From 65f0fa625575592639a24a9b39330e4a6b500f22 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Fri, 27 Oct 2017 19:36:31 -0400
Subject: add scaffolding for web UI (#358)

---
 src/SMAPI.Web/Controllers/ModsApiController.cs | 162 +++++++++++++++++++++++++
 src/SMAPI.Web/Controllers/ModsController.cs    | 162 -------------------------
 src/SMAPI.Web/Startup.cs                       |   1 +
 src/SMAPI.Web/Views/Shared/_Layout.cshtml      |  29 +++++
 src/SMAPI.Web/Views/_ViewStart.cshtml          |   3 +
 src/SMAPI.Web/wwwroot/Content/main.css         | 107 ++++++++++++++++
 src/SMAPI.Web/wwwroot/Content/sidebar-bg.gif   | Bin 0 -> 1104 bytes
 src/SMAPI.Web/wwwroot/favicon.ico              | Bin 0 -> 15086 bytes
 8 files changed, 302 insertions(+), 162 deletions(-)
 create mode 100644 src/SMAPI.Web/Controllers/ModsApiController.cs
 delete mode 100644 src/SMAPI.Web/Controllers/ModsController.cs
 create mode 100644 src/SMAPI.Web/Views/Shared/_Layout.cshtml
 create mode 100644 src/SMAPI.Web/Views/_ViewStart.cshtml
 create mode 100644 src/SMAPI.Web/wwwroot/Content/main.css
 create mode 100644 src/SMAPI.Web/wwwroot/Content/sidebar-bg.gif
 create mode 100644 src/SMAPI.Web/wwwroot/favicon.ico

(limited to 'src')

diff --git a/src/SMAPI.Web/Controllers/ModsApiController.cs b/src/SMAPI.Web/Controllers/ModsApiController.cs
new file mode 100644
index 00000000..1db5b59e
--- /dev/null
+++ b/src/SMAPI.Web/Controllers/ModsApiController.cs
@@ -0,0 +1,162 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text.RegularExpressions;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Caching.Memory;
+using Microsoft.Extensions.Options;
+using StardewModdingAPI.Common.Models;
+using StardewModdingAPI.Web.Framework.ConfigModels;
+using StardewModdingAPI.Web.Framework.ModRepositories;
+
+namespace StardewModdingAPI.Web.Controllers
+{
+    /// <summary>Provides an API to perform mod update checks.</summary>
+    [Produces("application/json")]
+    [Route("api/{version:semanticVersion}/mods")]
+    internal class ModsApiController : Controller
+    {
+        /*********
+        ** Properties
+        *********/
+        /// <summary>The mod repositories which provide mod metadata.</summary>
+        private readonly IDictionary<string, IModRepository> Repositories;
+
+        /// <summary>The cache in which to store mod metadata.</summary>
+        private readonly IMemoryCache Cache;
+
+        /// <summary>The number of minutes update checks should be cached before refetching them.</summary>
+        private readonly int CacheMinutes;
+
+        /// <summary>A regex which matches SMAPI-style semantic version.</summary>
+        private readonly string VersionRegex;
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="cache">The cache in which to store mod metadata.</param>
+        /// <param name="configProvider">The config settings for mod update checks.</param>
+        public ModsApiController(IMemoryCache cache, IOptions<ModUpdateCheckConfig> configProvider)
+        {
+            ModUpdateCheckConfig config = configProvider.Value;
+
+            this.Cache = cache;
+            this.CacheMinutes = config.CacheMinutes;
+            this.VersionRegex = config.SemanticVersionRegex;
+
+            string version = this.GetType().Assembly.GetName().Version.ToString(3);
+            this.Repositories =
+                new IModRepository[]
+                {
+                    new ChucklefishRepository(
+                        vendorKey: config.ChucklefishKey,
+                        userAgent: string.Format(config.ChucklefishUserAgent, version),
+                        baseUrl: config.ChucklefishBaseUrl,
+                        modPageUrlFormat: config.ChucklefishModPageUrlFormat
+                    ),
+                    new GitHubRepository(
+                        vendorKey: config.GitHubKey,
+                        baseUrl: config.GitHubBaseUrl,
+                        releaseUrlFormat: config.GitHubReleaseUrlFormat,
+                        userAgent: string.Format(config.GitHubUserAgent, version),
+                        acceptHeader: config.GitHubAcceptHeader,
+                        username: config.GitHubUsername,
+                        password: config.GitHubPassword
+                    ),
+                    new NexusRepository(
+                        vendorKey: config.NexusKey,
+                        userAgent: config.NexusUserAgent,
+                        baseUrl: config.NexusBaseUrl,
+                        modUrlFormat: config.NexusModUrlFormat
+                    )
+                }
+                .ToDictionary(p => p.VendorKey, StringComparer.CurrentCultureIgnoreCase);
+        }
+
+        /// <summary>Fetch version metadata for the given mods.</summary>
+        /// <param name="modKeys">The namespaced mod keys to search as a comma-delimited array.</param>
+        [HttpGet]
+        public async Task<IDictionary<string, ModInfoModel>> GetAsync(string modKeys)
+        {
+            string[] modKeysArray = modKeys?.Split(',').ToArray();
+            if (modKeysArray == null || !modKeysArray.Any())
+                return new Dictionary<string, ModInfoModel>();
+
+            return await this.PostAsync(new ModSearchModel(modKeysArray));
+        }
+
+        /// <summary>Fetch version metadata for the given mods.</summary>
+        /// <param name="search">The mod search criteria.</param>
+        [HttpPost]
+        public async Task<IDictionary<string, ModInfoModel>> PostAsync([FromBody] ModSearchModel search)
+        {
+            // sort & filter keys
+            string[] modKeys = (search?.ModKeys?.ToArray() ?? new string[0])
+                .Distinct(StringComparer.CurrentCultureIgnoreCase)
+                .OrderBy(p => p, StringComparer.CurrentCultureIgnoreCase)
+                .ToArray();
+
+            // fetch mod info
+            IDictionary<string, ModInfoModel> result = new Dictionary<string, ModInfoModel>(StringComparer.CurrentCultureIgnoreCase);
+            foreach (string modKey in modKeys)
+            {
+                // parse mod key
+                if (!this.TryParseModKey(modKey, out string vendorKey, out string modID))
+                {
+                    result[modKey] = new ModInfoModel("The mod key isn't in a valid format. It should contain the site key and mod ID like 'Nexus:541'.");
+                    continue;
+                }
+
+                // get matching repository
+                if (!this.Repositories.TryGetValue(vendorKey, out IModRepository repository))
+                {
+                    result[modKey] = new ModInfoModel($"There's no mod site with key '{vendorKey}'. Expected one of [{string.Join(", ", this.Repositories.Keys)}].");
+                    continue;
+                }
+
+                // fetch mod info
+                result[modKey] = await this.Cache.GetOrCreateAsync($"{repository.VendorKey}:{modID}".ToLower(), async entry =>
+                {
+                    entry.AbsoluteExpiration = DateTimeOffset.UtcNow.AddMinutes(this.CacheMinutes);
+
+                    ModInfoModel info = await repository.GetModInfoAsync(modID);
+                    if (info.Error == null && (info.Version == null || !Regex.IsMatch(info.Version, this.VersionRegex, RegexOptions.CultureInvariant | RegexOptions.IgnoreCase)))
+                        info = new ModInfoModel(info.Name, info.Version, info.Url, info.Version == null ? "Mod has no version number." : $"Mod has invalid semantic version '{info.Version}'.");
+
+                    return info;
+                });
+            }
+
+            return result;
+        }
+
+
+        /*********
+        ** Private methods
+        *********/
+        /// <summary>Parse a namespaced mod ID.</summary>
+        /// <param name="raw">The raw mod ID to parse.</param>
+        /// <param name="vendorKey">The parsed vendor key.</param>
+        /// <param name="modID">The parsed mod ID.</param>
+        /// <returns>Returns whether the value could be parsed.</returns>
+        private bool TryParseModKey(string raw, out string vendorKey, out string modID)
+        {
+            // split parts
+            string[] parts = raw?.Split(':');
+            if (parts == null || parts.Length != 2)
+            {
+                vendorKey = null;
+                modID = null;
+                return false;
+            }
+
+            // parse
+            vendorKey = parts[0].Trim();
+            modID = parts[1].Trim();
+            return true;
+        }
+    }
+}
diff --git a/src/SMAPI.Web/Controllers/ModsController.cs b/src/SMAPI.Web/Controllers/ModsController.cs
deleted file mode 100644
index a671ddca..00000000
--- a/src/SMAPI.Web/Controllers/ModsController.cs
+++ /dev/null
@@ -1,162 +0,0 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text.RegularExpressions;
-using System.Threading.Tasks;
-using Microsoft.AspNetCore.Mvc;
-using Microsoft.Extensions.Caching.Memory;
-using Microsoft.Extensions.Options;
-using StardewModdingAPI.Common.Models;
-using StardewModdingAPI.Web.Framework.ConfigModels;
-using StardewModdingAPI.Web.Framework.ModRepositories;
-
-namespace StardewModdingAPI.Web.Controllers
-{
-    /// <summary>Provides an API to perform mod update checks.</summary>
-    [Produces("application/json")]
-    [Route("api/{version:semanticVersion}/[controller]")]
-    internal class ModsController : Controller
-    {
-        /*********
-        ** Properties
-        *********/
-        /// <summary>The mod repositories which provide mod metadata.</summary>
-        private readonly IDictionary<string, IModRepository> Repositories;
-
-        /// <summary>The cache in which to store mod metadata.</summary>
-        private readonly IMemoryCache Cache;
-
-        /// <summary>The number of minutes update checks should be cached before refetching them.</summary>
-        private readonly int CacheMinutes;
-
-        /// <summary>A regex which matches SMAPI-style semantic version.</summary>
-        private readonly string VersionRegex;
-
-
-        /*********
-        ** Public methods
-        *********/
-        /// <summary>Construct an instance.</summary>
-        /// <param name="cache">The cache in which to store mod metadata.</param>
-        /// <param name="configProvider">The config settings for mod update checks.</param>
-        public ModsController(IMemoryCache cache, IOptions<ModUpdateCheckConfig> configProvider)
-        {
-            ModUpdateCheckConfig config = configProvider.Value;
-
-            this.Cache = cache;
-            this.CacheMinutes = config.CacheMinutes;
-            this.VersionRegex = config.SemanticVersionRegex;
-
-            string version = this.GetType().Assembly.GetName().Version.ToString(3);
-            this.Repositories =
-                new IModRepository[]
-                {
-                    new ChucklefishRepository(
-                        vendorKey: config.ChucklefishKey,
-                        userAgent: string.Format(config.ChucklefishUserAgent, version),
-                        baseUrl: config.ChucklefishBaseUrl,
-                        modPageUrlFormat: config.ChucklefishModPageUrlFormat
-                    ),
-                    new GitHubRepository(
-                        vendorKey: config.GitHubKey,
-                        baseUrl: config.GitHubBaseUrl,
-                        releaseUrlFormat: config.GitHubReleaseUrlFormat,
-                        userAgent: string.Format(config.GitHubUserAgent, version),
-                        acceptHeader: config.GitHubAcceptHeader,
-                        username: config.GitHubUsername,
-                        password: config.GitHubPassword
-                    ),
-                    new NexusRepository(
-                        vendorKey: config.NexusKey,
-                        userAgent: config.NexusUserAgent,
-                        baseUrl: config.NexusBaseUrl,
-                        modUrlFormat: config.NexusModUrlFormat
-                    )
-                }
-                .ToDictionary(p => p.VendorKey, StringComparer.CurrentCultureIgnoreCase);
-        }
-
-        /// <summary>Fetch version metadata for the given mods.</summary>
-        /// <param name="modKeys">The namespaced mod keys to search as a comma-delimited array.</param>
-        [HttpGet]
-        public async Task<IDictionary<string, ModInfoModel>> GetAsync(string modKeys)
-        {
-            string[] modKeysArray = modKeys?.Split(',').ToArray();
-            if (modKeysArray == null || !modKeysArray.Any())
-                return new Dictionary<string, ModInfoModel>();
-
-            return await this.PostAsync(new ModSearchModel(modKeysArray));
-        }
-
-        /// <summary>Fetch version metadata for the given mods.</summary>
-        /// <param name="search">The mod search criteria.</param>
-        [HttpPost]
-        public async Task<IDictionary<string, ModInfoModel>> PostAsync([FromBody] ModSearchModel search)
-        {
-            // sort & filter keys
-            string[] modKeys = (search?.ModKeys?.ToArray() ?? new string[0])
-                .Distinct(StringComparer.CurrentCultureIgnoreCase)
-                .OrderBy(p => p, StringComparer.CurrentCultureIgnoreCase)
-                .ToArray();
-
-            // fetch mod info
-            IDictionary<string, ModInfoModel> result = new Dictionary<string, ModInfoModel>(StringComparer.CurrentCultureIgnoreCase);
-            foreach (string modKey in modKeys)
-            {
-                // parse mod key
-                if (!this.TryParseModKey(modKey, out string vendorKey, out string modID))
-                {
-                    result[modKey] = new ModInfoModel("The mod key isn't in a valid format. It should contain the site key and mod ID like 'Nexus:541'.");
-                    continue;
-                }
-
-                // get matching repository
-                if (!this.Repositories.TryGetValue(vendorKey, out IModRepository repository))
-                {
-                    result[modKey] = new ModInfoModel($"There's no mod site with key '{vendorKey}'. Expected one of [{string.Join(", ", this.Repositories.Keys)}].");
-                    continue;
-                }
-
-                // fetch mod info
-                result[modKey] = await this.Cache.GetOrCreateAsync($"{repository.VendorKey}:{modID}".ToLower(), async entry =>
-                {
-                    entry.AbsoluteExpiration = DateTimeOffset.UtcNow.AddMinutes(this.CacheMinutes);
-
-                    ModInfoModel info = await repository.GetModInfoAsync(modID);
-                    if (info.Error == null && (info.Version == null || !Regex.IsMatch(info.Version, this.VersionRegex, RegexOptions.CultureInvariant | RegexOptions.IgnoreCase)))
-                        info = new ModInfoModel(info.Name, info.Version, info.Url, info.Version == null ? "Mod has no version number." : $"Mod has invalid semantic version '{info.Version}'.");
-
-                    return info;
-                });
-            }
-
-            return result;
-        }
-
-
-        /*********
-        ** Private methods
-        *********/
-        /// <summary>Parse a namespaced mod ID.</summary>
-        /// <param name="raw">The raw mod ID to parse.</param>
-        /// <param name="vendorKey">The parsed vendor key.</param>
-        /// <param name="modID">The parsed mod ID.</param>
-        /// <returns>Returns whether the value could be parsed.</returns>
-        private bool TryParseModKey(string raw, out string vendorKey, out string modID)
-        {
-            // split parts
-            string[] parts = raw?.Split(':');
-            if (parts == null || parts.Length != 2)
-            {
-                vendorKey = null;
-                modID = null;
-                return false;
-            }
-
-            // parse
-            vendorKey = parts[0].Trim();
-            modID = parts[1].Trim();
-            return true;
-        }
-    }
-}
diff --git a/src/SMAPI.Web/Startup.cs b/src/SMAPI.Web/Startup.cs
index eaf14983..abce8f28 100644
--- a/src/SMAPI.Web/Startup.cs
+++ b/src/SMAPI.Web/Startup.cs
@@ -64,6 +64,7 @@ namespace StardewModdingAPI.Web
             loggerFactory.AddDebug();
             app
                 .UseRewriter(new RewriteOptions().Add(new RewriteSubdomainRule())) // convert subdomain.smapi.io => smapi.io/subdomain for routing
+                .UseStaticFiles() // wwwroot folder
                 .UseMvc();
         }
     }
