1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2007 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
14 #ifndef INSPIRCD_CONFIGREADER
15 #define INSPIRCD_CONFIGREADER
24 #include "socketengine.h"
31 /** Types of data in the core config
39 DT_ALLOW_NEWLINE = 128
42 /** Holds a config value, either string, integer or boolean.
43 * Callback functions receive one or more of these, either on
44 * their own as a reference, or in a reference to a deque of them.
45 * The callback function can then alter the values of the ValueItem
46 * classes to validate the settings.
53 ValueItem(bool value);
54 ValueItem(char* value);
55 void Set(char* value);
56 void Set(const char* val);
63 /** The base class of the container 'ValueContainer'
64 * used internally by the core to hold core values.
66 class ValueContainerBase
69 ValueContainerBase() { }
70 virtual ~ValueContainerBase() { }
73 /** ValueContainer is used to contain pointers to different
74 * core values such as the server name, maximum number of
76 * It is specialized to hold a data type, then pointed at
77 * a value in the ServerConfig class. When the value has been
78 * read and validated, the Set method is called to write the
79 * value safely in a type-safe manner.
81 template<typename T> class ValueContainer : public ValueContainerBase
97 void Set(T newval, size_t s)
99 memcpy(val, newval, s);
103 /** A specialization of ValueContainer to hold a pointer to a bool
105 typedef ValueContainer<bool*> ValueContainerBool;
107 /** A specialization of ValueContainer to hold a pointer to
110 typedef ValueContainer<unsigned int*> ValueContainerUInt;
112 /** A specialization of ValueContainer to hold a pointer to
115 typedef ValueContainer<char*> ValueContainerChar;
117 /** A specialization of ValueContainer to hold a pointer to
120 typedef ValueContainer<int*> ValueContainerInt;
122 /** A set of ValueItems used by multi-value validator functions
124 typedef std::deque<ValueItem> ValueList;
126 /** A callback for validating a single value
128 typedef bool (*Validator)(ServerConfig* conf, const char*, const char*, ValueItem&);
129 /** A callback for validating multiple value entries
131 typedef bool (*MultiValidator)(ServerConfig* conf, const char*, char**, ValueList&, int*);
132 /** A callback indicating the end of a group of entries
134 typedef bool (*MultiNotify)(ServerConfig* conf, const char*);
136 /** Holds a core configuration item and its callbacks
142 ValueContainerBase* val;
143 ConfigDataType datatype;
144 Validator validation_function;
147 /** Holds a core configuration item and its callbacks
148 * where there may be more than one item
155 MultiNotify init_function;
156 MultiValidator validation_function;
157 MultiNotify finish_function;
160 /** A set of oper types
162 typedef std::map<irc::string,char*> opertype_t;
164 /** A Set of oper classes
166 typedef std::map<irc::string,char*> operclass_t;
169 /** This class holds the bulk of the runtime configuration for the ircd.
170 * It allows for reading new config values, accessing configuration files,
171 * and storage of the configuration data needed to run the ircd, such as
172 * the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
174 class ServerConfig : public Extensible
179 InspIRCd* ServerInstance;
181 /** This variable holds the names of all
182 * files included from the main one. This
183 * is used to make sure that no files are
184 * recursively included.
186 std::vector<std::string> include_stack;
188 /** This private method processes one line of
189 * configutation, appending errors to errorstream
190 * and setting error if an error has occured.
192 bool ParseLine(ConfigDataHash &target, std::string &line, long linenumber, std::ostringstream &errorstream);
194 /** Process an include directive
196 bool DoInclude(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream);
198 /** Check that there is only one of each configuration item
200 bool CheckOnce(char* tag, bool bail, userrec* user);
204 InspIRCd* GetInstance();
206 /** This holds all the information in the config file,
207 * it's indexed by tag name to a vector of key/values.
209 ConfigDataHash config_data;
211 /** Max number of WhoWas entries per user.
215 /** Max number of cumulative user-entries in WhoWas.
216 * When max reached and added to, push out oldest entry FIFO style.
220 /** Max seconds a user is kept in WhoWas before being pruned.
224 /** Holds the server name of the local server
225 * as defined by the administrator.
227 char ServerName[MAXBUF];
229 /* Holds the network name the local server
230 * belongs to. This is an arbitary field defined
231 * by the administrator.
233 char Network[MAXBUF];
235 /** Holds the description of the local server
236 * as defined by the administrator.
238 char ServerDesc[MAXBUF];
240 /** Holds the admin's name, for output in
241 * the /ADMIN command.
243 char AdminName[MAXBUF];
245 /** Holds the email address of the admin,
246 * for output in the /ADMIN command.
248 char AdminEmail[MAXBUF];
250 /** Holds the admin's nickname, for output
251 * in the /ADMIN command
253 char AdminNick[MAXBUF];
255 /** The admin-configured /DIE password
257 char diepass[MAXBUF];
259 /** The admin-configured /RESTART password
261 char restartpass[MAXBUF];
263 /** The pathname and filename of the message of the
264 * day file, as defined by the administrator.
268 /** The pathname and filename of the rules file,
269 * as defined by the administrator.
273 /** The quit prefix in use, or an empty string
275 char PrefixQuit[MAXBUF];
277 /** The last string found within a <die> tag, or
280 char DieValue[MAXBUF];
282 /** The DNS server to use for DNS queries
284 char DNSServer[MAXBUF];
286 /** This variable contains a space-seperated list
287 * of commands which are disabled by the
288 * administrator of the server for non-opers.
290 char DisabledCommands[MAXBUF];
292 /** The full path to the modules directory.
293 * This is either set at compile time, or
294 * overridden in the configuration file via
299 /** The full pathname to the executable, as
300 * given in argv[0] when the program starts.
302 char MyExecutable[1024];
304 /** The file handle of the logfile. If this
305 * value is NULL, the log file is not open,
306 * probably due to a permissions error on
307 * startup (this should not happen in normal
312 /** If this value is true, the owner of the
313 * server specified -nofork on the command
314 * line, causing the daemon to stay in the
319 /** If this value if true then all log
320 * messages will be output, regardless of
321 * the level given in the config file.
322 * This is set with the -debug commandline
327 /** If this is true then log output will be
328 * written to the logfile. This is the default.
329 * If you put -nolog on the commandline then
330 * the logfile will not be written.
331 * This is meant to be used in conjunction with
332 * -debug for debugging without filling up the
337 /** If this value is true, halfops have been
338 * enabled in the configuration file.
342 /** The number of seconds the DNS subsystem
343 * will wait before timing out any request.
347 /** The size of the read() buffer in the user
348 * handling code, used to read data into a user's
353 /** The value to be used for listen() backlogs
358 /** The soft limit value assigned to the irc server.
359 * The IRC server will not allow more than this
360 * number of local users.
362 unsigned int SoftLimit;
364 /** Maximum number of targets for a multi target command
365 * such as PRIVMSG or KICK
367 unsigned int MaxTargets;
369 /** The maximum number of /WHO results allowed
370 * in any single /WHO command.
374 /** True if the DEBUG loglevel is selected.
378 /** The loglevel in use by the IRC server
382 /** How many seconds to wait before exiting
383 * the program when /DIE is correctly issued.
387 /** True if we're going to hide netsplits as *.net *.split for non-opers
391 /** True if we're going to hide ban reasons for non-opers (e.g. G-Lines,
396 /** If this is enabled then operators will
397 * see invisible (+i) channels in /whois.
401 /** Set to a non-empty string to obfuscate the server name of users in WHOIS
403 char HideWhoisServer[MAXBUF];
405 /** A list of IP addresses the server is listening
408 char addrs[MAXBUF][255];
410 /** The MOTD file, cached in a file_cache type.
414 /** The RULES file, cached in a file_cache type.
418 /** The full pathname and filename of the PID
419 * file as defined in the configuration.
423 /** The connect classes in use by the IRC server.
427 /** A list of module names (names only, no paths)
428 * which are currently loaded by the server.
430 std::vector<std::string> module_names;
432 /** A list of ports which the server is listening on
436 /** A list of the file descriptors for the listening client ports
438 ListenSocket* openSockfd[255];
440 /** Boolean sets of which modules implement which functions
442 char implement_lists[255][255];
444 /** Global implementation list
446 char global_implementation[255];
448 /** A list of ports claimed by IO Modules
450 std::map<int,Module*> IOHookModule;
452 std::map<InspSocket*, Module*> SocketIOHookModule;
454 /** The 005 tokens of this server (ISUPPORT)
455 * populated/repopulated upon loading or unloading
459 std::vector<std::string> isupport;
461 /** STATS characters in this list are available
464 char UserStats[MAXBUF];
466 /** The path and filename of the ircd.log file
470 /** Custom version string, which if defined can replace the system info in VERSION.
472 char CustomVersion[MAXBUF];
474 /** List of u-lined servers
476 std::vector<irc::string> ulines;
478 /** Max banlist sizes for channels (the std::string is a glob)
480 std::map<std::string,int> maxbans;
482 /** Directory where the inspircd binary resides
486 /** If set to true, no user DNS lookups are to be performed
490 /** If set to true, provide syntax hints for unknown commands
494 /** If set to true, users appear to quit then rejoin when their hosts change.
495 * This keeps clients synchronized properly.
499 /** If set to true, prefixed channel NOTICEs and PRIVMSGs will have the prefix
500 * added to the outgoing text for undernet style msg prefixing.
502 bool UndernetMsgPrefix;
504 /** All oper type definitions from the config file
506 opertype_t opertypes;
508 /** All oper class definitions from the config file
510 operclass_t operclass;
512 /** Saved argv from startup
516 /** Saved argc from startup
520 /** Construct a new ServerConfig
522 ServerConfig(InspIRCd* Instance);
524 /** Clears the include stack in preperation for a Read() call.
528 /** Update the 005 vector
532 /** Send the 005 numerics (ISUPPORT) to a user
534 void Send005(userrec* user);
536 /** Read the entire configuration into memory
537 * and initialize this class. All other methods
538 * should be used only by the core.
540 void Read(bool bail, userrec* user);
542 /** Read a file into a file_cache object
544 bool ReadFile(file_cache &F, const char* fname);
546 /** Load 'filename' into 'target', with the new config parser everything is parsed into
547 * tag/key/value at load-time rather than at read-value time.
550 /** Report a configuration error given in errormessage.
551 * @param bail If this is set to true, the error is sent to the console, and the program exits
552 * @param user If this is set to a non-null value, and bail is false, the errors are spooled to
553 * this user as SNOTICEs.
554 * If the parameter is NULL, the messages are spooled to all users via WriteOpers as SNOTICEs.
556 void ReportConfigError(const std::string &errormessage, bool bail, userrec* user);
558 /** Load 'filename' into 'target', with the new config parser everything is parsed into
559 * tag/key/value at load-time rather than at read-value time.
561 bool LoadConf(ConfigDataHash &target, const char* filename, std::ostringstream &errorstream);
563 /** Load 'filename' into 'target', with the new config parser everything is parsed into
564 * tag/key/value at load-time rather than at read-value time.
566 bool LoadConf(ConfigDataHash &target, const std::string &filename, std::ostringstream &errorstream);
568 /* Both these return true if the value existed or false otherwise */
570 /** Writes 'length' chars into 'result' as a string
572 bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, int index, char* result, int length, bool allow_linefeeds = false);
573 /** Writes 'length' chars into 'result' as a string
575 bool ConfValue(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, std::string &result, bool allow_linefeeds = false);
577 /** Tries to convert the value to an integer and write it to 'result'
579 bool ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, int index, int &result);
580 /** Tries to convert the value to an integer and write it to 'result'
582 bool ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, int &result);
584 /** Returns true if the value exists and has a true value, false otherwise
586 bool ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, int index);
587 /** Returns true if the value exists and has a true value, false otherwise
589 bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, int index);
591 /** Returns the number of occurences of tag in the config file
593 int ConfValueEnum(ConfigDataHash &target, const char* tag);
594 /** Returns the number of occurences of tag in the config file
596 int ConfValueEnum(ConfigDataHash &target, const std::string &tag);
598 /** Returns the numbers of vars inside the index'th 'tag in the config file
600 int ConfVarEnum(ConfigDataHash &target, const char* tag, int index);
601 /** Returns the numbers of vars inside the index'th 'tag in the config file
603 int ConfVarEnum(ConfigDataHash &target, const std::string &tag, int index);
605 Module* GetIOHook(int port);
606 bool AddIOHook(int port, Module* iomod);
607 bool DelIOHook(int port);
608 Module* GetIOHook(InspSocket* is);
609 bool AddIOHook(Module* iomod, InspSocket* is);
610 bool DelIOHook(InspSocket* is);
612 static std::string GetFullProgDir(char** argv, int argc);
613 static bool DirValid(const char* dirandfile);
614 static char* CleanFilename(char* name);
615 static bool FileExists(const char* file);
619 bool InitializeDisabledCommands(const char* data, InspIRCd* ServerInstance);
621 bool InitTypes(ServerConfig* conf, const char* tag);
622 bool InitClasses(ServerConfig* conf, const char* tag);
623 bool DoType(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
624 bool DoClass(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
625 bool DoneClassesAndTypes(ServerConfig* conf, const char* tag);