X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fconfigreader.h;h=402f984e8a1695d88640b957f3f0efa414e419b4;hb=a59d08fffd3dc8a9850ce34c9928fb6382b9b37f;hp=51eb2f5fd9098b8661cfd25c2b5c09f635b2e163;hpb=a67b9de1742efbff29ec08093b220565eab7df23;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/configreader.h b/include/configreader.h index 51eb2f5fd..402f984e8 100644 --- a/include/configreader.h +++ b/include/configreader.h @@ -2,8 +2,8 @@ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * - * InspIRCd: (C) 2002-2008 InspIRCd Development Team - * See: http://www.inspircd.org/wiki/index.php/Credits + * InspIRCd: (C) 2002-2009 InspIRCd Development Team + * See: http://wiki.inspircd.org/Credits * * This program is free but copyrighted software; see * the file COPYING for details. @@ -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(s, m) (s->Config->ExemptChanOps[(unsigned char)m]) - #include #include #include @@ -32,215 +25,70 @@ /* 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. +/** A cached text file stored with its contents as lines */ -#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(); -}; +typedef std::vector file_cache; -/** The base class of the container 'ValueContainer' - * used internally by the core to hold core values. +/** A configuration key and value pair */ -class ValueContainerBase -{ - public: - /** Constructor */ - ValueContainerBase() { } - /** Destructor */ - virtual ~ValueContainerBase() { } -}; +typedef std::pair KeyVal; -/** 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 +struct CoreExport ConfigTag : public refcountbase { - /** Contained item */ - T val; - public: - - /** Initialize with nothing */ - ValueContainer() - { - val = NULL; - } + const std::string tag; + const std::string src_name; + const int src_line; + std::vector items; - /** 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; - -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*); + ConfigTag(const std::string& Tag, const std::string& file, int line) + : tag(Tag), src_name(file), src_line(line) {} -/** 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; -}; + std::string getString(const std::string& key, const std::string& def = ""); + long getInt(const std::string& key, long def = 0); + double getFloat(const std::string& key, double def = 0); + bool getBool(const std::string& key, bool def = false); -struct Deprecated -{ - const char* tag; - const char* value; - const char* reason; -}; + bool readString(const std::string& key, std::string& value, bool allow_newline = false); -/** 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; + std::string getTagLocation(); }; -/** A set of oper types +/** An entire config file, built up of KeyValLists */ -typedef std::map opertype_t; +typedef std::multimap > ConfigDataHash; -struct operclass_data : public Extensible -{ - char* commandlist; - char* cmodelist; - char* umodelist; -}; +typedef std::map > TagIndex; -/** A Set of oper classes +/** Defines the server's length limits on various length-limited + * items such as topics, nicknames, channel names etc. */ -typedef std::map operclass_t; - - -class ServerLimits : public Extensible +class ServerLimits { 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 +96,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++; @@ -266,64 +117,34 @@ 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(ConfigDataHash &target, const std::string &filename, std::string &line, long &linenumber, std::ostringstream &errorstream); - - /** Check that there is only one of each configuration item - */ - bool CheckOnce(const char* tag, ConfigDataHash &newconf); + void CrossCheckOperClassType(); + void CrossCheckConnectBlocks(ServerConfig* current); public: - /** Process an include executable directive - */ - bool DoPipe(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream); - - /** Process an include file directive + /** Error stream, contains error output from any failed configuration parsing. */ - bool DoInclude(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream); - - User* RehashUser; - - std::string RehashParameter; + std::stringstream errstr; - std::ostringstream errstr; - - ConfigDataHash newconfig; - - std::map IncludedFiles; + /** True if this configuration is valid enough to run with */ + bool valid; /** 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; - - 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, * it's indexed by tag name to a vector of key/values. */ ConfigDataHash config_data; + /** Length limits, see definition of ServerLimits class + */ ServerLimits Limits; /** Clones CIDR range for ipv4 (0-32) @@ -349,101 +170,110 @@ class CoreExport ServerConfig : public Extensible */ 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. */ - char ServerName[MAXBUF]; + std::string ServerName; /** Notice to give to users when they are Xlined */ - char MoronBanner[MAXBUF]; - + std::string MoronBanner; + /* 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]; + std::string FixedPart; /** The last string found within a tag, or * an empty string. */ - char DieValue[MAXBUF]; + std::string DieValue; /** The DNS server to use for DNS queries */ - char DNSServer[MAXBUF]; + std::string DNSServer; + + /** Pretend disabled commands don't exist. + */ + bool DisabledDontExist; /** This variable contains a space-seperated list * 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. */ @@ -459,12 +289,7 @@ class CoreExport ServerConfig : public Extensible * overridden in the configuration file via * the tag. */ - char ModPath[1024]; - - /** The full pathname to the executable, as - * given in argv[0] when the program starts. - */ - char MyExecutable[1024]; + std::string ModPath; /** The file handle of the logfile. If this * value is NULL, the log file is not open, @@ -480,7 +305,7 @@ class CoreExport ServerConfig : public Extensible * foreground. */ bool nofork; - + /** If this value if true then all log * messages will be output, regardless of * the level given in the config file. @@ -488,7 +313,7 @@ class CoreExport ServerConfig : public Extensible * 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 @@ -499,6 +324,17 @@ class CoreExport ServerConfig : public Extensible */ 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. + */ + bool GenericOper; + + /** 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. + */ + bool RestrictBannedUsers; + /** If this value is true, halfops have been * enabled in the configuration file. */ @@ -510,11 +346,6 @@ class CoreExport ServerConfig : public Extensible */ 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. */ @@ -576,11 +407,11 @@ class CoreExport ServerConfig : public Extensible /** 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]; + std::string HideKillsServer; /** The MOTD file, cached in a file_cache type. */ @@ -593,20 +424,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 client ports - */ - std::vector ports; - - /** socket objects that are attached to by modules - */ - std::map SocketIOHookModule; - /** The 005 tokens of this server (ISUPPORT) * populated/repopulated upon loading or unloading * modules. @@ -620,19 +443,19 @@ class CoreExport ServerConfig : public Extensible /** STATS characters in this list are available * only to operators. */ - char UserStats[MAXBUF]; - + std::string UserStats; + /** The path and filename of the ircd.log file */ std::string logpath; /** 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 */ @@ -671,11 +494,11 @@ class CoreExport ServerConfig : public Extensible /** All oper type definitions from the config file */ - opertype_t opertypes; + TagIndex opertypes; /** All oper class definitions from the config file */ - operclass_t operclass; + TagIndex operclass; /** Saved argv from startup */ @@ -698,7 +521,7 @@ class CoreExport ServerConfig : public Extensible * makes code simpler. 0AA, 1BB etc with letters are reserved * for services use. */ - char sid[MAXBUF]; + std::string sid; /** True if we have been told to run the testsuite from the commandline, * rather than entering the mainloop. @@ -707,11 +530,7 @@ class CoreExport ServerConfig : public Extensible /** 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 */ @@ -729,189 +548,52 @@ 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(); + + /** Apply configuration changes from the old configuration. + */ + 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); - /** 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. - */ - void ReportConfigError(const std::string &errormessage, bool bail, User* user); - /** 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, 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(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); + bool LoadConf(FILE* &conf, const std::string &filename, bool allowexeinc); - /** 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); - - /** 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); - - /** 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); - - /** Returns the number of occurences of tag in the config file - */ - int ConfValueEnum(ConfigDataHash &target, const char* tag); - /** Returns the number of occurences of tag in the config file - */ - int ConfValueEnum(ConfigDataHash &target, 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); - /** Returns the numbers of vars inside the index'th 'tag in the config file - */ - int ConfVarEnum(ConfigDataHash &target, const std::string &tag, int index); - - void ValidateHostname(const char* p, const std::string &tag, const std::string &val); + ConfigTag* ConfValue(const std::string& tag, int offset = 0); - void ValidateIP(const char* p, const std::string &tag, const std::string &val, bool wild); - - void ValidateNoSpaces(const char* p, const std::string &tag, const std::string &val); - - /** Get a pointer to the module which has hooked the given BufferedSocket class. - * @parameter port Port number - * @return Returns a pointer to the hooking module, or NULL - */ - Module* GetIOHook(BufferedSocket* is); - - /** Hook a module to an BufferedSocket class, so that it can receive notifications - * of low-level socket activity. - * @param iomod The module to hook to the socket - * @param is The BufferedSocket to attach to - * @return True if the hook was successful. - */ - bool AddIOHook(Module* iomod, BufferedSocket* is); - - /** Delete a module hook from an BufferedSocket. - * @param is The BufferedSocket to detatch from. - * @return True if the unhook was successful - */ - bool DelIOHook(BufferedSocket* is); - - /** 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); + 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); - -}; - -/** 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 - */ -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); - -/** Add a config-defined eline - */ -bool DoELine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types); - - + /** If this value is true, invites will bypass more than just +i + */ + bool InvBypassModes; +}; #endif -