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