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_COMMON = 4, // module needs to be common on all servers in a network to link
37 VF_OPTCOMMON = 8, // module should be common on all servers for unsurprising behavior
38 VF_CORE = 16 // module is a core command, can be assumed loaded on all servers
41 /** Used with SendToMode()
48 /** Used to represent an event type, for user, channel or server
50 enum TargetTypeFlags {
57 /** Used to represent wether a message was PRIVMSG or NOTICE
64 #define MOD_RES_ALLOW (ModResult(1))
65 #define MOD_RES_PASSTHRU (ModResult(0))
66 #define MOD_RES_DENY (ModResult(-1))
68 /** Used to represent an allow/deny module result.
69 * Not constructed as an enum because it reverses the value logic of some functions;
70 * the compiler will inline accesses to have the same efficiency as integer operations.
74 ModResult() : res(0) {}
75 explicit ModResult(int r) : res(r) {}
76 inline bool operator==(const ModResult& r) const
80 inline bool operator!=(const ModResult& r) const
84 inline bool operator!() const
88 inline bool check(bool def) const
90 return (res == 1 || (res == 0 && def));
93 * Merges two results, preferring ALLOW to DENY
95 inline ModResult operator+(const ModResult& r) const
97 if (res == r.res || r.res == 0)
101 // they are different, and neither is passthru
102 return MOD_RES_ALLOW;
106 /** If you change the module API in any way, increment this value.
107 * This MUST be a pure integer, with no parenthesis
109 #define API_VERSION 136
113 /* Forward-delacare module for ModuleMessage etc
118 /** A set of strings.
120 typedef std::vector<std::string> string_list;
122 /** Holds a list of 'published features' for modules.
124 typedef std::map<std::string,Module*> featurelist;
126 /** Holds a list of modules which implement an interface
128 typedef std::deque<Module*> modulelist;
130 /** Holds a list of all modules which implement interfaces, by interface name
132 typedef std::map<std::string, std::pair<int, modulelist> > interfacelist;
135 * This #define allows us to call a method in all
136 * loaded modules in a readable simple way, e.g.:
137 * 'FOREACH_MOD(I_OnConnect,OnConnect(user));'
139 #define FOREACH_MOD(y,x) do { \
140 EventHandlerIter safei; \
141 for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ) \
149 catch (CoreException& modexcept) \
151 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
158 * Custom module result handling loop. This is a paired macro, and should only
159 * be used with while_each_hook.
161 * See src/channels.cpp for an example of use.
163 #define DO_EACH_HOOK(n,v,args) \
165 EventHandlerIter iter_ ## n = ServerInstance->Modules->EventHandlers[I_ ## n].begin(); \
166 while (iter_ ## n != ServerInstance->Modules->EventHandlers[I_ ## n].end()) \
168 Module* mod_ ## n = *iter_ ## n; \
172 v = (mod_ ## n)->n args;
174 #define WHILE_EACH_HOOK(n) \
176 catch (CoreException& except_ ## n) \
178 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s", (except_ ## n).GetReason()); \
179 (void) mod_ ## n; /* catch mismatched pairs */ \
185 * Module result iterator
186 * Runs the given hook until some module returns a useful result.
188 * Example: ModResult result;
189 * FIRST_MOD_RESULT(OnUserPreNick, result, (user, newnick))
191 #define FIRST_MOD_RESULT(n,v,args) do { \
192 v = MOD_RES_PASSTHRU; \
193 DO_EACH_HOOK(n,v,args) \
195 if (v != MOD_RES_PASSTHRU) \
198 WHILE_EACH_HOOK(n); \
201 /** Holds a module's Version information.
202 * The members (set by the constructor only) indicate details as to the version number
203 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
205 * The core provides only one implementation of the template, causing a run-time linking
206 * error when attempting to load a module compiled against a different API_VERSION.
209 class CoreExport VersionBase
212 /** Module description
214 const std::string description;
215 /** Version information.
217 const std::string version;
223 /** Initialize version class
225 VersionBase(const std::string &desc, int flags = VF_NONE, const std::string& src_rev = VERSION " r" REVISION);
228 typedef VersionBase<API_VERSION> Version;
230 /** The Request class is a unicast message directed at a given module.
231 * When this class is properly instantiated it may be sent to a module
232 * using the Send() method, which will call the given module's OnRequest
233 * method with this class as its parameter.
235 class CoreExport Request : public classbase
238 /** This should be a null-terminated string identifying the type of request,
239 * all modules should define this and use it to determine the nature of the
240 * request before they attempt to cast the Request in any way.
242 const char* const id;
243 /** This is a pointer to the sender of the message, which can be used to
244 * directly trigger events, or to create a reply.
247 /** The single destination of the Request
251 /** Create a new Request
252 * This is for the 'new' way of defining a subclass
253 * of Request and defining it in a common header,
254 * passing an object of your Request subclass through
255 * as a Request* and using the ID string to determine
256 * what to cast it back to and the other end.
258 Request(Module* src, Module* dst, const char* idstr);
259 /** Send the Request.
265 /** The Event class is a unicast message directed at all modules.
266 * When the class is properly instantiated it may be sent to all modules
267 * using the Send() method, which will trigger the OnEvent method in
268 * all modules passing the object as its parameter.
270 class CoreExport Event : public classbase
273 /** This is a pointer to the sender of the message, which can be used to
274 * directly trigger events, or to create a reply.
277 /** The event identifier.
278 * This is arbitary text which should be used to distinguish
279 * one type of event from another.
281 const std::string id;
283 /** Create a new Event
285 Event(Module* src, const std::string &eventid);
287 * The return result of an Event::Send() will always be NULL as
288 * no replies are expected.
293 /** Priority types which can be used by Module::Prioritize()
295 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
297 /** Implementation-specific flags which may be set in Module::Implements()
302 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash,
303 I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois,
304 I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick,
305 I_OnUserMessage, I_OnUserNotice, I_OnMode, I_OnGetServerDescription, I_OnSyncUser,
306 I_OnSyncChannel, I_OnDecodeMetaData, I_OnWallops,
307 I_OnChangeHost, I_OnChangeName, I_OnAddLine, I_OnDelLine, I_OnExpireLine,
308 I_OnUserPostNick, I_OnPreMode, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule,
309 I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite,
310 I_OnRawMode, I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckChannelBan, I_OnExtBanCheck,
311 I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnPreTopicChange,
312 I_OnPostTopicChange, I_OnEvent, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan,
313 I_OnDelBan, I_OnChangeLocalUserGECOS, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
314 I_OnPostOper, I_OnSyncNetwork, I_OnSetAway, I_OnUserList, I_OnPostCommand, I_OnPostJoin,
315 I_OnWhoisLine, I_OnBuildNeighborList, I_OnGarbageCollect,
316 I_OnText, I_OnPassCompare, I_OnRunTestSuite, I_OnNamesListItem, I_OnNumeric, I_OnHookIO,
317 I_OnPreRehash, I_OnModuleRehash, I_OnSendWhoLine, I_OnChangeIdent, I_OnChannelRestrictionApply,
323 /** Base class for all InspIRCd modules
324 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
325 * its methods will be called when irc server events occur. class inherited from module must be
326 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
328 class CoreExport Module : public classbase
330 unsigned int refcount;
331 friend class reference_base;
333 /** File that this module was loaded from
335 std::string ModuleSourceFile;
336 /** Reference to the dlopen() value
338 DLLManager* ModuleDLLManager;
340 /** Default constructor.
341 * Creates a module class.
342 * @param Me An instance of the InspIRCd class which will be saved into ServerInstance for your use
343 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
347 /** Clean up prior to destruction
348 * If you override, you must call this AFTER your module's cleanup
350 virtual CullResult cull();
352 /** Default destructor.
353 * destroys a module class
357 virtual void Prioritize()
361 /** Returns the version number of a Module.
362 * The method should return a Version object with its version information assigned via
365 virtual Version GetVersion() = 0;
367 /** Called when a user connects.
368 * The details of the connecting user are available to you in the parameter User *user
369 * @param user The user who is connecting
371 virtual void OnUserConnect(User* user);
373 /** Called when a user quits.
374 * The details of the exiting user are available to you in the parameter User *user
375 * This event is only called when the user is fully registered when they quit. To catch
376 * raw disconnections, use the OnUserDisconnect method.
377 * @param user The user who is quitting
378 * @param message The user's quit message (as seen by non-opers)
379 * @param oper_message The user's quit message (as seen by opers)
381 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
383 /** Called whenever a user's socket is closed.
384 * The details of the exiting user are available to you in the parameter User *user
385 * This event is called for all users, registered or not, as a cleanup method for modules
386 * which might assign resources to user, such as dns lookups, objects and sockets.
387 * @param user The user who is disconnecting
389 virtual void OnUserDisconnect(User* user);
391 /** Called whenever a channel is about to be deleted
392 * @param chan The channel being deleted
393 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
395 virtual ModResult OnChannelPreDelete(Channel *chan);
397 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
398 * @param chan The channel being deleted
400 virtual void OnChannelDelete(Channel* chan);
402 /** Called when a user joins a channel.
403 * The details of the joining user are available to you in the parameter User *user,
404 * and the details of the channel they have joined is available in the variable Channel *channel
405 * @param memb The channel membership being created
406 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
407 * to a channel due to the network sync.
408 * @param created This is true if the join created the channel
410 virtual void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list);
412 /** Called after a user joins a channel
413 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
415 * @param memb The channel membership created
417 virtual void OnPostJoin(Membership*);
419 /** Called when a user parts a channel.
420 * The details of the leaving user are available to you in the parameter User *user,
421 * and the details of the channel they have left is available in the variable Channel *channel
422 * @param memb The channel membership being destroyed
423 * @param partmessage The part message, or an empty string (may be modified)
425 virtual void OnUserPart(Membership* memb, std::string &partmessage, CUList& except_list);
427 /** Called on rehash.
428 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
429 * system. This is called in all cases -- including when this server will not execute the
430 * rehash because it is directed at a remote server.
432 * @param user The user performing the rehash, if any. If this is server initiated, the value of
433 * this variable will be NULL.
434 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
437 virtual void OnPreRehash(User* user, const std::string ¶meter);
439 /** Called on rehash.
440 * This method is called when a user initiates a module-specific rehash. This can be used to do
441 * expensive operations (such as reloading SSL certificates) that are not executed on a normal
442 * rehash for efficiency. A rehash of this type does not reload the core configuration.
444 * @param user The user performing the rehash.
445 * @param parameter The parameter given to REHASH
447 virtual void OnModuleRehash(User* user, const std::string ¶meter);
449 /** Called on rehash.
450 * This method is called after a rehash has completed. You should use it to reload any module
451 * configuration from the main configuration file.
452 * @param user The user that performed the rehash, if it was initiated by a user and that user
453 * is still connected.
455 virtual void OnRehash(User* user);
457 /** Called whenever a snotice is about to be sent to a snomask.
458 * snomask and type may both be modified; the message may not.
459 * @param snomask The snomask the message is going to (e.g. 'A')
460 * @param type The textual description the snomask will go to (e.g. 'OPER')
461 * @param message The text message to be sent via snotice
462 * @return 1 to block the snotice from being sent entirely, 0 else.
464 virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
466 /** Called whenever a user is about to join a channel, before any processing is done.
467 * Returning a value of 1 from this function stops the process immediately, causing no
468 * output to be sent to the user by the core. If you do this you must produce your own numerics,
469 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
470 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
474 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
475 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
476 * processing on the actual channel record at this point, however the channel NAME will still be passed in
477 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
478 * @param user The user joining the channel
479 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
480 * @param cname The channel name being joined. For new channels this is valid where chan is not.
481 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "o".
482 * You may alter this string to alter the user's modes on the channel.
483 * @param keygiven The key given to join the channel, or an empty string if none was provided
484 * @return 1 To prevent the join, 0 to allow it.
486 virtual ModResult OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string &privs, const std::string &keygiven);
488 /** Called whenever a user is about to be kicked.
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,
492 * @param source The user issuing the kick
493 * @param user The user being kicked
494 * @param chan The channel the user is being kicked from
495 * @param reason The kick reason
496 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
498 virtual ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason);
500 /** Called whenever a user is kicked.
501 * If this method is called, the kick is already underway and cannot be prevented, so
502 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
503 * @param source The user issuing the kick
504 * @param user The user being kicked
505 * @param chan The channel the user is being kicked from
506 * @param reason The kick reason
508 virtual void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except_list);
510 /** Called whenever a user opers locally.
511 * The User will contain the oper mode 'o' as this function is called after any modifications
512 * are made to the user's structure by the core.
513 * @param user The user who is opering up
514 * @param opertype The opers type name
516 virtual void OnOper(User* user, const std::string &opertype);
518 /** Called after a user opers locally.
519 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
520 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
521 * out the OPERTYPE, etc.
522 * @param user The user who is opering up
523 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
524 * @param opertype The opers type name
526 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
528 /** Called whenever a user types /INFO.
529 * The User will contain the information of the user who typed the command. Modules may use this
530 * method to output their own credits in /INFO (which is the ircd's version of an about box).
531 * It is purposefully not possible to modify any info that has already been output, or halt the list.
532 * You must write a 371 numeric to the user, containing your info in the following format:
534 * <nick> :information here
536 * @param user The user issuing /INFO
538 virtual void OnInfo(User* user);
540 /** Called whenever a /WHOIS is performed on a local user.
541 * The source parameter contains the details of the user who issued the WHOIS command, and
542 * the dest parameter contains the information of the user they are whoising.
543 * @param source The user issuing the WHOIS command
544 * @param dest The user who is being WHOISed
546 virtual void OnWhois(User* source, User* dest);
548 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
549 * Returning 1 from this function stops the process immediately, causing no
550 * output to be sent to the user by the core. If you do this you must produce your own numerics,
551 * notices etc. This is useful for modules which may want to filter invites to channels.
552 * @param source The user who is issuing the INVITE
553 * @param dest The user being invited
554 * @param channel The channel the user is being invited to
555 * @param timeout The time the invite will expire (0 == never)
556 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
558 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
560 /** Called after a user has been successfully invited to a channel.
561 * You cannot prevent the invite from occuring using this function, to do that,
562 * use OnUserPreInvite instead.
563 * @param source The user who is issuing the INVITE
564 * @param dest The user being invited
565 * @param channel The channel the user is being invited to
566 * @param timeout The time the invite will expire (0 == never)
568 virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout);
570 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
571 * Returning any nonzero value 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 or redirect messages.
574 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
575 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
576 * of where the message is destined to be sent.
577 * @param user The user sending the message
578 * @param dest The target of the message (Channel* or User*)
579 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
580 * @param text Changeable text being sent by the user
581 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
582 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
583 * It will be ignored for private messages.
584 * @return 1 to deny the message, 0 to allow it
586 virtual ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
588 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
589 * Returning any nonzero value from this function stops the process immediately, causing no
590 * output to be sent to the user by the core. If you do this you must produce your own numerics,
591 * notices etc. This is useful for modules which may want to filter or redirect messages.
592 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
593 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
594 * of where the message is destined to be sent.
595 * You may alter the message text as you wish before relinquishing control to the next module
596 * in the chain, and if no other modules block the text this altered form of the text will be sent out
597 * to the user and possibly to other servers.
598 * @param user The user sending the message
599 * @param dest The target of the message (Channel* or User*)
600 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
601 * @param text Changeable text being sent by the user
602 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
603 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
604 * It will be ignored for private notices.
605 * @return 1 to deny the NOTICE, 0 to allow it
607 virtual ModResult OnUserPreNotice(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
609 /** Called when sending a message to all "neighbors" of a given user -
610 * that is, all users that share a common channel. This is used in
611 * commands such as NICK, QUIT, etc.
612 * @param source The source of the message
613 * @param include_c Channels to scan for users to include
614 * @param exceptions Map of user->bool that overrides the inclusion decision
616 * Set exceptions[user] = true to include, exceptions[user] = false to exclude
618 virtual void OnBuildNeighborList(User* source, UserChanList &include_c, std::map<User*,bool> &exceptions);
620 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
621 * Please note that although you can see remote nickchanges through this function, you should
622 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
623 * check user->server before taking any action (including returning nonzero from the method).
624 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
625 * module to generate some meaninful output.
626 * @param user The username changing their nick
627 * @param newnick Their new nickname
628 * @return 1 to deny the change, 0 to allow
630 virtual ModResult OnUserPreNick(User* user, const std::string &newnick);
632 /** Called after any PRIVMSG sent from a user.
633 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
634 * if target_type is TYPE_CHANNEL.
635 * @param user The user sending the message
636 * @param dest The target of the message
637 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
638 * @param text the text being sent by the user
639 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
641 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
643 /** Called after any NOTICE sent from a user.
644 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
645 * if target_type is TYPE_CHANNEL.
646 * @param user The user sending the message
647 * @param dest The target of the message
648 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
649 * @param text the text being sent by the user
650 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
652 virtual void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
654 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
655 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
656 * if target_type is TYPE_CHANNEL.
657 * The difference between this event and OnUserPreNotice/OnUserPreMessage is that delivery is gauranteed,
658 * the message has already been vetted. In the case of the other two methods, a later module may stop your
659 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
660 * @param user The user sending the message
661 * @param dest The target of the message
662 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
663 * @param text the text being sent by the user
664 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
666 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
668 /** Called after every MODE command sent from a user
669 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
670 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
671 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
672 * @param user The user sending the MODEs
673 * @param dest The target of the modes (User* or Channel*)
674 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
675 * @param text The actual modes and their parameters if any
676 * @param translate The translation types of the mode parameters
678 virtual void OnMode(User* user, void* dest, int target_type, const std::vector<std::string> &text, const std::vector<TranslateType> &translate);
680 /** Allows modules to alter or create server descriptions
681 * Whenever a module requires a server description, for example for display in
682 * WHOIS, this function is called in all modules. You may change or define the
683 * description given in std::string &description. If you do, this description
684 * will be shown in the WHOIS fields.
685 * @param servername The servername being searched for
686 * @param description Alterable server description for this server
688 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
690 /** Allows modules to synchronize data which relates to users during a netburst.
691 * When this function is called, it will be called from the module which implements
692 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
693 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
694 * (see below). This function will be called for every user visible on your side
695 * of the burst, allowing you to for example set modes, etc. Do not use this call to
696 * synchronize data which you have stored using class Extensible -- There is a specialist
697 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
698 * @param user The user being syncronized
699 * @param proto A pointer to the module handling network protocol
700 * @param opaque An opaque pointer set by the protocol module, should not be modified!
702 virtual void OnSyncUser(User* user, Module* proto, void* opaque);
704 /** Allows modules to synchronize data which relates to channels during a netburst.
705 * When this function is called, it will be called from the module which implements
706 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
707 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
708 * (see below). This function will be called for every user visible on your side
709 * of the burst, allowing you to for example set modes, etc.
711 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
713 * @param chan The channel being syncronized
714 * @param proto A pointer to the module handling network protocol
715 * @param opaque An opaque pointer set by the protocol module, should not be modified!
717 virtual void OnSyncChannel(Channel* chan, Module* proto, void* opaque);
719 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
720 * Whenever the linking module wants to send out data, but doesnt know what the data
721 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
722 * this method is called. You should use the ProtoSendMetaData function after you've
723 * correctly decided how the data should be represented, to send the metadata on its way if
724 * if it belongs to your module.
725 * @param proto A pointer to the module handling network protocol
726 * @param opaque An opaque pointer set by the protocol module, should not be modified!
727 * @param displayable If this value is true, the data is going to be displayed to a user,
728 * and not sent across the network. Use this to determine wether or not to show sensitive data.
730 virtual void OnSyncNetwork(Module* proto, void* opaque);
732 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
733 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
734 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
735 * @param target The Channel* or User* that data should be added to
736 * @param extname The extension name which is being sent
737 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
739 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
741 /** Implemented by modules which provide the ability to link servers.
742 * These modules will implement this method, which allows transparent sending of servermodes
743 * down the network link as a broadcast, without a module calling it having to know the format
744 * of the MODE command before the actual mode string.
746 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
747 * of how to use this function.
749 * @param opaque An opaque pointer set by the protocol module, should not be modified!
750 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
751 * @param target The Channel* or User* that modes should be sent for
752 * @param modeline The modes and parameters to be sent
753 * @param translate The translation types of the mode parameters
755 virtual void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::vector<std::string> &modeline, const std::vector<TranslateType> &translate);
757 /** Implemented by modules which provide the ability to link servers.
758 * These modules will implement this method, which allows metadata (extra data added to
759 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
760 * to other servers on a netburst and decoded at the other end by the same module on a
763 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
764 * how to use this function.
765 * @param opaque An opaque pointer set by the protocol module, should not be modified!
766 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
767 * @param target The Channel* or User* that metadata should be sent for
768 * @param extname The extension name to send metadata for
769 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
771 virtual void ProtoSendMetaData(void* opaque, Extensible* target, const std::string &extname, const std::string &extdata);
773 /** Called after every WALLOPS command.
774 * @param user The user sending the WALLOPS
775 * @param text The content of the WALLOPS message
777 virtual void OnWallops(User* user, const std::string &text);
779 /** Called whenever a user's hostname is changed.
780 * This event triggers after the host has been set.
781 * @param user The user whos host is being changed
782 * @param newhost The new hostname being set
784 virtual void OnChangeHost(User* user, const std::string &newhost);
786 /** Called whenever a user's GECOS (realname) is changed.
787 * This event triggers after the name has been set.
788 * @param user The user who's GECOS is being changed
789 * @param gecos The new GECOS being set on the user
791 virtual void OnChangeName(User* user, const std::string &gecos);
793 /** Called whenever a user's IDENT is changed.
794 * This event triggers after the name has been set.
795 * @param user The user who's IDENT is being changed
796 * @param gecos The new IDENT being set on the user
798 virtual void OnChangeIdent(User* user, const std::string &ident);
800 /** Called whenever an xline is added by a local user.
801 * This method is triggered after the line is added.
802 * @param source The sender of the line or NULL for local server
803 * @param line The xline being added
805 virtual void OnAddLine(User* source, XLine* line);
807 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
808 * This method is triggered after the line is deleted.
809 * @param source The user removing the line or NULL for local server
810 * @param line the line being deleted
812 virtual void OnDelLine(User* source, XLine* line);
814 /** Called whenever an xline expires.
815 * This method is triggered after the line is deleted.
816 * @param line The line being deleted.
818 virtual void OnExpireLine(XLine *line);
820 /** Called before your module is unloaded to clean up Extensibles.
821 * This method is called once for every user and channel on the network,
822 * so that when your module unloads it may clear up any remaining data
823 * in the form of Extensibles added using Extensible::Extend().
824 * If the target_type variable is TYPE_USER, then void* item refers to
825 * a User*, otherwise it refers to a Channel*.
826 * @param target_type The type of item being cleaned
827 * @param item A pointer to the item's class
829 virtual void OnCleanup(int target_type, void* item);
831 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
832 * have been applied. Please note that although you can see remote nickchanges through this function, you should
833 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
834 * check user->server before taking any action (including returning nonzero from the method).
835 * Because this method is called after the nickchange is taken place, no return values are possible
836 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
837 * @param user The user changing their nick
838 * @param oldnick The old nickname of the user before the nickchange
840 virtual void OnUserPostNick(User* user, const std::string &oldnick);
842 /** Called before any mode change, to allow a single access check for
843 * a full mode change (use OnRawMode to check individual modes)
845 * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
846 * OnRawMode for each individual mode
848 * @param source the user making the mode change
849 * @param dest the user destination of the umode change (NULL if a channel mode)
850 * @param channel the channel destination of the mode change
851 * @param parameters raw mode parameters; parameters[0] is the user/channel being changed
853 virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, const std::vector<std::string>& parameters);
855 /** Called when a 005 numeric is about to be output.
856 * The module should modify the 005 numeric if needed to indicate its features.
857 * @param output The 005 string to be modified if neccessary.
859 virtual void On005Numeric(std::string &output);
861 /** Called when a client is disconnected by KILL.
862 * If a client is killed by a server, e.g. a nickname collision or protocol error,
864 * Return 1 from this function to prevent the kill, and 0 from this function to allow
865 * it as normal. If you prevent the kill no output will be sent to the client, it is
866 * down to your module to generate this information.
867 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
868 * If you do so youre risking race conditions, desyncs and worse!
869 * @param source The user sending the KILL
870 * @param dest The user being killed
871 * @param reason The kill reason
872 * @return 1 to prevent the kill, 0 to allow
874 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
876 /** Called when an oper wants to disconnect a remote user via KILL
877 * @param source The user sending the KILL
878 * @param dest The user being killed
879 * @param reason The kill reason
881 virtual void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
883 /** Called whenever a module is loaded.
884 * mod will contain a pointer to the module, and string will contain its name,
885 * for example m_widgets.so. This function is primary for dependency checking,
886 * your module may decide to enable some extra features if it sees that you have
887 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
888 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
889 * but instead operate under reduced functionality, unless the dependency is
890 * absolutely neccessary (e.g. a module that extends the features of another
892 * @param mod A pointer to the new module
894 virtual void OnLoadModule(Module* mod);
896 /** Called whenever a module is unloaded.
897 * mod will contain a pointer to the module, and string will contain its name,
898 * for example m_widgets.so. This function is primary for dependency checking,
899 * your module may decide to enable some extra features if it sees that you have
900 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
901 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
902 * but instead operate under reduced functionality, unless the dependency is
903 * absolutely neccessary (e.g. a module that extends the features of another
905 * @param mod Pointer to the module being unloaded (still valid)
906 * @param name The filename of the module being unloaded
908 virtual void OnUnloadModule(Module* mod);
910 /** Called once every five seconds for background processing.
911 * This timer can be used to control timed features. Its period is not accurate
912 * enough to be used as a clock, but it is gauranteed to be called at least once in
913 * any five second period, directly from the main loop of the server.
914 * @param curtime The current timer derived from time(2)
916 virtual void OnBackgroundTimer(time_t curtime);
918 /** Called whenever any command is about to be executed.
919 * This event occurs for all registered commands, wether they are registered in the core,
920 * or another module, and for invalid commands. Invalid commands may only be sent to this
921 * function when the value of validated is false. By returning 1 from this method you may prevent the
922 * command being executed. If you do this, no output is created by the core, and it is
923 * down to your module to produce any output neccessary.
924 * Note that unless you return 1, you should not destroy any structures (e.g. by using
925 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
926 * method returns, it will be passed an invalid pointer to the user object and crash!)
927 * @param command The command being executed
928 * @param parameters An array of array of characters containing the parameters for the command
929 * @param pcnt The nuimber of parameters passed to the command
930 * @param user the user issuing the command
931 * @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.
932 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
933 * @param original_line The entire original line as passed to the parser from the user
934 * @return 1 to block the command, 0 to allow
936 virtual ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, User *user, bool validated, const std::string &original_line);
938 /** Called after any command has been executed.
939 * This event occurs for all registered commands, wether they are registered in the core,
940 * or another module, but it will not occur for invalid commands (e.g. ones which do not
941 * exist within the command table). The result code returned by the command handler is
943 * @param command The command being executed
944 * @param parameters An array of array of characters containing the parameters for the command
945 * @param pcnt The nuimber of parameters passed to the command
946 * @param user the user issuing the command
947 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
948 * @param original_line The entire original line as passed to the parser from the user
950 virtual void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, User *user, CmdResult result, const std::string &original_line);
952 /** Called to check if a user who is connecting can now be allowed to register
953 * If any modules return false for this function, the user is held in the waiting
954 * state until all modules return true. For example a module which implements ident
955 * lookups will continue to return false for a user until their ident lookup is completed.
956 * Note that the registration timeout for a user overrides these checks, if the registration
957 * timeout is reached, the user is disconnected even if modules report that the user is
958 * not ready to connect.
959 * @param user The user to check
960 * @return true to indicate readiness, false if otherwise
962 virtual ModResult OnCheckReady(User* user);
964 /** Called whenever a user is about to register their connection (e.g. before the user
965 * is sent the MOTD etc). Modules can use this method if they are performing a function
966 * which must be done before the actual connection is completed (e.g. ident lookups,
967 * dnsbl lookups, etc).
968 * Note that you should NOT delete the user record here by causing a disconnection!
969 * Use OnUserConnect for that instead.
970 * @param user The user registering
971 * @return 1 to indicate user quit, 0 to continue
973 virtual ModResult OnUserRegister(User* user);
975 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
976 * This method will always be called for each join, wether or not the channel is actually +i, and
977 * determines the outcome of an if statement around the whole section of invite checking code.
978 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
979 * @param user The user joining the channel
980 * @param chan The channel being joined
981 * @return 1 to explicitly allow the join, 0 to proceed as normal
983 virtual ModResult OnCheckInvite(User* user, Channel* chan);
985 /** Called whenever a mode character is processed.
986 * Return 1 from this function to block the mode character from being processed entirely.
987 * @param user The user who is sending the mode
988 * @param chan The channel the mode is being sent to (or NULL if a usermode)
989 * @param mode The mode character being set
990 * @param param The parameter for the mode or an empty string
991 * @param adding true of the mode is being added, false if it is being removed
992 * @param pcnt The parameter count for the mode (0 or 1)
993 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
994 * to skip all permission checking. Please note that for remote mode changes, your return value
997 virtual ModResult OnRawMode(User* user, Channel* chan, const char mode, const std::string ¶m, bool adding, int pcnt);
999 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1000 * This method will always be called for each join, wether or not the channel is actually +k, and
1001 * determines the outcome of an if statement around the whole section of key checking code.
1002 * if the user specified no key, the keygiven string will be a valid but empty value.
1003 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1004 * @param user The user joining the channel
1005 * @param chan The channel being joined
1006 * @return 1 to explicitly allow the join, 0 to proceed as normal
1008 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
1010 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1011 * This method will always be called for each join, wether or not the channel is actually +l, and
1012 * determines the outcome of an if statement around the whole section of channel limit checking code.
1013 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1014 * @param user The user joining the channel
1015 * @param chan The channel being joined
1016 * @return 1 to explicitly allow the join, 0 to proceed as normal
1018 virtual ModResult OnCheckLimit(User* user, Channel* chan);
1021 * Checks for a user's ban from the channel
1022 * @param user The user to check
1023 * @param chan The channel to check in
1024 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1025 * ban check, or MOD_RES_PASSTHRU to check bans normally
1027 virtual ModResult OnCheckChannelBan(User* user, Channel* chan);
1030 * Checks for a user's match of a single ban
1031 * @param user The user to check for match
1032 * @param chan The channel on which the match is being checked
1033 * @param mask The mask being checked
1034 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1035 * ban check, or MOD_RES_PASSTHRU to check bans normally
1037 virtual ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask);
1039 /** Checks for a match on a given extban type
1040 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1041 * ban check, or MOD_RES_PASSTHRU to check bans normally
1043 virtual ModResult OnExtBanCheck(User* user, Channel* chan, char type);
1045 /** Called on all /STATS commands
1046 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1047 * @param symbol the symbol provided to /STATS
1048 * @param user the user issuing the /STATS command
1049 * @param results A string_list to append results into. You should put all your results
1050 * into this string_list, rather than displaying them directly, so that your handler will
1051 * work when remote STATS queries are received.
1052 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1054 virtual ModResult OnStats(char symbol, User* user, string_list &results);
1056 /** Called whenever a change of a local users displayed host is attempted.
1057 * Return 1 to deny the host change, or 0 to allow it.
1058 * @param user The user whos host will be changed
1059 * @param newhost The new hostname
1060 * @return 1 to deny the host change, 0 to allow
1062 virtual ModResult OnChangeLocalUserHost(User* user, const std::string &newhost);
1064 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1065 * return 1 to deny the name change, or 0 to allow it.
1066 * @param user The user whos GECOS will be changed
1067 * @param newhost The new GECOS
1068 * @return 1 to deny the GECOS change, 0 to allow
1070 virtual ModResult OnChangeLocalUserGECOS(User* user, const std::string &newhost);
1072 /** Called before a topic is changed.
1073 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
1074 * As with other 'pre' events, you should only ever block a local event.
1075 * @param user The user changing the topic
1076 * @param chan The channels who's topic is being changed
1077 * @param topic The actual topic text
1078 * @param 1 to block the topic change, 0 to allow
1080 virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
1082 /** Called whenever a topic has been changed.
1083 * To block topic changes you must use OnPreTopicChange instead.
1084 * @param user The user changing the topic
1085 * @param chan The channels who's topic is being changed
1086 * @param topic The actual topic text
1088 virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
1090 /** Called whenever an Event class is sent to all modules by another module.
1091 * You should *always* check the value of Event::id to determine the event type.
1092 * @param event The Event class being received
1094 virtual void OnEvent(Event& event);
1096 /** Called whenever a Request class is sent to your module by another module.
1097 * The value of Request::id should be used to determine the type of request.
1098 * @param request The Request class being received
1100 virtual void OnRequest(Request& request);
1102 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
1103 * The password field (from the config file) is in 'password' and is to be compared against
1104 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
1105 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
1106 * @param ex The object that's causing the authentication (User* for <oper> <connect:allow> etc, Server* for <link>).
1107 * @param password The password from the configuration file (the password="" value).
1108 * @param input The password entered by the user or whoever.
1109 * @param hashtype The hash value from the config
1110 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
1112 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
1114 /** Called whenever a user is given usermode +o, anywhere on the network.
1115 * You cannot override this and prevent it from happening as it is already happened and
1116 * such a task must be performed by another server. You can however bounce modes by sending
1117 * servermodes out to reverse mode changes.
1118 * @param user The user who is opering
1120 virtual void OnGlobalOper(User* user);
1122 /** Called after a user has fully connected and all modules have executed OnUserConnect
1123 * This event is informational only. You should not change any user information in this
1124 * event. To do so, use the OnUserConnect method to change the state of local users.
1125 * This is called for both local and remote users.
1126 * @param user The user who is connecting
1128 virtual void OnPostConnect(User* user);
1130 /** Called whenever a ban is added to a channel's list.
1131 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1132 * @param source The user adding the ban
1133 * @param channel The channel the ban is being added to
1134 * @param banmask The ban mask being added
1135 * @return 1 to block the ban, 0 to continue as normal
1137 virtual ModResult OnAddBan(User* source, Channel* channel,const std::string &banmask);
1139 /** Called whenever a ban is removed from a channel's list.
1140 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1141 * @param source The user deleting the ban
1142 * @param channel The channel the ban is being deleted from
1143 * @param banmask The ban mask being deleted
1144 * @return 1 to block the unban, 0 to continue as normal
1146 virtual ModResult OnDelBan(User* source, Channel* channel,const std::string &banmask);
1148 /** Called to install an I/O hook on an event handler
1149 * @param user The item to possibly install the I/O hook on
1150 * @param via The port that <user> connected on
1152 virtual void OnHookIO(StreamSocket*, ListenSocketBase* via);
1154 /** Called immediately after any connection is accepted. This is intended for raw socket
1155 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1156 * no information relating to a user record as the connection has not been assigned yet.
1157 * There are no return values from this call as all modules get an opportunity if required to
1158 * process the connection.
1159 * @param fd The file descriptor returned from accept()
1160 * @param client The client IP address and port
1161 * @param server The server IP address and port
1162 * @param localport The local port number the user connected to
1164 virtual void OnStreamSocketAccept(StreamSocket*, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
1167 * Called when a hooked stream has data to write, or when the socket
1168 * engine returns it as writable
1169 * @param socket The socket in question
1170 * @param sendq Data to send to the socket
1171 * @return 1 if the sendq has been completely emptied, 0 if there is
1172 * still data to send, and -1 if there was an error
1174 virtual int OnStreamSocketWrite(StreamSocket*, std::string& sendq);
1176 /** Called immediately before any socket is closed. When this event is called, shutdown()
1177 * has not yet been called on the socket.
1178 * @param fd The file descriptor of the socket prior to close()
1180 virtual void OnStreamSocketClose(StreamSocket*);
1182 /** Called immediately upon connection of an outbound BufferedSocket which has been hooked
1184 * @param fd The file descriptor of the socket immediately after connect()
1186 virtual void OnStreamSocketConnect(StreamSocket*);
1189 * Called when the stream socket has data to read
1190 * @param socket The socket that is ready
1191 * @param recvq The receive queue that new data should be appended to
1192 * @return 1 if new data has been read, 0 if no new data is ready (but the
1193 * socket is still connected), -1 if there was an error or close
1195 virtual int OnStreamSocketRead(StreamSocket*, std::string& recvq);
1197 /** Called whenever a user sets away or returns from being away.
1198 * The away message is available as a parameter, but should not be modified.
1199 * At this stage, it has already been copied into the user record.
1200 * If awaymsg is empty, the user is returning from away.
1201 * @param user The user setting away
1202 * @param awaymsg The away message of the user, or empty if returning from away
1203 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
1205 virtual ModResult OnSetAway(User* user, const std::string &awaymsg);
1207 /** Called whenever a NAMES list is requested.
1208 * You can produce the nameslist yourself, overriding the current list,
1209 * and if you do you must return 1. If you do not handle the names list,
1211 * @param The user requesting the NAMES list
1212 * @param Ptr The channel the NAMES list is requested for
1214 virtual ModResult OnUserList(User* user, Channel* Ptr);
1216 /** Called whenever a line of WHOIS output is sent to a user.
1217 * You may change the numeric and the text of the output by changing
1218 * the values numeric and text, but you cannot change the user the
1219 * numeric is sent to. You may however change the user's User values.
1220 * @param user The user the numeric is being sent to
1221 * @param dest The user being WHOISed
1222 * @param numeric The numeric of the line being sent
1223 * @param text The text of the numeric, including any parameters
1224 * @return nonzero to drop the line completely so that the user does not
1225 * receive it, or zero to allow the line to be sent.
1227 virtual ModResult OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
1229 /** Called at intervals for modules to garbage-collect any hashes etc.
1230 * Certain data types such as hash_map 'leak' buckets, which must be
1231 * tidied up and freed by copying into a new item every so often. This
1232 * method is called when it is time to do that.
1234 virtual void OnGarbageCollect();
1236 /** Add test suite hooks here. These are used for testing functionality of a module
1237 * via the --testsuite debugging parameter.
1239 virtual void OnRunTestSuite();
1241 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
1242 * For example NAMESX, channel mode +u and +I, and UHNAMES. If the nick is set to an empty string by any
1243 * module, then this will cause the nickname not to be displayed at all.
1245 virtual void OnNamesListItem(User* issuer, Membership* item, std::string &prefixes, std::string &nick);
1247 virtual ModResult OnNumeric(User* user, unsigned int numeric, const std::string &text);
1249 /** Called whenever a result from /WHO is about to be returned
1250 * @param source The user running the /WHO query
1251 * @param user The user that this line of the query is about
1252 * @param channel The channel being queried (or NULL if not a channel query)
1253 * @param line The raw line to send; modifiable, if empty no line will be returned.
1255 virtual void OnSendWhoLine(User* source, User* user, Channel* channel, std::string& line);
1257 /** Called to check whether a channel restriction mode applies to a user on it
1258 * @return MOD_RES_DENY to apply the restriction, MOD_RES_ALLOW to bypass
1259 * the restriction, or MOD_RES_PASSTHRU to check restriction status normally
1261 virtual ModResult OnChannelRestrictionApply(User* user, Channel* chan, const char* restriction);
1265 #define CONF_NO_ERROR 0x000000
1266 #define CONF_NOT_A_NUMBER 0x000010
1267 #define CONF_INT_NEGATIVE 0x000080
1268 #define CONF_VALUE_NOT_FOUND 0x000100
1269 #define CONF_FILE_NOT_FOUND 0x000200
1272 /** Allows reading of values from configuration files
1273 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1274 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1275 * Constructing the class using one parameter allows you to specify a path to your own configuration
1276 * file, otherwise, inspircd.conf is read.
1278 class CoreExport ConfigReader : public interfacebase
1286 /** Default constructor.
1287 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1288 * as specified when running ./configure.
1291 /** Default destructor.
1292 * This method destroys the ConfigReader class.
1296 /** Retrieves a value from the config file.
1297 * This method retrieves a value from the config file. Where multiple copies of the tag
1298 * exist in the config file, index indicates which of the values to retrieve.
1300 std::string ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds = false);
1301 /** Retrieves a value from the config file.
1302 * This method retrieves a value from the config file. Where multiple copies of the tag
1303 * exist in the config file, index indicates which of the values to retrieve. If the
1304 * tag is not found the default value is returned instead.
1306 std::string ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds = false);
1308 /** Retrieves a boolean value from the config file.
1309 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1310 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1311 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1313 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1314 /** Retrieves a boolean value from the config file.
1315 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1316 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1317 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1318 * If the tag is not found, the default value is used instead.
1320 bool ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index);
1322 /** Retrieves an integer value from the config file.
1323 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1324 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1325 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1326 * return CONF_INVALID_NUMBER to be returned. need_positive is set if the number must be non-negative.
1327 * If a negative number is placed into a tag which is specified positive, 0 will be returned and GetError()
1328 * will return CONF_INT_NEGATIVE. Note that need_positive is not suitable to get an unsigned int - you
1329 * should cast the result to achieve that effect.
1331 int ReadInteger(const std::string &tag, const std::string &name, int index, bool need_positive);
1332 /** Retrieves an integer value from the config file.
1333 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1334 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1335 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1336 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1337 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1338 * will return CONF_NOT_UNSIGNED. If the tag is not found, the default value is used instead.
1340 int ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool need_positive);
1342 /** Returns the last error to occur.
1343 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1344 * A call to GetError() resets the error flag back to 0.
1348 /** Counts the number of times a given tag appears in the config file.
1349 * This method counts the number of times a tag appears in a config file, for use where
1350 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1351 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1352 * multiple instance tag.
1354 int Enumerate(const std::string &tag);
1359 /** Caches a text file into memory and can be used to retrieve lines from it.
1360 * This class contains methods for read-only manipulation of a text file in memory.
1361 * Either use the constructor type with one parameter to load a file into memory
1362 * at construction, or use the LoadFile method to load a file.
1364 class CoreExport FileReader : public classbase
1366 /** The file contents
1368 std::vector<std::string> fc;
1370 /** Content size in bytes
1372 unsigned long contentsize;
1374 /** Calculate content size in bytes
1379 /** Default constructor.
1380 * This method does not load any file into memory, you must use the LoadFile method
1381 * after constructing the class this way.
1385 /** Secondary constructor.
1386 * This method initialises the class with a file loaded into it ready for GetLine and
1387 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1390 FileReader(const std::string &filename);
1392 /** Default destructor.
1393 * This deletes the memory allocated to the file.
1397 /** Used to load a file.
1398 * This method loads a file into the class ready for GetLine and
1399 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1402 void LoadFile(const std::string &filename);
1404 /** Returns the whole content of the file as std::string
1406 std::string Contents();
1408 /** Returns the entire size of the file as std::string
1410 unsigned long ContentSize();
1412 /** Returns true if the file exists
1413 * This function will return false if the file could not be opened.
1417 /** Retrieve one line from the file.
1418 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1419 * the index was out of bounds, or the line had no data on it.
1421 std::string GetLine(int x);
1423 /** Returns the size of the file in lines.
1424 * This method returns the number of lines in the read file. If it is 0, no lines have been
1425 * read into memory, either because the file is empty or it does not exist, or cannot be
1426 * opened due to permission problems.
1431 /** A list of modules
1433 typedef std::vector<Module*> IntModuleList;
1435 /** An event handler iterator
1437 typedef IntModuleList::iterator EventHandlerIter;
1439 /** ModuleManager takes care of all things module-related
1442 class CoreExport ModuleManager
1445 /** Holds a string describing the last module error to occur
1447 std::string LastModuleError;
1449 /** The feature names published by various modules
1451 featurelist Features;
1453 /** The interface names published by various modules
1455 interfacelist Interfaces;
1457 /** Total number of modules loaded into the ircd
1461 /** List of loaded modules and shared object/dll handles
1462 * keyed by module name
1464 std::map<std::string, Module*> Modules;
1470 } prioritizationState;
1472 /** Internal unload module hook */
1473 bool CanUnload(Module*);
1476 /** Event handler hooks.
1477 * This needs to be public to be used by FOREACH_MOD and friends.
1479 IntModuleList EventHandlers[I_END];
1481 /** Simple, bog-standard, boring constructor.
1489 /** Change the priority of one event in a module.
1490 * Each module event has a list of modules which are attached to that event type.
1491 * If you wish to be called before or after other specific modules, you may use this
1492 * method (usually within void Module::Prioritize()) to set your events priority.
1493 * You may use this call in other methods too, however, this is not supported behaviour
1495 * @param mod The module to change the priority of
1496 * @param i The event to change the priority of
1497 * @param s The state you wish to use for this event. Use one of
1498 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1499 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1500 * to set it to be before or after one or more other modules.
1501 * @param modules If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1502 * then this contains a list of one or more modules your module must be
1503 * placed before or after. Your module will be placed before the highest
1504 * priority module in this list for PRIO_BEFORE, or after the lowest
1505 * priority module in this list for PRIORITY_AFTER.
1506 * @param sz The number of modules being passed for PRIO_BEFORE and PRIORITY_AFTER.
1507 * Defaults to 1, as most of the time you will only want to prioritize your module
1508 * to be before or after one other module.
1510 bool SetPriority(Module* mod, Implementation i, Priority s, Module** modules = NULL, size_t sz = 1);
1512 /** Change the priority of all events in a module.
1513 * @param mod The module to set the priority of
1514 * @param s The priority of all events in the module.
1515 * Note that with this method, it is not possible to effectively use
1516 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1517 * SetPriority method for this, where you may specify other modules to
1518 * be prioritized against.
1520 bool SetPriority(Module* mod, Priority s);
1522 /** Attach an event to a module.
1523 * You may later detatch the event with ModuleManager::Detach().
1524 * If your module is unloaded, all events are automatically detatched.
1525 * @param i Event type to attach
1526 * @param mod Module to attach event to
1527 * @return True if the event was attached
1529 bool Attach(Implementation i, Module* mod);
1531 /** Detatch an event from a module.
1532 * This is not required when your module unloads, as the core will
1533 * automatically detatch your module from all events it is attached to.
1534 * @param i Event type to detach
1535 * @param mod Module to detach event from
1536 * @param Detach true if the event was detached
1538 bool Detach(Implementation i, Module* mod);
1540 /** Attach an array of events to a module
1541 * @param i Event types (array) to attach
1542 * @param mod Module to attach events to
1544 void Attach(Implementation* i, Module* mod, size_t sz);
1546 /** Detach all events from a module (used on unload)
1547 * @param mod Module to detach from
1549 void DetachAll(Module* mod);
1551 /** Returns text describing the last module error
1552 * @return The last error message to occur
1554 std::string& LastError();
1556 /** Load a given module file
1557 * @param filename The file to load
1558 * @return True if the module was found and loaded
1560 bool Load(const char* filename);
1562 /** Unload a given module file. Note that the module will not be
1563 * completely gone until the cull list has finished processing.
1565 * @return true on success; if false, LastError will give a reason
1567 bool Unload(Module* module);
1569 /** Run an asynchronous reload of the given module. When the reload is
1570 * complete, the callback will be run with true if the reload succeeded
1571 * and false if it did not.
1573 void Reload(Module* module, HandlerBase1<void, bool>* callback);
1575 /** Called by the InspIRCd constructor to load all modules from the config file.
1579 void DoSafeUnload(Module*);
1581 /** Get the total number of currently loaded modules
1582 * @return The number of loaded modules
1586 return this->ModCount;
1589 /** Find a module by name, and return a Module* to it.
1590 * This is preferred over iterating the module lists yourself.
1591 * @param name The module name to look up
1592 * @return A pointer to the module, or NULL if the module cannot be found
1594 Module* Find(const std::string &name);
1596 /** Publish a 'feature'.
1597 * There are two ways for a module to find another module it depends on.
1598 * Either by name, using InspIRCd::FindModule, or by feature, using this
1599 * function. A feature is an arbitary string which identifies something this
1600 * module can do. For example, if your module provides SSL support, but other
1601 * modules provide SSL support too, all the modules supporting SSL should
1602 * publish an identical 'SSL' feature. This way, any module requiring use
1603 * of SSL functions can just look up the 'SSL' feature using FindFeature,
1604 * then use the module pointer they are given.
1605 * @param FeatureName The case sensitive feature name to make available
1606 * @param Mod a pointer to your module class
1607 * @returns True on success, false if the feature is already published by
1610 bool PublishFeature(const std::string &FeatureName, Module* Mod);
1612 /** Publish a module to an 'interface'.
1613 * Modules which implement the same interface (the same way of communicating
1614 * with other modules) can publish themselves to an interface, using this
1615 * method. When they do so, they become part of a list of related or
1616 * compatible modules, and a third module may then query for that list
1617 * and know that all modules within that list offer the same API.
1618 * A prime example of this is the hashing modules, which all accept the
1619 * same types of Request class. Consider this to be similar to PublishFeature,
1620 * except for that multiple modules may publish the same 'feature'.
1621 * @param InterfaceName The case sensitive interface name to make available
1622 * @param Mod a pointer to your module class
1623 * @returns True on success, false on failure (there are currently no failure
1626 bool PublishInterface(const std::string &InterfaceName, Module* Mod);
1628 /** Return a pair saying how many other modules are currently using the
1629 * interfaces provided by module m.
1630 * @param m The module to count usage for
1631 * @return A pair, where the first value is the number of uses of the interface,
1632 * and the second value is the interface name being used.
1634 std::pair<int,std::string> GetInterfaceInstanceCount(Module* m);
1636 /** Mark your module as using an interface.
1637 * If you mark your module as using an interface, then that interface
1638 * module may not unload until your module has unloaded first.
1639 * This can be used to prevent crashes by ensuring code you depend on
1640 * is always in memory while your module is active.
1641 * @param InterfaceName The interface to use
1643 void UseInterface(const std::string &InterfaceName);
1645 /** Mark your module as finished with an interface.
1646 * If you used UseInterface() above, you should use this method when
1647 * your module is finished with the interface (usually in its destructor)
1648 * to allow the modules which implement the given interface to be unloaded.
1649 * @param InterfaceName The interface you are finished with using.
1651 void DoneWithInterface(const std::string &InterfaceName);
1653 /** Unpublish a 'feature'.
1654 * When your module exits, it must call this method for every feature it
1655 * is providing so that the feature table is cleaned up.
1656 * @param FeatureName the feature to remove
1658 bool UnpublishFeature(const std::string &FeatureName);
1660 /** Unpublish your module from an interface
1661 * When your module exits, it must call this method for every interface
1662 * it is part of so that the interfaces table is cleaned up. Only when
1663 * the last item is deleted from an interface does the interface get
1665 * @param InterfaceName the interface to be removed from
1666 * @param Mod The module to remove from the interface list
1668 bool UnpublishInterface(const std::string &InterfaceName, Module* Mod);
1670 /** Find a 'feature'.
1671 * There are two ways for a module to find another module it depends on.
1672 * Either by name, using InspIRCd::FindModule, or by feature, using the
1673 * InspIRCd::PublishFeature method. A feature is an arbitary string which
1674 * identifies something this module can do. For example, if your module
1675 * provides SSL support, but other modules provide SSL support too, all
1676 * the modules supporting SSL should publish an identical 'SSL' feature.
1677 * To find a module capable of providing the feature you want, simply
1678 * call this method with the feature name you are looking for.
1679 * @param FeatureName The feature name you wish to obtain the module for
1680 * @returns A pointer to a valid module class on success, NULL on failure.
1682 Module* FindFeature(const std::string &FeatureName);
1684 /** Find an 'interface'.
1685 * An interface is a list of modules which all implement the same API.
1686 * @param InterfaceName The Interface you wish to obtain the module
1688 * @return A pointer to a deque of Module*, or NULL if the interface
1691 modulelist* FindInterface(const std::string &InterfaceName);
1693 /** Determine if a module has published the named interface.
1694 * This could be used in, for example, OnLoadModule to pick up other modules that can be used.
1695 * @param mod The module to check.
1696 * @param InterfaceName the interface you want to check for
1697 * @return True if the module provides the interface, false otherwise.
1699 bool ModuleHasInterface(Module* mod, const std::string& InterfaceName);
1701 /** Given a pointer to a Module, return its filename
1702 * @param m The module pointer to identify
1703 * @return The module name or an empty string
1705 const std::string& GetModuleName(Module* m);
1707 /** Return a list of all modules matching the given filter
1708 * @param filter This int is a bitmask of flags set in Module::Flags,
1709 * such as VF_VENDOR or VF_STATIC. If you wish to receive a list of
1710 * all modules with no filtering, set this to 0.
1711 * @return The list of module names
1713 const std::vector<std::string> GetAllModuleNames(int filter);
1716 /** Do not mess with these functions unless you know the C preprocessor
1717 * well enough to explain why they are needed. The order is important.
1719 #define MODULE_INIT_STR MODULE_INIT_STR_FN_2(MODULE_INIT_SYM)
1720 #define MODULE_INIT_STR_FN_2(x) MODULE_INIT_STR_FN_1(x)
1721 #define MODULE_INIT_STR_FN_1(x) #x
1722 #define MODULE_INIT_SYM MODULE_INIT_SYM_FN_2(API_VERSION)
1723 #define MODULE_INIT_SYM_FN_2(x) MODULE_INIT_SYM_FN_1(x)
1724 #define MODULE_INIT_SYM_FN_1(x) inspircd_module_ ## x
1726 /** This definition is used as shorthand for the various classes
1727 * and functions needed to make a module loadable by the OS.
1728 * It defines the class factory and external init_module function.
1732 #define MODULE_INIT(y) \
1733 extern "C" DllExport Module * MODULE_INIT_SYM() \
1737 BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
1739 switch ( nReason ) \
1741 case DLL_PROCESS_ATTACH: \
1742 case DLL_PROCESS_DETACH: \
1750 #define MODULE_INIT(y) \
1751 extern "C" DllExport Module * MODULE_INIT_SYM() \
1757 #define COMMAND_INIT(c) MODULE_INIT(CommandModule<c>)