Merge pull request #576 from Ryex/identify-zip-packs

fix #349

launcher/CMakeLists.txt

@@ -331,12 +331,18 @@ set(MINECRAFT_SOURCES
     minecraft/mod/Resource.cpp
     minecraft/mod/ResourceFolderModel.h
     minecraft/mod/ResourceFolderModel.cpp
+    minecraft/mod/DataPack.h
+    minecraft/mod/DataPack.cpp
     minecraft/mod/ResourcePack.h
     minecraft/mod/ResourcePack.cpp
     minecraft/mod/ResourcePackFolderModel.h
     minecraft/mod/ResourcePackFolderModel.cpp
     minecraft/mod/TexturePack.h
     minecraft/mod/TexturePack.cpp
+    minecraft/mod/ShaderPack.h
+    minecraft/mod/ShaderPack.cpp
+    minecraft/mod/WorldSave.h
+    minecraft/mod/WorldSave.cpp
     minecraft/mod/TexturePackFolderModel.h
     minecraft/mod/TexturePackFolderModel.cpp
     minecraft/mod/ShaderPackFolderModel.h
@@ -347,10 +353,18 @@ set(MINECRAFT_SOURCES
     minecraft/mod/tasks/LocalModParseTask.cpp
     minecraft/mod/tasks/LocalModUpdateTask.h
     minecraft/mod/tasks/LocalModUpdateTask.cpp
+    minecraft/mod/tasks/LocalDataPackParseTask.h
+    minecraft/mod/tasks/LocalDataPackParseTask.cpp
     minecraft/mod/tasks/LocalResourcePackParseTask.h
     minecraft/mod/tasks/LocalResourcePackParseTask.cpp
     minecraft/mod/tasks/LocalTexturePackParseTask.h
     minecraft/mod/tasks/LocalTexturePackParseTask.cpp
+    minecraft/mod/tasks/LocalShaderPackParseTask.h
+    minecraft/mod/tasks/LocalShaderPackParseTask.cpp
+    minecraft/mod/tasks/LocalWorldSaveParseTask.h
+    minecraft/mod/tasks/LocalWorldSaveParseTask.cpp
+    minecraft/mod/tasks/LocalResourceParse.h
+    minecraft/mod/tasks/LocalResourceParse.cpp
 
     # Assets
     minecraft/AssetsUtils.h

launcher/FileSystem.cpp

@@ -214,6 +214,22 @@ bool copy::operator()(const QString& offset, bool dryRun)
     return err.value() == 0;
 }
 
+bool move(const QString& source, const QString& dest)
+{
+    std::error_code err;
+
+    ensureFilePathExists(dest);
+    fs::rename(StringUtils::toStdString(source), StringUtils::toStdString(dest), err);
+
+    if (err) {
+        qWarning() << "Failed to move file:" << QString::fromStdString(err.message());
+        qDebug() << "Source file:" << source;
+        qDebug() << "Destination file:" << dest;
+    }
+
+    return err.value() == 0;
+}
+
 bool deletePath(QString path)
 {
     std::error_code err;

launcher/FileSystem.h

@@ -122,6 +122,14 @@ class copy : public QObject {
     int m_copied;
 };
 
+/**
+ * @brief moves a file by renaming it
+ * @param source source file path
+ * @param dest destination filepath
+ * 
+ */
+bool move(const QString&  source, const QString& dest);
+
 /**
  * Delete a folder recursively
  */

launcher/minecraft/mod/DataPack.cpp

@@ -0,0 +1,108 @@
+// 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 "DataPack.h"
+
+#include <QDebug>
+#include <QMap>
+#include <QRegularExpression>
+
+#include "Version.h"
+
+// Values taken from:
+// https://minecraft.fandom.com/wiki/Tutorials/Creating_a_data_pack#%22pack_format%22
+static const QMap<int, std::pair<Version, Version>> s_pack_format_versions = {
+    { 4, { Version("1.13"), Version("1.14.4") } },   { 5, { Version("1.15"), Version("1.16.1") } },
+    { 6, { Version("1.16.2"), Version("1.16.5") } }, { 7, { Version("1.17"), Version("1.17.1") } },
+    { 8, { Version("1.18"), Version("1.18.1") } },   { 9, { Version("1.18.2"), Version("1.18.2") } },
+    { 10, { Version("1.19"), Version("1.19.3") } },
+};
+
+void DataPack::setPackFormat(int new_format_id)
+{
+    QMutexLocker locker(&m_data_lock);
+
+    if (!s_pack_format_versions.contains(new_format_id)) {
+        qWarning() << "Pack format '" << new_format_id << "' is not a recognized data pack id!";
+    }
+
+    m_pack_format = new_format_id;
+}
+
+void DataPack::setDescription(QString new_description)
+{
+    QMutexLocker locker(&m_data_lock);
+
+    m_description = new_description;
+}
+
+std::pair<Version, Version> DataPack::compatibleVersions() const
+{
+    if (!s_pack_format_versions.contains(m_pack_format)) {
+        return { {}, {} };
+    }
+
+    return s_pack_format_versions.constFind(m_pack_format).value();
+}
+
+std::pair<int, bool> DataPack::compare(const Resource& other, SortType type) const
+{
+    auto const& cast_other = static_cast<DataPack const&>(other);
+
+    switch (type) {
+        default: {
+            auto res = Resource::compare(other, type);
+            if (res.first != 0)
+                return res;
+        }
+        case SortType::PACK_FORMAT: {
+            auto this_ver = packFormat();
+            auto other_ver = cast_other.packFormat();
+
+            if (this_ver > other_ver)
+                return { 1, type == SortType::PACK_FORMAT };
+            if (this_ver < other_ver)
+                return { -1, type == SortType::PACK_FORMAT };
+        }
+    }
+    return { 0, false };
+}
+
+bool DataPack::applyFilter(QRegularExpression filter) const
+{
+    if (filter.match(description()).hasMatch())
+        return true;
+
+    if (filter.match(QString::number(packFormat())).hasMatch())
+        return true;
+
+    if (filter.match(compatibleVersions().first.toString()).hasMatch())
+        return true;
+    if (filter.match(compatibleVersions().second.toString()).hasMatch())
+        return true;
+
+    return Resource::applyFilter(filter);
+}
+
+bool DataPack::valid() const
+{
+    return m_pack_format != 0;
+}

launcher/minecraft/mod/DataPack.h

@@ -0,0 +1,73 @@
+// 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 "Resource.h"
+
+#include <QMutex>
+
+class Version;
+
+/* TODO:
+ *
+ * Store localized descriptions
+ * */
+
+class DataPack : public Resource {
+    Q_OBJECT
+   public:
+    using Ptr = shared_qobject_ptr<Resource>;
+
+    DataPack(QObject* parent = nullptr) : Resource(parent) {}
+    DataPack(QFileInfo file_info) : Resource(file_info) {}
+
+    /** Gets the numerical ID of the pack format. */
+    [[nodiscard]] int packFormat() const { return m_pack_format; }
+    /** Gets, respectively, the lower and upper versions supported by the set pack format. */
+    [[nodiscard]] std::pair<Version, Version> compatibleVersions() const;
+
+    /** Gets the description of the data pack. */
+    [[nodiscard]] QString description() const { return m_description; }
+
+    /** Thread-safe. */
+    void setPackFormat(int new_format_id);
+
+    /** Thread-safe. */
+    void setDescription(QString new_description);
+
+    bool valid() const override;
+
+    [[nodiscard]] auto compare(Resource const& other, SortType type) const -> std::pair<int, bool> override;
+    [[nodiscard]] bool applyFilter(QRegularExpression filter) const override;
+
+   protected:
+    mutable QMutex m_data_lock;
+
+    /* The 'version' of a data pack, as defined in the pack.mcmeta file.
+     * See https://minecraft.fandom.com/wiki/Data_pack#pack.mcmeta
+     */
+    int m_pack_format = 0;
+
+    /** The data pack's description, as defined in the pack.mcmeta file.
+     */
+    QString m_description;
+};

launcher/minecraft/mod/Mod.cpp

@@ -43,6 +43,7 @@
 
 #include "MetadataHandler.h"
 #include "Version.h"
+#include "minecraft/mod/ModDetails.h"
 
 static ModPlatform::ProviderCapabilities ProviderCaps;
 
@@ -70,6 +71,10 @@ void Mod::setMetadata(std::shared_ptr<Metadata::ModStruct>&& metadata)
     m_local_details.metadata = metadata;
 }
 
+void Mod::setDetails(const ModDetails& details) {
+    m_local_details = details;
+}
+
 std::pair<int, bool> Mod::compare(const Resource& other, SortType type) const
 {
     auto cast_other = dynamic_cast<Mod const*>(&other);
@@ -204,3 +209,8 @@ auto Mod::provider() const -> std::optional<QString>
         return ProviderCaps.readableName(metadata()->provider);
     return {};
 }
+
+bool Mod::valid() const
+{
+    return !m_local_details.mod_id.isEmpty();
+}

launcher/minecraft/mod/Mod.h

@@ -71,6 +71,9 @@ class Mod : public Resource
     void setStatus(ModStatus status);
     void setMetadata(std::shared_ptr<Metadata::ModStruct>&& metadata);
     void setMetadata(const Metadata::ModStruct& metadata) { setMetadata(std::make_shared<Metadata::ModStruct>(metadata)); }
+    void setDetails(const ModDetails& details);
+
+    bool valid() const override;
 
     [[nodiscard]] auto compare(Resource const& other, SortType type) const -> std::pair<int, bool> override;
     [[nodiscard]] bool applyFilter(QRegularExpression filter) const override;

launcher/minecraft/mod/ModDetails.h

@@ -81,7 +81,7 @@ struct ModDetails
     ModDetails() = default;
 
     /** Metadata should be handled manually to properly set the mod status. */
-    ModDetails(ModDetails& other)
+    ModDetails(const ModDetails& other)
         : mod_id(other.mod_id)
         , name(other.name)
         , version(other.version)
@@ -92,7 +92,7 @@ struct ModDetails
         , status(other.status)
     {}
 
-    ModDetails& operator=(ModDetails& other)
+    ModDetails& operator=(const ModDetails& other)
     {
         this->mod_id = other.mod_id;
         this->name = other.name;
@@ -106,7 +106,7 @@ struct ModDetails
         return *this;
     }
 
-    ModDetails& operator=(ModDetails&& other)
+    ModDetails& operator=(const ModDetails&& other)
     {
         this->mod_id = other.mod_id;
         this->name = other.name;

launcher/minecraft/mod/ResourcePack.cpp

@@ -13,19 +13,20 @@
 // Values taken from:
 // https://minecraft.fandom.com/wiki/Tutorials/Creating_a_resource_pack#Formatting_pack.mcmeta
 static const QMap<int, std::pair<Version, Version>> s_pack_format_versions = {
-    { 1, { Version("1.6.1"), Version("1.8.9") } }, { 2, { Version("1.9"), Version("1.10.2") } },
-    { 3, { Version("1.11"), Version("1.12.2") } }, { 4, { Version("1.13"), Version("1.14.4") } },
-    { 5, { Version("1.15"), Version("1.16.1") } }, { 6, { Version("1.16.2"), Version("1.16.5") } },
-    { 7, { Version("1.17"), Version("1.17.1") } }, { 8, { Version("1.18"), Version("1.18.2") } },
-    { 9, { Version("1.19"), Version("1.19.2") } }, { 11, { Version("1.19.3"), Version("1.19.3") } },
+    { 1, { Version("1.6.1"), Version("1.8.9") } },    { 2, { Version("1.9"), Version("1.10.2") } },
+    { 3, { Version("1.11"), Version("1.12.2") } },    { 4, { Version("1.13"), Version("1.14.4") } },
+    { 5, { Version("1.15"), Version("1.16.1") } },    { 6, { Version("1.16.2"), Version("1.16.5") } },
+    { 7, { Version("1.17"), Version("1.17.1") } },    { 8, { Version("1.18"), Version("1.18.2") } },
+    { 9, { Version("1.19"), Version("1.19.2") } },    { 11, { Version("22w42a"), Version("22w44a") } },
+    { 12, { Version("1.19.3"), Version("1.19.3") } },
 };
 
 void ResourcePack::setPackFormat(int new_format_id)
 {
     QMutexLocker locker(&m_data_lock);
 
     if (!s_pack_format_versions.contains(new_format_id)) {
-        qWarning() << "Pack format '%1' is not a recognized resource pack id!";
+        qWarning() << "Pack format '" << new_format_id << "' is not a recognized resource pack id!";
     }
 
     m_pack_format = new_format_id;

launcher/minecraft/mod/ShaderPack.cpp

@@ -0,0 +1,37 @@
+
+// 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 "ShaderPack.h"
+
+#include "minecraft/mod/tasks/LocalShaderPackParseTask.h"
+
+void ShaderPack::setPackFormat(ShaderPackFormat new_format)
+{
+    QMutexLocker locker(&m_data_lock);
+
+    m_pack_format = new_format;
+}
+
+bool ShaderPack::valid() const
+{
+    return m_pack_format != ShaderPackFormat::INVALID;
+}