19 // used with OnExtendedMode() method of modules
25 // used with OnAccessCheck() method of modules
27 #define ACR_DEFAULT 0 // Do default action (act as if the module isnt even loaded)
28 #define ACR_DENY 1 // deny the action
29 #define ACR_ALLOW 2 // allow the action
31 #define AC_KICK 0 // a user is being kicked
32 #define AC_DEOP 1 // a user is being deopped
33 #define AC_OP 2 // a user is being opped
34 #define AC_VOICE 3 // a user is being voiced
35 #define AC_DEVOICE 4 // a user is being devoiced
36 #define AC_HALFOP 5 // a user is being halfopped
37 #define AC_DEHALFOP 6 // a user is being dehalfopped
38 #define AC_INVITE 7 // a user is being invited
39 #define AC_GENERAL_MODE 8 // a user channel mode is being changed
48 /** Low level definition of a FileReader classes file cache area
50 typedef std::deque<std::string> file_cache;
51 typedef file_cache string_list;
53 /** Holds a list of users in a channel
55 typedef std::deque<userrec*> chanuserlist;
58 // This #define allows us to call a method in all
59 // loaded modules in a readable simple way, e.g.:
60 // 'FOREACH_MOD OnConnect(user);'
62 #define FOREACH_MOD for (int i = 0; i <= MODCOUNT; i++) modules[i]->
64 // This define is similar to the one above but returns a result in MOD_RESULT.
65 // The first module to return a nonzero result is the value to be accepted,
66 // and any modules after are ignored.
68 // *********************************************************************************************
70 #define FOREACH_RESULT(x) { MOD_RESULT = 0; \
71 for (int i = 0; i <= MODCOUNT; i++) { \
72 int res = modules[i]->x ; \
80 // *********************************************************************************************
82 extern void createcommand(char* cmd, handlerfunc f, char flags, int minparams);
83 extern void server_mode(char **parameters, int pcnt, userrec *user);
85 // class Version holds the version information of a Module, returned
86 // by Module::GetVersion (thanks RD)
88 /** Holds a module's Version information
89 * The four members (set by the constructor only) indicate details as to the version number
90 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
92 class Version : public classbase
95 const int Major, Minor, Revision, Build;
96 Version(int major, int minor, int revision, int build);
100 * This class contains the admin details of the local server. It is constructed by class Server,
101 * and has three read-only values, Name, Email and Nick that contain the specified values for the
102 * server where the module is running.
104 class Admin : public classbase
107 const std::string Name, Email, Nick;
108 Admin(std::string name, std::string email, std::string nick);
111 /** Base class for all InspIRCd modules
112 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
113 * its methods will be called when irc server events occur. class inherited from module must be
114 * instantiated by the ModuleFactory class (see relevent section) for the plugin to be initialised.
116 class Module : public classbase
120 /** Default constructor
121 * creates a module class
125 /** Default destructor
126 * destroys a module class
130 /** Returns the version number of a Module.
131 * The method should return a Version object with its version information assigned via
134 virtual Version GetVersion();
136 /** Called when a user connects.
137 * The details of the connecting user are available to you in the parameter userrec *user
139 virtual void OnUserConnect(userrec* user);
141 /** Called when a user quits.
142 * The details of the exiting user are available to you in the parameter userrec *user
144 virtual void OnUserQuit(userrec* user);
146 /** Called when a user joins a channel.
147 * The details of the joining user are available to you in the parameter userrec *user,
148 * and the details of the channel they have joined is available in the variable chanrec *channel
150 virtual void OnUserJoin(userrec* user, chanrec* channel);
152 /** Called when a user parts a channel.
153 * The details of the leaving user are available to you in the parameter userrec *user,
154 * and the details of the channel they have left is available in the variable chanrec *channel
156 virtual void OnUserPart(userrec* user, chanrec* channel);
158 /** Called before a packet is transmitted across the irc network between two irc servers.
159 * The packet is represented as a char*, as it should be regarded as a buffer, and not a string.
160 * This allows you to easily represent it in the correct ways to implement encryption, compression,
161 * digital signatures and anything else you may want to add. This should be regarded as a pre-processor
162 * and will be called before ANY other operations within the ircd core program.
164 virtual void OnPacketTransmit(char *p);
166 /** Called after a packet is received from another irc server.
167 * The packet is represented as a char*, as it should be regarded as a buffer, and not a string.
168 * This allows you to easily represent it in the correct ways to implement encryption, compression,
169 * digital signatures and anything else you may want to add. This should be regarded as a pre-processor
170 * and will be called immediately after the packet is received but before any other operations with the
173 virtual void OnPacketReceive(char *p);
175 /** Called on rehash.
176 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
177 * system. You should use it to reload any files so that your module keeps in step with the
178 * rest of the application.
180 virtual void OnRehash();
182 /** Called when a raw command is transmitted or received.
183 * This method is the lowest level of handler available to a module. It will be called with raw
184 * data which is passing through a connected socket. If you wish, you may munge this data by changing
185 * the string parameter "raw". If you do this, after your function exits it will immediately be
186 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
187 * inbound is set to true) the value of user will be the userrec of the connection sending the
188 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
190 virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
192 /** Called whenever an extended mode is to be processed.
193 * The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being
194 * changed. mode_on is set when the mode is being set, in which case params contains a list of
195 * parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters
196 * may contain the parameters for the mode, dependent on wether they were defined when a mode handler
197 * was set up with Server::AddExtendedMode
198 * If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*.
199 * You must cast this value yourself to make use of it.
201 virtual int OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list ¶ms);
203 /** Called whenever a user is about to join a channel, before any processing is done.
204 * Returning any nonzero value from this function stops the process immediately, causing no
205 * output to be sent to the user by the core. If you do this you must produce your own numerics,
206 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc.
210 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
211 * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
212 * processing on the actual channel record at this point, however the channel NAME will still be passed in
213 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
215 virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname);
218 /** Called whenever a user opers locally.
219 * The userrec will contain the oper mode 'o' as this function is called after any modifications
220 * are made to the user's structure by the core.
222 virtual void OnOper(userrec* user);
224 /** Called whenever a user types /INFO.
225 * The userrec will contain the information of the user who typed the command. Modules may use this
226 * method to output their own credits in /INFO (which is the ircd's version of an about box).
227 * It is purposefully not possible to modify any info that has already been output, or halt the list.
228 * You must write a 371 numeric to the user, containing your info in the following format:
230 * <nick> :information here
232 virtual void OnInfo(userrec* user);
234 /** Called whenever a /WHOIS is performed on a local user.
235 * The source parameter contains the details of the user who issued the WHOIS command, and
236 * the dest parameter contains the information of the user they are whoising.
238 virtual void OnWhois(userrec* source, userrec* dest);
240 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
241 * Returning any nonzero value from this function stops the process immediately, causing no
242 * output to be sent to the user by the core. If you do this you must produce your own numerics,
243 * notices etc. This is useful for modules which may want to filter or redirect messages.
244 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
245 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
246 * of where the message is destined to be sent.
248 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string text);
250 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
251 * Returning any nonzero value from this function stops the process immediately, causing no
252 * output to be sent to the user by the core. If you do this you must produce your own numerics,
253 * notices etc. This is useful for modules which may want to filter or redirect messages.
254 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
255 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
256 * of where the message is destined to be sent.
258 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string text);
260 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
261 * Please note that although you can see remote nickchanges through this function, you should
262 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
263 * check user->server before taking any action (including returning nonzero from the method).
264 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
265 * module to generate some meaninful output.
267 virtual int OnUserPreNick(userrec* user, std::string newnick);
269 /** Called before an action which requires a channel privilage check.
270 * This function is called before many functions which check a users status on a channel, for example
271 * before opping a user, deopping a user, kicking a user, etc.
272 * There are several values for access_type which indicate for what reason access is being checked.
274 * AC_KICK (0) - A user is being kicked<br>
275 * AC_DEOP (1) - a user is being deopped<br>
276 * AC_OP (2) - a user is being opped<br>
277 * AC_VOICE (3) - a user is being voiced<br>
278 * AC_DEVOICE (4) - a user is being devoiced<br>
279 * AC_HALFOP (5) - a user is being halfopped<br>
280 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
281 * AC_INVITE (7) - a user is being invited<br>
282 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
283 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
284 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
285 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
286 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
287 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
288 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
291 virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
292 /** Called during a netburst to sync user data.
293 * This is called during the netburst on a per-user basis. You should use this call to up any special
294 * user-related things which are implemented by your module, e.g. sending listmodes. You may return
295 * multiple commands in the string_list.
297 virtual string_list OnUserSync(userrec* user);
299 /** Called during a netburst to sync channel data.
300 * This is called during the netburst on a per-channel basis. You should use this call to up any special
301 * channel-related things which are implemented by your module, e.g. sending listmodes. You may return
302 * multiple commands in the string_list.
304 virtual string_list OnChannelSync(chanrec* chan);
308 /** Allows server output and query functions
309 * This class contains methods which allow a module to query the state of the irc server, and produce
310 * output to users and other servers. All modules should instantiate at least one copy of this class,
311 * and use its member functions to perform their tasks.
313 class Server : public classbase
316 /** Default constructor.
317 * Creates a Server object.
320 /** Default destructor.
321 * Destroys a Server object.
325 /** Sends text to all opers.
326 * This method sends a server notice to all opers with the usermode +s.
328 virtual void SendOpers(std::string s);
329 /** Writes a log string.
330 * This method writes a line of text to the log. If the level given is lower than the
331 * level given in the configuration, this command has no effect.
333 virtual void Log(int level, std::string s);
334 /** Sends a line of text down a TCP/IP socket.
335 * This method writes a line of text to an established socket, cutting it to 510 characters
336 * plus a carriage return and linefeed if required.
338 virtual void Send(int Socket, std::string s);
339 /** Sends text from the server to a socket.
340 * This method writes a line of text to an established socket, with the servername prepended
341 * as used by numerics (see RFC 1459)
343 virtual void SendServ(int Socket, std::string s);
344 /** Sends text from a user to a socket.
345 * This method writes a line of text to an established socket, with the given user's nick/ident
346 * /host combination prepended, as used in PRIVSG etc commands (see RFC 1459)
348 virtual void SendFrom(int Socket, userrec* User, std::string s);
349 /** Sends text from a user to another user.
350 * This method writes a line of text to a user, with a user's nick/ident
351 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459)
352 * If you specify NULL as the source, then the data will originate from the
353 * local server, e.g. instead of:
355 * :user!ident@host TEXT
357 * The format will become:
361 * Which is useful for numerics and server notices to single users, etc.
363 virtual void SendTo(userrec* Source, userrec* Dest, std::string s);
364 /** Sends text from a user to a channel (mulicast).
365 * This method writes a line of text to a channel, with the given user's nick/ident
366 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the
367 * IncludeSender flag is set, then the text is also sent back to the user from which
368 * it originated, as seen in MODE (see RFC 1459).
370 virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender);
371 /** Returns true if two users share a common channel.
372 * This method is used internally by the NICK and QUIT commands, and the Server::SendCommon
375 virtual bool CommonChannels(userrec* u1, userrec* u2);
376 /** Sends text from a user to one or more channels (mulicast).
377 * This method writes a line of text to all users which share a common channel with a given
378 * user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc
379 * commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent
380 * back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it
381 * is only sent to the other recipients, as seen in QUIT.
383 virtual void SendCommon(userrec* User, std::string text,bool IncludeSender);
384 /** Sends a WALLOPS message.
385 * This method writes a WALLOPS message to all users with the +w flag, originating from the
388 virtual void SendWallops(userrec* User, std::string text);
390 /** Returns true if a nick is valid.
391 * Nicks for unregistered connections will return false.
393 virtual bool IsNick(std::string nick);
394 /** Returns a count of the number of users on a channel.
395 * This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.
397 virtual int CountUsers(chanrec* c);
398 /** Attempts to look up a nick and return a pointer to it.
399 * This function will return NULL if the nick does not exist.
401 virtual userrec* FindNick(std::string nick);
402 /** Attempts to look up a channel and return a pointer to it.
403 * This function will return NULL if the channel does not exist.
405 virtual chanrec* FindChannel(std::string channel);
406 /** Attempts to look up a user's privilages on a channel.
407 * This function will return a string containing either @, %, +, or an empty string,
408 * representing the user's privilages upon the channel you specify.
410 virtual std::string ChanMode(userrec* User, chanrec* Chan);
411 /** Checks if a user is on a channel.
412 * This function will return true or false to indicate if user 'User' is on channel 'Chan'.
414 virtual bool IsOnChannel(userrec* User, chanrec* Chan);
415 /** Returns the server name of the server where the module is loaded.
417 virtual std::string GetServerName();
418 /** Returns the network name, global to all linked servers.
420 virtual std::string GetNetworkName();
421 /** Returns the information of the server as returned by the /ADMIN command.
422 * See the Admin class for further information of the return value. The members
423 * Admin::Nick, Admin::Email and Admin::Name contain the information for the
424 * server where the module is loaded.
426 virtual Admin GetAdmin();
427 /** Adds an extended mode letter which is parsed by a module.
428 * This allows modules to add extra mode letters, e.g. +x for hostcloak.
429 * the "type" parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to
430 * indicate wether the mode is a channel mode, a client mode, or a server mode.
431 * requires_oper is used with MT_CLIENT type modes only to indicate the mode can only
432 * be set or unset by an oper. If this is used for MT_CHANNEL type modes it is ignored.
433 * params_when_on is the number of modes to expect when the mode is turned on
434 * (for type MT_CHANNEL only), e.g. with mode +k, this would have a value of 1.
435 * the params_when_off value has a similar value to params_when_on, except it indicates
436 * the number of parameters to expect when the mode is disabled. Modes which act in a similar
437 * way to channel mode +l (e.g. require a parameter to enable, but not to disable) should
438 * use this parameter. The function returns false if the mode is unavailable, and will not
439 * attempt to allocate another character, as this will confuse users. This also means that
440 * as only one module can claim a specific mode character, the core does not need to keep track
441 * of which modules own which modes, which speeds up operation of the server. In this version,
442 * a mode can have at most one parameter, attempting to use more parameters will have undefined
445 virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off);
447 /** Adds an extended mode letter which is parsed by a module and handled in a list fashion.
448 * This call is used to implement modes like +q and +a. The characteristics of these modes are
451 * (1) They are ALWAYS on channels, not on users, therefore their type is MT_CHANNEL
453 * (2) They always take exactly one parameter when being added or removed
455 * (3) They can be set multiple times, usually on users in channels
457 * (4) The mode and its parameter are NOT stored in the channels modes structure
459 * It is down to the module handling the mode to maintain state and determine what 'items' (e.g. users,
460 * or a banlist) have the mode set on them, and process the modes at the correct times, e.g. during access
461 * checks on channels, etc. When the extended mode is triggered the OnExtendedMode method will be triggered
462 * as above. Note that the target you are given will be a channel, if for example your mode is set 'on a user'
463 * (in for example +a) you must use Server::Find to locate the user the mode is operating on.
464 * Your mode handler may return 1 to handle the mode AND tell the core to display the mode change, e.g.
465 * '+aaa one two three' in the case of the mode for 'two', or it may return -1 to 'eat' the mode change,
466 * so the above example would become '+aa one three' after processing.
468 virtual bool AddExtendedListMode(char modechar);
470 /** Adds a command to the command table.
471 * This allows modules to add extra commands into the command table. You must place a function within your
472 * module which is is of type handlerfunc:
474 * typedef void (handlerfunc) (char**, int, userrec*);
476 * void handle_kill(char **parameters, int pcnt, userrec *user)
478 * When the command is typed, the parameters will be placed into the parameters array (similar to argv) and
479 * the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters
480 * than the 'minparams' value you specified when creating the command. The *user parameter is the class of
481 * the user which caused the command to trigger, who will always have the flag you specified in 'flags' when
482 * creating the initial command. For example to create an oper only command create the commands with flags='o'.
484 virtual void AddCommand(char* cmd, handlerfunc f, char flags, int minparams);
486 /** Sends a servermode.
487 * you must format the parameters array with the target, modes and parameters for those modes.
493 * modes[0] = ChannelName;
497 * modes[2] = user->nick;
499 * Srv->SendMode(modes,3,user);
501 * The modes will originate from the server where the command was issued, however responses (e.g. numerics)
502 * will be sent to the user you provide as the third parameter.
503 * You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave
504 * your server in an unstable state!
507 virtual void SendMode(char **parameters, int pcnt, userrec *user);
509 /** Sends to all users matching a mode mask
510 * You must specify one or more usermodes as the first parameter. These can be RFC specified modes such as +i,
511 * or module provided modes, including ones provided by your own module.
512 * In the second parameter you must place a flag value which indicates wether the modes you have given will be
513 * logically ANDed or OR'ed. You may use one of either WM_AND or WM_OR.
514 * for example, if you were to use:
516 * Serv->SendToModeMask("xi", WM_OR, "m00");
518 * Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the
519 * user must have both modes set to receive the message.
521 virtual void SendToModeMask(std::string modes, int flags, std::string text);
523 /** Forces a user to join a channel.
524 * This is similar to svsjoin and can be used to implement redirection, etc.
525 * On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to.
526 * On failure, the result is NULL.
528 virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key);
530 /** Forces a user to part a channel.
531 * This is similar to svspart and can be used to implement redirection, etc.
532 * Although the return value of this function is a pointer to a channel record, the returned data is
533 * undefined and should not be read or written to. This behaviour may be changed in a future version.
535 virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason);
537 /** Forces a user nickchange.
538 * This command works similarly to SVSNICK, and can be used to implement Q-lines etc.
539 * If you specify an invalid nickname, the nick change will be dropped and the target user will receive
540 * the error numeric for it.
542 virtual void ChangeUserNick(userrec* user, std::string nickname);
544 /** Forces a user to quit with the specified reason.
545 * To the user, it will appear as if they typed /QUIT themselves, except for the fact that this function
546 * may bypass the quit prefix specified in the config file.
550 * Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or
551 * read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of
552 * action after calling this method is to immediately bail from your handler.
554 virtual void QuitUser(userrec* user, std::string reason);
556 /** Matches text against a glob pattern.
557 * Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com
558 * Returns true if the literal successfully matches the pattern, false if otherwise.
560 virtual bool MatchText(std::string sliteral, std::string spattern);
562 /** Calls the handler for a command, either implemented by the core or by another module.
563 * You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN,
564 * KICK etc, or even as a method of callback. By defining command names that are untypeable
565 * for users on irc (e.g. those which contain a \r or \n) you may use them as callback identifiers.
566 * The first parameter to this method is the name of the command handler you wish to call, e.g.
567 * PRIVMSG. This will be a command handler previously registered by the core or wih AddCommand().
568 * The second parameter is an array of parameters, and the third parameter is a count of parameters
569 * in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the
570 * functiom will silently ignore it. The final parameter is the user executing the command handler,
571 * used for privilage checks, etc.
573 virtual void CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user);
575 /** Change displayed hostname of a user.
576 * You should always call this method to change a user's host rather than writing directly to the
577 * dhost member of userrec, as any change applied via this method will be propogated to any
580 virtual void ChangeHost(userrec* user, std::string host);
582 /** Change GECOS (fullname) of a user.
583 * You should always call this method to change a user's GECOS rather than writing directly to the
584 * fullname member of userrec, as any change applied via this method will be propogated to any
587 virtual void ChangeGECOS(userrec* user, std::string gecos);
589 /** Returns true if the servername you give is ulined.
590 * ULined servers have extra privilages. They are allowed to change nicknames on remote servers,
591 * change modes of clients which are on remote servers and set modes of channels where there are
592 * no channel operators for that channel on the ulined server, amongst other things. Ulined server
593 * data is also broadcast across the mesh at all times as opposed to selectively messaged in the
594 * case of normal servers, as many ulined server types (such as services) do not support meshed
595 * links and must operate in this manner.
597 virtual bool IsUlined(std::string server);
599 /** Fetches the userlist of a channel. This function must be here and not a member of userrec or
600 * chanrec due to include constraints.
602 virtual chanuserlist GetUsers(chanrec* chan);
606 #define CONF_NOT_A_NUMBER 0x000010
607 #define CONF_NOT_UNSIGNED 0x000080
608 #define CONF_VALUE_NOT_FOUND 0x000100
609 #define CONF_FILE_NOT_FOUND 0x000200
611 /** Allows reading of values from configuration files
612 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
613 * a module-specified configuration file. It may either be instantiated with one parameter or none.
614 * Constructing the class using one parameter allows you to specify a path to your own configuration
615 * file, otherwise, inspircd.conf is read.
617 class ConfigReader : public classbase
620 /** The contents of the configuration file
621 * This protected member should never be accessed by a module (and cannot be accessed unless the
622 * core is changed). It will contain a pointer to the configuration file data with unneeded data
623 * (such as comments) stripped from it.
625 std::stringstream *cache;
626 /** Used to store errors
632 /** Default constructor.
633 * This constructor initialises the ConfigReader class to read the inspircd.conf file
634 * as specified when running ./configure.
636 ConfigReader(); // default constructor reads ircd.conf
637 /** Overloaded constructor.
638 * This constructor initialises the ConfigReader class to read a user-specified config file
640 ConfigReader(std::string filename); // read a module-specific config
641 /** Default destructor.
642 * This method destroys the ConfigReader class.
645 /** Retrieves a value from the config file.
646 * This method retrieves a value from the config file. Where multiple copies of the tag
647 * exist in the config file, index indicates which of the values to retrieve.
649 std::string ReadValue(std::string tag, std::string name, int index);
650 /** Retrieves a boolean value from the config file.
651 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
652 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
653 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
655 bool ReadFlag(std::string tag, std::string name, int index);
656 /** Retrieves an integer value from the config file.
657 * This method retrieves an integer value from the config file. Where multiple copies of the tag
658 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
659 * values in the tag will cause the objects error value to be set, and any call to GetError() will
660 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
661 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
662 * will return CONF_NOT_UNSIGNED
664 long ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned);
665 /** Returns the last error to occur.
666 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
667 * A call to GetError() resets the error flag back to 0.
670 /** Counts the number of times a given tag appears in the config file.
671 * This method counts the number of times a tag appears in a config file, for use where
672 * there are several tags of the same kind, e.g. with opers and connect types. It can be
673 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
674 * multiple instance tag.
676 int Enumerate(std::string tag);
677 /** Returns true if a config file is valid.
678 * This method is partially implemented and will only return false if the config
679 * file does not exist or could not be opened.
683 /** Returns the number of items within a tag.
684 * For example if the tag was <test tag="blah" data="foo"> then this
685 * function would return 2. Spaces and newlines both qualify as valid seperators
688 int EnumerateValues(std::string tag, int index);
693 /** Caches a text file into memory and can be used to retrieve lines from it.
694 * This class contains methods for read-only manipulation of a text file in memory.
695 * Either use the constructor type with one parameter to load a file into memory
696 * at construction, or use the LoadFile method to load a file.
698 class FileReader : public classbase
702 /** Default constructor.
703 * This method does not load any file into memory, you must use the LoadFile method
704 * after constructing the class this way.
708 /** Secondary constructor.
709 * This method initialises the class with a file loaded into it ready for GetLine and
710 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
713 FileReader(std::string filename);
715 /** Default destructor.
716 * This deletes the memory allocated to the file.
720 /** Used to load a file.
721 * This method loads a file into the class ready for GetLine and
722 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
725 void LoadFile(std::string filename);
727 /** Returns true if the file exists
728 * This function will return false if the file could not be opened.
732 /** Retrieve one line from the file.
733 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
734 * the index was out of bounds, or the line had no data on it.
736 std::string GetLine(int x);
738 /** Returns the size of the file in lines.
739 * This method returns the number of lines in the read file. If it is 0, no lines have been
740 * read into memory, either because the file is empty or it does not exist, or cannot be
741 * opened due to permission problems.
747 /** Instantiates classes inherited from Module
748 * This class creates a class inherited from type Module, using new. This is to allow for modules
749 * to create many different variants of Module, dependent on architecture, configuration, etc.
750 * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
753 class ModuleFactory : public classbase
757 virtual ~ModuleFactory() { }
758 /** Creates a new module.
759 * Your inherited class of ModuleFactory must return a pointer to your Module class
762 virtual Module * CreateModule() = 0;
766 typedef DLLFactory<ModuleFactory> ircd_module;