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,
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 /** This method is called when you should reload module specific configuration:
323 * on boot, on a /REHASH and on module load.
324 * @param status The current status, can be inspected for more information;
325 * also used for reporting configuration errors and warnings.
327 virtual void ReadConfig(ConfigStatus& status);
329 /** Returns the version number of a Module.
330 * The method should return a Version object with its version information assigned via
333 virtual Version GetVersion() = 0;
335 /** Called when a user connects.
336 * The details of the connecting user are available to you in the parameter User *user
337 * @param user The user who is connecting
339 virtual void OnUserConnect(LocalUser* user);
341 /** Called when a user quits.
342 * The details of the exiting user are available to you in the parameter User *user
343 * This event is only called when the user is fully registered when they quit. To catch
344 * raw disconnections, use the OnUserDisconnect method.
345 * @param user The user who is quitting
346 * @param message The user's quit message (as seen by non-opers)
347 * @param oper_message The user's quit message (as seen by opers)
349 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
351 /** Called whenever a user's socket is closed.
352 * The details of the exiting user are available to you in the parameter User *user
353 * This event is called for all users, registered or not, as a cleanup method for modules
354 * which might assign resources to user, such as dns lookups, objects and sockets.
355 * @param user The user who is disconnecting
357 virtual void OnUserDisconnect(LocalUser* user);
359 /** Called whenever a channel is about to be deleted
360 * @param chan The channel being deleted
361 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
363 virtual ModResult OnChannelPreDelete(Channel *chan);
365 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
366 * @param chan The channel being deleted
368 virtual void OnChannelDelete(Channel* chan);
370 /** Called when a user joins a channel.
371 * The details of the joining user are available to you in the parameter User *user,
372 * and the details of the channel they have joined is available in the variable Channel *channel
373 * @param memb The channel membership being created
374 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
375 * to a channel due to the network sync.
376 * @param created This is true if the join created the channel
377 * @param except_list A list of users not to send to.
379 virtual void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list);
381 /** Called after a user joins a channel
382 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
384 * @param memb The channel membership created
386 virtual void OnPostJoin(Membership* memb);
388 /** Called when a user parts a channel.
389 * The details of the leaving user are available to you in the parameter User *user,
390 * and the details of the channel they have left is available in the variable Channel *channel
391 * @param memb The channel membership being destroyed
392 * @param partmessage The part message, or an empty string (may be modified)
393 * @param except_list A list of users to not send to.
395 virtual void OnUserPart(Membership* memb, std::string &partmessage, CUList& except_list);
397 /** Called on rehash.
398 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
399 * system. This is called in all cases -- including when this server will not execute the
400 * rehash because it is directed at a remote server.
402 * @param user The user performing the rehash, if any. If this is server initiated, the value of
403 * this variable will be NULL.
404 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
407 virtual void OnPreRehash(User* user, const std::string ¶meter);
409 /** Called on rehash.
410 * This method is called when a user initiates a module-specific rehash. This can be used to do
411 * expensive operations (such as reloading SSL certificates) that are not executed on a normal
412 * rehash for efficiency. A rehash of this type does not reload the core configuration.
414 * @param user The user performing the rehash.
415 * @param parameter The parameter given to REHASH
417 virtual void OnModuleRehash(User* user, const std::string ¶meter);
419 /** Called whenever a snotice is about to be sent to a snomask.
420 * snomask and type may both be modified; the message may not.
421 * @param snomask The snomask the message is going to (e.g. 'A')
422 * @param type The textual description the snomask will go to (e.g. 'OPER')
423 * @param message The text message to be sent via snotice
424 * @return 1 to block the snotice from being sent entirely, 0 else.
426 virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
428 /** Called whenever a user is about to join a channel, before any processing is done.
429 * Returning a value of 1 from this function stops the process immediately, causing no
430 * output to be sent to the user by the core. If you do this you must produce your own numerics,
431 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
432 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
436 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
437 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
438 * processing on the actual channel record at this point, however the channel NAME will still be passed in
439 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
440 * @param user The user joining the channel
441 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
442 * @param cname The channel name being joined. For new channels this is valid where chan is not.
443 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "o".
444 * You may alter this string to alter the user's modes on the channel.
445 * @param keygiven The key given to join the channel, or an empty string if none was provided
446 * @return 1 To prevent the join, 0 to allow it.
448 virtual ModResult OnUserPreJoin(LocalUser* user, Channel* chan, const std::string& cname, std::string& privs, const std::string& keygiven);
450 /** Called whenever a user is about to be kicked.
451 * Returning a value of 1 from this function stops the process immediately, causing no
452 * output to be sent to the user by the core. If you do this you must produce your own numerics,
454 * @param source The user issuing the kick
455 * @param memb The channel membership of the user who is being kicked.
456 * @param reason The kick reason
457 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
459 virtual ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason);
461 /** Called whenever a user is kicked.
462 * If this method is called, the kick is already underway and cannot be prevented, so
463 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
464 * @param source The user issuing the kick
465 * @param memb The channel membership of the user who was kicked.
466 * @param reason The kick reason
467 * @param except_list A list of users to not send to.
469 virtual void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except_list);
471 /** Called whenever a user opers locally.
472 * The User will contain the oper mode 'o' as this function is called after any modifications
473 * are made to the user's structure by the core.
474 * @param user The user who is opering up
475 * @param opertype The opers type name
477 virtual void OnOper(User* user, const std::string &opertype);
479 /** Called after a user opers locally.
480 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
481 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
482 * out the OPERTYPE, etc.
483 * @param user The user who is opering up
484 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
485 * @param opertype The opers type name
487 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
489 /** Called whenever a user types /INFO.
490 * The User will contain the information of the user who typed the command. Modules may use this
491 * method to output their own credits in /INFO (which is the ircd's version of an about box).
492 * It is purposefully not possible to modify any info that has already been output, or halt the list.
493 * You must write a 371 numeric to the user, containing your info in the following format:
495 * <nick> :information here
497 * @param user The user issuing /INFO
499 virtual void OnInfo(User* user);
501 /** Called whenever a /WHOIS is performed on a local user.
502 * The source parameter contains the details of the user who issued the WHOIS command, and
503 * the dest parameter contains the information of the user they are whoising.
504 * @param source The user issuing the WHOIS command
505 * @param dest The user who is being WHOISed
507 virtual void OnWhois(User* source, User* dest);
509 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
510 * Returning 1 from this function stops the process immediately, causing no
511 * output to be sent to the user by the core. If you do this you must produce your own numerics,
512 * notices etc. This is useful for modules which may want to filter invites to channels.
513 * @param source The user who is issuing the INVITE
514 * @param dest The user being invited
515 * @param channel The channel the user is being invited to
516 * @param timeout The time the invite will expire (0 == never)
517 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
519 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
521 /** Called after a user has been successfully invited to a channel.
522 * You cannot prevent the invite from occuring using this function, to do that,
523 * use OnUserPreInvite instead.
524 * @param source The user who is issuing the INVITE
525 * @param dest The user being invited
526 * @param channel The channel the user is being invited to
527 * @param timeout The time the invite will expire (0 == never)
529 virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout);
531 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
532 * Returning any nonzero value from this function stops the process immediately, causing no
533 * output to be sent to the user by the core. If you do this you must produce your own numerics,
534 * notices etc. This is useful for modules which may want to filter or redirect messages.
535 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
536 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
537 * of where the message is destined to be sent.
538 * @param user The user sending the message
539 * @param dest The target of the message (Channel* or User*)
540 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
541 * @param text Changeable text being sent by the user
542 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
543 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
544 * It will be ignored for private messages.
545 * @param msgtype The message type, MSG_PRIVMSG for PRIVMSGs, MSG_NOTICE for NOTICEs
546 * @return 1 to deny the message, 0 to allow it
548 virtual ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list, MessageType msgtype);
550 /** Called when sending a message to all "neighbors" of a given user -
551 * that is, all users that share a common channel. This is used in
552 * commands such as NICK, QUIT, etc.
553 * @param source The source of the message
554 * @param include_c Channels to scan for users to include
555 * @param exceptions Map of user->bool that overrides the inclusion decision
557 * Set exceptions[user] = true to include, exceptions[user] = false to exclude
559 virtual void OnBuildNeighborList(User* source, UserChanList &include_c, std::map<User*,bool> &exceptions);
561 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
562 * Please note that although you can see remote nickchanges through this function, you should
563 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
564 * check user->server before taking any action (including returning nonzero from the method).
565 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
566 * module to generate some meaninful output.
567 * @param user The username changing their nick
568 * @param newnick Their new nickname
569 * @return 1 to deny the change, 0 to allow
571 virtual ModResult OnUserPreNick(User* user, const std::string &newnick);
573 /** Called after any PRIVMSG sent from a user.
574 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
575 * if target_type is TYPE_CHANNEL.
576 * @param user The user sending the message
577 * @param dest The target of the message
578 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
579 * @param text the text being sent by the user
580 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
581 * @param exempt_list A list of users to not send to.
582 * @param msgtype The message type, MSG_PRIVMSG for PRIVMSGs, MSG_NOTICE for NOTICEs
584 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list, MessageType msgtype);
586 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
587 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
588 * if target_type is TYPE_CHANNEL.
589 * The difference between this event and OnUserPreMessage is that delivery is gauranteed,
590 * the message has already been vetted. In the case of the other two methods, a later module may stop your
591 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
592 * @param user The user sending the message
593 * @param dest The target of the message
594 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
595 * @param text the text being sent by the user
596 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
597 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
599 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
601 /** Called after every MODE command sent from a user
602 * Either the usertarget or the chantarget variable contains the target of the modes,
603 * the actual target will have a non-NULL pointer.
604 * The modes vector contains the remainder of the mode string after the target,
605 * e.g.: "+wsi" or ["+ooo", "nick1", "nick2", "nick3"].
606 * @param user The user sending the MODEs
607 * @param usertarget The target user of the modes, NULL if the target is a channel
608 * @param chantarget The target channel of the modes, NULL if the target is a user
609 * @param modes The actual modes and their parameters if any
610 * @param translate The translation types of the mode parameters
612 virtual void OnMode(User* user, User* usertarget, Channel* chantarget, const std::vector<std::string>& modes, const std::vector<TranslateType>& translate);
614 /** Allows modules to alter or create server descriptions
615 * Whenever a module requires a server description, for example for display in
616 * WHOIS, this function is called in all modules. You may change or define the
617 * description given in std::string &description. If you do, this description
618 * will be shown in the WHOIS fields.
619 * @param servername The servername being searched for
620 * @param description Alterable server description for this server
622 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
624 /** Allows modules to synchronize data which relates to users during a netburst.
625 * When this function is called, it will be called from the module which implements
626 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
627 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
628 * (see below). This function will be called for every user visible on your side
629 * of the burst, allowing you to for example set modes, etc. Do not use this call to
630 * synchronize data which you have stored using class Extensible -- There is a specialist
631 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
632 * @param user The user being syncronized
633 * @param proto A pointer to the module handling network protocol
634 * @param opaque An opaque pointer set by the protocol module, should not be modified!
636 virtual void OnSyncUser(User* user, Module* proto, void* opaque);
638 /** Allows modules to synchronize data which relates to channels during a netburst.
639 * When this function is called, it will be called from the module which implements
640 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
641 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
642 * (see below). This function will be called for every user visible on your side
643 * of the burst, allowing you to for example set modes, etc.
645 * @param chan The channel being syncronized
646 * @param proto A pointer to the module handling network protocol
647 * @param opaque An opaque pointer set by the protocol module, should not be modified!
649 virtual void OnSyncChannel(Channel* chan, Module* proto, void* opaque);
651 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
652 * Whenever the linking module wants to send out data, but doesnt know what the data
653 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
654 * this method is called. You should use the ProtoSendMetaData function after you've
655 * correctly decided how the data should be represented, to send the metadata on its way if
656 * if it belongs to your module.
657 * @param proto A pointer to the module handling network protocol
658 * @param opaque An opaque pointer set by the protocol module, should not be modified!
659 * @param displayable If this value is true, the data is going to be displayed to a user,
660 * and not sent across the network. Use this to determine wether or not to show sensitive data.
662 virtual void OnSyncNetwork(Module* proto, void* opaque);
664 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
665 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
666 * @param target The Channel* or User* that data should be added to
667 * @param extname The extension name which is being sent
668 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
670 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
672 /** Implemented by modules which provide the ability to link servers.
673 * These modules will implement this method, which allows transparent sending of servermodes
674 * down the network link as a broadcast, without a module calling it having to know the format
675 * of the MODE command before the actual mode string.
677 * @param opaque An opaque pointer set by the protocol module, should not be modified!
678 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
679 * @param target The Channel* or User* that modes should be sent for
680 * @param modeline The modes and parameters to be sent
681 * @param translate The translation types of the mode parameters
683 virtual void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::vector<std::string> &modeline, const std::vector<TranslateType> &translate);
685 /** Implemented by modules which provide the ability to link servers.
686 * These modules will implement this method, which allows metadata (extra data added to
687 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
688 * to other servers on a netburst and decoded at the other end by the same module on a
691 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
692 * how to use this function.
693 * @param opaque An opaque pointer set by the protocol module, should not be modified!
694 * @param target The Channel* or User* that metadata should be sent for
695 * @param extname The extension name to send metadata for
696 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
698 virtual void ProtoSendMetaData(void* opaque, Extensible* target, const std::string &extname, const std::string &extdata);
700 /** Called whenever a user's hostname is changed.
701 * This event triggers after the host has been set.
702 * @param user The user whos host is being changed
703 * @param newhost The new hostname being set
705 virtual void OnChangeHost(User* user, const std::string &newhost);
707 /** Called whenever a user's GECOS (realname) is changed.
708 * This event triggers after the name has been set.
709 * @param user The user who's GECOS is being changed
710 * @param gecos The new GECOS being set on the user
712 virtual void OnChangeName(User* user, const std::string &gecos);
714 /** Called whenever a user's IDENT is changed.
715 * This event triggers after the name has been set.
716 * @param user The user who's IDENT is being changed
717 * @param ident The new IDENT being set on the user
719 virtual void OnChangeIdent(User* user, const std::string &ident);
721 /** Called whenever an xline is added by a local user.
722 * This method is triggered after the line is added.
723 * @param source The sender of the line or NULL for local server
724 * @param line The xline being added
726 virtual void OnAddLine(User* source, XLine* line);
728 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
729 * This method is triggered after the line is deleted.
730 * @param source The user removing the line or NULL for local server
731 * @param line the line being deleted
733 virtual void OnDelLine(User* source, XLine* line);
735 /** Called whenever an xline expires.
736 * This method is triggered after the line is deleted.
737 * @param line The line being deleted.
739 virtual void OnExpireLine(XLine *line);
741 /** Called before your module is unloaded to clean up Extensibles.
742 * This method is called once for every user and channel on the network,
743 * so that when your module unloads it may clear up any remaining data
744 * in the form of Extensibles added using Extensible::Extend().
745 * If the target_type variable is TYPE_USER, then void* item refers to
746 * a User*, otherwise it refers to a Channel*.
747 * @param target_type The type of item being cleaned
748 * @param item A pointer to the item's class
750 virtual void OnCleanup(int target_type, void* item);
752 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
753 * have been applied. Please note that although you can see remote nickchanges through this function, you should
754 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
755 * check user->server before taking any action (including returning nonzero from the method).
756 * Because this method is called after the nickchange is taken place, no return values are possible
757 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
758 * @param user The user changing their nick
759 * @param oldnick The old nickname of the user before the nickchange
761 virtual void OnUserPostNick(User* user, const std::string &oldnick);
763 /** Called before any mode change, to allow a single access check for
764 * a full mode change (use OnRawMode to check individual modes)
766 * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
767 * OnRawMode for each individual mode
769 * @param source the user making the mode change
770 * @param dest the user destination of the umode change (NULL if a channel mode)
771 * @param channel the channel destination of the mode change
772 * @param parameters raw mode parameters; parameters[0] is the user/channel being changed
774 virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, const std::vector<std::string>& parameters);
776 /** Called when a 005 numeric is about to be output.
777 * The module should modify the 005 numeric if needed to indicate its features.
778 * @param tokens The 005 map to be modified if neccessary.
780 virtual void On005Numeric(std::map<std::string, std::string>& tokens);
782 /** Called when a client is disconnected by KILL.
783 * If a client is killed by a server, e.g. a nickname collision or protocol error,
785 * Return 1 from this function to prevent the kill, and 0 from this function to allow
786 * it as normal. If you prevent the kill no output will be sent to the client, it is
787 * down to your module to generate this information.
788 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
789 * If you do so youre risking race conditions, desyncs and worse!
790 * @param source The user sending the KILL
791 * @param dest The user being killed
792 * @param reason The kill reason
793 * @return 1 to prevent the kill, 0 to allow
795 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
797 /** Called whenever a module is loaded.
798 * mod will contain a pointer to the module, and string will contain its name,
799 * for example m_widgets.so. This function is primary for dependency checking,
800 * your module may decide to enable some extra features if it sees that you have
801 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
802 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
803 * but instead operate under reduced functionality, unless the dependency is
804 * absolutely neccessary (e.g. a module that extends the features of another
806 * @param mod A pointer to the new module
808 virtual void OnLoadModule(Module* mod);
810 /** Called whenever a module is unloaded.
811 * mod will contain a pointer to the module, and string will contain its name,
812 * for example m_widgets.so. This function is primary for dependency checking,
813 * your module may decide to enable some extra features if it sees that you have
814 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
815 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
816 * but instead operate under reduced functionality, unless the dependency is
817 * absolutely neccessary (e.g. a module that extends the features of another
819 * @param mod Pointer to the module being unloaded (still valid)
821 virtual void OnUnloadModule(Module* mod);
823 /** Called once every five seconds for background processing.
824 * This timer can be used to control timed features. Its period is not accurate
825 * enough to be used as a clock, but it is gauranteed to be called at least once in
826 * any five second period, directly from the main loop of the server.
827 * @param curtime The current timer derived from time(2)
829 virtual void OnBackgroundTimer(time_t curtime);
831 /** Called whenever any command is about to be executed.
832 * This event occurs for all registered commands, wether they are registered in the core,
833 * or another module, and for invalid commands. Invalid commands may only be sent to this
834 * function when the value of validated is false. By returning 1 from this method you may prevent the
835 * command being executed. If you do this, no output is created by the core, and it is
836 * down to your module to produce any output neccessary.
837 * Note that unless you return 1, you should not destroy any structures (e.g. by using
838 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
839 * method returns, it will be passed an invalid pointer to the user object and crash!)
840 * @param command The command being executed
841 * @param parameters An array of array of characters containing the parameters for the command
842 * @param user the user issuing the command
843 * @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.
844 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
845 * @param original_line The entire original line as passed to the parser from the user
846 * @return 1 to block the command, 0 to allow
848 virtual ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, LocalUser *user, bool validated, const std::string &original_line);
850 /** Called after any command has been executed.
851 * This event occurs for all registered commands, wether they are registered in the core,
852 * or another module, but it will not occur for invalid commands (e.g. ones which do not
853 * exist within the command table). The result code returned by the command handler is
855 * @param command The command being executed
856 * @param parameters An array of array of characters containing the parameters for the command
857 * @param user the user issuing the command
858 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
859 * @param original_line The entire original line as passed to the parser from the user
861 virtual void OnPostCommand(Command* command, const std::vector<std::string>& parameters, LocalUser* user, CmdResult result, const std::string& original_line);
863 /** Called when a user is first connecting, prior to starting DNS lookups, checking initial
864 * connect class, or accepting any commands.
866 virtual void OnUserInit(LocalUser* user);
868 /** Called to check if a user who is connecting can now be allowed to register
869 * If any modules return false for this function, the user is held in the waiting
870 * state until all modules return true. For example a module which implements ident
871 * lookups will continue to return false for a user until their ident lookup is completed.
872 * Note that the registration timeout for a user overrides these checks, if the registration
873 * timeout is reached, the user is disconnected even if modules report that the user is
874 * not ready to connect.
875 * @param user The user to check
876 * @return true to indicate readiness, false if otherwise
878 virtual ModResult OnCheckReady(LocalUser* user);
880 /** Called whenever a user is about to register their connection (e.g. before the user
881 * is sent the MOTD etc). Modules can use this method if they are performing a function
882 * which must be done before the actual connection is completed (e.g. ident lookups,
883 * dnsbl lookups, etc).
884 * Note that you should NOT delete the user record here by causing a disconnection!
885 * Use OnUserConnect for that instead.
886 * @param user The user registering
887 * @return 1 to indicate user quit, 0 to continue
889 virtual ModResult OnUserRegister(LocalUser* user);
891 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
892 * This method will always be called for each join, wether or not the channel is actually +i, and
893 * determines the outcome of an if statement around the whole section of invite checking code.
894 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
895 * @param user The user joining the channel
896 * @param chan The channel being joined
897 * @return 1 to explicitly allow the join, 0 to proceed as normal
899 virtual ModResult OnCheckInvite(User* user, Channel* chan);
901 /** Called whenever a mode character is processed.
902 * Return 1 from this function to block the mode character from being processed entirely.
903 * @param user The user who is sending the mode
904 * @param chan The channel the mode is being sent to (or NULL if a usermode)
905 * @param mode The mode character being set
906 * @param param The parameter for the mode or an empty string
907 * @param adding true of the mode is being added, false if it is being removed
908 * @param pcnt The parameter count for the mode (0 or 1)
909 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
910 * to skip all permission checking. Please note that for remote mode changes, your return value
913 virtual ModResult OnRawMode(User* user, Channel* chan, const char mode, const std::string ¶m, bool adding, int pcnt);
915 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
916 * This method will always be called for each join, wether or not the channel is actually +k, and
917 * determines the outcome of an if statement around the whole section of key checking code.
918 * if the user specified no key, the keygiven string will be a valid but empty value.
919 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
920 * @param user The user joining the channel
921 * @param chan The channel being joined
922 * @param keygiven The key given on joining the channel.
923 * @return 1 to explicitly allow the join, 0 to proceed as normal
925 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
927 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
928 * This method will always be called for each join, wether or not the channel is actually +l, and
929 * determines the outcome of an if statement around the whole section of channel limit checking code.
930 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
931 * @param user The user joining the channel
932 * @param chan The channel being joined
933 * @return 1 to explicitly allow the join, 0 to proceed as normal
935 virtual ModResult OnCheckLimit(User* user, Channel* chan);
938 * Checks for a user's ban from the channel
939 * @param user The user to check
940 * @param chan The channel to check in
941 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
942 * ban check, or MOD_RES_PASSTHRU to check bans normally
944 virtual ModResult OnCheckChannelBan(User* user, Channel* chan);
947 * Checks for a user's match of a single ban
948 * @param user The user to check for match
949 * @param chan The channel on which the match is being checked
950 * @param mask The mask being checked
951 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
952 * ban check, or MOD_RES_PASSTHRU to check bans normally
954 virtual ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask);
956 /** Checks for a match on a given extban type
957 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
958 * ban check, or MOD_RES_PASSTHRU to check bans normally
960 virtual ModResult OnExtBanCheck(User* user, Channel* chan, char type);
962 /** Called on all /STATS commands
963 * This method is triggered for all /STATS use, including stats symbols handled by the core.
964 * @param symbol the symbol provided to /STATS
965 * @param user the user issuing the /STATS command
966 * @param results A string_list to append results into. You should put all your results
967 * into this string_list, rather than displaying them directly, so that your handler will
968 * work when remote STATS queries are received.
969 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
971 virtual ModResult OnStats(char symbol, User* user, string_list &results);
973 /** Called whenever a change of a local users displayed host is attempted.
974 * Return 1 to deny the host change, or 0 to allow it.
975 * @param user The user whos host will be changed
976 * @param newhost The new hostname
977 * @return 1 to deny the host change, 0 to allow
979 virtual ModResult OnChangeLocalUserHost(LocalUser* user, const std::string &newhost);
981 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
982 * return 1 to deny the name change, or 0 to allow it.
983 * @param user The user whos GECOS will be changed
984 * @param newhost The new GECOS
985 * @return 1 to deny the GECOS change, 0 to allow
987 virtual ModResult OnChangeLocalUserGECOS(LocalUser* user, const std::string &newhost);
989 /** Called before a topic is changed.
990 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
991 * As with other 'pre' events, you should only ever block a local event.
992 * @param user The user changing the topic
993 * @param chan The channels who's topic is being changed
994 * @param topic The actual topic text
995 * @return 1 to block the topic change, 0 to allow
997 virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
999 /** Called whenever a topic has been changed.
1000 * To block topic changes you must use OnPreTopicChange instead.
1001 * @param user The user changing the topic
1002 * @param chan The channels who's topic is being changed
1003 * @param topic The actual topic text
1005 virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
1007 /** Called whenever an Event class is sent to all modules by another module.
1008 * You should *always* check the value of Event::id to determine the event type.
1009 * @param event The Event class being received
1011 virtual void OnEvent(Event& event);
1013 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
1014 * The password field (from the config file) is in 'password' and is to be compared against
1015 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
1016 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
1017 * @param ex The object that's causing the authentication (User* for \<oper> \<connect:allow> etc, Server* for \<link>).
1018 * @param password The password from the configuration file (the password="" value).
1019 * @param input The password entered by the user or whoever.
1020 * @param hashtype The hash value from the config
1021 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
1023 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
1025 /** Called whenever a user is given usermode +o, anywhere on the network.
1026 * You cannot override this and prevent it from happening as it is already happened and
1027 * such a task must be performed by another server. You can however bounce modes by sending
1028 * servermodes out to reverse mode changes.
1029 * @param user The user who is opering
1031 virtual void OnGlobalOper(User* user);
1033 /** Called after a user has fully connected and all modules have executed OnUserConnect
1034 * This event is informational only. You should not change any user information in this
1035 * event. To do so, use the OnUserConnect method to change the state of local users.
1036 * This is called for both local and remote users.
1037 * @param user The user who is connecting
1039 virtual void OnPostConnect(User* user);
1041 /** Called to install an I/O hook on an event handler
1042 * @param user The socket to possibly install the I/O hook on
1043 * @param via The port that the user connected on
1045 virtual void OnHookIO(StreamSocket* user, ListenSocket* via);
1047 /** Called when a port accepts a connection
1048 * Return MOD_RES_ACCEPT if you have used the file descriptor.
1049 * @param fd The file descriptor returned from accept()
1050 * @param sock The socket connection for the new user
1051 * @param client The client IP address and port
1052 * @param server The server IP address and port
1054 virtual ModResult OnAcceptConnection(int fd, ListenSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
1056 /** Called whenever a user sets away or returns from being away.
1057 * The away message is available as a parameter, but should not be modified.
1058 * At this stage, it has already been copied into the user record.
1059 * If awaymsg is empty, the user is returning from away.
1060 * @param user The user setting away
1061 * @param awaymsg The away message of the user, or empty if returning from away
1062 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
1064 virtual ModResult OnSetAway(User* user, const std::string &awaymsg);
1066 /** Called whenever a line of WHOIS output is sent to a user.
1067 * You may change the numeric and the text of the output by changing
1068 * the values numeric and text, but you cannot change the user the
1069 * numeric is sent to. You may however change the user's User values.
1070 * @param user The user the numeric is being sent to
1071 * @param dest The user being WHOISed
1072 * @param numeric The numeric of the line being sent
1073 * @param text The text of the numeric, including any parameters
1074 * @return nonzero to drop the line completely so that the user does not
1075 * receive it, or zero to allow the line to be sent.
1077 virtual ModResult OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
1079 /** Called at intervals for modules to garbage-collect any hashes etc.
1080 * Certain data types such as hash_map 'leak' buckets, which must be
1081 * tidied up and freed by copying into a new item every so often. This
1082 * method is called when it is time to do that.
1084 virtual void OnGarbageCollect();
1086 /** Called when a user's connect class is being matched
1087 * @return MOD_RES_ALLOW to force the class to match, MOD_RES_DENY to forbid it, or
1088 * MOD_RES_PASSTHRU to allow normal matching (by host/port).
1090 virtual ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass);
1092 /** Add test suite hooks here. These are used for testing functionality of a module
1093 * via the --testsuite debugging parameter.
1095 virtual void OnRunTestSuite();
1097 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
1098 * For example NAMESX, channel mode +u and +I, and UHNAMES. If the nick is set to an empty string by any
1099 * module, then this will cause the nickname not to be displayed at all.
1101 virtual void OnNamesListItem(User* issuer, Membership* item, std::string &prefixes, std::string &nick);
1103 virtual ModResult OnNumeric(User* user, unsigned int numeric, const std::string &text);
1105 /** Called whenever a result from /WHO is about to be returned
1106 * @param source The user running the /WHO query
1107 * @param params The parameters to the /WHO query
1108 * @param user The user that this line of the query is about
1109 * @param line The raw line to send; modifiable, if empty no line will be returned.
1111 virtual void OnSendWhoLine(User* source, const std::vector<std::string>& params, User* user, std::string& line);
1113 /** Called whenever a local user's IP is set for the first time, or when a local user's IP changes due to
1114 * a module like m_cgiirc changing it.
1115 * @param user The user whose IP is being set
1117 virtual void OnSetUserIP(LocalUser* user);
1120 /** Provides an easy method of reading a text file into memory. */
1121 class CoreExport FileReader : public classbase
1123 /** The lines of text in the file.
1125 std::vector<std::string> lines;
1127 /** Content size in bytes
1129 unsigned long totalSize;
1132 /** Initializes a new file reader.
1134 FileReader() : totalSize(0) { }
1136 /** Initializes a new file reader and reads the specified file.
1137 * @param filename The file to read into memory.
1139 FileReader(const std::string& filename);
1141 /** Loads a text file from disk.
1142 * @param filename The file to read into memory.
1143 * @throw CoreException The file can not be loaded.
1145 void Load(const std::string& filename);
1147 /** Retrieves the entire contents of the file cache as a single string.
1149 std::string GetString();
1151 /** Retrieves the entire contents of the file cache as a vector of strings.
1153 const std::vector<std::string>& GetVector() { return lines; }
1155 unsigned long TotalSize() { return totalSize; }
1158 /** A list of modules
1160 typedef std::vector<Module*> IntModuleList;
1162 /** An event handler iterator
1164 typedef IntModuleList::iterator EventHandlerIter;
1166 /** ModuleManager takes care of all things module-related
1169 class CoreExport ModuleManager
1172 /** Holds a string describing the last module error to occur
1174 std::string LastModuleError;
1176 /** Total number of modules loaded into the ircd
1180 /** List of loaded modules and shared object/dll handles
1181 * keyed by module name
1183 std::map<std::string, Module*> Modules;
1189 } prioritizationState;
1191 /** Internal unload module hook */
1192 bool CanUnload(Module*);
1195 typedef std::map<std::string, Module*> ModuleMap;
1197 /** Event handler hooks.
1198 * This needs to be public to be used by FOREACH_MOD and friends.
1200 IntModuleList EventHandlers[I_END];
1202 /** List of data services keyed by name */
1203 std::multimap<std::string, ServiceProvider*> DataProviders;
1205 /** Simple, bog-standard, boring constructor.
1213 /** Change the priority of one event in a module.
1214 * Each module event has a list of modules which are attached to that event type.
1215 * If you wish to be called before or after other specific modules, you may use this
1216 * method (usually within void Module::Prioritize()) to set your events priority.
1217 * You may use this call in other methods too, however, this is not supported behaviour
1219 * @param mod The module to change the priority of
1220 * @param i The event to change the priority of
1221 * @param s The state you wish to use for this event. Use one of
1222 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1223 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1224 * to set it to be before or after one or more other modules.
1225 * @param which If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1226 * then this contains a the module that your module must be placed before
1229 bool SetPriority(Module* mod, Implementation i, Priority s, Module* which = NULL);
1231 /** Backwards compat interface */
1232 inline bool SetPriority(Module* mod, Implementation i, Priority s, Module** dptr)
1234 return SetPriority(mod, i, s, *dptr);
1237 /** Change the priority of all events in a module.
1238 * @param mod The module to set the priority of
1239 * @param s The priority of all events in the module.
1240 * Note that with this method, it is not possible to effectively use
1241 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1242 * SetPriority method for this, where you may specify other modules to
1243 * be prioritized against.
1245 bool SetPriority(Module* mod, Priority s);
1247 /** Attach an event to a module.
1248 * You may later detatch the event with ModuleManager::Detach().
1249 * If your module is unloaded, all events are automatically detatched.
1250 * @param i Event type to attach
1251 * @param mod Module to attach event to
1252 * @return True if the event was attached
1254 bool Attach(Implementation i, Module* mod);
1256 /** Detatch an event from a module.
1257 * This is not required when your module unloads, as the core will
1258 * automatically detatch your module from all events it is attached to.
1259 * @param i Event type to detach
1260 * @param mod Module to detach event from
1261 * @return True if the event was detached
1263 bool Detach(Implementation i, Module* mod);
1265 /** Attach an array of events to a module
1266 * @param i Event types (array) to attach
1267 * @param mod Module to attach events to
1268 * @param sz The size of the implementation array
1270 void Attach(Implementation* i, Module* mod, size_t sz);
1272 /** Detach all events from a module (used on unload)
1273 * @param mod Module to detach from
1275 void DetachAll(Module* mod);
1277 /** Attach all events to a module (used on module load)
1278 * @param mod Module to attach to all events
1280 void AttachAll(Module* mod);
1282 /** Returns text describing the last module error
1283 * @return The last error message to occur
1285 std::string& LastError();
1287 /** Load a given module file
1288 * @param filename The file to load
1289 * @param defer Defer module init (loading many modules)
1290 * @return True if the module was found and loaded
1292 bool Load(const std::string& filename, bool defer = false);
1294 /** Unload a given module file. Note that the module will not be
1295 * completely gone until the cull list has finished processing.
1297 * @return true on success; if false, LastError will give a reason
1299 bool Unload(Module* module);
1301 /** Run an asynchronous reload of the given module. When the reload is
1302 * complete, the callback will be run with true if the reload succeeded
1303 * and false if it did not.
1305 void Reload(Module* module, HandlerBase1<void, bool>* callback);
1307 /** Called by the InspIRCd constructor to load all modules from the config file.
1311 void DoSafeUnload(Module*);
1313 /** Get the total number of currently loaded modules
1314 * @return The number of loaded modules
1318 return this->ModCount;
1321 /** Find a module by name, and return a Module* to it.
1322 * This is preferred over iterating the module lists yourself.
1323 * @param name The module name to look up
1324 * @return A pointer to the module, or NULL if the module cannot be found
1326 Module* Find(const std::string &name);
1328 /** Register a service provided by a module */
1329 void AddService(ServiceProvider&);
1331 /** Unregister a service provided by a module */
1332 void DelService(ServiceProvider&);
1334 inline void AddServices(ServiceProvider** list, int count)
1336 for(int i=0; i < count; i++)
1337 AddService(*list[i]);
1340 /** Find a service by name.
1341 * If multiple modules provide a given service, the first one loaded will be chosen.
1343 ServiceProvider* FindService(ServiceType Type, const std::string& name);
1345 template<typename T> inline T* FindDataService(const std::string& name)
1347 return static_cast<T*>(FindService(SERVICE_DATA, name));
1350 /** Get a map of all loaded modules keyed by their name
1351 * @return A ModuleMap containing all loaded modules
1353 const ModuleMap& GetModules() const { return Modules; }
1356 /** Do not mess with these functions unless you know the C preprocessor
1357 * well enough to explain why they are needed. The order is important.
1359 #define MODULE_INIT_STR MODULE_INIT_STR_FN_2(MODULE_INIT_SYM)
1360 #define MODULE_INIT_STR_FN_2(x) MODULE_INIT_STR_FN_1(x)
1361 #define MODULE_INIT_STR_FN_1(x) #x
1362 #define MODULE_INIT_SYM MODULE_INIT_SYM_FN_2(INSPIRCD_VERSION_MAJ, INSPIRCD_VERSION_API)
1363 #define MODULE_INIT_SYM_FN_2(x,y) MODULE_INIT_SYM_FN_1(x,y)
1364 #define MODULE_INIT_SYM_FN_1(x,y) inspircd_module_ ## x ## _ ## y
1368 struct AllCommandList {
1369 typedef Command* (*fn)(Module*);
1370 AllCommandList(fn cmd);
1372 #define COMMAND_INIT(x) static Command* MK_ ## x(Module* m) { return new x(m); } \
1373 static const AllCommandList PREP_ ## x(&MK_ ## x);
1375 struct AllModuleList {
1376 typedef Module* (*fn)();
1379 AllModuleList(fn mod, const std::string& Name);
1382 #define MODULE_INIT(x) static Module* MK_ ## x() { return new x; } \
1383 static const AllModuleList PREP_ ## x(&MK_ ## x, MODNAME ".so");
1387 /** This definition is used as shorthand for the various classes
1388 * and functions needed to make a module loadable by the OS.
1389 * It defines the class factory and external init_module function.
1393 #define MODULE_INIT(y) \
1394 extern "C" DllExport Module * MODULE_INIT_SYM() \
1398 BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
1400 switch ( nReason ) \
1402 case DLL_PROCESS_ATTACH: \
1403 case DLL_PROCESS_DETACH: \
1411 #define MODULE_INIT(y) \
1412 extern "C" DllExport Module * MODULE_INIT_SYM() \
1416 extern "C" const char inspircd_src_version[] = VERSION " " REVISION;
1419 #define COMMAND_INIT(c) MODULE_INIT(CommandModule<c>)