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()); \
217 * Custom module result handling loop. This is a paired macro, and should only
218 * be used with while_each_hook.
220 * See src/channels.cpp for an example of use.
222 #define DO_EACH_HOOK(z,n,v,args) \
224 EventHandlerIter iter_ ## n = z->Modules->EventHandlers[I_ ## n].begin(); \
225 while (iter_ ## n != z->Modules->EventHandlers[I_ ## n].end()) \
227 Module* mod_ ## n = *iter_ ## n; \
231 v = (mod_ ## n)->n args;
233 #define WHILE_EACH_HOOK(z,n) \
235 catch (CoreException& except_ ## n) \
237 z->Logs->Log("MODULE",DEFAULT,"Exception caught: %s", (except_ ## n).GetReason()); \
238 (void) mod_ ## n; /* catch mismatched pairs */ \
243 /** Represents a non-local user.
244 * (in fact, any FD less than -1 does)
246 #define FD_MAGIC_NUMBER -42
247 /** Represents a fake user (i.e. a server)
249 #define FD_FAKEUSER_NUMBER -7
253 /** Is a local user */
254 #define IS_LOCAL(x) (x->GetFd() > -1)
255 /** Is a remote user */
256 #define IS_REMOTE(x) (x->GetFd() < 0)
257 /** Is a fake user */
258 #define IS_FAKE(x) (x->GetFd() == FD_FAKEUSER_NUMBER)
259 /** Is a module created user */
260 #define IS_MODULE_CREATED(x) (x->GetFd() == FD_MAGIC_NUMBER)
262 #define IS_OPER(x) (!x->oper.empty())
264 #define IS_AWAY(x) (!x->awaymsg.empty())
266 /** Holds a module's Version information.
267 * The four members (set by the constructor only) indicate details as to the version number
268 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
269 * The flags and API values represent the module flags and API version of the module.
270 * The API version of a module must match the API version of the core exactly for the module to
273 class CoreExport Version : public classbase
276 /** Version information.
280 /** Flags and API version
282 const int Flags, API;
284 /** Initialize version class
286 Version(const std::string &sversion, int flags, int api_ver);
289 /** The ModuleMessage class is the base class of Request and Event
290 * This class is used to represent a basic data structure which is passed
291 * between modules for safe inter-module communications.
293 class CoreExport ModuleMessage : public Extensible
298 virtual ~ModuleMessage() {};
301 /** The Request class is a unicast message directed at a given module.
302 * When this class is properly instantiated it may be sent to a module
303 * using the Send() method, which will call the given module's OnRequest
304 * method with this class as its parameter.
306 class CoreExport Request : public ModuleMessage
309 /** This member holds a pointer to arbitary data set by the emitter of the message
312 /** This should be a null-terminated string identifying the type of request,
313 * all modules should define this and use it to determine the nature of the
314 * request before they attempt to cast the Request in any way.
317 /** This is a pointer to the sender of the message, which can be used to
318 * directly trigger events, or to create a reply.
321 /** The single destination of the Request
325 /** Create a new Request
326 * This is for the 'old' way of casting whatever the data is
327 * to char* and hoping you get the right thing at the other end.
328 * This is slowly being depreciated in favor of the 'new' way.
330 Request(char* anydata, Module* src, Module* dst);
331 /** Create a new Request
332 * This is for the 'new' way of defining a subclass
333 * of Request and defining it in a common header,
334 * passing an object of your Request subclass through
335 * as a Request* and using the ID string to determine
336 * what to cast it back to and the other end. This is
337 * much safer as there are no casts not confirmed by
338 * the ID string, and all casts are child->parent and
339 * can be checked at runtime with dynamic_cast<>()
341 Request(Module* src, Module* dst, const char* idstr);
342 /** Fetch the Request data
345 /** Fetch the ID string
348 /** Fetch the request source
351 /** Fetch the request destination (should be 'this' in the receiving module)
354 /** Send the Request.
355 * Upon returning the result will be arbitary data returned by the module you
356 * sent the request to. It is up to your module to know what this data is and
357 * how to deal with it.
363 /** The Event class is a unicast message directed at all modules.
364 * When the class is properly instantiated it may be sent to all modules
365 * using the Send() method, which will trigger the OnEvent method in
366 * all modules passing the object as its parameter.
368 class CoreExport Event : public ModuleMessage
371 /** This member holds a pointer to arbitary data set by the emitter of the message
374 /** This is a pointer to the sender of the message, which can be used to
375 * directly trigger events, or to create a reply.
378 /** The event identifier.
379 * This is arbitary text which should be used to distinguish
380 * one type of event from another.
384 /** Create a new Event
386 Event(char* anydata, Module* src, const std::string &eventid);
387 /** Get the Event data
390 /** Get the event Source
393 /** Get the event ID.
394 * Use this to determine the event type for safe casting of the data
396 std::string GetEventID();
398 * The return result of an Event::Send() will always be NULL as
399 * no replies are expected.
401 char* Send(InspIRCd* ServerInstance);
404 /** Priority types which can be returned from Module::Prioritize()
406 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
408 /** Implementation-specific flags which may be set in Module::Implements()
413 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash, I_OnSendSnotice,
414 I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois, I_OnUserPreInvite,
415 I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick, I_OnUserMessage, I_OnUserNotice, I_OnMode,
416 I_OnGetServerDescription, I_OnSyncUser, I_OnSyncChannel, I_OnSyncChannelMetaData, I_OnSyncUserMetaData,
417 I_OnDecodeMetaData, I_ProtoSendMode, I_ProtoSendMetaData, I_OnWallops, I_OnChangeHost, I_OnChangeName, I_OnAddLine,
418 I_OnDelLine, I_OnExpireLine, I_OnCleanup, I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill,
419 I_OnLoadModule, I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite, I_OnRawMode,
420 I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckExtBan, I_OnCheckStringExtBan, I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos,
421 I_OnLocalTopicChange, I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan, I_OnDelBan,
422 I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead, I_OnChangeLocalUserGECOS, I_OnUserRegister,
423 I_OnChannelPreDelete, I_OnChannelDelete, I_OnPostOper, I_OnSyncOtherMetaData, I_OnSetAway, I_OnUserList,
424 I_OnPostCommand, I_OnPostJoin, I_OnWhoisLine, I_OnBuildExemptList, I_OnRawSocketConnect, I_OnGarbageCollect, I_OnBufferFlushed,
425 I_OnText, I_OnPassCompare, I_OnRunTestSuite, I_OnNamesListItem, I_OnNumeric, I_OnHookUserIO, I_OnHostCycle,
426 I_OnPreRehash, I_OnModuleRehash,
432 /** Base class for all InspIRCd modules
433 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
434 * its methods will be called when irc server events occur. class inherited from module must be
435 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
437 class CoreExport Module : public Extensible
440 /** Creator/owner pointer
442 InspIRCd* ServerInstance;
445 /** Default constructor.
446 * Creates a module class.
447 * @param Me An instance of the InspIRCd class which will be saved into ServerInstance for your use
448 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
450 Module(InspIRCd* Me);
452 /** Default destructor.
453 * destroys a module class
457 virtual void Prioritize()
461 /** Returns the version number of a Module.
462 * The method should return a Version object with its version information assigned via
465 virtual Version GetVersion();
467 /** Called when a user connects.
468 * The details of the connecting user are available to you in the parameter User *user
469 * @param user The user who is connecting
471 virtual void OnUserConnect(User* user);
473 /** Called when a user quits.
474 * The details of the exiting user are available to you in the parameter User *user
475 * This event is only called when the user is fully registered when they quit. To catch
476 * raw disconnections, use the OnUserDisconnect method.
477 * @param user The user who is quitting
478 * @param message The user's quit message (as seen by non-opers)
479 * @param oper_message The user's quit message (as seen by opers)
481 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
483 /** Called whenever a user's socket is closed.
484 * The details of the exiting user are available to you in the parameter User *user
485 * This event is called for all users, registered or not, as a cleanup method for modules
486 * which might assign resources to user, such as dns lookups, objects and sockets.
487 * @param user The user who is disconnecting
489 virtual void OnUserDisconnect(User* user);
491 /** Called whenever a channel is about to be deleted
492 * @param chan The channel being deleted
493 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
495 virtual int OnChannelPreDelete(Channel *chan);
497 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
498 * @param chan The channel being deleted
500 virtual void OnChannelDelete(Channel* chan);
502 /** Called when a user joins a channel.
503 * The details of the joining user are available to you in the parameter User *user,
504 * and the details of the channel they have joined is available in the variable Channel *channel
505 * @param user The user who is joining
506 * @param channel The channel being joined
507 * @param silent Change this to true if you want to conceal the JOIN command from the other users
508 * of the channel (useful for modules such as auditorium)
509 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
510 * to a channel due to the network sync.
511 * @param created This is true if the join created the channel
513 virtual void OnUserJoin(User* user, Channel* channel, bool sync, bool &silent, bool created);
515 /** Called after a user joins a channel
516 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
518 * @param user The user who is joining
519 * @param channel The channel being joined
521 virtual void OnPostJoin(User* user, Channel* channel);
523 /** Called when a user parts a channel.
524 * The details of the leaving user are available to you in the parameter User *user,
525 * and the details of the channel they have left is available in the variable Channel *channel
526 * @param user The user who is parting
527 * @param channel The channel being parted
528 * @param partmessage The part message, or an empty string (may be modified)
529 * @param silent Change this to true if you want to conceal the PART command from the other users
530 * of the channel (useful for modules such as auditorium)
532 virtual void OnUserPart(User* user, Channel* channel, std::string &partmessage, bool &silent);
534 /** Called on rehash.
535 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
536 * system. This is called in all cases -- including when this server will not execute the
537 * rehash because it is directed at a remote server.
539 * @param user The user performing the rehash, if any. If this is server initiated, the value of
540 * this variable will be NULL.
541 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
544 virtual void OnPreRehash(User* user, const std::string ¶meter);
546 /** Called on rehash.
547 * This method is called when a user initiates a module-specific rehash. This can be used to do
548 * expensive operations (such as reloading SSL certificates) that are not executed on a normal
549 * rehash for efficiency. A rehash of this type does not reload the core configuration.
551 * @param user The user performing the rehash.
552 * @param parameter The parameter given to REHASH
554 virtual void OnModuleRehash(User* user, const std::string ¶meter);
556 /** Called on rehash.
557 * This method is called after a rehash has completed. You should use it to reload any module
558 * configuration from the main configuration file.
559 * @param user The user that performed the rehash, if it was initiated by a user and that user
560 * is still connected.
562 virtual void OnRehash(User* user);
564 /** Called whenever a snotice is about to be sent to a snomask.
565 * snomask and type may both be modified; the message may not.
566 * @param snomask The snomask the message is going to (e.g. 'A')
567 * @param type The textual description the snomask will go to (e.g. 'OPER')
568 * @param message The text message to be sent via snotice
569 * @return 1 to block the snotice from being sent entirely, 0 else.
571 virtual int OnSendSnotice(char &snomask, std::string &type, const std::string &message);
573 /** Called whenever a user is about to join a channel, before any processing is done.
574 * Returning a value of 1 from this function stops the process immediately, causing no
575 * output to be sent to the user by the core. If you do this you must produce your own numerics,
576 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
577 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
581 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
582 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
583 * processing on the actual channel record at this point, however the channel NAME will still be passed in
584 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
585 * @param user The user joining the channel
586 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
587 * @param cname The channel name being joined. For new channels this is valid where chan is not.
588 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "@".
589 * You may alter this string to alter the user's modes on the channel.
590 * @param keygiven The key given to join the channel, or an empty string if none was provided
591 * @return 1 To prevent the join, 0 to allow it.
593 virtual int OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string &privs, const std::string &keygiven);
595 /** Called whenever a user is about to be kicked.
596 * Returning a value of 1 from this function stops the process immediately, causing no
597 * output to be sent to the user by the core. If you do this you must produce your own numerics,
599 * @param source The user issuing the kick
600 * @param user The user being kicked
601 * @param chan The channel the user is being kicked from
602 * @param reason The kick reason
603 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
605 virtual int OnUserPreKick(User* source, User* user, Channel* chan, const std::string &reason);
607 /** Called whenever a user is kicked.
608 * If this method is called, the kick is already underway and cannot be prevented, so
609 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
610 * @param source The user issuing the kick
611 * @param user The user being kicked
612 * @param chan The channel the user is being kicked from
613 * @param reason The kick reason
614 * @param silent Change this to true if you want to conceal the PART command from the other users
615 * of the channel (useful for modules such as auditorium)
617 virtual void OnUserKick(User* source, User* user, Channel* chan, const std::string &reason, bool &silent);
619 /** Called whenever a user opers locally.
620 * The User will contain the oper mode 'o' as this function is called after any modifications
621 * are made to the user's structure by the core.
622 * @param user The user who is opering up
623 * @param opertype The opers type name
625 virtual void OnOper(User* user, const std::string &opertype);
627 /** Called after a user opers locally.
628 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
629 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
630 * out the OPERTYPE, etc.
631 * @param user The user who is opering up
632 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
633 * @param opertype The opers type name
635 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
637 /** Called whenever a user types /INFO.
638 * The User will contain the information of the user who typed the command. Modules may use this
639 * method to output their own credits in /INFO (which is the ircd's version of an about box).
640 * It is purposefully not possible to modify any info that has already been output, or halt the list.
641 * You must write a 371 numeric to the user, containing your info in the following format:
643 * <nick> :information here
645 * @param user The user issuing /INFO
647 virtual void OnInfo(User* user);
649 /** Called whenever a /WHOIS is performed on a local user.
650 * The source parameter contains the details of the user who issued the WHOIS command, and
651 * the dest parameter contains the information of the user they are whoising.
652 * @param source The user issuing the WHOIS command
653 * @param dest The user who is being WHOISed
655 virtual void OnWhois(User* source, User* dest);
657 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
658 * Returning 1 from this function stops the process immediately, causing no
659 * output to be sent to the user by the core. If you do this you must produce your own numerics,
660 * notices etc. This is useful for modules which may want to filter invites to channels.
661 * @param source The user who is issuing the INVITE
662 * @param dest The user being invited
663 * @param channel The channel the user is being invited to
664 * @param timeout The time the invite will expire (0 == never)
665 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
667 virtual int OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
669 /** Called after a user has been successfully invited to a channel.
670 * You cannot prevent the invite from occuring using this function, to do that,
671 * use OnUserPreInvite instead.
672 * @param source The user who is issuing the INVITE
673 * @param dest The user being invited
674 * @param channel The channel the user is being invited to
675 * @param timeout The time the invite will expire (0 == never)
677 virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout);
679 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
680 * Returning any nonzero value from this function stops the process immediately, causing no
681 * output to be sent to the user by the core. If you do this you must produce your own numerics,
682 * notices etc. This is useful for modules which may want to filter or redirect messages.
683 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
684 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
685 * of where the message is destined to be sent.
686 * @param user The user sending the message
687 * @param dest The target of the message (Channel* or User*)
688 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
689 * @param text Changeable text being sent by the user
690 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
691 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
692 * It will be ignored for private messages.
693 * @return 1 to deny the message, 0 to allow it
695 virtual int OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
697 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
698 * Returning any nonzero value from this function stops the process immediately, causing no
699 * output to be sent to the user by the core. If you do this you must produce your own numerics,
700 * notices etc. This is useful for modules which may want to filter or redirect messages.
701 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
702 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
703 * of where the message is destined to be sent.
704 * You may alter the message text as you wish before relinquishing control to the next module
705 * in the chain, and if no other modules block the text this altered form of the text will be sent out
706 * to the user and possibly to other servers.
707 * @param user The user sending the message
708 * @param dest The target of the message (Channel* or User*)
709 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
710 * @param text Changeable text being sent by the user
711 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
712 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
713 * It will be ignored for private notices.
714 * @return 1 to deny the NOTICE, 0 to allow it
716 virtual int OnUserPreNotice(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
718 /** Called whenever the server wants to build the exemption list for a channel, but is not directly doing a PRIVMSG or NOTICE.
719 * For example, the spanningtree protocol will call this event when passing a privmsg on (but not processing it directly).
720 * @param message_type The message type, either MSG_PRIVMSG or MSG_NOTICE
721 * @param chan The channel to build the exempt list of
722 * @param sender The original sender of the PRIVMSG or NOTICE
723 * @param status The status char to be used for the channel list
724 * @param exempt_list The exempt list to be populated
725 * @param text The original message text causing the exempt list to be built
727 virtual void OnBuildExemptList(MessageType message_type, Channel* chan, User* sender, char status, CUList &exempt_list, const std::string &text);
729 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
730 * Please note that although you can see remote nickchanges through this function, you should
731 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
732 * check user->server before taking any action (including returning nonzero from the method).
733 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
734 * module to generate some meaninful output.
735 * @param user The username changing their nick
736 * @param newnick Their new nickname
737 * @return 1 to deny the change, 0 to allow
739 virtual int OnUserPreNick(User* user, const std::string &newnick);
741 /** Called after any PRIVMSG sent from a user.
742 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
743 * if target_type is TYPE_CHANNEL.
744 * @param user The user sending the message
745 * @param dest The target of the message
746 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
747 * @param text the text being sent by the user
748 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
750 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
752 /** Called after any NOTICE sent from a user.
753 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
754 * if target_type is TYPE_CHANNEL.
755 * @param user The user sending the message
756 * @param dest The target of the message
757 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
758 * @param text the text being sent by the user
759 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
761 virtual void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
763 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
764 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
765 * if target_type is TYPE_CHANNEL.
766 * The difference between this event and OnUserPreNotice/OnUserPreMessage is that delivery is gauranteed,
767 * the message has already been vetted. In the case of the other two methods, a later module may stop your
768 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
769 * @param user The user sending the message
770 * @param dest The target of the message
771 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
772 * @param text the text being sent by the user
773 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
775 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
777 /** Called after every MODE command sent from a user
778 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
779 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
780 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
781 * @param user The user sending the MODEs
782 * @param dest The target of the modes (User* or Channel*)
783 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
784 * @param text The actual modes and their parameters if any
785 * @param translate The translation types of the mode parameters
787 virtual void OnMode(User* user, void* dest, int target_type, const std::vector<std::string> &text, const std::vector<TranslateType> &translate);
789 /** Allows modules to alter or create server descriptions
790 * Whenever a module requires a server description, for example for display in
791 * WHOIS, this function is called in all modules. You may change or define the
792 * description given in std::string &description. If you do, this description
793 * will be shown in the WHOIS fields.
794 * @param servername The servername being searched for
795 * @param description Alterable server description for this server
797 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
799 /** Allows modules to synchronize data which relates to users during a netburst.
800 * When this function is called, it will be called from the module which implements
801 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
802 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
803 * (see below). This function will be called for every user visible on your side
804 * of the burst, allowing you to for example set modes, etc. Do not use this call to
805 * synchronize data which you have stored using class Extensible -- There is a specialist
806 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
807 * @param user The user being syncronized
808 * @param proto A pointer to the module handling network protocol
809 * @param opaque An opaque pointer set by the protocol module, should not be modified!
811 virtual void OnSyncUser(User* user, Module* proto, void* opaque);
813 /** Allows modules to synchronize data which relates to channels during a netburst.
814 * When this function is called, it will be called from the module which implements
815 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
816 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
817 * (see below). This function will be called for every user visible on your side
818 * of the burst, allowing you to for example set modes, etc. Do not use this call to
819 * synchronize data which you have stored using class Extensible -- There is a specialist
820 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
822 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
824 * @param chan The channel being syncronized
825 * @param proto A pointer to the module handling network protocol
826 * @param opaque An opaque pointer set by the protocol module, should not be modified!
828 virtual void OnSyncChannel(Channel* chan, Module* proto, void* opaque);
830 /* Allows modules to syncronize metadata related to channels over the network during a netburst.
831 * Whenever the linking module wants to send out data, but doesnt know what the data
832 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
833 * this method is called.You should use the ProtoSendMetaData function after you've
834 * correctly decided how the data should be represented, to send the metadata on its way if it belongs
835 * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
836 * @param chan The channel whos metadata is being syncronized
837 * @param proto A pointer to the module handling network protocol
838 * @param opaque An opaque pointer set by the protocol module, should not be modified!
839 * @param extname The extensions name which is being searched for
840 * @param displayable If this value is true, the data is going to be displayed to a user,
841 * and not sent across the network. Use this to determine wether or not to show sensitive data.
843 virtual void OnSyncChannelMetaData(Channel* chan, Module* proto,void* opaque, const std::string &extname, bool displayable = false);
845 /* Allows modules to syncronize metadata related to users over the network during a netburst.
846 * Whenever the linking module wants to send out data, but doesnt know what the data
847 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
848 * this method is called. You should use the ProtoSendMetaData function after you've
849 * correctly decided how the data should be represented, to send the metadata on its way if
850 * if it belongs to your module.
851 * @param user The user whos metadata is being syncronized
852 * @param proto A pointer to the module handling network protocol
853 * @param opaque An opaque pointer set by the protocol module, should not be modified!
854 * @param extname The extensions name which is being searched for
855 * @param displayable If this value is true, the data is going to be displayed to a user,
856 * and not sent across the network. Use this to determine wether or not to show sensitive data.
858 virtual void OnSyncUserMetaData(User* user, Module* proto,void* opaque, const std::string &extname, bool displayable = false);
860 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
861 * Whenever the linking module wants to send out data, but doesnt know what the data
862 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
863 * this method is called. You should use the ProtoSendMetaData function after you've
864 * correctly decided how the data should be represented, to send the metadata on its way if
865 * if it belongs to your module.
866 * @param proto A pointer to the module handling network protocol
867 * @param opaque An opaque pointer set by the protocol module, should not be modified!
868 * @param displayable If this value is true, the data is going to be displayed to a user,
869 * and not sent across the network. Use this to determine wether or not to show sensitive data.
871 virtual void OnSyncOtherMetaData(Module* proto, void* opaque, bool displayable = false);
873 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
874 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
875 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
876 * @param target The Channel* or User* that data should be added to
877 * @param extname The extension name which is being sent
878 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
880 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata);
882 /** Implemented by modules which provide the ability to link servers.
883 * These modules will implement this method, which allows transparent sending of servermodes
884 * down the network link as a broadcast, without a module calling it having to know the format
885 * of the MODE command before the actual mode string.
887 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
888 * of how to use this function.
890 * @param opaque An opaque pointer set by the protocol module, should not be modified!
891 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
892 * @param target The Channel* or User* that modes should be sent for
893 * @param modeline The modes and parameters to be sent
894 * @param translate The translation types of the mode parameters
896 virtual void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::vector<std::string> &modeline, const std::vector<TranslateType> &translate);
898 /** Implemented by modules which provide the ability to link servers.
899 * These modules will implement this method, which allows metadata (extra data added to
900 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
901 * to other servers on a netburst and decoded at the other end by the same module on a
904 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
905 * how to use this function.
906 * @param opaque An opaque pointer set by the protocol module, should not be modified!
907 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
908 * @param target The Channel* or User* that metadata should be sent for
909 * @param extname The extension name to send metadata for
910 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
912 virtual void ProtoSendMetaData(void* opaque, TargetTypeFlags target_type, void* target, const std::string &extname, const std::string &extdata);
914 /** Called after every WALLOPS command.
915 * @param user The user sending the WALLOPS
916 * @param text The content of the WALLOPS message
918 virtual void OnWallops(User* user, const std::string &text);
920 /** Called whenever a user's hostname is changed.
921 * This event triggers after the host has been set.
922 * @param user The user whos host is being changed
923 * @param newhost The new hostname being set
925 virtual void OnChangeHost(User* user, const std::string &newhost);
927 /** Called whenever a user's GECOS (realname) is changed.
928 * This event triggers after the name has been set.
929 * @param user The user who's GECOS is being changed
930 * @param gecos The new GECOS being set on the user
932 virtual void OnChangeName(User* user, const std::string &gecos);
934 /** Called whenever an xline is added by a local user.
935 * This method is triggered after the line is added.
936 * @param source The sender of the line or NULL for local server
937 * @param line The xline being added
939 virtual void OnAddLine(User* source, XLine* line);
941 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
942 * This method is triggered after the line is deleted.
943 * @param source The user removing the line or NULL for local server
944 * @param line the line being deleted
946 virtual void OnDelLine(User* source, XLine* line);
948 /** Called whenever an xline expires.
949 * This method is triggered after the line is deleted.
950 * @param line The line being deleted.
952 virtual void OnExpireLine(XLine *line);
954 /** Called before your module is unloaded to clean up Extensibles.
955 * This method is called once for every user and channel on the network,
956 * so that when your module unloads it may clear up any remaining data
957 * in the form of Extensibles added using Extensible::Extend().
958 * If the target_type variable is TYPE_USER, then void* item refers to
959 * a User*, otherwise it refers to a Channel*.
960 * @param target_type The type of item being cleaned
961 * @param item A pointer to the item's class
963 virtual void OnCleanup(int target_type, void* item);
965 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
966 * have been applied. Please note that although you can see remote nickchanges through this function, you should
967 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
968 * check user->server before taking any action (including returning nonzero from the method).
969 * Because this method is called after the nickchange is taken place, no return values are possible
970 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
971 * @param user The user changing their nick
972 * @param oldnick The old nickname of the user before the nickchange
974 virtual void OnUserPostNick(User* user, const std::string &oldnick);
976 /** Called before an action which requires a channel privilage check.
977 * This function is called before many functions which check a users status on a channel, for example
978 * before opping a user, deopping a user, kicking a user, etc.
979 * There are several values for access_type which indicate for what reason access is being checked.
981 * AC_KICK - A user is being kicked<br>
982 * AC_DEOP - a user is being deopped<br>
983 * AC_OP - a user is being opped<br>
984 * AC_VOICE - a user is being voiced<br>
985 * AC_DEVOICE - a user is being devoiced<br>
986 * AC_HALFOP - a user is being halfopped<br>
987 * AC_DEHALFOP - a user is being dehalfopped<br>
988 * AC_INVITE - a user is being invited<br>
989 * AC_GENERAL_MODE - a user channel mode is being changed<br><br>
990 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
991 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
992 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
993 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
994 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
995 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
996 * @param source The source of the access check
997 * @param dest The destination of the access check
998 * @param channel The channel which is being checked
999 * @param access_type See above
1001 virtual int OnAccessCheck(User* source,User* dest,Channel* channel,int access_type);
1003 /** Called when a 005 numeric is about to be output.
1004 * The module should modify the 005 numeric if needed to indicate its features.
1005 * @param output The 005 string to be modified if neccessary.
1007 virtual void On005Numeric(std::string &output);
1009 /** Called when a client is disconnected by KILL.
1010 * If a client is killed by a server, e.g. a nickname collision or protocol error,
1012 * Return 1 from this function to prevent the kill, and 0 from this function to allow
1013 * it as normal. If you prevent the kill no output will be sent to the client, it is
1014 * down to your module to generate this information.
1015 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
1016 * If you do so youre risking race conditions, desyncs and worse!
1017 * @param source The user sending the KILL
1018 * @param dest The user being killed
1019 * @param reason The kill reason
1020 * @return 1 to prevent the kill, 0 to allow
1022 virtual int OnKill(User* source, User* dest, const std::string &reason);
1024 /** Called when an oper wants to disconnect a remote user via KILL
1025 * @param source The user sending the KILL
1026 * @param dest The user being killed
1027 * @param reason The kill reason
1029 virtual void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
1031 /** Called whenever a module is loaded.
1032 * mod will contain a pointer to the module, and string will contain its name,
1033 * for example m_widgets.so. This function is primary for dependency checking,
1034 * your module may decide to enable some extra features if it sees that you have
1035 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
1036 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
1037 * but instead operate under reduced functionality, unless the dependency is
1038 * absolutely neccessary (e.g. a module that extends the features of another
1040 * @param mod A pointer to the new module
1041 * @param name The new module's filename
1043 virtual void OnLoadModule(Module* mod,const std::string &name);
1045 /** Called whenever a module is unloaded.
1046 * mod will contain a pointer to the module, and string will contain its name,
1047 * for example m_widgets.so. This function is primary for dependency checking,
1048 * your module may decide to enable some extra features if it sees that you have
1049 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
1050 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
1051 * but instead operate under reduced functionality, unless the dependency is
1052 * absolutely neccessary (e.g. a module that extends the features of another
1054 * @param mod Pointer to the module being unloaded (still valid)
1055 * @param name The filename of the module being unloaded
1057 virtual void OnUnloadModule(Module* mod,const std::string &name);
1059 /** Called once every five seconds for background processing.
1060 * This timer can be used to control timed features. Its period is not accurate
1061 * enough to be used as a clock, but it is gauranteed to be called at least once in
1062 * any five second period, directly from the main loop of the server.
1063 * @param curtime The current timer derived from time(2)
1065 virtual void OnBackgroundTimer(time_t curtime);
1067 /** Called whenever any command is about to be executed.
1068 * This event occurs for all registered commands, wether they are registered in the core,
1069 * or another module, and for invalid commands. Invalid commands may only be sent to this
1070 * function when the value of validated is false. By returning 1 from this method you may prevent the
1071 * command being executed. If you do this, no output is created by the core, and it is
1072 * down to your module to produce any output neccessary.
1073 * Note that unless you return 1, you should not destroy any structures (e.g. by using
1074 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
1075 * method returns, it will be passed an invalid pointer to the user object and crash!)
1076 * @param command The command being executed
1077 * @param parameters An array of array of characters containing the parameters for the command
1078 * @param pcnt The nuimber of parameters passed to the command
1079 * @param user the user issuing the command
1080 * @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.
1081 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
1082 * @param original_line The entire original line as passed to the parser from the user
1083 * @return 1 to block the command, 0 to allow
1085 virtual int OnPreCommand(std::string &command, std::vector<std::string>& parameters, User *user, bool validated, const std::string &original_line);
1087 /** Called after any command has been executed.
1088 * This event occurs for all registered commands, wether they are registered in the core,
1089 * or another module, but it will not occur for invalid commands (e.g. ones which do not
1090 * exist within the command table). The result code returned by the command handler is
1092 * @param command The command being executed
1093 * @param parameters An array of array of characters containing the parameters for the command
1094 * @param pcnt The nuimber of parameters passed to the command
1095 * @param user the user issuing the command
1096 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
1097 * @param original_line The entire original line as passed to the parser from the user
1099 virtual void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, User *user, CmdResult result, const std::string &original_line);
1101 /** Called to check if a user who is connecting can now be allowed to register
1102 * If any modules return false for this function, the user is held in the waiting
1103 * state until all modules return true. For example a module which implements ident
1104 * lookups will continue to return false for a user until their ident lookup is completed.
1105 * Note that the registration timeout for a user overrides these checks, if the registration
1106 * timeout is reached, the user is disconnected even if modules report that the user is
1107 * not ready to connect.
1108 * @param user The user to check
1109 * @return true to indicate readiness, false if otherwise
1111 virtual bool OnCheckReady(User* user);
1113 /** Called whenever a user is about to register their connection (e.g. before the user
1114 * is sent the MOTD etc). Modules can use this method if they are performing a function
1115 * which must be done before the actual connection is completed (e.g. ident lookups,
1116 * dnsbl lookups, etc).
1117 * Note that you should NOT delete the user record here by causing a disconnection!
1118 * Use OnUserConnect for that instead.
1119 * @param user The user registering
1120 * @return 1 to indicate user quit, 0 to continue
1122 virtual int OnUserRegister(User* user);
1124 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1125 * This method will always be called for each join, wether or not the channel is actually +i, and
1126 * determines the outcome of an if statement around the whole section of invite checking code.
1127 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1128 * @param user The user joining the channel
1129 * @param chan The channel being joined
1130 * @return 1 to explicitly allow the join, 0 to proceed as normal
1132 virtual int OnCheckInvite(User* user, Channel* chan);
1134 /** Called whenever a mode character is processed.
1135 * Return 1 from this function to block the mode character from being processed entirely.
1136 * @param user The user who is sending the mode
1137 * @param chan The channel the mode is being sent to (or NULL if a usermode)
1138 * @param mode The mode character being set
1139 * @param param The parameter for the mode or an empty string
1140 * @param adding true of the mode is being added, false if it is being removed
1141 * @param pcnt The parameter count for the mode (0 or 1)
1142 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
1143 * to skip all permission checking. Please note that for remote mode changes, your return value
1146 virtual int OnRawMode(User* user, Channel* chan, const char mode, const std::string ¶m, bool adding, int pcnt, bool servermode = true);
1148 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1149 * This method will always be called for each join, wether or not the channel is actually +k, and
1150 * determines the outcome of an if statement around the whole section of key checking code.
1151 * if the user specified no key, the keygiven string will be a valid but empty value.
1152 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1153 * @param user The user joining the channel
1154 * @param chan The channel being joined
1155 * @return 1 to explicitly allow the join, 0 to proceed as normal
1157 virtual int OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
1159 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1160 * This method will always be called for each join, wether or not the channel is actually +l, and
1161 * determines the outcome of an if statement around the whole section of channel limit checking code.
1162 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1163 * @param user The user joining the channel
1164 * @param chan The channel being joined
1165 * @return 1 to explicitly allow the join, 0 to proceed as normal
1167 virtual int OnCheckLimit(User* user, Channel* chan);
1169 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
1170 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
1171 * determines the outcome of an if statement around the whole section of ban checking code.
1172 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1173 * @param user The user joining the channel
1174 * @param chan The channel being joined
1175 * @return 1 to explicitly allow the join, 0 to proceed as normal. Return -1 to explicitly deny the
1176 * join to the channel.
1178 virtual int OnCheckBan(User* user, Channel* chan);
1180 /* Called whenever checking whether or not a user is matched by an applicable extended bantype.
1181 * NOTE: may also trigger extra OnCheckStringExtBan events!
1182 * @param u The user to check
1183 * @param c The channel the user is on
1184 * @param type The type of extended ban to check for.
1185 * @returns 1 = exempt, 0 = no match, -1 = banned
1187 virtual int OnCheckExtBan(User *u, Channel *c, char type);
1189 /** Called whenever checking whether or not a string is extbanned. NOTE: one OnCheckExtBan will also trigger a number of
1190 * OnCheckStringExtBan events for seperate host/IP comnbinations.
1191 * @returns 1 = exempt, 0 = no match, -1 = banned
1193 virtual int OnCheckStringExtBan(const std::string &s, Channel *c, char type);
1195 /** Called on all /STATS commands
1196 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1197 * @param symbol the symbol provided to /STATS
1198 * @param user the user issuing the /STATS command
1199 * @param results A string_list to append results into. You should put all your results
1200 * into this string_list, rather than displaying them directly, so that your handler will
1201 * work when remote STATS queries are received.
1202 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1204 virtual int OnStats(char symbol, User* user, string_list &results);
1206 /** Called whenever a change of a local users displayed host is attempted.
1207 * Return 1 to deny the host change, or 0 to allow it.
1208 * @param user The user whos host will be changed
1209 * @param newhost The new hostname
1210 * @return 1 to deny the host change, 0 to allow
1212 virtual int OnChangeLocalUserHost(User* user, const std::string &newhost);
1214 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1215 * return 1 to deny the name change, or 0 to allow it.
1216 * @param user The user whos GECOS will be changed
1217 * @param newhost The new GECOS
1218 * @return 1 to deny the GECOS change, 0 to allow
1220 virtual int OnChangeLocalUserGECOS(User* user, const std::string &newhost);
1222 /** Called whenever a topic is changed by a local user.
1223 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
1224 * @param user The user changing the topic
1225 * @param chan The channels who's topic is being changed
1226 * @param topic The actual topic text
1227 * @param 1 to block the topic change, 0 to allow
1229 virtual int OnLocalTopicChange(User* user, Channel* chan, const std::string &topic);
1231 /** Called whenever a local topic has been changed.
1232 * To block topic changes you must use OnLocalTopicChange instead.
1233 * @param user The user changing the topic
1234 * @param chan The channels who's topic is being changed
1235 * @param topic The actual topic text
1237 virtual void OnPostLocalTopicChange(User* user, Channel* chan, const std::string &topic);
1239 /** Called whenever an Event class is sent to all module by another module.
1240 * Please see the documentation of Event::Send() for further information. The Event sent can
1241 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1242 * before doing anything to the event data, and you should *not* change the event data in any way!
1243 * @param event The Event class being received
1245 virtual void OnEvent(Event* event);
1247 /** Called whenever a Request class is sent to your module by another module.
1248 * Please see the documentation of Request::Send() for further information. The Request sent
1249 * can always be assumed to be non-NULL, you should not change the request object or its data.
1250 * Your method may return arbitary data in the char* result which the requesting module
1251 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1252 * @param request The Request class being received
1254 virtual const char* OnRequest(Request* request);
1256 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
1257 * The password field (from the config file) is in 'password' and is to be compared against
1258 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
1259 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
1260 * @param ex The object that's causing the authentication (User* for <oper> <connect:allow> etc, Server* for <link>).
1261 * @param password The password from the configuration file (the password="" value).
1262 * @param input The password entered by the user or whoever.
1263 * @param hashtype The hash value from the config
1264 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
1266 virtual int OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
1268 /** Called whenever a user is given usermode +o, anywhere on the network.
1269 * You cannot override this and prevent it from happening as it is already happened and
1270 * such a task must be performed by another server. You can however bounce modes by sending
1271 * servermodes out to reverse mode changes.
1272 * @param user The user who is opering
1274 virtual void OnGlobalOper(User* user);
1276 /** Called after a user has fully connected and all modules have executed OnUserConnect
1277 * This event is informational only. You should not change any user information in this
1278 * event. To do so, use the OnUserConnect method to change the state of local users.
1279 * This is called for both local and remote users.
1280 * @param user The user who is connecting
1282 virtual void OnPostConnect(User* user);
1284 /** Called whenever a ban is added to a channel's list.
1285 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1286 * @param source The user adding the ban
1287 * @param channel The channel the ban is being added to
1288 * @param banmask The ban mask being added
1289 * @return 1 to block the ban, 0 to continue as normal
1291 virtual int OnAddBan(User* source, Channel* channel,const std::string &banmask);
1293 /** Called whenever a ban is removed from a channel's list.
1294 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1295 * @param source The user deleting the ban
1296 * @param channel The channel the ban is being deleted from
1297 * @param banmask The ban mask being deleted
1298 * @return 1 to block the unban, 0 to continue as normal
1300 virtual int OnDelBan(User* source, Channel* channel,const std::string &banmask);
1302 virtual void OnHookUserIO(User* user);
1304 /** Called immediately after any connection is accepted. This is intended for raw socket
1305 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1306 * no information relating to a user record as the connection has not been assigned yet.
1307 * There are no return values from this call as all modules get an opportunity if required to
1308 * process the connection.
1309 * @param fd The file descriptor returned from accept()
1310 * @param client The client IP address and port
1311 * @param server The server IP address and port
1312 * @param localport The local port number the user connected to
1314 virtual void OnRawSocketAccept(int fd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
1316 /** Called immediately before any write() operation on a user's socket in the core. Because
1317 * this event is a low level event no user information is associated with it. It is intended
1318 * for use by modules which may wrap connections within another API such as SSL for example.
1319 * return a non-zero result if you have handled the write operation, in which case the core
1320 * will not call write().
1321 * @param fd The file descriptor of the socket
1322 * @param buffer A char* buffer being written
1323 * @param Number of characters to write
1324 * @return Number of characters actually written or 0 if you didn't handle the operation
1326 virtual int OnRawSocketWrite(int fd, const char* buffer, int count);
1328 /** Called immediately before any socket is closed. When this event is called, shutdown()
1329 * has not yet been called on the socket.
1330 * @param fd The file descriptor of the socket prior to close()
1332 virtual void OnRawSocketClose(int fd);
1334 /** Called immediately upon connection of an outbound BufferedSocket which has been hooked
1336 * @param fd The file descriptor of the socket immediately after connect()
1338 virtual void OnRawSocketConnect(int fd);
1340 /** Called immediately before any read() operation on a client socket in the core.
1341 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1342 * when this event occurs.
1343 * Your event should return 1 if it has handled the reading itself, which prevents the core
1344 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1345 * the value of count. The value of readresult must be identical to an actual result that might
1346 * be returned from the read() system call, for example, number of bytes read upon success,
1347 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1348 * you MUST set readresult.
1349 * @param fd The file descriptor of the socket
1350 * @param buffer A char* buffer being read to
1351 * @param count The size of the buffer
1352 * @param readresult The amount of characters read, or 0
1353 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1355 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1357 /** Called whenever a user sets away or returns from being away.
1358 * The away message is available as a parameter, but should not be modified.
1359 * At this stage, it has already been copied into the user record.
1360 * If awaymsg is empty, the user is returning from away.
1361 * @param user The user setting away
1362 * @param awaymsg The away message of the user, or empty if returning from away
1363 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
1365 virtual int OnSetAway(User* user, const std::string &awaymsg);
1367 /** Called whenever a NAMES list is requested.
1368 * You can produce the nameslist yourself, overriding the current list,
1369 * and if you do you must return 1. If you do not handle the names list,
1371 * @param The user requesting the NAMES list
1372 * @param Ptr The channel the NAMES list is requested for
1373 * @param userlist The user list for the channel (you may change this pointer.
1374 * If you want to change the values, take a copy first, and change the copy, then
1375 * point the pointer at your copy)
1376 * @return 1 to prevent the user list being sent to the client, 0 to allow it.
1377 * Returning -1 allows the names list, but bypasses any checks which check for
1378 * channel membership before sending the names list.
1380 virtual int OnUserList(User* user, Channel* Ptr, CUList* &userlist);
1382 /** Called whenever a line of WHOIS output is sent to a user.
1383 * You may change the numeric and the text of the output by changing
1384 * the values numeric and text, but you cannot change the user the
1385 * numeric is sent to. You may however change the user's User values.
1386 * @param user The user the numeric is being sent to
1387 * @param dest The user being WHOISed
1388 * @param numeric The numeric of the line being sent
1389 * @param text The text of the numeric, including any parameters
1390 * @return nonzero to drop the line completely so that the user does not
1391 * receive it, or zero to allow the line to be sent.
1393 virtual int OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
1395 /** Called at intervals for modules to garbage-collect any hashes etc.
1396 * Certain data types such as hash_map 'leak' buckets, which must be
1397 * tidied up and freed by copying into a new item every so often. This
1398 * method is called when it is time to do that.
1400 virtual void OnGarbageCollect();
1402 /** Called whenever a user's write buffer has been completely sent.
1403 * This is called when the user's write buffer is completely empty, and
1404 * there are no more pending bytes to be written and no pending write events
1405 * in the socket engine's queue. This may be used to refill the buffer with
1406 * data which is being spooled in a controlled manner, e.g. LIST lines.
1407 * @param user The user who's buffer is now empty.
1409 virtual void OnBufferFlushed(User* user);
1411 /** Add test suite hooks here. These are used for testing functionality of a module
1412 * via the --testsuite debugging parameter.
1414 virtual void OnRunTestSuite();
1416 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
1417 * For example NAMESX, channel mode +u and +I, and UHNAMES. If the nick is set to an empty string by any
1418 * module, then this will cause the nickname not to be displayed at all.
1420 virtual void OnNamesListItem(User* issuer, User* user, Channel* channel, std::string &prefixes, std::string &nick);
1422 virtual int OnNumeric(User* user, unsigned int numeric, const std::string &text);
1424 /** Called for every time the user's host or ident changes, to indicate wether or not the 'Changing host'
1425 * message should be sent, if enabled. Certain modules such as auditorium may opt to hide this message
1426 * even if it is enabled.
1428 virtual bool OnHostCycle(User* user);
1432 #define CONF_NO_ERROR 0x000000
1433 #define CONF_NOT_A_NUMBER 0x000010
1434 #define CONF_INT_NEGATIVE 0x000080
1435 #define CONF_VALUE_NOT_FOUND 0x000100
1436 #define CONF_FILE_NOT_FOUND 0x000200
1439 /** Allows reading of values from configuration files
1440 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1441 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1442 * Constructing the class using one parameter allows you to specify a path to your own configuration
1443 * file, otherwise, inspircd.conf is read.
1445 class CoreExport ConfigReader : public classbase
1448 InspIRCd* ServerInstance;
1454 /** Default constructor.
1455 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1456 * as specified when running ./configure.
1458 ConfigReader(InspIRCd* Instance);
1459 /** Default destructor.
1460 * This method destroys the ConfigReader class.
1464 /** Retrieves a value from the config file.
1465 * This method retrieves a value from the config file. Where multiple copies of the tag
1466 * exist in the config file, index indicates which of the values to retrieve.
1468 std::string ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds = false);
1469 /** Retrieves a value from the config file.
1470 * This method retrieves a 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. If the
1472 * tag is not found the default value is returned instead.
1474 std::string ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds = false);
1476 /** Retrieves a boolean value from the config file.
1477 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1478 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1479 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1481 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1482 /** Retrieves a boolean value from the config file.
1483 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1484 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1485 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1486 * If the tag is not found, the default value is used instead.
1488 bool ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index);
1490 /** Retrieves an integer value from the config file.
1491 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1492 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1493 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1494 * return CONF_INVALID_NUMBER to be returned. need_positive is set if the number must be non-negative.
1495 * If a negative number is placed into a tag which is specified positive, 0 will be returned and GetError()
1496 * will return CONF_INT_NEGATIVE. Note that need_positive is not suitable to get an unsigned int - you
1497 * should cast the result to achieve that effect.
1499 int ReadInteger(const std::string &tag, const std::string &name, int index, bool need_positive);
1500 /** Retrieves an integer value from the config file.
1501 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1502 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1503 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1504 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1505 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1506 * will return CONF_NOT_UNSIGNED. If the tag is not found, the default value is used instead.
1508 int ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool need_positive);
1510 /** Returns the last error to occur.
1511 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1512 * A call to GetError() resets the error flag back to 0.
1515 /** Counts the number of times a given tag appears in the config file.
1516 * This method counts the number of times a tag appears in a config file, for use where
1517 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1518 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1519 * multiple instance tag.
1521 int Enumerate(const std::string &tag);
1523 /** Returns the number of items within a tag.
1524 * For example if the tag was <test tag="blah" data="foo"> then this
1525 * function would return 2. Spaces and newlines both qualify as valid seperators
1528 int EnumerateValues(const std::string &tag, int index);
1533 /** Caches a text file into memory and can be used to retrieve lines from it.
1534 * This class contains methods for read-only manipulation of a text file in memory.
1535 * Either use the constructor type with one parameter to load a file into memory
1536 * at construction, or use the LoadFile method to load a file.
1538 class CoreExport FileReader : public classbase
1540 InspIRCd* ServerInstance;
1541 /** The file contents
1545 /** Content size in bytes
1547 unsigned long contentsize;
1549 /** Calculate content size in bytes
1554 /** Default constructor.
1555 * This method does not load any file into memory, you must use the LoadFile method
1556 * after constructing the class this way.
1558 FileReader(InspIRCd* Instance);
1560 /** Secondary constructor.
1561 * This method initialises the class with a file loaded into it ready for GetLine and
1562 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1565 FileReader(InspIRCd* Instance, const std::string &filename);
1567 /** Default destructor.
1568 * This deletes the memory allocated to the file.
1572 /** Used to load a file.
1573 * This method loads a file into the class ready for GetLine and
1574 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1577 void LoadFile(const std::string &filename);
1579 /** Returns the whole content of the file as std::string
1581 std::string Contents();
1583 /** Returns the entire size of the file as std::string
1585 unsigned long ContentSize();
1587 /** Returns true if the file exists
1588 * This function will return false if the file could not be opened.
1592 /** Retrieve one line from the file.
1593 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1594 * the index was out of bounds, or the line had no data on it.
1596 std::string GetLine(int x);
1598 /** Returns the size of the file in lines.
1599 * This method returns the number of lines in the read file. If it is 0, no lines have been
1600 * read into memory, either because the file is empty or it does not exist, or cannot be
1601 * opened due to permission problems.
1606 /** A DLLFactory (designed to load shared objects) containing a
1607 * handle to a module's init_module() function. Unfortunately,
1608 * due to the design of shared object systems we must keep this
1609 * hanging around, as if we remove this handle, we remove the
1610 * shared object file from memory (!)
1612 typedef DLLFactory<Module> ircd_module;
1614 /** A list of modules
1616 typedef std::vector<Module*> IntModuleList;
1618 /** An event handler iterator
1620 typedef IntModuleList::iterator EventHandlerIter;
1622 /** ModuleManager takes care of all things module-related
1625 class CoreExport ModuleManager : public classbase
1628 /** Holds a string describing the last module error to occur
1630 std::string LastModuleError;
1632 /** The feature names published by various modules
1634 featurelist Features;
1636 /** The interface names published by various modules
1638 interfacelist Interfaces;
1640 /** Total number of modules loaded into the ircd
1644 /** Our pointer to the main insp instance
1648 /** List of loaded modules and shared object/dll handles
1649 * keyed by module name
1651 std::map<std::string, std::pair<ircd_module*, Module*> > Modules;
1657 } prioritizationState;
1660 /** Event handler hooks.
1661 * This needs to be public to be used by FOREACH_MOD and friends.
1663 IntModuleList EventHandlers[I_END];
1665 /** Simple, bog-standard, boring constructor.
1667 ModuleManager(InspIRCd* Ins);
1673 /** Change the priority of one event in a module.
1674 * Each module event has a list of modules which are attached to that event type.
1675 * If you wish to be called before or after other specific modules, you may use this
1676 * method (usually within void Module::Prioritize()) to set your events priority.
1677 * You may use this call in other methods too, however, this is not supported behaviour
1679 * @param mod The module to change the priority of
1680 * @param i The event to change the priority of
1681 * @param s The state you wish to use for this event. Use one of
1682 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1683 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1684 * to set it to be before or after one or more other modules.
1685 * @param modules If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1686 * then this contains a list of one or more modules your module must be
1687 * placed before or after. Your module will be placed before the highest
1688 * priority module in this list for PRIO_BEFORE, or after the lowest
1689 * priority module in this list for PRIORITY_AFTER.
1690 * @param sz The number of modules being passed for PRIO_BEFORE and PRIORITY_AFTER.
1691 * Defaults to 1, as most of the time you will only want to prioritize your module
1692 * to be before or after one other module.
1694 bool SetPriority(Module* mod, Implementation i, Priority s, Module** modules = NULL, size_t sz = 1);
1696 /** Change the priority of all events in a module.
1697 * @param mod The module to set the priority of
1698 * @param s The priority of all events in the module.
1699 * Note that with this method, it is not possible to effectively use
1700 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1701 * SetPriority method for this, where you may specify other modules to
1702 * be prioritized against.
1704 bool SetPriority(Module* mod, Priority s);
1706 /** Attach an event to a module.
1707 * You may later detatch the event with ModuleManager::Detach().
1708 * If your module is unloaded, all events are automatically detatched.
1709 * @param i Event type to attach
1710 * @param mod Module to attach event to
1711 * @return True if the event was attached
1713 bool Attach(Implementation i, Module* mod);
1715 /** Detatch an event from a module.
1716 * This is not required when your module unloads, as the core will
1717 * automatically detatch your module from all events it is attached to.
1718 * @param i Event type to detach
1719 * @param mod Module to detach event from
1720 * @param Detach true if the event was detached
1722 bool Detach(Implementation i, Module* mod);
1724 /** Attach an array of events to a module
1725 * @param i Event types (array) to attach
1726 * @param mod Module to attach events to
1728 void Attach(Implementation* i, Module* mod, size_t sz);
1730 /** Detach all events from a module (used on unload)
1731 * @param mod Module to detach from
1733 void DetachAll(Module* mod);
1735 /** Returns text describing the last module error
1736 * @return The last error message to occur
1738 std::string& LastError();
1740 /** Load a given module file
1741 * @param filename The file to load
1742 * @return True if the module was found and loaded
1744 bool Load(const char* filename);
1746 /** Unload a given module file
1747 * @param filename The file to unload
1748 * @return True if the module was unloaded
1750 bool Unload(const char* filename);
1752 /** Called by the InspIRCd constructor to load all modules from the config file.
1756 /** Get the total number of currently loaded modules
1757 * @return The number of loaded modules
1761 return this->ModCount;
1764 /** Find a module by name, and return a Module* to it.
1765 * This is preferred over iterating the module lists yourself.
1766 * @param name The module name to look up
1767 * @return A pointer to the module, or NULL if the module cannot be found
1769 Module* Find(const std::string &name);
1771 /** Publish a 'feature'.
1772 * There are two ways for a module to find another module it depends on.
1773 * Either by name, using InspIRCd::FindModule, or by feature, using this
1774 * function. A feature is an arbitary string which identifies something this
1775 * module can do. For example, if your module provides SSL support, but other
1776 * modules provide SSL support too, all the modules supporting SSL should
1777 * publish an identical 'SSL' feature. This way, any module requiring use
1778 * of SSL functions can just look up the 'SSL' feature using FindFeature,
1779 * then use the module pointer they are given.
1780 * @param FeatureName The case sensitive feature name to make available
1781 * @param Mod a pointer to your module class
1782 * @returns True on success, false if the feature is already published by
1785 bool PublishFeature(const std::string &FeatureName, Module* Mod);
1787 /** Publish a module to an 'interface'.
1788 * Modules which implement the same interface (the same way of communicating
1789 * with other modules) can publish themselves to an interface, using this
1790 * method. When they do so, they become part of a list of related or
1791 * compatible modules, and a third module may then query for that list
1792 * and know that all modules within that list offer the same API.
1793 * A prime example of this is the hashing modules, which all accept the
1794 * same types of Request class. Consider this to be similar to PublishFeature,
1795 * except for that multiple modules may publish the same 'feature'.
1796 * @param InterfaceName The case sensitive interface name to make available
1797 * @param Mod a pointer to your module class
1798 * @returns True on success, false on failure (there are currently no failure
1801 bool PublishInterface(const std::string &InterfaceName, Module* Mod);
1803 /** Return a pair saying how many other modules are currently using the
1804 * interfaces provided by module m.
1805 * @param m The module to count usage for
1806 * @return A pair, where the first value is the number of uses of the interface,
1807 * and the second value is the interface name being used.
1809 std::pair<int,std::string> GetInterfaceInstanceCount(Module* m);
1811 /** Mark your module as using an interface.
1812 * If you mark your module as using an interface, then that interface
1813 * module may not unload until your module has unloaded first.
1814 * This can be used to prevent crashes by ensuring code you depend on
1815 * is always in memory while your module is active.
1816 * @param InterfaceName The interface to use
1818 void UseInterface(const std::string &InterfaceName);
1820 /** Mark your module as finished with an interface.
1821 * If you used UseInterface() above, you should use this method when
1822 * your module is finished with the interface (usually in its destructor)
1823 * to allow the modules which implement the given interface to be unloaded.
1824 * @param InterfaceName The interface you are finished with using.
1826 void DoneWithInterface(const std::string &InterfaceName);
1828 /** Unpublish a 'feature'.
1829 * When your module exits, it must call this method for every feature it
1830 * is providing so that the feature table is cleaned up.
1831 * @param FeatureName the feature to remove
1833 bool UnpublishFeature(const std::string &FeatureName);
1835 /** Unpublish your module from an interface
1836 * When your module exits, it must call this method for every interface
1837 * it is part of so that the interfaces table is cleaned up. Only when
1838 * the last item is deleted from an interface does the interface get
1840 * @param InterfaceName the interface to be removed from
1841 * @param Mod The module to remove from the interface list
1843 bool UnpublishInterface(const std::string &InterfaceName, Module* Mod);
1845 /** Find a 'feature'.
1846 * There are two ways for a module to find another module it depends on.
1847 * Either by name, using InspIRCd::FindModule, or by feature, using the
1848 * InspIRCd::PublishFeature method. A feature is an arbitary string which
1849 * identifies something this module can do. For example, if your module
1850 * provides SSL support, but other modules provide SSL support too, all
1851 * the modules supporting SSL should publish an identical 'SSL' feature.
1852 * To find a module capable of providing the feature you want, simply
1853 * call this method with the feature name you are looking for.
1854 * @param FeatureName The feature name you wish to obtain the module for
1855 * @returns A pointer to a valid module class on success, NULL on failure.
1857 Module* FindFeature(const std::string &FeatureName);
1859 /** Find an 'interface'.
1860 * An interface is a list of modules which all implement the same API.
1861 * @param InterfaceName The Interface you wish to obtain the module
1863 * @return A pointer to a deque of Module*, or NULL if the interface
1866 modulelist* FindInterface(const std::string &InterfaceName);
1868 /** Determine if a module has published the named interface.
1869 * This could be used in, for example, OnLoadModule to pick up other modules that can be used.
1870 * @param mod The module to check.
1871 * @param InterfaceName the interface you want to check for
1872 * @return True if the module provides the interface, false otherwise.
1874 bool ModuleHasInterface(Module* mod, const std::string& InterfaceName);
1876 /** Given a pointer to a Module, return its filename
1877 * @param m The module pointer to identify
1878 * @return The module name or an empty string
1880 const std::string& GetModuleName(Module* m);
1882 /** Return a list of all modules matching the given filter
1883 * @param filter This int is a bitmask of flags set in Module::Flags,
1884 * such as VF_VENDOR or VF_STATIC. If you wish to receive a list of
1885 * all modules with no filtering, set this to 0.
1886 * @return The list of module names
1888 const std::vector<std::string> GetAllModuleNames(int filter);
1891 /** This definition is used as shorthand for the various classes
1892 * and functions needed to make a module loadable by the OS.
1893 * It defines the class factory and external init_module function.
1897 #define MODULE_INIT(y) \
1898 extern "C" DllExport Module * init_module(InspIRCd* Me) \
1902 BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
1904 switch ( nReason ) \
1906 case DLL_PROCESS_ATTACH: \
1907 case DLL_PROCESS_DETACH: \
1915 #define MODULE_INIT(y) \
1916 extern "C" DllExport Module * init_module(InspIRCd* Me) \