PrismLauncher/launcher/minecraft/LaunchProfile.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 "LaunchProfile.h"
#include <Version.h>

void LaunchProfile::clear()
{
    m_minecraftVersion.clear();
    m_minecraftVersionType.clear();
    m_minecraftAssets.reset();
    m_minecraftArguments.clear();
    m_addnJvmArguments.clear();
    m_tweakers.clear();
    m_mainClass.clear();
    m_appletClass.clear();
    m_libraries.clear();
    m_mavenFiles.clear();
    m_agents.clear();
    m_traits.clear();
    m_jarMods.clear();
    m_mainJar.reset();
    m_problemSeverity = ProblemSeverity::None;
}

static void applyString(const QString& from, QString& to)
{
    if (from.isEmpty())
        return;
    to = from;
}

void LaunchProfile::applyMinecraftVersion(const QString& id)
{
    applyString(id, this->m_minecraftVersion);
}

void LaunchProfile::applyAppletClass(const QString& appletClass)
{
    applyString(appletClass, this->m_appletClass);
}

void LaunchProfile::applyMainClass(const QString& mainClass)
{
    applyString(mainClass, this->m_mainClass);
}

void LaunchProfile::applyMinecraftArguments(const QString& minecraftArguments)
{
    applyString(minecraftArguments, this->m_minecraftArguments);
}

void LaunchProfile::applyAddnJvmArguments(const QStringList& addnJvmArguments)
{
    this->m_addnJvmArguments.append(addnJvmArguments);
}

void LaunchProfile::applyMinecraftVersionType(const QString& type)
{
    applyString(type, this->m_minecraftVersionType);
}

void LaunchProfile::applyMinecraftAssets(MojangAssetIndexInfo::Ptr assets)
{
    if (assets) {
        m_minecraftAssets = assets;
    }
}

void LaunchProfile::applyTraits(const QSet<QString>& traits)
{
    this->m_traits.unite(traits);
}

void LaunchProfile::applyTweakers(const QStringList& tweakers)
{
    // if the applied tweakers override an existing one, skip it. this effectively moves it later in the sequence
    QStringList newTweakers;
    for (auto& tweaker : m_tweakers) {
        if (tweakers.contains(tweaker)) {
            continue;
        }
        newTweakers.append(tweaker);
    }
    // then just append the new tweakers (or moved original ones)
    newTweakers += tweakers;
    m_tweakers = newTweakers;
}

void LaunchProfile::applyJarMods(const QList<LibraryPtr>& jarMods)
{
    this->m_jarMods.append(jarMods);
}

static int findLibraryByName(QList<LibraryPtr>* haystack, const GradleSpecifier& needle)
{
    int retval = -1;
    for (int i = 0; i < haystack->size(); ++i) {
        if (haystack->at(i)->rawName().matchName(needle)) {
            // only one is allowed.
            if (retval != -1)
                return -1;
            retval = i;
        }
    }
    return retval;
}

void LaunchProfile::applyMods(const QList<LibraryPtr>& mods)
{
    QList<LibraryPtr>* list = &m_mods;
    for (auto& mod : mods) {
        auto modCopy = Library::limitedCopy(mod);

        // find the mod by name.
        const int index = findLibraryByName(list, mod->rawName());
        // mod not found? just add it.
        if (index < 0) {
            list->append(modCopy);
            return;
        }

        auto existingLibrary = list->at(index);
        // if we are higher it means we should update
        if (Version(mod->version()) > Version(existingLibrary->version())) {
            list->replace(index, modCopy);
        }
    }
}

void LaunchProfile::applyCompatibleJavaMajors(QList<int>& javaMajor)
{
    m_compatibleJavaMajors.append(javaMajor);
}

void LaunchProfile::applyLibrary(LibraryPtr library, const RuntimeContext& runtimeContext)
{
    if (!library->isActive(runtimeContext)) {
        return;
    }

    QList<LibraryPtr>* list = &m_libraries;
    if (library->isNative()) {
        list = &m_nativeLibraries;
    }

    auto libraryCopy = Library::limitedCopy(library);

    // find the library by name.
    const int index = findLibraryByName(list, library->rawName());
    // library not found? just add it.
    if (index < 0) {
        list->append(libraryCopy);
        return;
    }

    auto existingLibrary = list->at(index);
    // if we are higher it means we should update
    if (Version(library->version()) > Version(existingLibrary->version())) {
        list->replace(index, libraryCopy);
    }
}

