src/content/mods.h

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   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.
   9
  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.
  14
  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.
  18 */
  19
  20 #pragma once
  21
  22 #include "irrlichttypes.h"
  23 #include <list>
  24 #include <set>
  25 #include <vector>
  26 #include <string>
  27 #include <map>
  28 #include <json/json.h>
  29 #include <unordered_set>
  30 #include "util/basic_macros.h"
  31 #include "config.h"
  32 #include "metadata.h"
  33
  34 #define MODNAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyz0123456789_"
  35
  36 struct ModSpec
  37 {
  38         std::string name;
  39         std::string author;
  40         std::string path;
  41         std::string desc;
  42
  43         // if normal mod:
  44         std::unordered_set<std::string> depends;
  45         std::unordered_set<std::string> optdepends;
  46         std::unordered_set<std::string> unsatisfied_depends;
  47
  48         bool part_of_modpack = false;
  49         bool is_modpack = false;
  50
  51         // if modpack:
  52         std::map<std::string, ModSpec> modpack_content;
  53         ModSpec(const std::string &name = "", const std::string &path = "") :
  54                         name(name), path(path)
  55         {
  56         }
  57         ModSpec(const std::string &name, const std::string &path, bool part_of_modpack) :
  58                         name(name), path(path), part_of_modpack(part_of_modpack)
  59         {
  60         }
  61 };
  62
  63 // Retrieves depends, optdepends, is_modpack and modpack_content
  64 void parseModContents(ModSpec &mod);
  65
  66 std::map<std::string, ModSpec> getModsInPath(
  67                 const std::string &path, bool part_of_modpack = false);
  68
  69 // replaces modpack Modspecs with their content
  70 std::vector<ModSpec> flattenMods(std::map<std::string, ModSpec> mods);
  71
  72 // a ModConfiguration is a subset of installed mods, expected to have
  73 // all dependencies fullfilled, so it can be used as a list of mods to
  74 // load when the game starts.
  75 class ModConfiguration
  76 {
  77 public:
  78         // checks if all dependencies are fullfilled.
  79         bool isConsistent() const { return m_unsatisfied_mods.empty(); }
  80
  81         const std::vector<ModSpec> &getMods() const { return m_sorted_mods; }
  82
  83         const std::vector<ModSpec> &getUnsatisfiedMods() const
  84         {
  85                 return m_unsatisfied_mods;
  86         }
  87
  88         void printUnsatisfiedModsError() const;
  89
  90 protected:
  91         ModConfiguration(const std::string &worldpath);
  92         // adds all mods in the given path. used for games, modpacks
  93         // and world-specific mods (worldmods-folders)
  94         void addModsInPath(const std::string &path);
  95
  96         // adds all mods in the set.
  97         void addMods(const std::vector<ModSpec> &new_mods);
  98
  99         void addModsFromConfig(const std::string &settings_path,
 100                         const std::set<std::string> &mods);
 101
 102         void checkConflictsAndDeps();
 103
 104 protected:
 105         // list of mods sorted such that they can be loaded in the
 106         // given order with all dependencies being fullfilled. I.e.,
 107         // every mod in this list has only dependencies on mods which
 108         // appear earlier in the vector.
 109         std::vector<ModSpec> m_sorted_mods;
 110
 111 private:
 112         // move mods from m_unsatisfied_mods to m_sorted_mods
 113         // in an order that satisfies dependencies
 114         void resolveDependencies();
 115
 116         // mods with unmet dependencies. Before dependencies are resolved,
 117         // this is where all mods are stored. Afterwards this contains
 118         // only the ones with really unsatisfied dependencies.
 119         std::vector<ModSpec> m_unsatisfied_mods;
 120
 121         // set of mod names for which an unresolved name conflict
 122         // exists. A name conflict happens when two or more mods
 123         // at the same level have the same name but different paths.
 124         // Levels (mods in higher levels override mods in lower levels):
 125         // 1. game mod in modpack; 2. game mod;
 126         // 3. world mod in modpack; 4. world mod;
 127         // 5. addon mod in modpack; 6. addon mod.
 128         std::unordered_set<std::string> m_name_conflicts;
 129
 130         // Deleted default constructor
 131         ModConfiguration() = default;
 132 };
 133
 134 #ifndef SERVER
 135 class ClientModConfiguration : public ModConfiguration
 136 {
 137 public:
 138         ClientModConfiguration(const std::string &path);
 139 };
 140 #endif
 141
 142 class ModMetadata : public Metadata
 143 {
 144 public:
 145         ModMetadata() = delete;
 146         ModMetadata(const std::string &mod_name);
 147         ~ModMetadata() = default;
 148
 149         virtual void clear();
 150
 151         bool save(const std::string &root_path);
 152         bool load(const std::string &root_path);
 153
 154         bool isModified() const { return m_modified; }
 155         const std::string &getModName() const { return m_mod_name; }
 156
 157         virtual bool setString(const std::string &name, const std::string &var);
 158
 159 private:
 160         std::string m_mod_name;
 161         bool m_modified = false;
 162 };