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 Event class is a unicast message directed at all modules.
214 * When the class is properly instantiated it may be sent to all modules
215 * using the Send() method, which will trigger the OnEvent method in
216 * all modules passing the object as its parameter.
218 class CoreExport Event : public classbase
221 /** This is a pointer to the sender of the message, which can be used to
222 * directly trigger events, or to create a reply.
225 /** The event identifier.
226 * This is arbitary text which should be used to distinguish
227 * one type of event from another.
229 const std::string id;
231 /** Create a new Event
233 Event(Module* src, const std::string &eventid);
235 * The return result of an Event::Send() will always be NULL as
236 * no replies are expected.
241 class CoreExport DataProvider : public ServiceProvider
244 DataProvider(Module* Creator, const std::string& Name)
245 : ServiceProvider(Creator, Name, SERVICE_DATA) {}
248 class CoreExport dynamic_reference_base : public interfacebase
254 ServiceProvider* value;
257 dynamic_reference_base(Module* Creator, const std::string& Name);
258 ~dynamic_reference_base();
259 inline const std::string& GetProvider() { return name; }
260 void SetProvider(const std::string& newname);
262 operator bool() { return (value != NULL); }
263 static void reset_all();
266 inline void dynamic_reference_base::check()
269 throw ModuleException("Dynamic reference to '" + name + "' failed to resolve");
273 class dynamic_reference : public dynamic_reference_base
276 dynamic_reference(Module* Creator, const std::string& Name)
277 : dynamic_reference_base(Creator, Name) {}
279 inline T* operator->()
282 return static_cast<T*>(value);
292 class dynamic_reference_nocheck : public dynamic_reference_base
295 dynamic_reference_nocheck(Module* Creator, const std::string& Name)
296 : dynamic_reference_base(Creator, Name) {}
300 return static_cast<T*>(value);
309 class ModeReference : public dynamic_reference_nocheck<ModeHandler>
312 ModeReference(Module* mod, const std::string& modename)
313 : dynamic_reference_nocheck<ModeHandler>(mod, "mode/" + modename) {}
316 /** Priority types which can be used by Module::Prioritize()
318 enum Priority { PRIORITY_FIRST, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
320 /** Implementation-specific flags which may be set in Module::Implements()
325 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash,
326 I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois,
327 I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNick,
328 I_OnUserMessage, I_OnMode, I_OnGetServerDescription, I_OnSyncUser,
329 I_OnSyncChannel, I_OnDecodeMetaData, I_OnAcceptConnection, I_OnUserInit,
330 I_OnChangeHost, I_OnChangeName, I_OnAddLine, I_OnDelLine, I_OnExpireLine,
331 I_OnUserPostNick, I_OnPreMode, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule,
332 I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite,
333 I_OnRawMode, I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckChannelBan, I_OnExtBanCheck,
334 I_OnStats, I_OnChangeLocalUserHost, I_OnPreTopicChange,
335 I_OnPostTopicChange, I_OnEvent, I_OnGlobalOper, I_OnPostConnect,
336 I_OnChangeLocalUserGECOS, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
337 I_OnPostOper, I_OnSyncNetwork, I_OnSetAway, I_OnPostCommand, I_OnPostJoin,
338 I_OnWhoisLine, I_OnBuildNeighborList, I_OnGarbageCollect, I_OnSetConnectClass,
339 I_OnText, I_OnPassCompare, I_OnRunTestSuite, I_OnNamesListItem, I_OnNumeric, I_OnHookIO,
340 I_OnPreRehash, I_OnModuleRehash, I_OnSendWhoLine, I_OnChangeIdent, I_OnSetUserIP,
344 /** Base class for all InspIRCd modules
345 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
346 * its methods will be called when irc server events occur. class inherited from module must be
347 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
349 class CoreExport Module : public classbase, public usecountbase
352 /** File that this module was loaded from
354 std::string ModuleSourceFile;
355 /** Reference to the dlopen() value
357 DLLManager* ModuleDLLManager;
359 /** If true, this module will be unloaded soon, further unload attempts will fail
360 * Value is used by the ModuleManager internally, you should not modify it
364 /** Default constructor.
365 * Creates a module class. Don't do any type of hook registration or checks
366 * for other modules here; do that in init().
371 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
373 virtual void init() {}
375 /** Clean up prior to destruction
376 * If you override, you must call this AFTER your module's cleanup
378 virtual CullResult cull();
380 /** Default destructor.
381 * destroys a module class
385 virtual void Prioritize()
389 /** Returns the version number of a Module.
390 * The method should return a Version object with its version information assigned via
393 virtual Version GetVersion() = 0;
395 /** Called when a user connects.
396 * The details of the connecting user are available to you in the parameter User *user
397 * @param user The user who is connecting
399 virtual void OnUserConnect(LocalUser* user);
401 /** Called when a user quits.
402 * The details of the exiting user are available to you in the parameter User *user
403 * This event is only called when the user is fully registered when they quit. To catch
404 * raw disconnections, use the OnUserDisconnect method.
405 * @param user The user who is quitting
406 * @param message The user's quit message (as seen by non-opers)
407 * @param oper_message The user's quit message (as seen by opers)
409 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
411 /** Called whenever a user's socket is closed.
412 * The details of the exiting user are available to you in the parameter User *user
413 * This event is called for all users, registered or not, as a cleanup method for modules
414 * which might assign resources to user, such as dns lookups, objects and sockets.
415 * @param user The user who is disconnecting
417 virtual void OnUserDisconnect(LocalUser* user);
419 /** Called whenever a channel is about to be deleted
420 * @param chan The channel being deleted
421 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
423 virtual ModResult OnChannelPreDelete(Channel *chan);
425 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
426 * @param chan The channel being deleted
428 virtual void OnChannelDelete(Channel* chan);
430 /** Called when a user joins a channel.
431 * The details of the joining user are available to you in the parameter User *user,
432 * and the details of the channel they have joined is available in the variable Channel *channel
433 * @param memb The channel membership being created
434 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
435 * to a channel due to the network sync.
436 * @param created This is true if the join created the channel
437 * @param except_list A list of users not to send to.
439 virtual void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list);
441 /** Called after a user joins a channel
442 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
444 * @param memb The channel membership created
446 virtual void OnPostJoin(Membership* memb);
448 /** Called when a user parts a channel.
449 * The details of the leaving user are available to you in the parameter User *user,
450 * and the details of the channel they have left is available in the variable Channel *channel
451 * @param memb The channel membership being destroyed
452 * @param partmessage The part message, or an empty string (may be modified)
453 * @param except_list A list of users to not send to.
455 virtual void OnUserPart(Membership* memb, std::string &partmessage, CUList& except_list);
457 /** Called on rehash.
458 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
459 * system. This is called in all cases -- including when this server will not execute the
460 * rehash because it is directed at a remote server.
462 * @param user The user performing the rehash, if any. If this is server initiated, the value of
463 * this variable will be NULL.
464 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
467 virtual void OnPreRehash(User* user, const std::string ¶meter);
469 /** Called on rehash.
470 * This method is called when a user initiates a module-specific rehash. This can be used to do
471 * expensive operations (such as reloading SSL certificates) that are not executed on a normal
472 * rehash for efficiency. A rehash of this type does not reload the core configuration.
474 * @param user The user performing the rehash.
475 * @param parameter The parameter given to REHASH
477 virtual void OnModuleRehash(User* user, const std::string ¶meter);
479 /** Called on rehash.
480 * This method is called after a rehash has completed. You should use it to reload any module
481 * configuration from the main configuration file.
482 * @param user The user that performed the rehash, if it was initiated by a user and that user
483 * is still connected.
485 virtual void OnRehash(User* user);
487 /** Called whenever a snotice is about to be sent to a snomask.
488 * snomask and type may both be modified; the message may not.
489 * @param snomask The snomask the message is going to (e.g. 'A')
490 * @param type The textual description the snomask will go to (e.g. 'OPER')
491 * @param message The text message to be sent via snotice
492 * @return 1 to block the snotice from being sent entirely, 0 else.
494 virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
496 /** Called whenever a user is about to join a channel, before any processing is done.
497 * Returning a value of 1 from this function stops the process immediately, causing no
498 * output to be sent to the user by the core. If you do this you must produce your own numerics,
499 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
500 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
504 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
505 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
506 * processing on the actual channel record at this point, however the channel NAME will still be passed in
507 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
508 * @param user The user joining the channel
509 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
510 * @param cname The channel name being joined. For new channels this is valid where chan is not.
511 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "o".
512 * You may alter this string to alter the user's modes on the channel.
513 * @param keygiven The key given to join the channel, or an empty string if none was provided
514 * @return 1 To prevent the join, 0 to allow it.
516 virtual ModResult OnUserPreJoin(LocalUser* user, Channel* chan, const std::string& cname, std::string& privs, const std::string& keygiven);
518 /** Called whenever a user is about to be kicked.
519 * Returning a value of 1 from this function stops the process immediately, causing no
520 * output to be sent to the user by the core. If you do this you must produce your own numerics,
522 * @param source The user issuing the kick
523 * @param memb The channel membership of the user who is being kicked.
524 * @param reason The kick reason
525 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
527 virtual ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason);
529 /** Called whenever a user is kicked.
530 * If this method is called, the kick is already underway and cannot be prevented, so
531 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
532 * @param source The user issuing the kick
533 * @param memb The channel membership of the user who was kicked.
534 * @param reason The kick reason
535 * @param except_list A list of users to not send to.
537 virtual void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except_list);
539 /** Called whenever a user opers locally.
540 * The User will contain the oper mode 'o' as this function is called after any modifications
541 * are made to the user's structure by the core.
542 * @param user The user who is opering up
543 * @param opertype The opers type name
545 virtual void OnOper(User* user, const std::string &opertype);
547 /** Called after a user opers locally.
548 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
549 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
550 * out the OPERTYPE, etc.
551 * @param user The user who is opering up
552 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
553 * @param opertype The opers type name
555 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
557 /** Called whenever a user types /INFO.
558 * The User will contain the information of the user who typed the command. Modules may use this
559 * method to output their own credits in /INFO (which is the ircd's version of an about box).
560 * It is purposefully not possible to modify any info that has already been output, or halt the list.
561 * You must write a 371 numeric to the user, containing your info in the following format:
563 * <nick> :information here
565 * @param user The user issuing /INFO
567 virtual void OnInfo(User* user);
569 /** Called whenever a /WHOIS is performed on a local user.
570 * The source parameter contains the details of the user who issued the WHOIS command, and
571 * the dest parameter contains the information of the user they are whoising.
572 * @param source The user issuing the WHOIS command
573 * @param dest The user who is being WHOISed
575 virtual void OnWhois(User* source, User* dest);
577 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
578 * Returning 1 from this function stops the process immediately, causing no
579 * output to be sent to the user by the core. If you do this you must produce your own numerics,
580 * notices etc. This is useful for modules which may want to filter invites to channels.
581 * @param source The user who is issuing the INVITE
582 * @param dest The user being invited
583 * @param channel The channel the user is being invited to
584 * @param timeout The time the invite will expire (0 == never)
585 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
587 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
589 /** Called after a user has been successfully invited to a channel.
590 * You cannot prevent the invite from occuring using this function, to do that,
591 * use OnUserPreInvite instead.
592 * @param source The user who is issuing the INVITE
593 * @param dest The user being invited
594 * @param channel The channel the user is being invited to
595 * @param timeout The time the invite will expire (0 == never)
597 virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout);
599 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
600 * Returning any nonzero value from this function stops the process immediately, causing no
601 * output to be sent to the user by the core. If you do this you must produce your own numerics,
602 * notices etc. This is useful for modules which may want to filter or redirect messages.
603 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
604 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
605 * of where the message is destined to be sent.
606 * @param user The user sending the message
607 * @param dest The target of the message (Channel* or User*)
608 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
609 * @param text Changeable text being sent by the user
610 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
611 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
612 * It will be ignored for private messages.
613 * @param msgtype The message type, MSG_PRIVMSG for PRIVMSGs, MSG_NOTICE for NOTICEs
614 * @return 1 to deny the message, 0 to allow it
616 virtual ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list, MessageType msgtype);
618 /** Called when sending a message to all "neighbors" of a given user -
619 * that is, all users that share a common channel. This is used in
620 * commands such as NICK, QUIT, etc.
621 * @param source The source of the message
622 * @param include_c Channels to scan for users to include
623 * @param exceptions Map of user->bool that overrides the inclusion decision
625 * Set exceptions[user] = true to include, exceptions[user] = false to exclude
627 virtual void OnBuildNeighborList(User* source, UserChanList &include_c, std::map<User*,bool> &exceptions);
629 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
630 * Please note that although you can see remote nickchanges through this function, you should
631 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
632 * check user->server before taking any action (including returning nonzero from the method).
633 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
634 * module to generate some meaninful output.
635 * @param user The username changing their nick
636 * @param newnick Their new nickname
637 * @return 1 to deny the change, 0 to allow
639 virtual ModResult OnUserPreNick(User* user, const std::string &newnick);
641 /** Called after any PRIVMSG sent from a user.
642 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
643 * if target_type is TYPE_CHANNEL.
644 * @param user The user sending the message
645 * @param dest The target of the message
646 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
647 * @param text the text being sent by the user
648 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
649 * @param exempt_list A list of users to not send to.
650 * @param msgtype The message type, MSG_PRIVMSG for PRIVMSGs, MSG_NOTICE for NOTICEs
652 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list, MessageType msgtype);
654 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
655 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
656 * if target_type is TYPE_CHANNEL.
657 * The difference between this event and OnUserPreMessage is that delivery is gauranteed,
658 * the message has already been vetted. In the case of the other two methods, a later module may stop your
659 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
660 * @param user The user sending the message
661 * @param dest The target of the message
662 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
663 * @param text the text being sent by the user
664 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
665 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
667 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
669 /** Called after every MODE command sent from a user
670 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
671 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
672 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
673 * @param user The user sending the MODEs
674 * @param dest The target of the modes (User* or Channel*)
675 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
676 * @param text The actual modes and their parameters if any
677 * @param translate The translation types of the mode parameters
679 virtual void OnMode(User* user, void* dest, int target_type, const std::vector<std::string> &text, const std::vector<TranslateType> &translate);
681 /** Allows modules to alter or create server descriptions
682 * Whenever a module requires a server description, for example for display in
683 * WHOIS, this function is called in all modules. You may change or define the
684 * description given in std::string &description. If you do, this description
685 * will be shown in the WHOIS fields.
686 * @param servername The servername being searched for
687 * @param description Alterable server description for this server
689 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
691 /** Allows modules to synchronize data which relates to users during a netburst.
692 * When this function is called, it will be called from the module which implements
693 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
694 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
695 * (see below). This function will be called for every user visible on your side
696 * of the burst, allowing you to for example set modes, etc. Do not use this call to
697 * synchronize data which you have stored using class Extensible -- There is a specialist
698 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
699 * @param user The user being syncronized
700 * @param proto A pointer to the module handling network protocol
701 * @param opaque An opaque pointer set by the protocol module, should not be modified!
703 virtual void OnSyncUser(User* user, Module* proto, void* opaque);
705 /** Allows modules to synchronize data which relates to channels during a netburst.
706 * When this function is called, it will be called from the module which implements
707 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
708 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
709 * (see below). This function will be called for every user visible on your side
710 * of the burst, allowing you to for example set modes, etc.
712 * @param chan The channel being syncronized
713 * @param proto A pointer to the module handling network protocol
714 * @param opaque An opaque pointer set by the protocol module, should not be modified!
716 virtual void OnSyncChannel(Channel* chan, Module* proto, void* opaque);
718 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
719 * Whenever the linking module wants to send out data, but doesnt know what the data
720 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
721 * this method is called. You should use the ProtoSendMetaData function after you've
722 * correctly decided how the data should be represented, to send the metadata on its way if
723 * if it belongs to your module.
724 * @param proto A pointer to the module handling network protocol
725 * @param opaque An opaque pointer set by the protocol module, should not be modified!
726 * @param displayable If this value is true, the data is going to be displayed to a user,
727 * and not sent across the network. Use this to determine wether or not to show sensitive data.
729 virtual void OnSyncNetwork(Module* proto, void* opaque);
731 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
732 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
733 * @param target The Channel* or User* that data should be added to
734 * @param extname The extension name which is being sent
735 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
737 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
739 /** Implemented by modules which provide the ability to link servers.
740 * These modules will implement this method, which allows transparent sending of servermodes
741 * down the network link as a broadcast, without a module calling it having to know the format
742 * of the MODE command before the actual mode string.
744 * @param opaque An opaque pointer set by the protocol module, should not be modified!
745 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
746 * @param target The Channel* or User* that modes should be sent for
747 * @param modeline The modes and parameters to be sent
748 * @param translate The translation types of the mode parameters
750 virtual void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::vector<std::string> &modeline, const std::vector<TranslateType> &translate);
752 /** Implemented by modules which provide the ability to link servers.
753 * These modules will implement this method, which allows metadata (extra data added to
754 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
755 * to other servers on a netburst and decoded at the other end by the same module on a
758 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
759 * how to use this function.
760 * @param opaque An opaque pointer set by the protocol module, should not be modified!
761 * @param target The Channel* or User* that metadata should be sent for
762 * @param extname The extension name to send metadata for
763 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
765 virtual void ProtoSendMetaData(void* opaque, Extensible* target, const std::string &extname, const std::string &extdata);
767 /** Called whenever a user's hostname is changed.
768 * This event triggers after the host has been set.
769 * @param user The user whos host is being changed
770 * @param newhost The new hostname being set
772 virtual void OnChangeHost(User* user, const std::string &newhost);
774 /** Called whenever a user's GECOS (realname) is changed.
775 * This event triggers after the name has been set.
776 * @param user The user who's GECOS is being changed
777 * @param gecos The new GECOS being set on the user
779 virtual void OnChangeName(User* user, const std::string &gecos);
781 /** Called whenever a user's IDENT is changed.
782 * This event triggers after the name has been set.
783 * @param user The user who's IDENT is being changed
784 * @param ident The new IDENT being set on the user
786 virtual void OnChangeIdent(User* user, const std::string &ident);
788 /** Called whenever an xline is added by a local user.
789 * This method is triggered after the line is added.
790 * @param source The sender of the line or NULL for local server
791 * @param line The xline being added
793 virtual void OnAddLine(User* source, XLine* line);
795 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
796 * This method is triggered after the line is deleted.
797 * @param source The user removing the line or NULL for local server
798 * @param line the line being deleted
800 virtual void OnDelLine(User* source, XLine* line);
802 /** Called whenever an xline expires.
803 * This method is triggered after the line is deleted.
804 * @param line The line being deleted.
806 virtual void OnExpireLine(XLine *line);
808 /** Called before your module is unloaded to clean up Extensibles.
809 * This method is called once for every user and channel on the network,
810 * so that when your module unloads it may clear up any remaining data
811 * in the form of Extensibles added using Extensible::Extend().
812 * If the target_type variable is TYPE_USER, then void* item refers to
813 * a User*, otherwise it refers to a Channel*.
814 * @param target_type The type of item being cleaned
815 * @param item A pointer to the item's class
817 virtual void OnCleanup(int target_type, void* item);
819 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
820 * have been applied. Please note that although you can see remote nickchanges through this function, you should
821 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
822 * check user->server before taking any action (including returning nonzero from the method).
823 * Because this method is called after the nickchange is taken place, no return values are possible
824 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
825 * @param user The user changing their nick
826 * @param oldnick The old nickname of the user before the nickchange
828 virtual void OnUserPostNick(User* user, const std::string &oldnick);
830 /** Called before any mode change, to allow a single access check for
831 * a full mode change (use OnRawMode to check individual modes)
833 * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
834 * OnRawMode for each individual mode
836 * @param source the user making the mode change
837 * @param dest the user destination of the umode change (NULL if a channel mode)
838 * @param channel the channel destination of the mode change
839 * @param parameters raw mode parameters; parameters[0] is the user/channel being changed
841 virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, const std::vector<std::string>& parameters);
843 /** Called when a 005 numeric is about to be output.
844 * The module should modify the 005 numeric if needed to indicate its features.
845 * @param output The 005 map to be modified if neccessary.
847 virtual void On005Numeric(std::map<std::string, std::string>& tokens);
849 /** Called when a client is disconnected by KILL.
850 * If a client is killed by a server, e.g. a nickname collision or protocol error,
852 * Return 1 from this function to prevent the kill, and 0 from this function to allow
853 * it as normal. If you prevent the kill no output will be sent to the client, it is
854 * down to your module to generate this information.
855 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
856 * If you do so youre risking race conditions, desyncs and worse!
857 * @param source The user sending the KILL
858 * @param dest The user being killed
859 * @param reason The kill reason
860 * @return 1 to prevent the kill, 0 to allow
862 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
864 /** Called when an oper wants to disconnect a remote user via KILL
865 * @param source The user sending the KILL
866 * @param dest The user being killed
867 * @param reason The kill reason
868 * @param operreason The oper kill reason
870 virtual void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
872 /** Called whenever a module is loaded.
873 * mod will contain a pointer to the module, and string will contain its name,
874 * for example m_widgets.so. This function is primary for dependency checking,
875 * your module may decide to enable some extra features if it sees that you have
876 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
877 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
878 * but instead operate under reduced functionality, unless the dependency is
879 * absolutely neccessary (e.g. a module that extends the features of another
881 * @param mod A pointer to the new module
883 virtual void OnLoadModule(Module* mod);
885 /** Called whenever a module is unloaded.
886 * mod will contain a pointer to the module, and string will contain its name,
887 * for example m_widgets.so. This function is primary for dependency checking,
888 * your module may decide to enable some extra features if it sees that you have
889 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
890 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
891 * but instead operate under reduced functionality, unless the dependency is
892 * absolutely neccessary (e.g. a module that extends the features of another
894 * @param mod Pointer to the module being unloaded (still valid)
896 virtual void OnUnloadModule(Module* mod);
898 /** Called once every five seconds for background processing.
899 * This timer can be used to control timed features. Its period is not accurate
900 * enough to be used as a clock, but it is gauranteed to be called at least once in
901 * any five second period, directly from the main loop of the server.
902 * @param curtime The current timer derived from time(2)
904 virtual void OnBackgroundTimer(time_t curtime);
906 /** Called whenever any command is about to be executed.
907 * This event occurs for all registered commands, wether they are registered in the core,
908 * or another module, and for invalid commands. Invalid commands may only be sent to this
909 * function when the value of validated is false. By returning 1 from this method you may prevent the
910 * command being executed. If you do this, no output is created by the core, and it is
911 * down to your module to produce any output neccessary.
912 * Note that unless you return 1, you should not destroy any structures (e.g. by using
913 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
914 * method returns, it will be passed an invalid pointer to the user object and crash!)
915 * @param command The command being executed
916 * @param parameters An array of array of characters containing the parameters for the command
917 * @param user the user issuing the command
918 * @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.
919 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
920 * @param original_line The entire original line as passed to the parser from the user
921 * @return 1 to block the command, 0 to allow
923 virtual ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, LocalUser *user, bool validated, const std::string &original_line);
925 /** Called after any command has been executed.
926 * This event occurs for all registered commands, wether they are registered in the core,
927 * or another module, but it will not occur for invalid commands (e.g. ones which do not
928 * exist within the command table). The result code returned by the command handler is
930 * @param command The command being executed
931 * @param parameters An array of array of characters containing the parameters for the command
932 * @param user the user issuing the command
933 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
934 * @param original_line The entire original line as passed to the parser from the user
936 virtual void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, LocalUser *user, CmdResult result, const std::string &original_line);
938 /** Called when a user is first connecting, prior to starting DNS lookups, checking initial
939 * connect class, or accepting any commands.
941 virtual void OnUserInit(LocalUser* user);
943 /** Called to check if a user who is connecting can now be allowed to register
944 * If any modules return false for this function, the user is held in the waiting
945 * state until all modules return true. For example a module which implements ident
946 * lookups will continue to return false for a user until their ident lookup is completed.
947 * Note that the registration timeout for a user overrides these checks, if the registration
948 * timeout is reached, the user is disconnected even if modules report that the user is
949 * not ready to connect.
950 * @param user The user to check
951 * @return true to indicate readiness, false if otherwise
953 virtual ModResult OnCheckReady(LocalUser* user);
955 /** Called whenever a user is about to register their connection (e.g. before the user
956 * is sent the MOTD etc). Modules can use this method if they are performing a function
957 * which must be done before the actual connection is completed (e.g. ident lookups,
958 * dnsbl lookups, etc).
959 * Note that you should NOT delete the user record here by causing a disconnection!
960 * Use OnUserConnect for that instead.
961 * @param user The user registering
962 * @return 1 to indicate user quit, 0 to continue
964 virtual ModResult OnUserRegister(LocalUser* user);
966 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
967 * This method will always be called for each join, wether or not the channel is actually +i, and
968 * determines the outcome of an if statement around the whole section of invite checking code.
969 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
970 * @param user The user joining the channel
971 * @param chan The channel being joined
972 * @return 1 to explicitly allow the join, 0 to proceed as normal
974 virtual ModResult OnCheckInvite(User* user, Channel* chan);
976 /** Called whenever a mode character is processed.
977 * Return 1 from this function to block the mode character from being processed entirely.
978 * @param user The user who is sending the mode
979 * @param chan The channel the mode is being sent to (or NULL if a usermode)
980 * @param mode The mode character being set
981 * @param param The parameter for the mode or an empty string
982 * @param adding true of the mode is being added, false if it is being removed
983 * @param pcnt The parameter count for the mode (0 or 1)
984 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
985 * to skip all permission checking. Please note that for remote mode changes, your return value
988 virtual ModResult OnRawMode(User* user, Channel* chan, const char mode, const std::string ¶m, bool adding, int pcnt);
990 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
991 * This method will always be called for each join, wether or not the channel is actually +k, and
992 * determines the outcome of an if statement around the whole section of key checking code.
993 * if the user specified no key, the keygiven string will be a valid but empty value.
994 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
995 * @param user The user joining the channel
996 * @param chan The channel being joined
997 * @param keygiven The key given on joining the channel.
998 * @return 1 to explicitly allow the join, 0 to proceed as normal
1000 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
1002 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1003 * This method will always be called for each join, wether or not the channel is actually +l, and
1004 * determines the outcome of an if statement around the whole section of channel limit checking code.
1005 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1006 * @param user The user joining the channel
1007 * @param chan The channel being joined
1008 * @return 1 to explicitly allow the join, 0 to proceed as normal
1010 virtual ModResult OnCheckLimit(User* user, Channel* chan);
1013 * Checks for a user's ban from the channel
1014 * @param user The user to check
1015 * @param chan The channel to check in
1016 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1017 * ban check, or MOD_RES_PASSTHRU to check bans normally
1019 virtual ModResult OnCheckChannelBan(User* user, Channel* chan);
1022 * Checks for a user's match of a single ban
1023 * @param user The user to check for match
1024 * @param chan The channel on which the match is being checked
1025 * @param mask The mask being checked
1026 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1027 * ban check, or MOD_RES_PASSTHRU to check bans normally
1029 virtual ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask);
1031 /** Checks for a match on a given extban type
1032 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1033 * ban check, or MOD_RES_PASSTHRU to check bans normally
1035 virtual ModResult OnExtBanCheck(User* user, Channel* chan, char type);
1037 /** Called on all /STATS commands
1038 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1039 * @param symbol the symbol provided to /STATS
1040 * @param user the user issuing the /STATS command
1041 * @param results A string_list to append results into. You should put all your results
1042 * into this string_list, rather than displaying them directly, so that your handler will
1043 * work when remote STATS queries are received.
1044 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1046 virtual ModResult OnStats(char symbol, User* user, string_list &results);
1048 /** Called whenever a change of a local users displayed host is attempted.
1049 * Return 1 to deny the host change, or 0 to allow it.
1050 * @param user The user whos host will be changed
1051 * @param newhost The new hostname
1052 * @return 1 to deny the host change, 0 to allow
1054 virtual ModResult OnChangeLocalUserHost(LocalUser* user, const std::string &newhost);
1056 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1057 * return 1 to deny the name change, or 0 to allow it.
1058 * @param user The user whos GECOS will be changed
1059 * @param newhost The new GECOS
1060 * @return 1 to deny the GECOS change, 0 to allow
1062 virtual ModResult OnChangeLocalUserGECOS(LocalUser* user, const std::string &newhost);
1064 /** Called before a topic is changed.
1065 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
1066 * As with other 'pre' events, you should only ever block a local event.
1067 * @param user The user changing the topic
1068 * @param chan The channels who's topic is being changed
1069 * @param topic The actual topic text
1070 * @return 1 to block the topic change, 0 to allow
1072 virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
1074 /** Called whenever a topic has been changed.
1075 * To block topic changes you must use OnPreTopicChange instead.
1076 * @param user The user changing the topic
1077 * @param chan The channels who's topic is being changed
1078 * @param topic The actual topic text
1080 virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
1082 /** Called whenever an Event class is sent to all modules by another module.
1083 * You should *always* check the value of Event::id to determine the event type.
1084 * @param event The Event class being received
1086 virtual void OnEvent(Event& event);
1088 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
1089 * The password field (from the config file) is in 'password' and is to be compared against
1090 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
1091 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
1092 * @param ex The object that's causing the authentication (User* for \<oper> \<connect:allow> etc, Server* for \<link>).
1093 * @param password The password from the configuration file (the password="" value).
1094 * @param input The password entered by the user or whoever.
1095 * @param hashtype The hash value from the config
1096 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
1098 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
1100 /** Called whenever a user is given usermode +o, anywhere on the network.
1101 * You cannot override this and prevent it from happening as it is already happened and
1102 * such a task must be performed by another server. You can however bounce modes by sending
1103 * servermodes out to reverse mode changes.
1104 * @param user The user who is opering
1106 virtual void OnGlobalOper(User* user);
1108 /** Called after a user has fully connected and all modules have executed OnUserConnect
1109 * This event is informational only. You should not change any user information in this
1110 * event. To do so, use the OnUserConnect method to change the state of local users.
1111 * This is called for both local and remote users.
1112 * @param user The user who is connecting
1114 virtual void OnPostConnect(User* user);
1116 /** Called to install an I/O hook on an event handler
1117 * @param user The socket to possibly install the I/O hook on
1118 * @param via The port that the user connected on
1120 virtual void OnHookIO(StreamSocket* user, ListenSocket* via);
1122 /** Called when a port accepts a connection
1123 * Return MOD_RES_ACCEPT if you have used the file descriptor.
1124 * @param fd The file descriptor returned from accept()
1125 * @param sock The socket connection for the new user
1126 * @param client The client IP address and port
1127 * @param server The server IP address and port
1129 virtual ModResult OnAcceptConnection(int fd, ListenSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
1131 /** Called whenever a user sets away or returns from being away.
1132 * The away message is available as a parameter, but should not be modified.
1133 * At this stage, it has already been copied into the user record.
1134 * If awaymsg is empty, the user is returning from away.
1135 * @param user The user setting away
1136 * @param awaymsg The away message of the user, or empty if returning from away
1137 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
1139 virtual ModResult OnSetAway(User* user, const std::string &awaymsg);
1141 /** Called whenever a line of WHOIS output is sent to a user.
1142 * You may change the numeric and the text of the output by changing
1143 * the values numeric and text, but you cannot change the user the
1144 * numeric is sent to. You may however change the user's User values.
1145 * @param user The user the numeric is being sent to
1146 * @param dest The user being WHOISed
1147 * @param numeric The numeric of the line being sent
1148 * @param text The text of the numeric, including any parameters
1149 * @return nonzero to drop the line completely so that the user does not
1150 * receive it, or zero to allow the line to be sent.
1152 virtual ModResult OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
1154 /** Called at intervals for modules to garbage-collect any hashes etc.
1155 * Certain data types such as hash_map 'leak' buckets, which must be
1156 * tidied up and freed by copying into a new item every so often. This
1157 * method is called when it is time to do that.
1159 virtual void OnGarbageCollect();
1161 /** Called when a user's connect class is being matched
1162 * @return MOD_RES_ALLOW to force the class to match, MOD_RES_DENY to forbid it, or
1163 * MOD_RES_PASSTHRU to allow normal matching (by host/port).
1165 virtual ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass);
1167 /** Add test suite hooks here. These are used for testing functionality of a module
1168 * via the --testsuite debugging parameter.
1170 virtual void OnRunTestSuite();
1172 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
1173 * For example NAMESX, channel mode +u and +I, and UHNAMES. If the nick is set to an empty string by any
1174 * module, then this will cause the nickname not to be displayed at all.
1176 virtual void OnNamesListItem(User* issuer, Membership* item, std::string &prefixes, std::string &nick);
1178 virtual ModResult OnNumeric(User* user, unsigned int numeric, const std::string &text);
1180 /** Called whenever a result from /WHO is about to be returned
1181 * @param source The user running the /WHO query
1182 * @param params The parameters to the /WHO query
1183 * @param user The user that this line of the query is about
1184 * @param line The raw line to send; modifiable, if empty no line will be returned.
1186 virtual void OnSendWhoLine(User* source, const std::vector<std::string>& params, User* user, std::string& line);
1188 /** Called whenever a local user's IP is set for the first time, or when a local user's IP changes due to
1189 * a module like m_cgiirc changing it.
1190 * @param user The user whose IP is being set
1192 virtual void OnSetUserIP(LocalUser* user);
1195 /** Provides an easy method of reading a text file into memory. */
1196 class CoreExport FileReader : public classbase
1198 /** The lines of text in the file.
1200 std::vector<std::string> lines;
1202 /** Content size in bytes
1204 unsigned long totalSize;
1207 /** Initializes a new file reader.
1209 FileReader() : totalSize(0) { }
1211 /** Initializes a new file reader and reads the specified file.
1212 * @param file The file to read into memory.
1214 FileReader(const std::string& filename);
1216 /** Loads a text file from disk.
1217 * @param filename The file to read into memory.
1218 * @throw CoreException The file can not be loaded.
1220 void Load(const std::string& filename);
1222 /** Retrieves the entire contents of the file cache as a single string.
1224 std::string GetString();
1226 /** Retrieves the entire contents of the file cache as a vector of strings.
1228 const std::vector<std::string>& GetVector() { return lines; }
1230 unsigned long TotalSize() { return totalSize; }
1233 /** A list of modules
1235 typedef std::vector<Module*> IntModuleList;
1237 /** An event handler iterator
1239 typedef IntModuleList::iterator EventHandlerIter;
1241 /** ModuleManager takes care of all things module-related
1244 class CoreExport ModuleManager
1247 /** Holds a string describing the last module error to occur
1249 std::string LastModuleError;
1251 /** Total number of modules loaded into the ircd
1255 /** List of loaded modules and shared object/dll handles
1256 * keyed by module name
1258 std::map<std::string, Module*> Modules;
1264 } prioritizationState;
1266 /** Internal unload module hook */
1267 bool CanUnload(Module*);
1270 /** Event handler hooks.
1271 * This needs to be public to be used by FOREACH_MOD and friends.
1273 IntModuleList EventHandlers[I_END];
1275 /** List of data services keyed by name */
1276 std::multimap<std::string, ServiceProvider*> DataProviders;
1278 /** Simple, bog-standard, boring constructor.
1286 /** Change the priority of one event in a module.
1287 * Each module event has a list of modules which are attached to that event type.
1288 * If you wish to be called before or after other specific modules, you may use this
1289 * method (usually within void Module::Prioritize()) to set your events priority.
1290 * You may use this call in other methods too, however, this is not supported behaviour
1292 * @param mod The module to change the priority of
1293 * @param i The event to change the priority of
1294 * @param s The state you wish to use for this event. Use one of
1295 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1296 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1297 * to set it to be before or after one or more other modules.
1298 * @param which If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1299 * then this contains a the module that your module must be placed before
1302 bool SetPriority(Module* mod, Implementation i, Priority s, Module* which = NULL);
1304 /** Backwards compat interface */
1305 inline bool SetPriority(Module* mod, Implementation i, Priority s, Module** dptr)
1307 return SetPriority(mod, i, s, *dptr);
1310 /** Change the priority of all events in a module.
1311 * @param mod The module to set the priority of
1312 * @param s The priority of all events in the module.
1313 * Note that with this method, it is not possible to effectively use
1314 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1315 * SetPriority method for this, where you may specify other modules to
1316 * be prioritized against.
1318 bool SetPriority(Module* mod, Priority s);
1320 /** Attach an event to a module.
1321 * You may later detatch the event with ModuleManager::Detach().
1322 * If your module is unloaded, all events are automatically detatched.
1323 * @param i Event type to attach
1324 * @param mod Module to attach event to
1325 * @return True if the event was attached
1327 bool Attach(Implementation i, Module* mod);
1329 /** Detatch an event from a module.
1330 * This is not required when your module unloads, as the core will
1331 * automatically detatch your module from all events it is attached to.
1332 * @param i Event type to detach
1333 * @param mod Module to detach event from
1334 * @return True if the event was detached
1336 bool Detach(Implementation i, Module* mod);
1338 /** Attach an array of events to a module
1339 * @param i Event types (array) to attach
1340 * @param mod Module to attach events to
1341 * @param sz The size of the implementation array
1343 void Attach(Implementation* i, Module* mod, size_t sz);
1345 /** Detach all events from a module (used on unload)
1346 * @param mod Module to detach from
1348 void DetachAll(Module* mod);
1350 /** Returns text describing the last module error
1351 * @return The last error message to occur
1353 std::string& LastError();
1355 /** Load a given module file
1356 * @param filename The file to load
1357 * @param defer Defer module init (loading many modules)
1358 * @return True if the module was found and loaded
1360 bool Load(const std::string& filename, bool defer = false);
1362 /** Unload a given module file. Note that the module will not be
1363 * completely gone until the cull list has finished processing.
1365 * @return true on success; if false, LastError will give a reason
1367 bool Unload(Module* module);
1369 /** Run an asynchronous reload of the given module. When the reload is
1370 * complete, the callback will be run with true if the reload succeeded
1371 * and false if it did not.
1373 void Reload(Module* module, HandlerBase1<void, bool>* callback);
1375 /** Called by the InspIRCd constructor to load all modules from the config file.
1379 void DoSafeUnload(Module*);
1381 /** Get the total number of currently loaded modules
1382 * @return The number of loaded modules
1386 return this->ModCount;
1389 /** Find a module by name, and return a Module* to it.
1390 * This is preferred over iterating the module lists yourself.
1391 * @param name The module name to look up
1392 * @return A pointer to the module, or NULL if the module cannot be found
1394 Module* Find(const std::string &name);
1396 /** Register a service provided by a module */
1397 void AddService(ServiceProvider&);
1399 /** Unregister a service provided by a module */
1400 void DelService(ServiceProvider&);
1402 inline void AddServices(ServiceProvider** list, int count)
1404 for(int i=0; i < count; i++)
1405 AddService(*list[i]);
1408 /** Find a service by name.
1409 * If multiple modules provide a given service, the first one loaded will be chosen.
1411 ServiceProvider* FindService(ServiceType Type, const std::string& name);
1413 template<typename T> inline T* FindDataService(const std::string& name)
1415 return static_cast<T*>(FindService(SERVICE_DATA, name));
1418 /** Return a list of all modules matching the given filter
1419 * @param filter This int is a bitmask of flags set in Module::Flags,
1420 * such as VF_VENDOR or VF_STATIC. If you wish to receive a list of
1421 * all modules with no filtering, set this to 0.
1422 * @return The list of module names
1424 const std::vector<std::string> GetAllModuleNames(int filter);
1427 /** Do not mess with these functions unless you know the C preprocessor
1428 * well enough to explain why they are needed. The order is important.
1430 #define MODULE_INIT_STR MODULE_INIT_STR_FN_2(MODULE_INIT_SYM)
1431 #define MODULE_INIT_STR_FN_2(x) MODULE_INIT_STR_FN_1(x)
1432 #define MODULE_INIT_STR_FN_1(x) #x
1433 #define MODULE_INIT_SYM MODULE_INIT_SYM_FN_2(INSPIRCD_VERSION_MAJ, INSPIRCD_VERSION_API)
1434 #define MODULE_INIT_SYM_FN_2(x,y) MODULE_INIT_SYM_FN_1(x,y)
1435 #define MODULE_INIT_SYM_FN_1(x,y) inspircd_module_ ## x ## _ ## y
1439 struct AllCommandList {
1440 typedef Command* (*fn)(Module*);
1441 AllCommandList(fn cmd);
1443 #define COMMAND_INIT(x) static Command* MK_ ## x(Module* m) { return new x(m); } \
1444 static const AllCommandList PREP_ ## x(&MK_ ## x);
1446 struct AllModuleList {
1447 typedef Module* (*fn)();
1450 AllModuleList(fn mod, const std::string& Name);
1453 #define MODULE_INIT(x) static Module* MK_ ## x() { return new x; } \
1454 static const AllModuleList PREP_ ## x(&MK_ ## x, MODNAMESTR);
1456 #define MODNAMESTR MODNAMESTR_FN_2(MODNAME)
1457 #define MODNAMESTR_FN_2(x) MODNAMESTR_FN_1(x)
1458 #define MODNAMESTR_FN_1(x) #x
1462 /** This definition is used as shorthand for the various classes
1463 * and functions needed to make a module loadable by the OS.
1464 * It defines the class factory and external init_module function.
1468 #define MODULE_INIT(y) \
1469 extern "C" DllExport Module * MODULE_INIT_SYM() \
1473 BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
1475 switch ( nReason ) \
1477 case DLL_PROCESS_ATTACH: \
1478 case DLL_PROCESS_DETACH: \
1486 #define MODULE_INIT(y) \
1487 extern "C" DllExport Module * MODULE_INIT_SYM() \
1491 extern "C" const char inspircd_src_version[] = VERSION " r" REVISION;
1494 #define COMMAND_INIT(c) MODULE_INIT(CommandModule<c>)