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>
11 * Written by Craig Edwards, Craig McLure, and others.
12 * This program is free but copyrighted software; see
13 * the file COPYING for details.
15 * ---------------------------------------------------
18 #ifndef INSPIRCD_CONFIGREADER
19 #define INSPIRCD_CONFIGREADER
28 #include "socketengine.h"
34 /** A callback for validating a single value
36 typedef bool (*Validator)(ServerConfig* conf, const char*, const char*, void*);
37 /** A callback for validating multiple value entries
39 typedef bool (*MultiValidator)(ServerConfig* conf, const char*, char**, void**, int*);
40 /** A callback indicating the end of a group of entries
42 typedef bool (*MultiNotify)(ServerConfig* conf, const char*);
44 /** Types of data in the core config
46 enum ConfigDataType { DT_NOTHING, DT_INTEGER, DT_CHARPTR, DT_BOOLEAN };
48 /** Holds a core configuration item and its callbacks
55 ConfigDataType datatype;
56 Validator validation_function;
59 /** Holds a core configuration item and its callbacks
60 * where there may be more than one item
67 MultiNotify init_function;
68 MultiValidator validation_function;
69 MultiNotify finish_function;
72 /** A set of oper types
74 typedef std::map<irc::string,char*> opertype_t;
76 /** A Set of oper classes
78 typedef std::map<irc::string,char*> operclass_t;
81 /** This class holds the bulk of the runtime configuration for the ircd.
82 * It allows for reading new config values, accessing configuration files,
83 * and storage of the configuration data needed to run the ircd, such as
84 * the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
86 class ServerConfig : public Extensible
91 InspIRCd* ServerInstance;
93 /** This variable holds the names of all
94 * files included from the main one. This
95 * is used to make sure that no files are
96 * recursively included.
98 std::vector<std::string> include_stack;
100 /** This private method processes one line of
101 * configutation, appending errors to errorstream
102 * and setting error if an error has occured.
104 bool ParseLine(ConfigDataHash &target, std::string &line, long linenumber, std::ostringstream &errorstream);
106 /** Process an include directive
108 bool DoInclude(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream);
110 /** Check that there is only one of each configuration item
112 bool CheckOnce(char* tag, bool bail, userrec* user);
116 InspIRCd* GetInstance();
119 /** All oper class definitions from the config file
121 operclass_t operclass;
123 /** This holds all the information in the config file,
124 * it's indexed by tag name to a vector of key/values.
126 ConfigDataHash config_data;
128 /* All oper type definitions from the config file
130 opertype_t opertypes;
132 /** Holds the server name of the local server
133 * as defined by the administrator.
135 char ServerName[MAXBUF];
137 /* Holds the network name the local server
138 * belongs to. This is an arbitary field defined
139 * by the administrator.
141 char Network[MAXBUF];
143 /** Holds the description of the local server
144 * as defined by the administrator.
146 char ServerDesc[MAXBUF];
148 /** Holds the admin's name, for output in
149 * the /ADMIN command.
151 char AdminName[MAXBUF];
153 /** Holds the email address of the admin,
154 * for output in the /ADMIN command.
156 char AdminEmail[MAXBUF];
158 /** Holds the admin's nickname, for output
159 * in the /ADMIN command
161 char AdminNick[MAXBUF];
163 /** The admin-configured /DIE password
165 char diepass[MAXBUF];
167 /** The admin-configured /RESTART password
169 char restartpass[MAXBUF];
171 /** The pathname and filename of the message of the
172 * day file, as defined by the administrator.
176 /** The pathname and filename of the rules file,
177 * as defined by the administrator.
181 /** The quit prefix in use, or an empty string
183 char PrefixQuit[MAXBUF];
185 /** The last string found within a <die> tag, or
188 char DieValue[MAXBUF];
190 /** The DNS server to use for DNS queries
192 char DNSServer[MAXBUF];
194 /** This variable contains a space-seperated list
195 * of commands which are disabled by the
196 * administrator of the server for non-opers.
198 char DisabledCommands[MAXBUF];
200 /** The full path to the modules directory.
201 * This is either set at compile time, or
202 * overridden in the configuration file via
207 /** The temporary directory where modules are copied
211 /** The full pathname to the executable, as
212 * given in argv[0] when the program starts.
214 char MyExecutable[1024];
216 /** The file handle of the logfile. If this
217 * value is NULL, the log file is not open,
218 * probably due to a permissions error on
219 * startup (this should not happen in normal
224 /** If this value is true, the owner of the
225 * server specified -nofork on the command
226 * line, causing the daemon to stay in the
231 /** If this value if true then all log
232 * messages will be output, regardless of
233 * the level given in the config file.
234 * This is set with the -debug commandline
239 /** If this is true then log output will be
240 * written to the logfile. This is the default.
241 * If you put -nolog on the commandline then
242 * the logfile will not be written.
243 * This is meant to be used in conjunction with
244 * -debug for debugging without filling up the
249 /** If this value is true, halfops have been
250 * enabled in the configuration file.
254 /** The number of seconds the DNS subsystem
255 * will wait before timing out any request.
259 /** The size of the read() buffer in the user
260 * handling code, used to read data into a user's
265 /** The value to be used for listen() backlogs
270 /** The soft limit value assigned to the irc server.
271 * The IRC server will not allow more than this
272 * number of local users.
274 unsigned int SoftLimit;
276 /** Maximum number of targets for a multi target command
277 * such as PRIVMSG or KICK
279 unsigned int MaxTargets;
281 /** The maximum number of /WHO results allowed
282 * in any single /WHO command.
286 /** True if the DEBUG loglevel is selected.
290 /** The loglevel in use by the IRC server
294 /** How many seconds to wait before exiting
295 * the program when /DIE is correctly issued.
299 /** True if we're going to hide netsplits as *.net *.split for non-opers
303 /** True if we're going to hide ban reasons for non-opers (e.g. G-Lines,
308 /** If this is enabled then operators will
309 * see invisible (+i) channels in /whois.
313 /** Set to a non-empty string to obfuscate the server name of users in WHOIS
315 char HideWhoisServer[MAXBUF];
317 /** A list of IP addresses the server is listening
320 char addrs[MAXBUF][255];
322 /** The MOTD file, cached in a file_cache type.
326 /** The RULES file, cached in a file_cache type.
330 /** The full pathname and filename of the PID
331 * file as defined in the configuration.
335 /** The connect classes in use by the IRC server.
339 /** A list of module names (names only, no paths)
340 * which are currently loaded by the server.
342 std::vector<std::string> module_names;
344 /** A list of ports which the server is listening on
348 /** A list of the file descriptors for the listening client ports
350 ListenSocket* openSockfd[255];
352 /** Boolean sets of which modules implement which functions
354 char implement_lists[255][255];
356 /** Global implementation list
358 char global_implementation[255];
360 /** A list of ports claimed by IO Modules
362 std::map<int,Module*> IOHookModule;
364 /** The 005 tokens of this server (ISUPPORT)
365 * populated/repopulated upon loading or unloading
370 /** STATS characters in this list are available
373 char UserStats[MAXBUF];
375 /** The path and filename of the ircd.log file
379 /** Custom version string, which if defined can replace the system info in VERSION.
381 char CustomVersion[MAXBUF];
383 /** List of u-lined servers
385 std::vector<irc::string> ulines;
387 /** Max banlist sizes for channels (the std::string is a glob)
389 std::map<std::string,int> maxbans;
391 /** If set to true, no user DNS lookups are to be performed
395 /** If set to true, provide syntax hints for unknown commands
399 /** If set to true, users appear to quit then rejoin when their hosts change.
400 * This keeps clients synchronized properly.
404 /** Construct a new ServerConfig
406 ServerConfig(InspIRCd* Instance);
408 /** Clears the include stack in preperation for a Read() call.
412 /** Read the entire configuration into memory
413 * and initialize this class. All other methods
414 * should be used only by the core.
416 void Read(bool bail, userrec* user);
418 /** Read a file into a file_cache object
420 bool ReadFile(file_cache &F, const char* fname);
422 /** Load 'filename' into 'target', with the new config parser everything is parsed into
423 * tag/key/value at load-time rather than at read-value time.
425 bool LoadConf(ConfigDataHash &target, const char* filename, std::ostringstream &errorstream);
426 /** Load 'filename' into 'target', with the new config parser everything is parsed into
427 * tag/key/value at load-time rather than at read-value time.
429 bool LoadConf(ConfigDataHash &target, const std::string &filename, std::ostringstream &errorstream);
431 /* Both these return true if the value existed or false otherwise */
433 /** Writes 'length' chars into 'result' as a string
435 bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, int index, char* result, int length);
436 /** Writes 'length' chars into 'result' as a string
438 bool ConfValue(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, std::string &result);
440 /** Tries to convert the value to an integer and write it to 'result'
442 bool ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, int index, int &result);
443 /** Tries to convert the value to an integer and write it to 'result'
445 bool ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, int &result);
447 /** Returns true if the value exists and has a true value, false otherwise
449 bool ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, int index);
450 /** Returns true if the value exists and has a true value, false otherwise
452 bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, int index);
454 /** Returns the number of occurences of tag in the config file
456 int ConfValueEnum(ConfigDataHash &target, const char* tag);
457 /** Returns the number of occurences of tag in the config file
459 int ConfValueEnum(ConfigDataHash &target, const std::string &tag);
461 /** Returns the numbers of vars inside the index'th 'tag in the config file
463 int ConfVarEnum(ConfigDataHash &target, const char* tag, int index);
464 /** Returns the numbers of vars inside the index'th 'tag in the config file
466 int ConfVarEnum(ConfigDataHash &target, const std::string &tag, int index);
468 Module* GetIOHook(int port);
469 bool AddIOHook(int port, Module* iomod);
470 bool DelIOHook(int port);
472 static std::string GetFullProgDir(char** argv, int argc);
473 static bool DirValid(const char* dirandfile);
474 static char* CleanFilename(char* name);
475 static bool FileExists(const char* file);
479 bool InitializeDisabledCommands(const char* data, InspIRCd* ServerInstance);