X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fconfigreader.h;h=b5e6a887b4925e6709db13dfc2144192eb712f0a;hb=7b08be5752bb91d495f324f97b346976d669ad90;hp=787bcb243f3b65a3433b6ac851ed3be70a209a51;hpb=f209cce90b394acd26e22eacef0bff61e8f5b4e1;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/configreader.h b/include/configreader.h index 787bcb243..b5e6a887b 100644 --- a/include/configreader.h +++ b/include/configreader.h @@ -3,7 +3,7 @@ * +------------------------------------+ * * InspIRCd: (C) 2002-2009 InspIRCd Development Team - * See: http://www.inspircd.org/wiki/index.php/Credits + * See: http://wiki.inspircd.org/Credits * * This program is free but copyrighted software; see * the file COPYING for details. @@ -32,199 +32,13 @@ /* Required forward definitions */ class ServerConfig; +class ServerLimits; 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 */ - DT_BOOTONLY = 256 /* Can only be set on startup, not on rehash */ -}; - -/** 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 -{ - public: - /** Constructor */ - ValueContainerBase() { } - /** Destructor */ - virtual ~ValueContainerBase() { } -}; - -/** 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; +typedef std::map opertype_t; /** Holds an oper class. */ @@ -319,42 +133,37 @@ class CoreExport ServerConfig : public Extensible */ 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(ConfigDataHash &target, const std::string &filename, std::string &line, long &linenumber, std::ostringstream &errorstream); + 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, ConfigDataHash &newconf); + bool CheckOnce(const char* tag); + + void CrossCheckOperClassType(); + void CrossCheckConnectBlocks(ServerConfig* current); public: /** Process an include executable directive */ - bool DoPipe(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream); + bool DoPipe(const std::string &file); /** Process an include file directive */ - bool DoInclude(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream); - - /** User that is currently performing a rehash, needed because the - * rehash code is now threaded and needs to know who to give errors and feedback to. - */ - std::string RehashUserUID; - - /** Rehash parameter, as above - */ - std::string RehashParameter; + bool DoInclude(const std::string &file); /** Error stream, contains error output from any failed configuration parsing. */ - std::ostringstream* errstr; + std::stringstream errstr; - /** Holds the new configuration when a rehash occurs so we dont overwrite the existing - * working config with a broken one without checking it first and swapping pointers. - */ - ConfigDataHash newconfig; + /** True if this configuration is valid enough to run with */ + bool valid; /** Set of included files. Do we use this any more? */ @@ -363,9 +172,6 @@ class CoreExport ServerConfig : public Extensible /** 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(); @@ -525,12 +331,12 @@ class CoreExport ServerConfig : public Extensible * overridden in the configuration file via * the tag. */ - char ModPath[1024]; + std::string ModPath; /** The full pathname to the executable, as * given in argv[0] when the program starts. */ - char MyExecutable[1024]; + std::string MyExecutable; /** The file handle of the logfile. If this * value is NULL, the log file is not open, @@ -670,16 +476,12 @@ class CoreExport ServerConfig : public Extensible /** 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; - /** A list of the classes for listening ports - */ - std::vector ports; - /** The 005 tokens of this server (ISUPPORT) * populated/repopulated upon loading or unloading * modules. @@ -782,10 +584,6 @@ class CoreExport ServerConfig : public Extensible */ ServerConfig(InspIRCd* Instance); - /** Clears the include stack in preperation for a Read() call. - */ - void ClearStack(); - /** Get server ID as string with required leading zeroes */ std::string GetSID(); @@ -802,7 +600,12 @@ class CoreExport ServerConfig : public Extensible * and initialize this class. All other methods * should be used only by the core. */ - void Read(bool bail, const std::string &useruid); + void Read(); + + /** 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 */ @@ -812,109 +615,85 @@ class CoreExport ServerConfig : public Extensible */ bool StartsWithWindowsDriveLetter(const std::string &path); - /** Report a configuration error given in errormessage. - * @param bail If this is set to true, the error is sent to the console, and the program exits - * @param useruid If this is set to a non-empty value which is a valid UID, and bail is false, - * the errors are spooled to this user as SNOTICEs. - * If the parameter is not a valid UID, the messages are spooled to all opers. - */ - void ReportConfigError(const std::string &errormessage, bool bail, const std::string &useruid); - /** 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(ConfigDataHash &target, FILE* &conf, const char* filename, std::ostringstream &errorstream); + 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(ConfigDataHash &target, FILE* &conf, const std::string &filename, std::ostringstream &errorstream); + bool LoadConf(FILE* &conf, const std::string &filename); /** Writes 'length' chars into 'result' as a string */ - bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, int index, char* result, int length, bool allow_linefeeds = false); + 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(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index, char* result, int length, bool allow_linefeeds = false); + 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(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, std::string &result, bool allow_linefeeds = false); + 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(ConfigDataHash &target, const std::string &tag, const std::string &var, const std::string &default_value, int index, std::string &result, bool allow_linefeeds = false); + 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(ConfigDataHash &target, const char* tag, const char* var, int index, int &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(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index, int &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(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, int &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(ConfigDataHash &target, const std::string &tag, const std::string &var, const std::string &default_value, int index, int &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(ConfigDataHash &target, const char* tag, const char* var, int index); + 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(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index); + 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(ConfigDataHash &target, const std::string &tag, const std::string &var, int index); + 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(ConfigDataHash &target, const std::string &tag, const std::string &var, const std::string &default_value, int index); + 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(ConfigDataHash &target, const char* tag); + int ConfValueEnum(const char* tag); /** Returns the number of occurences of tag in the config file */ - int ConfValueEnum(ConfigDataHash &target, const std::string &tag); + int ConfValueEnum(const std::string &tag); /** Returns the numbers of vars inside the index'th 'tag in the config file */ - int ConfVarEnum(ConfigDataHash &target, const char* tag, int index); + int ConfVarEnum(const char* tag, int index); /** Returns the numbers of vars inside the index'th 'tag in the config file */ - int ConfVarEnum(ConfigDataHash &target, const std::string &tag, int index); + 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); + bool ApplyDisabledCommands(const char* data); /** Returns the fully qualified path to the inspircd directory * @return The full program directory */ std::string GetFullProgDir(); - /** Returns true if a directory is valid (within the modules directory). - * @param dirandfile The directory and filename to check - * @return True if the directory is valid - */ - static bool DirValid(const char* dirandfile); - /** Clean a filename, stripping the directories (and drives) from string. * @param name Directory to tidy * @return The cleaned filename @@ -933,50 +712,202 @@ class CoreExport ServerConfig : public Extensible }; -/** Initialize the disabled commands list + +/** Types of data in the core config */ -CoreExport bool InitializeDisabledCommands(const char* data, InspIRCd* ServerInstance); +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 */ +}; -/** Initialize the oper types +/** The maximum number of values in a core configuration tag. Can be increased if needed. */ -bool InitTypes(ServerConfig* conf, const char* tag); +#define MAX_VALUES_PER_TAG 18 -/** Initialize the oper classes +/** 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. */ -bool InitClasses(ServerConfig* conf, const char* tag); +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() { } +}; + +/** 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 +{ + T ServerConfig::* const vptr; + public: + /** Initialize with a value of type T */ + ValueContainer(T ServerConfig::* const offset) : vptr(offset) + { + } -/** Initialize an oper type + /** Change value to type T of size s */ + void Set(ServerConfig* conf, const T& value) + { + conf->*vptr = value; + } + + void Set(ServerConfig* conf, const ValueItem& item); +}; + +template<> void ValueContainer::Set(ServerConfig* conf, ValueItem const& item); + + +class ValueContainerLimit : public ValueContainerBase +{ + 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 */ -bool DoType(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types); +typedef ValueContainer ValueContainerBool; -/** Initialize an oper class +/** A specialization of ValueContainer to hold a pointer to + * an unsigned int */ -bool DoClass(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types); +typedef ValueContainer ValueContainerUInt; -/** Finish initializing the oper types and classes +/** A specialization of ValueContainer to hold a pointer to + * a char array. */ -bool DoneClassesAndTypes(ServerConfig* conf, const char* tag); +typedef ValueContainer ValueContainerChar; +/** 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; -/** Initialize x line +/** A set of ValueItems used by multi-value validator functions */ -bool InitXLine(ServerConfig* conf, const char* tag); +typedef std::deque ValueList; -/** Add a config-defined zline +/** 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 */ -bool DoZLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types); +typedef bool (*MultiNotify)(ServerConfig* conf, const char*); -/** Add a config-defined qline +/** Holds a core configuration item and its callbacks */ -bool DoQLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types); +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; +}; -/** Add a config-defined kline +/** Represents a deprecated configuration tag. */ -bool DoKLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types); +struct Deprecated +{ + /** Tag name + */ + const char* tag; + /** Tag value + */ + const char* value; + /** Reason for deprecation + */ + const char* reason; +}; -/** Add a config-defined eline +/** Holds a core configuration item and its callbacks + * where there may be more than one item */ -bool DoELine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types); +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; +}; #endif