]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/configparser.cpp
Refactor UserManager::DoBackgroundUserStuff().
[user/henk/code/inspircd.git] / src / configparser.cpp
index 5ee86c81178c49acd128ac940ae02aedc05757dc..abdf6f3de07e2f0cb58c3f989e750bd6704445e6 100644 (file)
 #include <fstream>
 #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
+};
+
+// 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<ConfigTag> tag;
        int ungot;
        std::string mandatory_tag;
@@ -52,11 +126,11 @@ struct Parser
                else if (ch == '\n')
                {
                        current.line++;
-                       current.col = 0;
+                       current.column = 0;
                }
                else
                {
-                       current.col++;
+                       current.column++;
                }
                return ch;
        }
@@ -200,7 +274,7 @@ struct Parser
                        throw CoreException("Empty tag name");
 
                ConfigItems* items;
-               tag = ConfigTag::create(name, current.filename, current.line, items);
+               tag = ConfigTag::create(name, current.name, current.line, items);
 
                while (kv(items))
                {
@@ -213,25 +287,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(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(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("<define> tags may only be used in XML-style config (add <config format=\"xml\">)");
@@ -241,12 +315,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);
@@ -286,7 +360,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");
                                }
@@ -402,6 +477,21 @@ 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, const TR1NS::function<bool(const std::string&)>& validator)
+{
+       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;
@@ -519,17 +609,27 @@ unsigned long ConfigTag::getDuration(const std::string& key, unsigned long def,
        if (!readString(key, duration))
                return def;
 
-       unsigned long ret = InspIRCd::Duration(duration);
+       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;
+       }
+
        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)