src/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 #ifndef MODS_HEADER
  21 #define MODS_HEADER
  22
  23 #include "irrlichttypes.h"
  24 #include <list>
  25 #include <set>
  26 #include <vector>
  27 #include <string>
  28 #include <map>
  29 #include <json/json.h>
  30 #include "util/cpp11_container.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 path;
  40         //if normal mod:
  41         UNORDERED_SET<std::string> depends;
  42         UNORDERED_SET<std::string> optdepends;
  43         UNORDERED_SET<std::string> unsatisfied_depends;
  44
  45         bool part_of_modpack;
  46         bool is_modpack;
  47         // if modpack:
  48         std::map<std::string,ModSpec> modpack_content;
  49         ModSpec(const std::string &name_="", const std::string &path_=""):
  50                 name(name_),
  51                 path(path_),
  52                 depends(),
  53                 optdepends(),
  54                 unsatisfied_depends(),
  55                 part_of_modpack(false),
  56                 is_modpack(false),
  57                 modpack_content()
  58         {}
  59 };
  60
  61 // Retrieves depends, optdepends, is_modpack and modpack_content
  62 void parseModContents(ModSpec &mod);
  63
  64 std::map<std::string,ModSpec> getModsInPath(std::string path, bool part_of_modpack = false);
  65
  66 // replaces modpack Modspecs with their content
  67 std::vector<ModSpec> flattenMods(std::map<std::string,ModSpec> mods);
  68
  69 // a ModConfiguration is a subset of installed mods, expected to have
  70 // all dependencies fullfilled, so it can be used as a list of mods to
  71 // load when the game starts.
  72 class ModConfiguration
  73 {
  74 public:
  75         // checks if all dependencies are fullfilled.
  76         bool isConsistent() const
  77         {
  78                 return m_unsatisfied_mods.empty();
  79         }
  80
  81         std::vector<ModSpec> getMods()
  82         {
  83                 return m_sorted_mods;
  84         }
  85
  86         const std::vector<ModSpec> &getUnsatisfiedMods() const
  87         {
  88                 return m_unsatisfied_mods;
  89         }
  90
  91         void printUnsatisfiedModsError() const;
  92
  93 protected:
  94         ModConfiguration(const std::string &worldpath);
  95         // adds all mods in the given path. used for games, modpacks
  96         // and world-specific mods (worldmods-folders)
  97         void addModsInPath(const std::string &path);
  98
  99         // adds all mods in the set.
 100         void addMods(const std::vector<ModSpec> &new_mods);
 101
 102         void checkConflictsAndDeps();
 103 private:
 104         // move mods from m_unsatisfied_mods to m_sorted_mods
 105         // in an order that satisfies dependencies
 106         void resolveDependencies();
 107
 108         // mods with unmet dependencies. Before dependencies are resolved,
 109         // this is where all mods are stored. Afterwards this contains
 110         // only the ones with really unsatisfied dependencies.
 111         std::vector<ModSpec> m_unsatisfied_mods;
 112
 113         // list of mods sorted such that they can be loaded in the
 114         // given order with all dependencies being fullfilled. I.e.,
 115         // every mod in this list has only dependencies on mods which
 116         // appear earlier in the vector.
 117         std::vector<ModSpec> m_sorted_mods;
 118
 119         // set of mod names for which an unresolved name conflict
 120         // exists. A name conflict happens when two or more mods
 121         // at the same level have the same name but different paths.
 122         // Levels (mods in higher levels override mods in lower levels):
 123         // 1. game mod in modpack; 2. game mod;
 124         // 3. world mod in modpack; 4. world mod;
 125         // 5. addon mod in modpack; 6. addon mod.
 126         UNORDERED_SET<std::string> m_name_conflicts;
 127
 128         // Deleted default constructor
 129         ModConfiguration() {}
 130
 131 };
 132
 133 class ServerModConfiguration: public ModConfiguration
 134 {
 135 public:
 136         ServerModConfiguration(const std::string &worldpath);
 137
 138 };
 139
 140 #ifndef SERVER
 141 class ClientModConfiguration: public ModConfiguration
 142 {
 143 public:
 144         ClientModConfiguration(const std::string &path);
 145 };
 146 #endif
 147
 148 #if USE_CURL
 149 Json::Value getModstoreUrl(std::string url);
 150 #else
 151 inline Json::Value getModstoreUrl(std::string url) {
 152         return Json::Value();
 153 }
 154 #endif
 155
 156 struct ModLicenseInfo {
 157         int id;
 158         std::string shortinfo;
 159         std::string url;
 160 };
 161
 162 struct ModAuthorInfo {
 163         int id;
 164         std::string username;
 165 };
 166
 167 struct ModStoreMod {
 168         int id;
 169         std::string title;
 170         std::string basename;
 171         ModAuthorInfo author;
 172         float rating;
 173         bool valid;
 174 };
 175
 176 struct ModStoreCategoryInfo {
 177         int id;
 178         std::string name;
 179 };
 180
 181 struct ModStoreVersionEntry {
 182         int id;
 183         std::string date;
 184         std::string file;
 185         bool approved;
 186         //ugly version number
 187         int mtversion;
 188 };
 189
 190 struct ModStoreTitlePic {
 191         int id;
 192         std::string file;
 193         std::string description;
 194         int mod;
 195 };
 196
 197 struct ModStoreModDetails {
 198         /* version_set?? */
 199         std::vector<ModStoreCategoryInfo> categories;
 200         ModAuthorInfo author;
 201         ModLicenseInfo license;
 202         ModStoreTitlePic titlepic;
 203         int id;
 204         std::string title;
 205         std::string basename;
 206         std::string description;
 207         std::string repository;
 208         float rating;
 209         std::vector<std::string> depends;
 210         std::vector<std::string> softdeps;
 211
 212         std::string download_url;
 213         std::string screenshot_url;
 214         std::vector<ModStoreVersionEntry> versions;
 215         bool valid;
 216 };
 217
 218 class ModMetadata: public Metadata
 219 {
 220 public:
 221         ModMetadata(const std::string &mod_name);
 222         ~ModMetadata() {}
 223
 224         virtual void clear();
 225
 226         bool save(const std::string &root_path);
 227         bool load(const std::string &root_path);
 228
 229         bool isModified() const { return m_modified; }
 230         const std::string &getModName() const { return m_mod_name; }
 231
 232         virtual bool setString(const std::string &name, const std::string &var);
 233 private:
 234         std::string m_mod_name;
 235         bool m_modified;
 236 };
 237
 238 #endif