Merge remote-tracking branch 'upstream/develop' into icon-indexing

4 files changed, 303 insertions, 20 deletions

diff --git a/launcher/ui/themes/CatPack.cpp b/launcher/ui/themes/CatPack.cpp
new file mode 100644
index 00000000..f0d8ddd5
--- /dev/null
+++ b/launcher/ui/themes/CatPack.cpp
@@ -0,0 +1,117 @@
+// SPDX-License-Identifier: GPL-3.0-only
+/*
+ *  Prism Launcher - Minecraft Launcher
+ *  Copyright (c) 2023 Trial97 <alexandru.tripon97@gmail.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/>.
+ *
+ * This file incorporates work covered by the following copyright and
+ * permission notice:
+ *
+ *      Copyright 2013-2021 MultiMC Contributors
+ *
+ *      Licensed under the Apache License, Version 2.0 (the "License");
+ *      you may not use this file except in compliance with the License.
+ *      You may obtain a copy of the License at
+ *
+ *          http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *      Unless required by applicable law or agreed to in writing, software
+ *      distributed under the License is distributed on an "AS IS" BASIS,
+ *      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *      See the License for the specific language governing permissions and
+ *      limitations under the License.
+ */
+
+#include "ui/themes/CatPack.h"
+#include <QDate>
+#include <QDir>
+#include <QFileInfo>
+#include "FileSystem.h"
+#include "Json.h"
+
+QString BasicCatPack::path()
+{
+    const auto now = QDate::currentDate();
+    const auto birthday = QDate(now.year(), 11, 30);
+    const auto xmas = QDate(now.year(), 12, 25);
+    const auto halloween = QDate(now.year(), 10, 31);
+
+    QString cat = QString(":/backgrounds/%1").arg(m_id);
+    if (std::abs(now.daysTo(xmas)) <= 4) {
+        cat += "-xmas";
+    } else if (std::abs(now.daysTo(halloween)) <= 4) {
+        cat += "-spooky";
+    } else if (std::abs(now.daysTo(birthday)) <= 12) {
+        cat += "-bday";
+    }
+    return cat;
+}
+
+JsonCatPack::PartialDate partialDate(QJsonObject date)
+{
+    auto month = Json::ensureInteger(date, "month", 1);
+    if (month > 12)
+        month = 12;
+    else if (month <= 0)
+        month = 1;
+    auto day = Json::ensureInteger(date, "day", 1);
+    if (day > 31)
+        day = 31;
+    else if (day <= 0)
+        day = 1;
+    return { month, day };
+};
+
+JsonCatPack::JsonCatPack(QFileInfo& manifestInfo) : BasicCatPack(manifestInfo.dir().dirName())
+{
+    QString path = manifestInfo.path();
+    auto doc = Json::requireDocument(manifestInfo.absoluteFilePath(), "CatPack JSON file");
+    const auto root = doc.object();
+    m_name = Json::requireString(root, "name", "Catpack name");
+    m_defaultPath = FS::PathCombine(path, Json::requireString(root, "default", "Default Cat"));
+    auto variants = Json::ensureArray(root, "variants", QJsonArray(), "Catpack Variants");
+    for (auto v : variants) {
+        auto variant = Json::ensureObject(v, QJsonObject(), "Cat variant");
+        m_variants << Variant{ FS::PathCombine(path, Json::requireString(variant, "path", "Variant path")),
+                               partialDate(Json::requireObject(variant, "startTime", "Variant startTime")),
+                               partialDate(Json::requireObject(variant, "endTime", "Variant endTime")) };
+    }
+}
+
+QDate ensureDay(int year, int month, int day)
+{
+    QDate date(year, month, 1);
+    if (day > date.daysInMonth())
+        day = date.daysInMonth();
+    return QDate(year, month, day);
+}
+
+QString JsonCatPack::path()
+{
+    const QDate now = QDate::currentDate();
+    for (auto var : m_variants) {
+        QDate startDate = ensureDay(now.year(), var.startTime.month, var.startTime.day);
+        QDate endDate = ensureDay(now.year(), var.endTime.month, var.endTime.day);
+        if (startDate > endDate) {  // it's spans over multiple years
+            if (endDate <= now)     // end date is in the past so jump one year into the future for endDate
+                endDate = endDate.addYears(1);
+            else  // end date is in the future so jump one year into the past for startDate
+                startDate = startDate.addYears(-1);
+        }
+
+        if (startDate >= now && now >= endDate)
+            return var.path;
+    }
+    return m_defaultPath;
+}
diff --git a/launcher/ui/themes/CatPack.h b/launcher/ui/themes/CatPack.h
new file mode 100644
index 00000000..b03a19f0
--- /dev/null
+++ b/launcher/ui/themes/CatPack.h
@@ -0,0 +1,91 @@
+// SPDX-License-Identifier: GPL-3.0-only
+/*
+ *  Prism Launcher - Minecraft Launcher
+ *  Copyright (c) 2023 Trial97 <alexandru.tripon97@gmail.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/>.
+ *
+ * This file incorporates work covered by the following copyright and
+ * permission notice:
+ *
+ *      Copyright 2013-2021 MultiMC Contributors
+ *
+ *      Licensed under the Apache License, Version 2.0 (the "License");
+ *      you may not use this file except in compliance with the License.
+ *      You may obtain a copy of the License at
+ *
+ *          http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *      Unless required by applicable law or agreed to in writing, software
+ *      distributed under the License is distributed on an "AS IS" BASIS,
+ *      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *      See the License for the specific language governing permissions and
+ *      limitations under the License.
+ */
+
+#pragma once
+
+#include <QDate>
+#include <QFileInfo>
+#include <QList>
+#include <QString>
+
+class CatPack {
+   public:
+    virtual ~CatPack() {}
+    virtual QString id() = 0;
+    virtual QString name() = 0;
+    virtual QString path() = 0;
+};
+
+class BasicCatPack : public CatPack {
+   public:
+    BasicCatPack(QString id, QString name) : m_id(id), m_name(name) {}
+    BasicCatPack(QString id) : BasicCatPack(id, id) {}
+    virtual QString id() { return m_id; };
+    virtual QString name() { return m_name; };
+    virtual QString path();
+
+   protected:
+    QString m_id;
+    QString m_name;
+};
+
+class FileCatPack : public BasicCatPack {
+   public:
+    FileCatPack(QString id, QFileInfo& fileInfo) : BasicCatPack(id), m_path(fileInfo.absoluteFilePath()) {}
+    FileCatPack(QFileInfo& fileInfo) : FileCatPack(fileInfo.baseName(), fileInfo) {}
+    virtual QString path() { return m_path; }
+
+   private:
+    QString m_path;
+};
+
+class JsonCatPack : public BasicCatPack {
+   public:
+    struct PartialDate {
+        int month;
+        int day;
+    };
+    struct Variant {
+        QString path;
+        PartialDate startTime;
+        PartialDate endTime;
+    };
+    JsonCatPack(QFileInfo& manifestInfo);
+    virtual QString path();
+
+   private:
+    QString m_defaultPath;
+    QList<Variant> m_variants;
+};
diff --git a/launcher/ui/themes/ThemeManager.cpp b/launcher/ui/themes/ThemeManager.cpp
index c929549e..fc7c3649 100644
--- a/launcher/ui/themes/ThemeManager.cpp
+++ b/launcher/ui/themes/ThemeManager.cpp
@@ -22,7 +22,10 @@
 #include <QDir>
 #include <QDirIterator>
 #include <QIcon>
