1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
20 #include "inspsocket.h"
30 /** Used with OnAccessCheck() method of modules
32 enum AccessControlType {
33 ACR_DEFAULT, // Do default action (act as if the module isnt even loaded)
34 ACR_DENY, // deny the action
35 ACR_ALLOW, // allow the action
36 AC_KICK, // a user is being kicked
37 AC_DEOP, // a user is being deopped
38 AC_OP, // a user is being opped
39 AC_VOICE, // a user is being voiced
40 AC_DEVOICE, // a user is being devoiced
41 AC_HALFOP, // a user is being halfopped
42 AC_DEHALFOP, // a user is being dehalfopped
43 AC_INVITE, // a user is being invited
44 AC_GENERAL_MODE // a channel mode is being changed
47 /** Used to define a set of behavior bits for a module
50 VF_STATIC = 1, // module is static, cannot be /unloadmodule'd
51 VF_VENDOR = 2, // module is a vendor module (came in the original tarball, not 3rd party)
52 VF_SERVICEPROVIDER = 4, // module provides a service to other modules (can be a dependency)
53 VF_COMMON = 8 // module needs to be common on all servers in a network to link
56 /** Used with SendToMode()
63 /** Used to represent an event type, for user, channel or server
65 enum TargetTypeFlags {
72 /** Used to represent wether a message was PRIVMSG or NOTICE
79 /** Used to represent an allow/deny module result.
80 * Not constructed as an enum because it reverses the value logic of some functions;
81 * the compiler will inline accesses to have the same efficiency as integer operations.
85 explicit ModResult(int r) : res(r) {}
86 bool operator==(const ModResult& r) const
90 bool operator!=(const ModResult& r) const
94 bool operator!() const
100 #define MOD_RES_ALLOW (ModResult(1))
101 #define MOD_RES_PASSTHRU (ModResult(0))
102 #define MOD_RES_DENY (ModResult(-1))
104 /** If you change the module API, change this value. */
105 #define API_VERSION 13000
109 /* Forward-delacare module for ModuleMessage etc
114 /** Low level definition of a FileReader classes file cache area -
115 * a text file seperated into lines.
117 typedef std::deque<std::string> file_cache;
119 /** A set of strings.
121 typedef file_cache string_list;
123 /** Holds a list of 'published features' for modules.
125 typedef std::map<std::string,Module*> featurelist;
127 /** Holds a list of modules which implement an interface
129 typedef std::deque<Module*> modulelist;
131 /** Holds a list of all modules which implement interfaces, by interface name
133 typedef std::map<std::string, std::pair<int, modulelist> > interfacelist;
136 * This #define allows us to call a method in all
137 * loaded modules in a readable simple way, e.g.:
138 * 'FOREACH_MOD(I_OnConnect,OnConnect(user));'
140 #define FOREACH_MOD(y,x) do { \
141 EventHandlerIter safei; \
142 for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ) \
150 catch (CoreException& modexcept) \
152 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
159 * This #define allows us to call a method in all
160 * loaded modules in a readable simple way and pass
161 * an instance pointer to the macro. e.g.:
162 * 'FOREACH_MOD_I(Instance, OnConnect, OnConnect(user));'
164 #define FOREACH_MOD_I(z,y,x) do { \
165 EventHandlerIter safei; \
166 for (EventHandlerIter _i = z->Modules->EventHandlers[y].begin(); _i != z->Modules->EventHandlers[y].end(); ) \
174 catch (CoreException& modexcept) \
176 z->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
183 * This define is similar to the one above but returns a result in MOD_RESULT.
184 * The first module to return a nonzero result is the value to be accepted,
185 * and any modules after are ignored.
187 #define FOREACH_RESULT(y,x) \
189 EventHandlerIter safei; \
191 for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ) \
197 int res = (*_i)->x ; \
203 catch (CoreException& modexcept) \
205 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
213 * This define is similar to the one above but returns a result in MOD_RESULT.
214 * The first module to return a nonzero result is the value to be accepted,
215 * and any modules after are ignored.
217 #define FOREACH_RESULT_I(z,y,x) \
219 EventHandlerIter safei; \
221 for (EventHandlerIter _i = z->Modules->EventHandlers[y].begin(); _i != z->Modules->EventHandlers[y].end(); ) \
227 int res = (*_i)->x ; \
233 catch (CoreException& modexcept) \
235 z->Logs->Log("MODULE",DEBUG,"Exception caught: %s",modexcept.GetReason()); \
242 * Custom module result handling loop. This is a paired macro, and should only
243 * be used with while_each_hook.
245 * See src/channels.cpp for an example of use.
247 #define DO_EACH_HOOK(z,n,v,args) \
249 EventHandlerIter iter_ ## n = z->Modules->EventHandlers[I_ ## n].begin(); \
250 while (iter_ ## n != z->Modules->EventHandlers[I_ ## n].end()) \
252 Module* mod_ ## n = *iter_ ## n; \
256 v = (mod_ ## n)->n args;
258 #define WHILE_EACH_HOOK(z,n) \
260 catch (CoreException& except_ ## n) \
262 z->Logs->Log("MODULE",DEFAULT,"Exception caught: %s", (except_ ## n).GetReason()); \
263 (void) mod_ ## n; /* catch mismatched pairs */ \
268 #define FIRST_MOD_RESULT(z,n,v,args) do { \
269 v = MOD_RES_PASSTHRU; \
270 DO_EACH_HOOK(z,n,v,args) \
272 if (v != MOD_RES_PASSTHRU) \
275 WHILE_EACH_HOOK(z,n); \
278 /** Represents a non-local user.
279 * (in fact, any FD less than -1 does)
281 #define FD_MAGIC_NUMBER -42
282 /** Represents a fake user (i.e. a server)
284 #define FD_FAKEUSER_NUMBER -7
288 /** Is a local user */
289 #define IS_LOCAL(x) (x->GetFd() > -1)
290 /** Is a remote user */
291 #define IS_REMOTE(x) (x->GetFd() < 0)
292 /** Is a fake user */
293 #define IS_FAKE(x) (x->GetFd() == FD_FAKEUSER_NUMBER)
294 /** Is a module created user */
295 #define IS_MODULE_CREATED(x) (x->GetFd() == FD_MAGIC_NUMBER)
297 #define IS_OPER(x) (!x->oper.empty())
299 #define IS_AWAY(x) (!x->awaymsg.empty())
301 /** Holds a module's Version information.
302 * The four members (set by the constructor only) indicate details as to the version number
303 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
304 * The flags and API values represent the module flags and API version of the module.
305 * The API version of a module must match the API version of the core exactly for the module to
308 class CoreExport Version : public classbase
311 /** Version information.
315 /** Flags and API version
317 const int Flags, API;
319 /** Initialize version class
321 Version(const std::string &sversion, int flags, int api_ver);
324 /** The ModuleMessage class is the base class of Request and Event
325 * This class is used to represent a basic data structure which is passed
326 * between modules for safe inter-module communications.
328 class CoreExport ModuleMessage : public Extensible
333 virtual ~ModuleMessage() {};
336 /** The Request class is a unicast message directed at a given module.
337 * When this class is properly instantiated it may be sent to a module
338 * using the Send() method, which will call the given module's OnRequest
339 * method with this class as its parameter.
341 class CoreExport Request : public ModuleMessage
344 /** This member holds a pointer to arbitary data set by the emitter of the message
347 /** This should be a null-terminated string identifying the type of request,
348 * all modules should define this and use it to determine the nature of the
349 * request before they attempt to cast the Request in any way.
352 /** This is a pointer to the sender of the message, which can be used to
353 * directly trigger events, or to create a reply.
356 /** The single destination of the Request
360 /** Create a new Request
361 * This is for the 'old' way of casting whatever the data is
362 * to char* and hoping you get the right thing at the other end.
363 * This is slowly being depreciated in favor of the 'new' way.
365 Request(char* anydata, Module* src, Module* dst);
366 /** Create a new Request
367 * This is for the 'new' way of defining a subclass
368 * of Request and defining it in a common header,
369 * passing an object of your Request subclass through
370 * as a Request* and using the ID string to determine
371 * what to cast it back to and the other end. This is
372 * much safer as there are no casts not confirmed by
373 * the ID string, and all casts are child->parent and
374 * can be checked at runtime with dynamic_cast<>()
376 Request(Module* src, Module* dst, const char* idstr);
377 /** Fetch the Request data
380 /** Fetch the ID string
383 /** Fetch the request source
386 /** Fetch the request destination (should be 'this' in the receiving module)
389 /** Send the Request.
390 * Upon returning the result will be arbitary data returned by the module you
391 * sent the request to. It is up to your module to know what this data is and
392 * how to deal with it.
398 /** The Event class is a unicast message directed at all modules.
399 * When the class is properly instantiated it may be sent to all modules
400 * using the Send() method, which will trigger the OnEvent method in
401 * all modules passing the object as its parameter.
403 class CoreExport Event : public ModuleMessage
406 /** This member holds a pointer to arbitary data set by the emitter of the message
409 /** This is a pointer to the sender of the message, which can be used to
410 * directly trigger events, or to create a reply.
413 /** The event identifier.
414 * This is arbitary text which should be used to distinguish
415 * one type of event from another.
419 /** Create a new Event
421 Event(char* anydata, Module* src, const std::string &eventid);
422 /** Get the Event data
425 /** Get the event Source
428 /** Get the event ID.
429 * Use this to determine the event type for safe casting of the data
431 std::string GetEventID();
433 * The return result of an Event::Send() will always be NULL as
434 * no replies are expected.
436 char* Send(InspIRCd* ServerInstance);
439 /** Priority types which can be returned from Module::Prioritize()
441 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
443 /** Implementation-specific flags which may be set in Module::Implements()
448 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash,
449 I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois,
450 I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick,
451 I_OnUserMessage, I_OnUserNotice, I_OnMode, I_OnGetServerDescription, I_OnSyncUser,
452 I_OnSyncChannel, I_OnSyncChannelMetaData, I_OnSyncUserMetaData, I_OnDecodeMetaData, I_OnWallops,
453 I_OnChangeHost, I_OnChangeName, I_OnAddLine, I_OnDelLine, I_OnExpireLine, I_OnCleanup,
454 I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule,
455 I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite,
456 I_OnRawMode, I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckExtBan, I_OnCheckStringExtBan,
457 I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnLocalTopicChange,
458 I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan,
459 I_OnDelBan, I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead,
460 I_OnChangeLocalUserGECOS, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
461 I_OnPostOper, I_OnSyncOtherMetaData, I_OnSetAway, I_OnUserList, I_OnPostCommand, I_OnPostJoin,
462 I_OnWhoisLine, I_OnBuildExemptList, I_OnRawSocketConnect, I_OnGarbageCollect, I_OnBufferFlushed,
463 I_OnText, I_OnPassCompare, I_OnRunTestSuite, I_OnNamesListItem, I_OnNumeric, I_OnHookUserIO,
464 I_OnHostCycle, I_OnPreRehash, I_OnModuleRehash,
470 /** Base class for all InspIRCd modules
471 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
472 * its methods will be called when irc server events occur. class inherited from module must be
473 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
475 class CoreExport Module : public Extensible
478 /** Creator/owner pointer
480 InspIRCd* ServerInstance;
483 /** Default constructor.
484 * Creates a module class.
485 * @param Me An instance of the InspIRCd class which will be saved into ServerInstance for your use
486 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
488 Module(InspIRCd* Me);
490 /** Default destructor.
491 * destroys a module class
495 virtual void Prioritize()
499 /** Returns the version number of a Module.
500 * The method should return a Version object with its version information assigned via
503 virtual Version GetVersion();
505 /** Called when a user connects.
506 * The details of the connecting user are available to you in the parameter User *user
507 * @param user The user who is connecting
509 virtual void OnUserConnect(User* user);
511 /** Called when a user quits.
512 * The details of the exiting user are available to you in the parameter User *user
513 * This event is only called when the user is fully registered when they quit. To catch
514 * raw disconnections, use the OnUserDisconnect method.
515 * @param user The user who is quitting
516 * @param message The user's quit message (as seen by non-opers)
517 * @param oper_message The user's quit message (as seen by opers)
519 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
521 /** Called whenever a user's socket is closed.
522 * The details of the exiting user are available to you in the parameter User *user
523 * This event is called for all users, registered or not, as a cleanup method for modules
524 * which might assign resources to user, such as dns lookups, objects and sockets.
525 * @param user The user who is disconnecting
527 virtual void OnUserDisconnect(User* user);
529 /** Called whenever a channel is about to be deleted
530 * @param chan The channel being deleted
531 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
533 virtual int OnChannelPreDelete(Channel *chan);
535 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
536 * @param chan The channel being deleted
538 virtual void OnChannelDelete(Channel* chan);
540 /** Called when a user joins a channel.
541 * The details of the joining user are available to you in the parameter User *user,
542 * and the details of the channel they have joined is available in the variable Channel *channel
543 * @param user The user who is joining
544 * @param channel The channel being joined
545 * @param silent Change this to true if you want to conceal the JOIN command from the other users
546 * of the channel (useful for modules such as auditorium)
547 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
548 * to a channel due to the network sync.
549 * @param created This is true if the join created the channel
551 virtual void OnUserJoin(User* user, Channel* channel, bool sync, bool &silent, bool created);
553 /** Called after a user joins a channel
554 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
556 * @param user The user who is joining
557 * @param channel The channel being joined
559 virtual void OnPostJoin(User* user, Channel* channel);
561 /** Called when a user parts a channel.
562 * The details of the leaving user are available to you in the parameter User *user,
563 * and the details of the channel they have left is available in the variable Channel *channel
564 * @param user The user who is parting
565 * @param channel The channel being parted
566 * @param partmessage The part message, or an empty string (may be modified)
567 * @param silent Change this to true if you want to conceal the PART command from the other users
568 * of the channel (useful for modules such as auditorium)
570 virtual void OnUserPart(User* user, Channel* channel, std::string &partmessage, bool &silent);
572 /** Called on rehash.
573 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
574 * system. This is called in all cases -- including when this server will not execute the
575 * rehash because it is directed at a remote server.
577 * @param user The user performing the rehash, if any. If this is server initiated, the value of
578 * this variable will be NULL.
579 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
582 virtual void OnPreRehash(User* user, const std::string ¶meter);
584 /** Called on rehash.
585 * This method is called when a user initiates a module-specific rehash. This can be used to do
586 * expensive operations (such as reloading SSL certificates) that are not executed on a normal
587 * rehash for efficiency. A rehash of this type does not reload the core configuration.
589 * @param user The user performing the rehash.
590 * @param parameter The parameter given to REHASH
592 virtual void OnModuleRehash(User* user, const std::string ¶meter);
594 /** Called on rehash.
595 * This method is called after a rehash has completed. You should use it to reload any module
596 * configuration from the main configuration file.
597 * @param user The user that performed the rehash, if it was initiated by a user and that user
598 * is still connected.
600 virtual void OnRehash(User* user);
602 /** Called whenever a snotice is about to be sent to a snomask.
603 * snomask and type may both be modified; the message may not.
604 * @param snomask The snomask the message is going to (e.g. 'A')
605 * @param type The textual description the snomask will go to (e.g. 'OPER')
606 * @param message The text message to be sent via snotice
607 * @return 1 to block the snotice from being sent entirely, 0 else.
609 virtual int OnSendSnotice(char &snomask, std::string &type, const std::string &message);
611 /** Called whenever a user is about to join a channel, before any processing is done.
612 * Returning a value of 1 from this function stops the process immediately, causing no
613 * output to be sent to the user by the core. If you do this you must produce your own numerics,
614 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
615 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
619 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
620 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
621 * processing on the actual channel record at this point, however the channel NAME will still be passed in
622 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
623 * @param user The user joining the channel
624 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
625 * @param cname The channel name being joined. For new channels this is valid where chan is not.
626 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "@".
627 * You may alter this string to alter the user's modes on the channel.
628 * @param keygiven The key given to join the channel, or an empty string if none was provided
629 * @return 1 To prevent the join, 0 to allow it.
631 virtual int OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string &privs, const std::string &keygiven);
633 /** Called whenever a user is about to be kicked.
634 * Returning a value of 1 from this function stops the process immediately, causing no
635 * output to be sent to the user by the core. If you do this you must produce your own numerics,
637 * @param source The user issuing the kick
638 * @param user The user being kicked
639 * @param chan The channel the user is being kicked from
640 * @param reason The kick reason
641 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
643 virtual int OnUserPreKick(User* source, User* user, Channel* chan, const std::string &reason);
645 /** Called whenever a user is kicked.
646 * If this method is called, the kick is already underway and cannot be prevented, so
647 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
648 * @param source The user issuing the kick
649 * @param user The user being kicked
650 * @param chan The channel the user is being kicked from
651 * @param reason The kick reason
652 * @param silent Change this to true if you want to conceal the PART command from the other users
653 * of the channel (useful for modules such as auditorium)
655 virtual void OnUserKick(User* source, User* user, Channel* chan, const std::string &reason, bool &silent);
657 /** Called whenever a user opers locally.
658 * The User will contain the oper mode 'o' as this function is called after any modifications
659 * are made to the user's structure by the core.
660 * @param user The user who is opering up
661 * @param opertype The opers type name
663 virtual void OnOper(User* user, const std::string &opertype);
665 /** Called after a user opers locally.
666 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
667 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
668 * out the OPERTYPE, etc.
669 * @param user The user who is opering up
670 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
671 * @param opertype The opers type name
673 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
675 /** Called whenever a user types /INFO.
676 * The User will contain the information of the user who typed the command. Modules may use this
677 * method to output their own credits in /INFO (which is the ircd's version of an about box).
678 * It is purposefully not possible to modify any info that has already been output, or halt the list.
679 * You must write a 371 numeric to the user, containing your info in the following format:
681 * <nick> :information here
683 * @param user The user issuing /INFO
685 virtual void OnInfo(User* user);
687 /** Called whenever a /WHOIS is performed on a local user.
688 * The source parameter contains the details of the user who issued the WHOIS command, and
689 * the dest parameter contains the information of the user they are whoising.
690 * @param source The user issuing the WHOIS command
691 * @param dest The user who is being WHOISed
693 virtual void OnWhois(User* source, User* dest);
695 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
696 * Returning 1 from this function stops the process immediately, causing no
697 * output to be sent to the user by the core. If you do this you must produce your own numerics,
698 * notices etc. This is useful for modules which may want to filter invites to channels.
699 * @param source The user who is issuing the INVITE
700 * @param dest The user being invited
701 * @param channel The channel the user is being invited to
702 * @param timeout The time the invite will expire (0 == never)
703 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
705 virtual int OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
707 /** Called after a user has been successfully invited to a channel.
708 * You cannot prevent the invite from occuring using this function, to do that,
709 * use OnUserPreInvite instead.
710 * @param source The user who is issuing the INVITE
711 * @param dest The user being invited
712 * @param channel The channel the user is being invited to
713 * @param timeout The time the invite will expire (0 == never)
715 virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout);
717 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
718 * Returning any nonzero value from this function stops the process immediately, causing no
719 * output to be sent to the user by the core. If you do this you must produce your own numerics,
720 * notices etc. This is useful for modules which may want to filter or redirect messages.
721 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
722 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
723 * of where the message is destined to be sent.
724 * @param user The user sending the message
725 * @param dest The target of the message (Channel* or User*)
726 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
727 * @param text Changeable text being sent by the user
728 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
729 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
730 * It will be ignored for private messages.
731 * @return 1 to deny the message, 0 to allow it
733 virtual int OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
735 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
736 * Returning any nonzero value from this function stops the process immediately, causing no
737 * output to be sent to the user by the core. If you do this you must produce your own numerics,
738 * notices etc. This is useful for modules which may want to filter or redirect messages.
739 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
740 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
741 * of where the message is destined to be sent.
742 * You may alter the message text as you wish before relinquishing control to the next module
743 * in the chain, and if no other modules block the text this altered form of the text will be sent out
744 * to the user and possibly to other servers.
745 * @param user The user sending the message
746 * @param dest The target of the message (Channel* or User*)
747 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
748 * @param text Changeable text being sent by the user
749 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
750 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
751 * It will be ignored for private notices.
752 * @return 1 to deny the NOTICE, 0 to allow it
754 virtual int OnUserPreNotice(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
756 /** Called whenever the server wants to build the exemption list for a channel, but is not directly doing a PRIVMSG or NOTICE.
757 * For example, the spanningtree protocol will call this event when passing a privmsg on (but not processing it directly).
758 * @param message_type The message type, either MSG_PRIVMSG or MSG_NOTICE
759 * @param chan The channel to build the exempt list of
760 * @param sender The original sender of the PRIVMSG or NOTICE
761 * @param status The status char to be used for the channel list
762 * @param exempt_list The exempt list to be populated
763 * @param text The original message text causing the exempt list to be built
765 virtual void OnBuildExemptList(MessageType message_type, Channel* chan, User* sender, char status, CUList &exempt_list, const std::string &text);
767 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
768 * Please note that although you can see remote nickchanges through this function, you should
769 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
770 * check user->server before taking any action (including returning nonzero from the method).
771 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
772 * module to generate some meaninful output.
773 * @param user The username changing their nick
774 * @param newnick Their new nickname
775 * @return 1 to deny the change, 0 to allow
777 virtual int OnUserPreNick(User* user, const std::string &newnick);
779 /** Called after any PRIVMSG sent from a user.
780 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
781 * if target_type is TYPE_CHANNEL.
782 * @param user The user sending the message
783 * @param dest The target of the message
784 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
785 * @param text the text being sent by the user
786 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
788 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
790 /** Called after any NOTICE sent from a user.
791 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
792 * if target_type is TYPE_CHANNEL.
793 * @param user The user sending the message
794 * @param dest The target of the message
795 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
796 * @param text the text being sent by the user
797 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
799 virtual void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
801 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
802 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
803 * if target_type is TYPE_CHANNEL.
804 * The difference between this event and OnUserPreNotice/OnUserPreMessage is that delivery is gauranteed,
805 * the message has already been vetted. In the case of the other two methods, a later module may stop your
806 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
807 * @param user The user sending the message
808 * @param dest The target of the message
809 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
810 * @param text the text being sent by the user
811 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
813 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
815 /** Called after every MODE command sent from a user
816 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
817 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
818 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
819 * @param user The user sending the MODEs
820 * @param dest The target of the modes (User* or Channel*)
821 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
822 * @param text The actual modes and their parameters if any
823 * @param translate The translation types of the mode parameters
825 virtual void OnMode(User* user, void* dest, int target_type, const std::vector<std::string> &text, const std::vector<TranslateType> &translate);
827 /** Allows modules to alter or create server descriptions
828 * Whenever a module requires a server description, for example for display in
829 * WHOIS, this function is called in all modules. You may change or define the
830 * description given in std::string &description. If you do, this description
831 * will be shown in the WHOIS fields.
832 * @param servername The servername being searched for
833 * @param description Alterable server description for this server
835 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
837 /** Allows modules to synchronize data which relates to users during a netburst.
838 * When this function is called, it will be called from the module which implements
839 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
840 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
841 * (see below). This function will be called for every user visible on your side
842 * of the burst, allowing you to for example set modes, etc. Do not use this call to
843 * synchronize data which you have stored using class Extensible -- There is a specialist
844 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
845 * @param user The user being syncronized
846 * @param proto A pointer to the module handling network protocol
847 * @param opaque An opaque pointer set by the protocol module, should not be modified!
849 virtual void OnSyncUser(User* user, Module* proto, void* opaque);
851 /** Allows modules to synchronize data which relates to channels during a netburst.
852 * When this function is called, it will be called from the module which implements
853 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
854 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
855 * (see below). This function will be called for every user visible on your side
856 * of the burst, allowing you to for example set modes, etc. Do not use this call to
857 * synchronize data which you have stored using class Extensible -- There is a specialist
858 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
860 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
862 * @param chan The channel being syncronized
863 * @param proto A pointer to the module handling network protocol
864 * @param opaque An opaque pointer set by the protocol module, should not be modified!
866 virtual void OnSyncChannel(Channel* chan, Module* proto, void* opaque);
868 /* Allows modules to syncronize metadata related to channels over the network during a netburst.
869 * Whenever the linking module wants to send out data, but doesnt know what the data
870 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
871 * this method is called.You should use the ProtoSendMetaData function after you've
872 * correctly decided how the data should be represented, to send the metadata on its way if it belongs
873 * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
874 * @param chan The channel whos metadata is being syncronized
875 * @param proto A pointer to the module handling network protocol
876 * @param opaque An opaque pointer set by the protocol module, should not be modified!
877 * @param extname The extensions name which is being searched for
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 OnSyncChannelMetaData(Channel* chan, Module* proto,void* opaque, const std::string &extname, bool displayable = false);
883 /* Allows modules to syncronize metadata related to users over the network during a netburst.
884 * Whenever the linking module wants to send out data, but doesnt know what the data
885 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
886 * this method is called. You should use the ProtoSendMetaData function after you've
887 * correctly decided how the data should be represented, to send the metadata on its way if
888 * if it belongs to your module.
889 * @param user The user whos metadata is being syncronized
890 * @param proto A pointer to the module handling network protocol
891 * @param opaque An opaque pointer set by the protocol module, should not be modified!
892 * @param extname The extensions name which is being searched for
893 * @param displayable If this value is true, the data is going to be displayed to a user,
894 * and not sent across the network. Use this to determine wether or not to show sensitive data.
896 virtual void OnSyncUserMetaData(User* user, Module* proto,void* opaque, const std::string &extname, bool displayable = false);
898 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
899 * Whenever the linking module wants to send out data, but doesnt know what the data
900 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
901 * this method is called. You should use the ProtoSendMetaData function after you've
902 * correctly decided how the data should be represented, to send the metadata on its way if
903 * if it belongs to your module.
904 * @param proto A pointer to the module handling network protocol
905 * @param opaque An opaque pointer set by the protocol module, should not be modified!
906 * @param displayable If this value is true, the data is going to be displayed to a user,
907 * and not sent across the network. Use this to determine wether or not to show sensitive data.
909 virtual void OnSyncOtherMetaData(Module* proto, void* opaque, bool displayable = false);
911 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
912 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
913 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
914 * @param target The Channel* or User* that data should be added to
915 * @param extname The extension name which is being sent
916 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
918 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata);
920 /** Implemented by modules which provide the ability to link servers.
921 * These modules will implement this method, which allows transparent sending of servermodes
922 * down the network link as a broadcast, without a module calling it having to know the format
923 * of the MODE command before the actual mode string.
925 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
926 * of how to use this function.
928 * @param opaque An opaque pointer set by the protocol module, should not be modified!
929 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
930 * @param target The Channel* or User* that modes should be sent for
931 * @param modeline The modes and parameters to be sent
932 * @param translate The translation types of the mode parameters
934 virtual void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::vector<std::string> &modeline, const std::vector<TranslateType> &translate);
936 /** Implemented by modules which provide the ability to link servers.
937 * These modules will implement this method, which allows metadata (extra data added to
938 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
939 * to other servers on a netburst and decoded at the other end by the same module on a
942 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
943 * how to use this function.
944 * @param opaque An opaque pointer set by the protocol module, should not be modified!
945 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
946 * @param target The Channel* or User* that metadata should be sent for
947 * @param extname The extension name to send metadata for
948 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
950 virtual void ProtoSendMetaData(void* opaque, TargetTypeFlags target_type, void* target, const std::string &extname, const std::string &extdata);
952 /** Called after every WALLOPS command.
953 * @param user The user sending the WALLOPS
954 * @param text The content of the WALLOPS message
956 virtual void OnWallops(User* user, const std::string &text);
958 /** Called whenever a user's hostname is changed.
959 * This event triggers after the host has been set.
960 * @param user The user whos host is being changed
961 * @param newhost The new hostname being set
963 virtual void OnChangeHost(User* user, const std::string &newhost);
965 /** Called whenever a user's GECOS (realname) is changed.
966 * This event triggers after the name has been set.
967 * @param user The user who's GECOS is being changed
968 * @param gecos The new GECOS being set on the user
970 virtual void OnChangeName(User* user, const std::string &gecos);
972 /** Called whenever an xline is added by a local user.
973 * This method is triggered after the line is added.
974 * @param source The sender of the line or NULL for local server
975 * @param line The xline being added
977 virtual void OnAddLine(User* source, XLine* line);
979 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
980 * This method is triggered after the line is deleted.
981 * @param source The user removing the line or NULL for local server
982 * @param line the line being deleted
984 virtual void OnDelLine(User* source, XLine* line);
986 /** Called whenever an xline expires.
987 * This method is triggered after the line is deleted.
988 * @param line The line being deleted.
990 virtual void OnExpireLine(XLine *line);
992 /** Called before your module is unloaded to clean up Extensibles.
993 * This method is called once for every user and channel on the network,
994 * so that when your module unloads it may clear up any remaining data
995 * in the form of Extensibles added using Extensible::Extend().
996 * If the target_type variable is TYPE_USER, then void* item refers to
997 * a User*, otherwise it refers to a Channel*.
998 * @param target_type The type of item being cleaned
999 * @param item A pointer to the item's class
1001 virtual void OnCleanup(int target_type, void* item);
1003 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
1004 * have been applied. Please note that although you can see remote nickchanges through this function, you should
1005 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
1006 * check user->server before taking any action (including returning nonzero from the method).
1007 * Because this method is called after the nickchange is taken place, no return values are possible
1008 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
1009 * @param user The user changing their nick
1010 * @param oldnick The old nickname of the user before the nickchange
1012 virtual void OnUserPostNick(User* user, const std::string &oldnick);
1014 /** Called before an action which requires a channel privilage check.
1015 * This function is called before many functions which check a users status on a channel, for example
1016 * before opping a user, deopping a user, kicking a user, etc.
1017 * There are several values for access_type which indicate for what reason access is being checked.
1018 * These are:<br><br>
1019 * AC_KICK - A user is being kicked<br>
1020 * AC_DEOP - a user is being deopped<br>
1021 * AC_OP - a user is being opped<br>
1022 * AC_VOICE - a user is being voiced<br>
1023 * AC_DEVOICE - a user is being devoiced<br>
1024 * AC_HALFOP - a user is being halfopped<br>
1025 * AC_DEHALFOP - a user is being dehalfopped<br>
1026 * AC_INVITE - a user is being invited<br>
1027 * AC_GENERAL_MODE - a user channel mode is being changed<br><br>
1028 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
1029 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
1030 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
1031 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
1032 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
1033 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
1034 * @param source The source of the access check
1035 * @param dest The destination of the access check
1036 * @param channel The channel which is being checked
1037 * @param access_type See above
1039 virtual int OnAccessCheck(User* source,User* dest,Channel* channel,int access_type);
1041 /** Called when a 005 numeric is about to be output.
1042 * The module should modify the 005 numeric if needed to indicate its features.
1043 * @param output The 005 string to be modified if neccessary.
1045 virtual void On005Numeric(std::string &output);
1047 /** Called when a client is disconnected by KILL.
1048 * If a client is killed by a server, e.g. a nickname collision or protocol error,
1050 * Return 1 from this function to prevent the kill, and 0 from this function to allow
1051 * it as normal. If you prevent the kill no output will be sent to the client, it is
1052 * down to your module to generate this information.
1053 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
1054 * If you do so youre risking race conditions, desyncs and worse!
1055 * @param source The user sending the KILL
1056 * @param dest The user being killed
1057 * @param reason The kill reason
1058 * @return 1 to prevent the kill, 0 to allow
1060 virtual int OnKill(User* source, User* dest, const std::string &reason);
1062 /** Called when an oper wants to disconnect a remote user via KILL
1063 * @param source The user sending the KILL
1064 * @param dest The user being killed
1065 * @param reason The kill reason
1067 virtual void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
1069 /** Called whenever a module is loaded.
1070 * mod will contain a pointer to the module, and string will contain its name,
1071 * for example m_widgets.so. This function is primary for dependency checking,
1072 * your module may decide to enable some extra features if it sees that you have
1073 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
1074 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
1075 * but instead operate under reduced functionality, unless the dependency is
1076 * absolutely neccessary (e.g. a module that extends the features of another
1078 * @param mod A pointer to the new module
1079 * @param name The new module's filename
1081 virtual void OnLoadModule(Module* mod,const std::string &name);
1083 /** Called whenever a module is unloaded.
1084 * mod will contain a pointer to the module, and string will contain its name,
1085 * for example m_widgets.so. This function is primary for dependency checking,
1086 * your module may decide to enable some extra features if it sees that you have
1087 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
1088 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
1089 * but instead operate under reduced functionality, unless the dependency is
1090 * absolutely neccessary (e.g. a module that extends the features of another
1092 * @param mod Pointer to the module being unloaded (still valid)
1093 * @param name The filename of the module being unloaded
1095 virtual void OnUnloadModule(Module* mod,const std::string &name);
1097 /** Called once every five seconds for background processing.
1098 * This timer can be used to control timed features. Its period is not accurate
1099 * enough to be used as a clock, but it is gauranteed to be called at least once in
1100 * any five second period, directly from the main loop of the server.
1101 * @param curtime The current timer derived from time(2)
1103 virtual void OnBackgroundTimer(time_t curtime);
1105 /** Called whenever any command is about to be executed.
1106 * This event occurs for all registered commands, wether they are registered in the core,
1107 * or another module, and for invalid commands. Invalid commands may only be sent to this
1108 * function when the value of validated is false. By returning 1 from this method you may prevent the
1109 * command being executed. If you do this, no output is created by the core, and it is
1110 * down to your module to produce any output neccessary.
1111 * Note that unless you return 1, you should not destroy any structures (e.g. by using
1112 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
1113 * method returns, it will be passed an invalid pointer to the user object and crash!)
1114 * @param command The command being executed
1115 * @param parameters An array of array of characters containing the parameters for the command
1116 * @param pcnt The nuimber of parameters passed to the command
1117 * @param user the user issuing the command
1118 * @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.
1119 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
1120 * @param original_line The entire original line as passed to the parser from the user
1121 * @return 1 to block the command, 0 to allow
1123 virtual int OnPreCommand(std::string &command, std::vector<std::string>& parameters, User *user, bool validated, const std::string &original_line);
1125 /** Called after any command has been executed.
1126 * This event occurs for all registered commands, wether they are registered in the core,
1127 * or another module, but it will not occur for invalid commands (e.g. ones which do not
1128 * exist within the command table). The result code returned by the command handler is
1130 * @param command The command being executed
1131 * @param parameters An array of array of characters containing the parameters for the command
1132 * @param pcnt The nuimber of parameters passed to the command
1133 * @param user the user issuing the command
1134 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
1135 * @param original_line The entire original line as passed to the parser from the user
1137 virtual void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, User *user, CmdResult result, const std::string &original_line);
1139 /** Called to check if a user who is connecting can now be allowed to register
1140 * If any modules return false for this function, the user is held in the waiting
1141 * state until all modules return true. For example a module which implements ident
1142 * lookups will continue to return false for a user until their ident lookup is completed.
1143 * Note that the registration timeout for a user overrides these checks, if the registration
1144 * timeout is reached, the user is disconnected even if modules report that the user is
1145 * not ready to connect.
1146 * @param user The user to check
1147 * @return true to indicate readiness, false if otherwise
1149 virtual bool OnCheckReady(User* user);
1151 /** Called whenever a user is about to register their connection (e.g. before the user
1152 * is sent the MOTD etc). Modules can use this method if they are performing a function
1153 * which must be done before the actual connection is completed (e.g. ident lookups,
1154 * dnsbl lookups, etc).
1155 * Note that you should NOT delete the user record here by causing a disconnection!
1156 * Use OnUserConnect for that instead.
1157 * @param user The user registering
1158 * @return 1 to indicate user quit, 0 to continue
1160 virtual int OnUserRegister(User* user);
1162 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1163 * This method will always be called for each join, wether or not the channel is actually +i, and
1164 * determines the outcome of an if statement around the whole section of invite checking code.
1165 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1166 * @param user The user joining the channel
1167 * @param chan The channel being joined
1168 * @return 1 to explicitly allow the join, 0 to proceed as normal
1170 virtual int OnCheckInvite(User* user, Channel* chan);
1172 /** Called whenever a mode character is processed.
1173 * Return 1 from this function to block the mode character from being processed entirely.
1174 * @param user The user who is sending the mode
1175 * @param chan The channel the mode is being sent to (or NULL if a usermode)
1176 * @param mode The mode character being set
1177 * @param param The parameter for the mode or an empty string
1178 * @param adding true of the mode is being added, false if it is being removed
1179 * @param pcnt The parameter count for the mode (0 or 1)
1180 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
1181 * to skip all permission checking. Please note that for remote mode changes, your return value
1184 virtual int OnRawMode(User* user, Channel* chan, const char mode, const std::string ¶m, bool adding, int pcnt, bool servermode = true);
1186 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1187 * This method will always be called for each join, wether or not the channel is actually +k, and
1188 * determines the outcome of an if statement around the whole section of key checking code.
1189 * if the user specified no key, the keygiven string will be a valid but empty value.
1190 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1191 * @param user The user joining the channel
1192 * @param chan The channel being joined
1193 * @return 1 to explicitly allow the join, 0 to proceed as normal
1195 virtual int OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
1197 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1198 * This method will always be called for each join, wether or not the channel is actually +l, and
1199 * determines the outcome of an if statement around the whole section of channel limit checking code.
1200 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1201 * @param user The user joining the channel
1202 * @param chan The channel being joined
1203 * @return 1 to explicitly allow the join, 0 to proceed as normal
1205 virtual int OnCheckLimit(User* user, Channel* chan);
1207 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
1208 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
1209 * determines the outcome of an if statement around the whole section of ban checking code.
1210 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1211 * @param user The user joining the channel
1212 * @param chan The channel being joined
1213 * @return 1 to explicitly allow the join, 0 to proceed as normal. Return -1 to explicitly deny the
1214 * join to the channel.
1216 virtual int OnCheckBan(User* user, Channel* chan);
1218 /* Called whenever checking whether or not a user is matched by an applicable extended bantype.
1219 * NOTE: may also trigger extra OnCheckStringExtBan events!
1220 * @param u The user to check
1221 * @param c The channel the user is on
1222 * @param type The type of extended ban to check for.
1223 * @returns 1 = exempt, 0 = no match, -1 = banned
1225 virtual int OnCheckExtBan(User *u, Channel *c, char type);
1227 /** Called whenever checking whether or not a string is extbanned. NOTE: one OnCheckExtBan will also trigger a number of
1228 * OnCheckStringExtBan events for seperate host/IP comnbinations.
1229 * @returns 1 = exempt, 0 = no match, -1 = banned
1231 virtual int OnCheckStringExtBan(const std::string &s, Channel *c, char type);
1233 /** Called on all /STATS commands
1234 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1235 * @param symbol the symbol provided to /STATS
1236 * @param user the user issuing the /STATS command
1237 * @param results A string_list to append results into. You should put all your results
1238 * into this string_list, rather than displaying them directly, so that your handler will
1239 * work when remote STATS queries are received.
1240 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1242 virtual int OnStats(char symbol, User* user, string_list &results);
1244 /** Called whenever a change of a local users displayed host is attempted.
1245 * Return 1 to deny the host change, or 0 to allow it.
1246 * @param user The user whos host will be changed
1247 * @param newhost The new hostname
1248 * @return 1 to deny the host change, 0 to allow
1250 virtual int OnChangeLocalUserHost(User* user, const std::string &newhost);
1252 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1253 * return 1 to deny the name change, or 0 to allow it.
1254 * @param user The user whos GECOS will be changed
1255 * @param newhost The new GECOS
1256 * @return 1 to deny the GECOS change, 0 to allow
1258 virtual int OnChangeLocalUserGECOS(User* user, const std::string &newhost);
1260 /** Called whenever a topic is changed by a local user.
1261 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
1262 * @param user The user changing the topic
1263 * @param chan The channels who's topic is being changed
1264 * @param topic The actual topic text
1265 * @param 1 to block the topic change, 0 to allow
1267 virtual int OnLocalTopicChange(User* user, Channel* chan, const std::string &topic);
1269 /** Called whenever a local topic has been changed.
1270 * To block topic changes you must use OnLocalTopicChange instead.
1271 * @param user The user changing the topic
1272 * @param chan The channels who's topic is being changed
1273 * @param topic The actual topic text
1275 virtual void OnPostLocalTopicChange(User* user, Channel* chan, const std::string &topic);
1277 /** Called whenever an Event class is sent to all module by another module.
1278 * Please see the documentation of Event::Send() for further information. The Event sent can
1279 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1280 * before doing anything to the event data, and you should *not* change the event data in any way!
1281 * @param event The Event class being received
1283 virtual void OnEvent(Event* event);
1285 /** Called whenever a Request class is sent to your module by another module.
1286 * Please see the documentation of Request::Send() for further information. The Request sent
1287 * can always be assumed to be non-NULL, you should not change the request object or its data.
1288 * Your method may return arbitary data in the char* result which the requesting module
1289 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1290 * @param request The Request class being received
1292 virtual const char* OnRequest(Request* request);
1294 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
1295 * The password field (from the config file) is in 'password' and is to be compared against
1296 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
1297 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
1298 * @param ex The object that's causing the authentication (User* for <oper> <connect:allow> etc, Server* for <link>).
1299 * @param password The password from the configuration file (the password="" value).
1300 * @param input The password entered by the user or whoever.
1301 * @param hashtype The hash value from the config
1302 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
1304 virtual int OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
1306 /** Called whenever a user is given usermode +o, anywhere on the network.
1307 * You cannot override this and prevent it from happening as it is already happened and
1308 * such a task must be performed by another server. You can however bounce modes by sending
1309 * servermodes out to reverse mode changes.
1310 * @param user The user who is opering
1312 virtual void OnGlobalOper(User* user);
1314 /** Called after a user has fully connected and all modules have executed OnUserConnect
1315 * This event is informational only. You should not change any user information in this
1316 * event. To do so, use the OnUserConnect method to change the state of local users.
1317 * This is called for both local and remote users.
1318 * @param user The user who is connecting
1320 virtual void OnPostConnect(User* user);
1322 /** Called whenever a ban is added to a channel's list.
1323 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1324 * @param source The user adding the ban
1325 * @param channel The channel the ban is being added to
1326 * @param banmask The ban mask being added
1327 * @return 1 to block the ban, 0 to continue as normal
1329 virtual int OnAddBan(User* source, Channel* channel,const std::string &banmask);
1331 /** Called whenever a ban is removed from a channel's list.
1332 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1333 * @param source The user deleting the ban
1334 * @param channel The channel the ban is being deleted from
1335 * @param banmask The ban mask being deleted
1336 * @return 1 to block the unban, 0 to continue as normal
1338 virtual int OnDelBan(User* source, Channel* channel,const std::string &banmask);
1340 virtual void OnHookUserIO(User* user);
1342 /** Called immediately after any connection is accepted. This is intended for raw socket
1343 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1344 * no information relating to a user record as the connection has not been assigned yet.
1345 * There are no return values from this call as all modules get an opportunity if required to
1346 * process the connection.
1347 * @param fd The file descriptor returned from accept()
1348 * @param client The client IP address and port
1349 * @param server The server IP address and port
1350 * @param localport The local port number the user connected to
1352 virtual void OnRawSocketAccept(int fd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
1354 /** Called immediately before any write() operation on a user's socket in the core. Because
1355 * this event is a low level event no user information is associated with it. It is intended
1356 * for use by modules which may wrap connections within another API such as SSL for example.
1357 * return a non-zero result if you have handled the write operation, in which case the core
1358 * will not call write().
1359 * @param fd The file descriptor of the socket
1360 * @param buffer A char* buffer being written
1361 * @param Number of characters to write
1362 * @return Number of characters actually written or 0 if you didn't handle the operation
1364 virtual int OnRawSocketWrite(int fd, const char* buffer, int count);
1366 /** Called immediately before any socket is closed. When this event is called, shutdown()
1367 * has not yet been called on the socket.
1368 * @param fd The file descriptor of the socket prior to close()
1370 virtual void OnRawSocketClose(int fd);
1372 /** Called immediately upon connection of an outbound BufferedSocket which has been hooked
1374 * @param fd The file descriptor of the socket immediately after connect()
1376 virtual void OnRawSocketConnect(int fd);
1378 /** Called immediately before any read() operation on a client socket in the core.
1379 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1380 * when this event occurs.
1381 * Your event should return 1 if it has handled the reading itself, which prevents the core
1382 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1383 * the value of count. The value of readresult must be identical to an actual result that might
1384 * be returned from the read() system call, for example, number of bytes read upon success,
1385 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1386 * you MUST set readresult.
1387 * @param fd The file descriptor of the socket
1388 * @param buffer A char* buffer being read to
1389 * @param count The size of the buffer
1390 * @param readresult The amount of characters read, or 0
1391 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1393 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1395 /** Called whenever a user sets away or returns from being away.
1396 * The away message is available as a parameter, but should not be modified.
1397 * At this stage, it has already been copied into the user record.
1398 * If awaymsg is empty, the user is returning from away.
1399 * @param user The user setting away
1400 * @param awaymsg The away message of the user, or empty if returning from away
1401 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
1403 virtual int OnSetAway(User* user, const std::string &awaymsg);
1405 /** Called whenever a NAMES list is requested.
1406 * You can produce the nameslist yourself, overriding the current list,
1407 * and if you do you must return 1. If you do not handle the names list,
1409 * @param The user requesting the NAMES list
1410 * @param Ptr The channel the NAMES list is requested for
1411 * @param userlist The user list for the channel (you may change this pointer.
1412 * If you want to change the values, take a copy first, and change the copy, then
1413 * point the pointer at your copy)
1414 * @return 1 to prevent the user list being sent to the client, 0 to allow it.
1415 * Returning -1 allows the names list, but bypasses any checks which check for
1416 * channel membership before sending the names list.
1418 virtual int OnUserList(User* user, Channel* Ptr, CUList* &userlist);
1420 /** Called whenever a line of WHOIS output is sent to a user.
1421 * You may change the numeric and the text of the output by changing
1422 * the values numeric and text, but you cannot change the user the
1423 * numeric is sent to. You may however change the user's User values.
1424 * @param user The user the numeric is being sent to
1425 * @param dest The user being WHOISed
1426 * @param numeric The numeric of the line being sent
1427 * @param text The text of the numeric, including any parameters
1428 * @return nonzero to drop the line completely so that the user does not
1429 * receive it, or zero to allow the line to be sent.
1431 virtual int OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
1433 /** Called at intervals for modules to garbage-collect any hashes etc.
1434 * Certain data types such as hash_map 'leak' buckets, which must be
1435 * tidied up and freed by copying into a new item every so often. This
1436 * method is called when it is time to do that.
1438 virtual void OnGarbageCollect();
1440 /** Called whenever a user's write buffer has been completely sent.
1441 * This is called when the user's write buffer is completely empty, and
1442 * there are no more pending bytes to be written and no pending write events
1443 * in the socket engine's queue. This may be used to refill the buffer with
1444 * data which is being spooled in a controlled manner, e.g. LIST lines.
1445 * @param user The user who's buffer is now empty.
1447 virtual void OnBufferFlushed(User* user);
1449 /** Add test suite hooks here. These are used for testing functionality of a module
1450 * via the --testsuite debugging parameter.
1452 virtual void OnRunTestSuite();
1454 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
1455 * For example NAMESX, channel mode +u and +I, and UHNAMES. If the nick is set to an empty string by any
1456 * module, then this will cause the nickname not to be displayed at all.
1458 virtual void OnNamesListItem(User* issuer, User* user, Channel* channel, std::string &prefixes, std::string &nick);
1460 virtual int OnNumeric(User* user, unsigned int numeric, const std::string &text);
1462 /** Called for every time the user's host or ident changes, to indicate wether or not the 'Changing host'
1463 * message should be sent, if enabled. Certain modules such as auditorium may opt to hide this message
1464 * even if it is enabled.
1466 virtual bool OnHostCycle(User* user);
1470 #define CONF_NO_ERROR 0x000000
1471 #define CONF_NOT_A_NUMBER 0x000010
1472 #define CONF_INT_NEGATIVE 0x000080
1473 #define CONF_VALUE_NOT_FOUND 0x000100
1474 #define CONF_FILE_NOT_FOUND 0x000200
1477 /** Allows reading of values from configuration files
1478 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1479 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1480 * Constructing the class using one parameter allows you to specify a path to your own configuration
1481 * file, otherwise, inspircd.conf is read.
1483 class CoreExport ConfigReader : public classbase
1486 InspIRCd* ServerInstance;
1492 /** Default constructor.
1493 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1494 * as specified when running ./configure.
1496 ConfigReader(InspIRCd* Instance);
1497 /** Default destructor.
1498 * This method destroys the ConfigReader class.
1502 /** Retrieves a value from the config file.
1503 * This method retrieves a value from the config file. Where multiple copies of the tag
1504 * exist in the config file, index indicates which of the values to retrieve.
1506 std::string ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds = false);
1507 /** Retrieves a value from the config file.
1508 * This method retrieves a value from the config file. Where multiple copies of the tag
1509 * exist in the config file, index indicates which of the values to retrieve. If the
1510 * tag is not found the default value is returned instead.
1512 std::string ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds = false);
1514 /** Retrieves a boolean value from the config file.
1515 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1516 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1517 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1519 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1520 /** Retrieves a boolean value from the config file.
1521 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1522 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1523 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1524 * If the tag is not found, the default value is used instead.
1526 bool ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index);
1528 /** Retrieves an integer value from the config file.
1529 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1530 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1531 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1532 * return CONF_INVALID_NUMBER to be returned. need_positive is set if the number must be non-negative.
1533 * If a negative number is placed into a tag which is specified positive, 0 will be returned and GetError()
1534 * will return CONF_INT_NEGATIVE. Note that need_positive is not suitable to get an unsigned int - you
1535 * should cast the result to achieve that effect.
1537 int ReadInteger(const std::string &tag, const std::string &name, int index, bool need_positive);
1538 /** Retrieves an integer value from the config file.
1539 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1540 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1541 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1542 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1543 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1544 * will return CONF_NOT_UNSIGNED. If the tag is not found, the default value is used instead.
1546 int ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool need_positive);
1548 /** Returns the last error to occur.
1549 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1550 * A call to GetError() resets the error flag back to 0.
1553 /** Counts the number of times a given tag appears in the config file.
1554 * This method counts the number of times a tag appears in a config file, for use where
1555 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1556 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1557 * multiple instance tag.
1559 int Enumerate(const std::string &tag);
1561 /** Returns the number of items within a tag.
1562 * For example if the tag was <test tag="blah" data="foo"> then this
1563 * function would return 2. Spaces and newlines both qualify as valid seperators
1566 int EnumerateValues(const std::string &tag, int index);
1571 /** Caches a text file into memory and can be used to retrieve lines from it.
1572 * This class contains methods for read-only manipulation of a text file in memory.
1573 * Either use the constructor type with one parameter to load a file into memory
1574 * at construction, or use the LoadFile method to load a file.
1576 class CoreExport FileReader : public classbase
1578 InspIRCd* ServerInstance;
1579 /** The file contents
1583 /** Content size in bytes
1585 unsigned long contentsize;
1587 /** Calculate content size in bytes
1592 /** Default constructor.
1593 * This method does not load any file into memory, you must use the LoadFile method
1594 * after constructing the class this way.
1596 FileReader(InspIRCd* Instance);
1598 /** Secondary constructor.
1599 * This method initialises the class with a file loaded into it ready for GetLine and
1600 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1603 FileReader(InspIRCd* Instance, const std::string &filename);
1605 /** Default destructor.
1606 * This deletes the memory allocated to the file.
1610 /** Used to load a file.
1611 * This method loads a file into the class ready for GetLine and
1612 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1615 void LoadFile(const std::string &filename);
1617 /** Returns the whole content of the file as std::string
1619 std::string Contents();
1621 /** Returns the entire size of the file as std::string
1623 unsigned long ContentSize();
1625 /** Returns true if the file exists
1626 * This function will return false if the file could not be opened.
1630 /** Retrieve one line from the file.
1631 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1632 * the index was out of bounds, or the line had no data on it.
1634 std::string GetLine(int x);
1636 /** Returns the size of the file in lines.
1637 * This method returns the number of lines in the read file. If it is 0, no lines have been
1638 * read into memory, either because the file is empty or it does not exist, or cannot be
1639 * opened due to permission problems.
1644 /** A DLLFactory (designed to load shared objects) containing a
1645 * handle to a module's init_module() function. Unfortunately,
1646 * due to the design of shared object systems we must keep this
1647 * hanging around, as if we remove this handle, we remove the
1648 * shared object file from memory (!)
1650 typedef DLLFactory<Module> ircd_module;
1652 /** A list of modules
1654 typedef std::vector<Module*> IntModuleList;
1656 /** An event handler iterator
1658 typedef IntModuleList::iterator EventHandlerIter;
1660 /** ModuleManager takes care of all things module-related
1663 class CoreExport ModuleManager : public classbase
1666 /** Holds a string describing the last module error to occur
1668 std::string LastModuleError;
1670 /** The feature names published by various modules
1672 featurelist Features;
1674 /** The interface names published by various modules
1676 interfacelist Interfaces;
1678 /** Total number of modules loaded into the ircd
1682 /** Our pointer to the main insp instance
1686 /** List of loaded modules and shared object/dll handles
1687 * keyed by module name
1689 std::map<std::string, std::pair<ircd_module*, Module*> > Modules;
1695 } prioritizationState;
1698 /** Event handler hooks.
1699 * This needs to be public to be used by FOREACH_MOD and friends.
1701 IntModuleList EventHandlers[I_END];
1703 /** Simple, bog-standard, boring constructor.
1705 ModuleManager(InspIRCd* Ins);
1711 /** Change the priority of one event in a module.
1712 * Each module event has a list of modules which are attached to that event type.
1713 * If you wish to be called before or after other specific modules, you may use this
1714 * method (usually within void Module::Prioritize()) to set your events priority.
1715 * You may use this call in other methods too, however, this is not supported behaviour
1717 * @param mod The module to change the priority of
1718 * @param i The event to change the priority of
1719 * @param s The state you wish to use for this event. Use one of
1720 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1721 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1722 * to set it to be before or after one or more other modules.
1723 * @param modules If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1724 * then this contains a list of one or more modules your module must be
1725 * placed before or after. Your module will be placed before the highest
1726 * priority module in this list for PRIO_BEFORE, or after the lowest
1727 * priority module in this list for PRIORITY_AFTER.
1728 * @param sz The number of modules being passed for PRIO_BEFORE and PRIORITY_AFTER.
1729 * Defaults to 1, as most of the time you will only want to prioritize your module
1730 * to be before or after one other module.
1732 bool SetPriority(Module* mod, Implementation i, Priority s, Module** modules = NULL, size_t sz = 1);
1734 /** Change the priority of all events in a module.
1735 * @param mod The module to set the priority of
1736 * @param s The priority of all events in the module.
1737 * Note that with this method, it is not possible to effectively use
1738 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1739 * SetPriority method for this, where you may specify other modules to
1740 * be prioritized against.
1742 bool SetPriority(Module* mod, Priority s);
1744 /** Attach an event to a module.
1745 * You may later detatch the event with ModuleManager::Detach().
1746 * If your module is unloaded, all events are automatically detatched.
1747 * @param i Event type to attach
1748 * @param mod Module to attach event to
1749 * @return True if the event was attached
1751 bool Attach(Implementation i, Module* mod);
1753 /** Detatch an event from a module.
1754 * This is not required when your module unloads, as the core will
1755 * automatically detatch your module from all events it is attached to.
1756 * @param i Event type to detach
1757 * @param mod Module to detach event from
1758 * @param Detach true if the event was detached
1760 bool Detach(Implementation i, Module* mod);
1762 /** Attach an array of events to a module
1763 * @param i Event types (array) to attach
1764 * @param mod Module to attach events to
1766 void Attach(Implementation* i, Module* mod, size_t sz);
1768 /** Detach all events from a module (used on unload)
1769 * @param mod Module to detach from
1771 void DetachAll(Module* mod);
1773 /** Returns text describing the last module error
1774 * @return The last error message to occur
1776 std::string& LastError();
1778 /** Load a given module file
1779 * @param filename The file to load
1780 * @return True if the module was found and loaded
1782 bool Load(const char* filename);
1784 /** Unload a given module file
1785 * @param filename The file to unload
1786 * @return True if the module was unloaded
1788 bool Unload(const char* filename);
1790 /** Called by the InspIRCd constructor to load all modules from the config file.
1794 /** Get the total number of currently loaded modules
1795 * @return The number of loaded modules
1799 return this->ModCount;
1802 /** Find a module by name, and return a Module* to it.
1803 * This is preferred over iterating the module lists yourself.
1804 * @param name The module name to look up
1805 * @return A pointer to the module, or NULL if the module cannot be found
1807 Module* Find(const std::string &name);
1809 /** Publish a 'feature'.
1810 * There are two ways for a module to find another module it depends on.
1811 * Either by name, using InspIRCd::FindModule, or by feature, using this
1812 * function. A feature is an arbitary string which identifies something this
1813 * module can do. For example, if your module provides SSL support, but other
1814 * modules provide SSL support too, all the modules supporting SSL should
1815 * publish an identical 'SSL' feature. This way, any module requiring use
1816 * of SSL functions can just look up the 'SSL' feature using FindFeature,
1817 * then use the module pointer they are given.
1818 * @param FeatureName The case sensitive feature name to make available
1819 * @param Mod a pointer to your module class
1820 * @returns True on success, false if the feature is already published by
1823 bool PublishFeature(const std::string &FeatureName, Module* Mod);
1825 /** Publish a module to an 'interface'.
1826 * Modules which implement the same interface (the same way of communicating
1827 * with other modules) can publish themselves to an interface, using this
1828 * method. When they do so, they become part of a list of related or
1829 * compatible modules, and a third module may then query for that list
1830 * and know that all modules within that list offer the same API.
1831 * A prime example of this is the hashing modules, which all accept the
1832 * same types of Request class. Consider this to be similar to PublishFeature,
1833 * except for that multiple modules may publish the same 'feature'.
1834 * @param InterfaceName The case sensitive interface name to make available
1835 * @param Mod a pointer to your module class
1836 * @returns True on success, false on failure (there are currently no failure
1839 bool PublishInterface(const std::string &InterfaceName, Module* Mod);
1841 /** Return a pair saying how many other modules are currently using the
1842 * interfaces provided by module m.
1843 * @param m The module to count usage for
1844 * @return A pair, where the first value is the number of uses of the interface,
1845 * and the second value is the interface name being used.
1847 std::pair<int,std::string> GetInterfaceInstanceCount(Module* m);
1849 /** Mark your module as using an interface.
1850 * If you mark your module as using an interface, then that interface
1851 * module may not unload until your module has unloaded first.
1852 * This can be used to prevent crashes by ensuring code you depend on
1853 * is always in memory while your module is active.
1854 * @param InterfaceName The interface to use
1856 void UseInterface(const std::string &InterfaceName);
1858 /** Mark your module as finished with an interface.
1859 * If you used UseInterface() above, you should use this method when
1860 * your module is finished with the interface (usually in its destructor)
1861 * to allow the modules which implement the given interface to be unloaded.
1862 * @param InterfaceName The interface you are finished with using.
1864 void DoneWithInterface(const std::string &InterfaceName);
1866 /** Unpublish a 'feature'.
1867 * When your module exits, it must call this method for every feature it
1868 * is providing so that the feature table is cleaned up.
1869 * @param FeatureName the feature to remove
1871 bool UnpublishFeature(const std::string &FeatureName);
1873 /** Unpublish your module from an interface
1874 * When your module exits, it must call this method for every interface
1875 * it is part of so that the interfaces table is cleaned up. Only when
1876 * the last item is deleted from an interface does the interface get
1878 * @param InterfaceName the interface to be removed from
1879 * @param Mod The module to remove from the interface list
1881 bool UnpublishInterface(const std::string &InterfaceName, Module* Mod);
1883 /** Find a 'feature'.
1884 * There are two ways for a module to find another module it depends on.
1885 * Either by name, using InspIRCd::FindModule, or by feature, using the
1886 * InspIRCd::PublishFeature method. A feature is an arbitary string which
1887 * identifies something this module can do. For example, if your module
1888 * provides SSL support, but other modules provide SSL support too, all
1889 * the modules supporting SSL should publish an identical 'SSL' feature.
1890 * To find a module capable of providing the feature you want, simply
1891 * call this method with the feature name you are looking for.
1892 * @param FeatureName The feature name you wish to obtain the module for
1893 * @returns A pointer to a valid module class on success, NULL on failure.
1895 Module* FindFeature(const std::string &FeatureName);
1897 /** Find an 'interface'.
1898 * An interface is a list of modules which all implement the same API.
1899 * @param InterfaceName The Interface you wish to obtain the module
1901 * @return A pointer to a deque of Module*, or NULL if the interface
1904 modulelist* FindInterface(const std::string &InterfaceName);
1906 /** Determine if a module has published the named interface.
1907 * This could be used in, for example, OnLoadModule to pick up other modules that can be used.
1908 * @param mod The module to check.
1909 * @param InterfaceName the interface you want to check for
1910 * @return True if the module provides the interface, false otherwise.
1912 bool ModuleHasInterface(Module* mod, const std::string& InterfaceName);
1914 /** Given a pointer to a Module, return its filename
1915 * @param m The module pointer to identify
1916 * @return The module name or an empty string
1918 const std::string& GetModuleName(Module* m);
1920 /** Return a list of all modules matching the given filter
1921 * @param filter This int is a bitmask of flags set in Module::Flags,
1922 * such as VF_VENDOR or VF_STATIC. If you wish to receive a list of
1923 * all modules with no filtering, set this to 0.
1924 * @return The list of module names
1926 const std::vector<std::string> GetAllModuleNames(int filter);
1929 /** This definition is used as shorthand for the various classes
1930 * and functions needed to make a module loadable by the OS.
1931 * It defines the class factory and external init_module function.
1935 #define MODULE_INIT(y) \
1936 extern "C" DllExport Module * init_module(InspIRCd* Me) \
1940 BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
1942 switch ( nReason ) \
1944 case DLL_PROCESS_ATTACH: \
1945 case DLL_PROCESS_DETACH: \
1953 #define MODULE_INIT(y) \
1954 extern "C" DllExport Module * init_module(InspIRCd* Me) \