feat: add initial support for parseing datapacks

Signed-off-by: Rachel Powers <508861+Ryex@users.noreply.github.com>

launcher/minecraft/mod/tasks/LocalDataPackParseTask.cpp

@@ -0,0 +1,169 @@
+// SPDX-FileCopyrightText: 2022 Rachel Powers <508861+Ryex@users.noreply.github.com>
+//
+// SPDX-License-Identifier: GPL-3.0-only
+
+/*
+ *  Prism Launcher - Minecraft Launcher
+ *  Copyright (C) 2022 Rachel Powers <508861+Ryex@users.noreply.github.com>
+ *
+ *  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 "LocalDataPackParseTask.h"
+
+#include "FileSystem.h"
+#include "Json.h"
+
+#include <quazip/quazip.h>
+#include <quazip/quazipfile.h>
+#include <quazip/quazipdir.h>
+
+#include <QCryptographicHash>
+
+namespace DataPackUtils {
+
+bool process(DataPack& pack, ProcessingLevel level)
+{
+    switch (pack.type()) {
+        case ResourceType::FOLDER:
+            return DataPackUtils::processFolder(pack, level);
+        case ResourceType::ZIPFILE:
+            return DataPackUtils::processZIP(pack, level);
+        default:
+            qWarning() << "Invalid type for resource pack parse task!";
+            return false;
+    }
+}
+
+bool processFolder(DataPack& pack, ProcessingLevel level)
+{
+    Q_ASSERT(pack.type() == ResourceType::FOLDER);
+
+    QFileInfo mcmeta_file_info(FS::PathCombine(pack.fileinfo().filePath(), "pack.mcmeta"));
+    if (mcmeta_file_info.exists() && mcmeta_file_info.isFile()) {
+        QFile mcmeta_file(mcmeta_file_info.filePath());
+        if (!mcmeta_file.open(QIODevice::ReadOnly))
+            return false; // can't open mcmeta file
+
+        auto data = mcmeta_file.readAll();
+
+        bool mcmeta_result = DataPackUtils::processMCMeta(pack, std::move(data));
+
+        mcmeta_file.close();
+        if (!mcmeta_result) {
+            return false; // mcmeta invalid
+        }
+    } else {
+        return false; // mcmeta file isn't a valid file
+    }
+
+    QFileInfo data_dir_info(FS::PathCombine(pack.fileinfo().filePath(), "data"));
+    if (!data_dir_info.exists() || !data_dir_info.isDir()) {
+        return false; // data dir does not exists or isn't valid
+    }
+
+    if (level == ProcessingLevel::BasicInfoOnly) {
+        return true; // only need basic info already checked
+    }
+
+    return true; // all tests passed
+}
+
+bool processZIP(DataPack& pack, ProcessingLevel level)
+{
+    Q_ASSERT(pack.type() == ResourceType::ZIPFILE);
+
+    QuaZip zip(pack.fileinfo().filePath());
+    if (!zip.open(QuaZip::mdUnzip))
+        return false; // can't open zip file
+
+    QuaZipFile file(&zip);
+
+    if (zip.setCurrentFile("pack.mcmeta")) {
+        if (!file.open(QIODevice::ReadOnly)) {
+            qCritical() << "Failed to open file in zip.";
+            zip.close();
+            return false;
+        }
+
+        auto data = file.readAll();
+
+        bool mcmeta_result = DataPackUtils::processMCMeta(pack, std::move(data));
+
+        file.close();
+        if (!mcmeta_result) {
+            return false; // mcmeta invalid
+        }
+    } else {
+        return false; // could not set pack.mcmeta as current file.
+    }
+
+    QuaZipDir zipDir(&zip);
+    if (!zipDir.exists("/data")) {
+        return false; // data dir does not exists at zip root
+    }
+
+    if (level == ProcessingLevel::BasicInfoOnly) {
+        zip.close();
+        return true; // only need basic info already checked
+    }
+
+    zip.close();
+
+    return true;
+}
+
+// https://minecraft.fandom.com/wiki/Tutorials/Creating_a_resource_pack#Formatting_pack.mcmeta
+bool processMCMeta(DataPack& pack, QByteArray&& raw_data)
+{
+    try {
+        auto json_doc = QJsonDocument::fromJson(raw_data);
+        auto pack_obj = Json::requireObject(json_doc.object(), "pack", {});
+
+        pack.setPackFormat(Json::ensureInteger(pack_obj, "pack_format", 0));
+        pack.setDescription(Json::ensureString(pack_obj, "description", ""));
+    } catch (Json::JsonException& e) {
+        qWarning() << "JsonException: " << e.what() << e.cause();
+        return false;
+    }
+    return true;
+}
+
+bool validate(QFileInfo file)
+{
+    DataPack dp{ file };
+    return DataPackUtils::process(dp, ProcessingLevel::BasicInfoOnly) && dp.valid();
+}
+
+}  // namespace DataPackUtils
+
+LocalDataPackParseTask::LocalDataPackParseTask(int token, DataPack& dp)
+    : Task(nullptr, false), m_token(token), m_resource_pack(dp)
+{}
+
+bool LocalDataPackParseTask::abort()
+{
+    m_aborted = true;
+    return true;
+}
+
+void LocalDataPackParseTask::executeTask()
+{
+    if (!DataPackUtils::process(m_resource_pack))
+        return;
+
+    if (m_aborted)
+        emitAborted();
+    else
+        emitSucceeded();
+}

launcher/minecraft/mod/tasks/LocalDataPackParseTask.h

@@ -0,0 +1,64 @@
+// SPDX-FileCopyrightText: 2022 Rachel Powers <508861+Ryex@users.noreply.github.com>
+//
+// SPDX-License-Identifier: GPL-3.0-only
+
+/*
+ *  Prism Launcher - Minecraft Launcher
+ *  Copyright (C) 2022 Rachel Powers <508861+Ryex@users.noreply.github.com>
+ *
+ *  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/>.
+ */
+
+#pragma once
+
+#include <QDebug>
+#include <QObject>
+
+#include "minecraft/mod/DataPack.h"
+
+#include "tasks/Task.h"
+
+namespace DataPackUtils {
+
+enum class ProcessingLevel { Full, BasicInfoOnly };
+
+bool process(DataPack& pack, ProcessingLevel level = ProcessingLevel::Full);
+
+bool processZIP(DataPack& pack, ProcessingLevel level = ProcessingLevel::Full);
+bool processFolder(DataPack& pack, ProcessingLevel level = ProcessingLevel::Full);
+
+bool processMCMeta(DataPack& pack, QByteArray&& raw_data);
+
+/** Checks whether a file is valid as a resource pack or not. */
+bool validate(QFileInfo file);
+}  // namespace ResourcePackUtils
+
+class LocalDataPackParseTask : public Task {
+    Q_OBJECT
+   public:
+    LocalDataPackParseTask(int token, DataPack& rp);
+
+    [[nodiscard]] bool canAbort() const override { return true; }
+    bool abort() override;
+
+    void executeTask() override;
+
+    [[nodiscard]] int token() const { return m_token; }
+
+   private:
+    int m_token;
+
+    DataPack& m_resource_pack;
+
+    bool m_aborted = false;
+};

