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>
10 * Written by Craig Edwards, Craig McLure, and others.
11 * This program is free but copyrighted software; see
12 * the file COPYING for details.
14 * ---------------------------------------------------
17 #ifndef __INSPIRCD_IO_H__
18 #define __INSPIRCD_IO_H__
28 /** Flags for use with log()
36 typedef bool (*Validator)(const char*, const char*, void*);
37 typedef bool (*MultiValidator)(const char*, char**, void**, int*);
38 typedef bool (*MultiNotify)(const char*);
40 enum ConfigDataType { DT_NOTHING, DT_INTEGER, DT_CHARPTR, DT_BOOLEAN };
42 struct InitialConfig {
46 ConfigDataType datatype;
47 Validator validation_function;
54 MultiNotify init_function;
55 MultiValidator validation_function;
56 MultiNotify finish_function;
59 /** This class holds the bulk of the runtime configuration for the ircd.
60 * It allows for reading new config values, accessing configuration files,
61 * and storage of the configuration data needed to run the ircd, such as
62 * the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
64 class ServerConfig : public classbase
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 /** This holds all the information in the config file,
89 * it's indexed by tag name to a vector of key/values.
91 ConfigDataHash config_data;
93 /** Holds the server name of the local server
94 * as defined by the administrator.
96 char ServerName[MAXBUF];
98 /* Holds the network name the local server
99 * belongs to. This is an arbitary field defined
100 * by the administrator.
102 char Network[MAXBUF];
104 /** Holds the description of the local server
105 * as defined by the administrator.
107 char ServerDesc[MAXBUF];
109 /** Holds the admin's name, for output in
110 * the /ADMIN command.
112 char AdminName[MAXBUF];
114 /** Holds the email address of the admin,
115 * for output in the /ADMIN command.
117 char AdminEmail[MAXBUF];
119 /** Holds the admin's nickname, for output
120 * in the /ADMIN command
122 char AdminNick[MAXBUF];
124 /** The admin-configured /DIE password
126 char diepass[MAXBUF];
128 /** The admin-configured /RESTART password
130 char restartpass[MAXBUF];
132 /** The pathname and filename of the message of the
133 * day file, as defined by the administrator.
137 /** The pathname and filename of the rules file,
138 * as defined by the administrator.
142 /** The quit prefix in use, or an empty string
144 char PrefixQuit[MAXBUF];
146 /** The last string found within a <die> tag, or
149 char DieValue[MAXBUF];
151 /** The DNS server to use for DNS queries
153 char DNSServer[MAXBUF];
155 /** This variable contains a space-seperated list
156 * of commands which are disabled by the
157 * administrator of the server for non-opers.
159 char DisabledCommands[MAXBUF];
161 /** The full path to the modules directory.
162 * This is either set at compile time, or
163 * overridden in the configuration file via
168 /** The temporary directory where modules are copied
172 /** The full pathname to the executable, as
173 * given in argv[0] when the program starts.
175 char MyExecutable[1024];
177 /** The file handle of the logfile. If this
178 * value is NULL, the log file is not open,
179 * probably due to a permissions error on
180 * startup (this should not happen in normal
185 /** If this value is true, the owner of the
186 * server specified -nofork on the command
187 * line, causing the daemon to stay in the
192 /** If this value is true, halfops have been
193 * enabled in the configuration file.
197 /** The number of seconds the DNS subsystem
198 * will wait before timing out any request.
202 /** The size of the read() buffer in the user
203 * handling code, used to read data into a user's
208 /** The value to be used for listen() backlogs
213 /** The soft limit value assigned to the irc server.
214 * The IRC server will not allow more than this
215 * number of local users.
217 unsigned int SoftLimit;
219 /** Maximum number of targets for a multi target command
220 * such as PRIVMSG or KICK
222 unsigned int MaxTargets;
224 /** The maximum number of /WHO results allowed
225 * in any single /WHO command.
229 /** True if the DEBUG loglevel is selected.
233 /** The loglevel in use by the IRC server
237 /** How many seconds to wait before exiting
238 * the program when /DIE is correctly issued.
242 /** True if we're going to hide netsplits as *.net *.split for non-opers
246 /** True if we're going to hide ban reasons for non-opers (e.g. G-Lines,
251 /** If this is enabled then operators will
252 * see invisible (+i) channels in /whois.
256 /** Set to a non-empty string to obfuscate the server name of users in WHOIS
258 char HideWhoisServer[MAXBUF];
260 /** A list of IP addresses the server is listening
263 char addrs[MAXBUF][255];
265 /** The MOTD file, cached in a file_cache type.
269 /** The RULES file, cached in a file_cache type.
273 /** The full pathname and filename of the PID
274 * file as defined in the configuration.
278 /** The connect classes in use by the IRC server.
282 /** A list of module names (names only, no paths)
283 * which are currently loaded by the server.
285 std::vector<std::string> module_names;
287 /** A list of ports which the server is listening on
291 /** Boolean sets of which modules implement which functions
293 char implement_lists[255][255];
295 /** Global implementation list
297 char global_implementation[255];
299 /** A list of ports claimed by IO Modules
301 std::map<int,Module*> IOHookModule;
303 /** The 005 tokens of this server (ISUPPORT)
304 * populated/repopulated upon loading or unloading
309 /** STATS characters in this list are available
312 char OperOnlyStats[MAXBUF];
314 /** The path and filename of the ircd.log file
318 /** Custom version string, which if defined can replace the system info in VERSION.
320 char CustomVersion[MAXBUF];
322 /** List of u-lined servers
324 std::vector<irc::string> ulines;
326 /** Max banlist sizes for channels (the std::string is a glob)
328 std::map<std::string,int> maxbans;
332 /** Clears the include stack in preperation for
337 /** Read the entire configuration into memory
338 * and initialize this class. All other methods
339 * should be used only by the core.
341 void Read(bool bail, userrec* user);
343 /** Load 'filename' into 'target', with the new config parser everything is parsed into
344 * tag/key/value at load-time rather than at read-value time.
346 bool LoadConf(ConfigDataHash &target, const char* filename, std::ostringstream &errorstream);
347 bool LoadConf(ConfigDataHash &target, const std::string &filename, std::ostringstream &errorstream);
349 /* Both these return true if the value existed or false otherwise */
351 /* Writes 'length' chars into 'result' as a string */
352 bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, int index, char* result, int length);
353 bool ConfValue(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, std::string &result);
355 /* Tries to convert the value to an integer and write it to 'result' */
356 bool ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, int index, int &result);
357 bool ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, int &result);
359 /* Returns true if the value exists and has a true value, false otherwise */
360 bool ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, int index);
361 bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, int index);
363 /* Returns the number of occurences of tag in the config file */
364 int ConfValueEnum(ConfigDataHash &target, const char* tag);
365 int ConfValueEnum(ConfigDataHash &target, const std::string &tag);
367 /* Returns the numbers of vars inside the index'th 'tag in the config file */
368 int ConfVarEnum(ConfigDataHash &target, const char* tag, int index);
369 int ConfVarEnum(ConfigDataHash &target, const std::string &tag, int index);
371 Module* GetIOHook(int port);
372 bool AddIOHook(int port, Module* iomod);
373 bool DelIOHook(int port);
377 void Exit(int status);
381 bool FileExists(const char* file);
383 bool BindSocket(int sockfd, struct sockaddr_in client, struct sockaddr_in server, int port, char* addr);
384 void WritePID(const std::string &filename);
385 int BindPorts(bool bail);
386 char* CleanFilename(char* name);