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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
|
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using StardewModdingAPI.Framework.ModHelpers;
using StardewModdingAPI.Toolkit.Framework.Clients.WebApi;
using StardewModdingAPI.Toolkit.Framework.ModData;
using StardewModdingAPI.Toolkit.Framework.UpdateData;
using StardewModdingAPI.Toolkit.Utilities;
namespace StardewModdingAPI.Framework.ModLoading
{
/// <summary>Metadata for a mod.</summary>
internal class ModMetadata : IModMetadata
{
/*********
** Fields
*********/
/// <summary>The non-error issues with the mod, including warnings suppressed by the data record.</summary>
private ModWarning ActualWarnings = ModWarning.None;
/*********
** Accessors
*********/
/// <inheritdoc />
public string DisplayName { get; }
/// <inheritdoc />
public string RootPath { get; }
/// <inheritdoc />
public string DirectoryPath { get; }
/// <inheritdoc />
public string RelativeDirectoryPath { get; }
/// <inheritdoc />
public IManifest Manifest { get; }
/// <inheritdoc />
public ModDataRecordVersionedFields DataRecord { get; }
/// <inheritdoc />
public ModMetadataStatus Status { get; private set; }
/// <inheritdoc />
public ModFailReason? FailReason { get; private set; }
/// <inheritdoc />
public ModWarning Warnings => this.ActualWarnings & ~(this.DataRecord?.DataRecord.SuppressWarnings ?? ModWarning.None);
/// <inheritdoc />
public string Error { get; private set; }
/// <inheritdoc />
public string ErrorDetails { get; private set; }
/// <inheritdoc />
public bool IsIgnored { get; }
/// <inheritdoc />
public IMod Mod { get; private set; }
/// <inheritdoc />
public IContentPack ContentPack { get; private set; }
/// <inheritdoc />
public TranslationHelper Translations { get; private set; }
/// <inheritdoc />
public IMonitor Monitor { get; private set; }
/// <inheritdoc />
public object Api { get; private set; }
/// <inheritdoc />
public ModEntryModel UpdateCheckData { get; private set; }
/// <inheritdoc />
public bool IsContentPack => this.Manifest?.ContentPackFor != null;
/*********
** Public methods
*********/
/// <summary>Construct an instance.</summary>
/// <param name="displayName">The mod's display name.</param>
/// <param name="directoryPath">The mod's full directory path within the <paramref name="rootPath"/>.</param>
/// <param name="rootPath">The root path containing mods.</param>
/// <param name="manifest">The mod manifest.</param>
/// <param name="dataRecord">Metadata about the mod from SMAPI's internal data (if any).</param>
/// <param name="isIgnored">Whether the mod folder should be ignored. This should be <c>true</c> if it was found within a folder whose name starts with a dot.</param>
public ModMetadata(string displayName, string directoryPath, string rootPath, IManifest manifest, ModDataRecordVersionedFields dataRecord, bool isIgnored)
{
this.DisplayName = displayName;
this.DirectoryPath = directoryPath;
this.RootPath = rootPath;
this.RelativeDirectoryPath = PathUtilities.GetRelativePath(this.RootPath, this.DirectoryPath);
this.Manifest = manifest;
this.DataRecord = dataRecord;
this.IsIgnored = isIgnored;
}
/// <inheritdoc />
public IModMetadata SetStatusFound()
{
this.SetStatus(ModMetadataStatus.Found, ModFailReason.Incompatible, null);
this.FailReason = null;
return this;
}
/// <inheritdoc />
public IModMetadata SetStatus(ModMetadataStatus status, ModFailReason reason, string error, string errorDetails = null)
{
this.Status = status;
this.FailReason = reason;
this.Error = error;
this.ErrorDetails = errorDetails;
return this;
}
/// <inheritdoc />
public IModMetadata SetWarning(ModWarning warning)
{
this.ActualWarnings |= warning;
return this;
}
/// <inheritdoc />
public IModMetadata SetMod(IMod mod, TranslationHelper translations)
{
if (this.ContentPack != null)
throw new InvalidOperationException("A mod can't be both an assembly mod and content pack.");
this.Mod = mod;
this.Monitor = mod.Monitor;
this.Translations = translations;
return this;
}
/// <inheritdoc />
public IModMetadata SetMod(IContentPack contentPack, IMonitor monitor, TranslationHelper translations)
{
if (this.Mod != null)
throw new InvalidOperationException("A mod can't be both an assembly mod and content pack.");
this.ContentPack = contentPack;
this.Monitor = monitor;
this.Translations = translations;
return this;
}
/// <inheritdoc />
public IModMetadata SetApi(object api)
{
this.Api = api;
return this;
}
/// <inheritdoc />
public IModMetadata SetUpdateData(ModEntryModel data)
{
this.UpdateCheckData = data;
return this;
}
/// <inheritdoc />
public bool HasManifest()
{
return this.Manifest != null;
}
/// <inheritdoc />
public bool HasID()
{
return
this.HasManifest()
&& !string.IsNullOrWhiteSpace(this.Manifest.UniqueID);
}
/// <inheritdoc />
public bool HasID(string id)
{
return
this.HasID()
&& string.Equals(this.Manifest.UniqueID.Trim(), id?.Trim(), StringComparison.OrdinalIgnoreCase);
}
/// <inheritdoc />
public IEnumerable<UpdateKey> GetUpdateKeys(bool validOnly = false)
{
foreach (string rawKey in this.Manifest?.UpdateKeys ?? new string[0])
{
UpdateKey updateKey = UpdateKey.Parse(rawKey);
if (updateKey.LooksValid || !validOnly)
yield return updateKey;
}
}
/// <inheritdoc />
public IEnumerable<string> GetRequiredModIds(bool includeOptional = false)
{
HashSet<string> required = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
// yield dependencies
if (this.Manifest?.Dependencies != null)
{
foreach (var entry in this.Manifest?.Dependencies)
{
if ((entry.IsRequired || includeOptional) && required.Add(entry.UniqueID))
yield return entry.UniqueID;
}
}
// yield content pack parent
if (this.Manifest?.ContentPackFor?.UniqueID != null && required.Add(this.Manifest.ContentPackFor.UniqueID))
yield return this.Manifest.ContentPackFor.UniqueID;
}
/// <inheritdoc />
public bool HasValidUpdateKeys()
{
return this.GetUpdateKeys(validOnly: true).Any();
}
/// <inheritdoc />
public bool HasWarnings(params ModWarning[] warnings)
{
ModWarning curWarnings = this.Warnings;
return warnings.Any(warning => curWarnings.HasFlag(warning));
}
/// <inheritdoc />
public string GetRelativePathWithRoot()
{
string rootFolderName = Path.GetFileName(this.RootPath) ?? "";
return Path.Combine(rootFolderName, this.RelativeDirectoryPath);
}
}
}
|
