Download game files during instance creation (#4944)

This commit is contained in:
Alexandru Ionut Tripon 2026-02-17 20:23:06 +00:00 committed by GitHub
commit 71abf3beec
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
22 changed files with 136 additions and 74 deletions

View file

@ -63,7 +63,7 @@ void DataMigrationTask::dryRunFinished()
void DataMigrationTask::dryRunAborted()
{
emitFailed(tr("Aborted"));
emitAborted();
}
void DataMigrationTask::copyFinished()
@ -81,5 +81,5 @@ void DataMigrationTask::copyFinished()
void DataMigrationTask::copyAborted()
{
emitFailed(tr("Aborted"));
emitAborted();
}

View file

@ -2,7 +2,23 @@
#include <QDebug>
#include <QFile>
#include "FileSystem.h"
#include "minecraft/MinecraftLoadAndCheck.h"
#include "tasks/SequentialTask.h"
bool InstanceCreationTask::abort()
{
if (!canAbort()) {
return false;
}
m_abort = true;
if (m_gameFilesTask) {
return m_gameFilesTask->abort();
}
return true;
}
void InstanceCreationTask::executeTask()
{
@ -19,7 +35,8 @@ void InstanceCreationTask::executeTask()
return;
}
if (!createInstance()) {
m_instance = createInstance();
if (!m_instance) {
if (m_abort)
return;
@ -61,6 +78,33 @@ void InstanceCreationTask::executeTask()
return;
}
}
if (!m_abort)
emitSucceeded();
if (!m_abort) {
setAbortable(true);
setAbortButtonText(tr("Skip"));
qDebug() << "Downloading game files";
auto updateTasks = m_instance->createUpdateTask();
if (updateTasks.isEmpty()) {
emitSucceeded();
return;
}
auto task = makeShared<SequentialTask>();
task->addTask(makeShared<MinecraftLoadAndCheck>(m_instance.get(), Net::Mode::Online));
for (const auto& t : updateTasks) {
task->addTask(t);
}
connect(task.get(), &Task::finished, this, [this, task] {
if (task->wasSuccessful() || m_abort) {
emitSucceeded();
} else {
emitFailed(tr("Could not download game files: %1").arg(task->failReason()));
}
});
propagateFromOther(task.get());
setDetails(tr("Downloading game files"));
m_gameFilesTask = task;
m_gameFilesTask->start();
}
}

View file

