3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 #include <json/json.h>
29 #include "convert_json.h"
31 static bool parseDependsLine(std::istream &is,
32 std::string &dep, std::set<char> &symbols)
34 std::getline(is, dep);
37 size_t pos = dep.size();
38 while(pos > 0 && !string_allowed(dep.substr(pos-1, 1), MODNAME_ALLOWED_CHARS)){
39 // last character is a symbol, not part of the modname
40 symbols.insert(dep[pos-1]);
43 dep = trim(dep.substr(0, pos));
47 void parseModContents(ModSpec &spec)
49 // NOTE: this function works in mutual recursion with getModsInPath
51 info.readConfigFile((spec.path+DIR_DELIM+"mod.conf").c_str());
53 if (info.exists("name"))
54 spec.name = info.get("name");
57 spec.optdepends.clear();
58 spec.is_modpack = false;
59 spec.modpack_content.clear();
61 // Handle modpacks (defined by containing modpack.txt)
62 std::ifstream modpack_is((spec.path+DIR_DELIM+"modpack.txt").c_str());
63 if(modpack_is.good()){ //a modpack, recursively get the mods in it
64 modpack_is.close(); // We don't actually need the file
65 spec.is_modpack = true;
66 spec.modpack_content = getModsInPath(spec.path, true);
68 // modpacks have no dependencies; they are defined and
69 // tracked separately for each mod in the modpack
71 else{ // not a modpack, parse the dependencies
72 std::ifstream is((spec.path+DIR_DELIM+"depends.txt").c_str());
75 std::set<char> symbols;
76 if(parseDependsLine(is, dep, symbols)){
77 if(symbols.count('?') != 0){
78 spec.optdepends.insert(dep);
81 spec.depends.insert(dep);
88 std::map<std::string, ModSpec> getModsInPath(const std::string &path,
91 // NOTE: this function works in mutual recursion with parseModContents
93 std::map<std::string, ModSpec> result;
94 std::vector<fs::DirListNode> dirlist = fs::GetDirListing(path);
97 for (const fs::DirListNode &dln : dirlist) {
101 const std::string &modname = dln.name;
102 // Ignore all directories beginning with a ".", especially
103 // VCS directories like ".git" or ".svn"
104 if (modname[0] == '.')
112 ModSpec spec(modname, modpath, part_of_modpack);
113 parseModContents(spec);
114 result.insert(std::make_pair(modname, spec));
119 std::vector<ModSpec> flattenMods(std::map<std::string, ModSpec> mods)
121 std::vector<ModSpec> result;
122 for (const auto &it : mods) {
123 const ModSpec &mod = it.second;
124 if (mod.is_modpack) {
125 std::vector<ModSpec> content = flattenMods(mod.modpack_content);
126 result.reserve(result.size() + content.size());
127 result.insert(result.end(),content.begin(),content.end());
132 result.push_back(mod);
138 ModConfiguration::ModConfiguration(const std::string &worldpath)
142 void ModConfiguration::printUnsatisfiedModsError() const
144 for (const ModSpec &mod : m_unsatisfied_mods) {
145 errorstream << "mod \"" << mod.name << "\" has unsatisfied dependencies: ";
146 for (const std::string &unsatisfied_depend : mod.unsatisfied_depends)
147 errorstream << " \"" << unsatisfied_depend << "\"";
148 errorstream << std::endl;
152 void ModConfiguration::addModsInPath(const std::string &path)
154 addMods(flattenMods(getModsInPath(path)));
157 void ModConfiguration::addMods(const std::vector<ModSpec> &new_mods)
159 // Maintain a map of all existing m_unsatisfied_mods.
160 // Keys are mod names and values are indices into m_unsatisfied_mods.
161 std::map<std::string, u32> existing_mods;
162 for(u32 i = 0; i < m_unsatisfied_mods.size(); ++i){
163 existing_mods[m_unsatisfied_mods[i].name] = i;
167 for(int want_from_modpack = 1; want_from_modpack >= 0; --want_from_modpack){
169 // Add all the mods that come from modpacks
171 // Add all the mods that didn't come from modpacks
173 std::set<std::string> seen_this_iteration;
175 for (const ModSpec &mod : new_mods) {
176 if (mod.part_of_modpack != (bool)want_from_modpack)
179 if (existing_mods.count(mod.name) == 0) {
180 // GOOD CASE: completely new mod.
181 m_unsatisfied_mods.push_back(mod);
182 existing_mods[mod.name] = m_unsatisfied_mods.size() - 1;
183 } else if(seen_this_iteration.count(mod.name) == 0) {
184 // BAD CASE: name conflict in different levels.
185 u32 oldindex = existing_mods[mod.name];
186 const ModSpec &oldmod = m_unsatisfied_mods[oldindex];
187 warningstream<<"Mod name conflict detected: \""
188 <<mod.name<<"\""<<std::endl
189 <<"Will not load: "<<oldmod.path<<std::endl
190 <<"Overridden by: "<<mod.path<<std::endl;
191 m_unsatisfied_mods[oldindex] = mod;
193 // If there was a "VERY BAD CASE" name conflict
194 // in an earlier level, ignore it.
195 m_name_conflicts.erase(mod.name);
197 // VERY BAD CASE: name conflict in the same level.
198 u32 oldindex = existing_mods[mod.name];
199 const ModSpec &oldmod = m_unsatisfied_mods[oldindex];
200 warningstream<<"Mod name conflict detected: \""
201 <<mod.name<<"\""<<std::endl
202 <<"Will not load: "<<oldmod.path<<std::endl
203 <<"Will not load: "<<mod.path<<std::endl;
204 m_unsatisfied_mods[oldindex] = mod;
205 m_name_conflicts.insert(mod.name);
208 seen_this_iteration.insert(mod.name);
213 void ModConfiguration::addModsFromConfig(const std::string &settings_path, const std::set<std::string> &mods)
216 std::set<std::string> load_mod_names;
218 conf.readConfigFile(settings_path.c_str());
219 std::vector<std::string> names = conf.getNames();
220 for (const std::string &name : names) {
221 if (name.compare(0,9,"load_mod_")==0 && conf.getBool(name))
222 load_mod_names.insert(name.substr(9));
225 std::vector<ModSpec> addon_mods;
226 for (const std::string &i : mods) {
227 std::vector<ModSpec> addon_mods_in_path = flattenMods(getModsInPath(i));
228 for (std::vector<ModSpec>::const_iterator it = addon_mods_in_path.begin();
229 it != addon_mods_in_path.end(); ++it) {
230 const ModSpec& mod = *it;
231 if (load_mod_names.count(mod.name) != 0)
232 addon_mods.push_back(mod);
234 conf.setBool("load_mod_" + mod.name, false);
237 conf.updateConfigFile(settings_path.c_str());
240 checkConflictsAndDeps();
242 // complain about mods declared to be loaded, but not found
243 for (const ModSpec &addon_mod : addon_mods)
244 load_mod_names.erase(addon_mod.name);
246 std::vector<ModSpec> unsatisfiedMods = getUnsatisfiedMods();
248 for (const ModSpec &unsatisfiedMod : unsatisfiedMods)
249 load_mod_names.erase(unsatisfiedMod.name);
251 if (!load_mod_names.empty()) {
252 errorstream << "The following mods could not be found:";
253 for (const std::string &mod : load_mod_names)
254 errorstream << " \"" << mod << "\"";
255 errorstream << std::endl;
259 void ModConfiguration::checkConflictsAndDeps()
261 // report on name conflicts
262 if (!m_name_conflicts.empty()) {
263 std::string s = "Unresolved name conflicts for mods ";
264 for (std::unordered_set<std::string>::const_iterator it =
265 m_name_conflicts.begin(); it != m_name_conflicts.end(); ++it) {
266 if (it != m_name_conflicts.begin()) s += ", ";
267 s += std::string("\"") + (*it) + "\"";
273 // get the mods in order
274 resolveDependencies();
277 void ModConfiguration::resolveDependencies()
279 // Step 1: Compile a list of the mod names we're working with
280 std::set<std::string> modnames;
281 for (const ModSpec &mod : m_unsatisfied_mods) {
282 modnames.insert(mod.name);
285 // Step 2: get dependencies (including optional dependencies)
286 // of each mod, split mods into satisfied and unsatisfied
287 std::list<ModSpec> satisfied;
288 std::list<ModSpec> unsatisfied;
289 for (ModSpec mod : m_unsatisfied_mods) {
290 mod.unsatisfied_depends = mod.depends;
291 // check which optional dependencies actually exist
292 for (const std::string &optdep : mod.optdepends) {
293 if (modnames.count(optdep) != 0)
294 mod.unsatisfied_depends.insert(optdep);
296 // if a mod has no depends it is initially satisfied
297 if (mod.unsatisfied_depends.empty())
298 satisfied.push_back(mod);
300 unsatisfied.push_back(mod);
303 // Step 3: mods without unmet dependencies can be appended to
305 while(!satisfied.empty()){
306 ModSpec mod = satisfied.back();
307 m_sorted_mods.push_back(mod);
308 satisfied.pop_back();
309 for (auto it = unsatisfied.begin(); it != unsatisfied.end(); ) {
311 mod2.unsatisfied_depends.erase(mod.name);
312 if (mod2.unsatisfied_depends.empty()) {
313 satisfied.push_back(mod2);
314 it = unsatisfied.erase(it);
321 // Step 4: write back list of unsatisfied mods
322 m_unsatisfied_mods.assign(unsatisfied.begin(), unsatisfied.end());
326 ClientModConfiguration::ClientModConfiguration(const std::string &path):
327 ModConfiguration(path)
329 std::set<std::string> paths;
330 std::string path_user = porting::path_user + DIR_DELIM + "clientmods";
332 paths.insert(path_user);
334 std::string settings_path = path_user + DIR_DELIM + "mods.conf";
335 addModsFromConfig(settings_path, paths);
339 ModMetadata::ModMetadata(const std::string &mod_name):
344 void ModMetadata::clear()
350 bool ModMetadata::save(const std::string &root_path)
353 for (StringMap::const_iterator it = m_stringvars.begin();
354 it != m_stringvars.end(); ++it) {
355 json[it->first] = it->second;
358 if (!fs::PathExists(root_path)) {
359 if (!fs::CreateAllDirs(root_path)) {
360 errorstream << "ModMetadata[" << m_mod_name << "]: Unable to save. '"
361 << root_path << "' tree cannot be created." << std::endl;
364 } else if (!fs::IsDir(root_path)) {
365 errorstream << "ModMetadata[" << m_mod_name << "]: Unable to save. '"
366 << root_path << "' is not a directory." << std::endl;
370 bool w_ok = fs::safeWriteToFile(root_path + DIR_DELIM + m_mod_name,
371 fastWriteJson(json));
376 errorstream << "ModMetadata[" << m_mod_name << "]: failed write file." << std::endl;
381 bool ModMetadata::load(const std::string &root_path)
383 m_stringvars.clear();
385 std::ifstream is((root_path + DIR_DELIM + m_mod_name).c_str(), std::ios_base::binary);
391 Json::CharReaderBuilder builder;
392 builder.settings_["collectComments"] = false;
395 if (!Json::parseFromStream(builder, is, &root, &errs)) {
396 errorstream << "ModMetadata[" << m_mod_name << "]: failed read data "
397 "(Json decoding failure). Message: " << errs << std::endl;
401 const Json::Value::Members attr_list = root.getMemberNames();
402 for (const auto &it : attr_list) {
403 Json::Value attr_value = root[it];
404 m_stringvars[it] = attr_value.asString();
410 bool ModMetadata::setString(const std::string &name, const std::string &var)
412 m_modified = Metadata::setString(name, var);