PrismLauncher/launcher/minecraft/Library.h

257 lines
7.4 KiB
C
Raw Normal View History

// SPDX-License-Identifier: GPL-3.0-only
/*
* PolyMC - 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.
*/
#pragma once
#include <QString>
#include <net/NetAction.h>
#include <QPair>
#include <QList>
#include <QString>
#include <QStringList>
#include <QMap>
#include <QDir>
#include <QUrl>
#include <memory>
#include "Rule.h"
#include "GradleSpecifier.h"
#include "MojangDownloadInfo.h"
#include "RuntimeContext.h"
class Library;
class MinecraftInstance;
typedef std::shared_ptr<Library> LibraryPtr;
class Library
{
2018-07-15 13:51:05 +01:00
friend class OneSixVersionFormat;
friend class MojangVersionFormat;
friend class LibraryTest;
2016-02-26 01:04:21 +00:00
public:
2018-07-15 13:51:05 +01:00
Library()
{
}
Library(const QString &name)
{
m_name = name;
}
/// limited copy without some data. TODO: why?
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;
return newlib;
}
2016-02-26 01:04:21 +00:00
public: /* methods */
2018-07-15 13:51:05 +01:00
/// 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,
2018-07-15 13:51:05 +01:00
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;
2018-07-15 13:51:05 +01:00
// DEPRECATED: set a display name, 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;
2018-07-15 13:51:05 +01:00
void setMojangDownloadInfo(MojangLibraryDownloadInfo::Ptr info)
{
m_mojangDownloads = info;
}
void setHint(const QString &hint)
{
m_hint = hint;
}
/// Set the load rules
void setRules(QList<std::shared_ptr<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;
2018-07-15 13:51:05 +01:00
/// 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;
2018-07-15 13:51:05 +01:00
// Get a list of downloads for this library
QList<NetAction::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 Prism Launcher
2018-07-15 13:51:05 +01:00
static QString defaultStoragePrefix();
2018-07-15 13:51:05 +01:00
/// Get the prefix - root of the storage to be used
QString storagePrefix() const;
2018-07-15 13:51:05 +01:00
/// Get the relative file path where the library should be saved
QString storageSuffix(const RuntimeContext & runtimeContext) const;
2018-07-15 13:51:05 +01:00
QString hint() const
{
return m_hint;
}
protected: /* data */
2018-07-15 13:51:05 +01:00
/// the basic gradle dependency specifier.
GradleSpecifier m_name;
2018-07-15 13:51:05 +01:00
/// DEPRECATED URL prefix of the maven repo where the file can be downloaded
QString m_repositoryURL;
2014-07-16 01:03:52 +01:00
/// DEPRECATED: Prism Launcher-specific absolute URL. takes precedence over the implicit maven repo URL, if defined
2018-07-15 13:51:05 +01:00
QString m_absoluteURL;
/// Prism Launcher extension - filename override
2018-07-15 13:51:05 +01:00
QString m_filename;
/// DEPRECATED Prism Launcher extension - display name
2018-07-15 13:51:05 +01:00
QString m_displayname;
2018-07-15 13:51:05 +01:00
/**
* Prism Launcher-specific type hint - modifies how the library is treated
2018-07-15 13:51:05 +01:00
*/
QString m_hint;
2018-07-15 13:51:05 +01:00
/**
* storage - by default the local libraries folder in Prism Launcher, but could be elsewhere
* Prism Launcher specific, because of FTB.
2018-07-15 13:51:05 +01:00
*/
QString m_storagePrefix;
2018-07-15 13:51:05 +01:00
/// true if the library had an extract/excludes section (even empty)
bool m_hasExcludes = false;
2018-07-15 13:51:05 +01:00
/// a list of files that shouldn't be extracted from the library
QStringList m_extractExcludes;
2018-07-15 13:51:05 +01:00
/// native suffixes per OS
QMap<QString, QString> m_nativeClassifiers;
2018-07-15 13:51:05 +01:00
/// true if the library had a rules section (even empty)
bool applyRules = false;
2018-07-15 13:51:05 +01:00
/// rules associated with the library
QList<std::shared_ptr<Rule>> m_rules;
2018-07-15 13:51:05 +01:00
/// MOJANG: container with Mojang style download info
MojangLibraryDownloadInfo::Ptr m_mojangDownloads;
};