1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * Inspire is copyright (C) 2002-2004 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 * ---------------------------------------------------
29 // used with OnExtendedMode() method of modules
35 // used with OnAccessCheck() method of modules
37 #define ACR_DEFAULT 0 // Do default action (act as if the module isnt even loaded)
38 #define ACR_DENY 1 // deny the action
39 #define ACR_ALLOW 2 // allow the action
41 #define AC_KICK 0 // a user is being kicked
42 #define AC_DEOP 1 // a user is being deopped
43 #define AC_OP 2 // a user is being opped
44 #define AC_VOICE 3 // a user is being voiced
45 #define AC_DEVOICE 4 // a user is being devoiced
46 #define AC_HALFOP 5 // a user is being halfopped
47 #define AC_DEHALFOP 6 // a user is being dehalfopped
48 #define AC_INVITE 7 // a user is being invited
49 #define AC_GENERAL_MODE 8 // a user channel mode is being changed
58 /** Low level definition of a FileReader classes file cache area
60 typedef std::deque<std::string> file_cache;
61 typedef file_cache string_list;
63 /** Holds a list of users in a channel
65 typedef std::deque<userrec*> chanuserlist;
68 // This #define allows us to call a method in all
69 // loaded modules in a readable simple way, e.g.:
70 // 'FOREACH_MOD OnConnect(user);'
72 #define FOREACH_MOD for (int i = 0; i <= MODCOUNT; i++) modules[i]->
74 // This define is similar to the one above but returns a result in MOD_RESULT.
75 // The first module to return a nonzero result is the value to be accepted,
76 // and any modules after are ignored.
78 // *********************************************************************************************
80 #define FOREACH_RESULT(x) { MOD_RESULT = 0; \
81 for (int i = 0; i <= MODCOUNT; i++) { \
82 int res = modules[i]->x ; \
90 // *********************************************************************************************
92 extern void createcommand(char* cmd, handlerfunc f, char flags, int minparams);
93 extern void server_mode(char **parameters, int pcnt, userrec *user);
95 // class Version holds the version information of a Module, returned
96 // by Module::GetVersion (thanks RD)
98 /** Holds a module's Version information
99 * The four members (set by the constructor only) indicate details as to the version number
100 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
102 class Version : public classbase
105 const int Major, Minor, Revision, Build;
106 Version(int major, int minor, int revision, int build);
109 /** Holds /ADMIN data
110 * This class contains the admin details of the local server. It is constructed by class Server,
111 * and has three read-only values, Name, Email and Nick that contain the specified values for the
112 * server where the module is running.
114 class Admin : public classbase
117 const std::string Name, Email, Nick;
118 Admin(std::string name, std::string email, std::string nick);
121 /** Base class for all InspIRCd modules
122 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
123 * its methods will be called when irc server events occur. class inherited from module must be
124 * instantiated by the ModuleFactory class (see relevent section) for the plugin to be initialised.
126 class Module : public classbase
130 /** Default constructor
131 * creates a module class
135 /** Default destructor
136 * destroys a module class
140 /** Returns the version number of a Module.
141 * The method should return a Version object with its version information assigned via
144 virtual Version GetVersion();
146 /** Called when a user connects.
147 * The details of the connecting user are available to you in the parameter userrec *user
149 virtual void OnUserConnect(userrec* user);
151 /** Called when a user quits.
152 * The details of the exiting user are available to you in the parameter userrec *user
154 virtual void OnUserQuit(userrec* user);
156 /** Called when a user joins a channel.
157 * The details of the joining user are available to you in the parameter userrec *user,
158 * and the details of the channel they have joined is available in the variable chanrec *channel
160 virtual void OnUserJoin(userrec* user, chanrec* channel);
162 /** Called when a user parts a channel.
163 * The details of the leaving user are available to you in the parameter userrec *user,
164 * and the details of the channel they have left is available in the variable chanrec *channel
166 virtual void OnUserPart(userrec* user, chanrec* channel);
168 /** Called before a packet is transmitted across the irc network between two irc servers.
169 * The packet is represented as a char*, as it should be regarded as a buffer, and not a string.
170 * This allows you to easily represent it in the correct ways to implement encryption, compression,
171 * digital signatures and anything else you may want to add. This should be regarded as a pre-processor
172 * and will be called before ANY other operations within the ircd core program.
174 virtual void OnPacketTransmit(char *p);
176 /** Called after a packet is received from another irc server.
177 * The packet is represented as a char*, as it should be regarded as a buffer, and not a string.
178 * This allows you to easily represent it in the correct ways to implement encryption, compression,
179 * digital signatures and anything else you may want to add. This should be regarded as a pre-processor
180 * and will be called immediately after the packet is received but before any other operations with the
183 virtual void OnPacketReceive(char *p);
185 /** Called on rehash.
186 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
187 * system. You should use it to reload any files so that your module keeps in step with the
188 * rest of the application.
190 virtual void OnRehash();
192 /** Called when a raw command is transmitted or received.
193 * This method is the lowest level of handler available to a module. It will be called with raw
194 * data which is passing through a connected socket. If you wish, you may munge this data by changing
195 * the string parameter "raw". If you do this, after your function exits it will immediately be
196 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
197 * inbound is set to true) the value of user will be the userrec of the connection sending the
198 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
200 virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
202 /** Called whenever an extended mode is to be processed.
203 * The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being
204 * changed. mode_on is set when the mode is being set, in which case params contains a list of
205 * parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters
206 * may contain the parameters for the mode, dependent on wether they were defined when a mode handler
207 * was set up with Server::AddExtendedMode
208 * If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*.
209 * You must cast this value yourself to make use of it.
211 virtual int OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list ¶ms);
213 /** Called whenever a user is about to join a channel, before any processing is done.
214 * Returning a value of 1 from this function stops the process immediately, causing no
215 * output to be sent to the user by the core. If you do this you must produce your own numerics,
216 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
217 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
221 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
222 * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
223 * processing on the actual channel record at this point, however the channel NAME will still be passed in
224 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
226 virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname);
229 /** Called whenever a user opers locally.
230 * The userrec will contain the oper mode 'o' as this function is called after any modifications
231 * are made to the user's structure by the core.
233 virtual void OnOper(userrec* user);
235 /** Called whenever a user types /INFO.
236 * The userrec will contain the information of the user who typed the command. Modules may use this
237 * method to output their own credits in /INFO (which is the ircd's version of an about box).
238 * It is purposefully not possible to modify any info that has already been output, or halt the list.
239 * You must write a 371 numeric to the user, containing your info in the following format:
241 * <nick> :information here
243 virtual void OnInfo(userrec* user);
245 /** Called whenever a /WHOIS is performed on a local user.
246 * The source parameter contains the details of the user who issued the WHOIS command, and
247 * the dest parameter contains the information of the user they are whoising.
249 virtual void OnWhois(userrec* source, userrec* dest);
251 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
252 * Returning 1 from this function stops the process immediately, causing no
253 * output to be sent to the user by the core. If you do this you must produce your own numerics,
254 * notices etc. This is useful for modules which may want to filter invites to channels.
256 virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel);
258 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
259 * Returning any nonzero value from this function stops the process immediately, causing no
260 * output to be sent to the user by the core. If you do this you must produce your own numerics,
261 * notices etc. This is useful for modules which may want to filter or redirect messages.
262 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
263 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
264 * of where the message is destined to be sent.
266 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string text);
268 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
269 * Returning any nonzero value from this function stops the process immediately, causing no
270 * output to be sent to the user by the core. If you do this you must produce your own numerics,
271 * notices etc. This is useful for modules which may want to filter or redirect messages.
272 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
273 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
274 * of where the message is destined to be sent.
276 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string text);
278 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
279 * Please note that although you can see remote nickchanges through this function, you should
280 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
281 * check user->server before taking any action (including returning nonzero from the method).
282 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
283 * module to generate some meaninful output.
285 virtual int OnUserPreNick(userrec* user, std::string newnick);
287 /** Called before an action which requires a channel privilage check.
288 * This function is called before many functions which check a users status on a channel, for example
289 * before opping a user, deopping a user, kicking a user, etc.
290 * There are several values for access_type which indicate for what reason access is being checked.
292 * AC_KICK (0) - A user is being kicked<br>
293 * AC_DEOP (1) - a user is being deopped<br>
294 * AC_OP (2) - a user is being opped<br>
295 * AC_VOICE (3) - a user is being voiced<br>
296 * AC_DEVOICE (4) - a user is being devoiced<br>
297 * AC_HALFOP (5) - a user is being halfopped<br>
298 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
299 * AC_INVITE (7) - a user is being invited<br>
300 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
301 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
302 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
303 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
304 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
305 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
306 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
309 virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
310 /** Called during a netburst to sync user data.
311 * This is called during the netburst on a per-user basis. You should use this call to up any special
312 * user-related things which are implemented by your module, e.g. sending listmodes. You may return
313 * multiple commands in the string_list.
315 virtual string_list OnUserSync(userrec* user);
317 /** Called during a netburst to sync channel data.
318 * This is called during the netburst on a per-channel basis. You should use this call to up any special
319 * channel-related things which are implemented by your module, e.g. sending listmodes. You may return
320 * multiple commands in the string_list.
322 virtual string_list OnChannelSync(chanrec* chan);
326 /** Allows server output and query functions
327 * This class contains methods which allow a module to query the state of the irc server, and produce
328 * output to users and other servers. All modules should instantiate at least one copy of this class,
329 * and use its member functions to perform their tasks.
331 class Server : public classbase
334 /** Default constructor.
335 * Creates a Server object.
338 /** Default destructor.
339 * Destroys a Server object.
343 /** Sends text to all opers.
344 * This method sends a server notice to all opers with the usermode +s.
346 virtual void SendOpers(std::string s);
347 /** Writes a log string.
348 * This method writes a line of text to the log. If the level given is lower than the
349 * level given in the configuration, this command has no effect.
351 virtual void Log(int level, std::string s);
352 /** Sends a line of text down a TCP/IP socket.
353 * This method writes a line of text to an established socket, cutting it to 510 characters
354 * plus a carriage return and linefeed if required.
356 virtual void Send(int Socket, std::string s);
357 /** Sends text from the server to a socket.
358 * This method writes a line of text to an established socket, with the servername prepended
359 * as used by numerics (see RFC 1459)
361 virtual void SendServ(int Socket, std::string s);
362 /** Sends text from a user to a socket.
363 * This method writes a line of text to an established socket, with the given user's nick/ident
364 * /host combination prepended, as used in PRIVSG etc commands (see RFC 1459)
366 virtual void SendFrom(int Socket, userrec* User, std::string s);
367 /** Sends text from a user to another user.
368 * This method writes a line of text to a user, with a user's nick/ident
369 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459)
370 * If you specify NULL as the source, then the data will originate from the
371 * local server, e.g. instead of:
373 * :user!ident@host TEXT
375 * The format will become:
379 * Which is useful for numerics and server notices to single users, etc.
381 virtual void SendTo(userrec* Source, userrec* Dest, std::string s);
382 /** Sends text from a user to a channel (mulicast).
383 * This method writes a line of text to a channel, with the given user's nick/ident
384 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the
385 * IncludeSender flag is set, then the text is also sent back to the user from which
386 * it originated, as seen in MODE (see RFC 1459).
388 virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender);
389 /** Returns true if two users share a common channel.
390 * This method is used internally by the NICK and QUIT commands, and the Server::SendCommon
393 virtual bool CommonChannels(userrec* u1, userrec* u2);
394 /** Sends text from a user to one or more channels (mulicast).
395 * This method writes a line of text to all users which share a common channel with a given
396 * user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc
397 * commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent
398 * back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it
399 * is only sent to the other recipients, as seen in QUIT.
401 virtual void SendCommon(userrec* User, std::string text,bool IncludeSender);
402 /** Sends a WALLOPS message.
403 * This method writes a WALLOPS message to all users with the +w flag, originating from the
406 virtual void SendWallops(userrec* User, std::string text);
408 /** Returns true if a nick is valid.
409 * Nicks for unregistered connections will return false.
411 virtual bool IsNick(std::string nick);
412 /** Returns a count of the number of users on a channel.
413 * This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.
415 virtual int CountUsers(chanrec* c);
416 /** Attempts to look up a nick and return a pointer to it.
417 * This function will return NULL if the nick does not exist.
419 virtual userrec* FindNick(std::string nick);
420 /** Attempts to look up a channel and return a pointer to it.
421 * This function will return NULL if the channel does not exist.
423 virtual chanrec* FindChannel(std::string channel);
424 /** Attempts to look up a user's privilages on a channel.
425 * This function will return a string containing either @, %, +, or an empty string,
426 * representing the user's privilages upon the channel you specify.
428 virtual std::string ChanMode(userrec* User, chanrec* Chan);
429 /** Checks if a user is on a channel.
430 * This function will return true or false to indicate if user 'User' is on channel 'Chan'.
432 virtual bool IsOnChannel(userrec* User, chanrec* Chan);
433 /** Returns the server name of the server where the module is loaded.
435 virtual std::string GetServerName();
436 /** Returns the network name, global to all linked servers.
438 virtual std::string GetNetworkName();
439 /** Returns the information of the server as returned by the /ADMIN command.
440 * See the Admin class for further information of the return value. The members
441 * Admin::Nick, Admin::Email and Admin::Name contain the information for the
442 * server where the module is loaded.
444 virtual Admin GetAdmin();
445 /** Adds an extended mode letter which is parsed by a module.
446 * This allows modules to add extra mode letters, e.g. +x for hostcloak.
447 * the "type" parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to
448 * indicate wether the mode is a channel mode, a client mode, or a server mode.
449 * requires_oper is used with MT_CLIENT type modes only to indicate the mode can only
450 * be set or unset by an oper. If this is used for MT_CHANNEL type modes it is ignored.
451 * params_when_on is the number of modes to expect when the mode is turned on
452 * (for type MT_CHANNEL only), e.g. with mode +k, this would have a value of 1.
453 * the params_when_off value has a similar value to params_when_on, except it indicates
454 * the number of parameters to expect when the mode is disabled. Modes which act in a similar
455 * way to channel mode +l (e.g. require a parameter to enable, but not to disable) should
456 * use this parameter. The function returns false if the mode is unavailable, and will not
457 * attempt to allocate another character, as this will confuse users. This also means that
458 * as only one module can claim a specific mode character, the core does not need to keep track
459 * of which modules own which modes, which speeds up operation of the server. In this version,
460 * a mode can have at most one parameter, attempting to use more parameters will have undefined
463 virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off);
465 /** Adds an extended mode letter which is parsed by a module and handled in a list fashion.
466 * This call is used to implement modes like +q and +a. The characteristics of these modes are
469 * (1) They are ALWAYS on channels, not on users, therefore their type is MT_CHANNEL
471 * (2) They always take exactly one parameter when being added or removed
473 * (3) They can be set multiple times, usually on users in channels
475 * (4) The mode and its parameter are NOT stored in the channels modes structure
477 * It is down to the module handling the mode to maintain state and determine what 'items' (e.g. users,
478 * or a banlist) have the mode set on them, and process the modes at the correct times, e.g. during access
479 * checks on channels, etc. When the extended mode is triggered the OnExtendedMode method will be triggered
480 * as above. Note that the target you are given will be a channel, if for example your mode is set 'on a user'
481 * (in for example +a) you must use Server::Find to locate the user the mode is operating on.
482 * Your mode handler may return 1 to handle the mode AND tell the core to display the mode change, e.g.
483 * '+aaa one two three' in the case of the mode for 'two', or it may return -1 to 'eat' the mode change,
484 * so the above example would become '+aa one three' after processing.
486 virtual bool AddExtendedListMode(char modechar);
488 /** Adds a command to the command table.
489 * This allows modules to add extra commands into the command table. You must place a function within your
490 * module which is is of type handlerfunc:
492 * typedef void (handlerfunc) (char**, int, userrec*);
494 * void handle_kill(char **parameters, int pcnt, userrec *user)
496 * When the command is typed, the parameters will be placed into the parameters array (similar to argv) and
497 * the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters
498 * than the 'minparams' value you specified when creating the command. The *user parameter is the class of
499 * the user which caused the command to trigger, who will always have the flag you specified in 'flags' when
500 * creating the initial command. For example to create an oper only command create the commands with flags='o'.
502 virtual void AddCommand(char* cmd, handlerfunc f, char flags, int minparams);
504 /** Sends a servermode.
505 * you must format the parameters array with the target, modes and parameters for those modes.
511 * modes[0] = ChannelName;
515 * modes[2] = user->nick;
517 * Srv->SendMode(modes,3,user);
519 * The modes will originate from the server where the command was issued, however responses (e.g. numerics)
520 * will be sent to the user you provide as the third parameter.
521 * You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave
522 * your server in an unstable state!
525 virtual void SendMode(char **parameters, int pcnt, userrec *user);
527 /** Sends to all users matching a mode mask
528 * You must specify one or more usermodes as the first parameter. These can be RFC specified modes such as +i,
529 * or module provided modes, including ones provided by your own module.
530 * In the second parameter you must place a flag value which indicates wether the modes you have given will be
531 * logically ANDed or OR'ed. You may use one of either WM_AND or WM_OR.
532 * for example, if you were to use:
534 * Serv->SendToModeMask("xi", WM_OR, "m00");
536 * Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the
537 * user must have both modes set to receive the message.
539 virtual void SendToModeMask(std::string modes, int flags, std::string text);
541 /** Forces a user to join a channel.
542 * This is similar to svsjoin and can be used to implement redirection, etc.
543 * On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to.
544 * On failure, the result is NULL.
546 virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key);
548 /** Forces a user to part a channel.
549 * This is similar to svspart and can be used to implement redirection, etc.
550 * Although the return value of this function is a pointer to a channel record, the returned data is
551 * undefined and should not be read or written to. This behaviour may be changed in a future version.
553 virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason);
555 /** Forces a user nickchange.
556 * This command works similarly to SVSNICK, and can be used to implement Q-lines etc.
557 * If you specify an invalid nickname, the nick change will be dropped and the target user will receive
558 * the error numeric for it.
560 virtual void ChangeUserNick(userrec* user, std::string nickname);
562 /** Forces a user to quit with the specified reason.
563 * To the user, it will appear as if they typed /QUIT themselves, except for the fact that this function
564 * may bypass the quit prefix specified in the config file.
568 * Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or
569 * read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of
570 * action after calling this method is to immediately bail from your handler.
572 virtual void QuitUser(userrec* user, std::string reason);
574 /** Matches text against a glob pattern.
575 * Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com
576 * Returns true if the literal successfully matches the pattern, false if otherwise.
578 virtual bool MatchText(std::string sliteral, std::string spattern);
580 /** Calls the handler for a command, either implemented by the core or by another module.
581 * You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN,
582 * KICK etc, or even as a method of callback. By defining command names that are untypeable
583 * for users on irc (e.g. those which contain a \r or \n) you may use them as callback identifiers.
584 * The first parameter to this method is the name of the command handler you wish to call, e.g.
585 * PRIVMSG. This will be a command handler previously registered by the core or wih AddCommand().
586 * The second parameter is an array of parameters, and the third parameter is a count of parameters
587 * in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the
588 * functiom will silently ignore it. The final parameter is the user executing the command handler,
589 * used for privilage checks, etc.
591 virtual void CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user);
593 /** Change displayed hostname of a user.
594 * You should always call this method to change a user's host rather than writing directly to the
595 * dhost member of userrec, as any change applied via this method will be propogated to any
598 virtual void ChangeHost(userrec* user, std::string host);
600 /** Change GECOS (fullname) of a user.
601 * You should always call this method to change a user's GECOS rather than writing directly to the
602 * fullname member of userrec, as any change applied via this method will be propogated to any
605 virtual void ChangeGECOS(userrec* user, std::string gecos);
607 /** Returns true if the servername you give is ulined.
608 * ULined servers have extra privilages. They are allowed to change nicknames on remote servers,
609 * change modes of clients which are on remote servers and set modes of channels where there are
610 * no channel operators for that channel on the ulined server, amongst other things. Ulined server
611 * data is also broadcast across the mesh at all times as opposed to selectively messaged in the
612 * case of normal servers, as many ulined server types (such as services) do not support meshed
613 * links and must operate in this manner.
615 virtual bool IsUlined(std::string server);
617 /** Fetches the userlist of a channel. This function must be here and not a member of userrec or
618 * chanrec due to include constraints.
620 virtual chanuserlist GetUsers(chanrec* chan);
624 #define CONF_NOT_A_NUMBER 0x000010
625 #define CONF_NOT_UNSIGNED 0x000080
626 #define CONF_VALUE_NOT_FOUND 0x000100
627 #define CONF_FILE_NOT_FOUND 0x000200
629 /** Allows reading of values from configuration files
630 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
631 * a module-specified configuration file. It may either be instantiated with one parameter or none.
632 * Constructing the class using one parameter allows you to specify a path to your own configuration
633 * file, otherwise, inspircd.conf is read.
635 class ConfigReader : public classbase
638 /** The contents of the configuration file
639 * This protected member should never be accessed by a module (and cannot be accessed unless the
640 * core is changed). It will contain a pointer to the configuration file data with unneeded data
641 * (such as comments) stripped from it.
643 std::stringstream *cache;
644 /** Used to store errors
650 /** Default constructor.
651 * This constructor initialises the ConfigReader class to read the inspircd.conf file
652 * as specified when running ./configure.
654 ConfigReader(); // default constructor reads ircd.conf
655 /** Overloaded constructor.
656 * This constructor initialises the ConfigReader class to read a user-specified config file
658 ConfigReader(std::string filename); // read a module-specific config
659 /** Default destructor.
660 * This method destroys the ConfigReader class.
663 /** Retrieves a value from the config file.
664 * This method retrieves a value from the config file. Where multiple copies of the tag
665 * exist in the config file, index indicates which of the values to retrieve.
667 std::string ReadValue(std::string tag, std::string name, int index);
668 /** Retrieves a boolean value from the config file.
669 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
670 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
671 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
673 bool ReadFlag(std::string tag, std::string name, int index);
674 /** Retrieves an integer value from the config file.
675 * This method retrieves an integer value from the config file. Where multiple copies of the tag
676 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
677 * values in the tag will cause the objects error value to be set, and any call to GetError() will
678 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
679 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
680 * will return CONF_NOT_UNSIGNED
682 long ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned);
683 /** Returns the last error to occur.
684 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
685 * A call to GetError() resets the error flag back to 0.
688 /** Counts the number of times a given tag appears in the config file.
689 * This method counts the number of times a tag appears in a config file, for use where
690 * there are several tags of the same kind, e.g. with opers and connect types. It can be
691 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
692 * multiple instance tag.
694 int Enumerate(std::string tag);
695 /** Returns true if a config file is valid.
696 * This method is partially implemented and will only return false if the config
697 * file does not exist or could not be opened.
701 /** Returns the number of items within a tag.
702 * For example if the tag was <test tag="blah" data="foo"> then this
703 * function would return 2. Spaces and newlines both qualify as valid seperators
706 int EnumerateValues(std::string tag, int index);
711 /** Caches a text file into memory and can be used to retrieve lines from it.
712 * This class contains methods for read-only manipulation of a text file in memory.
713 * Either use the constructor type with one parameter to load a file into memory
714 * at construction, or use the LoadFile method to load a file.
716 class FileReader : public classbase
720 /** Default constructor.
721 * This method does not load any file into memory, you must use the LoadFile method
722 * after constructing the class this way.
726 /** Secondary constructor.
727 * This method initialises the class with a file loaded into it ready for GetLine and
728 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
731 FileReader(std::string filename);
733 /** Default destructor.
734 * This deletes the memory allocated to the file.
738 /** Used to load a file.
739 * This method loads a file into the class ready for GetLine and
740 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
743 void LoadFile(std::string filename);
745 /** Returns true if the file exists
746 * This function will return false if the file could not be opened.
750 /** Retrieve one line from the file.
751 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
752 * the index was out of bounds, or the line had no data on it.
754 std::string GetLine(int x);
756 /** Returns the size of the file in lines.
757 * This method returns the number of lines in the read file. If it is 0, no lines have been
758 * read into memory, either because the file is empty or it does not exist, or cannot be
759 * opened due to permission problems.
765 /** Instantiates classes inherited from Module
766 * This class creates a class inherited from type Module, using new. This is to allow for modules
767 * to create many different variants of Module, dependent on architecture, configuration, etc.
768 * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
771 class ModuleFactory : public classbase
775 virtual ~ModuleFactory() { }
776 /** Creates a new module.
777 * Your inherited class of ModuleFactory must return a pointer to your Module class
780 virtual Module * CreateModule() = 0;
784 typedef DLLFactory<ModuleFactory> ircd_module;