2014-05-09 16:16:25 +01:00
|
|
|
#pragma once
|
|
|
|
#include <QString>
|
|
|
|
#include <QPair>
|
2014-05-11 11:37:21 +01:00
|
|
|
#include <QList>
|
|
|
|
#include <QStringList>
|
|
|
|
#include <QMap>
|
2014-07-26 22:00:35 +01:00
|
|
|
#include <QDir>
|
2015-05-27 00:30:18 +01:00
|
|
|
#include <QUrl>
|
2014-05-09 16:16:25 +01:00
|
|
|
#include <memory>
|
|
|
|
|
2016-03-07 01:01:28 +00:00
|
|
|
#include "Rule.h"
|
2015-02-09 00:51:14 +00:00
|
|
|
#include "minecraft/OpSys.h"
|
2014-07-19 22:16:02 +01:00
|
|
|
#include "GradleSpecifier.h"
|
2015-02-09 00:51:14 +00:00
|
|
|
#include "net/URLConstants.h"
|
2014-05-09 16:16:25 +01:00
|
|
|
|
2016-03-07 21:26:44 +00:00
|
|
|
class MojangLibraryDownloadInfo;
|
2016-03-07 01:01:28 +00:00
|
|
|
class Library;
|
2016-03-07 21:26:44 +00:00
|
|
|
|
2016-03-07 01:01:28 +00:00
|
|
|
typedef std::shared_ptr<Library> LibraryPtr;
|
2014-05-09 16:16:25 +01:00
|
|
|
|
2016-03-07 01:01:28 +00:00
|
|
|
class Library
|
2014-05-09 16:16:25 +01:00
|
|
|
{
|
2016-02-28 18:01:54 +00:00
|
|
|
friend class OneSixVersionFormat;
|
|
|
|
friend class MojangVersionFormat;
|
2016-02-26 01:04:21 +00:00
|
|
|
public:
|
2016-03-07 01:01:28 +00:00
|
|
|
Library()
|
2016-02-26 01:04:21 +00:00
|
|
|
{
|
|
|
|
}
|
2016-03-07 01:01:28 +00:00
|
|
|
Library(const QString &name)
|
2016-02-26 01:04:21 +00:00
|
|
|
{
|
|
|
|
m_name = name;
|
|
|
|
}
|
|
|
|
/// limited copy without some data. TODO: why?
|
2016-03-07 01:01:28 +00:00
|
|
|
static LibraryPtr limitedCopy(LibraryPtr base)
|
2016-02-26 01:04:21 +00:00
|
|
|
{
|
2016-03-07 01:01:28 +00:00
|
|
|
auto newlib = std::make_shared<Library>();
|
2016-02-26 01:04:21 +00:00
|
|
|
newlib->m_name = base->m_name;
|
|
|
|
newlib->m_base_url = base->m_base_url;
|
|
|
|
newlib->m_hint = base->m_hint;
|
|
|
|
newlib->m_absolute_url = base->m_absolute_url;
|
|
|
|
newlib->extract_excludes = base->extract_excludes;
|
|
|
|
newlib->m_native_classifiers = base->m_native_classifiers;
|
|
|
|
newlib->m_rules = base->m_rules;
|
|
|
|
newlib->m_storagePrefix = base->m_storagePrefix;
|
|
|
|
return newlib;
|
|
|
|
}
|
|
|
|
|
|
|
|
public: /* methods */
|
2014-07-26 22:00:35 +01:00
|
|
|
/// Returns the raw name field
|
|
|
|
const GradleSpecifier & rawName() const
|
|
|
|
{
|
|
|
|
return m_name;
|
|
|
|
}
|
2015-05-27 00:30:18 +01:00
|
|
|
|
2014-07-26 22:00:35 +01:00
|
|
|
void setRawName(const GradleSpecifier & spec)
|
|
|
|
{
|
|
|
|
m_name = spec;
|
|
|
|
}
|
|
|
|
|
|
|
|
void setClassifier(const QString & spec)
|
|
|
|
{
|
|
|
|
m_name.setClassifier(spec);
|
|
|
|
}
|
2015-05-27 00:30:18 +01:00
|
|
|
|
2014-07-26 22:00:35 +01:00
|
|
|
/// 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_native_classifiers.size() != 0;
|
|
|
|
}
|
|
|
|
|
2015-05-27 00:30:18 +01:00
|
|
|
void setStoragePrefix(QString prefix = QString());
|
|
|
|
|
|
|
|
/// the default storage prefix used by MultiMC
|
|
|
|
static QString defaultStoragePrefix();
|
|
|
|
|
|
|
|
bool storagePathIsDefault() const;
|
|
|
|
|
|
|
|
/// Get the prefix - root of the storage to be used
|
|
|
|
QString storagePrefix() const;
|
|
|
|
|
|
|
|
/// Get the relative path where the library should be saved
|
|
|
|
QString storageSuffix() const;
|
|
|
|
|
|
|
|
/// Get the absolute path where the library should be saved
|
|
|
|
QString storagePath() const;
|
|
|
|
|
2014-07-26 22:00:35 +01:00
|
|
|
/// Set the url base for downloads
|
2015-05-31 16:51:20 +01:00
|
|
|
void setBaseUrl(const QString &base_url)
|
2014-07-26 22:00:35 +01:00
|
|
|
{
|
|
|
|
m_base_url = base_url;
|
|
|
|
}
|
|
|
|
|
|
|
|
/// List of files this library describes. Required because of platform-specificness of native libs
|
|
|
|
QStringList files() const;
|
|
|
|
|
|
|
|
/// List Shortcut for checking if all the above files exist
|
|
|
|
bool filesExist(const QDir &base) const;
|
|
|
|
|
|
|
|
void setAbsoluteUrl(const QString &absolute_url)
|
|
|
|
{
|
|
|
|
m_absolute_url = absolute_url;
|
|
|
|
}
|
|
|
|
|
|
|
|
QString absoluteUrl() const
|
|
|
|
{
|
|
|
|
return m_absolute_url;
|
|
|
|
}
|
|
|
|
|
|
|
|
void setHint(const QString &hint)
|
|
|
|
{
|
|
|
|
m_hint = hint;
|
|
|
|
}
|
|
|
|
|
|
|
|
QString hint() const
|
|
|
|
{
|
|
|
|
return m_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;
|
|
|
|
|
|
|
|
/// Get the URL to download the library from
|
2015-05-31 16:51:20 +01:00
|
|
|
QString url() const;
|
2014-07-26 22:00:35 +01:00
|
|
|
|
|
|
|
protected: /* data */
|
|
|
|
/// the basic gradle dependency specifier.
|
2014-07-19 22:16:02 +01:00
|
|
|
GradleSpecifier m_name;
|
2014-07-26 22:00:35 +01:00
|
|
|
/// where to store the lib locally
|
|
|
|
QString m_storage_path;
|
|
|
|
/// is this lib actually active on the current OS?
|
|
|
|
bool m_is_active = false;
|
|
|
|
|
2016-02-24 23:29:35 +00:00
|
|
|
/// DEPRECATED URL prefix of the maven repo where the file can be downloaded
|
2015-05-31 16:51:20 +01:00
|
|
|
QString m_base_url;
|
2014-07-16 01:03:52 +01:00
|
|
|
|
2016-02-24 23:29:35 +00:00
|
|
|
/// DEPRECATED: MultiMC-specific absolute URL. takes precedence over the implicit maven repo URL, if defined
|
2014-07-26 22:00:35 +01:00
|
|
|
QString m_absolute_url;
|
|
|
|
|
2016-02-24 23:29:35 +00:00
|
|
|
/**
|
|
|
|
* MultiMC-specific type hint - modifies how the library is treated
|
|
|
|
*/
|
2014-05-11 11:37:21 +01:00
|
|
|
QString m_hint;
|
2014-05-09 16:16:25 +01:00
|
|
|
|
2016-02-24 23:29:35 +00:00
|
|
|
/**
|
|
|
|
* storage - by default the local libraries folder in multimc, but could be elsewhere
|
2016-03-07 01:01:28 +00:00
|
|
|
* MultiMC specific, because of FTB.
|
2016-02-24 23:29:35 +00:00
|
|
|
*/
|
2015-05-27 00:30:18 +01:00
|
|
|
QString m_storagePrefix;
|
|
|
|
|
2014-07-26 22:00:35 +01:00
|
|
|
/// true if the library had an extract/excludes section (even empty)
|
2014-05-09 16:16:25 +01:00
|
|
|
bool applyExcludes = false;
|
2014-07-26 22:00:35 +01:00
|
|
|
|
|
|
|
/// a list of files that shouldn't be extracted from the library
|
2014-05-11 11:37:21 +01:00
|
|
|
QStringList extract_excludes;
|
2014-05-09 16:16:25 +01:00
|
|
|
|
2014-05-11 11:37:21 +01:00
|
|
|
/// native suffixes per OS
|
2014-07-19 22:16:02 +01:00
|
|
|
QMap<OpSys, QString> m_native_classifiers;
|
2014-05-09 16:16:25 +01:00
|
|
|
|
2014-07-26 22:00:35 +01:00
|
|
|
/// true if the library had a rules section (even empty)
|
2014-05-09 16:16:25 +01:00
|
|
|
bool applyRules = false;
|
2014-07-26 22:00:35 +01:00
|
|
|
|
|
|
|
/// rules associated with the library
|
2014-05-11 11:37:21 +01:00
|
|
|
QList<std::shared_ptr<Rule>> m_rules;
|
2016-03-07 01:01:28 +00:00
|
|
|
|
|
|
|
/// MOJANG: container with Mojang style download info
|
2016-03-07 21:26:44 +00:00
|
|
|
std::shared_ptr<MojangLibraryDownloadInfo> m_mojang_downloads;
|
2014-05-09 16:16:25 +01:00
|
|
|
};
|