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 opertype_t 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();
118 /** This holds all the information in the config file,
119 * it's indexed by tag name to a vector of key/values.
121 ConfigDataHash config_data;
123 /** Holds the server name of the local server
124 * as defined by the administrator.
126 char ServerName[MAXBUF];
128 /* Holds the network name the local server
129 * belongs to. This is an arbitary field defined
130 * by the administrator.
132 char Network[MAXBUF];
134 /** Holds the description of the local server
135 * as defined by the administrator.
137 char ServerDesc[MAXBUF];
139 /** Holds the admin's name, for output in
140 * the /ADMIN command.
142 char AdminName[MAXBUF];
144 /** Holds the email address of the admin,
145 * for output in the /ADMIN command.
147 char AdminEmail[MAXBUF];
149 /** Holds the admin's nickname, for output
150 * in the /ADMIN command
152 char AdminNick[MAXBUF];
154 /** The admin-configured /DIE password
156 char diepass[MAXBUF];
158 /** The admin-configured /RESTART password
160 char restartpass[MAXBUF];
162 /** The pathname and filename of the message of the
163 * day file, as defined by the administrator.
167 /** The pathname and filename of the rules file,
168 * as defined by the administrator.
172 /** The quit prefix in use, or an empty string
174 char PrefixQuit[MAXBUF];
176 /** The last string found within a <die> tag, or
179 char DieValue[MAXBUF];
181 /** The DNS server to use for DNS queries
183 char DNSServer[MAXBUF];
185 /** This variable contains a space-seperated list
186 * of commands which are disabled by the
187 * administrator of the server for non-opers.
189 char DisabledCommands[MAXBUF];
191 /** The full path to the modules directory.
192 * This is either set at compile time, or
193 * overridden in the configuration file via
198 /** The temporary directory where modules are copied
202 /** The full pathname to the executable, as
203 * given in argv[0] when the program starts.
205 char MyExecutable[1024];
207 /** The file handle of the logfile. If this
208 * value is NULL, the log file is not open,
209 * probably due to a permissions error on
210 * startup (this should not happen in normal
215 /** If this value is true, the owner of the
216 * server specified -nofork on the command
217 * line, causing the daemon to stay in the
222 /** If this value if true then all log
223 * messages will be output, regardless of
224 * the level given in the config file.
225 * This is set with the -debug commandline
230 /** If this is true then log output will be
231 * written to the logfile. This is the default.
232 * If you put -nolog on the commandline then
233 * the logfile will not be written.
234 * This is meant to be used in conjunction with
235 * -debug for debugging without filling up the
240 /** If this value is true, halfops have been
241 * enabled in the configuration file.
245 /** The number of seconds the DNS subsystem
246 * will wait before timing out any request.
250 /** The size of the read() buffer in the user
251 * handling code, used to read data into a user's
256 /** The value to be used for listen() backlogs
261 /** The soft limit value assigned to the irc server.
262 * The IRC server will not allow more than this
263 * number of local users.
265 unsigned int SoftLimit;
267 /** Maximum number of targets for a multi target command
268 * such as PRIVMSG or KICK
270 unsigned int MaxTargets;
272 /** The maximum number of /WHO results allowed
273 * in any single /WHO command.
277 /** True if the DEBUG loglevel is selected.
281 /** The loglevel in use by the IRC server
285 /** How many seconds to wait before exiting
286 * the program when /DIE is correctly issued.
290 /** True if we're going to hide netsplits as *.net *.split for non-opers
294 /** True if we're going to hide ban reasons for non-opers (e.g. G-Lines,
299 /** If this is enabled then operators will
300 * see invisible (+i) channels in /whois.
304 /** Set to a non-empty string to obfuscate the server name of users in WHOIS
306 char HideWhoisServer[MAXBUF];
308 /** A list of IP addresses the server is listening
311 char addrs[MAXBUF][255];
313 /** The MOTD file, cached in a file_cache type.
317 /** The RULES file, cached in a file_cache type.
321 /** The full pathname and filename of the PID
322 * file as defined in the configuration.
326 /** The connect classes in use by the IRC server.
330 /** A list of module names (names only, no paths)
331 * which are currently loaded by the server.
333 std::vector<std::string> module_names;
335 /** A list of ports which the server is listening on
339 /** A list of the file descriptors for the listening client ports
341 ListenSocket* openSockfd[255];
343 /** Boolean sets of which modules implement which functions
345 char implement_lists[255][255];
347 /** Global implementation list
349 char global_implementation[255];
351 /** A list of ports claimed by IO Modules
353 std::map<int,Module*> IOHookModule;
355 /** The 005 tokens of this server (ISUPPORT)
356 * populated/repopulated upon loading or unloading
361 /** STATS characters in this list are available
364 char UserStats[MAXBUF];
366 /** The path and filename of the ircd.log file
370 /** Custom version string, which if defined can replace the system info in VERSION.
372 char CustomVersion[MAXBUF];
374 /** List of u-lined servers
376 std::vector<irc::string> ulines;
378 /** Max banlist sizes for channels (the std::string is a glob)
380 std::map<std::string,int> maxbans;
382 /** If set to true, no user DNS lookups are to be performed
386 /** If set to true, provide syntax hints for unknown commands
390 /** If set to true, users appear to quit then rejoin when their hosts change.
391 * This keeps clients synchronized properly.
395 /* All oper type definitions from the config file
397 opertype_t opertypes;
399 /** All oper class definitions from the config file
401 operclass_t operclass;
403 /** Construct a new ServerConfig
405 ServerConfig(InspIRCd* Instance);
407 /** Clears the include stack in preperation for a Read() call.
411 /** Read the entire configuration into memory
412 * and initialize this class. All other methods
413 * should be used only by the core.
415 void Read(bool bail, userrec* user);
417 /** Read a file into a file_cache object
419 bool ReadFile(file_cache &F, const char* fname);
421 /** Load 'filename' into 'target', with the new config parser everything is parsed into
422 * tag/key/value at load-time rather than at read-value time.
424 bool LoadConf(ConfigDataHash &target, const char* filename, std::ostringstream &errorstream);
425 /** Load 'filename' into 'target', with the new config parser everything is parsed into
426 * tag/key/value at load-time rather than at read-value time.
428 bool LoadConf(ConfigDataHash &target, const std::string &filename, std::ostringstream &errorstream);
430 /* Both these return true if the value existed or false otherwise */
432 /** Writes 'length' chars into 'result' as a string
434 bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, int index, char* result, int length);
435 /** Writes 'length' chars into 'result' as a string
437 bool ConfValue(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, std::string &result);
439 /** Tries to convert the value to an integer and write it to 'result'
441 bool ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, int index, int &result);
442 /** Tries to convert the value to an integer and write it to 'result'
444 bool ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, int &result);
446 /** Returns true if the value exists and has a true value, false otherwise
448 bool ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, int index);
449 /** Returns true if the value exists and has a true value, false otherwise
451 bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, int index);
453 /** Returns the number of occurences of tag in the config file
455 int ConfValueEnum(ConfigDataHash &target, const char* tag);
456 /** Returns the number of occurences of tag in the config file
458 int ConfValueEnum(ConfigDataHash &target, const std::string &tag);
460 /** Returns the numbers of vars inside the index'th 'tag in the config file
462 int ConfVarEnum(ConfigDataHash &target, const char* tag, int index);
463 /** Returns the numbers of vars inside the index'th 'tag in the config file
465 int ConfVarEnum(ConfigDataHash &target, const std::string &tag, int index);
467 Module* GetIOHook(int port);
468 bool AddIOHook(int port, Module* iomod);
469 bool DelIOHook(int port);
471 static std::string GetFullProgDir(char** argv, int argc);
472 static bool DirValid(const char* dirandfile);
473 static char* CleanFilename(char* name);
474 static bool FileExists(const char* file);
478 bool InitializeDisabledCommands(const char* data, InspIRCd* ServerInstance);