1
0
mirror of https://github.com/vcmi/vcmi.git synced 2024-12-16 10:19:47 +02:00
vcmi/launcher/modManager/cmodmanager.cpp

345 lines
9.1 KiB
C++
Raw Normal View History

/*
* cmodmanager.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 "cmodmanager.h"
#include "../../lib/VCMIDirs.h"
#include "../../lib/filesystem/Filesystem.h"
#include "../../lib/filesystem/CZipLoader.h"
#include "../../lib/modding/CModHandler.h"
#include "../../lib/modding/CModInfo.h"
#include "../../lib/modding/IdentifierStorage.h"
#include "../jsonutils.h"
#include "../launcherdirs.h"
namespace
{
QString detectModArchive(QString path, QString modName)
{
2016-01-09 22:23:55 +02:00
auto files = ZipArchive::listFiles(qstringToPath(path));
QString modDirName;
for(int folderLevel : {0, 1}) //search in subfolder if there is no mod.json in the root
{
for(auto file : files)
{
QString filename = QString::fromUtf8(file.c_str());
modDirName = filename.section('/', 0, folderLevel);
if(filename == modDirName + "/mod.json")
{
return modDirName;
}
}
}
return "";
}
}
CModManager::CModManager(CModList * modList)
: modList(modList)
{
loadMods();
loadModSettings();
}
QString CModManager::settingsPath()
{
return pathToQString(VCMIDirs::get().userConfigPath() / "modSettings.json");
}
void CModManager::loadModSettings()
{
modSettings = JsonUtils::JsonFromFile(settingsPath()).toMap();
modList->setModSettings(modSettings["activeMods"]);
}
void CModManager::resetRepositories()
{
modList->resetRepositories();
}
2022-09-29 15:38:03 +02:00
void CModManager::loadRepository(QVariantMap repomap)
{
2022-09-29 15:38:03 +02:00
modList->addRepository(repomap);
}
void CModManager::loadMods()
{
CModHandler handler;
handler.loadMods();
auto installedMods = handler.getAllMods();
localMods.clear();
for(auto modname : installedMods)
{
ResourceID resID(CModInfo::getModFile(modname));
if(CResourceHandler::get()->existsResource(resID))
{
2023-09-01 16:43:26 +02:00
//calculate mod size
qint64 total = 0;
ResourceID resDir(CModInfo::getModDir(modname), EResType::DIRECTORY);
if(CResourceHandler::get()->existsResource(resDir))
{
for(QDirIterator iter(QString::fromStdString(CResourceHandler::get()->getResourceName(resDir)->string()), QDirIterator::Subdirectories); iter.hasNext(); iter.next())
total += iter.fileInfo().size();
total /= 1024; //to Kb
}
boost::filesystem::path name = *CResourceHandler::get()->getResourceName(resID);
2016-01-16 20:44:15 +02:00
auto mod = JsonUtils::JsonFromFile(pathToQString(name));
2023-09-01 16:43:26 +02:00
auto json = JsonUtils::toJson(mod);
json["localSize"].Integer() = total;
if(!name.is_absolute())
json["storedLocaly"].Bool() = true;
2023-09-01 16:43:26 +02:00
mod = JsonUtils::toVariant(json);
localMods.insert(QString::fromUtf8(modname.c_str()).toLower(), mod);
}
}
modList->setLocalModList(localMods);
}
2013-09-06 00:25:03 +03:00
bool CModManager::addError(QString modname, QString message)
{
recentErrors.push_back(QString("%1: %2").arg(modname).arg(message));
return false;
}
QStringList CModManager::getErrors()
{
QStringList ret = recentErrors;
recentErrors.clear();
return ret;
}
bool CModManager::installMod(QString modname, QString archivePath)
{
return canInstallMod(modname) && doInstallMod(modname, archivePath);
}
bool CModManager::uninstallMod(QString modname)
{
return canUninstallMod(modname) && doUninstallMod(modname);
}
bool CModManager::enableMod(QString modname)
{
return canEnableMod(modname) && doEnableMod(modname, true);
}
bool CModManager::disableMod(QString modname)
{
return canDisableMod(modname) && doEnableMod(modname, false);
}
bool CModManager::canInstallMod(QString modname)
{
auto mod = modList->getMod(modname);
if(mod.getName().contains('.'))
return addError(modname, "Can not install submod");
if(mod.isInstalled())
2013-09-06 00:25:03 +03:00
return addError(modname, "Mod is already installed");
if(!mod.isAvailable())
2013-09-06 00:25:03 +03:00
return addError(modname, "Mod is not available");
return true;
}
bool CModManager::canUninstallMod(QString modname)
{
auto mod = modList->getMod(modname);
if(mod.getName().contains('.'))
return addError(modname, "Can not uninstall submod");
if(!mod.isInstalled())
2013-09-06 00:25:03 +03:00
return addError(modname, "Mod is not installed");
return true;
}
bool CModManager::canEnableMod(QString modname)
{
auto mod = modList->getMod(modname);
if(mod.isEnabled())
2013-09-06 00:25:03 +03:00
return addError(modname, "Mod is already enabled");
if(!mod.isInstalled())
2013-09-06 00:25:03 +03:00
return addError(modname, "Mod must be installed first");
2022-09-17 15:43:59 +02:00
//check for compatibility
if(!mod.isCompatible())
return addError(modname, "Mod is not compatible, please update VCMI and checkout latest mod revisions");
for(auto modEntry : mod.getValue("depends").toStringList())
{
if(!modList->hasMod(modEntry)) // required mod is not available
2013-09-06 00:25:03 +03:00
return addError(modname, QString("Required mod %1 is missing").arg(modEntry));
if(!modList->getMod(modEntry).isEnabled())
2013-09-06 00:25:03 +03:00
return addError(modname, QString("Required mod %1 is not enabled").arg(modEntry));
}
for(QString modEntry : modList->getModList())
{
2013-09-06 00:25:03 +03:00
auto mod = modList->getMod(modEntry);
2013-09-06 00:25:03 +03:00
// "reverse conflict" - enabled mod has this one as conflict
if(mod.isEnabled() && mod.getValue("conflicts").toStringList().contains(modname))
2013-09-06 00:25:03 +03:00
return addError(modname, QString("This mod conflicts with %1").arg(modEntry));
}
for(auto modEntry : mod.getValue("conflicts").toStringList())
{
// check if conflicting mod installed and enabled
if(modList->hasMod(modEntry) && modList->getMod(modEntry).isEnabled())
2013-09-06 00:25:03 +03:00
return addError(modname, QString("This mod conflicts with %1").arg(modEntry));
}
return true;
}
bool CModManager::canDisableMod(QString modname)
{
auto mod = modList->getMod(modname);
if(mod.isDisabled())
2013-09-06 00:25:03 +03:00
return addError(modname, "Mod is already disabled");
if(!mod.isInstalled())
2013-09-06 00:25:03 +03:00
return addError(modname, "Mod must be installed first");
for(QString modEntry : modList->getModList())
{
auto current = modList->getMod(modEntry);
if(current.getValue("depends").toStringList().contains(modname) && current.isEnabled())
2013-09-06 00:25:03 +03:00
return addError(modname, QString("This mod is needed to run %1").arg(modEntry));
}
return true;
}
static QVariant writeValue(QString path, QVariantMap input, QVariant value)
{
if(path.size() > 1)
{
QString entryName = path.section('/', 0, 1);
QString remainder = "/" + path.section('/', 2, -1);
entryName.remove(0, 1);
input.insert(entryName, writeValue(remainder, input.value(entryName).toMap(), value));
return input;
}
else
{
return value;
}
}
bool CModManager::doEnableMod(QString mod, bool on)
{
QString path = mod;
path = "/activeMods/" + path.replace(".", "/mods/") + "/active";
modSettings = writeValue(path, modSettings, QVariant(on)).toMap();
modList->setModSettings(modSettings["activeMods"]);
modList->modChanged(mod);
JsonUtils::JsonToFile(settingsPath(), modSettings);
return true;
}
bool CModManager::doInstallMod(QString modname, QString archivePath)
{
QString destDir = CLauncherDirs::get().modsPath() + "/";
if(!QFile(archivePath).exists())
2013-09-06 00:25:03 +03:00
return addError(modname, "Mod archive is missing");
if(localMods.contains(modname))
2013-09-06 00:25:03 +03:00
return addError(modname, "Mod with such name is already installed");
QString modDirName = ::detectModArchive(archivePath, modname);
if(!modDirName.size())
2013-09-06 00:25:03 +03:00
return addError(modname, "Mod archive is invalid or corrupted");
if(!ZipArchive::extract(qstringToPath(archivePath), qstringToPath(destDir)))
{
removeModDir(destDir + modDirName);
2013-09-06 00:25:03 +03:00
return addError(modname, "Failed to extract mod data");
}
//rename folder and fix the path
QDir extractedDir(destDir + modDirName);
auto rc = QFile::rename(destDir + modDirName, destDir + modname);
if (rc)
extractedDir.setPath(destDir + modname);
//there are possible excessive files - remove them
QString upperLevel = modDirName.section('/', 0, 0);
if(upperLevel != modDirName)
removeModDir(destDir + upperLevel);
CResourceHandler::get("initial")->updateFilteredFiles([](const std::string &) { return true; });
loadMods();
modList->reloadRepositories();
return true;
}
bool CModManager::doUninstallMod(QString modname)
{
2022-09-26 15:37:31 +02:00
ResourceID resID(std::string("Mods/") + modname.toStdString(), EResType::DIRECTORY);
// Get location of the mod, in case-insensitive way
2016-01-16 20:44:15 +02:00
QString modDir = pathToQString(*CResourceHandler::get()->getResourceName(resID));
if(!QDir(modDir).exists())
2013-09-06 00:25:03 +03:00
return addError(modname, "Data with this mod was not found");
QDir modFullDir(modDir);
if(!removeModDir(modDir))
2022-09-26 15:37:31 +02:00
return addError(modname, "Mod is located in protected directory, please remove it manually:\n" + modFullDir.absolutePath());
CResourceHandler::get("initial")->updateFilteredFiles([](const std::string &){ return true; });
loadMods();
modList->reloadRepositories();
return true;
}
bool CModManager::removeModDir(QString path)
{
// issues 2673 and 2680 its why you do not recursively remove without sanity check
QDir checkDir(path);
2022-09-25 14:24:25 +02:00
QDir dir(path);
if(!checkDir.cdUp() || QString::compare("Mods", checkDir.dirName(), Qt::CaseInsensitive))
return false;
2022-09-25 14:17:21 +02:00
#ifndef VCMI_IOS //ios applications are stored in the isolated container
if(!checkDir.cdUp() || QString::compare("vcmi", checkDir.dirName(), Qt::CaseInsensitive))
return false;
if(!dir.absolutePath().contains("vcmi", Qt::CaseInsensitive))
return false;
2022-09-25 14:17:21 +02:00
#endif
if(!dir.absolutePath().contains("Mods", Qt::CaseInsensitive))
return false;
return dir.removeRecursively();
}