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 {
80 /** Low level definition of a FileReader classes file cache area
82 typedef std::deque<std::string> file_cache;
83 typedef file_cache string_list;
85 /** Holds a list of users in a channel
87 typedef std::deque<userrec*> chanuserlist;
90 // This #define allows us to call a method in all
91 // loaded modules in a readable simple way, e.g.:
92 // 'FOREACH_MOD OnConnect(user);'
94 #define FOREACH_MOD(y,x) if (Config->global_implementation[y] > 0) { \
95 for (int _i = 0; _i <= MODCOUNT; _i++) { \
96 if (Config->implement_lists[_i][y]) \
101 catch (ModuleException& modexcept) \
103 log(DEBUG,"Module exception cought: %s",modexcept.GetReason()); \
108 // This define is similar to the one above but returns a result in MOD_RESULT.
109 // The first module to return a nonzero result is the value to be accepted,
110 // and any modules after are ignored.
112 // *********************************************************************************************
114 #define FOREACH_RESULT(y,x) { if (Config->global_implementation[y] > 0) { \
116 for (int _i = 0; _i <= MODCOUNT; _i++) { \
117 if (Config->implement_lists[_i][y]) {\
120 int res = modules[_i]->x ; \
126 catch (ModuleException& modexcept) \
128 log(DEBUG,"Module exception cought: %s",modexcept.GetReason()); \
135 // *********************************************************************************************
137 #define FD_MAGIC_NUMBER -42
141 #define IS_LOCAL(x) (x->fd > -1)
142 #define IS_REMOTE(x) (x->fd < 0)
143 #define IS_MODULE_CREATED(x) (x->fd == FD_MAGIC_NUMBER)
145 /*extern void createcommand(char* cmd, handlerfunc f, char flags, int minparams, char* source);
146 extern void server_mode(char **parameters, int pcnt, userrec *user);*/
148 // class Version holds the version information of a Module, returned
149 // by Module::GetVersion (thanks RD)
151 /** Holds a module's Version information
152 * The four members (set by the constructor only) indicate details as to the version number
153 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
155 class Version : public classbase
158 const int Major, Minor, Revision, Build, Flags;
159 Version(int major, int minor, int revision, int build, int flags);
162 /** Holds /ADMIN data
163 * This class contains the admin details of the local server. It is constructed by class Server,
164 * and has three read-only values, Name, Email and Nick that contain the specified values for the
165 * server where the module is running.
167 class Admin : public classbase
170 const std::string Name, Email, Nick;
171 Admin(std::string name, std::string email, std::string nick);
175 // Forward-delacare module for ModuleMessage etc
178 // Thanks to Rob (from anope) for the idea of this message passing API
179 // (its been done before, but this seemed a very neat and tidy way...
181 /** The ModuleMessage class is the base class of Request and Event
182 * This class is used to represent a basic data structure which is passed
183 * between modules for safe inter-module communications.
185 class ModuleMessage : public classbase
188 /** This class is pure virtual and must be inherited.
190 virtual char* Send() = 0;
191 virtual ~ModuleMessage() {};
194 /** The Request class is a unicast message directed at a given module.
195 * When this class is properly instantiated it may be sent to a module
196 * using the Send() method, which will call the given module's OnRequest
197 * method with this class as its parameter.
199 class Request : public ModuleMessage
202 /** This member holds a pointer to arbitary data set by the emitter of the message
205 /** This is a pointer to the sender of the message, which can be used to
206 * directly trigger events, or to create a reply.
209 /** The single destination of the Request
213 /** Create a new Request
215 Request(char* anydata, Module* src, Module* dst);
216 /** Fetch the Request data
219 /** Fetch the request source
222 /** Fetch the request destination (should be 'this' in the receiving module)
225 /** Send the Request.
226 * Upon returning the result will be arbitary data returned by the module you
227 * sent the request to. It is up to your module to know what this data is and
228 * how to deal with it.
234 /** The Event class is a unicast message directed at all modules.
235 * When the class is properly instantiated it may be sent to all modules
236 * using the Send() method, which will trigger the OnEvent method in
237 * all modules passing the object as its parameter.
239 class Event : public ModuleMessage
242 /** This member holds a pointer to arbitary data set by the emitter of the message
245 /** This is a pointer to the sender of the message, which can be used to
246 * directly trigger events, or to create a reply.
249 /** The event identifier.
250 * This is arbitary text which should be used to distinguish
251 * one type of event from another.
255 /** Create a new Event
257 Event(char* anydata, Module* src, std::string eventid);
258 /** Get the Event data
261 /** Get the event Source
264 /** Get the event ID.
265 * Use this to determine the event type for safe casting of the data
267 std::string GetEventID();
269 * The return result of an Event::Send() will always be NULL as
270 * no replies are expected.
275 /** Holds an extended mode's details.
276 * Used internally by modules.cpp
278 class ExtMode : public classbase
287 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) { };
291 /** This class can be used on its own to represent an exception, or derived to represent a module-specific exception.
292 * When a module whishes to abort, e.g. within a constructor, it should throw an exception using ModuleException or
293 * a class derived from ModuleException. If a module throws an exception during its constructor, the module will not
294 * be loaded. If this happens, the error message returned by ModuleException::GetReason will be displayed to the user
295 * attempting to load the module, or dumped to the console if the ircd is currently loading for the first time.
297 class ModuleException
300 /** Holds the error message to be displayed
304 /** Default constructor, just uses the error mesage 'Module threw an exception'.
306 ModuleException() : err("Module threw an exception") {}
307 /** This constructor can be used to specify an error message before throwing.
309 ModuleException(std::string message) : err(message) {}
310 /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
311 * Actually no, it does nothing. Never mind.
313 virtual ~ModuleException() {};
314 /** Returns the reason for the exception.
315 * The module should probably put something informative here as the user will see this upon failure.
317 virtual char *GetReason()
319 return (char*)err.c_str();
323 /** Priority types which can be returned from Module::Prioritize()
325 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
327 /** Implementation-specific flags which may be set in Module::Implements()
329 enum Implementation { I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash, I_OnServerRaw,
330 I_OnExtendedMode, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois, I_OnUserPreInvite,
331 I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick, I_OnUserMessage, I_OnUserNotice, I_OnMode,
332 I_OnGetServerDescription, I_OnSyncUser, I_OnSyncChannel, I_OnSyncChannelMetaData, I_OnSyncUserMetaData,
333 I_OnDecodeMetaData, I_ProtoSendMode, I_ProtoSendMetaData, I_OnWallops, I_OnChangeHost, I_OnChangeName, I_OnAddGLine,
334 I_OnAddZLine, I_OnAddQLine, I_OnAddKLine, I_OnAddELine, I_OnDelGLine, I_OnDelZLine, I_OnDelKLine, I_OnDelELine, I_OnDelQLine,
335 I_OnCleanup, I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule, I_OnUnloadModule,
336 I_OnBackgroundTimer, I_OnSendList, I_OnPreCommand, I_OnCheckReady, I_OnUserRrgister, I_OnRawMode, I_OnCheckInvite,
337 I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnLocalTopicChange,
338 I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnOperCompre, I_OnGlobalOper, I_OnGlobalConnect, I_OnAddBan, I_OnDelBan,
339 I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead, I_OnChangeLocalUserGECOS, I_OnUserRegister,
340 I_OnOperCompare, I_OnChannelDelete, I_OnPostOper, I_OnSyncOtherMetaData, I_OnSetAway, I_OnCancelAway };
342 /** Base class for all InspIRCd modules
343 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
344 * its methods will be called when irc server events occur. class inherited from module must be
345 * instantiated by the ModuleFactory class (see relevent section) for the plugin to be initialised.
347 class Module : public classbase
351 /** Default constructor
352 * Creates a module class.
353 * @param Me An instance of the Server class which can be saved for future use
354 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
358 /** Default destructor
359 * destroys a module class
363 /** Returns the version number of a Module.
364 * The method should return a Version object with its version information assigned via
367 virtual Version GetVersion();
369 /** The Implements function specifies which methods a module should receive events for.
370 * The char* parameter passed to this function contains a set of true or false values
371 * (1 or 0) which indicate wether each function is implemented. You must use the Iimplementation
372 * enum (documented elsewhere on this page) to mark functions as active. For example, to
373 * receive events for OnUserJoin():
375 * Implements[I_OnUserJoin] = 1;
377 * @param The implement list
379 virtual void Implements(char* Implements);
381 /** Used to set the 'priority' of a module (e.g. when it is called in relation to other modules.
382 * Some modules prefer to be called before other modules, due to their design. For example, a
383 * module which is expected to operate on complete information would expect to be placed last, so
384 * that any other modules which wish to adjust that information would execute before it, to be sure
385 * its information is correct. You can change your module's priority by returning one of:
387 * PRIORITY_FIRST - To place your module first in the list
389 * PRIORITY_LAST - To place your module last in the list
391 * PRIORITY_DONTCARE - To leave your module as it is (this is the default value, if you do not implement this function)
393 * The result of Server::PriorityBefore() - To move your module before another named module
395 * The result of Server::PriorityLast() - To move your module after another named module
397 * For a good working example of this method call, please see src/modules/m_spanningtree.cpp
398 * and src/modules/m_hostchange.so which make use of it. It is highly recommended that unless
399 * your module has a real need to reorder its priority, it should not implement this function,
400 * as many modules changing their priorities can make the system redundant.
402 virtual Priority Prioritize();
404 /** Called when a user connects.
405 * The details of the connecting user are available to you in the parameter userrec *user
406 * @param user The user who is connecting
408 virtual void OnUserConnect(userrec* user);
410 /** Called when a user quits.
411 * The details of the exiting user are available to you in the parameter userrec *user
412 * This event is only called when the user is fully registered when they quit. To catch
413 * raw disconnections, use the OnUserDisconnect method.
414 * @param user The user who is quitting
415 * @param message The user's quit message
417 virtual void OnUserQuit(userrec* user, std::string message);
419 /** Called whenever a user's socket is closed.
420 * The details of the exiting user are available to you in the parameter userrec *user
421 * This event is called for all users, registered or not, as a cleanup method for modules
422 * which might assign resources to user, such as dns lookups, objects and sockets.
423 * @param user The user who is disconnecting
425 virtual void OnUserDisconnect(userrec* user);
427 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
428 * @param chan The channel being deleted
430 virtual void OnChannelDelete(chanrec* chan);
432 /** Called when a user joins a channel.
433 * The details of the joining user are available to you in the parameter userrec *user,
434 * and the details of the channel they have joined is available in the variable chanrec *channel
435 * @param user The user who is joining
436 * @param channel The channel being joined
438 virtual void OnUserJoin(userrec* user, chanrec* channel);
440 /** Called when a user parts a channel.
441 * The details of the leaving user are available to you in the parameter userrec *user,
442 * and the details of the channel they have left is available in the variable chanrec *channel
443 * @param user The user who is parting
444 * @param channel The channel being parted
445 * @param partmessage The part message, or an empty string
447 virtual void OnUserPart(userrec* user, chanrec* channel, std::string partmessage);
449 /** Called on rehash.
450 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
451 * system. You should use it to reload any files so that your module keeps in step with the
452 * rest of the application. If a parameter is given, the core has done nothing. The module
453 * receiving the event can decide if this parameter has any relevence to it.
454 * @param parameter The (optional) parameter given to REHASH from the user.
456 virtual void OnRehash(std::string parameter);
458 /** Called when a raw command is transmitted or received.
459 * This method is the lowest level of handler available to a module. It will be called with raw
460 * data which is passing through a connected socket. If you wish, you may munge this data by changing
461 * the string parameter "raw". If you do this, after your function exits it will immediately be
462 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
463 * inbound is set to true) the value of user will be the userrec of the connection sending the
464 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
465 * @param raw The raw string in RFC1459 format
466 * @param inbound A flag to indicate wether the data is coming into the daemon or going out to the user
467 * @param user The user record sending the text, when inbound == true.
469 virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
471 /** Called whenever an extended mode is to be processed.
472 * The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being
473 * changed. mode_on is set when the mode is being set, in which case params contains a list of
474 * parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters
475 * may contain the parameters for the mode, dependent on wether they were defined when a mode handler
476 * was set up with Server::AddExtendedMode
477 * If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*.
478 * You must cast this value yourself to make use of it.
479 * @param user The user issuing the mode
480 * @param target The user or channel having the mode set on them
481 * @param modechar The mode character being set
482 * @param type The type of mode (user or channel) being set
483 * @param mode_on True if the mode is being set, false if it is being unset
484 * @param params A list of parameters for any channel mode (currently supports either 0 or 1 parameters)
486 virtual int OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list ¶ms);
488 /** Called whenever a user is about to join a channel, before any processing is done.
489 * Returning a value of 1 from this function stops the process immediately, causing no
490 * output to be sent to the user by the core. If you do this you must produce your own numerics,
491 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
492 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
496 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
497 * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
498 * processing on the actual channel record at this point, however the channel NAME will still be passed in
499 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
500 * @param user The user joining the channel
501 * @param cname The channel name being joined
502 * @return 1 To prevent the join, 0 to allow it.
504 virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname);
506 /** Called whenever a user is about to be kicked.
507 * Returning a value of 1 from this function stops the process immediately, causing no
508 * output to be sent to the user by the core. If you do this you must produce your own numerics,
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
514 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
516 virtual int OnUserPreKick(userrec* source, userrec* user, chanrec* chan, std::string reason);
518 /** Called whenever a user is kicked.
519 * If this method is called, the kick is already underway and cannot be prevented, so
520 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
521 * @param source The user issuing the kick
522 * @param user The user being kicked
523 * @param chan The channel the user is being kicked from
524 * @param reason The kick reason
526 virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, std::string reason);
528 /** Called whenever a user opers locally.
529 * The userrec will contain the oper mode 'o' as this function is called after any modifications
530 * are made to the user's structure by the core.
531 * @param user The user who is opering up
532 * @param opertype The opers type name
534 virtual void OnOper(userrec* user, std::string opertype);
536 /** Called after a user opers locally.
537 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
538 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
539 * out the OPERTYPE, etc.
540 * @param user The user who is opering up
541 * @param opertype The opers type name
543 virtual void OnPostOper(userrec* user, std::string opertype);
545 /** Called whenever a user types /INFO.
546 * The userrec will contain the information of the user who typed the command. Modules may use this
547 * method to output their own credits in /INFO (which is the ircd's version of an about box).
548 * It is purposefully not possible to modify any info that has already been output, or halt the list.
549 * You must write a 371 numeric to the user, containing your info in the following format:
551 * <nick> :information here
553 * @param user The user issuing /INFO
555 virtual void OnInfo(userrec* user);
557 /** Called whenever a /WHOIS is performed on a local user.
558 * The source parameter contains the details of the user who issued the WHOIS command, and
559 * the dest parameter contains the information of the user they are whoising.
560 * @param source The user issuing the WHOIS command
561 * @param dest The user who is being WHOISed
563 virtual void OnWhois(userrec* source, userrec* dest);
565 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
566 * Returning 1 from this function stops the process immediately, causing no
567 * output to be sent to the user by the core. If you do this you must produce your own numerics,
568 * notices etc. This is useful for modules which may want to filter invites to channels.
569 * @param source The user who is issuing the INVITE
570 * @param dest The user being invited
571 * @param channel The channel the user is being invited to
572 * @return 1 to deny the invite, 0 to allow
574 virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel);
576 /** Called after a user has been successfully invited to a channel.
577 * You cannot prevent the invite from occuring using this function, to do that,
578 * use OnUserPreInvite instead.
579 * @param source The user who is issuing the INVITE
580 * @param dest The user being invited
581 * @param channel The channel the user is being invited to
583 virtual void OnUserInvite(userrec* source,userrec* dest,chanrec* channel);
585 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
586 * Returning any nonzero value from this function stops the process immediately, causing no
587 * output to be sent to the user by the core. If you do this you must produce your own numerics,
588 * notices etc. This is useful for modules which may want to filter or redirect messages.
589 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
590 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
591 * of where the message is destined to be sent.
592 * @param user The user sending the message
593 * @param dest The target of the message (chanrec* or userrec*)
594 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
595 * @param text Changeable text being sent by the user
596 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
597 * @return 1 to deny the NOTICE, 0 to allow it
599 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text,char status);
601 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
602 * Returning any nonzero value from this function stops the process immediately, causing no
603 * output to be sent to the user by the core. If you do this you must produce your own numerics,
604 * notices etc. This is useful for modules which may want to filter or redirect messages.
605 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
606 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
607 * of where the message is destined to be sent.
608 * You may alter the message text as you wish before relinquishing control to the next module
609 * in the chain, and if no other modules block the text this altered form of the text will be sent out
610 * to the user and possibly to other servers.
611 * @param user The user sending the message
612 * @param dest The target of the message (chanrec* or userrec*)
613 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
614 * @param text Changeable text being sent by the user
615 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
616 * @return 1 to deny the NOTICE, 0 to allow it
618 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text,char status);
620 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
621 * Please note that although you can see remote nickchanges through this function, you should
622 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
623 * check user->server before taking any action (including returning nonzero from the method).
624 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
625 * module to generate some meaninful output.
626 * @param user The username changing their nick
627 * @param newnick Their new nickname
628 * @return 1 to deny the change, 0 to allow
630 virtual int OnUserPreNick(userrec* user, std::string newnick);
632 /** Called after any PRIVMSG 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. PRIVMSG @#chan has status== '@', 0 to send to everyone.
641 virtual void OnUserMessage(userrec* user, void* dest, int target_type, std::string text, char status);
643 /** Called after any NOTICE 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.
646 * @param user The user sending the message
647 * @param dest The target of the message
648 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
649 * @param text the text being sent by the user
650 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
652 virtual void OnUserNotice(userrec* user, void* dest, int target_type, std::string text, char status);
654 /** Called after every MODE command sent from a user
655 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
656 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
657 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
658 * @param user The user sending the MODEs
659 * @param dest The target of the modes (userrec* or chanrec*)
660 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
661 * @param text The actual modes and their parameters if any
663 virtual void OnMode(userrec* user, void* dest, int target_type, std::string text);
665 /** Allows modules to alter or create server descriptions
666 * Whenever a module requires a server description, for example for display in
667 * WHOIS, this function is called in all modules. You may change or define the
668 * description given in std::string &description. If you do, this description
669 * will be shown in the WHOIS fields.
670 * @param servername The servername being searched for
671 * @param description Alterable server description for this server
673 virtual void OnGetServerDescription(std::string servername,std::string &description);
675 /** Allows modules to synchronize data which relates to users during a netburst.
676 * When this function is called, it will be called from the module which implements
677 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
678 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
679 * (see below). This function will be called for every user visible on your side
680 * of the burst, allowing you to for example set modes, etc. Do not use this call to
681 * synchronize data which you have stored using class Extensible -- There is a specialist
682 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
683 * @param user The user being syncronized
684 * @param proto A pointer to the module handling network protocol
685 * @param opaque An opaque pointer set by the protocol module, should not be modified!
687 virtual void OnSyncUser(userrec* user, Module* proto, void* opaque);
689 /** Allows modules to synchronize data which relates to channels during a netburst.
690 * When this function is called, it will be called from the module which implements
691 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
692 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
693 * (see below). This function will be called for every user visible on your side
694 * of the burst, allowing you to for example set modes, etc. Do not use this call to
695 * synchronize data which you have stored using class Extensible -- There is a specialist
696 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
698 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
700 * @param chan The channel being syncronized
701 * @param proto A pointer to the module handling network protocol
702 * @param opaque An opaque pointer set by the protocol module, should not be modified!
704 virtual void OnSyncChannel(chanrec* chan, Module* proto, void* opaque);
706 /* Allows modules to syncronize metadata related to channels over the network during a netburst.
707 * Whenever the linking module wants to send out data, but doesnt know what the data
708 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
709 * this method is called.You should use the ProtoSendMetaData function after you've
710 * correctly decided how the data should be represented, to send the metadata on its way if it belongs
711 * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
712 * @param chan The channel whos metadata is being syncronized
713 * @param proto A pointer to the module handling network protocol
714 * @param opaque An opaque pointer set by the protocol module, should not be modified!
715 * @param extname The extensions name which is being searched for
717 virtual void OnSyncChannelMetaData(chanrec* chan, Module* proto,void* opaque, std::string extname);
719 /* Allows modules to syncronize metadata related to users over the network during a netburst.
720 * Whenever the linking module wants to send out data, but doesnt know what the data
721 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
722 * this method is called. You should use the ProtoSendMetaData function after you've
723 * correctly decided how the data should be represented, to send the metadata on its way if
724 * if it belongs to your module.
725 * @param user The user whos metadata is being syncronized
726 * @param proto A pointer to the module handling network protocol
727 * @param opaque An opaque pointer set by the protocol module, should not be modified!
728 * @param extname The extensions name which is being searched for
730 virtual void OnSyncUserMetaData(userrec* user, Module* proto,void* opaque, std::string extname);
732 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
733 * Whenever the linking module wants to send out data, but doesnt know what the data
734 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
735 * this method is called. You should use the ProtoSendMetaData function after you've
736 * correctly decided how the data should be represented, to send the metadata on its way if
737 * if it belongs to your module.
738 * @param proto A pointer to the module handling network protocol
739 * @param opaque An opaque pointer set by the protocol module, should not be modified!
741 virtual void OnSyncOtherMetaData(Module* proto, void* opaque);
743 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
744 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
745 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
746 * @param target The chanrec* or userrec* that data should be added to
747 * @param extname The extension name which is being sent
748 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
750 virtual void OnDecodeMetaData(int target_type, void* target, std::string extname, std::string extdata);
752 /** Implemented by modules which provide the ability to link servers.
753 * These modules will implement this method, which allows transparent sending of servermodes
754 * down the network link as a broadcast, without a module calling it having to know the format
755 * of the MODE command before the actual mode string.
757 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
758 * of how to use this function.
760 * @param opaque An opaque pointer set by the protocol module, should not be modified!
761 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
762 * @param target The chanrec* or userrec* that modes should be sent for
763 * @param modeline The modes and parameters to be sent
765 virtual void ProtoSendMode(void* opaque, int target_type, void* target, std::string modeline);
767 /** Implemented by modules which provide the ability to link servers.
768 * These modules will implement this method, which allows metadata (extra data added to
769 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
770 * to other servers on a netburst and decoded at the other end by the same module on a
773 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
774 * how to use this function.
775 * @param opaque An opaque pointer set by the protocol module, should not be modified!
776 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
777 * @param target The chanrec* or userrec* that metadata should be sent for
778 * @param extname The extension name to send metadata for
779 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
781 virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, std::string extname, std::string extdata);
783 /** Called after every WALLOPS command.
784 * @param user The user sending the WALLOPS
785 * @param text The content of the WALLOPS message
787 virtual void OnWallops(userrec* user, std::string text);
789 /** Called whenever a user's hostname is changed.
790 * This event triggers after the host has been set.
791 * @param user The user whos host is being changed
792 * @param newhost The new hostname being set
794 virtual void OnChangeHost(userrec* user, std::string newhost);
796 /** Called whenever a user's GECOS (realname) is changed.
797 * This event triggers after the name has been set.
798 * @param user The user who's GECOS is being changed
799 * @param gecos The new GECOS being set on the user
801 virtual void OnChangeName(userrec* user, std::string gecos);
803 /** Called whenever a gline is added by a local user.
804 * This method is triggered after the line is added.
805 * @param duration The duration of the line in seconds
806 * @param source The sender of the line
807 * @param reason The reason text to be displayed
808 * @param hostmask The hostmask to add
810 virtual void OnAddGLine(long duration, userrec* source, std::string reason, std::string hostmask);
812 /** Called whenever a zline is added by a local user.
813 * This method is triggered after the line is added.
814 * @param duration The duration of the line in seconds
815 * @param source The sender of the line
816 * @param reason The reason text to be displayed
817 * @param ipmask The hostmask to add
819 virtual void OnAddZLine(long duration, userrec* source, std::string reason, std::string ipmask);
821 /** Called whenever a kline is added by a local user.
822 * This method is triggered after the line is added.
823 * @param duration The duration of the line in seconds
824 * @param source The sender of the line
825 * @param reason The reason text to be displayed
826 * @param hostmask The hostmask to add
828 virtual void OnAddKLine(long duration, userrec* source, std::string reason, std::string hostmask);
830 /** Called whenever a qline is added by a local user.
831 * This method is triggered after the line is added.
832 * @param duration The duration of the line in seconds
833 * @param source The sender of the line
834 * @param reason The reason text to be displayed
835 * @param nickmask The hostmask to add
837 virtual void OnAddQLine(long duration, userrec* source, std::string reason, std::string nickmask);
839 /** Called whenever a eline is added by a local user.
840 * This method is triggered after the line is added.
841 * @param duration The duration of the line in seconds
842 * @param source The sender of the line
843 * @param reason The reason text to be displayed
844 * @param hostmask The hostmask to add
846 virtual void OnAddELine(long duration, userrec* source, std::string reason, std::string hostmask);
848 /** Called whenever a gline is deleted.
849 * This method is triggered after the line is deleted.
850 * @param source The user removing the line
851 * @param hostmask The hostmask to delete
853 virtual void OnDelGLine(userrec* source, std::string hostmask);
855 /** Called whenever a zline is deleted.
856 * This method is triggered after the line is deleted.
857 * @param source The user removing the line
858 * @param hostmask The hostmask to delete
860 virtual void OnDelZLine(userrec* source, std::string ipmask);
862 /** Called whenever a kline is deleted.
863 * This method is triggered after the line is deleted.
864 * @param source The user removing the line
865 * @param hostmask The hostmask to delete
867 virtual void OnDelKLine(userrec* source, std::string hostmask);
869 /** Called whenever a qline is deleted.
870 * This method is triggered after the line is deleted.
871 * @param source The user removing the line
872 * @param hostmask The hostmask to delete
874 virtual void OnDelQLine(userrec* source, std::string nickmask);
876 /** Called whenever a eline is deleted.
877 * This method is triggered after the line is deleted.
878 * @param source The user removing the line
879 * @param hostmask The hostmask to delete
881 virtual void OnDelELine(userrec* source, std::string hostmask);
883 /** Called before your module is unloaded to clean up Extensibles.
884 * This method is called once for every user and channel on the network,
885 * so that when your module unloads it may clear up any remaining data
886 * in the form of Extensibles added using Extensible::Extend().
887 * If the target_type variable is TYPE_USER, then void* item refers to
888 * a userrec*, otherwise it refers to a chanrec*.
889 * @param target_type The type of item being cleaned
890 * @param item A pointer to the item's class
892 virtual void OnCleanup(int target_type, void* item);
894 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
895 * have been applied. Please note that although you can see remote nickchanges through this function, you should
896 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
897 * check user->server before taking any action (including returning nonzero from the method).
898 * Because this method is called after the nickchange is taken place, no return values are possible
899 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
900 * @param user The user changing their nick
901 * @param oldnick The old nickname of the user before the nickchange
903 virtual void OnUserPostNick(userrec* user, std::string oldnick);
905 /** Called before an action which requires a channel privilage check.
906 * This function is called before many functions which check a users status on a channel, for example
907 * before opping a user, deopping a user, kicking a user, etc.
908 * There are several values for access_type which indicate for what reason access is being checked.
910 * AC_KICK (0) - A user is being kicked<br>
911 * AC_DEOP (1) - a user is being deopped<br>
912 * AC_OP (2) - a user is being opped<br>
913 * AC_VOICE (3) - a user is being voiced<br>
914 * AC_DEVOICE (4) - a user is being devoiced<br>
915 * AC_HALFOP (5) - a user is being halfopped<br>
916 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
917 * AC_INVITE (7) - a user is being invited<br>
918 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
919 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
920 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
921 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
922 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
923 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
924 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
925 * @param source The source of the access check
926 * @param dest The destination of the access check
927 * @param channel The channel which is being checked
928 * @param access_type See above
930 virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
932 /** Called when a 005 numeric is about to be output.
933 * The module should modify the 005 numeric if needed to indicate its features.
934 * @param output The 005 string to be modified if neccessary.
936 virtual void On005Numeric(std::string &output);
938 /** Called when a client is disconnected by KILL.
939 * If a client is killed by a server, e.g. a nickname collision or protocol error,
941 * Return 1 from this function to prevent the kill, and 0 from this function to allow
942 * it as normal. If you prevent the kill no output will be sent to the client, it is
943 * down to your module to generate this information.
944 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
945 * If you do so youre risking race conditions, desyncs and worse!
946 * @param source The user sending the KILL
947 * @param dest The user being killed
948 * @param reason The kill reason
949 * @return 1 to prevent the kill, 0 to allow
951 virtual int OnKill(userrec* source, userrec* dest, std::string reason);
953 /** Called when an oper wants to disconnect a remote user via KILL
954 * @param source The user sending the KILL
955 * @param dest The user being killed
956 * @param reason The kill reason
958 virtual void OnRemoteKill(userrec* source, userrec* dest, std::string reason);
960 /** Called whenever a module is loaded.
961 * mod will contain a pointer to the module, and string will contain its name,
962 * for example m_widgets.so. This function is primary for dependency checking,
963 * your module may decide to enable some extra features if it sees that you have
964 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
965 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
966 * but instead operate under reduced functionality, unless the dependency is
967 * absolutely neccessary (e.g. a module that extends the features of another
969 * @param mod A pointer to the new module
970 * @param name The new module's filename
972 virtual void OnLoadModule(Module* mod,std::string name);
974 /** Called whenever a module is unloaded.
975 * mod will contain a pointer to the module, and string will contain its name,
976 * for example m_widgets.so. This function is primary for dependency checking,
977 * your module may decide to enable some extra features if it sees that you have
978 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
979 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
980 * but instead operate under reduced functionality, unless the dependency is
981 * absolutely neccessary (e.g. a module that extends the features of another
983 * @param mod Pointer to the module being unloaded (still valid)
984 * @param name The filename of the module being unloaded
986 virtual void OnUnloadModule(Module* mod,std::string name);
988 /** Called once every five seconds for background processing.
989 * This timer can be used to control timed features. Its period is not accurate
990 * enough to be used as a clock, but it is gauranteed to be called at least once in
991 * any five second period, directly from the main loop of the server.
992 * @param curtime The current timer derived from time(2)
994 virtual void OnBackgroundTimer(time_t curtime);
996 /** Called whenever a list is needed for a listmode.
997 * For example, when a /MODE #channel +b (without any other parameters) is called,
998 * if a module was handling +b this function would be called. The function can then
999 * output any lists it wishes to. Please note that all modules will see all mode
1000 * characters to provide the ability to extend each other, so please only output
1001 * a list if the mode character given matches the one(s) you want to handle.
1002 * @param user The user requesting the list
1003 * @param channel The channel the list is for
1004 * @param mode The listmode which a list is being requested on
1006 virtual void OnSendList(userrec* user, chanrec* channel, char mode);
1008 /** Called whenever any command is about to be executed.
1009 * This event occurs for all registered commands, wether they are registered in the core,
1010 * or another module, but it will not occur for invalid commands (e.g. ones which do not
1011 * exist within the command table). By returning 1 from this method you may prevent the
1012 * command being executed. If you do this, no output is created by the core, and it is
1013 * down to your module to produce any output neccessary.
1014 * Note that unless you return 1, you should not destroy any structures (e.g. by using
1015 * Server::QuitUser) otherwise when the command's handler function executes after your
1016 * method returns, it will be passed an invalid pointer to the user object and crash!)
1017 * @param command The command being executed
1018 * @param parameters An array of array of characters containing the parameters for the command
1019 * @param pcnt The nuimber of parameters passed to the command
1020 * @param user the user issuing the command
1021 * @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.
1022 * @return 1 to block the command, 0 to allow
1024 virtual int OnPreCommand(std::string command, char **parameters, int pcnt, userrec *user, bool validated);
1026 /** Called to check if a user who is connecting can now be allowed to register
1027 * If any modules return false for this function, the user is held in the waiting
1028 * state until all modules return true. For example a module which implements ident
1029 * lookups will continue to return false for a user until their ident lookup is completed.
1030 * Note that the registration timeout for a user overrides these checks, if the registration
1031 * timeout is reached, the user is disconnected even if modules report that the user is
1032 * not ready to connect.
1033 * @param user The user to check
1034 * @return true to indicate readiness, false if otherwise
1036 virtual bool OnCheckReady(userrec* user);
1038 /** Called whenever a user is about to register their connection (e.g. before the user
1039 * is sent the MOTD etc). Modules can use this method if they are performing a function
1040 * which must be done before the actual connection is completed (e.g. ident lookups,
1041 * dnsbl lookups, etc).
1042 * Note that you should NOT delete the user record here by causing a disconnection!
1043 * Use OnUserConnect for that instead.
1044 * @param user The user registering
1046 virtual void OnUserRegister(userrec* user);
1048 /** Called whenever a mode character is processed.
1049 * Return 1 from this function to block the mode character from being processed entirely,
1050 * so that you may perform your own code instead. Note that this method allows you to override
1051 * modes defined by other modes, but this is NOT RECOMMENDED!
1052 * @param user The user who is sending the mode
1053 * @param chan The channel the mode is being sent to
1054 * @param mode The mode character being set
1055 * @param param The parameter for the mode or an empty string
1056 * @param adding true of the mode is being added, false if it is being removed
1057 * @param pcnt The parameter count for the mode (0 or 1)
1058 * @return 1 to deny the mode, 0 to allow
1060 virtual int OnRawMode(userrec* user, chanrec* chan, char mode, std::string param, bool adding, int pcnt);
1062 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1063 * This method will always be called for each join, wether or not the channel is actually +i, and
1064 * determines the outcome of an if statement around the whole section of invite checking code.
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 OnCheckInvite(userrec* user, chanrec* chan);
1072 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1073 * This method will always be called for each join, wether or not the channel is actually +k, and
1074 * determines the outcome of an if statement around the whole section of key checking code.
1075 * if the user specified no key, the keygiven string will be a valid but empty value.
1076 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1077 * @param user The user joining the channel
1078 * @param chan The channel being joined
1079 * @return 1 to explicitly allow the join, 0 to proceed as normal
1081 virtual int OnCheckKey(userrec* user, chanrec* chan, std::string keygiven);
1083 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1084 * This method will always be called for each join, wether or not the channel is actually +l, and
1085 * determines the outcome of an if statement around the whole section of channel limit checking code.
1086 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1087 * @param user The user joining the channel
1088 * @param chan The channel being joined
1089 * @return 1 to explicitly allow the join, 0 to proceed as normal
1091 virtual int OnCheckLimit(userrec* user, chanrec* chan);
1093 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
1094 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
1095 * determines the outcome of an if statement around the whole section of ban checking code.
1096 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1097 * @param user The user joining the channel
1098 * @param chan The channel being joined
1099 * @return 1 to explicitly allow the join, 0 to proceed as normal
1101 virtual int OnCheckBan(userrec* user, chanrec* chan);
1103 /** Called on all /STATS commands
1104 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1105 * @param symbol the symbol provided to /STATS
1106 * @user the user issuing the /STATS command
1107 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1109 virtual int OnStats(char symbol, userrec* user);
1111 /** Called whenever a change of a local users displayed host is attempted.
1112 * Return 1 to deny the host change, or 0 to allow it.
1113 * @param user The user whos host will be changed
1114 * @param newhost The new hostname
1115 * @return 1 to deny the host change, 0 to allow
1117 virtual int OnChangeLocalUserHost(userrec* user, std::string newhost);
1119 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1120 * return 1 to deny the name change, or 0 to allow it.
1121 * @param user The user whos GECOS will be changed
1122 * @param newhost The new GECOS
1123 * @return 1 to deny the GECOS change, 0 to allow
1125 virtual int OnChangeLocalUserGECOS(userrec* user, std::string newhost);
1127 /** Called whenever a topic is changed by a local user.
1128 * Return 1 to deny the topic change, or 0 to allow it.
1129 * @param user The user changing the topic
1130 * @param chan The channels who's topic is being changed
1131 * @param topic The actual topic text
1132 * @param 1 to block the topic change, 0 to allow
1134 virtual int OnLocalTopicChange(userrec* user, chanrec* chan, std::string topic);
1136 /** Called whenever a local topic has been changed.
1137 * To block topic changes you must use OnLocalTopicChange instead.
1138 * @param user The user changing the topic
1139 * @param chan The channels who's topic is being changed
1140 * @param topic The actual topic text
1142 virtual void OnPostLocalTopicChange(userrec* user, chanrec* chan, std::string topic);
1144 /** Called whenever an Event class is sent to all module by another module.
1145 * Please see the documentation of Event::Send() for further information. The Event sent can
1146 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1147 * before doing anything to the event data, and you should *not* change the event data in any way!
1148 * @param event The Event class being received
1150 virtual void OnEvent(Event* event);
1152 /** Called whenever a Request class is sent to your module by another module.
1153 * Please see the documentation of Request::Send() for further information. The Request sent
1154 * can always be assumed to be non-NULL, you should not change the request object or its data.
1155 * Your method may return arbitary data in the char* result which the requesting module
1156 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1157 * @param request The Request class being received
1159 virtual char* OnRequest(Request* request);
1161 /** Called whenever an oper password is to be compared to what a user has input.
1162 * The password field (from the config file) is in 'password' and is to be compared against
1163 * 'input'. This method allows for encryption of oper passwords and much more besides.
1164 * You should return a nonzero value if you want to allow the comparison or zero if you wish
1166 * @param password The oper's password
1167 * @param input The password entered
1168 * @return 1 to match the passwords, 0 to do nothing
1170 virtual int OnOperCompare(std::string password, std::string input);
1172 /** Called whenever a user is given usermode +o, anywhere on the network.
1173 * You cannot override this and prevent it from happening as it is already happened and
1174 * such a task must be performed by another server. You can however bounce modes by sending
1175 * servermodes out to reverse mode changes.
1176 * @param user The user who is opering
1178 virtual void OnGlobalOper(userrec* user);
1180 /** Called whenever a user connects, anywhere on the network.
1181 * This event is informational only. You should not change any user information in this
1182 * event. To do so, use the OnUserConnect method to change the state of local users.
1183 * @param user The user who is connecting
1185 virtual void OnGlobalConnect(userrec* user);
1187 /** Called whenever a ban is added to a channel's list.
1188 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1189 * @param source The user adding the ban
1190 * @param channel The channel the ban is being added to
1191 * @param banmask The ban mask being added
1192 * @return 1 to block the ban, 0 to continue as normal
1194 virtual int OnAddBan(userrec* source, chanrec* channel,std::string banmask);
1196 /** Called whenever a ban is removed from a channel's list.
1197 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1198 * @param source The user deleting the ban
1199 * @param channel The channel the ban is being deleted from
1200 * @param banmask The ban mask being deleted
1201 * @return 1 to block the unban, 0 to continue as normal
1203 virtual int OnDelBan(userrec* source, chanrec* channel,std::string banmask);
1205 /** Called immediately after any connection is accepted. This is intended for raw socket
1206 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1207 * no information relating to a user record as the connection has not been assigned yet.
1208 * There are no return values from this call as all modules get an opportunity if required to
1209 * process the connection.
1210 * @param fd The file descriptor returned from accept()
1211 * @param ip The IP address of the connecting user
1212 * @param localport The local port number the user connected to
1214 virtual void OnRawSocketAccept(int fd, std::string ip, int localport);
1216 /** Called immediately before any write() operation on a user's socket in the core. Because
1217 * this event is a low level event no user information is associated with it. It is intended
1218 * for use by modules which may wrap connections within another API such as SSL for example.
1219 * return a non-zero result if you have handled the write operation, in which case the core
1220 * will not call write().
1221 * @param fd The file descriptor of the socket
1222 * @param buffer A char* buffer being written
1223 * @param Number of characters to write
1224 * @return Number of characters actually written or 0 if you didn't handle the operation
1226 virtual int OnRawSocketWrite(int fd, char* buffer, int count);
1228 /** Called immediately before any socket is closed. When this event is called, shutdown()
1229 * has not yet been called on the socket.
1230 * @param fd The file descriptor of the socket prior to close()
1232 virtual void OnRawSocketClose(int fd);
1234 /** Called immediately before any read() operation on a client socket in the core.
1235 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1236 * when this event occurs.
1237 * Your event should return 1 if it has handled the reading itself, which prevents the core
1238 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1239 * the value of count. The value of readresult must be identical to an actual result that might
1240 * be returned from the read() system call, for example, number of bytes read upon success,
1241 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1242 * you MUST set readresult.
1243 * @param fd The file descriptor of the socket
1244 * @param buffer A char* buffer being read to
1245 * @param count The size of the buffer
1246 * @param readresult The amount of characters read, or 0
1247 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1249 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1251 virtual void OnSetAway(userrec* user);
1253 virtual void OnCancelAway(userrec* user);
1257 /** Allows server output and query functions
1258 * This class contains methods which allow a module to query the state of the irc server, and produce
1259 * output to users and other servers. All modules should instantiate at least one copy of this class,
1260 * and use its member functions to perform their tasks.
1262 class Server : public classbase
1265 /** Default constructor.
1266 * Creates a Server object.
1270 /** Default destructor.
1271 * Destroys a Server object.
1275 /** Obtains a pointer to the server's ServerConfig object.
1276 * The ServerConfig object contains most of the configuration data
1277 * of the IRC server, as read from the config file by the core.
1279 ServerConfig* GetConfig();
1281 /** For use with Module::Prioritize().
1282 * When the return value of this function is returned from
1283 * Module::Prioritize(), this specifies that the module wishes
1284 * to be ordered exactly BEFORE 'modulename'. For more information
1285 * please see Module::Prioritize().
1286 * @param modulename The module your module wants to be before in the call list
1287 * @returns a priority ID which the core uses to relocate the module in the list
1289 long PriorityBefore(std::string modulename);
1291 /** For use with Module::Prioritize().
1292 * When the return value of this function is returned from
1293 * Module::Prioritize(), this specifies that the module wishes
1294 * to be ordered exactly AFTER 'modulename'. For more information please
1295 * see Module::Prioritize().
1296 * @param modulename The module your module wants to be after in the call list
1297 * @returns a priority ID which the core uses to relocate the module in the list
1299 long PriorityAfter(std::string modulename);
1301 /** Sends text to all opers.
1302 * This method sends a server notice to all opers with the usermode +s.
1304 virtual void SendOpers(std::string s);
1306 /** Returns the version string of this server
1308 std::string GetVersion();
1310 /** Writes a log string.
1311 * This method writes a line of text to the log. If the level given is lower than the
1312 * level given in the configuration, this command has no effect.
1314 virtual void Log(int level, std::string s);
1316 /** Sends a line of text down a TCP/IP socket.
1317 * This method writes a line of text to an established socket, cutting it to 510 characters
1318 * plus a carriage return and linefeed if required.
1320 virtual void Send(int Socket, std::string s);
1322 /** Sends text from the server to a socket.
1323 * This method writes a line of text to an established socket, with the servername prepended
1324 * as used by numerics (see RFC 1459)
1326 virtual void SendServ(int Socket, std::string s);
1328 /** Writes text to a channel, but from a server, including all.
1329 * This can be used to send server notices to a group of users.
1331 virtual void SendChannelServerNotice(std::string ServName, chanrec* Channel, std::string text);
1333 /** Sends text from a user to a socket.
1334 * This method writes a line of text to an established socket, with the given user's nick/ident
1335 * /host combination prepended, as used in PRIVSG etc commands (see RFC 1459)
1337 virtual void SendFrom(int Socket, userrec* User, std::string s);
1339 /** Sends text from a user to another user.
1340 * This method writes a line of text to a user, with a user's nick/ident
1341 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459)
1342 * If you specify NULL as the source, then the data will originate from the
1343 * local server, e.g. instead of:
1345 * :user!ident@host TEXT
1347 * The format will become:
1351 * Which is useful for numerics and server notices to single users, etc.
1353 virtual void SendTo(userrec* Source, userrec* Dest, std::string s);
1355 /** Sends text from a user to a channel (mulicast).
1356 * This method writes a line of text to a channel, with the given user's nick/ident
1357 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the
1358 * IncludeSender flag is set, then the text is also sent back to the user from which
1359 * it originated, as seen in MODE (see RFC 1459).
1361 virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender);
1363 /** Returns true if two users share a common channel.
1364 * This method is used internally by the NICK and QUIT commands, and the Server::SendCommon
1367 virtual bool CommonChannels(userrec* u1, userrec* u2);
1369 /** Sends text from a user to one or more channels (mulicast).
1370 * This method writes a line of text to all users which share a common channel with a given
1371 * user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc
1372 * commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent
1373 * back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it
1374 * is only sent to the other recipients, as seen in QUIT.
1376 virtual void SendCommon(userrec* User, std::string text,bool IncludeSender);
1378 /** Sends a WALLOPS message.
1379 * This method writes a WALLOPS message to all users with the +w flag, originating from the
1382 virtual void SendWallops(userrec* User, std::string text);
1384 /** Returns true if a nick is valid.
1385 * Nicks for unregistered connections will return false.
1387 virtual bool IsNick(std::string nick);
1389 /** Returns a count of the number of users on a channel.
1390 * This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.
1392 virtual int CountUsers(chanrec* c);
1394 /** Adds an InspTimer which will trigger at a future time
1396 virtual void AddTimer(InspTimer* T);
1398 /** Attempts to look up a nick and return a pointer to it.
1399 * This function will return NULL if the nick does not exist.
1401 virtual userrec* FindNick(std::string nick);
1403 /** Attempts to look up a nick using the file descriptor associated with that nick.
1404 * This function will return NULL if the file descriptor is not associated with a valid user.
1406 virtual userrec* FindDescriptor(int socket);
1408 /** Attempts to look up a channel and return a pointer to it.
1409 * This function will return NULL if the channel does not exist.
1411 virtual chanrec* FindChannel(std::string channel);
1413 /** Attempts to look up a user's privilages on a channel.
1414 * This function will return a string containing either @, %, +, or an empty string,
1415 * representing the user's privilages upon the channel you specify.
1417 virtual std::string ChanMode(userrec* User, chanrec* Chan);
1419 /** Checks if a user is on a channel.
1420 * This function will return true or false to indicate if user 'User' is on channel 'Chan'.
1422 virtual bool IsOnChannel(userrec* User, chanrec* Chan);
1424 /** Returns the server name of the server where the module is loaded.
1426 virtual std::string GetServerName();
1428 /** Returns the network name, global to all linked servers.
1430 virtual std::string GetNetworkName();
1432 /** Returns the server description string of the local server
1434 virtual std::string GetServerDescription();
1436 /** Returns the information of the server as returned by the /ADMIN command.
1437 * See the Admin class for further information of the return value. The members
1438 * Admin::Nick, Admin::Email and Admin::Name contain the information for the
1439 * server where the module is loaded.
1441 virtual Admin GetAdmin();
1443 /** Adds an extended mode letter which is parsed by a module.
1444 * This allows modules to add extra mode letters, e.g. +x for hostcloak.
1445 * the "type" parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to
1446 * indicate wether the mode is a channel mode, a client mode, or a server mode.
1447 * requires_oper is used with MT_CLIENT type modes only to indicate the mode can only
1448 * be set or unset by an oper. If this is used for MT_CHANNEL type modes it is ignored.
1449 * params_when_on is the number of modes to expect when the mode is turned on
1450 * (for type MT_CHANNEL only), e.g. with mode +k, this would have a value of 1.
1451 * the params_when_off value has a similar value to params_when_on, except it indicates
1452 * the number of parameters to expect when the mode is disabled. Modes which act in a similar
1453 * way to channel mode +l (e.g. require a parameter to enable, but not to disable) should
1454 * use this parameter. The function returns false if the mode is unavailable, and will not
1455 * attempt to allocate another character, as this will confuse users. This also means that
1456 * as only one module can claim a specific mode character, the core does not need to keep track
1457 * of which modules own which modes, which speeds up operation of the server. In this version,
1458 * a mode can have at most one parameter, attempting to use more parameters will have undefined
1461 virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off);
1463 /** Adds an extended mode letter which is parsed by a module and handled in a list fashion.
1464 * This call is used to implement modes like +q and +a. The characteristics of these modes are
1467 * (1) They are ALWAYS on channels, not on users, therefore their type is MT_CHANNEL
1469 * (2) They always take exactly one parameter when being added or removed
1471 * (3) They can be set multiple times, usually on users in channels
1473 * (4) The mode and its parameter are NOT stored in the channels modes structure
1475 * It is down to the module handling the mode to maintain state and determine what 'items' (e.g. users,
1476 * or a banlist) have the mode set on them, and process the modes at the correct times, e.g. during access
1477 * checks on channels, etc. When the extended mode is triggered the OnExtendedMode method will be triggered
1478 * as above. Note that the target you are given will be a channel, if for example your mode is set 'on a user'
1479 * (in for example +a) you must use Server::Find to locate the user the mode is operating on.
1480 * Your mode handler may return 1 to handle the mode AND tell the core to display the mode change, e.g.
1481 * '+aaa one two three' in the case of the mode for 'two', or it may return -1 to 'eat' the mode change,
1482 * so the above example would become '+aa one three' after processing.
1484 virtual bool AddExtendedListMode(char modechar);
1486 /** Adds a command to the command table.
1487 * This allows modules to add extra commands into the command table. You must place a function within your
1488 * module which is is of type handlerfunc:
1490 * typedef void (handlerfunc) (char**, int, userrec*);
1492 * void handle_kill(char **parameters, int pcnt, userrec *user)
1494 * When the command is typed, the parameters will be placed into the parameters array (similar to argv) and
1495 * the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters
1496 * than the 'minparams' value you specified when creating the command. The *user parameter is the class of
1497 * the user which caused the command to trigger, who will always have the flag you specified in 'flags' when
1498 * creating the initial command. For example to create an oper only command create the commands with flags='o'.
1499 * The source parameter is used for resource tracking, and should contain the name of your module (with file
1500 * extension) e.g. "m_blarp.so". If you place the wrong identifier here, you can cause crashes if your module
1503 virtual void AddCommand(command_t *f);
1505 /** Sends a servermode.
1506 * you must format the parameters array with the target, modes and parameters for those modes.
1512 * modes[0] = ChannelName;
1516 * modes[2] = user->nick;
1518 * Srv->SendMode(modes,3,user);
1520 * The modes will originate from the server where the command was issued, however responses (e.g. numerics)
1521 * will be sent to the user you provide as the third parameter.
1522 * You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave
1523 * your server in an unstable state!
1526 virtual void SendMode(char **parameters, int pcnt, userrec *user);
1528 /** Sends to all users matching a mode mask
1529 * You must specify one or more usermodes as the first parameter. These can be RFC specified modes such as +i,
1530 * or module provided modes, including ones provided by your own module.
1531 * In the second parameter you must place a flag value which indicates wether the modes you have given will be
1532 * logically ANDed or OR'ed. You may use one of either WM_AND or WM_OR.
1533 * for example, if you were to use:
1535 * Serv->SendToModeMask("xi", WM_OR, "m00");
1537 * Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the
1538 * user must have both modes set to receive the message.
1540 virtual void SendToModeMask(std::string modes, int flags, std::string text);
1542 /** Forces a user to join a channel.
1543 * This is similar to svsjoin and can be used to implement redirection, etc.
1544 * On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to.
1545 * On failure, the result is NULL.
1547 virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key);
1549 /** Forces a user to part a channel.
1550 * This is similar to svspart and can be used to implement redirection, etc.
1551 * Although the return value of this function is a pointer to a channel record, the returned data is
1552 * undefined and should not be read or written to. This behaviour may be changed in a future version.
1554 virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason);
1556 /** Forces a user nickchange.
1557 * This command works similarly to SVSNICK, and can be used to implement Q-lines etc.
1558 * If you specify an invalid nickname, the nick change will be dropped and the target user will receive
1559 * the error numeric for it.
1561 virtual void ChangeUserNick(userrec* user, std::string nickname);
1563 /** Forces a user to quit with the specified reason.
1564 * To the user, it will appear as if they typed /QUIT themselves, except for the fact that this function
1565 * may bypass the quit prefix specified in the config file.
1569 * Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or
1570 * read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of
1571 * action after calling this method is to immediately bail from your handler.
1573 virtual void QuitUser(userrec* user, std::string reason);
1575 /** Makes a user kick another user, with the specified reason.
1576 * If source is NULL, the server will peform the kick.
1577 * @param The person or server (if NULL) performing the KICK
1578 * @param target The person being kicked
1579 * @param chan The channel to kick from
1580 * @param reason The kick reason
1582 virtual void KickUser(userrec* source, userrec* target, chanrec* chan, std::string reason);
1584 /** Matches text against a glob pattern.
1585 * Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com
1586 * Returns true if the literal successfully matches the pattern, false if otherwise.
1588 virtual bool MatchText(std::string sliteral, std::string spattern);
1590 /** Calls the handler for a command, either implemented by the core or by another module.
1591 * You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN,
1592 * KICK etc, or even as a method of callback. By defining command names that are untypeable
1593 * for users on irc (e.g. those which contain a \r or \n) you may use them as callback identifiers.
1594 * The first parameter to this method is the name of the command handler you wish to call, e.g.
1595 * PRIVMSG. This will be a command handler previously registered by the core or wih AddCommand().
1596 * The second parameter is an array of parameters, and the third parameter is a count of parameters
1597 * in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the
1598 * functiom will silently ignore it. The final parameter is the user executing the command handler,
1599 * used for privilage checks, etc.
1600 * @return True if the command exists
1602 virtual bool CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user);
1604 /** This function returns true if the commandname exists, pcnt is equal to or greater than the number
1605 * of paramters the command requires, the user specified is allowed to execute the command, AND
1606 * if the command is implemented by a module (not the core). This has a few specific uses, usually
1607 * within network protocols (see src/modules/m_spanningtree.cpp)
1609 virtual bool IsValidModuleCommand(std::string commandname, int pcnt, userrec* user);
1611 /** Change displayed hostname of a user.
1612 * You should always call this method to change a user's host rather than writing directly to the
1613 * dhost member of userrec, as any change applied via this method will be propogated to any
1616 virtual void ChangeHost(userrec* user, std::string host);
1618 /** Change GECOS (fullname) of a user.
1619 * You should always call this method to change a user's GECOS rather than writing directly to the
1620 * fullname member of userrec, as any change applied via this method will be propogated to any
1623 virtual void ChangeGECOS(userrec* user, std::string gecos);
1625 /** Returns true if the servername you give is ulined.
1626 * ULined servers have extra privilages. They are allowed to change nicknames on remote servers,
1627 * change modes of clients which are on remote servers and set modes of channels where there are
1628 * no channel operators for that channel on the ulined server, amongst other things.
1630 virtual bool IsUlined(std::string server);
1632 /** Fetches the userlist of a channel. This function must be here and not a member of userrec or
1633 * chanrec due to include constraints.
1635 virtual chanuserlist GetUsers(chanrec* chan);
1637 /** Remove a user's connection to the irc server, but leave their client in existence in the
1638 * user hash. When you call this function, the user's file descriptor will be replaced with the
1639 * value of FD_MAGIC_NUMBER and their old file descriptor will be closed. This idle client will
1640 * remain until it is restored with a valid file descriptor, or is removed from IRC by an operator
1641 * After this call, the pointer to user will be invalid.
1643 virtual bool UserToPseudo(userrec* user,std::string message);
1645 /** This user takes one user, and switches their file descriptor with another user, so that one user
1646 * "becomes" the other. The user in 'alive' is booted off the server with the given message. The user
1647 * referred to by 'zombie' should have previously been locked with Server::UserToPseudo, otherwise
1648 * stale sockets and file descriptor leaks can occur. After this call, the pointer to alive will be
1649 * invalid, and the pointer to zombie will be equivalent in effect to the old pointer to alive.
1651 virtual bool PseudoToUser(userrec* alive,userrec* zombie,std::string message);
1654 * The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1655 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1656 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1657 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1660 virtual void AddGLine(long duration, std::string source, std::string reason, std::string hostmask);
1663 * The Q-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1664 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1665 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1666 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1669 virtual void AddQLine(long duration, std::string source, std::string reason, std::string nickname);
1672 * The Z-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1673 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1674 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1675 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1678 virtual void AddZLine(long duration, std::string source, std::string reason, std::string ipaddr);
1681 * The K-line is enforced as soon as it is added.
1682 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1683 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1684 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1687 virtual void AddKLine(long duration, std::string source, std::string reason, std::string hostmask);
1690 * The E-line is enforced as soon as it is added.
1691 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1692 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1693 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1696 virtual void AddELine(long duration, std::string source, std::string reason, std::string hostmask);
1698 /** Deletes a G-Line from all servers
1700 virtual bool DelGLine(std::string hostmask);
1702 /** Deletes a Q-Line from all servers
1704 virtual bool DelQLine(std::string nickname);
1706 /** Deletes a Z-Line from all servers
1708 virtual bool DelZLine(std::string ipaddr);
1710 /** Deletes a local K-Line
1712 virtual bool DelKLine(std::string hostmask);
1714 /** Deletes a local E-Line
1716 virtual bool DelELine(std::string hostmask);
1718 /** Calculates a duration
1719 * This method will take a string containing a formatted duration (e.g. "1w2d") and return its value
1720 * as a total number of seconds. This is the same function used internally by /GLINE etc to set
1723 virtual long CalcDuration(std::string duration);
1725 /** Returns true if a nick!ident@host string is correctly formatted, false if otherwise.
1727 virtual bool IsValidMask(std::string mask);
1729 /** This function finds a module by name.
1730 * You must provide the filename of the module. If the module cannot be found (is not loaded)
1731 * the function will return NULL.
1733 virtual Module* FindModule(std::string name);
1735 /** Adds a class derived from InspSocket to the server's socket engine.
1737 virtual void AddSocket(InspSocket* sock);
1739 /** Forcibly removes a class derived from InspSocket from the servers socket engine.
1741 virtual void RemoveSocket(InspSocket* sock);
1743 /** Deletes a class derived from InspSocket from the server's socket engine.
1745 virtual void DelSocket(InspSocket* sock);
1747 virtual void RehashServer();
1749 virtual long GetChannelCount();
1751 virtual chanrec* GetChannelIndex(long index);
1755 #define CONF_NOT_A_NUMBER 0x000010
1756 #define CONF_NOT_UNSIGNED 0x000080
1757 #define CONF_VALUE_NOT_FOUND 0x000100
1758 #define CONF_FILE_NOT_FOUND 0x000200
1761 /** Allows reading of values from configuration files
1762 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1763 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1764 * Constructing the class using one parameter allows you to specify a path to your own configuration
1765 * file, otherwise, inspircd.conf is read.
1767 class ConfigReader : public classbase
1770 /** The contents of the configuration file
1771 * This protected member should never be accessed by a module (and cannot be accessed unless the
1772 * core is changed). It will contain a pointer to the configuration file data with unneeded data
1773 * (such as comments) stripped from it.
1775 std::stringstream *cache;
1776 std::stringstream *errorlog;
1777 /** Used to store errors
1783 /** Default constructor.
1784 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1785 * as specified when running ./configure.
1787 ConfigReader(); // default constructor reads ircd.conf
1788 /** Overloaded constructor.
1789 * This constructor initialises the ConfigReader class to read a user-specified config file
1791 ConfigReader(std::string filename); // read a module-specific config
1792 /** Default destructor.
1793 * This method destroys the ConfigReader class.
1796 /** Retrieves a value from the config file.
1797 * This method retrieves a value from the config file. Where multiple copies of the tag
1798 * exist in the config file, index indicates which of the values to retrieve.
1800 std::string ReadValue(std::string tag, std::string name, int index);
1801 /** Retrieves a boolean value from the config file.
1802 * This method retrieves a boolean 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. The values "1", "yes"
1804 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1806 bool ReadFlag(std::string tag, std::string name, int index);
1807 /** Retrieves an integer value from the config file.
1808 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1809 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1810 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1811 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1812 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1813 * will return CONF_NOT_UNSIGNED
1815 long ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned);
1816 /** Returns the last error to occur.
1817 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1818 * A call to GetError() resets the error flag back to 0.
1821 /** Counts the number of times a given tag appears in the config file.
1822 * This method counts the number of times a tag appears in a config file, for use where
1823 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1824 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1825 * multiple instance tag.
1827 int Enumerate(std::string tag);
1828 /** Returns true if a config file is valid.
1829 * This method is partially implemented and will only return false if the config
1830 * file does not exist or could not be opened.
1833 /** Dumps the list of errors in a config file to an output location. If bail is true,
1834 * then the program will abort. If bail is false and user points to a valid user
1835 * record, the error report will be spooled to the given user by means of NOTICE.
1836 * if bool is false AND user is false, the error report will be spooled to all opers
1837 * by means of a NOTICE to all opers.
1839 void DumpErrors(bool bail,userrec* user);
1841 /** Returns the number of items within a tag.
1842 * For example if the tag was <test tag="blah" data="foo"> then this
1843 * function would return 2. Spaces and newlines both qualify as valid seperators
1846 int EnumerateValues(std::string tag, int index);
1851 /** Caches a text file into memory and can be used to retrieve lines from it.
1852 * This class contains methods for read-only manipulation of a text file in memory.
1853 * Either use the constructor type with one parameter to load a file into memory
1854 * at construction, or use the LoadFile method to load a file.
1856 class FileReader : public classbase
1860 /** Default constructor.
1861 * This method does not load any file into memory, you must use the LoadFile method
1862 * after constructing the class this way.
1866 /** Secondary constructor.
1867 * This method initialises the class with a file loaded into it ready for GetLine and
1868 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1871 FileReader(std::string filename);
1873 /** Default destructor.
1874 * This deletes the memory allocated to the file.
1878 /** Used to load a file.
1879 * This method loads a file into the class ready for GetLine and
1880 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1883 void LoadFile(std::string filename);
1885 /** Returns true if the file exists
1886 * This function will return false if the file could not be opened.
1890 /** Retrieve one line from the file.
1891 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1892 * the index was out of bounds, or the line had no data on it.
1894 std::string GetLine(int x);
1896 /** Returns the size of the file in lines.
1897 * This method returns the number of lines in the read file. If it is 0, no lines have been
1898 * read into memory, either because the file is empty or it does not exist, or cannot be
1899 * opened due to permission problems.
1905 /** Instantiates classes inherited from Module
1906 * This class creates a class inherited from type Module, using new. This is to allow for modules
1907 * to create many different variants of Module, dependent on architecture, configuration, etc.
1908 * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
1911 class ModuleFactory : public classbase
1915 virtual ~ModuleFactory() { }
1916 /** Creates a new module.
1917 * Your inherited class of ModuleFactory must return a pointer to your Module class
1918 * using this method.
1920 virtual Module * CreateModule(Server* Me) = 0;
1924 typedef DLLFactory<ModuleFactory> ircd_module;
1926 bool ModeDefined(char c, int i);
1927 bool ModeDefinedOper(char c, int i);
1928 int ModeDefinedOn(char c, int i);
1929 int ModeDefinedOff(char c, int i);
1930 void ModeMakeList(char modechar);
1931 bool ModeIsListMode(char modechar, int type);