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
45 AC_GENERAL_UMODE // a user mode is being changed
48 /** Used to define a set of behavior bits for a module
51 VF_STATIC = 1, // module is static, cannot be /unloadmodule'd
52 VF_VENDOR = 2, // module is a vendor module (came in the original tarball, not 3rd party)
53 VF_SERVICEPROVIDER = 4, // module provides a service to other modules (can be a dependency)
54 VF_COMMON = 8, // module needs to be common on all servers in a network to link
55 VF_OPTCOMMON = 16 // module should be common on all servers for unsurprising behavior
58 /** Used with SendToMode()
65 /** Used to represent an event type, for user, channel or server
67 enum TargetTypeFlags {
74 /** Used to represent wether a message was PRIVMSG or NOTICE
81 #define MOD_RES_ALLOW (ModResult(1))
82 #define MOD_RES_PASSTHRU (ModResult(0))
83 #define MOD_RES_DENY (ModResult(-1))
85 /** Used to represent an allow/deny module result.
86 * Not constructed as an enum because it reverses the value logic of some functions;
87 * the compiler will inline accesses to have the same efficiency as integer operations.
91 ModResult() : res(0) {}
92 explicit ModResult(int r) : res(r) {}
93 bool operator==(const ModResult& r) const
97 bool operator!=(const ModResult& r) const
101 bool operator!() const
105 bool check(bool def) const
107 return (res == 1 || (res == 0 && def));
110 * Merges two results, preferring ALLOW to DENY
112 ModResult operator+(const ModResult& r) const
114 if (res == r.res || r.res == 0)
118 // they are different, and neither is passthru
119 return MOD_RES_ALLOW;
123 /** If you change the module API, change this value. */
124 #define API_VERSION 13000
128 /* Forward-delacare module for ModuleMessage etc
133 /** Low level definition of a FileReader classes file cache area -
134 * a text file seperated into lines.
136 typedef std::deque<std::string> file_cache;
138 /** A set of strings.
140 typedef file_cache string_list;
142 /** Holds a list of 'published features' for modules.
144 typedef std::map<std::string,Module*> featurelist;
146 /** Holds a list of modules which implement an interface
148 typedef std::deque<Module*> modulelist;
150 /** Holds a list of all modules which implement interfaces, by interface name
152 typedef std::map<std::string, std::pair<int, modulelist> > interfacelist;
155 * This #define allows us to call a method in all
156 * loaded modules in a readable simple way, e.g.:
157 * 'FOREACH_MOD(I_OnConnect,OnConnect(user));'
159 #define FOREACH_MOD(y,x) do { \
160 EventHandlerIter safei; \
161 for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ) \
169 catch (CoreException& modexcept) \
171 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
178 * This #define allows us to call a method in all
179 * loaded modules in a readable simple way and pass
180 * an instance pointer to the macro. e.g.:
181 * 'FOREACH_MOD_I(Instance, OnConnect, OnConnect(user));'
183 #define FOREACH_MOD_I(z,y,x) do { \
184 EventHandlerIter safei; \
185 for (EventHandlerIter _i = z->Modules->EventHandlers[y].begin(); _i != z->Modules->EventHandlers[y].end(); ) \
193 catch (CoreException& modexcept) \
195 z->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
202 * Custom module result handling loop. This is a paired macro, and should only
203 * be used with while_each_hook.
205 * See src/channels.cpp for an example of use.
207 #define DO_EACH_HOOK(z,n,v,args) \
209 EventHandlerIter iter_ ## n = z->Modules->EventHandlers[I_ ## n].begin(); \
210 while (iter_ ## n != z->Modules->EventHandlers[I_ ## n].end()) \
212 Module* mod_ ## n = *iter_ ## n; \
216 v = (mod_ ## n)->n args;
218 #define WHILE_EACH_HOOK(z,n) \
220 catch (CoreException& except_ ## n) \
222 z->Logs->Log("MODULE",DEFAULT,"Exception caught: %s", (except_ ## n).GetReason()); \
223 (void) mod_ ## n; /* catch mismatched pairs */ \
229 * Module result iterator
230 * Runs the given hook until some module returns a useful result.
232 * Example: ModResult result;
233 * FIRST_MOD_RESULT(ServerInstance, OnUserPreNick, result, (user, newnick))
235 #define FIRST_MOD_RESULT(z,n,v,args) do { \
236 v = MOD_RES_PASSTHRU; \
237 DO_EACH_HOOK(z,n,v,args) \
239 if (v != MOD_RES_PASSTHRU) \
242 WHILE_EACH_HOOK(z,n); \
245 /** Represents a non-local user.
246 * (in fact, any FD less than -1 does)
248 #define FD_MAGIC_NUMBER -42
249 /** Represents a fake user (i.e. a server)
251 #define FD_FAKEUSER_NUMBER -7
255 /** Is a local user */
256 #define IS_LOCAL(x) (x->GetFd() > -1)
257 /** Is a remote user */
258 #define IS_REMOTE(x) (x->GetFd() < 0)
259 /** Is a fake user */
260 #define IS_FAKE(x) (x->GetFd() == FD_FAKEUSER_NUMBER)
261 /** Is a module created user */
262 #define IS_MODULE_CREATED(x) (x->GetFd() == FD_MAGIC_NUMBER)
264 #define IS_OPER(x) (!x->oper.empty())
266 #define IS_AWAY(x) (!x->awaymsg.empty())
268 /** Holds a module's Version information.
269 * The four members (set by the constructor only) indicate details as to the version number
270 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
271 * The flags and API values represent the module flags and API version of the module.
272 * The API version of a module must match the API version of the core exactly for the module to
275 class CoreExport Version : public classbase
278 /** Version information.
280 const std::string version;
282 /** Flags and API version
284 const int Flags, API;
286 /** Initialize version class
288 Version(const std::string &customver, int flags,
289 int api_ver = API_VERSION, const std::string& src_rev = VERSION " r" REVISION);
292 /** The ModuleMessage class is the base class of Request and Event
293 * This class is used to represent a basic data structure which is passed
294 * between modules for safe inter-module communications.
296 class CoreExport ModuleMessage : public Extensible
301 virtual ~ModuleMessage() {};
304 /** The Request class is a unicast message directed at a given module.
305 * When this class is properly instantiated it may be sent to a module
306 * using the Send() method, which will call the given module's OnRequest
307 * method with this class as its parameter.
309 class CoreExport Request : public ModuleMessage
312 /** This member holds a pointer to arbitary data set by the emitter of the message
315 /** This should be a null-terminated string identifying the type of request,
316 * all modules should define this and use it to determine the nature of the
317 * request before they attempt to cast the Request in any way.
320 /** This is a pointer to the sender of the message, which can be used to
321 * directly trigger events, or to create a reply.
324 /** The single destination of the Request
328 /** Create a new Request
329 * This is for the 'old' way of casting whatever the data is
330 * to char* and hoping you get the right thing at the other end.
331 * This is slowly being depreciated in favor of the 'new' way.
333 Request(char* anydata, Module* src, Module* dst);
334 /** Create a new Request
335 * This is for the 'new' way of defining a subclass
336 * of Request and defining it in a common header,
337 * passing an object of your Request subclass through
338 * as a Request* and using the ID string to determine
339 * what to cast it back to and the other end. This is
340 * much safer as there are no casts not confirmed by
341 * the ID string, and all casts are child->parent and
342 * can be checked at runtime with dynamic_cast<>()
344 Request(Module* src, Module* dst, const char* idstr);
345 /** Fetch the Request data
348 /** Fetch the ID string
351 /** Fetch the request source
354 /** Fetch the request destination (should be 'this' in the receiving module)
357 /** Send the Request.
358 * Upon returning the result will be arbitary data returned by the module you
359 * sent the request to. It is up to your module to know what this data is and
360 * how to deal with it.
366 /** The Event class is a unicast message directed at all modules.
367 * When the class is properly instantiated it may be sent to all modules
368 * using the Send() method, which will trigger the OnEvent method in
369 * all modules passing the object as its parameter.
371 class CoreExport Event : public ModuleMessage
374 /** This member holds a pointer to arbitary data set by the emitter of the message
377 /** This is a pointer to the sender of the message, which can be used to
378 * directly trigger events, or to create a reply.
381 /** The event identifier.
382 * This is arbitary text which should be used to distinguish
383 * one type of event from another.
387 /** Create a new Event
389 Event(char* anydata, Module* src, const std::string &eventid);
390 /** Get the Event data
393 /** Get the event Source
396 /** Get the event ID.
397 * Use this to determine the event type for safe casting of the data
399 std::string GetEventID();
401 * The return result of an Event::Send() will always be NULL as
402 * no replies are expected.
404 char* Send(InspIRCd* ServerInstance);
407 /** Priority types which can be returned from Module::Prioritize()
409 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
411 /** Implementation-specific flags which may be set in Module::Implements()
416 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash,
417 I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois,
418 I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick,
419 I_OnUserMessage, I_OnUserNotice, I_OnMode, I_OnGetServerDescription, I_OnSyncUser,
420 I_OnSyncChannel, I_OnDecodeMetaData, I_OnWallops,
421 I_OnChangeHost, I_OnChangeName, I_OnAddLine, I_OnDelLine, I_OnExpireLine, I_OnCleanup,
422 I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule,
423 I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite,
424 I_OnRawMode, I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckExtBan, I_OnCheckStringExtBan,
425 I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnPreTopicChange,
426 I_OnPostTopicChange, I_OnEvent, I_OnRequest, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan,
427 I_OnDelBan, I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead,
428 I_OnChangeLocalUserGECOS, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
429 I_OnPostOper, I_OnSyncNetwork, I_OnSetAway, I_OnUserList, I_OnPostCommand, I_OnPostJoin,
430 I_OnWhoisLine, I_OnBuildExemptList, I_OnRawSocketConnect, I_OnGarbageCollect, I_OnBufferFlushed,
431 I_OnText, I_OnPassCompare, I_OnRunTestSuite, I_OnNamesListItem, I_OnNumeric, I_OnHookIO,
432 I_OnHostCycle, I_OnPreRehash, I_OnModuleRehash, I_OnSendWhoLine, I_OnChangeIdent,
438 /** Base class for all InspIRCd modules
439 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
440 * its methods will be called when irc server events occur. class inherited from module must be
441 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
443 class CoreExport Module : public Extensible
446 /** Creator/owner pointer
448 InspIRCd* ServerInstance;
449 /** File that this module was loaded from
451 std::string ModuleSourceFile;
453 /** Default constructor.
454 * Creates a module class.
455 * @param Me An instance of the InspIRCd class which will be saved into ServerInstance for your use
456 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
458 Module(InspIRCd* Me);
460 /** Default destructor.
461 * destroys a module class
465 virtual void Prioritize()
469 /** Returns the version number of a Module.
470 * The method should return a Version object with its version information assigned via
473 virtual Version GetVersion();
475 /** Called when a user connects.
476 * The details of the connecting user are available to you in the parameter User *user
477 * @param user The user who is connecting
479 virtual void OnUserConnect(User* user);
481 /** Called when a user quits.
482 * The details of the exiting user are available to you in the parameter User *user
483 * This event is only called when the user is fully registered when they quit. To catch
484 * raw disconnections, use the OnUserDisconnect method.
485 * @param user The user who is quitting
486 * @param message The user's quit message (as seen by non-opers)
487 * @param oper_message The user's quit message (as seen by opers)
489 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
491 /** Called whenever a user's socket is closed.
492 * The details of the exiting user are available to you in the parameter User *user
493 * This event is called for all users, registered or not, as a cleanup method for modules
494 * which might assign resources to user, such as dns lookups, objects and sockets.
495 * @param user The user who is disconnecting
497 virtual void OnUserDisconnect(User* user);
499 /** Called whenever a channel is about to be deleted
500 * @param chan The channel being deleted
501 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
503 virtual ModResult OnChannelPreDelete(Channel *chan);
505 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
506 * @param chan The channel being deleted
508 virtual void OnChannelDelete(Channel* chan);
510 /** Called when a user joins a channel.
511 * The details of the joining user are available to you in the parameter User *user,
512 * and the details of the channel they have joined is available in the variable Channel *channel
513 * @param memb The channel membership being created
514 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
515 * to a channel due to the network sync.
516 * @param created This is true if the join created the channel
518 virtual void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list);
520 /** Called after a user joins a channel
521 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
523 * @param memb The channel membership created
525 virtual void OnPostJoin(Membership*);
527 /** Called when a user parts a channel.
528 * The details of the leaving user are available to you in the parameter User *user,
529 * and the details of the channel they have left is available in the variable Channel *channel
530 * @param memb The channel membership being destroyed
531 * @param partmessage The part message, or an empty string (may be modified)
533 virtual void OnUserPart(Membership* memb, std::string &partmessage, CUList& except_list);
535 /** Called on rehash.
536 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
537 * system. This is called in all cases -- including when this server will not execute the
538 * rehash because it is directed at a remote server.
540 * @param user The user performing the rehash, if any. If this is server initiated, the value of
541 * this variable will be NULL.
542 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
545 virtual void OnPreRehash(User* user, const std::string ¶meter);
547 /** Called on rehash.
548 * This method is called when a user initiates a module-specific rehash. This can be used to do
549 * expensive operations (such as reloading SSL certificates) that are not executed on a normal
550 * rehash for efficiency. A rehash of this type does not reload the core configuration.
552 * @param user The user performing the rehash.
553 * @param parameter The parameter given to REHASH
555 virtual void OnModuleRehash(User* user, const std::string ¶meter);
557 /** Called on rehash.
558 * This method is called after a rehash has completed. You should use it to reload any module
559 * configuration from the main configuration file.
560 * @param user The user that performed the rehash, if it was initiated by a user and that user
561 * is still connected.
563 virtual void OnRehash(User* user);
565 /** Called whenever a snotice is about to be sent to a snomask.
566 * snomask and type may both be modified; the message may not.
567 * @param snomask The snomask the message is going to (e.g. 'A')
568 * @param type The textual description the snomask will go to (e.g. 'OPER')
569 * @param message The text message to be sent via snotice
570 * @return 1 to block the snotice from being sent entirely, 0 else.
572 virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
574 /** Called whenever a user is about to join a channel, before any processing is done.
575 * Returning a value of 1 from this function stops the process immediately, causing no
576 * output to be sent to the user by the core. If you do this you must produce your own numerics,
577 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
578 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
582 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
583 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
584 * processing on the actual channel record at this point, however the channel NAME will still be passed in
585 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
586 * @param user The user joining the channel
587 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
588 * @param cname The channel name being joined. For new channels this is valid where chan is not.
589 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "@".
590 * You may alter this string to alter the user's modes on the channel.
591 * @param keygiven The key given to join the channel, or an empty string if none was provided
592 * @return 1 To prevent the join, 0 to allow it.
594 virtual ModResult OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string &privs, const std::string &keygiven);
596 /** Called whenever a user is about to be kicked.
597 * Returning a value of 1 from this function stops the process immediately, causing no
598 * output to be sent to the user by the core. If you do this you must produce your own numerics,
600 * @param source The user issuing the kick
601 * @param user The user being kicked
602 * @param chan The channel the user is being kicked from
603 * @param reason The kick reason
604 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
606 virtual ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason);
608 /** Called whenever a user is kicked.
609 * If this method is called, the kick is already underway and cannot be prevented, so
610 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
611 * @param source The user issuing the kick
612 * @param user The user being kicked
613 * @param chan The channel the user is being kicked from
614 * @param reason The kick reason
616 virtual void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except_list);
618 /** Called whenever a user opers locally.
619 * The User will contain the oper mode 'o' as this function is called after any modifications
620 * are made to the user's structure by the core.
621 * @param user The user who is opering up
622 * @param opertype The opers type name
624 virtual void OnOper(User* user, const std::string &opertype);
626 /** Called after a user opers locally.
627 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
628 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
629 * out the OPERTYPE, etc.
630 * @param user The user who is opering up
631 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
632 * @param opertype The opers type name
634 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
636 /** Called whenever a user types /INFO.
637 * The User will contain the information of the user who typed the command. Modules may use this
638 * method to output their own credits in /INFO (which is the ircd's version of an about box).
639 * It is purposefully not possible to modify any info that has already been output, or halt the list.
640 * You must write a 371 numeric to the user, containing your info in the following format:
642 * <nick> :information here
644 * @param user The user issuing /INFO
646 virtual void OnInfo(User* user);
648 /** Called whenever a /WHOIS is performed on a local user.
649 * The source parameter contains the details of the user who issued the WHOIS command, and
650 * the dest parameter contains the information of the user they are whoising.
651 * @param source The user issuing the WHOIS command
652 * @param dest The user who is being WHOISed
654 virtual void OnWhois(User* source, User* dest);
656 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
657 * Returning 1 from this function stops the process immediately, causing no
658 * output to be sent to the user by the core. If you do this you must produce your own numerics,
659 * notices etc. This is useful for modules which may want to filter invites to channels.
660 * @param source The user who is issuing the INVITE
661 * @param dest The user being invited
662 * @param channel The channel the user is being invited to
663 * @param timeout The time the invite will expire (0 == never)
664 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
666 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
668 /** Called after a user has been successfully invited to a channel.
669 * You cannot prevent the invite from occuring using this function, to do that,
670 * use OnUserPreInvite instead.
671 * @param source The user who is issuing the INVITE
672 * @param dest The user being invited
673 * @param channel The channel the user is being invited to
674 * @param timeout The time the invite will expire (0 == never)
676 virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout);
678 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
679 * Returning any nonzero value from this function stops the process immediately, causing no
680 * output to be sent to the user by the core. If you do this you must produce your own numerics,
681 * notices etc. This is useful for modules which may want to filter or redirect messages.
682 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
683 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
684 * of where the message is destined to be sent.
685 * @param user The user sending the message
686 * @param dest The target of the message (Channel* or User*)
687 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
688 * @param text Changeable text being sent by the user
689 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
690 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
691 * It will be ignored for private messages.
692 * @return 1 to deny the message, 0 to allow it
694 virtual ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
696 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
697 * Returning any nonzero value from this function stops the process immediately, causing no
698 * output to be sent to the user by the core. If you do this you must produce your own numerics,
699 * notices etc. This is useful for modules which may want to filter or redirect messages.
700 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
701 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
702 * of where the message is destined to be sent.
703 * You may alter the message text as you wish before relinquishing control to the next module
704 * in the chain, and if no other modules block the text this altered form of the text will be sent out
705 * to the user and possibly to other servers.
706 * @param user The user sending the message
707 * @param dest The target of the message (Channel* or User*)
708 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
709 * @param text Changeable text being sent by the user
710 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
711 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
712 * It will be ignored for private notices.
713 * @return 1 to deny the NOTICE, 0 to allow it
715 virtual ModResult OnUserPreNotice(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
717 /** Called whenever the server wants to build the exemption list for a channel, but is not directly doing a PRIVMSG or NOTICE.
718 * For example, the spanningtree protocol will call this event when passing a privmsg on (but not processing it directly).
719 * @param message_type The message type, either MSG_PRIVMSG or MSG_NOTICE
720 * @param chan The channel to build the exempt list of
721 * @param sender The original sender of the PRIVMSG or NOTICE
722 * @param status The status char to be used for the channel list
723 * @param exempt_list The exempt list to be populated
724 * @param text The original message text causing the exempt list to be built
726 virtual void OnBuildExemptList(MessageType message_type, Channel* chan, User* sender, char status, CUList &exempt_list, const std::string &text);
728 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
729 * Please note that although you can see remote nickchanges through this function, you should
730 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
731 * check user->server before taking any action (including returning nonzero from the method).
732 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
733 * module to generate some meaninful output.
734 * @param user The username changing their nick
735 * @param newnick Their new nickname
736 * @return 1 to deny the change, 0 to allow
738 virtual ModResult OnUserPreNick(User* user, const std::string &newnick);
740 /** Called after any PRIVMSG sent from a user.
741 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
742 * if target_type is TYPE_CHANNEL.
743 * @param user The user sending the message
744 * @param dest The target of the message
745 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
746 * @param text the text being sent by the user
747 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
749 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
751 /** Called after any NOTICE sent from a user.
752 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
753 * if target_type is TYPE_CHANNEL.
754 * @param user The user sending the message
755 * @param dest The target of the message
756 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
757 * @param text the text being sent by the user
758 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
760 virtual void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
762 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
763 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
764 * if target_type is TYPE_CHANNEL.
765 * The difference between this event and OnUserPreNotice/OnUserPreMessage is that delivery is gauranteed,
766 * the message has already been vetted. In the case of the other two methods, a later module may stop your
767 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
768 * @param user The user sending the message
769 * @param dest The target of the message
770 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
771 * @param text the text being sent by the user
772 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
774 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
776 /** Called after every MODE command sent from a user
777 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
778 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
779 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
780 * @param user The user sending the MODEs
781 * @param dest The target of the modes (User* or Channel*)
782 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
783 * @param text The actual modes and their parameters if any
784 * @param translate The translation types of the mode parameters
786 virtual void OnMode(User* user, void* dest, int target_type, const std::vector<std::string> &text, const std::vector<TranslateType> &translate);
788 /** Allows modules to alter or create server descriptions
789 * Whenever a module requires a server description, for example for display in
790 * WHOIS, this function is called in all modules. You may change or define the
791 * description given in std::string &description. If you do, this description
792 * will be shown in the WHOIS fields.
793 * @param servername The servername being searched for
794 * @param description Alterable server description for this server
796 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
798 /** Allows modules to synchronize data which relates to users during a netburst.
799 * When this function is called, it will be called from the module which implements
800 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
801 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
802 * (see below). This function will be called for every user visible on your side
803 * of the burst, allowing you to for example set modes, etc. Do not use this call to
804 * synchronize data which you have stored using class Extensible -- There is a specialist
805 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
806 * @param user The user being syncronized
807 * @param proto A pointer to the module handling network protocol
808 * @param opaque An opaque pointer set by the protocol module, should not be modified!
810 virtual void OnSyncUser(User* user, Module* proto, void* opaque);
812 /** Allows modules to synchronize data which relates to channels during a netburst.
813 * When this function is called, it will be called from the module which implements
814 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
815 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
816 * (see below). This function will be called for every user visible on your side
817 * of the burst, allowing you to for example set modes, etc.
819 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
821 * @param chan The channel being syncronized
822 * @param proto A pointer to the module handling network protocol
823 * @param opaque An opaque pointer set by the protocol module, should not be modified!
825 virtual void OnSyncChannel(Channel* chan, Module* proto, void* opaque);
827 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
828 * Whenever the linking module wants to send out data, but doesnt know what the data
829 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
830 * this method is called. You should use the ProtoSendMetaData function after you've
831 * correctly decided how the data should be represented, to send the metadata on its way if
832 * if it belongs to your module.
833 * @param proto A pointer to the module handling network protocol
834 * @param opaque An opaque pointer set by the protocol module, should not be modified!
835 * @param displayable If this value is true, the data is going to be displayed to a user,
836 * and not sent across the network. Use this to determine wether or not to show sensitive data.
838 virtual void OnSyncNetwork(Module* proto, void* opaque);
840 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
841 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
842 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
843 * @param target The Channel* or User* that data should be added to
844 * @param extname The extension name which is being sent
845 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
847 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
849 /** Implemented by modules which provide the ability to link servers.
850 * These modules will implement this method, which allows transparent sending of servermodes
851 * down the network link as a broadcast, without a module calling it having to know the format
852 * of the MODE command before the actual mode string.
854 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
855 * of how to use this function.
857 * @param opaque An opaque pointer set by the protocol module, should not be modified!
858 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
859 * @param target The Channel* or User* that modes should be sent for
860 * @param modeline The modes and parameters to be sent
861 * @param translate The translation types of the mode parameters
863 virtual void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::vector<std::string> &modeline, const std::vector<TranslateType> &translate);
865 /** Implemented by modules which provide the ability to link servers.
866 * These modules will implement this method, which allows metadata (extra data added to
867 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
868 * to other servers on a netburst and decoded at the other end by the same module on a
871 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
872 * how to use this function.
873 * @param opaque An opaque pointer set by the protocol module, should not be modified!
874 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
875 * @param target The Channel* or User* that metadata should be sent for
876 * @param extname The extension name to send metadata for
877 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
879 virtual void ProtoSendMetaData(void* opaque, Extensible* target, const std::string &extname, const std::string &extdata);
882 * Implemented by all modules that implement ProtoSendMetaData.
883 * Translates the item into a string format suitable for sending to other servers.
884 * Currently, this just translates nicks to their UID and channels to their name
886 virtual std::string ProtoTranslate(Extensible* item);
888 /** Called after every WALLOPS command.
889 * @param user The user sending the WALLOPS
890 * @param text The content of the WALLOPS message
892 virtual void OnWallops(User* user, const std::string &text);
894 /** Called whenever a user's hostname is changed.
895 * This event triggers after the host has been set.
896 * @param user The user whos host is being changed
897 * @param newhost The new hostname being set
899 virtual void OnChangeHost(User* user, const std::string &newhost);
901 /** Called whenever a user's GECOS (realname) is changed.
902 * This event triggers after the name has been set.
903 * @param user The user who's GECOS is being changed
904 * @param gecos The new GECOS being set on the user
906 virtual void OnChangeName(User* user, const std::string &gecos);
908 /** Called whenever a user's IDENT is changed.
909 * This event triggers after the name has been set.
910 * @param user The user who's IDENT is being changed
911 * @param gecos The new IDENT being set on the user
913 virtual void OnChangeIdent(User* user, const std::string &ident);
915 /** Called whenever an xline is added by a local user.
916 * This method is triggered after the line is added.
917 * @param source The sender of the line or NULL for local server
918 * @param line The xline being added
920 virtual void OnAddLine(User* source, XLine* line);
922 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
923 * This method is triggered after the line is deleted.
924 * @param source The user removing the line or NULL for local server
925 * @param line the line being deleted
927 virtual void OnDelLine(User* source, XLine* line);
929 /** Called whenever an xline expires.
930 * This method is triggered after the line is deleted.
931 * @param line The line being deleted.
933 virtual void OnExpireLine(XLine *line);
935 /** Called before your module is unloaded to clean up Extensibles.
936 * This method is called once for every user and channel on the network,
937 * so that when your module unloads it may clear up any remaining data
938 * in the form of Extensibles added using Extensible::Extend().
939 * If the target_type variable is TYPE_USER, then void* item refers to
940 * a User*, otherwise it refers to a Channel*.
941 * @param target_type The type of item being cleaned
942 * @param item A pointer to the item's class
944 virtual void OnCleanup(int target_type, void* item);
946 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
947 * have been applied. Please note that although you can see remote nickchanges through this function, you should
948 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
949 * check user->server before taking any action (including returning nonzero from the method).
950 * Because this method is called after the nickchange is taken place, no return values are possible
951 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
952 * @param user The user changing their nick
953 * @param oldnick The old nickname of the user before the nickchange
955 virtual void OnUserPostNick(User* user, const std::string &oldnick);
957 /** Called before an action which requires a channel privilage check.
958 * This function is called before many functions which check a users status on a channel, for example
959 * before opping a user, deopping a user, kicking a user, etc.
960 * There are several values for access_type which indicate for what reason access is being checked.
962 * AC_KICK - A user is being kicked<br>
963 * AC_DEOP - a user is being deopped<br>
964 * AC_OP - a user is being opped<br>
965 * AC_VOICE - a user is being voiced<br>
966 * AC_DEVOICE - a user is being devoiced<br>
967 * AC_HALFOP - a user is being halfopped<br>
968 * AC_DEHALFOP - a user is being dehalfopped<br>
969 * AC_INVITE - a user is being invited<br>
970 * AC_GENERAL_MODE - a user channel mode is being changed<br><br>
971 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
972 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
973 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
974 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
975 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
976 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
977 * @param source The source of the access check
978 * @param dest The destination of the access check
979 * @param channel The channel which is being checked
980 * @param access_type See above
982 virtual ModResult OnAccessCheck(User* source,User* dest,Channel* channel,int access_type);
984 /** Called when a 005 numeric is about to be output.
985 * The module should modify the 005 numeric if needed to indicate its features.
986 * @param output The 005 string to be modified if neccessary.
988 virtual void On005Numeric(std::string &output);
990 /** Called when a client is disconnected by KILL.
991 * If a client is killed by a server, e.g. a nickname collision or protocol error,
993 * Return 1 from this function to prevent the kill, and 0 from this function to allow
994 * it as normal. If you prevent the kill no output will be sent to the client, it is
995 * down to your module to generate this information.
996 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
997 * If you do so youre risking race conditions, desyncs and worse!
998 * @param source The user sending the KILL
999 * @param dest The user being killed
1000 * @param reason The kill reason
1001 * @return 1 to prevent the kill, 0 to allow
1003 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
1005 /** Called when an oper wants to disconnect a remote user via KILL
1006 * @param source The user sending the KILL
1007 * @param dest The user being killed
1008 * @param reason The kill reason
1010 virtual void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
1012 /** Called whenever a module is loaded.
1013 * mod will contain a pointer to the module, and string will contain its name,
1014 * for example m_widgets.so. This function is primary for dependency checking,
1015 * your module may decide to enable some extra features if it sees that you have
1016 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
1017 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
1018 * but instead operate under reduced functionality, unless the dependency is
1019 * absolutely neccessary (e.g. a module that extends the features of another
1021 * @param mod A pointer to the new module
1022 * @param name The new module's filename
1024 virtual void OnLoadModule(Module* mod,const std::string &name);
1026 /** Called whenever a module is unloaded.
1027 * mod will contain a pointer to the module, and string will contain its name,
1028 * for example m_widgets.so. This function is primary for dependency checking,
1029 * your module may decide to enable some extra features if it sees that you have
1030 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
1031 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
1032 * but instead operate under reduced functionality, unless the dependency is
1033 * absolutely neccessary (e.g. a module that extends the features of another
1035 * @param mod Pointer to the module being unloaded (still valid)
1036 * @param name The filename of the module being unloaded
1038 virtual void OnUnloadModule(Module* mod,const std::string &name);
1040 /** Called once every five seconds for background processing.
1041 * This timer can be used to control timed features. Its period is not accurate
1042 * enough to be used as a clock, but it is gauranteed to be called at least once in
1043 * any five second period, directly from the main loop of the server.
1044 * @param curtime The current timer derived from time(2)
1046 virtual void OnBackgroundTimer(time_t curtime);
1048 /** Called whenever any command is about to be executed.
1049 * This event occurs for all registered commands, wether they are registered in the core,
1050 * or another module, and for invalid commands. Invalid commands may only be sent to this
1051 * function when the value of validated is false. By returning 1 from this method you may prevent the
1052 * command being executed. If you do this, no output is created by the core, and it is
1053 * down to your module to produce any output neccessary.
1054 * Note that unless you return 1, you should not destroy any structures (e.g. by using
1055 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
1056 * method returns, it will be passed an invalid pointer to the user object and crash!)
1057 * @param command The command being executed
1058 * @param parameters An array of array of characters containing the parameters for the command
1059 * @param pcnt The nuimber of parameters passed to the command
1060 * @param user the user issuing the command
1061 * @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.
1062 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
1063 * @param original_line The entire original line as passed to the parser from the user
1064 * @return 1 to block the command, 0 to allow
1066 virtual ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, User *user, bool validated, const std::string &original_line);
1068 /** Called after any command has been executed.
1069 * This event occurs for all registered commands, wether they are registered in the core,
1070 * or another module, but it will not occur for invalid commands (e.g. ones which do not
1071 * exist within the command table). The result code returned by the command handler is
1073 * @param command The command being executed
1074 * @param parameters An array of array of characters containing the parameters for the command
1075 * @param pcnt The nuimber of parameters passed to the command
1076 * @param user the user issuing the command
1077 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
1078 * @param original_line The entire original line as passed to the parser from the user
1080 virtual void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, User *user, CmdResult result, const std::string &original_line);
1082 /** Called to check if a user who is connecting can now be allowed to register
1083 * If any modules return false for this function, the user is held in the waiting
1084 * state until all modules return true. For example a module which implements ident
1085 * lookups will continue to return false for a user until their ident lookup is completed.
1086 * Note that the registration timeout for a user overrides these checks, if the registration
1087 * timeout is reached, the user is disconnected even if modules report that the user is
1088 * not ready to connect.
1089 * @param user The user to check
1090 * @return true to indicate readiness, false if otherwise
1092 virtual ModResult OnCheckReady(User* user);
1094 /** Called whenever a user is about to register their connection (e.g. before the user
1095 * is sent the MOTD etc). Modules can use this method if they are performing a function
1096 * which must be done before the actual connection is completed (e.g. ident lookups,
1097 * dnsbl lookups, etc).
1098 * Note that you should NOT delete the user record here by causing a disconnection!
1099 * Use OnUserConnect for that instead.
1100 * @param user The user registering
1101 * @return 1 to indicate user quit, 0 to continue
1103 virtual ModResult OnUserRegister(User* user);
1105 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1106 * This method will always be called for each join, wether or not the channel is actually +i, and
1107 * determines the outcome of an if statement around the whole section of invite checking code.
1108 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1109 * @param user The user joining the channel
1110 * @param chan The channel being joined
1111 * @return 1 to explicitly allow the join, 0 to proceed as normal
1113 virtual ModResult OnCheckInvite(User* user, Channel* chan);
1115 /** Called whenever a mode character is processed.
1116 * Return 1 from this function to block the mode character from being processed entirely.
1117 * @param user The user who is sending the mode
1118 * @param chan The channel the mode is being sent to (or NULL if a usermode)
1119 * @param mode The mode character being set
1120 * @param param The parameter for the mode or an empty string
1121 * @param adding true of the mode is being added, false if it is being removed
1122 * @param pcnt The parameter count for the mode (0 or 1)
1123 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
1124 * to skip all permission checking. Please note that for remote mode changes, your return value
1127 virtual ModResult OnRawMode(User* user, Channel* chan, const char mode, const std::string ¶m, bool adding, int pcnt);
1129 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1130 * This method will always be called for each join, wether or not the channel is actually +k, and
1131 * determines the outcome of an if statement around the whole section of key checking code.
1132 * if the user specified no key, the keygiven string will be a valid but empty value.
1133 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1134 * @param user The user joining the channel
1135 * @param chan The channel being joined
1136 * @return 1 to explicitly allow the join, 0 to proceed as normal
1138 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
1140 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1141 * This method will always be called for each join, wether or not the channel is actually +l, and
1142 * determines the outcome of an if statement around the whole section of channel limit checking code.
1143 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1144 * @param user The user joining the channel
1145 * @param chan The channel being joined
1146 * @return 1 to explicitly allow the join, 0 to proceed as normal
1148 virtual ModResult OnCheckLimit(User* user, Channel* chan);
1150 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
1151 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
1152 * determines the outcome of an if statement around the whole section of ban checking code.
1153 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1154 * @param user The user joining the channel
1155 * @param chan The channel being joined
1156 * @return 1 to explicitly allow the join, 0 to proceed as normal. Return -1 to explicitly deny the
1157 * join to the channel.
1159 virtual ModResult OnCheckBan(User* user, Channel* chan);
1161 /* Called whenever checking whether or not a user is matched by an applicable extended bantype.
1162 * NOTE: may also trigger extra OnCheckStringExtBan events!
1163 * @param u The user to check
1164 * @param c The channel the user is on
1165 * @param type The type of extended ban to check for.
1166 * @returns 1 = exempt, 0 = no match, -1 = banned
1168 virtual ModResult OnCheckExtBan(User *u, Channel *c, char type);
1170 /** Called whenever checking whether or not a string is extbanned. NOTE: one OnCheckExtBan will also trigger a number of
1171 * OnCheckStringExtBan events for seperate host/IP comnbinations.
1172 * @returns 1 = exempt, 0 = no match, -1 = banned
1174 virtual ModResult OnCheckStringExtBan(const std::string &s, Channel *c, char type);
1176 /** Called on all /STATS commands
1177 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1178 * @param symbol the symbol provided to /STATS
1179 * @param user the user issuing the /STATS command
1180 * @param results A string_list to append results into. You should put all your results
1181 * into this string_list, rather than displaying them directly, so that your handler will
1182 * work when remote STATS queries are received.
1183 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1185 virtual ModResult OnStats(char symbol, User* user, string_list &results);
1187 /** Called whenever a change of a local users displayed host is attempted.
1188 * Return 1 to deny the host change, or 0 to allow it.
1189 * @param user The user whos host will be changed
1190 * @param newhost The new hostname
1191 * @return 1 to deny the host change, 0 to allow
1193 virtual ModResult OnChangeLocalUserHost(User* user, const std::string &newhost);
1195 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1196 * return 1 to deny the name change, or 0 to allow it.
1197 * @param user The user whos GECOS will be changed
1198 * @param newhost The new GECOS
1199 * @return 1 to deny the GECOS change, 0 to allow
1201 virtual ModResult OnChangeLocalUserGECOS(User* user, const std::string &newhost);
1203 /** Called before a topic is changed.
1204 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
1205 * As with other 'pre' events, you should only ever block a local event.
1206 * @param user The user changing the topic
1207 * @param chan The channels who's topic is being changed
1208 * @param topic The actual topic text
1209 * @param 1 to block the topic change, 0 to allow
1211 virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
1213 /** Called whenever a topic has been changed.
1214 * To block topic changes you must use OnPreTopicChange instead.
1215 * @param user The user changing the topic
1216 * @param chan The channels who's topic is being changed
1217 * @param topic The actual topic text
1219 virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
1221 /** Called whenever an Event class is sent to all module by another module.
1222 * Please see the documentation of Event::Send() for further information. The Event sent can
1223 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1224 * before doing anything to the event data, and you should *not* change the event data in any way!
1225 * @param event The Event class being received
1227 virtual void OnEvent(Event* event);
1229 /** Called whenever a Request class is sent to your module by another module.
1230 * Please see the documentation of Request::Send() for further information. The Request sent
1231 * can always be assumed to be non-NULL, you should not change the request object or its data.
1232 * Your method may return arbitary data in the char* result which the requesting module
1233 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1234 * @param request The Request class being received
1236 virtual const char* OnRequest(Request* request);
1238 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
1239 * The password field (from the config file) is in 'password' and is to be compared against
1240 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
1241 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
1242 * @param ex The object that's causing the authentication (User* for <oper> <connect:allow> etc, Server* for <link>).
1243 * @param password The password from the configuration file (the password="" value).
1244 * @param input The password entered by the user or whoever.
1245 * @param hashtype The hash value from the config
1246 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
1248 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
1250 /** Called whenever a user is given usermode +o, anywhere on the network.
1251 * You cannot override this and prevent it from happening as it is already happened and
1252 * such a task must be performed by another server. You can however bounce modes by sending
1253 * servermodes out to reverse mode changes.
1254 * @param user The user who is opering
1256 virtual void OnGlobalOper(User* user);
1258 /** Called after a user has fully connected and all modules have executed OnUserConnect
1259 * This event is informational only. You should not change any user information in this
1260 * event. To do so, use the OnUserConnect method to change the state of local users.
1261 * This is called for both local and remote users.
1262 * @param user The user who is connecting
1264 virtual void OnPostConnect(User* user);
1266 /** Called whenever a ban is added to a channel's list.
1267 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1268 * @param source The user adding the ban
1269 * @param channel The channel the ban is being added to
1270 * @param banmask The ban mask being added
1271 * @return 1 to block the ban, 0 to continue as normal
1273 virtual ModResult OnAddBan(User* source, Channel* channel,const std::string &banmask);
1275 /** Called whenever a ban is removed from a channel's list.
1276 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1277 * @param source The user deleting the ban
1278 * @param channel The channel the ban is being deleted from
1279 * @param banmask The ban mask being deleted
1280 * @return 1 to block the unban, 0 to continue as normal
1282 virtual ModResult OnDelBan(User* source, Channel* channel,const std::string &banmask);
1284 /** Called to install an I/O hook on an event handler
1285 * @param user The item to possibly install the I/O hook on
1286 * @param via The port that <user> connected on
1288 virtual void OnHookIO(EventHandler* user, ListenSocketBase* via);
1290 /** Called immediately after any connection is accepted. This is intended for raw socket
1291 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1292 * no information relating to a user record as the connection has not been assigned yet.
1293 * There are no return values from this call as all modules get an opportunity if required to
1294 * process the connection.
1295 * @param fd The file descriptor returned from accept()
1296 * @param client The client IP address and port
1297 * @param server The server IP address and port
1298 * @param localport The local port number the user connected to
1300 virtual void OnRawSocketAccept(int fd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
1302 /** Called immediately before any write() operation on a user's socket in the core. Because
1303 * this event is a low level event no user information is associated with it. It is intended
1304 * for use by modules which may wrap connections within another API such as SSL for example.
1305 * return a non-zero result if you have handled the write operation, in which case the core
1306 * will not call write().
1307 * @param fd The file descriptor of the socket
1308 * @param buffer A char* buffer being written
1309 * @param Number of characters to write
1310 * @return Number of characters actually written or 0 if you didn't handle the operation
1312 virtual int OnRawSocketWrite(int fd, const char* buffer, int count);
1314 /** Called immediately before any socket is closed. When this event is called, shutdown()
1315 * has not yet been called on the socket.
1316 * @param fd The file descriptor of the socket prior to close()
1318 virtual void OnRawSocketClose(int fd);
1320 /** Called immediately upon connection of an outbound BufferedSocket which has been hooked
1322 * @param fd The file descriptor of the socket immediately after connect()
1324 virtual void OnRawSocketConnect(int fd);
1326 /** Called immediately before any read() operation on a client socket in the core.
1327 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1328 * when this event occurs.
1329 * Your event should return 1 if it has handled the reading itself, which prevents the core
1330 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1331 * the value of count. The value of readresult must be identical to an actual result that might
1332 * be returned from the read() system call, for example, number of bytes read upon success,
1333 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1334 * you MUST set readresult.
1335 * @param fd The file descriptor of the socket
1336 * @param buffer A char* buffer being read to
1337 * @param count The size of the buffer
1338 * @param readresult The amount of characters read, or 0
1339 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1341 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1343 /** Called whenever a user sets away or returns from being away.
1344 * The away message is available as a parameter, but should not be modified.
1345 * At this stage, it has already been copied into the user record.
1346 * If awaymsg is empty, the user is returning from away.
1347 * @param user The user setting away
1348 * @param awaymsg The away message of the user, or empty if returning from away
1349 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
1351 virtual ModResult OnSetAway(User* user, const std::string &awaymsg);
1353 /** Called whenever a NAMES list is requested.
1354 * You can produce the nameslist yourself, overriding the current list,
1355 * and if you do you must return 1. If you do not handle the names list,
1357 * @param The user requesting the NAMES list
1358 * @param Ptr The channel the NAMES list is requested for
1360 virtual ModResult OnUserList(User* user, Channel* Ptr);
1362 /** Called whenever a line of WHOIS output is sent to a user.
1363 * You may change the numeric and the text of the output by changing
1364 * the values numeric and text, but you cannot change the user the
1365 * numeric is sent to. You may however change the user's User values.
1366 * @param user The user the numeric is being sent to
1367 * @param dest The user being WHOISed
1368 * @param numeric The numeric of the line being sent
1369 * @param text The text of the numeric, including any parameters
1370 * @return nonzero to drop the line completely so that the user does not
1371 * receive it, or zero to allow the line to be sent.
1373 virtual ModResult OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
1375 /** Called at intervals for modules to garbage-collect any hashes etc.
1376 * Certain data types such as hash_map 'leak' buckets, which must be
1377 * tidied up and freed by copying into a new item every so often. This
1378 * method is called when it is time to do that.
1380 virtual void OnGarbageCollect();
1382 /** Called whenever a user's write buffer has been completely sent.
1383 * This is called when the user's write buffer is completely empty, and
1384 * there are no more pending bytes to be written and no pending write events
1385 * in the socket engine's queue. This may be used to refill the buffer with
1386 * data which is being spooled in a controlled manner, e.g. LIST lines.
1387 * @param user The user who's buffer is now empty.
1389 virtual void OnBufferFlushed(User* user);
1391 /** Add test suite hooks here. These are used for testing functionality of a module
1392 * via the --testsuite debugging parameter.
1394 virtual void OnRunTestSuite();
1396 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
1397 * For example NAMESX, channel mode +u and +I, and UHNAMES. If the nick is set to an empty string by any
1398 * module, then this will cause the nickname not to be displayed at all.
1400 virtual void OnNamesListItem(User* issuer, Membership* item, std::string &prefixes, std::string &nick);
1402 virtual ModResult OnNumeric(User* user, unsigned int numeric, const std::string &text);
1404 /** Called for every time the user's host or ident changes, to indicate wether or not the 'Changing host'
1405 * message should be sent, if enabled. Certain modules such as auditorium may opt to hide this message
1406 * even if it is enabled.
1408 virtual ModResult OnHostCycle(User* user);
1410 /** Called whenever a result from /WHO is about to be returned
1411 * @param source The user running the /WHO query
1412 * @param user The user that this line of the query is about
1413 * @param channel The channel being queried (or NULL if not a channel query)
1414 * @param line The raw line to send; modifiable, if empty no line will be returned.
1416 virtual void OnSendWhoLine(User* source, User* user, Channel* channel, std::string& line);
1420 #define CONF_NO_ERROR 0x000000
1421 #define CONF_NOT_A_NUMBER 0x000010
1422 #define CONF_INT_NEGATIVE 0x000080
1423 #define CONF_VALUE_NOT_FOUND 0x000100
1424 #define CONF_FILE_NOT_FOUND 0x000200
1427 /** Allows reading of values from configuration files
1428 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1429 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1430 * Constructing the class using one parameter allows you to specify a path to your own configuration
1431 * file, otherwise, inspircd.conf is read.
1433 class CoreExport ConfigReader : public classbase
1436 InspIRCd* ServerInstance;
1442 /** Default constructor.
1443 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1444 * as specified when running ./configure.
1446 ConfigReader(InspIRCd* Instance);
1447 /** Default destructor.
1448 * This method destroys the ConfigReader class.
1452 /** Retrieves a value from the config file.
1453 * This method retrieves a value from the config file. Where multiple copies of the tag
1454 * exist in the config file, index indicates which of the values to retrieve.
1456 std::string ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds = false);
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. If the
1460 * tag is not found the default value is returned instead.
1462 std::string ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds = false);
1464 /** Retrieves a boolean value from the config file.
1465 * This method retrieves a boolean 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. The values "1", "yes"
1467 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1469 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1470 /** Retrieves a boolean value from the config file.
1471 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1472 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1473 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1474 * If the tag is not found, the default value is used instead.
1476 bool ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index);
1478 /** Retrieves an integer value from the config file.
1479 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1480 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1481 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1482 * return CONF_INVALID_NUMBER to be returned. need_positive is set if the number must be non-negative.
1483 * If a negative number is placed into a tag which is specified positive, 0 will be returned and GetError()
1484 * will return CONF_INT_NEGATIVE. Note that need_positive is not suitable to get an unsigned int - you
1485 * should cast the result to achieve that effect.
1487 int ReadInteger(const std::string &tag, const std::string &name, int index, bool need_positive);
1488 /** Retrieves an integer value from the config file.
1489 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1490 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1491 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1492 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1493 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1494 * will return CONF_NOT_UNSIGNED. If the tag is not found, the default value is used instead.
1496 int ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool need_positive);
1498 /** Returns the last error to occur.
1499 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1500 * A call to GetError() resets the error flag back to 0.
1503 /** Counts the number of times a given tag appears in the config file.
1504 * This method counts the number of times a tag appears in a config file, for use where
1505 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1506 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1507 * multiple instance tag.
1509 int Enumerate(const std::string &tag);
1511 /** Returns the number of items within a tag.
1512 * For example if the tag was <test tag="blah" data="foo"> then this
1513 * function would return 2. Spaces and newlines both qualify as valid seperators
1516 int EnumerateValues(const std::string &tag, int index);
1521 /** Caches a text file into memory and can be used to retrieve lines from it.
1522 * This class contains methods for read-only manipulation of a text file in memory.
1523 * Either use the constructor type with one parameter to load a file into memory
1524 * at construction, or use the LoadFile method to load a file.
1526 class CoreExport FileReader : public classbase
1528 InspIRCd* ServerInstance;
1529 /** The file contents
1533 /** Content size in bytes
1535 unsigned long contentsize;
1537 /** Calculate content size in bytes
1542 /** Default constructor.
1543 * This method does not load any file into memory, you must use the LoadFile method
1544 * after constructing the class this way.
1546 FileReader(InspIRCd* Instance);
1548 /** Secondary constructor.
1549 * This method initialises the class with a file loaded into it ready for GetLine and
1550 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1553 FileReader(InspIRCd* Instance, const std::string &filename);
1555 /** Default destructor.
1556 * This deletes the memory allocated to the file.
1560 /** Used to load a file.
1561 * This method loads a file into the class ready for GetLine and
1562 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1565 void LoadFile(const std::string &filename);
1567 /** Returns the whole content of the file as std::string
1569 std::string Contents();
1571 /** Returns the entire size of the file as std::string
1573 unsigned long ContentSize();
1575 /** Returns true if the file exists
1576 * This function will return false if the file could not be opened.
1580 /** Retrieve one line from the file.
1581 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1582 * the index was out of bounds, or the line had no data on it.
1584 std::string GetLine(int x);
1586 /** Returns the size of the file in lines.
1587 * This method returns the number of lines in the read file. If it is 0, no lines have been
1588 * read into memory, either because the file is empty or it does not exist, or cannot be
1589 * opened due to permission problems.
1594 /** A DLLFactory (designed to load shared objects) containing a
1595 * handle to a module's init_module() function. Unfortunately,
1596 * due to the design of shared object systems we must keep this
1597 * hanging around, as if we remove this handle, we remove the
1598 * shared object file from memory (!)
1600 typedef DLLFactory<Module> ircd_module;
1602 /** A list of modules
1604 typedef std::vector<Module*> IntModuleList;
1606 /** An event handler iterator
1608 typedef IntModuleList::iterator EventHandlerIter;
1610 /** ModuleManager takes care of all things module-related
1613 class CoreExport ModuleManager : public classbase
1616 /** Holds a string describing the last module error to occur
1618 std::string LastModuleError;
1620 /** The feature names published by various modules
1622 featurelist Features;
1624 /** The interface names published by various modules
1626 interfacelist Interfaces;
1628 /** Total number of modules loaded into the ircd
1632 /** Our pointer to the main insp instance
1636 /** List of loaded modules and shared object/dll handles
1637 * keyed by module name
1639 std::map<std::string, std::pair<ircd_module*, Module*> > Modules;
1645 } prioritizationState;
1648 /** Event handler hooks.
1649 * This needs to be public to be used by FOREACH_MOD and friends.
1651 IntModuleList EventHandlers[I_END];
1653 /** Simple, bog-standard, boring constructor.
1655 ModuleManager(InspIRCd* Ins);
1661 /** Change the priority of one event in a module.
1662 * Each module event has a list of modules which are attached to that event type.
1663 * If you wish to be called before or after other specific modules, you may use this
1664 * method (usually within void Module::Prioritize()) to set your events priority.
1665 * You may use this call in other methods too, however, this is not supported behaviour
1667 * @param mod The module to change the priority of
1668 * @param i The event to change the priority of
1669 * @param s The state you wish to use for this event. Use one of
1670 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1671 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1672 * to set it to be before or after one or more other modules.
1673 * @param modules If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1674 * then this contains a list of one or more modules your module must be
1675 * placed before or after. Your module will be placed before the highest
1676 * priority module in this list for PRIO_BEFORE, or after the lowest
1677 * priority module in this list for PRIORITY_AFTER.
1678 * @param sz The number of modules being passed for PRIO_BEFORE and PRIORITY_AFTER.
1679 * Defaults to 1, as most of the time you will only want to prioritize your module
1680 * to be before or after one other module.
1682 bool SetPriority(Module* mod, Implementation i, Priority s, Module** modules = NULL, size_t sz = 1);
1684 /** Change the priority of all events in a module.
1685 * @param mod The module to set the priority of
1686 * @param s The priority of all events in the module.
1687 * Note that with this method, it is not possible to effectively use
1688 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1689 * SetPriority method for this, where you may specify other modules to
1690 * be prioritized against.
1692 bool SetPriority(Module* mod, Priority s);
1694 /** Attach an event to a module.
1695 * You may later detatch the event with ModuleManager::Detach().
1696 * If your module is unloaded, all events are automatically detatched.
1697 * @param i Event type to attach
1698 * @param mod Module to attach event to
1699 * @return True if the event was attached
1701 bool Attach(Implementation i, Module* mod);
1703 /** Detatch an event from a module.
1704 * This is not required when your module unloads, as the core will
1705 * automatically detatch your module from all events it is attached to.
1706 * @param i Event type to detach
1707 * @param mod Module to detach event from
1708 * @param Detach true if the event was detached
1710 bool Detach(Implementation i, Module* mod);
1712 /** Attach an array of events to a module
1713 * @param i Event types (array) to attach
1714 * @param mod Module to attach events to
1716 void Attach(Implementation* i, Module* mod, size_t sz);
1718 /** Detach all events from a module (used on unload)
1719 * @param mod Module to detach from
1721 void DetachAll(Module* mod);
1723 /** Returns text describing the last module error
1724 * @return The last error message to occur
1726 std::string& LastError();
1728 /** Load a given module file
1729 * @param filename The file to load
1730 * @return True if the module was found and loaded
1732 bool Load(const char* filename);
1734 /** Unload a given module file
1735 * @param filename The file to unload
1736 * @return True if the module was unloaded
1738 bool Unload(const char* filename);
1740 /** Called by the InspIRCd constructor to load all modules from the config file.
1744 /** Get the total number of currently loaded modules
1745 * @return The number of loaded modules
1749 return this->ModCount;
1752 /** Find a module by name, and return a Module* to it.
1753 * This is preferred over iterating the module lists yourself.
1754 * @param name The module name to look up
1755 * @return A pointer to the module, or NULL if the module cannot be found
1757 Module* Find(const std::string &name);
1759 /** Publish a 'feature'.
1760 * There are two ways for a module to find another module it depends on.
1761 * Either by name, using InspIRCd::FindModule, or by feature, using this
1762 * function. A feature is an arbitary string which identifies something this
1763 * module can do. For example, if your module provides SSL support, but other
1764 * modules provide SSL support too, all the modules supporting SSL should
1765 * publish an identical 'SSL' feature. This way, any module requiring use
1766 * of SSL functions can just look up the 'SSL' feature using FindFeature,
1767 * then use the module pointer they are given.
1768 * @param FeatureName The case sensitive feature name to make available
1769 * @param Mod a pointer to your module class
1770 * @returns True on success, false if the feature is already published by
1773 bool PublishFeature(const std::string &FeatureName, Module* Mod);
1775 /** Publish a module to an 'interface'.
1776 * Modules which implement the same interface (the same way of communicating
1777 * with other modules) can publish themselves to an interface, using this
1778 * method. When they do so, they become part of a list of related or
1779 * compatible modules, and a third module may then query for that list
1780 * and know that all modules within that list offer the same API.
1781 * A prime example of this is the hashing modules, which all accept the
1782 * same types of Request class. Consider this to be similar to PublishFeature,
1783 * except for that multiple modules may publish the same 'feature'.
1784 * @param InterfaceName The case sensitive interface name to make available
1785 * @param Mod a pointer to your module class
1786 * @returns True on success, false on failure (there are currently no failure
1789 bool PublishInterface(const std::string &InterfaceName, Module* Mod);
1791 /** Return a pair saying how many other modules are currently using the
1792 * interfaces provided by module m.
1793 * @param m The module to count usage for
1794 * @return A pair, where the first value is the number of uses of the interface,
1795 * and the second value is the interface name being used.
1797 std::pair<int,std::string> GetInterfaceInstanceCount(Module* m);
1799 /** Mark your module as using an interface.
1800 * If you mark your module as using an interface, then that interface
1801 * module may not unload until your module has unloaded first.
1802 * This can be used to prevent crashes by ensuring code you depend on
1803 * is always in memory while your module is active.
1804 * @param InterfaceName The interface to use
1806 void UseInterface(const std::string &InterfaceName);
1808 /** Mark your module as finished with an interface.
1809 * If you used UseInterface() above, you should use this method when
1810 * your module is finished with the interface (usually in its destructor)
1811 * to allow the modules which implement the given interface to be unloaded.
1812 * @param InterfaceName The interface you are finished with using.
1814 void DoneWithInterface(const std::string &InterfaceName);
1816 /** Unpublish a 'feature'.
1817 * When your module exits, it must call this method for every feature it
1818 * is providing so that the feature table is cleaned up.
1819 * @param FeatureName the feature to remove
1821 bool UnpublishFeature(const std::string &FeatureName);
1823 /** Unpublish your module from an interface
1824 * When your module exits, it must call this method for every interface
1825 * it is part of so that the interfaces table is cleaned up. Only when
1826 * the last item is deleted from an interface does the interface get
1828 * @param InterfaceName the interface to be removed from
1829 * @param Mod The module to remove from the interface list
1831 bool UnpublishInterface(const std::string &InterfaceName, Module* Mod);
1833 /** Find a 'feature'.
1834 * There are two ways for a module to find another module it depends on.
1835 * Either by name, using InspIRCd::FindModule, or by feature, using the
1836 * InspIRCd::PublishFeature method. A feature is an arbitary string which
1837 * identifies something this module can do. For example, if your module
1838 * provides SSL support, but other modules provide SSL support too, all
1839 * the modules supporting SSL should publish an identical 'SSL' feature.
1840 * To find a module capable of providing the feature you want, simply
1841 * call this method with the feature name you are looking for.
1842 * @param FeatureName The feature name you wish to obtain the module for
1843 * @returns A pointer to a valid module class on success, NULL on failure.
1845 Module* FindFeature(const std::string &FeatureName);
1847 /** Find an 'interface'.
1848 * An interface is a list of modules which all implement the same API.
1849 * @param InterfaceName The Interface you wish to obtain the module
1851 * @return A pointer to a deque of Module*, or NULL if the interface
1854 modulelist* FindInterface(const std::string &InterfaceName);
1856 /** Determine if a module has published the named interface.
1857 * This could be used in, for example, OnLoadModule to pick up other modules that can be used.
1858 * @param mod The module to check.
1859 * @param InterfaceName the interface you want to check for
1860 * @return True if the module provides the interface, false otherwise.
1862 bool ModuleHasInterface(Module* mod, const std::string& InterfaceName);
1864 /** Given a pointer to a Module, return its filename
1865 * @param m The module pointer to identify
1866 * @return The module name or an empty string
1868 const std::string& GetModuleName(Module* m);
1870 /** Return a list of all modules matching the given filter
1871 * @param filter This int is a bitmask of flags set in Module::Flags,
1872 * such as VF_VENDOR or VF_STATIC. If you wish to receive a list of
1873 * all modules with no filtering, set this to 0.
1874 * @return The list of module names
1876 const std::vector<std::string> GetAllModuleNames(int filter);
1879 /** This definition is used as shorthand for the various classes
1880 * and functions needed to make a module loadable by the OS.
1881 * It defines the class factory and external init_module function.
1885 #define MODULE_INIT(y) \
1886 extern "C" DllExport Module * init_module(InspIRCd* Me) \
1890 BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
1892 switch ( nReason ) \
1894 case DLL_PROCESS_ATTACH: \
1895 case DLL_PROCESS_DETACH: \
1903 #define MODULE_INIT(y) \
1904 extern "C" DllExport Module * init_module(InspIRCd* Me) \
1910 #define COMMAND_INIT(c) MODULE_INIT(CommandModule<c>)