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
32 typedef bool (*Validator)(ServerConfig* conf, const char*, const char*, void*);
33 typedef bool (*MultiValidator)(ServerConfig* conf, const char*, char**, void**, int*);
34 typedef bool (*MultiNotify)(ServerConfig* conf, const char*);
36 enum ConfigDataType { DT_NOTHING, DT_INTEGER, DT_CHARPTR, DT_BOOLEAN };
43 ConfigDataType datatype;
44 Validator validation_function;
52 MultiNotify init_function;
53 MultiValidator validation_function;
54 MultiNotify finish_function;
57 /** This class holds the bulk of the runtime configuration for the ircd.
58 * It allows for reading new config values, accessing configuration files,
59 * and storage of the configuration data needed to run the ircd, such as
60 * the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
62 class ServerConfig : public Extensible
65 InspIRCd* ServerInstance;
67 /** This variable holds the names of all
68 * files included from the main one. This
69 * is used to make sure that no files are
70 * recursively included.
72 std::vector<std::string> include_stack;
74 /** This private method processes one line of
75 * configutation, appending errors to errorstream
76 * and setting error if an error has occured.
78 bool ParseLine(ConfigDataHash &target, std::string &line, long linenumber, std::ostringstream &errorstream);
80 bool DoInclude(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream);
82 /** Check that there is only one of each configuration item
84 bool CheckOnce(char* tag, bool bail, userrec* user);
88 InspIRCd* GetInstance();
90 /** This holds all the information in the config file,
91 * it's indexed by tag name to a vector of key/values.
93 ConfigDataHash config_data;
95 /** Holds the server name of the local server
96 * as defined by the administrator.
98 char ServerName[MAXBUF];
100 /* Holds the network name the local server
101 * belongs to. This is an arbitary field defined
102 * by the administrator.
104 char Network[MAXBUF];
106 /** Holds the description of the local server
107 * as defined by the administrator.
109 char ServerDesc[MAXBUF];
111 /** Holds the admin's name, for output in
112 * the /ADMIN command.
114 char AdminName[MAXBUF];
116 /** Holds the email address of the admin,
117 * for output in the /ADMIN command.
119 char AdminEmail[MAXBUF];
121 /** Holds the admin's nickname, for output
122 * in the /ADMIN command
124 char AdminNick[MAXBUF];
126 /** The admin-configured /DIE password
128 char diepass[MAXBUF];
130 /** The admin-configured /RESTART password
132 char restartpass[MAXBUF];
134 /** The pathname and filename of the message of the
135 * day file, as defined by the administrator.
139 /** The pathname and filename of the rules file,
140 * as defined by the administrator.
144 /** The quit prefix in use, or an empty string
146 char PrefixQuit[MAXBUF];
148 /** The last string found within a <die> tag, or
151 char DieValue[MAXBUF];
153 /** The DNS server to use for DNS queries
155 char DNSServer[MAXBUF];
157 /** This variable contains a space-seperated list
158 * of commands which are disabled by the
159 * administrator of the server for non-opers.
161 char DisabledCommands[MAXBUF];
163 /** The full path to the modules directory.
164 * This is either set at compile time, or
165 * overridden in the configuration file via
170 /** The temporary directory where modules are copied
174 /** The full pathname to the executable, as
175 * given in argv[0] when the program starts.
177 char MyExecutable[1024];
179 /** The file handle of the logfile. If this
180 * value is NULL, the log file is not open,
181 * probably due to a permissions error on
182 * startup (this should not happen in normal
187 /** If this value is true, the owner of the
188 * server specified -nofork on the command
189 * line, causing the daemon to stay in the
194 /** If this value if true then all log
195 * messages will be output, regardless of
196 * the level given in the config file.
197 * This is set with the -debug commandline
202 /** If this is true then log output will be
203 * written to the logfile. This is the default.
204 * If you put -nolog on the commandline then
205 * the logfile will not be written.
206 * This is meant to be used in conjunction with
207 * -debug for debugging without filling up the
212 /** If this value is true, halfops have been
213 * enabled in the configuration file.
217 /** The number of seconds the DNS subsystem
218 * will wait before timing out any request.
222 /** The size of the read() buffer in the user
223 * handling code, used to read data into a user's
228 /** The value to be used for listen() backlogs
233 /** The soft limit value assigned to the irc server.
234 * The IRC server will not allow more than this
235 * number of local users.
237 unsigned int SoftLimit;
239 /** Maximum number of targets for a multi target command
240 * such as PRIVMSG or KICK
242 unsigned int MaxTargets;
244 /** The maximum number of /WHO results allowed
245 * in any single /WHO command.
249 /** True if the DEBUG loglevel is selected.
253 /** The loglevel in use by the IRC server
257 /** How many seconds to wait before exiting
258 * the program when /DIE is correctly issued.
262 /** True if we're going to hide netsplits as *.net *.split for non-opers
266 /** True if we're going to hide ban reasons for non-opers (e.g. G-Lines,
271 /** If this is enabled then operators will
272 * see invisible (+i) channels in /whois.
276 /** Set to a non-empty string to obfuscate the server name of users in WHOIS
278 char HideWhoisServer[MAXBUF];
280 /** A list of IP addresses the server is listening
283 char addrs[MAXBUF][255];
285 /** The MOTD file, cached in a file_cache type.
289 /** The RULES file, cached in a file_cache type.
293 /** The full pathname and filename of the PID
294 * file as defined in the configuration.
298 /** The connect classes in use by the IRC server.
302 /** A list of module names (names only, no paths)
303 * which are currently loaded by the server.
305 std::vector<std::string> module_names;
307 /** A list of ports which the server is listening on
311 /** A list of the file descriptors for the listening client ports
313 int openSockfd[MAX_DESCRIPTORS];
315 /** Boolean sets of which modules implement which functions
317 char implement_lists[255][255];
319 /** Global implementation list
321 char global_implementation[255];
323 /** A list of ports claimed by IO Modules
325 std::map<int,Module*> IOHookModule;
327 /** The 005 tokens of this server (ISUPPORT)
328 * populated/repopulated upon loading or unloading
333 /** STATS characters in this list are available
336 char OperOnlyStats[MAXBUF];
338 /** The path and filename of the ircd.log file
342 /** Custom version string, which if defined can replace the system info in VERSION.
344 char CustomVersion[MAXBUF];
346 /** List of u-lined servers
348 std::vector<irc::string> ulines;
350 /** Max banlist sizes for channels (the std::string is a glob)
352 std::map<std::string,int> maxbans;
354 /** If set to true, no user DNS lookups are to be performed
358 /** If set to true, provide syntax hints for unknown commands
362 ServerConfig(InspIRCd* Instance);
364 /** Clears the include stack in preperation for
369 /** Read the entire configuration into memory
370 * and initialize this class. All other methods
371 * should be used only by the core.
373 void Read(bool bail, userrec* user);
375 /** Read a file into a file_cache object
377 bool ReadFile(file_cache &F, const char* fname);
379 /** Load 'filename' into 'target', with the new config parser everything is parsed into
380 * tag/key/value at load-time rather than at read-value time.
382 bool LoadConf(ConfigDataHash &target, const char* filename, std::ostringstream &errorstream);
383 bool LoadConf(ConfigDataHash &target, const std::string &filename, std::ostringstream &errorstream);
385 /* Both these return true if the value existed or false otherwise */
387 /* Writes 'length' chars into 'result' as a string */
388 bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, int index, char* result, int length);
389 bool ConfValue(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, std::string &result);
391 /* Tries to convert the value to an integer and write it to 'result' */
392 bool ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, int index, int &result);
393 bool ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, int &result);
395 /* Returns true if the value exists and has a true value, false otherwise */
396 bool ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, int index);
397 bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, int index);
399 /* Returns the number of occurences of tag in the config file */
400 int ConfValueEnum(ConfigDataHash &target, const char* tag);
401 int ConfValueEnum(ConfigDataHash &target, const std::string &tag);
403 /* Returns the numbers of vars inside the index'th 'tag in the config file */
404 int ConfVarEnum(ConfigDataHash &target, const char* tag, int index);
405 int ConfVarEnum(ConfigDataHash &target, const std::string &tag, int index);
407 Module* GetIOHook(int port);
408 bool AddIOHook(int port, Module* iomod);
409 bool DelIOHook(int port);
411 static std::string GetFullProgDir(char** argv, int argc);
412 static bool DirValid(const char* dirandfile);
413 static char* CleanFilename(char* name);
414 static bool FileExists(const char* file);
418 bool InitializeDisabledCommands(const char* data, InspIRCd* ServerInstance);