+#include <QImageReader>
+#include "Exception.h"
 #include "ui/themes/BrightTheme.h"
+#include "ui/themes/CatPack.h"
 #include "ui/themes/CustomTheme.h"
 #include "ui/themes/DarkTheme.h"
 #include "ui/themes/SystemTheme.h"
@@ -32,6 +35,7 @@
 ThemeManager::ThemeManager()
 {
     initializeThemes();
+    initializeCatPacks();
 }
 
 /// @brief Adds the Theme to the list of themes
@@ -40,7 +44,10 @@ ThemeManager::ThemeManager()
 QString ThemeManager::addTheme(std::unique_ptr<ITheme> theme)
 {
     QString id = theme->id();
-    m_themes.emplace(id, std::move(theme));
+    if (m_themes.find(id) == m_themes.end())
+        m_themes.emplace(id, std::move(theme));
+    else
+        themeWarningLog() << "Theme(" << id << ") not added to prevent id duplication";
     return id;
 }
 
@@ -165,6 +172,16 @@ QList<ITheme*> ThemeManager::getValidApplicationThemes()
     return ret;
 }
 
+QList<CatPack*> ThemeManager::getValidCatPacks()
+{
+    QList<CatPack*> ret;
+    ret.reserve(m_catPacks.size());
+    for (auto&& [id, theme] : m_catPacks) {
+        ret.append(theme.get());
+    }
+    return ret;
+}
+
 bool ThemeManager::isValidIconTheme(const QString& id)
 {
     return !id.isEmpty() && m_icons.find(id) != m_icons.end();
@@ -217,19 +234,74 @@ void ThemeManager::applyCurrentlySelectedTheme(bool initial)
     themeDebugLog() << "<> Application theme set.";
 }
 
