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.
23 #include "irrlichttypes.h"
32 #include "json/json.h"
36 #include <curl/curl.h>
39 #define MODNAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyz0123456789_"
41 class ModError : public std::exception
44 ModError(const std::string &s)
49 virtual ~ModError() throw()
51 virtual const char * what() const throw()
63 std::set<std::string> depends;
64 std::set<std::string> optdepends;
65 std::set<std::string> unsatisfied_depends;
70 std::map<std::string,ModSpec> modpack_content;
71 ModSpec(const std::string name_="", const std::string path_=""):
76 unsatisfied_depends(),
77 part_of_modpack(false),
83 // Retrieves depends, optdepends, is_modpack and modpack_content
84 void parseModContents(ModSpec &mod);
86 std::map<std::string,ModSpec> getModsInPath(std::string path, bool part_of_modpack = false);
88 // If failed, returned modspec has name==""
89 ModSpec findCommonMod(const std::string &modname);
91 // expands modpack contents, but does not replace them.
92 std::map<std::string, ModSpec> flattenModTree(std::map<std::string, ModSpec> mods);
94 // replaces modpack Modspecs with their content
95 std::vector<ModSpec> flattenMods(std::map<std::string,ModSpec> mods);
97 // a ModConfiguration is a subset of installed mods, expected to have
98 // all dependencies fullfilled, so it can be used as a list of mods to
99 // load when the game starts.
100 class ModConfiguration
104 m_unsatisfied_mods(),
110 ModConfiguration(std::string worldpath);
112 // checks if all dependencies are fullfilled.
115 return m_unsatisfied_mods.empty();
118 std::vector<ModSpec> getMods()
120 return m_sorted_mods;
123 std::vector<ModSpec> getUnsatisfiedMods()
125 return m_unsatisfied_mods;
129 // adds all mods in the given path. used for games, modpacks
130 // and world-specific mods (worldmods-folders)
131 void addModsInPath(std::string path);
133 // adds all mods in the set.
134 void addMods(std::vector<ModSpec> new_mods);
136 // move mods from m_unsatisfied_mods to m_sorted_mods
137 // in an order that satisfies dependencies
138 void resolveDependencies();
140 // mods with unmet dependencies. Before dependencies are resolved,
141 // this is where all mods are stored. Afterwards this contains
142 // only the ones with really unsatisfied dependencies.
143 std::vector<ModSpec> m_unsatisfied_mods;
145 // list of mods sorted such that they can be loaded in the
146 // given order with all dependencies being fullfilled. I.e.,
147 // every mod in this list has only dependencies on mods which
148 // appear earlier in the vector.
149 std::vector<ModSpec> m_sorted_mods;
151 // set of mod names for which an unresolved name conflict
152 // exists. A name conflict happens when two or more mods
153 // at the same level have the same name but different paths.
154 // Levels (mods in higher levels override mods in lower levels):
155 // 1. common mod in modpack; 2. common mod;
156 // 3. game mod in modpack; 4. game mod;
157 // 5. world mod in modpack; 6. world mod;
158 // 7. addon mod in modpack; 8. addon mod.
159 std::set<std::string> m_name_conflicts;
164 Json::Value getModstoreUrl(std::string url);
166 inline Json::Value getModstoreUrl(std::string url) {
167 return Json::Value();
171 struct ModLicenseInfo {
173 std::string shortinfo;
177 struct ModAuthorInfo {
179 std::string username;
185 std::string basename;
186 ModAuthorInfo author;
191 struct ModStoreCategoryInfo {
196 struct ModStoreVersionEntry {
201 //ugly version number
205 struct ModStoreTitlePic {
208 std::string description;
212 struct ModStoreModDetails {
214 std::vector<ModStoreCategoryInfo> categories;
215 ModAuthorInfo author;
216 ModLicenseInfo license;
217 ModStoreTitlePic titlepic;
220 std::string basename;
221 std::string description;
222 std::string repository;
224 std::vector<std::string> depends;
225 std::vector<std::string> softdeps;
227 std::string download_url;
228 std::string screenshot_url;
229 std::vector<ModStoreVersionEntry> versions;