diff --git a/src/SMAPI.Web/Views/Shared/_Layout.cshtml b/src/SMAPI.Web/Views/Shared/_Layout.cshtml
new file mode 100644
index 00000000..89b1866c
--- /dev/null
+++ b/src/SMAPI.Web/Views/Shared/_Layout.cshtml
@@ -0,0 +1,29 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <meta charset="utf-8" />
+    <title>@ViewData["Title"] - SMAPI.io</title>
+    <link rel="stylesheet" href="~/Content/main.css" />
+</head>
+<body>
+    <div id="sidebar">
+        <h4>SMAPI</h4>
+        <ul>
+            <li><a href="https://stardewvalleywiki.com/Modding:Index">FAQs & guides</a></li>
+            <li><a href="https://github.com/pathoschild/SMAPI/releases">Download SMAPI</a></li>
+            <li><a href="https://discord.gg/stardewvalley">Get help on Discord</a></li>
+        </ul>
+    </div>
+    <div id="content-column">
+        <div id="content">
+            <h1>@ViewData["Title"]</h1>
+            @RenderBody()
+        </div>
+        <div id="footer">
+            <div id="license">
+                Hi! You can <a href="https://github.com/pathoschild/SMAPI" title="view source">view the source code</a> or <a href="https://github.com/pathoschild/SMAPI/issues" title="report issue">report a bug or suggestion</a>.
+            </div>
+        </div>
+    </div>
+</body>
+</html>
diff --git a/src/SMAPI.Web/Views/_ViewStart.cshtml b/src/SMAPI.Web/Views/_ViewStart.cshtml
new file mode 100644
index 00000000..a5f10045
--- /dev/null
+++ b/src/SMAPI.Web/Views/_ViewStart.cshtml
@@ -0,0 +1,3 @@
+@{
+    Layout = "_Layout";
+}
diff --git a/src/SMAPI.Web/wwwroot/Content/main.css b/src/SMAPI.Web/wwwroot/Content/main.css
new file mode 100644
index 00000000..c8ce8d33
--- /dev/null
+++ b/src/SMAPI.Web/wwwroot/Content/main.css
@@ -0,0 +1,107 @@
+/* tags */
+html {
+    height: 100%;
+}
+
+body {
+    height: 100%;
+    font-family: sans-serif;
+}
+
+h1, h2, h3 {
+    font-weight: bold;
+    margin: 0.2em 0 0.1em 0;
+    padding-top: .5em;
+}
+
+h1 {
+    font-size: 1.5em;
+    color: #888;
+    margin-bottom: 0;
+}
+
+h2 {
+    font-size: 1.5em;
+    border-bottom: 1px solid #AAA;
+}
+
+h3 {
+    font-size: 1.2em;
+    border-bottom: 1px solid #AAA;
+    width: 50%;
+}
+
+a {
+    color: #006;
+}
+
+/* content */
+#content-column {
+    position: absolute;
+    top: 1em;
+    left: 10em;
+}
+
+#content {
+    min-height: 140px;
+    padding: 0 1em 1em 1em;
+    border-left: 1px solid #CCC;
+    background: #FFF;
+    font-size: 0.9em;
+}
+
+#content p {
+    max-width: 55em;
+}
+
+.section {
+    border: 1px solid #CCC;
+    padding: 0.5em;
+    margin-bottom: 1em;
+}
+
+/* sidebar */
+#sidebar {
+    margin-top: 3em;
+    min-height: 75%;
+    width: 12em;
+    background: url("sidebar-bg.gif") no-repeat top right;
+    color: #666;
+}
+
+#sidebar h4 {
+    margin: 0 0 0.2em 0;
+    width: 10em;
+    border-bottom: 1px solid #CCC;
+    font-size: 0.8em;
+    font-weight: normal;
+}
+
+#sidebar a {
+    color: #77B;
+    border: 0;
+}
+
+#sidebar ul, #sidebar li {
+    margin: 0;
+    padding: 0;
+    list-style: none none;
+    font-size: 0.9em;
+    color: #888;
+}
+
+#sidebar li {
+    margin-left: 1em;
+}
+
+/* footer */
+#footer {
+    margin: 1em;
+    padding: 1em;
+    font-size: 0.6em;
+    color: gray;
+}
+
+#footer a {
+    color: #669;
+}
diff --git a/src/SMAPI.Web/wwwroot/Content/sidebar-bg.gif b/src/SMAPI.Web/wwwroot/Content/sidebar-bg.gif
new file mode 100644
index 00000000..48e9af5a
Binary files /dev/null and b/src/SMAPI.Web/wwwroot/Content/sidebar-bg.gif differ
diff --git a/src/SMAPI.Web/wwwroot/favicon.ico b/src/SMAPI.Web/wwwroot/favicon.ico
new file mode 100644
index 00000000..587a6e74
Binary files /dev/null and b/src/SMAPI.Web/wwwroot/favicon.ico differ
-- 
cgit