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"
39 /** Used to define a set of behavior bits for a module
42 VF_NONE = 0, // module is not special at all
43 VF_STATIC = 1, // module is static, cannot be /unloadmodule'd
44 VF_VENDOR = 2, // module is a vendor module (came in the original tarball, not 3rd party)
45 VF_COMMON = 4, // module needs to be common on all servers in a network to link
46 VF_OPTCOMMON = 8, // module should be common on all servers for unsurprising behavior
47 VF_CORE = 16 // module is a core command, can be assumed loaded on all servers
50 /** Used to represent an event type, for user, channel or server
52 enum TargetTypeFlags {
59 /** Used to represent wether a message was PRIVMSG or NOTICE
66 #define MOD_RES_ALLOW (ModResult(1))
67 #define MOD_RES_PASSTHRU (ModResult(0))
68 #define MOD_RES_DENY (ModResult(-1))
70 /** Used to represent an allow/deny module result.
71 * Not constructed as an enum because it reverses the value logic of some functions;
72 * the compiler will inline accesses to have the same efficiency as integer operations.
76 ModResult() : res(0) {}
77 explicit ModResult(int r) : res(r) {}
78 inline bool operator==(const ModResult& r) const
82 inline bool operator!=(const ModResult& r) const
86 inline bool operator!() const
90 inline bool check(bool def) const
92 return (res == 1 || (res == 0 && def));
95 * Merges two results, preferring ALLOW to DENY
97 inline ModResult operator+(const ModResult& r) const
99 if (res == r.res || r.res == 0)
103 // they are different, and neither is passthru
104 return MOD_RES_ALLOW;
108 /** InspIRCd major version.
109 * 1.2 -> 102; 2.1 -> 201; 2.12 -> 212
111 #define INSPIRCD_VERSION_MAJ 202
112 /** InspIRCd API version.
113 * If you change any API elements, increment this value. This counter should be
114 * reset whenever the major version is changed. Modules can use these two values
115 * and numerical comparisons in preprocessor macros if they wish to support
116 * multiple versions of InspIRCd in one file.
118 #define INSPIRCD_VERSION_API 1
121 * This #define allows us to call a method in all
122 * loaded modules in a readable simple way, e.g.:
123 * 'FOREACH_MOD(I_OnConnect,OnConnect(user));'
125 #define FOREACH_MOD(y,x) do { \
126 EventHandlerIter safei; \
127 for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ) \
135 catch (CoreException& modexcept) \
137 ServerInstance->Logs->Log("MODULE",LOG_DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
144 * Custom module result handling loop. This is a paired macro, and should only
145 * be used with while_each_hook.
147 * See src/channels.cpp for an example of use.
149 #define DO_EACH_HOOK(n,v,args) \
151 EventHandlerIter iter_ ## n = ServerInstance->Modules->EventHandlers[I_ ## n].begin(); \
152 while (iter_ ## n != ServerInstance->Modules->EventHandlers[I_ ## n].end()) \
154 Module* mod_ ## n = *iter_ ## n; \
158 v = (mod_ ## n)->n args;
160 #define WHILE_EACH_HOOK(n) \
162 catch (CoreException& except_ ## n) \
164 ServerInstance->Logs->Log("MODULE",LOG_DEFAULT,"Exception caught: %s", (except_ ## n).GetReason()); \
165 (void) mod_ ## n; /* catch mismatched pairs */ \
171 * Module result iterator
172 * Runs the given hook until some module returns a useful result.
174 * Example: ModResult result;
175 * FIRST_MOD_RESULT(OnUserPreNick, result, (user, newnick))
177 #define FIRST_MOD_RESULT(n,v,args) do { \
178 v = MOD_RES_PASSTHRU; \
179 DO_EACH_HOOK(n,v,args) \
181 if (v != MOD_RES_PASSTHRU) \
184 WHILE_EACH_HOOK(n); \
187 /** Holds a module's Version information.
188 * The members (set by the constructor only) indicate details as to the version number
189 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
191 class CoreExport Version
194 /** Module description
196 const std::string description;
202 /** Server linking description string */
203 const std::string link_data;
205 /** Simple module version */
206 Version(const std::string &desc, int flags = VF_NONE);
208 /** Complex version information, including linking compatability data */
209 Version(const std::string &desc, int flags, const std::string& linkdata);
211 virtual ~Version() {}
214 /** The Request class is a unicast message directed at a given module.
215 * When this class is properly instantiated it may be sent to a module
216 * using the Send() method, which will call the given module's OnRequest
217 * method with this class as its parameter.
219 class CoreExport Request : public classbase
222 /** This should be a null-terminated string identifying the type of request,
223 * all modules should define this and use it to determine the nature of the
224 * request before they attempt to cast the Request in any way.
226 const char* const id;
227 /** This is a pointer to the sender of the message, which can be used to
228 * directly trigger events, or to create a reply.
231 /** The single destination of the Request
235 /** Create a new Request
236 * This is for the 'new' way of defining a subclass
237 * of Request and defining it in a common header,
238 * passing an object of your Request subclass through
239 * as a Request* and using the ID string to determine
240 * what to cast it back to and the other end.
242 Request(Module* src, Module* dst, const char* idstr);
243 /** Send the Request.
249 /** The Event class is a unicast message directed at all modules.
250 * When the class is properly instantiated it may be sent to all modules
251 * using the Send() method, which will trigger the OnEvent method in
252 * all modules passing the object as its parameter.
254 class CoreExport Event : public classbase
257 /** This is a pointer to the sender of the message, which can be used to
258 * directly trigger events, or to create a reply.
261 /** The event identifier.
262 * This is arbitary text which should be used to distinguish
263 * one type of event from another.
265 const std::string id;
267 /** Create a new Event
269 Event(Module* src, const std::string &eventid);
271 * The return result of an Event::Send() will always be NULL as
272 * no replies are expected.
277 class CoreExport DataProvider : public ServiceProvider
280 DataProvider(Module* Creator, const std::string& Name)
281 : ServiceProvider(Creator, Name, SERVICE_DATA) {}
284 class CoreExport dynamic_reference_base : public interfacebase
290 ServiceProvider* value;
293 dynamic_reference_base(Module* Creator, const std::string& Name);
294 ~dynamic_reference_base();
295 inline const std::string& GetProvider() { return name; }
296 void SetProvider(const std::string& newname);
298 operator bool() { return (value != NULL); }
299 static void reset_all();
302 inline void dynamic_reference_base::check()
305 throw ModuleException("Dynamic reference to '" + name + "' failed to resolve");
309 class dynamic_reference : public dynamic_reference_base
312 dynamic_reference(Module* Creator, const std::string& Name)
313 : dynamic_reference_base(Creator, Name) {}
315 inline T* operator->()
318 return static_cast<T*>(value);
328 class dynamic_reference_nocheck : public dynamic_reference_base
331 dynamic_reference_nocheck(Module* Creator, const std::string& Name)
332 : dynamic_reference_base(Creator, Name) {}
336 return static_cast<T*>(value);
345 class ModeReference : public dynamic_reference_nocheck<ModeHandler>
348 ModeReference(Module* mod, const std::string& modename)
349 : dynamic_reference_nocheck<ModeHandler>(mod, "mode/" + modename) {}
352 /** Priority types which can be used by Module::Prioritize()
354 enum Priority { PRIORITY_FIRST, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
356 /** Implementation-specific flags which may be set in Module::Implements()
361 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash,
362 I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois,
363 I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick,
364 I_OnUserMessage, I_OnUserNotice, I_OnMode, I_OnGetServerDescription, I_OnSyncUser,
365 I_OnSyncChannel, I_OnDecodeMetaData, I_OnWallops, I_OnAcceptConnection, I_OnUserInit,
366 I_OnChangeHost, I_OnChangeName, I_OnAddLine, I_OnDelLine, I_OnExpireLine,
367 I_OnUserPostNick, I_OnPreMode, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule,
368 I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite,
369 I_OnRawMode, I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckChannelBan, I_OnExtBanCheck,
370 I_OnStats, I_OnChangeLocalUserHost, I_OnPreTopicChange,
371 I_OnPostTopicChange, I_OnEvent, I_OnGlobalOper, I_OnPostConnect,
372 I_OnChangeLocalUserGECOS, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
373 I_OnPostOper, I_OnSyncNetwork, I_OnSetAway, I_OnPostCommand, I_OnPostJoin,
374 I_OnWhoisLine, I_OnBuildNeighborList, I_OnGarbageCollect, I_OnSetConnectClass,
375 I_OnText, I_OnPassCompare, I_OnRunTestSuite, I_OnNamesListItem, I_OnNumeric, I_OnHookIO,
376 I_OnPreRehash, I_OnModuleRehash, I_OnSendWhoLine, I_OnChangeIdent, I_OnSetUserIP,
380 /** Base class for all InspIRCd modules
381 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
382 * its methods will be called when irc server events occur. class inherited from module must be
383 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
385 class CoreExport Module : public classbase, public usecountbase
388 /** File that this module was loaded from
390 std::string ModuleSourceFile;
391 /** Reference to the dlopen() value
393 DLLManager* ModuleDLLManager;
395 /** Default constructor.
396 * Creates a module class. Don't do any type of hook registration or checks
397 * for other modules here; do that in init().
402 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
404 virtual void init() {}
406 /** Clean up prior to destruction
407 * If you override, you must call this AFTER your module's cleanup
409 virtual CullResult cull();
411 /** Default destructor.
412 * destroys a module class
416 virtual void Prioritize()
420 /** Returns the version number of a Module.
421 * The method should return a Version object with its version information assigned via
424 virtual Version GetVersion() = 0;
426 /** Called when a user connects.
427 * The details of the connecting user are available to you in the parameter User *user
428 * @param user The user who is connecting
430 virtual void OnUserConnect(LocalUser* user);
432 /** Called when a user quits.
433 * The details of the exiting user are available to you in the parameter User *user
434 * This event is only called when the user is fully registered when they quit. To catch
435 * raw disconnections, use the OnUserDisconnect method.
436 * @param user The user who is quitting
437 * @param message The user's quit message (as seen by non-opers)
438 * @param oper_message The user's quit message (as seen by opers)
440 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
442 /** Called whenever a user's socket is closed.
443 * The details of the exiting user are available to you in the parameter User *user
444 * This event is called for all users, registered or not, as a cleanup method for modules
445 * which might assign resources to user, such as dns lookups, objects and sockets.
446 * @param user The user who is disconnecting
448 virtual void OnUserDisconnect(LocalUser* user);
450 /** Called whenever a channel is about to be deleted
451 * @param chan The channel being deleted
452 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
454 virtual ModResult OnChannelPreDelete(Channel *chan);
456 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
457 * @param chan The channel being deleted
459 virtual void OnChannelDelete(Channel* chan);
461 /** Called when a user joins a channel.
462 * The details of the joining user are available to you in the parameter User *user,
463 * and the details of the channel they have joined is available in the variable Channel *channel
464 * @param memb The channel membership being created
465 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
466 * to a channel due to the network sync.
467 * @param created This is true if the join created the channel
468 * @param except_list A list of users not to send to.
470 virtual void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list);
472 /** Called after a user joins a channel
473 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
475 * @param memb The channel membership created
477 virtual void OnPostJoin(Membership* memb);
479 /** Called when a user parts a channel.
480 * The details of the leaving user are available to you in the parameter User *user,
481 * and the details of the channel they have left is available in the variable Channel *channel
482 * @param memb The channel membership being destroyed
483 * @param partmessage The part message, or an empty string (may be modified)
484 * @param except_list A list of users to not send to.
486 virtual void OnUserPart(Membership* memb, std::string &partmessage, CUList& except_list);
488 /** Called on rehash.
489 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
490 * system. This is called in all cases -- including when this server will not execute the
491 * rehash because it is directed at a remote server.
493 * @param user The user performing the rehash, if any. If this is server initiated, the value of
494 * this variable will be NULL.
495 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
498 virtual void OnPreRehash(User* user, const std::string ¶meter);
500 /** Called on rehash.
501 * This method is called when a user initiates a module-specific rehash. This can be used to do
502 * expensive operations (such as reloading SSL certificates) that are not executed on a normal
503 * rehash for efficiency. A rehash of this type does not reload the core configuration.
505 * @param user The user performing the rehash.
506 * @param parameter The parameter given to REHASH
508 virtual void OnModuleRehash(User* user, const std::string ¶meter);
510 /** Called on rehash.
511 * This method is called after a rehash has completed. You should use it to reload any module
512 * configuration from the main configuration file.
513 * @param user The user that performed the rehash, if it was initiated by a user and that user
514 * is still connected.
516 virtual void OnRehash(User* user);
518 /** Called whenever a snotice is about to be sent to a snomask.
519 * snomask and type may both be modified; the message may not.
520 * @param snomask The snomask the message is going to (e.g. 'A')
521 * @param type The textual description the snomask will go to (e.g. 'OPER')
522 * @param message The text message to be sent via snotice
523 * @return 1 to block the snotice from being sent entirely, 0 else.
525 virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
527 /** Called whenever a user is about to join a channel, before any processing is done.
528 * Returning a value of 1 from this function stops the process immediately, causing no
529 * output to be sent to the user by the core. If you do this you must produce your own numerics,
530 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
531 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
535 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
536 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
537 * processing on the actual channel record at this point, however the channel NAME will still be passed in
538 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
539 * @param user The user joining the channel
540 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
541 * @param cname The channel name being joined. For new channels this is valid where chan is not.
542 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "o".
543 * You may alter this string to alter the user's modes on the channel.
544 * @param keygiven The key given to join the channel, or an empty string if none was provided
545 * @return 1 To prevent the join, 0 to allow it.
547 virtual ModResult OnUserPreJoin(LocalUser* user, Channel* chan, const std::string& cname, std::string& privs, const std::string& keygiven);
549 /** Called whenever a user is about to be kicked.
550 * Returning a value of 1 from this function stops the process immediately, causing no
551 * output to be sent to the user by the core. If you do this you must produce your own numerics,
553 * @param source The user issuing the kick
554 * @param memb The channel membership of the user who is being kicked.
555 * @param reason The kick reason
556 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
558 virtual ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason);
560 /** Called whenever a user is kicked.
561 * If this method is called, the kick is already underway and cannot be prevented, so
562 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
563 * @param source The user issuing the kick
564 * @param memb The channel membership of the user who was kicked.
565 * @param reason The kick reason
566 * @param except_list A list of users to not send to.
568 virtual void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except_list);
570 /** Called whenever a user opers locally.
571 * The User will contain the oper mode 'o' as this function is called after any modifications
572 * are made to the user's structure by the core.
573 * @param user The user who is opering up
574 * @param opertype The opers type name
576 virtual void OnOper(User* user, const std::string &opertype);
578 /** Called after a user opers locally.
579 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
580 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
581 * out the OPERTYPE, etc.
582 * @param user The user who is opering up
583 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
584 * @param opertype The opers type name
586 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
588 /** Called whenever a user types /INFO.
589 * The User will contain the information of the user who typed the command. Modules may use this
590 * method to output their own credits in /INFO (which is the ircd's version of an about box).
591 * It is purposefully not possible to modify any info that has already been output, or halt the list.
592 * You must write a 371 numeric to the user, containing your info in the following format:
594 * <nick> :information here
596 * @param user The user issuing /INFO
598 virtual void OnInfo(User* user);
600 /** Called whenever a /WHOIS is performed on a local user.
601 * The source parameter contains the details of the user who issued the WHOIS command, and
602 * the dest parameter contains the information of the user they are whoising.
603 * @param source The user issuing the WHOIS command
604 * @param dest The user who is being WHOISed
606 virtual void OnWhois(User* source, User* dest);
608 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
609 * Returning 1 from this function stops the process immediately, causing no
610 * output to be sent to the user by the core. If you do this you must produce your own numerics,
611 * notices etc. This is useful for modules which may want to filter invites to channels.
612 * @param source The user who is issuing the INVITE
613 * @param dest The user being invited
614 * @param channel The channel the user is being invited to
615 * @param timeout The time the invite will expire (0 == never)
616 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
618 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
620 /** Called after a user has been successfully invited to a channel.
621 * You cannot prevent the invite from occuring using this function, to do that,
622 * use OnUserPreInvite instead.
623 * @param source The user who is issuing the INVITE
624 * @param dest The user being invited
625 * @param channel The channel the user is being invited to
626 * @param timeout The time the invite will expire (0 == never)
628 virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout);
630 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
631 * Returning any nonzero value from this function stops the process immediately, causing no
632 * output to be sent to the user by the core. If you do this you must produce your own numerics,
633 * notices etc. This is useful for modules which may want to filter or redirect messages.
634 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
635 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
636 * of where the message is destined to be sent.
637 * @param user The user sending the message
638 * @param dest The target of the message (Channel* or User*)
639 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
640 * @param text Changeable text being sent by the user
641 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
642 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
643 * It will be ignored for private messages.
644 * @return 1 to deny the message, 0 to allow it
646 virtual ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
648 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
649 * Returning any nonzero value from this function stops the process immediately, causing no
650 * output to be sent to the user by the core. If you do this you must produce your own numerics,
651 * notices etc. This is useful for modules which may want to filter or redirect messages.
652 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
653 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
654 * of where the message is destined to be sent.
655 * You may alter the message text as you wish before relinquishing control to the next module
656 * in the chain, and if no other modules block the text this altered form of the text will be sent out
657 * to the user and possibly to other servers.
658 * @param user The user sending the message
659 * @param dest The target of the message (Channel* or User*)
660 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
661 * @param text Changeable text being sent by the user
662 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
663 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
664 * It will be ignored for private notices.
665 * @return 1 to deny the NOTICE, 0 to allow it
667 virtual ModResult OnUserPreNotice(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
669 /** Called when sending a message to all "neighbors" of a given user -
670 * that is, all users that share a common channel. This is used in
671 * commands such as NICK, QUIT, etc.
672 * @param source The source of the message
673 * @param include_c Channels to scan for users to include
674 * @param exceptions Map of user->bool that overrides the inclusion decision
676 * Set exceptions[user] = true to include, exceptions[user] = false to exclude
678 virtual void OnBuildNeighborList(User* source, UserChanList &include_c, std::map<User*,bool> &exceptions);
680 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
681 * Please note that although you can see remote nickchanges through this function, you should
682 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
683 * check user->server before taking any action (including returning nonzero from the method).
684 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
685 * module to generate some meaninful output.
686 * @param user The username changing their nick
687 * @param newnick Their new nickname
688 * @return 1 to deny the change, 0 to allow
690 virtual ModResult OnUserPreNick(User* user, const std::string &newnick);
692 /** Called after any PRIVMSG sent from a user.
693 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
694 * if target_type is TYPE_CHANNEL.
695 * @param user The user sending the message
696 * @param dest The target of the message
697 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
698 * @param text the text being sent by the user
699 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
700 * @param exempt_list A list of users to not send to.
702 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
704 /** Called after any NOTICE sent from a user.
705 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
706 * if target_type is TYPE_CHANNEL.
707 * @param user The user sending the message
708 * @param dest The target of the message
709 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
710 * @param text the text being sent by the user
711 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
712 * @param exempt_list A list of users to not send to.
714 virtual void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
716 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
717 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
718 * if target_type is TYPE_CHANNEL.
719 * The difference between this event and OnUserPreNotice/OnUserPreMessage is that delivery is gauranteed,
720 * the message has already been vetted. In the case of the other two methods, a later module may stop your
721 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
722 * @param user The user sending the message
723 * @param dest The target of the message
724 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
725 * @param text the text being sent by the user
726 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
727 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
729 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
731 /** Called after every MODE command sent from a user
732 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
733 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
734 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
735 * @param user The user sending the MODEs
736 * @param dest The target of the modes (User* or Channel*)
737 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
738 * @param text The actual modes and their parameters if any
739 * @param translate The translation types of the mode parameters
741 virtual void OnMode(User* user, void* dest, int target_type, const std::vector<std::string> &text, const std::vector<TranslateType> &translate);
743 /** Allows modules to alter or create server descriptions
744 * Whenever a module requires a server description, for example for display in
745 * WHOIS, this function is called in all modules. You may change or define the
746 * description given in std::string &description. If you do, this description
747 * will be shown in the WHOIS fields.
748 * @param servername The servername being searched for
749 * @param description Alterable server description for this server
751 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
753 /** Allows modules to synchronize data which relates to users during a netburst.
754 * When this function is called, it will be called from the module which implements
755 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
756 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
757 * (see below). This function will be called for every user visible on your side
758 * of the burst, allowing you to for example set modes, etc. Do not use this call to
759 * synchronize data which you have stored using class Extensible -- There is a specialist
760 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
761 * @param user The user being syncronized
762 * @param proto A pointer to the module handling network protocol
763 * @param opaque An opaque pointer set by the protocol module, should not be modified!
765 virtual void OnSyncUser(User* user, Module* proto, void* opaque);
767 /** Allows modules to synchronize data which relates to channels during a netburst.
768 * When this function is called, it will be called from the module which implements
769 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
770 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
771 * (see below). This function will be called for every user visible on your side
772 * of the burst, allowing you to for example set modes, etc.
774 * @param chan The channel being syncronized
775 * @param proto A pointer to the module handling network protocol
776 * @param opaque An opaque pointer set by the protocol module, should not be modified!
778 virtual void OnSyncChannel(Channel* chan, Module* proto, void* opaque);
780 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
781 * Whenever the linking module wants to send out data, but doesnt know what the data
782 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
783 * this method is called. You should use the ProtoSendMetaData function after you've
784 * correctly decided how the data should be represented, to send the metadata on its way if
785 * if it belongs to your module.
786 * @param proto A pointer to the module handling network protocol
787 * @param opaque An opaque pointer set by the protocol module, should not be modified!
788 * @param displayable If this value is true, the data is going to be displayed to a user,
789 * and not sent across the network. Use this to determine wether or not to show sensitive data.
791 virtual void OnSyncNetwork(Module* proto, void* opaque);
793 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
794 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
795 * @param target The Channel* or User* that data should be added to
796 * @param extname The extension name which is being sent
797 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
799 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
801 /** Implemented by modules which provide the ability to link servers.
802 * These modules will implement this method, which allows transparent sending of servermodes
803 * down the network link as a broadcast, without a module calling it having to know the format
804 * of the MODE command before the actual mode string.
806 * @param opaque An opaque pointer set by the protocol module, should not be modified!
807 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
808 * @param target The Channel* or User* that modes should be sent for
809 * @param modeline The modes and parameters to be sent
810 * @param translate The translation types of the mode parameters
812 virtual void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::vector<std::string> &modeline, const std::vector<TranslateType> &translate);
814 /** Implemented by modules which provide the ability to link servers.
815 * These modules will implement this method, which allows metadata (extra data added to
816 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
817 * to other servers on a netburst and decoded at the other end by the same module on a
820 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
821 * how to use this function.
822 * @param opaque An opaque pointer set by the protocol module, should not be modified!
823 * @param target The Channel* or User* that metadata should be sent for
824 * @param extname The extension name to send metadata for
825 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
827 virtual void ProtoSendMetaData(void* opaque, Extensible* target, const std::string &extname, const std::string &extdata);
829 /** Called after every WALLOPS command.
830 * @param user The user sending the WALLOPS
831 * @param text The content of the WALLOPS message
833 virtual void OnWallops(User* user, const std::string &text);
835 /** Called whenever a user's hostname is changed.
836 * This event triggers after the host has been set.
837 * @param user The user whos host is being changed
838 * @param newhost The new hostname being set
840 virtual void OnChangeHost(User* user, const std::string &newhost);
842 /** Called whenever a user's GECOS (realname) is changed.
843 * This event triggers after the name has been set.
844 * @param user The user who's GECOS is being changed
845 * @param gecos The new GECOS being set on the user
847 virtual void OnChangeName(User* user, const std::string &gecos);
849 /** Called whenever a user's IDENT is changed.
850 * This event triggers after the name has been set.
851 * @param user The user who's IDENT is being changed
852 * @param ident The new IDENT being set on the user
854 virtual void OnChangeIdent(User* user, const std::string &ident);
856 /** Called whenever an xline is added by a local user.
857 * This method is triggered after the line is added.
858 * @param source The sender of the line or NULL for local server
859 * @param line The xline being added
861 virtual void OnAddLine(User* source, XLine* line);
863 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
864 * This method is triggered after the line is deleted.
865 * @param source The user removing the line or NULL for local server
866 * @param line the line being deleted
868 virtual void OnDelLine(User* source, XLine* line);
870 /** Called whenever an xline expires.
871 * This method is triggered after the line is deleted.
872 * @param line The line being deleted.
874 virtual void OnExpireLine(XLine *line);
876 /** Called before your module is unloaded to clean up Extensibles.
877 * This method is called once for every user and channel on the network,
878 * so that when your module unloads it may clear up any remaining data
879 * in the form of Extensibles added using Extensible::Extend().
880 * If the target_type variable is TYPE_USER, then void* item refers to
881 * a User*, otherwise it refers to a Channel*.
882 * @param target_type The type of item being cleaned
883 * @param item A pointer to the item's class
885 virtual void OnCleanup(int target_type, void* item);
887 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
888 * have been applied. Please note that although you can see remote nickchanges through this function, you should
889 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
890 * check user->server before taking any action (including returning nonzero from the method).
891 * Because this method is called after the nickchange is taken place, no return values are possible
892 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
893 * @param user The user changing their nick
894 * @param oldnick The old nickname of the user before the nickchange
896 virtual void OnUserPostNick(User* user, const std::string &oldnick);
898 /** Called before any mode change, to allow a single access check for
899 * a full mode change (use OnRawMode to check individual modes)
901 * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
902 * OnRawMode for each individual mode
904 * @param source the user making the mode change
905 * @param dest the user destination of the umode change (NULL if a channel mode)
906 * @param channel the channel destination of the mode change
907 * @param parameters raw mode parameters; parameters[0] is the user/channel being changed
909 virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, const std::vector<std::string>& parameters);
911 /** Called when a 005 numeric is about to be output.
912 * The module should modify the 005 numeric if needed to indicate its features.
913 * @param output The 005 map to be modified if neccessary.
915 virtual void On005Numeric(std::map<std::string, std::string>& tokens);
917 /** Called when a client is disconnected by KILL.
918 * If a client is killed by a server, e.g. a nickname collision or protocol error,
920 * Return 1 from this function to prevent the kill, and 0 from this function to allow
921 * it as normal. If you prevent the kill no output will be sent to the client, it is
922 * down to your module to generate this information.
923 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
924 * If you do so youre risking race conditions, desyncs and worse!
925 * @param source The user sending the KILL
926 * @param dest The user being killed
927 * @param reason The kill reason
928 * @return 1 to prevent the kill, 0 to allow
930 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
932 /** Called when an oper wants to disconnect a remote user via KILL
933 * @param source The user sending the KILL
934 * @param dest The user being killed
935 * @param reason The kill reason
936 * @param operreason The oper kill reason
938 virtual void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
940 /** Called whenever a module is loaded.
941 * mod will contain a pointer to the module, and string will contain its name,
942 * for example m_widgets.so. This function is primary for dependency checking,
943 * your module may decide to enable some extra features if it sees that you have
944 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
945 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
946 * but instead operate under reduced functionality, unless the dependency is
947 * absolutely neccessary (e.g. a module that extends the features of another
949 * @param mod A pointer to the new module
951 virtual void OnLoadModule(Module* mod);
953 /** Called whenever a module is unloaded.
954 * mod will contain a pointer to the module, and string will contain its name,
955 * for example m_widgets.so. This function is primary for dependency checking,
956 * your module may decide to enable some extra features if it sees that you have
957 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
958 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
959 * but instead operate under reduced functionality, unless the dependency is
960 * absolutely neccessary (e.g. a module that extends the features of another
962 * @param mod Pointer to the module being unloaded (still valid)
964 virtual void OnUnloadModule(Module* mod);
966 /** Called once every five seconds for background processing.
967 * This timer can be used to control timed features. Its period is not accurate
968 * enough to be used as a clock, but it is gauranteed to be called at least once in
969 * any five second period, directly from the main loop of the server.
970 * @param curtime The current timer derived from time(2)
972 virtual void OnBackgroundTimer(time_t curtime);
974 /** Called whenever any command is about to be executed.
975 * This event occurs for all registered commands, wether they are registered in the core,
976 * or another module, and for invalid commands. Invalid commands may only be sent to this
977 * function when the value of validated is false. By returning 1 from this method you may prevent the
978 * command being executed. If you do this, no output is created by the core, and it is
979 * down to your module to produce any output neccessary.
980 * Note that unless you return 1, you should not destroy any structures (e.g. by using
981 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
982 * method returns, it will be passed an invalid pointer to the user object and crash!)
983 * @param command The command being executed
984 * @param parameters An array of array of characters containing the parameters for the command
985 * @param user the user issuing the command
986 * @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.
987 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
988 * @param original_line The entire original line as passed to the parser from the user
989 * @return 1 to block the command, 0 to allow
991 virtual ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, LocalUser *user, bool validated, const std::string &original_line);
993 /** Called after any command has been executed.
994 * This event occurs for all registered commands, wether they are registered in the core,
995 * or another module, but it will not occur for invalid commands (e.g. ones which do not
996 * exist within the command table). The result code returned by the command handler is
998 * @param command The command being executed
999 * @param parameters An array of array of characters containing the parameters for the command
1000 * @param user the user issuing the command
1001 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
1002 * @param original_line The entire original line as passed to the parser from the user
1004 virtual void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, LocalUser *user, CmdResult result, const std::string &original_line);
1006 /** Called when a user is first connecting, prior to starting DNS lookups, checking initial
1007 * connect class, or accepting any commands.
1009 virtual void OnUserInit(LocalUser* user);
1011 /** Called to check if a user who is connecting can now be allowed to register
1012 * If any modules return false for this function, the user is held in the waiting
1013 * state until all modules return true. For example a module which implements ident
1014 * lookups will continue to return false for a user until their ident lookup is completed.
1015 * Note that the registration timeout for a user overrides these checks, if the registration
1016 * timeout is reached, the user is disconnected even if modules report that the user is
1017 * not ready to connect.
1018 * @param user The user to check
1019 * @return true to indicate readiness, false if otherwise
1021 virtual ModResult OnCheckReady(LocalUser* user);
1023 /** Called whenever a user is about to register their connection (e.g. before the user
1024 * is sent the MOTD etc). Modules can use this method if they are performing a function
1025 * which must be done before the actual connection is completed (e.g. ident lookups,
1026 * dnsbl lookups, etc).
1027 * Note that you should NOT delete the user record here by causing a disconnection!
1028 * Use OnUserConnect for that instead.
1029 * @param user The user registering
1030 * @return 1 to indicate user quit, 0 to continue
1032 virtual ModResult OnUserRegister(LocalUser* user);
1034 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1035 * This method will always be called for each join, wether or not the channel is actually +i, and
1036 * determines the outcome of an if statement around the whole section of invite checking code.
1037 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1038 * @param user The user joining the channel
1039 * @param chan The channel being joined
1040 * @return 1 to explicitly allow the join, 0 to proceed as normal
1042 virtual ModResult OnCheckInvite(User* user, Channel* chan);
1044 /** Called whenever a mode character is processed.
1045 * Return 1 from this function to block the mode character from being processed entirely.
1046 * @param user The user who is sending the mode
1047 * @param chan The channel the mode is being sent to (or NULL if a usermode)
1048 * @param mode The mode character being set
1049 * @param param The parameter for the mode or an empty string
1050 * @param adding true of the mode is being added, false if it is being removed
1051 * @param pcnt The parameter count for the mode (0 or 1)
1052 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
1053 * to skip all permission checking. Please note that for remote mode changes, your return value
1056 virtual ModResult OnRawMode(User* user, Channel* chan, const char mode, const std::string ¶m, bool adding, int pcnt);
1058 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1059 * This method will always be called for each join, wether or not the channel is actually +k, and
1060 * determines the outcome of an if statement around the whole section of key checking code.
1061 * if the user specified no key, the keygiven string will be a valid but empty value.
1062 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1063 * @param user The user joining the channel
1064 * @param chan The channel being joined
1065 * @param keygiven The key given on joining the channel.
1066 * @return 1 to explicitly allow the join, 0 to proceed as normal
1068 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
1070 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1071 * This method will always be called for each join, wether or not the channel is actually +l, and
1072 * determines the outcome of an if statement around the whole section of channel limit checking code.
1073 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1074 * @param user The user joining the channel
1075 * @param chan The channel being joined
1076 * @return 1 to explicitly allow the join, 0 to proceed as normal
1078 virtual ModResult OnCheckLimit(User* user, Channel* chan);
1081 * Checks for a user's ban from the channel
1082 * @param user The user to check
1083 * @param chan The channel to check in
1084 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1085 * ban check, or MOD_RES_PASSTHRU to check bans normally
1087 virtual ModResult OnCheckChannelBan(User* user, Channel* chan);
1090 * Checks for a user's match of a single ban
1091 * @param user The user to check for match
1092 * @param chan The channel on which the match is being checked
1093 * @param mask The mask being checked
1094 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1095 * ban check, or MOD_RES_PASSTHRU to check bans normally
1097 virtual ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask);
1099 /** Checks for a match on a given extban type
1100 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1101 * ban check, or MOD_RES_PASSTHRU to check bans normally
1103 virtual ModResult OnExtBanCheck(User* user, Channel* chan, char type);
1105 /** Called on all /STATS commands
1106 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1107 * @param symbol the symbol provided to /STATS
1108 * @param user the user issuing the /STATS command
1109 * @param results A string_list to append results into. You should put all your results
1110 * into this string_list, rather than displaying them directly, so that your handler will
1111 * work when remote STATS queries are received.
1112 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1114 virtual ModResult OnStats(char symbol, User* user, string_list &results);
1116 /** Called whenever a change of a local users displayed host is attempted.
1117 * Return 1 to deny the host change, or 0 to allow it.
1118 * @param user The user whos host will be changed
1119 * @param newhost The new hostname
1120 * @return 1 to deny the host change, 0 to allow
1122 virtual ModResult OnChangeLocalUserHost(LocalUser* user, const std::string &newhost);
1124 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1125 * return 1 to deny the name change, or 0 to allow it.
1126 * @param user The user whos GECOS will be changed
1127 * @param newhost The new GECOS
1128 * @return 1 to deny the GECOS change, 0 to allow
1130 virtual ModResult OnChangeLocalUserGECOS(LocalUser* user, const std::string &newhost);
1132 /** Called before a topic is changed.
1133 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
1134 * As with other 'pre' events, you should only ever block a local event.
1135 * @param user The user changing the topic
1136 * @param chan The channels who's topic is being changed
1137 * @param topic The actual topic text
1138 * @return 1 to block the topic change, 0 to allow
1140 virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
1142 /** Called whenever a topic has been changed.
1143 * To block topic changes you must use OnPreTopicChange instead.
1144 * @param user The user changing the topic
1145 * @param chan The channels who's topic is being changed
1146 * @param topic The actual topic text
1148 virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
1150 /** Called whenever an Event class is sent to all modules by another module.
1151 * You should *always* check the value of Event::id to determine the event type.
1152 * @param event The Event class being received
1154 virtual void OnEvent(Event& event);
1156 /** Called whenever a Request class is sent to your module by another module.
1157 * The value of Request::id should be used to determine the type of request.
1158 * @param request The Request class being received
1160 virtual void OnRequest(Request& request);
1162 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
1163 * The password field (from the config file) is in 'password' and is to be compared against
1164 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
1165 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
1166 * @param ex The object that's causing the authentication (User* for \<oper> \<connect:allow> etc, Server* for \<link>).
1167 * @param password The password from the configuration file (the password="" value).
1168 * @param input The password entered by the user or whoever.
1169 * @param hashtype The hash value from the config
1170 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
1172 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
1174 /** Called whenever a user is given usermode +o, anywhere on the network.
1175 * You cannot override this and prevent it from happening as it is already happened and
1176 * such a task must be performed by another server. You can however bounce modes by sending
1177 * servermodes out to reverse mode changes.
1178 * @param user The user who is opering
1180 virtual void OnGlobalOper(User* user);
1182 /** Called after a user has fully connected and all modules have executed OnUserConnect
1183 * This event is informational only. You should not change any user information in this
1184 * event. To do so, use the OnUserConnect method to change the state of local users.
1185 * This is called for both local and remote users.
1186 * @param user The user who is connecting
1188 virtual void OnPostConnect(User* user);
1190 /** Called to install an I/O hook on an event handler
1191 * @param user The socket to possibly install the I/O hook on
1192 * @param via The port that the user connected on
1194 virtual void OnHookIO(StreamSocket* user, ListenSocket* via);
1196 /** Called when a port accepts a connection
1197 * Return MOD_RES_ACCEPT if you have used the file descriptor.
1198 * @param fd The file descriptor returned from accept()
1199 * @param sock The socket connection for the new user
1200 * @param client The client IP address and port
1201 * @param server The server IP address and port
1203 virtual ModResult OnAcceptConnection(int fd, ListenSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
1205 /** Called immediately after any connection is accepted. This is intended for raw socket
1206 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1207 * no information relating to a user record as the connection has not been assigned yet.
1208 * There are no return values from this call as all modules get an opportunity if required to
1209 * process the connection.
1210 * @param sock The socket in question
1211 * @param client The client IP address and port
1212 * @param server The server IP address and port
1214 virtual void OnStreamSocketAccept(StreamSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
1217 * Called when a hooked stream has data to write, or when the socket
1218 * engine returns it as writable
1219 * @param sock The socket in question
1220 * @param sendq Data to send to the socket
1221 * @return 1 if the sendq has been completely emptied, 0 if there is
1222 * still data to send, and -1 if there was an error
1224 virtual int OnStreamSocketWrite(StreamSocket* sock, std::string& sendq);
1226 /** Called immediately before any socket is closed. When this event is called, shutdown()
1227 * has not yet been called on the socket.
1228 * @param sock The socket in question
1230 virtual void OnStreamSocketClose(StreamSocket* sock);
1232 /** Called immediately upon connection of an outbound BufferedSocket which has been hooked
1234 * @param sock The socket in question
1236 virtual void OnStreamSocketConnect(StreamSocket* sock);
1239 * Called when the stream socket has data to read
1240 * @param sock The socket that is ready
1241 * @param recvq The receive queue that new data should be appended to
1242 * @return 1 if new data has been read, 0 if no new data is ready (but the
1243 * socket is still connected), -1 if there was an error or close
1245 virtual int OnStreamSocketRead(StreamSocket* sock, std::string& recvq);
1247 /** Called whenever a user sets away or returns from being away.
1248 * The away message is available as a parameter, but should not be modified.
1249 * At this stage, it has already been copied into the user record.
1250 * If awaymsg is empty, the user is returning from away.
1251 * @param user The user setting away
1252 * @param awaymsg The away message of the user, or empty if returning from away
1253 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
1255 virtual ModResult OnSetAway(User* user, const std::string &awaymsg);
1257 /** Called whenever a line of WHOIS output is sent to a user.
1258 * You may change the numeric and the text of the output by changing
1259 * the values numeric and text, but you cannot change the user the
1260 * numeric is sent to. You may however change the user's User values.
1261 * @param user The user the numeric is being sent to
1262 * @param dest The user being WHOISed
1263 * @param numeric The numeric of the line being sent
1264 * @param text The text of the numeric, including any parameters
1265 * @return nonzero to drop the line completely so that the user does not
1266 * receive it, or zero to allow the line to be sent.
1268 virtual ModResult OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
1270 /** Called at intervals for modules to garbage-collect any hashes etc.
1271 * Certain data types such as hash_map 'leak' buckets, which must be
1272 * tidied up and freed by copying into a new item every so often. This
1273 * method is called when it is time to do that.
1275 virtual void OnGarbageCollect();
1277 /** Called when a user's connect class is being matched
1278 * @return MOD_RES_ALLOW to force the class to match, MOD_RES_DENY to forbid it, or
1279 * MOD_RES_PASSTHRU to allow normal matching (by host/port).
1281 virtual ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass);
1283 /** Add test suite hooks here. These are used for testing functionality of a module
1284 * via the --testsuite debugging parameter.
1286 virtual void OnRunTestSuite();
1288 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
1289 * For example NAMESX, channel mode +u and +I, and UHNAMES. If the nick is set to an empty string by any
1290 * module, then this will cause the nickname not to be displayed at all.
1292 virtual void OnNamesListItem(User* issuer, Membership* item, std::string &prefixes, std::string &nick);
1294 virtual ModResult OnNumeric(User* user, unsigned int numeric, const std::string &text);
1296 /** Called whenever a result from /WHO is about to be returned
1297 * @param source The user running the /WHO query
1298 * @param params The parameters to the /WHO query
1299 * @param user The user that this line of the query is about
1300 * @param line The raw line to send; modifiable, if empty no line will be returned.
1302 virtual void OnSendWhoLine(User* source, const std::vector<std::string>& params, User* user, std::string& line);
1304 /** Called whenever a local user's IP is set for the first time, or when a local user's IP changes due to
1305 * a module like m_cgiirc changing it.
1306 * @param user The user whose IP is being set
1308 virtual void OnSetUserIP(LocalUser* user);
1311 /** Caches a text file into memory and can be used to retrieve lines from it.
1312 * This class contains methods for read-only manipulation of a text file in memory.
1313 * Either use the constructor type with one parameter to load a file into memory
1314 * at construction, or use the LoadFile method to load a file.
1316 class CoreExport FileReader : public classbase
1318 /** The file contents
1320 std::vector<std::string> fc;
1322 /** Content size in bytes
1324 unsigned long contentsize;
1326 /** Calculate content size in bytes
1331 /** Default constructor.
1332 * This method does not load any file into memory, you must use the LoadFile method
1333 * after constructing the class this way.
1337 /** Secondary constructor.
1338 * This method initialises the class with a file loaded into it ready for GetLine and
1339 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1342 FileReader(const std::string &filename);
1344 /** Default destructor.
1345 * This deletes the memory allocated to the file.
1349 /** Used to load a file.
1350 * This method loads a file into the class ready for GetLine and
1351 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1354 void LoadFile(const std::string &filename);
1356 /** Returns the whole content of the file as std::string
1358 std::string Contents();
1360 /** Returns the entire size of the file as std::string
1362 unsigned long ContentSize();
1364 /** Returns true if the file exists
1365 * This function will return false if the file could not be opened.
1369 /** Retrieve one line from the file.
1370 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1371 * the index was out of bounds, or the line had no data on it.
1373 std::string GetLine(int x);
1375 /** Returns the size of the file in lines.
1376 * This method returns the number of lines in the read file. If it is 0, no lines have been
1377 * read into memory, either because the file is empty or it does not exist, or cannot be
1378 * opened due to permission problems.
1383 /** A list of modules
1385 typedef std::vector<Module*> IntModuleList;
1387 /** An event handler iterator
1389 typedef IntModuleList::iterator EventHandlerIter;
1391 /** ModuleManager takes care of all things module-related
1394 class CoreExport ModuleManager
1397 /** Holds a string describing the last module error to occur
1399 std::string LastModuleError;
1401 /** Total number of modules loaded into the ircd
1405 /** List of loaded modules and shared object/dll handles
1406 * keyed by module name
1408 std::map<std::string, Module*> Modules;
1414 } prioritizationState;
1416 /** Internal unload module hook */
1417 bool CanUnload(Module*);
1420 /** Event handler hooks.
1421 * This needs to be public to be used by FOREACH_MOD and friends.
1423 IntModuleList EventHandlers[I_END];
1425 /** List of data services keyed by name */
1426 std::multimap<std::string, ServiceProvider*> DataProviders;
1428 /** Simple, bog-standard, boring constructor.
1436 /** Change the priority of one event in a module.
1437 * Each module event has a list of modules which are attached to that event type.
1438 * If you wish to be called before or after other specific modules, you may use this
1439 * method (usually within void Module::Prioritize()) to set your events priority.
1440 * You may use this call in other methods too, however, this is not supported behaviour
1442 * @param mod The module to change the priority of
1443 * @param i The event to change the priority of
1444 * @param s The state you wish to use for this event. Use one of
1445 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1446 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1447 * to set it to be before or after one or more other modules.
1448 * @param which If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1449 * then this contains a the module that your module must be placed before
1452 bool SetPriority(Module* mod, Implementation i, Priority s, Module* which = NULL);
1454 /** Backwards compat interface */
1455 inline bool SetPriority(Module* mod, Implementation i, Priority s, Module** dptr)
1457 return SetPriority(mod, i, s, *dptr);
1460 /** Change the priority of all events in a module.
1461 * @param mod The module to set the priority of
1462 * @param s The priority of all events in the module.
1463 * Note that with this method, it is not possible to effectively use
1464 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1465 * SetPriority method for this, where you may specify other modules to
1466 * be prioritized against.
1468 bool SetPriority(Module* mod, Priority s);
1470 /** Attach an event to a module.
1471 * You may later detatch the event with ModuleManager::Detach().
1472 * If your module is unloaded, all events are automatically detatched.
1473 * @param i Event type to attach
1474 * @param mod Module to attach event to
1475 * @return True if the event was attached
1477 bool Attach(Implementation i, Module* mod);
1479 /** Detatch an event from a module.
1480 * This is not required when your module unloads, as the core will
1481 * automatically detatch your module from all events it is attached to.
1482 * @param i Event type to detach
1483 * @param mod Module to detach event from
1484 * @return True if the event was detached
1486 bool Detach(Implementation i, Module* mod);
1488 /** Attach an array of events to a module
1489 * @param i Event types (array) to attach
1490 * @param mod Module to attach events to
1491 * @param sz The size of the implementation array
1493 void Attach(Implementation* i, Module* mod, size_t sz);
1495 /** Detach all events from a module (used on unload)
1496 * @param mod Module to detach from
1498 void DetachAll(Module* mod);
1500 /** Returns text describing the last module error
1501 * @return The last error message to occur
1503 std::string& LastError();
1505 /** Load a given module file
1506 * @param filename The file to load
1507 * @param defer Defer module init (loading many modules)
1508 * @return True if the module was found and loaded
1510 bool Load(const std::string& filename, bool defer = false);
1512 /** Unload a given module file. Note that the module will not be
1513 * completely gone until the cull list has finished processing.
1515 * @return true on success; if false, LastError will give a reason
1517 bool Unload(Module* module);
1519 /** Run an asynchronous reload of the given module. When the reload is
1520 * complete, the callback will be run with true if the reload succeeded
1521 * and false if it did not.
1523 void Reload(Module* module, HandlerBase1<void, bool>* callback);
1525 /** Called by the InspIRCd constructor to load all modules from the config file.
1529 void DoSafeUnload(Module*);
1531 /** Get the total number of currently loaded modules
1532 * @return The number of loaded modules
1536 return this->ModCount;
1539 /** Find a module by name, and return a Module* to it.
1540 * This is preferred over iterating the module lists yourself.
1541 * @param name The module name to look up
1542 * @return A pointer to the module, or NULL if the module cannot be found
1544 Module* Find(const std::string &name);
1546 /** Register a service provided by a module */
1547 void AddService(ServiceProvider&);
1549 /** Unregister a service provided by a module */
1550 void DelService(ServiceProvider&);
1552 inline void AddServices(ServiceProvider** list, int count)
1554 for(int i=0; i < count; i++)
1555 AddService(*list[i]);
1558 /** Find a service by name.
1559 * If multiple modules provide a given service, the first one loaded will be chosen.
1561 ServiceProvider* FindService(ServiceType Type, const std::string& name);
1563 template<typename T> inline T* FindDataService(const std::string& name)
1565 return static_cast<T*>(FindService(SERVICE_DATA, name));
1568 /** Return a list of all modules matching the given filter
1569 * @param filter This int is a bitmask of flags set in Module::Flags,
1570 * such as VF_VENDOR or VF_STATIC. If you wish to receive a list of
1571 * all modules with no filtering, set this to 0.
1572 * @return The list of module names
1574 const std::vector<std::string> GetAllModuleNames(int filter);
1577 /** Do not mess with these functions unless you know the C preprocessor
1578 * well enough to explain why they are needed. The order is important.
1580 #define MODULE_INIT_STR MODULE_INIT_STR_FN_2(MODULE_INIT_SYM)
1581 #define MODULE_INIT_STR_FN_2(x) MODULE_INIT_STR_FN_1(x)
1582 #define MODULE_INIT_STR_FN_1(x) #x
1583 #define MODULE_INIT_SYM MODULE_INIT_SYM_FN_2(INSPIRCD_VERSION_MAJ, INSPIRCD_VERSION_API)
1584 #define MODULE_INIT_SYM_FN_2(x,y) MODULE_INIT_SYM_FN_1(x,y)
1585 #define MODULE_INIT_SYM_FN_1(x,y) inspircd_module_ ## x ## _ ## y
1589 struct AllCommandList {
1590 typedef Command* (*fn)(Module*);
1591 AllCommandList(fn cmd);
1593 #define COMMAND_INIT(x) static Command* MK_ ## x(Module* m) { return new x(m); } \
1594 static const AllCommandList PREP_ ## x(&MK_ ## x);
1596 struct AllModuleList {
1597 typedef Module* (*fn)();
1600 AllModuleList(fn mod, const std::string& Name);
1603 #define MODULE_INIT(x) static Module* MK_ ## x() { return new x; } \
1604 static const AllModuleList PREP_ ## x(&MK_ ## x, MODNAMESTR);
1606 #define MODNAMESTR MODNAMESTR_FN_2(MODNAME)
1607 #define MODNAMESTR_FN_2(x) MODNAMESTR_FN_1(x)
1608 #define MODNAMESTR_FN_1(x) #x
1612 /** This definition is used as shorthand for the various classes
1613 * and functions needed to make a module loadable by the OS.
1614 * It defines the class factory and external init_module function.
1618 #define MODULE_INIT(y) \
1619 extern "C" DllExport Module * MODULE_INIT_SYM() \
1623 BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
1625 switch ( nReason ) \
1627 case DLL_PROCESS_ATTACH: \
1628 case DLL_PROCESS_DETACH: \
1636 #define MODULE_INIT(y) \
1637 extern "C" DllExport Module * MODULE_INIT_SYM() \
1641 extern "C" const char inspircd_src_version[] = VERSION " r" REVISION;
1644 #define COMMAND_INIT(c) MODULE_INIT(CommandModule<c>)