1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2010 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 to represent an event type, for user, channel or server
41 enum TargetTypeFlags {
48 /** Used to represent wether a message was PRIVMSG or NOTICE
55 #define MOD_RES_ALLOW (ModResult(1))
56 #define MOD_RES_PASSTHRU (ModResult(0))
57 #define MOD_RES_DENY (ModResult(-1))
59 /** Used to represent an allow/deny module result.
60 * Not constructed as an enum because it reverses the value logic of some functions;
61 * the compiler will inline accesses to have the same efficiency as integer operations.
65 ModResult() : res(0) {}
66 explicit ModResult(int r) : res(r) {}
67 inline bool operator==(const ModResult& r) const
71 inline bool operator!=(const ModResult& r) const
75 inline bool operator!() const
79 inline bool check(bool def) const
81 return (res == 1 || (res == 0 && def));
84 * Merges two results, preferring ALLOW to DENY
86 inline ModResult operator+(const ModResult& r) const
88 if (res == r.res || r.res == 0)
92 // they are different, and neither is passthru
97 /** If you change the module API in any way, increment this value.
98 * This MUST be a pure integer, with no parenthesis
100 #define API_VERSION 141
103 * This #define allows us to call a method in all
104 * loaded modules in a readable simple way, e.g.:
105 * 'FOREACH_MOD(I_OnConnect,OnConnect(user));'
107 #define FOREACH_MOD(y,x) do { \
108 EventHandlerIter safei; \
109 for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ) \
117 catch (CoreException& modexcept) \
119 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
126 * Custom module result handling loop. This is a paired macro, and should only
127 * be used with while_each_hook.
129 * See src/channels.cpp for an example of use.
131 #define DO_EACH_HOOK(n,v,args) \
133 EventHandlerIter iter_ ## n = ServerInstance->Modules->EventHandlers[I_ ## n].begin(); \
134 while (iter_ ## n != ServerInstance->Modules->EventHandlers[I_ ## n].end()) \
136 Module* mod_ ## n = *iter_ ## n; \
140 v = (mod_ ## n)->n args;
142 #define WHILE_EACH_HOOK(n) \
144 catch (CoreException& except_ ## n) \
146 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s", (except_ ## n).GetReason()); \
147 (void) mod_ ## n; /* catch mismatched pairs */ \
153 * Module result iterator
154 * Runs the given hook until some module returns a useful result.
156 * Example: ModResult result;
157 * FIRST_MOD_RESULT(OnUserPreNick, result, (user, newnick))
159 #define FIRST_MOD_RESULT(n,v,args) do { \
160 v = MOD_RES_PASSTHRU; \
161 DO_EACH_HOOK(n,v,args) \
163 if (v != MOD_RES_PASSTHRU) \
166 WHILE_EACH_HOOK(n); \
169 /** Holds a module's Version information.
170 * The members (set by the constructor only) indicate details as to the version number
171 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
173 * The core provides only one implementation of the template, causing a run-time linking
174 * error when attempting to load a module compiled against a different API_VERSION.
177 class CoreExport VersionBase
180 /** Module description
182 const std::string description;
188 /** Server linking description string */
189 const std::string link_data;
191 /** Simple module version */
192 VersionBase(const std::string &desc, int flags = VF_NONE);
194 /** Complex version information, including linking compatability data */
195 VersionBase(const std::string &desc, int flags, const std::string& linkdata);
197 virtual ~VersionBase() {}
199 /** Return true if the module can link (default is identity comparison) */
200 virtual bool CanLink(const std::string& other_data);
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 class CoreExport DataProvider : public ServiceProvider
271 DataProvider(Module* Creator, const std::string& Name)
272 : ServiceProvider(Creator, Name, SERVICE_DATA) {}
275 class CoreExport dynamic_reference_base : public interfacebase
283 dynamic_reference_base(Module* Creator, const std::string& Name);
284 ~dynamic_reference_base();
285 inline void ClearCache() { value = NULL; }
286 inline const std::string& GetProvider() { return name; }
287 void SetProvider(const std::string& newname);
290 static void reset_all();
294 class dynamic_reference : public dynamic_reference_base
297 dynamic_reference(Module* Creator, const std::string& Name)
298 : dynamic_reference_base(Creator, Name) {}
299 inline T* operator->()
303 return static_cast<T*>(value);
307 /** Priority types which can be used by Module::Prioritize()
309 enum Priority { PRIORITY_FIRST, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
311 /** Implementation-specific flags which may be set in Module::Implements()
316 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash,
317 I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois,
318 I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick,
319 I_OnUserMessage, I_OnUserNotice, I_OnMode, I_OnGetServerDescription, I_OnSyncUser,
320 I_OnSyncChannel, I_OnDecodeMetaData, I_OnWallops, I_OnAcceptConnection, I_OnUserInit,
321 I_OnChangeHost, I_OnChangeName, I_OnAddLine, I_OnDelLine, I_OnExpireLine,
322 I_OnUserPostNick, I_OnPreMode, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule,
323 I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite,
324 I_OnRawMode, I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckChannelBan, I_OnExtBanCheck,
325 I_OnStats, I_OnChangeLocalUserHost, I_OnPreTopicChange,
326 I_OnPostTopicChange, I_OnEvent, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan,
327 I_OnDelBan, I_OnChangeLocalUserGECOS, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
328 I_OnPostOper, I_OnSyncNetwork, I_OnSetAway, I_OnPostCommand, I_OnPostJoin,
329 I_OnWhoisLine, I_OnBuildNeighborList, I_OnGarbageCollect, I_OnSetConnectClass,
330 I_OnText, I_OnPassCompare, I_OnRunTestSuite, I_OnNamesListItem, I_OnNumeric, I_OnHookIO,
331 I_OnPreRehash, I_OnModuleRehash, I_OnSendWhoLine, I_OnChangeIdent,
335 /** Base class for all InspIRCd modules
336 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
337 * its methods will be called when irc server events occur. class inherited from module must be
338 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
340 class CoreExport Module : public classbase, public usecountbase
343 /** File that this module was loaded from
345 std::string ModuleSourceFile;
346 /** Reference to the dlopen() value
348 DLLManager* ModuleDLLManager;
350 /** Default constructor.
351 * Creates a module class. Don't do any type of hook registration or checks
352 * for other modules here; do that in init().
357 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
359 virtual void init() {}
361 /** Clean up prior to destruction
362 * If you override, you must call this AFTER your module's cleanup
364 virtual CullResult cull();
366 /** Default destructor.
367 * destroys a module class
371 virtual void Prioritize()
375 /** Returns the version number of a Module.
376 * The method should return a Version object with its version information assigned via
379 virtual Version GetVersion() = 0;
381 /** Called when a user connects.
382 * The details of the connecting user are available to you in the parameter User *user
383 * @param user The user who is connecting
385 virtual void OnUserConnect(LocalUser* user);
387 /** Called when a user quits.
388 * The details of the exiting user are available to you in the parameter User *user
389 * This event is only called when the user is fully registered when they quit. To catch
390 * raw disconnections, use the OnUserDisconnect method.
391 * @param user The user who is quitting
392 * @param message The user's quit message (as seen by non-opers)
393 * @param oper_message The user's quit message (as seen by opers)
395 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
397 /** Called whenever a user's socket is closed.
398 * The details of the exiting user are available to you in the parameter User *user
399 * This event is called for all users, registered or not, as a cleanup method for modules
400 * which might assign resources to user, such as dns lookups, objects and sockets.
401 * @param user The user who is disconnecting
403 virtual void OnUserDisconnect(LocalUser* user);
405 /** Called whenever a channel is about to be deleted
406 * @param chan The channel being deleted
407 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
409 virtual ModResult OnChannelPreDelete(Channel *chan);
411 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
412 * @param chan The channel being deleted
414 virtual void OnChannelDelete(Channel* chan);
416 /** Called when a user joins a channel.
417 * The details of the joining user are available to you in the parameter User *user,
418 * and the details of the channel they have joined is available in the variable Channel *channel
419 * @param memb The channel membership being created
420 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
421 * to a channel due to the network sync.
422 * @param created This is true if the join created the channel
424 virtual void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list);
426 /** Called after a user joins a channel
427 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
429 * @param memb The channel membership created
431 virtual void OnPostJoin(Membership*);
433 /** Called when a user parts a channel.
434 * The details of the leaving user are available to you in the parameter User *user,
435 * and the details of the channel they have left is available in the variable Channel *channel
436 * @param memb The channel membership being destroyed
437 * @param partmessage The part message, or an empty string (may be modified)
439 virtual void OnUserPart(Membership* memb, std::string &partmessage, CUList& except_list);
441 /** Called on rehash.
442 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
443 * system. This is called in all cases -- including when this server will not execute the
444 * rehash because it is directed at a remote server.
446 * @param user The user performing the rehash, if any. If this is server initiated, the value of
447 * this variable will be NULL.
448 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
451 virtual void OnPreRehash(User* user, const std::string ¶meter);
453 /** Called on rehash.
454 * This method is called when a user initiates a module-specific rehash. This can be used to do
455 * expensive operations (such as reloading SSL certificates) that are not executed on a normal
456 * rehash for efficiency. A rehash of this type does not reload the core configuration.
458 * @param user The user performing the rehash.
459 * @param parameter The parameter given to REHASH
461 virtual void OnModuleRehash(User* user, const std::string ¶meter);
463 /** Called on rehash.
464 * This method is called after a rehash has completed. You should use it to reload any module
465 * configuration from the main configuration file.
466 * @param user The user that performed the rehash, if it was initiated by a user and that user
467 * is still connected.
469 virtual void OnRehash(User* user);
471 /** Called whenever a snotice is about to be sent to a snomask.
472 * snomask and type may both be modified; the message may not.
473 * @param snomask The snomask the message is going to (e.g. 'A')
474 * @param type The textual description the snomask will go to (e.g. 'OPER')
475 * @param message The text message to be sent via snotice
476 * @return 1 to block the snotice from being sent entirely, 0 else.
478 virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
480 /** Called whenever a user is about to join a channel, before any processing is done.
481 * Returning a value of 1 from this function stops the process immediately, causing no
482 * output to be sent to the user by the core. If you do this you must produce your own numerics,
483 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
484 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
488 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
489 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
490 * processing on the actual channel record at this point, however the channel NAME will still be passed in
491 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
492 * @param user The user joining the channel
493 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
494 * @param cname The channel name being joined. For new channels this is valid where chan is not.
495 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "o".
496 * You may alter this string to alter the user's modes on the channel.
497 * @param keygiven The key given to join the channel, or an empty string if none was provided
498 * @return 1 To prevent the join, 0 to allow it.
500 virtual ModResult OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string &privs, const std::string &keygiven);
502 /** Called whenever a user is about to be kicked.
503 * Returning a value of 1 from this function stops the process immediately, causing no
504 * output to be sent to the user by the core. If you do this you must produce your own numerics,
506 * @param source The user issuing the kick
507 * @param user The user being kicked
508 * @param chan The channel the user is being kicked from
509 * @param reason The kick reason
510 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
512 virtual ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason);
514 /** Called whenever a user is kicked.
515 * If this method is called, the kick is already underway and cannot be prevented, so
516 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
517 * @param source The user issuing the kick
518 * @param user The user being kicked
519 * @param chan The channel the user is being kicked from
520 * @param reason The kick reason
522 virtual void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except_list);
524 /** Called whenever a user opers locally.
525 * The User will contain the oper mode 'o' as this function is called after any modifications
526 * are made to the user's structure by the core.
527 * @param user The user who is opering up
528 * @param opertype The opers type name
530 virtual void OnOper(User* user, const std::string &opertype);
532 /** Called after a user opers locally.
533 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
534 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
535 * out the OPERTYPE, etc.
536 * @param user The user who is opering up
537 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
538 * @param opertype The opers type name
540 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
542 /** Called whenever a user types /INFO.
543 * The User will contain the information of the user who typed the command. Modules may use this
544 * method to output their own credits in /INFO (which is the ircd's version of an about box).
545 * It is purposefully not possible to modify any info that has already been output, or halt the list.
546 * You must write a 371 numeric to the user, containing your info in the following format:
548 * <nick> :information here
550 * @param user The user issuing /INFO
552 virtual void OnInfo(User* user);
554 /** Called whenever a /WHOIS is performed on a local user.
555 * The source parameter contains the details of the user who issued the WHOIS command, and
556 * the dest parameter contains the information of the user they are whoising.
557 * @param source The user issuing the WHOIS command
558 * @param dest The user who is being WHOISed
560 virtual void OnWhois(User* source, User* dest);
562 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
563 * Returning 1 from this function stops the process immediately, causing no
564 * output to be sent to the user by the core. If you do this you must produce your own numerics,
565 * notices etc. This is useful for modules which may want to filter invites to channels.
566 * @param source The user who is issuing the INVITE
567 * @param dest The user being invited
568 * @param channel The channel the user is being invited to
569 * @param timeout The time the invite will expire (0 == never)
570 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
572 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
574 /** Called after a user has been successfully invited to a channel.
575 * You cannot prevent the invite from occuring using this function, to do that,
576 * use OnUserPreInvite instead.
577 * @param source The user who is issuing the INVITE
578 * @param dest The user being invited
579 * @param channel The channel the user is being invited to
580 * @param timeout The time the invite will expire (0 == never)
582 virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout);
584 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
585 * Returning any nonzero value from this function stops the process immediately, causing no
586 * output to be sent to the user by the core. If you do this you must produce your own numerics,
587 * notices etc. This is useful for modules which may want to filter or redirect messages.
588 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
589 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
590 * of where the message is destined to be sent.
591 * @param user The user sending the message
592 * @param dest The target of the message (Channel* or User*)
593 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
594 * @param text Changeable text being sent by the user
595 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
596 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
597 * It will be ignored for private messages.
598 * @return 1 to deny the message, 0 to allow it
600 virtual ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
602 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
603 * Returning any nonzero value from this function stops the process immediately, causing no
604 * output to be sent to the user by the core. If you do this you must produce your own numerics,
605 * notices etc. This is useful for modules which may want to filter or redirect messages.
606 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
607 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
608 * of where the message is destined to be sent.
609 * You may alter the message text as you wish before relinquishing control to the next module
610 * in the chain, and if no other modules block the text this altered form of the text will be sent out
611 * to the user and possibly to other servers.
612 * @param user The user sending the message
613 * @param dest The target of the message (Channel* or User*)
614 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
615 * @param text Changeable text being sent by the user
616 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
617 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
618 * It will be ignored for private notices.
619 * @return 1 to deny the NOTICE, 0 to allow it
621 virtual ModResult OnUserPreNotice(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
623 /** Called when sending a message to all "neighbors" of a given user -
624 * that is, all users that share a common channel. This is used in
625 * commands such as NICK, QUIT, etc.
626 * @param source The source of the message
627 * @param include_c Channels to scan for users to include
628 * @param exceptions Map of user->bool that overrides the inclusion decision
630 * Set exceptions[user] = true to include, exceptions[user] = false to exclude
632 virtual void OnBuildNeighborList(User* source, UserChanList &include_c, std::map<User*,bool> &exceptions);
634 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
635 * Please note that although you can see remote nickchanges through this function, you should
636 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
637 * check user->server before taking any action (including returning nonzero from the method).
638 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
639 * module to generate some meaninful output.
640 * @param user The username changing their nick
641 * @param newnick Their new nickname
642 * @return 1 to deny the change, 0 to allow
644 virtual ModResult OnUserPreNick(User* user, const std::string &newnick);
646 /** Called after any PRIVMSG sent from a user.
647 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
648 * if target_type is TYPE_CHANNEL.
649 * @param user The user sending the message
650 * @param dest The target of the message
651 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
652 * @param text the text being sent by the user
653 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
655 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
657 /** Called after any NOTICE sent from a user.
658 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
659 * if target_type is TYPE_CHANNEL.
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 OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
668 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
669 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
670 * if target_type is TYPE_CHANNEL.
671 * The difference between this event and OnUserPreNotice/OnUserPreMessage is that delivery is gauranteed,
672 * the message has already been vetted. In the case of the other two methods, a later module may stop your
673 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
674 * @param user The user sending the message
675 * @param dest The target of the message
676 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
677 * @param text the text being sent by the user
678 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
680 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
682 /** Called after every MODE command sent from a user
683 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
684 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
685 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
686 * @param user The user sending the MODEs
687 * @param dest The target of the modes (User* or Channel*)
688 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
689 * @param text The actual modes and their parameters if any
690 * @param translate The translation types of the mode parameters
692 virtual void OnMode(User* user, void* dest, int target_type, const std::vector<std::string> &text, const std::vector<TranslateType> &translate);
694 /** Allows modules to alter or create server descriptions
695 * Whenever a module requires a server description, for example for display in
696 * WHOIS, this function is called in all modules. You may change or define the
697 * description given in std::string &description. If you do, this description
698 * will be shown in the WHOIS fields.
699 * @param servername The servername being searched for
700 * @param description Alterable server description for this server
702 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
704 /** Allows modules to synchronize data which relates to users 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. Do not use this call to
710 * synchronize data which you have stored using class Extensible -- There is a specialist
711 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
712 * @param user The user being syncronized
713 * @param proto A pointer to the module handling network protocol
714 * @param opaque An opaque pointer set by the protocol module, should not be modified!
716 virtual void OnSyncUser(User* user, Module* proto, void* opaque);
718 /** Allows modules to synchronize data which relates to channels during a netburst.
719 * When this function is called, it will be called from the module which implements
720 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
721 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
722 * (see below). This function will be called for every user visible on your side
723 * of the burst, allowing you to for example set modes, etc.
725 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
727 * @param chan The channel being syncronized
728 * @param proto A pointer to the module handling network protocol
729 * @param opaque An opaque pointer set by the protocol module, should not be modified!
731 virtual void OnSyncChannel(Channel* chan, Module* proto, void* opaque);
733 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
734 * Whenever the linking module wants to send out data, but doesnt know what the data
735 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
736 * this method is called. You should use the ProtoSendMetaData function after you've
737 * correctly decided how the data should be represented, to send the metadata on its way if
738 * if it belongs to your module.
739 * @param proto A pointer to the module handling network protocol
740 * @param opaque An opaque pointer set by the protocol module, should not be modified!
741 * @param displayable If this value is true, the data is going to be displayed to a user,
742 * and not sent across the network. Use this to determine wether or not to show sensitive data.
744 virtual void OnSyncNetwork(Module* proto, void* opaque);
746 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
747 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
748 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
749 * @param target The Channel* or User* that data should be added to
750 * @param extname The extension name which is being sent
751 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
753 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
755 /** Implemented by modules which provide the ability to link servers.
756 * These modules will implement this method, which allows transparent sending of servermodes
757 * down the network link as a broadcast, without a module calling it having to know the format
758 * of the MODE command before the actual mode string.
760 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
761 * of how to use this function.
763 * @param opaque An opaque pointer set by the protocol module, should not be modified!
764 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
765 * @param target The Channel* or User* that modes should be sent for
766 * @param modeline The modes and parameters to be sent
767 * @param translate The translation types of the mode parameters
769 virtual void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::vector<std::string> &modeline, const std::vector<TranslateType> &translate);
771 /** Implemented by modules which provide the ability to link servers.
772 * These modules will implement this method, which allows metadata (extra data added to
773 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
774 * to other servers on a netburst and decoded at the other end by the same module on a
777 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
778 * how to use this function.
779 * @param opaque An opaque pointer set by the protocol module, should not be modified!
780 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
781 * @param target The Channel* or User* that metadata should be sent for
782 * @param extname The extension name to send metadata for
783 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
785 virtual void ProtoSendMetaData(void* opaque, Extensible* target, const std::string &extname, const std::string &extdata);
787 /** Called after every WALLOPS command.
788 * @param user The user sending the WALLOPS
789 * @param text The content of the WALLOPS message
791 virtual void OnWallops(User* user, const std::string &text);
793 /** Called whenever a user's hostname is changed.
794 * This event triggers after the host has been set.
795 * @param user The user whos host is being changed
796 * @param newhost The new hostname being set
798 virtual void OnChangeHost(User* user, const std::string &newhost);
800 /** Called whenever a user's GECOS (realname) is changed.
801 * This event triggers after the name has been set.
802 * @param user The user who's GECOS is being changed
803 * @param gecos The new GECOS being set on the user
805 virtual void OnChangeName(User* user, const std::string &gecos);
807 /** Called whenever a user's IDENT is changed.
808 * This event triggers after the name has been set.
809 * @param user The user who's IDENT is being changed
810 * @param gecos The new IDENT being set on the user
812 virtual void OnChangeIdent(User* user, const std::string &ident);
814 /** Called whenever an xline is added by a local user.
815 * This method is triggered after the line is added.
816 * @param source The sender of the line or NULL for local server
817 * @param line The xline being added
819 virtual void OnAddLine(User* source, XLine* line);
821 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
822 * This method is triggered after the line is deleted.
823 * @param source The user removing the line or NULL for local server
824 * @param line the line being deleted
826 virtual void OnDelLine(User* source, XLine* line);
828 /** Called whenever an xline expires.
829 * This method is triggered after the line is deleted.
830 * @param line The line being deleted.
832 virtual void OnExpireLine(XLine *line);
834 /** Called before your module is unloaded to clean up Extensibles.
835 * This method is called once for every user and channel on the network,
836 * so that when your module unloads it may clear up any remaining data
837 * in the form of Extensibles added using Extensible::Extend().
838 * If the target_type variable is TYPE_USER, then void* item refers to
839 * a User*, otherwise it refers to a Channel*.
840 * @param target_type The type of item being cleaned
841 * @param item A pointer to the item's class
843 virtual void OnCleanup(int target_type, void* item);
845 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
846 * have been applied. Please note that although you can see remote nickchanges through this function, you should
847 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
848 * check user->server before taking any action (including returning nonzero from the method).
849 * Because this method is called after the nickchange is taken place, no return values are possible
850 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
851 * @param user The user changing their nick
852 * @param oldnick The old nickname of the user before the nickchange
854 virtual void OnUserPostNick(User* user, const std::string &oldnick);
856 /** Called before any mode change, to allow a single access check for
857 * a full mode change (use OnRawMode to check individual modes)
859 * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
860 * OnRawMode for each individual mode
862 * @param source the user making the mode change
863 * @param dest the user destination of the umode change (NULL if a channel mode)
864 * @param channel the channel destination of the mode change
865 * @param parameters raw mode parameters; parameters[0] is the user/channel being changed
867 virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, const std::vector<std::string>& parameters);
869 /** Called when a 005 numeric is about to be output.
870 * The module should modify the 005 numeric if needed to indicate its features.
871 * @param output The 005 string to be modified if neccessary.
873 virtual void On005Numeric(std::string &output);
875 /** Called when a client is disconnected by KILL.
876 * If a client is killed by a server, e.g. a nickname collision or protocol error,
878 * Return 1 from this function to prevent the kill, and 0 from this function to allow
879 * it as normal. If you prevent the kill no output will be sent to the client, it is
880 * down to your module to generate this information.
881 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
882 * If you do so youre risking race conditions, desyncs and worse!
883 * @param source The user sending the KILL
884 * @param dest The user being killed
885 * @param reason The kill reason
886 * @return 1 to prevent the kill, 0 to allow
888 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
890 /** Called when an oper wants to disconnect a remote user via KILL
891 * @param source The user sending the KILL
892 * @param dest The user being killed
893 * @param reason The kill reason
895 virtual void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
897 /** Called whenever a module is loaded.
898 * mod will contain a pointer to the module, and string will contain its name,
899 * for example m_widgets.so. This function is primary for dependency checking,
900 * your module may decide to enable some extra features if it sees that you have
901 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
902 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
903 * but instead operate under reduced functionality, unless the dependency is
904 * absolutely neccessary (e.g. a module that extends the features of another
906 * @param mod A pointer to the new module
908 virtual void OnLoadModule(Module* mod);
910 /** Called whenever a module is unloaded.
911 * mod will contain a pointer to the module, and string will contain its name,
912 * for example m_widgets.so. This function is primary for dependency checking,
913 * your module may decide to enable some extra features if it sees that you have
914 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
915 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
916 * but instead operate under reduced functionality, unless the dependency is
917 * absolutely neccessary (e.g. a module that extends the features of another
919 * @param mod Pointer to the module being unloaded (still valid)
920 * @param name The filename of the module being unloaded
922 virtual void OnUnloadModule(Module* mod);
924 /** Called once every five seconds for background processing.
925 * This timer can be used to control timed features. Its period is not accurate
926 * enough to be used as a clock, but it is gauranteed to be called at least once in
927 * any five second period, directly from the main loop of the server.
928 * @param curtime The current timer derived from time(2)
930 virtual void OnBackgroundTimer(time_t curtime);
932 /** Called whenever any command is about to be executed.
933 * This event occurs for all registered commands, wether they are registered in the core,
934 * or another module, and for invalid commands. Invalid commands may only be sent to this
935 * function when the value of validated is false. By returning 1 from this method you may prevent the
936 * command being executed. If you do this, no output is created by the core, and it is
937 * down to your module to produce any output neccessary.
938 * Note that unless you return 1, you should not destroy any structures (e.g. by using
939 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
940 * method returns, it will be passed an invalid pointer to the user object and crash!)
941 * @param command The command being executed
942 * @param parameters An array of array of characters containing the parameters for the command
943 * @param pcnt The nuimber of parameters passed to the command
944 * @param user the user issuing the command
945 * @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.
946 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
947 * @param original_line The entire original line as passed to the parser from the user
948 * @return 1 to block the command, 0 to allow
950 virtual ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, LocalUser *user, bool validated, const std::string &original_line);
952 /** Called after any command has been executed.
953 * This event occurs for all registered commands, wether they are registered in the core,
954 * or another module, but it will not occur for invalid commands (e.g. ones which do not
955 * exist within the command table). The result code returned by the command handler is
957 * @param command The command being executed
958 * @param parameters An array of array of characters containing the parameters for the command
959 * @param pcnt The nuimber of parameters passed to the command
960 * @param user the user issuing the command
961 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
962 * @param original_line The entire original line as passed to the parser from the user
964 virtual void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, LocalUser *user, CmdResult result, const std::string &original_line);
966 /** Called when a user is first connecting, prior to starting DNS lookups, checking initial
967 * connect class, or accepting any commands.
969 virtual void OnUserInit(LocalUser* user);
971 /** Called to check if a user who is connecting can now be allowed to register
972 * If any modules return false for this function, the user is held in the waiting
973 * state until all modules return true. For example a module which implements ident
974 * lookups will continue to return false for a user until their ident lookup is completed.
975 * Note that the registration timeout for a user overrides these checks, if the registration
976 * timeout is reached, the user is disconnected even if modules report that the user is
977 * not ready to connect.
978 * @param user The user to check
979 * @return true to indicate readiness, false if otherwise
981 virtual ModResult OnCheckReady(LocalUser* user);
983 /** Called whenever a user is about to register their connection (e.g. before the user
984 * is sent the MOTD etc). Modules can use this method if they are performing a function
985 * which must be done before the actual connection is completed (e.g. ident lookups,
986 * dnsbl lookups, etc).
987 * Note that you should NOT delete the user record here by causing a disconnection!
988 * Use OnUserConnect for that instead.
989 * @param user The user registering
990 * @return 1 to indicate user quit, 0 to continue
992 virtual ModResult OnUserRegister(LocalUser* user);
994 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
995 * This method will always be called for each join, wether or not the channel is actually +i, and
996 * determines the outcome of an if statement around the whole section of invite checking code.
997 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
998 * @param user The user joining the channel
999 * @param chan The channel being joined
1000 * @return 1 to explicitly allow the join, 0 to proceed as normal
1002 virtual ModResult OnCheckInvite(User* user, Channel* chan);
1004 /** Called whenever a mode character is processed.
1005 * Return 1 from this function to block the mode character from being processed entirely.
1006 * @param user The user who is sending the mode
1007 * @param chan The channel the mode is being sent to (or NULL if a usermode)
1008 * @param mode The mode character being set
1009 * @param param The parameter for the mode or an empty string
1010 * @param adding true of the mode is being added, false if it is being removed
1011 * @param pcnt The parameter count for the mode (0 or 1)
1012 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
1013 * to skip all permission checking. Please note that for remote mode changes, your return value
1016 virtual ModResult OnRawMode(User* user, Channel* chan, const char mode, const std::string ¶m, bool adding, int pcnt);
1018 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1019 * This method will always be called for each join, wether or not the channel is actually +k, and
1020 * determines the outcome of an if statement around the whole section of key checking code.
1021 * if the user specified no key, the keygiven string will be a valid but empty value.
1022 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1023 * @param user The user joining the channel
1024 * @param chan The channel being joined
1025 * @return 1 to explicitly allow the join, 0 to proceed as normal
1027 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
1029 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1030 * This method will always be called for each join, wether or not the channel is actually +l, and
1031 * determines the outcome of an if statement around the whole section of channel limit checking code.
1032 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1033 * @param user The user joining the channel
1034 * @param chan The channel being joined
1035 * @return 1 to explicitly allow the join, 0 to proceed as normal
1037 virtual ModResult OnCheckLimit(User* user, Channel* chan);
1040 * Checks for a user's ban from the channel
1041 * @param user The user to check
1042 * @param chan The channel to check in
1043 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1044 * ban check, or MOD_RES_PASSTHRU to check bans normally
1046 virtual ModResult OnCheckChannelBan(User* user, Channel* chan);
1049 * Checks for a user's match of a single ban
1050 * @param user The user to check for match
1051 * @param chan The channel on which the match is being checked
1052 * @param mask The mask being checked
1053 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1054 * ban check, or MOD_RES_PASSTHRU to check bans normally
1056 virtual ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask);
1058 /** Checks for a match on a given extban type
1059 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1060 * ban check, or MOD_RES_PASSTHRU to check bans normally
1062 virtual ModResult OnExtBanCheck(User* user, Channel* chan, char type);
1064 /** Called on all /STATS commands
1065 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1066 * @param symbol the symbol provided to /STATS
1067 * @param user the user issuing the /STATS command
1068 * @param results A string_list to append results into. You should put all your results
1069 * into this string_list, rather than displaying them directly, so that your handler will
1070 * work when remote STATS queries are received.
1071 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1073 virtual ModResult OnStats(char symbol, User* user, string_list &results);
1075 /** Called whenever a change of a local users displayed host is attempted.
1076 * Return 1 to deny the host change, or 0 to allow it.
1077 * @param user The user whos host will be changed
1078 * @param newhost The new hostname
1079 * @return 1 to deny the host change, 0 to allow
1081 virtual ModResult OnChangeLocalUserHost(LocalUser* user, const std::string &newhost);
1083 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1084 * return 1 to deny the name change, or 0 to allow it.
1085 * @param user The user whos GECOS will be changed
1086 * @param newhost The new GECOS
1087 * @return 1 to deny the GECOS change, 0 to allow
1089 virtual ModResult OnChangeLocalUserGECOS(LocalUser* user, const std::string &newhost);
1091 /** Called before a topic is changed.
1092 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
1093 * As with other 'pre' events, you should only ever block a local event.
1094 * @param user The user changing the topic
1095 * @param chan The channels who's topic is being changed
1096 * @param topic The actual topic text
1097 * @param 1 to block the topic change, 0 to allow
1099 virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
1101 /** Called whenever a topic has been changed.
1102 * To block topic changes you must use OnPreTopicChange instead.
1103 * @param user The user changing the topic
1104 * @param chan The channels who's topic is being changed
1105 * @param topic The actual topic text
1107 virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
1109 /** Called whenever an Event class is sent to all modules by another module.
1110 * You should *always* check the value of Event::id to determine the event type.
1111 * @param event The Event class being received
1113 virtual void OnEvent(Event& event);
1115 /** Called whenever a Request class is sent to your module by another module.
1116 * The value of Request::id should be used to determine the type of request.
1117 * @param request The Request class being received
1119 virtual void OnRequest(Request& request);
1121 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
1122 * The password field (from the config file) is in 'password' and is to be compared against
1123 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
1124 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
1125 * @param ex The object that's causing the authentication (User* for <oper> <connect:allow> etc, Server* for <link>).
1126 * @param password The password from the configuration file (the password="" value).
1127 * @param input The password entered by the user or whoever.
1128 * @param hashtype The hash value from the config
1129 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
1131 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
1133 /** Called whenever a user is given usermode +o, anywhere on the network.
1134 * You cannot override this and prevent it from happening as it is already happened and
1135 * such a task must be performed by another server. You can however bounce modes by sending
1136 * servermodes out to reverse mode changes.
1137 * @param user The user who is opering
1139 virtual void OnGlobalOper(User* user);
1141 /** Called after a user has fully connected and all modules have executed OnUserConnect
1142 * This event is informational only. You should not change any user information in this
1143 * event. To do so, use the OnUserConnect method to change the state of local users.
1144 * This is called for both local and remote users.
1145 * @param user The user who is connecting
1147 virtual void OnPostConnect(User* user);
1149 /** Called whenever a ban is added to a channel's list.
1150 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1151 * @param source The user adding the ban
1152 * @param channel The channel the ban is being added to
1153 * @param banmask The ban mask being added
1154 * @return 1 to block the ban, 0 to continue as normal
1156 virtual ModResult OnAddBan(User* source, Channel* channel,const std::string &banmask);
1158 /** Called whenever a ban is removed from a channel's list.
1159 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1160 * @param source The user deleting the ban
1161 * @param channel The channel the ban is being deleted from
1162 * @param banmask The ban mask being deleted
1163 * @return 1 to block the unban, 0 to continue as normal
1165 virtual ModResult OnDelBan(User* source, Channel* channel,const std::string &banmask);
1167 /** Called to install an I/O hook on an event handler
1168 * @param user The item to possibly install the I/O hook on
1169 * @param via The port that <user> connected on
1171 virtual void OnHookIO(StreamSocket*, ListenSocket* via);
1173 /** Called when a port accepts a connection
1174 * Return MOD_RES_ACCEPT if you have used the file descriptor.
1175 * @param fd The file descriptor returned from accept()
1176 * @param from The local port the user connected to
1177 * @param client The client IP address and port
1178 * @param server The server IP address and port
1180 virtual ModResult OnAcceptConnection(int fd, ListenSocket* from, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
1182 /** Called immediately after any connection is accepted. This is intended for raw socket
1183 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1184 * no information relating to a user record as the connection has not been assigned yet.
1185 * There are no return values from this call as all modules get an opportunity if required to
1186 * process the connection.
1187 * @param fd The file descriptor returned from accept()
1188 * @param client The client IP address and port
1189 * @param server The server IP address and port
1190 * @param localport The local port number the user connected to
1192 virtual void OnStreamSocketAccept(StreamSocket*, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
1195 * Called when a hooked stream has data to write, or when the socket
1196 * engine returns it as writable
1197 * @param socket The socket in question
1198 * @param sendq Data to send to the socket
1199 * @return 1 if the sendq has been completely emptied, 0 if there is
1200 * still data to send, and -1 if there was an error
1202 virtual int OnStreamSocketWrite(StreamSocket*, std::string& sendq);
1204 /** Called immediately before any socket is closed. When this event is called, shutdown()
1205 * has not yet been called on the socket.
1206 * @param fd The file descriptor of the socket prior to close()
1208 virtual void OnStreamSocketClose(StreamSocket*);
1210 /** Called immediately upon connection of an outbound BufferedSocket which has been hooked
1212 * @param fd The file descriptor of the socket immediately after connect()
1214 virtual void OnStreamSocketConnect(StreamSocket*);
1217 * Called when the stream socket has data to read
1218 * @param socket The socket that is ready
1219 * @param recvq The receive queue that new data should be appended to
1220 * @return 1 if new data has been read, 0 if no new data is ready (but the
1221 * socket is still connected), -1 if there was an error or close
1223 virtual int OnStreamSocketRead(StreamSocket*, std::string& recvq);
1225 /** Called whenever a user sets away or returns from being away.
1226 * The away message is available as a parameter, but should not be modified.
1227 * At this stage, it has already been copied into the user record.
1228 * If awaymsg is empty, the user is returning from away.
1229 * @param user The user setting away
1230 * @param awaymsg The away message of the user, or empty if returning from away
1231 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
1233 virtual ModResult OnSetAway(User* user, const std::string &awaymsg);
1235 /** Called whenever a line of WHOIS output is sent to a user.
1236 * You may change the numeric and the text of the output by changing
1237 * the values numeric and text, but you cannot change the user the
1238 * numeric is sent to. You may however change the user's User values.
1239 * @param user The user the numeric is being sent to
1240 * @param dest The user being WHOISed
1241 * @param numeric The numeric of the line being sent
1242 * @param text The text of the numeric, including any parameters
1243 * @return nonzero to drop the line completely so that the user does not
1244 * receive it, or zero to allow the line to be sent.
1246 virtual ModResult OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
1248 /** Called at intervals for modules to garbage-collect any hashes etc.
1249 * Certain data types such as hash_map 'leak' buckets, which must be
1250 * tidied up and freed by copying into a new item every so often. This
1251 * method is called when it is time to do that.
1253 virtual void OnGarbageCollect();
1255 /** Called when a user's connect class is being matched
1256 * @return MOD_RES_ALLOW to force the class to match, MOD_RES_DENY to forbid it, or
1257 * MOD_RES_PASSTHRU to allow normal matching (by host/port).
1259 virtual ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass);
1261 /** Add test suite hooks here. These are used for testing functionality of a module
1262 * via the --testsuite debugging parameter.
1264 virtual void OnRunTestSuite();
1266 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
1267 * For example NAMESX, channel mode +u and +I, and UHNAMES. If the nick is set to an empty string by any
1268 * module, then this will cause the nickname not to be displayed at all.
1270 virtual void OnNamesListItem(User* issuer, Membership* item, std::string &prefixes, std::string &nick);
1272 virtual ModResult OnNumeric(User* user, unsigned int numeric, const std::string &text);
1274 /** Called whenever a result from /WHO is about to be returned
1275 * @param source The user running the /WHO query
1276 * @param params The parameters to the /WHO query
1277 * @param user The user that this line of the query is about
1278 * @param line The raw line to send; modifiable, if empty no line will be returned.
1280 virtual void OnSendWhoLine(User* source, const std::vector<std::string>& params, User* user, std::string& line);
1284 #define CONF_NO_ERROR 0x000000
1285 #define CONF_NOT_A_NUMBER 0x000010
1286 #define CONF_INT_NEGATIVE 0x000080
1287 #define CONF_VALUE_NOT_FOUND 0x000100
1288 #define CONF_FILE_NOT_FOUND 0x000200
1291 /** Allows reading of values from configuration files
1292 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1293 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1294 * Constructing the class using one parameter allows you to specify a path to your own configuration
1295 * file, otherwise, inspircd.conf is read.
1297 class CoreExport ConfigReader : public interfacebase
1305 /** Default constructor.
1306 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1307 * as specified when running ./configure.
1310 /** Default destructor.
1311 * This method destroys the ConfigReader class.
1315 /** Retrieves a value from the config file.
1316 * This method retrieves a value from the config file. Where multiple copies of the tag
1317 * exist in the config file, index indicates which of the values to retrieve.
1319 std::string ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds = false);
1320 /** Retrieves a value from the config file.
1321 * This method retrieves a value from the config file. Where multiple copies of the tag
1322 * exist in the config file, index indicates which of the values to retrieve. If the
1323 * tag is not found the default value is returned instead.
1325 std::string ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds = false);
1327 /** Retrieves a boolean value from the config file.
1328 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1329 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1330 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1332 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1333 /** Retrieves a boolean value from the config file.
1334 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1335 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1336 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1337 * If the tag is not found, the default value is used instead.
1339 bool ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index);
1341 /** Retrieves an integer value from the config file.
1342 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1343 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1344 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1345 * return CONF_INVALID_NUMBER to be returned. need_positive is set if the number must be non-negative.
1346 * If a negative number is placed into a tag which is specified positive, 0 will be returned and GetError()
1347 * will return CONF_INT_NEGATIVE. Note that need_positive is not suitable to get an unsigned int - you
1348 * should cast the result to achieve that effect.
1350 int ReadInteger(const std::string &tag, const std::string &name, int index, bool need_positive);
1351 /** Retrieves an integer value from the config file.
1352 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1353 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1354 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1355 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1356 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1357 * will return CONF_NOT_UNSIGNED. If the tag is not found, the default value is used instead.
1359 int ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool need_positive);
1361 /** Returns the last error to occur.
1362 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1363 * A call to GetError() resets the error flag back to 0.
1367 /** Counts the number of times a given tag appears in the config file.
1368 * This method counts the number of times a tag appears in a config file, for use where
1369 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1370 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1371 * multiple instance tag.
1373 int Enumerate(const std::string &tag);
1378 /** Caches a text file into memory and can be used to retrieve lines from it.
1379 * This class contains methods for read-only manipulation of a text file in memory.
1380 * Either use the constructor type with one parameter to load a file into memory
1381 * at construction, or use the LoadFile method to load a file.
1383 class CoreExport FileReader : public classbase
1385 /** The file contents
1387 std::vector<std::string> fc;
1389 /** Content size in bytes
1391 unsigned long contentsize;
1393 /** Calculate content size in bytes
1398 /** Default constructor.
1399 * This method does not load any file into memory, you must use the LoadFile method
1400 * after constructing the class this way.
1404 /** Secondary constructor.
1405 * This method initialises the class with a file loaded into it ready for GetLine and
1406 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1409 FileReader(const std::string &filename);
1411 /** Default destructor.
1412 * This deletes the memory allocated to the file.
1416 /** Used to load a file.
1417 * This method loads a file into the class ready for GetLine and
1418 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1421 void LoadFile(const std::string &filename);
1423 /** Returns the whole content of the file as std::string
1425 std::string Contents();
1427 /** Returns the entire size of the file as std::string
1429 unsigned long ContentSize();
1431 /** Returns true if the file exists
1432 * This function will return false if the file could not be opened.
1436 /** Retrieve one line from the file.
1437 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1438 * the index was out of bounds, or the line had no data on it.
1440 std::string GetLine(int x);
1442 /** Returns the size of the file in lines.
1443 * This method returns the number of lines in the read file. If it is 0, no lines have been
1444 * read into memory, either because the file is empty or it does not exist, or cannot be
1445 * opened due to permission problems.
1450 /** A list of modules
1452 typedef std::vector<Module*> IntModuleList;
1454 /** An event handler iterator
1456 typedef IntModuleList::iterator EventHandlerIter;
1458 /** ModuleManager takes care of all things module-related
1461 class CoreExport ModuleManager
1464 /** Holds a string describing the last module error to occur
1466 std::string LastModuleError;
1468 /** Total number of modules loaded into the ircd
1472 /** List of loaded modules and shared object/dll handles
1473 * keyed by module name
1475 std::map<std::string, Module*> Modules;
1481 } prioritizationState;
1483 /** Internal unload module hook */
1484 bool CanUnload(Module*);
1487 /** Event handler hooks.
1488 * This needs to be public to be used by FOREACH_MOD and friends.
1490 IntModuleList EventHandlers[I_END];
1492 /** List of data services keyed by name */
1493 std::multimap<std::string, ServiceProvider*> DataProviders;
1495 /** Simple, bog-standard, boring constructor.
1503 /** Change the priority of one event in a module.
1504 * Each module event has a list of modules which are attached to that event type.
1505 * If you wish to be called before or after other specific modules, you may use this
1506 * method (usually within void Module::Prioritize()) to set your events priority.
1507 * You may use this call in other methods too, however, this is not supported behaviour
1509 * @param mod The module to change the priority of
1510 * @param i The event to change the priority of
1511 * @param s The state you wish to use for this event. Use one of
1512 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1513 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1514 * to set it to be before or after one or more other modules.
1515 * @param which If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1516 * then this contains a the module that your module must be placed before
1519 bool SetPriority(Module* mod, Implementation i, Priority s, Module* which = NULL);
1521 /** Backwards compat interface */
1522 inline bool SetPriority(Module* mod, Implementation i, Priority s, Module** dptr)
1524 return SetPriority(mod, i, s, *dptr);
1527 /** Change the priority of all events in a module.
1528 * @param mod The module to set the priority of
1529 * @param s The priority of all events in the module.
1530 * Note that with this method, it is not possible to effectively use
1531 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1532 * SetPriority method for this, where you may specify other modules to
1533 * be prioritized against.
1535 bool SetPriority(Module* mod, Priority s);
1537 /** Attach an event to a module.
1538 * You may later detatch the event with ModuleManager::Detach().
1539 * If your module is unloaded, all events are automatically detatched.
1540 * @param i Event type to attach
1541 * @param mod Module to attach event to
1542 * @return True if the event was attached
1544 bool Attach(Implementation i, Module* mod);
1546 /** Detatch an event from a module.
1547 * This is not required when your module unloads, as the core will
1548 * automatically detatch your module from all events it is attached to.
1549 * @param i Event type to detach
1550 * @param mod Module to detach event from
1551 * @param Detach true if the event was detached
1553 bool Detach(Implementation i, Module* mod);
1555 /** Attach an array of events to a module
1556 * @param i Event types (array) to attach
1557 * @param mod Module to attach events to
1559 void Attach(Implementation* i, Module* mod, size_t sz);
1561 /** Detach all events from a module (used on unload)
1562 * @param mod Module to detach from
1564 void DetachAll(Module* mod);
1566 /** Returns text describing the last module error
1567 * @return The last error message to occur
1569 std::string& LastError();
1571 /** Load a given module file
1572 * @param filename The file to load
1573 * @param defer Defer module init (loading many modules)
1574 * @return True if the module was found and loaded
1576 bool Load(const std::string& filename, bool defer = false);
1578 /** Unload a given module file. Note that the module will not be
1579 * completely gone until the cull list has finished processing.
1581 * @return true on success; if false, LastError will give a reason
1583 bool Unload(Module* module);
1585 /** Run an asynchronous reload of the given module. When the reload is
1586 * complete, the callback will be run with true if the reload succeeded
1587 * and false if it did not.
1589 void Reload(Module* module, HandlerBase1<void, bool>* callback);
1591 /** Called by the InspIRCd constructor to load all modules from the config file.
1595 void DoSafeUnload(Module*);
1597 /** Get the total number of currently loaded modules
1598 * @return The number of loaded modules
1602 return this->ModCount;
1605 /** Find a module by name, and return a Module* to it.
1606 * This is preferred over iterating the module lists yourself.
1607 * @param name The module name to look up
1608 * @return A pointer to the module, or NULL if the module cannot be found
1610 Module* Find(const std::string &name);
1612 /** Register a service provided by a module */
1613 void AddService(ServiceProvider&);
1615 /** Unregister a service provided by a module */
1616 void DelService(ServiceProvider&);
1618 inline void AddServices(ServiceProvider** list, int count)
1620 for(int i=0; i < count; i++)
1621 AddService(*list[i]);
1624 /** Find a service by name.
1625 * If multiple modules provide a given service, the first one loaded will be chosen.
1627 ServiceProvider* FindService(ServiceType Type, const std::string& name);
1629 template<typename T> inline T* FindDataService(const std::string& name)
1631 return static_cast<T*>(FindService(SERVICE_DATA, name));
1634 /** Return a list of all modules matching the given filter
1635 * @param filter This int is a bitmask of flags set in Module::Flags,
1636 * such as VF_VENDOR or VF_STATIC. If you wish to receive a list of
1637 * all modules with no filtering, set this to 0.
1638 * @return The list of module names
1640 const std::vector<std::string> GetAllModuleNames(int filter);
1643 /** Do not mess with these functions unless you know the C preprocessor
1644 * well enough to explain why they are needed. The order is important.
1646 #define MODULE_INIT_STR MODULE_INIT_STR_FN_2(MODULE_INIT_SYM)
1647 #define MODULE_INIT_STR_FN_2(x) MODULE_INIT_STR_FN_1(x)
1648 #define MODULE_INIT_STR_FN_1(x) #x
1649 #define MODULE_INIT_SYM MODULE_INIT_SYM_FN_2(API_VERSION)
1650 #define MODULE_INIT_SYM_FN_2(x) MODULE_INIT_SYM_FN_1(x)
1651 #define MODULE_INIT_SYM_FN_1(x) inspircd_module_ ## x
1655 struct AllCommandList {
1656 typedef Command* (*fn)(Module*);
1657 AllCommandList(fn cmd);
1659 #define COMMAND_INIT(x) static Command* MK_ ## x(Module* m) { return new x(m); } \
1660 static const AllCommandList PREP_ ## x(&MK_ ## x);
1662 struct AllModuleList {
1663 typedef Module* (*fn)();
1666 AllModuleList(fn mod, const std::string& Name);
1669 #define MODULE_INIT(x) static Module* MK_ ## x() { return new x; } \
1670 static const AllModuleList PREP_ ## x(&MK_ ## x, MODNAMESTR);
1672 #define MODNAMESTR MODNAMESTR_FN_2(MODNAME)
1673 #define MODNAMESTR_FN_2(x) MODNAMESTR_FN_1(x)
1674 #define MODNAMESTR_FN_1(x) #x
1678 /** This definition is used as shorthand for the various classes
1679 * and functions needed to make a module loadable by the OS.
1680 * It defines the class factory and external init_module function.
1684 #define MODULE_INIT(y) \
1685 extern "C" DllExport Module * MODULE_INIT_SYM() \
1689 BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
1691 switch ( nReason ) \
1693 case DLL_PROCESS_ATTACH: \
1694 case DLL_PROCESS_DETACH: \
1702 #define MODULE_INIT(y) \
1703 extern "C" DllExport Module * MODULE_INIT_SYM() \
1707 extern "C" const char inspircd_src_version[] = VERSION " r" REVISION;
1710 #define COMMAND_INIT(c) MODULE_INIT(CommandModule<c>)