1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2010 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
20 #include "inspsocket.h"
28 /** Used to define a set of behavior bits for a module
31 VF_NONE = 0, // module is not special at all
32 VF_STATIC = 1, // module is static, cannot be /unloadmodule'd
33 VF_VENDOR = 2, // module is a vendor module (came in the original tarball, not 3rd party)
34 VF_COMMON = 4, // module needs to be common on all servers in a network to link
35 VF_OPTCOMMON = 8, // module should be common on all servers for unsurprising behavior
36 VF_CORE = 16 // module is a core command, can be assumed loaded on all servers
39 /** Used to represent an event type, for user, channel or server
41 enum TargetTypeFlags {
48 /** Used to represent wether a message was PRIVMSG or NOTICE
55 #define MOD_RES_ALLOW (ModResult(1))
56 #define MOD_RES_PASSTHRU (ModResult(0))
57 #define MOD_RES_DENY (ModResult(-1))
59 /** Used to represent an allow/deny module result.
60 * Not constructed as an enum because it reverses the value logic of some functions;
61 * the compiler will inline accesses to have the same efficiency as integer operations.
65 ModResult() : res(0) {}
66 explicit ModResult(int r) : res(r) {}
67 inline bool operator==(const ModResult& r) const
71 inline bool operator!=(const ModResult& r) const
75 inline bool operator!() const
79 inline bool check(bool def) const
81 return (res == 1 || (res == 0 && def));
84 * Merges two results, preferring ALLOW to DENY
86 inline ModResult operator+(const ModResult& r) const
88 if (res == r.res || r.res == 0)
92 // they are different, and neither is passthru
97 /** InspIRCd major version.
98 * 1.2 -> 102; 2.1 -> 201; 2.12 -> 212
100 #define INSPIRCD_VERSION_MAJ 200
101 /** InspIRCd API version.
102 * If you change any API elements, increment this value. This counter should be
103 * reset whenever the major version is changed. Modules can use these two values
104 * and numerical comparisons in preprocessor macros if they wish to support
105 * multiple versions of InspIRCd in one file.
107 #define INSPIRCD_VERSION_API 1
110 * This #define allows us to call a method in all
111 * loaded modules in a readable simple way, e.g.:
112 * 'FOREACH_MOD(I_OnConnect,OnConnect(user));'
114 #define FOREACH_MOD(y,x) do { \
115 EventHandlerIter safei; \
116 for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ) \
124 catch (CoreException& modexcept) \
126 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
133 * Custom module result handling loop. This is a paired macro, and should only
134 * be used with while_each_hook.
136 * See src/channels.cpp for an example of use.
138 #define DO_EACH_HOOK(n,v,args) \
140 EventHandlerIter iter_ ## n = ServerInstance->Modules->EventHandlers[I_ ## n].begin(); \
141 while (iter_ ## n != ServerInstance->Modules->EventHandlers[I_ ## n].end()) \
143 Module* mod_ ## n = *iter_ ## n; \
147 v = (mod_ ## n)->n args;
149 #define WHILE_EACH_HOOK(n) \
151 catch (CoreException& except_ ## n) \
153 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s", (except_ ## n).GetReason()); \
154 (void) mod_ ## n; /* catch mismatched pairs */ \
160 * Module result iterator
161 * Runs the given hook until some module returns a useful result.
163 * Example: ModResult result;
164 * FIRST_MOD_RESULT(OnUserPreNick, result, (user, newnick))
166 #define FIRST_MOD_RESULT(n,v,args) do { \
167 v = MOD_RES_PASSTHRU; \
168 DO_EACH_HOOK(n,v,args) \
170 if (v != MOD_RES_PASSTHRU) \
173 WHILE_EACH_HOOK(n); \
176 /** Holds a module's Version information.
177 * The members (set by the constructor only) indicate details as to the version number
178 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
180 class CoreExport Version
183 /** Module description
185 const std::string description;
191 /** Server linking description string */
192 const std::string link_data;
194 /** Simple module version */
195 Version(const std::string &desc, int flags = VF_NONE);
197 /** Complex version information, including linking compatability data */
198 Version(const std::string &desc, int flags, const std::string& linkdata);
200 virtual ~Version() {}
203 /** The Request class is a unicast message directed at a given module.
204 * When this class is properly instantiated it may be sent to a module
205 * using the Send() method, which will call the given module's OnRequest
206 * method with this class as its parameter.
208 class CoreExport Request : public classbase
211 /** This should be a null-terminated string identifying the type of request,
212 * all modules should define this and use it to determine the nature of the
213 * request before they attempt to cast the Request in any way.
215 const char* const id;
216 /** This is a pointer to the sender of the message, which can be used to
217 * directly trigger events, or to create a reply.
220 /** The single destination of the Request
224 /** Create a new Request
225 * This is for the 'new' way of defining a subclass
226 * of Request and defining it in a common header,
227 * passing an object of your Request subclass through
228 * as a Request* and using the ID string to determine
229 * what to cast it back to and the other end.
231 Request(Module* src, Module* dst, const char* idstr);
232 /** Send the Request.
238 /** The Event class is a unicast message directed at all modules.
239 * When the class is properly instantiated it may be sent to all modules
240 * using the Send() method, which will trigger the OnEvent method in
241 * all modules passing the object as its parameter.
243 class CoreExport Event : public classbase
246 /** This is a pointer to the sender of the message, which can be used to
247 * directly trigger events, or to create a reply.
250 /** The event identifier.
251 * This is arbitary text which should be used to distinguish
252 * one type of event from another.
254 const std::string id;
256 /** Create a new Event
258 Event(Module* src, const std::string &eventid);
260 * The return result of an Event::Send() will always be NULL as
261 * no replies are expected.
266 class CoreExport DataProvider : public ServiceProvider
269 DataProvider(Module* Creator, const std::string& Name)
270 : ServiceProvider(Creator, Name, SERVICE_DATA) {}
273 class CoreExport dynamic_reference_base : public interfacebase
281 dynamic_reference_base(Module* Creator, const std::string& Name);
282 ~dynamic_reference_base();
283 inline void ClearCache() { value = NULL; }
284 inline const std::string& GetProvider() { return name; }
285 void SetProvider(const std::string& newname);
288 static void reset_all();
292 class dynamic_reference : public dynamic_reference_base
295 dynamic_reference(Module* Creator, const std::string& Name)
296 : dynamic_reference_base(Creator, Name) {}
297 inline T* operator->()
301 return static_cast<T*>(value);
305 /** Priority types which can be used by Module::Prioritize()
307 enum Priority { PRIORITY_FIRST, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
309 /** Implementation-specific flags which may be set in Module::Implements()
314 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash,
315 I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois,
316 I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick,
317 I_OnUserMessage, I_OnUserNotice, I_OnMode, I_OnGetServerDescription, I_OnSyncUser,
318 I_OnSyncChannel, I_OnDecodeMetaData, I_OnWallops, I_OnAcceptConnection, I_OnUserInit,
319 I_OnChangeHost, I_OnChangeName, I_OnAddLine, I_OnDelLine, I_OnExpireLine,
320 I_OnUserPostNick, I_OnPreMode, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule,
321 I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite,
322 I_OnRawMode, I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckChannelBan, I_OnExtBanCheck,
323 I_OnStats, I_OnChangeLocalUserHost, I_OnPreTopicChange,
324 I_OnPostTopicChange, I_OnEvent, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan,
325 I_OnDelBan, I_OnChangeLocalUserGECOS, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
326 I_OnPostOper, I_OnSyncNetwork, I_OnSetAway, I_OnPostCommand, I_OnPostJoin,
327 I_OnWhoisLine, I_OnBuildNeighborList, I_OnGarbageCollect, I_OnSetConnectClass,
328 I_OnText, I_OnPassCompare, I_OnRunTestSuite, I_OnNamesListItem, I_OnNumeric, I_OnHookIO,
329 I_OnPreRehash, I_OnModuleRehash, I_OnSendWhoLine, I_OnChangeIdent,
333 /** Base class for all InspIRCd modules
334 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
335 * its methods will be called when irc server events occur. class inherited from module must be
336 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
338 class CoreExport Module : public classbase, public usecountbase
341 /** File that this module was loaded from
343 std::string ModuleSourceFile;
344 /** Reference to the dlopen() value
346 DLLManager* ModuleDLLManager;
348 /** Default constructor.
349 * Creates a module class. Don't do any type of hook registration or checks
350 * for other modules here; do that in init().
355 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
357 virtual void init() {}
359 /** Clean up prior to destruction
360 * If you override, you must call this AFTER your module's cleanup
362 virtual CullResult cull();
364 /** Default destructor.
365 * destroys a module class
369 virtual void Prioritize()
373 /** Returns the version number of a Module.
374 * The method should return a Version object with its version information assigned via
377 virtual Version GetVersion() = 0;
379 /** Called when a user connects.
380 * The details of the connecting user are available to you in the parameter User *user
381 * @param user The user who is connecting
383 virtual void OnUserConnect(LocalUser* user);
385 /** Called when a user quits.
386 * The details of the exiting user are available to you in the parameter User *user
387 * This event is only called when the user is fully registered when they quit. To catch
388 * raw disconnections, use the OnUserDisconnect method.
389 * @param user The user who is quitting
390 * @param message The user's quit message (as seen by non-opers)
391 * @param oper_message The user's quit message (as seen by opers)
393 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
395 /** Called whenever a user's socket is closed.
396 * The details of the exiting user are available to you in the parameter User *user
397 * This event is called for all users, registered or not, as a cleanup method for modules
398 * which might assign resources to user, such as dns lookups, objects and sockets.
399 * @param user The user who is disconnecting
401 virtual void OnUserDisconnect(LocalUser* user);
403 /** Called whenever a channel is about to be deleted
404 * @param chan The channel being deleted
405 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
407 virtual ModResult OnChannelPreDelete(Channel *chan);
409 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
410 * @param chan The channel being deleted
412 virtual void OnChannelDelete(Channel* chan);
414 /** Called when a user joins a channel.
415 * The details of the joining user are available to you in the parameter User *user,
416 * and the details of the channel they have joined is available in the variable Channel *channel
417 * @param memb The channel membership being created
418 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
419 * to a channel due to the network sync.
420 * @param created This is true if the join created the channel
422 virtual void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list);
424 /** Called after a user joins a channel
425 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
427 * @param memb The channel membership created
429 virtual void OnPostJoin(Membership*);
431 /** Called when a user parts a channel.
432 * The details of the leaving user are available to you in the parameter User *user,
433 * and the details of the channel they have left is available in the variable Channel *channel
434 * @param memb The channel membership being destroyed
435 * @param partmessage The part message, or an empty string (may be modified)
437 virtual void OnUserPart(Membership* memb, std::string &partmessage, CUList& except_list);
439 /** Called on rehash.
440 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
441 * system. This is called in all cases -- including when this server will not execute the
442 * rehash because it is directed at a remote server.
444 * @param user The user performing the rehash, if any. If this is server initiated, the value of
445 * this variable will be NULL.
446 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
449 virtual void OnPreRehash(User* user, const std::string ¶meter);
451 /** Called on rehash.
452 * This method is called when a user initiates a module-specific rehash. This can be used to do
453 * expensive operations (such as reloading SSL certificates) that are not executed on a normal
454 * rehash for efficiency. A rehash of this type does not reload the core configuration.
456 * @param user The user performing the rehash.
457 * @param parameter The parameter given to REHASH
459 virtual void OnModuleRehash(User* user, const std::string ¶meter);
461 /** Called on rehash.
462 * This method is called after a rehash has completed. You should use it to reload any module
463 * configuration from the main configuration file.
464 * @param user The user that performed the rehash, if it was initiated by a user and that user
465 * is still connected.
467 virtual void OnRehash(User* user);
469 /** Called whenever a snotice is about to be sent to a snomask.
470 * snomask and type may both be modified; the message may not.
471 * @param snomask The snomask the message is going to (e.g. 'A')
472 * @param type The textual description the snomask will go to (e.g. 'OPER')
473 * @param message The text message to be sent via snotice
474 * @return 1 to block the snotice from being sent entirely, 0 else.
476 virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
478 /** Called whenever a user is about to join a channel, before any processing is done.
479 * Returning a value of 1 from this function stops the process immediately, causing no
480 * output to be sent to the user by the core. If you do this you must produce your own numerics,
481 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
482 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
486 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
487 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
488 * processing on the actual channel record at this point, however the channel NAME will still be passed in
489 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
490 * @param user The user joining the channel
491 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
492 * @param cname The channel name being joined. For new channels this is valid where chan is not.
493 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "o".
494 * You may alter this string to alter the user's modes on the channel.
495 * @param keygiven The key given to join the channel, or an empty string if none was provided
496 * @return 1 To prevent the join, 0 to allow it.
498 virtual ModResult OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string &privs, const std::string &keygiven);
500 /** Called whenever a user is about to be kicked.
501 * Returning a value of 1 from this function stops the process immediately, causing no
502 * output to be sent to the user by the core. If you do this you must produce your own numerics,
504 * @param source The user issuing the kick
505 * @param user The user being kicked
506 * @param chan The channel the user is being kicked from
507 * @param reason The kick reason
508 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
510 virtual ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason);
512 /** Called whenever a user is kicked.
513 * If this method is called, the kick is already underway and cannot be prevented, so
514 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
515 * @param source The user issuing the kick
516 * @param user The user being kicked
517 * @param chan The channel the user is being kicked from
518 * @param reason The kick reason
520 virtual void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except_list);
522 /** Called whenever a user opers locally.
523 * The User will contain the oper mode 'o' as this function is called after any modifications
524 * are made to the user's structure by the core.
525 * @param user The user who is opering up
526 * @param opertype The opers type name
528 virtual void OnOper(User* user, const std::string &opertype);
530 /** Called after a user opers locally.
531 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
532 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
533 * out the OPERTYPE, etc.
534 * @param user The user who is opering up
535 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
536 * @param opertype The opers type name
538 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
540 /** Called whenever a user types /INFO.
541 * The User will contain the information of the user who typed the command. Modules may use this
542 * method to output their own credits in /INFO (which is the ircd's version of an about box).
543 * It is purposefully not possible to modify any info that has already been output, or halt the list.
544 * You must write a 371 numeric to the user, containing your info in the following format:
546 * <nick> :information here
548 * @param user The user issuing /INFO
550 virtual void OnInfo(User* user);
552 /** Called whenever a /WHOIS is performed on a local user.
553 * The source parameter contains the details of the user who issued the WHOIS command, and
554 * the dest parameter contains the information of the user they are whoising.
555 * @param source The user issuing the WHOIS command
556 * @param dest The user who is being WHOISed
558 virtual void OnWhois(User* source, User* dest);
560 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
561 * Returning 1 from this function stops the process immediately, causing no
562 * output to be sent to the user by the core. If you do this you must produce your own numerics,
563 * notices etc. This is useful for modules which may want to filter invites to channels.
564 * @param source The user who is issuing the INVITE
565 * @param dest The user being invited
566 * @param channel The channel the user is being invited to
567 * @param timeout The time the invite will expire (0 == never)
568 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
570 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
572 /** Called after a user has been successfully invited to a channel.
573 * You cannot prevent the invite from occuring using this function, to do that,
574 * use OnUserPreInvite instead.
575 * @param source The user who is issuing the INVITE
576 * @param dest The user being invited
577 * @param channel The channel the user is being invited to
578 * @param timeout The time the invite will expire (0 == never)
580 virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout);
582 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
583 * Returning any nonzero value from this function stops the process immediately, causing no
584 * output to be sent to the user by the core. If you do this you must produce your own numerics,
585 * notices etc. This is useful for modules which may want to filter or redirect messages.
586 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
587 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
588 * of where the message is destined to be sent.
589 * @param user The user sending the message
590 * @param dest The target of the message (Channel* or User*)
591 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
592 * @param text Changeable text being sent by the user
593 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
594 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
595 * It will be ignored for private messages.
596 * @return 1 to deny the message, 0 to allow it
598 virtual ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
600 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
601 * Returning any nonzero value from this function stops the process immediately, causing no
602 * output to be sent to the user by the core. If you do this you must produce your own numerics,
603 * notices etc. This is useful for modules which may want to filter or redirect messages.
604 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
605 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
606 * of where the message is destined to be sent.
607 * You may alter the message text as you wish before relinquishing control to the next module
608 * in the chain, and if no other modules block the text this altered form of the text will be sent out
609 * to the user and possibly to other servers.
610 * @param user The user sending the message
611 * @param dest The target of the message (Channel* or User*)
612 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
613 * @param text Changeable text being sent by the user
614 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
615 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
616 * It will be ignored for private notices.
617 * @return 1 to deny the NOTICE, 0 to allow it
619 virtual ModResult OnUserPreNotice(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
621 /** Called when sending a message to all "neighbors" of a given user -
622 * that is, all users that share a common channel. This is used in
623 * commands such as NICK, QUIT, etc.
624 * @param source The source of the message
625 * @param include_c Channels to scan for users to include
626 * @param exceptions Map of user->bool that overrides the inclusion decision
628 * Set exceptions[user] = true to include, exceptions[user] = false to exclude
630 virtual void OnBuildNeighborList(User* source, UserChanList &include_c, std::map<User*,bool> &exceptions);
632 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
633 * Please note that although you can see remote nickchanges through this function, you should
634 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
635 * check user->server before taking any action (including returning nonzero from the method).
636 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
637 * module to generate some meaninful output.
638 * @param user The username changing their nick
639 * @param newnick Their new nickname
640 * @return 1 to deny the change, 0 to allow
642 virtual ModResult OnUserPreNick(User* user, const std::string &newnick);
644 /** Called after any PRIVMSG sent from a user.
645 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
646 * if target_type is TYPE_CHANNEL.
647 * @param user The user sending the message
648 * @param dest The target of the message
649 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
650 * @param text the text being sent by the user
651 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
653 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
655 /** Called after any NOTICE sent from a user.
656 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
657 * if target_type is TYPE_CHANNEL.
658 * @param user The user sending the message
659 * @param dest The target of the message
660 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
661 * @param text the text being sent by the user
662 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
664 virtual void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
666 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
667 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
668 * if target_type is TYPE_CHANNEL.
669 * The difference between this event and OnUserPreNotice/OnUserPreMessage is that delivery is gauranteed,
670 * the message has already been vetted. In the case of the other two methods, a later module may stop your
671 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
672 * @param user The user sending the message
673 * @param dest The target of the message
674 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
675 * @param text the text being sent by the user
676 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
678 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
680 /** Called after every MODE command sent from a user
681 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
682 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
683 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
684 * @param user The user sending the MODEs
685 * @param dest The target of the modes (User* or Channel*)
686 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
687 * @param text The actual modes and their parameters if any
688 * @param translate The translation types of the mode parameters
690 virtual void OnMode(User* user, void* dest, int target_type, const std::vector<std::string> &text, const std::vector<TranslateType> &translate);
692 /** Allows modules to alter or create server descriptions
693 * Whenever a module requires a server description, for example for display in
694 * WHOIS, this function is called in all modules. You may change or define the
695 * description given in std::string &description. If you do, this description
696 * will be shown in the WHOIS fields.
697 * @param servername The servername being searched for
698 * @param description Alterable server description for this server
700 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
702 /** Allows modules to synchronize data which relates to users during a netburst.
703 * When this function is called, it will be called from the module which implements
704 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
705 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
706 * (see below). This function will be called for every user visible on your side
707 * of the burst, allowing you to for example set modes, etc. Do not use this call to
708 * synchronize data which you have stored using class Extensible -- There is a specialist
709 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
710 * @param user The user being syncronized
711 * @param proto A pointer to the module handling network protocol
712 * @param opaque An opaque pointer set by the protocol module, should not be modified!
714 virtual void OnSyncUser(User* user, Module* proto, void* opaque);
716 /** Allows modules to synchronize data which relates to channels during a netburst.
717 * When this function is called, it will be called from the module which implements
718 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
719 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
720 * (see below). This function will be called for every user visible on your side
721 * of the burst, allowing you to for example set modes, etc.
723 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
725 * @param chan The channel being syncronized
726 * @param proto A pointer to the module handling network protocol
727 * @param opaque An opaque pointer set by the protocol module, should not be modified!
729 virtual void OnSyncChannel(Channel* chan, Module* proto, void* opaque);
731 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
732 * Whenever the linking module wants to send out data, but doesnt know what the data
733 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
734 * this method is called. You should use the ProtoSendMetaData function after you've
735 * correctly decided how the data should be represented, to send the metadata on its way if
736 * if it belongs to your module.
737 * @param proto A pointer to the module handling network protocol
738 * @param opaque An opaque pointer set by the protocol module, should not be modified!
739 * @param displayable If this value is true, the data is going to be displayed to a user,
740 * and not sent across the network. Use this to determine wether or not to show sensitive data.
742 virtual void OnSyncNetwork(Module* proto, void* opaque);
744 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
745 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
746 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
747 * @param target The Channel* or User* that data should be added to
748 * @param extname The extension name which is being sent
749 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
751 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
753 /** Implemented by modules which provide the ability to link servers.
754 * These modules will implement this method, which allows transparent sending of servermodes
755 * down the network link as a broadcast, without a module calling it having to know the format
756 * of the MODE command before the actual mode string.
758 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
759 * of how to use this function.
761 * @param opaque An opaque pointer set by the protocol module, should not be modified!
762 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
763 * @param target The Channel* or User* that modes should be sent for
764 * @param modeline The modes and parameters to be sent
765 * @param translate The translation types of the mode parameters
767 virtual void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::vector<std::string> &modeline, const std::vector<TranslateType> &translate);
769 /** Implemented by modules which provide the ability to link servers.
770 * These modules will implement this method, which allows metadata (extra data added to
771 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
772 * to other servers on a netburst and decoded at the other end by the same module on a
775 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
776 * how to use this function.
777 * @param opaque An opaque pointer set by the protocol module, should not be modified!
778 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
779 * @param target The Channel* or User* that metadata should be sent for
780 * @param extname The extension name to send metadata for
781 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
783 virtual void ProtoSendMetaData(void* opaque, Extensible* target, const std::string &extname, const std::string &extdata);
785 /** Called after every WALLOPS command.
786 * @param user The user sending the WALLOPS
787 * @param text The content of the WALLOPS message
789 virtual void OnWallops(User* user, const std::string &text);
791 /** Called whenever a user's hostname is changed.
792 * This event triggers after the host has been set.
793 * @param user The user whos host is being changed
794 * @param newhost The new hostname being set
796 virtual void OnChangeHost(User* user, const std::string &newhost);
798 /** Called whenever a user's GECOS (realname) is changed.
799 * This event triggers after the name has been set.
800 * @param user The user who's GECOS is being changed
801 * @param gecos The new GECOS being set on the user
803 virtual void OnChangeName(User* user, const std::string &gecos);
805 /** Called whenever a user's IDENT is changed.
806 * This event triggers after the name has been set.
807 * @param user The user who's IDENT is being changed
808 * @param gecos The new IDENT being set on the user
810 virtual void OnChangeIdent(User* user, const std::string &ident);
812 /** Called whenever an xline is added by a local user.
813 * This method is triggered after the line is added.
814 * @param source The sender of the line or NULL for local server
815 * @param line The xline being added
817 virtual void OnAddLine(User* source, XLine* line);
819 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
820 * This method is triggered after the line is deleted.
821 * @param source The user removing the line or NULL for local server
822 * @param line the line being deleted
824 virtual void OnDelLine(User* source, XLine* line);
826 /** Called whenever an xline expires.
827 * This method is triggered after the line is deleted.
828 * @param line The line being deleted.
830 virtual void OnExpireLine(XLine *line);
832 /** Called before your module is unloaded to clean up Extensibles.
833 * This method is called once for every user and channel on the network,
834 * so that when your module unloads it may clear up any remaining data
835 * in the form of Extensibles added using Extensible::Extend().
836 * If the target_type variable is TYPE_USER, then void* item refers to
837 * a User*, otherwise it refers to a Channel*.
838 * @param target_type The type of item being cleaned
839 * @param item A pointer to the item's class
841 virtual void OnCleanup(int target_type, void* item);
843 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
844 * have been applied. Please note that although you can see remote nickchanges through this function, you should
845 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
846 * check user->server before taking any action (including returning nonzero from the method).
847 * Because this method is called after the nickchange is taken place, no return values are possible
848 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
849 * @param user The user changing their nick
850 * @param oldnick The old nickname of the user before the nickchange
852 virtual void OnUserPostNick(User* user, const std::string &oldnick);
854 /** Called before any mode change, to allow a single access check for
855 * a full mode change (use OnRawMode to check individual modes)
857 * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
858 * OnRawMode for each individual mode
860 * @param source the user making the mode change
861 * @param dest the user destination of the umode change (NULL if a channel mode)
862 * @param channel the channel destination of the mode change
863 * @param parameters raw mode parameters; parameters[0] is the user/channel being changed
865 virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, const std::vector<std::string>& parameters);
867 /** Called when a 005 numeric is about to be output.
868 * The module should modify the 005 numeric if needed to indicate its features.
869 * @param output The 005 string to be modified if neccessary.
871 virtual void On005Numeric(std::string &output);
873 /** Called when a client is disconnected by KILL.
874 * If a client is killed by a server, e.g. a nickname collision or protocol error,
876 * Return 1 from this function to prevent the kill, and 0 from this function to allow
877 * it as normal. If you prevent the kill no output will be sent to the client, it is
878 * down to your module to generate this information.
879 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
880 * If you do so youre risking race conditions, desyncs and worse!
881 * @param source The user sending the KILL
882 * @param dest The user being killed
883 * @param reason The kill reason
884 * @return 1 to prevent the kill, 0 to allow
886 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
888 /** Called when an oper wants to disconnect a remote user via KILL
889 * @param source The user sending the KILL
890 * @param dest The user being killed
891 * @param reason The kill reason
893 virtual void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
895 /** Called whenever a module is loaded.
896 * mod will contain a pointer to the module, and string will contain its name,
897 * for example m_widgets.so. This function is primary for dependency checking,
898 * your module may decide to enable some extra features if it sees that you have
899 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
900 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
901 * but instead operate under reduced functionality, unless the dependency is
902 * absolutely neccessary (e.g. a module that extends the features of another
904 * @param mod A pointer to the new module
906 virtual void OnLoadModule(Module* mod);
908 /** Called whenever a module is unloaded.
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 Pointer to the module being unloaded (still valid)
918 * @param name The filename of the module being unloaded
920 virtual void OnUnloadModule(Module* mod);
922 /** Called once every five seconds for background processing.
923 * This timer can be used to control timed features. Its period is not accurate
924 * enough to be used as a clock, but it is gauranteed to be called at least once in
925 * any five second period, directly from the main loop of the server.
926 * @param curtime The current timer derived from time(2)
928 virtual void OnBackgroundTimer(time_t curtime);
930 /** Called whenever any command is about to be executed.
931 * This event occurs for all registered commands, wether they are registered in the core,
932 * or another module, and for invalid commands. Invalid commands may only be sent to this
933 * function when the value of validated is false. By returning 1 from this method you may prevent the
934 * command being executed. If you do this, no output is created by the core, and it is
935 * down to your module to produce any output neccessary.
936 * Note that unless you return 1, you should not destroy any structures (e.g. by using
937 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
938 * method returns, it will be passed an invalid pointer to the user object and crash!)
939 * @param command The command being executed
940 * @param parameters An array of array of characters containing the parameters for the command
941 * @param pcnt The nuimber of parameters passed to the command
942 * @param user the user issuing the command
943 * @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.
944 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
945 * @param original_line The entire original line as passed to the parser from the user
946 * @return 1 to block the command, 0 to allow
948 virtual ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, LocalUser *user, bool validated, const std::string &original_line);
950 /** Called after any command has been executed.
951 * This event occurs for all registered commands, wether they are registered in the core,
952 * or another module, but it will not occur for invalid commands (e.g. ones which do not
953 * exist within the command table). The result code returned by the command handler is
955 * @param command The command being executed
956 * @param parameters An array of array of characters containing the parameters for the command
957 * @param pcnt The nuimber of parameters passed to the command
958 * @param user the user issuing the command
959 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
960 * @param original_line The entire original line as passed to the parser from the user
962 virtual void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, LocalUser *user, CmdResult result, const std::string &original_line);
964 /** Called when a user is first connecting, prior to starting DNS lookups, checking initial
965 * connect class, or accepting any commands.
967 virtual void OnUserInit(LocalUser* user);
969 /** Called to check if a user who is connecting can now be allowed to register
970 * If any modules return false for this function, the user is held in the waiting
971 * state until all modules return true. For example a module which implements ident
972 * lookups will continue to return false for a user until their ident lookup is completed.
973 * Note that the registration timeout for a user overrides these checks, if the registration
974 * timeout is reached, the user is disconnected even if modules report that the user is
975 * not ready to connect.
976 * @param user The user to check
977 * @return true to indicate readiness, false if otherwise
979 virtual ModResult OnCheckReady(LocalUser* user);
981 /** Called whenever a user is about to register their connection (e.g. before the user
982 * is sent the MOTD etc). Modules can use this method if they are performing a function
983 * which must be done before the actual connection is completed (e.g. ident lookups,
984 * dnsbl lookups, etc).
985 * Note that you should NOT delete the user record here by causing a disconnection!
986 * Use OnUserConnect for that instead.
987 * @param user The user registering
988 * @return 1 to indicate user quit, 0 to continue
990 virtual ModResult OnUserRegister(LocalUser* user);
992 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
993 * This method will always be called for each join, wether or not the channel is actually +i, and
994 * determines the outcome of an if statement around the whole section of invite checking code.
995 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
996 * @param user The user joining the channel
997 * @param chan The channel being joined
998 * @return 1 to explicitly allow the join, 0 to proceed as normal
1000 virtual ModResult OnCheckInvite(User* user, Channel* chan);
1002 /** Called whenever a mode character is processed.
1003 * Return 1 from this function to block the mode character from being processed entirely.
1004 * @param user The user who is sending the mode
1005 * @param chan The channel the mode is being sent to (or NULL if a usermode)
1006 * @param mode The mode character being set
1007 * @param param The parameter for the mode or an empty string
1008 * @param adding true of the mode is being added, false if it is being removed
1009 * @param pcnt The parameter count for the mode (0 or 1)
1010 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
1011 * to skip all permission checking. Please note that for remote mode changes, your return value
1014 virtual ModResult OnRawMode(User* user, Channel* chan, const char mode, const std::string ¶m, bool adding, int pcnt);
1016 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1017 * This method will always be called for each join, wether or not the channel is actually +k, and
1018 * determines the outcome of an if statement around the whole section of key checking code.
1019 * if the user specified no key, the keygiven string will be a valid but empty value.
1020 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1021 * @param user The user joining the channel
1022 * @param chan The channel being joined
1023 * @return 1 to explicitly allow the join, 0 to proceed as normal
1025 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
1027 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1028 * This method will always be called for each join, wether or not the channel is actually +l, and
1029 * determines the outcome of an if statement around the whole section of channel limit checking code.
1030 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1031 * @param user The user joining the channel
1032 * @param chan The channel being joined
1033 * @return 1 to explicitly allow the join, 0 to proceed as normal
1035 virtual ModResult OnCheckLimit(User* user, Channel* chan);
1038 * Checks for a user's ban from the channel
1039 * @param user The user to check
1040 * @param chan The channel to check in
1041 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1042 * ban check, or MOD_RES_PASSTHRU to check bans normally
1044 virtual ModResult OnCheckChannelBan(User* user, Channel* chan);
1047 * Checks for a user's match of a single ban
1048 * @param user The user to check for match
1049 * @param chan The channel on which the match is being checked
1050 * @param mask The mask being checked
1051 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1052 * ban check, or MOD_RES_PASSTHRU to check bans normally
1054 virtual ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask);
1056 /** Checks for a match on a given extban type
1057 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
1058 * ban check, or MOD_RES_PASSTHRU to check bans normally
1060 virtual ModResult OnExtBanCheck(User* user, Channel* chan, char type);
1062 /** Called on all /STATS commands
1063 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1064 * @param symbol the symbol provided to /STATS
1065 * @param user the user issuing the /STATS command
1066 * @param results A string_list to append results into. You should put all your results
1067 * into this string_list, rather than displaying them directly, so that your handler will
1068 * work when remote STATS queries are received.
1069 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1071 virtual ModResult OnStats(char symbol, User* user, string_list &results);
1073 /** Called whenever a change of a local users displayed host is attempted.
1074 * Return 1 to deny the host change, or 0 to allow it.
1075 * @param user The user whos host will be changed
1076 * @param newhost The new hostname
1077 * @return 1 to deny the host change, 0 to allow
1079 virtual ModResult OnChangeLocalUserHost(LocalUser* user, const std::string &newhost);
1081 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1082 * return 1 to deny the name change, or 0 to allow it.
1083 * @param user The user whos GECOS will be changed
1084 * @param newhost The new GECOS
1085 * @return 1 to deny the GECOS change, 0 to allow
1087 virtual ModResult OnChangeLocalUserGECOS(LocalUser* user, const std::string &newhost);
1089 /** Called before a topic is changed.
1090 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
1091 * As with other 'pre' events, you should only ever block a local event.
1092 * @param user The user changing the topic
1093 * @param chan The channels who's topic is being changed
1094 * @param topic The actual topic text
1095 * @param 1 to block the topic change, 0 to allow
1097 virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
1099 /** Called whenever a topic has been changed.
1100 * To block topic changes you must use OnPreTopicChange instead.
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
1105 virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
1107 /** Called whenever an Event class is sent to all modules by another module.
1108 * You should *always* check the value of Event::id to determine the event type.
1109 * @param event The Event class being received
1111 virtual void OnEvent(Event& event);
1113 /** Called whenever a Request class is sent to your module by another module.
1114 * The value of Request::id should be used to determine the type of request.
1115 * @param request The Request class being received
1117 virtual void OnRequest(Request& request);
1119 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
1120 * The password field (from the config file) is in 'password' and is to be compared against
1121 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
1122 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
1123 * @param ex The object that's causing the authentication (User* for <oper> <connect:allow> etc, Server* for <link>).
1124 * @param password The password from the configuration file (the password="" value).
1125 * @param input The password entered by the user or whoever.
1126 * @param hashtype The hash value from the config
1127 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
1129 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
1131 /** Called whenever a user is given usermode +o, anywhere on the network.
1132 * You cannot override this and prevent it from happening as it is already happened and
1133 * such a task must be performed by another server. You can however bounce modes by sending
1134 * servermodes out to reverse mode changes.
1135 * @param user The user who is opering
1137 virtual void OnGlobalOper(User* user);
1139 /** Called after a user has fully connected and all modules have executed OnUserConnect
1140 * This event is informational only. You should not change any user information in this
1141 * event. To do so, use the OnUserConnect method to change the state of local users.
1142 * This is called for both local and remote users.
1143 * @param user The user who is connecting
1145 virtual void OnPostConnect(User* user);
1147 /** Called whenever a ban is added to a channel's list.
1148 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1149 * @param source The user adding the ban
1150 * @param channel The channel the ban is being added to
1151 * @param banmask The ban mask being added
1152 * @return 1 to block the ban, 0 to continue as normal
1154 virtual ModResult OnAddBan(User* source, Channel* channel,const std::string &banmask);
1156 /** Called whenever a ban is removed from a channel's list.
1157 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1158 * @param source The user deleting the ban
1159 * @param channel The channel the ban is being deleted from
1160 * @param banmask The ban mask being deleted
1161 * @return 1 to block the unban, 0 to continue as normal
1163 virtual ModResult OnDelBan(User* source, Channel* channel,const std::string &banmask);
1165 /** Called to install an I/O hook on an event handler
1166 * @param user The item to possibly install the I/O hook on
1167 * @param via The port that <user> connected on
1169 virtual void OnHookIO(StreamSocket*, ListenSocket* via);
1171 /** Called when a port accepts a connection
1172 * Return MOD_RES_ACCEPT if you have used the file descriptor.
1173 * @param fd The file descriptor returned from accept()
1174 * @param from The local port the user connected to
1175 * @param client The client IP address and port
1176 * @param server The server IP address and port
1178 virtual ModResult OnAcceptConnection(int fd, ListenSocket* from, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
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 line of WHOIS output is sent to a user.
1234 * You may change the numeric and the text of the output by changing
1235 * the values numeric and text, but you cannot change the user the
1236 * numeric is sent to. You may however change the user's User values.
1237 * @param user The user the numeric is being sent to
1238 * @param dest The user being WHOISed
1239 * @param numeric The numeric of the line being sent
1240 * @param text The text of the numeric, including any parameters
1241 * @return nonzero to drop the line completely so that the user does not
1242 * receive it, or zero to allow the line to be sent.
1244 virtual ModResult OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
1246 /** Called at intervals for modules to garbage-collect any hashes etc.
1247 * Certain data types such as hash_map 'leak' buckets, which must be
1248 * tidied up and freed by copying into a new item every so often. This
1249 * method is called when it is time to do that.
1251 virtual void OnGarbageCollect();
1253 /** Called when a user's connect class is being matched
1254 * @return MOD_RES_ALLOW to force the class to match, MOD_RES_DENY to forbid it, or
1255 * MOD_RES_PASSTHRU to allow normal matching (by host/port).
1257 virtual ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass);
1259 /** Add test suite hooks here. These are used for testing functionality of a module
1260 * via the --testsuite debugging parameter.
1262 virtual void OnRunTestSuite();
1264 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
1265 * For example NAMESX, channel mode +u and +I, and UHNAMES. If the nick is set to an empty string by any
1266 * module, then this will cause the nickname not to be displayed at all.
1268 virtual void OnNamesListItem(User* issuer, Membership* item, std::string &prefixes, std::string &nick);
1270 virtual ModResult OnNumeric(User* user, unsigned int numeric, const std::string &text);
1272 /** Called whenever a result from /WHO is about to be returned
1273 * @param source The user running the /WHO query
1274 * @param params The parameters to the /WHO query
1275 * @param user The user that this line of the query is about
1276 * @param line The raw line to send; modifiable, if empty no line will be returned.
1278 virtual void OnSendWhoLine(User* source, const std::vector<std::string>& params, User* user, std::string& line);
1282 #define CONF_NO_ERROR 0x000000
1283 #define CONF_NOT_A_NUMBER 0x000010
1284 #define CONF_INT_NEGATIVE 0x000080
1285 #define CONF_VALUE_NOT_FOUND 0x000100
1286 #define CONF_FILE_NOT_FOUND 0x000200
1289 /** Allows reading of values from configuration files
1290 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1291 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1292 * Constructing the class using one parameter allows you to specify a path to your own configuration
1293 * file, otherwise, inspircd.conf is read.
1295 class CoreExport ConfigReader : public interfacebase
1303 /** Default constructor.
1304 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1305 * as specified when running ./configure.
1308 /** Default destructor.
1309 * This method destroys the ConfigReader class.
1313 /** Retrieves a value from the config file.
1314 * This method retrieves a value from the config file. Where multiple copies of the tag
1315 * exist in the config file, index indicates which of the values to retrieve.
1317 std::string ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds = false);
1318 /** Retrieves a value from the config file.
1319 * This method retrieves a value from the config file. Where multiple copies of the tag
1320 * exist in the config file, index indicates which of the values to retrieve. If the
1321 * tag is not found the default value is returned instead.
1323 std::string ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds = false);
1325 /** Retrieves a boolean value from the config file.
1326 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1327 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1328 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1330 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1331 /** Retrieves a boolean value from the config file.
1332 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1333 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1334 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1335 * If the tag is not found, the default value is used instead.
1337 bool ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index);
1339 /** Retrieves an integer value from the config file.
1340 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1341 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1342 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1343 * return CONF_INVALID_NUMBER to be returned. need_positive is set if the number must be non-negative.
1344 * If a negative number is placed into a tag which is specified positive, 0 will be returned and GetError()
1345 * will return CONF_INT_NEGATIVE. Note that need_positive is not suitable to get an unsigned int - you
1346 * should cast the result to achieve that effect.
1348 int ReadInteger(const std::string &tag, const std::string &name, int index, bool need_positive);
1349 /** Retrieves an integer value from the config file.
1350 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1351 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1352 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1353 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1354 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1355 * will return CONF_NOT_UNSIGNED. If the tag is not found, the default value is used instead.
1357 int ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool need_positive);
1359 /** Returns the last error to occur.
1360 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1361 * A call to GetError() resets the error flag back to 0.
1365 /** Counts the number of times a given tag appears in the config file.
1366 * This method counts the number of times a tag appears in a config file, for use where
1367 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1368 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1369 * multiple instance tag.
1371 int Enumerate(const std::string &tag);
1376 /** Caches a text file into memory and can be used to retrieve lines from it.
1377 * This class contains methods for read-only manipulation of a text file in memory.
1378 * Either use the constructor type with one parameter to load a file into memory
1379 * at construction, or use the LoadFile method to load a file.
1381 class CoreExport FileReader : public classbase
1383 /** The file contents
1385 std::vector<std::string> fc;
1387 /** Content size in bytes
1389 unsigned long contentsize;
1391 /** Calculate content size in bytes
1396 /** Default constructor.
1397 * This method does not load any file into memory, you must use the LoadFile method
1398 * after constructing the class this way.
1402 /** Secondary constructor.
1403 * This method initialises the class with a file loaded into it ready for GetLine and
1404 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1407 FileReader(const std::string &filename);
1409 /** Default destructor.
1410 * This deletes the memory allocated to the file.
1414 /** Used to load a file.
1415 * This method loads a file into the class ready for GetLine and
1416 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1419 void LoadFile(const std::string &filename);
1421 /** Returns the whole content of the file as std::string
1423 std::string Contents();
1425 /** Returns the entire size of the file as std::string
1427 unsigned long ContentSize();
1429 /** Returns true if the file exists
1430 * This function will return false if the file could not be opened.
1434 /** Retrieve one line from the file.
1435 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1436 * the index was out of bounds, or the line had no data on it.
1438 std::string GetLine(int x);
1440 /** Returns the size of the file in lines.
1441 * This method returns the number of lines in the read file. If it is 0, no lines have been
1442 * read into memory, either because the file is empty or it does not exist, or cannot be
1443 * opened due to permission problems.
1448 /** A list of modules
1450 typedef std::vector<Module*> IntModuleList;
1452 /** An event handler iterator
1454 typedef IntModuleList::iterator EventHandlerIter;
1456 /** ModuleManager takes care of all things module-related
1459 class CoreExport ModuleManager
1462 /** Holds a string describing the last module error to occur
1464 std::string LastModuleError;
1466 /** Total number of modules loaded into the ircd
1470 /** List of loaded modules and shared object/dll handles
1471 * keyed by module name
1473 std::map<std::string, Module*> Modules;
1479 } prioritizationState;
1481 /** Internal unload module hook */
1482 bool CanUnload(Module*);
1485 /** Event handler hooks.
1486 * This needs to be public to be used by FOREACH_MOD and friends.
1488 IntModuleList EventHandlers[I_END];
1490 /** List of data services keyed by name */
1491 std::multimap<std::string, ServiceProvider*> DataProviders;
1493 /** Simple, bog-standard, boring constructor.
1501 /** Change the priority of one event in a module.
1502 * Each module event has a list of modules which are attached to that event type.
1503 * If you wish to be called before or after other specific modules, you may use this
1504 * method (usually within void Module::Prioritize()) to set your events priority.
1505 * You may use this call in other methods too, however, this is not supported behaviour
1507 * @param mod The module to change the priority of
1508 * @param i The event to change the priority of
1509 * @param s The state you wish to use for this event. Use one of
1510 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1511 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1512 * to set it to be before or after one or more other modules.
1513 * @param which If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1514 * then this contains a the module that your module must be placed before
1517 bool SetPriority(Module* mod, Implementation i, Priority s, Module* which = NULL);
1519 /** Backwards compat interface */
1520 inline bool SetPriority(Module* mod, Implementation i, Priority s, Module** dptr)
1522 return SetPriority(mod, i, s, *dptr);
1525 /** Change the priority of all events in a module.
1526 * @param mod The module to set the priority of
1527 * @param s The priority of all events in the module.
1528 * Note that with this method, it is not possible to effectively use
1529 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1530 * SetPriority method for this, where you may specify other modules to
1531 * be prioritized against.
1533 bool SetPriority(Module* mod, Priority s);
1535 /** Attach an event to a module.
1536 * You may later detatch the event with ModuleManager::Detach().
1537 * If your module is unloaded, all events are automatically detatched.
1538 * @param i Event type to attach
1539 * @param mod Module to attach event to
1540 * @return True if the event was attached
1542 bool Attach(Implementation i, Module* mod);
1544 /** Detatch an event from a module.
1545 * This is not required when your module unloads, as the core will
1546 * automatically detatch your module from all events it is attached to.
1547 * @param i Event type to detach
1548 * @param mod Module to detach event from
1549 * @param Detach true if the event was detached
1551 bool Detach(Implementation i, Module* mod);
1553 /** Attach an array of events to a module
1554 * @param i Event types (array) to attach
1555 * @param mod Module to attach events to
1557 void Attach(Implementation* i, Module* mod, size_t sz);
1559 /** Detach all events from a module (used on unload)
1560 * @param mod Module to detach from
1562 void DetachAll(Module* mod);
1564 /** Returns text describing the last module error
1565 * @return The last error message to occur
1567 std::string& LastError();
1569 /** Load a given module file
1570 * @param filename The file to load
1571 * @param defer Defer module init (loading many modules)
1572 * @return True if the module was found and loaded
1574 bool Load(const std::string& filename, bool defer = false);
1576 /** Unload a given module file. Note that the module will not be
1577 * completely gone until the cull list has finished processing.
1579 * @return true on success; if false, LastError will give a reason
1581 bool Unload(Module* module);
1583 /** Run an asynchronous reload of the given module. When the reload is
1584 * complete, the callback will be run with true if the reload succeeded
1585 * and false if it did not.
1587 void Reload(Module* module, HandlerBase1<void, bool>* callback);
1589 /** Called by the InspIRCd constructor to load all modules from the config file.
1593 void DoSafeUnload(Module*);
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 /** Register a service provided by a module */
1611 void AddService(ServiceProvider&);
1613 /** Unregister a service provided by a module */
1614 void DelService(ServiceProvider&);
1616 inline void AddServices(ServiceProvider** list, int count)
1618 for(int i=0; i < count; i++)
1619 AddService(*list[i]);
1622 /** Find a service by name.
1623 * If multiple modules provide a given service, the first one loaded will be chosen.
1625 ServiceProvider* FindService(ServiceType Type, const std::string& name);
1627 template<typename T> inline T* FindDataService(const std::string& name)
1629 return static_cast<T*>(FindService(SERVICE_DATA, name));
1632 /** Return a list of all modules matching the given filter
1633 * @param filter This int is a bitmask of flags set in Module::Flags,
1634 * such as VF_VENDOR or VF_STATIC. If you wish to receive a list of
1635 * all modules with no filtering, set this to 0.
1636 * @return The list of module names
1638 const std::vector<std::string> GetAllModuleNames(int filter);
1641 /** Do not mess with these functions unless you know the C preprocessor
1642 * well enough to explain why they are needed. The order is important.
1644 #define MODULE_INIT_STR MODULE_INIT_STR_FN_2(MODULE_INIT_SYM)
1645 #define MODULE_INIT_STR_FN_2(x) MODULE_INIT_STR_FN_1(x)
1646 #define MODULE_INIT_STR_FN_1(x) #x
1647 #define MODULE_INIT_SYM MODULE_INIT_SYM_FN_2(INSPIRCD_VERSION_MAJ, INSPIRCD_VERSION_API)
1648 #define MODULE_INIT_SYM_FN_2(x,y) MODULE_INIT_SYM_FN_1(x,y)
1649 #define MODULE_INIT_SYM_FN_1(x,y) inspircd_module_ ## x ## _ ## y
1653 struct AllCommandList {
1654 typedef Command* (*fn)(Module*);
1655 AllCommandList(fn cmd);
1657 #define COMMAND_INIT(x) static Command* MK_ ## x(Module* m) { return new x(m); } \
1658 static const AllCommandList PREP_ ## x(&MK_ ## x);
1660 struct AllModuleList {
1661 typedef Module* (*fn)();
1664 AllModuleList(fn mod, const std::string& Name);
1667 #define MODULE_INIT(x) static Module* MK_ ## x() { return new x; } \
1668 static const AllModuleList PREP_ ## x(&MK_ ## x, MODNAMESTR);
1670 #define MODNAMESTR MODNAMESTR_FN_2(MODNAME)
1671 #define MODNAMESTR_FN_2(x) MODNAMESTR_FN_1(x)
1672 #define MODNAMESTR_FN_1(x) #x
1676 /** This definition is used as shorthand for the various classes
1677 * and functions needed to make a module loadable by the OS.
1678 * It defines the class factory and external init_module function.
1682 #define MODULE_INIT(y) \
1683 extern "C" DllExport Module * MODULE_INIT_SYM() \
1687 BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
1689 switch ( nReason ) \
1691 case DLL_PROCESS_ATTACH: \
1692 case DLL_PROCESS_DETACH: \
1700 #define MODULE_INIT(y) \
1701 extern "C" DllExport Module * MODULE_INIT_SYM() \
1705 extern "C" const char inspircd_src_version[] = VERSION " r" REVISION;
1708 #define COMMAND_INIT(c) MODULE_INIT(CommandModule<c>)