1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/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 #define API_VERSION 13000
84 /* Forward-delacare module for ModuleMessage etc
89 /** Low level definition of a FileReader classes file cache area -
90 * a text file seperated into lines.
92 typedef std::deque<std::string> file_cache;
96 typedef file_cache string_list;
98 /** Holds a list of 'published features' for modules.
100 typedef std::map<std::string,Module*> featurelist;
102 /** Holds a list of modules which implement an interface
104 typedef std::deque<Module*> modulelist;
106 /** Holds a list of all modules which implement interfaces, by interface name
108 typedef std::map<std::string, std::pair<int, modulelist> > interfacelist;
111 * This #define allows us to call a method in all
112 * loaded modules in a readable simple way, e.g.:
113 * 'FOREACH_MOD(I_OnConnect,OnConnect(user));'
115 #define FOREACH_MOD(y,x) do { \
116 EventHandlerIter safei; \
117 for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ) \
125 catch (CoreException& modexcept) \
127 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
134 * This #define allows us to call a method in all
135 * loaded modules in a readable simple way and pass
136 * an instance pointer to the macro. e.g.:
137 * 'FOREACH_MOD_I(Instance, OnConnect, OnConnect(user));'
139 #define FOREACH_MOD_I(z,y,x) do { \
140 EventHandlerIter safei; \
141 for (EventHandlerIter _i = z->Modules->EventHandlers[y].begin(); _i != z->Modules->EventHandlers[y].end(); ) \
149 catch (CoreException& modexcept) \
151 z->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
158 * This define is similar to the one above but returns a result in MOD_RESULT.
159 * The first module to return a nonzero result is the value to be accepted,
160 * and any modules after are ignored.
162 #define FOREACH_RESULT(y,x) \
164 EventHandlerIter safei; \
166 for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ) \
172 int res = (*_i)->x ; \
178 catch (CoreException& modexcept) \
180 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
188 * This define is similar to the one above but returns a result in MOD_RESULT.
189 * The first module to return a nonzero result is the value to be accepted,
190 * and any modules after are ignored.
192 #define FOREACH_RESULT_I(z,y,x) \
194 EventHandlerIter safei; \
196 for (EventHandlerIter _i = z->Modules->EventHandlers[y].begin(); _i != z->Modules->EventHandlers[y].end(); ) \
202 int res = (*_i)->x ; \
208 catch (CoreException& modexcept) \
210 z->Logs->Log("MODULE",DEBUG,"Exception caught: %s",modexcept.GetReason()); \
216 #define FOREACH_RESULT_MAP(y,x,f) \
218 EventHandlerIter safei; \
219 for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ) \
225 int MOD_RESULT = (*_i)->x ; \
228 catch (CoreException& modexcept) \
230 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
236 /** Represents a non-local user.
237 * (in fact, any FD less than -1 does)
239 #define FD_MAGIC_NUMBER -42
240 /** Represents a fake user (i.e. a server)
242 #define FD_FAKEUSER_NUMBER -7
246 /** Is a local user */
247 #define IS_LOCAL(x) (x->GetFd() > -1)
248 /** Is a remote user */
249 #define IS_REMOTE(x) (x->GetFd() < 0)
250 /** Is a fake user */
251 #define IS_FAKE(x) (x->GetFd() == FD_FAKEUSER_NUMBER)
252 /** Is a module created user */
253 #define IS_MODULE_CREATED(x) (x->GetFd() == FD_MAGIC_NUMBER)
255 #define IS_OPER(x) (!x->oper.empty())
257 #define IS_AWAY(x) (!x->awaymsg.empty())
259 /** Holds a module's Version information.
260 * The four members (set by the constructor only) indicate details as to the version number
261 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
262 * The flags and API values represent the module flags and API version of the module.
263 * The API version of a module must match the API version of the core exactly for the module to
266 class CoreExport Version : public classbase
269 /** Version information.
273 /** Flags and API version
275 const int Flags, API;
277 /** Initialize version class
279 Version(const std::string &sversion, int flags, int api_ver);
282 /** The ModuleMessage class is the base class of Request and Event
283 * This class is used to represent a basic data structure which is passed
284 * between modules for safe inter-module communications.
286 class CoreExport ModuleMessage : public Extensible
291 virtual ~ModuleMessage() {};
294 /** The Request class is a unicast message directed at a given module.
295 * When this class is properly instantiated it may be sent to a module
296 * using the Send() method, which will call the given module's OnRequest
297 * method with this class as its parameter.
299 class CoreExport Request : public ModuleMessage
302 /** This member holds a pointer to arbitary data set by the emitter of the message
305 /** This should be a null-terminated string identifying the type of request,
306 * all modules should define this and use it to determine the nature of the
307 * request before they attempt to cast the Request in any way.
310 /** This is a pointer to the sender of the message, which can be used to
311 * directly trigger events, or to create a reply.
314 /** The single destination of the Request
318 /** Create a new Request
319 * This is for the 'old' way of casting whatever the data is
320 * to char* and hoping you get the right thing at the other end.
321 * This is slowly being depreciated in favor of the 'new' way.
323 Request(char* anydata, Module* src, Module* dst);
324 /** Create a new Request
325 * This is for the 'new' way of defining a subclass
326 * of Request and defining it in a common header,
327 * passing an object of your Request subclass through
328 * as a Request* and using the ID string to determine
329 * what to cast it back to and the other end. This is
330 * much safer as there are no casts not confirmed by
331 * the ID string, and all casts are child->parent and
332 * can be checked at runtime with dynamic_cast<>()
334 Request(Module* src, Module* dst, const char* idstr);
335 /** Fetch the Request data
338 /** Fetch the ID string
341 /** Fetch the request source
344 /** Fetch the request destination (should be 'this' in the receiving module)
347 /** Send the Request.
348 * Upon returning the result will be arbitary data returned by the module you
349 * sent the request to. It is up to your module to know what this data is and
350 * how to deal with it.
356 /** The Event class is a unicast message directed at all modules.
357 * When the class is properly instantiated it may be sent to all modules
358 * using the Send() method, which will trigger the OnEvent method in
359 * all modules passing the object as its parameter.
361 class CoreExport Event : public ModuleMessage
364 /** This member holds a pointer to arbitary data set by the emitter of the message
367 /** This is a pointer to the sender of the message, which can be used to
368 * directly trigger events, or to create a reply.
371 /** The event identifier.
372 * This is arbitary text which should be used to distinguish
373 * one type of event from another.
377 /** Create a new Event
379 Event(char* anydata, Module* src, const std::string &eventid);
380 /** Get the Event data
383 /** Get the event Source
386 /** Get the event ID.
387 * Use this to determine the event type for safe casting of the data
389 std::string GetEventID();
391 * The return result of an Event::Send() will always be NULL as
392 * no replies are expected.
394 char* Send(InspIRCd* ServerInstance);
397 /** Priority types which can be returned from Module::Prioritize()
399 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
401 /** Implementation-specific flags which may be set in Module::Implements()
406 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash, I_OnSendSnotice,
407 I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois, I_OnUserPreInvite,
408 I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick, I_OnUserMessage, I_OnUserNotice, I_OnMode,
409 I_OnGetServerDescription, I_OnSyncUser, I_OnSyncChannel, I_OnSyncChannelMetaData, I_OnSyncUserMetaData,
410 I_OnDecodeMetaData, I_ProtoSendMode, I_ProtoSendMetaData, I_OnWallops, I_OnChangeHost, I_OnChangeName, I_OnAddLine,
411 I_OnDelLine, I_OnExpireLine, I_OnCleanup, I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill,
412 I_OnLoadModule, I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite, I_OnRawMode,
413 I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckExtBan, I_OnCheckStringExtBan, I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos,
414 I_OnLocalTopicChange, I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan, I_OnDelBan,
415 I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead, I_OnChangeLocalUserGECOS, I_OnUserRegister,
416 I_OnChannelPreDelete, I_OnChannelDelete, I_OnPostOper, I_OnSyncOtherMetaData, I_OnSetAway, I_OnUserList,
417 I_OnPostCommand, I_OnPostJoin, I_OnWhoisLine, I_OnBuildExemptList, I_OnRawSocketConnect, I_OnGarbageCollect, I_OnBufferFlushed,
418 I_OnText, I_OnPassCompare, I_OnRunTestSuite, I_OnNamesListItem, I_OnNumeric, I_OnHookUserIO, I_OnHostCycle,
419 I_OnPreRehash, I_OnModuleRehash,
425 /** Base class for all InspIRCd modules
426 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
427 * its methods will be called when irc server events occur. class inherited from module must be
428 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
430 class CoreExport Module : public Extensible
433 /** Creator/owner pointer
435 InspIRCd* ServerInstance;
438 /** Default constructor.
439 * Creates a module class.
440 * @param Me An instance of the InspIRCd class which will be saved into ServerInstance for your use
441 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
443 Module(InspIRCd* Me);
445 /** Default destructor.
446 * destroys a module class
450 virtual void Prioritize()
454 /** Returns the version number of a Module.
455 * The method should return a Version object with its version information assigned via
458 virtual Version GetVersion();
460 /** Called when a user connects.
461 * The details of the connecting user are available to you in the parameter User *user
462 * @param user The user who is connecting
464 virtual void OnUserConnect(User* user);
466 /** Called when a user quits.
467 * The details of the exiting user are available to you in the parameter User *user
468 * This event is only called when the user is fully registered when they quit. To catch
469 * raw disconnections, use the OnUserDisconnect method.
470 * @param user The user who is quitting
471 * @param message The user's quit message (as seen by non-opers)
472 * @param oper_message The user's quit message (as seen by opers)
474 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
476 /** Called whenever a user's socket is closed.
477 * The details of the exiting user are available to you in the parameter User *user
478 * This event is called for all users, registered or not, as a cleanup method for modules
479 * which might assign resources to user, such as dns lookups, objects and sockets.
480 * @param user The user who is disconnecting
482 virtual void OnUserDisconnect(User* user);
484 /** Called whenever a channel is about to be deleted
485 * @param chan The channel being deleted
486 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
488 virtual int OnChannelPreDelete(Channel *chan);
490 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
491 * @param chan The channel being deleted
493 virtual void OnChannelDelete(Channel* chan);
495 /** Called when a user joins a channel.
496 * The details of the joining user are available to you in the parameter User *user,
497 * and the details of the channel they have joined is available in the variable Channel *channel
498 * @param user The user who is joining
499 * @param channel The channel being joined
500 * @param silent Change this to true if you want to conceal the JOIN command from the other users
501 * of the channel (useful for modules such as auditorium)
502 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
503 * to a channel due to the network sync.
504 * @param created This is true if the join created the channel
506 virtual void OnUserJoin(User* user, Channel* channel, bool sync, bool &silent, bool created);
508 /** Called after a user joins a channel
509 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
511 * @param user The user who is joining
512 * @param channel The channel being joined
514 virtual void OnPostJoin(User* user, Channel* channel);
516 /** Called when a user parts a channel.
517 * The details of the leaving user are available to you in the parameter User *user,
518 * and the details of the channel they have left is available in the variable Channel *channel
519 * @param user The user who is parting
520 * @param channel The channel being parted
521 * @param partmessage The part message, or an empty string (may be modified)
522 * @param silent Change this to true if you want to conceal the PART command from the other users
523 * of the channel (useful for modules such as auditorium)
525 virtual void OnUserPart(User* user, Channel* channel, std::string &partmessage, bool &silent);
527 /** Called on rehash.
528 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
529 * system. This is called in all cases -- including when this server will not execute the
530 * rehash because it is directed at a remote server.
532 * @param user The user performing the rehash, if any. If this is server initiated, the value of
533 * this variable will be NULL.
534 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
537 virtual void OnPreRehash(User* user, const std::string ¶meter);
539 /** Called on rehash.
540 * This method is called when a user initiates a module-specific rehash. This can be used to do
541 * expensive operations (such as reloading SSL certificates) that are not executed on a normal
542 * rehash for efficiency. A rehash of this type does not reload the core configuration.
544 * @param user The user performing the rehash.
545 * @param parameter The parameter given to REHASH
547 virtual void OnModuleRehash(User* user, const std::string ¶meter);
549 /** Called on rehash.
550 * This method is called after a rehash has completed. You should use it to reload any module
551 * configuration from the main configuration file.
552 * @param user The user that performed the rehash, if it was initiated by a user and that user
553 * is still connected.
555 virtual void OnRehash(User* user);
557 /** Called whenever a snotice is about to be sent to a snomask.
558 * snomask and type may both be modified; the message may not.
559 * @param snomask The snomask the message is going to (e.g. 'A')
560 * @param type The textual description the snomask will go to (e.g. 'OPER')
561 * @param message The text message to be sent via snotice
562 * @return 1 to block the snotice from being sent entirely, 0 else.
564 virtual int OnSendSnotice(char &snomask, std::string &type, const std::string &message);
566 /** Called whenever a user is about to join a channel, before any processing is done.
567 * Returning a value of 1 from this function stops the process immediately, causing no
568 * output to be sent to the user by the core. If you do this you must produce your own numerics,
569 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
570 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
574 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
575 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
576 * processing on the actual channel record at this point, however the channel NAME will still be passed in
577 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
578 * @param user The user joining the channel
579 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
580 * @param cname The channel name being joined. For new channels this is valid where chan is not.
581 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "@".
582 * You may alter this string to alter the user's modes on the channel.
583 * @param keygiven The key given to join the channel, or an empty string if none was provided
584 * @return 1 To prevent the join, 0 to allow it.
586 virtual int OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string &privs, const std::string &keygiven);
588 /** Called whenever a user is about to be kicked.
589 * Returning a value of 1 from this function stops the process immediately, causing no
590 * output to be sent to the user by the core. If you do this you must produce your own numerics,
592 * @param source The user issuing the kick
593 * @param user The user being kicked
594 * @param chan The channel the user is being kicked from
595 * @param reason The kick reason
596 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
598 virtual int OnUserPreKick(User* source, User* user, Channel* chan, const std::string &reason);
600 /** Called whenever a user is kicked.
601 * If this method is called, the kick is already underway and cannot be prevented, so
602 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
603 * @param source The user issuing the kick
604 * @param user The user being kicked
605 * @param chan The channel the user is being kicked from
606 * @param reason The kick reason
607 * @param silent Change this to true if you want to conceal the PART command from the other users
608 * of the channel (useful for modules such as auditorium)
610 virtual void OnUserKick(User* source, User* user, Channel* chan, const std::string &reason, bool &silent);
612 /** Called whenever a user opers locally.
613 * The User will contain the oper mode 'o' as this function is called after any modifications
614 * are made to the user's structure by the core.
615 * @param user The user who is opering up
616 * @param opertype The opers type name
618 virtual void OnOper(User* user, const std::string &opertype);
620 /** Called after a user opers locally.
621 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
622 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
623 * out the OPERTYPE, etc.
624 * @param user The user who is opering up
625 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
626 * @param opertype The opers type name
628 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
630 /** Called whenever a user types /INFO.
631 * The User will contain the information of the user who typed the command. Modules may use this
632 * method to output their own credits in /INFO (which is the ircd's version of an about box).
633 * It is purposefully not possible to modify any info that has already been output, or halt the list.
634 * You must write a 371 numeric to the user, containing your info in the following format:
636 * <nick> :information here
638 * @param user The user issuing /INFO
640 virtual void OnInfo(User* user);
642 /** Called whenever a /WHOIS is performed on a local user.
643 * The source parameter contains the details of the user who issued the WHOIS command, and
644 * the dest parameter contains the information of the user they are whoising.
645 * @param source The user issuing the WHOIS command
646 * @param dest The user who is being WHOISed
648 virtual void OnWhois(User* source, User* dest);
650 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
651 * Returning 1 from this function stops the process immediately, causing no
652 * output to be sent to the user by the core. If you do this you must produce your own numerics,
653 * notices etc. This is useful for modules which may want to filter invites to channels.
654 * @param source The user who is issuing the INVITE
655 * @param dest The user being invited
656 * @param channel The channel the user is being invited to
657 * @param timeout The time the invite will expire (0 == never)
658 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
660 virtual int OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
662 /** Called after a user has been successfully invited to a channel.
663 * You cannot prevent the invite from occuring using this function, to do that,
664 * use OnUserPreInvite instead.
665 * @param source The user who is issuing the INVITE
666 * @param dest The user being invited
667 * @param channel The channel the user is being invited to
668 * @param timeout The time the invite will expire (0 == never)
670 virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout);
672 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
673 * Returning any nonzero value from this function stops the process immediately, causing no
674 * output to be sent to the user by the core. If you do this you must produce your own numerics,
675 * notices etc. This is useful for modules which may want to filter or redirect messages.
676 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
677 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
678 * of where the message is destined to be sent.
679 * @param user The user sending the message
680 * @param dest The target of the message (Channel* or User*)
681 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
682 * @param text Changeable text being sent by the user
683 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
684 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
685 * It will be ignored for private messages.
686 * @return 1 to deny the message, 0 to allow it
688 virtual int OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
690 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
691 * Returning any nonzero value from this function stops the process immediately, causing no
692 * output to be sent to the user by the core. If you do this you must produce your own numerics,
693 * notices etc. This is useful for modules which may want to filter or redirect messages.
694 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
695 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
696 * of where the message is destined to be sent.
697 * You may alter the message text as you wish before relinquishing control to the next module
698 * in the chain, and if no other modules block the text this altered form of the text will be sent out
699 * to the user and possibly to other servers.
700 * @param user The user sending the message
701 * @param dest The target of the message (Channel* or User*)
702 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
703 * @param text Changeable text being sent by the user
704 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
705 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
706 * It will be ignored for private notices.
707 * @return 1 to deny the NOTICE, 0 to allow it
709 virtual int OnUserPreNotice(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
711 /** Called whenever the server wants to build the exemption list for a channel, but is not directly doing a PRIVMSG or NOTICE.
712 * For example, the spanningtree protocol will call this event when passing a privmsg on (but not processing it directly).
713 * @param message_type The message type, either MSG_PRIVMSG or MSG_NOTICE
714 * @param chan The channel to build the exempt list of
715 * @param sender The original sender of the PRIVMSG or NOTICE
716 * @param status The status char to be used for the channel list
717 * @param exempt_list The exempt list to be populated
718 * @param text The original message text causing the exempt list to be built
720 virtual void OnBuildExemptList(MessageType message_type, Channel* chan, User* sender, char status, CUList &exempt_list, const std::string &text);
722 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
723 * Please note that although you can see remote nickchanges through this function, you should
724 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
725 * check user->server before taking any action (including returning nonzero from the method).
726 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
727 * module to generate some meaninful output.
728 * @param user The username changing their nick
729 * @param newnick Their new nickname
730 * @return 1 to deny the change, 0 to allow
732 virtual int OnUserPreNick(User* user, const std::string &newnick);
734 /** Called after any PRIVMSG 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.
737 * @param user The user sending the message
738 * @param dest The target of the message
739 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
740 * @param text the text being sent by the user
741 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
743 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
745 /** Called after any NOTICE sent from a user.
746 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
747 * if target_type is TYPE_CHANNEL.
748 * @param user The user sending the message
749 * @param dest The target of the message
750 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
751 * @param text the text being sent by the user
752 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
754 virtual void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
756 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
757 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
758 * if target_type is TYPE_CHANNEL.
759 * The difference between this event and OnUserPreNotice/OnUserPreMessage is that delivery is gauranteed,
760 * the message has already been vetted. In the case of the other two methods, a later module may stop your
761 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
762 * @param user The user sending the message
763 * @param dest The target of the message
764 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
765 * @param text the text being sent by the user
766 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
768 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
770 /** Called after every MODE command sent from a user
771 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
772 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
773 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
774 * @param user The user sending the MODEs
775 * @param dest The target of the modes (User* or Channel*)
776 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
777 * @param text The actual modes and their parameters if any
778 * @param translate The translation types of the mode parameters
780 virtual void OnMode(User* user, void* dest, int target_type, const std::vector<std::string> &text, const std::vector<TranslateType> &translate);
782 /** Allows modules to alter or create server descriptions
783 * Whenever a module requires a server description, for example for display in
784 * WHOIS, this function is called in all modules. You may change or define the
785 * description given in std::string &description. If you do, this description
786 * will be shown in the WHOIS fields.
787 * @param servername The servername being searched for
788 * @param description Alterable server description for this server
790 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
792 /** Allows modules to synchronize data which relates to users during a netburst.
793 * When this function is called, it will be called from the module which implements
794 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
795 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
796 * (see below). This function will be called for every user visible on your side
797 * of the burst, allowing you to for example set modes, etc. Do not use this call to
798 * synchronize data which you have stored using class Extensible -- There is a specialist
799 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
800 * @param user The user being syncronized
801 * @param proto A pointer to the module handling network protocol
802 * @param opaque An opaque pointer set by the protocol module, should not be modified!
804 virtual void OnSyncUser(User* user, Module* proto, void* opaque);
806 /** Allows modules to synchronize data which relates to channels during a netburst.
807 * When this function is called, it will be called from the module which implements
808 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
809 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
810 * (see below). This function will be called for every user visible on your side
811 * of the burst, allowing you to for example set modes, etc. Do not use this call to
812 * synchronize data which you have stored using class Extensible -- There is a specialist
813 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
815 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
817 * @param chan The channel being syncronized
818 * @param proto A pointer to the module handling network protocol
819 * @param opaque An opaque pointer set by the protocol module, should not be modified!
821 virtual void OnSyncChannel(Channel* chan, Module* proto, void* opaque);
823 /* Allows modules to syncronize metadata related to channels over the network during a netburst.
824 * Whenever the linking module wants to send out data, but doesnt know what the data
825 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
826 * this method is called.You should use the ProtoSendMetaData function after you've
827 * correctly decided how the data should be represented, to send the metadata on its way if it belongs
828 * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
829 * @param chan The channel whos metadata is being syncronized
830 * @param proto A pointer to the module handling network protocol
831 * @param opaque An opaque pointer set by the protocol module, should not be modified!
832 * @param extname The extensions name which is being searched for
833 * @param displayable If this value is true, the data is going to be displayed to a user,
834 * and not sent across the network. Use this to determine wether or not to show sensitive data.
836 virtual void OnSyncChannelMetaData(Channel* chan, Module* proto,void* opaque, const std::string &extname, bool displayable = false);
838 /* Allows modules to syncronize metadata related to users over the network during a netburst.
839 * Whenever the linking module wants to send out data, but doesnt know what the data
840 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
841 * this method is called. You should use the ProtoSendMetaData function after you've
842 * correctly decided how the data should be represented, to send the metadata on its way if
843 * if it belongs to your module.
844 * @param user The user whos metadata is being syncronized
845 * @param proto A pointer to the module handling network protocol
846 * @param opaque An opaque pointer set by the protocol module, should not be modified!
847 * @param extname The extensions name which is being searched for
848 * @param displayable If this value is true, the data is going to be displayed to a user,
849 * and not sent across the network. Use this to determine wether or not to show sensitive data.
851 virtual void OnSyncUserMetaData(User* user, Module* proto,void* opaque, const std::string &extname, bool displayable = false);
853 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
854 * Whenever the linking module wants to send out data, but doesnt know what the data
855 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
856 * this method is called. You should use the ProtoSendMetaData function after you've
857 * correctly decided how the data should be represented, to send the metadata on its way if
858 * if it belongs to your module.
859 * @param proto A pointer to the module handling network protocol
860 * @param opaque An opaque pointer set by the protocol module, should not be modified!
861 * @param displayable If this value is true, the data is going to be displayed to a user,
862 * and not sent across the network. Use this to determine wether or not to show sensitive data.
864 virtual void OnSyncOtherMetaData(Module* proto, void* opaque, bool displayable = false);
866 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
867 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
868 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
869 * @param target The Channel* or User* that data should be added to
870 * @param extname The extension name which is being sent
871 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
873 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata);
875 /** Implemented by modules which provide the ability to link servers.
876 * These modules will implement this method, which allows transparent sending of servermodes
877 * down the network link as a broadcast, without a module calling it having to know the format
878 * of the MODE command before the actual mode string.
880 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
881 * of how to use this function.
883 * @param opaque An opaque pointer set by the protocol module, should not be modified!
884 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
885 * @param target The Channel* or User* that modes should be sent for
886 * @param modeline The modes and parameters to be sent
887 * @param translate The translation types of the mode parameters
889 virtual void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::vector<std::string> &modeline, const std::vector<TranslateType> &translate);
891 /** Implemented by modules which provide the ability to link servers.
892 * These modules will implement this method, which allows metadata (extra data added to
893 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
894 * to other servers on a netburst and decoded at the other end by the same module on a
897 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
898 * how to use this function.
899 * @param opaque An opaque pointer set by the protocol module, should not be modified!
900 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
901 * @param target The Channel* or User* that metadata should be sent for
902 * @param extname The extension name to send metadata for
903 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
905 virtual void ProtoSendMetaData(void* opaque, TargetTypeFlags target_type, void* target, const std::string &extname, const std::string &extdata);
907 /** Called after every WALLOPS command.
908 * @param user The user sending the WALLOPS
909 * @param text The content of the WALLOPS message
911 virtual void OnWallops(User* user, const std::string &text);
913 /** Called whenever a user's hostname is changed.
914 * This event triggers after the host has been set.
915 * @param user The user whos host is being changed
916 * @param newhost The new hostname being set
918 virtual void OnChangeHost(User* user, const std::string &newhost);
920 /** Called whenever a user's GECOS (realname) is changed.
921 * This event triggers after the name has been set.
922 * @param user The user who's GECOS is being changed
923 * @param gecos The new GECOS being set on the user
925 virtual void OnChangeName(User* user, const std::string &gecos);
927 /** Called whenever an xline is added by a local user.
928 * This method is triggered after the line is added.
929 * @param source The sender of the line or NULL for local server
930 * @param line The xline being added
932 virtual void OnAddLine(User* source, XLine* line);
934 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
935 * This method is triggered after the line is deleted.
936 * @param source The user removing the line or NULL for local server
937 * @param line the line being deleted
939 virtual void OnDelLine(User* source, XLine* line);
941 /** Called whenever an xline expires.
942 * This method is triggered after the line is deleted.
943 * @param line The line being deleted.
945 virtual void OnExpireLine(XLine *line);
947 /** Called before your module is unloaded to clean up Extensibles.
948 * This method is called once for every user and channel on the network,
949 * so that when your module unloads it may clear up any remaining data
950 * in the form of Extensibles added using Extensible::Extend().
951 * If the target_type variable is TYPE_USER, then void* item refers to
952 * a User*, otherwise it refers to a Channel*.
953 * @param target_type The type of item being cleaned
954 * @param item A pointer to the item's class
956 virtual void OnCleanup(int target_type, void* item);
958 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
959 * have been applied. Please note that although you can see remote nickchanges through this function, you should
960 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
961 * check user->server before taking any action (including returning nonzero from the method).
962 * Because this method is called after the nickchange is taken place, no return values are possible
963 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
964 * @param user The user changing their nick
965 * @param oldnick The old nickname of the user before the nickchange
967 virtual void OnUserPostNick(User* user, const std::string &oldnick);
969 /** Called before an action which requires a channel privilage check.
970 * This function is called before many functions which check a users status on a channel, for example
971 * before opping a user, deopping a user, kicking a user, etc.
972 * There are several values for access_type which indicate for what reason access is being checked.
974 * AC_KICK - A user is being kicked<br>
975 * AC_DEOP - a user is being deopped<br>
976 * AC_OP - a user is being opped<br>
977 * AC_VOICE - a user is being voiced<br>
978 * AC_DEVOICE - a user is being devoiced<br>
979 * AC_HALFOP - a user is being halfopped<br>
980 * AC_DEHALFOP - a user is being dehalfopped<br>
981 * AC_INVITE - a user is being invited<br>
982 * AC_GENERAL_MODE - a user channel mode is being changed<br><br>
983 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
984 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
985 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
986 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
987 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
988 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
989 * @param source The source of the access check
990 * @param dest The destination of the access check
991 * @param channel The channel which is being checked
992 * @param access_type See above
994 virtual int OnAccessCheck(User* source,User* dest,Channel* channel,int access_type);
996 /** Called when a 005 numeric is about to be output.
997 * The module should modify the 005 numeric if needed to indicate its features.
998 * @param output The 005 string to be modified if neccessary.
1000 virtual void On005Numeric(std::string &output);
1002 /** Called when a client is disconnected by KILL.
1003 * If a client is killed by a server, e.g. a nickname collision or protocol error,
1005 * Return 1 from this function to prevent the kill, and 0 from this function to allow
1006 * it as normal. If you prevent the kill no output will be sent to the client, it is
1007 * down to your module to generate this information.
1008 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
1009 * If you do so youre risking race conditions, desyncs and worse!
1010 * @param source The user sending the KILL
1011 * @param dest The user being killed
1012 * @param reason The kill reason
1013 * @return 1 to prevent the kill, 0 to allow
1015 virtual int OnKill(User* source, User* dest, const std::string &reason);
1017 /** Called when an oper wants to disconnect a remote user via KILL
1018 * @param source The user sending the KILL
1019 * @param dest The user being killed
1020 * @param reason The kill reason
1022 virtual void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
1024 /** Called whenever a module is loaded.
1025 * mod will contain a pointer to the module, and string will contain its name,
1026 * for example m_widgets.so. This function is primary for dependency checking,
1027 * your module may decide to enable some extra features if it sees that you have
1028 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
1029 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
1030 * but instead operate under reduced functionality, unless the dependency is
1031 * absolutely neccessary (e.g. a module that extends the features of another
1033 * @param mod A pointer to the new module
1034 * @param name The new module's filename
1036 virtual void OnLoadModule(Module* mod,const std::string &name);
1038 /** Called whenever a module is unloaded.
1039 * mod will contain a pointer to the module, and string will contain its name,
1040 * for example m_widgets.so. This function is primary for dependency checking,
1041 * your module may decide to enable some extra features if it sees that you have
1042 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
1043 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
1044 * but instead operate under reduced functionality, unless the dependency is
1045 * absolutely neccessary (e.g. a module that extends the features of another
1047 * @param mod Pointer to the module being unloaded (still valid)
1048 * @param name The filename of the module being unloaded
1050 virtual void OnUnloadModule(Module* mod,const std::string &name);
1052 /** Called once every five seconds for background processing.
1053 * This timer can be used to control timed features. Its period is not accurate
1054 * enough to be used as a clock, but it is gauranteed to be called at least once in
1055 * any five second period, directly from the main loop of the server.
1056 * @param curtime The current timer derived from time(2)
1058 virtual void OnBackgroundTimer(time_t curtime);
1060 /** Called whenever any command is about to be executed.
1061 * This event occurs for all registered commands, wether they are registered in the core,
1062 * or another module, and for invalid commands. Invalid commands may only be sent to this
1063 * function when the value of validated is false. By returning 1 from this method you may prevent the
1064 * command being executed. If you do this, no output is created by the core, and it is
1065 * down to your module to produce any output neccessary.
1066 * Note that unless you return 1, you should not destroy any structures (e.g. by using
1067 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
1068 * method returns, it will be passed an invalid pointer to the user object and crash!)
1069 * @param command The command being executed
1070 * @param parameters An array of array of characters containing the parameters for the command
1071 * @param pcnt The nuimber of parameters passed to the command
1072 * @param user the user issuing the command
1073 * @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.
1074 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
1075 * @param original_line The entire original line as passed to the parser from the user
1076 * @return 1 to block the command, 0 to allow
1078 virtual int OnPreCommand(std::string &command, std::vector<std::string>& parameters, User *user, bool validated, const std::string &original_line);
1080 /** Called after any command has been executed.
1081 * This event occurs for all registered commands, wether they are registered in the core,
1082 * or another module, but it will not occur for invalid commands (e.g. ones which do not
1083 * exist within the command table). The result code returned by the command handler is
1085 * @param command The command being executed
1086 * @param parameters An array of array of characters containing the parameters for the command
1087 * @param pcnt The nuimber of parameters passed to the command
1088 * @param user the user issuing the command
1089 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
1090 * @param original_line The entire original line as passed to the parser from the user
1092 virtual void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, User *user, CmdResult result, const std::string &original_line);
1094 /** Called to check if a user who is connecting can now be allowed to register
1095 * If any modules return false for this function, the user is held in the waiting
1096 * state until all modules return true. For example a module which implements ident
1097 * lookups will continue to return false for a user until their ident lookup is completed.
1098 * Note that the registration timeout for a user overrides these checks, if the registration
1099 * timeout is reached, the user is disconnected even if modules report that the user is
1100 * not ready to connect.
1101 * @param user The user to check
1102 * @return true to indicate readiness, false if otherwise
1104 virtual bool OnCheckReady(User* user);
1106 /** Called whenever a user is about to register their connection (e.g. before the user
1107 * is sent the MOTD etc). Modules can use this method if they are performing a function
1108 * which must be done before the actual connection is completed (e.g. ident lookups,
1109 * dnsbl lookups, etc).
1110 * Note that you should NOT delete the user record here by causing a disconnection!
1111 * Use OnUserConnect for that instead.
1112 * @param user The user registering
1113 * @return 1 to indicate user quit, 0 to continue
1115 virtual int OnUserRegister(User* user);
1117 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1118 * This method will always be called for each join, wether or not the channel is actually +i, and
1119 * determines the outcome of an if statement around the whole section of invite checking code.
1120 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1121 * @param user The user joining the channel
1122 * @param chan The channel being joined
1123 * @return 1 to explicitly allow the join, 0 to proceed as normal
1125 virtual int OnCheckInvite(User* user, Channel* chan);
1127 /** Called whenever a mode character is processed.
1128 * Return 1 from this function to block the mode character from being processed entirely.
1129 * @param user The user who is sending the mode
1130 * @param chan The channel the mode is being sent to (or NULL if a usermode)
1131 * @param mode The mode character being set
1132 * @param param The parameter for the mode or an empty string
1133 * @param adding true of the mode is being added, false if it is being removed
1134 * @param pcnt The parameter count for the mode (0 or 1)
1135 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
1136 * to skip all permission checking. Please note that for remote mode changes, your return value
1139 virtual int OnRawMode(User* user, Channel* chan, const char mode, const std::string ¶m, bool adding, int pcnt, bool servermode = true);
1141 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1142 * This method will always be called for each join, wether or not the channel is actually +k, and
1143 * determines the outcome of an if statement around the whole section of key checking code.
1144 * if the user specified no key, the keygiven string will be a valid but empty value.
1145 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1146 * @param user The user joining the channel
1147 * @param chan The channel being joined
1148 * @return 1 to explicitly allow the join, 0 to proceed as normal
1150 virtual int OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
1152 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1153 * This method will always be called for each join, wether or not the channel is actually +l, and
1154 * determines the outcome of an if statement around the whole section of channel limit checking code.
1155 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1156 * @param user The user joining the channel
1157 * @param chan The channel being joined
1158 * @return 1 to explicitly allow the join, 0 to proceed as normal
1160 virtual int OnCheckLimit(User* user, Channel* chan);
1162 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
1163 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
1164 * determines the outcome of an if statement around the whole section of ban checking code.
1165 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1166 * @param user The user joining the channel
1167 * @param chan The channel being joined
1168 * @return 1 to explicitly allow the join, 0 to proceed as normal. Return -1 to explicitly deny the
1169 * join to the channel.
1171 virtual int OnCheckBan(User* user, Channel* chan);
1173 /* Called whenever checking whether or not a user is matched by an applicable extended bantype.
1174 * NOTE: may also trigger extra OnCheckStringExtBan events!
1175 * @param u The user to check
1176 * @param c The channel the user is on
1177 * @param type The type of extended ban to check for.
1178 * @returns 1 = exempt, 0 = no match, -1 = banned
1180 virtual int OnCheckExtBan(User *u, Channel *c, char type);
1182 /** Called whenever checking whether or not a string is extbanned. NOTE: one OnCheckExtBan will also trigger a number of
1183 * OnCheckStringExtBan events for seperate host/IP comnbinations.
1184 * @returns 1 = exempt, 0 = no match, -1 = banned
1186 virtual int OnCheckStringExtBan(const std::string &s, Channel *c, char type);
1188 /** Called on all /STATS commands
1189 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1190 * @param symbol the symbol provided to /STATS
1191 * @param user the user issuing the /STATS command
1192 * @param results A string_list to append results into. You should put all your results
1193 * into this string_list, rather than displaying them directly, so that your handler will
1194 * work when remote STATS queries are received.
1195 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1197 virtual int OnStats(char symbol, User* user, string_list &results);
1199 /** Called whenever a change of a local users displayed host is attempted.
1200 * Return 1 to deny the host change, or 0 to allow it.
1201 * @param user The user whos host will be changed
1202 * @param newhost The new hostname
1203 * @return 1 to deny the host change, 0 to allow
1205 virtual int OnChangeLocalUserHost(User* user, const std::string &newhost);
1207 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1208 * return 1 to deny the name change, or 0 to allow it.
1209 * @param user The user whos GECOS will be changed
1210 * @param newhost The new GECOS
1211 * @return 1 to deny the GECOS change, 0 to allow
1213 virtual int OnChangeLocalUserGECOS(User* user, const std::string &newhost);
1215 /** Called whenever a topic is changed by a local user.
1216 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
1217 * @param user The user changing the topic
1218 * @param chan The channels who's topic is being changed
1219 * @param topic The actual topic text
1220 * @param 1 to block the topic change, 0 to allow
1222 virtual int OnLocalTopicChange(User* user, Channel* chan, const std::string &topic);
1224 /** Called whenever a local topic has been changed.
1225 * To block topic changes you must use OnLocalTopicChange instead.
1226 * @param user The user changing the topic
1227 * @param chan The channels who's topic is being changed
1228 * @param topic The actual topic text
1230 virtual void OnPostLocalTopicChange(User* user, Channel* chan, const std::string &topic);
1232 /** Called whenever an Event class is sent to all module by another module.
1233 * Please see the documentation of Event::Send() for further information. The Event sent can
1234 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1235 * before doing anything to the event data, and you should *not* change the event data in any way!
1236 * @param event The Event class being received
1238 virtual void OnEvent(Event* event);
1240 /** Called whenever a Request class is sent to your module by another module.
1241 * Please see the documentation of Request::Send() for further information. The Request sent
1242 * can always be assumed to be non-NULL, you should not change the request object or its data.
1243 * Your method may return arbitary data in the char* result which the requesting module
1244 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1245 * @param request The Request class being received
1247 virtual const char* OnRequest(Request* request);
1249 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
1250 * The password field (from the config file) is in 'password' and is to be compared against
1251 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
1252 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
1253 * @param ex The object that's causing the authentication (User* for <oper> <connect:allow> etc, Server* for <link>).
1254 * @param password The password from the configuration file (the password="" value).
1255 * @param input The password entered by the user or whoever.
1256 * @param hashtype The hash value from the config
1257 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
1259 virtual int OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
1261 /** Called whenever a user is given usermode +o, anywhere on the network.
1262 * You cannot override this and prevent it from happening as it is already happened and
1263 * such a task must be performed by another server. You can however bounce modes by sending
1264 * servermodes out to reverse mode changes.
1265 * @param user The user who is opering
1267 virtual void OnGlobalOper(User* user);
1269 /** Called after a user has fully connected and all modules have executed OnUserConnect
1270 * This event is informational only. You should not change any user information in this
1271 * event. To do so, use the OnUserConnect method to change the state of local users.
1272 * This is called for both local and remote users.
1273 * @param user The user who is connecting
1275 virtual void OnPostConnect(User* user);
1277 /** Called whenever a ban is added to a channel's list.
1278 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1279 * @param source The user adding the ban
1280 * @param channel The channel the ban is being added to
1281 * @param banmask The ban mask being added
1282 * @return 1 to block the ban, 0 to continue as normal
1284 virtual int OnAddBan(User* source, Channel* channel,const std::string &banmask);
1286 /** Called whenever a ban is removed from a channel's list.
1287 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1288 * @param source The user deleting the ban
1289 * @param channel The channel the ban is being deleted from
1290 * @param banmask The ban mask being deleted
1291 * @return 1 to block the unban, 0 to continue as normal
1293 virtual int OnDelBan(User* source, Channel* channel,const std::string &banmask);
1295 virtual void OnHookUserIO(User* user);
1297 /** Called immediately after any connection is accepted. This is intended for raw socket
1298 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1299 * no information relating to a user record as the connection has not been assigned yet.
1300 * There are no return values from this call as all modules get an opportunity if required to
1301 * process the connection.
1302 * @param fd The file descriptor returned from accept()
1303 * @param client The client IP address and port
1304 * @param server The server IP address and port
1305 * @param localport The local port number the user connected to
1307 virtual void OnRawSocketAccept(int fd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
1309 /** Called immediately before any write() operation on a user's socket in the core. Because
1310 * this event is a low level event no user information is associated with it. It is intended
1311 * for use by modules which may wrap connections within another API such as SSL for example.
1312 * return a non-zero result if you have handled the write operation, in which case the core
1313 * will not call write().
1314 * @param fd The file descriptor of the socket
1315 * @param buffer A char* buffer being written
1316 * @param Number of characters to write
1317 * @return Number of characters actually written or 0 if you didn't handle the operation
1319 virtual int OnRawSocketWrite(int fd, const char* buffer, int count);
1321 /** Called immediately before any socket is closed. When this event is called, shutdown()
1322 * has not yet been called on the socket.
1323 * @param fd The file descriptor of the socket prior to close()
1325 virtual void OnRawSocketClose(int fd);
1327 /** Called immediately upon connection of an outbound BufferedSocket which has been hooked
1329 * @param fd The file descriptor of the socket immediately after connect()
1331 virtual void OnRawSocketConnect(int fd);
1333 /** Called immediately before any read() operation on a client socket in the core.
1334 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1335 * when this event occurs.
1336 * Your event should return 1 if it has handled the reading itself, which prevents the core
1337 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1338 * the value of count. The value of readresult must be identical to an actual result that might
1339 * be returned from the read() system call, for example, number of bytes read upon success,
1340 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1341 * you MUST set readresult.
1342 * @param fd The file descriptor of the socket
1343 * @param buffer A char* buffer being read to
1344 * @param count The size of the buffer
1345 * @param readresult The amount of characters read, or 0
1346 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1348 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1350 /** Called whenever a user sets away or returns from being away.
1351 * The away message is available as a parameter, but should not be modified.
1352 * At this stage, it has already been copied into the user record.
1353 * If awaymsg is empty, the user is returning from away.
1354 * @param user The user setting away
1355 * @param awaymsg The away message of the user, or empty if returning from away
1356 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
1358 virtual int OnSetAway(User* user, const std::string &awaymsg);
1360 /** Called whenever a NAMES list is requested.
1361 * You can produce the nameslist yourself, overriding the current list,
1362 * and if you do you must return 1. If you do not handle the names list,
1364 * @param The user requesting the NAMES list
1365 * @param Ptr The channel the NAMES list is requested for
1366 * @param userlist The user list for the channel (you may change this pointer.
1367 * If you want to change the values, take a copy first, and change the copy, then
1368 * point the pointer at your copy)
1369 * @return 1 to prevent the user list being sent to the client, 0 to allow it.
1370 * Returning -1 allows the names list, but bypasses any checks which check for
1371 * channel membership before sending the names list.
1373 virtual int OnUserList(User* user, Channel* Ptr, CUList* &userlist);
1375 /** Called whenever a line of WHOIS output is sent to a user.
1376 * You may change the numeric and the text of the output by changing
1377 * the values numeric and text, but you cannot change the user the
1378 * numeric is sent to. You may however change the user's User values.
1379 * @param user The user the numeric is being sent to
1380 * @param dest The user being WHOISed
1381 * @param numeric The numeric of the line being sent
1382 * @param text The text of the numeric, including any parameters
1383 * @return nonzero to drop the line completely so that the user does not
1384 * receive it, or zero to allow the line to be sent.
1386 virtual int OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
1388 /** Called at intervals for modules to garbage-collect any hashes etc.
1389 * Certain data types such as hash_map 'leak' buckets, which must be
1390 * tidied up and freed by copying into a new item every so often. This
1391 * method is called when it is time to do that.
1393 virtual void OnGarbageCollect();
1395 /** Called whenever a user's write buffer has been completely sent.
1396 * This is called when the user's write buffer is completely empty, and
1397 * there are no more pending bytes to be written and no pending write events
1398 * in the socket engine's queue. This may be used to refill the buffer with
1399 * data which is being spooled in a controlled manner, e.g. LIST lines.
1400 * @param user The user who's buffer is now empty.
1402 virtual void OnBufferFlushed(User* user);
1404 /** Add test suite hooks here. These are used for testing functionality of a module
1405 * via the --testsuite debugging parameter.
1407 virtual void OnRunTestSuite();
1409 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
1410 * For example NAMESX, channel mode +u and +I, and UHNAMES. If the nick is set to an empty string by any
1411 * module, then this will cause the nickname not to be displayed at all.
1413 virtual void OnNamesListItem(User* issuer, User* user, Channel* channel, std::string &prefixes, std::string &nick);
1415 virtual int OnNumeric(User* user, unsigned int numeric, const std::string &text);
1417 /** Called for every time the user's host or ident changes, to indicate wether or not the 'Changing host'
1418 * message should be sent, if enabled. Certain modules such as auditorium may opt to hide this message
1419 * even if it is enabled.
1421 virtual bool OnHostCycle(User* user);
1425 #define CONF_NO_ERROR 0x000000
1426 #define CONF_NOT_A_NUMBER 0x000010
1427 #define CONF_INT_NEGATIVE 0x000080
1428 #define CONF_VALUE_NOT_FOUND 0x000100
1429 #define CONF_FILE_NOT_FOUND 0x000200
1432 /** Allows reading of values from configuration files
1433 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1434 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1435 * Constructing the class using one parameter allows you to specify a path to your own configuration
1436 * file, otherwise, inspircd.conf is read.
1438 class CoreExport ConfigReader : public classbase
1441 InspIRCd* ServerInstance;
1447 /** Default constructor.
1448 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1449 * as specified when running ./configure.
1451 ConfigReader(InspIRCd* Instance);
1452 /** Default destructor.
1453 * This method destroys the ConfigReader class.
1457 /** Retrieves a value from the config file.
1458 * This method retrieves a value from the config file. Where multiple copies of the tag
1459 * exist in the config file, index indicates which of the values to retrieve.
1461 std::string ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds = false);
1462 /** Retrieves a value from the config file.
1463 * This method retrieves a value from the config file. Where multiple copies of the tag
1464 * exist in the config file, index indicates which of the values to retrieve. If the
1465 * tag is not found the default value is returned instead.
1467 std::string ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds = false);
1469 /** Retrieves a boolean value from the config file.
1470 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1471 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1472 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1474 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1475 /** Retrieves a boolean value from the config file.
1476 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1477 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1478 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1479 * If the tag is not found, the default value is used instead.
1481 bool ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index);
1483 /** Retrieves an integer value from the config file.
1484 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1485 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1486 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1487 * return CONF_INVALID_NUMBER to be returned. need_positive is set if the number must be non-negative.
1488 * If a negative number is placed into a tag which is specified positive, 0 will be returned and GetError()
1489 * will return CONF_INT_NEGATIVE. Note that need_positive is not suitable to get an unsigned int - you
1490 * should cast the result to achieve that effect.
1492 int ReadInteger(const std::string &tag, const std::string &name, int index, bool need_positive);
1493 /** Retrieves an integer value from the config file.
1494 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1495 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1496 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1497 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1498 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1499 * will return CONF_NOT_UNSIGNED. If the tag is not found, the default value is used instead.
1501 int ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool need_positive);
1503 /** Returns the last error to occur.
1504 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1505 * A call to GetError() resets the error flag back to 0.
1508 /** Counts the number of times a given tag appears in the config file.
1509 * This method counts the number of times a tag appears in a config file, for use where
1510 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1511 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1512 * multiple instance tag.
1514 int Enumerate(const std::string &tag);
1516 /** Returns the number of items within a tag.
1517 * For example if the tag was <test tag="blah" data="foo"> then this
1518 * function would return 2. Spaces and newlines both qualify as valid seperators
1521 int EnumerateValues(const std::string &tag, int index);
1526 /** Caches a text file into memory and can be used to retrieve lines from it.
1527 * This class contains methods for read-only manipulation of a text file in memory.
1528 * Either use the constructor type with one parameter to load a file into memory
1529 * at construction, or use the LoadFile method to load a file.
1531 class CoreExport FileReader : public classbase
1533 InspIRCd* ServerInstance;
1534 /** The file contents
1538 /** Content size in bytes
1540 unsigned long contentsize;
1542 /** Calculate content size in bytes
1547 /** Default constructor.
1548 * This method does not load any file into memory, you must use the LoadFile method
1549 * after constructing the class this way.
1551 FileReader(InspIRCd* Instance);
1553 /** Secondary constructor.
1554 * This method initialises the class with a file loaded into it ready for GetLine and
1555 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1558 FileReader(InspIRCd* Instance, const std::string &filename);
1560 /** Default destructor.
1561 * This deletes the memory allocated to the file.
1565 /** Used to load a file.
1566 * This method loads a file into the class ready for GetLine and
1567 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1570 void LoadFile(const std::string &filename);
1572 /** Returns the whole content of the file as std::string
1574 std::string Contents();
1576 /** Returns the entire size of the file as std::string
1578 unsigned long ContentSize();
1580 /** Returns true if the file exists
1581 * This function will return false if the file could not be opened.
1585 /** Retrieve one line from the file.
1586 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1587 * the index was out of bounds, or the line had no data on it.
1589 std::string GetLine(int x);
1591 /** Returns the size of the file in lines.
1592 * This method returns the number of lines in the read file. If it is 0, no lines have been
1593 * read into memory, either because the file is empty or it does not exist, or cannot be
1594 * opened due to permission problems.
1599 /** A DLLFactory (designed to load shared objects) containing a
1600 * handle to a module's init_module() function. Unfortunately,
1601 * due to the design of shared object systems we must keep this
1602 * hanging around, as if we remove this handle, we remove the
1603 * shared object file from memory (!)
1605 typedef DLLFactory<Module> ircd_module;
1607 /** A list of modules
1609 typedef std::vector<Module*> IntModuleList;
1611 /** An event handler iterator
1613 typedef IntModuleList::iterator EventHandlerIter;
1615 /** ModuleManager takes care of all things module-related
1618 class CoreExport ModuleManager : public classbase
1621 /** Holds a string describing the last module error to occur
1623 std::string LastModuleError;
1625 /** The feature names published by various modules
1627 featurelist Features;
1629 /** The interface names published by various modules
1631 interfacelist Interfaces;
1633 /** Total number of modules loaded into the ircd
1637 /** Our pointer to the main insp instance
1641 /** List of loaded modules and shared object/dll handles
1642 * keyed by module name
1644 std::map<std::string, std::pair<ircd_module*, Module*> > Modules;
1650 } prioritizationState;
1653 /** Event handler hooks.
1654 * This needs to be public to be used by FOREACH_MOD and friends.
1656 IntModuleList EventHandlers[I_END];
1658 /** Simple, bog-standard, boring constructor.
1660 ModuleManager(InspIRCd* Ins);
1666 /** Change the priority of one event in a module.
1667 * Each module event has a list of modules which are attached to that event type.
1668 * If you wish to be called before or after other specific modules, you may use this
1669 * method (usually within void Module::Prioritize()) to set your events priority.
1670 * You may use this call in other methods too, however, this is not supported behaviour
1672 * @param mod The module to change the priority of
1673 * @param i The event to change the priority of
1674 * @param s The state you wish to use for this event. Use one of
1675 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1676 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1677 * to set it to be before or after one or more other modules.
1678 * @param modules If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1679 * then this contains a list of one or more modules your module must be
1680 * placed before or after. Your module will be placed before the highest
1681 * priority module in this list for PRIO_BEFORE, or after the lowest
1682 * priority module in this list for PRIORITY_AFTER.
1683 * @param sz The number of modules being passed for PRIO_BEFORE and PRIORITY_AFTER.
1684 * Defaults to 1, as most of the time you will only want to prioritize your module
1685 * to be before or after one other module.
1687 bool SetPriority(Module* mod, Implementation i, Priority s, Module** modules = NULL, size_t sz = 1);
1689 /** Change the priority of all events in a module.
1690 * @param mod The module to set the priority of
1691 * @param s The priority of all events in the module.
1692 * Note that with this method, it is not possible to effectively use
1693 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1694 * SetPriority method for this, where you may specify other modules to
1695 * be prioritized against.
1697 bool SetPriority(Module* mod, Priority s);
1699 /** Attach an event to a module.
1700 * You may later detatch the event with ModuleManager::Detach().
1701 * If your module is unloaded, all events are automatically detatched.
1702 * @param i Event type to attach
1703 * @param mod Module to attach event to
1704 * @return True if the event was attached
1706 bool Attach(Implementation i, Module* mod);
1708 /** Detatch an event from a module.
1709 * This is not required when your module unloads, as the core will
1710 * automatically detatch your module from all events it is attached to.
1711 * @param i Event type to detach
1712 * @param mod Module to detach event from
1713 * @param Detach true if the event was detached
1715 bool Detach(Implementation i, Module* mod);
1717 /** Attach an array of events to a module
1718 * @param i Event types (array) to attach
1719 * @param mod Module to attach events to
1721 void Attach(Implementation* i, Module* mod, size_t sz);
1723 /** Detach all events from a module (used on unload)
1724 * @param mod Module to detach from
1726 void DetachAll(Module* mod);
1728 /** Returns text describing the last module error
1729 * @return The last error message to occur
1731 std::string& LastError();
1733 /** Load a given module file
1734 * @param filename The file to load
1735 * @return True if the module was found and loaded
1737 bool Load(const char* filename);
1739 /** Unload a given module file
1740 * @param filename The file to unload
1741 * @return True if the module was unloaded
1743 bool Unload(const char* filename);
1745 /** Called by the InspIRCd constructor to load all modules from the config file.
1749 /** Get the total number of currently loaded modules
1750 * @return The number of loaded modules
1754 return this->ModCount;
1757 /** Find a module by name, and return a Module* to it.
1758 * This is preferred over iterating the module lists yourself.
1759 * @param name The module name to look up
1760 * @return A pointer to the module, or NULL if the module cannot be found
1762 Module* Find(const std::string &name);
1764 /** Publish a 'feature'.
1765 * There are two ways for a module to find another module it depends on.
1766 * Either by name, using InspIRCd::FindModule, or by feature, using this
1767 * function. A feature is an arbitary string which identifies something this
1768 * module can do. For example, if your module provides SSL support, but other
1769 * modules provide SSL support too, all the modules supporting SSL should
1770 * publish an identical 'SSL' feature. This way, any module requiring use
1771 * of SSL functions can just look up the 'SSL' feature using FindFeature,
1772 * then use the module pointer they are given.
1773 * @param FeatureName The case sensitive feature name to make available
1774 * @param Mod a pointer to your module class
1775 * @returns True on success, false if the feature is already published by
1778 bool PublishFeature(const std::string &FeatureName, Module* Mod);
1780 /** Publish a module to an 'interface'.
1781 * Modules which implement the same interface (the same way of communicating
1782 * with other modules) can publish themselves to an interface, using this
1783 * method. When they do so, they become part of a list of related or
1784 * compatible modules, and a third module may then query for that list
1785 * and know that all modules within that list offer the same API.
1786 * A prime example of this is the hashing modules, which all accept the
1787 * same types of Request class. Consider this to be similar to PublishFeature,
1788 * except for that multiple modules may publish the same 'feature'.
1789 * @param InterfaceName The case sensitive interface name to make available
1790 * @param Mod a pointer to your module class
1791 * @returns True on success, false on failure (there are currently no failure
1794 bool PublishInterface(const std::string &InterfaceName, Module* Mod);
1796 /** Return a pair saying how many other modules are currently using the
1797 * interfaces provided by module m.
1798 * @param m The module to count usage for
1799 * @return A pair, where the first value is the number of uses of the interface,
1800 * and the second value is the interface name being used.
1802 std::pair<int,std::string> GetInterfaceInstanceCount(Module* m);
1804 /** Mark your module as using an interface.
1805 * If you mark your module as using an interface, then that interface
1806 * module may not unload until your module has unloaded first.
1807 * This can be used to prevent crashes by ensuring code you depend on
1808 * is always in memory while your module is active.
1809 * @param InterfaceName The interface to use
1811 void UseInterface(const std::string &InterfaceName);
1813 /** Mark your module as finished with an interface.
1814 * If you used UseInterface() above, you should use this method when
1815 * your module is finished with the interface (usually in its destructor)
1816 * to allow the modules which implement the given interface to be unloaded.
1817 * @param InterfaceName The interface you are finished with using.
1819 void DoneWithInterface(const std::string &InterfaceName);
1821 /** Unpublish a 'feature'.
1822 * When your module exits, it must call this method for every feature it
1823 * is providing so that the feature table is cleaned up.
1824 * @param FeatureName the feature to remove
1826 bool UnpublishFeature(const std::string &FeatureName);
1828 /** Unpublish your module from an interface
1829 * When your module exits, it must call this method for every interface
1830 * it is part of so that the interfaces table is cleaned up. Only when
1831 * the last item is deleted from an interface does the interface get
1833 * @param InterfaceName the interface to be removed from
1834 * @param Mod The module to remove from the interface list
1836 bool UnpublishInterface(const std::string &InterfaceName, Module* Mod);
1838 /** Find a 'feature'.
1839 * There are two ways for a module to find another module it depends on.
1840 * Either by name, using InspIRCd::FindModule, or by feature, using the
1841 * InspIRCd::PublishFeature method. A feature is an arbitary string which
1842 * identifies something this module can do. For example, if your module
1843 * provides SSL support, but other modules provide SSL support too, all
1844 * the modules supporting SSL should publish an identical 'SSL' feature.
1845 * To find a module capable of providing the feature you want, simply
1846 * call this method with the feature name you are looking for.
1847 * @param FeatureName The feature name you wish to obtain the module for
1848 * @returns A pointer to a valid module class on success, NULL on failure.
1850 Module* FindFeature(const std::string &FeatureName);
1852 /** Find an 'interface'.
1853 * An interface is a list of modules which all implement the same API.
1854 * @param InterfaceName The Interface you wish to obtain the module
1856 * @return A pointer to a deque of Module*, or NULL if the interface
1859 modulelist* FindInterface(const std::string &InterfaceName);
1861 /** Determine if a module has published the named interface.
1862 * This could be used in, for example, OnLoadModule to pick up other modules that can be used.
1863 * @param mod The module to check.
1864 * @param InterfaceName the interface you want to check for
1865 * @return True if the module provides the interface, false otherwise.
1867 bool ModuleHasInterface(Module* mod, const std::string& InterfaceName);
1869 /** Given a pointer to a Module, return its filename
1870 * @param m The module pointer to identify
1871 * @return The module name or an empty string
1873 const std::string& GetModuleName(Module* m);
1875 /** Return a list of all modules matching the given filter
1876 * @param filter This int is a bitmask of flags set in Module::Flags,
1877 * such as VF_VENDOR or VF_STATIC. If you wish to receive a list of
1878 * all modules with no filtering, set this to 0.
1879 * @return The list of module names
1881 const std::vector<std::string> GetAllModuleNames(int filter);
1884 /** This definition is used as shorthand for the various classes
1885 * and functions needed to make a module loadable by the OS.
1886 * It defines the class factory and external init_module function.
1890 #define MODULE_INIT(y) \
1891 extern "C" DllExport Module * init_module(InspIRCd* Me) \
1895 BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
1897 switch ( nReason ) \
1899 case DLL_PROCESS_ATTACH: \
1900 case DLL_PROCESS_DETACH: \
1908 #define MODULE_INIT(y) \
1909 extern "C" DllExport Module * init_module(InspIRCd* Me) \