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 /** Types of data in the core config
36 enum ConfigDataType { DT_NOTHING, DT_INTEGER, DT_CHARPTR, DT_BOOLEAN };
56 ValueItem(char* value)
61 int GetInteger() { return atoi(v.c_str()); };
63 const char* GetString() { return v.c_str(); };
65 bool GetBool() { return GetInteger(); };
68 typedef std::deque<ValueItem> ValueList;
70 /** A callback for validating a single value
72 typedef bool (*Validator)(ServerConfig* conf, const char*, const char*, void*);
73 /** A callback for validating multiple value entries
75 typedef bool (*MultiValidator)(ServerConfig* conf, const char*, char**, ValueList&, int*);
76 /** A callback indicating the end of a group of entries
78 typedef bool (*MultiNotify)(ServerConfig* conf, const char*);
81 /** Holds a core configuration item and its callbacks
88 ConfigDataType datatype;
89 Validator validation_function;
92 /** Holds a core configuration item and its callbacks
93 * where there may be more than one item
100 MultiNotify init_function;
101 MultiValidator validation_function;
102 MultiNotify finish_function;
105 /** A set of oper types
107 typedef std::map<irc::string,char*> opertype_t;
109 /** A Set of oper classes
111 typedef std::map<irc::string,char*> operclass_t;
114 /** This class holds the bulk of the runtime configuration for the ircd.
115 * It allows for reading new config values, accessing configuration files,
116 * and storage of the configuration data needed to run the ircd, such as
117 * the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
119 class ServerConfig : public Extensible
124 InspIRCd* ServerInstance;
126 /** This variable holds the names of all
127 * files included from the main one. This
128 * is used to make sure that no files are
129 * recursively included.
131 std::vector<std::string> include_stack;
133 /** This private method processes one line of
134 * configutation, appending errors to errorstream
135 * and setting error if an error has occured.
137 bool ParseLine(ConfigDataHash &target, std::string &line, long linenumber, std::ostringstream &errorstream);
139 /** Process an include directive
141 bool DoInclude(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream);
143 /** Check that there is only one of each configuration item
145 bool CheckOnce(char* tag, bool bail, userrec* user);
149 InspIRCd* GetInstance();
151 /** This holds all the information in the config file,
152 * it's indexed by tag name to a vector of key/values.
154 ConfigDataHash config_data;
156 /** Max number of WhoWas entries per user.
160 /** Max number of cumulative user-entries in WhoWas.
161 * When max reached and added to, push out oldest entry FIFO style.
165 /** Max seconds a user is kept in WhoWas before being pruned.
169 /** Holds the server name of the local server
170 * as defined by the administrator.
172 char ServerName[MAXBUF];
174 /* Holds the network name the local server
175 * belongs to. This is an arbitary field defined
176 * by the administrator.
178 char Network[MAXBUF];
180 /** Holds the description of the local server
181 * as defined by the administrator.
183 char ServerDesc[MAXBUF];
185 /** Holds the admin's name, for output in
186 * the /ADMIN command.
188 char AdminName[MAXBUF];
190 /** Holds the email address of the admin,
191 * for output in the /ADMIN command.
193 char AdminEmail[MAXBUF];
195 /** Holds the admin's nickname, for output
196 * in the /ADMIN command
198 char AdminNick[MAXBUF];
200 /** The admin-configured /DIE password
202 char diepass[MAXBUF];
204 /** The admin-configured /RESTART password
206 char restartpass[MAXBUF];
208 /** The pathname and filename of the message of the
209 * day file, as defined by the administrator.
213 /** The pathname and filename of the rules file,
214 * as defined by the administrator.
218 /** The quit prefix in use, or an empty string
220 char PrefixQuit[MAXBUF];
222 /** The last string found within a <die> tag, or
225 char DieValue[MAXBUF];
227 /** The DNS server to use for DNS queries
229 char DNSServer[MAXBUF];
231 /** This variable contains a space-seperated list
232 * of commands which are disabled by the
233 * administrator of the server for non-opers.
235 char DisabledCommands[MAXBUF];
237 /** The full path to the modules directory.
238 * This is either set at compile time, or
239 * overridden in the configuration file via
244 /** The temporary directory where modules are copied
248 /** The full pathname to the executable, as
249 * given in argv[0] when the program starts.
251 char MyExecutable[1024];
253 /** The file handle of the logfile. If this
254 * value is NULL, the log file is not open,
255 * probably due to a permissions error on
256 * startup (this should not happen in normal
261 /** If this value is true, the owner of the
262 * server specified -nofork on the command
263 * line, causing the daemon to stay in the
268 /** If this value if true then all log
269 * messages will be output, regardless of
270 * the level given in the config file.
271 * This is set with the -debug commandline
276 /** If this is true then log output will be
277 * written to the logfile. This is the default.
278 * If you put -nolog on the commandline then
279 * the logfile will not be written.
280 * This is meant to be used in conjunction with
281 * -debug for debugging without filling up the
286 /** If this value is true, halfops have been
287 * enabled in the configuration file.
291 /** The number of seconds the DNS subsystem
292 * will wait before timing out any request.
296 /** The size of the read() buffer in the user
297 * handling code, used to read data into a user's
302 /** The value to be used for listen() backlogs
307 /** The soft limit value assigned to the irc server.
308 * The IRC server will not allow more than this
309 * number of local users.
311 unsigned int SoftLimit;
313 /** Maximum number of targets for a multi target command
314 * such as PRIVMSG or KICK
316 unsigned int MaxTargets;
318 /** The maximum number of /WHO results allowed
319 * in any single /WHO command.
323 /** True if the DEBUG loglevel is selected.
327 /** The loglevel in use by the IRC server
331 /** How many seconds to wait before exiting
332 * the program when /DIE is correctly issued.
336 /** True if we're going to hide netsplits as *.net *.split for non-opers
340 /** True if we're going to hide ban reasons for non-opers (e.g. G-Lines,
345 /** If this is enabled then operators will
346 * see invisible (+i) channels in /whois.
350 /** Set to a non-empty string to obfuscate the server name of users in WHOIS
352 char HideWhoisServer[MAXBUF];
354 /** A list of IP addresses the server is listening
357 char addrs[MAXBUF][255];
359 /** The MOTD file, cached in a file_cache type.
363 /** The RULES file, cached in a file_cache type.
367 /** The full pathname and filename of the PID
368 * file as defined in the configuration.
372 /** The connect classes in use by the IRC server.
376 /** A list of module names (names only, no paths)
377 * which are currently loaded by the server.
379 std::vector<std::string> module_names;
381 /** A list of ports which the server is listening on
385 /** A list of the file descriptors for the listening client ports
387 ListenSocket* openSockfd[255];
389 /** Boolean sets of which modules implement which functions
391 char implement_lists[255][255];
393 /** Global implementation list
395 char global_implementation[255];
397 /** A list of ports claimed by IO Modules
399 std::map<int,Module*> IOHookModule;
401 /** The 005 tokens of this server (ISUPPORT)
402 * populated/repopulated upon loading or unloading
407 /** STATS characters in this list are available
410 char UserStats[MAXBUF];
412 /** The path and filename of the ircd.log file
416 /** Custom version string, which if defined can replace the system info in VERSION.
418 char CustomVersion[MAXBUF];
420 /** List of u-lined servers
422 std::vector<irc::string> ulines;
424 /** Max banlist sizes for channels (the std::string is a glob)
426 std::map<std::string,int> maxbans;
428 /** If set to true, no user DNS lookups are to be performed
432 /** If set to true, provide syntax hints for unknown commands
436 /** If set to true, users appear to quit then rejoin when their hosts change.
437 * This keeps clients synchronized properly.
442 #if __GNUC__ == 3 && __GNUC_MINOR__ == 3
443 /** if we're being compiled with GCC 3.3 add
444 * dummy opertype on heap to fix GCC 3.3 crash
446 opertype_t dummyopertype;
449 /** All oper type definitions from the config file
451 opertype_t opertypes;
453 /** All oper class definitions from the config file
455 operclass_t operclass;
457 /** Construct a new ServerConfig
459 ServerConfig(InspIRCd* Instance);
461 /** Clears the include stack in preperation for a Read() call.
465 /** Read the entire configuration into memory
466 * and initialize this class. All other methods
467 * should be used only by the core.
469 void Read(bool bail, userrec* user);
471 /** Read a file into a file_cache object
473 bool ReadFile(file_cache &F, const char* fname);
475 /** Load 'filename' into 'target', with the new config parser everything is parsed into
476 * tag/key/value at load-time rather than at read-value time.
478 bool LoadConf(ConfigDataHash &target, const char* filename, std::ostringstream &errorstream);
479 /** Load 'filename' into 'target', with the new config parser everything is parsed into
480 * tag/key/value at load-time rather than at read-value time.
482 bool LoadConf(ConfigDataHash &target, const std::string &filename, std::ostringstream &errorstream);
484 /* Both these return true if the value existed or false otherwise */
486 /** Writes 'length' chars into 'result' as a string
488 bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, int index, char* result, int length);
489 /** Writes 'length' chars into 'result' as a string
491 bool ConfValue(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, std::string &result);
493 /** Tries to convert the value to an integer and write it to 'result'
495 bool ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, int index, int &result);
496 /** Tries to convert the value to an integer and write it to 'result'
498 bool ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, int &result);
500 /** Returns true if the value exists and has a true value, false otherwise
502 bool ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, int index);
503 /** Returns true if the value exists and has a true value, false otherwise
505 bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, int index);
507 /** Returns the number of occurences of tag in the config file
509 int ConfValueEnum(ConfigDataHash &target, const char* tag);
510 /** Returns the number of occurences of tag in the config file
512 int ConfValueEnum(ConfigDataHash &target, const std::string &tag);
514 /** Returns the numbers of vars inside the index'th 'tag in the config file
516 int ConfVarEnum(ConfigDataHash &target, const char* tag, int index);
517 /** Returns the numbers of vars inside the index'th 'tag in the config file
519 int ConfVarEnum(ConfigDataHash &target, const std::string &tag, int index);
521 Module* GetIOHook(int port);
522 bool AddIOHook(int port, Module* iomod);
523 bool DelIOHook(int port);
525 static std::string GetFullProgDir(char** argv, int argc);
526 static bool DirValid(const char* dirandfile);
527 static char* CleanFilename(char* name);
528 static bool FileExists(const char* file);
532 bool InitializeDisabledCommands(const char* data, InspIRCd* ServerInstance);
534 bool InitTypes(ServerConfig* conf, const char* tag);
535 bool InitClasses(ServerConfig* conf, const char* tag);
536 bool DoType(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
537 bool DoClass(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
538 bool DoneClassesAndTypes(ServerConfig* conf, const char* tag);