/* Minetest Copyright (C) 2010-2013 celeron55, Perttu Ahola This program is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ #include "settings.h" #include "irrlichttypes_bloated.h" #include "exceptions.h" #include "threading/mutex_auto_lock.h" #include "util/strfnd.h" #include #include #include #include "debug.h" #include "log.h" #include "util/serialize.h" #include "filesys.h" #include "noise.h" #include #include Settings *g_settings = nullptr; static SettingsHierarchy g_hierarchy; std::string g_settings_path; std::unordered_map Settings::s_flags; /* Settings hierarchy implementation */ SettingsHierarchy::SettingsHierarchy(Settings *fallback) { layers.push_back(fallback); } Settings *SettingsHierarchy::getLayer(int layer) const { if (layer < 0 || layer >= (int)layers.size()) throw BaseException("Invalid settings layer"); return layers[layer]; } Settings *SettingsHierarchy::getParent(int layer) const { assert(layer >= 0 && layer < (int)layers.size()); // iterate towards the origin (0) to find the next fallback layer for (int i = layer - 1; i >= 0; --i) { if (layers[i]) return layers[i]; } return nullptr; } void SettingsHierarchy::onLayerCreated(int layer, Settings *obj) { if (layer < 0) throw BaseException("Invalid settings layer"); if ((int)layers.size() < layer + 1) layers.resize(layer + 1); Settings *&pos = layers[layer]; if (pos) throw BaseException("Setting layer " + itos(layer) + " already exists"); pos = obj; // This feels bad if (this == &g_hierarchy && layer == (int)SL_GLOBAL) g_settings = obj; } void SettingsHierarchy::onLayerRemoved(int layer) { assert(layer >= 0 && layer < layers.size()); layers[layer] = nullptr; if (this == &g_hierarchy && layer == (int)SL_GLOBAL) g_settings = nullptr; } /* Settings implementation */ Settings *Settings::createLayer(SettingsLayer sl, const std::string &end_tag) { return new Settings(end_tag, &g_hierarchy, (int)sl); } Settings *Settings::getLayer(SettingsLayer sl) { sanity_check((int)sl >= 0 && sl < SL_TOTAL_COUNT); return g_hierarchy.layers[(int)sl]; } Settings::Settings(const std::string &end_tag, SettingsHierarchy *h, int settings_layer) : m_end_tag(end_tag), m_hierarchy(h), m_settingslayer(settings_layer) { if (m_hierarchy) m_hierarchy->onLayerCreated(m_settingslayer, this); } Settings::~Settings() { MutexAutoLock lock(m_mutex); if (m_hierarchy) m_hierarchy->onLayerRemoved(m_settingslayer); clearNoLock(); } Settings & Settings::operator = (const Settings &other) { if (&other == this) return *this; // TODO: Avoid copying Settings objects. Make this private. FATAL_ERROR_IF(m_hierarchy || other.m_hierarchy, "Cannot copy or overwrite Settings object that belongs to a hierarchy"); MutexAutoLock lock(m_mutex); MutexAutoLock lock2(other.m_mutex); clearNoLock(); m_settings = other.m_settings; m_callbacks = other.m_callbacks; return *this; } bool Settings::checkNameValid(const std::string &name) { bool valid = name.find_first_of("=\"{}#") == std::string::npos; if (valid) valid = std::find_if(name.begin(), name.end(), ::isspace) == name.end(); if (!valid) { errorstream << "Invalid setting name \"" << name << "\"" << std::endl; return false; } return true; } bool Settings::checkValueValid(const std::string &value) { if (value.substr(0, 3) == "\"\"\"" || value.find("\n\"\"\"") != std::string::npos) { errorstream << "Invalid character sequence '\"\"\"' found in" " setting value!" << std::endl; return false; } return true; } std::string Settings::getMultiline(std::istream &is, size_t *num_lines) { size_t lines = 1; std::string value; std::string line; while (is.good()) { lines++; std::getline(is, line); if (line == "\"\"\"") break; value += line; value.push_back('\n'); } size_t len = value.size(); if (len) value.erase(len - 1); if (num_lines) *num_lines = lines; return value; } bool Settings::readConfigFile(const char *filename) { std::ifstream is(filename); if (!is.good()) return false; return parseConfigLines(is); } bool Settings::parseConfigLines(std::istream &is) { MutexAutoLock lock(m_mutex); std::string line, name, value; while (is.good()) { std::getline(is, line); SettingsParseEvent event = parseConfigObject(line, name, value); switch (event) { case SPE_NONE: case SPE_INVALID: case SPE_COMMENT: break; case SPE_KVPAIR: m_settings[name] = SettingsEntry(value); break; case SPE_END: return true; case SPE_GROUP: { Settings *group = new Settings("}"); if (!group->parseConfigLines(is)) { delete group; return false; } m_settings[name] = SettingsEntry(group); break; } case SPE_MULTILINE: m_settings[name] = SettingsEntry(getMultiline(is)); break; } } // false (failure) if end tag not found return m_end_tag.empty(); } void Settings::writeLines(std::ostream &os, u32 tab_depth) const { MutexAutoLock lock(m_mutex); for (const auto &setting_it : m_settings) printEntry(os, setting_it.first, setting_it.second, tab_depth); // For groups this must be "}" ! if (!m_end_tag.empty()) { for (u32 i = 0; i < tab_depth; i++) os << "\t"; os << m_end_tag << "\n"; } } void Settings::printEntry(std::ostream &os, const std::string &name, const SettingsEntry &entry, u32 tab_depth) { for (u32 i = 0; i != tab_depth; i++) os << "\t"; if (entry.is_group) { os << name << " = {\n"; entry.group->writeLines(os, tab_depth + 1); // Closing bracket handled by writeLines } else { os << name << " = "; if (entry.value.find('\n') != std::string::npos) os << "\"\"\"\n" << entry.value << "\n\"\"\"\n"; else os << entry.value << "\n"; } } bool Settings::updateConfigObject(std::istream &is, std::ostream &os, u32 tab_depth) { SettingEntries::const_iterator it; std::set present_entries; std::string line, name, value; bool was_modified = false; bool end_found = false; // Add any settings that exist in the config file with the current value // in the object if existing while (is.good() && !end_found) { std::getline(is, line); SettingsParseEvent event = parseConfigObject(line, name, value); switch (event) { case SPE_END: // Skip end tag. Append later. end_found = true; break; case SPE_MULTILINE: value = getMultiline(is); /* FALLTHROUGH */ case SPE_KVPAIR: it = m_settings.find(name); if (it != m_settings.end() && (it->second.is_group || it->second.value != value)) { printEntry(os, name, it->second, tab_depth); was_modified = true; } else if (it == m_settings.end()) { // Remove by skipping was_modified = true; break; } else { os << line << "\n"; if (event == SPE_MULTILINE) os << value << "\n\"\"\"\n"; } present_entries.insert(name); break; case SPE_GROUP: it = m_settings.find(name); if (it != m_settings.end() && it->second.is_group) { os << line << "\n"; sanity_check(it->second.group != NULL); was_modified |= it->second.group->updateConfigObject(is, os, tab_depth + 1); } else if (it == m_settings.end()) { // Remove by skipping was_modified = true; Settings removed_group("}"); // Move 'is' to group end std::stringstream ss; removed_group.updateConfigObject(is, ss, tab_depth + 1); break; } else { printEntry(os, name, it->second, tab_depth); was_modified = true; } present_entries.insert(name); break; default: os << line << (is.eof() ? "" : "\n"); break; } } if (!line.empty() && is.eof()) os << "\n"; // Add any settings in the object that don't exist in the config file yet for (it = m_settings.begin(); it != m_settings.end(); ++it) { if (present_entries.find(it->first) != present_entries.end()) continue; printEntry(os, it->first, it->second, tab_depth); was_modified = true; } // Append ending tag if (!m_end_tag.empty()) { os << m_end_tag << "\n"; was_modified |= !end_found; } return was_modified; } bool Settings::updateConfigFile(const char *filename) { MutexAutoLock lock(m_mutex); std::ifstream is(filename); std::ostringstream os(std::ios_base::binary); bool was_modified = updateConfigObject(is, os); is.close(); if (!was_modified) return true; if (!fs::safeWriteToFile(filename, os.str())) { errorstream << "Error writing configuration file: \"" << filename << "\"" << std::endl; return false; } return true; } bool Settings::parseCommandLine(int argc, char *argv[], std::map &allowed_options) { int nonopt_index = 0; for (int i = 1; i < argc; i++) { std::string arg_name = argv[i]; if (arg_name.substr(0, 2) != "--") { // If option doesn't start with -, read it in as nonoptX if (arg_name[0] != '-'){ std::string name = "nonopt"; name += itos(nonopt_index); set(name, arg_name); nonopt_index++; continue; } errorstream << "Invalid command-line parameter \"" << arg_name << "\": --