PackageInfo.cs
8.53 KB
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
using System;
using System.Collections.Generic;
using System.Linq;
using Semver;
using System.IO;
namespace UnityEditor.PackageManager.UI
{
[Serializable]
internal class PackageInfo : IEquatable<PackageInfo>
{
// Module package.json files contain a documentation url embedded in the description.
// We parse that to have the "View Documentation" button direct to it, instead of showing
// the link in the description text.
private const string builtinPackageDocsUrlKey = "Scripting API: ";
public string Name;
public string DisplayName;
private string _PackageId;
public SemVersion Version;
public string Description;
public string Category;
public PackageState State;
public bool IsCurrent;
public bool IsLatest;
public string Group;
public PackageSource Origin;
public List<Error> Errors;
public bool IsVerified;
public string Author;
public bool IsUnityPackage;
public PackageManager.PackageInfo Info { get; set; }
public string PackageId
{
get
{
if (!string.IsNullOrEmpty(_PackageId))
return _PackageId;
return string.Format("{0}@{1}", Name.ToLower(), Version);
}
set
{
_PackageId = value;
}
}
// This will always be <name>@<version>, even for an embedded package.
public string VersionId { get { return string.Format("{0}@{1}", Name.ToLower(), Version); } }
public string ShortVersionId { get { return string.Format("{0}@{1}", Name.ToLower(), Version.ShortVersion()); } }
public string BuiltInDescription
{
get
{
if (IsBuiltIn)
return string.Format("This built in package controls the presence of the {0} module.", DisplayName);
else
return Description.Split(new[] {builtinPackageDocsUrlKey}, StringSplitOptions.None)[0];
}
}
private static Version ParseShortVersion(string shortVersionId)
{
try
{
var versionToken = shortVersionId.Split('@')[1];
return new Version(versionToken);
}
catch (Exception)
{
// Keep default version 0.0 on exception
return new Version();
}
}
// Method content must be matched in package manager UI
public static string GetPackageUrlRedirect(string packageName, string shortVersionId)
{
var redirectUrl = "";
if (packageName == "com.unity.ads")
redirectUrl = "https://docs.unity3d.com/Manual/UnityAds.html";
else if (packageName == "com.unity.analytics")
{
if (ParseShortVersion(shortVersionId) < new Version(3, 2))
redirectUrl = "https://docs.unity3d.com/Manual/UnityAnalytics.html";
}
else if (packageName == "com.unity.purchasing")
redirectUrl = "https://docs.unity3d.com/Manual/UnityIAP.html";
else if (packageName == "com.unity.standardevents")
redirectUrl = "https://docs.unity3d.com/Manual/UnityAnalyticsStandardEvents.html";
else if (packageName == "com.unity.xiaomi")
redirectUrl = "https://unity3d.com/cn/partners/xiaomi/guide";
else if (packageName == "com.unity.shadergraph")
{
if (ParseShortVersion(shortVersionId) < new Version(4, 1))
redirectUrl = "https://github.com/Unity-Technologies/ShaderGraph/wiki";
}
return redirectUrl;
}
public bool RedirectsToManual(PackageInfo packageInfo)
{
return !string.IsNullOrEmpty(GetPackageUrlRedirect(packageInfo.Name, packageInfo.ShortVersionId));
}
public bool HasChangelog(PackageInfo packageInfo)
{
// Packages with no docs have no third party notice
return !RedirectsToManual(packageInfo);
}
public string GetDocumentationUrl()
{
if (IsBuiltIn)
{
if (!string.IsNullOrEmpty(Description))
{
var split = Description.Split(new[] {builtinPackageDocsUrlKey}, StringSplitOptions.None);
if (split.Length > 1)
return split[1];
}
}
return string.Format("http://docs.unity3d.com/Packages/{0}/index.html", ShortVersionId);
}
public string GetOfflineDocumentationUrl()
{
var docsFolder = Path.Combine(Info.resolvedPath, "Documentation~");
if (!Directory.Exists(docsFolder))
docsFolder = Path.Combine(Info.resolvedPath, "Documentation");
if (Directory.Exists(docsFolder))
{
var mdFiles = Directory.GetFiles(docsFolder, "*.md", SearchOption.TopDirectoryOnly);
var docsMd = mdFiles.FirstOrDefault(d => Path.GetFileName(d).ToLower() == "index.md")
?? mdFiles.FirstOrDefault(d => Path.GetFileName(d).ToLower() == "tableofcontents.md") ?? mdFiles.FirstOrDefault();
if (!string.IsNullOrEmpty(docsMd))
return new Uri(docsMd).AbsoluteUri;
}
return string.Empty;
}
public string GetChangelogUrl()
{
return string.Format("http://docs.unity3d.com/Packages/{0}/changelog/CHANGELOG.html", ShortVersionId);
}
public string GetOfflineChangelogUrl()
{
var changelogFile = Path.Combine(Info.resolvedPath, "CHANGELOG.md");
return File.Exists(changelogFile) ? new Uri(changelogFile).AbsoluteUri : string.Empty;
}
public string GetLicensesUrl()
{
var url = string.Format("http://docs.unity3d.com/Packages/{0}/license/index.html", ShortVersionId);
if (RedirectsToManual(this))
url = "https://unity3d.com/legal/licenses/Unity_Companion_License";
return url;
}
public string GetOfflineLicensesUrl()
{
var licenseFile = Path.Combine(Info.resolvedPath, "LICENSE.md");
return File.Exists(licenseFile) ? new Uri(licenseFile).AbsoluteUri : string.Empty;
}
public bool Equals(PackageInfo other)
{
if (other == null)
return false;
if (other == this)
return true;
return Name == other.Name && Version == other.Version;
}
public override int GetHashCode()
{
return PackageId.GetHashCode();
}
public bool HasVersionTag(string tag)
{
if (string.IsNullOrEmpty(Version.Prerelease))
return false;
return String.Equals(Version.Prerelease.Split('.').First(), tag, StringComparison.CurrentCultureIgnoreCase);
}
public bool HasVersionTag(PackageTag tag)
{
return HasVersionTag(tag.ToString());
}
// Is it a pre-release (alpha/beta/experimental/preview)?
// Current logic is any tag is considered pre-release, except recommended
public bool IsPreRelease
{
get { return !string.IsNullOrEmpty(Version.Prerelease) || Version.Major == 0; }
}
public bool IsPreview
{
get { return HasVersionTag(PackageTag.preview) || Version.Major == 0; }
}
// A version is user visible if it has a supported tag (or no tag at all)
public bool IsUserVisible
{
get { return IsCurrent || string.IsNullOrEmpty(Version.Prerelease) || HasVersionTag(PackageTag.preview) || IsVerified; }
}
public bool IsInDevelopment { get { return Origin == PackageSource.Embedded; } }
public bool IsLocal { get { return Origin == PackageSource.Local; } }
public bool IsBuiltIn { get { return Origin == PackageSource.BuiltIn; } }
public string VersionWithoutTag { get { return Version.VersionOnly(); } }
public bool IsVersionLocked
{
get { return Origin == PackageSource.Embedded || Origin == PackageSource.Git || Origin == PackageSource.BuiltIn; }
}
public bool CanBeRemoved
{
get { return Origin == PackageSource.Registry || Origin == PackageSource.BuiltIn || Origin == PackageSource.Local; }
}
}
}