PrismLauncher/launcher/minecraft/OneSixVersionFormat.cpp

// SPDX-License-Identifier: GPL-3.0-only
/*
 *  Prism Launcher - Minecraft Launcher
 *  Copyright (C) 2022 Sefa Eyeoglu <contact@scrumplex.net>
 *
 *  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 "OneSixVersionFormat.h"
#include <Json.h>
#include <minecraft/MojangVersionFormat.h>
#include <QList>
#include "java/JavaMetadata.h"

#include <QRegularExpression>
#include <memory>

using namespace Json;

Result<> optionalString(const QJsonObject& root, const QString& key, QString& variable)
{
    if (root.contains(key)) {
        TRY_INTO(variable, requireString(root.value(key)))
    }
    return {};
}

Result<LibraryPtr> OneSixVersionFormat::libraryFromJson(ProblemContainer& problems, const QJsonObject& libObj, const QString& filename)
{
    auto res = MojangVersionFormat::libraryFromJson(problems, libObj, filename);
    TRY(res)
    auto out = res.value();
    TRY(optionalString(libObj, "MMC-hint", out->m_hint))
    TRY(optionalString(libObj, "MMC-absulute_url", out->m_absoluteURL))
    TRY(optionalString(libObj, "MMC-absoluteUrl", out->m_absoluteURL))
    TRY(optionalString(libObj, "MMC-filename", out->m_filename))
    TRY(optionalString(libObj, "MMC-displayname", out->m_displayname))
    return out;
}

QJsonObject OneSixVersionFormat::libraryToJson(Library* library)
{
    QJsonObject libRoot = MojangVersionFormat::libraryToJson(library);
    if (!library->m_absoluteURL.isEmpty()) {
        libRoot.insert("MMC-absoluteUrl", library->m_absoluteURL);
    }
    if (!library->m_hint.isEmpty()) {
        libRoot.insert("MMC-hint", library->m_hint);
    }
    if (!library->m_filename.isEmpty()) {
        libRoot.insert("MMC-filename", library->m_filename);
    }
    if (!library->m_displayname.isEmpty()) {
        libRoot.insert("MMC-displayname", library->m_displayname);
    }
    return libRoot;
}

Result<VersionFilePtr> OneSixVersionFormat::versionFileFromJson(const QJsonDocument& doc, const QString& filename, const bool requireOrder)
{
    auto out = std::make_shared<VersionFile>();
    if (doc.isEmpty() || doc.isNull()) {
        return std::unexpected(filename + " is empty or null");
    }
    if (!doc.isObject()) {
        return std::unexpected(filename + " is not an object");
    }

    QJsonObject root = doc.object();

    auto formatVersion = Meta::parseFormatVersion(root, false);
    TRY(formatVersion)

    if (requireOrder) {
        if (root.contains("order")) {
            TRY_INTO(out->order, requireInteger(root.value("order")))
        } else {
            // FIXME: evaluate if we don't want to return unexpected
            qCritical() << filename << "doesn't contain an order field";
        }
    }

    out->name = root.value("name").toString();

    if (root.contains("uid")) {
        out->uid = root.value("uid").toString();
    } else {
        out->uid = root.value("fileId").toString();
    }

    static const QRegularExpression s_validUidRegex{ QRegularExpression::anchoredPattern(
        QStringLiteral(R"([a-zA-Z0-9-_]+(?:\.[a-zA-Z0-9-_]+)*)")) };
    if (!s_validUidRegex.match(out->uid).hasMatch()) {
        qCritical() << "The component's 'uid' contains illegal characters! UID:" << out->uid;
        out->addProblem(ProblemSeverity::Error,
                        QObject::tr("The component's 'uid' contains illegal characters! This can cause security issues."));
    }

    out->version = root.value("version").toString();

    TRY(MojangVersionFormat::readVersionProperties(root, out.get()))

    // added for legacy Minecraft window embedding, TODO: remove
    TRY(optionalString(root, "appletClass", out->appletClass))

    if (root.contains("+tweakers")) {
        auto arr = requireArray(root.value("+tweakers"));
        TRY(arr)
        for (auto tweakerVal : arr.value()) {
            auto v = requireString(tweakerVal);
            TRY(v)
            out->addTweakers.append(v.value());
        }
    }

    if (root.contains("+traits")) {
        auto arr = requireArray(root.value("+traits"));
        TRY(arr)
        for (auto tweakerVal : arr.value()) {
            auto v = requireString(tweakerVal);
            TRY(v)
            out->traits.insert(v.value());
        }
    }

    if (root.contains("+jvmArgs")) {
        auto arr = requireArray(root.value("+jvmArgs"));
        TRY(arr)
        for (auto arg : arr.value()) {
            auto v = requireString(arg);
            TRY(v)
            out->addnJvmArguments.append(v.value());
        }
    }

    if (root.contains("jarMods")) {
        auto arr = requireArray(root.value("jarMods"));
        TRY(arr)
        for (auto libVal : arr.value()) {
            auto libObj = requireObject(libVal);
            TRY(libObj)
            // parse the jarmod
            auto lib = OneSixVersionFormat::jarModFromJson(*out, *libObj, filename);
            TRY(lib)
            // and add to jar mods
            out->jarMods.append(lib.value());
        }
    } else if (root.contains("+jarMods"))  // DEPRECATED: old style '+jarMods' are only here for backwards compatibility
    {
        auto arr = requireArray(root.value("+jarMods"));
        TRY(arr)
        for (auto libVal : arr.value()) {
            auto libObj = requireObject(libVal);
            TRY(libObj)
            // parse the jarmod
            auto lib = OneSixVersionFormat::plusJarModFromJson(*out, *libObj, filename, out->name);
            TRY(lib)
            // and add to jar mods
            out->jarMods.append(lib.value());
        }
    }

    if (root.contains("mods")) {
        auto arr = requireArray(root.value("mods"));
        TRY(arr)
        for (auto libVal : arr.value()) {
            auto libObj = requireObject(libVal);
            TRY(libObj)
            // parse the jarmod
            auto lib = OneSixVersionFormat::modFromJson(*out, *libObj, filename);
            TRY(lib)
            // and add to jar mods
            out->mods.append(lib.value());
        }
    }

    auto readLibs = [&root, &out, &filename](const char* which, QList<LibraryPtr>& outList) -> Result<> {
        auto arr = requireArray(root.value(which));
        TRY(arr)
        for (auto libVal : arr.value()) {
            auto libObj = requireObject(libVal);
            TRY(libObj)
            // parse the library
            auto lib = libraryFromJson(*out, *libObj, filename);
            TRY(lib)
            outList.append(lib.value());
        }
        return {};
    };
    bool hasPlusLibs = root.contains("+libraries");
    bool hasLibs = root.contains("libraries");
    if (hasPlusLibs && hasLibs) {
        out->addProblem(ProblemSeverity::Warning,
                        QObject::tr("Version file has both '+libraries' and 'libraries'. This is no longer supported."));
        TRY(readLibs("libraries", out->libraries))
        TRY(readLibs("+libraries", out->libraries))
    } else if (hasLibs) {
        TRY(readLibs("libraries", out->libraries))
    } else if (hasPlusLibs) {
        TRY(readLibs("+libraries", out->libraries))
    }

    if (root.contains("mavenFiles")) {
        TRY(readLibs("mavenFiles", out->mavenFiles))
    }

    if (root.contains("+agents")) {
        auto arr = requireArray(root.value("+agents"));
        TRY(arr)
        for (auto agentVal : arr.value()) {
            auto agentObj = requireObject(agentVal);
            TRY(agentObj)
            auto lib = libraryFromJson(*out, *agentObj, filename);
            TRY(lib)

            QString arg = "";
            TRY(optionalString(*agentObj, "argument", arg))

            out->agents.append(Agent{ .library = lib.value(), .argument = arg });
        }
    }

    // if we have mainJar, just use it
    if (root.contains("mainJar")) {
        auto libObj = requireObject(root, "mainJar");
        TRY(libObj)
        auto mainJar = libraryFromJson(*out, *libObj, filename);
        TRY(mainJar)
        out->mainJar = mainJar.value();
    }
    // else reconstruct it from downloads and id ... if that's available
    else if (!out->minecraftVersion.isEmpty()) {
        auto lib = std::make_shared<Library>();
        lib->setRawName(GradleSpecifier(QString("com.mojang:minecraft:%1:client").arg(out->minecraftVersion)));
        // we have a reliable client download, use it.
        if (out->mojangDownloads.contains("client")) {
            auto libDlInfo = std::make_shared<MojangLibraryDownloadInfo>();
            libDlInfo->artifact = out->mojangDownloads["client"];
            lib->setMojangDownloadInfo(libDlInfo);
        }
        // we got nothing...
        else {
            out->addProblem(
                ProblemSeverity::Error,
                QObject::tr("URL for the main jar could not be determined - Mojang removed the server that we used as fallback."));
        }
        out->mainJar = lib;
    }

    if (root.contains("requires")) {
        TRY(Meta::parseRequires(root, &out->m_requires))
    }
    QString dependsOnMinecraftVersion = root.value("mcVersion").toString();
    if (!dependsOnMinecraftVersion.isEmpty()) {
        Meta::Require mcReq;
        mcReq.uid = "net.minecraft";
        mcReq.equalsVersion = dependsOnMinecraftVersion;
        if (!out->m_requires.contains(mcReq)) {
            out->m_requires.insert(mcReq);
        }
    }
    if (root.contains("conflicts")) {
        TRY(Meta::parseRequires(root, &out->conflicts))
    }
    if (root.contains("volatile")) {
        TRY_INTO(out->m_volatile, requireBoolean(root, "volatile"))
    }

    if (root.contains("runtimes")) {
        out->runtimes = {};
        for (auto runtime : root["runtimes"].toArray()) {
            auto runtimeMeta = Java::parseJavaMeta(runtime.toObject());
            TRY(runtimeMeta)
            out->runtimes.append(runtimeMeta.value());
        }
    }

    /* removed features that shouldn't be used */
    if (root.contains("tweakers")) {
        out->addProblem(ProblemSeverity::Error, QObject::tr("Version file contains unsupported element 'tweakers'"));
    }
    if (root.contains("-libraries")) {
        out->addProblem(ProblemSeverity::Error, QObject::tr("Version file contains unsupported element '-libraries'"));
    }
    if (root.contains("-tweakers")) {
        out->addProblem(ProblemSeverity::Error, QObject::tr("Version file contains unsupported element '-tweakers'"));
    }
    if (root.contains("-minecraftArguments")) {
        out->addProblem(ProblemSeverity::Error, QObject::tr("Version file contains unsupported element '-minecraftArguments'"));
    }
    if (root.contains("+minecraftArguments")) {
        out->addProblem(ProblemSeverity::Error, QObject::tr("Version file contains unsupported element '+minecraftArguments'"));
    }
    return out;
}