launcher/minecraft/mod/tasks/LocalResourcePackParseTask.cpp

@@ -23,6 +23,7 @@
 
 #include <quazip/quazip.h>
 #include <quazip/quazipfile.h>
+#include <quazip/quazipdir.h>
 
 #include <QCryptographicHash>
 
@@ -32,58 +33,74 @@ bool process(ResourcePack& pack, ProcessingLevel level)
 {
     switch (pack.type()) {
         case ResourceType::FOLDER:
-            ResourcePackUtils::processFolder(pack, level);
-            return true;
+            return ResourcePackUtils::processFolder(pack, level);
         case ResourceType::ZIPFILE:
-            ResourcePackUtils::processZIP(pack, level);
-            return true;
+            return ResourcePackUtils::processZIP(pack, level);
         default:
             qWarning() << "Invalid type for resource pack parse task!";
             return false;
     }
 }
 
-void processFolder(ResourcePack& pack, ProcessingLevel level)
+bool processFolder(ResourcePack& pack, ProcessingLevel level)
 {
     Q_ASSERT(pack.type() == ResourceType::FOLDER);
 
     QFileInfo mcmeta_file_info(FS::PathCombine(pack.fileinfo().filePath(), "pack.mcmeta"));
-    if (mcmeta_file_info.isFile()) {
+    if (mcmeta_file_info.exists() && mcmeta_file_info.isFile()) {
         QFile mcmeta_file(mcmeta_file_info.filePath());
         if (!mcmeta_file.open(QIODevice::ReadOnly))
-            return;
+            return false; // can't open mcmeta file
 
         auto data = mcmeta_file.readAll();
 
-        ResourcePackUtils::processMCMeta(pack, std::move(data));
+        bool mcmeta_result = ResourcePackUtils::processMCMeta(pack, std::move(data));
 
         mcmeta_file.close();
+        if (!mcmeta_result) {
+            return false; // mcmeta invalid
+        }
+    } else {
+        return false; // mcmeta file isn't a valid file
     }
 
-    if (level == ProcessingLevel::BasicInfoOnly)
-        return;
+    QFileInfo assets_dir_info(FS::PathCombine(pack.fileinfo().filePath(), "assets"));
+    if (!assets_dir_info.exists() || !assets_dir_info.isDir()) {
+        return false; // assets dir does not exists or isn't valid
+    }
 
+    if (level == ProcessingLevel::BasicInfoOnly) {
+        return true; // only need basic info already checked
+    }
+        
     QFileInfo image_file_info(FS::PathCombine(pack.fileinfo().filePath(), "pack.png"));
-    if (image_file_info.isFile()) {
+    if (image_file_info.exists() && image_file_info.isFile()) {
         QFile mcmeta_file(image_file_info.filePath());
         if (!mcmeta_file.open(QIODevice::ReadOnly))
-            return;
+            return false; // can't open pack.png file
 
         auto data = mcmeta_file.readAll();
 
-        ResourcePackUtils::processPackPNG(pack, std::move(data));
+        bool pack_png_result = ResourcePackUtils::processPackPNG(pack, std::move(data));
 
         mcmeta_file.close();
+        if (!pack_png_result) {
+            return false; // pack.png invalid
+        }
+    } else {
+        return false; // pack.png does not exists or is not a valid file.
     }
+
+    return true; // all tests passed
 }
 
-void processZIP(ResourcePack& pack, ProcessingLevel level)
+bool processZIP(ResourcePack& pack, ProcessingLevel level)
 {
     Q_ASSERT(pack.type() == ResourceType::ZIPFILE);
 
     QuaZip zip(pack.fileinfo().filePath());
     if (!zip.open(QuaZip::mdUnzip))
-        return;
+        return false; // can't open zip file
 
     QuaZipFile file(&zip);
 
@@ -91,40 +108,57 @@ void processZIP(ResourcePack& pack, ProcessingLevel level)
         if (!file.open(QIODevice::ReadOnly)) {
             qCritical() << "Failed to open file in zip.";
             zip.close();
-            return;
+            return false;
         }
 
         auto data = file.readAll();
 
-        ResourcePackUtils::processMCMeta(pack, std::move(data));
+        bool mcmeta_result = ResourcePackUtils::processMCMeta(pack, std::move(data));
 
         file.close();
+        if (!mcmeta_result) {
+            return false; // mcmeta invalid
+        }
+    } else {
+        return false; // could not set pack.mcmeta as current file.
+    }
+
+    QuaZipDir zipDir(&zip);
+    if (!zipDir.exists("/assets")) {
+        return false; // assets dir does not exists at zip root
     }
 
     if (level == ProcessingLevel::BasicInfoOnly) {
         zip.close();
-        return;
+        return true; // only need basic info already checked
     }
 
     if (zip.setCurrentFile("pack.png")) {
         if (!file.open(QIODevice::ReadOnly)) {
             qCritical() << "Failed to open file in zip.";
             zip.close();
-            return;
+            return false;
         }
 
         auto data = file.readAll();
 
-        ResourcePackUtils::processPackPNG(pack, std::move(data));
+        bool pack_png_result = ResourcePackUtils::processPackPNG(pack, std::move(data));
 
         file.close();
+        if (!pack_png_result) {
+            return false; // pack.png invalid
+        }
+    } else {
+        return false; // could not set pack.mcmeta as current file.
     }
 
     zip.close();
+
+    return true;
 }
 
 // https://minecraft.fandom.com/wiki/Tutorials/Creating_a_resource_pack#Formatting_pack.mcmeta
-void processMCMeta(ResourcePack& pack, QByteArray&& raw_data)
+bool processMCMeta(ResourcePack& pack, QByteArray&& raw_data)
 {
     try {
         auto json_doc = QJsonDocument::fromJson(raw_data);
@@ -134,17 +168,21 @@ void processMCMeta(ResourcePack& pack, QByteArray&& raw_data)
         pack.setDescription(Json::ensureString(pack_obj, "description", ""));
     } catch (Json::JsonException& e) {
         qWarning() << "JsonException: " << e.what() << e.cause();
+        return false;
     }
+    return true;
 }
 
-void processPackPNG(ResourcePack& pack, QByteArray&& raw_data)
+bool processPackPNG(ResourcePack& pack, QByteArray&& raw_data)
 {
     auto img = QImage::fromData(raw_data);
     if (!img.isNull()) {
         pack.setImage(img);
     } else {
         qWarning() << "Failed to parse pack.png.";
+        return false;
     }
+    return true;
 }
 
 bool validate(QFileInfo file)

launcher/minecraft/mod/tasks/LocalResourcePackParseTask.h

@@ -31,11 +31,11 @@ enum class ProcessingLevel { Full, BasicInfoOnly };
 
 bool process(ResourcePack& pack, ProcessingLevel level = ProcessingLevel::Full);
 
-void processZIP(ResourcePack& pack, ProcessingLevel level = ProcessingLevel::Full);
-void processFolder(ResourcePack& pack, ProcessingLevel level = ProcessingLevel::Full);
+bool processZIP(ResourcePack& pack, ProcessingLevel level = ProcessingLevel::Full);
+bool processFolder(ResourcePack& pack, ProcessingLevel level = ProcessingLevel::Full);
 
-void processMCMeta(ResourcePack& pack, QByteArray&& raw_data);
-void processPackPNG(ResourcePack& pack, QByteArray&& raw_data);
+bool processMCMeta(ResourcePack& pack, QByteArray&& raw_data);
+bool processPackPNG(ResourcePack& pack, QByteArray&& raw_data);
 
 /** Checks whether a file is valid as a resource pack or not. */
 bool validate(QFileInfo file);

launcher/minecraft/mod/tasks/LocalTexturePackParseTask.cpp

@@ -32,18 +32,16 @@ bool process(TexturePack& pack, ProcessingLevel level)
 {
     switch (pack.type()) {
         case ResourceType::FOLDER:
-            TexturePackUtils::processFolder(pack, level);
-            return true;
+            return TexturePackUtils::processFolder(pack, level);
         case ResourceType::ZIPFILE:
-            TexturePackUtils::processZIP(pack, level);
-            return true;
+            return TexturePackUtils::processZIP(pack, level);
         default:
             qWarning() << "Invalid type for resource pack parse task!";
             return false;
     }
 }
 
-void processFolder(TexturePack& pack, ProcessingLevel level)
+bool processFolder(TexturePack& pack, ProcessingLevel level)
 {
     Q_ASSERT(pack.type() == ResourceType::FOLDER);
 
@@ -51,39 +49,51 @@ void processFolder(TexturePack& pack, ProcessingLevel level)
     if (mcmeta_file_info.isFile()) {
         QFile mcmeta_file(mcmeta_file_info.filePath());
         if (!mcmeta_file.open(QIODevice::ReadOnly))
-            return;
+            return false;
 
         auto data = mcmeta_file.readAll();
 
-        TexturePackUtils::processPackTXT(pack, std::move(data));
+        bool packTXT_result = TexturePackUtils::processPackTXT(pack, std::move(data));
 
         mcmeta_file.close();
+        if (!packTXT_result) {
+            return false;
+        }
+    } else {
+        return false;
     }
 
     if (level == ProcessingLevel::BasicInfoOnly)
-        return;
+        return true;
 
     QFileInfo image_file_info(FS::PathCombine(pack.fileinfo().filePath(), "pack.png"));
     if (image_file_info.isFile()) {
         QFile mcmeta_file(image_file_info.filePath());
         if (!mcmeta_file.open(QIODevice::ReadOnly))
-            return;
+            return false;
 
         auto data = mcmeta_file.readAll();
 
-        TexturePackUtils::processPackPNG(pack, std::move(data));
+        bool packPNG_result = TexturePackUtils::processPackPNG(pack, std::move(data));
 
         mcmeta_file.close();
+        if (!packPNG_result) {
+            return false;
+        }
+    } else {
+        return false;
     }
+
+    return true;
 }
 
-void processZIP(TexturePack& pack, ProcessingLevel level)
+bool processZIP(TexturePack& pack, ProcessingLevel level)
 {
     Q_ASSERT(pack.type() == ResourceType::ZIPFILE);
 
     QuaZip zip(pack.fileinfo().filePath());
     if (!zip.open(QuaZip::mdUnzip))
-        return;
+        return false;
 
     QuaZipFile file(&zip);
 
@@ -91,51 +101,62 @@ void processZIP(TexturePack& pack, ProcessingLevel level)
         if (!file.open(QIODevice::ReadOnly)) {
             qCritical() << "Failed to open file in zip.";
             zip.close();
-            return;
+            return false;
         }
 
         auto data = file.readAll();
 
-        TexturePackUtils::processPackTXT(pack, std::move(data));
+        bool packTXT_result = TexturePackUtils::processPackTXT(pack, std::move(data));
 
         file.close();
+        if (!packTXT_result) {
+            return false;
+        }
     }
 
     if (level == ProcessingLevel::BasicInfoOnly) {
         zip.close();
-        return;
+        return false;
     }
 
     if (zip.setCurrentFile("pack.png")) {
         if (!file.open(QIODevice::ReadOnly)) {
             qCritical() << "Failed to open file in zip.";
             zip.close();
-            return;
+            return false;
         }
 
         auto data = file.readAll();
 
-        TexturePackUtils::processPackPNG(pack, std::move(data));
+        bool packPNG_result = TexturePackUtils::processPackPNG(pack, std::move(data));
 
         file.close();
+        if (!packPNG_result) {
+            return false;
+        }
     }
 
     zip.close();
+
+    return true;
 }
 
