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
54 VF_OPTCOMMON = 16 // module should be common on all servers for unsurprising behavior
57 /** Used with SendToMode()
64 /** Used to represent an event type, for user, channel or server
66 enum TargetTypeFlags {
73 /** Used to represent wether a message was PRIVMSG or NOTICE
80 /** Used to represent an allow/deny module result.
81 * Not constructed as an enum because it reverses the value logic of some functions;
82 * the compiler will inline accesses to have the same efficiency as integer operations.
86 explicit ModResult(int r) : res(r) {}
87 bool operator==(const ModResult& r) const
91 bool operator!=(const ModResult& r) const
95 bool operator!() const
101 #define MOD_RES_ALLOW (ModResult(1))
102 #define MOD_RES_PASSTHRU (ModResult(0))
103 #define MOD_RES_DENY (ModResult(-1))
105 /** If you change the module API, change this value. */
106 #define API_VERSION 13000
110 /* Forward-delacare module for ModuleMessage etc
115 /** Low level definition of a FileReader classes file cache area -
116 * a text file seperated into lines.
118 typedef std::deque<std::string> file_cache;
120 /** A set of strings.
122 typedef file_cache string_list;
124 /** Holds a list of 'published features' for modules.
126 typedef std::map<std::string,Module*> featurelist;
128 /** Holds a list of modules which implement an interface
130 typedef std::deque<Module*> modulelist;
132 /** Holds a list of all modules which implement interfaces, by interface name
134 typedef std::map<std::string, std::pair<int, modulelist> > interfacelist;
137 * This #define allows us to call a method in all
138 * loaded modules in a readable simple way, e.g.:
139 * 'FOREACH_MOD(I_OnConnect,OnConnect(user));'
141 #define FOREACH_MOD(y,x) do { \
142 EventHandlerIter safei; \
143 for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ) \
151 catch (CoreException& modexcept) \
153 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
160 * This #define allows us to call a method in all
161 * loaded modules in a readable simple way and pass
162 * an instance pointer to the macro. e.g.:
163 * 'FOREACH_MOD_I(Instance, OnConnect, OnConnect(user));'
165 #define FOREACH_MOD_I(z,y,x) do { \
166 EventHandlerIter safei; \
167 for (EventHandlerIter _i = z->Modules->EventHandlers[y].begin(); _i != z->Modules->EventHandlers[y].end(); ) \
175 catch (CoreException& modexcept) \
177 z->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
184 * This define is similar to the one above but returns a result in MOD_RESULT.
185 * The first module to return a nonzero result is the value to be accepted,
186 * and any modules after are ignored.
188 #define FOREACH_RESULT(y,x) \
190 EventHandlerIter safei; \
192 for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ) \
198 int res = (*_i)->x ; \
204 catch (CoreException& modexcept) \
206 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
214 * This define is similar to the one above but returns a result in MOD_RESULT.
215 * The first module to return a nonzero result is the value to be accepted,
216 * and any modules after are ignored.
218 #define FOREACH_RESULT_I(z,y,x) \
220 EventHandlerIter safei; \
222 for (EventHandlerIter _i = z->Modules->EventHandlers[y].begin(); _i != z->Modules->EventHandlers[y].end(); ) \
228 int res = (*_i)->x ; \
234 catch (CoreException& modexcept) \
236 z->Logs->Log("MODULE",DEBUG,"Exception caught: %s",modexcept.GetReason()); \
243 * Custom module result handling loop. This is a paired macro, and should only
244 * be used with while_each_hook.
246 * See src/channels.cpp for an example of use.
248 #define DO_EACH_HOOK(z,n,v,args) \
250 EventHandlerIter iter_ ## n = z->Modules->EventHandlers[I_ ## n].begin(); \
251 while (iter_ ## n != z->Modules->EventHandlers[I_ ## n].end()) \
253 Module* mod_ ## n = *iter_ ## n; \
257 v = (mod_ ## n)->n args;
259 #define WHILE_EACH_HOOK(z,n) \
261 catch (CoreException& except_ ## n) \
263 z->Logs->Log("MODULE",DEFAULT,"Exception caught: %s", (except_ ## n).GetReason()); \
264 (void) mod_ ## n; /* catch mismatched pairs */ \
269 #define FIRST_MOD_RESULT(z,n,v,args) do { \
270 v = MOD_RES_PASSTHRU; \
271 DO_EACH_HOOK(z,n,v,args) \
273 if (v != MOD_RES_PASSTHRU) \
276 WHILE_EACH_HOOK(z,n); \
279 /** Represents a non-local user.
280 * (in fact, any FD less than -1 does)
282 #define FD_MAGIC_NUMBER -42
283 /** Represents a fake user (i.e. a server)
285 #define FD_FAKEUSER_NUMBER -7
289 /** Is a local user */
290 #define IS_LOCAL(x) (x->GetFd() > -1)
291 /** Is a remote user */
292 #define IS_REMOTE(x) (x->GetFd() < 0)
293 /** Is a fake user */
294 #define IS_FAKE(x) (x->GetFd() == FD_FAKEUSER_NUMBER)
295 /** Is a module created user */
296 #define IS_MODULE_CREATED(x) (x->GetFd() == FD_MAGIC_NUMBER)
298 #define IS_OPER(x) (!x->oper.empty())
300 #define IS_AWAY(x) (!x->awaymsg.empty())
302 /** Holds a module's Version information.
303 * The four members (set by the constructor only) indicate details as to the version number
304 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
305 * The flags and API values represent the module flags and API version of the module.
306 * The API version of a module must match the API version of the core exactly for the module to
309 class CoreExport Version : public classbase
312 /** Version information.
316 /** Flags and API version
318 const int Flags, API;
320 /** Initialize version class
322 Version(const std::string &sversion, int flags, int api_ver);
325 /** The ModuleMessage class is the base class of Request and Event
326 * This class is used to represent a basic data structure which is passed
327 * between modules for safe inter-module communications.
329 class CoreExport ModuleMessage : public Extensible
334 virtual ~ModuleMessage() {};
337 /** The Request class is a unicast message directed at a given module.
338 * When this class is properly instantiated it may be sent to a module
339 * using the Send() method, which will call the given module's OnRequest
340 * method with this class as its parameter.
342 class CoreExport Request : public ModuleMessage
345 /** This member holds a pointer to arbitary data set by the emitter of the message
348 /** This should be a null-terminated string identifying the type of request,
349 * all modules should define this and use it to determine the nature of the
350 * request before they attempt to cast the Request in any way.
353 /** This is a pointer to the sender of the message, which can be used to
354 * directly trigger events, or to create a reply.
357 /** The single destination of the Request
361 /** Create a new Request
362 * This is for the 'old' way of casting whatever the data is
363 * to char* and hoping you get the right thing at the other end.
364 * This is slowly being depreciated in favor of the 'new' way.
366 Request(char* anydata, Module* src, Module* dst);
367 /** Create a new Request
368 * This is for the 'new' way of defining a subclass
369 * of Request and defining it in a common header,
370 * passing an object of your Request subclass through
371 * as a Request* and using the ID string to determine
372 * what to cast it back to and the other end. This is
373 * much safer as there are no casts not confirmed by
374 * the ID string, and all casts are child->parent and
375 * can be checked at runtime with dynamic_cast<>()
377 Request(Module* src, Module* dst, const char* idstr);
378 /** Fetch the Request data
381 /** Fetch the ID string
384 /** Fetch the request source
387 /** Fetch the request destination (should be 'this' in the receiving module)
390 /** Send the Request.
391 * Upon returning the result will be arbitary data returned by the module you
392 * sent the request to. It is up to your module to know what this data is and
393 * how to deal with it.
399 /** The Event class is a unicast message directed at all modules.
400 * When the class is properly instantiated it may be sent to all modules
401 * using the Send() method, which will trigger the OnEvent method in
402 * all modules passing the object as its parameter.
404 class CoreExport Event : public ModuleMessage
407 /** This member holds a pointer to arbitary data set by the emitter of the message
410 /** This is a pointer to the sender of the message, which can be used to
411 * directly trigger events, or to create a reply.
414 /** The event identifier.
415 * This is arbitary text which should be used to distinguish
416 * one type of event from another.
420 /** Create a new Event
422 Event(char* anydata, Module* src, const std::string &eventid);
423 /** Get the Event data
426 /** Get the event Source
429 /** Get the event ID.
430 * Use this to determine the event type for safe casting of the data
432 std::string GetEventID();
434 * The return result of an Event::Send() will always be NULL as
435 * no replies are expected.
437 char* Send(InspIRCd* ServerInstance);
440 /** Priority types which can be returned from Module::Prioritize()
442 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
444 /** Implementation-specific flags which may be set in Module::Implements()
449 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash,
450 I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois,
451 I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick,
452 I_OnUserMessage, I_OnUserNotice, I_OnMode, I_OnGetServerDescription, I_OnSyncUser,
453 I_OnSyncChannel, I_OnDecodeMetaData, I_OnWallops,
454 I_OnChangeHost, I_OnChangeName, I_OnAddLine, I_OnDelLine, I_OnExpireLine, I_OnCleanup,
455 I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule,
456 I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite,
457 I_OnRawMode, I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckExtBan, I_OnCheckStringExtBan,
458 I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnLocalTopicChange,
459 I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan,
460 I_OnDelBan, I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead,
461 I_OnChangeLocalUserGECOS, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
462 I_OnPostOper, I_OnSyncNetwork, I_OnSetAway, I_OnUserList, I_OnPostCommand, I_OnPostJoin,
463 I_OnWhoisLine, I_OnBuildExemptList, I_OnRawSocketConnect, I_OnGarbageCollect, I_OnBufferFlushed,
464 I_OnText, I_OnPassCompare, I_OnRunTestSuite, I_OnNamesListItem, I_OnNumeric, I_OnHookIO,
465 I_OnHostCycle, I_OnPreRehash, I_OnModuleRehash,
471 /** Base class for all InspIRCd modules
472 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
473 * its methods will be called when irc server events occur. class inherited from module must be
474 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
476 class CoreExport Module : public Extensible
479 /** Creator/owner pointer
481 InspIRCd* ServerInstance;
483 /** File that this module was loaded from
485 std::string ModuleSourceFile;
487 /** Default constructor.
488 * Creates a module class.
489 * @param Me An instance of the InspIRCd class which will be saved into ServerInstance for your use
490 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
492 Module(InspIRCd* Me);
494 /** Default destructor.
495 * destroys a module class
499 virtual void Prioritize()
503 /** Returns the version number of a Module.
504 * The method should return a Version object with its version information assigned via
507 virtual Version GetVersion();
509 /** Called when a user connects.
510 * The details of the connecting user are available to you in the parameter User *user
511 * @param user The user who is connecting
513 virtual void OnUserConnect(User* user);
515 /** Called when a user quits.
516 * The details of the exiting user are available to you in the parameter User *user
517 * This event is only called when the user is fully registered when they quit. To catch
518 * raw disconnections, use the OnUserDisconnect method.
519 * @param user The user who is quitting
520 * @param message The user's quit message (as seen by non-opers)
521 * @param oper_message The user's quit message (as seen by opers)
523 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
525 /** Called whenever a user's socket is closed.
526 * The details of the exiting user are available to you in the parameter User *user
527 * This event is called for all users, registered or not, as a cleanup method for modules
528 * which might assign resources to user, such as dns lookups, objects and sockets.
529 * @param user The user who is disconnecting
531 virtual void OnUserDisconnect(User* user);
533 /** Called whenever a channel is about to be deleted
534 * @param chan The channel being deleted
535 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
537 virtual int OnChannelPreDelete(Channel *chan);
539 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
540 * @param chan The channel being deleted
542 virtual void OnChannelDelete(Channel* chan);
544 /** Called when a user joins a channel.
545 * The details of the joining user are available to you in the parameter User *user,
546 * and the details of the channel they have joined is available in the variable Channel *channel
547 * @param user The user who is joining
548 * @param channel The channel being joined
549 * @param silent Change this to true if you want to conceal the JOIN command from the other users
550 * of the channel (useful for modules such as auditorium)
551 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
552 * to a channel due to the network sync.
553 * @param created This is true if the join created the channel
555 virtual void OnUserJoin(User* user, Channel* channel, bool sync, bool &silent, bool created);
557 /** Called after a user joins a channel
558 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
560 * @param user The user who is joining
561 * @param channel The channel being joined
563 virtual void OnPostJoin(User* user, Channel* channel);
565 /** Called when a user parts a channel.
566 * The details of the leaving user are available to you in the parameter User *user,
567 * and the details of the channel they have left is available in the variable Channel *channel
568 * @param user The user who is parting
569 * @param channel The channel being parted
570 * @param partmessage The part message, or an empty string (may be modified)
571 * @param silent Change this to true if you want to conceal the PART command from the other users
572 * of the channel (useful for modules such as auditorium)
574 virtual void OnUserPart(User* user, Channel* channel, std::string &partmessage, bool &silent);
576 /** Called on rehash.
577 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
578 * system. This is called in all cases -- including when this server will not execute the
579 * rehash because it is directed at a remote server.
581 * @param user The user performing the rehash, if any. If this is server initiated, the value of
582 * this variable will be NULL.
583 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
586 virtual void OnPreRehash(User* user, const std::string ¶meter);
588 /** Called on rehash.
589 * This method is called when a user initiates a module-specific rehash. This can be used to do
590 * expensive operations (such as reloading SSL certificates) that are not executed on a normal
591 * rehash for efficiency. A rehash of this type does not reload the core configuration.
593 * @param user The user performing the rehash.
594 * @param parameter The parameter given to REHASH
596 virtual void OnModuleRehash(User* user, const std::string ¶meter);
598 /** Called on rehash.
599 * This method is called after a rehash has completed. You should use it to reload any module
600 * configuration from the main configuration file.
601 * @param user The user that performed the rehash, if it was initiated by a user and that user
602 * is still connected.
604 virtual void OnRehash(User* user);
606 /** Called whenever a snotice is about to be sent to a snomask.
607 * snomask and type may both be modified; the message may not.
608 * @param snomask The snomask the message is going to (e.g. 'A')
609 * @param type The textual description the snomask will go to (e.g. 'OPER')
610 * @param message The text message to be sent via snotice
611 * @return 1 to block the snotice from being sent entirely, 0 else.
613 virtual int OnSendSnotice(char &snomask, std::string &type, const std::string &message);
615 /** Called whenever a user is about to join a channel, before any processing is done.
616 * Returning a value of 1 from this function stops the process immediately, causing no
617 * output to be sent to the user by the core. If you do this you must produce your own numerics,
618 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
619 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
623 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
624 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
625 * processing on the actual channel record at this point, however the channel NAME will still be passed in
626 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
627 * @param user The user joining the channel
628 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
629 * @param cname The channel name being joined. For new channels this is valid where chan is not.
630 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "@".
631 * You may alter this string to alter the user's modes on the channel.
632 * @param keygiven The key given to join the channel, or an empty string if none was provided
633 * @return 1 To prevent the join, 0 to allow it.
635 virtual int OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string &privs, const std::string &keygiven);
637 /** Called whenever a user is about to be kicked.
638 * Returning a value of 1 from this function stops the process immediately, causing no
639 * output to be sent to the user by the core. If you do this you must produce your own numerics,
641 * @param source The user issuing the kick
642 * @param user The user being kicked
643 * @param chan The channel the user is being kicked from
644 * @param reason The kick reason
645 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
647 virtual int OnUserPreKick(User* source, User* user, Channel* chan, const std::string &reason);
649 /** Called whenever a user is kicked.
650 * If this method is called, the kick is already underway and cannot be prevented, so
651 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
652 * @param source The user issuing the kick
653 * @param user The user being kicked
654 * @param chan The channel the user is being kicked from
655 * @param reason The kick reason
656 * @param silent Change this to true if you want to conceal the PART command from the other users
657 * of the channel (useful for modules such as auditorium)
659 virtual void OnUserKick(User* source, User* user, Channel* chan, const std::string &reason, bool &silent);
661 /** Called whenever a user opers locally.
662 * The User will contain the oper mode 'o' as this function is called after any modifications
663 * are made to the user's structure by the core.
664 * @param user The user who is opering up
665 * @param opertype The opers type name
667 virtual void OnOper(User* user, const std::string &opertype);
669 /** Called after a user opers locally.
670 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
671 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
672 * out the OPERTYPE, etc.
673 * @param user The user who is opering up
674 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
675 * @param opertype The opers type name
677 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
679 /** Called whenever a user types /INFO.
680 * The User will contain the information of the user who typed the command. Modules may use this
681 * method to output their own credits in /INFO (which is the ircd's version of an about box).
682 * It is purposefully not possible to modify any info that has already been output, or halt the list.
683 * You must write a 371 numeric to the user, containing your info in the following format:
685 * <nick> :information here
687 * @param user The user issuing /INFO
689 virtual void OnInfo(User* user);
691 /** Called whenever a /WHOIS is performed on a local user.
692 * The source parameter contains the details of the user who issued the WHOIS command, and
693 * the dest parameter contains the information of the user they are whoising.
694 * @param source The user issuing the WHOIS command
695 * @param dest The user who is being WHOISed
697 virtual void OnWhois(User* source, User* dest);
699 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
700 * Returning 1 from this function stops the process immediately, causing no
701 * output to be sent to the user by the core. If you do this you must produce your own numerics,
702 * notices etc. This is useful for modules which may want to filter invites to channels.
703 * @param source The user who is issuing the INVITE
704 * @param dest The user being invited
705 * @param channel The channel the user is being invited to
706 * @param timeout The time the invite will expire (0 == never)
707 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
709 virtual int OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
711 /** Called after a user has been successfully invited to a channel.
712 * You cannot prevent the invite from occuring using this function, to do that,
713 * use OnUserPreInvite instead.
714 * @param source The user who is issuing the INVITE
715 * @param dest The user being invited
716 * @param channel The channel the user is being invited to
717 * @param timeout The time the invite will expire (0 == never)
719 virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout);
721 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
722 * Returning any nonzero value from this function stops the process immediately, causing no
723 * output to be sent to the user by the core. If you do this you must produce your own numerics,
724 * notices etc. This is useful for modules which may want to filter or redirect messages.
725 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
726 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
727 * of where the message is destined to be sent.
728 * @param user The user sending the message
729 * @param dest The target of the message (Channel* or User*)
730 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
731 * @param text Changeable text being sent by the user
732 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
733 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
734 * It will be ignored for private messages.
735 * @return 1 to deny the message, 0 to allow it
737 virtual int OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
739 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
740 * Returning any nonzero value from this function stops the process immediately, causing no
741 * output to be sent to the user by the core. If you do this you must produce your own numerics,
742 * notices etc. This is useful for modules which may want to filter or redirect messages.
743 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
744 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
745 * of where the message is destined to be sent.
746 * You may alter the message text as you wish before relinquishing control to the next module
747 * in the chain, and if no other modules block the text this altered form of the text will be sent out
748 * to the user and possibly to other servers.
749 * @param user The user sending the message
750 * @param dest The target of the message (Channel* or User*)
751 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
752 * @param text Changeable text being sent by the user
753 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
754 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
755 * It will be ignored for private notices.
756 * @return 1 to deny the NOTICE, 0 to allow it
758 virtual int OnUserPreNotice(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
760 /** Called whenever the server wants to build the exemption list for a channel, but is not directly doing a PRIVMSG or NOTICE.
761 * For example, the spanningtree protocol will call this event when passing a privmsg on (but not processing it directly).
762 * @param message_type The message type, either MSG_PRIVMSG or MSG_NOTICE
763 * @param chan The channel to build the exempt list of
764 * @param sender The original sender of the PRIVMSG or NOTICE
765 * @param status The status char to be used for the channel list
766 * @param exempt_list The exempt list to be populated
767 * @param text The original message text causing the exempt list to be built
769 virtual void OnBuildExemptList(MessageType message_type, Channel* chan, User* sender, char status, CUList &exempt_list, const std::string &text);
771 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
772 * Please note that although you can see remote nickchanges through this function, you should
773 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
774 * check user->server before taking any action (including returning nonzero from the method).
775 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
776 * module to generate some meaninful output.
777 * @param user The username changing their nick
778 * @param newnick Their new nickname
779 * @return 1 to deny the change, 0 to allow
781 virtual int OnUserPreNick(User* user, const std::string &newnick);
783 /** Called after any PRIVMSG sent from a user.
784 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
785 * if target_type is TYPE_CHANNEL.
786 * @param user The user sending the message
787 * @param dest The target of the message
788 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
789 * @param text the text being sent by the user
790 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
792 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
794 /** Called after any NOTICE sent from a user.
795 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
796 * if target_type is TYPE_CHANNEL.
797 * @param user The user sending the message
798 * @param dest The target of the message
799 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
800 * @param text the text being sent by the user
801 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
803 virtual void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
805 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
806 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
807 * if target_type is TYPE_CHANNEL.
808 * The difference between this event and OnUserPreNotice/OnUserPreMessage is that delivery is gauranteed,
809 * the message has already been vetted. In the case of the other two methods, a later module may stop your
810 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
811 * @param user The user sending the message
812 * @param dest The target of the message
813 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
814 * @param text the text being sent by the user
815 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
817 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
819 /** Called after every MODE command sent from a user
820 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
821 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
822 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
823 * @param user The user sending the MODEs
824 * @param dest The target of the modes (User* or Channel*)
825 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
826 * @param text The actual modes and their parameters if any
827 * @param translate The translation types of the mode parameters
829 virtual void OnMode(User* user, void* dest, int target_type, const std::vector<std::string> &text, const std::vector<TranslateType> &translate);
831 /** Allows modules to alter or create server descriptions
832 * Whenever a module requires a server description, for example for display in
833 * WHOIS, this function is called in all modules. You may change or define the
834 * description given in std::string &description. If you do, this description
835 * will be shown in the WHOIS fields.
836 * @param servername The servername being searched for
837 * @param description Alterable server description for this server
839 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
841 /** Allows modules to synchronize data which relates to users during a netburst.
842 * When this function is called, it will be called from the module which implements
843 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
844 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
845 * (see below). This function will be called for every user visible on your side
846 * of the burst, allowing you to for example set modes, etc. Do not use this call to
847 * synchronize data which you have stored using class Extensible -- There is a specialist
848 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
849 * @param user The user being syncronized
850 * @param proto A pointer to the module handling network protocol
851 * @param opaque An opaque pointer set by the protocol module, should not be modified!
853 virtual void OnSyncUser(User* user, Module* proto, void* opaque);
855 /** Allows modules to synchronize data which relates to channels during a netburst.
856 * When this function is called, it will be called from the module which implements
857 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
858 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
859 * (see below). This function will be called for every user visible on your side
860 * of the burst, allowing you to for example set modes, etc.
862 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
864 * @param chan The channel being syncronized
865 * @param proto A pointer to the module handling network protocol
866 * @param opaque An opaque pointer set by the protocol module, should not be modified!
868 virtual void OnSyncChannel(Channel* chan, Module* proto, void* opaque);
870 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
871 * Whenever the linking module wants to send out data, but doesnt know what the data
872 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
873 * this method is called. You should use the ProtoSendMetaData function after you've
874 * correctly decided how the data should be represented, to send the metadata on its way if
875 * if it belongs to your module.
876 * @param proto A pointer to the module handling network protocol
877 * @param opaque An opaque pointer set by the protocol module, should not be modified!
878 * @param displayable If this value is true, the data is going to be displayed to a user,
879 * and not sent across the network. Use this to determine wether or not to show sensitive data.
881 virtual void OnSyncNetwork(Module* proto, void* opaque);
883 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
884 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
885 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
886 * @param target The Channel* or User* that data should be added to
887 * @param extname The extension name which is being sent
888 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
890 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
892 /** Implemented by modules which provide the ability to link servers.
893 * These modules will implement this method, which allows transparent sending of servermodes
894 * down the network link as a broadcast, without a module calling it having to know the format
895 * of the MODE command before the actual mode string.
897 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
898 * of how to use this function.
900 * @param opaque An opaque pointer set by the protocol module, should not be modified!
901 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
902 * @param target The Channel* or User* that modes should be sent for
903 * @param modeline The modes and parameters to be sent
904 * @param translate The translation types of the mode parameters
906 virtual void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::vector<std::string> &modeline, const std::vector<TranslateType> &translate);
908 /** Implemented by modules which provide the ability to link servers.
909 * These modules will implement this method, which allows metadata (extra data added to
910 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
911 * to other servers on a netburst and decoded at the other end by the same module on a
914 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
915 * how to use this function.
916 * @param opaque An opaque pointer set by the protocol module, should not be modified!
917 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
918 * @param target The Channel* or User* that metadata should be sent for
919 * @param extname The extension name to send metadata for
920 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
922 virtual void ProtoSendMetaData(void* opaque, Extensible* target, const std::string &extname, const std::string &extdata);
925 * Implemented by all modules that implement ProtoSendMetaData.
926 * Translates the item into a string format suitable for sending to other servers.
927 * Currently, this just translates nicks to their UID and channels to their name
929 virtual std::string ProtoTranslate(Extensible* item);
931 /** Called after every WALLOPS command.
932 * @param user The user sending the WALLOPS
933 * @param text The content of the WALLOPS message
935 virtual void OnWallops(User* user, const std::string &text);
937 /** Called whenever a user's hostname is changed.
938 * This event triggers after the host has been set.
939 * @param user The user whos host is being changed
940 * @param newhost The new hostname being set
942 virtual void OnChangeHost(User* user, const std::string &newhost);
944 /** Called whenever a user's GECOS (realname) is changed.
945 * This event triggers after the name has been set.
946 * @param user The user who's GECOS is being changed
947 * @param gecos The new GECOS being set on the user
949 virtual void OnChangeName(User* user, const std::string &gecos);
951 /** Called whenever an xline is added by a local user.
952 * This method is triggered after the line is added.
953 * @param source The sender of the line or NULL for local server
954 * @param line The xline being added
956 virtual void OnAddLine(User* source, XLine* line);
958 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
959 * This method is triggered after the line is deleted.
960 * @param source The user removing the line or NULL for local server
961 * @param line the line being deleted
963 virtual void OnDelLine(User* source, XLine* line);
965 /** Called whenever an xline expires.
966 * This method is triggered after the line is deleted.
967 * @param line The line being deleted.
969 virtual void OnExpireLine(XLine *line);
971 /** Called before your module is unloaded to clean up Extensibles.
972 * This method is called once for every user and channel on the network,
973 * so that when your module unloads it may clear up any remaining data
974 * in the form of Extensibles added using Extensible::Extend().
975 * If the target_type variable is TYPE_USER, then void* item refers to
976 * a User*, otherwise it refers to a Channel*.
977 * @param target_type The type of item being cleaned
978 * @param item A pointer to the item's class
980 virtual void OnCleanup(int target_type, void* item);
982 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
983 * have been applied. Please note that although you can see remote nickchanges through this function, you should
984 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
985 * check user->server before taking any action (including returning nonzero from the method).
986 * Because this method is called after the nickchange is taken place, no return values are possible
987 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
988 * @param user The user changing their nick
989 * @param oldnick The old nickname of the user before the nickchange
991 virtual void OnUserPostNick(User* user, const std::string &oldnick);
993 /** Called before an action which requires a channel privilage check.
994 * This function is called before many functions which check a users status on a channel, for example
995 * before opping a user, deopping a user, kicking a user, etc.
996 * There are several values for access_type which indicate for what reason access is being checked.
998 * AC_KICK - A user is being kicked<br>
999 * AC_DEOP - a user is being deopped<br>
1000 * AC_OP - a user is being opped<br>
1001 * AC_VOICE - a user is being voiced<br>
1002 * AC_DEVOICE - a user is being devoiced<br>
1003 * AC_HALFOP - a user is being halfopped<br>
1004 * AC_DEHALFOP - a user is being dehalfopped<br>
1005 * AC_INVITE - a user is being invited<br>
1006 * AC_GENERAL_MODE - a user channel mode is being changed<br><br>
1007 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
1008 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
1009 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
1010 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
1011 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
1012 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
1013 * @param source The source of the access check
1014 * @param dest The destination of the access check
1015 * @param channel The channel which is being checked
1016 * @param access_type See above
1018 virtual int OnAccessCheck(User* source,User* dest,Channel* channel,int access_type);
1020 /** Called when a 005 numeric is about to be output.
1021 * The module should modify the 005 numeric if needed to indicate its features.
1022 * @param output The 005 string to be modified if neccessary.
1024 virtual void On005Numeric(std::string &output);
1026 /** Called when a client is disconnected by KILL.
1027 * If a client is killed by a server, e.g. a nickname collision or protocol error,
1029 * Return 1 from this function to prevent the kill, and 0 from this function to allow
1030 * it as normal. If you prevent the kill no output will be sent to the client, it is
1031 * down to your module to generate this information.
1032 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
1033 * If you do so youre risking race conditions, desyncs and worse!
1034 * @param source The user sending the KILL
1035 * @param dest The user being killed
1036 * @param reason The kill reason
1037 * @return 1 to prevent the kill, 0 to allow
1039 virtual int OnKill(User* source, User* dest, const std::string &reason);
1041 /** Called when an oper wants to disconnect a remote user via KILL
1042 * @param source The user sending the KILL
1043 * @param dest The user being killed
1044 * @param reason The kill reason
1046 virtual void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
1048 /** Called whenever a module is loaded.
1049 * mod will contain a pointer to the module, and string will contain its name,
1050 * for example m_widgets.so. This function is primary for dependency checking,
1051 * your module may decide to enable some extra features if it sees that you have
1052 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
1053 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
1054 * but instead operate under reduced functionality, unless the dependency is
1055 * absolutely neccessary (e.g. a module that extends the features of another
1057 * @param mod A pointer to the new module
1058 * @param name The new module's filename
1060 virtual void OnLoadModule(Module* mod,const std::string &name);
1062 /** Called whenever a module is unloaded.
1063 * mod will contain a pointer to the module, and string will contain its name,
1064 * for example m_widgets.so. This function is primary for dependency checking,
1065 * your module may decide to enable some extra features if it sees that you have
1066 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
1067 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
1068 * but instead operate under reduced functionality, unless the dependency is
1069 * absolutely neccessary (e.g. a module that extends the features of another
1071 * @param mod Pointer to the module being unloaded (still valid)
1072 * @param name The filename of the module being unloaded
1074 virtual void OnUnloadModule(Module* mod,const std::string &name);
1076 /** Called once every five seconds for background processing.
1077 * This timer can be used to control timed features. Its period is not accurate
1078 * enough to be used as a clock, but it is gauranteed to be called at least once in
1079 * any five second period, directly from the main loop of the server.
1080 * @param curtime The current timer derived from time(2)
1082 virtual void OnBackgroundTimer(time_t curtime);
1084 /** Called whenever any command is about to be executed.
1085 * This event occurs for all registered commands, wether they are registered in the core,
1086 * or another module, and for invalid commands. Invalid commands may only be sent to this
1087 * function when the value of validated is false. By returning 1 from this method you may prevent the
1088 * command being executed. If you do this, no output is created by the core, and it is
1089 * down to your module to produce any output neccessary.
1090 * Note that unless you return 1, you should not destroy any structures (e.g. by using
1091 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
1092 * method returns, it will be passed an invalid pointer to the user object and crash!)
1093 * @param command The command being executed
1094 * @param parameters An array of array of characters containing the parameters for the command
1095 * @param pcnt The nuimber of parameters passed to the command
1096 * @param user the user issuing the command
1097 * @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.
1098 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
1099 * @param original_line The entire original line as passed to the parser from the user
1100 * @return 1 to block the command, 0 to allow
1102 virtual int OnPreCommand(std::string &command, std::vector<std::string>& parameters, User *user, bool validated, const std::string &original_line);
1104 /** Called after any command has been executed.
1105 * This event occurs for all registered commands, wether they are registered in the core,
1106 * or another module, but it will not occur for invalid commands (e.g. ones which do not
1107 * exist within the command table). The result code returned by the command handler is
1109 * @param command The command being executed
1110 * @param parameters An array of array of characters containing the parameters for the command
1111 * @param pcnt The nuimber of parameters passed to the command
1112 * @param user the user issuing the command
1113 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
1114 * @param original_line The entire original line as passed to the parser from the user
1116 virtual void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, User *user, CmdResult result, const std::string &original_line);
1118 /** Called to check if a user who is connecting can now be allowed to register
1119 * If any modules return false for this function, the user is held in the waiting
1120 * state until all modules return true. For example a module which implements ident
1121 * lookups will continue to return false for a user until their ident lookup is completed.
1122 * Note that the registration timeout for a user overrides these checks, if the registration
1123 * timeout is reached, the user is disconnected even if modules report that the user is
1124 * not ready to connect.
1125 * @param user The user to check
1126 * @return true to indicate readiness, false if otherwise
1128 virtual bool OnCheckReady(User* user);
1130 /** Called whenever a user is about to register their connection (e.g. before the user
1131 * is sent the MOTD etc). Modules can use this method if they are performing a function
1132 * which must be done before the actual connection is completed (e.g. ident lookups,
1133 * dnsbl lookups, etc).
1134 * Note that you should NOT delete the user record here by causing a disconnection!
1135 * Use OnUserConnect for that instead.
1136 * @param user The user registering
1137 * @return 1 to indicate user quit, 0 to continue
1139 virtual int OnUserRegister(User* user);
1141 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1142 * This method will always be called for each join, wether or not the channel is actually +i, and
1143 * determines the outcome of an if statement around the whole section of invite checking code.
1144 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1145 * @param user The user joining the channel
1146 * @param chan The channel being joined
1147 * @return 1 to explicitly allow the join, 0 to proceed as normal
1149 virtual int OnCheckInvite(User* user, Channel* chan);
1151 /** Called whenever a mode character is processed.
1152 * Return 1 from this function to block the mode character from being processed entirely.
1153 * @param user The user who is sending the mode
1154 * @param chan The channel the mode is being sent to (or NULL if a usermode)
1155 * @param mode The mode character being set
1156 * @param param The parameter for the mode or an empty string
1157 * @param adding true of the mode is being added, false if it is being removed
1158 * @param pcnt The parameter count for the mode (0 or 1)
1159 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
1160 * to skip all permission checking. Please note that for remote mode changes, your return value
1163 virtual int OnRawMode(User* user, Channel* chan, const char mode, const std::string ¶m, bool adding, int pcnt);
1165 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1166 * This method will always be called for each join, wether or not the channel is actually +k, and
1167 * determines the outcome of an if statement around the whole section of key checking code.
1168 * if the user specified no key, the keygiven string will be a valid but empty value.
1169 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1170 * @param user The user joining the channel
1171 * @param chan The channel being joined
1172 * @return 1 to explicitly allow the join, 0 to proceed as normal
1174 virtual int OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
1176 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1177 * This method will always be called for each join, wether or not the channel is actually +l, and
1178 * determines the outcome of an if statement around the whole section of channel limit checking code.
1179 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1180 * @param user The user joining the channel
1181 * @param chan The channel being joined
1182 * @return 1 to explicitly allow the join, 0 to proceed as normal
1184 virtual int OnCheckLimit(User* user, Channel* chan);
1186 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
1187 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
1188 * determines the outcome of an if statement around the whole section of ban checking code.
1189 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1190 * @param user The user joining the channel
1191 * @param chan The channel being joined
1192 * @return 1 to explicitly allow the join, 0 to proceed as normal. Return -1 to explicitly deny the
1193 * join to the channel.
1195 virtual int OnCheckBan(User* user, Channel* chan);
1197 /* Called whenever checking whether or not a user is matched by an applicable extended bantype.
1198 * NOTE: may also trigger extra OnCheckStringExtBan events!
1199 * @param u The user to check
1200 * @param c The channel the user is on
1201 * @param type The type of extended ban to check for.
1202 * @returns 1 = exempt, 0 = no match, -1 = banned
1204 virtual int OnCheckExtBan(User *u, Channel *c, char type);
1206 /** Called whenever checking whether or not a string is extbanned. NOTE: one OnCheckExtBan will also trigger a number of
1207 * OnCheckStringExtBan events for seperate host/IP comnbinations.
1208 * @returns 1 = exempt, 0 = no match, -1 = banned
1210 virtual int OnCheckStringExtBan(const std::string &s, Channel *c, char type);
1212 /** Called on all /STATS commands
1213 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1214 * @param symbol the symbol provided to /STATS
1215 * @param user the user issuing the /STATS command
1216 * @param results A string_list to append results into. You should put all your results
1217 * into this string_list, rather than displaying them directly, so that your handler will
1218 * work when remote STATS queries are received.
1219 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1221 virtual int OnStats(char symbol, User* user, string_list &results);
1223 /** Called whenever a change of a local users displayed host is attempted.
1224 * Return 1 to deny the host change, or 0 to allow it.
1225 * @param user The user whos host will be changed
1226 * @param newhost The new hostname
1227 * @return 1 to deny the host change, 0 to allow
1229 virtual int OnChangeLocalUserHost(User* user, const std::string &newhost);
1231 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1232 * return 1 to deny the name change, or 0 to allow it.
1233 * @param user The user whos GECOS will be changed
1234 * @param newhost The new GECOS
1235 * @return 1 to deny the GECOS change, 0 to allow
1237 virtual int OnChangeLocalUserGECOS(User* user, const std::string &newhost);
1239 /** Called whenever a topic is changed by a local user.
1240 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
1241 * @param user The user changing the topic
1242 * @param chan The channels who's topic is being changed
1243 * @param topic The actual topic text
1244 * @param 1 to block the topic change, 0 to allow
1246 virtual int OnLocalTopicChange(User* user, Channel* chan, const std::string &topic);
1248 /** Called whenever a local topic has been changed.
1249 * To block topic changes you must use OnLocalTopicChange instead.
1250 * @param user The user changing the topic
1251 * @param chan The channels who's topic is being changed
1252 * @param topic The actual topic text
1254 virtual void OnPostLocalTopicChange(User* user, Channel* chan, const std::string &topic);
1256 /** Called whenever an Event class is sent to all module by another module.
1257 * Please see the documentation of Event::Send() for further information. The Event sent can
1258 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1259 * before doing anything to the event data, and you should *not* change the event data in any way!
1260 * @param event The Event class being received
1262 virtual void OnEvent(Event* event);
1264 /** Called whenever a Request class is sent to your module by another module.
1265 * Please see the documentation of Request::Send() for further information. The Request sent
1266 * can always be assumed to be non-NULL, you should not change the request object or its data.
1267 * Your method may return arbitary data in the char* result which the requesting module
1268 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1269 * @param request The Request class being received
1271 virtual const char* OnRequest(Request* request);
1273 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
1274 * The password field (from the config file) is in 'password' and is to be compared against
1275 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
1276 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
1277 * @param ex The object that's causing the authentication (User* for <oper> <connect:allow> etc, Server* for <link>).
1278 * @param password The password from the configuration file (the password="" value).
1279 * @param input The password entered by the user or whoever.
1280 * @param hashtype The hash value from the config
1281 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
1283 virtual int OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
1285 /** Called whenever a user is given usermode +o, anywhere on the network.
1286 * You cannot override this and prevent it from happening as it is already happened and
1287 * such a task must be performed by another server. You can however bounce modes by sending
1288 * servermodes out to reverse mode changes.
1289 * @param user The user who is opering
1291 virtual void OnGlobalOper(User* user);
1293 /** Called after a user has fully connected and all modules have executed OnUserConnect
1294 * This event is informational only. You should not change any user information in this
1295 * event. To do so, use the OnUserConnect method to change the state of local users.
1296 * This is called for both local and remote users.
1297 * @param user The user who is connecting
1299 virtual void OnPostConnect(User* user);
1301 /** Called whenever a ban is added to a channel's list.
1302 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1303 * @param source The user adding the ban
1304 * @param channel The channel the ban is being added to
1305 * @param banmask The ban mask being added
1306 * @return 1 to block the ban, 0 to continue as normal
1308 virtual int OnAddBan(User* source, Channel* channel,const std::string &banmask);
1310 /** Called whenever a ban is removed from a channel's list.
1311 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1312 * @param source The user deleting the ban
1313 * @param channel The channel the ban is being deleted from
1314 * @param banmask The ban mask being deleted
1315 * @return 1 to block the unban, 0 to continue as normal
1317 virtual int OnDelBan(User* source, Channel* channel,const std::string &banmask);
1319 /** Called to install an I/O hook on an event handler
1320 * @param user The item to possibly install the I/O hook on
1321 * @param via The port that <user> connected on
1323 virtual void OnHookIO(EventHandler* user, ListenSocketBase* via);
1325 /** Called immediately after any connection is accepted. This is intended for raw socket
1326 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1327 * no information relating to a user record as the connection has not been assigned yet.
1328 * There are no return values from this call as all modules get an opportunity if required to
1329 * process the connection.
1330 * @param fd The file descriptor returned from accept()
1331 * @param client The client IP address and port
1332 * @param server The server IP address and port
1333 * @param localport The local port number the user connected to
1335 virtual void OnRawSocketAccept(int fd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
1337 /** Called immediately before any write() operation on a user's socket in the core. Because
1338 * this event is a low level event no user information is associated with it. It is intended
1339 * for use by modules which may wrap connections within another API such as SSL for example.
1340 * return a non-zero result if you have handled the write operation, in which case the core
1341 * will not call write().
1342 * @param fd The file descriptor of the socket
1343 * @param buffer A char* buffer being written
1344 * @param Number of characters to write
1345 * @return Number of characters actually written or 0 if you didn't handle the operation
1347 virtual int OnRawSocketWrite(int fd, const char* buffer, int count);
1349 /** Called immediately before any socket is closed. When this event is called, shutdown()
1350 * has not yet been called on the socket.
1351 * @param fd The file descriptor of the socket prior to close()
1353 virtual void OnRawSocketClose(int fd);
1355 /** Called immediately upon connection of an outbound BufferedSocket which has been hooked
1357 * @param fd The file descriptor of the socket immediately after connect()
1359 virtual void OnRawSocketConnect(int fd);
1361 /** Called immediately before any read() operation on a client socket in the core.
1362 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1363 * when this event occurs.
1364 * Your event should return 1 if it has handled the reading itself, which prevents the core
1365 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1366 * the value of count. The value of readresult must be identical to an actual result that might
1367 * be returned from the read() system call, for example, number of bytes read upon success,
1368 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1369 * you MUST set readresult.
1370 * @param fd The file descriptor of the socket
1371 * @param buffer A char* buffer being read to
1372 * @param count The size of the buffer
1373 * @param readresult The amount of characters read, or 0
1374 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1376 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1378 /** Called whenever a user sets away or returns from being away.
1379 * The away message is available as a parameter, but should not be modified.
1380 * At this stage, it has already been copied into the user record.
1381 * If awaymsg is empty, the user is returning from away.
1382 * @param user The user setting away
1383 * @param awaymsg The away message of the user, or empty if returning from away
1384 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
1386 virtual int OnSetAway(User* user, const std::string &awaymsg);
1388 /** Called whenever a NAMES list is requested.
1389 * You can produce the nameslist yourself, overriding the current list,
1390 * and if you do you must return 1. If you do not handle the names list,
1392 * @param The user requesting the NAMES list
1393 * @param Ptr The channel the NAMES list is requested for
1394 * @param userlist The user list for the channel (you may change this pointer.
1395 * If you want to change the values, take a copy first, and change the copy, then
1396 * point the pointer at your copy)
1397 * @return 1 to prevent the user list being sent to the client, 0 to allow it.
1398 * Returning -1 allows the names list, but bypasses any checks which check for
1399 * channel membership before sending the names list.
1401 virtual int OnUserList(User* user, Channel* Ptr, CUList* &userlist);
1403 /** Called whenever a line of WHOIS output is sent to a user.
1404 * You may change the numeric and the text of the output by changing
1405 * the values numeric and text, but you cannot change the user the
1406 * numeric is sent to. You may however change the user's User values.
1407 * @param user The user the numeric is being sent to
1408 * @param dest The user being WHOISed
1409 * @param numeric The numeric of the line being sent
1410 * @param text The text of the numeric, including any parameters
1411 * @return nonzero to drop the line completely so that the user does not
1412 * receive it, or zero to allow the line to be sent.
1414 virtual int OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
1416 /** Called at intervals for modules to garbage-collect any hashes etc.
1417 * Certain data types such as hash_map 'leak' buckets, which must be
1418 * tidied up and freed by copying into a new item every so often. This
1419 * method is called when it is time to do that.
1421 virtual void OnGarbageCollect();
1423 /** Called whenever a user's write buffer has been completely sent.
1424 * This is called when the user's write buffer is completely empty, and
1425 * there are no more pending bytes to be written and no pending write events
1426 * in the socket engine's queue. This may be used to refill the buffer with
1427 * data which is being spooled in a controlled manner, e.g. LIST lines.
1428 * @param user The user who's buffer is now empty.
1430 virtual void OnBufferFlushed(User* user);
1432 /** Add test suite hooks here. These are used for testing functionality of a module
1433 * via the --testsuite debugging parameter.
1435 virtual void OnRunTestSuite();
1437 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
1438 * For example NAMESX, channel mode +u and +I, and UHNAMES. If the nick is set to an empty string by any
1439 * module, then this will cause the nickname not to be displayed at all.
1441 virtual void OnNamesListItem(User* issuer, User* user, Channel* channel, std::string &prefixes, std::string &nick);
1443 virtual int OnNumeric(User* user, unsigned int numeric, const std::string &text);
1445 /** Called for every time the user's host or ident changes, to indicate wether or not the 'Changing host'
1446 * message should be sent, if enabled. Certain modules such as auditorium may opt to hide this message
1447 * even if it is enabled.
1449 virtual bool OnHostCycle(User* user);
1453 #define CONF_NO_ERROR 0x000000
1454 #define CONF_NOT_A_NUMBER 0x000010
1455 #define CONF_INT_NEGATIVE 0x000080
1456 #define CONF_VALUE_NOT_FOUND 0x000100
1457 #define CONF_FILE_NOT_FOUND 0x000200
1460 /** Allows reading of values from configuration files
1461 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1462 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1463 * Constructing the class using one parameter allows you to specify a path to your own configuration
1464 * file, otherwise, inspircd.conf is read.
1466 class CoreExport ConfigReader : public classbase
1469 InspIRCd* ServerInstance;
1475 /** Default constructor.
1476 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1477 * as specified when running ./configure.
1479 ConfigReader(InspIRCd* Instance);
1480 /** Default destructor.
1481 * This method destroys the ConfigReader class.
1485 /** Retrieves a value from the config file.
1486 * This method retrieves a value from the config file. Where multiple copies of the tag
1487 * exist in the config file, index indicates which of the values to retrieve.
1489 std::string ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds = false);
1490 /** Retrieves a value from the config file.
1491 * This method retrieves a 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. If the
1493 * tag is not found the default value is returned instead.
1495 std::string ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds = false);
1497 /** Retrieves a boolean value from the config file.
1498 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1499 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1500 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1502 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1503 /** Retrieves a boolean value from the config file.
1504 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1505 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1506 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1507 * If the tag is not found, the default value is used instead.
1509 bool ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index);
1511 /** Retrieves an integer value from the config file.
1512 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1513 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1514 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1515 * return CONF_INVALID_NUMBER to be returned. need_positive is set if the number must be non-negative.
1516 * If a negative number is placed into a tag which is specified positive, 0 will be returned and GetError()
1517 * will return CONF_INT_NEGATIVE. Note that need_positive is not suitable to get an unsigned int - you
1518 * should cast the result to achieve that effect.
1520 int ReadInteger(const std::string &tag, const std::string &name, int index, bool need_positive);
1521 /** Retrieves an integer value from the config file.
1522 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1523 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1524 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1525 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1526 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1527 * will return CONF_NOT_UNSIGNED. If the tag is not found, the default value is used instead.
1529 int ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool need_positive);
1531 /** Returns the last error to occur.
1532 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1533 * A call to GetError() resets the error flag back to 0.
1536 /** Counts the number of times a given tag appears in the config file.
1537 * This method counts the number of times a tag appears in a config file, for use where
1538 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1539 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1540 * multiple instance tag.
1542 int Enumerate(const std::string &tag);
1544 /** Returns the number of items within a tag.
1545 * For example if the tag was <test tag="blah" data="foo"> then this
1546 * function would return 2. Spaces and newlines both qualify as valid seperators
1549 int EnumerateValues(const std::string &tag, int index);
1554 /** Caches a text file into memory and can be used to retrieve lines from it.
1555 * This class contains methods for read-only manipulation of a text file in memory.
1556 * Either use the constructor type with one parameter to load a file into memory
1557 * at construction, or use the LoadFile method to load a file.
1559 class CoreExport FileReader : public classbase
1561 InspIRCd* ServerInstance;
1562 /** The file contents
1566 /** Content size in bytes
1568 unsigned long contentsize;
1570 /** Calculate content size in bytes
1575 /** Default constructor.
1576 * This method does not load any file into memory, you must use the LoadFile method
1577 * after constructing the class this way.
1579 FileReader(InspIRCd* Instance);
1581 /** Secondary constructor.
1582 * This method initialises the class with a file loaded into it ready for GetLine and
1583 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1586 FileReader(InspIRCd* Instance, const std::string &filename);
1588 /** Default destructor.
1589 * This deletes the memory allocated to the file.
1593 /** Used to load a file.
1594 * This method loads a file into the class ready for GetLine and
1595 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1598 void LoadFile(const std::string &filename);
1600 /** Returns the whole content of the file as std::string
1602 std::string Contents();
1604 /** Returns the entire size of the file as std::string
1606 unsigned long ContentSize();
1608 /** Returns true if the file exists
1609 * This function will return false if the file could not be opened.
1613 /** Retrieve one line from the file.
1614 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1615 * the index was out of bounds, or the line had no data on it.
1617 std::string GetLine(int x);
1619 /** Returns the size of the file in lines.
1620 * This method returns the number of lines in the read file. If it is 0, no lines have been
1621 * read into memory, either because the file is empty or it does not exist, or cannot be
1622 * opened due to permission problems.
1627 /** A DLLFactory (designed to load shared objects) containing a
1628 * handle to a module's init_module() function. Unfortunately,
1629 * due to the design of shared object systems we must keep this
1630 * hanging around, as if we remove this handle, we remove the
1631 * shared object file from memory (!)
1633 typedef DLLFactory<Module> ircd_module;
1635 /** A list of modules
1637 typedef std::vector<Module*> IntModuleList;
1639 /** An event handler iterator
1641 typedef IntModuleList::iterator EventHandlerIter;
1643 /** ModuleManager takes care of all things module-related
1646 class CoreExport ModuleManager : public classbase
1649 /** Holds a string describing the last module error to occur
1651 std::string LastModuleError;
1653 /** The feature names published by various modules
1655 featurelist Features;
1657 /** The interface names published by various modules
1659 interfacelist Interfaces;
1661 /** Total number of modules loaded into the ircd
1665 /** Our pointer to the main insp instance
1669 /** List of loaded modules and shared object/dll handles
1670 * keyed by module name
1672 std::map<std::string, std::pair<ircd_module*, Module*> > Modules;
1678 } prioritizationState;
1681 /** Event handler hooks.
1682 * This needs to be public to be used by FOREACH_MOD and friends.
1684 IntModuleList EventHandlers[I_END];
1686 /** Simple, bog-standard, boring constructor.
1688 ModuleManager(InspIRCd* Ins);
1694 /** Change the priority of one event in a module.
1695 * Each module event has a list of modules which are attached to that event type.
1696 * If you wish to be called before or after other specific modules, you may use this
1697 * method (usually within void Module::Prioritize()) to set your events priority.
1698 * You may use this call in other methods too, however, this is not supported behaviour
1700 * @param mod The module to change the priority of
1701 * @param i The event to change the priority of
1702 * @param s The state you wish to use for this event. Use one of
1703 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1704 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1705 * to set it to be before or after one or more other modules.
1706 * @param modules If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1707 * then this contains a list of one or more modules your module must be
1708 * placed before or after. Your module will be placed before the highest
1709 * priority module in this list for PRIO_BEFORE, or after the lowest
1710 * priority module in this list for PRIORITY_AFTER.
1711 * @param sz The number of modules being passed for PRIO_BEFORE and PRIORITY_AFTER.
1712 * Defaults to 1, as most of the time you will only want to prioritize your module
1713 * to be before or after one other module.
1715 bool SetPriority(Module* mod, Implementation i, Priority s, Module** modules = NULL, size_t sz = 1);
1717 /** Change the priority of all events in a module.
1718 * @param mod The module to set the priority of
1719 * @param s The priority of all events in the module.
1720 * Note that with this method, it is not possible to effectively use
1721 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1722 * SetPriority method for this, where you may specify other modules to
1723 * be prioritized against.
1725 bool SetPriority(Module* mod, Priority s);
1727 /** Attach an event to a module.
1728 * You may later detatch the event with ModuleManager::Detach().
1729 * If your module is unloaded, all events are automatically detatched.
1730 * @param i Event type to attach
1731 * @param mod Module to attach event to
1732 * @return True if the event was attached
1734 bool Attach(Implementation i, Module* mod);
1736 /** Detatch an event from a module.
1737 * This is not required when your module unloads, as the core will
1738 * automatically detatch your module from all events it is attached to.
1739 * @param i Event type to detach
1740 * @param mod Module to detach event from
1741 * @param Detach true if the event was detached
1743 bool Detach(Implementation i, Module* mod);
1745 /** Attach an array of events to a module
1746 * @param i Event types (array) to attach
1747 * @param mod Module to attach events to
1749 void Attach(Implementation* i, Module* mod, size_t sz);
1751 /** Detach all events from a module (used on unload)
1752 * @param mod Module to detach from
1754 void DetachAll(Module* mod);
1756 /** Returns text describing the last module error
1757 * @return The last error message to occur
1759 std::string& LastError();
1761 /** Load a given module file
1762 * @param filename The file to load
1763 * @return True if the module was found and loaded
1765 bool Load(const char* filename);
1767 /** Unload a given module file
1768 * @param filename The file to unload
1769 * @return True if the module was unloaded
1771 bool Unload(const char* filename);
1773 /** Called by the InspIRCd constructor to load all modules from the config file.
1777 /** Get the total number of currently loaded modules
1778 * @return The number of loaded modules
1782 return this->ModCount;
1785 /** Find a module by name, and return a Module* to it.
1786 * This is preferred over iterating the module lists yourself.
1787 * @param name The module name to look up
1788 * @return A pointer to the module, or NULL if the module cannot be found
1790 Module* Find(const std::string &name);
1792 /** Publish a 'feature'.
1793 * There are two ways for a module to find another module it depends on.
1794 * Either by name, using InspIRCd::FindModule, or by feature, using this
1795 * function. A feature is an arbitary string which identifies something this
1796 * module can do. For example, if your module provides SSL support, but other
1797 * modules provide SSL support too, all the modules supporting SSL should
1798 * publish an identical 'SSL' feature. This way, any module requiring use
1799 * of SSL functions can just look up the 'SSL' feature using FindFeature,
1800 * then use the module pointer they are given.
1801 * @param FeatureName The case sensitive feature name to make available
1802 * @param Mod a pointer to your module class
1803 * @returns True on success, false if the feature is already published by
1806 bool PublishFeature(const std::string &FeatureName, Module* Mod);
1808 /** Publish a module to an 'interface'.
1809 * Modules which implement the same interface (the same way of communicating
1810 * with other modules) can publish themselves to an interface, using this
1811 * method. When they do so, they become part of a list of related or
1812 * compatible modules, and a third module may then query for that list
1813 * and know that all modules within that list offer the same API.
1814 * A prime example of this is the hashing modules, which all accept the
1815 * same types of Request class. Consider this to be similar to PublishFeature,
1816 * except for that multiple modules may publish the same 'feature'.
1817 * @param InterfaceName The case sensitive interface name to make available
1818 * @param Mod a pointer to your module class
1819 * @returns True on success, false on failure (there are currently no failure
1822 bool PublishInterface(const std::string &InterfaceName, Module* Mod);
1824 /** Return a pair saying how many other modules are currently using the
1825 * interfaces provided by module m.
1826 * @param m The module to count usage for
1827 * @return A pair, where the first value is the number of uses of the interface,
1828 * and the second value is the interface name being used.
1830 std::pair<int,std::string> GetInterfaceInstanceCount(Module* m);
1832 /** Mark your module as using an interface.
1833 * If you mark your module as using an interface, then that interface
1834 * module may not unload until your module has unloaded first.
1835 * This can be used to prevent crashes by ensuring code you depend on
1836 * is always in memory while your module is active.
1837 * @param InterfaceName The interface to use
1839 void UseInterface(const std::string &InterfaceName);
1841 /** Mark your module as finished with an interface.
1842 * If you used UseInterface() above, you should use this method when
1843 * your module is finished with the interface (usually in its destructor)
1844 * to allow the modules which implement the given interface to be unloaded.
1845 * @param InterfaceName The interface you are finished with using.
1847 void DoneWithInterface(const std::string &InterfaceName);
1849 /** Unpublish a 'feature'.
1850 * When your module exits, it must call this method for every feature it
1851 * is providing so that the feature table is cleaned up.
1852 * @param FeatureName the feature to remove
1854 bool UnpublishFeature(const std::string &FeatureName);
1856 /** Unpublish your module from an interface
1857 * When your module exits, it must call this method for every interface
1858 * it is part of so that the interfaces table is cleaned up. Only when
1859 * the last item is deleted from an interface does the interface get
1861 * @param InterfaceName the interface to be removed from
1862 * @param Mod The module to remove from the interface list
1864 bool UnpublishInterface(const std::string &InterfaceName, Module* Mod);
1866 /** Find a 'feature'.
1867 * There are two ways for a module to find another module it depends on.
1868 * Either by name, using InspIRCd::FindModule, or by feature, using the
1869 * InspIRCd::PublishFeature method. A feature is an arbitary string which
1870 * identifies something this module can do. For example, if your module
1871 * provides SSL support, but other modules provide SSL support too, all
1872 * the modules supporting SSL should publish an identical 'SSL' feature.
1873 * To find a module capable of providing the feature you want, simply
1874 * call this method with the feature name you are looking for.
1875 * @param FeatureName The feature name you wish to obtain the module for
1876 * @returns A pointer to a valid module class on success, NULL on failure.
1878 Module* FindFeature(const std::string &FeatureName);
1880 /** Find an 'interface'.
1881 * An interface is a list of modules which all implement the same API.
1882 * @param InterfaceName The Interface you wish to obtain the module
1884 * @return A pointer to a deque of Module*, or NULL if the interface
1887 modulelist* FindInterface(const std::string &InterfaceName);
1889 /** Determine if a module has published the named interface.
1890 * This could be used in, for example, OnLoadModule to pick up other modules that can be used.
1891 * @param mod The module to check.
1892 * @param InterfaceName the interface you want to check for
1893 * @return True if the module provides the interface, false otherwise.
1895 bool ModuleHasInterface(Module* mod, const std::string& InterfaceName);
1897 /** Given a pointer to a Module, return its filename
1898 * @param m The module pointer to identify
1899 * @return The module name or an empty string
1901 const std::string& GetModuleName(Module* m);
1903 /** Return a list of all modules matching the given filter
1904 * @param filter This int is a bitmask of flags set in Module::Flags,
1905 * such as VF_VENDOR or VF_STATIC. If you wish to receive a list of
1906 * all modules with no filtering, set this to 0.
1907 * @return The list of module names
1909 const std::vector<std::string> GetAllModuleNames(int filter);
1912 /** This definition is used as shorthand for the various classes
1913 * and functions needed to make a module loadable by the OS.
1914 * It defines the class factory and external init_module function.
1918 #define MODULE_INIT(y) \
1919 extern "C" DllExport Module * init_module(InspIRCd* Me) \
1923 BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
1925 switch ( nReason ) \
1927 case DLL_PROCESS_ATTACH: \
1928 case DLL_PROCESS_DETACH: \
1936 #define MODULE_INIT(y) \
1937 extern "C" DllExport Module * init_module(InspIRCd* Me) \