1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
7 * <brain@chatspike.net>
8 * <Craig@chatspike.net>
10 * Written by Craig Edwards, Craig McLure, and others.
11 * This program is free but copyrighted software; see
12 * the file COPYING for details.
14 * ---------------------------------------------------
21 /** Used with OnAccessCheck() method of modules
23 enum AccessControlType {
24 ACR_DEFAULT, // Do default action (act as if the module isnt even loaded)
25 ACR_DENY, // deny the action
26 ACR_ALLOW, // allow the action
27 AC_KICK, // a user is being kicked
28 AC_DEOP, // a user is being deopped
29 AC_OP, // a user is being opped
30 AC_VOICE, // a user is being voiced
31 AC_DEVOICE, // a user is being devoiced
32 AC_HALFOP, // a user is being halfopped
33 AC_DEHALFOP, // a user is being dehalfopped
34 AC_INVITE, // a user is being invited
35 AC_GENERAL_MODE // a channel mode is being changed
38 /** Used to define a set of behavior bits for a module
41 VF_STATIC = 1, // module is static, cannot be /unloadmodule'd
42 VF_VENDOR = 2, // module is a vendor module (came in the original tarball, not 3rd party)
43 VF_SERVICEPROVIDER = 4, // module provides a service to other modules (can be a dependency)
44 VF_COMMON = 8 // module needs to be common on all servers in a network to link
52 enum TargetTypeFlags {
63 #include "inspsocket.h"
71 /** If you change the module API, change this value.
72 * If you have enabled ipv6, the sizes of structs is
73 * different, and modules will be incompatible with
74 * ipv4 servers, so this value will be ten times as
75 * high on ipv6 servers.
77 #define NATIVE_API_VERSION 11005
79 #define API_VERSION (NATIVE_API_VERSION * 10)
81 #define API_VERSION (NATIVE_API_VERSION * 1)
86 /* Forward-delacare module for ModuleMessage etc
90 /** Low level definition of a FileReader classes file cache area
92 typedef std::deque<std::string> file_cache;
93 typedef file_cache string_list;
95 /** Holds a list of 'published features' for modules.
97 typedef std::map<std::string,Module*> featurelist;
100 * This #define allows us to call a method in all
101 * loaded modules in a readable simple way, e.g.:
102 * 'FOREACH_MOD(I_OnXonnwxr,OnConnect(user));'
104 #define FOREACH_MOD(y,x) if (ServerInstance->Config->global_implementation[y] > 0) { \
105 for (int _i = 0; _i <= ServerInstance->GetModuleCount(); _i++) { \
106 if (ServerInstance->Config->implement_lists[_i][y]) \
109 ServerInstance->modules[_i]->x ; \
111 catch (ModuleException& modexcept) \
113 ServerInstance->Log(DEBUG,"Module exception caught: %s",modexcept.GetReason()); \
118 #define FOREACH_MOD_I(z,y,x) if (z->Config->global_implementation[y] > 0) { \
119 for (int _i = 0; _i <= z->GetModuleCount(); _i++) { \
120 if (z->Config->implement_lists[_i][y]) \
123 z->modules[_i]->x ; \
125 catch (ModuleException& modexcept) \
127 z->Log(DEBUG,"Module exception caught: %s",modexcept.GetReason()); \
132 * This define is similar to the one above but returns a result in MOD_RESULT.
133 * The first module to return a nonzero result is the value to be accepted,
134 * and any modules after are ignored.
136 #define FOREACH_RESULT(y,x) { if (ServerInstance->Config->global_implementation[y] > 0) { \
138 for (int _i = 0; _i <= ServerInstance->GetModuleCount(); _i++) { \
139 if (ServerInstance->Config->implement_lists[_i][y]) { \
142 int res = ServerInstance->modules[_i]->x ; \
148 catch (ModuleException& modexcept) \
150 ServerInstance->Log(DEBUG,"Module exception cought: %s",modexcept.GetReason()); \
157 #define FOREACH_RESULT_I(z,y,x) { if (z->Config->global_implementation[y] > 0) { \
159 for (int _i = 0; _i <= z->GetModuleCount(); _i++) { \
160 if (z->Config->implement_lists[_i][y]) { \
163 int res = z->modules[_i]->x ; \
169 catch (ModuleException& modexcept) \
171 z->Log(DEBUG,"Module exception cought: %s",modexcept.GetReason()); \
178 #define FD_MAGIC_NUMBER -42
182 #define IS_LOCAL(x) ((x->GetFd() > -1) && (x->GetFd() <= MAX_DESCRIPTORS))
183 #define IS_REMOTE(x) (x->GetFd() < 0)
184 #define IS_MODULE_CREATED(x) (x->GetFd() == FD_MAGIC_NUMBER)
186 /** Holds a module's Version information
187 * The four members (set by the constructor only) indicate details as to the version number
188 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
190 class Version : public classbase
193 const int Major, Minor, Revision, Build, Flags, API;
194 Version(int major, int minor, int revision, int build, int flags, int api_ver);
197 /** The ModuleMessage class is the base class of Request and Event
198 * This class is used to represent a basic data structure which is passed
199 * between modules for safe inter-module communications.
201 class ModuleMessage : public Extensible
204 virtual ~ModuleMessage() {};
207 /** The Request class is a unicast message directed at a given module.
208 * When this class is properly instantiated it may be sent to a module
209 * using the Send() method, which will call the given module's OnRequest
210 * method with this class as its parameter.
212 class Request : public ModuleMessage
215 /** This member holds a pointer to arbitary data set by the emitter of the message
218 /** This should be a null-terminated string identifying the type of request,
219 * all modules should define this and use it to determine the nature of the
220 * request before they attempt to cast the Request in any way.
223 /** This is a pointer to the sender of the message, which can be used to
224 * directly trigger events, or to create a reply.
227 /** The single destination of the Request
231 /** Create a new Request
232 * This is for the 'old' way of casting whatever the data is
233 * to char* and hoping you get the right thing at the other end.
234 * This is slowly being depreciated in favor of the 'new' way.
236 Request(char* anydata, Module* src, Module* dst);
237 /** Create a new Request
238 * This is for the 'new' way of defining a subclass
239 * of Request and defining it in a common header,
240 * passing an object of your Request subclass through
241 * as a Request* and using the ID string to determine
242 * what to cast it back to and the other end. This is
243 * much safer as there are no casts not confirmed by
244 * the ID string, and all casts are child->parent and
245 * can be checked at runtime with dynamic_cast<>()
247 Request(Module* src, Module* dst, const char* idstr);
248 /** Fetch the Request data
251 /** Fetch the ID string
254 /** Fetch the request source
257 /** Fetch the request destination (should be 'this' in the receiving module)
260 /** Send the Request.
261 * Upon returning the result will be arbitary data returned by the module you
262 * sent the request to. It is up to your module to know what this data is and
263 * how to deal with it.
269 /** The Event class is a unicast message directed at all modules.
270 * When the class is properly instantiated it may be sent to all modules
271 * using the Send() method, which will trigger the OnEvent method in
272 * all modules passing the object as its parameter.
274 class Event : public ModuleMessage
277 /** This member holds a pointer to arbitary data set by the emitter of the message
280 /** This is a pointer to the sender of the message, which can be used to
281 * directly trigger events, or to create a reply.
284 /** The event identifier.
285 * This is arbitary text which should be used to distinguish
286 * one type of event from another.
290 /** Create a new Event
292 Event(char* anydata, Module* src, const std::string &eventid);
293 /** Get the Event data
296 /** Get the event Source
299 /** Get the event ID.
300 * Use this to determine the event type for safe casting of the data
302 std::string GetEventID();
304 * The return result of an Event::Send() will always be NULL as
305 * no replies are expected.
307 char* Send(InspIRCd* ServerInstance);
310 /** This class can be used on its own to represent an exception, or derived to represent a module-specific exception.
311 * When a module whishes to abort, e.g. within a constructor, it should throw an exception using ModuleException or
312 * a class derived from ModuleException. If a module throws an exception during its constructor, the module will not
313 * be loaded. If this happens, the error message returned by ModuleException::GetReason will be displayed to the user
314 * attempting to load the module, or dumped to the console if the ircd is currently loading for the first time.
316 class ModuleException : public std::exception
319 /** Holds the error message to be displayed
323 /** Default constructor, just uses the error mesage 'Module threw an exception'.
325 ModuleException() : err("Module threw an exception") {}
326 /** This constructor can be used to specify an error message before throwing.
328 ModuleException(std::string message) : err(message) {}
329 /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
330 * Actually no, it does nothing. Never mind.
333 virtual ~ModuleException() throw() {};
334 /** Returns the reason for the exception.
335 * The module should probably put something informative here as the user will see this upon failure.
337 virtual const char* GetReason()
343 /** Priority types which can be returned from Module::Prioritize()
345 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
347 /** Implementation-specific flags which may be set in Module::Implements()
349 enum Implementation { I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash, I_OnServerRaw,
350 I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois, I_OnUserPreInvite,
351 I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick, I_OnUserMessage, I_OnUserNotice, I_OnMode,
352 I_OnGetServerDescription, I_OnSyncUser, I_OnSyncChannel, I_OnSyncChannelMetaData, I_OnSyncUserMetaData,
353 I_OnDecodeMetaData, I_ProtoSendMode, I_ProtoSendMetaData, I_OnWallops, I_OnChangeHost, I_OnChangeName, I_OnAddGLine,
354 I_OnAddZLine, I_OnAddQLine, I_OnAddKLine, I_OnAddELine, I_OnDelGLine, I_OnDelZLine, I_OnDelKLine, I_OnDelELine, I_OnDelQLine,
355 I_OnCleanup, I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule, I_OnUnloadModule,
356 I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnUserRrgister, I_OnCheckInvite,
357 I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnLocalTopicChange,
358 I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnOperCompre, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan, I_OnDelBan,
359 I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead, I_OnChangeLocalUserGECOS, I_OnUserRegister,
360 I_OnOperCompare, I_OnChannelDelete, I_OnPostOper, I_OnSyncOtherMetaData, I_OnSetAway, I_OnCancelAway, I_OnUserList,
361 I_OnPostCommand, I_OnPostJoin, I_OnWhoisLine };
363 /** Base class for all InspIRCd modules
364 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
365 * its methods will be called when irc server events occur. class inherited from module must be
366 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
368 class Module : public Extensible
371 InspIRCd* ServerInstance;
374 /** Default constructor
375 * Creates a module class.
376 * @param Me An instance of the InspIRCd class which will be saved into ServerInstance for your use
377 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
379 Module(InspIRCd* Me);
381 /** Default destructor
382 * destroys a module class
386 /** Returns the version number of a Module.
387 * The method should return a Version object with its version information assigned via
390 virtual Version GetVersion();
392 /** The Implements function specifies which methods a module should receive events for.
393 * The char* parameter passed to this function contains a set of true or false values
394 * (1 or 0) which indicate wether each function is implemented. You must use the Iimplementation
395 * enum (documented elsewhere on this page) to mark functions as active. For example, to
396 * receive events for OnUserJoin():
398 * Implements[I_OnUserJoin] = 1;
400 * @param The implement list
402 virtual void Implements(char* Implements);
404 /** Used to set the 'priority' of a module (e.g. when it is called in relation to other modules.
405 * Some modules prefer to be called before other modules, due to their design. For example, a
406 * module which is expected to operate on complete information would expect to be placed last, so
407 * that any other modules which wish to adjust that information would execute before it, to be sure
408 * its information is correct. You can change your module's priority by returning one of:
410 * PRIORITY_FIRST - To place your module first in the list
412 * PRIORITY_LAST - To place your module last in the list
414 * PRIORITY_DONTCARE - To leave your module as it is (this is the default value, if you do not implement this function)
416 * The result of InspIRCd::PriorityBefore() - To move your module before another named module
418 * The result of InspIRCd::PriorityLast() - To move your module after another named module
420 * For a good working example of this method call, please see src/modules/m_spanningtree.cpp
421 * and src/modules/m_hostchange.so which make use of it. It is highly recommended that unless
422 * your module has a real need to reorder its priority, it should not implement this function,
423 * as many modules changing their priorities can make the system redundant.
425 virtual Priority Prioritize();
427 /** Called when a user connects.
428 * The details of the connecting user are available to you in the parameter userrec *user
429 * @param user The user who is connecting
431 virtual void OnUserConnect(userrec* user);
433 /** Called when a user quits.
434 * The details of the exiting user are available to you in the parameter userrec *user
435 * This event is only called when the user is fully registered when they quit. To catch
436 * raw disconnections, use the OnUserDisconnect method.
437 * @param user The user who is quitting
438 * @param message The user's quit message
440 virtual void OnUserQuit(userrec* user, const std::string &message);
442 /** Called whenever a user's socket is closed.
443 * The details of the exiting user are available to you in the parameter userrec *user
444 * This event is called for all users, registered or not, as a cleanup method for modules
445 * which might assign resources to user, such as dns lookups, objects and sockets.
446 * @param user The user who is disconnecting
448 virtual void OnUserDisconnect(userrec* user);
450 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
451 * @param chan The channel being deleted
453 virtual void OnChannelDelete(chanrec* chan);
455 /** Called when a user joins a channel.
456 * The details of the joining user are available to you in the parameter userrec *user,
457 * and the details of the channel they have joined is available in the variable chanrec *channel
458 * @param user The user who is joining
459 * @param channel The channel being joined
461 virtual void OnUserJoin(userrec* user, chanrec* channel);
463 /** Called after a user joins a channel
464 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
466 * @param user The user who is joining
467 * @param channel The channel being joined
469 virtual void OnPostJoin(userrec* user, chanrec* channel);
471 /** Called when a user parts a channel.
472 * The details of the leaving user are available to you in the parameter userrec *user,
473 * and the details of the channel they have left is available in the variable chanrec *channel
474 * @param user The user who is parting
475 * @param channel The channel being parted
476 * @param partmessage The part message, or an empty string
478 virtual void OnUserPart(userrec* user, chanrec* channel, const std::string &partmessage);
480 /** Called on rehash.
481 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
482 * system. You should use it to reload any files so that your module keeps in step with the
483 * rest of the application. If a parameter is given, the core has done nothing. The module
484 * receiving the event can decide if this parameter has any relevence to it.
485 * @param parameter The (optional) parameter given to REHASH from the user.
487 virtual void OnRehash(const std::string ¶meter);
489 /** Called when a raw command is transmitted or received.
490 * This method is the lowest level of handler available to a module. It will be called with raw
491 * data which is passing through a connected socket. If you wish, you may munge this data by changing
492 * the string parameter "raw". If you do this, after your function exits it will immediately be
493 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
494 * inbound is set to true) the value of user will be the userrec of the connection sending the
495 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
496 * @param raw The raw string in RFC1459 format
497 * @param inbound A flag to indicate wether the data is coming into the daemon or going out to the user
498 * @param user The user record sending the text, when inbound == true.
500 virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
502 /** Called whenever a user is about to join a channel, before any processing is done.
503 * Returning a value of 1 from this function stops the process immediately, causing no
504 * output to be sent to the user by the core. If you do this you must produce your own numerics,
505 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
506 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
510 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
511 * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
512 * processing on the actual channel record at this point, however the channel NAME will still be passed in
513 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
514 * @param user The user joining the channel
515 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
516 * @param cname The channel name being joined. For new channels this is valid where chan is not.
517 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "@".
518 * You may alter this string to alter the user's modes on the channel.
519 * @return 1 To prevent the join, 0 to allow it.
521 virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname, std::string &privs);
523 /** Called whenever a user is about to be kicked.
524 * Returning a value of 1 from this function stops the process immediately, causing no
525 * output to be sent to the user by the core. If you do this you must produce your own numerics,
527 * @param source The user issuing the kick
528 * @param user The user being kicked
529 * @param chan The channel the user is being kicked from
530 * @param reason The kick reason
531 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
533 virtual int OnUserPreKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason);
535 /** Called whenever a user is kicked.
536 * If this method is called, the kick is already underway and cannot be prevented, so
537 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
538 * @param source The user issuing the kick
539 * @param user The user being kicked
540 * @param chan The channel the user is being kicked from
541 * @param reason The kick reason
543 virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason);
545 /** Called whenever a user opers locally.
546 * The userrec will contain the oper mode 'o' as this function is called after any modifications
547 * are made to the user's structure by the core.
548 * @param user The user who is opering up
549 * @param opertype The opers type name
551 virtual void OnOper(userrec* user, const std::string &opertype);
553 /** Called after a user opers locally.
554 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
555 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
556 * out the OPERTYPE, etc.
557 * @param user The user who is opering up
558 * @param opertype The opers type name
560 virtual void OnPostOper(userrec* user, const std::string &opertype);
562 /** Called whenever a user types /INFO.
563 * The userrec will contain the information of the user who typed the command. Modules may use this
564 * method to output their own credits in /INFO (which is the ircd's version of an about box).
565 * It is purposefully not possible to modify any info that has already been output, or halt the list.
566 * You must write a 371 numeric to the user, containing your info in the following format:
568 * <nick> :information here
570 * @param user The user issuing /INFO
572 virtual void OnInfo(userrec* user);
574 /** Called whenever a /WHOIS is performed on a local user.
575 * The source parameter contains the details of the user who issued the WHOIS command, and
576 * the dest parameter contains the information of the user they are whoising.
577 * @param source The user issuing the WHOIS command
578 * @param dest The user who is being WHOISed
580 virtual void OnWhois(userrec* source, userrec* dest);
582 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
583 * Returning 1 from this function stops the process immediately, causing no
584 * output to be sent to the user by the core. If you do this you must produce your own numerics,
585 * notices etc. This is useful for modules which may want to filter invites to channels.
586 * @param source The user who is issuing the INVITE
587 * @param dest The user being invited
588 * @param channel The channel the user is being invited to
589 * @return 1 to deny the invite, 0 to allow
591 virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel);
593 /** Called after a user has been successfully invited to a channel.
594 * You cannot prevent the invite from occuring using this function, to do that,
595 * use OnUserPreInvite instead.
596 * @param source The user who is issuing the INVITE
597 * @param dest The user being invited
598 * @param channel The channel the user is being invited to
600 virtual void OnUserInvite(userrec* source,userrec* dest,chanrec* channel);
602 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
603 * Returning any nonzero value from this function stops the process immediately, causing no
604 * output to be sent to the user by the core. If you do this you must produce your own numerics,
605 * notices etc. This is useful for modules which may want to filter or redirect messages.
606 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
607 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
608 * of where the message is destined to be sent.
609 * @param user The user sending the message
610 * @param dest The target of the message (chanrec* or userrec*)
611 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
612 * @param text Changeable text being sent by the user
613 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
614 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
615 * It will be ignored for private messages.
616 * @return 1 to deny the NOTICE, 0 to allow it
618 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
620 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
621 * Returning any nonzero value from this function stops the process immediately, causing no
622 * output to be sent to the user by the core. If you do this you must produce your own numerics,
623 * notices etc. This is useful for modules which may want to filter or redirect messages.
624 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
625 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
626 * of where the message is destined to be sent.
627 * You may alter the message text as you wish before relinquishing control to the next module
628 * in the chain, and if no other modules block the text this altered form of the text will be sent out
629 * to the user and possibly to other servers.
630 * @param user The user sending the message
631 * @param dest The target of the message (chanrec* or userrec*)
632 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
633 * @param text Changeable text being sent by the user
634 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
635 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
636 * It will be ignored for private notices.
637 * @return 1 to deny the NOTICE, 0 to allow it
639 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
641 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
642 * Please note that although you can see remote nickchanges through this function, you should
643 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
644 * check user->server before taking any action (including returning nonzero from the method).
645 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
646 * module to generate some meaninful output.
647 * @param user The username changing their nick
648 * @param newnick Their new nickname
649 * @return 1 to deny the change, 0 to allow
651 virtual int OnUserPreNick(userrec* user, const std::string &newnick);
653 /** Called after any PRIVMSG sent from a user.
654 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
655 * if target_type is TYPE_CHANNEL.
656 * @param user The user sending the message
657 * @param dest The target of the message
658 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
659 * @param text the text being sent by the user
660 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
662 virtual void OnUserMessage(userrec* user, void* dest, int target_type, const std::string &text, char status);
664 /** Called after any NOTICE sent from a user.
665 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
666 * if target_type is TYPE_CHANNEL.
667 * @param user The user sending the message
668 * @param dest The target of the message
669 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
670 * @param text the text being sent by the user
671 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
673 virtual void OnUserNotice(userrec* user, void* dest, int target_type, const std::string &text, char status);
675 /** Called after every MODE command sent from a user
676 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
677 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
678 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
679 * @param user The user sending the MODEs
680 * @param dest The target of the modes (userrec* or chanrec*)
681 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
682 * @param text The actual modes and their parameters if any
684 virtual void OnMode(userrec* user, void* dest, int target_type, const std::string &text);
686 /** Allows modules to alter or create server descriptions
687 * Whenever a module requires a server description, for example for display in
688 * WHOIS, this function is called in all modules. You may change or define the
689 * description given in std::string &description. If you do, this description
690 * will be shown in the WHOIS fields.
691 * @param servername The servername being searched for
692 * @param description Alterable server description for this server
694 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
696 /** Allows modules to synchronize data which relates to users during a netburst.
697 * When this function is called, it will be called from the module which implements
698 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
699 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
700 * (see below). This function will be called for every user visible on your side
701 * of the burst, allowing you to for example set modes, etc. Do not use this call to
702 * synchronize data which you have stored using class Extensible -- There is a specialist
703 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
704 * @param user The user being syncronized
705 * @param proto A pointer to the module handling network protocol
706 * @param opaque An opaque pointer set by the protocol module, should not be modified!
708 virtual void OnSyncUser(userrec* user, Module* proto, void* opaque);
710 /** Allows modules to synchronize data which relates to channels during a netburst.
711 * When this function is called, it will be called from the module which implements
712 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
713 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
714 * (see below). This function will be called for every user visible on your side
715 * of the burst, allowing you to for example set modes, etc. Do not use this call to
716 * synchronize data which you have stored using class Extensible -- There is a specialist
717 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
719 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
721 * @param chan The channel being syncronized
722 * @param proto A pointer to the module handling network protocol
723 * @param opaque An opaque pointer set by the protocol module, should not be modified!
725 virtual void OnSyncChannel(chanrec* chan, Module* proto, void* opaque);
727 /* Allows modules to syncronize metadata related to channels over the network during a netburst.
728 * Whenever the linking module wants to send out data, but doesnt know what the data
729 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
730 * this method is called.You should use the ProtoSendMetaData function after you've
731 * correctly decided how the data should be represented, to send the metadata on its way if it belongs
732 * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
733 * @param chan The channel whos metadata is being syncronized
734 * @param proto A pointer to the module handling network protocol
735 * @param opaque An opaque pointer set by the protocol module, should not be modified!
736 * @param extname The extensions name which is being searched for
738 virtual void OnSyncChannelMetaData(chanrec* chan, Module* proto,void* opaque, const std::string &extname);
740 /* Allows modules to syncronize metadata related to users over the network during a netburst.
741 * Whenever the linking module wants to send out data, but doesnt know what the data
742 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
743 * this method is called. You should use the ProtoSendMetaData function after you've
744 * correctly decided how the data should be represented, to send the metadata on its way if
745 * if it belongs to your module.
746 * @param user The user whos metadata is being syncronized
747 * @param proto A pointer to the module handling network protocol
748 * @param opaque An opaque pointer set by the protocol module, should not be modified!
749 * @param extname The extensions name which is being searched for
751 virtual void OnSyncUserMetaData(userrec* user, Module* proto,void* opaque, const std::string &extname);
753 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
754 * Whenever the linking module wants to send out data, but doesnt know what the data
755 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
756 * this method is called. You should use the ProtoSendMetaData function after you've
757 * correctly decided how the data should be represented, to send the metadata on its way if
758 * if it belongs to your module.
759 * @param proto A pointer to the module handling network protocol
760 * @param opaque An opaque pointer set by the protocol module, should not be modified!
762 virtual void OnSyncOtherMetaData(Module* proto, void* opaque);
764 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
765 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
766 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
767 * @param target The chanrec* or userrec* that data should be added to
768 * @param extname The extension name which is being sent
769 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
771 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata);
773 /** Implemented by modules which provide the ability to link servers.
774 * These modules will implement this method, which allows transparent sending of servermodes
775 * down the network link as a broadcast, without a module calling it having to know the format
776 * of the MODE command before the actual mode string.
778 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
779 * of how to use this function.
781 * @param opaque An opaque pointer set by the protocol module, should not be modified!
782 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
783 * @param target The chanrec* or userrec* that modes should be sent for
784 * @param modeline The modes and parameters to be sent
786 virtual void ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline);
788 /** Implemented by modules which provide the ability to link servers.
789 * These modules will implement this method, which allows metadata (extra data added to
790 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
791 * to other servers on a netburst and decoded at the other end by the same module on a
794 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
795 * how to use this function.
796 * @param opaque An opaque pointer set by the protocol module, should not be modified!
797 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
798 * @param target The chanrec* or userrec* that metadata should be sent for
799 * @param extname The extension name to send metadata for
800 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
802 virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata);
804 /** Called after every WALLOPS command.
805 * @param user The user sending the WALLOPS
806 * @param text The content of the WALLOPS message
808 virtual void OnWallops(userrec* user, const std::string &text);
810 /** Called whenever a user's hostname is changed.
811 * This event triggers after the host has been set.
812 * @param user The user whos host is being changed
813 * @param newhost The new hostname being set
815 virtual void OnChangeHost(userrec* user, const std::string &newhost);
817 /** Called whenever a user's GECOS (realname) is changed.
818 * This event triggers after the name has been set.
819 * @param user The user who's GECOS is being changed
820 * @param gecos The new GECOS being set on the user
822 virtual void OnChangeName(userrec* user, const std::string &gecos);
824 /** Called whenever a gline is added by a local user.
825 * This method is triggered after the line is added.
826 * @param duration The duration of the line in seconds
827 * @param source The sender of the line
828 * @param reason The reason text to be displayed
829 * @param hostmask The hostmask to add
831 virtual void OnAddGLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
833 /** Called whenever a zline is added by a local user.
834 * This method is triggered after the line is added.
835 * @param duration The duration of the line in seconds
836 * @param source The sender of the line
837 * @param reason The reason text to be displayed
838 * @param ipmask The hostmask to add
840 virtual void OnAddZLine(long duration, userrec* source, const std::string &reason, const std::string &ipmask);
842 /** Called whenever a kline is added by a local user.
843 * This method is triggered after the line is added.
844 * @param duration The duration of the line in seconds
845 * @param source The sender of the line
846 * @param reason The reason text to be displayed
847 * @param hostmask The hostmask to add
849 virtual void OnAddKLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
851 /** Called whenever a qline is added by a local user.
852 * This method is triggered after the line is added.
853 * @param duration The duration of the line in seconds
854 * @param source The sender of the line
855 * @param reason The reason text to be displayed
856 * @param nickmask The hostmask to add
858 virtual void OnAddQLine(long duration, userrec* source, const std::string &reason, const std::string &nickmask);
860 /** Called whenever a eline 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 OnAddELine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
869 /** Called whenever a gline is deleted.
870 * This method is triggered after the line is deleted.
871 * @param source The user removing the line
872 * @param hostmask The hostmask to delete
874 virtual void OnDelGLine(userrec* source, const std::string &hostmask);
876 /** Called whenever a zline is deleted.
877 * This method is triggered after the line is deleted.
878 * @param source The user removing the line
879 * @param hostmask The hostmask to delete
881 virtual void OnDelZLine(userrec* source, const std::string &ipmask);
883 /** Called whenever a kline is deleted.
884 * This method is triggered after the line is deleted.
885 * @param source The user removing the line
886 * @param hostmask The hostmask to delete
888 virtual void OnDelKLine(userrec* source, const std::string &hostmask);
890 /** Called whenever a qline is deleted.
891 * This method is triggered after the line is deleted.
892 * @param source The user removing the line
893 * @param hostmask The hostmask to delete
895 virtual void OnDelQLine(userrec* source, const std::string &nickmask);
897 /** Called whenever a eline is deleted.
898 * This method is triggered after the line is deleted.
899 * @param source The user removing the line
900 * @param hostmask The hostmask to delete
902 virtual void OnDelELine(userrec* source, const std::string &hostmask);
904 /** Called before your module is unloaded to clean up Extensibles.
905 * This method is called once for every user and channel on the network,
906 * so that when your module unloads it may clear up any remaining data
907 * in the form of Extensibles added using Extensible::Extend().
908 * If the target_type variable is TYPE_USER, then void* item refers to
909 * a userrec*, otherwise it refers to a chanrec*.
910 * @param target_type The type of item being cleaned
911 * @param item A pointer to the item's class
913 virtual void OnCleanup(int target_type, void* item);
915 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
916 * have been applied. Please note that although you can see remote nickchanges through this function, you should
917 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
918 * check user->server before taking any action (including returning nonzero from the method).
919 * Because this method is called after the nickchange is taken place, no return values are possible
920 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
921 * @param user The user changing their nick
922 * @param oldnick The old nickname of the user before the nickchange
924 virtual void OnUserPostNick(userrec* user, const std::string &oldnick);
926 /** Called before an action which requires a channel privilage check.
927 * This function is called before many functions which check a users status on a channel, for example
928 * before opping a user, deopping a user, kicking a user, etc.
929 * There are several values for access_type which indicate for what reason access is being checked.
931 * AC_KICK (0) - A user is being kicked<br>
932 * AC_DEOP (1) - a user is being deopped<br>
933 * AC_OP (2) - a user is being opped<br>
934 * AC_VOICE (3) - a user is being voiced<br>
935 * AC_DEVOICE (4) - a user is being devoiced<br>
936 * AC_HALFOP (5) - a user is being halfopped<br>
937 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
938 * AC_INVITE () - a user is being invited<br>
939 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
940 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
941 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
942 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
943 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
944 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
945 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
946 * @param source The source of the access check
947 * @param dest The destination of the access check
948 * @param channel The channel which is being checked
949 * @param access_type See above
951 virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
953 /** Called when a 005 numeric is about to be output.
954 * The module should modify the 005 numeric if needed to indicate its features.
955 * @param output The 005 string to be modified if neccessary.
957 virtual void On005Numeric(std::string &output);
959 /** Called when a client is disconnected by KILL.
960 * If a client is killed by a server, e.g. a nickname collision or protocol error,
962 * Return 1 from this function to prevent the kill, and 0 from this function to allow
963 * it as normal. If you prevent the kill no output will be sent to the client, it is
964 * down to your module to generate this information.
965 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
966 * If you do so youre risking race conditions, desyncs and worse!
967 * @param source The user sending the KILL
968 * @param dest The user being killed
969 * @param reason The kill reason
970 * @return 1 to prevent the kill, 0 to allow
972 virtual int OnKill(userrec* source, userrec* dest, const std::string &reason);
974 /** Called when an oper wants to disconnect a remote user via KILL
975 * @param source The user sending the KILL
976 * @param dest The user being killed
977 * @param reason The kill reason
979 virtual void OnRemoteKill(userrec* source, userrec* dest, const std::string &reason);
981 /** Called whenever a module is loaded.
982 * mod will contain a pointer to the module, and string will contain its name,
983 * for example m_widgets.so. This function is primary for dependency checking,
984 * your module may decide to enable some extra features if it sees that you have
985 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
986 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
987 * but instead operate under reduced functionality, unless the dependency is
988 * absolutely neccessary (e.g. a module that extends the features of another
990 * @param mod A pointer to the new module
991 * @param name The new module's filename
993 virtual void OnLoadModule(Module* mod,const std::string &name);
995 /** Called whenever a module is unloaded.
996 * mod will contain a pointer to the module, and string will contain its name,
997 * for example m_widgets.so. This function is primary for dependency checking,
998 * your module may decide to enable some extra features if it sees that you have
999 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
1000 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
1001 * but instead operate under reduced functionality, unless the dependency is
1002 * absolutely neccessary (e.g. a module that extends the features of another
1004 * @param mod Pointer to the module being unloaded (still valid)
1005 * @param name The filename of the module being unloaded
1007 virtual void OnUnloadModule(Module* mod,const std::string &name);
1009 /** Called once every five seconds for background processing.
1010 * This timer can be used to control timed features. Its period is not accurate
1011 * enough to be used as a clock, but it is gauranteed to be called at least once in
1012 * any five second period, directly from the main loop of the server.
1013 * @param curtime The current timer derived from time(2)
1015 virtual void OnBackgroundTimer(time_t curtime);
1017 /** Called whenever any command is about to be executed.
1018 * This event occurs for all registered commands, wether they are registered in the core,
1019 * or another module, and for invalid commands. Invalid commands may only be sent to this
1020 * function when the value of validated is false. By returning 1 from this method you may prevent the
1021 * command being executed. If you do this, no output is created by the core, and it is
1022 * down to your module to produce any output neccessary.
1023 * Note that unless you return 1, you should not destroy any structures (e.g. by using
1024 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
1025 * method returns, it will be passed an invalid pointer to the user object and crash!)
1026 * @param command The command being executed
1027 * @param parameters An array of array of characters containing the parameters for the command
1028 * @param pcnt The nuimber of parameters passed to the command
1029 * @param user the user issuing the command
1030 * @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.
1031 * @param original_line The entire original line as passed to the parser from the user
1032 * @return 1 to block the command, 0 to allow
1034 virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line);
1036 /** Called after any command has been executed.
1037 * This event occurs for all registered commands, wether they are registered in the core,
1038 * or another module, but it will not occur for invalid commands (e.g. ones which do not
1039 * exist within the command table). The result code returned by the command handler is
1041 * @param command The command being executed
1042 * @param parameters An array of array of characters containing the parameters for the command
1043 * @param pcnt The nuimber of parameters passed to the command
1044 * @param user the user issuing the command
1045 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
1046 * @param original_line The entire original line as passed to the parser from the user
1048 virtual void OnPostCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, CmdResult result, const std::string &original_line);
1050 /** Called to check if a user who is connecting can now be allowed to register
1051 * If any modules return false for this function, the user is held in the waiting
1052 * state until all modules return true. For example a module which implements ident
1053 * lookups will continue to return false for a user until their ident lookup is completed.
1054 * Note that the registration timeout for a user overrides these checks, if the registration
1055 * timeout is reached, the user is disconnected even if modules report that the user is
1056 * not ready to connect.
1057 * @param user The user to check
1058 * @return true to indicate readiness, false if otherwise
1060 virtual bool OnCheckReady(userrec* user);
1062 /** Called whenever a user is about to register their connection (e.g. before the user
1063 * is sent the MOTD etc). Modules can use this method if they are performing a function
1064 * which must be done before the actual connection is completed (e.g. ident lookups,
1065 * dnsbl lookups, etc).
1066 * Note that you should NOT delete the user record here by causing a disconnection!
1067 * Use OnUserConnect for that instead.
1068 * @param user The user registering
1069 * @return 1 to indicate user quit, 0 to continue
1071 virtual int OnUserRegister(userrec* user);
1073 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1074 * This method will always be called for each join, wether or not the channel is actually +i, and
1075 * determines the outcome of an if statement around the whole section of invite checking code.
1076 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1077 * @param user The user joining the channel
1078 * @param chan The channel being joined
1079 * @return 1 to explicitly allow the join, 0 to proceed as normal
1081 virtual int OnCheckInvite(userrec* user, chanrec* chan);
1083 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1084 * This method will always be called for each join, wether or not the channel is actually +k, and
1085 * determines the outcome of an if statement around the whole section of key checking code.
1086 * if the user specified no key, the keygiven string will be a valid but empty value.
1087 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1088 * @param user The user joining the channel
1089 * @param chan The channel being joined
1090 * @return 1 to explicitly allow the join, 0 to proceed as normal
1092 virtual int OnCheckKey(userrec* user, chanrec* chan, const std::string &keygiven);
1094 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1095 * This method will always be called for each join, wether or not the channel is actually +l, and
1096 * determines the outcome of an if statement around the whole section of channel limit checking code.
1097 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1098 * @param user The user joining the channel
1099 * @param chan The channel being joined
1100 * @return 1 to explicitly allow the join, 0 to proceed as normal
1102 virtual int OnCheckLimit(userrec* user, chanrec* chan);
1104 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
1105 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
1106 * determines the outcome of an if statement around the whole section of ban checking code.
1107 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1108 * @param user The user joining the channel
1109 * @param chan The channel being joined
1110 * @return 1 to explicitly allow the join, 0 to proceed as normal
1112 virtual int OnCheckBan(userrec* user, chanrec* chan);
1114 /** Called on all /STATS commands
1115 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1116 * @param symbol the symbol provided to /STATS
1117 * @param user the user issuing the /STATS command
1118 * @param results A string_list to append results into. You should put all your results
1119 * into this string_list, rather than displaying them directly, so that your handler will
1120 * work when remote STATS queries are received.
1121 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1123 virtual int OnStats(char symbol, userrec* user, string_list &results);
1125 /** Called whenever a change of a local users displayed host is attempted.
1126 * Return 1 to deny the host change, or 0 to allow it.
1127 * @param user The user whos host will be changed
1128 * @param newhost The new hostname
1129 * @return 1 to deny the host change, 0 to allow
1131 virtual int OnChangeLocalUserHost(userrec* user, const std::string &newhost);
1133 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1134 * return 1 to deny the name change, or 0 to allow it.
1135 * @param user The user whos GECOS will be changed
1136 * @param newhost The new GECOS
1137 * @return 1 to deny the GECOS change, 0 to allow
1139 virtual int OnChangeLocalUserGECOS(userrec* user, const std::string &newhost);
1141 /** Called whenever a topic is changed by a local user.
1142 * Return 1 to deny the topic change, or 0 to allow it.
1143 * @param user The user changing the topic
1144 * @param chan The channels who's topic is being changed
1145 * @param topic The actual topic text
1146 * @param 1 to block the topic change, 0 to allow
1148 virtual int OnLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic);
1150 /** Called whenever a local topic has been changed.
1151 * To block topic changes you must use OnLocalTopicChange instead.
1152 * @param user The user changing the topic
1153 * @param chan The channels who's topic is being changed
1154 * @param topic The actual topic text
1156 virtual void OnPostLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic);
1158 /** Called whenever an Event class is sent to all module by another module.
1159 * Please see the documentation of Event::Send() for further information. The Event sent can
1160 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1161 * before doing anything to the event data, and you should *not* change the event data in any way!
1162 * @param event The Event class being received
1164 virtual void OnEvent(Event* event);
1166 /** Called whenever a Request class is sent to your module by another module.
1167 * Please see the documentation of Request::Send() for further information. The Request sent
1168 * can always be assumed to be non-NULL, you should not change the request object or its data.
1169 * Your method may return arbitary data in the char* result which the requesting module
1170 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1171 * @param request The Request class being received
1173 virtual char* OnRequest(Request* request);
1175 /** Called whenever an oper password is to be compared to what a user has input.
1176 * The password field (from the config file) is in 'password' and is to be compared against
1177 * 'input'. This method allows for encryption of oper passwords and much more besides.
1178 * You should return a nonzero value if you want to allow the comparison or zero if you wish
1180 * @param password The oper's password
1181 * @param input The password entered
1182 * @return 1 to match the passwords, 0 to do nothing
1184 virtual int OnOperCompare(const std::string &password, const std::string &input);
1186 /** Called whenever a user is given usermode +o, anywhere on the network.
1187 * You cannot override this and prevent it from happening as it is already happened and
1188 * such a task must be performed by another server. You can however bounce modes by sending
1189 * servermodes out to reverse mode changes.
1190 * @param user The user who is opering
1192 virtual void OnGlobalOper(userrec* user);
1194 /** Called after a user has fully connected and all modules have executed OnUserConnect
1195 * This event is informational only. You should not change any user information in this
1196 * event. To do so, use the OnUserConnect method to change the state of local users.
1197 * This is called for both local and remote users.
1198 * @param user The user who is connecting
1200 virtual void OnPostConnect(userrec* user);
1202 /** Called whenever a ban is added to a channel's list.
1203 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1204 * @param source The user adding the ban
1205 * @param channel The channel the ban is being added to
1206 * @param banmask The ban mask being added
1207 * @return 1 to block the ban, 0 to continue as normal
1209 virtual int OnAddBan(userrec* source, chanrec* channel,const std::string &banmask);
1211 /** Called whenever a ban is removed from a channel's list.
1212 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1213 * @param source The user deleting the ban
1214 * @param channel The channel the ban is being deleted from
1215 * @param banmask The ban mask being deleted
1216 * @return 1 to block the unban, 0 to continue as normal
1218 virtual int OnDelBan(userrec* source, chanrec* channel,const std::string &banmask);
1220 /** Called immediately after any connection is accepted. This is intended for raw socket
1221 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1222 * no information relating to a user record as the connection has not been assigned yet.
1223 * There are no return values from this call as all modules get an opportunity if required to
1224 * process the connection.
1225 * @param fd The file descriptor returned from accept()
1226 * @param ip The IP address of the connecting user
1227 * @param localport The local port number the user connected to
1229 virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport);
1231 /** Called immediately before any write() operation on a user's socket in the core. Because
1232 * this event is a low level event no user information is associated with it. It is intended
1233 * for use by modules which may wrap connections within another API such as SSL for example.
1234 * return a non-zero result if you have handled the write operation, in which case the core
1235 * will not call write().
1236 * @param fd The file descriptor of the socket
1237 * @param buffer A char* buffer being written
1238 * @param Number of characters to write
1239 * @return Number of characters actually written or 0 if you didn't handle the operation
1241 virtual int OnRawSocketWrite(int fd, const char* buffer, int count);
1243 /** Called immediately before any socket is closed. When this event is called, shutdown()
1244 * has not yet been called on the socket.
1245 * @param fd The file descriptor of the socket prior to close()
1247 virtual void OnRawSocketClose(int fd);
1249 /** Called immediately before any read() operation on a client socket in the core.
1250 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1251 * when this event occurs.
1252 * Your event should return 1 if it has handled the reading itself, which prevents the core
1253 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1254 * the value of count. The value of readresult must be identical to an actual result that might
1255 * be returned from the read() system call, for example, number of bytes read upon success,
1256 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1257 * you MUST set readresult.
1258 * @param fd The file descriptor of the socket
1259 * @param buffer A char* buffer being read to
1260 * @param count The size of the buffer
1261 * @param readresult The amount of characters read, or 0
1262 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1264 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1266 /** Called whenever a user sets away.
1267 * This method has no parameter for the away message, as it is available in the
1268 * user record as userrec::awaymsg.
1270 virtual void OnSetAway(userrec* user);
1272 /** Called when a user cancels their away state.
1274 virtual void OnCancelAway(userrec* user);
1276 /** Called whenever a NAMES list is requested.
1277 * You can produce the nameslist yourself, overriding the current list,
1278 * and if you do you must return 1. If you do not handle the names list,
1281 virtual int OnUserList(userrec* user, chanrec* Ptr);
1283 /** Called whenever a line of WHOIS output is sent to a user.
1284 * You may change the numeric and the text of the output by changing
1285 * the values numeric and text, but you cannot change the user the
1286 * numeric is sent to. You may however change the user's userrec values.
1287 * @param user The user the numeric is being sent to
1288 * @param dest The user being WHOISed
1289 * @param numeric The numeric of the line being sent
1290 * @param text The text of the numeric, including any parameters
1291 * @return nonzero to drop the line completely so that the user does not
1292 * receive it, or zero to allow the line to be sent.
1294 virtual int OnWhoisLine(userrec* user, userrec* dest, int &numeric, std::string &text);
1298 #define CONF_NOT_A_NUMBER 0x000010
1299 #define CONF_NOT_UNSIGNED 0x000080
1300 #define CONF_VALUE_NOT_FOUND 0x000100
1301 #define CONF_FILE_NOT_FOUND 0x000200
1304 /** Allows reading of values from configuration files
1305 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1306 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1307 * Constructing the class using one parameter allows you to specify a path to your own configuration
1308 * file, otherwise, inspircd.conf is read.
1310 class ConfigReader : public classbase
1313 InspIRCd* ServerInstance;
1314 /** The contents of the configuration file
1315 * This protected member should never be accessed by a module (and cannot be accessed unless the
1316 * core is changed). It will contain a pointer to the configuration file data with unneeded data
1317 * (such as comments) stripped from it.
1319 ConfigDataHash* data;
1320 std::ostringstream* errorlog;;
1321 /** Used to store errors
1323 bool privatehash; // If we're using our own config data hash or not.
1328 /** Default constructor.
1329 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1330 * as specified when running ./configure.
1332 ConfigReader(InspIRCd* Instance);
1333 /** Overloaded constructor.
1334 * This constructor initialises the ConfigReader class to read a user-specified config file
1336 ConfigReader(InspIRCd* Instance, const std::string &filename);
1337 /** Default destructor.
1338 * This method destroys the ConfigReader class.
1341 /** Retrieves a value from the config file.
1342 * This method retrieves a value from the config file. Where multiple copies of the tag
1343 * exist in the config file, index indicates which of the values to retrieve.
1345 std::string ReadValue(const std::string &tag, const std::string &name, int index);
1346 /** Retrieves a boolean value from the config file.
1347 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1348 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1349 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1351 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1352 /** Retrieves an integer value from the config file.
1353 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1354 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1355 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1356 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1357 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1358 * will return CONF_NOT_UNSIGNED
1360 long ReadInteger(const std::string &tag, const std::string &name, int index, bool needs_unsigned);
1361 /** Returns the last error to occur.
1362 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1363 * A call to GetError() resets the error flag back to 0.
1366 /** Counts the number of times a given tag appears in the config file.
1367 * This method counts the number of times a tag appears in a config file, for use where
1368 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1369 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1370 * multiple instance tag.
1372 int Enumerate(const std::string &tag);
1373 /** Returns true if a config file is valid.
1374 * This method is partially implemented and will only return false if the config
1375 * file does not exist or could not be opened.
1378 /** Dumps the list of errors in a config file to an output location. If bail is true,
1379 * then the program will abort. If bail is false and user points to a valid user
1380 * record, the error report will be spooled to the given user by means of NOTICE.
1381 * if bool is false AND user is false, the error report will be spooled to all opers
1382 * by means of a NOTICE to all opers.
1384 void DumpErrors(bool bail,userrec* user);
1386 /** Returns the number of items within a tag.
1387 * For example if the tag was <test tag="blah" data="foo"> then this
1388 * function would return 2. Spaces and newlines both qualify as valid seperators
1391 int EnumerateValues(const std::string &tag, int index);
1396 /** Caches a text file into memory and can be used to retrieve lines from it.
1397 * This class contains methods for read-only manipulation of a text file in memory.
1398 * Either use the constructor type with one parameter to load a file into memory
1399 * at construction, or use the LoadFile method to load a file.
1401 class FileReader : public classbase
1403 InspIRCd* ServerInstance;
1404 /** The file contents
1408 unsigned long contentsize;
1413 /** Default constructor.
1414 * This method does not load any file into memory, you must use the LoadFile method
1415 * after constructing the class this way.
1417 FileReader(InspIRCd* Instance);
1419 /** Secondary constructor.
1420 * This method initialises the class with a file loaded into it ready for GetLine and
1421 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1424 FileReader(InspIRCd* Instance, const std::string &filename);
1426 /** Default destructor.
1427 * This deletes the memory allocated to the file.
1431 /** Used to load a file.
1432 * This method loads a file into the class ready for GetLine and
1433 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1436 void LoadFile(const std::string &filename);
1438 /** Returns the whole content of the file as std::string
1440 std::string Contents();
1442 /** Returns the entire size of the file as std::string
1444 unsigned long ContentSize();
1446 /** Returns true if the file exists
1447 * This function will return false if the file could not be opened.
1451 /** Retrieve one line from the file.
1452 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1453 * the index was out of bounds, or the line had no data on it.
1455 std::string GetLine(int x);
1457 /** Returns the size of the file in lines.
1458 * This method returns the number of lines in the read file. If it is 0, no lines have been
1459 * read into memory, either because the file is empty or it does not exist, or cannot be
1460 * opened due to permission problems.
1466 /** Instantiates classes inherited from Module.
1467 * This class creates a class inherited from type Module, using new. This is to allow for modules
1468 * to create many different variants of Module, dependent on architecture, configuration, etc.
1469 * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
1472 class ModuleFactory : public classbase
1475 /** The default constructor does nothing.
1478 /** The default destructor does nothing
1480 virtual ~ModuleFactory() { }
1481 /** Creates a new module.
1482 * Your inherited class of ModuleFactory must return a pointer to your Module class
1483 * using this method.
1485 virtual Module * CreateModule(InspIRCd* Me) = 0;
1488 /** A DLLFactory (designed to load shared objects) containing a ModuleFactory.
1490 typedef DLLFactory<ModuleFactory> ircd_module;
1492 /** A list of loaded Modules
1494 typedef std::vector<Module*> ModuleList;
1496 /** A list of loaded ModuleFactories
1498 typedef std::vector<ircd_module*> FactoryList;