ModManager.cpp 25 KB

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