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"
30 #include "json/json.h"
34 #include <curl/curl.h>
37 #define MODNAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyz0123456789_"
39 class ModError : public std::exception
42 ModError(const std::string &s)
47 virtual ~ModError() throw()
49 virtual const char * what() const throw()
61 std::set<std::string> depends;
62 std::set<std::string> optdepends;
63 std::set<std::string> unsatisfied_depends;
68 std::map<std::string,ModSpec> modpack_content;
69 ModSpec(const std::string &name_="", const std::string &path_=""):
74 unsatisfied_depends(),
75 part_of_modpack(false),
81 // Retrieves depends, optdepends, is_modpack and modpack_content
82 void parseModContents(ModSpec &mod);
84 std::map<std::string,ModSpec> getModsInPath(std::string path, bool part_of_modpack = false);
86 // If failed, returned modspec has name==""
87 ModSpec findCommonMod(const std::string &modname);
89 // expands modpack contents, but does not replace them.
90 std::map<std::string, ModSpec> flattenModTree(std::map<std::string, ModSpec> mods);
92 // replaces modpack Modspecs with their content
93 std::vector<ModSpec> flattenMods(std::map<std::string,ModSpec> mods);
95 // a ModConfiguration is a subset of installed mods, expected to have
96 // all dependencies fullfilled, so it can be used as a list of mods to
97 // load when the game starts.
98 class ModConfiguration
102 m_unsatisfied_mods(),
108 ModConfiguration(std::string worldpath);
110 // checks if all dependencies are fullfilled.
113 return m_unsatisfied_mods.empty();
116 std::vector<ModSpec> getMods()
118 return m_sorted_mods;
121 std::vector<ModSpec> getUnsatisfiedMods()
123 return m_unsatisfied_mods;
127 // adds all mods in the given path. used for games, modpacks
128 // and world-specific mods (worldmods-folders)
129 void addModsInPath(std::string path);
131 // adds all mods in the set.
132 void addMods(std::vector<ModSpec> new_mods);
134 // move mods from m_unsatisfied_mods to m_sorted_mods
135 // in an order that satisfies dependencies
136 void resolveDependencies();
138 // mods with unmet dependencies. Before dependencies are resolved,
139 // this is where all mods are stored. Afterwards this contains
140 // only the ones with really unsatisfied dependencies.
141 std::vector<ModSpec> m_unsatisfied_mods;
143 // list of mods sorted such that they can be loaded in the
144 // given order with all dependencies being fullfilled. I.e.,
145 // every mod in this list has only dependencies on mods which
146 // appear earlier in the vector.
147 std::vector<ModSpec> m_sorted_mods;
149 // set of mod names for which an unresolved name conflict
150 // exists. A name conflict happens when two or more mods
151 // at the same level have the same name but different paths.
152 // Levels (mods in higher levels override mods in lower levels):
153 // 1. game mod in modpack; 2. game mod;
154 // 3. world mod in modpack; 4. world mod;
155 // 5. addon mod in modpack; 6. addon mod.
156 std::set<std::string> m_name_conflicts;
161 Json::Value getModstoreUrl(std::string url);
163 inline Json::Value getModstoreUrl(std::string url) {
164 return Json::Value();
168 struct ModLicenseInfo {
170 std::string shortinfo;
174 struct ModAuthorInfo {
176 std::string username;
182 std::string basename;
183 ModAuthorInfo author;
188 struct ModStoreCategoryInfo {
193 struct ModStoreVersionEntry {
198 //ugly version number
202 struct ModStoreTitlePic {
205 std::string description;
209 struct ModStoreModDetails {
211 std::vector<ModStoreCategoryInfo> categories;
212 ModAuthorInfo author;
213 ModLicenseInfo license;
214 ModStoreTitlePic titlepic;
217 std::string basename;
218 std::string description;
219 std::string repository;
221 std::vector<std::string> depends;
222 std::vector<std::string> softdeps;
224 std::string download_url;
225 std::string screenshot_url;
226 std::vector<ModStoreVersionEntry> versions;