X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fconfigparser.cpp;h=9f5a49f1daffc65d401304f36803fb982d268a3d;hb=e2b0f3dc9ef4d56c71d7abda13e6139ca092e387;hp=6b0d8fa04fc473a6e6f4f6a99d23ef45ff31c78e;hpb=48f8f79317a04891e2becd859363add6eb2d6444;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/configparser.cpp b/src/configparser.cpp index 6b0d8fa04..9f5a49f1d 100644 --- a/src/configparser.cpp +++ b/src/configparser.cpp @@ -1,6 +1,12 @@ /* * InspIRCd -- Internet Relay Chat Daemon * + * Copyright (C) 2018 linuxdaemon + * Copyright (C) 2013-2014, 2016-2020 Sadie Powell + * Copyright (C) 2013 ChrisTX + * Copyright (C) 2012-2014 Attila Molnar + * Copyright (C) 2012 Robby + * Copyright (C) 2010 Craig Edwards * Copyright (C) 2009-2010 Daniel De Graaf * * This file is part of InspIRCd. InspIRCd is free software: you can @@ -21,13 +27,93 @@ #include #include "configparser.h" +enum ParseFlags +{ + // Legacy config parsing should be used. + FLAG_USE_COMPAT = 1, + + // Executable includes are disabled. + FLAG_NO_EXEC = 2, + + // All includes are disabled. + FLAG_NO_INC = 4, + + // &env.FOO; is disabled. + FLAG_NO_ENV = 8, + + // It's okay if an include doesn't exist. + FLAG_MISSING_OKAY = 16 +}; + +// Represents the position within a config file. +struct FilePosition +{ + // The name of the file which is being read. + std::string name; + + // The line of the file that this position points to. + unsigned int line; + + // The column of the file that this position points to. + unsigned int column; + + FilePosition(const std::string& Name) + : name(Name) + , line(1) + , column(1) + { + } + + /** Returns a string that represents this file position. */ + std::string str() + { + return name + ":" + ConvToStr(line) + ":" + ConvToStr(column); + } +}; + +// RAII wrapper for FILE* which closes the file when it goes out of scope. +class FileWrapper +{ + private: + // Whether this file handle should be closed with pclose. + bool close_with_pclose; + + // The file handle which is being wrapped. + FILE* const file; + + public: + FileWrapper(FILE* File, bool CloseWithPClose = false) + : close_with_pclose(CloseWithPClose) + , file(File) + { + } + + // Operator which determines whether the file is open. + operator bool() { return (file != NULL); } + + // Operator which retrieves the underlying FILE pointer. + operator FILE*() { return file; } + + ~FileWrapper() + { + if (!file) + return; + + if (close_with_pclose) + pclose(file); + else + fclose(file); + } +}; + + struct Parser { ParseStack& stack; int flags; FILE* const file; - fpos current; - fpos last_tag; + FilePosition current; + FilePosition last_tag; reference tag; int ungot; std::string mandatory_tag; @@ -52,11 +138,11 @@ struct Parser else if (ch == '\n') { current.line++; - current.col = 0; + current.column = 0; } else { - current.col++; + current.column++; } return ch; } @@ -78,12 +164,20 @@ struct Parser } } + bool wordchar(char ch) + { + return isalnum(ch) + || ch == '-' + || ch == '.' + || ch == '_'; + } + void nextword(std::string& rv) { int ch = next(); while (isspace(ch)) ch = next(); - while (isalnum(ch) || ch == '_'|| ch == '-') + while (wordchar(ch)) { rv.push_back(ch); ch = next(); @@ -91,7 +185,7 @@ struct Parser unget(ch); } - bool kv(std::vector* items, std::set& seen) + bool kv(ConfigItems* items) { std::string key; nextword(key); @@ -125,7 +219,7 @@ struct Parser while (1) { ch = next(); - if (isalnum(ch) || (varname.empty() && ch == '#')) + if (wordchar(ch) || (varname.empty() && ch == '#')) varname.push_back(ch); else if (ch == ';') break; @@ -153,9 +247,20 @@ struct Parser throw CoreException("Invalid numeric character reference '&" + varname + ";'"); value.push_back(static_cast(lvalue)); } + else if (varname.compare(0, 4, "env.") == 0) + { + if (flags & FLAG_NO_ENV) + throw CoreException("XML environment entity reference in file included with noenv=\"yes\""); + + const char* envstr = getenv(varname.c_str() + 4); + if (!envstr) + throw CoreException("Undefined XML environment entity reference '&" + varname + ";'"); + + value.append(envstr); + } else { - std::map::iterator var = stack.vars.find(varname); + insp::flat_map::iterator var = stack.vars.find(varname); if (var == stack.vars.end()) throw CoreException("Undefined XML entity reference '&" + varname + ";'"); value.append(var->second); @@ -173,14 +278,14 @@ struct Parser } else if (ch == '"') break; - else + else if (ch != '\r') value.push_back(ch); } - if (!seen.insert(key).second) + if (items->find(key) != items->end()) throw CoreException("Duplicate key '" + key + "' found"); - items->push_back(KeyVal(key, value)); + (*items)[key] = value; return true; } @@ -199,11 +304,10 @@ struct Parser if (name.empty()) throw CoreException("Empty tag name"); - std::vector* items; - std::set seen; - tag = ConfigTag::create(name, current.filename, current.line, items); + ConfigItems* items; + tag = ConfigTag::create(name, current.name, current.line, items); - while (kv(items, seen)) + while (kv(items)) { // Do nothing here (silences a GCC warning). } @@ -214,25 +318,25 @@ struct Parser mandatory_tag.clear(); } - if (name == "include") + if (stdalgo::string::equalsci(name, "include")) { stack.DoInclude(tag, flags); } - else if (name == "files") + else if (stdalgo::string::equalsci(name, "files")) { - for(std::vector::iterator i = items->begin(); i != items->end(); i++) + for(ConfigItems::iterator i = items->begin(); i != items->end(); i++) { stack.DoReadFile(i->first, i->second, flags, false); } } - else if (name == "execfiles") + else if (stdalgo::string::equalsci(name, "execfiles")) { - for(std::vector::iterator i = items->begin(); i != items->end(); i++) + for(ConfigItems::iterator i = items->begin(); i != items->end(); i++) { stack.DoReadFile(i->first, i->second, flags, true); } } - else if (name == "define") + else if (stdalgo::string::equalsci(name, "define")) { if (flags & FLAG_USE_COMPAT) throw CoreException(" tags may only be used in XML-style config (add )"); @@ -242,12 +346,12 @@ struct Parser throw CoreException("Variable definition must include variable name"); stack.vars[varname] = value; } - else if (name == "config") + else if (stdalgo::string::equalsci(name, "config")) { std::string format = tag->getString("format"); - if (format == "xml") + if (stdalgo::string::equalsci(format, "xml")) flags &= ~FLAG_USE_COMPAT; - else if (format == "compat") + else if (stdalgo::string::equalsci(format, "compat")) flags |= FLAG_USE_COMPAT; else if (!format.empty()) throw CoreException("Unknown configuration format " + format); @@ -287,7 +391,8 @@ struct Parser break; case 0xFE: case 0xFF: - stack.errstr << "Do not save your files as UTF-16; use ASCII!\n"; + stack.errstr << "Do not save your files as UTF-16 or UTF-32, use UTF-8!\n"; + /*@fallthrough@*/ default: throw CoreException("Syntax error - start of tag expected"); } @@ -318,11 +423,43 @@ void ParseStack::DoInclude(ConfigTag* tag, int flags) { if (tag->getBool("noinclude", false)) flags |= FLAG_NO_INC; + if (tag->getBool("noexec", false)) flags |= FLAG_NO_EXEC; + + if (tag->getBool("noenv", false)) + flags |= FLAG_NO_ENV; + + if (tag->getBool("missingokay", false)) + flags |= FLAG_MISSING_OKAY; + else + flags &= ~FLAG_MISSING_OKAY; + if (!ParseFile(ServerInstance->Config->Paths.PrependConfig(name), flags, mandatorytag)) throw CoreException("Included"); } + else if (tag->readString("directory", name)) + { + if (tag->getBool("noinclude", false)) + flags |= FLAG_NO_INC; + if (tag->getBool("noexec", false)) + flags |= FLAG_NO_EXEC; + if (tag->getBool("noenv", false)) + flags |= FLAG_NO_ENV; + + const std::string includedir = ServerInstance->Config->Paths.PrependConfig(name); + std::vector files; + if (!FileSystem::GetFileList(includedir, files, "*.conf")) + throw CoreException("Unable to read directory for include: " + includedir); + + std::sort(files.begin(), files.end()); + for (std::vector::const_iterator iter = files.begin(); iter != files.end(); ++iter) + { + const std::string path = includedir + '/' + *iter; + if (!ParseFile(path, flags, mandatorytag)) + throw CoreException("Included"); + } + } else if (tag->readString("executable", name)) { if (flags & FLAG_NO_EXEC) @@ -331,6 +468,9 @@ void ParseStack::DoInclude(ConfigTag* tag, int flags) flags |= FLAG_NO_INC; if (tag->getBool("noexec", true)) flags |= FLAG_NO_EXEC; + if (tag->getBool("noenv", true)) + flags |= FLAG_NO_ENV; + if (!ParseFile(name, flags, mandatorytag, true)) throw CoreException("Included"); } @@ -374,7 +514,12 @@ bool ParseStack::ParseFile(const std::string& path, int flags, const std::string FileWrapper file((isexec ? popen(path.c_str(), "r") : fopen(path.c_str(), "r")), isexec); if (!file) + { + if (flags & FLAG_MISSING_OKAY) + return true; + throw CoreException("Could not read \"" + path + "\" for include"); + } reading.push_back(path); Parser p(*this, flags, file, path, mandatory_tag); @@ -385,7 +530,7 @@ bool ParseStack::ParseFile(const std::string& path, int flags, const std::string bool ConfigTag::readString(const std::string& key, std::string& value, bool allow_lf) { - for(std::vector::iterator j = items.begin(); j != items.end(); ++j) + for(ConfigItems::iterator j = items.begin(); j != items.end(); ++j) { if(j->first != key) continue; @@ -403,17 +548,102 @@ bool ConfigTag::readString(const std::string& key, std::string& value, bool allo return false; } -std::string ConfigTag::getString(const std::string& key, const std::string& def) +std::string ConfigTag::getString(const std::string& key, const std::string& def, const TR1NS::function& validator) { - std::string res = def; - readString(key, res); + std::string res; + if (!readString(key, res)) + return def; + + if (!validator(res)) + { + ServerInstance->Logs->Log("CONFIG", LOG_DEFAULT, "WARNING: The value of <%s:%s> is not valid; value set to %s.", + tag.c_str(), key.c_str(), def.c_str()); + return def; + } + return res; +} + +std::string ConfigTag::getString(const std::string& key, const std::string& def, size_t minlen, size_t maxlen) +{ + std::string res; + if (!readString(key, res)) + return def; + + if (res.length() < minlen || res.length() > maxlen) + { + ServerInstance->Logs->Log("CONFIG", LOG_DEFAULT, "WARNING: The length of <%s:%s> is not between %ld and %ld; value set to %s.", + tag.c_str(), key.c_str(), minlen, maxlen, def.c_str()); + return def; + } return res; } +namespace +{ + /** Check for an invalid magnitude specifier. If one is found a warning is logged and the + * value is corrected (set to \p def). + * @param tag The tag name; used in the warning message. + * @param key The key name; used in the warning message. + * @param val The full value set in the config as a string. + * @param num The value to verify and modify if needed. + * @param def The default value, \p res will be set to this if \p tail does not contain a. + * valid magnitude specifier. + * @param tail The location in the config value at which the magnifier is located. + */ + template + void CheckMagnitude(const std::string& tag, const std::string& key, const std::string& val, Numeric& num, Numeric def, const char* tail) + { + // If this is NULL then no magnitude specifier was given. + if (!*tail) + return; + + switch (toupper(*tail)) + { + case 'K': + num *= 1024; + return; + + case 'M': + num *= 1024 * 1024; + return; + + case 'G': + num *= 1024 * 1024 * 1024; + return; + } + + const std::string message = "WARNING: <" + tag + ":" + key + "> value of " + val + " contains an invalid magnitude specifier '" + + tail + "'; value set to " + ConvToStr(def) + "."; + ServerInstance->Logs->Log("CONFIG", LOG_DEFAULT, message); + num = def; + } + + /** Check for an out of range value. If the value falls outside the boundaries a warning is + * logged and the value is corrected (set to \p def). + * @param tag The tag name; used in the warning message. + * @param key The key name; used in the warning message. + * @param num The value to verify and modify if needed. + * @param def The default value, \p res will be set to this if (min <= res <= max) doesn't hold true. + * @param min Minimum accepted value for \p res. + * @param max Maximum accepted value for \p res. + */ + template + void CheckRange(const std::string& tag, const std::string& key, Numeric& num, Numeric def, Numeric min, Numeric max) + { + if (num >= min && num <= max) + return; + + const std::string message = "WARNING: <" + tag + ":" + key + "> value of " + ConvToStr(num) + " is not between " + + ConvToStr(min) + " and " + ConvToStr(max) + "; value set to " + ConvToStr(def) + "."; + ServerInstance->Logs->Log("CONFIG", LOG_DEFAULT, message); + num = def; + } +} + long ConfigTag::getInt(const std::string &key, long def, long min, long max) { std::string result; - if(!readString(key, result)) + if(!readString(key, result) || result.empty()) return def; const char* res_cstr = result.c_str(); @@ -421,61 +651,68 @@ long ConfigTag::getInt(const std::string &key, long def, long min, long max) long res = strtol(res_cstr, &res_tail, 0); if (res_tail == res_cstr) return def; - switch (toupper(*res_tail)) - { - case 'K': - res = res * 1024; - break; - case 'M': - res = res * 1024 * 1024; - break; - case 'G': - res = res * 1024 * 1024 * 1024; - break; - } - CheckRange(key, res, def, min, max); + CheckMagnitude(tag, key, result, res, def, res_tail); + CheckRange(tag, key, res, def, min, max); return res; } -void ConfigTag::CheckRange(const std::string& key, long& res, long def, long min, long max) +unsigned long ConfigTag::getUInt(const std::string& key, unsigned long def, unsigned long min, unsigned long max) { - if (res < min || res > max) - { - ServerInstance->Logs->Log("CONFIG", LOG_DEFAULT, "WARNING: <%s:%s> value of %ld is not between %ld and %ld; set to %ld.", - tag.c_str(), key.c_str(), res, min, max, def); - res = def; - } + std::string result; + if (!readString(key, result) || result.empty()) + return def; + + const char* res_cstr = result.c_str(); + char* res_tail = NULL; + unsigned long res = strtoul(res_cstr, &res_tail, 0); + if (res_tail == res_cstr) + return def; + + CheckMagnitude(tag, key, result, res, def, res_tail); + CheckRange(tag, key, res, def, min, max); + return res; } -long ConfigTag::getDuration(const std::string& key, long def, long min, long max) +unsigned long ConfigTag::getDuration(const std::string& key, unsigned long def, unsigned long min, unsigned long max) { std::string duration; - if (!readString(key, duration)) + if (!readString(key, duration) || duration.empty()) + return def; + + unsigned long ret; + if (!InspIRCd::Duration(duration, ret)) + { + ServerInstance->Logs->Log("CONFIG", LOG_DEFAULT, "Value of <" + tag + ":" + key + "> at " + getTagLocation() + + " is not a duration; value set to " + ConvToStr(def) + "."); return def; + } - long ret = InspIRCd::Duration(duration); - CheckRange(key, ret, def, min, max); + CheckRange(tag, key, ret, def, min, max); return ret; } -double ConfigTag::getFloat(const std::string &key, double def) +double ConfigTag::getFloat(const std::string& key, double def, double min, double max) { std::string result; if (!readString(key, result)) return def; - return strtod(result.c_str(), NULL); + + double res = strtod(result.c_str(), NULL); + CheckRange(tag, key, res, def, min, max); + return res; } bool ConfigTag::getBool(const std::string &key, bool def) { std::string result; - if(!readString(key, result)) + if(!readString(key, result) || result.empty()) return def; - if (result == "yes" || result == "true" || result == "1" || result == "on") + if (stdalgo::string::equalsci(result, "yes") || stdalgo::string::equalsci(result, "true") || stdalgo::string::equalsci(result, "on") || result == "1") return true; - if (result == "no" || result == "false" || result == "0" || result == "off") + + if (stdalgo::string::equalsci(result, "no") || stdalgo::string::equalsci(result, "false") || stdalgo::string::equalsci(result, "off") || result == "0") return false; ServerInstance->Logs->Log("CONFIG", LOG_DEFAULT, "Value of <" + tag + ":" + key + "> at " + getTagLocation() + @@ -488,7 +725,7 @@ std::string ConfigTag::getTagLocation() return src_name + ":" + ConvToStr(src_line); } -ConfigTag* ConfigTag::create(const std::string& Tag, const std::string& file, int line, std::vector*& Items) +ConfigTag* ConfigTag::create(const std::string& Tag, const std::string& file, int line, ConfigItems*& Items) { ConfigTag* rv = new ConfigTag(Tag, file, line); Items = &rv->items; @@ -500,6 +737,11 @@ ConfigTag::ConfigTag(const std::string& Tag, const std::string& file, int line) { } +OperInfo::OperInfo(const std::string& Name) + : name(Name) +{ +} + std::string OperInfo::getConfig(const std::string& key) { std::string rv;