1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
20 #include "inspsocket.h"
30 /** Used to define a set of behavior bits for a module
33 VF_NONE = 0, // module is not special at all
34 VF_STATIC = 1, // module is static, cannot be /unloadmodule'd
35 VF_VENDOR = 2, // module is a vendor module (came in the original tarball, not 3rd party)
36 VF_SERVICEPROVIDER = 4, // module provides a service to other modules (can be a dependency)
37 VF_COMMON = 8, // module needs to be common on all servers in a network to link
38 VF_OPTCOMMON = 16, // module should be common on all servers for unsurprising behavior
39 VF_CORE = 32 // module is a core command, can be assumed loaded on all servers
42 /** Used with SendToMode()
49 /** Used to represent an event type, for user, channel or server
51 enum TargetTypeFlags {
58 /** Used to represent wether a message was PRIVMSG or NOTICE
65 #define MOD_RES_ALLOW (ModResult(1))
66 #define MOD_RES_PASSTHRU (ModResult(0))
67 #define MOD_RES_DENY (ModResult(-1))
69 /** Used to represent an allow/deny module result.
70 * Not constructed as an enum because it reverses the value logic of some functions;
71 * the compiler will inline accesses to have the same efficiency as integer operations.
75 ModResult() : res(0) {}
76 explicit ModResult(int r) : res(r) {}
77 bool operator==(const ModResult& r) const
81 bool operator!=(const ModResult& r) const
85 bool operator!() const
89 bool check(bool def) const
91 return (res == 1 || (res == 0 && def));
94 * Merges two results, preferring ALLOW to DENY
96 ModResult operator+(const ModResult& r) const
98 if (res == r.res || r.res == 0)
102 // they are different, and neither is passthru
103 return MOD_RES_ALLOW;
107 /** If you change the module API in any way, increment this value.
108 * This MUST be a pure integer, with no parenthesis
110 #define API_VERSION 134
114 /* Forward-delacare module for ModuleMessage etc
119 /** Low level definition of a FileReader classes file cache area -
120 * a text file seperated into lines.
122 typedef std::deque<std::string> file_cache;
124 /** A set of strings.
126 typedef file_cache string_list;
128 /** Holds a list of 'published features' for modules.
130 typedef std::map<std::string,Module*> featurelist;
132 /** Holds a list of modules which implement an interface
134 typedef std::deque<Module*> modulelist;
136 /** Holds a list of all modules which implement interfaces, by interface name
138 typedef std::map<std::string, std::pair<int, modulelist> > interfacelist;
141 * This #define allows us to call a method in all
142 * loaded modules in a readable simple way, e.g.:
143 * 'FOREACH_MOD(I_OnConnect,OnConnect(user));'
145 #define FOREACH_MOD(y,x) do { \
146 EventHandlerIter safei; \
147 for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ) \
155 catch (CoreException& modexcept) \
157 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
164 * Custom module result handling loop. This is a paired macro, and should only
165 * be used with while_each_hook.
167 * See src/channels.cpp for an example of use.
169 #define DO_EACH_HOOK(n,v,args) \
171 EventHandlerIter iter_ ## n = ServerInstance->Modules->EventHandlers[I_ ## n].begin(); \
172 while (iter_ ## n != ServerInstance->Modules->EventHandlers[I_ ## n].end()) \
174 Module* mod_ ## n = *iter_ ## n; \
178 v = (mod_ ## n)->n args;
180 #define WHILE_EACH_HOOK(n) \
182 catch (CoreException& except_ ## n) \
184 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s", (except_ ## n).GetReason()); \
185 (void) mod_ ## n; /* catch mismatched pairs */ \
191 * Module result iterator
192 * Runs the given hook until some module returns a useful result.
194 * Example: ModResult result;
195 * FIRST_MOD_RESULT(OnUserPreNick, result, (user, newnick))
197 #define FIRST_MOD_RESULT(n,v,args) do { \
198 v = MOD_RES_PASSTHRU; \
199 DO_EACH_HOOK(n,v,args) \
201 if (v != MOD_RES_PASSTHRU) \
204 WHILE_EACH_HOOK(n); \
207 /** Represents a non-local user.
208 * (in fact, any FD less than -1 does)
210 #define FD_MAGIC_NUMBER -42
211 /** Represents a fake user (i.e. a server)
213 #define FD_FAKEUSER_NUMBER -7
217 /** Is a local user */
218 #define IS_LOCAL(x) (x->GetFd() > -1)
219 /** Is a remote user */
220 #define IS_REMOTE(x) (x->GetFd() < 0)
221 /** Is a fake user */
222 #define IS_SERVER(x) (x->GetFd() == FD_FAKEUSER_NUMBER)
223 /** Is a module created user */
224 #define IS_MODULE_CREATED(x) (x->GetFd() == FD_MAGIC_NUMBER)
226 #define IS_OPER(x) (!x->oper.empty())
228 #define IS_AWAY(x) (!x->awaymsg.empty())
230 /** Holds a module's Version information.
231 * The members (set by the constructor only) indicate details as to the version number
232 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
234 * The core provides only one implementation of the template, causing a run-time linking
235 * error when attempting to load a module compiled against a different API_VERSION.
238 class CoreExport VersionBase : public classbase
241 /** Module description
243 const std::string description;
244 /** Version information.
246 const std::string version;
252 /** Initialize version class
254 VersionBase(const std::string &desc, int flags = VF_NONE, int dummy = 0, const std::string& src_rev = VERSION " r" REVISION);
257 typedef VersionBase<API_VERSION> Version;
259 /** The Request class is a unicast message directed at a given module.
260 * When this class is properly instantiated it may be sent to a module
261 * using the Send() method, which will call the given module's OnRequest
262 * method with this class as its parameter.
264 class CoreExport Request : public classbase
267 /** This should be a null-terminated string identifying the type of request,
268 * all modules should define this and use it to determine the nature of the
269 * request before they attempt to cast the Request in any way.
271 const char* const id;
272 /** This is a pointer to the sender of the message, which can be used to
273 * directly trigger events, or to create a reply.
275 Module* const source;
276 /** The single destination of the Request
280 /** Create a new Request
281 * This is for the 'new' way of defining a subclass
282 * of Request and defining it in a common header,
283 * passing an object of your Request subclass through
284 * as a Request* and using the ID string to determine
285 * what to cast it back to and the other end.
287 Request(Module* src, Module* dst, const char* idstr);
288 /** Send the Request.
294 /** The Event class is a unicast message directed at all modules.
295 * When the class is properly instantiated it may be sent to all modules
296 * using the Send() method, which will trigger the OnEvent method in
297 * all modules passing the object as its parameter.
299 class CoreExport Event : public classbase
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.
305 Module* const source;
306 /** The event identifier.
307 * This is arbitary text which should be used to distinguish
308 * one type of event from another.
310 const std::string id;
312 /** Create a new Event
314 Event(Module* src, const std::string &eventid);
316 * The return result of an Event::Send() will always be NULL as
317 * no replies are expected.
322 /** Priority types which can be returned from Module::Prioritize()
324 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
326 /** Implementation-specific flags which may be set in Module::Implements()
331 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash,
332 I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois,
333 I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick,
334 I_OnUserMessage, I_OnUserNotice, I_OnMode, I_OnGetServerDescription, I_OnSyncUser,
335 I_OnSyncChannel, I_OnDecodeMetaData, I_OnWallops,
336 I_OnChangeHost, I_OnChangeName, I_OnAddLine, I_OnDelLine, I_OnExpireLine,
337 I_OnUserPostNick, I_OnPreMode, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule,
338 I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite,
339 I_OnRawMode, I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckChannelBan, I_OnExtBanCheck,
340 I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnPreTopicChange,
341 I_OnPostTopicChange, I_OnEvent, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan,
342 I_OnDelBan, I_OnChangeLocalUserGECOS, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
343 I_OnPostOper, I_OnSyncNetwork, I_OnSetAway, I_OnUserList, I_OnPostCommand, I_OnPostJoin,
344 I_OnWhoisLine, I_OnBuildNeighborList, I_OnGarbageCollect,
345 I_OnText, I_OnPassCompare, I_OnRunTestSuite, I_OnNamesListItem, I_OnNumeric, I_OnHookIO,
346 I_OnPreRehash, I_OnModuleRehash, I_OnSendWhoLine, I_OnChangeIdent, I_OnChannelRestrictionApply,
352 /** Base class for all InspIRCd modules
353 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
354 * its methods will be called when irc server events occur. class inherited from module must be
355 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
357 class CoreExport Module : public Extensible
360 /** File that this module was loaded from
362 std::string ModuleSourceFile;
363 /** Reference to the dlopen() value
365 DLLManager* ModuleDLLManager;
367 /** Default constructor.
368 * Creates a module class.
369 * @param Me An instance of the InspIRCd class which will be saved into ServerInstance for your use
370 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
374 /** Clean up prior to destruction
375 * If you override, you must call this AFTER your module's cleanup
379 /** Default destructor.
380 * destroys a module class
384 virtual void Prioritize()
388 /** Returns the version number of a Module.
389 * The method should return a Version object with its version information assigned via
392 virtual Version GetVersion() = 0;
394 /** Called when a user connects.
395 * The details of the connecting user are available to you in the parameter User *user
396 * @param user The user who is connecting
398 virtual void OnUserConnect(User* user);
400 /** Called when a user quits.
401 * The details of the exiting user are available to you in the parameter User *user
402 * This event is only called when the user is fully registered when they quit. To catch
403 * raw disconnections, use the OnUserDisconnect method.
404 * @param user The user who is quitting
405 * @param message The user's quit message (as seen by non-opers)
406 * @param oper_message The user's quit message (as seen by opers)
408 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
410 /** Called whenever a user's socket is closed.
411 * The details of the exiting user are available to you in the parameter User *user
412 * This event is called for all users, registered or not, as a cleanup method for modules
413 * which might assign resources to user, such as dns lookups, objects and sockets.
414 * @param user The user who is disconnecting
416 virtual void OnUserDisconnect(User* user);
418 /** Called whenever a channel is about to be deleted
419 * @param chan The channel being deleted
420 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
422 virtual ModResult OnChannelPreDelete(Channel *chan);
424 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
425 * @param chan The channel being deleted
427 virtual void OnChannelDelete(Channel* chan);
429 /** Called when a user joins a channel.
430 * The details of the joining user are available to you in the parameter User *user,
431 * and the details of the channel they have joined is available in the variable Channel *channel
432 * @param memb The channel membership being created
433 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
434 * to a channel due to the network sync.
435 * @param created This is true if the join created the channel
437 virtual void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list);
439 /** Called after a user joins a channel
440 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
442 * @param memb The channel membership created
444 virtual void OnPostJoin(Membership*);
446 /** Called when a user parts a channel.
447 * The details of the leaving user are available to you in the parameter User *user,
448 * and the details of the channel they have left is available in the variable Channel *channel
449 * @param memb The channel membership being destroyed
450 * @param partmessage The part message, or an empty string (may be modified)
452 virtual void OnUserPart(Membership* memb, std::string &partmessage, CUList& except_list);
454 /** Called on rehash.
455 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
456 * system. This is called in all cases -- including when this server will not execute the
457 * rehash because it is directed at a remote server.
459 * @param user The user performing the rehash, if any. If this is server initiated, the value of
460 * this variable will be NULL.
461 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
464 virtual void OnPreRehash(User* user, const std::string ¶meter);
466 /** Called on rehash.
467 * This method is called when a user initiates a module-specific rehash. This can be used to do
468 * expensive operations (such as reloading SSL certificates) that are not executed on a normal
469 * rehash for efficiency. A rehash of this type does not reload the core configuration.
471 * @param user The user performing the rehash.
472 * @param parameter The parameter given to REHASH
474 virtual void OnModuleRehash(User* user, const std::string ¶meter);
476 /** Called on rehash.
477 * This method is called after a rehash has completed. You should use it to reload any module
478 * configuration from the main configuration file.
479 * @param user The user that performed the rehash, if it was initiated by a user and that user
480 * is still connected.
482 virtual void OnRehash(User* user);
484 /** Called whenever a snotice is about to be sent to a snomask.
485 * snomask and type may both be modified; the message may not.
486 * @param snomask The snomask the message is going to (e.g. 'A')
487 * @param type The textual description the snomask will go to (e.g. 'OPER')
488 * @param message The text message to be sent via snotice
489 * @return 1 to block the snotice from being sent entirely, 0 else.
491 virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
493 /** Called whenever a user is about to join a channel, before any processing is done.
494 * Returning a value of 1 from this function stops the process immediately, causing no
495 * output to be sent to the user by the core. If you do this you must produce your own numerics,
496 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
497 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
501 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
502 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
503 * processing on the actual channel record at this point, however the channel NAME will still be passed in
504 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
505 * @param user The user joining the channel
506 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
507 * @param cname The channel name being joined. For new channels this is valid where chan is not.
508 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "o".
509 * You may alter this string to alter the user's modes on the channel.
510 * @param keygiven The key given to join the channel, or an empty string if none was provided
511 * @return 1 To prevent the join, 0 to allow it.
513 virtual ModResult OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string &privs, const std::string &keygiven);
515 /** Called whenever a user is about to be kicked.
516 * Returning a value of 1 from this function stops the process immediately, causing no
517 * output to be sent to the user by the core. If you do this you must produce your own numerics,
519 * @param source The user issuing the kick
520 * @param user The user being kicked
521 * @param chan The channel the user is being kicked from
522 * @param reason The kick reason
523 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
525 virtual ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason);
527 /** Called whenever a user is kicked.
528 * If this method is called, the kick is already underway and cannot be prevented, so
529 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
530 * @param source The user issuing the kick
531 * @param user The user being kicked
532 * @param chan The channel the user is being kicked from
533 * @param reason The kick reason
535 virtual void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except_list);
537 /** Called whenever a user opers locally.
538 * The User will contain the oper mode 'o' as this function is called after any modifications
539 * are made to the user's structure by the core.
540 * @param user The user who is opering up
541 * @param opertype The opers type name
543 virtual void OnOper(User* user, const std::string &opertype);
545 /** Called after a user opers locally.
546 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
547 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
548 * out the OPERTYPE, etc.
549 * @param user The user who is opering up
550 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
551 * @param opertype The opers type name
553 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
555 /** Called whenever a user types /INFO.
556 * The User will contain the information of the user who typed the command. Modules may use this
557 * method to output their own credits in /INFO (which is the ircd's version of an about box).
558 * It is purposefully not possible to modify any info that has already been output, or halt the list.
559 * You must write a 371 numeric to the user, containing your info in the following format:
561 * <nick> :information here
563 * @param user The user issuing /INFO
565 virtual void OnInfo(User* user);
567 /** Called whenever a /WHOIS is performed on a local user.
568 * The source parameter contains the details of the user who issued the WHOIS command, and
569 * the dest parameter contains the information of the user they are whoising.
570 * @param source The user issuing the WHOIS command
571 * @param dest The user who is being WHOISed
573 virtual void OnWhois(User* source, User* dest);
575 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
576 * Returning 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,
578 * notices etc. This is useful for modules which may want to filter invites to channels.
579 * @param source The user who is issuing the INVITE
580 * @param dest The user being invited
581 * @param channel The channel the user is being invited to
582 * @param timeout The time the invite will expire (0 == never)
583 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
585 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
587 /** Called after a user has been successfully invited to a channel.
588 * You cannot prevent the invite from occuring using this function, to do that,
589 * use OnUserPreInvite instead.
590 * @param source The user who is issuing the INVITE
591 * @param dest The user being invited
592 * @param channel The channel the user is being invited to
593 * @param timeout The time the invite will expire (0 == never)
595 virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout);
597 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
598 * Returning any nonzero value from this function stops the process immediately, causing no
599 * output to be sent to the user by the core. If you do this you must produce your own numerics,
600 * notices etc. This is useful for modules which may want to filter or redirect messages.
601 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
602 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
603 * of where the message is destined to be sent.
604 * @param user The user sending the message
605 * @param dest The target of the message (Channel* or User*)
606 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
607 * @param text Changeable text being sent by the user
608 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
609 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
610 * It will be ignored for private messages.
611 * @return 1 to deny the message, 0 to allow it
613 virtual ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
615 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
616 * Returning any nonzero value from this function stops the process immediately, causing no
617 * output to be sent to the user by the core. If you do this you must produce your own numerics,
618 * notices etc. This is useful for modules which may want to filter or redirect messages.
619 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
620 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
621 * of where the message is destined to be sent.
622 * You may alter the message text as you wish before relinquishing control to the next module
623 * in the chain, and if no other modules block the text this altered form of the text will be sent out
624 * to the user and possibly to other servers.
625 * @param user The user sending the message
626 * @param dest The target of the message (Channel* or User*)
627 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
628 * @param text Changeable text being sent by the user
629 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
630 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
631 * It will be ignored for private notices.
632 * @return 1 to deny the NOTICE, 0 to allow it
634 virtual ModResult OnUserPreNotice(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
636 /** Called when sending a message to all "neighbors" of a given user -
637 * that is, all users that share a common channel. This is used in
638 * commands such as NICK, QUIT, etc.
639 * @param source The source of the message
640 * @param include_c Channels to scan for users to include
641 * @param exceptions Map of user->bool that overrides the inclusion decision
643 * Set exceptions[user] = true to include, exceptions[user] = false to exclude
645 virtual void OnBuildNeighborList(User* source, UserChanList &include_c, std::map<User*,bool> &exceptions);
647 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
648 * Please note that although you can see remote nickchanges through this function, you should
649 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
650 * check user->server before taking any action (including returning nonzero from the method).
651 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
652 * module to generate some meaninful output.
653 * @param user The username changing their nick
654 * @param newnick Their new nickname
655 * @return 1 to deny the change, 0 to allow
657 virtual ModResult OnUserPreNick(User* user, const std::string &newnick);
659 /** Called after any PRIVMSG sent from a user.
660 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
661 * if target_type is TYPE_CHANNEL.
662 * @param user The user sending the message
663 * @param dest The target of the message
664 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
665 * @param text the text being sent by the user
666 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
668 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
670 /** Called after any NOTICE sent from a user.
671 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
672 * if target_type is TYPE_CHANNEL.
673 * @param user The user sending the message
674 * @param dest The target of the message
675 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
676 * @param text the text being sent by the user
677 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
679 virtual void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
681 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
682 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
683 * if target_type is TYPE_CHANNEL.
684 * The difference between this event and OnUserPreNotice/OnUserPreMessage is that delivery is gauranteed,
685 * the message has already been vetted. In the case of the other two methods, a later module may stop your
686 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
687 * @param user The user sending the message
688 * @param dest The target of the message
689 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
690 * @param text the text being sent by the user
691 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
693 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
695 /** Called after every MODE command sent from a user
696 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
697 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
698 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
699 * @param user The user sending the MODEs
700 * @param dest The target of the modes (User* or Channel*)
701 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
702 * @param text The actual modes and their parameters if any
703 * @param translate The translation types of the mode parameters
705 virtual void OnMode(User* user, void* dest, int target_type, const std::vector<std::string> &text, const std::vector<TranslateType> &translate);
707 /** Allows modules to alter or create server descriptions
708 * Whenever a module requires a server description, for example for display in
709 * WHOIS, this function is called in all modules. You may change or define the
710 * description given in std::string &description. If you do, this description
711 * will be shown in the WHOIS fields.
712 * @param servername The servername being searched for
713 * @param description Alterable server description for this server
715 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
717 /** Allows modules to synchronize data which relates to users during a netburst.
718 * When this function is called, it will be called from the module which implements
719 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
720 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
721 * (see below). This function will be called for every user visible on your side
722 * of the burst, allowing you to for example set modes, etc. Do not use this call to
723 * synchronize data which you have stored using class Extensible -- There is a specialist
724 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
725 * @param user The user being syncronized
726 * @param proto A pointer to the module handling network protocol
727 * @param opaque An opaque pointer set by the protocol module, should not be modified!
729 virtual void OnSyncUser(User* user, Module* proto, void* opaque);
731 /** Allows modules to synchronize data which relates to channels during a netburst.
732 * When this function is called, it will be called from the module which implements
733 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
734 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
735 * (see below). This function will be called for every user visible on your side
736 * of the burst, allowing you to for example set modes, etc.
738 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
740 * @param chan The channel being syncronized
741 * @param proto A pointer to the module handling network protocol
742 * @param opaque An opaque pointer set by the protocol module, should not be modified!
744 virtual void OnSyncChannel(Channel* chan, Module* proto, void* opaque);
746 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
747 * Whenever the linking module wants to send out data, but doesnt know what the data
748 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
749 * this method is called. You should use the ProtoSendMetaData function after you've
750 * correctly decided how the data should be represented, to send the metadata on its way if
751 * if it belongs to your module.
752 * @param proto A pointer to the module handling network protocol
753 * @param opaque An opaque pointer set by the protocol module, should not be modified!
754 * @param displayable If this value is true, the data is going to be displayed to a user,
755 * and not sent across the network. Use this to determine wether or not to show sensitive data.
757 virtual void OnSyncNetwork(Module* proto, void* opaque);
759 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
760 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
761 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
762 * @param target The Channel* or User* that data should be added to
763 * @param extname The extension name which is being sent
764 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
766 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
768 /** Implemented by modules which provide the ability to link servers.
769 * These modules will implement this method, which allows transparent sending of servermodes
770 * down the network link as a broadcast, without a module calling it having to know the format
771 * of the MODE command before the actual mode string.
773 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
774 * of how to use this function.
776 * @param opaque An opaque pointer set by the protocol module, should not be modified!
777 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
778 * @param target The Channel* or User* that modes should be sent for
779 * @param modeline The modes and parameters to be sent
780 * @param translate The translation types of the mode parameters
782 virtual void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::vector<std::string> &modeline, const std::vector<TranslateType> &translate);
784 /** Implemented by modules which provide the ability to link servers.
785 * These modules will implement this method, which allows metadata (extra data added to
786 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
787 * to other servers on a netburst and decoded at the other end by the same module on a
790 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
791 * how to use this function.
792 * @param opaque An opaque pointer set by the protocol module, should not be modified!
793 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
794 * @param target The Channel* or User* that metadata should be sent for
795 * @param extname The extension name to send metadata for
796 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
798 virtual void ProtoSendMetaData(void* opaque, Extensible* target, const std::string &extname, const std::string &extdata);
800 /** Called after every WALLOPS command.
801 * @param user The user sending the WALLOPS
802 * @param text The content of the WALLOPS message
804 virtual void OnWallops(User* user, const std::string &text);
806 /** Called whenever a user's hostname is changed.
807 * This event triggers after the host has been set.
808 * @param user The user whos host is being changed
809 * @param newhost The new hostname being set
811 virtual void OnChangeHost(User* user, const std::string &newhost);
813 /** Called whenever a user's GECOS (realname) is changed.
814 * This event triggers after the name has been set.
815 * @param user The user who's GECOS is being changed
816 * @param gecos The new GECOS being set on the user
818 virtual void OnChangeName(User* user, const std::string &gecos);
820 /** Called whenever a user's IDENT is changed.
821 * This event triggers after the name has been set.
822 * @param user The user who's IDENT is being changed
823 * @param gecos The new IDENT being set on the user
825 virtual void OnChangeIdent(User* user, const std::string &ident);
827 /** Called whenever an xline is added by a local user.
828 * This method is triggered after the line is added.
829 * @param source The sender of the line or NULL for local server
830 * @param line The xline being added
832 virtual void OnAddLine(User* source, XLine* line);
834 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
835 * This method is triggered after the line is deleted.
836 * @param source The user removing the line or NULL for local server
837 * @param line the line being deleted
839 virtual void OnDelLine(User* source, XLine* line);
841 /** Called whenever an xline expires.
842 * This method is triggered after the line is deleted.
843 * @param line The line being deleted.
845 virtual void OnExpireLine(XLine *line);
847 /** Called before your module is unloaded to clean up Extensibles.
848 * This method is called once for every user and channel on the network,
849 * so that when your module unloads it may clear up any remaining data
850 * in the form of Extensibles added using Extensible::Extend().
851 * If the target_type variable is TYPE_USER, then void* item refers to
852 * a User*, otherwise it refers to a Channel*.
853 * @param target_type The type of item being cleaned
854 * @param item A pointer to the item's class
856 virtual void OnCleanup(int target_type, void* item);
858 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
859 * have been applied. Please note that although you can see remote nickchanges through this function, you should
860 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
861 * check user->server before taking any action (including returning nonzero from the method).
862 * Because this method is called after the nickchange is taken place, no return values are possible
863 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
864 * @param user The user changing their nick
865 * @param oldnick The old nickname of the user before the nickchange
867 virtual void OnUserPostNick(User* user, const std::string &oldnick);
869 /** Called before any mode change, to allow a single access check for
870 * a full mode change (use OnRawMode to check individual modes)
872 * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
873 * OnRawMode for each individual mode
875 * @param source the user making the mode change
876 * @param dest the user destination of the umode change (NULL if a channel mode)
877 * @param channel the channel destination of the mode change
878 * @param parameters raw mode parameters; parameters[0] is the user/channel being changed
880 virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, const std::vector<std::string>& parameters);
882 /** Called when a 005 numeric is about to be output.
883 * The module should modify the 005 numeric if needed to indicate its features.
884 * @param output The 005 string to be modified if neccessary.
886 virtual void On005Numeric(std::string &output);
888 /** Called when a client is disconnected by KILL.
889 * If a client is killed by a server, e.g. a nickname collision or protocol error,
891 * Return 1 from this function to prevent the kill, and 0 from this function to allow
892 * it as normal. If you prevent the kill no output will be sent to the client, it is
893 * down to your module to generate this information.
894 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
895 * If you do so youre risking race conditions, desyncs and worse!
896 * @param source The user sending the KILL
897 * @param dest The user being killed
898 * @param reason The kill reason
899 * @return 1 to prevent the kill, 0 to allow
901 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
903 /** Called when an oper wants to disconnect a remote user via KILL
904 * @param source The user sending the KILL
905 * @param dest The user being killed
906 * @param reason The kill reason
908 virtual void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
910 /** Called whenever a module is loaded.
911 * mod will contain a pointer to the module, and string will contain its name,
912 * for example m_widgets.so. This function is primary for dependency checking,
913 * your module may decide to enable some extra features if it sees that you have
914 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
915 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
916 * but instead operate under reduced functionality, unless the dependency is
917 * absolutely neccessary (e.g. a module that extends the features of another
919 * @param mod A pointer to the new module
921 virtual void OnLoadModule(Module* mod);
923 /** Called whenever a module is unloaded.
924 * mod will contain a pointer to the module, and string will contain its name,
925 * for example m_widgets.so. This function is primary for dependency checking,
926 * your module may decide to enable some extra features if it sees that you have
927 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
928 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
929 * but instead operate under reduced functionality, unless the dependency is
930 * absolutely neccessary (e.g. a module that extends the features of another
932 * @param mod Pointer to the module being unloaded (still valid)
933 * @param name The filename of the module being unloaded
935 virtual void OnUnloadModule(Module* mod);
937 /** Called once every five seconds for background processing.
938 * This timer can be used to control timed features. Its period is not accurate
939 * enough to be used as a clock, but it is gauranteed to be called at least once in
940 * any five second period, directly from the main loop of the server.
941 * @param curtime The current timer derived from time(2)
943 virtual void OnBackgroundTimer(time_t curtime);
945 /** Called whenever any command is about to be executed.
946 * This event occurs for all registered commands, wether they are registered in the core,
947 * or another module, and for invalid commands. Invalid commands may only be sent to this
948 * function when the value of validated is false. By returning 1 from this method you may prevent the
949 * command being executed. If you do this, no output is created by the core, and it is
950 * down to your module to produce any output neccessary.
951 * Note that unless you return 1, you should not destroy any structures (e.g. by using
952 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
953 * method returns, it will be passed an invalid pointer to the user object and crash!)
954 * @param command The command being executed
955 * @param parameters An array of array of characters containing the parameters for the command
956 * @param pcnt The nuimber of parameters passed to the command
957 * @param user the user issuing the command
958 * @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.
959 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
960 * @param original_line The entire original line as passed to the parser from the user
961 * @return 1 to block the command, 0 to allow
963 virtual ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, User *user, bool validated, const std::string &original_line);
965 /** Called after any command has been executed.
966 * This event occurs for all registered commands, wether they are registered in the core,
967 * or another module, but it will not occur for invalid commands (e.g. ones which do not
968 * exist within the command table). The result code returned by the command handler is
970 * @param command The command being executed
971 * @param parameters An array of array of characters containing the parameters for the command
972 * @param pcnt The nuimber of parameters passed to the command
973 * @param user the user issuing the command
974 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
975 * @param original_line The entire original line as passed to the parser from the user
977 virtual void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, User *user, CmdResult result, const std::string &original_line);
979 /** Called to check if a user who is connecting can now be allowed to register
980 * If any modules return false for this function, the user is held in the waiting
981 * state until all modules return true. For example a module which implements ident
982 * lookups will continue to return false for a user until their ident lookup is completed.
983 * Note that the registration timeout for a user overrides these checks, if the registration
984 * timeout is reached, the user is disconnected even if modules report that the user is
985 * not ready to connect.
986 * @param user The user to check
987 * @return true to indicate readiness, false if otherwise
989 virtual ModResult OnCheckReady(User* user);
991 /** Called whenever a user is about to register their connection (e.g. before the user
992 * is sent the MOTD etc). Modules can use this method if they are performing a function
993 * which must be done before the actual connection is completed (e.g. ident lookups,
994 * dnsbl lookups, etc).
995 * Note that you should NOT delete the user record here by causing a disconnection!
996 * Use OnUserConnect for that instead.
997 * @param user The user registering
998 * @return 1 to indicate user quit, 0 to continue
1000 virtual ModResult OnUserRegister(User* user);
1002 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1003 * This method will always be called for each join, wether or not the channel is actually +i, and
1004 * determines the outcome of an if statement around the whole section of invite checking code.
1005 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1006 * @param user The user joining the channel
1007 * @param chan The channel being joined
1008 * @return 1 to explicitly allow the join, 0 to proceed as normal
1010 virtual ModResult OnCheckInvite(User* user, Channel* chan);
1012 /** Called whenever a mode character is processed.
1013 * Return 1 from this function to block the mode character from being processed entirely.
1014 * @param user The user who is sending the mode
1015 * @param chan The channel the mode is being sent to (or NULL if a usermode)
1016 * @param mode The mode character being set
1017 * @param param The parameter for the mode or an empty string
1018 * @param adding true of the mode is being added, false if it is being removed
1019 * @param pcnt The parameter count for the mode (0 or 1)
1020 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
1021 * to skip all permission checking. Please note that for remote mode changes, your return value
1024 virtual ModResult OnRawMode(User* user, Channel* chan, const char mode, const std::string ¶m, bool adding, int pcnt);
1026 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1027 * This method will always be called for each join, wether or not the channel is actually +k, and
1028 * determines the outcome of an if statement around the whole section of key checking code.
1029 * if the user specified no key, the keygiven string will be a valid but empty value.
1030 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1031 * @param user The user joining the channel
1032 * @param chan The channel being joined
1033 * @return 1 to explicitly allow the join, 0 to proceed as normal
1035 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
1037 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1038 * This method will always be called for each join, wether or not the channel is actually +l, and
1039 * determines the outcome of an if statement around the whole section of channel limit checking code.
1040 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1041 * @param user The user joining the channel
1042 * @param chan The channel being joined
1043 * @return 1 to explicitly allow the join, 0 to proceed as normal
1045 virtual ModResult OnCheckLimit(User* user, Channel* chan);
1048 * Checks for a user's ban from the channel
1049 * @param user The user to check
1050 * @param chan The channel to check in
1051 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1052 * ban check, or MOD_RES_PASSTHRU to check bans normally
1054 virtual ModResult OnCheckChannelBan(User* user, Channel* chan);
1057 * Checks for a user's match of a single ban
1058 * @param user The user to check for match
1059 * @param chan The channel on which the match is being checked
1060 * @param mask The mask being checked
1061 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1062 * ban check, or MOD_RES_PASSTHRU to check bans normally
1064 virtual ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask);
1066 /** Checks for a match on a given extban type
1067 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1068 * ban check, or MOD_RES_PASSTHRU to check bans normally
1070 virtual ModResult OnExtBanCheck(User* user, Channel* chan, char type);
1072 /** Called on all /STATS commands
1073 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1074 * @param symbol the symbol provided to /STATS
1075 * @param user the user issuing the /STATS command
1076 * @param results A string_list to append results into. You should put all your results
1077 * into this string_list, rather than displaying them directly, so that your handler will
1078 * work when remote STATS queries are received.
1079 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1081 virtual ModResult OnStats(char symbol, User* user, string_list &results);
1083 /** Called whenever a change of a local users displayed host is attempted.
1084 * Return 1 to deny the host change, or 0 to allow it.
1085 * @param user The user whos host will be changed
1086 * @param newhost The new hostname
1087 * @return 1 to deny the host change, 0 to allow
1089 virtual ModResult OnChangeLocalUserHost(User* user, const std::string &newhost);
1091 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1092 * return 1 to deny the name change, or 0 to allow it.
1093 * @param user The user whos GECOS will be changed
1094 * @param newhost The new GECOS
1095 * @return 1 to deny the GECOS change, 0 to allow
1097 virtual ModResult OnChangeLocalUserGECOS(User* user, const std::string &newhost);
1099 /** Called before a topic is changed.
1100 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
1101 * As with other 'pre' events, you should only ever block a local event.
1102 * @param user The user changing the topic
1103 * @param chan The channels who's topic is being changed
1104 * @param topic The actual topic text
1105 * @param 1 to block the topic change, 0 to allow
1107 virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
1109 /** Called whenever a topic has been changed.
1110 * To block topic changes you must use OnPreTopicChange instead.
1111 * @param user The user changing the topic
1112 * @param chan The channels who's topic is being changed
1113 * @param topic The actual topic text
1115 virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
1117 /** Called whenever an Event class is sent to all modules by another module.
1118 * You should *always* check the value of Event::id to determine the event type.
1119 * @param event The Event class being received
1121 virtual void OnEvent(Event& event);
1123 /** Called whenever a Request class is sent to your module by another module.
1124 * The value of Request::id should be used to determine the type of request.
1125 * @param request The Request class being received
1127 virtual void OnRequest(Request& request);
1129 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
1130 * The password field (from the config file) is in 'password' and is to be compared against
1131 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
1132 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
1133 * @param ex The object that's causing the authentication (User* for <oper> <connect:allow> etc, Server* for <link>).
1134 * @param password The password from the configuration file (the password="" value).
1135 * @param input The password entered by the user or whoever.
1136 * @param hashtype The hash value from the config
1137 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
1139 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
1141 /** Called whenever a user is given usermode +o, anywhere on the network.
1142 * You cannot override this and prevent it from happening as it is already happened and
1143 * such a task must be performed by another server. You can however bounce modes by sending
1144 * servermodes out to reverse mode changes.
1145 * @param user The user who is opering
1147 virtual void OnGlobalOper(User* user);
1149 /** Called after a user has fully connected and all modules have executed OnUserConnect
1150 * This event is informational only. You should not change any user information in this
1151 * event. To do so, use the OnUserConnect method to change the state of local users.
1152 * This is called for both local and remote users.
1153 * @param user The user who is connecting
1155 virtual void OnPostConnect(User* user);
1157 /** Called whenever a ban is added to a channel's list.
1158 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1159 * @param source The user adding the ban
1160 * @param channel The channel the ban is being added to
1161 * @param banmask The ban mask being added
1162 * @return 1 to block the ban, 0 to continue as normal
1164 virtual ModResult OnAddBan(User* source, Channel* channel,const std::string &banmask);
1166 /** Called whenever a ban is removed from a channel's list.
1167 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1168 * @param source The user deleting the ban
1169 * @param channel The channel the ban is being deleted from
1170 * @param banmask The ban mask being deleted
1171 * @return 1 to block the unban, 0 to continue as normal
1173 virtual ModResult OnDelBan(User* source, Channel* channel,const std::string &banmask);
1175 /** Called to install an I/O hook on an event handler
1176 * @param user The item to possibly install the I/O hook on
1177 * @param via The port that <user> connected on
1179 virtual void OnHookIO(StreamSocket*, ListenSocketBase* via);
1181 /** Called immediately after any connection is accepted. This is intended for raw socket
1182 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1183 * no information relating to a user record as the connection has not been assigned yet.
1184 * There are no return values from this call as all modules get an opportunity if required to
1185 * process the connection.
1186 * @param fd The file descriptor returned from accept()
1187 * @param client The client IP address and port
1188 * @param server The server IP address and port
1189 * @param localport The local port number the user connected to
1191 virtual void OnStreamSocketAccept(StreamSocket*, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
1194 * Called when a hooked stream has data to write, or when the socket
1195 * engine returns it as writable
1196 * @param socket The socket in question
1197 * @param sendq Data to send to the socket
1198 * @return 1 if the sendq has been completely emptied, 0 if there is
1199 * still data to send, and -1 if there was an error
1201 virtual int OnStreamSocketWrite(StreamSocket*, std::string& sendq);
1203 /** Called immediately before any socket is closed. When this event is called, shutdown()
1204 * has not yet been called on the socket.
1205 * @param fd The file descriptor of the socket prior to close()
1207 virtual void OnStreamSocketClose(StreamSocket*);
1209 /** Called immediately upon connection of an outbound BufferedSocket which has been hooked
1211 * @param fd The file descriptor of the socket immediately after connect()
1213 virtual void OnStreamSocketConnect(StreamSocket*);
1216 * Called when the stream socket has data to read
1217 * @param socket The socket that is ready
1218 * @param recvq The receive queue that new data should be appended to
1219 * @return 1 if new data has been read, 0 if no new data is ready (but the
1220 * socket is still connected), -1 if there was an error or close
1222 virtual int OnStreamSocketRead(StreamSocket*, std::string& recvq);
1224 /** Called whenever a user sets away or returns from being away.
1225 * The away message is available as a parameter, but should not be modified.
1226 * At this stage, it has already been copied into the user record.
1227 * If awaymsg is empty, the user is returning from away.
1228 * @param user The user setting away
1229 * @param awaymsg The away message of the user, or empty if returning from away
1230 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
1232 virtual ModResult OnSetAway(User* user, const std::string &awaymsg);
1234 /** Called whenever a NAMES list is requested.
1235 * You can produce the nameslist yourself, overriding the current list,
1236 * and if you do you must return 1. If you do not handle the names list,
1238 * @param The user requesting the NAMES list
1239 * @param Ptr The channel the NAMES list is requested for
1241 virtual ModResult OnUserList(User* user, Channel* Ptr);
1243 /** Called whenever a line of WHOIS output is sent to a user.
1244 * You may change the numeric and the text of the output by changing
1245 * the values numeric and text, but you cannot change the user the
1246 * numeric is sent to. You may however change the user's User values.
1247 * @param user The user the numeric is being sent to
1248 * @param dest The user being WHOISed
1249 * @param numeric The numeric of the line being sent
1250 * @param text The text of the numeric, including any parameters
1251 * @return nonzero to drop the line completely so that the user does not
1252 * receive it, or zero to allow the line to be sent.
1254 virtual ModResult OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
1256 /** Called at intervals for modules to garbage-collect any hashes etc.
1257 * Certain data types such as hash_map 'leak' buckets, which must be
1258 * tidied up and freed by copying into a new item every so often. This
1259 * method is called when it is time to do that.
1261 virtual void OnGarbageCollect();
1263 /** Add test suite hooks here. These are used for testing functionality of a module
1264 * via the --testsuite debugging parameter.
1266 virtual void OnRunTestSuite();
1268 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
1269 * For example NAMESX, channel mode +u and +I, and UHNAMES. If the nick is set to an empty string by any
1270 * module, then this will cause the nickname not to be displayed at all.
1272 virtual void OnNamesListItem(User* issuer, Membership* item, std::string &prefixes, std::string &nick);
1274 virtual ModResult OnNumeric(User* user, unsigned int numeric, const std::string &text);
1276 /** Called whenever a result from /WHO is about to be returned
1277 * @param source The user running the /WHO query
1278 * @param user The user that this line of the query is about
1279 * @param channel The channel being queried (or NULL if not a channel query)
1280 * @param line The raw line to send; modifiable, if empty no line will be returned.
1282 virtual void OnSendWhoLine(User* source, User* user, Channel* channel, std::string& line);
1284 /** Called to check whether a channel restriction mode applies to a user on it
1285 * @return MOD_RES_DENY to apply the restriction, MOD_RES_ALLOW to bypass
1286 * the restriction, or MOD_RES_PASSTHRU to check restriction status normally
1288 virtual ModResult OnChannelRestrictionApply(User* user, Channel* chan, const char* restriction);
1292 #define CONF_NO_ERROR 0x000000
1293 #define CONF_NOT_A_NUMBER 0x000010
1294 #define CONF_INT_NEGATIVE 0x000080
1295 #define CONF_VALUE_NOT_FOUND 0x000100
1296 #define CONF_FILE_NOT_FOUND 0x000200
1299 /** Allows reading of values from configuration files
1300 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1301 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1302 * Constructing the class using one parameter allows you to specify a path to your own configuration
1303 * file, otherwise, inspircd.conf is read.
1305 class CoreExport ConfigReader : public classbase
1313 /** Default constructor.
1314 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1315 * as specified when running ./configure.
1318 /** Default destructor.
1319 * This method destroys the ConfigReader class.
1323 /** Retrieves a value from the config file.
1324 * This method retrieves a value from the config file. Where multiple copies of the tag
1325 * exist in the config file, index indicates which of the values to retrieve.
1327 std::string ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds = false);
1328 /** Retrieves a value from the config file.
1329 * This method retrieves a value from the config file. Where multiple copies of the tag
1330 * exist in the config file, index indicates which of the values to retrieve. If the
1331 * tag is not found the default value is returned instead.
1333 std::string ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds = false);
1335 /** Retrieves a boolean value from the config file.
1336 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1337 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1338 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1340 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1341 /** Retrieves a boolean value from the config file.
1342 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1343 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1344 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1345 * If the tag is not found, the default value is used instead.
1347 bool ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index);
1349 /** Retrieves an integer value from the config file.
1350 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1351 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1352 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1353 * return CONF_INVALID_NUMBER to be returned. need_positive is set if the number must be non-negative.
1354 * If a negative number is placed into a tag which is specified positive, 0 will be returned and GetError()
1355 * will return CONF_INT_NEGATIVE. Note that need_positive is not suitable to get an unsigned int - you
1356 * should cast the result to achieve that effect.
1358 int ReadInteger(const std::string &tag, const std::string &name, int index, bool need_positive);
1359 /** Retrieves an integer value from the config file.
1360 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1361 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1362 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1363 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1364 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1365 * will return CONF_NOT_UNSIGNED. If the tag is not found, the default value is used instead.
1367 int ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool need_positive);
1369 /** Returns the last error to occur.
1370 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1371 * A call to GetError() resets the error flag back to 0.
1374 /** Counts the number of times a given tag appears in the config file.
1375 * This method counts the number of times a tag appears in a config file, for use where
1376 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1377 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1378 * multiple instance tag.
1380 int Enumerate(const std::string &tag);
1382 /** Returns the number of items within a tag.
1383 * For example if the tag was <test tag="blah" data="foo"> then this
1384 * function would return 2. Spaces and newlines both qualify as valid seperators
1387 int EnumerateValues(const std::string &tag, int index);
1392 /** Caches a text file into memory and can be used to retrieve lines from it.
1393 * This class contains methods for read-only manipulation of a text file in memory.
1394 * Either use the constructor type with one parameter to load a file into memory
1395 * at construction, or use the LoadFile method to load a file.
1397 class CoreExport FileReader : public classbase
1399 /** The file contents
1403 /** Content size in bytes
1405 unsigned long contentsize;
1407 /** Calculate content size in bytes
1412 /** Default constructor.
1413 * This method does not load any file into memory, you must use the LoadFile method
1414 * after constructing the class this way.
1418 /** Secondary constructor.
1419 * This method initialises the class with a file loaded into it ready for GetLine and
1420 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1423 FileReader(const std::string &filename);
1425 /** Default destructor.
1426 * This deletes the memory allocated to the file.
1430 /** Used to load a file.
1431 * This method loads a file into the class ready for GetLine and
1432 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1435 void LoadFile(const std::string &filename);
1437 /** Returns the whole content of the file as std::string
1439 std::string Contents();
1441 /** Returns the entire size of the file as std::string
1443 unsigned long ContentSize();
1445 /** Returns true if the file exists
1446 * This function will return false if the file could not be opened.
1450 /** Retrieve one line from the file.
1451 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1452 * the index was out of bounds, or the line had no data on it.
1454 std::string GetLine(int x);
1456 /** Returns the size of the file in lines.
1457 * This method returns the number of lines in the read file. If it is 0, no lines have been
1458 * read into memory, either because the file is empty or it does not exist, or cannot be
1459 * opened due to permission problems.
1464 /** A list of modules
1466 typedef std::vector<Module*> IntModuleList;
1468 /** An event handler iterator
1470 typedef IntModuleList::iterator EventHandlerIter;
1472 /** ModuleManager takes care of all things module-related
1475 class CoreExport ModuleManager : public classbase
1478 /** Holds a string describing the last module error to occur
1480 std::string LastModuleError;
1482 /** The feature names published by various modules
1484 featurelist Features;
1486 /** The interface names published by various modules
1488 interfacelist Interfaces;
1490 /** Total number of modules loaded into the ircd
1494 /** List of loaded modules and shared object/dll handles
1495 * keyed by module name
1497 std::map<std::string, Module*> Modules;
1503 } prioritizationState;
1505 /** Internal unload module hook */
1506 bool CanUnload(Module*);
1509 /** Event handler hooks.
1510 * This needs to be public to be used by FOREACH_MOD and friends.
1512 IntModuleList EventHandlers[I_END];
1514 /** Simple, bog-standard, boring constructor.
1522 /** Change the priority of one event in a module.
1523 * Each module event has a list of modules which are attached to that event type.
1524 * If you wish to be called before or after other specific modules, you may use this
1525 * method (usually within void Module::Prioritize()) to set your events priority.
1526 * You may use this call in other methods too, however, this is not supported behaviour
1528 * @param mod The module to change the priority of
1529 * @param i The event to change the priority of
1530 * @param s The state you wish to use for this event. Use one of
1531 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1532 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1533 * to set it to be before or after one or more other modules.
1534 * @param modules If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1535 * then this contains a list of one or more modules your module must be
1536 * placed before or after. Your module will be placed before the highest
1537 * priority module in this list for PRIO_BEFORE, or after the lowest
1538 * priority module in this list for PRIORITY_AFTER.
1539 * @param sz The number of modules being passed for PRIO_BEFORE and PRIORITY_AFTER.
1540 * Defaults to 1, as most of the time you will only want to prioritize your module
1541 * to be before or after one other module.
1543 bool SetPriority(Module* mod, Implementation i, Priority s, Module** modules = NULL, size_t sz = 1);
1545 /** Change the priority of all events in a module.
1546 * @param mod The module to set the priority of
1547 * @param s The priority of all events in the module.
1548 * Note that with this method, it is not possible to effectively use
1549 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1550 * SetPriority method for this, where you may specify other modules to
1551 * be prioritized against.
1553 bool SetPriority(Module* mod, Priority s);
1555 /** Attach an event to a module.
1556 * You may later detatch the event with ModuleManager::Detach().
1557 * If your module is unloaded, all events are automatically detatched.
1558 * @param i Event type to attach
1559 * @param mod Module to attach event to
1560 * @return True if the event was attached
1562 bool Attach(Implementation i, Module* mod);
1564 /** Detatch an event from a module.
1565 * This is not required when your module unloads, as the core will
1566 * automatically detatch your module from all events it is attached to.
1567 * @param i Event type to detach
1568 * @param mod Module to detach event from
1569 * @param Detach true if the event was detached
1571 bool Detach(Implementation i, Module* mod);
1573 /** Attach an array of events to a module
1574 * @param i Event types (array) to attach
1575 * @param mod Module to attach events to
1577 void Attach(Implementation* i, Module* mod, size_t sz);
1579 /** Detach all events from a module (used on unload)
1580 * @param mod Module to detach from
1582 void DetachAll(Module* mod);
1584 /** Returns text describing the last module error
1585 * @return The last error message to occur
1587 std::string& LastError();
1589 /** Load a given module file
1590 * @param filename The file to load
1591 * @return True if the module was found and loaded
1593 bool Load(const char* filename);
1595 /** Unload a given module file. Note that the module will not be
1596 * completely gone until the cull list has finished processing.
1598 * @return true on success; if false, LastError will give a reason
1600 bool Unload(Module* module);
1602 /** Run an asynchronous reload of the given module. When the reload is
1603 * complete, the callback will be run with true if the reload succeeded
1604 * and false if it did not.
1606 void Reload(Module* module, HandlerBase1<void, bool>* callback);
1608 /** Called by the InspIRCd constructor to load all modules from the config file.
1612 void DoSafeUnload(Module*);
1614 /** Get the total number of currently loaded modules
1615 * @return The number of loaded modules
1619 return this->ModCount;
1622 /** Find a module by name, and return a Module* to it.
1623 * This is preferred over iterating the module lists yourself.
1624 * @param name The module name to look up
1625 * @return A pointer to the module, or NULL if the module cannot be found
1627 Module* Find(const std::string &name);
1629 /** Publish a 'feature'.
1630 * There are two ways for a module to find another module it depends on.
1631 * Either by name, using InspIRCd::FindModule, or by feature, using this
1632 * function. A feature is an arbitary string which identifies something this
1633 * module can do. For example, if your module provides SSL support, but other
1634 * modules provide SSL support too, all the modules supporting SSL should
1635 * publish an identical 'SSL' feature. This way, any module requiring use
1636 * of SSL functions can just look up the 'SSL' feature using FindFeature,
1637 * then use the module pointer they are given.
1638 * @param FeatureName The case sensitive feature name to make available
1639 * @param Mod a pointer to your module class
1640 * @returns True on success, false if the feature is already published by
1643 bool PublishFeature(const std::string &FeatureName, Module* Mod);
1645 /** Publish a module to an 'interface'.
1646 * Modules which implement the same interface (the same way of communicating
1647 * with other modules) can publish themselves to an interface, using this
1648 * method. When they do so, they become part of a list of related or
1649 * compatible modules, and a third module may then query for that list
1650 * and know that all modules within that list offer the same API.
1651 * A prime example of this is the hashing modules, which all accept the
1652 * same types of Request class. Consider this to be similar to PublishFeature,
1653 * except for that multiple modules may publish the same 'feature'.
1654 * @param InterfaceName The case sensitive interface name to make available
1655 * @param Mod a pointer to your module class
1656 * @returns True on success, false on failure (there are currently no failure
1659 bool PublishInterface(const std::string &InterfaceName, Module* Mod);
1661 /** Return a pair saying how many other modules are currently using the
1662 * interfaces provided by module m.
1663 * @param m The module to count usage for
1664 * @return A pair, where the first value is the number of uses of the interface,
1665 * and the second value is the interface name being used.
1667 std::pair<int,std::string> GetInterfaceInstanceCount(Module* m);
1669 /** Mark your module as using an interface.
1670 * If you mark your module as using an interface, then that interface
1671 * module may not unload until your module has unloaded first.
1672 * This can be used to prevent crashes by ensuring code you depend on
1673 * is always in memory while your module is active.
1674 * @param InterfaceName The interface to use
1676 void UseInterface(const std::string &InterfaceName);
1678 /** Mark your module as finished with an interface.
1679 * If you used UseInterface() above, you should use this method when
1680 * your module is finished with the interface (usually in its destructor)
1681 * to allow the modules which implement the given interface to be unloaded.
1682 * @param InterfaceName The interface you are finished with using.
1684 void DoneWithInterface(const std::string &InterfaceName);
1686 /** Unpublish a 'feature'.
1687 * When your module exits, it must call this method for every feature it
1688 * is providing so that the feature table is cleaned up.
1689 * @param FeatureName the feature to remove
1691 bool UnpublishFeature(const std::string &FeatureName);
1693 /** Unpublish your module from an interface
1694 * When your module exits, it must call this method for every interface
1695 * it is part of so that the interfaces table is cleaned up. Only when
1696 * the last item is deleted from an interface does the interface get
1698 * @param InterfaceName the interface to be removed from
1699 * @param Mod The module to remove from the interface list
1701 bool UnpublishInterface(const std::string &InterfaceName, Module* Mod);
1703 /** Find 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 the
1706 * InspIRCd::PublishFeature method. A feature is an arbitary string which
1707 * identifies something this module can do. For example, if your module
1708 * provides SSL support, but other modules provide SSL support too, all
1709 * the modules supporting SSL should publish an identical 'SSL' feature.
1710 * To find a module capable of providing the feature you want, simply
1711 * call this method with the feature name you are looking for.
1712 * @param FeatureName The feature name you wish to obtain the module for
1713 * @returns A pointer to a valid module class on success, NULL on failure.
1715 Module* FindFeature(const std::string &FeatureName);
1717 /** Find an 'interface'.
1718 * An interface is a list of modules which all implement the same API.
1719 * @param InterfaceName The Interface you wish to obtain the module
1721 * @return A pointer to a deque of Module*, or NULL if the interface
1724 modulelist* FindInterface(const std::string &InterfaceName);
1726 /** Determine if a module has published the named interface.
1727 * This could be used in, for example, OnLoadModule to pick up other modules that can be used.
1728 * @param mod The module to check.
1729 * @param InterfaceName the interface you want to check for
1730 * @return True if the module provides the interface, false otherwise.
1732 bool ModuleHasInterface(Module* mod, const std::string& InterfaceName);
1734 /** Given a pointer to a Module, return its filename
1735 * @param m The module pointer to identify
1736 * @return The module name or an empty string
1738 const std::string& GetModuleName(Module* m);
1740 /** Return a list of all modules matching the given filter
1741 * @param filter This int is a bitmask of flags set in Module::Flags,
1742 * such as VF_VENDOR or VF_STATIC. If you wish to receive a list of
1743 * all modules with no filtering, set this to 0.
1744 * @return The list of module names
1746 const std::vector<std::string> GetAllModuleNames(int filter);
1749 /** Do not mess with these functions unless you know the C preprocessor
1750 * well enough to explain why they are needed. The order is important.
1752 #define MODULE_INIT_STR MODULE_INIT_STR_FN_2(MODULE_INIT_SYM)
1753 #define MODULE_INIT_STR_FN_2(x) MODULE_INIT_STR_FN_1(x)
1754 #define MODULE_INIT_STR_FN_1(x) #x
1755 #define MODULE_INIT_SYM MODULE_INIT_SYM_FN_2(API_VERSION)
1756 #define MODULE_INIT_SYM_FN_2(x) MODULE_INIT_SYM_FN_1(x)
1757 #define MODULE_INIT_SYM_FN_1(x) inspircd_module_ ## x
1759 /** This definition is used as shorthand for the various classes
1760 * and functions needed to make a module loadable by the OS.
1761 * It defines the class factory and external init_module function.
1765 #define MODULE_INIT(y) \
1766 extern "C" DllExport Module * MODULE_INIT_SYM() \
1770 BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
1772 switch ( nReason ) \
1774 case DLL_PROCESS_ATTACH: \
1775 case DLL_PROCESS_DETACH: \
1783 #define MODULE_INIT(y) \
1784 extern "C" DllExport Module * MODULE_INIT_SYM() \
1790 #define COMMAND_INIT(c) MODULE_INIT(CommandModule<c>)