@ -2,6 +2,7 @@
#include "BaseVersion.h"
#include "InstanceTask.h"
#include "minecraft/MinecraftInstance.h"
class InstanceCreationTask : public InstanceTask {
Q_OBJECT
@ -9,6 +10,8 @@ class InstanceCreationTask : public InstanceTask {
InstanceCreationTask() = default;
virtual ~InstanceCreationTask() = default;
bool abort() override;
protected:
void executeTask() final override;
@ -27,9 +30,9 @@ class InstanceCreationTask : public InstanceTask {
/**
* Creates a new instance.
*
* Returns whether the instance creation was successful (true) or not (false).
* Returns the instance if it was created or nullptr otherwise.
*/
virtual bool createInstance() { return false; };
virtual std::unique_ptr<MinecraftInstance> createInstance() { return nullptr; }
QString getError() const { return m_error_message; }
@ -43,4 +46,6 @@ class InstanceCreationTask : public InstanceTask {
private:
QString m_error_message;
std::unique_ptr<MinecraftInstance> m_instance;
Task::Ptr m_gameFilesTask;
};

View file

@ -322,6 +322,7 @@ void InstanceImportTask::processFlame()
connect(inst_creation_task.get(), &Task::aborted, this, &InstanceImportTask::emitAborted);
connect(inst_creation_task.get(), &Task::abortStatusChanged, this, &Task::setAbortable);
connect(inst_creation_task.get(), &Task::abortButtonTextChanged, this, &Task::setAbortButtonText);
connect(inst_creation_task.get(), &Task::warningLogged, this, [this](const QString& line) { m_Warnings.append(line); });
@ -421,6 +422,7 @@ void InstanceImportTask::processModrinth()
connect(inst_creation_task.get(), &Task::aborted, this, &InstanceImportTask::emitAborted);
connect(inst_creation_task.get(), &Task::abortStatusChanged, this, &Task::setAbortable);
connect(inst_creation_task.get(), &Task::abortButtonTextChanged, this, &Task::setAbortButtonText);
connect(inst_creation_task.get(), &Task::warningLogged, this, [this](const QString& line) { m_Warnings.append(line); });

View file

@ -923,6 +923,7 @@ class InstanceStaging : public Task {
connect(child, &Task::failed, this, &InstanceStaging::childFailed);
connect(child, &Task::aborted, this, &InstanceStaging::childAborted);
connect(child, &Task::abortStatusChanged, this, &InstanceStaging::setAbortable);
connect(child, &Task::abortButtonTextChanged, this, &InstanceStaging::setAbortButtonText);
connect(child, &Task::status, this, &InstanceStaging::setStatus);
connect(child, &Task::details, this, &InstanceStaging::setDetails);
connect(child, &Task::progress, this, &InstanceStaging::setProgress);
@ -939,9 +940,7 @@ class InstanceStaging : public Task {
if (!canAbort())
return false;
m_child->abort();
return Task::abort();
return m_child->abort();
}
bool canAbort() const override { return (m_child && m_child->canAbort()); }

View file

@ -180,7 +180,7 @@ bool LaunchTask::abort()
return true;
case LaunchTask::NotStarted: {
state = LaunchTask::Aborted;
emitFailed("Aborted");
emitAborted();
return true;
}
case LaunchTask::Running:

View file

@ -38,7 +38,7 @@ void LookupServerAddress::setOutputAddressPtr(MinecraftTarget::Ptr output)
bool LookupServerAddress::abort()
{
m_dnsLookup->abort();
emitFailed("Aborted");
emitAborted();
return true;
}

View file

@ -24,6 +24,6 @@ bool TextPrint::canAbort() const
bool TextPrint::abort()
{
emitFailed("Aborted.");
emitAborted();
return true;
}

View file

@ -20,7 +20,7 @@ void MinecraftLoadAndCheck::executeTask()
}
connect(m_task.get(), &Task::succeeded, this, &MinecraftLoadAndCheck::emitSucceeded);
connect(m_task.get(), &Task::failed, this, &MinecraftLoadAndCheck::emitFailed);
connect(m_task.get(), &Task::aborted, this, [this] { emitFailed(tr("Aborted")); });
connect(m_task.get(), &Task::aborted, this, &MinecraftLoadAndCheck::emitAborted);
propagateFromOther(m_task.get());
}

View file

@ -15,22 +15,22 @@ VanillaCreationTask::VanillaCreationTask(BaseVersion::Ptr version, QString loade
, m_loader_version(std::move(loader_version))
{}
bool VanillaCreationTask::createInstance()
std::unique_ptr<MinecraftInstance> VanillaCreationTask::createInstance()
{
setStatus(tr("Creating instance from version %1").arg(m_version->name()));
MinecraftInstance inst(m_globalSettings, std::make_unique<INISettingsObject>(FS::PathCombine(m_stagingPath, "instance.cfg")),
auto inst = std::make_unique<MinecraftInstance>(m_globalSettings, std::make_unique<INISettingsObject>(FS::PathCombine(m_stagingPath, "instance.cfg")),
m_stagingPath);
SettingsObject::Lock lock(inst.settings());
SettingsObject::Lock lock(inst->settings());
auto components = inst.getPackProfile();
auto components = inst->getPackProfile();
components->buildingFromScratch();
components->setComponentVersion("net.minecraft", m_version->descriptor(), true);
if (m_using_loader)
components->setComponentVersion(m_loader, m_loader_version->descriptor());
inst.setName(name());
inst.setIconKey(m_instIcon);
inst->setName(name());
inst->setIconKey(m_instIcon);
return true;
return inst;
}

View file

@ -10,7 +10,7 @@ class VanillaCreationTask final : public InstanceCreationTask {
VanillaCreationTask(BaseVersion::Ptr version) : InstanceCreationTask(), m_version(std::move(version)) {}
VanillaCreationTask(BaseVersion::Ptr version, QString loader, BaseVersion::Ptr loader_version);
bool createInstance() override;
std::unique_ptr<MinecraftInstance> createInstance() override;
private:
// Version to update to / create of the instance.

View file

@ -244,7 +244,7 @@ bool AutoInstallJava::abort()
{
if (m_current_task && m_current_task->canAbort()) {
auto status = m_current_task->abort();
emitFailed("Aborted.");
emitAborted();
return status;
}
return Task::abort();

View file

@ -39,7 +39,7 @@ void AssetUpdateTask::executeTask()
connect(downloadJob.get(), &NetJob::succeeded, this, &AssetUpdateTask::assetIndexFinished);
connect(downloadJob.get(), &NetJob::failed, this, &AssetUpdateTask::assetIndexFailed);
connect(downloadJob.get(), &NetJob::aborted, this, [this] { emitFailed(tr("Aborted")); });
connect(downloadJob.get(), &NetJob::aborted, this, &AssetUpdateTask::emitAborted);
connect(downloadJob.get(), &NetJob::progress, this, &AssetUpdateTask::progress);
connect(downloadJob.get(), &NetJob::stepProgress, this, &AssetUpdateTask::propagateStepProgress);
@ -82,7 +82,7 @@ void AssetUpdateTask::assetIndexFinished()
downloadJob = job;
connect(downloadJob.get(), &NetJob::succeeded, this, &AssetUpdateTask::emitSucceeded);
connect(downloadJob.get(), &NetJob::failed, this, &AssetUpdateTask::assetsFailed);
connect(downloadJob.get(), &NetJob::aborted, this, [this] { emitFailed(tr("Aborted")); });
connect(downloadJob.get(), &NetJob::aborted, this, &AssetUpdateTask::emitAborted);
connect(downloadJob.get(), &NetJob::progress, this, &AssetUpdateTask::progress);
connect(downloadJob.get(), &NetJob::stepProgress, this, &AssetUpdateTask::propagateStepProgress);
downloadJob->start();

View file

@ -70,7 +70,7 @@ void LegacyFMLLibrariesTask::executeTask()
connect(dljob.get(), &NetJob::succeeded, this, &LegacyFMLLibrariesTask::fmllibsFinished);
connect(dljob.get(), &NetJob::failed, this, &LegacyFMLLibrariesTask::fmllibsFailed);
connect(dljob.get(), &NetJob::aborted, this, [this] { emitFailed(tr("Aborted")); });
connect(dljob.get(), &NetJob::aborted, this, &LegacyFMLLibrariesTask::emitAborted);
connect(dljob.get(), &NetJob::progress, this, &LegacyFMLLibrariesTask::progress);
connect(dljob.get(), &NetJob::stepProgress, this, &LegacyFMLLibrariesTask::propagateStepProgress);
downloadJob.reset(dljob);

View file

@ -64,7 +64,7 @@ void LibrariesTask::executeTask()
connect(downloadJob.get(), &NetJob::succeeded, this, &LibrariesTask::emitSucceeded);
connect(downloadJob.get(), &NetJob::failed, this, &LibrariesTask::jarlibFailed);
connect(downloadJob.get(), &NetJob::aborted, this, [this] { emitFailed(tr("Aborted")); });
connect(downloadJob.get(), &NetJob::aborted, this, &LibrariesTask::emitAborted);
connect(downloadJob.get(), &NetJob::progress, this, &LibrariesTask::progress);
connect(downloadJob.get(), &NetJob::stepProgress, this, &LibrariesTask::propagateStepProgress);

View file

@ -75,7 +75,6 @@ bool FlameCreationTask::abort()
if (!canAbort())
return false;
m_abort = true;
if (m_processUpdateFileInfoJob)
m_processUpdateFileInfoJob->abort();
if (m_filesJob)
@ -83,7 +82,7 @@ bool FlameCreationTask::abort()
if (m_modIdResolver)
m_modIdResolver->abort();
return Task::abort();
return InstanceCreationTask::abort();
}
bool FlameCreationTask::updateInstance()
@ -316,7 +315,7 @@ QString FlameCreationTask::getVersionForLoader(QString uid, QString loaderType,
return loaderVersion;
}
bool FlameCreationTask::createInstance()
std::unique_ptr<MinecraftInstance> FlameCreationTask::createInstance()
{
QEventLoop loop;
@ -334,7 +333,7 @@ bool FlameCreationTask::createInstance()
} catch (const JSONValidationError& e) {
setError(tr("Could not understand pack manifest:\n") + e.cause());
return false;
return nullptr;
}
if (!m_pack.overrides.isEmpty()) {
@ -346,7 +345,7 @@ bool FlameCreationTask::createInstance()
QString mcPath = FS::PathCombine(m_stagingPath, "minecraft");
if (!FS::move(overridePath, mcPath)) {
setError(tr("Could not rename the overrides folder:\n") + m_pack.overrides);
return false;
return nullptr;
}
} else {
logWarning(
@ -387,7 +386,7 @@ bool FlameCreationTask::createInstance()
QString configPath = FS::PathCombine(m_stagingPath, "instance.cfg");
auto instanceSettings = std::make_unique<INISettingsObject>(configPath);
MinecraftInstance instance(m_globalSettings, std::move(instanceSettings), m_stagingPath);
auto instance = std::make_unique<MinecraftInstance>(m_globalSettings, std::move(instanceSettings), m_stagingPath);
auto mcVersion = m_pack.minecraft.version;
// Hack to correct some 'special sauce'...
@ -397,25 +396,25 @@ bool FlameCreationTask::createInstance()
logWarning(tr("Mysterious trailing dots removed from Minecraft version while importing pack."));
}
auto components = instance.getPackProfile();
auto components = instance->getPackProfile();
components->buildingFromScratch();
components->setComponentVersion("net.minecraft", mcVersion, true);
if (!loaderType.isEmpty()) {
auto version = getVersionForLoader(loaderUid, loaderType, loaderVersion, mcVersion);
if (version.isEmpty())
return false;
return nullptr;
components->setComponentVersion(loaderUid, version);
}
if (m_instIcon != "default") {
instance.setIconKey(m_instIcon);
instance->setIconKey(m_instIcon);
} else {
if (m_pack.name.contains("Direwolf20")) {
instance.setIconKey("steve");
instance->setIconKey("steve");
} else if (m_pack.name.contains("FTB") || m_pack.name.contains("Feed The Beast")) {
instance.setIconKey("ftb_logo");
instance->setIconKey("ftb_logo");
} else {
instance.setIconKey("flame");
instance->setIconKey("flame");
}
}
@ -433,8 +432,8 @@ bool FlameCreationTask::createInstance()
recommendedRAM = max;
}
instance.settings()->set("OverrideMemory", true);
instance.settings()->set("MaxMemAlloc", recommendedRAM);
instance->settings()->set("OverrideMemory", true);
instance->settings()->set("MaxMemAlloc", recommendedRAM);
}
QString jarmodsPath = FS::PathCombine(m_stagingPath, "minecraft", "jarmods");
@ -448,7 +447,7 @@ bool FlameCreationTask::createInstance()
qDebug() << info.fileName();
jarMods.push_back(info.absoluteFilePath());
}
auto profile = instance.getPackProfile();
auto profile = instance->getPackProfile();
profile->installJarMods(jarMods);
// nuke the original files
FS::deletePath(jarmodsPath);
@ -456,11 +455,11 @@ bool FlameCreationTask::createInstance()
// Don't add managed info to packs without an ID (most likely imported from ZIP)
if (!m_managedId.isEmpty())
instance.setManagedPack("flame", m_managedId, m_pack.name, m_managedVersionId, m_pack.version);
instance->setManagedPack("flame", m_managedId, m_pack.name, m_managedVersionId, m_pack.version);
else
instance.setManagedPack("flame", "", name(), "", "");
instance->setManagedPack("flame", "", name(), "", "");
instance.setName(name());
instance->setName(name());
m_modIdResolver.reset(new Flame::FileResolvingTask(m_pack));
connect(m_modIdResolver.get(), &Flame::FileResolvingTask::succeeded, this, [this, &loop] { idResolverSucceeded(loop); });
@ -485,10 +484,13 @@ bool FlameCreationTask::createInstance()
setAbortable(false);
auto inst = m_instance.value();
inst->copyManagedPack(instance);
inst->copyManagedPack(*instance);
}
return did_succeed;
if (did_succeed) {
return instance;
}
return nullptr;
}
void FlameCreationTask::idResolverSucceeded(QEventLoop& loop)

View file

@ -68,7 +68,7 @@ class FlameCreationTask final : public InstanceCreationTask {
bool abort() override;
bool updateInstance() override;
bool createInstance() override;
std::unique_ptr<MinecraftInstance> createInstance() override;
private slots:
void idResolverSucceeded(QEventLoop&);

View file

@ -32,10 +32,9 @@ bool ModrinthCreationTask::abort()
if (!canAbort())
return false;
m_abort = true;
if (m_task)
m_task->abort();
return Task::abort();
return InstanceCreationTask::abort();
}
bool ModrinthCreationTask::updateInstance()
@ -169,7 +168,7 @@ bool ModrinthCreationTask::updateInstance()
}
// https://docs.modrinth.com/docs/modpacks/format_definition/
bool ModrinthCreationTask::createInstance()
std::unique_ptr<MinecraftInstance> ModrinthCreationTask::createInstance()
{
QEventLoop loop;
@ -177,7 +176,7 @@ bool ModrinthCreationTask::createInstance()
QString index_path = FS::PathCombine(m_stagingPath, "modrinth.index.json");
if (m_files.empty() && !parseManifest(index_path, m_files, true, true))
return false;
return nullptr;
// Keep index file in case we need it some other time (like when changing versions)
QString new_index_place(FS::PathCombine(parent_folder, "modrinth.index.json"));
@ -194,7 +193,7 @@ bool ModrinthCreationTask::createInstance()
// Apply the overrides
if (!FS::move(override_path, mcPath)) {
setError(tr("Could not rename the overrides folder:\n") + "overrides");
return false;
return nullptr;
}
}
@ -207,15 +206,15 @@ bool ModrinthCreationTask::createInstance()
// Apply the overrides
if (!FS::overrideFolder(mcPath, client_override_path)) {
setError(tr("Could not rename the client overrides folder:\n") + "client overrides");
return false;
return nullptr;
}
}
QString configPath = FS::PathCombine(m_stagingPath, "instance.cfg");
auto instanceSettings = std::make_unique<INISettingsObject>(configPath);
MinecraftInstance instance(m_globalSettings, std::move(instanceSettings), m_stagingPath);
auto instance = std::make_unique<MinecraftInstance>(m_globalSettings, std::move(instanceSettings), m_stagingPath);
auto components = instance.getPackProfile();
auto components = instance->getPackProfile();
components->buildingFromScratch();
components->setComponentVersion("net.minecraft", m_minecraft_version, true);
@ -229,19 +228,19 @@ bool ModrinthCreationTask::createInstance()
components->setComponentVersion("net.neoforged", m_neoForge_version);
if (m_instIcon != "default") {
instance.setIconKey(m_instIcon);
instance->setIconKey(m_instIcon);
} else if (!m_managed_id.isEmpty()) {
instance.setIconKey("modrinth");
instance->setIconKey("modrinth");
}
// Don't add managed info to packs without an ID (most likely imported from ZIP)
if (!m_managed_id.isEmpty())
instance.setManagedPack("modrinth", m_managed_id, m_managed_name, m_managed_version_id, version());
instance->setManagedPack("modrinth", m_managed_id, m_managed_name, m_managed_version_id, version());
else
instance.setManagedPack("modrinth", "", name(), "", "");
instance->setManagedPack("modrinth", "", name(), "", "");
instance.setName(name());
instance.saveNow();
instance->setName(name());
instance->saveNow();
auto downloadMods = makeShared<NetJob>(tr("Mod Download Modrinth"), APPLICATION->network());
@ -257,7 +256,7 @@ bool ModrinthCreationTask::createInstance()
// This means we somehow got out of the root folder, so abort here to prevent exploits
setError(tr("One of the files has a path that leads to an arbitrary location (%1). This is a security risk and isn't allowed.")
.arg(fileName));
return false;
return nullptr;
}
if (fileName.startsWith("mods/")) {
auto mod = new Mod(file_path);
@ -268,7 +267,7 @@ bool ModrinthCreationTask::createInstance()
}
if (file.downloads.empty()) {
setError(tr("The file '%1' is missing a download link. This is invalid in the pack format.").arg(fileName));
return false;
return nullptr;
}
qDebug() << "Will try to download" << file.downloads.front() << "to" << file_path;
auto dl = Net::ApiDownload::makeFile(file.downloads.dequeue(), file_path);
@ -312,11 +311,11 @@ bool ModrinthCreationTask::createInstance()
for (auto resource : resources) {
delete resource;
}
return ended_well;
return nullptr;
}
QEventLoop ensureMetaLoop;
QDir folder = FS::PathCombine(instance.modsRoot(), ".index");
QDir folder = FS::PathCombine(instance->modsRoot(), ".index");
auto ensureMetadataTask = makeShared<EnsureMetadataTask>(resources, folder, ModPlatform::ResourceProvider::MODRINTH);
connect(ensureMetadataTask.get(), &Task::succeeded, this, [&ended_well]() { ended_well = true; });
connect(ensureMetadataTask.get(), &Task::finished, &ensureMetaLoop, &QEventLoop::quit);
@ -343,15 +342,18 @@ bool ModrinthCreationTask::createInstance()
// Only change the name if it didn't use a custom name, so that the previous custom name
// is preserved, but if we're using the original one, we update the version string.
// NOTE: This needs to come before the copyManagedPack call!
if (inst->name().contains(inst->getManagedPackVersionName()) && inst->name() != instance.name()) {
if (askForChangingInstanceName(m_parent, inst->name(), instance.name()) == InstanceNameChange::ShouldChange)
inst->setName(instance.name());
if (inst->name().contains(inst->getManagedPackVersionName()) && inst->name() != instance->name()) {
if (askForChangingInstanceName(m_parent, inst->name(), instance->name()) == InstanceNameChange::ShouldChange)
inst->setName(instance->name());
}
inst->copyManagedPack(instance);
inst->copyManagedPack(*instance);
}
return ended_well;
if (ended_well) {
return instance;
}
return nullptr;
}
bool ModrinthCreationTask::parseManifest(const QString& index_path,

View file

@ -41,7 +41,7 @@ class ModrinthCreationTask final : public InstanceCreationTask {
bool abort() override;
bool updateInstance() override;
bool createInstance() override;
std::unique_ptr<MinecraftInstance> createInstance() override;
private:
bool parseManifest(const QString&, std::vector<File>&, bool set_internal_data = true, bool show_optional_dialog = true);

View file

@ -131,7 +131,7 @@ void Task::emitAborted()
return;
}
m_state = State::AbortedByUser;
m_failReason = "Aborted.";
m_failReason = tr("Aborted");
if (m_show_debug)
qCDebug(taskLogC) << "Task" << describe() << "aborted.";
emit aborted();

View file

@ -154,6 +154,8 @@ class Task : public QObject, public QRunnable {
//! Emitted when the canAbort() status has changed. */
void abortStatusChanged(bool can_abort);
void abortButtonTextChanged(QString text);
public slots:
// QRunnable's interface
void run() override { start(); }
@ -174,6 +176,11 @@ class Task : public QObject, public QRunnable {
emit abortStatusChanged(can_abort);
}
void setAbortButtonText(QString text)
{
emit abortButtonTextChanged(text);
}
protected:
//! The task subclass must implement this method. This method is called to start to run the task.
//! The task is not finished when this method returns. the subclass must manually call emitSucceeded() or emitFailed() instead.

View file

@ -152,6 +152,7 @@ int ProgressDialog::execWithTask(Task* task)
this->m_taskConnections.push_back(connect(task, &Task::progress, this, &ProgressDialog::changeProgress));
this->m_taskConnections.push_back(connect(task, &Task::aborted, this, &ProgressDialog::hide));
this->m_taskConnections.push_back(connect(task, &Task::abortStatusChanged, ui->skipButton, &QPushButton::setEnabled));
this->m_taskConnections.push_back(connect(task, &Task::abortButtonTextChanged, ui->skipButton, &QPushButton::setText));
m_is_multi_step = task->isMultiStep();
ui->taskProgressScrollArea->setHidden(!m_is_multi_step);