ModManager.cpp 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835
  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. }
  146. void ModsPresetState::createInitialPreset()
  147. {
  148. // TODO: scan mods directory for all its content? Probably unnecessary since this looks like new install, but who knows?
  149. modConfig["presets"]["default"]["mods"].Vector().emplace_back("vcmi");
  150. }
  151. void ModsPresetState::importInitialPreset()
  152. {
  153. JsonNode preset;
  154. for(const auto & mod : modConfig["activeMods"].Struct())
  155. {
  156. if(mod.second["active"].Bool())
  157. preset["mods"].Vector().emplace_back(mod.first);
  158. for(const auto & submod : mod.second["mods"].Struct())
  159. preset["settings"][mod.first][submod.first] = submod.second["active"];
  160. }
  161. modConfig["presets"]["default"] = preset;
  162. }
  163. const JsonNode & ModsPresetState::getActivePresetConfig() const
  164. {
  165. const std::string & currentPresetName = modConfig["activePreset"].String();
  166. const JsonNode & currentPreset = modConfig["presets"][currentPresetName];
  167. return currentPreset;
  168. }
  169. TModList ModsPresetState::getActiveRootMods() const
  170. {
  171. const JsonNode & modsToActivateJson = getActivePresetConfig()["mods"];
  172. auto modsToActivate = modsToActivateJson.convertTo<std::vector<TModID>>();
  173. if (!vstd::contains(modsToActivate, ModScope::scopeBuiltin()))
  174. modsToActivate.push_back(ModScope::scopeBuiltin());
  175. return modsToActivate;
  176. }
  177. std::map<TModID, bool> ModsPresetState::getModSettings(const TModID & modID) const
  178. {
  179. const JsonNode & modSettingsJson = getActivePresetConfig()["settings"][modID];
  180. auto modSettings = modSettingsJson.convertTo<std::map<TModID, bool>>();
  181. return modSettings;
  182. }
  183. std::optional<uint32_t> ModsPresetState::getValidatedChecksum(const TModID & modName) const
  184. {
  185. const JsonNode & node = modConfig["validatedMods"][modName];
  186. if (node.isNull())
  187. return std::nullopt;
  188. else
  189. return node.Integer();
  190. }
  191. void ModsPresetState::setModActive(const TModID & modID, bool isActive)
  192. {
  193. size_t dotPos = modID.find('.');
  194. if(dotPos != std::string::npos)
  195. {
  196. std::string rootMod = modID.substr(0, dotPos);
  197. std::string settingID = modID.substr(dotPos + 1);
  198. setSettingActive(rootMod, settingID, isActive);
  199. }
  200. else
  201. {
  202. if (isActive)
  203. addRootMod(modID);
  204. else
  205. eraseRootMod(modID);
  206. }
  207. }
  208. void ModsPresetState::addRootMod(const TModID & modName)
  209. {
  210. const std::string & currentPresetName = modConfig["activePreset"].String();
  211. JsonNode & currentPreset = modConfig["presets"][currentPresetName];
  212. if (!vstd::contains(currentPreset["mods"].Vector(), JsonNode(modName)))
  213. currentPreset["mods"].Vector().emplace_back(modName);
  214. }
  215. void ModsPresetState::setSettingActive(const TModID & modName, const TModID & settingName, bool isActive)
  216. {
  217. const std::string & currentPresetName = modConfig["activePreset"].String();
  218. JsonNode & currentPreset = modConfig["presets"][currentPresetName];
  219. currentPreset["settings"][modName][settingName].Bool() = isActive;
  220. }
  221. void ModsPresetState::removeOldMods(const TModList & modsToKeep)
  222. {
  223. const std::string & currentPresetName = modConfig["activePreset"].String();
  224. JsonNode & currentPreset = modConfig["presets"][currentPresetName];
  225. vstd::erase_if(currentPreset["mods"].Vector(), [&](const JsonNode & entry){
  226. return !vstd::contains(modsToKeep, entry.String());
  227. });
  228. vstd::erase_if(currentPreset["settings"].Struct(), [&](const auto & entry){
  229. return !vstd::contains(modsToKeep, entry.first);
  230. });
  231. }
  232. void ModsPresetState::eraseRootMod(const TModID & modName)
  233. {
  234. const std::string & currentPresetName = modConfig["activePreset"].String();
  235. JsonNode & currentPreset = modConfig["presets"][currentPresetName];
  236. vstd::erase(currentPreset["mods"].Vector(), JsonNode(modName));
  237. }
  238. void ModsPresetState::eraseModSetting(const TModID & modName, const TModID & settingName)
  239. {
  240. const std::string & currentPresetName = modConfig["activePreset"].String();
  241. JsonNode & currentPreset = modConfig["presets"][currentPresetName];
  242. currentPreset["settings"][modName].Struct().erase(settingName);
  243. }
  244. std::vector<TModID> ModsPresetState::getActiveMods() const
  245. {
  246. TModList activeRootMods = getActiveRootMods();
  247. TModList allActiveMods;
  248. for(const auto & activeMod : activeRootMods)
  249. {
  250. assert(!vstd::contains(allActiveMods, activeMod));
  251. allActiveMods.push_back(activeMod);
  252. for(const auto & submod : getModSettings(activeMod))
  253. {
  254. if(submod.second)
  255. {
  256. assert(!vstd::contains(allActiveMods, activeMod + '.' + submod.first));
  257. allActiveMods.push_back(activeMod + '.' + submod.first);
  258. }
  259. }
  260. }
  261. return allActiveMods;
  262. }
  263. void ModsPresetState::setValidatedChecksum(const TModID & modName, std::optional<uint32_t> value)
  264. {
  265. if (value.has_value())
  266. modConfig["validatedMods"][modName].Integer() = *value;
  267. else
  268. modConfig["validatedMods"].Struct().erase(modName);
  269. }
  270. void ModsPresetState::saveConfigurationState() const
  271. {
  272. std::fstream file(CResourceHandler::get()->getResourceName(ResourcePath("config/modSettings.json"))->c_str(), std::ofstream::out | std::ofstream::trunc);
  273. file << modConfig.toCompactString();
  274. }
  275. void ModsPresetState::createNewPreset(const std::string & presetName)
  276. {
  277. if (modConfig["presets"][presetName].isNull())
  278. modConfig["presets"][presetName]["mods"].Vector().emplace_back("vcmi");
  279. }
  280. void ModsPresetState::deletePreset(const std::string & presetName)
  281. {
  282. if (modConfig["presets"].Struct().size() < 2)
  283. throw std::runtime_error("Unable to delete last preset!");
  284. modConfig["presets"].Struct().erase(presetName);
  285. }
  286. void ModsPresetState::activatePreset(const std::string & presetName)
  287. {
  288. if (modConfig["presets"].Struct().count(presetName) == 0)
  289. throw std::runtime_error("Unable to activate non-exinsting preset!");
  290. modConfig["activePreset"].String() = presetName;
  291. }
  292. void ModsPresetState::renamePreset(const std::string & oldPresetName, const std::string & newPresetName)
  293. {
  294. if (oldPresetName == newPresetName)
  295. throw std::runtime_error("Unable to rename preset to the same name!");
  296. if (modConfig["presets"].Struct().count(oldPresetName) == 0)
  297. throw std::runtime_error("Unable to rename non-existing last preset!");
  298. if (modConfig["presets"].Struct().count(newPresetName) != 0)
  299. throw std::runtime_error("Unable to rename preset - preset with such name already exists!");
  300. modConfig["presets"][newPresetName] = modConfig["presets"][oldPresetName];
  301. modConfig["presets"].Struct().erase(oldPresetName);
  302. if (modConfig["activePreset"].String() == oldPresetName)
  303. modConfig["activePreset"].String() = newPresetName;
  304. }
  305. std::vector<std::string> ModsPresetState::getAllPresets() const
  306. {
  307. std::vector<std::string> presets;
  308. for (const auto & preset : modConfig["presets"].Struct())
  309. presets.push_back(preset.first);
  310. return presets;
  311. }
  312. std::string ModsPresetState::getActivePreset() const
  313. {
  314. return modConfig["activePreset"].String();
  315. }
  316. JsonNode ModsPresetState::exportCurrentPreset() const
  317. {
  318. JsonNode data = getActivePresetConfig();
  319. std::string presetName = getActivePreset();
  320. data["name"] = JsonNode(presetName);
  321. vstd::erase_if(data["settings"].Struct(), [&](const auto & pair){
  322. return !vstd::contains(data["mods"].Vector(), JsonNode(pair.first));
  323. });
  324. return data;
  325. }
  326. void ModsPresetState::importPreset(const JsonNode & newConfig)
  327. {
  328. std::string importedPresetName = newConfig["name"].String();
  329. if (importedPresetName.empty())
  330. throw std::runtime_error("Attempt to import invalid preset");
  331. modConfig["presets"][importedPresetName] = newConfig;
  332. modConfig["presets"][importedPresetName].Struct().erase("name");
  333. }
  334. ModsStorage::ModsStorage(const std::vector<TModID> & modsToLoad, const JsonNode & repositoryList)
  335. {
  336. JsonNode coreModConfig(JsonPath::builtin("config/gameConfig.json"));
  337. coreModConfig.setModScope(ModScope::scopeBuiltin());
  338. mods.try_emplace(ModScope::scopeBuiltin(), ModScope::scopeBuiltin(), coreModConfig, JsonNode());
  339. for(auto modID : modsToLoad)
  340. {
  341. if(ModScope::isScopeReserved(modID))
  342. continue;
  343. JsonNode modConfig(getModDescriptionFile(modID));
  344. modConfig.setModScope(modID);
  345. if(modConfig["modType"].isNull())
  346. {
  347. logMod->error("Can not load mod %s - invalid mod config file!", modID);
  348. continue;
  349. }
  350. mods.try_emplace(modID, modID, modConfig, repositoryList[modID]);
  351. }
  352. for(const auto & mod : repositoryList.Struct())
  353. {
  354. if (vstd::contains(modsToLoad, mod.first))
  355. continue;
  356. if (mod.second["modType"].isNull() || mod.second["name"].isNull())
  357. continue;
  358. mods.try_emplace(mod.first, mod.first, JsonNode(), mod.second);
  359. }
  360. }
  361. const ModDescription & ModsStorage::getMod(const TModID & fullID) const
  362. {
  363. return mods.at(fullID);
  364. }
  365. TModList ModsStorage::getAllMods() const
  366. {
  367. TModList result;
  368. for (const auto & mod : mods)
  369. result.push_back(mod.first);
  370. return result;
  371. }
  372. ModManager::ModManager()
  373. :ModManager(JsonNode())
  374. {
  375. }
  376. ModManager::ModManager(const JsonNode & repositoryList)
  377. : modsState(std::make_unique<ModsState>())
  378. , modsPreset(std::make_unique<ModsPresetState>())
  379. {
  380. modsStorage = std::make_unique<ModsStorage>(modsState->getInstalledMods(), repositoryList);
  381. eraseMissingModsFromPreset();
  382. addNewModsToPreset();
  383. std::vector<TModID> desiredModList = modsPreset->getActiveMods();
  384. ModDependenciesResolver newResolver(desiredModList, *modsStorage);
  385. updatePreset(newResolver);
  386. }
  387. ModManager::~ModManager() = default;
  388. const ModDescription & ModManager::getModDescription(const TModID & modID) const
  389. {
  390. assert(boost::to_lower_copy(modID) == modID);
  391. return modsStorage->getMod(modID);
  392. }
  393. bool ModManager::isModSettingActive(const TModID & rootModID, const TModID & modSettingID) const
  394. {
  395. return modsPreset->getModSettings(rootModID).at(modSettingID);
  396. }
  397. bool ModManager::isModActive(const TModID & modID) const
  398. {
  399. return vstd::contains(getActiveMods(), modID);
  400. }
  401. const TModList & ModManager::getActiveMods() const
  402. {
  403. return depedencyResolver->getActiveMods();
  404. }
  405. uint32_t ModManager::computeChecksum(const TModID & modName) const
  406. {
  407. return modsState->computeChecksum(modName);
  408. }
  409. std::optional<uint32_t> ModManager::getValidatedChecksum(const TModID & modName) const
  410. {
  411. return modsPreset->getValidatedChecksum(modName);
  412. }
  413. void ModManager::setValidatedChecksum(const TModID & modName, std::optional<uint32_t> value)
  414. {
  415. modsPreset->setValidatedChecksum(modName, value);
  416. }
  417. void ModManager::saveConfigurationState() const
  418. {
  419. modsPreset->saveConfigurationState();
  420. }
  421. TModList ModManager::getAllMods() const
  422. {
  423. return modsStorage->getAllMods();
  424. }
  425. double ModManager::getInstalledModSizeMegabytes(const TModID & modName) const
  426. {
  427. return modsState->getInstalledModSizeMegabytes(modName);
  428. }
  429. void ModManager::eraseMissingModsFromPreset()
  430. {
  431. const TModList & installedMods = modsState->getInstalledMods();
  432. const TModList & rootMods = modsPreset->getActiveRootMods();
  433. modsPreset->removeOldMods(installedMods);
  434. for(const auto & rootMod : rootMods)
  435. {
  436. const auto & modSettings = modsPreset->getModSettings(rootMod);
  437. for(const auto & modSetting : modSettings)
  438. {
  439. TModID fullModID = rootMod + '.' + modSetting.first;
  440. if(!vstd::contains(installedMods, fullModID))
  441. {
  442. modsPreset->eraseModSetting(rootMod, modSetting.first);
  443. continue;
  444. }
  445. }
  446. }
  447. }
  448. void ModManager::addNewModsToPreset()
  449. {
  450. const TModList & installedMods = modsState->getInstalledMods();
  451. for(const auto & modID : installedMods)
  452. {
  453. size_t dotPos = modID.find('.');
  454. if(dotPos == std::string::npos)
  455. continue; // only look up submods aka mod settings
  456. std::string rootMod = modID.substr(0, dotPos);
  457. std::string settingID = modID.substr(dotPos + 1);
  458. const auto & modSettings = modsPreset->getModSettings(rootMod);
  459. if (!modSettings.count(settingID))
  460. modsPreset->setSettingActive(rootMod, settingID, !modsStorage->getMod(modID).keepDisabled());
  461. }
  462. }
  463. TModList ModManager::collectDependenciesRecursive(const TModID & modID) const
  464. {
  465. TModList result;
  466. TModList toTest;
  467. toTest.push_back(modID);
  468. while (!toTest.empty())
  469. {
  470. TModID currentModID = toTest.back();
  471. const auto & currentMod = getModDescription(currentModID);
  472. toTest.pop_back();
  473. result.push_back(currentModID);
  474. if (!currentMod.isInstalled())
  475. throw std::runtime_error("Unable to enable mod " + modID + "! Dependency " + currentModID + " is not installed!");
  476. for (const auto & dependency : currentMod.getDependencies())
  477. {
  478. if (!vstd::contains(result, dependency))
  479. toTest.push_back(dependency);
  480. }
  481. }
  482. return result;
  483. }
  484. void ModManager::tryEnableMods(const TModList & modList)
  485. {
  486. TModList requiredActiveMods;
  487. TModList additionalActiveMods = getActiveMods();
  488. for (const auto & modName : modList)
  489. {
  490. for (const auto & dependency : collectDependenciesRecursive(modName))
  491. {
  492. if (!vstd::contains(requiredActiveMods, dependency))
  493. {
  494. requiredActiveMods.push_back(dependency);
  495. vstd::erase(additionalActiveMods, dependency);
  496. }
  497. }
  498. assert(!vstd::contains(additionalActiveMods, modName));
  499. assert(vstd::contains(requiredActiveMods, modName));// FIXME: fails on attempt to enable broken mod / translation to other language
  500. }
  501. ModDependenciesResolver testResolver(requiredActiveMods, *modsStorage);
  502. testResolver.tryAddMods(additionalActiveMods, *modsStorage);
  503. TModList additionalActiveSubmods;
  504. for (const auto & modName : modList)
  505. {
  506. if (modName.find('.') != std::string::npos)
  507. continue;
  508. auto modSettings = modsPreset->getModSettings(modName);
  509. for (const auto & entry : modSettings)
  510. {
  511. TModID fullModID = modName + '.' + entry.first;
  512. if (entry.second && !vstd::contains(requiredActiveMods, fullModID))
  513. additionalActiveSubmods.push_back(fullModID);
  514. }
  515. }
  516. testResolver.tryAddMods(additionalActiveSubmods, *modsStorage);
  517. for (const auto & modName : modList)
  518. if (!vstd::contains(testResolver.getActiveMods(), modName))
  519. throw std::runtime_error("Failed to enable mod! Mod " + modName + " remains disabled!");
  520. updatePreset(testResolver);
  521. }
  522. void ModManager::tryDisableMod(const TModID & modName)
  523. {
  524. auto desiredActiveMods = getActiveMods();
  525. assert(vstd::contains(desiredActiveMods, modName));
  526. vstd::erase(desiredActiveMods, modName);
  527. ModDependenciesResolver testResolver(desiredActiveMods, *modsStorage);
  528. if (vstd::contains(testResolver.getActiveMods(), modName))
  529. throw std::runtime_error("Failed to disable mod! Mod " + modName + " remains enabled!");
  530. modsPreset->setModActive(modName, false);
  531. updatePreset(testResolver);
  532. }
  533. void ModManager::updatePreset(const ModDependenciesResolver & testResolver)
  534. {
  535. const auto & newActiveMods = testResolver.getActiveMods();
  536. const auto & newBrokenMods = testResolver.getBrokenMods();
  537. for (const auto & modID : newActiveMods)
  538. {
  539. assert(vstd::contains(modsState->getInstalledMods(), modID));
  540. modsPreset->setModActive(modID, true);
  541. }
  542. for (const auto & modID : newBrokenMods)
  543. {
  544. const auto & mod = getModDescription(modID);
  545. if (vstd::contains(newActiveMods, mod.getTopParentID()))
  546. modsPreset->setModActive(modID, false);
  547. }
  548. std::vector<TModID> desiredModList = modsPreset->getActiveMods();
  549. // Try to enable all existing compatibility patches. Ignore on failure
  550. for (const auto & rootMod : modsPreset->getActiveRootMods())
  551. {
  552. for (const auto & modSetting : modsPreset->getModSettings(rootMod))
  553. {
  554. if (modSetting.second)
  555. continue;
  556. TModID fullModID = rootMod + '.' + modSetting.first;
  557. const auto & modDescription = modsStorage->getMod(fullModID);
  558. if (modDescription.isCompatibility())
  559. desiredModList.push_back(fullModID);
  560. }
  561. }
  562. depedencyResolver = std::make_unique<ModDependenciesResolver>(desiredModList, *modsStorage);
  563. modsPreset->saveConfigurationState();
  564. }
  565. ModDependenciesResolver::ModDependenciesResolver(const TModList & modsToResolve, const ModsStorage & storage)
  566. {
  567. tryAddMods(modsToResolve, storage);
  568. }
  569. const TModList & ModDependenciesResolver::getActiveMods() const
  570. {
  571. return activeMods;
  572. }
  573. const TModList & ModDependenciesResolver::getBrokenMods() const
  574. {
  575. return brokenMods;
  576. }
  577. void ModDependenciesResolver::tryAddMods(TModList modsToResolve, const ModsStorage & storage)
  578. {
  579. // Topological sort algorithm.
  580. boost::range::sort(modsToResolve); // Sort mods per name
  581. std::vector<TModID> sortedValidMods(activeMods.begin(), activeMods.end()); // Vector keeps order of elements (LIFO)
  582. std::set<TModID> resolvedModIDs(activeMods.begin(), activeMods.end()); // Use a set for validation for performance reason, but set does not keep order of elements
  583. std::set<TModID> notResolvedModIDs(modsToResolve.begin(), modsToResolve.end()); // Use a set for validation for performance reason
  584. // Mod is resolved if it has no dependencies or all its dependencies are already resolved
  585. auto isResolved = [&](const ModDescription & mod) -> bool
  586. {
  587. if (mod.isTranslation() && CGeneralTextHandler::getPreferredLanguage() != mod.getBaseLanguage())
  588. return false;
  589. if(mod.getDependencies().size() > resolvedModIDs.size())
  590. return false;
  591. for(const TModID & dependency : mod.getDependencies())
  592. if(!vstd::contains(resolvedModIDs, dependency))
  593. return false;
  594. for(const TModID & softDependency : mod.getSoftDependencies())
  595. if(vstd::contains(notResolvedModIDs, softDependency))
  596. return false;
  597. for(const TModID & conflict : mod.getConflicts())
  598. if(vstd::contains(resolvedModIDs, conflict))
  599. return false;
  600. for(const TModID & reverseConflict : resolvedModIDs)
  601. if(vstd::contains(storage.getMod(reverseConflict).getConflicts(), mod.getID()))
  602. return false;
  603. return true;
  604. };
  605. while(true)
  606. {
  607. std::set<TModID> resolvedOnCurrentTreeLevel;
  608. for(auto it = modsToResolve.begin(); it != modsToResolve.end();) // One iteration - one level of mods tree
  609. {
  610. if(isResolved(storage.getMod(*it)))
  611. {
  612. resolvedOnCurrentTreeLevel.insert(*it); // Not to the resolvedModIDs, so current node children will be resolved on the next iteration
  613. assert(!vstd::contains(sortedValidMods, *it));
  614. sortedValidMods.push_back(*it);
  615. it = modsToResolve.erase(it);
  616. continue;
  617. }
  618. it++;
  619. }
  620. if(!resolvedOnCurrentTreeLevel.empty())
  621. {
  622. resolvedModIDs.insert(resolvedOnCurrentTreeLevel.begin(), resolvedOnCurrentTreeLevel.end());
  623. for(const auto & it : resolvedOnCurrentTreeLevel)
  624. notResolvedModIDs.erase(it);
  625. continue;
  626. }
  627. // If there are no valid mods on the current mods tree level, no more mod can be resolved, should be ended.
  628. break;
  629. }
  630. assert(!sortedValidMods.empty());
  631. activeMods = sortedValidMods;
  632. brokenMods.insert(brokenMods.end(), modsToResolve.begin(), modsToResolve.end());
  633. }
  634. void ModManager::createNewPreset(const std::string & presetName)
  635. {
  636. modsPreset->createNewPreset(presetName);
  637. modsPreset->saveConfigurationState();
  638. }
  639. void ModManager::deletePreset(const std::string & presetName)
  640. {
  641. modsPreset->deletePreset(presetName);
  642. modsPreset->saveConfigurationState();
  643. }
  644. void ModManager::activatePreset(const std::string & presetName)
  645. {
  646. modsPreset->activatePreset(presetName);
  647. modsPreset->saveConfigurationState();
  648. }
  649. void ModManager::renamePreset(const std::string & oldPresetName, const std::string & newPresetName)
  650. {
  651. modsPreset->renamePreset(oldPresetName, newPresetName);
  652. modsPreset->saveConfigurationState();
  653. }
  654. std::vector<std::string> ModManager::getAllPresets() const
  655. {
  656. return modsPreset->getAllPresets();
  657. }
  658. std::string ModManager::getActivePreset() const
  659. {
  660. return modsPreset->getActivePreset();
  661. }
  662. JsonNode ModManager::exportCurrentPreset() const
  663. {
  664. return modsPreset->exportCurrentPreset();
  665. }
  666. void ModManager::importPreset(const JsonNode & data)
  667. {
  668. modsPreset->importPreset(data);
  669. modsPreset->saveConfigurationState();
  670. }
  671. VCMI_LIB_NAMESPACE_END