ModManager.cpp 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893
  1. /*
  2. * ModManager.cpp, part of VCMI engine
  3. *
  4. * Authors: listed in file AUTHORS in main folder
  5. *
  6. * License: GNU General Public License v2.0 or later
  7. * Full text of license available in license.txt file, in main folder
  8. *
  9. */
  10. #include "StdInc.h"
  11. #include "ModManager.h"
  12. #include "ModDescription.h"
  13. #include "ModScope.h"
  14. #include "../constants/StringConstants.h"
  15. #include "../filesystem/Filesystem.h"
  16. #include "../json/JsonNode.h"
  17. #include "../texts/CGeneralTextHandler.h"
  18. VCMI_LIB_NAMESPACE_BEGIN
  19. static std::string getModDirectory(const TModID & modName)
  20. {
  21. std::string result = modName;
  22. boost::to_upper(result);
  23. boost::algorithm::replace_all(result, ".", "/MODS/");
  24. return "MODS/" + result;
  25. }
  26. static std::string getModSettingsDirectory(const TModID & modName)
  27. {
  28. return getModDirectory(modName) + "/MODS/";
  29. }
  30. static JsonPath getModDescriptionFile(const TModID & modName)
  31. {
  32. return JsonPath::builtin(getModDirectory(modName) + "/mod");
  33. }
  34. ModsState::ModsState()
  35. {
  36. modList.push_back(ModScope::scopeBuiltin());
  37. std::vector<TModID> testLocations = scanModsDirectory("MODS/");
  38. while(!testLocations.empty())
  39. {
  40. std::string target = testLocations.back();
  41. testLocations.pop_back();
  42. modList.push_back(boost::algorithm::to_lower_copy(target));
  43. for(const auto & submod : scanModsDirectory(getModSettingsDirectory(target)))
  44. testLocations.push_back(target + '.' + submod);
  45. }
  46. }
  47. TModList ModsState::getInstalledMods() const
  48. {
  49. return modList;
  50. }
  51. uint32_t ModsState::computeChecksum(const TModID & modName) const
  52. {
  53. boost::crc_32_type modChecksum;
  54. // first - add current VCMI version into checksum to force re-validation on VCMI updates
  55. modChecksum.process_bytes(static_cast<const void*>(GameConstants::VCMI_VERSION.data()), GameConstants::VCMI_VERSION.size());
  56. // second - add mod.json into checksum because filesystem does not contains this file
  57. if (modName != ModScope::scopeBuiltin())
  58. {
  59. auto modConfFile = getModDescriptionFile(modName);
  60. ui32 configChecksum = CResourceHandler::get("initial")->load(modConfFile)->calculateCRC32();
  61. modChecksum.process_bytes(static_cast<const void *>(&configChecksum), sizeof(configChecksum));
  62. }
  63. // third - add all detected text files from this mod into checksum
  64. const auto & filesystem = CResourceHandler::get(modName);
  65. auto files = filesystem->getFilteredFiles([](const ResourcePath & resID)
  66. {
  67. return resID.getType() == EResType::JSON && boost::starts_with(resID.getName(), "CONFIG");
  68. });
  69. for (const ResourcePath & file : files)
  70. {
  71. ui32 fileChecksum = filesystem->load(file)->calculateCRC32();
  72. modChecksum.process_bytes(static_cast<const void *>(&fileChecksum), sizeof(fileChecksum));
  73. }
  74. return modChecksum.checksum();
  75. }
  76. double ModsState::getInstalledModSizeMegabytes(const TModID & modName) const
  77. {
  78. ResourcePath resDir(getModDirectory(modName), EResType::DIRECTORY);
  79. std::string path = CResourceHandler::get()->getResourceName(resDir)->string();
  80. size_t sizeBytes = 0;
  81. for(boost::filesystem::recursive_directory_iterator it(path); it != boost::filesystem::recursive_directory_iterator(); ++it)
  82. {
  83. if(!boost::filesystem::is_directory(*it))
  84. sizeBytes += boost::filesystem::file_size(*it);
  85. }
  86. double sizeMegabytes = sizeBytes / static_cast<double>(1024*1024);
  87. return sizeMegabytes;
  88. }
  89. std::vector<TModID> ModsState::scanModsDirectory(const std::string & modDir) const
  90. {
  91. size_t depth = boost::range::count(modDir, '/');
  92. const auto & modScanFilter = [&](const ResourcePath & id) -> bool
  93. {
  94. if(id.getType() != EResType::DIRECTORY)
  95. return false;
  96. if(!boost::algorithm::starts_with(id.getName(), modDir))
  97. return false;
  98. if(boost::range::count(id.getName(), '/') != depth)
  99. return false;
  100. return true;
  101. };
  102. auto list = CResourceHandler::get("initial")->getFilteredFiles(modScanFilter);
  103. //storage for found mods
  104. std::vector<TModID> foundMods;
  105. for(const auto & entry : list)
  106. {
  107. std::string name = entry.getName();
  108. name.erase(0, modDir.size()); //Remove path prefix
  109. if(name.empty())
  110. continue;
  111. if(name.find('.') != std::string::npos)
  112. continue;
  113. if (ModScope::isScopeReserved(boost::to_lower_copy(name)))
  114. continue;
  115. if(!CResourceHandler::get("initial")->existsResource(JsonPath::builtin(entry.getName() + "/MOD")))
  116. continue;
  117. foundMods.push_back(name);
  118. }
  119. return foundMods;
  120. }
  121. ///////////////////////////////////////////////////////////////////////////////
  122. ModsPresetState::ModsPresetState()
  123. {
  124. static const JsonPath settingsPath = JsonPath::builtin("config/modSettings.json");
  125. if(CResourceHandler::get("local")->existsResource(ResourcePath(settingsPath)))
  126. {
  127. modConfig = JsonNode(settingsPath);
  128. }
  129. else
  130. {
  131. // Probably new install. Create initial configuration
  132. CResourceHandler::get("local")->createResource(settingsPath.getOriginalName() + ".json");
  133. }
  134. if(modConfig["presets"].isNull() || modConfig["presets"].Struct().empty())
  135. {
  136. modConfig["activePreset"] = JsonNode("default");
  137. if(modConfig["activeMods"].isNull())
  138. createInitialPreset(); // new install
  139. else
  140. importInitialPreset(); // 1.5 format import
  141. }
  142. auto allPresets = getAllPresets();
  143. if (!vstd::contains(allPresets, modConfig["activePreset"].String()))
  144. modConfig["activePreset"] = JsonNode(allPresets.front());
  145. logGlobal->debug("Loading following mod settings: %s", modConfig.toCompactString());
  146. }
  147. void ModsPresetState::createInitialPreset()
  148. {
  149. // TODO: scan mods directory for all its content? Probably unnecessary since this looks like new install, but who knows?
  150. modConfig["presets"]["default"]["mods"].Vector().emplace_back("vcmi");
  151. }
  152. void ModsPresetState::importInitialPreset()
  153. {
  154. JsonNode preset;
  155. for(const auto & mod : modConfig["activeMods"].Struct())
  156. {
  157. if(mod.second["active"].Bool())
  158. preset["mods"].Vector().emplace_back(mod.first);
  159. for(const auto & submod : mod.second["mods"].Struct())
  160. preset["settings"][mod.first][submod.first] = submod.second["active"];
  161. }
  162. modConfig["presets"]["default"] = preset;
  163. }
  164. const JsonNode & ModsPresetState::getActivePresetConfig() const
  165. {
  166. const std::string & currentPresetName = modConfig["activePreset"].String();
  167. const JsonNode & currentPreset = modConfig["presets"][currentPresetName];
  168. return currentPreset;
  169. }
  170. TModList ModsPresetState::getActiveRootMods() const
  171. {
  172. return getRootMods(getActivePreset());
  173. }
  174. TModList ModsPresetState::getRootMods(const std::string & presetName) const
  175. {
  176. const JsonNode & modsToActivateJson = modConfig["presets"][presetName]["mods"];
  177. auto modsToActivate = modsToActivateJson.convertTo<std::vector<TModID>>();
  178. if (!vstd::contains(modsToActivate, ModScope::scopeBuiltin()))
  179. modsToActivate.push_back(ModScope::scopeBuiltin());
  180. return modsToActivate;
  181. }
  182. std::map<TModID, bool> ModsPresetState::getModSettings(const TModID & modID) const
  183. {
  184. const JsonNode & modSettingsJson = getActivePresetConfig()["settings"][modID];
  185. auto modSettings = modSettingsJson.convertTo<std::map<TModID, bool>>();
  186. return modSettings;
  187. }
  188. std::optional<uint32_t> ModsPresetState::getValidatedChecksum(const TModID & modName) const
  189. {
  190. const JsonNode & node = modConfig["validatedMods"][modName];
  191. if (node.isNull())
  192. return std::nullopt;
  193. else
  194. return node.Integer();
  195. }
  196. void ModsPresetState::setModActive(const TModID & modID, bool isActive)
  197. {
  198. size_t dotPos = modID.find('.');
  199. if(dotPos != std::string::npos)
  200. {
  201. std::string rootMod = modID.substr(0, dotPos);
  202. std::string settingID = modID.substr(dotPos + 1);
  203. setSettingActive(rootMod, settingID, isActive);
  204. }
  205. else
  206. {
  207. if (isActive)
  208. addRootMod(modID);
  209. else
  210. eraseRootMod(modID);
  211. }
  212. }
  213. void ModsPresetState::addRootMod(const TModID & modName)
  214. {
  215. const std::string & currentPresetName = modConfig["activePreset"].String();
  216. JsonNode & currentPreset = modConfig["presets"][currentPresetName];
  217. if (!vstd::contains(currentPreset["mods"].Vector(), JsonNode(modName)))
  218. currentPreset["mods"].Vector().emplace_back(modName);
  219. }
  220. void ModsPresetState::setSettingActive(const TModID & modName, const TModID & settingName, bool isActive)
  221. {
  222. const std::string & currentPresetName = modConfig["activePreset"].String();
  223. JsonNode & currentPreset = modConfig["presets"][currentPresetName];
  224. currentPreset["settings"][modName][settingName].Bool() = isActive;
  225. }
  226. void ModsPresetState::removeOldMods(const TModList & modsToKeep)
  227. {
  228. const std::string & currentPresetName = modConfig["activePreset"].String();
  229. JsonNode & currentPreset = modConfig["presets"][currentPresetName];
  230. vstd::erase_if(currentPreset["mods"].Vector(), [&](const JsonNode & entry){
  231. return !vstd::contains(modsToKeep, entry.String());
  232. });
  233. vstd::erase_if(currentPreset["settings"].Struct(), [&](const auto & entry){
  234. return !vstd::contains(modsToKeep, entry.first);
  235. });
  236. for (auto & modSettings : currentPreset["settings"].Struct())
  237. {
  238. vstd::erase_if(modSettings.second.Struct(), [&](const auto & entry){
  239. return !vstd::contains(modsToKeep, modSettings.first + "." + entry.first);
  240. });
  241. }
  242. }
  243. void ModsPresetState::eraseRootMod(const TModID & modName)
  244. {
  245. const std::string & currentPresetName = modConfig["activePreset"].String();
  246. JsonNode & currentPreset = modConfig["presets"][currentPresetName];
  247. vstd::erase(currentPreset["mods"].Vector(), JsonNode(modName));
  248. }
  249. void ModsPresetState::eraseModSetting(const TModID & modName, const TModID & settingName)
  250. {
  251. const std::string & currentPresetName = modConfig["activePreset"].String();
  252. JsonNode & currentPreset = modConfig["presets"][currentPresetName];
  253. currentPreset["settings"][modName].Struct().erase(settingName);
  254. }
  255. std::vector<TModID> ModsPresetState::getActiveMods() const
  256. {
  257. TModList activeRootMods = getActiveRootMods();
  258. TModList allActiveMods;
  259. for(const auto & activeMod : activeRootMods)
  260. {
  261. assert(!vstd::contains(allActiveMods, activeMod));
  262. allActiveMods.push_back(activeMod);
  263. for(const auto & submod : getModSettings(activeMod))
  264. {
  265. if(submod.second)
  266. {
  267. assert(!vstd::contains(allActiveMods, activeMod + '.' + submod.first));
  268. allActiveMods.push_back(activeMod + '.' + submod.first);
  269. }
  270. }
  271. }
  272. return allActiveMods;
  273. }
  274. void ModsPresetState::setValidatedChecksum(const TModID & modName, std::optional<uint32_t> value)
  275. {
  276. if (value.has_value())
  277. modConfig["validatedMods"][modName].Integer() = *value;
  278. else
  279. modConfig["validatedMods"].Struct().erase(modName);
  280. }
  281. void ModsPresetState::saveConfigurationState() const
  282. {
  283. std::fstream file(CResourceHandler::get()->getResourceName(ResourcePath("config/modSettings.json"))->c_str(), std::ofstream::out | std::ofstream::trunc);
  284. file << modConfig.toCompactString();
  285. }
  286. void ModsPresetState::createNewPreset(const std::string & presetName)
  287. {
  288. if (modConfig["presets"][presetName].isNull())
  289. modConfig["presets"][presetName]["mods"].Vector().emplace_back("vcmi");
  290. }
  291. void ModsPresetState::deletePreset(const std::string & presetName)
  292. {
  293. if (modConfig["presets"].Struct().size() < 2)
  294. throw std::runtime_error("Unable to delete last preset!");
  295. modConfig["presets"].Struct().erase(presetName);
  296. }
  297. void ModsPresetState::activatePreset(const std::string & presetName)
  298. {
  299. if (modConfig["presets"].Struct().count(presetName) == 0)
  300. throw std::runtime_error("Unable to activate non-exinsting preset!");
  301. modConfig["activePreset"].String() = presetName;
  302. }
  303. void ModsPresetState::renamePreset(const std::string & oldPresetName, const std::string & newPresetName)
  304. {
  305. if (oldPresetName == newPresetName)
  306. throw std::runtime_error("Unable to rename preset to the same name!");
  307. if (modConfig["presets"].Struct().count(oldPresetName) == 0)
  308. throw std::runtime_error("Unable to rename non-existing last preset!");
  309. if (modConfig["presets"].Struct().count(newPresetName) != 0)
  310. throw std::runtime_error("Unable to rename preset - preset with such name already exists!");
  311. modConfig["presets"][newPresetName] = modConfig["presets"][oldPresetName];
  312. modConfig["presets"].Struct().erase(oldPresetName);
  313. if (modConfig["activePreset"].String() == oldPresetName)
  314. modConfig["activePreset"].String() = newPresetName;
  315. }
  316. std::vector<std::string> ModsPresetState::getAllPresets() const
  317. {
  318. std::vector<std::string> presets;
  319. for (const auto & preset : modConfig["presets"].Struct())
  320. presets.push_back(preset.first);
  321. return presets;
  322. }
  323. std::string ModsPresetState::getActivePreset() const
  324. {
  325. return modConfig["activePreset"].String();
  326. }
  327. JsonNode ModsPresetState::exportCurrentPreset() const
  328. {
  329. JsonNode data = getActivePresetConfig();
  330. std::string presetName = getActivePreset();
  331. data["name"] = JsonNode(presetName);
  332. vstd::erase_if(data["settings"].Struct(), [&](const auto & pair){
  333. return !vstd::contains(data["mods"].Vector(), JsonNode(pair.first));
  334. });
  335. return data;
  336. }
  337. std::string ModsPresetState::importPreset(const JsonNode & newConfig)
  338. {
  339. std::string importedPresetName = newConfig["name"].String();
  340. if (importedPresetName.empty())
  341. throw std::runtime_error("Attempt to import invalid preset");
  342. modConfig["presets"][importedPresetName] = newConfig;
  343. modConfig["presets"][importedPresetName].Struct().erase("name");
  344. return importedPresetName;
  345. }
  346. ModsStorage::ModsStorage(const std::vector<TModID> & modsToLoad, const JsonNode & repositoryList)
  347. {
  348. JsonNode coreModConfig(JsonPath::builtin("config/gameConfig.json"));
  349. coreModConfig.setModScope(ModScope::scopeBuiltin());
  350. mods.try_emplace(ModScope::scopeBuiltin(), ModScope::scopeBuiltin(), coreModConfig, JsonNode());
  351. // MODS COMPATIBILITY: in 1.6, repository list contains mod list directly, in 1.7 it is located in 'availableMods' node
  352. const auto & availableRepositoryMods = repositoryList["availableMods"].isNull() ? repositoryList : repositoryList["availableMods"];
  353. for(auto modID : modsToLoad)
  354. {
  355. if(ModScope::isScopeReserved(modID))
  356. continue;
  357. JsonNode modConfig(getModDescriptionFile(modID));
  358. modConfig.setModScope(modID);
  359. if(modConfig["modType"].isNull())
  360. {
  361. logMod->error("Can not load mod %s - invalid mod config file!", modID);
  362. continue;
  363. }
  364. mods.try_emplace(modID, modID, modConfig, availableRepositoryMods[modID]);
  365. }
  366. for(const auto & mod : availableRepositoryMods.Struct())
  367. {
  368. if (vstd::contains(modsToLoad, mod.first))
  369. continue;
  370. if (mod.second["modType"].isNull() || mod.second["name"].isNull())
  371. continue;
  372. mods.try_emplace(mod.first, mod.first, JsonNode(), mod.second);
  373. }
  374. }
  375. const ModDescription & ModsStorage::getMod(const TModID & fullID) const
  376. {
  377. try {
  378. return mods.at(fullID);
  379. }
  380. catch (const std::out_of_range & )
  381. {
  382. // rethrow with better error message
  383. throw std::out_of_range("Failed to find mod " + fullID);
  384. }
  385. }
  386. TModList ModsStorage::getAllMods() const
  387. {
  388. TModList result;
  389. for (const auto & mod : mods)
  390. result.push_back(mod.first);
  391. return result;
  392. }
  393. ModManager::ModManager()
  394. :ModManager(JsonNode())
  395. {
  396. }
  397. ModManager::ModManager(const JsonNode & repositoryList)
  398. : modsState(std::make_unique<ModsState>())
  399. , modsPreset(std::make_unique<ModsPresetState>())
  400. {
  401. modsStorage = std::make_unique<ModsStorage>(modsState->getInstalledMods(), repositoryList);
  402. eraseMissingModsFromPreset();
  403. addNewModsToPreset();
  404. std::vector<TModID> desiredModList = modsPreset->getActiveMods();
  405. ModDependenciesResolver newResolver(desiredModList, *modsStorage);
  406. updatePreset(newResolver);
  407. }
  408. ModManager::~ModManager() = default;
  409. const ModDescription & ModManager::getModDescription(const TModID & modID) const
  410. {
  411. assert(boost::to_lower_copy(modID) == modID);
  412. return modsStorage->getMod(modID);
  413. }
  414. bool ModManager::isModSettingActive(const TModID & rootModID, const TModID & modSettingID) const
  415. {
  416. return modsPreset->getModSettings(rootModID).at(modSettingID);
  417. }
  418. bool ModManager::isModActive(const TModID & modID) const
  419. {
  420. return vstd::contains(getActiveMods(), modID);
  421. }
  422. const TModList & ModManager::getActiveMods() const
  423. {
  424. return depedencyResolver->getActiveMods();
  425. }
  426. uint32_t ModManager::computeChecksum(const TModID & modName) const
  427. {
  428. return modsState->computeChecksum(modName);
  429. }
  430. std::optional<uint32_t> ModManager::getValidatedChecksum(const TModID & modName) const
  431. {
  432. return modsPreset->getValidatedChecksum(modName);
  433. }
  434. void ModManager::setValidatedChecksum(const TModID & modName, std::optional<uint32_t> value)
  435. {
  436. modsPreset->setValidatedChecksum(modName, value);
  437. }
  438. void ModManager::saveConfigurationState() const
  439. {
  440. modsPreset->saveConfigurationState();
  441. }
  442. TModList ModManager::getAllMods() const
  443. {
  444. return modsStorage->getAllMods();
  445. }
  446. double ModManager::getInstalledModSizeMegabytes(const TModID & modName) const
  447. {
  448. return modsState->getInstalledModSizeMegabytes(modName);
  449. }
  450. void ModManager::eraseMissingModsFromPreset()
  451. {
  452. const TModList & installedMods = getInstalledValidMods();
  453. const TModList & rootMods = modsPreset->getActiveRootMods();
  454. modsPreset->removeOldMods(installedMods);
  455. for(const auto & rootMod : rootMods)
  456. {
  457. const auto & modSettings = modsPreset->getModSettings(rootMod);
  458. for(const auto & modSetting : modSettings)
  459. {
  460. TModID fullModID = rootMod + '.' + modSetting.first;
  461. if(!vstd::contains(installedMods, fullModID))
  462. {
  463. modsPreset->eraseModSetting(rootMod, modSetting.first);
  464. continue;
  465. }
  466. }
  467. }
  468. }
  469. void ModManager::addNewModsToPreset()
  470. {
  471. const TModList & installedMods = getInstalledValidMods();
  472. for(const auto & modID : installedMods)
  473. {
  474. size_t dotPos = modID.find('.');
  475. if(dotPos == std::string::npos)
  476. continue; // only look up submods aka mod settings
  477. std::string rootMod = modID.substr(0, dotPos);
  478. std::string settingID = modID.substr(dotPos + 1);
  479. const auto & modSettings = modsPreset->getModSettings(rootMod);
  480. if (!modSettings.count(settingID))
  481. modsPreset->setSettingActive(rootMod, settingID, !modsStorage->getMod(modID).keepDisabled());
  482. }
  483. }
  484. TModList ModManager::getInstalledValidMods() const
  485. {
  486. TModList installedMods = modsState->getInstalledMods();
  487. TModList validMods = modsStorage->getAllMods();
  488. TModList result;
  489. for (const auto & modID : installedMods)
  490. if (vstd::contains(validMods, modID))
  491. result.push_back(modID);
  492. return result;
  493. }
  494. TModList ModManager::collectDependenciesRecursive(const TModID & modID) const
  495. {
  496. TModList result;
  497. TModList toTest;
  498. toTest.push_back(modID);
  499. while (!toTest.empty())
  500. {
  501. TModID currentModID = toTest.back();
  502. const auto & currentMod = getModDescription(currentModID);
  503. toTest.pop_back();
  504. result.push_back(currentModID);
  505. if (!currentMod.isInstalled())
  506. throw std::runtime_error("Unable to enable mod " + modID + "! Dependency " + currentModID + " is not installed!");
  507. for (const auto & dependency : currentMod.getDependencies())
  508. {
  509. if (!vstd::contains(result, dependency))
  510. toTest.push_back(dependency);
  511. }
  512. }
  513. return result;
  514. }
  515. void ModManager::tryEnableMods(const TModList & modList)
  516. {
  517. TModList requiredActiveMods;
  518. TModList additionalActiveMods = getActiveMods();
  519. for (const auto & modName : modList)
  520. {
  521. for (const auto & dependency : collectDependenciesRecursive(modName))
  522. {
  523. if (!vstd::contains(requiredActiveMods, dependency))
  524. {
  525. requiredActiveMods.push_back(dependency);
  526. vstd::erase(additionalActiveMods, dependency);
  527. }
  528. }
  529. assert(!vstd::contains(additionalActiveMods, modName));
  530. assert(vstd::contains(requiredActiveMods, modName));// FIXME: fails on attempt to enable broken mod / translation to other language
  531. }
  532. ModDependenciesResolver testResolver(requiredActiveMods, *modsStorage);
  533. testResolver.tryAddMods(additionalActiveMods, *modsStorage);
  534. TModList additionalActiveSubmods;
  535. for (const auto & modName : modList)
  536. {
  537. if (modName.find('.') != std::string::npos)
  538. continue;
  539. auto modSettings = modsPreset->getModSettings(modName);
  540. for (const auto & entry : modSettings)
  541. {
  542. TModID fullModID = modName + '.' + entry.first;
  543. if (entry.second && !vstd::contains(requiredActiveMods, fullModID))
  544. additionalActiveSubmods.push_back(fullModID);
  545. }
  546. }
  547. testResolver.tryAddMods(additionalActiveSubmods, *modsStorage);
  548. for (const auto & modName : modList)
  549. if (!vstd::contains(testResolver.getActiveMods(), modName))
  550. logGlobal->error("Failed to enable mod '%s'! This may be caused by a recursive dependency!", modName);
  551. updatePreset(testResolver);
  552. }
  553. void ModManager::tryDisableMod(const TModID & modName)
  554. {
  555. auto desiredActiveMods = getActiveMods();
  556. assert(vstd::contains(desiredActiveMods, modName));
  557. vstd::erase(desiredActiveMods, modName);
  558. ModDependenciesResolver testResolver(desiredActiveMods, *modsStorage);
  559. if (vstd::contains(testResolver.getActiveMods(), modName))
  560. throw std::runtime_error("Failed to disable mod! Mod " + modName + " remains enabled!");
  561. modsPreset->setModActive(modName, false);
  562. updatePreset(testResolver);
  563. }
  564. void ModManager::updatePreset(const ModDependenciesResolver & testResolver)
  565. {
  566. const auto & newActiveMods = testResolver.getActiveMods();
  567. const auto & newBrokenMods = testResolver.getBrokenMods();
  568. for (const auto & modID : newActiveMods)
  569. {
  570. assert(vstd::contains(getInstalledValidMods(), modID));
  571. modsPreset->setModActive(modID, true);
  572. }
  573. for (const auto & modID : newBrokenMods)
  574. {
  575. const auto & mod = getModDescription(modID);
  576. if (mod.getTopParentID().empty() || vstd::contains(newActiveMods, mod.getTopParentID()))
  577. modsPreset->setModActive(modID, false);
  578. }
  579. std::vector<TModID> desiredModList = modsPreset->getActiveMods();
  580. // Try to enable all existing compatibility patches. Ignore on failure
  581. for (const auto & rootMod : modsPreset->getActiveRootMods())
  582. {
  583. for (const auto & modSetting : modsPreset->getModSettings(rootMod))
  584. {
  585. if (modSetting.second)
  586. continue;
  587. TModID fullModID = rootMod + '.' + modSetting.first;
  588. const auto & modDescription = modsStorage->getMod(fullModID);
  589. if (modDescription.isCompatibility())
  590. desiredModList.push_back(fullModID);
  591. }
  592. }
  593. depedencyResolver = std::make_unique<ModDependenciesResolver>(desiredModList, *modsStorage);
  594. modsPreset->saveConfigurationState();
  595. }
  596. ModDependenciesResolver::ModDependenciesResolver(const TModList & modsToResolve, const ModsStorage & storage)
  597. {
  598. tryAddMods(modsToResolve, storage);
  599. }
  600. const TModList & ModDependenciesResolver::getActiveMods() const
  601. {
  602. return activeMods;
  603. }
  604. const TModList & ModDependenciesResolver::getBrokenMods() const
  605. {
  606. return brokenMods;
  607. }
  608. void ModDependenciesResolver::tryAddMods(TModList modsToResolve, const ModsStorage & storage)
  609. {
  610. // Topological sort algorithm.
  611. boost::range::sort(modsToResolve); // Sort mods per name
  612. std::vector<TModID> sortedValidMods(activeMods.begin(), activeMods.end()); // Vector keeps order of elements (LIFO)
  613. std::set<TModID> resolvedModIDs(activeMods.begin(), activeMods.end()); // Use a set for validation for performance reason, but set does not keep order of elements
  614. std::set<TModID> notResolvedModIDs(modsToResolve.begin(), modsToResolve.end()); // Use a set for validation for performance reason
  615. // Mod is resolved if it has no dependencies or all its dependencies are already resolved
  616. auto isResolved = [&](const ModDescription & mod) -> bool
  617. {
  618. if (mod.isTranslation() && CGeneralTextHandler::getPreferredLanguage() != mod.getBaseLanguage())
  619. return false;
  620. if(!mod.isCompatible())
  621. return false;
  622. if(mod.getDependencies().size() > resolvedModIDs.size())
  623. return false;
  624. for(const TModID & dependency : mod.getDependencies())
  625. if(!vstd::contains(resolvedModIDs, dependency))
  626. return false;
  627. for(const TModID & softDependency : mod.getSoftDependencies())
  628. if(vstd::contains(notResolvedModIDs, softDependency))
  629. return false;
  630. for(const TModID & conflict : mod.getConflicts())
  631. if(vstd::contains(resolvedModIDs, conflict))
  632. return false;
  633. for(const TModID & reverseConflict : resolvedModIDs)
  634. if(vstd::contains(storage.getMod(reverseConflict).getConflicts(), mod.getID()))
  635. return false;
  636. return true;
  637. };
  638. while(true)
  639. {
  640. std::set<TModID> resolvedOnCurrentTreeLevel;
  641. for(auto it = modsToResolve.begin(); it != modsToResolve.end();) // One iteration - one level of mods tree
  642. {
  643. if(isResolved(storage.getMod(*it)))
  644. {
  645. resolvedOnCurrentTreeLevel.insert(*it); // Not to the resolvedModIDs, so current node children will be resolved on the next iteration
  646. assert(!vstd::contains(sortedValidMods, *it));
  647. if(storage.getMod(*it).getValue("modType").String() == "Resources") // Resources needs to load before core to make it possible to override core elements with new resources and for correct init of ResourceSet
  648. sortedValidMods.insert(sortedValidMods.begin(), *it);
  649. else
  650. sortedValidMods.push_back(*it);
  651. it = modsToResolve.erase(it);
  652. continue;
  653. }
  654. it++;
  655. }
  656. if(!resolvedOnCurrentTreeLevel.empty())
  657. {
  658. resolvedModIDs.insert(resolvedOnCurrentTreeLevel.begin(), resolvedOnCurrentTreeLevel.end());
  659. for(const auto & it : resolvedOnCurrentTreeLevel)
  660. notResolvedModIDs.erase(it);
  661. continue;
  662. }
  663. // If there are no valid mods on the current mods tree level, no more mod can be resolved, should be ended.
  664. break;
  665. }
  666. assert(!sortedValidMods.empty());
  667. activeMods = sortedValidMods;
  668. brokenMods.insert(brokenMods.end(), modsToResolve.begin(), modsToResolve.end());
  669. }
  670. void ModManager::createNewPreset(const std::string & presetName)
  671. {
  672. modsPreset->createNewPreset(presetName);
  673. modsPreset->saveConfigurationState();
  674. }
  675. void ModManager::deletePreset(const std::string & presetName)
  676. {
  677. modsPreset->deletePreset(presetName);
  678. modsPreset->saveConfigurationState();
  679. }
  680. void ModManager::activatePreset(const std::string & presetName)
  681. {
  682. modsPreset->activatePreset(presetName);
  683. modsPreset->saveConfigurationState();
  684. }
  685. void ModManager::renamePreset(const std::string & oldPresetName, const std::string & newPresetName)
  686. {
  687. modsPreset->renamePreset(oldPresetName, newPresetName);
  688. modsPreset->saveConfigurationState();
  689. }
  690. std::vector<std::string> ModManager::getAllPresets() const
  691. {
  692. return modsPreset->getAllPresets();
  693. }
  694. std::string ModManager::getActivePreset() const
  695. {
  696. return modsPreset->getActivePreset();
  697. }
  698. JsonNode ModManager::exportCurrentPreset() const
  699. {
  700. return modsPreset->exportCurrentPreset();
  701. }
  702. std::tuple<std::string, TModList> ModManager::importPreset(const JsonNode & data)
  703. {
  704. std::string presetName = modsPreset->importPreset(data);
  705. TModList requiredMods = modsPreset->getRootMods(presetName);
  706. TModList installedMods = getInstalledValidMods();
  707. TModList missingMods;
  708. for (const auto & modID : requiredMods)
  709. {
  710. if (!vstd::contains(installedMods, modID))
  711. missingMods.push_back(modID);
  712. }
  713. modsPreset->saveConfigurationState();
  714. return {presetName, missingMods};
  715. }
  716. VCMI_LIB_NAMESPACE_END