2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2006-2007, 2009 Dennis Friis <peavey@inspircd.org>
6 * Copyright (C) 2003-2008 Craig Edwards <craigedwards@brainbox.cc>
7 * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
8 * Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
9 * Copyright (C) 2006-2007 Oliver Lupton <oliverlupton@gmail.com>
10 * Copyright (C) 2003 randomdan <???@???>
12 * This file is part of InspIRCd. InspIRCd is free software: you can
13 * redistribute it and/or modify it under the terms of the GNU General Public
14 * License as published by the Free Software Foundation, version 2.
16 * This program is distributed in the hope that it will be useful, but WITHOUT
17 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
18 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
31 #include "inspsocket.h"
38 /** Used to define a set of behavior bits for a module
41 VF_NONE = 0, // module is not special at all
42 VF_STATIC = 1, // module is static, cannot be /unloadmodule'd
43 VF_VENDOR = 2, // module is a vendor module (came in the original tarball, not 3rd party)
44 VF_COMMON = 4, // module needs to be common on all servers in a network to link
45 VF_OPTCOMMON = 8, // module should be common on all servers for unsurprising behavior
46 VF_CORE = 16 // module is a core command, can be assumed loaded on all servers
49 /** Used to represent an event type, for user, channel or server
51 enum TargetTypeFlags {
58 /** Used to represent wether a message was PRIVMSG or NOTICE
65 #define MOD_RES_ALLOW (ModResult(1))
66 #define MOD_RES_PASSTHRU (ModResult(0))
67 #define MOD_RES_DENY (ModResult(-1))
69 /** Used to represent an allow/deny module result.
70 * Not constructed as an enum because it reverses the value logic of some functions;
71 * the compiler will inline accesses to have the same efficiency as integer operations.
75 ModResult() : res(0) {}
76 explicit ModResult(int r) : res(r) {}
77 inline bool operator==(const ModResult& r) const
81 inline bool operator!=(const ModResult& r) const
85 inline bool operator!() const
89 inline bool check(bool def) const
91 return (res == 1 || (res == 0 && def));
94 * Merges two results, preferring ALLOW to DENY
96 inline ModResult operator+(const ModResult& r) const
98 if (res == r.res || r.res == 0)
102 // they are different, and neither is passthru
103 return MOD_RES_ALLOW;
107 /** InspIRCd major version.
108 * 1.2 -> 102; 2.1 -> 201; 2.12 -> 212
110 #define INSPIRCD_VERSION_MAJ 202
111 /** InspIRCd API version.
112 * If you change any API elements, increment this value. This counter should be
113 * reset whenever the major version is changed. Modules can use these two values
114 * and numerical comparisons in preprocessor macros if they wish to support
115 * multiple versions of InspIRCd in one file.
117 #define INSPIRCD_VERSION_API 1
120 * This #define allows us to call a method in all
121 * loaded modules in a readable simple way, e.g.:
122 * 'FOREACH_MOD(I_OnConnect,OnConnect(user));'
124 #define FOREACH_MOD(y,x) do { \
125 EventHandlerIter safei; \
126 for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ) \
134 catch (CoreException& modexcept) \
136 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, "Exception caught: %s",modexcept.GetReason()); \
143 * Custom module result handling loop. This is a paired macro, and should only
144 * be used with while_each_hook.
146 * See src/channels.cpp for an example of use.
148 #define DO_EACH_HOOK(n,v,args) \
150 EventHandlerIter iter_ ## n = ServerInstance->Modules->EventHandlers[I_ ## n].begin(); \
151 while (iter_ ## n != ServerInstance->Modules->EventHandlers[I_ ## n].end()) \
153 Module* mod_ ## n = *iter_ ## n; \
157 v = (mod_ ## n)->n args;
159 #define WHILE_EACH_HOOK(n) \
161 catch (CoreException& except_ ## n) \
163 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, "Exception caught: %s", (except_ ## n).GetReason()); \
164 (void) mod_ ## n; /* catch mismatched pairs */ \
170 * Module result iterator
171 * Runs the given hook until some module returns a useful result.
173 * Example: ModResult result;
174 * FIRST_MOD_RESULT(OnUserPreNick, result, (user, newnick))
176 #define FIRST_MOD_RESULT(n,v,args) do { \
177 v = MOD_RES_PASSTHRU; \
178 DO_EACH_HOOK(n,v,args) \
180 if (v != MOD_RES_PASSTHRU) \
183 WHILE_EACH_HOOK(n); \
186 /** Holds a module's Version information.
187 * The members (set by the constructor only) indicate details as to the version number
188 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
190 class CoreExport Version
193 /** Module description
195 const std::string description;
201 /** Server linking description string */
202 const std::string link_data;
204 /** Simple module version */
205 Version(const std::string &desc, int flags = VF_NONE);
207 /** Complex version information, including linking compatability data */
208 Version(const std::string &desc, int flags, const std::string& linkdata);
210 virtual ~Version() {}
213 /** The Request class is a unicast message directed at a given module.
214 * When this class is properly instantiated it may be sent to a module
215 * using the Send() method, which will call the given module's OnRequest
216 * method with this class as its parameter.
218 class CoreExport Request : public classbase
221 /** This should be a null-terminated string identifying the type of request,
222 * all modules should define this and use it to determine the nature of the
223 * request before they attempt to cast the Request in any way.
225 const char* const id;
226 /** This is a pointer to the sender of the message, which can be used to
227 * directly trigger events, or to create a reply.
230 /** The single destination of the Request
234 /** Create a new Request
235 * This is for the 'new' way of defining a subclass
236 * of Request and defining it in a common header,
237 * passing an object of your Request subclass through
238 * as a Request* and using the ID string to determine
239 * what to cast it back to and the other end.
241 Request(Module* src, Module* dst, const char* idstr);
242 /** Send the Request.
248 /** The Event class is a unicast message directed at all modules.
249 * When the class is properly instantiated it may be sent to all modules
250 * using the Send() method, which will trigger the OnEvent method in
251 * all modules passing the object as its parameter.
253 class CoreExport Event : public classbase
256 /** This is a pointer to the sender of the message, which can be used to
257 * directly trigger events, or to create a reply.
260 /** The event identifier.
261 * This is arbitary text which should be used to distinguish
262 * one type of event from another.
264 const std::string id;
266 /** Create a new Event
268 Event(Module* src, const std::string &eventid);
270 * The return result of an Event::Send() will always be NULL as
271 * no replies are expected.
276 class CoreExport DataProvider : public ServiceProvider
279 DataProvider(Module* Creator, const std::string& Name)
280 : ServiceProvider(Creator, Name, SERVICE_DATA) {}
283 class CoreExport dynamic_reference_base : public interfacebase
289 ServiceProvider* value;
292 dynamic_reference_base(Module* Creator, const std::string& Name);
293 ~dynamic_reference_base();
294 inline const std::string& GetProvider() { return name; }
295 void SetProvider(const std::string& newname);
297 operator bool() { return (value != NULL); }
298 static void reset_all();
301 inline void dynamic_reference_base::check()
304 throw ModuleException("Dynamic reference to '" + name + "' failed to resolve");
308 class dynamic_reference : public dynamic_reference_base
311 dynamic_reference(Module* Creator, const std::string& Name)
312 : dynamic_reference_base(Creator, Name) {}
314 inline T* operator->()
317 return static_cast<T*>(value);
327 class dynamic_reference_nocheck : public dynamic_reference_base
330 dynamic_reference_nocheck(Module* Creator, const std::string& Name)
331 : dynamic_reference_base(Creator, Name) {}
335 return static_cast<T*>(value);
344 class ModeReference : public dynamic_reference_nocheck<ModeHandler>
347 ModeReference(Module* mod, const std::string& modename)
348 : dynamic_reference_nocheck<ModeHandler>(mod, "mode/" + modename) {}
351 /** Priority types which can be used by Module::Prioritize()
353 enum Priority { PRIORITY_FIRST, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
355 /** Implementation-specific flags which may be set in Module::Implements()
360 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash,
361 I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois,
362 I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNick,
363 I_OnUserMessage, I_OnMode, I_OnGetServerDescription, I_OnSyncUser,
364 I_OnSyncChannel, I_OnDecodeMetaData, I_OnAcceptConnection, I_OnUserInit,
365 I_OnChangeHost, I_OnChangeName, I_OnAddLine, I_OnDelLine, I_OnExpireLine,
366 I_OnUserPostNick, I_OnPreMode, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule,
367 I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite,
368 I_OnRawMode, I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckChannelBan, I_OnExtBanCheck,
369 I_OnStats, I_OnChangeLocalUserHost, I_OnPreTopicChange,
370 I_OnPostTopicChange, I_OnEvent, I_OnGlobalOper, I_OnPostConnect,
371 I_OnChangeLocalUserGECOS, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
372 I_OnPostOper, I_OnSyncNetwork, I_OnSetAway, I_OnPostCommand, I_OnPostJoin,
373 I_OnWhoisLine, I_OnBuildNeighborList, I_OnGarbageCollect, I_OnSetConnectClass,
374 I_OnText, I_OnPassCompare, I_OnRunTestSuite, I_OnNamesListItem, I_OnNumeric, I_OnHookIO,
375 I_OnPreRehash, I_OnModuleRehash, I_OnSendWhoLine, I_OnChangeIdent, I_OnSetUserIP,
379 /** Base class for all InspIRCd modules
380 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
381 * its methods will be called when irc server events occur. class inherited from module must be
382 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
384 class CoreExport Module : public classbase, public usecountbase
387 /** File that this module was loaded from
389 std::string ModuleSourceFile;
390 /** Reference to the dlopen() value
392 DLLManager* ModuleDLLManager;
394 /** If true, this module will be unloaded soon, further unload attempts will fail
395 * Value is used by the ModuleManager internally, you should not modify it
399 /** Default constructor.
400 * Creates a module class. Don't do any type of hook registration or checks
401 * for other modules here; do that in init().
406 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
408 virtual void init() {}
410 /** Clean up prior to destruction
411 * If you override, you must call this AFTER your module's cleanup
413 virtual CullResult cull();
415 /** Default destructor.
416 * destroys a module class
420 virtual void Prioritize()
424 /** Returns the version number of a Module.
425 * The method should return a Version object with its version information assigned via
428 virtual Version GetVersion() = 0;
430 /** Called when a user connects.
431 * The details of the connecting user are available to you in the parameter User *user
432 * @param user The user who is connecting
434 virtual void OnUserConnect(LocalUser* user);
436 /** Called when a user quits.
437 * The details of the exiting user are available to you in the parameter User *user
438 * This event is only called when the user is fully registered when they quit. To catch
439 * raw disconnections, use the OnUserDisconnect method.
440 * @param user The user who is quitting
441 * @param message The user's quit message (as seen by non-opers)
442 * @param oper_message The user's quit message (as seen by opers)
444 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
446 /** Called whenever a user's socket is closed.
447 * The details of the exiting user are available to you in the parameter User *user
448 * This event is called for all users, registered or not, as a cleanup method for modules
449 * which might assign resources to user, such as dns lookups, objects and sockets.
450 * @param user The user who is disconnecting
452 virtual void OnUserDisconnect(LocalUser* user);
454 /** Called whenever a channel is about to be deleted
455 * @param chan The channel being deleted
456 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
458 virtual ModResult OnChannelPreDelete(Channel *chan);
460 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
461 * @param chan The channel being deleted
463 virtual void OnChannelDelete(Channel* chan);
465 /** Called when a user joins a channel.
466 * The details of the joining user are available to you in the parameter User *user,
467 * and the details of the channel they have joined is available in the variable Channel *channel
468 * @param memb The channel membership being created
469 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
470 * to a channel due to the network sync.
471 * @param created This is true if the join created the channel
472 * @param except_list A list of users not to send to.
474 virtual void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list);
476 /** Called after a user joins a channel
477 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
479 * @param memb The channel membership created
481 virtual void OnPostJoin(Membership* memb);
483 /** Called when a user parts a channel.
484 * The details of the leaving user are available to you in the parameter User *user,
485 * and the details of the channel they have left is available in the variable Channel *channel
486 * @param memb The channel membership being destroyed
487 * @param partmessage The part message, or an empty string (may be modified)
488 * @param except_list A list of users to not send to.
490 virtual void OnUserPart(Membership* memb, std::string &partmessage, CUList& except_list);
492 /** Called on rehash.
493 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
494 * system. This is called in all cases -- including when this server will not execute the
495 * rehash because it is directed at a remote server.
497 * @param user The user performing the rehash, if any. If this is server initiated, the value of
498 * this variable will be NULL.
499 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
502 virtual void OnPreRehash(User* user, const std::string ¶meter);
504 /** Called on rehash.
505 * This method is called when a user initiates a module-specific rehash. This can be used to do
506 * expensive operations (such as reloading SSL certificates) that are not executed on a normal
507 * rehash for efficiency. A rehash of this type does not reload the core configuration.
509 * @param user The user performing the rehash.
510 * @param parameter The parameter given to REHASH
512 virtual void OnModuleRehash(User* user, const std::string ¶meter);
514 /** Called on rehash.
515 * This method is called after a rehash has completed. You should use it to reload any module
516 * configuration from the main configuration file.
517 * @param user The user that performed the rehash, if it was initiated by a user and that user
518 * is still connected.
520 virtual void OnRehash(User* user);
522 /** Called whenever a snotice is about to be sent to a snomask.
523 * snomask and type may both be modified; the message may not.
524 * @param snomask The snomask the message is going to (e.g. 'A')
525 * @param type The textual description the snomask will go to (e.g. 'OPER')
526 * @param message The text message to be sent via snotice
527 * @return 1 to block the snotice from being sent entirely, 0 else.
529 virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
531 /** Called whenever a user is about to join a channel, before any processing is done.
532 * Returning a value of 1 from this function stops the process immediately, causing no
533 * output to be sent to the user by the core. If you do this you must produce your own numerics,
534 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
535 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
539 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
540 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
541 * processing on the actual channel record at this point, however the channel NAME will still be passed in
542 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
543 * @param user The user joining the channel
544 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
545 * @param cname The channel name being joined. For new channels this is valid where chan is not.
546 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "o".
547 * You may alter this string to alter the user's modes on the channel.
548 * @param keygiven The key given to join the channel, or an empty string if none was provided
549 * @return 1 To prevent the join, 0 to allow it.
551 virtual ModResult OnUserPreJoin(LocalUser* user, Channel* chan, const std::string& cname, std::string& privs, const std::string& keygiven);
553 /** Called whenever a user is about to be kicked.
554 * Returning a value of 1 from this function stops the process immediately, causing no
555 * output to be sent to the user by the core. If you do this you must produce your own numerics,
557 * @param source The user issuing the kick
558 * @param memb The channel membership of the user who is being kicked.
559 * @param reason The kick reason
560 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
562 virtual ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason);
564 /** Called whenever a user is kicked.
565 * If this method is called, the kick is already underway and cannot be prevented, so
566 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
567 * @param source The user issuing the kick
568 * @param memb The channel membership of the user who was kicked.
569 * @param reason The kick reason
570 * @param except_list A list of users to not send to.
572 virtual void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except_list);
574 /** Called whenever a user opers locally.
575 * The User will contain the oper mode 'o' as this function is called after any modifications
576 * are made to the user's structure by the core.
577 * @param user The user who is opering up
578 * @param opertype The opers type name
580 virtual void OnOper(User* user, const std::string &opertype);
582 /** Called after a user opers locally.
583 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
584 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
585 * out the OPERTYPE, etc.
586 * @param user The user who is opering up
587 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
588 * @param opertype The opers type name
590 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
592 /** Called whenever a user types /INFO.
593 * The User will contain the information of the user who typed the command. Modules may use this
594 * method to output their own credits in /INFO (which is the ircd's version of an about box).
595 * It is purposefully not possible to modify any info that has already been output, or halt the list.
596 * You must write a 371 numeric to the user, containing your info in the following format:
598 * <nick> :information here
600 * @param user The user issuing /INFO
602 virtual void OnInfo(User* user);
604 /** Called whenever a /WHOIS is performed on a local user.
605 * The source parameter contains the details of the user who issued the WHOIS command, and
606 * the dest parameter contains the information of the user they are whoising.
607 * @param source The user issuing the WHOIS command
608 * @param dest The user who is being WHOISed
610 virtual void OnWhois(User* source, User* dest);
612 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
613 * Returning 1 from this function stops the process immediately, causing no
614 * output to be sent to the user by the core. If you do this you must produce your own numerics,
615 * notices etc. This is useful for modules which may want to filter invites to channels.
616 * @param source The user who is issuing the INVITE
617 * @param dest The user being invited
618 * @param channel The channel the user is being invited to
619 * @param timeout The time the invite will expire (0 == never)
620 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
622 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
624 /** Called after a user has been successfully invited to a channel.
625 * You cannot prevent the invite from occuring using this function, to do that,
626 * use OnUserPreInvite instead.
627 * @param source The user who is issuing the INVITE
628 * @param dest The user being invited
629 * @param channel The channel the user is being invited to
630 * @param timeout The time the invite will expire (0 == never)
632 virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout);
634 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
635 * Returning any nonzero value from this function stops the process immediately, causing no
636 * output to be sent to the user by the core. If you do this you must produce your own numerics,
637 * notices etc. This is useful for modules which may want to filter or redirect messages.
638 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
639 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
640 * of where the message is destined to be sent.
641 * @param user The user sending the message
642 * @param dest The target of the message (Channel* or User*)
643 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
644 * @param text Changeable text being sent by the user
645 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
646 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
647 * It will be ignored for private messages.
648 * @param msgtype The message type, MSG_PRIVMSG for PRIVMSGs, MSG_NOTICE for NOTICEs
649 * @return 1 to deny the message, 0 to allow it
651 virtual ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list, MessageType msgtype);
653 /** Called when sending a message to all "neighbors" of a given user -
654 * that is, all users that share a common channel. This is used in
655 * commands such as NICK, QUIT, etc.
656 * @param source The source of the message
657 * @param include_c Channels to scan for users to include
658 * @param exceptions Map of user->bool that overrides the inclusion decision
660 * Set exceptions[user] = true to include, exceptions[user] = false to exclude
662 virtual void OnBuildNeighborList(User* source, UserChanList &include_c, std::map<User*,bool> &exceptions);
664 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
665 * Please note that although you can see remote nickchanges through this function, you should
666 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
667 * check user->server before taking any action (including returning nonzero from the method).
668 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
669 * module to generate some meaninful output.
670 * @param user The username changing their nick
671 * @param newnick Their new nickname
672 * @return 1 to deny the change, 0 to allow
674 virtual ModResult OnUserPreNick(User* user, const std::string &newnick);
676 /** Called after any PRIVMSG sent from a user.
677 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
678 * if target_type is TYPE_CHANNEL.
679 * @param user The user sending the message
680 * @param dest The target of the message
681 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
682 * @param text the text being sent by the user
683 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
684 * @param exempt_list A list of users to not send to.
685 * @param msgtype The message type, MSG_PRIVMSG for PRIVMSGs, MSG_NOTICE for NOTICEs
687 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list, MessageType msgtype);
689 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
690 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
691 * if target_type is TYPE_CHANNEL.
692 * The difference between this event and OnUserPreMessage is that delivery is gauranteed,
693 * the message has already been vetted. In the case of the other two methods, a later module may stop your
694 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
695 * @param user The user sending the message
696 * @param dest The target of the message
697 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
698 * @param text the text being sent by the user
699 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
700 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
702 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
704 /** Called after every MODE command sent from a user
705 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
706 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
707 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
708 * @param user The user sending the MODEs
709 * @param dest The target of the modes (User* or Channel*)
710 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
711 * @param text The actual modes and their parameters if any
712 * @param translate The translation types of the mode parameters
714 virtual void OnMode(User* user, void* dest, int target_type, const std::vector<std::string> &text, const std::vector<TranslateType> &translate);
716 /** Allows modules to alter or create server descriptions
717 * Whenever a module requires a server description, for example for display in
718 * WHOIS, this function is called in all modules. You may change or define the
719 * description given in std::string &description. If you do, this description
720 * will be shown in the WHOIS fields.
721 * @param servername The servername being searched for
722 * @param description Alterable server description for this server
724 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
726 /** Allows modules to synchronize data which relates to users during a netburst.
727 * When this function is called, it will be called from the module which implements
728 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
729 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
730 * (see below). This function will be called for every user visible on your side
731 * of the burst, allowing you to for example set modes, etc. Do not use this call to
732 * synchronize data which you have stored using class Extensible -- There is a specialist
733 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
734 * @param user The user being syncronized
735 * @param proto A pointer to the module handling network protocol
736 * @param opaque An opaque pointer set by the protocol module, should not be modified!
738 virtual void OnSyncUser(User* user, Module* proto, void* opaque);
740 /** Allows modules to synchronize data which relates to channels during a netburst.
741 * When this function is called, it will be called from the module which implements
742 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
743 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
744 * (see below). This function will be called for every user visible on your side
745 * of the burst, allowing you to for example set modes, etc.
747 * @param chan The channel being syncronized
748 * @param proto A pointer to the module handling network protocol
749 * @param opaque An opaque pointer set by the protocol module, should not be modified!
751 virtual void OnSyncChannel(Channel* chan, Module* proto, void* opaque);
753 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
754 * Whenever the linking module wants to send out data, but doesnt know what the data
755 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
756 * this method is called. You should use the ProtoSendMetaData function after you've
757 * correctly decided how the data should be represented, to send the metadata on its way if
758 * if it belongs to your module.
759 * @param proto A pointer to the module handling network protocol
760 * @param opaque An opaque pointer set by the protocol module, should not be modified!
761 * @param displayable If this value is true, the data is going to be displayed to a user,
762 * and not sent across the network. Use this to determine wether or not to show sensitive data.
764 virtual void OnSyncNetwork(Module* proto, void* opaque);
766 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
767 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
768 * @param target The Channel* or User* that data should be added to
769 * @param extname The extension name which is being sent
770 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
772 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
774 /** Implemented by modules which provide the ability to link servers.
775 * These modules will implement this method, which allows transparent sending of servermodes
776 * down the network link as a broadcast, without a module calling it having to know the format
777 * of the MODE command before the actual mode string.
779 * @param opaque An opaque pointer set by the protocol module, should not be modified!
780 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
781 * @param target The Channel* or User* that modes should be sent for
782 * @param modeline The modes and parameters to be sent
783 * @param translate The translation types of the mode parameters
785 virtual void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::vector<std::string> &modeline, const std::vector<TranslateType> &translate);
787 /** Implemented by modules which provide the ability to link servers.
788 * These modules will implement this method, which allows metadata (extra data added to
789 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
790 * to other servers on a netburst and decoded at the other end by the same module on a
793 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
794 * how to use this function.
795 * @param opaque An opaque pointer set by the protocol module, should not be modified!
796 * @param target The Channel* or User* that metadata should be sent for
797 * @param extname The extension name to send metadata for
798 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
800 virtual void ProtoSendMetaData(void* opaque, Extensible* target, const std::string &extname, const std::string &extdata);
802 /** Called whenever a user's hostname is changed.
803 * This event triggers after the host has been set.
804 * @param user The user whos host is being changed
805 * @param newhost The new hostname being set
807 virtual void OnChangeHost(User* user, const std::string &newhost);
809 /** Called whenever a user's GECOS (realname) is changed.
810 * This event triggers after the name has been set.
811 * @param user The user who's GECOS is being changed
812 * @param gecos The new GECOS being set on the user
814 virtual void OnChangeName(User* user, const std::string &gecos);
816 /** Called whenever a user's IDENT is changed.
817 * This event triggers after the name has been set.
818 * @param user The user who's IDENT is being changed
819 * @param ident The new IDENT being set on the user
821 virtual void OnChangeIdent(User* user, const std::string &ident);
823 /** Called whenever an xline is added by a local user.
824 * This method is triggered after the line is added.
825 * @param source The sender of the line or NULL for local server
826 * @param line The xline being added
828 virtual void OnAddLine(User* source, XLine* line);
830 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
831 * This method is triggered after the line is deleted.
832 * @param source The user removing the line or NULL for local server
833 * @param line the line being deleted
835 virtual void OnDelLine(User* source, XLine* line);
837 /** Called whenever an xline expires.
838 * This method is triggered after the line is deleted.
839 * @param line The line being deleted.
841 virtual void OnExpireLine(XLine *line);
843 /** Called before your module is unloaded to clean up Extensibles.
844 * This method is called once for every user and channel on the network,
845 * so that when your module unloads it may clear up any remaining data
846 * in the form of Extensibles added using Extensible::Extend().
847 * If the target_type variable is TYPE_USER, then void* item refers to
848 * a User*, otherwise it refers to a Channel*.
849 * @param target_type The type of item being cleaned
850 * @param item A pointer to the item's class
852 virtual void OnCleanup(int target_type, void* item);
854 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
855 * have been applied. Please note that although you can see remote nickchanges through this function, you should
856 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
857 * check user->server before taking any action (including returning nonzero from the method).
858 * Because this method is called after the nickchange is taken place, no return values are possible
859 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
860 * @param user The user changing their nick
861 * @param oldnick The old nickname of the user before the nickchange
863 virtual void OnUserPostNick(User* user, const std::string &oldnick);
865 /** Called before any mode change, to allow a single access check for
866 * a full mode change (use OnRawMode to check individual modes)
868 * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
869 * OnRawMode for each individual mode
871 * @param source the user making the mode change
872 * @param dest the user destination of the umode change (NULL if a channel mode)
873 * @param channel the channel destination of the mode change
874 * @param parameters raw mode parameters; parameters[0] is the user/channel being changed
876 virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, const std::vector<std::string>& parameters);
878 /** Called when a 005 numeric is about to be output.
879 * The module should modify the 005 numeric if needed to indicate its features.
880 * @param output The 005 map to be modified if neccessary.
882 virtual void On005Numeric(std::map<std::string, std::string>& tokens);
884 /** Called when a client is disconnected by KILL.
885 * If a client is killed by a server, e.g. a nickname collision or protocol error,
887 * Return 1 from this function to prevent the kill, and 0 from this function to allow
888 * it as normal. If you prevent the kill no output will be sent to the client, it is
889 * down to your module to generate this information.
890 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
891 * If you do so youre risking race conditions, desyncs and worse!
892 * @param source The user sending the KILL
893 * @param dest The user being killed
894 * @param reason The kill reason
895 * @return 1 to prevent the kill, 0 to allow
897 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
899 /** Called when an oper wants to disconnect a remote user via KILL
900 * @param source The user sending the KILL
901 * @param dest The user being killed
902 * @param reason The kill reason
903 * @param operreason The oper kill reason
905 virtual void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
907 /** Called whenever a module is loaded.
908 * mod will contain a pointer to the module, and string will contain its name,
909 * for example m_widgets.so. This function is primary for dependency checking,
910 * your module may decide to enable some extra features if it sees that you have
911 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
912 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
913 * but instead operate under reduced functionality, unless the dependency is
914 * absolutely neccessary (e.g. a module that extends the features of another
916 * @param mod A pointer to the new module
918 virtual void OnLoadModule(Module* mod);
920 /** Called whenever a module is unloaded.
921 * mod will contain a pointer to the module, and string will contain its name,
922 * for example m_widgets.so. This function is primary for dependency checking,
923 * your module may decide to enable some extra features if it sees that you have
924 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
925 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
926 * but instead operate under reduced functionality, unless the dependency is
927 * absolutely neccessary (e.g. a module that extends the features of another
929 * @param mod Pointer to the module being unloaded (still valid)
931 virtual void OnUnloadModule(Module* mod);
933 /** Called once every five seconds for background processing.
934 * This timer can be used to control timed features. Its period is not accurate
935 * enough to be used as a clock, but it is gauranteed to be called at least once in
936 * any five second period, directly from the main loop of the server.
937 * @param curtime The current timer derived from time(2)
939 virtual void OnBackgroundTimer(time_t curtime);
941 /** Called whenever any command is about to be executed.
942 * This event occurs for all registered commands, wether they are registered in the core,
943 * or another module, and for invalid commands. Invalid commands may only be sent to this
944 * function when the value of validated is false. By returning 1 from this method you may prevent the
945 * command being executed. If you do this, no output is created by the core, and it is
946 * down to your module to produce any output neccessary.
947 * Note that unless you return 1, you should not destroy any structures (e.g. by using
948 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
949 * method returns, it will be passed an invalid pointer to the user object and crash!)
950 * @param command The command being executed
951 * @param parameters An array of array of characters containing the parameters for the command
952 * @param user the user issuing the command
953 * @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.
954 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
955 * @param original_line The entire original line as passed to the parser from the user
956 * @return 1 to block the command, 0 to allow
958 virtual ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, LocalUser *user, bool validated, const std::string &original_line);
960 /** Called after any command has been executed.
961 * This event occurs for all registered commands, wether they are registered in the core,
962 * or another module, but it will not occur for invalid commands (e.g. ones which do not
963 * exist within the command table). The result code returned by the command handler is
965 * @param command The command being executed
966 * @param parameters An array of array of characters containing the parameters for the command
967 * @param user the user issuing the command
968 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
969 * @param original_line The entire original line as passed to the parser from the user
971 virtual void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, LocalUser *user, CmdResult result, const std::string &original_line);
973 /** Called when a user is first connecting, prior to starting DNS lookups, checking initial
974 * connect class, or accepting any commands.
976 virtual void OnUserInit(LocalUser* user);
978 /** Called to check if a user who is connecting can now be allowed to register
979 * If any modules return false for this function, the user is held in the waiting
980 * state until all modules return true. For example a module which implements ident
981 * lookups will continue to return false for a user until their ident lookup is completed.
982 * Note that the registration timeout for a user overrides these checks, if the registration
983 * timeout is reached, the user is disconnected even if modules report that the user is
984 * not ready to connect.
985 * @param user The user to check
986 * @return true to indicate readiness, false if otherwise
988 virtual ModResult OnCheckReady(LocalUser* user);
990 /** Called whenever a user is about to register their connection (e.g. before the user
991 * is sent the MOTD etc). Modules can use this method if they are performing a function
992 * which must be done before the actual connection is completed (e.g. ident lookups,
993 * dnsbl lookups, etc).
994 * Note that you should NOT delete the user record here by causing a disconnection!
995 * Use OnUserConnect for that instead.
996 * @param user The user registering
997 * @return 1 to indicate user quit, 0 to continue
999 virtual ModResult OnUserRegister(LocalUser* user);
1001 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1002 * This method will always be called for each join, wether or not the channel is actually +i, and
1003 * determines the outcome of an if statement around the whole section of invite checking code.
1004 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1005 * @param user The user joining the channel
1006 * @param chan The channel being joined
1007 * @return 1 to explicitly allow the join, 0 to proceed as normal
1009 virtual ModResult OnCheckInvite(User* user, Channel* chan);
1011 /** Called whenever a mode character is processed.
1012 * Return 1 from this function to block the mode character from being processed entirely.
1013 * @param user The user who is sending the mode
1014 * @param chan The channel the mode is being sent to (or NULL if a usermode)
1015 * @param mode The mode character being set
1016 * @param param The parameter for the mode or an empty string
1017 * @param adding true of the mode is being added, false if it is being removed
1018 * @param pcnt The parameter count for the mode (0 or 1)
1019 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
1020 * to skip all permission checking. Please note that for remote mode changes, your return value
1023 virtual ModResult OnRawMode(User* user, Channel* chan, const char mode, const std::string ¶m, bool adding, int pcnt);
1025 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1026 * This method will always be called for each join, wether or not the channel is actually +k, and
1027 * determines the outcome of an if statement around the whole section of key checking code.
1028 * if the user specified no key, the keygiven string will be a valid but empty value.
1029 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1030 * @param user The user joining the channel
1031 * @param chan The channel being joined
1032 * @param keygiven The key given on joining the channel.
1033 * @return 1 to explicitly allow the join, 0 to proceed as normal
1035 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
1037 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1038 * This method will always be called for each join, wether or not the channel is actually +l, and
1039 * determines the outcome of an if statement around the whole section of channel limit checking code.
1040 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1041 * @param user The user joining the channel
1042 * @param chan The channel being joined
1043 * @return 1 to explicitly allow the join, 0 to proceed as normal
1045 virtual ModResult OnCheckLimit(User* user, Channel* chan);
1048 * Checks for a user's ban from the channel
1049 * @param user The user to check
1050 * @param chan The channel to check in
1051 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1052 * ban check, or MOD_RES_PASSTHRU to check bans normally
1054 virtual ModResult OnCheckChannelBan(User* user, Channel* chan);
1057 * Checks for a user's match of a single ban
1058 * @param user The user to check for match
1059 * @param chan The channel on which the match is being checked
1060 * @param mask The mask being checked
1061 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1062 * ban check, or MOD_RES_PASSTHRU to check bans normally
1064 virtual ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask);
1066 /** Checks for a match on a given extban type
1067 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1068 * ban check, or MOD_RES_PASSTHRU to check bans normally
1070 virtual ModResult OnExtBanCheck(User* user, Channel* chan, char type);
1072 /** Called on all /STATS commands
1073 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1074 * @param symbol the symbol provided to /STATS
1075 * @param user the user issuing the /STATS command
1076 * @param results A string_list to append results into. You should put all your results
1077 * into this string_list, rather than displaying them directly, so that your handler will
1078 * work when remote STATS queries are received.
1079 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1081 virtual ModResult OnStats(char symbol, User* user, string_list &results);
1083 /** Called whenever a change of a local users displayed host is attempted.
1084 * Return 1 to deny the host change, or 0 to allow it.
1085 * @param user The user whos host will be changed
1086 * @param newhost The new hostname
1087 * @return 1 to deny the host change, 0 to allow
1089 virtual ModResult OnChangeLocalUserHost(LocalUser* user, const std::string &newhost);
1091 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1092 * return 1 to deny the name change, or 0 to allow it.
1093 * @param user The user whos GECOS will be changed
1094 * @param newhost The new GECOS
1095 * @return 1 to deny the GECOS change, 0 to allow
1097 virtual ModResult OnChangeLocalUserGECOS(LocalUser* user, const std::string &newhost);
1099 /** Called before a topic is changed.
1100 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
1101 * As with other 'pre' events, you should only ever block a local event.
1102 * @param user The user changing the topic
1103 * @param chan The channels who's topic is being changed
1104 * @param topic The actual topic text
1105 * @return 1 to block the topic change, 0 to allow
1107 virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
1109 /** Called whenever a topic has been changed.
1110 * To block topic changes you must use OnPreTopicChange instead.
1111 * @param user The user changing the topic
1112 * @param chan The channels who's topic is being changed
1113 * @param topic The actual topic text
1115 virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
1117 /** Called whenever an Event class is sent to all modules by another module.
1118 * You should *always* check the value of Event::id to determine the event type.
1119 * @param event The Event class being received
1121 virtual void OnEvent(Event& event);
1123 /** Called whenever a Request class is sent to your module by another module.
1124 * The value of Request::id should be used to determine the type of request.
1125 * @param request The Request class being received
1127 virtual void OnRequest(Request& request);
1129 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
1130 * The password field (from the config file) is in 'password' and is to be compared against
1131 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
1132 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
1133 * @param ex The object that's causing the authentication (User* for \<oper> \<connect:allow> etc, Server* for \<link>).
1134 * @param password The password from the configuration file (the password="" value).
1135 * @param input The password entered by the user or whoever.
1136 * @param hashtype The hash value from the config
1137 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
1139 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
1141 /** Called whenever a user is given usermode +o, anywhere on the network.
1142 * You cannot override this and prevent it from happening as it is already happened and
1143 * such a task must be performed by another server. You can however bounce modes by sending
1144 * servermodes out to reverse mode changes.
1145 * @param user The user who is opering
1147 virtual void OnGlobalOper(User* user);
1149 /** Called after a user has fully connected and all modules have executed OnUserConnect
1150 * This event is informational only. You should not change any user information in this
1151 * event. To do so, use the OnUserConnect method to change the state of local users.
1152 * This is called for both local and remote users.
1153 * @param user The user who is connecting
1155 virtual void OnPostConnect(User* user);
1157 /** Called to install an I/O hook on an event handler
1158 * @param user The socket to possibly install the I/O hook on
1159 * @param via The port that the user connected on
1161 virtual void OnHookIO(StreamSocket* user, ListenSocket* via);
1163 /** Called when a port accepts a connection
1164 * Return MOD_RES_ACCEPT if you have used the file descriptor.
1165 * @param fd The file descriptor returned from accept()
1166 * @param sock The socket connection for the new user
1167 * @param client The client IP address and port
1168 * @param server The server IP address and port
1170 virtual ModResult OnAcceptConnection(int fd, ListenSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
1172 /** Called immediately after any connection is accepted. This is intended for raw socket
1173 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1174 * no information relating to a user record as the connection has not been assigned yet.
1175 * There are no return values from this call as all modules get an opportunity if required to
1176 * process the connection.
1177 * @param sock The socket in question
1178 * @param client The client IP address and port
1179 * @param server The server IP address and port
1181 virtual void OnStreamSocketAccept(StreamSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
1184 * Called when a hooked stream has data to write, or when the socket
1185 * engine returns it as writable
1186 * @param sock The socket in question
1187 * @param sendq Data to send to the socket
1188 * @return 1 if the sendq has been completely emptied, 0 if there is
1189 * still data to send, and -1 if there was an error
1191 virtual int OnStreamSocketWrite(StreamSocket* sock, std::string& sendq);
1193 /** Called immediately before any socket is closed. When this event is called, shutdown()
1194 * has not yet been called on the socket.
1195 * @param sock The socket in question
1197 virtual void OnStreamSocketClose(StreamSocket* sock);
1199 /** Called immediately upon connection of an outbound BufferedSocket which has been hooked
1201 * @param sock The socket in question
1203 virtual void OnStreamSocketConnect(StreamSocket* sock);
1206 * Called when the stream socket has data to read
1207 * @param sock The socket that is ready
1208 * @param recvq The receive queue that new data should be appended to
1209 * @return 1 if new data has been read, 0 if no new data is ready (but the
1210 * socket is still connected), -1 if there was an error or close
1212 virtual int OnStreamSocketRead(StreamSocket* sock, std::string& recvq);
1214 /** Called whenever a user sets away or returns from being away.
1215 * The away message is available as a parameter, but should not be modified.
1216 * At this stage, it has already been copied into the user record.
1217 * If awaymsg is empty, the user is returning from away.
1218 * @param user The user setting away
1219 * @param awaymsg The away message of the user, or empty if returning from away
1220 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
1222 virtual ModResult OnSetAway(User* user, const std::string &awaymsg);
1224 /** Called whenever a line of WHOIS output is sent to a user.
1225 * You may change the numeric and the text of the output by changing
1226 * the values numeric and text, but you cannot change the user the
1227 * numeric is sent to. You may however change the user's User values.
1228 * @param user The user the numeric is being sent to
1229 * @param dest The user being WHOISed
1230 * @param numeric The numeric of the line being sent
1231 * @param text The text of the numeric, including any parameters
1232 * @return nonzero to drop the line completely so that the user does not
1233 * receive it, or zero to allow the line to be sent.
1235 virtual ModResult OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
1237 /** Called at intervals for modules to garbage-collect any hashes etc.
1238 * Certain data types such as hash_map 'leak' buckets, which must be
1239 * tidied up and freed by copying into a new item every so often. This
1240 * method is called when it is time to do that.
1242 virtual void OnGarbageCollect();
1244 /** Called when a user's connect class is being matched
1245 * @return MOD_RES_ALLOW to force the class to match, MOD_RES_DENY to forbid it, or
1246 * MOD_RES_PASSTHRU to allow normal matching (by host/port).
1248 virtual ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass);
1250 /** Add test suite hooks here. These are used for testing functionality of a module
1251 * via the --testsuite debugging parameter.
1253 virtual void OnRunTestSuite();
1255 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
1256 * For example NAMESX, channel mode +u and +I, and UHNAMES. If the nick is set to an empty string by any
1257 * module, then this will cause the nickname not to be displayed at all.
1259 virtual void OnNamesListItem(User* issuer, Membership* item, std::string &prefixes, std::string &nick);
1261 virtual ModResult OnNumeric(User* user, unsigned int numeric, const std::string &text);
1263 /** Called whenever a result from /WHO is about to be returned
1264 * @param source The user running the /WHO query
1265 * @param params The parameters to the /WHO query
1266 * @param user The user that this line of the query is about
1267 * @param line The raw line to send; modifiable, if empty no line will be returned.
1269 virtual void OnSendWhoLine(User* source, const std::vector<std::string>& params, User* user, std::string& line);
1271 /** Called whenever a local user's IP is set for the first time, or when a local user's IP changes due to
1272 * a module like m_cgiirc changing it.
1273 * @param user The user whose IP is being set
1275 virtual void OnSetUserIP(LocalUser* user);
1278 /** Provides an easy method of reading a text file into memory. */
1279 class CoreExport FileReader : public classbase
1281 /** The lines of text in the file.
1283 std::vector<std::string> lines;
1285 /** Content size in bytes
1287 unsigned long totalSize;
1290 /** Initializes a new file reader.
1292 FileReader() : totalSize(0) { }
1294 /** Initializes a new file reader and reads the specified file.
1295 * @param file The file to read into memory.
1297 FileReader(const std::string& filename);
1299 /** Loads a text file from disk.
1300 * @param filename The file to read into memory.
1301 * @throw CoreException The file can not be loaded.
1303 void Load(const std::string& filename);
1305 /** Retrieves the entire contents of the file cache as a single string.
1307 std::string GetString();
1309 /** Retrieves the entire contents of the file cache as a vector of strings.
1311 const std::vector<std::string>& GetVector() { return lines; }
1313 unsigned long TotalSize() { return totalSize; }
1316 /** A list of modules
1318 typedef std::vector<Module*> IntModuleList;
1320 /** An event handler iterator
1322 typedef IntModuleList::iterator EventHandlerIter;
1324 /** ModuleManager takes care of all things module-related
1327 class CoreExport ModuleManager
1330 /** Holds a string describing the last module error to occur
1332 std::string LastModuleError;
1334 /** Total number of modules loaded into the ircd
1338 /** List of loaded modules and shared object/dll handles
1339 * keyed by module name
1341 std::map<std::string, Module*> Modules;
1347 } prioritizationState;
1349 /** Internal unload module hook */
1350 bool CanUnload(Module*);
1353 /** Event handler hooks.
1354 * This needs to be public to be used by FOREACH_MOD and friends.
1356 IntModuleList EventHandlers[I_END];
1358 /** List of data services keyed by name */
1359 std::multimap<std::string, ServiceProvider*> DataProviders;
1361 /** Simple, bog-standard, boring constructor.
1369 /** Change the priority of one event in a module.
1370 * Each module event has a list of modules which are attached to that event type.
1371 * If you wish to be called before or after other specific modules, you may use this
1372 * method (usually within void Module::Prioritize()) to set your events priority.
1373 * You may use this call in other methods too, however, this is not supported behaviour
1375 * @param mod The module to change the priority of
1376 * @param i The event to change the priority of
1377 * @param s The state you wish to use for this event. Use one of
1378 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1379 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1380 * to set it to be before or after one or more other modules.
1381 * @param which If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1382 * then this contains a the module that your module must be placed before
1385 bool SetPriority(Module* mod, Implementation i, Priority s, Module* which = NULL);
1387 /** Backwards compat interface */
1388 inline bool SetPriority(Module* mod, Implementation i, Priority s, Module** dptr)
1390 return SetPriority(mod, i, s, *dptr);
1393 /** Change the priority of all events in a module.
1394 * @param mod The module to set the priority of
1395 * @param s The priority of all events in the module.
1396 * Note that with this method, it is not possible to effectively use
1397 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1398 * SetPriority method for this, where you may specify other modules to
1399 * be prioritized against.
1401 bool SetPriority(Module* mod, Priority s);
1403 /** Attach an event to a module.
1404 * You may later detatch the event with ModuleManager::Detach().
1405 * If your module is unloaded, all events are automatically detatched.
1406 * @param i Event type to attach
1407 * @param mod Module to attach event to
1408 * @return True if the event was attached
1410 bool Attach(Implementation i, Module* mod);
1412 /** Detatch an event from a module.
1413 * This is not required when your module unloads, as the core will
1414 * automatically detatch your module from all events it is attached to.
1415 * @param i Event type to detach
1416 * @param mod Module to detach event from
1417 * @return True if the event was detached
1419 bool Detach(Implementation i, Module* mod);
1421 /** Attach an array of events to a module
1422 * @param i Event types (array) to attach
1423 * @param mod Module to attach events to
1424 * @param sz The size of the implementation array
1426 void Attach(Implementation* i, Module* mod, size_t sz);
1428 /** Detach all events from a module (used on unload)
1429 * @param mod Module to detach from
1431 void DetachAll(Module* mod);
1433 /** Returns text describing the last module error
1434 * @return The last error message to occur
1436 std::string& LastError();
1438 /** Load a given module file
1439 * @param filename The file to load
1440 * @param defer Defer module init (loading many modules)
1441 * @return True if the module was found and loaded
1443 bool Load(const std::string& filename, bool defer = false);
1445 /** Unload a given module file. Note that the module will not be
1446 * completely gone until the cull list has finished processing.
1448 * @return true on success; if false, LastError will give a reason
1450 bool Unload(Module* module);
1452 /** Run an asynchronous reload of the given module. When the reload is
1453 * complete, the callback will be run with true if the reload succeeded
1454 * and false if it did not.
1456 void Reload(Module* module, HandlerBase1<void, bool>* callback);
1458 /** Called by the InspIRCd constructor to load all modules from the config file.
1462 void DoSafeUnload(Module*);
1464 /** Get the total number of currently loaded modules
1465 * @return The number of loaded modules
1469 return this->ModCount;
1472 /** Find a module by name, and return a Module* to it.
1473 * This is preferred over iterating the module lists yourself.
1474 * @param name The module name to look up
1475 * @return A pointer to the module, or NULL if the module cannot be found
1477 Module* Find(const std::string &name);
1479 /** Register a service provided by a module */
1480 void AddService(ServiceProvider&);
1482 /** Unregister a service provided by a module */
1483 void DelService(ServiceProvider&);
1485 inline void AddServices(ServiceProvider** list, int count)
1487 for(int i=0; i < count; i++)
1488 AddService(*list[i]);
1491 /** Find a service by name.
1492 * If multiple modules provide a given service, the first one loaded will be chosen.
1494 ServiceProvider* FindService(ServiceType Type, const std::string& name);
1496 template<typename T> inline T* FindDataService(const std::string& name)
1498 return static_cast<T*>(FindService(SERVICE_DATA, name));
1501 /** Return a list of all modules matching the given filter
1502 * @param filter This int is a bitmask of flags set in Module::Flags,
1503 * such as VF_VENDOR or VF_STATIC. If you wish to receive a list of
1504 * all modules with no filtering, set this to 0.
1505 * @return The list of module names
1507 const std::vector<std::string> GetAllModuleNames(int filter);
1510 /** Do not mess with these functions unless you know the C preprocessor
1511 * well enough to explain why they are needed. The order is important.
1513 #define MODULE_INIT_STR MODULE_INIT_STR_FN_2(MODULE_INIT_SYM)
1514 #define MODULE_INIT_STR_FN_2(x) MODULE_INIT_STR_FN_1(x)
1515 #define MODULE_INIT_STR_FN_1(x) #x
1516 #define MODULE_INIT_SYM MODULE_INIT_SYM_FN_2(INSPIRCD_VERSION_MAJ, INSPIRCD_VERSION_API)
1517 #define MODULE_INIT_SYM_FN_2(x,y) MODULE_INIT_SYM_FN_1(x,y)
1518 #define MODULE_INIT_SYM_FN_1(x,y) inspircd_module_ ## x ## _ ## y
1522 struct AllCommandList {
1523 typedef Command* (*fn)(Module*);
1524 AllCommandList(fn cmd);
1526 #define COMMAND_INIT(x) static Command* MK_ ## x(Module* m) { return new x(m); } \
1527 static const AllCommandList PREP_ ## x(&MK_ ## x);
1529 struct AllModuleList {
1530 typedef Module* (*fn)();
1533 AllModuleList(fn mod, const std::string& Name);
1536 #define MODULE_INIT(x) static Module* MK_ ## x() { return new x; } \
1537 static const AllModuleList PREP_ ## x(&MK_ ## x, MODNAMESTR);
1539 #define MODNAMESTR MODNAMESTR_FN_2(MODNAME)
1540 #define MODNAMESTR_FN_2(x) MODNAMESTR_FN_1(x)
1541 #define MODNAMESTR_FN_1(x) #x
1545 /** This definition is used as shorthand for the various classes
1546 * and functions needed to make a module loadable by the OS.
1547 * It defines the class factory and external init_module function.
1551 #define MODULE_INIT(y) \
1552 extern "C" DllExport Module * MODULE_INIT_SYM() \
1556 BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
1558 switch ( nReason ) \
1560 case DLL_PROCESS_ATTACH: \
1561 case DLL_PROCESS_DETACH: \
1569 #define MODULE_INIT(y) \
1570 extern "C" DllExport Module * MODULE_INIT_SYM() \
1574 extern "C" const char inspircd_src_version[] = VERSION " r" REVISION;
1577 #define COMMAND_INIT(c) MODULE_INIT(CommandModule<c>)