Merge branch 'feature/update-check-api' into develop

6 files changed, 321 insertions, 0 deletions

diff --git a/src/StardewModdingAPI.Web/Framework/ConfigModels/ModUpdateCheckConfig.cs b/src/StardewModdingAPI.Web/Framework/ConfigModels/ModUpdateCheckConfig.cs
new file mode 100644
index 00000000..5d55ba18
--- /dev/null
+++ b/src/StardewModdingAPI.Web/Framework/ConfigModels/ModUpdateCheckConfig.cs
@@ -0,0 +1,54 @@
+namespace StardewModdingAPI.Web.Framework.ConfigModels
+{
+    /// <summary>The config settings for mod update checks.</summary>
+    public class ModUpdateCheckConfig
+    {
+        /*********
+        ** Accessors
+        *********/
+        /****
+        ** General
+        ****/
+        /// <summary>The number of minutes update checks should be cached before refetching them.</summary>
+        public int CacheMinutes { get; set; }
+
+        /****
+        ** GitHub
+        ****/
+        /// <summary>The repository key for Nexus Mods.</summary>
+        public string GitHubKey { get; set; }
+
+        /// <summary>The user agent for the GitHub API client.</summary>
+        public string GitHubUserAgent { get; set; }
+
+        /// <summary>The base URL for the GitHub API.</summary>
+        public string GitHubBaseUrl { get; set; }
+
+        /// <summary>The URL for a GitHub API latest-release query excluding the <see cref="GitHubBaseUrl"/>, where {0} is the organisation and project name.</summary>
+        public string GitHubReleaseUrlFormat { get; set; }
+
+        /// <summary>The Accept header value expected by the GitHub API.</summary>
+        public string GitHubAcceptHeader { get; set; }
+
+        /// <summary>The username with which to authenticate to the GitHub API (if any).</summary>
+        public string GitHubUsername { get; set; }
+
+        /// <summary>The password with which to authenticate to the GitHub API (if any).</summary>
+        public string GitHubPassword { get; set; }
+
+        /****
+        ** Nexus Mods
+        ****/
+        /// <summary>The repository key for Nexus Mods.</summary>
+        public string NexusKey { get; set; }
+
+        /// <summary>The user agent for the Nexus Mods API client.</summary>
+        public string NexusUserAgent { get; set; }
+
+        /// <summary>The base URL for the Nexus Mods API.</summary>
+        public string NexusBaseUrl { get; set; }
+
+        /// <summary>The URL for a Nexus Mods API query excluding the <see cref="NexusBaseUrl"/>, where {0} is the mod ID.</summary>
+        public string NexusModUrlFormat { get; set; }
+    }
+}
diff --git a/src/StardewModdingAPI.Web/Framework/InternalControllerFeatureProvider.cs b/src/StardewModdingAPI.Web/Framework/InternalControllerFeatureProvider.cs
new file mode 100644
index 00000000..2c24c610
--- /dev/null
+++ b/src/StardewModdingAPI.Web/Framework/InternalControllerFeatureProvider.cs
@@ -0,0 +1,27 @@
+using System;
+using System.Reflection;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Mvc.Controllers;
+
+namespace StardewModdingAPI.Web.Framework
+{
+    /// <summary>Discovers controllers with support for non-public controllers.</summary>
+    internal class InternalControllerFeatureProvider : ControllerFeatureProvider
+    {
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Determines if a given type is a controller.</summary>
+        /// <param name="type">The <see cref="T:System.Reflection.TypeInfo" /> candidate.</param>
+        /// <returns><code>true</code> if the type is a controller; otherwise <code>false</code>.</returns>
+        protected override bool IsController(TypeInfo type)
+        {
+            return
+                type.IsClass
+                && !type.IsAbstract
+                && (/*type.IsPublic &&*/ !type.ContainsGenericParameters)
+                && (!type.IsDefined(typeof(NonControllerAttribute))
+                && (type.Name.EndsWith("Controller", StringComparison.OrdinalIgnoreCase) || type.IsDefined(typeof(ControllerAttribute))));
+        }
+    }
+}
diff --git a/src/StardewModdingAPI.Web/Framework/ModRepositories/GitHubRepository.cs b/src/StardewModdingAPI.Web/Framework/ModRepositories/GitHubRepository.cs
new file mode 100644
index 00000000..421220de
--- /dev/null
+++ b/src/StardewModdingAPI.Web/Framework/ModRepositories/GitHubRepository.cs
@@ -0,0 +1,95 @@
+using System;
+using System.Threading.Tasks;
+using Newtonsoft.Json;
+using Pathoschild.Http.Client;
+using StardewModdingAPI.Models;
+
+namespace StardewModdingAPI.Web.Framework.ModRepositories
+{
+    /// <summary>An HTTP client for fetching mod metadata from GitHub project releases.</summary>
+    internal class GitHubRepository : IModRepository
+    {
+        /*********
+        ** Properties
+        *********/
+        /// <summary>The underlying HTTP client.</summary>
+        private readonly IClient Client;
+
+
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The unique key for this vendor.</summary>
+        public string VendorKey { get; }
+
+        /// <summary>The URL for a Nexus Mods API query excluding the base URL, where {0} is the mod ID.</summary>
+        public string ReleaseUrlFormat { get; }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="vendorKey">The unique key for this vendor.</param>
+        /// <param name="baseUrl">The base URL for the Nexus Mods API.</param>
+        /// <param name="releaseUrlFormat">The URL for a Nexus Mods API query excluding the <paramref name="baseUrl"/>, where {0} is the mod ID.</param>
+        /// <param name="userAgent">The user agent for the GitHub API client.</param>
+        /// <param name="acceptHeader">The Accept header value expected by the GitHub API.</param>
+        /// <param name="username">The username with which to authenticate to the GitHub API.</param>
+        /// <param name="password">The password with which to authenticate to the GitHub API.</param>
+        public GitHubRepository(string vendorKey, string baseUrl, string releaseUrlFormat, string userAgent, string acceptHeader, string username, string password)
+        {
+            this.VendorKey = vendorKey;
+            this.ReleaseUrlFormat = releaseUrlFormat;
+
+            this.Client = new FluentClient(baseUrl)
+                .SetUserAgent(string.Format(userAgent, this.GetType().Assembly.GetName().Version))
+                .AddDefault(req => req.WithHeader("Accept", acceptHeader));
+            if (!string.IsNullOrWhiteSpace(username))
+                this.Client = this.Client.SetBasicAuthentication(username, password);
+        }
+
+        /// <summary>Get metadata about a mod in the repository.</summary>
+        /// <param name="id">The mod ID in this repository.</param>
+        public async Task<ModInfoModel> GetModInfoAsync(string id)
+        {
+            try
+            {
+                GitRelease release = await this.Client
+                    .GetAsync(string.Format(this.ReleaseUrlFormat, id))
+                    .As<GitRelease>();
+
+                return new ModInfoModel(id, release.Tag, $"https://github.com/{id}/releases");
+            }
+            catch (Exception ex)
+            {
+                return new ModInfoModel(ex.ToString());
+            }
+        }
+
+        /// <summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
+        public void Dispose()
+        {
+            this.Client.Dispose();
+        }
+
+
+        /*********
+        ** Private models
+        *********/
+        /// <summary>Metadata about a GitHub release tag.</summary>
+        private class GitRelease
+        {
+            /*********
+            ** Accessors
+            *********/
+            /// <summary>The display name.</summary>
+            [JsonProperty("name")]
+            public string Name { get; set; }
+
+            /// <summary>The semantic version string.</summary>
+            [JsonProperty("tag_name")]
+            public string Tag { get; set; }
+        }
+    }
+}
diff --git a/src/StardewModdingAPI.Web/Framework/ModRepositories/IModRepository.cs b/src/StardewModdingAPI.Web/Framework/ModRepositories/IModRepository.cs
new file mode 100644
index 00000000..98e4c957
--- /dev/null
+++ b/src/StardewModdingAPI.Web/Framework/ModRepositories/IModRepository.cs
@@ -0,0 +1,24 @@
+using System;
+using System.Threading.Tasks;
+using StardewModdingAPI.Models;
+
+namespace StardewModdingAPI.Web.Framework.ModRepositories
+{
+    /// <summary>A repository which provides mod metadata.</summary>
+    internal interface IModRepository : IDisposable
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The unique key for this vendor.</summary>
+        string VendorKey { get; }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Get metadata about a mod in the repository.</summary>
+        /// <param name="id">The mod ID in this repository.</param>
+        Task<ModInfoModel> GetModInfoAsync(string id);
+    }
+}
diff --git a/src/StardewModdingAPI.Web/Framework/ModRepositories/NexusRepository.cs b/src/StardewModdingAPI.Web/Framework/ModRepositories/NexusRepository.cs
new file mode 100644
index 00000000..6cf5b04a
--- /dev/null
+++ b/src/StardewModdingAPI.Web/Framework/ModRepositories/NexusRepository.cs
@@ -0,0 +1,91 @@
+using System;
+using System.Threading.Tasks;
+using Newtonsoft.Json;
+using Pathoschild.Http.Client;
+using StardewModdingAPI.Models;
+
+namespace StardewModdingAPI.Web.Framework.ModRepositories
+{
+    /// <summary>An HTTP client for fetching mod metadata from Nexus Mods.</summary>
+    internal class NexusRepository : IModRepository
+    {
+        /*********
+        ** Properties
+        *********/
+        /// <summary>The underlying HTTP client.</summary>
+        private readonly IClient Client;
+
+
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The unique key for this vendor.</summary>
+        public string VendorKey { get; }
+
+        /// <summary>The URL for a Nexus Mods API query excluding the base URL, where {0} is the mod ID.</summary>
+        public string ModUrlFormat { get; }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="vendorKey">The unique key for this vendor.</param>
+        /// <param name="userAgent">The user agent for the Nexus Mods API client.</param>
+        /// <param name="baseUrl">The base URL for the Nexus Mods API.</param>
+        /// <param name="modUrlFormat">The URL for a Nexus Mods API query excluding the <paramref name="baseUrl"/>, where {0} is the mod ID.</param>
+        public NexusRepository(string vendorKey, string userAgent, string baseUrl, string modUrlFormat)
+        {
+            this.VendorKey = vendorKey;
+            this.ModUrlFormat = modUrlFormat;
+            this.Client = new FluentClient(baseUrl).SetUserAgent(userAgent);
+        }
+
+        /// <summary>Get metadata about a mod in the repository.</summary>
+        /// <param name="id">The mod ID in this repository.</param>
+        public async Task<ModInfoModel> GetModInfoAsync(string id)
+        {
+            try
+            {
+                NexusResponseModel response = await this.Client
+                    .GetAsync(string.Format(this.ModUrlFormat, id))
+                    .As<NexusResponseModel>();
+
+                return response != null
+                    ? new ModInfoModel(response.Name, response.Version, response.Url)
+                    : new ModInfoModel("Found no mod with this ID.");
+            }
+            catch (Exception ex)
+            {
+                return new ModInfoModel(ex.ToString());
+            }
+        }
+
+        /// <summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
+        public void Dispose()
+        {
+            this.Client.Dispose();
+        }
+
+
+        /*********
+        ** Private models
+        *********/
+        /// <summary>A mod metadata response from Nexus Mods.</summary>
+        private class NexusResponseModel
+        {
+            /*********
+            ** Accessors
+            *********/
+            /// <summary>The mod name.</summary>
+            public string Name { get; set; }
+
+            /// <summary>The mod's semantic version number.</summary>
+            public string Version { get; set; }
+
+            /// <summary>The mod's web URL.</summary>
+            [JsonProperty("mod_page_uri")]
+            public string Url { get; set; }
+        }
+    }
+}
diff --git a/src/StardewModdingAPI.Web/Framework/RewriteSubdomainRule.cs b/src/StardewModdingAPI.Web/Framework/RewriteSubdomainRule.cs
new file mode 100644
index 00000000..5a56844f
--- /dev/null
+++ b/src/StardewModdingAPI.Web/Framework/RewriteSubdomainRule.cs
@@ -0,0 +1,30 @@
+using System;
+using Microsoft.AspNetCore.Rewrite;
+
+namespace StardewModdingAPI.Web.Framework
+{
+    /// <summary>Rewrite requests to prepend the subdomain portion (if any) to the path.</summary>
+    /// <remarks>Derived from <a href="https://stackoverflow.com/a/44526747/262123" />.</remarks>
+    internal class RewriteSubdomainRule : IRule
+    {
+        /// <summary>Applies the rule. Implementations of ApplyRule should set the value for <see cref="RewriteContext.Result" /> (defaults to RuleResult.ContinueRules).</summary>
+        /// <param name="context">The rewrite context.</param>
+        public void ApplyRule(RewriteContext context)
+        {
+            context.Result = RuleResult.ContinueRules;
+
+            // get host parts
+            string host = context.HttpContext.Request.Host.Host;
+            string[] parts = host.Split('.');
+
+            // validate
+            if (parts.Length < 2)
+                return;
+            if (parts.Length < 3 && !"localhost".Equals(parts[1], StringComparison.InvariantCultureIgnoreCase))
+                return;
+
+            // prepend to path
+            context.HttpContext.Request.Path = $"/{parts[0]}{context.HttpContext.Request.Path}";
+        }
+    }
+}