X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fconfigreader.h;h=859e5bddb87b1a64c97576c7afc70262ed75a163;hb=9175a3799dbf1e0809fb1bb540ca715243c0be2a;hp=af9c33533b02649c64065d4d4cd5b6d973aeb0d4;hpb=61fed23a3e9a62f19c2f88208585b31356c986ef;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/configreader.h b/include/configreader.h index af9c33533..859e5bddb 100644 --- a/include/configreader.h +++ b/include/configreader.h @@ -149,6 +149,9 @@ typedef ValueContainer ValueContainerChar; */ 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 @@ -183,10 +186,18 @@ struct InitialConfig 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; }; @@ -215,32 +226,57 @@ struct MultiConfig */ typedef std::map opertype_t; +/** Holds an oper class. + */ struct operclass_data : public Extensible { - char* commandlist; - char* cmodelist; - char* umodelist; + /** 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 { public: + /** Maximum nickname length */ size_t NickMax; + /** Maximum channel length */ size_t ChanMax; + /** Maximum number of modes per line */ size_t MaxModes; + /** Maximum length of ident, not including ~ etc */ size_t IdentMax; + /** Maximum length of a quit message */ size_t MaxQuit; + /** Maximum topic length */ size_t MaxTopic; + /** Maximum kick message length */ size_t MaxKick; + /** Maximum GECOS (real name) length */ size_t MaxGecos; + /** Maximum away message length */ size_t MaxAway; - /* Creating the class initialises it to the defaults + /** 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. */ @@ -248,6 +284,9 @@ class ServerLimits : public Extensible { } + /** 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++; @@ -299,14 +338,26 @@ class CoreExport ServerConfig : public Extensible */ bool DoInclude(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream); - User* RehashUser; + /** 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; - std::ostringstream errstr; + /** Error stream, contains error output from any failed configuration parsing. + */ + std::ostringstream* 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; + /** Set of included files. Do we use this any more? + */ std::map IncludedFiles; /** Used to indicate who we announce invites to on a channel */ @@ -315,8 +366,12 @@ class CoreExport ServerConfig : public Extensible /** 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(); /** This holds all the information in the config file, @@ -324,6 +379,8 @@ class CoreExport ServerConfig : public Extensible */ ConfigDataHash config_data; + /** Length limits, see definition of ServerLimits class + */ ServerLimits Limits; /** Clones CIDR range for ipv4 (0-32) @@ -349,6 +406,11 @@ class CoreExport ServerConfig : public Extensible */ 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. */ @@ -603,9 +665,9 @@ class CoreExport ServerConfig : public Extensible */ ClassVector Classes; - /** A list of the classes for listening client ports + /** A list of the classes for listening ports */ - std::vector ports; + std::vector ports; /** The 005 tokens of this server (ISUPPORT) * populated/repopulated upon loading or unloading @@ -729,7 +791,7 @@ class CoreExport ServerConfig : public Extensible * and initialize this class. All other methods * should be used only by the core. */ - void Read(bool bail, User* user); + void Read(bool bail, const std::string &useruid); /** Read a file into a file_cache object */ @@ -741,11 +803,11 @@ class CoreExport ServerConfig : public Extensible /** 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 user If this is set to a non-null value, and bail is false, the errors are spooled to - * this user as SNOTICEs. - * If the parameter is NULL, the messages are spooled to all opers. + * @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, User* user); + 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. @@ -757,11 +819,10 @@ class CoreExport ServerConfig : public Extensible */ bool LoadConf(ConfigDataHash &target, FILE* &conf, const std::string &filename, std::ostringstream &errorstream); - /* Both these return true if the value existed or false otherwise */ - /** 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); + /** 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); @@ -769,6 +830,7 @@ class CoreExport ServerConfig : public Extensible /** 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); + /** 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); @@ -776,12 +838,15 @@ class CoreExport ServerConfig : public Extensible /** 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); + /** 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); + /** 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); + /** 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); @@ -789,12 +854,15 @@ class CoreExport ServerConfig : public Extensible /** 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); + /** 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); + /** 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); + /** 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); @@ -813,10 +881,16 @@ class CoreExport ServerConfig : public Extensible */ int ConfVarEnum(ConfigDataHash &target, 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