]> git.lizzy.rs Git - minetest.git/blobdiff - src/mods.cpp
Line_of_sight: Improve using VoxelLineIterator
[minetest.git] / src / mods.cpp
index bae9a42d31c64a8e62ddf0c19920eb775ddddf7c..dae49233978c29fa01fef5378486a92af6b6f59e 100644 (file)
@@ -19,11 +19,13 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 
 #include <cctype>
 #include <fstream>
+#include <json/json.h>
 #include "mods.h"
 #include "filesys.h"
 #include "log.h"
 #include "subgame.h"
 #include "settings.h"
+#include "porting.h"
 #include "convert_json.h"
 
 static bool parseDependsLine(std::istream &is,
@@ -39,7 +41,7 @@ static bool parseDependsLine(std::istream &is,
                --pos;
        }
        dep = trim(dep.substr(0, pos));
-       return dep != "";
+       return !dep.empty();
 }
 
 void parseModContents(ModSpec &spec)
@@ -89,13 +91,13 @@ std::map<std::string, ModSpec> getModsInPath(std::string path, bool part_of_modp
 
        std::map<std::string, ModSpec> result;
        std::vector<fs::DirListNode> dirlist = fs::GetDirListing(path);
-       for(u32 j=0; j<dirlist.size(); j++){
-               if(!dirlist[j].dir)
+       for (const fs::DirListNode &dln : dirlist) {
+               if(!dln.dir)
                        continue;
-               std::string modname = dirlist[j].name;
+               const std::string &modname = dln.name;
                // Ignore all directories beginning with a ".", especially
                // VCS directories like ".git" or ".svn"
-               if(modname[0] == '.')
+               if (modname[0] == '.')
                        continue;
                std::string modpath = path + DIR_DELIM + modname;
 
@@ -107,37 +109,12 @@ std::map<std::string, ModSpec> getModsInPath(std::string path, bool part_of_modp
        return result;
 }
 
-std::map<std::string, ModSpec> flattenModTree(std::map<std::string, ModSpec> mods)
-{
-       std::map<std::string, ModSpec> result;
-       for(std::map<std::string,ModSpec>::iterator it = mods.begin();
-               it != mods.end(); ++it)
-       {
-               ModSpec mod = (*it).second;
-               if(mod.is_modpack)
-               {
-                       std::map<std::string, ModSpec> content =
-                               flattenModTree(mod.modpack_content);
-                       result.insert(content.begin(),content.end());
-                       result.insert(std::make_pair(mod.name,mod));
-               }
-               else //not a modpack
-               {
-                       result.insert(std::make_pair(mod.name,mod));
-               }
-       }
-       return result;
-}
-
 std::vector<ModSpec> flattenMods(std::map<std::string, ModSpec> mods)
 {
        std::vector<ModSpec> result;
-       for(std::map<std::string,ModSpec>::iterator it = mods.begin();
-               it != mods.end(); ++it)
-       {
-               ModSpec mod = (*it).second;
-               if(mod.is_modpack)
-               {
+       for (const auto &it : mods) {
+               const ModSpec &mod = it.second;
+               if (mod.is_modpack) {
                        std::vector<ModSpec> content = flattenMods(mod.modpack_content);
                        result.reserve(result.size() + content.size());
                        result.insert(result.end(),content.begin(),content.end());
@@ -151,78 +128,26 @@ std::vector<ModSpec> flattenMods(std::map<std::string, ModSpec> mods)
        return result;
 }
 
-ModConfiguration::ModConfiguration(std::string worldpath)
+ModConfiguration::ModConfiguration(const std::string &worldpath)
 {
-       SubgameSpec gamespec = findWorldSubgame(worldpath);
-
-       // Add all game mods and all world mods
-       addModsInPath(gamespec.gamemods_path);
-       addModsInPath(worldpath + DIR_DELIM + "worldmods");
-
-       // check world.mt file for mods explicitely declared to be
-       // loaded or not by a load_mod_<modname> = ... line.
-       std::string worldmt = worldpath+DIR_DELIM+"world.mt";
-       Settings worldmt_settings;
-       worldmt_settings.readConfigFile(worldmt.c_str());
-       std::vector<std::string> names = worldmt_settings.getNames();
-       std::set<std::string> include_mod_names;
-       for(std::vector<std::string>::iterator it = names.begin();
-               it != names.end(); ++it)
-       {
-               std::string name = *it;
-               // for backwards compatibility: exclude only mods which are
-               // explicitely excluded. if mod is not mentioned at all, it is
-               // enabled. So by default, all installed mods are enabled.
-               if (name.compare(0,9,"load_mod_") == 0 &&
-                       worldmt_settings.getBool(name))
-               {
-                       include_mod_names.insert(name.substr(9));
-               }
-       }
-
-       // Collect all mods that are also in include_mod_names
-       std::vector<ModSpec> addon_mods;
-       for(std::set<std::string>::const_iterator it_path = gamespec.addon_mods_paths.begin();
-                       it_path != gamespec.addon_mods_paths.end(); ++it_path)
-       {
-               std::vector<ModSpec> addon_mods_in_path = flattenMods(getModsInPath(*it_path));
-               for(std::vector<ModSpec>::iterator it = addon_mods_in_path.begin();
-                       it != addon_mods_in_path.end(); ++it)
-               {
-                       ModSpec& mod = *it;
-                       if(include_mod_names.count(mod.name) != 0)
-                               addon_mods.push_back(mod);
-                       else
-                               worldmt_settings.setBool("load_mod_" + mod.name, false);
-               }
-       }
-       worldmt_settings.updateConfigFile(worldmt.c_str());
-
-       addMods(addon_mods);
+}
 
-       // report on name conflicts
-       if(!m_name_conflicts.empty()){
-               std::string s = "Unresolved name conflicts for mods ";
-               for(std::set<std::string>::const_iterator it = m_name_conflicts.begin();
-                               it != m_name_conflicts.end(); ++it)
-               {
-                       if(it != m_name_conflicts.begin()) s += ", ";
-                       s += std::string("\"") + (*it) + "\"";
-               }
-               s += ".";
-               throw ModError(s);
+void ModConfiguration::printUnsatisfiedModsError() const
+{
+       for (const ModSpec &mod : m_unsatisfied_mods) {
+               errorstream << "mod \"" << mod.name << "\" has unsatisfied dependencies: ";
+               for (const std::string &unsatisfied_depend : mod.unsatisfied_depends)
+                       errorstream << " \"" << unsatisfied_depend << "\"";
+               errorstream << std::endl;
        }
-
-       // get the mods in order
-       resolveDependencies();
 }
 
-void ModConfiguration::addModsInPath(std::string path)
+void ModConfiguration::addModsInPath(const std::string &path)
 {
        addMods(flattenMods(getModsInPath(path)));
 }
 
-void ModConfiguration::addMods(std::vector<ModSpec> new_mods)
+void ModConfiguration::addMods(const std::vector<ModSpec> &new_mods)
 {
        // Maintain a map of all existing m_unsatisfied_mods.
        // Keys are mod names and values are indices into m_unsatisfied_mods.
@@ -240,17 +165,15 @@ void ModConfiguration::addMods(std::vector<ModSpec> new_mods)
 
                std::set<std::string> seen_this_iteration;
 
-               for(std::vector<ModSpec>::const_iterator it = new_mods.begin();
-                               it != new_mods.end(); ++it){
-                       const ModSpec &mod = *it;
-                       if(mod.part_of_modpack != (bool)want_from_modpack)
+               for (const ModSpec &mod : new_mods) {
+                       if (mod.part_of_modpack != (bool)want_from_modpack)
                                continue;
-                       if(existing_mods.count(mod.name) == 0){
+
+                       if (existing_mods.count(mod.name) == 0) {
                                // GOOD CASE: completely new mod.
                                m_unsatisfied_mods.push_back(mod);
                                existing_mods[mod.name] = m_unsatisfied_mods.size() - 1;
-                       }
-                       else if(seen_this_iteration.count(mod.name) == 0){
+                       } else if(seen_this_iteration.count(mod.name) == 0) {
                                // BAD CASE: name conflict in different levels.
                                u32 oldindex = existing_mods[mod.name];
                                const ModSpec &oldmod = m_unsatisfied_mods[oldindex];
@@ -263,8 +186,7 @@ void ModConfiguration::addMods(std::vector<ModSpec> new_mods)
                                // If there was a "VERY BAD CASE" name conflict
                                // in an earlier level, ignore it.
                                m_name_conflicts.erase(mod.name);
-                       }
-                       else{
+                       } else {
                                // VERY BAD CASE: name conflict in the same level.
                                u32 oldindex = existing_mods[mod.name];
                                const ModSpec &oldmod = m_unsatisfied_mods[oldindex];
@@ -275,37 +197,97 @@ void ModConfiguration::addMods(std::vector<ModSpec> new_mods)
                                m_unsatisfied_mods[oldindex] = mod;
                                m_name_conflicts.insert(mod.name);
                        }
+
                        seen_this_iteration.insert(mod.name);
                }
        }
 }
 
+void ModConfiguration::addModsFromConfig(const std::string &settings_path, const std::set<std::string> &mods)
+{
+       Settings conf;
+       std::set<std::string> load_mod_names;
+
+       conf.readConfigFile(settings_path.c_str());
+       std::vector<std::string> names = conf.getNames();
+       for (const std::string &name : names) {
+               if (name.compare(0,9,"load_mod_")==0 && conf.getBool(name))
+                       load_mod_names.insert(name.substr(9));
+       }
+
+       std::vector<ModSpec> addon_mods;
+       for (const std::string &i : mods) {
+               std::vector<ModSpec> addon_mods_in_path = flattenMods(getModsInPath(i));
+               for (std::vector<ModSpec>::const_iterator it = addon_mods_in_path.begin();
+                               it != addon_mods_in_path.end(); ++it) {
+                       const ModSpec& mod = *it;
+                       if (load_mod_names.count(mod.name) != 0)
+                               addon_mods.push_back(mod);
+                       else
+                               conf.setBool("load_mod_" + mod.name, false);
+               }
+       }
+       conf.updateConfigFile(settings_path.c_str());
+
+       addMods(addon_mods);
+       checkConflictsAndDeps();
+
+       // complain about mods declared to be loaded, but not found
+       for (const ModSpec &addon_mod : addon_mods)
+               load_mod_names.erase(addon_mod.name);
+
+       std::vector<ModSpec> unsatisfiedMods = getUnsatisfiedMods();
+
+       for (const ModSpec &unsatisfiedMod : unsatisfiedMods)
+               load_mod_names.erase(unsatisfiedMod.name);
+
+       if (!load_mod_names.empty()) {
+               errorstream << "The following mods could not be found:";
+               for (const std::string &mod : load_mod_names)
+                       errorstream << " \"" << mod << "\"";
+               errorstream << std::endl;
+       }
+}
+
+void ModConfiguration::checkConflictsAndDeps()
+{
+       // report on name conflicts
+       if (!m_name_conflicts.empty()) {
+               std::string s = "Unresolved name conflicts for mods ";
+               for (std::unordered_set<std::string>::const_iterator it =
+                       m_name_conflicts.begin(); it != m_name_conflicts.end(); ++it) {
+                       if (it != m_name_conflicts.begin()) s += ", ";
+                       s += std::string("\"") + (*it) + "\"";
+               }
+               s += ".";
+               throw ModError(s);
+       }
+
+       // get the mods in order
+       resolveDependencies();
+}
+
 void ModConfiguration::resolveDependencies()
 {
        // Step 1: Compile a list of the mod names we're working with
        std::set<std::string> modnames;
-       for(std::vector<ModSpec>::iterator it = m_unsatisfied_mods.begin();
-               it != m_unsatisfied_mods.end(); ++it){
-               modnames.insert((*it).name);
+       for (const ModSpec &mod : m_unsatisfied_mods) {
+               modnames.insert(mod.name);
        }
 
        // Step 2: get dependencies (including optional dependencies)
        // of each mod, split mods into satisfied and unsatisfied
        std::list<ModSpec> satisfied;
        std::list<ModSpec> unsatisfied;
-       for(std::vector<ModSpec>::iterator it = m_unsatisfied_mods.begin();
-                       it != m_unsatisfied_mods.end(); ++it){
-               ModSpec mod = *it;
+       for (ModSpec mod : m_unsatisfied_mods) {
                mod.unsatisfied_depends = mod.depends;
                // check which optional dependencies actually exist
-               for(std::set<std::string>::iterator it_optdep = mod.optdepends.begin();
-                               it_optdep != mod.optdepends.end(); ++it_optdep){
-                       std::string optdep = *it_optdep;
-                       if(modnames.count(optdep) != 0)
+               for (const std::string &optdep : mod.optdepends) {
+                       if (modnames.count(optdep) != 0)
                                mod.unsatisfied_depends.insert(optdep);
                }
                // if a mod has no depends it is initially satisfied
-               if(mod.unsatisfied_depends.empty())
+               if (mod.unsatisfied_depends.empty())
                        satisfied.push_back(mod);
                else
                        unsatisfied.push_back(mod);
@@ -317,15 +299,13 @@ void ModConfiguration::resolveDependencies()
                ModSpec mod = satisfied.back();
                m_sorted_mods.push_back(mod);
                satisfied.pop_back();
-               for(std::list<ModSpec>::iterator it = unsatisfied.begin();
-                               it != unsatisfied.end(); ){
+               for (auto it = unsatisfied.begin(); it != unsatisfied.end(); ) {
                        ModSpec& mod2 = *it;
                        mod2.unsatisfied_depends.erase(mod.name);
-                       if(mod2.unsatisfied_depends.empty()){
+                       if (mod2.unsatisfied_depends.empty()) {
                                satisfied.push_back(mod2);
                                it = unsatisfied.erase(it);
-                       }
-                       else{
+                       } else {
                                ++it;
                        }
                }
@@ -335,30 +315,37 @@ void ModConfiguration::resolveDependencies()
        m_unsatisfied_mods.assign(unsatisfied.begin(), unsatisfied.end());
 }
 
-#if USE_CURL
-Json::Value getModstoreUrl(std::string url)
+ServerModConfiguration::ServerModConfiguration(const std::string &worldpath):
+       ModConfiguration(worldpath)
 {
-       std::vector<std::string> extra_headers;
-
-       bool special_http_header = true;
+       SubgameSpec gamespec = findWorldSubgame(worldpath);
 
-       try {
-               special_http_header = g_settings->getBool("modstore_disable_special_http_header");
-       } catch (SettingNotFoundException) {}
+       // Add all game mods and all world mods
+       addModsInPath(gamespec.gamemods_path);
+       addModsInPath(worldpath + DIR_DELIM + "worldmods");
 
-       if (special_http_header) {
-               extra_headers.push_back("Accept: application/vnd.minetest.mmdb-v1+json");
-       }
-       return fetchJsonValue(url, special_http_header ? &extra_headers : NULL);
+       // Load normal mods
+       std::string worldmt = worldpath + DIR_DELIM + "world.mt";
+       addModsFromConfig(worldmt, gamespec.addon_mods_paths);
 }
 
+#ifndef SERVER
+ClientModConfiguration::ClientModConfiguration(const std::string &path):
+       ModConfiguration(path)
+{
+       std::set<std::string> paths;
+       std::string path_user = porting::path_user + DIR_DELIM + "clientmods";
+       paths.insert(path);
+       paths.insert(path_user);
+
+       std::string settings_path = path_user + DIR_DELIM + "mods.conf";
+       addModsFromConfig(settings_path, paths);
+}
 #endif
 
 ModMetadata::ModMetadata(const std::string &mod_name):
-       m_mod_name(mod_name),
-       m_modified(false)
+       m_mod_name(mod_name)
 {
-       m_stringvars.clear();
 }
 
 void ModMetadata::clear()
@@ -388,7 +375,7 @@ bool ModMetadata::save(const std::string &root_path)
        }
 
        bool w_ok = fs::safeWriteToFile(root_path + DIR_DELIM + m_mod_name,
-               Json::FastWriter().write(json));
+                       fastWriteJson(json));
 
        if (w_ok) {
                m_modified = false;
@@ -407,19 +394,21 @@ bool ModMetadata::load(const std::string &root_path)
                return false;
        }
 
-       Json::Reader reader;
        Json::Value root;
-       if (!reader.parse(is, root)) {
+       Json::CharReaderBuilder builder;
+       builder.settings_["collectComments"] = false;
+       std::string errs;
+
+       if (!Json::parseFromStream(builder, is, &root, &errs)) {
                errorstream << "ModMetadata[" << m_mod_name << "]: failed read data "
-                       "(Json decoding failure)." << std::endl;
+                       "(Json decoding failure). Message: " << errs << std::endl;
                return false;
        }
 
        const Json::Value::Members attr_list = root.getMemberNames();
-       for (Json::Value::Members::const_iterator it = attr_list.begin();
-                       it != attr_list.end(); ++it) {
-               Json::Value attr_value = root[*it];
-               m_stringvars[*it] = attr_value.asString();
+       for (const auto &it : attr_list) {
+               Json::Value attr_value = root[it];
+               m_stringvars[it] = attr_value.asString();
        }
 
        return true;