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
48 enum TargetTypeFlags {
64 #include "inspsocket.h"
72 /** If you change the module API, change this value.
73 * If you have enabled ipv6, the sizes of structs is
74 * different, and modules will be incompatible with
75 * ipv4 servers, so this value will be ten times as
76 * high on ipv6 servers.
78 #define NATIVE_API_VERSION 11020
80 #define API_VERSION (NATIVE_API_VERSION * 10)
82 #define API_VERSION (NATIVE_API_VERSION * 1)
87 /* Forward-delacare module for ModuleMessage etc
91 /** Low level definition of a FileReader classes file cache area
93 typedef std::deque<std::string> file_cache;
94 typedef file_cache string_list;
96 /** Holds a list of 'published features' for modules.
98 typedef std::map<std::string,Module*> featurelist;
100 /** Holds a list of modules which implement an interface
102 typedef std::deque<Module*> modulelist;
104 /** Holds a list of all modules which implement interfaces, by interface name
106 typedef std::map<std::string, std::pair<int, modulelist> > interfacelist;
109 * This #define allows us to call a method in all
110 * loaded modules in a readable simple way, e.g.:
111 * 'FOREACH_MOD(I_OnXonnwxr,OnConnect(user));'
113 #define FOREACH_MOD(y,x) if (ServerInstance->Config->global_implementation[y] > 0) { \
114 for (int _i = 0; _i <= ServerInstance->GetModuleCount(); _i++) { \
115 if (ServerInstance->Config->implement_lists[_i][y]) \
118 ServerInstance->modules[_i]->x ; \
120 catch (CoreException& modexcept) \
122 ServerInstance->Log(DEFAULT,"Exception cought: %s",modexcept.GetReason()); \
127 #define FOREACH_MOD_I(z,y,x) if (z->Config->global_implementation[y] > 0) { \
128 for (int _i = 0; _i <= z->GetModuleCount(); _i++) { \
129 if (z->Config->implement_lists[_i][y]) \
132 z->modules[_i]->x ; \
134 catch (CoreException& modexcept) \
136 z->Log(DEFAULT,"Exception cought: %s",modexcept.GetReason()); \
141 * This define is similar to the one above but returns a result in MOD_RESULT.
142 * The first module to return a nonzero result is the value to be accepted,
143 * and any modules after are ignored.
145 #define FOREACH_RESULT(y,x) { if (ServerInstance->Config->global_implementation[y] > 0) { \
147 for (int _i = 0; _i <= ServerInstance->GetModuleCount(); _i++) { \
148 if (ServerInstance->Config->implement_lists[_i][y]) { \
151 int res = ServerInstance->modules[_i]->x ; \
157 catch (CoreException& modexcept) \
159 ServerInstance->Log(DEFAULT,"Exception cought: %s",modexcept.GetReason()); \
166 #define FOREACH_RESULT_I(z,y,x) { if (z->Config->global_implementation[y] > 0) { \
168 for (int _i = 0; _i <= z->GetModuleCount(); _i++) { \
169 if (z->Config->implement_lists[_i][y]) { \
172 int res = z->modules[_i]->x ; \
178 catch (CoreException& modexcept) \
180 z->Log(DEBUG,"Exception cought: %s",modexcept.GetReason()); \
187 #define FD_MAGIC_NUMBER -42
191 #define IS_LOCAL(x) ((x->GetFd() > -1) && (x->GetFd() <= MAX_DESCRIPTORS))
192 #define IS_REMOTE(x) (x->GetFd() < 0)
193 #define IS_MODULE_CREATED(x) (x->GetFd() == FD_MAGIC_NUMBER)
194 #define IS_OPER(x) (*x->oper)
195 #define IS_AWAY(x) (*x->awaymsg)
197 /** Holds a module's Version information
198 * The four members (set by the constructor only) indicate details as to the version number
199 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
201 class Version : public classbase
204 const int Major, Minor, Revision, Build, Flags, API;
205 Version(int major, int minor, int revision, int build, int flags, int api_ver);
208 /** The ModuleMessage class is the base class of Request and Event
209 * This class is used to represent a basic data structure which is passed
210 * between modules for safe inter-module communications.
212 class ModuleMessage : public Extensible
215 virtual ~ModuleMessage() {};
218 /** The Request class is a unicast message directed at a given module.
219 * When this class is properly instantiated it may be sent to a module
220 * using the Send() method, which will call the given module's OnRequest
221 * method with this class as its parameter.
223 class Request : public ModuleMessage
226 /** This member holds a pointer to arbitary data set by the emitter of the message
229 /** This should be a null-terminated string identifying the type of request,
230 * all modules should define this and use it to determine the nature of the
231 * request before they attempt to cast the Request in any way.
234 /** This is a pointer to the sender of the message, which can be used to
235 * directly trigger events, or to create a reply.
238 /** The single destination of the Request
242 /** Create a new Request
243 * This is for the 'old' way of casting whatever the data is
244 * to char* and hoping you get the right thing at the other end.
245 * This is slowly being depreciated in favor of the 'new' way.
247 Request(char* anydata, Module* src, Module* dst);
248 /** Create a new Request
249 * This is for the 'new' way of defining a subclass
250 * of Request and defining it in a common header,
251 * passing an object of your Request subclass through
252 * as a Request* and using the ID string to determine
253 * what to cast it back to and the other end. This is
254 * much safer as there are no casts not confirmed by
255 * the ID string, and all casts are child->parent and
256 * can be checked at runtime with dynamic_cast<>()
258 Request(Module* src, Module* dst, const char* idstr);
259 /** Fetch the Request data
262 /** Fetch the ID string
265 /** Fetch the request source
268 /** Fetch the request destination (should be 'this' in the receiving module)
271 /** Send the Request.
272 * Upon returning the result will be arbitary data returned by the module you
273 * sent the request to. It is up to your module to know what this data is and
274 * how to deal with it.
280 /** The Event class is a unicast message directed at all modules.
281 * When the class is properly instantiated it may be sent to all modules
282 * using the Send() method, which will trigger the OnEvent method in
283 * all modules passing the object as its parameter.
285 class Event : public ModuleMessage
288 /** This member holds a pointer to arbitary data set by the emitter of the message
291 /** This is a pointer to the sender of the message, which can be used to
292 * directly trigger events, or to create a reply.
295 /** The event identifier.
296 * This is arbitary text which should be used to distinguish
297 * one type of event from another.
301 /** Create a new Event
303 Event(char* anydata, Module* src, const std::string &eventid);
304 /** Get the Event data
307 /** Get the event Source
310 /** Get the event ID.
311 * Use this to determine the event type for safe casting of the data
313 std::string GetEventID();
315 * The return result of an Event::Send() will always be NULL as
316 * no replies are expected.
318 char* Send(InspIRCd* ServerInstance);
321 /** This class can be used on its own to represent an exception, or derived to represent a module-specific exception.
322 * When a module whishes to abort, e.g. within a constructor, it should throw an exception using ModuleException or
323 * a class derived from ModuleException. If a module throws an exception during its constructor, the module will not
324 * be loaded. If this happens, the error message returned by ModuleException::GetReason will be displayed to the user
325 * attempting to load the module, or dumped to the console if the ircd is currently loading for the first time.
327 class CoreException : public std::exception
330 /** Holds the error message to be displayed
332 const std::string err;
333 const std::string source;
335 /** Default constructor, just uses the error mesage 'Core threw an exception'.
337 CoreException() : err("Core threw an exception"), source("The core") {}
338 /** This constructor can be used to specify an error message before throwing.
340 CoreException(const std::string &message) : err(message), source("The core") {}
341 /** This constructor can be used to specify an error message before throwing,
342 * and to specify the source of the exception.
344 CoreException(const std::string &message, const std::string &src) : err(message), source(src) {}
345 /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
346 * Actually no, it does nothing. Never mind.
349 virtual ~CoreException() throw() {};
350 /** Returns the reason for the exception.
351 * The module should probably put something informative here as the user will see this upon failure.
353 virtual const char* GetReason()
358 virtual const char* GetSource()
360 return source.c_str();
364 class ModuleException : public CoreException
367 /** Default constructor, just uses the error mesage 'Module threw an exception'.
369 ModuleException() : CoreException("Module threw an exception", "A Module") {}
371 /** This constructor can be used to specify an error message before throwing.
373 ModuleException(const std::string &message) : CoreException(message, "A Module") {}
374 /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
375 * Actually no, it does nothing. Never mind.
378 virtual ~ModuleException() throw() {};
381 /** Priority types which can be returned from Module::Prioritize()
383 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
385 /** Implementation-specific flags which may be set in Module::Implements()
387 enum Implementation { I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash, I_OnServerRaw,
388 I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois, I_OnUserPreInvite,
389 I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick, I_OnUserMessage, I_OnUserNotice, I_OnMode,
390 I_OnGetServerDescription, I_OnSyncUser, I_OnSyncChannel, I_OnSyncChannelMetaData, I_OnSyncUserMetaData,
391 I_OnDecodeMetaData, I_ProtoSendMode, I_ProtoSendMetaData, I_OnWallops, I_OnChangeHost, I_OnChangeName, I_OnAddGLine,
392 I_OnAddZLine, I_OnAddQLine, I_OnAddKLine, I_OnAddELine, I_OnDelGLine, I_OnDelZLine, I_OnDelKLine, I_OnDelELine, I_OnDelQLine,
393 I_OnCleanup, I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule, I_OnUnloadModule,
394 I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnUserRrgister, I_OnCheckInvite,
395 I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnLocalTopicChange,
396 I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnOperCompre, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan, I_OnDelBan,
397 I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead, I_OnChangeLocalUserGECOS, I_OnUserRegister,
398 I_OnOperCompare, I_OnChannelDelete, I_OnPostOper, I_OnSyncOtherMetaData, I_OnSetAway, I_OnCancelAway, I_OnUserList,
399 I_OnPostCommand, I_OnPostJoin, I_OnWhoisLine, I_OnBuildExemptList, I_OnRawSocketConnect, I_OnGarbageCollect, I_OnBufferFlushed };
401 /** Base class for all InspIRCd modules
402 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
403 * its methods will be called when irc server events occur. class inherited from module must be
404 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
406 class Module : public Extensible
409 InspIRCd* ServerInstance;
412 /** Default constructor
413 * Creates a module class.
414 * @param Me An instance of the InspIRCd class which will be saved into ServerInstance for your use
415 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
417 Module(InspIRCd* Me);
419 /** Default destructor
420 * destroys a module class
424 /** Returns the version number of a Module.
425 * The method should return a Version object with its version information assigned via
428 virtual Version GetVersion();
430 /** The Implements function specifies which methods a module should receive events for.
431 * The char* parameter passed to this function contains a set of true or false values
432 * (1 or 0) which indicate wether each function is implemented. You must use the Iimplementation
433 * enum (documented elsewhere on this page) to mark functions as active. For example, to
434 * receive events for OnUserJoin():
436 * Implements[I_OnUserJoin] = 1;
438 * @param The implement list
440 virtual void Implements(char* Implements);
442 /** Used to set the 'priority' of a module (e.g. when it is called in relation to other modules.
443 * Some modules prefer to be called before other modules, due to their design. For example, a
444 * module which is expected to operate on complete information would expect to be placed last, so
445 * that any other modules which wish to adjust that information would execute before it, to be sure
446 * its information is correct. You can change your module's priority by returning one of:
448 * PRIORITY_FIRST - To place your module first in the list
450 * PRIORITY_LAST - To place your module last in the list
452 * PRIORITY_DONTCARE - To leave your module as it is (this is the default value, if you do not implement this function)
454 * The result of InspIRCd::PriorityBefore() - To move your module before another named module
456 * The result of InspIRCd::PriorityLast() - To move your module after another named module
458 * For a good working example of this method call, please see src/modules/m_spanningtree.cpp
459 * and src/modules/m_hostchange.so which make use of it. It is highly recommended that unless
460 * your module has a real need to reorder its priority, it should not implement this function,
461 * as many modules changing their priorities can make the system redundant.
463 virtual Priority Prioritize();
465 /** Called when a user connects.
466 * The details of the connecting user are available to you in the parameter userrec *user
467 * @param user The user who is connecting
469 virtual void OnUserConnect(userrec* user);
471 /** Called when a user quits.
472 * The details of the exiting user are available to you in the parameter userrec *user
473 * This event is only called when the user is fully registered when they quit. To catch
474 * raw disconnections, use the OnUserDisconnect method.
475 * @param user The user who is quitting
476 * @param message The user's quit message (as seen by non-opers)
477 * @param oper_message The user's quit message (as seen by opers)
479 virtual void OnUserQuit(userrec* user, const std::string &message, const std::string &oper_message);
481 /** Called whenever a user's socket is closed.
482 * The details of the exiting user are available to you in the parameter userrec *user
483 * This event is called for all users, registered or not, as a cleanup method for modules
484 * which might assign resources to user, such as dns lookups, objects and sockets.
485 * @param user The user who is disconnecting
487 virtual void OnUserDisconnect(userrec* user);
489 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
490 * @param chan The channel being deleted
492 virtual void OnChannelDelete(chanrec* chan);
494 /** Called when a user joins a channel.
495 * The details of the joining user are available to you in the parameter userrec *user,
496 * and the details of the channel they have joined is available in the variable chanrec *channel
497 * @param user The user who is joining
498 * @param channel The channel being joined
499 * @param silent Change this to true if you want to conceal the JOIN command from the other users
500 * of the channel (useful for modules such as auditorium)
502 virtual void OnUserJoin(userrec* user, chanrec* channel, bool &silent);
504 /** Called after a user joins a channel
505 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
507 * @param user The user who is joining
508 * @param channel The channel being joined
510 virtual void OnPostJoin(userrec* user, chanrec* channel);
512 /** Called when a user parts a channel.
513 * The details of the leaving user are available to you in the parameter userrec *user,
514 * and the details of the channel they have left is available in the variable chanrec *channel
515 * @param user The user who is parting
516 * @param channel The channel being parted
517 * @param partmessage The part message, or an empty string
518 * @param silent Change this to true if you want to conceal the PART command from the other users
519 * of the channel (useful for modules such as auditorium)
521 virtual void OnUserPart(userrec* user, chanrec* channel, const std::string &partmessage, bool &silent);
523 /** Called on rehash.
524 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
525 * system. You should use it to reload any files so that your module keeps in step with the
526 * rest of the application. If a parameter is given, the core has done nothing. The module
527 * receiving the event can decide if this parameter has any relevence to it.
528 * @param user The user performing the rehash, if any -- if this is server initiated, the
529 * value of this variable will be NULL.
530 * @param parameter The (optional) parameter given to REHASH from the user.
532 virtual void OnRehash(userrec* user, const std::string ¶meter);
534 /** Called when a raw command is transmitted or received.
535 * This method is the lowest level of handler available to a module. It will be called with raw
536 * data which is passing through a connected socket. If you wish, you may munge this data by changing
537 * the string parameter "raw". If you do this, after your function exits it will immediately be
538 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
539 * inbound is set to true) the value of user will be the userrec of the connection sending the
540 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
541 * @param raw The raw string in RFC1459 format
542 * @param inbound A flag to indicate wether the data is coming into the daemon or going out to the user
543 * @param user The user record sending the text, when inbound == true.
545 virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
547 /** Called whenever a user is about to join a channel, before any processing is done.
548 * Returning a value of 1 from this function stops the process immediately, causing no
549 * output to be sent to the user by the core. If you do this you must produce your own numerics,
550 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
551 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
555 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
556 * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
557 * processing on the actual channel record at this point, however the channel NAME will still be passed in
558 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
559 * @param user The user joining the channel
560 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
561 * @param cname The channel name being joined. For new channels this is valid where chan is not.
562 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "@".
563 * You may alter this string to alter the user's modes on the channel.
564 * @return 1 To prevent the join, 0 to allow it.
566 virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname, std::string &privs);
568 /** Called whenever a user is about to be kicked.
569 * Returning a value of 1 from this function stops the process immediately, causing no
570 * output to be sent to the user by the core. If you do this you must produce your own numerics,
572 * @param source The user issuing the kick
573 * @param user The user being kicked
574 * @param chan The channel the user is being kicked from
575 * @param reason The kick reason
576 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
578 virtual int OnUserPreKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason);
580 /** Called whenever a user is kicked.
581 * If this method is called, the kick is already underway and cannot be prevented, so
582 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
583 * @param source The user issuing the kick
584 * @param user The user being kicked
585 * @param chan The channel the user is being kicked from
586 * @param reason The kick reason
587 * @param silent Change this to true if you want to conceal the PART command from the other users
588 * of the channel (useful for modules such as auditorium)
590 virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason, bool &silent);
592 /** Called whenever a user opers locally.
593 * The userrec will contain the oper mode 'o' as this function is called after any modifications
594 * are made to the user's structure by the core.
595 * @param user The user who is opering up
596 * @param opertype The opers type name
598 virtual void OnOper(userrec* user, const std::string &opertype);
600 /** Called after a user opers locally.
601 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
602 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
603 * out the OPERTYPE, etc.
604 * @param user The user who is opering up
605 * @param opertype The opers type name
607 virtual void OnPostOper(userrec* user, const std::string &opertype);
609 /** Called whenever a user types /INFO.
610 * The userrec will contain the information of the user who typed the command. Modules may use this
611 * method to output their own credits in /INFO (which is the ircd's version of an about box).
612 * It is purposefully not possible to modify any info that has already been output, or halt the list.
613 * You must write a 371 numeric to the user, containing your info in the following format:
615 * <nick> :information here
617 * @param user The user issuing /INFO
619 virtual void OnInfo(userrec* user);
621 /** Called whenever a /WHOIS is performed on a local user.
622 * The source parameter contains the details of the user who issued the WHOIS command, and
623 * the dest parameter contains the information of the user they are whoising.
624 * @param source The user issuing the WHOIS command
625 * @param dest The user who is being WHOISed
627 virtual void OnWhois(userrec* source, userrec* dest);
629 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
630 * Returning 1 from this function stops the process immediately, causing no
631 * output to be sent to the user by the core. If you do this you must produce your own numerics,
632 * notices etc. This is useful for modules which may want to filter invites to channels.
633 * @param source The user who is issuing the INVITE
634 * @param dest The user being invited
635 * @param channel The channel the user is being invited to
636 * @return 1 to deny the invite, 0 to allow
638 virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel);
640 /** Called after a user has been successfully invited to a channel.
641 * You cannot prevent the invite from occuring using this function, to do that,
642 * use OnUserPreInvite instead.
643 * @param source The user who is issuing the INVITE
644 * @param dest The user being invited
645 * @param channel The channel the user is being invited to
647 virtual void OnUserInvite(userrec* source,userrec* dest,chanrec* channel);
649 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
650 * Returning any nonzero value from this function stops the process immediately, causing no
651 * output to be sent to the user by the core. If you do this you must produce your own numerics,
652 * notices etc. This is useful for modules which may want to filter or redirect messages.
653 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
654 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
655 * of where the message is destined to be sent.
656 * @param user The user sending the message
657 * @param dest The target of the message (chanrec* or userrec*)
658 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
659 * @param text Changeable text being sent by the user
660 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
661 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
662 * It will be ignored for private messages.
663 * @return 1 to deny the NOTICE, 0 to allow it
665 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
667 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
668 * Returning any nonzero value from this function stops the process immediately, causing no
669 * output to be sent to the user by the core. If you do this you must produce your own numerics,
670 * notices etc. This is useful for modules which may want to filter or redirect messages.
671 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
672 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
673 * of where the message is destined to be sent.
674 * You may alter the message text as you wish before relinquishing control to the next module
675 * in the chain, and if no other modules block the text this altered form of the text will be sent out
676 * to the user and possibly to other servers.
677 * @param user The user sending the message
678 * @param dest The target of the message (chanrec* or userrec*)
679 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
680 * @param text Changeable text being sent by the user
681 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
682 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
683 * It will be ignored for private notices.
684 * @return 1 to deny the NOTICE, 0 to allow it
686 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
688 /** Called whenever the server wants to build the exemption list for a channel, but is not directly doing a PRIVMSG or NOTICE.
689 * For example, the spanningtree protocol will call this event when passing a privmsg on (but not processing it directly).
690 * @param message_type The message type, either MSG_PRIVMSG or MSG_NOTICE
691 * @param chan The channel to build the exempt list of
692 * @param sender The original sender of the PRIVMSG or NOTICE
693 * @param status The status char to be used for the channel list
694 * @param exempt_list The exempt list to be populated
696 virtual void OnBuildExemptList(MessageType message_type, chanrec* chan, userrec* sender, char status, CUList &exempt_list);
698 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
699 * Please note that although you can see remote nickchanges through this function, you should
700 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
701 * check user->server before taking any action (including returning nonzero from the method).
702 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
703 * module to generate some meaninful output.
704 * @param user The username changing their nick
705 * @param newnick Their new nickname
706 * @return 1 to deny the change, 0 to allow
708 virtual int OnUserPreNick(userrec* user, const std::string &newnick);
710 /** Called after any PRIVMSG sent from a user.
711 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
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. PRIVMSG @#chan has status== '@', 0 to send to everyone.
719 virtual void OnUserMessage(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
721 /** Called after any NOTICE sent from a user.
722 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
723 * if target_type is TYPE_CHANNEL.
724 * @param user The user sending the message
725 * @param dest The target of the message
726 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
727 * @param text the text being sent by the user
728 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
730 virtual void OnUserNotice(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
732 /** Called after every MODE command sent from a user
733 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
734 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
735 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
736 * @param user The user sending the MODEs
737 * @param dest The target of the modes (userrec* or chanrec*)
738 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
739 * @param text The actual modes and their parameters if any
741 virtual void OnMode(userrec* user, void* dest, int target_type, const std::string &text);
743 /** Allows modules to alter or create server descriptions
744 * Whenever a module requires a server description, for example for display in
745 * WHOIS, this function is called in all modules. You may change or define the
746 * description given in std::string &description. If you do, this description
747 * will be shown in the WHOIS fields.
748 * @param servername The servername being searched for
749 * @param description Alterable server description for this server
751 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
753 /** Allows modules to synchronize data which relates to users during a netburst.
754 * When this function is called, it will be called from the module which implements
755 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
756 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
757 * (see below). This function will be called for every user visible on your side
758 * of the burst, allowing you to for example set modes, etc. Do not use this call to
759 * synchronize data which you have stored using class Extensible -- There is a specialist
760 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
761 * @param user The user being syncronized
762 * @param proto A pointer to the module handling network protocol
763 * @param opaque An opaque pointer set by the protocol module, should not be modified!
765 virtual void OnSyncUser(userrec* user, Module* proto, void* opaque);
767 /** Allows modules to synchronize data which relates to channels during a netburst.
768 * When this function is called, it will be called from the module which implements
769 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
770 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
771 * (see below). This function will be called for every user visible on your side
772 * of the burst, allowing you to for example set modes, etc. Do not use this call to
773 * synchronize data which you have stored using class Extensible -- There is a specialist
774 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
776 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
778 * @param chan The channel being syncronized
779 * @param proto A pointer to the module handling network protocol
780 * @param opaque An opaque pointer set by the protocol module, should not be modified!
782 virtual void OnSyncChannel(chanrec* chan, Module* proto, void* opaque);
784 /* Allows modules to syncronize metadata related to channels over the network during a netburst.
785 * Whenever the linking module wants to send out data, but doesnt know what the data
786 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
787 * this method is called.You should use the ProtoSendMetaData function after you've
788 * correctly decided how the data should be represented, to send the metadata on its way if it belongs
789 * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
790 * @param chan The channel whos metadata is being syncronized
791 * @param proto A pointer to the module handling network protocol
792 * @param opaque An opaque pointer set by the protocol module, should not be modified!
793 * @param extname The extensions name which is being searched for
795 virtual void OnSyncChannelMetaData(chanrec* chan, Module* proto,void* opaque, const std::string &extname);
797 /* Allows modules to syncronize metadata related to users over the network during a netburst.
798 * Whenever the linking module wants to send out data, but doesnt know what the data
799 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
800 * this method is called. You should use the ProtoSendMetaData function after you've
801 * correctly decided how the data should be represented, to send the metadata on its way if
802 * if it belongs to your module.
803 * @param user The user whos metadata is being syncronized
804 * @param proto A pointer to the module handling network protocol
805 * @param opaque An opaque pointer set by the protocol module, should not be modified!
806 * @param extname The extensions name which is being searched for
808 virtual void OnSyncUserMetaData(userrec* user, Module* proto,void* opaque, const std::string &extname);
810 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
811 * Whenever the linking module wants to send out data, but doesnt know what the data
812 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
813 * this method is called. You should use the ProtoSendMetaData function after you've
814 * correctly decided how the data should be represented, to send the metadata on its way if
815 * if it belongs to your module.
816 * @param proto A pointer to the module handling network protocol
817 * @param opaque An opaque pointer set by the protocol module, should not be modified!
819 virtual void OnSyncOtherMetaData(Module* proto, void* opaque);
821 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
822 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
823 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
824 * @param target The chanrec* or userrec* that data should be added to
825 * @param extname The extension name which is being sent
826 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
828 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata);
830 /** Implemented by modules which provide the ability to link servers.
831 * These modules will implement this method, which allows transparent sending of servermodes
832 * down the network link as a broadcast, without a module calling it having to know the format
833 * of the MODE command before the actual mode string.
835 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
836 * of how to use this function.
838 * @param opaque An opaque pointer set by the protocol module, should not be modified!
839 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
840 * @param target The chanrec* or userrec* that modes should be sent for
841 * @param modeline The modes and parameters to be sent
843 virtual void ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline);
845 /** Implemented by modules which provide the ability to link servers.
846 * These modules will implement this method, which allows metadata (extra data added to
847 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
848 * to other servers on a netburst and decoded at the other end by the same module on a
851 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
852 * how to use this function.
853 * @param opaque An opaque pointer set by the protocol module, should not be modified!
854 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
855 * @param target The chanrec* or userrec* that metadata should be sent for
856 * @param extname The extension name to send metadata for
857 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
859 virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata);
861 /** Called after every WALLOPS command.
862 * @param user The user sending the WALLOPS
863 * @param text The content of the WALLOPS message
865 virtual void OnWallops(userrec* user, const std::string &text);
867 /** Called whenever a user's hostname is changed.
868 * This event triggers after the host has been set.
869 * @param user The user whos host is being changed
870 * @param newhost The new hostname being set
872 virtual void OnChangeHost(userrec* user, const std::string &newhost);
874 /** Called whenever a user's GECOS (realname) is changed.
875 * This event triggers after the name has been set.
876 * @param user The user who's GECOS is being changed
877 * @param gecos The new GECOS being set on the user
879 virtual void OnChangeName(userrec* user, const std::string &gecos);
881 /** Called whenever a gline is added by a local user.
882 * This method is triggered after the line is added.
883 * @param duration The duration of the line in seconds
884 * @param source The sender of the line
885 * @param reason The reason text to be displayed
886 * @param hostmask The hostmask to add
888 virtual void OnAddGLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
890 /** Called whenever a zline is added by a local user.
891 * This method is triggered after the line is added.
892 * @param duration The duration of the line in seconds
893 * @param source The sender of the line
894 * @param reason The reason text to be displayed
895 * @param ipmask The hostmask to add
897 virtual void OnAddZLine(long duration, userrec* source, const std::string &reason, const std::string &ipmask);
899 /** Called whenever a kline is added by a local user.
900 * This method is triggered after the line is added.
901 * @param duration The duration of the line in seconds
902 * @param source The sender of the line
903 * @param reason The reason text to be displayed
904 * @param hostmask The hostmask to add
906 virtual void OnAddKLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
908 /** Called whenever a qline is added by a local user.
909 * This method is triggered after the line is added.
910 * @param duration The duration of the line in seconds
911 * @param source The sender of the line
912 * @param reason The reason text to be displayed
913 * @param nickmask The hostmask to add
915 virtual void OnAddQLine(long duration, userrec* source, const std::string &reason, const std::string &nickmask);
917 /** Called whenever a eline is added by a local user.
918 * This method is triggered after the line is added.
919 * @param duration The duration of the line in seconds
920 * @param source The sender of the line
921 * @param reason The reason text to be displayed
922 * @param hostmask The hostmask to add
924 virtual void OnAddELine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
926 /** Called whenever a gline is deleted.
927 * This method is triggered after the line is deleted.
928 * @param source The user removing the line
929 * @param hostmask The hostmask to delete
931 virtual void OnDelGLine(userrec* source, const std::string &hostmask);
933 /** Called whenever a zline is deleted.
934 * This method is triggered after the line is deleted.
935 * @param source The user removing the line
936 * @param hostmask The hostmask to delete
938 virtual void OnDelZLine(userrec* source, const std::string &ipmask);
940 /** Called whenever a kline is deleted.
941 * This method is triggered after the line is deleted.
942 * @param source The user removing the line
943 * @param hostmask The hostmask to delete
945 virtual void OnDelKLine(userrec* source, const std::string &hostmask);
947 /** Called whenever a qline is deleted.
948 * This method is triggered after the line is deleted.
949 * @param source The user removing the line
950 * @param hostmask The hostmask to delete
952 virtual void OnDelQLine(userrec* source, const std::string &nickmask);
954 /** Called whenever a eline is deleted.
955 * This method is triggered after the line is deleted.
956 * @param source The user removing the line
957 * @param hostmask The hostmask to delete
959 virtual void OnDelELine(userrec* source, const std::string &hostmask);
961 /** Called before your module is unloaded to clean up Extensibles.
962 * This method is called once for every user and channel on the network,
963 * so that when your module unloads it may clear up any remaining data
964 * in the form of Extensibles added using Extensible::Extend().
965 * If the target_type variable is TYPE_USER, then void* item refers to
966 * a userrec*, otherwise it refers to a chanrec*.
967 * @param target_type The type of item being cleaned
968 * @param item A pointer to the item's class
970 virtual void OnCleanup(int target_type, void* item);
972 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
973 * have been applied. Please note that although you can see remote nickchanges through this function, you should
974 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
975 * check user->server before taking any action (including returning nonzero from the method).
976 * Because this method is called after the nickchange is taken place, no return values are possible
977 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
978 * @param user The user changing their nick
979 * @param oldnick The old nickname of the user before the nickchange
981 virtual void OnUserPostNick(userrec* user, const std::string &oldnick);
983 /** Called before an action which requires a channel privilage check.
984 * This function is called before many functions which check a users status on a channel, for example
985 * before opping a user, deopping a user, kicking a user, etc.
986 * There are several values for access_type which indicate for what reason access is being checked.
988 * AC_KICK (0) - A user is being kicked<br>
989 * AC_DEOP (1) - a user is being deopped<br>
990 * AC_OP (2) - a user is being opped<br>
991 * AC_VOICE (3) - a user is being voiced<br>
992 * AC_DEVOICE (4) - a user is being devoiced<br>
993 * AC_HALFOP (5) - a user is being halfopped<br>
994 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
995 * AC_INVITE () - a user is being invited<br>
996 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
997 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
998 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
999 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
1000 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
1001 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
1002 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
1003 * @param source The source of the access check
1004 * @param dest The destination of the access check
1005 * @param channel The channel which is being checked
1006 * @param access_type See above
1008 virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
1010 /** Called when a 005 numeric is about to be output.
1011 * The module should modify the 005 numeric if needed to indicate its features.
1012 * @param output The 005 string to be modified if neccessary.
1014 virtual void On005Numeric(std::string &output);
1016 /** Called when a client is disconnected by KILL.
1017 * If a client is killed by a server, e.g. a nickname collision or protocol error,
1019 * Return 1 from this function to prevent the kill, and 0 from this function to allow
1020 * it as normal. If you prevent the kill no output will be sent to the client, it is
1021 * down to your module to generate this information.
1022 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
1023 * If you do so youre risking race conditions, desyncs and worse!
1024 * @param source The user sending the KILL
1025 * @param dest The user being killed
1026 * @param reason The kill reason
1027 * @return 1 to prevent the kill, 0 to allow
1029 virtual int OnKill(userrec* source, userrec* dest, const std::string &reason);
1031 /** Called when an oper wants to disconnect a remote user via KILL
1032 * @param source The user sending the KILL
1033 * @param dest The user being killed
1034 * @param reason The kill reason
1036 virtual void OnRemoteKill(userrec* source, userrec* dest, const std::string &reason);
1038 /** Called whenever a module is loaded.
1039 * mod will contain a pointer to the module, and string will contain its name,
1040 * for example m_widgets.so. This function is primary for dependency checking,
1041 * your module may decide to enable some extra features if it sees that you have
1042 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
1043 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
1044 * but instead operate under reduced functionality, unless the dependency is
1045 * absolutely neccessary (e.g. a module that extends the features of another
1047 * @param mod A pointer to the new module
1048 * @param name The new module's filename
1050 virtual void OnLoadModule(Module* mod,const std::string &name);
1052 /** Called whenever a module is unloaded.
1053 * mod will contain a pointer to the module, and string will contain its name,
1054 * for example m_widgets.so. This function is primary for dependency checking,
1055 * your module may decide to enable some extra features if it sees that you have
1056 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
1057 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
1058 * but instead operate under reduced functionality, unless the dependency is
1059 * absolutely neccessary (e.g. a module that extends the features of another
1061 * @param mod Pointer to the module being unloaded (still valid)
1062 * @param name The filename of the module being unloaded
1064 virtual void OnUnloadModule(Module* mod,const std::string &name);
1066 /** Called once every five seconds for background processing.
1067 * This timer can be used to control timed features. Its period is not accurate
1068 * enough to be used as a clock, but it is gauranteed to be called at least once in
1069 * any five second period, directly from the main loop of the server.
1070 * @param curtime The current timer derived from time(2)
1072 virtual void OnBackgroundTimer(time_t curtime);
1074 /** Called whenever any command is about to be executed.
1075 * This event occurs for all registered commands, wether they are registered in the core,
1076 * or another module, and for invalid commands. Invalid commands may only be sent to this
1077 * function when the value of validated is false. By returning 1 from this method you may prevent the
1078 * command being executed. If you do this, no output is created by the core, and it is
1079 * down to your module to produce any output neccessary.
1080 * Note that unless you return 1, you should not destroy any structures (e.g. by using
1081 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
1082 * method returns, it will be passed an invalid pointer to the user object and crash!)
1083 * @param command The command being executed
1084 * @param parameters An array of array of characters containing the parameters for the command
1085 * @param pcnt The nuimber of parameters passed to the command
1086 * @param user the user issuing the command
1087 * @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.
1088 * @param original_line The entire original line as passed to the parser from the user
1089 * @return 1 to block the command, 0 to allow
1091 virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line);
1093 /** Called after any command has been executed.
1094 * This event occurs for all registered commands, wether they are registered in the core,
1095 * or another module, but it will not occur for invalid commands (e.g. ones which do not
1096 * exist within the command table). The result code returned by the command handler is
1098 * @param command The command being executed
1099 * @param parameters An array of array of characters containing the parameters for the command
1100 * @param pcnt The nuimber of parameters passed to the command
1101 * @param user the user issuing the command
1102 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
1103 * @param original_line The entire original line as passed to the parser from the user
1105 virtual void OnPostCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, CmdResult result, const std::string &original_line);
1107 /** Called to check if a user who is connecting can now be allowed to register
1108 * If any modules return false for this function, the user is held in the waiting
1109 * state until all modules return true. For example a module which implements ident
1110 * lookups will continue to return false for a user until their ident lookup is completed.
1111 * Note that the registration timeout for a user overrides these checks, if the registration
1112 * timeout is reached, the user is disconnected even if modules report that the user is
1113 * not ready to connect.
1114 * @param user The user to check
1115 * @return true to indicate readiness, false if otherwise
1117 virtual bool OnCheckReady(userrec* user);
1119 /** Called whenever a user is about to register their connection (e.g. before the user
1120 * is sent the MOTD etc). Modules can use this method if they are performing a function
1121 * which must be done before the actual connection is completed (e.g. ident lookups,
1122 * dnsbl lookups, etc).
1123 * Note that you should NOT delete the user record here by causing a disconnection!
1124 * Use OnUserConnect for that instead.
1125 * @param user The user registering
1126 * @return 1 to indicate user quit, 0 to continue
1128 virtual int OnUserRegister(userrec* user);
1130 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1131 * This method will always be called for each join, wether or not the channel is actually +i, and
1132 * determines the outcome of an if statement around the whole section of invite checking code.
1133 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1134 * @param user The user joining the channel
1135 * @param chan The channel being joined
1136 * @return 1 to explicitly allow the join, 0 to proceed as normal
1138 virtual int OnCheckInvite(userrec* user, chanrec* chan);
1140 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1141 * This method will always be called for each join, wether or not the channel is actually +k, and
1142 * determines the outcome of an if statement around the whole section of key checking code.
1143 * if the user specified no key, the keygiven string will be a valid but empty value.
1144 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1145 * @param user The user joining the channel
1146 * @param chan The channel being joined
1147 * @return 1 to explicitly allow the join, 0 to proceed as normal
1149 virtual int OnCheckKey(userrec* user, chanrec* chan, const std::string &keygiven);
1151 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1152 * This method will always be called for each join, wether or not the channel is actually +l, and
1153 * determines the outcome of an if statement around the whole section of channel limit checking code.
1154 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1155 * @param user The user joining the channel
1156 * @param chan The channel being joined
1157 * @return 1 to explicitly allow the join, 0 to proceed as normal
1159 virtual int OnCheckLimit(userrec* user, chanrec* chan);
1161 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
1162 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
1163 * determines the outcome of an if statement around the whole section of ban checking code.
1164 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1165 * @param user The user joining the channel
1166 * @param chan The channel being joined
1167 * @return 1 to explicitly allow the join, 0 to proceed as normal
1169 virtual int OnCheckBan(userrec* user, chanrec* chan);
1171 /** Called on all /STATS commands
1172 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1173 * @param symbol the symbol provided to /STATS
1174 * @param user the user issuing the /STATS command
1175 * @param results A string_list to append results into. You should put all your results
1176 * into this string_list, rather than displaying them directly, so that your handler will
1177 * work when remote STATS queries are received.
1178 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1180 virtual int OnStats(char symbol, userrec* user, string_list &results);
1182 /** Called whenever a change of a local users displayed host is attempted.
1183 * Return 1 to deny the host change, or 0 to allow it.
1184 * @param user The user whos host will be changed
1185 * @param newhost The new hostname
1186 * @return 1 to deny the host change, 0 to allow
1188 virtual int OnChangeLocalUserHost(userrec* user, const std::string &newhost);
1190 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1191 * return 1 to deny the name change, or 0 to allow it.
1192 * @param user The user whos GECOS will be changed
1193 * @param newhost The new GECOS
1194 * @return 1 to deny the GECOS change, 0 to allow
1196 virtual int OnChangeLocalUserGECOS(userrec* user, const std::string &newhost);
1198 /** Called whenever a topic is changed by a local user.
1199 * Return 1 to deny the topic change, or 0 to allow it.
1200 * @param user The user changing the topic
1201 * @param chan The channels who's topic is being changed
1202 * @param topic The actual topic text
1203 * @param 1 to block the topic change, 0 to allow
1205 virtual int OnLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic);
1207 /** Called whenever a local topic has been changed.
1208 * To block topic changes you must use OnLocalTopicChange instead.
1209 * @param user The user changing the topic
1210 * @param chan The channels who's topic is being changed
1211 * @param topic The actual topic text
1213 virtual void OnPostLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic);
1215 /** Called whenever an Event class is sent to all module by another module.
1216 * Please see the documentation of Event::Send() for further information. The Event sent can
1217 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1218 * before doing anything to the event data, and you should *not* change the event data in any way!
1219 * @param event The Event class being received
1221 virtual void OnEvent(Event* event);
1223 /** Called whenever a Request class is sent to your module by another module.
1224 * Please see the documentation of Request::Send() for further information. The Request sent
1225 * can always be assumed to be non-NULL, you should not change the request object or its data.
1226 * Your method may return arbitary data in the char* result which the requesting module
1227 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1228 * @param request The Request class being received
1230 virtual char* OnRequest(Request* request);
1232 /** Called whenever an oper password is to be compared to what a user has input.
1233 * The password field (from the config file) is in 'password' and is to be compared against
1234 * 'input'. This method allows for encryption of oper passwords and much more besides.
1235 * You should return a nonzero value if you want to allow the comparison or zero if you wish
1237 * @param password The oper's password
1238 * @param input The password entered
1239 * @param tagnumber The tag number (from the configuration file) of this oper's tag
1240 * @return 1 to match the passwords, 0 to do nothing. -1 to not match, and not continue.
1242 virtual int OnOperCompare(const std::string &password, const std::string &input, int tagnumber);
1244 /** Called whenever a user is given usermode +o, anywhere on the network.
1245 * You cannot override this and prevent it from happening as it is already happened and
1246 * such a task must be performed by another server. You can however bounce modes by sending
1247 * servermodes out to reverse mode changes.
1248 * @param user The user who is opering
1250 virtual void OnGlobalOper(userrec* user);
1252 /** Called after a user has fully connected and all modules have executed OnUserConnect
1253 * This event is informational only. You should not change any user information in this
1254 * event. To do so, use the OnUserConnect method to change the state of local users.
1255 * This is called for both local and remote users.
1256 * @param user The user who is connecting
1258 virtual void OnPostConnect(userrec* user);
1260 /** Called whenever a ban is added to a channel's list.
1261 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1262 * @param source The user adding the ban
1263 * @param channel The channel the ban is being added to
1264 * @param banmask The ban mask being added
1265 * @return 1 to block the ban, 0 to continue as normal
1267 virtual int OnAddBan(userrec* source, chanrec* channel,const std::string &banmask);
1269 /** Called whenever a ban is removed from a channel's list.
1270 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1271 * @param source The user deleting the ban
1272 * @param channel The channel the ban is being deleted from
1273 * @param banmask The ban mask being deleted
1274 * @return 1 to block the unban, 0 to continue as normal
1276 virtual int OnDelBan(userrec* source, chanrec* channel,const std::string &banmask);
1278 /** Called immediately after any connection is accepted. This is intended for raw socket
1279 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1280 * no information relating to a user record as the connection has not been assigned yet.
1281 * There are no return values from this call as all modules get an opportunity if required to
1282 * process the connection.
1283 * @param fd The file descriptor returned from accept()
1284 * @param ip The IP address of the connecting user
1285 * @param localport The local port number the user connected to
1287 virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport);
1289 /** Called immediately before any write() operation on a user's socket in the core. Because
1290 * this event is a low level event no user information is associated with it. It is intended
1291 * for use by modules which may wrap connections within another API such as SSL for example.
1292 * return a non-zero result if you have handled the write operation, in which case the core
1293 * will not call write().
1294 * @param fd The file descriptor of the socket
1295 * @param buffer A char* buffer being written
1296 * @param Number of characters to write
1297 * @return Number of characters actually written or 0 if you didn't handle the operation
1299 virtual int OnRawSocketWrite(int fd, const char* buffer, int count);
1301 /** Called immediately before any socket is closed. When this event is called, shutdown()
1302 * has not yet been called on the socket.
1303 * @param fd The file descriptor of the socket prior to close()
1305 virtual void OnRawSocketClose(int fd);
1307 virtual void OnRawSocketConnect(int fd);
1309 /** Called immediately before any read() operation on a client socket in the core.
1310 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1311 * when this event occurs.
1312 * Your event should return 1 if it has handled the reading itself, which prevents the core
1313 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1314 * the value of count. The value of readresult must be identical to an actual result that might
1315 * be returned from the read() system call, for example, number of bytes read upon success,
1316 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1317 * you MUST set readresult.
1318 * @param fd The file descriptor of the socket
1319 * @param buffer A char* buffer being read to
1320 * @param count The size of the buffer
1321 * @param readresult The amount of characters read, or 0
1322 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1324 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1326 /** Called whenever a user sets away.
1327 * This method has no parameter for the away message, as it is available in the
1328 * user record as userrec::awaymsg.
1330 virtual void OnSetAway(userrec* user);
1332 /** Called when a user cancels their away state.
1334 virtual void OnCancelAway(userrec* user);
1336 /** Called whenever a NAMES list is requested.
1337 * You can produce the nameslist yourself, overriding the current list,
1338 * and if you do you must return 1. If you do not handle the names list,
1341 virtual int OnUserList(userrec* user, chanrec* Ptr);
1343 /** Called whenever a line of WHOIS output is sent to a user.
1344 * You may change the numeric and the text of the output by changing
1345 * the values numeric and text, but you cannot change the user the
1346 * numeric is sent to. You may however change the user's userrec values.
1347 * @param user The user the numeric is being sent to
1348 * @param dest The user being WHOISed
1349 * @param numeric The numeric of the line being sent
1350 * @param text The text of the numeric, including any parameters
1351 * @return nonzero to drop the line completely so that the user does not
1352 * receive it, or zero to allow the line to be sent.
1354 virtual int OnWhoisLine(userrec* user, userrec* dest, int &numeric, std::string &text);
1356 /** Called at intervals for modules to garbage-collect any hashes etc.
1357 * Certain data types such as hash_map 'leak' buckets, which must be
1358 * tidied up and freed by copying into a new item every so often. This
1359 * method is called when it is time to do that.
1361 virtual void OnGarbageCollect();
1363 /** Called whenever a user's write buffer has been completely sent.
1364 * This is called when the user's write buffer is completely empty, and
1365 * there are no more pending bytes to be written and no pending write events
1366 * in the socket engine's queue. This may be used to refill the buffer with
1367 * data which is being spooled in a controlled manner, e.g. LIST lines.
1368 * @param user The user who's buffer is now empty.
1370 virtual void OnBufferFlushed(userrec* user);
1374 #define CONF_NOT_A_NUMBER 0x000010
1375 #define CONF_NOT_UNSIGNED 0x000080
1376 #define CONF_VALUE_NOT_FOUND 0x000100
1377 #define CONF_FILE_NOT_FOUND 0x000200
1380 /** Allows reading of values from configuration files
1381 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1382 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1383 * Constructing the class using one parameter allows you to specify a path to your own configuration
1384 * file, otherwise, inspircd.conf is read.
1386 class ConfigReader : public classbase
1389 InspIRCd* ServerInstance;
1390 /** The contents of the configuration file
1391 * This protected member should never be accessed by a module (and cannot be accessed unless the
1392 * core is changed). It will contain a pointer to the configuration file data with unneeded data
1393 * (such as comments) stripped from it.
1395 ConfigDataHash* data;
1396 std::ostringstream* errorlog;;
1397 /** Used to store errors
1399 bool privatehash; // If we're using our own config data hash or not.
1404 /** Default constructor.
1405 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1406 * as specified when running ./configure.
1408 ConfigReader(InspIRCd* Instance);
1409 /** Overloaded constructor.
1410 * This constructor initialises the ConfigReader class to read a user-specified config file
1412 ConfigReader(InspIRCd* Instance, const std::string &filename);
1413 /** Default destructor.
1414 * This method destroys the ConfigReader class.
1418 /** Retrieves a value from the config file.
1419 * This method retrieves a value from the config file. Where multiple copies of the tag
1420 * exist in the config file, index indicates which of the values to retrieve.
1422 std::string ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds = false);
1423 /** Retrieves a value from the config file.
1424 * This method retrieves a value from the config file. Where multiple copies of the tag
1425 * exist in the config file, index indicates which of the values to retrieve. If the
1426 * tag is not found the default value is returned instead.
1428 std::string ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds = false);
1430 /** Retrieves a boolean value from the config file.
1431 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1432 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1433 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1435 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1436 /** Retrieves a boolean value from the config file.
1437 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1438 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1439 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1440 * If the tag is not found, the default value is used instead.
1442 bool ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index);
1444 /** Retrieves an integer value from the config file.
1445 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1446 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1447 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1448 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1449 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1450 * will return CONF_NOT_UNSIGNED
1452 long ReadInteger(const std::string &tag, const std::string &name, int index, bool needs_unsigned);
1453 /** Retrieves an integer value from the config file.
1454 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1455 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1456 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1457 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1458 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1459 * will return CONF_NOT_UNSIGNED. If the tag is not found, the default value is used instead.
1461 long ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool needs_unsigned);
1463 /** Returns the last error to occur.
1464 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1465 * A call to GetError() resets the error flag back to 0.
1468 /** Counts the number of times a given tag appears in the config file.
1469 * This method counts the number of times a tag appears in a config file, for use where
1470 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1471 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1472 * multiple instance tag.
1474 int Enumerate(const std::string &tag);
1475 /** Returns true if a config file is valid.
1476 * This method is partially implemented and will only return false if the config
1477 * file does not exist or could not be opened.
1480 /** Dumps the list of errors in a config file to an output location. If bail is true,
1481 * then the program will abort. If bail is false and user points to a valid user
1482 * record, the error report will be spooled to the given user by means of NOTICE.
1483 * if bool is false AND user is false, the error report will be spooled to all opers
1484 * by means of a NOTICE to all opers.
1486 void DumpErrors(bool bail,userrec* user);
1488 /** Returns the number of items within a tag.
1489 * For example if the tag was <test tag="blah" data="foo"> then this
1490 * function would return 2. Spaces and newlines both qualify as valid seperators
1493 int EnumerateValues(const std::string &tag, int index);
1498 /** Caches a text file into memory and can be used to retrieve lines from it.
1499 * This class contains methods for read-only manipulation of a text file in memory.
1500 * Either use the constructor type with one parameter to load a file into memory
1501 * at construction, or use the LoadFile method to load a file.
1503 class FileReader : public classbase
1505 InspIRCd* ServerInstance;
1506 /** The file contents
1510 unsigned long contentsize;
1515 /** Default constructor.
1516 * This method does not load any file into memory, you must use the LoadFile method
1517 * after constructing the class this way.
1519 FileReader(InspIRCd* Instance);
1521 /** Secondary constructor.
1522 * This method initialises the class with a file loaded into it ready for GetLine and
1523 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1526 FileReader(InspIRCd* Instance, const std::string &filename);
1528 /** Default destructor.
1529 * This deletes the memory allocated to the file.
1533 /** Used to load a file.
1534 * This method loads a file into the class ready for GetLine and
1535 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1538 void LoadFile(const std::string &filename);
1540 /** Returns the whole content of the file as std::string
1542 std::string Contents();
1544 /** Returns the entire size of the file as std::string
1546 unsigned long ContentSize();
1548 /** Returns true if the file exists
1549 * This function will return false if the file could not be opened.
1553 /** Retrieve one line from the file.
1554 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1555 * the index was out of bounds, or the line had no data on it.
1557 std::string GetLine(int x);
1559 /** Returns the size of the file in lines.
1560 * This method returns the number of lines in the read file. If it is 0, no lines have been
1561 * read into memory, either because the file is empty or it does not exist, or cannot be
1562 * opened due to permission problems.
1568 /** Instantiates classes inherited from Module.
1569 * This class creates a class inherited from type Module, using new. This is to allow for modules
1570 * to create many different variants of Module, dependent on architecture, configuration, etc.
1571 * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
1574 class ModuleFactory : public classbase
1577 /** The default constructor does nothing.
1580 /** The default destructor does nothing
1582 virtual ~ModuleFactory() { }
1583 /** Creates a new module.
1584 * Your inherited class of ModuleFactory must return a pointer to your Module class
1585 * using this method.
1587 virtual Module * CreateModule(InspIRCd* Me) = 0;
1590 /** A DLLFactory (designed to load shared objects) containing a ModuleFactory.
1592 typedef DLLFactory<ModuleFactory> ircd_module;
1594 /** A list of loaded Modules
1596 typedef std::vector<Module*> ModuleList;
1598 /** A list of loaded ModuleFactories
1600 typedef std::vector<ircd_module*> FactoryList;