X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fconfigreader.h;h=0d514e41d3d12a37013bf8e5d07d5d41fd17f834;hb=4509cbcc0b57f9f397af26f5e8dbe629499c2b24;hp=36e5badfd0c455a80acd4f8f22cdb8fe612d0786;hpb=c384697c88aa54b5a532cd2edce3c063c70d7868;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/configreader.h b/include/configreader.h index 36e5badfd..0d514e41d 100644 --- a/include/configreader.h +++ b/include/configreader.h @@ -1,25 +1,27 @@ -/* +------------------------------------+ - * | 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) 2009 Daniel De Graaf + * Copyright (C) 2007, 2009 Dennis Friis + * Copyright (C) 2006-2008 Craig Edwards + * Copyright (C) 2006-2008 Robin Burchell + * Copyright (C) 2006 Oliver Lupton * - * 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 - -/* handy defines */ -/** Determines if a channel op is exempt from given mode m, - * in config of server instance s. - */ -#define CHANOPS_EXEMPT(s, m) (s->Config->ExemptChanOps[(unsigned char)m]) +#pragma once #include #include @@ -30,230 +32,47 @@ #include "socketengine.h" #include "socket.h" -/* Required forward definitions */ -class ServerConfig; -class InspIRCd; -class BufferedSocket; - -/** 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_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 char pointer */ - ValueItem(const char* value); - /** Change value to a char pointer */ - void Set(const char* val); - /** Change value to an int */ - void Set(int value); - /** Get value as an int */ - int GetInteger(); - /** Get value as a string */ - char* GetString(); - /** 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 +/** Structure representing a single \ in config */ +class CoreExport ConfigTag : public refcountbase { + std::vector items; public: - /** Constructor */ - ValueContainerBase() { } - /** Destructor */ - virtual ~ValueContainerBase() { } + 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 = ""); + /** Get the value of an option, using def if it does not exist */ + long getInt(const std::string& key, long def = 0, long min = LONG_MIN, long max = LONG_MAX); + /** Get the value of an option, using def if it does not exist */ + double getFloat(const std::string& key, double def = 0); + /** 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 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 std::vector& getItems() const { return items; } + + /** Create a new ConfigTag, giving access to the private KeyVal item list */ + static ConfigTag* create(const std::string& Tag, const std::string& file, int line, + std::vector*&items); + private: + ConfigTag(const std::string& Tag, const std::string& file, int line); }; -/** 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. - */ -template class ValueContainer : public ValueContainerBase -{ - /** Contained item */ - T val; - public: - - /** Initialize with nothing */ - ValueContainer() - { - val = NULL; - } - - /** Initialize with a value of type T */ - ValueContainer(T Val) - { - val = Val; - } - - /** Change value to type T of size s */ - void Set(T newval, size_t s) - { - memcpy(val, newval, s); - } -}; - -/** 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 ValueContainerChar; - -/** A specialization of ValueContainer to hold a pointer to - * an int - */ -typedef ValueContainer ValueContainerInt; - -/** A specialization of ValueContainer to hold a pointer to - * a size_t. - */ -typedef ValueContainer ValueContainerST; - -/** 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*, char**, ValueList&, int*); -/** A callback indicating the end of a group of entries - */ -typedef bool (*MultiNotify)(ServerConfig* conf, const char*); - -/** 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; -}; - -/** Represents a deprecated configuration tag. - */ -struct Deprecated -{ - /** Tag name - */ - 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]; - /** Initialization function */ - MultiNotify init_function; - /** Validation function */ - MultiValidator validation_function; - /** Completion function */ - MultiNotify finish_function; -}; - -/** A set of oper types - */ -typedef std::map opertype_t; - -/** Holds an oper class. - */ -struct operclass_data : public Extensible -{ - /** Command list for the class - */ - char *commandlist; - - /** Channel mode list for the class - */ - char *cmodelist; - - /** User mode list for the class - */ - char *umodelist; - - /** Priviledges given by this class - */ - char *privs; -}; - -/** 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 Extensible +class ServerLimits { public: /** Maximum nickname length */ @@ -274,29 +93,83 @@ class ServerLimits : public Extensible size_t MaxGecos; /** Maximum away message length */ size_t MaxAway; + /** Maximum line length */ + size_t MaxLine; /** 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. */ - ServerLimits() : NickMax(31), ChanMax(64), MaxModes(20), IdentMax(12), MaxQuit(255), MaxTopic(307), MaxKick(255), MaxGecos(128), MaxAway(200) - { - } + ServerLimits() : NickMax(31), ChanMax(64), MaxModes(20), IdentMax(12), + MaxQuit(255), MaxTopic(307), MaxKick(255), MaxGecos(128), MaxAway(200), + MaxLine(512) { } +}; - /** 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. +struct CommandLineConf +{ + /** If this value is true, the owner of the + * server specified -nofork on the command + * line, causing the daemon to stay in the + * foreground. */ - void Finalise() - { - NickMax++; - ChanMax++; - IdentMax++; - MaxQuit++; - MaxTopic++; - MaxKick++; - MaxGecos++; - MaxAway++; - } + bool nofork; + + /** 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. + */ + bool forcedebug; + + /** 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. + */ + bool writelog; + + /** True if we have been told to run the testsuite from the commandline, + * rather than entering the mainloop. + */ + bool TestSuite; + + /** Saved argc from startup + */ + int argc; + + /** Saved argv from startup + */ + char** argv; +}; + +class CoreExport OperInfo : public refcountbase +{ + public: + std::set AllowedOperCommands; + std::set AllowedPrivs; + + /** Allowed user modes from oper classes. */ + std::bitset<64> AllowedUserModes; + + /** Allowed channel modes from oper classes. */ + std::bitset<64> AllowedChanModes; + + /** \ 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; + + /** Get a configuration item, searching in the oper, type, and class blocks (in that order) */ + std::string getConfig(const std::string& key); + void init(); }; /** This class holds the bulk of the runtime configuration for the ircd. @@ -304,73 +177,53 @@ class ServerLimits : public Extensible * 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 Extensible +class CoreExport ServerConfig { private: - /** Creator/owner pointer - */ - InspIRCd* ServerInstance; - - /** 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; - - /** 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); - - /** 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 + /** Get a configuration tag + * @param tag The name of the tag to get */ - bool DoInclude(const std::string &file); + ConfigTag* ConfValue(const std::string& tag); + + ConfigTagList ConfTags(const std::string& tag); /** Error stream, contains error output from any failed configuration parsing. */ - std::ostringstream errstr; + std::stringstream errstr; /** True if this configuration is valid enough to run with */ bool valid; - /** Set of included files. Do we use this any more? - */ - std::map IncludedFiles; + /** Bind to IPv6 by default */ + bool WildcardIPv6; /** 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 }; - - /** Pointer to function that validates dns server addresses (can be changed depending on platform) */ - Validator DNSServerValidator; - - /** Returns the creator InspIRCd pointer - */ - InspIRCd* GetInstance(); - - /** Not used any more as it is named, can probably be removed or renamed. - */ - int DoDownloads(); + enum OperSpyWhoisState { SPYWHOIS_NONE, SPYWHOIS_SINGLEMSG, SPYWHOIS_SPLITMSG }; /** This holds all the information in the config file, * it's indexed by tag name to a vector of key/values. */ ConfigDataHash config_data; + /** This holds all extra files that have been read in the configuration + * (for example, MOTD and RULES files are stored here) + */ + ConfigFileCache Files; + /** Length limits, see definition of ServerLimits class */ ServerLimits Limits; + /** Configuration parsed from the command line. + */ + CommandLineConf cmdline; + /** Clones CIDR range for ipv4 (0-32) * Defaults to 32 (checks clones on all IPs seperately) */ @@ -381,113 +234,86 @@ class CoreExport ServerConfig : public Extensible */ int c_ipv6_range; - /** Max number of WhoWas entries per user. - */ - int WhoWasGroupSize; - - /** Max number of cumulative user-entries in WhoWas. - * When max reached and added to, push out oldest entry FIFO style. - */ - int WhoWasMaxGroups; - - /** Max seconds a user is kept in WhoWas before being pruned. - */ - int WhoWasMaxKeep; - - /** Both for set(g|u)id. - */ - char SetUser[MAXBUF]; - char SetGroup[MAXBUF]; - /** Holds the server name of the local server * as defined by the administrator. */ - char ServerName[MAXBUF]; + std::string ServerName; - /** Notice to give to users when they are Xlined + /** Notice to give to users when they are banned by an XLine */ - char MoronBanner[MAXBUF]; + std::string XLineMessage; /* Holds the network name the local server * belongs to. This is an arbitary field defined * by the administrator. */ - char Network[MAXBUF]; + std::string Network; /** Holds the description of the local server * as defined by the administrator. */ - char ServerDesc[MAXBUF]; + std::string ServerDesc; /** Holds the admin's name, for output in * the /ADMIN command. */ - char AdminName[MAXBUF]; + std::string AdminName; /** Holds the email address of the admin, * for output in the /ADMIN command. */ - char AdminEmail[MAXBUF]; + std::string AdminEmail; /** Holds the admin's nickname, for output * in the /ADMIN command */ - char AdminNick[MAXBUF]; + std::string AdminNick; /** The admin-configured /DIE password */ - char diepass[MAXBUF]; + std::string diepass; /** The admin-configured /RESTART password */ - char restartpass[MAXBUF]; + std::string restartpass; /** The hash method for *BOTH* the die and restart passwords. */ - char powerhash[MAXBUF]; + std::string powerhash; /** The pathname and filename of the message of the * day file, as defined by the administrator. */ - char motd[MAXBUF]; + std::string motd; /** The pathname and filename of the rules file, * as defined by the administrator. */ - char rules[MAXBUF]; + std::string rules; /** The quit prefix in use, or an empty string */ - char PrefixQuit[MAXBUF]; + std::string PrefixQuit; /** The quit suffix in use, or an empty string */ - char SuffixQuit[MAXBUF]; + std::string SuffixQuit; /** The fixed quit message in use, or an empty string */ - char FixedQuit[MAXBUF]; + std::string FixedQuit; /** The part prefix in use, or an empty string */ - char PrefixPart[MAXBUF]; + std::string PrefixPart; /** The part suffix in use, or an empty string */ - char SuffixPart[MAXBUF]; + std::string SuffixPart; /** The fixed part message in use, or an empty string */ - char FixedPart[MAXBUF]; - - /** The last string found within a tag, or - * an empty string. - */ - char DieValue[MAXBUF]; - - /** The DNS server to use for DNS queries - */ - char DNSServer[MAXBUF]; + std::string FixedPart; /** Pretend disabled commands don't exist. */ @@ -497,11 +323,10 @@ class CoreExport ServerConfig : public Extensible * of commands which are disabled by the * administrator of the server for non-opers. */ - char DisabledCommands[MAXBUF]; + std::string DisabledCommands; /** This variable identifies which usermodes have been diabled. */ - char DisabledUModes[64]; /** This variable identifies which chanmodes have been disabled. @@ -511,47 +336,9 @@ class CoreExport ServerConfig : public Extensible /** The full path to the modules directory. * This is either set at compile time, or * overridden in the configuration file via - * the tag. + * the \ tag. */ - char ModPath[1024]; - - /** The full pathname to the executable, as - * given in argv[0] when the program starts. - */ - char MyExecutable[1024]; - - /** 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; - - /** If this value is true, the owner of the - * server specified -nofork on the command - * line, causing the daemon to stay in the - * foreground. - */ - bool nofork; - - /** 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. - */ - bool forcedebug; - - /** 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. - */ - bool writelog; + std::string ModPath; /** If set to true, then all opers on this server are * shown with a generic 'is an IRC operator' line rather @@ -564,22 +351,12 @@ class CoreExport ServerConfig : public Extensible */ bool RestrictBannedUsers; - /** If this value is true, halfops have been - * enabled in the configuration file. - */ - bool AllowHalfop; - /** If this is set to true, then mode lists (e.g - * MODE #chan b) are hidden from unprivileged + * MODE \#chan b) are hidden from unprivileged * users. */ bool HideModeLists[256]; - /** If this is set to true, then channel operators - * are exempt from this channel mode. Used for +Sc etc. - */ - bool ExemptChanOps[256]; - /** The number of seconds the DNS subsystem * will wait before timing out any request. */ @@ -596,6 +373,13 @@ class CoreExport ServerConfig : public Extensible */ 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. @@ -607,20 +391,6 @@ class CoreExport ServerConfig : public Extensible */ 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; @@ -637,110 +407,68 @@ class CoreExport ServerConfig : public Extensible /** If this is enabled then operators will * see invisible (+i) channels in /whois. */ - bool OperSpyWhois; + OperSpyWhoisState OperSpyWhois; + + /** True if raw I/O is being logged */ + bool RawLog; /** Set to a non-empty string to obfuscate the server name of users in WHOIS */ - char HideWhoisServer[MAXBUF]; + std::string HideWhoisServer; /** Set to a non empty string to obfuscate nicknames prepended to a KILL. */ - char HideKillsServer[MAXBUF]; - - /** The MOTD file, cached in a file_cache type. - */ - file_cache MOTD; - - /** The RULES file, cached in a file_cache type. - */ - file_cache RULES; + std::string HideKillsServer; /** The full pathname and filename of the PID * file as defined in the configuration. */ - char PID[1024]; + std::string PID; /** The connect classes in use by the IRC server. */ 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. */ - char UserStats[MAXBUF]; - - /** The path and filename of the ircd.log file - */ - std::string logpath; + std::string UserStats; /** Default channel modes */ - char DefaultModes[MAXBUF]; + std::string DefaultModes; /** Custom version string, which if defined can replace the system info in VERSION. */ - char CustomVersion[MAXBUF]; + 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. + /** If set to true, the CycleHosts mode change will be sourced from the user, + * rather than the server */ - bool CycleHosts; + bool CycleHostsFromUser; /** 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 block and type index. + * For anonymous oper blocks (type only), prefix with a space. */ - opertype_t opertypes; - - /** All oper class definitions from the config file - */ - operclass_t operclass; - - /** Saved argv from startup - */ - char** argv; - - /** Saved argc from startup - */ - int argc; + OperIndex oper_blocks; /** Max channels per user */ @@ -755,32 +483,15 @@ class CoreExport ServerConfig : public Extensible * makes code simpler. 0AA, 1BB etc with letters are reserved * for services use. */ - char sid[MAXBUF]; - - /** True if we have been told to run the testsuite from the commandline, - * rather than entering the mainloop. - */ - bool TestSuite; + std::string sid; /** Construct a new ServerConfig */ - ServerConfig(InspIRCd* Instance); - - /** Clears the include stack in preperation for a Read() call. - */ - void ClearStack(); + ServerConfig(); /** Get server ID as string with required leading zeroes */ - std::string GetSID(); - - /** Update the 005 vector - */ - void Update005(); - - /** Send the 005 numerics (ISUPPORT) to a user - */ - void Send005(User* user); + const std::string& GetSID() const { return sid; } /** Read the entire configuration into memory * and initialize this class. All other methods @@ -791,170 +502,64 @@ class CoreExport ServerConfig : public Extensible /** Apply configuration changes from the old configuration. */ 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); + void Fill(); - /* Returns true if the given string starts with a windows drive letter + /** Returns true if the given string starts with a windows drive letter */ bool StartsWithWindowsDriveLetter(const std::string &path); - /** Report a configuration error given in errormessage. - */ - void ReportConfigError(const std::string &errormessage); - - /** 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); - - /** 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); - - /** 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); - - /** Validates a hostname value, throwing ConfigException if it is not valid - */ - void ValidateHostname(const char* p, const std::string &tag, const std::string &val); - - /** Validates an IP address value, throwing ConfigException if it is not valid - */ - void ValidateIP(const char* p, const std::string &tag, const std::string &val, bool wild); - - /** Validates a value that should not contain spaces, throwing ConfigException of it is not valid - */ - void ValidateNoSpaces(const char* p, const std::string &tag, const std::string &val); - - /** Returns the fully qualified path to the inspircd directory - * @return The full program directory - */ - std::string GetFullProgDir(); + 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 char* CleanFilename(char* name); + static const char* CleanFilename(const char* name); /** Check if a file exists. * @param file The full path to a file * @return True if the file exists and is readable. */ static bool FileExists(const char* file); + + /** 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 std::string Escape(const std::string& str, bool xml = true); /** If this value is true, invites will bypass more than just +i */ bool InvBypassModes; + /** If this value is true, snotices will not stack when repeats are sent + */ + bool NoSnoticeStack; }; -/** Initialize the disabled commands list - */ -CoreExport bool InitializeDisabledCommands(const char* data, InspIRCd* ServerInstance); - -/** Initialize the oper types - */ -bool InitTypes(ServerConfig* conf, const char* tag); - -/** Initialize the oper classes - */ -bool InitClasses(ServerConfig* conf, const char* tag); - -/** Initialize an oper type - */ -bool DoType(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types); - -/** Initialize an oper class - */ -bool DoClass(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types); - -/** Finish initializing the oper types and classes - */ -bool DoneClassesAndTypes(ServerConfig* conf, const char* tag); - - - -/** Initialize x line +/** The background thread for config reading, so that reading from executable includes + * does not block. */ -bool InitXLine(ServerConfig* conf, const char* tag); - -/** Add a config-defined zline - */ -bool DoZLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types); - -/** Add a config-defined qline - */ -bool DoQLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types); - -/** Add a config-defined kline - */ -bool DoKLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types); +class CoreExport ConfigReaderThread : public Thread +{ + ServerConfig* Config; + volatile bool done; + public: + const std::string TheUserUID; + ConfigReaderThread(const std::string &useruid) + : Config(new ServerConfig), done(false), TheUserUID(useruid) + { + } -/** Add a config-defined eline - */ -bool DoELine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types); + virtual ~ConfigReaderThread() + { + delete Config; + } -#endif + void Run(); + /** Run in the main thread to apply the configuration */ + void Finish(); + bool IsDone() { return done; } +};