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"
78 // Forward-delacare module for ModuleMessage etc
81 /** Low level definition of a FileReader classes file cache area
83 typedef std::deque<std::string> file_cache;
84 typedef file_cache string_list;
86 /** Holds a list of users in a channel
88 typedef std::deque<userrec*> chanuserlist;
91 /** Holds a list of 'published features' for modules.
93 typedef std::map<std::string,Module*> featurelist;
96 * This #define allows us to call a method in all
97 * loaded modules in a readable simple way, e.g.:
98 * 'FOREACH_MOD(I_OnXonnwxr,OnConnect(user));'
100 #define FOREACH_MOD(y,x) if (Config->global_implementation[y] > 0) { \
101 for (int _i = 0; _i <= MODCOUNT; _i++) { \
102 if (Config->implement_lists[_i][y]) \
107 catch (ModuleException& modexcept) \
109 log(DEBUG,"Module exception caught: %s",modexcept.GetReason()); \
115 * This define is similar to the one above but returns a result in MOD_RESULT.
116 * The first module to return a nonzero result is the value to be accepted,
117 * and any modules after are ignored.
119 #define FOREACH_RESULT(y,x) { if (Config->global_implementation[y] > 0) { \
121 for (int _i = 0; _i <= MODCOUNT; _i++) { \
122 if (Config->implement_lists[_i][y]) {\
125 int res = modules[_i]->x ; \
131 catch (ModuleException& modexcept) \
133 log(DEBUG,"Module exception cought: %s",modexcept.GetReason()); \
140 #define FD_MAGIC_NUMBER -42
144 #define IS_LOCAL(x) ((x->fd > -1) && (x->fd <= MAX_DESCRIPTORS))
145 #define IS_REMOTE(x) (x->fd < 0)
146 #define IS_MODULE_CREATED(x) (x->fd == FD_MAGIC_NUMBER)
148 /** Holds a module's Version information
149 * The four members (set by the constructor only) indicate details as to the version number
150 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
152 class Version : public classbase
155 const int Major, Minor, Revision, Build, Flags;
156 Version(int major, int minor, int revision, int build, int flags);
159 /** Holds /ADMIN data
160 * This class contains the admin details of the local server. It is constructed by class Server,
161 * and has three read-only values, Name, Email and Nick that contain the specified values for the
162 * server where the module is running.
164 class Admin : public classbase
167 const std::string Name, Email, Nick;
168 Admin(std::string name, std::string email, std::string nick);
171 /** The ModuleMessage class is the base class of Request and Event
172 * This class is used to represent a basic data structure which is passed
173 * between modules for safe inter-module communications.
175 class ModuleMessage : public classbase
178 /** This class is pure virtual and must be inherited.
180 virtual char* Send() = 0;
181 virtual ~ModuleMessage() {};
184 /** The Request class is a unicast message directed at a given module.
185 * When this class is properly instantiated it may be sent to a module
186 * using the Send() method, which will call the given module's OnRequest
187 * method with this class as its parameter.
189 class Request : public ModuleMessage
192 /** This member holds a pointer to arbitary data set by the emitter of the message
195 /** This is a pointer to the sender of the message, which can be used to
196 * directly trigger events, or to create a reply.
199 /** The single destination of the Request
203 /** Create a new Request
205 Request(char* anydata, Module* src, Module* dst);
206 /** Fetch the Request data
209 /** Fetch the request source
212 /** Fetch the request destination (should be 'this' in the receiving module)
215 /** Send the Request.
216 * Upon returning the result will be arbitary data returned by the module you
217 * sent the request to. It is up to your module to know what this data is and
218 * how to deal with it.
224 /** The Event class is a unicast message directed at all modules.
225 * When the class is properly instantiated it may be sent to all modules
226 * using the Send() method, which will trigger the OnEvent method in
227 * all modules passing the object as its parameter.
229 class Event : public ModuleMessage
232 /** This member holds a pointer to arbitary data set by the emitter of the message
235 /** This is a pointer to the sender of the message, which can be used to
236 * directly trigger events, or to create a reply.
239 /** The event identifier.
240 * This is arbitary text which should be used to distinguish
241 * one type of event from another.
245 /** Create a new Event
247 Event(char* anydata, Module* src, const std::string &eventid);
248 /** Get the Event data
251 /** Get the event Source
254 /** Get the event ID.
255 * Use this to determine the event type for safe casting of the data
257 std::string GetEventID();
259 * The return result of an Event::Send() will always be NULL as
260 * no replies are expected.
265 /** This class can be used on its own to represent an exception, or derived to represent a module-specific exception.
266 * When a module whishes to abort, e.g. within a constructor, it should throw an exception using ModuleException or
267 * a class derived from ModuleException. If a module throws an exception during its constructor, the module will not
268 * be loaded. If this happens, the error message returned by ModuleException::GetReason will be displayed to the user
269 * attempting to load the module, or dumped to the console if the ircd is currently loading for the first time.
271 class ModuleException
274 /** Holds the error message to be displayed
278 /** Default constructor, just uses the error mesage 'Module threw an exception'.
280 ModuleException() : err("Module threw an exception") {}
281 /** This constructor can be used to specify an error message before throwing.
283 ModuleException(std::string message) : err(message) {}
284 /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
285 * Actually no, it does nothing. Never mind.
287 virtual ~ModuleException() {};
288 /** Returns the reason for the exception.
289 * The module should probably put something informative here as the user will see this upon failure.
291 virtual const char* GetReason()
297 /** Priority types which can be returned from Module::Prioritize()
299 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
301 /** Implementation-specific flags which may be set in Module::Implements()
303 enum Implementation { I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash, I_OnServerRaw,
304 I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois, I_OnUserPreInvite,
305 I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick, I_OnUserMessage, I_OnUserNotice, I_OnMode,
306 I_OnGetServerDescription, I_OnSyncUser, I_OnSyncChannel, I_OnSyncChannelMetaData, I_OnSyncUserMetaData,
307 I_OnDecodeMetaData, I_ProtoSendMode, I_ProtoSendMetaData, I_OnWallops, I_OnChangeHost, I_OnChangeName, I_OnAddGLine,
308 I_OnAddZLine, I_OnAddQLine, I_OnAddKLine, I_OnAddELine, I_OnDelGLine, I_OnDelZLine, I_OnDelKLine, I_OnDelELine, I_OnDelQLine,
309 I_OnCleanup, I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule, I_OnUnloadModule,
310 I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnUserRrgister, I_OnRawMode, I_OnCheckInvite,
311 I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnLocalTopicChange,
312 I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnOperCompre, I_OnGlobalOper, I_OnGlobalConnect, I_OnAddBan, I_OnDelBan,
313 I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead, I_OnChangeLocalUserGECOS, I_OnUserRegister,
314 I_OnOperCompare, I_OnChannelDelete, I_OnPostOper, I_OnSyncOtherMetaData, I_OnSetAway, I_OnCancelAway };
316 /** Base class for all InspIRCd modules
317 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
318 * its methods will be called when irc server events occur. class inherited from module must be
319 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
321 class Module : public classbase
325 /** Default constructor
326 * Creates a module class.
327 * @param Me An instance of the Server class which can be saved for future use
328 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
332 /** Default destructor
333 * destroys a module class
337 /** Returns the version number of a Module.
338 * The method should return a Version object with its version information assigned via
341 virtual Version GetVersion();
343 /** The Implements function specifies which methods a module should receive events for.
344 * The char* parameter passed to this function contains a set of true or false values
345 * (1 or 0) which indicate wether each function is implemented. You must use the Iimplementation
346 * enum (documented elsewhere on this page) to mark functions as active. For example, to
347 * receive events for OnUserJoin():
349 * Implements[I_OnUserJoin] = 1;
351 * @param The implement list
353 virtual void Implements(char* Implements);
355 /** Used to set the 'priority' of a module (e.g. when it is called in relation to other modules.
356 * Some modules prefer to be called before other modules, due to their design. For example, a
357 * module which is expected to operate on complete information would expect to be placed last, so
358 * that any other modules which wish to adjust that information would execute before it, to be sure
359 * its information is correct. You can change your module's priority by returning one of:
361 * PRIORITY_FIRST - To place your module first in the list
363 * PRIORITY_LAST - To place your module last in the list
365 * PRIORITY_DONTCARE - To leave your module as it is (this is the default value, if you do not implement this function)
367 * The result of Server::PriorityBefore() - To move your module before another named module
369 * The result of Server::PriorityLast() - To move your module after another named module
371 * For a good working example of this method call, please see src/modules/m_spanningtree.cpp
372 * and src/modules/m_hostchange.so which make use of it. It is highly recommended that unless
373 * your module has a real need to reorder its priority, it should not implement this function,
374 * as many modules changing their priorities can make the system redundant.
376 virtual Priority Prioritize();
378 /** Called when a user connects.
379 * The details of the connecting user are available to you in the parameter userrec *user
380 * @param user The user who is connecting
382 virtual void OnUserConnect(userrec* user);
384 /** Called when a user quits.
385 * The details of the exiting user are available to you in the parameter userrec *user
386 * This event is only called when the user is fully registered when they quit. To catch
387 * raw disconnections, use the OnUserDisconnect method.
388 * @param user The user who is quitting
389 * @param message The user's quit message
391 virtual void OnUserQuit(userrec* user, const std::string &message);
393 /** Called whenever a user's socket is closed.
394 * The details of the exiting user are available to you in the parameter userrec *user
395 * This event is called for all users, registered or not, as a cleanup method for modules
396 * which might assign resources to user, such as dns lookups, objects and sockets.
397 * @param user The user who is disconnecting
399 virtual void OnUserDisconnect(userrec* user);
401 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
402 * @param chan The channel being deleted
404 virtual void OnChannelDelete(chanrec* chan);
406 /** Called when a user joins a channel.
407 * The details of the joining user are available to you in the parameter userrec *user,
408 * and the details of the channel they have joined is available in the variable chanrec *channel
409 * @param user The user who is joining
410 * @param channel The channel being joined
412 virtual void OnUserJoin(userrec* user, chanrec* channel);
414 /** Called when a user parts a channel.
415 * The details of the leaving user are available to you in the parameter userrec *user,
416 * and the details of the channel they have left is available in the variable chanrec *channel
417 * @param user The user who is parting
418 * @param channel The channel being parted
419 * @param partmessage The part message, or an empty string
421 virtual void OnUserPart(userrec* user, chanrec* channel, const std::string &partmessage);
423 /** Called on rehash.
424 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
425 * system. You should use it to reload any files so that your module keeps in step with the
426 * rest of the application. If a parameter is given, the core has done nothing. The module
427 * receiving the event can decide if this parameter has any relevence to it.
428 * @param parameter The (optional) parameter given to REHASH from the user.
430 virtual void OnRehash(const std::string ¶meter);
432 /** Called when a raw command is transmitted or received.
433 * This method is the lowest level of handler available to a module. It will be called with raw
434 * data which is passing through a connected socket. If you wish, you may munge this data by changing
435 * the string parameter "raw". If you do this, after your function exits it will immediately be
436 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
437 * inbound is set to true) the value of user will be the userrec of the connection sending the
438 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
439 * @param raw The raw string in RFC1459 format
440 * @param inbound A flag to indicate wether the data is coming into the daemon or going out to the user
441 * @param user The user record sending the text, when inbound == true.
443 virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
445 /** Called whenever a user is about to join a channel, before any processing is done.
446 * Returning a value of 1 from this function stops the process immediately, causing no
447 * output to be sent to the user by the core. If you do this you must produce your own numerics,
448 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
449 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
453 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
454 * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
455 * processing on the actual channel record at this point, however the channel NAME will still be passed in
456 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
457 * @param user The user joining the channel
458 * @param cname The channel name being joined
459 * @return 1 To prevent the join, 0 to allow it.
461 virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname);
463 /** Called whenever a user is about to be kicked.
464 * Returning a value of 1 from this function stops the process immediately, causing no
465 * output to be sent to the user by the core. If you do this you must produce your own numerics,
467 * @param source The user issuing the kick
468 * @param user The user being kicked
469 * @param chan The channel the user is being kicked from
470 * @param reason The kick reason
471 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
473 virtual int OnUserPreKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason);
475 /** Called whenever a user is kicked.
476 * If this method is called, the kick is already underway and cannot be prevented, so
477 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
478 * @param source The user issuing the kick
479 * @param user The user being kicked
480 * @param chan The channel the user is being kicked from
481 * @param reason The kick reason
483 virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason);
485 /** Called whenever a user opers locally.
486 * The userrec will contain the oper mode 'o' as this function is called after any modifications
487 * are made to the user's structure by the core.
488 * @param user The user who is opering up
489 * @param opertype The opers type name
491 virtual void OnOper(userrec* user, const std::string &opertype);
493 /** Called after a user opers locally.
494 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
495 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
496 * out the OPERTYPE, etc.
497 * @param user The user who is opering up
498 * @param opertype The opers type name
500 virtual void OnPostOper(userrec* user, const std::string &opertype);
502 /** Called whenever a user types /INFO.
503 * The userrec will contain the information of the user who typed the command. Modules may use this
504 * method to output their own credits in /INFO (which is the ircd's version of an about box).
505 * It is purposefully not possible to modify any info that has already been output, or halt the list.
506 * You must write a 371 numeric to the user, containing your info in the following format:
508 * <nick> :information here
510 * @param user The user issuing /INFO
512 virtual void OnInfo(userrec* user);
514 /** Called whenever a /WHOIS is performed on a local user.
515 * The source parameter contains the details of the user who issued the WHOIS command, and
516 * the dest parameter contains the information of the user they are whoising.
517 * @param source The user issuing the WHOIS command
518 * @param dest The user who is being WHOISed
520 virtual void OnWhois(userrec* source, userrec* dest);
522 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
523 * Returning 1 from this function stops the process immediately, causing no
524 * output to be sent to the user by the core. If you do this you must produce your own numerics,
525 * notices etc. This is useful for modules which may want to filter invites to channels.
526 * @param source The user who is issuing the INVITE
527 * @param dest The user being invited
528 * @param channel The channel the user is being invited to
529 * @return 1 to deny the invite, 0 to allow
531 virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel);
533 /** Called after a user has been successfully invited to a channel.
534 * You cannot prevent the invite from occuring using this function, to do that,
535 * use OnUserPreInvite instead.
536 * @param source The user who is issuing the INVITE
537 * @param dest The user being invited
538 * @param channel The channel the user is being invited to
540 virtual void OnUserInvite(userrec* source,userrec* dest,chanrec* channel);
542 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
543 * Returning any nonzero value from this function stops the process immediately, causing no
544 * output to be sent to the user by the core. If you do this you must produce your own numerics,
545 * notices etc. This is useful for modules which may want to filter or redirect messages.
546 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
547 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
548 * of where the message is destined to be sent.
549 * @param user The user sending the message
550 * @param dest The target of the message (chanrec* or userrec*)
551 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
552 * @param text Changeable text being sent by the user
553 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
554 * @return 1 to deny the NOTICE, 0 to allow it
556 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text,char status);
558 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
559 * Returning any nonzero value from this function stops the process immediately, causing no
560 * output to be sent to the user by the core. If you do this you must produce your own numerics,
561 * notices etc. This is useful for modules which may want to filter or redirect messages.
562 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
563 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
564 * of where the message is destined to be sent.
565 * You may alter the message text as you wish before relinquishing control to the next module
566 * in the chain, and if no other modules block the text this altered form of the text will be sent out
567 * to the user and possibly to other servers.
568 * @param user The user sending the message
569 * @param dest The target of the message (chanrec* or userrec*)
570 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
571 * @param text Changeable text being sent by the user
572 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
573 * @return 1 to deny the NOTICE, 0 to allow it
575 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text,char status);
577 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
578 * Please note that although you can see remote nickchanges through this function, you should
579 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
580 * check user->server before taking any action (including returning nonzero from the method).
581 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
582 * module to generate some meaninful output.
583 * @param user The username changing their nick
584 * @param newnick Their new nickname
585 * @return 1 to deny the change, 0 to allow
587 virtual int OnUserPreNick(userrec* user, const std::string &newnick);
589 /** Called after any PRIVMSG sent from a user.
590 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
591 * if target_type is TYPE_CHANNEL.
592 * @param user The user sending the message
593 * @param dest The target of the message
594 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
595 * @param text the text being sent by the user
596 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
598 virtual void OnUserMessage(userrec* user, void* dest, int target_type, const std::string &text, char status);
600 /** Called after any NOTICE sent from a user.
601 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
602 * if target_type is TYPE_CHANNEL.
603 * @param user The user sending the message
604 * @param dest The target of the message
605 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
606 * @param text the text being sent by the user
607 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
609 virtual void OnUserNotice(userrec* user, void* dest, int target_type, const std::string &text, char status);
611 /** Called after every MODE command sent from a user
612 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
613 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
614 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
615 * @param user The user sending the MODEs
616 * @param dest The target of the modes (userrec* or chanrec*)
617 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
618 * @param text The actual modes and their parameters if any
620 virtual void OnMode(userrec* user, void* dest, int target_type, const std::string &text);
622 /** Allows modules to alter or create server descriptions
623 * Whenever a module requires a server description, for example for display in
624 * WHOIS, this function is called in all modules. You may change or define the
625 * description given in std::string &description. If you do, this description
626 * will be shown in the WHOIS fields.
627 * @param servername The servername being searched for
628 * @param description Alterable server description for this server
630 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
632 /** Allows modules to synchronize data which relates to users during a netburst.
633 * When this function is called, it will be called from the module which implements
634 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
635 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
636 * (see below). This function will be called for every user visible on your side
637 * of the burst, allowing you to for example set modes, etc. Do not use this call to
638 * synchronize data which you have stored using class Extensible -- There is a specialist
639 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
640 * @param user The user being syncronized
641 * @param proto A pointer to the module handling network protocol
642 * @param opaque An opaque pointer set by the protocol module, should not be modified!
644 virtual void OnSyncUser(userrec* user, Module* proto, void* opaque);
646 /** Allows modules to synchronize data which relates to channels during a netburst.
647 * When this function is called, it will be called from the module which implements
648 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
649 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
650 * (see below). This function will be called for every user visible on your side
651 * of the burst, allowing you to for example set modes, etc. Do not use this call to
652 * synchronize data which you have stored using class Extensible -- There is a specialist
653 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
655 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
657 * @param chan The channel being syncronized
658 * @param proto A pointer to the module handling network protocol
659 * @param opaque An opaque pointer set by the protocol module, should not be modified!
661 virtual void OnSyncChannel(chanrec* chan, Module* proto, void* opaque);
663 /* Allows modules to syncronize metadata related to channels over the network during a netburst.
664 * Whenever the linking module wants to send out data, but doesnt know what the data
665 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
666 * this method is called.You should use the ProtoSendMetaData function after you've
667 * correctly decided how the data should be represented, to send the metadata on its way if it belongs
668 * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
669 * @param chan The channel whos metadata is being syncronized
670 * @param proto A pointer to the module handling network protocol
671 * @param opaque An opaque pointer set by the protocol module, should not be modified!
672 * @param extname The extensions name which is being searched for
674 virtual void OnSyncChannelMetaData(chanrec* chan, Module* proto,void* opaque, const std::string &extname);
676 /* Allows modules to syncronize metadata related to users over the network during a netburst.
677 * Whenever the linking module wants to send out data, but doesnt know what the data
678 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
679 * this method is called. You should use the ProtoSendMetaData function after you've
680 * correctly decided how the data should be represented, to send the metadata on its way if
681 * if it belongs to your module.
682 * @param user The user whos metadata is being syncronized
683 * @param proto A pointer to the module handling network protocol
684 * @param opaque An opaque pointer set by the protocol module, should not be modified!
685 * @param extname The extensions name which is being searched for
687 virtual void OnSyncUserMetaData(userrec* user, Module* proto,void* opaque, const std::string &extname);
689 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
690 * Whenever the linking module wants to send out data, but doesnt know what the data
691 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
692 * this method is called. You should use the ProtoSendMetaData function after you've
693 * correctly decided how the data should be represented, to send the metadata on its way if
694 * if it belongs to your module.
695 * @param proto A pointer to the module handling network protocol
696 * @param opaque An opaque pointer set by the protocol module, should not be modified!
698 virtual void OnSyncOtherMetaData(Module* proto, void* opaque);
700 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
701 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
702 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
703 * @param target The chanrec* or userrec* that data should be added to
704 * @param extname The extension name which is being sent
705 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
707 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata);
709 /** Implemented by modules which provide the ability to link servers.
710 * These modules will implement this method, which allows transparent sending of servermodes
711 * down the network link as a broadcast, without a module calling it having to know the format
712 * of the MODE command before the actual mode string.
714 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
715 * of how to use this function.
717 * @param opaque An opaque pointer set by the protocol module, should not be modified!
718 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
719 * @param target The chanrec* or userrec* that modes should be sent for
720 * @param modeline The modes and parameters to be sent
722 virtual void ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline);
724 /** Implemented by modules which provide the ability to link servers.
725 * These modules will implement this method, which allows metadata (extra data added to
726 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
727 * to other servers on a netburst and decoded at the other end by the same module on a
730 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
731 * how to use this function.
732 * @param opaque An opaque pointer set by the protocol module, should not be modified!
733 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
734 * @param target The chanrec* or userrec* that metadata should be sent for
735 * @param extname The extension name to send metadata for
736 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
738 virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata);
740 /** Called after every WALLOPS command.
741 * @param user The user sending the WALLOPS
742 * @param text The content of the WALLOPS message
744 virtual void OnWallops(userrec* user, const std::string &text);
746 /** Called whenever a user's hostname is changed.
747 * This event triggers after the host has been set.
748 * @param user The user whos host is being changed
749 * @param newhost The new hostname being set
751 virtual void OnChangeHost(userrec* user, const std::string &newhost);
753 /** Called whenever a user's GECOS (realname) is changed.
754 * This event triggers after the name has been set.
755 * @param user The user who's GECOS is being changed
756 * @param gecos The new GECOS being set on the user
758 virtual void OnChangeName(userrec* user, const std::string &gecos);
760 /** Called whenever a gline is added by a local user.
761 * This method is triggered after the line is added.
762 * @param duration The duration of the line in seconds
763 * @param source The sender of the line
764 * @param reason The reason text to be displayed
765 * @param hostmask The hostmask to add
767 virtual void OnAddGLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
769 /** Called whenever a zline is added by a local user.
770 * This method is triggered after the line is added.
771 * @param duration The duration of the line in seconds
772 * @param source The sender of the line
773 * @param reason The reason text to be displayed
774 * @param ipmask The hostmask to add
776 virtual void OnAddZLine(long duration, userrec* source, const std::string &reason, const std::string &ipmask);
778 /** Called whenever a kline is added by a local user.
779 * This method is triggered after the line is added.
780 * @param duration The duration of the line in seconds
781 * @param source The sender of the line
782 * @param reason The reason text to be displayed
783 * @param hostmask The hostmask to add
785 virtual void OnAddKLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
787 /** Called whenever a qline is added by a local user.
788 * This method is triggered after the line is added.
789 * @param duration The duration of the line in seconds
790 * @param source The sender of the line
791 * @param reason The reason text to be displayed
792 * @param nickmask The hostmask to add
794 virtual void OnAddQLine(long duration, userrec* source, const std::string &reason, const std::string &nickmask);
796 /** Called whenever a eline is added by a local user.
797 * This method is triggered after the line is added.
798 * @param duration The duration of the line in seconds
799 * @param source The sender of the line
800 * @param reason The reason text to be displayed
801 * @param hostmask The hostmask to add
803 virtual void OnAddELine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
805 /** Called whenever a gline is deleted.
806 * This method is triggered after the line is deleted.
807 * @param source The user removing the line
808 * @param hostmask The hostmask to delete
810 virtual void OnDelGLine(userrec* source, const std::string &hostmask);
812 /** Called whenever a zline is deleted.
813 * This method is triggered after the line is deleted.
814 * @param source The user removing the line
815 * @param hostmask The hostmask to delete
817 virtual void OnDelZLine(userrec* source, const std::string &ipmask);
819 /** Called whenever a kline is deleted.
820 * This method is triggered after the line is deleted.
821 * @param source The user removing the line
822 * @param hostmask The hostmask to delete
824 virtual void OnDelKLine(userrec* source, const std::string &hostmask);
826 /** Called whenever a qline is deleted.
827 * This method is triggered after the line is deleted.
828 * @param source The user removing the line
829 * @param hostmask The hostmask to delete
831 virtual void OnDelQLine(userrec* source, const std::string &nickmask);
833 /** Called whenever a eline is deleted.
834 * This method is triggered after the line is deleted.
835 * @param source The user removing the line
836 * @param hostmask The hostmask to delete
838 virtual void OnDelELine(userrec* source, const std::string &hostmask);
840 /** Called before your module is unloaded to clean up Extensibles.
841 * This method is called once for every user and channel on the network,
842 * so that when your module unloads it may clear up any remaining data
843 * in the form of Extensibles added using Extensible::Extend().
844 * If the target_type variable is TYPE_USER, then void* item refers to
845 * a userrec*, otherwise it refers to a chanrec*.
846 * @param target_type The type of item being cleaned
847 * @param item A pointer to the item's class
849 virtual void OnCleanup(int target_type, void* item);
851 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
852 * have been applied. Please note that although you can see remote nickchanges through this function, you should
853 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
854 * check user->server before taking any action (including returning nonzero from the method).
855 * Because this method is called after the nickchange is taken place, no return values are possible
856 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
857 * @param user The user changing their nick
858 * @param oldnick The old nickname of the user before the nickchange
860 virtual void OnUserPostNick(userrec* user, const std::string &oldnick);
862 /** Called before an action which requires a channel privilage check.
863 * This function is called before many functions which check a users status on a channel, for example
864 * before opping a user, deopping a user, kicking a user, etc.
865 * There are several values for access_type which indicate for what reason access is being checked.
867 * AC_KICK (0) - A user is being kicked<br>
868 * AC_DEOP (1) - a user is being deopped<br>
869 * AC_OP (2) - a user is being opped<br>
870 * AC_VOICE (3) - a user is being voiced<br>
871 * AC_DEVOICE (4) - a user is being devoiced<br>
872 * AC_HALFOP (5) - a user is being halfopped<br>
873 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
874 * AC_INVITE () - a user is being invited<br>
875 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
876 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
877 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
878 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
879 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
880 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
881 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
882 * @param source The source of the access check
883 * @param dest The destination of the access check
884 * @param channel The channel which is being checked
885 * @param access_type See above
887 virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
889 /** Called when a 005 numeric is about to be output.
890 * The module should modify the 005 numeric if needed to indicate its features.
891 * @param output The 005 string to be modified if neccessary.
893 virtual void On005Numeric(std::string &output);
895 /** Called when a client is disconnected by KILL.
896 * If a client is killed by a server, e.g. a nickname collision or protocol error,
898 * Return 1 from this function to prevent the kill, and 0 from this function to allow
899 * it as normal. If you prevent the kill no output will be sent to the client, it is
900 * down to your module to generate this information.
901 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
902 * If you do so youre risking race conditions, desyncs and worse!
903 * @param source The user sending the KILL
904 * @param dest The user being killed
905 * @param reason The kill reason
906 * @return 1 to prevent the kill, 0 to allow
908 virtual int OnKill(userrec* source, userrec* dest, const std::string &reason);
910 /** Called when an oper wants to disconnect a remote user via KILL
911 * @param source The user sending the KILL
912 * @param dest The user being killed
913 * @param reason The kill reason
915 virtual void OnRemoteKill(userrec* source, userrec* dest, const std::string &reason);
917 /** Called whenever a module is loaded.
918 * mod will contain a pointer to the module, and string will contain its name,
919 * for example m_widgets.so. This function is primary for dependency checking,
920 * your module may decide to enable some extra features if it sees that you have
921 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
922 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
923 * but instead operate under reduced functionality, unless the dependency is
924 * absolutely neccessary (e.g. a module that extends the features of another
926 * @param mod A pointer to the new module
927 * @param name The new module's filename
929 virtual void OnLoadModule(Module* mod,const std::string &name);
931 /** Called whenever a module is unloaded.
932 * mod will contain a pointer to the module, and string will contain its name,
933 * for example m_widgets.so. This function is primary for dependency checking,
934 * your module may decide to enable some extra features if it sees that you have
935 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
936 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
937 * but instead operate under reduced functionality, unless the dependency is
938 * absolutely neccessary (e.g. a module that extends the features of another
940 * @param mod Pointer to the module being unloaded (still valid)
941 * @param name The filename of the module being unloaded
943 virtual void OnUnloadModule(Module* mod,const std::string &name);
945 /** Called once every five seconds for background processing.
946 * This timer can be used to control timed features. Its period is not accurate
947 * enough to be used as a clock, but it is gauranteed to be called at least once in
948 * any five second period, directly from the main loop of the server.
949 * @param curtime The current timer derived from time(2)
951 virtual void OnBackgroundTimer(time_t curtime);
953 /** Called whenever any command is about to be executed.
954 * This event occurs for all registered commands, wether they are registered in the core,
955 * or another module, but it will not occur for invalid commands (e.g. ones which do not
956 * exist within the command table). By returning 1 from this method you may prevent the
957 * command being executed. If you do this, no output is created by the core, and it is
958 * down to your module to produce any output neccessary.
959 * Note that unless you return 1, you should not destroy any structures (e.g. by using
960 * Server::QuitUser) otherwise when the command's handler function executes after your
961 * method returns, it will be passed an invalid pointer to the user object and crash!)
962 * @param command The command being executed
963 * @param parameters An array of array of characters containing the parameters for the command
964 * @param pcnt The nuimber of parameters passed to the command
965 * @param user the user issuing the command
966 * @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.
967 * @return 1 to block the command, 0 to allow
969 virtual int OnPreCommand(const std::string &command, char **parameters, int pcnt, userrec *user, bool validated);
971 /** Called to check if a user who is connecting can now be allowed to register
972 * If any modules return false for this function, the user is held in the waiting
973 * state until all modules return true. For example a module which implements ident
974 * lookups will continue to return false for a user until their ident lookup is completed.
975 * Note that the registration timeout for a user overrides these checks, if the registration
976 * timeout is reached, the user is disconnected even if modules report that the user is
977 * not ready to connect.
978 * @param user The user to check
979 * @return true to indicate readiness, false if otherwise
981 virtual bool OnCheckReady(userrec* user);
983 /** Called whenever a user is about to register their connection (e.g. before the user
984 * is sent the MOTD etc). Modules can use this method if they are performing a function
985 * which must be done before the actual connection is completed (e.g. ident lookups,
986 * dnsbl lookups, etc).
987 * Note that you should NOT delete the user record here by causing a disconnection!
988 * Use OnUserConnect for that instead.
989 * @param user The user registering
991 virtual void OnUserRegister(userrec* user);
993 /** Called whenever a mode character is processed.
994 * Return 1 from this function to block the mode character from being processed entirely,
995 * so that you may perform your own code instead. Note that this method allows you to override
996 * modes defined by other modes, but this is NOT RECOMMENDED!
997 * @param user The user who is sending the mode
998 * @param chan The channel the mode is being sent to
999 * @param mode The mode character being set
1000 * @param param The parameter for the mode or an empty string
1001 * @param adding true of the mode is being added, false if it is being removed
1002 * @param pcnt The parameter count for the mode (0 or 1)
1003 * @return 1 to deny the mode, 0 to allow
1005 virtual int OnRawMode(userrec* user, chanrec* chan, char mode, const std::string ¶m, bool adding, int pcnt);
1007 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1008 * This method will always be called for each join, wether or not the channel is actually +i, and
1009 * determines the outcome of an if statement around the whole section of invite checking code.
1010 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1011 * @param user The user joining the channel
1012 * @param chan The channel being joined
1013 * @return 1 to explicitly allow the join, 0 to proceed as normal
1015 virtual int OnCheckInvite(userrec* user, chanrec* chan);
1017 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1018 * This method will always be called for each join, wether or not the channel is actually +k, and
1019 * determines the outcome of an if statement around the whole section of key checking code.
1020 * if the user specified no key, the keygiven string will be a valid but empty value.
1021 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1022 * @param user The user joining the channel
1023 * @param chan The channel being joined
1024 * @return 1 to explicitly allow the join, 0 to proceed as normal
1026 virtual int OnCheckKey(userrec* user, chanrec* chan, const std::string &keygiven);
1028 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1029 * This method will always be called for each join, wether or not the channel is actually +l, and
1030 * determines the outcome of an if statement around the whole section of channel limit checking code.
1031 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1032 * @param user The user joining the channel
1033 * @param chan The channel being joined
1034 * @return 1 to explicitly allow the join, 0 to proceed as normal
1036 virtual int OnCheckLimit(userrec* user, chanrec* chan);
1038 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
1039 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
1040 * determines the outcome of an if statement around the whole section of ban checking code.
1041 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1042 * @param user The user joining the channel
1043 * @param chan The channel being joined
1044 * @return 1 to explicitly allow the join, 0 to proceed as normal
1046 virtual int OnCheckBan(userrec* user, chanrec* chan);
1048 /** Called on all /STATS commands
1049 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1050 * @param symbol the symbol provided to /STATS
1051 * @user the user issuing the /STATS command
1052 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1054 virtual int OnStats(char symbol, userrec* user);
1056 /** Called whenever a change of a local users displayed host is attempted.
1057 * Return 1 to deny the host change, or 0 to allow it.
1058 * @param user The user whos host will be changed
1059 * @param newhost The new hostname
1060 * @return 1 to deny the host change, 0 to allow
1062 virtual int OnChangeLocalUserHost(userrec* user, const std::string &newhost);
1064 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1065 * return 1 to deny the name change, or 0 to allow it.
1066 * @param user The user whos GECOS will be changed
1067 * @param newhost The new GECOS
1068 * @return 1 to deny the GECOS change, 0 to allow
1070 virtual int OnChangeLocalUserGECOS(userrec* user, const std::string &newhost);
1072 /** Called whenever a topic is changed by a local user.
1073 * Return 1 to deny the topic change, or 0 to allow it.
1074 * @param user The user changing the topic
1075 * @param chan The channels who's topic is being changed
1076 * @param topic The actual topic text
1077 * @param 1 to block the topic change, 0 to allow
1079 virtual int OnLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic);
1081 /** Called whenever a local topic has been changed.
1082 * To block topic changes you must use OnLocalTopicChange instead.
1083 * @param user The user changing the topic
1084 * @param chan The channels who's topic is being changed
1085 * @param topic The actual topic text
1087 virtual void OnPostLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic);
1089 /** Called whenever an Event class is sent to all module by another module.
1090 * Please see the documentation of Event::Send() for further information. The Event sent can
1091 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1092 * before doing anything to the event data, and you should *not* change the event data in any way!
1093 * @param event The Event class being received
1095 virtual void OnEvent(Event* event);
1097 /** Called whenever a Request class is sent to your module by another module.
1098 * Please see the documentation of Request::Send() for further information. The Request sent
1099 * can always be assumed to be non-NULL, you should not change the request object or its data.
1100 * Your method may return arbitary data in the char* result which the requesting module
1101 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1102 * @param request The Request class being received
1104 virtual char* OnRequest(Request* request);
1106 /** Called whenever an oper password is to be compared to what a user has input.
1107 * The password field (from the config file) is in 'password' and is to be compared against
1108 * 'input'. This method allows for encryption of oper passwords and much more besides.
1109 * You should return a nonzero value if you want to allow the comparison or zero if you wish
1111 * @param password The oper's password
1112 * @param input The password entered
1113 * @return 1 to match the passwords, 0 to do nothing
1115 virtual int OnOperCompare(const std::string &password, const std::string &input);
1117 /** Called whenever a user is given usermode +o, anywhere on the network.
1118 * You cannot override this and prevent it from happening as it is already happened and
1119 * such a task must be performed by another server. You can however bounce modes by sending
1120 * servermodes out to reverse mode changes.
1121 * @param user The user who is opering
1123 virtual void OnGlobalOper(userrec* user);
1125 /** Called whenever a user connects, anywhere on the network.
1126 * This event is informational only. You should not change any user information in this
1127 * event. To do so, use the OnUserConnect method to change the state of local users.
1128 * @param user The user who is connecting
1130 virtual void OnGlobalConnect(userrec* user);
1132 /** Called whenever a ban is added to a channel's list.
1133 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1134 * @param source The user adding the ban
1135 * @param channel The channel the ban is being added to
1136 * @param banmask The ban mask being added
1137 * @return 1 to block the ban, 0 to continue as normal
1139 virtual int OnAddBan(userrec* source, chanrec* channel,const std::string &banmask);
1141 /** Called whenever a ban is removed from a channel's list.
1142 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1143 * @param source The user deleting the ban
1144 * @param channel The channel the ban is being deleted from
1145 * @param banmask The ban mask being deleted
1146 * @return 1 to block the unban, 0 to continue as normal
1148 virtual int OnDelBan(userrec* source, chanrec* channel,const std::string &banmask);
1150 /** Called immediately after any connection is accepted. This is intended for raw socket
1151 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1152 * no information relating to a user record as the connection has not been assigned yet.
1153 * There are no return values from this call as all modules get an opportunity if required to
1154 * process the connection.
1155 * @param fd The file descriptor returned from accept()
1156 * @param ip The IP address of the connecting user
1157 * @param localport The local port number the user connected to
1159 virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport);
1161 /** Called immediately before any write() operation on a user's socket in the core. Because
1162 * this event is a low level event no user information is associated with it. It is intended
1163 * for use by modules which may wrap connections within another API such as SSL for example.
1164 * return a non-zero result if you have handled the write operation, in which case the core
1165 * will not call write().
1166 * @param fd The file descriptor of the socket
1167 * @param buffer A char* buffer being written
1168 * @param Number of characters to write
1169 * @return Number of characters actually written or 0 if you didn't handle the operation
1171 virtual int OnRawSocketWrite(int fd, char* buffer, int count);
1173 /** Called immediately before any socket is closed. When this event is called, shutdown()
1174 * has not yet been called on the socket.
1175 * @param fd The file descriptor of the socket prior to close()
1177 virtual void OnRawSocketClose(int fd);
1179 /** Called immediately before any read() operation on a client socket in the core.
1180 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1181 * when this event occurs.
1182 * Your event should return 1 if it has handled the reading itself, which prevents the core
1183 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1184 * the value of count. The value of readresult must be identical to an actual result that might
1185 * be returned from the read() system call, for example, number of bytes read upon success,
1186 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1187 * you MUST set readresult.
1188 * @param fd The file descriptor of the socket
1189 * @param buffer A char* buffer being read to
1190 * @param count The size of the buffer
1191 * @param readresult The amount of characters read, or 0
1192 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1194 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1196 /** Called whenever a user sets away.
1197 * This method has no parameter for the away message, as it is available in the
1198 * user record as userrec::awaymsg.
1200 virtual void OnSetAway(userrec* user);
1202 /** Called when a user cancels their away state.
1204 virtual void OnCancelAway(userrec* user);
1208 /** Allows server output and query functions
1209 * This class contains methods which allow a module to query the state of the irc server, and produce
1210 * output to users and other servers. All modules should instantiate at least one copy of this class,
1211 * and use its member functions to perform their tasks.
1213 class Server : public classbase
1216 /** Default constructor.
1217 * Creates a Server object.
1221 /** Default destructor.
1222 * Destroys a Server object.
1226 /** Obtains a pointer to the server's ServerConfig object.
1227 * The ServerConfig object contains most of the configuration data
1228 * of the IRC server, as read from the config file by the core.
1230 ServerConfig* GetConfig();
1232 /** For use with Module::Prioritize().
1233 * When the return value of this function is returned from
1234 * Module::Prioritize(), this specifies that the module wishes
1235 * to be ordered exactly BEFORE 'modulename'. For more information
1236 * please see Module::Prioritize().
1237 * @param modulename The module your module wants to be before in the call list
1238 * @returns a priority ID which the core uses to relocate the module in the list
1240 long PriorityBefore(const std::string &modulename);
1242 /** For use with Module::Prioritize().
1243 * When the return value of this function is returned from
1244 * Module::Prioritize(), this specifies that the module wishes
1245 * to be ordered exactly AFTER 'modulename'. For more information please
1246 * see Module::Prioritize().
1247 * @param modulename The module your module wants to be after in the call list
1248 * @returns a priority ID which the core uses to relocate the module in the list
1250 long PriorityAfter(const std::string &modulename);
1252 /** Sends text to all opers.
1253 * This method sends a server notice to all opers with the usermode +s.
1255 virtual void SendOpers(const std::string &s);
1257 /** Returns the version string of this server
1259 std::string GetVersion();
1261 /** Publish a 'feature'.
1262 * There are two ways for a module to find another module it depends on.
1263 * Either by name, using Server::FindModule, or by feature, using this
1264 * function. A feature is an arbitary string which identifies something this
1265 * module can do. For example, if your module provides SSL support, but other
1266 * modules provide SSL support too, all the modules supporting SSL should
1267 * publish an identical 'SSL' feature. This way, any module requiring use
1268 * of SSL functions can just look up the 'SSL' feature using FindFeature,
1269 * then use the module pointer they are given.
1270 * @param FeatureName The case sensitive feature name to make available
1271 * @param Mod a pointer to your module class
1272 * @returns True on success, false if the feature is already published by
1275 bool PublishFeature(const std::string &FeatureName, Module* Mod);
1277 /** Unpublish a 'feature'.
1278 * When your module exits, it must call this method for every feature it
1279 * is providing so that the feature table is cleaned up.
1280 * @param FeatureName the feature to remove
1282 bool UnpublishFeature(const std::string &FeatureName);
1284 /** Find a 'feature'.
1285 * There are two ways for a module to find another module it depends on.
1286 * Either by name, using Server::FindModule, or by feature, using the
1287 * Server::PublishFeature method. A feature is an arbitary string which
1288 * identifies something this module can do. For example, if your module
1289 * provides SSL support, but other modules provide SSL support too, all
1290 * the modules supporting SSL should publish an identical 'SSL' feature.
1291 * To find a module capable of providing the feature you want, simply
1292 * call this method with the feature name you are looking for.
1293 * @param FeatureName The feature name you wish to obtain the module for
1294 * @returns A pointer to a valid module class on success, NULL on failure.
1296 Module* FindFeature(const std::string &FeatureName);
1298 /** Writes a log string.
1299 * This method writes a line of text to the log. If the level given is lower than the
1300 * level given in the configuration, this command has no effect.
1302 virtual void Log(int level, const std::string &s);
1304 /** Sends a line of text down a TCP/IP socket.
1305 * This method writes a line of text to an established socket, cutting it to 510 characters
1306 * plus a carriage return and linefeed if required.
1308 virtual void Send(int Socket, const std::string &s);
1310 /** Sends text from the server to a socket.
1311 * This method writes a line of text to an established socket, with the servername prepended
1312 * as used by numerics (see RFC 1459)
1314 virtual void SendServ(int Socket, const std::string &s);
1316 /** Writes text to a channel, but from a server, including all.
1317 * This can be used to send server notices to a group of users.
1319 virtual void SendChannelServerNotice(const std::string &ServName, chanrec* Channel, const std::string &text);
1321 /** Sends text from a user to a socket.
1322 * This method writes a line of text to an established socket, with the given user's nick/ident
1323 * /host combination prepended, as used in PRIVSG etc commands (see RFC 1459)
1325 virtual void SendFrom(int Socket, userrec* User, const std::string &s);
1327 /** Sends text from a user to another user.
1328 * This method writes a line of text to a user, with a user's nick/ident
1329 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459)
1330 * If you specify NULL as the source, then the data will originate from the
1331 * local server, e.g. instead of:
1333 * :user!ident@host TEXT
1335 * The format will become:
1339 * Which is useful for numerics and server notices to single users, etc.
1341 virtual void SendTo(userrec* Source, userrec* Dest, const std::string &s);
1343 /** Sends text from a user to a channel (mulicast).
1344 * This method writes a line of text to a channel, with the given user's nick/ident
1345 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the
1346 * IncludeSender flag is set, then the text is also sent back to the user from which
1347 * it originated, as seen in MODE (see RFC 1459).
1349 virtual void SendChannel(userrec* User, chanrec* Channel, const std::string &s, bool IncludeSender);
1351 /** Returns true if two users share a common channel.
1352 * This method is used internally by the NICK and QUIT commands, and the Server::SendCommon
1355 virtual bool CommonChannels(userrec* u1, userrec* u2);
1357 /** Sends text from a user to one or more channels (mulicast).
1358 * This method writes a line of text to all users which share a common channel with a given
1359 * user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc
1360 * commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent
1361 * back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it
1362 * is only sent to the other recipients, as seen in QUIT.
1364 virtual void SendCommon(userrec* User, const std::string &text, bool IncludeSender);
1366 /** Sends a WALLOPS message.
1367 * This method writes a WALLOPS message to all users with the +w flag, originating from the
1370 virtual void SendWallops(userrec* User, const std::string &text);
1372 /** Returns true if a nick is valid.
1373 * Nicks for unregistered connections will return false.
1375 virtual bool IsNick(const std::string &nick);
1377 /** Returns a count of the number of users on a channel.
1378 * This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.
1380 virtual int CountUsers(chanrec* c);
1382 /** Adds an InspTimer which will trigger at a future time
1384 virtual void AddTimer(InspTimer* T);
1386 /** Attempts to look up a nick and return a pointer to it.
1387 * This function will return NULL if the nick does not exist.
1389 virtual userrec* FindNick(const std::string &nick);
1391 /** Attempts to look up a nick using the file descriptor associated with that nick.
1392 * This function will return NULL if the file descriptor is not associated with a valid user.
1394 virtual userrec* FindDescriptor(int socket);
1396 /** Attempts to look up a channel and return a pointer to it.
1397 * This function will return NULL if the channel does not exist.
1399 virtual chanrec* FindChannel(const std::string &channel);
1401 /** Attempts to look up a user's privilages on a channel.
1402 * This function will return a string containing either @, %, +, or an empty string,
1403 * representing the user's privilages upon the channel you specify.
1405 virtual std::string ChanMode(userrec* User, chanrec* Chan);
1407 /** Returns the server name of the server where the module is loaded.
1409 virtual std::string GetServerName();
1411 /** Returns the network name, global to all linked servers.
1413 virtual std::string GetNetworkName();
1415 /** Returns the server description string of the local server
1417 virtual std::string GetServerDescription();
1419 /** Returns the information of the server as returned by the /ADMIN command.
1420 * See the Admin class for further information of the return value. The members
1421 * Admin::Nick, Admin::Email and Admin::Name contain the information for the
1422 * server where the module is loaded.
1424 virtual Admin GetAdmin();
1426 virtual bool AddMode(ModeHandler* mh, const unsigned char modechar);
1428 /** Adds a command to the command table.
1429 * This allows modules to add extra commands into the command table. You must place a function within your
1430 * module which is is of type handlerfunc:
1432 * typedef void (handlerfunc) (char**, int, userrec*);
1434 * void handle_kill(char **parameters, int pcnt, userrec *user)
1436 * When the command is typed, the parameters will be placed into the parameters array (similar to argv) and
1437 * the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters
1438 * than the 'minparams' value you specified when creating the command. The *user parameter is the class of
1439 * the user which caused the command to trigger, who will always have the flag you specified in 'flags' when
1440 * creating the initial command. For example to create an oper only command create the commands with flags='o'.
1441 * The source parameter is used for resource tracking, and should contain the name of your module (with file
1442 * extension) e.g. "m_blarp.so". If you place the wrong identifier here, you can cause crashes if your module
1445 virtual void AddCommand(command_t *f);
1447 /** Sends a servermode.
1448 * you must format the parameters array with the target, modes and parameters for those modes.
1454 * modes[0] = ChannelName;
1458 * modes[2] = user->nick;
1460 * Srv->SendMode(modes,3,user);
1462 * The modes will originate from the server where the command was issued, however responses (e.g. numerics)
1463 * will be sent to the user you provide as the third parameter.
1464 * You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave
1465 * your server in an unstable state!
1468 virtual void SendMode(char **parameters, int pcnt, userrec *user);
1470 /** Sends to all users matching a mode mask
1471 * You must specify one or more usermodes as the first parameter. These can be RFC specified modes such as +i,
1472 * or module provided modes, including ones provided by your own module.
1473 * In the second parameter you must place a flag value which indicates wether the modes you have given will be
1474 * logically ANDed or OR'ed. You may use one of either WM_AND or WM_OR.
1475 * for example, if you were to use:
1477 * Serv->SendToModeMask("xi", WM_OR, "m00");
1479 * Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the
1480 * user must have both modes set to receive the message.
1482 virtual void SendToModeMask(const std::string &modes, int flags, const std::string &text);
1484 /** Forces a user to join a channel.
1485 * This is similar to svsjoin and can be used to implement redirection, etc.
1486 * On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to.
1487 * On failure, the result is NULL.
1489 virtual chanrec* JoinUserToChannel(userrec* user, const std::string &cname, const std::string &key);
1491 /** Forces a user to part a channel.
1492 * This is similar to svspart and can be used to implement redirection, etc.
1493 * Although the return value of this function is a pointer to a channel record, the returned data is
1494 * undefined and should not be read or written to. This behaviour may be changed in a future version.
1496 virtual chanrec* PartUserFromChannel(userrec* user, const std::string &cname, const std::string &reason);
1498 /** Forces a user nickchange.
1499 * This command works similarly to SVSNICK, and can be used to implement Q-lines etc.
1500 * If you specify an invalid nickname, the nick change will be dropped and the target user will receive
1501 * the error numeric for it.
1503 virtual void ChangeUserNick(userrec* user, const std::string &nickname);
1505 /** Forces a user to quit with the specified reason.
1506 * To the user, it will appear as if they typed /QUIT themselves, except for the fact that this function
1507 * may bypass the quit prefix specified in the config file.
1511 * Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or
1512 * read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of
1513 * action after calling this method is to immediately bail from your handler.
1515 virtual void QuitUser(userrec* user, const std::string &reason);
1517 /** Makes a user kick another user, with the specified reason.
1518 * If source is NULL, the server will peform the kick.
1519 * @param The person or server (if NULL) performing the KICK
1520 * @param target The person being kicked
1521 * @param chan The channel to kick from
1522 * @param reason The kick reason
1524 virtual void KickUser(userrec* source, userrec* target, chanrec* chan, const std::string &reason);
1526 /** Matches text against a glob pattern.
1527 * Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com
1528 * Returns true if the literal successfully matches the pattern, false if otherwise.
1530 virtual bool MatchText(const std::string &sliteral, const std::string &spattern);
1532 /** Calls the handler for a command, either implemented by the core or by another module.
1533 * You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN,
1534 * KICK etc, or even as a method of callback. By defining command names that are untypeable
1535 * for users on irc (e.g. those which contain a \r or \n) you may use them as callback identifiers.
1536 * The first parameter to this method is the name of the command handler you wish to call, e.g.
1537 * PRIVMSG. This will be a command handler previously registered by the core or wih AddCommand().
1538 * The second parameter is an array of parameters, and the third parameter is a count of parameters
1539 * in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the
1540 * functiom will silently ignore it. The final parameter is the user executing the command handler,
1541 * used for privilage checks, etc.
1542 * @return True if the command exists
1544 virtual bool CallCommandHandler(const std::string &commandname, char** parameters, int pcnt, userrec* user);
1546 /** This function returns true if the commandname exists, pcnt is equal to or greater than the number
1547 * of paramters the command requires, the user specified is allowed to execute the command, AND
1548 * if the command is implemented by a module (not the core). This has a few specific uses, usually
1549 * within network protocols (see src/modules/m_spanningtree.cpp)
1551 virtual bool IsValidModuleCommand(const std::string &commandname, int pcnt, userrec* user);
1553 /** Change displayed hostname of a user.
1554 * You should always call this method to change a user's host rather than writing directly to the
1555 * dhost member of userrec, as any change applied via this method will be propogated to any
1558 virtual void ChangeHost(userrec* user, const std::string &host);
1560 /** Change GECOS (fullname) of a user.
1561 * You should always call this method to change a user's GECOS rather than writing directly to the
1562 * fullname member of userrec, as any change applied via this method will be propogated to any
1565 virtual void ChangeGECOS(userrec* user, const std::string &gecos);
1567 /** Returns true if the servername you give is ulined.
1568 * ULined servers have extra privilages. They are allowed to change nicknames on remote servers,
1569 * change modes of clients which are on remote servers and set modes of channels where there are
1570 * no channel operators for that channel on the ulined server, amongst other things.
1572 virtual bool IsUlined(const std::string &server);
1574 /** Fetches the userlist of a channel. This function must be here and not a member of userrec or
1575 * chanrec due to include constraints.
1577 virtual chanuserlist GetUsers(chanrec* chan);
1579 /** Remove a user's connection to the irc server, but leave their client in existence in the
1580 * user hash. When you call this function, the user's file descriptor will be replaced with the
1581 * value of FD_MAGIC_NUMBER and their old file descriptor will be closed. This idle client will
1582 * remain until it is restored with a valid file descriptor, or is removed from IRC by an operator
1583 * After this call, the pointer to user will be invalid.
1585 virtual bool UserToPseudo(userrec* user, const std::string &message);
1587 /** This user takes one user, and switches their file descriptor with another user, so that one user
1588 * "becomes" the other. The user in 'alive' is booted off the server with the given message. The user
1589 * referred to by 'zombie' should have previously been locked with Server::UserToPseudo, otherwise
1590 * stale sockets and file descriptor leaks can occur. After this call, the pointer to alive will be
1591 * invalid, and the pointer to zombie will be equivalent in effect to the old pointer to alive.
1593 virtual bool PseudoToUser(userrec* alive, userrec* zombie, const std::string &message);
1596 * The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1597 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1598 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1599 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1602 virtual void AddGLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1605 * The Q-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 AddQLine(long duration, const std::string &source, const std::string &reason, const std::string &nickname);
1614 * The Z-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 AddZLine(long duration, const std::string &source, const std::string &reason, const std::string &ipaddr);
1623 * The K-line is 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 AddKLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1632 * The E-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 AddELine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1640 /** Deletes a G-Line from all servers
1642 virtual bool DelGLine(const std::string &hostmask);
1644 /** Deletes a Q-Line from all servers
1646 virtual bool DelQLine(const std::string &nickname);
1648 /** Deletes a Z-Line from all servers
1650 virtual bool DelZLine(const std::string &ipaddr);
1652 /** Deletes a local K-Line
1654 virtual bool DelKLine(const std::string &hostmask);
1656 /** Deletes a local E-Line
1658 virtual bool DelELine(const std::string &hostmask);
1660 /** Calculates a duration
1661 * This method will take a string containing a formatted duration (e.g. "1w2d") and return its value
1662 * as a total number of seconds. This is the same function used internally by /GLINE etc to set
1665 virtual long CalcDuration(const std::string &duration);
1667 /** Returns true if a nick!ident@host string is correctly formatted, false if otherwise.
1669 virtual bool IsValidMask(const std::string &mask);
1671 /** This function finds a module by name.
1672 * You must provide the filename of the module. If the module cannot be found (is not loaded)
1673 * the function will return NULL.
1675 virtual Module* FindModule(const std::string &name);
1677 /** Adds a class derived from InspSocket to the server's socket engine.
1679 virtual void AddSocket(InspSocket* sock);
1681 /** Forcibly removes a class derived from InspSocket from the servers socket engine.
1683 virtual void RemoveSocket(InspSocket* sock);
1685 /** Deletes a class derived from InspSocket from the server's socket engine.
1687 virtual void DelSocket(InspSocket* sock);
1689 /** Causes the local server to rehash immediately.
1690 * WARNING: Do not call this method from within your rehash method, for
1693 virtual void RehashServer();
1695 /** This method returns the total number of channels on the network.
1697 virtual long GetChannelCount();
1699 /** This method returns a channel whos index is greater than or equal to 0 and less than the number returned by Server::GetChannelCount().
1700 * This is slower (by factors of dozens) than requesting a channel by name with Server::FindChannel(), however there are times when
1701 * you wish to safely iterate the channel list, saving your position, with large amounts of time in between, which is what this function
1704 virtual chanrec* GetChannelIndex(long index);
1706 /** Dumps text (in a stringstream) to a user. The stringstream should not contain linefeeds, as it will be split
1707 * automatically by the function into safe amounts. The line prefix given is prepended onto each line (e.g. a servername
1710 void DumpText(userrec* User, const std::string &LinePrefix, stringstream &TextStream);
1714 #define CONF_NOT_A_NUMBER 0x000010
1715 #define CONF_NOT_UNSIGNED 0x000080
1716 #define CONF_VALUE_NOT_FOUND 0x000100
1717 #define CONF_FILE_NOT_FOUND 0x000200
1720 /** Allows reading of values from configuration files
1721 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1722 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1723 * Constructing the class using one parameter allows you to specify a path to your own configuration
1724 * file, otherwise, inspircd.conf is read.
1726 class ConfigReader : public classbase
1729 /** The contents of the configuration file
1730 * This protected member should never be accessed by a module (and cannot be accessed unless the
1731 * core is changed). It will contain a pointer to the configuration file data with unneeded data
1732 * (such as comments) stripped from it.
1734 ConfigDataHash* data;
1735 std::ostringstream* errorlog;;
1736 /** Used to store errors
1738 bool privatehash; // If we're using our own config data hash or not.
1743 /** Default constructor.
1744 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1745 * as specified when running ./configure.
1747 ConfigReader(); // default constructor reads ircd.conf
1748 /** Overloaded constructor.
1749 * This constructor initialises the ConfigReader class to read a user-specified config file
1751 ConfigReader(const std::string &filename); // read a module-specific config
1752 /** Default destructor.
1753 * This method destroys the ConfigReader class.
1756 /** Retrieves a value from the config file.
1757 * This method retrieves a value from the config file. Where multiple copies of the tag
1758 * exist in the config file, index indicates which of the values to retrieve.
1760 std::string ReadValue(const std::string &tag, const std::string &name, int index);
1761 /** Retrieves a boolean value from the config file.
1762 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1763 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1764 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1766 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1767 /** Retrieves an integer value from the config file.
1768 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1769 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1770 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1771 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1772 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1773 * will return CONF_NOT_UNSIGNED
1775 long ReadInteger(const std::string &tag, const std::string &name, int index, bool needs_unsigned);
1776 /** Returns the last error to occur.
1777 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1778 * A call to GetError() resets the error flag back to 0.
1781 /** Counts the number of times a given tag appears in the config file.
1782 * This method counts the number of times a tag appears in a config file, for use where
1783 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1784 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1785 * multiple instance tag.
1787 int Enumerate(const std::string &tag);
1788 /** Returns true if a config file is valid.
1789 * This method is partially implemented and will only return false if the config
1790 * file does not exist or could not be opened.
1793 /** Dumps the list of errors in a config file to an output location. If bail is true,
1794 * then the program will abort. If bail is false and user points to a valid user
1795 * record, the error report will be spooled to the given user by means of NOTICE.
1796 * if bool is false AND user is false, the error report will be spooled to all opers
1797 * by means of a NOTICE to all opers.
1799 void DumpErrors(bool bail,userrec* user);
1801 /** Returns the number of items within a tag.
1802 * For example if the tag was <test tag="blah" data="foo"> then this
1803 * function would return 2. Spaces and newlines both qualify as valid seperators
1806 int EnumerateValues(const std::string &tag, int index);
1811 /** Caches a text file into memory and can be used to retrieve lines from it.
1812 * This class contains methods for read-only manipulation of a text file in memory.
1813 * Either use the constructor type with one parameter to load a file into memory
1814 * at construction, or use the LoadFile method to load a file.
1816 class FileReader : public classbase
1818 /** The file contents
1822 /** Default constructor.
1823 * This method does not load any file into memory, you must use the LoadFile method
1824 * after constructing the class this way.
1828 /** Secondary constructor.
1829 * This method initialises the class with a file loaded into it ready for GetLine and
1830 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1833 FileReader(const std::string &filename);
1835 /** Default destructor.
1836 * This deletes the memory allocated to the file.
1840 /** Used to load a file.
1841 * This method loads a file into the class ready for GetLine and
1842 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1845 void LoadFile(const std::string &filename);
1847 /** Returns true if the file exists
1848 * This function will return false if the file could not be opened.
1852 /** Retrieve one line from the file.
1853 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1854 * the index was out of bounds, or the line had no data on it.
1856 std::string GetLine(int x);
1858 /** Returns the size of the file in lines.
1859 * This method returns the number of lines in the read file. If it is 0, no lines have been
1860 * read into memory, either because the file is empty or it does not exist, or cannot be
1861 * opened due to permission problems.
1867 /** Instantiates classes inherited from Module
1868 * This class creates a class inherited from type Module, using new. This is to allow for modules
1869 * to create many different variants of Module, dependent on architecture, configuration, etc.
1870 * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
1873 class ModuleFactory : public classbase
1877 virtual ~ModuleFactory() { }
1878 /** Creates a new module.
1879 * Your inherited class of ModuleFactory must return a pointer to your Module class
1880 * using this method.
1882 virtual Module * CreateModule(Server* Me) = 0;
1886 typedef DLLFactory<ModuleFactory> ircd_module;
1887 typedef std::vector<Module*> ModuleList;
1888 typedef std::vector<ircd_module*> FactoryList;