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
73 #define API_VERSION 11001
77 /* Forward-delacare module for ModuleMessage etc
81 /** Low level definition of a FileReader classes file cache area
83 typedef std::deque<std::string> file_cache;
84 typedef file_cache string_list;
86 /** Holds a list of 'published features' for modules.
88 typedef std::map<std::string,Module*> featurelist;
91 * This #define allows us to call a method in all
92 * loaded modules in a readable simple way, e.g.:
93 * 'FOREACH_MOD(I_OnXonnwxr,OnConnect(user));'
95 #define FOREACH_MOD(y,x) if (ServerInstance->Config->global_implementation[y] > 0) { \
96 for (int _i = 0; _i <= ServerInstance->GetModuleCount(); _i++) { \
97 if (ServerInstance->Config->implement_lists[_i][y]) \
100 ServerInstance->modules[_i]->x ; \
102 catch (ModuleException& modexcept) \
104 ServerInstance->Log(DEBUG,"Module exception caught: %s",modexcept.GetReason()); \
109 #define FOREACH_MOD_I(z,y,x) if (z->Config->global_implementation[y] > 0) { \
110 for (int _i = 0; _i <= z->GetModuleCount(); _i++) { \
111 if (z->Config->implement_lists[_i][y]) \
114 z->modules[_i]->x ; \
116 catch (ModuleException& modexcept) \
118 z->Log(DEBUG,"Module exception caught: %s",modexcept.GetReason()); \
123 * This define is similar to the one above but returns a result in MOD_RESULT.
124 * The first module to return a nonzero result is the value to be accepted,
125 * and any modules after are ignored.
127 #define FOREACH_RESULT(y,x) { if (ServerInstance->Config->global_implementation[y] > 0) { \
129 for (int _i = 0; _i <= ServerInstance->GetModuleCount(); _i++) { \
130 if (ServerInstance->Config->implement_lists[_i][y]) { \
133 int res = ServerInstance->modules[_i]->x ; \
139 catch (ModuleException& modexcept) \
141 ServerInstance->Log(DEBUG,"Module exception cought: %s",modexcept.GetReason()); \
148 #define FOREACH_RESULT_I(z,y,x) { if (z->Config->global_implementation[y] > 0) { \
150 for (int _i = 0; _i <= z->GetModuleCount(); _i++) { \
151 if (z->Config->implement_lists[_i][y]) { \
154 int res = z->modules[_i]->x ; \
160 catch (ModuleException& modexcept) \
162 z->Log(DEBUG,"Module exception cought: %s",modexcept.GetReason()); \
169 #define FD_MAGIC_NUMBER -42
173 #define IS_LOCAL(x) ((x->GetFd() > -1) && (x->GetFd() <= MAX_DESCRIPTORS))
174 #define IS_REMOTE(x) (x->GetFd() < 0)
175 #define IS_MODULE_CREATED(x) (x->GetFd() == FD_MAGIC_NUMBER)
177 /** Holds a module's Version information
178 * The four members (set by the constructor only) indicate details as to the version number
179 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
181 class Version : public classbase
184 const int Major, Minor, Revision, Build, Flags, API;
185 Version(int major, int minor, int revision, int build, int flags, int api_ver);
188 /** The ModuleMessage class is the base class of Request and Event
189 * This class is used to represent a basic data structure which is passed
190 * between modules for safe inter-module communications.
192 class ModuleMessage : public Extensible
195 virtual ~ModuleMessage() {};
198 /** The Request class is a unicast message directed at a given module.
199 * When this class is properly instantiated it may be sent to a module
200 * using the Send() method, which will call the given module's OnRequest
201 * method with this class as its parameter.
203 class Request : public ModuleMessage
206 /** This member holds a pointer to arbitary data set by the emitter of the message
209 /** This should be a null-terminated string identifying the type of request,
210 * all modules should define this and use it to determine the nature of the
211 * request before they attempt to cast the Request in any way.
214 /** This is a pointer to the sender of the message, which can be used to
215 * directly trigger events, or to create a reply.
218 /** The single destination of the Request
222 /** Create a new Request
223 * This is for the 'old' way of casting whatever the data is
224 * to char* and hoping you get the right thing at the other end.
225 * This is slowly being depreciated in favor of the 'new' way.
227 Request(char* anydata, Module* src, Module* dst);
228 /** Create a new Request
229 * This is for the 'new' way of defining a subclass
230 * of Request and defining it in a common header,
231 * passing an object of your Request subclass through
232 * as a Request* and using the ID string to determine
233 * what to cast it back to and the other end. This is
234 * much safer as there are no casts not confirmed by
235 * the ID string, and all casts are child->parent and
236 * can be checked at runtime with dynamic_cast<>()
238 Request(Module* src, Module* dst, const char* idstr);
239 /** Fetch the Request data
242 /** Fetch the ID string
245 /** Fetch the request source
248 /** Fetch the request destination (should be 'this' in the receiving module)
251 /** Send the Request.
252 * Upon returning the result will be arbitary data returned by the module you
253 * sent the request to. It is up to your module to know what this data is and
254 * how to deal with it.
260 /** The Event class is a unicast message directed at all modules.
261 * When the class is properly instantiated it may be sent to all modules
262 * using the Send() method, which will trigger the OnEvent method in
263 * all modules passing the object as its parameter.
265 class Event : public ModuleMessage
268 /** This member holds a pointer to arbitary data set by the emitter of the message
271 /** This is a pointer to the sender of the message, which can be used to
272 * directly trigger events, or to create a reply.
275 /** The event identifier.
276 * This is arbitary text which should be used to distinguish
277 * one type of event from another.
281 /** Create a new Event
283 Event(char* anydata, Module* src, const std::string &eventid);
284 /** Get the Event data
287 /** Get the event Source
290 /** Get the event ID.
291 * Use this to determine the event type for safe casting of the data
293 std::string GetEventID();
295 * The return result of an Event::Send() will always be NULL as
296 * no replies are expected.
298 char* Send(InspIRCd* ServerInstance);
301 /** This class can be used on its own to represent an exception, or derived to represent a module-specific exception.
302 * When a module whishes to abort, e.g. within a constructor, it should throw an exception using ModuleException or
303 * a class derived from ModuleException. If a module throws an exception during its constructor, the module will not
304 * be loaded. If this happens, the error message returned by ModuleException::GetReason will be displayed to the user
305 * attempting to load the module, or dumped to the console if the ircd is currently loading for the first time.
307 class ModuleException : public classbase
310 /** Holds the error message to be displayed
314 /** Default constructor, just uses the error mesage 'Module threw an exception'.
316 ModuleException() : err("Module threw an exception") {}
317 /** This constructor can be used to specify an error message before throwing.
319 ModuleException(std::string message) : err(message) {}
320 /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
321 * Actually no, it does nothing. Never mind.
323 virtual ~ModuleException() {};
324 /** Returns the reason for the exception.
325 * The module should probably put something informative here as the user will see this upon failure.
327 virtual const char* GetReason()
333 /** Priority types which can be returned from Module::Prioritize()
335 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
337 /** Implementation-specific flags which may be set in Module::Implements()
339 enum Implementation { I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash, I_OnServerRaw,
340 I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois, I_OnUserPreInvite,
341 I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick, I_OnUserMessage, I_OnUserNotice, I_OnMode,
342 I_OnGetServerDescription, I_OnSyncUser, I_OnSyncChannel, I_OnSyncChannelMetaData, I_OnSyncUserMetaData,
343 I_OnDecodeMetaData, I_ProtoSendMode, I_ProtoSendMetaData, I_OnWallops, I_OnChangeHost, I_OnChangeName, I_OnAddGLine,
344 I_OnAddZLine, I_OnAddQLine, I_OnAddKLine, I_OnAddELine, I_OnDelGLine, I_OnDelZLine, I_OnDelKLine, I_OnDelELine, I_OnDelQLine,
345 I_OnCleanup, I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule, I_OnUnloadModule,
346 I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnUserRrgister, I_OnRawMode, I_OnCheckInvite,
347 I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnLocalTopicChange,
348 I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnOperCompre, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan, I_OnDelBan,
349 I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead, I_OnChangeLocalUserGECOS, I_OnUserRegister,
350 I_OnOperCompare, I_OnChannelDelete, I_OnPostOper, I_OnSyncOtherMetaData, I_OnSetAway, I_OnCancelAway, I_OnUserList, I_OnPostCommand, I_OnPostJoin };
352 /** Base class for all InspIRCd modules
353 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
354 * its methods will be called when irc server events occur. class inherited from module must be
355 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
357 class Module : public Extensible
360 InspIRCd* ServerInstance;
363 /** Default constructor
364 * Creates a module class.
365 * @param Me An instance of the InspIRCd class which will be saved into ServerInstance for your use
366 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
368 Module(InspIRCd* Me);
370 /** Default destructor
371 * destroys a module class
375 /** Returns the version number of a Module.
376 * The method should return a Version object with its version information assigned via
379 virtual Version GetVersion();
381 /** The Implements function specifies which methods a module should receive events for.
382 * The char* parameter passed to this function contains a set of true or false values
383 * (1 or 0) which indicate wether each function is implemented. You must use the Iimplementation
384 * enum (documented elsewhere on this page) to mark functions as active. For example, to
385 * receive events for OnUserJoin():
387 * Implements[I_OnUserJoin] = 1;
389 * @param The implement list
391 virtual void Implements(char* Implements);
393 /** Used to set the 'priority' of a module (e.g. when it is called in relation to other modules.
394 * Some modules prefer to be called before other modules, due to their design. For example, a
395 * module which is expected to operate on complete information would expect to be placed last, so
396 * that any other modules which wish to adjust that information would execute before it, to be sure
397 * its information is correct. You can change your module's priority by returning one of:
399 * PRIORITY_FIRST - To place your module first in the list
401 * PRIORITY_LAST - To place your module last in the list
403 * PRIORITY_DONTCARE - To leave your module as it is (this is the default value, if you do not implement this function)
405 * The result of InspIRCd::PriorityBefore() - To move your module before another named module
407 * The result of InspIRCd::PriorityLast() - To move your module after another named module
409 * For a good working example of this method call, please see src/modules/m_spanningtree.cpp
410 * and src/modules/m_hostchange.so which make use of it. It is highly recommended that unless
411 * your module has a real need to reorder its priority, it should not implement this function,
412 * as many modules changing their priorities can make the system redundant.
414 virtual Priority Prioritize();
416 /** Called when a user connects.
417 * The details of the connecting user are available to you in the parameter userrec *user
418 * @param user The user who is connecting
420 virtual void OnUserConnect(userrec* user);
422 /** Called when a user quits.
423 * The details of the exiting user are available to you in the parameter userrec *user
424 * This event is only called when the user is fully registered when they quit. To catch
425 * raw disconnections, use the OnUserDisconnect method.
426 * @param user The user who is quitting
427 * @param message The user's quit message
429 virtual void OnUserQuit(userrec* user, const std::string &message);
431 /** Called whenever a user's socket is closed.
432 * The details of the exiting user are available to you in the parameter userrec *user
433 * This event is called for all users, registered or not, as a cleanup method for modules
434 * which might assign resources to user, such as dns lookups, objects and sockets.
435 * @param user The user who is disconnecting
437 virtual void OnUserDisconnect(userrec* user);
439 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
440 * @param chan The channel being deleted
442 virtual void OnChannelDelete(chanrec* chan);
444 /** Called when a user joins a channel.
445 * The details of the joining user are available to you in the parameter userrec *user,
446 * and the details of the channel they have joined is available in the variable chanrec *channel
447 * @param user The user who is joining
448 * @param channel The channel being joined
450 virtual void OnUserJoin(userrec* user, chanrec* channel);
452 /** Called after a user joins a channel
453 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
455 * @param user The user who is joining
456 * @param channel The channel being joined
458 virtual void OnPostJoin(userrec* user, chanrec* channel);
460 /** Called when a user parts a channel.
461 * The details of the leaving user are available to you in the parameter userrec *user,
462 * and the details of the channel they have left is available in the variable chanrec *channel
463 * @param user The user who is parting
464 * @param channel The channel being parted
465 * @param partmessage The part message, or an empty string
467 virtual void OnUserPart(userrec* user, chanrec* channel, const std::string &partmessage);
469 /** Called on rehash.
470 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
471 * system. You should use it to reload any files so that your module keeps in step with the
472 * rest of the application. If a parameter is given, the core has done nothing. The module
473 * receiving the event can decide if this parameter has any relevence to it.
474 * @param parameter The (optional) parameter given to REHASH from the user.
476 virtual void OnRehash(const std::string ¶meter);
478 /** Called when a raw command is transmitted or received.
479 * This method is the lowest level of handler available to a module. It will be called with raw
480 * data which is passing through a connected socket. If you wish, you may munge this data by changing
481 * the string parameter "raw". If you do this, after your function exits it will immediately be
482 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
483 * inbound is set to true) the value of user will be the userrec of the connection sending the
484 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
485 * @param raw The raw string in RFC1459 format
486 * @param inbound A flag to indicate wether the data is coming into the daemon or going out to the user
487 * @param user The user record sending the text, when inbound == true.
489 virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
491 /** Called whenever a user is about to join a channel, before any processing is done.
492 * Returning a value of 1 from this function stops the process immediately, causing no
493 * output to be sent to the user by the core. If you do this you must produce your own numerics,
494 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
495 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
499 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
500 * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
501 * processing on the actual channel record at this point, however the channel NAME will still be passed in
502 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
503 * @param user The user joining the channel
504 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
505 * @param cname The channel name being joined. For new channels this is valid where chan is not.
506 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "@".
507 * You may alter this string to alter the user's modes on the channel.
508 * @return 1 To prevent the join, 0 to allow it.
510 virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname, std::string &privs);
512 /** Called whenever a user is about to be kicked.
513 * Returning a value of 1 from this function stops the process immediately, causing no
514 * output to be sent to the user by the core. If you do this you must produce your own numerics,
516 * @param source The user issuing the kick
517 * @param user The user being kicked
518 * @param chan The channel the user is being kicked from
519 * @param reason The kick reason
520 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
522 virtual int OnUserPreKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason);
524 /** Called whenever a user is kicked.
525 * If this method is called, the kick is already underway and cannot be prevented, so
526 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
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
532 virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason);
534 /** Called whenever a user opers locally.
535 * The userrec will contain the oper mode 'o' as this function is called after any modifications
536 * are made to the user's structure by the core.
537 * @param user The user who is opering up
538 * @param opertype The opers type name
540 virtual void OnOper(userrec* user, const std::string &opertype);
542 /** Called after a user opers locally.
543 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
544 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
545 * out the OPERTYPE, etc.
546 * @param user The user who is opering up
547 * @param opertype The opers type name
549 virtual void OnPostOper(userrec* user, const std::string &opertype);
551 /** Called whenever a user types /INFO.
552 * The userrec will contain the information of the user who typed the command. Modules may use this
553 * method to output their own credits in /INFO (which is the ircd's version of an about box).
554 * It is purposefully not possible to modify any info that has already been output, or halt the list.
555 * You must write a 371 numeric to the user, containing your info in the following format:
557 * <nick> :information here
559 * @param user The user issuing /INFO
561 virtual void OnInfo(userrec* user);
563 /** Called whenever a /WHOIS is performed on a local user.
564 * The source parameter contains the details of the user who issued the WHOIS command, and
565 * the dest parameter contains the information of the user they are whoising.
566 * @param source The user issuing the WHOIS command
567 * @param dest The user who is being WHOISed
569 virtual void OnWhois(userrec* source, userrec* dest);
571 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
572 * Returning 1 from this function stops the process immediately, causing no
573 * output to be sent to the user by the core. If you do this you must produce your own numerics,
574 * notices etc. This is useful for modules which may want to filter invites to channels.
575 * @param source The user who is issuing the INVITE
576 * @param dest The user being invited
577 * @param channel The channel the user is being invited to
578 * @return 1 to deny the invite, 0 to allow
580 virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel);
582 /** Called after a user has been successfully invited to a channel.
583 * You cannot prevent the invite from occuring using this function, to do that,
584 * use OnUserPreInvite instead.
585 * @param source The user who is issuing the INVITE
586 * @param dest The user being invited
587 * @param channel The channel the user is being invited to
589 virtual void OnUserInvite(userrec* source,userrec* dest,chanrec* channel);
591 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
592 * Returning any nonzero value from this function stops the process immediately, causing no
593 * output to be sent to the user by the core. If you do this you must produce your own numerics,
594 * notices etc. This is useful for modules which may want to filter or redirect messages.
595 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
596 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
597 * of where the message is destined to be sent.
598 * @param user The user sending the message
599 * @param dest The target of the message (chanrec* or userrec*)
600 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
601 * @param text Changeable text being sent by the user
602 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
603 * @return 1 to deny the NOTICE, 0 to allow it
605 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text,char status);
607 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
608 * Returning any nonzero value from this function stops the process immediately, causing no
609 * output to be sent to the user by the core. If you do this you must produce your own numerics,
610 * notices etc. This is useful for modules which may want to filter or redirect messages.
611 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
612 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
613 * of where the message is destined to be sent.
614 * You may alter the message text as you wish before relinquishing control to the next module
615 * in the chain, and if no other modules block the text this altered form of the text will be sent out
616 * to the user and possibly to other servers.
617 * @param user The user sending the message
618 * @param dest The target of the message (chanrec* or userrec*)
619 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
620 * @param text Changeable text being sent by the user
621 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
622 * @return 1 to deny the NOTICE, 0 to allow it
624 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text,char status);
626 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
627 * Please note that although you can see remote nickchanges through this function, you should
628 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
629 * check user->server before taking any action (including returning nonzero from the method).
630 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
631 * module to generate some meaninful output.
632 * @param user The username changing their nick
633 * @param newnick Their new nickname
634 * @return 1 to deny the change, 0 to allow
636 virtual int OnUserPreNick(userrec* user, const std::string &newnick);
638 /** Called after any PRIVMSG sent from a user.
639 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
640 * if target_type is TYPE_CHANNEL.
641 * @param user The user sending the message
642 * @param dest The target of the message
643 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
644 * @param text the text being sent by the user
645 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
647 virtual void OnUserMessage(userrec* user, void* dest, int target_type, const std::string &text, char status);
649 /** Called after any NOTICE sent from a user.
650 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
651 * if target_type is TYPE_CHANNEL.
652 * @param user The user sending the message
653 * @param dest The target of the message
654 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
655 * @param text the text being sent by the user
656 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
658 virtual void OnUserNotice(userrec* user, void* dest, int target_type, const std::string &text, char status);
660 /** Called after every MODE command sent from a user
661 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
662 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
663 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
664 * @param user The user sending the MODEs
665 * @param dest The target of the modes (userrec* or chanrec*)
666 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
667 * @param text The actual modes and their parameters if any
669 virtual void OnMode(userrec* user, void* dest, int target_type, const std::string &text);
671 /** Allows modules to alter or create server descriptions
672 * Whenever a module requires a server description, for example for display in
673 * WHOIS, this function is called in all modules. You may change or define the
674 * description given in std::string &description. If you do, this description
675 * will be shown in the WHOIS fields.
676 * @param servername The servername being searched for
677 * @param description Alterable server description for this server
679 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
681 /** Allows modules to synchronize data which relates to users during a netburst.
682 * When this function is called, it will be called from the module which implements
683 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
684 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
685 * (see below). This function will be called for every user visible on your side
686 * of the burst, allowing you to for example set modes, etc. Do not use this call to
687 * synchronize data which you have stored using class Extensible -- There is a specialist
688 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
689 * @param user The user being syncronized
690 * @param proto A pointer to the module handling network protocol
691 * @param opaque An opaque pointer set by the protocol module, should not be modified!
693 virtual void OnSyncUser(userrec* user, Module* proto, void* opaque);
695 /** Allows modules to synchronize data which relates to channels during a netburst.
696 * When this function is called, it will be called from the module which implements
697 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
698 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
699 * (see below). This function will be called for every user visible on your side
700 * of the burst, allowing you to for example set modes, etc. Do not use this call to
701 * synchronize data which you have stored using class Extensible -- There is a specialist
702 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
704 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
706 * @param chan The channel being syncronized
707 * @param proto A pointer to the module handling network protocol
708 * @param opaque An opaque pointer set by the protocol module, should not be modified!
710 virtual void OnSyncChannel(chanrec* chan, Module* proto, void* opaque);
712 /* Allows modules to syncronize metadata related to channels over the network during a netburst.
713 * Whenever the linking module wants to send out data, but doesnt know what the data
714 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
715 * this method is called.You should use the ProtoSendMetaData function after you've
716 * correctly decided how the data should be represented, to send the metadata on its way if it belongs
717 * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
718 * @param chan The channel whos metadata is being syncronized
719 * @param proto A pointer to the module handling network protocol
720 * @param opaque An opaque pointer set by the protocol module, should not be modified!
721 * @param extname The extensions name which is being searched for
723 virtual void OnSyncChannelMetaData(chanrec* chan, Module* proto,void* opaque, const std::string &extname);
725 /* Allows modules to syncronize metadata related to users over the network during a netburst.
726 * Whenever the linking module wants to send out data, but doesnt know what the data
727 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
728 * this method is called. You should use the ProtoSendMetaData function after you've
729 * correctly decided how the data should be represented, to send the metadata on its way if
730 * if it belongs to your module.
731 * @param user The user whos metadata is being syncronized
732 * @param proto A pointer to the module handling network protocol
733 * @param opaque An opaque pointer set by the protocol module, should not be modified!
734 * @param extname The extensions name which is being searched for
736 virtual void OnSyncUserMetaData(userrec* user, Module* proto,void* opaque, const std::string &extname);
738 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
739 * Whenever the linking module wants to send out data, but doesnt know what the data
740 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
741 * this method is called. You should use the ProtoSendMetaData function after you've
742 * correctly decided how the data should be represented, to send the metadata on its way if
743 * if it belongs to your module.
744 * @param proto A pointer to the module handling network protocol
745 * @param opaque An opaque pointer set by the protocol module, should not be modified!
747 virtual void OnSyncOtherMetaData(Module* proto, void* opaque);
749 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
750 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
751 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
752 * @param target The chanrec* or userrec* that data should be added to
753 * @param extname The extension name which is being sent
754 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
756 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata);
758 /** Implemented by modules which provide the ability to link servers.
759 * These modules will implement this method, which allows transparent sending of servermodes
760 * down the network link as a broadcast, without a module calling it having to know the format
761 * of the MODE command before the actual mode string.
763 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
764 * of how to use this function.
766 * @param opaque An opaque pointer set by the protocol module, should not be modified!
767 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
768 * @param target The chanrec* or userrec* that modes should be sent for
769 * @param modeline The modes and parameters to be sent
771 virtual void ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline);
773 /** Implemented by modules which provide the ability to link servers.
774 * These modules will implement this method, which allows metadata (extra data added to
775 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
776 * to other servers on a netburst and decoded at the other end by the same module on a
779 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
780 * 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 metadata should be sent for
784 * @param extname The extension name to send metadata for
785 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
787 virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata);
789 /** Called after every WALLOPS command.
790 * @param user The user sending the WALLOPS
791 * @param text The content of the WALLOPS message
793 virtual void OnWallops(userrec* user, const std::string &text);
795 /** Called whenever a user's hostname is changed.
796 * This event triggers after the host has been set.
797 * @param user The user whos host is being changed
798 * @param newhost The new hostname being set
800 virtual void OnChangeHost(userrec* user, const std::string &newhost);
802 /** Called whenever a user's GECOS (realname) is changed.
803 * This event triggers after the name has been set.
804 * @param user The user who's GECOS is being changed
805 * @param gecos The new GECOS being set on the user
807 virtual void OnChangeName(userrec* user, const std::string &gecos);
809 /** Called whenever a gline is added by a local user.
810 * This method is triggered after the line is added.
811 * @param duration The duration of the line in seconds
812 * @param source The sender of the line
813 * @param reason The reason text to be displayed
814 * @param hostmask The hostmask to add
816 virtual void OnAddGLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
818 /** Called whenever a zline is added by a local user.
819 * This method is triggered after the line is added.
820 * @param duration The duration of the line in seconds
821 * @param source The sender of the line
822 * @param reason The reason text to be displayed
823 * @param ipmask The hostmask to add
825 virtual void OnAddZLine(long duration, userrec* source, const std::string &reason, const std::string &ipmask);
827 /** Called whenever a kline is added by a local user.
828 * This method is triggered after the line is added.
829 * @param duration The duration of the line in seconds
830 * @param source The sender of the line
831 * @param reason The reason text to be displayed
832 * @param hostmask The hostmask to add
834 virtual void OnAddKLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
836 /** Called whenever a qline is added by a local user.
837 * This method is triggered after the line is added.
838 * @param duration The duration of the line in seconds
839 * @param source The sender of the line
840 * @param reason The reason text to be displayed
841 * @param nickmask The hostmask to add
843 virtual void OnAddQLine(long duration, userrec* source, const std::string &reason, const std::string &nickmask);
845 /** Called whenever a eline is added by a local user.
846 * This method is triggered after the line is added.
847 * @param duration The duration of the line in seconds
848 * @param source The sender of the line
849 * @param reason The reason text to be displayed
850 * @param hostmask The hostmask to add
852 virtual void OnAddELine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
854 /** Called whenever a gline is deleted.
855 * This method is triggered after the line is deleted.
856 * @param source The user removing the line
857 * @param hostmask The hostmask to delete
859 virtual void OnDelGLine(userrec* source, const std::string &hostmask);
861 /** Called whenever a zline is deleted.
862 * This method is triggered after the line is deleted.
863 * @param source The user removing the line
864 * @param hostmask The hostmask to delete
866 virtual void OnDelZLine(userrec* source, const std::string &ipmask);
868 /** Called whenever a kline is deleted.
869 * This method is triggered after the line is deleted.
870 * @param source The user removing the line
871 * @param hostmask The hostmask to delete
873 virtual void OnDelKLine(userrec* source, const std::string &hostmask);
875 /** Called whenever a qline is deleted.
876 * This method is triggered after the line is deleted.
877 * @param source The user removing the line
878 * @param hostmask The hostmask to delete
880 virtual void OnDelQLine(userrec* source, const std::string &nickmask);
882 /** Called whenever a eline is deleted.
883 * This method is triggered after the line is deleted.
884 * @param source The user removing the line
885 * @param hostmask The hostmask to delete
887 virtual void OnDelELine(userrec* source, const std::string &hostmask);
889 /** Called before your module is unloaded to clean up Extensibles.
890 * This method is called once for every user and channel on the network,
891 * so that when your module unloads it may clear up any remaining data
892 * in the form of Extensibles added using Extensible::Extend().
893 * If the target_type variable is TYPE_USER, then void* item refers to
894 * a userrec*, otherwise it refers to a chanrec*.
895 * @param target_type The type of item being cleaned
896 * @param item A pointer to the item's class
898 virtual void OnCleanup(int target_type, void* item);
900 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
901 * have been applied. Please note that although you can see remote nickchanges through this function, you should
902 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
903 * check user->server before taking any action (including returning nonzero from the method).
904 * Because this method is called after the nickchange is taken place, no return values are possible
905 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
906 * @param user The user changing their nick
907 * @param oldnick The old nickname of the user before the nickchange
909 virtual void OnUserPostNick(userrec* user, const std::string &oldnick);
911 /** Called before an action which requires a channel privilage check.
912 * This function is called before many functions which check a users status on a channel, for example
913 * before opping a user, deopping a user, kicking a user, etc.
914 * There are several values for access_type which indicate for what reason access is being checked.
916 * AC_KICK (0) - A user is being kicked<br>
917 * AC_DEOP (1) - a user is being deopped<br>
918 * AC_OP (2) - a user is being opped<br>
919 * AC_VOICE (3) - a user is being voiced<br>
920 * AC_DEVOICE (4) - a user is being devoiced<br>
921 * AC_HALFOP (5) - a user is being halfopped<br>
922 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
923 * AC_INVITE () - a user is being invited<br>
924 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
925 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
926 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
927 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
928 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
929 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
930 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
931 * @param source The source of the access check
932 * @param dest The destination of the access check
933 * @param channel The channel which is being checked
934 * @param access_type See above
936 virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
938 /** Called when a 005 numeric is about to be output.
939 * The module should modify the 005 numeric if needed to indicate its features.
940 * @param output The 005 string to be modified if neccessary.
942 virtual void On005Numeric(std::string &output);
944 /** Called when a client is disconnected by KILL.
945 * If a client is killed by a server, e.g. a nickname collision or protocol error,
947 * Return 1 from this function to prevent the kill, and 0 from this function to allow
948 * it as normal. If you prevent the kill no output will be sent to the client, it is
949 * down to your module to generate this information.
950 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
951 * If you do so youre risking race conditions, desyncs and worse!
952 * @param source The user sending the KILL
953 * @param dest The user being killed
954 * @param reason The kill reason
955 * @return 1 to prevent the kill, 0 to allow
957 virtual int OnKill(userrec* source, userrec* dest, const std::string &reason);
959 /** Called when an oper wants to disconnect a remote user via KILL
960 * @param source The user sending the KILL
961 * @param dest The user being killed
962 * @param reason The kill reason
964 virtual void OnRemoteKill(userrec* source, userrec* dest, const std::string &reason);
966 /** Called whenever a module is loaded.
967 * mod will contain a pointer to the module, and string will contain its name,
968 * for example m_widgets.so. This function is primary for dependency checking,
969 * your module may decide to enable some extra features if it sees that you have
970 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
971 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
972 * but instead operate under reduced functionality, unless the dependency is
973 * absolutely neccessary (e.g. a module that extends the features of another
975 * @param mod A pointer to the new module
976 * @param name The new module's filename
978 virtual void OnLoadModule(Module* mod,const std::string &name);
980 /** Called whenever a module is unloaded.
981 * mod will contain a pointer to the module, and string will contain its name,
982 * for example m_widgets.so. This function is primary for dependency checking,
983 * your module may decide to enable some extra features if it sees that you have
984 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
985 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
986 * but instead operate under reduced functionality, unless the dependency is
987 * absolutely neccessary (e.g. a module that extends the features of another
989 * @param mod Pointer to the module being unloaded (still valid)
990 * @param name The filename of the module being unloaded
992 virtual void OnUnloadModule(Module* mod,const std::string &name);
994 /** Called once every five seconds for background processing.
995 * This timer can be used to control timed features. Its period is not accurate
996 * enough to be used as a clock, but it is gauranteed to be called at least once in
997 * any five second period, directly from the main loop of the server.
998 * @param curtime The current timer derived from time(2)
1000 virtual void OnBackgroundTimer(time_t curtime);
1002 /** Called whenever any command is about to be executed.
1003 * This event occurs for all registered commands, wether they are registered in the core,
1004 * or another module, and for invalid commands. Invalid commands may only be sent to this
1005 * function when the value of validated is false. By returning 1 from this method you may prevent the
1006 * command being executed. If you do this, no output is created by the core, and it is
1007 * down to your module to produce any output neccessary.
1008 * Note that unless you return 1, you should not destroy any structures (e.g. by using
1009 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
1010 * method returns, it will be passed an invalid pointer to the user object and crash!)
1011 * @param command The command being executed
1012 * @param parameters An array of array of characters containing the parameters for the command
1013 * @param pcnt The nuimber of parameters passed to the command
1014 * @param user the user issuing the command
1015 * @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.
1016 * @param original_line The entire original line as passed to the parser from the user
1017 * @return 1 to block the command, 0 to allow
1019 virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line);
1021 /** Called after any command has been executed.
1022 * This event occurs for all registered commands, wether they are registered in the core,
1023 * or another module, but it will not occur for invalid commands (e.g. ones which do not
1024 * exist within the command table). The result code returned by the command handler is
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 result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
1031 * @param original_line The entire original line as passed to the parser from the user
1033 virtual void OnPostCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, CmdResult result, const std::string &original_line);
1035 /** Called to check if a user who is connecting can now be allowed to register
1036 * If any modules return false for this function, the user is held in the waiting
1037 * state until all modules return true. For example a module which implements ident
1038 * lookups will continue to return false for a user until their ident lookup is completed.
1039 * Note that the registration timeout for a user overrides these checks, if the registration
1040 * timeout is reached, the user is disconnected even if modules report that the user is
1041 * not ready to connect.
1042 * @param user The user to check
1043 * @return true to indicate readiness, false if otherwise
1045 virtual bool OnCheckReady(userrec* user);
1047 /** Called whenever a user is about to register their connection (e.g. before the user
1048 * is sent the MOTD etc). Modules can use this method if they are performing a function
1049 * which must be done before the actual connection is completed (e.g. ident lookups,
1050 * dnsbl lookups, etc).
1051 * Note that you should NOT delete the user record here by causing a disconnection!
1052 * Use OnUserConnect for that instead.
1053 * @param user The user registering
1055 virtual void OnUserRegister(userrec* user);
1057 /** Called whenever a mode character is processed.
1058 * Return 1 from this function to block the mode character from being processed entirely,
1059 * so that you may perform your own code instead. Note that this method allows you to override
1060 * modes defined by other modes, but this is NOT RECOMMENDED!
1061 * @param user The user who is sending the mode
1062 * @param chan The channel the mode is being sent to
1063 * @param mode The mode character being set
1064 * @param param The parameter for the mode or an empty string
1065 * @param adding true of the mode is being added, false if it is being removed
1066 * @param pcnt The parameter count for the mode (0 or 1)
1067 * @return 1 to deny the mode, 0 to allow
1069 virtual int OnRawMode(userrec* user, chanrec* chan, char mode, const std::string ¶m, bool adding, int pcnt);
1071 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1072 * This method will always be called for each join, wether or not the channel is actually +i, and
1073 * determines the outcome of an if statement around the whole section of invite checking code.
1074 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1075 * @param user The user joining the channel
1076 * @param chan The channel being joined
1077 * @return 1 to explicitly allow the join, 0 to proceed as normal
1079 virtual int OnCheckInvite(userrec* user, chanrec* chan);
1081 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1082 * This method will always be called for each join, wether or not the channel is actually +k, and
1083 * determines the outcome of an if statement around the whole section of key checking code.
1084 * if the user specified no key, the keygiven string will be a valid but empty value.
1085 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1086 * @param user The user joining the channel
1087 * @param chan The channel being joined
1088 * @return 1 to explicitly allow the join, 0 to proceed as normal
1090 virtual int OnCheckKey(userrec* user, chanrec* chan, const std::string &keygiven);
1092 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1093 * This method will always be called for each join, wether or not the channel is actually +l, and
1094 * determines the outcome of an if statement around the whole section of channel limit checking code.
1095 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1096 * @param user The user joining the channel
1097 * @param chan The channel being joined
1098 * @return 1 to explicitly allow the join, 0 to proceed as normal
1100 virtual int OnCheckLimit(userrec* user, chanrec* chan);
1102 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
1103 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
1104 * determines the outcome of an if statement around the whole section of ban checking code.
1105 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1106 * @param user The user joining the channel
1107 * @param chan The channel being joined
1108 * @return 1 to explicitly allow the join, 0 to proceed as normal
1110 virtual int OnCheckBan(userrec* user, chanrec* chan);
1112 /** Called on all /STATS commands
1113 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1114 * @param symbol the symbol provided to /STATS
1115 * @param user the user issuing the /STATS command
1116 * @param results A string_list to append results into. You should put all your results
1117 * into this string_list, rather than displaying them directly, so that your handler will
1118 * work when remote STATS queries are received.
1119 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1121 virtual int OnStats(char symbol, userrec* user, string_list &results);
1123 /** Called whenever a change of a local users displayed host is attempted.
1124 * Return 1 to deny the host change, or 0 to allow it.
1125 * @param user The user whos host will be changed
1126 * @param newhost The new hostname
1127 * @return 1 to deny the host change, 0 to allow
1129 virtual int OnChangeLocalUserHost(userrec* user, const std::string &newhost);
1131 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1132 * return 1 to deny the name change, or 0 to allow it.
1133 * @param user The user whos GECOS will be changed
1134 * @param newhost The new GECOS
1135 * @return 1 to deny the GECOS change, 0 to allow
1137 virtual int OnChangeLocalUserGECOS(userrec* user, const std::string &newhost);
1139 /** Called whenever a topic is changed by a local user.
1140 * Return 1 to deny the topic change, or 0 to allow it.
1141 * @param user The user changing the topic
1142 * @param chan The channels who's topic is being changed
1143 * @param topic The actual topic text
1144 * @param 1 to block the topic change, 0 to allow
1146 virtual int OnLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic);
1148 /** Called whenever a local topic has been changed.
1149 * To block topic changes you must use OnLocalTopicChange instead.
1150 * @param user The user changing the topic
1151 * @param chan The channels who's topic is being changed
1152 * @param topic The actual topic text
1154 virtual void OnPostLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic);
1156 /** Called whenever an Event class is sent to all module by another module.
1157 * Please see the documentation of Event::Send() for further information. The Event sent can
1158 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1159 * before doing anything to the event data, and you should *not* change the event data in any way!
1160 * @param event The Event class being received
1162 virtual void OnEvent(Event* event);
1164 /** Called whenever a Request class is sent to your module by another module.
1165 * Please see the documentation of Request::Send() for further information. The Request sent
1166 * can always be assumed to be non-NULL, you should not change the request object or its data.
1167 * Your method may return arbitary data in the char* result which the requesting module
1168 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1169 * @param request The Request class being received
1171 virtual char* OnRequest(Request* request);
1173 /** Called whenever an oper password is to be compared to what a user has input.
1174 * The password field (from the config file) is in 'password' and is to be compared against
1175 * 'input'. This method allows for encryption of oper passwords and much more besides.
1176 * You should return a nonzero value if you want to allow the comparison or zero if you wish
1178 * @param password The oper's password
1179 * @param input The password entered
1180 * @return 1 to match the passwords, 0 to do nothing
1182 virtual int OnOperCompare(const std::string &password, const std::string &input);
1184 /** Called whenever a user is given usermode +o, anywhere on the network.
1185 * You cannot override this and prevent it from happening as it is already happened and
1186 * such a task must be performed by another server. You can however bounce modes by sending
1187 * servermodes out to reverse mode changes.
1188 * @param user The user who is opering
1190 virtual void OnGlobalOper(userrec* user);
1192 /** Called after a user has fully connected and all modules have executed OnUserConnect
1193 * This event is informational only. You should not change any user information in this
1194 * event. To do so, use the OnUserConnect method to change the state of local users.
1195 * This is called for both local and remote users.
1196 * @param user The user who is connecting
1198 virtual void OnPostConnect(userrec* user);
1200 /** Called whenever a ban is added to a channel's list.
1201 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1202 * @param source The user adding the ban
1203 * @param channel The channel the ban is being added to
1204 * @param banmask The ban mask being added
1205 * @return 1 to block the ban, 0 to continue as normal
1207 virtual int OnAddBan(userrec* source, chanrec* channel,const std::string &banmask);
1209 /** Called whenever a ban is removed from a channel's list.
1210 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1211 * @param source The user deleting the ban
1212 * @param channel The channel the ban is being deleted from
1213 * @param banmask The ban mask being deleted
1214 * @return 1 to block the unban, 0 to continue as normal
1216 virtual int OnDelBan(userrec* source, chanrec* channel,const std::string &banmask);
1218 /** Called immediately after any connection is accepted. This is intended for raw socket
1219 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1220 * no information relating to a user record as the connection has not been assigned yet.
1221 * There are no return values from this call as all modules get an opportunity if required to
1222 * process the connection.
1223 * @param fd The file descriptor returned from accept()
1224 * @param ip The IP address of the connecting user
1225 * @param localport The local port number the user connected to
1227 virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport);
1229 /** Called immediately before any write() operation on a user's socket in the core. Because
1230 * this event is a low level event no user information is associated with it. It is intended
1231 * for use by modules which may wrap connections within another API such as SSL for example.
1232 * return a non-zero result if you have handled the write operation, in which case the core
1233 * will not call write().
1234 * @param fd The file descriptor of the socket
1235 * @param buffer A char* buffer being written
1236 * @param Number of characters to write
1237 * @return Number of characters actually written or 0 if you didn't handle the operation
1239 virtual int OnRawSocketWrite(int fd, const char* buffer, int count);
1241 /** Called immediately before any socket is closed. When this event is called, shutdown()
1242 * has not yet been called on the socket.
1243 * @param fd The file descriptor of the socket prior to close()
1245 virtual void OnRawSocketClose(int fd);
1247 /** Called immediately before any read() operation on a client socket in the core.
1248 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1249 * when this event occurs.
1250 * Your event should return 1 if it has handled the reading itself, which prevents the core
1251 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1252 * the value of count. The value of readresult must be identical to an actual result that might
1253 * be returned from the read() system call, for example, number of bytes read upon success,
1254 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1255 * you MUST set readresult.
1256 * @param fd The file descriptor of the socket
1257 * @param buffer A char* buffer being read to
1258 * @param count The size of the buffer
1259 * @param readresult The amount of characters read, or 0
1260 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1262 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1264 /** Called whenever a user sets away.
1265 * This method has no parameter for the away message, as it is available in the
1266 * user record as userrec::awaymsg.
1268 virtual void OnSetAway(userrec* user);
1270 /** Called when a user cancels their away state.
1272 virtual void OnCancelAway(userrec* user);
1274 /** Called whenever a NAMES list is requested.
1275 * You can produce the nameslist yourself, overriding the current list,
1276 * and if you do you must return 1. If you do not handle the names list,
1279 virtual int OnUserList(userrec* user, chanrec* Ptr);
1283 #define CONF_NOT_A_NUMBER 0x000010
1284 #define CONF_NOT_UNSIGNED 0x000080
1285 #define CONF_VALUE_NOT_FOUND 0x000100
1286 #define CONF_FILE_NOT_FOUND 0x000200
1289 /** Allows reading of values from configuration files
1290 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1291 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1292 * Constructing the class using one parameter allows you to specify a path to your own configuration
1293 * file, otherwise, inspircd.conf is read.
1295 class ConfigReader : public classbase
1298 InspIRCd* ServerInstance;
1299 /** The contents of the configuration file
1300 * This protected member should never be accessed by a module (and cannot be accessed unless the
1301 * core is changed). It will contain a pointer to the configuration file data with unneeded data
1302 * (such as comments) stripped from it.
1304 ConfigDataHash* data;
1305 std::ostringstream* errorlog;;
1306 /** Used to store errors
1308 bool privatehash; // If we're using our own config data hash or not.
1313 /** Default constructor.
1314 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1315 * as specified when running ./configure.
1317 ConfigReader(InspIRCd* Instance);
1318 /** Overloaded constructor.
1319 * This constructor initialises the ConfigReader class to read a user-specified config file
1321 ConfigReader(InspIRCd* Instance, const std::string &filename);
1322 /** Default destructor.
1323 * This method destroys the ConfigReader class.
1326 /** Retrieves a value from the config file.
1327 * This method retrieves a value from the config file. Where multiple copies of the tag
1328 * exist in the config file, index indicates which of the values to retrieve.
1330 std::string ReadValue(const std::string &tag, const std::string &name, int index);
1331 /** Retrieves a boolean value from the config file.
1332 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1333 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1334 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1336 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1337 /** Retrieves an integer value from the config file.
1338 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1339 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1340 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1341 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1342 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1343 * will return CONF_NOT_UNSIGNED
1345 long ReadInteger(const std::string &tag, const std::string &name, int index, bool needs_unsigned);
1346 /** Returns the last error to occur.
1347 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1348 * A call to GetError() resets the error flag back to 0.
1351 /** Counts the number of times a given tag appears in the config file.
1352 * This method counts the number of times a tag appears in a config file, for use where
1353 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1354 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1355 * multiple instance tag.
1357 int Enumerate(const std::string &tag);
1358 /** Returns true if a config file is valid.
1359 * This method is partially implemented and will only return false if the config
1360 * file does not exist or could not be opened.
1363 /** Dumps the list of errors in a config file to an output location. If bail is true,
1364 * then the program will abort. If bail is false and user points to a valid user
1365 * record, the error report will be spooled to the given user by means of NOTICE.
1366 * if bool is false AND user is false, the error report will be spooled to all opers
1367 * by means of a NOTICE to all opers.
1369 void DumpErrors(bool bail,userrec* user);
1371 /** Returns the number of items within a tag.
1372 * For example if the tag was <test tag="blah" data="foo"> then this
1373 * function would return 2. Spaces and newlines both qualify as valid seperators
1376 int EnumerateValues(const std::string &tag, int index);
1381 /** Caches a text file into memory and can be used to retrieve lines from it.
1382 * This class contains methods for read-only manipulation of a text file in memory.
1383 * Either use the constructor type with one parameter to load a file into memory
1384 * at construction, or use the LoadFile method to load a file.
1386 class FileReader : public classbase
1388 InspIRCd* ServerInstance;
1389 /** The file contents
1393 unsigned long contentsize;
1398 /** Default constructor.
1399 * This method does not load any file into memory, you must use the LoadFile method
1400 * after constructing the class this way.
1402 FileReader(InspIRCd* Instance);
1404 /** Secondary constructor.
1405 * This method initialises the class with a file loaded into it ready for GetLine and
1406 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1409 FileReader(InspIRCd* Instance, const std::string &filename);
1411 /** Default destructor.
1412 * This deletes the memory allocated to the file.
1416 /** Used to load a file.
1417 * This method loads a file into the class ready for GetLine and
1418 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1421 void LoadFile(const std::string &filename);
1423 /** Returns the whole content of the file as std::string
1425 std::string Contents();
1427 /** Returns the entire size of the file as std::string
1429 unsigned long ContentSize();
1431 /** Returns true if the file exists
1432 * This function will return false if the file could not be opened.
1436 /** Retrieve one line from the file.
1437 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1438 * the index was out of bounds, or the line had no data on it.
1440 std::string GetLine(int x);
1442 /** Returns the size of the file in lines.
1443 * This method returns the number of lines in the read file. If it is 0, no lines have been
1444 * read into memory, either because the file is empty or it does not exist, or cannot be
1445 * opened due to permission problems.
1451 /** Instantiates classes inherited from Module.
1452 * This class creates a class inherited from type Module, using new. This is to allow for modules
1453 * to create many different variants of Module, dependent on architecture, configuration, etc.
1454 * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
1457 class ModuleFactory : public classbase
1460 /** The default constructor does nothing.
1463 /** The default destructor does nothing
1465 virtual ~ModuleFactory() { }
1466 /** Creates a new module.
1467 * Your inherited class of ModuleFactory must return a pointer to your Module class
1468 * using this method.
1470 virtual Module * CreateModule(InspIRCd* Me) = 0;
1473 /** A DLLFactory (designed to load shared objects) containing a ModuleFactory.
1475 typedef DLLFactory<ModuleFactory> ircd_module;
1477 /** A list of loaded Modules
1479 typedef std::vector<Module*> ModuleList;
1481 /** A list of loaded ModuleFactories
1483 typedef std::vector<ircd_module*> FactoryList;