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"
28 /** Used to define a set of behavior bits for a module
31 VF_NONE = 0, // module is not special at all
32 VF_STATIC = 1, // module is static, cannot be /unloadmodule'd
33 VF_VENDOR = 2, // module is a vendor module (came in the original tarball, not 3rd party)
34 VF_COMMON = 4, // module needs to be common on all servers in a network to link
35 VF_OPTCOMMON = 8, // module should be common on all servers for unsurprising behavior
36 VF_CORE = 16 // module is a core command, can be assumed loaded on all servers
39 /** Used with SendToMode()
46 /** Used to represent an event type, for user, channel or server
48 enum TargetTypeFlags {
55 /** Used to represent wether a message was PRIVMSG or NOTICE
62 #define MOD_RES_ALLOW (ModResult(1))
63 #define MOD_RES_PASSTHRU (ModResult(0))
64 #define MOD_RES_DENY (ModResult(-1))
66 /** Used to represent an allow/deny module result.
67 * Not constructed as an enum because it reverses the value logic of some functions;
68 * the compiler will inline accesses to have the same efficiency as integer operations.
72 ModResult() : res(0) {}
73 explicit ModResult(int r) : res(r) {}
74 inline bool operator==(const ModResult& r) const
78 inline bool operator!=(const ModResult& r) const
82 inline bool operator!() const
86 inline bool check(bool def) const
88 return (res == 1 || (res == 0 && def));
91 * Merges two results, preferring ALLOW to DENY
93 inline ModResult operator+(const ModResult& r) const
95 if (res == r.res || r.res == 0)
99 // they are different, and neither is passthru
100 return MOD_RES_ALLOW;
104 /** If you change the module API in any way, increment this value.
105 * This MUST be a pure integer, with no parenthesis
107 #define API_VERSION 137
110 * This #define allows us to call a method in all
111 * loaded modules in a readable simple way, e.g.:
112 * 'FOREACH_MOD(I_OnConnect,OnConnect(user));'
114 #define FOREACH_MOD(y,x) do { \
115 EventHandlerIter safei; \
116 for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ) \
124 catch (CoreException& modexcept) \
126 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
133 * Custom module result handling loop. This is a paired macro, and should only
134 * be used with while_each_hook.
136 * See src/channels.cpp for an example of use.
138 #define DO_EACH_HOOK(n,v,args) \
140 EventHandlerIter iter_ ## n = ServerInstance->Modules->EventHandlers[I_ ## n].begin(); \
141 while (iter_ ## n != ServerInstance->Modules->EventHandlers[I_ ## n].end()) \
143 Module* mod_ ## n = *iter_ ## n; \
147 v = (mod_ ## n)->n args;
149 #define WHILE_EACH_HOOK(n) \
151 catch (CoreException& except_ ## n) \
153 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s", (except_ ## n).GetReason()); \
154 (void) mod_ ## n; /* catch mismatched pairs */ \
160 * Module result iterator
161 * Runs the given hook until some module returns a useful result.
163 * Example: ModResult result;
164 * FIRST_MOD_RESULT(OnUserPreNick, result, (user, newnick))
166 #define FIRST_MOD_RESULT(n,v,args) do { \
167 v = MOD_RES_PASSTHRU; \
168 DO_EACH_HOOK(n,v,args) \
170 if (v != MOD_RES_PASSTHRU) \
173 WHILE_EACH_HOOK(n); \
176 /** Holds a module's Version information.
177 * The members (set by the constructor only) indicate details as to the version number
178 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
180 * The core provides only one implementation of the template, causing a run-time linking
181 * error when attempting to load a module compiled against a different API_VERSION.
184 class CoreExport VersionBase
187 /** Module description
189 const std::string description;
190 /** Version information.
192 const std::string version;
198 /** Initialize version class
200 VersionBase(const std::string &desc, int flags = VF_NONE, const std::string& src_rev = VERSION " r" REVISION);
203 typedef VersionBase<API_VERSION> Version;
205 /** The Request class is a unicast message directed at a given module.
206 * When this class is properly instantiated it may be sent to a module
207 * using the Send() method, which will call the given module's OnRequest
208 * method with this class as its parameter.
210 class CoreExport Request : public classbase
213 /** This should be a null-terminated string identifying the type of request,
214 * all modules should define this and use it to determine the nature of the
215 * request before they attempt to cast the Request in any way.
217 const char* const id;
218 /** This is a pointer to the sender of the message, which can be used to
219 * directly trigger events, or to create a reply.
222 /** The single destination of the Request
226 /** Create a new Request
227 * This is for the 'new' way of defining a subclass
228 * of Request and defining it in a common header,
229 * passing an object of your Request subclass through
230 * as a Request* and using the ID string to determine
231 * what to cast it back to and the other end.
233 Request(Module* src, Module* dst, const char* idstr);
234 /** Send the Request.
240 /** The Event class is a unicast message directed at all modules.
241 * When the class is properly instantiated it may be sent to all modules
242 * using the Send() method, which will trigger the OnEvent method in
243 * all modules passing the object as its parameter.
245 class CoreExport Event : public classbase
248 /** This is a pointer to the sender of the message, which can be used to
249 * directly trigger events, or to create a reply.
252 /** The event identifier.
253 * This is arbitary text which should be used to distinguish
254 * one type of event from another.
256 const std::string id;
258 /** Create a new Event
260 Event(Module* src, const std::string &eventid);
262 * The return result of an Event::Send() will always be NULL as
263 * no replies are expected.
268 /** Priority types which can be used by Module::Prioritize()
270 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
272 /** Implementation-specific flags which may be set in Module::Implements()
277 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash,
278 I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois,
279 I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick,
280 I_OnUserMessage, I_OnUserNotice, I_OnMode, I_OnGetServerDescription, I_OnSyncUser,
281 I_OnSyncChannel, I_OnDecodeMetaData, I_OnWallops, I_OnAcceptConnection,
282 I_OnChangeHost, I_OnChangeName, I_OnAddLine, I_OnDelLine, I_OnExpireLine,
283 I_OnUserPostNick, I_OnPreMode, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule,
284 I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite,
285 I_OnRawMode, I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckChannelBan, I_OnExtBanCheck,
286 I_OnStats, I_OnChangeLocalUserHost, I_OnPreTopicChange,
287 I_OnPostTopicChange, I_OnEvent, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan,
288 I_OnDelBan, I_OnChangeLocalUserGECOS, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
289 I_OnPostOper, I_OnSyncNetwork, I_OnSetAway, I_OnUserList, I_OnPostCommand, I_OnPostJoin,
290 I_OnWhoisLine, I_OnBuildNeighborList, I_OnGarbageCollect,
291 I_OnText, I_OnPassCompare, I_OnRunTestSuite, I_OnNamesListItem, I_OnNumeric, I_OnHookIO,
292 I_OnPreRehash, I_OnModuleRehash, I_OnSendWhoLine, I_OnChangeIdent, I_OnChannelRestrictionApply,
296 /** Base class for all InspIRCd modules
297 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
298 * its methods will be called when irc server events occur. class inherited from module must be
299 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
301 class CoreExport Module : public classbase, public usecountbase
304 /** File that this module was loaded from
306 std::string ModuleSourceFile;
307 /** Reference to the dlopen() value
309 DLLManager* ModuleDLLManager;
311 /** Default constructor.
312 * Creates a module class.
313 * @param Me An instance of the InspIRCd class which will be saved into ServerInstance for your use
314 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
318 /** Clean up prior to destruction
319 * If you override, you must call this AFTER your module's cleanup
321 virtual CullResult cull();
323 /** Default destructor.
324 * destroys a module class
328 virtual void Prioritize()
332 /** Returns the version number of a Module.
333 * The method should return a Version object with its version information assigned via
336 virtual Version GetVersion() = 0;
338 /** Called when a user connects.
339 * The details of the connecting user are available to you in the parameter User *user
340 * @param user The user who is connecting
342 virtual void OnUserConnect(LocalUser* user);
344 /** Called when a user quits.
345 * The details of the exiting user are available to you in the parameter User *user
346 * This event is only called when the user is fully registered when they quit. To catch
347 * raw disconnections, use the OnUserDisconnect method.
348 * @param user The user who is quitting
349 * @param message The user's quit message (as seen by non-opers)
350 * @param oper_message The user's quit message (as seen by opers)
352 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
354 /** Called whenever a user's socket is closed.
355 * The details of the exiting user are available to you in the parameter User *user
356 * This event is called for all users, registered or not, as a cleanup method for modules
357 * which might assign resources to user, such as dns lookups, objects and sockets.
358 * @param user The user who is disconnecting
360 virtual void OnUserDisconnect(LocalUser* user);
362 /** Called whenever a channel is about to be deleted
363 * @param chan The channel being deleted
364 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
366 virtual ModResult OnChannelPreDelete(Channel *chan);
368 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
369 * @param chan The channel being deleted
371 virtual void OnChannelDelete(Channel* chan);
373 /** Called when a user joins a channel.
374 * The details of the joining user are available to you in the parameter User *user,
375 * and the details of the channel they have joined is available in the variable Channel *channel
376 * @param memb The channel membership being created
377 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
378 * to a channel due to the network sync.
379 * @param created This is true if the join created the channel
381 virtual void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list);
383 /** Called after a user joins a channel
384 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
386 * @param memb The channel membership created
388 virtual void OnPostJoin(Membership*);
390 /** Called when a user parts a channel.
391 * The details of the leaving user are available to you in the parameter User *user,
392 * and the details of the channel they have left is available in the variable Channel *channel
393 * @param memb The channel membership being destroyed
394 * @param partmessage The part message, or an empty string (may be modified)
396 virtual void OnUserPart(Membership* memb, std::string &partmessage, CUList& except_list);
398 /** Called on rehash.
399 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
400 * system. This is called in all cases -- including when this server will not execute the
401 * rehash because it is directed at a remote server.
403 * @param user The user performing the rehash, if any. If this is server initiated, the value of
404 * this variable will be NULL.
405 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
408 virtual void OnPreRehash(User* user, const std::string ¶meter);
410 /** Called on rehash.
411 * This method is called when a user initiates a module-specific rehash. This can be used to do
412 * expensive operations (such as reloading SSL certificates) that are not executed on a normal
413 * rehash for efficiency. A rehash of this type does not reload the core configuration.
415 * @param user The user performing the rehash.
416 * @param parameter The parameter given to REHASH
418 virtual void OnModuleRehash(User* user, const std::string ¶meter);
420 /** Called on rehash.
421 * This method is called after a rehash has completed. You should use it to reload any module
422 * configuration from the main configuration file.
423 * @param user The user that performed the rehash, if it was initiated by a user and that user
424 * is still connected.
426 virtual void OnRehash(User* user);
428 /** Called whenever a snotice is about to be sent to a snomask.
429 * snomask and type may both be modified; the message may not.
430 * @param snomask The snomask the message is going to (e.g. 'A')
431 * @param type The textual description the snomask will go to (e.g. 'OPER')
432 * @param message The text message to be sent via snotice
433 * @return 1 to block the snotice from being sent entirely, 0 else.
435 virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
437 /** Called whenever a user is about to join a channel, before any processing is done.
438 * Returning a value of 1 from this function stops the process immediately, causing no
439 * output to be sent to the user by the core. If you do this you must produce your own numerics,
440 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
441 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
445 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
446 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
447 * processing on the actual channel record at this point, however the channel NAME will still be passed in
448 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
449 * @param user The user joining the channel
450 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
451 * @param cname The channel name being joined. For new channels this is valid where chan is not.
452 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "o".
453 * You may alter this string to alter the user's modes on the channel.
454 * @param keygiven The key given to join the channel, or an empty string if none was provided
455 * @return 1 To prevent the join, 0 to allow it.
457 virtual ModResult OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string &privs, const std::string &keygiven);
459 /** Called whenever a user is about to be kicked.
460 * Returning a value of 1 from this function stops the process immediately, causing no
461 * output to be sent to the user by the core. If you do this you must produce your own numerics,
463 * @param source The user issuing the kick
464 * @param user The user being kicked
465 * @param chan The channel the user is being kicked from
466 * @param reason The kick reason
467 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
469 virtual ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason);
471 /** Called whenever a user is kicked.
472 * If this method is called, the kick is already underway and cannot be prevented, so
473 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
474 * @param source The user issuing the kick
475 * @param user The user being kicked
476 * @param chan The channel the user is being kicked from
477 * @param reason The kick reason
479 virtual void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except_list);
481 /** Called whenever a user opers locally.
482 * The User will contain the oper mode 'o' as this function is called after any modifications
483 * are made to the user's structure by the core.
484 * @param user The user who is opering up
485 * @param opertype The opers type name
487 virtual void OnOper(User* user, const std::string &opertype);
489 /** Called after a user opers locally.
490 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
491 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
492 * out the OPERTYPE, etc.
493 * @param user The user who is opering up
494 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
495 * @param opertype The opers type name
497 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
499 /** Called whenever a user types /INFO.
500 * The User will contain the information of the user who typed the command. Modules may use this
501 * method to output their own credits in /INFO (which is the ircd's version of an about box).
502 * It is purposefully not possible to modify any info that has already been output, or halt the list.
503 * You must write a 371 numeric to the user, containing your info in the following format:
505 * <nick> :information here
507 * @param user The user issuing /INFO
509 virtual void OnInfo(User* user);
511 /** Called whenever a /WHOIS is performed on a local user.
512 * The source parameter contains the details of the user who issued the WHOIS command, and
513 * the dest parameter contains the information of the user they are whoising.
514 * @param source The user issuing the WHOIS command
515 * @param dest The user who is being WHOISed
517 virtual void OnWhois(User* source, User* dest);
519 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
520 * Returning 1 from this function stops the process immediately, causing no
521 * output to be sent to the user by the core. If you do this you must produce your own numerics,
522 * notices etc. This is useful for modules which may want to filter invites to channels.
523 * @param source The user who is issuing the INVITE
524 * @param dest The user being invited
525 * @param channel The channel the user is being invited to
526 * @param timeout The time the invite will expire (0 == never)
527 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
529 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
531 /** Called after a user has been successfully invited to a channel.
532 * You cannot prevent the invite from occuring using this function, to do that,
533 * use OnUserPreInvite instead.
534 * @param source The user who is issuing the INVITE
535 * @param dest The user being invited
536 * @param channel The channel the user is being invited to
537 * @param timeout The time the invite will expire (0 == never)
539 virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout);
541 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
542 * Returning any nonzero value from this function stops the process immediately, causing no
543 * output to be sent to the user by the core. If you do this you must produce your own numerics,
544 * notices etc. This is useful for modules which may want to filter or redirect messages.
545 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
546 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
547 * of where the message is destined to be sent.
548 * @param user The user sending the message
549 * @param dest The target of the message (Channel* or User*)
550 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
551 * @param text Changeable text being sent by the user
552 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
553 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
554 * It will be ignored for private messages.
555 * @return 1 to deny the message, 0 to allow it
557 virtual ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
559 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
560 * Returning any nonzero value from this function stops the process immediately, causing no
561 * output to be sent to the user by the core. If you do this you must produce your own numerics,
562 * notices etc. This is useful for modules which may want to filter or redirect messages.
563 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
564 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
565 * of where the message is destined to be sent.
566 * You may alter the message text as you wish before relinquishing control to the next module
567 * in the chain, and if no other modules block the text this altered form of the text will be sent out
568 * to the user and possibly to other servers.
569 * @param user The user sending the message
570 * @param dest The target of the message (Channel* or User*)
571 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
572 * @param text Changeable text being sent by the user
573 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
574 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
575 * It will be ignored for private notices.
576 * @return 1 to deny the NOTICE, 0 to allow it
578 virtual ModResult OnUserPreNotice(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
580 /** Called when sending a message to all "neighbors" of a given user -
581 * that is, all users that share a common channel. This is used in
582 * commands such as NICK, QUIT, etc.
583 * @param source The source of the message
584 * @param include_c Channels to scan for users to include
585 * @param exceptions Map of user->bool that overrides the inclusion decision
587 * Set exceptions[user] = true to include, exceptions[user] = false to exclude
589 virtual void OnBuildNeighborList(User* source, UserChanList &include_c, std::map<User*,bool> &exceptions);
591 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
592 * Please note that although you can see remote nickchanges through this function, you should
593 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
594 * check user->server before taking any action (including returning nonzero from the method).
595 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
596 * module to generate some meaninful output.
597 * @param user The username changing their nick
598 * @param newnick Their new nickname
599 * @return 1 to deny the change, 0 to allow
601 virtual ModResult OnUserPreNick(User* user, const std::string &newnick);
603 /** Called after any PRIVMSG sent from a user.
604 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
605 * if target_type is TYPE_CHANNEL.
606 * @param user The user sending the message
607 * @param dest The target of the message
608 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
609 * @param text the text being sent by the user
610 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
612 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
614 /** Called after any NOTICE sent from a user.
615 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
616 * if target_type is TYPE_CHANNEL.
617 * @param user The user sending the message
618 * @param dest The target of the message
619 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
620 * @param text the text being sent by the user
621 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
623 virtual void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
625 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
626 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
627 * if target_type is TYPE_CHANNEL.
628 * The difference between this event and OnUserPreNotice/OnUserPreMessage is that delivery is gauranteed,
629 * the message has already been vetted. In the case of the other two methods, a later module may stop your
630 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
631 * @param user The user sending the message
632 * @param dest The target of the message
633 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
634 * @param text the text being sent by the user
635 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
637 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
639 /** Called after every MODE command sent from a user
640 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
641 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
642 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
643 * @param user The user sending the MODEs
644 * @param dest The target of the modes (User* or Channel*)
645 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
646 * @param text The actual modes and their parameters if any
647 * @param translate The translation types of the mode parameters
649 virtual void OnMode(User* user, void* dest, int target_type, const std::vector<std::string> &text, const std::vector<TranslateType> &translate);
651 /** Allows modules to alter or create server descriptions
652 * Whenever a module requires a server description, for example for display in
653 * WHOIS, this function is called in all modules. You may change or define the
654 * description given in std::string &description. If you do, this description
655 * will be shown in the WHOIS fields.
656 * @param servername The servername being searched for
657 * @param description Alterable server description for this server
659 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
661 /** Allows modules to synchronize data which relates to users during a netburst.
662 * When this function is called, it will be called from the module which implements
663 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
664 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
665 * (see below). This function will be called for every user visible on your side
666 * of the burst, allowing you to for example set modes, etc. Do not use this call to
667 * synchronize data which you have stored using class Extensible -- There is a specialist
668 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
669 * @param user The user being syncronized
670 * @param proto A pointer to the module handling network protocol
671 * @param opaque An opaque pointer set by the protocol module, should not be modified!
673 virtual void OnSyncUser(User* user, Module* proto, void* opaque);
675 /** Allows modules to synchronize data which relates to channels during a netburst.
676 * When this function is called, it will be called from the module which implements
677 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
678 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
679 * (see below). This function will be called for every user visible on your side
680 * of the burst, allowing you to for example set modes, etc.
682 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
684 * @param chan The channel being syncronized
685 * @param proto A pointer to the module handling network protocol
686 * @param opaque An opaque pointer set by the protocol module, should not be modified!
688 virtual void OnSyncChannel(Channel* chan, Module* proto, void* opaque);
690 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
691 * Whenever the linking module wants to send out data, but doesnt know what the data
692 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
693 * this method is called. You should use the ProtoSendMetaData function after you've
694 * correctly decided how the data should be represented, to send the metadata on its way if
695 * if it belongs to your module.
696 * @param proto A pointer to the module handling network protocol
697 * @param opaque An opaque pointer set by the protocol module, should not be modified!
698 * @param displayable If this value is true, the data is going to be displayed to a user,
699 * and not sent across the network. Use this to determine wether or not to show sensitive data.
701 virtual void OnSyncNetwork(Module* proto, void* opaque);
703 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
704 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
705 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
706 * @param target The Channel* or User* that data should be added to
707 * @param extname The extension name which is being sent
708 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
710 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
712 /** Implemented by modules which provide the ability to link servers.
713 * These modules will implement this method, which allows transparent sending of servermodes
714 * down the network link as a broadcast, without a module calling it having to know the format
715 * of the MODE command before the actual mode string.
717 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
718 * of how to use this function.
720 * @param opaque An opaque pointer set by the protocol module, should not be modified!
721 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
722 * @param target The Channel* or User* that modes should be sent for
723 * @param modeline The modes and parameters to be sent
724 * @param translate The translation types of the mode parameters
726 virtual void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::vector<std::string> &modeline, const std::vector<TranslateType> &translate);
728 /** Implemented by modules which provide the ability to link servers.
729 * These modules will implement this method, which allows metadata (extra data added to
730 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
731 * to other servers on a netburst and decoded at the other end by the same module on a
734 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
735 * how to use this function.
736 * @param opaque An opaque pointer set by the protocol module, should not be modified!
737 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
738 * @param target The Channel* or User* that metadata should be sent for
739 * @param extname The extension name to send metadata for
740 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
742 virtual void ProtoSendMetaData(void* opaque, Extensible* target, const std::string &extname, const std::string &extdata);
744 /** Called after every WALLOPS command.
745 * @param user The user sending the WALLOPS
746 * @param text The content of the WALLOPS message
748 virtual void OnWallops(User* user, const std::string &text);
750 /** Called whenever a user's hostname is changed.
751 * This event triggers after the host has been set.
752 * @param user The user whos host is being changed
753 * @param newhost The new hostname being set
755 virtual void OnChangeHost(User* user, const std::string &newhost);
757 /** Called whenever a user's GECOS (realname) is changed.
758 * This event triggers after the name has been set.
759 * @param user The user who's GECOS is being changed
760 * @param gecos The new GECOS being set on the user
762 virtual void OnChangeName(User* user, const std::string &gecos);
764 /** Called whenever a user's IDENT is changed.
765 * This event triggers after the name has been set.
766 * @param user The user who's IDENT is being changed
767 * @param gecos The new IDENT being set on the user
769 virtual void OnChangeIdent(User* user, const std::string &ident);
771 /** Called whenever an xline is added by a local user.
772 * This method is triggered after the line is added.
773 * @param source The sender of the line or NULL for local server
774 * @param line The xline being added
776 virtual void OnAddLine(User* source, XLine* line);
778 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
779 * This method is triggered after the line is deleted.
780 * @param source The user removing the line or NULL for local server
781 * @param line the line being deleted
783 virtual void OnDelLine(User* source, XLine* line);
785 /** Called whenever an xline expires.
786 * This method is triggered after the line is deleted.
787 * @param line The line being deleted.
789 virtual void OnExpireLine(XLine *line);
791 /** Called before your module is unloaded to clean up Extensibles.
792 * This method is called once for every user and channel on the network,
793 * so that when your module unloads it may clear up any remaining data
794 * in the form of Extensibles added using Extensible::Extend().
795 * If the target_type variable is TYPE_USER, then void* item refers to
796 * a User*, otherwise it refers to a Channel*.
797 * @param target_type The type of item being cleaned
798 * @param item A pointer to the item's class
800 virtual void OnCleanup(int target_type, void* item);
802 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
803 * have been applied. Please note that although you can see remote nickchanges through this function, you should
804 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
805 * check user->server before taking any action (including returning nonzero from the method).
806 * Because this method is called after the nickchange is taken place, no return values are possible
807 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
808 * @param user The user changing their nick
809 * @param oldnick The old nickname of the user before the nickchange
811 virtual void OnUserPostNick(User* user, const std::string &oldnick);
813 /** Called before any mode change, to allow a single access check for
814 * a full mode change (use OnRawMode to check individual modes)
816 * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
817 * OnRawMode for each individual mode
819 * @param source the user making the mode change
820 * @param dest the user destination of the umode change (NULL if a channel mode)
821 * @param channel the channel destination of the mode change
822 * @param parameters raw mode parameters; parameters[0] is the user/channel being changed
824 virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, const std::vector<std::string>& parameters);
826 /** Called when a 005 numeric is about to be output.
827 * The module should modify the 005 numeric if needed to indicate its features.
828 * @param output The 005 string to be modified if neccessary.
830 virtual void On005Numeric(std::string &output);
832 /** Called when a client is disconnected by KILL.
833 * If a client is killed by a server, e.g. a nickname collision or protocol error,
835 * Return 1 from this function to prevent the kill, and 0 from this function to allow
836 * it as normal. If you prevent the kill no output will be sent to the client, it is
837 * down to your module to generate this information.
838 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
839 * If you do so youre risking race conditions, desyncs and worse!
840 * @param source The user sending the KILL
841 * @param dest The user being killed
842 * @param reason The kill reason
843 * @return 1 to prevent the kill, 0 to allow
845 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
847 /** Called when an oper wants to disconnect a remote user via KILL
848 * @param source The user sending the KILL
849 * @param dest The user being killed
850 * @param reason The kill reason
852 virtual void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
854 /** Called whenever a module is loaded.
855 * mod will contain a pointer to the module, and string will contain its name,
856 * for example m_widgets.so. This function is primary for dependency checking,
857 * your module may decide to enable some extra features if it sees that you have
858 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
859 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
860 * but instead operate under reduced functionality, unless the dependency is
861 * absolutely neccessary (e.g. a module that extends the features of another
863 * @param mod A pointer to the new module
865 virtual void OnLoadModule(Module* mod);
867 /** Called whenever a module is unloaded.
868 * mod will contain a pointer to the module, and string will contain its name,
869 * for example m_widgets.so. This function is primary for dependency checking,
870 * your module may decide to enable some extra features if it sees that you have
871 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
872 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
873 * but instead operate under reduced functionality, unless the dependency is
874 * absolutely neccessary (e.g. a module that extends the features of another
876 * @param mod Pointer to the module being unloaded (still valid)
877 * @param name The filename of the module being unloaded
879 virtual void OnUnloadModule(Module* mod);
881 /** Called once every five seconds for background processing.
882 * This timer can be used to control timed features. Its period is not accurate
883 * enough to be used as a clock, but it is gauranteed to be called at least once in
884 * any five second period, directly from the main loop of the server.
885 * @param curtime The current timer derived from time(2)
887 virtual void OnBackgroundTimer(time_t curtime);
889 /** Called whenever any command is about to be executed.
890 * This event occurs for all registered commands, wether they are registered in the core,
891 * or another module, and for invalid commands. Invalid commands may only be sent to this
892 * function when the value of validated is false. By returning 1 from this method you may prevent the
893 * command being executed. If you do this, no output is created by the core, and it is
894 * down to your module to produce any output neccessary.
895 * Note that unless you return 1, you should not destroy any structures (e.g. by using
896 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
897 * method returns, it will be passed an invalid pointer to the user object and crash!)
898 * @param command The command being executed
899 * @param parameters An array of array of characters containing the parameters for the command
900 * @param pcnt The nuimber of parameters passed to the command
901 * @param user the user issuing the command
902 * @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.
903 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
904 * @param original_line The entire original line as passed to the parser from the user
905 * @return 1 to block the command, 0 to allow
907 virtual ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, User *user, bool validated, const std::string &original_line);
909 /** Called after any command has been executed.
910 * This event occurs for all registered commands, wether they are registered in the core,
911 * or another module, but it will not occur for invalid commands (e.g. ones which do not
912 * exist within the command table). The result code returned by the command handler is
914 * @param command The command being executed
915 * @param parameters An array of array of characters containing the parameters for the command
916 * @param pcnt The nuimber of parameters passed to the command
917 * @param user the user issuing the command
918 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
919 * @param original_line The entire original line as passed to the parser from the user
921 virtual void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, User *user, CmdResult result, const std::string &original_line);
923 /** Called to check if a user who is connecting can now be allowed to register
924 * If any modules return false for this function, the user is held in the waiting
925 * state until all modules return true. For example a module which implements ident
926 * lookups will continue to return false for a user until their ident lookup is completed.
927 * Note that the registration timeout for a user overrides these checks, if the registration
928 * timeout is reached, the user is disconnected even if modules report that the user is
929 * not ready to connect.
930 * @param user The user to check
931 * @return true to indicate readiness, false if otherwise
933 virtual ModResult OnCheckReady(LocalUser* user);
935 /** Called whenever a user is about to register their connection (e.g. before the user
936 * is sent the MOTD etc). Modules can use this method if they are performing a function
937 * which must be done before the actual connection is completed (e.g. ident lookups,
938 * dnsbl lookups, etc).
939 * Note that you should NOT delete the user record here by causing a disconnection!
940 * Use OnUserConnect for that instead.
941 * @param user The user registering
942 * @return 1 to indicate user quit, 0 to continue
944 virtual ModResult OnUserRegister(LocalUser* user);
946 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
947 * This method will always be called for each join, wether or not the channel is actually +i, and
948 * determines the outcome of an if statement around the whole section of invite checking code.
949 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
950 * @param user The user joining the channel
951 * @param chan The channel being joined
952 * @return 1 to explicitly allow the join, 0 to proceed as normal
954 virtual ModResult OnCheckInvite(User* user, Channel* chan);
956 /** Called whenever a mode character is processed.
957 * Return 1 from this function to block the mode character from being processed entirely.
958 * @param user The user who is sending the mode
959 * @param chan The channel the mode is being sent to (or NULL if a usermode)
960 * @param mode The mode character being set
961 * @param param The parameter for the mode or an empty string
962 * @param adding true of the mode is being added, false if it is being removed
963 * @param pcnt The parameter count for the mode (0 or 1)
964 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
965 * to skip all permission checking. Please note that for remote mode changes, your return value
968 virtual ModResult OnRawMode(User* user, Channel* chan, const char mode, const std::string ¶m, bool adding, int pcnt);
970 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
971 * This method will always be called for each join, wether or not the channel is actually +k, and
972 * determines the outcome of an if statement around the whole section of key checking code.
973 * if the user specified no key, the keygiven string will be a valid but empty value.
974 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
975 * @param user The user joining the channel
976 * @param chan The channel being joined
977 * @return 1 to explicitly allow the join, 0 to proceed as normal
979 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
981 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
982 * This method will always be called for each join, wether or not the channel is actually +l, and
983 * determines the outcome of an if statement around the whole section of channel limit checking code.
984 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
985 * @param user The user joining the channel
986 * @param chan The channel being joined
987 * @return 1 to explicitly allow the join, 0 to proceed as normal
989 virtual ModResult OnCheckLimit(User* user, Channel* chan);
992 * Checks for a user's ban from the channel
993 * @param user The user to check
994 * @param chan The channel to check in
995 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
996 * ban check, or MOD_RES_PASSTHRU to check bans normally
998 virtual ModResult OnCheckChannelBan(User* user, Channel* chan);
1001 * Checks for a user's match of a single ban
1002 * @param user The user to check for match
1003 * @param chan The channel on which the match is being checked
1004 * @param mask The mask being checked
1005 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1006 * ban check, or MOD_RES_PASSTHRU to check bans normally
1008 virtual ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask);
1010 /** Checks for a match on a given extban type
1011 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1012 * ban check, or MOD_RES_PASSTHRU to check bans normally
1014 virtual ModResult OnExtBanCheck(User* user, Channel* chan, char type);
1016 /** Called on all /STATS commands
1017 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1018 * @param symbol the symbol provided to /STATS
1019 * @param user the user issuing the /STATS command
1020 * @param results A string_list to append results into. You should put all your results
1021 * into this string_list, rather than displaying them directly, so that your handler will
1022 * work when remote STATS queries are received.
1023 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1025 virtual ModResult OnStats(char symbol, User* user, string_list &results);
1027 /** Called whenever a change of a local users displayed host is attempted.
1028 * Return 1 to deny the host change, or 0 to allow it.
1029 * @param user The user whos host will be changed
1030 * @param newhost The new hostname
1031 * @return 1 to deny the host change, 0 to allow
1033 virtual ModResult OnChangeLocalUserHost(LocalUser* user, const std::string &newhost);
1035 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1036 * return 1 to deny the name change, or 0 to allow it.
1037 * @param user The user whos GECOS will be changed
1038 * @param newhost The new GECOS
1039 * @return 1 to deny the GECOS change, 0 to allow
1041 virtual ModResult OnChangeLocalUserGECOS(LocalUser* user, const std::string &newhost);
1043 /** Called before a topic is changed.
1044 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
1045 * As with other 'pre' events, you should only ever block a local event.
1046 * @param user The user changing the topic
1047 * @param chan The channels who's topic is being changed
1048 * @param topic The actual topic text
1049 * @param 1 to block the topic change, 0 to allow
1051 virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
1053 /** Called whenever a topic has been changed.
1054 * To block topic changes you must use OnPreTopicChange instead.
1055 * @param user The user changing the topic
1056 * @param chan The channels who's topic is being changed
1057 * @param topic The actual topic text
1059 virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
1061 /** Called whenever an Event class is sent to all modules by another module.
1062 * You should *always* check the value of Event::id to determine the event type.
1063 * @param event The Event class being received
1065 virtual void OnEvent(Event& event);
1067 /** Called whenever a Request class is sent to your module by another module.
1068 * The value of Request::id should be used to determine the type of request.
1069 * @param request The Request class being received
1071 virtual void OnRequest(Request& request);
1073 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
1074 * The password field (from the config file) is in 'password' and is to be compared against
1075 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
1076 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
1077 * @param ex The object that's causing the authentication (User* for <oper> <connect:allow> etc, Server* for <link>).
1078 * @param password The password from the configuration file (the password="" value).
1079 * @param input The password entered by the user or whoever.
1080 * @param hashtype The hash value from the config
1081 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
1083 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
1085 /** Called whenever a user is given usermode +o, anywhere on the network.
1086 * You cannot override this and prevent it from happening as it is already happened and
1087 * such a task must be performed by another server. You can however bounce modes by sending
1088 * servermodes out to reverse mode changes.
1089 * @param user The user who is opering
1091 virtual void OnGlobalOper(User* user);
1093 /** Called after a user has fully connected and all modules have executed OnUserConnect
1094 * This event is informational only. You should not change any user information in this
1095 * event. To do so, use the OnUserConnect method to change the state of local users.
1096 * This is called for both local and remote users.
1097 * @param user The user who is connecting
1099 virtual void OnPostConnect(User* user);
1101 /** Called whenever a ban is added to a channel's list.
1102 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1103 * @param source The user adding the ban
1104 * @param channel The channel the ban is being added to
1105 * @param banmask The ban mask being added
1106 * @return 1 to block the ban, 0 to continue as normal
1108 virtual ModResult OnAddBan(User* source, Channel* channel,const std::string &banmask);
1110 /** Called whenever a ban is removed from a channel's list.
1111 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1112 * @param source The user deleting the ban
1113 * @param channel The channel the ban is being deleted from
1114 * @param banmask The ban mask being deleted
1115 * @return 1 to block the unban, 0 to continue as normal
1117 virtual ModResult OnDelBan(User* source, Channel* channel,const std::string &banmask);
1119 /** Called to install an I/O hook on an event handler
1120 * @param user The item to possibly install the I/O hook on
1121 * @param via The port that <user> connected on
1123 virtual void OnHookIO(StreamSocket*, ListenSocket* via);
1125 /** Called when a port accepts a connection
1126 * Return MOD_RES_ACCEPT if you have used the file descriptor.
1127 * @param fd The file descriptor returned from accept()
1128 * @param from The local port the user connected to
1129 * @param client The client IP address and port
1130 * @param server The server IP address and port
1132 virtual ModResult OnAcceptConnection(int fd, ListenSocket* from, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
1134 /** Called immediately after any connection is accepted. This is intended for raw socket
1135 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1136 * no information relating to a user record as the connection has not been assigned yet.
1137 * There are no return values from this call as all modules get an opportunity if required to
1138 * process the connection.
1139 * @param fd The file descriptor returned from accept()
1140 * @param client The client IP address and port
1141 * @param server The server IP address and port
1142 * @param localport The local port number the user connected to
1144 virtual void OnStreamSocketAccept(StreamSocket*, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
1147 * Called when a hooked stream has data to write, or when the socket
1148 * engine returns it as writable
1149 * @param socket The socket in question
1150 * @param sendq Data to send to the socket
1151 * @return 1 if the sendq has been completely emptied, 0 if there is
1152 * still data to send, and -1 if there was an error
1154 virtual int OnStreamSocketWrite(StreamSocket*, std::string& sendq);
1156 /** Called immediately before any socket is closed. When this event is called, shutdown()
1157 * has not yet been called on the socket.
1158 * @param fd The file descriptor of the socket prior to close()
1160 virtual void OnStreamSocketClose(StreamSocket*);
1162 /** Called immediately upon connection of an outbound BufferedSocket which has been hooked
1164 * @param fd The file descriptor of the socket immediately after connect()
1166 virtual void OnStreamSocketConnect(StreamSocket*);
1169 * Called when the stream socket has data to read
1170 * @param socket The socket that is ready
1171 * @param recvq The receive queue that new data should be appended to
1172 * @return 1 if new data has been read, 0 if no new data is ready (but the
1173 * socket is still connected), -1 if there was an error or close
1175 virtual int OnStreamSocketRead(StreamSocket*, std::string& recvq);
1177 /** Called whenever a user sets away or returns from being away.
1178 * The away message is available as a parameter, but should not be modified.
1179 * At this stage, it has already been copied into the user record.
1180 * If awaymsg is empty, the user is returning from away.
1181 * @param user The user setting away
1182 * @param awaymsg The away message of the user, or empty if returning from away
1183 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
1185 virtual ModResult OnSetAway(User* user, const std::string &awaymsg);
1187 /** Called whenever a NAMES list is requested.
1188 * You can produce the nameslist yourself, overriding the current list,
1189 * and if you do you must return 1. If you do not handle the names list,
1191 * @param The user requesting the NAMES list
1192 * @param Ptr The channel the NAMES list is requested for
1194 virtual ModResult OnUserList(User* user, Channel* Ptr);
1196 /** Called whenever a line of WHOIS output is sent to a user.
1197 * You may change the numeric and the text of the output by changing
1198 * the values numeric and text, but you cannot change the user the
1199 * numeric is sent to. You may however change the user's User values.
1200 * @param user The user the numeric is being sent to
1201 * @param dest The user being WHOISed
1202 * @param numeric The numeric of the line being sent
1203 * @param text The text of the numeric, including any parameters
1204 * @return nonzero to drop the line completely so that the user does not
1205 * receive it, or zero to allow the line to be sent.
1207 virtual ModResult OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
1209 /** Called at intervals for modules to garbage-collect any hashes etc.
1210 * Certain data types such as hash_map 'leak' buckets, which must be
1211 * tidied up and freed by copying into a new item every so often. This
1212 * method is called when it is time to do that.
1214 virtual void OnGarbageCollect();
1216 /** Add test suite hooks here. These are used for testing functionality of a module
1217 * via the --testsuite debugging parameter.
1219 virtual void OnRunTestSuite();
1221 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
1222 * For example NAMESX, channel mode +u and +I, and UHNAMES. If the nick is set to an empty string by any
1223 * module, then this will cause the nickname not to be displayed at all.
1225 virtual void OnNamesListItem(User* issuer, Membership* item, std::string &prefixes, std::string &nick);
1227 virtual ModResult OnNumeric(User* user, unsigned int numeric, const std::string &text);
1229 /** Called whenever a result from /WHO is about to be returned
1230 * @param source The user running the /WHO query
1231 * @param user The user that this line of the query is about
1232 * @param channel The channel being queried (or NULL if not a channel query)
1233 * @param line The raw line to send; modifiable, if empty no line will be returned.
1235 virtual void OnSendWhoLine(User* source, User* user, Channel* channel, std::string& line);
1237 /** Called to check whether a channel restriction mode applies to a user on it
1238 * @return MOD_RES_DENY to apply the restriction, MOD_RES_ALLOW to bypass
1239 * the restriction, or MOD_RES_PASSTHRU to check restriction status normally
1241 virtual ModResult OnChannelRestrictionApply(User* user, Channel* chan, const char* restriction);
1245 #define CONF_NO_ERROR 0x000000
1246 #define CONF_NOT_A_NUMBER 0x000010
1247 #define CONF_INT_NEGATIVE 0x000080
1248 #define CONF_VALUE_NOT_FOUND 0x000100
1249 #define CONF_FILE_NOT_FOUND 0x000200
1252 /** Allows reading of values from configuration files
1253 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1254 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1255 * Constructing the class using one parameter allows you to specify a path to your own configuration
1256 * file, otherwise, inspircd.conf is read.
1258 class CoreExport ConfigReader : public interfacebase
1266 /** Default constructor.
1267 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1268 * as specified when running ./configure.
1271 /** Default destructor.
1272 * This method destroys the ConfigReader class.
1276 /** Retrieves a value from the config file.
1277 * This method retrieves a value from the config file. Where multiple copies of the tag
1278 * exist in the config file, index indicates which of the values to retrieve.
1280 std::string ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds = false);
1281 /** Retrieves a value from the config file.
1282 * This method retrieves a value from the config file. Where multiple copies of the tag
1283 * exist in the config file, index indicates which of the values to retrieve. If the
1284 * tag is not found the default value is returned instead.
1286 std::string ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds = false);
1288 /** Retrieves a boolean value from the config file.
1289 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1290 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1291 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1293 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1294 /** Retrieves a boolean value from the config file.
1295 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1296 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1297 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1298 * If the tag is not found, the default value is used instead.
1300 bool ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index);
1302 /** Retrieves an integer value from the config file.
1303 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1304 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1305 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1306 * return CONF_INVALID_NUMBER to be returned. need_positive is set if the number must be non-negative.
1307 * If a negative number is placed into a tag which is specified positive, 0 will be returned and GetError()
1308 * will return CONF_INT_NEGATIVE. Note that need_positive is not suitable to get an unsigned int - you
1309 * should cast the result to achieve that effect.
1311 int ReadInteger(const std::string &tag, const std::string &name, int index, bool need_positive);
1312 /** Retrieves an integer value from the config file.
1313 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1314 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1315 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1316 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1317 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1318 * will return CONF_NOT_UNSIGNED. If the tag is not found, the default value is used instead.
1320 int ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool need_positive);
1322 /** Returns the last error to occur.
1323 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1324 * A call to GetError() resets the error flag back to 0.
1328 /** Counts the number of times a given tag appears in the config file.
1329 * This method counts the number of times a tag appears in a config file, for use where
1330 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1331 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1332 * multiple instance tag.
1334 int Enumerate(const std::string &tag);
1339 /** Caches a text file into memory and can be used to retrieve lines from it.
1340 * This class contains methods for read-only manipulation of a text file in memory.
1341 * Either use the constructor type with one parameter to load a file into memory
1342 * at construction, or use the LoadFile method to load a file.
1344 class CoreExport FileReader : public classbase
1346 /** The file contents
1348 std::vector<std::string> fc;
1350 /** Content size in bytes
1352 unsigned long contentsize;
1354 /** Calculate content size in bytes
1359 /** Default constructor.
1360 * This method does not load any file into memory, you must use the LoadFile method
1361 * after constructing the class this way.
1365 /** Secondary constructor.
1366 * This method initialises the class with a file loaded into it ready for GetLine and
1367 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1370 FileReader(const std::string &filename);
1372 /** Default destructor.
1373 * This deletes the memory allocated to the file.
1377 /** Used to load a file.
1378 * This method loads a file into the class ready for GetLine and
1379 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1382 void LoadFile(const std::string &filename);
1384 /** Returns the whole content of the file as std::string
1386 std::string Contents();
1388 /** Returns the entire size of the file as std::string
1390 unsigned long ContentSize();
1392 /** Returns true if the file exists
1393 * This function will return false if the file could not be opened.
1397 /** Retrieve one line from the file.
1398 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1399 * the index was out of bounds, or the line had no data on it.
1401 std::string GetLine(int x);
1403 /** Returns the size of the file in lines.
1404 * This method returns the number of lines in the read file. If it is 0, no lines have been
1405 * read into memory, either because the file is empty or it does not exist, or cannot be
1406 * opened due to permission problems.
1411 /** A list of modules
1413 typedef std::vector<Module*> IntModuleList;
1415 /** An event handler iterator
1417 typedef IntModuleList::iterator EventHandlerIter;
1419 /** ModuleManager takes care of all things module-related
1422 class CoreExport ModuleManager
1425 /** Holds a string describing the last module error to occur
1427 std::string LastModuleError;
1429 /** The feature names published by various modules
1431 featurelist Features;
1433 /** The interface names published by various modules
1435 interfacelist Interfaces;
1437 /** Total number of modules loaded into the ircd
1441 /** List of loaded modules and shared object/dll handles
1442 * keyed by module name
1444 std::map<std::string, Module*> Modules;
1450 } prioritizationState;
1452 /** Internal unload module hook */
1453 bool CanUnload(Module*);
1456 /** Event handler hooks.
1457 * This needs to be public to be used by FOREACH_MOD and friends.
1459 IntModuleList EventHandlers[I_END];
1461 /** Simple, bog-standard, boring constructor.
1469 /** Change the priority of one event in a module.
1470 * Each module event has a list of modules which are attached to that event type.
1471 * If you wish to be called before or after other specific modules, you may use this
1472 * method (usually within void Module::Prioritize()) to set your events priority.
1473 * You may use this call in other methods too, however, this is not supported behaviour
1475 * @param mod The module to change the priority of
1476 * @param i The event to change the priority of
1477 * @param s The state you wish to use for this event. Use one of
1478 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1479 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1480 * to set it to be before or after one or more other modules.
1481 * @param modules If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1482 * then this contains a list of one or more modules your module must be
1483 * placed before or after. Your module will be placed before the highest
1484 * priority module in this list for PRIO_BEFORE, or after the lowest
1485 * priority module in this list for PRIORITY_AFTER.
1486 * @param sz The number of modules being passed for PRIO_BEFORE and PRIORITY_AFTER.
1487 * Defaults to 1, as most of the time you will only want to prioritize your module
1488 * to be before or after one other module.
1490 bool SetPriority(Module* mod, Implementation i, Priority s, Module** modules = NULL, size_t sz = 1);
1492 /** Change the priority of all events in a module.
1493 * @param mod The module to set the priority of
1494 * @param s The priority of all events in the module.
1495 * Note that with this method, it is not possible to effectively use
1496 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1497 * SetPriority method for this, where you may specify other modules to
1498 * be prioritized against.
1500 bool SetPriority(Module* mod, Priority s);
1502 /** Attach an event to a module.
1503 * You may later detatch the event with ModuleManager::Detach().
1504 * If your module is unloaded, all events are automatically detatched.
1505 * @param i Event type to attach
1506 * @param mod Module to attach event to
1507 * @return True if the event was attached
1509 bool Attach(Implementation i, Module* mod);
1511 /** Detatch an event from a module.
1512 * This is not required when your module unloads, as the core will
1513 * automatically detatch your module from all events it is attached to.
1514 * @param i Event type to detach
1515 * @param mod Module to detach event from
1516 * @param Detach true if the event was detached
1518 bool Detach(Implementation i, Module* mod);
1520 /** Attach an array of events to a module
1521 * @param i Event types (array) to attach
1522 * @param mod Module to attach events to
1524 void Attach(Implementation* i, Module* mod, size_t sz);
1526 /** Detach all events from a module (used on unload)
1527 * @param mod Module to detach from
1529 void DetachAll(Module* mod);
1531 /** Returns text describing the last module error
1532 * @return The last error message to occur
1534 std::string& LastError();
1536 /** Load a given module file
1537 * @param filename The file to load
1538 * @return True if the module was found and loaded
1540 bool Load(const char* filename);
1542 /** Unload a given module file. Note that the module will not be
1543 * completely gone until the cull list has finished processing.
1545 * @return true on success; if false, LastError will give a reason
1547 bool Unload(Module* module);
1549 /** Run an asynchronous reload of the given module. When the reload is
1550 * complete, the callback will be run with true if the reload succeeded
1551 * and false if it did not.
1553 void Reload(Module* module, HandlerBase1<void, bool>* callback);
1555 /** Called by the InspIRCd constructor to load all modules from the config file.
1559 void DoSafeUnload(Module*);
1561 /** Get the total number of currently loaded modules
1562 * @return The number of loaded modules
1566 return this->ModCount;
1569 /** Find a module by name, and return a Module* to it.
1570 * This is preferred over iterating the module lists yourself.
1571 * @param name The module name to look up
1572 * @return A pointer to the module, or NULL if the module cannot be found
1574 Module* Find(const std::string &name);
1576 /** Publish a 'feature'.
1577 * There are two ways for a module to find another module it depends on.
1578 * Either by name, using InspIRCd::FindModule, or by feature, using this
1579 * function. A feature is an arbitary string which identifies something this
1580 * module can do. For example, if your module provides SSL support, but other
1581 * modules provide SSL support too, all the modules supporting SSL should
1582 * publish an identical 'SSL' feature. This way, any module requiring use
1583 * of SSL functions can just look up the 'SSL' feature using FindFeature,
1584 * then use the module pointer they are given.
1585 * @param FeatureName The case sensitive feature name to make available
1586 * @param Mod a pointer to your module class
1587 * @returns True on success, false if the feature is already published by
1590 bool PublishFeature(const std::string &FeatureName, Module* Mod);
1592 /** Publish a module to an 'interface'.
1593 * Modules which implement the same interface (the same way of communicating
1594 * with other modules) can publish themselves to an interface, using this
1595 * method. When they do so, they become part of a list of related or
1596 * compatible modules, and a third module may then query for that list
1597 * and know that all modules within that list offer the same API.
1598 * A prime example of this is the hashing modules, which all accept the
1599 * same types of Request class. Consider this to be similar to PublishFeature,
1600 * except for that multiple modules may publish the same 'feature'.
1601 * @param InterfaceName The case sensitive interface name to make available
1602 * @param Mod a pointer to your module class
1603 * @returns True on success, false on failure (there are currently no failure
1606 bool PublishInterface(const std::string &InterfaceName, Module* Mod);
1608 /** Return a pair saying how many other modules are currently using the
1609 * interfaces provided by module m.
1610 * @param m The module to count usage for
1611 * @return A pair, where the first value is the number of uses of the interface,
1612 * and the second value is the interface name being used.
1614 std::pair<int,std::string> GetInterfaceInstanceCount(Module* m);
1616 /** Mark your module as using an interface.
1617 * If you mark your module as using an interface, then that interface
1618 * module may not unload until your module has unloaded first.
1619 * This can be used to prevent crashes by ensuring code you depend on
1620 * is always in memory while your module is active.
1621 * @param InterfaceName The interface to use
1623 void UseInterface(const std::string &InterfaceName);
1625 /** Mark your module as finished with an interface.
1626 * If you used UseInterface() above, you should use this method when
1627 * your module is finished with the interface (usually in its destructor)
1628 * to allow the modules which implement the given interface to be unloaded.
1629 * @param InterfaceName The interface you are finished with using.
1631 void DoneWithInterface(const std::string &InterfaceName);
1633 /** Unpublish a 'feature'.
1634 * When your module exits, it must call this method for every feature it
1635 * is providing so that the feature table is cleaned up.
1636 * @param FeatureName the feature to remove
1638 bool UnpublishFeature(const std::string &FeatureName);
1640 /** Unpublish your module from an interface
1641 * When your module exits, it must call this method for every interface
1642 * it is part of so that the interfaces table is cleaned up. Only when
1643 * the last item is deleted from an interface does the interface get
1645 * @param InterfaceName the interface to be removed from
1646 * @param Mod The module to remove from the interface list
1648 bool UnpublishInterface(const std::string &InterfaceName, Module* Mod);
1650 /** Find a 'feature'.
1651 * There are two ways for a module to find another module it depends on.
1652 * Either by name, using InspIRCd::FindModule, or by feature, using the
1653 * InspIRCd::PublishFeature method. A feature is an arbitary string which
1654 * identifies something this module can do. For example, if your module
1655 * provides SSL support, but other modules provide SSL support too, all
1656 * the modules supporting SSL should publish an identical 'SSL' feature.
1657 * To find a module capable of providing the feature you want, simply
1658 * call this method with the feature name you are looking for.
1659 * @param FeatureName The feature name you wish to obtain the module for
1660 * @returns A pointer to a valid module class on success, NULL on failure.
1662 Module* FindFeature(const std::string &FeatureName);
1664 /** Find an 'interface'.
1665 * An interface is a list of modules which all implement the same API.
1666 * @param InterfaceName The Interface you wish to obtain the module
1668 * @return A pointer to a deque of Module*, or NULL if the interface
1671 modulelist* FindInterface(const std::string &InterfaceName);
1673 /** Determine if a module has published the named interface.
1674 * This could be used in, for example, OnLoadModule to pick up other modules that can be used.
1675 * @param mod The module to check.
1676 * @param InterfaceName the interface you want to check for
1677 * @return True if the module provides the interface, false otherwise.
1679 bool ModuleHasInterface(Module* mod, const std::string& InterfaceName);
1681 /** Given a pointer to a Module, return its filename
1682 * @param m The module pointer to identify
1683 * @return The module name or an empty string
1685 const std::string& GetModuleName(Module* m);
1687 /** Return a list of all modules matching the given filter
1688 * @param filter This int is a bitmask of flags set in Module::Flags,
1689 * such as VF_VENDOR or VF_STATIC. If you wish to receive a list of
1690 * all modules with no filtering, set this to 0.
1691 * @return The list of module names
1693 const std::vector<std::string> GetAllModuleNames(int filter);
1696 /** Do not mess with these functions unless you know the C preprocessor
1697 * well enough to explain why they are needed. The order is important.
1699 #define MODULE_INIT_STR MODULE_INIT_STR_FN_2(MODULE_INIT_SYM)
1700 #define MODULE_INIT_STR_FN_2(x) MODULE_INIT_STR_FN_1(x)
1701 #define MODULE_INIT_STR_FN_1(x) #x
1702 #define MODULE_INIT_SYM MODULE_INIT_SYM_FN_2(API_VERSION)
1703 #define MODULE_INIT_SYM_FN_2(x) MODULE_INIT_SYM_FN_1(x)
1704 #define MODULE_INIT_SYM_FN_1(x) inspircd_module_ ## x
1706 /** This definition is used as shorthand for the various classes
1707 * and functions needed to make a module loadable by the OS.
1708 * It defines the class factory and external init_module function.
1712 #define MODULE_INIT(y) \
1713 extern "C" DllExport Module * MODULE_INIT_SYM() \
1717 BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
1719 switch ( nReason ) \
1721 case DLL_PROCESS_ATTACH: \
1722 case DLL_PROCESS_DETACH: \
1730 #define MODULE_INIT(y) \
1731 extern "C" DllExport Module * MODULE_INIT_SYM() \
1737 #define COMMAND_INIT(c) MODULE_INIT(CommandModule<c>)