/* * 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 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(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(&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(&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(1024*1024); return sizeMegabytes; } std::vector 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 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()); } 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 { const JsonNode & modsToActivateJson = getActivePresetConfig()["mods"]; auto modsToActivate = modsToActivateJson.convertTo>(); if (!vstd::contains(modsToActivate, ModScope::scopeBuiltin())) modsToActivate.push_back(ModScope::scopeBuiltin()); return modsToActivate; } std::map ModsPresetState::getModSettings(const TModID & modID) const { const JsonNode & modSettingsJson = getActivePresetConfig()["settings"][modID]; auto modSettings = modSettingsJson.convertTo>(); return modSettings; } std::optional 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); }); } 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 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 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 ModsPresetState::getAllPresets() const { std::vector presets; for (const auto & preset : modConfig["presets"].Struct()) presets.push_back(preset.first); return presets; } std::string ModsPresetState::getActivePreset() const { return modConfig["activePreset"].String(); } ModsStorage::ModsStorage(const std::vector & modsToLoad, const JsonNode & repositoryList) { JsonNode coreModConfig(JsonPath::builtin("config/gameConfig.json")); coreModConfig.setModScope(ModScope::scopeBuiltin()); mods.try_emplace(ModScope::scopeBuiltin(), ModScope::scopeBuiltin(), coreModConfig, JsonNode()); 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, repositoryList[modID]); } for(const auto & mod : repositoryList.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 { return mods.at(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()) , modsPreset(std::make_unique()) { modsStorage = std::make_unique(modsState->getInstalledMods(), repositoryList); eraseMissingModsFromPreset(); addNewModsToPreset(); std::vector 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 ModManager::getValidatedChecksum(const TModID & modName) const { return modsPreset->getValidatedChecksum(modName); } void ModManager::setValidatedChecksum(const TModID & modName, std::optional 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 = modsState->getInstalledMods(); 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 = modsState->getInstalledMods(); 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::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)) throw std::runtime_error("Failed to enable mod! Mod " + modName + " remains disabled!"); 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(modsState->getInstalledMods(), modID)); modsPreset->setModActive(modID, true); } for (const auto & modID : newBrokenMods) { const auto & mod = getModDescription(modID); if (vstd::contains(newActiveMods, mod.getTopParentID())) modsPreset->setModActive(modID, false); } std::vector 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(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 sortedValidMods(activeMods.begin(), activeMods.end()); // Vector keeps order of elements (LIFO) std::set resolvedModIDs(activeMods.begin(), activeMods.end()); // Use a set for validation for performance reason, but set does not keep order of elements std::set 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.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 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)); 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 ModManager::getAllPresets() const { return modsPreset->getAllPresets(); } std::string ModManager::getActivePreset() const { return modsPreset->getActivePreset(); } VCMI_LIB_NAMESPACE_END