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.
282 /** Flags and API version
284 const int Flags, API;
286 /** Initialize version class
288 Version(const std::string &sversion, int flags, int api_ver);
291 /** The ModuleMessage class is the base class of Request and Event
292 * This class is used to represent a basic data structure which is passed
293 * between modules for safe inter-module communications.
295 class CoreExport ModuleMessage : public Extensible
300 virtual ~ModuleMessage() {};
303 /** The Request class is a unicast message directed at a given module.
304 * When this class is properly instantiated it may be sent to a module
305 * using the Send() method, which will call the given module's OnRequest
306 * method with this class as its parameter.
308 class CoreExport Request : public ModuleMessage
311 /** This member holds a pointer to arbitary data set by the emitter of the message
314 /** This should be a null-terminated string identifying the type of request,
315 * all modules should define this and use it to determine the nature of the
316 * request before they attempt to cast the Request in any way.
319 /** This is a pointer to the sender of the message, which can be used to
320 * directly trigger events, or to create a reply.
323 /** The single destination of the Request
327 /** Create a new Request
328 * This is for the 'old' way of casting whatever the data is
329 * to char* and hoping you get the right thing at the other end.
330 * This is slowly being depreciated in favor of the 'new' way.
332 Request(char* anydata, Module* src, Module* dst);
333 /** Create a new Request
334 * This is for the 'new' way of defining a subclass
335 * of Request and defining it in a common header,
336 * passing an object of your Request subclass through
337 * as a Request* and using the ID string to determine
338 * what to cast it back to and the other end. This is
339 * much safer as there are no casts not confirmed by
340 * the ID string, and all casts are child->parent and
341 * can be checked at runtime with dynamic_cast<>()
343 Request(Module* src, Module* dst, const char* idstr);
344 /** Fetch the Request data
347 /** Fetch the ID string
350 /** Fetch the request source
353 /** Fetch the request destination (should be 'this' in the receiving module)
356 /** Send the Request.
357 * Upon returning the result will be arbitary data returned by the module you
358 * sent the request to. It is up to your module to know what this data is and
359 * how to deal with it.
365 /** The Event class is a unicast message directed at all modules.
366 * When the class is properly instantiated it may be sent to all modules
367 * using the Send() method, which will trigger the OnEvent method in
368 * all modules passing the object as its parameter.
370 class CoreExport Event : public ModuleMessage
373 /** This member holds a pointer to arbitary data set by the emitter of the message
376 /** This is a pointer to the sender of the message, which can be used to
377 * directly trigger events, or to create a reply.
380 /** The event identifier.
381 * This is arbitary text which should be used to distinguish
382 * one type of event from another.
386 /** Create a new Event
388 Event(char* anydata, Module* src, const std::string &eventid);
389 /** Get the Event data
392 /** Get the event Source
395 /** Get the event ID.
396 * Use this to determine the event type for safe casting of the data
398 std::string GetEventID();
400 * The return result of an Event::Send() will always be NULL as
401 * no replies are expected.
403 char* Send(InspIRCd* ServerInstance);
406 /** Priority types which can be returned from Module::Prioritize()
408 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
410 /** Implementation-specific flags which may be set in Module::Implements()
415 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash,
416 I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois,
417 I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick,
418 I_OnUserMessage, I_OnUserNotice, I_OnMode, I_OnGetServerDescription, I_OnSyncUser,
419 I_OnSyncChannel, I_OnDecodeMetaData, I_OnWallops,
420 I_OnChangeHost, I_OnChangeName, I_OnAddLine, I_OnDelLine, I_OnExpireLine, I_OnCleanup,
421 I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule,
422 I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite,
423 I_OnRawMode, I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckExtBan, I_OnCheckStringExtBan,
424 I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnLocalTopicChange,
425 I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan,
426 I_OnDelBan, I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead,
427 I_OnChangeLocalUserGECOS, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
428 I_OnPostOper, I_OnSyncNetwork, I_OnSetAway, I_OnUserList, I_OnPostCommand, I_OnPostJoin,
429 I_OnWhoisLine, I_OnBuildExemptList, I_OnRawSocketConnect, I_OnGarbageCollect, I_OnBufferFlushed,
430 I_OnText, I_OnPassCompare, I_OnRunTestSuite, I_OnNamesListItem, I_OnNumeric, I_OnHookIO,
431 I_OnHostCycle, I_OnPreRehash, I_OnModuleRehash, I_OnSendWhoLine,
437 /** Base class for all InspIRCd modules
438 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
439 * its methods will be called when irc server events occur. class inherited from module must be
440 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
442 class CoreExport Module : public Extensible
445 /** Creator/owner pointer
447 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 user The user who is joining
514 * @param channel The channel being joined
515 * @param silent Change this to true if you want to conceal the JOIN command from the other users
516 * of the channel (useful for modules such as auditorium)
517 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
518 * to a channel due to the network sync.
519 * @param created This is true if the join created the channel
521 virtual void OnUserJoin(User* user, Channel* channel, bool sync, bool &silent, bool created);
523 /** Called after a user joins a channel
524 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
526 * @param user The user who is joining
527 * @param channel The channel being joined
529 virtual void OnPostJoin(User* user, Channel* channel);
531 /** Called when a user parts a channel.
532 * The details of the leaving user are available to you in the parameter User *user,
533 * and the details of the channel they have left is available in the variable Channel *channel
534 * @param user The user who is parting
535 * @param channel The channel being parted
536 * @param partmessage The part message, or an empty string (may be modified)
537 * @param silent Change this to true if you want to conceal the PART command from the other users
538 * of the channel (useful for modules such as auditorium)
540 virtual void OnUserPart(User* user, Channel* channel, std::string &partmessage, bool &silent);
542 /** Called on rehash.
543 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
544 * system. This is called in all cases -- including when this server will not execute the
545 * rehash because it is directed at a remote server.
547 * @param user The user performing the rehash, if any. If this is server initiated, the value of
548 * this variable will be NULL.
549 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
552 virtual void OnPreRehash(User* user, const std::string ¶meter);
554 /** Called on rehash.
555 * This method is called when a user initiates a module-specific rehash. This can be used to do
556 * expensive operations (such as reloading SSL certificates) that are not executed on a normal
557 * rehash for efficiency. A rehash of this type does not reload the core configuration.
559 * @param user The user performing the rehash.
560 * @param parameter The parameter given to REHASH
562 virtual void OnModuleRehash(User* user, const std::string ¶meter);
564 /** Called on rehash.
565 * This method is called after a rehash has completed. You should use it to reload any module
566 * configuration from the main configuration file.
567 * @param user The user that performed the rehash, if it was initiated by a user and that user
568 * is still connected.
570 virtual void OnRehash(User* user);
572 /** Called whenever a snotice is about to be sent to a snomask.
573 * snomask and type may both be modified; the message may not.
574 * @param snomask The snomask the message is going to (e.g. 'A')
575 * @param type The textual description the snomask will go to (e.g. 'OPER')
576 * @param message The text message to be sent via snotice
577 * @return 1 to block the snotice from being sent entirely, 0 else.
579 virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
581 /** Called whenever a user is about to join a channel, before any processing is done.
582 * Returning a value of 1 from this function stops the process immediately, causing no
583 * output to be sent to the user by the core. If you do this you must produce your own numerics,
584 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
585 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
589 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
590 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
591 * processing on the actual channel record at this point, however the channel NAME will still be passed in
592 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
593 * @param user The user joining the channel
594 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
595 * @param cname The channel name being joined. For new channels this is valid where chan is not.
596 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "@".
597 * You may alter this string to alter the user's modes on the channel.
598 * @param keygiven The key given to join the channel, or an empty string if none was provided
599 * @return 1 To prevent the join, 0 to allow it.
601 virtual ModResult OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string &privs, const std::string &keygiven);
603 /** Called whenever a user is about to be kicked.
604 * Returning a value of 1 from this function stops the process immediately, causing no
605 * output to be sent to the user by the core. If you do this you must produce your own numerics,
607 * @param source The user issuing the kick
608 * @param user The user being kicked
609 * @param chan The channel the user is being kicked from
610 * @param reason The kick reason
611 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
613 virtual ModResult OnUserPreKick(User* source, User* user, Channel* chan, const std::string &reason);
615 /** Called whenever a user is kicked.
616 * If this method is called, the kick is already underway and cannot be prevented, so
617 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
618 * @param source The user issuing the kick
619 * @param user The user being kicked
620 * @param chan The channel the user is being kicked from
621 * @param reason The kick reason
622 * @param silent Change this to true if you want to conceal the PART command from the other users
623 * of the channel (useful for modules such as auditorium)
625 virtual void OnUserKick(User* source, User* user, Channel* chan, const std::string &reason, bool &silent);
627 /** Called whenever a user opers locally.
628 * The User will contain the oper mode 'o' as this function is called after any modifications
629 * are made to the user's structure by the core.
630 * @param user The user who is opering up
631 * @param opertype The opers type name
633 virtual void OnOper(User* user, const std::string &opertype);
635 /** Called after a user opers locally.
636 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
637 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
638 * out the OPERTYPE, etc.
639 * @param user The user who is opering up
640 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
641 * @param opertype The opers type name
643 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
645 /** Called whenever a user types /INFO.
646 * The User will contain the information of the user who typed the command. Modules may use this
647 * method to output their own credits in /INFO (which is the ircd's version of an about box).
648 * It is purposefully not possible to modify any info that has already been output, or halt the list.
649 * You must write a 371 numeric to the user, containing your info in the following format:
651 * <nick> :information here
653 * @param user The user issuing /INFO
655 virtual void OnInfo(User* user);
657 /** Called whenever a /WHOIS is performed on a local user.
658 * The source parameter contains the details of the user who issued the WHOIS command, and
659 * the dest parameter contains the information of the user they are whoising.
660 * @param source The user issuing the WHOIS command
661 * @param dest The user who is being WHOISed
663 virtual void OnWhois(User* source, User* dest);
665 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
666 * Returning 1 from this function stops the process immediately, causing no
667 * output to be sent to the user by the core. If you do this you must produce your own numerics,
668 * notices etc. This is useful for modules which may want to filter invites to channels.
669 * @param source The user who is issuing the INVITE
670 * @param dest The user being invited
671 * @param channel The channel the user is being invited to
672 * @param timeout The time the invite will expire (0 == never)
673 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
675 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
677 /** Called after a user has been successfully invited to a channel.
678 * You cannot prevent the invite from occuring using this function, to do that,
679 * use OnUserPreInvite instead.
680 * @param source The user who is issuing the INVITE
681 * @param dest The user being invited
682 * @param channel The channel the user is being invited to
683 * @param timeout The time the invite will expire (0 == never)
685 virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout);
687 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
688 * Returning any nonzero value from this function stops the process immediately, causing no
689 * output to be sent to the user by the core. If you do this you must produce your own numerics,
690 * notices etc. This is useful for modules which may want to filter or redirect messages.
691 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
692 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
693 * of where the message is destined to be sent.
694 * @param user The user sending the message
695 * @param dest The target of the message (Channel* or User*)
696 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
697 * @param text Changeable text being sent by the user
698 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
699 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
700 * It will be ignored for private messages.
701 * @return 1 to deny the message, 0 to allow it
703 virtual ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
705 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
706 * Returning any nonzero value from this function stops the process immediately, causing no
707 * output to be sent to the user by the core. If you do this you must produce your own numerics,
708 * notices etc. This is useful for modules which may want to filter or redirect messages.
709 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
710 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
711 * of where the message is destined to be sent.
712 * You may alter the message text as you wish before relinquishing control to the next module
713 * in the chain, and if no other modules block the text this altered form of the text will be sent out
714 * to the user and possibly to other servers.
715 * @param user The user sending the message
716 * @param dest The target of the message (Channel* or User*)
717 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
718 * @param text Changeable text being sent by the user
719 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
720 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
721 * It will be ignored for private notices.
722 * @return 1 to deny the NOTICE, 0 to allow it
724 virtual ModResult OnUserPreNotice(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
726 /** Called whenever the server wants to build the exemption list for a channel, but is not directly doing a PRIVMSG or NOTICE.
727 * For example, the spanningtree protocol will call this event when passing a privmsg on (but not processing it directly).
728 * @param message_type The message type, either MSG_PRIVMSG or MSG_NOTICE
729 * @param chan The channel to build the exempt list of
730 * @param sender The original sender of the PRIVMSG or NOTICE
731 * @param status The status char to be used for the channel list
732 * @param exempt_list The exempt list to be populated
733 * @param text The original message text causing the exempt list to be built
735 virtual void OnBuildExemptList(MessageType message_type, Channel* chan, User* sender, char status, CUList &exempt_list, const std::string &text);
737 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
738 * Please note that although you can see remote nickchanges through this function, you should
739 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
740 * check user->server before taking any action (including returning nonzero from the method).
741 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
742 * module to generate some meaninful output.
743 * @param user The username changing their nick
744 * @param newnick Their new nickname
745 * @return 1 to deny the change, 0 to allow
747 virtual ModResult OnUserPreNick(User* user, const std::string &newnick);
749 /** Called after any PRIVMSG sent from a user.
750 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
751 * if target_type is TYPE_CHANNEL.
752 * @param user The user sending the message
753 * @param dest The target of the message
754 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
755 * @param text the text being sent by the user
756 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
758 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
760 /** Called after any NOTICE sent from a user.
761 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
762 * if target_type is TYPE_CHANNEL.
763 * @param user The user sending the message
764 * @param dest The target of the message
765 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
766 * @param text the text being sent by the user
767 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
769 virtual void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
771 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
772 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
773 * if target_type is TYPE_CHANNEL.
774 * The difference between this event and OnUserPreNotice/OnUserPreMessage is that delivery is gauranteed,
775 * the message has already been vetted. In the case of the other two methods, a later module may stop your
776 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
777 * @param user The user sending the message
778 * @param dest The target of the message
779 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
780 * @param text the text being sent by the user
781 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
783 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
785 /** Called after every MODE command sent from a user
786 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
787 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
788 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
789 * @param user The user sending the MODEs
790 * @param dest The target of the modes (User* or Channel*)
791 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
792 * @param text The actual modes and their parameters if any
793 * @param translate The translation types of the mode parameters
795 virtual void OnMode(User* user, void* dest, int target_type, const std::vector<std::string> &text, const std::vector<TranslateType> &translate);
797 /** Allows modules to alter or create server descriptions
798 * Whenever a module requires a server description, for example for display in
799 * WHOIS, this function is called in all modules. You may change or define the
800 * description given in std::string &description. If you do, this description
801 * will be shown in the WHOIS fields.
802 * @param servername The servername being searched for
803 * @param description Alterable server description for this server
805 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
807 /** Allows modules to synchronize data which relates to users during a netburst.
808 * When this function is called, it will be called from the module which implements
809 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
810 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
811 * (see below). This function will be called for every user visible on your side
812 * of the burst, allowing you to for example set modes, etc. Do not use this call to
813 * synchronize data which you have stored using class Extensible -- There is a specialist
814 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
815 * @param user The user being syncronized
816 * @param proto A pointer to the module handling network protocol
817 * @param opaque An opaque pointer set by the protocol module, should not be modified!
819 virtual void OnSyncUser(User* user, Module* proto, void* opaque);
821 /** Allows modules to synchronize data which relates to channels during a netburst.
822 * When this function is called, it will be called from the module which implements
823 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
824 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
825 * (see below). This function will be called for every user visible on your side
826 * of the burst, allowing you to for example set modes, etc.
828 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
830 * @param chan The channel being syncronized
831 * @param proto A pointer to the module handling network protocol
832 * @param opaque An opaque pointer set by the protocol module, should not be modified!
834 virtual void OnSyncChannel(Channel* chan, Module* proto, void* opaque);
836 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
837 * Whenever the linking module wants to send out data, but doesnt know what the data
838 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
839 * this method is called. You should use the ProtoSendMetaData function after you've
840 * correctly decided how the data should be represented, to send the metadata on its way if
841 * if it belongs to your module.
842 * @param proto A pointer to the module handling network protocol
843 * @param opaque An opaque pointer set by the protocol module, should not be modified!
844 * @param displayable If this value is true, the data is going to be displayed to a user,
845 * and not sent across the network. Use this to determine wether or not to show sensitive data.
847 virtual void OnSyncNetwork(Module* proto, void* opaque);
849 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
850 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
851 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
852 * @param target The Channel* or User* that data should be added to
853 * @param extname The extension name which is being sent
854 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
856 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
858 /** Implemented by modules which provide the ability to link servers.
859 * These modules will implement this method, which allows transparent sending of servermodes
860 * down the network link as a broadcast, without a module calling it having to know the format
861 * of the MODE command before the actual mode string.
863 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
864 * of how to use this function.
866 * @param opaque An opaque pointer set by the protocol module, should not be modified!
867 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
868 * @param target The Channel* or User* that modes should be sent for
869 * @param modeline The modes and parameters to be sent
870 * @param translate The translation types of the mode parameters
872 virtual void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::vector<std::string> &modeline, const std::vector<TranslateType> &translate);
874 /** Implemented by modules which provide the ability to link servers.
875 * These modules will implement this method, which allows metadata (extra data added to
876 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
877 * to other servers on a netburst and decoded at the other end by the same module on a
880 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
881 * how to use this function.
882 * @param opaque An opaque pointer set by the protocol module, should not be modified!
883 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
884 * @param target The Channel* or User* that metadata should be sent for
885 * @param extname The extension name to send metadata for
886 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
888 virtual void ProtoSendMetaData(void* opaque, Extensible* target, const std::string &extname, const std::string &extdata);
891 * Implemented by all modules that implement ProtoSendMetaData.
892 * Translates the item into a string format suitable for sending to other servers.
893 * Currently, this just translates nicks to their UID and channels to their name
895 virtual std::string ProtoTranslate(Extensible* item);
897 /** Called after every WALLOPS command.
898 * @param user The user sending the WALLOPS
899 * @param text The content of the WALLOPS message
901 virtual void OnWallops(User* user, const std::string &text);
903 /** Called whenever a user's hostname is changed.
904 * This event triggers after the host has been set.
905 * @param user The user whos host is being changed
906 * @param newhost The new hostname being set
908 virtual void OnChangeHost(User* user, const std::string &newhost);
910 /** Called whenever a user's GECOS (realname) is changed.
911 * This event triggers after the name has been set.
912 * @param user The user who's GECOS is being changed
913 * @param gecos The new GECOS being set on the user
915 virtual void OnChangeName(User* user, const std::string &gecos);
917 /** Called whenever an xline is added by a local user.
918 * This method is triggered after the line is added.
919 * @param source The sender of the line or NULL for local server
920 * @param line The xline being added
922 virtual void OnAddLine(User* source, XLine* line);
924 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
925 * This method is triggered after the line is deleted.
926 * @param source The user removing the line or NULL for local server
927 * @param line the line being deleted
929 virtual void OnDelLine(User* source, XLine* line);
931 /** Called whenever an xline expires.
932 * This method is triggered after the line is deleted.
933 * @param line The line being deleted.
935 virtual void OnExpireLine(XLine *line);
937 /** Called before your module is unloaded to clean up Extensibles.
938 * This method is called once for every user and channel on the network,
939 * so that when your module unloads it may clear up any remaining data
940 * in the form of Extensibles added using Extensible::Extend().
941 * If the target_type variable is TYPE_USER, then void* item refers to
942 * a User*, otherwise it refers to a Channel*.
943 * @param target_type The type of item being cleaned
944 * @param item A pointer to the item's class
946 virtual void OnCleanup(int target_type, void* item);
948 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
949 * have been applied. Please note that although you can see remote nickchanges through this function, you should
950 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
951 * check user->server before taking any action (including returning nonzero from the method).
952 * Because this method is called after the nickchange is taken place, no return values are possible
953 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
954 * @param user The user changing their nick
955 * @param oldnick The old nickname of the user before the nickchange
957 virtual void OnUserPostNick(User* user, const std::string &oldnick);
959 /** Called before an action which requires a channel privilage check.
960 * This function is called before many functions which check a users status on a channel, for example
961 * before opping a user, deopping a user, kicking a user, etc.
962 * There are several values for access_type which indicate for what reason access is being checked.
964 * AC_KICK - A user is being kicked<br>
965 * AC_DEOP - a user is being deopped<br>
966 * AC_OP - a user is being opped<br>
967 * AC_VOICE - a user is being voiced<br>
968 * AC_DEVOICE - a user is being devoiced<br>
969 * AC_HALFOP - a user is being halfopped<br>
970 * AC_DEHALFOP - a user is being dehalfopped<br>
971 * AC_INVITE - a user is being invited<br>
972 * AC_GENERAL_MODE - a user channel mode is being changed<br><br>
973 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
974 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
975 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
976 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
977 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
978 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
979 * @param source The source of the access check
980 * @param dest The destination of the access check
981 * @param channel The channel which is being checked
982 * @param access_type See above
984 virtual ModResult OnAccessCheck(User* source,User* dest,Channel* channel,int access_type);
986 /** Called when a 005 numeric is about to be output.
987 * The module should modify the 005 numeric if needed to indicate its features.
988 * @param output The 005 string to be modified if neccessary.
990 virtual void On005Numeric(std::string &output);
992 /** Called when a client is disconnected by KILL.
993 * If a client is killed by a server, e.g. a nickname collision or protocol error,
995 * Return 1 from this function to prevent the kill, and 0 from this function to allow
996 * it as normal. If you prevent the kill no output will be sent to the client, it is
997 * down to your module to generate this information.
998 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
999 * If you do so youre risking race conditions, desyncs and worse!
1000 * @param source The user sending the KILL
1001 * @param dest The user being killed
1002 * @param reason The kill reason
1003 * @return 1 to prevent the kill, 0 to allow
1005 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
1007 /** Called when an oper wants to disconnect a remote user via KILL
1008 * @param source The user sending the KILL
1009 * @param dest The user being killed
1010 * @param reason The kill reason
1012 virtual void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
1014 /** Called whenever a module is loaded.
1015 * mod will contain a pointer to the module, and string will contain its name,
1016 * for example m_widgets.so. This function is primary for dependency checking,
1017 * your module may decide to enable some extra features if it sees that you have
1018 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
1019 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
1020 * but instead operate under reduced functionality, unless the dependency is
1021 * absolutely neccessary (e.g. a module that extends the features of another
1023 * @param mod A pointer to the new module
1024 * @param name The new module's filename
1026 virtual void OnLoadModule(Module* mod,const std::string &name);
1028 /** Called whenever a module is unloaded.
1029 * mod will contain a pointer to the module, and string will contain its name,
1030 * for example m_widgets.so. This function is primary for dependency checking,
1031 * your module may decide to enable some extra features if it sees that you have
1032 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
1033 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
1034 * but instead operate under reduced functionality, unless the dependency is
1035 * absolutely neccessary (e.g. a module that extends the features of another
1037 * @param mod Pointer to the module being unloaded (still valid)
1038 * @param name The filename of the module being unloaded
1040 virtual void OnUnloadModule(Module* mod,const std::string &name);
1042 /** Called once every five seconds for background processing.
1043 * This timer can be used to control timed features. Its period is not accurate
1044 * enough to be used as a clock, but it is gauranteed to be called at least once in
1045 * any five second period, directly from the main loop of the server.
1046 * @param curtime The current timer derived from time(2)
1048 virtual void OnBackgroundTimer(time_t curtime);
1050 /** Called whenever any command is about to be executed.
1051 * This event occurs for all registered commands, wether they are registered in the core,
1052 * or another module, and for invalid commands. Invalid commands may only be sent to this
1053 * function when the value of validated is false. By returning 1 from this method you may prevent the
1054 * command being executed. If you do this, no output is created by the core, and it is
1055 * down to your module to produce any output neccessary.
1056 * Note that unless you return 1, you should not destroy any structures (e.g. by using
1057 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
1058 * method returns, it will be passed an invalid pointer to the user object and crash!)
1059 * @param command The command being executed
1060 * @param parameters An array of array of characters containing the parameters for the command
1061 * @param pcnt The nuimber of parameters passed to the command
1062 * @param user the user issuing the command
1063 * @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.
1064 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
1065 * @param original_line The entire original line as passed to the parser from the user
1066 * @return 1 to block the command, 0 to allow
1068 virtual ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, User *user, bool validated, const std::string &original_line);
1070 /** Called after any command has been executed.
1071 * This event occurs for all registered commands, wether they are registered in the core,
1072 * or another module, but it will not occur for invalid commands (e.g. ones which do not
1073 * exist within the command table). The result code returned by the command handler is
1075 * @param command The command being executed
1076 * @param parameters An array of array of characters containing the parameters for the command
1077 * @param pcnt The nuimber of parameters passed to the command
1078 * @param user the user issuing the command
1079 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
1080 * @param original_line The entire original line as passed to the parser from the user
1082 virtual void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, User *user, CmdResult result, const std::string &original_line);
1084 /** Called to check if a user who is connecting can now be allowed to register
1085 * If any modules return false for this function, the user is held in the waiting
1086 * state until all modules return true. For example a module which implements ident
1087 * lookups will continue to return false for a user until their ident lookup is completed.
1088 * Note that the registration timeout for a user overrides these checks, if the registration
1089 * timeout is reached, the user is disconnected even if modules report that the user is
1090 * not ready to connect.
1091 * @param user The user to check
1092 * @return true to indicate readiness, false if otherwise
1094 virtual ModResult OnCheckReady(User* user);
1096 /** Called whenever a user is about to register their connection (e.g. before the user
1097 * is sent the MOTD etc). Modules can use this method if they are performing a function
1098 * which must be done before the actual connection is completed (e.g. ident lookups,
1099 * dnsbl lookups, etc).
1100 * Note that you should NOT delete the user record here by causing a disconnection!
1101 * Use OnUserConnect for that instead.
1102 * @param user The user registering
1103 * @return 1 to indicate user quit, 0 to continue
1105 virtual ModResult OnUserRegister(User* user);
1107 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1108 * This method will always be called for each join, wether or not the channel is actually +i, and
1109 * determines the outcome of an if statement around the whole section of invite checking code.
1110 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1111 * @param user The user joining the channel
1112 * @param chan The channel being joined
1113 * @return 1 to explicitly allow the join, 0 to proceed as normal
1115 virtual ModResult OnCheckInvite(User* user, Channel* chan);
1117 /** Called whenever a mode character is processed.
1118 * Return 1 from this function to block the mode character from being processed entirely.
1119 * @param user The user who is sending the mode
1120 * @param chan The channel the mode is being sent to (or NULL if a usermode)
1121 * @param mode The mode character being set
1122 * @param param The parameter for the mode or an empty string
1123 * @param adding true of the mode is being added, false if it is being removed
1124 * @param pcnt The parameter count for the mode (0 or 1)
1125 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
1126 * to skip all permission checking. Please note that for remote mode changes, your return value
1129 virtual ModResult OnRawMode(User* user, Channel* chan, const char mode, const std::string ¶m, bool adding, int pcnt);
1131 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1132 * This method will always be called for each join, wether or not the channel is actually +k, and
1133 * determines the outcome of an if statement around the whole section of key checking code.
1134 * if the user specified no key, the keygiven string will be a valid but empty value.
1135 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1136 * @param user The user joining the channel
1137 * @param chan The channel being joined
1138 * @return 1 to explicitly allow the join, 0 to proceed as normal
1140 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
1142 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1143 * This method will always be called for each join, wether or not the channel is actually +l, and
1144 * determines the outcome of an if statement around the whole section of channel limit checking code.
1145 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1146 * @param user The user joining the channel
1147 * @param chan The channel being joined
1148 * @return 1 to explicitly allow the join, 0 to proceed as normal
1150 virtual ModResult OnCheckLimit(User* user, Channel* chan);
1152 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
1153 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
1154 * determines the outcome of an if statement around the whole section of ban checking code.
1155 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1156 * @param user The user joining the channel
1157 * @param chan The channel being joined
1158 * @return 1 to explicitly allow the join, 0 to proceed as normal. Return -1 to explicitly deny the
1159 * join to the channel.
1161 virtual ModResult OnCheckBan(User* user, Channel* chan);
1163 /* Called whenever checking whether or not a user is matched by an applicable extended bantype.
1164 * NOTE: may also trigger extra OnCheckStringExtBan events!
1165 * @param u The user to check
1166 * @param c The channel the user is on
1167 * @param type The type of extended ban to check for.
1168 * @returns 1 = exempt, 0 = no match, -1 = banned
1170 virtual ModResult OnCheckExtBan(User *u, Channel *c, char type);
1172 /** Called whenever checking whether or not a string is extbanned. NOTE: one OnCheckExtBan will also trigger a number of
1173 * OnCheckStringExtBan events for seperate host/IP comnbinations.
1174 * @returns 1 = exempt, 0 = no match, -1 = banned
1176 virtual ModResult OnCheckStringExtBan(const std::string &s, Channel *c, char type);
1178 /** Called on all /STATS commands
1179 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1180 * @param symbol the symbol provided to /STATS
1181 * @param user the user issuing the /STATS command
1182 * @param results A string_list to append results into. You should put all your results
1183 * into this string_list, rather than displaying them directly, so that your handler will
1184 * work when remote STATS queries are received.
1185 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1187 virtual ModResult OnStats(char symbol, User* user, string_list &results);
1189 /** Called whenever a change of a local users displayed host is attempted.
1190 * Return 1 to deny the host change, or 0 to allow it.
1191 * @param user The user whos host will be changed
1192 * @param newhost The new hostname
1193 * @return 1 to deny the host change, 0 to allow
1195 virtual ModResult OnChangeLocalUserHost(User* user, const std::string &newhost);
1197 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1198 * return 1 to deny the name change, or 0 to allow it.
1199 * @param user The user whos GECOS will be changed
1200 * @param newhost The new GECOS
1201 * @return 1 to deny the GECOS change, 0 to allow
1203 virtual ModResult OnChangeLocalUserGECOS(User* user, const std::string &newhost);
1205 /** Called whenever a topic is changed by a local user.
1206 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
1207 * @param user The user changing the topic
1208 * @param chan The channels who's topic is being changed
1209 * @param topic The actual topic text
1210 * @param 1 to block the topic change, 0 to allow
1212 virtual ModResult OnLocalTopicChange(User* user, Channel* chan, const std::string &topic);
1214 /** Called whenever a local topic has been changed.
1215 * To block topic changes you must use OnLocalTopicChange instead.
1216 * @param user The user changing the topic
1217 * @param chan The channels who's topic is being changed
1218 * @param topic The actual topic text
1220 virtual void OnPostLocalTopicChange(User* user, Channel* chan, const std::string &topic);
1222 /** Called whenever an Event class is sent to all module by another module.
1223 * Please see the documentation of Event::Send() for further information. The Event sent can
1224 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1225 * before doing anything to the event data, and you should *not* change the event data in any way!
1226 * @param event The Event class being received
1228 virtual void OnEvent(Event* event);
1230 /** Called whenever a Request class is sent to your module by another module.
1231 * Please see the documentation of Request::Send() for further information. The Request sent
1232 * can always be assumed to be non-NULL, you should not change the request object or its data.
1233 * Your method may return arbitary data in the char* result which the requesting module
1234 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1235 * @param request The Request class being received
1237 virtual const char* OnRequest(Request* request);
1239 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
1240 * The password field (from the config file) is in 'password' and is to be compared against
1241 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
1242 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
1243 * @param ex The object that's causing the authentication (User* for <oper> <connect:allow> etc, Server* for <link>).
1244 * @param password The password from the configuration file (the password="" value).
1245 * @param input The password entered by the user or whoever.
1246 * @param hashtype The hash value from the config
1247 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
1249 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
1251 /** Called whenever a user is given usermode +o, anywhere on the network.
1252 * You cannot override this and prevent it from happening as it is already happened and
1253 * such a task must be performed by another server. You can however bounce modes by sending
1254 * servermodes out to reverse mode changes.
1255 * @param user The user who is opering
1257 virtual void OnGlobalOper(User* user);
1259 /** Called after a user has fully connected and all modules have executed OnUserConnect
1260 * This event is informational only. You should not change any user information in this
1261 * event. To do so, use the OnUserConnect method to change the state of local users.
1262 * This is called for both local and remote users.
1263 * @param user The user who is connecting
1265 virtual void OnPostConnect(User* user);
1267 /** Called whenever a ban is added to a channel's list.
1268 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1269 * @param source The user adding the ban
1270 * @param channel The channel the ban is being added to
1271 * @param banmask The ban mask being added
1272 * @return 1 to block the ban, 0 to continue as normal
1274 virtual ModResult OnAddBan(User* source, Channel* channel,const std::string &banmask);
1276 /** Called whenever a ban is removed from a channel's list.
1277 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1278 * @param source The user deleting the ban
1279 * @param channel The channel the ban is being deleted from
1280 * @param banmask The ban mask being deleted
1281 * @return 1 to block the unban, 0 to continue as normal
1283 virtual ModResult OnDelBan(User* source, Channel* channel,const std::string &banmask);
1285 /** Called to install an I/O hook on an event handler
1286 * @param user The item to possibly install the I/O hook on
1287 * @param via The port that <user> connected on
1289 virtual void OnHookIO(EventHandler* user, ListenSocketBase* via);
1291 /** Called immediately after any connection is accepted. This is intended for raw socket
1292 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1293 * no information relating to a user record as the connection has not been assigned yet.
1294 * There are no return values from this call as all modules get an opportunity if required to
1295 * process the connection.
1296 * @param fd The file descriptor returned from accept()
1297 * @param client The client IP address and port
1298 * @param server The server IP address and port
1299 * @param localport The local port number the user connected to
1301 virtual void OnRawSocketAccept(int fd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
1303 /** Called immediately before any write() operation on a user's socket in the core. Because
1304 * this event is a low level event no user information is associated with it. It is intended
1305 * for use by modules which may wrap connections within another API such as SSL for example.
1306 * return a non-zero result if you have handled the write operation, in which case the core
1307 * will not call write().
1308 * @param fd The file descriptor of the socket
1309 * @param buffer A char* buffer being written
1310 * @param Number of characters to write
1311 * @return Number of characters actually written or 0 if you didn't handle the operation
1313 virtual int OnRawSocketWrite(int fd, const char* buffer, int count);
1315 /** Called immediately before any socket is closed. When this event is called, shutdown()
1316 * has not yet been called on the socket.
1317 * @param fd The file descriptor of the socket prior to close()
1319 virtual void OnRawSocketClose(int fd);
1321 /** Called immediately upon connection of an outbound BufferedSocket which has been hooked
1323 * @param fd The file descriptor of the socket immediately after connect()
1325 virtual void OnRawSocketConnect(int fd);
1327 /** Called immediately before any read() operation on a client socket in the core.
1328 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1329 * when this event occurs.
1330 * Your event should return 1 if it has handled the reading itself, which prevents the core
1331 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1332 * the value of count. The value of readresult must be identical to an actual result that might
1333 * be returned from the read() system call, for example, number of bytes read upon success,
1334 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1335 * you MUST set readresult.
1336 * @param fd The file descriptor of the socket
1337 * @param buffer A char* buffer being read to
1338 * @param count The size of the buffer
1339 * @param readresult The amount of characters read, or 0
1340 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1342 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1344 /** Called whenever a user sets away or returns from being away.
1345 * The away message is available as a parameter, but should not be modified.
1346 * At this stage, it has already been copied into the user record.
1347 * If awaymsg is empty, the user is returning from away.
1348 * @param user The user setting away
1349 * @param awaymsg The away message of the user, or empty if returning from away
1350 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
1352 virtual ModResult OnSetAway(User* user, const std::string &awaymsg);
1354 /** Called whenever a NAMES list is requested.
1355 * You can produce the nameslist yourself, overriding the current list,
1356 * and if you do you must return 1. If you do not handle the names list,
1358 * @param The user requesting the NAMES list
1359 * @param Ptr The channel the NAMES list is requested for
1360 * @param userlist The user list for the channel (you may change this pointer.
1361 * If you want to change the values, take a copy first, and change the copy, then
1362 * point the pointer at your copy)
1363 * @return 1 to prevent the user list being sent to the client, 0 to allow it.
1364 * Returning -1 allows the names list, but bypasses any checks which check for
1365 * channel membership before sending the names list.
1367 virtual ModResult OnUserList(User* user, Channel* Ptr, CUList* &userlist);
1369 /** Called whenever a line of WHOIS output is sent to a user.
1370 * You may change the numeric and the text of the output by changing
1371 * the values numeric and text, but you cannot change the user the
1372 * numeric is sent to. You may however change the user's User values.
1373 * @param user The user the numeric is being sent to
1374 * @param dest The user being WHOISed
1375 * @param numeric The numeric of the line being sent
1376 * @param text The text of the numeric, including any parameters
1377 * @return nonzero to drop the line completely so that the user does not
1378 * receive it, or zero to allow the line to be sent.
1380 virtual ModResult OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
1382 /** Called at intervals for modules to garbage-collect any hashes etc.
1383 * Certain data types such as hash_map 'leak' buckets, which must be
1384 * tidied up and freed by copying into a new item every so often. This
1385 * method is called when it is time to do that.
1387 virtual void OnGarbageCollect();
1389 /** Called whenever a user's write buffer has been completely sent.
1390 * This is called when the user's write buffer is completely empty, and
1391 * there are no more pending bytes to be written and no pending write events
1392 * in the socket engine's queue. This may be used to refill the buffer with
1393 * data which is being spooled in a controlled manner, e.g. LIST lines.
1394 * @param user The user who's buffer is now empty.
1396 virtual void OnBufferFlushed(User* user);
1398 /** Add test suite hooks here. These are used for testing functionality of a module
1399 * via the --testsuite debugging parameter.
1401 virtual void OnRunTestSuite();
1403 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
1404 * For example NAMESX, channel mode +u and +I, and UHNAMES. If the nick is set to an empty string by any
1405 * module, then this will cause the nickname not to be displayed at all.
1407 virtual void OnNamesListItem(User* issuer, User* user, Channel* channel, std::string &prefixes, std::string &nick);
1409 virtual ModResult OnNumeric(User* user, unsigned int numeric, const std::string &text);
1411 /** Called for every time the user's host or ident changes, to indicate wether or not the 'Changing host'
1412 * message should be sent, if enabled. Certain modules such as auditorium may opt to hide this message
1413 * even if it is enabled.
1415 virtual ModResult OnHostCycle(User* user);
1417 /** Called whenever a result from /WHO is about to be returned
1418 * @param source The user running the /WHO query
1419 * @param user The user that this line of the query is about
1420 * @param channel The channel being queried (or NULL if not a channel query)
1421 * @param line The raw line to send; modifiable, if empty no line will be returned.
1423 virtual void OnSendWhoLine(User* source, User* user, Channel* channel, std::string& line);
1427 #define CONF_NO_ERROR 0x000000
1428 #define CONF_NOT_A_NUMBER 0x000010
1429 #define CONF_INT_NEGATIVE 0x000080
1430 #define CONF_VALUE_NOT_FOUND 0x000100
1431 #define CONF_FILE_NOT_FOUND 0x000200
1434 /** Allows reading of values from configuration files
1435 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1436 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1437 * Constructing the class using one parameter allows you to specify a path to your own configuration
1438 * file, otherwise, inspircd.conf is read.
1440 class CoreExport ConfigReader : public classbase
1443 InspIRCd* ServerInstance;
1449 /** Default constructor.
1450 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1451 * as specified when running ./configure.
1453 ConfigReader(InspIRCd* Instance);
1454 /** Default destructor.
1455 * This method destroys the ConfigReader class.
1459 /** Retrieves a value from the config file.
1460 * This method retrieves a value from the config file. Where multiple copies of the tag
1461 * exist in the config file, index indicates which of the values to retrieve.
1463 std::string ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds = false);
1464 /** Retrieves a value from the config file.
1465 * This method retrieves a value from the config file. Where multiple copies of the tag
1466 * exist in the config file, index indicates which of the values to retrieve. If the
1467 * tag is not found the default value is returned instead.
1469 std::string ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds = false);
1471 /** Retrieves a boolean value from the config file.
1472 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1473 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1474 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1476 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1477 /** Retrieves a boolean value from the config file.
1478 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1479 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1480 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1481 * If the tag is not found, the default value is used instead.
1483 bool ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index);
1485 /** Retrieves an integer value from the config file.
1486 * This method retrieves an integer 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. Any invalid integer
1488 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1489 * return CONF_INVALID_NUMBER to be returned. need_positive is set if the number must be non-negative.
1490 * If a negative number is placed into a tag which is specified positive, 0 will be returned and GetError()
1491 * will return CONF_INT_NEGATIVE. Note that need_positive is not suitable to get an unsigned int - you
1492 * should cast the result to achieve that effect.
1494 int ReadInteger(const std::string &tag, const std::string &name, int index, bool need_positive);
1495 /** Retrieves an integer value from the config file.
1496 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1497 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1498 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1499 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1500 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1501 * will return CONF_NOT_UNSIGNED. If the tag is not found, the default value is used instead.
1503 int ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool need_positive);
1505 /** Returns the last error to occur.
1506 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1507 * A call to GetError() resets the error flag back to 0.
1510 /** Counts the number of times a given tag appears in the config file.
1511 * This method counts the number of times a tag appears in a config file, for use where
1512 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1513 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1514 * multiple instance tag.
1516 int Enumerate(const std::string &tag);
1518 /** Returns the number of items within a tag.
1519 * For example if the tag was <test tag="blah" data="foo"> then this
1520 * function would return 2. Spaces and newlines both qualify as valid seperators
1523 int EnumerateValues(const std::string &tag, int index);
1528 /** Caches a text file into memory and can be used to retrieve lines from it.
1529 * This class contains methods for read-only manipulation of a text file in memory.
1530 * Either use the constructor type with one parameter to load a file into memory
1531 * at construction, or use the LoadFile method to load a file.
1533 class CoreExport FileReader : public classbase
1535 InspIRCd* ServerInstance;
1536 /** The file contents
1540 /** Content size in bytes
1542 unsigned long contentsize;
1544 /** Calculate content size in bytes
1549 /** Default constructor.
1550 * This method does not load any file into memory, you must use the LoadFile method
1551 * after constructing the class this way.
1553 FileReader(InspIRCd* Instance);
1555 /** Secondary constructor.
1556 * This method initialises the class with a file loaded into it ready for GetLine and
1557 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1560 FileReader(InspIRCd* Instance, const std::string &filename);
1562 /** Default destructor.
1563 * This deletes the memory allocated to the file.
1567 /** Used to load a file.
1568 * This method loads a file into the class ready for GetLine and
1569 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1572 void LoadFile(const std::string &filename);
1574 /** Returns the whole content of the file as std::string
1576 std::string Contents();
1578 /** Returns the entire size of the file as std::string
1580 unsigned long ContentSize();
1582 /** Returns true if the file exists
1583 * This function will return false if the file could not be opened.
1587 /** Retrieve one line from the file.
1588 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1589 * the index was out of bounds, or the line had no data on it.
1591 std::string GetLine(int x);
1593 /** Returns the size of the file in lines.
1594 * This method returns the number of lines in the read file. If it is 0, no lines have been
1595 * read into memory, either because the file is empty or it does not exist, or cannot be
1596 * opened due to permission problems.
1601 /** A DLLFactory (designed to load shared objects) containing a
1602 * handle to a module's init_module() function. Unfortunately,
1603 * due to the design of shared object systems we must keep this
1604 * hanging around, as if we remove this handle, we remove the
1605 * shared object file from memory (!)
1607 typedef DLLFactory<Module> ircd_module;
1609 /** A list of modules
1611 typedef std::vector<Module*> IntModuleList;
1613 /** An event handler iterator
1615 typedef IntModuleList::iterator EventHandlerIter;
1617 /** ModuleManager takes care of all things module-related
1620 class CoreExport ModuleManager : public classbase
1623 /** Holds a string describing the last module error to occur
1625 std::string LastModuleError;
1627 /** The feature names published by various modules
1629 featurelist Features;
1631 /** The interface names published by various modules
1633 interfacelist Interfaces;
1635 /** Total number of modules loaded into the ircd
1639 /** Our pointer to the main insp instance
1643 /** List of loaded modules and shared object/dll handles
1644 * keyed by module name
1646 std::map<std::string, std::pair<ircd_module*, Module*> > Modules;
1652 } prioritizationState;
1655 /** Event handler hooks.
1656 * This needs to be public to be used by FOREACH_MOD and friends.
1658 IntModuleList EventHandlers[I_END];
1660 /** Simple, bog-standard, boring constructor.
1662 ModuleManager(InspIRCd* Ins);
1668 /** Change the priority of one event in a module.
1669 * Each module event has a list of modules which are attached to that event type.
1670 * If you wish to be called before or after other specific modules, you may use this
1671 * method (usually within void Module::Prioritize()) to set your events priority.
1672 * You may use this call in other methods too, however, this is not supported behaviour
1674 * @param mod The module to change the priority of
1675 * @param i The event to change the priority of
1676 * @param s The state you wish to use for this event. Use one of
1677 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1678 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1679 * to set it to be before or after one or more other modules.
1680 * @param modules If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1681 * then this contains a list of one or more modules your module must be
1682 * placed before or after. Your module will be placed before the highest
1683 * priority module in this list for PRIO_BEFORE, or after the lowest
1684 * priority module in this list for PRIORITY_AFTER.
1685 * @param sz The number of modules being passed for PRIO_BEFORE and PRIORITY_AFTER.
1686 * Defaults to 1, as most of the time you will only want to prioritize your module
1687 * to be before or after one other module.
1689 bool SetPriority(Module* mod, Implementation i, Priority s, Module** modules = NULL, size_t sz = 1);
1691 /** Change the priority of all events in a module.
1692 * @param mod The module to set the priority of
1693 * @param s The priority of all events in the module.
1694 * Note that with this method, it is not possible to effectively use
1695 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1696 * SetPriority method for this, where you may specify other modules to
1697 * be prioritized against.
1699 bool SetPriority(Module* mod, Priority s);
1701 /** Attach an event to a module.
1702 * You may later detatch the event with ModuleManager::Detach().
1703 * If your module is unloaded, all events are automatically detatched.
1704 * @param i Event type to attach
1705 * @param mod Module to attach event to
1706 * @return True if the event was attached
1708 bool Attach(Implementation i, Module* mod);
1710 /** Detatch an event from a module.
1711 * This is not required when your module unloads, as the core will
1712 * automatically detatch your module from all events it is attached to.
1713 * @param i Event type to detach
1714 * @param mod Module to detach event from
1715 * @param Detach true if the event was detached
1717 bool Detach(Implementation i, Module* mod);
1719 /** Attach an array of events to a module
1720 * @param i Event types (array) to attach
1721 * @param mod Module to attach events to
1723 void Attach(Implementation* i, Module* mod, size_t sz);
1725 /** Detach all events from a module (used on unload)
1726 * @param mod Module to detach from
1728 void DetachAll(Module* mod);
1730 /** Returns text describing the last module error
1731 * @return The last error message to occur
1733 std::string& LastError();
1735 /** Load a given module file
1736 * @param filename The file to load
1737 * @return True if the module was found and loaded
1739 bool Load(const char* filename);
1741 /** Unload a given module file
1742 * @param filename The file to unload
1743 * @return True if the module was unloaded
1745 bool Unload(const char* filename);
1747 /** Called by the InspIRCd constructor to load all modules from the config file.
1751 /** Get the total number of currently loaded modules
1752 * @return The number of loaded modules
1756 return this->ModCount;
1759 /** Find a module by name, and return a Module* to it.
1760 * This is preferred over iterating the module lists yourself.
1761 * @param name The module name to look up
1762 * @return A pointer to the module, or NULL if the module cannot be found
1764 Module* Find(const std::string &name);
1766 /** Publish a 'feature'.
1767 * There are two ways for a module to find another module it depends on.
1768 * Either by name, using InspIRCd::FindModule, or by feature, using this
1769 * function. A feature is an arbitary string which identifies something this
1770 * module can do. For example, if your module provides SSL support, but other
1771 * modules provide SSL support too, all the modules supporting SSL should
1772 * publish an identical 'SSL' feature. This way, any module requiring use
1773 * of SSL functions can just look up the 'SSL' feature using FindFeature,
1774 * then use the module pointer they are given.
1775 * @param FeatureName The case sensitive feature name to make available
1776 * @param Mod a pointer to your module class
1777 * @returns True on success, false if the feature is already published by
1780 bool PublishFeature(const std::string &FeatureName, Module* Mod);
1782 /** Publish a module to an 'interface'.
1783 * Modules which implement the same interface (the same way of communicating
1784 * with other modules) can publish themselves to an interface, using this
1785 * method. When they do so, they become part of a list of related or
1786 * compatible modules, and a third module may then query for that list
1787 * and know that all modules within that list offer the same API.
1788 * A prime example of this is the hashing modules, which all accept the
1789 * same types of Request class. Consider this to be similar to PublishFeature,
1790 * except for that multiple modules may publish the same 'feature'.
1791 * @param InterfaceName The case sensitive interface name to make available
1792 * @param Mod a pointer to your module class
1793 * @returns True on success, false on failure (there are currently no failure
1796 bool PublishInterface(const std::string &InterfaceName, Module* Mod);
1798 /** Return a pair saying how many other modules are currently using the
1799 * interfaces provided by module m.
1800 * @param m The module to count usage for
1801 * @return A pair, where the first value is the number of uses of the interface,
1802 * and the second value is the interface name being used.
1804 std::pair<int,std::string> GetInterfaceInstanceCount(Module* m);
1806 /** Mark your module as using an interface.
1807 * If you mark your module as using an interface, then that interface
1808 * module may not unload until your module has unloaded first.
1809 * This can be used to prevent crashes by ensuring code you depend on
1810 * is always in memory while your module is active.
1811 * @param InterfaceName The interface to use
1813 void UseInterface(const std::string &InterfaceName);
1815 /** Mark your module as finished with an interface.
1816 * If you used UseInterface() above, you should use this method when
1817 * your module is finished with the interface (usually in its destructor)
1818 * to allow the modules which implement the given interface to be unloaded.
1819 * @param InterfaceName The interface you are finished with using.
1821 void DoneWithInterface(const std::string &InterfaceName);
1823 /** Unpublish a 'feature'.
1824 * When your module exits, it must call this method for every feature it
1825 * is providing so that the feature table is cleaned up.
1826 * @param FeatureName the feature to remove
1828 bool UnpublishFeature(const std::string &FeatureName);
1830 /** Unpublish your module from an interface
1831 * When your module exits, it must call this method for every interface
1832 * it is part of so that the interfaces table is cleaned up. Only when
1833 * the last item is deleted from an interface does the interface get
1835 * @param InterfaceName the interface to be removed from
1836 * @param Mod The module to remove from the interface list
1838 bool UnpublishInterface(const std::string &InterfaceName, Module* Mod);
1840 /** Find a 'feature'.
1841 * There are two ways for a module to find another module it depends on.
1842 * Either by name, using InspIRCd::FindModule, or by feature, using the
1843 * InspIRCd::PublishFeature method. A feature is an arbitary string which
1844 * identifies something this module can do. For example, if your module
1845 * provides SSL support, but other modules provide SSL support too, all
1846 * the modules supporting SSL should publish an identical 'SSL' feature.
1847 * To find a module capable of providing the feature you want, simply
1848 * call this method with the feature name you are looking for.
1849 * @param FeatureName The feature name you wish to obtain the module for
1850 * @returns A pointer to a valid module class on success, NULL on failure.
1852 Module* FindFeature(const std::string &FeatureName);
1854 /** Find an 'interface'.
1855 * An interface is a list of modules which all implement the same API.
1856 * @param InterfaceName The Interface you wish to obtain the module
1858 * @return A pointer to a deque of Module*, or NULL if the interface
1861 modulelist* FindInterface(const std::string &InterfaceName);
1863 /** Determine if a module has published the named interface.
1864 * This could be used in, for example, OnLoadModule to pick up other modules that can be used.
1865 * @param mod The module to check.
1866 * @param InterfaceName the interface you want to check for
1867 * @return True if the module provides the interface, false otherwise.
1869 bool ModuleHasInterface(Module* mod, const std::string& InterfaceName);
1871 /** Given a pointer to a Module, return its filename
1872 * @param m The module pointer to identify
1873 * @return The module name or an empty string
1875 const std::string& GetModuleName(Module* m);
1877 /** Return a list of all modules matching the given filter
1878 * @param filter This int is a bitmask of flags set in Module::Flags,
1879 * such as VF_VENDOR or VF_STATIC. If you wish to receive a list of
1880 * all modules with no filtering, set this to 0.
1881 * @return The list of module names
1883 const std::vector<std::string> GetAllModuleNames(int filter);
1886 /** This definition is used as shorthand for the various classes
1887 * and functions needed to make a module loadable by the OS.
1888 * It defines the class factory and external init_module function.
1892 #define MODULE_INIT(y) \
1893 extern "C" DllExport Module * init_module(InspIRCd* Me) \
1897 BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
1899 switch ( nReason ) \
1901 case DLL_PROCESS_ATTACH: \
1902 case DLL_PROCESS_DETACH: \
1910 #define MODULE_INIT(y) \
1911 extern "C" DllExport Module * init_module(InspIRCd* Me) \