feat: add curseforge modpack updating

Signed-off-by: flow <flowlnlnln@gmail.com>
This commit is contained in:
flow 2022-07-14 16:41:49 -03:00
parent ebd46705d5
commit 795d6f35ee
No known key found for this signature in database
GPG Key ID: 8D0F221F0A59F469
4 changed files with 206 additions and 36 deletions

View File

@ -1,5 +1,6 @@
#include "FlameInstanceCreationTask.h" #include "FlameInstanceCreationTask.h"
#include "modplatform/flame/FlameAPI.h"
#include "modplatform/flame/PackManifest.h" #include "modplatform/flame/PackManifest.h"
#include "Application.h" #include "Application.h"
@ -11,10 +12,23 @@
#include "settings/INISettingsObject.h" #include "settings/INISettingsObject.h"
#include "ui/dialogs/CustomMessageBox.h"
#include "ui/dialogs/BlockedModsDialog.h" #include "ui/dialogs/BlockedModsDialog.h"
// NOTE: Because of CF's ToS, I don't know if it counts as caching data, so it'll be disabled for now
#define DO_DIFF_UPDATE 0
const static QMap<QString, QString> forgemap = { { "1.2.5", "3.4.9.171" },
{ "1.4.2", "6.0.1.355" },
{ "1.4.7", "6.6.2.534" },
{ "1.5.2", "7.8.1.737" } };
static const FlameAPI api;
bool FlameCreationTask::abort() bool FlameCreationTask::abort()
{ {
if (m_process_update_file_info_job)
m_process_update_file_info_job->abort();
if (m_files_job) if (m_files_job)
m_files_job->abort(); m_files_job->abort();
if (m_mod_id_resolver) if (m_mod_id_resolver)
@ -23,43 +37,186 @@ bool FlameCreationTask::abort()
return true; return true;
} }
const static QMap<QString, QString> forgemap = { { "1.2.5", "3.4.9.171" }, bool FlameCreationTask::updateInstance()
{ "1.4.2", "6.0.1.355" },
{ "1.4.7", "6.6.2.534" },
{ "1.5.2", "7.8.1.737" } };
bool FlameCreationTask::createInstance()
{ {
QEventLoop loop; auto instance_list = APPLICATION->instances();
// FIXME: How to handle situations when there's more than one install already for a given modpack?
auto inst = instance_list->getInstanceByManagedName(originalName());
if (!inst) {
inst = instance_list->getInstanceById(originalName());
if (!inst)
return false;
}
QString index_path(FS::PathCombine(m_stagingPath, "manifest.json"));
Flame::Manifest pack;
try { try {
QString configPath = FS::PathCombine(m_stagingPath, "manifest.json"); Flame::loadManifest(m_pack, index_path);
Flame::loadManifest(pack, configPath);
QFile::remove(configPath);
} catch (const JSONValidationError& e) { } catch (const JSONValidationError& e) {
setError(tr("Could not understand pack manifest:\n") + e.cause()); setError(tr("Could not understand pack manifest:\n") + e.cause());
return false; return false;
} }
if (!pack.overrides.isEmpty()) { auto version_id = inst->getManagedPackVersionName();
QString overridePath = FS::PathCombine(m_stagingPath, pack.overrides); auto version_str = !version_id.isEmpty() ? tr(" (version %1)").arg(version_id) : "";
auto info = CustomMessageBox::selectable(m_parent, tr("Similar modpack was found!"),
tr("One or more of your instances are from this same modpack%1. Do you want to create a "
"separate instance, or update the existing one?")
.arg(version_str),
QMessageBox::Information, QMessageBox::Ok | QMessageBox::Abort);
info->setButtonText(QMessageBox::Ok, tr("Update existing instance"));
info->setButtonText(QMessageBox::Abort, tr("Create new instance"));
if (info->exec() && info->clickedButton() == info->button(QMessageBox::Abort))
return false;
QDir old_inst_dir(inst->instanceRoot());
QString old_index_path(FS::PathCombine(old_inst_dir.absolutePath(), "flame", "manifest.json"));
QFileInfo old_index_file(old_index_path);
if (old_index_file.exists()) {
Flame::Manifest old_pack;
Flame::loadManifest(old_pack, old_index_path);
auto& old_files = old_pack.files;
#if DO_DIFF_UPDATE
// Remove repeated files, we don't need to download them!
auto& files = m_pack.files;
// Let's remove all duplicated, identical resources!
auto files_iterator = files.begin();
while (files_iterator != files.end()) {
auto const& file = files_iterator;
auto old_file = old_files.find(file.key());
if (old_file != old_files.end()) {
// We found a match, but is it a different version?
if (old_file->fileId == file->fileId) {
qDebug() << "Removed file at" << file->targetFolder << "with id" << file->fileId << "from list of downloads";
old_files.remove(file.key());
files_iterator = files.erase(files_iterator);
}
}
files_iterator++;
}
#endif
// Remove remaining old files (we need to do an API request to know which ids are which files...)
QStringList fileIds;
for (auto& file : old_files) {
fileIds.append(QString::number(file.fileId));
}
auto* raw_response = new QByteArray;
auto job = api.getFiles(fileIds, raw_response);
QEventLoop loop;
connect(job, &NetJob::succeeded, this, [raw_response, fileIds, old_inst_dir, &old_files] {
// Parse the API response
QJsonParseError parse_error{};
auto doc = QJsonDocument::fromJson(*raw_response, &parse_error);
if (parse_error.error != QJsonParseError::NoError) {
qWarning() << "Error while parsing JSON response from Flame files task at " << parse_error.offset
<< " reason: " << parse_error.errorString();
qWarning() << *raw_response;
return;
}
try {
QJsonArray entries;
if (fileIds.size() == 1)
entries = { Json::requireObject(Json::requireObject(doc), "data") };
else
entries = Json::requireArray(Json::requireObject(doc), "data");
for (auto entry : entries) {
auto entry_obj = Json::requireObject(entry);
Flame::File file;
// We don't care about blocked mods, we just need local data to delete the file
file.parseFromObject(entry_obj, false);
auto id = Json::requireInteger(entry_obj, "id");
old_files.insert(id, file);
}
} catch (Json::JsonException& e) {
qCritical() << e.cause() << e.what();
}
// Delete the files
for (auto& file : old_files) {
if (file.fileName.isEmpty() || file.targetFolder.isEmpty())
continue;
qDebug() << "Removing" << file.fileName << "at" << file.targetFolder;
QString path(FS::PathCombine(old_inst_dir.absolutePath(), "minecraft", file.targetFolder, file.fileName));
if (!QFile::remove(path))
qDebug() << "Failed to remove file at" << path;
}
});
connect(job, &NetJob::finished, &loop, &QEventLoop::quit);
m_process_update_file_info_job = job;
job->start();
loop.exec();
m_process_update_file_info_job = nullptr;
}
// TODO: Currently 'overrides' will always override the stuff on update. How do we preserve unchanged overrides?
setOverride(true);
qDebug() << "Will override instance!";
// We let it go through the createInstance() stage, just with a couple modifications for updating
return false;
}
bool FlameCreationTask::createInstance()
{
QEventLoop loop;
try {
QString index_path(FS::PathCombine(m_stagingPath, "manifest.json"));
if (!m_pack.is_loaded)
Flame::loadManifest(m_pack, index_path);
// Keep index file in case we need it some other time (like when changing versions)
QString new_index_place(FS::PathCombine(m_stagingPath, "flame", "manifest.json"));
FS::ensureFilePathExists(new_index_place);
QFile::rename(index_path, new_index_place);
} catch (const JSONValidationError& e) {
setError(tr("Could not understand pack manifest:\n") + e.cause());
return false;
}
if (!m_pack.overrides.isEmpty()) {
QString overridePath = FS::PathCombine(m_stagingPath, m_pack.overrides);
if (QFile::exists(overridePath)) { if (QFile::exists(overridePath)) {
QString mcPath = FS::PathCombine(m_stagingPath, "minecraft"); QString mcPath = FS::PathCombine(m_stagingPath, "minecraft");
if (!QFile::rename(overridePath, mcPath)) { if (!QFile::rename(overridePath, mcPath)) {
setError(tr("Could not rename the overrides folder:\n") + pack.overrides); setError(tr("Could not rename the overrides folder:\n") + m_pack.overrides);
return false; return false;
} }
} else { } else {
logWarning( logWarning(
tr("The specified overrides folder (%1) is missing. Maybe the modpack was already used before?").arg(pack.overrides)); tr("The specified overrides folder (%1) is missing. Maybe the modpack was already used before?").arg(m_pack.overrides));
} }
} }
QString forgeVersion; QString forgeVersion;
QString fabricVersion; QString fabricVersion;
// TODO: is Quilt relevant here? // TODO: is Quilt relevant here?
for (auto& loader : pack.minecraft.modLoaders) { for (auto& loader : m_pack.minecraft.modLoaders) {
auto id = loader.id; auto id = loader.id;
if (id.startsWith("forge-")) { if (id.startsWith("forge-")) {
id.remove("forge-"); id.remove("forge-");
@ -77,7 +234,7 @@ bool FlameCreationTask::createInstance()
QString configPath = FS::PathCombine(m_stagingPath, "instance.cfg"); QString configPath = FS::PathCombine(m_stagingPath, "instance.cfg");
auto instanceSettings = std::make_shared<INISettingsObject>(configPath); auto instanceSettings = std::make_shared<INISettingsObject>(configPath);
MinecraftInstance instance(m_globalSettings, instanceSettings, m_stagingPath); MinecraftInstance instance(m_globalSettings, instanceSettings, m_stagingPath);
auto mcVersion = pack.minecraft.version; auto mcVersion = m_pack.minecraft.version;
// Hack to correct some 'special sauce'... // Hack to correct some 'special sauce'...
if (mcVersion.endsWith('.')) { if (mcVersion.endsWith('.')) {
@ -105,9 +262,9 @@ bool FlameCreationTask::createInstance()
if (m_instIcon != "default") { if (m_instIcon != "default") {
instance.setIconKey(m_instIcon); instance.setIconKey(m_instIcon);
} else { } else {
if (pack.name.contains("Direwolf20")) { if (m_pack.name.contains("Direwolf20")) {
instance.setIconKey("steve"); instance.setIconKey("steve");
} else if (pack.name.contains("FTB") || pack.name.contains("Feed The Beast")) { } else if (m_pack.name.contains("FTB") || m_pack.name.contains("Feed The Beast")) {
instance.setIconKey("ftb_logo"); instance.setIconKey("ftb_logo");
} else { } else {
instance.setIconKey("flame"); instance.setIconKey("flame");
@ -133,10 +290,8 @@ bool FlameCreationTask::createInstance()
instance.setName(m_instName); instance.setName(m_instName);
m_mod_id_resolver = new Flame::FileResolvingTask(APPLICATION->network(), pack); m_mod_id_resolver = new Flame::FileResolvingTask(APPLICATION->network(), m_pack);
connect(m_mod_id_resolver.get(), &Flame::FileResolvingTask::succeeded, this, [this, &loop]{ connect(m_mod_id_resolver.get(), &Flame::FileResolvingTask::succeeded, this, [this, &loop] { idResolverSucceeded(loop); });
idResolverSucceeded(loop);
});
connect(m_mod_id_resolver.get(), &Flame::FileResolvingTask::failed, [&](QString reason) { connect(m_mod_id_resolver.get(), &Flame::FileResolvingTask::failed, [&](QString reason) {
m_mod_id_resolver.reset(); m_mod_id_resolver.reset();
setError(tr("Unable to resolve mod IDs:\n") + reason); setError(tr("Unable to resolve mod IDs:\n") + reason);

View File

@ -19,6 +19,7 @@ class FlameCreationTask final : public InstanceCreationTask {
bool abort() override; bool abort() override;
bool updateInstance() override;
bool createInstance() override; bool createInstance() override;
private slots: private slots:
@ -29,5 +30,9 @@ class FlameCreationTask final : public InstanceCreationTask {
QWidget* m_parent = nullptr; QWidget* m_parent = nullptr;
shared_qobject_ptr<Flame::FileResolvingTask> m_mod_id_resolver; shared_qobject_ptr<Flame::FileResolvingTask> m_mod_id_resolver;
NetJob::Ptr m_files_job; Flame::Manifest m_pack;
// Handle to allow aborting
NetJob* m_process_update_file_info_job = nullptr;
NetJob::Ptr m_files_job = nullptr;
}; };

View File

@ -29,21 +29,29 @@ static void loadMinecraftV1(Flame::Minecraft& m, QJsonObject& minecraft)
} }
} }
static void loadManifestV1(Flame::Manifest& m, QJsonObject& manifest) static void loadManifestV1(Flame::Manifest& pack, QJsonObject& manifest)
{ {
auto mc = Json::requireObject(manifest, "minecraft"); auto mc = Json::requireObject(manifest, "minecraft");
loadMinecraftV1(m.minecraft, mc);
m.name = Json::ensureString(manifest, QString("name"), "Unnamed"); loadMinecraftV1(pack.minecraft, mc);
m.version = Json::ensureString(manifest, QString("version"), QString());
m.author = Json::ensureString(manifest, QString("author"), "Anonymous"); pack.name = Json::ensureString(manifest, QString("name"), "Unnamed");
pack.version = Json::ensureString(manifest, QString("version"), QString());
pack.author = Json::ensureString(manifest, QString("author"), "Anonymous");
auto arr = Json::ensureArray(manifest, "files", QJsonArray()); auto arr = Json::ensureArray(manifest, "files", QJsonArray());
for (QJsonValueRef item : arr) { for (auto item : arr) {
auto obj = Json::requireObject(item); auto obj = Json::requireObject(item);
Flame::File file; Flame::File file;
loadFileV1(file, obj); loadFileV1(file, obj);
m.files.insert(file.fileId,file);
pack.files.insert(file.fileId,file);
} }
m.overrides = Json::ensureString(manifest, "overrides", "overrides");
pack.overrides = Json::ensureString(manifest, "overrides", "overrides");
pack.is_loaded = true;
} }
void Flame::loadManifest(Flame::Manifest& m, const QString& filepath) void Flame::loadManifest(Flame::Manifest& m, const QString& filepath)

View File

@ -35,11 +35,11 @@
#pragma once #pragma once
#include <QString>
#include <QVector>
#include <QMap>
#include <QUrl>
#include <QJsonObject> #include <QJsonObject>
#include <QMap>
#include <QString>
#include <QUrl>
#include <QVector>
namespace Flame namespace Flame
{ {
@ -97,6 +97,8 @@ struct Manifest
//File id -> File //File id -> File
QMap<int,Flame::File> files; QMap<int,Flame::File> files;
QString overrides; QString overrides;
bool is_loaded = false;
}; };
void loadManifest(Flame::Manifest & m, const QString &filepath); void loadManifest(Flame::Manifest & m, const QString &filepath);