Merge branch 'develop' into stable

11 files changed, 449 insertions, 31 deletions

diff --git a/src/SMAPI.Web/Framework/AllowLargePostsAttribute.cs b/src/SMAPI.Web/Framework/AllowLargePostsAttribute.cs
new file mode 100644
index 00000000..68ead3c2
--- /dev/null
+++ b/src/SMAPI.Web/Framework/AllowLargePostsAttribute.cs
@@ -0,0 +1,52 @@
+using System;
+using Microsoft.AspNetCore.Http.Features;
+using Microsoft.AspNetCore.Mvc.Filters;
+
+namespace StardewModdingAPI.Web.Framework
+{
+    /// <summary>A filter which increases the maximum request size for an endpoint.</summary>
+    /// <remarks>Derived from <a href="https://stackoverflow.com/a/38360093/262123"/>.</remarks>
+    [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)]
+    public class AllowLargePostsAttribute : Attribute, IAuthorizationFilter, IOrderedFilter
+    {
+        /*********
+        ** Properties
+        *********/
+        /// <summary>The underlying form options.</summary>
+        private readonly FormOptions FormOptions;
+
+
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The attribute order.</summary>
+        public int Order { get; set; }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        public AllowLargePostsAttribute()
+        {
+            this.FormOptions = new FormOptions
+            {
+                ValueLengthLimit = 200 * 1024 * 1024 // 200MB
+            };
+        }
+
+        /// <summary>Called early in the filter pipeline to confirm request is authorized.</summary>
+        /// <param name="context">The authorisation filter context.</param>
+        public void OnAuthorization(AuthorizationFilterContext context)
+        {
+            IFeatureCollection features = context.HttpContext.Features;
+            IFormFeature formFeature = features.Get<IFormFeature>();
+
+            if (formFeature?.Form == null)
+            {
+                // Request form has not been read yet, so set the limits
+                features.Set<IFormFeature>(new FormFeature(context.HttpContext.Request, this.FormOptions));
+            }
+        }
+    }
+}
diff --git a/src/SMAPI.Web/Framework/BeanstalkEnvPropsConfigProvider.cs b/src/SMAPI.Web/Framework/BeanstalkEnvPropsConfigProvider.cs
new file mode 100644
index 00000000..b39a3b61
--- /dev/null
+++ b/src/SMAPI.Web/Framework/BeanstalkEnvPropsConfigProvider.cs
@@ -0,0 +1,54 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using Microsoft.Extensions.Configuration;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+
+namespace StardewModdingAPI.Web.Framework
+{
+    /// <summary>Reads configuration values from the AWS Beanstalk environment properties file (if present).</summary>
+    /// <remarks>This is a workaround for AWS Beanstalk injection not working with .NET Core apps.</remarks>
+    internal class BeanstalkEnvPropsConfigProvider : ConfigurationProvider, IConfigurationSource
+    {
+        /*********
+        ** Properties
+        *********/
+        /// <summary>The absolute path to the container configuration file on an Amazon EC2 instance.</summary>
+        private const string ContainerConfigPath = @"C:\Program Files\Amazon\ElasticBeanstalk\config\containerconfiguration";
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Build the configuration provider for this source.</summary>
+        /// <param name="builder">The configuration builder.</param>
+        public IConfigurationProvider Build(IConfigurationBuilder builder)
+        {
+            return new BeanstalkEnvPropsConfigProvider();
+        }
+
+        /// <summary>Load the environment properties.</summary>
+        public override void Load()
+        {
+            this.Data = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
+
+            // get Beanstalk config file
+            FileInfo file = new FileInfo(BeanstalkEnvPropsConfigProvider.ContainerConfigPath);
+            if (!file.Exists)
+                return;
+
+            // parse JSON
+            JObject jsonRoot = (JObject)JsonConvert.DeserializeObject(File.ReadAllText(file.FullName));
+            if (jsonRoot["iis"]?["env"] is JArray jsonProps)
+            {
+                foreach (string prop in jsonProps.Values<string>())
+                {
+                    string[] parts = prop.Split('=', 2); // key=value
+                    if (parts.Length == 2)
+                        this.Data[parts[0]] = parts[1];
+                }
+            }
+        }
+    }
+}
diff --git a/src/SMAPI.Web/Framework/ConfigModels/LogParserConfig.cs b/src/SMAPI.Web/Framework/ConfigModels/LogParserConfig.cs
new file mode 100644
index 00000000..df5d605d
--- /dev/null
+++ b/src/SMAPI.Web/Framework/ConfigModels/LogParserConfig.cs
@@ -0,0 +1,24 @@
+namespace StardewModdingAPI.Web.Framework.ConfigModels
+{
+    /// <summary>The config settings for the log parser.</summary>
+    internal class LogParserConfig
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The root URL for the log parser controller.</summary>
+        public string SectionUrl { get; set; }
+
+        /// <summary>The base URL for the Pastebin API.</summary>
+        public string PastebinBaseUrl { get; set; }
+
+        /// <summary>The user agent for the Pastebin API client, where {0} is the SMAPI version.</summary>
+        public string PastebinUserAgent { get; set; }
+
+        /// <summary>The user key used to authenticate with the Pastebin API.</summary>
+        public string PastebinUserKey { get; set; }
+
+        /// <summary>The developer key used to authenticate with the Pastebin API.</summary>
+        public string PastebinDevKey { get; set; }
+    }
+}
diff --git a/src/SMAPI.Web/Framework/ConfigModels/ModUpdateCheckConfig.cs b/src/SMAPI.Web/Framework/ConfigModels/ModUpdateCheckConfig.cs
index 03de639e..2fb5b97e 100644
--- a/src/SMAPI.Web/Framework/ConfigModels/ModUpdateCheckConfig.cs
+++ b/src/SMAPI.Web/Framework/ConfigModels/ModUpdateCheckConfig.cs
@@ -1,7 +1,7 @@
 namespace StardewModdingAPI.Web.Framework.ConfigModels
 {
     /// <summary>The config settings for mod update checks.</summary>
-    public class ModUpdateCheckConfig
+    internal class ModUpdateCheckConfig
     {
         /*********
         ** Accessors
diff --git a/src/SMAPI.Web/Framework/LogParser/GetPasteResponse.cs b/src/SMAPI.Web/Framework/LogParser/GetPasteResponse.cs
new file mode 100644
index 00000000..4f8794db
--- /dev/null
+++ b/src/SMAPI.Web/Framework/LogParser/GetPasteResponse.cs
@@ -0,0 +1,15 @@
+namespace StardewModdingAPI.Web.Framework.LogParser
+{
+    /// <summary>The response for a get-paste request.</summary>
+    internal class GetPasteResponse
+    {
+        /// <summary>Whether the log was successfully fetched.</summary>
+        public bool Success { get; set; }
+
+        /// <summary>The fetched paste content (if <see cref="Success"/> is <c>true</c>).</summary>
+        public string Content { get; set; }
+
+        /// <summary>The error message (if saving failed).</summary>
+        public string Error { get; set; }
+    }
+}
diff --git a/src/SMAPI.Web/Framework/LogParser/PastebinClient.cs b/src/SMAPI.Web/Framework/LogParser/PastebinClient.cs
new file mode 100644
index 00000000..738330d3
--- /dev/null
+++ b/src/SMAPI.Web/Framework/LogParser/PastebinClient.cs
@@ -0,0 +1,117 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Net;
+using System.Net.Http;
+using System.Threading.Tasks;
+using Pathoschild.Http.Client;
+
+namespace StardewModdingAPI.Web.Framework.LogParser
+{
+    /// <summary>An API client for Pastebin.</summary>
+    internal class PastebinClient : IDisposable
+    {
+        /*********
+        ** Properties
+        *********/
+        /// <summary>The underlying HTTP client.</summary>
+        private readonly IClient Client;
+
+        /// <summary>The user key used to authenticate with the Pastebin API.</summary>
+        private readonly string UserKey;
+
+        /// <summary>The developer key used to authenticate with the Pastebin API.</summary>
+        private readonly string DevKey;
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="baseUrl">The base URL for the Pastebin API.</param>
+        /// <param name="userAgent">The user agent for the API client.</param>
+        /// <param name="userKey">The user key used to authenticate with the Pastebin API.</param>
+        /// <param name="devKey">The developer key used to authenticate with the Pastebin API.</param>
+        public PastebinClient(string baseUrl, string userAgent, string userKey, string devKey)
+        {
+            this.Client = new FluentClient(baseUrl).SetUserAgent(userAgent);
+            this.UserKey = userKey;
+            this.DevKey = devKey;
+        }
+
+        /// <summary>Fetch a saved paste.</summary>
+        /// <param name="id">The paste ID.</param>
+        public async Task<GetPasteResponse> GetAsync(string id)
+        {
+            try
+            {
+                // get from API
+                string content = await this.Client
+                    .GetAsync($"raw/{id}")
+                    .AsString();
+
+                // handle Pastebin errors
+                if (string.IsNullOrWhiteSpace(content))
+                    return new GetPasteResponse { Error = "Received an empty response from Pastebin." };
+                if (content.StartsWith("<!DOCTYPE"))
+                    return new GetPasteResponse { Error = $"Received a captcha challenge from Pastebin. Please visit https://pastebin.com/{id} in a new window to solve it." };
+                return new GetPasteResponse { Success = true, Content = content };
+            }
+            catch (ApiException ex) when (ex.Status == HttpStatusCode.NotFound)
+            {
+                return new GetPasteResponse { Error = "There's no log with that ID." };
+            }
+            catch (Exception ex)
+            {
+                return new GetPasteResponse { Error = ex.ToString() };
+            }
+        }
+
+        public async Task<SavePasteResponse> PostAsync(string content)
+        {
+            try
+            {
+                // validate
+                if (string.IsNullOrWhiteSpace(content))
+                    return new SavePasteResponse { Error = "The log content can't be empty." };
+
+                // post to API
+                string response = await this.Client
+                        .PostAsync("api/api_post.php")
+                        .WithBodyContent(new FormUrlEncodedContent(new Dictionary<string, string>
+                        {
+                            ["api_option"] = "paste",
+                            ["api_user_key"] = this.UserKey,
+                            ["api_dev_key"] = this.DevKey,
+                            ["api_paste_private"] = "1", // unlisted
+                            ["api_paste_name"] = $"SMAPI log {DateTime.UtcNow:s}",
+                            ["api_paste_expire_date"] = "1W", // one week
+                            ["api_paste_code"] = content
+                        }))
+                        .AsString();
+
+                // handle Pastebin errors
+                if (string.IsNullOrWhiteSpace(response))
+                    return new SavePasteResponse { Error = "Received an empty response from Pastebin." };
+                if (response.StartsWith("Bad API request"))
+                    return new SavePasteResponse { Error = response };
+                if (!response.Contains("/"))
+                    return new SavePasteResponse { Error = $"Received an unknown response: {response}" };
+
+                // return paste ID
+                string pastebinID = response.Split("/").Last();
+                return new SavePasteResponse { Success = true, ID = pastebinID };
+            }
+            catch (Exception ex)
+            {
+                return new SavePasteResponse { Success = false, Error = ex.ToString() };
+            }
+        }
+
+        /// <summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
+        public void Dispose()
+        {
+            this.Client.Dispose();
+        }
+    }
+}
diff --git a/src/SMAPI.Web/Framework/LogParser/SavePasteResponse.cs b/src/SMAPI.Web/Framework/LogParser/SavePasteResponse.cs
new file mode 100644
index 00000000..1c0960a4
--- /dev/null
+++ b/src/SMAPI.Web/Framework/LogParser/SavePasteResponse.cs
@@ -0,0 +1,15 @@
+namespace StardewModdingAPI.Web.Framework.LogParser
+{
+    /// <summary>The response for a save-log request.</summary>
+    internal class SavePasteResponse
+    {
+        /// <summary>Whether the log was successfully saved.</summary>
+        public bool Success { get; set; }
+
+        /// <summary>The saved paste ID (if <see cref="Success"/> is <c>true</c>).</summary>
+        public string ID { get; set; }
+
+        /// <summary>The error message (if saving failed).</summary>
+        public string Error { get; set; }
+    }
+}
diff --git a/src/SMAPI.Web/Framework/RewriteRules/ConditionalRedirectToHttpsRule.cs b/src/SMAPI.Web/Framework/RewriteRules/ConditionalRedirectToHttpsRule.cs
new file mode 100644
index 00000000..d6a56bb7
--- /dev/null
+++ b/src/SMAPI.Web/Framework/RewriteRules/ConditionalRedirectToHttpsRule.cs
@@ -0,0 +1,62 @@
+using System;
+using System.Net;
+using System.Text;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Rewrite;
+
+namespace StardewModdingAPI.Web.Framework.RewriteRules
+{
+    /// <summary>Redirect requests to HTTPS.</summary>
+    /// <remarks>Derived from <a href="https://stackoverflow.com/a/44526747/262123" /> and <see cref="Microsoft.AspNetCore.Rewrite.Internal.RedirectToHttpsRule"/>.</remarks>
+    internal class ConditionalRedirectToHttpsRule : IRule
+    {
+        /*********
+        ** Properties
+        *********/
+        /// <summary>A predicate which indicates when the rule should be applied.</summary>
+        private readonly Func<HttpRequest, bool> ShouldRewrite;
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="shouldRewrite">A predicate which indicates when the rule should be applied.</param>
+        public ConditionalRedirectToHttpsRule(Func<HttpRequest, bool> shouldRewrite = null)
+        {
+            this.ShouldRewrite = shouldRewrite ?? (req => true);
+        }
+
+        /// <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)
+        {
+            HttpRequest request = context.HttpContext.Request;
+
+            // check condition
+            if (this.IsSecure(request) || !this.ShouldRewrite(request))
+                return;
+
+            // redirect request
+            HttpResponse response = context.HttpContext.Response;
+            response.StatusCode = (int)HttpStatusCode.RedirectKeepVerb;
+            response.Headers["Location"] = new StringBuilder()
+                .Append("https://")
+                .Append(request.Host.Host)
+                .Append(request.PathBase)
+                .Append(request.Path)
+                .Append(request.QueryString)
+                .ToString();
+            context.Result = RuleResult.EndResponse;
+        }
+
+        /// <summary>Get whether the request was received over HTTPS.</summary>
+        /// <param name="request">The request to check.</param>
+        public bool IsSecure(HttpRequest request)
+        {
+            return
+                request.IsHttps // HTTPS to server
+                || string.Equals(request.Headers["x-forwarded-proto"], "HTTPS", StringComparison.OrdinalIgnoreCase); // HTTPS to AWS load balancer
+        }
+    }
+}
diff --git a/src/SMAPI.Web/Framework/RewriteRules/ConditionalRewriteSubdomainRule.cs b/src/SMAPI.Web/Framework/RewriteRules/ConditionalRewriteSubdomainRule.cs
new file mode 100644
index 00000000..920632ab
--- /dev/null
+++ b/src/SMAPI.Web/Framework/RewriteRules/ConditionalRewriteSubdomainRule.cs
@@ -0,0 +1,48 @@
+using System;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Rewrite;
+
+namespace StardewModdingAPI.Web.Framework.RewriteRules
+{
+    /// <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 ConditionalRewriteSubdomainRule : IRule
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>A predicate which indicates when the rule should be applied.</summary>
+        private readonly Func<HttpRequest, bool> ShouldRewrite;
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="shouldRewrite">A predicate which indicates when the rule should be applied.</param>
+        public ConditionalRewriteSubdomainRule(Func<HttpRequest, bool> shouldRewrite = null)
+        {
+            this.ShouldRewrite = shouldRewrite ?? (req => true);
+        }
+
+        /// <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)
+        {
+            HttpRequest request = context.HttpContext.Request;
+
+            // check condition
+            if (!this.ShouldRewrite(request))
+                return;
+
+            // get host parts
+            string host = request.Host.Host;
+            string[] parts = host.Split('.');
+            if (parts.Length < 2)
+                return;
+
+            // prepend to path
+            request.Path = $"/{parts[0]}{request.Path}";
+        }
+    }
+}
diff --git a/src/SMAPI.Web/Framework/RewriteRules/RedirectToUrlRule.cs b/src/SMAPI.Web/Framework/RewriteRules/RedirectToUrlRule.cs
new file mode 100644
index 00000000..0719e311
--- /dev/null
+++ b/src/SMAPI.Web/Framework/RewriteRules/RedirectToUrlRule.cs
@@ -0,0 +1,61 @@
+using System;
+using System.Net;
+using System.Text.RegularExpressions;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Rewrite;
+
+namespace StardewModdingAPI.Web.Framework.RewriteRules
+{
+    /// <summary>Redirect requests to an external URL if they match a condition.</summary>
+    internal class RedirectToUrlRule : IRule
+    {
+        /*********
+        ** Properties
+        *********/
+        /// <summary>A predicate which indicates when the rule should be applied.</summary>
+        private readonly Func<HttpRequest, bool> ShouldRewrite;
+
+        /// <summary>The new URL to which to redirect.</summary>
+        private readonly string NewUrl;
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="shouldRewrite">A predicate which indicates when the rule should be applied.</param>
+        /// <param name="url">The new URL to which to redirect.</param>
+        public RedirectToUrlRule(Func<HttpRequest, bool> shouldRewrite, string url)
+        {
+            this.ShouldRewrite = shouldRewrite ?? (req => true);
+            this.NewUrl = url;
+        }
+
+        /// <summary>Construct an instance.</summary>
+        /// <param name="pathRegex">A case-insensitive regex to match against the path.</param>
+        /// <param name="url">The external URL.</param>
+        public RedirectToUrlRule(string pathRegex, string url)
+        {
+            Regex regex = new Regex(pathRegex, RegexOptions.IgnoreCase | RegexOptions.Compiled);
+            this.ShouldRewrite = req => req.Path.HasValue && regex.IsMatch(req.Path.Value);
+            this.NewUrl = url;
+        }
+
+        /// <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)
+        {
+            HttpRequest request = context.HttpContext.Request;
+
+            // check condition
+            if (!this.ShouldRewrite(request))
+                return;
+
+            // redirect request
+            HttpResponse response = context.HttpContext.Response;
+            response.StatusCode = (int)HttpStatusCode.Redirect;
+            response.Headers["Location"] = this.NewUrl;
+            context.Result = RuleResult.EndResponse;
+        }
+    }
+}
diff --git a/src/SMAPI.Web/Framework/RewriteSubdomainRule.cs b/src/SMAPI.Web/Framework/RewriteSubdomainRule.cs
deleted file mode 100644
index 5a56844f..00000000
--- a/src/SMAPI.Web/Framework/RewriteSubdomainRule.cs
+++ /dev/null
@@ -1,30 +0,0 @@
-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}";
-        }
-    }
-}