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_SERVICEPROVIDER = 4, // module provides a service to other modules (can be a dependency)
37 VF_COMMON = 8, // module needs to be common on all servers in a network to link
38 VF_OPTCOMMON = 16, // module should be common on all servers for unsurprising behavior
39 VF_CORE = 32 // module is a core command, can be assumed loaded on all servers
42 /** Used with SendToMode()
49 /** Used to represent an event type, for user, channel or server
51 enum TargetTypeFlags {
58 /** Used to represent wether a message was PRIVMSG or NOTICE
65 #define MOD_RES_ALLOW (ModResult(1))
66 #define MOD_RES_PASSTHRU (ModResult(0))
67 #define MOD_RES_DENY (ModResult(-1))
69 /** Used to represent an allow/deny module result.
70 * Not constructed as an enum because it reverses the value logic of some functions;
71 * the compiler will inline accesses to have the same efficiency as integer operations.
75 ModResult() : res(0) {}
76 explicit ModResult(int r) : res(r) {}
77 bool operator==(const ModResult& r) const
81 bool operator!=(const ModResult& r) const
85 bool operator!() const
89 bool check(bool def) const
91 return (res == 1 || (res == 0 && def));
94 * Merges two results, preferring ALLOW to DENY
96 ModResult operator+(const ModResult& r) const
98 if (res == r.res || r.res == 0)
102 // they are different, and neither is passthru
103 return MOD_RES_ALLOW;
107 /** If you change the module API in any way, increment this value. */
108 #define API_VERSION 132
112 /* Forward-delacare module for ModuleMessage etc
117 /** Low level definition of a FileReader classes file cache area -
118 * a text file seperated into lines.
120 typedef std::deque<std::string> file_cache;
122 /** A set of strings.
124 typedef file_cache string_list;
126 /** Holds a list of 'published features' for modules.
128 typedef std::map<std::string,Module*> featurelist;
130 /** Holds a list of modules which implement an interface
132 typedef std::deque<Module*> modulelist;
134 /** Holds a list of all modules which implement interfaces, by interface name
136 typedef std::map<std::string, std::pair<int, modulelist> > interfacelist;
139 * This #define allows us to call a method in all
140 * loaded modules in a readable simple way, e.g.:
141 * 'FOREACH_MOD(I_OnConnect,OnConnect(user));'
143 #define FOREACH_MOD(y,x) do { \
144 EventHandlerIter safei; \
145 for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ) \
153 catch (CoreException& modexcept) \
155 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
162 * Custom module result handling loop. This is a paired macro, and should only
163 * be used with while_each_hook.
165 * See src/channels.cpp for an example of use.
167 #define DO_EACH_HOOK(n,v,args) \
169 EventHandlerIter iter_ ## n = ServerInstance->Modules->EventHandlers[I_ ## n].begin(); \
170 while (iter_ ## n != ServerInstance->Modules->EventHandlers[I_ ## n].end()) \
172 Module* mod_ ## n = *iter_ ## n; \
176 v = (mod_ ## n)->n args;
178 #define WHILE_EACH_HOOK(n) \
180 catch (CoreException& except_ ## n) \
182 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s", (except_ ## n).GetReason()); \
183 (void) mod_ ## n; /* catch mismatched pairs */ \
189 * Module result iterator
190 * Runs the given hook until some module returns a useful result.
192 * Example: ModResult result;
193 * FIRST_MOD_RESULT(OnUserPreNick, result, (user, newnick))
195 #define FIRST_MOD_RESULT(n,v,args) do { \
196 v = MOD_RES_PASSTHRU; \
197 DO_EACH_HOOK(n,v,args) \
199 if (v != MOD_RES_PASSTHRU) \
202 WHILE_EACH_HOOK(n); \
205 /** Represents a non-local user.
206 * (in fact, any FD less than -1 does)
208 #define FD_MAGIC_NUMBER -42
209 /** Represents a fake user (i.e. a server)
211 #define FD_FAKEUSER_NUMBER -7
215 /** Is a local user */
216 #define IS_LOCAL(x) (x->GetFd() > -1)
217 /** Is a remote user */
218 #define IS_REMOTE(x) (x->GetFd() < 0)
219 /** Is a fake user */
220 #define IS_SERVER(x) (x->GetFd() == FD_FAKEUSER_NUMBER)
221 /** Is a module created user */
222 #define IS_MODULE_CREATED(x) (x->GetFd() == FD_MAGIC_NUMBER)
224 #define IS_OPER(x) (!x->oper.empty())
226 #define IS_AWAY(x) (!x->awaymsg.empty())
228 /** Holds a module's Version information.
229 * The members (set by the constructor only) indicate details as to the version number
230 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
232 * The core provides only one implementation of the template, causing a run-time linking
233 * error when attempting to load a module compiled against a different API_VERSION.
236 class CoreExport VersionBase : public classbase
239 /** Module description
241 const std::string description;
242 /** Version information.
244 const std::string version;
250 /** Initialize version class
252 VersionBase(const std::string &desc, int flags = VF_NONE, int dummy = 0, const std::string& src_rev = VERSION " r" REVISION);
255 typedef VersionBase<API_VERSION> Version;
257 /** The Request class is a unicast message directed at a given module.
258 * When this class is properly instantiated it may be sent to a module
259 * using the Send() method, which will call the given module's OnRequest
260 * method with this class as its parameter.
262 class CoreExport Request : public classbase
265 /** This should be a null-terminated string identifying the type of request,
266 * all modules should define this and use it to determine the nature of the
267 * request before they attempt to cast the Request in any way.
269 const char* const id;
270 /** This is a pointer to the sender of the message, which can be used to
271 * directly trigger events, or to create a reply.
273 Module* const source;
274 /** The single destination of the Request
278 /** Create a new Request
279 * This is for the 'new' way of defining a subclass
280 * of Request and defining it in a common header,
281 * passing an object of your Request subclass through
282 * as a Request* and using the ID string to determine
283 * what to cast it back to and the other end.
285 Request(Module* src, Module* dst, const char* idstr);
286 /** Send the Request.
292 /** The Event class is a unicast message directed at all modules.
293 * When the class is properly instantiated it may be sent to all modules
294 * using the Send() method, which will trigger the OnEvent method in
295 * all modules passing the object as its parameter.
297 class CoreExport Event : public classbase
300 /** This is a pointer to the sender of the message, which can be used to
301 * directly trigger events, or to create a reply.
303 Module* const source;
304 /** The event identifier.
305 * This is arbitary text which should be used to distinguish
306 * one type of event from another.
308 const std::string id;
310 /** Create a new Event
312 Event(Module* src, const std::string &eventid);
314 * The return result of an Event::Send() will always be NULL as
315 * no replies are expected.
320 /** Priority types which can be returned from Module::Prioritize()
322 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
324 /** Implementation-specific flags which may be set in Module::Implements()
329 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash,
330 I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois,
331 I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick,
332 I_OnUserMessage, I_OnUserNotice, I_OnMode, I_OnGetServerDescription, I_OnSyncUser,
333 I_OnSyncChannel, I_OnDecodeMetaData, I_OnWallops,
334 I_OnChangeHost, I_OnChangeName, I_OnAddLine, I_OnDelLine, I_OnExpireLine,
335 I_OnUserPostNick, I_OnPreMode, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule,
336 I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite,
337 I_OnRawMode, I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckChannelBan, I_OnExtBanCheck,
338 I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnPreTopicChange,
339 I_OnPostTopicChange, I_OnEvent, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan,
340 I_OnDelBan, I_OnChangeLocalUserGECOS, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
341 I_OnPostOper, I_OnSyncNetwork, I_OnSetAway, I_OnUserList, I_OnPostCommand, I_OnPostJoin,
342 I_OnWhoisLine, I_OnBuildNeighborList, I_OnGarbageCollect,
343 I_OnText, I_OnPassCompare, I_OnRunTestSuite, I_OnNamesListItem, I_OnNumeric, I_OnHookIO,
344 I_OnPreRehash, I_OnModuleRehash, I_OnSendWhoLine, I_OnChangeIdent,
350 /** Base class for all InspIRCd modules
351 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
352 * its methods will be called when irc server events occur. class inherited from module must be
353 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
355 class CoreExport Module : public Extensible
358 /** File that this module was loaded from
360 std::string ModuleSourceFile;
361 /** Reference to the dlopen() value
363 DLLFactory* ModuleDLLFactory;
365 /** Default constructor.
366 * Creates a module class.
367 * @param Me An instance of the InspIRCd class which will be saved into ServerInstance for your use
368 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
372 /** Clean up prior to destruction
373 * If you override, you must call this AFTER your module's cleanup
377 /** Default destructor.
378 * destroys a module class
382 virtual void Prioritize()
386 /** Returns the version number of a Module.
387 * The method should return a Version object with its version information assigned via
390 virtual Version GetVersion() = 0;
392 /** Called when a user connects.
393 * The details of the connecting user are available to you in the parameter User *user
394 * @param user The user who is connecting
396 virtual void OnUserConnect(User* user);
398 /** Called when a user quits.
399 * The details of the exiting user are available to you in the parameter User *user
400 * This event is only called when the user is fully registered when they quit. To catch
401 * raw disconnections, use the OnUserDisconnect method.
402 * @param user The user who is quitting
403 * @param message The user's quit message (as seen by non-opers)
404 * @param oper_message The user's quit message (as seen by opers)
406 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
408 /** Called whenever a user's socket is closed.
409 * The details of the exiting user are available to you in the parameter User *user
410 * This event is called for all users, registered or not, as a cleanup method for modules
411 * which might assign resources to user, such as dns lookups, objects and sockets.
412 * @param user The user who is disconnecting
414 virtual void OnUserDisconnect(User* user);
416 /** Called whenever a channel is about to be deleted
417 * @param chan The channel being deleted
418 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
420 virtual ModResult OnChannelPreDelete(Channel *chan);
422 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
423 * @param chan The channel being deleted
425 virtual void OnChannelDelete(Channel* chan);
427 /** Called when a user joins a channel.
428 * The details of the joining user are available to you in the parameter User *user,
429 * and the details of the channel they have joined is available in the variable Channel *channel
430 * @param memb The channel membership being created
431 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
432 * to a channel due to the network sync.
433 * @param created This is true if the join created the channel
435 virtual void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list);
437 /** Called after a user joins a channel
438 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
440 * @param memb The channel membership created
442 virtual void OnPostJoin(Membership*);
444 /** Called when a user parts a channel.
445 * The details of the leaving user are available to you in the parameter User *user,
446 * and the details of the channel they have left is available in the variable Channel *channel
447 * @param memb The channel membership being destroyed
448 * @param partmessage The part message, or an empty string (may be modified)
450 virtual void OnUserPart(Membership* memb, std::string &partmessage, CUList& except_list);
452 /** Called on rehash.
453 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
454 * system. This is called in all cases -- including when this server will not execute the
455 * rehash because it is directed at a remote server.
457 * @param user The user performing the rehash, if any. If this is server initiated, the value of
458 * this variable will be NULL.
459 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
462 virtual void OnPreRehash(User* user, const std::string ¶meter);
464 /** Called on rehash.
465 * This method is called when a user initiates a module-specific rehash. This can be used to do
466 * expensive operations (such as reloading SSL certificates) that are not executed on a normal
467 * rehash for efficiency. A rehash of this type does not reload the core configuration.
469 * @param user The user performing the rehash.
470 * @param parameter The parameter given to REHASH
472 virtual void OnModuleRehash(User* user, const std::string ¶meter);
474 /** Called on rehash.
475 * This method is called after a rehash has completed. You should use it to reload any module
476 * configuration from the main configuration file.
477 * @param user The user that performed the rehash, if it was initiated by a user and that user
478 * is still connected.
480 virtual void OnRehash(User* user);
482 /** Called whenever a snotice is about to be sent to a snomask.
483 * snomask and type may both be modified; the message may not.
484 * @param snomask The snomask the message is going to (e.g. 'A')
485 * @param type The textual description the snomask will go to (e.g. 'OPER')
486 * @param message The text message to be sent via snotice
487 * @return 1 to block the snotice from being sent entirely, 0 else.
489 virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
491 /** Called whenever a user is about to join a channel, before any processing is done.
492 * Returning a value of 1 from this function stops the process immediately, causing no
493 * output to be sent to the user by the core. If you do this you must produce your own numerics,
494 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
495 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
499 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
500 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
501 * processing on the actual channel record at this point, however the channel NAME will still be passed in
502 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
503 * @param user The user joining the channel
504 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
505 * @param cname The channel name being joined. For new channels this is valid where chan is not.
506 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "o".
507 * You may alter this string to alter the user's modes on the channel.
508 * @param keygiven The key given to join the channel, or an empty string if none was provided
509 * @return 1 To prevent the join, 0 to allow it.
511 virtual ModResult OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string &privs, const std::string &keygiven);
513 /** Called whenever a user is about to be kicked.
514 * Returning a value of 1 from this function stops the process immediately, causing no
515 * output to be sent to the user by the core. If you do this you must produce your own numerics,
517 * @param source The user issuing the kick
518 * @param user The user being kicked
519 * @param chan The channel the user is being kicked from
520 * @param reason The kick reason
521 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
523 virtual ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason);
525 /** Called whenever a user is kicked.
526 * If this method is called, the kick is already underway and cannot be prevented, so
527 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
528 * @param source The user issuing the kick
529 * @param user The user being kicked
530 * @param chan The channel the user is being kicked from
531 * @param reason The kick reason
533 virtual void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except_list);
535 /** Called whenever a user opers locally.
536 * The User will contain the oper mode 'o' as this function is called after any modifications
537 * are made to the user's structure by the core.
538 * @param user The user who is opering up
539 * @param opertype The opers type name
541 virtual void OnOper(User* user, const std::string &opertype);
543 /** Called after a user opers locally.
544 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
545 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
546 * out the OPERTYPE, etc.
547 * @param user The user who is opering up
548 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
549 * @param opertype The opers type name
551 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
553 /** Called whenever a user types /INFO.
554 * The User will contain the information of the user who typed the command. Modules may use this
555 * method to output their own credits in /INFO (which is the ircd's version of an about box).
556 * It is purposefully not possible to modify any info that has already been output, or halt the list.
557 * You must write a 371 numeric to the user, containing your info in the following format:
559 * <nick> :information here
561 * @param user The user issuing /INFO
563 virtual void OnInfo(User* user);
565 /** Called whenever a /WHOIS is performed on a local user.
566 * The source parameter contains the details of the user who issued the WHOIS command, and
567 * the dest parameter contains the information of the user they are whoising.
568 * @param source The user issuing the WHOIS command
569 * @param dest The user who is being WHOISed
571 virtual void OnWhois(User* source, User* dest);
573 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
574 * Returning 1 from this function stops the process immediately, causing no
575 * output to be sent to the user by the core. If you do this you must produce your own numerics,
576 * notices etc. This is useful for modules which may want to filter invites to channels.
577 * @param source The user who is issuing the INVITE
578 * @param dest The user being invited
579 * @param channel The channel the user is being invited to
580 * @param timeout The time the invite will expire (0 == never)
581 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
583 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
585 /** Called after a user has been successfully invited to a channel.
586 * You cannot prevent the invite from occuring using this function, to do that,
587 * use OnUserPreInvite instead.
588 * @param source The user who is issuing the INVITE
589 * @param dest The user being invited
590 * @param channel The channel the user is being invited to
591 * @param timeout The time the invite will expire (0 == never)
593 virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout);
595 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
596 * Returning any nonzero value from this function stops the process immediately, causing no
597 * output to be sent to the user by the core. If you do this you must produce your own numerics,
598 * notices etc. This is useful for modules which may want to filter or redirect messages.
599 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
600 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
601 * of where the message is destined to be sent.
602 * @param user The user sending the message
603 * @param dest The target of the message (Channel* or User*)
604 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
605 * @param text Changeable text being sent by the user
606 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
607 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
608 * It will be ignored for private messages.
609 * @return 1 to deny the message, 0 to allow it
611 virtual ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
613 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
614 * Returning any nonzero value from this function stops the process immediately, causing no
615 * output to be sent to the user by the core. If you do this you must produce your own numerics,
616 * notices etc. This is useful for modules which may want to filter or redirect messages.
617 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
618 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
619 * of where the message is destined to be sent.
620 * You may alter the message text as you wish before relinquishing control to the next module
621 * in the chain, and if no other modules block the text this altered form of the text will be sent out
622 * to the user and possibly to other servers.
623 * @param user The user sending the message
624 * @param dest The target of the message (Channel* or User*)
625 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
626 * @param text Changeable text being sent by the user
627 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
628 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
629 * It will be ignored for private notices.
630 * @return 1 to deny the NOTICE, 0 to allow it
632 virtual ModResult OnUserPreNotice(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
634 /** Called when sending a message to all "neighbors" of a given user -
635 * that is, all users that share a common channel. This is used in
636 * commands such as NICK, QUIT, etc.
637 * @param source The source of the message
638 * @param include_c Channels to scan for users to include
639 * @param exceptions Map of user->bool that overrides the inclusion decision
641 * Set exceptions[user] = true to include, exceptions[user] = false to exclude
643 virtual void OnBuildNeighborList(User* source, UserChanList &include_c, std::map<User*,bool> &exceptions);
645 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
646 * Please note that although you can see remote nickchanges through this function, you should
647 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
648 * check user->server before taking any action (including returning nonzero from the method).
649 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
650 * module to generate some meaninful output.
651 * @param user The username changing their nick
652 * @param newnick Their new nickname
653 * @return 1 to deny the change, 0 to allow
655 virtual ModResult OnUserPreNick(User* user, const std::string &newnick);
657 /** Called after any PRIVMSG sent from a user.
658 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
659 * if target_type is TYPE_CHANNEL.
660 * @param user The user sending the message
661 * @param dest The target of the message
662 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
663 * @param text the text being sent by the user
664 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
666 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
668 /** Called after any NOTICE sent from a user.
669 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
670 * if target_type is TYPE_CHANNEL.
671 * @param user The user sending the message
672 * @param dest The target of the message
673 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
674 * @param text the text being sent by the user
675 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
677 virtual void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
679 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
680 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
681 * if target_type is TYPE_CHANNEL.
682 * The difference between this event and OnUserPreNotice/OnUserPreMessage is that delivery is gauranteed,
683 * the message has already been vetted. In the case of the other two methods, a later module may stop your
684 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
685 * @param user The user sending the message
686 * @param dest The target of the message
687 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
688 * @param text the text being sent by the user
689 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
691 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
693 /** Called after every MODE command sent from a user
694 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
695 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
696 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
697 * @param user The user sending the MODEs
698 * @param dest The target of the modes (User* or Channel*)
699 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
700 * @param text The actual modes and their parameters if any
701 * @param translate The translation types of the mode parameters
703 virtual void OnMode(User* user, void* dest, int target_type, const std::vector<std::string> &text, const std::vector<TranslateType> &translate);
705 /** Allows modules to alter or create server descriptions
706 * Whenever a module requires a server description, for example for display in
707 * WHOIS, this function is called in all modules. You may change or define the
708 * description given in std::string &description. If you do, this description
709 * will be shown in the WHOIS fields.
710 * @param servername The servername being searched for
711 * @param description Alterable server description for this server
713 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
715 /** Allows modules to synchronize data which relates to users during a netburst.
716 * When this function is called, it will be called from the module which implements
717 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
718 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
719 * (see below). This function will be called for every user visible on your side
720 * of the burst, allowing you to for example set modes, etc. Do not use this call to
721 * synchronize data which you have stored using class Extensible -- There is a specialist
722 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
723 * @param user The user being syncronized
724 * @param proto A pointer to the module handling network protocol
725 * @param opaque An opaque pointer set by the protocol module, should not be modified!
727 virtual void OnSyncUser(User* user, Module* proto, void* opaque);
729 /** Allows modules to synchronize data which relates to channels during a netburst.
730 * When this function is called, it will be called from the module which implements
731 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
732 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
733 * (see below). This function will be called for every user visible on your side
734 * of the burst, allowing you to for example set modes, etc.
736 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
738 * @param chan The channel being syncronized
739 * @param proto A pointer to the module handling network protocol
740 * @param opaque An opaque pointer set by the protocol module, should not be modified!
742 virtual void OnSyncChannel(Channel* chan, Module* proto, void* opaque);
744 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
745 * Whenever the linking module wants to send out data, but doesnt know what the data
746 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
747 * this method is called. You should use the ProtoSendMetaData function after you've
748 * correctly decided how the data should be represented, to send the metadata on its way if
749 * if it belongs to your module.
750 * @param proto A pointer to the module handling network protocol
751 * @param opaque An opaque pointer set by the protocol module, should not be modified!
752 * @param displayable If this value is true, the data is going to be displayed to a user,
753 * and not sent across the network. Use this to determine wether or not to show sensitive data.
755 virtual void OnSyncNetwork(Module* proto, void* opaque);
757 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
758 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
759 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
760 * @param target The Channel* or User* that data should be added to
761 * @param extname The extension name which is being sent
762 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
764 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
766 /** Implemented by modules which provide the ability to link servers.
767 * These modules will implement this method, which allows transparent sending of servermodes
768 * down the network link as a broadcast, without a module calling it having to know the format
769 * of the MODE command before the actual mode string.
771 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
772 * of how to use this function.
774 * @param opaque An opaque pointer set by the protocol module, should not be modified!
775 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
776 * @param target The Channel* or User* that modes should be sent for
777 * @param modeline The modes and parameters to be sent
778 * @param translate The translation types of the mode parameters
780 virtual void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::vector<std::string> &modeline, const std::vector<TranslateType> &translate);
782 /** Implemented by modules which provide the ability to link servers.
783 * These modules will implement this method, which allows metadata (extra data added to
784 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
785 * to other servers on a netburst and decoded at the other end by the same module on a
788 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
789 * how to use this function.
790 * @param opaque An opaque pointer set by the protocol module, should not be modified!
791 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
792 * @param target The Channel* or User* that metadata should be sent for
793 * @param extname The extension name to send metadata for
794 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
796 virtual void ProtoSendMetaData(void* opaque, Extensible* target, const std::string &extname, const std::string &extdata);
798 /** Called after every WALLOPS command.
799 * @param user The user sending the WALLOPS
800 * @param text The content of the WALLOPS message
802 virtual void OnWallops(User* user, const std::string &text);
804 /** Called whenever a user's hostname is changed.
805 * This event triggers after the host has been set.
806 * @param user The user whos host is being changed
807 * @param newhost The new hostname being set
809 virtual void OnChangeHost(User* user, const std::string &newhost);
811 /** Called whenever a user's GECOS (realname) is changed.
812 * This event triggers after the name has been set.
813 * @param user The user who's GECOS is being changed
814 * @param gecos The new GECOS being set on the user
816 virtual void OnChangeName(User* user, const std::string &gecos);
818 /** Called whenever a user's IDENT is changed.
819 * This event triggers after the name has been set.
820 * @param user The user who's IDENT is being changed
821 * @param gecos The new IDENT being set on the user
823 virtual void OnChangeIdent(User* user, const std::string &ident);
825 /** Called whenever an xline is added by a local user.
826 * This method is triggered after the line is added.
827 * @param source The sender of the line or NULL for local server
828 * @param line The xline being added
830 virtual void OnAddLine(User* source, XLine* line);
832 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
833 * This method is triggered after the line is deleted.
834 * @param source The user removing the line or NULL for local server
835 * @param line the line being deleted
837 virtual void OnDelLine(User* source, XLine* line);
839 /** Called whenever an xline expires.
840 * This method is triggered after the line is deleted.
841 * @param line The line being deleted.
843 virtual void OnExpireLine(XLine *line);
845 /** Called before your module is unloaded to clean up Extensibles.
846 * This method is called once for every user and channel on the network,
847 * so that when your module unloads it may clear up any remaining data
848 * in the form of Extensibles added using Extensible::Extend().
849 * If the target_type variable is TYPE_USER, then void* item refers to
850 * a User*, otherwise it refers to a Channel*.
851 * @param target_type The type of item being cleaned
852 * @param item A pointer to the item's class
854 virtual void OnCleanup(int target_type, void* item);
856 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
857 * have been applied. Please note that although you can see remote nickchanges through this function, you should
858 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
859 * check user->server before taking any action (including returning nonzero from the method).
860 * Because this method is called after the nickchange is taken place, no return values are possible
861 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
862 * @param user The user changing their nick
863 * @param oldnick The old nickname of the user before the nickchange
865 virtual void OnUserPostNick(User* user, const std::string &oldnick);
867 /** Called before any mode change, to allow a single access check for
868 * a full mode change (use OnRawMode to check individual modes)
870 * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
871 * OnRawMode for each individual mode
873 * @param source the user making the mode change
874 * @param dest the user destination of the umode change (NULL if a channel mode)
875 * @param channel the channel destination of the mode change
876 * @param parameters raw mode parameters; parameters[0] is the user/channel being changed
878 virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, const std::vector<std::string>& parameters);
880 /** Called when a 005 numeric is about to be output.
881 * The module should modify the 005 numeric if needed to indicate its features.
882 * @param output The 005 string to be modified if neccessary.
884 virtual void On005Numeric(std::string &output);
886 /** Called when a client is disconnected by KILL.
887 * If a client is killed by a server, e.g. a nickname collision or protocol error,
889 * Return 1 from this function to prevent the kill, and 0 from this function to allow
890 * it as normal. If you prevent the kill no output will be sent to the client, it is
891 * down to your module to generate this information.
892 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
893 * If you do so youre risking race conditions, desyncs and worse!
894 * @param source The user sending the KILL
895 * @param dest The user being killed
896 * @param reason The kill reason
897 * @return 1 to prevent the kill, 0 to allow
899 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
901 /** Called when an oper wants to disconnect a remote user via KILL
902 * @param source The user sending the KILL
903 * @param dest The user being killed
904 * @param reason The kill reason
906 virtual void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
908 /** Called whenever a module is loaded.
909 * mod will contain a pointer to the module, and string will contain its name,
910 * for example m_widgets.so. This function is primary for dependency checking,
911 * your module may decide to enable some extra features if it sees that you have
912 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
913 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
914 * but instead operate under reduced functionality, unless the dependency is
915 * absolutely neccessary (e.g. a module that extends the features of another
917 * @param mod A pointer to the new module
918 * @param name The new module's filename
920 virtual void OnLoadModule(Module* mod,const std::string &name);
922 /** Called whenever a module is unloaded.
923 * mod will contain a pointer to the module, and string will contain its name,
924 * for example m_widgets.so. This function is primary for dependency checking,
925 * your module may decide to enable some extra features if it sees that you have
926 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
927 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
928 * but instead operate under reduced functionality, unless the dependency is
929 * absolutely neccessary (e.g. a module that extends the features of another
931 * @param mod Pointer to the module being unloaded (still valid)
932 * @param name The filename of the module being unloaded
934 virtual void OnUnloadModule(Module* mod,const std::string &name);
936 /** Called once every five seconds for background processing.
937 * This timer can be used to control timed features. Its period is not accurate
938 * enough to be used as a clock, but it is gauranteed to be called at least once in
939 * any five second period, directly from the main loop of the server.
940 * @param curtime The current timer derived from time(2)
942 virtual void OnBackgroundTimer(time_t curtime);
944 /** Called whenever any command is about to be executed.
945 * This event occurs for all registered commands, wether they are registered in the core,
946 * or another module, and for invalid commands. Invalid commands may only be sent to this
947 * function when the value of validated is false. By returning 1 from this method you may prevent the
948 * command being executed. If you do this, no output is created by the core, and it is
949 * down to your module to produce any output neccessary.
950 * Note that unless you return 1, you should not destroy any structures (e.g. by using
951 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
952 * method returns, it will be passed an invalid pointer to the user object and crash!)
953 * @param command The command being executed
954 * @param parameters An array of array of characters containing the parameters for the command
955 * @param pcnt The nuimber of parameters passed to the command
956 * @param user the user issuing the command
957 * @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.
958 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
959 * @param original_line The entire original line as passed to the parser from the user
960 * @return 1 to block the command, 0 to allow
962 virtual ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, User *user, bool validated, const std::string &original_line);
964 /** Called after any command has been executed.
965 * This event occurs for all registered commands, wether they are registered in the core,
966 * or another module, but it will not occur for invalid commands (e.g. ones which do not
967 * exist within the command table). The result code returned by the command handler is
969 * @param command The command being executed
970 * @param parameters An array of array of characters containing the parameters for the command
971 * @param pcnt The nuimber of parameters passed to the command
972 * @param user the user issuing the command
973 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
974 * @param original_line The entire original line as passed to the parser from the user
976 virtual void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, User *user, CmdResult result, const std::string &original_line);
978 /** Called to check if a user who is connecting can now be allowed to register
979 * If any modules return false for this function, the user is held in the waiting
980 * state until all modules return true. For example a module which implements ident
981 * lookups will continue to return false for a user until their ident lookup is completed.
982 * Note that the registration timeout for a user overrides these checks, if the registration
983 * timeout is reached, the user is disconnected even if modules report that the user is
984 * not ready to connect.
985 * @param user The user to check
986 * @return true to indicate readiness, false if otherwise
988 virtual ModResult OnCheckReady(User* user);
990 /** Called whenever a user is about to register their connection (e.g. before the user
991 * is sent the MOTD etc). Modules can use this method if they are performing a function
992 * which must be done before the actual connection is completed (e.g. ident lookups,
993 * dnsbl lookups, etc).
994 * Note that you should NOT delete the user record here by causing a disconnection!
995 * Use OnUserConnect for that instead.
996 * @param user The user registering
997 * @return 1 to indicate user quit, 0 to continue
999 virtual ModResult OnUserRegister(User* user);
1001 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1002 * This method will always be called for each join, wether or not the channel is actually +i, and
1003 * determines the outcome of an if statement around the whole section of invite checking code.
1004 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1005 * @param user The user joining the channel
1006 * @param chan The channel being joined
1007 * @return 1 to explicitly allow the join, 0 to proceed as normal
1009 virtual ModResult OnCheckInvite(User* user, Channel* chan);
1011 /** Called whenever a mode character is processed.
1012 * Return 1 from this function to block the mode character from being processed entirely.
1013 * @param user The user who is sending the mode
1014 * @param chan The channel the mode is being sent to (or NULL if a usermode)
1015 * @param mode The mode character being set
1016 * @param param The parameter for the mode or an empty string
1017 * @param adding true of the mode is being added, false if it is being removed
1018 * @param pcnt The parameter count for the mode (0 or 1)
1019 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
1020 * to skip all permission checking. Please note that for remote mode changes, your return value
1023 virtual ModResult OnRawMode(User* user, Channel* chan, const char mode, const std::string ¶m, bool adding, int pcnt);
1025 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1026 * This method will always be called for each join, wether or not the channel is actually +k, and
1027 * determines the outcome of an if statement around the whole section of key checking code.
1028 * if the user specified no key, the keygiven string will be a valid but empty value.
1029 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1030 * @param user The user joining the channel
1031 * @param chan The channel being joined
1032 * @return 1 to explicitly allow the join, 0 to proceed as normal
1034 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
1036 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1037 * This method will always be called for each join, wether or not the channel is actually +l, and
1038 * determines the outcome of an if statement around the whole section of channel limit checking code.
1039 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1040 * @param user The user joining the channel
1041 * @param chan The channel being joined
1042 * @return 1 to explicitly allow the join, 0 to proceed as normal
1044 virtual ModResult OnCheckLimit(User* user, Channel* chan);
1047 * Checks for a user's ban from the channel
1048 * @param user The user to check
1049 * @param chan The channel to check in
1050 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1051 * ban check, or MOD_RES_PASSTHRU to check bans normally
1053 virtual ModResult OnCheckChannelBan(User* user, Channel* chan);
1056 * Checks for a user's match of a single ban
1057 * @param user The user to check for match
1058 * @param chan The channel on which the match is being checked
1059 * @param mask The mask being checked
1060 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1061 * ban check, or MOD_RES_PASSTHRU to check bans normally
1063 virtual ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask);
1065 /** Checks for a match on a given extban type
1066 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1067 * ban check, or MOD_RES_PASSTHRU to check bans normally
1069 virtual ModResult OnExtBanCheck(User* user, Channel* chan, char type);
1071 /** Called on all /STATS commands
1072 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1073 * @param symbol the symbol provided to /STATS
1074 * @param user the user issuing the /STATS command
1075 * @param results A string_list to append results into. You should put all your results
1076 * into this string_list, rather than displaying them directly, so that your handler will
1077 * work when remote STATS queries are received.
1078 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1080 virtual ModResult OnStats(char symbol, User* user, string_list &results);
1082 /** Called whenever a change of a local users displayed host is attempted.
1083 * Return 1 to deny the host change, or 0 to allow it.
1084 * @param user The user whos host will be changed
1085 * @param newhost The new hostname
1086 * @return 1 to deny the host change, 0 to allow
1088 virtual ModResult OnChangeLocalUserHost(User* user, const std::string &newhost);
1090 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1091 * return 1 to deny the name change, or 0 to allow it.
1092 * @param user The user whos GECOS will be changed
1093 * @param newhost The new GECOS
1094 * @return 1 to deny the GECOS change, 0 to allow
1096 virtual ModResult OnChangeLocalUserGECOS(User* user, const std::string &newhost);
1098 /** Called before a topic is changed.
1099 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
1100 * As with other 'pre' events, you should only ever block a local event.
1101 * @param user The user changing the topic
1102 * @param chan The channels who's topic is being changed
1103 * @param topic The actual topic text
1104 * @param 1 to block the topic change, 0 to allow
1106 virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
1108 /** Called whenever a topic has been changed.
1109 * To block topic changes you must use OnPreTopicChange instead.
1110 * @param user The user changing the topic
1111 * @param chan The channels who's topic is being changed
1112 * @param topic The actual topic text
1114 virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
1116 /** Called whenever an Event class is sent to all modules by another module.
1117 * You should *always* check the value of Event::id to determine the event type.
1118 * @param event The Event class being received
1120 virtual void OnEvent(Event& event);
1122 /** Called whenever a Request class is sent to your module by another module.
1123 * The value of Request::id should be used to determine the type of request.
1124 * @param request The Request class being received
1126 virtual void OnRequest(Request& request);
1128 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
1129 * The password field (from the config file) is in 'password' and is to be compared against
1130 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
1131 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
1132 * @param ex The object that's causing the authentication (User* for <oper> <connect:allow> etc, Server* for <link>).
1133 * @param password The password from the configuration file (the password="" value).
1134 * @param input The password entered by the user or whoever.
1135 * @param hashtype The hash value from the config
1136 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
1138 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
1140 /** Called whenever a user is given usermode +o, anywhere on the network.
1141 * You cannot override this and prevent it from happening as it is already happened and
1142 * such a task must be performed by another server. You can however bounce modes by sending
1143 * servermodes out to reverse mode changes.
1144 * @param user The user who is opering
1146 virtual void OnGlobalOper(User* user);
1148 /** Called after a user has fully connected and all modules have executed OnUserConnect
1149 * This event is informational only. You should not change any user information in this
1150 * event. To do so, use the OnUserConnect method to change the state of local users.
1151 * This is called for both local and remote users.
1152 * @param user The user who is connecting
1154 virtual void OnPostConnect(User* user);
1156 /** Called whenever a ban is added to a channel's list.
1157 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1158 * @param source The user adding the ban
1159 * @param channel The channel the ban is being added to
1160 * @param banmask The ban mask being added
1161 * @return 1 to block the ban, 0 to continue as normal
1163 virtual ModResult OnAddBan(User* source, Channel* channel,const std::string &banmask);
1165 /** Called whenever a ban is removed from a channel's list.
1166 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1167 * @param source The user deleting the ban
1168 * @param channel The channel the ban is being deleted from
1169 * @param banmask The ban mask being deleted
1170 * @return 1 to block the unban, 0 to continue as normal
1172 virtual ModResult OnDelBan(User* source, Channel* channel,const std::string &banmask);
1174 /** Called to install an I/O hook on an event handler
1175 * @param user The item to possibly install the I/O hook on
1176 * @param via The port that <user> connected on
1178 virtual void OnHookIO(StreamSocket*, ListenSocketBase* via);
1180 /** Called immediately after any connection is accepted. This is intended for raw socket
1181 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1182 * no information relating to a user record as the connection has not been assigned yet.
1183 * There are no return values from this call as all modules get an opportunity if required to
1184 * process the connection.
1185 * @param fd The file descriptor returned from accept()
1186 * @param client The client IP address and port
1187 * @param server The server IP address and port
1188 * @param localport The local port number the user connected to
1190 virtual void OnStreamSocketAccept(StreamSocket*, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
1193 * Called when a hooked stream has data to write, or when the socket
1194 * engine returns it as writable
1195 * @param socket The socket in question
1196 * @param sendq Data to send to the socket
1197 * @return 1 if the sendq has been completely emptied, 0 if there is
1198 * still data to send, and -1 if there was an error
1200 virtual int OnStreamSocketWrite(StreamSocket*, std::string& sendq);
1202 /** Called immediately before any socket is closed. When this event is called, shutdown()
1203 * has not yet been called on the socket.
1204 * @param fd The file descriptor of the socket prior to close()
1206 virtual void OnStreamSocketClose(StreamSocket*);
1208 /** Called immediately upon connection of an outbound BufferedSocket which has been hooked
1210 * @param fd The file descriptor of the socket immediately after connect()
1212 virtual void OnStreamSocketConnect(StreamSocket*);
1215 * Called when the stream socket has data to read
1216 * @param socket The socket that is ready
1217 * @param recvq The receive queue that new data should be appended to
1218 * @return 1 if new data has been read, 0 if no new data is ready (but the
1219 * socket is still connected), -1 if there was an error or close
1221 virtual int OnStreamSocketRead(StreamSocket*, std::string& recvq);
1223 /** Called whenever a user sets away or returns from being away.
1224 * The away message is available as a parameter, but should not be modified.
1225 * At this stage, it has already been copied into the user record.
1226 * If awaymsg is empty, the user is returning from away.
1227 * @param user The user setting away
1228 * @param awaymsg The away message of the user, or empty if returning from away
1229 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
1231 virtual ModResult OnSetAway(User* user, const std::string &awaymsg);
1233 /** Called whenever a NAMES list is requested.
1234 * You can produce the nameslist yourself, overriding the current list,
1235 * and if you do you must return 1. If you do not handle the names list,
1237 * @param The user requesting the NAMES list
1238 * @param Ptr The channel the NAMES list is requested for
1240 virtual ModResult OnUserList(User* user, Channel* Ptr);
1242 /** Called whenever a line of WHOIS output is sent to a user.
1243 * You may change the numeric and the text of the output by changing
1244 * the values numeric and text, but you cannot change the user the
1245 * numeric is sent to. You may however change the user's User values.
1246 * @param user The user the numeric is being sent to
1247 * @param dest The user being WHOISed
1248 * @param numeric The numeric of the line being sent
1249 * @param text The text of the numeric, including any parameters
1250 * @return nonzero to drop the line completely so that the user does not
1251 * receive it, or zero to allow the line to be sent.
1253 virtual ModResult OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
1255 /** Called at intervals for modules to garbage-collect any hashes etc.
1256 * Certain data types such as hash_map 'leak' buckets, which must be
1257 * tidied up and freed by copying into a new item every so often. This
1258 * method is called when it is time to do that.
1260 virtual void OnGarbageCollect();
1262 /** Add test suite hooks here. These are used for testing functionality of a module
1263 * via the --testsuite debugging parameter.
1265 virtual void OnRunTestSuite();
1267 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
1268 * For example NAMESX, channel mode +u and +I, and UHNAMES. If the nick is set to an empty string by any
1269 * module, then this will cause the nickname not to be displayed at all.
1271 virtual void OnNamesListItem(User* issuer, Membership* item, std::string &prefixes, std::string &nick);
1273 virtual ModResult OnNumeric(User* user, unsigned int numeric, const std::string &text);
1275 /** Called whenever a result from /WHO is about to be returned
1276 * @param source The user running the /WHO query
1277 * @param user The user that this line of the query is about
1278 * @param channel The channel being queried (or NULL if not a channel query)
1279 * @param line The raw line to send; modifiable, if empty no line will be returned.
1281 virtual void OnSendWhoLine(User* source, User* user, Channel* channel, std::string& line);
1285 #define CONF_NO_ERROR 0x000000
1286 #define CONF_NOT_A_NUMBER 0x000010
1287 #define CONF_INT_NEGATIVE 0x000080
1288 #define CONF_VALUE_NOT_FOUND 0x000100
1289 #define CONF_FILE_NOT_FOUND 0x000200
1292 /** Allows reading of values from configuration files
1293 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1294 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1295 * Constructing the class using one parameter allows you to specify a path to your own configuration
1296 * file, otherwise, inspircd.conf is read.
1298 class CoreExport ConfigReader : public classbase
1306 /** Default constructor.
1307 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1308 * as specified when running ./configure.
1311 /** Default destructor.
1312 * This method destroys the ConfigReader class.
1316 /** Retrieves a value from the config file.
1317 * This method retrieves a value from the config file. Where multiple copies of the tag
1318 * exist in the config file, index indicates which of the values to retrieve.
1320 std::string ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds = false);
1321 /** Retrieves a value from the config file.
1322 * This method retrieves a value from the config file. Where multiple copies of the tag
1323 * exist in the config file, index indicates which of the values to retrieve. If the
1324 * tag is not found the default value is returned instead.
1326 std::string ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds = false);
1328 /** Retrieves a boolean value from the config file.
1329 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1330 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1331 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1333 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1334 /** Retrieves a boolean value from the config file.
1335 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1336 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1337 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1338 * If the tag is not found, the default value is used instead.
1340 bool ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index);
1342 /** Retrieves an integer value from the config file.
1343 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1344 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1345 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1346 * return CONF_INVALID_NUMBER to be returned. need_positive is set if the number must be non-negative.
1347 * If a negative number is placed into a tag which is specified positive, 0 will be returned and GetError()
1348 * will return CONF_INT_NEGATIVE. Note that need_positive is not suitable to get an unsigned int - you
1349 * should cast the result to achieve that effect.
1351 int ReadInteger(const std::string &tag, const std::string &name, int index, bool need_positive);
1352 /** Retrieves an integer value from the config file.
1353 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1354 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1355 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1356 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1357 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1358 * will return CONF_NOT_UNSIGNED. If the tag is not found, the default value is used instead.
1360 int ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool need_positive);
1362 /** Returns the last error to occur.
1363 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1364 * A call to GetError() resets the error flag back to 0.
1367 /** Counts the number of times a given tag appears in the config file.
1368 * This method counts the number of times a tag appears in a config file, for use where
1369 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1370 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1371 * multiple instance tag.
1373 int Enumerate(const std::string &tag);
1375 /** Returns the number of items within a tag.
1376 * For example if the tag was <test tag="blah" data="foo"> then this
1377 * function would return 2. Spaces and newlines both qualify as valid seperators
1380 int EnumerateValues(const std::string &tag, int index);
1385 /** Caches a text file into memory and can be used to retrieve lines from it.
1386 * This class contains methods for read-only manipulation of a text file in memory.
1387 * Either use the constructor type with one parameter to load a file into memory
1388 * at construction, or use the LoadFile method to load a file.
1390 class CoreExport FileReader : public classbase
1392 /** The file contents
1396 /** Content size in bytes
1398 unsigned long contentsize;
1400 /** Calculate content size in bytes
1405 /** Default constructor.
1406 * This method does not load any file into memory, you must use the LoadFile method
1407 * after constructing the class this way.
1411 /** Secondary constructor.
1412 * This method initialises the class with a file loaded into it ready for GetLine and
1413 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1416 FileReader(const std::string &filename);
1418 /** Default destructor.
1419 * This deletes the memory allocated to the file.
1423 /** Used to load a file.
1424 * This method loads a file into the class ready for GetLine and
1425 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1428 void LoadFile(const std::string &filename);
1430 /** Returns the whole content of the file as std::string
1432 std::string Contents();
1434 /** Returns the entire size of the file as std::string
1436 unsigned long ContentSize();
1438 /** Returns true if the file exists
1439 * This function will return false if the file could not be opened.
1443 /** Retrieve one line from the file.
1444 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1445 * the index was out of bounds, or the line had no data on it.
1447 std::string GetLine(int x);
1449 /** Returns the size of the file in lines.
1450 * This method returns the number of lines in the read file. If it is 0, no lines have been
1451 * read into memory, either because the file is empty or it does not exist, or cannot be
1452 * opened due to permission problems.
1457 /** A list of modules
1459 typedef std::vector<Module*> IntModuleList;
1461 /** An event handler iterator
1463 typedef IntModuleList::iterator EventHandlerIter;
1465 /** ModuleManager takes care of all things module-related
1468 class CoreExport ModuleManager : public classbase
1471 /** Holds a string describing the last module error to occur
1473 std::string LastModuleError;
1475 /** The feature names published by various modules
1477 featurelist Features;
1479 /** The interface names published by various modules
1481 interfacelist Interfaces;
1483 /** Total number of modules loaded into the ircd
1487 /** List of loaded modules and shared object/dll handles
1488 * keyed by module name
1490 std::map<std::string, Module*> Modules;
1496 } prioritizationState;
1499 /** Event handler hooks.
1500 * This needs to be public to be used by FOREACH_MOD and friends.
1502 IntModuleList EventHandlers[I_END];
1504 /** Simple, bog-standard, boring constructor.
1512 /** Change the priority of one event in a module.
1513 * Each module event has a list of modules which are attached to that event type.
1514 * If you wish to be called before or after other specific modules, you may use this
1515 * method (usually within void Module::Prioritize()) to set your events priority.
1516 * You may use this call in other methods too, however, this is not supported behaviour
1518 * @param mod The module to change the priority of
1519 * @param i The event to change the priority of
1520 * @param s The state you wish to use for this event. Use one of
1521 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1522 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1523 * to set it to be before or after one or more other modules.
1524 * @param modules If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1525 * then this contains a list of one or more modules your module must be
1526 * placed before or after. Your module will be placed before the highest
1527 * priority module in this list for PRIO_BEFORE, or after the lowest
1528 * priority module in this list for PRIORITY_AFTER.
1529 * @param sz The number of modules being passed for PRIO_BEFORE and PRIORITY_AFTER.
1530 * Defaults to 1, as most of the time you will only want to prioritize your module
1531 * to be before or after one other module.
1533 bool SetPriority(Module* mod, Implementation i, Priority s, Module** modules = NULL, size_t sz = 1);
1535 /** Change the priority of all events in a module.
1536 * @param mod The module to set the priority of
1537 * @param s The priority of all events in the module.
1538 * Note that with this method, it is not possible to effectively use
1539 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1540 * SetPriority method for this, where you may specify other modules to
1541 * be prioritized against.
1543 bool SetPriority(Module* mod, Priority s);
1545 /** Attach an event to a module.
1546 * You may later detatch the event with ModuleManager::Detach().
1547 * If your module is unloaded, all events are automatically detatched.
1548 * @param i Event type to attach
1549 * @param mod Module to attach event to
1550 * @return True if the event was attached
1552 bool Attach(Implementation i, Module* mod);
1554 /** Detatch an event from a module.
1555 * This is not required when your module unloads, as the core will
1556 * automatically detatch your module from all events it is attached to.
1557 * @param i Event type to detach
1558 * @param mod Module to detach event from
1559 * @param Detach true if the event was detached
1561 bool Detach(Implementation i, Module* mod);
1563 /** Attach an array of events to a module
1564 * @param i Event types (array) to attach
1565 * @param mod Module to attach events to
1567 void Attach(Implementation* i, Module* mod, size_t sz);
1569 /** Detach all events from a module (used on unload)
1570 * @param mod Module to detach from
1572 void DetachAll(Module* mod);
1574 /** Returns text describing the last module error
1575 * @return The last error message to occur
1577 std::string& LastError();
1579 /** Load a given module file
1580 * @param filename The file to load
1581 * @return True if the module was found and loaded
1583 bool Load(const char* filename);
1585 /** Unload a given module file
1586 * @param filename The file to unload
1587 * @return True if the module was unloaded
1589 bool Unload(const char* filename);
1591 /** Called by the InspIRCd constructor to load all modules from the config file.
1595 /** Get the total number of currently loaded modules
1596 * @return The number of loaded modules
1600 return this->ModCount;
1603 /** Find a module by name, and return a Module* to it.
1604 * This is preferred over iterating the module lists yourself.
1605 * @param name The module name to look up
1606 * @return A pointer to the module, or NULL if the module cannot be found
1608 Module* Find(const std::string &name);
1610 /** Publish a 'feature'.
1611 * There are two ways for a module to find another module it depends on.
1612 * Either by name, using InspIRCd::FindModule, or by feature, using this
1613 * function. A feature is an arbitary string which identifies something this
1614 * module can do. For example, if your module provides SSL support, but other
1615 * modules provide SSL support too, all the modules supporting SSL should
1616 * publish an identical 'SSL' feature. This way, any module requiring use
1617 * of SSL functions can just look up the 'SSL' feature using FindFeature,
1618 * then use the module pointer they are given.
1619 * @param FeatureName The case sensitive feature name to make available
1620 * @param Mod a pointer to your module class
1621 * @returns True on success, false if the feature is already published by
1624 bool PublishFeature(const std::string &FeatureName, Module* Mod);
1626 /** Publish a module to an 'interface'.
1627 * Modules which implement the same interface (the same way of communicating
1628 * with other modules) can publish themselves to an interface, using this
1629 * method. When they do so, they become part of a list of related or
1630 * compatible modules, and a third module may then query for that list
1631 * and know that all modules within that list offer the same API.
1632 * A prime example of this is the hashing modules, which all accept the
1633 * same types of Request class. Consider this to be similar to PublishFeature,
1634 * except for that multiple modules may publish the same 'feature'.
1635 * @param InterfaceName The case sensitive interface name to make available
1636 * @param Mod a pointer to your module class
1637 * @returns True on success, false on failure (there are currently no failure
1640 bool PublishInterface(const std::string &InterfaceName, Module* Mod);
1642 /** Return a pair saying how many other modules are currently using the
1643 * interfaces provided by module m.
1644 * @param m The module to count usage for
1645 * @return A pair, where the first value is the number of uses of the interface,
1646 * and the second value is the interface name being used.
1648 std::pair<int,std::string> GetInterfaceInstanceCount(Module* m);
1650 /** Mark your module as using an interface.
1651 * If you mark your module as using an interface, then that interface
1652 * module may not unload until your module has unloaded first.
1653 * This can be used to prevent crashes by ensuring code you depend on
1654 * is always in memory while your module is active.
1655 * @param InterfaceName The interface to use
1657 void UseInterface(const std::string &InterfaceName);
1659 /** Mark your module as finished with an interface.
1660 * If you used UseInterface() above, you should use this method when
1661 * your module is finished with the interface (usually in its destructor)
1662 * to allow the modules which implement the given interface to be unloaded.
1663 * @param InterfaceName The interface you are finished with using.
1665 void DoneWithInterface(const std::string &InterfaceName);
1667 /** Unpublish a 'feature'.
1668 * When your module exits, it must call this method for every feature it
1669 * is providing so that the feature table is cleaned up.
1670 * @param FeatureName the feature to remove
1672 bool UnpublishFeature(const std::string &FeatureName);
1674 /** Unpublish your module from an interface
1675 * When your module exits, it must call this method for every interface
1676 * it is part of so that the interfaces table is cleaned up. Only when
1677 * the last item is deleted from an interface does the interface get
1679 * @param InterfaceName the interface to be removed from
1680 * @param Mod The module to remove from the interface list
1682 bool UnpublishInterface(const std::string &InterfaceName, Module* Mod);
1684 /** Find a 'feature'.
1685 * There are two ways for a module to find another module it depends on.
1686 * Either by name, using InspIRCd::FindModule, or by feature, using the
1687 * InspIRCd::PublishFeature method. A feature is an arbitary string which
1688 * identifies something this module can do. For example, if your module
1689 * provides SSL support, but other modules provide SSL support too, all
1690 * the modules supporting SSL should publish an identical 'SSL' feature.
1691 * To find a module capable of providing the feature you want, simply
1692 * call this method with the feature name you are looking for.
1693 * @param FeatureName The feature name you wish to obtain the module for
1694 * @returns A pointer to a valid module class on success, NULL on failure.
1696 Module* FindFeature(const std::string &FeatureName);
1698 /** Find an 'interface'.
1699 * An interface is a list of modules which all implement the same API.
1700 * @param InterfaceName The Interface you wish to obtain the module
1702 * @return A pointer to a deque of Module*, or NULL if the interface
1705 modulelist* FindInterface(const std::string &InterfaceName);
1707 /** Determine if a module has published the named interface.
1708 * This could be used in, for example, OnLoadModule to pick up other modules that can be used.
1709 * @param mod The module to check.
1710 * @param InterfaceName the interface you want to check for
1711 * @return True if the module provides the interface, false otherwise.
1713 bool ModuleHasInterface(Module* mod, const std::string& InterfaceName);
1715 /** Given a pointer to a Module, return its filename
1716 * @param m The module pointer to identify
1717 * @return The module name or an empty string
1719 const std::string& GetModuleName(Module* m);
1721 /** Return a list of all modules matching the given filter
1722 * @param filter This int is a bitmask of flags set in Module::Flags,
1723 * such as VF_VENDOR or VF_STATIC. If you wish to receive a list of
1724 * all modules with no filtering, set this to 0.
1725 * @return The list of module names
1727 const std::vector<std::string> GetAllModuleNames(int filter);
1730 /** This definition is used as shorthand for the various classes
1731 * and functions needed to make a module loadable by the OS.
1732 * It defines the class factory and external init_module function.
1736 #define MODULE_INIT(y) \
1737 extern "C" DllExport Module * init_module() \
1741 BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
1743 switch ( nReason ) \
1745 case DLL_PROCESS_ATTACH: \
1746 case DLL_PROCESS_DETACH: \
1754 #define MODULE_INIT(y) \
1755 extern "C" DllExport Module * init_module() \
1761 #define COMMAND_INIT(c) MODULE_INIT(CommandModule<c>)