X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fconfigreader.h;h=8a548fcbfef8e0724a0610ad977e1c6b6cc1ea52;hb=d3a7ac87cb9ef8687f7fec09f54a570f9858efb4;hp=cd8d66849c7285255117253e741526d6a99284e7;hpb=d1ddbd62f91d4b9453447b5d25f5e41e807b0010;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/configreader.h b/include/configreader.h index cd8d66849..8a548fcbf 100644 --- a/include/configreader.h +++ b/include/configreader.h @@ -1,18 +1,33 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd: (C) 2002-2009 InspIRCd Development Team - * See: http://wiki.inspircd.org/Credits + * Copyright (C) 2019 Matt Schatz + * Copyright (C) 2018 Chris Novakovic + * Copyright (C) 2013-2014, 2016 Attila Molnar + * Copyright (C) 2013 Daniel Vassdal + * Copyright (C) 2012-2014, 2016-2020 Sadie Powell + * Copyright (C) 2012, 2019 Robby + * Copyright (C) 2009-2010 Daniel De Graaf + * Copyright (C) 2008 Thomas Stagner + * Copyright (C) 2007-2008 Robin Burchell + * Copyright (C) 2007-2008 Craig Edwards + * Copyright (C) 2007 Dennis Friis * - * This program is free but copyrighted software; see - * the file COPYING for details. + * This file is part of InspIRCd. InspIRCd is free software: you can + * redistribute it and/or modify it under the terms of the GNU General Public + * License as published by the Free Software Foundation, version 2. * - * --------------------------------------------------- + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . */ -#ifndef INSPIRCD_CONFIGREADER -#define INSPIRCD_CONFIGREADER + +#pragma once #include #include @@ -22,48 +37,66 @@ #include "modules.h" #include "socketengine.h" #include "socket.h" +#include "token_list.h" -/* Required forward definitions */ -class ServerConfig; -class ServerLimits; -class InspIRCd; -class BufferedSocket; - -/** A set of oper types - */ -typedef std::map opertype_t; - -/** Holds an oper class. - */ -struct operclass_data : public classbase +/** Structure representing a single \ in config */ +class CoreExport ConfigTag : public refcountbase { - /** Command list for the class - */ - std::string commandlist; - - /** Channel mode list for the class - */ - std::string cmodelist; - - /** User mode list for the class - */ - std::string umodelist; - - /** Priviledges given by this class - */ - std::string privs; + ConfigItems items; + public: + const std::string tag; + const std::string src_name; + const int src_line; + + /** Get the value of an option, using def if it does not exist */ + std::string getString(const std::string& key, const std::string& def, const TR1NS::function& validator); + /** Get the value of an option, using def if it does not exist */ + std::string getString(const std::string& key, const std::string& def = "", size_t minlen = 0, size_t maxlen = UINT32_MAX); + /** Get the value of an option, using def if it does not exist */ + long getInt(const std::string& key, long def, long min = LONG_MIN, long max = LONG_MAX); + /** Get the value of an option, using def if it does not exist */ + unsigned long getUInt(const std::string& key, unsigned long def, unsigned long min = 0, unsigned long max = ULONG_MAX); + /** Get the value of an option, using def if it does not exist */ + double getFloat(const std::string& key, double def, double min = DBL_MIN, double max = DBL_MAX); + /** Get the value of an option, using def if it does not exist */ + bool getBool(const std::string& key, bool def = false); + + /** Get the value in seconds of a duration that is in the user-friendly "1h2m3s" format, + * using a default value if it does not exist or is out of bounds. + * @param key The config key name + * @param def Default value (optional) + * @param min Minimum acceptable value (optional) + * @param max Maximum acceptable value (optional) + * @return The duration in seconds + */ + unsigned long getDuration(const std::string& key, unsigned long def, unsigned long min = 0, unsigned long max = ULONG_MAX); + + /** Get the value of an option + * @param key The option to get + * @param value The location to store the value (unmodified if does not exist) + * @param allow_newline Allow newlines in the option (normally replaced with spaces) + * @return true if the option exists + */ + bool readString(const std::string& key, std::string& value, bool allow_newline = false); + + std::string getTagLocation(); + + inline const ConfigItems& getItems() const { return items; } + + /** Create a new ConfigTag, giving access to the private ConfigItems item list */ + static ConfigTag* create(const std::string& Tag, const std::string& file, int line, ConfigItems*& Items); + private: + ConfigTag(const std::string& Tag, const std::string& file, int line); }; -/** A Set of oper classes - */ -typedef std::map operclass_t; - /** Defines the server's length limits on various length-limited * items such as topics, nicknames, channel names etc. */ class ServerLimits { public: + /** Maximum line length */ + size_t MaxLine; /** Maximum nickname length */ size_t NickMax; /** Maximum channel length */ @@ -78,305 +111,243 @@ class ServerLimits size_t MaxTopic; /** Maximum kick message length */ size_t MaxKick; - /** Maximum GECOS (real name) length */ - size_t MaxGecos; + /** Maximum real name length */ + size_t MaxReal; /** Maximum away message length */ size_t MaxAway; + /** Maximum hostname length */ + size_t MaxHost; - /** Creating the class initialises it to the defaults - * as in 1.1's ./configure script. Reading other values - * from the config will change these values. + /** Read all limits from a config tag. Limits which aren't specified in the tag are set to a default value. + * @param tag Configuration tag to read the limits from */ - ServerLimits() : NickMax(31), ChanMax(64), MaxModes(20), IdentMax(12), MaxQuit(255), MaxTopic(307), MaxKick(255), MaxGecos(128), MaxAway(200) - { - } + ServerLimits(ConfigTag* tag); - /** Finalises the settings by adding one. This allows for them to be used as-is - * without a 'value+1' when using the std::string assignment methods etc. - */ - void Finalise() - { - NickMax++; - ChanMax++; - IdentMax++; - MaxQuit++; - MaxTopic++; - MaxKick++; - MaxGecos++; - MaxAway++; - } + /** Maximum length of a n!u\@h mask */ + size_t GetMaxMask() const { return NickMax + 1 + IdentMax + 1 + MaxHost; } }; -/** This class holds the bulk of the runtime configuration for the ircd. - * It allows for reading new config values, accessing configuration files, - * and storage of the configuration data needed to run the ircd, such as - * the servername, connect classes, /ADMIN data, MOTDs and filenames etc. - */ -class CoreExport ServerConfig : public classbase +struct CommandLineConf { - private: - /** This variable holds the names of all - * files included from the main one. This - * is used to make sure that no files are - * recursively included. - */ - std::vector include_stack; - - /* classes removed by this rehash */ - std::vector removed_classes; - - /** This private method processes one line of - * configutation, appending errors to errorstream - * and setting error if an error has occured. - */ - bool ParseLine(const std::string &filename, std::string &line, long &linenumber, bool allowexeinc); - - /** Check that there is only one of each configuration item - */ - bool CheckOnce(const char* tag); - - void CrossCheckOperClassType(); - void CrossCheckConnectBlocks(ServerConfig* current); - - public: - /** Process an include executable directive - */ - bool DoPipe(const std::string &file); - - /** Process an include file directive - */ - bool DoInclude(const std::string &file, bool allowexeinc); - - /** Error stream, contains error output from any failed configuration parsing. + /** If this value is true, the owner of the + * server specified -nofork on the command + * line, causing the daemon to stay in the + * foreground. */ - std::stringstream errstr; - - /** True if this configuration is valid enough to run with */ - bool valid; + bool nofork; - /** Set of included files. Do we use this any more? + /** If this value if true then all log + * messages will be output, regardless of + * the level given in the config file. + * This is set with the -debug commandline + * option. */ - std::map IncludedFiles; - - /** Used to indicate who we announce invites to on a channel */ - enum InviteAnnounceState { INVITE_ANNOUNCE_NONE, INVITE_ANNOUNCE_ALL, INVITE_ANNOUNCE_OPS, INVITE_ANNOUNCE_DYNAMIC }; + bool forcedebug; - /** Not used any more as it is named, can probably be removed or renamed. + /** If this is true then log output will be + * written to the logfile. This is the default. + * If you put -nolog on the commandline then + * the logfile will not be written. + * This is meant to be used in conjunction with + * -debug for debugging without filling up the + * hard disk. */ - int DoDownloads(); + bool writelog; - /** This holds all the information in the config file, - * it's indexed by tag name to a vector of key/values. + /** If this is true, a PID file will be written + * to the file given in the "file" variable of + * the \ tag in the config file. This is + * the default. + * Passing --nopid as a command line argument + * sets this to false; in this case, a PID file + * will not be written, even the default PID + * file that is usually written when the \ + * tag is not defined in the config file. */ - ConfigDataHash config_data; + bool writepid; - /** Length limits, see definition of ServerLimits class - */ - ServerLimits Limits; + /* Whether the --runasroot option was specified at boot. */ + bool runasroot; - /** Clones CIDR range for ipv4 (0-32) - * Defaults to 32 (checks clones on all IPs seperately) - */ - int c_ipv4_range; + /** Saved argc from startup. */ + int argc; - /** Clones CIDR range for ipv6 (0-128) - * Defaults to 128 (checks on all IPs seperately) - */ - int c_ipv6_range; + /** Saved argv from startup. */ + char** argv; +}; - /** Max number of WhoWas entries per user. - */ - int WhoWasGroupSize; +class CoreExport OperInfo : public refcountbase +{ + public: + TokenList AllowedOperCommands; + TokenList AllowedPrivs; - /** Max number of cumulative user-entries in WhoWas. - * When max reached and added to, push out oldest entry FIFO style. - */ - int WhoWasMaxGroups; + /** Allowed user modes from oper classes. */ + std::bitset<64> AllowedUserModes; - /** Max seconds a user is kept in WhoWas before being pruned. - */ - int WhoWasMaxKeep; + /** Allowed channel modes from oper classes. */ + std::bitset<64> AllowedChanModes; - /** Both for set(g|u)id. - */ - std::string SetUser; - std::string SetGroup; + /** Allowed snomasks from oper classes. */ + std::bitset<64> AllowedSnomasks; - /** Holds the server name of the local server - * as defined by the administrator. - */ - std::string ServerName; + /** \ block used for this oper-up. May be NULL. */ + reference oper_block; + /** \ block used for this oper-up. Valid for local users, may be NULL on remote */ + reference type_block; + /** \ blocks referenced from the \ block. These define individual permissions */ + std::vector > class_blocks; + /** Name of the oper type; i.e. the one shown in WHOIS */ + std::string name; - /** Notice to give to users when they are Xlined + /** Creates a new OperInfo with the specified oper type name. + * @param Name The name of the oper type. */ - std::string MoronBanner; + OperInfo(const std::string& Name); - /* Holds the network name the local server - * belongs to. This is an arbitary field defined - * by the administrator. - */ - std::string Network; + /** Get a configuration item, searching in the oper, type, and class blocks (in that order) */ + std::string getConfig(const std::string& key); + void init(); +}; - /** Holds the description of the local server - * as defined by the administrator. - */ - std::string ServerDesc; +/** This class holds the bulk of the runtime configuration for the ircd. + * It allows for reading new config values, accessing configuration files, + * and storage of the configuration data needed to run the ircd, such as + * the servername, connect classes, /ADMIN data, MOTDs and filenames etc. + */ +class CoreExport ServerConfig +{ + private: + void CrossCheckOperClassType(); + void CrossCheckConnectBlocks(ServerConfig* current); - /** Holds the admin's name, for output in - * the /ADMIN command. - */ - std::string AdminName; + public: + /** How to treat a user in a channel who is banned. */ + enum BannedUserTreatment + { + /** Don't treat a banned user any different to normal. */ + BUT_NORMAL, - /** Holds the email address of the admin, - * for output in the /ADMIN command. - */ - std::string AdminEmail; + /** Restrict the actions of a banned user. */ + BUT_RESTRICT_SILENT, - /** Holds the admin's nickname, for output - * in the /ADMIN command - */ - std::string AdminNick; + /** Restrict the actions of a banned user and notify them of their treatment. */ + BUT_RESTRICT_NOTIFY + }; - /** The admin-configured /DIE password - */ - std::string diepass; + class ServerPaths + { + public: + /** Config path */ + std::string Config; - /** The admin-configured /RESTART password - */ - std::string restartpass; + /** Data path */ + std::string Data; - /** The hash method for *BOTH* the die and restart passwords. - */ - std::string powerhash; + /** Log path */ + std::string Log; - /** The pathname and filename of the message of the - * day file, as defined by the administrator. - */ - std::string motd; + /** Module path */ + std::string Module; - /** The pathname and filename of the rules file, - * as defined by the administrator. - */ - std::string rules; + /** Runtime path */ + std::string Runtime; - /** The quit prefix in use, or an empty string - */ - std::string PrefixQuit; + ServerPaths(ConfigTag* tag); - /** The quit suffix in use, or an empty string - */ - std::string SuffixQuit; + std::string PrependConfig(const std::string& fn) const { return FileSystem::ExpandPath(Config, fn); } + std::string PrependData(const std::string& fn) const { return FileSystem::ExpandPath(Data, fn); } + std::string PrependLog(const std::string& fn) const { return FileSystem::ExpandPath(Log, fn); } + std::string PrependModule(const std::string& fn) const { return FileSystem::ExpandPath(Module, fn); } + std::string PrependRuntime(const std::string& fn) const { return FileSystem::ExpandPath(Runtime, fn); } + }; - /** The fixed quit message in use, or an empty string + /** Holds a complete list of all connect blocks */ - std::string FixedQuit; + typedef std::vector > ClassVector; - /** The part prefix in use, or an empty string + /** Index of valid oper blocks and types */ - std::string PrefixPart; + typedef insp::flat_map > OperIndex; - /** The part suffix in use, or an empty string + /** Get a configuration tag by name. If one or more tags are present then the first is returned. + * @param tag The name of the tag to get. + * @returns Either a tag from the config or EmptyTag. */ - std::string SuffixPart; + ConfigTag* ConfValue(const std::string& tag); - /** The fixed part message in use, or an empty string + /** Get a list of configuration tags by name. + * @param tag The name of the tags to get. + * @returns Either a list of tags from the config or an empty ConfigTagList. */ - std::string FixedPart; + ConfigTagList ConfTags(const std::string& tag); - /** The last string found within a tag, or - * an empty string. - */ - std::string DieValue; + /** An empty configuration tag. */ + ConfigTag* EmptyTag; - /** The DNS server to use for DNS queries + /** Error stream, contains error output from any failed configuration parsing. */ - std::string DNSServer; + std::stringstream errstr; - /** Pretend disabled commands don't exist. - */ - bool DisabledDontExist; + /** True if this configuration is valid enough to run with */ + bool valid; - /** This variable contains a space-seperated list - * of commands which are disabled by the - * administrator of the server for non-opers. - */ - std::string DisabledCommands; + /** Bind to IPv6 by default */ + bool WildcardIPv6; - /** This variable identifies which usermodes have been diabled. + /** This holds all the information in the config file, + * it's indexed by tag name to a vector of key/values. */ + ConfigDataHash config_data; - char DisabledUModes[64]; - - /** This variable identifies which chanmodes have been disabled. + /** This holds all extra files that have been read in the configuration + * (for example, MOTD and RULES files are stored here) */ - char DisabledCModes[64]; + ConfigFileCache Files; - /** The full path to the modules directory. - * This is either set at compile time, or - * overridden in the configuration file via - * the tag. + /** Length limits, see definition of ServerLimits class */ - std::string ModPath; + ServerLimits Limits; - /** The file handle of the logfile. If this - * value is NULL, the log file is not open, - * probably due to a permissions error on - * startup (this should not happen in normal - * operation!). - */ - FILE *log_file; + /** Locations of various types of file (config, module, etc). */ + ServerPaths Paths; - /** If this value is true, the owner of the - * server specified -nofork on the command - * line, causing the daemon to stay in the - * foreground. + /** Configuration parsed from the command line. */ - bool nofork; + CommandLineConf cmdline; - /** If this value if true then all log - * messages will be output, regardless of - * the level given in the config file. - * This is set with the -debug commandline - * option. + /** Clones CIDR range for ipv4 (0-32) + * Defaults to 32 (checks clones on all IPs separately) */ - bool forcedebug; + unsigned char c_ipv4_range; - /** If this is true then log output will be - * written to the logfile. This is the default. - * If you put -nolog on the commandline then - * the logfile will not be written. - * This is meant to be used in conjunction with - * -debug for debugging without filling up the - * hard disk. + /** Clones CIDR range for ipv6 (0-128) + * Defaults to 128 (checks on all IPs separately) */ - bool writelog; + unsigned char c_ipv6_range; - /** If set to true, then all opers on this server are - * shown with a generic 'is an IRC operator' line rather - * than the oper type. Oper types are still used internally. + /** Holds the server name of the local server + * as defined by the administrator. */ - bool GenericOper; + std::string ServerName; - /** If this value is true, banned users (+b, not extbans) will not be able to change nick - * if banned on any channel, nor to message them. + /** Notice to give to users when they are banned by an XLine */ - bool RestrictBannedUsers; + std::string XLineMessage; - /** If this value is true, halfops have been - * enabled in the configuration file. + /* Holds the network name the local server + * belongs to. This is an arbitrary field defined + * by the administrator. */ - bool AllowHalfop; + std::string Network; - /** If this is set to true, then mode lists (e.g - * MODE #chan b) are hidden from unprivileged - * users. + /** Holds the description of the local server + * as defined by the administrator. */ - bool HideModeLists[256]; + std::string ServerDesc; - /** The number of seconds the DNS subsystem - * will wait before timing out any request. - */ - int dns_timeout; + /** How to treat a user in a channel who is banned. */ + BannedUserTreatment RestrictBannedUsers; /** The size of the read() buffer in the user * handling code, used to read data into a user's @@ -389,6 +360,13 @@ class CoreExport ServerConfig : public classbase */ int MaxConn; + /** If we should check for clones during CheckClass() in AddUser() + * Setting this to false allows to not trigger on maxclones for users + * that may belong to another class after DNS-lookup is complete. + * It does, however, make the server spend more time on users we may potentially not want. + */ + bool CCOnConnect; + /** The soft limit value assigned to the irc server. * The IRC server will not allow more than this * number of local users. @@ -400,53 +378,19 @@ class CoreExport ServerConfig : public classbase */ unsigned int MaxTargets; - /** The maximum number of /WHO results allowed - * in any single /WHO command. - */ - int MaxWhoResults; - - /** True if the DEBUG loglevel is selected. - */ - int debugging; - - /** How many seconds to wait before exiting - * the program when /DIE is correctly issued. - */ - int DieDelay; - - /** True if we're going to hide netsplits as *.net *.split for non-opers - */ - bool HideSplits; + /** The number of seconds that the server clock can skip by before server operators are warned. */ + time_t TimeSkipWarn; - /** True if we're going to hide ban reasons for non-opers (e.g. G-Lines, - * K-Lines, Z-Lines) + /** True if we're going to hide ban reasons for non-opers (e.g. G-lines, + * K-lines, Z-lines) */ bool HideBans; - /** Announce invites to the channel with a server notice - */ - InviteAnnounceState AnnounceInvites; - - /** If this is enabled then operators will - * see invisible (+i) channels in /whois. - */ - bool OperSpyWhois; - - /** Set to a non-empty string to obfuscate the server name of users in WHOIS - */ - std::string HideWhoisServer; + /** True if raw I/O is being logged */ + bool RawLog; - /** Set to a non empty string to obfuscate nicknames prepended to a KILL. - */ - std::string HideKillsServer; - - /** The MOTD file, cached in a file_cache type. - */ - file_cache MOTD; - - /** The RULES file, cached in a file_cache type. - */ - file_cache RULES; + /** Set to a non-empty string to obfuscate server names. */ + std::string HideServer; /** The full pathname and filename of the PID * file as defined in the configuration. @@ -457,25 +401,6 @@ class CoreExport ServerConfig : public classbase */ ClassVector Classes; - /** The 005 tokens of this server (ISUPPORT) - * populated/repopulated upon loading or unloading - * modules. - */ - std::string data005; - - /** isupport strings - */ - std::vector isupport; - - /** STATS characters in this list are available - * only to operators. - */ - std::string UserStats; - - /** The path and filename of the ircd.log file - */ - std::string logpath; - /** Default channel modes */ std::string DefaultModes; @@ -484,62 +409,32 @@ class CoreExport ServerConfig : public classbase */ std::string CustomVersion; - /** List of u-lined servers - */ - std::map ulines; - - /** Max banlist sizes for channels (the std::string is a glob) - */ - std::map maxbans; - - /** Directory where the inspircd binary resides - */ - std::string MyDir; - - /** If set to true, no user DNS lookups are to be performed - */ - bool NoUserDns; - /** If set to true, provide syntax hints for unknown commands */ bool SyntaxHints; - /** If set to true, users appear to quit then rejoin when their hosts change. - * This keeps clients synchronized properly. + /** The name of the casemapping method used by this server. */ - bool CycleHosts; + std::string CaseMapping; - /** If set to true, prefixed channel NOTICEs and PRIVMSGs will have the prefix - * added to the outgoing text for undernet style msg prefixing. - */ - bool UndernetMsgPrefix; - - /** If set to true, the full nick!user@host will be shown in the TOPIC command + /** If set to true, the full nick!user\@host will be shown in the TOPIC command * for who set the topic last. If false, only the nick is shown. */ bool FullHostInTopic; - /** All oper type definitions from the config file + /** Oper blocks keyed by their name */ - opertype_t opertypes; + OperIndex oper_blocks; - /** All oper class definitions from the config file + /** Oper types keyed by their name */ - operclass_t operclass; + OperIndex OperTypes; - /** Saved argv from startup - */ - char** argv; - - /** Saved argc from startup - */ - int argc; - - /** Max channels per user + /** Default value for , deprecated in 3.0 */ unsigned int MaxChans; - /** Oper max channels per user + /** Default value for , deprecated in 3.0 */ unsigned int OperMaxChans; @@ -550,26 +445,21 @@ class CoreExport ServerConfig : public classbase */ std::string sid; - /** True if we have been told to run the testsuite from the commandline, - * rather than entering the mainloop. - */ - bool TestSuite; - /** Construct a new ServerConfig */ ServerConfig(); + ~ServerConfig(); + /** Get server ID as string with required leading zeroes */ - std::string GetSID(); + const std::string& GetSID() const { return sid; } - /** Update the 005 vector - */ - void Update005(); + /** Retrieves the server name which should be shown to users. */ + const std::string& GetServerName() const { return HideServer.empty() ? ServerName : HideServer; } - /** Send the 005 numerics (ISUPPORT) to a user - */ - void Send005(User* user); + /** Retrieves the server description which should be shown to users. */ + const std::string& GetServerDesc() const { return HideServer.empty() ? ServerDesc : HideServer; } /** Read the entire configuration into memory * and initialize this class. All other methods @@ -582,294 +472,61 @@ class CoreExport ServerConfig : public classbase void Apply(ServerConfig* old, const std::string &useruid); void ApplyModules(User* user); - /** Read a file into a file_cache object - */ - bool ReadFile(file_cache &F, const char* fname); - - /* Returns true if the given string starts with a windows drive letter - */ - bool StartsWithWindowsDriveLetter(const std::string &path); - - /** Load 'filename' into 'target', with the new config parser everything is parsed into - * tag/key/value at load-time rather than at read-value time. - */ - bool LoadConf(FILE* &conf, const char* filename, bool allowexeinc); - - /** Load 'filename' into 'target', with the new config parser everything is parsed into - * tag/key/value at load-time rather than at read-value time. - */ - bool LoadConf(FILE* &conf, const std::string &filename, bool allowexeinc); - - /** Writes 'length' chars into 'result' as a string - */ - bool ConfValue(const char* tag, const char* var, int index, char* result, int length, bool allow_linefeeds = false); - - /** Writes 'length' chars into 'result' as a string - */ - bool ConfValue(const char* tag, const char* var, const char* default_value, int index, char* result, int length, bool allow_linefeeds = false); - - /** Writes 'length' chars into 'result' as a string - */ - bool ConfValue(const std::string &tag, const std::string &var, int index, std::string &result, bool allow_linefeeds = false); - - /** Writes 'length' chars into 'result' as a string - */ - bool ConfValue(const std::string &tag, const std::string &var, const std::string &default_value, int index, std::string &result, bool allow_linefeeds = false); - - /** Tries to convert the value to an integer and write it to 'result' - */ - bool ConfValueInteger(const char* tag, const char* var, int index, int &result); - - /** Tries to convert the value to an integer and write it to 'result' - */ - bool ConfValueInteger(const char* tag, const char* var, const char* default_value, int index, int &result); - - /** Tries to convert the value to an integer and write it to 'result' - */ - bool ConfValueInteger(const std::string &tag, const std::string &var, int index, int &result); - - /** Tries to convert the value to an integer and write it to 'result' - */ - bool ConfValueInteger(const std::string &tag, const std::string &var, const std::string &default_value, int index, int &result); - - /** Returns true if the value exists and has a true value, false otherwise - */ - bool ConfValueBool(const char* tag, const char* var, int index); - - /** Returns true if the value exists and has a true value, false otherwise - */ - bool ConfValueBool(const char* tag, const char* var, const char* default_value, int index); - - /** Returns true if the value exists and has a true value, false otherwise - */ - bool ConfValueBool(const std::string &tag, const std::string &var, int index); - - /** Returns true if the value exists and has a true value, false otherwise - */ - bool ConfValueBool(const std::string &tag, const std::string &var, const std::string &default_value, int index); - - /** Returns the number of occurences of tag in the config file - */ - int ConfValueEnum(const char* tag); - /** Returns the number of occurences of tag in the config file - */ - int ConfValueEnum(const std::string &tag); - - /** Returns the numbers of vars inside the index'th 'tag in the config file - */ - int ConfVarEnum(const char* tag, int index); - /** Returns the numbers of vars inside the index'th 'tag in the config file - */ - int ConfVarEnum(const std::string &tag, int index); - - bool ApplyDisabledCommands(const std::string& data); - - /** Clean a filename, stripping the directories (and drives) from string. - * @param name Directory to tidy - * @return The cleaned filename - */ - static const char* CleanFilename(const char* name); + void Fill(); - /** Check if a file exists. - * @param file The full path to a file - * @return True if the file exists and is readable. + /** Escapes a value for storage in a configuration key. + * @param str The string to escape. + * @param xml Are we using the XML config format? */ - static bool FileExists(const char* file); + static std::string Escape(const std::string& str, bool xml = true); - /** If this value is true, invites will bypass more than just +i + /** If this value is true, snotices will not stack when repeats are sent */ - bool InvBypassModes; - -}; - - -/** Types of data in the core config - */ -enum ConfigDataType -{ - DT_NOTHING = 0, /* No data */ - DT_INTEGER = 1, /* Integer */ - DT_CHARPTR = 2, /* Char pointer */ - DT_BOOLEAN = 3, /* Boolean */ - DT_HOSTNAME = 4, /* Hostname syntax */ - DT_NOSPACES = 5, /* No spaces */ - DT_IPADDRESS = 6, /* IP address (v4, v6) */ - DT_CHANNEL = 7, /* Channel name */ - DT_LIMIT = 8, /* size_t */ - DT_ALLOW_WILD = 64, /* Allow wildcards/CIDR in DT_IPADDRESS */ - DT_ALLOW_NEWLINE = 128 /* New line characters allowed in DT_CHARPTR */ -}; - -/** The maximum number of values in a core configuration tag. Can be increased if needed. - */ -#define MAX_VALUES_PER_TAG 18 - -/** Holds a config value, either string, integer or boolean. - * Callback functions receive one or more of these, either on - * their own as a reference, or in a reference to a deque of them. - * The callback function can then alter the values of the ValueItem - * classes to validate the settings. - */ -class ValueItem -{ - /** Actual data */ - std::string v; - public: - /** Initialize with an int */ - ValueItem(int value); - /** Initialize with a bool */ - ValueItem(bool value); - /** Initialize with a string */ - ValueItem(const char* value) : v(value) { } - /** Change value to a string */ - void Set(const std::string &val); - /** Change value to an int */ - void Set(int value); - /** Get value as an int */ - int GetInteger(); - /** Get value as a string */ - const char* GetString() const; - /** Get value as a string */ - inline const std::string& GetValue() const { return v; } - /** Get value as a bool */ - bool GetBool(); -}; - -/** The base class of the container 'ValueContainer' - * used internally by the core to hold core values. - */ -class ValueContainerBase -{ - public: - /** Constructor */ - ValueContainerBase() { } - /** Destructor */ - virtual ~ValueContainerBase() { } + bool NoSnoticeStack; }; -/** ValueContainer is used to contain pointers to different - * core values such as the server name, maximum number of - * clients etc. - * It is specialized to hold a data type, then pointed at - * a value in the ServerConfig class. When the value has been - * read and validated, the Set method is called to write the - * value safely in a type-safe manner. +/** The background thread for config reading, so that reading from executable includes + * does not block. */ -template class ValueContainer : public ValueContainerBase +class CoreExport ConfigReaderThread : public Thread { - T ServerConfig::* const vptr; + ServerConfig* Config; + volatile bool done; public: - /** Initialize with a value of type T */ - ValueContainer(T ServerConfig::* const offset) : vptr(offset) + const std::string TheUserUID; + ConfigReaderThread(const std::string &useruid) + : Config(new ServerConfig), done(false), TheUserUID(useruid) { } - /** Change value to type T of size s */ - void Set(ServerConfig* conf, const T& value) + virtual ~ConfigReaderThread() { - conf->*vptr = value; + delete Config; } - void Set(ServerConfig* conf, const ValueItem& item); + void Run() CXX11_OVERRIDE; + /** Run in the main thread to apply the configuration */ + void Finish(); + bool IsDone() { return done; } }; -class ValueContainerLimit : public ValueContainerBase +/** Represents the status of a config load. */ +class CoreExport ConfigStatus { - size_t ServerLimits::* const vptr; public: - /** Initialize with a value of type T */ - ValueContainerLimit(size_t ServerLimits::* const offset) : vptr(offset) - { - } - - /** Change value to type T of size s */ - void Set(ServerConfig* conf, const size_t& value) - { - conf->Limits.*vptr = value; - } -}; - -/** A specialization of ValueContainer to hold a pointer to a bool - */ -typedef ValueContainer ValueContainerBool; - -/** A specialization of ValueContainer to hold a pointer to - * an unsigned int - */ -typedef ValueContainer ValueContainerUInt; - -/** A specialization of ValueContainer to hold a pointer to - * a char array. - */ -typedef ValueContainer ValueContainerString; - -/** A specialization of ValueContainer to hold a pointer to - * an int - */ -typedef ValueContainer ValueContainerInt; - -/** A set of ValueItems used by multi-value validator functions - */ -typedef std::deque ValueList; - -/** A callback for validating a single value - */ -typedef bool (*Validator)(ServerConfig* conf, const char*, const char*, ValueItem&); -/** A callback for validating multiple value entries - */ -typedef bool (*MultiValidator)(ServerConfig* conf, const char*, const char**, ValueList&, int*); -/** A callback indicating the end of a group of entries - */ -typedef bool (*MultiNotify)(ServerConfig* conf, const char*); + /** Whether this is the initial config load. */ + bool const initial; -/** Holds a core configuration item and its callbacks - */ -struct InitialConfig -{ - /** Tag name */ - const char* tag; - /** Value name */ - const char* value; - /** Default, if not defined */ - const char* default_value; - /** Value containers */ - ValueContainerBase* val; - /** Data types */ - int datatype; - /** Validation function */ - Validator validation_function; -}; + /** The user who initiated the config load or NULL if not initiated by a user. */ + User* const srcuser; -/** Represents a deprecated configuration tag. - */ -struct Deprecated -{ - /** Tag name + /** Initializes a new instance of the ConfigStatus class. + * @param user The user who initiated the config load or NULL if not initiated by a user. + * @param isinitial Whether this is the initial config load. */ - const char* tag; - /** Tag value - */ - const char* value; - /** Reason for deprecation - */ - const char* reason; -}; - -/** Holds a core configuration item and its callbacks - * where there may be more than one item - */ -struct MultiConfig -{ - /** Tag name */ - const char* tag; - /** One or more items within tag */ - const char* items[MAX_VALUES_PER_TAG]; - /** One or more defaults for items within tags */ - const char* items_default[MAX_VALUES_PER_TAG]; - /** One or more data types */ - int datatype[MAX_VALUES_PER_TAG]; - /** Validation function */ - MultiValidator validation_function; + ConfigStatus(User* user = NULL, bool isinitial = false) + : initial(isinitial) + , srcuser(user) + { + } }; - -#endif