-QString ThemeManager::getCatImage(QString catName)
+QString ThemeManager::getCatPack(QString catName)
+{
+    auto catIter = m_catPacks.find(!catName.isEmpty() ? catName : APPLICATION->settings()->get("BackgroundCat").toString());
+    if (catIter != m_catPacks.end()) {
+        auto& catPack = catIter->second;
+        themeDebugLog() << "applying catpack" << catPack->id();
+        return catPack->path();
+    } else {
+        themeWarningLog() << "Tried to get invalid catPack:" << catName;
+    }
+
+    return m_catPacks.begin()->second->path();
+}
+
+QString ThemeManager::addCatPack(std::unique_ptr<CatPack> catPack)
 {
-    QDateTime now = QDateTime::currentDateTime();
-    QDateTime birthday(QDate(now.date().year(), 11, 30), QTime(0, 0));
-    QDateTime xmas(QDate(now.date().year(), 12, 25), QTime(0, 0));
-    QDateTime halloween(QDate(now.date().year(), 10, 31), QTime(0, 0));
-    QString cat = !catName.isEmpty() ? catName : APPLICATION->settings()->get("BackgroundCat").toString();
-    if (std::abs(now.daysTo(xmas)) <= 4) {
-        cat += "-xmas";
-    } else if (std::abs(now.daysTo(halloween)) <= 4) {
-        cat += "-spooky";
-    } else if (std::abs(now.daysTo(birthday)) <= 12) {
-        cat += "-bday";
+    QString id = catPack->id();
+    if (m_catPacks.find(id) == m_catPacks.end())
+        m_catPacks.emplace(id, std::move(catPack));
+    else
+        themeWarningLog() << "CatPack(" << id << ") not added to prevent id duplication";
+    return id;
+}
+
+void ThemeManager::initializeCatPacks()
+{
+    QList<std::pair<QString, QString>> defaultCats{ { "kitteh", QObject::tr("Background Cat (from MultiMC)") },
+                                                    { "rory", QObject::tr("Rory ID 11 (drawn by Ashtaka)") },
+                                                    { "rory-flat", QObject::tr("Rory ID 11 (flat edition, drawn by Ashtaka)") },
+                                                    { "teawie", QObject::tr("Teawie (drawn by SympathyTea)") } };
+    for (auto [id, name] : defaultCats) {
+        addCatPack(std::unique_ptr<CatPack>(new BasicCatPack(id, name)));
+    }
+    QDir catpacksDir("catpacks");
+    QString catpacksFolder = catpacksDir.absoluteFilePath("");
+    themeDebugLog() << "CatPacks Folder Path:" << catpacksFolder;
+
+    QStringList supportedImageFormats;
+    for (auto format : QImageReader::supportedImageFormats()) {
+        supportedImageFormats.append("*." + format);
+    }
+    auto loadFiles = [this, supportedImageFormats](QDir dir) {
+        // Load image files directly
+        QDirIterator ImageFileIterator(dir.absoluteFilePath(""), supportedImageFormats, QDir::Files);
+        while (ImageFileIterator.hasNext()) {
+            QFile customCatFile(ImageFileIterator.next());
+            QFileInfo customCatFileInfo(customCatFile);
+            themeDebugLog() << "Loading CatPack from:" << customCatFileInfo.absoluteFilePath();
+            addCatPack(std::unique_ptr<CatPack>(new FileCatPack(customCatFileInfo)));
+        }
+    };
+
+    loadFiles(catpacksDir);
+
+    QDirIterator directoryIterator(catpacksFolder, QDir::Dirs | QDir::NoDotAndDotDot);
+    while (directoryIterator.hasNext()) {
+        QDir dir(directoryIterator.next());
+        QFileInfo manifest(dir.absoluteFilePath("catpack.json"));
+        if (manifest.isFile()) {
+            try {
+                // Load background manifest
+                themeDebugLog() << "Loading background manifest from:" << manifest.absoluteFilePath();
+                addCatPack(std::unique_ptr<CatPack>(new JsonCatPack(manifest)));
+            } catch (const Exception& e) {
+                themeWarningLog() << "Couldn't load catpack json:" << e.cause();
+            }
+        } else {
+            loadFiles(dir);
+        }
     }
-    return cat;
 }
diff --git a/launcher/ui/themes/ThemeManager.h b/launcher/ui/themes/ThemeManager.h
index 5634a81a..1eb83ce1 100644
--- a/launcher/ui/themes/ThemeManager.h
+++ b/launcher/ui/themes/ThemeManager.h
@@ -22,6 +22,7 @@
 
 #include "IconTheme.h"
 #include "ui/MainWindow.h"
+#include "ui/themes/CatPack.h"
 #include "ui/themes/ITheme.h"
 
 inline auto themeDebugLog()
@@ -47,23 +48,25 @@ class ThemeManager {
     void setIconTheme(const QString& name);
     void setApplicationTheme(const QString& name, bool initial = false);
 
-    /// <summary>
-    /// Returns the cat based on selected cat and with events (Birthday, XMas, etc.)
-    /// </summary>
-    /// <param name="catName">Optional, if you need a specific cat.</param>
-    /// <returns></returns>
-    static QString getCatImage(QString catName = "");
+    /// @brief Returns the background based on selected and with events (Birthday, XMas, etc.)
+    /// @param catName Optional, if you need a specific background.
+    /// @return
+    QString getCatPack(QString catName = "");
+    QList<CatPack*> getValidCatPacks();
 
    private:
     std::map<QString, std::unique_ptr<ITheme>> m_themes;
     std::map<QString, IconTheme> m_icons;
     QDir m_iconThemeFolder{ "iconthemes" };
     QDir m_applicationThemeFolder{ "themes" };
+    std::map<QString, std::unique_ptr<CatPack>> m_catPacks;
 
     void initializeThemes();
+    void initializeCatPacks();
     QString addTheme(std::unique_ptr<ITheme> theme);
     ITheme* getTheme(QString themeId);
     QString addIconTheme(IconTheme theme);
+    QString addCatPack(std::unique_ptr<CatPack> catPack);
     void initializeIcons();
     void initializeWidgets();