QJsonDocument OneSixVersionFormat::versionFileToJson(const VersionFilePtr& patch)
{
    QJsonObject root;
    writeString(root, "name", patch->name);

    writeString(root, "uid", patch->uid);

    writeString(root, "version", patch->version);

    Meta::serializeFormatVersion(root, 1);

    MojangVersionFormat::writeVersionProperties(patch.get(), root);

    if (patch->mainJar) {
        root.insert("mainJar", libraryToJson(patch->mainJar.get()));
    }
    writeString(root, "appletClass", patch->appletClass);
    writeStringList(root, "+tweakers", patch->addTweakers);
    writeStringList(root, "+traits", patch->traits.values());
    writeStringList(root, "+jvmArgs", patch->addnJvmArguments);
    if (!patch->agents.isEmpty()) {
        QJsonArray array;
        for (const auto& value : patch->agents) {
            QJsonObject agentOut = OneSixVersionFormat::libraryToJson(value.library.get());
            if (!value.argument.isEmpty()) {
                agentOut.insert("argument", value.argument);
            }

            array.append(agentOut);
        }
        root.insert("+agents", array);
    }
    if (!patch->libraries.isEmpty()) {
        QJsonArray array;
        for (const auto& value : patch->libraries) {
            array.append(OneSixVersionFormat::libraryToJson(value.get()));
        }
        root.insert("libraries", array);
    }
    if (!patch->mavenFiles.isEmpty()) {
        QJsonArray array;
        for (const auto& value : patch->mavenFiles) {
            array.append(OneSixVersionFormat::libraryToJson(value.get()));
        }
        root.insert("mavenFiles", array);
    }
    if (!patch->jarMods.isEmpty()) {
        QJsonArray array;
        for (const auto& value : patch->jarMods) {
            array.append(OneSixVersionFormat::jarModtoJson(value.get()));
        }
        root.insert("jarMods", array);
    }
    if (!patch->mods.isEmpty()) {
        QJsonArray array;
        for (const auto& value : patch->jarMods) {
            array.append(OneSixVersionFormat::modtoJson(value.get()));
        }
        root.insert("mods", array);
    }
    if (!patch->m_requires.empty()) {
        Meta::serializeRequires(root, &patch->m_requires, "requires");
    }
    if (!patch->conflicts.empty()) {
        Meta::serializeRequires(root, &patch->conflicts, "conflicts");
    }
    if (patch->m_volatile) {
        root.insert("volatile", true);
    }
    // write the contents to a json document.
    {
        QJsonDocument out;
        out.setObject(root);
        return out;
    }
}

