Merge pull request #876 from jltaylor-us/update-manifest

Add `UpdateManifest` update keys

7 files changed, 312 insertions, 0 deletions

diff --git a/src/SMAPI.Web/Framework/Clients/UpdateManifest/IUpdateManifestClient.cs b/src/SMAPI.Web/Framework/Clients/UpdateManifest/IUpdateManifestClient.cs
new file mode 100644
index 00000000..bf1edd3f
--- /dev/null
+++ b/src/SMAPI.Web/Framework/Clients/UpdateManifest/IUpdateManifestClient.cs
@@ -0,0 +1,7 @@
+using System;
+
+namespace StardewModdingAPI.Web.Framework.Clients.UpdateManifest
+{
+    /// <summary>An API client for fetching update metadata from an arbitrary JSON URL.</summary>
+    internal interface IUpdateManifestClient : IModSiteClient, IDisposable { }
+}
diff --git a/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModModel.cs b/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModModel.cs
new file mode 100644
index 00000000..ead5c229
--- /dev/null
+++ b/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModModel.cs
@@ -0,0 +1,35 @@
+using System;
+
+namespace StardewModdingAPI.Web.Framework.Clients.UpdateManifest.ResponseModels
+{
+    /// <summary>The data model for a mod in an update manifest file.</summary>
+    internal class UpdateManifestModModel
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The mod's name.</summary>
+        public string? Name { get; }
+
+        /// <summary>The mod page URL from which to download updates.</summary>
+        public string? ModPageUrl { get; }
+
+        /// <summary>The available versions for this mod.</summary>
+        public UpdateManifestVersionModel[] Versions { get; }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="name">The mod's name.</param>
+        /// <param name="modPageUrl">The mod page URL from which to download updates.</param>
+        /// <param name="versions">The available versions for this mod.</param>
+        public UpdateManifestModModel(string? name, string? modPageUrl, UpdateManifestVersionModel[]? versions)
+        {
+            this.Name = name;
+            this.ModPageUrl = modPageUrl;
+            this.Versions = versions ?? Array.Empty<UpdateManifestVersionModel>();
+        }
+    }
+}
diff --git a/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModel.cs b/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModel.cs
new file mode 100644
index 00000000..5ccd31b0
--- /dev/null
+++ b/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestModel.cs
@@ -0,0 +1,30 @@
+using System.Collections.Generic;
+
+namespace StardewModdingAPI.Web.Framework.Clients.UpdateManifest.ResponseModels
+{
+    /// <summary>The data model for an update manifest file.</summary>
+    internal class UpdateManifestModel
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The manifest format version. This is equivalent to the SMAPI version, and is used to parse older manifests correctly if later versions of SMAPI change the expected format.</summary>
+        public string Format { get; }
+
+        /// <summary>The mod info in this update manifest.</summary>
+        public IDictionary<string, UpdateManifestModModel> Mods { get; }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="format">The manifest format version.</param>
+        /// <param name="mods">The mod info in this update manifest.</param>
+        public UpdateManifestModel(string format, IDictionary<string, UpdateManifestModModel>? mods)
+        {
+            this.Format = format;
+            this.Mods = mods ?? new Dictionary<string, UpdateManifestModModel>();
+        }
+    }
+}
diff --git a/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestVersionModel.cs b/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestVersionModel.cs
new file mode 100644
index 00000000..6678f5eb
--- /dev/null
+++ b/src/SMAPI.Web/Framework/Clients/UpdateManifest/ResponseModels/UpdateManifestVersionModel.cs
@@ -0,0 +1,28 @@
+namespace StardewModdingAPI.Web.Framework.Clients.UpdateManifest.ResponseModels
+{
+    /// <summary>Data model for a Version in an update manifest.</summary>
+    internal class UpdateManifestVersionModel
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The mod's semantic version.</summary>
+        public string? Version { get; }
+
+        /// <summary>The mod page URL from which to download updates, if different from <see cref="UpdateManifestModModel.ModPageUrl"/>.</summary>
+        public string? ModPageUrl { get; }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="version">The mod's semantic version.</param>
+        /// <param name="modPageUrl">The mod page URL from which to download updates, if different from <see cref="UpdateManifestModModel.ModPageUrl"/>.</param>
+        public UpdateManifestVersionModel(string version, string? modPageUrl)
+        {
+            this.Version = version;
+            this.ModPageUrl = modPageUrl;
+        }
+    }
+}
diff --git a/src/SMAPI.Web/Framework/Clients/UpdateManifest/UpdateManifestClient.cs b/src/SMAPI.Web/Framework/Clients/UpdateManifest/UpdateManifestClient.cs
new file mode 100644
index 00000000..1614beab
--- /dev/null
+++ b/src/SMAPI.Web/Framework/Clients/UpdateManifest/UpdateManifestClient.cs
@@ -0,0 +1,107 @@
+
+using System;
+using System.Diagnostics.CodeAnalysis;
+using System.Net;
+using System.Net.Http.Headers;
+using System.Threading.Tasks;
+using Pathoschild.Http.Client;
+using StardewModdingAPI.Toolkit;
+using StardewModdingAPI.Toolkit.Framework.UpdateData;
+using StardewModdingAPI.Web.Framework.Clients.UpdateManifest.ResponseModels;
+
+namespace StardewModdingAPI.Web.Framework.Clients.UpdateManifest
+{
+    /// <summary>An API client for fetching update metadata from an arbitrary JSON URL.</summary>
+    internal class UpdateManifestClient : IUpdateManifestClient
+    {
+        /*********
+        ** Fields
+        *********/
+        /// <summary>The underlying HTTP client.</summary>
+        private readonly IClient Client;
+
+
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The unique key for the mod site.</summary>
+        public ModSiteKey SiteKey => ModSiteKey.UpdateManifest;
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="userAgent">The user agent for the API client.</param>
+        public UpdateManifestClient(string userAgent)
+        {
+            this.Client = new FluentClient()
+                .SetUserAgent(userAgent);
+
+            this.Client.Formatters.JsonFormatter.SupportedMediaTypes.Add(new MediaTypeHeaderValue("text/plain"));
+        }
+
+        /// <summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
+        public void Dispose()
+        {
+            this.Client.Dispose();
+        }
+
+        /// <inheritdoc/>
+        [SuppressMessage("ReSharper", "ConditionIsAlwaysTrueOrFalseAccordingToNullableAPIContract", Justification = "This is the method which ensures the annotations are correct.")]
+        public async Task<IModPage?> GetModData(string id)
+        {
+            // get raw update manifest
+            UpdateManifestModel? manifest;
+            try
+            {
+                manifest = await this.Client.GetAsync(id).As<UpdateManifestModel?>();
+                if (manifest is null)
+                    return this.GetFormatError(id, "manifest can't be empty");
+            }
+            catch (ApiException ex) when (ex.Status == HttpStatusCode.NotFound)
+            {
+                return new GenericModPage(this.SiteKey, id).SetError(RemoteModStatus.DoesNotExist, $"No update manifest found at {id}");
+            }
+            catch (Exception ex)
+            {
+                return this.GetFormatError(id, ex.Message);
+            }
+
+            // validate
+            if (!SemanticVersion.TryParse(manifest.Format, out _))
+                return this.GetFormatError(id, $"invalid format version '{manifest.Format}'");
+            foreach (UpdateManifestModModel mod in manifest.Mods.Values)
+            {
+                if (mod is null)
+                    return this.GetFormatError(id, "a mod record can't be null");
+                if (string.IsNullOrWhiteSpace(mod.ModPageUrl))
+                    return this.GetFormatError(id, $"all mods must have a {nameof(mod.ModPageUrl)} value");
+                foreach (UpdateManifestVersionModel? version in mod.Versions)
+                {
+                    if (version is null)
+                        return this.GetFormatError(id, "a version record can't be null");
+                    if (string.IsNullOrWhiteSpace(version.Version))
+                        return this.GetFormatError(id, $"all version records must have a {nameof(version.Version)} field");
+                    if (!SemanticVersion.TryParse(version.Version, out _))
+                        return this.GetFormatError(id, $"invalid mod version '{version.Version}'");
+                }
+            }
+
+            // build model
+            return new UpdateManifestModPage(id, manifest);
+        }
+
+
+        /*********
+        ** Private methods
+        *********/
+        /// <summary>Get a mod page instance with an error indicating the update manifest is invalid.</summary>
+        /// <param name="url">The full URL to the update manifest.</param>
+        /// <param name="reason">A human-readable reason phrase indicating why it's invalid.</param>
+        private IModPage GetFormatError(string url, string reason)
+        {
+            return new GenericModPage(this.SiteKey, url).SetError(RemoteModStatus.InvalidData, $"The update manifest at {url} is invalid ({reason})");
+        }
+    }
+}
diff --git a/src/SMAPI.Web/Framework/Clients/UpdateManifest/UpdateManifestModDownload.cs b/src/SMAPI.Web/Framework/Clients/UpdateManifest/UpdateManifestModDownload.cs
new file mode 100644
index 00000000..f8cb760a
--- /dev/null
+++ b/src/SMAPI.Web/Framework/Clients/UpdateManifest/UpdateManifestModDownload.cs
@@ -0,0 +1,34 @@
+namespace StardewModdingAPI.Web.Framework.Clients.UpdateManifest
+{
+    /// <summary>Metadata about a mod download in an update manifest file.</summary>
+    internal class UpdateManifestModDownload : GenericModDownload
+    {
+        /*********
+        ** Fields
+        *********/
+        /// <summary>The update subkey for this mod download.</summary>
+        private readonly string Subkey;
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="fieldName">The field name for this mod download in the manifest.</param>
+        /// <param name="name">The mod name for this download.</param>
+        /// <param name="version">The download's version.</param>
+        /// <param name="url">The download's URL.</param>
+        public UpdateManifestModDownload(string fieldName, string name, string? version, string? url)
+            : base(name, null, version, url)
+        {
+            this.Subkey = '@' + fieldName;
+        }
+
+        /// <summary>Get whether the subkey matches this download.</summary>
+        /// <param name="subkey">The update subkey to check.</param>
+        public override bool MatchesSubkey(string subkey)
+        {
+            return subkey == this.Subkey;
+        }
+    }
+}
diff --git a/src/SMAPI.Web/Framework/Clients/UpdateManifest/UpdateManifestModPage.cs b/src/SMAPI.Web/Framework/Clients/UpdateManifest/UpdateManifestModPage.cs
new file mode 100644
index 00000000..df752713
--- /dev/null
+++ b/src/SMAPI.Web/Framework/Clients/UpdateManifest/UpdateManifestModPage.cs
@@ -0,0 +1,71 @@
+using System.Collections.Generic;
+using System.Linq;
+using StardewModdingAPI.Toolkit.Framework.UpdateData;
+using StardewModdingAPI.Web.Framework.Clients.UpdateManifest.ResponseModels;
+
+namespace StardewModdingAPI.Web.Framework.Clients.UpdateManifest
+{
+    /// <summary>Metadata about an update manifest "page".</summary>
+    internal class UpdateManifestModPage : GenericModPage
+    {
+        /*********
+        ** Fields
+        *********/
+        /// <summary>The mods from the update manifest.</summary>
+        private readonly IDictionary<string, UpdateManifestModModel> Mods;
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="url">The URL of the update manifest file.</param>
+        /// <param name="manifest">The parsed update manifest.</param>
+        public UpdateManifestModPage(string url, UpdateManifestModel manifest)
+            : base(ModSiteKey.UpdateManifest, url)
+        {
+            this.RequireSubkey = true;
+            this.Mods = manifest.Mods;
+            this.SetInfo(name: url, url: url, version: null, downloads: this.ParseDownloads(manifest.Mods).ToArray());
+        }
+
+        /// <summary>Return the mod name for the given subkey, if it exists in this update manifest.</summary>
+        /// <param name="subkey">The subkey.</param>
+        /// <returns>The mod name for the given subkey, or <see langword="null"/> if this manifest does not contain the given subkey.</returns>
+        public override string? GetName(string? subkey)
+        {
+            return subkey is not null && this.Mods.TryGetValue(subkey.TrimStart('@'), out UpdateManifestModModel? mod)
+                ? mod.Name
+                : null;
+        }
+
+        /// <summary>Return the mod URL for the given subkey, if it exists in this update manifest.</summary>
+        /// <param name="subkey">The subkey.</param>
+        /// <returns>The mod URL for the given subkey, or <see langword="null"/> if this manifest does not contain the given subkey.</returns>
+        public override string? GetUrl(string? subkey)
+        {
+            return subkey is not null && this.Mods.TryGetValue(subkey.TrimStart('@'), out UpdateManifestModModel? mod)
+                ? mod.ModPageUrl
+                : null;
+        }
+
+
+        /*********
+        ** Private methods
+        *********/
+        /// <summary>Convert the raw download info from an update manifest to <see cref="IModDownload"/>.</summary>
+        /// <param name="mods">The mods from the update manifest.</param>
+        private IEnumerable<IModDownload> ParseDownloads(IDictionary<string, UpdateManifestModModel>? mods)
+        {
+            if (mods is null)
+                yield break;
+
+            foreach ((string modKey, UpdateManifestModModel mod) in mods)
+            {
+                foreach (UpdateManifestVersionModel version in mod.Versions)
+                    yield return new UpdateManifestModDownload(modKey, mod.Name ?? modKey, version.Version, version.ModPageUrl);
+            }
+        }
+
+    }
+}