[CSM] implement client side mod loading (#5123)
[oweals/minetest.git] / src / mods.h
index 59dffdade544ffab4a75ad1c8c36ccfcf42d8636..c9bd51d992f6e6b78478517050a876ca480316bf 100644 (file)
@@ -1,6 +1,6 @@
 /*
-Minetest-c55
-Copyright (C) 2011 celeron55, Perttu Ahola <celeron55@gmail.com>
+Minetest
+Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU Lesser General Public License as published by
@@ -21,96 +21,59 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #define MODS_HEADER
 
 #include "irrlichttypes.h"
-#include <irrList.h>
 #include <list>
 #include <set>
 #include <vector>
 #include <string>
 #include <map>
-#include <exception>
+#include <json/json.h>
+#include "util/cpp11_container.h"
+#include "config.h"
+#include "metadata.h"
 
-class ModError : public std::exception
-{
-public:
-       ModError(const std::string &s)
-       {
-               m_s = "ModError: ";
-               m_s += s;
-       }
-       virtual ~ModError() throw()
-       {}
-       virtual const char * what() const throw()
-       {
-               return m_s.c_str();
-       }
-       std::string m_s;
-};
+#define MODNAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyz0123456789_"
 
 struct ModSpec
 {
        std::string name;
        std::string path;
        //if normal mod:
-       std::set<std::string> depends;
-       std::set<std::string> unsatisfied_depends;
+       UNORDERED_SET<std::string> depends;
+       UNORDERED_SET<std::string> optdepends;
+       UNORDERED_SET<std::string> unsatisfied_depends;
 
+       bool part_of_modpack;
        bool is_modpack;
        // if modpack:
        std::map<std::string,ModSpec> modpack_content;
-       ModSpec(const std::string name_="", const std::string path_="",
-                       const std::set<std::string> depends_=std::set<std::string>()):
+       ModSpec(const std::string &name_="", const std::string &path_=""):
                name(name_),
                path(path_),
-               depends(depends_),
-               unsatisfied_depends(depends_),
-               is_modpack(false),      
-               modpack_content()       
+               depends(),
+               optdepends(),
+               unsatisfied_depends(),
+               part_of_modpack(false),
+               is_modpack(false),
+               modpack_content()
        {}
 };
 
+// Retrieves depends, optdepends, is_modpack and modpack_content
+void parseModContents(ModSpec &mod);
 
-std::map<std::string,ModSpec> getModsInPath(std::string path);
-
-// expands modpack contents, but does not replace them.
-std::map<std::string, ModSpec> flattenModTree(std::map<std::string, ModSpec> mods);
+std::map<std::string,ModSpec> getModsInPath(std::string path, bool part_of_modpack = false);
 
 // replaces modpack Modspecs with their content
 std::vector<ModSpec> flattenMods(std::map<std::string,ModSpec> mods);
 
-// removes Mods mentioned in exclude_mod_names
-std::vector<ModSpec> filterMods(std::vector<ModSpec> mods,
-                                                               std::set<std::string> exclude_mod_names);
-
 // a ModConfiguration is a subset of installed mods, expected to have
 // all dependencies fullfilled, so it can be used as a list of mods to
 // load when the game starts.
 class ModConfiguration
 {
 public:
-       ModConfiguration():
-               m_unsatisfied_mods(),
-               m_sorted_mods()
-       {}
-
-               
-       ModConfiguration(std::string worldpath);
-
-       // adds all mods in the given path. used for games, modpacks
-       // and world-specific mods (worldmods-folders)
-       void addModsInPath(std::string path)
-       {
-               addMods(flattenMods(getModsInPath(path)));
-       }
-
-       // adds all mods in the given path whose name does not appear
-       // in the exclude_mods set. 
-       void addModsInPathFiltered(std::string path, std::set<std::string> exclude_mods);
-
-       // adds all mods in the set.
-       void addMods(std::vector<ModSpec> mods);
-
        // checks if all dependencies are fullfilled.
-       bool isConsistent()
+       bool isConsistent() const
        {
                return m_unsatisfied_mods.empty();
        }
@@ -120,17 +83,32 @@ public:
                return m_sorted_mods;
        }
 
-       std::list<ModSpec> getUnsatisfiedMods()
+       const std::vector<ModSpec> &getUnsatisfiedMods() const
        {
                return m_unsatisfied_mods;
        }
 
+       void printUnsatisfiedModsError() const;
+
+protected:
+       ModConfiguration(const std::string &worldpath);
+       // adds all mods in the given path. used for games, modpacks
+       // and world-specific mods (worldmods-folders)
+       void addModsInPath(const std::string &path);
+
+       // adds all mods in the set.
+       void addMods(const std::vector<ModSpec> &new_mods);
+
+       void checkConflictsAndDeps();
 private:
+       // move mods from m_unsatisfied_mods to m_sorted_mods
+       // in an order that satisfies dependencies
+       void resolveDependencies();
 
-       // mods with unmet dependencies. This is a list and not a
-       // vector because we want easy removal of elements at every
-       // position.
-       std::list<ModSpec> m_unsatisfied_mods;
+       // mods with unmet dependencies. Before dependencies are resolved,
+       // this is where all mods are stored. Afterwards this contains
+       // only the ones with really unsatisfied dependencies.
+       std::vector<ModSpec> m_unsatisfied_mods;
 
        // list of mods sorted such that they can be loaded in the
        // given order with all dependencies being fullfilled. I.e.,
@@ -138,8 +116,123 @@ private:
        // appear earlier in the vector.
        std::vector<ModSpec> m_sorted_mods;
 
+       // set of mod names for which an unresolved name conflict
+       // exists. A name conflict happens when two or more mods
+       // at the same level have the same name but different paths.
+       // Levels (mods in higher levels override mods in lower levels):
+       // 1. game mod in modpack; 2. game mod;
+       // 3. world mod in modpack; 4. world mod;
+       // 5. addon mod in modpack; 6. addon mod.
+       UNORDERED_SET<std::string> m_name_conflicts;
+
+       // Deleted default constructor
+       ModConfiguration() {}
+
 };
 
+class ServerModConfiguration: public ModConfiguration
+{
+public:
+       ServerModConfiguration(const std::string &worldpath);
 
+};
+
+#ifndef SERVER
+class ClientModConfiguration: public ModConfiguration
+{
+public:
+       ClientModConfiguration(const std::string &path);
+};
 #endif
 
+#if USE_CURL
+Json::Value getModstoreUrl(std::string url);
+#else
+inline Json::Value getModstoreUrl(std::string url) {
+       return Json::Value();
+}
+#endif
+
+struct ModLicenseInfo {
+       int id;
+       std::string shortinfo;
+       std::string url;
+};
+
+struct ModAuthorInfo {
+       int id;
+       std::string username;
+};
+
+struct ModStoreMod {
+       int id;
+       std::string title;
+       std::string basename;
+       ModAuthorInfo author;
+       float rating;
+       bool valid;
+};
+
+struct ModStoreCategoryInfo {
+       int id;
+       std::string name;
+};
+
+struct ModStoreVersionEntry {
+       int id;
+       std::string date;
+       std::string file;
+       bool approved;
+       //ugly version number
+       int mtversion;
+};
+
+struct ModStoreTitlePic {
+       int id;
+       std::string file;
+       std::string description;
+       int mod;
+};
+
+struct ModStoreModDetails {
+       /* version_set?? */
+       std::vector<ModStoreCategoryInfo> categories;
+       ModAuthorInfo author;
+       ModLicenseInfo license;
+       ModStoreTitlePic titlepic;
+       int id;
+       std::string title;
+       std::string basename;
+       std::string description;
+       std::string repository;
+       float rating;
+       std::vector<std::string> depends;
+       std::vector<std::string> softdeps;
+
+       std::string download_url;
+       std::string screenshot_url;
+       std::vector<ModStoreVersionEntry> versions;
+       bool valid;
+};
+
+class ModMetadata: public Metadata
+{
+public:
+       ModMetadata(const std::string &mod_name);
+       ~ModMetadata() {}
+
+       virtual void clear();
+
+       bool save(const std::string &root_path);
+       bool load(const std::string &root_path);
+
+       bool isModified() const { return m_modified; }
+       const std::string &getModName() const { return m_mod_name; }
+
+       virtual bool setString(const std::string &name, const std::string &var);
+private:
+       std::string m_mod_name;
+       bool m_modified;
+};
+
+#endif