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 * ---------------------------------------------------
17 /** Used with OnAccessCheck() method of modules
19 enum AccessControlType {
20 ACR_DEFAULT, // Do default action (act as if the module isnt even loaded)
21 ACR_DENY, // deny the action
22 ACR_ALLOW, // allow the action
23 AC_KICK, // a user is being kicked
24 AC_DEOP, // a user is being deopped
25 AC_OP, // a user is being opped
26 AC_VOICE, // a user is being voiced
27 AC_DEVOICE, // a user is being devoiced
28 AC_HALFOP, // a user is being halfopped
29 AC_DEHALFOP, // a user is being dehalfopped
30 AC_INVITE, // a user is being invited
31 AC_GENERAL_MODE // a channel mode is being changed
34 /** Used to define a set of behavior bits for a module
37 VF_STATIC = 1, // module is static, cannot be /unloadmodule'd
38 VF_VENDOR = 2, // module is a vendor module (came in the original tarball, not 3rd party)
39 VF_SERVICEPROVIDER = 4, // module provides a service to other modules (can be a dependency)
40 VF_COMMON = 8 // module needs to be common on all servers in a network to link
43 /** Used with SendToMode()
50 /** Used to represent an event type, for user, channel or server
52 enum TargetTypeFlags {
59 /** Used to represent wether a message was PRIVMSG or NOTICE
70 #include "inspsocket.h"
78 /** If you change the module API, change this value.
79 * If you have enabled ipv6, the sizes of structs is
80 * different, and modules will be incompatible with
81 * ipv4 servers, so this value will be ten times as
82 * high on ipv6 servers.
84 #define NATIVE_API_VERSION 11024
86 #define API_VERSION (NATIVE_API_VERSION * 10)
88 #define API_VERSION (NATIVE_API_VERSION * 1)
93 /* Forward-delacare module for ModuleMessage etc
97 /** Low level definition of a FileReader classes file cache area -
98 * a text file seperated into lines.
100 typedef std::deque<std::string> file_cache;
102 /** A set of strings.
104 typedef file_cache string_list;
106 /** Holds a list of 'published features' for modules.
108 typedef std::map<std::string,Module*> featurelist;
110 /** Holds a list of modules which implement an interface
112 typedef std::deque<Module*> modulelist;
114 /** Holds a list of all modules which implement interfaces, by interface name
116 typedef std::map<std::string, std::pair<int, modulelist> > interfacelist;
119 * This #define allows us to call a method in all
120 * loaded modules in a readable simple way, e.g.:
121 * 'FOREACH_MOD(I_OnConnect,OnConnect(user));'
123 #define FOREACH_MOD(y,x) if (ServerInstance->Config->global_implementation[y] > 0) { \
124 for (int _i = 0; _i <= ServerInstance->GetModuleCount(); _i++) { \
125 if (ServerInstance->Config->implement_lists[_i][y]) \
128 ServerInstance->modules[_i]->x ; \
130 catch (CoreException& modexcept) \
132 ServerInstance->Log(DEFAULT,"Exception cought: %s",modexcept.GetReason()); \
138 * This #define allows us to call a method in all
139 * loaded modules in a readable simple way and pass
140 * an instance pointer to the macro. e.g.:
141 * 'FOREACH_MOD_I(Instance, OnConnect, OnConnect(user));'
143 #define FOREACH_MOD_I(z,y,x) if (z->Config->global_implementation[y] > 0) { \
144 for (int _i = 0; _i <= z->GetModuleCount(); _i++) { \
145 if (z->Config->implement_lists[_i][y]) \
148 z->modules[_i]->x ; \
150 catch (CoreException& modexcept) \
152 z->Log(DEFAULT,"Exception cought: %s",modexcept.GetReason()); \
157 * This define is similar to the one above but returns a result in MOD_RESULT.
158 * The first module to return a nonzero result is the value to be accepted,
159 * and any modules after are ignored.
161 #define FOREACH_RESULT(y,x) { if (ServerInstance->Config->global_implementation[y] > 0) { \
163 for (int _i = 0; _i <= ServerInstance->GetModuleCount(); _i++) { \
164 if (ServerInstance->Config->implement_lists[_i][y]) { \
167 int res = ServerInstance->modules[_i]->x ; \
173 catch (CoreException& modexcept) \
175 ServerInstance->Log(DEFAULT,"Exception cought: %s",modexcept.GetReason()); \
183 * This define is similar to the one above but returns a result in MOD_RESULT.
184 * The first module to return a nonzero result is the value to be accepted,
185 * and any modules after are ignored.
187 #define FOREACH_RESULT_I(z,y,x) { if (z->Config->global_implementation[y] > 0) { \
189 for (int _i = 0; _i <= z->GetModuleCount(); _i++) { \
190 if (z->Config->implement_lists[_i][y]) { \
193 int res = z->modules[_i]->x ; \
199 catch (CoreException& modexcept) \
201 z->Log(DEBUG,"Exception cought: %s",modexcept.GetReason()); \
208 /** Represents a non-local user.
209 * (in fact, any FD less than -1 does)
211 #define FD_MAGIC_NUMBER -42
215 /** Is a local user */
216 #define IS_LOCAL(x) ((x->GetFd() > -1))
218 /** Is a local user */
219 #define IS_LOCAL(x) ((x->GetFd() > -1) && (x->GetFd() <= MAX_DESCRIPTORS))
221 /** Is a remote user */
222 #define IS_REMOTE(x) (x->GetFd() < 0)
223 /** Is a module created user */
224 #define IS_MODULE_CREATED(x) (x->GetFd() == FD_MAGIC_NUMBER)
226 #define IS_OPER(x) (*x->oper)
228 #define IS_AWAY(x) (*x->awaymsg)
230 /** Holds a module's Version information.
231 * The four members (set by the constructor only) indicate details as to the version number
232 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
233 * The flags and API values represent the module flags and API version of the module.
234 * The API version of a module must match the API version of the core exactly for the module to
237 class CoreExport Version : public classbase
240 /** Version numbers, build number, flags and API version
242 const int Major, Minor, Revision, Build, Flags, API;
244 /** Initialize version class
246 Version(int major, int minor, int revision, int build, int flags, int api_ver);
249 /** The ModuleMessage class is the base class of Request and Event
250 * This class is used to represent a basic data structure which is passed
251 * between modules for safe inter-module communications.
253 class CoreExport ModuleMessage : public Extensible
258 virtual ~ModuleMessage() {};
261 /** The Request class is a unicast message directed at a given module.
262 * When this class is properly instantiated it may be sent to a module
263 * using the Send() method, which will call the given module's OnRequest
264 * method with this class as its parameter.
266 class CoreExport Request : public ModuleMessage
269 /** This member holds a pointer to arbitary data set by the emitter of the message
272 /** This should be a null-terminated string identifying the type of request,
273 * all modules should define this and use it to determine the nature of the
274 * request before they attempt to cast the Request in any way.
277 /** This is a pointer to the sender of the message, which can be used to
278 * directly trigger events, or to create a reply.
281 /** The single destination of the Request
285 /** Create a new Request
286 * This is for the 'old' way of casting whatever the data is
287 * to char* and hoping you get the right thing at the other end.
288 * This is slowly being depreciated in favor of the 'new' way.
290 Request(char* anydata, Module* src, Module* dst);
291 /** Create a new Request
292 * This is for the 'new' way of defining a subclass
293 * of Request and defining it in a common header,
294 * passing an object of your Request subclass through
295 * as a Request* and using the ID string to determine
296 * what to cast it back to and the other end. This is
297 * much safer as there are no casts not confirmed by
298 * the ID string, and all casts are child->parent and
299 * can be checked at runtime with dynamic_cast<>()
301 Request(Module* src, Module* dst, const char* idstr);
302 /** Fetch the Request data
305 /** Fetch the ID string
308 /** Fetch the request source
311 /** Fetch the request destination (should be 'this' in the receiving module)
314 /** Send the Request.
315 * Upon returning the result will be arbitary data returned by the module you
316 * sent the request to. It is up to your module to know what this data is and
317 * how to deal with it.
323 /** The Event class is a unicast message directed at all modules.
324 * When the class is properly instantiated it may be sent to all modules
325 * using the Send() method, which will trigger the OnEvent method in
326 * all modules passing the object as its parameter.
328 class CoreExport Event : public ModuleMessage
331 /** This member holds a pointer to arbitary data set by the emitter of the message
334 /** This is a pointer to the sender of the message, which can be used to
335 * directly trigger events, or to create a reply.
338 /** The event identifier.
339 * This is arbitary text which should be used to distinguish
340 * one type of event from another.
344 /** Create a new Event
346 Event(char* anydata, Module* src, const std::string &eventid);
347 /** Get the Event data
350 /** Get the event Source
353 /** Get the event ID.
354 * Use this to determine the event type for safe casting of the data
356 std::string GetEventID();
358 * The return result of an Event::Send() will always be NULL as
359 * no replies are expected.
361 char* Send(InspIRCd* ServerInstance);
364 /** This class can be used on its own to represent an exception, or derived to represent a module-specific exception.
365 * When a module whishes to abort, e.g. within a constructor, it should throw an exception using ModuleException or
366 * a class derived from ModuleException. If a module throws an exception during its constructor, the module will not
367 * be loaded. If this happens, the error message returned by ModuleException::GetReason will be displayed to the user
368 * attempting to load the module, or dumped to the console if the ircd is currently loading for the first time.
370 class CoreExport CoreException : public std::exception
373 /** Holds the error message to be displayed
375 const std::string err;
376 /** Source of the exception
378 const std::string source;
380 /** Default constructor, just uses the error mesage 'Core threw an exception'.
382 CoreException() : err("Core threw an exception"), source("The core") {}
383 /** This constructor can be used to specify an error message before throwing.
385 CoreException(const std::string &message) : err(message), source("The core") {}
386 /** This constructor can be used to specify an error message before throwing,
387 * and to specify the source of the exception.
389 CoreException(const std::string &message, const std::string &src) : err(message), source(src) {}
390 /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
391 * Actually no, it does nothing. Never mind.
394 virtual ~CoreException() throw() {};
395 /** Returns the reason for the exception.
396 * The module should probably put something informative here as the user will see this upon failure.
398 virtual const char* GetReason()
403 virtual const char* GetSource()
405 return source.c_str();
409 class CoreExport ModuleException : public CoreException
412 /** Default constructor, just uses the error mesage 'Module threw an exception'.
414 ModuleException() : CoreException("Module threw an exception", "A Module") {}
416 /** This constructor can be used to specify an error message before throwing.
418 ModuleException(const std::string &message) : CoreException(message, "A Module") {}
419 /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
420 * Actually no, it does nothing. Never mind.
423 virtual ~ModuleException() throw() {};
426 /** Priority types which can be returned from Module::Prioritize()
428 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
430 /** Implementation-specific flags which may be set in Module::Implements()
432 enum Implementation { I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash, I_OnServerRaw,
433 I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois, I_OnUserPreInvite,
434 I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick, I_OnUserMessage, I_OnUserNotice, I_OnMode,
435 I_OnGetServerDescription, I_OnSyncUser, I_OnSyncChannel, I_OnSyncChannelMetaData, I_OnSyncUserMetaData,
436 I_OnDecodeMetaData, I_ProtoSendMode, I_ProtoSendMetaData, I_OnWallops, I_OnChangeHost, I_OnChangeName, I_OnAddGLine,
437 I_OnAddZLine, I_OnAddQLine, I_OnAddKLine, I_OnAddELine, I_OnDelGLine, I_OnDelZLine, I_OnDelKLine, I_OnDelELine, I_OnDelQLine,
438 I_OnCleanup, I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule, I_OnUnloadModule,
439 I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnUserRrgister, I_OnCheckInvite,
440 I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnLocalTopicChange,
441 I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnOperCompre, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan, I_OnDelBan,
442 I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead, I_OnChangeLocalUserGECOS, I_OnUserRegister,
443 I_OnOperCompare, I_OnChannelDelete, I_OnPostOper, I_OnSyncOtherMetaData, I_OnSetAway, I_OnCancelAway, I_OnUserList,
444 I_OnPostCommand, I_OnPostJoin, I_OnWhoisLine, I_OnBuildExemptList, I_OnRawSocketConnect, I_OnGarbageCollect, I_OnBufferFlushed };
446 /** Base class for all InspIRCd modules
447 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
448 * its methods will be called when irc server events occur. class inherited from module must be
449 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
451 class CoreExport Module : public Extensible
454 /** Creator/owner pointer
456 InspIRCd* ServerInstance;
459 /** Default constructor.
460 * Creates a module class.
461 * @param Me An instance of the InspIRCd class which will be saved into ServerInstance for your use
462 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
464 Module(InspIRCd* Me);
466 /** Default destructor.
467 * destroys a module class
471 /** Returns the version number of a Module.
472 * The method should return a Version object with its version information assigned via
475 virtual Version GetVersion();
477 /** The Implements function specifies which methods a module should receive events for.
478 * The char* parameter passed to this function contains a set of true or false values
479 * (1 or 0) which indicate wether each function is implemented. You must use the Iimplementation
480 * enum (documented elsewhere on this page) to mark functions as active. For example, to
481 * receive events for OnUserJoin():
483 * Implements[I_OnUserJoin] = 1;
485 * @param The implement list
487 virtual void Implements(char* Implements);
489 /** Used to set the 'priority' of a module (e.g. when it is called in relation to other modules.
490 * Some modules prefer to be called before other modules, due to their design. For example, a
491 * module which is expected to operate on complete information would expect to be placed last, so
492 * that any other modules which wish to adjust that information would execute before it, to be sure
493 * its information is correct. You can change your module's priority by returning one of:
495 * PRIORITY_FIRST - To place your module first in the list
497 * PRIORITY_LAST - To place your module last in the list
499 * PRIORITY_DONTCARE - To leave your module as it is (this is the default value, if you do not implement this function)
501 * The result of InspIRCd::PriorityBefore() - To move your module before another named module
503 * The result of InspIRCd::PriorityLast() - To move your module after another named module
505 * For a good working example of this method call, please see src/modules/m_spanningtree.cpp
506 * and src/modules/m_hostchange.so which make use of it. It is highly recommended that unless
507 * your module has a real need to reorder its priority, it should not implement this function,
508 * as many modules changing their priorities can make the system redundant.
510 virtual Priority Prioritize();
512 /** Called when a user connects.
513 * The details of the connecting user are available to you in the parameter userrec *user
514 * @param user The user who is connecting
516 virtual void OnUserConnect(userrec* user);
518 /** Called when a user quits.
519 * The details of the exiting user are available to you in the parameter userrec *user
520 * This event is only called when the user is fully registered when they quit. To catch
521 * raw disconnections, use the OnUserDisconnect method.
522 * @param user The user who is quitting
523 * @param message The user's quit message (as seen by non-opers)
524 * @param oper_message The user's quit message (as seen by opers)
526 virtual void OnUserQuit(userrec* user, const std::string &message, const std::string &oper_message);
528 /** Called whenever a user's socket is closed.
529 * The details of the exiting user are available to you in the parameter userrec *user
530 * This event is called for all users, registered or not, as a cleanup method for modules
531 * which might assign resources to user, such as dns lookups, objects and sockets.
532 * @param user The user who is disconnecting
534 virtual void OnUserDisconnect(userrec* user);
536 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
537 * @param chan The channel being deleted
539 virtual void OnChannelDelete(chanrec* chan);
541 /** Called when a user joins a channel.
542 * The details of the joining user are available to you in the parameter userrec *user,
543 * and the details of the channel they have joined is available in the variable chanrec *channel
544 * @param user The user who is joining
545 * @param channel The channel being joined
546 * @param silent Change this to true if you want to conceal the JOIN command from the other users
547 * of the channel (useful for modules such as auditorium)
549 virtual void OnUserJoin(userrec* user, chanrec* channel, bool &silent);
551 /** Called after a user joins a channel
552 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
554 * @param user The user who is joining
555 * @param channel The channel being joined
557 virtual void OnPostJoin(userrec* user, chanrec* channel);
559 /** Called when a user parts a channel.
560 * The details of the leaving user are available to you in the parameter userrec *user,
561 * and the details of the channel they have left is available in the variable chanrec *channel
562 * @param user The user who is parting
563 * @param channel The channel being parted
564 * @param partmessage The part message, or an empty string
565 * @param silent Change this to true if you want to conceal the PART command from the other users
566 * of the channel (useful for modules such as auditorium)
568 virtual void OnUserPart(userrec* user, chanrec* channel, const std::string &partmessage, bool &silent);
570 /** Called on rehash.
571 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
572 * system. You should use it to reload any files so that your module keeps in step with the
573 * rest of the application. If a parameter is given, the core has done nothing. The module
574 * receiving the event can decide if this parameter has any relevence to it.
575 * @param user The user performing the rehash, if any -- if this is server initiated, the
576 * value of this variable will be NULL.
577 * @param parameter The (optional) parameter given to REHASH from the user.
579 virtual void OnRehash(userrec* user, const std::string ¶meter);
581 /** Called when a raw command is transmitted or received.
582 * This method is the lowest level of handler available to a module. It will be called with raw
583 * data which is passing through a connected socket. If you wish, you may munge this data by changing
584 * the string parameter "raw". If you do this, after your function exits it will immediately be
585 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
586 * inbound is set to true) the value of user will be the userrec of the connection sending the
587 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
588 * @param raw The raw string in RFC1459 format
589 * @param inbound A flag to indicate wether the data is coming into the daemon or going out to the user
590 * @param user The user record sending the text, when inbound == true.
592 virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
594 /** Called whenever a user is about to join a channel, before any processing is done.
595 * Returning a value of 1 from this function stops the process immediately, causing no
596 * output to be sent to the user by the core. If you do this you must produce your own numerics,
597 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
598 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
602 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
603 * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
604 * processing on the actual channel record at this point, however the channel NAME will still be passed in
605 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
606 * @param user The user joining the channel
607 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
608 * @param cname The channel name being joined. For new channels this is valid where chan is not.
609 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "@".
610 * You may alter this string to alter the user's modes on the channel.
611 * @return 1 To prevent the join, 0 to allow it.
613 virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname, std::string &privs);
615 /** Called whenever a user is about to be kicked.
616 * Returning a value of 1 from this function stops the process immediately, causing no
617 * output to be sent to the user by the core. If you do this you must produce your own numerics,
619 * @param source The user issuing the kick
620 * @param user The user being kicked
621 * @param chan The channel the user is being kicked from
622 * @param reason The kick reason
623 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
625 virtual int OnUserPreKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason);
627 /** Called whenever a user is kicked.
628 * If this method is called, the kick is already underway and cannot be prevented, so
629 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
630 * @param source The user issuing the kick
631 * @param user The user being kicked
632 * @param chan The channel the user is being kicked from
633 * @param reason The kick reason
634 * @param silent Change this to true if you want to conceal the PART command from the other users
635 * of the channel (useful for modules such as auditorium)
637 virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason, bool &silent);
639 /** Called whenever a user opers locally.
640 * The userrec will contain the oper mode 'o' as this function is called after any modifications
641 * are made to the user's structure by the core.
642 * @param user The user who is opering up
643 * @param opertype The opers type name
645 virtual void OnOper(userrec* user, const std::string &opertype);
647 /** Called after a user opers locally.
648 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
649 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
650 * out the OPERTYPE, etc.
651 * @param user The user who is opering up
652 * @param opertype The opers type name
654 virtual void OnPostOper(userrec* user, const std::string &opertype);
656 /** Called whenever a user types /INFO.
657 * The userrec will contain the information of the user who typed the command. Modules may use this
658 * method to output their own credits in /INFO (which is the ircd's version of an about box).
659 * It is purposefully not possible to modify any info that has already been output, or halt the list.
660 * You must write a 371 numeric to the user, containing your info in the following format:
662 * <nick> :information here
664 * @param user The user issuing /INFO
666 virtual void OnInfo(userrec* user);
668 /** Called whenever a /WHOIS is performed on a local user.
669 * The source parameter contains the details of the user who issued the WHOIS command, and
670 * the dest parameter contains the information of the user they are whoising.
671 * @param source The user issuing the WHOIS command
672 * @param dest The user who is being WHOISed
674 virtual void OnWhois(userrec* source, userrec* dest);
676 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
677 * Returning 1 from this function stops the process immediately, causing no
678 * output to be sent to the user by the core. If you do this you must produce your own numerics,
679 * notices etc. This is useful for modules which may want to filter invites to channels.
680 * @param source The user who is issuing the INVITE
681 * @param dest The user being invited
682 * @param channel The channel the user is being invited to
683 * @return 1 to deny the invite, 0 to allow
685 virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel);
687 /** Called after a user has been successfully invited to a channel.
688 * You cannot prevent the invite from occuring using this function, to do that,
689 * use OnUserPreInvite instead.
690 * @param source The user who is issuing the INVITE
691 * @param dest The user being invited
692 * @param channel The channel the user is being invited to
694 virtual void OnUserInvite(userrec* source,userrec* dest,chanrec* channel);
696 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
697 * Returning any nonzero value from this function stops the process immediately, causing no
698 * output to be sent to the user by the core. If you do this you must produce your own numerics,
699 * notices etc. This is useful for modules which may want to filter or redirect messages.
700 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
701 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
702 * of where the message is destined to be sent.
703 * @param user The user sending the message
704 * @param dest The target of the message (chanrec* or userrec*)
705 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
706 * @param text Changeable text being sent by the user
707 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
708 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
709 * It will be ignored for private messages.
710 * @return 1 to deny the NOTICE, 0 to allow it
712 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
714 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
715 * Returning any nonzero value from this function stops the process immediately, causing no
716 * output to be sent to the user by the core. If you do this you must produce your own numerics,
717 * notices etc. This is useful for modules which may want to filter or redirect messages.
718 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
719 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
720 * of where the message is destined to be sent.
721 * You may alter the message text as you wish before relinquishing control to the next module
722 * in the chain, and if no other modules block the text this altered form of the text will be sent out
723 * to the user and possibly to other servers.
724 * @param user The user sending the message
725 * @param dest The target of the message (chanrec* or userrec*)
726 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
727 * @param text Changeable text being sent by the user
728 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
729 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
730 * It will be ignored for private notices.
731 * @return 1 to deny the NOTICE, 0 to allow it
733 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
735 /** Called whenever the server wants to build the exemption list for a channel, but is not directly doing a PRIVMSG or NOTICE.
736 * For example, the spanningtree protocol will call this event when passing a privmsg on (but not processing it directly).
737 * @param message_type The message type, either MSG_PRIVMSG or MSG_NOTICE
738 * @param chan The channel to build the exempt list of
739 * @param sender The original sender of the PRIVMSG or NOTICE
740 * @param status The status char to be used for the channel list
741 * @param exempt_list The exempt list to be populated
743 virtual void OnBuildExemptList(MessageType message_type, chanrec* chan, userrec* sender, char status, CUList &exempt_list);
745 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
746 * Please note that although you can see remote nickchanges through this function, you should
747 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
748 * check user->server before taking any action (including returning nonzero from the method).
749 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
750 * module to generate some meaninful output.
751 * @param user The username changing their nick
752 * @param newnick Their new nickname
753 * @return 1 to deny the change, 0 to allow
755 virtual int OnUserPreNick(userrec* user, const std::string &newnick);
757 /** Called after any PRIVMSG sent from a user.
758 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
759 * if target_type is TYPE_CHANNEL.
760 * @param user The user sending the message
761 * @param dest The target of the message
762 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
763 * @param text the text being sent by the user
764 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
766 virtual void OnUserMessage(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
768 /** Called after any NOTICE sent from a user.
769 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
770 * if target_type is TYPE_CHANNEL.
771 * @param user The user sending the message
772 * @param dest The target of the message
773 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
774 * @param text the text being sent by the user
775 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
777 virtual void OnUserNotice(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
779 /** Called after every MODE command sent from a user
780 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
781 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
782 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
783 * @param user The user sending the MODEs
784 * @param dest The target of the modes (userrec* or chanrec*)
785 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
786 * @param text The actual modes and their parameters if any
788 virtual void OnMode(userrec* user, void* dest, int target_type, const std::string &text);
790 /** Allows modules to alter or create server descriptions
791 * Whenever a module requires a server description, for example for display in
792 * WHOIS, this function is called in all modules. You may change or define the
793 * description given in std::string &description. If you do, this description
794 * will be shown in the WHOIS fields.
795 * @param servername The servername being searched for
796 * @param description Alterable server description for this server
798 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
800 /** Allows modules to synchronize data which relates to users during a netburst.
801 * When this function is called, it will be called from the module which implements
802 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
803 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
804 * (see below). This function will be called for every user visible on your side
805 * of the burst, allowing you to for example set modes, etc. Do not use this call to
806 * synchronize data which you have stored using class Extensible -- There is a specialist
807 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
808 * @param user The user 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!
812 virtual void OnSyncUser(userrec* user, Module* proto, void* opaque);
814 /** Allows modules to synchronize data which relates to channels during a netburst.
815 * When this function is called, it will be called from the module which implements
816 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
817 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
818 * (see below). This function will be called for every user visible on your side
819 * of the burst, allowing you to for example set modes, etc. Do not use this call to
820 * synchronize data which you have stored using class Extensible -- There is a specialist
821 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
823 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
825 * @param chan The channel being syncronized
826 * @param proto A pointer to the module handling network protocol
827 * @param opaque An opaque pointer set by the protocol module, should not be modified!
829 virtual void OnSyncChannel(chanrec* chan, Module* proto, void* opaque);
831 /* Allows modules to syncronize metadata related to channels over the network during a netburst.
832 * Whenever the linking module wants to send out data, but doesnt know what the data
833 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
834 * this method is called.You should use the ProtoSendMetaData function after you've
835 * correctly decided how the data should be represented, to send the metadata on its way if it belongs
836 * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
837 * @param chan The channel whos metadata is being syncronized
838 * @param proto A pointer to the module handling network protocol
839 * @param opaque An opaque pointer set by the protocol module, should not be modified!
840 * @param extname The extensions name which is being searched for
841 * @param displayable If this value is true, the data is going to be displayed to a user,
842 * and not sent across the network. Use this to determine wether or not to show sensitive data.
844 virtual void OnSyncChannelMetaData(chanrec* chan, Module* proto,void* opaque, const std::string &extname, bool displayable = false);
846 /* Allows modules to syncronize metadata related to users over the network during a netburst.
847 * Whenever the linking module wants to send out data, but doesnt know what the data
848 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
849 * this method is called. You should use the ProtoSendMetaData function after you've
850 * correctly decided how the data should be represented, to send the metadata on its way if
851 * if it belongs to your module.
852 * @param user The user whos metadata is being syncronized
853 * @param proto A pointer to the module handling network protocol
854 * @param opaque An opaque pointer set by the protocol module, should not be modified!
855 * @param extname The extensions name which is being searched for
856 * @param displayable If this value is true, the data is going to be displayed to a user,
857 * and not sent across the network. Use this to determine wether or not to show sensitive data.
859 virtual void OnSyncUserMetaData(userrec* user, Module* proto,void* opaque, const std::string &extname, bool displayable = false);
861 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
862 * Whenever the linking module wants to send out data, but doesnt know what the data
863 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
864 * this method is called. You should use the ProtoSendMetaData function after you've
865 * correctly decided how the data should be represented, to send the metadata on its way if
866 * if it belongs to your module.
867 * @param proto A pointer to the module handling network protocol
868 * @param opaque An opaque pointer set by the protocol module, should not be modified!
869 * @param displayable If this value is true, the data is going to be displayed to a user,
870 * and not sent across the network. Use this to determine wether or not to show sensitive data.
872 virtual void OnSyncOtherMetaData(Module* proto, void* opaque, bool displayable = false);
874 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
875 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
876 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
877 * @param target The chanrec* or userrec* that data should be added to
878 * @param extname The extension name which is being sent
879 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
881 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata);
883 /** Implemented by modules which provide the ability to link servers.
884 * These modules will implement this method, which allows transparent sending of servermodes
885 * down the network link as a broadcast, without a module calling it having to know the format
886 * of the MODE command before the actual mode string.
888 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
889 * of how to use this function.
891 * @param opaque An opaque pointer set by the protocol module, should not be modified!
892 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
893 * @param target The chanrec* or userrec* that modes should be sent for
894 * @param modeline The modes and parameters to be sent
896 virtual void ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline);
898 /** Implemented by modules which provide the ability to link servers.
899 * These modules will implement this method, which allows metadata (extra data added to
900 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
901 * to other servers on a netburst and decoded at the other end by the same module on a
904 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
905 * how to use this function.
906 * @param opaque An opaque pointer set by the protocol module, should not be modified!
907 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
908 * @param target The chanrec* or userrec* that metadata should be sent for
909 * @param extname The extension name to send metadata for
910 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
912 virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata);
914 /** Called after every WALLOPS command.
915 * @param user The user sending the WALLOPS
916 * @param text The content of the WALLOPS message
918 virtual void OnWallops(userrec* user, const std::string &text);
920 /** Called whenever a user's hostname is changed.
921 * This event triggers after the host has been set.
922 * @param user The user whos host is being changed
923 * @param newhost The new hostname being set
925 virtual void OnChangeHost(userrec* user, const std::string &newhost);
927 /** Called whenever a user's GECOS (realname) is changed.
928 * This event triggers after the name has been set.
929 * @param user The user who's GECOS is being changed
930 * @param gecos The new GECOS being set on the user
932 virtual void OnChangeName(userrec* user, const std::string &gecos);
934 /** Called whenever a gline is added by a local user.
935 * This method is triggered after the line is added.
936 * @param duration The duration of the line in seconds
937 * @param source The sender of the line
938 * @param reason The reason text to be displayed
939 * @param hostmask The hostmask to add
941 virtual void OnAddGLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
943 /** Called whenever a zline is added by a local user.
944 * This method is triggered after the line is added.
945 * @param duration The duration of the line in seconds
946 * @param source The sender of the line
947 * @param reason The reason text to be displayed
948 * @param ipmask The hostmask to add
950 virtual void OnAddZLine(long duration, userrec* source, const std::string &reason, const std::string &ipmask);
952 /** Called whenever a kline is added by a local user.
953 * This method is triggered after the line is added.
954 * @param duration The duration of the line in seconds
955 * @param source The sender of the line
956 * @param reason The reason text to be displayed
957 * @param hostmask The hostmask to add
959 virtual void OnAddKLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
961 /** Called whenever a qline is added by a local user.
962 * This method is triggered after the line is added.
963 * @param duration The duration of the line in seconds
964 * @param source The sender of the line
965 * @param reason The reason text to be displayed
966 * @param nickmask The hostmask to add
968 virtual void OnAddQLine(long duration, userrec* source, const std::string &reason, const std::string &nickmask);
970 /** Called whenever a eline is added by a local user.
971 * This method is triggered after the line is added.
972 * @param duration The duration of the line in seconds
973 * @param source The sender of the line
974 * @param reason The reason text to be displayed
975 * @param hostmask The hostmask to add
977 virtual void OnAddELine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
979 /** Called whenever a gline is deleted.
980 * This method is triggered after the line is deleted.
981 * @param source The user removing the line
982 * @param hostmask The hostmask to delete
984 virtual void OnDelGLine(userrec* source, const std::string &hostmask);
986 /** Called whenever a zline is deleted.
987 * This method is triggered after the line is deleted.
988 * @param source The user removing the line
989 * @param hostmask The hostmask to delete
991 virtual void OnDelZLine(userrec* source, const std::string &ipmask);
993 /** Called whenever a kline is deleted.
994 * This method is triggered after the line is deleted.
995 * @param source The user removing the line
996 * @param hostmask The hostmask to delete
998 virtual void OnDelKLine(userrec* source, const std::string &hostmask);
1000 /** Called whenever a qline is deleted.
1001 * This method is triggered after the line is deleted.
1002 * @param source The user removing the line
1003 * @param hostmask The hostmask to delete
1005 virtual void OnDelQLine(userrec* source, const std::string &nickmask);
1007 /** Called whenever a eline is deleted.
1008 * This method is triggered after the line is deleted.
1009 * @param source The user removing the line
1010 * @param hostmask The hostmask to delete
1012 virtual void OnDelELine(userrec* source, const std::string &hostmask);
1014 /** Called before your module is unloaded to clean up Extensibles.
1015 * This method is called once for every user and channel on the network,
1016 * so that when your module unloads it may clear up any remaining data
1017 * in the form of Extensibles added using Extensible::Extend().
1018 * If the target_type variable is TYPE_USER, then void* item refers to
1019 * a userrec*, otherwise it refers to a chanrec*.
1020 * @param target_type The type of item being cleaned
1021 * @param item A pointer to the item's class
1023 virtual void OnCleanup(int target_type, void* item);
1025 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
1026 * have been applied. Please note that although you can see remote nickchanges through this function, you should
1027 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
1028 * check user->server before taking any action (including returning nonzero from the method).
1029 * Because this method is called after the nickchange is taken place, no return values are possible
1030 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
1031 * @param user The user changing their nick
1032 * @param oldnick The old nickname of the user before the nickchange
1034 virtual void OnUserPostNick(userrec* user, const std::string &oldnick);
1036 /** Called before an action which requires a channel privilage check.
1037 * This function is called before many functions which check a users status on a channel, for example
1038 * before opping a user, deopping a user, kicking a user, etc.
1039 * There are several values for access_type which indicate for what reason access is being checked.
1040 * These are:<br><br>
1041 * AC_KICK (0) - A user is being kicked<br>
1042 * AC_DEOP (1) - a user is being deopped<br>
1043 * AC_OP (2) - a user is being opped<br>
1044 * AC_VOICE (3) - a user is being voiced<br>
1045 * AC_DEVOICE (4) - a user is being devoiced<br>
1046 * AC_HALFOP (5) - a user is being halfopped<br>
1047 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
1048 * AC_INVITE () - a user is being invited<br>
1049 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
1050 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
1051 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
1052 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
1053 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
1054 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
1055 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
1056 * @param source The source of the access check
1057 * @param dest The destination of the access check
1058 * @param channel The channel which is being checked
1059 * @param access_type See above
1061 virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
1063 /** Called when a 005 numeric is about to be output.
1064 * The module should modify the 005 numeric if needed to indicate its features.
1065 * @param output The 005 string to be modified if neccessary.
1067 virtual void On005Numeric(std::string &output);
1069 /** Called when a client is disconnected by KILL.
1070 * If a client is killed by a server, e.g. a nickname collision or protocol error,
1072 * Return 1 from this function to prevent the kill, and 0 from this function to allow
1073 * it as normal. If you prevent the kill no output will be sent to the client, it is
1074 * down to your module to generate this information.
1075 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
1076 * If you do so youre risking race conditions, desyncs and worse!
1077 * @param source The user sending the KILL
1078 * @param dest The user being killed
1079 * @param reason The kill reason
1080 * @return 1 to prevent the kill, 0 to allow
1082 virtual int OnKill(userrec* source, userrec* dest, const std::string &reason);
1084 /** Called when an oper wants to disconnect a remote user via KILL
1085 * @param source The user sending the KILL
1086 * @param dest The user being killed
1087 * @param reason The kill reason
1089 virtual void OnRemoteKill(userrec* source, userrec* dest, const std::string &reason);
1091 /** Called whenever a module is loaded.
1092 * mod will contain a pointer to the module, and string will contain its name,
1093 * for example m_widgets.so. This function is primary for dependency checking,
1094 * your module may decide to enable some extra features if it sees that you have
1095 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
1096 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
1097 * but instead operate under reduced functionality, unless the dependency is
1098 * absolutely neccessary (e.g. a module that extends the features of another
1100 * @param mod A pointer to the new module
1101 * @param name The new module's filename
1103 virtual void OnLoadModule(Module* mod,const std::string &name);
1105 /** Called whenever a module is unloaded.
1106 * mod will contain a pointer to the module, and string will contain its name,
1107 * for example m_widgets.so. This function is primary for dependency checking,
1108 * your module may decide to enable some extra features if it sees that you have
1109 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
1110 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
1111 * but instead operate under reduced functionality, unless the dependency is
1112 * absolutely neccessary (e.g. a module that extends the features of another
1114 * @param mod Pointer to the module being unloaded (still valid)
1115 * @param name The filename of the module being unloaded
1117 virtual void OnUnloadModule(Module* mod,const std::string &name);
1119 /** Called once every five seconds for background processing.
1120 * This timer can be used to control timed features. Its period is not accurate
1121 * enough to be used as a clock, but it is gauranteed to be called at least once in
1122 * any five second period, directly from the main loop of the server.
1123 * @param curtime The current timer derived from time(2)
1125 virtual void OnBackgroundTimer(time_t curtime);
1127 /** Called whenever any command is about to be executed.
1128 * This event occurs for all registered commands, wether they are registered in the core,
1129 * or another module, and for invalid commands. Invalid commands may only be sent to this
1130 * function when the value of validated is false. By returning 1 from this method you may prevent the
1131 * command being executed. If you do this, no output is created by the core, and it is
1132 * down to your module to produce any output neccessary.
1133 * Note that unless you return 1, you should not destroy any structures (e.g. by using
1134 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
1135 * method returns, it will be passed an invalid pointer to the user object and crash!)
1136 * @param command The command being executed
1137 * @param parameters An array of array of characters containing the parameters for the command
1138 * @param pcnt The nuimber of parameters passed to the command
1139 * @param user the user issuing the command
1140 * @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.
1141 * @param original_line The entire original line as passed to the parser from the user
1142 * @return 1 to block the command, 0 to allow
1144 virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line);
1146 /** Called after any command has been executed.
1147 * This event occurs for all registered commands, wether they are registered in the core,
1148 * or another module, but it will not occur for invalid commands (e.g. ones which do not
1149 * exist within the command table). The result code returned by the command handler is
1151 * @param command The command being executed
1152 * @param parameters An array of array of characters containing the parameters for the command
1153 * @param pcnt The nuimber of parameters passed to the command
1154 * @param user the user issuing the command
1155 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
1156 * @param original_line The entire original line as passed to the parser from the user
1158 virtual void OnPostCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, CmdResult result, const std::string &original_line);
1160 /** Called to check if a user who is connecting can now be allowed to register
1161 * If any modules return false for this function, the user is held in the waiting
1162 * state until all modules return true. For example a module which implements ident
1163 * lookups will continue to return false for a user until their ident lookup is completed.
1164 * Note that the registration timeout for a user overrides these checks, if the registration
1165 * timeout is reached, the user is disconnected even if modules report that the user is
1166 * not ready to connect.
1167 * @param user The user to check
1168 * @return true to indicate readiness, false if otherwise
1170 virtual bool OnCheckReady(userrec* user);
1172 /** Called whenever a user is about to register their connection (e.g. before the user
1173 * is sent the MOTD etc). Modules can use this method if they are performing a function
1174 * which must be done before the actual connection is completed (e.g. ident lookups,
1175 * dnsbl lookups, etc).
1176 * Note that you should NOT delete the user record here by causing a disconnection!
1177 * Use OnUserConnect for that instead.
1178 * @param user The user registering
1179 * @return 1 to indicate user quit, 0 to continue
1181 virtual int OnUserRegister(userrec* user);
1183 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1184 * This method will always be called for each join, wether or not the channel is actually +i, and
1185 * determines the outcome of an if statement around the whole section of invite checking code.
1186 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1187 * @param user The user joining the channel
1188 * @param chan The channel being joined
1189 * @return 1 to explicitly allow the join, 0 to proceed as normal
1191 virtual int OnCheckInvite(userrec* user, chanrec* chan);
1193 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1194 * This method will always be called for each join, wether or not the channel is actually +k, and
1195 * determines the outcome of an if statement around the whole section of key checking code.
1196 * if the user specified no key, the keygiven string will be a valid but empty value.
1197 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1198 * @param user The user joining the channel
1199 * @param chan The channel being joined
1200 * @return 1 to explicitly allow the join, 0 to proceed as normal
1202 virtual int OnCheckKey(userrec* user, chanrec* chan, const std::string &keygiven);
1204 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1205 * This method will always be called for each join, wether or not the channel is actually +l, and
1206 * determines the outcome of an if statement around the whole section of channel limit checking code.
1207 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1208 * @param user The user joining the channel
1209 * @param chan The channel being joined
1210 * @return 1 to explicitly allow the join, 0 to proceed as normal
1212 virtual int OnCheckLimit(userrec* user, chanrec* chan);
1214 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
1215 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
1216 * determines the outcome of an if statement around the whole section of ban checking code.
1217 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1218 * @param user The user joining the channel
1219 * @param chan The channel being joined
1220 * @return 1 to explicitly allow the join, 0 to proceed as normal
1222 virtual int OnCheckBan(userrec* user, chanrec* chan);
1224 /** Called on all /STATS commands
1225 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1226 * @param symbol the symbol provided to /STATS
1227 * @param user the user issuing the /STATS command
1228 * @param results A string_list to append results into. You should put all your results
1229 * into this string_list, rather than displaying them directly, so that your handler will
1230 * work when remote STATS queries are received.
1231 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1233 virtual int OnStats(char symbol, userrec* user, string_list &results);
1235 /** Called whenever a change of a local users displayed host is attempted.
1236 * Return 1 to deny the host change, or 0 to allow it.
1237 * @param user The user whos host will be changed
1238 * @param newhost The new hostname
1239 * @return 1 to deny the host change, 0 to allow
1241 virtual int OnChangeLocalUserHost(userrec* user, const std::string &newhost);
1243 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1244 * return 1 to deny the name change, or 0 to allow it.
1245 * @param user The user whos GECOS will be changed
1246 * @param newhost The new GECOS
1247 * @return 1 to deny the GECOS change, 0 to allow
1249 virtual int OnChangeLocalUserGECOS(userrec* user, const std::string &newhost);
1251 /** Called whenever a topic is changed by a local user.
1252 * Return 1 to deny the topic change, or 0 to allow it.
1253 * @param user The user changing the topic
1254 * @param chan The channels who's topic is being changed
1255 * @param topic The actual topic text
1256 * @param 1 to block the topic change, 0 to allow
1258 virtual int OnLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic);
1260 /** Called whenever a local topic has been changed.
1261 * To block topic changes you must use OnLocalTopicChange instead.
1262 * @param user The user changing the topic
1263 * @param chan The channels who's topic is being changed
1264 * @param topic The actual topic text
1266 virtual void OnPostLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic);
1268 /** Called whenever an Event class is sent to all module by another module.
1269 * Please see the documentation of Event::Send() for further information. The Event sent can
1270 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1271 * before doing anything to the event data, and you should *not* change the event data in any way!
1272 * @param event The Event class being received
1274 virtual void OnEvent(Event* event);
1276 /** Called whenever a Request class is sent to your module by another module.
1277 * Please see the documentation of Request::Send() for further information. The Request sent
1278 * can always be assumed to be non-NULL, you should not change the request object or its data.
1279 * Your method may return arbitary data in the char* result which the requesting module
1280 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1281 * @param request The Request class being received
1283 virtual char* OnRequest(Request* request);
1285 /** Called whenever an oper password is to be compared to what a user has input.
1286 * The password field (from the config file) is in 'password' and is to be compared against
1287 * 'input'. This method allows for encryption of oper passwords and much more besides.
1288 * You should return a nonzero value if you want to allow the comparison or zero if you wish
1290 * @param password The oper's password
1291 * @param input The password entered
1292 * @param tagnumber The tag number (from the configuration file) of this oper's tag
1293 * @return 1 to match the passwords, 0 to do nothing. -1 to not match, and not continue.
1295 virtual int OnOperCompare(const std::string &password, const std::string &input, int tagnumber);
1297 /** Called whenever a user is given usermode +o, anywhere on the network.
1298 * You cannot override this and prevent it from happening as it is already happened and
1299 * such a task must be performed by another server. You can however bounce modes by sending
1300 * servermodes out to reverse mode changes.
1301 * @param user The user who is opering
1303 virtual void OnGlobalOper(userrec* user);
1305 /** Called after a user has fully connected and all modules have executed OnUserConnect
1306 * This event is informational only. You should not change any user information in this
1307 * event. To do so, use the OnUserConnect method to change the state of local users.
1308 * This is called for both local and remote users.
1309 * @param user The user who is connecting
1311 virtual void OnPostConnect(userrec* user);
1313 /** Called whenever a ban is added to a channel's list.
1314 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1315 * @param source The user adding the ban
1316 * @param channel The channel the ban is being added to
1317 * @param banmask The ban mask being added
1318 * @return 1 to block the ban, 0 to continue as normal
1320 virtual int OnAddBan(userrec* source, chanrec* channel,const std::string &banmask);
1322 /** Called whenever a ban is removed from a channel's list.
1323 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1324 * @param source The user deleting the ban
1325 * @param channel The channel the ban is being deleted from
1326 * @param banmask The ban mask being deleted
1327 * @return 1 to block the unban, 0 to continue as normal
1329 virtual int OnDelBan(userrec* source, chanrec* channel,const std::string &banmask);
1331 /** Called immediately after any connection is accepted. This is intended for raw socket
1332 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1333 * no information relating to a user record as the connection has not been assigned yet.
1334 * There are no return values from this call as all modules get an opportunity if required to
1335 * process the connection.
1336 * @param fd The file descriptor returned from accept()
1337 * @param ip The IP address of the connecting user
1338 * @param localport The local port number the user connected to
1340 virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport);
1342 /** Called immediately before any write() operation on a user's socket in the core. Because
1343 * this event is a low level event no user information is associated with it. It is intended
1344 * for use by modules which may wrap connections within another API such as SSL for example.
1345 * return a non-zero result if you have handled the write operation, in which case the core
1346 * will not call write().
1347 * @param fd The file descriptor of the socket
1348 * @param buffer A char* buffer being written
1349 * @param Number of characters to write
1350 * @return Number of characters actually written or 0 if you didn't handle the operation
1352 virtual int OnRawSocketWrite(int fd, const char* buffer, int count);
1354 /** Called immediately before any socket is closed. When this event is called, shutdown()
1355 * has not yet been called on the socket.
1356 * @param fd The file descriptor of the socket prior to close()
1358 virtual void OnRawSocketClose(int fd);
1360 /** Called immediately upon connection of an outbound InspSocket which has been hooked
1362 * @param fd The file descriptor of the socket immediately after connect()
1364 virtual void OnRawSocketConnect(int fd);
1366 /** Called immediately before any read() operation on a client socket in the core.
1367 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1368 * when this event occurs.
1369 * Your event should return 1 if it has handled the reading itself, which prevents the core
1370 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1371 * the value of count. The value of readresult must be identical to an actual result that might
1372 * be returned from the read() system call, for example, number of bytes read upon success,
1373 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1374 * you MUST set readresult.
1375 * @param fd The file descriptor of the socket
1376 * @param buffer A char* buffer being read to
1377 * @param count The size of the buffer
1378 * @param readresult The amount of characters read, or 0
1379 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1381 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1383 /** Called whenever a user sets away.
1384 * This method has no parameter for the away message, as it is available in the
1385 * user record as userrec::awaymsg.
1386 * @param user The user setting away
1388 virtual void OnSetAway(userrec* user);
1390 /** Called when a user cancels their away state.
1391 * @param user The user returning from away
1393 virtual void OnCancelAway(userrec* user);
1395 /** Called whenever a NAMES list is requested.
1396 * You can produce the nameslist yourself, overriding the current list,
1397 * and if you do you must return 1. If you do not handle the names list,
1399 * @param The user requesting the NAMES list
1400 * @param Ptr The channel the NAMES list is requested for
1401 * @param userlist The user list for the channel (you may change this pointer.
1402 * If you want to change the values, take a copy first, and change the copy, then
1403 * point the pointer at your copy)
1404 * @return 1 to prevent the user list being sent to the client, 0 to allow it
1406 virtual int OnUserList(userrec* user, chanrec* Ptr, CUList* &userlist);
1408 /** Called whenever a line of WHOIS output is sent to a user.
1409 * You may change the numeric and the text of the output by changing
1410 * the values numeric and text, but you cannot change the user the
1411 * numeric is sent to. You may however change the user's userrec values.
1412 * @param user The user the numeric is being sent to
1413 * @param dest The user being WHOISed
1414 * @param numeric The numeric of the line being sent
1415 * @param text The text of the numeric, including any parameters
1416 * @return nonzero to drop the line completely so that the user does not
1417 * receive it, or zero to allow the line to be sent.
1419 virtual int OnWhoisLine(userrec* user, userrec* dest, int &numeric, std::string &text);
1421 /** Called at intervals for modules to garbage-collect any hashes etc.
1422 * Certain data types such as hash_map 'leak' buckets, which must be
1423 * tidied up and freed by copying into a new item every so often. This
1424 * method is called when it is time to do that.
1426 virtual void OnGarbageCollect();
1428 /** Called whenever a user's write buffer has been completely sent.
1429 * This is called when the user's write buffer is completely empty, and
1430 * there are no more pending bytes to be written and no pending write events
1431 * in the socket engine's queue. This may be used to refill the buffer with
1432 * data which is being spooled in a controlled manner, e.g. LIST lines.
1433 * @param user The user who's buffer is now empty.
1435 virtual void OnBufferFlushed(userrec* user);
1439 #define CONF_NOT_A_NUMBER 0x000010
1440 #define CONF_NOT_UNSIGNED 0x000080
1441 #define CONF_VALUE_NOT_FOUND 0x000100
1442 #define CONF_FILE_NOT_FOUND 0x000200
1445 /** Allows reading of values from configuration files
1446 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1447 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1448 * Constructing the class using one parameter allows you to specify a path to your own configuration
1449 * file, otherwise, inspircd.conf is read.
1451 class CoreExport ConfigReader : public classbase
1454 InspIRCd* ServerInstance;
1455 /** The contents of the configuration file
1456 * This protected member should never be accessed by a module (and cannot be accessed unless the
1457 * core is changed). It will contain a pointer to the configuration file data with unneeded data
1458 * (such as comments) stripped from it.
1460 ConfigDataHash* data;
1461 /** Used to store errors
1463 std::ostringstream* errorlog;
1464 /** If we're using our own config data hash or not
1467 /** True if an error occured reading the config file
1475 /** Default constructor.
1476 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1477 * as specified when running ./configure.
1479 ConfigReader(InspIRCd* Instance);
1480 /** Overloaded constructor.
1481 * This constructor initialises the ConfigReader class to read a user-specified config file
1483 ConfigReader(InspIRCd* Instance, const std::string &filename);
1484 /** Default destructor.
1485 * This method destroys the ConfigReader class.
1489 /** Retrieves a value from the config file.
1490 * This method retrieves a value from the config file. Where multiple copies of the tag
1491 * exist in the config file, index indicates which of the values to retrieve.
1493 std::string ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds = false);
1494 /** Retrieves a value from the config file.
1495 * This method retrieves a value from the config file. Where multiple copies of the tag
1496 * exist in the config file, index indicates which of the values to retrieve. If the
1497 * tag is not found the default value is returned instead.
1499 std::string ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds = false);
1501 /** Retrieves a boolean value from the config file.
1502 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1503 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1504 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1506 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1507 /** Retrieves a boolean value from the config file.
1508 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1509 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1510 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1511 * If the tag is not found, the default value is used instead.
1513 bool ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index);
1515 /** Retrieves an integer value from the config file.
1516 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1517 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1518 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1519 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1520 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1521 * will return CONF_NOT_UNSIGNED
1523 long ReadInteger(const std::string &tag, const std::string &name, int index, bool needs_unsigned);
1524 /** Retrieves an integer value from the config file.
1525 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1526 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1527 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1528 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1529 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1530 * will return CONF_NOT_UNSIGNED. If the tag is not found, the default value is used instead.
1532 long ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool needs_unsigned);
1534 /** Returns the last error to occur.
1535 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1536 * A call to GetError() resets the error flag back to 0.
1539 /** Counts the number of times a given tag appears in the config file.
1540 * This method counts the number of times a tag appears in a config file, for use where
1541 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1542 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1543 * multiple instance tag.
1545 int Enumerate(const std::string &tag);
1546 /** Returns true if a config file is valid.
1547 * This method is partially implemented and will only return false if the config
1548 * file does not exist or could not be opened.
1551 /** Dumps the list of errors in a config file to an output location. If bail is true,
1552 * then the program will abort. If bail is false and user points to a valid user
1553 * record, the error report will be spooled to the given user by means of NOTICE.
1554 * if bool is false AND user is false, the error report will be spooled to all opers
1555 * by means of a NOTICE to all opers.
1557 void DumpErrors(bool bail,userrec* user);
1559 /** Returns the number of items within a tag.
1560 * For example if the tag was <test tag="blah" data="foo"> then this
1561 * function would return 2. Spaces and newlines both qualify as valid seperators
1564 int EnumerateValues(const std::string &tag, int index);
1569 /** Caches a text file into memory and can be used to retrieve lines from it.
1570 * This class contains methods for read-only manipulation of a text file in memory.
1571 * Either use the constructor type with one parameter to load a file into memory
1572 * at construction, or use the LoadFile method to load a file.
1574 class CoreExport FileReader : public classbase
1576 InspIRCd* ServerInstance;
1577 /** The file contents
1581 /** Content size in bytes
1583 unsigned long contentsize;
1585 /** Calculate content size in bytes
1590 /** Default constructor.
1591 * This method does not load any file into memory, you must use the LoadFile method
1592 * after constructing the class this way.
1594 FileReader(InspIRCd* Instance);
1596 /** Secondary constructor.
1597 * This method initialises the class with a file loaded into it ready for GetLine and
1598 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1601 FileReader(InspIRCd* Instance, const std::string &filename);
1603 /** Default destructor.
1604 * This deletes the memory allocated to the file.
1608 /** Used to load a file.
1609 * This method loads a file into the class ready for GetLine and
1610 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1613 void LoadFile(const std::string &filename);
1615 /** Returns the whole content of the file as std::string
1617 std::string Contents();
1619 /** Returns the entire size of the file as std::string
1621 unsigned long ContentSize();
1623 /** Returns true if the file exists
1624 * This function will return false if the file could not be opened.
1628 /** Retrieve one line from the file.
1629 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1630 * the index was out of bounds, or the line had no data on it.
1632 std::string GetLine(int x);
1634 /** Returns the size of the file in lines.
1635 * This method returns the number of lines in the read file. If it is 0, no lines have been
1636 * read into memory, either because the file is empty or it does not exist, or cannot be
1637 * opened due to permission problems.
1643 /** Instantiates classes inherited from Module.
1644 * This class creates a class inherited from type Module, using new. This is to allow for modules
1645 * to create many different variants of Module, dependent on architecture, configuration, etc.
1646 * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
1649 class CoreExport ModuleFactory : public classbase
1652 /** The default constructor does nothing.
1655 /** The default destructor does nothing
1657 virtual ~ModuleFactory() { }
1658 /** Creates a new module.
1659 * Your inherited class of ModuleFactory must return a pointer to your Module class
1660 * using this method.
1662 virtual Module * CreateModule(InspIRCd* Me) = 0;
1665 /** A DLLFactory (designed to load shared objects) containing a ModuleFactory.
1667 typedef DLLFactory<ModuleFactory> ircd_module;
1669 /** A list of loaded Modules
1671 typedef std::vector<Module*> ModuleList;
1673 /** A list of loaded ModuleFactories
1675 typedef std::vector<ircd_module*> FactoryList;
1677 /** This definition is used as shorthand for the various classes
1678 * and functions needed to make a module loadable by the OS.
1679 * It defines the class factory and external init_module function.
1681 #define MODULE_INIT(y) \
1682 class Factory : public ModuleFactory \
1685 virtual Module * CreateModule(InspIRCd* Me) \
1690 extern "C" DllExport void * init_module(void) \
1692 return new Factory; \