Result<LibraryPtr> OneSixVersionFormat::plusJarModFromJson([[maybe_unused]] ProblemContainer& problems,
                                                           const QJsonObject& libObj,
                                                           const QString& filename,
                                                           const QString& originalName)
{
    LibraryPtr out = std::make_shared<Library>();
    if (!libObj.contains("name")) {
        return std::unexpected(filename + " contains a jarmod that doesn't have a 'name' field");
    }

    // just make up something unique on the spot for the library name.
    QString id = QUuid::createUuid().toString(QUuid::WithoutBraces);
    out->setRawName(GradleSpecifier("org.multimc.jarmods:" + id + ":1"));

    // filename override is the old name
    out->setFilename(libObj.value("name").toString());

    // it needs to be local, it is stored in the instance jarmods folder
    out->setHint("local");

    // read the original name if present - some versions did not set it
    // it is the original jar mod filename before it got renamed at the point of addition
    auto displayName = libObj.value("originalName").toString();
    if (displayName.isEmpty()) {
        auto fixed = originalName;
        fixed.remove(" (jar mod)");
        out->setDisplayName(fixed);
    } else {
        out->setDisplayName(displayName);
    }
    return out;
}

Result<LibraryPtr> OneSixVersionFormat::jarModFromJson(ProblemContainer& problems, const QJsonObject& libObj, const QString& filename)
{
    return libraryFromJson(problems, libObj, filename);
}

QJsonObject OneSixVersionFormat::jarModtoJson(Library* jarmod)
{
    return libraryToJson(jarmod);
}

Result<LibraryPtr> OneSixVersionFormat::modFromJson(ProblemContainer& problems, const QJsonObject& libObj, const QString& filename)
{
    return libraryFromJson(problems, libObj, filename);
}

QJsonObject OneSixVersionFormat::modtoJson(Library* jarmod)
{
    return libraryToJson(jarmod);
}