1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
7 * <brain@chatspike.net>
8 * <Craig@chatspike.net>
10 * Written by Craig Edwards, Craig McLure, and others.
11 * This program is free but copyrighted software; see
12 * the file COPYING for details.
14 * ---------------------------------------------------
23 enum DebugLevels { DEBUG, VERBOSE, DEFAULT, SPARSE, NONE };
25 /** Used with OnExtendedMode() method of modules
27 enum ModeTargetType { MT_CHANNEL, MT_CLIENT, MT_SERVER };
29 /** Used with OnAccessCheck() method of modules
31 enum AccessControlType {
32 ACR_DEFAULT, // Do default action (act as if the module isnt even loaded)
33 ACR_DENY, // deny the action
34 ACR_ALLOW, // allow the action
35 AC_KICK, // a user is being kicked
36 AC_DEOP, // a user is being deopped
37 AC_OP, // a user is being opped
38 AC_VOICE, // a user is being voiced
39 AC_DEVOICE, // a user is being devoiced
40 AC_HALFOP, // a user is being halfopped
41 AC_DEHALFOP, // a user is being dehalfopped
42 AC_INVITE, // a user is being invited
43 AC_GENERAL_MODE // a channel mode is being changed
46 /** Used to define a set of behavior bits for a module
49 VF_STATIC = 1, // module is static, cannot be /unloadmodule'd
50 VF_VENDOR = 2, // module is a vendor module (came in the original tarball, not 3rd party)
51 VF_SERVICEPROVIDER = 4, // module provides a service to other modules (can be a dependency)
52 VF_COMMON = 8 // module needs to be common on all servers in a network to link
60 enum TargetTypeFlags {
79 /** Low level definition of a FileReader classes file cache area
81 typedef std::deque<std::string> file_cache;
82 typedef file_cache string_list;
84 /** Holds a list of users in a channel
86 typedef std::deque<userrec*> chanuserlist;
89 // This #define allows us to call a method in all
90 // loaded modules in a readable simple way, e.g.:
91 // 'FOREACH_MOD OnConnect(user);'
93 #define FOREACH_MOD(y,x) if (Config->global_implementation[y] > 0) { \
94 for (int _i = 0; _i <= MODCOUNT; _i++) { \
95 if (Config->implement_lists[_i][y]) \
100 // This define is similar to the one above but returns a result in MOD_RESULT.
101 // The first module to return a nonzero result is the value to be accepted,
102 // and any modules after are ignored.
104 // *********************************************************************************************
106 #define FOREACH_RESULT(y,x) { if (Config->global_implementation[y] > 0) { \
108 for (int _i = 0; _i <= MODCOUNT; _i++) { \
109 if (Config->implement_lists[_i][y]) {\
110 int res = modules[_i]->x ; \
120 // *********************************************************************************************
122 #define FD_MAGIC_NUMBER -42
126 #define IS_LOCAL(x) (x->fd > -1)
127 #define IS_REMOTE(x) (x->fd < 0)
128 #define IS_MODULE_CREATED(x) (x->fd == FD_MAGIC_NUMBER)
130 /*extern void createcommand(char* cmd, handlerfunc f, char flags, int minparams, char* source);
131 extern void server_mode(char **parameters, int pcnt, userrec *user);*/
133 // class Version holds the version information of a Module, returned
134 // by Module::GetVersion (thanks RD)
136 /** Holds a module's Version information
137 * The four members (set by the constructor only) indicate details as to the version number
138 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
140 class Version : public classbase
143 const int Major, Minor, Revision, Build, Flags;
144 Version(int major, int minor, int revision, int build, int flags);
147 /** Holds /ADMIN data
148 * This class contains the admin details of the local server. It is constructed by class Server,
149 * and has three read-only values, Name, Email and Nick that contain the specified values for the
150 * server where the module is running.
152 class Admin : public classbase
155 const std::string Name, Email, Nick;
156 Admin(std::string name, std::string email, std::string nick);
160 // Forward-delacare module for ModuleMessage etc
163 // Thanks to Rob (from anope) for the idea of this message passing API
164 // (its been done before, but this seemed a very neat and tidy way...
166 /** The ModuleMessage class is the base class of Request and Event
167 * This class is used to represent a basic data structure which is passed
168 * between modules for safe inter-module communications.
170 class ModuleMessage : public classbase
173 /** This class is pure virtual and must be inherited.
175 virtual char* Send() = 0;
176 virtual ~ModuleMessage() {};
179 /** The Request class is a unicast message directed at a given module.
180 * When this class is properly instantiated it may be sent to a module
181 * using the Send() method, which will call the given module's OnRequest
182 * method with this class as its parameter.
184 class Request : public ModuleMessage
187 /** This member holds a pointer to arbitary data set by the emitter of the message
190 /** This is a pointer to the sender of the message, which can be used to
191 * directly trigger events, or to create a reply.
194 /** The single destination of the Request
198 /** Create a new Request
200 Request(char* anydata, Module* src, Module* dst);
201 /** Fetch the Request data
204 /** Fetch the request source
207 /** Fetch the request destination (should be 'this' in the receiving module)
210 /** Send the Request.
211 * Upon returning the result will be arbitary data returned by the module you
212 * sent the request to. It is up to your module to know what this data is and
213 * how to deal with it.
219 /** The Event class is a unicast message directed at all modules.
220 * When the class is properly instantiated it may be sent to all modules
221 * using the Send() method, which will trigger the OnEvent method in
222 * all modules passing the object as its parameter.
224 class Event : public ModuleMessage
227 /** This member holds a pointer to arbitary data set by the emitter of the message
230 /** This is a pointer to the sender of the message, which can be used to
231 * directly trigger events, or to create a reply.
234 /** The event identifier.
235 * This is arbitary text which should be used to distinguish
236 * one type of event from another.
240 /** Create a new Event
242 Event(char* anydata, Module* src, std::string eventid);
243 /** Get the Event data
246 /** Get the event Source
249 /** Get the event ID.
250 * Use this to determine the event type for safe casting of the data
252 std::string GetEventID();
254 * The return result of an Event::Send() will always be NULL as
255 * no replies are expected.
260 /** Holds an extended mode's details.
261 * Used internally by modules.cpp
263 class ExtMode : public classbase
272 ExtMode(char mc, int ty, bool oper, int p_on, int p_off) : modechar(mc), type(ty), needsoper(oper), params_when_on(p_on), params_when_off(p_off), list(false) { };
275 /** Priority types which can be returned from Module::Prioritize()
277 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
279 /** Implementation-specific flags which may be set in Module::Implements()
281 enum Implementation { I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash, I_OnServerRaw,
282 I_OnExtendedMode, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois, I_OnUserPreInvite,
283 I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick, I_OnUserMessage, I_OnUserNotice, I_OnMode,
284 I_OnGetServerDescription, I_OnSyncUser, I_OnSyncChannel, I_OnSyncChannelMetaData, I_OnSyncUserMetaData,
285 I_OnDecodeMetaData, I_ProtoSendMode, I_ProtoSendMetaData, I_OnWallops, I_OnChangeHost, I_OnChangeName, I_OnAddGLine,
286 I_OnAddZLine, I_OnAddQLine, I_OnAddKLine, I_OnAddELine, I_OnDelGLine, I_OnDelZLine, I_OnDelKLine, I_OnDelELine, I_OnDelQLine,
287 I_OnCleanup, I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule, I_OnUnloadModule,
288 I_OnBackgroundTimer, I_OnSendList, I_OnPreCommand, I_OnCheckReady, I_OnUserRrgister, I_OnRawMode, I_OnCheckInvite,
289 I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnLocalTopicChange,
290 I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnOperCompre, I_OnGlobalOper, I_OnGlobalConnect, I_OnAddBan, I_OnDelBan,
291 I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead, I_OnChangeLocalUserGECOS, I_OnUserRegister,
292 I_OnOperCompare, I_OnChannelDelete, I_OnPostOper, I_OnSyncOtherMetaData };
294 /** Base class for all InspIRCd modules
295 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
296 * its methods will be called when irc server events occur. class inherited from module must be
297 * instantiated by the ModuleFactory class (see relevent section) for the plugin to be initialised.
299 class Module : public classbase
303 /** Default constructor
304 * Creates a module class.
305 * @param Me An instance of the Server class which can be saved for future use
309 /** Default destructor
310 * destroys a module class
314 /** Returns the version number of a Module.
315 * The method should return a Version object with its version information assigned via
318 virtual Version GetVersion();
320 /** The Implements function specifies which methods a module should receive events for.
321 * The char* parameter passed to this function contains a set of true or false values
322 * (1 or 0) which indicate wether each function is implemented. You must use the Iimplementation
323 * enum (documented elsewhere on this page) to mark functions as active. For example, to
324 * receive events for OnUserJoin():
326 * Implements[I_OnUserJoin] = 1;
328 * @param The implement list
330 virtual void Implements(char* Implements);
332 /** Used to set the 'priority' of a module (e.g. when it is called in relation to other modules.
333 * Some modules prefer to be called before other modules, due to their design. For example, a
334 * module which is expected to operate on complete information would expect to be placed last, so
335 * that any other modules which wish to adjust that information would execute before it, to be sure
336 * its information is correct. You can change your module's priority by returning one of:
338 * PRIORITY_FIRST - To place your module first in the list
340 * PRIORITY_LAST - To place your module last in the list
342 * PRIORITY_DONTCARE - To leave your module as it is (this is the default value, if you do not implement this function)
344 * The result of Server::PriorityBefore() - To move your module before another named module
346 * The result of Server::PriorityLast() - To move your module after another named module
348 * For a good working example of this method call, please see src/modules/m_spanningtree.cpp
349 * and src/modules/m_hostchange.so which make use of it. It is highly recommended that unless
350 * your module has a real need to reorder its priority, it should not implement this function,
351 * as many modules changing their priorities can make the system redundant.
353 virtual Priority Prioritize();
355 /** Called when a user connects.
356 * The details of the connecting user are available to you in the parameter userrec *user
357 * @param user The user who is connecting
359 virtual void OnUserConnect(userrec* user);
361 /** Called when a user quits.
362 * The details of the exiting user are available to you in the parameter userrec *user
363 * This event is only called when the user is fully registered when they quit. To catch
364 * raw disconnections, use the OnUserDisconnect method.
365 * @param user The user who is quitting
366 * @param message The user's quit message
368 virtual void OnUserQuit(userrec* user, std::string message);
370 /** Called whenever a user's socket is closed.
371 * The details of the exiting user are available to you in the parameter userrec *user
372 * This event is called for all users, registered or not, as a cleanup method for modules
373 * which might assign resources to user, such as dns lookups, objects and sockets.
374 * @param user The user who is disconnecting
376 virtual void OnUserDisconnect(userrec* user);
378 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
379 * @param chan The channel being deleted
381 virtual void OnChannelDelete(chanrec* chan);
383 /** Called when a user joins a channel.
384 * The details of the joining user are available to you in the parameter userrec *user,
385 * and the details of the channel they have joined is available in the variable chanrec *channel
386 * @param user The user who is joining
387 * @param channel The channel being joined
389 virtual void OnUserJoin(userrec* user, chanrec* channel);
391 /** Called when a user parts a channel.
392 * The details of the leaving user are available to you in the parameter userrec *user,
393 * and the details of the channel they have left is available in the variable chanrec *channel
394 * @param user The user who is parting
395 * @param channel The channel being parted
396 * @param partmessage The part message, or an empty string
398 virtual void OnUserPart(userrec* user, chanrec* channel, std::string partmessage);
400 /** Called on rehash.
401 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
402 * system. You should use it to reload any files so that your module keeps in step with the
403 * rest of the application. If a parameter is given, the core has done nothing. The module
404 * receiving the event can decide if this parameter has any relevence to it.
405 * @param parameter The (optional) parameter given to REHASH from the user.
407 virtual void OnRehash(std::string parameter);
409 /** Called when a raw command is transmitted or received.
410 * This method is the lowest level of handler available to a module. It will be called with raw
411 * data which is passing through a connected socket. If you wish, you may munge this data by changing
412 * the string parameter "raw". If you do this, after your function exits it will immediately be
413 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
414 * inbound is set to true) the value of user will be the userrec of the connection sending the
415 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
416 * @param raw The raw string in RFC1459 format
417 * @param inbound A flag to indicate wether the data is coming into the daemon or going out to the user
418 * @param user The user record sending the text, when inbound == true.
420 virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
422 /** Called whenever an extended mode is to be processed.
423 * The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being
424 * changed. mode_on is set when the mode is being set, in which case params contains a list of
425 * parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters
426 * may contain the parameters for the mode, dependent on wether they were defined when a mode handler
427 * was set up with Server::AddExtendedMode
428 * If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*.
429 * You must cast this value yourself to make use of it.
430 * @param user The user issuing the mode
431 * @param target The user or channel having the mode set on them
432 * @param modechar The mode character being set
433 * @param type The type of mode (user or channel) being set
434 * @param mode_on True if the mode is being set, false if it is being unset
435 * @param params A list of parameters for any channel mode (currently supports either 0 or 1 parameters)
437 virtual int OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list ¶ms);
439 /** Called whenever a user is about to join a channel, before any processing is done.
440 * Returning a value of 1 from this function stops the process immediately, causing no
441 * output to be sent to the user by the core. If you do this you must produce your own numerics,
442 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
443 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
447 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
448 * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
449 * processing on the actual channel record at this point, however the channel NAME will still be passed in
450 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
451 * @param user The user joining the channel
452 * @param cname The channel name being joined
453 * @return 1 To prevent the join, 0 to allow it.
455 virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname);
457 /** Called whenever a user is about to be kicked.
458 * Returning a value of 1 from this function stops the process immediately, causing no
459 * output to be sent to the user by the core. If you do this you must produce your own numerics,
461 * @param source The user issuing the kick
462 * @param user The user being kicked
463 * @param chan The channel the user is being kicked from
464 * @param reason The kick reason
465 * @return 1 to prevent the kick, 0 to allow it
467 virtual int OnUserPreKick(userrec* source, userrec* user, chanrec* chan, std::string reason);
469 /** Called whenever a user is kicked.
470 * If this method is called, the kick is already underway and cannot be prevented, so
471 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
472 * @param source The user issuing the kick
473 * @param user The user being kicked
474 * @param chan The channel the user is being kicked from
475 * @param reason The kick reason
477 virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, std::string reason);
479 /** Called whenever a user opers locally.
480 * The userrec will contain the oper mode 'o' as this function is called after any modifications
481 * are made to the user's structure by the core.
482 * @param user The user who is opering up
483 * @param opertype The opers type name
485 virtual void OnOper(userrec* user, std::string opertype);
487 /** Called after a user opers locally.
488 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
489 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
490 * out the OPERTYPE, etc.
491 * @param user The user who is opering up
492 * @param opertype The opers type name
494 virtual void OnPostOper(userrec* user, std::string opertype);
496 /** Called whenever a user types /INFO.
497 * The userrec will contain the information of the user who typed the command. Modules may use this
498 * method to output their own credits in /INFO (which is the ircd's version of an about box).
499 * It is purposefully not possible to modify any info that has already been output, or halt the list.
500 * You must write a 371 numeric to the user, containing your info in the following format:
502 * <nick> :information here
504 * @param user The user issuing /INFO
506 virtual void OnInfo(userrec* user);
508 /** Called whenever a /WHOIS is performed on a local user.
509 * The source parameter contains the details of the user who issued the WHOIS command, and
510 * the dest parameter contains the information of the user they are whoising.
511 * @param source The user issuing the WHOIS command
512 * @param dest The user who is being WHOISed
514 virtual void OnWhois(userrec* source, userrec* dest);
516 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
517 * Returning 1 from this function stops the process immediately, causing no
518 * output to be sent to the user by the core. If you do this you must produce your own numerics,
519 * notices etc. This is useful for modules which may want to filter invites to channels.
520 * @param source The user who is issuing the INVITE
521 * @param dest The user being invited
522 * @param channel The channel the user is being invited to
523 * @return 1 to deny the invite, 0 to allow
525 virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel);
527 /** Called after a user has been successfully invited to a channel.
528 * You cannot prevent the invite from occuring using this function, to do that,
529 * use OnUserPreInvite instead.
530 * @param source The user who is issuing the INVITE
531 * @param dest The user being invited
532 * @param channel The channel the user is being invited to
534 virtual void OnUserInvite(userrec* source,userrec* dest,chanrec* channel);
536 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
537 * Returning any nonzero value from this function stops the process immediately, causing no
538 * output to be sent to the user by the core. If you do this you must produce your own numerics,
539 * notices etc. This is useful for modules which may want to filter or redirect messages.
540 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
541 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
542 * of where the message is destined to be sent.
543 * @param user The user sending the message
544 * @param dest The target of the message (chanrec* or userrec*)
545 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
546 * @param text Changeable text being sent by the user
547 * @return 1 to deny the NOTICE, 0 to allow it
549 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text);
551 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
552 * Returning any nonzero value from this function stops the process immediately, causing no
553 * output to be sent to the user by the core. If you do this you must produce your own numerics,
554 * notices etc. This is useful for modules which may want to filter or redirect messages.
555 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
556 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
557 * of where the message is destined to be sent.
558 * You may alter the message text as you wish before relinquishing control to the next module
559 * in the chain, and if no other modules block the text this altered form of the text will be sent out
560 * to the user and possibly to other servers.
561 * @param user The user sending the message
562 * @param dest The target of the message (chanrec* or userrec*)
563 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
564 * @param text Changeable text being sent by the user
565 * @return 1 to deny the NOTICE, 0 to allow it
567 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text);
569 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
570 * Please note that although you can see remote nickchanges through this function, you should
571 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
572 * check user->server before taking any action (including returning nonzero from the method).
573 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
574 * module to generate some meaninful output.
575 * @param user The username changing their nick
576 * @param newnick Their new nickname
577 * @return 1 to deny the change, 0 to allow
579 virtual int OnUserPreNick(userrec* user, std::string newnick);
581 /** Called after any PRIVMSG sent from a user.
582 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
583 * if target_type is TYPE_CHANNEL.
584 * @param user The user sending the message
585 * @param dest The target of the message
586 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
587 * @param text the text being sent by the user
589 virtual void OnUserMessage(userrec* user, void* dest, int target_type, std::string text);
591 /** Called after any NOTICE sent from a user.
592 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
593 * if target_type is TYPE_CHANNEL.
594 * @param user The user sending the message
595 * @param dest The target of the message
596 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
597 * @param text the text being sent by the user
599 virtual void OnUserNotice(userrec* user, void* dest, int target_type, std::string text);
601 /** Called after every MODE command sent from a user
602 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
603 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
604 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
605 * @param user The user sending the MODEs
606 * @param dest The target of the modes (userrec* or chanrec*)
607 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
608 * @param text The actual modes and their parameters if any
610 virtual void OnMode(userrec* user, void* dest, int target_type, std::string text);
612 /** Allows modules to alter or create server descriptions
613 * Whenever a module requires a server description, for example for display in
614 * WHOIS, this function is called in all modules. You may change or define the
615 * description given in std::string &description. If you do, this description
616 * will be shown in the WHOIS fields.
617 * @param servername The servername being searched for
618 * @param description Alterable server description for this server
620 virtual void OnGetServerDescription(std::string servername,std::string &description);
622 /** Allows modules to synchronize data which relates to users during a netburst.
623 * When this function is called, it will be called from the module which implements
624 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
625 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
626 * (see below). This function will be called for every user visible on your side
627 * of the burst, allowing you to for example set modes, etc. Do not use this call to
628 * synchronize data which you have stored using class Extensible -- There is a specialist
629 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
630 * @param user The user being syncronized
631 * @param proto A pointer to the module handling network protocol
632 * @param opaque An opaque pointer set by the protocol module, should not be modified!
634 virtual void OnSyncUser(userrec* user, Module* proto, void* opaque);
636 /** Allows modules to synchronize data which relates to channels during a netburst.
637 * When this function is called, it will be called from the module which implements
638 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
639 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
640 * (see below). This function will be called for every user visible on your side
641 * of the burst, allowing you to for example set modes, etc. Do not use this call to
642 * synchronize data which you have stored using class Extensible -- There is a specialist
643 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
645 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
647 * @param chan The channel being syncronized
648 * @param proto A pointer to the module handling network protocol
649 * @param opaque An opaque pointer set by the protocol module, should not be modified!
651 virtual void OnSyncChannel(chanrec* chan, Module* proto, void* opaque);
653 /* Allows modules to syncronize metadata related to channels over the network during a netburst.
654 * Whenever the linking module wants to send out data, but doesnt know what the data
655 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
656 * this method is called.You should use the ProtoSendMetaData function after you've
657 * correctly decided how the data should be represented, to send the metadata on its way if it belongs
658 * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
659 * @param chan The channel whos metadata is being syncronized
660 * @param proto A pointer to the module handling network protocol
661 * @param opaque An opaque pointer set by the protocol module, should not be modified!
662 * @param extname The extensions name which is being searched for
664 virtual void OnSyncChannelMetaData(chanrec* chan, Module* proto,void* opaque, std::string extname);
666 /* Allows modules to syncronize metadata related to users over the network during a netburst.
667 * Whenever the linking module wants to send out data, but doesnt know what the data
668 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
669 * this method is called. You should use the ProtoSendMetaData function after you've
670 * correctly decided how the data should be represented, to send the metadata on its way if
671 * if it belongs to your module.
672 * @param user The user whos metadata is being syncronized
673 * @param proto A pointer to the module handling network protocol
674 * @param opaque An opaque pointer set by the protocol module, should not be modified!
675 * @param extname The extensions name which is being searched for
677 virtual void OnSyncUserMetaData(userrec* user, Module* proto,void* opaque, std::string extname);
679 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
680 * Whenever the linking module wants to send out data, but doesnt know what the data
681 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
682 * this method is called. You should use the ProtoSendMetaData function after you've
683 * correctly decided how the data should be represented, to send the metadata on its way if
684 * if it belongs to your module.
685 * @param proto A pointer to the module handling network protocol
686 * @param opaque An opaque pointer set by the protocol module, should not be modified!
688 virtual void OnSyncOtherMetaData(Module* proto, void* opaque);
690 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
691 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
692 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
693 * @param target The chanrec* or userrec* that data should be added to
694 * @param extname The extension name which is being sent
695 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
697 virtual void OnDecodeMetaData(int target_type, void* target, std::string extname, std::string extdata);
699 /** Implemented by modules which provide the ability to link servers.
700 * These modules will implement this method, which allows transparent sending of servermodes
701 * down the network link as a broadcast, without a module calling it having to know the format
702 * of the MODE command before the actual mode string.
704 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
705 * of how to use this function.
707 * @param opaque An opaque pointer set by the protocol module, should not be modified!
708 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
709 * @param target The chanrec* or userrec* that modes should be sent for
710 * @param modeline The modes and parameters to be sent
712 virtual void ProtoSendMode(void* opaque, int target_type, void* target, std::string modeline);
714 /** Implemented by modules which provide the ability to link servers.
715 * These modules will implement this method, which allows metadata (extra data added to
716 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
717 * to other servers on a netburst and decoded at the other end by the same module on a
720 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
721 * how to use this function.
722 * @param opaque An opaque pointer set by the protocol module, should not be modified!
723 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
724 * @param target The chanrec* or userrec* that metadata should be sent for
725 * @param extname The extension name to send metadata for
726 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
728 virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, std::string extname, std::string extdata);
730 /** Called after every WALLOPS command.
731 * @param user The user sending the WALLOPS
732 * @param text The content of the WALLOPS message
734 virtual void OnWallops(userrec* user, std::string text);
736 /** Called whenever a user's hostname is changed.
737 * This event triggers after the host has been set.
738 * @param user The user whos host is being changed
739 * @param newhost The new hostname being set
741 virtual void OnChangeHost(userrec* user, std::string newhost);
743 /** Called whenever a user's GECOS (realname) is changed.
744 * This event triggers after the name has been set.
745 * @param user The user who's GECOS is being changed
746 * @param gecos The new GECOS being set on the user
748 virtual void OnChangeName(userrec* user, std::string gecos);
750 /** Called whenever a gline is added by a local user.
751 * This method is triggered after the line is added.
752 * @param duration The duration of the line in seconds
753 * @param source The sender of the line
754 * @param reason The reason text to be displayed
755 * @param hostmask The hostmask to add
757 virtual void OnAddGLine(long duration, userrec* source, std::string reason, std::string hostmask);
759 /** Called whenever a zline is added by a local user.
760 * This method is triggered after the line is added.
761 * @param duration The duration of the line in seconds
762 * @param source The sender of the line
763 * @param reason The reason text to be displayed
764 * @param ipmask The hostmask to add
766 virtual void OnAddZLine(long duration, userrec* source, std::string reason, std::string ipmask);
768 /** Called whenever a kline is added by a local user.
769 * This method is triggered after the line is added.
770 * @param duration The duration of the line in seconds
771 * @param source The sender of the line
772 * @param reason The reason text to be displayed
773 * @param hostmask The hostmask to add
775 virtual void OnAddKLine(long duration, userrec* source, std::string reason, std::string hostmask);
777 /** Called whenever a qline is added by a local user.
778 * This method is triggered after the line is added.
779 * @param duration The duration of the line in seconds
780 * @param source The sender of the line
781 * @param reason The reason text to be displayed
782 * @param nickmask The hostmask to add
784 virtual void OnAddQLine(long duration, userrec* source, std::string reason, std::string nickmask);
786 /** Called whenever a eline is added by a local user.
787 * This method is triggered after the line is added.
788 * @param duration The duration of the line in seconds
789 * @param source The sender of the line
790 * @param reason The reason text to be displayed
791 * @param hostmask The hostmask to add
793 virtual void OnAddELine(long duration, userrec* source, std::string reason, std::string hostmask);
795 /** Called whenever a gline is deleted.
796 * This method is triggered after the line is deleted.
797 * @param source The user removing the line
798 * @param hostmask The hostmask to delete
800 virtual void OnDelGLine(userrec* source, std::string hostmask);
802 /** Called whenever a zline is deleted.
803 * This method is triggered after the line is deleted.
804 * @param source The user removing the line
805 * @param hostmask The hostmask to delete
807 virtual void OnDelZLine(userrec* source, std::string ipmask);
809 /** Called whenever a kline is deleted.
810 * This method is triggered after the line is deleted.
811 * @param source The user removing the line
812 * @param hostmask The hostmask to delete
814 virtual void OnDelKLine(userrec* source, std::string hostmask);
816 /** Called whenever a qline is deleted.
817 * This method is triggered after the line is deleted.
818 * @param source The user removing the line
819 * @param hostmask The hostmask to delete
821 virtual void OnDelQLine(userrec* source, std::string nickmask);
823 /** Called whenever a eline is deleted.
824 * This method is triggered after the line is deleted.
825 * @param source The user removing the line
826 * @param hostmask The hostmask to delete
828 virtual void OnDelELine(userrec* source, std::string hostmask);
830 /** Called before your module is unloaded to clean up Extensibles.
831 * This method is called once for every user and channel on the network,
832 * so that when your module unloads it may clear up any remaining data
833 * in the form of Extensibles added using Extensible::Extend().
834 * If the target_type variable is TYPE_USER, then void* item refers to
835 * a userrec*, otherwise it refers to a chanrec*.
836 * @param target_type The type of item being cleaned
837 * @param item A pointer to the item's class
839 virtual void OnCleanup(int target_type, void* item);
841 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
842 * have been applied. Please note that although you can see remote nickchanges through this function, you should
843 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
844 * check user->server before taking any action (including returning nonzero from the method).
845 * Because this method is called after the nickchange is taken place, no return values are possible
846 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
847 * @param user The user changing their nick
848 * @param oldnick The old nickname of the user before the nickchange
850 virtual void OnUserPostNick(userrec* user, std::string oldnick);
852 /** Called before an action which requires a channel privilage check.
853 * This function is called before many functions which check a users status on a channel, for example
854 * before opping a user, deopping a user, kicking a user, etc.
855 * There are several values for access_type which indicate for what reason access is being checked.
857 * AC_KICK (0) - A user is being kicked<br>
858 * AC_DEOP (1) - a user is being deopped<br>
859 * AC_OP (2) - a user is being opped<br>
860 * AC_VOICE (3) - a user is being voiced<br>
861 * AC_DEVOICE (4) - a user is being devoiced<br>
862 * AC_HALFOP (5) - a user is being halfopped<br>
863 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
864 * AC_INVITE (7) - a user is being invited<br>
865 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
866 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
867 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
868 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
869 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
870 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
871 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
872 * @param source The source of the access check
873 * @param dest The destination of the access check
874 * @param channel The channel which is being checked
875 * @param access_type See above
877 virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
879 /** Called when a 005 numeric is about to be output.
880 * The module should modify the 005 numeric if needed to indicate its features.
881 * @param output The 005 string to be modified if neccessary.
883 virtual void On005Numeric(std::string &output);
885 /** Called when a client is disconnected by KILL.
886 * If a client is killed by a server, e.g. a nickname collision or protocol error,
888 * Return 1 from this function to prevent the kill, and 0 from this function to allow
889 * it as normal. If you prevent the kill no output will be sent to the client, it is
890 * down to your module to generate this information.
891 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
892 * If you do so youre risking race conditions, desyncs and worse!
893 * @param source The user sending the KILL
894 * @param dest The user being killed
895 * @param reason The kill reason
896 * @return 1 to prevent the kill, 0 to allow
898 virtual int OnKill(userrec* source, userrec* dest, std::string reason);
900 /** Called when an oper wants to disconnect a remote user via KILL
901 * @param source The user sending the KILL
902 * @param dest The user being killed
903 * @param reason The kill reason
905 virtual void OnRemoteKill(userrec* source, userrec* dest, std::string reason);
907 /** Called whenever a module is loaded.
908 * mod will contain a pointer to the module, and string will contain its name,
909 * for example m_widgets.so. This function is primary for dependency checking,
910 * your module may decide to enable some extra features if it sees that you have
911 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
912 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
913 * but instead operate under reduced functionality, unless the dependency is
914 * absolutely neccessary (e.g. a module that extends the features of another
916 * @param mod A pointer to the new module
917 * @param name The new module's filename
919 virtual void OnLoadModule(Module* mod,std::string name);
921 /** Called whenever a module is unloaded.
922 * mod will contain a pointer to the module, and string will contain its name,
923 * for example m_widgets.so. This function is primary for dependency checking,
924 * your module may decide to enable some extra features if it sees that you have
925 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
926 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
927 * but instead operate under reduced functionality, unless the dependency is
928 * absolutely neccessary (e.g. a module that extends the features of another
930 * @param mod Pointer to the module being unloaded (still valid)
931 * @param name The filename of the module being unloaded
933 virtual void OnUnloadModule(Module* mod,std::string name);
935 /** Called once every five seconds for background processing.
936 * This timer can be used to control timed features. Its period is not accurate
937 * enough to be used as a clock, but it is gauranteed to be called at least once in
938 * any five second period, directly from the main loop of the server.
939 * @param curtime The current timer derived from time(2)
941 virtual void OnBackgroundTimer(time_t curtime);
943 /** Called whenever a list is needed for a listmode.
944 * For example, when a /MODE #channel +b (without any other parameters) is called,
945 * if a module was handling +b this function would be called. The function can then
946 * output any lists it wishes to. Please note that all modules will see all mode
947 * characters to provide the ability to extend each other, so please only output
948 * a list if the mode character given matches the one(s) you want to handle.
949 * @param user The user requesting the list
950 * @param channel The channel the list is for
951 * @param mode The listmode which a list is being requested on
953 virtual void OnSendList(userrec* user, chanrec* channel, char mode);
955 /** Called whenever any command is about to be executed.
956 * This event occurs for all registered commands, wether they are registered in the core,
957 * or another module, but it will not occur for invalid commands (e.g. ones which do not
958 * exist within the command table). By returning 1 from this method you may prevent the
959 * command being executed. If you do this, no output is created by the core, and it is
960 * down to your module to produce any output neccessary.
961 * Note that unless you return 1, you should not destroy any structures (e.g. by using
962 * Server::QuitUser) otherwise when the command's handler function executes after your
963 * method returns, it will be passed an invalid pointer to the user object and crash!)
964 * @param command The command being executed
965 * @param parameters An array of array of characters containing the parameters for the command
966 * @param pcnt The nuimber of parameters passed to the command
967 * @param user the user issuing the command
968 * @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.
969 * @return 1 to block the command, 0 to allow
971 virtual int OnPreCommand(std::string command, char **parameters, int pcnt, userrec *user, bool validated);
973 /** Called to check if a user who is connecting can now be allowed to register
974 * If any modules return false for this function, the user is held in the waiting
975 * state until all modules return true. For example a module which implements ident
976 * lookups will continue to return false for a user until their ident lookup is completed.
977 * Note that the registration timeout for a user overrides these checks, if the registration
978 * timeout is reached, the user is disconnected even if modules report that the user is
979 * not ready to connect.
980 * @param user The user to check
981 * @return true to indicate readiness, false if otherwise
983 virtual bool OnCheckReady(userrec* user);
985 /** Called whenever a user is about to register their connection (e.g. before the user
986 * is sent the MOTD etc). Modules can use this method if they are performing a function
987 * which must be done before the actual connection is completed (e.g. ident lookups,
988 * dnsbl lookups, etc).
989 * Note that you should NOT delete the user record here by causing a disconnection!
990 * Use OnUserConnect for that instead.
991 * @param user The user registering
993 virtual void OnUserRegister(userrec* user);
995 /** Called whenever a mode character is processed.
996 * Return 1 from this function to block the mode character from being processed entirely,
997 * so that you may perform your own code instead. Note that this method allows you to override
998 * modes defined by other modes, but this is NOT RECOMMENDED!
999 * @param user The user who is sending the mode
1000 * @param chan The channel the mode is being sent to
1001 * @param mode The mode character being set
1002 * @param param The parameter for the mode or an empty string
1003 * @param adding true of the mode is being added, false if it is being removed
1004 * @param pcnt The parameter count for the mode (0 or 1)
1005 * @return 1 to deny the mode, 0 to allow
1007 virtual int OnRawMode(userrec* user, chanrec* chan, char mode, std::string param, bool adding, int pcnt);
1009 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1010 * This method will always be called for each join, wether or not the channel is actually +i, and
1011 * determines the outcome of an if statement around the whole section of invite checking code.
1012 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1013 * @param user The user joining the channel
1014 * @param chan The channel being joined
1015 * @return 1 to explicitly allow the join, 0 to proceed as normal
1017 virtual int OnCheckInvite(userrec* user, chanrec* chan);
1019 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1020 * This method will always be called for each join, wether or not the channel is actually +k, and
1021 * determines the outcome of an if statement around the whole section of key checking code.
1022 * if the user specified no key, the keygiven string will be a valid but empty value.
1023 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1024 * @param user The user joining the channel
1025 * @param chan The channel being joined
1026 * @return 1 to explicitly allow the join, 0 to proceed as normal
1028 virtual int OnCheckKey(userrec* user, chanrec* chan, std::string keygiven);
1030 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1031 * This method will always be called for each join, wether or not the channel is actually +l, and
1032 * determines the outcome of an if statement around the whole section of channel limit 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 OnCheckLimit(userrec* user, chanrec* chan);
1040 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
1041 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
1042 * determines the outcome of an if statement around the whole section of ban checking code.
1043 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1044 * @param user The user joining the channel
1045 * @param chan The channel being joined
1046 * @return 1 to explicitly allow the join, 0 to proceed as normal
1048 virtual int OnCheckBan(userrec* user, chanrec* chan);
1050 /** Called on all /STATS commands
1051 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1052 * @param symbol the symbol provided to /STATS
1053 * @user the user issuing the /STATS command
1054 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1056 virtual int OnStats(char symbol, userrec* user);
1058 /** Called whenever a change of a local users displayed host is attempted.
1059 * Return 1 to deny the host change, or 0 to allow it.
1060 * @param user The user whos host will be changed
1061 * @param newhost The new hostname
1062 * @return 1 to deny the host change, 0 to allow
1064 virtual int OnChangeLocalUserHost(userrec* user, std::string newhost);
1066 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1067 * return 1 to deny the name change, or 0 to allow it.
1068 * @param user The user whos GECOS will be changed
1069 * @param newhost The new GECOS
1070 * @return 1 to deny the GECOS change, 0 to allow
1072 virtual int OnChangeLocalUserGECOS(userrec* user, std::string newhost);
1074 /** Called whenever a topic is changed by a local user.
1075 * Return 1 to deny the topic change, or 0 to allow it.
1076 * @param user The user changing the topic
1077 * @param chan The channels who's topic is being changed
1078 * @param topic The actual topic text
1079 * @param 1 to block the topic change, 0 to allow
1081 virtual int OnLocalTopicChange(userrec* user, chanrec* chan, std::string topic);
1083 /** Called whenever a local topic has been changed.
1084 * To block topic changes you must use OnLocalTopicChange instead.
1085 * @param user The user changing the topic
1086 * @param chan The channels who's topic is being changed
1087 * @param topic The actual topic text
1089 virtual void OnPostLocalTopicChange(userrec* user, chanrec* chan, std::string topic);
1091 /** Called whenever an Event class is sent to all module by another module.
1092 * Please see the documentation of Event::Send() for further information. The Event sent can
1093 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1094 * before doing anything to the event data, and you should *not* change the event data in any way!
1095 * @param event The Event class being received
1097 virtual void OnEvent(Event* event);
1099 /** Called whenever a Request class is sent to your module by another module.
1100 * Please see the documentation of Request::Send() for further information. The Request sent
1101 * can always be assumed to be non-NULL, you should not change the request object or its data.
1102 * Your method may return arbitary data in the char* result which the requesting module
1103 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1104 * @param request The Request class being received
1106 virtual char* OnRequest(Request* request);
1108 /** Called whenever an oper password is to be compared to what a user has input.
1109 * The password field (from the config file) is in 'password' and is to be compared against
1110 * 'input'. This method allows for encryption of oper passwords and much more besides.
1111 * You should return a nonzero value if you want to allow the comparison or zero if you wish
1113 * @param password The oper's password
1114 * @param input The password entered
1115 * @return 1 to match the passwords, 0 to do nothing
1117 virtual int OnOperCompare(std::string password, std::string input);
1119 /** Called whenever a user is given usermode +o, anywhere on the network.
1120 * You cannot override this and prevent it from happening as it is already happened and
1121 * such a task must be performed by another server. You can however bounce modes by sending
1122 * servermodes out to reverse mode changes.
1123 * @param user The user who is opering
1125 virtual void OnGlobalOper(userrec* user);
1127 /** Called whenever a user connects, anywhere on the network.
1128 * This event is informational only. You should not change any user information in this
1129 * event. To do so, use the OnUserConnect method to change the state of local users.
1130 * @param user The user who is connecting
1132 virtual void OnGlobalConnect(userrec* user);
1134 /** Called whenever a ban is added to a channel's list.
1135 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1136 * @param source The user adding the ban
1137 * @param channel The channel the ban is being added to
1138 * @param banmask The ban mask being added
1139 * @return 1 to block the ban, 0 to continue as normal
1141 virtual int OnAddBan(userrec* source, chanrec* channel,std::string banmask);
1143 /** Called whenever a ban is removed from a channel's list.
1144 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1145 * @param source The user deleting the ban
1146 * @param channel The channel the ban is being deleted from
1147 * @param banmask The ban mask being deleted
1148 * @return 1 to block the unban, 0 to continue as normal
1150 virtual int OnDelBan(userrec* source, chanrec* channel,std::string banmask);
1152 /** Called immediately after any connection is accepted. This is intended for raw socket
1153 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1154 * no information relating to a user record as the connection has not been assigned yet.
1155 * There are no return values from this call as all modules get an opportunity if required to
1156 * process the connection.
1157 * @param fd The file descriptor returned from accept()
1158 * @param ip The IP address of the connecting user
1159 * @param localport The local port number the user connected to
1161 virtual void OnRawSocketAccept(int fd, std::string ip, int localport);
1163 /** Called immediately before any write() operation on a user's socket in the core. Because
1164 * this event is a low level event no user information is associated with it. It is intended
1165 * for use by modules which may wrap connections within another API such as SSL for example.
1166 * return a non-zero result if you have handled the write operation, in which case the core
1167 * will not call write().
1168 * @param fd The file descriptor of the socket
1169 * @param buffer A char* buffer being written
1170 * @param Number of characters to write
1171 * @return Number of characters actually written or 0 if you didn't handle the operation
1173 virtual int OnRawSocketWrite(int fd, char* buffer, int count);
1175 /** Called immediately before any socket is closed. When this event is called, shutdown()
1176 * has not yet been called on the socket.
1177 * @param fd The file descriptor of the socket prior to close()
1179 virtual void OnRawSocketClose(int fd);
1181 /** Called immediately before any read() operation on a client socket in the core.
1182 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1183 * when this event occurs.
1184 * Your event should return 1 if it has handled the reading itself, which prevents the core
1185 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1186 * the value of count. The value of readresult must be identical to an actual result that might
1187 * be returned from the read() system call, for example, number of bytes read upon success,
1188 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1189 * you MUST set readresult.
1190 * @param fd The file descriptor of the socket
1191 * @param buffer A char* buffer being read to
1192 * @param count The size of the buffer
1193 * @param readresult The amount of characters read, or 0
1194 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1196 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1200 /** Allows server output and query functions
1201 * This class contains methods which allow a module to query the state of the irc server, and produce
1202 * output to users and other servers. All modules should instantiate at least one copy of this class,
1203 * and use its member functions to perform their tasks.
1205 class Server : public classbase
1208 /** Default constructor.
1209 * Creates a Server object.
1213 /** Default destructor.
1214 * Destroys a Server object.
1218 /** Obtains a pointer to the server's ServerConfig object.
1219 * The ServerConfig object contains most of the configuration data
1220 * of the IRC server, as read from the config file by the core.
1222 ServerConfig* GetConfig();
1224 /** For use with Module::Prioritize().
1225 * When the return value of this function is returned from
1226 * Module::Prioritize(), this specifies that the module wishes
1227 * to be ordered exactly BEFORE 'modulename'. For more information
1228 * please see Module::Prioritize().
1229 * @param modulename The module your module wants to be before in the call list
1230 * @returns a priority ID which the core uses to relocate the module in the list
1232 long PriorityBefore(std::string modulename);
1234 /** For use with Module::Prioritize().
1235 * When the return value of this function is returned from
1236 * Module::Prioritize(), this specifies that the module wishes
1237 * to be ordered exactly AFTER 'modulename'. For more information please
1238 * see Module::Prioritize().
1239 * @param modulename The module your module wants to be after in the call list
1240 * @returns a priority ID which the core uses to relocate the module in the list
1242 long PriorityAfter(std::string modulename);
1244 /** Sends text to all opers.
1245 * This method sends a server notice to all opers with the usermode +s.
1247 virtual void SendOpers(std::string s);
1249 /** Returns the version string of this server
1251 std::string GetVersion();
1253 /** Writes a log string.
1254 * This method writes a line of text to the log. If the level given is lower than the
1255 * level given in the configuration, this command has no effect.
1257 virtual void Log(int level, std::string s);
1259 /** Sends a line of text down a TCP/IP socket.
1260 * This method writes a line of text to an established socket, cutting it to 510 characters
1261 * plus a carriage return and linefeed if required.
1263 virtual void Send(int Socket, std::string s);
1265 /** Sends text from the server to a socket.
1266 * This method writes a line of text to an established socket, with the servername prepended
1267 * as used by numerics (see RFC 1459)
1269 virtual void SendServ(int Socket, std::string s);
1271 /** Writes text to a channel, but from a server, including all.
1272 * This can be used to send server notices to a group of users.
1274 virtual void SendChannelServerNotice(std::string ServName, chanrec* Channel, std::string text);
1276 /** Sends text from a user to a socket.
1277 * This method writes a line of text to an established socket, with the given user's nick/ident
1278 * /host combination prepended, as used in PRIVSG etc commands (see RFC 1459)
1280 virtual void SendFrom(int Socket, userrec* User, std::string s);
1282 /** Sends text from a user to another user.
1283 * This method writes a line of text to a user, with a user's nick/ident
1284 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459)
1285 * If you specify NULL as the source, then the data will originate from the
1286 * local server, e.g. instead of:
1288 * :user!ident@host TEXT
1290 * The format will become:
1294 * Which is useful for numerics and server notices to single users, etc.
1296 virtual void SendTo(userrec* Source, userrec* Dest, std::string s);
1298 /** Sends text from a user to a channel (mulicast).
1299 * This method writes a line of text to a channel, with the given user's nick/ident
1300 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the
1301 * IncludeSender flag is set, then the text is also sent back to the user from which
1302 * it originated, as seen in MODE (see RFC 1459).
1304 virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender);
1306 /** Returns true if two users share a common channel.
1307 * This method is used internally by the NICK and QUIT commands, and the Server::SendCommon
1310 virtual bool CommonChannels(userrec* u1, userrec* u2);
1312 /** Sends text from a user to one or more channels (mulicast).
1313 * This method writes a line of text to all users which share a common channel with a given
1314 * user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc
1315 * commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent
1316 * back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it
1317 * is only sent to the other recipients, as seen in QUIT.
1319 virtual void SendCommon(userrec* User, std::string text,bool IncludeSender);
1321 /** Sends a WALLOPS message.
1322 * This method writes a WALLOPS message to all users with the +w flag, originating from the
1325 virtual void SendWallops(userrec* User, std::string text);
1327 /** Returns true if a nick is valid.
1328 * Nicks for unregistered connections will return false.
1330 virtual bool IsNick(std::string nick);
1332 /** Returns a count of the number of users on a channel.
1333 * This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.
1335 virtual int CountUsers(chanrec* c);
1337 /** Attempts to look up a nick and return a pointer to it.
1338 * This function will return NULL if the nick does not exist.
1340 virtual userrec* FindNick(std::string nick);
1342 /** Attempts to look up a nick using the file descriptor associated with that nick.
1343 * This function will return NULL if the file descriptor is not associated with a valid user.
1345 virtual userrec* FindDescriptor(int socket);
1347 /** Attempts to look up a channel and return a pointer to it.
1348 * This function will return NULL if the channel does not exist.
1350 virtual chanrec* FindChannel(std::string channel);
1352 /** Attempts to look up a user's privilages on a channel.
1353 * This function will return a string containing either @, %, +, or an empty string,
1354 * representing the user's privilages upon the channel you specify.
1356 virtual std::string ChanMode(userrec* User, chanrec* Chan);
1358 /** Checks if a user is on a channel.
1359 * This function will return true or false to indicate if user 'User' is on channel 'Chan'.
1361 virtual bool IsOnChannel(userrec* User, chanrec* Chan);
1363 /** Returns the server name of the server where the module is loaded.
1365 virtual std::string GetServerName();
1367 /** Returns the network name, global to all linked servers.
1369 virtual std::string GetNetworkName();
1371 /** Returns the server description string of the local server
1373 virtual std::string GetServerDescription();
1375 /** Returns the information of the server as returned by the /ADMIN command.
1376 * See the Admin class for further information of the return value. The members
1377 * Admin::Nick, Admin::Email and Admin::Name contain the information for the
1378 * server where the module is loaded.
1380 virtual Admin GetAdmin();
1382 /** Adds an extended mode letter which is parsed by a module.
1383 * This allows modules to add extra mode letters, e.g. +x for hostcloak.
1384 * the "type" parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to
1385 * indicate wether the mode is a channel mode, a client mode, or a server mode.
1386 * requires_oper is used with MT_CLIENT type modes only to indicate the mode can only
1387 * be set or unset by an oper. If this is used for MT_CHANNEL type modes it is ignored.
1388 * params_when_on is the number of modes to expect when the mode is turned on
1389 * (for type MT_CHANNEL only), e.g. with mode +k, this would have a value of 1.
1390 * the params_when_off value has a similar value to params_when_on, except it indicates
1391 * the number of parameters to expect when the mode is disabled. Modes which act in a similar
1392 * way to channel mode +l (e.g. require a parameter to enable, but not to disable) should
1393 * use this parameter. The function returns false if the mode is unavailable, and will not
1394 * attempt to allocate another character, as this will confuse users. This also means that
1395 * as only one module can claim a specific mode character, the core does not need to keep track
1396 * of which modules own which modes, which speeds up operation of the server. In this version,
1397 * a mode can have at most one parameter, attempting to use more parameters will have undefined
1400 virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off);
1402 /** Adds an extended mode letter which is parsed by a module and handled in a list fashion.
1403 * This call is used to implement modes like +q and +a. The characteristics of these modes are
1406 * (1) They are ALWAYS on channels, not on users, therefore their type is MT_CHANNEL
1408 * (2) They always take exactly one parameter when being added or removed
1410 * (3) They can be set multiple times, usually on users in channels
1412 * (4) The mode and its parameter are NOT stored in the channels modes structure
1414 * It is down to the module handling the mode to maintain state and determine what 'items' (e.g. users,
1415 * or a banlist) have the mode set on them, and process the modes at the correct times, e.g. during access
1416 * checks on channels, etc. When the extended mode is triggered the OnExtendedMode method will be triggered
1417 * as above. Note that the target you are given will be a channel, if for example your mode is set 'on a user'
1418 * (in for example +a) you must use Server::Find to locate the user the mode is operating on.
1419 * Your mode handler may return 1 to handle the mode AND tell the core to display the mode change, e.g.
1420 * '+aaa one two three' in the case of the mode for 'two', or it may return -1 to 'eat' the mode change,
1421 * so the above example would become '+aa one three' after processing.
1423 virtual bool AddExtendedListMode(char modechar);
1425 /** Adds a command to the command table.
1426 * This allows modules to add extra commands into the command table. You must place a function within your
1427 * module which is is of type handlerfunc:
1429 * typedef void (handlerfunc) (char**, int, userrec*);
1431 * void handle_kill(char **parameters, int pcnt, userrec *user)
1433 * When the command is typed, the parameters will be placed into the parameters array (similar to argv) and
1434 * the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters
1435 * than the 'minparams' value you specified when creating the command. The *user parameter is the class of
1436 * the user which caused the command to trigger, who will always have the flag you specified in 'flags' when
1437 * creating the initial command. For example to create an oper only command create the commands with flags='o'.
1438 * The source parameter is used for resource tracking, and should contain the name of your module (with file
1439 * extension) e.g. "m_blarp.so". If you place the wrong identifier here, you can cause crashes if your module
1442 virtual void AddCommand(command_t *f);
1444 /** Sends a servermode.
1445 * you must format the parameters array with the target, modes and parameters for those modes.
1451 * modes[0] = ChannelName;
1455 * modes[2] = user->nick;
1457 * Srv->SendMode(modes,3,user);
1459 * The modes will originate from the server where the command was issued, however responses (e.g. numerics)
1460 * will be sent to the user you provide as the third parameter.
1461 * You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave
1462 * your server in an unstable state!
1465 virtual void SendMode(char **parameters, int pcnt, userrec *user);
1467 /** Sends to all users matching a mode mask
1468 * You must specify one or more usermodes as the first parameter. These can be RFC specified modes such as +i,
1469 * or module provided modes, including ones provided by your own module.
1470 * In the second parameter you must place a flag value which indicates wether the modes you have given will be
1471 * logically ANDed or OR'ed. You may use one of either WM_AND or WM_OR.
1472 * for example, if you were to use:
1474 * Serv->SendToModeMask("xi", WM_OR, "m00");
1476 * Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the
1477 * user must have both modes set to receive the message.
1479 virtual void SendToModeMask(std::string modes, int flags, std::string text);
1481 /** Forces a user to join a channel.
1482 * This is similar to svsjoin and can be used to implement redirection, etc.
1483 * On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to.
1484 * On failure, the result is NULL.
1486 virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key);
1488 /** Forces a user to part a channel.
1489 * This is similar to svspart and can be used to implement redirection, etc.
1490 * Although the return value of this function is a pointer to a channel record, the returned data is
1491 * undefined and should not be read or written to. This behaviour may be changed in a future version.
1493 virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason);
1495 /** Forces a user nickchange.
1496 * This command works similarly to SVSNICK, and can be used to implement Q-lines etc.
1497 * If you specify an invalid nickname, the nick change will be dropped and the target user will receive
1498 * the error numeric for it.
1500 virtual void ChangeUserNick(userrec* user, std::string nickname);
1502 /** Forces a user to quit with the specified reason.
1503 * To the user, it will appear as if they typed /QUIT themselves, except for the fact that this function
1504 * may bypass the quit prefix specified in the config file.
1508 * Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or
1509 * read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of
1510 * action after calling this method is to immediately bail from your handler.
1512 virtual void QuitUser(userrec* user, std::string reason);
1514 /** Makes a user kick another user, with the specified reason.
1515 * If source is NULL, the server will peform the kick.
1516 * @param The person or server (if NULL) performing the KICK
1517 * @param target The person being kicked
1518 * @param chan The channel to kick from
1519 * @param reason The kick reason
1521 virtual void KickUser(userrec* source, userrec* target, chanrec* chan, std::string reason);
1523 /** Matches text against a glob pattern.
1524 * Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com
1525 * Returns true if the literal successfully matches the pattern, false if otherwise.
1527 virtual bool MatchText(std::string sliteral, std::string spattern);
1529 /** Calls the handler for a command, either implemented by the core or by another module.
1530 * You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN,
1531 * KICK etc, or even as a method of callback. By defining command names that are untypeable
1532 * for users on irc (e.g. those which contain a \r or \n) you may use them as callback identifiers.
1533 * The first parameter to this method is the name of the command handler you wish to call, e.g.
1534 * PRIVMSG. This will be a command handler previously registered by the core or wih AddCommand().
1535 * The second parameter is an array of parameters, and the third parameter is a count of parameters
1536 * in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the
1537 * functiom will silently ignore it. The final parameter is the user executing the command handler,
1538 * used for privilage checks, etc.
1540 virtual void CallCommandHandler(std::string commandname, 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(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, 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, 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(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,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,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, std::string source, std::string reason, 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, std::string source, std::string reason, 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, std::string source, std::string reason, 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, std::string source, std::string reason, 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, std::string source, std::string reason, std::string hostmask);
1636 /** Deletes a G-Line from all servers
1638 virtual bool DelGLine(std::string hostmask);
1640 /** Deletes a Q-Line from all servers
1642 virtual bool DelQLine(std::string nickname);
1644 /** Deletes a Z-Line from all servers
1646 virtual bool DelZLine(std::string ipaddr);
1648 /** Deletes a local K-Line
1650 virtual bool DelKLine(std::string hostmask);
1652 /** Deletes a local E-Line
1654 virtual bool DelELine(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(std::string duration);
1663 /** Returns true if a nick!ident@host string is correctly formatted, false if otherwise.
1665 virtual bool IsValidMask(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(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 virtual void RehashServer();
1689 #define CONF_NOT_A_NUMBER 0x000010
1690 #define CONF_NOT_UNSIGNED 0x000080
1691 #define CONF_VALUE_NOT_FOUND 0x000100
1692 #define CONF_FILE_NOT_FOUND 0x000200
1695 /** Allows reading of values from configuration files
1696 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1697 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1698 * Constructing the class using one parameter allows you to specify a path to your own configuration
1699 * file, otherwise, inspircd.conf is read.
1701 class ConfigReader : public classbase
1704 /** The contents of the configuration file
1705 * This protected member should never be accessed by a module (and cannot be accessed unless the
1706 * core is changed). It will contain a pointer to the configuration file data with unneeded data
1707 * (such as comments) stripped from it.
1709 std::stringstream *cache;
1710 std::stringstream *errorlog;
1711 /** Used to store errors
1717 /** Default constructor.
1718 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1719 * as specified when running ./configure.
1721 ConfigReader(); // default constructor reads ircd.conf
1722 /** Overloaded constructor.
1723 * This constructor initialises the ConfigReader class to read a user-specified config file
1725 ConfigReader(std::string filename); // read a module-specific config
1726 /** Default destructor.
1727 * This method destroys the ConfigReader class.
1730 /** Retrieves a value from the config file.
1731 * This method retrieves a value from the config file. Where multiple copies of the tag
1732 * exist in the config file, index indicates which of the values to retrieve.
1734 std::string ReadValue(std::string tag, std::string name, int index);
1735 /** Retrieves a boolean value from the config file.
1736 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1737 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1738 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1740 bool ReadFlag(std::string tag, std::string name, int index);
1741 /** Retrieves an integer value from the config file.
1742 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1743 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1744 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1745 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1746 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1747 * will return CONF_NOT_UNSIGNED
1749 long ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned);
1750 /** Returns the last error to occur.
1751 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1752 * A call to GetError() resets the error flag back to 0.
1755 /** Counts the number of times a given tag appears in the config file.
1756 * This method counts the number of times a tag appears in a config file, for use where
1757 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1758 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1759 * multiple instance tag.
1761 int Enumerate(std::string tag);
1762 /** Returns true if a config file is valid.
1763 * This method is partially implemented and will only return false if the config
1764 * file does not exist or could not be opened.
1767 /** Dumps the list of errors in a config file to an output location. If bail is true,
1768 * then the program will abort. If bail is false and user points to a valid user
1769 * record, the error report will be spooled to the given user by means of NOTICE.
1770 * if bool is false AND user is false, the error report will be spooled to all opers
1771 * by means of a NOTICE to all opers.
1773 void DumpErrors(bool bail,userrec* user);
1775 /** Returns the number of items within a tag.
1776 * For example if the tag was <test tag="blah" data="foo"> then this
1777 * function would return 2. Spaces and newlines both qualify as valid seperators
1780 int EnumerateValues(std::string tag, int index);
1785 /** Caches a text file into memory and can be used to retrieve lines from it.
1786 * This class contains methods for read-only manipulation of a text file in memory.
1787 * Either use the constructor type with one parameter to load a file into memory
1788 * at construction, or use the LoadFile method to load a file.
1790 class FileReader : public classbase
1794 /** Default constructor.
1795 * This method does not load any file into memory, you must use the LoadFile method
1796 * after constructing the class this way.
1800 /** Secondary constructor.
1801 * This method initialises the class with a file loaded into it ready for GetLine and
1802 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1805 FileReader(std::string filename);
1807 /** Default destructor.
1808 * This deletes the memory allocated to the file.
1812 /** Used to load a file.
1813 * This method loads a file into the class ready for GetLine and
1814 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1817 void LoadFile(std::string filename);
1819 /** Returns true if the file exists
1820 * This function will return false if the file could not be opened.
1824 /** Retrieve one line from the file.
1825 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1826 * the index was out of bounds, or the line had no data on it.
1828 std::string GetLine(int x);
1830 /** Returns the size of the file in lines.
1831 * This method returns the number of lines in the read file. If it is 0, no lines have been
1832 * read into memory, either because the file is empty or it does not exist, or cannot be
1833 * opened due to permission problems.
1839 /** Instantiates classes inherited from Module
1840 * This class creates a class inherited from type Module, using new. This is to allow for modules
1841 * to create many different variants of Module, dependent on architecture, configuration, etc.
1842 * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
1845 class ModuleFactory : public classbase
1849 virtual ~ModuleFactory() { }
1850 /** Creates a new module.
1851 * Your inherited class of ModuleFactory must return a pointer to your Module class
1852 * using this method.
1854 virtual Module * CreateModule(Server* Me) = 0;
1858 typedef DLLFactory<ModuleFactory> ircd_module;
1860 bool ModeDefined(char c, int i);
1861 bool ModeDefinedOper(char c, int i);
1862 int ModeDefinedOn(char c, int i);
1863 int ModeDefinedOff(char c, int i);
1864 void ModeMakeList(char modechar);
1865 bool ModeIsListMode(char modechar, int type);