-void processPackTXT(TexturePack& pack, QByteArray&& raw_data)
+bool processPackTXT(TexturePack& pack, QByteArray&& raw_data)
 {
     pack.setDescription(QString(raw_data));
+    return true;
 }
 
-void processPackPNG(TexturePack& pack, QByteArray&& raw_data)
+bool processPackPNG(TexturePack& pack, QByteArray&& raw_data)
 {
     auto img = QImage::fromData(raw_data);
     if (!img.isNull()) {
         pack.setImage(img);
     } else {
         qWarning() << "Failed to parse pack.png.";
+        return false;
     }
+    return true;
 }
 
 bool validate(QFileInfo file)

launcher/minecraft/mod/tasks/LocalTexturePackParseTask.h

@@ -32,11 +32,11 @@ enum class ProcessingLevel { Full, BasicInfoOnly };
 
 bool process(TexturePack& pack, ProcessingLevel level = ProcessingLevel::Full);
 
-void processZIP(TexturePack& pack, ProcessingLevel level = ProcessingLevel::Full);
-void processFolder(TexturePack& pack, ProcessingLevel level = ProcessingLevel::Full);
+bool processZIP(TexturePack& pack, ProcessingLevel level = ProcessingLevel::Full);
+bool processFolder(TexturePack& pack, ProcessingLevel level = ProcessingLevel::Full);
 
-void processPackTXT(TexturePack& pack, QByteArray&& raw_data);
-void processPackPNG(TexturePack& pack, QByteArray&& raw_data);
+bool processPackTXT(TexturePack& pack, QByteArray&& raw_data);
+bool processPackPNG(TexturePack& pack, QByteArray&& raw_data);
 
 /** Checks whether a file is valid as a texture pack or not. */
 bool validate(QFileInfo file);