X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fconfigreader.h;h=3d01d7e9168ec01ec7a41e653cff71cf6b4971c6;hb=ab8305ad99d7bb7d2cfe4154b2deb007546d5b70;hp=893259b7c0d001f04ae104387b5763e0ffb64cae;hpb=de25d946733f774e3a5b53a58438a9c92af0acbe;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/configreader.h b/include/configreader.h index 893259b7c..3d01d7e91 100644 --- a/include/configreader.h +++ b/include/configreader.h @@ -2,7 +2,7 @@ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * - * InspIRCd: (C) 2002-2009 InspIRCd Development Team + * InspIRCd: (C) 2002-2010 InspIRCd Development Team * See: http://wiki.inspircd.org/Credits * * This program is free but copyrighted software; see @@ -14,13 +14,6 @@ #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(m) (ServerInstance->Config->ExemptChanOps[(unsigned char)m]) - #include #include #include @@ -30,41 +23,43 @@ #include "socketengine.h" #include "socket.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; + std::vector 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 = ""); + /** Get the value of an option, using def if it does not exist */ + long getInt(const std::string& key, long def = 0); + /** 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); }; -/** 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. */ @@ -114,45 +109,100 @@ class ServerLimits } }; -/** 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. + /** 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::vector include_stack; + bool nofork; - /* classes removed by this rehash */ - std::vector removed_classes; + /** 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; - /** This private method processes one line of - * configutation, appending errors to errorstream - * and setting error if an error has occured. + /** 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 ParseLine(const std::string &filename, std::string &line, long &linenumber, bool allowexeinc); + bool writelog; - /** Check that there is only one of each configuration item + /** True if we have been told to run the testsuite from the commandline, + * rather than entering the mainloop. */ - bool CheckOnce(const char* tag); + bool TestSuite; + + /** Saved argc from startup + */ + int argc; + + /** Saved argv from startup + */ + char** argv; + + std::string startup_log; +}; + +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(); + + inline const char* NameStr() + { + return irc::Spacify(name.c_str()); + } +}; + +/** 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); 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 + * @param offset get the Nth occurance of the tag */ - bool DoInclude(const std::string &file, bool allowexeinc); + ConfigTag* ConfValue(const std::string& tag); + + ConfigTagList ConfTags(const std::string& tag); /** Error stream, contains error output from any failed configuration parsing. */ @@ -161,17 +211,9 @@ class CoreExport ServerConfig : public classbase /** 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; - /** 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 }; - /** 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, * it's indexed by tag name to a vector of key/values. */ @@ -181,6 +223,10 @@ class CoreExport ServerConfig : public classbase */ 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) */ @@ -204,11 +250,6 @@ class CoreExport ServerConfig : public classbase */ int WhoWasMaxKeep; - /** Both for set(g|u)id. - */ - std::string SetUser; - std::string SetGroup; - /** Holds the server name of the local server * as defined by the administrator. */ @@ -311,7 +352,6 @@ class CoreExport ServerConfig : public classbase /** This variable identifies which usermodes have been diabled. */ - char DisabledUModes[64]; /** This variable identifies which chanmodes have been disabled. @@ -321,48 +361,10 @@ class CoreExport ServerConfig : public classbase /** 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. */ std::string ModPath; - /** The full pathname to the executable, as - * given in argv[0] when the program starts. - */ - std::string MyExecutable; - - /** 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; - /** 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. @@ -374,22 +376,12 @@ class CoreExport ServerConfig : public classbase */ 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 * 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. */ @@ -417,20 +409,6 @@ 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; @@ -489,10 +467,6 @@ class CoreExport ServerConfig : public classbase */ std::string UserStats; - /** The path and filename of the ircd.log file - */ - std::string logpath; - /** Default channel modes */ std::string DefaultModes; @@ -509,10 +483,6 @@ class CoreExport ServerConfig : public classbase */ 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; @@ -536,21 +506,10 @@ class CoreExport ServerConfig : public classbase */ bool FullHostInTopic; - /** All oper type definitions from the config file - */ - opertype_t opertypes; - - /** All oper class definitions from the config file - */ - operclass_t operclass; - - /** Saved argv from startup - */ - char** argv; - - /** Saved argc from startup + /** Oper block and type index. + * For anonymous oper blocks (type only), prefix with a space. */ - int argc; + OperIndex oper_blocks; /** Max channels per user */ @@ -567,11 +526,6 @@ 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(); @@ -599,93 +553,18 @@ class CoreExport ServerConfig : public classbase void Apply(ServerConfig* old, const std::string &useruid); void ApplyModules(User* user); + void Fill(); + /** Read a file into a file_cache object */ - bool ReadFile(file_cache &F, const char* fname); + bool ReadFile(file_cache &F, const std::string& 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); - /** Returns the fully qualified path to the inspircd directory - * @return The full program directory - */ - std::string GetFullProgDir(); - /** Clean a filename, stripping the directories (and drives) from string. * @param name Directory to tidy * @return The cleaned filename @@ -704,194 +583,29 @@ class CoreExport ServerConfig : public classbase }; - -/** 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. +/** The background thread for config reading, so that reading from executable includes + * does not block. */ -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) - { - } - - /** 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); -}; - -class ValueContainerLimit : public ValueContainerBase +class CoreExport ConfigReaderThread : public Thread { - size_t ServerLimits::* const vptr; + ServerConfig* Config; + volatile bool done; public: - /** Initialize with a value of type T */ - ValueContainerLimit(size_t ServerLimits::* 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 size_t& value) + virtual ~ConfigReaderThread() { - conf->Limits.*vptr = value; + delete Config; } -}; - -/** 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*); - -/** 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]; - /** Validation function */ - MultiValidator validation_function; + void Run(); + /** Run in the main thread to apply the configuration */ + void Finish(); + bool IsDone() { return done; } }; #endif