Improvements and refinements to pack export

- Persist fields - Toggle optional files Signed-off-by: TheKodeToad <TheKodeToad@proton.me>
2023-08-12 21:18:22 +01:00 · 2023-08-12 21:18:22 +01:00 · 5056a51c18
commit 5056a51c18
parent 3aba7f8fec
7 changed files with 129 additions and 66 deletions
--- a/launcher/minecraft/MinecraftInstance.cpp
+++ b/launcher/minecraft/MinecraftInstance.cpp
@ -194,6 +194,12 @@ void MinecraftInstance::loadSpecificSettings()
    m_settings->registerSetting("UseAccountForInstance", false);
    m_settings->registerSetting("InstanceAccountId", "");

+    m_settings->registerSetting("ExportName", "");
+    m_settings->registerSetting("ExportVersion", "1.0.0");
+    m_settings->registerSetting("ExportSummary", "");
+    m_settings->registerSetting("ExportAuthor", "");
+    m_settings->registerSetting("ExportOptionalFiles", true);
+
    qDebug() << "Instance-type specific settings were loaded!";

    setSpecificSettingsLoaded(true);
--- a/launcher/modplatform/flame/FlamePackExportTask.cpp
+++ b/launcher/modplatform/flame/FlamePackExportTask.cpp
@ -43,12 +43,14 @@ const QStringList FlamePackExportTask::FILE_EXTENSIONS({ "jar", "zip" });
 FlamePackExportTask::FlamePackExportTask(const QString& name,
                                         const QString& version,
                                         const QString& author,
+                                         bool optionalFiles,
                                         InstancePtr instance,
                                         const QString& output,
                                         MMCZip::FilterFunction filter)
    : name(name)
    , version(version)
    , author(author)
+    , optionalFiles(optionalFiles)
    , instance(instance)
    , mcInstance(dynamic_cast<MinecraftInstance*>(instance.get()))
    , gameRoot(instance->gameRoot())
@ -407,7 +409,7 @@ QByteArray FlamePackExportTask::generateIndex()
        QJsonObject file;
        file["projectID"] = mod.addonId;
        file["fileID"] = mod.version;
-        file["required"] = mod.enabled;
+        file["required"] = mod.enabled || !optionalFiles;
        files << file;
    }
    obj["files"] = files;
