1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
20 #include "inspsocket.h"
30 /** Used to define a set of behavior bits for a module
33 VF_NONE = 0, // module is not special at all
34 VF_STATIC = 1, // module is static, cannot be /unloadmodule'd
35 VF_VENDOR = 2, // module is a vendor module (came in the original tarball, not 3rd party)
36 VF_SERVICEPROVIDER = 4, // module provides a service to other modules (can be a dependency)
37 VF_COMMON = 8, // module needs to be common on all servers in a network to link
38 VF_OPTCOMMON = 16, // module should be common on all servers for unsurprising behavior
39 VF_CORE = 32 // module is a core command, can be assumed loaded on all servers
42 /** Used with SendToMode()
49 /** Used to represent an event type, for user, channel or server
51 enum TargetTypeFlags {
58 /** Used to represent wether a message was PRIVMSG or NOTICE
65 #define MOD_RES_ALLOW (ModResult(1))
66 #define MOD_RES_PASSTHRU (ModResult(0))
67 #define MOD_RES_DENY (ModResult(-1))
69 /** Used to represent an allow/deny module result.
70 * Not constructed as an enum because it reverses the value logic of some functions;
71 * the compiler will inline accesses to have the same efficiency as integer operations.
75 ModResult() : res(0) {}
76 explicit ModResult(int r) : res(r) {}
77 bool operator==(const ModResult& r) const
81 bool operator!=(const ModResult& r) const
85 bool operator!() const
89 bool check(bool def) const
91 return (res == 1 || (res == 0 && def));
94 * Merges two results, preferring ALLOW to DENY
96 ModResult operator+(const ModResult& r) const
98 if (res == r.res || r.res == 0)
102 // they are different, and neither is passthru
103 return MOD_RES_ALLOW;
107 /** If you change the module API, change this value. */
108 #define API_VERSION 13000
112 /* Forward-delacare module for ModuleMessage etc
117 /** Low level definition of a FileReader classes file cache area -
118 * a text file seperated into lines.
120 typedef std::deque<std::string> file_cache;
122 /** A set of strings.
124 typedef file_cache string_list;
126 /** Holds a list of 'published features' for modules.
128 typedef std::map<std::string,Module*> featurelist;
130 /** Holds a list of modules which implement an interface
132 typedef std::deque<Module*> modulelist;
134 /** Holds a list of all modules which implement interfaces, by interface name
136 typedef std::map<std::string, std::pair<int, modulelist> > interfacelist;
139 * This #define allows us to call a method in all
140 * loaded modules in a readable simple way, e.g.:
141 * 'FOREACH_MOD(I_OnConnect,OnConnect(user));'
143 #define FOREACH_MOD(y,x) do { \
144 EventHandlerIter safei; \
145 for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ) \
153 catch (CoreException& modexcept) \
155 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
162 * Custom module result handling loop. This is a paired macro, and should only
163 * be used with while_each_hook.
165 * See src/channels.cpp for an example of use.
167 #define DO_EACH_HOOK(n,v,args) \
169 EventHandlerIter iter_ ## n = ServerInstance->Modules->EventHandlers[I_ ## n].begin(); \
170 while (iter_ ## n != ServerInstance->Modules->EventHandlers[I_ ## n].end()) \
172 Module* mod_ ## n = *iter_ ## n; \
176 v = (mod_ ## n)->n args;
178 #define WHILE_EACH_HOOK(n) \
180 catch (CoreException& except_ ## n) \
182 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s", (except_ ## n).GetReason()); \
183 (void) mod_ ## n; /* catch mismatched pairs */ \
189 * Module result iterator
190 * Runs the given hook until some module returns a useful result.
192 * Example: ModResult result;
193 * FIRST_MOD_RESULT(OnUserPreNick, result, (user, newnick))
195 #define FIRST_MOD_RESULT(n,v,args) do { \
196 v = MOD_RES_PASSTHRU; \
197 DO_EACH_HOOK(n,v,args) \
199 if (v != MOD_RES_PASSTHRU) \
202 WHILE_EACH_HOOK(n); \
205 /** Represents a non-local user.
206 * (in fact, any FD less than -1 does)
208 #define FD_MAGIC_NUMBER -42
209 /** Represents a fake user (i.e. a server)
211 #define FD_FAKEUSER_NUMBER -7
215 /** Is a local user */
216 #define IS_LOCAL(x) (x->GetFd() > -1)
217 /** Is a remote user */
218 #define IS_REMOTE(x) (x->GetFd() < 0)
219 /** Is a fake user */
220 #define IS_SERVER(x) (x->GetFd() == FD_FAKEUSER_NUMBER)
221 /** Is a module created user */
222 #define IS_MODULE_CREATED(x) (x->GetFd() == FD_MAGIC_NUMBER)
224 #define IS_OPER(x) (!x->oper.empty())
226 #define IS_AWAY(x) (!x->awaymsg.empty())
228 /** Holds a module's Version information.
229 * The four members (set by the constructor only) indicate details as to the version number
230 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
231 * The flags and API values represent the module flags and API version of the module.
232 * The API version of a module must match the API version of the core exactly for the module to
235 class CoreExport Version : public classbase
238 /** Module description
240 const std::string description;
241 /** Version information.
243 const std::string version;
245 /** Flags and API version
247 const int Flags, API;
249 /** Initialize version class
251 Version(const std::string &desc, int flags,
252 int api_ver = API_VERSION, const std::string& src_rev = VERSION " r" REVISION);
255 /** The ModuleMessage class is the base class of Request and Event
256 * This class is used to represent a basic data structure which is passed
257 * between modules for safe inter-module communications.
259 class CoreExport ModuleMessage : public Extensible
264 virtual ~ModuleMessage() {};
267 /** The Request class is a unicast message directed at a given module.
268 * When this class is properly instantiated it may be sent to a module
269 * using the Send() method, which will call the given module's OnRequest
270 * method with this class as its parameter.
272 class CoreExport Request : public ModuleMessage
275 /** This member holds a pointer to arbitary data set by the emitter of the message
278 /** This should be a null-terminated string identifying the type of request,
279 * all modules should define this and use it to determine the nature of the
280 * request before they attempt to cast the Request in any way.
283 /** This is a pointer to the sender of the message, which can be used to
284 * directly trigger events, or to create a reply.
287 /** The single destination of the Request
291 /** Create a new Request
292 * This is for the 'old' way of casting whatever the data is
293 * to char* and hoping you get the right thing at the other end.
294 * This is slowly being depreciated in favor of the 'new' way.
296 Request(char* anydata, Module* src, Module* dst);
297 /** Create a new Request
298 * This is for the 'new' way of defining a subclass
299 * of Request and defining it in a common header,
300 * passing an object of your Request subclass through
301 * as a Request* and using the ID string to determine
302 * what to cast it back to and the other end. This is
303 * much safer as there are no casts not confirmed by
304 * the ID string, and all casts are child->parent and
305 * can be checked at runtime with dynamic_cast<>()
307 Request(Module* src, Module* dst, const char* idstr);
308 /** Fetch the Request data
311 /** Fetch the ID string
314 /** Fetch the request source
317 /** Fetch the request destination (should be 'this' in the receiving module)
320 /** Send the Request.
321 * Upon returning the result will be arbitary data returned by the module you
322 * sent the request to. It is up to your module to know what this data is and
323 * how to deal with it.
329 /** The Event class is a unicast message directed at all modules.
330 * When the class is properly instantiated it may be sent to all modules
331 * using the Send() method, which will trigger the OnEvent method in
332 * all modules passing the object as its parameter.
334 class CoreExport Event : public ModuleMessage
337 /** This member holds a pointer to arbitary data set by the emitter of the message
340 /** This is a pointer to the sender of the message, which can be used to
341 * directly trigger events, or to create a reply.
344 /** The event identifier.
345 * This is arbitary text which should be used to distinguish
346 * one type of event from another.
350 /** Create a new Event
352 Event(char* anydata, Module* src, const std::string &eventid);
353 /** Get the Event data
356 /** Get the event Source
359 /** Get the event ID.
360 * Use this to determine the event type for safe casting of the data
362 std::string GetEventID();
364 * The return result of an Event::Send() will always be NULL as
365 * no replies are expected.
370 /** Priority types which can be returned from Module::Prioritize()
372 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
374 /** Implementation-specific flags which may be set in Module::Implements()
379 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash,
380 I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois,
381 I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick,
382 I_OnUserMessage, I_OnUserNotice, I_OnMode, I_OnGetServerDescription, I_OnSyncUser,
383 I_OnSyncChannel, I_OnDecodeMetaData, I_OnWallops,
384 I_OnChangeHost, I_OnChangeName, I_OnAddLine, I_OnDelLine, I_OnExpireLine, I_OnCleanup,
385 I_OnUserPostNick, I_OnPreMode, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule,
386 I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite,
387 I_OnRawMode, I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckChannelBan, I_OnExtBanCheck,
388 I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnPreTopicChange,
389 I_OnPostTopicChange, I_OnEvent, I_OnRequest, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan,
390 I_OnDelBan, I_OnChangeLocalUserGECOS, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
391 I_OnPostOper, I_OnSyncNetwork, I_OnSetAway, I_OnUserList, I_OnPostCommand, I_OnPostJoin,
392 I_OnWhoisLine, I_OnBuildExemptList, I_OnGarbageCollect,
393 I_OnText, I_OnPassCompare, I_OnRunTestSuite, I_OnNamesListItem, I_OnNumeric, I_OnHookIO,
394 I_OnHostCycle, I_OnPreRehash, I_OnModuleRehash, I_OnSendWhoLine, I_OnChangeIdent,
400 /** Base class for all InspIRCd modules
401 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
402 * its methods will be called when irc server events occur. class inherited from module must be
403 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
405 class CoreExport Module : public Extensible
408 /** File that this module was loaded from
410 std::string ModuleSourceFile;
411 /** Reference to the dlopen() value
413 DLLFactory* ModuleDLLFactory;
415 /** Default constructor.
416 * Creates a module class.
417 * @param Me An instance of the InspIRCd class which will be saved into ServerInstance for your use
418 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
422 /** Clean up prior to destruction
423 * If you override, you must call this AFTER your module's cleanup
427 /** Default destructor.
428 * destroys a module class
432 virtual void Prioritize()
436 /** Returns the version number of a Module.
437 * The method should return a Version object with its version information assigned via
440 virtual Version GetVersion() = 0;
442 /** Called when a user connects.
443 * The details of the connecting user are available to you in the parameter User *user
444 * @param user The user who is connecting
446 virtual void OnUserConnect(User* user);
448 /** Called when a user quits.
449 * The details of the exiting user are available to you in the parameter User *user
450 * This event is only called when the user is fully registered when they quit. To catch
451 * raw disconnections, use the OnUserDisconnect method.
452 * @param user The user who is quitting
453 * @param message The user's quit message (as seen by non-opers)
454 * @param oper_message The user's quit message (as seen by opers)
456 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
458 /** Called whenever a user's socket is closed.
459 * The details of the exiting user are available to you in the parameter User *user
460 * This event is called for all users, registered or not, as a cleanup method for modules
461 * which might assign resources to user, such as dns lookups, objects and sockets.
462 * @param user The user who is disconnecting
464 virtual void OnUserDisconnect(User* user);
466 /** Called whenever a channel is about to be deleted
467 * @param chan The channel being deleted
468 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
470 virtual ModResult OnChannelPreDelete(Channel *chan);
472 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
473 * @param chan The channel being deleted
475 virtual void OnChannelDelete(Channel* chan);
477 /** Called when a user joins a channel.
478 * The details of the joining user are available to you in the parameter User *user,
479 * and the details of the channel they have joined is available in the variable Channel *channel
480 * @param memb The channel membership being created
481 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
482 * to a channel due to the network sync.
483 * @param created This is true if the join created the channel
485 virtual void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list);
487 /** Called after a user joins a channel
488 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
490 * @param memb The channel membership created
492 virtual void OnPostJoin(Membership*);
494 /** Called when a user parts a channel.
495 * The details of the leaving user are available to you in the parameter User *user,
496 * and the details of the channel they have left is available in the variable Channel *channel
497 * @param memb The channel membership being destroyed
498 * @param partmessage The part message, or an empty string (may be modified)
500 virtual void OnUserPart(Membership* memb, std::string &partmessage, CUList& except_list);
502 /** Called on rehash.
503 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
504 * system. This is called in all cases -- including when this server will not execute the
505 * rehash because it is directed at a remote server.
507 * @param user The user performing the rehash, if any. If this is server initiated, the value of
508 * this variable will be NULL.
509 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
512 virtual void OnPreRehash(User* user, const std::string ¶meter);
514 /** Called on rehash.
515 * This method is called when a user initiates a module-specific rehash. This can be used to do
516 * expensive operations (such as reloading SSL certificates) that are not executed on a normal
517 * rehash for efficiency. A rehash of this type does not reload the core configuration.
519 * @param user The user performing the rehash.
520 * @param parameter The parameter given to REHASH
522 virtual void OnModuleRehash(User* user, const std::string ¶meter);
524 /** Called on rehash.
525 * This method is called after a rehash has completed. You should use it to reload any module
526 * configuration from the main configuration file.
527 * @param user The user that performed the rehash, if it was initiated by a user and that user
528 * is still connected.
530 virtual void OnRehash(User* user);
532 /** Called whenever a snotice is about to be sent to a snomask.
533 * snomask and type may both be modified; the message may not.
534 * @param snomask The snomask the message is going to (e.g. 'A')
535 * @param type The textual description the snomask will go to (e.g. 'OPER')
536 * @param message The text message to be sent via snotice
537 * @return 1 to block the snotice from being sent entirely, 0 else.
539 virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
541 /** Called whenever a user is about to join a channel, before any processing is done.
542 * Returning a value of 1 from this function stops the process immediately, causing no
543 * output to be sent to the user by the core. If you do this you must produce your own numerics,
544 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
545 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
549 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
550 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
551 * processing on the actual channel record at this point, however the channel NAME will still be passed in
552 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
553 * @param user The user joining the channel
554 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
555 * @param cname The channel name being joined. For new channels this is valid where chan is not.
556 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "o".
557 * You may alter this string to alter the user's modes on the channel.
558 * @param keygiven The key given to join the channel, or an empty string if none was provided
559 * @return 1 To prevent the join, 0 to allow it.
561 virtual ModResult OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string &privs, const std::string &keygiven);
563 /** Called whenever a user is about to be kicked.
564 * Returning a value of 1 from this function stops the process immediately, causing no
565 * output to be sent to the user by the core. If you do this you must produce your own numerics,
567 * @param source The user issuing the kick
568 * @param user The user being kicked
569 * @param chan The channel the user is being kicked from
570 * @param reason The kick reason
571 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
573 virtual ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason);
575 /** Called whenever a user is kicked.
576 * If this method is called, the kick is already underway and cannot be prevented, so
577 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
578 * @param source The user issuing the kick
579 * @param user The user being kicked
580 * @param chan The channel the user is being kicked from
581 * @param reason The kick reason
583 virtual void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except_list);
585 /** Called whenever a user opers locally.
586 * The User will contain the oper mode 'o' as this function is called after any modifications
587 * are made to the user's structure by the core.
588 * @param user The user who is opering up
589 * @param opertype The opers type name
591 virtual void OnOper(User* user, const std::string &opertype);
593 /** Called after a user opers locally.
594 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
595 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
596 * out the OPERTYPE, etc.
597 * @param user The user who is opering up
598 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
599 * @param opertype The opers type name
601 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
603 /** Called whenever a user types /INFO.
604 * The User will contain the information of the user who typed the command. Modules may use this
605 * method to output their own credits in /INFO (which is the ircd's version of an about box).
606 * It is purposefully not possible to modify any info that has already been output, or halt the list.
607 * You must write a 371 numeric to the user, containing your info in the following format:
609 * <nick> :information here
611 * @param user The user issuing /INFO
613 virtual void OnInfo(User* user);
615 /** Called whenever a /WHOIS is performed on a local user.
616 * The source parameter contains the details of the user who issued the WHOIS command, and
617 * the dest parameter contains the information of the user they are whoising.
618 * @param source The user issuing the WHOIS command
619 * @param dest The user who is being WHOISed
621 virtual void OnWhois(User* source, User* dest);
623 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
624 * Returning 1 from this function stops the process immediately, causing no
625 * output to be sent to the user by the core. If you do this you must produce your own numerics,
626 * notices etc. This is useful for modules which may want to filter invites to channels.
627 * @param source The user who is issuing the INVITE
628 * @param dest The user being invited
629 * @param channel The channel the user is being invited to
630 * @param timeout The time the invite will expire (0 == never)
631 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
633 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
635 /** Called after a user has been successfully invited to a channel.
636 * You cannot prevent the invite from occuring using this function, to do that,
637 * use OnUserPreInvite instead.
638 * @param source The user who is issuing the INVITE
639 * @param dest The user being invited
640 * @param channel The channel the user is being invited to
641 * @param timeout The time the invite will expire (0 == never)
643 virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout);
645 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
646 * Returning any nonzero value from this function stops the process immediately, causing no
647 * output to be sent to the user by the core. If you do this you must produce your own numerics,
648 * notices etc. This is useful for modules which may want to filter or redirect messages.
649 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
650 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
651 * of where the message is destined to be sent.
652 * @param user The user sending the message
653 * @param dest The target of the message (Channel* or User*)
654 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
655 * @param text Changeable text being sent by the user
656 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
657 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
658 * It will be ignored for private messages.
659 * @return 1 to deny the message, 0 to allow it
661 virtual ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
663 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
664 * Returning any nonzero value from this function stops the process immediately, causing no
665 * output to be sent to the user by the core. If you do this you must produce your own numerics,
666 * notices etc. This is useful for modules which may want to filter or redirect messages.
667 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
668 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
669 * of where the message is destined to be sent.
670 * You may alter the message text as you wish before relinquishing control to the next module
671 * in the chain, and if no other modules block the text this altered form of the text will be sent out
672 * to the user and possibly to other servers.
673 * @param user The user sending the message
674 * @param dest The target of the message (Channel* or User*)
675 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
676 * @param text Changeable text being sent by the user
677 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
678 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
679 * It will be ignored for private notices.
680 * @return 1 to deny the NOTICE, 0 to allow it
682 virtual ModResult OnUserPreNotice(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
684 /** Called whenever the server wants to build the exemption list for a channel, but is not directly doing a PRIVMSG or NOTICE.
685 * For example, the spanningtree protocol will call this event when passing a privmsg on (but not processing it directly).
686 * @param message_type The message type, either MSG_PRIVMSG or MSG_NOTICE
687 * @param chan The channel to build the exempt list of
688 * @param sender The original sender of the PRIVMSG or NOTICE
689 * @param status The status char to be used for the channel list
690 * @param exempt_list The exempt list to be populated
691 * @param text The original message text causing the exempt list to be built
693 virtual void OnBuildExemptList(MessageType message_type, Channel* chan, User* sender, char status, CUList &exempt_list, const std::string &text);
695 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
696 * Please note that although you can see remote nickchanges through this function, you should
697 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
698 * check user->server before taking any action (including returning nonzero from the method).
699 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
700 * module to generate some meaninful output.
701 * @param user The username changing their nick
702 * @param newnick Their new nickname
703 * @return 1 to deny the change, 0 to allow
705 virtual ModResult OnUserPreNick(User* user, const std::string &newnick);
707 /** Called after any PRIVMSG sent from a user.
708 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
709 * if target_type is TYPE_CHANNEL.
710 * @param user The user sending the message
711 * @param dest The target of the message
712 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
713 * @param text the text being sent by the user
714 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
716 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
718 /** Called after any NOTICE sent from a user.
719 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
720 * if target_type is TYPE_CHANNEL.
721 * @param user The user sending the message
722 * @param dest The target of the message
723 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
724 * @param text the text being sent by the user
725 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
727 virtual void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
729 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
730 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
731 * if target_type is TYPE_CHANNEL.
732 * The difference between this event and OnUserPreNotice/OnUserPreMessage is that delivery is gauranteed,
733 * the message has already been vetted. In the case of the other two methods, a later module may stop your
734 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
735 * @param user The user sending the message
736 * @param dest The target of the message
737 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
738 * @param text the text being sent by the user
739 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
741 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
743 /** Called after every MODE command sent from a user
744 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
745 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
746 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
747 * @param user The user sending the MODEs
748 * @param dest The target of the modes (User* or Channel*)
749 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
750 * @param text The actual modes and their parameters if any
751 * @param translate The translation types of the mode parameters
753 virtual void OnMode(User* user, void* dest, int target_type, const std::vector<std::string> &text, const std::vector<TranslateType> &translate);
755 /** Allows modules to alter or create server descriptions
756 * Whenever a module requires a server description, for example for display in
757 * WHOIS, this function is called in all modules. You may change or define the
758 * description given in std::string &description. If you do, this description
759 * will be shown in the WHOIS fields.
760 * @param servername The servername being searched for
761 * @param description Alterable server description for this server
763 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
765 /** Allows modules to synchronize data which relates to users during a netburst.
766 * When this function is called, it will be called from the module which implements
767 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
768 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
769 * (see below). This function will be called for every user visible on your side
770 * of the burst, allowing you to for example set modes, etc. Do not use this call to
771 * synchronize data which you have stored using class Extensible -- There is a specialist
772 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
773 * @param user The user being syncronized
774 * @param proto A pointer to the module handling network protocol
775 * @param opaque An opaque pointer set by the protocol module, should not be modified!
777 virtual void OnSyncUser(User* user, Module* proto, void* opaque);
779 /** Allows modules to synchronize data which relates to channels during a netburst.
780 * When this function is called, it will be called from the module which implements
781 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
782 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
783 * (see below). This function will be called for every user visible on your side
784 * of the burst, allowing you to for example set modes, etc.
786 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
788 * @param chan The channel being syncronized
789 * @param proto A pointer to the module handling network protocol
790 * @param opaque An opaque pointer set by the protocol module, should not be modified!
792 virtual void OnSyncChannel(Channel* chan, Module* proto, void* opaque);
794 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
795 * Whenever the linking module wants to send out data, but doesnt know what the data
796 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
797 * this method is called. You should use the ProtoSendMetaData function after you've
798 * correctly decided how the data should be represented, to send the metadata on its way if
799 * if it belongs to your module.
800 * @param proto A pointer to the module handling network protocol
801 * @param opaque An opaque pointer set by the protocol module, should not be modified!
802 * @param displayable If this value is true, the data is going to be displayed to a user,
803 * and not sent across the network. Use this to determine wether or not to show sensitive data.
805 virtual void OnSyncNetwork(Module* proto, void* opaque);
807 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
808 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
809 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
810 * @param target The Channel* or User* that data should be added to
811 * @param extname The extension name which is being sent
812 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
814 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
816 /** Implemented by modules which provide the ability to link servers.
817 * These modules will implement this method, which allows transparent sending of servermodes
818 * down the network link as a broadcast, without a module calling it having to know the format
819 * of the MODE command before the actual mode string.
821 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
822 * of how to use this function.
824 * @param opaque An opaque pointer set by the protocol module, should not be modified!
825 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
826 * @param target The Channel* or User* that modes should be sent for
827 * @param modeline The modes and parameters to be sent
828 * @param translate The translation types of the mode parameters
830 virtual void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::vector<std::string> &modeline, const std::vector<TranslateType> &translate);
832 /** Implemented by modules which provide the ability to link servers.
833 * These modules will implement this method, which allows metadata (extra data added to
834 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
835 * to other servers on a netburst and decoded at the other end by the same module on a
838 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
839 * how to use this function.
840 * @param opaque An opaque pointer set by the protocol module, should not be modified!
841 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
842 * @param target The Channel* or User* that metadata should be sent for
843 * @param extname The extension name to send metadata for
844 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
846 virtual void ProtoSendMetaData(void* opaque, Extensible* target, const std::string &extname, const std::string &extdata);
848 /** Called after every WALLOPS command.
849 * @param user The user sending the WALLOPS
850 * @param text The content of the WALLOPS message
852 virtual void OnWallops(User* user, const std::string &text);
854 /** Called whenever a user's hostname is changed.
855 * This event triggers after the host has been set.
856 * @param user The user whos host is being changed
857 * @param newhost The new hostname being set
859 virtual void OnChangeHost(User* user, const std::string &newhost);
861 /** Called whenever a user's GECOS (realname) is changed.
862 * This event triggers after the name has been set.
863 * @param user The user who's GECOS is being changed
864 * @param gecos The new GECOS being set on the user
866 virtual void OnChangeName(User* user, const std::string &gecos);
868 /** Called whenever a user's IDENT is changed.
869 * This event triggers after the name has been set.
870 * @param user The user who's IDENT is being changed
871 * @param gecos The new IDENT being set on the user
873 virtual void OnChangeIdent(User* user, const std::string &ident);
875 /** Called whenever an xline is added by a local user.
876 * This method is triggered after the line is added.
877 * @param source The sender of the line or NULL for local server
878 * @param line The xline being added
880 virtual void OnAddLine(User* source, XLine* line);
882 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
883 * This method is triggered after the line is deleted.
884 * @param source The user removing the line or NULL for local server
885 * @param line the line being deleted
887 virtual void OnDelLine(User* source, XLine* line);
889 /** Called whenever an xline expires.
890 * This method is triggered after the line is deleted.
891 * @param line The line being deleted.
893 virtual void OnExpireLine(XLine *line);
895 /** Called before your module is unloaded to clean up Extensibles.
896 * This method is called once for every user and channel on the network,
897 * so that when your module unloads it may clear up any remaining data
898 * in the form of Extensibles added using Extensible::Extend().
899 * If the target_type variable is TYPE_USER, then void* item refers to
900 * a User*, otherwise it refers to a Channel*.
901 * @param target_type The type of item being cleaned
902 * @param item A pointer to the item's class
904 virtual void OnCleanup(int target_type, void* item);
906 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
907 * have been applied. Please note that although you can see remote nickchanges through this function, you should
908 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
909 * check user->server before taking any action (including returning nonzero from the method).
910 * Because this method is called after the nickchange is taken place, no return values are possible
911 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
912 * @param user The user changing their nick
913 * @param oldnick The old nickname of the user before the nickchange
915 virtual void OnUserPostNick(User* user, const std::string &oldnick);
917 /** Called before any mode change, to allow a single access check for
918 * a full mode change (use OnRawMode to check individual modes)
920 * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
921 * OnRawMode for each individual mode
923 * @param source the user making the mode change
924 * @param dest the user destination of the umode change (NULL if a channel mode)
925 * @param channel the channel destination of the mode change
926 * @param parameters raw mode parameters; parameters[0] is the user/channel being changed
928 virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, const std::vector<std::string>& parameters);
930 /** Called when a 005 numeric is about to be output.
931 * The module should modify the 005 numeric if needed to indicate its features.
932 * @param output The 005 string to be modified if neccessary.
934 virtual void On005Numeric(std::string &output);
936 /** Called when a client is disconnected by KILL.
937 * If a client is killed by a server, e.g. a nickname collision or protocol error,
939 * Return 1 from this function to prevent the kill, and 0 from this function to allow
940 * it as normal. If you prevent the kill no output will be sent to the client, it is
941 * down to your module to generate this information.
942 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
943 * If you do so youre risking race conditions, desyncs and worse!
944 * @param source The user sending the KILL
945 * @param dest The user being killed
946 * @param reason The kill reason
947 * @return 1 to prevent the kill, 0 to allow
949 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
951 /** Called when an oper wants to disconnect a remote user via KILL
952 * @param source The user sending the KILL
953 * @param dest The user being killed
954 * @param reason The kill reason
956 virtual void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
958 /** Called whenever a module is loaded.
959 * mod will contain a pointer to the module, and string will contain its name,
960 * for example m_widgets.so. This function is primary for dependency checking,
961 * your module may decide to enable some extra features if it sees that you have
962 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
963 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
964 * but instead operate under reduced functionality, unless the dependency is
965 * absolutely neccessary (e.g. a module that extends the features of another
967 * @param mod A pointer to the new module
968 * @param name The new module's filename
970 virtual void OnLoadModule(Module* mod,const std::string &name);
972 /** Called whenever a module is unloaded.
973 * mod will contain a pointer to the module, and string will contain its name,
974 * for example m_widgets.so. This function is primary for dependency checking,
975 * your module may decide to enable some extra features if it sees that you have
976 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
977 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
978 * but instead operate under reduced functionality, unless the dependency is
979 * absolutely neccessary (e.g. a module that extends the features of another
981 * @param mod Pointer to the module being unloaded (still valid)
982 * @param name The filename of the module being unloaded
984 virtual void OnUnloadModule(Module* mod,const std::string &name);
986 /** Called once every five seconds for background processing.
987 * This timer can be used to control timed features. Its period is not accurate
988 * enough to be used as a clock, but it is gauranteed to be called at least once in
989 * any five second period, directly from the main loop of the server.
990 * @param curtime The current timer derived from time(2)
992 virtual void OnBackgroundTimer(time_t curtime);
994 /** Called whenever any command is about to be executed.
995 * This event occurs for all registered commands, wether they are registered in the core,
996 * or another module, and for invalid commands. Invalid commands may only be sent to this
997 * function when the value of validated is false. By returning 1 from this method you may prevent the
998 * command being executed. If you do this, no output is created by the core, and it is
999 * down to your module to produce any output neccessary.
1000 * Note that unless you return 1, you should not destroy any structures (e.g. by using
1001 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
1002 * method returns, it will be passed an invalid pointer to the user object and crash!)
1003 * @param command The command being executed
1004 * @param parameters An array of array of characters containing the parameters for the command
1005 * @param pcnt The nuimber of parameters passed to the command
1006 * @param user the user issuing the command
1007 * @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.
1008 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
1009 * @param original_line The entire original line as passed to the parser from the user
1010 * @return 1 to block the command, 0 to allow
1012 virtual ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, User *user, bool validated, const std::string &original_line);
1014 /** Called after any command has been executed.
1015 * This event occurs for all registered commands, wether they are registered in the core,
1016 * or another module, but it will not occur for invalid commands (e.g. ones which do not
1017 * exist within the command table). The result code returned by the command handler is
1019 * @param command The command being executed
1020 * @param parameters An array of array of characters containing the parameters for the command
1021 * @param pcnt The nuimber of parameters passed to the command
1022 * @param user the user issuing the command
1023 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
1024 * @param original_line The entire original line as passed to the parser from the user
1026 virtual void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, User *user, CmdResult result, const std::string &original_line);
1028 /** Called to check if a user who is connecting can now be allowed to register
1029 * If any modules return false for this function, the user is held in the waiting
1030 * state until all modules return true. For example a module which implements ident
1031 * lookups will continue to return false for a user until their ident lookup is completed.
1032 * Note that the registration timeout for a user overrides these checks, if the registration
1033 * timeout is reached, the user is disconnected even if modules report that the user is
1034 * not ready to connect.
1035 * @param user The user to check
1036 * @return true to indicate readiness, false if otherwise
1038 virtual ModResult OnCheckReady(User* user);
1040 /** Called whenever a user is about to register their connection (e.g. before the user
1041 * is sent the MOTD etc). Modules can use this method if they are performing a function
1042 * which must be done before the actual connection is completed (e.g. ident lookups,
1043 * dnsbl lookups, etc).
1044 * Note that you should NOT delete the user record here by causing a disconnection!
1045 * Use OnUserConnect for that instead.
1046 * @param user The user registering
1047 * @return 1 to indicate user quit, 0 to continue
1049 virtual ModResult OnUserRegister(User* user);
1051 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1052 * This method will always be called for each join, wether or not the channel is actually +i, and
1053 * determines the outcome of an if statement around the whole section of invite checking code.
1054 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1055 * @param user The user joining the channel
1056 * @param chan The channel being joined
1057 * @return 1 to explicitly allow the join, 0 to proceed as normal
1059 virtual ModResult OnCheckInvite(User* user, Channel* chan);
1061 /** Called whenever a mode character is processed.
1062 * Return 1 from this function to block the mode character from being processed entirely.
1063 * @param user The user who is sending the mode
1064 * @param chan The channel the mode is being sent to (or NULL if a usermode)
1065 * @param mode The mode character being set
1066 * @param param The parameter for the mode or an empty string
1067 * @param adding true of the mode is being added, false if it is being removed
1068 * @param pcnt The parameter count for the mode (0 or 1)
1069 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
1070 * to skip all permission checking. Please note that for remote mode changes, your return value
1073 virtual ModResult OnRawMode(User* user, Channel* chan, const char mode, const std::string ¶m, bool adding, int pcnt);
1075 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1076 * This method will always be called for each join, wether or not the channel is actually +k, and
1077 * determines the outcome of an if statement around the whole section of key checking code.
1078 * if the user specified no key, the keygiven string will be a valid but empty value.
1079 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1080 * @param user The user joining the channel
1081 * @param chan The channel being joined
1082 * @return 1 to explicitly allow the join, 0 to proceed as normal
1084 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
1086 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1087 * This method will always be called for each join, wether or not the channel is actually +l, and
1088 * determines the outcome of an if statement around the whole section of channel limit checking code.
1089 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1090 * @param user The user joining the channel
1091 * @param chan The channel being joined
1092 * @return 1 to explicitly allow the join, 0 to proceed as normal
1094 virtual ModResult OnCheckLimit(User* user, Channel* chan);
1097 * Checks for a user's ban from the channel
1098 * @param user The user to check
1099 * @param chan The channel to check in
1100 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1101 * ban check, or MOD_RES_PASSTHRU to check bans normally
1103 virtual ModResult OnCheckChannelBan(User* user, Channel* chan);
1106 * Checks for a user's match of a single ban
1107 * @param user The user to check for match
1108 * @param chan The channel on which the match is being checked
1109 * @param mask The mask being checked
1110 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1111 * ban check, or MOD_RES_PASSTHRU to check bans normally
1113 virtual ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask);
1115 /** Checks for a match on a given extban type
1116 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1117 * ban check, or MOD_RES_PASSTHRU to check bans normally
1119 virtual ModResult OnExtBanCheck(User* user, Channel* chan, char type);
1121 /** Called on all /STATS commands
1122 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1123 * @param symbol the symbol provided to /STATS
1124 * @param user the user issuing the /STATS command
1125 * @param results A string_list to append results into. You should put all your results
1126 * into this string_list, rather than displaying them directly, so that your handler will
1127 * work when remote STATS queries are received.
1128 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1130 virtual ModResult OnStats(char symbol, User* user, string_list &results);
1132 /** Called whenever a change of a local users displayed host is attempted.
1133 * Return 1 to deny the host change, or 0 to allow it.
1134 * @param user The user whos host will be changed
1135 * @param newhost The new hostname
1136 * @return 1 to deny the host change, 0 to allow
1138 virtual ModResult OnChangeLocalUserHost(User* user, const std::string &newhost);
1140 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1141 * return 1 to deny the name change, or 0 to allow it.
1142 * @param user The user whos GECOS will be changed
1143 * @param newhost The new GECOS
1144 * @return 1 to deny the GECOS change, 0 to allow
1146 virtual ModResult OnChangeLocalUserGECOS(User* user, const std::string &newhost);
1148 /** Called before a topic is changed.
1149 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
1150 * As with other 'pre' events, you should only ever block a local event.
1151 * @param user The user changing the topic
1152 * @param chan The channels who's topic is being changed
1153 * @param topic The actual topic text
1154 * @param 1 to block the topic change, 0 to allow
1156 virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
1158 /** Called whenever a topic has been changed.
1159 * To block topic changes you must use OnPreTopicChange instead.
1160 * @param user The user changing the topic
1161 * @param chan The channels who's topic is being changed
1162 * @param topic The actual topic text
1164 virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
1166 /** Called whenever an Event class is sent to all module by another module.
1167 * Please see the documentation of Event::Send() for further information. The Event sent can
1168 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1169 * before doing anything to the event data, and you should *not* change the event data in any way!
1170 * @param event The Event class being received
1172 virtual void OnEvent(Event* event);
1174 /** Called whenever a Request class is sent to your module by another module.
1175 * Please see the documentation of Request::Send() for further information. The Request sent
1176 * can always be assumed to be non-NULL, you should not change the request object or its data.
1177 * Your method may return arbitary data in the char* result which the requesting module
1178 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1179 * @param request The Request class being received
1181 virtual const char* OnRequest(Request* request);
1183 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
1184 * The password field (from the config file) is in 'password' and is to be compared against
1185 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
1186 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
1187 * @param ex The object that's causing the authentication (User* for <oper> <connect:allow> etc, Server* for <link>).
1188 * @param password The password from the configuration file (the password="" value).
1189 * @param input The password entered by the user or whoever.
1190 * @param hashtype The hash value from the config
1191 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
1193 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
1195 /** Called whenever a user is given usermode +o, anywhere on the network.
1196 * You cannot override this and prevent it from happening as it is already happened and
1197 * such a task must be performed by another server. You can however bounce modes by sending
1198 * servermodes out to reverse mode changes.
1199 * @param user The user who is opering
1201 virtual void OnGlobalOper(User* user);
1203 /** Called after a user has fully connected and all modules have executed OnUserConnect
1204 * This event is informational only. You should not change any user information in this
1205 * event. To do so, use the OnUserConnect method to change the state of local users.
1206 * This is called for both local and remote users.
1207 * @param user The user who is connecting
1209 virtual void OnPostConnect(User* user);
1211 /** Called whenever a ban is added to a channel's list.
1212 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1213 * @param source The user adding the ban
1214 * @param channel The channel the ban is being added to
1215 * @param banmask The ban mask being added
1216 * @return 1 to block the ban, 0 to continue as normal
1218 virtual ModResult OnAddBan(User* source, Channel* channel,const std::string &banmask);
1220 /** Called whenever a ban is removed from a channel's list.
1221 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1222 * @param source The user deleting the ban
1223 * @param channel The channel the ban is being deleted from
1224 * @param banmask The ban mask being deleted
1225 * @return 1 to block the unban, 0 to continue as normal
1227 virtual ModResult OnDelBan(User* source, Channel* channel,const std::string &banmask);
1229 /** Called to install an I/O hook on an event handler
1230 * @param user The item to possibly install the I/O hook on
1231 * @param via The port that <user> connected on
1233 virtual void OnHookIO(StreamSocket*, ListenSocketBase* via);
1235 /** Called immediately after any connection is accepted. This is intended for raw socket
1236 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1237 * no information relating to a user record as the connection has not been assigned yet.
1238 * There are no return values from this call as all modules get an opportunity if required to
1239 * process the connection.
1240 * @param fd The file descriptor returned from accept()
1241 * @param client The client IP address and port
1242 * @param server The server IP address and port
1243 * @param localport The local port number the user connected to
1245 virtual void OnStreamSocketAccept(StreamSocket*, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
1248 * Called when a hooked stream has data to write, or when the socket
1249 * engine returns it as writable
1250 * @param socket The socket in question
1251 * @param sendq Data to send to the socket
1252 * @return 1 if the sendq has been completely emptied, 0 if there is
1253 * still data to send, and -1 if there was an error
1255 virtual int OnStreamSocketWrite(StreamSocket*, std::string& sendq);
1257 /** Called immediately before any socket is closed. When this event is called, shutdown()
1258 * has not yet been called on the socket.
1259 * @param fd The file descriptor of the socket prior to close()
1261 virtual void OnStreamSocketClose(StreamSocket*);
1263 /** Called immediately upon connection of an outbound BufferedSocket which has been hooked
1265 * @param fd The file descriptor of the socket immediately after connect()
1267 virtual void OnStreamSocketConnect(StreamSocket*);
1270 * Called when the stream socket has data to read
1271 * @param socket The socket that is ready
1272 * @param recvq The receive queue that new data should be appended to
1273 * @return 1 if new data has been read, 0 if no new data is ready (but the
1274 * socket is still connected), -1 if there was an error or close
1276 virtual int OnStreamSocketRead(StreamSocket*, std::string& recvq);
1278 /** Called whenever a user sets away or returns from being away.
1279 * The away message is available as a parameter, but should not be modified.
1280 * At this stage, it has already been copied into the user record.
1281 * If awaymsg is empty, the user is returning from away.
1282 * @param user The user setting away
1283 * @param awaymsg The away message of the user, or empty if returning from away
1284 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
1286 virtual ModResult OnSetAway(User* user, const std::string &awaymsg);
1288 /** Called whenever a NAMES list is requested.
1289 * You can produce the nameslist yourself, overriding the current list,
1290 * and if you do you must return 1. If you do not handle the names list,
1292 * @param The user requesting the NAMES list
1293 * @param Ptr The channel the NAMES list is requested for
1295 virtual ModResult OnUserList(User* user, Channel* Ptr);
1297 /** Called whenever a line of WHOIS output is sent to a user.
1298 * You may change the numeric and the text of the output by changing
1299 * the values numeric and text, but you cannot change the user the
1300 * numeric is sent to. You may however change the user's User values.
1301 * @param user The user the numeric is being sent to
1302 * @param dest The user being WHOISed
1303 * @param numeric The numeric of the line being sent
1304 * @param text The text of the numeric, including any parameters
1305 * @return nonzero to drop the line completely so that the user does not
1306 * receive it, or zero to allow the line to be sent.
1308 virtual ModResult OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
1310 /** Called at intervals for modules to garbage-collect any hashes etc.
1311 * Certain data types such as hash_map 'leak' buckets, which must be
1312 * tidied up and freed by copying into a new item every so often. This
1313 * method is called when it is time to do that.
1315 virtual void OnGarbageCollect();
1317 /** Add test suite hooks here. These are used for testing functionality of a module
1318 * via the --testsuite debugging parameter.
1320 virtual void OnRunTestSuite();
1322 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
1323 * For example NAMESX, channel mode +u and +I, and UHNAMES. If the nick is set to an empty string by any
1324 * module, then this will cause the nickname not to be displayed at all.
1326 virtual void OnNamesListItem(User* issuer, Membership* item, std::string &prefixes, std::string &nick);
1328 virtual ModResult OnNumeric(User* user, unsigned int numeric, const std::string &text);
1330 /** Called for every time the user's host or ident changes, to indicate wether or not the 'Changing host'
1331 * message should be sent, if enabled. Certain modules such as auditorium may opt to hide this message
1332 * even if it is enabled.
1334 virtual ModResult OnHostCycle(User* user);
1336 /** Called whenever a result from /WHO is about to be returned
1337 * @param source The user running the /WHO query
1338 * @param user The user that this line of the query is about
1339 * @param channel The channel being queried (or NULL if not a channel query)
1340 * @param line The raw line to send; modifiable, if empty no line will be returned.
1342 virtual void OnSendWhoLine(User* source, User* user, Channel* channel, std::string& line);
1346 #define CONF_NO_ERROR 0x000000
1347 #define CONF_NOT_A_NUMBER 0x000010
1348 #define CONF_INT_NEGATIVE 0x000080
1349 #define CONF_VALUE_NOT_FOUND 0x000100
1350 #define CONF_FILE_NOT_FOUND 0x000200
1353 /** Allows reading of values from configuration files
1354 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1355 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1356 * Constructing the class using one parameter allows you to specify a path to your own configuration
1357 * file, otherwise, inspircd.conf is read.
1359 class CoreExport ConfigReader : public classbase
1367 /** Default constructor.
1368 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1369 * as specified when running ./configure.
1372 /** Default destructor.
1373 * This method destroys the ConfigReader class.
1377 /** Retrieves a value from the config file.
1378 * This method retrieves a value from the config file. Where multiple copies of the tag
1379 * exist in the config file, index indicates which of the values to retrieve.
1381 std::string ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds = false);
1382 /** Retrieves a value from the config file.
1383 * This method retrieves a value from the config file. Where multiple copies of the tag
1384 * exist in the config file, index indicates which of the values to retrieve. If the
1385 * tag is not found the default value is returned instead.
1387 std::string ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds = false);
1389 /** Retrieves a boolean value from the config file.
1390 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1391 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1392 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1394 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1395 /** Retrieves a boolean value from the config file.
1396 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1397 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1398 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1399 * If the tag is not found, the default value is used instead.
1401 bool ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index);
1403 /** Retrieves an integer value from the config file.
1404 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1405 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1406 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1407 * return CONF_INVALID_NUMBER to be returned. need_positive is set if the number must be non-negative.
1408 * If a negative number is placed into a tag which is specified positive, 0 will be returned and GetError()
1409 * will return CONF_INT_NEGATIVE. Note that need_positive is not suitable to get an unsigned int - you
1410 * should cast the result to achieve that effect.
1412 int ReadInteger(const std::string &tag, const std::string &name, int index, bool need_positive);
1413 /** Retrieves an integer value from the config file.
1414 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1415 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1416 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1417 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1418 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1419 * will return CONF_NOT_UNSIGNED. If the tag is not found, the default value is used instead.
1421 int ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool need_positive);
1423 /** Returns the last error to occur.
1424 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1425 * A call to GetError() resets the error flag back to 0.
1428 /** Counts the number of times a given tag appears in the config file.
1429 * This method counts the number of times a tag appears in a config file, for use where
1430 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1431 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1432 * multiple instance tag.
1434 int Enumerate(const std::string &tag);
1436 /** Returns the number of items within a tag.
1437 * For example if the tag was <test tag="blah" data="foo"> then this
1438 * function would return 2. Spaces and newlines both qualify as valid seperators
1441 int EnumerateValues(const std::string &tag, int index);
1446 /** Caches a text file into memory and can be used to retrieve lines from it.
1447 * This class contains methods for read-only manipulation of a text file in memory.
1448 * Either use the constructor type with one parameter to load a file into memory
1449 * at construction, or use the LoadFile method to load a file.
1451 class CoreExport FileReader : public classbase
1453 /** The file contents
1457 /** Content size in bytes
1459 unsigned long contentsize;
1461 /** Calculate content size in bytes
1466 /** Default constructor.
1467 * This method does not load any file into memory, you must use the LoadFile method
1468 * after constructing the class this way.
1472 /** Secondary constructor.
1473 * This method initialises the class with a file loaded into it ready for GetLine and
1474 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1477 FileReader(const std::string &filename);
1479 /** Default destructor.
1480 * This deletes the memory allocated to the file.
1484 /** Used to load a file.
1485 * This method loads a file into the class ready for GetLine and
1486 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1489 void LoadFile(const std::string &filename);
1491 /** Returns the whole content of the file as std::string
1493 std::string Contents();
1495 /** Returns the entire size of the file as std::string
1497 unsigned long ContentSize();
1499 /** Returns true if the file exists
1500 * This function will return false if the file could not be opened.
1504 /** Retrieve one line from the file.
1505 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1506 * the index was out of bounds, or the line had no data on it.
1508 std::string GetLine(int x);
1510 /** Returns the size of the file in lines.
1511 * This method returns the number of lines in the read file. If it is 0, no lines have been
1512 * read into memory, either because the file is empty or it does not exist, or cannot be
1513 * opened due to permission problems.
1518 /** A list of modules
1520 typedef std::vector<Module*> IntModuleList;
1522 /** An event handler iterator
1524 typedef IntModuleList::iterator EventHandlerIter;
1526 /** ModuleManager takes care of all things module-related
1529 class CoreExport ModuleManager : public classbase
1532 /** Holds a string describing the last module error to occur
1534 std::string LastModuleError;
1536 /** The feature names published by various modules
1538 featurelist Features;
1540 /** The interface names published by various modules
1542 interfacelist Interfaces;
1544 /** Total number of modules loaded into the ircd
1548 /** List of loaded modules and shared object/dll handles
1549 * keyed by module name
1551 std::map<std::string, Module*> Modules;
1557 } prioritizationState;
1560 /** Event handler hooks.
1561 * This needs to be public to be used by FOREACH_MOD and friends.
1563 IntModuleList EventHandlers[I_END];
1565 /** Simple, bog-standard, boring constructor.
1573 /** Change the priority of one event in a module.
1574 * Each module event has a list of modules which are attached to that event type.
1575 * If you wish to be called before or after other specific modules, you may use this
1576 * method (usually within void Module::Prioritize()) to set your events priority.
1577 * You may use this call in other methods too, however, this is not supported behaviour
1579 * @param mod The module to change the priority of
1580 * @param i The event to change the priority of
1581 * @param s The state you wish to use for this event. Use one of
1582 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1583 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1584 * to set it to be before or after one or more other modules.
1585 * @param modules If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1586 * then this contains a list of one or more modules your module must be
1587 * placed before or after. Your module will be placed before the highest
1588 * priority module in this list for PRIO_BEFORE, or after the lowest
1589 * priority module in this list for PRIORITY_AFTER.
1590 * @param sz The number of modules being passed for PRIO_BEFORE and PRIORITY_AFTER.
1591 * Defaults to 1, as most of the time you will only want to prioritize your module
1592 * to be before or after one other module.
1594 bool SetPriority(Module* mod, Implementation i, Priority s, Module** modules = NULL, size_t sz = 1);
1596 /** Change the priority of all events in a module.
1597 * @param mod The module to set the priority of
1598 * @param s The priority of all events in the module.
1599 * Note that with this method, it is not possible to effectively use
1600 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1601 * SetPriority method for this, where you may specify other modules to
1602 * be prioritized against.
1604 bool SetPriority(Module* mod, Priority s);
1606 /** Attach an event to a module.
1607 * You may later detatch the event with ModuleManager::Detach().
1608 * If your module is unloaded, all events are automatically detatched.
1609 * @param i Event type to attach
1610 * @param mod Module to attach event to
1611 * @return True if the event was attached
1613 bool Attach(Implementation i, Module* mod);
1615 /** Detatch an event from a module.
1616 * This is not required when your module unloads, as the core will
1617 * automatically detatch your module from all events it is attached to.
1618 * @param i Event type to detach
1619 * @param mod Module to detach event from
1620 * @param Detach true if the event was detached
1622 bool Detach(Implementation i, Module* mod);
1624 /** Attach an array of events to a module
1625 * @param i Event types (array) to attach
1626 * @param mod Module to attach events to
1628 void Attach(Implementation* i, Module* mod, size_t sz);
1630 /** Detach all events from a module (used on unload)
1631 * @param mod Module to detach from
1633 void DetachAll(Module* mod);
1635 /** Returns text describing the last module error
1636 * @return The last error message to occur
1638 std::string& LastError();
1640 /** Load a given module file
1641 * @param filename The file to load
1642 * @return True if the module was found and loaded
1644 bool Load(const char* filename);
1646 /** Unload a given module file
1647 * @param filename The file to unload
1648 * @return True if the module was unloaded
1650 bool Unload(const char* filename);
1652 /** Called by the InspIRCd constructor to load all modules from the config file.
1656 /** Get the total number of currently loaded modules
1657 * @return The number of loaded modules
1661 return this->ModCount;
1664 /** Find a module by name, and return a Module* to it.
1665 * This is preferred over iterating the module lists yourself.
1666 * @param name The module name to look up
1667 * @return A pointer to the module, or NULL if the module cannot be found
1669 Module* Find(const std::string &name);
1671 /** Publish a 'feature'.
1672 * There are two ways for a module to find another module it depends on.
1673 * Either by name, using InspIRCd::FindModule, or by feature, using this
1674 * function. A feature is an arbitary string which identifies something this
1675 * module can do. For example, if your module provides SSL support, but other
1676 * modules provide SSL support too, all the modules supporting SSL should
1677 * publish an identical 'SSL' feature. This way, any module requiring use
1678 * of SSL functions can just look up the 'SSL' feature using FindFeature,
1679 * then use the module pointer they are given.
1680 * @param FeatureName The case sensitive feature name to make available
1681 * @param Mod a pointer to your module class
1682 * @returns True on success, false if the feature is already published by
1685 bool PublishFeature(const std::string &FeatureName, Module* Mod);
1687 /** Publish a module to an 'interface'.
1688 * Modules which implement the same interface (the same way of communicating
1689 * with other modules) can publish themselves to an interface, using this
1690 * method. When they do so, they become part of a list of related or
1691 * compatible modules, and a third module may then query for that list
1692 * and know that all modules within that list offer the same API.
1693 * A prime example of this is the hashing modules, which all accept the
1694 * same types of Request class. Consider this to be similar to PublishFeature,
1695 * except for that multiple modules may publish the same 'feature'.
1696 * @param InterfaceName The case sensitive interface name to make available
1697 * @param Mod a pointer to your module class
1698 * @returns True on success, false on failure (there are currently no failure
1701 bool PublishInterface(const std::string &InterfaceName, Module* Mod);
1703 /** Return a pair saying how many other modules are currently using the
1704 * interfaces provided by module m.
1705 * @param m The module to count usage for
1706 * @return A pair, where the first value is the number of uses of the interface,
1707 * and the second value is the interface name being used.
1709 std::pair<int,std::string> GetInterfaceInstanceCount(Module* m);
1711 /** Mark your module as using an interface.
1712 * If you mark your module as using an interface, then that interface
1713 * module may not unload until your module has unloaded first.
1714 * This can be used to prevent crashes by ensuring code you depend on
1715 * is always in memory while your module is active.
1716 * @param InterfaceName The interface to use
1718 void UseInterface(const std::string &InterfaceName);
1720 /** Mark your module as finished with an interface.
1721 * If you used UseInterface() above, you should use this method when
1722 * your module is finished with the interface (usually in its destructor)
1723 * to allow the modules which implement the given interface to be unloaded.
1724 * @param InterfaceName The interface you are finished with using.
1726 void DoneWithInterface(const std::string &InterfaceName);
1728 /** Unpublish a 'feature'.
1729 * When your module exits, it must call this method for every feature it
1730 * is providing so that the feature table is cleaned up.
1731 * @param FeatureName the feature to remove
1733 bool UnpublishFeature(const std::string &FeatureName);
1735 /** Unpublish your module from an interface
1736 * When your module exits, it must call this method for every interface
1737 * it is part of so that the interfaces table is cleaned up. Only when
1738 * the last item is deleted from an interface does the interface get
1740 * @param InterfaceName the interface to be removed from
1741 * @param Mod The module to remove from the interface list
1743 bool UnpublishInterface(const std::string &InterfaceName, Module* Mod);
1745 /** Find a 'feature'.
1746 * There are two ways for a module to find another module it depends on.
1747 * Either by name, using InspIRCd::FindModule, or by feature, using the
1748 * InspIRCd::PublishFeature method. A feature is an arbitary string which
1749 * identifies something this module can do. For example, if your module
1750 * provides SSL support, but other modules provide SSL support too, all
1751 * the modules supporting SSL should publish an identical 'SSL' feature.
1752 * To find a module capable of providing the feature you want, simply
1753 * call this method with the feature name you are looking for.
1754 * @param FeatureName The feature name you wish to obtain the module for
1755 * @returns A pointer to a valid module class on success, NULL on failure.
1757 Module* FindFeature(const std::string &FeatureName);
1759 /** Find an 'interface'.
1760 * An interface is a list of modules which all implement the same API.
1761 * @param InterfaceName The Interface you wish to obtain the module
1763 * @return A pointer to a deque of Module*, or NULL if the interface
1766 modulelist* FindInterface(const std::string &InterfaceName);
1768 /** Determine if a module has published the named interface.
1769 * This could be used in, for example, OnLoadModule to pick up other modules that can be used.
1770 * @param mod The module to check.
1771 * @param InterfaceName the interface you want to check for
1772 * @return True if the module provides the interface, false otherwise.
1774 bool ModuleHasInterface(Module* mod, const std::string& InterfaceName);
1776 /** Given a pointer to a Module, return its filename
1777 * @param m The module pointer to identify
1778 * @return The module name or an empty string
1780 const std::string& GetModuleName(Module* m);
1782 /** Return a list of all modules matching the given filter
1783 * @param filter This int is a bitmask of flags set in Module::Flags,
1784 * such as VF_VENDOR or VF_STATIC. If you wish to receive a list of
1785 * all modules with no filtering, set this to 0.
1786 * @return The list of module names
1788 const std::vector<std::string> GetAllModuleNames(int filter);
1791 /** This definition is used as shorthand for the various classes
1792 * and functions needed to make a module loadable by the OS.
1793 * It defines the class factory and external init_module function.
1797 #define MODULE_INIT(y) \
1798 extern "C" DllExport Module * init_module() \
1802 BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
1804 switch ( nReason ) \
1806 case DLL_PROCESS_ATTACH: \
1807 case DLL_PROCESS_DETACH: \
1815 #define MODULE_INIT(y) \
1816 extern "C" DllExport Module * init_module() \
1822 #define COMMAND_INIT(c) MODULE_INIT(CommandModule<c>)