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 * ---------------------------------------------------
23 enum DebugLevels { DEBUG, VERBOSE, DEFAULT, SPARSE, NONE };
25 /** Used with OnExtendedMode() method of modules
27 enum ModeTargetType { MT_CHANNEL, MT_CLIENT, MT_SERVER };
29 /** Used with OnAccessCheck() method of modules
31 enum AccessControlType {
32 ACR_DEFAULT, // Do default action (act as if the module isnt even loaded)
33 ACR_DENY, // deny the action
34 ACR_ALLOW, // allow the action
35 AC_KICK, // a user is being kicked
36 AC_DEOP, // a user is being deopped
37 AC_OP, // a user is being opped
38 AC_VOICE, // a user is being voiced
39 AC_DEVOICE, // a user is being devoiced
40 AC_HALFOP, // a user is being halfopped
41 AC_DEHALFOP, // a user is being dehalfopped
42 AC_INVITE, // a user is being invited
43 AC_GENERAL_MODE // a channel mode is being changed
46 /** Used to define a set of behavior bits for a module
49 VF_STATIC = 1, // module is static, cannot be /unloadmodule'd
50 VF_VENDOR = 2, // module is a vendor module (came in the original tarball, not 3rd party)
51 VF_SERVICEPROVIDER = 4, // module provides a service to other modules (can be a dependency)
52 VF_COMMON = 8 // module needs to be common on all servers in a network to link
60 enum TargetTypeFlags {
71 #include "inspsocket.h"
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 users in a channel
88 typedef std::deque<userrec*> chanuserlist;
92 * This #define allows us to call a method in all
93 * loaded modules in a readable simple way, e.g.:
94 * 'FOREACH_MOD(I_OnXonnwxr,OnConnect(user));'
96 #define FOREACH_MOD(y,x) if (Config->global_implementation[y] > 0) { \
97 for (int _i = 0; _i <= MODCOUNT; _i++) { \
98 if (Config->implement_lists[_i][y]) \
103 catch (ModuleException& modexcept) \
105 log(DEBUG,"Module exception caught: %s",modexcept.GetReason()); \
111 * This define is similar to the one above but returns a result in MOD_RESULT.
112 * The first module to return a nonzero result is the value to be accepted,
113 * and any modules after are ignored.
115 #define FOREACH_RESULT(y,x) { if (Config->global_implementation[y] > 0) { \
117 for (int _i = 0; _i <= MODCOUNT; _i++) { \
118 if (Config->implement_lists[_i][y]) {\
121 int res = modules[_i]->x ; \
127 catch (ModuleException& modexcept) \
129 log(DEBUG,"Module exception cought: %s",modexcept.GetReason()); \
136 #define FD_MAGIC_NUMBER -42
140 #define IS_LOCAL(x) (x->fd > -1)
141 #define IS_REMOTE(x) (x->fd < 0)
142 #define IS_MODULE_CREATED(x) (x->fd == FD_MAGIC_NUMBER)
144 /** Holds a module's Version information
145 * The four members (set by the constructor only) indicate details as to the version number
146 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
148 class Version : public classbase
151 const int Major, Minor, Revision, Build, Flags;
152 Version(int major, int minor, int revision, int build, int flags);
155 /** Holds /ADMIN data
156 * This class contains the admin details of the local server. It is constructed by class Server,
157 * and has three read-only values, Name, Email and Nick that contain the specified values for the
158 * server where the module is running.
160 class Admin : public classbase
163 const std::string Name, Email, Nick;
164 Admin(std::string name, std::string email, std::string nick);
167 // Forward-delacare module for ModuleMessage etc
170 /** The ModuleMessage class is the base class of Request and Event
171 * This class is used to represent a basic data structure which is passed
172 * between modules for safe inter-module communications.
174 class ModuleMessage : public classbase
177 /** This class is pure virtual and must be inherited.
179 virtual char* Send() = 0;
180 virtual ~ModuleMessage() {};
183 /** The Request class is a unicast message directed at a given module.
184 * When this class is properly instantiated it may be sent to a module
185 * using the Send() method, which will call the given module's OnRequest
186 * method with this class as its parameter.
188 class Request : public ModuleMessage
191 /** This member holds a pointer to arbitary data set by the emitter of the message
194 /** This is a pointer to the sender of the message, which can be used to
195 * directly trigger events, or to create a reply.
198 /** The single destination of the Request
202 /** Create a new Request
204 Request(char* anydata, Module* src, Module* dst);
205 /** Fetch the Request data
208 /** Fetch the request source
211 /** Fetch the request destination (should be 'this' in the receiving module)
214 /** Send the Request.
215 * Upon returning the result will be arbitary data returned by the module you
216 * sent the request to. It is up to your module to know what this data is and
217 * how to deal with it.
223 /** The Event class is a unicast message directed at all modules.
224 * When the class is properly instantiated it may be sent to all modules
225 * using the Send() method, which will trigger the OnEvent method in
226 * all modules passing the object as its parameter.
228 class Event : public ModuleMessage
231 /** This member holds a pointer to arbitary data set by the emitter of the message
234 /** This is a pointer to the sender of the message, which can be used to
235 * directly trigger events, or to create a reply.
238 /** The event identifier.
239 * This is arbitary text which should be used to distinguish
240 * one type of event from another.
244 /** Create a new Event
246 Event(char* anydata, Module* src, const std::string &eventid);
247 /** Get the Event data
250 /** Get the event Source
253 /** Get the event ID.
254 * Use this to determine the event type for safe casting of the data
256 std::string GetEventID();
258 * The return result of an Event::Send() will always be NULL as
259 * no replies are expected.
264 /** Holds an extended mode's details.
265 * Used internally by modules.cpp
267 class ExtMode : public classbase
276 ExtMode(char mc, int ty, bool oper, int p_on, int p_off) : modechar(mc), type(ty), needsoper(oper), params_when_on(p_on), params_when_off(p_off), list(false) { };
280 /** This class can be used on its own to represent an exception, or derived to represent a module-specific exception.
281 * When a module whishes to abort, e.g. within a constructor, it should throw an exception using ModuleException or
282 * a class derived from ModuleException. If a module throws an exception during its constructor, the module will not
283 * be loaded. If this happens, the error message returned by ModuleException::GetReason will be displayed to the user
284 * attempting to load the module, or dumped to the console if the ircd is currently loading for the first time.
286 class ModuleException
289 /** Holds the error message to be displayed
293 /** Default constructor, just uses the error mesage 'Module threw an exception'.
295 ModuleException() : err("Module threw an exception") {}
296 /** This constructor can be used to specify an error message before throwing.
298 ModuleException(std::string message) : err(message) {}
299 /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
300 * Actually no, it does nothing. Never mind.
302 virtual ~ModuleException() {};
303 /** Returns the reason for the exception.
304 * The module should probably put something informative here as the user will see this upon failure.
306 virtual const char* GetReason()
312 /** Priority types which can be returned from Module::Prioritize()
314 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
316 /** Implementation-specific flags which may be set in Module::Implements()
318 enum Implementation { I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash, I_OnServerRaw,
319 I_OnExtendedMode, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois, I_OnUserPreInvite,
320 I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick, I_OnUserMessage, I_OnUserNotice, I_OnMode,
321 I_OnGetServerDescription, I_OnSyncUser, I_OnSyncChannel, I_OnSyncChannelMetaData, I_OnSyncUserMetaData,
322 I_OnDecodeMetaData, I_ProtoSendMode, I_ProtoSendMetaData, I_OnWallops, I_OnChangeHost, I_OnChangeName, I_OnAddGLine,
323 I_OnAddZLine, I_OnAddQLine, I_OnAddKLine, I_OnAddELine, I_OnDelGLine, I_OnDelZLine, I_OnDelKLine, I_OnDelELine, I_OnDelQLine,
324 I_OnCleanup, I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule, I_OnUnloadModule,
325 I_OnBackgroundTimer, I_OnSendList, I_OnPreCommand, I_OnCheckReady, I_OnUserRrgister, I_OnRawMode, I_OnCheckInvite,
326 I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnLocalTopicChange,
327 I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnOperCompre, I_OnGlobalOper, I_OnGlobalConnect, I_OnAddBan, I_OnDelBan,
328 I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead, I_OnChangeLocalUserGECOS, I_OnUserRegister,
329 I_OnOperCompare, I_OnChannelDelete, I_OnPostOper, I_OnSyncOtherMetaData, I_OnSetAway, I_OnCancelAway };
331 /** Base class for all InspIRCd modules
332 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
333 * its methods will be called when irc server events occur. class inherited from module must be
334 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
336 class Module : public classbase
340 /** Default constructor
341 * Creates a module class.
342 * @param Me An instance of the Server class which can be saved for future use
343 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
347 /** Default destructor
348 * destroys a module class
352 /** Returns the version number of a Module.
353 * The method should return a Version object with its version information assigned via
356 virtual Version GetVersion();
358 /** The Implements function specifies which methods a module should receive events for.
359 * The char* parameter passed to this function contains a set of true or false values
360 * (1 or 0) which indicate wether each function is implemented. You must use the Iimplementation
361 * enum (documented elsewhere on this page) to mark functions as active. For example, to
362 * receive events for OnUserJoin():
364 * Implements[I_OnUserJoin] = 1;
366 * @param The implement list
368 virtual void Implements(char* Implements);
370 /** Used to set the 'priority' of a module (e.g. when it is called in relation to other modules.
371 * Some modules prefer to be called before other modules, due to their design. For example, a
372 * module which is expected to operate on complete information would expect to be placed last, so
373 * that any other modules which wish to adjust that information would execute before it, to be sure
374 * its information is correct. You can change your module's priority by returning one of:
376 * PRIORITY_FIRST - To place your module first in the list
378 * PRIORITY_LAST - To place your module last in the list
380 * PRIORITY_DONTCARE - To leave your module as it is (this is the default value, if you do not implement this function)
382 * The result of Server::PriorityBefore() - To move your module before another named module
384 * The result of Server::PriorityLast() - To move your module after another named module
386 * For a good working example of this method call, please see src/modules/m_spanningtree.cpp
387 * and src/modules/m_hostchange.so which make use of it. It is highly recommended that unless
388 * your module has a real need to reorder its priority, it should not implement this function,
389 * as many modules changing their priorities can make the system redundant.
391 virtual Priority Prioritize();
393 /** Called when a user connects.
394 * The details of the connecting user are available to you in the parameter userrec *user
395 * @param user The user who is connecting
397 virtual void OnUserConnect(userrec* user);
399 /** Called when a user quits.
400 * The details of the exiting user are available to you in the parameter userrec *user
401 * This event is only called when the user is fully registered when they quit. To catch
402 * raw disconnections, use the OnUserDisconnect method.
403 * @param user The user who is quitting
404 * @param message The user's quit message
406 virtual void OnUserQuit(userrec* user, const std::string &message);
408 /** Called whenever a user's socket is closed.
409 * The details of the exiting user are available to you in the parameter userrec *user
410 * This event is called for all users, registered or not, as a cleanup method for modules
411 * which might assign resources to user, such as dns lookups, objects and sockets.
412 * @param user The user who is disconnecting
414 virtual void OnUserDisconnect(userrec* user);
416 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
417 * @param chan The channel being deleted
419 virtual void OnChannelDelete(chanrec* chan);
421 /** Called when a user joins a channel.
422 * The details of the joining user are available to you in the parameter userrec *user,
423 * and the details of the channel they have joined is available in the variable chanrec *channel
424 * @param user The user who is joining
425 * @param channel The channel being joined
427 virtual void OnUserJoin(userrec* user, chanrec* channel);
429 /** Called when a user parts a channel.
430 * The details of the leaving user are available to you in the parameter userrec *user,
431 * and the details of the channel they have left is available in the variable chanrec *channel
432 * @param user The user who is parting
433 * @param channel The channel being parted
434 * @param partmessage The part message, or an empty string
436 virtual void OnUserPart(userrec* user, chanrec* channel, const std::string &partmessage);
438 /** Called on rehash.
439 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
440 * system. You should use it to reload any files so that your module keeps in step with the
441 * rest of the application. If a parameter is given, the core has done nothing. The module
442 * receiving the event can decide if this parameter has any relevence to it.
443 * @param parameter The (optional) parameter given to REHASH from the user.
445 virtual void OnRehash(const std::string ¶meter);
447 /** Called when a raw command is transmitted or received.
448 * This method is the lowest level of handler available to a module. It will be called with raw
449 * data which is passing through a connected socket. If you wish, you may munge this data by changing
450 * the string parameter "raw". If you do this, after your function exits it will immediately be
451 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
452 * inbound is set to true) the value of user will be the userrec of the connection sending the
453 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
454 * @param raw The raw string in RFC1459 format
455 * @param inbound A flag to indicate wether the data is coming into the daemon or going out to the user
456 * @param user The user record sending the text, when inbound == true.
458 virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
460 /** Called whenever an extended mode is to be processed.
461 * The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being
462 * changed. mode_on is set when the mode is being set, in which case params contains a list of
463 * parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters
464 * may contain the parameters for the mode, dependent on wether they were defined when a mode handler
465 * was set up with Server::AddExtendedMode
466 * If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*.
467 * You must cast this value yourself to make use of it.
468 * @param user The user issuing the mode
469 * @param target The user or channel having the mode set on them
470 * @param modechar The mode character being set
471 * @param type The type of mode (user or channel) being set
472 * @param mode_on True if the mode is being set, false if it is being unset
473 * @param params A list of parameters for any channel mode (currently supports either 0 or 1 parameters)
475 virtual int OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list ¶ms);
477 /** Called whenever a user is about to join a channel, before any processing is done.
478 * Returning a value of 1 from this function stops the process immediately, causing no
479 * output to be sent to the user by the core. If you do this you must produce your own numerics,
480 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
481 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
485 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
486 * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
487 * processing on the actual channel record at this point, however the channel NAME will still be passed in
488 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
489 * @param user The user joining the channel
490 * @param cname The channel name being joined
491 * @return 1 To prevent the join, 0 to allow it.
493 virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname);
495 /** Called whenever a user is about to be kicked.
496 * Returning a value of 1 from this function stops the process immediately, causing no
497 * output to be sent to the user by the core. If you do this you must produce your own numerics,
499 * @param source The user issuing the kick
500 * @param user The user being kicked
501 * @param chan The channel the user is being kicked from
502 * @param reason The kick reason
503 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
505 virtual int OnUserPreKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason);
507 /** Called whenever a user is kicked.
508 * If this method is called, the kick is already underway and cannot be prevented, so
509 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
510 * @param source The user issuing the kick
511 * @param user The user being kicked
512 * @param chan The channel the user is being kicked from
513 * @param reason The kick reason
515 virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason);
517 /** Called whenever a user opers locally.
518 * The userrec will contain the oper mode 'o' as this function is called after any modifications
519 * are made to the user's structure by the core.
520 * @param user The user who is opering up
521 * @param opertype The opers type name
523 virtual void OnOper(userrec* user, const std::string &opertype);
525 /** Called after a user opers locally.
526 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
527 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
528 * out the OPERTYPE, etc.
529 * @param user The user who is opering up
530 * @param opertype The opers type name
532 virtual void OnPostOper(userrec* user, const std::string &opertype);
534 /** Called whenever a user types /INFO.
535 * The userrec will contain the information of the user who typed the command. Modules may use this
536 * method to output their own credits in /INFO (which is the ircd's version of an about box).
537 * It is purposefully not possible to modify any info that has already been output, or halt the list.
538 * You must write a 371 numeric to the user, containing your info in the following format:
540 * <nick> :information here
542 * @param user The user issuing /INFO
544 virtual void OnInfo(userrec* user);
546 /** Called whenever a /WHOIS is performed on a local user.
547 * The source parameter contains the details of the user who issued the WHOIS command, and
548 * the dest parameter contains the information of the user they are whoising.
549 * @param source The user issuing the WHOIS command
550 * @param dest The user who is being WHOISed
552 virtual void OnWhois(userrec* source, userrec* dest);
554 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
555 * Returning 1 from this function stops the process immediately, causing no
556 * output to be sent to the user by the core. If you do this you must produce your own numerics,
557 * notices etc. This is useful for modules which may want to filter invites to channels.
558 * @param source The user who is issuing the INVITE
559 * @param dest The user being invited
560 * @param channel The channel the user is being invited to
561 * @return 1 to deny the invite, 0 to allow
563 virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel);
565 /** Called after a user has been successfully invited to a channel.
566 * You cannot prevent the invite from occuring using this function, to do that,
567 * use OnUserPreInvite instead.
568 * @param source The user who is issuing the INVITE
569 * @param dest The user being invited
570 * @param channel The channel the user is being invited to
572 virtual void OnUserInvite(userrec* source,userrec* dest,chanrec* channel);
574 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
575 * Returning any nonzero value from this function stops the process immediately, causing no
576 * output to be sent to the user by the core. If you do this you must produce your own numerics,
577 * notices etc. This is useful for modules which may want to filter or redirect messages.
578 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
579 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
580 * of where the message is destined to be sent.
581 * @param user The user sending the message
582 * @param dest The target of the message (chanrec* or userrec*)
583 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
584 * @param text Changeable text being sent by the user
585 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
586 * @return 1 to deny the NOTICE, 0 to allow it
588 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text,char status);
590 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
591 * Returning any nonzero value from this function stops the process immediately, causing no
592 * output to be sent to the user by the core. If you do this you must produce your own numerics,
593 * notices etc. This is useful for modules which may want to filter or redirect messages.
594 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
595 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
596 * of where the message is destined to be sent.
597 * You may alter the message text as you wish before relinquishing control to the next module
598 * in the chain, and if no other modules block the text this altered form of the text will be sent out
599 * to the user and possibly to other servers.
600 * @param user The user sending the message
601 * @param dest The target of the message (chanrec* or userrec*)
602 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
603 * @param text Changeable text being sent by the user
604 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
605 * @return 1 to deny the NOTICE, 0 to allow it
607 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text,char status);
609 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
610 * Please note that although you can see remote nickchanges through this function, you should
611 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
612 * check user->server before taking any action (including returning nonzero from the method).
613 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
614 * module to generate some meaninful output.
615 * @param user The username changing their nick
616 * @param newnick Their new nickname
617 * @return 1 to deny the change, 0 to allow
619 virtual int OnUserPreNick(userrec* user, const std::string &newnick);
621 /** Called after any PRIVMSG sent from a user.
622 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
623 * if target_type is TYPE_CHANNEL.
624 * @param user The user sending the message
625 * @param dest The target of the message
626 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
627 * @param text the text being sent by the user
628 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
630 virtual void OnUserMessage(userrec* user, void* dest, int target_type, const std::string &text, char status);
632 /** Called after any NOTICE sent from a user.
633 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
634 * if target_type is TYPE_CHANNEL.
635 * @param user The user sending the message
636 * @param dest The target of the message
637 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
638 * @param text the text being sent by the user
639 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
641 virtual void OnUserNotice(userrec* user, void* dest, int target_type, const std::string &text, char status);
643 /** Called after every MODE command sent from a user
644 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
645 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
646 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
647 * @param user The user sending the MODEs
648 * @param dest The target of the modes (userrec* or chanrec*)
649 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
650 * @param text The actual modes and their parameters if any
652 virtual void OnMode(userrec* user, void* dest, int target_type, const std::string &text);
654 /** Allows modules to alter or create server descriptions
655 * Whenever a module requires a server description, for example for display in
656 * WHOIS, this function is called in all modules. You may change or define the
657 * description given in std::string &description. If you do, this description
658 * will be shown in the WHOIS fields.
659 * @param servername The servername being searched for
660 * @param description Alterable server description for this server
662 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
664 /** Allows modules to synchronize data which relates to users during a netburst.
665 * When this function is called, it will be called from the module which implements
666 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
667 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
668 * (see below). This function will be called for every user visible on your side
669 * of the burst, allowing you to for example set modes, etc. Do not use this call to
670 * synchronize data which you have stored using class Extensible -- There is a specialist
671 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
672 * @param user The user being syncronized
673 * @param proto A pointer to the module handling network protocol
674 * @param opaque An opaque pointer set by the protocol module, should not be modified!
676 virtual void OnSyncUser(userrec* user, Module* proto, void* opaque);
678 /** Allows modules to synchronize data which relates to channels during a netburst.
679 * When this function is called, it will be called from the module which implements
680 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
681 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
682 * (see below). This function will be called for every user visible on your side
683 * of the burst, allowing you to for example set modes, etc. Do not use this call to
684 * synchronize data which you have stored using class Extensible -- There is a specialist
685 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
687 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
689 * @param chan The channel 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 OnSyncChannel(chanrec* chan, Module* proto, void* opaque);
695 /* Allows modules to syncronize metadata related to channels over the network during a netburst.
696 * Whenever the linking module wants to send out data, but doesnt know what the data
697 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
698 * this method is called.You should use the ProtoSendMetaData function after you've
699 * correctly decided how the data should be represented, to send the metadata on its way if it belongs
700 * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
701 * @param chan The channel whos metadata is being syncronized
702 * @param proto A pointer to the module handling network protocol
703 * @param opaque An opaque pointer set by the protocol module, should not be modified!
704 * @param extname The extensions name which is being searched for
706 virtual void OnSyncChannelMetaData(chanrec* chan, Module* proto,void* opaque, const std::string &extname);
708 /* Allows modules to syncronize metadata related to users over the network during a netburst.
709 * Whenever the linking module wants to send out data, but doesnt know what the data
710 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
711 * this method is called. You should use the ProtoSendMetaData function after you've
712 * correctly decided how the data should be represented, to send the metadata on its way if
713 * if it belongs to your module.
714 * @param user The user whos metadata is being syncronized
715 * @param proto A pointer to the module handling network protocol
716 * @param opaque An opaque pointer set by the protocol module, should not be modified!
717 * @param extname The extensions name which is being searched for
719 virtual void OnSyncUserMetaData(userrec* user, Module* proto,void* opaque, const std::string &extname);
721 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
722 * Whenever the linking module wants to send out data, but doesnt know what the data
723 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
724 * this method is called. You should use the ProtoSendMetaData function after you've
725 * correctly decided how the data should be represented, to send the metadata on its way if
726 * if it belongs to your module.
727 * @param proto A pointer to the module handling network protocol
728 * @param opaque An opaque pointer set by the protocol module, should not be modified!
730 virtual void OnSyncOtherMetaData(Module* proto, void* opaque);
732 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
733 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
734 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
735 * @param target The chanrec* or userrec* that data should be added to
736 * @param extname The extension name which is being sent
737 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
739 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata);
741 /** Implemented by modules which provide the ability to link servers.
742 * These modules will implement this method, which allows transparent sending of servermodes
743 * down the network link as a broadcast, without a module calling it having to know the format
744 * of the MODE command before the actual mode string.
746 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
747 * of how to use this function.
749 * @param opaque An opaque pointer set by the protocol module, should not be modified!
750 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
751 * @param target The chanrec* or userrec* that modes should be sent for
752 * @param modeline The modes and parameters to be sent
754 virtual void ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline);
756 /** Implemented by modules which provide the ability to link servers.
757 * These modules will implement this method, which allows metadata (extra data added to
758 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
759 * to other servers on a netburst and decoded at the other end by the same module on a
762 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
763 * how to use this function.
764 * @param opaque An opaque pointer set by the protocol module, should not be modified!
765 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
766 * @param target The chanrec* or userrec* that metadata should be sent for
767 * @param extname The extension name to send metadata for
768 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
770 virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata);
772 /** Called after every WALLOPS command.
773 * @param user The user sending the WALLOPS
774 * @param text The content of the WALLOPS message
776 virtual void OnWallops(userrec* user, const std::string &text);
778 /** Called whenever a user's hostname is changed.
779 * This event triggers after the host has been set.
780 * @param user The user whos host is being changed
781 * @param newhost The new hostname being set
783 virtual void OnChangeHost(userrec* user, const std::string &newhost);
785 /** Called whenever a user's GECOS (realname) is changed.
786 * This event triggers after the name has been set.
787 * @param user The user who's GECOS is being changed
788 * @param gecos The new GECOS being set on the user
790 virtual void OnChangeName(userrec* user, const std::string &gecos);
792 /** Called whenever a gline is added by a local user.
793 * This method is triggered after the line is added.
794 * @param duration The duration of the line in seconds
795 * @param source The sender of the line
796 * @param reason The reason text to be displayed
797 * @param hostmask The hostmask to add
799 virtual void OnAddGLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
801 /** Called whenever a zline is added by a local user.
802 * This method is triggered after the line is added.
803 * @param duration The duration of the line in seconds
804 * @param source The sender of the line
805 * @param reason The reason text to be displayed
806 * @param ipmask The hostmask to add
808 virtual void OnAddZLine(long duration, userrec* source, const std::string &reason, const std::string &ipmask);
810 /** Called whenever a kline is added by a local user.
811 * This method is triggered after the line is added.
812 * @param duration The duration of the line in seconds
813 * @param source The sender of the line
814 * @param reason The reason text to be displayed
815 * @param hostmask The hostmask to add
817 virtual void OnAddKLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
819 /** Called whenever a qline is added by a local user.
820 * This method is triggered after the line is added.
821 * @param duration The duration of the line in seconds
822 * @param source The sender of the line
823 * @param reason The reason text to be displayed
824 * @param nickmask The hostmask to add
826 virtual void OnAddQLine(long duration, userrec* source, const std::string &reason, const std::string &nickmask);
828 /** Called whenever a eline is added by a local user.
829 * This method is triggered after the line is added.
830 * @param duration The duration of the line in seconds
831 * @param source The sender of the line
832 * @param reason The reason text to be displayed
833 * @param hostmask The hostmask to add
835 virtual void OnAddELine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
837 /** Called whenever a gline is deleted.
838 * This method is triggered after the line is deleted.
839 * @param source The user removing the line
840 * @param hostmask The hostmask to delete
842 virtual void OnDelGLine(userrec* source, const std::string &hostmask);
844 /** Called whenever a zline is deleted.
845 * This method is triggered after the line is deleted.
846 * @param source The user removing the line
847 * @param hostmask The hostmask to delete
849 virtual void OnDelZLine(userrec* source, const std::string &ipmask);
851 /** Called whenever a kline is deleted.
852 * This method is triggered after the line is deleted.
853 * @param source The user removing the line
854 * @param hostmask The hostmask to delete
856 virtual void OnDelKLine(userrec* source, const std::string &hostmask);
858 /** Called whenever a qline is deleted.
859 * This method is triggered after the line is deleted.
860 * @param source The user removing the line
861 * @param hostmask The hostmask to delete
863 virtual void OnDelQLine(userrec* source, const std::string &nickmask);
865 /** Called whenever a eline is deleted.
866 * This method is triggered after the line is deleted.
867 * @param source The user removing the line
868 * @param hostmask The hostmask to delete
870 virtual void OnDelELine(userrec* source, const std::string &hostmask);
872 /** Called before your module is unloaded to clean up Extensibles.
873 * This method is called once for every user and channel on the network,
874 * so that when your module unloads it may clear up any remaining data
875 * in the form of Extensibles added using Extensible::Extend().
876 * If the target_type variable is TYPE_USER, then void* item refers to
877 * a userrec*, otherwise it refers to a chanrec*.
878 * @param target_type The type of item being cleaned
879 * @param item A pointer to the item's class
881 virtual void OnCleanup(int target_type, void* item);
883 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
884 * have been applied. Please note that although you can see remote nickchanges through this function, you should
885 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
886 * check user->server before taking any action (including returning nonzero from the method).
887 * Because this method is called after the nickchange is taken place, no return values are possible
888 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
889 * @param user The user changing their nick
890 * @param oldnick The old nickname of the user before the nickchange
892 virtual void OnUserPostNick(userrec* user, const std::string &oldnick);
894 /** Called before an action which requires a channel privilage check.
895 * This function is called before many functions which check a users status on a channel, for example
896 * before opping a user, deopping a user, kicking a user, etc.
897 * There are several values for access_type which indicate for what reason access is being checked.
899 * AC_KICK (0) - A user is being kicked<br>
900 * AC_DEOP (1) - a user is being deopped<br>
901 * AC_OP (2) - a user is being opped<br>
902 * AC_VOICE (3) - a user is being voiced<br>
903 * AC_DEVOICE (4) - a user is being devoiced<br>
904 * AC_HALFOP (5) - a user is being halfopped<br>
905 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
906 * AC_INVITE (7) - a user is being invited<br>
907 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
908 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
909 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
910 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
911 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
912 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
913 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
914 * @param source The source of the access check
915 * @param dest The destination of the access check
916 * @param channel The channel which is being checked
917 * @param access_type See above
919 virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
921 /** Called when a 005 numeric is about to be output.
922 * The module should modify the 005 numeric if needed to indicate its features.
923 * @param output The 005 string to be modified if neccessary.
925 virtual void On005Numeric(std::string &output);
927 /** Called when a client is disconnected by KILL.
928 * If a client is killed by a server, e.g. a nickname collision or protocol error,
930 * Return 1 from this function to prevent the kill, and 0 from this function to allow
931 * it as normal. If you prevent the kill no output will be sent to the client, it is
932 * down to your module to generate this information.
933 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
934 * If you do so youre risking race conditions, desyncs and worse!
935 * @param source The user sending the KILL
936 * @param dest The user being killed
937 * @param reason The kill reason
938 * @return 1 to prevent the kill, 0 to allow
940 virtual int OnKill(userrec* source, userrec* dest, const std::string &reason);
942 /** Called when an oper wants to disconnect a remote user via KILL
943 * @param source The user sending the KILL
944 * @param dest The user being killed
945 * @param reason The kill reason
947 virtual void OnRemoteKill(userrec* source, userrec* dest, const std::string &reason);
949 /** Called whenever a module is loaded.
950 * mod will contain a pointer to the module, and string will contain its name,
951 * for example m_widgets.so. This function is primary for dependency checking,
952 * your module may decide to enable some extra features if it sees that you have
953 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
954 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
955 * but instead operate under reduced functionality, unless the dependency is
956 * absolutely neccessary (e.g. a module that extends the features of another
958 * @param mod A pointer to the new module
959 * @param name The new module's filename
961 virtual void OnLoadModule(Module* mod,const std::string &name);
963 /** Called whenever a module is unloaded.
964 * mod will contain a pointer to the module, and string will contain its name,
965 * for example m_widgets.so. This function is primary for dependency checking,
966 * your module may decide to enable some extra features if it sees that you have
967 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
968 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
969 * but instead operate under reduced functionality, unless the dependency is
970 * absolutely neccessary (e.g. a module that extends the features of another
972 * @param mod Pointer to the module being unloaded (still valid)
973 * @param name The filename of the module being unloaded
975 virtual void OnUnloadModule(Module* mod,const std::string &name);
977 /** Called once every five seconds for background processing.
978 * This timer can be used to control timed features. Its period is not accurate
979 * enough to be used as a clock, but it is gauranteed to be called at least once in
980 * any five second period, directly from the main loop of the server.
981 * @param curtime The current timer derived from time(2)
983 virtual void OnBackgroundTimer(time_t curtime);
985 /** Called whenever a list is needed for a listmode.
986 * For example, when a /MODE #channel +b (without any other parameters) is called,
987 * if a module was handling +b this function would be called. The function can then
988 * output any lists it wishes to. Please note that all modules will see all mode
989 * characters to provide the ability to extend each other, so please only output
990 * a list if the mode character given matches the one(s) you want to handle.
991 * @param user The user requesting the list
992 * @param channel The channel the list is for
993 * @param mode The listmode which a list is being requested on
995 virtual void OnSendList(userrec* user, chanrec* channel, char mode);
997 /** Called whenever any command is about to be executed.
998 * This event occurs for all registered commands, wether they are registered in the core,
999 * or another module, but it will not occur for invalid commands (e.g. ones which do not
1000 * exist within the command table). By returning 1 from this method you may prevent the
1001 * command being executed. If you do this, no output is created by the core, and it is
1002 * down to your module to produce any output neccessary.
1003 * Note that unless you return 1, you should not destroy any structures (e.g. by using
1004 * Server::QuitUser) otherwise when the command's handler function executes after your
1005 * method returns, it will be passed an invalid pointer to the user object and crash!)
1006 * @param command The command being executed
1007 * @param parameters An array of array of characters containing the parameters for the command
1008 * @param pcnt The nuimber of parameters passed to the command
1009 * @param user the user issuing the command
1010 * @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.
1011 * @return 1 to block the command, 0 to allow
1013 virtual int OnPreCommand(const std::string &command, char **parameters, int pcnt, userrec *user, bool validated);
1015 /** Called to check if a user who is connecting can now be allowed to register
1016 * If any modules return false for this function, the user is held in the waiting
1017 * state until all modules return true. For example a module which implements ident
1018 * lookups will continue to return false for a user until their ident lookup is completed.
1019 * Note that the registration timeout for a user overrides these checks, if the registration
1020 * timeout is reached, the user is disconnected even if modules report that the user is
1021 * not ready to connect.
1022 * @param user The user to check
1023 * @return true to indicate readiness, false if otherwise
1025 virtual bool OnCheckReady(userrec* user);
1027 /** Called whenever a user is about to register their connection (e.g. before the user
1028 * is sent the MOTD etc). Modules can use this method if they are performing a function
1029 * which must be done before the actual connection is completed (e.g. ident lookups,
1030 * dnsbl lookups, etc).
1031 * Note that you should NOT delete the user record here by causing a disconnection!
1032 * Use OnUserConnect for that instead.
1033 * @param user The user registering
1035 virtual void OnUserRegister(userrec* user);
1037 /** Called whenever a mode character is processed.
1038 * Return 1 from this function to block the mode character from being processed entirely,
1039 * so that you may perform your own code instead. Note that this method allows you to override
1040 * modes defined by other modes, but this is NOT RECOMMENDED!
1041 * @param user The user who is sending the mode
1042 * @param chan The channel the mode is being sent to
1043 * @param mode The mode character being set
1044 * @param param The parameter for the mode or an empty string
1045 * @param adding true of the mode is being added, false if it is being removed
1046 * @param pcnt The parameter count for the mode (0 or 1)
1047 * @return 1 to deny the mode, 0 to allow
1049 virtual int OnRawMode(userrec* user, chanrec* chan, char mode, const std::string ¶m, bool adding, int pcnt);
1051 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1052 * This method will always be called for each join, wether or not the channel is actually +i, and
1053 * determines the outcome of an if statement around the whole section of invite checking code.
1054 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1055 * @param user The user joining the channel
1056 * @param chan The channel being joined
1057 * @return 1 to explicitly allow the join, 0 to proceed as normal
1059 virtual int OnCheckInvite(userrec* user, chanrec* chan);
1061 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1062 * This method will always be called for each join, wether or not the channel is actually +k, and
1063 * determines the outcome of an if statement around the whole section of key checking code.
1064 * if the user specified no key, the keygiven string will be a valid but empty value.
1065 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1066 * @param user The user joining the channel
1067 * @param chan The channel being joined
1068 * @return 1 to explicitly allow the join, 0 to proceed as normal
1070 virtual int OnCheckKey(userrec* user, chanrec* chan, const std::string &keygiven);
1072 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1073 * This method will always be called for each join, wether or not the channel is actually +l, and
1074 * determines the outcome of an if statement around the whole section of channel limit checking code.
1075 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1076 * @param user The user joining the channel
1077 * @param chan The channel being joined
1078 * @return 1 to explicitly allow the join, 0 to proceed as normal
1080 virtual int OnCheckLimit(userrec* user, chanrec* chan);
1082 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
1083 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
1084 * determines the outcome of an if statement around the whole section of ban checking code.
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 OnCheckBan(userrec* user, chanrec* chan);
1092 /** Called on all /STATS commands
1093 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1094 * @param symbol the symbol provided to /STATS
1095 * @user the user issuing the /STATS command
1096 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1098 virtual int OnStats(char symbol, userrec* user);
1100 /** Called whenever a change of a local users displayed host is attempted.
1101 * Return 1 to deny the host change, or 0 to allow it.
1102 * @param user The user whos host will be changed
1103 * @param newhost The new hostname
1104 * @return 1 to deny the host change, 0 to allow
1106 virtual int OnChangeLocalUserHost(userrec* user, const std::string &newhost);
1108 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1109 * return 1 to deny the name change, or 0 to allow it.
1110 * @param user The user whos GECOS will be changed
1111 * @param newhost The new GECOS
1112 * @return 1 to deny the GECOS change, 0 to allow
1114 virtual int OnChangeLocalUserGECOS(userrec* user, const std::string &newhost);
1116 /** Called whenever a topic is changed by a local user.
1117 * Return 1 to deny the topic change, or 0 to allow it.
1118 * @param user The user changing the topic
1119 * @param chan The channels who's topic is being changed
1120 * @param topic The actual topic text
1121 * @param 1 to block the topic change, 0 to allow
1123 virtual int OnLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic);
1125 /** Called whenever a local topic has been changed.
1126 * To block topic changes you must use OnLocalTopicChange instead.
1127 * @param user The user changing the topic
1128 * @param chan The channels who's topic is being changed
1129 * @param topic The actual topic text
1131 virtual void OnPostLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic);
1133 /** Called whenever an Event class is sent to all module by another module.
1134 * Please see the documentation of Event::Send() for further information. The Event sent can
1135 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1136 * before doing anything to the event data, and you should *not* change the event data in any way!
1137 * @param event The Event class being received
1139 virtual void OnEvent(Event* event);
1141 /** Called whenever a Request class is sent to your module by another module.
1142 * Please see the documentation of Request::Send() for further information. The Request sent
1143 * can always be assumed to be non-NULL, you should not change the request object or its data.
1144 * Your method may return arbitary data in the char* result which the requesting module
1145 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1146 * @param request The Request class being received
1148 virtual char* OnRequest(Request* request);
1150 /** Called whenever an oper password is to be compared to what a user has input.
1151 * The password field (from the config file) is in 'password' and is to be compared against
1152 * 'input'. This method allows for encryption of oper passwords and much more besides.
1153 * You should return a nonzero value if you want to allow the comparison or zero if you wish
1155 * @param password The oper's password
1156 * @param input The password entered
1157 * @return 1 to match the passwords, 0 to do nothing
1159 virtual int OnOperCompare(const std::string &password, const std::string &input);
1161 /** Called whenever a user is given usermode +o, anywhere on the network.
1162 * You cannot override this and prevent it from happening as it is already happened and
1163 * such a task must be performed by another server. You can however bounce modes by sending
1164 * servermodes out to reverse mode changes.
1165 * @param user The user who is opering
1167 virtual void OnGlobalOper(userrec* user);
1169 /** Called whenever a user connects, anywhere on the network.
1170 * This event is informational only. You should not change any user information in this
1171 * event. To do so, use the OnUserConnect method to change the state of local users.
1172 * @param user The user who is connecting
1174 virtual void OnGlobalConnect(userrec* user);
1176 /** Called whenever a ban is added to a channel's list.
1177 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1178 * @param source The user adding the ban
1179 * @param channel The channel the ban is being added to
1180 * @param banmask The ban mask being added
1181 * @return 1 to block the ban, 0 to continue as normal
1183 virtual int OnAddBan(userrec* source, chanrec* channel,const std::string &banmask);
1185 /** Called whenever a ban is removed from a channel's list.
1186 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1187 * @param source The user deleting the ban
1188 * @param channel The channel the ban is being deleted from
1189 * @param banmask The ban mask being deleted
1190 * @return 1 to block the unban, 0 to continue as normal
1192 virtual int OnDelBan(userrec* source, chanrec* channel,const std::string &banmask);
1194 /** Called immediately after any connection is accepted. This is intended for raw socket
1195 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1196 * no information relating to a user record as the connection has not been assigned yet.
1197 * There are no return values from this call as all modules get an opportunity if required to
1198 * process the connection.
1199 * @param fd The file descriptor returned from accept()
1200 * @param ip The IP address of the connecting user
1201 * @param localport The local port number the user connected to
1203 virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport);
1205 /** Called immediately before any write() operation on a user's socket in the core. Because
1206 * this event is a low level event no user information is associated with it. It is intended
1207 * for use by modules which may wrap connections within another API such as SSL for example.
1208 * return a non-zero result if you have handled the write operation, in which case the core
1209 * will not call write().
1210 * @param fd The file descriptor of the socket
1211 * @param buffer A char* buffer being written
1212 * @param Number of characters to write
1213 * @return Number of characters actually written or 0 if you didn't handle the operation
1215 virtual int OnRawSocketWrite(int fd, char* buffer, int count);
1217 /** Called immediately before any socket is closed. When this event is called, shutdown()
1218 * has not yet been called on the socket.
1219 * @param fd The file descriptor of the socket prior to close()
1221 virtual void OnRawSocketClose(int fd);
1223 /** Called immediately before any read() operation on a client socket in the core.
1224 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1225 * when this event occurs.
1226 * Your event should return 1 if it has handled the reading itself, which prevents the core
1227 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1228 * the value of count. The value of readresult must be identical to an actual result that might
1229 * be returned from the read() system call, for example, number of bytes read upon success,
1230 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1231 * you MUST set readresult.
1232 * @param fd The file descriptor of the socket
1233 * @param buffer A char* buffer being read to
1234 * @param count The size of the buffer
1235 * @param readresult The amount of characters read, or 0
1236 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1238 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1240 /** Called whenever a user sets away.
1241 * This method has no parameter for the away message, as it is available in the
1242 * user record as userrec::awaymsg.
1244 virtual void OnSetAway(userrec* user);
1246 /** Called when a user cancels their away state.
1248 virtual void OnCancelAway(userrec* user);
1252 /** Allows server output and query functions
1253 * This class contains methods which allow a module to query the state of the irc server, and produce
1254 * output to users and other servers. All modules should instantiate at least one copy of this class,
1255 * and use its member functions to perform their tasks.
1257 class Server : public classbase
1260 /** Default constructor.
1261 * Creates a Server object.
1265 /** Default destructor.
1266 * Destroys a Server object.
1270 /** Obtains a pointer to the server's ServerConfig object.
1271 * The ServerConfig object contains most of the configuration data
1272 * of the IRC server, as read from the config file by the core.
1274 ServerConfig* GetConfig();
1276 /** For use with Module::Prioritize().
1277 * When the return value of this function is returned from
1278 * Module::Prioritize(), this specifies that the module wishes
1279 * to be ordered exactly BEFORE 'modulename'. For more information
1280 * please see Module::Prioritize().
1281 * @param modulename The module your module wants to be before in the call list
1282 * @returns a priority ID which the core uses to relocate the module in the list
1284 long PriorityBefore(const std::string &modulename);
1286 /** For use with Module::Prioritize().
1287 * When the return value of this function is returned from
1288 * Module::Prioritize(), this specifies that the module wishes
1289 * to be ordered exactly AFTER 'modulename'. For more information please
1290 * see Module::Prioritize().
1291 * @param modulename The module your module wants to be after in the call list
1292 * @returns a priority ID which the core uses to relocate the module in the list
1294 long PriorityAfter(const std::string &modulename);
1296 /** Sends text to all opers.
1297 * This method sends a server notice to all opers with the usermode +s.
1299 virtual void SendOpers(const std::string &s);
1301 /** Returns the version string of this server
1303 std::string GetVersion();
1305 /** Writes a log string.
1306 * This method writes a line of text to the log. If the level given is lower than the
1307 * level given in the configuration, this command has no effect.
1309 virtual void Log(int level, const std::string &s);
1311 /** Sends a line of text down a TCP/IP socket.
1312 * This method writes a line of text to an established socket, cutting it to 510 characters
1313 * plus a carriage return and linefeed if required.
1315 virtual void Send(int Socket, const std::string &s);
1317 /** Sends text from the server to a socket.
1318 * This method writes a line of text to an established socket, with the servername prepended
1319 * as used by numerics (see RFC 1459)
1321 virtual void SendServ(int Socket, const std::string &s);
1323 /** Writes text to a channel, but from a server, including all.
1324 * This can be used to send server notices to a group of users.
1326 virtual void SendChannelServerNotice(const std::string &ServName, chanrec* Channel, const std::string &text);
1328 /** Sends text from a user to a socket.
1329 * This method writes a line of text to an established socket, with the given user's nick/ident
1330 * /host combination prepended, as used in PRIVSG etc commands (see RFC 1459)
1332 virtual void SendFrom(int Socket, userrec* User, const std::string &s);
1334 /** Sends text from a user to another user.
1335 * This method writes a line of text to a user, with a user's nick/ident
1336 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459)
1337 * If you specify NULL as the source, then the data will originate from the
1338 * local server, e.g. instead of:
1340 * :user!ident@host TEXT
1342 * The format will become:
1346 * Which is useful for numerics and server notices to single users, etc.
1348 virtual void SendTo(userrec* Source, userrec* Dest, const std::string &s);
1350 /** Sends text from a user to a channel (mulicast).
1351 * This method writes a line of text to a channel, with the given user's nick/ident
1352 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the
1353 * IncludeSender flag is set, then the text is also sent back to the user from which
1354 * it originated, as seen in MODE (see RFC 1459).
1356 virtual void SendChannel(userrec* User, chanrec* Channel, const std::string &s, bool IncludeSender);
1358 /** Returns true if two users share a common channel.
1359 * This method is used internally by the NICK and QUIT commands, and the Server::SendCommon
1362 virtual bool CommonChannels(userrec* u1, userrec* u2);
1364 /** Sends text from a user to one or more channels (mulicast).
1365 * This method writes a line of text to all users which share a common channel with a given
1366 * user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc
1367 * commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent
1368 * back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it
1369 * is only sent to the other recipients, as seen in QUIT.
1371 virtual void SendCommon(userrec* User, const std::string &text, bool IncludeSender);
1373 /** Sends a WALLOPS message.
1374 * This method writes a WALLOPS message to all users with the +w flag, originating from the
1377 virtual void SendWallops(userrec* User, const std::string &text);
1379 /** Returns true if a nick is valid.
1380 * Nicks for unregistered connections will return false.
1382 virtual bool IsNick(const std::string &nick);
1384 /** Returns a count of the number of users on a channel.
1385 * This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.
1387 virtual int CountUsers(chanrec* c);
1389 /** Adds an InspTimer which will trigger at a future time
1391 virtual void AddTimer(InspTimer* T);
1393 /** Attempts to look up a nick and return a pointer to it.
1394 * This function will return NULL if the nick does not exist.
1396 virtual userrec* FindNick(const std::string &nick);
1398 /** Attempts to look up a nick using the file descriptor associated with that nick.
1399 * This function will return NULL if the file descriptor is not associated with a valid user.
1401 virtual userrec* FindDescriptor(int socket);
1403 /** Attempts to look up a channel and return a pointer to it.
1404 * This function will return NULL if the channel does not exist.
1406 virtual chanrec* FindChannel(const std::string &channel);
1408 /** Attempts to look up a user's privilages on a channel.
1409 * This function will return a string containing either @, %, +, or an empty string,
1410 * representing the user's privilages upon the channel you specify.
1412 virtual std::string ChanMode(userrec* User, chanrec* Chan);
1414 /** Returns the server name of the server where the module is loaded.
1416 virtual std::string GetServerName();
1418 /** Returns the network name, global to all linked servers.
1420 virtual std::string GetNetworkName();
1422 /** Returns the server description string of the local server
1424 virtual std::string GetServerDescription();
1426 /** Returns the information of the server as returned by the /ADMIN command.
1427 * See the Admin class for further information of the return value. The members
1428 * Admin::Nick, Admin::Email and Admin::Name contain the information for the
1429 * server where the module is loaded.
1431 virtual Admin GetAdmin();
1433 /** Adds an extended mode letter which is parsed by a module.
1434 * This allows modules to add extra mode letters, e.g. +x for hostcloak.
1435 * the "type" parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to
1436 * indicate wether the mode is a channel mode, a client mode, or a server mode.
1437 * requires_oper is used with MT_CLIENT type modes only to indicate the mode can only
1438 * be set or unset by an oper. If this is used for MT_CHANNEL type modes it is ignored.
1439 * params_when_on is the number of modes to expect when the mode is turned on
1440 * (for type MT_CHANNEL only), e.g. with mode +k, this would have a value of 1.
1441 * the params_when_off value has a similar value to params_when_on, except it indicates
1442 * the number of parameters to expect when the mode is disabled. Modes which act in a similar
1443 * way to channel mode +l (e.g. require a parameter to enable, but not to disable) should
1444 * use this parameter. The function returns false if the mode is unavailable, and will not
1445 * attempt to allocate another character, as this will confuse users. This also means that
1446 * as only one module can claim a specific mode character, the core does not need to keep track
1447 * of which modules own which modes, which speeds up operation of the server. In this version,
1448 * a mode can have at most one parameter, attempting to use more parameters will have undefined
1451 virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off);
1453 /** Adds an extended mode letter which is parsed by a module and handled in a list fashion.
1454 * This call is used to implement modes like +q and +a. The characteristics of these modes are
1457 * (1) They are ALWAYS on channels, not on users, therefore their type is MT_CHANNEL
1459 * (2) They always take exactly one parameter when being added or removed
1461 * (3) They can be set multiple times, usually on users in channels
1463 * (4) The mode and its parameter are NOT stored in the channels modes structure
1465 * It is down to the module handling the mode to maintain state and determine what 'items' (e.g. users,
1466 * or a banlist) have the mode set on them, and process the modes at the correct times, e.g. during access
1467 * checks on channels, etc. When the extended mode is triggered the OnExtendedMode method will be triggered
1468 * as above. Note that the target you are given will be a channel, if for example your mode is set 'on a user'
1469 * (in for example +a) you must use Server::Find to locate the user the mode is operating on.
1470 * Your mode handler may return 1 to handle the mode AND tell the core to display the mode change, e.g.
1471 * '+aaa one two three' in the case of the mode for 'two', or it may return -1 to 'eat' the mode change,
1472 * so the above example would become '+aa one three' after processing.
1474 virtual bool AddExtendedListMode(char modechar);
1476 /** Adds a command to the command table.
1477 * This allows modules to add extra commands into the command table. You must place a function within your
1478 * module which is is of type handlerfunc:
1480 * typedef void (handlerfunc) (char**, int, userrec*);
1482 * void handle_kill(char **parameters, int pcnt, userrec *user)
1484 * When the command is typed, the parameters will be placed into the parameters array (similar to argv) and
1485 * the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters
1486 * than the 'minparams' value you specified when creating the command. The *user parameter is the class of
1487 * the user which caused the command to trigger, who will always have the flag you specified in 'flags' when
1488 * creating the initial command. For example to create an oper only command create the commands with flags='o'.
1489 * The source parameter is used for resource tracking, and should contain the name of your module (with file
1490 * extension) e.g. "m_blarp.so". If you place the wrong identifier here, you can cause crashes if your module
1493 virtual void AddCommand(command_t *f);
1495 /** Sends a servermode.
1496 * you must format the parameters array with the target, modes and parameters for those modes.
1502 * modes[0] = ChannelName;
1506 * modes[2] = user->nick;
1508 * Srv->SendMode(modes,3,user);
1510 * The modes will originate from the server where the command was issued, however responses (e.g. numerics)
1511 * will be sent to the user you provide as the third parameter.
1512 * You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave
1513 * your server in an unstable state!
1516 virtual void SendMode(char **parameters, int pcnt, userrec *user);
1518 /** Sends to all users matching a mode mask
1519 * You must specify one or more usermodes as the first parameter. These can be RFC specified modes such as +i,
1520 * or module provided modes, including ones provided by your own module.
1521 * In the second parameter you must place a flag value which indicates wether the modes you have given will be
1522 * logically ANDed or OR'ed. You may use one of either WM_AND or WM_OR.
1523 * for example, if you were to use:
1525 * Serv->SendToModeMask("xi", WM_OR, "m00");
1527 * Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the
1528 * user must have both modes set to receive the message.
1530 virtual void SendToModeMask(const std::string &modes, int flags, const std::string &text);
1532 /** Forces a user to join a channel.
1533 * This is similar to svsjoin and can be used to implement redirection, etc.
1534 * On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to.
1535 * On failure, the result is NULL.
1537 virtual chanrec* JoinUserToChannel(userrec* user, const std::string &cname, const std::string &key);
1539 /** Forces a user to part a channel.
1540 * This is similar to svspart and can be used to implement redirection, etc.
1541 * Although the return value of this function is a pointer to a channel record, the returned data is
1542 * undefined and should not be read or written to. This behaviour may be changed in a future version.
1544 virtual chanrec* PartUserFromChannel(userrec* user, const std::string &cname, const std::string &reason);
1546 /** Forces a user nickchange.
1547 * This command works similarly to SVSNICK, and can be used to implement Q-lines etc.
1548 * If you specify an invalid nickname, the nick change will be dropped and the target user will receive
1549 * the error numeric for it.
1551 virtual void ChangeUserNick(userrec* user, const std::string &nickname);
1553 /** Forces a user to quit with the specified reason.
1554 * To the user, it will appear as if they typed /QUIT themselves, except for the fact that this function
1555 * may bypass the quit prefix specified in the config file.
1559 * Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or
1560 * read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of
1561 * action after calling this method is to immediately bail from your handler.
1563 virtual void QuitUser(userrec* user, const std::string &reason);
1565 /** Makes a user kick another user, with the specified reason.
1566 * If source is NULL, the server will peform the kick.
1567 * @param The person or server (if NULL) performing the KICK
1568 * @param target The person being kicked
1569 * @param chan The channel to kick from
1570 * @param reason The kick reason
1572 virtual void KickUser(userrec* source, userrec* target, chanrec* chan, const std::string &reason);
1574 /** Matches text against a glob pattern.
1575 * Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com
1576 * Returns true if the literal successfully matches the pattern, false if otherwise.
1578 virtual bool MatchText(const std::string &sliteral, const std::string &spattern);
1580 /** Calls the handler for a command, either implemented by the core or by another module.
1581 * You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN,
1582 * KICK etc, or even as a method of callback. By defining command names that are untypeable
1583 * for users on irc (e.g. those which contain a \r or \n) you may use them as callback identifiers.
1584 * The first parameter to this method is the name of the command handler you wish to call, e.g.
1585 * PRIVMSG. This will be a command handler previously registered by the core or wih AddCommand().
1586 * The second parameter is an array of parameters, and the third parameter is a count of parameters
1587 * in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the
1588 * functiom will silently ignore it. The final parameter is the user executing the command handler,
1589 * used for privilage checks, etc.
1590 * @return True if the command exists
1592 virtual bool CallCommandHandler(const std::string &commandname, char** parameters, int pcnt, userrec* user);
1594 /** This function returns true if the commandname exists, pcnt is equal to or greater than the number
1595 * of paramters the command requires, the user specified is allowed to execute the command, AND
1596 * if the command is implemented by a module (not the core). This has a few specific uses, usually
1597 * within network protocols (see src/modules/m_spanningtree.cpp)
1599 virtual bool IsValidModuleCommand(const std::string &commandname, int pcnt, userrec* user);
1601 /** Change displayed hostname of a user.
1602 * You should always call this method to change a user's host rather than writing directly to the
1603 * dhost member of userrec, as any change applied via this method will be propogated to any
1606 virtual void ChangeHost(userrec* user, const std::string &host);
1608 /** Change GECOS (fullname) of a user.
1609 * You should always call this method to change a user's GECOS rather than writing directly to the
1610 * fullname member of userrec, as any change applied via this method will be propogated to any
1613 virtual void ChangeGECOS(userrec* user, const std::string &gecos);
1615 /** Returns true if the servername you give is ulined.
1616 * ULined servers have extra privilages. They are allowed to change nicknames on remote servers,
1617 * change modes of clients which are on remote servers and set modes of channels where there are
1618 * no channel operators for that channel on the ulined server, amongst other things.
1620 virtual bool IsUlined(const std::string &server);
1622 /** Fetches the userlist of a channel. This function must be here and not a member of userrec or
1623 * chanrec due to include constraints.
1625 virtual chanuserlist GetUsers(chanrec* chan);
1627 /** Remove a user's connection to the irc server, but leave their client in existence in the
1628 * user hash. When you call this function, the user's file descriptor will be replaced with the
1629 * value of FD_MAGIC_NUMBER and their old file descriptor will be closed. This idle client will
1630 * remain until it is restored with a valid file descriptor, or is removed from IRC by an operator
1631 * After this call, the pointer to user will be invalid.
1633 virtual bool UserToPseudo(userrec* user, const std::string &message);
1635 /** This user takes one user, and switches their file descriptor with another user, so that one user
1636 * "becomes" the other. The user in 'alive' is booted off the server with the given message. The user
1637 * referred to by 'zombie' should have previously been locked with Server::UserToPseudo, otherwise
1638 * stale sockets and file descriptor leaks can occur. After this call, the pointer to alive will be
1639 * invalid, and the pointer to zombie will be equivalent in effect to the old pointer to alive.
1641 virtual bool PseudoToUser(userrec* alive, userrec* zombie, const std::string &message);
1644 * The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1645 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1646 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1647 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1650 virtual void AddGLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1653 * The Q-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1654 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1655 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1656 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1659 virtual void AddQLine(long duration, const std::string &source, const std::string &reason, const std::string &nickname);
1662 * The Z-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1663 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1664 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1665 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1668 virtual void AddZLine(long duration, const std::string &source, const std::string &reason, const std::string &ipaddr);
1671 * The K-line is enforced as soon as it is added.
1672 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1673 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1674 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1677 virtual void AddKLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1680 * The E-line is enforced as soon as it is added.
1681 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1682 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1683 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1686 virtual void AddELine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1688 /** Deletes a G-Line from all servers
1690 virtual bool DelGLine(const std::string &hostmask);
1692 /** Deletes a Q-Line from all servers
1694 virtual bool DelQLine(const std::string &nickname);
1696 /** Deletes a Z-Line from all servers
1698 virtual bool DelZLine(const std::string &ipaddr);
1700 /** Deletes a local K-Line
1702 virtual bool DelKLine(const std::string &hostmask);
1704 /** Deletes a local E-Line
1706 virtual bool DelELine(const std::string &hostmask);
1708 /** Calculates a duration
1709 * This method will take a string containing a formatted duration (e.g. "1w2d") and return its value
1710 * as a total number of seconds. This is the same function used internally by /GLINE etc to set
1713 virtual long CalcDuration(const std::string &duration);
1715 /** Returns true if a nick!ident@host string is correctly formatted, false if otherwise.
1717 virtual bool IsValidMask(const std::string &mask);
1719 /** This function finds a module by name.
1720 * You must provide the filename of the module. If the module cannot be found (is not loaded)
1721 * the function will return NULL.
1723 virtual Module* FindModule(const std::string &name);
1725 /** Adds a class derived from InspSocket to the server's socket engine.
1727 virtual void AddSocket(InspSocket* sock);
1729 /** Forcibly removes a class derived from InspSocket from the servers socket engine.
1731 virtual void RemoveSocket(InspSocket* sock);
1733 /** Deletes a class derived from InspSocket from the server's socket engine.
1735 virtual void DelSocket(InspSocket* sock);
1737 /** Causes the local server to rehash immediately.
1738 * WARNING: Do not call this method from within your rehash method, for
1741 virtual void RehashServer();
1743 /** This method returns the total number of channels on the network.
1745 virtual long GetChannelCount();
1747 /** This method returns a channel whos index is greater than or equal to 0 and less than the number returned by Server::GetChannelCount().
1748 * This is slower (by factors of dozens) than requesting a channel by name with Server::FindChannel(), however there are times when
1749 * you wish to safely iterate the channel list, saving your position, with large amounts of time in between, which is what this function
1752 virtual chanrec* GetChannelIndex(long index);
1754 /** Dumps text (in a stringstream) to a user. The stringstream should not contain linefeeds, as it will be split
1755 * automatically by the function into safe amounts. The line prefix given is prepended onto each line (e.g. a servername
1758 void DumpText(userrec* User, const std::string &LinePrefix, stringstream &TextStream);
1762 #define CONF_NOT_A_NUMBER 0x000010
1763 #define CONF_NOT_UNSIGNED 0x000080
1764 #define CONF_VALUE_NOT_FOUND 0x000100
1765 #define CONF_FILE_NOT_FOUND 0x000200
1768 /** Allows reading of values from configuration files
1769 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1770 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1771 * Constructing the class using one parameter allows you to specify a path to your own configuration
1772 * file, otherwise, inspircd.conf is read.
1774 class ConfigReader : public classbase
1777 /** The contents of the configuration file
1778 * This protected member should never be accessed by a module (and cannot be accessed unless the
1779 * core is changed). It will contain a pointer to the configuration file data with unneeded data
1780 * (such as comments) stripped from it.
1782 ConfigDataHash* data;
1783 std::ostringstream* errorlog;;
1784 /** Used to store errors
1786 bool privatehash; // If we're using our own config data hash or not.
1791 /** Default constructor.
1792 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1793 * as specified when running ./configure.
1795 ConfigReader(); // default constructor reads ircd.conf
1796 /** Overloaded constructor.
1797 * This constructor initialises the ConfigReader class to read a user-specified config file
1799 ConfigReader(const std::string &filename); // read a module-specific config
1800 /** Default destructor.
1801 * This method destroys the ConfigReader class.
1804 /** Retrieves a value from the config file.
1805 * This method retrieves a value from the config file. Where multiple copies of the tag
1806 * exist in the config file, index indicates which of the values to retrieve.
1808 std::string ReadValue(const std::string &tag, const std::string &name, int index);
1809 /** Retrieves a boolean value from the config file.
1810 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1811 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1812 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1814 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1815 /** Retrieves an integer value from the config file.
1816 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1817 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1818 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1819 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1820 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1821 * will return CONF_NOT_UNSIGNED
1823 long ReadInteger(const std::string &tag, const std::string &name, int index, bool needs_unsigned);
1824 /** Returns the last error to occur.
1825 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1826 * A call to GetError() resets the error flag back to 0.
1829 /** Counts the number of times a given tag appears in the config file.
1830 * This method counts the number of times a tag appears in a config file, for use where
1831 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1832 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1833 * multiple instance tag.
1835 int Enumerate(const std::string &tag);
1836 /** Returns true if a config file is valid.
1837 * This method is partially implemented and will only return false if the config
1838 * file does not exist or could not be opened.
1841 /** Dumps the list of errors in a config file to an output location. If bail is true,
1842 * then the program will abort. If bail is false and user points to a valid user
1843 * record, the error report will be spooled to the given user by means of NOTICE.
1844 * if bool is false AND user is false, the error report will be spooled to all opers
1845 * by means of a NOTICE to all opers.
1847 void DumpErrors(bool bail,userrec* user);
1849 /** Returns the number of items within a tag.
1850 * For example if the tag was <test tag="blah" data="foo"> then this
1851 * function would return 2. Spaces and newlines both qualify as valid seperators
1854 int EnumerateValues(const std::string &tag, int index);
1859 /** Caches a text file into memory and can be used to retrieve lines from it.
1860 * This class contains methods for read-only manipulation of a text file in memory.
1861 * Either use the constructor type with one parameter to load a file into memory
1862 * at construction, or use the LoadFile method to load a file.
1864 class FileReader : public classbase
1866 /** The file contents
1870 /** Default constructor.
1871 * This method does not load any file into memory, you must use the LoadFile method
1872 * after constructing the class this way.
1876 /** Secondary constructor.
1877 * This method initialises the class with a file loaded into it ready for GetLine and
1878 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1881 FileReader(const std::string &filename);
1883 /** Default destructor.
1884 * This deletes the memory allocated to the file.
1888 /** Used to load a file.
1889 * This method loads a file into the class ready for GetLine and
1890 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1893 void LoadFile(const std::string &filename);
1895 /** Returns true if the file exists
1896 * This function will return false if the file could not be opened.
1900 /** Retrieve one line from the file.
1901 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1902 * the index was out of bounds, or the line had no data on it.
1904 std::string GetLine(int x);
1906 /** Returns the size of the file in lines.
1907 * This method returns the number of lines in the read file. If it is 0, no lines have been
1908 * read into memory, either because the file is empty or it does not exist, or cannot be
1909 * opened due to permission problems.
1915 /** Instantiates classes inherited from Module
1916 * This class creates a class inherited from type Module, using new. This is to allow for modules
1917 * to create many different variants of Module, dependent on architecture, configuration, etc.
1918 * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
1921 class ModuleFactory : public classbase
1925 virtual ~ModuleFactory() { }
1926 /** Creates a new module.
1927 * Your inherited class of ModuleFactory must return a pointer to your Module class
1928 * using this method.
1930 virtual Module * CreateModule(Server* Me) = 0;
1934 typedef DLLFactory<ModuleFactory> ircd_module;
1935 typedef std::vector<Module*> ModuleList;
1936 typedef std::vector<ircd_module*> FactoryList;
1938 bool ModeDefined(char c, int i);
1939 bool ModeDefinedOper(char c, int i);
1940 int ModeDefinedOn(char c, int i);
1941 int ModeDefinedOff(char c, int i);
1942 void ModeMakeList(char modechar);
1943 bool ModeIsListMode(char modechar, int type);