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
41 /** Used with SendToMode()
48 /** Used to represent an event type, for user, channel or server
50 enum TargetTypeFlags {
57 /** Used to represent wether a message was PRIVMSG or NOTICE
64 #define MOD_RES_ALLOW (ModResult(1))
65 #define MOD_RES_PASSTHRU (ModResult(0))
66 #define MOD_RES_DENY (ModResult(-1))
68 /** Used to represent an allow/deny module result.
69 * Not constructed as an enum because it reverses the value logic of some functions;
70 * the compiler will inline accesses to have the same efficiency as integer operations.
74 ModResult() : res(0) {}
75 explicit ModResult(int r) : res(r) {}
76 bool operator==(const ModResult& r) const
80 bool operator!=(const ModResult& r) const
84 bool operator!() const
88 bool check(bool def) const
90 return (res == 1 || (res == 0 && def));
93 * Merges two results, preferring ALLOW to DENY
95 ModResult operator+(const ModResult& r) const
97 if (res == r.res || r.res == 0)
101 // they are different, and neither is passthru
102 return MOD_RES_ALLOW;
106 /** If you change the module API, change this value. */
107 #define API_VERSION 13000
111 /* Forward-delacare module for ModuleMessage etc
116 /** Low level definition of a FileReader classes file cache area -
117 * a text file seperated into lines.
119 typedef std::deque<std::string> file_cache;
121 /** A set of strings.
123 typedef file_cache string_list;
125 /** Holds a list of 'published features' for modules.
127 typedef std::map<std::string,Module*> featurelist;
129 /** Holds a list of modules which implement an interface
131 typedef std::deque<Module*> modulelist;
133 /** Holds a list of all modules which implement interfaces, by interface name
135 typedef std::map<std::string, std::pair<int, modulelist> > interfacelist;
138 * This #define allows us to call a method in all
139 * loaded modules in a readable simple way, e.g.:
140 * 'FOREACH_MOD(I_OnConnect,OnConnect(user));'
142 #define FOREACH_MOD(y,x) do { \
143 EventHandlerIter safei; \
144 for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ) \
152 catch (CoreException& modexcept) \
154 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
161 * This #define allows us to call a method in all
162 * loaded modules in a readable simple way and pass
163 * an instance pointer to the macro. e.g.:
164 * 'FOREACH_MOD_I(Instance, OnConnect, OnConnect(user));'
166 #define FOREACH_MOD_I(z,y,x) do { \
167 EventHandlerIter safei; \
168 for (EventHandlerIter _i = z->Modules->EventHandlers[y].begin(); _i != z->Modules->EventHandlers[y].end(); ) \
176 catch (CoreException& modexcept) \
178 z->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
185 * Custom module result handling loop. This is a paired macro, and should only
186 * be used with while_each_hook.
188 * See src/channels.cpp for an example of use.
190 #define DO_EACH_HOOK(z,n,v,args) \
192 EventHandlerIter iter_ ## n = z->Modules->EventHandlers[I_ ## n].begin(); \
193 while (iter_ ## n != z->Modules->EventHandlers[I_ ## n].end()) \
195 Module* mod_ ## n = *iter_ ## n; \
199 v = (mod_ ## n)->n args;
201 #define WHILE_EACH_HOOK(z,n) \
203 catch (CoreException& except_ ## n) \
205 z->Logs->Log("MODULE",DEFAULT,"Exception caught: %s", (except_ ## n).GetReason()); \
206 (void) mod_ ## n; /* catch mismatched pairs */ \
212 * Module result iterator
213 * Runs the given hook until some module returns a useful result.
215 * Example: ModResult result;
216 * FIRST_MOD_RESULT(ServerInstance, OnUserPreNick, result, (user, newnick))
218 #define FIRST_MOD_RESULT(z,n,v,args) do { \
219 v = MOD_RES_PASSTHRU; \
220 DO_EACH_HOOK(z,n,v,args) \
222 if (v != MOD_RES_PASSTHRU) \
225 WHILE_EACH_HOOK(z,n); \
228 /** Represents a non-local user.
229 * (in fact, any FD less than -1 does)
231 #define FD_MAGIC_NUMBER -42
232 /** Represents a fake user (i.e. a server)
234 #define FD_FAKEUSER_NUMBER -7
238 /** Is a local user */
239 #define IS_LOCAL(x) (x->GetFd() > -1)
240 /** Is a remote user */
241 #define IS_REMOTE(x) (x->GetFd() < 0)
242 /** Is a fake user */
243 #define IS_FAKE(x) (x->GetFd() == FD_FAKEUSER_NUMBER)
244 /** Is a module created user */
245 #define IS_MODULE_CREATED(x) (x->GetFd() == FD_MAGIC_NUMBER)
247 #define IS_OPER(x) (!x->oper.empty())
249 #define IS_AWAY(x) (!x->awaymsg.empty())
251 /** Holds a module's Version information.
252 * The four members (set by the constructor only) indicate details as to the version number
253 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
254 * The flags and API values represent the module flags and API version of the module.
255 * The API version of a module must match the API version of the core exactly for the module to
258 class CoreExport Version : public classbase
261 /** Module description
263 const std::string description;
264 /** Version information.
266 const std::string version;
268 /** Flags and API version
270 const int Flags, API;
272 /** Initialize version class
274 Version(const std::string &desc, int flags,
275 int api_ver = API_VERSION, const std::string& src_rev = VERSION " r" REVISION);
278 /** The ModuleMessage class is the base class of Request and Event
279 * This class is used to represent a basic data structure which is passed
280 * between modules for safe inter-module communications.
282 class CoreExport ModuleMessage : public Extensible
287 virtual ~ModuleMessage() {};
290 /** The Request class is a unicast message directed at a given module.
291 * When this class is properly instantiated it may be sent to a module
292 * using the Send() method, which will call the given module's OnRequest
293 * method with this class as its parameter.
295 class CoreExport Request : public ModuleMessage
298 /** This member holds a pointer to arbitary data set by the emitter of the message
301 /** This should be a null-terminated string identifying the type of request,
302 * all modules should define this and use it to determine the nature of the
303 * request before they attempt to cast the Request in any way.
306 /** This is a pointer to the sender of the message, which can be used to
307 * directly trigger events, or to create a reply.
310 /** The single destination of the Request
314 /** Create a new Request
315 * This is for the 'old' way of casting whatever the data is
316 * to char* and hoping you get the right thing at the other end.
317 * This is slowly being depreciated in favor of the 'new' way.
319 Request(char* anydata, Module* src, Module* dst);
320 /** Create a new Request
321 * This is for the 'new' way of defining a subclass
322 * of Request and defining it in a common header,
323 * passing an object of your Request subclass through
324 * as a Request* and using the ID string to determine
325 * what to cast it back to and the other end. This is
326 * much safer as there are no casts not confirmed by
327 * the ID string, and all casts are child->parent and
328 * can be checked at runtime with dynamic_cast<>()
330 Request(Module* src, Module* dst, const char* idstr);
331 /** Fetch the Request data
334 /** Fetch the ID string
337 /** Fetch the request source
340 /** Fetch the request destination (should be 'this' in the receiving module)
343 /** Send the Request.
344 * Upon returning the result will be arbitary data returned by the module you
345 * sent the request to. It is up to your module to know what this data is and
346 * how to deal with it.
352 /** The Event class is a unicast message directed at all modules.
353 * When the class is properly instantiated it may be sent to all modules
354 * using the Send() method, which will trigger the OnEvent method in
355 * all modules passing the object as its parameter.
357 class CoreExport Event : public ModuleMessage
360 /** This member holds a pointer to arbitary data set by the emitter of the message
363 /** This is a pointer to the sender of the message, which can be used to
364 * directly trigger events, or to create a reply.
367 /** The event identifier.
368 * This is arbitary text which should be used to distinguish
369 * one type of event from another.
373 /** Create a new Event
375 Event(char* anydata, Module* src, const std::string &eventid);
376 /** Get the Event data
379 /** Get the event Source
382 /** Get the event ID.
383 * Use this to determine the event type for safe casting of the data
385 std::string GetEventID();
387 * The return result of an Event::Send() will always be NULL as
388 * no replies are expected.
390 char* Send(InspIRCd* ServerInstance);
393 /** Priority types which can be returned from Module::Prioritize()
395 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
397 /** Implementation-specific flags which may be set in Module::Implements()
402 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash,
403 I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois,
404 I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick,
405 I_OnUserMessage, I_OnUserNotice, I_OnMode, I_OnGetServerDescription, I_OnSyncUser,
406 I_OnSyncChannel, I_OnDecodeMetaData, I_OnWallops,
407 I_OnChangeHost, I_OnChangeName, I_OnAddLine, I_OnDelLine, I_OnExpireLine, I_OnCleanup,
408 I_OnUserPostNick, I_OnPreMode, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule,
409 I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite,
410 I_OnRawMode, I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckChannelBan, I_OnExtBanCheck,
411 I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnPreTopicChange,
412 I_OnPostTopicChange, I_OnEvent, I_OnRequest, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan,
413 I_OnDelBan, I_OnChangeLocalUserGECOS, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
414 I_OnPostOper, I_OnSyncNetwork, I_OnSetAway, I_OnUserList, I_OnPostCommand, I_OnPostJoin,
415 I_OnWhoisLine, I_OnBuildExemptList, I_OnGarbageCollect, I_OnBufferFlushed,
416 I_OnText, I_OnPassCompare, I_OnRunTestSuite, I_OnNamesListItem, I_OnNumeric, I_OnHookIO,
417 I_OnHostCycle, I_OnPreRehash, I_OnModuleRehash, I_OnSendWhoLine, I_OnChangeIdent,
423 /** Base class for all InspIRCd modules
424 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
425 * its methods will be called when irc server events occur. class inherited from module must be
426 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
428 class CoreExport Module : public Extensible
431 /** File that this module was loaded from
433 std::string ModuleSourceFile;
435 /** Default constructor.
436 * Creates a module class.
437 * @param Me An instance of the InspIRCd class which will be saved into ServerInstance for your use
438 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
440 Module(InspIRCd* Me = ServerInstance);
442 /** Default destructor.
443 * destroys a module class
447 virtual void Prioritize()
451 /** Returns the version number of a Module.
452 * The method should return a Version object with its version information assigned via
455 virtual Version GetVersion() = 0;
457 /** Called when a user connects.
458 * The details of the connecting user are available to you in the parameter User *user
459 * @param user The user who is connecting
461 virtual void OnUserConnect(User* user);
463 /** Called when a user quits.
464 * The details of the exiting user are available to you in the parameter User *user
465 * This event is only called when the user is fully registered when they quit. To catch
466 * raw disconnections, use the OnUserDisconnect method.
467 * @param user The user who is quitting
468 * @param message The user's quit message (as seen by non-opers)
469 * @param oper_message The user's quit message (as seen by opers)
471 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
473 /** Called whenever a user's socket is closed.
474 * The details of the exiting user are available to you in the parameter User *user
475 * This event is called for all users, registered or not, as a cleanup method for modules
476 * which might assign resources to user, such as dns lookups, objects and sockets.
477 * @param user The user who is disconnecting
479 virtual void OnUserDisconnect(User* user);
481 /** Called whenever a channel is about to be deleted
482 * @param chan The channel being deleted
483 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
485 virtual ModResult OnChannelPreDelete(Channel *chan);
487 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
488 * @param chan The channel being deleted
490 virtual void OnChannelDelete(Channel* chan);
492 /** Called when a user joins a channel.
493 * The details of the joining user are available to you in the parameter User *user,
494 * and the details of the channel they have joined is available in the variable Channel *channel
495 * @param memb The channel membership being created
496 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
497 * to a channel due to the network sync.
498 * @param created This is true if the join created the channel
500 virtual void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list);
502 /** Called after a user joins a channel
503 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
505 * @param memb The channel membership created
507 virtual void OnPostJoin(Membership*);
509 /** Called when a user parts a channel.
510 * The details of the leaving user are available to you in the parameter User *user,
511 * and the details of the channel they have left is available in the variable Channel *channel
512 * @param memb The channel membership being destroyed
513 * @param partmessage The part message, or an empty string (may be modified)
515 virtual void OnUserPart(Membership* memb, std::string &partmessage, CUList& except_list);
517 /** Called on rehash.
518 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
519 * system. This is called in all cases -- including when this server will not execute the
520 * rehash because it is directed at a remote server.
522 * @param user The user performing the rehash, if any. If this is server initiated, the value of
523 * this variable will be NULL.
524 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
527 virtual void OnPreRehash(User* user, const std::string ¶meter);
529 /** Called on rehash.
530 * This method is called when a user initiates a module-specific rehash. This can be used to do
531 * expensive operations (such as reloading SSL certificates) that are not executed on a normal
532 * rehash for efficiency. A rehash of this type does not reload the core configuration.
534 * @param user The user performing the rehash.
535 * @param parameter The parameter given to REHASH
537 virtual void OnModuleRehash(User* user, const std::string ¶meter);
539 /** Called on rehash.
540 * This method is called after a rehash has completed. You should use it to reload any module
541 * configuration from the main configuration file.
542 * @param user The user that performed the rehash, if it was initiated by a user and that user
543 * is still connected.
545 virtual void OnRehash(User* user);
547 /** Called whenever a snotice is about to be sent to a snomask.
548 * snomask and type may both be modified; the message may not.
549 * @param snomask The snomask the message is going to (e.g. 'A')
550 * @param type The textual description the snomask will go to (e.g. 'OPER')
551 * @param message The text message to be sent via snotice
552 * @return 1 to block the snotice from being sent entirely, 0 else.
554 virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
556 /** Called whenever a user is about to join a channel, before any processing is done.
557 * Returning a value of 1 from this function stops the process immediately, causing no
558 * output to be sent to the user by the core. If you do this you must produce your own numerics,
559 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
560 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
564 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
565 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
566 * processing on the actual channel record at this point, however the channel NAME will still be passed in
567 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
568 * @param user The user joining the channel
569 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
570 * @param cname The channel name being joined. For new channels this is valid where chan is not.
571 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "o".
572 * You may alter this string to alter the user's modes on the channel.
573 * @param keygiven The key given to join the channel, or an empty string if none was provided
574 * @return 1 To prevent the join, 0 to allow it.
576 virtual ModResult OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string &privs, const std::string &keygiven);
578 /** Called whenever a user is about to be kicked.
579 * Returning a value of 1 from this function stops the process immediately, causing no
580 * output to be sent to the user by the core. If you do this you must produce your own numerics,
582 * @param source The user issuing the kick
583 * @param user The user being kicked
584 * @param chan The channel the user is being kicked from
585 * @param reason The kick reason
586 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
588 virtual ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason);
590 /** Called whenever a user is kicked.
591 * If this method is called, the kick is already underway and cannot be prevented, so
592 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
593 * @param source The user issuing the kick
594 * @param user The user being kicked
595 * @param chan The channel the user is being kicked from
596 * @param reason The kick reason
598 virtual void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except_list);
600 /** Called whenever a user opers locally.
601 * The User will contain the oper mode 'o' as this function is called after any modifications
602 * are made to the user's structure by the core.
603 * @param user The user who is opering up
604 * @param opertype The opers type name
606 virtual void OnOper(User* user, const std::string &opertype);
608 /** Called after a user opers locally.
609 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
610 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
611 * out the OPERTYPE, etc.
612 * @param user The user who is opering up
613 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
614 * @param opertype The opers type name
616 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
618 /** Called whenever a user types /INFO.
619 * The User will contain the information of the user who typed the command. Modules may use this
620 * method to output their own credits in /INFO (which is the ircd's version of an about box).
621 * It is purposefully not possible to modify any info that has already been output, or halt the list.
622 * You must write a 371 numeric to the user, containing your info in the following format:
624 * <nick> :information here
626 * @param user The user issuing /INFO
628 virtual void OnInfo(User* user);
630 /** Called whenever a /WHOIS is performed on a local user.
631 * The source parameter contains the details of the user who issued the WHOIS command, and
632 * the dest parameter contains the information of the user they are whoising.
633 * @param source The user issuing the WHOIS command
634 * @param dest The user who is being WHOISed
636 virtual void OnWhois(User* source, User* dest);
638 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
639 * Returning 1 from this function stops the process immediately, causing no
640 * output to be sent to the user by the core. If you do this you must produce your own numerics,
641 * notices etc. This is useful for modules which may want to filter invites to channels.
642 * @param source The user who is issuing the INVITE
643 * @param dest The user being invited
644 * @param channel The channel the user is being invited to
645 * @param timeout The time the invite will expire (0 == never)
646 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
648 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
650 /** Called after a user has been successfully invited to a channel.
651 * You cannot prevent the invite from occuring using this function, to do that,
652 * use OnUserPreInvite instead.
653 * @param source The user who is issuing the INVITE
654 * @param dest The user being invited
655 * @param channel The channel the user is being invited to
656 * @param timeout The time the invite will expire (0 == never)
658 virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout);
660 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
661 * Returning any nonzero value from this function stops the process immediately, causing no
662 * output to be sent to the user by the core. If you do this you must produce your own numerics,
663 * notices etc. This is useful for modules which may want to filter or redirect messages.
664 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
665 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
666 * of where the message is destined to be sent.
667 * @param user The user sending the message
668 * @param dest The target of the message (Channel* or User*)
669 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
670 * @param text Changeable text being sent by the user
671 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
672 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
673 * It will be ignored for private messages.
674 * @return 1 to deny the message, 0 to allow it
676 virtual ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
678 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
679 * Returning any nonzero value from this function stops the process immediately, causing no
680 * output to be sent to the user by the core. If you do this you must produce your own numerics,
681 * notices etc. This is useful for modules which may want to filter or redirect messages.
682 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
683 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
684 * of where the message is destined to be sent.
685 * You may alter the message text as you wish before relinquishing control to the next module
686 * in the chain, and if no other modules block the text this altered form of the text will be sent out
687 * to the user and possibly to other servers.
688 * @param user The user sending the message
689 * @param dest The target of the message (Channel* or User*)
690 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
691 * @param text Changeable text being sent by the user
692 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
693 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
694 * It will be ignored for private notices.
695 * @return 1 to deny the NOTICE, 0 to allow it
697 virtual ModResult OnUserPreNotice(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
699 /** Called whenever the server wants to build the exemption list for a channel, but is not directly doing a PRIVMSG or NOTICE.
700 * For example, the spanningtree protocol will call this event when passing a privmsg on (but not processing it directly).
701 * @param message_type The message type, either MSG_PRIVMSG or MSG_NOTICE
702 * @param chan The channel to build the exempt list of
703 * @param sender The original sender of the PRIVMSG or NOTICE
704 * @param status The status char to be used for the channel list
705 * @param exempt_list The exempt list to be populated
706 * @param text The original message text causing the exempt list to be built
708 virtual void OnBuildExemptList(MessageType message_type, Channel* chan, User* sender, char status, CUList &exempt_list, const std::string &text);
710 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
711 * Please note that although you can see remote nickchanges through this function, you should
712 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
713 * check user->server before taking any action (including returning nonzero from the method).
714 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
715 * module to generate some meaninful output.
716 * @param user The username changing their nick
717 * @param newnick Their new nickname
718 * @return 1 to deny the change, 0 to allow
720 virtual ModResult OnUserPreNick(User* user, const std::string &newnick);
722 /** Called after any PRIVMSG sent from a user.
723 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
724 * if target_type is TYPE_CHANNEL.
725 * @param user The user sending the message
726 * @param dest The target of the message
727 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
728 * @param text the text being sent by the user
729 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
731 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
733 /** Called after any NOTICE sent from a user.
734 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
735 * if target_type is TYPE_CHANNEL.
736 * @param user The user sending the message
737 * @param dest The target of the message
738 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
739 * @param text the text being sent by the user
740 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
742 virtual void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
744 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
745 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
746 * if target_type is TYPE_CHANNEL.
747 * The difference between this event and OnUserPreNotice/OnUserPreMessage is that delivery is gauranteed,
748 * the message has already been vetted. In the case of the other two methods, a later module may stop your
749 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
750 * @param user The user sending the message
751 * @param dest The target of the message
752 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
753 * @param text the text being sent by the user
754 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
756 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
758 /** Called after every MODE command sent from a user
759 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
760 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
761 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
762 * @param user The user sending the MODEs
763 * @param dest The target of the modes (User* or Channel*)
764 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
765 * @param text The actual modes and their parameters if any
766 * @param translate The translation types of the mode parameters
768 virtual void OnMode(User* user, void* dest, int target_type, const std::vector<std::string> &text, const std::vector<TranslateType> &translate);
770 /** Allows modules to alter or create server descriptions
771 * Whenever a module requires a server description, for example for display in
772 * WHOIS, this function is called in all modules. You may change or define the
773 * description given in std::string &description. If you do, this description
774 * will be shown in the WHOIS fields.
775 * @param servername The servername being searched for
776 * @param description Alterable server description for this server
778 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
780 /** Allows modules to synchronize data which relates to users during a netburst.
781 * When this function is called, it will be called from the module which implements
782 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
783 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
784 * (see below). This function will be called for every user visible on your side
785 * of the burst, allowing you to for example set modes, etc. Do not use this call to
786 * synchronize data which you have stored using class Extensible -- There is a specialist
787 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
788 * @param user The user 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 OnSyncUser(User* user, Module* proto, void* opaque);
794 /** Allows modules to synchronize data which relates to channels during a netburst.
795 * When this function is called, it will be called from the module which implements
796 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
797 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
798 * (see below). This function will be called for every user visible on your side
799 * of the burst, allowing you to for example set modes, etc.
801 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
803 * @param chan The channel being syncronized
804 * @param proto A pointer to the module handling network protocol
805 * @param opaque An opaque pointer set by the protocol module, should not be modified!
807 virtual void OnSyncChannel(Channel* chan, Module* proto, void* opaque);
809 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
810 * Whenever the linking module wants to send out data, but doesnt know what the data
811 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
812 * this method is called. You should use the ProtoSendMetaData function after you've
813 * correctly decided how the data should be represented, to send the metadata on its way if
814 * if it belongs to your module.
815 * @param proto A pointer to the module handling network protocol
816 * @param opaque An opaque pointer set by the protocol module, should not be modified!
817 * @param displayable If this value is true, the data is going to be displayed to a user,
818 * and not sent across the network. Use this to determine wether or not to show sensitive data.
820 virtual void OnSyncNetwork(Module* proto, void* opaque);
822 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
823 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
824 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
825 * @param target The Channel* or User* that data should be added to
826 * @param extname The extension name which is being sent
827 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
829 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
831 /** Implemented by modules which provide the ability to link servers.
832 * These modules will implement this method, which allows transparent sending of servermodes
833 * down the network link as a broadcast, without a module calling it having to know the format
834 * of the MODE command before the actual mode string.
836 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
837 * of how to use this function.
839 * @param opaque An opaque pointer set by the protocol module, should not be modified!
840 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
841 * @param target The Channel* or User* that modes should be sent for
842 * @param modeline The modes and parameters to be sent
843 * @param translate The translation types of the mode parameters
845 virtual void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::vector<std::string> &modeline, const std::vector<TranslateType> &translate);
847 /** Implemented by modules which provide the ability to link servers.
848 * These modules will implement this method, which allows metadata (extra data added to
849 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
850 * to other servers on a netburst and decoded at the other end by the same module on a
853 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
854 * how to use this function.
855 * @param opaque An opaque pointer set by the protocol module, should not be modified!
856 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
857 * @param target The Channel* or User* that metadata should be sent for
858 * @param extname The extension name to send metadata for
859 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
861 virtual void ProtoSendMetaData(void* opaque, Extensible* target, const std::string &extname, const std::string &extdata);
863 /** Called after every WALLOPS command.
864 * @param user The user sending the WALLOPS
865 * @param text The content of the WALLOPS message
867 virtual void OnWallops(User* user, const std::string &text);
869 /** Called whenever a user's hostname is changed.
870 * This event triggers after the host has been set.
871 * @param user The user whos host is being changed
872 * @param newhost The new hostname being set
874 virtual void OnChangeHost(User* user, const std::string &newhost);
876 /** Called whenever a user's GECOS (realname) is changed.
877 * This event triggers after the name has been set.
878 * @param user The user who's GECOS is being changed
879 * @param gecos The new GECOS being set on the user
881 virtual void OnChangeName(User* user, const std::string &gecos);
883 /** Called whenever a user's IDENT is changed.
884 * This event triggers after the name has been set.
885 * @param user The user who's IDENT is being changed
886 * @param gecos The new IDENT being set on the user
888 virtual void OnChangeIdent(User* user, const std::string &ident);
890 /** Called whenever an xline is added by a local user.
891 * This method is triggered after the line is added.
892 * @param source The sender of the line or NULL for local server
893 * @param line The xline being added
895 virtual void OnAddLine(User* source, XLine* line);
897 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
898 * This method is triggered after the line is deleted.
899 * @param source The user removing the line or NULL for local server
900 * @param line the line being deleted
902 virtual void OnDelLine(User* source, XLine* line);
904 /** Called whenever an xline expires.
905 * This method is triggered after the line is deleted.
906 * @param line The line being deleted.
908 virtual void OnExpireLine(XLine *line);
910 /** Called before your module is unloaded to clean up Extensibles.
911 * This method is called once for every user and channel on the network,
912 * so that when your module unloads it may clear up any remaining data
913 * in the form of Extensibles added using Extensible::Extend().
914 * If the target_type variable is TYPE_USER, then void* item refers to
915 * a User*, otherwise it refers to a Channel*.
916 * @param target_type The type of item being cleaned
917 * @param item A pointer to the item's class
919 virtual void OnCleanup(int target_type, void* item);
921 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
922 * have been applied. Please note that although you can see remote nickchanges through this function, you should
923 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
924 * check user->server before taking any action (including returning nonzero from the method).
925 * Because this method is called after the nickchange is taken place, no return values are possible
926 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
927 * @param user The user changing their nick
928 * @param oldnick The old nickname of the user before the nickchange
930 virtual void OnUserPostNick(User* user, const std::string &oldnick);
932 /** Called before any mode change, to allow a single access check for
933 * a full mode change (use OnRawMode to check individual modes)
935 * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
936 * OnRawMode for each individual mode
938 * @param source the user making the mode change
939 * @param dest the user destination of the umode change (NULL if a channel mode)
940 * @param channel the channel destination of the mode change
941 * @param parameters raw mode parameters; parameters[0] is the user/channel being changed
943 virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, const std::vector<std::string>& parameters);
945 /** Called when a 005 numeric is about to be output.
946 * The module should modify the 005 numeric if needed to indicate its features.
947 * @param output The 005 string to be modified if neccessary.
949 virtual void On005Numeric(std::string &output);
951 /** Called when a client is disconnected by KILL.
952 * If a client is killed by a server, e.g. a nickname collision or protocol error,
954 * Return 1 from this function to prevent the kill, and 0 from this function to allow
955 * it as normal. If you prevent the kill no output will be sent to the client, it is
956 * down to your module to generate this information.
957 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
958 * If you do so youre risking race conditions, desyncs and worse!
959 * @param source The user sending the KILL
960 * @param dest The user being killed
961 * @param reason The kill reason
962 * @return 1 to prevent the kill, 0 to allow
964 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
966 /** Called when an oper wants to disconnect a remote user via KILL
967 * @param source The user sending the KILL
968 * @param dest The user being killed
969 * @param reason The kill reason
971 virtual void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
973 /** Called whenever a module is loaded.
974 * mod will contain a pointer to the module, and string will contain its name,
975 * for example m_widgets.so. This function is primary for dependency checking,
976 * your module may decide to enable some extra features if it sees that you have
977 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
978 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
979 * but instead operate under reduced functionality, unless the dependency is
980 * absolutely neccessary (e.g. a module that extends the features of another
982 * @param mod A pointer to the new module
983 * @param name The new module's filename
985 virtual void OnLoadModule(Module* mod,const std::string &name);
987 /** Called whenever a module is unloaded.
988 * mod will contain a pointer to the module, and string will contain its name,
989 * for example m_widgets.so. This function is primary for dependency checking,
990 * your module may decide to enable some extra features if it sees that you have
991 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
992 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
993 * but instead operate under reduced functionality, unless the dependency is
994 * absolutely neccessary (e.g. a module that extends the features of another
996 * @param mod Pointer to the module being unloaded (still valid)
997 * @param name The filename of the module being unloaded
999 virtual void OnUnloadModule(Module* mod,const std::string &name);
1001 /** Called once every five seconds for background processing.
1002 * This timer can be used to control timed features. Its period is not accurate
1003 * enough to be used as a clock, but it is gauranteed to be called at least once in
1004 * any five second period, directly from the main loop of the server.
1005 * @param curtime The current timer derived from time(2)
1007 virtual void OnBackgroundTimer(time_t curtime);
1009 /** Called whenever any command is about to be executed.
1010 * This event occurs for all registered commands, wether they are registered in the core,
1011 * or another module, and for invalid commands. Invalid commands may only be sent to this
1012 * function when the value of validated is false. By returning 1 from this method you may prevent the
1013 * command being executed. If you do this, no output is created by the core, and it is
1014 * down to your module to produce any output neccessary.
1015 * Note that unless you return 1, you should not destroy any structures (e.g. by using
1016 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
1017 * method returns, it will be passed an invalid pointer to the user object and crash!)
1018 * @param command The command being executed
1019 * @param parameters An array of array of characters containing the parameters for the command
1020 * @param pcnt The nuimber of parameters passed to the command
1021 * @param user the user issuing the command
1022 * @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.
1023 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
1024 * @param original_line The entire original line as passed to the parser from the user
1025 * @return 1 to block the command, 0 to allow
1027 virtual ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, User *user, bool validated, const std::string &original_line);
1029 /** Called after any command has been executed.
1030 * This event occurs for all registered commands, wether they are registered in the core,
1031 * or another module, but it will not occur for invalid commands (e.g. ones which do not
1032 * exist within the command table). The result code returned by the command handler is
1034 * @param command The command being executed
1035 * @param parameters An array of array of characters containing the parameters for the command
1036 * @param pcnt The nuimber of parameters passed to the command
1037 * @param user the user issuing the command
1038 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
1039 * @param original_line The entire original line as passed to the parser from the user
1041 virtual void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, User *user, CmdResult result, const std::string &original_line);
1043 /** Called to check if a user who is connecting can now be allowed to register
1044 * If any modules return false for this function, the user is held in the waiting
1045 * state until all modules return true. For example a module which implements ident
1046 * lookups will continue to return false for a user until their ident lookup is completed.
1047 * Note that the registration timeout for a user overrides these checks, if the registration
1048 * timeout is reached, the user is disconnected even if modules report that the user is
1049 * not ready to connect.
1050 * @param user The user to check
1051 * @return true to indicate readiness, false if otherwise
1053 virtual ModResult OnCheckReady(User* user);
1055 /** Called whenever a user is about to register their connection (e.g. before the user
1056 * is sent the MOTD etc). Modules can use this method if they are performing a function
1057 * which must be done before the actual connection is completed (e.g. ident lookups,
1058 * dnsbl lookups, etc).
1059 * Note that you should NOT delete the user record here by causing a disconnection!
1060 * Use OnUserConnect for that instead.
1061 * @param user The user registering
1062 * @return 1 to indicate user quit, 0 to continue
1064 virtual ModResult OnUserRegister(User* user);
1066 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1067 * This method will always be called for each join, wether or not the channel is actually +i, and
1068 * determines the outcome of an if statement around the whole section of invite checking code.
1069 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1070 * @param user The user joining the channel
1071 * @param chan The channel being joined
1072 * @return 1 to explicitly allow the join, 0 to proceed as normal
1074 virtual ModResult OnCheckInvite(User* user, Channel* chan);
1076 /** Called whenever a mode character is processed.
1077 * Return 1 from this function to block the mode character from being processed entirely.
1078 * @param user The user who is sending the mode
1079 * @param chan The channel the mode is being sent to (or NULL if a usermode)
1080 * @param mode The mode character being set
1081 * @param param The parameter for the mode or an empty string
1082 * @param adding true of the mode is being added, false if it is being removed
1083 * @param pcnt The parameter count for the mode (0 or 1)
1084 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
1085 * to skip all permission checking. Please note that for remote mode changes, your return value
1088 virtual ModResult OnRawMode(User* user, Channel* chan, const char mode, const std::string ¶m, bool adding, int pcnt);
1090 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1091 * This method will always be called for each join, wether or not the channel is actually +k, and
1092 * determines the outcome of an if statement around the whole section of key checking code.
1093 * if the user specified no key, the keygiven string will be a valid but empty value.
1094 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1095 * @param user The user joining the channel
1096 * @param chan The channel being joined
1097 * @return 1 to explicitly allow the join, 0 to proceed as normal
1099 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
1101 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1102 * This method will always be called for each join, wether or not the channel is actually +l, and
1103 * determines the outcome of an if statement around the whole section of channel limit checking code.
1104 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1105 * @param user The user joining the channel
1106 * @param chan The channel being joined
1107 * @return 1 to explicitly allow the join, 0 to proceed as normal
1109 virtual ModResult OnCheckLimit(User* user, Channel* chan);
1112 * Checks for a user's ban from the channel
1113 * @param user The user to check
1114 * @param chan The channel to check in
1115 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1116 * ban check, or MOD_RES_PASSTHRU to check bans normally
1118 virtual ModResult OnCheckChannelBan(User* user, Channel* chan);
1121 * Checks for a user's match of a single ban
1122 * @param user The user to check for match
1123 * @param chan The channel on which the match is being checked
1124 * @param mask The mask being checked
1125 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1126 * ban check, or MOD_RES_PASSTHRU to check bans normally
1128 virtual ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask);
1130 /** Checks for a match on a given extban type
1131 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1132 * ban check, or MOD_RES_PASSTHRU to check bans normally
1134 virtual ModResult OnExtBanCheck(User* user, Channel* chan, char type);
1136 /** Called on all /STATS commands
1137 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1138 * @param symbol the symbol provided to /STATS
1139 * @param user the user issuing the /STATS command
1140 * @param results A string_list to append results into. You should put all your results
1141 * into this string_list, rather than displaying them directly, so that your handler will
1142 * work when remote STATS queries are received.
1143 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1145 virtual ModResult OnStats(char symbol, User* user, string_list &results);
1147 /** Called whenever a change of a local users displayed host is attempted.
1148 * Return 1 to deny the host change, or 0 to allow it.
1149 * @param user The user whos host will be changed
1150 * @param newhost The new hostname
1151 * @return 1 to deny the host change, 0 to allow
1153 virtual ModResult OnChangeLocalUserHost(User* user, const std::string &newhost);
1155 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1156 * return 1 to deny the name change, or 0 to allow it.
1157 * @param user The user whos GECOS will be changed
1158 * @param newhost The new GECOS
1159 * @return 1 to deny the GECOS change, 0 to allow
1161 virtual ModResult OnChangeLocalUserGECOS(User* user, const std::string &newhost);
1163 /** Called before a topic is changed.
1164 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
1165 * As with other 'pre' events, you should only ever block a local event.
1166 * @param user The user changing the topic
1167 * @param chan The channels who's topic is being changed
1168 * @param topic The actual topic text
1169 * @param 1 to block the topic change, 0 to allow
1171 virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
1173 /** Called whenever a topic has been changed.
1174 * To block topic changes you must use OnPreTopicChange instead.
1175 * @param user The user changing the topic
1176 * @param chan The channels who's topic is being changed
1177 * @param topic The actual topic text
1179 virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
1181 /** Called whenever an Event class is sent to all module by another module.
1182 * Please see the documentation of Event::Send() for further information. The Event sent can
1183 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1184 * before doing anything to the event data, and you should *not* change the event data in any way!
1185 * @param event The Event class being received
1187 virtual void OnEvent(Event* event);
1189 /** Called whenever a Request class is sent to your module by another module.
1190 * Please see the documentation of Request::Send() for further information. The Request sent
1191 * can always be assumed to be non-NULL, you should not change the request object or its data.
1192 * Your method may return arbitary data in the char* result which the requesting module
1193 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1194 * @param request The Request class being received
1196 virtual const char* OnRequest(Request* request);
1198 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
1199 * The password field (from the config file) is in 'password' and is to be compared against
1200 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
1201 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
1202 * @param ex The object that's causing the authentication (User* for <oper> <connect:allow> etc, Server* for <link>).
1203 * @param password The password from the configuration file (the password="" value).
1204 * @param input The password entered by the user or whoever.
1205 * @param hashtype The hash value from the config
1206 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
1208 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
1210 /** Called whenever a user is given usermode +o, anywhere on the network.
1211 * You cannot override this and prevent it from happening as it is already happened and
1212 * such a task must be performed by another server. You can however bounce modes by sending
1213 * servermodes out to reverse mode changes.
1214 * @param user The user who is opering
1216 virtual void OnGlobalOper(User* user);
1218 /** Called after a user has fully connected and all modules have executed OnUserConnect
1219 * This event is informational only. You should not change any user information in this
1220 * event. To do so, use the OnUserConnect method to change the state of local users.
1221 * This is called for both local and remote users.
1222 * @param user The user who is connecting
1224 virtual void OnPostConnect(User* user);
1226 /** Called whenever a ban is added to a channel's list.
1227 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1228 * @param source The user adding the ban
1229 * @param channel The channel the ban is being added to
1230 * @param banmask The ban mask being added
1231 * @return 1 to block the ban, 0 to continue as normal
1233 virtual ModResult OnAddBan(User* source, Channel* channel,const std::string &banmask);
1235 /** Called whenever a ban is removed from a channel's list.
1236 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1237 * @param source The user deleting the ban
1238 * @param channel The channel the ban is being deleted from
1239 * @param banmask The ban mask being deleted
1240 * @return 1 to block the unban, 0 to continue as normal
1242 virtual ModResult OnDelBan(User* source, Channel* channel,const std::string &banmask);
1244 /** Called to install an I/O hook on an event handler
1245 * @param user The item to possibly install the I/O hook on
1246 * @param via The port that <user> connected on
1248 virtual void OnHookIO(StreamSocket*, ListenSocketBase* via);
1250 /** Called immediately after any connection is accepted. This is intended for raw socket
1251 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1252 * no information relating to a user record as the connection has not been assigned yet.
1253 * There are no return values from this call as all modules get an opportunity if required to
1254 * process the connection.
1255 * @param fd The file descriptor returned from accept()
1256 * @param client The client IP address and port
1257 * @param server The server IP address and port
1258 * @param localport The local port number the user connected to
1260 virtual void OnStreamSocketAccept(StreamSocket*, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
1263 * Called when a hooked stream has data to write, or when the socket
1264 * engine returns it as writable
1265 * @param socket The socket in question
1266 * @param sendq Data to send to the socket
1267 * @return 1 if the sendq has been completely emptied, 0 if there is
1268 * still data to send, and -1 if there was an error
1270 virtual int OnStreamSocketWrite(StreamSocket*, std::string& sendq);
1272 /** Called immediately before any socket is closed. When this event is called, shutdown()
1273 * has not yet been called on the socket.
1274 * @param fd The file descriptor of the socket prior to close()
1276 virtual void OnStreamSocketClose(StreamSocket*);
1278 /** Called immediately upon connection of an outbound BufferedSocket which has been hooked
1280 * @param fd The file descriptor of the socket immediately after connect()
1282 virtual void OnStreamSocketConnect(StreamSocket*);
1285 * Called when the stream socket has data to read
1286 * @param socket The socket that is ready
1287 * @param recvq The receive queue that new data should be appended to
1288 * @return 1 if new data has been read, 0 if no new data is ready (but the
1289 * socket is still connected), -1 if there was an error or close
1291 virtual int OnStreamSocketRead(StreamSocket*, std::string& recvq);
1293 /** Called whenever a user sets away or returns from being away.
1294 * The away message is available as a parameter, but should not be modified.
1295 * At this stage, it has already been copied into the user record.
1296 * If awaymsg is empty, the user is returning from away.
1297 * @param user The user setting away
1298 * @param awaymsg The away message of the user, or empty if returning from away
1299 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
1301 virtual ModResult OnSetAway(User* user, const std::string &awaymsg);
1303 /** Called whenever a NAMES list is requested.
1304 * You can produce the nameslist yourself, overriding the current list,
1305 * and if you do you must return 1. If you do not handle the names list,
1307 * @param The user requesting the NAMES list
1308 * @param Ptr The channel the NAMES list is requested for
1310 virtual ModResult OnUserList(User* user, Channel* Ptr);
1312 /** Called whenever a line of WHOIS output is sent to a user.
1313 * You may change the numeric and the text of the output by changing
1314 * the values numeric and text, but you cannot change the user the
1315 * numeric is sent to. You may however change the user's User values.
1316 * @param user The user the numeric is being sent to
1317 * @param dest The user being WHOISed
1318 * @param numeric The numeric of the line being sent
1319 * @param text The text of the numeric, including any parameters
1320 * @return nonzero to drop the line completely so that the user does not
1321 * receive it, or zero to allow the line to be sent.
1323 virtual ModResult OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
1325 /** Called at intervals for modules to garbage-collect any hashes etc.
1326 * Certain data types such as hash_map 'leak' buckets, which must be
1327 * tidied up and freed by copying into a new item every so often. This
1328 * method is called when it is time to do that.
1330 virtual void OnGarbageCollect();
1332 /** Called whenever a user's write buffer has been completely sent.
1333 * This is called when the user's write buffer is completely empty, and
1334 * there are no more pending bytes to be written and no pending write events
1335 * in the socket engine's queue. This may be used to refill the buffer with
1336 * data which is being spooled in a controlled manner, e.g. LIST lines.
1337 * @param user The user who's buffer is now empty.
1339 virtual void OnBufferFlushed(User* user);
1341 /** Add test suite hooks here. These are used for testing functionality of a module
1342 * via the --testsuite debugging parameter.
1344 virtual void OnRunTestSuite();
1346 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
1347 * For example NAMESX, channel mode +u and +I, and UHNAMES. If the nick is set to an empty string by any
1348 * module, then this will cause the nickname not to be displayed at all.
1350 virtual void OnNamesListItem(User* issuer, Membership* item, std::string &prefixes, std::string &nick);
1352 virtual ModResult OnNumeric(User* user, unsigned int numeric, const std::string &text);
1354 /** Called for every time the user's host or ident changes, to indicate wether or not the 'Changing host'
1355 * message should be sent, if enabled. Certain modules such as auditorium may opt to hide this message
1356 * even if it is enabled.
1358 virtual ModResult OnHostCycle(User* user);
1360 /** Called whenever a result from /WHO is about to be returned
1361 * @param source The user running the /WHO query
1362 * @param user The user that this line of the query is about
1363 * @param channel The channel being queried (or NULL if not a channel query)
1364 * @param line The raw line to send; modifiable, if empty no line will be returned.
1366 virtual void OnSendWhoLine(User* source, User* user, Channel* channel, std::string& line);
1370 #define CONF_NO_ERROR 0x000000
1371 #define CONF_NOT_A_NUMBER 0x000010
1372 #define CONF_INT_NEGATIVE 0x000080
1373 #define CONF_VALUE_NOT_FOUND 0x000100
1374 #define CONF_FILE_NOT_FOUND 0x000200
1377 /** Allows reading of values from configuration files
1378 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1379 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1380 * Constructing the class using one parameter allows you to specify a path to your own configuration
1381 * file, otherwise, inspircd.conf is read.
1383 class CoreExport ConfigReader : public classbase
1391 /** Default constructor.
1392 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1393 * as specified when running ./configure.
1395 ConfigReader(InspIRCd* Instance = ServerInstance);
1396 /** Default destructor.
1397 * This method destroys the ConfigReader class.
1401 /** Retrieves a value from the config file.
1402 * This method retrieves a value from the config file. Where multiple copies of the tag
1403 * exist in the config file, index indicates which of the values to retrieve.
1405 std::string ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds = false);
1406 /** Retrieves a value from the config file.
1407 * This method retrieves a value from the config file. Where multiple copies of the tag
1408 * exist in the config file, index indicates which of the values to retrieve. If the
1409 * tag is not found the default value is returned instead.
1411 std::string ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds = false);
1413 /** Retrieves a boolean value from the config file.
1414 * This method retrieves a boolean 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. The values "1", "yes"
1416 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1418 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1419 /** Retrieves a boolean value from the config file.
1420 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1421 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1422 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1423 * If the tag is not found, the default value is used instead.
1425 bool ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index);
1427 /** Retrieves an integer value from the config file.
1428 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1429 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1430 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1431 * return CONF_INVALID_NUMBER to be returned. need_positive is set if the number must be non-negative.
1432 * If a negative number is placed into a tag which is specified positive, 0 will be returned and GetError()
1433 * will return CONF_INT_NEGATIVE. Note that need_positive is not suitable to get an unsigned int - you
1434 * should cast the result to achieve that effect.
1436 int ReadInteger(const std::string &tag, const std::string &name, int index, bool need_positive);
1437 /** Retrieves an integer value from the config file.
1438 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1439 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1440 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1441 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1442 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1443 * will return CONF_NOT_UNSIGNED. If the tag is not found, the default value is used instead.
1445 int ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool need_positive);
1447 /** Returns the last error to occur.
1448 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1449 * A call to GetError() resets the error flag back to 0.
1452 /** Counts the number of times a given tag appears in the config file.
1453 * This method counts the number of times a tag appears in a config file, for use where
1454 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1455 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1456 * multiple instance tag.
1458 int Enumerate(const std::string &tag);
1460 /** Returns the number of items within a tag.
1461 * For example if the tag was <test tag="blah" data="foo"> then this
1462 * function would return 2. Spaces and newlines both qualify as valid seperators
1465 int EnumerateValues(const std::string &tag, int index);
1470 /** Caches a text file into memory and can be used to retrieve lines from it.
1471 * This class contains methods for read-only manipulation of a text file in memory.
1472 * Either use the constructor type with one parameter to load a file into memory
1473 * at construction, or use the LoadFile method to load a file.
1475 class CoreExport FileReader : public classbase
1477 /** The file contents
1481 /** Content size in bytes
1483 unsigned long contentsize;
1485 /** Calculate content size in bytes
1490 /** Default constructor.
1491 * This method does not load any file into memory, you must use the LoadFile method
1492 * after constructing the class this way.
1494 FileReader(InspIRCd* Instance = ServerInstance);
1496 /** Secondary constructor.
1497 * This method initialises the class with a file loaded into it ready for GetLine and
1498 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1501 FileReader(InspIRCd* Instance, const std::string &filename);
1503 /** Default destructor.
1504 * This deletes the memory allocated to the file.
1508 /** Used to load a file.
1509 * This method loads a file into the class ready for GetLine and
1510 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1513 void LoadFile(const std::string &filename);
1515 /** Returns the whole content of the file as std::string
1517 std::string Contents();
1519 /** Returns the entire size of the file as std::string
1521 unsigned long ContentSize();
1523 /** Returns true if the file exists
1524 * This function will return false if the file could not be opened.
1528 /** Retrieve one line from the file.
1529 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1530 * the index was out of bounds, or the line had no data on it.
1532 std::string GetLine(int x);
1534 /** Returns the size of the file in lines.
1535 * This method returns the number of lines in the read file. If it is 0, no lines have been
1536 * read into memory, either because the file is empty or it does not exist, or cannot be
1537 * opened due to permission problems.
1542 /** A DLLFactory (designed to load shared objects) containing a
1543 * handle to a module's init_module() function. Unfortunately,
1544 * due to the design of shared object systems we must keep this
1545 * hanging around, as if we remove this handle, we remove the
1546 * shared object file from memory (!)
1548 typedef DLLFactory<Module> ircd_module;
1550 /** A list of modules
1552 typedef std::vector<Module*> IntModuleList;
1554 /** An event handler iterator
1556 typedef IntModuleList::iterator EventHandlerIter;
1558 /** ModuleManager takes care of all things module-related
1561 class CoreExport ModuleManager : public classbase
1564 /** Holds a string describing the last module error to occur
1566 std::string LastModuleError;
1568 /** The feature names published by various modules
1570 featurelist Features;
1572 /** The interface names published by various modules
1574 interfacelist Interfaces;
1576 /** Total number of modules loaded into the ircd
1580 /** List of loaded modules and shared object/dll handles
1581 * keyed by module name
1583 std::map<std::string, std::pair<ircd_module*, Module*> > Modules;
1589 } prioritizationState;
1592 /** Event handler hooks.
1593 * This needs to be public to be used by FOREACH_MOD and friends.
1595 IntModuleList EventHandlers[I_END];
1597 /** Simple, bog-standard, boring constructor.
1605 /** Change the priority of one event in a module.
1606 * Each module event has a list of modules which are attached to that event type.
1607 * If you wish to be called before or after other specific modules, you may use this
1608 * method (usually within void Module::Prioritize()) to set your events priority.
1609 * You may use this call in other methods too, however, this is not supported behaviour
1611 * @param mod The module to change the priority of
1612 * @param i The event to change the priority of
1613 * @param s The state you wish to use for this event. Use one of
1614 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1615 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1616 * to set it to be before or after one or more other modules.
1617 * @param modules If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1618 * then this contains a list of one or more modules your module must be
1619 * placed before or after. Your module will be placed before the highest
1620 * priority module in this list for PRIO_BEFORE, or after the lowest
1621 * priority module in this list for PRIORITY_AFTER.
1622 * @param sz The number of modules being passed for PRIO_BEFORE and PRIORITY_AFTER.
1623 * Defaults to 1, as most of the time you will only want to prioritize your module
1624 * to be before or after one other module.
1626 bool SetPriority(Module* mod, Implementation i, Priority s, Module** modules = NULL, size_t sz = 1);
1628 /** Change the priority of all events in a module.
1629 * @param mod The module to set the priority of
1630 * @param s The priority of all events in the module.
1631 * Note that with this method, it is not possible to effectively use
1632 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1633 * SetPriority method for this, where you may specify other modules to
1634 * be prioritized against.
1636 bool SetPriority(Module* mod, Priority s);
1638 /** Attach an event to a module.
1639 * You may later detatch the event with ModuleManager::Detach().
1640 * If your module is unloaded, all events are automatically detatched.
1641 * @param i Event type to attach
1642 * @param mod Module to attach event to
1643 * @return True if the event was attached
1645 bool Attach(Implementation i, Module* mod);
1647 /** Detatch an event from a module.
1648 * This is not required when your module unloads, as the core will
1649 * automatically detatch your module from all events it is attached to.
1650 * @param i Event type to detach
1651 * @param mod Module to detach event from
1652 * @param Detach true if the event was detached
1654 bool Detach(Implementation i, Module* mod);
1656 /** Attach an array of events to a module
1657 * @param i Event types (array) to attach
1658 * @param mod Module to attach events to
1660 void Attach(Implementation* i, Module* mod, size_t sz);
1662 /** Detach all events from a module (used on unload)
1663 * @param mod Module to detach from
1665 void DetachAll(Module* mod);
1667 /** Returns text describing the last module error
1668 * @return The last error message to occur
1670 std::string& LastError();
1672 /** Load a given module file
1673 * @param filename The file to load
1674 * @return True if the module was found and loaded
1676 bool Load(const char* filename);
1678 /** Unload a given module file
1679 * @param filename The file to unload
1680 * @return True if the module was unloaded
1682 bool Unload(const char* filename);
1684 /** Called by the InspIRCd constructor to load all modules from the config file.
1688 /** Get the total number of currently loaded modules
1689 * @return The number of loaded modules
1693 return this->ModCount;
1696 /** Find a module by name, and return a Module* to it.
1697 * This is preferred over iterating the module lists yourself.
1698 * @param name The module name to look up
1699 * @return A pointer to the module, or NULL if the module cannot be found
1701 Module* Find(const std::string &name);
1703 /** Publish a 'feature'.
1704 * There are two ways for a module to find another module it depends on.
1705 * Either by name, using InspIRCd::FindModule, or by feature, using this
1706 * function. A feature is an arbitary string which identifies something this
1707 * module can do. For example, if your module provides SSL support, but other
1708 * modules provide SSL support too, all the modules supporting SSL should
1709 * publish an identical 'SSL' feature. This way, any module requiring use
1710 * of SSL functions can just look up the 'SSL' feature using FindFeature,
1711 * then use the module pointer they are given.
1712 * @param FeatureName The case sensitive feature name to make available
1713 * @param Mod a pointer to your module class
1714 * @returns True on success, false if the feature is already published by
1717 bool PublishFeature(const std::string &FeatureName, Module* Mod);
1719 /** Publish a module to an 'interface'.
1720 * Modules which implement the same interface (the same way of communicating
1721 * with other modules) can publish themselves to an interface, using this
1722 * method. When they do so, they become part of a list of related or
1723 * compatible modules, and a third module may then query for that list
1724 * and know that all modules within that list offer the same API.
1725 * A prime example of this is the hashing modules, which all accept the
1726 * same types of Request class. Consider this to be similar to PublishFeature,
1727 * except for that multiple modules may publish the same 'feature'.
1728 * @param InterfaceName The case sensitive interface name to make available
1729 * @param Mod a pointer to your module class
1730 * @returns True on success, false on failure (there are currently no failure
1733 bool PublishInterface(const std::string &InterfaceName, Module* Mod);
1735 /** Return a pair saying how many other modules are currently using the
1736 * interfaces provided by module m.
1737 * @param m The module to count usage for
1738 * @return A pair, where the first value is the number of uses of the interface,
1739 * and the second value is the interface name being used.
1741 std::pair<int,std::string> GetInterfaceInstanceCount(Module* m);
1743 /** Mark your module as using an interface.
1744 * If you mark your module as using an interface, then that interface
1745 * module may not unload until your module has unloaded first.
1746 * This can be used to prevent crashes by ensuring code you depend on
1747 * is always in memory while your module is active.
1748 * @param InterfaceName The interface to use
1750 void UseInterface(const std::string &InterfaceName);
1752 /** Mark your module as finished with an interface.
1753 * If you used UseInterface() above, you should use this method when
1754 * your module is finished with the interface (usually in its destructor)
1755 * to allow the modules which implement the given interface to be unloaded.
1756 * @param InterfaceName The interface you are finished with using.
1758 void DoneWithInterface(const std::string &InterfaceName);
1760 /** Unpublish a 'feature'.
1761 * When your module exits, it must call this method for every feature it
1762 * is providing so that the feature table is cleaned up.
1763 * @param FeatureName the feature to remove
1765 bool UnpublishFeature(const std::string &FeatureName);
1767 /** Unpublish your module from an interface
1768 * When your module exits, it must call this method for every interface
1769 * it is part of so that the interfaces table is cleaned up. Only when
1770 * the last item is deleted from an interface does the interface get
1772 * @param InterfaceName the interface to be removed from
1773 * @param Mod The module to remove from the interface list
1775 bool UnpublishInterface(const std::string &InterfaceName, Module* Mod);
1777 /** Find a 'feature'.
1778 * There are two ways for a module to find another module it depends on.
1779 * Either by name, using InspIRCd::FindModule, or by feature, using the
1780 * InspIRCd::PublishFeature method. A feature is an arbitary string which
1781 * identifies something this module can do. For example, if your module
1782 * provides SSL support, but other modules provide SSL support too, all
1783 * the modules supporting SSL should publish an identical 'SSL' feature.
1784 * To find a module capable of providing the feature you want, simply
1785 * call this method with the feature name you are looking for.
1786 * @param FeatureName The feature name you wish to obtain the module for
1787 * @returns A pointer to a valid module class on success, NULL on failure.
1789 Module* FindFeature(const std::string &FeatureName);
1791 /** Find an 'interface'.
1792 * An interface is a list of modules which all implement the same API.
1793 * @param InterfaceName The Interface you wish to obtain the module
1795 * @return A pointer to a deque of Module*, or NULL if the interface
1798 modulelist* FindInterface(const std::string &InterfaceName);
1800 /** Determine if a module has published the named interface.
1801 * This could be used in, for example, OnLoadModule to pick up other modules that can be used.
1802 * @param mod The module to check.
1803 * @param InterfaceName the interface you want to check for
1804 * @return True if the module provides the interface, false otherwise.
1806 bool ModuleHasInterface(Module* mod, const std::string& InterfaceName);
1808 /** Given a pointer to a Module, return its filename
1809 * @param m The module pointer to identify
1810 * @return The module name or an empty string
1812 const std::string& GetModuleName(Module* m);
1814 /** Return a list of all modules matching the given filter
1815 * @param filter This int is a bitmask of flags set in Module::Flags,
1816 * such as VF_VENDOR or VF_STATIC. If you wish to receive a list of
1817 * all modules with no filtering, set this to 0.
1818 * @return The list of module names
1820 const std::vector<std::string> GetAllModuleNames(int filter);
1823 /** This definition is used as shorthand for the various classes
1824 * and functions needed to make a module loadable by the OS.
1825 * It defines the class factory and external init_module function.
1829 #define MODULE_INIT(y) \
1830 extern "C" DllExport Module * init_module(InspIRCd* Me) \
1834 BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
1836 switch ( nReason ) \
1838 case DLL_PROCESS_ATTACH: \
1839 case DLL_PROCESS_DETACH: \
1847 #define MODULE_INIT(y) \
1848 extern "C" DllExport Module * init_module(InspIRCd* Me) \
1854 #define COMMAND_INIT(c) MODULE_INIT(CommandModule<c>)