51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
+#include <cctype>
+#include <fstream>
#include "mods.h"
-#include "main.h"
#include "filesys.h"
-#include "strfnd.h"
#include "log.h"
#include "subgame.h"
#include "settings.h"
-#include "strfnd.h"
-#include <cctype>
#include "convert_json.h"
+#include "exceptions.h"
+#include "porting.h"
static bool parseDependsLine(std::istream &is,
std::string &dep, std::set<char> &symbols)
void parseModContents(ModSpec &spec)
{
// NOTE: this function works in mutual recursion with getModsInPath
+ Settings info;
+ info.readConfigFile((spec.path+DIR_DELIM+"mod.conf").c_str());
+
+ if (info.exists("name"))
+ spec.name = info.get("name");
spec.depends.clear();
spec.optdepends.clear();
}
}
}
-
- // FIXME: optdepends.txt is deprecated
- // remove this code at some point in the future
- std::ifstream is2((spec.path+DIR_DELIM+"optdepends.txt").c_str());
- while(is2.good()){
- std::string dep;
- std::set<char> symbols;
- if(parseDependsLine(is2, dep, symbols))
- spec.optdepends.insert(dep);
- }
}
}
return result;
}
-ModSpec findCommonMod(const std::string &modname)
-{
- // Try to find in {$user,$share}/games/common/$modname
- std::vector<std::string> find_paths;
- find_paths.push_back(porting::path_user + DIR_DELIM + "games" +
- DIR_DELIM + "common" + DIR_DELIM + "mods" + DIR_DELIM + modname);
- find_paths.push_back(porting::path_share + DIR_DELIM + "games" +
- DIR_DELIM + "common" + DIR_DELIM + "mods" + DIR_DELIM + modname);
- for(u32 i=0; i<find_paths.size(); i++){
- const std::string &try_path = find_paths[i];
- if(fs::PathExists(try_path)){
- ModSpec spec(modname, try_path);
- parseModContents(spec);
- return spec;
- }
- }
- // Failed to find mod
- return ModSpec();
-}
-
-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;
std::vector<ModSpec> content = flattenMods(mod.modpack_content);
result.reserve(result.size() + content.size());
result.insert(result.end(),content.begin(),content.end());
-
- }
+
+ }
else //not a modpack
{
result.push_back(mod);
return result;
}
-ModConfiguration::ModConfiguration(std::string worldpath)
+ModConfiguration::ModConfiguration(const std::string &worldpath):
+ m_unsatisfied_mods(),
+ m_sorted_mods(),
+ m_name_conflicts()
{
- SubgameSpec gamespec = findWorldSubgame(worldpath);
-
- // Add common mods
- std::map<std::string, ModSpec> common_mods;
- std::vector<std::string> inexistent_common_mods;
- Settings gameconf;
- if(getGameConfig(gamespec.path, gameconf)){
- if(gameconf.exists("common_mods")){
- Strfnd f(gameconf.get("common_mods"));
- while(!f.atend()){
- std::string modname = trim(f.next(","));
- if(modname.empty())
- continue;
- ModSpec spec = findCommonMod(modname);
- if(spec.name.empty())
- inexistent_common_mods.push_back(modname);
- else
- common_mods.insert(std::make_pair(modname, spec));
- }
- }
- }
- if(!inexistent_common_mods.empty()){
- std::string s = "Required common mods ";
- for(u32 i=0; i<inexistent_common_mods.size(); i++){
- if(i != 0) s += ", ";
- s += std::string("\"") + inexistent_common_mods[i] + "\"";
- }
- s += " could not be found.";
- throw ModError(s);
- }
- addMods(flattenMods(common_mods));
-
- // 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 (std::vector<ModSpec>::const_iterator it = m_unsatisfied_mods.begin();
+ it != m_unsatisfied_mods.end(); ++it) {
+ ModSpec mod = *it;
+ errorstream << "mod \"" << mod.name << "\" has unsatisfied dependencies: ";
+ for (UNORDERED_SET<std::string>::iterator dep_it = mod.unsatisfied_depends.begin();
+ dep_it != mod.unsatisfied_depends.end(); ++dep_it)
+ errorstream << " \"" << *dep_it << "\"";
+ 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.
// Add all the mods that come from modpacks
// Second iteration:
// Add all the mods that didn't come from modpacks
-
+
std::set<std::string> seen_this_iteration;
- for(std::vector<ModSpec>::const_iterator it = new_mods.begin();
- it != new_mods.end(); ++it){
+ for (std::vector<ModSpec>::const_iterator it = new_mods.begin();
+ it != new_mods.end(); ++it) {
const ModSpec &mod = *it;
- if(mod.part_of_modpack != want_from_modpack)
+ if(mod.part_of_modpack != (bool)want_from_modpack)
continue;
if(existing_mods.count(mod.name) == 0){
// GOOD CASE: completely new mod.
// BAD CASE: name conflict in different levels.
u32 oldindex = existing_mods[mod.name];
const ModSpec &oldmod = m_unsatisfied_mods[oldindex];
- actionstream<<"WARNING: Mod name conflict detected: \""
+ warningstream<<"Mod name conflict detected: \""
<<mod.name<<"\""<<std::endl
<<"Will not load: "<<oldmod.path<<std::endl
<<"Overridden by: "<<mod.path<<std::endl;
// VERY BAD CASE: name conflict in the same level.
u32 oldindex = existing_mods[mod.name];
const ModSpec &oldmod = m_unsatisfied_mods[oldindex];
- errorstream<<"WARNING: Mod name conflict detected: \""
+ warningstream<<"Mod name conflict detected: \""
<<mod.name<<"\""<<std::endl
<<"Will not load: "<<oldmod.path<<std::endl
<<"Will not load: "<<mod.path<<std::endl;
}
}
+void ModConfiguration::checkConflictsAndDeps()
+{
+ // report on name conflicts
+ if (!m_name_conflicts.empty()) {
+ std::string s = "Unresolved name conflicts for mods ";
+ for (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
// 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){
+ for (std::vector<ModSpec>::iterator it = m_unsatisfied_mods.begin();
+ it != m_unsatisfied_mods.end(); ++it) {
ModSpec mod = *it;
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){
+ for (UNORDERED_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)
+ 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);
else{
++it;
}
- }
+ }
}
// Step 4: write back list of unsatisfied mods
m_unsatisfied_mods.assign(unsatisfied.begin(), unsatisfied.end());
}
+ServerModConfiguration::ServerModConfiguration(const std::string &worldpath):
+ ModConfiguration(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>::const_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>::const_iterator it = addon_mods_in_path.begin();
+ it != addon_mods_in_path.end(); ++it) {
+ const 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);
+
+ checkConflictsAndDeps();
+}
+
+#ifndef SERVER
+ClientModConfiguration::ClientModConfiguration(const std::string &path):
+ ModConfiguration(path)
+{
+ addModsInPath(path);
+ addModsInPath(porting::path_user + DIR_DELIM + "clientmods");
+ checkConflictsAndDeps();
+}
+#endif
+
#if USE_CURL
-Json::Value getModstoreUrl(std::string url)
+Json::Value getModstoreUrl(const std::string &url)
{
- struct curl_slist *chunk = NULL;
+ std::vector<std::string> extra_headers;
bool special_http_header = true;
- try{
+ try {
special_http_header = g_settings->getBool("modstore_disable_special_http_header");
+ } catch (SettingNotFoundException) {}
+
+ if (special_http_header) {
+ extra_headers.push_back("Accept: application/vnd.minetest.mmdb-v1+json");
}
- catch(SettingNotFoundException &e) {
+ return fetchJsonValue(url, special_http_header ? &extra_headers : NULL);
+}
+
+#endif
+
+ModMetadata::ModMetadata(const std::string &mod_name):
+ m_mod_name(mod_name),
+ m_modified(false)
+{
+ m_stringvars.clear();
+}
+
+void ModMetadata::clear()
+{
+ Metadata::clear();
+ m_modified = true;
+}
+
+bool ModMetadata::save(const std::string &root_path)
+{
+ Json::Value json;
+ for (StringMap::const_iterator it = m_stringvars.begin();
+ it != m_stringvars.end(); ++it) {
+ json[it->first] = it->second;
+ }
+
+ if (!fs::PathExists(root_path)) {
+ if (!fs::CreateAllDirs(root_path)) {
+ errorstream << "ModMetadata[" << m_mod_name << "]: Unable to save. '"
+ << root_path << "' tree cannot be created." << std::endl;
+ return false;
+ }
+ } else if (!fs::IsDir(root_path)) {
+ errorstream << "ModMetadata[" << m_mod_name << "]: Unable to save. '"
+ << root_path << "' is not a directory." << std::endl;
+ return false;
+ }
+
+ bool w_ok = fs::safeWriteToFile(root_path + DIR_DELIM + m_mod_name,
+ Json::FastWriter().write(json));
+
+ if (w_ok) {
+ m_modified = false;
+ } else {
+ errorstream << "ModMetadata[" << m_mod_name << "]: failed write file." << std::endl;
}
+ return w_ok;
+}
- if (special_http_header)
- chunk = curl_slist_append(chunk, "Accept: application/vnd.minetest.mmdb-v1+json");
+bool ModMetadata::load(const std::string &root_path)
+{
+ m_stringvars.clear();
+
+ std::ifstream is((root_path + DIR_DELIM + m_mod_name).c_str(), std::ios_base::binary);
+ if (!is.good()) {
+ return false;
+ }
- Json::Value retval = fetchJsonValue(url,chunk);
+ Json::Reader reader;
+ Json::Value root;
+ if (!reader.parse(is, root)) {
+ errorstream << "ModMetadata[" << m_mod_name << "]: failed read data "
+ "(Json decoding failure)." << std::endl;
+ return false;
+ }
- if (chunk != NULL)
- curl_slist_free_all(chunk);
+ 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();
+ }
- return retval;
+ return true;
}
-#endif
+bool ModMetadata::setString(const std::string &name, const std::string &var)
+{
+ m_modified = Metadata::setString(name, var);
+ return m_modified;
+}
projects / minetest.git / blobdiff