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 should be a null-terminated string identifying the type of request,
197 * all modules should define this and use it to determine the nature of the
198 * request before they attempt to cast the Request in any way.
201 /** This is a pointer to the sender of the message, which can be used to
202 * directly trigger events, or to create a reply.
205 /** The single destination of the Request
209 /** Create a new Request
210 * This is for the 'old' way of casting whatever the data is
211 * to char* and hoping you get the right thing at the other end.
212 * This is slowly being depreciated in favor of the 'new' way.
214 Request(char* anydata, Module* src, Module* dst);
215 /** Create a new Request
216 * This is for the 'new' way of defining a subclass
217 * of Request and defining it in a common header,
218 * passing an object of your Request subclass through
219 * as a Request* and using the ID string to determine
220 * what to cast it back to and the other end. This is
221 * much safer as there are no casts not confirmed by
222 * the ID string, and all casts are child->parent and
223 * can be checked at runtime with dynamic_cast<>()
225 Request(Module* src, Module* dst, const char* idstr);
226 /** Fetch the Request data
229 /** Fetch the ID string
232 /** Fetch the request source
235 /** Fetch the request destination (should be 'this' in the receiving module)
238 /** Send the Request.
239 * Upon returning the result will be arbitary data returned by the module you
240 * sent the request to. It is up to your module to know what this data is and
241 * how to deal with it.
247 /** The Event class is a unicast message directed at all modules.
248 * When the class is properly instantiated it may be sent to all modules
249 * using the Send() method, which will trigger the OnEvent method in
250 * all modules passing the object as its parameter.
252 class Event : public ModuleMessage
255 /** This member holds a pointer to arbitary data set by the emitter of the message
258 /** This is a pointer to the sender of the message, which can be used to
259 * directly trigger events, or to create a reply.
262 /** The event identifier.
263 * This is arbitary text which should be used to distinguish
264 * one type of event from another.
268 /** Create a new Event
270 Event(char* anydata, Module* src, const std::string &eventid);
271 /** Get the Event data
274 /** Get the event Source
277 /** Get the event ID.
278 * Use this to determine the event type for safe casting of the data
280 std::string GetEventID();
282 * The return result of an Event::Send() will always be NULL as
283 * no replies are expected.
288 /** This class can be used on its own to represent an exception, or derived to represent a module-specific exception.
289 * When a module whishes to abort, e.g. within a constructor, it should throw an exception using ModuleException or
290 * a class derived from ModuleException. If a module throws an exception during its constructor, the module will not
291 * be loaded. If this happens, the error message returned by ModuleException::GetReason will be displayed to the user
292 * attempting to load the module, or dumped to the console if the ircd is currently loading for the first time.
294 class ModuleException : public classbase
297 /** Holds the error message to be displayed
301 /** Default constructor, just uses the error mesage 'Module threw an exception'.
303 ModuleException() : err("Module threw an exception") {}
304 /** This constructor can be used to specify an error message before throwing.
306 ModuleException(std::string message) : err(message) {}
307 /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
308 * Actually no, it does nothing. Never mind.
310 virtual ~ModuleException() {};
311 /** Returns the reason for the exception.
312 * The module should probably put something informative here as the user will see this upon failure.
314 virtual const char* GetReason()
320 /** Priority types which can be returned from Module::Prioritize()
322 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
324 /** Implementation-specific flags which may be set in Module::Implements()
326 enum Implementation { I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash, I_OnServerRaw,
327 I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois, I_OnUserPreInvite,
328 I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick, I_OnUserMessage, I_OnUserNotice, I_OnMode,
329 I_OnGetServerDescription, I_OnSyncUser, I_OnSyncChannel, I_OnSyncChannelMetaData, I_OnSyncUserMetaData,
330 I_OnDecodeMetaData, I_ProtoSendMode, I_ProtoSendMetaData, I_OnWallops, I_OnChangeHost, I_OnChangeName, I_OnAddGLine,
331 I_OnAddZLine, I_OnAddQLine, I_OnAddKLine, I_OnAddELine, I_OnDelGLine, I_OnDelZLine, I_OnDelKLine, I_OnDelELine, I_OnDelQLine,
332 I_OnCleanup, I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule, I_OnUnloadModule,
333 I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnUserRrgister, I_OnRawMode, I_OnCheckInvite,
334 I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnLocalTopicChange,
335 I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnOperCompre, I_OnGlobalOper, I_OnGlobalConnect, I_OnAddBan, I_OnDelBan,
336 I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead, I_OnChangeLocalUserGECOS, I_OnUserRegister,
337 I_OnOperCompare, I_OnChannelDelete, I_OnPostOper, I_OnSyncOtherMetaData, I_OnSetAway, I_OnCancelAway };
339 /** Base class for all InspIRCd modules
340 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
341 * its methods will be called when irc server events occur. class inherited from module must be
342 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
344 class Module : public Extensible
348 /** Default constructor
349 * Creates a module class.
350 * @param Me An instance of the Server class which can be saved for future use
351 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
355 /** Default destructor
356 * destroys a module class
360 /** Returns the version number of a Module.
361 * The method should return a Version object with its version information assigned via
364 virtual Version GetVersion();
366 /** The Implements function specifies which methods a module should receive events for.
367 * The char* parameter passed to this function contains a set of true or false values
368 * (1 or 0) which indicate wether each function is implemented. You must use the Iimplementation
369 * enum (documented elsewhere on this page) to mark functions as active. For example, to
370 * receive events for OnUserJoin():
372 * Implements[I_OnUserJoin] = 1;
374 * @param The implement list
376 virtual void Implements(char* Implements);
378 /** Used to set the 'priority' of a module (e.g. when it is called in relation to other modules.
379 * Some modules prefer to be called before other modules, due to their design. For example, a
380 * module which is expected to operate on complete information would expect to be placed last, so
381 * that any other modules which wish to adjust that information would execute before it, to be sure
382 * its information is correct. You can change your module's priority by returning one of:
384 * PRIORITY_FIRST - To place your module first in the list
386 * PRIORITY_LAST - To place your module last in the list
388 * PRIORITY_DONTCARE - To leave your module as it is (this is the default value, if you do not implement this function)
390 * The result of Server::PriorityBefore() - To move your module before another named module
392 * The result of Server::PriorityLast() - To move your module after another named module
394 * For a good working example of this method call, please see src/modules/m_spanningtree.cpp
395 * and src/modules/m_hostchange.so which make use of it. It is highly recommended that unless
396 * your module has a real need to reorder its priority, it should not implement this function,
397 * as many modules changing their priorities can make the system redundant.
399 virtual Priority Prioritize();
401 /** Called when a user connects.
402 * The details of the connecting user are available to you in the parameter userrec *user
403 * @param user The user who is connecting
405 virtual void OnUserConnect(userrec* user);
407 /** Called when a user quits.
408 * The details of the exiting user are available to you in the parameter userrec *user
409 * This event is only called when the user is fully registered when they quit. To catch
410 * raw disconnections, use the OnUserDisconnect method.
411 * @param user The user who is quitting
412 * @param message The user's quit message
414 virtual void OnUserQuit(userrec* user, const std::string &message);
416 /** Called whenever a user's socket is closed.
417 * The details of the exiting user are available to you in the parameter userrec *user
418 * This event is called for all users, registered or not, as a cleanup method for modules
419 * which might assign resources to user, such as dns lookups, objects and sockets.
420 * @param user The user who is disconnecting
422 virtual void OnUserDisconnect(userrec* user);
424 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
425 * @param chan The channel being deleted
427 virtual void OnChannelDelete(chanrec* chan);
429 /** Called when a user joins a channel.
430 * The details of the joining user are available to you in the parameter userrec *user,
431 * and the details of the channel they have joined is available in the variable chanrec *channel
432 * @param user The user who is joining
433 * @param channel The channel being joined
435 virtual void OnUserJoin(userrec* user, chanrec* channel);
437 /** Called when a user parts a channel.
438 * The details of the leaving user are available to you in the parameter userrec *user,
439 * and the details of the channel they have left is available in the variable chanrec *channel
440 * @param user The user who is parting
441 * @param channel The channel being parted
442 * @param partmessage The part message, or an empty string
444 virtual void OnUserPart(userrec* user, chanrec* channel, const std::string &partmessage);
446 /** Called on rehash.
447 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
448 * system. You should use it to reload any files so that your module keeps in step with the
449 * rest of the application. If a parameter is given, the core has done nothing. The module
450 * receiving the event can decide if this parameter has any relevence to it.
451 * @param parameter The (optional) parameter given to REHASH from the user.
453 virtual void OnRehash(const std::string ¶meter);
455 /** Called when a raw command is transmitted or received.
456 * This method is the lowest level of handler available to a module. It will be called with raw
457 * data which is passing through a connected socket. If you wish, you may munge this data by changing
458 * the string parameter "raw". If you do this, after your function exits it will immediately be
459 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
460 * inbound is set to true) the value of user will be the userrec of the connection sending the
461 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
462 * @param raw The raw string in RFC1459 format
463 * @param inbound A flag to indicate wether the data is coming into the daemon or going out to the user
464 * @param user The user record sending the text, when inbound == true.
466 virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
468 /** Called whenever a user is about to join a channel, before any processing is done.
469 * Returning a value of 1 from this function stops the process immediately, causing no
470 * output to be sent to the user by the core. If you do this you must produce your own numerics,
471 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
472 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
476 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
477 * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
478 * processing on the actual channel record at this point, however the channel NAME will still be passed in
479 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
480 * @param user The user joining the channel
481 * @param cname The channel name being joined
482 * @return 1 To prevent the join, 0 to allow it.
484 virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname);
486 /** Called whenever a user is about to be kicked.
487 * Returning a value of 1 from this function stops the process immediately, causing no
488 * output to be sent to the user by the core. If you do this you must produce your own numerics,
490 * @param source The user issuing the kick
491 * @param user The user being kicked
492 * @param chan The channel the user is being kicked from
493 * @param reason The kick reason
494 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
496 virtual int OnUserPreKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason);
498 /** Called whenever a user is kicked.
499 * If this method is called, the kick is already underway and cannot be prevented, so
500 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
501 * @param source The user issuing the kick
502 * @param user The user being kicked
503 * @param chan The channel the user is being kicked from
504 * @param reason The kick reason
506 virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason);
508 /** Called whenever a user opers locally.
509 * The userrec will contain the oper mode 'o' as this function is called after any modifications
510 * are made to the user's structure by the core.
511 * @param user The user who is opering up
512 * @param opertype The opers type name
514 virtual void OnOper(userrec* user, const std::string &opertype);
516 /** Called after a user opers locally.
517 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
518 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
519 * out the OPERTYPE, etc.
520 * @param user The user who is opering up
521 * @param opertype The opers type name
523 virtual void OnPostOper(userrec* user, const std::string &opertype);
525 /** Called whenever a user types /INFO.
526 * The userrec will contain the information of the user who typed the command. Modules may use this
527 * method to output their own credits in /INFO (which is the ircd's version of an about box).
528 * It is purposefully not possible to modify any info that has already been output, or halt the list.
529 * You must write a 371 numeric to the user, containing your info in the following format:
531 * <nick> :information here
533 * @param user The user issuing /INFO
535 virtual void OnInfo(userrec* user);
537 /** Called whenever a /WHOIS is performed on a local user.
538 * The source parameter contains the details of the user who issued the WHOIS command, and
539 * the dest parameter contains the information of the user they are whoising.
540 * @param source The user issuing the WHOIS command
541 * @param dest The user who is being WHOISed
543 virtual void OnWhois(userrec* source, userrec* dest);
545 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
546 * Returning 1 from this function stops the process immediately, causing no
547 * output to be sent to the user by the core. If you do this you must produce your own numerics,
548 * notices etc. This is useful for modules which may want to filter invites to channels.
549 * @param source The user who is issuing the INVITE
550 * @param dest The user being invited
551 * @param channel The channel the user is being invited to
552 * @return 1 to deny the invite, 0 to allow
554 virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel);
556 /** Called after a user has been successfully invited to a channel.
557 * You cannot prevent the invite from occuring using this function, to do that,
558 * use OnUserPreInvite instead.
559 * @param source The user who is issuing the INVITE
560 * @param dest The user being invited
561 * @param channel The channel the user is being invited to
563 virtual void OnUserInvite(userrec* source,userrec* dest,chanrec* channel);
565 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
566 * Returning any nonzero value from this function stops the process immediately, causing no
567 * output to be sent to the user by the core. If you do this you must produce your own numerics,
568 * notices etc. This is useful for modules which may want to filter or redirect messages.
569 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
570 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
571 * of where the message is destined to be sent.
572 * @param user The user sending the message
573 * @param dest The target of the message (chanrec* or userrec*)
574 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
575 * @param text Changeable text being sent by the user
576 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
577 * @return 1 to deny the NOTICE, 0 to allow it
579 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text,char status);
581 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
582 * Returning any nonzero value from this function stops the process immediately, causing no
583 * output to be sent to the user by the core. If you do this you must produce your own numerics,
584 * notices etc. This is useful for modules which may want to filter or redirect messages.
585 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
586 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
587 * of where the message is destined to be sent.
588 * You may alter the message text as you wish before relinquishing control to the next module
589 * in the chain, and if no other modules block the text this altered form of the text will be sent out
590 * to the user and possibly to other servers.
591 * @param user The user sending the message
592 * @param dest The target of the message (chanrec* or userrec*)
593 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
594 * @param text Changeable text being sent by the user
595 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
596 * @return 1 to deny the NOTICE, 0 to allow it
598 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text,char status);
600 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
601 * Please note that although you can see remote nickchanges through this function, you should
602 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
603 * check user->server before taking any action (including returning nonzero from the method).
604 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
605 * module to generate some meaninful output.
606 * @param user The username changing their nick
607 * @param newnick Their new nickname
608 * @return 1 to deny the change, 0 to allow
610 virtual int OnUserPreNick(userrec* user, const std::string &newnick);
612 /** Called after any PRIVMSG 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.
615 * @param user The user sending the message
616 * @param dest The target of the message
617 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
618 * @param text the text being sent by the user
619 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
621 virtual void OnUserMessage(userrec* user, void* dest, int target_type, const std::string &text, char status);
623 /** Called after any NOTICE sent from a user.
624 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
625 * if target_type is TYPE_CHANNEL.
626 * @param user The user sending the message
627 * @param dest The target of the message
628 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
629 * @param text the text being sent by the user
630 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
632 virtual void OnUserNotice(userrec* user, void* dest, int target_type, const std::string &text, char status);
634 /** Called after every MODE command sent from a user
635 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
636 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
637 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
638 * @param user The user sending the MODEs
639 * @param dest The target of the modes (userrec* or chanrec*)
640 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
641 * @param text The actual modes and their parameters if any
643 virtual void OnMode(userrec* user, void* dest, int target_type, const std::string &text);
645 /** Allows modules to alter or create server descriptions
646 * Whenever a module requires a server description, for example for display in
647 * WHOIS, this function is called in all modules. You may change or define the
648 * description given in std::string &description. If you do, this description
649 * will be shown in the WHOIS fields.
650 * @param servername The servername being searched for
651 * @param description Alterable server description for this server
653 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
655 /** Allows modules to synchronize data which relates to users during a netburst.
656 * When this function is called, it will be called from the module which implements
657 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
658 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
659 * (see below). This function will be called for every user visible on your side
660 * of the burst, allowing you to for example set modes, etc. Do not use this call to
661 * synchronize data which you have stored using class Extensible -- There is a specialist
662 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
663 * @param user The user being syncronized
664 * @param proto A pointer to the module handling network protocol
665 * @param opaque An opaque pointer set by the protocol module, should not be modified!
667 virtual void OnSyncUser(userrec* user, Module* proto, void* opaque);
669 /** Allows modules to synchronize data which relates to channels during a netburst.
670 * When this function is called, it will be called from the module which implements
671 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
672 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
673 * (see below). This function will be called for every user visible on your side
674 * of the burst, allowing you to for example set modes, etc. Do not use this call to
675 * synchronize data which you have stored using class Extensible -- There is a specialist
676 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
678 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
680 * @param chan The channel being syncronized
681 * @param proto A pointer to the module handling network protocol
682 * @param opaque An opaque pointer set by the protocol module, should not be modified!
684 virtual void OnSyncChannel(chanrec* chan, Module* proto, void* opaque);
686 /* Allows modules to syncronize metadata related to channels over the network during a netburst.
687 * Whenever the linking module wants to send out data, but doesnt know what the data
688 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
689 * this method is called.You should use the ProtoSendMetaData function after you've
690 * correctly decided how the data should be represented, to send the metadata on its way if it belongs
691 * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
692 * @param chan The channel whos metadata is being syncronized
693 * @param proto A pointer to the module handling network protocol
694 * @param opaque An opaque pointer set by the protocol module, should not be modified!
695 * @param extname The extensions name which is being searched for
697 virtual void OnSyncChannelMetaData(chanrec* chan, Module* proto,void* opaque, const std::string &extname);
699 /* Allows modules to syncronize metadata related to users over the network during a netburst.
700 * Whenever the linking module wants to send out data, but doesnt know what the data
701 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
702 * this method is called. You should use the ProtoSendMetaData function after you've
703 * correctly decided how the data should be represented, to send the metadata on its way if
704 * if it belongs to your module.
705 * @param user The user whos metadata is being syncronized
706 * @param proto A pointer to the module handling network protocol
707 * @param opaque An opaque pointer set by the protocol module, should not be modified!
708 * @param extname The extensions name which is being searched for
710 virtual void OnSyncUserMetaData(userrec* user, Module* proto,void* opaque, const std::string &extname);
712 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
713 * Whenever the linking module wants to send out data, but doesnt know what the data
714 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
715 * this method is called. You should use the ProtoSendMetaData function after you've
716 * correctly decided how the data should be represented, to send the metadata on its way if
717 * if it belongs to your module.
718 * @param proto A pointer to the module handling network protocol
719 * @param opaque An opaque pointer set by the protocol module, should not be modified!
721 virtual void OnSyncOtherMetaData(Module* proto, void* opaque);
723 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
724 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
725 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
726 * @param target The chanrec* or userrec* that data should be added to
727 * @param extname The extension name which is being sent
728 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
730 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata);
732 /** Implemented by modules which provide the ability to link servers.
733 * These modules will implement this method, which allows transparent sending of servermodes
734 * down the network link as a broadcast, without a module calling it having to know the format
735 * of the MODE command before the actual mode string.
737 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
738 * of how to use this function.
740 * @param opaque An opaque pointer set by the protocol module, should not be modified!
741 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
742 * @param target The chanrec* or userrec* that modes should be sent for
743 * @param modeline The modes and parameters to be sent
745 virtual void ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline);
747 /** Implemented by modules which provide the ability to link servers.
748 * These modules will implement this method, which allows metadata (extra data added to
749 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
750 * to other servers on a netburst and decoded at the other end by the same module on a
753 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
754 * how to use this function.
755 * @param opaque An opaque pointer set by the protocol module, should not be modified!
756 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
757 * @param target The chanrec* or userrec* that metadata should be sent for
758 * @param extname The extension name to send metadata for
759 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
761 virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata);
763 /** Called after every WALLOPS command.
764 * @param user The user sending the WALLOPS
765 * @param text The content of the WALLOPS message
767 virtual void OnWallops(userrec* user, const std::string &text);
769 /** Called whenever a user's hostname is changed.
770 * This event triggers after the host has been set.
771 * @param user The user whos host is being changed
772 * @param newhost The new hostname being set
774 virtual void OnChangeHost(userrec* user, const std::string &newhost);
776 /** Called whenever a user's GECOS (realname) is changed.
777 * This event triggers after the name has been set.
778 * @param user The user who's GECOS is being changed
779 * @param gecos The new GECOS being set on the user
781 virtual void OnChangeName(userrec* user, const std::string &gecos);
783 /** Called whenever a gline is added by a local user.
784 * This method is triggered after the line is added.
785 * @param duration The duration of the line in seconds
786 * @param source The sender of the line
787 * @param reason The reason text to be displayed
788 * @param hostmask The hostmask to add
790 virtual void OnAddGLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
792 /** Called whenever a zline is added by a local user.
793 * This method is triggered after the line is added.
794 * @param duration The duration of the line in seconds
795 * @param source The sender of the line
796 * @param reason The reason text to be displayed
797 * @param ipmask The hostmask to add
799 virtual void OnAddZLine(long duration, userrec* source, const std::string &reason, const std::string &ipmask);
801 /** Called whenever a kline is added by a local user.
802 * This method is triggered after the line is added.
803 * @param duration The duration of the line in seconds
804 * @param source The sender of the line
805 * @param reason The reason text to be displayed
806 * @param hostmask The hostmask to add
808 virtual void OnAddKLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
810 /** Called whenever a qline is added by a local user.
811 * This method is triggered after the line is added.
812 * @param duration The duration of the line in seconds
813 * @param source The sender of the line
814 * @param reason The reason text to be displayed
815 * @param nickmask The hostmask to add
817 virtual void OnAddQLine(long duration, userrec* source, const std::string &reason, const std::string &nickmask);
819 /** Called whenever a eline is added by a local user.
820 * This method is triggered after the line is added.
821 * @param duration The duration of the line in seconds
822 * @param source The sender of the line
823 * @param reason The reason text to be displayed
824 * @param hostmask The hostmask to add
826 virtual void OnAddELine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
828 /** Called whenever a gline is deleted.
829 * This method is triggered after the line is deleted.
830 * @param source The user removing the line
831 * @param hostmask The hostmask to delete
833 virtual void OnDelGLine(userrec* source, const std::string &hostmask);
835 /** Called whenever a zline is deleted.
836 * This method is triggered after the line is deleted.
837 * @param source The user removing the line
838 * @param hostmask The hostmask to delete
840 virtual void OnDelZLine(userrec* source, const std::string &ipmask);
842 /** Called whenever a kline is deleted.
843 * This method is triggered after the line is deleted.
844 * @param source The user removing the line
845 * @param hostmask The hostmask to delete
847 virtual void OnDelKLine(userrec* source, const std::string &hostmask);
849 /** Called whenever a qline is deleted.
850 * This method is triggered after the line is deleted.
851 * @param source The user removing the line
852 * @param hostmask The hostmask to delete
854 virtual void OnDelQLine(userrec* source, const std::string &nickmask);
856 /** Called whenever a eline is deleted.
857 * This method is triggered after the line is deleted.
858 * @param source The user removing the line
859 * @param hostmask The hostmask to delete
861 virtual void OnDelELine(userrec* source, const std::string &hostmask);
863 /** Called before your module is unloaded to clean up Extensibles.
864 * This method is called once for every user and channel on the network,
865 * so that when your module unloads it may clear up any remaining data
866 * in the form of Extensibles added using Extensible::Extend().
867 * If the target_type variable is TYPE_USER, then void* item refers to
868 * a userrec*, otherwise it refers to a chanrec*.
869 * @param target_type The type of item being cleaned
870 * @param item A pointer to the item's class
872 virtual void OnCleanup(int target_type, void* item);
874 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
875 * have been applied. Please note that although you can see remote nickchanges through this function, you should
876 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
877 * check user->server before taking any action (including returning nonzero from the method).
878 * Because this method is called after the nickchange is taken place, no return values are possible
879 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
880 * @param user The user changing their nick
881 * @param oldnick The old nickname of the user before the nickchange
883 virtual void OnUserPostNick(userrec* user, const std::string &oldnick);
885 /** Called before an action which requires a channel privilage check.
886 * This function is called before many functions which check a users status on a channel, for example
887 * before opping a user, deopping a user, kicking a user, etc.
888 * There are several values for access_type which indicate for what reason access is being checked.
890 * AC_KICK (0) - A user is being kicked<br>
891 * AC_DEOP (1) - a user is being deopped<br>
892 * AC_OP (2) - a user is being opped<br>
893 * AC_VOICE (3) - a user is being voiced<br>
894 * AC_DEVOICE (4) - a user is being devoiced<br>
895 * AC_HALFOP (5) - a user is being halfopped<br>
896 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
897 * AC_INVITE () - a user is being invited<br>
898 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
899 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
900 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
901 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
902 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
903 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
904 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
905 * @param source The source of the access check
906 * @param dest The destination of the access check
907 * @param channel The channel which is being checked
908 * @param access_type See above
910 virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
912 /** Called when a 005 numeric is about to be output.
913 * The module should modify the 005 numeric if needed to indicate its features.
914 * @param output The 005 string to be modified if neccessary.
916 virtual void On005Numeric(std::string &output);
918 /** Called when a client is disconnected by KILL.
919 * If a client is killed by a server, e.g. a nickname collision or protocol error,
921 * Return 1 from this function to prevent the kill, and 0 from this function to allow
922 * it as normal. If you prevent the kill no output will be sent to the client, it is
923 * down to your module to generate this information.
924 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
925 * If you do so youre risking race conditions, desyncs and worse!
926 * @param source The user sending the KILL
927 * @param dest The user being killed
928 * @param reason The kill reason
929 * @return 1 to prevent the kill, 0 to allow
931 virtual int OnKill(userrec* source, userrec* dest, const std::string &reason);
933 /** Called when an oper wants to disconnect a remote user via KILL
934 * @param source The user sending the KILL
935 * @param dest The user being killed
936 * @param reason The kill reason
938 virtual void OnRemoteKill(userrec* source, userrec* dest, const std::string &reason);
940 /** Called whenever a module is loaded.
941 * mod will contain a pointer to the module, and string will contain its name,
942 * for example m_widgets.so. This function is primary for dependency checking,
943 * your module may decide to enable some extra features if it sees that you have
944 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
945 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
946 * but instead operate under reduced functionality, unless the dependency is
947 * absolutely neccessary (e.g. a module that extends the features of another
949 * @param mod A pointer to the new module
950 * @param name The new module's filename
952 virtual void OnLoadModule(Module* mod,const std::string &name);
954 /** Called whenever a module is unloaded.
955 * mod will contain a pointer to the module, and string will contain its name,
956 * for example m_widgets.so. This function is primary for dependency checking,
957 * your module may decide to enable some extra features if it sees that you have
958 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
959 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
960 * but instead operate under reduced functionality, unless the dependency is
961 * absolutely neccessary (e.g. a module that extends the features of another
963 * @param mod Pointer to the module being unloaded (still valid)
964 * @param name The filename of the module being unloaded
966 virtual void OnUnloadModule(Module* mod,const std::string &name);
968 /** Called once every five seconds for background processing.
969 * This timer can be used to control timed features. Its period is not accurate
970 * enough to be used as a clock, but it is gauranteed to be called at least once in
971 * any five second period, directly from the main loop of the server.
972 * @param curtime The current timer derived from time(2)
974 virtual void OnBackgroundTimer(time_t curtime);
976 /** Called whenever any command is about to be executed.
977 * This event occurs for all registered commands, wether they are registered in the core,
978 * or another module, but it will not occur for invalid commands (e.g. ones which do not
979 * exist within the command table). By returning 1 from this method you may prevent the
980 * command being executed. If you do this, no output is created by the core, and it is
981 * down to your module to produce any output neccessary.
982 * Note that unless you return 1, you should not destroy any structures (e.g. by using
983 * Server::QuitUser) otherwise when the command's handler function executes after your
984 * method returns, it will be passed an invalid pointer to the user object and crash!)
985 * @param command The command being executed
986 * @param parameters An array of array of characters containing the parameters for the command
987 * @param pcnt The nuimber of parameters passed to the command
988 * @param user the user issuing the command
989 * @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.
990 * @return 1 to block the command, 0 to allow
992 virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated);
994 /** Called to check if a user who is connecting can now be allowed to register
995 * If any modules return false for this function, the user is held in the waiting
996 * state until all modules return true. For example a module which implements ident
997 * lookups will continue to return false for a user until their ident lookup is completed.
998 * Note that the registration timeout for a user overrides these checks, if the registration
999 * timeout is reached, the user is disconnected even if modules report that the user is
1000 * not ready to connect.
1001 * @param user The user to check
1002 * @return true to indicate readiness, false if otherwise
1004 virtual bool OnCheckReady(userrec* user);
1006 /** Called whenever a user is about to register their connection (e.g. before the user
1007 * is sent the MOTD etc). Modules can use this method if they are performing a function
1008 * which must be done before the actual connection is completed (e.g. ident lookups,
1009 * dnsbl lookups, etc).
1010 * Note that you should NOT delete the user record here by causing a disconnection!
1011 * Use OnUserConnect for that instead.
1012 * @param user The user registering
1014 virtual void OnUserRegister(userrec* user);
1016 /** Called whenever a mode character is processed.
1017 * Return 1 from this function to block the mode character from being processed entirely,
1018 * so that you may perform your own code instead. Note that this method allows you to override
1019 * modes defined by other modes, but this is NOT RECOMMENDED!
1020 * @param user The user who is sending the mode
1021 * @param chan The channel the mode is being sent to
1022 * @param mode The mode character being set
1023 * @param param The parameter for the mode or an empty string
1024 * @param adding true of the mode is being added, false if it is being removed
1025 * @param pcnt The parameter count for the mode (0 or 1)
1026 * @return 1 to deny the mode, 0 to allow
1028 virtual int OnRawMode(userrec* user, chanrec* chan, char mode, const std::string ¶m, bool adding, int pcnt);
1030 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1031 * This method will always be called for each join, wether or not the channel is actually +i, and
1032 * determines the outcome of an if statement around the whole section of invite checking code.
1033 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1034 * @param user The user joining the channel
1035 * @param chan The channel being joined
1036 * @return 1 to explicitly allow the join, 0 to proceed as normal
1038 virtual int OnCheckInvite(userrec* user, chanrec* chan);
1040 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1041 * This method will always be called for each join, wether or not the channel is actually +k, and
1042 * determines the outcome of an if statement around the whole section of key checking code.
1043 * if the user specified no key, the keygiven string will be a valid but empty value.
1044 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1045 * @param user The user joining the channel
1046 * @param chan The channel being joined
1047 * @return 1 to explicitly allow the join, 0 to proceed as normal
1049 virtual int OnCheckKey(userrec* user, chanrec* chan, const std::string &keygiven);
1051 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1052 * This method will always be called for each join, wether or not the channel is actually +l, and
1053 * determines the outcome of an if statement around the whole section of channel limit checking code.
1054 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1055 * @param user The user joining the channel
1056 * @param chan The channel being joined
1057 * @return 1 to explicitly allow the join, 0 to proceed as normal
1059 virtual int OnCheckLimit(userrec* user, chanrec* chan);
1061 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
1062 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
1063 * determines the outcome of an if statement around the whole section of ban checking code.
1064 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1065 * @param user The user joining the channel
1066 * @param chan The channel being joined
1067 * @return 1 to explicitly allow the join, 0 to proceed as normal
1069 virtual int OnCheckBan(userrec* user, chanrec* chan);
1071 /** Called on all /STATS commands
1072 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1073 * @param symbol the symbol provided to /STATS
1074 * @param user the user issuing the /STATS command
1075 * @param results A string_list to append results into
1076 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1078 virtual int OnStats(char symbol, userrec* user, string_list &results);
1080 /** Called whenever a change of a local users displayed host is attempted.
1081 * Return 1 to deny the host change, or 0 to allow it.
1082 * @param user The user whos host will be changed
1083 * @param newhost The new hostname
1084 * @return 1 to deny the host change, 0 to allow
1086 virtual int OnChangeLocalUserHost(userrec* user, const std::string &newhost);
1088 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1089 * return 1 to deny the name change, or 0 to allow it.
1090 * @param user The user whos GECOS will be changed
1091 * @param newhost The new GECOS
1092 * @return 1 to deny the GECOS change, 0 to allow
1094 virtual int OnChangeLocalUserGECOS(userrec* user, const std::string &newhost);
1096 /** Called whenever a topic is changed by a local user.
1097 * Return 1 to deny the topic change, or 0 to allow it.
1098 * @param user The user changing the topic
1099 * @param chan The channels who's topic is being changed
1100 * @param topic The actual topic text
1101 * @param 1 to block the topic change, 0 to allow
1103 virtual int OnLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic);
1105 /** Called whenever a local topic has been changed.
1106 * To block topic changes you must use OnLocalTopicChange instead.
1107 * @param user The user changing the topic
1108 * @param chan The channels who's topic is being changed
1109 * @param topic The actual topic text
1111 virtual void OnPostLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic);
1113 /** Called whenever an Event class is sent to all module by another module.
1114 * Please see the documentation of Event::Send() for further information. The Event sent can
1115 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1116 * before doing anything to the event data, and you should *not* change the event data in any way!
1117 * @param event The Event class being received
1119 virtual void OnEvent(Event* event);
1121 /** Called whenever a Request class is sent to your module by another module.
1122 * Please see the documentation of Request::Send() for further information. The Request sent
1123 * can always be assumed to be non-NULL, you should not change the request object or its data.
1124 * Your method may return arbitary data in the char* result which the requesting module
1125 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1126 * @param request The Request class being received
1128 virtual char* OnRequest(Request* request);
1130 /** Called whenever an oper password is to be compared to what a user has input.
1131 * The password field (from the config file) is in 'password' and is to be compared against
1132 * 'input'. This method allows for encryption of oper passwords and much more besides.
1133 * You should return a nonzero value if you want to allow the comparison or zero if you wish
1135 * @param password The oper's password
1136 * @param input The password entered
1137 * @return 1 to match the passwords, 0 to do nothing
1139 virtual int OnOperCompare(const std::string &password, const std::string &input);
1141 /** Called whenever a user is given usermode +o, anywhere on the network.
1142 * You cannot override this and prevent it from happening as it is already happened and
1143 * such a task must be performed by another server. You can however bounce modes by sending
1144 * servermodes out to reverse mode changes.
1145 * @param user The user who is opering
1147 virtual void OnGlobalOper(userrec* user);
1149 /** Called whenever a user connects, anywhere on the network.
1150 * This event is informational only. You should not change any user information in this
1151 * event. To do so, use the OnUserConnect method to change the state of local users.
1152 * @param user The user who is connecting
1154 virtual void OnGlobalConnect(userrec* user);
1156 /** Called whenever a ban is added to a channel's list.
1157 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1158 * @param source The user adding the ban
1159 * @param channel The channel the ban is being added to
1160 * @param banmask The ban mask being added
1161 * @return 1 to block the ban, 0 to continue as normal
1163 virtual int OnAddBan(userrec* source, chanrec* channel,const std::string &banmask);
1165 /** Called whenever a ban is removed from a channel's list.
1166 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1167 * @param source The user deleting the ban
1168 * @param channel The channel the ban is being deleted from
1169 * @param banmask The ban mask being deleted
1170 * @return 1 to block the unban, 0 to continue as normal
1172 virtual int OnDelBan(userrec* source, chanrec* channel,const std::string &banmask);
1174 /** Called immediately after any connection is accepted. This is intended for raw socket
1175 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1176 * no information relating to a user record as the connection has not been assigned yet.
1177 * There are no return values from this call as all modules get an opportunity if required to
1178 * process the connection.
1179 * @param fd The file descriptor returned from accept()
1180 * @param ip The IP address of the connecting user
1181 * @param localport The local port number the user connected to
1183 virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport);
1185 /** Called immediately before any write() operation on a user's socket in the core. Because
1186 * this event is a low level event no user information is associated with it. It is intended
1187 * for use by modules which may wrap connections within another API such as SSL for example.
1188 * return a non-zero result if you have handled the write operation, in which case the core
1189 * will not call write().
1190 * @param fd The file descriptor of the socket
1191 * @param buffer A char* buffer being written
1192 * @param Number of characters to write
1193 * @return Number of characters actually written or 0 if you didn't handle the operation
1195 virtual int OnRawSocketWrite(int fd, char* buffer, int count);
1197 /** Called immediately before any socket is closed. When this event is called, shutdown()
1198 * has not yet been called on the socket.
1199 * @param fd The file descriptor of the socket prior to close()
1201 virtual void OnRawSocketClose(int fd);
1203 /** Called immediately before any read() operation on a client socket in the core.
1204 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1205 * when this event occurs.
1206 * Your event should return 1 if it has handled the reading itself, which prevents the core
1207 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1208 * the value of count. The value of readresult must be identical to an actual result that might
1209 * be returned from the read() system call, for example, number of bytes read upon success,
1210 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1211 * you MUST set readresult.
1212 * @param fd The file descriptor of the socket
1213 * @param buffer A char* buffer being read to
1214 * @param count The size of the buffer
1215 * @param readresult The amount of characters read, or 0
1216 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1218 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1220 /** Called whenever a user sets away.
1221 * This method has no parameter for the away message, as it is available in the
1222 * user record as userrec::awaymsg.
1224 virtual void OnSetAway(userrec* user);
1226 /** Called when a user cancels their away state.
1228 virtual void OnCancelAway(userrec* user);
1232 /** Allows server output and query functions
1233 * This class contains methods which allow a module to query the state of the irc server, and produce
1234 * output to users and other servers. All modules should instantiate at least one copy of this class,
1235 * and use its member functions to perform their tasks.
1237 class Server : public Extensible
1240 /** Default constructor.
1241 * Creates a Server object.
1245 /** Default destructor.
1246 * Destroys a Server object.
1250 /** Obtains a pointer to the server's ServerConfig object.
1251 * The ServerConfig object contains most of the configuration data
1252 * of the IRC server, as read from the config file by the core.
1254 ServerConfig* GetConfig();
1256 /** For use with Module::Prioritize().
1257 * When the return value of this function is returned from
1258 * Module::Prioritize(), this specifies that the module wishes
1259 * to be ordered exactly BEFORE 'modulename'. For more information
1260 * please see Module::Prioritize().
1261 * @param modulename The module your module wants to be before in the call list
1262 * @returns a priority ID which the core uses to relocate the module in the list
1264 long PriorityBefore(const std::string &modulename);
1266 /** For use with Module::Prioritize().
1267 * When the return value of this function is returned from
1268 * Module::Prioritize(), this specifies that the module wishes
1269 * to be ordered exactly AFTER 'modulename'. For more information please
1270 * see Module::Prioritize().
1271 * @param modulename The module your module wants to be after in the call list
1272 * @returns a priority ID which the core uses to relocate the module in the list
1274 long PriorityAfter(const std::string &modulename);
1276 /** Sends text to all opers.
1277 * This method sends a server notice to all opers with the usermode +s.
1279 virtual void SendOpers(const std::string &s);
1281 /** Returns the version string of this server
1283 std::string GetVersion();
1285 /** Publish 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 this
1288 * function. A feature is an arbitary string which identifies something this
1289 * module can do. For example, if your module provides SSL support, but other
1290 * modules provide SSL support too, all the modules supporting SSL should
1291 * publish an identical 'SSL' feature. This way, any module requiring use
1292 * of SSL functions can just look up the 'SSL' feature using FindFeature,
1293 * then use the module pointer they are given.
1294 * @param FeatureName The case sensitive feature name to make available
1295 * @param Mod a pointer to your module class
1296 * @returns True on success, false if the feature is already published by
1299 bool PublishFeature(const std::string &FeatureName, Module* Mod);
1301 /** Unpublish a 'feature'.
1302 * When your module exits, it must call this method for every feature it
1303 * is providing so that the feature table is cleaned up.
1304 * @param FeatureName the feature to remove
1306 bool UnpublishFeature(const std::string &FeatureName);
1308 /** Find a 'feature'.
1309 * There are two ways for a module to find another module it depends on.
1310 * Either by name, using Server::FindModule, or by feature, using the
1311 * Server::PublishFeature method. A feature is an arbitary string which
1312 * identifies something this module can do. For example, if your module
1313 * provides SSL support, but other modules provide SSL support too, all
1314 * the modules supporting SSL should publish an identical 'SSL' feature.
1315 * To find a module capable of providing the feature you want, simply
1316 * call this method with the feature name you are looking for.
1317 * @param FeatureName The feature name you wish to obtain the module for
1318 * @returns A pointer to a valid module class on success, NULL on failure.
1320 Module* FindFeature(const std::string &FeatureName);
1322 const std::string& GetModuleName(Module* m);
1324 /** Writes a log string.
1325 * This method writes a line of text to the log. If the level given is lower than the
1326 * level given in the configuration, this command has no effect.
1328 virtual void Log(int level, const std::string &s);
1330 /** Sends a line of text down a TCP/IP socket.
1331 * This method writes a line of text to an established socket, cutting it to 510 characters
1332 * plus a carriage return and linefeed if required.
1334 virtual void Send(int Socket, const std::string &s);
1336 /** Sends text from the server to a socket.
1337 * This method writes a line of text to an established socket, with the servername prepended
1338 * as used by numerics (see RFC 1459)
1340 virtual void SendServ(int Socket, const std::string &s);
1342 /** Sends text from a user to a socket.
1343 * This method writes a line of text to an established socket, with the given user's nick/ident
1344 * /host combination prepended, as used in PRIVSG etc commands (see RFC 1459)
1346 virtual void SendFrom(int Socket, userrec* User, const std::string &s);
1348 /** Sends text from a user to another user.
1349 * This method writes a line of text to a user, with a user's nick/ident
1350 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459)
1351 * If you specify NULL as the source, then the data will originate from the
1352 * local server, e.g. instead of:
1354 * :user!ident@host TEXT
1356 * The format will become:
1360 * Which is useful for numerics and server notices to single users, etc.
1362 virtual void SendTo(userrec* Source, userrec* Dest, const std::string &s);
1364 /** Returns true if two users share a common channel.
1365 * This method is used internally by the NICK and QUIT commands, and the Server::SendCommon
1368 virtual bool CommonChannels(userrec* u1, userrec* u2);
1370 /** Sends text from a user to one or more channels (mulicast).
1371 * This method writes a line of text to all users which share a common channel with a given
1372 * user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc
1373 * commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent
1374 * back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it
1375 * is only sent to the other recipients, as seen in QUIT.
1377 virtual void SendCommon(userrec* User, const std::string &text, bool IncludeSender);
1379 /** Sends a WALLOPS message.
1380 * This method writes a WALLOPS message to all users with the +w flag, originating from the
1383 virtual void SendWallops(userrec* User, const std::string &text);
1385 /** Returns true if a nick is valid.
1386 * Nicks for unregistered connections will return false.
1388 virtual bool IsNick(const std::string &nick);
1390 /** Returns a count of the number of users on a channel.
1391 * This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.
1393 virtual int CountUsers(chanrec* c);
1395 /** Adds an InspTimer which will trigger at a future time
1397 virtual void AddTimer(InspTimer* T);
1399 /** Attempts to look up a nick and return a pointer to it.
1400 * This function will return NULL if the nick does not exist.
1402 virtual userrec* FindNick(const std::string &nick);
1404 /** Attempts to look up a nick using the file descriptor associated with that nick.
1405 * This function will return NULL if the file descriptor is not associated with a valid user.
1407 virtual userrec* FindDescriptor(int socket);
1409 /** Attempts to look up a channel and return a pointer to it.
1410 * This function will return NULL if the channel does not exist.
1412 virtual chanrec* FindChannel(const std::string &channel);
1414 /** Attempts to look up a user's privilages on a channel.
1415 * This function will return a string containing either @, %, +, or an empty string,
1416 * representing the user's privilages upon the channel you specify.
1418 virtual std::string ChanMode(userrec* User, chanrec* Chan);
1420 /** Returns the server name of the server where the module is loaded.
1422 virtual std::string GetServerName();
1424 /** Returns the network name, global to all linked servers.
1426 virtual std::string GetNetworkName();
1428 /** Returns the server description string of the local server
1430 virtual std::string GetServerDescription();
1432 /** Returns the information of the server as returned by the /ADMIN command.
1433 * See the Admin class for further information of the return value. The members
1434 * Admin::Nick, Admin::Email and Admin::Name contain the information for the
1435 * server where the module is loaded.
1437 virtual Admin GetAdmin();
1439 virtual bool AddMode(ModeHandler* mh, const unsigned char modechar);
1441 virtual bool AddModeWatcher(ModeWatcher* mw);
1443 virtual bool DelModeWatcher(ModeWatcher* mw);
1445 virtual bool AddResolver(Resolver* r);
1447 /** Adds a command to the command table.
1448 * This allows modules to add extra commands into the command table. You must place a function within your
1449 * module which is is of type handlerfunc:
1451 * typedef void (handlerfunc) (char**, int, userrec*);
1453 * void handle_kill(char **parameters, int pcnt, userrec *user)
1455 * When the command is typed, the parameters will be placed into the parameters array (similar to argv) and
1456 * the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters
1457 * than the 'minparams' value you specified when creating the command. The *user parameter is the class of
1458 * the user which caused the command to trigger, who will always have the flag you specified in 'flags' when
1459 * creating the initial command. For example to create an oper only command create the commands with flags='o'.
1460 * The source parameter is used for resource tracking, and should contain the name of your module (with file
1461 * extension) e.g. "m_blarp.so". If you place the wrong identifier here, you can cause crashes if your module
1464 virtual void AddCommand(command_t *f);
1466 /** Sends a servermode.
1467 * you must format the parameters array with the target, modes and parameters for those modes.
1473 * modes[0] = ChannelName;
1477 * modes[2] = user->nick;
1479 * Srv->SendMode(modes,3,user);
1481 * The modes will originate from the server where the command was issued, however responses (e.g. numerics)
1482 * will be sent to the user you provide as the third parameter.
1483 * You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave
1484 * your server in an unstable state!
1487 virtual void SendMode(const char **parameters, int pcnt, userrec *user);
1489 /** Sends to all users matching a mode mask
1490 * You must specify one or more usermodes as the first parameter. These can be RFC specified modes such as +i,
1491 * or module provided modes, including ones provided by your own module.
1492 * In the second parameter you must place a flag value which indicates wether the modes you have given will be
1493 * logically ANDed or OR'ed. You may use one of either WM_AND or WM_OR.
1494 * for example, if you were to use:
1496 * Serv->SendToModeMask("xi", WM_OR, "m00");
1498 * Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the
1499 * user must have both modes set to receive the message.
1501 virtual void SendToModeMask(const std::string &modes, int flags, const std::string &text);
1503 /** Forces a user nickchange.
1504 * This command works similarly to SVSNICK, and can be used to implement Q-lines etc.
1505 * If you specify an invalid nickname, the nick change will be dropped and the target user will receive
1506 * the error numeric for it.
1508 virtual void ChangeUserNick(userrec* user, const std::string &nickname);
1510 /** Forces a user to quit with the specified reason.
1511 * To the user, it will appear as if they typed /QUIT themselves, except for the fact that this function
1512 * may bypass the quit prefix specified in the config file.
1516 * Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or
1517 * read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of
1518 * action after calling this method is to immediately bail from your handler.
1520 virtual void QuitUser(userrec* user, const std::string &reason);
1522 /** Matches text against a glob pattern.
1523 * Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com
1524 * Returns true if the literal successfully matches the pattern, false if otherwise.
1526 virtual bool MatchText(const std::string &sliteral, const std::string &spattern);
1528 /** Calls the handler for a command, either implemented by the core or by another module.
1529 * You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN,
1530 * KICK etc, or even as a method of callback. By defining command names that are untypeable
1531 * for users on irc (e.g. those which contain a \r or \n) you may use them as callback identifiers.
1532 * The first parameter to this method is the name of the command handler you wish to call, e.g.
1533 * PRIVMSG. This will be a command handler previously registered by the core or wih AddCommand().
1534 * The second parameter is an array of parameters, and the third parameter is a count of parameters
1535 * in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the
1536 * functiom will silently ignore it. The final parameter is the user executing the command handler,
1537 * used for privilage checks, etc.
1538 * @return True if the command exists
1540 virtual bool CallCommandHandler(const std::string &commandname, const char** parameters, int pcnt, userrec* user);
1542 /** This function returns true if the commandname exists, pcnt is equal to or greater than the number
1543 * of paramters the command requires, the user specified is allowed to execute the command, AND
1544 * if the command is implemented by a module (not the core). This has a few specific uses, usually
1545 * within network protocols (see src/modules/m_spanningtree.cpp)
1547 virtual bool IsValidModuleCommand(const std::string &commandname, int pcnt, userrec* user);
1549 /** Change displayed hostname of a user.
1550 * You should always call this method to change a user's host rather than writing directly to the
1551 * dhost member of userrec, as any change applied via this method will be propogated to any
1554 virtual void ChangeHost(userrec* user, const std::string &host);
1556 /** Change GECOS (fullname) of a user.
1557 * You should always call this method to change a user's GECOS rather than writing directly to the
1558 * fullname member of userrec, as any change applied via this method will be propogated to any
1561 virtual void ChangeGECOS(userrec* user, const std::string &gecos);
1563 /** Returns true if the servername you give is ulined.
1564 * ULined servers have extra privilages. They are allowed to change nicknames on remote servers,
1565 * change modes of clients which are on remote servers and set modes of channels where there are
1566 * no channel operators for that channel on the ulined server, amongst other things.
1568 virtual bool IsUlined(const std::string &server);
1570 /** Fetches the userlist of a channel. This function must be here and not a member of userrec or
1571 * chanrec due to include constraints.
1573 virtual chanuserlist GetUsers(chanrec* chan);
1575 /** Remove a user's connection to the irc server, but leave their client in existence in the
1576 * user hash. When you call this function, the user's file descriptor will be replaced with the
1577 * value of FD_MAGIC_NUMBER and their old file descriptor will be closed. This idle client will
1578 * remain until it is restored with a valid file descriptor, or is removed from IRC by an operator
1579 * After this call, the pointer to user will be invalid.
1581 virtual bool UserToPseudo(userrec* user, const std::string &message);
1583 /** This user takes one user, and switches their file descriptor with another user, so that one user
1584 * "becomes" the other. The user in 'alive' is booted off the server with the given message. The user
1585 * referred to by 'zombie' should have previously been locked with Server::UserToPseudo, otherwise
1586 * stale sockets and file descriptor leaks can occur. After this call, the pointer to alive will be
1587 * invalid, and the pointer to zombie will be equivalent in effect to the old pointer to alive.
1589 virtual bool PseudoToUser(userrec* alive, userrec* zombie, const std::string &message);
1592 * The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1593 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1594 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1595 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1598 virtual void AddGLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1601 * The Q-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1602 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1603 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1604 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1607 virtual void AddQLine(long duration, const std::string &source, const std::string &reason, const std::string &nickname);
1610 * The Z-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1611 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1612 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1613 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1616 virtual void AddZLine(long duration, const std::string &source, const std::string &reason, const std::string &ipaddr);
1619 * The K-line is enforced as soon as it is added.
1620 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1621 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1622 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1625 virtual void AddKLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1628 * The E-line is enforced as soon as it is added.
1629 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1630 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1631 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1634 virtual void AddELine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1636 /** Deletes a G-Line from all servers
1638 virtual bool DelGLine(const std::string &hostmask);
1640 /** Deletes a Q-Line from all servers
1642 virtual bool DelQLine(const std::string &nickname);
1644 /** Deletes a Z-Line from all servers
1646 virtual bool DelZLine(const std::string &ipaddr);
1648 /** Deletes a local K-Line
1650 virtual bool DelKLine(const std::string &hostmask);
1652 /** Deletes a local E-Line
1654 virtual bool DelELine(const std::string &hostmask);
1656 /** Calculates a duration
1657 * This method will take a string containing a formatted duration (e.g. "1w2d") and return its value
1658 * as a total number of seconds. This is the same function used internally by /GLINE etc to set
1661 virtual long CalcDuration(const std::string &duration);
1663 /** Returns true if a nick!ident@host string is correctly formatted, false if otherwise.
1665 virtual bool IsValidMask(const std::string &mask);
1667 /** This function finds a module by name.
1668 * You must provide the filename of the module. If the module cannot be found (is not loaded)
1669 * the function will return NULL.
1671 virtual Module* FindModule(const std::string &name);
1673 /** Adds a class derived from InspSocket to the server's socket engine.
1675 virtual void AddSocket(InspSocket* sock);
1677 /** Forcibly removes a class derived from InspSocket from the servers socket engine.
1679 virtual void RemoveSocket(InspSocket* sock);
1681 /** Deletes a class derived from InspSocket from the server's socket engine.
1683 virtual void DelSocket(InspSocket* sock);
1685 /** Causes the local server to rehash immediately.
1686 * WARNING: Do not call this method from within your rehash method, for
1689 virtual void RehashServer();
1691 /** This method returns the total number of channels on the network.
1693 virtual long GetChannelCount();
1695 /** This method returns a channel whos index is greater than or equal to 0 and less than the number returned by Server::GetChannelCount().
1696 * This is slower (by factors of dozens) than requesting a channel by name with Server::FindChannel(), however there are times when
1697 * you wish to safely iterate the channel list, saving your position, with large amounts of time in between, which is what this function
1700 virtual chanrec* GetChannelIndex(long index);
1702 /** Dumps text (in a stringstream) to a user. The stringstream should not contain linefeeds, as it will be split
1703 * automatically by the function into safe amounts. The line prefix given is prepended onto each line (e.g. a servername
1706 void DumpText(userrec* User, const std::string &LinePrefix, stringstream &TextStream);
1710 #define CONF_NOT_A_NUMBER 0x000010
1711 #define CONF_NOT_UNSIGNED 0x000080
1712 #define CONF_VALUE_NOT_FOUND 0x000100
1713 #define CONF_FILE_NOT_FOUND 0x000200
1716 /** Allows reading of values from configuration files
1717 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1718 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1719 * Constructing the class using one parameter allows you to specify a path to your own configuration
1720 * file, otherwise, inspircd.conf is read.
1722 class ConfigReader : public classbase
1725 /** The contents of the configuration file
1726 * This protected member should never be accessed by a module (and cannot be accessed unless the
1727 * core is changed). It will contain a pointer to the configuration file data with unneeded data
1728 * (such as comments) stripped from it.
1730 ConfigDataHash* data;
1731 std::ostringstream* errorlog;;
1732 /** Used to store errors
1734 bool privatehash; // If we're using our own config data hash or not.
1739 /** Default constructor.
1740 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1741 * as specified when running ./configure.
1743 ConfigReader(); // default constructor reads ircd.conf
1744 /** Overloaded constructor.
1745 * This constructor initialises the ConfigReader class to read a user-specified config file
1747 ConfigReader(const std::string &filename); // read a module-specific config
1748 /** Default destructor.
1749 * This method destroys the ConfigReader class.
1752 /** Retrieves a value from the config file.
1753 * This method retrieves a value from the config file. Where multiple copies of the tag
1754 * exist in the config file, index indicates which of the values to retrieve.
1756 std::string ReadValue(const std::string &tag, const std::string &name, int index);
1757 /** Retrieves a boolean value from the config file.
1758 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1759 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1760 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1762 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1763 /** Retrieves an integer value from the config file.
1764 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1765 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1766 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1767 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1768 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1769 * will return CONF_NOT_UNSIGNED
1771 long ReadInteger(const std::string &tag, const std::string &name, int index, bool needs_unsigned);
1772 /** Returns the last error to occur.
1773 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1774 * A call to GetError() resets the error flag back to 0.
1777 /** Counts the number of times a given tag appears in the config file.
1778 * This method counts the number of times a tag appears in a config file, for use where
1779 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1780 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1781 * multiple instance tag.
1783 int Enumerate(const std::string &tag);
1784 /** Returns true if a config file is valid.
1785 * This method is partially implemented and will only return false if the config
1786 * file does not exist or could not be opened.
1789 /** Dumps the list of errors in a config file to an output location. If bail is true,
1790 * then the program will abort. If bail is false and user points to a valid user
1791 * record, the error report will be spooled to the given user by means of NOTICE.
1792 * if bool is false AND user is false, the error report will be spooled to all opers
1793 * by means of a NOTICE to all opers.
1795 void DumpErrors(bool bail,userrec* user);
1797 /** Returns the number of items within a tag.
1798 * For example if the tag was <test tag="blah" data="foo"> then this
1799 * function would return 2. Spaces and newlines both qualify as valid seperators
1802 int EnumerateValues(const std::string &tag, int index);
1807 /** Caches a text file into memory and can be used to retrieve lines from it.
1808 * This class contains methods for read-only manipulation of a text file in memory.
1809 * Either use the constructor type with one parameter to load a file into memory
1810 * at construction, or use the LoadFile method to load a file.
1812 class FileReader : public classbase
1814 /** The file contents
1818 unsigned long contentsize;
1823 /** Default constructor.
1824 * This method does not load any file into memory, you must use the LoadFile method
1825 * after constructing the class this way.
1829 /** Secondary constructor.
1830 * This method initialises the class with a file loaded into it ready for GetLine and
1831 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1834 FileReader(const std::string &filename);
1836 /** Default destructor.
1837 * This deletes the memory allocated to the file.
1841 /** Used to load a file.
1842 * This method loads a file into the class ready for GetLine and
1843 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1846 void LoadFile(const std::string &filename);
1848 /** Returns the whole content of the file as std::string
1850 std::string Contents();
1852 /** Returns the entire size of the file as std::string
1854 unsigned long ContentSize();
1856 /** Returns true if the file exists
1857 * This function will return false if the file could not be opened.
1861 /** Retrieve one line from the file.
1862 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1863 * the index was out of bounds, or the line had no data on it.
1865 std::string GetLine(int x);
1867 /** Returns the size of the file in lines.
1868 * This method returns the number of lines in the read file. If it is 0, no lines have been
1869 * read into memory, either because the file is empty or it does not exist, or cannot be
1870 * opened due to permission problems.
1876 /** Instantiates classes inherited from Module
1877 * This class creates a class inherited from type Module, using new. This is to allow for modules
1878 * to create many different variants of Module, dependent on architecture, configuration, etc.
1879 * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
1882 class ModuleFactory : public classbase
1886 virtual ~ModuleFactory() { }
1887 /** Creates a new module.
1888 * Your inherited class of ModuleFactory must return a pointer to your Module class
1889 * using this method.
1891 virtual Module * CreateModule(Server* Me) = 0;
1895 typedef DLLFactory<ModuleFactory> ircd_module;
1896 typedef std::vector<Module*> ModuleList;
1897 typedef std::vector<ircd_module*> FactoryList;