--- a/launcher/modplatform/flame/FlamePackExportTask.h
+++ b/launcher/modplatform/flame/FlamePackExportTask.h
@ -30,6 +30,7 @@ class FlamePackExportTask : public Task {
    FlamePackExportTask(const QString& name,
                        const QString& version,
                        const QString& author,
+                        bool optionalFiles,
                        InstancePtr instance,
                        const QString& output,
                        MMCZip::FilterFunction filter);
@ -44,6 +45,7 @@ class FlamePackExportTask : public Task {

    // inputs
    const QString name, version, author;
+    const bool optionalFiles;
    const InstancePtr instance;
    MinecraftInstance* mcInstance;
    const QDir gameRoot;
--- a/launcher/modplatform/modrinth/ModrinthPackExportTask.cpp
+++ b/launcher/modplatform/modrinth/ModrinthPackExportTask.cpp
@ -33,12 +33,14 @@ const QStringList ModrinthPackExportTask::FILE_EXTENSIONS({ "jar", "litemod", "z
 ModrinthPackExportTask::ModrinthPackExportTask(const QString& name,
                                               const QString& version,
                                               const QString& summary,
+                                               bool optionalFiles,
                                               InstancePtr instance,
                                               const QString& output,
                                               MMCZip::FilterFunction filter)
    : name(name)
    , version(version)
    , summary(summary)
+    , optionalFiles(optionalFiles)
    , instance(instance)
    , mcInstance(dynamic_cast<MinecraftInstance*>(instance.get()))
    , gameRoot(instance->gameRoot())
@ -267,16 +269,18 @@ QByteArray ModrinthPackExportTask::generateIndex()
        QString path = iterator.key();
        const ResolvedFile& value = iterator.value();

-        // detect disabled mod
-        const QFileInfo pathInfo(path);
-        if (pathInfo.suffix() == "disabled") {
-            // rename it
-            path = pathInfo.dir().filePath(pathInfo.completeBaseName());
-            // ...and make it optional
-            QJsonObject env;
-            env["client"] = "optional";
-            env["server"] = "optional";
-            fileOut["env"] = env;
+        if (optionalFiles) {
+            // detect disabled mod
+            const QFileInfo pathInfo(path);
+            if (pathInfo.suffix() == "disabled") {
+                // rename it
+                path = pathInfo.dir().filePath(pathInfo.completeBaseName());
+                // ...and make it optional
+                QJsonObject env;
+                env["client"] = "optional";
+                env["server"] = "optional";
+                fileOut["env"] = env;
+            }
        }

        fileOut["path"] = path;
--- a/launcher/modplatform/modrinth/ModrinthPackExportTask.h
+++ b/launcher/modplatform/modrinth/ModrinthPackExportTask.h
@ -31,6 +31,7 @@ class ModrinthPackExportTask : public Task {
    ModrinthPackExportTask(const QString& name,
                           const QString& version,
                           const QString& summary,
+                           bool optionalFiles,
                           InstancePtr instance,
                           const QString& output,
                           MMCZip::FilterFunction filter);
@ -50,6 +51,7 @@ class ModrinthPackExportTask : public Task {

    // inputs
    const QString name, version, summary;
+    const bool optionalFiles;
    const InstancePtr instance;
    MinecraftInstance* mcInstance;
    const QDir gameRoot;
--- a/launcher/ui/dialogs/ExportPackDialog.cpp
+++ b/launcher/ui/dialogs/ExportPackDialog.cpp
@ -37,15 +37,21 @@
 ExportPackDialog::ExportPackDialog(InstancePtr instance, QWidget* parent, ModPlatform::ResourceProvider provider)
    : QDialog(parent), instance(instance), ui(new Ui::ExportPackDialog), m_provider(provider)
 {
+    Q_ASSERT(m_provider == ModPlatform::ResourceProvider::MODRINTH || m_provider == ModPlatform::ResourceProvider::FLAME);
+
    ui->setupUi(this);
-    ui->name->setText(instance->name());
+    ui->name->setPlaceholderText(instance->name());
+    ui->name->setText(instance->settings()->get("ExportName").toString());
+    ui->version->setText(instance->settings()->get("ExportVersion").toString());
+    ui->optionalFiles->setChecked(instance->settings()->get("ExportOptionalFiles").toBool());
+
    if (m_provider == ModPlatform::ResourceProvider::MODRINTH) {
-        ui->summary->setText(instance->notes().split(QRegularExpression("\\r?\\n"))[0]);
-        setWindowTitle("Export Modrinth Pack");
+        setWindowTitle(tr("Export Modrinth Pack"));
+        ui->summary->setText(instance->settings()->get("ExportSummary").toString());
    } else {
-        setWindowTitle("Export CurseForge Pack");
-        ui->version->setText("");
-        ui->summaryLabel->setText("Author");
+        setWindowTitle(tr("Export CurseForge Pack"));
+        ui->summaryLabel->setText(tr("&Author"));
+        ui->summary->setText(instance->settings()->get("ExportAuthor").toString());
    }

    // ensure a valid pack is generated
@ -81,14 +87,14 @@ ExportPackDialog::ExportPackDialog(InstancePtr instance, QWidget* parent, ModPla
            proxy->blockedPaths().insert(root.relativeFilePath(index.absolutePath()));
    }

-    ui->treeView->setModel(proxy);
-    ui->treeView->setRootIndex(proxy->mapFromSource(model->index(instance->gameRoot())));
-    ui->treeView->sortByColumn(0, Qt::AscendingOrder);
+    ui->files->setModel(proxy);
+    ui->files->setRootIndex(proxy->mapFromSource(model->index(instance->gameRoot())));
+    ui->files->sortByColumn(0, Qt::AscendingOrder);

    model->setFilter(filter);
    model->setRootPath(instance->gameRoot());

-    QHeaderView* headerView = ui->treeView->header();
+    QHeaderView* headerView = ui->files->header();
    headerView->setSectionResizeMode(QHeaderView::ResizeToContents);
    headerView->setSectionResizeMode(0, QHeaderView::Stretch);
 }
@ -100,26 +106,40 @@ ExportPackDialog::~ExportPackDialog()

 void ExportPackDialog::done(int result)
 {
+    auto settings = instance->settings();
+    settings->set("ExportName", ui->name->text());
+    settings->set("ExportVersion", ui->version->text());
+    settings->set(m_provider == ModPlatform::ResourceProvider::FLAME ? "ExportAuthor" : "ExportSummary", ui->summary->text());
+    settings->set("ExportOptionalFiles", ui->optionalFiles->isChecked());
+
    if (result == Accepted) {
-        const QString filename = FS::RemoveInvalidFilenameChars(ui->name->text());
+        const QString name = ui->name->text().isEmpty() ? instance->name() : ui->name->text();
+        const QString filename = FS::RemoveInvalidFilenameChars(name);
+
        QString output;
-        if (m_provider == ModPlatform::ResourceProvider::MODRINTH)
-            output = QFileDialog::getSaveFileName(this, tr("Export %1").arg(ui->name->text()),
-                                                  FS::PathCombine(QDir::homePath(), filename + ".mrpack"), "Modrinth pack (*.mrpack *.zip)",
-                                                  nullptr);
-        else
-            output = QFileDialog::getSaveFileName(this, tr("Export %1").arg(ui->name->text()),
-                                                  FS::PathCombine(QDir::homePath(), filename + ".zip"), "CurseForge pack (*.zip)", nullptr);
+        if (m_provider == ModPlatform::ResourceProvider::MODRINTH) {
+            output = QFileDialog::getSaveFileName(this, tr("Export %1").arg(name), FS::PathCombine(QDir::homePath(), filename + ".mrpack"),
+                                                  "Modrinth pack (*.mrpack *.zip)", nullptr);
+            if (!(output.endsWith(".zip") || output.endsWith(".mrpack")))
+                output.append(".mrpack");
+        } else {
+            output = QFileDialog::getSaveFileName(this, tr("Export %1").arg(name), FS::PathCombine(QDir::homePath(), filename + ".zip"),
+                                                  "CurseForge pack (*.zip)", nullptr);
+            if (!output.endsWith(".zip"))
+                output.append(".zip");
+        }

        if (output.isEmpty())
            return;
+
        Task* task;
-        if (m_provider == ModPlatform::ResourceProvider::MODRINTH)
-            task = new ModrinthPackExportTask(ui->name->text(), ui->version->text(), ui->summary->text(), instance, output,
-                                              std::bind(&FileIgnoreProxy::filterFile, proxy, std::placeholders::_1));
-        else
-            task = new FlamePackExportTask(ui->name->text(), ui->version->text(), ui->summary->text(), instance, output,
+        if (m_provider == ModPlatform::ResourceProvider::MODRINTH) {
+            task = new ModrinthPackExportTask(name, ui->version->text(), ui->summary->text(), ui->optionalFiles->isChecked(), instance,
+                                              output, std::bind(&FileIgnoreProxy::filterFile, proxy, std::placeholders::_1));
+        } else {
+            task = new FlamePackExportTask(name, ui->version->text(), ui->summary->text(), ui->optionalFiles->isChecked(), instance, output,
                                           std::bind(&FileIgnoreProxy::filterFile, proxy, std::placeholders::_1));
+        }

        connect(task, &Task::failed,
                [this](const QString reason) { CustomMessageBox::selectable(this, tr("Error"), reason, QMessageBox::Critical)->show(); });
@ -140,7 +160,6 @@ void ExportPackDialog::done(int result)

 void ExportPackDialog::validate()
 {
-    const bool invalid =
-        ui->name->text().isEmpty() || ((m_provider == ModPlatform::ResourceProvider::MODRINTH) && ui->version->text().isEmpty());
-    ui->buttonBox->button(QDialogButtonBox::Ok)->setDisabled(invalid);
+    ui->buttonBox->button(QDialogButtonBox::Ok)
+        ->setDisabled(m_provider == ModPlatform::ResourceProvider::MODRINTH && ui->version->text().isEmpty());
 }
--- a/launcher/ui/dialogs/ExportPackDialog.ui
+++ b/launcher/ui/dialogs/ExportPackDialog.ui
@ -7,12 +7,9 @@
    <x>0</x>
    <y>0</y>
    <width>650</width>
-    <height>413</height>
+    <height>510</height>
   </rect>
  </property>
-  <property name="windowTitle">
-   <string>Export Pack</string>
-  </property>
  <property name="sizeGripEnabled">
   <bool>true</bool>
  </property>
@ -20,13 +17,16 @@
   <item>
    <widget class="QGroupBox" name="information">
     <property name="title">
-      <string>Information</string>
+      <string>&amp;Description</string>
     </property>
     <layout class="QGridLayout" name="gridLayout">
      <item row="3" column="0">
       <widget class="QLabel" name="summaryLabel">
        <property name="text">
-         <string>Summary</string>
+         <string>&amp;Summary</string>
+        </property>
+        <property name="buddy">
+         <cstring>summary</cstring>
        </property>
       </widget>
      </item>
@ -36,14 +36,20 @@
      <item row="0" column="0">
       <widget class="QLabel" name="nameLabel">
        <property name="text">
-         <string>Name</string>
+         <string>&amp;Name</string>
+        </property>
+        <property name="buddy">
+         <cstring>name</cstring>
        </property>
       </widget>
      </item>
      <item row="1" column="0">
       <widget class="QLabel" name="versionLabel">
        <property name="text">
-         <string>Version</string>
+         <string>&amp;Version</string>
+        </property>
+        <property name="buddy">
+         <cstring>version</cstring>
        </property>
       </widget>
      </item>
@ -57,31 +63,52 @@
        </property>
       </widget>
      </item>
-     
     </layout>
    </widget>
   </item>
   <item>
-    <widget class="QLabel" name="filesLabel">
-     <property name="text">
-      <string>Files</string>
+    <widget class="QGroupBox" name="options">
+     <property name="title">
+      <string>&amp;Options</string>
     </property>
-    </widget>
-   </item>
-   <item>
-    <widget class="QTreeView" name="treeView">
-     <property name="alternatingRowColors">
-      <bool>true</bool>
-     </property>
-     <property name="selectionMode">
-      <enum>QAbstractItemView::ExtendedSelection</enum>
-     </property>
-     <property name="sortingEnabled">
-      <bool>true</bool>
-     </property>
-     <attribute name="headerStretchLastSection">
-      <bool>false</bool>
-     </attribute>
+     <layout class="QVBoxLayout" name="verticalLayout">
+      <item>
+       <widget class="QLabel" name="filesLabel">
+        <property name="text">
+         <string>&amp;Files</string>
+        </property>
+        <property name="buddy">
+         <cstring>files</cstring>
+        </property>
+       </widget>
+      </item>
+      <item>
+       <widget class="QTreeView" name="files">
+        <property name="alternatingRowColors">
+         <bool>true</bool>
+        </property>
+        <property name="selectionMode">
+         <enum>QAbstractItemView::ExtendedSelection</enum>
+        </property>
+        <property name="sortingEnabled">
+         <bool>true</bool>
+        </property>
+        <attribute name="headerStretchLastSection">
+         <bool>false</bool>
+        </attribute>
+       </widget>
+      </item>
+      <item>
+       <widget class="QCheckBox" name="optionalFiles">
+        <property name="text">
+         <string>&amp;Mark disabled files as optional</string>
+        </property>
+        <property name="checked">
+         <bool>true</bool>
+        </property>
+       </widget>
+      </item>
+     </layout>
    </widget>
   </item>
   <item>
@ -97,7 +124,8 @@
  <tabstop>name</tabstop>
  <tabstop>version</tabstop>
  <tabstop>summary</tabstop>
-  <tabstop>treeView</tabstop>
+  <tabstop>files</tabstop>
+  <tabstop>optionalFiles</tabstop>
 </tabstops>
 <resources/>
 <connections>