ModManager.cpp 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799
  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. ModsStorage::ModsStorage(const std::vector<TModID> & modsToLoad, const JsonNode & repositoryList)
  317. {
  318. JsonNode coreModConfig(JsonPath::builtin("config/gameConfig.json"));
  319. coreModConfig.setModScope(ModScope::scopeBuiltin());
  320. mods.try_emplace(ModScope::scopeBuiltin(), ModScope::scopeBuiltin(), coreModConfig, JsonNode());
  321. for(auto modID : modsToLoad)
  322. {
  323. if(ModScope::isScopeReserved(modID))
  324. continue;
  325. JsonNode modConfig(getModDescriptionFile(modID));
  326. modConfig.setModScope(modID);
  327. if(modConfig["modType"].isNull())
  328. {
  329. logMod->error("Can not load mod %s - invalid mod config file!", modID);
  330. continue;
  331. }
  332. mods.try_emplace(modID, modID, modConfig, repositoryList[modID]);
  333. }
  334. for(const auto & mod : repositoryList.Struct())
  335. {
  336. if (vstd::contains(modsToLoad, mod.first))
  337. continue;
  338. if (mod.second["modType"].isNull() || mod.second["name"].isNull())
  339. continue;
  340. mods.try_emplace(mod.first, mod.first, JsonNode(), mod.second);
  341. }
  342. }
  343. const ModDescription & ModsStorage::getMod(const TModID & fullID) const
  344. {
  345. return mods.at(fullID);
  346. }
  347. TModList ModsStorage::getAllMods() const
  348. {
  349. TModList result;
  350. for (const auto & mod : mods)
  351. result.push_back(mod.first);
  352. return result;
  353. }
  354. ModManager::ModManager()
  355. :ModManager(JsonNode())
  356. {
  357. }
  358. ModManager::ModManager(const JsonNode & repositoryList)
  359. : modsState(std::make_unique<ModsState>())
  360. , modsPreset(std::make_unique<ModsPresetState>())
  361. {
  362. modsStorage = std::make_unique<ModsStorage>(modsState->getInstalledMods(), repositoryList);
  363. eraseMissingModsFromPreset();
  364. addNewModsToPreset();
  365. std::vector<TModID> desiredModList = modsPreset->getActiveMods();
  366. ModDependenciesResolver newResolver(desiredModList, *modsStorage);
  367. updatePreset(newResolver);
  368. }
  369. ModManager::~ModManager() = default;
  370. const ModDescription & ModManager::getModDescription(const TModID & modID) const
  371. {
  372. assert(boost::to_lower_copy(modID) == modID);
  373. return modsStorage->getMod(modID);
  374. }
  375. bool ModManager::isModSettingActive(const TModID & rootModID, const TModID & modSettingID) const
  376. {
  377. return modsPreset->getModSettings(rootModID).at(modSettingID);
  378. }
  379. bool ModManager::isModActive(const TModID & modID) const
  380. {
  381. return vstd::contains(getActiveMods(), modID);
  382. }
  383. const TModList & ModManager::getActiveMods() const
  384. {
  385. return depedencyResolver->getActiveMods();
  386. }
  387. uint32_t ModManager::computeChecksum(const TModID & modName) const
  388. {
  389. return modsState->computeChecksum(modName);
  390. }
  391. std::optional<uint32_t> ModManager::getValidatedChecksum(const TModID & modName) const
  392. {
  393. return modsPreset->getValidatedChecksum(modName);
  394. }
  395. void ModManager::setValidatedChecksum(const TModID & modName, std::optional<uint32_t> value)
  396. {
  397. modsPreset->setValidatedChecksum(modName, value);
  398. }
  399. void ModManager::saveConfigurationState() const
  400. {
  401. modsPreset->saveConfigurationState();
  402. }
  403. TModList ModManager::getAllMods() const
  404. {
  405. return modsStorage->getAllMods();
  406. }
  407. double ModManager::getInstalledModSizeMegabytes(const TModID & modName) const
  408. {
  409. return modsState->getInstalledModSizeMegabytes(modName);
  410. }
  411. void ModManager::eraseMissingModsFromPreset()
  412. {
  413. const TModList & installedMods = modsState->getInstalledMods();
  414. const TModList & rootMods = modsPreset->getActiveRootMods();
  415. modsPreset->removeOldMods(installedMods);
  416. for(const auto & rootMod : rootMods)
  417. {
  418. const auto & modSettings = modsPreset->getModSettings(rootMod);
  419. for(const auto & modSetting : modSettings)
  420. {
  421. TModID fullModID = rootMod + '.' + modSetting.first;
  422. if(!vstd::contains(installedMods, fullModID))
  423. {
  424. modsPreset->eraseModSetting(rootMod, modSetting.first);
  425. continue;
  426. }
  427. }
  428. }
  429. }
  430. void ModManager::addNewModsToPreset()
  431. {
  432. const TModList & installedMods = modsState->getInstalledMods();
  433. for(const auto & modID : installedMods)
  434. {
  435. size_t dotPos = modID.find('.');
  436. if(dotPos == std::string::npos)
  437. continue; // only look up submods aka mod settings
  438. std::string rootMod = modID.substr(0, dotPos);
  439. std::string settingID = modID.substr(dotPos + 1);
  440. const auto & modSettings = modsPreset->getModSettings(rootMod);
  441. if (!modSettings.count(settingID))
  442. modsPreset->setSettingActive(rootMod, settingID, !modsStorage->getMod(modID).keepDisabled());
  443. }
  444. }
  445. TModList ModManager::collectDependenciesRecursive(const TModID & modID) const
  446. {
  447. TModList result;
  448. TModList toTest;
  449. toTest.push_back(modID);
  450. while (!toTest.empty())
  451. {
  452. TModID currentModID = toTest.back();
  453. const auto & currentMod = getModDescription(currentModID);
  454. toTest.pop_back();
  455. result.push_back(currentModID);
  456. if (!currentMod.isInstalled())
  457. throw std::runtime_error("Unable to enable mod " + modID + "! Dependency " + currentModID + " is not installed!");
  458. for (const auto & dependency : currentMod.getDependencies())
  459. {
  460. if (!vstd::contains(result, dependency))
  461. toTest.push_back(dependency);
  462. }
  463. }
  464. return result;
  465. }
  466. void ModManager::tryEnableMods(const TModList & modList)
  467. {
  468. TModList requiredActiveMods;
  469. TModList additionalActiveMods = getActiveMods();
  470. for (const auto & modName : modList)
  471. {
  472. for (const auto & dependency : collectDependenciesRecursive(modName))
  473. {
  474. if (!vstd::contains(requiredActiveMods, dependency))
  475. {
  476. requiredActiveMods.push_back(dependency);
  477. vstd::erase(additionalActiveMods, dependency);
  478. }
  479. }
  480. assert(!vstd::contains(additionalActiveMods, modName));
  481. assert(vstd::contains(requiredActiveMods, modName));// FIXME: fails on attempt to enable broken mod / translation to other language
  482. }
  483. ModDependenciesResolver testResolver(requiredActiveMods, *modsStorage);
  484. testResolver.tryAddMods(additionalActiveMods, *modsStorage);
  485. TModList additionalActiveSubmods;
  486. for (const auto & modName : modList)
  487. {
  488. if (modName.find('.') != std::string::npos)
  489. continue;
  490. auto modSettings = modsPreset->getModSettings(modName);
  491. for (const auto & entry : modSettings)
  492. {
  493. TModID fullModID = modName + '.' + entry.first;
  494. if (entry.second && !vstd::contains(requiredActiveMods, fullModID))
  495. additionalActiveSubmods.push_back(fullModID);
  496. }
  497. }
  498. testResolver.tryAddMods(additionalActiveSubmods, *modsStorage);
  499. for (const auto & modName : modList)
  500. if (!vstd::contains(testResolver.getActiveMods(), modName))
  501. throw std::runtime_error("Failed to enable mod! Mod " + modName + " remains disabled!");
  502. updatePreset(testResolver);
  503. }
  504. void ModManager::tryDisableMod(const TModID & modName)
  505. {
  506. auto desiredActiveMods = getActiveMods();
  507. assert(vstd::contains(desiredActiveMods, modName));
  508. vstd::erase(desiredActiveMods, modName);
  509. ModDependenciesResolver testResolver(desiredActiveMods, *modsStorage);
  510. if (vstd::contains(testResolver.getActiveMods(), modName))
  511. throw std::runtime_error("Failed to disable mod! Mod " + modName + " remains enabled!");
  512. modsPreset->setModActive(modName, false);
  513. updatePreset(testResolver);
  514. }
  515. void ModManager::updatePreset(const ModDependenciesResolver & testResolver)
  516. {
  517. const auto & newActiveMods = testResolver.getActiveMods();
  518. const auto & newBrokenMods = testResolver.getBrokenMods();
  519. for (const auto & modID : newActiveMods)
  520. {
  521. assert(vstd::contains(modsState->getInstalledMods(), modID));
  522. modsPreset->setModActive(modID, true);
  523. }
  524. for (const auto & modID : newBrokenMods)
  525. {
  526. const auto & mod = getModDescription(modID);
  527. if (mod.getTopParentID().empty() || vstd::contains(newActiveMods, mod.getTopParentID()))
  528. modsPreset->setModActive(modID, false);
  529. }
  530. std::vector<TModID> desiredModList = modsPreset->getActiveMods();
  531. // Try to enable all existing compatibility patches. Ignore on failure
  532. for (const auto & rootMod : modsPreset->getActiveRootMods())
  533. {
  534. for (const auto & modSetting : modsPreset->getModSettings(rootMod))
  535. {
  536. if (modSetting.second)
  537. continue;
  538. TModID fullModID = rootMod + '.' + modSetting.first;
  539. const auto & modDescription = modsStorage->getMod(fullModID);
  540. if (modDescription.isCompatibility())
  541. desiredModList.push_back(fullModID);
  542. }
  543. }
  544. depedencyResolver = std::make_unique<ModDependenciesResolver>(desiredModList, *modsStorage);
  545. modsPreset->saveConfigurationState();
  546. }
  547. ModDependenciesResolver::ModDependenciesResolver(const TModList & modsToResolve, const ModsStorage & storage)
  548. {
  549. tryAddMods(modsToResolve, storage);
  550. }
  551. const TModList & ModDependenciesResolver::getActiveMods() const
  552. {
  553. return activeMods;
  554. }
  555. const TModList & ModDependenciesResolver::getBrokenMods() const
  556. {
  557. return brokenMods;
  558. }
  559. void ModDependenciesResolver::tryAddMods(TModList modsToResolve, const ModsStorage & storage)
  560. {
  561. // Topological sort algorithm.
  562. boost::range::sort(modsToResolve); // Sort mods per name
  563. std::vector<TModID> sortedValidMods(activeMods.begin(), activeMods.end()); // Vector keeps order of elements (LIFO)
  564. std::set<TModID> resolvedModIDs(activeMods.begin(), activeMods.end()); // Use a set for validation for performance reason, but set does not keep order of elements
  565. std::set<TModID> notResolvedModIDs(modsToResolve.begin(), modsToResolve.end()); // Use a set for validation for performance reason
  566. // Mod is resolved if it has no dependencies or all its dependencies are already resolved
  567. auto isResolved = [&](const ModDescription & mod) -> bool
  568. {
  569. if (mod.isTranslation() && CGeneralTextHandler::getPreferredLanguage() != mod.getBaseLanguage())
  570. return false;
  571. if(mod.getDependencies().size() > resolvedModIDs.size())
  572. return false;
  573. for(const TModID & dependency : mod.getDependencies())
  574. if(!vstd::contains(resolvedModIDs, dependency))
  575. return false;
  576. for(const TModID & softDependency : mod.getSoftDependencies())
  577. if(vstd::contains(notResolvedModIDs, softDependency))
  578. return false;
  579. for(const TModID & conflict : mod.getConflicts())
  580. if(vstd::contains(resolvedModIDs, conflict))
  581. return false;
  582. for(const TModID & reverseConflict : resolvedModIDs)
  583. if(vstd::contains(storage.getMod(reverseConflict).getConflicts(), mod.getID()))
  584. return false;
  585. return true;
  586. };
  587. while(true)
  588. {
  589. std::set<TModID> resolvedOnCurrentTreeLevel;
  590. for(auto it = modsToResolve.begin(); it != modsToResolve.end();) // One iteration - one level of mods tree
  591. {
  592. if(isResolved(storage.getMod(*it)))
  593. {
  594. resolvedOnCurrentTreeLevel.insert(*it); // Not to the resolvedModIDs, so current node children will be resolved on the next iteration
  595. assert(!vstd::contains(sortedValidMods, *it));
  596. sortedValidMods.push_back(*it);
  597. it = modsToResolve.erase(it);
  598. continue;
  599. }
  600. it++;
  601. }
  602. if(!resolvedOnCurrentTreeLevel.empty())
  603. {
  604. resolvedModIDs.insert(resolvedOnCurrentTreeLevel.begin(), resolvedOnCurrentTreeLevel.end());
  605. for(const auto & it : resolvedOnCurrentTreeLevel)
  606. notResolvedModIDs.erase(it);
  607. continue;
  608. }
  609. // If there are no valid mods on the current mods tree level, no more mod can be resolved, should be ended.
  610. break;
  611. }
  612. assert(!sortedValidMods.empty());
  613. activeMods = sortedValidMods;
  614. brokenMods.insert(brokenMods.end(), modsToResolve.begin(), modsToResolve.end());
  615. }
  616. void ModManager::createNewPreset(const std::string & presetName)
  617. {
  618. modsPreset->createNewPreset(presetName);
  619. modsPreset->saveConfigurationState();
  620. }
  621. void ModManager::deletePreset(const std::string & presetName)
  622. {
  623. modsPreset->deletePreset(presetName);
  624. modsPreset->saveConfigurationState();
  625. }
  626. void ModManager::activatePreset(const std::string & presetName)
  627. {
  628. modsPreset->activatePreset(presetName);
  629. modsPreset->saveConfigurationState();
  630. }
  631. void ModManager::renamePreset(const std::string & oldPresetName, const std::string & newPresetName)
  632. {
  633. modsPreset->renamePreset(oldPresetName, newPresetName);
  634. modsPreset->saveConfigurationState();
  635. }
  636. std::vector<std::string> ModManager::getAllPresets() const
  637. {
  638. return modsPreset->getAllPresets();
  639. }
  640. std::string ModManager::getActivePreset() const
  641. {
  642. return modsPreset->getActivePreset();
  643. }
  644. VCMI_LIB_NAMESPACE_END