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(OnConnect,(user));'
124 #define FOREACH_MOD(y,x) do { \
125 const IntModuleList& _handlers = ServerInstance->Modules->EventHandlers[I_ ## y]; \
126 for (IntModuleList::const_reverse_iterator _i = _handlers.rbegin(), _next; _i != _handlers.rend(); _i = _next) \
133 catch (CoreException& modexcept) \
135 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, "Exception caught: %s",modexcept.GetReason()); \
141 * Custom module result handling loop. This is a paired macro, and should only
142 * be used with while_each_hook.
144 * See src/channels.cpp for an example of use.
146 #define DO_EACH_HOOK(n,v,args) \
148 const IntModuleList& _handlers = ServerInstance->Modules->EventHandlers[I_ ## n]; \
149 for (IntModuleList::const_reverse_iterator _i = _handlers.rbegin(), _next; _i != _handlers.rend(); _i = _next) \
156 #define WHILE_EACH_HOOK(n) \
158 catch (CoreException& except_ ## n) \
160 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, "Exception caught: %s", (except_ ## n).GetReason()); \
166 * Module result iterator
167 * Runs the given hook until some module returns a useful result.
169 * Example: ModResult result;
170 * FIRST_MOD_RESULT(OnUserPreNick, result, (user, newnick))
172 #define FIRST_MOD_RESULT(n,v,args) do { \
173 v = MOD_RES_PASSTHRU; \
174 DO_EACH_HOOK(n,v,args) \
176 if (v != MOD_RES_PASSTHRU) \
179 WHILE_EACH_HOOK(n); \
182 /** Holds a module's Version information.
183 * The members (set by the constructor only) indicate details as to the version number
184 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
186 class CoreExport Version
189 /** Module description
191 const std::string description;
197 /** Server linking description string */
198 const std::string link_data;
200 /** Simple module version */
201 Version(const std::string &desc, int flags = VF_NONE);
203 /** Complex version information, including linking compatability data */
204 Version(const std::string &desc, int flags, const std::string& linkdata);
206 virtual ~Version() {}
209 /** The Event class is a unicast message directed at all modules.
210 * When the class is properly instantiated it may be sent to all modules
211 * using the Send() method, which will trigger the OnEvent method in
212 * all modules passing the object as its parameter.
214 class CoreExport Event : public classbase
217 /** This is a pointer to the sender of the message, which can be used to
218 * directly trigger events, or to create a reply.
221 /** The event identifier.
222 * This is arbitary text which should be used to distinguish
223 * one type of event from another.
225 const std::string id;
227 /** Create a new Event
229 Event(Module* src, const std::string &eventid);
231 * The return result of an Event::Send() will always be NULL as
232 * no replies are expected.
237 class CoreExport DataProvider : public ServiceProvider
240 DataProvider(Module* Creator, const std::string& Name)
241 : ServiceProvider(Creator, Name, SERVICE_DATA) {}
244 /** Priority types which can be used by Module::Prioritize()
246 enum Priority { PRIORITY_FIRST, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
248 /** Implementation-specific flags which may be set in Module::Implements()
253 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash,
254 I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois,
255 I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNick,
256 I_OnUserMessage, I_OnMode, I_OnGetServerDescription, I_OnSyncUser,
257 I_OnSyncChannel, I_OnDecodeMetaData, I_OnAcceptConnection, I_OnUserInit,
258 I_OnChangeHost, I_OnChangeName, I_OnAddLine, I_OnDelLine, I_OnExpireLine,
259 I_OnUserPostNick, I_OnPreMode, I_On005Numeric, I_OnKill, I_OnLoadModule,
260 I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite,
261 I_OnRawMode, I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckChannelBan, I_OnExtBanCheck,
262 I_OnStats, I_OnChangeLocalUserHost, I_OnPreTopicChange,
263 I_OnPostTopicChange, I_OnEvent, I_OnGlobalOper, I_OnPostConnect,
264 I_OnChangeLocalUserGECOS, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
265 I_OnPostOper, I_OnSyncNetwork, I_OnSetAway, I_OnPostCommand, I_OnPostJoin,
266 I_OnWhoisLine, I_OnBuildNeighborList, I_OnGarbageCollect, I_OnSetConnectClass,
267 I_OnText, I_OnPassCompare, I_OnRunTestSuite, I_OnNamesListItem, I_OnNumeric, I_OnHookIO,
268 I_OnPreRehash, I_OnModuleRehash, I_OnSendWhoLine, I_OnChangeIdent, I_OnSetUserIP,
272 /** Base class for all InspIRCd modules
273 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
274 * its methods will be called when irc server events occur. class inherited from module must be
275 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
277 class CoreExport Module : public classbase, public usecountbase
279 /** Detach an event from this module
280 * @param i Event type to detach
282 void DetachEvent(Implementation i);
285 /** File that this module was loaded from
287 std::string ModuleSourceFile;
288 /** Reference to the dlopen() value
290 DLLManager* ModuleDLLManager;
292 /** If true, this module will be unloaded soon, further unload attempts will fail
293 * Value is used by the ModuleManager internally, you should not modify it
297 /** Default constructor.
298 * Creates a module class. Don't do any type of hook registration or checks
299 * for other modules here; do that in init().
304 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
306 virtual void init() {}
308 /** Clean up prior to destruction
309 * If you override, you must call this AFTER your module's cleanup
311 virtual CullResult cull();
313 /** Default destructor.
314 * destroys a module class
318 virtual void Prioritize()
322 /** Returns the version number of a Module.
323 * The method should return a Version object with its version information assigned via
326 virtual Version GetVersion() = 0;
328 /** Called when a user connects.
329 * The details of the connecting user are available to you in the parameter User *user
330 * @param user The user who is connecting
332 virtual void OnUserConnect(LocalUser* user);
334 /** Called when a user quits.
335 * The details of the exiting user are available to you in the parameter User *user
336 * This event is only called when the user is fully registered when they quit. To catch
337 * raw disconnections, use the OnUserDisconnect method.
338 * @param user The user who is quitting
339 * @param message The user's quit message (as seen by non-opers)
340 * @param oper_message The user's quit message (as seen by opers)
342 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
344 /** Called whenever a user's socket is closed.
345 * The details of the exiting user are available to you in the parameter User *user
346 * This event is called for all users, registered or not, as a cleanup method for modules
347 * which might assign resources to user, such as dns lookups, objects and sockets.
348 * @param user The user who is disconnecting
350 virtual void OnUserDisconnect(LocalUser* user);
352 /** Called whenever a channel is about to be deleted
353 * @param chan The channel being deleted
354 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
356 virtual ModResult OnChannelPreDelete(Channel *chan);
358 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
359 * @param chan The channel being deleted
361 virtual void OnChannelDelete(Channel* chan);
363 /** Called when a user joins a channel.
364 * The details of the joining user are available to you in the parameter User *user,
365 * and the details of the channel they have joined is available in the variable Channel *channel
366 * @param memb The channel membership being created
367 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
368 * to a channel due to the network sync.
369 * @param created This is true if the join created the channel
370 * @param except_list A list of users not to send to.
372 virtual void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list);
374 /** Called after a user joins a channel
375 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
377 * @param memb The channel membership created
379 virtual void OnPostJoin(Membership* memb);
381 /** Called when a user parts a channel.
382 * The details of the leaving user are available to you in the parameter User *user,
383 * and the details of the channel they have left is available in the variable Channel *channel
384 * @param memb The channel membership being destroyed
385 * @param partmessage The part message, or an empty string (may be modified)
386 * @param except_list A list of users to not send to.
388 virtual void OnUserPart(Membership* memb, std::string &partmessage, CUList& except_list);
390 /** Called on rehash.
391 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
392 * system. This is called in all cases -- including when this server will not execute the
393 * rehash because it is directed at a remote server.
395 * @param user The user performing the rehash, if any. If this is server initiated, the value of
396 * this variable will be NULL.
397 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
400 virtual void OnPreRehash(User* user, const std::string ¶meter);
402 /** Called on rehash.
403 * This method is called when a user initiates a module-specific rehash. This can be used to do
404 * expensive operations (such as reloading SSL certificates) that are not executed on a normal
405 * rehash for efficiency. A rehash of this type does not reload the core configuration.
407 * @param user The user performing the rehash.
408 * @param parameter The parameter given to REHASH
410 virtual void OnModuleRehash(User* user, const std::string ¶meter);
412 /** Called on rehash.
413 * This method is called after a rehash has completed. You should use it to reload any module
414 * configuration from the main configuration file.
415 * @param user The user that performed the rehash, if it was initiated by a user and that user
416 * is still connected.
418 virtual void OnRehash(User* user);
420 /** Called whenever a snotice is about to be sent to a snomask.
421 * snomask and type may both be modified; the message may not.
422 * @param snomask The snomask the message is going to (e.g. 'A')
423 * @param type The textual description the snomask will go to (e.g. 'OPER')
424 * @param message The text message to be sent via snotice
425 * @return 1 to block the snotice from being sent entirely, 0 else.
427 virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
429 /** Called whenever a user is about to join a channel, before any processing is done.
430 * Returning a value of 1 from this function stops the process immediately, causing no
431 * output to be sent to the user by the core. If you do this you must produce your own numerics,
432 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
433 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
437 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
438 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
439 * processing on the actual channel record at this point, however the channel NAME will still be passed in
440 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
441 * @param user The user joining the channel
442 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
443 * @param cname The channel name being joined. For new channels this is valid where chan is not.
444 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "o".
445 * You may alter this string to alter the user's modes on the channel.
446 * @param keygiven The key given to join the channel, or an empty string if none was provided
447 * @return 1 To prevent the join, 0 to allow it.
449 virtual ModResult OnUserPreJoin(LocalUser* user, Channel* chan, const std::string& cname, std::string& privs, const std::string& keygiven);
451 /** Called whenever a user is about to be kicked.
452 * Returning a value of 1 from this function stops the process immediately, causing no
453 * output to be sent to the user by the core. If you do this you must produce your own numerics,
455 * @param source The user issuing the kick
456 * @param memb The channel membership of the user who is being kicked.
457 * @param reason The kick reason
458 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
460 virtual ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason);
462 /** Called whenever a user is kicked.
463 * If this method is called, the kick is already underway and cannot be prevented, so
464 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
465 * @param source The user issuing the kick
466 * @param memb The channel membership of the user who was kicked.
467 * @param reason The kick reason
468 * @param except_list A list of users to not send to.
470 virtual void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except_list);
472 /** Called whenever a user opers locally.
473 * The User will contain the oper mode 'o' as this function is called after any modifications
474 * are made to the user's structure by the core.
475 * @param user The user who is opering up
476 * @param opertype The opers type name
478 virtual void OnOper(User* user, const std::string &opertype);
480 /** Called after a user opers locally.
481 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
482 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
483 * out the OPERTYPE, etc.
484 * @param user The user who is opering up
485 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
486 * @param opertype The opers type name
488 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
490 /** Called whenever a user types /INFO.
491 * The User will contain the information of the user who typed the command. Modules may use this
492 * method to output their own credits in /INFO (which is the ircd's version of an about box).
493 * It is purposefully not possible to modify any info that has already been output, or halt the list.
494 * You must write a 371 numeric to the user, containing your info in the following format:
496 * <nick> :information here
498 * @param user The user issuing /INFO
500 virtual void OnInfo(User* user);
502 /** Called whenever a /WHOIS is performed on a local user.
503 * The source parameter contains the details of the user who issued the WHOIS command, and
504 * the dest parameter contains the information of the user they are whoising.
505 * @param source The user issuing the WHOIS command
506 * @param dest The user who is being WHOISed
508 virtual void OnWhois(User* source, User* dest);
510 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
511 * Returning 1 from this function stops the process immediately, causing no
512 * output to be sent to the user by the core. If you do this you must produce your own numerics,
513 * notices etc. This is useful for modules which may want to filter invites to channels.
514 * @param source The user who is issuing the INVITE
515 * @param dest The user being invited
516 * @param channel The channel the user is being invited to
517 * @param timeout The time the invite will expire (0 == never)
518 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
520 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
522 /** Called after a user has been successfully invited to a channel.
523 * You cannot prevent the invite from occuring using this function, to do that,
524 * use OnUserPreInvite instead.
525 * @param source The user who is issuing the INVITE
526 * @param dest The user being invited
527 * @param channel The channel the user is being invited to
528 * @param timeout The time the invite will expire (0 == never)
530 virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout);
532 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
533 * Returning any nonzero value from this function stops the process immediately, causing no
534 * output to be sent to the user by the core. If you do this you must produce your own numerics,
535 * notices etc. This is useful for modules which may want to filter or redirect messages.
536 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
537 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
538 * of where the message is destined to be sent.
539 * @param user The user sending the message
540 * @param dest The target of the message (Channel* or User*)
541 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
542 * @param text Changeable text being sent by the user
543 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
544 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
545 * It will be ignored for private messages.
546 * @param msgtype The message type, MSG_PRIVMSG for PRIVMSGs, MSG_NOTICE for NOTICEs
547 * @return 1 to deny the message, 0 to allow it
549 virtual ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list, MessageType msgtype);
551 /** Called when sending a message to all "neighbors" of a given user -
552 * that is, all users that share a common channel. This is used in
553 * commands such as NICK, QUIT, etc.
554 * @param source The source of the message
555 * @param include_c Channels to scan for users to include
556 * @param exceptions Map of user->bool that overrides the inclusion decision
558 * Set exceptions[user] = true to include, exceptions[user] = false to exclude
560 virtual void OnBuildNeighborList(User* source, UserChanList &include_c, std::map<User*,bool> &exceptions);
562 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
563 * Please note that although you can see remote nickchanges through this function, you should
564 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
565 * check user->server before taking any action (including returning nonzero from the method).
566 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
567 * module to generate some meaninful output.
568 * @param user The username changing their nick
569 * @param newnick Their new nickname
570 * @return 1 to deny the change, 0 to allow
572 virtual ModResult OnUserPreNick(User* user, const std::string &newnick);
574 /** Called after any PRIVMSG sent from a user.
575 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
576 * if target_type is TYPE_CHANNEL.
577 * @param user The user sending the message
578 * @param dest The target of the message
579 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
580 * @param text the text being sent by the user
581 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
582 * @param exempt_list A list of users to not send to.
583 * @param msgtype The message type, MSG_PRIVMSG for PRIVMSGs, MSG_NOTICE for NOTICEs
585 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list, MessageType msgtype);
587 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
588 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
589 * if target_type is TYPE_CHANNEL.
590 * The difference between this event and OnUserPreMessage is that delivery is gauranteed,
591 * the message has already been vetted. In the case of the other two methods, a later module may stop your
592 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
593 * @param user The user sending the message
594 * @param dest The target of the message
595 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
596 * @param text the text being sent by the user
597 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
598 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
600 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
602 /** Called after every MODE command sent from a user
603 * Either the usertarget or the chantarget variable contains the target of the modes,
604 * the actual target will have a non-NULL pointer.
605 * The modes vector contains the remainder of the mode string after the target,
606 * e.g.: "+wsi" or ["+ooo", "nick1", "nick2", "nick3"].
607 * @param user The user sending the MODEs
608 * @param usertarget The target user of the modes, NULL if the target is a channel
609 * @param chantarget The target channel of the modes, NULL if the target is a user
610 * @param modes The actual modes and their parameters if any
611 * @param translate The translation types of the mode parameters
613 virtual void OnMode(User* user, User* usertarget, Channel* chantarget, const std::vector<std::string>& modes, const std::vector<TranslateType>& translate);
615 /** Allows modules to alter or create server descriptions
616 * Whenever a module requires a server description, for example for display in
617 * WHOIS, this function is called in all modules. You may change or define the
618 * description given in std::string &description. If you do, this description
619 * will be shown in the WHOIS fields.
620 * @param servername The servername being searched for
621 * @param description Alterable server description for this server
623 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
625 /** Allows modules to synchronize data which relates to users during a netburst.
626 * When this function is called, it will be called from the module which implements
627 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
628 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
629 * (see below). This function will be called for every user visible on your side
630 * of the burst, allowing you to for example set modes, etc. Do not use this call to
631 * synchronize data which you have stored using class Extensible -- There is a specialist
632 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
633 * @param user The user being syncronized
634 * @param proto A pointer to the module handling network protocol
635 * @param opaque An opaque pointer set by the protocol module, should not be modified!
637 virtual void OnSyncUser(User* user, Module* proto, void* opaque);
639 /** Allows modules to synchronize data which relates to channels during a netburst.
640 * When this function is called, it will be called from the module which implements
641 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
642 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
643 * (see below). This function will be called for every user visible on your side
644 * of the burst, allowing you to for example set modes, etc.
646 * @param chan The channel being syncronized
647 * @param proto A pointer to the module handling network protocol
648 * @param opaque An opaque pointer set by the protocol module, should not be modified!
650 virtual void OnSyncChannel(Channel* chan, Module* proto, void* opaque);
652 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
653 * Whenever the linking module wants to send out data, but doesnt know what the data
654 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
655 * this method is called. You should use the ProtoSendMetaData function after you've
656 * correctly decided how the data should be represented, to send the metadata on its way if
657 * if it belongs to your module.
658 * @param proto A pointer to the module handling network protocol
659 * @param opaque An opaque pointer set by the protocol module, should not be modified!
660 * @param displayable If this value is true, the data is going to be displayed to a user,
661 * and not sent across the network. Use this to determine wether or not to show sensitive data.
663 virtual void OnSyncNetwork(Module* proto, void* opaque);
665 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
666 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
667 * @param target The Channel* or User* that data should be added to
668 * @param extname The extension name which is being sent
669 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
671 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
673 /** Implemented by modules which provide the ability to link servers.
674 * These modules will implement this method, which allows transparent sending of servermodes
675 * down the network link as a broadcast, without a module calling it having to know the format
676 * of the MODE command before the actual mode string.
678 * @param opaque An opaque pointer set by the protocol module, should not be modified!
679 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
680 * @param target The Channel* or User* that modes should be sent for
681 * @param modeline The modes and parameters to be sent
682 * @param translate The translation types of the mode parameters
684 virtual void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::vector<std::string> &modeline, const std::vector<TranslateType> &translate);
686 /** Implemented by modules which provide the ability to link servers.
687 * These modules will implement this method, which allows metadata (extra data added to
688 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
689 * to other servers on a netburst and decoded at the other end by the same module on a
692 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
693 * how to use this function.
694 * @param opaque An opaque pointer set by the protocol module, should not be modified!
695 * @param target The Channel* or User* that metadata should be sent for
696 * @param extname The extension name to send metadata for
697 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
699 virtual void ProtoSendMetaData(void* opaque, Extensible* target, const std::string &extname, const std::string &extdata);
701 /** Called whenever a user's hostname is changed.
702 * This event triggers after the host has been set.
703 * @param user The user whos host is being changed
704 * @param newhost The new hostname being set
706 virtual void OnChangeHost(User* user, const std::string &newhost);
708 /** Called whenever a user's GECOS (realname) is changed.
709 * This event triggers after the name has been set.
710 * @param user The user who's GECOS is being changed
711 * @param gecos The new GECOS being set on the user
713 virtual void OnChangeName(User* user, const std::string &gecos);
715 /** Called whenever a user's IDENT is changed.
716 * This event triggers after the name has been set.
717 * @param user The user who's IDENT is being changed
718 * @param ident The new IDENT being set on the user
720 virtual void OnChangeIdent(User* user, const std::string &ident);
722 /** Called whenever an xline is added by a local user.
723 * This method is triggered after the line is added.
724 * @param source The sender of the line or NULL for local server
725 * @param line The xline being added
727 virtual void OnAddLine(User* source, XLine* line);
729 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
730 * This method is triggered after the line is deleted.
731 * @param source The user removing the line or NULL for local server
732 * @param line the line being deleted
734 virtual void OnDelLine(User* source, XLine* line);
736 /** Called whenever an xline expires.
737 * This method is triggered after the line is deleted.
738 * @param line The line being deleted.
740 virtual void OnExpireLine(XLine *line);
742 /** Called before your module is unloaded to clean up Extensibles.
743 * This method is called once for every user and channel on the network,
744 * so that when your module unloads it may clear up any remaining data
745 * in the form of Extensibles added using Extensible::Extend().
746 * If the target_type variable is TYPE_USER, then void* item refers to
747 * a User*, otherwise it refers to a Channel*.
748 * @param target_type The type of item being cleaned
749 * @param item A pointer to the item's class
751 virtual void OnCleanup(int target_type, void* item);
753 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
754 * have been applied. Please note that although you can see remote nickchanges through this function, you should
755 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
756 * check user->server before taking any action (including returning nonzero from the method).
757 * Because this method is called after the nickchange is taken place, no return values are possible
758 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
759 * @param user The user changing their nick
760 * @param oldnick The old nickname of the user before the nickchange
762 virtual void OnUserPostNick(User* user, const std::string &oldnick);
764 /** Called before any mode change, to allow a single access check for
765 * a full mode change (use OnRawMode to check individual modes)
767 * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
768 * OnRawMode for each individual mode
770 * @param source the user making the mode change
771 * @param dest the user destination of the umode change (NULL if a channel mode)
772 * @param channel the channel destination of the mode change
773 * @param parameters raw mode parameters; parameters[0] is the user/channel being changed
775 virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, const std::vector<std::string>& parameters);
777 /** Called when a 005 numeric is about to be output.
778 * The module should modify the 005 numeric if needed to indicate its features.
779 * @param tokens The 005 map to be modified if neccessary.
781 virtual void On005Numeric(std::map<std::string, std::string>& tokens);
783 /** Called when a client is disconnected by KILL.
784 * If a client is killed by a server, e.g. a nickname collision or protocol error,
786 * Return 1 from this function to prevent the kill, and 0 from this function to allow
787 * it as normal. If you prevent the kill no output will be sent to the client, it is
788 * down to your module to generate this information.
789 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
790 * If you do so youre risking race conditions, desyncs and worse!
791 * @param source The user sending the KILL
792 * @param dest The user being killed
793 * @param reason The kill reason
794 * @return 1 to prevent the kill, 0 to allow
796 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
798 /** Called whenever a module is loaded.
799 * mod will contain a pointer to the module, and string will contain its name,
800 * for example m_widgets.so. This function is primary for dependency checking,
801 * your module may decide to enable some extra features if it sees that you have
802 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
803 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
804 * but instead operate under reduced functionality, unless the dependency is
805 * absolutely neccessary (e.g. a module that extends the features of another
807 * @param mod A pointer to the new module
809 virtual void OnLoadModule(Module* mod);
811 /** Called whenever a module is unloaded.
812 * mod will contain a pointer to the module, and string will contain its name,
813 * for example m_widgets.so. This function is primary for dependency checking,
814 * your module may decide to enable some extra features if it sees that you have
815 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
816 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
817 * but instead operate under reduced functionality, unless the dependency is
818 * absolutely neccessary (e.g. a module that extends the features of another
820 * @param mod Pointer to the module being unloaded (still valid)
822 virtual void OnUnloadModule(Module* mod);
824 /** Called once every five seconds for background processing.
825 * This timer can be used to control timed features. Its period is not accurate
826 * enough to be used as a clock, but it is gauranteed to be called at least once in
827 * any five second period, directly from the main loop of the server.
828 * @param curtime The current timer derived from time(2)
830 virtual void OnBackgroundTimer(time_t curtime);
832 /** Called whenever any command is about to be executed.
833 * This event occurs for all registered commands, wether they are registered in the core,
834 * or another module, and for invalid commands. Invalid commands may only be sent to this
835 * function when the value of validated is false. By returning 1 from this method you may prevent the
836 * command being executed. If you do this, no output is created by the core, and it is
837 * down to your module to produce any output neccessary.
838 * Note that unless you return 1, you should not destroy any structures (e.g. by using
839 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
840 * method returns, it will be passed an invalid pointer to the user object and crash!)
841 * @param command The command being executed
842 * @param parameters An array of array of characters containing the parameters for the command
843 * @param user the user issuing the command
844 * @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.
845 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
846 * @param original_line The entire original line as passed to the parser from the user
847 * @return 1 to block the command, 0 to allow
849 virtual ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, LocalUser *user, bool validated, const std::string &original_line);
851 /** Called after any command has been executed.
852 * This event occurs for all registered commands, wether they are registered in the core,
853 * or another module, but it will not occur for invalid commands (e.g. ones which do not
854 * exist within the command table). The result code returned by the command handler is
856 * @param command The command being executed
857 * @param parameters An array of array of characters containing the parameters for the command
858 * @param user the user issuing the command
859 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
860 * @param original_line The entire original line as passed to the parser from the user
862 virtual void OnPostCommand(Command* command, const std::vector<std::string>& parameters, LocalUser* user, CmdResult result, const std::string& original_line);
864 /** Called when a user is first connecting, prior to starting DNS lookups, checking initial
865 * connect class, or accepting any commands.
867 virtual void OnUserInit(LocalUser* user);
869 /** Called to check if a user who is connecting can now be allowed to register
870 * If any modules return false for this function, the user is held in the waiting
871 * state until all modules return true. For example a module which implements ident
872 * lookups will continue to return false for a user until their ident lookup is completed.
873 * Note that the registration timeout for a user overrides these checks, if the registration
874 * timeout is reached, the user is disconnected even if modules report that the user is
875 * not ready to connect.
876 * @param user The user to check
877 * @return true to indicate readiness, false if otherwise
879 virtual ModResult OnCheckReady(LocalUser* user);
881 /** Called whenever a user is about to register their connection (e.g. before the user
882 * is sent the MOTD etc). Modules can use this method if they are performing a function
883 * which must be done before the actual connection is completed (e.g. ident lookups,
884 * dnsbl lookups, etc).
885 * Note that you should NOT delete the user record here by causing a disconnection!
886 * Use OnUserConnect for that instead.
887 * @param user The user registering
888 * @return 1 to indicate user quit, 0 to continue
890 virtual ModResult OnUserRegister(LocalUser* user);
892 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
893 * This method will always be called for each join, wether or not the channel is actually +i, and
894 * determines the outcome of an if statement around the whole section of invite checking code.
895 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
896 * @param user The user joining the channel
897 * @param chan The channel being joined
898 * @return 1 to explicitly allow the join, 0 to proceed as normal
900 virtual ModResult OnCheckInvite(User* user, Channel* chan);
902 /** Called whenever a mode character is processed.
903 * Return 1 from this function to block the mode character from being processed entirely.
904 * @param user The user who is sending the mode
905 * @param chan The channel the mode is being sent to (or NULL if a usermode)
906 * @param mode The mode character being set
907 * @param param The parameter for the mode or an empty string
908 * @param adding true of the mode is being added, false if it is being removed
909 * @param pcnt The parameter count for the mode (0 or 1)
910 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
911 * to skip all permission checking. Please note that for remote mode changes, your return value
914 virtual ModResult OnRawMode(User* user, Channel* chan, const char mode, const std::string ¶m, bool adding, int pcnt);
916 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
917 * This method will always be called for each join, wether or not the channel is actually +k, and
918 * determines the outcome of an if statement around the whole section of key checking code.
919 * if the user specified no key, the keygiven string will be a valid but empty value.
920 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
921 * @param user The user joining the channel
922 * @param chan The channel being joined
923 * @param keygiven The key given on joining the channel.
924 * @return 1 to explicitly allow the join, 0 to proceed as normal
926 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
928 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
929 * This method will always be called for each join, wether or not the channel is actually +l, and
930 * determines the outcome of an if statement around the whole section of channel limit checking code.
931 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
932 * @param user The user joining the channel
933 * @param chan The channel being joined
934 * @return 1 to explicitly allow the join, 0 to proceed as normal
936 virtual ModResult OnCheckLimit(User* user, Channel* chan);
939 * Checks for a user's ban from the channel
940 * @param user The user to check
941 * @param chan The channel to check in
942 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
943 * ban check, or MOD_RES_PASSTHRU to check bans normally
945 virtual ModResult OnCheckChannelBan(User* user, Channel* chan);
948 * Checks for a user's match of a single ban
949 * @param user The user to check for match
950 * @param chan The channel on which the match is being checked
951 * @param mask The mask being checked
952 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
953 * ban check, or MOD_RES_PASSTHRU to check bans normally
955 virtual ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask);
957 /** Checks for a match on a given extban type
958 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
959 * ban check, or MOD_RES_PASSTHRU to check bans normally
961 virtual ModResult OnExtBanCheck(User* user, Channel* chan, char type);
963 /** Called on all /STATS commands
964 * This method is triggered for all /STATS use, including stats symbols handled by the core.
965 * @param symbol the symbol provided to /STATS
966 * @param user the user issuing the /STATS command
967 * @param results A string_list to append results into. You should put all your results
968 * into this string_list, rather than displaying them directly, so that your handler will
969 * work when remote STATS queries are received.
970 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
972 virtual ModResult OnStats(char symbol, User* user, string_list &results);
974 /** Called whenever a change of a local users displayed host is attempted.
975 * Return 1 to deny the host change, or 0 to allow it.
976 * @param user The user whos host will be changed
977 * @param newhost The new hostname
978 * @return 1 to deny the host change, 0 to allow
980 virtual ModResult OnChangeLocalUserHost(LocalUser* user, const std::string &newhost);
982 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
983 * return 1 to deny the name change, or 0 to allow it.
984 * @param user The user whos GECOS will be changed
985 * @param newhost The new GECOS
986 * @return 1 to deny the GECOS change, 0 to allow
988 virtual ModResult OnChangeLocalUserGECOS(LocalUser* user, const std::string &newhost);
990 /** Called before a topic is changed.
991 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
992 * As with other 'pre' events, you should only ever block a local event.
993 * @param user The user changing the topic
994 * @param chan The channels who's topic is being changed
995 * @param topic The actual topic text
996 * @return 1 to block the topic change, 0 to allow
998 virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
1000 /** Called whenever a topic has been changed.
1001 * To block topic changes you must use OnPreTopicChange instead.
1002 * @param user The user changing the topic
1003 * @param chan The channels who's topic is being changed
1004 * @param topic The actual topic text
1006 virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
1008 /** Called whenever an Event class is sent to all modules by another module.
1009 * You should *always* check the value of Event::id to determine the event type.
1010 * @param event The Event class being received
1012 virtual void OnEvent(Event& event);
1014 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
1015 * The password field (from the config file) is in 'password' and is to be compared against
1016 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
1017 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
1018 * @param ex The object that's causing the authentication (User* for \<oper> \<connect:allow> etc, Server* for \<link>).
1019 * @param password The password from the configuration file (the password="" value).
1020 * @param input The password entered by the user or whoever.
1021 * @param hashtype The hash value from the config
1022 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
1024 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
1026 /** Called whenever a user is given usermode +o, anywhere on the network.
1027 * You cannot override this and prevent it from happening as it is already happened and
1028 * such a task must be performed by another server. You can however bounce modes by sending
1029 * servermodes out to reverse mode changes.
1030 * @param user The user who is opering
1032 virtual void OnGlobalOper(User* user);
1034 /** Called after a user has fully connected and all modules have executed OnUserConnect
1035 * This event is informational only. You should not change any user information in this
1036 * event. To do so, use the OnUserConnect method to change the state of local users.
1037 * This is called for both local and remote users.
1038 * @param user The user who is connecting
1040 virtual void OnPostConnect(User* user);
1042 /** Called to install an I/O hook on an event handler
1043 * @param user The socket to possibly install the I/O hook on
1044 * @param via The port that the user connected on
1046 virtual void OnHookIO(StreamSocket* user, ListenSocket* via);
1048 /** Called when a port accepts a connection
1049 * Return MOD_RES_ACCEPT if you have used the file descriptor.
1050 * @param fd The file descriptor returned from accept()
1051 * @param sock The socket connection for the new user
1052 * @param client The client IP address and port
1053 * @param server The server IP address and port
1055 virtual ModResult OnAcceptConnection(int fd, ListenSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
1057 /** Called whenever a user sets away or returns from being away.
1058 * The away message is available as a parameter, but should not be modified.
1059 * At this stage, it has already been copied into the user record.
1060 * If awaymsg is empty, the user is returning from away.
1061 * @param user The user setting away
1062 * @param awaymsg The away message of the user, or empty if returning from away
1063 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
1065 virtual ModResult OnSetAway(User* user, const std::string &awaymsg);
1067 /** Called whenever a line of WHOIS output is sent to a user.
1068 * You may change the numeric and the text of the output by changing
1069 * the values numeric and text, but you cannot change the user the
1070 * numeric is sent to. You may however change the user's User values.
1071 * @param user The user the numeric is being sent to
1072 * @param dest The user being WHOISed
1073 * @param numeric The numeric of the line being sent
1074 * @param text The text of the numeric, including any parameters
1075 * @return nonzero to drop the line completely so that the user does not
1076 * receive it, or zero to allow the line to be sent.
1078 virtual ModResult OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
1080 /** Called at intervals for modules to garbage-collect any hashes etc.
1081 * Certain data types such as hash_map 'leak' buckets, which must be
1082 * tidied up and freed by copying into a new item every so often. This
1083 * method is called when it is time to do that.
1085 virtual void OnGarbageCollect();
1087 /** Called when a user's connect class is being matched
1088 * @return MOD_RES_ALLOW to force the class to match, MOD_RES_DENY to forbid it, or
1089 * MOD_RES_PASSTHRU to allow normal matching (by host/port).
1091 virtual ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass);
1093 /** Add test suite hooks here. These are used for testing functionality of a module
1094 * via the --testsuite debugging parameter.
1096 virtual void OnRunTestSuite();
1098 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
1099 * For example NAMESX, channel mode +u and +I, and UHNAMES. If the nick is set to an empty string by any
1100 * module, then this will cause the nickname not to be displayed at all.
1102 virtual void OnNamesListItem(User* issuer, Membership* item, std::string &prefixes, std::string &nick);
1104 virtual ModResult OnNumeric(User* user, unsigned int numeric, const std::string &text);
1106 /** Called whenever a result from /WHO is about to be returned
1107 * @param source The user running the /WHO query
1108 * @param params The parameters to the /WHO query
1109 * @param user The user that this line of the query is about
1110 * @param line The raw line to send; modifiable, if empty no line will be returned.
1112 virtual void OnSendWhoLine(User* source, const std::vector<std::string>& params, User* user, std::string& line);
1114 /** Called whenever a local user's IP is set for the first time, or when a local user's IP changes due to
1115 * a module like m_cgiirc changing it.
1116 * @param user The user whose IP is being set
1118 virtual void OnSetUserIP(LocalUser* user);
1121 /** Provides an easy method of reading a text file into memory. */
1122 class CoreExport FileReader : public classbase
1124 /** The lines of text in the file.
1126 std::vector<std::string> lines;
1128 /** Content size in bytes
1130 unsigned long totalSize;
1133 /** Initializes a new file reader.
1135 FileReader() : totalSize(0) { }
1137 /** Initializes a new file reader and reads the specified file.
1138 * @param filename The file to read into memory.
1140 FileReader(const std::string& filename);
1142 /** Loads a text file from disk.
1143 * @param filename The file to read into memory.
1144 * @throw CoreException The file can not be loaded.
1146 void Load(const std::string& filename);
1148 /** Retrieves the entire contents of the file cache as a single string.
1150 std::string GetString();
1152 /** Retrieves the entire contents of the file cache as a vector of strings.
1154 const std::vector<std::string>& GetVector() { return lines; }
1156 unsigned long TotalSize() { return totalSize; }
1159 /** A list of modules
1161 typedef std::vector<Module*> IntModuleList;
1163 /** An event handler iterator
1165 typedef IntModuleList::iterator EventHandlerIter;
1167 /** ModuleManager takes care of all things module-related
1170 class CoreExport ModuleManager
1173 /** Holds a string describing the last module error to occur
1175 std::string LastModuleError;
1177 /** Total number of modules loaded into the ircd
1181 /** List of loaded modules and shared object/dll handles
1182 * keyed by module name
1184 std::map<std::string, Module*> Modules;
1190 } prioritizationState;
1192 /** Internal unload module hook */
1193 bool CanUnload(Module*);
1196 /** Event handler hooks.
1197 * This needs to be public to be used by FOREACH_MOD and friends.
1199 IntModuleList EventHandlers[I_END];
1201 /** List of data services keyed by name */
1202 std::multimap<std::string, ServiceProvider*> DataProviders;
1204 /** Simple, bog-standard, boring constructor.
1212 /** Change the priority of one event in a module.
1213 * Each module event has a list of modules which are attached to that event type.
1214 * If you wish to be called before or after other specific modules, you may use this
1215 * method (usually within void Module::Prioritize()) to set your events priority.
1216 * You may use this call in other methods too, however, this is not supported behaviour
1218 * @param mod The module to change the priority of
1219 * @param i The event to change the priority of
1220 * @param s The state you wish to use for this event. Use one of
1221 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1222 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1223 * to set it to be before or after one or more other modules.
1224 * @param which If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1225 * then this contains a the module that your module must be placed before
1228 bool SetPriority(Module* mod, Implementation i, Priority s, Module* which = NULL);
1230 /** Backwards compat interface */
1231 inline bool SetPriority(Module* mod, Implementation i, Priority s, Module** dptr)
1233 return SetPriority(mod, i, s, *dptr);
1236 /** Change the priority of all events in a module.
1237 * @param mod The module to set the priority of
1238 * @param s The priority of all events in the module.
1239 * Note that with this method, it is not possible to effectively use
1240 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1241 * SetPriority method for this, where you may specify other modules to
1242 * be prioritized against.
1244 bool SetPriority(Module* mod, Priority s);
1246 /** Attach an event to a module.
1247 * You may later detatch the event with ModuleManager::Detach().
1248 * If your module is unloaded, all events are automatically detatched.
1249 * @param i Event type to attach
1250 * @param mod Module to attach event to
1251 * @return True if the event was attached
1253 bool Attach(Implementation i, Module* mod);
1255 /** Detatch an event from a module.
1256 * This is not required when your module unloads, as the core will
1257 * automatically detatch your module from all events it is attached to.
1258 * @param i Event type to detach
1259 * @param mod Module to detach event from
1260 * @return True if the event was detached
1262 bool Detach(Implementation i, Module* mod);
1264 /** Attach an array of events to a module
1265 * @param i Event types (array) to attach
1266 * @param mod Module to attach events to
1267 * @param sz The size of the implementation array
1269 void Attach(Implementation* i, Module* mod, size_t sz);
1271 /** Detach all events from a module (used on unload)
1272 * @param mod Module to detach from
1274 void DetachAll(Module* mod);
1276 /** Attach all events to a module (used on module load)
1277 * @param mod Module to attach to all events
1279 void AttachAll(Module* mod);
1281 /** Returns text describing the last module error
1282 * @return The last error message to occur
1284 std::string& LastError();
1286 /** Load a given module file
1287 * @param filename The file to load
1288 * @param defer Defer module init (loading many modules)
1289 * @return True if the module was found and loaded
1291 bool Load(const std::string& filename, bool defer = false);
1293 /** Unload a given module file. Note that the module will not be
1294 * completely gone until the cull list has finished processing.
1296 * @return true on success; if false, LastError will give a reason
1298 bool Unload(Module* module);
1300 /** Run an asynchronous reload of the given module. When the reload is
1301 * complete, the callback will be run with true if the reload succeeded
1302 * and false if it did not.
1304 void Reload(Module* module, HandlerBase1<void, bool>* callback);
1306 /** Called by the InspIRCd constructor to load all modules from the config file.
1310 void DoSafeUnload(Module*);
1312 /** Get the total number of currently loaded modules
1313 * @return The number of loaded modules
1317 return this->ModCount;
1320 /** Find a module by name, and return a Module* to it.
1321 * This is preferred over iterating the module lists yourself.
1322 * @param name The module name to look up
1323 * @return A pointer to the module, or NULL if the module cannot be found
1325 Module* Find(const std::string &name);
1327 /** Register a service provided by a module */
1328 void AddService(ServiceProvider&);
1330 /** Unregister a service provided by a module */
1331 void DelService(ServiceProvider&);
1333 inline void AddServices(ServiceProvider** list, int count)
1335 for(int i=0; i < count; i++)
1336 AddService(*list[i]);
1339 /** Find a service by name.
1340 * If multiple modules provide a given service, the first one loaded will be chosen.
1342 ServiceProvider* FindService(ServiceType Type, const std::string& name);
1344 template<typename T> inline T* FindDataService(const std::string& name)
1346 return static_cast<T*>(FindService(SERVICE_DATA, name));
1349 /** Return a list of all modules matching the given filter
1350 * @param filter This int is a bitmask of flags set in Module::Flags,
1351 * such as VF_VENDOR or VF_STATIC. If you wish to receive a list of
1352 * all modules with no filtering, set this to 0.
1353 * @return The list of module names
1355 const std::vector<std::string> GetAllModuleNames(int filter);
1358 /** Do not mess with these functions unless you know the C preprocessor
1359 * well enough to explain why they are needed. The order is important.
1361 #define MODULE_INIT_STR MODULE_INIT_STR_FN_2(MODULE_INIT_SYM)
1362 #define MODULE_INIT_STR_FN_2(x) MODULE_INIT_STR_FN_1(x)
1363 #define MODULE_INIT_STR_FN_1(x) #x
1364 #define MODULE_INIT_SYM MODULE_INIT_SYM_FN_2(INSPIRCD_VERSION_MAJ, INSPIRCD_VERSION_API)
1365 #define MODULE_INIT_SYM_FN_2(x,y) MODULE_INIT_SYM_FN_1(x,y)
1366 #define MODULE_INIT_SYM_FN_1(x,y) inspircd_module_ ## x ## _ ## y
1370 struct AllCommandList {
1371 typedef Command* (*fn)(Module*);
1372 AllCommandList(fn cmd);
1374 #define COMMAND_INIT(x) static Command* MK_ ## x(Module* m) { return new x(m); } \
1375 static const AllCommandList PREP_ ## x(&MK_ ## x);
1377 struct AllModuleList {
1378 typedef Module* (*fn)();
1381 AllModuleList(fn mod, const std::string& Name);
1384 #define MODULE_INIT(x) static Module* MK_ ## x() { return new x; } \
1385 static const AllModuleList PREP_ ## x(&MK_ ## x, MODNAMESTR);
1387 #define MODNAMESTR MODNAMESTR_FN_2(MODNAME)
1388 #define MODNAMESTR_FN_2(x) MODNAMESTR_FN_1(x)
1389 #define MODNAMESTR_FN_1(x) #x
1393 /** This definition is used as shorthand for the various classes
1394 * and functions needed to make a module loadable by the OS.
1395 * It defines the class factory and external init_module function.
1399 #define MODULE_INIT(y) \
1400 extern "C" DllExport Module * MODULE_INIT_SYM() \
1404 BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
1406 switch ( nReason ) \
1408 case DLL_PROCESS_ATTACH: \
1409 case DLL_PROCESS_DETACH: \
1417 #define MODULE_INIT(y) \
1418 extern "C" DllExport Module * MODULE_INIT_SYM() \
1422 extern "C" const char inspircd_src_version[] = VERSION " " REVISION;
1425 #define COMMAND_INIT(c) MODULE_INIT(CommandModule<c>)