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_STATIC = 1, // module is static, cannot be /unloadmodule'd
34 VF_VENDOR = 2, // module is a vendor module (came in the original tarball, not 3rd party)
35 VF_SERVICEPROVIDER = 4, // module provides a service to other modules (can be a dependency)
36 VF_COMMON = 8, // module needs to be common on all servers in a network to link
37 VF_OPTCOMMON = 16 // module should be common on all servers for unsurprising behavior
40 /** Used with SendToMode()
47 /** Used to represent an event type, for user, channel or server
49 enum TargetTypeFlags {
56 /** Used to represent wether a message was PRIVMSG or NOTICE
63 #define MOD_RES_ALLOW (ModResult(1))
64 #define MOD_RES_PASSTHRU (ModResult(0))
65 #define MOD_RES_DENY (ModResult(-1))
67 /** Used to represent an allow/deny module result.
68 * Not constructed as an enum because it reverses the value logic of some functions;
69 * the compiler will inline accesses to have the same efficiency as integer operations.
73 ModResult() : res(0) {}
74 explicit ModResult(int r) : res(r) {}
75 bool operator==(const ModResult& r) const
79 bool operator!=(const ModResult& r) const
83 bool operator!() const
87 bool check(bool def) const
89 return (res == 1 || (res == 0 && def));
92 * Merges two results, preferring ALLOW to DENY
94 ModResult operator+(const ModResult& r) const
96 if (res == r.res || r.res == 0)
100 // they are different, and neither is passthru
101 return MOD_RES_ALLOW;
105 /** If you change the module API, change this value. */
106 #define API_VERSION 13000
110 /* Forward-delacare module for ModuleMessage etc
115 /** Low level definition of a FileReader classes file cache area -
116 * a text file seperated into lines.
118 typedef std::deque<std::string> file_cache;
120 /** A set of strings.
122 typedef file_cache string_list;
124 /** Holds a list of 'published features' for modules.
126 typedef std::map<std::string,Module*> featurelist;
128 /** Holds a list of modules which implement an interface
130 typedef std::deque<Module*> modulelist;
132 /** Holds a list of all modules which implement interfaces, by interface name
134 typedef std::map<std::string, std::pair<int, modulelist> > interfacelist;
137 * This #define allows us to call a method in all
138 * loaded modules in a readable simple way, e.g.:
139 * 'FOREACH_MOD(I_OnConnect,OnConnect(user));'
141 #define FOREACH_MOD(y,x) do { \
142 EventHandlerIter safei; \
143 for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ) \
151 catch (CoreException& modexcept) \
153 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
160 * This #define allows us to call a method in all
161 * loaded modules in a readable simple way and pass
162 * an instance pointer to the macro. e.g.:
163 * 'FOREACH_MOD_I(Instance, OnConnect, OnConnect(user));'
165 #define FOREACH_MOD_I(z,y,x) do { \
166 EventHandlerIter safei; \
167 for (EventHandlerIter _i = z->Modules->EventHandlers[y].begin(); _i != z->Modules->EventHandlers[y].end(); ) \
175 catch (CoreException& modexcept) \
177 z->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
184 * Custom module result handling loop. This is a paired macro, and should only
185 * be used with while_each_hook.
187 * See src/channels.cpp for an example of use.
189 #define DO_EACH_HOOK(z,n,v,args) \
191 EventHandlerIter iter_ ## n = z->Modules->EventHandlers[I_ ## n].begin(); \
192 while (iter_ ## n != z->Modules->EventHandlers[I_ ## n].end()) \
194 Module* mod_ ## n = *iter_ ## n; \
198 v = (mod_ ## n)->n args;
200 #define WHILE_EACH_HOOK(z,n) \
202 catch (CoreException& except_ ## n) \
204 z->Logs->Log("MODULE",DEFAULT,"Exception caught: %s", (except_ ## n).GetReason()); \
205 (void) mod_ ## n; /* catch mismatched pairs */ \
211 * Module result iterator
212 * Runs the given hook until some module returns a useful result.
214 * Example: ModResult result;
215 * FIRST_MOD_RESULT(ServerInstance, OnUserPreNick, result, (user, newnick))
217 #define FIRST_MOD_RESULT(z,n,v,args) do { \
218 v = MOD_RES_PASSTHRU; \
219 DO_EACH_HOOK(z,n,v,args) \
221 if (v != MOD_RES_PASSTHRU) \
224 WHILE_EACH_HOOK(z,n); \
227 /** Represents a non-local user.
228 * (in fact, any FD less than -1 does)
230 #define FD_MAGIC_NUMBER -42
231 /** Represents a fake user (i.e. a server)
233 #define FD_FAKEUSER_NUMBER -7
237 /** Is a local user */
238 #define IS_LOCAL(x) (x->GetFd() > -1)
239 /** Is a remote user */
240 #define IS_REMOTE(x) (x->GetFd() < 0)
241 /** Is a fake user */
242 #define IS_FAKE(x) (x->GetFd() == FD_FAKEUSER_NUMBER)
243 /** Is a module created user */
244 #define IS_MODULE_CREATED(x) (x->GetFd() == FD_MAGIC_NUMBER)
246 #define IS_OPER(x) (!x->oper.empty())
248 #define IS_AWAY(x) (!x->awaymsg.empty())
250 /** Holds a module's Version information.
251 * The four members (set by the constructor only) indicate details as to the version number
252 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
253 * The flags and API values represent the module flags and API version of the module.
254 * The API version of a module must match the API version of the core exactly for the module to
257 class CoreExport Version : public classbase
260 /** Version information.
262 const std::string version;
264 /** Flags and API version
266 const int Flags, API;
268 /** Initialize version class
270 Version(const std::string &customver, int flags,
271 int api_ver = API_VERSION, const std::string& src_rev = VERSION " r" REVISION);
274 /** The ModuleMessage class is the base class of Request and Event
275 * This class is used to represent a basic data structure which is passed
276 * between modules for safe inter-module communications.
278 class CoreExport ModuleMessage : public Extensible
283 virtual ~ModuleMessage() {};
286 /** The Request class is a unicast message directed at a given module.
287 * When this class is properly instantiated it may be sent to a module
288 * using the Send() method, which will call the given module's OnRequest
289 * method with this class as its parameter.
291 class CoreExport Request : public ModuleMessage
294 /** This member holds a pointer to arbitary data set by the emitter of the message
297 /** This should be a null-terminated string identifying the type of request,
298 * all modules should define this and use it to determine the nature of the
299 * request before they attempt to cast the Request in any way.
302 /** This is a pointer to the sender of the message, which can be used to
303 * directly trigger events, or to create a reply.
306 /** The single destination of the Request
310 /** Create a new Request
311 * This is for the 'old' way of casting whatever the data is
312 * to char* and hoping you get the right thing at the other end.
313 * This is slowly being depreciated in favor of the 'new' way.
315 Request(char* anydata, Module* src, Module* dst);
316 /** Create a new Request
317 * This is for the 'new' way of defining a subclass
318 * of Request and defining it in a common header,
319 * passing an object of your Request subclass through
320 * as a Request* and using the ID string to determine
321 * what to cast it back to and the other end. This is
322 * much safer as there are no casts not confirmed by
323 * the ID string, and all casts are child->parent and
324 * can be checked at runtime with dynamic_cast<>()
326 Request(Module* src, Module* dst, const char* idstr);
327 /** Fetch the Request data
330 /** Fetch the ID string
333 /** Fetch the request source
336 /** Fetch the request destination (should be 'this' in the receiving module)
339 /** Send the Request.
340 * Upon returning the result will be arbitary data returned by the module you
341 * sent the request to. It is up to your module to know what this data is and
342 * how to deal with it.
348 /** The Event class is a unicast message directed at all modules.
349 * When the class is properly instantiated it may be sent to all modules
350 * using the Send() method, which will trigger the OnEvent method in
351 * all modules passing the object as its parameter.
353 class CoreExport Event : public ModuleMessage
356 /** This member holds a pointer to arbitary data set by the emitter of the message
359 /** This is a pointer to the sender of the message, which can be used to
360 * directly trigger events, or to create a reply.
363 /** The event identifier.
364 * This is arbitary text which should be used to distinguish
365 * one type of event from another.
369 /** Create a new Event
371 Event(char* anydata, Module* src, const std::string &eventid);
372 /** Get the Event data
375 /** Get the event Source
378 /** Get the event ID.
379 * Use this to determine the event type for safe casting of the data
381 std::string GetEventID();
383 * The return result of an Event::Send() will always be NULL as
384 * no replies are expected.
386 char* Send(InspIRCd* ServerInstance);
389 /** Priority types which can be returned from Module::Prioritize()
391 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
393 /** Implementation-specific flags which may be set in Module::Implements()
398 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash,
399 I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois,
400 I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick,
401 I_OnUserMessage, I_OnUserNotice, I_OnMode, I_OnGetServerDescription, I_OnSyncUser,
402 I_OnSyncChannel, I_OnDecodeMetaData, I_OnWallops,
403 I_OnChangeHost, I_OnChangeName, I_OnAddLine, I_OnDelLine, I_OnExpireLine, I_OnCleanup,
404 I_OnUserPostNick, I_OnPreMode, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule,
405 I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite,
406 I_OnRawMode, I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckExtBan, I_OnCheckStringExtBan,
407 I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnPreTopicChange,
408 I_OnPostTopicChange, I_OnEvent, I_OnRequest, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan,
409 I_OnDelBan, I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead,
410 I_OnChangeLocalUserGECOS, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
411 I_OnPostOper, I_OnSyncNetwork, I_OnSetAway, I_OnUserList, I_OnPostCommand, I_OnPostJoin,
412 I_OnWhoisLine, I_OnBuildExemptList, I_OnRawSocketConnect, I_OnGarbageCollect, I_OnBufferFlushed,
413 I_OnText, I_OnPassCompare, I_OnRunTestSuite, I_OnNamesListItem, I_OnNumeric, I_OnHookIO,
414 I_OnHostCycle, I_OnPreRehash, I_OnModuleRehash, I_OnSendWhoLine, I_OnChangeIdent,
420 /** Base class for all InspIRCd modules
421 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
422 * its methods will be called when irc server events occur. class inherited from module must be
423 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
425 class CoreExport Module : public Extensible
428 /** File that this module was loaded from
430 std::string ModuleSourceFile;
432 /** Default constructor.
433 * Creates a module class.
434 * @param Me An instance of the InspIRCd class which will be saved into ServerInstance for your use
435 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
437 Module(InspIRCd* Me = ServerInstance);
439 /** Default destructor.
440 * destroys a module class
444 virtual void Prioritize()
448 /** Returns the version number of a Module.
449 * The method should return a Version object with its version information assigned via
452 virtual Version GetVersion();
454 /** Called when a user connects.
455 * The details of the connecting user are available to you in the parameter User *user
456 * @param user The user who is connecting
458 virtual void OnUserConnect(User* user);
460 /** Called when a user quits.
461 * The details of the exiting user are available to you in the parameter User *user
462 * This event is only called when the user is fully registered when they quit. To catch
463 * raw disconnections, use the OnUserDisconnect method.
464 * @param user The user who is quitting
465 * @param message The user's quit message (as seen by non-opers)
466 * @param oper_message The user's quit message (as seen by opers)
468 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
470 /** Called whenever a user's socket is closed.
471 * The details of the exiting user are available to you in the parameter User *user
472 * This event is called for all users, registered or not, as a cleanup method for modules
473 * which might assign resources to user, such as dns lookups, objects and sockets.
474 * @param user The user who is disconnecting
476 virtual void OnUserDisconnect(User* user);
478 /** Called whenever a channel is about to be deleted
479 * @param chan The channel being deleted
480 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
482 virtual ModResult OnChannelPreDelete(Channel *chan);
484 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
485 * @param chan The channel being deleted
487 virtual void OnChannelDelete(Channel* chan);
489 /** Called when a user joins a channel.
490 * The details of the joining user are available to you in the parameter User *user,
491 * and the details of the channel they have joined is available in the variable Channel *channel
492 * @param memb The channel membership being created
493 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
494 * to a channel due to the network sync.
495 * @param created This is true if the join created the channel
497 virtual void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list);
499 /** Called after a user joins a channel
500 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
502 * @param memb The channel membership created
504 virtual void OnPostJoin(Membership*);
506 /** Called when a user parts a channel.
507 * The details of the leaving user are available to you in the parameter User *user,
508 * and the details of the channel they have left is available in the variable Channel *channel
509 * @param memb The channel membership being destroyed
510 * @param partmessage The part message, or an empty string (may be modified)
512 virtual void OnUserPart(Membership* memb, std::string &partmessage, CUList& except_list);
514 /** Called on rehash.
515 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
516 * system. This is called in all cases -- including when this server will not execute the
517 * rehash because it is directed at a remote server.
519 * @param user The user performing the rehash, if any. If this is server initiated, the value of
520 * this variable will be NULL.
521 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
524 virtual void OnPreRehash(User* user, const std::string ¶meter);
526 /** Called on rehash.
527 * This method is called when a user initiates a module-specific rehash. This can be used to do
528 * expensive operations (such as reloading SSL certificates) that are not executed on a normal
529 * rehash for efficiency. A rehash of this type does not reload the core configuration.
531 * @param user The user performing the rehash.
532 * @param parameter The parameter given to REHASH
534 virtual void OnModuleRehash(User* user, const std::string ¶meter);
536 /** Called on rehash.
537 * This method is called after a rehash has completed. You should use it to reload any module
538 * configuration from the main configuration file.
539 * @param user The user that performed the rehash, if it was initiated by a user and that user
540 * is still connected.
542 virtual void OnRehash(User* user);
544 /** Called whenever a snotice is about to be sent to a snomask.
545 * snomask and type may both be modified; the message may not.
546 * @param snomask The snomask the message is going to (e.g. 'A')
547 * @param type The textual description the snomask will go to (e.g. 'OPER')
548 * @param message The text message to be sent via snotice
549 * @return 1 to block the snotice from being sent entirely, 0 else.
551 virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
553 /** Called whenever a user is about to join a channel, before any processing is done.
554 * Returning a value of 1 from this function stops the process immediately, causing no
555 * output to be sent to the user by the core. If you do this you must produce your own numerics,
556 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
557 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
561 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
562 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
563 * processing on the actual channel record at this point, however the channel NAME will still be passed in
564 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
565 * @param user The user joining the channel
566 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
567 * @param cname The channel name being joined. For new channels this is valid where chan is not.
568 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "o".
569 * You may alter this string to alter the user's modes on the channel.
570 * @param keygiven The key given to join the channel, or an empty string if none was provided
571 * @return 1 To prevent the join, 0 to allow it.
573 virtual ModResult OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string &privs, const std::string &keygiven);
575 /** Called whenever a user is about to be kicked.
576 * Returning a value of 1 from this function stops the process immediately, causing no
577 * output to be sent to the user by the core. If you do this you must produce your own numerics,
579 * @param source The user issuing the kick
580 * @param user The user being kicked
581 * @param chan The channel the user is being kicked from
582 * @param reason The kick reason
583 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
585 virtual ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason);
587 /** Called whenever a user is kicked.
588 * If this method is called, the kick is already underway and cannot be prevented, so
589 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
590 * @param source The user issuing the kick
591 * @param user The user being kicked
592 * @param chan The channel the user is being kicked from
593 * @param reason The kick reason
595 virtual void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except_list);
597 /** Called whenever a user opers locally.
598 * The User will contain the oper mode 'o' as this function is called after any modifications
599 * are made to the user's structure by the core.
600 * @param user The user who is opering up
601 * @param opertype The opers type name
603 virtual void OnOper(User* user, const std::string &opertype);
605 /** Called after a user opers locally.
606 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
607 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
608 * out the OPERTYPE, etc.
609 * @param user The user who is opering up
610 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
611 * @param opertype The opers type name
613 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
615 /** Called whenever a user types /INFO.
616 * The User will contain the information of the user who typed the command. Modules may use this
617 * method to output their own credits in /INFO (which is the ircd's version of an about box).
618 * It is purposefully not possible to modify any info that has already been output, or halt the list.
619 * You must write a 371 numeric to the user, containing your info in the following format:
621 * <nick> :information here
623 * @param user The user issuing /INFO
625 virtual void OnInfo(User* user);
627 /** Called whenever a /WHOIS is performed on a local user.
628 * The source parameter contains the details of the user who issued the WHOIS command, and
629 * the dest parameter contains the information of the user they are whoising.
630 * @param source The user issuing the WHOIS command
631 * @param dest The user who is being WHOISed
633 virtual void OnWhois(User* source, User* dest);
635 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
636 * Returning 1 from this function stops the process immediately, causing no
637 * output to be sent to the user by the core. If you do this you must produce your own numerics,
638 * notices etc. This is useful for modules which may want to filter invites to channels.
639 * @param source The user who is issuing the INVITE
640 * @param dest The user being invited
641 * @param channel The channel the user is being invited to
642 * @param timeout The time the invite will expire (0 == never)
643 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
645 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
647 /** Called after a user has been successfully invited to a channel.
648 * You cannot prevent the invite from occuring using this function, to do that,
649 * use OnUserPreInvite instead.
650 * @param source The user who is issuing the INVITE
651 * @param dest The user being invited
652 * @param channel The channel the user is being invited to
653 * @param timeout The time the invite will expire (0 == never)
655 virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout);
657 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
658 * Returning any nonzero value from this function stops the process immediately, causing no
659 * output to be sent to the user by the core. If you do this you must produce your own numerics,
660 * notices etc. This is useful for modules which may want to filter or redirect messages.
661 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
662 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
663 * of where the message is destined to be sent.
664 * @param user The user sending the message
665 * @param dest The target of the message (Channel* or User*)
666 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
667 * @param text Changeable text being sent by the user
668 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
669 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
670 * It will be ignored for private messages.
671 * @return 1 to deny the message, 0 to allow it
673 virtual ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
675 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
676 * Returning any nonzero value from this function stops the process immediately, causing no
677 * output to be sent to the user by the core. If you do this you must produce your own numerics,
678 * notices etc. This is useful for modules which may want to filter or redirect messages.
679 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
680 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
681 * of where the message is destined to be sent.
682 * You may alter the message text as you wish before relinquishing control to the next module
683 * in the chain, and if no other modules block the text this altered form of the text will be sent out
684 * to the user and possibly to other servers.
685 * @param user The user sending the message
686 * @param dest The target of the message (Channel* or User*)
687 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
688 * @param text Changeable text being sent by the user
689 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
690 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
691 * It will be ignored for private notices.
692 * @return 1 to deny the NOTICE, 0 to allow it
694 virtual ModResult OnUserPreNotice(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
696 /** Called whenever the server wants to build the exemption list for a channel, but is not directly doing a PRIVMSG or NOTICE.
697 * For example, the spanningtree protocol will call this event when passing a privmsg on (but not processing it directly).
698 * @param message_type The message type, either MSG_PRIVMSG or MSG_NOTICE
699 * @param chan The channel to build the exempt list of
700 * @param sender The original sender of the PRIVMSG or NOTICE
701 * @param status The status char to be used for the channel list
702 * @param exempt_list The exempt list to be populated
703 * @param text The original message text causing the exempt list to be built
705 virtual void OnBuildExemptList(MessageType message_type, Channel* chan, User* sender, char status, CUList &exempt_list, const std::string &text);
707 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
708 * Please note that although you can see remote nickchanges through this function, you should
709 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
710 * check user->server before taking any action (including returning nonzero from the method).
711 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
712 * module to generate some meaninful output.
713 * @param user The username changing their nick
714 * @param newnick Their new nickname
715 * @return 1 to deny the change, 0 to allow
717 virtual ModResult OnUserPreNick(User* user, const std::string &newnick);
719 /** Called after any PRIVMSG sent from a user.
720 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
721 * if target_type is TYPE_CHANNEL.
722 * @param user The user sending the message
723 * @param dest The target of the message
724 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
725 * @param text the text being sent by the user
726 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
728 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
730 /** Called after any NOTICE sent from a user.
731 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
732 * if target_type is TYPE_CHANNEL.
733 * @param user The user sending the message
734 * @param dest The target of the message
735 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
736 * @param text the text being sent by the user
737 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
739 virtual void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
741 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
742 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
743 * if target_type is TYPE_CHANNEL.
744 * The difference between this event and OnUserPreNotice/OnUserPreMessage is that delivery is gauranteed,
745 * the message has already been vetted. In the case of the other two methods, a later module may stop your
746 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
747 * @param user The user sending the message
748 * @param dest The target of the message
749 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
750 * @param text the text being sent by the user
751 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
753 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
755 /** Called after every MODE command sent from a user
756 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
757 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
758 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
759 * @param user The user sending the MODEs
760 * @param dest The target of the modes (User* or Channel*)
761 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
762 * @param text The actual modes and their parameters if any
763 * @param translate The translation types of the mode parameters
765 virtual void OnMode(User* user, void* dest, int target_type, const std::vector<std::string> &text, const std::vector<TranslateType> &translate);
767 /** Allows modules to alter or create server descriptions
768 * Whenever a module requires a server description, for example for display in
769 * WHOIS, this function is called in all modules. You may change or define the
770 * description given in std::string &description. If you do, this description
771 * will be shown in the WHOIS fields.
772 * @param servername The servername being searched for
773 * @param description Alterable server description for this server
775 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
777 /** Allows modules to synchronize data which relates to users during a netburst.
778 * When this function is called, it will be called from the module which implements
779 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
780 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
781 * (see below). This function will be called for every user visible on your side
782 * of the burst, allowing you to for example set modes, etc. Do not use this call to
783 * synchronize data which you have stored using class Extensible -- There is a specialist
784 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
785 * @param user The user being syncronized
786 * @param proto A pointer to the module handling network protocol
787 * @param opaque An opaque pointer set by the protocol module, should not be modified!
789 virtual void OnSyncUser(User* user, Module* proto, void* opaque);
791 /** Allows modules to synchronize data which relates to channels during a netburst.
792 * When this function is called, it will be called from the module which implements
793 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
794 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
795 * (see below). This function will be called for every user visible on your side
796 * of the burst, allowing you to for example set modes, etc.
798 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
800 * @param chan The channel being syncronized
801 * @param proto A pointer to the module handling network protocol
802 * @param opaque An opaque pointer set by the protocol module, should not be modified!
804 virtual void OnSyncChannel(Channel* chan, Module* proto, void* opaque);
806 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
807 * Whenever the linking module wants to send out data, but doesnt know what the data
808 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
809 * this method is called. You should use the ProtoSendMetaData function after you've
810 * correctly decided how the data should be represented, to send the metadata on its way if
811 * if it belongs to your module.
812 * @param proto A pointer to the module handling network protocol
813 * @param opaque An opaque pointer set by the protocol module, should not be modified!
814 * @param displayable If this value is true, the data is going to be displayed to a user,
815 * and not sent across the network. Use this to determine wether or not to show sensitive data.
817 virtual void OnSyncNetwork(Module* proto, void* opaque);
819 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
820 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
821 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
822 * @param target The Channel* or User* that data should be added to
823 * @param extname The extension name which is being sent
824 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
826 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
828 /** Implemented by modules which provide the ability to link servers.
829 * These modules will implement this method, which allows transparent sending of servermodes
830 * down the network link as a broadcast, without a module calling it having to know the format
831 * of the MODE command before the actual mode string.
833 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
834 * of how to use this function.
836 * @param opaque An opaque pointer set by the protocol module, should not be modified!
837 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
838 * @param target The Channel* or User* that modes should be sent for
839 * @param modeline The modes and parameters to be sent
840 * @param translate The translation types of the mode parameters
842 virtual void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::vector<std::string> &modeline, const std::vector<TranslateType> &translate);
844 /** Implemented by modules which provide the ability to link servers.
845 * These modules will implement this method, which allows metadata (extra data added to
846 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
847 * to other servers on a netburst and decoded at the other end by the same module on a
850 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
851 * how to use this function.
852 * @param opaque An opaque pointer set by the protocol module, should not be modified!
853 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
854 * @param target The Channel* or User* that metadata should be sent for
855 * @param extname The extension name to send metadata for
856 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
858 virtual void ProtoSendMetaData(void* opaque, Extensible* target, const std::string &extname, const std::string &extdata);
860 /** Called after every WALLOPS command.
861 * @param user The user sending the WALLOPS
862 * @param text The content of the WALLOPS message
864 virtual void OnWallops(User* user, const std::string &text);
866 /** Called whenever a user's hostname is changed.
867 * This event triggers after the host has been set.
868 * @param user The user whos host is being changed
869 * @param newhost The new hostname being set
871 virtual void OnChangeHost(User* user, const std::string &newhost);
873 /** Called whenever a user's GECOS (realname) is changed.
874 * This event triggers after the name has been set.
875 * @param user The user who's GECOS is being changed
876 * @param gecos The new GECOS being set on the user
878 virtual void OnChangeName(User* user, const std::string &gecos);
880 /** Called whenever a user's IDENT is changed.
881 * This event triggers after the name has been set.
882 * @param user The user who's IDENT is being changed
883 * @param gecos The new IDENT being set on the user
885 virtual void OnChangeIdent(User* user, const std::string &ident);
887 /** Called whenever an xline is added by a local user.
888 * This method is triggered after the line is added.
889 * @param source The sender of the line or NULL for local server
890 * @param line The xline being added
892 virtual void OnAddLine(User* source, XLine* line);
894 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
895 * This method is triggered after the line is deleted.
896 * @param source The user removing the line or NULL for local server
897 * @param line the line being deleted
899 virtual void OnDelLine(User* source, XLine* line);
901 /** Called whenever an xline expires.
902 * This method is triggered after the line is deleted.
903 * @param line The line being deleted.
905 virtual void OnExpireLine(XLine *line);
907 /** Called before your module is unloaded to clean up Extensibles.
908 * This method is called once for every user and channel on the network,
909 * so that when your module unloads it may clear up any remaining data
910 * in the form of Extensibles added using Extensible::Extend().
911 * If the target_type variable is TYPE_USER, then void* item refers to
912 * a User*, otherwise it refers to a Channel*.
913 * @param target_type The type of item being cleaned
914 * @param item A pointer to the item's class
916 virtual void OnCleanup(int target_type, void* item);
918 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
919 * have been applied. Please note that although you can see remote nickchanges through this function, you should
920 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
921 * check user->server before taking any action (including returning nonzero from the method).
922 * Because this method is called after the nickchange is taken place, no return values are possible
923 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
924 * @param user The user changing their nick
925 * @param oldnick The old nickname of the user before the nickchange
927 virtual void OnUserPostNick(User* user, const std::string &oldnick);
929 /** Called before any mode change, to allow a single access check for
930 * a full mode change (use OnRawMode to check individual modes)
932 * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
933 * OnRawMode for each individual mode
935 * @param source the user making the mode change
936 * @param dest the user destination of the umode change (NULL if a channel mode)
937 * @param channel the channel destination of the mode change
938 * @param parameters raw mode parameters; parameters[0] is the user/channel being changed
940 virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, const std::vector<std::string>& parameters);
942 /** Called when a 005 numeric is about to be output.
943 * The module should modify the 005 numeric if needed to indicate its features.
944 * @param output The 005 string to be modified if neccessary.
946 virtual void On005Numeric(std::string &output);
948 /** Called when a client is disconnected by KILL.
949 * If a client is killed by a server, e.g. a nickname collision or protocol error,
951 * Return 1 from this function to prevent the kill, and 0 from this function to allow
952 * it as normal. If you prevent the kill no output will be sent to the client, it is
953 * down to your module to generate this information.
954 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
955 * If you do so youre risking race conditions, desyncs and worse!
956 * @param source The user sending the KILL
957 * @param dest The user being killed
958 * @param reason The kill reason
959 * @return 1 to prevent the kill, 0 to allow
961 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
963 /** Called when an oper wants to disconnect a remote user via KILL
964 * @param source The user sending the KILL
965 * @param dest The user being killed
966 * @param reason The kill reason
968 virtual void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
970 /** Called whenever a module is loaded.
971 * mod will contain a pointer to the module, and string will contain its name,
972 * for example m_widgets.so. This function is primary for dependency checking,
973 * your module may decide to enable some extra features if it sees that you have
974 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
975 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
976 * but instead operate under reduced functionality, unless the dependency is
977 * absolutely neccessary (e.g. a module that extends the features of another
979 * @param mod A pointer to the new module
980 * @param name The new module's filename
982 virtual void OnLoadModule(Module* mod,const std::string &name);
984 /** Called whenever a module is unloaded.
985 * mod will contain a pointer to the module, and string will contain its name,
986 * for example m_widgets.so. This function is primary for dependency checking,
987 * your module may decide to enable some extra features if it sees that you have
988 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
989 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
990 * but instead operate under reduced functionality, unless the dependency is
991 * absolutely neccessary (e.g. a module that extends the features of another
993 * @param mod Pointer to the module being unloaded (still valid)
994 * @param name The filename of the module being unloaded
996 virtual void OnUnloadModule(Module* mod,const std::string &name);
998 /** Called once every five seconds for background processing.
999 * This timer can be used to control timed features. Its period is not accurate
1000 * enough to be used as a clock, but it is gauranteed to be called at least once in
1001 * any five second period, directly from the main loop of the server.
1002 * @param curtime The current timer derived from time(2)
1004 virtual void OnBackgroundTimer(time_t curtime);
1006 /** Called whenever any command is about to be executed.
1007 * This event occurs for all registered commands, wether they are registered in the core,
1008 * or another module, and for invalid commands. Invalid commands may only be sent to this
1009 * function when the value of validated is false. By returning 1 from this method you may prevent the
1010 * command being executed. If you do this, no output is created by the core, and it is
1011 * down to your module to produce any output neccessary.
1012 * Note that unless you return 1, you should not destroy any structures (e.g. by using
1013 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
1014 * method returns, it will be passed an invalid pointer to the user object and crash!)
1015 * @param command The command being executed
1016 * @param parameters An array of array of characters containing the parameters for the command
1017 * @param pcnt The nuimber of parameters passed to the command
1018 * @param user the user issuing the command
1019 * @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.
1020 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
1021 * @param original_line The entire original line as passed to the parser from the user
1022 * @return 1 to block the command, 0 to allow
1024 virtual ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, User *user, bool validated, const std::string &original_line);
1026 /** Called after any command has been executed.
1027 * This event occurs for all registered commands, wether they are registered in the core,
1028 * or another module, but it will not occur for invalid commands (e.g. ones which do not
1029 * exist within the command table). The result code returned by the command handler is
1031 * @param command The command being executed
1032 * @param parameters An array of array of characters containing the parameters for the command
1033 * @param pcnt The nuimber of parameters passed to the command
1034 * @param user the user issuing the command
1035 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
1036 * @param original_line The entire original line as passed to the parser from the user
1038 virtual void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, User *user, CmdResult result, const std::string &original_line);
1040 /** Called to check if a user who is connecting can now be allowed to register
1041 * If any modules return false for this function, the user is held in the waiting
1042 * state until all modules return true. For example a module which implements ident
1043 * lookups will continue to return false for a user until their ident lookup is completed.
1044 * Note that the registration timeout for a user overrides these checks, if the registration
1045 * timeout is reached, the user is disconnected even if modules report that the user is
1046 * not ready to connect.
1047 * @param user The user to check
1048 * @return true to indicate readiness, false if otherwise
1050 virtual ModResult OnCheckReady(User* user);
1052 /** Called whenever a user is about to register their connection (e.g. before the user
1053 * is sent the MOTD etc). Modules can use this method if they are performing a function
1054 * which must be done before the actual connection is completed (e.g. ident lookups,
1055 * dnsbl lookups, etc).
1056 * Note that you should NOT delete the user record here by causing a disconnection!
1057 * Use OnUserConnect for that instead.
1058 * @param user The user registering
1059 * @return 1 to indicate user quit, 0 to continue
1061 virtual ModResult OnUserRegister(User* user);
1063 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1064 * This method will always be called for each join, wether or not the channel is actually +i, and
1065 * determines the outcome of an if statement around the whole section of invite checking code.
1066 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1067 * @param user The user joining the channel
1068 * @param chan The channel being joined
1069 * @return 1 to explicitly allow the join, 0 to proceed as normal
1071 virtual ModResult OnCheckInvite(User* user, Channel* chan);
1073 /** Called whenever a mode character is processed.
1074 * Return 1 from this function to block the mode character from being processed entirely.
1075 * @param user The user who is sending the mode
1076 * @param chan The channel the mode is being sent to (or NULL if a usermode)
1077 * @param mode The mode character being set
1078 * @param param The parameter for the mode or an empty string
1079 * @param adding true of the mode is being added, false if it is being removed
1080 * @param pcnt The parameter count for the mode (0 or 1)
1081 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
1082 * to skip all permission checking. Please note that for remote mode changes, your return value
1085 virtual ModResult OnRawMode(User* user, Channel* chan, const char mode, const std::string ¶m, bool adding, int pcnt);
1087 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1088 * This method will always be called for each join, wether or not the channel is actually +k, and
1089 * determines the outcome of an if statement around the whole section of key checking code.
1090 * if the user specified no key, the keygiven string will be a valid but empty value.
1091 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1092 * @param user The user joining the channel
1093 * @param chan The channel being joined
1094 * @return 1 to explicitly allow the join, 0 to proceed as normal
1096 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
1098 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1099 * This method will always be called for each join, wether or not the channel is actually +l, and
1100 * determines the outcome of an if statement around the whole section of channel limit checking code.
1101 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1102 * @param user The user joining the channel
1103 * @param chan The channel being joined
1104 * @return 1 to explicitly allow the join, 0 to proceed as normal
1106 virtual ModResult OnCheckLimit(User* user, Channel* chan);
1108 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
1109 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
1110 * determines the outcome of an if statement around the whole section of ban checking code.
1111 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1112 * @param user The user joining the channel
1113 * @param chan The channel being joined
1114 * @return 1 to explicitly allow the join, 0 to proceed as normal. Return -1 to explicitly deny the
1115 * join to the channel.
1117 virtual ModResult OnCheckBan(User* user, Channel* chan);
1119 /* Called whenever checking whether or not a user is matched by an applicable extended bantype.
1120 * NOTE: may also trigger extra OnCheckStringExtBan events!
1121 * @param u The user to check
1122 * @param c The channel the user is on
1123 * @param type The type of extended ban to check for.
1124 * @returns 1 = exempt, 0 = no match, -1 = banned
1126 virtual ModResult OnCheckExtBan(User *u, Channel *c, char type);
1128 /** Called whenever checking whether or not a string is extbanned. NOTE: one OnCheckExtBan will also trigger a number of
1129 * OnCheckStringExtBan events for seperate host/IP comnbinations.
1130 * @returns 1 = exempt, 0 = no match, -1 = banned
1132 virtual ModResult OnCheckStringExtBan(const std::string &s, Channel *c, char type);
1134 /** Called on all /STATS commands
1135 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1136 * @param symbol the symbol provided to /STATS
1137 * @param user the user issuing the /STATS command
1138 * @param results A string_list to append results into. You should put all your results
1139 * into this string_list, rather than displaying them directly, so that your handler will
1140 * work when remote STATS queries are received.
1141 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1143 virtual ModResult OnStats(char symbol, User* user, string_list &results);
1145 /** Called whenever a change of a local users displayed host is attempted.
1146 * Return 1 to deny the host change, or 0 to allow it.
1147 * @param user The user whos host will be changed
1148 * @param newhost The new hostname
1149 * @return 1 to deny the host change, 0 to allow
1151 virtual ModResult OnChangeLocalUserHost(User* user, const std::string &newhost);
1153 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1154 * return 1 to deny the name change, or 0 to allow it.
1155 * @param user The user whos GECOS will be changed
1156 * @param newhost The new GECOS
1157 * @return 1 to deny the GECOS change, 0 to allow
1159 virtual ModResult OnChangeLocalUserGECOS(User* user, const std::string &newhost);
1161 /** Called before a topic is changed.
1162 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
1163 * As with other 'pre' events, you should only ever block a local event.
1164 * @param user The user changing the topic
1165 * @param chan The channels who's topic is being changed
1166 * @param topic The actual topic text
1167 * @param 1 to block the topic change, 0 to allow
1169 virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
1171 /** Called whenever a topic has been changed.
1172 * To block topic changes you must use OnPreTopicChange instead.
1173 * @param user The user changing the topic
1174 * @param chan The channels who's topic is being changed
1175 * @param topic The actual topic text
1177 virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
1179 /** Called whenever an Event class is sent to all module by another module.
1180 * Please see the documentation of Event::Send() for further information. The Event sent can
1181 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1182 * before doing anything to the event data, and you should *not* change the event data in any way!
1183 * @param event The Event class being received
1185 virtual void OnEvent(Event* event);
1187 /** Called whenever a Request class is sent to your module by another module.
1188 * Please see the documentation of Request::Send() for further information. The Request sent
1189 * can always be assumed to be non-NULL, you should not change the request object or its data.
1190 * Your method may return arbitary data in the char* result which the requesting module
1191 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1192 * @param request The Request class being received
1194 virtual const char* OnRequest(Request* request);
1196 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
1197 * The password field (from the config file) is in 'password' and is to be compared against
1198 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
1199 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
1200 * @param ex The object that's causing the authentication (User* for <oper> <connect:allow> etc, Server* for <link>).
1201 * @param password The password from the configuration file (the password="" value).
1202 * @param input The password entered by the user or whoever.
1203 * @param hashtype The hash value from the config
1204 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
1206 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
1208 /** Called whenever a user is given usermode +o, anywhere on the network.
1209 * You cannot override this and prevent it from happening as it is already happened and
1210 * such a task must be performed by another server. You can however bounce modes by sending
1211 * servermodes out to reverse mode changes.
1212 * @param user The user who is opering
1214 virtual void OnGlobalOper(User* user);
1216 /** Called after a user has fully connected and all modules have executed OnUserConnect
1217 * This event is informational only. You should not change any user information in this
1218 * event. To do so, use the OnUserConnect method to change the state of local users.
1219 * This is called for both local and remote users.
1220 * @param user The user who is connecting
1222 virtual void OnPostConnect(User* user);
1224 /** Called whenever a ban is added to a channel's list.
1225 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1226 * @param source The user adding the ban
1227 * @param channel The channel the ban is being added to
1228 * @param banmask The ban mask being added
1229 * @return 1 to block the ban, 0 to continue as normal
1231 virtual ModResult OnAddBan(User* source, Channel* channel,const std::string &banmask);
1233 /** Called whenever a ban is removed from a channel's list.
1234 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1235 * @param source The user deleting the ban
1236 * @param channel The channel the ban is being deleted from
1237 * @param banmask The ban mask being deleted
1238 * @return 1 to block the unban, 0 to continue as normal
1240 virtual ModResult OnDelBan(User* source, Channel* channel,const std::string &banmask);
1242 /** Called to install an I/O hook on an event handler
1243 * @param user The item to possibly install the I/O hook on
1244 * @param via The port that <user> connected on
1246 virtual void OnHookIO(EventHandler* user, ListenSocketBase* via);
1248 /** Called immediately after any connection is accepted. This is intended for raw socket
1249 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1250 * no information relating to a user record as the connection has not been assigned yet.
1251 * There are no return values from this call as all modules get an opportunity if required to
1252 * process the connection.
1253 * @param fd The file descriptor returned from accept()
1254 * @param client The client IP address and port
1255 * @param server The server IP address and port
1256 * @param localport The local port number the user connected to
1258 virtual void OnRawSocketAccept(int fd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
1260 /** Called immediately before any write() operation on a user's socket in the core. Because
1261 * this event is a low level event no user information is associated with it. It is intended
1262 * for use by modules which may wrap connections within another API such as SSL for example.
1263 * return a non-zero result if you have handled the write operation, in which case the core
1264 * will not call write().
1265 * @param fd The file descriptor of the socket
1266 * @param buffer A char* buffer being written
1267 * @param Number of characters to write
1268 * @return Number of characters actually written or 0 if you didn't handle the operation
1270 virtual int OnRawSocketWrite(int fd, const char* buffer, int count);
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 OnRawSocketClose(int fd);
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 OnRawSocketConnect(int fd);
1284 /** Called immediately before any read() operation on a client socket in the core.
1285 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1286 * when this event occurs.
1287 * Your event should return 1 if it has handled the reading itself, which prevents the core
1288 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1289 * the value of count. The value of readresult must be identical to an actual result that might
1290 * be returned from the read() system call, for example, number of bytes read upon success,
1291 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1292 * you MUST set readresult.
1293 * @param fd The file descriptor of the socket
1294 * @param buffer A char* buffer being read to
1295 * @param count The size of the buffer
1296 * @param readresult The amount of characters read, or 0
1297 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1299 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1301 /** Called whenever a user sets away or returns from being away.
1302 * The away message is available as a parameter, but should not be modified.
1303 * At this stage, it has already been copied into the user record.
1304 * If awaymsg is empty, the user is returning from away.
1305 * @param user The user setting away
1306 * @param awaymsg The away message of the user, or empty if returning from away
1307 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
1309 virtual ModResult OnSetAway(User* user, const std::string &awaymsg);
1311 /** Called whenever a NAMES list is requested.
1312 * You can produce the nameslist yourself, overriding the current list,
1313 * and if you do you must return 1. If you do not handle the names list,
1315 * @param The user requesting the NAMES list
1316 * @param Ptr The channel the NAMES list is requested for
1318 virtual ModResult OnUserList(User* user, Channel* Ptr);
1320 /** Called whenever a line of WHOIS output is sent to a user.
1321 * You may change the numeric and the text of the output by changing
1322 * the values numeric and text, but you cannot change the user the
1323 * numeric is sent to. You may however change the user's User values.
1324 * @param user The user the numeric is being sent to
1325 * @param dest The user being WHOISed
1326 * @param numeric The numeric of the line being sent
1327 * @param text The text of the numeric, including any parameters
1328 * @return nonzero to drop the line completely so that the user does not
1329 * receive it, or zero to allow the line to be sent.
1331 virtual ModResult OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
1333 /** Called at intervals for modules to garbage-collect any hashes etc.
1334 * Certain data types such as hash_map 'leak' buckets, which must be
1335 * tidied up and freed by copying into a new item every so often. This
1336 * method is called when it is time to do that.
1338 virtual void OnGarbageCollect();
1340 /** Called whenever a user's write buffer has been completely sent.
1341 * This is called when the user's write buffer is completely empty, and
1342 * there are no more pending bytes to be written and no pending write events
1343 * in the socket engine's queue. This may be used to refill the buffer with
1344 * data which is being spooled in a controlled manner, e.g. LIST lines.
1345 * @param user The user who's buffer is now empty.
1347 virtual void OnBufferFlushed(User* user);
1349 /** Add test suite hooks here. These are used for testing functionality of a module
1350 * via the --testsuite debugging parameter.
1352 virtual void OnRunTestSuite();
1354 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
1355 * For example NAMESX, channel mode +u and +I, and UHNAMES. If the nick is set to an empty string by any
1356 * module, then this will cause the nickname not to be displayed at all.
1358 virtual void OnNamesListItem(User* issuer, Membership* item, std::string &prefixes, std::string &nick);
1360 virtual ModResult OnNumeric(User* user, unsigned int numeric, const std::string &text);
1362 /** Called for every time the user's host or ident changes, to indicate wether or not the 'Changing host'
1363 * message should be sent, if enabled. Certain modules such as auditorium may opt to hide this message
1364 * even if it is enabled.
1366 virtual ModResult OnHostCycle(User* user);
1368 /** Called whenever a result from /WHO is about to be returned
1369 * @param source The user running the /WHO query
1370 * @param user The user that this line of the query is about
1371 * @param channel The channel being queried (or NULL if not a channel query)
1372 * @param line The raw line to send; modifiable, if empty no line will be returned.
1374 virtual void OnSendWhoLine(User* source, User* user, Channel* channel, std::string& line);
1378 #define CONF_NO_ERROR 0x000000
1379 #define CONF_NOT_A_NUMBER 0x000010
1380 #define CONF_INT_NEGATIVE 0x000080
1381 #define CONF_VALUE_NOT_FOUND 0x000100
1382 #define CONF_FILE_NOT_FOUND 0x000200
1385 /** Allows reading of values from configuration files
1386 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1387 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1388 * Constructing the class using one parameter allows you to specify a path to your own configuration
1389 * file, otherwise, inspircd.conf is read.
1391 class CoreExport ConfigReader : public classbase
1399 /** Default constructor.
1400 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1401 * as specified when running ./configure.
1403 ConfigReader(InspIRCd* Instance = ServerInstance);
1404 /** Default destructor.
1405 * This method destroys the ConfigReader class.
1409 /** Retrieves a value from the config file.
1410 * This method retrieves a value from the config file. Where multiple copies of the tag
1411 * exist in the config file, index indicates which of the values to retrieve.
1413 std::string ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds = false);
1414 /** Retrieves a value from the config file.
1415 * This method retrieves a value from the config file. Where multiple copies of the tag
1416 * exist in the config file, index indicates which of the values to retrieve. If the
1417 * tag is not found the default value is returned instead.
1419 std::string ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds = false);
1421 /** Retrieves a boolean value from the config file.
1422 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1423 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1424 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1426 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1427 /** Retrieves a boolean value from the config file.
1428 * This method retrieves a boolean 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. The values "1", "yes"
1430 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1431 * If the tag is not found, the default value is used instead.
1433 bool ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index);
1435 /** Retrieves an integer value from the config file.
1436 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1437 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1438 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1439 * return CONF_INVALID_NUMBER to be returned. need_positive is set if the number must be non-negative.
1440 * If a negative number is placed into a tag which is specified positive, 0 will be returned and GetError()
1441 * will return CONF_INT_NEGATIVE. Note that need_positive is not suitable to get an unsigned int - you
1442 * should cast the result to achieve that effect.
1444 int ReadInteger(const std::string &tag, const std::string &name, int index, bool need_positive);
1445 /** Retrieves an integer value from the config file.
1446 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1447 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1448 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1449 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1450 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1451 * will return CONF_NOT_UNSIGNED. If the tag is not found, the default value is used instead.
1453 int ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool need_positive);
1455 /** Returns the last error to occur.
1456 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1457 * A call to GetError() resets the error flag back to 0.
1460 /** Counts the number of times a given tag appears in the config file.
1461 * This method counts the number of times a tag appears in a config file, for use where
1462 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1463 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1464 * multiple instance tag.
1466 int Enumerate(const std::string &tag);
1468 /** Returns the number of items within a tag.
1469 * For example if the tag was <test tag="blah" data="foo"> then this
1470 * function would return 2. Spaces and newlines both qualify as valid seperators
1473 int EnumerateValues(const std::string &tag, int index);
1478 /** Caches a text file into memory and can be used to retrieve lines from it.
1479 * This class contains methods for read-only manipulation of a text file in memory.
1480 * Either use the constructor type with one parameter to load a file into memory
1481 * at construction, or use the LoadFile method to load a file.
1483 class CoreExport FileReader : public classbase
1485 /** The file contents
1489 /** Content size in bytes
1491 unsigned long contentsize;
1493 /** Calculate content size in bytes
1498 /** Default constructor.
1499 * This method does not load any file into memory, you must use the LoadFile method
1500 * after constructing the class this way.
1502 FileReader(InspIRCd* Instance = ServerInstance);
1504 /** Secondary constructor.
1505 * This method initialises the class with a file loaded into it ready for GetLine and
1506 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1509 FileReader(InspIRCd* Instance, const std::string &filename);
1511 /** Default destructor.
1512 * This deletes the memory allocated to the file.
1516 /** Used to load a file.
1517 * This method loads a file into the class ready for GetLine and
1518 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1521 void LoadFile(const std::string &filename);
1523 /** Returns the whole content of the file as std::string
1525 std::string Contents();
1527 /** Returns the entire size of the file as std::string
1529 unsigned long ContentSize();
1531 /** Returns true if the file exists
1532 * This function will return false if the file could not be opened.
1536 /** Retrieve one line from the file.
1537 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1538 * the index was out of bounds, or the line had no data on it.
1540 std::string GetLine(int x);
1542 /** Returns the size of the file in lines.
1543 * This method returns the number of lines in the read file. If it is 0, no lines have been
1544 * read into memory, either because the file is empty or it does not exist, or cannot be
1545 * opened due to permission problems.
1550 /** A DLLFactory (designed to load shared objects) containing a
1551 * handle to a module's init_module() function. Unfortunately,
1552 * due to the design of shared object systems we must keep this
1553 * hanging around, as if we remove this handle, we remove the
1554 * shared object file from memory (!)
1556 typedef DLLFactory<Module> ircd_module;
1558 /** A list of modules
1560 typedef std::vector<Module*> IntModuleList;
1562 /** An event handler iterator
1564 typedef IntModuleList::iterator EventHandlerIter;
1566 /** ModuleManager takes care of all things module-related
1569 class CoreExport ModuleManager : public classbase
1572 /** Holds a string describing the last module error to occur
1574 std::string LastModuleError;
1576 /** The feature names published by various modules
1578 featurelist Features;
1580 /** The interface names published by various modules
1582 interfacelist Interfaces;
1584 /** Total number of modules loaded into the ircd
1588 /** List of loaded modules and shared object/dll handles
1589 * keyed by module name
1591 std::map<std::string, std::pair<ircd_module*, Module*> > Modules;
1597 } prioritizationState;
1600 /** Event handler hooks.
1601 * This needs to be public to be used by FOREACH_MOD and friends.
1603 IntModuleList EventHandlers[I_END];
1605 /** Simple, bog-standard, boring constructor.
1613 /** Change the priority of one event in a module.
1614 * Each module event has a list of modules which are attached to that event type.
1615 * If you wish to be called before or after other specific modules, you may use this
1616 * method (usually within void Module::Prioritize()) to set your events priority.
1617 * You may use this call in other methods too, however, this is not supported behaviour
1619 * @param mod The module to change the priority of
1620 * @param i The event to change the priority of
1621 * @param s The state you wish to use for this event. Use one of
1622 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1623 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1624 * to set it to be before or after one or more other modules.
1625 * @param modules If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1626 * then this contains a list of one or more modules your module must be
1627 * placed before or after. Your module will be placed before the highest
1628 * priority module in this list for PRIO_BEFORE, or after the lowest
1629 * priority module in this list for PRIORITY_AFTER.
1630 * @param sz The number of modules being passed for PRIO_BEFORE and PRIORITY_AFTER.
1631 * Defaults to 1, as most of the time you will only want to prioritize your module
1632 * to be before or after one other module.
1634 bool SetPriority(Module* mod, Implementation i, Priority s, Module** modules = NULL, size_t sz = 1);
1636 /** Change the priority of all events in a module.
1637 * @param mod The module to set the priority of
1638 * @param s The priority of all events in the module.
1639 * Note that with this method, it is not possible to effectively use
1640 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1641 * SetPriority method for this, where you may specify other modules to
1642 * be prioritized against.
1644 bool SetPriority(Module* mod, Priority s);
1646 /** Attach an event to a module.
1647 * You may later detatch the event with ModuleManager::Detach().
1648 * If your module is unloaded, all events are automatically detatched.
1649 * @param i Event type to attach
1650 * @param mod Module to attach event to
1651 * @return True if the event was attached
1653 bool Attach(Implementation i, Module* mod);
1655 /** Detatch an event from a module.
1656 * This is not required when your module unloads, as the core will
1657 * automatically detatch your module from all events it is attached to.
1658 * @param i Event type to detach
1659 * @param mod Module to detach event from
1660 * @param Detach true if the event was detached
1662 bool Detach(Implementation i, Module* mod);
1664 /** Attach an array of events to a module
1665 * @param i Event types (array) to attach
1666 * @param mod Module to attach events to
1668 void Attach(Implementation* i, Module* mod, size_t sz);
1670 /** Detach all events from a module (used on unload)
1671 * @param mod Module to detach from
1673 void DetachAll(Module* mod);
1675 /** Returns text describing the last module error
1676 * @return The last error message to occur
1678 std::string& LastError();
1680 /** Load a given module file
1681 * @param filename The file to load
1682 * @return True if the module was found and loaded
1684 bool Load(const char* filename);
1686 /** Unload a given module file
1687 * @param filename The file to unload
1688 * @return True if the module was unloaded
1690 bool Unload(const char* filename);
1692 /** Called by the InspIRCd constructor to load all modules from the config file.
1696 /** Get the total number of currently loaded modules
1697 * @return The number of loaded modules
1701 return this->ModCount;
1704 /** Find a module by name, and return a Module* to it.
1705 * This is preferred over iterating the module lists yourself.
1706 * @param name The module name to look up
1707 * @return A pointer to the module, or NULL if the module cannot be found
1709 Module* Find(const std::string &name);
1711 /** Publish a 'feature'.
1712 * There are two ways for a module to find another module it depends on.
1713 * Either by name, using InspIRCd::FindModule, or by feature, using this
1714 * function. A feature is an arbitary string which identifies something this
1715 * module can do. For example, if your module provides SSL support, but other
1716 * modules provide SSL support too, all the modules supporting SSL should
1717 * publish an identical 'SSL' feature. This way, any module requiring use
1718 * of SSL functions can just look up the 'SSL' feature using FindFeature,
1719 * then use the module pointer they are given.
1720 * @param FeatureName The case sensitive feature name to make available
1721 * @param Mod a pointer to your module class
1722 * @returns True on success, false if the feature is already published by
1725 bool PublishFeature(const std::string &FeatureName, Module* Mod);
1727 /** Publish a module to an 'interface'.
1728 * Modules which implement the same interface (the same way of communicating
1729 * with other modules) can publish themselves to an interface, using this
1730 * method. When they do so, they become part of a list of related or
1731 * compatible modules, and a third module may then query for that list
1732 * and know that all modules within that list offer the same API.
1733 * A prime example of this is the hashing modules, which all accept the
1734 * same types of Request class. Consider this to be similar to PublishFeature,
1735 * except for that multiple modules may publish the same 'feature'.
1736 * @param InterfaceName The case sensitive interface name to make available
1737 * @param Mod a pointer to your module class
1738 * @returns True on success, false on failure (there are currently no failure
1741 bool PublishInterface(const std::string &InterfaceName, Module* Mod);
1743 /** Return a pair saying how many other modules are currently using the
1744 * interfaces provided by module m.
1745 * @param m The module to count usage for
1746 * @return A pair, where the first value is the number of uses of the interface,
1747 * and the second value is the interface name being used.
1749 std::pair<int,std::string> GetInterfaceInstanceCount(Module* m);
1751 /** Mark your module as using an interface.
1752 * If you mark your module as using an interface, then that interface
1753 * module may not unload until your module has unloaded first.
1754 * This can be used to prevent crashes by ensuring code you depend on
1755 * is always in memory while your module is active.
1756 * @param InterfaceName The interface to use
1758 void UseInterface(const std::string &InterfaceName);
1760 /** Mark your module as finished with an interface.
1761 * If you used UseInterface() above, you should use this method when
1762 * your module is finished with the interface (usually in its destructor)
1763 * to allow the modules which implement the given interface to be unloaded.
1764 * @param InterfaceName The interface you are finished with using.
1766 void DoneWithInterface(const std::string &InterfaceName);
1768 /** Unpublish a 'feature'.
1769 * When your module exits, it must call this method for every feature it
1770 * is providing so that the feature table is cleaned up.
1771 * @param FeatureName the feature to remove
1773 bool UnpublishFeature(const std::string &FeatureName);
1775 /** Unpublish your module from an interface
1776 * When your module exits, it must call this method for every interface
1777 * it is part of so that the interfaces table is cleaned up. Only when
1778 * the last item is deleted from an interface does the interface get
1780 * @param InterfaceName the interface to be removed from
1781 * @param Mod The module to remove from the interface list
1783 bool UnpublishInterface(const std::string &InterfaceName, Module* Mod);
1785 /** Find a 'feature'.
1786 * There are two ways for a module to find another module it depends on.
1787 * Either by name, using InspIRCd::FindModule, or by feature, using the
1788 * InspIRCd::PublishFeature method. A feature is an arbitary string which
1789 * identifies something this module can do. For example, if your module
1790 * provides SSL support, but other modules provide SSL support too, all
1791 * the modules supporting SSL should publish an identical 'SSL' feature.
1792 * To find a module capable of providing the feature you want, simply
1793 * call this method with the feature name you are looking for.
1794 * @param FeatureName The feature name you wish to obtain the module for
1795 * @returns A pointer to a valid module class on success, NULL on failure.
1797 Module* FindFeature(const std::string &FeatureName);
1799 /** Find an 'interface'.
1800 * An interface is a list of modules which all implement the same API.
1801 * @param InterfaceName The Interface you wish to obtain the module
1803 * @return A pointer to a deque of Module*, or NULL if the interface
1806 modulelist* FindInterface(const std::string &InterfaceName);
1808 /** Determine if a module has published the named interface.
1809 * This could be used in, for example, OnLoadModule to pick up other modules that can be used.
1810 * @param mod The module to check.
1811 * @param InterfaceName the interface you want to check for
1812 * @return True if the module provides the interface, false otherwise.
1814 bool ModuleHasInterface(Module* mod, const std::string& InterfaceName);
1816 /** Given a pointer to a Module, return its filename
1817 * @param m The module pointer to identify
1818 * @return The module name or an empty string
1820 const std::string& GetModuleName(Module* m);
1822 /** Return a list of all modules matching the given filter
1823 * @param filter This int is a bitmask of flags set in Module::Flags,
1824 * such as VF_VENDOR or VF_STATIC. If you wish to receive a list of
1825 * all modules with no filtering, set this to 0.
1826 * @return The list of module names
1828 const std::vector<std::string> GetAllModuleNames(int filter);
1831 /** This definition is used as shorthand for the various classes
1832 * and functions needed to make a module loadable by the OS.
1833 * It defines the class factory and external init_module function.
1837 #define MODULE_INIT(y) \
1838 extern "C" DllExport Module * init_module(InspIRCd* Me) \
1842 BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
1844 switch ( nReason ) \
1846 case DLL_PROCESS_ATTACH: \
1847 case DLL_PROCESS_DETACH: \
1855 #define MODULE_INIT(y) \
1856 extern "C" DllExport Module * init_module(InspIRCd* Me) \
1862 #define COMMAND_INIT(c) MODULE_INIT(CommandModule<c>)