void LaunchProfile::applyMavenFile(LibraryPtr mavenFile, const RuntimeContext& runtimeContext)
{
    if (!mavenFile->isActive(runtimeContext)) {
        return;
    }

    if (mavenFile->isNative()) {
        return;
    }

    // unlike libraries, we do not keep only one version or try to dedupe them
    m_mavenFiles.append(Library::limitedCopy(mavenFile));
}

void LaunchProfile::applyAgent(AgentPtr agent, const RuntimeContext& runtimeContext)
{
    auto lib = agent->library();
    if (!lib->isActive(runtimeContext)) {
        return;
    }

    if (lib->isNative()) {
        return;
    }

    m_agents.append(agent);
}

const LibraryPtr LaunchProfile::getMainJar() const
{
    return m_mainJar;
}

void LaunchProfile::applyMainJar(LibraryPtr jar)
{
    if (jar) {
        m_mainJar = jar;
    }
}

void LaunchProfile::applyProblemSeverity(ProblemSeverity severity)
{
    if (m_problemSeverity < severity) {
        m_problemSeverity = severity;
    }
}

const QList<PatchProblem> LaunchProfile::getProblems() const
{
    // FIXME: implement something that actually makes sense here
    return {};
}

QString LaunchProfile::getMinecraftVersion() const
{
    return m_minecraftVersion;
}

QString LaunchProfile::getAppletClass() const
{
    return m_appletClass;
}

QString LaunchProfile::getMainClass() const
{
    return m_mainClass;
}

const QSet<QString>& LaunchProfile::getTraits() const
{
    return m_traits;
}

const QStringList& LaunchProfile::getTweakers() const
{
    return m_tweakers;
}

bool LaunchProfile::hasTrait(const QString& trait) const
{
    return m_traits.contains(trait);
}

ProblemSeverity LaunchProfile::getProblemSeverity() const
{
    return m_problemSeverity;
}

QString LaunchProfile::getMinecraftVersionType() const
{
    return m_minecraftVersionType;
}

std::shared_ptr<MojangAssetIndexInfo> LaunchProfile::getMinecraftAssets() const
{
    if (!m_minecraftAssets) {
        return std::make_shared<MojangAssetIndexInfo>("legacy");
    }
    return m_minecraftAssets;
}

QString LaunchProfile::getMinecraftArguments() const
{
    return m_minecraftArguments;
}

const QStringList& LaunchProfile::getAddnJvmArguments() const
{
    return m_addnJvmArguments;
}

const QList<LibraryPtr>& LaunchProfile::getJarMods() const
{
    return m_jarMods;
}

const QList<LibraryPtr>& LaunchProfile::getLibraries() const
{
    return m_libraries;
}

const QList<LibraryPtr>& LaunchProfile::getNativeLibraries() const
{
    return m_nativeLibraries;
}

const QList<LibraryPtr>& LaunchProfile::getMavenFiles() const
{
    return m_mavenFiles;
}

const QList<AgentPtr>& LaunchProfile::getAgents() const
{
    return m_agents;
}

const QList<int>& LaunchProfile::getCompatibleJavaMajors() const
{
    return m_compatibleJavaMajors;
}

void LaunchProfile::getLibraryFiles(const RuntimeContext& runtimeContext,
                                    QStringList& jars,
                                    QStringList& nativeJars,
                                    const QString& overridePath,
                                    const QString& tempPath) const
{
    QStringList native32, native64;
    jars.clear();
    nativeJars.clear();
    for (auto lib : getLibraries()) {
        lib->getApplicableFiles(runtimeContext, jars, nativeJars, native32, native64, overridePath);
    }
    // NOTE: order is important here, add main jar last to the lists
    if (m_mainJar) {
        // FIXME: HACK!! jar modding is weird and unsystematic!
        if (m_jarMods.size()) {
            QDir tempDir(tempPath);
            jars.append(tempDir.absoluteFilePath("minecraft.jar"));
        } else {
            m_mainJar->getApplicableFiles(runtimeContext, jars, nativeJars, native32, native64, overridePath);
        }
    }
    for (auto lib : getNativeLibraries()) {
        lib->getApplicableFiles(runtimeContext, jars, nativeJars, native32, native64, overridePath);
    }
    if (runtimeContext.javaArchitecture == "32") {
        nativeJars.append(native32);
    } else if (runtimeContext.javaArchitecture == "64") {
        nativeJars.append(native64);
    }
}