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 /** A set of strings.
121 typedef std::vector<std::string> string_list;
123 /** Holds a list of 'published features' for modules.
125 typedef std::map<std::string,Module*> featurelist;
127 /** Holds a list of modules which implement an interface
129 typedef std::deque<Module*> modulelist;
131 /** Holds a list of all modules which implement interfaces, by interface name
133 typedef std::map<std::string, std::pair<int, modulelist> > interfacelist;
136 * This #define allows us to call a method in all
137 * loaded modules in a readable simple way, e.g.:
138 * 'FOREACH_MOD(I_OnConnect,OnConnect(user));'
140 #define FOREACH_MOD(y,x) do { \
141 EventHandlerIter safei; \
142 for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ) \
150 catch (CoreException& modexcept) \
152 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
159 * Custom module result handling loop. This is a paired macro, and should only
160 * be used with while_each_hook.
162 * See src/channels.cpp for an example of use.
164 #define DO_EACH_HOOK(n,v,args) \
166 EventHandlerIter iter_ ## n = ServerInstance->Modules->EventHandlers[I_ ## n].begin(); \
167 while (iter_ ## n != ServerInstance->Modules->EventHandlers[I_ ## n].end()) \
169 Module* mod_ ## n = *iter_ ## n; \
173 v = (mod_ ## n)->n args;
175 #define WHILE_EACH_HOOK(n) \
177 catch (CoreException& except_ ## n) \
179 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s", (except_ ## n).GetReason()); \
180 (void) mod_ ## n; /* catch mismatched pairs */ \
186 * Module result iterator
187 * Runs the given hook until some module returns a useful result.
189 * Example: ModResult result;
190 * FIRST_MOD_RESULT(OnUserPreNick, result, (user, newnick))
192 #define FIRST_MOD_RESULT(n,v,args) do { \
193 v = MOD_RES_PASSTHRU; \
194 DO_EACH_HOOK(n,v,args) \
196 if (v != MOD_RES_PASSTHRU) \
199 WHILE_EACH_HOOK(n); \
202 /** Represents a non-local user.
203 * (in fact, any FD less than -1 does)
205 #define FD_MAGIC_NUMBER -42
206 /** Represents a fake user (i.e. a server)
208 #define FD_FAKEUSER_NUMBER -7
212 /** Is a local user */
213 #define IS_LOCAL(x) (x->GetFd() > -1)
214 /** Is a remote user */
215 #define IS_REMOTE(x) (x->GetFd() < 0)
216 /** Is a fake user */
217 #define IS_SERVER(x) (x->GetFd() == FD_FAKEUSER_NUMBER)
218 /** Is a module created user */
219 #define IS_MODULE_CREATED(x) (x->GetFd() == FD_MAGIC_NUMBER)
221 #define IS_OPER(x) (!x->oper.empty())
223 #define IS_AWAY(x) (!x->awaymsg.empty())
225 /** Holds a module's Version information.
226 * The members (set by the constructor only) indicate details as to the version number
227 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
229 * The core provides only one implementation of the template, causing a run-time linking
230 * error when attempting to load a module compiled against a different API_VERSION.
233 class CoreExport VersionBase
236 /** Module description
238 const std::string description;
239 /** Version information.
241 const std::string version;
247 /** Initialize version class
249 VersionBase(const std::string &desc, int flags = VF_NONE, const std::string& src_rev = VERSION " r" REVISION);
252 typedef VersionBase<API_VERSION> Version;
254 /** The Request class is a unicast message directed at a given module.
255 * When this class is properly instantiated it may be sent to a module
256 * using the Send() method, which will call the given module's OnRequest
257 * method with this class as its parameter.
259 class CoreExport Request : public classbase
262 /** This should be a null-terminated string identifying the type of request,
263 * all modules should define this and use it to determine the nature of the
264 * request before they attempt to cast the Request in any way.
266 const char* const id;
267 /** This is a pointer to the sender of the message, which can be used to
268 * directly trigger events, or to create a reply.
270 Module* const source;
271 /** The single destination of the Request
275 /** Create a new Request
276 * This is for the 'new' way of defining a subclass
277 * of Request and defining it in a common header,
278 * passing an object of your Request subclass through
279 * as a Request* and using the ID string to determine
280 * what to cast it back to and the other end.
282 Request(Module* src, Module* dst, const char* idstr);
283 /** Send the Request.
289 /** The Event class is a unicast message directed at all modules.
290 * When the class is properly instantiated it may be sent to all modules
291 * using the Send() method, which will trigger the OnEvent method in
292 * all modules passing the object as its parameter.
294 class CoreExport Event : public classbase
297 /** This is a pointer to the sender of the message, which can be used to
298 * directly trigger events, or to create a reply.
300 Module* const source;
301 /** The event identifier.
302 * This is arbitary text which should be used to distinguish
303 * one type of event from another.
305 const std::string id;
307 /** Create a new Event
309 Event(Module* src, const std::string &eventid);
311 * The return result of an Event::Send() will always be NULL as
312 * no replies are expected.
317 /** Priority types which can be returned from Module::Prioritize()
319 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
321 /** Implementation-specific flags which may be set in Module::Implements()
326 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash,
327 I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois,
328 I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick,
329 I_OnUserMessage, I_OnUserNotice, I_OnMode, I_OnGetServerDescription, I_OnSyncUser,
330 I_OnSyncChannel, I_OnDecodeMetaData, I_OnWallops,
331 I_OnChangeHost, I_OnChangeName, I_OnAddLine, I_OnDelLine, I_OnExpireLine,
332 I_OnUserPostNick, I_OnPreMode, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule,
333 I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite,
334 I_OnRawMode, I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckChannelBan, I_OnExtBanCheck,
335 I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnPreTopicChange,
336 I_OnPostTopicChange, I_OnEvent, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan,
337 I_OnDelBan, I_OnChangeLocalUserGECOS, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
338 I_OnPostOper, I_OnSyncNetwork, I_OnSetAway, I_OnUserList, I_OnPostCommand, I_OnPostJoin,
339 I_OnWhoisLine, I_OnBuildNeighborList, I_OnGarbageCollect,
340 I_OnText, I_OnPassCompare, I_OnRunTestSuite, I_OnNamesListItem, I_OnNumeric, I_OnHookIO,
341 I_OnPreRehash, I_OnModuleRehash, I_OnSendWhoLine, I_OnChangeIdent, I_OnChannelRestrictionApply,
347 /** Base class for all InspIRCd modules
348 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
349 * its methods will be called when irc server events occur. class inherited from module must be
350 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
352 class CoreExport Module : public classbase
355 /** File that this module was loaded from
357 std::string ModuleSourceFile;
358 /** Reference to the dlopen() value
360 DLLManager* ModuleDLLManager;
362 /** Default constructor.
363 * Creates a module class.
364 * @param Me An instance of the InspIRCd class which will be saved into ServerInstance for your use
365 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
369 /** Clean up prior to destruction
370 * If you override, you must call this AFTER your module's cleanup
372 virtual CullResult cull();
374 /** Default destructor.
375 * destroys a module class
379 virtual void Prioritize()
383 /** Returns the version number of a Module.
384 * The method should return a Version object with its version information assigned via
387 virtual Version GetVersion() = 0;
389 /** Called when a user connects.
390 * The details of the connecting user are available to you in the parameter User *user
391 * @param user The user who is connecting
393 virtual void OnUserConnect(User* user);
395 /** Called when a user quits.
396 * The details of the exiting user are available to you in the parameter User *user
397 * This event is only called when the user is fully registered when they quit. To catch
398 * raw disconnections, use the OnUserDisconnect method.
399 * @param user The user who is quitting
400 * @param message The user's quit message (as seen by non-opers)
401 * @param oper_message The user's quit message (as seen by opers)
403 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
405 /** Called whenever a user's socket is closed.
406 * The details of the exiting user are available to you in the parameter User *user
407 * This event is called for all users, registered or not, as a cleanup method for modules
408 * which might assign resources to user, such as dns lookups, objects and sockets.
409 * @param user The user who is disconnecting
411 virtual void OnUserDisconnect(User* user);
413 /** Called whenever a channel is about to be deleted
414 * @param chan The channel being deleted
415 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
417 virtual ModResult OnChannelPreDelete(Channel *chan);
419 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
420 * @param chan The channel being deleted
422 virtual void OnChannelDelete(Channel* chan);
424 /** Called when a user joins a channel.
425 * The details of the joining user are available to you in the parameter User *user,
426 * and the details of the channel they have joined is available in the variable Channel *channel
427 * @param memb The channel membership being created
428 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
429 * to a channel due to the network sync.
430 * @param created This is true if the join created the channel
432 virtual void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list);
434 /** Called after a user joins a channel
435 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
437 * @param memb The channel membership created
439 virtual void OnPostJoin(Membership*);
441 /** Called when a user parts a channel.
442 * The details of the leaving user are available to you in the parameter User *user,
443 * and the details of the channel they have left is available in the variable Channel *channel
444 * @param memb The channel membership being destroyed
445 * @param partmessage The part message, or an empty string (may be modified)
447 virtual void OnUserPart(Membership* memb, std::string &partmessage, CUList& except_list);
449 /** Called on rehash.
450 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
451 * system. This is called in all cases -- including when this server will not execute the
452 * rehash because it is directed at a remote server.
454 * @param user The user performing the rehash, if any. If this is server initiated, the value of
455 * this variable will be NULL.
456 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
459 virtual void OnPreRehash(User* user, const std::string ¶meter);
461 /** Called on rehash.
462 * This method is called when a user initiates a module-specific rehash. This can be used to do
463 * expensive operations (such as reloading SSL certificates) that are not executed on a normal
464 * rehash for efficiency. A rehash of this type does not reload the core configuration.
466 * @param user The user performing the rehash.
467 * @param parameter The parameter given to REHASH
469 virtual void OnModuleRehash(User* user, const std::string ¶meter);
471 /** Called on rehash.
472 * This method is called after a rehash has completed. You should use it to reload any module
473 * configuration from the main configuration file.
474 * @param user The user that performed the rehash, if it was initiated by a user and that user
475 * is still connected.
477 virtual void OnRehash(User* user);
479 /** Called whenever a snotice is about to be sent to a snomask.
480 * snomask and type may both be modified; the message may not.
481 * @param snomask The snomask the message is going to (e.g. 'A')
482 * @param type The textual description the snomask will go to (e.g. 'OPER')
483 * @param message The text message to be sent via snotice
484 * @return 1 to block the snotice from being sent entirely, 0 else.
486 virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
488 /** Called whenever a user is about to join a channel, before any processing is done.
489 * Returning a value of 1 from this function stops the process immediately, causing no
490 * output to be sent to the user by the core. If you do this you must produce your own numerics,
491 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
492 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
496 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
497 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
498 * processing on the actual channel record at this point, however the channel NAME will still be passed in
499 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
500 * @param user The user joining the channel
501 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
502 * @param cname The channel name being joined. For new channels this is valid where chan is not.
503 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "o".
504 * You may alter this string to alter the user's modes on the channel.
505 * @param keygiven The key given to join the channel, or an empty string if none was provided
506 * @return 1 To prevent the join, 0 to allow it.
508 virtual ModResult OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string &privs, const std::string &keygiven);
510 /** Called whenever a user is about to be kicked.
511 * Returning a value of 1 from this function stops the process immediately, causing no
512 * output to be sent to the user by the core. If you do this you must produce your own numerics,
514 * @param source The user issuing the kick
515 * @param user The user being kicked
516 * @param chan The channel the user is being kicked from
517 * @param reason The kick reason
518 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
520 virtual ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason);
522 /** Called whenever a user is kicked.
523 * If this method is called, the kick is already underway and cannot be prevented, so
524 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
525 * @param source The user issuing the kick
526 * @param user The user being kicked
527 * @param chan The channel the user is being kicked from
528 * @param reason The kick reason
530 virtual void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except_list);
532 /** Called whenever a user opers locally.
533 * The User will contain the oper mode 'o' as this function is called after any modifications
534 * are made to the user's structure by the core.
535 * @param user The user who is opering up
536 * @param opertype The opers type name
538 virtual void OnOper(User* user, const std::string &opertype);
540 /** Called after a user opers locally.
541 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
542 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
543 * out the OPERTYPE, etc.
544 * @param user The user who is opering up
545 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
546 * @param opertype The opers type name
548 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
550 /** Called whenever a user types /INFO.
551 * The User will contain the information of the user who typed the command. Modules may use this
552 * method to output their own credits in /INFO (which is the ircd's version of an about box).
553 * It is purposefully not possible to modify any info that has already been output, or halt the list.
554 * You must write a 371 numeric to the user, containing your info in the following format:
556 * <nick> :information here
558 * @param user The user issuing /INFO
560 virtual void OnInfo(User* user);
562 /** Called whenever a /WHOIS is performed on a local user.
563 * The source parameter contains the details of the user who issued the WHOIS command, and
564 * the dest parameter contains the information of the user they are whoising.
565 * @param source The user issuing the WHOIS command
566 * @param dest The user who is being WHOISed
568 virtual void OnWhois(User* source, User* dest);
570 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
571 * Returning 1 from this function stops the process immediately, causing no
572 * output to be sent to the user by the core. If you do this you must produce your own numerics,
573 * notices etc. This is useful for modules which may want to filter invites to channels.
574 * @param source The user who is issuing the INVITE
575 * @param dest The user being invited
576 * @param channel The channel the user is being invited to
577 * @param timeout The time the invite will expire (0 == never)
578 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
580 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
582 /** Called after a user has been successfully invited to a channel.
583 * You cannot prevent the invite from occuring using this function, to do that,
584 * use OnUserPreInvite instead.
585 * @param source The user who is issuing the INVITE
586 * @param dest The user being invited
587 * @param channel The channel the user is being invited to
588 * @param timeout The time the invite will expire (0 == never)
590 virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout);
592 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
593 * Returning any nonzero value from this function stops the process immediately, causing no
594 * output to be sent to the user by the core. If you do this you must produce your own numerics,
595 * notices etc. This is useful for modules which may want to filter or redirect messages.
596 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
597 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
598 * of where the message is destined to be sent.
599 * @param user The user sending the message
600 * @param dest The target of the message (Channel* or User*)
601 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
602 * @param text Changeable text being sent by the user
603 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
604 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
605 * It will be ignored for private messages.
606 * @return 1 to deny the message, 0 to allow it
608 virtual ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
610 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
611 * Returning any nonzero value from this function stops the process immediately, causing no
612 * output to be sent to the user by the core. If you do this you must produce your own numerics,
613 * notices etc. This is useful for modules which may want to filter or redirect messages.
614 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
615 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
616 * of where the message is destined to be sent.
617 * You may alter the message text as you wish before relinquishing control to the next module
618 * in the chain, and if no other modules block the text this altered form of the text will be sent out
619 * to the user and possibly to other servers.
620 * @param user The user sending the message
621 * @param dest The target of the message (Channel* or User*)
622 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
623 * @param text Changeable text being sent by the user
624 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
625 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
626 * It will be ignored for private notices.
627 * @return 1 to deny the NOTICE, 0 to allow it
629 virtual ModResult OnUserPreNotice(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
631 /** Called when sending a message to all "neighbors" of a given user -
632 * that is, all users that share a common channel. This is used in
633 * commands such as NICK, QUIT, etc.
634 * @param source The source of the message
635 * @param include_c Channels to scan for users to include
636 * @param exceptions Map of user->bool that overrides the inclusion decision
638 * Set exceptions[user] = true to include, exceptions[user] = false to exclude
640 virtual void OnBuildNeighborList(User* source, UserChanList &include_c, std::map<User*,bool> &exceptions);
642 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
643 * Please note that although you can see remote nickchanges through this function, you should
644 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
645 * check user->server before taking any action (including returning nonzero from the method).
646 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
647 * module to generate some meaninful output.
648 * @param user The username changing their nick
649 * @param newnick Their new nickname
650 * @return 1 to deny the change, 0 to allow
652 virtual ModResult OnUserPreNick(User* user, const std::string &newnick);
654 /** Called after any PRIVMSG sent from a user.
655 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
656 * if target_type is TYPE_CHANNEL.
657 * @param user The user sending the message
658 * @param dest The target of the message
659 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
660 * @param text the text being sent by the user
661 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
663 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
665 /** Called after any NOTICE sent from a user.
666 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
667 * if target_type is TYPE_CHANNEL.
668 * @param user The user sending the message
669 * @param dest The target of the message
670 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
671 * @param text the text being sent by the user
672 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
674 virtual void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
676 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
677 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
678 * if target_type is TYPE_CHANNEL.
679 * The difference between this event and OnUserPreNotice/OnUserPreMessage is that delivery is gauranteed,
680 * the message has already been vetted. In the case of the other two methods, a later module may stop your
681 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
682 * @param user The user sending the message
683 * @param dest The target of the message
684 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
685 * @param text the text being sent by the user
686 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
688 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
690 /** Called after every MODE command sent from a user
691 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
692 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
693 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
694 * @param user The user sending the MODEs
695 * @param dest The target of the modes (User* or Channel*)
696 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
697 * @param text The actual modes and their parameters if any
698 * @param translate The translation types of the mode parameters
700 virtual void OnMode(User* user, void* dest, int target_type, const std::vector<std::string> &text, const std::vector<TranslateType> &translate);
702 /** Allows modules to alter or create server descriptions
703 * Whenever a module requires a server description, for example for display in
704 * WHOIS, this function is called in all modules. You may change or define the
705 * description given in std::string &description. If you do, this description
706 * will be shown in the WHOIS fields.
707 * @param servername The servername being searched for
708 * @param description Alterable server description for this server
710 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
712 /** Allows modules to synchronize data which relates to users during a netburst.
713 * When this function is called, it will be called from the module which implements
714 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
715 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
716 * (see below). This function will be called for every user visible on your side
717 * of the burst, allowing you to for example set modes, etc. Do not use this call to
718 * synchronize data which you have stored using class Extensible -- There is a specialist
719 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
720 * @param user The user being syncronized
721 * @param proto A pointer to the module handling network protocol
722 * @param opaque An opaque pointer set by the protocol module, should not be modified!
724 virtual void OnSyncUser(User* user, Module* proto, void* opaque);
726 /** Allows modules to synchronize data which relates to channels during a netburst.
727 * When this function is called, it will be called from the module which implements
728 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
729 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
730 * (see below). This function will be called for every user visible on your side
731 * of the burst, allowing you to for example set modes, etc.
733 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
735 * @param chan The channel being syncronized
736 * @param proto A pointer to the module handling network protocol
737 * @param opaque An opaque pointer set by the protocol module, should not be modified!
739 virtual void OnSyncChannel(Channel* chan, Module* proto, void* opaque);
741 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
742 * Whenever the linking module wants to send out data, but doesnt know what the data
743 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
744 * this method is called. You should use the ProtoSendMetaData function after you've
745 * correctly decided how the data should be represented, to send the metadata on its way if
746 * if it belongs to your module.
747 * @param proto A pointer to the module handling network protocol
748 * @param opaque An opaque pointer set by the protocol module, should not be modified!
749 * @param displayable If this value is true, the data is going to be displayed to a user,
750 * and not sent across the network. Use this to determine wether or not to show sensitive data.
752 virtual void OnSyncNetwork(Module* proto, void* opaque);
754 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
755 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
756 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
757 * @param target The Channel* or User* that data should be added to
758 * @param extname The extension name which is being sent
759 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
761 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
763 /** Implemented by modules which provide the ability to link servers.
764 * These modules will implement this method, which allows transparent sending of servermodes
765 * down the network link as a broadcast, without a module calling it having to know the format
766 * of the MODE command before the actual mode string.
768 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
769 * of how to use this function.
771 * @param opaque An opaque pointer set by the protocol module, should not be modified!
772 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
773 * @param target The Channel* or User* that modes should be sent for
774 * @param modeline The modes and parameters to be sent
775 * @param translate The translation types of the mode parameters
777 virtual void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::vector<std::string> &modeline, const std::vector<TranslateType> &translate);
779 /** Implemented by modules which provide the ability to link servers.
780 * These modules will implement this method, which allows metadata (extra data added to
781 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
782 * to other servers on a netburst and decoded at the other end by the same module on a
785 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
786 * how to use this function.
787 * @param opaque An opaque pointer set by the protocol module, should not be modified!
788 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
789 * @param target The Channel* or User* that metadata should be sent for
790 * @param extname The extension name to send metadata for
791 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
793 virtual void ProtoSendMetaData(void* opaque, Extensible* target, const std::string &extname, const std::string &extdata);
795 /** Called after every WALLOPS command.
796 * @param user The user sending the WALLOPS
797 * @param text The content of the WALLOPS message
799 virtual void OnWallops(User* user, const std::string &text);
801 /** Called whenever a user's hostname is changed.
802 * This event triggers after the host has been set.
803 * @param user The user whos host is being changed
804 * @param newhost The new hostname being set
806 virtual void OnChangeHost(User* user, const std::string &newhost);
808 /** Called whenever a user's GECOS (realname) is changed.
809 * This event triggers after the name has been set.
810 * @param user The user who's GECOS is being changed
811 * @param gecos The new GECOS being set on the user
813 virtual void OnChangeName(User* user, const std::string &gecos);
815 /** Called whenever a user's IDENT is changed.
816 * This event triggers after the name has been set.
817 * @param user The user who's IDENT is being changed
818 * @param gecos The new IDENT being set on the user
820 virtual void OnChangeIdent(User* user, const std::string &ident);
822 /** Called whenever an xline is added by a local user.
823 * This method is triggered after the line is added.
824 * @param source The sender of the line or NULL for local server
825 * @param line The xline being added
827 virtual void OnAddLine(User* source, XLine* line);
829 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
830 * This method is triggered after the line is deleted.
831 * @param source The user removing the line or NULL for local server
832 * @param line the line being deleted
834 virtual void OnDelLine(User* source, XLine* line);
836 /** Called whenever an xline expires.
837 * This method is triggered after the line is deleted.
838 * @param line The line being deleted.
840 virtual void OnExpireLine(XLine *line);
842 /** Called before your module is unloaded to clean up Extensibles.
843 * This method is called once for every user and channel on the network,
844 * so that when your module unloads it may clear up any remaining data
845 * in the form of Extensibles added using Extensible::Extend().
846 * If the target_type variable is TYPE_USER, then void* item refers to
847 * a User*, otherwise it refers to a Channel*.
848 * @param target_type The type of item being cleaned
849 * @param item A pointer to the item's class
851 virtual void OnCleanup(int target_type, void* item);
853 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
854 * have been applied. Please note that although you can see remote nickchanges through this function, you should
855 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
856 * check user->server before taking any action (including returning nonzero from the method).
857 * Because this method is called after the nickchange is taken place, no return values are possible
858 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
859 * @param user The user changing their nick
860 * @param oldnick The old nickname of the user before the nickchange
862 virtual void OnUserPostNick(User* user, const std::string &oldnick);
864 /** Called before any mode change, to allow a single access check for
865 * a full mode change (use OnRawMode to check individual modes)
867 * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
868 * OnRawMode for each individual mode
870 * @param source the user making the mode change
871 * @param dest the user destination of the umode change (NULL if a channel mode)
872 * @param channel the channel destination of the mode change
873 * @param parameters raw mode parameters; parameters[0] is the user/channel being changed
875 virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, const std::vector<std::string>& parameters);
877 /** Called when a 005 numeric is about to be output.
878 * The module should modify the 005 numeric if needed to indicate its features.
879 * @param output The 005 string to be modified if neccessary.
881 virtual void On005Numeric(std::string &output);
883 /** Called when a client is disconnected by KILL.
884 * If a client is killed by a server, e.g. a nickname collision or protocol error,
886 * Return 1 from this function to prevent the kill, and 0 from this function to allow
887 * it as normal. If you prevent the kill no output will be sent to the client, it is
888 * down to your module to generate this information.
889 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
890 * If you do so youre risking race conditions, desyncs and worse!
891 * @param source The user sending the KILL
892 * @param dest The user being killed
893 * @param reason The kill reason
894 * @return 1 to prevent the kill, 0 to allow
896 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
898 /** Called when an oper wants to disconnect a remote user via KILL
899 * @param source The user sending the KILL
900 * @param dest The user being killed
901 * @param reason The kill reason
903 virtual void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
905 /** Called whenever a module is loaded.
906 * mod will contain a pointer to the module, and string will contain its name,
907 * for example m_widgets.so. This function is primary for dependency checking,
908 * your module may decide to enable some extra features if it sees that you have
909 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
910 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
911 * but instead operate under reduced functionality, unless the dependency is
912 * absolutely neccessary (e.g. a module that extends the features of another
914 * @param mod A pointer to the new module
916 virtual void OnLoadModule(Module* mod);
918 /** Called whenever a module is unloaded.
919 * mod will contain a pointer to the module, and string will contain its name,
920 * for example m_widgets.so. This function is primary for dependency checking,
921 * your module may decide to enable some extra features if it sees that you have
922 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
923 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
924 * but instead operate under reduced functionality, unless the dependency is
925 * absolutely neccessary (e.g. a module that extends the features of another
927 * @param mod Pointer to the module being unloaded (still valid)
928 * @param name The filename of the module being unloaded
930 virtual void OnUnloadModule(Module* mod);
932 /** Called once every five seconds for background processing.
933 * This timer can be used to control timed features. Its period is not accurate
934 * enough to be used as a clock, but it is gauranteed to be called at least once in
935 * any five second period, directly from the main loop of the server.
936 * @param curtime The current timer derived from time(2)
938 virtual void OnBackgroundTimer(time_t curtime);
940 /** Called whenever any command is about to be executed.
941 * This event occurs for all registered commands, wether they are registered in the core,
942 * or another module, and for invalid commands. Invalid commands may only be sent to this
943 * function when the value of validated is false. By returning 1 from this method you may prevent the
944 * command being executed. If you do this, no output is created by the core, and it is
945 * down to your module to produce any output neccessary.
946 * Note that unless you return 1, you should not destroy any structures (e.g. by using
947 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
948 * method returns, it will be passed an invalid pointer to the user object and crash!)
949 * @param command The command being executed
950 * @param parameters An array of array of characters containing the parameters for the command
951 * @param pcnt The nuimber of parameters passed to the command
952 * @param user the user issuing the command
953 * @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.
954 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
955 * @param original_line The entire original line as passed to the parser from the user
956 * @return 1 to block the command, 0 to allow
958 virtual ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, User *user, bool validated, const std::string &original_line);
960 /** Called after any command has been executed.
961 * This event occurs for all registered commands, wether they are registered in the core,
962 * or another module, but it will not occur for invalid commands (e.g. ones which do not
963 * exist within the command table). The result code returned by the command handler is
965 * @param command The command being executed
966 * @param parameters An array of array of characters containing the parameters for the command
967 * @param pcnt The nuimber of parameters passed to the command
968 * @param user the user issuing the command
969 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
970 * @param original_line The entire original line as passed to the parser from the user
972 virtual void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, User *user, CmdResult result, const std::string &original_line);
974 /** Called to check if a user who is connecting can now be allowed to register
975 * If any modules return false for this function, the user is held in the waiting
976 * state until all modules return true. For example a module which implements ident
977 * lookups will continue to return false for a user until their ident lookup is completed.
978 * Note that the registration timeout for a user overrides these checks, if the registration
979 * timeout is reached, the user is disconnected even if modules report that the user is
980 * not ready to connect.
981 * @param user The user to check
982 * @return true to indicate readiness, false if otherwise
984 virtual ModResult OnCheckReady(User* user);
986 /** Called whenever a user is about to register their connection (e.g. before the user
987 * is sent the MOTD etc). Modules can use this method if they are performing a function
988 * which must be done before the actual connection is completed (e.g. ident lookups,
989 * dnsbl lookups, etc).
990 * Note that you should NOT delete the user record here by causing a disconnection!
991 * Use OnUserConnect for that instead.
992 * @param user The user registering
993 * @return 1 to indicate user quit, 0 to continue
995 virtual ModResult OnUserRegister(User* user);
997 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
998 * This method will always be called for each join, wether or not the channel is actually +i, and
999 * determines the outcome of an if statement around the whole section of invite checking code.
1000 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1001 * @param user The user joining the channel
1002 * @param chan The channel being joined
1003 * @return 1 to explicitly allow the join, 0 to proceed as normal
1005 virtual ModResult OnCheckInvite(User* user, Channel* chan);
1007 /** Called whenever a mode character is processed.
1008 * Return 1 from this function to block the mode character from being processed entirely.
1009 * @param user The user who is sending the mode
1010 * @param chan The channel the mode is being sent to (or NULL if a usermode)
1011 * @param mode The mode character being set
1012 * @param param The parameter for the mode or an empty string
1013 * @param adding true of the mode is being added, false if it is being removed
1014 * @param pcnt The parameter count for the mode (0 or 1)
1015 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
1016 * to skip all permission checking. Please note that for remote mode changes, your return value
1019 virtual ModResult OnRawMode(User* user, Channel* chan, const char mode, const std::string ¶m, bool adding, int pcnt);
1021 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1022 * This method will always be called for each join, wether or not the channel is actually +k, and
1023 * determines the outcome of an if statement around the whole section of key checking code.
1024 * if the user specified no key, the keygiven string will be a valid but empty value.
1025 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1026 * @param user The user joining the channel
1027 * @param chan The channel being joined
1028 * @return 1 to explicitly allow the join, 0 to proceed as normal
1030 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
1032 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1033 * This method will always be called for each join, wether or not the channel is actually +l, and
1034 * determines the outcome of an if statement around the whole section of channel limit checking code.
1035 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1036 * @param user The user joining the channel
1037 * @param chan The channel being joined
1038 * @return 1 to explicitly allow the join, 0 to proceed as normal
1040 virtual ModResult OnCheckLimit(User* user, Channel* chan);
1043 * Checks for a user's ban from the channel
1044 * @param user The user to check
1045 * @param chan The channel to check in
1046 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1047 * ban check, or MOD_RES_PASSTHRU to check bans normally
1049 virtual ModResult OnCheckChannelBan(User* user, Channel* chan);
1052 * Checks for a user's match of a single ban
1053 * @param user The user to check for match
1054 * @param chan The channel on which the match is being checked
1055 * @param mask The mask being checked
1056 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1057 * ban check, or MOD_RES_PASSTHRU to check bans normally
1059 virtual ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask);
1061 /** Checks for a match on a given extban type
1062 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1063 * ban check, or MOD_RES_PASSTHRU to check bans normally
1065 virtual ModResult OnExtBanCheck(User* user, Channel* chan, char type);
1067 /** Called on all /STATS commands
1068 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1069 * @param symbol the symbol provided to /STATS
1070 * @param user the user issuing the /STATS command
1071 * @param results A string_list to append results into. You should put all your results
1072 * into this string_list, rather than displaying them directly, so that your handler will
1073 * work when remote STATS queries are received.
1074 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1076 virtual ModResult OnStats(char symbol, User* user, string_list &results);
1078 /** Called whenever a change of a local users displayed host is attempted.
1079 * Return 1 to deny the host change, or 0 to allow it.
1080 * @param user The user whos host will be changed
1081 * @param newhost The new hostname
1082 * @return 1 to deny the host change, 0 to allow
1084 virtual ModResult OnChangeLocalUserHost(User* user, const std::string &newhost);
1086 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1087 * return 1 to deny the name change, or 0 to allow it.
1088 * @param user The user whos GECOS will be changed
1089 * @param newhost The new GECOS
1090 * @return 1 to deny the GECOS change, 0 to allow
1092 virtual ModResult OnChangeLocalUserGECOS(User* user, const std::string &newhost);
1094 /** Called before a topic is changed.
1095 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
1096 * As with other 'pre' events, you should only ever block a local event.
1097 * @param user The user changing the topic
1098 * @param chan The channels who's topic is being changed
1099 * @param topic The actual topic text
1100 * @param 1 to block the topic change, 0 to allow
1102 virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
1104 /** Called whenever a topic has been changed.
1105 * To block topic changes you must use OnPreTopicChange instead.
1106 * @param user The user changing the topic
1107 * @param chan The channels who's topic is being changed
1108 * @param topic The actual topic text
1110 virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
1112 /** Called whenever an Event class is sent to all modules by another module.
1113 * You should *always* check the value of Event::id to determine the event type.
1114 * @param event The Event class being received
1116 virtual void OnEvent(Event& event);
1118 /** Called whenever a Request class is sent to your module by another module.
1119 * The value of Request::id should be used to determine the type of request.
1120 * @param request The Request class being received
1122 virtual void OnRequest(Request& request);
1124 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
1125 * The password field (from the config file) is in 'password' and is to be compared against
1126 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
1127 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
1128 * @param ex The object that's causing the authentication (User* for <oper> <connect:allow> etc, Server* for <link>).
1129 * @param password The password from the configuration file (the password="" value).
1130 * @param input The password entered by the user or whoever.
1131 * @param hashtype The hash value from the config
1132 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
1134 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
1136 /** Called whenever a user is given usermode +o, anywhere on the network.
1137 * You cannot override this and prevent it from happening as it is already happened and
1138 * such a task must be performed by another server. You can however bounce modes by sending
1139 * servermodes out to reverse mode changes.
1140 * @param user The user who is opering
1142 virtual void OnGlobalOper(User* user);
1144 /** Called after a user has fully connected and all modules have executed OnUserConnect
1145 * This event is informational only. You should not change any user information in this
1146 * event. To do so, use the OnUserConnect method to change the state of local users.
1147 * This is called for both local and remote users.
1148 * @param user The user who is connecting
1150 virtual void OnPostConnect(User* user);
1152 /** Called whenever a ban is added to a channel's list.
1153 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1154 * @param source The user adding the ban
1155 * @param channel The channel the ban is being added to
1156 * @param banmask The ban mask being added
1157 * @return 1 to block the ban, 0 to continue as normal
1159 virtual ModResult OnAddBan(User* source, Channel* channel,const std::string &banmask);
1161 /** Called whenever a ban is removed from a channel's list.
1162 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1163 * @param source The user deleting the ban
1164 * @param channel The channel the ban is being deleted from
1165 * @param banmask The ban mask being deleted
1166 * @return 1 to block the unban, 0 to continue as normal
1168 virtual ModResult OnDelBan(User* source, Channel* channel,const std::string &banmask);
1170 /** Called to install an I/O hook on an event handler
1171 * @param user The item to possibly install the I/O hook on
1172 * @param via The port that <user> connected on
1174 virtual void OnHookIO(StreamSocket*, ListenSocketBase* via);
1176 /** Called immediately after any connection is accepted. This is intended for raw socket
1177 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1178 * no information relating to a user record as the connection has not been assigned yet.
1179 * There are no return values from this call as all modules get an opportunity if required to
1180 * process the connection.
1181 * @param fd The file descriptor returned from accept()
1182 * @param client The client IP address and port
1183 * @param server The server IP address and port
1184 * @param localport The local port number the user connected to
1186 virtual void OnStreamSocketAccept(StreamSocket*, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
1189 * Called when a hooked stream has data to write, or when the socket
1190 * engine returns it as writable
1191 * @param socket The socket in question
1192 * @param sendq Data to send to the socket
1193 * @return 1 if the sendq has been completely emptied, 0 if there is
1194 * still data to send, and -1 if there was an error
1196 virtual int OnStreamSocketWrite(StreamSocket*, std::string& sendq);
1198 /** Called immediately before any socket is closed. When this event is called, shutdown()
1199 * has not yet been called on the socket.
1200 * @param fd The file descriptor of the socket prior to close()
1202 virtual void OnStreamSocketClose(StreamSocket*);
1204 /** Called immediately upon connection of an outbound BufferedSocket which has been hooked
1206 * @param fd The file descriptor of the socket immediately after connect()
1208 virtual void OnStreamSocketConnect(StreamSocket*);
1211 * Called when the stream socket has data to read
1212 * @param socket The socket that is ready
1213 * @param recvq The receive queue that new data should be appended to
1214 * @return 1 if new data has been read, 0 if no new data is ready (but the
1215 * socket is still connected), -1 if there was an error or close
1217 virtual int OnStreamSocketRead(StreamSocket*, std::string& recvq);
1219 /** Called whenever a user sets away or returns from being away.
1220 * The away message is available as a parameter, but should not be modified.
1221 * At this stage, it has already been copied into the user record.
1222 * If awaymsg is empty, the user is returning from away.
1223 * @param user The user setting away
1224 * @param awaymsg The away message of the user, or empty if returning from away
1225 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
1227 virtual ModResult OnSetAway(User* user, const std::string &awaymsg);
1229 /** Called whenever a NAMES list is requested.
1230 * You can produce the nameslist yourself, overriding the current list,
1231 * and if you do you must return 1. If you do not handle the names list,
1233 * @param The user requesting the NAMES list
1234 * @param Ptr The channel the NAMES list is requested for
1236 virtual ModResult OnUserList(User* user, Channel* Ptr);
1238 /** Called whenever a line of WHOIS output is sent to a user.
1239 * You may change the numeric and the text of the output by changing
1240 * the values numeric and text, but you cannot change the user the
1241 * numeric is sent to. You may however change the user's User values.
1242 * @param user The user the numeric is being sent to
1243 * @param dest The user being WHOISed
1244 * @param numeric The numeric of the line being sent
1245 * @param text The text of the numeric, including any parameters
1246 * @return nonzero to drop the line completely so that the user does not
1247 * receive it, or zero to allow the line to be sent.
1249 virtual ModResult OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
1251 /** Called at intervals for modules to garbage-collect any hashes etc.
1252 * Certain data types such as hash_map 'leak' buckets, which must be
1253 * tidied up and freed by copying into a new item every so often. This
1254 * method is called when it is time to do that.
1256 virtual void OnGarbageCollect();
1258 /** Add test suite hooks here. These are used for testing functionality of a module
1259 * via the --testsuite debugging parameter.
1261 virtual void OnRunTestSuite();
1263 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
1264 * For example NAMESX, channel mode +u and +I, and UHNAMES. If the nick is set to an empty string by any
1265 * module, then this will cause the nickname not to be displayed at all.
1267 virtual void OnNamesListItem(User* issuer, Membership* item, std::string &prefixes, std::string &nick);
1269 virtual ModResult OnNumeric(User* user, unsigned int numeric, const std::string &text);
1271 /** Called whenever a result from /WHO is about to be returned
1272 * @param source The user running the /WHO query
1273 * @param user The user that this line of the query is about
1274 * @param channel The channel being queried (or NULL if not a channel query)
1275 * @param line The raw line to send; modifiable, if empty no line will be returned.
1277 virtual void OnSendWhoLine(User* source, User* user, Channel* channel, std::string& line);
1279 /** Called to check whether a channel restriction mode applies to a user on it
1280 * @return MOD_RES_DENY to apply the restriction, MOD_RES_ALLOW to bypass
1281 * the restriction, or MOD_RES_PASSTHRU to check restriction status normally
1283 virtual ModResult OnChannelRestrictionApply(User* user, Channel* chan, const char* restriction);
1287 #define CONF_NO_ERROR 0x000000
1288 #define CONF_NOT_A_NUMBER 0x000010
1289 #define CONF_INT_NEGATIVE 0x000080
1290 #define CONF_VALUE_NOT_FOUND 0x000100
1291 #define CONF_FILE_NOT_FOUND 0x000200
1294 /** Allows reading of values from configuration files
1295 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1296 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1297 * Constructing the class using one parameter allows you to specify a path to your own configuration
1298 * file, otherwise, inspircd.conf is read.
1300 class CoreExport ConfigReader : public classbase
1308 /** Default constructor.
1309 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1310 * as specified when running ./configure.
1313 /** Default destructor.
1314 * This method destroys the ConfigReader class.
1318 /** Retrieves a value from the config file.
1319 * This method retrieves a value from the config file. Where multiple copies of the tag
1320 * exist in the config file, index indicates which of the values to retrieve.
1322 std::string ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds = false);
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. If the
1326 * tag is not found the default value is returned instead.
1328 std::string ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds = false);
1330 /** Retrieves a boolean value from the config file.
1331 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1332 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1333 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1335 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1336 /** Retrieves a boolean value from the config file.
1337 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1338 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1339 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1340 * If the tag is not found, the default value is used instead.
1342 bool ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index);
1344 /** Retrieves an integer value from the config file.
1345 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1346 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1347 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1348 * return CONF_INVALID_NUMBER to be returned. need_positive is set if the number must be non-negative.
1349 * If a negative number is placed into a tag which is specified positive, 0 will be returned and GetError()
1350 * will return CONF_INT_NEGATIVE. Note that need_positive is not suitable to get an unsigned int - you
1351 * should cast the result to achieve that effect.
1353 int ReadInteger(const std::string &tag, const std::string &name, int index, bool need_positive);
1354 /** Retrieves an integer value from the config file.
1355 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1356 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1357 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1358 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1359 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1360 * will return CONF_NOT_UNSIGNED. If the tag is not found, the default value is used instead.
1362 int ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool need_positive);
1364 /** Returns the last error to occur.
1365 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1366 * A call to GetError() resets the error flag back to 0.
1370 /** Counts the number of times a given tag appears in the config file.
1371 * This method counts the number of times a tag appears in a config file, for use where
1372 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1373 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1374 * multiple instance tag.
1376 int Enumerate(const std::string &tag);
1381 /** Caches a text file into memory and can be used to retrieve lines from it.
1382 * This class contains methods for read-only manipulation of a text file in memory.
1383 * Either use the constructor type with one parameter to load a file into memory
1384 * at construction, or use the LoadFile method to load a file.
1386 class CoreExport FileReader : public classbase
1388 /** The file contents
1390 std::vector<std::string> fc;
1392 /** Content size in bytes
1394 unsigned long contentsize;
1396 /** Calculate content size in bytes
1401 /** Default constructor.
1402 * This method does not load any file into memory, you must use the LoadFile method
1403 * after constructing the class this way.
1407 /** Secondary constructor.
1408 * This method initialises the class with a file loaded into it ready for GetLine and
1409 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1412 FileReader(const std::string &filename);
1414 /** Default destructor.
1415 * This deletes the memory allocated to the file.
1419 /** Used to load a file.
1420 * This method loads a file into the class ready for GetLine and
1421 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1424 void LoadFile(const std::string &filename);
1426 /** Returns the whole content of the file as std::string
1428 std::string Contents();
1430 /** Returns the entire size of the file as std::string
1432 unsigned long ContentSize();
1434 /** Returns true if the file exists
1435 * This function will return false if the file could not be opened.
1439 /** Retrieve one line from the file.
1440 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1441 * the index was out of bounds, or the line had no data on it.
1443 std::string GetLine(int x);
1445 /** Returns the size of the file in lines.
1446 * This method returns the number of lines in the read file. If it is 0, no lines have been
1447 * read into memory, either because the file is empty or it does not exist, or cannot be
1448 * opened due to permission problems.
1453 /** A list of modules
1455 typedef std::vector<Module*> IntModuleList;
1457 /** An event handler iterator
1459 typedef IntModuleList::iterator EventHandlerIter;
1461 /** ModuleManager takes care of all things module-related
1464 class CoreExport ModuleManager : public classbase
1467 /** Holds a string describing the last module error to occur
1469 std::string LastModuleError;
1471 /** The feature names published by various modules
1473 featurelist Features;
1475 /** The interface names published by various modules
1477 interfacelist Interfaces;
1479 /** Total number of modules loaded into the ircd
1483 /** List of loaded modules and shared object/dll handles
1484 * keyed by module name
1486 std::map<std::string, Module*> Modules;
1492 } prioritizationState;
1494 /** Internal unload module hook */
1495 bool CanUnload(Module*);
1498 /** Event handler hooks.
1499 * This needs to be public to be used by FOREACH_MOD and friends.
1501 IntModuleList EventHandlers[I_END];
1503 /** Simple, bog-standard, boring constructor.
1511 /** Change the priority of one event in a module.
1512 * Each module event has a list of modules which are attached to that event type.
1513 * If you wish to be called before or after other specific modules, you may use this
1514 * method (usually within void Module::Prioritize()) to set your events priority.
1515 * You may use this call in other methods too, however, this is not supported behaviour
1517 * @param mod The module to change the priority of
1518 * @param i The event to change the priority of
1519 * @param s The state you wish to use for this event. Use one of
1520 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1521 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1522 * to set it to be before or after one or more other modules.
1523 * @param modules If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1524 * then this contains a list of one or more modules your module must be
1525 * placed before or after. Your module will be placed before the highest
1526 * priority module in this list for PRIO_BEFORE, or after the lowest
1527 * priority module in this list for PRIORITY_AFTER.
1528 * @param sz The number of modules being passed for PRIO_BEFORE and PRIORITY_AFTER.
1529 * Defaults to 1, as most of the time you will only want to prioritize your module
1530 * to be before or after one other module.
1532 bool SetPriority(Module* mod, Implementation i, Priority s, Module** modules = NULL, size_t sz = 1);
1534 /** Change the priority of all events in a module.
1535 * @param mod The module to set the priority of
1536 * @param s The priority of all events in the module.
1537 * Note that with this method, it is not possible to effectively use
1538 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1539 * SetPriority method for this, where you may specify other modules to
1540 * be prioritized against.
1542 bool SetPriority(Module* mod, Priority s);
1544 /** Attach an event to a module.
1545 * You may later detatch the event with ModuleManager::Detach().
1546 * If your module is unloaded, all events are automatically detatched.
1547 * @param i Event type to attach
1548 * @param mod Module to attach event to
1549 * @return True if the event was attached
1551 bool Attach(Implementation i, Module* mod);
1553 /** Detatch an event from a module.
1554 * This is not required when your module unloads, as the core will
1555 * automatically detatch your module from all events it is attached to.
1556 * @param i Event type to detach
1557 * @param mod Module to detach event from
1558 * @param Detach true if the event was detached
1560 bool Detach(Implementation i, Module* mod);
1562 /** Attach an array of events to a module
1563 * @param i Event types (array) to attach
1564 * @param mod Module to attach events to
1566 void Attach(Implementation* i, Module* mod, size_t sz);
1568 /** Detach all events from a module (used on unload)
1569 * @param mod Module to detach from
1571 void DetachAll(Module* mod);
1573 /** Returns text describing the last module error
1574 * @return The last error message to occur
1576 std::string& LastError();
1578 /** Load a given module file
1579 * @param filename The file to load
1580 * @return True if the module was found and loaded
1582 bool Load(const char* filename);
1584 /** Unload a given module file. Note that the module will not be
1585 * completely gone until the cull list has finished processing.
1587 * @return true on success; if false, LastError will give a reason
1589 bool Unload(Module* module);
1591 /** Run an asynchronous reload of the given module. When the reload is
1592 * complete, the callback will be run with true if the reload succeeded
1593 * and false if it did not.
1595 void Reload(Module* module, HandlerBase1<void, bool>* callback);
1597 /** Called by the InspIRCd constructor to load all modules from the config file.
1601 void DoSafeUnload(Module*);
1603 /** Get the total number of currently loaded modules
1604 * @return The number of loaded modules
1608 return this->ModCount;
1611 /** Find a module by name, and return a Module* to it.
1612 * This is preferred over iterating the module lists yourself.
1613 * @param name The module name to look up
1614 * @return A pointer to the module, or NULL if the module cannot be found
1616 Module* Find(const std::string &name);
1618 /** Publish a 'feature'.
1619 * There are two ways for a module to find another module it depends on.
1620 * Either by name, using InspIRCd::FindModule, or by feature, using this
1621 * function. A feature is an arbitary string which identifies something this
1622 * module can do. For example, if your module provides SSL support, but other
1623 * modules provide SSL support too, all the modules supporting SSL should
1624 * publish an identical 'SSL' feature. This way, any module requiring use
1625 * of SSL functions can just look up the 'SSL' feature using FindFeature,
1626 * then use the module pointer they are given.
1627 * @param FeatureName The case sensitive feature name to make available
1628 * @param Mod a pointer to your module class
1629 * @returns True on success, false if the feature is already published by
1632 bool PublishFeature(const std::string &FeatureName, Module* Mod);
1634 /** Publish a module to an 'interface'.
1635 * Modules which implement the same interface (the same way of communicating
1636 * with other modules) can publish themselves to an interface, using this
1637 * method. When they do so, they become part of a list of related or
1638 * compatible modules, and a third module may then query for that list
1639 * and know that all modules within that list offer the same API.
1640 * A prime example of this is the hashing modules, which all accept the
1641 * same types of Request class. Consider this to be similar to PublishFeature,
1642 * except for that multiple modules may publish the same 'feature'.
1643 * @param InterfaceName The case sensitive interface name to make available
1644 * @param Mod a pointer to your module class
1645 * @returns True on success, false on failure (there are currently no failure
1648 bool PublishInterface(const std::string &InterfaceName, Module* Mod);
1650 /** Return a pair saying how many other modules are currently using the
1651 * interfaces provided by module m.
1652 * @param m The module to count usage for
1653 * @return A pair, where the first value is the number of uses of the interface,
1654 * and the second value is the interface name being used.
1656 std::pair<int,std::string> GetInterfaceInstanceCount(Module* m);
1658 /** Mark your module as using an interface.
1659 * If you mark your module as using an interface, then that interface
1660 * module may not unload until your module has unloaded first.
1661 * This can be used to prevent crashes by ensuring code you depend on
1662 * is always in memory while your module is active.
1663 * @param InterfaceName The interface to use
1665 void UseInterface(const std::string &InterfaceName);
1667 /** Mark your module as finished with an interface.
1668 * If you used UseInterface() above, you should use this method when
1669 * your module is finished with the interface (usually in its destructor)
1670 * to allow the modules which implement the given interface to be unloaded.
1671 * @param InterfaceName The interface you are finished with using.
1673 void DoneWithInterface(const std::string &InterfaceName);
1675 /** Unpublish a 'feature'.
1676 * When your module exits, it must call this method for every feature it
1677 * is providing so that the feature table is cleaned up.
1678 * @param FeatureName the feature to remove
1680 bool UnpublishFeature(const std::string &FeatureName);
1682 /** Unpublish your module from an interface
1683 * When your module exits, it must call this method for every interface
1684 * it is part of so that the interfaces table is cleaned up. Only when
1685 * the last item is deleted from an interface does the interface get
1687 * @param InterfaceName the interface to be removed from
1688 * @param Mod The module to remove from the interface list
1690 bool UnpublishInterface(const std::string &InterfaceName, Module* Mod);
1692 /** Find a 'feature'.
1693 * There are two ways for a module to find another module it depends on.
1694 * Either by name, using InspIRCd::FindModule, or by feature, using the
1695 * InspIRCd::PublishFeature method. A feature is an arbitary string which
1696 * identifies something this module can do. For example, if your module
1697 * provides SSL support, but other modules provide SSL support too, all
1698 * the modules supporting SSL should publish an identical 'SSL' feature.
1699 * To find a module capable of providing the feature you want, simply
1700 * call this method with the feature name you are looking for.
1701 * @param FeatureName The feature name you wish to obtain the module for
1702 * @returns A pointer to a valid module class on success, NULL on failure.
1704 Module* FindFeature(const std::string &FeatureName);
1706 /** Find an 'interface'.
1707 * An interface is a list of modules which all implement the same API.
1708 * @param InterfaceName The Interface you wish to obtain the module
1710 * @return A pointer to a deque of Module*, or NULL if the interface
1713 modulelist* FindInterface(const std::string &InterfaceName);
1715 /** Determine if a module has published the named interface.
1716 * This could be used in, for example, OnLoadModule to pick up other modules that can be used.
1717 * @param mod The module to check.
1718 * @param InterfaceName the interface you want to check for
1719 * @return True if the module provides the interface, false otherwise.
1721 bool ModuleHasInterface(Module* mod, const std::string& InterfaceName);
1723 /** Given a pointer to a Module, return its filename
1724 * @param m The module pointer to identify
1725 * @return The module name or an empty string
1727 const std::string& GetModuleName(Module* m);
1729 /** Return a list of all modules matching the given filter
1730 * @param filter This int is a bitmask of flags set in Module::Flags,
1731 * such as VF_VENDOR or VF_STATIC. If you wish to receive a list of
1732 * all modules with no filtering, set this to 0.
1733 * @return The list of module names
1735 const std::vector<std::string> GetAllModuleNames(int filter);
1738 /** Do not mess with these functions unless you know the C preprocessor
1739 * well enough to explain why they are needed. The order is important.
1741 #define MODULE_INIT_STR MODULE_INIT_STR_FN_2(MODULE_INIT_SYM)
1742 #define MODULE_INIT_STR_FN_2(x) MODULE_INIT_STR_FN_1(x)
1743 #define MODULE_INIT_STR_FN_1(x) #x
1744 #define MODULE_INIT_SYM MODULE_INIT_SYM_FN_2(API_VERSION)
1745 #define MODULE_INIT_SYM_FN_2(x) MODULE_INIT_SYM_FN_1(x)
1746 #define MODULE_INIT_SYM_FN_1(x) inspircd_module_ ## x
1748 /** This definition is used as shorthand for the various classes
1749 * and functions needed to make a module loadable by the OS.
1750 * It defines the class factory and external init_module function.
1754 #define MODULE_INIT(y) \
1755 extern "C" DllExport Module * MODULE_INIT_SYM() \
1759 BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
1761 switch ( nReason ) \
1763 case DLL_PROCESS_ATTACH: \
1764 case DLL_PROCESS_DETACH: \
1772 #define MODULE_INIT(y) \
1773 extern "C" DllExport Module * MODULE_INIT_SYM() \
1779 #define COMMAND_INIT(c) MODULE_INIT(CommandModule<c>)