path: root/archived/projt-launcher/launcher/minecraft/Library.h

// SPDX-License-Identifier: GPL-3.0-only
// SPDX-FileCopyrightText: 2026 Project Tick
// SPDX-FileContributor: Project Tick Team
/*
 *  ProjT Launcher - Minecraft Launcher
 *  Copyright (C) 2026 Project Tick
 *
 *  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, write to the Free Software Foundation,
 *  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * === Upstream License Block (Do Not Modify) ==============================
 *
 *
 *
 *  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, write to the Free Software Foundation,
 *  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * 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 <QDir>
#include <QList>
#include <QMap>
#include <QPair>
#include <QString>
#include <QStringList>
#include <QUrl>
#include <memory>

#include "GradleSpecifier.h"
#include "MojangDownloadInfo.h"
#include "Rule.h"
#include "RuntimeContext.h"
#include "net/NetRequest.h"

class Library;
class MinecraftInstance;

using LibraryPtr = std::shared_ptr<Library>;

class Library
{
	friend class OneSixVersionFormat;
	friend class MojangVersionFormat;
	friend class LibraryTest;

  public:
	Library()
	{}
	Library(const QString& name)
	{
		m_name = name;
	}
	/// Create a copy of the library.
	static LibraryPtr limitedCopy(LibraryPtr base)
	{
		auto newlib					= std::make_shared<Library>();
		newlib->m_name				= base->m_name;
		newlib->m_repositoryURL		= base->m_repositoryURL;
		newlib->m_hint				= base->m_hint;
		newlib->m_absoluteURL		= base->m_absoluteURL;
		newlib->m_extractExcludes	= base->m_extractExcludes;
		newlib->m_nativeClassifiers = base->m_nativeClassifiers;
		newlib->m_rules				= base->m_rules;
		newlib->m_storagePrefix		= base->m_storagePrefix;
		newlib->m_mojangDownloads	= base->m_mojangDownloads;
		newlib->m_filename			= base->m_filename;
		newlib->m_displayname		= base->m_displayname; // Full copy
		return newlib;
	}

  public: /* methods */
	/// Returns the raw name field
	const GradleSpecifier& rawName() const
	{
		return m_name;
	}

	void setRawName(const GradleSpecifier& spec)
	{
		m_name = spec;
	}

	void setClassifier(const QString& spec)
	{
		m_name.setClassifier(spec);
	}

	/// returns the full group and artifact prefix
	QString artifactPrefix() const
	{
		return m_name.artifactPrefix();
	}

	/// get the artifact ID
	QString artifactId() const
	{
		return m_name.artifactId();
	}

	/// get the artifact version
	QString version() const
	{
		return m_name.version();
	}

	/// Returns true if the library is native
	bool isNative() const
	{
		return m_nativeClassifiers.size() != 0;
	}

	void setStoragePrefix(QString prefix = QString());

	/// Set the url base for downloads
	void setRepositoryURL(const QString& base_url)
	{
		m_repositoryURL = base_url;
	}

	void getApplicableFiles(const RuntimeContext& runtimeContext,
							QStringList& jar,
							QStringList& native,
							QStringList& native32,
							QStringList& native64,
							const QString& overridePath) const;

	void setAbsoluteUrl(const QString& absolute_url)
	{
		m_absoluteURL = absolute_url;
	}

	void setFilename(const QString& filename)
	{
		m_filename = filename;
	}

	/// Get the file name of the library
	QString filename(const RuntimeContext& runtimeContext) const;

	// NOTE: Legacy support for Core Mods display cutoff (approx 1.4.7 era). Used by jar mods only
	void setDisplayName(const QString& displayName)
	{
		m_displayname = displayName;
	}

	/// Get the file name of the library
	QString displayName(const RuntimeContext& runtimeContext) const;

	void setMojangDownloadInfo(MojangLibraryDownloadInfo::Ptr info)
	{
		m_mojangDownloads = info;
	}

	void setHint(const QString& hint)
	{
		m_hint = hint;
	}

	/// Set the load rules
	void setRules(QList<Rule> rules)
	{
		m_rules = rules;
	}

	/// Returns true if the library should be loaded (or extracted, in case of natives)
	bool isActive(const RuntimeContext& runtimeContext) const;

	/// Returns true if the library is contained in an instance and false if it is shared
	bool isLocal() const;

	/// Returns true if the library is to always be checked for updates
	bool isAlwaysStale() const;

	/// Return true if the library requires forge XZ hacks
	bool isForge() const;

	// Get a list of downloads for this library
	QList<Net::NetRequest::Ptr> getDownloads(const RuntimeContext& runtimeContext,
											 class HttpMetaCache* cache,
											 QStringList& failedLocalFiles,
											 const QString& overridePath) const;

	QString getCompatibleNative(const RuntimeContext& runtimeContext) const;

  private: /* methods */
	/// the default storage prefix used by ProjT Launcher
	static QString defaultStoragePrefix();

	/// Get the prefix - root of the storage to be used
	QString storagePrefix() const;

	/// Get the relative file path where the library should be saved
	QString storageSuffix(const RuntimeContext& runtimeContext) const;

	QString hint() const
	{
		return m_hint;
	}

  protected: /* data */
	/// the basic gradle dependency specifier.
	GradleSpecifier m_name;

	/// DEPRECATED URL prefix of the maven repo where the file can be downloaded
	QString m_repositoryURL;

	/// DEPRECATED: ProjT Launcher-specific absolute URL. takes precedence over the implicit maven repo URL, if defined
	QString m_absoluteURL;

	/// ProjT Launcher extension - filename override
	QString m_filename;

	/// DEPRECATED ProjT Launcher extension - display name
	QString m_displayname;

	/**
	 * ProjT Launcher-specific type hint - modifies how the library is treated
	 */
	QString m_hint;

	/**
	 * storage - by default the local libraries folder in ProjT Launcher, but could be elsewhere
	 * ProjT Launcher specific, because of FTB.
	 */
	QString m_storagePrefix;

	/// true if the library had an extract/excludes section (even empty)
	bool m_hasExcludes = false;

	/// a list of files that shouldn't be extracted from the library
	QStringList m_extractExcludes;

	/// native suffixes per OS
	QMap<QString, QString> m_nativeClassifiers;

	/// true if the library had a rules section (even empty)
	bool applyRules = false;

	/// rules associated with the library
	QList<Rule> m_rules;

	/// MOJANG: container with Mojang style download info
	MojangLibraryDownloadInfo::Ptr m_mojangDownloads;
};