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 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
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,
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 /** Default constructor.
361 * Creates a module class. Don't do any type of hook registration or checks
362 * for other modules here; do that in init().
367 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
369 virtual void init() {}
371 /** Clean up prior to destruction
372 * If you override, you must call this AFTER your module's cleanup
374 virtual CullResult cull();
376 /** Default destructor.
377 * destroys a module class
381 virtual void Prioritize()
385 /** Returns the version number of a Module.
386 * The method should return a Version object with its version information assigned via
389 virtual Version GetVersion() = 0;
391 /** Called when a user connects.
392 * The details of the connecting user are available to you in the parameter User *user
393 * @param user The user who is connecting
395 virtual void OnUserConnect(LocalUser* user);
397 /** Called when a user quits.
398 * The details of the exiting user are available to you in the parameter User *user
399 * This event is only called when the user is fully registered when they quit. To catch
400 * raw disconnections, use the OnUserDisconnect method.
401 * @param user The user who is quitting
402 * @param message The user's quit message (as seen by non-opers)
403 * @param oper_message The user's quit message (as seen by opers)
405 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
407 /** Called whenever a user's socket is closed.
408 * The details of the exiting user are available to you in the parameter User *user
409 * This event is called for all users, registered or not, as a cleanup method for modules
410 * which might assign resources to user, such as dns lookups, objects and sockets.
411 * @param user The user who is disconnecting
413 virtual void OnUserDisconnect(LocalUser* user);
415 /** Called whenever a channel is about to be deleted
416 * @param chan The channel being deleted
417 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
419 virtual ModResult OnChannelPreDelete(Channel *chan);
421 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
422 * @param chan The channel being deleted
424 virtual void OnChannelDelete(Channel* chan);
426 /** Called when a user joins a channel.
427 * The details of the joining user are available to you in the parameter User *user,
428 * and the details of the channel they have joined is available in the variable Channel *channel
429 * @param memb The channel membership being created
430 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
431 * to a channel due to the network sync.
432 * @param created This is true if the join created the channel
434 virtual void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list);
436 /** Called after a user joins a channel
437 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
439 * @param memb The channel membership created
441 virtual void OnPostJoin(Membership*);
443 /** Called when a user parts a channel.
444 * The details of the leaving user are available to you in the parameter User *user,
445 * and the details of the channel they have left is available in the variable Channel *channel
446 * @param memb The channel membership being destroyed
447 * @param partmessage The part message, or an empty string (may be modified)
449 virtual void OnUserPart(Membership* memb, std::string &partmessage, CUList& except_list);
451 /** Called on rehash.
452 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
453 * system. This is called in all cases -- including when this server will not execute the
454 * rehash because it is directed at a remote server.
456 * @param user The user performing the rehash, if any. If this is server initiated, the value of
457 * this variable will be NULL.
458 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
461 virtual void OnPreRehash(User* user, const std::string ¶meter);
463 /** Called on rehash.
464 * This method is called when a user initiates a module-specific rehash. This can be used to do
465 * expensive operations (such as reloading SSL certificates) that are not executed on a normal
466 * rehash for efficiency. A rehash of this type does not reload the core configuration.
468 * @param user The user performing the rehash.
469 * @param parameter The parameter given to REHASH
471 virtual void OnModuleRehash(User* user, const std::string ¶meter);
473 /** Called on rehash.
474 * This method is called after a rehash has completed. You should use it to reload any module
475 * configuration from the main configuration file.
476 * @param user The user that performed the rehash, if it was initiated by a user and that user
477 * is still connected.
479 virtual void OnRehash(User* user);
481 /** Called whenever a snotice is about to be sent to a snomask.
482 * snomask and type may both be modified; the message may not.
483 * @param snomask The snomask the message is going to (e.g. 'A')
484 * @param type The textual description the snomask will go to (e.g. 'OPER')
485 * @param message The text message to be sent via snotice
486 * @return 1 to block the snotice from being sent entirely, 0 else.
488 virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
490 /** Called whenever a user is about to join a channel, before any processing is done.
491 * Returning a value of 1 from this function stops the process immediately, causing no
492 * output to be sent to the user by the core. If you do this you must produce your own numerics,
493 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
494 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
498 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
499 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
500 * processing on the actual channel record at this point, however the channel NAME will still be passed in
501 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
502 * @param user The user joining the channel
503 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
504 * @param cname The channel name being joined. For new channels this is valid where chan is not.
505 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "o".
506 * You may alter this string to alter the user's modes on the channel.
507 * @param keygiven The key given to join the channel, or an empty string if none was provided
508 * @return 1 To prevent the join, 0 to allow it.
510 virtual ModResult OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string &privs, const std::string &keygiven);
512 /** Called whenever a user is about to be kicked.
513 * Returning a value of 1 from this function stops the process immediately, causing no
514 * output to be sent to the user by the core. If you do this you must produce your own numerics,
516 * @param source The user issuing the kick
517 * @param user The user being kicked
518 * @param chan The channel the user is being kicked from
519 * @param reason The kick reason
520 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
522 virtual ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason);
524 /** Called whenever a user is kicked.
525 * If this method is called, the kick is already underway and cannot be prevented, so
526 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
527 * @param source The user issuing the kick
528 * @param user The user being kicked
529 * @param chan The channel the user is being kicked from
530 * @param reason The kick reason
532 virtual void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except_list);
534 /** Called whenever a user opers locally.
535 * The User will contain the oper mode 'o' as this function is called after any modifications
536 * are made to the user's structure by the core.
537 * @param user The user who is opering up
538 * @param opertype The opers type name
540 virtual void OnOper(User* user, const std::string &opertype);
542 /** Called after a user opers locally.
543 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
544 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
545 * out the OPERTYPE, etc.
546 * @param user The user who is opering up
547 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
548 * @param opertype The opers type name
550 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
552 /** Called whenever a user types /INFO.
553 * The User will contain the information of the user who typed the command. Modules may use this
554 * method to output their own credits in /INFO (which is the ircd's version of an about box).
555 * It is purposefully not possible to modify any info that has already been output, or halt the list.
556 * You must write a 371 numeric to the user, containing your info in the following format:
558 * <nick> :information here
560 * @param user The user issuing /INFO
562 virtual void OnInfo(User* user);
564 /** Called whenever a /WHOIS is performed on a local user.
565 * The source parameter contains the details of the user who issued the WHOIS command, and
566 * the dest parameter contains the information of the user they are whoising.
567 * @param source The user issuing the WHOIS command
568 * @param dest The user who is being WHOISed
570 virtual void OnWhois(User* source, User* dest);
572 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
573 * Returning 1 from this function stops the process immediately, causing no
574 * output to be sent to the user by the core. If you do this you must produce your own numerics,
575 * notices etc. This is useful for modules which may want to filter invites to channels.
576 * @param source The user who is issuing the INVITE
577 * @param dest The user being invited
578 * @param channel The channel the user is being invited to
579 * @param timeout The time the invite will expire (0 == never)
580 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
582 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
584 /** Called after a user has been successfully invited to a channel.
585 * You cannot prevent the invite from occuring using this function, to do that,
586 * use OnUserPreInvite instead.
587 * @param source The user who is issuing the INVITE
588 * @param dest The user being invited
589 * @param channel The channel the user is being invited to
590 * @param timeout The time the invite will expire (0 == never)
592 virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout);
594 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
595 * Returning any nonzero value from this function stops the process immediately, causing no
596 * output to be sent to the user by the core. If you do this you must produce your own numerics,
597 * notices etc. This is useful for modules which may want to filter or redirect messages.
598 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
599 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
600 * of where the message is destined to be sent.
601 * @param user The user sending the message
602 * @param dest The target of the message (Channel* or User*)
603 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
604 * @param text Changeable text being sent by the user
605 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
606 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
607 * It will be ignored for private messages.
608 * @return 1 to deny the message, 0 to allow it
610 virtual ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
612 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
613 * Returning any nonzero value from this function stops the process immediately, causing no
614 * output to be sent to the user by the core. If you do this you must produce your own numerics,
615 * notices etc. This is useful for modules which may want to filter or redirect messages.
616 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
617 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
618 * of where the message is destined to be sent.
619 * You may alter the message text as you wish before relinquishing control to the next module
620 * in the chain, and if no other modules block the text this altered form of the text will be sent out
621 * to the user and possibly to other servers.
622 * @param user The user sending the message
623 * @param dest The target of the message (Channel* or User*)
624 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
625 * @param text Changeable text being sent by the user
626 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
627 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
628 * It will be ignored for private notices.
629 * @return 1 to deny the NOTICE, 0 to allow it
631 virtual ModResult OnUserPreNotice(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
633 /** Called when sending a message to all "neighbors" of a given user -
634 * that is, all users that share a common channel. This is used in
635 * commands such as NICK, QUIT, etc.
636 * @param source The source of the message
637 * @param include_c Channels to scan for users to include
638 * @param exceptions Map of user->bool that overrides the inclusion decision
640 * Set exceptions[user] = true to include, exceptions[user] = false to exclude
642 virtual void OnBuildNeighborList(User* source, UserChanList &include_c, std::map<User*,bool> &exceptions);
644 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
645 * Please note that although you can see remote nickchanges through this function, you should
646 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
647 * check user->server before taking any action (including returning nonzero from the method).
648 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
649 * module to generate some meaninful output.
650 * @param user The username changing their nick
651 * @param newnick Their new nickname
652 * @return 1 to deny the change, 0 to allow
654 virtual ModResult OnUserPreNick(User* user, const std::string &newnick);
656 /** Called after any PRIVMSG sent from a user.
657 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
658 * if target_type is TYPE_CHANNEL.
659 * @param user The user sending the message
660 * @param dest The target of the message
661 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
662 * @param text the text being sent by the user
663 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
665 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
667 /** Called after any NOTICE sent from a user.
668 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
669 * if target_type is TYPE_CHANNEL.
670 * @param user The user sending the message
671 * @param dest The target of the message
672 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
673 * @param text the text being sent by the user
674 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
676 virtual void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
678 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
679 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
680 * if target_type is TYPE_CHANNEL.
681 * The difference between this event and OnUserPreNotice/OnUserPreMessage is that delivery is gauranteed,
682 * the message has already been vetted. In the case of the other two methods, a later module may stop your
683 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
684 * @param user The user sending the message
685 * @param dest The target of the message
686 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
687 * @param text the text being sent by the user
688 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
690 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
692 /** Called after every MODE command sent from a user
693 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
694 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
695 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
696 * @param user The user sending the MODEs
697 * @param dest The target of the modes (User* or Channel*)
698 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
699 * @param text The actual modes and their parameters if any
700 * @param translate The translation types of the mode parameters
702 virtual void OnMode(User* user, void* dest, int target_type, const std::vector<std::string> &text, const std::vector<TranslateType> &translate);
704 /** Allows modules to alter or create server descriptions
705 * Whenever a module requires a server description, for example for display in
706 * WHOIS, this function is called in all modules. You may change or define the
707 * description given in std::string &description. If you do, this description
708 * will be shown in the WHOIS fields.
709 * @param servername The servername being searched for
710 * @param description Alterable server description for this server
712 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
714 /** Allows modules to synchronize data which relates to users during a netburst.
715 * When this function is called, it will be called from the module which implements
716 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
717 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
718 * (see below). This function will be called for every user visible on your side
719 * of the burst, allowing you to for example set modes, etc. Do not use this call to
720 * synchronize data which you have stored using class Extensible -- There is a specialist
721 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
722 * @param user The user being syncronized
723 * @param proto A pointer to the module handling network protocol
724 * @param opaque An opaque pointer set by the protocol module, should not be modified!
726 virtual void OnSyncUser(User* user, Module* proto, void* opaque);
728 /** Allows modules to synchronize data which relates to channels during a netburst.
729 * When this function is called, it will be called from the module which implements
730 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
731 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
732 * (see below). This function will be called for every user visible on your side
733 * of the burst, allowing you to for example set modes, etc.
735 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
737 * @param chan The channel being syncronized
738 * @param proto A pointer to the module handling network protocol
739 * @param opaque An opaque pointer set by the protocol module, should not be modified!
741 virtual void OnSyncChannel(Channel* chan, Module* proto, void* opaque);
743 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
744 * Whenever the linking module wants to send out data, but doesnt know what the data
745 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
746 * this method is called. You should use the ProtoSendMetaData function after you've
747 * correctly decided how the data should be represented, to send the metadata on its way if
748 * if it belongs to your module.
749 * @param proto A pointer to the module handling network protocol
750 * @param opaque An opaque pointer set by the protocol module, should not be modified!
751 * @param displayable If this value is true, the data is going to be displayed to a user,
752 * and not sent across the network. Use this to determine wether or not to show sensitive data.
754 virtual void OnSyncNetwork(Module* proto, void* opaque);
756 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
757 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
758 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
759 * @param target The Channel* or User* that data should be added to
760 * @param extname The extension name which is being sent
761 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
763 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
765 /** Implemented by modules which provide the ability to link servers.
766 * These modules will implement this method, which allows transparent sending of servermodes
767 * down the network link as a broadcast, without a module calling it having to know the format
768 * of the MODE command before the actual mode string.
770 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
771 * of how to use this function.
773 * @param opaque An opaque pointer set by the protocol module, should not be modified!
774 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
775 * @param target The Channel* or User* that modes should be sent for
776 * @param modeline The modes and parameters to be sent
777 * @param translate The translation types of the mode parameters
779 virtual void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::vector<std::string> &modeline, const std::vector<TranslateType> &translate);
781 /** Implemented by modules which provide the ability to link servers.
782 * These modules will implement this method, which allows metadata (extra data added to
783 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
784 * to other servers on a netburst and decoded at the other end by the same module on a
787 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
788 * how to use this function.
789 * @param opaque An opaque pointer set by the protocol module, should not be modified!
790 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
791 * @param target The Channel* or User* that metadata should be sent for
792 * @param extname The extension name to send metadata for
793 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
795 virtual void ProtoSendMetaData(void* opaque, Extensible* target, const std::string &extname, const std::string &extdata);
797 /** Called after every WALLOPS command.
798 * @param user The user sending the WALLOPS
799 * @param text The content of the WALLOPS message
801 virtual void OnWallops(User* user, const std::string &text);
803 /** Called whenever a user's hostname is changed.
804 * This event triggers after the host has been set.
805 * @param user The user whos host is being changed
806 * @param newhost The new hostname being set
808 virtual void OnChangeHost(User* user, const std::string &newhost);
810 /** Called whenever a user's GECOS (realname) is changed.
811 * This event triggers after the name has been set.
812 * @param user The user who's GECOS is being changed
813 * @param gecos The new GECOS being set on the user
815 virtual void OnChangeName(User* user, const std::string &gecos);
817 /** Called whenever a user's IDENT is changed.
818 * This event triggers after the name has been set.
819 * @param user The user who's IDENT is being changed
820 * @param gecos The new IDENT being set on the user
822 virtual void OnChangeIdent(User* user, const std::string &ident);
824 /** Called whenever an xline is added by a local user.
825 * This method is triggered after the line is added.
826 * @param source The sender of the line or NULL for local server
827 * @param line The xline being added
829 virtual void OnAddLine(User* source, XLine* line);
831 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
832 * This method is triggered after the line is deleted.
833 * @param source The user removing the line or NULL for local server
834 * @param line the line being deleted
836 virtual void OnDelLine(User* source, XLine* line);
838 /** Called whenever an xline expires.
839 * This method is triggered after the line is deleted.
840 * @param line The line being deleted.
842 virtual void OnExpireLine(XLine *line);
844 /** Called before your module is unloaded to clean up Extensibles.
845 * This method is called once for every user and channel on the network,
846 * so that when your module unloads it may clear up any remaining data
847 * in the form of Extensibles added using Extensible::Extend().
848 * If the target_type variable is TYPE_USER, then void* item refers to
849 * a User*, otherwise it refers to a Channel*.
850 * @param target_type The type of item being cleaned
851 * @param item A pointer to the item's class
853 virtual void OnCleanup(int target_type, void* item);
855 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
856 * have been applied. Please note that although you can see remote nickchanges through this function, you should
857 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
858 * check user->server before taking any action (including returning nonzero from the method).
859 * Because this method is called after the nickchange is taken place, no return values are possible
860 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
861 * @param user The user changing their nick
862 * @param oldnick The old nickname of the user before the nickchange
864 virtual void OnUserPostNick(User* user, const std::string &oldnick);
866 /** Called before any mode change, to allow a single access check for
867 * a full mode change (use OnRawMode to check individual modes)
869 * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
870 * OnRawMode for each individual mode
872 * @param source the user making the mode change
873 * @param dest the user destination of the umode change (NULL if a channel mode)
874 * @param channel the channel destination of the mode change
875 * @param parameters raw mode parameters; parameters[0] is the user/channel being changed
877 virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, const std::vector<std::string>& parameters);
879 /** Called when a 005 numeric is about to be output.
880 * The module should modify the 005 numeric if needed to indicate its features.
881 * @param output The 005 string to be modified if neccessary.
883 virtual void On005Numeric(std::string &output);
885 /** Called when a client is disconnected by KILL.
886 * If a client is killed by a server, e.g. a nickname collision or protocol error,
888 * Return 1 from this function to prevent the kill, and 0 from this function to allow
889 * it as normal. If you prevent the kill no output will be sent to the client, it is
890 * down to your module to generate this information.
891 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
892 * If you do so youre risking race conditions, desyncs and worse!
893 * @param source The user sending the KILL
894 * @param dest The user being killed
895 * @param reason The kill reason
896 * @return 1 to prevent the kill, 0 to allow
898 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
900 /** Called when an oper wants to disconnect a remote user via KILL
901 * @param source The user sending the KILL
902 * @param dest The user being killed
903 * @param reason The kill reason
905 virtual void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
907 /** Called whenever a module is loaded.
908 * mod will contain a pointer to the module, and string will contain its name,
909 * for example m_widgets.so. This function is primary for dependency checking,
910 * your module may decide to enable some extra features if it sees that you have
911 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
912 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
913 * but instead operate under reduced functionality, unless the dependency is
914 * absolutely neccessary (e.g. a module that extends the features of another
916 * @param mod A pointer to the new module
918 virtual void OnLoadModule(Module* mod);
920 /** Called whenever a module is unloaded.
921 * mod will contain a pointer to the module, and string will contain its name,
922 * for example m_widgets.so. This function is primary for dependency checking,
923 * your module may decide to enable some extra features if it sees that you have
924 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
925 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
926 * but instead operate under reduced functionality, unless the dependency is
927 * absolutely neccessary (e.g. a module that extends the features of another
929 * @param mod Pointer to the module being unloaded (still valid)
930 * @param name The filename of the module being unloaded
932 virtual void OnUnloadModule(Module* mod);
934 /** Called once every five seconds for background processing.
935 * This timer can be used to control timed features. Its period is not accurate
936 * enough to be used as a clock, but it is gauranteed to be called at least once in
937 * any five second period, directly from the main loop of the server.
938 * @param curtime The current timer derived from time(2)
940 virtual void OnBackgroundTimer(time_t curtime);
942 /** Called whenever any command is about to be executed.
943 * This event occurs for all registered commands, wether they are registered in the core,
944 * or another module, and for invalid commands. Invalid commands may only be sent to this
945 * function when the value of validated is false. By returning 1 from this method you may prevent the
946 * command being executed. If you do this, no output is created by the core, and it is
947 * down to your module to produce any output neccessary.
948 * Note that unless you return 1, you should not destroy any structures (e.g. by using
949 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
950 * method returns, it will be passed an invalid pointer to the user object and crash!)
951 * @param command The command being executed
952 * @param parameters An array of array of characters containing the parameters for the command
953 * @param pcnt The nuimber of parameters passed to the command
954 * @param user the user issuing the command
955 * @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.
956 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
957 * @param original_line The entire original line as passed to the parser from the user
958 * @return 1 to block the command, 0 to allow
960 virtual ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, LocalUser *user, bool validated, const std::string &original_line);
962 /** Called after any command has been executed.
963 * This event occurs for all registered commands, wether they are registered in the core,
964 * or another module, but it will not occur for invalid commands (e.g. ones which do not
965 * exist within the command table). The result code returned by the command handler is
967 * @param command The command being executed
968 * @param parameters An array of array of characters containing the parameters for the command
969 * @param pcnt The nuimber of parameters passed to the command
970 * @param user the user issuing the command
971 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
972 * @param original_line The entire original line as passed to the parser from the user
974 virtual void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, LocalUser *user, CmdResult result, const std::string &original_line);
976 /** Called when a user is first connecting, prior to starting DNS lookups, checking initial
977 * connect class, or accepting any commands.
979 virtual void OnUserInit(LocalUser* user);
981 /** Called to check if a user who is connecting can now be allowed to register
982 * If any modules return false for this function, the user is held in the waiting
983 * state until all modules return true. For example a module which implements ident
984 * lookups will continue to return false for a user until their ident lookup is completed.
985 * Note that the registration timeout for a user overrides these checks, if the registration
986 * timeout is reached, the user is disconnected even if modules report that the user is
987 * not ready to connect.
988 * @param user The user to check
989 * @return true to indicate readiness, false if otherwise
991 virtual ModResult OnCheckReady(LocalUser* user);
993 /** Called whenever a user is about to register their connection (e.g. before the user
994 * is sent the MOTD etc). Modules can use this method if they are performing a function
995 * which must be done before the actual connection is completed (e.g. ident lookups,
996 * dnsbl lookups, etc).
997 * Note that you should NOT delete the user record here by causing a disconnection!
998 * Use OnUserConnect for that instead.
999 * @param user The user registering
1000 * @return 1 to indicate user quit, 0 to continue
1002 virtual ModResult OnUserRegister(LocalUser* user);
1004 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1005 * This method will always be called for each join, wether or not the channel is actually +i, and
1006 * determines the outcome of an if statement around the whole section of invite checking code.
1007 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1008 * @param user The user joining the channel
1009 * @param chan The channel being joined
1010 * @return 1 to explicitly allow the join, 0 to proceed as normal
1012 virtual ModResult OnCheckInvite(User* user, Channel* chan);
1014 /** Called whenever a mode character is processed.
1015 * Return 1 from this function to block the mode character from being processed entirely.
1016 * @param user The user who is sending the mode
1017 * @param chan The channel the mode is being sent to (or NULL if a usermode)
1018 * @param mode The mode character being set
1019 * @param param The parameter for the mode or an empty string
1020 * @param adding true of the mode is being added, false if it is being removed
1021 * @param pcnt The parameter count for the mode (0 or 1)
1022 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
1023 * to skip all permission checking. Please note that for remote mode changes, your return value
1026 virtual ModResult OnRawMode(User* user, Channel* chan, const char mode, const std::string ¶m, bool adding, int pcnt);
1028 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1029 * This method will always be called for each join, wether or not the channel is actually +k, and
1030 * determines the outcome of an if statement around the whole section of key checking code.
1031 * if the user specified no key, the keygiven string will be a valid but empty value.
1032 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1033 * @param user The user joining the channel
1034 * @param chan The channel being joined
1035 * @return 1 to explicitly allow the join, 0 to proceed as normal
1037 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
1039 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1040 * This method will always be called for each join, wether or not the channel is actually +l, and
1041 * determines the outcome of an if statement around the whole section of channel limit checking code.
1042 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1043 * @param user The user joining the channel
1044 * @param chan The channel being joined
1045 * @return 1 to explicitly allow the join, 0 to proceed as normal
1047 virtual ModResult OnCheckLimit(User* user, Channel* chan);
1050 * Checks for a user's ban from the channel
1051 * @param user The user to check
1052 * @param chan The channel to check in
1053 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1054 * ban check, or MOD_RES_PASSTHRU to check bans normally
1056 virtual ModResult OnCheckChannelBan(User* user, Channel* chan);
1059 * Checks for a user's match of a single ban
1060 * @param user The user to check for match
1061 * @param chan The channel on which the match is being checked
1062 * @param mask The mask being checked
1063 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1064 * ban check, or MOD_RES_PASSTHRU to check bans normally
1066 virtual ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask);
1068 /** Checks for a match on a given extban type
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 OnExtBanCheck(User* user, Channel* chan, char type);
1074 /** Called on all /STATS commands
1075 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1076 * @param symbol the symbol provided to /STATS
1077 * @param user the user issuing the /STATS command
1078 * @param results A string_list to append results into. You should put all your results
1079 * into this string_list, rather than displaying them directly, so that your handler will
1080 * work when remote STATS queries are received.
1081 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1083 virtual ModResult OnStats(char symbol, User* user, string_list &results);
1085 /** Called whenever a change of a local users displayed host is attempted.
1086 * Return 1 to deny the host change, or 0 to allow it.
1087 * @param user The user whos host will be changed
1088 * @param newhost The new hostname
1089 * @return 1 to deny the host change, 0 to allow
1091 virtual ModResult OnChangeLocalUserHost(LocalUser* user, const std::string &newhost);
1093 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1094 * return 1 to deny the name change, or 0 to allow it.
1095 * @param user The user whos GECOS will be changed
1096 * @param newhost The new GECOS
1097 * @return 1 to deny the GECOS change, 0 to allow
1099 virtual ModResult OnChangeLocalUserGECOS(LocalUser* user, const std::string &newhost);
1101 /** Called before a topic is changed.
1102 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
1103 * As with other 'pre' events, you should only ever block a local event.
1104 * @param user The user changing the topic
1105 * @param chan The channels who's topic is being changed
1106 * @param topic The actual topic text
1107 * @param 1 to block the topic change, 0 to allow
1109 virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
1111 /** Called whenever a topic has been changed.
1112 * To block topic changes you must use OnPreTopicChange instead.
1113 * @param user The user changing the topic
1114 * @param chan The channels who's topic is being changed
1115 * @param topic The actual topic text
1117 virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
1119 /** Called whenever an Event class is sent to all modules by another module.
1120 * You should *always* check the value of Event::id to determine the event type.
1121 * @param event The Event class being received
1123 virtual void OnEvent(Event& event);
1125 /** Called whenever a Request class is sent to your module by another module.
1126 * The value of Request::id should be used to determine the type of request.
1127 * @param request The Request class being received
1129 virtual void OnRequest(Request& request);
1131 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
1132 * The password field (from the config file) is in 'password' and is to be compared against
1133 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
1134 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
1135 * @param ex The object that's causing the authentication (User* for <oper> <connect:allow> etc, Server* for <link>).
1136 * @param password The password from the configuration file (the password="" value).
1137 * @param input The password entered by the user or whoever.
1138 * @param hashtype The hash value from the config
1139 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
1141 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
1143 /** Called whenever a user is given usermode +o, anywhere on the network.
1144 * You cannot override this and prevent it from happening as it is already happened and
1145 * such a task must be performed by another server. You can however bounce modes by sending
1146 * servermodes out to reverse mode changes.
1147 * @param user The user who is opering
1149 virtual void OnGlobalOper(User* user);
1151 /** Called after a user has fully connected and all modules have executed OnUserConnect
1152 * This event is informational only. You should not change any user information in this
1153 * event. To do so, use the OnUserConnect method to change the state of local users.
1154 * This is called for both local and remote users.
1155 * @param user The user who is connecting
1157 virtual void OnPostConnect(User* user);
1159 /** Called whenever a ban is added to a channel's list.
1160 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1161 * @param source The user adding the ban
1162 * @param channel The channel the ban is being added to
1163 * @param banmask The ban mask being added
1164 * @return 1 to block the ban, 0 to continue as normal
1166 virtual ModResult OnAddBan(User* source, Channel* channel,const std::string &banmask);
1168 /** Called whenever a ban is removed from a channel's list.
1169 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1170 * @param source The user deleting the ban
1171 * @param channel The channel the ban is being deleted from
1172 * @param banmask The ban mask being deleted
1173 * @return 1 to block the unban, 0 to continue as normal
1175 virtual ModResult OnDelBan(User* source, Channel* channel,const std::string &banmask);
1177 /** Called to install an I/O hook on an event handler
1178 * @param user The item to possibly install the I/O hook on
1179 * @param via The port that <user> connected on
1181 virtual void OnHookIO(StreamSocket*, ListenSocket* via);
1183 /** Called when a port accepts a connection
1184 * Return MOD_RES_ACCEPT if you have used the file descriptor.
1185 * @param fd The file descriptor returned from accept()
1186 * @param from The local port the user connected to
1187 * @param client The client IP address and port
1188 * @param server The server IP address and port
1190 virtual ModResult OnAcceptConnection(int fd, ListenSocket* from, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
1192 /** Called immediately after any connection is accepted. This is intended for raw socket
1193 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1194 * no information relating to a user record as the connection has not been assigned yet.
1195 * There are no return values from this call as all modules get an opportunity if required to
1196 * process the connection.
1197 * @param fd The file descriptor returned from accept()
1198 * @param client The client IP address and port
1199 * @param server The server IP address and port
1200 * @param localport The local port number the user connected to
1202 virtual void OnStreamSocketAccept(StreamSocket*, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
1205 * Called when a hooked stream has data to write, or when the socket
1206 * engine returns it as writable
1207 * @param socket The socket in question
1208 * @param sendq Data to send to the socket
1209 * @return 1 if the sendq has been completely emptied, 0 if there is
1210 * still data to send, and -1 if there was an error
1212 virtual int OnStreamSocketWrite(StreamSocket*, std::string& sendq);
1214 /** Called immediately before any socket is closed. When this event is called, shutdown()
1215 * has not yet been called on the socket.
1216 * @param fd The file descriptor of the socket prior to close()
1218 virtual void OnStreamSocketClose(StreamSocket*);
1220 /** Called immediately upon connection of an outbound BufferedSocket which has been hooked
1222 * @param fd The file descriptor of the socket immediately after connect()
1224 virtual void OnStreamSocketConnect(StreamSocket*);
1227 * Called when the stream socket has data to read
1228 * @param socket The socket that is ready
1229 * @param recvq The receive queue that new data should be appended to
1230 * @return 1 if new data has been read, 0 if no new data is ready (but the
1231 * socket is still connected), -1 if there was an error or close
1233 virtual int OnStreamSocketRead(StreamSocket*, std::string& recvq);
1235 /** Called whenever a user sets away or returns from being away.
1236 * The away message is available as a parameter, but should not be modified.
1237 * At this stage, it has already been copied into the user record.
1238 * If awaymsg is empty, the user is returning from away.
1239 * @param user The user setting away
1240 * @param awaymsg The away message of the user, or empty if returning from away
1241 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
1243 virtual ModResult OnSetAway(User* user, const std::string &awaymsg);
1245 /** Called whenever a line of WHOIS output is sent to a user.
1246 * You may change the numeric and the text of the output by changing
1247 * the values numeric and text, but you cannot change the user the
1248 * numeric is sent to. You may however change the user's User values.
1249 * @param user The user the numeric is being sent to
1250 * @param dest The user being WHOISed
1251 * @param numeric The numeric of the line being sent
1252 * @param text The text of the numeric, including any parameters
1253 * @return nonzero to drop the line completely so that the user does not
1254 * receive it, or zero to allow the line to be sent.
1256 virtual ModResult OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
1258 /** Called at intervals for modules to garbage-collect any hashes etc.
1259 * Certain data types such as hash_map 'leak' buckets, which must be
1260 * tidied up and freed by copying into a new item every so often. This
1261 * method is called when it is time to do that.
1263 virtual void OnGarbageCollect();
1265 /** Called when a user's connect class is being matched
1266 * @return MOD_RES_ALLOW to force the class to match, MOD_RES_DENY to forbid it, or
1267 * MOD_RES_PASSTHRU to allow normal matching (by host/port).
1269 virtual ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass);
1271 /** Add test suite hooks here. These are used for testing functionality of a module
1272 * via the --testsuite debugging parameter.
1274 virtual void OnRunTestSuite();
1276 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
1277 * For example NAMESX, channel mode +u and +I, and UHNAMES. If the nick is set to an empty string by any
1278 * module, then this will cause the nickname not to be displayed at all.
1280 virtual void OnNamesListItem(User* issuer, Membership* item, std::string &prefixes, std::string &nick);
1282 virtual ModResult OnNumeric(User* user, unsigned int numeric, const std::string &text);
1284 /** Called whenever a result from /WHO is about to be returned
1285 * @param source The user running the /WHO query
1286 * @param params The parameters to the /WHO query
1287 * @param user The user that this line of the query is about
1288 * @param line The raw line to send; modifiable, if empty no line will be returned.
1290 virtual void OnSendWhoLine(User* source, const std::vector<std::string>& params, User* user, std::string& line);
1294 #define CONF_NO_ERROR 0x000000
1295 #define CONF_NOT_A_NUMBER 0x000010
1296 #define CONF_INT_NEGATIVE 0x000080
1297 #define CONF_VALUE_NOT_FOUND 0x000100
1298 #define CONF_FILE_NOT_FOUND 0x000200
1301 /** Allows reading of values from configuration files
1302 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1303 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1304 * Constructing the class using one parameter allows you to specify a path to your own configuration
1305 * file, otherwise, inspircd.conf is read.
1307 class CoreExport ConfigReader : public interfacebase
1315 /** Default constructor.
1316 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1317 * as specified when running ./configure.
1320 /** Default destructor.
1321 * This method destroys the ConfigReader class.
1325 /** Retrieves a value from the config file.
1326 * This method retrieves a value from the config file. Where multiple copies of the tag
1327 * exist in the config file, index indicates which of the values to retrieve.
1329 std::string ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds = false);
1330 /** Retrieves a value from the config file.
1331 * This method retrieves a value from the config file. Where multiple copies of the tag
1332 * exist in the config file, index indicates which of the values to retrieve. If the
1333 * tag is not found the default value is returned instead.
1335 std::string ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds = false);
1337 /** Retrieves a boolean value from the config file.
1338 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1339 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1340 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1342 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1343 /** Retrieves a boolean value from the config file.
1344 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1345 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1346 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1347 * If the tag is not found, the default value is used instead.
1349 bool ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index);
1351 /** Retrieves an integer value from the config file.
1352 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1353 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1354 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1355 * return CONF_INVALID_NUMBER to be returned. need_positive is set if the number must be non-negative.
1356 * If a negative number is placed into a tag which is specified positive, 0 will be returned and GetError()
1357 * will return CONF_INT_NEGATIVE. Note that need_positive is not suitable to get an unsigned int - you
1358 * should cast the result to achieve that effect.
1360 int ReadInteger(const std::string &tag, const std::string &name, int index, bool need_positive);
1361 /** Retrieves an integer value from the config file.
1362 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1363 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1364 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1365 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1366 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1367 * will return CONF_NOT_UNSIGNED. If the tag is not found, the default value is used instead.
1369 int ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool need_positive);
1371 /** Returns the last error to occur.
1372 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1373 * A call to GetError() resets the error flag back to 0.
1377 /** Counts the number of times a given tag appears in the config file.
1378 * This method counts the number of times a tag appears in a config file, for use where
1379 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1380 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1381 * multiple instance tag.
1383 int Enumerate(const std::string &tag);
1388 /** Caches a text file into memory and can be used to retrieve lines from it.
1389 * This class contains methods for read-only manipulation of a text file in memory.
1390 * Either use the constructor type with one parameter to load a file into memory
1391 * at construction, or use the LoadFile method to load a file.
1393 class CoreExport FileReader : public classbase
1395 /** The file contents
1397 std::vector<std::string> fc;
1399 /** Content size in bytes
1401 unsigned long contentsize;
1403 /** Calculate content size in bytes
1408 /** Default constructor.
1409 * This method does not load any file into memory, you must use the LoadFile method
1410 * after constructing the class this way.
1414 /** Secondary constructor.
1415 * This method initialises the class with a file loaded into it ready for GetLine and
1416 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1419 FileReader(const std::string &filename);
1421 /** Default destructor.
1422 * This deletes the memory allocated to the file.
1426 /** Used to load a file.
1427 * This method loads a file into the class ready for GetLine and
1428 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1431 void LoadFile(const std::string &filename);
1433 /** Returns the whole content of the file as std::string
1435 std::string Contents();
1437 /** Returns the entire size of the file as std::string
1439 unsigned long ContentSize();
1441 /** Returns true if the file exists
1442 * This function will return false if the file could not be opened.
1446 /** Retrieve one line from the file.
1447 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1448 * the index was out of bounds, or the line had no data on it.
1450 std::string GetLine(int x);
1452 /** Returns the size of the file in lines.
1453 * This method returns the number of lines in the read file. If it is 0, no lines have been
1454 * read into memory, either because the file is empty or it does not exist, or cannot be
1455 * opened due to permission problems.
1460 /** A list of modules
1462 typedef std::vector<Module*> IntModuleList;
1464 /** An event handler iterator
1466 typedef IntModuleList::iterator EventHandlerIter;
1468 /** ModuleManager takes care of all things module-related
1471 class CoreExport ModuleManager
1474 /** Holds a string describing the last module error to occur
1476 std::string LastModuleError;
1478 /** Total number of modules loaded into the ircd
1482 /** List of loaded modules and shared object/dll handles
1483 * keyed by module name
1485 std::map<std::string, Module*> Modules;
1491 } prioritizationState;
1493 /** Internal unload module hook */
1494 bool CanUnload(Module*);
1497 /** Event handler hooks.
1498 * This needs to be public to be used by FOREACH_MOD and friends.
1500 IntModuleList EventHandlers[I_END];
1502 /** List of data services keyed by name */
1503 std::multimap<std::string, ServiceProvider*> DataProviders;
1505 /** Simple, bog-standard, boring constructor.
1513 /** Change the priority of one event in a module.
1514 * Each module event has a list of modules which are attached to that event type.
1515 * If you wish to be called before or after other specific modules, you may use this
1516 * method (usually within void Module::Prioritize()) to set your events priority.
1517 * You may use this call in other methods too, however, this is not supported behaviour
1519 * @param mod The module to change the priority of
1520 * @param i The event to change the priority of
1521 * @param s The state you wish to use for this event. Use one of
1522 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1523 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1524 * to set it to be before or after one or more other modules.
1525 * @param which If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1526 * then this contains a the module that your module must be placed before
1529 bool SetPriority(Module* mod, Implementation i, Priority s, Module* which = NULL);
1531 /** Backwards compat interface */
1532 inline bool SetPriority(Module* mod, Implementation i, Priority s, Module** dptr)
1534 return SetPriority(mod, i, s, *dptr);
1537 /** Change the priority of all events in a module.
1538 * @param mod The module to set the priority of
1539 * @param s The priority of all events in the module.
1540 * Note that with this method, it is not possible to effectively use
1541 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1542 * SetPriority method for this, where you may specify other modules to
1543 * be prioritized against.
1545 bool SetPriority(Module* mod, Priority s);
1547 /** Attach an event to a module.
1548 * You may later detatch the event with ModuleManager::Detach().
1549 * If your module is unloaded, all events are automatically detatched.
1550 * @param i Event type to attach
1551 * @param mod Module to attach event to
1552 * @return True if the event was attached
1554 bool Attach(Implementation i, Module* mod);
1556 /** Detatch an event from a module.
1557 * This is not required when your module unloads, as the core will
1558 * automatically detatch your module from all events it is attached to.
1559 * @param i Event type to detach
1560 * @param mod Module to detach event from
1561 * @param Detach true if the event was detached
1563 bool Detach(Implementation i, Module* mod);
1565 /** Attach an array of events to a module
1566 * @param i Event types (array) to attach
1567 * @param mod Module to attach events to
1569 void Attach(Implementation* i, Module* mod, size_t sz);
1571 /** Detach all events from a module (used on unload)
1572 * @param mod Module to detach from
1574 void DetachAll(Module* mod);
1576 /** Returns text describing the last module error
1577 * @return The last error message to occur
1579 std::string& LastError();
1581 /** Load a given module file
1582 * @param filename The file to load
1583 * @param defer Defer module init (loading many modules)
1584 * @return True if the module was found and loaded
1586 bool Load(const std::string& filename, bool defer = false);
1588 /** Unload a given module file. Note that the module will not be
1589 * completely gone until the cull list has finished processing.
1591 * @return true on success; if false, LastError will give a reason
1593 bool Unload(Module* module);
1595 /** Run an asynchronous reload of the given module. When the reload is
1596 * complete, the callback will be run with true if the reload succeeded
1597 * and false if it did not.
1599 void Reload(Module* module, HandlerBase1<void, bool>* callback);
1601 /** Called by the InspIRCd constructor to load all modules from the config file.
1605 void DoSafeUnload(Module*);
1607 /** Get the total number of currently loaded modules
1608 * @return The number of loaded modules
1612 return this->ModCount;
1615 /** Find a module by name, and return a Module* to it.
1616 * This is preferred over iterating the module lists yourself.
1617 * @param name The module name to look up
1618 * @return A pointer to the module, or NULL if the module cannot be found
1620 Module* Find(const std::string &name);
1622 /** Register a service provided by a module */
1623 void AddService(ServiceProvider&);
1625 /** Unregister a service provided by a module */
1626 void DelService(ServiceProvider&);
1628 inline void AddServices(ServiceProvider** list, int count)
1630 for(int i=0; i < count; i++)
1631 AddService(*list[i]);
1634 /** Find a service by name.
1635 * If multiple modules provide a given service, the first one loaded will be chosen.
1637 ServiceProvider* FindService(ServiceType Type, const std::string& name);
1639 template<typename T> inline T* FindDataService(const std::string& name)
1641 return static_cast<T*>(FindService(SERVICE_DATA, name));
1644 /** Return a list of all modules matching the given filter
1645 * @param filter This int is a bitmask of flags set in Module::Flags,
1646 * such as VF_VENDOR or VF_STATIC. If you wish to receive a list of
1647 * all modules with no filtering, set this to 0.
1648 * @return The list of module names
1650 const std::vector<std::string> GetAllModuleNames(int filter);
1653 /** Do not mess with these functions unless you know the C preprocessor
1654 * well enough to explain why they are needed. The order is important.
1656 #define MODULE_INIT_STR MODULE_INIT_STR_FN_2(MODULE_INIT_SYM)
1657 #define MODULE_INIT_STR_FN_2(x) MODULE_INIT_STR_FN_1(x)
1658 #define MODULE_INIT_STR_FN_1(x) #x
1659 #define MODULE_INIT_SYM MODULE_INIT_SYM_FN_2(INSPIRCD_VERSION_MAJ, INSPIRCD_VERSION_API)
1660 #define MODULE_INIT_SYM_FN_2(x,y) MODULE_INIT_SYM_FN_1(x,y)
1661 #define MODULE_INIT_SYM_FN_1(x,y) inspircd_module_ ## x ## _ ## y
1665 struct AllCommandList {
1666 typedef Command* (*fn)(Module*);
1667 AllCommandList(fn cmd);
1669 #define COMMAND_INIT(x) static Command* MK_ ## x(Module* m) { return new x(m); } \
1670 static const AllCommandList PREP_ ## x(&MK_ ## x);
1672 struct AllModuleList {
1673 typedef Module* (*fn)();
1676 AllModuleList(fn mod, const std::string& Name);
1679 #define MODULE_INIT(x) static Module* MK_ ## x() { return new x; } \
1680 static const AllModuleList PREP_ ## x(&MK_ ## x, MODNAMESTR);
1682 #define MODNAMESTR MODNAMESTR_FN_2(MODNAME)
1683 #define MODNAMESTR_FN_2(x) MODNAMESTR_FN_1(x)
1684 #define MODNAMESTR_FN_1(x) #x
1688 /** This definition is used as shorthand for the various classes
1689 * and functions needed to make a module loadable by the OS.
1690 * It defines the class factory and external init_module function.
1694 #define MODULE_INIT(y) \
1695 extern "C" DllExport Module * MODULE_INIT_SYM() \
1699 BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
1701 switch ( nReason ) \
1703 case DLL_PROCESS_ATTACH: \
1704 case DLL_PROCESS_DETACH: \
1712 #define MODULE_INIT(y) \
1713 extern "C" DllExport Module * MODULE_INIT_SYM() \
1717 extern "C" const char inspircd_src_version[] = VERSION " r" REVISION;
1720 #define COMMAND_INIT(c) MODULE_INIT(CommandModule<c>)