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 11008
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 (ModuleException& modexcept) \
122 ServerInstance->Log(DEBUG,"Module exception caught: %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 (ModuleException& modexcept) \
136 z->Log(DEBUG,"Module exception caught: %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 (ModuleException& modexcept) \
159 ServerInstance->Log(DEBUG,"Module 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 (ModuleException& modexcept) \
180 z->Log(DEBUG,"Module 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)
195 /** Holds a module's Version information
196 * The four members (set by the constructor only) indicate details as to the version number
197 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
199 class Version : public classbase
202 const int Major, Minor, Revision, Build, Flags, API;
203 Version(int major, int minor, int revision, int build, int flags, int api_ver);
206 /** The ModuleMessage class is the base class of Request and Event
207 * This class is used to represent a basic data structure which is passed
208 * between modules for safe inter-module communications.
210 class ModuleMessage : public Extensible
213 virtual ~ModuleMessage() {};
216 /** The Request class is a unicast message directed at a given module.
217 * When this class is properly instantiated it may be sent to a module
218 * using the Send() method, which will call the given module's OnRequest
219 * method with this class as its parameter.
221 class Request : public ModuleMessage
224 /** This member holds a pointer to arbitary data set by the emitter of the message
227 /** This should be a null-terminated string identifying the type of request,
228 * all modules should define this and use it to determine the nature of the
229 * request before they attempt to cast the Request in any way.
232 /** This is a pointer to the sender of the message, which can be used to
233 * directly trigger events, or to create a reply.
236 /** The single destination of the Request
240 /** Create a new Request
241 * This is for the 'old' way of casting whatever the data is
242 * to char* and hoping you get the right thing at the other end.
243 * This is slowly being depreciated in favor of the 'new' way.
245 Request(char* anydata, Module* src, Module* dst);
246 /** Create a new Request
247 * This is for the 'new' way of defining a subclass
248 * of Request and defining it in a common header,
249 * passing an object of your Request subclass through
250 * as a Request* and using the ID string to determine
251 * what to cast it back to and the other end. This is
252 * much safer as there are no casts not confirmed by
253 * the ID string, and all casts are child->parent and
254 * can be checked at runtime with dynamic_cast<>()
256 Request(Module* src, Module* dst, const char* idstr);
257 /** Fetch the Request data
260 /** Fetch the ID string
263 /** Fetch the request source
266 /** Fetch the request destination (should be 'this' in the receiving module)
269 /** Send the Request.
270 * Upon returning the result will be arbitary data returned by the module you
271 * sent the request to. It is up to your module to know what this data is and
272 * how to deal with it.
278 /** The Event class is a unicast message directed at all modules.
279 * When the class is properly instantiated it may be sent to all modules
280 * using the Send() method, which will trigger the OnEvent method in
281 * all modules passing the object as its parameter.
283 class Event : public ModuleMessage
286 /** This member holds a pointer to arbitary data set by the emitter of the message
289 /** This is a pointer to the sender of the message, which can be used to
290 * directly trigger events, or to create a reply.
293 /** The event identifier.
294 * This is arbitary text which should be used to distinguish
295 * one type of event from another.
299 /** Create a new Event
301 Event(char* anydata, Module* src, const std::string &eventid);
302 /** Get the Event data
305 /** Get the event Source
308 /** Get the event ID.
309 * Use this to determine the event type for safe casting of the data
311 std::string GetEventID();
313 * The return result of an Event::Send() will always be NULL as
314 * no replies are expected.
316 char* Send(InspIRCd* ServerInstance);
319 /** This class can be used on its own to represent an exception, or derived to represent a module-specific exception.
320 * When a module whishes to abort, e.g. within a constructor, it should throw an exception using ModuleException or
321 * a class derived from ModuleException. If a module throws an exception during its constructor, the module will not
322 * be loaded. If this happens, the error message returned by ModuleException::GetReason will be displayed to the user
323 * attempting to load the module, or dumped to the console if the ircd is currently loading for the first time.
325 class CoreException : public std::exception
328 /** Holds the error message to be displayed
330 const std::string err;
332 /** Default constructor, just uses the error mesage 'Core threw an exception'.
334 CoreException() : err("Core threw an exception") {}
335 /** This constructor can be used to specify an error message before throwing.
337 CoreException(const std::string &message) : err(message) {}
338 /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
339 * Actually no, it does nothing. Never mind.
342 virtual ~CoreException() throw() {};
343 /** Returns the reason for the exception.
344 * The module should probably put something informative here as the user will see this upon failure.
346 virtual const char* GetReason()
352 class ModuleException : public CoreException
355 /** Default constructor, just uses the error mesage 'Module threw an exception'.
357 ModuleException() : CoreException("Module threw an exception") {}
359 /** This constructor can be used to specify an error message before throwing.
361 ModuleException(const std::string &message) : CoreException(message) {}
362 /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
363 * Actually no, it does nothing. Never mind.
366 virtual ~ModuleException() throw() {};
369 /** Priority types which can be returned from Module::Prioritize()
371 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
373 /** Implementation-specific flags which may be set in Module::Implements()
375 enum Implementation { I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash, I_OnServerRaw,
376 I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois, I_OnUserPreInvite,
377 I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick, I_OnUserMessage, I_OnUserNotice, I_OnMode,
378 I_OnGetServerDescription, I_OnSyncUser, I_OnSyncChannel, I_OnSyncChannelMetaData, I_OnSyncUserMetaData,
379 I_OnDecodeMetaData, I_ProtoSendMode, I_ProtoSendMetaData, I_OnWallops, I_OnChangeHost, I_OnChangeName, I_OnAddGLine,
380 I_OnAddZLine, I_OnAddQLine, I_OnAddKLine, I_OnAddELine, I_OnDelGLine, I_OnDelZLine, I_OnDelKLine, I_OnDelELine, I_OnDelQLine,
381 I_OnCleanup, I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule, I_OnUnloadModule,
382 I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnUserRrgister, I_OnCheckInvite,
383 I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnLocalTopicChange,
384 I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnOperCompre, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan, I_OnDelBan,
385 I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead, I_OnChangeLocalUserGECOS, I_OnUserRegister,
386 I_OnOperCompare, I_OnChannelDelete, I_OnPostOper, I_OnSyncOtherMetaData, I_OnSetAway, I_OnCancelAway, I_OnUserList,
387 I_OnPostCommand, I_OnPostJoin, I_OnWhoisLine, I_OnBuildExemptList, I_OnRawSocketConnect };
389 /** Base class for all InspIRCd modules
390 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
391 * its methods will be called when irc server events occur. class inherited from module must be
392 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
394 class Module : public Extensible
397 InspIRCd* ServerInstance;
400 /** Default constructor
401 * Creates a module class.
402 * @param Me An instance of the InspIRCd class which will be saved into ServerInstance for your use
403 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
405 Module(InspIRCd* Me);
407 /** Default destructor
408 * destroys a module class
412 /** Returns the version number of a Module.
413 * The method should return a Version object with its version information assigned via
416 virtual Version GetVersion();
418 /** The Implements function specifies which methods a module should receive events for.
419 * The char* parameter passed to this function contains a set of true or false values
420 * (1 or 0) which indicate wether each function is implemented. You must use the Iimplementation
421 * enum (documented elsewhere on this page) to mark functions as active. For example, to
422 * receive events for OnUserJoin():
424 * Implements[I_OnUserJoin] = 1;
426 * @param The implement list
428 virtual void Implements(char* Implements);
430 /** Used to set the 'priority' of a module (e.g. when it is called in relation to other modules.
431 * Some modules prefer to be called before other modules, due to their design. For example, a
432 * module which is expected to operate on complete information would expect to be placed last, so
433 * that any other modules which wish to adjust that information would execute before it, to be sure
434 * its information is correct. You can change your module's priority by returning one of:
436 * PRIORITY_FIRST - To place your module first in the list
438 * PRIORITY_LAST - To place your module last in the list
440 * PRIORITY_DONTCARE - To leave your module as it is (this is the default value, if you do not implement this function)
442 * The result of InspIRCd::PriorityBefore() - To move your module before another named module
444 * The result of InspIRCd::PriorityLast() - To move your module after another named module
446 * For a good working example of this method call, please see src/modules/m_spanningtree.cpp
447 * and src/modules/m_hostchange.so which make use of it. It is highly recommended that unless
448 * your module has a real need to reorder its priority, it should not implement this function,
449 * as many modules changing their priorities can make the system redundant.
451 virtual Priority Prioritize();
453 /** Called when a user connects.
454 * The details of the connecting user are available to you in the parameter userrec *user
455 * @param user The user who is connecting
457 virtual void OnUserConnect(userrec* user);
459 /** Called when a user quits.
460 * The details of the exiting user are available to you in the parameter userrec *user
461 * This event is only called when the user is fully registered when they quit. To catch
462 * raw disconnections, use the OnUserDisconnect method.
463 * @param user The user who is quitting
464 * @param message The user's quit message
466 virtual void OnUserQuit(userrec* user, const std::string &message);
468 /** Called whenever a user's socket is closed.
469 * The details of the exiting user are available to you in the parameter userrec *user
470 * This event is called for all users, registered or not, as a cleanup method for modules
471 * which might assign resources to user, such as dns lookups, objects and sockets.
472 * @param user The user who is disconnecting
474 virtual void OnUserDisconnect(userrec* user);
476 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
477 * @param chan The channel being deleted
479 virtual void OnChannelDelete(chanrec* chan);
481 /** Called when a user joins a channel.
482 * The details of the joining user are available to you in the parameter userrec *user,
483 * and the details of the channel they have joined is available in the variable chanrec *channel
484 * @param user The user who is joining
485 * @param channel The channel being joined
487 virtual void OnUserJoin(userrec* user, chanrec* channel);
489 /** Called after a user joins a channel
490 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
492 * @param user The user who is joining
493 * @param channel The channel being joined
495 virtual void OnPostJoin(userrec* user, chanrec* channel);
497 /** Called when a user parts a channel.
498 * The details of the leaving user are available to you in the parameter userrec *user,
499 * and the details of the channel they have left is available in the variable chanrec *channel
500 * @param user The user who is parting
501 * @param channel The channel being parted
502 * @param partmessage The part message, or an empty string
504 virtual void OnUserPart(userrec* user, chanrec* channel, const std::string &partmessage);
506 /** Called on rehash.
507 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
508 * system. You should use it to reload any files so that your module keeps in step with the
509 * rest of the application. If a parameter is given, the core has done nothing. The module
510 * receiving the event can decide if this parameter has any relevence to it.
511 * @param parameter The (optional) parameter given to REHASH from the user.
513 virtual void OnRehash(const std::string ¶meter);
515 /** Called when a raw command is transmitted or received.
516 * This method is the lowest level of handler available to a module. It will be called with raw
517 * data which is passing through a connected socket. If you wish, you may munge this data by changing
518 * the string parameter "raw". If you do this, after your function exits it will immediately be
519 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
520 * inbound is set to true) the value of user will be the userrec of the connection sending the
521 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
522 * @param raw The raw string in RFC1459 format
523 * @param inbound A flag to indicate wether the data is coming into the daemon or going out to the user
524 * @param user The user record sending the text, when inbound == true.
526 virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
528 /** Called whenever a user is about to join a channel, before any processing is done.
529 * Returning a value of 1 from this function stops the process immediately, causing no
530 * output to be sent to the user by the core. If you do this you must produce your own numerics,
531 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
532 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
536 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
537 * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
538 * processing on the actual channel record at this point, however the channel NAME will still be passed in
539 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
540 * @param user The user joining the channel
541 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
542 * @param cname The channel name being joined. For new channels this is valid where chan is not.
543 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "@".
544 * You may alter this string to alter the user's modes on the channel.
545 * @return 1 To prevent the join, 0 to allow it.
547 virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname, std::string &privs);
549 /** Called whenever a user is about to be kicked.
550 * Returning a value of 1 from this function stops the process immediately, causing no
551 * output to be sent to the user by the core. If you do this you must produce your own numerics,
553 * @param source The user issuing the kick
554 * @param user The user being kicked
555 * @param chan The channel the user is being kicked from
556 * @param reason The kick reason
557 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
559 virtual int OnUserPreKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason);
561 /** Called whenever a user is kicked.
562 * If this method is called, the kick is already underway and cannot be prevented, so
563 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
564 * @param source The user issuing the kick
565 * @param user The user being kicked
566 * @param chan The channel the user is being kicked from
567 * @param reason The kick reason
569 virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason);
571 /** Called whenever a user opers locally.
572 * The userrec will contain the oper mode 'o' as this function is called after any modifications
573 * are made to the user's structure by the core.
574 * @param user The user who is opering up
575 * @param opertype The opers type name
577 virtual void OnOper(userrec* user, const std::string &opertype);
579 /** Called after a user opers locally.
580 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
581 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
582 * out the OPERTYPE, etc.
583 * @param user The user who is opering up
584 * @param opertype The opers type name
586 virtual void OnPostOper(userrec* user, const std::string &opertype);
588 /** Called whenever a user types /INFO.
589 * The userrec will contain the information of the user who typed the command. Modules may use this
590 * method to output their own credits in /INFO (which is the ircd's version of an about box).
591 * It is purposefully not possible to modify any info that has already been output, or halt the list.
592 * You must write a 371 numeric to the user, containing your info in the following format:
594 * <nick> :information here
596 * @param user The user issuing /INFO
598 virtual void OnInfo(userrec* user);
600 /** Called whenever a /WHOIS is performed on a local user.
601 * The source parameter contains the details of the user who issued the WHOIS command, and
602 * the dest parameter contains the information of the user they are whoising.
603 * @param source The user issuing the WHOIS command
604 * @param dest The user who is being WHOISed
606 virtual void OnWhois(userrec* source, userrec* dest);
608 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
609 * Returning 1 from this function stops the process immediately, causing no
610 * output to be sent to the user by the core. If you do this you must produce your own numerics,
611 * notices etc. This is useful for modules which may want to filter invites to channels.
612 * @param source The user who is issuing the INVITE
613 * @param dest The user being invited
614 * @param channel The channel the user is being invited to
615 * @return 1 to deny the invite, 0 to allow
617 virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel);
619 /** Called after a user has been successfully invited to a channel.
620 * You cannot prevent the invite from occuring using this function, to do that,
621 * use OnUserPreInvite instead.
622 * @param source The user who is issuing the INVITE
623 * @param dest The user being invited
624 * @param channel The channel the user is being invited to
626 virtual void OnUserInvite(userrec* source,userrec* dest,chanrec* channel);
628 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
629 * Returning any nonzero value from this function stops the process immediately, causing no
630 * output to be sent to the user by the core. If you do this you must produce your own numerics,
631 * notices etc. This is useful for modules which may want to filter or redirect messages.
632 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
633 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
634 * of where the message is destined to be sent.
635 * @param user The user sending the message
636 * @param dest The target of the message (chanrec* or userrec*)
637 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
638 * @param text Changeable text being sent by the user
639 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
640 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
641 * It will be ignored for private messages.
642 * @return 1 to deny the NOTICE, 0 to allow it
644 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
646 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
647 * Returning any nonzero value from this function stops the process immediately, causing no
648 * output to be sent to the user by the core. If you do this you must produce your own numerics,
649 * notices etc. This is useful for modules which may want to filter or redirect messages.
650 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
651 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
652 * of where the message is destined to be sent.
653 * You may alter the message text as you wish before relinquishing control to the next module
654 * in the chain, and if no other modules block the text this altered form of the text will be sent out
655 * to the user and possibly to other servers.
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 notices, this will usually contain just the sender.
662 * It will be ignored for private notices.
663 * @return 1 to deny the NOTICE, 0 to allow it
665 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
667 /** Called whenever the server wants to build the exemption list for a channel, but is not directly doing a PRIVMSG or NOTICE.
668 * For example, the spanningtree protocol will call this event when passing a privmsg on (but not processing it directly).
669 * @param message_type The message type, either MSG_PRIVMSG or MSG_NOTICE
670 * @param chan The channel to build the exempt list of
671 * @param sender The original sender of the PRIVMSG or NOTICE
672 * @param status The status char to be used for the channel list
673 * @param exempt_list The exempt list to be populated
675 virtual void OnBuildExemptList(MessageType message_type, chanrec* chan, userrec* sender, char status, CUList &exempt_list);
677 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
678 * Please note that although you can see remote nickchanges through this function, you should
679 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
680 * check user->server before taking any action (including returning nonzero from the method).
681 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
682 * module to generate some meaninful output.
683 * @param user The username changing their nick
684 * @param newnick Their new nickname
685 * @return 1 to deny the change, 0 to allow
687 virtual int OnUserPreNick(userrec* user, const std::string &newnick);
689 /** Called after any PRIVMSG sent from a user.
690 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
691 * if target_type is TYPE_CHANNEL.
692 * @param user The user sending the message
693 * @param dest The target of the message
694 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
695 * @param text the text being sent by the user
696 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
698 virtual void OnUserMessage(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
700 /** Called after any NOTICE sent from a user.
701 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
702 * if target_type is TYPE_CHANNEL.
703 * @param user The user sending the message
704 * @param dest The target of the message
705 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
706 * @param text the text being sent by the user
707 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
709 virtual void OnUserNotice(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
711 /** Called after every MODE command sent from a user
712 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
713 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
714 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
715 * @param user The user sending the MODEs
716 * @param dest The target of the modes (userrec* or chanrec*)
717 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
718 * @param text The actual modes and their parameters if any
720 virtual void OnMode(userrec* user, void* dest, int target_type, const std::string &text);
722 /** Allows modules to alter or create server descriptions
723 * Whenever a module requires a server description, for example for display in
724 * WHOIS, this function is called in all modules. You may change or define the
725 * description given in std::string &description. If you do, this description
726 * will be shown in the WHOIS fields.
727 * @param servername The servername being searched for
728 * @param description Alterable server description for this server
730 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
732 /** Allows modules to synchronize data which relates to users during a netburst.
733 * When this function is called, it will be called from the module which implements
734 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
735 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
736 * (see below). This function will be called for every user visible on your side
737 * of the burst, allowing you to for example set modes, etc. Do not use this call to
738 * synchronize data which you have stored using class Extensible -- There is a specialist
739 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
740 * @param user The user being syncronized
741 * @param proto A pointer to the module handling network protocol
742 * @param opaque An opaque pointer set by the protocol module, should not be modified!
744 virtual void OnSyncUser(userrec* user, Module* proto, void* opaque);
746 /** Allows modules to synchronize data which relates to channels during a netburst.
747 * When this function is called, it will be called from the module which implements
748 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
749 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
750 * (see below). This function will be called for every user visible on your side
751 * of the burst, allowing you to for example set modes, etc. Do not use this call to
752 * synchronize data which you have stored using class Extensible -- There is a specialist
753 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
755 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
757 * @param chan The channel being syncronized
758 * @param proto A pointer to the module handling network protocol
759 * @param opaque An opaque pointer set by the protocol module, should not be modified!
761 virtual void OnSyncChannel(chanrec* chan, Module* proto, void* opaque);
763 /* Allows modules to syncronize metadata related to channels over the network during a netburst.
764 * Whenever the linking module wants to send out data, but doesnt know what the data
765 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
766 * this method is called.You should use the ProtoSendMetaData function after you've
767 * correctly decided how the data should be represented, to send the metadata on its way if it belongs
768 * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
769 * @param chan The channel whos metadata is being syncronized
770 * @param proto A pointer to the module handling network protocol
771 * @param opaque An opaque pointer set by the protocol module, should not be modified!
772 * @param extname The extensions name which is being searched for
774 virtual void OnSyncChannelMetaData(chanrec* chan, Module* proto,void* opaque, const std::string &extname);
776 /* Allows modules to syncronize metadata related to users over the network during a netburst.
777 * Whenever the linking module wants to send out data, but doesnt know what the data
778 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
779 * this method is called. You should use the ProtoSendMetaData function after you've
780 * correctly decided how the data should be represented, to send the metadata on its way if
781 * if it belongs to your module.
782 * @param user The user whos metadata is being syncronized
783 * @param proto A pointer to the module handling network protocol
784 * @param opaque An opaque pointer set by the protocol module, should not be modified!
785 * @param extname The extensions name which is being searched for
787 virtual void OnSyncUserMetaData(userrec* user, Module* proto,void* opaque, const std::string &extname);
789 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
790 * Whenever the linking module wants to send out data, but doesnt know what the data
791 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
792 * this method is called. You should use the ProtoSendMetaData function after you've
793 * correctly decided how the data should be represented, to send the metadata on its way if
794 * if it belongs to your module.
795 * @param proto A pointer to the module handling network protocol
796 * @param opaque An opaque pointer set by the protocol module, should not be modified!
798 virtual void OnSyncOtherMetaData(Module* proto, void* opaque);
800 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
801 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
802 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
803 * @param target The chanrec* or userrec* that data should be added to
804 * @param extname The extension name which is being sent
805 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
807 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata);
809 /** Implemented by modules which provide the ability to link servers.
810 * These modules will implement this method, which allows transparent sending of servermodes
811 * down the network link as a broadcast, without a module calling it having to know the format
812 * of the MODE command before the actual mode string.
814 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
815 * of how to use this function.
817 * @param opaque An opaque pointer set by the protocol module, should not be modified!
818 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
819 * @param target The chanrec* or userrec* that modes should be sent for
820 * @param modeline The modes and parameters to be sent
822 virtual void ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline);
824 /** Implemented by modules which provide the ability to link servers.
825 * These modules will implement this method, which allows metadata (extra data added to
826 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
827 * to other servers on a netburst and decoded at the other end by the same module on a
830 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
831 * how to use this function.
832 * @param opaque An opaque pointer set by the protocol module, should not be modified!
833 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
834 * @param target The chanrec* or userrec* that metadata should be sent for
835 * @param extname The extension name to send metadata for
836 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
838 virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata);
840 /** Called after every WALLOPS command.
841 * @param user The user sending the WALLOPS
842 * @param text The content of the WALLOPS message
844 virtual void OnWallops(userrec* user, const std::string &text);
846 /** Called whenever a user's hostname is changed.
847 * This event triggers after the host has been set.
848 * @param user The user whos host is being changed
849 * @param newhost The new hostname being set
851 virtual void OnChangeHost(userrec* user, const std::string &newhost);
853 /** Called whenever a user's GECOS (realname) is changed.
854 * This event triggers after the name has been set.
855 * @param user The user who's GECOS is being changed
856 * @param gecos The new GECOS being set on the user
858 virtual void OnChangeName(userrec* user, const std::string &gecos);
860 /** Called whenever a gline is added by a local user.
861 * This method is triggered after the line is added.
862 * @param duration The duration of the line in seconds
863 * @param source The sender of the line
864 * @param reason The reason text to be displayed
865 * @param hostmask The hostmask to add
867 virtual void OnAddGLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
869 /** Called whenever a zline is added by a local user.
870 * This method is triggered after the line is added.
871 * @param duration The duration of the line in seconds
872 * @param source The sender of the line
873 * @param reason The reason text to be displayed
874 * @param ipmask The hostmask to add
876 virtual void OnAddZLine(long duration, userrec* source, const std::string &reason, const std::string &ipmask);
878 /** Called whenever a kline is added by a local user.
879 * This method is triggered after the line is added.
880 * @param duration The duration of the line in seconds
881 * @param source The sender of the line
882 * @param reason The reason text to be displayed
883 * @param hostmask The hostmask to add
885 virtual void OnAddKLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
887 /** Called whenever a qline is added by a local user.
888 * This method is triggered after the line is added.
889 * @param duration The duration of the line in seconds
890 * @param source The sender of the line
891 * @param reason The reason text to be displayed
892 * @param nickmask The hostmask to add
894 virtual void OnAddQLine(long duration, userrec* source, const std::string &reason, const std::string &nickmask);
896 /** Called whenever a eline is added by a local user.
897 * This method is triggered after the line is added.
898 * @param duration The duration of the line in seconds
899 * @param source The sender of the line
900 * @param reason The reason text to be displayed
901 * @param hostmask The hostmask to add
903 virtual void OnAddELine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
905 /** Called whenever a gline is deleted.
906 * This method is triggered after the line is deleted.
907 * @param source The user removing the line
908 * @param hostmask The hostmask to delete
910 virtual void OnDelGLine(userrec* source, const std::string &hostmask);
912 /** Called whenever a zline is deleted.
913 * This method is triggered after the line is deleted.
914 * @param source The user removing the line
915 * @param hostmask The hostmask to delete
917 virtual void OnDelZLine(userrec* source, const std::string &ipmask);
919 /** Called whenever a kline is deleted.
920 * This method is triggered after the line is deleted.
921 * @param source The user removing the line
922 * @param hostmask The hostmask to delete
924 virtual void OnDelKLine(userrec* source, const std::string &hostmask);
926 /** Called whenever a qline 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 OnDelQLine(userrec* source, const std::string &nickmask);
933 /** Called whenever a eline 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 OnDelELine(userrec* source, const std::string &hostmask);
940 /** Called before your module is unloaded to clean up Extensibles.
941 * This method is called once for every user and channel on the network,
942 * so that when your module unloads it may clear up any remaining data
943 * in the form of Extensibles added using Extensible::Extend().
944 * If the target_type variable is TYPE_USER, then void* item refers to
945 * a userrec*, otherwise it refers to a chanrec*.
946 * @param target_type The type of item being cleaned
947 * @param item A pointer to the item's class
949 virtual void OnCleanup(int target_type, void* item);
951 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
952 * have been applied. Please note that although you can see remote nickchanges through this function, you should
953 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
954 * check user->server before taking any action (including returning nonzero from the method).
955 * Because this method is called after the nickchange is taken place, no return values are possible
956 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
957 * @param user The user changing their nick
958 * @param oldnick The old nickname of the user before the nickchange
960 virtual void OnUserPostNick(userrec* user, const std::string &oldnick);
962 /** Called before an action which requires a channel privilage check.
963 * This function is called before many functions which check a users status on a channel, for example
964 * before opping a user, deopping a user, kicking a user, etc.
965 * There are several values for access_type which indicate for what reason access is being checked.
967 * AC_KICK (0) - A user is being kicked<br>
968 * AC_DEOP (1) - a user is being deopped<br>
969 * AC_OP (2) - a user is being opped<br>
970 * AC_VOICE (3) - a user is being voiced<br>
971 * AC_DEVOICE (4) - a user is being devoiced<br>
972 * AC_HALFOP (5) - a user is being halfopped<br>
973 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
974 * AC_INVITE () - a user is being invited<br>
975 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
976 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
977 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
978 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
979 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
980 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
981 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
982 * @param source The source of the access check
983 * @param dest The destination of the access check
984 * @param channel The channel which is being checked
985 * @param access_type See above
987 virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
989 /** Called when a 005 numeric is about to be output.
990 * The module should modify the 005 numeric if needed to indicate its features.
991 * @param output The 005 string to be modified if neccessary.
993 virtual void On005Numeric(std::string &output);
995 /** Called when a client is disconnected by KILL.
996 * If a client is killed by a server, e.g. a nickname collision or protocol error,
998 * Return 1 from this function to prevent the kill, and 0 from this function to allow
999 * it as normal. If you prevent the kill no output will be sent to the client, it is
1000 * down to your module to generate this information.
1001 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
1002 * If you do so youre risking race conditions, desyncs and worse!
1003 * @param source The user sending the KILL
1004 * @param dest The user being killed
1005 * @param reason The kill reason
1006 * @return 1 to prevent the kill, 0 to allow
1008 virtual int OnKill(userrec* source, userrec* dest, const std::string &reason);
1010 /** Called when an oper wants to disconnect a remote user via KILL
1011 * @param source The user sending the KILL
1012 * @param dest The user being killed
1013 * @param reason The kill reason
1015 virtual void OnRemoteKill(userrec* source, userrec* dest, const std::string &reason);
1017 /** Called whenever a module is loaded.
1018 * mod will contain a pointer to the module, and string will contain its name,
1019 * for example m_widgets.so. This function is primary for dependency checking,
1020 * your module may decide to enable some extra features if it sees that you have
1021 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
1022 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
1023 * but instead operate under reduced functionality, unless the dependency is
1024 * absolutely neccessary (e.g. a module that extends the features of another
1026 * @param mod A pointer to the new module
1027 * @param name The new module's filename
1029 virtual void OnLoadModule(Module* mod,const std::string &name);
1031 /** Called whenever a module is unloaded.
1032 * mod will contain a pointer to the module, and string will contain its name,
1033 * for example m_widgets.so. This function is primary for dependency checking,
1034 * your module may decide to enable some extra features if it sees that you have
1035 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
1036 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
1037 * but instead operate under reduced functionality, unless the dependency is
1038 * absolutely neccessary (e.g. a module that extends the features of another
1040 * @param mod Pointer to the module being unloaded (still valid)
1041 * @param name The filename of the module being unloaded
1043 virtual void OnUnloadModule(Module* mod,const std::string &name);
1045 /** Called once every five seconds for background processing.
1046 * This timer can be used to control timed features. Its period is not accurate
1047 * enough to be used as a clock, but it is gauranteed to be called at least once in
1048 * any five second period, directly from the main loop of the server.
1049 * @param curtime The current timer derived from time(2)
1051 virtual void OnBackgroundTimer(time_t curtime);
1053 /** Called whenever any command is about to be executed.
1054 * This event occurs for all registered commands, wether they are registered in the core,
1055 * or another module, and for invalid commands. Invalid commands may only be sent to this
1056 * function when the value of validated is false. By returning 1 from this method you may prevent the
1057 * command being executed. If you do this, no output is created by the core, and it is
1058 * down to your module to produce any output neccessary.
1059 * Note that unless you return 1, you should not destroy any structures (e.g. by using
1060 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
1061 * method returns, it will be passed an invalid pointer to the user object and crash!)
1062 * @param command The command being executed
1063 * @param parameters An array of array of characters containing the parameters for the command
1064 * @param pcnt The nuimber of parameters passed to the command
1065 * @param user the user issuing the command
1066 * @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.
1067 * @param original_line The entire original line as passed to the parser from the user
1068 * @return 1 to block the command, 0 to allow
1070 virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line);
1072 /** Called after any command has been executed.
1073 * This event occurs for all registered commands, wether they are registered in the core,
1074 * or another module, but it will not occur for invalid commands (e.g. ones which do not
1075 * exist within the command table). The result code returned by the command handler is
1077 * @param command The command being executed
1078 * @param parameters An array of array of characters containing the parameters for the command
1079 * @param pcnt The nuimber of parameters passed to the command
1080 * @param user the user issuing the command
1081 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
1082 * @param original_line The entire original line as passed to the parser from the user
1084 virtual void OnPostCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, CmdResult result, const std::string &original_line);
1086 /** Called to check if a user who is connecting can now be allowed to register
1087 * If any modules return false for this function, the user is held in the waiting
1088 * state until all modules return true. For example a module which implements ident
1089 * lookups will continue to return false for a user until their ident lookup is completed.
1090 * Note that the registration timeout for a user overrides these checks, if the registration
1091 * timeout is reached, the user is disconnected even if modules report that the user is
1092 * not ready to connect.
1093 * @param user The user to check
1094 * @return true to indicate readiness, false if otherwise
1096 virtual bool OnCheckReady(userrec* user);
1098 /** Called whenever a user is about to register their connection (e.g. before the user
1099 * is sent the MOTD etc). Modules can use this method if they are performing a function
1100 * which must be done before the actual connection is completed (e.g. ident lookups,
1101 * dnsbl lookups, etc).
1102 * Note that you should NOT delete the user record here by causing a disconnection!
1103 * Use OnUserConnect for that instead.
1104 * @param user The user registering
1105 * @return 1 to indicate user quit, 0 to continue
1107 virtual int OnUserRegister(userrec* user);
1109 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1110 * This method will always be called for each join, wether or not the channel is actually +i, and
1111 * determines the outcome of an if statement around the whole section of invite checking code.
1112 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1113 * @param user The user joining the channel
1114 * @param chan The channel being joined
1115 * @return 1 to explicitly allow the join, 0 to proceed as normal
1117 virtual int OnCheckInvite(userrec* user, chanrec* chan);
1119 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1120 * This method will always be called for each join, wether or not the channel is actually +k, and
1121 * determines the outcome of an if statement around the whole section of key checking code.
1122 * if the user specified no key, the keygiven string will be a valid but empty value.
1123 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1124 * @param user The user joining the channel
1125 * @param chan The channel being joined
1126 * @return 1 to explicitly allow the join, 0 to proceed as normal
1128 virtual int OnCheckKey(userrec* user, chanrec* chan, const std::string &keygiven);
1130 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1131 * This method will always be called for each join, wether or not the channel is actually +l, and
1132 * determines the outcome of an if statement around the whole section of channel limit 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 OnCheckLimit(userrec* user, chanrec* chan);
1140 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
1141 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
1142 * determines the outcome of an if statement around the whole section of ban checking code.
1143 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1144 * @param user The user joining the channel
1145 * @param chan The channel being joined
1146 * @return 1 to explicitly allow the join, 0 to proceed as normal
1148 virtual int OnCheckBan(userrec* user, chanrec* chan);
1150 /** Called on all /STATS commands
1151 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1152 * @param symbol the symbol provided to /STATS
1153 * @param user the user issuing the /STATS command
1154 * @param results A string_list to append results into. You should put all your results
1155 * into this string_list, rather than displaying them directly, so that your handler will
1156 * work when remote STATS queries are received.
1157 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1159 virtual int OnStats(char symbol, userrec* user, string_list &results);
1161 /** Called whenever a change of a local users displayed host is attempted.
1162 * Return 1 to deny the host change, or 0 to allow it.
1163 * @param user The user whos host will be changed
1164 * @param newhost The new hostname
1165 * @return 1 to deny the host change, 0 to allow
1167 virtual int OnChangeLocalUserHost(userrec* user, const std::string &newhost);
1169 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1170 * return 1 to deny the name change, or 0 to allow it.
1171 * @param user The user whos GECOS will be changed
1172 * @param newhost The new GECOS
1173 * @return 1 to deny the GECOS change, 0 to allow
1175 virtual int OnChangeLocalUserGECOS(userrec* user, const std::string &newhost);
1177 /** Called whenever a topic is changed by a local user.
1178 * Return 1 to deny the topic change, or 0 to allow it.
1179 * @param user The user changing the topic
1180 * @param chan The channels who's topic is being changed
1181 * @param topic The actual topic text
1182 * @param 1 to block the topic change, 0 to allow
1184 virtual int OnLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic);
1186 /** Called whenever a local topic has been changed.
1187 * To block topic changes you must use OnLocalTopicChange instead.
1188 * @param user The user changing the topic
1189 * @param chan The channels who's topic is being changed
1190 * @param topic The actual topic text
1192 virtual void OnPostLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic);
1194 /** Called whenever an Event class is sent to all module by another module.
1195 * Please see the documentation of Event::Send() for further information. The Event sent can
1196 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1197 * before doing anything to the event data, and you should *not* change the event data in any way!
1198 * @param event The Event class being received
1200 virtual void OnEvent(Event* event);
1202 /** Called whenever a Request class is sent to your module by another module.
1203 * Please see the documentation of Request::Send() for further information. The Request sent
1204 * can always be assumed to be non-NULL, you should not change the request object or its data.
1205 * Your method may return arbitary data in the char* result which the requesting module
1206 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1207 * @param request The Request class being received
1209 virtual char* OnRequest(Request* request);
1211 /** Called whenever an oper password is to be compared to what a user has input.
1212 * The password field (from the config file) is in 'password' and is to be compared against
1213 * 'input'. This method allows for encryption of oper passwords and much more besides.
1214 * You should return a nonzero value if you want to allow the comparison or zero if you wish
1216 * @param password The oper's password
1217 * @param input The password entered
1218 * @param tagnumber The tag number (from the configuration file) of this oper's tag
1219 * @return 1 to match the passwords, 0 to do nothing. -1 to not match, and not continue.
1221 virtual int OnOperCompare(const std::string &password, const std::string &input, int tagnumber);
1223 /** Called whenever a user is given usermode +o, anywhere on the network.
1224 * You cannot override this and prevent it from happening as it is already happened and
1225 * such a task must be performed by another server. You can however bounce modes by sending
1226 * servermodes out to reverse mode changes.
1227 * @param user The user who is opering
1229 virtual void OnGlobalOper(userrec* user);
1231 /** Called after a user has fully connected and all modules have executed OnUserConnect
1232 * This event is informational only. You should not change any user information in this
1233 * event. To do so, use the OnUserConnect method to change the state of local users.
1234 * This is called for both local and remote users.
1235 * @param user The user who is connecting
1237 virtual void OnPostConnect(userrec* user);
1239 /** Called whenever a ban is added to a channel's list.
1240 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1241 * @param source The user adding the ban
1242 * @param channel The channel the ban is being added to
1243 * @param banmask The ban mask being added
1244 * @return 1 to block the ban, 0 to continue as normal
1246 virtual int OnAddBan(userrec* source, chanrec* channel,const std::string &banmask);
1248 /** Called whenever a ban is removed from a channel's list.
1249 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1250 * @param source The user deleting the ban
1251 * @param channel The channel the ban is being deleted from
1252 * @param banmask The ban mask being deleted
1253 * @return 1 to block the unban, 0 to continue as normal
1255 virtual int OnDelBan(userrec* source, chanrec* channel,const std::string &banmask);
1257 /** Called immediately after any connection is accepted. This is intended for raw socket
1258 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1259 * no information relating to a user record as the connection has not been assigned yet.
1260 * There are no return values from this call as all modules get an opportunity if required to
1261 * process the connection.
1262 * @param fd The file descriptor returned from accept()
1263 * @param ip The IP address of the connecting user
1264 * @param localport The local port number the user connected to
1266 virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport);
1268 /** Called immediately before any write() operation on a user's socket in the core. Because
1269 * this event is a low level event no user information is associated with it. It is intended
1270 * for use by modules which may wrap connections within another API such as SSL for example.
1271 * return a non-zero result if you have handled the write operation, in which case the core
1272 * will not call write().
1273 * @param fd The file descriptor of the socket
1274 * @param buffer A char* buffer being written
1275 * @param Number of characters to write
1276 * @return Number of characters actually written or 0 if you didn't handle the operation
1278 virtual int OnRawSocketWrite(int fd, const char* buffer, int count);
1280 /** Called immediately before any socket is closed. When this event is called, shutdown()
1281 * has not yet been called on the socket.
1282 * @param fd The file descriptor of the socket prior to close()
1284 virtual void OnRawSocketClose(int fd);
1286 virtual void OnRawSocketConnect(int fd);
1288 /** Called immediately before any read() operation on a client socket in the core.
1289 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1290 * when this event occurs.
1291 * Your event should return 1 if it has handled the reading itself, which prevents the core
1292 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1293 * the value of count. The value of readresult must be identical to an actual result that might
1294 * be returned from the read() system call, for example, number of bytes read upon success,
1295 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1296 * you MUST set readresult.
1297 * @param fd The file descriptor of the socket
1298 * @param buffer A char* buffer being read to
1299 * @param count The size of the buffer
1300 * @param readresult The amount of characters read, or 0
1301 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1303 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1305 /** Called whenever a user sets away.
1306 * This method has no parameter for the away message, as it is available in the
1307 * user record as userrec::awaymsg.
1309 virtual void OnSetAway(userrec* user);
1311 /** Called when a user cancels their away state.
1313 virtual void OnCancelAway(userrec* user);
1315 /** Called whenever a NAMES list is requested.
1316 * You can produce the nameslist yourself, overriding the current list,
1317 * and if you do you must return 1. If you do not handle the names list,
1320 virtual int OnUserList(userrec* user, chanrec* Ptr);
1322 /** Called whenever a line of WHOIS output is sent to a user.
1323 * You may change the numeric and the text of the output by changing
1324 * the values numeric and text, but you cannot change the user the
1325 * numeric is sent to. You may however change the user's userrec values.
1326 * @param user The user the numeric is being sent to
1327 * @param dest The user being WHOISed
1328 * @param numeric The numeric of the line being sent
1329 * @param text The text of the numeric, including any parameters
1330 * @return nonzero to drop the line completely so that the user does not
1331 * receive it, or zero to allow the line to be sent.
1333 virtual int OnWhoisLine(userrec* user, userrec* dest, int &numeric, std::string &text);
1337 #define CONF_NOT_A_NUMBER 0x000010
1338 #define CONF_NOT_UNSIGNED 0x000080
1339 #define CONF_VALUE_NOT_FOUND 0x000100
1340 #define CONF_FILE_NOT_FOUND 0x000200
1343 /** Allows reading of values from configuration files
1344 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1345 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1346 * Constructing the class using one parameter allows you to specify a path to your own configuration
1347 * file, otherwise, inspircd.conf is read.
1349 class ConfigReader : public classbase
1352 InspIRCd* ServerInstance;
1353 /** The contents of the configuration file
1354 * This protected member should never be accessed by a module (and cannot be accessed unless the
1355 * core is changed). It will contain a pointer to the configuration file data with unneeded data
1356 * (such as comments) stripped from it.
1358 ConfigDataHash* data;
1359 std::ostringstream* errorlog;;
1360 /** Used to store errors
1362 bool privatehash; // If we're using our own config data hash or not.
1367 /** Default constructor.
1368 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1369 * as specified when running ./configure.
1371 ConfigReader(InspIRCd* Instance);
1372 /** Overloaded constructor.
1373 * This constructor initialises the ConfigReader class to read a user-specified config file
1375 ConfigReader(InspIRCd* Instance, const std::string &filename);
1376 /** Default destructor.
1377 * This method destroys the ConfigReader class.
1380 /** Retrieves a value from the config file.
1381 * This method retrieves a value from the config file. Where multiple copies of the tag
1382 * exist in the config file, index indicates which of the values to retrieve.
1384 std::string ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds = false);
1385 /** Retrieves a boolean value from the config file.
1386 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1387 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1388 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1390 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1391 /** Retrieves an integer value from the config file.
1392 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1393 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1394 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1395 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1396 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1397 * will return CONF_NOT_UNSIGNED
1399 long ReadInteger(const std::string &tag, const std::string &name, int index, bool needs_unsigned);
1400 /** Returns the last error to occur.
1401 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1402 * A call to GetError() resets the error flag back to 0.
1405 /** Counts the number of times a given tag appears in the config file.
1406 * This method counts the number of times a tag appears in a config file, for use where
1407 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1408 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1409 * multiple instance tag.
1411 int Enumerate(const std::string &tag);
1412 /** Returns true if a config file is valid.
1413 * This method is partially implemented and will only return false if the config
1414 * file does not exist or could not be opened.
1417 /** Dumps the list of errors in a config file to an output location. If bail is true,
1418 * then the program will abort. If bail is false and user points to a valid user
1419 * record, the error report will be spooled to the given user by means of NOTICE.
1420 * if bool is false AND user is false, the error report will be spooled to all opers
1421 * by means of a NOTICE to all opers.
1423 void DumpErrors(bool bail,userrec* user);
1425 /** Returns the number of items within a tag.
1426 * For example if the tag was <test tag="blah" data="foo"> then this
1427 * function would return 2. Spaces and newlines both qualify as valid seperators
1430 int EnumerateValues(const std::string &tag, int index);
1435 /** Caches a text file into memory and can be used to retrieve lines from it.
1436 * This class contains methods for read-only manipulation of a text file in memory.
1437 * Either use the constructor type with one parameter to load a file into memory
1438 * at construction, or use the LoadFile method to load a file.
1440 class FileReader : public classbase
1442 InspIRCd* ServerInstance;
1443 /** The file contents
1447 unsigned long contentsize;
1452 /** Default constructor.
1453 * This method does not load any file into memory, you must use the LoadFile method
1454 * after constructing the class this way.
1456 FileReader(InspIRCd* Instance);
1458 /** Secondary constructor.
1459 * This method initialises the class with a file loaded into it ready for GetLine and
1460 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1463 FileReader(InspIRCd* Instance, const std::string &filename);
1465 /** Default destructor.
1466 * This deletes the memory allocated to the file.
1470 /** Used to load a file.
1471 * This method loads a file into the class ready for GetLine and
1472 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1475 void LoadFile(const std::string &filename);
1477 /** Returns the whole content of the file as std::string
1479 std::string Contents();
1481 /** Returns the entire size of the file as std::string
1483 unsigned long ContentSize();
1485 /** Returns true if the file exists
1486 * This function will return false if the file could not be opened.
1490 /** Retrieve one line from the file.
1491 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1492 * the index was out of bounds, or the line had no data on it.
1494 std::string GetLine(int x);
1496 /** Returns the size of the file in lines.
1497 * This method returns the number of lines in the read file. If it is 0, no lines have been
1498 * read into memory, either because the file is empty or it does not exist, or cannot be
1499 * opened due to permission problems.
1505 /** Instantiates classes inherited from Module.
1506 * This class creates a class inherited from type Module, using new. This is to allow for modules
1507 * to create many different variants of Module, dependent on architecture, configuration, etc.
1508 * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
1511 class ModuleFactory : public classbase
1514 /** The default constructor does nothing.
1517 /** The default destructor does nothing
1519 virtual ~ModuleFactory() { }
1520 /** Creates a new module.
1521 * Your inherited class of ModuleFactory must return a pointer to your Module class
1522 * using this method.
1524 virtual Module * CreateModule(InspIRCd* Me) = 0;
1527 /** A DLLFactory (designed to load shared objects) containing a ModuleFactory.
1529 typedef DLLFactory<ModuleFactory> ircd_module;
1531 /** A list of loaded Modules
1533 typedef std::vector<Module*> ModuleList;
1535 /** A list of loaded ModuleFactories
1537 typedef std::vector<ircd_module*> FactoryList;