1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
20 #include "inspsocket.h"
30 /** Used to define a set of behavior bits for a module
33 VF_NONE = 0, // module is not special at all
34 VF_STATIC = 1, // module is static, cannot be /unloadmodule'd
35 VF_VENDOR = 2, // module is a vendor module (came in the original tarball, not 3rd party)
36 VF_COMMON = 4, // module needs to be common on all servers in a network to link
37 VF_OPTCOMMON = 8, // module should be common on all servers for unsurprising behavior
38 VF_CORE = 16 // module is a core command, can be assumed loaded on all servers
41 /** Used with SendToMode()
48 /** Used to represent an event type, for user, channel or server
50 enum TargetTypeFlags {
57 /** Used to represent wether a message was PRIVMSG or NOTICE
64 #define MOD_RES_ALLOW (ModResult(1))
65 #define MOD_RES_PASSTHRU (ModResult(0))
66 #define MOD_RES_DENY (ModResult(-1))
68 /** Used to represent an allow/deny module result.
69 * Not constructed as an enum because it reverses the value logic of some functions;
70 * the compiler will inline accesses to have the same efficiency as integer operations.
74 ModResult() : res(0) {}
75 explicit ModResult(int r) : res(r) {}
76 inline bool operator==(const ModResult& r) const
80 inline bool operator!=(const ModResult& r) const
84 inline bool operator!() const
88 inline bool check(bool def) const
90 return (res == 1 || (res == 0 && def));
93 * Merges two results, preferring ALLOW to DENY
95 inline ModResult operator+(const ModResult& r) const
97 if (res == r.res || r.res == 0)
101 // they are different, and neither is passthru
102 return MOD_RES_ALLOW;
106 /** If you change the module API in any way, increment this value.
107 * This MUST be a pure integer, with no parenthesis
109 #define API_VERSION 135
113 /* Forward-delacare module for ModuleMessage etc
118 /** A set of strings.
120 typedef std::vector<std::string> string_list;
122 /** Holds a list of 'published features' for modules.
124 typedef std::map<std::string,Module*> featurelist;
126 /** Holds a list of modules which implement an interface
128 typedef std::deque<Module*> modulelist;
130 /** Holds a list of all modules which implement interfaces, by interface name
132 typedef std::map<std::string, std::pair<int, modulelist> > interfacelist;
135 * This #define allows us to call a method in all
136 * loaded modules in a readable simple way, e.g.:
137 * 'FOREACH_MOD(I_OnConnect,OnConnect(user));'
139 #define FOREACH_MOD(y,x) do { \
140 EventHandlerIter safei; \
141 for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ) \
149 catch (CoreException& modexcept) \
151 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
158 * Custom module result handling loop. This is a paired macro, and should only
159 * be used with while_each_hook.
161 * See src/channels.cpp for an example of use.
163 #define DO_EACH_HOOK(n,v,args) \
165 EventHandlerIter iter_ ## n = ServerInstance->Modules->EventHandlers[I_ ## n].begin(); \
166 while (iter_ ## n != ServerInstance->Modules->EventHandlers[I_ ## n].end()) \
168 Module* mod_ ## n = *iter_ ## n; \
172 v = (mod_ ## n)->n args;
174 #define WHILE_EACH_HOOK(n) \
176 catch (CoreException& except_ ## n) \
178 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s", (except_ ## n).GetReason()); \
179 (void) mod_ ## n; /* catch mismatched pairs */ \
185 * Module result iterator
186 * Runs the given hook until some module returns a useful result.
188 * Example: ModResult result;
189 * FIRST_MOD_RESULT(OnUserPreNick, result, (user, newnick))
191 #define FIRST_MOD_RESULT(n,v,args) do { \
192 v = MOD_RES_PASSTHRU; \
193 DO_EACH_HOOK(n,v,args) \
195 if (v != MOD_RES_PASSTHRU) \
198 WHILE_EACH_HOOK(n); \
201 /** Represents a non-local user.
202 * (in fact, any FD less than -1 does)
204 #define FD_MAGIC_NUMBER -42
205 /** Represents a fake user (i.e. a server)
207 #define FD_FAKEUSER_NUMBER -7
211 /** Is a local user */
212 #define IS_LOCAL(x) (x->GetFd() > -1)
213 /** Is a remote user */
214 #define IS_REMOTE(x) (x->GetFd() < 0)
215 /** Is a fake user */
216 #define IS_SERVER(x) (x->GetFd() == FD_FAKEUSER_NUMBER)
217 /** Is a module created user */
218 #define IS_MODULE_CREATED(x) (x->GetFd() == FD_MAGIC_NUMBER)
220 #define IS_OPER(x) (!x->oper.empty())
222 #define IS_AWAY(x) (!x->awaymsg.empty())
224 /** Holds a module's Version information.
225 * The members (set by the constructor only) indicate details as to the version number
226 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
228 * The core provides only one implementation of the template, causing a run-time linking
229 * error when attempting to load a module compiled against a different API_VERSION.
232 class CoreExport VersionBase
235 /** Module description
237 const std::string description;
238 /** Version information.
240 const std::string version;
246 /** Initialize version class
248 VersionBase(const std::string &desc, int flags = VF_NONE, const std::string& src_rev = VERSION " r" REVISION);
251 typedef VersionBase<API_VERSION> Version;
253 /** The Request class is a unicast message directed at a given module.
254 * When this class is properly instantiated it may be sent to a module
255 * using the Send() method, which will call the given module's OnRequest
256 * method with this class as its parameter.
258 class CoreExport Request : public classbase
261 /** This should be a null-terminated string identifying the type of request,
262 * all modules should define this and use it to determine the nature of the
263 * request before they attempt to cast the Request in any way.
265 const char* const id;
266 /** This is a pointer to the sender of the message, which can be used to
267 * directly trigger events, or to create a reply.
269 Module* const source;
270 /** The single destination of the Request
274 /** Create a new Request
275 * This is for the 'new' way of defining a subclass
276 * of Request and defining it in a common header,
277 * passing an object of your Request subclass through
278 * as a Request* and using the ID string to determine
279 * what to cast it back to and the other end.
281 Request(Module* src, Module* dst, const char* idstr);
282 /** Send the Request.
288 /** The Event class is a unicast message directed at all modules.
289 * When the class is properly instantiated it may be sent to all modules
290 * using the Send() method, which will trigger the OnEvent method in
291 * all modules passing the object as its parameter.
293 class CoreExport Event : public classbase
296 /** This is a pointer to the sender of the message, which can be used to
297 * directly trigger events, or to create a reply.
299 Module* const source;
300 /** The event identifier.
301 * This is arbitary text which should be used to distinguish
302 * one type of event from another.
304 const std::string id;
306 /** Create a new Event
308 Event(Module* src, const std::string &eventid);
310 * The return result of an Event::Send() will always be NULL as
311 * no replies are expected.
316 /** Priority types which can be used by Module::Prioritize()
318 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
320 /** Implementation-specific flags which may be set in Module::Implements()
325 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash,
326 I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois,
327 I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick,
328 I_OnUserMessage, I_OnUserNotice, I_OnMode, I_OnGetServerDescription, I_OnSyncUser,
329 I_OnSyncChannel, I_OnDecodeMetaData, I_OnWallops,
330 I_OnChangeHost, I_OnChangeName, I_OnAddLine, I_OnDelLine, I_OnExpireLine,
331 I_OnUserPostNick, I_OnPreMode, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule,
332 I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite,
333 I_OnRawMode, I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckChannelBan, I_OnExtBanCheck,
334 I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnPreTopicChange,
335 I_OnPostTopicChange, I_OnEvent, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan,
336 I_OnDelBan, I_OnChangeLocalUserGECOS, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
337 I_OnPostOper, I_OnSyncNetwork, I_OnSetAway, I_OnUserList, I_OnPostCommand, I_OnPostJoin,
338 I_OnWhoisLine, I_OnBuildNeighborList, I_OnGarbageCollect,
339 I_OnText, I_OnPassCompare, I_OnRunTestSuite, I_OnNamesListItem, I_OnNumeric, I_OnHookIO,
340 I_OnPreRehash, I_OnModuleRehash, I_OnSendWhoLine, I_OnChangeIdent, I_OnChannelRestrictionApply,
346 /** Base class for all InspIRCd modules
347 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
348 * its methods will be called when irc server events occur. class inherited from module must be
349 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
351 class CoreExport Module : public classbase
354 /** File that this module was loaded from
356 std::string ModuleSourceFile;
357 /** Reference to the dlopen() value
359 DLLManager* ModuleDLLManager;
361 /** Default constructor.
362 * Creates a module class.
363 * @param Me An instance of the InspIRCd class which will be saved into ServerInstance for your use
364 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
368 /** Clean up prior to destruction
369 * If you override, you must call this AFTER your module's cleanup
371 virtual CullResult cull();
373 /** Default destructor.
374 * destroys a module class
378 virtual void Prioritize()
382 /** Returns the version number of a Module.
383 * The method should return a Version object with its version information assigned via
386 virtual Version GetVersion() = 0;
388 /** Called when a user connects.
389 * The details of the connecting user are available to you in the parameter User *user
390 * @param user The user who is connecting
392 virtual void OnUserConnect(User* user);
394 /** Called when a user quits.
395 * The details of the exiting user are available to you in the parameter User *user
396 * This event is only called when the user is fully registered when they quit. To catch
397 * raw disconnections, use the OnUserDisconnect method.
398 * @param user The user who is quitting
399 * @param message The user's quit message (as seen by non-opers)
400 * @param oper_message The user's quit message (as seen by opers)
402 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
404 /** Called whenever a user's socket is closed.
405 * The details of the exiting user are available to you in the parameter User *user
406 * This event is called for all users, registered or not, as a cleanup method for modules
407 * which might assign resources to user, such as dns lookups, objects and sockets.
408 * @param user The user who is disconnecting
410 virtual void OnUserDisconnect(User* user);
412 /** Called whenever a channel is about to be deleted
413 * @param chan The channel being deleted
414 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
416 virtual ModResult OnChannelPreDelete(Channel *chan);
418 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
419 * @param chan The channel being deleted
421 virtual void OnChannelDelete(Channel* chan);
423 /** Called when a user joins a channel.
424 * The details of the joining user are available to you in the parameter User *user,
425 * and the details of the channel they have joined is available in the variable Channel *channel
426 * @param memb The channel membership being created
427 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
428 * to a channel due to the network sync.
429 * @param created This is true if the join created the channel
431 virtual void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list);
433 /** Called after a user joins a channel
434 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
436 * @param memb The channel membership created
438 virtual void OnPostJoin(Membership*);
440 /** Called when a user parts a channel.
441 * The details of the leaving user are available to you in the parameter User *user,
442 * and the details of the channel they have left is available in the variable Channel *channel
443 * @param memb The channel membership being destroyed
444 * @param partmessage The part message, or an empty string (may be modified)
446 virtual void OnUserPart(Membership* memb, std::string &partmessage, CUList& except_list);
448 /** Called on rehash.
449 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
450 * system. This is called in all cases -- including when this server will not execute the
451 * rehash because it is directed at a remote server.
453 * @param user The user performing the rehash, if any. If this is server initiated, the value of
454 * this variable will be NULL.
455 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
458 virtual void OnPreRehash(User* user, const std::string ¶meter);
460 /** Called on rehash.
461 * This method is called when a user initiates a module-specific rehash. This can be used to do
462 * expensive operations (such as reloading SSL certificates) that are not executed on a normal
463 * rehash for efficiency. A rehash of this type does not reload the core configuration.
465 * @param user The user performing the rehash.
466 * @param parameter The parameter given to REHASH
468 virtual void OnModuleRehash(User* user, const std::string ¶meter);
470 /** Called on rehash.
471 * This method is called after a rehash has completed. You should use it to reload any module
472 * configuration from the main configuration file.
473 * @param user The user that performed the rehash, if it was initiated by a user and that user
474 * is still connected.
476 virtual void OnRehash(User* user);
478 /** Called whenever a snotice is about to be sent to a snomask.
479 * snomask and type may both be modified; the message may not.
480 * @param snomask The snomask the message is going to (e.g. 'A')
481 * @param type The textual description the snomask will go to (e.g. 'OPER')
482 * @param message The text message to be sent via snotice
483 * @return 1 to block the snotice from being sent entirely, 0 else.
485 virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
487 /** Called whenever a user is about to join a channel, before any processing is done.
488 * Returning a value of 1 from this function stops the process immediately, causing no
489 * output to be sent to the user by the core. If you do this you must produce your own numerics,
490 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
491 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
495 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
496 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
497 * processing on the actual channel record at this point, however the channel NAME will still be passed in
498 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
499 * @param user The user joining the channel
500 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
501 * @param cname The channel name being joined. For new channels this is valid where chan is not.
502 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "o".
503 * You may alter this string to alter the user's modes on the channel.
504 * @param keygiven The key given to join the channel, or an empty string if none was provided
505 * @return 1 To prevent the join, 0 to allow it.
507 virtual ModResult OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string &privs, const std::string &keygiven);
509 /** Called whenever a user is about to be kicked.
510 * Returning a value of 1 from this function stops the process immediately, causing no
511 * output to be sent to the user by the core. If you do this you must produce your own numerics,
513 * @param source The user issuing the kick
514 * @param user The user being kicked
515 * @param chan The channel the user is being kicked from
516 * @param reason The kick reason
517 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
519 virtual ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason);
521 /** Called whenever a user is kicked.
522 * If this method is called, the kick is already underway and cannot be prevented, so
523 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
524 * @param source The user issuing the kick
525 * @param user The user being kicked
526 * @param chan The channel the user is being kicked from
527 * @param reason The kick reason
529 virtual void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except_list);
531 /** Called whenever a user opers locally.
532 * The User will contain the oper mode 'o' as this function is called after any modifications
533 * are made to the user's structure by the core.
534 * @param user The user who is opering up
535 * @param opertype The opers type name
537 virtual void OnOper(User* user, const std::string &opertype);
539 /** Called after a user opers locally.
540 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
541 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
542 * out the OPERTYPE, etc.
543 * @param user The user who is opering up
544 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
545 * @param opertype The opers type name
547 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
549 /** Called whenever a user types /INFO.
550 * The User will contain the information of the user who typed the command. Modules may use this
551 * method to output their own credits in /INFO (which is the ircd's version of an about box).
552 * It is purposefully not possible to modify any info that has already been output, or halt the list.
553 * You must write a 371 numeric to the user, containing your info in the following format:
555 * <nick> :information here
557 * @param user The user issuing /INFO
559 virtual void OnInfo(User* user);
561 /** Called whenever a /WHOIS is performed on a local user.
562 * The source parameter contains the details of the user who issued the WHOIS command, and
563 * the dest parameter contains the information of the user they are whoising.
564 * @param source The user issuing the WHOIS command
565 * @param dest The user who is being WHOISed
567 virtual void OnWhois(User* source, User* dest);
569 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
570 * Returning 1 from this function stops the process immediately, causing no
571 * output to be sent to the user by the core. If you do this you must produce your own numerics,
572 * notices etc. This is useful for modules which may want to filter invites to channels.
573 * @param source The user who is issuing the INVITE
574 * @param dest The user being invited
575 * @param channel The channel the user is being invited to
576 * @param timeout The time the invite will expire (0 == never)
577 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
579 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
581 /** Called after a user has been successfully invited to a channel.
582 * You cannot prevent the invite from occuring using this function, to do that,
583 * use OnUserPreInvite instead.
584 * @param source The user who is issuing the INVITE
585 * @param dest The user being invited
586 * @param channel The channel the user is being invited to
587 * @param timeout The time the invite will expire (0 == never)
589 virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout);
591 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
592 * Returning any nonzero value from this function stops the process immediately, causing no
593 * output to be sent to the user by the core. If you do this you must produce your own numerics,
594 * notices etc. This is useful for modules which may want to filter or redirect messages.
595 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
596 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
597 * of where the message is destined to be sent.
598 * @param user The user sending the message
599 * @param dest The target of the message (Channel* or User*)
600 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
601 * @param text Changeable text being sent by the user
602 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
603 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
604 * It will be ignored for private messages.
605 * @return 1 to deny the message, 0 to allow it
607 virtual ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
609 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
610 * Returning any nonzero value from this function stops the process immediately, causing no
611 * output to be sent to the user by the core. If you do this you must produce your own numerics,
612 * notices etc. This is useful for modules which may want to filter or redirect messages.
613 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
614 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
615 * of where the message is destined to be sent.
616 * You may alter the message text as you wish before relinquishing control to the next module
617 * in the chain, and if no other modules block the text this altered form of the text will be sent out
618 * to the user and possibly to other servers.
619 * @param user The user sending the message
620 * @param dest The target of the message (Channel* or User*)
621 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
622 * @param text Changeable text being sent by the user
623 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
624 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
625 * It will be ignored for private notices.
626 * @return 1 to deny the NOTICE, 0 to allow it
628 virtual ModResult OnUserPreNotice(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
630 /** Called when sending a message to all "neighbors" of a given user -
631 * that is, all users that share a common channel. This is used in
632 * commands such as NICK, QUIT, etc.
633 * @param source The source of the message
634 * @param include_c Channels to scan for users to include
635 * @param exceptions Map of user->bool that overrides the inclusion decision
637 * Set exceptions[user] = true to include, exceptions[user] = false to exclude
639 virtual void OnBuildNeighborList(User* source, UserChanList &include_c, std::map<User*,bool> &exceptions);
641 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
642 * Please note that although you can see remote nickchanges through this function, you should
643 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
644 * check user->server before taking any action (including returning nonzero from the method).
645 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
646 * module to generate some meaninful output.
647 * @param user The username changing their nick
648 * @param newnick Their new nickname
649 * @return 1 to deny the change, 0 to allow
651 virtual ModResult OnUserPreNick(User* user, const std::string &newnick);
653 /** Called after any PRIVMSG sent from a user.
654 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
655 * if target_type is TYPE_CHANNEL.
656 * @param user The user sending the message
657 * @param dest The target of the message
658 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
659 * @param text the text being sent by the user
660 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
662 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
664 /** Called after any NOTICE sent from a user.
665 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
666 * if target_type is TYPE_CHANNEL.
667 * @param user The user sending the message
668 * @param dest The target of the message
669 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
670 * @param text the text being sent by the user
671 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
673 virtual void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
675 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
676 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
677 * if target_type is TYPE_CHANNEL.
678 * The difference between this event and OnUserPreNotice/OnUserPreMessage is that delivery is gauranteed,
679 * the message has already been vetted. In the case of the other two methods, a later module may stop your
680 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
681 * @param user The user sending the message
682 * @param dest The target of the message
683 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
684 * @param text the text being sent by the user
685 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
687 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
689 /** Called after every MODE command sent from a user
690 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
691 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
692 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
693 * @param user The user sending the MODEs
694 * @param dest The target of the modes (User* or Channel*)
695 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
696 * @param text The actual modes and their parameters if any
697 * @param translate The translation types of the mode parameters
699 virtual void OnMode(User* user, void* dest, int target_type, const std::vector<std::string> &text, const std::vector<TranslateType> &translate);
701 /** Allows modules to alter or create server descriptions
702 * Whenever a module requires a server description, for example for display in
703 * WHOIS, this function is called in all modules. You may change or define the
704 * description given in std::string &description. If you do, this description
705 * will be shown in the WHOIS fields.
706 * @param servername The servername being searched for
707 * @param description Alterable server description for this server
709 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
711 /** Allows modules to synchronize data which relates to users during a netburst.
712 * When this function is called, it will be called from the module which implements
713 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
714 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
715 * (see below). This function will be called for every user visible on your side
716 * of the burst, allowing you to for example set modes, etc. Do not use this call to
717 * synchronize data which you have stored using class Extensible -- There is a specialist
718 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
719 * @param user The user being syncronized
720 * @param proto A pointer to the module handling network protocol
721 * @param opaque An opaque pointer set by the protocol module, should not be modified!
723 virtual void OnSyncUser(User* user, Module* proto, void* opaque);
725 /** Allows modules to synchronize data which relates to channels during a netburst.
726 * When this function is called, it will be called from the module which implements
727 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
728 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
729 * (see below). This function will be called for every user visible on your side
730 * of the burst, allowing you to for example set modes, etc.
732 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
734 * @param chan The channel being syncronized
735 * @param proto A pointer to the module handling network protocol
736 * @param opaque An opaque pointer set by the protocol module, should not be modified!
738 virtual void OnSyncChannel(Channel* chan, Module* proto, void* opaque);
740 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
741 * Whenever the linking module wants to send out data, but doesnt know what the data
742 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
743 * this method is called. You should use the ProtoSendMetaData function after you've
744 * correctly decided how the data should be represented, to send the metadata on its way if
745 * if it belongs to your module.
746 * @param proto A pointer to the module handling network protocol
747 * @param opaque An opaque pointer set by the protocol module, should not be modified!
748 * @param displayable If this value is true, the data is going to be displayed to a user,
749 * and not sent across the network. Use this to determine wether or not to show sensitive data.
751 virtual void OnSyncNetwork(Module* proto, void* opaque);
753 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
754 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
755 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
756 * @param target The Channel* or User* that data should be added to
757 * @param extname The extension name which is being sent
758 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
760 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
762 /** Implemented by modules which provide the ability to link servers.
763 * These modules will implement this method, which allows transparent sending of servermodes
764 * down the network link as a broadcast, without a module calling it having to know the format
765 * of the MODE command before the actual mode string.
767 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
768 * of how to use this function.
770 * @param opaque An opaque pointer set by the protocol module, should not be modified!
771 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
772 * @param target The Channel* or User* that modes should be sent for
773 * @param modeline The modes and parameters to be sent
774 * @param translate The translation types of the mode parameters
776 virtual void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::vector<std::string> &modeline, const std::vector<TranslateType> &translate);
778 /** Implemented by modules which provide the ability to link servers.
779 * These modules will implement this method, which allows metadata (extra data added to
780 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
781 * to other servers on a netburst and decoded at the other end by the same module on a
784 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
785 * how to use this function.
786 * @param opaque An opaque pointer set by the protocol module, should not be modified!
787 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
788 * @param target The Channel* or User* that metadata should be sent for
789 * @param extname The extension name to send metadata for
790 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
792 virtual void ProtoSendMetaData(void* opaque, Extensible* target, const std::string &extname, const std::string &extdata);
794 /** Called after every WALLOPS command.
795 * @param user The user sending the WALLOPS
796 * @param text The content of the WALLOPS message
798 virtual void OnWallops(User* user, const std::string &text);
800 /** Called whenever a user's hostname is changed.
801 * This event triggers after the host has been set.
802 * @param user The user whos host is being changed
803 * @param newhost The new hostname being set
805 virtual void OnChangeHost(User* user, const std::string &newhost);
807 /** Called whenever a user's GECOS (realname) is changed.
808 * This event triggers after the name has been set.
809 * @param user The user who's GECOS is being changed
810 * @param gecos The new GECOS being set on the user
812 virtual void OnChangeName(User* user, const std::string &gecos);
814 /** Called whenever a user's IDENT is changed.
815 * This event triggers after the name has been set.
816 * @param user The user who's IDENT is being changed
817 * @param gecos The new IDENT being set on the user
819 virtual void OnChangeIdent(User* user, const std::string &ident);
821 /** Called whenever an xline is added by a local user.
822 * This method is triggered after the line is added.
823 * @param source The sender of the line or NULL for local server
824 * @param line The xline being added
826 virtual void OnAddLine(User* source, XLine* line);
828 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
829 * This method is triggered after the line is deleted.
830 * @param source The user removing the line or NULL for local server
831 * @param line the line being deleted
833 virtual void OnDelLine(User* source, XLine* line);
835 /** Called whenever an xline expires.
836 * This method is triggered after the line is deleted.
837 * @param line The line being deleted.
839 virtual void OnExpireLine(XLine *line);
841 /** Called before your module is unloaded to clean up Extensibles.
842 * This method is called once for every user and channel on the network,
843 * so that when your module unloads it may clear up any remaining data
844 * in the form of Extensibles added using Extensible::Extend().
845 * If the target_type variable is TYPE_USER, then void* item refers to
846 * a User*, otherwise it refers to a Channel*.
847 * @param target_type The type of item being cleaned
848 * @param item A pointer to the item's class
850 virtual void OnCleanup(int target_type, void* item);
852 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
853 * have been applied. Please note that although you can see remote nickchanges through this function, you should
854 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
855 * check user->server before taking any action (including returning nonzero from the method).
856 * Because this method is called after the nickchange is taken place, no return values are possible
857 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
858 * @param user The user changing their nick
859 * @param oldnick The old nickname of the user before the nickchange
861 virtual void OnUserPostNick(User* user, const std::string &oldnick);
863 /** Called before any mode change, to allow a single access check for
864 * a full mode change (use OnRawMode to check individual modes)
866 * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
867 * OnRawMode for each individual mode
869 * @param source the user making the mode change
870 * @param dest the user destination of the umode change (NULL if a channel mode)
871 * @param channel the channel destination of the mode change
872 * @param parameters raw mode parameters; parameters[0] is the user/channel being changed
874 virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, const std::vector<std::string>& parameters);
876 /** Called when a 005 numeric is about to be output.
877 * The module should modify the 005 numeric if needed to indicate its features.
878 * @param output The 005 string to be modified if neccessary.
880 virtual void On005Numeric(std::string &output);
882 /** Called when a client is disconnected by KILL.
883 * If a client is killed by a server, e.g. a nickname collision or protocol error,
885 * Return 1 from this function to prevent the kill, and 0 from this function to allow
886 * it as normal. If you prevent the kill no output will be sent to the client, it is
887 * down to your module to generate this information.
888 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
889 * If you do so youre risking race conditions, desyncs and worse!
890 * @param source The user sending the KILL
891 * @param dest The user being killed
892 * @param reason The kill reason
893 * @return 1 to prevent the kill, 0 to allow
895 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
897 /** Called when an oper wants to disconnect a remote user via KILL
898 * @param source The user sending the KILL
899 * @param dest The user being killed
900 * @param reason The kill reason
902 virtual void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
904 /** Called whenever a module is loaded.
905 * mod will contain a pointer to the module, and string will contain its name,
906 * for example m_widgets.so. This function is primary for dependency checking,
907 * your module may decide to enable some extra features if it sees that you have
908 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
909 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
910 * but instead operate under reduced functionality, unless the dependency is
911 * absolutely neccessary (e.g. a module that extends the features of another
913 * @param mod A pointer to the new module
915 virtual void OnLoadModule(Module* mod);
917 /** Called whenever a module is unloaded.
918 * mod will contain a pointer to the module, and string will contain its name,
919 * for example m_widgets.so. This function is primary for dependency checking,
920 * your module may decide to enable some extra features if it sees that you have
921 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
922 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
923 * but instead operate under reduced functionality, unless the dependency is
924 * absolutely neccessary (e.g. a module that extends the features of another
926 * @param mod Pointer to the module being unloaded (still valid)
927 * @param name The filename of the module being unloaded
929 virtual void OnUnloadModule(Module* mod);
931 /** Called once every five seconds for background processing.
932 * This timer can be used to control timed features. Its period is not accurate
933 * enough to be used as a clock, but it is gauranteed to be called at least once in
934 * any five second period, directly from the main loop of the server.
935 * @param curtime The current timer derived from time(2)
937 virtual void OnBackgroundTimer(time_t curtime);
939 /** Called whenever any command is about to be executed.
940 * This event occurs for all registered commands, wether they are registered in the core,
941 * or another module, and for invalid commands. Invalid commands may only be sent to this
942 * function when the value of validated is false. By returning 1 from this method you may prevent the
943 * command being executed. If you do this, no output is created by the core, and it is
944 * down to your module to produce any output neccessary.
945 * Note that unless you return 1, you should not destroy any structures (e.g. by using
946 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
947 * method returns, it will be passed an invalid pointer to the user object and crash!)
948 * @param command The command being executed
949 * @param parameters An array of array of characters containing the parameters for the command
950 * @param pcnt The nuimber of parameters passed to the command
951 * @param user the user issuing the command
952 * @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.
953 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
954 * @param original_line The entire original line as passed to the parser from the user
955 * @return 1 to block the command, 0 to allow
957 virtual ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, User *user, bool validated, const std::string &original_line);
959 /** Called after any command has been executed.
960 * This event occurs for all registered commands, wether they are registered in the core,
961 * or another module, but it will not occur for invalid commands (e.g. ones which do not
962 * exist within the command table). The result code returned by the command handler is
964 * @param command The command being executed
965 * @param parameters An array of array of characters containing the parameters for the command
966 * @param pcnt The nuimber of parameters passed to the command
967 * @param user the user issuing the command
968 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
969 * @param original_line The entire original line as passed to the parser from the user
971 virtual void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, User *user, CmdResult result, const std::string &original_line);
973 /** Called to check if a user who is connecting can now be allowed to register
974 * If any modules return false for this function, the user is held in the waiting
975 * state until all modules return true. For example a module which implements ident
976 * lookups will continue to return false for a user until their ident lookup is completed.
977 * Note that the registration timeout for a user overrides these checks, if the registration
978 * timeout is reached, the user is disconnected even if modules report that the user is
979 * not ready to connect.
980 * @param user The user to check
981 * @return true to indicate readiness, false if otherwise
983 virtual ModResult OnCheckReady(User* user);
985 /** Called whenever a user is about to register their connection (e.g. before the user
986 * is sent the MOTD etc). Modules can use this method if they are performing a function
987 * which must be done before the actual connection is completed (e.g. ident lookups,
988 * dnsbl lookups, etc).
989 * Note that you should NOT delete the user record here by causing a disconnection!
990 * Use OnUserConnect for that instead.
991 * @param user The user registering
992 * @return 1 to indicate user quit, 0 to continue
994 virtual ModResult OnUserRegister(User* user);
996 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
997 * This method will always be called for each join, wether or not the channel is actually +i, and
998 * determines the outcome of an if statement around the whole section of invite checking code.
999 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1000 * @param user The user joining the channel
1001 * @param chan The channel being joined
1002 * @return 1 to explicitly allow the join, 0 to proceed as normal
1004 virtual ModResult OnCheckInvite(User* user, Channel* chan);
1006 /** Called whenever a mode character is processed.
1007 * Return 1 from this function to block the mode character from being processed entirely.
1008 * @param user The user who is sending the mode
1009 * @param chan The channel the mode is being sent to (or NULL if a usermode)
1010 * @param mode The mode character being set
1011 * @param param The parameter for the mode or an empty string
1012 * @param adding true of the mode is being added, false if it is being removed
1013 * @param pcnt The parameter count for the mode (0 or 1)
1014 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
1015 * to skip all permission checking. Please note that for remote mode changes, your return value
1018 virtual ModResult OnRawMode(User* user, Channel* chan, const char mode, const std::string ¶m, bool adding, int pcnt);
1020 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1021 * This method will always be called for each join, wether or not the channel is actually +k, and
1022 * determines the outcome of an if statement around the whole section of key checking code.
1023 * if the user specified no key, the keygiven string will be a valid but empty value.
1024 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1025 * @param user The user joining the channel
1026 * @param chan The channel being joined
1027 * @return 1 to explicitly allow the join, 0 to proceed as normal
1029 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
1031 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1032 * This method will always be called for each join, wether or not the channel is actually +l, and
1033 * determines the outcome of an if statement around the whole section of channel limit checking code.
1034 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1035 * @param user The user joining the channel
1036 * @param chan The channel being joined
1037 * @return 1 to explicitly allow the join, 0 to proceed as normal
1039 virtual ModResult OnCheckLimit(User* user, Channel* chan);
1042 * Checks for a user's ban from the channel
1043 * @param user The user to check
1044 * @param chan The channel to check in
1045 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1046 * ban check, or MOD_RES_PASSTHRU to check bans normally
1048 virtual ModResult OnCheckChannelBan(User* user, Channel* chan);
1051 * Checks for a user's match of a single ban
1052 * @param user The user to check for match
1053 * @param chan The channel on which the match is being checked
1054 * @param mask The mask being checked
1055 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1056 * ban check, or MOD_RES_PASSTHRU to check bans normally
1058 virtual ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask);
1060 /** Checks for a match on a given extban type
1061 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1062 * ban check, or MOD_RES_PASSTHRU to check bans normally
1064 virtual ModResult OnExtBanCheck(User* user, Channel* chan, char type);
1066 /** Called on all /STATS commands
1067 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1068 * @param symbol the symbol provided to /STATS
1069 * @param user the user issuing the /STATS command
1070 * @param results A string_list to append results into. You should put all your results
1071 * into this string_list, rather than displaying them directly, so that your handler will
1072 * work when remote STATS queries are received.
1073 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1075 virtual ModResult OnStats(char symbol, User* user, string_list &results);
1077 /** Called whenever a change of a local users displayed host is attempted.
1078 * Return 1 to deny the host change, or 0 to allow it.
1079 * @param user The user whos host will be changed
1080 * @param newhost The new hostname
1081 * @return 1 to deny the host change, 0 to allow
1083 virtual ModResult OnChangeLocalUserHost(User* user, const std::string &newhost);
1085 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1086 * return 1 to deny the name change, or 0 to allow it.
1087 * @param user The user whos GECOS will be changed
1088 * @param newhost The new GECOS
1089 * @return 1 to deny the GECOS change, 0 to allow
1091 virtual ModResult OnChangeLocalUserGECOS(User* user, const std::string &newhost);
1093 /** Called before a topic is changed.
1094 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
1095 * As with other 'pre' events, you should only ever block a local event.
1096 * @param user The user changing the topic
1097 * @param chan The channels who's topic is being changed
1098 * @param topic The actual topic text
1099 * @param 1 to block the topic change, 0 to allow
1101 virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
1103 /** Called whenever a topic has been changed.
1104 * To block topic changes you must use OnPreTopicChange instead.
1105 * @param user The user changing the topic
1106 * @param chan The channels who's topic is being changed
1107 * @param topic The actual topic text
1109 virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
1111 /** Called whenever an Event class is sent to all modules by another module.
1112 * You should *always* check the value of Event::id to determine the event type.
1113 * @param event The Event class being received
1115 virtual void OnEvent(Event& event);
1117 /** Called whenever a Request class is sent to your module by another module.
1118 * The value of Request::id should be used to determine the type of request.
1119 * @param request The Request class being received
1121 virtual void OnRequest(Request& request);
1123 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
1124 * The password field (from the config file) is in 'password' and is to be compared against
1125 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
1126 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
1127 * @param ex The object that's causing the authentication (User* for <oper> <connect:allow> etc, Server* for <link>).
1128 * @param password The password from the configuration file (the password="" value).
1129 * @param input The password entered by the user or whoever.
1130 * @param hashtype The hash value from the config
1131 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
1133 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
1135 /** Called whenever a user is given usermode +o, anywhere on the network.
1136 * You cannot override this and prevent it from happening as it is already happened and
1137 * such a task must be performed by another server. You can however bounce modes by sending
1138 * servermodes out to reverse mode changes.
1139 * @param user The user who is opering
1141 virtual void OnGlobalOper(User* user);
1143 /** Called after a user has fully connected and all modules have executed OnUserConnect
1144 * This event is informational only. You should not change any user information in this
1145 * event. To do so, use the OnUserConnect method to change the state of local users.
1146 * This is called for both local and remote users.
1147 * @param user The user who is connecting
1149 virtual void OnPostConnect(User* user);
1151 /** Called whenever a ban is added to a channel's list.
1152 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1153 * @param source The user adding the ban
1154 * @param channel The channel the ban is being added to
1155 * @param banmask The ban mask being added
1156 * @return 1 to block the ban, 0 to continue as normal
1158 virtual ModResult OnAddBan(User* source, Channel* channel,const std::string &banmask);
1160 /** Called whenever a ban is removed from a channel's list.
1161 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1162 * @param source The user deleting the ban
1163 * @param channel The channel the ban is being deleted from
1164 * @param banmask The ban mask being deleted
1165 * @return 1 to block the unban, 0 to continue as normal
1167 virtual ModResult OnDelBan(User* source, Channel* channel,const std::string &banmask);
1169 /** Called to install an I/O hook on an event handler
1170 * @param user The item to possibly install the I/O hook on
1171 * @param via The port that <user> connected on
1173 virtual void OnHookIO(StreamSocket*, ListenSocketBase* via);
1175 /** Called immediately after any connection is accepted. This is intended for raw socket
1176 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1177 * no information relating to a user record as the connection has not been assigned yet.
1178 * There are no return values from this call as all modules get an opportunity if required to
1179 * process the connection.
1180 * @param fd The file descriptor returned from accept()
1181 * @param client The client IP address and port
1182 * @param server The server IP address and port
1183 * @param localport The local port number the user connected to
1185 virtual void OnStreamSocketAccept(StreamSocket*, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
1188 * Called when a hooked stream has data to write, or when the socket
1189 * engine returns it as writable
1190 * @param socket The socket in question
1191 * @param sendq Data to send to the socket
1192 * @return 1 if the sendq has been completely emptied, 0 if there is
1193 * still data to send, and -1 if there was an error
1195 virtual int OnStreamSocketWrite(StreamSocket*, std::string& sendq);
1197 /** Called immediately before any socket is closed. When this event is called, shutdown()
1198 * has not yet been called on the socket.
1199 * @param fd The file descriptor of the socket prior to close()
1201 virtual void OnStreamSocketClose(StreamSocket*);
1203 /** Called immediately upon connection of an outbound BufferedSocket which has been hooked
1205 * @param fd The file descriptor of the socket immediately after connect()
1207 virtual void OnStreamSocketConnect(StreamSocket*);
1210 * Called when the stream socket has data to read
1211 * @param socket The socket that is ready
1212 * @param recvq The receive queue that new data should be appended to
1213 * @return 1 if new data has been read, 0 if no new data is ready (but the
1214 * socket is still connected), -1 if there was an error or close
1216 virtual int OnStreamSocketRead(StreamSocket*, std::string& recvq);
1218 /** Called whenever a user sets away or returns from being away.
1219 * The away message is available as a parameter, but should not be modified.
1220 * At this stage, it has already been copied into the user record.
1221 * If awaymsg is empty, the user is returning from away.
1222 * @param user The user setting away
1223 * @param awaymsg The away message of the user, or empty if returning from away
1224 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
1226 virtual ModResult OnSetAway(User* user, const std::string &awaymsg);
1228 /** Called whenever a NAMES list is requested.
1229 * You can produce the nameslist yourself, overriding the current list,
1230 * and if you do you must return 1. If you do not handle the names list,
1232 * @param The user requesting the NAMES list
1233 * @param Ptr The channel the NAMES list is requested for
1235 virtual ModResult OnUserList(User* user, Channel* Ptr);
1237 /** Called whenever a line of WHOIS output is sent to a user.
1238 * You may change the numeric and the text of the output by changing
1239 * the values numeric and text, but you cannot change the user the
1240 * numeric is sent to. You may however change the user's User values.
1241 * @param user The user the numeric is being sent to
1242 * @param dest The user being WHOISed
1243 * @param numeric The numeric of the line being sent
1244 * @param text The text of the numeric, including any parameters
1245 * @return nonzero to drop the line completely so that the user does not
1246 * receive it, or zero to allow the line to be sent.
1248 virtual ModResult OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
1250 /** Called at intervals for modules to garbage-collect any hashes etc.
1251 * Certain data types such as hash_map 'leak' buckets, which must be
1252 * tidied up and freed by copying into a new item every so often. This
1253 * method is called when it is time to do that.
1255 virtual void OnGarbageCollect();
1257 /** Add test suite hooks here. These are used for testing functionality of a module
1258 * via the --testsuite debugging parameter.
1260 virtual void OnRunTestSuite();
1262 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
1263 * For example NAMESX, channel mode +u and +I, and UHNAMES. If the nick is set to an empty string by any
1264 * module, then this will cause the nickname not to be displayed at all.
1266 virtual void OnNamesListItem(User* issuer, Membership* item, std::string &prefixes, std::string &nick);
1268 virtual ModResult OnNumeric(User* user, unsigned int numeric, const std::string &text);
1270 /** Called whenever a result from /WHO is about to be returned
1271 * @param source The user running the /WHO query
1272 * @param user The user that this line of the query is about
1273 * @param channel The channel being queried (or NULL if not a channel query)
1274 * @param line The raw line to send; modifiable, if empty no line will be returned.
1276 virtual void OnSendWhoLine(User* source, User* user, Channel* channel, std::string& line);
1278 /** Called to check whether a channel restriction mode applies to a user on it
1279 * @return MOD_RES_DENY to apply the restriction, MOD_RES_ALLOW to bypass
1280 * the restriction, or MOD_RES_PASSTHRU to check restriction status normally
1282 virtual ModResult OnChannelRestrictionApply(User* user, Channel* chan, const char* restriction);
1286 #define CONF_NO_ERROR 0x000000
1287 #define CONF_NOT_A_NUMBER 0x000010
1288 #define CONF_INT_NEGATIVE 0x000080
1289 #define CONF_VALUE_NOT_FOUND 0x000100
1290 #define CONF_FILE_NOT_FOUND 0x000200
1293 /** Allows reading of values from configuration files
1294 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1295 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1296 * Constructing the class using one parameter allows you to specify a path to your own configuration
1297 * file, otherwise, inspircd.conf is read.
1299 class CoreExport ConfigReader : public interfacebase
1307 /** Default constructor.
1308 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1309 * as specified when running ./configure.
1312 /** Default destructor.
1313 * This method destroys the ConfigReader class.
1317 /** Retrieves a value from the config file.
1318 * This method retrieves a value from the config file. Where multiple copies of the tag
1319 * exist in the config file, index indicates which of the values to retrieve.
1321 std::string ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds = false);
1322 /** Retrieves a value from the config file.
1323 * This method retrieves a value from the config file. Where multiple copies of the tag
1324 * exist in the config file, index indicates which of the values to retrieve. If the
1325 * tag is not found the default value is returned instead.
1327 std::string ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds = false);
1329 /** Retrieves a boolean value from the config file.
1330 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1331 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1332 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1334 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1335 /** Retrieves a boolean value from the config file.
1336 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1337 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1338 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1339 * If the tag is not found, the default value is used instead.
1341 bool ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index);
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. need_positive is set if the number must be non-negative.
1348 * If a negative number is placed into a tag which is specified positive, 0 will be returned and GetError()
1349 * will return CONF_INT_NEGATIVE. Note that need_positive is not suitable to get an unsigned int - you
1350 * should cast the result to achieve that effect.
1352 int ReadInteger(const std::string &tag, const std::string &name, int index, bool need_positive);
1353 /** Retrieves an integer value from the config file.
1354 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1355 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1356 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1357 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1358 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1359 * will return CONF_NOT_UNSIGNED. If the tag is not found, the default value is used instead.
1361 int ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool need_positive);
1363 /** Returns the last error to occur.
1364 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1365 * A call to GetError() resets the error flag back to 0.
1369 /** Counts the number of times a given tag appears in the config file.
1370 * This method counts the number of times a tag appears in a config file, for use where
1371 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1372 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1373 * multiple instance tag.
1375 int Enumerate(const std::string &tag);
1380 /** Caches a text file into memory and can be used to retrieve lines from it.
1381 * This class contains methods for read-only manipulation of a text file in memory.
1382 * Either use the constructor type with one parameter to load a file into memory
1383 * at construction, or use the LoadFile method to load a file.
1385 class CoreExport FileReader : public classbase
1387 /** The file contents
1389 std::vector<std::string> fc;
1391 /** Content size in bytes
1393 unsigned long contentsize;
1395 /** Calculate content size in bytes
1400 /** Default constructor.
1401 * This method does not load any file into memory, you must use the LoadFile method
1402 * after constructing the class this way.
1406 /** Secondary constructor.
1407 * This method initialises the class with a file loaded into it ready for GetLine and
1408 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1411 FileReader(const std::string &filename);
1413 /** Default destructor.
1414 * This deletes the memory allocated to the file.
1418 /** Used to load a file.
1419 * This method loads a file into the class ready for GetLine and
1420 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1423 void LoadFile(const std::string &filename);
1425 /** Returns the whole content of the file as std::string
1427 std::string Contents();
1429 /** Returns the entire size of the file as std::string
1431 unsigned long ContentSize();
1433 /** Returns true if the file exists
1434 * This function will return false if the file could not be opened.
1438 /** Retrieve one line from the file.
1439 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1440 * the index was out of bounds, or the line had no data on it.
1442 std::string GetLine(int x);
1444 /** Returns the size of the file in lines.
1445 * This method returns the number of lines in the read file. If it is 0, no lines have been
1446 * read into memory, either because the file is empty or it does not exist, or cannot be
1447 * opened due to permission problems.
1452 /** A list of modules
1454 typedef std::vector<Module*> IntModuleList;
1456 /** An event handler iterator
1458 typedef IntModuleList::iterator EventHandlerIter;
1460 /** ModuleManager takes care of all things module-related
1463 class CoreExport ModuleManager
1466 /** Holds a string describing the last module error to occur
1468 std::string LastModuleError;
1470 /** The feature names published by various modules
1472 featurelist Features;
1474 /** The interface names published by various modules
1476 interfacelist Interfaces;
1478 /** Total number of modules loaded into the ircd
1482 /** List of loaded modules and shared object/dll handles
1483 * keyed by module name
1485 std::map<std::string, Module*> Modules;
1491 } prioritizationState;
1493 /** Internal unload module hook */
1494 bool CanUnload(Module*);
1497 /** Event handler hooks.
1498 * This needs to be public to be used by FOREACH_MOD and friends.
1500 IntModuleList EventHandlers[I_END];
1502 /** Simple, bog-standard, boring constructor.
1510 /** Change the priority of one event in a module.
1511 * Each module event has a list of modules which are attached to that event type.
1512 * If you wish to be called before or after other specific modules, you may use this
1513 * method (usually within void Module::Prioritize()) to set your events priority.
1514 * You may use this call in other methods too, however, this is not supported behaviour
1516 * @param mod The module to change the priority of
1517 * @param i The event to change the priority of
1518 * @param s The state you wish to use for this event. Use one of
1519 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1520 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1521 * to set it to be before or after one or more other modules.
1522 * @param modules If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1523 * then this contains a list of one or more modules your module must be
1524 * placed before or after. Your module will be placed before the highest
1525 * priority module in this list for PRIO_BEFORE, or after the lowest
1526 * priority module in this list for PRIORITY_AFTER.
1527 * @param sz The number of modules being passed for PRIO_BEFORE and PRIORITY_AFTER.
1528 * Defaults to 1, as most of the time you will only want to prioritize your module
1529 * to be before or after one other module.
1531 bool SetPriority(Module* mod, Implementation i, Priority s, Module** modules = NULL, size_t sz = 1);
1533 /** Change the priority of all events in a module.
1534 * @param mod The module to set the priority of
1535 * @param s The priority of all events in the module.
1536 * Note that with this method, it is not possible to effectively use
1537 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1538 * SetPriority method for this, where you may specify other modules to
1539 * be prioritized against.
1541 bool SetPriority(Module* mod, Priority s);
1543 /** Attach an event to a module.
1544 * You may later detatch the event with ModuleManager::Detach().
1545 * If your module is unloaded, all events are automatically detatched.
1546 * @param i Event type to attach
1547 * @param mod Module to attach event to
1548 * @return True if the event was attached
1550 bool Attach(Implementation i, Module* mod);
1552 /** Detatch an event from a module.
1553 * This is not required when your module unloads, as the core will
1554 * automatically detatch your module from all events it is attached to.
1555 * @param i Event type to detach
1556 * @param mod Module to detach event from
1557 * @param Detach true if the event was detached
1559 bool Detach(Implementation i, Module* mod);
1561 /** Attach an array of events to a module
1562 * @param i Event types (array) to attach
1563 * @param mod Module to attach events to
1565 void Attach(Implementation* i, Module* mod, size_t sz);
1567 /** Detach all events from a module (used on unload)
1568 * @param mod Module to detach from
1570 void DetachAll(Module* mod);
1572 /** Returns text describing the last module error
1573 * @return The last error message to occur
1575 std::string& LastError();
1577 /** Load a given module file
1578 * @param filename The file to load
1579 * @return True if the module was found and loaded
1581 bool Load(const char* filename);
1583 /** Unload a given module file. Note that the module will not be
1584 * completely gone until the cull list has finished processing.
1586 * @return true on success; if false, LastError will give a reason
1588 bool Unload(Module* module);
1590 /** Run an asynchronous reload of the given module. When the reload is
1591 * complete, the callback will be run with true if the reload succeeded
1592 * and false if it did not.
1594 void Reload(Module* module, HandlerBase1<void, bool>* callback);
1596 /** Called by the InspIRCd constructor to load all modules from the config file.
1600 void DoSafeUnload(Module*);
1602 /** Get the total number of currently loaded modules
1603 * @return The number of loaded modules
1607 return this->ModCount;
1610 /** Find a module by name, and return a Module* to it.
1611 * This is preferred over iterating the module lists yourself.
1612 * @param name The module name to look up
1613 * @return A pointer to the module, or NULL if the module cannot be found
1615 Module* Find(const std::string &name);
1617 /** Publish a 'feature'.
1618 * There are two ways for a module to find another module it depends on.
1619 * Either by name, using InspIRCd::FindModule, or by feature, using this
1620 * function. A feature is an arbitary string which identifies something this
1621 * module can do. For example, if your module provides SSL support, but other
1622 * modules provide SSL support too, all the modules supporting SSL should
1623 * publish an identical 'SSL' feature. This way, any module requiring use
1624 * of SSL functions can just look up the 'SSL' feature using FindFeature,
1625 * then use the module pointer they are given.
1626 * @param FeatureName The case sensitive feature name to make available
1627 * @param Mod a pointer to your module class
1628 * @returns True on success, false if the feature is already published by
1631 bool PublishFeature(const std::string &FeatureName, Module* Mod);
1633 /** Publish a module to an 'interface'.
1634 * Modules which implement the same interface (the same way of communicating
1635 * with other modules) can publish themselves to an interface, using this
1636 * method. When they do so, they become part of a list of related or
1637 * compatible modules, and a third module may then query for that list
1638 * and know that all modules within that list offer the same API.
1639 * A prime example of this is the hashing modules, which all accept the
1640 * same types of Request class. Consider this to be similar to PublishFeature,
1641 * except for that multiple modules may publish the same 'feature'.
1642 * @param InterfaceName The case sensitive interface name to make available
1643 * @param Mod a pointer to your module class
1644 * @returns True on success, false on failure (there are currently no failure
1647 bool PublishInterface(const std::string &InterfaceName, Module* Mod);
1649 /** Return a pair saying how many other modules are currently using the
1650 * interfaces provided by module m.
1651 * @param m The module to count usage for
1652 * @return A pair, where the first value is the number of uses of the interface,
1653 * and the second value is the interface name being used.
1655 std::pair<int,std::string> GetInterfaceInstanceCount(Module* m);
1657 /** Mark your module as using an interface.
1658 * If you mark your module as using an interface, then that interface
1659 * module may not unload until your module has unloaded first.
1660 * This can be used to prevent crashes by ensuring code you depend on
1661 * is always in memory while your module is active.
1662 * @param InterfaceName The interface to use
1664 void UseInterface(const std::string &InterfaceName);
1666 /** Mark your module as finished with an interface.
1667 * If you used UseInterface() above, you should use this method when
1668 * your module is finished with the interface (usually in its destructor)
1669 * to allow the modules which implement the given interface to be unloaded.
1670 * @param InterfaceName The interface you are finished with using.
1672 void DoneWithInterface(const std::string &InterfaceName);
1674 /** Unpublish a 'feature'.
1675 * When your module exits, it must call this method for every feature it
1676 * is providing so that the feature table is cleaned up.
1677 * @param FeatureName the feature to remove
1679 bool UnpublishFeature(const std::string &FeatureName);
1681 /** Unpublish your module from an interface
1682 * When your module exits, it must call this method for every interface
1683 * it is part of so that the interfaces table is cleaned up. Only when
1684 * the last item is deleted from an interface does the interface get
1686 * @param InterfaceName the interface to be removed from
1687 * @param Mod The module to remove from the interface list
1689 bool UnpublishInterface(const std::string &InterfaceName, Module* Mod);
1691 /** Find a 'feature'.
1692 * There are two ways for a module to find another module it depends on.
1693 * Either by name, using InspIRCd::FindModule, or by feature, using the
1694 * InspIRCd::PublishFeature method. A feature is an arbitary string which
1695 * identifies something this module can do. For example, if your module
1696 * provides SSL support, but other modules provide SSL support too, all
1697 * the modules supporting SSL should publish an identical 'SSL' feature.
1698 * To find a module capable of providing the feature you want, simply
1699 * call this method with the feature name you are looking for.
1700 * @param FeatureName The feature name you wish to obtain the module for
1701 * @returns A pointer to a valid module class on success, NULL on failure.
1703 Module* FindFeature(const std::string &FeatureName);
1705 /** Find an 'interface'.
1706 * An interface is a list of modules which all implement the same API.
1707 * @param InterfaceName The Interface you wish to obtain the module
1709 * @return A pointer to a deque of Module*, or NULL if the interface
1712 modulelist* FindInterface(const std::string &InterfaceName);
1714 /** Determine if a module has published the named interface.
1715 * This could be used in, for example, OnLoadModule to pick up other modules that can be used.
1716 * @param mod The module to check.
1717 * @param InterfaceName the interface you want to check for
1718 * @return True if the module provides the interface, false otherwise.
1720 bool ModuleHasInterface(Module* mod, const std::string& InterfaceName);
1722 /** Given a pointer to a Module, return its filename
1723 * @param m The module pointer to identify
1724 * @return The module name or an empty string
1726 const std::string& GetModuleName(Module* m);
1728 /** Return a list of all modules matching the given filter
1729 * @param filter This int is a bitmask of flags set in Module::Flags,
1730 * such as VF_VENDOR or VF_STATIC. If you wish to receive a list of
1731 * all modules with no filtering, set this to 0.
1732 * @return The list of module names
1734 const std::vector<std::string> GetAllModuleNames(int filter);
1737 /** Do not mess with these functions unless you know the C preprocessor
1738 * well enough to explain why they are needed. The order is important.
1740 #define MODULE_INIT_STR MODULE_INIT_STR_FN_2(MODULE_INIT_SYM)
1741 #define MODULE_INIT_STR_FN_2(x) MODULE_INIT_STR_FN_1(x)
1742 #define MODULE_INIT_STR_FN_1(x) #x
1743 #define MODULE_INIT_SYM MODULE_INIT_SYM_FN_2(API_VERSION)
1744 #define MODULE_INIT_SYM_FN_2(x) MODULE_INIT_SYM_FN_1(x)
1745 #define MODULE_INIT_SYM_FN_1(x) inspircd_module_ ## x
1747 /** This definition is used as shorthand for the various classes
1748 * and functions needed to make a module loadable by the OS.
1749 * It defines the class factory and external init_module function.
1753 #define MODULE_INIT(y) \
1754 extern "C" DllExport Module * MODULE_INIT_SYM() \
1758 BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
1760 switch ( nReason ) \
1762 case DLL_PROCESS_ATTACH: \
1763 case DLL_PROCESS_DETACH: \
1771 #define MODULE_INIT(y) \
1772 extern "C" DllExport Module * MODULE_INIT_SYM() \
1778 #define COMMAND_INIT(c) MODULE_INIT(CommandModule<c>)