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 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 137
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;
183 /** Version information.
185 const std::string version;
191 /** Initialize version class
193 VersionBase(const std::string &desc, int flags = VF_NONE, const std::string& src_rev = VERSION " r" REVISION);
196 typedef VersionBase<API_VERSION> Version;
198 /** The Request class is a unicast message directed at a given module.
199 * When this class is properly instantiated it may be sent to a module
200 * using the Send() method, which will call the given module's OnRequest
201 * method with this class as its parameter.
203 class CoreExport Request : public classbase
206 /** This should be a null-terminated string identifying the type of request,
207 * all modules should define this and use it to determine the nature of the
208 * request before they attempt to cast the Request in any way.
210 const char* const id;
211 /** This is a pointer to the sender of the message, which can be used to
212 * directly trigger events, or to create a reply.
215 /** The single destination of the Request
219 /** Create a new Request
220 * This is for the 'new' way of defining a subclass
221 * of Request and defining it in a common header,
222 * passing an object of your Request subclass through
223 * as a Request* and using the ID string to determine
224 * what to cast it back to and the other end.
226 Request(Module* src, Module* dst, const char* idstr);
227 /** Send the Request.
233 /** The Event class is a unicast message directed at all modules.
234 * When the class is properly instantiated it may be sent to all modules
235 * using the Send() method, which will trigger the OnEvent method in
236 * all modules passing the object as its parameter.
238 class CoreExport Event : public classbase
241 /** This is a pointer to the sender of the message, which can be used to
242 * directly trigger events, or to create a reply.
245 /** The event identifier.
246 * This is arbitary text which should be used to distinguish
247 * one type of event from another.
249 const std::string id;
251 /** Create a new Event
253 Event(Module* src, const std::string &eventid);
255 * The return result of an Event::Send() will always be NULL as
256 * no replies are expected.
261 class CoreExport DataProvider : public ServiceProvider
264 DataProvider(Module* Creator, const std::string& Name)
265 : ServiceProvider(Creator, Name, SERVICE_DATA) {}
268 class CoreExport dynamic_reference_base : public interfacebase
276 dynamic_reference_base(Module* Creator, const std::string& Name);
277 ~dynamic_reference_base();
278 inline void ClearCache() { value = NULL; }
279 inline const std::string& GetProvider() { return name; }
280 void SetProvider(const std::string& newname);
286 class dynamic_reference : public dynamic_reference_base
289 dynamic_reference(Module* Creator, const std::string& Name)
290 : dynamic_reference_base(Creator, Name) {}
291 inline T* operator->()
295 return static_cast<T*>(value);
299 /** Priority types which can be used by Module::Prioritize()
301 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
303 /** Implementation-specific flags which may be set in Module::Implements()
308 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash,
309 I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois,
310 I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick,
311 I_OnUserMessage, I_OnUserNotice, I_OnMode, I_OnGetServerDescription, I_OnSyncUser,
312 I_OnSyncChannel, I_OnDecodeMetaData, I_OnWallops, I_OnAcceptConnection,
313 I_OnChangeHost, I_OnChangeName, I_OnAddLine, I_OnDelLine, I_OnExpireLine,
314 I_OnUserPostNick, I_OnPreMode, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule,
315 I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite,
316 I_OnRawMode, I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckChannelBan, I_OnExtBanCheck,
317 I_OnStats, I_OnChangeLocalUserHost, I_OnPreTopicChange,
318 I_OnPostTopicChange, I_OnEvent, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan,
319 I_OnDelBan, I_OnChangeLocalUserGECOS, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
320 I_OnPostOper, I_OnSyncNetwork, I_OnSetAway, I_OnUserList, I_OnPostCommand, I_OnPostJoin,
321 I_OnWhoisLine, I_OnBuildNeighborList, I_OnGarbageCollect,
322 I_OnText, I_OnPassCompare, I_OnRunTestSuite, I_OnNamesListItem, I_OnNumeric, I_OnHookIO,
323 I_OnPreRehash, I_OnModuleRehash, I_OnSendWhoLine, I_OnChangeIdent, I_OnChannelRestrictionApply,
327 /** Base class for all InspIRCd modules
328 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
329 * its methods will be called when irc server events occur. class inherited from module must be
330 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
332 class CoreExport Module : public classbase, public usecountbase
335 /** File that this module was loaded from
337 std::string ModuleSourceFile;
338 /** Reference to the dlopen() value
340 DLLManager* ModuleDLLManager;
342 /** Default constructor.
343 * Creates a module class.
344 * @param Me An instance of the InspIRCd class which will be saved into ServerInstance for your use
345 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
349 /** Clean up prior to destruction
350 * If you override, you must call this AFTER your module's cleanup
352 virtual CullResult cull();
354 /** Default destructor.
355 * destroys a module class
359 virtual void Prioritize()
363 /** Returns the version number of a Module.
364 * The method should return a Version object with its version information assigned via
367 virtual Version GetVersion() = 0;
369 /** Called when a user connects.
370 * The details of the connecting user are available to you in the parameter User *user
371 * @param user The user who is connecting
373 virtual void OnUserConnect(LocalUser* user);
375 /** Called when a user quits.
376 * The details of the exiting user are available to you in the parameter User *user
377 * This event is only called when the user is fully registered when they quit. To catch
378 * raw disconnections, use the OnUserDisconnect method.
379 * @param user The user who is quitting
380 * @param message The user's quit message (as seen by non-opers)
381 * @param oper_message The user's quit message (as seen by opers)
383 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
385 /** Called whenever a user's socket is closed.
386 * The details of the exiting user are available to you in the parameter User *user
387 * This event is called for all users, registered or not, as a cleanup method for modules
388 * which might assign resources to user, such as dns lookups, objects and sockets.
389 * @param user The user who is disconnecting
391 virtual void OnUserDisconnect(LocalUser* user);
393 /** Called whenever a channel is about to be deleted
394 * @param chan The channel being deleted
395 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
397 virtual ModResult OnChannelPreDelete(Channel *chan);
399 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
400 * @param chan The channel being deleted
402 virtual void OnChannelDelete(Channel* chan);
404 /** Called when a user joins a channel.
405 * The details of the joining user are available to you in the parameter User *user,
406 * and the details of the channel they have joined is available in the variable Channel *channel
407 * @param memb The channel membership being created
408 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
409 * to a channel due to the network sync.
410 * @param created This is true if the join created the channel
412 virtual void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list);
414 /** Called after a user joins a channel
415 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
417 * @param memb The channel membership created
419 virtual void OnPostJoin(Membership*);
421 /** Called when a user parts a channel.
422 * The details of the leaving user are available to you in the parameter User *user,
423 * and the details of the channel they have left is available in the variable Channel *channel
424 * @param memb The channel membership being destroyed
425 * @param partmessage The part message, or an empty string (may be modified)
427 virtual void OnUserPart(Membership* memb, std::string &partmessage, CUList& except_list);
429 /** Called on rehash.
430 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
431 * system. This is called in all cases -- including when this server will not execute the
432 * rehash because it is directed at a remote server.
434 * @param user The user performing the rehash, if any. If this is server initiated, the value of
435 * this variable will be NULL.
436 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
439 virtual void OnPreRehash(User* user, const std::string ¶meter);
441 /** Called on rehash.
442 * This method is called when a user initiates a module-specific rehash. This can be used to do
443 * expensive operations (such as reloading SSL certificates) that are not executed on a normal
444 * rehash for efficiency. A rehash of this type does not reload the core configuration.
446 * @param user The user performing the rehash.
447 * @param parameter The parameter given to REHASH
449 virtual void OnModuleRehash(User* user, const std::string ¶meter);
451 /** Called on rehash.
452 * This method is called after a rehash has completed. You should use it to reload any module
453 * configuration from the main configuration file.
454 * @param user The user that performed the rehash, if it was initiated by a user and that user
455 * is still connected.
457 virtual void OnRehash(User* user);
459 /** Called whenever a snotice is about to be sent to a snomask.
460 * snomask and type may both be modified; the message may not.
461 * @param snomask The snomask the message is going to (e.g. 'A')
462 * @param type The textual description the snomask will go to (e.g. 'OPER')
463 * @param message The text message to be sent via snotice
464 * @return 1 to block the snotice from being sent entirely, 0 else.
466 virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
468 /** Called whenever a user is about to join a channel, before any processing is done.
469 * Returning a value of 1 from this function stops the process immediately, causing no
470 * output to be sent to the user by the core. If you do this you must produce your own numerics,
471 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
472 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
476 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
477 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
478 * processing on the actual channel record at this point, however the channel NAME will still be passed in
479 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
480 * @param user The user joining the channel
481 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
482 * @param cname The channel name being joined. For new channels this is valid where chan is not.
483 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "o".
484 * You may alter this string to alter the user's modes on the channel.
485 * @param keygiven The key given to join the channel, or an empty string if none was provided
486 * @return 1 To prevent the join, 0 to allow it.
488 virtual ModResult OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string &privs, const std::string &keygiven);
490 /** Called whenever a user is about to be kicked.
491 * Returning a value of 1 from this function stops the process immediately, causing no
492 * output to be sent to the user by the core. If you do this you must produce your own numerics,
494 * @param source The user issuing the kick
495 * @param user The user being kicked
496 * @param chan The channel the user is being kicked from
497 * @param reason The kick reason
498 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
500 virtual ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason);
502 /** Called whenever a user is kicked.
503 * If this method is called, the kick is already underway and cannot be prevented, so
504 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
505 * @param source The user issuing the kick
506 * @param user The user being kicked
507 * @param chan The channel the user is being kicked from
508 * @param reason The kick reason
510 virtual void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except_list);
512 /** Called whenever a user opers locally.
513 * The User will contain the oper mode 'o' as this function is called after any modifications
514 * are made to the user's structure by the core.
515 * @param user The user who is opering up
516 * @param opertype The opers type name
518 virtual void OnOper(User* user, const std::string &opertype);
520 /** Called after a user opers locally.
521 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
522 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
523 * out the OPERTYPE, etc.
524 * @param user The user who is opering up
525 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
526 * @param opertype The opers type name
528 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
530 /** Called whenever a user types /INFO.
531 * The User will contain the information of the user who typed the command. Modules may use this
532 * method to output their own credits in /INFO (which is the ircd's version of an about box).
533 * It is purposefully not possible to modify any info that has already been output, or halt the list.
534 * You must write a 371 numeric to the user, containing your info in the following format:
536 * <nick> :information here
538 * @param user The user issuing /INFO
540 virtual void OnInfo(User* user);
542 /** Called whenever a /WHOIS is performed on a local user.
543 * The source parameter contains the details of the user who issued the WHOIS command, and
544 * the dest parameter contains the information of the user they are whoising.
545 * @param source The user issuing the WHOIS command
546 * @param dest The user who is being WHOISed
548 virtual void OnWhois(User* source, User* dest);
550 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
551 * Returning 1 from this function stops the process immediately, causing no
552 * output to be sent to the user by the core. If you do this you must produce your own numerics,
553 * notices etc. This is useful for modules which may want to filter invites to channels.
554 * @param source The user who is issuing the INVITE
555 * @param dest The user being invited
556 * @param channel The channel the user is being invited to
557 * @param timeout The time the invite will expire (0 == never)
558 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
560 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
562 /** Called after a user has been successfully invited to a channel.
563 * You cannot prevent the invite from occuring using this function, to do that,
564 * use OnUserPreInvite instead.
565 * @param source The user who is issuing the INVITE
566 * @param dest The user being invited
567 * @param channel The channel the user is being invited to
568 * @param timeout The time the invite will expire (0 == never)
570 virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout);
572 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
573 * Returning any nonzero value from this function stops the process immediately, causing no
574 * output to be sent to the user by the core. If you do this you must produce your own numerics,
575 * notices etc. This is useful for modules which may want to filter or redirect messages.
576 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
577 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
578 * of where the message is destined to be sent.
579 * @param user The user sending the message
580 * @param dest The target of the message (Channel* or User*)
581 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
582 * @param text Changeable text being sent by the user
583 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
584 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
585 * It will be ignored for private messages.
586 * @return 1 to deny the message, 0 to allow it
588 virtual ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
590 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
591 * Returning any nonzero value from this function stops the process immediately, causing no
592 * output to be sent to the user by the core. If you do this you must produce your own numerics,
593 * notices etc. This is useful for modules which may want to filter or redirect messages.
594 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
595 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
596 * of where the message is destined to be sent.
597 * You may alter the message text as you wish before relinquishing control to the next module
598 * in the chain, and if no other modules block the text this altered form of the text will be sent out
599 * to the user and possibly to other servers.
600 * @param user The user sending the message
601 * @param dest The target of the message (Channel* or User*)
602 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
603 * @param text Changeable text being sent by the user
604 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
605 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
606 * It will be ignored for private notices.
607 * @return 1 to deny the NOTICE, 0 to allow it
609 virtual ModResult OnUserPreNotice(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
611 /** Called when sending a message to all "neighbors" of a given user -
612 * that is, all users that share a common channel. This is used in
613 * commands such as NICK, QUIT, etc.
614 * @param source The source of the message
615 * @param include_c Channels to scan for users to include
616 * @param exceptions Map of user->bool that overrides the inclusion decision
618 * Set exceptions[user] = true to include, exceptions[user] = false to exclude
620 virtual void OnBuildNeighborList(User* source, UserChanList &include_c, std::map<User*,bool> &exceptions);
622 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
623 * Please note that although you can see remote nickchanges through this function, you should
624 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
625 * check user->server before taking any action (including returning nonzero from the method).
626 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
627 * module to generate some meaninful output.
628 * @param user The username changing their nick
629 * @param newnick Their new nickname
630 * @return 1 to deny the change, 0 to allow
632 virtual ModResult OnUserPreNick(User* user, const std::string &newnick);
634 /** Called after any PRIVMSG sent from a user.
635 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
636 * if target_type is TYPE_CHANNEL.
637 * @param user The user sending the message
638 * @param dest The target of the message
639 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
640 * @param text the text being sent by the user
641 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
643 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
645 /** Called after any NOTICE sent from a user.
646 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
647 * if target_type is TYPE_CHANNEL.
648 * @param user The user sending the message
649 * @param dest The target of the message
650 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
651 * @param text the text being sent by the user
652 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
654 virtual void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
656 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
657 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
658 * if target_type is TYPE_CHANNEL.
659 * The difference between this event and OnUserPreNotice/OnUserPreMessage is that delivery is gauranteed,
660 * the message has already been vetted. In the case of the other two methods, a later module may stop your
661 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
662 * @param user The user sending the message
663 * @param dest The target of the message
664 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
665 * @param text the text being sent by the user
666 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
668 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
670 /** Called after every MODE command sent from a user
671 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
672 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
673 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
674 * @param user The user sending the MODEs
675 * @param dest The target of the modes (User* or Channel*)
676 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
677 * @param text The actual modes and their parameters if any
678 * @param translate The translation types of the mode parameters
680 virtual void OnMode(User* user, void* dest, int target_type, const std::vector<std::string> &text, const std::vector<TranslateType> &translate);
682 /** Allows modules to alter or create server descriptions
683 * Whenever a module requires a server description, for example for display in
684 * WHOIS, this function is called in all modules. You may change or define the
685 * description given in std::string &description. If you do, this description
686 * will be shown in the WHOIS fields.
687 * @param servername The servername being searched for
688 * @param description Alterable server description for this server
690 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
692 /** Allows modules to synchronize data which relates to users during a netburst.
693 * When this function is called, it will be called from the module which implements
694 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
695 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
696 * (see below). This function will be called for every user visible on your side
697 * of the burst, allowing you to for example set modes, etc. Do not use this call to
698 * synchronize data which you have stored using class Extensible -- There is a specialist
699 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
700 * @param user The user being syncronized
701 * @param proto A pointer to the module handling network protocol
702 * @param opaque An opaque pointer set by the protocol module, should not be modified!
704 virtual void OnSyncUser(User* user, Module* proto, void* opaque);
706 /** Allows modules to synchronize data which relates to channels during a netburst.
707 * When this function is called, it will be called from the module which implements
708 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
709 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
710 * (see below). This function will be called for every user visible on your side
711 * of the burst, allowing you to for example set modes, etc.
713 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
715 * @param chan The channel being syncronized
716 * @param proto A pointer to the module handling network protocol
717 * @param opaque An opaque pointer set by the protocol module, should not be modified!
719 virtual void OnSyncChannel(Channel* chan, Module* proto, void* opaque);
721 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
722 * Whenever the linking module wants to send out data, but doesnt know what the data
723 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
724 * this method is called. You should use the ProtoSendMetaData function after you've
725 * correctly decided how the data should be represented, to send the metadata on its way if
726 * if it belongs to your module.
727 * @param proto A pointer to the module handling network protocol
728 * @param opaque An opaque pointer set by the protocol module, should not be modified!
729 * @param displayable If this value is true, the data is going to be displayed to a user,
730 * and not sent across the network. Use this to determine wether or not to show sensitive data.
732 virtual void OnSyncNetwork(Module* proto, void* opaque);
734 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
735 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
736 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
737 * @param target The Channel* or User* that data should be added to
738 * @param extname The extension name which is being sent
739 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
741 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
743 /** Implemented by modules which provide the ability to link servers.
744 * These modules will implement this method, which allows transparent sending of servermodes
745 * down the network link as a broadcast, without a module calling it having to know the format
746 * of the MODE command before the actual mode string.
748 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
749 * of how to use this function.
751 * @param opaque An opaque pointer set by the protocol module, should not be modified!
752 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
753 * @param target The Channel* or User* that modes should be sent for
754 * @param modeline The modes and parameters to be sent
755 * @param translate The translation types of the mode parameters
757 virtual void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::vector<std::string> &modeline, const std::vector<TranslateType> &translate);
759 /** Implemented by modules which provide the ability to link servers.
760 * These modules will implement this method, which allows metadata (extra data added to
761 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
762 * to other servers on a netburst and decoded at the other end by the same module on a
765 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
766 * how to use this function.
767 * @param opaque An opaque pointer set by the protocol module, should not be modified!
768 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
769 * @param target The Channel* or User* that metadata should be sent for
770 * @param extname The extension name to send metadata for
771 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
773 virtual void ProtoSendMetaData(void* opaque, Extensible* target, const std::string &extname, const std::string &extdata);
775 /** Called after every WALLOPS command.
776 * @param user The user sending the WALLOPS
777 * @param text The content of the WALLOPS message
779 virtual void OnWallops(User* user, const std::string &text);
781 /** Called whenever a user's hostname is changed.
782 * This event triggers after the host has been set.
783 * @param user The user whos host is being changed
784 * @param newhost The new hostname being set
786 virtual void OnChangeHost(User* user, const std::string &newhost);
788 /** Called whenever a user's GECOS (realname) is changed.
789 * This event triggers after the name has been set.
790 * @param user The user who's GECOS is being changed
791 * @param gecos The new GECOS being set on the user
793 virtual void OnChangeName(User* user, const std::string &gecos);
795 /** Called whenever a user's IDENT is changed.
796 * This event triggers after the name has been set.
797 * @param user The user who's IDENT is being changed
798 * @param gecos The new IDENT being set on the user
800 virtual void OnChangeIdent(User* user, const std::string &ident);
802 /** Called whenever an xline is added by a local user.
803 * This method is triggered after the line is added.
804 * @param source The sender of the line or NULL for local server
805 * @param line The xline being added
807 virtual void OnAddLine(User* source, XLine* line);
809 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
810 * This method is triggered after the line is deleted.
811 * @param source The user removing the line or NULL for local server
812 * @param line the line being deleted
814 virtual void OnDelLine(User* source, XLine* line);
816 /** Called whenever an xline expires.
817 * This method is triggered after the line is deleted.
818 * @param line The line being deleted.
820 virtual void OnExpireLine(XLine *line);
822 /** Called before your module is unloaded to clean up Extensibles.
823 * This method is called once for every user and channel on the network,
824 * so that when your module unloads it may clear up any remaining data
825 * in the form of Extensibles added using Extensible::Extend().
826 * If the target_type variable is TYPE_USER, then void* item refers to
827 * a User*, otherwise it refers to a Channel*.
828 * @param target_type The type of item being cleaned
829 * @param item A pointer to the item's class
831 virtual void OnCleanup(int target_type, void* item);
833 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
834 * have been applied. Please note that although you can see remote nickchanges through this function, you should
835 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
836 * check user->server before taking any action (including returning nonzero from the method).
837 * Because this method is called after the nickchange is taken place, no return values are possible
838 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
839 * @param user The user changing their nick
840 * @param oldnick The old nickname of the user before the nickchange
842 virtual void OnUserPostNick(User* user, const std::string &oldnick);
844 /** Called before any mode change, to allow a single access check for
845 * a full mode change (use OnRawMode to check individual modes)
847 * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
848 * OnRawMode for each individual mode
850 * @param source the user making the mode change
851 * @param dest the user destination of the umode change (NULL if a channel mode)
852 * @param channel the channel destination of the mode change
853 * @param parameters raw mode parameters; parameters[0] is the user/channel being changed
855 virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, const std::vector<std::string>& parameters);
857 /** Called when a 005 numeric is about to be output.
858 * The module should modify the 005 numeric if needed to indicate its features.
859 * @param output The 005 string to be modified if neccessary.
861 virtual void On005Numeric(std::string &output);
863 /** Called when a client is disconnected by KILL.
864 * If a client is killed by a server, e.g. a nickname collision or protocol error,
866 * Return 1 from this function to prevent the kill, and 0 from this function to allow
867 * it as normal. If you prevent the kill no output will be sent to the client, it is
868 * down to your module to generate this information.
869 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
870 * If you do so youre risking race conditions, desyncs and worse!
871 * @param source The user sending the KILL
872 * @param dest The user being killed
873 * @param reason The kill reason
874 * @return 1 to prevent the kill, 0 to allow
876 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
878 /** Called when an oper wants to disconnect a remote user via KILL
879 * @param source The user sending the KILL
880 * @param dest The user being killed
881 * @param reason The kill reason
883 virtual void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
885 /** Called whenever a module is loaded.
886 * mod will contain a pointer to the module, and string will contain its name,
887 * for example m_widgets.so. This function is primary for dependency checking,
888 * your module may decide to enable some extra features if it sees that you have
889 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
890 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
891 * but instead operate under reduced functionality, unless the dependency is
892 * absolutely neccessary (e.g. a module that extends the features of another
894 * @param mod A pointer to the new module
896 virtual void OnLoadModule(Module* mod);
898 /** Called whenever a module is unloaded.
899 * mod will contain a pointer to the module, and string will contain its name,
900 * for example m_widgets.so. This function is primary for dependency checking,
901 * your module may decide to enable some extra features if it sees that you have
902 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
903 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
904 * but instead operate under reduced functionality, unless the dependency is
905 * absolutely neccessary (e.g. a module that extends the features of another
907 * @param mod Pointer to the module being unloaded (still valid)
908 * @param name The filename of the module being unloaded
910 virtual void OnUnloadModule(Module* mod);
912 /** Called once every five seconds for background processing.
913 * This timer can be used to control timed features. Its period is not accurate
914 * enough to be used as a clock, but it is gauranteed to be called at least once in
915 * any five second period, directly from the main loop of the server.
916 * @param curtime The current timer derived from time(2)
918 virtual void OnBackgroundTimer(time_t curtime);
920 /** Called whenever any command is about to be executed.
921 * This event occurs for all registered commands, wether they are registered in the core,
922 * or another module, and for invalid commands. Invalid commands may only be sent to this
923 * function when the value of validated is false. By returning 1 from this method you may prevent the
924 * command being executed. If you do this, no output is created by the core, and it is
925 * down to your module to produce any output neccessary.
926 * Note that unless you return 1, you should not destroy any structures (e.g. by using
927 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
928 * method returns, it will be passed an invalid pointer to the user object and crash!)
929 * @param command The command being executed
930 * @param parameters An array of array of characters containing the parameters for the command
931 * @param pcnt The nuimber of parameters passed to the command
932 * @param user the user issuing the command
933 * @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.
934 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
935 * @param original_line The entire original line as passed to the parser from the user
936 * @return 1 to block the command, 0 to allow
938 virtual ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, User *user, bool validated, const std::string &original_line);
940 /** Called after any command has been executed.
941 * This event occurs for all registered commands, wether they are registered in the core,
942 * or another module, but it will not occur for invalid commands (e.g. ones which do not
943 * exist within the command table). The result code returned by the command handler is
945 * @param command The command being executed
946 * @param parameters An array of array of characters containing the parameters for the command
947 * @param pcnt The nuimber of parameters passed to the command
948 * @param user the user issuing the command
949 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
950 * @param original_line The entire original line as passed to the parser from the user
952 virtual void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, User *user, CmdResult result, const std::string &original_line);
954 /** Called to check if a user who is connecting can now be allowed to register
955 * If any modules return false for this function, the user is held in the waiting
956 * state until all modules return true. For example a module which implements ident
957 * lookups will continue to return false for a user until their ident lookup is completed.
958 * Note that the registration timeout for a user overrides these checks, if the registration
959 * timeout is reached, the user is disconnected even if modules report that the user is
960 * not ready to connect.
961 * @param user The user to check
962 * @return true to indicate readiness, false if otherwise
964 virtual ModResult OnCheckReady(LocalUser* user);
966 /** Called whenever a user is about to register their connection (e.g. before the user
967 * is sent the MOTD etc). Modules can use this method if they are performing a function
968 * which must be done before the actual connection is completed (e.g. ident lookups,
969 * dnsbl lookups, etc).
970 * Note that you should NOT delete the user record here by causing a disconnection!
971 * Use OnUserConnect for that instead.
972 * @param user The user registering
973 * @return 1 to indicate user quit, 0 to continue
975 virtual ModResult OnUserRegister(LocalUser* user);
977 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
978 * This method will always be called for each join, wether or not the channel is actually +i, and
979 * determines the outcome of an if statement around the whole section of invite checking code.
980 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
981 * @param user The user joining the channel
982 * @param chan The channel being joined
983 * @return 1 to explicitly allow the join, 0 to proceed as normal
985 virtual ModResult OnCheckInvite(User* user, Channel* chan);
987 /** Called whenever a mode character is processed.
988 * Return 1 from this function to block the mode character from being processed entirely.
989 * @param user The user who is sending the mode
990 * @param chan The channel the mode is being sent to (or NULL if a usermode)
991 * @param mode The mode character being set
992 * @param param The parameter for the mode or an empty string
993 * @param adding true of the mode is being added, false if it is being removed
994 * @param pcnt The parameter count for the mode (0 or 1)
995 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
996 * to skip all permission checking. Please note that for remote mode changes, your return value
999 virtual ModResult OnRawMode(User* user, Channel* chan, const char mode, const std::string ¶m, bool adding, int pcnt);
1001 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1002 * This method will always be called for each join, wether or not the channel is actually +k, and
1003 * determines the outcome of an if statement around the whole section of key checking code.
1004 * if the user specified no key, the keygiven string will be a valid but empty value.
1005 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1006 * @param user The user joining the channel
1007 * @param chan The channel being joined
1008 * @return 1 to explicitly allow the join, 0 to proceed as normal
1010 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
1012 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1013 * This method will always be called for each join, wether or not the channel is actually +l, and
1014 * determines the outcome of an if statement around the whole section of channel limit checking code.
1015 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1016 * @param user The user joining the channel
1017 * @param chan The channel being joined
1018 * @return 1 to explicitly allow the join, 0 to proceed as normal
1020 virtual ModResult OnCheckLimit(User* user, Channel* chan);
1023 * Checks for a user's ban from the channel
1024 * @param user The user to check
1025 * @param chan The channel to check in
1026 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1027 * ban check, or MOD_RES_PASSTHRU to check bans normally
1029 virtual ModResult OnCheckChannelBan(User* user, Channel* chan);
1032 * Checks for a user's match of a single ban
1033 * @param user The user to check for match
1034 * @param chan The channel on which the match is being checked
1035 * @param mask The mask being checked
1036 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1037 * ban check, or MOD_RES_PASSTHRU to check bans normally
1039 virtual ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask);
1041 /** Checks for a match on a given extban type
1042 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1043 * ban check, or MOD_RES_PASSTHRU to check bans normally
1045 virtual ModResult OnExtBanCheck(User* user, Channel* chan, char type);
1047 /** Called on all /STATS commands
1048 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1049 * @param symbol the symbol provided to /STATS
1050 * @param user the user issuing the /STATS command
1051 * @param results A string_list to append results into. You should put all your results
1052 * into this string_list, rather than displaying them directly, so that your handler will
1053 * work when remote STATS queries are received.
1054 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1056 virtual ModResult OnStats(char symbol, User* user, string_list &results);
1058 /** Called whenever a change of a local users displayed host is attempted.
1059 * Return 1 to deny the host change, or 0 to allow it.
1060 * @param user The user whos host will be changed
1061 * @param newhost The new hostname
1062 * @return 1 to deny the host change, 0 to allow
1064 virtual ModResult OnChangeLocalUserHost(LocalUser* user, const std::string &newhost);
1066 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1067 * return 1 to deny the name change, or 0 to allow it.
1068 * @param user The user whos GECOS will be changed
1069 * @param newhost The new GECOS
1070 * @return 1 to deny the GECOS change, 0 to allow
1072 virtual ModResult OnChangeLocalUserGECOS(LocalUser* user, const std::string &newhost);
1074 /** Called before a topic is changed.
1075 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
1076 * As with other 'pre' events, you should only ever block a local event.
1077 * @param user The user changing the topic
1078 * @param chan The channels who's topic is being changed
1079 * @param topic The actual topic text
1080 * @param 1 to block the topic change, 0 to allow
1082 virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
1084 /** Called whenever a topic has been changed.
1085 * To block topic changes you must use OnPreTopicChange instead.
1086 * @param user The user changing the topic
1087 * @param chan The channels who's topic is being changed
1088 * @param topic The actual topic text
1090 virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
1092 /** Called whenever an Event class is sent to all modules by another module.
1093 * You should *always* check the value of Event::id to determine the event type.
1094 * @param event The Event class being received
1096 virtual void OnEvent(Event& event);
1098 /** Called whenever a Request class is sent to your module by another module.
1099 * The value of Request::id should be used to determine the type of request.
1100 * @param request The Request class being received
1102 virtual void OnRequest(Request& request);
1104 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
1105 * The password field (from the config file) is in 'password' and is to be compared against
1106 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
1107 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
1108 * @param ex The object that's causing the authentication (User* for <oper> <connect:allow> etc, Server* for <link>).
1109 * @param password The password from the configuration file (the password="" value).
1110 * @param input The password entered by the user or whoever.
1111 * @param hashtype The hash value from the config
1112 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
1114 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
1116 /** Called whenever a user is given usermode +o, anywhere on the network.
1117 * You cannot override this and prevent it from happening as it is already happened and
1118 * such a task must be performed by another server. You can however bounce modes by sending
1119 * servermodes out to reverse mode changes.
1120 * @param user The user who is opering
1122 virtual void OnGlobalOper(User* user);
1124 /** Called after a user has fully connected and all modules have executed OnUserConnect
1125 * This event is informational only. You should not change any user information in this
1126 * event. To do so, use the OnUserConnect method to change the state of local users.
1127 * This is called for both local and remote users.
1128 * @param user The user who is connecting
1130 virtual void OnPostConnect(User* user);
1132 /** Called whenever a ban is added to a channel's list.
1133 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1134 * @param source The user adding the ban
1135 * @param channel The channel the ban is being added to
1136 * @param banmask The ban mask being added
1137 * @return 1 to block the ban, 0 to continue as normal
1139 virtual ModResult OnAddBan(User* source, Channel* channel,const std::string &banmask);
1141 /** Called whenever a ban is removed from a channel's list.
1142 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1143 * @param source The user deleting the ban
1144 * @param channel The channel the ban is being deleted from
1145 * @param banmask The ban mask being deleted
1146 * @return 1 to block the unban, 0 to continue as normal
1148 virtual ModResult OnDelBan(User* source, Channel* channel,const std::string &banmask);
1150 /** Called to install an I/O hook on an event handler
1151 * @param user The item to possibly install the I/O hook on
1152 * @param via The port that <user> connected on
1154 virtual void OnHookIO(StreamSocket*, ListenSocket* via);
1156 /** Called when a port accepts a connection
1157 * Return MOD_RES_ACCEPT if you have used the file descriptor.
1158 * @param fd The file descriptor returned from accept()
1159 * @param from The local port the user connected to
1160 * @param client The client IP address and port
1161 * @param server The server IP address and port
1163 virtual ModResult OnAcceptConnection(int fd, ListenSocket* from, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
1165 /** Called immediately after any connection is accepted. This is intended for raw socket
1166 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1167 * no information relating to a user record as the connection has not been assigned yet.
1168 * There are no return values from this call as all modules get an opportunity if required to
1169 * process the connection.
1170 * @param fd The file descriptor returned from accept()
1171 * @param client The client IP address and port
1172 * @param server The server IP address and port
1173 * @param localport The local port number the user connected to
1175 virtual void OnStreamSocketAccept(StreamSocket*, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
1178 * Called when a hooked stream has data to write, or when the socket
1179 * engine returns it as writable
1180 * @param socket The socket in question
1181 * @param sendq Data to send to the socket
1182 * @return 1 if the sendq has been completely emptied, 0 if there is
1183 * still data to send, and -1 if there was an error
1185 virtual int OnStreamSocketWrite(StreamSocket*, std::string& sendq);
1187 /** Called immediately before any socket is closed. When this event is called, shutdown()
1188 * has not yet been called on the socket.
1189 * @param fd The file descriptor of the socket prior to close()
1191 virtual void OnStreamSocketClose(StreamSocket*);
1193 /** Called immediately upon connection of an outbound BufferedSocket which has been hooked
1195 * @param fd The file descriptor of the socket immediately after connect()
1197 virtual void OnStreamSocketConnect(StreamSocket*);
1200 * Called when the stream socket has data to read
1201 * @param socket The socket that is ready
1202 * @param recvq The receive queue that new data should be appended to
1203 * @return 1 if new data has been read, 0 if no new data is ready (but the
1204 * socket is still connected), -1 if there was an error or close
1206 virtual int OnStreamSocketRead(StreamSocket*, std::string& recvq);
1208 /** Called whenever a user sets away or returns from being away.
1209 * The away message is available as a parameter, but should not be modified.
1210 * At this stage, it has already been copied into the user record.
1211 * If awaymsg is empty, the user is returning from away.
1212 * @param user The user setting away
1213 * @param awaymsg The away message of the user, or empty if returning from away
1214 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
1216 virtual ModResult OnSetAway(User* user, const std::string &awaymsg);
1218 /** Called whenever a NAMES list is requested.
1219 * You can produce the nameslist yourself, overriding the current list,
1220 * and if you do you must return 1. If you do not handle the names list,
1222 * @param The user requesting the NAMES list
1223 * @param Ptr The channel the NAMES list is requested for
1225 virtual ModResult OnUserList(User* user, Channel* Ptr);
1227 /** Called whenever a line of WHOIS output is sent to a user.
1228 * You may change the numeric and the text of the output by changing
1229 * the values numeric and text, but you cannot change the user the
1230 * numeric is sent to. You may however change the user's User values.
1231 * @param user The user the numeric is being sent to
1232 * @param dest The user being WHOISed
1233 * @param numeric The numeric of the line being sent
1234 * @param text The text of the numeric, including any parameters
1235 * @return nonzero to drop the line completely so that the user does not
1236 * receive it, or zero to allow the line to be sent.
1238 virtual ModResult OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
1240 /** Called at intervals for modules to garbage-collect any hashes etc.
1241 * Certain data types such as hash_map 'leak' buckets, which must be
1242 * tidied up and freed by copying into a new item every so often. This
1243 * method is called when it is time to do that.
1245 virtual void OnGarbageCollect();
1247 /** Add test suite hooks here. These are used for testing functionality of a module
1248 * via the --testsuite debugging parameter.
1250 virtual void OnRunTestSuite();
1252 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
1253 * For example NAMESX, channel mode +u and +I, and UHNAMES. If the nick is set to an empty string by any
1254 * module, then this will cause the nickname not to be displayed at all.
1256 virtual void OnNamesListItem(User* issuer, Membership* item, std::string &prefixes, std::string &nick);
1258 virtual ModResult OnNumeric(User* user, unsigned int numeric, const std::string &text);
1260 /** Called whenever a result from /WHO is about to be returned
1261 * @param source The user running the /WHO query
1262 * @param user The user that this line of the query is about
1263 * @param channel The channel being queried (or NULL if not a channel query)
1264 * @param line The raw line to send; modifiable, if empty no line will be returned.
1266 virtual void OnSendWhoLine(User* source, User* user, Channel* channel, std::string& line);
1268 /** Called to check whether a channel restriction mode applies to a user on it
1269 * @return MOD_RES_DENY to apply the restriction, MOD_RES_ALLOW to bypass
1270 * the restriction, or MOD_RES_PASSTHRU to check restriction status normally
1272 virtual ModResult OnChannelRestrictionApply(User* user, Channel* chan, const char* restriction);
1276 #define CONF_NO_ERROR 0x000000
1277 #define CONF_NOT_A_NUMBER 0x000010
1278 #define CONF_INT_NEGATIVE 0x000080
1279 #define CONF_VALUE_NOT_FOUND 0x000100
1280 #define CONF_FILE_NOT_FOUND 0x000200
1283 /** Allows reading of values from configuration files
1284 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1285 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1286 * Constructing the class using one parameter allows you to specify a path to your own configuration
1287 * file, otherwise, inspircd.conf is read.
1289 class CoreExport ConfigReader : public interfacebase
1297 /** Default constructor.
1298 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1299 * as specified when running ./configure.
1302 /** Default destructor.
1303 * This method destroys the ConfigReader class.
1307 /** Retrieves a value from the config file.
1308 * This method retrieves a value from the config file. Where multiple copies of the tag
1309 * exist in the config file, index indicates which of the values to retrieve.
1311 std::string ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds = false);
1312 /** Retrieves a value from the config file.
1313 * This method retrieves a 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. If the
1315 * tag is not found the default value is returned instead.
1317 std::string ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds = false);
1319 /** Retrieves a boolean value from the config file.
1320 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1321 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1322 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1324 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1325 /** Retrieves a boolean value from the config file.
1326 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1327 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1328 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1329 * If the tag is not found, the default value is used instead.
1331 bool ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index);
1333 /** Retrieves an integer value from the config file.
1334 * This method retrieves an integer 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. Any invalid integer
1336 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1337 * return CONF_INVALID_NUMBER to be returned. need_positive is set if the number must be non-negative.
1338 * If a negative number is placed into a tag which is specified positive, 0 will be returned and GetError()
1339 * will return CONF_INT_NEGATIVE. Note that need_positive is not suitable to get an unsigned int - you
1340 * should cast the result to achieve that effect.
1342 int ReadInteger(const std::string &tag, const std::string &name, int index, bool need_positive);
1343 /** Retrieves an integer value from the config file.
1344 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1345 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1346 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1347 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1348 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1349 * will return CONF_NOT_UNSIGNED. If the tag is not found, the default value is used instead.
1351 int ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool need_positive);
1353 /** Returns the last error to occur.
1354 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1355 * A call to GetError() resets the error flag back to 0.
1359 /** Counts the number of times a given tag appears in the config file.
1360 * This method counts the number of times a tag appears in a config file, for use where
1361 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1362 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1363 * multiple instance tag.
1365 int Enumerate(const std::string &tag);
1370 /** Caches a text file into memory and can be used to retrieve lines from it.
1371 * This class contains methods for read-only manipulation of a text file in memory.
1372 * Either use the constructor type with one parameter to load a file into memory
1373 * at construction, or use the LoadFile method to load a file.
1375 class CoreExport FileReader : public classbase
1377 /** The file contents
1379 std::vector<std::string> fc;
1381 /** Content size in bytes
1383 unsigned long contentsize;
1385 /** Calculate content size in bytes
1390 /** Default constructor.
1391 * This method does not load any file into memory, you must use the LoadFile method
1392 * after constructing the class this way.
1396 /** Secondary constructor.
1397 * This method initialises the class with a file loaded into it ready for GetLine and
1398 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1401 FileReader(const std::string &filename);
1403 /** Default destructor.
1404 * This deletes the memory allocated to the file.
1408 /** Used to load a file.
1409 * This method loads a file into the class ready for GetLine and
1410 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1413 void LoadFile(const std::string &filename);
1415 /** Returns the whole content of the file as std::string
1417 std::string Contents();
1419 /** Returns the entire size of the file as std::string
1421 unsigned long ContentSize();
1423 /** Returns true if the file exists
1424 * This function will return false if the file could not be opened.
1428 /** Retrieve one line from the file.
1429 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1430 * the index was out of bounds, or the line had no data on it.
1432 std::string GetLine(int x);
1434 /** Returns the size of the file in lines.
1435 * This method returns the number of lines in the read file. If it is 0, no lines have been
1436 * read into memory, either because the file is empty or it does not exist, or cannot be
1437 * opened due to permission problems.
1442 /** A list of modules
1444 typedef std::vector<Module*> IntModuleList;
1446 /** An event handler iterator
1448 typedef IntModuleList::iterator EventHandlerIter;
1450 /** ModuleManager takes care of all things module-related
1453 class CoreExport ModuleManager
1456 /** Holds a string describing the last module error to occur
1458 std::string LastModuleError;
1460 /** Total number of modules loaded into the ircd
1464 /** List of loaded modules and shared object/dll handles
1465 * keyed by module name
1467 std::map<std::string, Module*> Modules;
1473 } prioritizationState;
1475 /** Internal unload module hook */
1476 bool CanUnload(Module*);
1479 /** Event handler hooks.
1480 * This needs to be public to be used by FOREACH_MOD and friends.
1482 IntModuleList EventHandlers[I_END];
1484 /** List of data services keyed by name */
1485 std::multimap<std::string, ServiceProvider*> DataProviders;
1487 /** List of all dynamic references that are currently active */
1488 std::vector<dynamic_reference_base*> ActiveDynrefs;
1490 /** Simple, bog-standard, boring constructor.
1498 /** Change the priority of one event in a module.
1499 * Each module event has a list of modules which are attached to that event type.
1500 * If you wish to be called before or after other specific modules, you may use this
1501 * method (usually within void Module::Prioritize()) to set your events priority.
1502 * You may use this call in other methods too, however, this is not supported behaviour
1504 * @param mod The module to change the priority of
1505 * @param i The event to change the priority of
1506 * @param s The state you wish to use for this event. Use one of
1507 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1508 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1509 * to set it to be before or after one or more other modules.
1510 * @param modules If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1511 * then this contains a list of one or more modules your module must be
1512 * placed before or after. Your module will be placed before the highest
1513 * priority module in this list for PRIO_BEFORE, or after the lowest
1514 * priority module in this list for PRIORITY_AFTER.
1515 * @param sz The number of modules being passed for PRIO_BEFORE and PRIORITY_AFTER.
1516 * Defaults to 1, as most of the time you will only want to prioritize your module
1517 * to be before or after one other module.
1519 bool SetPriority(Module* mod, Implementation i, Priority s, Module** modules = NULL, size_t sz = 1);
1521 /** Change the priority of all events in a module.
1522 * @param mod The module to set the priority of
1523 * @param s The priority of all events in the module.
1524 * Note that with this method, it is not possible to effectively use
1525 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1526 * SetPriority method for this, where you may specify other modules to
1527 * be prioritized against.
1529 bool SetPriority(Module* mod, Priority s);
1531 /** Attach an event to a module.
1532 * You may later detatch the event with ModuleManager::Detach().
1533 * If your module is unloaded, all events are automatically detatched.
1534 * @param i Event type to attach
1535 * @param mod Module to attach event to
1536 * @return True if the event was attached
1538 bool Attach(Implementation i, Module* mod);
1540 /** Detatch an event from a module.
1541 * This is not required when your module unloads, as the core will
1542 * automatically detatch your module from all events it is attached to.
1543 * @param i Event type to detach
1544 * @param mod Module to detach event from
1545 * @param Detach true if the event was detached
1547 bool Detach(Implementation i, Module* mod);
1549 /** Attach an array of events to a module
1550 * @param i Event types (array) to attach
1551 * @param mod Module to attach events to
1553 void Attach(Implementation* i, Module* mod, size_t sz);
1555 /** Detach all events from a module (used on unload)
1556 * @param mod Module to detach from
1558 void DetachAll(Module* mod);
1560 /** Returns text describing the last module error
1561 * @return The last error message to occur
1563 std::string& LastError();
1565 /** Load a given module file
1566 * @param filename The file to load
1567 * @return True if the module was found and loaded
1569 bool Load(const char* filename);
1571 /** Unload a given module file. Note that the module will not be
1572 * completely gone until the cull list has finished processing.
1574 * @return true on success; if false, LastError will give a reason
1576 bool Unload(Module* module);
1578 /** Run an asynchronous reload of the given module. When the reload is
1579 * complete, the callback will be run with true if the reload succeeded
1580 * and false if it did not.
1582 void Reload(Module* module, HandlerBase1<void, bool>* callback);
1584 /** Called by the InspIRCd constructor to load all modules from the config file.
1588 void DoSafeUnload(Module*);
1590 /** Get the total number of currently loaded modules
1591 * @return The number of loaded modules
1595 return this->ModCount;
1598 /** Find a module by name, and return a Module* to it.
1599 * This is preferred over iterating the module lists yourself.
1600 * @param name The module name to look up
1601 * @return A pointer to the module, or NULL if the module cannot be found
1603 Module* Find(const std::string &name);
1605 /** Register a service provided by a module */
1606 void AddService(ServiceProvider&);
1608 inline void AddServices(ServiceProvider** list, int count)
1610 for(int i=0; i < count; i++)
1611 AddService(*list[i]);
1614 /** Find a service by name.
1615 * If multiple modules provide a given service, the first one loaded will be chosen.
1617 ServiceProvider* FindService(ServiceType Type, const std::string& name);
1619 template<typename T> inline T* FindDataService(const std::string& name)
1621 return static_cast<T*>(FindService(SERVICE_DATA, name));
1624 /** Return a list of all modules matching the given filter
1625 * @param filter This int is a bitmask of flags set in Module::Flags,
1626 * such as VF_VENDOR or VF_STATIC. If you wish to receive a list of
1627 * all modules with no filtering, set this to 0.
1628 * @return The list of module names
1630 const std::vector<std::string> GetAllModuleNames(int filter);
1633 /** Do not mess with these functions unless you know the C preprocessor
1634 * well enough to explain why they are needed. The order is important.
1636 #define MODULE_INIT_STR MODULE_INIT_STR_FN_2(MODULE_INIT_SYM)
1637 #define MODULE_INIT_STR_FN_2(x) MODULE_INIT_STR_FN_1(x)
1638 #define MODULE_INIT_STR_FN_1(x) #x
1639 #define MODULE_INIT_SYM MODULE_INIT_SYM_FN_2(API_VERSION)
1640 #define MODULE_INIT_SYM_FN_2(x) MODULE_INIT_SYM_FN_1(x)
1641 #define MODULE_INIT_SYM_FN_1(x) inspircd_module_ ## x
1645 struct AllCommandList {
1646 typedef Command* (*fn)(Module*);
1647 AllCommandList(fn cmd);
1649 #define COMMAND_INIT(x) static Command* MK_ ## x(Module* m) { return new x(m); } \
1650 static const AllCommandList PREP_ ## x(&MK_ ## x);
1652 struct AllModuleList {
1653 typedef Module* (*fn)();
1656 AllModuleList(fn mod, const std::string& Name);
1659 #define MODULE_INIT(x) static Module* MK_ ## x() { return new x; } \
1660 static const AllModuleList PREP_ ## x(&MK_ ## x, #x);
1665 /** This definition is used as shorthand for the various classes
1666 * and functions needed to make a module loadable by the OS.
1667 * It defines the class factory and external init_module function.
1671 #define MODULE_INIT(y) \
1672 extern "C" DllExport Module * MODULE_INIT_SYM() \
1676 BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
1678 switch ( nReason ) \
1680 case DLL_PROCESS_ATTACH: \
1681 case DLL_PROCESS_DETACH: \
1689 #define MODULE_INIT(y) \
1690 extern "C" DllExport Module * MODULE_INIT_SYM() \
1696 #define COMMAND_INIT(c) MODULE_INIT(CommandModule<c>)