From 8b09a2776d9c0faf96fa90c923952033ce659477 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com>
Date: Thu, 7 Nov 2019 13:51:45 -0500
Subject: add support for CurseForge update keys (#605)

---
 .../Clients/CurseForge/CurseForgeClient.cs         | 113 +++++++++++++++++++++
 .../Framework/Clients/CurseForge/CurseForgeMod.cs  |  23 +++++
 .../Clients/CurseForge/ICurseForgeClient.cs        |  17 ++++
 .../CurseForge/ResponseModels/ModFileModel.cs      |  12 +++
 .../Clients/CurseForge/ResponseModels/ModModel.cs  |  18 ++++
 5 files changed, 183 insertions(+)
 create mode 100644 src/SMAPI.Web/Framework/Clients/CurseForge/CurseForgeClient.cs
 create mode 100644 src/SMAPI.Web/Framework/Clients/CurseForge/CurseForgeMod.cs
 create mode 100644 src/SMAPI.Web/Framework/Clients/CurseForge/ICurseForgeClient.cs
 create mode 100644 src/SMAPI.Web/Framework/Clients/CurseForge/ResponseModels/ModFileModel.cs
 create mode 100644 src/SMAPI.Web/Framework/Clients/CurseForge/ResponseModels/ModModel.cs

(limited to 'src/SMAPI.Web/Framework/Clients/CurseForge')

diff --git a/src/SMAPI.Web/Framework/Clients/CurseForge/CurseForgeClient.cs b/src/SMAPI.Web/Framework/Clients/CurseForge/CurseForgeClient.cs
new file mode 100644
index 00000000..140b854e
--- /dev/null
+++ b/src/SMAPI.Web/Framework/Clients/CurseForge/CurseForgeClient.cs
@@ -0,0 +1,113 @@
+using System.Linq;
+using System.Text.RegularExpressions;
+using System.Threading.Tasks;
+using Pathoschild.Http.Client;
+using StardewModdingAPI.Toolkit;
+using StardewModdingAPI.Web.Framework.Clients.CurseForge.ResponseModels;
+
+namespace StardewModdingAPI.Web.Framework.Clients.CurseForge
+{
+    /// <summary>An HTTP client for fetching mod metadata from the CurseForge API.</summary>
+    internal class CurseForgeClient : ICurseForgeClient
+    {
+        /*********
+        ** Fields
+        *********/
+        /// <summary>The underlying HTTP client.</summary>
+        private readonly IClient Client;
+
+        /// <summary>A regex pattern which matches a version number in a CurseForge mod file name.</summary>
+        private readonly Regex VersionInNamePattern = new Regex(@"^(?:.+? | *)v?(\d+\.\d+(?:\.\d+)?(?:-.+?)?) *(?:\.(?:zip|rar|7z))?$", RegexOptions.Compiled);
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="userAgent">The user agent for the API client.</param>
+        /// <param name="apiUrl">The base URL for the CurseForge API.</param>
+        public CurseForgeClient(string userAgent, string apiUrl)
+        {
+            this.Client = new FluentClient(apiUrl).SetUserAgent(userAgent);
+        }
+
+        /// <summary>Get metadata about a mod.</summary>
+        /// <param name="id">The CurseForge mod ID.</param>
+        /// <returns>Returns the mod info if found, else <c>null</c>.</returns>
+        public async Task<CurseForgeMod> GetModAsync(long id)
+        {
+            // get raw data
+            ModModel mod = await this.Client
+                .GetAsync($"addon/{id}")
+                .As<ModModel>();
+            if (mod == null)
+                return null;
+
+            // get latest versions
+            string invalidVersion = null;
+            ISemanticVersion latest = null;
+            foreach (ModFileModel file in mod.LatestFiles)
+            {
+                // extract version
+                ISemanticVersion version;
+                {
+                    string raw = this.GetRawVersion(file);
+                    if (raw == null)
+                        continue;
+
+                    if (!SemanticVersion.TryParse(raw, out version))
+                    {
+                        if (invalidVersion == null)
+                            invalidVersion = raw;
+                        continue;
+                    }
+                }
+
+                // track latest version
+                if (latest == null || version.IsNewerThan(latest))
+                    latest = version;
+            }
+
+            // get error
+            string error = null;
+            if (latest == null && invalidVersion == null)
+            {
+                error = mod.LatestFiles.Any()
+                    ? $"CurseForge mod {id} has no downloads which specify the version in a recognised format."
+                    : $"CurseForge mod {id} has no downloads.";
+            }
+
+            // generate result
+            return new CurseForgeMod
+            {
+                Name = mod.Name,
+                LatestVersion = latest?.ToString() ?? invalidVersion,
+                Url = mod.WebsiteUrl,
+                Error = error
+            };
+        }
+
+        /// <summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
+        public void Dispose()
+        {
+            this.Client?.Dispose();
+        }
+
+
+        /*********
+        ** Private methods
+        *********/
+        /// <summary>Get a raw version string for a mod file, if available.</summary>
+        /// <param name="file">The file whose version to get.</param>
+        private string GetRawVersion(ModFileModel file)
+        {
+            Match match = this.VersionInNamePattern.Match(file.DisplayName);
+            if (!match.Success)
+                match = this.VersionInNamePattern.Match(file.FileName);
+
+            return match.Success
+                ? match.Groups[1].Value
+                : null;
+        }
+    }
+}
diff --git a/src/SMAPI.Web/Framework/Clients/CurseForge/CurseForgeMod.cs b/src/SMAPI.Web/Framework/Clients/CurseForge/CurseForgeMod.cs
new file mode 100644
index 00000000..e5bb8cf1
--- /dev/null
+++ b/src/SMAPI.Web/Framework/Clients/CurseForge/CurseForgeMod.cs
@@ -0,0 +1,23 @@
+using Newtonsoft.Json;
+
+namespace StardewModdingAPI.Web.Framework.Clients.CurseForge
+{
+    /// <summary>Mod metadata from the CurseForge API.</summary>
+    internal class CurseForgeMod
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The mod name.</summary>
+        public string Name { get; set; }
+
+        /// <summary>The latest file version.</summary>
+        public string LatestVersion { get; set; }
+
+        /// <summary>The mod's web URL.</summary>
+        public string Url { get; set; }
+
+        /// <summary>A user-friendly error which indicates why fetching the mod info failed (if applicable).</summary>
+        public string Error { get; set; }
+    }
+}
diff --git a/src/SMAPI.Web/Framework/Clients/CurseForge/ICurseForgeClient.cs b/src/SMAPI.Web/Framework/Clients/CurseForge/ICurseForgeClient.cs
new file mode 100644
index 00000000..907b4087
--- /dev/null
+++ b/src/SMAPI.Web/Framework/Clients/CurseForge/ICurseForgeClient.cs
@@ -0,0 +1,17 @@
+using System;
+using System.Threading.Tasks;
+
+namespace StardewModdingAPI.Web.Framework.Clients.CurseForge
+{
+    /// <summary>An HTTP client for fetching mod metadata from the CurseForge API.</summary>
+    internal interface ICurseForgeClient : IDisposable
+    {
+        /*********
+        ** Methods
+        *********/
+        /// <summary>Get metadata about a mod.</summary>
+        /// <param name="id">The CurseForge mod ID.</param>
+        /// <returns>Returns the mod info if found, else <c>null</c>.</returns>
+        Task<CurseForgeMod> GetModAsync(long id);
+    }
+}
diff --git a/src/SMAPI.Web/Framework/Clients/CurseForge/ResponseModels/ModFileModel.cs b/src/SMAPI.Web/Framework/Clients/CurseForge/ResponseModels/ModFileModel.cs
new file mode 100644
index 00000000..9de74847
--- /dev/null
+++ b/src/SMAPI.Web/Framework/Clients/CurseForge/ResponseModels/ModFileModel.cs
@@ -0,0 +1,12 @@
+namespace StardewModdingAPI.Web.Framework.Clients.CurseForge.ResponseModels
+{
+    /// <summary>Metadata from the CurseForge API about a mod file.</summary>
+    public class ModFileModel
+    {
+        /// <summary>The file name as downloaded.</summary>
+        public string FileName { get; set; }
+
+        /// <summary>The file display name.</summary>
+        public string DisplayName { get; set; }
+    }
+}
diff --git a/src/SMAPI.Web/Framework/Clients/CurseForge/ResponseModels/ModModel.cs b/src/SMAPI.Web/Framework/Clients/CurseForge/ResponseModels/ModModel.cs
new file mode 100644
index 00000000..48cd185b
--- /dev/null
+++ b/src/SMAPI.Web/Framework/Clients/CurseForge/ResponseModels/ModModel.cs
@@ -0,0 +1,18 @@
+namespace StardewModdingAPI.Web.Framework.Clients.CurseForge.ResponseModels
+{
+    /// <summary>An mod from the CurseForge API.</summary>
+    public class ModModel
+    {
+        /// <summary>The mod's unique ID on CurseForge.</summary>
+        public int ID { get; set; }
+
+        /// <summary>The mod name.</summary>
+        public string Name { get; set; }
+
+        /// <summary>The web URL for the mod page.</summary>
+        public string WebsiteUrl { get; set; }
+
+        /// <summary>The available file downloads.</summary>
+        public ModFileModel[] LatestFiles { get; set; }
+    }
+}
-- 
cgit