1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2007 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
19 /** Used with OnAccessCheck() method of modules
21 enum AccessControlType {
22 ACR_DEFAULT, // Do default action (act as if the module isnt even loaded)
23 ACR_DENY, // deny the action
24 ACR_ALLOW, // allow the action
25 AC_KICK, // a user is being kicked
26 AC_DEOP, // a user is being deopped
27 AC_OP, // a user is being opped
28 AC_VOICE, // a user is being voiced
29 AC_DEVOICE, // a user is being devoiced
30 AC_HALFOP, // a user is being halfopped
31 AC_DEHALFOP, // a user is being dehalfopped
32 AC_INVITE, // a user is being invited
33 AC_GENERAL_MODE // a channel mode is being changed
36 /** Used to define a set of behavior bits for a module
39 VF_STATIC = 1, // module is static, cannot be /unloadmodule'd
40 VF_VENDOR = 2, // module is a vendor module (came in the original tarball, not 3rd party)
41 VF_SERVICEPROVIDER = 4, // module provides a service to other modules (can be a dependency)
42 VF_COMMON = 8 // module needs to be common on all servers in a network to link
45 /** Used with SendToMode()
52 /** Used to represent an event type, for user, channel or server
54 enum TargetTypeFlags {
61 /** Used to represent wether a message was PRIVMSG or NOTICE
72 #include "inspsocket.h"
80 /** If you change the module API, change this value.
81 * If you have enabled ipv6, the sizes of structs is
82 * different, and modules will be incompatible with
83 * ipv4 servers, so this value will be ten times as
84 * high on ipv6 servers.
86 #define NATIVE_API_VERSION 12000
88 #define API_VERSION (NATIVE_API_VERSION * 10)
90 #define API_VERSION (NATIVE_API_VERSION * 1)
95 /* Forward-delacare module for ModuleMessage etc
100 /** Low level definition of a FileReader classes file cache area -
101 * a text file seperated into lines.
103 typedef std::deque<std::string> file_cache;
105 /** A set of strings.
107 typedef file_cache string_list;
109 /** Holds a list of 'published features' for modules.
111 typedef std::map<std::string,Module*> featurelist;
113 /** Holds a list of modules which implement an interface
115 typedef std::deque<Module*> modulelist;
117 /** Holds a list of all modules which implement interfaces, by interface name
119 typedef std::map<std::string, std::pair<int, modulelist> > interfacelist;
122 * This #define allows us to call a method in all
123 * loaded modules in a readable simple way, e.g.:
124 * 'FOREACH_MOD(I_OnConnect,OnConnect(user));'
126 #define FOREACH_MOD(y,x) if (ServerInstance->Config->global_implementation[y] > 0) { \
127 for (int _i = 0; _i <= ServerInstance->Modules->GetCount(); _i++) { \
128 if (ServerInstance->Config->implement_lists[_i][y]) \
131 ServerInstance->Modules->modules[_i]->x ; \
133 catch (CoreException& modexcept) \
135 ServerInstance->Log(DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
141 * This #define allows us to call a method in all
142 * loaded modules in a readable simple way and pass
143 * an instance pointer to the macro. e.g.:
144 * 'FOREACH_MOD_I(Instance, OnConnect, OnConnect(user));'
146 #define FOREACH_MOD_I(z,y,x) if (z->Config->global_implementation[y] > 0) { \
147 for (int _i = 0; _i <= z->Modules->GetCount(); _i++) { \
148 if (z->Config->implement_lists[_i][y]) \
151 z->Modules->modules[_i]->x ; \
153 catch (CoreException& modexcept) \
155 z->Log(DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
160 * This define is similar to the one above but returns a result in MOD_RESULT.
161 * The first module to return a nonzero result is the value to be accepted,
162 * and any modules after are ignored.
164 #define FOREACH_RESULT(y,x) { if (ServerInstance->Config->global_implementation[y] > 0) { \
166 for (int _i = 0; _i <= ServerInstance->Modules->GetCount(); _i++) { \
167 if (ServerInstance->Config->implement_lists[_i][y]) { \
170 int res = ServerInstance->Modules->modules[_i]->x ; \
176 catch (CoreException& modexcept) \
178 ServerInstance->Log(DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
186 * This define is similar to the one above but returns a result in MOD_RESULT.
187 * The first module to return a nonzero result is the value to be accepted,
188 * and any modules after are ignored.
190 #define FOREACH_RESULT_I(z,y,x) { if (z->Config->global_implementation[y] > 0) { \
192 for (int _i = 0; _i <= z->Modules->GetCount(); _i++) { \
193 if (z->Config->implement_lists[_i][y]) { \
196 int res = z->Modules->modules[_i]->x ; \
202 catch (CoreException& modexcept) \
204 z->Log(DEBUG,"Exception caught: %s",modexcept.GetReason()); \
211 /** Represents a non-local user.
212 * (in fact, any FD less than -1 does)
214 #define FD_MAGIC_NUMBER -42
218 /** Is a local user */
219 #define IS_LOCAL(x) ((x->GetFd() > -1))
221 /** Is a local user */
222 #define IS_LOCAL(x) ((x->GetFd() > -1) && (x->GetFd() <= MAX_DESCRIPTORS))
224 /** Is a remote user */
225 #define IS_REMOTE(x) (x->GetFd() < 0)
226 /** Is a module created user */
227 #define IS_MODULE_CREATED(x) (x->GetFd() == FD_MAGIC_NUMBER)
229 #define IS_OPER(x) (*x->oper)
231 #define IS_AWAY(x) (*x->awaymsg)
233 /** Holds a module's Version information.
234 * The four members (set by the constructor only) indicate details as to the version number
235 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
236 * The flags and API values represent the module flags and API version of the module.
237 * The API version of a module must match the API version of the core exactly for the module to
240 class CoreExport Version : public classbase
243 /** Version numbers, build number, flags and API version
245 const int Major, Minor, Revision, Build, Flags, API;
247 /** Initialize version class
249 Version(int major, int minor, int revision, int build, int flags, int api_ver);
252 /** The ModuleMessage class is the base class of Request and Event
253 * This class is used to represent a basic data structure which is passed
254 * between modules for safe inter-module communications.
256 class CoreExport ModuleMessage : public Extensible
261 virtual ~ModuleMessage() {};
264 /** The Request class is a unicast message directed at a given module.
265 * When this class is properly instantiated it may be sent to a module
266 * using the Send() method, which will call the given module's OnRequest
267 * method with this class as its parameter.
269 class CoreExport Request : public ModuleMessage
272 /** This member holds a pointer to arbitary data set by the emitter of the message
275 /** This should be a null-terminated string identifying the type of request,
276 * all modules should define this and use it to determine the nature of the
277 * request before they attempt to cast the Request in any way.
280 /** This is a pointer to the sender of the message, which can be used to
281 * directly trigger events, or to create a reply.
284 /** The single destination of the Request
288 /** Create a new Request
289 * This is for the 'old' way of casting whatever the data is
290 * to char* and hoping you get the right thing at the other end.
291 * This is slowly being depreciated in favor of the 'new' way.
293 Request(char* anydata, Module* src, Module* dst);
294 /** Create a new Request
295 * This is for the 'new' way of defining a subclass
296 * of Request and defining it in a common header,
297 * passing an object of your Request subclass through
298 * as a Request* and using the ID string to determine
299 * what to cast it back to and the other end. This is
300 * much safer as there are no casts not confirmed by
301 * the ID string, and all casts are child->parent and
302 * can be checked at runtime with dynamic_cast<>()
304 Request(Module* src, Module* dst, const char* idstr);
305 /** Fetch the Request data
308 /** Fetch the ID string
311 /** Fetch the request source
314 /** Fetch the request destination (should be 'this' in the receiving module)
317 /** Send the Request.
318 * Upon returning the result will be arbitary data returned by the module you
319 * sent the request to. It is up to your module to know what this data is and
320 * how to deal with it.
326 /** The Event class is a unicast message directed at all modules.
327 * When the class is properly instantiated it may be sent to all modules
328 * using the Send() method, which will trigger the OnEvent method in
329 * all modules passing the object as its parameter.
331 class CoreExport Event : public ModuleMessage
334 /** This member holds a pointer to arbitary data set by the emitter of the message
337 /** This is a pointer to the sender of the message, which can be used to
338 * directly trigger events, or to create a reply.
341 /** The event identifier.
342 * This is arbitary text which should be used to distinguish
343 * one type of event from another.
347 /** Create a new Event
349 Event(char* anydata, Module* src, const std::string &eventid);
350 /** Get the Event data
353 /** Get the event Source
356 /** Get the event ID.
357 * Use this to determine the event type for safe casting of the data
359 std::string GetEventID();
361 * The return result of an Event::Send() will always be NULL as
362 * no replies are expected.
364 char* Send(InspIRCd* ServerInstance);
367 /** Priority types which can be returned from Module::Prioritize()
369 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
371 /** Implementation-specific flags which may be set in Module::Implements()
373 enum Implementation { I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash, I_OnServerRaw,
374 I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois, I_OnUserPreInvite,
375 I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick, I_OnUserMessage, I_OnUserNotice, I_OnMode,
376 I_OnGetServerDescription, I_OnSyncUser, I_OnSyncChannel, I_OnSyncChannelMetaData, I_OnSyncUserMetaData,
377 I_OnDecodeMetaData, I_ProtoSendMode, I_ProtoSendMetaData, I_OnWallops, I_OnChangeHost, I_OnChangeName, I_OnAddLine,
378 I_OnDelLine, I_OnCleanup, I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule, I_OnUnloadModule,
379 I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnUserRrgister, I_OnCheckInvite,
380 I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnLocalTopicChange,
381 I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnOperCompre, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan, I_OnDelBan,
382 I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead, I_OnChangeLocalUserGECOS, I_OnUserRegister,
383 I_OnOperCompare, I_OnChannelDelete, I_OnPostOper, I_OnSyncOtherMetaData, I_OnSetAway, I_OnCancelAway, I_OnUserList,
384 I_OnPostCommand, I_OnPostJoin, I_OnWhoisLine, I_OnBuildExemptList, I_OnRawSocketConnect, I_OnGarbageCollect, I_OnBufferFlushed,
387 /** Base class for all InspIRCd modules
388 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
389 * its methods will be called when irc server events occur. class inherited from module must be
390 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
392 class CoreExport Module : public Extensible
395 /** Creator/owner pointer
397 InspIRCd* ServerInstance;
400 /** Default constructor.
401 * Creates a module class.
402 * @param Me An instance of the InspIRCd class which will be saved into ServerInstance for your use
403 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
405 Module(InspIRCd* Me);
407 /** Default destructor.
408 * destroys a module class
412 /** Returns the version number of a Module.
413 * The method should return a Version object with its version information assigned via
416 virtual Version GetVersion();
418 /** The Implements function specifies which methods a module should receive events for.
419 * The char* parameter passed to this function contains a set of true or false values
420 * (1 or 0) which indicate wether each function is implemented. You must use the Iimplementation
421 * enum (documented elsewhere on this page) to mark functions as active. For example, to
422 * receive events for OnUserJoin():
424 * Implements[I_OnUserJoin] = 1;
426 * @param The implement list
428 virtual void Implements(char* Implements);
430 /** Used to set the 'priority' of a module (e.g. when it is called in relation to other modules.
431 * Some modules prefer to be called before other modules, due to their design. For example, a
432 * module which is expected to operate on complete information would expect to be placed last, so
433 * that any other modules which wish to adjust that information would execute before it, to be sure
434 * its information is correct. You can change your module's priority by returning one of:
436 * PRIORITY_FIRST - To place your module first in the list
438 * PRIORITY_LAST - To place your module last in the list
440 * PRIORITY_DONTCARE - To leave your module as it is (this is the default value, if you do not implement this function)
442 * The result of InspIRCd::PriorityBefore() - To move your module before another named module
444 * The result of InspIRCd::PriorityLast() - To move your module after another named module
446 * For a good working example of this method call, please see src/modules/m_spanningtree.cpp
447 * and src/modules/m_hostchange.so which make use of it. It is highly recommended that unless
448 * your module has a real need to reorder its priority, it should not implement this function,
449 * as many modules changing their priorities can make the system redundant.
451 virtual Priority Prioritize();
453 /** Called when a user connects.
454 * The details of the connecting user are available to you in the parameter User *user
455 * @param user The user who is connecting
457 virtual void OnUserConnect(User* user);
459 /** Called when a user quits.
460 * The details of the exiting user are available to you in the parameter User *user
461 * This event is only called when the user is fully registered when they quit. To catch
462 * raw disconnections, use the OnUserDisconnect method.
463 * @param user The user who is quitting
464 * @param message The user's quit message (as seen by non-opers)
465 * @param oper_message The user's quit message (as seen by opers)
467 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
469 /** Called whenever a user's socket is closed.
470 * The details of the exiting user are available to you in the parameter User *user
471 * This event is called for all users, registered or not, as a cleanup method for modules
472 * which might assign resources to user, such as dns lookups, objects and sockets.
473 * @param user The user who is disconnecting
475 virtual void OnUserDisconnect(User* user);
477 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
478 * @param chan The channel being deleted
480 virtual void OnChannelDelete(Channel* chan);
482 /** Called when a user joins a channel.
483 * The details of the joining user are available to you in the parameter User *user,
484 * and the details of the channel they have joined is available in the variable Channel *channel
485 * @param user The user who is joining
486 * @param channel The channel being joined
487 * @param silent Change this to true if you want to conceal the JOIN command from the other users
488 * of the channel (useful for modules such as auditorium)
490 virtual void OnUserJoin(User* user, Channel* channel, bool &silent);
492 /** Called after a user joins a channel
493 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
495 * @param user The user who is joining
496 * @param channel The channel being joined
498 virtual void OnPostJoin(User* user, Channel* channel);
500 /** Called when a user parts a channel.
501 * The details of the leaving user are available to you in the parameter User *user,
502 * and the details of the channel they have left is available in the variable Channel *channel
503 * @param user The user who is parting
504 * @param channel The channel being parted
505 * @param partmessage The part message, or an empty string
506 * @param silent Change this to true if you want to conceal the PART command from the other users
507 * of the channel (useful for modules such as auditorium)
509 virtual void OnUserPart(User* user, Channel* channel, const std::string &partmessage, bool &silent);
511 /** Called on rehash.
512 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
513 * system. You should use it to reload any files so that your module keeps in step with the
514 * rest of the application. If a parameter is given, the core has done nothing. The module
515 * receiving the event can decide if this parameter has any relevence to it.
516 * @param user The user performing the rehash, if any -- if this is server initiated, the
517 * value of this variable will be NULL.
518 * @param parameter The (optional) parameter given to REHASH from the user.
520 virtual void OnRehash(User* user, const std::string ¶meter);
522 /** Called when a raw command is transmitted or received.
523 * This method is the lowest level of handler available to a module. It will be called with raw
524 * data which is passing through a connected socket. If you wish, you may munge this data by changing
525 * the string parameter "raw". If you do this, after your function exits it will immediately be
526 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
527 * inbound is set to true) the value of user will be the User of the connection sending the
528 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
529 * @param raw The raw string in RFC1459 format
530 * @param inbound A flag to indicate wether the data is coming into the daemon or going out to the user
531 * @param user The user record sending the text, when inbound == true.
533 virtual void OnServerRaw(std::string &raw, bool inbound, User* user);
535 /** Called whenever a user is about to join a channel, before any processing is done.
536 * Returning a value of 1 from this function stops the process immediately, causing no
537 * output to be sent to the user by the core. If you do this you must produce your own numerics,
538 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
539 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
543 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
544 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
545 * processing on the actual channel record at this point, however the channel NAME will still be passed in
546 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
547 * @param user The user joining the channel
548 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
549 * @param cname The channel name being joined. For new channels this is valid where chan is not.
550 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "@".
551 * You may alter this string to alter the user's modes on the channel.
552 * @return 1 To prevent the join, 0 to allow it.
554 virtual int OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string &privs);
556 /** Called whenever a user is about to be kicked.
557 * Returning a value of 1 from this function stops the process immediately, causing no
558 * output to be sent to the user by the core. If you do this you must produce your own numerics,
560 * @param source The user issuing the kick
561 * @param user The user being kicked
562 * @param chan The channel the user is being kicked from
563 * @param reason The kick reason
564 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
566 virtual int OnUserPreKick(User* source, User* user, Channel* chan, const std::string &reason);
568 /** Called whenever a user is kicked.
569 * If this method is called, the kick is already underway and cannot be prevented, so
570 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
571 * @param source The user issuing the kick
572 * @param user The user being kicked
573 * @param chan The channel the user is being kicked from
574 * @param reason The kick reason
575 * @param silent Change this to true if you want to conceal the PART command from the other users
576 * of the channel (useful for modules such as auditorium)
578 virtual void OnUserKick(User* source, User* user, Channel* chan, const std::string &reason, bool &silent);
580 /** Called whenever a user opers locally.
581 * The User will contain the oper mode 'o' as this function is called after any modifications
582 * are made to the user's structure by the core.
583 * @param user The user who is opering up
584 * @param opertype The opers type name
586 virtual void OnOper(User* user, const std::string &opertype);
588 /** Called after a user opers locally.
589 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
590 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
591 * out the OPERTYPE, etc.
592 * @param user The user who is opering up
593 * @param opertype The opers type name
595 virtual void OnPostOper(User* user, const std::string &opertype);
597 /** Called whenever a user types /INFO.
598 * The User will contain the information of the user who typed the command. Modules may use this
599 * method to output their own credits in /INFO (which is the ircd's version of an about box).
600 * It is purposefully not possible to modify any info that has already been output, or halt the list.
601 * You must write a 371 numeric to the user, containing your info in the following format:
603 * <nick> :information here
605 * @param user The user issuing /INFO
607 virtual void OnInfo(User* user);
609 /** Called whenever a /WHOIS is performed on a local user.
610 * The source parameter contains the details of the user who issued the WHOIS command, and
611 * the dest parameter contains the information of the user they are whoising.
612 * @param source The user issuing the WHOIS command
613 * @param dest The user who is being WHOISed
615 virtual void OnWhois(User* source, User* dest);
617 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
618 * Returning 1 from this function stops the process immediately, causing no
619 * output to be sent to the user by the core. If you do this you must produce your own numerics,
620 * notices etc. This is useful for modules which may want to filter invites to channels.
621 * @param source The user who is issuing the INVITE
622 * @param dest The user being invited
623 * @param channel The channel the user is being invited to
624 * @return 1 to deny the invite, 0 to allow
626 virtual int OnUserPreInvite(User* source,User* dest,Channel* channel);
628 /** Called after a user has been successfully invited to a channel.
629 * You cannot prevent the invite from occuring using this function, to do that,
630 * use OnUserPreInvite instead.
631 * @param source The user who is issuing the INVITE
632 * @param dest The user being invited
633 * @param channel The channel the user is being invited to
635 virtual void OnUserInvite(User* source,User* dest,Channel* channel);
637 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
638 * Returning any nonzero value from this function stops the process immediately, causing no
639 * output to be sent to the user by the core. If you do this you must produce your own numerics,
640 * notices etc. This is useful for modules which may want to filter or redirect messages.
641 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
642 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
643 * of where the message is destined to be sent.
644 * @param user The user sending the message
645 * @param dest The target of the message (Channel* or User*)
646 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
647 * @param text Changeable text being sent by the user
648 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
649 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
650 * It will be ignored for private messages.
651 * @return 1 to deny the NOTICE, 0 to allow it
653 virtual int OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
655 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
656 * Returning any nonzero value from this function stops the process immediately, causing no
657 * output to be sent to the user by the core. If you do this you must produce your own numerics,
658 * notices etc. This is useful for modules which may want to filter or redirect messages.
659 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
660 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
661 * of where the message is destined to be sent.
662 * You may alter the message text as you wish before relinquishing control to the next module
663 * in the chain, and if no other modules block the text this altered form of the text will be sent out
664 * to the user and possibly to other servers.
665 * @param user The user sending the message
666 * @param dest The target of the message (Channel* or User*)
667 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
668 * @param text Changeable text being sent by the user
669 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
670 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
671 * It will be ignored for private notices.
672 * @return 1 to deny the NOTICE, 0 to allow it
674 virtual int OnUserPreNotice(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
676 /** Called whenever the server wants to build the exemption list for a channel, but is not directly doing a PRIVMSG or NOTICE.
677 * For example, the spanningtree protocol will call this event when passing a privmsg on (but not processing it directly).
678 * @param message_type The message type, either MSG_PRIVMSG or MSG_NOTICE
679 * @param chan The channel to build the exempt list of
680 * @param sender The original sender of the PRIVMSG or NOTICE
681 * @param status The status char to be used for the channel list
682 * @param exempt_list The exempt list to be populated
683 * @param text The original message text causing the exempt list to be built
685 virtual void OnBuildExemptList(MessageType message_type, Channel* chan, User* sender, char status, CUList &exempt_list, const std::string &text);
687 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
688 * Please note that although you can see remote nickchanges through this function, you should
689 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
690 * check user->server before taking any action (including returning nonzero from the method).
691 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
692 * module to generate some meaninful output.
693 * @param user The username changing their nick
694 * @param newnick Their new nickname
695 * @return 1 to deny the change, 0 to allow
697 virtual int OnUserPreNick(User* user, const std::string &newnick);
699 /** Called after any PRIVMSG sent from a user.
700 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
701 * if target_type is TYPE_CHANNEL.
702 * @param user The user sending the message
703 * @param dest The target of the message
704 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
705 * @param text the text being sent by the user
706 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
708 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
710 /** Called after any NOTICE sent from a user.
711 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
712 * if target_type is TYPE_CHANNEL.
713 * @param user The user sending the message
714 * @param dest The target of the message
715 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
716 * @param text the text being sent by the user
717 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
719 virtual void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
721 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
722 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
723 * if target_type is TYPE_CHANNEL.
724 * The difference between this event and OnUserPreNotice/OnUserPreMessage is that delivery is gauranteed,
725 * the message has already been vetted. In the case of the other two methods, a later module may stop your
726 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
727 * @param user The user sending the message
728 * @param dest The target of the message
729 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
730 * @param text the text being sent by the user
731 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
733 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
735 /** Called after every MODE command sent from a user
736 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
737 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
738 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
739 * @param user The user sending the MODEs
740 * @param dest The target of the modes (User* or Channel*)
741 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
742 * @param text The actual modes and their parameters if any
744 virtual void OnMode(User* user, void* dest, int target_type, const std::string &text);
746 /** Allows modules to alter or create server descriptions
747 * Whenever a module requires a server description, for example for display in
748 * WHOIS, this function is called in all modules. You may change or define the
749 * description given in std::string &description. If you do, this description
750 * will be shown in the WHOIS fields.
751 * @param servername The servername being searched for
752 * @param description Alterable server description for this server
754 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
756 /** Allows modules to synchronize data which relates to users during a netburst.
757 * When this function is called, it will be called from the module which implements
758 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
759 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
760 * (see below). This function will be called for every user visible on your side
761 * of the burst, allowing you to for example set modes, etc. Do not use this call to
762 * synchronize data which you have stored using class Extensible -- There is a specialist
763 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
764 * @param user The user being syncronized
765 * @param proto A pointer to the module handling network protocol
766 * @param opaque An opaque pointer set by the protocol module, should not be modified!
768 virtual void OnSyncUser(User* user, Module* proto, void* opaque);
770 /** Allows modules to synchronize data which relates to channels during a netburst.
771 * When this function is called, it will be called from the module which implements
772 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
773 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
774 * (see below). This function will be called for every user visible on your side
775 * of the burst, allowing you to for example set modes, etc. Do not use this call to
776 * synchronize data which you have stored using class Extensible -- There is a specialist
777 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
779 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
781 * @param chan The channel being syncronized
782 * @param proto A pointer to the module handling network protocol
783 * @param opaque An opaque pointer set by the protocol module, should not be modified!
785 virtual void OnSyncChannel(Channel* chan, Module* proto, void* opaque);
787 /* Allows modules to syncronize metadata related to channels over the network during a netburst.
788 * Whenever the linking module wants to send out data, but doesnt know what the data
789 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
790 * this method is called.You should use the ProtoSendMetaData function after you've
791 * correctly decided how the data should be represented, to send the metadata on its way if it belongs
792 * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
793 * @param chan The channel whos metadata is being syncronized
794 * @param proto A pointer to the module handling network protocol
795 * @param opaque An opaque pointer set by the protocol module, should not be modified!
796 * @param extname The extensions name which is being searched for
797 * @param displayable If this value is true, the data is going to be displayed to a user,
798 * and not sent across the network. Use this to determine wether or not to show sensitive data.
800 virtual void OnSyncChannelMetaData(Channel* chan, Module* proto,void* opaque, const std::string &extname, bool displayable = false);
802 /* Allows modules to syncronize metadata related to users over the network during a netburst.
803 * Whenever the linking module wants to send out data, but doesnt know what the data
804 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
805 * this method is called. You should use the ProtoSendMetaData function after you've
806 * correctly decided how the data should be represented, to send the metadata on its way if
807 * if it belongs to your module.
808 * @param user The user whos metadata is being syncronized
809 * @param proto A pointer to the module handling network protocol
810 * @param opaque An opaque pointer set by the protocol module, should not be modified!
811 * @param extname The extensions name which is being searched for
812 * @param displayable If this value is true, the data is going to be displayed to a user,
813 * and not sent across the network. Use this to determine wether or not to show sensitive data.
815 virtual void OnSyncUserMetaData(User* user, Module* proto,void* opaque, const std::string &extname, bool displayable = false);
817 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
818 * Whenever the linking module wants to send out data, but doesnt know what the data
819 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
820 * this method is called. You should use the ProtoSendMetaData function after you've
821 * correctly decided how the data should be represented, to send the metadata on its way if
822 * if it belongs to your module.
823 * @param proto A pointer to the module handling network protocol
824 * @param opaque An opaque pointer set by the protocol module, should not be modified!
825 * @param displayable If this value is true, the data is going to be displayed to a user,
826 * and not sent across the network. Use this to determine wether or not to show sensitive data.
828 virtual void OnSyncOtherMetaData(Module* proto, void* opaque, bool displayable = false);
830 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
831 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
832 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
833 * @param target The Channel* or User* that data should be added to
834 * @param extname The extension name which is being sent
835 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
837 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata);
839 /** Implemented by modules which provide the ability to link servers.
840 * These modules will implement this method, which allows transparent sending of servermodes
841 * down the network link as a broadcast, without a module calling it having to know the format
842 * of the MODE command before the actual mode string.
844 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
845 * of how to use this function.
847 * @param opaque An opaque pointer set by the protocol module, should not be modified!
848 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
849 * @param target The Channel* or User* that modes should be sent for
850 * @param modeline The modes and parameters to be sent
852 virtual void ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline);
854 /** Implemented by modules which provide the ability to link servers.
855 * These modules will implement this method, which allows metadata (extra data added to
856 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
857 * to other servers on a netburst and decoded at the other end by the same module on a
860 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
861 * how to use this function.
862 * @param opaque An opaque pointer set by the protocol module, should not be modified!
863 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
864 * @param target The Channel* or User* that metadata should be sent for
865 * @param extname The extension name to send metadata for
866 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
868 virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata);
870 /** Called after every WALLOPS command.
871 * @param user The user sending the WALLOPS
872 * @param text The content of the WALLOPS message
874 virtual void OnWallops(User* user, const std::string &text);
876 /** Called whenever a user's hostname is changed.
877 * This event triggers after the host has been set.
878 * @param user The user whos host is being changed
879 * @param newhost The new hostname being set
881 virtual void OnChangeHost(User* user, const std::string &newhost);
883 /** Called whenever a user's GECOS (realname) is changed.
884 * This event triggers after the name has been set.
885 * @param user The user who's GECOS is being changed
886 * @param gecos The new GECOS being set on the user
888 virtual void OnChangeName(User* user, const std::string &gecos);
890 /** Called whenever an xline is added by a local user.
891 * This method is triggered after the line is added.
892 * @param source The sender of the line or NULL for local server
893 * @param line The xline being added
895 virtual void OnAddLine(User* source, XLine* line);
897 /** Called whenever an xline is deleted.
898 * This method is triggered after the line is deleted.
899 * @param source The user removing the line or NULL for local server
900 * @param line the line being deleted
902 virtual void OnDelLine(User* source, XLine* line);
904 /** Called whenever a zline is deleted.
905 * This method is triggered after the line is deleted.
906 * @param source The user removing the line
907 * @param hostmask The hostmask to delete
910 /** Called before your module is unloaded to clean up Extensibles.
911 * This method is called once for every user and channel on the network,
912 * so that when your module unloads it may clear up any remaining data
913 * in the form of Extensibles added using Extensible::Extend().
914 * If the target_type variable is TYPE_USER, then void* item refers to
915 * a User*, otherwise it refers to a Channel*.
916 * @param target_type The type of item being cleaned
917 * @param item A pointer to the item's class
919 virtual void OnCleanup(int target_type, void* item);
921 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
922 * have been applied. Please note that although you can see remote nickchanges through this function, you should
923 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
924 * check user->server before taking any action (including returning nonzero from the method).
925 * Because this method is called after the nickchange is taken place, no return values are possible
926 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
927 * @param user The user changing their nick
928 * @param oldnick The old nickname of the user before the nickchange
930 virtual void OnUserPostNick(User* user, const std::string &oldnick);
932 /** Called before an action which requires a channel privilage check.
933 * This function is called before many functions which check a users status on a channel, for example
934 * before opping a user, deopping a user, kicking a user, etc.
935 * There are several values for access_type which indicate for what reason access is being checked.
937 * AC_KICK (0) - A user is being kicked<br>
938 * AC_DEOP (1) - a user is being deopped<br>
939 * AC_OP (2) - a user is being opped<br>
940 * AC_VOICE (3) - a user is being voiced<br>
941 * AC_DEVOICE (4) - a user is being devoiced<br>
942 * AC_HALFOP (5) - a user is being halfopped<br>
943 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
944 * AC_INVITE () - a user is being invited<br>
945 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
946 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
947 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
948 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
949 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
950 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
951 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
952 * @param source The source of the access check
953 * @param dest The destination of the access check
954 * @param channel The channel which is being checked
955 * @param access_type See above
957 virtual int OnAccessCheck(User* source,User* dest,Channel* channel,int access_type);
959 /** Called when a 005 numeric is about to be output.
960 * The module should modify the 005 numeric if needed to indicate its features.
961 * @param output The 005 string to be modified if neccessary.
963 virtual void On005Numeric(std::string &output);
965 /** Called when a client is disconnected by KILL.
966 * If a client is killed by a server, e.g. a nickname collision or protocol error,
968 * Return 1 from this function to prevent the kill, and 0 from this function to allow
969 * it as normal. If you prevent the kill no output will be sent to the client, it is
970 * down to your module to generate this information.
971 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
972 * If you do so youre risking race conditions, desyncs and worse!
973 * @param source The user sending the KILL
974 * @param dest The user being killed
975 * @param reason The kill reason
976 * @return 1 to prevent the kill, 0 to allow
978 virtual int OnKill(User* source, User* dest, const std::string &reason);
980 /** Called when an oper wants to disconnect a remote user via KILL
981 * @param source The user sending the KILL
982 * @param dest The user being killed
983 * @param reason The kill reason
985 virtual void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
987 /** Called whenever a module is loaded.
988 * mod will contain a pointer to the module, and string will contain its name,
989 * for example m_widgets.so. This function is primary for dependency checking,
990 * your module may decide to enable some extra features if it sees that you have
991 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
992 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
993 * but instead operate under reduced functionality, unless the dependency is
994 * absolutely neccessary (e.g. a module that extends the features of another
996 * @param mod A pointer to the new module
997 * @param name The new module's filename
999 virtual void OnLoadModule(Module* mod,const std::string &name);
1001 /** Called whenever a module is unloaded.
1002 * mod will contain a pointer to the module, and string will contain its name,
1003 * for example m_widgets.so. This function is primary for dependency checking,
1004 * your module may decide to enable some extra features if it sees that you have
1005 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
1006 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
1007 * but instead operate under reduced functionality, unless the dependency is
1008 * absolutely neccessary (e.g. a module that extends the features of another
1010 * @param mod Pointer to the module being unloaded (still valid)
1011 * @param name The filename of the module being unloaded
1013 virtual void OnUnloadModule(Module* mod,const std::string &name);
1015 /** Called once every five seconds for background processing.
1016 * This timer can be used to control timed features. Its period is not accurate
1017 * enough to be used as a clock, but it is gauranteed to be called at least once in
1018 * any five second period, directly from the main loop of the server.
1019 * @param curtime The current timer derived from time(2)
1021 virtual void OnBackgroundTimer(time_t curtime);
1023 /** Called whenever any command is about to be executed.
1024 * This event occurs for all registered commands, wether they are registered in the core,
1025 * or another module, and for invalid commands. Invalid commands may only be sent to this
1026 * function when the value of validated is false. By returning 1 from this method you may prevent the
1027 * command being executed. If you do this, no output is created by the core, and it is
1028 * down to your module to produce any output neccessary.
1029 * Note that unless you return 1, you should not destroy any structures (e.g. by using
1030 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
1031 * method returns, it will be passed an invalid pointer to the user object and crash!)
1032 * @param command The command being executed
1033 * @param parameters An array of array of characters containing the parameters for the command
1034 * @param pcnt The nuimber of parameters passed to the command
1035 * @param user the user issuing the command
1036 * @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.
1037 * @param original_line The entire original line as passed to the parser from the user
1038 * @return 1 to block the command, 0 to allow
1040 virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, User *user, bool validated, const std::string &original_line);
1042 /** Called after any command has been executed.
1043 * This event occurs for all registered commands, wether they are registered in the core,
1044 * or another module, but it will not occur for invalid commands (e.g. ones which do not
1045 * exist within the command table). The result code returned by the command handler is
1047 * @param command The command being executed
1048 * @param parameters An array of array of characters containing the parameters for the command
1049 * @param pcnt The nuimber of parameters passed to the command
1050 * @param user the user issuing the command
1051 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
1052 * @param original_line The entire original line as passed to the parser from the user
1054 virtual void OnPostCommand(const std::string &command, const char** parameters, int pcnt, User *user, CmdResult result, const std::string &original_line);
1056 /** Called to check if a user who is connecting can now be allowed to register
1057 * If any modules return false for this function, the user is held in the waiting
1058 * state until all modules return true. For example a module which implements ident
1059 * lookups will continue to return false for a user until their ident lookup is completed.
1060 * Note that the registration timeout for a user overrides these checks, if the registration
1061 * timeout is reached, the user is disconnected even if modules report that the user is
1062 * not ready to connect.
1063 * @param user The user to check
1064 * @return true to indicate readiness, false if otherwise
1066 virtual bool OnCheckReady(User* user);
1068 /** Called whenever a user is about to register their connection (e.g. before the user
1069 * is sent the MOTD etc). Modules can use this method if they are performing a function
1070 * which must be done before the actual connection is completed (e.g. ident lookups,
1071 * dnsbl lookups, etc).
1072 * Note that you should NOT delete the user record here by causing a disconnection!
1073 * Use OnUserConnect for that instead.
1074 * @param user The user registering
1075 * @return 1 to indicate user quit, 0 to continue
1077 virtual int OnUserRegister(User* user);
1079 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1080 * This method will always be called for each join, wether or not the channel is actually +i, and
1081 * determines the outcome of an if statement around the whole section of invite checking code.
1082 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1083 * @param user The user joining the channel
1084 * @param chan The channel being joined
1085 * @return 1 to explicitly allow the join, 0 to proceed as normal
1087 virtual int OnCheckInvite(User* user, Channel* chan);
1089 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1090 * This method will always be called for each join, wether or not the channel is actually +k, and
1091 * determines the outcome of an if statement around the whole section of key checking code.
1092 * if the user specified no key, the keygiven string will be a valid but empty value.
1093 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1094 * @param user The user joining the channel
1095 * @param chan The channel being joined
1096 * @return 1 to explicitly allow the join, 0 to proceed as normal
1098 virtual int OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
1100 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1101 * This method will always be called for each join, wether or not the channel is actually +l, and
1102 * determines the outcome of an if statement around the whole section of channel limit checking code.
1103 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1104 * @param user The user joining the channel
1105 * @param chan The channel being joined
1106 * @return 1 to explicitly allow the join, 0 to proceed as normal
1108 virtual int OnCheckLimit(User* user, Channel* chan);
1110 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
1111 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
1112 * determines the outcome of an if statement around the whole section of ban checking code.
1113 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1114 * @param user The user joining the channel
1115 * @param chan The channel being joined
1116 * @return 1 to explicitly allow the join, 0 to proceed as normal
1118 virtual int OnCheckBan(User* user, Channel* chan);
1120 /** Called on all /STATS commands
1121 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1122 * @param symbol the symbol provided to /STATS
1123 * @param user the user issuing the /STATS command
1124 * @param results A string_list to append results into. You should put all your results
1125 * into this string_list, rather than displaying them directly, so that your handler will
1126 * work when remote STATS queries are received.
1127 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1129 virtual int OnStats(char symbol, User* user, string_list &results);
1131 /** Called whenever a change of a local users displayed host is attempted.
1132 * Return 1 to deny the host change, or 0 to allow it.
1133 * @param user The user whos host will be changed
1134 * @param newhost The new hostname
1135 * @return 1 to deny the host change, 0 to allow
1137 virtual int OnChangeLocalUserHost(User* user, const std::string &newhost);
1139 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1140 * return 1 to deny the name change, or 0 to allow it.
1141 * @param user The user whos GECOS will be changed
1142 * @param newhost The new GECOS
1143 * @return 1 to deny the GECOS change, 0 to allow
1145 virtual int OnChangeLocalUserGECOS(User* user, const std::string &newhost);
1147 /** Called whenever a topic is changed by a local user.
1148 * Return 1 to deny the topic change, or 0 to allow it.
1149 * @param user The user changing the topic
1150 * @param chan The channels who's topic is being changed
1151 * @param topic The actual topic text
1152 * @param 1 to block the topic change, 0 to allow
1154 virtual int OnLocalTopicChange(User* user, Channel* chan, const std::string &topic);
1156 /** Called whenever a local topic has been changed.
1157 * To block topic changes you must use OnLocalTopicChange instead.
1158 * @param user The user changing the topic
1159 * @param chan The channels who's topic is being changed
1160 * @param topic The actual topic text
1162 virtual void OnPostLocalTopicChange(User* user, Channel* chan, const std::string &topic);
1164 /** Called whenever an Event class is sent to all module by another module.
1165 * Please see the documentation of Event::Send() for further information. The Event sent can
1166 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1167 * before doing anything to the event data, and you should *not* change the event data in any way!
1168 * @param event The Event class being received
1170 virtual void OnEvent(Event* event);
1172 /** Called whenever a Request class is sent to your module by another module.
1173 * Please see the documentation of Request::Send() for further information. The Request sent
1174 * can always be assumed to be non-NULL, you should not change the request object or its data.
1175 * Your method may return arbitary data in the char* result which the requesting module
1176 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1177 * @param request The Request class being received
1179 virtual char* OnRequest(Request* request);
1181 /** Called whenever an oper password is to be compared to what a user has input.
1182 * The password field (from the config file) is in 'password' and is to be compared against
1183 * 'input'. This method allows for encryption of oper passwords and much more besides.
1184 * You should return a nonzero value if you want to allow the comparison or zero if you wish
1186 * @param password The oper's password
1187 * @param input The password entered
1188 * @param tagnumber The tag number (from the configuration file) of this oper's tag
1189 * @return 1 to match the passwords, 0 to do nothing. -1 to not match, and not continue.
1191 virtual int OnOperCompare(const std::string &password, const std::string &input, int tagnumber);
1193 /** Called whenever a user is given usermode +o, anywhere on the network.
1194 * You cannot override this and prevent it from happening as it is already happened and
1195 * such a task must be performed by another server. You can however bounce modes by sending
1196 * servermodes out to reverse mode changes.
1197 * @param user The user who is opering
1199 virtual void OnGlobalOper(User* user);
1201 /** Called after a user has fully connected and all modules have executed OnUserConnect
1202 * This event is informational only. You should not change any user information in this
1203 * event. To do so, use the OnUserConnect method to change the state of local users.
1204 * This is called for both local and remote users.
1205 * @param user The user who is connecting
1207 virtual void OnPostConnect(User* user);
1209 /** Called whenever a ban is added to a channel's list.
1210 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1211 * @param source The user adding the ban
1212 * @param channel The channel the ban is being added to
1213 * @param banmask The ban mask being added
1214 * @return 1 to block the ban, 0 to continue as normal
1216 virtual int OnAddBan(User* source, Channel* channel,const std::string &banmask);
1218 /** Called whenever a ban is removed from a channel's list.
1219 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1220 * @param source The user deleting the ban
1221 * @param channel The channel the ban is being deleted from
1222 * @param banmask The ban mask being deleted
1223 * @return 1 to block the unban, 0 to continue as normal
1225 virtual int OnDelBan(User* source, Channel* channel,const std::string &banmask);
1227 /** Called immediately after any connection is accepted. This is intended for raw socket
1228 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1229 * no information relating to a user record as the connection has not been assigned yet.
1230 * There are no return values from this call as all modules get an opportunity if required to
1231 * process the connection.
1232 * @param fd The file descriptor returned from accept()
1233 * @param ip The IP address of the connecting user
1234 * @param localport The local port number the user connected to
1236 virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport);
1238 /** Called immediately before any write() operation on a user's socket in the core. Because
1239 * this event is a low level event no user information is associated with it. It is intended
1240 * for use by modules which may wrap connections within another API such as SSL for example.
1241 * return a non-zero result if you have handled the write operation, in which case the core
1242 * will not call write().
1243 * @param fd The file descriptor of the socket
1244 * @param buffer A char* buffer being written
1245 * @param Number of characters to write
1246 * @return Number of characters actually written or 0 if you didn't handle the operation
1248 virtual int OnRawSocketWrite(int fd, const char* buffer, int count);
1250 /** Called immediately before any socket is closed. When this event is called, shutdown()
1251 * has not yet been called on the socket.
1252 * @param fd The file descriptor of the socket prior to close()
1254 virtual void OnRawSocketClose(int fd);
1256 /** Called immediately upon connection of an outbound BufferedSocket which has been hooked
1258 * @param fd The file descriptor of the socket immediately after connect()
1260 virtual void OnRawSocketConnect(int fd);
1262 /** Called immediately before any read() operation on a client socket in the core.
1263 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1264 * when this event occurs.
1265 * Your event should return 1 if it has handled the reading itself, which prevents the core
1266 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1267 * the value of count. The value of readresult must be identical to an actual result that might
1268 * be returned from the read() system call, for example, number of bytes read upon success,
1269 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1270 * you MUST set readresult.
1271 * @param fd The file descriptor of the socket
1272 * @param buffer A char* buffer being read to
1273 * @param count The size of the buffer
1274 * @param readresult The amount of characters read, or 0
1275 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1277 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1279 /** Called whenever a user sets away.
1280 * This method has no parameter for the away message, as it is available in the
1281 * user record as User::awaymsg.
1282 * @param user The user setting away
1284 virtual void OnSetAway(User* user);
1286 /** Called when a user cancels their away state.
1287 * @param user The user returning from away
1289 virtual void OnCancelAway(User* user);
1291 /** Called whenever a NAMES list is requested.
1292 * You can produce the nameslist yourself, overriding the current list,
1293 * and if you do you must return 1. If you do not handle the names list,
1295 * @param The user requesting the NAMES list
1296 * @param Ptr The channel the NAMES list is requested for
1297 * @param userlist The user list for the channel (you may change this pointer.
1298 * If you want to change the values, take a copy first, and change the copy, then
1299 * point the pointer at your copy)
1300 * @return 1 to prevent the user list being sent to the client, 0 to allow it
1302 virtual int OnUserList(User* user, Channel* Ptr, CUList* &userlist);
1304 /** Called whenever a line of WHOIS output is sent to a user.
1305 * You may change the numeric and the text of the output by changing
1306 * the values numeric and text, but you cannot change the user the
1307 * numeric is sent to. You may however change the user's User values.
1308 * @param user The user the numeric is being sent to
1309 * @param dest The user being WHOISed
1310 * @param numeric The numeric of the line being sent
1311 * @param text The text of the numeric, including any parameters
1312 * @return nonzero to drop the line completely so that the user does not
1313 * receive it, or zero to allow the line to be sent.
1315 virtual int OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
1317 /** Called at intervals for modules to garbage-collect any hashes etc.
1318 * Certain data types such as hash_map 'leak' buckets, which must be
1319 * tidied up and freed by copying into a new item every so often. This
1320 * method is called when it is time to do that.
1322 virtual void OnGarbageCollect();
1324 /** Called whenever a user's write buffer has been completely sent.
1325 * This is called when the user's write buffer is completely empty, and
1326 * there are no more pending bytes to be written and no pending write events
1327 * in the socket engine's queue. This may be used to refill the buffer with
1328 * data which is being spooled in a controlled manner, e.g. LIST lines.
1329 * @param user The user who's buffer is now empty.
1331 virtual void OnBufferFlushed(User* user);
1335 #define CONF_NO_ERROR 0x000000
1336 #define CONF_NOT_A_NUMBER 0x000010
1337 #define CONF_INT_NEGATIVE 0x000080
1338 #define CONF_VALUE_NOT_FOUND 0x000100
1339 #define CONF_FILE_NOT_FOUND 0x000200
1342 /** Allows reading of values from configuration files
1343 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1344 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1345 * Constructing the class using one parameter allows you to specify a path to your own configuration
1346 * file, otherwise, inspircd.conf is read.
1348 class CoreExport ConfigReader : public classbase
1351 InspIRCd* ServerInstance;
1352 /** The contents of the configuration file
1353 * This protected member should never be accessed by a module (and cannot be accessed unless the
1354 * core is changed). It will contain a pointer to the configuration file data with unneeded data
1355 * (such as comments) stripped from it.
1357 ConfigDataHash* data;
1358 /** Used to store errors
1360 std::ostringstream* errorlog;
1361 /** If we're using our own config data hash or not
1364 /** True if an error occured reading the config file
1372 /** Default constructor.
1373 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1374 * as specified when running ./configure.
1376 ConfigReader(InspIRCd* Instance);
1377 /** Overloaded constructor.
1378 * This constructor initialises the ConfigReader class to read a user-specified config file
1380 ConfigReader(InspIRCd* Instance, const std::string &filename);
1381 /** Default destructor.
1382 * This method destroys the ConfigReader class.
1386 /** Retrieves a value from the config file.
1387 * This method retrieves a value from the config file. Where multiple copies of the tag
1388 * exist in the config file, index indicates which of the values to retrieve.
1390 std::string ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds = false);
1391 /** Retrieves a value from the config file.
1392 * This method retrieves a value from the config file. Where multiple copies of the tag
1393 * exist in the config file, index indicates which of the values to retrieve. If the
1394 * tag is not found the default value is returned instead.
1396 std::string ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds = false);
1398 /** Retrieves a boolean value from the config file.
1399 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1400 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1401 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1403 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1404 /** Retrieves a boolean value from the config file.
1405 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1406 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1407 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1408 * If the tag is not found, the default value is used instead.
1410 bool ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index);
1412 /** Retrieves an integer value from the config file.
1413 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1414 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1415 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1416 * return CONF_INVALID_NUMBER to be returned. need_positive is set if the number must be non-negative.
1417 * If a negative number is placed into a tag which is specified positive, 0 will be returned and GetError()
1418 * will return CONF_INT_NEGATIVE. Note that need_positive is not suitable to get an unsigned int - you
1419 * should cast the result to achieve that effect.
1421 int ReadInteger(const std::string &tag, const std::string &name, int index, bool need_positive);
1422 /** Retrieves an integer value from the config file.
1423 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1424 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1425 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1426 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1427 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1428 * will return CONF_NOT_UNSIGNED. If the tag is not found, the default value is used instead.
1430 int ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool need_positive);
1432 /** Returns the last error to occur.
1433 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1434 * A call to GetError() resets the error flag back to 0.
1437 /** Counts the number of times a given tag appears in the config file.
1438 * This method counts the number of times a tag appears in a config file, for use where
1439 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1440 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1441 * multiple instance tag.
1443 int Enumerate(const std::string &tag);
1444 /** Returns true if a config file is valid.
1445 * This method is partially implemented and will only return false if the config
1446 * file does not exist or could not be opened.
1449 /** Dumps the list of errors in a config file to an output location. If bail is true,
1450 * then the program will abort. If bail is false and user points to a valid user
1451 * record, the error report will be spooled to the given user by means of NOTICE.
1452 * if bool is false AND user is false, the error report will be spooled to all opers
1453 * by means of a NOTICE to all opers.
1455 void DumpErrors(bool bail,User* user);
1457 /** Returns the number of items within a tag.
1458 * For example if the tag was <test tag="blah" data="foo"> then this
1459 * function would return 2. Spaces and newlines both qualify as valid seperators
1462 int EnumerateValues(const std::string &tag, int index);
1467 /** Caches a text file into memory and can be used to retrieve lines from it.
1468 * This class contains methods for read-only manipulation of a text file in memory.
1469 * Either use the constructor type with one parameter to load a file into memory
1470 * at construction, or use the LoadFile method to load a file.
1472 class CoreExport FileReader : public classbase
1474 InspIRCd* ServerInstance;
1475 /** The file contents
1479 /** Content size in bytes
1481 unsigned long contentsize;
1483 /** Calculate content size in bytes
1488 /** Default constructor.
1489 * This method does not load any file into memory, you must use the LoadFile method
1490 * after constructing the class this way.
1492 FileReader(InspIRCd* Instance);
1494 /** Secondary constructor.
1495 * This method initialises the class with a file loaded into it ready for GetLine and
1496 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1499 FileReader(InspIRCd* Instance, const std::string &filename);
1501 /** Default destructor.
1502 * This deletes the memory allocated to the file.
1506 /** Used to load a file.
1507 * This method loads a file into the class ready for GetLine and
1508 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1511 void LoadFile(const std::string &filename);
1513 /** Returns the whole content of the file as std::string
1515 std::string Contents();
1517 /** Returns the entire size of the file as std::string
1519 unsigned long ContentSize();
1521 /** Returns true if the file exists
1522 * This function will return false if the file could not be opened.
1526 /** Retrieve one line from the file.
1527 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1528 * the index was out of bounds, or the line had no data on it.
1530 std::string GetLine(int x);
1532 /** Returns the size of the file in lines.
1533 * This method returns the number of lines in the read file. If it is 0, no lines have been
1534 * read into memory, either because the file is empty or it does not exist, or cannot be
1535 * opened due to permission problems.
1540 /** A DLLFactory (designed to load shared objects) containing a
1541 * handle to a module's init_module() function.
1543 typedef DLLFactory<Module> ircd_module;
1545 /** A list of loaded Modules
1547 typedef std::vector<Module*> ModuleList;
1549 /** A list of loaded module handles (ircd_module)
1551 typedef std::vector<ircd_module*> ModuleHandleList;
1553 /** ModuleManager takes care of all things module-related
1556 class CoreExport ModuleManager : public classbase
1559 /** Holds a string describing the last module error to occur
1561 char MODERR[MAXBUF];
1563 /** The feature names published by various modules
1565 featurelist Features;
1567 /** The interface names published by various modules
1569 interfacelist Interfaces;
1571 /** Total number of modules loaded into the ircd, minus one
1575 /** Our pointer to the main insp instance
1580 /** A list of ircd_module* module handles
1581 * Note that this list is always exactly 255 in size.
1582 * The actual number of loaded modules is available from GetModuleCount()
1584 ModuleHandleList handles;
1586 /** A list of Module* module classes
1587 * Note that this list is always exactly 255 in size.
1588 * The actual number of loaded modules is available from GetModuleCount()
1592 /** Simple, bog-standard, boring constructor.
1594 ModuleManager(InspIRCd* Ins);
1598 /** Returns text describing the last module error
1599 * @return The last error message to occur
1601 const char* LastError();
1603 /** Load a given module file
1604 * @param filename The file to load
1605 * @return True if the module was found and loaded
1607 bool Load(const char* filename);
1609 /** Unload a given module file
1610 * @param filename The file to unload
1611 * @return True if the module was unloaded
1613 bool Unload(const char* filename);
1615 /** Called by the InspIRCd constructor to load all modules from the config file.
1619 /** Get the total number of currently loaded modules
1620 * @return The number of loaded modules
1624 return this->ModCount;
1627 /** Find a module by name, and return a Module* to it.
1628 * This is preferred over iterating the module lists yourself.
1629 * @param name The module name to look up
1630 * @return A pointer to the module, or NULL if the module cannot be found
1632 Module* Find(const std::string &name);
1634 /** Remove a module handle pointer
1635 * @param j Index number of the module handle to remove
1636 * @return True if a handle existed at the given index, false otherwise
1638 bool EraseHandle(unsigned int j);
1640 /** Remove a Module pointer
1641 * @param j Index number of the Module to remove
1642 * @return True if a handle existed at the given index, false otherwise
1644 bool EraseModule(unsigned int j);
1646 /** Move a given module to a specific slot in the list
1647 * @param modulename The module name to relocate
1648 * @param slot The slot to move the module into
1650 void MoveTo(std::string modulename,int slot);
1652 /** Moves the given module to the last slot in the list
1653 * @param modulename The module name to relocate
1655 void MoveToLast(std::string modulename);
1657 /** Moves the given module to the first slot in the list
1658 * @param modulename The module name to relocate
1660 void MoveToFirst(std::string modulename);
1662 /** Moves one module to be placed after another in the list
1663 * @param modulename The module name to relocate
1664 * @param after The module name to place the module after
1666 void MoveAfter(std::string modulename, std::string after);
1668 /** Moves one module to be placed before another in the list
1669 * @param modulename The module name to relocate
1670 * @param after The module name to place the module before
1672 void MoveBefore(std::string modulename, std::string before);
1674 /** For use with Module::Prioritize().
1675 * When the return value of this function is returned from
1676 * Module::Prioritize(), this specifies that the module wishes
1677 * to be ordered exactly BEFORE 'modulename'. For more information
1678 * please see Module::Prioritize().
1679 * @param modulename The module your module wants to be before in the call list
1680 * @returns a priority ID which the core uses to relocate the module in the list
1682 long PriorityBefore(const std::string &modulename);
1684 /** For use with Module::Prioritize().
1685 * When the return value of this function is returned from
1686 * Module::Prioritize(), this specifies that the module wishes
1687 * to be ordered exactly AFTER 'modulename'. For more information please
1688 * see Module::Prioritize().
1689 * @param modulename The module your module wants to be after in the call list
1690 * @returns a priority ID which the core uses to relocate the module in the list
1692 long PriorityAfter(const std::string &modulename);
1694 /** Publish a 'feature'.
1695 * There are two ways for a module to find another module it depends on.
1696 * Either by name, using InspIRCd::FindModule, or by feature, using this
1697 * function. A feature is an arbitary string which identifies something this
1698 * module can do. For example, if your module provides SSL support, but other
1699 * modules provide SSL support too, all the modules supporting SSL should
1700 * publish an identical 'SSL' feature. This way, any module requiring use
1701 * of SSL functions can just look up the 'SSL' feature using FindFeature,
1702 * then use the module pointer they are given.
1703 * @param FeatureName The case sensitive feature name to make available
1704 * @param Mod a pointer to your module class
1705 * @returns True on success, false if the feature is already published by
1708 bool PublishFeature(const std::string &FeatureName, Module* Mod);
1710 /** Publish a module to an 'interface'.
1711 * Modules which implement the same interface (the same way of communicating
1712 * with other modules) can publish themselves to an interface, using this
1713 * method. When they do so, they become part of a list of related or
1714 * compatible modules, and a third module may then query for that list
1715 * and know that all modules within that list offer the same API.
1716 * A prime example of this is the hashing modules, which all accept the
1717 * same types of Request class. Consider this to be similar to PublishFeature,
1718 * except for that multiple modules may publish the same 'feature'.
1719 * @param InterfaceName The case sensitive interface name to make available
1720 * @param Mod a pointer to your module class
1721 * @returns True on success, false on failure (there are currently no failure
1724 bool PublishInterface(const std::string &InterfaceName, Module* Mod);
1726 /** Return a pair saying how many other modules are currently using the
1727 * interfaces provided by module m.
1728 * @param m The module to count usage for
1729 * @return A pair, where the first value is the number of uses of the interface,
1730 * and the second value is the interface name being used.
1732 std::pair<int,std::string> GetInterfaceInstanceCount(Module* m);
1734 /** Mark your module as using an interface.
1735 * If you mark your module as using an interface, then that interface
1736 * module may not unload until your module has unloaded first.
1737 * This can be used to prevent crashes by ensuring code you depend on
1738 * is always in memory while your module is active.
1739 * @param InterfaceName The interface to use
1741 void UseInterface(const std::string &InterfaceName);
1743 /** Mark your module as finished with an interface.
1744 * If you used UseInterface() above, you should use this method when
1745 * your module is finished with the interface (usually in its destructor)
1746 * to allow the modules which implement the given interface to be unloaded.
1747 * @param InterfaceName The interface you are finished with using.
1749 void DoneWithInterface(const std::string &InterfaceName);
1751 /** Unpublish a 'feature'.
1752 * When your module exits, it must call this method for every feature it
1753 * is providing so that the feature table is cleaned up.
1754 * @param FeatureName the feature to remove
1756 bool UnpublishFeature(const std::string &FeatureName);
1758 /** Unpublish your module from an interface
1759 * When your module exits, it must call this method for every interface
1760 * it is part of so that the interfaces table is cleaned up. Only when
1761 * the last item is deleted from an interface does the interface get
1763 * @param InterfaceName the interface to be removed from
1764 * @param Mod The module to remove from the interface list
1766 bool UnpublishInterface(const std::string &InterfaceName, Module* Mod);
1768 /** Find a 'feature'.
1769 * There are two ways for a module to find another module it depends on.
1770 * Either by name, using InspIRCd::FindModule, or by feature, using the
1771 * InspIRCd::PublishFeature method. A feature is an arbitary string which
1772 * identifies something this module can do. For example, if your module
1773 * provides SSL support, but other modules provide SSL support too, all
1774 * the modules supporting SSL should publish an identical 'SSL' feature.
1775 * To find a module capable of providing the feature you want, simply
1776 * call this method with the feature name you are looking for.
1777 * @param FeatureName The feature name you wish to obtain the module for
1778 * @returns A pointer to a valid module class on success, NULL on failure.
1780 Module* FindFeature(const std::string &FeatureName);
1782 /** Find an 'interface'.
1783 * An interface is a list of modules which all implement the same API.
1784 * @param InterfaceName The Interface you wish to obtain the module
1786 * @return A pointer to a deque of Module*, or NULL if the interface
1789 modulelist* FindInterface(const std::string &InterfaceName);
1791 /** Given a pointer to a Module, return its filename
1792 * @param m The module pointer to identify
1793 * @return The module name or an empty string
1795 const std::string& GetModuleName(Module* m);
1798 /** This definition is used as shorthand for the various classes
1799 * and functions needed to make a module loadable by the OS.
1800 * It defines the class factory and external init_module function.
1802 #define MODULE_INIT(y) \
1803 extern "C" DllExport Module * init_module(InspIRCd* Me) \