123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893 |
- /*
- * ModManager.cpp, part of VCMI engine
- *
- * Authors: listed in file AUTHORS in main folder
- *
- * License: GNU General Public License v2.0 or later
- * Full text of license available in license.txt file, in main folder
- *
- */
- #include "StdInc.h"
- #include "ModManager.h"
- #include "ModDescription.h"
- #include "ModScope.h"
- #include "../constants/StringConstants.h"
- #include "../filesystem/Filesystem.h"
- #include "../json/JsonNode.h"
- #include "../texts/CGeneralTextHandler.h"
- VCMI_LIB_NAMESPACE_BEGIN
- static std::string getModDirectory(const TModID & modName)
- {
- std::string result = modName;
- boost::to_upper(result);
- boost::algorithm::replace_all(result, ".", "/MODS/");
- return "MODS/" + result;
- }
- static std::string getModSettingsDirectory(const TModID & modName)
- {
- return getModDirectory(modName) + "/MODS/";
- }
- static JsonPath getModDescriptionFile(const TModID & modName)
- {
- return JsonPath::builtin(getModDirectory(modName) + "/mod");
- }
- ModsState::ModsState()
- {
- modList.push_back(ModScope::scopeBuiltin());
- std::vector<TModID> testLocations = scanModsDirectory("MODS/");
- while(!testLocations.empty())
- {
- std::string target = testLocations.back();
- testLocations.pop_back();
- modList.push_back(boost::algorithm::to_lower_copy(target));
- for(const auto & submod : scanModsDirectory(getModSettingsDirectory(target)))
- testLocations.push_back(target + '.' + submod);
- }
- }
- TModList ModsState::getInstalledMods() const
- {
- return modList;
- }
- uint32_t ModsState::computeChecksum(const TModID & modName) const
- {
- boost::crc_32_type modChecksum;
- // first - add current VCMI version into checksum to force re-validation on VCMI updates
- modChecksum.process_bytes(static_cast<const void*>(GameConstants::VCMI_VERSION.data()), GameConstants::VCMI_VERSION.size());
- // second - add mod.json into checksum because filesystem does not contains this file
- if (modName != ModScope::scopeBuiltin())
- {
- auto modConfFile = getModDescriptionFile(modName);
- ui32 configChecksum = CResourceHandler::get("initial")->load(modConfFile)->calculateCRC32();
- modChecksum.process_bytes(static_cast<const void *>(&configChecksum), sizeof(configChecksum));
- }
- // third - add all detected text files from this mod into checksum
- const auto & filesystem = CResourceHandler::get(modName);
- auto files = filesystem->getFilteredFiles([](const ResourcePath & resID)
- {
- return resID.getType() == EResType::JSON && boost::starts_with(resID.getName(), "CONFIG");
- });
- for (const ResourcePath & file : files)
- {
- ui32 fileChecksum = filesystem->load(file)->calculateCRC32();
- modChecksum.process_bytes(static_cast<const void *>(&fileChecksum), sizeof(fileChecksum));
- }
- return modChecksum.checksum();
- }
- double ModsState::getInstalledModSizeMegabytes(const TModID & modName) const
- {
- ResourcePath resDir(getModDirectory(modName), EResType::DIRECTORY);
- std::string path = CResourceHandler::get()->getResourceName(resDir)->string();
- size_t sizeBytes = 0;
- for(boost::filesystem::recursive_directory_iterator it(path); it != boost::filesystem::recursive_directory_iterator(); ++it)
- {
- if(!boost::filesystem::is_directory(*it))
- sizeBytes += boost::filesystem::file_size(*it);
- }
- double sizeMegabytes = sizeBytes / static_cast<double>(1024*1024);
- return sizeMegabytes;
- }
- std::vector<TModID> ModsState::scanModsDirectory(const std::string & modDir) const
- {
- size_t depth = boost::range::count(modDir, '/');
- const auto & modScanFilter = [&](const ResourcePath & id) -> bool
- {
- if(id.getType() != EResType::DIRECTORY)
- return false;
- if(!boost::algorithm::starts_with(id.getName(), modDir))
- return false;
- if(boost::range::count(id.getName(), '/') != depth)
- return false;
- return true;
- };
- auto list = CResourceHandler::get("initial")->getFilteredFiles(modScanFilter);
- //storage for found mods
- std::vector<TModID> foundMods;
- for(const auto & entry : list)
- {
- std::string name = entry.getName();
- name.erase(0, modDir.size()); //Remove path prefix
- if(name.empty())
- continue;
- if(name.find('.') != std::string::npos)
- continue;
- if (ModScope::isScopeReserved(boost::to_lower_copy(name)))
- continue;
- if(!CResourceHandler::get("initial")->existsResource(JsonPath::builtin(entry.getName() + "/MOD")))
- continue;
- foundMods.push_back(name);
- }
- return foundMods;
- }
- ///////////////////////////////////////////////////////////////////////////////
- ModsPresetState::ModsPresetState()
- {
- static const JsonPath settingsPath = JsonPath::builtin("config/modSettings.json");
- if(CResourceHandler::get("local")->existsResource(ResourcePath(settingsPath)))
- {
- modConfig = JsonNode(settingsPath);
- }
- else
- {
- // Probably new install. Create initial configuration
- CResourceHandler::get("local")->createResource(settingsPath.getOriginalName() + ".json");
- }
- if(modConfig["presets"].isNull() || modConfig["presets"].Struct().empty())
- {
- modConfig["activePreset"] = JsonNode("default");
- if(modConfig["activeMods"].isNull())
- createInitialPreset(); // new install
- else
- importInitialPreset(); // 1.5 format import
- }
- auto allPresets = getAllPresets();
- if (!vstd::contains(allPresets, modConfig["activePreset"].String()))
- modConfig["activePreset"] = JsonNode(allPresets.front());
- logGlobal->debug("Loading following mod settings: %s", modConfig.toCompactString());
- }
- void ModsPresetState::createInitialPreset()
- {
- // TODO: scan mods directory for all its content? Probably unnecessary since this looks like new install, but who knows?
- modConfig["presets"]["default"]["mods"].Vector().emplace_back("vcmi");
- }
- void ModsPresetState::importInitialPreset()
- {
- JsonNode preset;
- for(const auto & mod : modConfig["activeMods"].Struct())
- {
- if(mod.second["active"].Bool())
- preset["mods"].Vector().emplace_back(mod.first);
- for(const auto & submod : mod.second["mods"].Struct())
- preset["settings"][mod.first][submod.first] = submod.second["active"];
- }
- modConfig["presets"]["default"] = preset;
- }
- const JsonNode & ModsPresetState::getActivePresetConfig() const
- {
- const std::string & currentPresetName = modConfig["activePreset"].String();
- const JsonNode & currentPreset = modConfig["presets"][currentPresetName];
- return currentPreset;
- }
- TModList ModsPresetState::getActiveRootMods() const
- {
- return getRootMods(getActivePreset());
- }
- TModList ModsPresetState::getRootMods(const std::string & presetName) const
- {
- const JsonNode & modsToActivateJson = modConfig["presets"][presetName]["mods"];
- auto modsToActivate = modsToActivateJson.convertTo<std::vector<TModID>>();
- if (!vstd::contains(modsToActivate, ModScope::scopeBuiltin()))
- modsToActivate.push_back(ModScope::scopeBuiltin());
- return modsToActivate;
- }
- std::map<TModID, bool> ModsPresetState::getModSettings(const TModID & modID) const
- {
- const JsonNode & modSettingsJson = getActivePresetConfig()["settings"][modID];
- auto modSettings = modSettingsJson.convertTo<std::map<TModID, bool>>();
- return modSettings;
- }
- std::optional<uint32_t> ModsPresetState::getValidatedChecksum(const TModID & modName) const
- {
- const JsonNode & node = modConfig["validatedMods"][modName];
- if (node.isNull())
- return std::nullopt;
- else
- return node.Integer();
- }
- void ModsPresetState::setModActive(const TModID & modID, bool isActive)
- {
- size_t dotPos = modID.find('.');
- if(dotPos != std::string::npos)
- {
- std::string rootMod = modID.substr(0, dotPos);
- std::string settingID = modID.substr(dotPos + 1);
- setSettingActive(rootMod, settingID, isActive);
- }
- else
- {
- if (isActive)
- addRootMod(modID);
- else
- eraseRootMod(modID);
- }
- }
- void ModsPresetState::addRootMod(const TModID & modName)
- {
- const std::string & currentPresetName = modConfig["activePreset"].String();
- JsonNode & currentPreset = modConfig["presets"][currentPresetName];
- if (!vstd::contains(currentPreset["mods"].Vector(), JsonNode(modName)))
- currentPreset["mods"].Vector().emplace_back(modName);
- }
- void ModsPresetState::setSettingActive(const TModID & modName, const TModID & settingName, bool isActive)
- {
- const std::string & currentPresetName = modConfig["activePreset"].String();
- JsonNode & currentPreset = modConfig["presets"][currentPresetName];
- currentPreset["settings"][modName][settingName].Bool() = isActive;
- }
- void ModsPresetState::removeOldMods(const TModList & modsToKeep)
- {
- const std::string & currentPresetName = modConfig["activePreset"].String();
- JsonNode & currentPreset = modConfig["presets"][currentPresetName];
- vstd::erase_if(currentPreset["mods"].Vector(), [&](const JsonNode & entry){
- return !vstd::contains(modsToKeep, entry.String());
- });
- vstd::erase_if(currentPreset["settings"].Struct(), [&](const auto & entry){
- return !vstd::contains(modsToKeep, entry.first);
- });
- for (auto & modSettings : currentPreset["settings"].Struct())
- {
- vstd::erase_if(modSettings.second.Struct(), [&](const auto & entry){
- return !vstd::contains(modsToKeep, modSettings.first + "." + entry.first);
- });
- }
- }
- void ModsPresetState::eraseRootMod(const TModID & modName)
- {
- const std::string & currentPresetName = modConfig["activePreset"].String();
- JsonNode & currentPreset = modConfig["presets"][currentPresetName];
- vstd::erase(currentPreset["mods"].Vector(), JsonNode(modName));
- }
- void ModsPresetState::eraseModSetting(const TModID & modName, const TModID & settingName)
- {
- const std::string & currentPresetName = modConfig["activePreset"].String();
- JsonNode & currentPreset = modConfig["presets"][currentPresetName];
- currentPreset["settings"][modName].Struct().erase(settingName);
- }
- std::vector<TModID> ModsPresetState::getActiveMods() const
- {
- TModList activeRootMods = getActiveRootMods();
- TModList allActiveMods;
- for(const auto & activeMod : activeRootMods)
- {
- assert(!vstd::contains(allActiveMods, activeMod));
- allActiveMods.push_back(activeMod);
- for(const auto & submod : getModSettings(activeMod))
- {
- if(submod.second)
- {
- assert(!vstd::contains(allActiveMods, activeMod + '.' + submod.first));
- allActiveMods.push_back(activeMod + '.' + submod.first);
- }
- }
- }
- return allActiveMods;
- }
- void ModsPresetState::setValidatedChecksum(const TModID & modName, std::optional<uint32_t> value)
- {
- if (value.has_value())
- modConfig["validatedMods"][modName].Integer() = *value;
- else
- modConfig["validatedMods"].Struct().erase(modName);
- }
- void ModsPresetState::saveConfigurationState() const
- {
- std::fstream file(CResourceHandler::get()->getResourceName(ResourcePath("config/modSettings.json"))->c_str(), std::ofstream::out | std::ofstream::trunc);
- file << modConfig.toCompactString();
- }
- void ModsPresetState::createNewPreset(const std::string & presetName)
- {
- if (modConfig["presets"][presetName].isNull())
- modConfig["presets"][presetName]["mods"].Vector().emplace_back("vcmi");
- }
- void ModsPresetState::deletePreset(const std::string & presetName)
- {
- if (modConfig["presets"].Struct().size() < 2)
- throw std::runtime_error("Unable to delete last preset!");
- modConfig["presets"].Struct().erase(presetName);
- }
- void ModsPresetState::activatePreset(const std::string & presetName)
- {
- if (modConfig["presets"].Struct().count(presetName) == 0)
- throw std::runtime_error("Unable to activate non-exinsting preset!");
- modConfig["activePreset"].String() = presetName;
- }
- void ModsPresetState::renamePreset(const std::string & oldPresetName, const std::string & newPresetName)
- {
- if (oldPresetName == newPresetName)
- throw std::runtime_error("Unable to rename preset to the same name!");
- if (modConfig["presets"].Struct().count(oldPresetName) == 0)
- throw std::runtime_error("Unable to rename non-existing last preset!");
- if (modConfig["presets"].Struct().count(newPresetName) != 0)
- throw std::runtime_error("Unable to rename preset - preset with such name already exists!");
- modConfig["presets"][newPresetName] = modConfig["presets"][oldPresetName];
- modConfig["presets"].Struct().erase(oldPresetName);
- if (modConfig["activePreset"].String() == oldPresetName)
- modConfig["activePreset"].String() = newPresetName;
- }
- std::vector<std::string> ModsPresetState::getAllPresets() const
- {
- std::vector<std::string> presets;
- for (const auto & preset : modConfig["presets"].Struct())
- presets.push_back(preset.first);
- return presets;
- }
- std::string ModsPresetState::getActivePreset() const
- {
- return modConfig["activePreset"].String();
- }
- JsonNode ModsPresetState::exportCurrentPreset() const
- {
- JsonNode data = getActivePresetConfig();
- std::string presetName = getActivePreset();
- data["name"] = JsonNode(presetName);
- vstd::erase_if(data["settings"].Struct(), [&](const auto & pair){
- return !vstd::contains(data["mods"].Vector(), JsonNode(pair.first));
- });
- return data;
- }
- std::string ModsPresetState::importPreset(const JsonNode & newConfig)
- {
- std::string importedPresetName = newConfig["name"].String();
- if (importedPresetName.empty())
- throw std::runtime_error("Attempt to import invalid preset");
- modConfig["presets"][importedPresetName] = newConfig;
- modConfig["presets"][importedPresetName].Struct().erase("name");
- return importedPresetName;
- }
- ModsStorage::ModsStorage(const std::vector<TModID> & modsToLoad, const JsonNode & repositoryList)
- {
- JsonNode coreModConfig(JsonPath::builtin("config/gameConfig.json"));
- coreModConfig.setModScope(ModScope::scopeBuiltin());
- mods.try_emplace(ModScope::scopeBuiltin(), ModScope::scopeBuiltin(), coreModConfig, JsonNode());
- // MODS COMPATIBILITY: in 1.6, repository list contains mod list directly, in 1.7 it is located in 'availableMods' node
- const auto & availableRepositoryMods = repositoryList["availableMods"].isNull() ? repositoryList : repositoryList["availableMods"];
- for(auto modID : modsToLoad)
- {
- if(ModScope::isScopeReserved(modID))
- continue;
- JsonNode modConfig(getModDescriptionFile(modID));
- modConfig.setModScope(modID);
- if(modConfig["modType"].isNull())
- {
- logMod->error("Can not load mod %s - invalid mod config file!", modID);
- continue;
- }
- mods.try_emplace(modID, modID, modConfig, availableRepositoryMods[modID]);
- }
- for(const auto & mod : availableRepositoryMods.Struct())
- {
- if (vstd::contains(modsToLoad, mod.first))
- continue;
- if (mod.second["modType"].isNull() || mod.second["name"].isNull())
- continue;
- mods.try_emplace(mod.first, mod.first, JsonNode(), mod.second);
- }
- }
- const ModDescription & ModsStorage::getMod(const TModID & fullID) const
- {
- try {
- return mods.at(fullID);
- }
- catch (const std::out_of_range & )
- {
- // rethrow with better error message
- throw std::out_of_range("Failed to find mod " + fullID);
- }
- }
- TModList ModsStorage::getAllMods() const
- {
- TModList result;
- for (const auto & mod : mods)
- result.push_back(mod.first);
- return result;
- }
- ModManager::ModManager()
- :ModManager(JsonNode())
- {
- }
- ModManager::ModManager(const JsonNode & repositoryList)
- : modsState(std::make_unique<ModsState>())
- , modsPreset(std::make_unique<ModsPresetState>())
- {
- modsStorage = std::make_unique<ModsStorage>(modsState->getInstalledMods(), repositoryList);
- eraseMissingModsFromPreset();
- addNewModsToPreset();
- std::vector<TModID> desiredModList = modsPreset->getActiveMods();
- ModDependenciesResolver newResolver(desiredModList, *modsStorage);
- updatePreset(newResolver);
- }
- ModManager::~ModManager() = default;
- const ModDescription & ModManager::getModDescription(const TModID & modID) const
- {
- assert(boost::to_lower_copy(modID) == modID);
- return modsStorage->getMod(modID);
- }
- bool ModManager::isModSettingActive(const TModID & rootModID, const TModID & modSettingID) const
- {
- return modsPreset->getModSettings(rootModID).at(modSettingID);
- }
- bool ModManager::isModActive(const TModID & modID) const
- {
- return vstd::contains(getActiveMods(), modID);
- }
- const TModList & ModManager::getActiveMods() const
- {
- return depedencyResolver->getActiveMods();
- }
- uint32_t ModManager::computeChecksum(const TModID & modName) const
- {
- return modsState->computeChecksum(modName);
- }
- std::optional<uint32_t> ModManager::getValidatedChecksum(const TModID & modName) const
- {
- return modsPreset->getValidatedChecksum(modName);
- }
- void ModManager::setValidatedChecksum(const TModID & modName, std::optional<uint32_t> value)
- {
- modsPreset->setValidatedChecksum(modName, value);
- }
- void ModManager::saveConfigurationState() const
- {
- modsPreset->saveConfigurationState();
- }
- TModList ModManager::getAllMods() const
- {
- return modsStorage->getAllMods();
- }
- double ModManager::getInstalledModSizeMegabytes(const TModID & modName) const
- {
- return modsState->getInstalledModSizeMegabytes(modName);
- }
- void ModManager::eraseMissingModsFromPreset()
- {
- const TModList & installedMods = getInstalledValidMods();
- const TModList & rootMods = modsPreset->getActiveRootMods();
- modsPreset->removeOldMods(installedMods);
- for(const auto & rootMod : rootMods)
- {
- const auto & modSettings = modsPreset->getModSettings(rootMod);
- for(const auto & modSetting : modSettings)
- {
- TModID fullModID = rootMod + '.' + modSetting.first;
- if(!vstd::contains(installedMods, fullModID))
- {
- modsPreset->eraseModSetting(rootMod, modSetting.first);
- continue;
- }
- }
- }
- }
- void ModManager::addNewModsToPreset()
- {
- const TModList & installedMods = getInstalledValidMods();
- for(const auto & modID : installedMods)
- {
- size_t dotPos = modID.find('.');
- if(dotPos == std::string::npos)
- continue; // only look up submods aka mod settings
- std::string rootMod = modID.substr(0, dotPos);
- std::string settingID = modID.substr(dotPos + 1);
- const auto & modSettings = modsPreset->getModSettings(rootMod);
- if (!modSettings.count(settingID))
- modsPreset->setSettingActive(rootMod, settingID, !modsStorage->getMod(modID).keepDisabled());
- }
- }
- TModList ModManager::getInstalledValidMods() const
- {
- TModList installedMods = modsState->getInstalledMods();
- TModList validMods = modsStorage->getAllMods();
- TModList result;
- for (const auto & modID : installedMods)
- if (vstd::contains(validMods, modID))
- result.push_back(modID);
- return result;
- }
- TModList ModManager::collectDependenciesRecursive(const TModID & modID) const
- {
- TModList result;
- TModList toTest;
- toTest.push_back(modID);
- while (!toTest.empty())
- {
- TModID currentModID = toTest.back();
- const auto & currentMod = getModDescription(currentModID);
- toTest.pop_back();
- result.push_back(currentModID);
- if (!currentMod.isInstalled())
- throw std::runtime_error("Unable to enable mod " + modID + "! Dependency " + currentModID + " is not installed!");
- for (const auto & dependency : currentMod.getDependencies())
- {
- if (!vstd::contains(result, dependency))
- toTest.push_back(dependency);
- }
- }
- return result;
- }
- void ModManager::tryEnableMods(const TModList & modList)
- {
- TModList requiredActiveMods;
- TModList additionalActiveMods = getActiveMods();
- for (const auto & modName : modList)
- {
- for (const auto & dependency : collectDependenciesRecursive(modName))
- {
- if (!vstd::contains(requiredActiveMods, dependency))
- {
- requiredActiveMods.push_back(dependency);
- vstd::erase(additionalActiveMods, dependency);
- }
- }
- assert(!vstd::contains(additionalActiveMods, modName));
- assert(vstd::contains(requiredActiveMods, modName));// FIXME: fails on attempt to enable broken mod / translation to other language
- }
- ModDependenciesResolver testResolver(requiredActiveMods, *modsStorage);
- testResolver.tryAddMods(additionalActiveMods, *modsStorage);
- TModList additionalActiveSubmods;
- for (const auto & modName : modList)
- {
- if (modName.find('.') != std::string::npos)
- continue;
- auto modSettings = modsPreset->getModSettings(modName);
- for (const auto & entry : modSettings)
- {
- TModID fullModID = modName + '.' + entry.first;
- if (entry.second && !vstd::contains(requiredActiveMods, fullModID))
- additionalActiveSubmods.push_back(fullModID);
- }
- }
- testResolver.tryAddMods(additionalActiveSubmods, *modsStorage);
- for (const auto & modName : modList)
- if (!vstd::contains(testResolver.getActiveMods(), modName))
- logGlobal->error("Failed to enable mod '%s'! This may be caused by a recursive dependency!", modName);
- updatePreset(testResolver);
- }
- void ModManager::tryDisableMod(const TModID & modName)
- {
- auto desiredActiveMods = getActiveMods();
- assert(vstd::contains(desiredActiveMods, modName));
- vstd::erase(desiredActiveMods, modName);
- ModDependenciesResolver testResolver(desiredActiveMods, *modsStorage);
- if (vstd::contains(testResolver.getActiveMods(), modName))
- throw std::runtime_error("Failed to disable mod! Mod " + modName + " remains enabled!");
- modsPreset->setModActive(modName, false);
- updatePreset(testResolver);
- }
- void ModManager::updatePreset(const ModDependenciesResolver & testResolver)
- {
- const auto & newActiveMods = testResolver.getActiveMods();
- const auto & newBrokenMods = testResolver.getBrokenMods();
- for (const auto & modID : newActiveMods)
- {
- assert(vstd::contains(getInstalledValidMods(), modID));
- modsPreset->setModActive(modID, true);
- }
- for (const auto & modID : newBrokenMods)
- {
- const auto & mod = getModDescription(modID);
- if (mod.getTopParentID().empty() || vstd::contains(newActiveMods, mod.getTopParentID()))
- modsPreset->setModActive(modID, false);
- }
- std::vector<TModID> desiredModList = modsPreset->getActiveMods();
- // Try to enable all existing compatibility patches. Ignore on failure
- for (const auto & rootMod : modsPreset->getActiveRootMods())
- {
- for (const auto & modSetting : modsPreset->getModSettings(rootMod))
- {
- if (modSetting.second)
- continue;
- TModID fullModID = rootMod + '.' + modSetting.first;
- const auto & modDescription = modsStorage->getMod(fullModID);
- if (modDescription.isCompatibility())
- desiredModList.push_back(fullModID);
- }
- }
- depedencyResolver = std::make_unique<ModDependenciesResolver>(desiredModList, *modsStorage);
- modsPreset->saveConfigurationState();
- }
- ModDependenciesResolver::ModDependenciesResolver(const TModList & modsToResolve, const ModsStorage & storage)
- {
- tryAddMods(modsToResolve, storage);
- }
- const TModList & ModDependenciesResolver::getActiveMods() const
- {
- return activeMods;
- }
- const TModList & ModDependenciesResolver::getBrokenMods() const
- {
- return brokenMods;
- }
- void ModDependenciesResolver::tryAddMods(TModList modsToResolve, const ModsStorage & storage)
- {
- // Topological sort algorithm.
- boost::range::sort(modsToResolve); // Sort mods per name
- std::vector<TModID> sortedValidMods(activeMods.begin(), activeMods.end()); // Vector keeps order of elements (LIFO)
- std::set<TModID> resolvedModIDs(activeMods.begin(), activeMods.end()); // Use a set for validation for performance reason, but set does not keep order of elements
- std::set<TModID> notResolvedModIDs(modsToResolve.begin(), modsToResolve.end()); // Use a set for validation for performance reason
- // Mod is resolved if it has no dependencies or all its dependencies are already resolved
- auto isResolved = [&](const ModDescription & mod) -> bool
- {
- if (mod.isTranslation() && CGeneralTextHandler::getPreferredLanguage() != mod.getBaseLanguage())
- return false;
- if(!mod.isCompatible())
- return false;
- if(mod.getDependencies().size() > resolvedModIDs.size())
- return false;
- for(const TModID & dependency : mod.getDependencies())
- if(!vstd::contains(resolvedModIDs, dependency))
- return false;
- for(const TModID & softDependency : mod.getSoftDependencies())
- if(vstd::contains(notResolvedModIDs, softDependency))
- return false;
- for(const TModID & conflict : mod.getConflicts())
- if(vstd::contains(resolvedModIDs, conflict))
- return false;
- for(const TModID & reverseConflict : resolvedModIDs)
- if(vstd::contains(storage.getMod(reverseConflict).getConflicts(), mod.getID()))
- return false;
- return true;
- };
- while(true)
- {
- std::set<TModID> resolvedOnCurrentTreeLevel;
- for(auto it = modsToResolve.begin(); it != modsToResolve.end();) // One iteration - one level of mods tree
- {
- if(isResolved(storage.getMod(*it)))
- {
- resolvedOnCurrentTreeLevel.insert(*it); // Not to the resolvedModIDs, so current node children will be resolved on the next iteration
- assert(!vstd::contains(sortedValidMods, *it));
- 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
- sortedValidMods.insert(sortedValidMods.begin(), *it);
- else
- sortedValidMods.push_back(*it);
- it = modsToResolve.erase(it);
- continue;
- }
- it++;
- }
- if(!resolvedOnCurrentTreeLevel.empty())
- {
- resolvedModIDs.insert(resolvedOnCurrentTreeLevel.begin(), resolvedOnCurrentTreeLevel.end());
- for(const auto & it : resolvedOnCurrentTreeLevel)
- notResolvedModIDs.erase(it);
- continue;
- }
- // If there are no valid mods on the current mods tree level, no more mod can be resolved, should be ended.
- break;
- }
- assert(!sortedValidMods.empty());
- activeMods = sortedValidMods;
- brokenMods.insert(brokenMods.end(), modsToResolve.begin(), modsToResolve.end());
- }
- void ModManager::createNewPreset(const std::string & presetName)
- {
- modsPreset->createNewPreset(presetName);
- modsPreset->saveConfigurationState();
- }
- void ModManager::deletePreset(const std::string & presetName)
- {
- modsPreset->deletePreset(presetName);
- modsPreset->saveConfigurationState();
- }
- void ModManager::activatePreset(const std::string & presetName)
- {
- modsPreset->activatePreset(presetName);
- modsPreset->saveConfigurationState();
- }
- void ModManager::renamePreset(const std::string & oldPresetName, const std::string & newPresetName)
- {
- modsPreset->renamePreset(oldPresetName, newPresetName);
- modsPreset->saveConfigurationState();
- }
- std::vector<std::string> ModManager::getAllPresets() const
- {
- return modsPreset->getAllPresets();
- }
- std::string ModManager::getActivePreset() const
- {
- return modsPreset->getActivePreset();
- }
- JsonNode ModManager::exportCurrentPreset() const
- {
- return modsPreset->exportCurrentPreset();
- }
- std::tuple<std::string, TModList> ModManager::importPreset(const JsonNode & data)
- {
- std::string presetName = modsPreset->importPreset(data);
- TModList requiredMods = modsPreset->getRootMods(presetName);
- TModList installedMods = getInstalledValidMods();
- TModList missingMods;
- for (const auto & modID : requiredMods)
- {
- if (!vstd::contains(installedMods, modID))
- missingMods.push_back(modID);
- }
- modsPreset->saveConfigurationState();
- return {presetName, missingMods};
- }
- VCMI_LIB_NAMESPACE_END
|