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/>.
32 #include "inspsocket.h"
40 /** Used to define a set of behavior bits for a module
43 VF_NONE = 0, // module is not special at all
44 VF_STATIC = 1, // module is static, cannot be /unloadmodule'd
45 VF_VENDOR = 2, // module is a vendor module (came in the original tarball, not 3rd party)
46 VF_COMMON = 4, // module needs to be common on all servers in a network to link
47 VF_OPTCOMMON = 8, // module should be common on all servers for unsurprising behavior
48 VF_CORE = 16 // module is a core command, can be assumed loaded on all servers
51 /** Used to represent an event type, for user, channel or server
53 enum TargetTypeFlags {
60 /** Used to represent wether a message was PRIVMSG or NOTICE
67 #define MOD_RES_ALLOW (ModResult(1))
68 #define MOD_RES_PASSTHRU (ModResult(0))
69 #define MOD_RES_DENY (ModResult(-1))
71 /** Used to represent an allow/deny module result.
72 * Not constructed as an enum because it reverses the value logic of some functions;
73 * the compiler will inline accesses to have the same efficiency as integer operations.
77 ModResult() : res(0) {}
78 explicit ModResult(int r) : res(r) {}
79 inline bool operator==(const ModResult& r) const
83 inline bool operator!=(const ModResult& r) const
87 inline bool operator!() const
91 inline bool check(bool def) const
93 return (res == 1 || (res == 0 && def));
96 * Merges two results, preferring ALLOW to DENY
98 inline ModResult operator+(const ModResult& r) const
100 if (res == r.res || r.res == 0)
104 // they are different, and neither is passthru
105 return MOD_RES_ALLOW;
109 /** InspIRCd major version.
110 * 1.2 -> 102; 2.1 -> 201; 2.12 -> 212
112 #define INSPIRCD_VERSION_MAJ 200
113 /** InspIRCd API version.
114 * If you change any API elements, increment this value. This counter should be
115 * reset whenever the major version is changed. Modules can use these two values
116 * and numerical comparisons in preprocessor macros if they wish to support
117 * multiple versions of InspIRCd in one file.
119 #define INSPIRCD_VERSION_API 11
122 * This #define allows us to call a method in all
123 * loaded modules in a readable simple way, e.g.:
124 * 'FOREACH_MOD(I_OnConnect,OnConnect(user));'
126 #define FOREACH_MOD(y,x) do { \
127 EventHandlerIter safei; \
128 for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ) \
136 catch (CoreException& modexcept) \
138 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
145 * Custom module result handling loop. This is a paired macro, and should only
146 * be used with while_each_hook.
148 * See src/channels.cpp for an example of use.
150 #define DO_EACH_HOOK(n,v,args) \
152 EventHandlerIter iter_ ## n = ServerInstance->Modules->EventHandlers[I_ ## n].begin(); \
153 while (iter_ ## n != ServerInstance->Modules->EventHandlers[I_ ## n].end()) \
155 Module* mod_ ## n = *iter_ ## n; \
159 v = (mod_ ## n)->n args;
161 #define WHILE_EACH_HOOK(n) \
163 catch (CoreException& except_ ## n) \
165 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s", (except_ ## n).GetReason()); \
166 (void) mod_ ## n; /* catch mismatched pairs */ \
172 * Module result iterator
173 * Runs the given hook until some module returns a useful result.
175 * Example: ModResult result;
176 * FIRST_MOD_RESULT(OnUserPreNick, result, (user, newnick))
178 #define FIRST_MOD_RESULT(n,v,args) do { \
179 v = MOD_RES_PASSTHRU; \
180 DO_EACH_HOOK(n,v,args) \
182 if (v != MOD_RES_PASSTHRU) \
185 WHILE_EACH_HOOK(n); \
188 /** Holds a module's Version information.
189 * The members (set by the constructor only) indicate details as to the version number
190 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
192 class CoreExport Version
195 /** Module description
197 const std::string description;
203 /** Server linking description string */
204 const std::string link_data;
206 /** Simple module version */
207 Version(const std::string &desc, int flags = VF_NONE);
209 /** Complex version information, including linking compatability data */
210 Version(const std::string &desc, int flags, const std::string& linkdata);
212 virtual ~Version() {}
215 /** The Request class is a unicast message directed at a given module.
216 * When this class is properly instantiated it may be sent to a module
217 * using the Send() method, which will call the given module's OnRequest
218 * method with this class as its parameter.
220 class CoreExport Request : public classbase
223 /** This should be a null-terminated string identifying the type of request,
224 * all modules should define this and use it to determine the nature of the
225 * request before they attempt to cast the Request in any way.
227 const char* const id;
228 /** This is a pointer to the sender of the message, which can be used to
229 * directly trigger events, or to create a reply.
232 /** The single destination of the Request
236 /** Create a new Request
237 * This is for the 'new' way of defining a subclass
238 * of Request and defining it in a common header,
239 * passing an object of your Request subclass through
240 * as a Request* and using the ID string to determine
241 * what to cast it back to and the other end.
243 Request(Module* src, Module* dst, const char* idstr);
244 /** Send the Request.
250 /** The Event class is a unicast message directed at all modules.
251 * When the class is properly instantiated it may be sent to all modules
252 * using the Send() method, which will trigger the OnEvent method in
253 * all modules passing the object as its parameter.
255 class CoreExport Event : public classbase
258 /** This is a pointer to the sender of the message, which can be used to
259 * directly trigger events, or to create a reply.
262 /** The event identifier.
263 * This is arbitary text which should be used to distinguish
264 * one type of event from another.
266 const std::string id;
268 /** Create a new Event
270 Event(Module* src, const std::string &eventid);
272 * The return result of an Event::Send() will always be NULL as
273 * no replies are expected.
278 class CoreExport DataProvider : public ServiceProvider
281 DataProvider(Module* Creator, const std::string& Name)
282 : ServiceProvider(Creator, Name, SERVICE_DATA) {}
285 class CoreExport dynamic_reference_base : public interfacebase
293 dynamic_reference_base(Module* Creator, const std::string& Name);
294 ~dynamic_reference_base();
295 inline void ClearCache() { value = NULL; }
296 inline const std::string& GetProvider() { return name; }
297 void SetProvider(const std::string& newname);
300 static void reset_all();
304 class dynamic_reference : public dynamic_reference_base
307 dynamic_reference(Module* Creator, const std::string& Name)
308 : dynamic_reference_base(Creator, Name) {}
309 inline T* operator->()
313 return static_cast<T*>(value);
317 /** Priority types which can be used by Module::Prioritize()
319 enum Priority { PRIORITY_FIRST, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
321 /** Implementation-specific flags which may be set in Module::Implements()
326 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash,
327 I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois,
328 I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick,
329 I_OnUserMessage, I_OnUserNotice, I_OnMode, I_OnGetServerDescription, I_OnSyncUser,
330 I_OnSyncChannel, I_OnDecodeMetaData, I_OnWallops, I_OnAcceptConnection, I_OnUserInit,
331 I_OnChangeHost, I_OnChangeName, I_OnAddLine, I_OnDelLine, I_OnExpireLine,
332 I_OnUserPostNick, I_OnPreMode, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule,
333 I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite,
334 I_OnRawMode, I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckChannelBan, I_OnExtBanCheck,
335 I_OnStats, I_OnChangeLocalUserHost, I_OnPreTopicChange, I_OnPostDeoper,
336 I_OnPostTopicChange, I_OnEvent, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan,
337 I_OnDelBan, I_OnChangeLocalUserGECOS, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
338 I_OnPostOper, I_OnSyncNetwork, I_OnSetAway, I_OnPostCommand, I_OnPostJoin,
339 I_OnWhoisLine, I_OnBuildNeighborList, I_OnGarbageCollect, I_OnSetConnectClass,
340 I_OnText, I_OnPassCompare, I_OnRunTestSuite, I_OnNamesListItem, I_OnNumeric, I_OnHookIO,
341 I_OnPreRehash, I_OnModuleRehash, I_OnSendWhoLine, I_OnChangeIdent, I_OnSetUserIP,
345 /** Base class for all InspIRCd modules
346 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
347 * its methods will be called when irc server events occur. class inherited from module must be
348 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
350 class CoreExport Module : public classbase, public usecountbase
353 /** File that this module was loaded from
355 std::string ModuleSourceFile;
356 /** Reference to the dlopen() value
358 DLLManager* ModuleDLLManager;
360 /** If true, this module will be unloaded soon, further unload attempts will fail
361 * Value is used by the ModuleManager internally, you should not modify it
365 /** Default constructor.
366 * Creates a module class. Don't do any type of hook registration or checks
367 * for other modules here; do that in init().
372 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
374 virtual void init() {}
376 /** Clean up prior to destruction
377 * If you override, you must call this AFTER your module's cleanup
379 virtual CullResult cull();
381 /** Default destructor.
382 * destroys a module class
386 virtual void Prioritize()
390 /** Returns the version number of a Module.
391 * The method should return a Version object with its version information assigned via
394 virtual Version GetVersion() = 0;
396 /** Called when a user connects.
397 * The details of the connecting user are available to you in the parameter User *user
398 * @param user The user who is connecting
400 virtual void OnUserConnect(LocalUser* user);
402 /** Called when a user quits.
403 * The details of the exiting user are available to you in the parameter User *user
404 * This event is only called when the user is fully registered when they quit. To catch
405 * raw disconnections, use the OnUserDisconnect method.
406 * @param user The user who is quitting
407 * @param message The user's quit message (as seen by non-opers)
408 * @param oper_message The user's quit message (as seen by opers)
410 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
412 /** Called whenever a user's socket is closed.
413 * The details of the exiting user are available to you in the parameter User *user
414 * This event is called for all users, registered or not, as a cleanup method for modules
415 * which might assign resources to user, such as dns lookups, objects and sockets.
416 * @param user The user who is disconnecting
418 virtual void OnUserDisconnect(LocalUser* user);
420 /** Called whenever a channel is about to be deleted
421 * @param chan The channel being deleted
422 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
424 virtual ModResult OnChannelPreDelete(Channel *chan);
426 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
427 * @param chan The channel being deleted
429 virtual void OnChannelDelete(Channel* chan);
431 /** Called when a user joins a channel.
432 * The details of the joining user are available to you in the parameter User *user,
433 * and the details of the channel they have joined is available in the variable Channel *channel
434 * @param memb The channel membership being created
435 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
436 * to a channel due to the network sync.
437 * @param created This is true if the join created the channel
438 * @param except_list A list of users not to send to.
440 virtual void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list);
442 /** Called after a user joins a channel
443 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
445 * @param memb The channel membership created
447 virtual void OnPostJoin(Membership* memb);
449 /** Called when a user parts a channel.
450 * The details of the leaving user are available to you in the parameter User *user,
451 * and the details of the channel they have left is available in the variable Channel *channel
452 * @param memb The channel membership being destroyed
453 * @param partmessage The part message, or an empty string (may be modified)
454 * @param except_list A list of users to not send to.
456 virtual void OnUserPart(Membership* memb, std::string &partmessage, CUList& except_list);
458 /** Called on rehash.
459 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
460 * system. This is called in all cases -- including when this server will not execute the
461 * rehash because it is directed at a remote server.
463 * @param user The user performing the rehash, if any. If this is server initiated, the value of
464 * this variable will be NULL.
465 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
468 virtual void OnPreRehash(User* user, const std::string ¶meter);
470 /** Called on rehash.
471 * This method is called when a user initiates a module-specific rehash. This can be used to do
472 * expensive operations (such as reloading SSL certificates) that are not executed on a normal
473 * rehash for efficiency. A rehash of this type does not reload the core configuration.
475 * @param user The user performing the rehash.
476 * @param parameter The parameter given to REHASH
478 virtual void OnModuleRehash(User* user, const std::string ¶meter);
480 /** Called on rehash.
481 * This method is called after a rehash has completed. You should use it to reload any module
482 * configuration from the main configuration file.
483 * @param user The user that performed the rehash, if it was initiated by a user and that user
484 * is still connected.
486 virtual void OnRehash(User* user);
488 /** Called whenever a snotice is about to be sent to a snomask.
489 * snomask and type may both be modified; the message may not.
490 * @param snomask The snomask the message is going to (e.g. 'A')
491 * @param type The textual description the snomask will go to (e.g. 'OPER')
492 * @param message The text message to be sent via snotice
493 * @return 1 to block the snotice from being sent entirely, 0 else.
495 virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
497 /** Called whenever a user is about to join a channel, before any processing is done.
498 * Returning a value of 1 from this function stops the process immediately, causing no
499 * output to be sent to the user by the core. If you do this you must produce your own numerics,
500 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
501 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
505 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
506 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
507 * processing on the actual channel record at this point, however the channel NAME will still be passed in
508 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
509 * @param user The user joining the channel
510 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
511 * @param cname The channel name being joined. For new channels this is valid where chan is not.
512 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "o".
513 * You may alter this string to alter the user's modes on the channel.
514 * @param keygiven The key given to join the channel, or an empty string if none was provided
515 * @return 1 To prevent the join, 0 to allow it.
517 virtual ModResult OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string &privs, const std::string &keygiven);
519 /** Called whenever a user is about to be kicked.
520 * Returning a value of 1 from this function stops the process immediately, causing no
521 * output to be sent to the user by the core. If you do this you must produce your own numerics,
523 * @param source The user issuing the kick
524 * @param memb The channel membership of the user who is being kicked.
525 * @param reason The kick reason
526 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
528 virtual ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason);
530 /** Called whenever a user is kicked.
531 * If this method is called, the kick is already underway and cannot be prevented, so
532 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
533 * @param source The user issuing the kick
534 * @param memb The channel membership of the user who was kicked.
535 * @param reason The kick reason
536 * @param except_list A list of users to not send to.
538 virtual void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except_list);
540 /** Called whenever a user opers locally.
541 * The User will contain the oper mode 'o' as this function is called after any modifications
542 * are made to the user's structure by the core.
543 * @param user The user who is opering up
544 * @param opertype The opers type name
546 virtual void OnOper(User* user, const std::string &opertype);
548 /** Called after a user opers locally.
549 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
550 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
551 * out the OPERTYPE, etc.
552 * @param user The user who is opering up
553 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
554 * @param opertype The opers type name
556 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
558 /** Called after a user deopers locally.
559 * @param user The user who has deopered.
561 virtual void OnPostDeoper(User* user);
563 /** Called whenever a user types /INFO.
564 * The User will contain the information of the user who typed the command. Modules may use this
565 * method to output their own credits in /INFO (which is the ircd's version of an about box).
566 * It is purposefully not possible to modify any info that has already been output, or halt the list.
567 * You must write a 371 numeric to the user, containing your info in the following format:
569 * <nick> :information here
571 * @param user The user issuing /INFO
573 virtual void OnInfo(User* user);
575 /** Called whenever a /WHOIS is performed on a local user.
576 * The source parameter contains the details of the user who issued the WHOIS command, and
577 * the dest parameter contains the information of the user they are whoising.
578 * @param source The user issuing the WHOIS command
579 * @param dest The user who is being WHOISed
581 virtual void OnWhois(User* source, User* dest);
583 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
584 * Returning 1 from this function stops the process immediately, causing no
585 * output to be sent to the user by the core. If you do this you must produce your own numerics,
586 * notices etc. This is useful for modules which may want to filter invites to channels.
587 * @param source The user who is issuing the INVITE
588 * @param dest The user being invited
589 * @param channel The channel the user is being invited to
590 * @param timeout The time the invite will expire (0 == never)
591 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
593 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
595 /** Called after a user has been successfully invited to a channel.
596 * You cannot prevent the invite from occuring using this function, to do that,
597 * use OnUserPreInvite instead.
598 * @param source The user who is issuing the INVITE
599 * @param dest The user being invited
600 * @param channel The channel the user is being invited to
601 * @param timeout The time the invite will expire (0 == never)
603 virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout);
605 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
606 * Returning any nonzero value from this function stops the process immediately, causing no
607 * output to be sent to the user by the core. If you do this you must produce your own numerics,
608 * notices etc. This is useful for modules which may want to filter or redirect messages.
609 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
610 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
611 * of where the message is destined to be sent.
612 * @param user The user sending the message
613 * @param dest The target of the message (Channel* or User*)
614 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
615 * @param text Changeable text being sent by the user
616 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
617 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
618 * It will be ignored for private messages.
619 * @return 1 to deny the message, 0 to allow it
621 virtual ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
623 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
624 * Returning any nonzero value from this function stops the process immediately, causing no
625 * output to be sent to the user by the core. If you do this you must produce your own numerics,
626 * notices etc. This is useful for modules which may want to filter or redirect messages.
627 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
628 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
629 * of where the message is destined to be sent.
630 * You may alter the message text as you wish before relinquishing control to the next module
631 * in the chain, and if no other modules block the text this altered form of the text will be sent out
632 * to the user and possibly to other servers.
633 * @param user The user sending the message
634 * @param dest The target of the message (Channel* or User*)
635 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
636 * @param text Changeable text being sent by the user
637 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
638 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
639 * It will be ignored for private notices.
640 * @return 1 to deny the NOTICE, 0 to allow it
642 virtual ModResult OnUserPreNotice(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
644 /** Called when sending a message to all "neighbors" of a given user -
645 * that is, all users that share a common channel. This is used in
646 * commands such as NICK, QUIT, etc.
647 * @param source The source of the message
648 * @param include_c Channels to scan for users to include
649 * @param exceptions Map of user->bool that overrides the inclusion decision
651 * Set exceptions[user] = true to include, exceptions[user] = false to exclude
653 virtual void OnBuildNeighborList(User* source, UserChanList &include_c, std::map<User*,bool> &exceptions);
655 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
656 * Please note that although you can see remote nickchanges through this function, you should
657 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
658 * check user->server before taking any action (including returning nonzero from the method).
659 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
660 * module to generate some meaninful output.
661 * @param user The username changing their nick
662 * @param newnick Their new nickname
663 * @return 1 to deny the change, 0 to allow
665 virtual ModResult OnUserPreNick(User* user, const std::string &newnick);
667 /** Called after any PRIVMSG sent from a user.
668 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
669 * if target_type is TYPE_CHANNEL.
670 * @param user The user sending the message
671 * @param dest The target of the message
672 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
673 * @param text the text being sent by the user
674 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
675 * @param exempt_list A list of users to not send to.
677 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
679 /** Called after any NOTICE sent from a user.
680 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
681 * if target_type is TYPE_CHANNEL.
682 * @param user The user sending the message
683 * @param dest The target of the message
684 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
685 * @param text the text being sent by the user
686 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
687 * @param exempt_list A list of users to not send to.
689 virtual void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
691 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
692 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
693 * if target_type is TYPE_CHANNEL.
694 * The difference between this event and OnUserPreNotice/OnUserPreMessage is that delivery is gauranteed,
695 * the message has already been vetted. In the case of the other two methods, a later module may stop your
696 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
697 * @param user The user sending the message
698 * @param dest The target of the message
699 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
700 * @param text the text being sent by the user
701 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
702 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
704 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
706 /** Called after every MODE command sent from a user
707 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
708 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
709 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
710 * @param user The user sending the MODEs
711 * @param dest The target of the modes (User* or Channel*)
712 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
713 * @param text The actual modes and their parameters if any
714 * @param translate The translation types of the mode parameters
716 virtual void OnMode(User* user, void* dest, int target_type, const std::vector<std::string> &text, const std::vector<TranslateType> &translate);
718 /** Allows modules to alter or create server descriptions
719 * Whenever a module requires a server description, for example for display in
720 * WHOIS, this function is called in all modules. You may change or define the
721 * description given in std::string &description. If you do, this description
722 * will be shown in the WHOIS fields.
723 * @param servername The servername being searched for
724 * @param description Alterable server description for this server
726 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
728 /** Allows modules to synchronize data which relates to users during a netburst.
729 * When this function is called, it will be called from the module which implements
730 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
731 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
732 * (see below). This function will be called for every user visible on your side
733 * of the burst, allowing you to for example set modes, etc. Do not use this call to
734 * synchronize data which you have stored using class Extensible -- There is a specialist
735 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
736 * @param user The user being syncronized
737 * @param proto A pointer to the module handling network protocol
738 * @param opaque An opaque pointer set by the protocol module, should not be modified!
740 virtual void OnSyncUser(User* user, Module* proto, void* opaque);
742 /** Allows modules to synchronize data which relates to channels during a netburst.
743 * When this function is called, it will be called from the module which implements
744 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
745 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
746 * (see below). This function will be called for every user visible on your side
747 * of the burst, allowing you to for example set modes, etc.
749 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
751 * @param chan The channel being syncronized
752 * @param proto A pointer to the module handling network protocol
753 * @param opaque An opaque pointer set by the protocol module, should not be modified!
755 virtual void OnSyncChannel(Channel* chan, Module* proto, void* opaque);
757 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
758 * Whenever the linking module wants to send out data, but doesnt know what the data
759 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
760 * this method is called. You should use the ProtoSendMetaData function after you've
761 * correctly decided how the data should be represented, to send the metadata on its way if
762 * if it belongs to your module.
763 * @param proto A pointer to the module handling network protocol
764 * @param opaque An opaque pointer set by the protocol module, should not be modified!
765 * @param displayable If this value is true, the data is going to be displayed to a user,
766 * and not sent across the network. Use this to determine wether or not to show sensitive data.
768 virtual void OnSyncNetwork(Module* proto, void* opaque);
770 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
771 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
772 * @param target The Channel* or User* that data should be added to
773 * @param extname The extension name which is being sent
774 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
776 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
778 /** Implemented by modules which provide the ability to link servers.
779 * These modules will implement this method, which allows transparent sending of servermodes
780 * down the network link as a broadcast, without a module calling it having to know the format
781 * of the MODE command before the actual mode string.
783 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
784 * of how to use this function.
786 * @param opaque An opaque pointer set by the protocol module, should not be modified!
787 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
788 * @param target The Channel* or User* that modes should be sent for
789 * @param modeline The modes and parameters to be sent
790 * @param translate The translation types of the mode parameters
792 virtual void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::vector<std::string> &modeline, const std::vector<TranslateType> &translate);
794 /** Implemented by modules which provide the ability to link servers.
795 * These modules will implement this method, which allows metadata (extra data added to
796 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
797 * to other servers on a netburst and decoded at the other end by the same module on a
800 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
801 * how to use this function.
802 * @param opaque An opaque pointer set by the protocol module, should not be modified!
803 * @param target The Channel* or User* that metadata should be sent for
804 * @param extname The extension name to send metadata for
805 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
807 virtual void ProtoSendMetaData(void* opaque, Extensible* target, const std::string &extname, const std::string &extdata);
809 /** Called after every WALLOPS command.
810 * @param user The user sending the WALLOPS
811 * @param text The content of the WALLOPS message
813 virtual void OnWallops(User* user, const std::string &text);
815 /** Called whenever a user's hostname is changed.
816 * This event triggers after the host has been set.
817 * @param user The user whos host is being changed
818 * @param newhost The new hostname being set
820 virtual void OnChangeHost(User* user, const std::string &newhost);
822 /** Called whenever a user's GECOS (realname) is changed.
823 * This event triggers after the name has been set.
824 * @param user The user who's GECOS is being changed
825 * @param gecos The new GECOS being set on the user
827 virtual void OnChangeName(User* user, const std::string &gecos);
829 /** Called whenever a user's IDENT is changed.
830 * This event triggers after the name has been set.
831 * @param user The user who's IDENT is being changed
832 * @param ident The new IDENT being set on the user
834 virtual void OnChangeIdent(User* user, const std::string &ident);
836 /** Called whenever an xline is added by a local user.
837 * This method is triggered after the line is added.
838 * @param source The sender of the line or NULL for local server
839 * @param line The xline being added
841 virtual void OnAddLine(User* source, XLine* line);
843 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
844 * This method is triggered after the line is deleted.
845 * @param source The user removing the line or NULL for local server
846 * @param line the line being deleted
848 virtual void OnDelLine(User* source, XLine* line);
850 /** Called whenever an xline expires.
851 * This method is triggered after the line is deleted.
852 * @param line The line being deleted.
854 virtual void OnExpireLine(XLine *line);
856 /** Called before your module is unloaded to clean up Extensibles.
857 * This method is called once for every user and channel on the network,
858 * so that when your module unloads it may clear up any remaining data
859 * in the form of Extensibles added using Extensible::Extend().
860 * If the target_type variable is TYPE_USER, then void* item refers to
861 * a User*, otherwise it refers to a Channel*.
862 * @param target_type The type of item being cleaned
863 * @param item A pointer to the item's class
865 virtual void OnCleanup(int target_type, void* item);
867 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
868 * have been applied. Please note that although you can see remote nickchanges through this function, you should
869 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
870 * check user->server before taking any action (including returning nonzero from the method).
871 * Because this method is called after the nickchange is taken place, no return values are possible
872 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
873 * @param user The user changing their nick
874 * @param oldnick The old nickname of the user before the nickchange
876 virtual void OnUserPostNick(User* user, const std::string &oldnick);
878 /** Called before any mode change, to allow a single access check for
879 * a full mode change (use OnRawMode to check individual modes)
881 * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
882 * OnRawMode for each individual mode
884 * @param source the user making the mode change
885 * @param dest the user destination of the umode change (NULL if a channel mode)
886 * @param channel the channel destination of the mode change
887 * @param parameters raw mode parameters; parameters[0] is the user/channel being changed
889 virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, const std::vector<std::string>& parameters);
891 /** Called when a 005 numeric is about to be output.
892 * The module should modify the 005 numeric if needed to indicate its features.
893 * @param output The 005 string to be modified if neccessary.
895 virtual void On005Numeric(std::string &output);
897 /** Called when a client is disconnected by KILL.
898 * If a client is killed by a server, e.g. a nickname collision or protocol error,
900 * Return 1 from this function to prevent the kill, and 0 from this function to allow
901 * it as normal. If you prevent the kill no output will be sent to the client, it is
902 * down to your module to generate this information.
903 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
904 * If you do so youre risking race conditions, desyncs and worse!
905 * @param source The user sending the KILL
906 * @param dest The user being killed
907 * @param reason The kill reason
908 * @return 1 to prevent the kill, 0 to allow
910 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
912 /** Called when an oper wants to disconnect a remote user via KILL
913 * @param source The user sending the KILL
914 * @param dest The user being killed
915 * @param reason The kill reason
916 * @param operreason The oper kill reason
918 virtual void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
920 /** Called whenever a module is loaded.
921 * mod will contain a pointer to the module, and string will contain its name,
922 * for example m_widgets.so. This function is primary for dependency checking,
923 * your module may decide to enable some extra features if it sees that you have
924 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
925 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
926 * but instead operate under reduced functionality, unless the dependency is
927 * absolutely neccessary (e.g. a module that extends the features of another
929 * @param mod A pointer to the new module
931 virtual void OnLoadModule(Module* mod);
933 /** Called whenever a module is unloaded.
934 * mod will contain a pointer to the module, and string will contain its name,
935 * for example m_widgets.so. This function is primary for dependency checking,
936 * your module may decide to enable some extra features if it sees that you have
937 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
938 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
939 * but instead operate under reduced functionality, unless the dependency is
940 * absolutely neccessary (e.g. a module that extends the features of another
942 * @param mod Pointer to the module being unloaded (still valid)
944 virtual void OnUnloadModule(Module* mod);
946 /** Called once every five seconds for background processing.
947 * This timer can be used to control timed features. Its period is not accurate
948 * enough to be used as a clock, but it is gauranteed to be called at least once in
949 * any five second period, directly from the main loop of the server.
950 * @param curtime The current timer derived from time(2)
952 virtual void OnBackgroundTimer(time_t curtime);
954 /** Called whenever any command is about to be executed.
955 * This event occurs for all registered commands, wether they are registered in the core,
956 * or another module, and for invalid commands. Invalid commands may only be sent to this
957 * function when the value of validated is false. By returning 1 from this method you may prevent the
958 * command being executed. If you do this, no output is created by the core, and it is
959 * down to your module to produce any output neccessary.
960 * Note that unless you return 1, you should not destroy any structures (e.g. by using
961 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
962 * method returns, it will be passed an invalid pointer to the user object and crash!)
963 * @param command The command being executed
964 * @param parameters An array of array of characters containing the parameters for the command
965 * @param user the user issuing the command
966 * @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.
967 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
968 * @param original_line The entire original line as passed to the parser from the user
969 * @return 1 to block the command, 0 to allow
971 virtual ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, LocalUser *user, bool validated, const std::string &original_line);
973 /** Called after any command has been executed.
974 * This event occurs for all registered commands, wether they are registered in the core,
975 * or another module, but it will not occur for invalid commands (e.g. ones which do not
976 * exist within the command table). The result code returned by the command handler is
978 * @param command The command being executed
979 * @param parameters An array of array of characters containing the parameters for the command
980 * @param user the user issuing the command
981 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
982 * @param original_line The entire original line as passed to the parser from the user
984 virtual void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, LocalUser *user, CmdResult result, const std::string &original_line);
986 /** Called when a user is first connecting, prior to starting DNS lookups, checking initial
987 * connect class, or accepting any commands.
989 virtual void OnUserInit(LocalUser* user);
991 /** Called to check if a user who is connecting can now be allowed to register
992 * If any modules return false for this function, the user is held in the waiting
993 * state until all modules return true. For example a module which implements ident
994 * lookups will continue to return false for a user until their ident lookup is completed.
995 * Note that the registration timeout for a user overrides these checks, if the registration
996 * timeout is reached, the user is disconnected even if modules report that the user is
997 * not ready to connect.
998 * @param user The user to check
999 * @return true to indicate readiness, false if otherwise
1001 virtual ModResult OnCheckReady(LocalUser* user);
1003 /** Called whenever a user is about to register their connection (e.g. before the user
1004 * is sent the MOTD etc). Modules can use this method if they are performing a function
1005 * which must be done before the actual connection is completed (e.g. ident lookups,
1006 * dnsbl lookups, etc).
1007 * Note that you should NOT delete the user record here by causing a disconnection!
1008 * Use OnUserConnect for that instead.
1009 * @param user The user registering
1010 * @return 1 to indicate user quit, 0 to continue
1012 virtual ModResult OnUserRegister(LocalUser* user);
1014 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1015 * This method will always be called for each join, wether or not the channel is actually +i, and
1016 * determines the outcome of an if statement around the whole section of invite checking code.
1017 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1018 * @param user The user joining the channel
1019 * @param chan The channel being joined
1020 * @return 1 to explicitly allow the join, 0 to proceed as normal
1022 virtual ModResult OnCheckInvite(User* user, Channel* chan);
1024 /** Called whenever a mode character is processed.
1025 * Return 1 from this function to block the mode character from being processed entirely.
1026 * @param user The user who is sending the mode
1027 * @param chan The channel the mode is being sent to (or NULL if a usermode)
1028 * @param mode The mode character being set
1029 * @param param The parameter for the mode or an empty string
1030 * @param adding true of the mode is being added, false if it is being removed
1031 * @param pcnt The parameter count for the mode (0 or 1)
1032 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
1033 * to skip all permission checking. Please note that for remote mode changes, your return value
1036 virtual ModResult OnRawMode(User* user, Channel* chan, const char mode, const std::string ¶m, bool adding, int pcnt);
1038 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1039 * This method will always be called for each join, wether or not the channel is actually +k, and
1040 * determines the outcome of an if statement around the whole section of key checking code.
1041 * if the user specified no key, the keygiven string will be a valid but empty value.
1042 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1043 * @param user The user joining the channel
1044 * @param chan The channel being joined
1045 * @param keygiven The key given on joining the channel.
1046 * @return 1 to explicitly allow the join, 0 to proceed as normal
1048 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
1050 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1051 * This method will always be called for each join, wether or not the channel is actually +l, and
1052 * determines the outcome of an if statement around the whole section of channel limit checking code.
1053 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1054 * @param user The user joining the channel
1055 * @param chan The channel being joined
1056 * @return 1 to explicitly allow the join, 0 to proceed as normal
1058 virtual ModResult OnCheckLimit(User* user, Channel* chan);
1061 * Checks for a user's ban from the channel
1062 * @param user The user to check
1063 * @param chan The channel to check in
1064 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1065 * ban check, or MOD_RES_PASSTHRU to check bans normally
1067 virtual ModResult OnCheckChannelBan(User* user, Channel* chan);
1070 * Checks for a user's match of a single ban
1071 * @param user The user to check for match
1072 * @param chan The channel on which the match is being checked
1073 * @param mask The mask being checked
1074 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1075 * ban check, or MOD_RES_PASSTHRU to check bans normally
1077 virtual ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask);
1079 /** Checks for a match on a given extban type
1080 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1081 * ban check, or MOD_RES_PASSTHRU to check bans normally
1083 virtual ModResult OnExtBanCheck(User* user, Channel* chan, char type);
1085 /** Called on all /STATS commands
1086 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1087 * @param symbol the symbol provided to /STATS
1088 * @param user the user issuing the /STATS command
1089 * @param results A string_list to append results into. You should put all your results
1090 * into this string_list, rather than displaying them directly, so that your handler will
1091 * work when remote STATS queries are received.
1092 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1094 virtual ModResult OnStats(char symbol, User* user, string_list &results);
1096 /** Called whenever a change of a local users displayed host is attempted.
1097 * Return 1 to deny the host change, or 0 to allow it.
1098 * @param user The user whos host will be changed
1099 * @param newhost The new hostname
1100 * @return 1 to deny the host change, 0 to allow
1102 virtual ModResult OnChangeLocalUserHost(LocalUser* user, const std::string &newhost);
1104 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1105 * return 1 to deny the name change, or 0 to allow it.
1106 * @param user The user whos GECOS will be changed
1107 * @param newhost The new GECOS
1108 * @return 1 to deny the GECOS change, 0 to allow
1110 virtual ModResult OnChangeLocalUserGECOS(LocalUser* user, const std::string &newhost);
1112 /** Called before a topic is changed.
1113 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
1114 * As with other 'pre' events, you should only ever block a local event.
1115 * @param user The user changing the topic
1116 * @param chan The channels who's topic is being changed
1117 * @param topic The actual topic text
1118 * @return 1 to block the topic change, 0 to allow
1120 virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
1122 /** Called whenever a topic has been changed.
1123 * To block topic changes you must use OnPreTopicChange instead.
1124 * @param user The user changing the topic
1125 * @param chan The channels who's topic is being changed
1126 * @param topic The actual topic text
1128 virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
1130 /** Called whenever an Event class is sent to all modules by another module.
1131 * You should *always* check the value of Event::id to determine the event type.
1132 * @param event The Event class being received
1134 virtual void OnEvent(Event& event);
1136 /** Called whenever a Request class is sent to your module by another module.
1137 * The value of Request::id should be used to determine the type of request.
1138 * @param request The Request class being received
1140 virtual void OnRequest(Request& request);
1142 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
1143 * The password field (from the config file) is in 'password' and is to be compared against
1144 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
1145 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
1146 * @param ex The object that's causing the authentication (User* for \<oper> \<connect:allow> etc, Server* for \<link>).
1147 * @param password The password from the configuration file (the password="" value).
1148 * @param input The password entered by the user or whoever.
1149 * @param hashtype The hash value from the config
1150 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
1152 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
1154 /** Called whenever a user is given usermode +o, anywhere on the network.
1155 * You cannot override this and prevent it from happening as it is already happened and
1156 * such a task must be performed by another server. You can however bounce modes by sending
1157 * servermodes out to reverse mode changes.
1158 * @param user The user who is opering
1160 virtual void OnGlobalOper(User* user);
1162 /** Called after a user has fully connected and all modules have executed OnUserConnect
1163 * This event is informational only. You should not change any user information in this
1164 * event. To do so, use the OnUserConnect method to change the state of local users.
1165 * This is called for both local and remote users.
1166 * @param user The user who is connecting
1168 virtual void OnPostConnect(User* user);
1170 /** Called whenever a ban is added to a channel's list.
1171 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1172 * @param source The user adding the ban
1173 * @param channel The channel the ban is being added to
1174 * @param banmask The ban mask being added
1175 * @return 1 to block the ban, 0 to continue as normal
1177 virtual ModResult OnAddBan(User* source, Channel* channel,const std::string &banmask);
1179 /** Called whenever a ban is removed from a channel's list.
1180 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1181 * @param source The user deleting the ban
1182 * @param channel The channel the ban is being deleted from
1183 * @param banmask The ban mask being deleted
1184 * @return 1 to block the unban, 0 to continue as normal
1186 virtual ModResult OnDelBan(User* source, Channel* channel,const std::string &banmask);
1188 /** Called to install an I/O hook on an event handler
1189 * @param user The socket to possibly install the I/O hook on
1190 * @param via The port that the user connected on
1192 virtual void OnHookIO(StreamSocket* user, ListenSocket* via);
1194 /** Called when a port accepts a connection
1195 * Return MOD_RES_ACCEPT if you have used the file descriptor.
1196 * @param fd The file descriptor returned from accept()
1197 * @param sock The socket connection for the new user
1198 * @param client The client IP address and port
1199 * @param server The server IP address and port
1201 virtual ModResult OnAcceptConnection(int fd, ListenSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
1203 /** Called immediately after any connection is accepted. This is intended for raw socket
1204 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1205 * no information relating to a user record as the connection has not been assigned yet.
1206 * There are no return values from this call as all modules get an opportunity if required to
1207 * process the connection.
1208 * @param sock The socket in question
1209 * @param client The client IP address and port
1210 * @param server The server IP address and port
1212 virtual void OnStreamSocketAccept(StreamSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
1215 * Called when a hooked stream has data to write, or when the socket
1216 * engine returns it as writable
1217 * @param sock The socket in question
1218 * @param sendq Data to send to the socket
1219 * @return 1 if the sendq has been completely emptied, 0 if there is
1220 * still data to send, and -1 if there was an error
1222 virtual int OnStreamSocketWrite(StreamSocket* sock, std::string& sendq);
1224 /** Called immediately before any socket is closed. When this event is called, shutdown()
1225 * has not yet been called on the socket.
1226 * @param sock The socket in question
1228 virtual void OnStreamSocketClose(StreamSocket* sock);
1230 /** Called immediately upon connection of an outbound BufferedSocket which has been hooked
1232 * @param sock The socket in question
1234 virtual void OnStreamSocketConnect(StreamSocket* sock);
1237 * Called when the stream socket has data to read
1238 * @param sock The socket that is ready
1239 * @param recvq The receive queue that new data should be appended to
1240 * @return 1 if new data has been read, 0 if no new data is ready (but the
1241 * socket is still connected), -1 if there was an error or close
1243 virtual int OnStreamSocketRead(StreamSocket* sock, std::string& recvq);
1245 /** Called whenever a user sets away or returns from being away.
1246 * The away message is available as a parameter, but should not be modified.
1247 * At this stage, it has already been copied into the user record.
1248 * If awaymsg is empty, the user is returning from away.
1249 * @param user The user setting away
1250 * @param awaymsg The away message of the user, or empty if returning from away
1251 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
1253 virtual ModResult OnSetAway(User* user, const std::string &awaymsg);
1255 /** Called whenever a line of WHOIS output is sent to a user.
1256 * You may change the numeric and the text of the output by changing
1257 * the values numeric and text, but you cannot change the user the
1258 * numeric is sent to. You may however change the user's User values.
1259 * @param user The user the numeric is being sent to
1260 * @param dest The user being WHOISed
1261 * @param numeric The numeric of the line being sent
1262 * @param text The text of the numeric, including any parameters
1263 * @return nonzero to drop the line completely so that the user does not
1264 * receive it, or zero to allow the line to be sent.
1266 virtual ModResult OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
1268 /** Called at intervals for modules to garbage-collect any hashes etc.
1269 * Certain data types such as hash_map 'leak' buckets, which must be
1270 * tidied up and freed by copying into a new item every so often. This
1271 * method is called when it is time to do that.
1273 virtual void OnGarbageCollect();
1275 /** Called when a user's connect class is being matched
1276 * @return MOD_RES_ALLOW to force the class to match, MOD_RES_DENY to forbid it, or
1277 * MOD_RES_PASSTHRU to allow normal matching (by host/port).
1279 virtual ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass);
1281 /** Add test suite hooks here. These are used for testing functionality of a module
1282 * via the --testsuite debugging parameter.
1284 virtual void OnRunTestSuite();
1286 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
1287 * For example NAMESX, channel mode +u and +I, and UHNAMES. If the nick is set to an empty string by any
1288 * module, then this will cause the nickname not to be displayed at all.
1290 virtual void OnNamesListItem(User* issuer, Membership* item, std::string &prefixes, std::string &nick);
1292 virtual ModResult OnNumeric(User* user, unsigned int numeric, const std::string &text);
1294 /** Called whenever a result from /WHO is about to be returned
1295 * @param source The user running the /WHO query
1296 * @param params The parameters to the /WHO query
1297 * @param user The user that this line of the query is about
1298 * @param line The raw line to send; modifiable, if empty no line will be returned.
1300 virtual void OnSendWhoLine(User* source, const std::vector<std::string>& params, User* user, std::string& line);
1302 /** Called whenever a local user's IP is set for the first time, or when a local user's IP changes due to
1303 * a module like m_cgiirc changing it.
1304 * @param user The user whose IP is being set
1306 virtual void OnSetUserIP(LocalUser* user);
1310 #define CONF_NO_ERROR 0x000000
1311 #define CONF_NOT_A_NUMBER 0x000010
1312 #define CONF_INT_NEGATIVE 0x000080
1313 #define CONF_VALUE_NOT_FOUND 0x000100
1314 #define CONF_FILE_NOT_FOUND 0x000200
1317 /** Allows reading of values from configuration files
1318 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1319 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1320 * Constructing the class using one parameter allows you to specify a path to your own configuration
1321 * file, otherwise, inspircd.conf is read.
1323 class CoreExport ConfigReader : public interfacebase
1331 /** Default constructor.
1332 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1333 * as specified when running ./configure.
1336 /** Default destructor.
1337 * This method destroys the ConfigReader class.
1341 /** Retrieves a value from the config file.
1342 * This method retrieves a value from the config file. Where multiple copies of the tag
1343 * exist in the config file, index indicates which of the values to retrieve.
1345 std::string ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds = false);
1346 /** Retrieves a value from the config file.
1347 * This method retrieves a value from the config file. Where multiple copies of the tag
1348 * exist in the config file, index indicates which of the values to retrieve. If the
1349 * tag is not found the default value is returned instead.
1351 std::string ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds = false);
1353 /** Retrieves a boolean value from the config file.
1354 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1355 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1356 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1358 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1359 /** Retrieves a boolean value from the config file.
1360 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1361 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1362 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1363 * If the tag is not found, the default value is used instead.
1365 bool ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index);
1367 /** Retrieves an integer value from the config file.
1368 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1369 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1370 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1371 * return CONF_INVALID_NUMBER to be returned. need_positive is set if the number must be non-negative.
1372 * If a negative number is placed into a tag which is specified positive, 0 will be returned and GetError()
1373 * will return CONF_INT_NEGATIVE. Note that need_positive is not suitable to get an unsigned int - you
1374 * should cast the result to achieve that effect.
1376 int ReadInteger(const std::string &tag, const std::string &name, int index, bool need_positive);
1377 /** Retrieves an integer value from the config file.
1378 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1379 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1380 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1381 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1382 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1383 * will return CONF_NOT_UNSIGNED. If the tag is not found, the default value is used instead.
1385 int ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool need_positive);
1387 /** Returns the last error to occur.
1388 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1389 * A call to GetError() resets the error flag back to 0.
1393 /** Counts the number of times a given tag appears in the config file.
1394 * This method counts the number of times a tag appears in a config file, for use where
1395 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1396 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1397 * multiple instance tag.
1399 int Enumerate(const std::string &tag);
1404 /** Caches a text file into memory and can be used to retrieve lines from it.
1405 * This class contains methods for read-only manipulation of a text file in memory.
1406 * Either use the constructor type with one parameter to load a file into memory
1407 * at construction, or use the LoadFile method to load a file.
1409 class CoreExport FileReader : public classbase
1411 /** The file contents
1413 std::vector<std::string> fc;
1415 /** Content size in bytes
1417 unsigned long contentsize;
1419 /** Calculate content size in bytes
1424 /** Default constructor.
1425 * This method does not load any file into memory, you must use the LoadFile method
1426 * after constructing the class this way.
1430 /** Secondary constructor.
1431 * This method initialises the class with a file loaded into it ready for GetLine and
1432 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1435 FileReader(const std::string &filename);
1437 /** Default destructor.
1438 * This deletes the memory allocated to the file.
1442 /** Used to load a file.
1443 * This method loads a file into the class ready for GetLine and
1444 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1447 void LoadFile(const std::string &filename);
1449 /** Returns the whole content of the file as std::string
1451 std::string Contents();
1453 /** Returns the entire size of the file as std::string
1455 unsigned long ContentSize();
1457 /** Returns true if the file exists
1458 * This function will return false if the file could not be opened.
1462 /** Retrieve one line from the file.
1463 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1464 * the index was out of bounds, or the line had no data on it.
1466 std::string GetLine(int x);
1468 /** Returns the size of the file in lines.
1469 * This method returns the number of lines in the read file. If it is 0, no lines have been
1470 * read into memory, either because the file is empty or it does not exist, or cannot be
1471 * opened due to permission problems.
1476 /** A list of modules
1478 typedef std::vector<Module*> IntModuleList;
1480 /** An event handler iterator
1482 typedef IntModuleList::iterator EventHandlerIter;
1484 /** ModuleManager takes care of all things module-related
1487 class CoreExport ModuleManager
1490 /** Holds a string describing the last module error to occur
1492 std::string LastModuleError;
1494 /** Total number of modules loaded into the ircd
1498 /** List of loaded modules and shared object/dll handles
1499 * keyed by module name
1501 std::map<std::string, Module*> Modules;
1507 } prioritizationState;
1509 /** Internal unload module hook */
1510 bool CanUnload(Module*);
1513 /** Event handler hooks.
1514 * This needs to be public to be used by FOREACH_MOD and friends.
1516 IntModuleList EventHandlers[I_END];
1518 /** List of data services keyed by name */
1519 std::multimap<std::string, ServiceProvider*> DataProviders;
1521 /** Simple, bog-standard, boring constructor.
1529 /** Change the priority of one event in a module.
1530 * Each module event has a list of modules which are attached to that event type.
1531 * If you wish to be called before or after other specific modules, you may use this
1532 * method (usually within void Module::Prioritize()) to set your events priority.
1533 * You may use this call in other methods too, however, this is not supported behaviour
1535 * @param mod The module to change the priority of
1536 * @param i The event to change the priority of
1537 * @param s The state you wish to use for this event. Use one of
1538 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1539 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1540 * to set it to be before or after one or more other modules.
1541 * @param which If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1542 * then this contains a the module that your module must be placed before
1545 bool SetPriority(Module* mod, Implementation i, Priority s, Module* which = NULL);
1547 /** Backwards compat interface */
1548 inline bool SetPriority(Module* mod, Implementation i, Priority s, Module** dptr)
1550 return SetPriority(mod, i, s, *dptr);
1553 /** Change the priority of all events in a module.
1554 * @param mod The module to set the priority of
1555 * @param s The priority of all events in the module.
1556 * Note that with this method, it is not possible to effectively use
1557 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1558 * SetPriority method for this, where you may specify other modules to
1559 * be prioritized against.
1561 bool SetPriority(Module* mod, Priority s);
1563 /** Attach an event to a module.
1564 * You may later detatch the event with ModuleManager::Detach().
1565 * If your module is unloaded, all events are automatically detatched.
1566 * @param i Event type to attach
1567 * @param mod Module to attach event to
1568 * @return True if the event was attached
1570 bool Attach(Implementation i, Module* mod);
1572 /** Detatch an event from a module.
1573 * This is not required when your module unloads, as the core will
1574 * automatically detatch your module from all events it is attached to.
1575 * @param i Event type to detach
1576 * @param mod Module to detach event from
1577 * @return True if the event was detached
1579 bool Detach(Implementation i, Module* mod);
1581 /** Attach an array of events to a module
1582 * @param i Event types (array) to attach
1583 * @param mod Module to attach events to
1584 * @param sz The size of the implementation array
1586 void Attach(Implementation* i, Module* mod, size_t sz);
1588 /** Detach all events from a module (used on unload)
1589 * @param mod Module to detach from
1591 void DetachAll(Module* mod);
1593 /** Returns text describing the last module error
1594 * @return The last error message to occur
1596 std::string& LastError();
1598 /** Load a given module file
1599 * @param filename The file to load
1600 * @param defer Defer module init (loading many modules)
1601 * @return True if the module was found and loaded
1603 bool Load(const std::string& filename, bool defer = false);
1605 /** Unload a given module file. Note that the module will not be
1606 * completely gone until the cull list has finished processing.
1608 * @return true on success; if false, LastError will give a reason
1610 bool Unload(Module* module);
1612 /** Run an asynchronous reload of the given module. When the reload is
1613 * complete, the callback will be run with true if the reload succeeded
1614 * and false if it did not.
1616 void Reload(Module* module, HandlerBase1<void, bool>* callback);
1618 /** Called by the InspIRCd constructor to load all modules from the config file.
1622 void DoSafeUnload(Module*);
1624 /** Get the total number of currently loaded modules
1625 * @return The number of loaded modules
1629 return this->ModCount;
1632 /** Find a module by name, and return a Module* to it.
1633 * This is preferred over iterating the module lists yourself.
1634 * @param name The module name to look up
1635 * @return A pointer to the module, or NULL if the module cannot be found
1637 Module* Find(const std::string &name);
1639 /** Register a service provided by a module */
1640 void AddService(ServiceProvider&);
1642 /** Unregister a service provided by a module */
1643 void DelService(ServiceProvider&);
1645 inline void AddServices(ServiceProvider** list, int count)
1647 for(int i=0; i < count; i++)
1648 AddService(*list[i]);
1651 /** Find a service by name.
1652 * If multiple modules provide a given service, the first one loaded will be chosen.
1654 ServiceProvider* FindService(ServiceType Type, const std::string& name);
1656 template<typename T> inline T* FindDataService(const std::string& name)
1658 return static_cast<T*>(FindService(SERVICE_DATA, name));
1661 /** Return a list of all modules matching the given filter
1662 * @param filter This int is a bitmask of flags set in Module::Flags,
1663 * such as VF_VENDOR or VF_STATIC. If you wish to receive a list of
1664 * all modules with no filtering, set this to 0.
1665 * @return The list of module names
1667 const std::vector<std::string> GetAllModuleNames(int filter);
1670 /** Do not mess with these functions unless you know the C preprocessor
1671 * well enough to explain why they are needed. The order is important.
1673 #define MODULE_INIT_STR MODULE_INIT_STR_FN_2(MODULE_INIT_SYM)
1674 #define MODULE_INIT_STR_FN_2(x) MODULE_INIT_STR_FN_1(x)
1675 #define MODULE_INIT_STR_FN_1(x) #x
1676 #define MODULE_INIT_SYM MODULE_INIT_SYM_FN_2(INSPIRCD_VERSION_MAJ, INSPIRCD_VERSION_API)
1677 #define MODULE_INIT_SYM_FN_2(x,y) MODULE_INIT_SYM_FN_1(x,y)
1678 #define MODULE_INIT_SYM_FN_1(x,y) inspircd_module_ ## x ## _ ## y
1682 struct AllCommandList {
1683 typedef Command* (*fn)(Module*);
1684 AllCommandList(fn cmd);
1686 #define COMMAND_INIT(x) static Command* MK_ ## x(Module* m) { return new x(m); } \
1687 static const AllCommandList PREP_ ## x(&MK_ ## x);
1689 struct AllModuleList {
1690 typedef Module* (*fn)();
1693 AllModuleList(fn mod, const std::string& Name);
1696 #define MODULE_INIT(x) static Module* MK_ ## x() { return new x; } \
1697 static const AllModuleList PREP_ ## x(&MK_ ## x, MODNAMESTR);
1699 #define MODNAMESTR MODNAMESTR_FN_2(MODNAME)
1700 #define MODNAMESTR_FN_2(x) MODNAMESTR_FN_1(x)
1701 #define MODNAMESTR_FN_1(x) #x
1705 /** This definition is used as shorthand for the various classes
1706 * and functions needed to make a module loadable by the OS.
1707 * It defines the class factory and external init_module function.
1711 #define MODULE_INIT(y) \
1712 extern "C" DllExport Module * MODULE_INIT_SYM() \
1716 BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
1718 switch ( nReason ) \
1720 case DLL_PROCESS_ATTACH: \
1721 case DLL_PROCESS_DETACH: \
1726 extern "C" DllExport const char inspircd_src_version[] = VERSION " r" REVISION;
1730 #define MODULE_INIT(y) \
1731 extern "C" DllExport Module * MODULE_INIT_SYM() \
1735 extern "C" const char inspircd_src_version[] = VERSION " r" REVISION;
1738 #define COMMAND_INIT(c) MODULE_INIT(CommandModule<c>)