1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
20 #include "inspsocket.h"
30 /** Used with OnAccessCheck() method of modules
32 enum AccessControlType {
33 ACR_DEFAULT, // Do default action (act as if the module isnt even loaded)
34 ACR_DENY, // deny the action
35 ACR_ALLOW, // allow the action
36 AC_KICK, // a user is being kicked
37 AC_DEOP, // a user is being deopped
38 AC_OP, // a user is being opped
39 AC_VOICE, // a user is being voiced
40 AC_DEVOICE, // a user is being devoiced
41 AC_HALFOP, // a user is being halfopped
42 AC_DEHALFOP, // a user is being dehalfopped
43 AC_INVITE, // a user is being invited
44 AC_GENERAL_MODE // a channel mode is being changed
47 /** Used to define a set of behavior bits for a module
50 VF_STATIC = 1, // module is static, cannot be /unloadmodule'd
51 VF_VENDOR = 2, // module is a vendor module (came in the original tarball, not 3rd party)
52 VF_SERVICEPROVIDER = 4, // module provides a service to other modules (can be a dependency)
53 VF_COMMON = 8 // module needs to be common on all servers in a network to link
56 /** Used with SendToMode()
63 /** Used to represent an event type, for user, channel or server
65 enum TargetTypeFlags {
72 /** Used to represent wether a message was PRIVMSG or NOTICE
79 /** If you change the module API, change this value.
80 * If you have enabled ipv6, the sizes of structs is
81 * different, and modules will be incompatible with
82 * ipv4 servers, so this value will be ten times as
83 * high on ipv6 servers.
85 #define NATIVE_API_VERSION 12000
87 #define API_VERSION (NATIVE_API_VERSION * 10)
89 #define API_VERSION (NATIVE_API_VERSION * 1)
94 /* Forward-delacare module for ModuleMessage etc
99 /** Low level definition of a FileReader classes file cache area -
100 * a text file seperated into lines.
102 typedef std::deque<std::string> file_cache;
104 /** A set of strings.
106 typedef file_cache string_list;
108 /** Holds a list of 'published features' for modules.
110 typedef std::map<std::string,Module*> featurelist;
112 /** Holds a list of modules which implement an interface
114 typedef std::deque<Module*> modulelist;
116 /** Holds a list of all modules which implement interfaces, by interface name
118 typedef std::map<std::string, std::pair<int, modulelist> > interfacelist;
121 * This #define allows us to call a method in all
122 * loaded modules in a readable simple way, e.g.:
123 * 'FOREACH_MOD(I_OnConnect,OnConnect(user));'
125 #define FOREACH_MOD(y,x) do { \
126 EventHandlerIter safei; \
127 for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ) \
135 catch (CoreException& modexcept) \
137 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
144 * This #define allows us to call a method in all
145 * loaded modules in a readable simple way and pass
146 * an instance pointer to the macro. e.g.:
147 * 'FOREACH_MOD_I(Instance, OnConnect, OnConnect(user));'
149 #define FOREACH_MOD_I(z,y,x) do { \
150 EventHandlerIter safei; \
151 for (EventHandlerIter _i = z->Modules->EventHandlers[y].begin(); _i != z->Modules->EventHandlers[y].end(); ) \
159 catch (CoreException& modexcept) \
161 z->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
168 * This define is similar to the one above but returns a result in MOD_RESULT.
169 * The first module to return a nonzero result is the value to be accepted,
170 * and any modules after are ignored.
172 #define FOREACH_RESULT(y,x) \
174 EventHandlerIter safei; \
176 for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ) \
182 int res = (*_i)->x ; \
188 catch (CoreException& modexcept) \
190 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
198 * This define is similar to the one above but returns a result in MOD_RESULT.
199 * The first module to return a nonzero result is the value to be accepted,
200 * and any modules after are ignored.
202 #define FOREACH_RESULT_I(z,y,x) \
204 EventHandlerIter safei; \
206 for (EventHandlerIter _i = z->Modules->EventHandlers[y].begin(); _i != z->Modules->EventHandlers[y].end(); ) \
212 int res = (*_i)->x ; \
218 catch (CoreException& modexcept) \
220 z->Logs->Log("MODULE",DEBUG,"Exception caught: %s",modexcept.GetReason()); \
226 /** Represents a non-local user.
227 * (in fact, any FD less than -1 does)
229 #define FD_MAGIC_NUMBER -42
233 /** Is a local user */
234 #define IS_LOCAL(x) ((x->GetFd() > -1))
235 /** Is a remote user */
236 #define IS_REMOTE(x) (x->GetFd() < 0)
237 /** Is a module created user */
238 #define IS_MODULE_CREATED(x) (x->GetFd() == FD_MAGIC_NUMBER)
240 #define IS_OPER(x) (!x->oper.empty())
242 #define IS_AWAY(x) (!x->awaymsg.empty())
244 /** Holds a module's Version information.
245 * The four members (set by the constructor only) indicate details as to the version number
246 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
247 * The flags and API values represent the module flags and API version of the module.
248 * The API version of a module must match the API version of the core exactly for the module to
251 class CoreExport Version : public classbase
254 /** Version information.
258 /** Flags and API version
260 const int Flags, API;
262 /** Initialize version class
264 Version(const std::string &sversion, int flags, int api_ver);
267 /** The ModuleMessage class is the base class of Request and Event
268 * This class is used to represent a basic data structure which is passed
269 * between modules for safe inter-module communications.
271 class CoreExport ModuleMessage : public Extensible
276 virtual ~ModuleMessage() {};
279 /** The Request class is a unicast message directed at a given module.
280 * When this class is properly instantiated it may be sent to a module
281 * using the Send() method, which will call the given module's OnRequest
282 * method with this class as its parameter.
284 class CoreExport Request : public ModuleMessage
287 /** This member holds a pointer to arbitary data set by the emitter of the message
290 /** This should be a null-terminated string identifying the type of request,
291 * all modules should define this and use it to determine the nature of the
292 * request before they attempt to cast the Request in any way.
295 /** This is a pointer to the sender of the message, which can be used to
296 * directly trigger events, or to create a reply.
299 /** The single destination of the Request
303 /** Create a new Request
304 * This is for the 'old' way of casting whatever the data is
305 * to char* and hoping you get the right thing at the other end.
306 * This is slowly being depreciated in favor of the 'new' way.
308 Request(char* anydata, Module* src, Module* dst);
309 /** Create a new Request
310 * This is for the 'new' way of defining a subclass
311 * of Request and defining it in a common header,
312 * passing an object of your Request subclass through
313 * as a Request* and using the ID string to determine
314 * what to cast it back to and the other end. This is
315 * much safer as there are no casts not confirmed by
316 * the ID string, and all casts are child->parent and
317 * can be checked at runtime with dynamic_cast<>()
319 Request(Module* src, Module* dst, const char* idstr);
320 /** Fetch the Request data
323 /** Fetch the ID string
326 /** Fetch the request source
329 /** Fetch the request destination (should be 'this' in the receiving module)
332 /** Send the Request.
333 * Upon returning the result will be arbitary data returned by the module you
334 * sent the request to. It is up to your module to know what this data is and
335 * how to deal with it.
341 /** The Event class is a unicast message directed at all modules.
342 * When the class is properly instantiated it may be sent to all modules
343 * using the Send() method, which will trigger the OnEvent method in
344 * all modules passing the object as its parameter.
346 class CoreExport Event : public ModuleMessage
349 /** This member holds a pointer to arbitary data set by the emitter of the message
352 /** This is a pointer to the sender of the message, which can be used to
353 * directly trigger events, or to create a reply.
356 /** The event identifier.
357 * This is arbitary text which should be used to distinguish
358 * one type of event from another.
362 /** Create a new Event
364 Event(char* anydata, Module* src, const std::string &eventid);
365 /** Get the Event data
368 /** Get the event Source
371 /** Get the event ID.
372 * Use this to determine the event type for safe casting of the data
374 std::string GetEventID();
376 * The return result of an Event::Send() will always be NULL as
377 * no replies are expected.
379 char* Send(InspIRCd* ServerInstance);
382 /** Priority types which can be returned from Module::Prioritize()
384 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
386 /** Implementation-specific flags which may be set in Module::Implements()
391 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash, I_OnSendSnotice,
392 I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois, I_OnUserPreInvite,
393 I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick, I_OnUserMessage, I_OnUserNotice, I_OnMode,
394 I_OnGetServerDescription, I_OnSyncUser, I_OnSyncChannel, I_OnSyncChannelMetaData, I_OnSyncUserMetaData,
395 I_OnDecodeMetaData, I_ProtoSendMode, I_ProtoSendMetaData, I_OnWallops, I_OnChangeHost, I_OnChangeName, I_OnAddLine,
396 I_OnDelLine, I_OnExpireLine, I_OnCleanup, I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule, I_OnUnloadModule,
397 I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite, I_OnRawMode,
398 I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckExtBan, I_OnCheckStringExtBan, I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos,
399 I_OnLocalTopicChange, I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan, I_OnDelBan,
400 I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead, I_OnChangeLocalUserGECOS, I_OnUserRegister,
401 I_OnChannelPreDelete, I_OnChannelDelete, I_OnPostOper, I_OnSyncOtherMetaData, I_OnSetAway, I_OnUserList,
402 I_OnPostCommand, I_OnPostJoin, I_OnWhoisLine, I_OnBuildExemptList, I_OnRawSocketConnect, I_OnGarbageCollect, I_OnBufferFlushed,
403 I_OnText, I_OnPassCompare, I_OnRunTestSuite, I_OnNamesListItem, I_OnNumeric, I_OnHookUserIO, I_OnHostCycle,
409 /** Base class for all InspIRCd modules
410 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
411 * its methods will be called when irc server events occur. class inherited from module must be
412 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
414 class CoreExport Module : public Extensible
417 /** Creator/owner pointer
419 InspIRCd* ServerInstance;
422 /** Default constructor.
423 * Creates a module class.
424 * @param Me An instance of the InspIRCd class which will be saved into ServerInstance for your use
425 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
427 Module(InspIRCd* Me);
429 /** Default destructor.
430 * destroys a module class
434 virtual void Prioritize()
438 /** Returns the version number of a Module.
439 * The method should return a Version object with its version information assigned via
442 virtual Version GetVersion();
444 /** Called when a user connects.
445 * The details of the connecting user are available to you in the parameter User *user
446 * @param user The user who is connecting
448 virtual void OnUserConnect(User* user);
450 /** Called when a user quits.
451 * The details of the exiting user are available to you in the parameter User *user
452 * This event is only called when the user is fully registered when they quit. To catch
453 * raw disconnections, use the OnUserDisconnect method.
454 * @param user The user who is quitting
455 * @param message The user's quit message (as seen by non-opers)
456 * @param oper_message The user's quit message (as seen by opers)
458 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
460 /** Called whenever a user's socket is closed.
461 * The details of the exiting user are available to you in the parameter User *user
462 * This event is called for all users, registered or not, as a cleanup method for modules
463 * which might assign resources to user, such as dns lookups, objects and sockets.
464 * @param user The user who is disconnecting
466 virtual void OnUserDisconnect(User* user);
468 /** Called whenever a channel is about to be deleted
469 * @param chan The channel being deleted
470 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
472 virtual int OnChannelPreDelete(Channel *chan);
474 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
475 * @param chan The channel being deleted
477 virtual void OnChannelDelete(Channel* chan);
479 /** Called when a user joins a channel.
480 * The details of the joining user are available to you in the parameter User *user,
481 * and the details of the channel they have joined is available in the variable Channel *channel
482 * @param user The user who is joining
483 * @param channel The channel being joined
484 * @param silent Change this to true if you want to conceal the JOIN command from the other users
485 * of the channel (useful for modules such as auditorium)
486 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
487 * to a channel due to the network sync.
489 virtual void OnUserJoin(User* user, Channel* channel, bool sync, bool &silent);
491 /** Called after a user joins a channel
492 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
494 * @param user The user who is joining
495 * @param channel The channel being joined
497 virtual void OnPostJoin(User* user, Channel* channel);
499 /** Called when a user parts a channel.
500 * The details of the leaving user are available to you in the parameter User *user,
501 * and the details of the channel they have left is available in the variable Channel *channel
502 * @param user The user who is parting
503 * @param channel The channel being parted
504 * @param partmessage The part message, or an empty string (may be modified)
505 * @param silent Change this to true if you want to conceal the PART command from the other users
506 * of the channel (useful for modules such as auditorium)
508 virtual void OnUserPart(User* user, Channel* channel, std::string &partmessage, bool &silent);
510 /** Called on rehash.
511 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
512 * system. You should use it to reload any files so that your module keeps in step with the
513 * rest of the application. If a parameter is given, the core has done nothing. The module
514 * receiving the event can decide if this parameter has any relevence to it.
515 * @param user The user performing the rehash, if any -- if this is server initiated, the
516 * value of this variable will be NULL.
517 * @param parameter The (optional) parameter given to REHASH from the user.
519 virtual void OnRehash(User* user, const std::string ¶meter);
521 /** Called whenever a snotice is about to be sent to a snomask.
522 * snomask and type may both be modified; the message may not.
523 * @param snomask The snomask the message is going to (e.g. 'A')
524 * @param type The textual description the snomask will go to (e.g. 'OPER')
525 * @param message The text message to be sent via snotice
526 * @return 1 to block the snotice from being sent entirely, 0 else.
528 virtual int OnSendSnotice(char &snomask, std::string &type, const std::string &message);
530 /** Called whenever a user is about to join a channel, before any processing is done.
531 * Returning a value of 1 from this function stops the process immediately, causing no
532 * output to be sent to the user by the core. If you do this you must produce your own numerics,
533 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
534 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
538 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
539 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
540 * processing on the actual channel record at this point, however the channel NAME will still be passed in
541 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
542 * @param user The user joining the channel
543 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
544 * @param cname The channel name being joined. For new channels this is valid where chan is not.
545 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "@".
546 * You may alter this string to alter the user's modes on the channel.
547 * @param keygiven The key given to join the channel, or an empty string if none was provided
548 * @return 1 To prevent the join, 0 to allow it.
550 virtual int OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string &privs, const std::string &keygiven);
552 /** Called whenever a user is about to be kicked.
553 * Returning a value of 1 from this function stops the process immediately, causing no
554 * output to be sent to the user by the core. If you do this you must produce your own numerics,
556 * @param source The user issuing the kick
557 * @param user The user being kicked
558 * @param chan The channel the user is being kicked from
559 * @param reason The kick reason
560 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
562 virtual int OnUserPreKick(User* source, User* user, Channel* chan, const std::string &reason);
564 /** Called whenever a user is kicked.
565 * If this method is called, the kick is already underway and cannot be prevented, so
566 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
567 * @param source The user issuing the kick
568 * @param user The user being kicked
569 * @param chan The channel the user is being kicked from
570 * @param reason The kick reason
571 * @param silent Change this to true if you want to conceal the PART command from the other users
572 * of the channel (useful for modules such as auditorium)
574 virtual void OnUserKick(User* source, User* user, Channel* chan, const std::string &reason, bool &silent);
576 /** Called whenever a user opers locally.
577 * The User will contain the oper mode 'o' as this function is called after any modifications
578 * are made to the user's structure by the core.
579 * @param user The user who is opering up
580 * @param opertype The opers type name
582 virtual void OnOper(User* user, const std::string &opertype);
584 /** Called after a user opers locally.
585 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
586 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
587 * out the OPERTYPE, etc.
588 * @param user The user who is opering up
589 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
590 * @param opertype The opers type name
592 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
594 /** Called whenever a user types /INFO.
595 * The User will contain the information of the user who typed the command. Modules may use this
596 * method to output their own credits in /INFO (which is the ircd's version of an about box).
597 * It is purposefully not possible to modify any info that has already been output, or halt the list.
598 * You must write a 371 numeric to the user, containing your info in the following format:
600 * <nick> :information here
602 * @param user The user issuing /INFO
604 virtual void OnInfo(User* user);
606 /** Called whenever a /WHOIS is performed on a local user.
607 * The source parameter contains the details of the user who issued the WHOIS command, and
608 * the dest parameter contains the information of the user they are whoising.
609 * @param source The user issuing the WHOIS command
610 * @param dest The user who is being WHOISed
612 virtual void OnWhois(User* source, User* dest);
614 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
615 * Returning 1 from this function stops the process immediately, causing no
616 * output to be sent to the user by the core. If you do this you must produce your own numerics,
617 * notices etc. This is useful for modules which may want to filter invites to channels.
618 * @param source The user who is issuing the INVITE
619 * @param dest The user being invited
620 * @param channel The channel the user is being invited to
621 * @param timeout The time the invite will expire (0 == never)
622 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
624 virtual int OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
626 /** Called after a user has been successfully invited to a channel.
627 * You cannot prevent the invite from occuring using this function, to do that,
628 * use OnUserPreInvite instead.
629 * @param source The user who is issuing the INVITE
630 * @param dest The user being invited
631 * @param channel The channel the user is being invited to
632 * @param timeout The time the invite will expire (0 == never)
634 virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout);
636 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
637 * Returning any nonzero value from this function stops the process immediately, causing no
638 * output to be sent to the user by the core. If you do this you must produce your own numerics,
639 * notices etc. This is useful for modules which may want to filter or redirect messages.
640 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
641 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
642 * of where the message is destined to be sent.
643 * @param user The user sending the message
644 * @param dest The target of the message (Channel* or User*)
645 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
646 * @param text Changeable text being sent by the user
647 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
648 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
649 * It will be ignored for private messages.
650 * @return 1 to deny the message, 0 to allow it
652 virtual int OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
654 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
655 * Returning any nonzero value from this function stops the process immediately, causing no
656 * output to be sent to the user by the core. If you do this you must produce your own numerics,
657 * notices etc. This is useful for modules which may want to filter or redirect messages.
658 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
659 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
660 * of where the message is destined to be sent.
661 * You may alter the message text as you wish before relinquishing control to the next module
662 * in the chain, and if no other modules block the text this altered form of the text will be sent out
663 * to the user and possibly to other servers.
664 * @param user The user sending the message
665 * @param dest The target of the message (Channel* or User*)
666 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
667 * @param text Changeable text being sent by the user
668 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
669 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
670 * It will be ignored for private notices.
671 * @return 1 to deny the NOTICE, 0 to allow it
673 virtual int OnUserPreNotice(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
675 /** Called whenever the server wants to build the exemption list for a channel, but is not directly doing a PRIVMSG or NOTICE.
676 * For example, the spanningtree protocol will call this event when passing a privmsg on (but not processing it directly).
677 * @param message_type The message type, either MSG_PRIVMSG or MSG_NOTICE
678 * @param chan The channel to build the exempt list of
679 * @param sender The original sender of the PRIVMSG or NOTICE
680 * @param status The status char to be used for the channel list
681 * @param exempt_list The exempt list to be populated
682 * @param text The original message text causing the exempt list to be built
684 virtual void OnBuildExemptList(MessageType message_type, Channel* chan, User* sender, char status, CUList &exempt_list, const std::string &text);
686 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
687 * Please note that although you can see remote nickchanges through this function, you should
688 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
689 * check user->server before taking any action (including returning nonzero from the method).
690 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
691 * module to generate some meaninful output.
692 * @param user The username changing their nick
693 * @param newnick Their new nickname
694 * @return 1 to deny the change, 0 to allow
696 virtual int OnUserPreNick(User* user, const std::string &newnick);
698 /** Called after any PRIVMSG sent from a user.
699 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
700 * if target_type is TYPE_CHANNEL.
701 * @param user The user sending the message
702 * @param dest The target of the message
703 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
704 * @param text the text being sent by the user
705 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
707 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
709 /** Called after any NOTICE sent from a user.
710 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
711 * if target_type is TYPE_CHANNEL.
712 * @param user The user sending the message
713 * @param dest The target of the message
714 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
715 * @param text the text being sent by the user
716 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
718 virtual void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
720 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
721 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
722 * if target_type is TYPE_CHANNEL.
723 * The difference between this event and OnUserPreNotice/OnUserPreMessage is that delivery is gauranteed,
724 * the message has already been vetted. In the case of the other two methods, a later module may stop your
725 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
726 * @param user The user sending the message
727 * @param dest The target of the message
728 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
729 * @param text the text being sent by the user
730 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
732 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
734 /** Called after every MODE command sent from a user
735 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
736 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
737 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
738 * @param user The user sending the MODEs
739 * @param dest The target of the modes (User* or Channel*)
740 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
741 * @param text The actual modes and their parameters if any
742 * @param translate The translation types of the mode parameters
744 virtual void OnMode(User* user, void* dest, int target_type, const std::string &text, const std::vector<TranslateType> &translate);
746 /** Allows modules to alter or create server descriptions
747 * Whenever a module requires a server description, for example for display in
748 * WHOIS, this function is called in all modules. You may change or define the
749 * description given in std::string &description. If you do, this description
750 * will be shown in the WHOIS fields.
751 * @param servername The servername being searched for
752 * @param description Alterable server description for this server
754 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
756 /** Allows modules to synchronize data which relates to users during a netburst.
757 * When this function is called, it will be called from the module which implements
758 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
759 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
760 * (see below). This function will be called for every user visible on your side
761 * of the burst, allowing you to for example set modes, etc. Do not use this call to
762 * synchronize data which you have stored using class Extensible -- There is a specialist
763 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
764 * @param user The user being syncronized
765 * @param proto A pointer to the module handling network protocol
766 * @param opaque An opaque pointer set by the protocol module, should not be modified!
768 virtual void OnSyncUser(User* user, Module* proto, void* opaque);
770 /** Allows modules to synchronize data which relates to channels during a netburst.
771 * When this function is called, it will be called from the module which implements
772 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
773 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
774 * (see below). This function will be called for every user visible on your side
775 * of the burst, allowing you to for example set modes, etc. Do not use this call to
776 * synchronize data which you have stored using class Extensible -- There is a specialist
777 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
779 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
781 * @param chan The channel being syncronized
782 * @param proto A pointer to the module handling network protocol
783 * @param opaque An opaque pointer set by the protocol module, should not be modified!
785 virtual void OnSyncChannel(Channel* chan, Module* proto, void* opaque);
787 /* Allows modules to syncronize metadata related to channels over the network during a netburst.
788 * Whenever the linking module wants to send out data, but doesnt know what the data
789 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
790 * this method is called.You should use the ProtoSendMetaData function after you've
791 * correctly decided how the data should be represented, to send the metadata on its way if it belongs
792 * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
793 * @param chan The channel whos metadata is being syncronized
794 * @param proto A pointer to the module handling network protocol
795 * @param opaque An opaque pointer set by the protocol module, should not be modified!
796 * @param extname The extensions name which is being searched for
797 * @param displayable If this value is true, the data is going to be displayed to a user,
798 * and not sent across the network. Use this to determine wether or not to show sensitive data.
800 virtual void OnSyncChannelMetaData(Channel* chan, Module* proto,void* opaque, const std::string &extname, bool displayable = false);
802 /* Allows modules to syncronize metadata related to users over the network during a netburst.
803 * Whenever the linking module wants to send out data, but doesnt know what the data
804 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
805 * this method is called. You should use the ProtoSendMetaData function after you've
806 * correctly decided how the data should be represented, to send the metadata on its way if
807 * if it belongs to your module.
808 * @param user The user whos metadata is being syncronized
809 * @param proto A pointer to the module handling network protocol
810 * @param opaque An opaque pointer set by the protocol module, should not be modified!
811 * @param extname The extensions name which is being searched for
812 * @param displayable If this value is true, the data is going to be displayed to a user,
813 * and not sent across the network. Use this to determine wether or not to show sensitive data.
815 virtual void OnSyncUserMetaData(User* user, Module* proto,void* opaque, const std::string &extname, bool displayable = false);
817 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
818 * Whenever the linking module wants to send out data, but doesnt know what the data
819 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
820 * this method is called. You should use the ProtoSendMetaData function after you've
821 * correctly decided how the data should be represented, to send the metadata on its way if
822 * if it belongs to your module.
823 * @param proto A pointer to the module handling network protocol
824 * @param opaque An opaque pointer set by the protocol module, should not be modified!
825 * @param displayable If this value is true, the data is going to be displayed to a user,
826 * and not sent across the network. Use this to determine wether or not to show sensitive data.
828 virtual void OnSyncOtherMetaData(Module* proto, void* opaque, bool displayable = false);
830 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
831 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
832 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
833 * @param target The Channel* or User* that data should be added to
834 * @param extname The extension name which is being sent
835 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
837 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata);
839 /** Implemented by modules which provide the ability to link servers.
840 * These modules will implement this method, which allows transparent sending of servermodes
841 * down the network link as a broadcast, without a module calling it having to know the format
842 * of the MODE command before the actual mode string.
844 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
845 * of how to use this function.
847 * @param opaque An opaque pointer set by the protocol module, should not be modified!
848 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
849 * @param target The Channel* or User* that modes should be sent for
850 * @param modeline The modes and parameters to be sent
851 * @param translate The translation types of the mode parameters
853 virtual void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::string &modeline, const std::vector<TranslateType> &translate);
855 /** Implemented by modules which provide the ability to link servers.
856 * These modules will implement this method, which allows metadata (extra data added to
857 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
858 * to other servers on a netburst and decoded at the other end by the same module on a
861 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
862 * how to use this function.
863 * @param opaque An opaque pointer set by the protocol module, should not be modified!
864 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
865 * @param target The Channel* or User* that metadata should be sent for
866 * @param extname The extension name to send metadata for
867 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
869 virtual void ProtoSendMetaData(void* opaque, TargetTypeFlags target_type, void* target, const std::string &extname, const std::string &extdata);
871 /** Called after every WALLOPS command.
872 * @param user The user sending the WALLOPS
873 * @param text The content of the WALLOPS message
875 virtual void OnWallops(User* user, const std::string &text);
877 /** Called whenever a user's hostname is changed.
878 * This event triggers after the host has been set.
879 * @param user The user whos host is being changed
880 * @param newhost The new hostname being set
882 virtual void OnChangeHost(User* user, const std::string &newhost);
884 /** Called whenever a user's GECOS (realname) is changed.
885 * This event triggers after the name has been set.
886 * @param user The user who's GECOS is being changed
887 * @param gecos The new GECOS being set on the user
889 virtual void OnChangeName(User* user, const std::string &gecos);
891 /** Called whenever an xline is added by a local user.
892 * This method is triggered after the line is added.
893 * @param source The sender of the line or NULL for local server
894 * @param line The xline being added
896 virtual void OnAddLine(User* source, XLine* line);
898 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
899 * This method is triggered after the line is deleted.
900 * @param source The user removing the line or NULL for local server
901 * @param line the line being deleted
903 virtual void OnDelLine(User* source, XLine* line);
905 /** Called whenever an xline expires.
906 * This method is triggered after the line is deleted.
907 * @param line The line being deleted.
909 virtual void OnExpireLine(XLine *line);
911 /** Called before your module is unloaded to clean up Extensibles.
912 * This method is called once for every user and channel on the network,
913 * so that when your module unloads it may clear up any remaining data
914 * in the form of Extensibles added using Extensible::Extend().
915 * If the target_type variable is TYPE_USER, then void* item refers to
916 * a User*, otherwise it refers to a Channel*.
917 * @param target_type The type of item being cleaned
918 * @param item A pointer to the item's class
920 virtual void OnCleanup(int target_type, void* item);
922 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
923 * have been applied. Please note that although you can see remote nickchanges through this function, you should
924 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
925 * check user->server before taking any action (including returning nonzero from the method).
926 * Because this method is called after the nickchange is taken place, no return values are possible
927 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
928 * @param user The user changing their nick
929 * @param oldnick The old nickname of the user before the nickchange
931 virtual void OnUserPostNick(User* user, const std::string &oldnick);
933 /** Called before an action which requires a channel privilage check.
934 * This function is called before many functions which check a users status on a channel, for example
935 * before opping a user, deopping a user, kicking a user, etc.
936 * There are several values for access_type which indicate for what reason access is being checked.
938 * AC_KICK - A user is being kicked<br>
939 * AC_DEOP - a user is being deopped<br>
940 * AC_OP - a user is being opped<br>
941 * AC_VOICE - a user is being voiced<br>
942 * AC_DEVOICE - a user is being devoiced<br>
943 * AC_HALFOP - a user is being halfopped<br>
944 * AC_DEHALFOP - a user is being dehalfopped<br>
945 * AC_INVITE - a user is being invited<br>
946 * AC_GENERAL_MODE - a user channel mode is being changed<br><br>
947 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
948 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
949 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
950 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
951 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
952 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
953 * @param source The source of the access check
954 * @param dest The destination of the access check
955 * @param channel The channel which is being checked
956 * @param access_type See above
958 virtual int OnAccessCheck(User* source,User* dest,Channel* channel,int access_type);
960 /** Called when a 005 numeric is about to be output.
961 * The module should modify the 005 numeric if needed to indicate its features.
962 * @param output The 005 string to be modified if neccessary.
964 virtual void On005Numeric(std::string &output);
966 /** Called when a client is disconnected by KILL.
967 * If a client is killed by a server, e.g. a nickname collision or protocol error,
969 * Return 1 from this function to prevent the kill, and 0 from this function to allow
970 * it as normal. If you prevent the kill no output will be sent to the client, it is
971 * down to your module to generate this information.
972 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
973 * If you do so youre risking race conditions, desyncs and worse!
974 * @param source The user sending the KILL
975 * @param dest The user being killed
976 * @param reason The kill reason
977 * @return 1 to prevent the kill, 0 to allow
979 virtual int OnKill(User* source, User* dest, const std::string &reason);
981 /** Called when an oper wants to disconnect a remote user via KILL
982 * @param source The user sending the KILL
983 * @param dest The user being killed
984 * @param reason The kill reason
986 virtual void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
988 /** Called whenever a module is loaded.
989 * mod will contain a pointer to the module, and string will contain its name,
990 * for example m_widgets.so. This function is primary for dependency checking,
991 * your module may decide to enable some extra features if it sees that you have
992 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
993 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
994 * but instead operate under reduced functionality, unless the dependency is
995 * absolutely neccessary (e.g. a module that extends the features of another
997 * @param mod A pointer to the new module
998 * @param name The new module's filename
1000 virtual void OnLoadModule(Module* mod,const std::string &name);
1002 /** Called whenever a module is unloaded.
1003 * mod will contain a pointer to the module, and string will contain its name,
1004 * for example m_widgets.so. This function is primary for dependency checking,
1005 * your module may decide to enable some extra features if it sees that you have
1006 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
1007 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
1008 * but instead operate under reduced functionality, unless the dependency is
1009 * absolutely neccessary (e.g. a module that extends the features of another
1011 * @param mod Pointer to the module being unloaded (still valid)
1012 * @param name The filename of the module being unloaded
1014 virtual void OnUnloadModule(Module* mod,const std::string &name);
1016 /** Called once every five seconds for background processing.
1017 * This timer can be used to control timed features. Its period is not accurate
1018 * enough to be used as a clock, but it is gauranteed to be called at least once in
1019 * any five second period, directly from the main loop of the server.
1020 * @param curtime The current timer derived from time(2)
1022 virtual void OnBackgroundTimer(time_t curtime);
1024 /** Called whenever any command is about to be executed.
1025 * This event occurs for all registered commands, wether they are registered in the core,
1026 * or another module, and for invalid commands. Invalid commands may only be sent to this
1027 * function when the value of validated is false. By returning 1 from this method you may prevent the
1028 * command being executed. If you do this, no output is created by the core, and it is
1029 * down to your module to produce any output neccessary.
1030 * Note that unless you return 1, you should not destroy any structures (e.g. by using
1031 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
1032 * method returns, it will be passed an invalid pointer to the user object and crash!)
1033 * @param command The command being executed
1034 * @param parameters An array of array of characters containing the parameters for the command
1035 * @param pcnt The nuimber of parameters passed to the command
1036 * @param user the user issuing the command
1037 * @param validated True if the command has passed all checks, e.g. it is recognised, has enough parameters, the user has permission to execute it, etc.
1038 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
1039 * @param original_line The entire original line as passed to the parser from the user
1040 * @return 1 to block the command, 0 to allow
1042 virtual int OnPreCommand(std::string &command, std::vector<std::string>& parameters, User *user, bool validated, const std::string &original_line);
1044 /** Called after any command has been executed.
1045 * This event occurs for all registered commands, wether they are registered in the core,
1046 * or another module, but it will not occur for invalid commands (e.g. ones which do not
1047 * exist within the command table). The result code returned by the command handler is
1049 * @param command The command being executed
1050 * @param parameters An array of array of characters containing the parameters for the command
1051 * @param pcnt The nuimber of parameters passed to the command
1052 * @param user the user issuing the command
1053 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
1054 * @param original_line The entire original line as passed to the parser from the user
1056 virtual void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, User *user, CmdResult result, const std::string &original_line);
1058 /** Called to check if a user who is connecting can now be allowed to register
1059 * If any modules return false for this function, the user is held in the waiting
1060 * state until all modules return true. For example a module which implements ident
1061 * lookups will continue to return false for a user until their ident lookup is completed.
1062 * Note that the registration timeout for a user overrides these checks, if the registration
1063 * timeout is reached, the user is disconnected even if modules report that the user is
1064 * not ready to connect.
1065 * @param user The user to check
1066 * @return true to indicate readiness, false if otherwise
1068 virtual bool OnCheckReady(User* user);
1070 /** Called whenever a user is about to register their connection (e.g. before the user
1071 * is sent the MOTD etc). Modules can use this method if they are performing a function
1072 * which must be done before the actual connection is completed (e.g. ident lookups,
1073 * dnsbl lookups, etc).
1074 * Note that you should NOT delete the user record here by causing a disconnection!
1075 * Use OnUserConnect for that instead.
1076 * @param user The user registering
1077 * @return 1 to indicate user quit, 0 to continue
1079 virtual int OnUserRegister(User* user);
1081 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1082 * This method will always be called for each join, wether or not the channel is actually +i, and
1083 * determines the outcome of an if statement around the whole section of invite checking code.
1084 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1085 * @param user The user joining the channel
1086 * @param chan The channel being joined
1087 * @return 1 to explicitly allow the join, 0 to proceed as normal
1089 virtual int OnCheckInvite(User* user, Channel* chan);
1091 /** Called whenever a mode character is processed.
1092 * Return 1 from this function to block the mode character from being processed entirely.
1093 * @param user The user who is sending the mode
1094 * @param chan The channel the mode is being sent to (or NULL if a usermode)
1095 * @param mode The mode character being set
1096 * @param param The parameter for the mode or an empty string
1097 * @param adding true of the mode is being added, false if it is being removed
1098 * @param pcnt The parameter count for the mode (0 or 1)
1099 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
1100 * to skip all permission checking. Please note that for remote mode changes, your return value
1103 virtual int OnRawMode(User* user, Channel* chan, const char mode, const std::string ¶m, bool adding, int pcnt, bool servermode = true);
1105 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1106 * This method will always be called for each join, wether or not the channel is actually +k, and
1107 * determines the outcome of an if statement around the whole section of key checking code.
1108 * if the user specified no key, the keygiven string will be a valid but empty value.
1109 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1110 * @param user The user joining the channel
1111 * @param chan The channel being joined
1112 * @return 1 to explicitly allow the join, 0 to proceed as normal
1114 virtual int OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
1116 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1117 * This method will always be called for each join, wether or not the channel is actually +l, and
1118 * determines the outcome of an if statement around the whole section of channel limit checking code.
1119 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1120 * @param user The user joining the channel
1121 * @param chan The channel being joined
1122 * @return 1 to explicitly allow the join, 0 to proceed as normal
1124 virtual int OnCheckLimit(User* user, Channel* chan);
1126 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
1127 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
1128 * determines the outcome of an if statement around the whole section of ban checking code.
1129 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1130 * @param user The user joining the channel
1131 * @param chan The channel being joined
1132 * @return 1 to explicitly allow the join, 0 to proceed as normal. Return -1 to explicitly deny the
1133 * join to the channel.
1135 virtual int OnCheckBan(User* user, Channel* chan);
1137 /* Called whenever checking whether or not a user is matched by an applicable extended bantype.
1138 * NOTE: may also trigger extra OnCheckStringExtBan events!
1139 * @param u The user to check
1140 * @param c The channel the user is on
1141 * @param type The type of extended ban to check for.
1143 virtual int OnCheckExtBan(User *u, Channel *c, char type);
1145 /** Called whenever checking whether or not a string is extbanned. NOTE: one OnCheckExtBan will also trigger a number of
1146 * OnCheckStringExtBan events for seperate host/IP comnbinations.
1148 virtual int OnCheckStringExtBan(const std::string &s, Channel *c, char type);
1150 /** Called on all /STATS commands
1151 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1152 * @param symbol the symbol provided to /STATS
1153 * @param user the user issuing the /STATS command
1154 * @param results A string_list to append results into. You should put all your results
1155 * into this string_list, rather than displaying them directly, so that your handler will
1156 * work when remote STATS queries are received.
1157 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1159 virtual int OnStats(char symbol, User* user, string_list &results);
1161 /** Called whenever a change of a local users displayed host is attempted.
1162 * Return 1 to deny the host change, or 0 to allow it.
1163 * @param user The user whos host will be changed
1164 * @param newhost The new hostname
1165 * @return 1 to deny the host change, 0 to allow
1167 virtual int OnChangeLocalUserHost(User* user, const std::string &newhost);
1169 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1170 * return 1 to deny the name change, or 0 to allow it.
1171 * @param user The user whos GECOS will be changed
1172 * @param newhost The new GECOS
1173 * @return 1 to deny the GECOS change, 0 to allow
1175 virtual int OnChangeLocalUserGECOS(User* user, const std::string &newhost);
1177 /** Called whenever a topic is changed by a local user.
1178 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
1179 * @param user The user changing the topic
1180 * @param chan The channels who's topic is being changed
1181 * @param topic The actual topic text
1182 * @param 1 to block the topic change, 0 to allow
1184 virtual int OnLocalTopicChange(User* user, Channel* chan, const std::string &topic);
1186 /** Called whenever a local topic has been changed.
1187 * To block topic changes you must use OnLocalTopicChange instead.
1188 * @param user The user changing the topic
1189 * @param chan The channels who's topic is being changed
1190 * @param topic The actual topic text
1192 virtual void OnPostLocalTopicChange(User* user, Channel* chan, const std::string &topic);
1194 /** Called whenever an Event class is sent to all module by another module.
1195 * Please see the documentation of Event::Send() for further information. The Event sent can
1196 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1197 * before doing anything to the event data, and you should *not* change the event data in any way!
1198 * @param event The Event class being received
1200 virtual void OnEvent(Event* event);
1202 /** Called whenever a Request class is sent to your module by another module.
1203 * Please see the documentation of Request::Send() for further information. The Request sent
1204 * can always be assumed to be non-NULL, you should not change the request object or its data.
1205 * Your method may return arbitary data in the char* result which the requesting module
1206 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1207 * @param request The Request class being received
1209 virtual const char* OnRequest(Request* request);
1211 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
1212 * The password field (from the config file) is in 'password' and is to be compared against
1213 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
1214 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
1215 * @param ex The object that's causing the authentication (User* for <oper> <connect:allow> etc, Server* for <link>).
1216 * @param password The password from the configuration file (the password="" value).
1217 * @param input The password entered by the user or whoever.
1218 * @param hashtype The hash value from the config
1219 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
1221 virtual int OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
1223 /** Called whenever a user is given usermode +o, anywhere on the network.
1224 * You cannot override this and prevent it from happening as it is already happened and
1225 * such a task must be performed by another server. You can however bounce modes by sending
1226 * servermodes out to reverse mode changes.
1227 * @param user The user who is opering
1229 virtual void OnGlobalOper(User* user);
1231 /** Called after a user has fully connected and all modules have executed OnUserConnect
1232 * This event is informational only. You should not change any user information in this
1233 * event. To do so, use the OnUserConnect method to change the state of local users.
1234 * This is called for both local and remote users.
1235 * @param user The user who is connecting
1237 virtual void OnPostConnect(User* user);
1239 /** Called whenever a ban is added to a channel's list.
1240 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1241 * @param source The user adding the ban
1242 * @param channel The channel the ban is being added to
1243 * @param banmask The ban mask being added
1244 * @return 1 to block the ban, 0 to continue as normal
1246 virtual int OnAddBan(User* source, Channel* channel,const std::string &banmask);
1248 /** Called whenever a ban is removed from a channel's list.
1249 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1250 * @param source The user deleting the ban
1251 * @param channel The channel the ban is being deleted from
1252 * @param banmask The ban mask being deleted
1253 * @return 1 to block the unban, 0 to continue as normal
1255 virtual int OnDelBan(User* source, Channel* channel,const std::string &banmask);
1257 virtual void OnHookUserIO(User* user, const std::string &targetip);
1259 /** Called immediately after any connection is accepted. This is intended for raw socket
1260 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1261 * no information relating to a user record as the connection has not been assigned yet.
1262 * There are no return values from this call as all modules get an opportunity if required to
1263 * process the connection.
1264 * @param fd The file descriptor returned from accept()
1265 * @param ip The IP address of the connecting user
1266 * @param localport The local port number the user connected to
1268 virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport);
1270 /** Called immediately before any write() operation on a user's socket in the core. Because
1271 * this event is a low level event no user information is associated with it. It is intended
1272 * for use by modules which may wrap connections within another API such as SSL for example.
1273 * return a non-zero result if you have handled the write operation, in which case the core
1274 * will not call write().
1275 * @param fd The file descriptor of the socket
1276 * @param buffer A char* buffer being written
1277 * @param Number of characters to write
1278 * @return Number of characters actually written or 0 if you didn't handle the operation
1280 virtual int OnRawSocketWrite(int fd, const char* buffer, int count);
1282 /** Called immediately before any socket is closed. When this event is called, shutdown()
1283 * has not yet been called on the socket.
1284 * @param fd The file descriptor of the socket prior to close()
1286 virtual void OnRawSocketClose(int fd);
1288 /** Called immediately upon connection of an outbound BufferedSocket which has been hooked
1290 * @param fd The file descriptor of the socket immediately after connect()
1292 virtual void OnRawSocketConnect(int fd);
1294 /** Called immediately before any read() operation on a client socket in the core.
1295 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1296 * when this event occurs.
1297 * Your event should return 1 if it has handled the reading itself, which prevents the core
1298 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1299 * the value of count. The value of readresult must be identical to an actual result that might
1300 * be returned from the read() system call, for example, number of bytes read upon success,
1301 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1302 * you MUST set readresult.
1303 * @param fd The file descriptor of the socket
1304 * @param buffer A char* buffer being read to
1305 * @param count The size of the buffer
1306 * @param readresult The amount of characters read, or 0
1307 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1309 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1311 /** Called whenever a user sets away or returns from being away.
1312 * The away message is available as a parameter, but should not be modified.
1313 * At this stage, it has already been copied into the user record.
1314 * If awaymsg is empty, the user is returning from away.
1315 * @param user The user setting away
1316 * @param awaymsg The away message of the user, or empty if returning from away
1317 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
1319 virtual int OnSetAway(User* user, const std::string &awaymsg);
1321 /** Called whenever a NAMES list is requested.
1322 * You can produce the nameslist yourself, overriding the current list,
1323 * and if you do you must return 1. If you do not handle the names list,
1325 * @param The user requesting the NAMES list
1326 * @param Ptr The channel the NAMES list is requested for
1327 * @param userlist The user list for the channel (you may change this pointer.
1328 * If you want to change the values, take a copy first, and change the copy, then
1329 * point the pointer at your copy)
1330 * @return 1 to prevent the user list being sent to the client, 0 to allow it.
1331 * Returning -1 allows the names list, but bypasses any checks which check for
1332 * channel membership before sending the names list.
1334 virtual int OnUserList(User* user, Channel* Ptr, CUList* &userlist);
1336 /** Called whenever a line of WHOIS output is sent to a user.
1337 * You may change the numeric and the text of the output by changing
1338 * the values numeric and text, but you cannot change the user the
1339 * numeric is sent to. You may however change the user's User values.
1340 * @param user The user the numeric is being sent to
1341 * @param dest The user being WHOISed
1342 * @param numeric The numeric of the line being sent
1343 * @param text The text of the numeric, including any parameters
1344 * @return nonzero to drop the line completely so that the user does not
1345 * receive it, or zero to allow the line to be sent.
1347 virtual int OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
1349 /** Called at intervals for modules to garbage-collect any hashes etc.
1350 * Certain data types such as hash_map 'leak' buckets, which must be
1351 * tidied up and freed by copying into a new item every so often. This
1352 * method is called when it is time to do that.
1354 virtual void OnGarbageCollect();
1356 /** Called whenever a user's write buffer has been completely sent.
1357 * This is called when the user's write buffer is completely empty, and
1358 * there are no more pending bytes to be written and no pending write events
1359 * in the socket engine's queue. This may be used to refill the buffer with
1360 * data which is being spooled in a controlled manner, e.g. LIST lines.
1361 * @param user The user who's buffer is now empty.
1363 virtual void OnBufferFlushed(User* user);
1365 /** Add test suite hooks here. These are used for testing functionality of a module
1366 * via the --testsuite debugging parameter.
1368 virtual void OnRunTestSuite();
1370 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
1371 * For example NAMESX, channel mode +u and +I, and UHNAMES. If the nick is set to an empty string by any
1372 * module, then this will cause the nickname not to be displayed at all.
1374 virtual void OnNamesListItem(User* issuer, User* user, Channel* channel, std::string &prefixes, std::string &nick);
1376 virtual int OnNumeric(User* user, unsigned int numeric, const std::string &text);
1378 /** Called for every time the user's host or ident changes, to indicate wether or not the 'Changing host'
1379 * message should be sent, if enabled. Certain modules such as auditorium may opt to hide this message
1380 * even if it is enabled.
1382 virtual bool OnHostCycle(User* user);
1386 #define CONF_NO_ERROR 0x000000
1387 #define CONF_NOT_A_NUMBER 0x000010
1388 #define CONF_INT_NEGATIVE 0x000080
1389 #define CONF_VALUE_NOT_FOUND 0x000100
1390 #define CONF_FILE_NOT_FOUND 0x000200
1393 /** Allows reading of values from configuration files
1394 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1395 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1396 * Constructing the class using one parameter allows you to specify a path to your own configuration
1397 * file, otherwise, inspircd.conf is read.
1399 class CoreExport ConfigReader : public classbase
1402 InspIRCd* ServerInstance;
1403 /** The contents of the configuration file
1404 * This protected member should never be accessed by a module (and cannot be accessed unless the
1405 * core is changed). It will contain a pointer to the configuration file data with unneeded data
1406 * (such as comments) stripped from it.
1408 ConfigDataHash* data;
1409 /** Used to store errors
1411 std::ostringstream* errorlog;
1412 /** If we're using our own config data hash or not
1415 /** True if an error occured reading the config file
1423 /** Default constructor.
1424 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1425 * as specified when running ./configure.
1427 ConfigReader(InspIRCd* Instance);
1428 /** Overloaded constructor.
1429 * This constructor initialises the ConfigReader class to read a user-specified config file
1431 ConfigReader(InspIRCd* Instance, const std::string &filename);
1432 /** Default destructor.
1433 * This method destroys the ConfigReader class.
1437 /** Retrieves a value from the config file.
1438 * This method retrieves a value from the config file. Where multiple copies of the tag
1439 * exist in the config file, index indicates which of the values to retrieve.
1441 std::string ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds = false);
1442 /** Retrieves a value from the config file.
1443 * This method retrieves a value from the config file. Where multiple copies of the tag
1444 * exist in the config file, index indicates which of the values to retrieve. If the
1445 * tag is not found the default value is returned instead.
1447 std::string ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds = false);
1449 /** Retrieves a boolean value from the config file.
1450 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1451 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1452 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1454 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1455 /** Retrieves a boolean value from the config file.
1456 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1457 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1458 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1459 * If the tag is not found, the default value is used instead.
1461 bool ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index);
1463 /** Retrieves an integer value from the config file.
1464 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1465 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1466 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1467 * return CONF_INVALID_NUMBER to be returned. need_positive is set if the number must be non-negative.
1468 * If a negative number is placed into a tag which is specified positive, 0 will be returned and GetError()
1469 * will return CONF_INT_NEGATIVE. Note that need_positive is not suitable to get an unsigned int - you
1470 * should cast the result to achieve that effect.
1472 int ReadInteger(const std::string &tag, const std::string &name, int index, bool need_positive);
1473 /** Retrieves an integer value from the config file.
1474 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1475 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1476 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1477 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1478 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1479 * will return CONF_NOT_UNSIGNED. If the tag is not found, the default value is used instead.
1481 int ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool need_positive);
1483 /** Returns the last error to occur.
1484 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1485 * A call to GetError() resets the error flag back to 0.
1488 /** Counts the number of times a given tag appears in the config file.
1489 * This method counts the number of times a tag appears in a config file, for use where
1490 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1491 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1492 * multiple instance tag.
1494 int Enumerate(const std::string &tag);
1495 /** Returns true if a config file is valid.
1496 * This method is partially implemented and will only return false if the config
1497 * file does not exist or could not be opened.
1500 /** Dumps the list of errors in a config file to an output location. If bail is true,
1501 * then the program will abort. If bail is false and user points to a valid user
1502 * record, the error report will be spooled to the given user by means of NOTICE.
1503 * if bool is false AND user is false, the error report will be spooled to all opers
1504 * by means of a NOTICE to all opers.
1506 void DumpErrors(bool bail,User* user);
1508 /** Returns the number of items within a tag.
1509 * For example if the tag was <test tag="blah" data="foo"> then this
1510 * function would return 2. Spaces and newlines both qualify as valid seperators
1513 int EnumerateValues(const std::string &tag, int index);
1518 /** Caches a text file into memory and can be used to retrieve lines from it.
1519 * This class contains methods for read-only manipulation of a text file in memory.
1520 * Either use the constructor type with one parameter to load a file into memory
1521 * at construction, or use the LoadFile method to load a file.
1523 class CoreExport FileReader : public classbase
1525 InspIRCd* ServerInstance;
1526 /** The file contents
1530 /** Content size in bytes
1532 unsigned long contentsize;
1534 /** Calculate content size in bytes
1539 /** Default constructor.
1540 * This method does not load any file into memory, you must use the LoadFile method
1541 * after constructing the class this way.
1543 FileReader(InspIRCd* Instance);
1545 /** Secondary constructor.
1546 * This method initialises the class with a file loaded into it ready for GetLine and
1547 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1550 FileReader(InspIRCd* Instance, const std::string &filename);
1552 /** Default destructor.
1553 * This deletes the memory allocated to the file.
1557 /** Used to load a file.
1558 * This method loads a file into the class ready for GetLine and
1559 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1562 void LoadFile(const std::string &filename);
1564 /** Returns the whole content of the file as std::string
1566 std::string Contents();
1568 /** Returns the entire size of the file as std::string
1570 unsigned long ContentSize();
1572 /** Returns true if the file exists
1573 * This function will return false if the file could not be opened.
1577 /** Retrieve one line from the file.
1578 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1579 * the index was out of bounds, or the line had no data on it.
1581 std::string GetLine(int x);
1583 /** Returns the size of the file in lines.
1584 * This method returns the number of lines in the read file. If it is 0, no lines have been
1585 * read into memory, either because the file is empty or it does not exist, or cannot be
1586 * opened due to permission problems.
1591 /** A DLLFactory (designed to load shared objects) containing a
1592 * handle to a module's init_module() function. Unfortunately,
1593 * due to the design of shared object systems we must keep this
1594 * hanging around, as if we remove this handle, we remove the
1595 * shared object file from memory (!)
1597 typedef DLLFactory<Module> ircd_module;
1599 /** A list of modules
1601 typedef std::vector<Module*> IntModuleList;
1603 /** An event handler iterator
1605 typedef IntModuleList::iterator EventHandlerIter;
1607 /** ModuleManager takes care of all things module-related
1610 class CoreExport ModuleManager : public classbase
1613 /** Holds a string describing the last module error to occur
1615 std::string LastModuleError;
1617 /** The feature names published by various modules
1619 featurelist Features;
1621 /** The interface names published by various modules
1623 interfacelist Interfaces;
1625 /** Total number of modules loaded into the ircd
1629 /** Our pointer to the main insp instance
1633 /** List of loaded modules and shared object/dll handles
1634 * keyed by module name
1636 std::map<std::string, std::pair<ircd_module*, Module*> > Modules;
1640 /** Event handler hooks.
1641 * This needs to be public to be used by FOREACH_MOD and friends.
1643 IntModuleList EventHandlers[I_END];
1645 /** Simple, bog-standard, boring constructor.
1647 ModuleManager(InspIRCd* Ins);
1653 /** Change the priority of one event in a module.
1654 * Each module event has a list of modules which are attached to that event type.
1655 * If you wish to be called before or after other specific modules, you may use this
1656 * method (usually within void Module::Prioritize()) to set your events priority.
1657 * You may use this call in other methods too, however, this is not supported behaviour
1659 * @param mod The module to change the priority of
1660 * @param i The event to change the priority of
1661 * @param s The state you wish to use for this event. Use one of
1662 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1663 * set it to be the last called, or PRIO_BEFORE and PRIO_AFTER
1664 * to set it to be before or after one or more other modules.
1665 * @param modules If PRIO_BEFORE or PRIO_AFTER is set in parameter 's',
1666 * then this contains a list of one or more modules your module must be
1667 * placed before or after. Your module will be placed before the highest
1668 * priority module in this list for PRIO_BEFORE, or after the lowest
1669 * priority module in this list for PRIO_AFTER.
1670 * @param sz The number of modules being passed for PRIO_BEFORE and PRIO_AFTER.
1671 * Defaults to 1, as most of the time you will only want to prioritize your module
1672 * to be before or after one other module.
1674 bool SetPriority(Module* mod, Implementation i, Priority s, Module** modules = NULL, size_t sz = 1);
1676 /** Change the priority of all events in a module.
1677 * @param mod The module to set the priority of
1678 * @param s The priority of all events in the module.
1679 * Note that with this method, it is not possible to effectively use
1680 * PRIO_BEFORE or PRIO_AFTER, you should use the more fine tuned
1681 * SetPriority method for this, where you may specify other modules to
1682 * be prioritized against.
1684 bool SetPriority(Module* mod, Priority s);
1686 /** Attach an event to a module.
1687 * You may later detatch the event with ModuleManager::Detach().
1688 * If your module is unloaded, all events are automatically detatched.
1689 * @param i Event type to attach
1690 * @param mod Module to attach event to
1691 * @return True if the event was attached
1693 bool Attach(Implementation i, Module* mod);
1695 /** Detatch an event from a module.
1696 * This is not required when your module unloads, as the core will
1697 * automatically detatch your module from all events it is attached to.
1698 * @param i Event type to detach
1699 * @param mod Module to detach event from
1700 * @param Detach true if the event was detached
1702 bool Detach(Implementation i, Module* mod);
1704 /** Attach an array of events to a module
1705 * @param i Event types (array) to attach
1706 * @param mod Module to attach events to
1708 void Attach(Implementation* i, Module* mod, size_t sz);
1710 /** Detach all events from a module (used on unload)
1711 * @param mod Module to detach from
1713 void DetachAll(Module* mod);
1715 /** Returns text describing the last module error
1716 * @return The last error message to occur
1718 std::string& LastError();
1720 /** Load a given module file
1721 * @param filename The file to load
1722 * @return True if the module was found and loaded
1724 bool Load(const char* filename);
1726 /** Unload a given module file
1727 * @param filename The file to unload
1728 * @return True if the module was unloaded
1730 bool Unload(const char* filename);
1732 /** Called by the InspIRCd constructor to load all modules from the config file.
1736 /** Get the total number of currently loaded modules
1737 * @return The number of loaded modules
1741 return this->ModCount;
1744 /** Find a module by name, and return a Module* to it.
1745 * This is preferred over iterating the module lists yourself.
1746 * @param name The module name to look up
1747 * @return A pointer to the module, or NULL if the module cannot be found
1749 Module* Find(const std::string &name);
1751 /** Publish a 'feature'.
1752 * There are two ways for a module to find another module it depends on.
1753 * Either by name, using InspIRCd::FindModule, or by feature, using this
1754 * function. A feature is an arbitary string which identifies something this
1755 * module can do. For example, if your module provides SSL support, but other
1756 * modules provide SSL support too, all the modules supporting SSL should
1757 * publish an identical 'SSL' feature. This way, any module requiring use
1758 * of SSL functions can just look up the 'SSL' feature using FindFeature,
1759 * then use the module pointer they are given.
1760 * @param FeatureName The case sensitive feature name to make available
1761 * @param Mod a pointer to your module class
1762 * @returns True on success, false if the feature is already published by
1765 bool PublishFeature(const std::string &FeatureName, Module* Mod);
1767 /** Publish a module to an 'interface'.
1768 * Modules which implement the same interface (the same way of communicating
1769 * with other modules) can publish themselves to an interface, using this
1770 * method. When they do so, they become part of a list of related or
1771 * compatible modules, and a third module may then query for that list
1772 * and know that all modules within that list offer the same API.
1773 * A prime example of this is the hashing modules, which all accept the
1774 * same types of Request class. Consider this to be similar to PublishFeature,
1775 * except for that multiple modules may publish the same 'feature'.
1776 * @param InterfaceName The case sensitive interface name to make available
1777 * @param Mod a pointer to your module class
1778 * @returns True on success, false on failure (there are currently no failure
1781 bool PublishInterface(const std::string &InterfaceName, Module* Mod);
1783 /** Return a pair saying how many other modules are currently using the
1784 * interfaces provided by module m.
1785 * @param m The module to count usage for
1786 * @return A pair, where the first value is the number of uses of the interface,
1787 * and the second value is the interface name being used.
1789 std::pair<int,std::string> GetInterfaceInstanceCount(Module* m);
1791 /** Mark your module as using an interface.
1792 * If you mark your module as using an interface, then that interface
1793 * module may not unload until your module has unloaded first.
1794 * This can be used to prevent crashes by ensuring code you depend on
1795 * is always in memory while your module is active.
1796 * @param InterfaceName The interface to use
1798 void UseInterface(const std::string &InterfaceName);
1800 /** Mark your module as finished with an interface.
1801 * If you used UseInterface() above, you should use this method when
1802 * your module is finished with the interface (usually in its destructor)
1803 * to allow the modules which implement the given interface to be unloaded.
1804 * @param InterfaceName The interface you are finished with using.
1806 void DoneWithInterface(const std::string &InterfaceName);
1808 /** Unpublish a 'feature'.
1809 * When your module exits, it must call this method for every feature it
1810 * is providing so that the feature table is cleaned up.
1811 * @param FeatureName the feature to remove
1813 bool UnpublishFeature(const std::string &FeatureName);
1815 /** Unpublish your module from an interface
1816 * When your module exits, it must call this method for every interface
1817 * it is part of so that the interfaces table is cleaned up. Only when
1818 * the last item is deleted from an interface does the interface get
1820 * @param InterfaceName the interface to be removed from
1821 * @param Mod The module to remove from the interface list
1823 bool UnpublishInterface(const std::string &InterfaceName, Module* Mod);
1825 /** Find a 'feature'.
1826 * There are two ways for a module to find another module it depends on.
1827 * Either by name, using InspIRCd::FindModule, or by feature, using the
1828 * InspIRCd::PublishFeature method. A feature is an arbitary string which
1829 * identifies something this module can do. For example, if your module
1830 * provides SSL support, but other modules provide SSL support too, all
1831 * the modules supporting SSL should publish an identical 'SSL' feature.
1832 * To find a module capable of providing the feature you want, simply
1833 * call this method with the feature name you are looking for.
1834 * @param FeatureName The feature name you wish to obtain the module for
1835 * @returns A pointer to a valid module class on success, NULL on failure.
1837 Module* FindFeature(const std::string &FeatureName);
1839 /** Find an 'interface'.
1840 * An interface is a list of modules which all implement the same API.
1841 * @param InterfaceName The Interface you wish to obtain the module
1843 * @return A pointer to a deque of Module*, or NULL if the interface
1846 modulelist* FindInterface(const std::string &InterfaceName);
1848 /** Determine if a module has published the named interface.
1849 * This could be used in, for example, OnLoadModule to pick up other modules that can be used.
1850 * @param mod The module to check.
1851 * @param InterfaceName the interface you want to check for
1852 * @return True if the module provides the interface, false otherwise.
1854 bool ModuleHasInterface(Module* mod, const std::string& InterfaceName);
1856 /** Given a pointer to a Module, return its filename
1857 * @param m The module pointer to identify
1858 * @return The module name or an empty string
1860 const std::string& GetModuleName(Module* m);
1862 /** Return a list of all modules matching the given filter
1863 * @param filter This int is a bitmask of flags set in Module::Flags,
1864 * such as VF_VENDOR or VF_STATIC. If you wish to receive a list of
1865 * all modules with no filtering, set this to 0.
1866 * @return The list of module names
1868 const std::vector<std::string> GetAllModuleNames(int filter);
1871 /** This definition is used as shorthand for the various classes
1872 * and functions needed to make a module loadable by the OS.
1873 * It defines the class factory and external init_module function.
1877 #define MODULE_INIT(y) \
1878 extern "C" DllExport Module * init_module(InspIRCd* Me) \
1882 BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
1884 switch ( nReason ) \
1886 case DLL_PROCESS_ATTACH: \
1887 case DLL_PROCESS_DETACH: \
1895 #define MODULE_INIT(y) \
1896 extern "C" DllExport Module * init_module(InspIRCd* Me) \