1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
// 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.
*/
#pragma once
#include <net/NetAction.h>
#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"
class Library;
class MinecraftInstance;
typedef std::shared_ptr<Library> LibraryPtr;
class Library {
friend class OneSixVersionFormat;
friend class MojangVersionFormat;
friend class LibraryTest;
public:
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;
}
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;
// 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;
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;
/// 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<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
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: Prism Launcher-specific absolute URL. takes precedence over the implicit maven repo URL, if defined
QString m_absoluteURL;
/// Prism Launcher extension - filename override
QString m_filename;
/// DEPRECATED Prism Launcher extension - display name
QString m_displayname;
/**
* Prism Launcher-specific type hint - modifies how the library is treated
*/
QString m_hint;
/**
* storage - by default the local libraries folder in Prism Launcher, but could be elsewhere
* Prism 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<std::shared_ptr<Rule>> m_rules;
/// MOJANG: container with Mojang style download info
MojangLibraryDownloadInfo::Ptr m_mojangDownloads;
};
|
