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 {
79 /** Low level definition of a FileReader classes file cache area
81 typedef std::deque<std::string> file_cache;
82 typedef file_cache string_list;
84 /** Holds a list of users in a channel
86 typedef std::deque<userrec*> chanuserlist;
89 // This #define allows us to call a method in all
90 // loaded modules in a readable simple way, e.g.:
91 // 'FOREACH_MOD OnConnect(user);'
93 #define FOREACH_MOD(y,x) if (Config->global_implementation[y] > 0) { \
94 for (int _i = 0; _i <= MODCOUNT; _i++) { \
95 if (Config->implement_lists[_i][y]) \
100 catch (ModuleException& modexcept) \
102 log(DEBUG,"Module exception cought: %s",modexcept.GetReason()); \
107 // This define is similar to the one above but returns a result in MOD_RESULT.
108 // The first module to return a nonzero result is the value to be accepted,
109 // and any modules after are ignored.
111 // *********************************************************************************************
113 #define FOREACH_RESULT(y,x) { if (Config->global_implementation[y] > 0) { \
115 for (int _i = 0; _i <= MODCOUNT; _i++) { \
116 if (Config->implement_lists[_i][y]) {\
119 int res = modules[_i]->x ; \
125 catch (ModuleException& modexcept) \
127 log(DEBUG,"Module exception cought: %s",modexcept.GetReason()); \
134 // *********************************************************************************************
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 /*extern void createcommand(char* cmd, handlerfunc f, char flags, int minparams, char* source);
145 extern void server_mode(char **parameters, int pcnt, userrec *user);*/
147 // class Version holds the version information of a Module, returned
148 // by Module::GetVersion (thanks RD)
150 /** Holds a module's Version information
151 * The four members (set by the constructor only) indicate details as to the version number
152 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
154 class Version : public classbase
157 const int Major, Minor, Revision, Build, Flags;
158 Version(int major, int minor, int revision, int build, int flags);
161 /** Holds /ADMIN data
162 * This class contains the admin details of the local server. It is constructed by class Server,
163 * and has three read-only values, Name, Email and Nick that contain the specified values for the
164 * server where the module is running.
166 class Admin : public classbase
169 const std::string Name, Email, Nick;
170 Admin(std::string name, std::string email, std::string nick);
174 // Forward-delacare module for ModuleMessage etc
177 // Thanks to Rob (from anope) for the idea of this message passing API
178 // (its been done before, but this seemed a very neat and tidy way...
180 /** The ModuleMessage class is the base class of Request and Event
181 * This class is used to represent a basic data structure which is passed
182 * between modules for safe inter-module communications.
184 class ModuleMessage : public classbase
187 /** This class is pure virtual and must be inherited.
189 virtual char* Send() = 0;
190 virtual ~ModuleMessage() {};
193 /** The Request class is a unicast message directed at a given module.
194 * When this class is properly instantiated it may be sent to a module
195 * using the Send() method, which will call the given module's OnRequest
196 * method with this class as its parameter.
198 class Request : public ModuleMessage
201 /** This member holds a pointer to arbitary data set by the emitter of the message
204 /** This is a pointer to the sender of the message, which can be used to
205 * directly trigger events, or to create a reply.
208 /** The single destination of the Request
212 /** Create a new Request
214 Request(char* anydata, Module* src, Module* dst);
215 /** Fetch the Request data
218 /** Fetch the request source
221 /** Fetch the request destination (should be 'this' in the receiving module)
224 /** Send the Request.
225 * Upon returning the result will be arbitary data returned by the module you
226 * sent the request to. It is up to your module to know what this data is and
227 * how to deal with it.
233 /** The Event class is a unicast message directed at all modules.
234 * When the class is properly instantiated it may be sent to all modules
235 * using the Send() method, which will trigger the OnEvent method in
236 * all modules passing the object as its parameter.
238 class Event : public ModuleMessage
241 /** This member holds a pointer to arbitary data set by the emitter of the message
244 /** This is a pointer to the sender of the message, which can be used to
245 * directly trigger events, or to create a reply.
248 /** The event identifier.
249 * This is arbitary text which should be used to distinguish
250 * one type of event from another.
254 /** Create a new Event
256 Event(char* anydata, Module* src, std::string eventid);
257 /** Get the Event data
260 /** Get the event Source
263 /** Get the event ID.
264 * Use this to determine the event type for safe casting of the data
266 std::string GetEventID();
268 * The return result of an Event::Send() will always be NULL as
269 * no replies are expected.
274 /** Holds an extended mode's details.
275 * Used internally by modules.cpp
277 class ExtMode : public classbase
286 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) { };
290 /** This class can be used on its own to represent an exception, or derived to represent a module-specific exception.
291 * When a module whishes to abort, e.g. within a constructor, it should throw an exception using ModuleException or
292 * a class derived from ModuleException. If a module throws an exception during its constructor, the module will not
293 * be loaded. If this happens, the error message returned by ModuleException::GetReason will be displayed to the user
294 * attempting to load the module, or dumped to the console if the ircd is currently loading for the first time.
296 class ModuleException
299 /** Holds the error message to be displayed
303 /** Default constructor, just uses the error mesage 'Module threw an exception'.
305 ModuleException() : err("Module threw an exception") {}
306 /** This constructor can be used to specify an error message before throwing.
308 ModuleException(std::string message) : err(message) {}
309 /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
310 * Actually no, it does nothing. Never mind.
312 virtual ~ModuleException() {};
313 /** Returns the reason for the exception.
314 * The module should probably put something informative here as the user will see this upon failure.
316 virtual char *GetReason()
318 return (char*)err.c_str();
322 /** Priority types which can be returned from Module::Prioritize()
324 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
326 /** Implementation-specific flags which may be set in Module::Implements()
328 enum Implementation { I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash, I_OnServerRaw,
329 I_OnExtendedMode, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois, I_OnUserPreInvite,
330 I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick, I_OnUserMessage, I_OnUserNotice, I_OnMode,
331 I_OnGetServerDescription, I_OnSyncUser, I_OnSyncChannel, I_OnSyncChannelMetaData, I_OnSyncUserMetaData,
332 I_OnDecodeMetaData, I_ProtoSendMode, I_ProtoSendMetaData, I_OnWallops, I_OnChangeHost, I_OnChangeName, I_OnAddGLine,
333 I_OnAddZLine, I_OnAddQLine, I_OnAddKLine, I_OnAddELine, I_OnDelGLine, I_OnDelZLine, I_OnDelKLine, I_OnDelELine, I_OnDelQLine,
334 I_OnCleanup, I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule, I_OnUnloadModule,
335 I_OnBackgroundTimer, I_OnSendList, I_OnPreCommand, I_OnCheckReady, I_OnUserRrgister, I_OnRawMode, I_OnCheckInvite,
336 I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnLocalTopicChange,
337 I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnOperCompre, I_OnGlobalOper, I_OnGlobalConnect, I_OnAddBan, I_OnDelBan,
338 I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead, I_OnChangeLocalUserGECOS, I_OnUserRegister,
339 I_OnOperCompare, I_OnChannelDelete, I_OnPostOper, I_OnSyncOtherMetaData, I_OnSetAway, I_OnCancelAway };
341 /** Base class for all InspIRCd modules
342 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
343 * its methods will be called when irc server events occur. class inherited from module must be
344 * instantiated by the ModuleFactory class (see relevent section) for the plugin to be initialised.
346 class Module : public classbase
350 /** Default constructor
351 * Creates a module class.
352 * @param Me An instance of the Server class which can be saved for future use
353 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
357 /** Default destructor
358 * destroys a module class
362 /** Returns the version number of a Module.
363 * The method should return a Version object with its version information assigned via
366 virtual Version GetVersion();
368 /** The Implements function specifies which methods a module should receive events for.
369 * The char* parameter passed to this function contains a set of true or false values
370 * (1 or 0) which indicate wether each function is implemented. You must use the Iimplementation
371 * enum (documented elsewhere on this page) to mark functions as active. For example, to
372 * receive events for OnUserJoin():
374 * Implements[I_OnUserJoin] = 1;
376 * @param The implement list
378 virtual void Implements(char* Implements);
380 /** Used to set the 'priority' of a module (e.g. when it is called in relation to other modules.
381 * Some modules prefer to be called before other modules, due to their design. For example, a
382 * module which is expected to operate on complete information would expect to be placed last, so
383 * that any other modules which wish to adjust that information would execute before it, to be sure
384 * its information is correct. You can change your module's priority by returning one of:
386 * PRIORITY_FIRST - To place your module first in the list
388 * PRIORITY_LAST - To place your module last in the list
390 * PRIORITY_DONTCARE - To leave your module as it is (this is the default value, if you do not implement this function)
392 * The result of Server::PriorityBefore() - To move your module before another named module
394 * The result of Server::PriorityLast() - To move your module after another named module
396 * For a good working example of this method call, please see src/modules/m_spanningtree.cpp
397 * and src/modules/m_hostchange.so which make use of it. It is highly recommended that unless
398 * your module has a real need to reorder its priority, it should not implement this function,
399 * as many modules changing their priorities can make the system redundant.
401 virtual Priority Prioritize();
403 /** Called when a user connects.
404 * The details of the connecting user are available to you in the parameter userrec *user
405 * @param user The user who is connecting
407 virtual void OnUserConnect(userrec* user);
409 /** Called when a user quits.
410 * The details of the exiting user are available to you in the parameter userrec *user
411 * This event is only called when the user is fully registered when they quit. To catch
412 * raw disconnections, use the OnUserDisconnect method.
413 * @param user The user who is quitting
414 * @param message The user's quit message
416 virtual void OnUserQuit(userrec* user, std::string message);
418 /** Called whenever a user's socket is closed.
419 * The details of the exiting user are available to you in the parameter userrec *user
420 * This event is called for all users, registered or not, as a cleanup method for modules
421 * which might assign resources to user, such as dns lookups, objects and sockets.
422 * @param user The user who is disconnecting
424 virtual void OnUserDisconnect(userrec* user);
426 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
427 * @param chan The channel being deleted
429 virtual void OnChannelDelete(chanrec* chan);
431 /** Called when a user joins a channel.
432 * The details of the joining user are available to you in the parameter userrec *user,
433 * and the details of the channel they have joined is available in the variable chanrec *channel
434 * @param user The user who is joining
435 * @param channel The channel being joined
437 virtual void OnUserJoin(userrec* user, chanrec* channel);
439 /** Called when a user parts a channel.
440 * The details of the leaving user are available to you in the parameter userrec *user,
441 * and the details of the channel they have left is available in the variable chanrec *channel
442 * @param user The user who is parting
443 * @param channel The channel being parted
444 * @param partmessage The part message, or an empty string
446 virtual void OnUserPart(userrec* user, chanrec* channel, std::string partmessage);
448 /** Called on rehash.
449 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
450 * system. You should use it to reload any files so that your module keeps in step with the
451 * rest of the application. If a parameter is given, the core has done nothing. The module
452 * receiving the event can decide if this parameter has any relevence to it.
453 * @param parameter The (optional) parameter given to REHASH from the user.
455 virtual void OnRehash(std::string parameter);
457 /** Called when a raw command is transmitted or received.
458 * This method is the lowest level of handler available to a module. It will be called with raw
459 * data which is passing through a connected socket. If you wish, you may munge this data by changing
460 * the string parameter "raw". If you do this, after your function exits it will immediately be
461 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
462 * inbound is set to true) the value of user will be the userrec of the connection sending the
463 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
464 * @param raw The raw string in RFC1459 format
465 * @param inbound A flag to indicate wether the data is coming into the daemon or going out to the user
466 * @param user The user record sending the text, when inbound == true.
468 virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
470 /** Called whenever an extended mode is to be processed.
471 * The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being
472 * changed. mode_on is set when the mode is being set, in which case params contains a list of
473 * parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters
474 * may contain the parameters for the mode, dependent on wether they were defined when a mode handler
475 * was set up with Server::AddExtendedMode
476 * If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*.
477 * You must cast this value yourself to make use of it.
478 * @param user The user issuing the mode
479 * @param target The user or channel having the mode set on them
480 * @param modechar The mode character being set
481 * @param type The type of mode (user or channel) being set
482 * @param mode_on True if the mode is being set, false if it is being unset
483 * @param params A list of parameters for any channel mode (currently supports either 0 or 1 parameters)
485 virtual int OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list ¶ms);
487 /** Called whenever a user is about to join a channel, before any processing is done.
488 * Returning a value of 1 from this function stops the process immediately, causing no
489 * output to be sent to the user by the core. If you do this you must produce your own numerics,
490 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
491 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
495 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
496 * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
497 * processing on the actual channel record at this point, however the channel NAME will still be passed in
498 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
499 * @param user The user joining the channel
500 * @param cname The channel name being joined
501 * @return 1 To prevent the join, 0 to allow it.
503 virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname);
505 /** Called whenever a user is about to be kicked.
506 * Returning a value of 1 from this function stops the process immediately, causing no
507 * output to be sent to the user by the core. If you do this you must produce your own numerics,
509 * @param source The user issuing the kick
510 * @param user The user being kicked
511 * @param chan The channel the user is being kicked from
512 * @param reason The kick reason
513 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
515 virtual int OnUserPreKick(userrec* source, userrec* user, chanrec* chan, std::string reason);
517 /** Called whenever a user is kicked.
518 * If this method is called, the kick is already underway and cannot be prevented, so
519 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
520 * @param source The user issuing the kick
521 * @param user The user being kicked
522 * @param chan The channel the user is being kicked from
523 * @param reason The kick reason
525 virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, std::string reason);
527 /** Called whenever a user opers locally.
528 * The userrec will contain the oper mode 'o' as this function is called after any modifications
529 * are made to the user's structure by the core.
530 * @param user The user who is opering up
531 * @param opertype The opers type name
533 virtual void OnOper(userrec* user, std::string opertype);
535 /** Called after a user opers locally.
536 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
537 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
538 * out the OPERTYPE, etc.
539 * @param user The user who is opering up
540 * @param opertype The opers type name
542 virtual void OnPostOper(userrec* user, std::string opertype);
544 /** Called whenever a user types /INFO.
545 * The userrec will contain the information of the user who typed the command. Modules may use this
546 * method to output their own credits in /INFO (which is the ircd's version of an about box).
547 * It is purposefully not possible to modify any info that has already been output, or halt the list.
548 * You must write a 371 numeric to the user, containing your info in the following format:
550 * <nick> :information here
552 * @param user The user issuing /INFO
554 virtual void OnInfo(userrec* user);
556 /** Called whenever a /WHOIS is performed on a local user.
557 * The source parameter contains the details of the user who issued the WHOIS command, and
558 * the dest parameter contains the information of the user they are whoising.
559 * @param source The user issuing the WHOIS command
560 * @param dest The user who is being WHOISed
562 virtual void OnWhois(userrec* source, userrec* dest);
564 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
565 * Returning 1 from this function stops the process immediately, causing no
566 * output to be sent to the user by the core. If you do this you must produce your own numerics,
567 * notices etc. This is useful for modules which may want to filter invites to channels.
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
571 * @return 1 to deny the invite, 0 to allow
573 virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel);
575 /** Called after a user has been successfully invited to a channel.
576 * You cannot prevent the invite from occuring using this function, to do that,
577 * use OnUserPreInvite instead.
578 * @param source The user who is issuing the INVITE
579 * @param dest The user being invited
580 * @param channel The channel the user is being invited to
582 virtual void OnUserInvite(userrec* source,userrec* dest,chanrec* channel);
584 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
585 * Returning any nonzero value from this function stops the process immediately, causing no
586 * output to be sent to the user by the core. If you do this you must produce your own numerics,
587 * notices etc. This is useful for modules which may want to filter or redirect messages.
588 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
589 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
590 * of where the message is destined to be sent.
591 * @param user The user sending the message
592 * @param dest The target of the message (chanrec* or userrec*)
593 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
594 * @param text Changeable text being sent by the user
595 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
596 * @return 1 to deny the NOTICE, 0 to allow it
598 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text,char status);
600 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
601 * Returning any nonzero value from this function stops the process immediately, causing no
602 * output to be sent to the user by the core. If you do this you must produce your own numerics,
603 * notices etc. This is useful for modules which may want to filter or redirect messages.
604 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
605 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
606 * of where the message is destined to be sent.
607 * You may alter the message text as you wish before relinquishing control to the next module
608 * in the chain, and if no other modules block the text this altered form of the text will be sent out
609 * to the user and possibly to other servers.
610 * @param user The user sending the message
611 * @param dest The target of the message (chanrec* or userrec*)
612 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
613 * @param text Changeable text being sent by the user
614 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
615 * @return 1 to deny the NOTICE, 0 to allow it
617 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text,char status);
619 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
620 * Please note that although you can see remote nickchanges through this function, you should
621 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
622 * check user->server before taking any action (including returning nonzero from the method).
623 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
624 * module to generate some meaninful output.
625 * @param user The username changing their nick
626 * @param newnick Their new nickname
627 * @return 1 to deny the change, 0 to allow
629 virtual int OnUserPreNick(userrec* user, std::string newnick);
631 /** Called after any PRIVMSG sent from a user.
632 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
633 * if target_type is TYPE_CHANNEL.
634 * @param user The user sending the message
635 * @param dest The target of the message
636 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
637 * @param text the text being sent by the user
638 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
640 virtual void OnUserMessage(userrec* user, void* dest, int target_type, std::string text, char status);
642 /** Called after any NOTICE sent from a user.
643 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
644 * if target_type is TYPE_CHANNEL.
645 * @param user The user sending the message
646 * @param dest The target of the message
647 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
648 * @param text the text being sent by the user
649 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
651 virtual void OnUserNotice(userrec* user, void* dest, int target_type, std::string text, char status);
653 /** Called after every MODE command sent from a user
654 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
655 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
656 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
657 * @param user The user sending the MODEs
658 * @param dest The target of the modes (userrec* or chanrec*)
659 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
660 * @param text The actual modes and their parameters if any
662 virtual void OnMode(userrec* user, void* dest, int target_type, std::string text);
664 /** Allows modules to alter or create server descriptions
665 * Whenever a module requires a server description, for example for display in
666 * WHOIS, this function is called in all modules. You may change or define the
667 * description given in std::string &description. If you do, this description
668 * will be shown in the WHOIS fields.
669 * @param servername The servername being searched for
670 * @param description Alterable server description for this server
672 virtual void OnGetServerDescription(std::string servername,std::string &description);
674 /** Allows modules to synchronize data which relates to users during a netburst.
675 * When this function is called, it will be called from the module which implements
676 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
677 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
678 * (see below). This function will be called for every user visible on your side
679 * of the burst, allowing you to for example set modes, etc. Do not use this call to
680 * synchronize data which you have stored using class Extensible -- There is a specialist
681 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
682 * @param user The user being syncronized
683 * @param proto A pointer to the module handling network protocol
684 * @param opaque An opaque pointer set by the protocol module, should not be modified!
686 virtual void OnSyncUser(userrec* user, Module* proto, void* opaque);
688 /** Allows modules to synchronize data which relates to channels during a netburst.
689 * When this function is called, it will be called from the module which implements
690 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
691 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
692 * (see below). This function will be called for every user visible on your side
693 * of the burst, allowing you to for example set modes, etc. Do not use this call to
694 * synchronize data which you have stored using class Extensible -- There is a specialist
695 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
697 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
699 * @param chan The channel being syncronized
700 * @param proto A pointer to the module handling network protocol
701 * @param opaque An opaque pointer set by the protocol module, should not be modified!
703 virtual void OnSyncChannel(chanrec* chan, Module* proto, void* opaque);
705 /* Allows modules to syncronize metadata related to channels over the network during a netburst.
706 * Whenever the linking module wants to send out data, but doesnt know what the data
707 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
708 * this method is called.You should use the ProtoSendMetaData function after you've
709 * correctly decided how the data should be represented, to send the metadata on its way if it belongs
710 * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
711 * @param chan The channel whos metadata is being syncronized
712 * @param proto A pointer to the module handling network protocol
713 * @param opaque An opaque pointer set by the protocol module, should not be modified!
714 * @param extname The extensions name which is being searched for
716 virtual void OnSyncChannelMetaData(chanrec* chan, Module* proto,void* opaque, std::string extname);
718 /* Allows modules to syncronize metadata related to users over the network during a netburst.
719 * Whenever the linking module wants to send out data, but doesnt know what the data
720 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
721 * this method is called. You should use the ProtoSendMetaData function after you've
722 * correctly decided how the data should be represented, to send the metadata on its way if
723 * if it belongs to your module.
724 * @param user The user whos metadata is being syncronized
725 * @param proto A pointer to the module handling network protocol
726 * @param opaque An opaque pointer set by the protocol module, should not be modified!
727 * @param extname The extensions name which is being searched for
729 virtual void OnSyncUserMetaData(userrec* user, Module* proto,void* opaque, std::string extname);
731 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
732 * Whenever the linking module wants to send out data, but doesnt know what the data
733 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
734 * this method is called. You should use the ProtoSendMetaData function after you've
735 * correctly decided how the data should be represented, to send the metadata on its way if
736 * if it belongs to your module.
737 * @param proto A pointer to the module handling network protocol
738 * @param opaque An opaque pointer set by the protocol module, should not be modified!
740 virtual void OnSyncOtherMetaData(Module* proto, void* opaque);
742 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
743 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
744 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
745 * @param target The chanrec* or userrec* that data should be added to
746 * @param extname The extension name which is being sent
747 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
749 virtual void OnDecodeMetaData(int target_type, void* target, std::string extname, std::string extdata);
751 /** Implemented by modules which provide the ability to link servers.
752 * These modules will implement this method, which allows transparent sending of servermodes
753 * down the network link as a broadcast, without a module calling it having to know the format
754 * of the MODE command before the actual mode string.
756 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
757 * of how to use this function.
759 * @param opaque An opaque pointer set by the protocol module, should not be modified!
760 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
761 * @param target The chanrec* or userrec* that modes should be sent for
762 * @param modeline The modes and parameters to be sent
764 virtual void ProtoSendMode(void* opaque, int target_type, void* target, std::string modeline);
766 /** Implemented by modules which provide the ability to link servers.
767 * These modules will implement this method, which allows metadata (extra data added to
768 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
769 * to other servers on a netburst and decoded at the other end by the same module on a
772 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
773 * how to use this function.
774 * @param opaque An opaque pointer set by the protocol module, should not be modified!
775 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
776 * @param target The chanrec* or userrec* that metadata should be sent for
777 * @param extname The extension name to send metadata for
778 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
780 virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, std::string extname, std::string extdata);
782 /** Called after every WALLOPS command.
783 * @param user The user sending the WALLOPS
784 * @param text The content of the WALLOPS message
786 virtual void OnWallops(userrec* user, std::string text);
788 /** Called whenever a user's hostname is changed.
789 * This event triggers after the host has been set.
790 * @param user The user whos host is being changed
791 * @param newhost The new hostname being set
793 virtual void OnChangeHost(userrec* user, std::string newhost);
795 /** Called whenever a user's GECOS (realname) is changed.
796 * This event triggers after the name has been set.
797 * @param user The user who's GECOS is being changed
798 * @param gecos The new GECOS being set on the user
800 virtual void OnChangeName(userrec* user, std::string gecos);
802 /** Called whenever a gline is added by a local user.
803 * This method is triggered after the line is added.
804 * @param duration The duration of the line in seconds
805 * @param source The sender of the line
806 * @param reason The reason text to be displayed
807 * @param hostmask The hostmask to add
809 virtual void OnAddGLine(long duration, userrec* source, std::string reason, std::string hostmask);
811 /** Called whenever a zline is added by a local user.
812 * This method is triggered after the line is added.
813 * @param duration The duration of the line in seconds
814 * @param source The sender of the line
815 * @param reason The reason text to be displayed
816 * @param ipmask The hostmask to add
818 virtual void OnAddZLine(long duration, userrec* source, std::string reason, std::string ipmask);
820 /** Called whenever a kline is added by a local user.
821 * This method is triggered after the line is added.
822 * @param duration The duration of the line in seconds
823 * @param source The sender of the line
824 * @param reason The reason text to be displayed
825 * @param hostmask The hostmask to add
827 virtual void OnAddKLine(long duration, userrec* source, std::string reason, std::string hostmask);
829 /** Called whenever a qline is added by a local user.
830 * This method is triggered after the line is added.
831 * @param duration The duration of the line in seconds
832 * @param source The sender of the line
833 * @param reason The reason text to be displayed
834 * @param nickmask The hostmask to add
836 virtual void OnAddQLine(long duration, userrec* source, std::string reason, std::string nickmask);
838 /** Called whenever a eline is added by a local user.
839 * This method is triggered after the line is added.
840 * @param duration The duration of the line in seconds
841 * @param source The sender of the line
842 * @param reason The reason text to be displayed
843 * @param hostmask The hostmask to add
845 virtual void OnAddELine(long duration, userrec* source, std::string reason, std::string hostmask);
847 /** Called whenever a gline is deleted.
848 * This method is triggered after the line is deleted.
849 * @param source The user removing the line
850 * @param hostmask The hostmask to delete
852 virtual void OnDelGLine(userrec* source, std::string hostmask);
854 /** Called whenever a zline is deleted.
855 * This method is triggered after the line is deleted.
856 * @param source The user removing the line
857 * @param hostmask The hostmask to delete
859 virtual void OnDelZLine(userrec* source, std::string ipmask);
861 /** Called whenever a kline is deleted.
862 * This method is triggered after the line is deleted.
863 * @param source The user removing the line
864 * @param hostmask The hostmask to delete
866 virtual void OnDelKLine(userrec* source, std::string hostmask);
868 /** Called whenever a qline is deleted.
869 * This method is triggered after the line is deleted.
870 * @param source The user removing the line
871 * @param hostmask The hostmask to delete
873 virtual void OnDelQLine(userrec* source, std::string nickmask);
875 /** Called whenever a eline is deleted.
876 * This method is triggered after the line is deleted.
877 * @param source The user removing the line
878 * @param hostmask The hostmask to delete
880 virtual void OnDelELine(userrec* source, std::string hostmask);
882 /** Called before your module is unloaded to clean up Extensibles.
883 * This method is called once for every user and channel on the network,
884 * so that when your module unloads it may clear up any remaining data
885 * in the form of Extensibles added using Extensible::Extend().
886 * If the target_type variable is TYPE_USER, then void* item refers to
887 * a userrec*, otherwise it refers to a chanrec*.
888 * @param target_type The type of item being cleaned
889 * @param item A pointer to the item's class
891 virtual void OnCleanup(int target_type, void* item);
893 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
894 * have been applied. Please note that although you can see remote nickchanges through this function, you should
895 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
896 * check user->server before taking any action (including returning nonzero from the method).
897 * Because this method is called after the nickchange is taken place, no return values are possible
898 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
899 * @param user The user changing their nick
900 * @param oldnick The old nickname of the user before the nickchange
902 virtual void OnUserPostNick(userrec* user, std::string oldnick);
904 /** Called before an action which requires a channel privilage check.
905 * This function is called before many functions which check a users status on a channel, for example
906 * before opping a user, deopping a user, kicking a user, etc.
907 * There are several values for access_type which indicate for what reason access is being checked.
909 * AC_KICK (0) - A user is being kicked<br>
910 * AC_DEOP (1) - a user is being deopped<br>
911 * AC_OP (2) - a user is being opped<br>
912 * AC_VOICE (3) - a user is being voiced<br>
913 * AC_DEVOICE (4) - a user is being devoiced<br>
914 * AC_HALFOP (5) - a user is being halfopped<br>
915 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
916 * AC_INVITE (7) - a user is being invited<br>
917 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
918 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
919 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
920 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
921 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
922 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
923 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
924 * @param source The source of the access check
925 * @param dest The destination of the access check
926 * @param channel The channel which is being checked
927 * @param access_type See above
929 virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
931 /** Called when a 005 numeric is about to be output.
932 * The module should modify the 005 numeric if needed to indicate its features.
933 * @param output The 005 string to be modified if neccessary.
935 virtual void On005Numeric(std::string &output);
937 /** Called when a client is disconnected by KILL.
938 * If a client is killed by a server, e.g. a nickname collision or protocol error,
940 * Return 1 from this function to prevent the kill, and 0 from this function to allow
941 * it as normal. If you prevent the kill no output will be sent to the client, it is
942 * down to your module to generate this information.
943 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
944 * If you do so youre risking race conditions, desyncs and worse!
945 * @param source The user sending the KILL
946 * @param dest The user being killed
947 * @param reason The kill reason
948 * @return 1 to prevent the kill, 0 to allow
950 virtual int OnKill(userrec* source, userrec* dest, std::string reason);
952 /** Called when an oper wants to disconnect a remote user via KILL
953 * @param source The user sending the KILL
954 * @param dest The user being killed
955 * @param reason The kill reason
957 virtual void OnRemoteKill(userrec* source, userrec* dest, std::string reason);
959 /** Called whenever a module is loaded.
960 * mod will contain a pointer to the module, and string will contain its name,
961 * for example m_widgets.so. This function is primary for dependency checking,
962 * your module may decide to enable some extra features if it sees that you have
963 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
964 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
965 * but instead operate under reduced functionality, unless the dependency is
966 * absolutely neccessary (e.g. a module that extends the features of another
968 * @param mod A pointer to the new module
969 * @param name The new module's filename
971 virtual void OnLoadModule(Module* mod,std::string name);
973 /** Called whenever a module is unloaded.
974 * mod will contain a pointer to the module, and string will contain its name,
975 * for example m_widgets.so. This function is primary for dependency checking,
976 * your module may decide to enable some extra features if it sees that you have
977 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
978 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
979 * but instead operate under reduced functionality, unless the dependency is
980 * absolutely neccessary (e.g. a module that extends the features of another
982 * @param mod Pointer to the module being unloaded (still valid)
983 * @param name The filename of the module being unloaded
985 virtual void OnUnloadModule(Module* mod,std::string name);
987 /** Called once every five seconds for background processing.
988 * This timer can be used to control timed features. Its period is not accurate
989 * enough to be used as a clock, but it is gauranteed to be called at least once in
990 * any five second period, directly from the main loop of the server.
991 * @param curtime The current timer derived from time(2)
993 virtual void OnBackgroundTimer(time_t curtime);
995 /** Called whenever a list is needed for a listmode.
996 * For example, when a /MODE #channel +b (without any other parameters) is called,
997 * if a module was handling +b this function would be called. The function can then
998 * output any lists it wishes to. Please note that all modules will see all mode
999 * characters to provide the ability to extend each other, so please only output
1000 * a list if the mode character given matches the one(s) you want to handle.
1001 * @param user The user requesting the list
1002 * @param channel The channel the list is for
1003 * @param mode The listmode which a list is being requested on
1005 virtual void OnSendList(userrec* user, chanrec* channel, char mode);
1007 /** Called whenever any command is about to be executed.
1008 * This event occurs for all registered commands, wether they are registered in the core,
1009 * or another module, but it will not occur for invalid commands (e.g. ones which do not
1010 * exist within the command table). By returning 1 from this method you may prevent the
1011 * command being executed. If you do this, no output is created by the core, and it is
1012 * down to your module to produce any output neccessary.
1013 * Note that unless you return 1, you should not destroy any structures (e.g. by using
1014 * Server::QuitUser) otherwise when the command's handler function executes after your
1015 * method returns, it will be passed an invalid pointer to the user object and crash!)
1016 * @param command The command being executed
1017 * @param parameters An array of array of characters containing the parameters for the command
1018 * @param pcnt The nuimber of parameters passed to the command
1019 * @param user the user issuing the command
1020 * @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.
1021 * @return 1 to block the command, 0 to allow
1023 virtual int OnPreCommand(std::string command, char **parameters, int pcnt, userrec *user, bool validated);
1025 /** Called to check if a user who is connecting can now be allowed to register
1026 * If any modules return false for this function, the user is held in the waiting
1027 * state until all modules return true. For example a module which implements ident
1028 * lookups will continue to return false for a user until their ident lookup is completed.
1029 * Note that the registration timeout for a user overrides these checks, if the registration
1030 * timeout is reached, the user is disconnected even if modules report that the user is
1031 * not ready to connect.
1032 * @param user The user to check
1033 * @return true to indicate readiness, false if otherwise
1035 virtual bool OnCheckReady(userrec* user);
1037 /** Called whenever a user is about to register their connection (e.g. before the user
1038 * is sent the MOTD etc). Modules can use this method if they are performing a function
1039 * which must be done before the actual connection is completed (e.g. ident lookups,
1040 * dnsbl lookups, etc).
1041 * Note that you should NOT delete the user record here by causing a disconnection!
1042 * Use OnUserConnect for that instead.
1043 * @param user The user registering
1045 virtual void OnUserRegister(userrec* user);
1047 /** Called whenever a mode character is processed.
1048 * Return 1 from this function to block the mode character from being processed entirely,
1049 * so that you may perform your own code instead. Note that this method allows you to override
1050 * modes defined by other modes, but this is NOT RECOMMENDED!
1051 * @param user The user who is sending the mode
1052 * @param chan The channel the mode is being sent to
1053 * @param mode The mode character being set
1054 * @param param The parameter for the mode or an empty string
1055 * @param adding true of the mode is being added, false if it is being removed
1056 * @param pcnt The parameter count for the mode (0 or 1)
1057 * @return 1 to deny the mode, 0 to allow
1059 virtual int OnRawMode(userrec* user, chanrec* chan, char mode, std::string param, bool adding, int pcnt);
1061 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1062 * This method will always be called for each join, wether or not the channel is actually +i, and
1063 * determines the outcome of an if statement around the whole section of invite checking code.
1064 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1065 * @param user The user joining the channel
1066 * @param chan The channel being joined
1067 * @return 1 to explicitly allow the join, 0 to proceed as normal
1069 virtual int OnCheckInvite(userrec* user, chanrec* chan);
1071 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1072 * This method will always be called for each join, wether or not the channel is actually +k, and
1073 * determines the outcome of an if statement around the whole section of key checking code.
1074 * if the user specified no key, the keygiven string will be a valid but empty value.
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 OnCheckKey(userrec* user, chanrec* chan, std::string keygiven);
1082 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1083 * This method will always be called for each join, wether or not the channel is actually +l, and
1084 * determines the outcome of an if statement around the whole section of channel limit 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 OnCheckLimit(userrec* user, chanrec* chan);
1092 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
1093 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
1094 * determines the outcome of an if statement around the whole section of ban checking code.
1095 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1096 * @param user The user joining the channel
1097 * @param chan The channel being joined
1098 * @return 1 to explicitly allow the join, 0 to proceed as normal
1100 virtual int OnCheckBan(userrec* user, chanrec* chan);
1102 /** Called on all /STATS commands
1103 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1104 * @param symbol the symbol provided to /STATS
1105 * @user the user issuing the /STATS command
1106 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1108 virtual int OnStats(char symbol, userrec* user);
1110 /** Called whenever a change of a local users displayed host is attempted.
1111 * Return 1 to deny the host change, or 0 to allow it.
1112 * @param user The user whos host will be changed
1113 * @param newhost The new hostname
1114 * @return 1 to deny the host change, 0 to allow
1116 virtual int OnChangeLocalUserHost(userrec* user, std::string newhost);
1118 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1119 * return 1 to deny the name change, or 0 to allow it.
1120 * @param user The user whos GECOS will be changed
1121 * @param newhost The new GECOS
1122 * @return 1 to deny the GECOS change, 0 to allow
1124 virtual int OnChangeLocalUserGECOS(userrec* user, std::string newhost);
1126 /** Called whenever a topic is changed by a local user.
1127 * Return 1 to deny the topic change, or 0 to allow it.
1128 * @param user The user changing the topic
1129 * @param chan The channels who's topic is being changed
1130 * @param topic The actual topic text
1131 * @param 1 to block the topic change, 0 to allow
1133 virtual int OnLocalTopicChange(userrec* user, chanrec* chan, std::string topic);
1135 /** Called whenever a local topic has been changed.
1136 * To block topic changes you must use OnLocalTopicChange instead.
1137 * @param user The user changing the topic
1138 * @param chan The channels who's topic is being changed
1139 * @param topic The actual topic text
1141 virtual void OnPostLocalTopicChange(userrec* user, chanrec* chan, std::string topic);
1143 /** Called whenever an Event class is sent to all module by another module.
1144 * Please see the documentation of Event::Send() for further information. The Event sent can
1145 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1146 * before doing anything to the event data, and you should *not* change the event data in any way!
1147 * @param event The Event class being received
1149 virtual void OnEvent(Event* event);
1151 /** Called whenever a Request class is sent to your module by another module.
1152 * Please see the documentation of Request::Send() for further information. The Request sent
1153 * can always be assumed to be non-NULL, you should not change the request object or its data.
1154 * Your method may return arbitary data in the char* result which the requesting module
1155 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1156 * @param request The Request class being received
1158 virtual char* OnRequest(Request* request);
1160 /** Called whenever an oper password is to be compared to what a user has input.
1161 * The password field (from the config file) is in 'password' and is to be compared against
1162 * 'input'. This method allows for encryption of oper passwords and much more besides.
1163 * You should return a nonzero value if you want to allow the comparison or zero if you wish
1165 * @param password The oper's password
1166 * @param input The password entered
1167 * @return 1 to match the passwords, 0 to do nothing
1169 virtual int OnOperCompare(std::string password, std::string input);
1171 /** Called whenever a user is given usermode +o, anywhere on the network.
1172 * You cannot override this and prevent it from happening as it is already happened and
1173 * such a task must be performed by another server. You can however bounce modes by sending
1174 * servermodes out to reverse mode changes.
1175 * @param user The user who is opering
1177 virtual void OnGlobalOper(userrec* user);
1179 /** Called whenever a user connects, anywhere on the network.
1180 * This event is informational only. You should not change any user information in this
1181 * event. To do so, use the OnUserConnect method to change the state of local users.
1182 * @param user The user who is connecting
1184 virtual void OnGlobalConnect(userrec* user);
1186 /** Called whenever a ban is added to a channel's list.
1187 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1188 * @param source The user adding the ban
1189 * @param channel The channel the ban is being added to
1190 * @param banmask The ban mask being added
1191 * @return 1 to block the ban, 0 to continue as normal
1193 virtual int OnAddBan(userrec* source, chanrec* channel,std::string banmask);
1195 /** Called whenever a ban is removed from a channel's list.
1196 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1197 * @param source The user deleting the ban
1198 * @param channel The channel the ban is being deleted from
1199 * @param banmask The ban mask being deleted
1200 * @return 1 to block the unban, 0 to continue as normal
1202 virtual int OnDelBan(userrec* source, chanrec* channel,std::string banmask);
1204 /** Called immediately after any connection is accepted. This is intended for raw socket
1205 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1206 * no information relating to a user record as the connection has not been assigned yet.
1207 * There are no return values from this call as all modules get an opportunity if required to
1208 * process the connection.
1209 * @param fd The file descriptor returned from accept()
1210 * @param ip The IP address of the connecting user
1211 * @param localport The local port number the user connected to
1213 virtual void OnRawSocketAccept(int fd, std::string ip, int localport);
1215 /** Called immediately before any write() operation on a user's socket in the core. Because
1216 * this event is a low level event no user information is associated with it. It is intended
1217 * for use by modules which may wrap connections within another API such as SSL for example.
1218 * return a non-zero result if you have handled the write operation, in which case the core
1219 * will not call write().
1220 * @param fd The file descriptor of the socket
1221 * @param buffer A char* buffer being written
1222 * @param Number of characters to write
1223 * @return Number of characters actually written or 0 if you didn't handle the operation
1225 virtual int OnRawSocketWrite(int fd, char* buffer, int count);
1227 /** Called immediately before any socket is closed. When this event is called, shutdown()
1228 * has not yet been called on the socket.
1229 * @param fd The file descriptor of the socket prior to close()
1231 virtual void OnRawSocketClose(int fd);
1233 /** Called immediately before any read() operation on a client socket in the core.
1234 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1235 * when this event occurs.
1236 * Your event should return 1 if it has handled the reading itself, which prevents the core
1237 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1238 * the value of count. The value of readresult must be identical to an actual result that might
1239 * be returned from the read() system call, for example, number of bytes read upon success,
1240 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1241 * you MUST set readresult.
1242 * @param fd The file descriptor of the socket
1243 * @param buffer A char* buffer being read to
1244 * @param count The size of the buffer
1245 * @param readresult The amount of characters read, or 0
1246 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1248 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1250 virtual void OnSetAway(userrec* user);
1252 virtual void OnCancelAway(userrec* user);
1256 /** Allows server output and query functions
1257 * This class contains methods which allow a module to query the state of the irc server, and produce
1258 * output to users and other servers. All modules should instantiate at least one copy of this class,
1259 * and use its member functions to perform their tasks.
1261 class Server : public classbase
1264 /** Default constructor.
1265 * Creates a Server object.
1269 /** Default destructor.
1270 * Destroys a Server object.
1274 /** Obtains a pointer to the server's ServerConfig object.
1275 * The ServerConfig object contains most of the configuration data
1276 * of the IRC server, as read from the config file by the core.
1278 ServerConfig* GetConfig();
1280 /** For use with Module::Prioritize().
1281 * When the return value of this function is returned from
1282 * Module::Prioritize(), this specifies that the module wishes
1283 * to be ordered exactly BEFORE 'modulename'. For more information
1284 * please see Module::Prioritize().
1285 * @param modulename The module your module wants to be before in the call list
1286 * @returns a priority ID which the core uses to relocate the module in the list
1288 long PriorityBefore(std::string modulename);
1290 /** For use with Module::Prioritize().
1291 * When the return value of this function is returned from
1292 * Module::Prioritize(), this specifies that the module wishes
1293 * to be ordered exactly AFTER 'modulename'. For more information please
1294 * see Module::Prioritize().
1295 * @param modulename The module your module wants to be after in the call list
1296 * @returns a priority ID which the core uses to relocate the module in the list
1298 long PriorityAfter(std::string modulename);
1300 /** Sends text to all opers.
1301 * This method sends a server notice to all opers with the usermode +s.
1303 virtual void SendOpers(std::string s);
1305 /** Returns the version string of this server
1307 std::string GetVersion();
1309 /** Writes a log string.
1310 * This method writes a line of text to the log. If the level given is lower than the
1311 * level given in the configuration, this command has no effect.
1313 virtual void Log(int level, std::string s);
1315 /** Sends a line of text down a TCP/IP socket.
1316 * This method writes a line of text to an established socket, cutting it to 510 characters
1317 * plus a carriage return and linefeed if required.
1319 virtual void Send(int Socket, std::string s);
1321 /** Sends text from the server to a socket.
1322 * This method writes a line of text to an established socket, with the servername prepended
1323 * as used by numerics (see RFC 1459)
1325 virtual void SendServ(int Socket, std::string s);
1327 /** Writes text to a channel, but from a server, including all.
1328 * This can be used to send server notices to a group of users.
1330 virtual void SendChannelServerNotice(std::string ServName, chanrec* Channel, std::string text);
1332 /** Sends text from a user to a socket.
1333 * This method writes a line of text to an established socket, with the given user's nick/ident
1334 * /host combination prepended, as used in PRIVSG etc commands (see RFC 1459)
1336 virtual void SendFrom(int Socket, userrec* User, std::string s);
1338 /** Sends text from a user to another user.
1339 * This method writes a line of text to a user, with a user's nick/ident
1340 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459)
1341 * If you specify NULL as the source, then the data will originate from the
1342 * local server, e.g. instead of:
1344 * :user!ident@host TEXT
1346 * The format will become:
1350 * Which is useful for numerics and server notices to single users, etc.
1352 virtual void SendTo(userrec* Source, userrec* Dest, std::string s);
1354 /** Sends text from a user to a channel (mulicast).
1355 * This method writes a line of text to a channel, with the given user's nick/ident
1356 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the
1357 * IncludeSender flag is set, then the text is also sent back to the user from which
1358 * it originated, as seen in MODE (see RFC 1459).
1360 virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender);
1362 /** Returns true if two users share a common channel.
1363 * This method is used internally by the NICK and QUIT commands, and the Server::SendCommon
1366 virtual bool CommonChannels(userrec* u1, userrec* u2);
1368 /** Sends text from a user to one or more channels (mulicast).
1369 * This method writes a line of text to all users which share a common channel with a given
1370 * user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc
1371 * commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent
1372 * back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it
1373 * is only sent to the other recipients, as seen in QUIT.
1375 virtual void SendCommon(userrec* User, std::string text,bool IncludeSender);
1377 /** Sends a WALLOPS message.
1378 * This method writes a WALLOPS message to all users with the +w flag, originating from the
1381 virtual void SendWallops(userrec* User, std::string text);
1383 /** Returns true if a nick is valid.
1384 * Nicks for unregistered connections will return false.
1386 virtual bool IsNick(std::string nick);
1388 /** Returns a count of the number of users on a channel.
1389 * This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.
1391 virtual int CountUsers(chanrec* c);
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(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(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 /** Checks if a user is on a channel.
1415 * This function will return true or false to indicate if user 'User' is on channel 'Chan'.
1417 virtual bool IsOnChannel(userrec* User, chanrec* Chan);
1419 /** Returns the server name of the server where the module is loaded.
1421 virtual std::string GetServerName();
1423 /** Returns the network name, global to all linked servers.
1425 virtual std::string GetNetworkName();
1427 /** Returns the server description string of the local server
1429 virtual std::string GetServerDescription();
1431 /** Returns the information of the server as returned by the /ADMIN command.
1432 * See the Admin class for further information of the return value. The members
1433 * Admin::Nick, Admin::Email and Admin::Name contain the information for the
1434 * server where the module is loaded.
1436 virtual Admin GetAdmin();
1438 /** Adds an extended mode letter which is parsed by a module.
1439 * This allows modules to add extra mode letters, e.g. +x for hostcloak.
1440 * the "type" parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to
1441 * indicate wether the mode is a channel mode, a client mode, or a server mode.
1442 * requires_oper is used with MT_CLIENT type modes only to indicate the mode can only
1443 * be set or unset by an oper. If this is used for MT_CHANNEL type modes it is ignored.
1444 * params_when_on is the number of modes to expect when the mode is turned on
1445 * (for type MT_CHANNEL only), e.g. with mode +k, this would have a value of 1.
1446 * the params_when_off value has a similar value to params_when_on, except it indicates
1447 * the number of parameters to expect when the mode is disabled. Modes which act in a similar
1448 * way to channel mode +l (e.g. require a parameter to enable, but not to disable) should
1449 * use this parameter. The function returns false if the mode is unavailable, and will not
1450 * attempt to allocate another character, as this will confuse users. This also means that
1451 * as only one module can claim a specific mode character, the core does not need to keep track
1452 * of which modules own which modes, which speeds up operation of the server. In this version,
1453 * a mode can have at most one parameter, attempting to use more parameters will have undefined
1456 virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off);
1458 /** Adds an extended mode letter which is parsed by a module and handled in a list fashion.
1459 * This call is used to implement modes like +q and +a. The characteristics of these modes are
1462 * (1) They are ALWAYS on channels, not on users, therefore their type is MT_CHANNEL
1464 * (2) They always take exactly one parameter when being added or removed
1466 * (3) They can be set multiple times, usually on users in channels
1468 * (4) The mode and its parameter are NOT stored in the channels modes structure
1470 * It is down to the module handling the mode to maintain state and determine what 'items' (e.g. users,
1471 * or a banlist) have the mode set on them, and process the modes at the correct times, e.g. during access
1472 * checks on channels, etc. When the extended mode is triggered the OnExtendedMode method will be triggered
1473 * as above. Note that the target you are given will be a channel, if for example your mode is set 'on a user'
1474 * (in for example +a) you must use Server::Find to locate the user the mode is operating on.
1475 * Your mode handler may return 1 to handle the mode AND tell the core to display the mode change, e.g.
1476 * '+aaa one two three' in the case of the mode for 'two', or it may return -1 to 'eat' the mode change,
1477 * so the above example would become '+aa one three' after processing.
1479 virtual bool AddExtendedListMode(char modechar);
1481 /** Adds a command to the command table.
1482 * This allows modules to add extra commands into the command table. You must place a function within your
1483 * module which is is of type handlerfunc:
1485 * typedef void (handlerfunc) (char**, int, userrec*);
1487 * void handle_kill(char **parameters, int pcnt, userrec *user)
1489 * When the command is typed, the parameters will be placed into the parameters array (similar to argv) and
1490 * the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters
1491 * than the 'minparams' value you specified when creating the command. The *user parameter is the class of
1492 * the user which caused the command to trigger, who will always have the flag you specified in 'flags' when
1493 * creating the initial command. For example to create an oper only command create the commands with flags='o'.
1494 * The source parameter is used for resource tracking, and should contain the name of your module (with file
1495 * extension) e.g. "m_blarp.so". If you place the wrong identifier here, you can cause crashes if your module
1498 virtual void AddCommand(command_t *f);
1500 /** Sends a servermode.
1501 * you must format the parameters array with the target, modes and parameters for those modes.
1507 * modes[0] = ChannelName;
1511 * modes[2] = user->nick;
1513 * Srv->SendMode(modes,3,user);
1515 * The modes will originate from the server where the command was issued, however responses (e.g. numerics)
1516 * will be sent to the user you provide as the third parameter.
1517 * You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave
1518 * your server in an unstable state!
1521 virtual void SendMode(char **parameters, int pcnt, userrec *user);
1523 /** Sends to all users matching a mode mask
1524 * You must specify one or more usermodes as the first parameter. These can be RFC specified modes such as +i,
1525 * or module provided modes, including ones provided by your own module.
1526 * In the second parameter you must place a flag value which indicates wether the modes you have given will be
1527 * logically ANDed or OR'ed. You may use one of either WM_AND or WM_OR.
1528 * for example, if you were to use:
1530 * Serv->SendToModeMask("xi", WM_OR, "m00");
1532 * Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the
1533 * user must have both modes set to receive the message.
1535 virtual void SendToModeMask(std::string modes, int flags, std::string text);
1537 /** Forces a user to join a channel.
1538 * This is similar to svsjoin and can be used to implement redirection, etc.
1539 * On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to.
1540 * On failure, the result is NULL.
1542 virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key);
1544 /** Forces a user to part a channel.
1545 * This is similar to svspart and can be used to implement redirection, etc.
1546 * Although the return value of this function is a pointer to a channel record, the returned data is
1547 * undefined and should not be read or written to. This behaviour may be changed in a future version.
1549 virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason);
1551 /** Forces a user nickchange.
1552 * This command works similarly to SVSNICK, and can be used to implement Q-lines etc.
1553 * If you specify an invalid nickname, the nick change will be dropped and the target user will receive
1554 * the error numeric for it.
1556 virtual void ChangeUserNick(userrec* user, std::string nickname);
1558 /** Forces a user to quit with the specified reason.
1559 * To the user, it will appear as if they typed /QUIT themselves, except for the fact that this function
1560 * may bypass the quit prefix specified in the config file.
1564 * Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or
1565 * read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of
1566 * action after calling this method is to immediately bail from your handler.
1568 virtual void QuitUser(userrec* user, std::string reason);
1570 /** Makes a user kick another user, with the specified reason.
1571 * If source is NULL, the server will peform the kick.
1572 * @param The person or server (if NULL) performing the KICK
1573 * @param target The person being kicked
1574 * @param chan The channel to kick from
1575 * @param reason The kick reason
1577 virtual void KickUser(userrec* source, userrec* target, chanrec* chan, std::string reason);
1579 /** Matches text against a glob pattern.
1580 * Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com
1581 * Returns true if the literal successfully matches the pattern, false if otherwise.
1583 virtual bool MatchText(std::string sliteral, std::string spattern);
1585 /** Calls the handler for a command, either implemented by the core or by another module.
1586 * You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN,
1587 * KICK etc, or even as a method of callback. By defining command names that are untypeable
1588 * for users on irc (e.g. those which contain a \r or \n) you may use them as callback identifiers.
1589 * The first parameter to this method is the name of the command handler you wish to call, e.g.
1590 * PRIVMSG. This will be a command handler previously registered by the core or wih AddCommand().
1591 * The second parameter is an array of parameters, and the third parameter is a count of parameters
1592 * in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the
1593 * functiom will silently ignore it. The final parameter is the user executing the command handler,
1594 * used for privilage checks, etc.
1596 virtual void CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user);
1598 /** This function returns true if the commandname exists, pcnt is equal to or greater than the number
1599 * of paramters the command requires, the user specified is allowed to execute the command, AND
1600 * if the command is implemented by a module (not the core). This has a few specific uses, usually
1601 * within network protocols (see src/modules/m_spanningtree.cpp)
1603 virtual bool IsValidModuleCommand(std::string commandname, int pcnt, userrec* user);
1605 /** Change displayed hostname of a user.
1606 * You should always call this method to change a user's host rather than writing directly to the
1607 * dhost member of userrec, as any change applied via this method will be propogated to any
1610 virtual void ChangeHost(userrec* user, std::string host);
1612 /** Change GECOS (fullname) of a user.
1613 * You should always call this method to change a user's GECOS rather than writing directly to the
1614 * fullname member of userrec, as any change applied via this method will be propogated to any
1617 virtual void ChangeGECOS(userrec* user, std::string gecos);
1619 /** Returns true if the servername you give is ulined.
1620 * ULined servers have extra privilages. They are allowed to change nicknames on remote servers,
1621 * change modes of clients which are on remote servers and set modes of channels where there are
1622 * no channel operators for that channel on the ulined server, amongst other things.
1624 virtual bool IsUlined(std::string server);
1626 /** Fetches the userlist of a channel. This function must be here and not a member of userrec or
1627 * chanrec due to include constraints.
1629 virtual chanuserlist GetUsers(chanrec* chan);
1631 /** Remove a user's connection to the irc server, but leave their client in existence in the
1632 * user hash. When you call this function, the user's file descriptor will be replaced with the
1633 * value of FD_MAGIC_NUMBER and their old file descriptor will be closed. This idle client will
1634 * remain until it is restored with a valid file descriptor, or is removed from IRC by an operator
1635 * After this call, the pointer to user will be invalid.
1637 virtual bool UserToPseudo(userrec* user,std::string message);
1639 /** This user takes one user, and switches their file descriptor with another user, so that one user
1640 * "becomes" the other. The user in 'alive' is booted off the server with the given message. The user
1641 * referred to by 'zombie' should have previously been locked with Server::UserToPseudo, otherwise
1642 * stale sockets and file descriptor leaks can occur. After this call, the pointer to alive will be
1643 * invalid, and the pointer to zombie will be equivalent in effect to the old pointer to alive.
1645 virtual bool PseudoToUser(userrec* alive,userrec* zombie,std::string message);
1648 * The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1649 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1650 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1651 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1654 virtual void AddGLine(long duration, std::string source, std::string reason, std::string hostmask);
1657 * The Q-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1658 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1659 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1660 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1663 virtual void AddQLine(long duration, std::string source, std::string reason, std::string nickname);
1666 * The Z-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1667 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1668 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1669 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1672 virtual void AddZLine(long duration, std::string source, std::string reason, std::string ipaddr);
1675 * The K-line is enforced as soon as it is added.
1676 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1677 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1678 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1681 virtual void AddKLine(long duration, std::string source, std::string reason, std::string hostmask);
1684 * The E-line is enforced as soon as it is added.
1685 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1686 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1687 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1690 virtual void AddELine(long duration, std::string source, std::string reason, std::string hostmask);
1692 /** Deletes a G-Line from all servers
1694 virtual bool DelGLine(std::string hostmask);
1696 /** Deletes a Q-Line from all servers
1698 virtual bool DelQLine(std::string nickname);
1700 /** Deletes a Z-Line from all servers
1702 virtual bool DelZLine(std::string ipaddr);
1704 /** Deletes a local K-Line
1706 virtual bool DelKLine(std::string hostmask);
1708 /** Deletes a local E-Line
1710 virtual bool DelELine(std::string hostmask);
1712 /** Calculates a duration
1713 * This method will take a string containing a formatted duration (e.g. "1w2d") and return its value
1714 * as a total number of seconds. This is the same function used internally by /GLINE etc to set
1717 virtual long CalcDuration(std::string duration);
1719 /** Returns true if a nick!ident@host string is correctly formatted, false if otherwise.
1721 virtual bool IsValidMask(std::string mask);
1723 /** This function finds a module by name.
1724 * You must provide the filename of the module. If the module cannot be found (is not loaded)
1725 * the function will return NULL.
1727 virtual Module* FindModule(std::string name);
1729 /** Adds a class derived from InspSocket to the server's socket engine.
1731 virtual void AddSocket(InspSocket* sock);
1733 /** Forcibly removes a class derived from InspSocket from the servers socket engine.
1735 virtual void RemoveSocket(InspSocket* sock);
1737 /** Deletes a class derived from InspSocket from the server's socket engine.
1739 virtual void DelSocket(InspSocket* sock);
1741 virtual void RehashServer();
1743 virtual long GetChannelCount();
1745 virtual chanrec* GetChannelIndex(long index);
1749 #define CONF_NOT_A_NUMBER 0x000010
1750 #define CONF_NOT_UNSIGNED 0x000080
1751 #define CONF_VALUE_NOT_FOUND 0x000100
1752 #define CONF_FILE_NOT_FOUND 0x000200
1755 /** Allows reading of values from configuration files
1756 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1757 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1758 * Constructing the class using one parameter allows you to specify a path to your own configuration
1759 * file, otherwise, inspircd.conf is read.
1761 class ConfigReader : public classbase
1764 /** The contents of the configuration file
1765 * This protected member should never be accessed by a module (and cannot be accessed unless the
1766 * core is changed). It will contain a pointer to the configuration file data with unneeded data
1767 * (such as comments) stripped from it.
1769 std::stringstream *cache;
1770 std::stringstream *errorlog;
1771 /** Used to store errors
1777 /** Default constructor.
1778 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1779 * as specified when running ./configure.
1781 ConfigReader(); // default constructor reads ircd.conf
1782 /** Overloaded constructor.
1783 * This constructor initialises the ConfigReader class to read a user-specified config file
1785 ConfigReader(std::string filename); // read a module-specific config
1786 /** Default destructor.
1787 * This method destroys the ConfigReader class.
1790 /** Retrieves a value from the config file.
1791 * This method retrieves a value from the config file. Where multiple copies of the tag
1792 * exist in the config file, index indicates which of the values to retrieve.
1794 std::string ReadValue(std::string tag, std::string name, int index);
1795 /** Retrieves a boolean value from the config file.
1796 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1797 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1798 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1800 bool ReadFlag(std::string tag, std::string name, int index);
1801 /** Retrieves an integer value from the config file.
1802 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1803 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1804 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1805 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1806 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1807 * will return CONF_NOT_UNSIGNED
1809 long ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned);
1810 /** Returns the last error to occur.
1811 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1812 * A call to GetError() resets the error flag back to 0.
1815 /** Counts the number of times a given tag appears in the config file.
1816 * This method counts the number of times a tag appears in a config file, for use where
1817 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1818 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1819 * multiple instance tag.
1821 int Enumerate(std::string tag);
1822 /** Returns true if a config file is valid.
1823 * This method is partially implemented and will only return false if the config
1824 * file does not exist or could not be opened.
1827 /** Dumps the list of errors in a config file to an output location. If bail is true,
1828 * then the program will abort. If bail is false and user points to a valid user
1829 * record, the error report will be spooled to the given user by means of NOTICE.
1830 * if bool is false AND user is false, the error report will be spooled to all opers
1831 * by means of a NOTICE to all opers.
1833 void DumpErrors(bool bail,userrec* user);
1835 /** Returns the number of items within a tag.
1836 * For example if the tag was <test tag="blah" data="foo"> then this
1837 * function would return 2. Spaces and newlines both qualify as valid seperators
1840 int EnumerateValues(std::string tag, int index);
1845 /** Caches a text file into memory and can be used to retrieve lines from it.
1846 * This class contains methods for read-only manipulation of a text file in memory.
1847 * Either use the constructor type with one parameter to load a file into memory
1848 * at construction, or use the LoadFile method to load a file.
1850 class FileReader : public classbase
1854 /** Default constructor.
1855 * This method does not load any file into memory, you must use the LoadFile method
1856 * after constructing the class this way.
1860 /** Secondary constructor.
1861 * This method initialises the class with a file loaded into it ready for GetLine and
1862 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1865 FileReader(std::string filename);
1867 /** Default destructor.
1868 * This deletes the memory allocated to the file.
1872 /** Used to load a file.
1873 * This method loads a file into the class ready for GetLine and
1874 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1877 void LoadFile(std::string filename);
1879 /** Returns true if the file exists
1880 * This function will return false if the file could not be opened.
1884 /** Retrieve one line from the file.
1885 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1886 * the index was out of bounds, or the line had no data on it.
1888 std::string GetLine(int x);
1890 /** Returns the size of the file in lines.
1891 * This method returns the number of lines in the read file. If it is 0, no lines have been
1892 * read into memory, either because the file is empty or it does not exist, or cannot be
1893 * opened due to permission problems.
1899 /** Instantiates classes inherited from Module
1900 * This class creates a class inherited from type Module, using new. This is to allow for modules
1901 * to create many different variants of Module, dependent on architecture, configuration, etc.
1902 * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
1905 class ModuleFactory : public classbase
1909 virtual ~ModuleFactory() { }
1910 /** Creates a new module.
1911 * Your inherited class of ModuleFactory must return a pointer to your Module class
1912 * using this method.
1914 virtual Module * CreateModule(Server* Me) = 0;
1918 typedef DLLFactory<ModuleFactory> ircd_module;
1920 bool ModeDefined(char c, int i);
1921 bool ModeDefinedOper(char c, int i);
1922 int ModeDefinedOn(char c, int i);
1923 int ModeDefinedOff(char c, int i);
1924 void ModeMakeList(char modechar);
1925 bool ModeIsListMode(char modechar, int type);