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 OnAccessCheck() method of modules
27 enum AccessControlType {
28 ACR_DEFAULT, // Do default action (act as if the module isnt even loaded)
29 ACR_DENY, // deny the action
30 ACR_ALLOW, // allow the action
31 AC_KICK, // a user is being kicked
32 AC_DEOP, // a user is being deopped
33 AC_OP, // a user is being opped
34 AC_VOICE, // a user is being voiced
35 AC_DEVOICE, // a user is being devoiced
36 AC_HALFOP, // a user is being halfopped
37 AC_DEHALFOP, // a user is being dehalfopped
38 AC_INVITE, // a user is being invited
39 AC_GENERAL_MODE // a channel mode is being changed
42 /** Used to define a set of behavior bits for a module
45 VF_STATIC = 1, // module is static, cannot be /unloadmodule'd
46 VF_VENDOR = 2, // module is a vendor module (came in the original tarball, not 3rd party)
47 VF_SERVICEPROVIDER = 4, // module provides a service to other modules (can be a dependency)
48 VF_COMMON = 8 // module needs to be common on all servers in a network to link
56 enum TargetTypeFlags {
67 #include "inspsocket.h"
79 // Forward-delacare module for ModuleMessage etc
82 /** Low level definition of a FileReader classes file cache area
84 typedef std::deque<std::string> file_cache;
85 typedef file_cache string_list;
87 /** Holds a list of users in a channel
89 typedef std::deque<userrec*> chanuserlist;
92 /** Holds a list of 'published features' for modules.
94 typedef std::map<std::string,Module*> featurelist;
97 * This #define allows us to call a method in all
98 * loaded modules in a readable simple way, e.g.:
99 * 'FOREACH_MOD(I_OnXonnwxr,OnConnect(user));'
101 #define FOREACH_MOD(y,x) if (Config->global_implementation[y] > 0) { \
102 for (int _i = 0; _i <= MODCOUNT; _i++) { \
103 if (Config->implement_lists[_i][y]) \
108 catch (ModuleException& modexcept) \
110 log(DEBUG,"Module exception caught: %s",modexcept.GetReason()); \
116 * This define is similar to the one above but returns a result in MOD_RESULT.
117 * The first module to return a nonzero result is the value to be accepted,
118 * and any modules after are ignored.
120 #define FOREACH_RESULT(y,x) { if (Config->global_implementation[y] > 0) { \
122 for (int _i = 0; _i <= MODCOUNT; _i++) { \
123 if (Config->implement_lists[_i][y]) {\
126 int res = modules[_i]->x ; \
132 catch (ModuleException& modexcept) \
134 log(DEBUG,"Module exception cought: %s",modexcept.GetReason()); \
141 #define FD_MAGIC_NUMBER -42
145 #define IS_LOCAL(x) ((x->fd > -1) && (x->fd <= MAX_DESCRIPTORS))
146 #define IS_REMOTE(x) (x->fd < 0)
147 #define IS_MODULE_CREATED(x) (x->fd == FD_MAGIC_NUMBER)
149 /** Holds a module's Version information
150 * The four members (set by the constructor only) indicate details as to the version number
151 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
153 class Version : public classbase
156 const int Major, Minor, Revision, Build, Flags;
157 Version(int major, int minor, int revision, int build, int flags);
160 /** Holds /ADMIN data
161 * This class contains the admin details of the local server. It is constructed by class Server,
162 * and has three read-only values, Name, Email and Nick that contain the specified values for the
163 * server where the module is running.
165 class Admin : public classbase
168 const std::string Name, Email, Nick;
169 Admin(std::string name, std::string email, std::string nick);
172 /** The ModuleMessage class is the base class of Request and Event
173 * This class is used to represent a basic data structure which is passed
174 * between modules for safe inter-module communications.
176 class ModuleMessage : public classbase
179 /** This class is pure virtual and must be inherited.
181 virtual char* Send() = 0;
182 virtual ~ModuleMessage() {};
185 /** The Request class is a unicast message directed at a given module.
186 * When this class is properly instantiated it may be sent to a module
187 * using the Send() method, which will call the given module's OnRequest
188 * method with this class as its parameter.
190 class Request : public ModuleMessage
193 /** This member holds a pointer to arbitary data set by the emitter of the message
196 /** This is a pointer to the sender of the message, which can be used to
197 * directly trigger events, or to create a reply.
200 /** The single destination of the Request
204 /** Create a new Request
206 Request(char* anydata, Module* src, Module* dst);
207 /** Fetch the Request data
210 /** Fetch the request source
213 /** Fetch the request destination (should be 'this' in the receiving module)
216 /** Send the Request.
217 * Upon returning the result will be arbitary data returned by the module you
218 * sent the request to. It is up to your module to know what this data is and
219 * how to deal with it.
225 /** The Event class is a unicast message directed at all modules.
226 * When the class is properly instantiated it may be sent to all modules
227 * using the Send() method, which will trigger the OnEvent method in
228 * all modules passing the object as its parameter.
230 class Event : public ModuleMessage
233 /** This member holds a pointer to arbitary data set by the emitter of the message
236 /** This is a pointer to the sender of the message, which can be used to
237 * directly trigger events, or to create a reply.
240 /** The event identifier.
241 * This is arbitary text which should be used to distinguish
242 * one type of event from another.
246 /** Create a new Event
248 Event(char* anydata, Module* src, const std::string &eventid);
249 /** Get the Event data
252 /** Get the event Source
255 /** Get the event ID.
256 * Use this to determine the event type for safe casting of the data
258 std::string GetEventID();
260 * The return result of an Event::Send() will always be NULL as
261 * no replies are expected.
266 /** This class can be used on its own to represent an exception, or derived to represent a module-specific exception.
267 * When a module whishes to abort, e.g. within a constructor, it should throw an exception using ModuleException or
268 * a class derived from ModuleException. If a module throws an exception during its constructor, the module will not
269 * be loaded. If this happens, the error message returned by ModuleException::GetReason will be displayed to the user
270 * attempting to load the module, or dumped to the console if the ircd is currently loading for the first time.
272 class ModuleException : public classbase
275 /** Holds the error message to be displayed
279 /** Default constructor, just uses the error mesage 'Module threw an exception'.
281 ModuleException() : err("Module threw an exception") {}
282 /** This constructor can be used to specify an error message before throwing.
284 ModuleException(std::string message) : err(message) {}
285 /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
286 * Actually no, it does nothing. Never mind.
288 virtual ~ModuleException() {};
289 /** Returns the reason for the exception.
290 * The module should probably put something informative here as the user will see this upon failure.
292 virtual const char* GetReason()
298 /** Priority types which can be returned from Module::Prioritize()
300 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
302 /** Implementation-specific flags which may be set in Module::Implements()
304 enum Implementation { I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash, I_OnServerRaw,
305 I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois, I_OnUserPreInvite,
306 I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick, I_OnUserMessage, I_OnUserNotice, I_OnMode,
307 I_OnGetServerDescription, I_OnSyncUser, I_OnSyncChannel, I_OnSyncChannelMetaData, I_OnSyncUserMetaData,
308 I_OnDecodeMetaData, I_ProtoSendMode, I_ProtoSendMetaData, I_OnWallops, I_OnChangeHost, I_OnChangeName, I_OnAddGLine,
309 I_OnAddZLine, I_OnAddQLine, I_OnAddKLine, I_OnAddELine, I_OnDelGLine, I_OnDelZLine, I_OnDelKLine, I_OnDelELine, I_OnDelQLine,
310 I_OnCleanup, I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule, I_OnUnloadModule,
311 I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnUserRrgister, I_OnRawMode, I_OnCheckInvite,
312 I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnLocalTopicChange,
313 I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnOperCompre, I_OnGlobalOper, I_OnGlobalConnect, I_OnAddBan, I_OnDelBan,
314 I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead, I_OnChangeLocalUserGECOS, I_OnUserRegister,
315 I_OnOperCompare, I_OnChannelDelete, I_OnPostOper, I_OnSyncOtherMetaData, I_OnSetAway, I_OnCancelAway };
317 /** Base class for all InspIRCd modules
318 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
319 * its methods will be called when irc server events occur. class inherited from module must be
320 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
322 class Module : public Extensible
326 /** Default constructor
327 * Creates a module class.
328 * @param Me An instance of the Server class which can be saved for future use
329 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
333 /** Default destructor
334 * destroys a module class
338 /** Returns the version number of a Module.
339 * The method should return a Version object with its version information assigned via
342 virtual Version GetVersion();
344 /** The Implements function specifies which methods a module should receive events for.
345 * The char* parameter passed to this function contains a set of true or false values
346 * (1 or 0) which indicate wether each function is implemented. You must use the Iimplementation
347 * enum (documented elsewhere on this page) to mark functions as active. For example, to
348 * receive events for OnUserJoin():
350 * Implements[I_OnUserJoin] = 1;
352 * @param The implement list
354 virtual void Implements(char* Implements);
356 /** Used to set the 'priority' of a module (e.g. when it is called in relation to other modules.
357 * Some modules prefer to be called before other modules, due to their design. For example, a
358 * module which is expected to operate on complete information would expect to be placed last, so
359 * that any other modules which wish to adjust that information would execute before it, to be sure
360 * its information is correct. You can change your module's priority by returning one of:
362 * PRIORITY_FIRST - To place your module first in the list
364 * PRIORITY_LAST - To place your module last in the list
366 * PRIORITY_DONTCARE - To leave your module as it is (this is the default value, if you do not implement this function)
368 * The result of Server::PriorityBefore() - To move your module before another named module
370 * The result of Server::PriorityLast() - To move your module after another named module
372 * For a good working example of this method call, please see src/modules/m_spanningtree.cpp
373 * and src/modules/m_hostchange.so which make use of it. It is highly recommended that unless
374 * your module has a real need to reorder its priority, it should not implement this function,
375 * as many modules changing their priorities can make the system redundant.
377 virtual Priority Prioritize();
379 /** Called when a user connects.
380 * The details of the connecting user are available to you in the parameter userrec *user
381 * @param user The user who is connecting
383 virtual void OnUserConnect(userrec* user);
385 /** Called when a user quits.
386 * The details of the exiting user are available to you in the parameter userrec *user
387 * This event is only called when the user is fully registered when they quit. To catch
388 * raw disconnections, use the OnUserDisconnect method.
389 * @param user The user who is quitting
390 * @param message The user's quit message
392 virtual void OnUserQuit(userrec* user, const std::string &message);
394 /** Called whenever a user's socket is closed.
395 * The details of the exiting user are available to you in the parameter userrec *user
396 * This event is called for all users, registered or not, as a cleanup method for modules
397 * which might assign resources to user, such as dns lookups, objects and sockets.
398 * @param user The user who is disconnecting
400 virtual void OnUserDisconnect(userrec* user);
402 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
403 * @param chan The channel being deleted
405 virtual void OnChannelDelete(chanrec* chan);
407 /** Called when a user joins a channel.
408 * The details of the joining user are available to you in the parameter userrec *user,
409 * and the details of the channel they have joined is available in the variable chanrec *channel
410 * @param user The user who is joining
411 * @param channel The channel being joined
413 virtual void OnUserJoin(userrec* user, chanrec* channel);
415 /** Called when a user parts a channel.
416 * The details of the leaving user are available to you in the parameter userrec *user,
417 * and the details of the channel they have left is available in the variable chanrec *channel
418 * @param user The user who is parting
419 * @param channel The channel being parted
420 * @param partmessage The part message, or an empty string
422 virtual void OnUserPart(userrec* user, chanrec* channel, const std::string &partmessage);
424 /** Called on rehash.
425 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
426 * system. You should use it to reload any files so that your module keeps in step with the
427 * rest of the application. If a parameter is given, the core has done nothing. The module
428 * receiving the event can decide if this parameter has any relevence to it.
429 * @param parameter The (optional) parameter given to REHASH from the user.
431 virtual void OnRehash(const std::string ¶meter);
433 /** Called when a raw command is transmitted or received.
434 * This method is the lowest level of handler available to a module. It will be called with raw
435 * data which is passing through a connected socket. If you wish, you may munge this data by changing
436 * the string parameter "raw". If you do this, after your function exits it will immediately be
437 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
438 * inbound is set to true) the value of user will be the userrec of the connection sending the
439 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
440 * @param raw The raw string in RFC1459 format
441 * @param inbound A flag to indicate wether the data is coming into the daemon or going out to the user
442 * @param user The user record sending the text, when inbound == true.
444 virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
446 /** Called whenever a user is about to join a channel, before any processing is done.
447 * Returning a value of 1 from this function stops the process immediately, causing no
448 * output to be sent to the user by the core. If you do this you must produce your own numerics,
449 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
450 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
454 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
455 * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
456 * processing on the actual channel record at this point, however the channel NAME will still be passed in
457 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
458 * @param user The user joining the channel
459 * @param cname The channel name being joined
460 * @return 1 To prevent the join, 0 to allow it.
462 virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname);
464 /** Called whenever a user is about to be kicked.
465 * Returning a value of 1 from this function stops the process immediately, causing no
466 * output to be sent to the user by the core. If you do this you must produce your own numerics,
468 * @param source The user issuing the kick
469 * @param user The user being kicked
470 * @param chan The channel the user is being kicked from
471 * @param reason The kick reason
472 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
474 virtual int OnUserPreKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason);
476 /** Called whenever a user is kicked.
477 * If this method is called, the kick is already underway and cannot be prevented, so
478 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
479 * @param source The user issuing the kick
480 * @param user The user being kicked
481 * @param chan The channel the user is being kicked from
482 * @param reason The kick reason
484 virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason);
486 /** Called whenever a user opers locally.
487 * The userrec will contain the oper mode 'o' as this function is called after any modifications
488 * are made to the user's structure by the core.
489 * @param user The user who is opering up
490 * @param opertype The opers type name
492 virtual void OnOper(userrec* user, const std::string &opertype);
494 /** Called after a user opers locally.
495 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
496 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
497 * out the OPERTYPE, etc.
498 * @param user The user who is opering up
499 * @param opertype The opers type name
501 virtual void OnPostOper(userrec* user, const std::string &opertype);
503 /** Called whenever a user types /INFO.
504 * The userrec will contain the information of the user who typed the command. Modules may use this
505 * method to output their own credits in /INFO (which is the ircd's version of an about box).
506 * It is purposefully not possible to modify any info that has already been output, or halt the list.
507 * You must write a 371 numeric to the user, containing your info in the following format:
509 * <nick> :information here
511 * @param user The user issuing /INFO
513 virtual void OnInfo(userrec* user);
515 /** Called whenever a /WHOIS is performed on a local user.
516 * The source parameter contains the details of the user who issued the WHOIS command, and
517 * the dest parameter contains the information of the user they are whoising.
518 * @param source The user issuing the WHOIS command
519 * @param dest The user who is being WHOISed
521 virtual void OnWhois(userrec* source, userrec* dest);
523 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
524 * Returning 1 from this function stops the process immediately, causing no
525 * output to be sent to the user by the core. If you do this you must produce your own numerics,
526 * notices etc. This is useful for modules which may want to filter invites to channels.
527 * @param source The user who is issuing the INVITE
528 * @param dest The user being invited
529 * @param channel The channel the user is being invited to
530 * @return 1 to deny the invite, 0 to allow
532 virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel);
534 /** Called after a user has been successfully invited to a channel.
535 * You cannot prevent the invite from occuring using this function, to do that,
536 * use OnUserPreInvite instead.
537 * @param source The user who is issuing the INVITE
538 * @param dest The user being invited
539 * @param channel The channel the user is being invited to
541 virtual void OnUserInvite(userrec* source,userrec* dest,chanrec* channel);
543 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
544 * Returning any nonzero value from this function stops the process immediately, causing no
545 * output to be sent to the user by the core. If you do this you must produce your own numerics,
546 * notices etc. This is useful for modules which may want to filter or redirect messages.
547 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
548 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
549 * of where the message is destined to be sent.
550 * @param user The user sending the message
551 * @param dest The target of the message (chanrec* or userrec*)
552 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
553 * @param text Changeable text being sent by the user
554 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
555 * @return 1 to deny the NOTICE, 0 to allow it
557 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text,char status);
559 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
560 * Returning any nonzero value from this function stops the process immediately, causing no
561 * output to be sent to the user by the core. If you do this you must produce your own numerics,
562 * notices etc. This is useful for modules which may want to filter or redirect messages.
563 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
564 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
565 * of where the message is destined to be sent.
566 * You may alter the message text as you wish before relinquishing control to the next module
567 * in the chain, and if no other modules block the text this altered form of the text will be sent out
568 * to the user and possibly to other servers.
569 * @param user The user sending the message
570 * @param dest The target of the message (chanrec* or userrec*)
571 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
572 * @param text Changeable text being sent by the user
573 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
574 * @return 1 to deny the NOTICE, 0 to allow it
576 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text,char status);
578 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
579 * Please note that although you can see remote nickchanges through this function, you should
580 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
581 * check user->server before taking any action (including returning nonzero from the method).
582 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
583 * module to generate some meaninful output.
584 * @param user The username changing their nick
585 * @param newnick Their new nickname
586 * @return 1 to deny the change, 0 to allow
588 virtual int OnUserPreNick(userrec* user, const std::string &newnick);
590 /** Called after any PRIVMSG sent from a user.
591 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
592 * if target_type is TYPE_CHANNEL.
593 * @param user The user sending the message
594 * @param dest The target of the message
595 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
596 * @param text the text being sent by the user
597 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
599 virtual void OnUserMessage(userrec* user, void* dest, int target_type, const std::string &text, char status);
601 /** Called after any NOTICE sent from a user.
602 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
603 * if target_type is TYPE_CHANNEL.
604 * @param user The user sending the message
605 * @param dest The target of the message
606 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
607 * @param text the text being sent by the user
608 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
610 virtual void OnUserNotice(userrec* user, void* dest, int target_type, const std::string &text, char status);
612 /** Called after every MODE command sent from a user
613 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
614 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
615 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
616 * @param user The user sending the MODEs
617 * @param dest The target of the modes (userrec* or chanrec*)
618 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
619 * @param text The actual modes and their parameters if any
621 virtual void OnMode(userrec* user, void* dest, int target_type, const std::string &text);
623 /** Allows modules to alter or create server descriptions
624 * Whenever a module requires a server description, for example for display in
625 * WHOIS, this function is called in all modules. You may change or define the
626 * description given in std::string &description. If you do, this description
627 * will be shown in the WHOIS fields.
628 * @param servername The servername being searched for
629 * @param description Alterable server description for this server
631 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
633 /** Allows modules to synchronize data which relates to users during a netburst.
634 * When this function is called, it will be called from the module which implements
635 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
636 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
637 * (see below). This function will be called for every user visible on your side
638 * of the burst, allowing you to for example set modes, etc. Do not use this call to
639 * synchronize data which you have stored using class Extensible -- There is a specialist
640 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
641 * @param user The user being syncronized
642 * @param proto A pointer to the module handling network protocol
643 * @param opaque An opaque pointer set by the protocol module, should not be modified!
645 virtual void OnSyncUser(userrec* user, Module* proto, void* opaque);
647 /** Allows modules to synchronize data which relates to channels during a netburst.
648 * When this function is called, it will be called from the module which implements
649 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
650 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
651 * (see below). This function will be called for every user visible on your side
652 * of the burst, allowing you to for example set modes, etc. Do not use this call to
653 * synchronize data which you have stored using class Extensible -- There is a specialist
654 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
656 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
658 * @param chan The channel being syncronized
659 * @param proto A pointer to the module handling network protocol
660 * @param opaque An opaque pointer set by the protocol module, should not be modified!
662 virtual void OnSyncChannel(chanrec* chan, Module* proto, void* opaque);
664 /* Allows modules to syncronize metadata related to channels over the network during a netburst.
665 * Whenever the linking module wants to send out data, but doesnt know what the data
666 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
667 * this method is called.You should use the ProtoSendMetaData function after you've
668 * correctly decided how the data should be represented, to send the metadata on its way if it belongs
669 * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
670 * @param chan The channel whos metadata is being syncronized
671 * @param proto A pointer to the module handling network protocol
672 * @param opaque An opaque pointer set by the protocol module, should not be modified!
673 * @param extname The extensions name which is being searched for
675 virtual void OnSyncChannelMetaData(chanrec* chan, Module* proto,void* opaque, const std::string &extname);
677 /* Allows modules to syncronize metadata related to users over the network during a netburst.
678 * Whenever the linking module wants to send out data, but doesnt know what the data
679 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
680 * this method is called. You should use the ProtoSendMetaData function after you've
681 * correctly decided how the data should be represented, to send the metadata on its way if
682 * if it belongs to your module.
683 * @param user The user whos metadata is 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!
686 * @param extname The extensions name which is being searched for
688 virtual void OnSyncUserMetaData(userrec* user, Module* proto,void* opaque, const std::string &extname);
690 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
691 * Whenever the linking module wants to send out data, but doesnt know what the data
692 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
693 * this method is called. You should use the ProtoSendMetaData function after you've
694 * correctly decided how the data should be represented, to send the metadata on its way if
695 * if it belongs to your module.
696 * @param proto A pointer to the module handling network protocol
697 * @param opaque An opaque pointer set by the protocol module, should not be modified!
699 virtual void OnSyncOtherMetaData(Module* proto, void* opaque);
701 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
702 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
703 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
704 * @param target The chanrec* or userrec* that data should be added to
705 * @param extname The extension name which is being sent
706 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
708 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata);
710 /** Implemented by modules which provide the ability to link servers.
711 * These modules will implement this method, which allows transparent sending of servermodes
712 * down the network link as a broadcast, without a module calling it having to know the format
713 * of the MODE command before the actual mode string.
715 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
716 * of how to use this function.
718 * @param opaque An opaque pointer set by the protocol module, should not be modified!
719 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
720 * @param target The chanrec* or userrec* that modes should be sent for
721 * @param modeline The modes and parameters to be sent
723 virtual void ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline);
725 /** Implemented by modules which provide the ability to link servers.
726 * These modules will implement this method, which allows metadata (extra data added to
727 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
728 * to other servers on a netburst and decoded at the other end by the same module on a
731 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
732 * how to use this function.
733 * @param opaque An opaque pointer set by the protocol module, should not be modified!
734 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
735 * @param target The chanrec* or userrec* that metadata should be sent for
736 * @param extname The extension name to send metadata for
737 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
739 virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata);
741 /** Called after every WALLOPS command.
742 * @param user The user sending the WALLOPS
743 * @param text The content of the WALLOPS message
745 virtual void OnWallops(userrec* user, const std::string &text);
747 /** Called whenever a user's hostname is changed.
748 * This event triggers after the host has been set.
749 * @param user The user whos host is being changed
750 * @param newhost The new hostname being set
752 virtual void OnChangeHost(userrec* user, const std::string &newhost);
754 /** Called whenever a user's GECOS (realname) is changed.
755 * This event triggers after the name has been set.
756 * @param user The user who's GECOS is being changed
757 * @param gecos The new GECOS being set on the user
759 virtual void OnChangeName(userrec* user, const std::string &gecos);
761 /** Called whenever a gline is added by a local user.
762 * This method is triggered after the line is added.
763 * @param duration The duration of the line in seconds
764 * @param source The sender of the line
765 * @param reason The reason text to be displayed
766 * @param hostmask The hostmask to add
768 virtual void OnAddGLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
770 /** Called whenever a zline is added by a local user.
771 * This method is triggered after the line is added.
772 * @param duration The duration of the line in seconds
773 * @param source The sender of the line
774 * @param reason The reason text to be displayed
775 * @param ipmask The hostmask to add
777 virtual void OnAddZLine(long duration, userrec* source, const std::string &reason, const std::string &ipmask);
779 /** Called whenever a kline is added by a local user.
780 * This method is triggered after the line is added.
781 * @param duration The duration of the line in seconds
782 * @param source The sender of the line
783 * @param reason The reason text to be displayed
784 * @param hostmask The hostmask to add
786 virtual void OnAddKLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
788 /** Called whenever a qline is added by a local user.
789 * This method is triggered after the line is added.
790 * @param duration The duration of the line in seconds
791 * @param source The sender of the line
792 * @param reason The reason text to be displayed
793 * @param nickmask The hostmask to add
795 virtual void OnAddQLine(long duration, userrec* source, const std::string &reason, const std::string &nickmask);
797 /** Called whenever a eline is added by a local user.
798 * This method is triggered after the line is added.
799 * @param duration The duration of the line in seconds
800 * @param source The sender of the line
801 * @param reason The reason text to be displayed
802 * @param hostmask The hostmask to add
804 virtual void OnAddELine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
806 /** Called whenever a gline is deleted.
807 * This method is triggered after the line is deleted.
808 * @param source The user removing the line
809 * @param hostmask The hostmask to delete
811 virtual void OnDelGLine(userrec* source, const std::string &hostmask);
813 /** Called whenever a zline is deleted.
814 * This method is triggered after the line is deleted.
815 * @param source The user removing the line
816 * @param hostmask The hostmask to delete
818 virtual void OnDelZLine(userrec* source, const std::string &ipmask);
820 /** Called whenever a kline is deleted.
821 * This method is triggered after the line is deleted.
822 * @param source The user removing the line
823 * @param hostmask The hostmask to delete
825 virtual void OnDelKLine(userrec* source, const std::string &hostmask);
827 /** Called whenever a qline is deleted.
828 * This method is triggered after the line is deleted.
829 * @param source The user removing the line
830 * @param hostmask The hostmask to delete
832 virtual void OnDelQLine(userrec* source, const std::string &nickmask);
834 /** Called whenever a eline is deleted.
835 * This method is triggered after the line is deleted.
836 * @param source The user removing the line
837 * @param hostmask The hostmask to delete
839 virtual void OnDelELine(userrec* source, const std::string &hostmask);
841 /** Called before your module is unloaded to clean up Extensibles.
842 * This method is called once for every user and channel on the network,
843 * so that when your module unloads it may clear up any remaining data
844 * in the form of Extensibles added using Extensible::Extend().
845 * If the target_type variable is TYPE_USER, then void* item refers to
846 * a userrec*, otherwise it refers to a chanrec*.
847 * @param target_type The type of item being cleaned
848 * @param item A pointer to the item's class
850 virtual void OnCleanup(int target_type, void* item);
852 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
853 * have been applied. Please note that although you can see remote nickchanges through this function, you should
854 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
855 * check user->server before taking any action (including returning nonzero from the method).
856 * Because this method is called after the nickchange is taken place, no return values are possible
857 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
858 * @param user The user changing their nick
859 * @param oldnick The old nickname of the user before the nickchange
861 virtual void OnUserPostNick(userrec* user, const std::string &oldnick);
863 /** Called before an action which requires a channel privilage check.
864 * This function is called before many functions which check a users status on a channel, for example
865 * before opping a user, deopping a user, kicking a user, etc.
866 * There are several values for access_type which indicate for what reason access is being checked.
868 * AC_KICK (0) - A user is being kicked<br>
869 * AC_DEOP (1) - a user is being deopped<br>
870 * AC_OP (2) - a user is being opped<br>
871 * AC_VOICE (3) - a user is being voiced<br>
872 * AC_DEVOICE (4) - a user is being devoiced<br>
873 * AC_HALFOP (5) - a user is being halfopped<br>
874 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
875 * AC_INVITE () - a user is being invited<br>
876 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
877 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
878 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
879 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
880 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
881 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
882 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
883 * @param source The source of the access check
884 * @param dest The destination of the access check
885 * @param channel The channel which is being checked
886 * @param access_type See above
888 virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
890 /** Called when a 005 numeric is about to be output.
891 * The module should modify the 005 numeric if needed to indicate its features.
892 * @param output The 005 string to be modified if neccessary.
894 virtual void On005Numeric(std::string &output);
896 /** Called when a client is disconnected by KILL.
897 * If a client is killed by a server, e.g. a nickname collision or protocol error,
899 * Return 1 from this function to prevent the kill, and 0 from this function to allow
900 * it as normal. If you prevent the kill no output will be sent to the client, it is
901 * down to your module to generate this information.
902 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
903 * If you do so youre risking race conditions, desyncs and worse!
904 * @param source The user sending the KILL
905 * @param dest The user being killed
906 * @param reason The kill reason
907 * @return 1 to prevent the kill, 0 to allow
909 virtual int OnKill(userrec* source, userrec* dest, const std::string &reason);
911 /** Called when an oper wants to disconnect a remote user via KILL
912 * @param source The user sending the KILL
913 * @param dest The user being killed
914 * @param reason The kill reason
916 virtual void OnRemoteKill(userrec* source, userrec* dest, const std::string &reason);
918 /** Called whenever a module is loaded.
919 * mod will contain a pointer to the module, and string will contain its name,
920 * for example m_widgets.so. This function is primary for dependency checking,
921 * your module may decide to enable some extra features if it sees that you have
922 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
923 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
924 * but instead operate under reduced functionality, unless the dependency is
925 * absolutely neccessary (e.g. a module that extends the features of another
927 * @param mod A pointer to the new module
928 * @param name The new module's filename
930 virtual void OnLoadModule(Module* mod,const std::string &name);
932 /** Called whenever a module is unloaded.
933 * mod will contain a pointer to the module, and string will contain its name,
934 * for example m_widgets.so. This function is primary for dependency checking,
935 * your module may decide to enable some extra features if it sees that you have
936 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
937 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
938 * but instead operate under reduced functionality, unless the dependency is
939 * absolutely neccessary (e.g. a module that extends the features of another
941 * @param mod Pointer to the module being unloaded (still valid)
942 * @param name The filename of the module being unloaded
944 virtual void OnUnloadModule(Module* mod,const std::string &name);
946 /** Called once every five seconds for background processing.
947 * This timer can be used to control timed features. Its period is not accurate
948 * enough to be used as a clock, but it is gauranteed to be called at least once in
949 * any five second period, directly from the main loop of the server.
950 * @param curtime The current timer derived from time(2)
952 virtual void OnBackgroundTimer(time_t curtime);
954 /** Called whenever any command is about to be executed.
955 * This event occurs for all registered commands, wether they are registered in the core,
956 * or another module, but it will not occur for invalid commands (e.g. ones which do not
957 * exist within the command table). By returning 1 from this method you may prevent the
958 * command being executed. If you do this, no output is created by the core, and it is
959 * down to your module to produce any output neccessary.
960 * Note that unless you return 1, you should not destroy any structures (e.g. by using
961 * Server::QuitUser) otherwise when the command's handler function executes after your
962 * method returns, it will be passed an invalid pointer to the user object and crash!)
963 * @param command The command being executed
964 * @param parameters An array of array of characters containing the parameters for the command
965 * @param pcnt The nuimber of parameters passed to the command
966 * @param user the user issuing the command
967 * @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.
968 * @return 1 to block the command, 0 to allow
970 virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated);
972 /** Called to check if a user who is connecting can now be allowed to register
973 * If any modules return false for this function, the user is held in the waiting
974 * state until all modules return true. For example a module which implements ident
975 * lookups will continue to return false for a user until their ident lookup is completed.
976 * Note that the registration timeout for a user overrides these checks, if the registration
977 * timeout is reached, the user is disconnected even if modules report that the user is
978 * not ready to connect.
979 * @param user The user to check
980 * @return true to indicate readiness, false if otherwise
982 virtual bool OnCheckReady(userrec* user);
984 /** Called whenever a user is about to register their connection (e.g. before the user
985 * is sent the MOTD etc). Modules can use this method if they are performing a function
986 * which must be done before the actual connection is completed (e.g. ident lookups,
987 * dnsbl lookups, etc).
988 * Note that you should NOT delete the user record here by causing a disconnection!
989 * Use OnUserConnect for that instead.
990 * @param user The user registering
992 virtual void OnUserRegister(userrec* user);
994 /** Called whenever a mode character is processed.
995 * Return 1 from this function to block the mode character from being processed entirely,
996 * so that you may perform your own code instead. Note that this method allows you to override
997 * modes defined by other modes, but this is NOT RECOMMENDED!
998 * @param user The user who is sending the mode
999 * @param chan The channel the mode is being sent to
1000 * @param mode The mode character being set
1001 * @param param The parameter for the mode or an empty string
1002 * @param adding true of the mode is being added, false if it is being removed
1003 * @param pcnt The parameter count for the mode (0 or 1)
1004 * @return 1 to deny the mode, 0 to allow
1006 virtual int OnRawMode(userrec* user, chanrec* chan, char mode, const std::string ¶m, bool adding, int pcnt);
1008 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1009 * This method will always be called for each join, wether or not the channel is actually +i, and
1010 * determines the outcome of an if statement around the whole section of invite checking code.
1011 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1012 * @param user The user joining the channel
1013 * @param chan The channel being joined
1014 * @return 1 to explicitly allow the join, 0 to proceed as normal
1016 virtual int OnCheckInvite(userrec* user, chanrec* chan);
1018 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1019 * This method will always be called for each join, wether or not the channel is actually +k, and
1020 * determines the outcome of an if statement around the whole section of key checking code.
1021 * if the user specified no key, the keygiven string will be a valid but empty value.
1022 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1023 * @param user The user joining the channel
1024 * @param chan The channel being joined
1025 * @return 1 to explicitly allow the join, 0 to proceed as normal
1027 virtual int OnCheckKey(userrec* user, chanrec* chan, const std::string &keygiven);
1029 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1030 * This method will always be called for each join, wether or not the channel is actually +l, and
1031 * determines the outcome of an if statement around the whole section of channel limit checking code.
1032 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1033 * @param user The user joining the channel
1034 * @param chan The channel being joined
1035 * @return 1 to explicitly allow the join, 0 to proceed as normal
1037 virtual int OnCheckLimit(userrec* user, chanrec* chan);
1039 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
1040 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
1041 * determines the outcome of an if statement around the whole section of ban checking code.
1042 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1043 * @param user The user joining the channel
1044 * @param chan The channel being joined
1045 * @return 1 to explicitly allow the join, 0 to proceed as normal
1047 virtual int OnCheckBan(userrec* user, chanrec* chan);
1049 /** Called on all /STATS commands
1050 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1051 * @param symbol the symbol provided to /STATS
1052 * @user the user issuing the /STATS command
1053 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1055 virtual int OnStats(char symbol, userrec* user);
1057 /** Called whenever a change of a local users displayed host is attempted.
1058 * Return 1 to deny the host change, or 0 to allow it.
1059 * @param user The user whos host will be changed
1060 * @param newhost The new hostname
1061 * @return 1 to deny the host change, 0 to allow
1063 virtual int OnChangeLocalUserHost(userrec* user, const std::string &newhost);
1065 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1066 * return 1 to deny the name change, or 0 to allow it.
1067 * @param user The user whos GECOS will be changed
1068 * @param newhost The new GECOS
1069 * @return 1 to deny the GECOS change, 0 to allow
1071 virtual int OnChangeLocalUserGECOS(userrec* user, const std::string &newhost);
1073 /** Called whenever a topic is changed by a local user.
1074 * Return 1 to deny the topic change, or 0 to allow it.
1075 * @param user The user changing the topic
1076 * @param chan The channels who's topic is being changed
1077 * @param topic The actual topic text
1078 * @param 1 to block the topic change, 0 to allow
1080 virtual int OnLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic);
1082 /** Called whenever a local topic has been changed.
1083 * To block topic changes you must use OnLocalTopicChange instead.
1084 * @param user The user changing the topic
1085 * @param chan The channels who's topic is being changed
1086 * @param topic The actual topic text
1088 virtual void OnPostLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic);
1090 /** Called whenever an Event class is sent to all module by another module.
1091 * Please see the documentation of Event::Send() for further information. The Event sent can
1092 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1093 * before doing anything to the event data, and you should *not* change the event data in any way!
1094 * @param event The Event class being received
1096 virtual void OnEvent(Event* event);
1098 /** Called whenever a Request class is sent to your module by another module.
1099 * Please see the documentation of Request::Send() for further information. The Request sent
1100 * can always be assumed to be non-NULL, you should not change the request object or its data.
1101 * Your method may return arbitary data in the char* result which the requesting module
1102 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1103 * @param request The Request class being received
1105 virtual char* OnRequest(Request* request);
1107 /** Called whenever an oper password is to be compared to what a user has input.
1108 * The password field (from the config file) is in 'password' and is to be compared against
1109 * 'input'. This method allows for encryption of oper passwords and much more besides.
1110 * You should return a nonzero value if you want to allow the comparison or zero if you wish
1112 * @param password The oper's password
1113 * @param input The password entered
1114 * @return 1 to match the passwords, 0 to do nothing
1116 virtual int OnOperCompare(const std::string &password, const std::string &input);
1118 /** Called whenever a user is given usermode +o, anywhere on the network.
1119 * You cannot override this and prevent it from happening as it is already happened and
1120 * such a task must be performed by another server. You can however bounce modes by sending
1121 * servermodes out to reverse mode changes.
1122 * @param user The user who is opering
1124 virtual void OnGlobalOper(userrec* user);
1126 /** Called whenever a user connects, anywhere on the network.
1127 * This event is informational only. You should not change any user information in this
1128 * event. To do so, use the OnUserConnect method to change the state of local users.
1129 * @param user The user who is connecting
1131 virtual void OnGlobalConnect(userrec* user);
1133 /** Called whenever a ban is added to a channel's list.
1134 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1135 * @param source The user adding the ban
1136 * @param channel The channel the ban is being added to
1137 * @param banmask The ban mask being added
1138 * @return 1 to block the ban, 0 to continue as normal
1140 virtual int OnAddBan(userrec* source, chanrec* channel,const std::string &banmask);
1142 /** Called whenever a ban is removed from a channel's list.
1143 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1144 * @param source The user deleting the ban
1145 * @param channel The channel the ban is being deleted from
1146 * @param banmask The ban mask being deleted
1147 * @return 1 to block the unban, 0 to continue as normal
1149 virtual int OnDelBan(userrec* source, chanrec* channel,const std::string &banmask);
1151 /** Called immediately after any connection is accepted. This is intended for raw socket
1152 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1153 * no information relating to a user record as the connection has not been assigned yet.
1154 * There are no return values from this call as all modules get an opportunity if required to
1155 * process the connection.
1156 * @param fd The file descriptor returned from accept()
1157 * @param ip The IP address of the connecting user
1158 * @param localport The local port number the user connected to
1160 virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport);
1162 /** Called immediately before any write() operation on a user's socket in the core. Because
1163 * this event is a low level event no user information is associated with it. It is intended
1164 * for use by modules which may wrap connections within another API such as SSL for example.
1165 * return a non-zero result if you have handled the write operation, in which case the core
1166 * will not call write().
1167 * @param fd The file descriptor of the socket
1168 * @param buffer A char* buffer being written
1169 * @param Number of characters to write
1170 * @return Number of characters actually written or 0 if you didn't handle the operation
1172 virtual int OnRawSocketWrite(int fd, char* buffer, int count);
1174 /** Called immediately before any socket is closed. When this event is called, shutdown()
1175 * has not yet been called on the socket.
1176 * @param fd The file descriptor of the socket prior to close()
1178 virtual void OnRawSocketClose(int fd);
1180 /** Called immediately before any read() operation on a client socket in the core.
1181 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1182 * when this event occurs.
1183 * Your event should return 1 if it has handled the reading itself, which prevents the core
1184 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1185 * the value of count. The value of readresult must be identical to an actual result that might
1186 * be returned from the read() system call, for example, number of bytes read upon success,
1187 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1188 * you MUST set readresult.
1189 * @param fd The file descriptor of the socket
1190 * @param buffer A char* buffer being read to
1191 * @param count The size of the buffer
1192 * @param readresult The amount of characters read, or 0
1193 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1195 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1197 /** Called whenever a user sets away.
1198 * This method has no parameter for the away message, as it is available in the
1199 * user record as userrec::awaymsg.
1201 virtual void OnSetAway(userrec* user);
1203 /** Called when a user cancels their away state.
1205 virtual void OnCancelAway(userrec* user);
1209 /** Allows server output and query functions
1210 * This class contains methods which allow a module to query the state of the irc server, and produce
1211 * output to users and other servers. All modules should instantiate at least one copy of this class,
1212 * and use its member functions to perform their tasks.
1214 class Server : public Extensible
1217 /** Default constructor.
1218 * Creates a Server object.
1222 /** Default destructor.
1223 * Destroys a Server object.
1227 /** Obtains a pointer to the server's ServerConfig object.
1228 * The ServerConfig object contains most of the configuration data
1229 * of the IRC server, as read from the config file by the core.
1231 ServerConfig* GetConfig();
1233 /** For use with Module::Prioritize().
1234 * When the return value of this function is returned from
1235 * Module::Prioritize(), this specifies that the module wishes
1236 * to be ordered exactly BEFORE 'modulename'. For more information
1237 * please see Module::Prioritize().
1238 * @param modulename The module your module wants to be before in the call list
1239 * @returns a priority ID which the core uses to relocate the module in the list
1241 long PriorityBefore(const std::string &modulename);
1243 /** For use with Module::Prioritize().
1244 * When the return value of this function is returned from
1245 * Module::Prioritize(), this specifies that the module wishes
1246 * to be ordered exactly AFTER 'modulename'. For more information please
1247 * see Module::Prioritize().
1248 * @param modulename The module your module wants to be after in the call list
1249 * @returns a priority ID which the core uses to relocate the module in the list
1251 long PriorityAfter(const std::string &modulename);
1253 /** Sends text to all opers.
1254 * This method sends a server notice to all opers with the usermode +s.
1256 virtual void SendOpers(const std::string &s);
1258 /** Returns the version string of this server
1260 std::string GetVersion();
1262 /** Publish a 'feature'.
1263 * There are two ways for a module to find another module it depends on.
1264 * Either by name, using Server::FindModule, or by feature, using this
1265 * function. A feature is an arbitary string which identifies something this
1266 * module can do. For example, if your module provides SSL support, but other
1267 * modules provide SSL support too, all the modules supporting SSL should
1268 * publish an identical 'SSL' feature. This way, any module requiring use
1269 * of SSL functions can just look up the 'SSL' feature using FindFeature,
1270 * then use the module pointer they are given.
1271 * @param FeatureName The case sensitive feature name to make available
1272 * @param Mod a pointer to your module class
1273 * @returns True on success, false if the feature is already published by
1276 bool PublishFeature(const std::string &FeatureName, Module* Mod);
1278 /** Unpublish a 'feature'.
1279 * When your module exits, it must call this method for every feature it
1280 * is providing so that the feature table is cleaned up.
1281 * @param FeatureName the feature to remove
1283 bool UnpublishFeature(const std::string &FeatureName);
1285 /** Find a 'feature'.
1286 * There are two ways for a module to find another module it depends on.
1287 * Either by name, using Server::FindModule, or by feature, using the
1288 * Server::PublishFeature method. A feature is an arbitary string which
1289 * identifies something this module can do. For example, if your module
1290 * provides SSL support, but other modules provide SSL support too, all
1291 * the modules supporting SSL should publish an identical 'SSL' feature.
1292 * To find a module capable of providing the feature you want, simply
1293 * call this method with the feature name you are looking for.
1294 * @param FeatureName The feature name you wish to obtain the module for
1295 * @returns A pointer to a valid module class on success, NULL on failure.
1297 Module* FindFeature(const std::string &FeatureName);
1299 const std::string& GetModuleName(Module* m);
1301 /** Writes a log string.
1302 * This method writes a line of text to the log. If the level given is lower than the
1303 * level given in the configuration, this command has no effect.
1305 virtual void Log(int level, const std::string &s);
1307 /** Sends a line of text down a TCP/IP socket.
1308 * This method writes a line of text to an established socket, cutting it to 510 characters
1309 * plus a carriage return and linefeed if required.
1311 virtual void Send(int Socket, const std::string &s);
1313 /** Sends text from the server to a socket.
1314 * This method writes a line of text to an established socket, with the servername prepended
1315 * as used by numerics (see RFC 1459)
1317 virtual void SendServ(int Socket, const std::string &s);
1319 /** Writes text to a channel, but from a server, including all.
1320 * This can be used to send server notices to a group of users.
1322 virtual void SendChannelServerNotice(const std::string &ServName, chanrec* Channel, const std::string &text);
1324 /** Sends text from a user to a socket.
1325 * This method writes a line of text to an established socket, with the given user's nick/ident
1326 * /host combination prepended, as used in PRIVSG etc commands (see RFC 1459)
1328 virtual void SendFrom(int Socket, userrec* User, const std::string &s);
1330 /** Sends text from a user to another user.
1331 * This method writes a line of text to a user, with a user's nick/ident
1332 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459)
1333 * If you specify NULL as the source, then the data will originate from the
1334 * local server, e.g. instead of:
1336 * :user!ident@host TEXT
1338 * The format will become:
1342 * Which is useful for numerics and server notices to single users, etc.
1344 virtual void SendTo(userrec* Source, userrec* Dest, const std::string &s);
1346 /** Sends text from a user to a channel (mulicast).
1347 * This method writes a line of text to a channel, with the given user's nick/ident
1348 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the
1349 * IncludeSender flag is set, then the text is also sent back to the user from which
1350 * it originated, as seen in MODE (see RFC 1459).
1352 virtual void SendChannel(userrec* User, chanrec* Channel, const std::string &s, bool IncludeSender);
1354 /** Returns true if two users share a common channel.
1355 * This method is used internally by the NICK and QUIT commands, and the Server::SendCommon
1358 virtual bool CommonChannels(userrec* u1, userrec* u2);
1360 /** Sends text from a user to one or more channels (mulicast).
1361 * This method writes a line of text to all users which share a common channel with a given
1362 * user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc
1363 * commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent
1364 * back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it
1365 * is only sent to the other recipients, as seen in QUIT.
1367 virtual void SendCommon(userrec* User, const std::string &text, bool IncludeSender);
1369 /** Sends a WALLOPS message.
1370 * This method writes a WALLOPS message to all users with the +w flag, originating from the
1373 virtual void SendWallops(userrec* User, const std::string &text);
1375 /** Returns true if a nick is valid.
1376 * Nicks for unregistered connections will return false.
1378 virtual bool IsNick(const std::string &nick);
1380 /** Returns a count of the number of users on a channel.
1381 * This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.
1383 virtual int CountUsers(chanrec* c);
1385 /** Adds an InspTimer which will trigger at a future time
1387 virtual void AddTimer(InspTimer* T);
1389 /** Attempts to look up a nick and return a pointer to it.
1390 * This function will return NULL if the nick does not exist.
1392 virtual userrec* FindNick(const std::string &nick);
1394 /** Attempts to look up a nick using the file descriptor associated with that nick.
1395 * This function will return NULL if the file descriptor is not associated with a valid user.
1397 virtual userrec* FindDescriptor(int socket);
1399 /** Attempts to look up a channel and return a pointer to it.
1400 * This function will return NULL if the channel does not exist.
1402 virtual chanrec* FindChannel(const std::string &channel);
1404 /** Attempts to look up a user's privilages on a channel.
1405 * This function will return a string containing either @, %, +, or an empty string,
1406 * representing the user's privilages upon the channel you specify.
1408 virtual std::string ChanMode(userrec* User, chanrec* Chan);
1410 /** Returns the server name of the server where the module is loaded.
1412 virtual std::string GetServerName();
1414 /** Returns the network name, global to all linked servers.
1416 virtual std::string GetNetworkName();
1418 /** Returns the server description string of the local server
1420 virtual std::string GetServerDescription();
1422 /** Returns the information of the server as returned by the /ADMIN command.
1423 * See the Admin class for further information of the return value. The members
1424 * Admin::Nick, Admin::Email and Admin::Name contain the information for the
1425 * server where the module is loaded.
1427 virtual Admin GetAdmin();
1429 virtual bool AddMode(ModeHandler* mh, const unsigned char modechar);
1431 virtual bool AddModeWatcher(ModeWatcher* mw);
1433 virtual bool DelModeWatcher(ModeWatcher* mw);
1435 virtual bool AddResolver(Resolver* r);
1437 /** Adds a command to the command table.
1438 * This allows modules to add extra commands into the command table. You must place a function within your
1439 * module which is is of type handlerfunc:
1441 * typedef void (handlerfunc) (char**, int, userrec*);
1443 * void handle_kill(char **parameters, int pcnt, userrec *user)
1445 * When the command is typed, the parameters will be placed into the parameters array (similar to argv) and
1446 * the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters
1447 * than the 'minparams' value you specified when creating the command. The *user parameter is the class of
1448 * the user which caused the command to trigger, who will always have the flag you specified in 'flags' when
1449 * creating the initial command. For example to create an oper only command create the commands with flags='o'.
1450 * The source parameter is used for resource tracking, and should contain the name of your module (with file
1451 * extension) e.g. "m_blarp.so". If you place the wrong identifier here, you can cause crashes if your module
1454 virtual void AddCommand(command_t *f);
1456 /** Sends a servermode.
1457 * you must format the parameters array with the target, modes and parameters for those modes.
1463 * modes[0] = ChannelName;
1467 * modes[2] = user->nick;
1469 * Srv->SendMode(modes,3,user);
1471 * The modes will originate from the server where the command was issued, however responses (e.g. numerics)
1472 * will be sent to the user you provide as the third parameter.
1473 * You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave
1474 * your server in an unstable state!
1477 virtual void SendMode(const char **parameters, int pcnt, userrec *user);
1479 /** Sends to all users matching a mode mask
1480 * You must specify one or more usermodes as the first parameter. These can be RFC specified modes such as +i,
1481 * or module provided modes, including ones provided by your own module.
1482 * In the second parameter you must place a flag value which indicates wether the modes you have given will be
1483 * logically ANDed or OR'ed. You may use one of either WM_AND or WM_OR.
1484 * for example, if you were to use:
1486 * Serv->SendToModeMask("xi", WM_OR, "m00");
1488 * Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the
1489 * user must have both modes set to receive the message.
1491 virtual void SendToModeMask(const std::string &modes, int flags, const std::string &text);
1493 /** Forces a user to join a channel.
1494 * This is similar to svsjoin and can be used to implement redirection, etc.
1495 * On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to.
1496 * On failure, the result is NULL.
1498 virtual chanrec* JoinUserToChannel(userrec* user, const std::string &cname, const std::string &key);
1500 /** Forces a user to part a channel.
1501 * This is similar to svspart and can be used to implement redirection, etc.
1502 * Although the return value of this function is a pointer to a channel record, the returned data is
1503 * undefined and should not be read or written to. This behaviour may be changed in a future version.
1505 virtual chanrec* PartUserFromChannel(userrec* user, const std::string &cname, const std::string &reason);
1507 /** Forces a user nickchange.
1508 * This command works similarly to SVSNICK, and can be used to implement Q-lines etc.
1509 * If you specify an invalid nickname, the nick change will be dropped and the target user will receive
1510 * the error numeric for it.
1512 virtual void ChangeUserNick(userrec* user, const std::string &nickname);
1514 /** Forces a user to quit with the specified reason.
1515 * To the user, it will appear as if they typed /QUIT themselves, except for the fact that this function
1516 * may bypass the quit prefix specified in the config file.
1520 * Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or
1521 * read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of
1522 * action after calling this method is to immediately bail from your handler.
1524 virtual void QuitUser(userrec* user, const std::string &reason);
1526 /** Makes a user kick another user, with the specified reason.
1527 * If source is NULL, the server will peform the kick.
1528 * @param The person or server (if NULL) performing the KICK
1529 * @param target The person being kicked
1530 * @param chan The channel to kick from
1531 * @param reason The kick reason
1533 virtual void KickUser(userrec* source, userrec* target, chanrec* chan, const std::string &reason);
1535 /** Matches text against a glob pattern.
1536 * Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com
1537 * Returns true if the literal successfully matches the pattern, false if otherwise.
1539 virtual bool MatchText(const std::string &sliteral, const std::string &spattern);
1541 /** Calls the handler for a command, either implemented by the core or by another module.
1542 * You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN,
1543 * KICK etc, or even as a method of callback. By defining command names that are untypeable
1544 * for users on irc (e.g. those which contain a \r or \n) you may use them as callback identifiers.
1545 * The first parameter to this method is the name of the command handler you wish to call, e.g.
1546 * PRIVMSG. This will be a command handler previously registered by the core or wih AddCommand().
1547 * The second parameter is an array of parameters, and the third parameter is a count of parameters
1548 * in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the
1549 * functiom will silently ignore it. The final parameter is the user executing the command handler,
1550 * used for privilage checks, etc.
1551 * @return True if the command exists
1553 virtual bool CallCommandHandler(const std::string &commandname, const char** parameters, int pcnt, userrec* user);
1555 /** This function returns true if the commandname exists, pcnt is equal to or greater than the number
1556 * of paramters the command requires, the user specified is allowed to execute the command, AND
1557 * if the command is implemented by a module (not the core). This has a few specific uses, usually
1558 * within network protocols (see src/modules/m_spanningtree.cpp)
1560 virtual bool IsValidModuleCommand(const std::string &commandname, int pcnt, userrec* user);
1562 /** Change displayed hostname of a user.
1563 * You should always call this method to change a user's host rather than writing directly to the
1564 * dhost member of userrec, as any change applied via this method will be propogated to any
1567 virtual void ChangeHost(userrec* user, const std::string &host);
1569 /** Change GECOS (fullname) of a user.
1570 * You should always call this method to change a user's GECOS rather than writing directly to the
1571 * fullname member of userrec, as any change applied via this method will be propogated to any
1574 virtual void ChangeGECOS(userrec* user, const std::string &gecos);
1576 /** Returns true if the servername you give is ulined.
1577 * ULined servers have extra privilages. They are allowed to change nicknames on remote servers,
1578 * change modes of clients which are on remote servers and set modes of channels where there are
1579 * no channel operators for that channel on the ulined server, amongst other things.
1581 virtual bool IsUlined(const std::string &server);
1583 /** Fetches the userlist of a channel. This function must be here and not a member of userrec or
1584 * chanrec due to include constraints.
1586 virtual chanuserlist GetUsers(chanrec* chan);
1588 /** Remove a user's connection to the irc server, but leave their client in existence in the
1589 * user hash. When you call this function, the user's file descriptor will be replaced with the
1590 * value of FD_MAGIC_NUMBER and their old file descriptor will be closed. This idle client will
1591 * remain until it is restored with a valid file descriptor, or is removed from IRC by an operator
1592 * After this call, the pointer to user will be invalid.
1594 virtual bool UserToPseudo(userrec* user, const std::string &message);
1596 /** This user takes one user, and switches their file descriptor with another user, so that one user
1597 * "becomes" the other. The user in 'alive' is booted off the server with the given message. The user
1598 * referred to by 'zombie' should have previously been locked with Server::UserToPseudo, otherwise
1599 * stale sockets and file descriptor leaks can occur. After this call, the pointer to alive will be
1600 * invalid, and the pointer to zombie will be equivalent in effect to the old pointer to alive.
1602 virtual bool PseudoToUser(userrec* alive, userrec* zombie, const std::string &message);
1605 * The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1606 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1607 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1608 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1611 virtual void AddGLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1614 * The Q-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1615 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1616 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1617 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1620 virtual void AddQLine(long duration, const std::string &source, const std::string &reason, const std::string &nickname);
1623 * The Z-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1624 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1625 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1626 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1629 virtual void AddZLine(long duration, const std::string &source, const std::string &reason, const std::string &ipaddr);
1632 * The K-line is enforced as soon as it is added.
1633 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1634 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1635 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1638 virtual void AddKLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1641 * The E-line is enforced as soon as it is added.
1642 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1643 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1644 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1647 virtual void AddELine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1649 /** Deletes a G-Line from all servers
1651 virtual bool DelGLine(const std::string &hostmask);
1653 /** Deletes a Q-Line from all servers
1655 virtual bool DelQLine(const std::string &nickname);
1657 /** Deletes a Z-Line from all servers
1659 virtual bool DelZLine(const std::string &ipaddr);
1661 /** Deletes a local K-Line
1663 virtual bool DelKLine(const std::string &hostmask);
1665 /** Deletes a local E-Line
1667 virtual bool DelELine(const std::string &hostmask);
1669 /** Calculates a duration
1670 * This method will take a string containing a formatted duration (e.g. "1w2d") and return its value
1671 * as a total number of seconds. This is the same function used internally by /GLINE etc to set
1674 virtual long CalcDuration(const std::string &duration);
1676 /** Returns true if a nick!ident@host string is correctly formatted, false if otherwise.
1678 virtual bool IsValidMask(const std::string &mask);
1680 /** This function finds a module by name.
1681 * You must provide the filename of the module. If the module cannot be found (is not loaded)
1682 * the function will return NULL.
1684 virtual Module* FindModule(const std::string &name);
1686 /** Adds a class derived from InspSocket to the server's socket engine.
1688 virtual void AddSocket(InspSocket* sock);
1690 /** Forcibly removes a class derived from InspSocket from the servers socket engine.
1692 virtual void RemoveSocket(InspSocket* sock);
1694 /** Deletes a class derived from InspSocket from the server's socket engine.
1696 virtual void DelSocket(InspSocket* sock);
1698 /** Causes the local server to rehash immediately.
1699 * WARNING: Do not call this method from within your rehash method, for
1702 virtual void RehashServer();
1704 /** This method returns the total number of channels on the network.
1706 virtual long GetChannelCount();
1708 /** This method returns a channel whos index is greater than or equal to 0 and less than the number returned by Server::GetChannelCount().
1709 * This is slower (by factors of dozens) than requesting a channel by name with Server::FindChannel(), however there are times when
1710 * you wish to safely iterate the channel list, saving your position, with large amounts of time in between, which is what this function
1713 virtual chanrec* GetChannelIndex(long index);
1715 /** Dumps text (in a stringstream) to a user. The stringstream should not contain linefeeds, as it will be split
1716 * automatically by the function into safe amounts. The line prefix given is prepended onto each line (e.g. a servername
1719 void DumpText(userrec* User, const std::string &LinePrefix, stringstream &TextStream);
1723 #define CONF_NOT_A_NUMBER 0x000010
1724 #define CONF_NOT_UNSIGNED 0x000080
1725 #define CONF_VALUE_NOT_FOUND 0x000100
1726 #define CONF_FILE_NOT_FOUND 0x000200
1729 /** Allows reading of values from configuration files
1730 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1731 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1732 * Constructing the class using one parameter allows you to specify a path to your own configuration
1733 * file, otherwise, inspircd.conf is read.
1735 class ConfigReader : public classbase
1738 /** The contents of the configuration file
1739 * This protected member should never be accessed by a module (and cannot be accessed unless the
1740 * core is changed). It will contain a pointer to the configuration file data with unneeded data
1741 * (such as comments) stripped from it.
1743 ConfigDataHash* data;
1744 std::ostringstream* errorlog;;
1745 /** Used to store errors
1747 bool privatehash; // If we're using our own config data hash or not.
1752 /** Default constructor.
1753 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1754 * as specified when running ./configure.
1756 ConfigReader(); // default constructor reads ircd.conf
1757 /** Overloaded constructor.
1758 * This constructor initialises the ConfigReader class to read a user-specified config file
1760 ConfigReader(const std::string &filename); // read a module-specific config
1761 /** Default destructor.
1762 * This method destroys the ConfigReader class.
1765 /** Retrieves a value from the config file.
1766 * This method retrieves a value from the config file. Where multiple copies of the tag
1767 * exist in the config file, index indicates which of the values to retrieve.
1769 std::string ReadValue(const std::string &tag, const std::string &name, int index);
1770 /** Retrieves a boolean value from the config file.
1771 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1772 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1773 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1775 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1776 /** Retrieves an integer value from the config file.
1777 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1778 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1779 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1780 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1781 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1782 * will return CONF_NOT_UNSIGNED
1784 long ReadInteger(const std::string &tag, const std::string &name, int index, bool needs_unsigned);
1785 /** Returns the last error to occur.
1786 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1787 * A call to GetError() resets the error flag back to 0.
1790 /** Counts the number of times a given tag appears in the config file.
1791 * This method counts the number of times a tag appears in a config file, for use where
1792 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1793 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1794 * multiple instance tag.
1796 int Enumerate(const std::string &tag);
1797 /** Returns true if a config file is valid.
1798 * This method is partially implemented and will only return false if the config
1799 * file does not exist or could not be opened.
1802 /** Dumps the list of errors in a config file to an output location. If bail is true,
1803 * then the program will abort. If bail is false and user points to a valid user
1804 * record, the error report will be spooled to the given user by means of NOTICE.
1805 * if bool is false AND user is false, the error report will be spooled to all opers
1806 * by means of a NOTICE to all opers.
1808 void DumpErrors(bool bail,userrec* user);
1810 /** Returns the number of items within a tag.
1811 * For example if the tag was <test tag="blah" data="foo"> then this
1812 * function would return 2. Spaces and newlines both qualify as valid seperators
1815 int EnumerateValues(const std::string &tag, int index);
1820 /** Caches a text file into memory and can be used to retrieve lines from it.
1821 * This class contains methods for read-only manipulation of a text file in memory.
1822 * Either use the constructor type with one parameter to load a file into memory
1823 * at construction, or use the LoadFile method to load a file.
1825 class FileReader : public classbase
1827 /** The file contents
1831 unsigned long contentsize;
1836 /** Default constructor.
1837 * This method does not load any file into memory, you must use the LoadFile method
1838 * after constructing the class this way.
1842 /** Secondary constructor.
1843 * This method initialises the class with a file loaded into it ready for GetLine and
1844 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1847 FileReader(const std::string &filename);
1849 /** Default destructor.
1850 * This deletes the memory allocated to the file.
1854 /** Used to load a file.
1855 * This method loads a file into the class ready for GetLine and
1856 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1859 void LoadFile(const std::string &filename);
1861 /** Returns the whole content of the file as std::string
1863 std::string Contents();
1865 /** Returns the entire size of the file as std::string
1867 unsigned long ContentSize();
1869 /** Returns true if the file exists
1870 * This function will return false if the file could not be opened.
1874 /** Retrieve one line from the file.
1875 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1876 * the index was out of bounds, or the line had no data on it.
1878 std::string GetLine(int x);
1880 /** Returns the size of the file in lines.
1881 * This method returns the number of lines in the read file. If it is 0, no lines have been
1882 * read into memory, either because the file is empty or it does not exist, or cannot be
1883 * opened due to permission problems.
1889 /** Instantiates classes inherited from Module
1890 * This class creates a class inherited from type Module, using new. This is to allow for modules
1891 * to create many different variants of Module, dependent on architecture, configuration, etc.
1892 * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
1895 class ModuleFactory : public classbase
1899 virtual ~ModuleFactory() { }
1900 /** Creates a new module.
1901 * Your inherited class of ModuleFactory must return a pointer to your Module class
1902 * using this method.
1904 virtual Module * CreateModule(Server* Me) = 0;
1908 typedef DLLFactory<ModuleFactory> ircd_module;
1909 typedef std::vector<Module*> ModuleList;
1910 typedef std::vector<ircd_module*> FactoryList;