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 202
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 1
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
294 dynamic_reference_base(Module* Creator, const std::string& Name);
295 ~dynamic_reference_base();
296 inline const std::string& GetProvider() { return name; }
297 void SetProvider(const std::string& newname);
299 operator bool() { return (value != NULL); }
300 static void reset_all();
303 inline void dynamic_reference_base::check()
306 throw ModuleException("Dynamic reference to '" + name + "' failed to resolve");
310 class dynamic_reference : public dynamic_reference_base
313 dynamic_reference(Module* Creator, const std::string& Name)
314 : dynamic_reference_base(Creator, Name) {}
316 inline T* operator->()
319 return static_cast<T*>(value);
329 class dynamic_reference_nocheck : public dynamic_reference_base
332 dynamic_reference_nocheck(Module* Creator, const std::string& Name)
333 : dynamic_reference_base(Creator, Name) {}
337 return static_cast<T*>(value);
346 /** Priority types which can be used by Module::Prioritize()
348 enum Priority { PRIORITY_FIRST, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
350 /** Implementation-specific flags which may be set in Module::Implements()
355 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash,
356 I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois,
357 I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick,
358 I_OnUserMessage, I_OnUserNotice, I_OnMode, I_OnGetServerDescription, I_OnSyncUser,
359 I_OnSyncChannel, I_OnDecodeMetaData, I_OnWallops, I_OnAcceptConnection, I_OnUserInit,
360 I_OnChangeHost, I_OnChangeName, I_OnAddLine, I_OnDelLine, I_OnExpireLine,
361 I_OnUserPostNick, I_OnPreMode, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule,
362 I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite,
363 I_OnRawMode, I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckChannelBan, I_OnExtBanCheck,
364 I_OnStats, I_OnChangeLocalUserHost, I_OnPreTopicChange,
365 I_OnPostTopicChange, I_OnEvent, I_OnGlobalOper, I_OnPostConnect,
366 I_OnChangeLocalUserGECOS, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
367 I_OnPostOper, I_OnSyncNetwork, I_OnSetAway, I_OnPostCommand, I_OnPostJoin,
368 I_OnWhoisLine, I_OnBuildNeighborList, I_OnGarbageCollect, I_OnSetConnectClass,
369 I_OnText, I_OnPassCompare, I_OnRunTestSuite, I_OnNamesListItem, I_OnNumeric, I_OnHookIO,
370 I_OnPreRehash, I_OnModuleRehash, I_OnSendWhoLine, I_OnChangeIdent, I_OnSetUserIP,
374 /** Base class for all InspIRCd modules
375 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
376 * its methods will be called when irc server events occur. class inherited from module must be
377 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
379 class CoreExport Module : public classbase, public usecountbase
382 /** File that this module was loaded from
384 std::string ModuleSourceFile;
385 /** Reference to the dlopen() value
387 DLLManager* ModuleDLLManager;
389 /** Default constructor.
390 * Creates a module class. Don't do any type of hook registration or checks
391 * for other modules here; do that in init().
396 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
398 virtual void init() {}
400 /** Clean up prior to destruction
401 * If you override, you must call this AFTER your module's cleanup
403 virtual CullResult cull();
405 /** Default destructor.
406 * destroys a module class
410 virtual void Prioritize()
414 /** Returns the version number of a Module.
415 * The method should return a Version object with its version information assigned via
418 virtual Version GetVersion() = 0;
420 /** Called when a user connects.
421 * The details of the connecting user are available to you in the parameter User *user
422 * @param user The user who is connecting
424 virtual void OnUserConnect(LocalUser* user);
426 /** Called when a user quits.
427 * The details of the exiting user are available to you in the parameter User *user
428 * This event is only called when the user is fully registered when they quit. To catch
429 * raw disconnections, use the OnUserDisconnect method.
430 * @param user The user who is quitting
431 * @param message The user's quit message (as seen by non-opers)
432 * @param oper_message The user's quit message (as seen by opers)
434 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
436 /** Called whenever a user's socket is closed.
437 * The details of the exiting user are available to you in the parameter User *user
438 * This event is called for all users, registered or not, as a cleanup method for modules
439 * which might assign resources to user, such as dns lookups, objects and sockets.
440 * @param user The user who is disconnecting
442 virtual void OnUserDisconnect(LocalUser* user);
444 /** Called whenever a channel is about to be deleted
445 * @param chan The channel being deleted
446 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
448 virtual ModResult OnChannelPreDelete(Channel *chan);
450 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
451 * @param chan The channel being deleted
453 virtual void OnChannelDelete(Channel* chan);
455 /** Called when a user joins a channel.
456 * The details of the joining user are available to you in the parameter User *user,
457 * and the details of the channel they have joined is available in the variable Channel *channel
458 * @param memb The channel membership being created
459 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
460 * to a channel due to the network sync.
461 * @param created This is true if the join created the channel
462 * @param except_list A list of users not to send to.
464 virtual void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list);
466 /** Called after a user joins a channel
467 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
469 * @param memb The channel membership created
471 virtual void OnPostJoin(Membership* memb);
473 /** Called when a user parts a channel.
474 * The details of the leaving user are available to you in the parameter User *user,
475 * and the details of the channel they have left is available in the variable Channel *channel
476 * @param memb The channel membership being destroyed
477 * @param partmessage The part message, or an empty string (may be modified)
478 * @param except_list A list of users to not send to.
480 virtual void OnUserPart(Membership* memb, std::string &partmessage, CUList& except_list);
482 /** Called on rehash.
483 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
484 * system. This is called in all cases -- including when this server will not execute the
485 * rehash because it is directed at a remote server.
487 * @param user The user performing the rehash, if any. If this is server initiated, the value of
488 * this variable will be NULL.
489 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
492 virtual void OnPreRehash(User* user, const std::string ¶meter);
494 /** Called on rehash.
495 * This method is called when a user initiates a module-specific rehash. This can be used to do
496 * expensive operations (such as reloading SSL certificates) that are not executed on a normal
497 * rehash for efficiency. A rehash of this type does not reload the core configuration.
499 * @param user The user performing the rehash.
500 * @param parameter The parameter given to REHASH
502 virtual void OnModuleRehash(User* user, const std::string ¶meter);
504 /** Called on rehash.
505 * This method is called after a rehash has completed. You should use it to reload any module
506 * configuration from the main configuration file.
507 * @param user The user that performed the rehash, if it was initiated by a user and that user
508 * is still connected.
510 virtual void OnRehash(User* user);
512 /** Called whenever a snotice is about to be sent to a snomask.
513 * snomask and type may both be modified; the message may not.
514 * @param snomask The snomask the message is going to (e.g. 'A')
515 * @param type The textual description the snomask will go to (e.g. 'OPER')
516 * @param message The text message to be sent via snotice
517 * @return 1 to block the snotice from being sent entirely, 0 else.
519 virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
521 /** Called whenever a user is about to join a channel, before any processing is done.
522 * Returning a value of 1 from this function stops the process immediately, causing no
523 * output to be sent to the user by the core. If you do this you must produce your own numerics,
524 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
525 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
529 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
530 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
531 * processing on the actual channel record at this point, however the channel NAME will still be passed in
532 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
533 * @param user The user joining the channel
534 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
535 * @param cname The channel name being joined. For new channels this is valid where chan is not.
536 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "o".
537 * You may alter this string to alter the user's modes on the channel.
538 * @param keygiven The key given to join the channel, or an empty string if none was provided
539 * @return 1 To prevent the join, 0 to allow it.
541 virtual ModResult OnUserPreJoin(User* user, Channel* chan, const std::string& cname, std::string& privs, const std::string& keygiven);
543 /** Called whenever a user is about to be kicked.
544 * Returning a value of 1 from this function stops the process immediately, causing no
545 * output to be sent to the user by the core. If you do this you must produce your own numerics,
547 * @param source The user issuing the kick
548 * @param memb The channel membership of the user who is being kicked.
549 * @param reason The kick reason
550 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
552 virtual ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason);
554 /** Called whenever a user is kicked.
555 * If this method is called, the kick is already underway and cannot be prevented, so
556 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
557 * @param source The user issuing the kick
558 * @param memb The channel membership of the user who was kicked.
559 * @param reason The kick reason
560 * @param except_list A list of users to not send to.
562 virtual void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except_list);
564 /** Called whenever a user opers locally.
565 * The User will contain the oper mode 'o' as this function is called after any modifications
566 * are made to the user's structure by the core.
567 * @param user The user who is opering up
568 * @param opertype The opers type name
570 virtual void OnOper(User* user, const std::string &opertype);
572 /** Called after a user opers locally.
573 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
574 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
575 * out the OPERTYPE, etc.
576 * @param user The user who is opering up
577 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
578 * @param opertype The opers type name
580 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
582 /** Called whenever a user types /INFO.
583 * The User will contain the information of the user who typed the command. Modules may use this
584 * method to output their own credits in /INFO (which is the ircd's version of an about box).
585 * It is purposefully not possible to modify any info that has already been output, or halt the list.
586 * You must write a 371 numeric to the user, containing your info in the following format:
588 * <nick> :information here
590 * @param user The user issuing /INFO
592 virtual void OnInfo(User* user);
594 /** Called whenever a /WHOIS is performed on a local user.
595 * The source parameter contains the details of the user who issued the WHOIS command, and
596 * the dest parameter contains the information of the user they are whoising.
597 * @param source The user issuing the WHOIS command
598 * @param dest The user who is being WHOISed
600 virtual void OnWhois(User* source, User* dest);
602 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
603 * Returning 1 from this function stops the process immediately, causing no
604 * output to be sent to the user by the core. If you do this you must produce your own numerics,
605 * notices etc. This is useful for modules which may want to filter invites to channels.
606 * @param source The user who is issuing the INVITE
607 * @param dest The user being invited
608 * @param channel The channel the user is being invited to
609 * @param timeout The time the invite will expire (0 == never)
610 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
612 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
614 /** Called after a user has been successfully invited to a channel.
615 * You cannot prevent the invite from occuring using this function, to do that,
616 * use OnUserPreInvite instead.
617 * @param source The user who is issuing the INVITE
618 * @param dest The user being invited
619 * @param channel The channel the user is being invited to
620 * @param timeout The time the invite will expire (0 == never)
622 virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout);
624 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
625 * Returning any nonzero value from this function stops the process immediately, causing no
626 * output to be sent to the user by the core. If you do this you must produce your own numerics,
627 * notices etc. This is useful for modules which may want to filter or redirect messages.
628 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
629 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
630 * of where the message is destined to be sent.
631 * @param user The user sending the message
632 * @param dest The target of the message (Channel* or User*)
633 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
634 * @param text Changeable text being sent by the user
635 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
636 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
637 * It will be ignored for private messages.
638 * @return 1 to deny the message, 0 to allow it
640 virtual ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
642 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
643 * Returning any nonzero value from this function stops the process immediately, causing no
644 * output to be sent to the user by the core. If you do this you must produce your own numerics,
645 * notices etc. This is useful for modules which may want to filter or redirect messages.
646 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
647 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
648 * of where the message is destined to be sent.
649 * You may alter the message text as you wish before relinquishing control to the next module
650 * in the chain, and if no other modules block the text this altered form of the text will be sent out
651 * to the user and possibly to other servers.
652 * @param user The user sending the message
653 * @param dest The target of the message (Channel* or User*)
654 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
655 * @param text Changeable text being sent by the user
656 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
657 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
658 * It will be ignored for private notices.
659 * @return 1 to deny the NOTICE, 0 to allow it
661 virtual ModResult OnUserPreNotice(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
663 /** Called when sending a message to all "neighbors" of a given user -
664 * that is, all users that share a common channel. This is used in
665 * commands such as NICK, QUIT, etc.
666 * @param source The source of the message
667 * @param include_c Channels to scan for users to include
668 * @param exceptions Map of user->bool that overrides the inclusion decision
670 * Set exceptions[user] = true to include, exceptions[user] = false to exclude
672 virtual void OnBuildNeighborList(User* source, UserChanList &include_c, std::map<User*,bool> &exceptions);
674 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
675 * Please note that although you can see remote nickchanges through this function, you should
676 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
677 * check user->server before taking any action (including returning nonzero from the method).
678 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
679 * module to generate some meaninful output.
680 * @param user The username changing their nick
681 * @param newnick Their new nickname
682 * @return 1 to deny the change, 0 to allow
684 virtual ModResult OnUserPreNick(User* user, const std::string &newnick);
686 /** Called after any PRIVMSG sent from a user.
687 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
688 * if target_type is TYPE_CHANNEL.
689 * @param user The user sending the message
690 * @param dest The target of the message
691 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
692 * @param text the text being sent by the user
693 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
694 * @param exempt_list A list of users to not send to.
696 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
698 /** Called after any NOTICE sent from a user.
699 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
700 * if target_type is TYPE_CHANNEL.
701 * @param user The user sending the message
702 * @param dest The target of the message
703 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
704 * @param text the text being sent by the user
705 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
706 * @param exempt_list A list of users to not send to.
708 virtual void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
710 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
711 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
712 * if target_type is TYPE_CHANNEL.
713 * The difference between this event and OnUserPreNotice/OnUserPreMessage is that delivery is gauranteed,
714 * the message has already been vetted. In the case of the other two methods, a later module may stop your
715 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
716 * @param user The user sending the message
717 * @param dest The target of the message
718 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
719 * @param text the text being sent by the user
720 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
721 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
723 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
725 /** Called after every MODE command sent from a user
726 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
727 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
728 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
729 * @param user The user sending the MODEs
730 * @param dest The target of the modes (User* or Channel*)
731 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
732 * @param text The actual modes and their parameters if any
733 * @param translate The translation types of the mode parameters
735 virtual void OnMode(User* user, void* dest, int target_type, const std::vector<std::string> &text, const std::vector<TranslateType> &translate);
737 /** Allows modules to alter or create server descriptions
738 * Whenever a module requires a server description, for example for display in
739 * WHOIS, this function is called in all modules. You may change or define the
740 * description given in std::string &description. If you do, this description
741 * will be shown in the WHOIS fields.
742 * @param servername The servername being searched for
743 * @param description Alterable server description for this server
745 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
747 /** Allows modules to synchronize data which relates to users during a netburst.
748 * When this function is called, it will be called from the module which implements
749 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
750 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
751 * (see below). This function will be called for every user visible on your side
752 * of the burst, allowing you to for example set modes, etc. Do not use this call to
753 * synchronize data which you have stored using class Extensible -- There is a specialist
754 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
755 * @param user The user being syncronized
756 * @param proto A pointer to the module handling network protocol
757 * @param opaque An opaque pointer set by the protocol module, should not be modified!
759 virtual void OnSyncUser(User* user, Module* proto, void* opaque);
761 /** Allows modules to synchronize data which relates to channels during a netburst.
762 * When this function is called, it will be called from the module which implements
763 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
764 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
765 * (see below). This function will be called for every user visible on your side
766 * of the burst, allowing you to for example set modes, etc.
768 * @param chan The channel being syncronized
769 * @param proto A pointer to the module handling network protocol
770 * @param opaque An opaque pointer set by the protocol module, should not be modified!
772 virtual void OnSyncChannel(Channel* chan, Module* proto, void* opaque);
774 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
775 * Whenever the linking module wants to send out data, but doesnt know what the data
776 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
777 * this method is called. You should use the ProtoSendMetaData function after you've
778 * correctly decided how the data should be represented, to send the metadata on its way if
779 * if it belongs to your module.
780 * @param proto A pointer to the module handling network protocol
781 * @param opaque An opaque pointer set by the protocol module, should not be modified!
782 * @param displayable If this value is true, the data is going to be displayed to a user,
783 * and not sent across the network. Use this to determine wether or not to show sensitive data.
785 virtual void OnSyncNetwork(Module* proto, void* opaque);
787 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
788 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
789 * @param target The Channel* or User* that data should be added to
790 * @param extname The extension name which is being sent
791 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
793 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
795 /** Implemented by modules which provide the ability to link servers.
796 * These modules will implement this method, which allows transparent sending of servermodes
797 * down the network link as a broadcast, without a module calling it having to know the format
798 * of the MODE command before the actual mode string.
800 * @param opaque An opaque pointer set by the protocol module, should not be modified!
801 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
802 * @param target The Channel* or User* that modes should be sent for
803 * @param modeline The modes and parameters to be sent
804 * @param translate The translation types of the mode parameters
806 virtual void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::vector<std::string> &modeline, const std::vector<TranslateType> &translate);
808 /** Implemented by modules which provide the ability to link servers.
809 * These modules will implement this method, which allows metadata (extra data added to
810 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
811 * to other servers on a netburst and decoded at the other end by the same module on a
814 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
815 * how to use this function.
816 * @param opaque An opaque pointer set by the protocol module, should not be modified!
817 * @param target The Channel* or User* that metadata should be sent for
818 * @param extname The extension name to send metadata for
819 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
821 virtual void ProtoSendMetaData(void* opaque, Extensible* target, const std::string &extname, const std::string &extdata);
823 /** Called after every WALLOPS command.
824 * @param user The user sending the WALLOPS
825 * @param text The content of the WALLOPS message
827 virtual void OnWallops(User* user, const std::string &text);
829 /** Called whenever a user's hostname is changed.
830 * This event triggers after the host has been set.
831 * @param user The user whos host is being changed
832 * @param newhost The new hostname being set
834 virtual void OnChangeHost(User* user, const std::string &newhost);
836 /** Called whenever a user's GECOS (realname) is changed.
837 * This event triggers after the name has been set.
838 * @param user The user who's GECOS is being changed
839 * @param gecos The new GECOS being set on the user
841 virtual void OnChangeName(User* user, const std::string &gecos);
843 /** Called whenever a user's IDENT is changed.
844 * This event triggers after the name has been set.
845 * @param user The user who's IDENT is being changed
846 * @param ident The new IDENT being set on the user
848 virtual void OnChangeIdent(User* user, const std::string &ident);
850 /** Called whenever an xline is added by a local user.
851 * This method is triggered after the line is added.
852 * @param source The sender of the line or NULL for local server
853 * @param line The xline being added
855 virtual void OnAddLine(User* source, XLine* line);
857 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
858 * This method is triggered after the line is deleted.
859 * @param source The user removing the line or NULL for local server
860 * @param line the line being deleted
862 virtual void OnDelLine(User* source, XLine* line);
864 /** Called whenever an xline expires.
865 * This method is triggered after the line is deleted.
866 * @param line The line being deleted.
868 virtual void OnExpireLine(XLine *line);
870 /** Called before your module is unloaded to clean up Extensibles.
871 * This method is called once for every user and channel on the network,
872 * so that when your module unloads it may clear up any remaining data
873 * in the form of Extensibles added using Extensible::Extend().
874 * If the target_type variable is TYPE_USER, then void* item refers to
875 * a User*, otherwise it refers to a Channel*.
876 * @param target_type The type of item being cleaned
877 * @param item A pointer to the item's class
879 virtual void OnCleanup(int target_type, void* item);
881 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
882 * have been applied. Please note that although you can see remote nickchanges through this function, you should
883 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
884 * check user->server before taking any action (including returning nonzero from the method).
885 * Because this method is called after the nickchange is taken place, no return values are possible
886 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
887 * @param user The user changing their nick
888 * @param oldnick The old nickname of the user before the nickchange
890 virtual void OnUserPostNick(User* user, const std::string &oldnick);
892 /** Called before any mode change, to allow a single access check for
893 * a full mode change (use OnRawMode to check individual modes)
895 * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
896 * OnRawMode for each individual mode
898 * @param source the user making the mode change
899 * @param dest the user destination of the umode change (NULL if a channel mode)
900 * @param channel the channel destination of the mode change
901 * @param parameters raw mode parameters; parameters[0] is the user/channel being changed
903 virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, const std::vector<std::string>& parameters);
905 /** Called when a 005 numeric is about to be output.
906 * The module should modify the 005 numeric if needed to indicate its features.
907 * @param output The 005 string to be modified if neccessary.
909 virtual void On005Numeric(std::string &output);
911 /** Called when a client is disconnected by KILL.
912 * If a client is killed by a server, e.g. a nickname collision or protocol error,
914 * Return 1 from this function to prevent the kill, and 0 from this function to allow
915 * it as normal. If you prevent the kill no output will be sent to the client, it is
916 * down to your module to generate this information.
917 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
918 * If you do so youre risking race conditions, desyncs and worse!
919 * @param source The user sending the KILL
920 * @param dest The user being killed
921 * @param reason The kill reason
922 * @return 1 to prevent the kill, 0 to allow
924 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
926 /** Called when an oper wants to disconnect a remote user via KILL
927 * @param source The user sending the KILL
928 * @param dest The user being killed
929 * @param reason The kill reason
930 * @param operreason The oper kill reason
932 virtual void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
934 /** Called whenever a module is loaded.
935 * mod will contain a pointer to the module, and string will contain its name,
936 * for example m_widgets.so. This function is primary for dependency checking,
937 * your module may decide to enable some extra features if it sees that you have
938 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
939 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
940 * but instead operate under reduced functionality, unless the dependency is
941 * absolutely neccessary (e.g. a module that extends the features of another
943 * @param mod A pointer to the new module
945 virtual void OnLoadModule(Module* mod);
947 /** Called whenever a module is unloaded.
948 * mod will contain a pointer to the module, and string will contain its name,
949 * for example m_widgets.so. This function is primary for dependency checking,
950 * your module may decide to enable some extra features if it sees that you have
951 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
952 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
953 * but instead operate under reduced functionality, unless the dependency is
954 * absolutely neccessary (e.g. a module that extends the features of another
956 * @param mod Pointer to the module being unloaded (still valid)
958 virtual void OnUnloadModule(Module* mod);
960 /** Called once every five seconds for background processing.
961 * This timer can be used to control timed features. Its period is not accurate
962 * enough to be used as a clock, but it is gauranteed to be called at least once in
963 * any five second period, directly from the main loop of the server.
964 * @param curtime The current timer derived from time(2)
966 virtual void OnBackgroundTimer(time_t curtime);
968 /** Called whenever any command is about to be executed.
969 * This event occurs for all registered commands, wether they are registered in the core,
970 * or another module, and for invalid commands. Invalid commands may only be sent to this
971 * function when the value of validated is false. By returning 1 from this method you may prevent the
972 * command being executed. If you do this, no output is created by the core, and it is
973 * down to your module to produce any output neccessary.
974 * Note that unless you return 1, you should not destroy any structures (e.g. by using
975 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
976 * method returns, it will be passed an invalid pointer to the user object and crash!)
977 * @param command The command being executed
978 * @param parameters An array of array of characters containing the parameters for the command
979 * @param user the user issuing the command
980 * @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.
981 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
982 * @param original_line The entire original line as passed to the parser from the user
983 * @return 1 to block the command, 0 to allow
985 virtual ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, LocalUser *user, bool validated, const std::string &original_line);
987 /** Called after any command has been executed.
988 * This event occurs for all registered commands, wether they are registered in the core,
989 * or another module, but it will not occur for invalid commands (e.g. ones which do not
990 * exist within the command table). The result code returned by the command handler is
992 * @param command The command being executed
993 * @param parameters An array of array of characters containing the parameters for the command
994 * @param user the user issuing the command
995 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
996 * @param original_line The entire original line as passed to the parser from the user
998 virtual void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, LocalUser *user, CmdResult result, const std::string &original_line);
1000 /** Called when a user is first connecting, prior to starting DNS lookups, checking initial
1001 * connect class, or accepting any commands.
1003 virtual void OnUserInit(LocalUser* user);
1005 /** Called to check if a user who is connecting can now be allowed to register
1006 * If any modules return false for this function, the user is held in the waiting
1007 * state until all modules return true. For example a module which implements ident
1008 * lookups will continue to return false for a user until their ident lookup is completed.
1009 * Note that the registration timeout for a user overrides these checks, if the registration
1010 * timeout is reached, the user is disconnected even if modules report that the user is
1011 * not ready to connect.
1012 * @param user The user to check
1013 * @return true to indicate readiness, false if otherwise
1015 virtual ModResult OnCheckReady(LocalUser* user);
1017 /** Called whenever a user is about to register their connection (e.g. before the user
1018 * is sent the MOTD etc). Modules can use this method if they are performing a function
1019 * which must be done before the actual connection is completed (e.g. ident lookups,
1020 * dnsbl lookups, etc).
1021 * Note that you should NOT delete the user record here by causing a disconnection!
1022 * Use OnUserConnect for that instead.
1023 * @param user The user registering
1024 * @return 1 to indicate user quit, 0 to continue
1026 virtual ModResult OnUserRegister(LocalUser* user);
1028 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1029 * This method will always be called for each join, wether or not the channel is actually +i, and
1030 * determines the outcome of an if statement around the whole section of invite checking code.
1031 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1032 * @param user The user joining the channel
1033 * @param chan The channel being joined
1034 * @return 1 to explicitly allow the join, 0 to proceed as normal
1036 virtual ModResult OnCheckInvite(User* user, Channel* chan);
1038 /** Called whenever a mode character is processed.
1039 * Return 1 from this function to block the mode character from being processed entirely.
1040 * @param user The user who is sending the mode
1041 * @param chan The channel the mode is being sent to (or NULL if a usermode)
1042 * @param mode The mode character being set
1043 * @param param The parameter for the mode or an empty string
1044 * @param adding true of the mode is being added, false if it is being removed
1045 * @param pcnt The parameter count for the mode (0 or 1)
1046 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
1047 * to skip all permission checking. Please note that for remote mode changes, your return value
1050 virtual ModResult OnRawMode(User* user, Channel* chan, const char mode, const std::string ¶m, bool adding, int pcnt);
1052 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1053 * This method will always be called for each join, wether or not the channel is actually +k, and
1054 * determines the outcome of an if statement around the whole section of key checking code.
1055 * if the user specified no key, the keygiven string will be a valid but empty value.
1056 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1057 * @param user The user joining the channel
1058 * @param chan The channel being joined
1059 * @param keygiven The key given on joining the channel.
1060 * @return 1 to explicitly allow the join, 0 to proceed as normal
1062 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
1064 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1065 * This method will always be called for each join, wether or not the channel is actually +l, and
1066 * determines the outcome of an if statement around the whole section of channel limit checking code.
1067 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1068 * @param user The user joining the channel
1069 * @param chan The channel being joined
1070 * @return 1 to explicitly allow the join, 0 to proceed as normal
1072 virtual ModResult OnCheckLimit(User* user, Channel* chan);
1075 * Checks for a user's ban from the channel
1076 * @param user The user to check
1077 * @param chan The channel to check in
1078 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1079 * ban check, or MOD_RES_PASSTHRU to check bans normally
1081 virtual ModResult OnCheckChannelBan(User* user, Channel* chan);
1084 * Checks for a user's match of a single ban
1085 * @param user The user to check for match
1086 * @param chan The channel on which the match is being checked
1087 * @param mask The mask being checked
1088 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1089 * ban check, or MOD_RES_PASSTHRU to check bans normally
1091 virtual ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask);
1093 /** Checks for a match on a given extban type
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 OnExtBanCheck(User* user, Channel* chan, char type);
1099 /** Called on all /STATS commands
1100 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1101 * @param symbol the symbol provided to /STATS
1102 * @param user the user issuing the /STATS command
1103 * @param results A string_list to append results into. You should put all your results
1104 * into this string_list, rather than displaying them directly, so that your handler will
1105 * work when remote STATS queries are received.
1106 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1108 virtual ModResult OnStats(char symbol, User* user, string_list &results);
1110 /** Called whenever a change of a local users displayed host is attempted.
1111 * Return 1 to deny the host change, or 0 to allow it.
1112 * @param user The user whos host will be changed
1113 * @param newhost The new hostname
1114 * @return 1 to deny the host change, 0 to allow
1116 virtual ModResult OnChangeLocalUserHost(LocalUser* user, const std::string &newhost);
1118 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1119 * return 1 to deny the name change, or 0 to allow it.
1120 * @param user The user whos GECOS will be changed
1121 * @param newhost The new GECOS
1122 * @return 1 to deny the GECOS change, 0 to allow
1124 virtual ModResult OnChangeLocalUserGECOS(LocalUser* user, const std::string &newhost);
1126 /** Called before a topic is changed.
1127 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
1128 * As with other 'pre' events, you should only ever block a local event.
1129 * @param user The user changing the topic
1130 * @param chan The channels who's topic is being changed
1131 * @param topic The actual topic text
1132 * @return 1 to block the topic change, 0 to allow
1134 virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
1136 /** Called whenever a topic has been changed.
1137 * To block topic changes you must use OnPreTopicChange instead.
1138 * @param user The user changing the topic
1139 * @param chan The channels who's topic is being changed
1140 * @param topic The actual topic text
1142 virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
1144 /** Called whenever an Event class is sent to all modules by another module.
1145 * You should *always* check the value of Event::id to determine the event type.
1146 * @param event The Event class being received
1148 virtual void OnEvent(Event& event);
1150 /** Called whenever a Request class is sent to your module by another module.
1151 * The value of Request::id should be used to determine the type of request.
1152 * @param request The Request class being received
1154 virtual void OnRequest(Request& request);
1156 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
1157 * The password field (from the config file) is in 'password' and is to be compared against
1158 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
1159 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
1160 * @param ex The object that's causing the authentication (User* for \<oper> \<connect:allow> etc, Server* for \<link>).
1161 * @param password The password from the configuration file (the password="" value).
1162 * @param input The password entered by the user or whoever.
1163 * @param hashtype The hash value from the config
1164 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
1166 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
1168 /** Called whenever a user is given usermode +o, anywhere on the network.
1169 * You cannot override this and prevent it from happening as it is already happened and
1170 * such a task must be performed by another server. You can however bounce modes by sending
1171 * servermodes out to reverse mode changes.
1172 * @param user The user who is opering
1174 virtual void OnGlobalOper(User* user);
1176 /** Called after a user has fully connected and all modules have executed OnUserConnect
1177 * This event is informational only. You should not change any user information in this
1178 * event. To do so, use the OnUserConnect method to change the state of local users.
1179 * This is called for both local and remote users.
1180 * @param user The user who is connecting
1182 virtual void OnPostConnect(User* user);
1184 /** Called to install an I/O hook on an event handler
1185 * @param user The socket to possibly install the I/O hook on
1186 * @param via The port that the user connected on
1188 virtual void OnHookIO(StreamSocket* user, ListenSocket* via);
1190 /** Called when a port accepts a connection
1191 * Return MOD_RES_ACCEPT if you have used the file descriptor.
1192 * @param fd The file descriptor returned from accept()
1193 * @param sock The socket connection for the new user
1194 * @param client The client IP address and port
1195 * @param server The server IP address and port
1197 virtual ModResult OnAcceptConnection(int fd, ListenSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
1199 /** Called immediately after any connection is accepted. This is intended for raw socket
1200 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1201 * no information relating to a user record as the connection has not been assigned yet.
1202 * There are no return values from this call as all modules get an opportunity if required to
1203 * process the connection.
1204 * @param sock The socket in question
1205 * @param client The client IP address and port
1206 * @param server The server IP address and port
1208 virtual void OnStreamSocketAccept(StreamSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
1211 * Called when a hooked stream has data to write, or when the socket
1212 * engine returns it as writable
1213 * @param sock The socket in question
1214 * @param sendq Data to send to the socket
1215 * @return 1 if the sendq has been completely emptied, 0 if there is
1216 * still data to send, and -1 if there was an error
1218 virtual int OnStreamSocketWrite(StreamSocket* sock, std::string& sendq);
1220 /** Called immediately before any socket is closed. When this event is called, shutdown()
1221 * has not yet been called on the socket.
1222 * @param sock The socket in question
1224 virtual void OnStreamSocketClose(StreamSocket* sock);
1226 /** Called immediately upon connection of an outbound BufferedSocket which has been hooked
1228 * @param sock The socket in question
1230 virtual void OnStreamSocketConnect(StreamSocket* sock);
1233 * Called when the stream socket has data to read
1234 * @param sock The socket that is ready
1235 * @param recvq The receive queue that new data should be appended to
1236 * @return 1 if new data has been read, 0 if no new data is ready (but the
1237 * socket is still connected), -1 if there was an error or close
1239 virtual int OnStreamSocketRead(StreamSocket* sock, std::string& recvq);
1241 /** Called whenever a user sets away or returns from being away.
1242 * The away message is available as a parameter, but should not be modified.
1243 * At this stage, it has already been copied into the user record.
1244 * If awaymsg is empty, the user is returning from away.
1245 * @param user The user setting away
1246 * @param awaymsg The away message of the user, or empty if returning from away
1247 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
1249 virtual ModResult OnSetAway(User* user, const std::string &awaymsg);
1251 /** Called whenever a line of WHOIS output is sent to a user.
1252 * You may change the numeric and the text of the output by changing
1253 * the values numeric and text, but you cannot change the user the
1254 * numeric is sent to. You may however change the user's User values.
1255 * @param user The user the numeric is being sent to
1256 * @param dest The user being WHOISed
1257 * @param numeric The numeric of the line being sent
1258 * @param text The text of the numeric, including any parameters
1259 * @return nonzero to drop the line completely so that the user does not
1260 * receive it, or zero to allow the line to be sent.
1262 virtual ModResult OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
1264 /** Called at intervals for modules to garbage-collect any hashes etc.
1265 * Certain data types such as hash_map 'leak' buckets, which must be
1266 * tidied up and freed by copying into a new item every so often. This
1267 * method is called when it is time to do that.
1269 virtual void OnGarbageCollect();
1271 /** Called when a user's connect class is being matched
1272 * @return MOD_RES_ALLOW to force the class to match, MOD_RES_DENY to forbid it, or
1273 * MOD_RES_PASSTHRU to allow normal matching (by host/port).
1275 virtual ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass);
1277 /** Add test suite hooks here. These are used for testing functionality of a module
1278 * via the --testsuite debugging parameter.
1280 virtual void OnRunTestSuite();
1282 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
1283 * For example NAMESX, channel mode +u and +I, and UHNAMES. If the nick is set to an empty string by any
1284 * module, then this will cause the nickname not to be displayed at all.
1286 virtual void OnNamesListItem(User* issuer, Membership* item, std::string &prefixes, std::string &nick);
1288 virtual ModResult OnNumeric(User* user, unsigned int numeric, const std::string &text);
1290 /** Called whenever a result from /WHO is about to be returned
1291 * @param source The user running the /WHO query
1292 * @param params The parameters to the /WHO query
1293 * @param user The user that this line of the query is about
1294 * @param line The raw line to send; modifiable, if empty no line will be returned.
1296 virtual void OnSendWhoLine(User* source, const std::vector<std::string>& params, User* user, std::string& line);
1298 /** Called whenever a local user's IP is set for the first time, or when a local user's IP changes due to
1299 * a module like m_cgiirc changing it.
1300 * @param user The user whose IP is being set
1302 virtual void OnSetUserIP(LocalUser* user);
1305 /** Caches a text file into memory and can be used to retrieve lines from it.
1306 * This class contains methods for read-only manipulation of a text file in memory.
1307 * Either use the constructor type with one parameter to load a file into memory
1308 * at construction, or use the LoadFile method to load a file.
1310 class CoreExport FileReader : public classbase
1312 /** The file contents
1314 std::vector<std::string> fc;
1316 /** Content size in bytes
1318 unsigned long contentsize;
1320 /** Calculate content size in bytes
1325 /** Default constructor.
1326 * This method does not load any file into memory, you must use the LoadFile method
1327 * after constructing the class this way.
1331 /** Secondary constructor.
1332 * This method initialises the class with a file loaded into it ready for GetLine and
1333 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1336 FileReader(const std::string &filename);
1338 /** Default destructor.
1339 * This deletes the memory allocated to the file.
1343 /** Used to load a file.
1344 * This method loads a file into the class ready for GetLine and
1345 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1348 void LoadFile(const std::string &filename);
1350 /** Returns the whole content of the file as std::string
1352 std::string Contents();
1354 /** Returns the entire size of the file as std::string
1356 unsigned long ContentSize();
1358 /** Returns true if the file exists
1359 * This function will return false if the file could not be opened.
1363 /** Retrieve one line from the file.
1364 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1365 * the index was out of bounds, or the line had no data on it.
1367 std::string GetLine(int x);
1369 /** Returns the size of the file in lines.
1370 * This method returns the number of lines in the read file. If it is 0, no lines have been
1371 * read into memory, either because the file is empty or it does not exist, or cannot be
1372 * opened due to permission problems.
1377 /** A list of modules
1379 typedef std::vector<Module*> IntModuleList;
1381 /** An event handler iterator
1383 typedef IntModuleList::iterator EventHandlerIter;
1385 /** ModuleManager takes care of all things module-related
1388 class CoreExport ModuleManager
1391 /** Holds a string describing the last module error to occur
1393 std::string LastModuleError;
1395 /** Total number of modules loaded into the ircd
1399 /** List of loaded modules and shared object/dll handles
1400 * keyed by module name
1402 std::map<std::string, Module*> Modules;
1408 } prioritizationState;
1410 /** Internal unload module hook */
1411 bool CanUnload(Module*);
1414 /** Event handler hooks.
1415 * This needs to be public to be used by FOREACH_MOD and friends.
1417 IntModuleList EventHandlers[I_END];
1419 /** List of data services keyed by name */
1420 std::multimap<std::string, ServiceProvider*> DataProviders;
1422 /** Simple, bog-standard, boring constructor.
1430 /** Change the priority of one event in a module.
1431 * Each module event has a list of modules which are attached to that event type.
1432 * If you wish to be called before or after other specific modules, you may use this
1433 * method (usually within void Module::Prioritize()) to set your events priority.
1434 * You may use this call in other methods too, however, this is not supported behaviour
1436 * @param mod The module to change the priority of
1437 * @param i The event to change the priority of
1438 * @param s The state you wish to use for this event. Use one of
1439 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1440 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1441 * to set it to be before or after one or more other modules.
1442 * @param which If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1443 * then this contains a the module that your module must be placed before
1446 bool SetPriority(Module* mod, Implementation i, Priority s, Module* which = NULL);
1448 /** Backwards compat interface */
1449 inline bool SetPriority(Module* mod, Implementation i, Priority s, Module** dptr)
1451 return SetPriority(mod, i, s, *dptr);
1454 /** Change the priority of all events in a module.
1455 * @param mod The module to set the priority of
1456 * @param s The priority of all events in the module.
1457 * Note that with this method, it is not possible to effectively use
1458 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1459 * SetPriority method for this, where you may specify other modules to
1460 * be prioritized against.
1462 bool SetPriority(Module* mod, Priority s);
1464 /** Attach an event to a module.
1465 * You may later detatch the event with ModuleManager::Detach().
1466 * If your module is unloaded, all events are automatically detatched.
1467 * @param i Event type to attach
1468 * @param mod Module to attach event to
1469 * @return True if the event was attached
1471 bool Attach(Implementation i, Module* mod);
1473 /** Detatch an event from a module.
1474 * This is not required when your module unloads, as the core will
1475 * automatically detatch your module from all events it is attached to.
1476 * @param i Event type to detach
1477 * @param mod Module to detach event from
1478 * @return True if the event was detached
1480 bool Detach(Implementation i, Module* mod);
1482 /** Attach an array of events to a module
1483 * @param i Event types (array) to attach
1484 * @param mod Module to attach events to
1485 * @param sz The size of the implementation array
1487 void Attach(Implementation* i, Module* mod, size_t sz);
1489 /** Detach all events from a module (used on unload)
1490 * @param mod Module to detach from
1492 void DetachAll(Module* mod);
1494 /** Returns text describing the last module error
1495 * @return The last error message to occur
1497 std::string& LastError();
1499 /** Load a given module file
1500 * @param filename The file to load
1501 * @param defer Defer module init (loading many modules)
1502 * @return True if the module was found and loaded
1504 bool Load(const std::string& filename, bool defer = false);
1506 /** Unload a given module file. Note that the module will not be
1507 * completely gone until the cull list has finished processing.
1509 * @return true on success; if false, LastError will give a reason
1511 bool Unload(Module* module);
1513 /** Run an asynchronous reload of the given module. When the reload is
1514 * complete, the callback will be run with true if the reload succeeded
1515 * and false if it did not.
1517 void Reload(Module* module, HandlerBase1<void, bool>* callback);
1519 /** Called by the InspIRCd constructor to load all modules from the config file.
1523 void DoSafeUnload(Module*);
1525 /** Get the total number of currently loaded modules
1526 * @return The number of loaded modules
1530 return this->ModCount;
1533 /** Find a module by name, and return a Module* to it.
1534 * This is preferred over iterating the module lists yourself.
1535 * @param name The module name to look up
1536 * @return A pointer to the module, or NULL if the module cannot be found
1538 Module* Find(const std::string &name);
1540 /** Register a service provided by a module */
1541 void AddService(ServiceProvider&);
1543 /** Unregister a service provided by a module */
1544 void DelService(ServiceProvider&);
1546 inline void AddServices(ServiceProvider** list, int count)
1548 for(int i=0; i < count; i++)
1549 AddService(*list[i]);
1552 /** Find a service by name.
1553 * If multiple modules provide a given service, the first one loaded will be chosen.
1555 ServiceProvider* FindService(ServiceType Type, const std::string& name);
1557 template<typename T> inline T* FindDataService(const std::string& name)
1559 return static_cast<T*>(FindService(SERVICE_DATA, name));
1562 /** Return a list of all modules matching the given filter
1563 * @param filter This int is a bitmask of flags set in Module::Flags,
1564 * such as VF_VENDOR or VF_STATIC. If you wish to receive a list of
1565 * all modules with no filtering, set this to 0.
1566 * @return The list of module names
1568 const std::vector<std::string> GetAllModuleNames(int filter);
1571 /** Do not mess with these functions unless you know the C preprocessor
1572 * well enough to explain why they are needed. The order is important.
1574 #define MODULE_INIT_STR MODULE_INIT_STR_FN_2(MODULE_INIT_SYM)
1575 #define MODULE_INIT_STR_FN_2(x) MODULE_INIT_STR_FN_1(x)
1576 #define MODULE_INIT_STR_FN_1(x) #x
1577 #define MODULE_INIT_SYM MODULE_INIT_SYM_FN_2(INSPIRCD_VERSION_MAJ, INSPIRCD_VERSION_API)
1578 #define MODULE_INIT_SYM_FN_2(x,y) MODULE_INIT_SYM_FN_1(x,y)
1579 #define MODULE_INIT_SYM_FN_1(x,y) inspircd_module_ ## x ## _ ## y
1583 struct AllCommandList {
1584 typedef Command* (*fn)(Module*);
1585 AllCommandList(fn cmd);
1587 #define COMMAND_INIT(x) static Command* MK_ ## x(Module* m) { return new x(m); } \
1588 static const AllCommandList PREP_ ## x(&MK_ ## x);
1590 struct AllModuleList {
1591 typedef Module* (*fn)();
1594 AllModuleList(fn mod, const std::string& Name);
1597 #define MODULE_INIT(x) static Module* MK_ ## x() { return new x; } \
1598 static const AllModuleList PREP_ ## x(&MK_ ## x, MODNAMESTR);
1600 #define MODNAMESTR MODNAMESTR_FN_2(MODNAME)
1601 #define MODNAMESTR_FN_2(x) MODNAMESTR_FN_1(x)
1602 #define MODNAMESTR_FN_1(x) #x
1606 /** This definition is used as shorthand for the various classes
1607 * and functions needed to make a module loadable by the OS.
1608 * It defines the class factory and external init_module function.
1612 #define MODULE_INIT(y) \
1613 extern "C" DllExport Module * MODULE_INIT_SYM() \
1617 BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
1619 switch ( nReason ) \
1621 case DLL_PROCESS_ATTACH: \
1622 case DLL_PROCESS_DETACH: \
1630 #define MODULE_INIT(y) \
1631 extern "C" DllExport Module * MODULE_INIT_SYM() \
1635 extern "C" const char inspircd_src_version[] = VERSION " r" REVISION;
1638 #define COMMAND_INIT(c) MODULE_INIT(CommandModule<c>)