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