Sneederix/sneedmc
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #1477 from LennyMcLennington/cf-workarounds

Browse Source 
Curseforge workarounds and fixes
This commit is contained in:
LennyMcLennington 2022-10-25 02:02:18 +01:00 committed by GitHub
commit 46adfda5a6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
18 changed files with 261 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CMakeLists.txt
View File

@ -128,7 +128,8 @@ set(Launcher_MSA_CLIENT_ID "6b329578-bfec-42a3-b503-303ab3f2ac96" CACHE STRING "
# By using this key in your builds you accept the terms and conditions laid down in
# https://support.curseforge.com/en/support/solutions/articles/9000207405-curse-forge-3rd-party-api-terms-and-conditions
# NOTE: CurseForge requires you to change this if you make any kind of derivative work.
set(Launcher_CURSEFORGE_API_KEY "$2a$10$1Oqr2MX3O4n/ilhFGc597u8tfI3L2Hyr9/rtWDAMRjghSQV2QUuxq" CACHE STRING "API key for the CurseForge platform")
set(Launcher_CURSEFORGE_API_KEY "" CACHE STRING "API key for the CurseForge platform")
set(Launcher_CURSEFORGE_API_KEY_API_URL "https://fluchschmieden-entwickler-sind-alle.skids.lol/api" CACHE STRING "URL to fetch the Curseforge API key from.")
#### Check the current Git commit and branch

2
buildconfig/BuildConfig.cpp.in
View File

@ -2,6 +2,7 @@
/*
* PolyMC - Minecraft Launcher
* Copyright (C) 2022 Sefa Eyeoglu <contact@scrumplex.net>
* Copyright (C) 2022 Lenny McLennington <lenny@sneed.church>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@ -103,6 +104,7 @@ Config::Config()
IMGUR_CLIENT_ID = "@Launcher_IMGUR_CLIENT_ID@";
MSA_CLIENT_ID = "@Launcher_MSA_CLIENT_ID@";
FLAME_API_KEY = "@Launcher_CURSEFORGE_API_KEY@";
FLAME_API_KEY_API_URL = "@Launcher_CURSEFORGE_API_KEY_API_URL@";
META_URL = "@Launcher_META_URL@";
BUG_TRACKER_URL = "@Launcher_BUG_TRACKER_URL@";

6
buildconfig/BuildConfig.h
View File

@ -3,6 +3,7 @@
* PolyMC - Minecraft Launcher
* Copyright (c) 2022 Jamie Mansfield <jmansfield@cadixdev.org>
* Copyright (C) 2022 Sefa Eyeoglu <contact@scrumplex.net>
* Copyright (C) 2022 Lenny McLennington <lenny@sneed.church>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@ -125,6 +126,11 @@ class Config {
*/
QString FLAME_API_KEY;
/**
* URL to fetch the Client API key for CurseForge from
*/
QString FLAME_API_KEY_API_URL;
/**
* Metadata repository URL prefix
*/

30
launcher/Application.cpp
View File

@ -97,6 +97,8 @@
#include "icons/IconList.h"
#include "net/HttpMetaCache.h"
#include "ui/GuiUtil.h"
#include "java/JavaUtils.h"
#include "updater/UpdateChecker.h"
@ -668,6 +670,7 @@ Application::Application(int &argc, char **argv) : QApplication(argc, argv)
m_settings->set("FlameKeyOverride", flameKey);
m_settings->reset("CFKeyOverride");
}
m_settings->registerSetting("FlameKeyShouldBeFetchedOnStartup", true);
m_settings->registerSetting("UserAgentOverride", "");
// Init page provider
@ -949,6 +952,33 @@ void Application::setupWizardFinished(int status)
void Application::performMainStartupAction()
{
m_status = Application::Initialized;
{
bool shouldFetch = m_settings->get("FlameKeyShouldBeFetchedOnStartup").toBool();
if (shouldFetch && !(capabilities() & Capability::SupportsFlame))
{
auto response = QMessageBox::question(nullptr,
tr("Curseforge Core API Key"),
tr("Should PolyMC try to fetch the Official Curseforge Launcher's API Key? "
"Using this key technically breaks Curseforge's Terms of Service, but this distribution of PolyMC "
"does not come with a Curseforge API key by default, so without this key or another valid API key, "
"which you can always change in the settings, you won't be able to download Curseforge modpacks."),
QMessageBox::Yes | QMessageBox::No);
if (response == QMessageBox::Yes)
{
QString apiKey = GuiUtil::fetchFlameKey();
if (!apiKey.isEmpty())
{
m_settings->set("FlameKeyOverride", apiKey);
updateCapabilities();
}
}
m_settings->set("FlameKeyShouldBeFetchedOnStartup", false);
}
}
if(!m_instanceIdToLaunch.isEmpty())
{
auto inst = instances()->getInstanceById(m_instanceIdToLaunch);

2
launcher/CMakeLists.txt
View File

@ -103,6 +103,8 @@ set(NET_SOURCES
net/ChecksumValidator.h
net/Download.cpp
net/Download.h
net/FetchFlameAPIKey.cpp
net/FetchFlameAPIKey.h
net/FileSink.cpp
net/FileSink.h
net/HttpMetaCache.cpp

1
launcher/InstanceImportTask.h
View File

@ -85,7 +85,6 @@ private slots:
private: /* data */
NetJob::Ptr m_filesNetJob;
shared_qobject_ptr<Flame::FileResolvingTask> m_modIdResolver;
QUrl m_sourceUrl;
QString m_archivePath;
bool m_downloadRequired = false;

12
launcher/modplatform/flame/FileResolvingTask.cpp
View File

@ -41,7 +41,17 @@ void Flame::FileResolvingTask::netJobFinished()
// job to check modrinth for blocked projects
auto job = new NetJob("Modrinth check", m_network);
blockedProjects = QMap<File *,QByteArray *>();
auto doc = Json::requireDocument(*result);
QJsonDocument doc;
try {
doc = Json::requireDocument(*result);
}
catch (const JSONValidationError &e) {
qDebug() << "Flame::FileResolvingTask: Json Validation error: " << e.what();
emitFailed(e.what());
return;
}
auto array = Json::requireArray(doc.object()["data"]);
for (QJsonValueRef file : array) {
auto fileid = Json::requireInteger(Json::requireObject(file)["id"]);

3
launcher/modplatform/flame/FlameInstanceCreationTask.cpp
View File

@ -335,9 +335,10 @@ bool FlameCreationTask::createInstance()
m_mod_id_resolver = new Flame::FileResolvingTask(APPLICATION->network(), m_pack);
connect(m_mod_id_resolver.get(), &Flame::FileResolvingTask::succeeded, this, [this, &loop] { idResolverSucceeded(loop); });
connect(m_mod_id_resolver.get(), &Flame::FileResolvingTask::failed, [&](QString reason) {
connect(m_mod_id_resolver.get(), &Flame::FileResolvingTask::failed, [this, &loop](QString reason) {
m_mod_id_resolver.reset();
setError(tr("Unable to resolve mod IDs:\n") + reason);
loop.exit();
});
connect(m_mod_id_resolver.get(), &Flame::FileResolvingTask::progress, this, &FlameCreationTask::setProgress);
connect(m_mod_id_resolver.get(), &Flame::FileResolvingTask::status, this, &FlameCreationTask::setStatus);

6
launcher/net/Download.cpp
View File

@ -117,11 +117,13 @@ void Download::executeTask()
return;
}
request.setHeader(QNetworkRequest::UserAgentHeader, APPLICATION->getUserAgent().toUtf8());
if (APPLICATION->capabilities() & Application::SupportsFlame
&& request.url().host().contains("api.curseforge.com")) {
request.setRawHeader("x-api-key", APPLICATION->getFlameAPIKey().toUtf8());
};
}
else {
request.setHeader(QNetworkRequest::UserAgentHeader, APPLICATION->getUserAgent().toUtf8());
}
QNetworkReply* rep = m_network->get(request);

81
launcher/net/FetchFlameAPIKey.cpp Normal file
View File

@ -0,0 +1,81 @@
// SPDX-License-Identifier: GPL-3.0-only
/*
* PolyMC - Minecraft Launcher
* Copyright (C) 2022 Lenny McLennington <lenny@sneed.church>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, version 3.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#include "FetchFlameAPIKey.h"
#include "Application.h"
#include <BuildConfig.h>
#include <Json.h>
#include <ui/dialogs/ProgressDialog.h>
#include <ui/dialogs/CustomMessageBox.h>
FetchFlameAPIKey::FetchFlameAPIKey(QObject *parent)
: Task{parent}
{
}
void FetchFlameAPIKey::executeTask()
{
QNetworkRequest req(BuildConfig.FLAME_API_KEY_API_URL);
m_reply.reset(APPLICATION->network()->get(req));
connect(m_reply.get(), &QNetworkReply::downloadProgress, this, &Task::setProgress);
connect(m_reply.get(), &QNetworkReply::finished, this, &FetchFlameAPIKey::downloadFinished);
connect(m_reply.get(),
#if QT_VERSION >= QT_VERSION_CHECK(5, 15, 0)
&QNetworkReply::errorOccurred,
#else
qOverload<QNetworkReply::NetworkError>(&QNetworkReply::error),
#endif
this,
[this] (QNetworkReply::NetworkError error) {
qCritical() << "Network error: " << error;
emitFailed(m_reply->errorString());
});
setStatus(tr("Fetching Curseforge core API key"));
}
void FetchFlameAPIKey::downloadFinished()
{
auto res = m_reply->readAll();
auto doc = QJsonDocument::fromJson(res);
qDebug() << doc;
try {
auto obj = Json::requireObject(doc);
auto success = Json::requireBoolean(obj, "ok");
if (success)
{
m_result = Json::requireString(obj, "token");
emitSucceeded();
}
else
{
emitFailed("The API returned an output indicating failure.");
}
}
catch (Json::JsonException&)
{
qCritical() << "Output: " << res;
emitFailed("The API returned an unexpected JSON output.");
}
}

44
launcher/net/FetchFlameAPIKey.h Normal file
View File

@ -0,0 +1,44 @@
// SPDX-License-Identifier: GPL-3.0-only
/*
* PolyMC - Minecraft Launcher
* Copyright (C) 2022 Lenny McLennington <lenny@sneed.church>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, version 3.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#ifndef FETCHFLAMEAPIKEY_H
#define FETCHFLAMEAPIKEY_H
#include <QObject>
#include <QNetworkReply>
#include <tasks/Task.h>
class FetchFlameAPIKey : public Task
{
Q_OBJECT
public:
explicit FetchFlameAPIKey(QObject *parent = nullptr);
QString m_result;
public slots:
void downloadFinished();
protected:
virtual void executeTask();
std::shared_ptr<QNetworkReply> m_reply;
};
#endif // FETCHFLAMEAPIKEY_H

4
launcher/net/Upload.cpp
View File

@ -215,11 +215,13 @@ namespace Net {
return;
}
request.setHeader(QNetworkRequest::UserAgentHeader, APPLICATION->getUserAgent().toUtf8());
if (APPLICATION->capabilities() & Application::SupportsFlame
&& request.url().host().contains("api.curseforge.com")) {
request.setRawHeader("x-api-key", APPLICATION->getFlameAPIKey().toUtf8());
}
else {
request.setHeader(QNetworkRequest::UserAgentHeader, APPLICATION->getUserAgent().toUtf8());
}
//TODO other types of post requests ?
request.setHeader(QNetworkRequest::ContentTypeHeader, "application/json");
QNetworkReply* rep = m_network->post(request, m_post_data);

23
launcher/ui/GuiUtil.cpp
View File

@ -40,6 +40,7 @@
#include <QApplication>
#include <QFileDialog>
#include "net/FetchFlameAPIKey.h"
#include "ui/dialogs/ProgressDialog.h"
#include "ui/dialogs/CustomMessageBox.h"
#include "net/PasteUpload.h"
@ -49,6 +50,28 @@
#include <DesktopServices.h>
#include <BuildConfig.h>
QString GuiUtil::fetchFlameKey(QWidget *parentWidget)
{
ProgressDialog prog(parentWidget);
auto flameKeyTask = std::make_unique<FetchFlameAPIKey>();
prog.execWithTask(flameKeyTask.get());
if (!flameKeyTask->wasSuccessful())
{
auto message = QObject::tr("Fetching the Curseforge API key failed. Reason: %1").arg(flameKeyTask->failReason());
if (!(APPLICATION->capabilities() & Application::SupportsFlame))
{
message += "\n\n" + QObject::tr("Downloading Curseforge modpacks will not work unless you manually set a valid Curseforge Core API key in the settings.");
}
CustomMessageBox::selectable(parentWidget,
QObject::tr("Failed to fetch Curseforge API key."),
message, QMessageBox::Critical)->exec();
}
return flameKeyTask->m_result;
}
QString GuiUtil::uploadPaste(const QString &text, QWidget *parentWidget)
{
ProgressDialog dialog(parentWidget);

1
launcher/ui/GuiUtil.h
View File

@ -4,6 +4,7 @@
namespace GuiUtil
{
QString fetchFlameKey(QWidget *parentWidget = nullptr);
QString uploadPaste(const QString &text, QWidget *parentWidget);
void setClipboardText(const QString &text);
QStringList BrowseForFiles(QString context, QString caption, QString filter, QString defaultPath, QWidget *parentWidget);

15
launcher/ui/MainWindow.cpp
View File

@ -2,6 +2,7 @@
/*
* PolyMC - Minecraft Launcher
* Copyright (C) 2022 Sefa Eyeoglu <contact@scrumplex.net>
* Copyright (C) 2022 Lenny McLennington <lenny@sneed.church>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@ -1631,8 +1632,14 @@ InstanceView
void MainWindow::runModalTask(Task *task)
{
connect(task, &Task::failed, [this](QString reason)
ProgressDialog loadDialog(this);
connect(task, &Task::failed, [this, &loadDialog](QString reason)
{
// FIXME:
// HACK: I don't know why calling show() on this CustomMessageBox causes loadDialog to not close,
// but this forces it to close BEFORE the CustomMessageBox gets opened... I think this is a bad fix
loadDialog.close();
CustomMessageBox::selectable(this, tr("Error"), reason, QMessageBox::Critical)->show();
});
connect(task, &Task::succeeded, [this, task]()
@ -1643,13 +1650,15 @@ void MainWindow::runModalTask(Task *task)
CustomMessageBox::selectable(this, tr("Warnings"), warnings.join('\n'), QMessageBox::Warning)->show();
}
});
connect(task, &Task::aborted, [this]
connect(task, &Task::aborted, [this, &loadDialog]
{
// HACK: Same bad hack as above slot for Task::failed
loadDialog.close();
CustomMessageBox::selectable(this, tr("Task aborted"), tr("The task has been aborted by the user."), QMessageBox::Information)->show();
});
ProgressDialog loadDialog(this);
loadDialog.setSkipButton(true, tr("Abort"));
loadDialog.execWithTask(task);
qDebug() << "MainWindow::runModalTask: execWithTask exited properly";
}
void MainWindow::instanceFromInstanceTask(InstanceTask *rawTask)

14
launcher/ui/pages/global/APIPage.cpp
View File

@ -52,6 +52,8 @@
#include "net/PasteUpload.h"
#include "BuildConfig.h"
#include "ui/GuiUtil.h"
APIPage::APIPage(QWidget *parent) :
QWidget(parent),
ui(new Ui::APIPage)
@ -92,6 +94,8 @@ APIPage::APIPage(QWidget *parent) :
resetBaseURLNote();
connect(ui->pasteTypeComboBox, currentIndexChangedSignal, this, &APIPage::updateBaseURLNote);
connect(ui->baseURLEntry, &QLineEdit::textEdited, this, &APIPage::resetBaseURLNote);
connect(ui->fetchKeyButton, &QPushButton::clicked, this, &APIPage::fetchKeyButtonPressed);
}
APIPage::~APIPage()
@ -178,6 +182,16 @@ void APIPage::applySettings()
QString flameKey = ui->flameKey->text();
s->set("FlameKeyOverride", flameKey);
s->set("UserAgentOverride", ui->userAgentLineEdit->text());
APPLICATION->updateCapabilities();
}
void APIPage::fetchKeyButtonPressed()
{
QString apiKey = GuiUtil::fetchFlameKey(parentWidget());
if (!apiKey.isEmpty())
ui->flameKey->setText(apiKey);
}
bool APIPage::apply()

1
launcher/ui/pages/global/APIPage.h
View File

@ -80,6 +80,7 @@ private:
void updateBaseURLPlaceholder(int index);
void loadSettings();
void applySettings();
void fetchKeyButtonPressed();
private:
Ui::APIPage *ui;

30
launcher/ui/pages/global/APIPage.ui
View File

@ -204,13 +204,6 @@
<string>&amp;CurseForge Core API</string>
</property>
<layout class="QGridLayout" name="gridLayout">
<item row="0" column="0">
<widget class="QLabel" name="label_8">
<property name="text">
<string>Note: you probably don't need to set this if CurseForge already works.</string>
</property>
</widget>
</item>
<item row="2" column="0">
<widget class="QLabel" name="label_7">
<property name="text">
@ -237,6 +230,29 @@
</property>
</widget>
</item>
<item row="1" column="1">
<widget class="QPushButton" name="fetchKeyButton">
<property name="text">
<string>Fetch Official Launcher's Key</string>
</property>
</widget>
</item>
<item row="0" column="0" colspan="2">
<widget class="QLabel" name="label_8">
<property name="sizePolicy">
<sizepolicy hsizetype="Preferred" vsizetype="Preferred">
<horstretch>0</horstretch>
<verstretch>0</verstretch>
</sizepolicy>
</property>
<property name="text">
<string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;Note: you probably don't need to set this if CurseForge already works.&lt;/p&gt;&lt;p&gt;&lt;span style=&quot; font-weight:700;&quot;&gt;Using the Official Curseforge Launcher's key may break Curseforge's Terms of service, but should allow PolyMC to download all mods in a modpack without you needing to download any of them manually.&lt;/span&gt;&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
</property>
<property name="wordWrap">
<bool>true</bool>
</property>
</widget>
</item>
</layout>
</widget>
</item>