Merge branch 'develop' into stable

1 files changed, 193 insertions, 86 deletions

diff --git a/src/SMAPI.Web/Controllers/ModsApiController.cs b/src/SMAPI.Web/Controllers/ModsApiController.cs
index 7e6f592c..fe220eb5 100644
--- a/src/SMAPI.Web/Controllers/ModsApiController.cs
+++ b/src/SMAPI.Web/Controllers/ModsApiController.cs
@@ -2,18 +2,19 @@ using System;
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
-using System.Text.RegularExpressions;
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.AspNetCore.Mvc;
-using Microsoft.Extensions.Caching.Memory;
 using Microsoft.Extensions.Options;
 using StardewModdingAPI.Toolkit;
 using StardewModdingAPI.Toolkit.Framework.Clients.WebApi;
 using StardewModdingAPI.Toolkit.Framework.Clients.Wiki;
 using StardewModdingAPI.Toolkit.Framework.ModData;
 using StardewModdingAPI.Toolkit.Framework.UpdateData;
+using StardewModdingAPI.Web.Framework.Caching.Mods;
+using StardewModdingAPI.Web.Framework.Caching.Wiki;
 using StardewModdingAPI.Web.Framework.Clients.Chucklefish;
+using StardewModdingAPI.Web.Framework.Clients.CurseForge;
 using StardewModdingAPI.Web.Framework.Clients.GitHub;
 using StardewModdingAPI.Web.Framework.Clients.ModDrop;
 using StardewModdingAPI.Web.Framework.Clients.Nexus;
@@ -33,8 +34,11 @@ namespace StardewModdingAPI.Web.Controllers
         /// <summary>The mod repositories which provide mod metadata.</summary>
         private readonly IDictionary<ModRepositoryKey, IModRepository> Repositories;
 
-        /// <summary>The cache in which to store mod metadata.</summary>
-        private readonly IMemoryCache Cache;
+        /// <summary>The cache in which to store wiki data.</summary>
+        private readonly IWikiCacheRepository WikiCache;
+
+        /// <summary>The cache in which to store mod data.</summary>
+        private readonly IModCacheRepository ModCache;
 
         /// <summary>The number of minutes successful update checks should be cached before refetching them.</summary>
         private readonly int SuccessCacheMinutes;
@@ -42,9 +46,6 @@ namespace StardewModdingAPI.Web.Controllers
         /// <summary>The number of minutes failed update checks should be cached before refetching them.</summary>
         private readonly int ErrorCacheMinutes;
 
-        /// <summary>A regex which matches SMAPI-style semantic version.</summary>
-        private readonly string VersionRegex;
-
         /// <summary>The internal mod metadata list.</summary>
         private readonly ModDatabase ModDatabase;
 
@@ -57,26 +58,29 @@ namespace StardewModdingAPI.Web.Controllers
         *********/
         /// <summary>Construct an instance.</summary>
         /// <param name="environment">The web hosting environment.</param>
-        /// <param name="cache">The cache in which to store mod metadata.</param>
+        /// <param name="wikiCache">The cache in which to store wiki data.</param>
+        /// <param name="modCache">The cache in which to store mod metadata.</param>
         /// <param name="configProvider">The config settings for mod update checks.</param>
         /// <param name="chucklefish">The Chucklefish API client.</param>
+        /// <param name="curseForge">The CurseForge API client.</param>
         /// <param name="github">The GitHub API client.</param>
         /// <param name="modDrop">The ModDrop API client.</param>
         /// <param name="nexus">The Nexus API client.</param>
-        public ModsApiController(IHostingEnvironment environment, IMemoryCache cache, IOptions<ModUpdateCheckConfig> configProvider, IChucklefishClient chucklefish, IGitHubClient github, IModDropClient modDrop, INexusClient nexus)
+        public ModsApiController(IHostingEnvironment environment, IWikiCacheRepository wikiCache, IModCacheRepository modCache, IOptions<ModUpdateCheckConfig> configProvider, IChucklefishClient chucklefish, ICurseForgeClient curseForge, IGitHubClient github, IModDropClient modDrop, INexusClient nexus)
         {
-            this.ModDatabase = new ModToolkit().GetModDatabase(Path.Combine(environment.WebRootPath, "StardewModdingAPI.metadata.json"));
+            this.ModDatabase = new ModToolkit().GetModDatabase(Path.Combine(environment.WebRootPath, "SMAPI.metadata.json"));
             ModUpdateCheckConfig config = configProvider.Value;
             this.CompatibilityPageUrl = config.CompatibilityPageUrl;
 
-            this.Cache = cache;
+            this.WikiCache = wikiCache;
+            this.ModCache = modCache;
             this.SuccessCacheMinutes = config.SuccessCacheMinutes;
             this.ErrorCacheMinutes = config.ErrorCacheMinutes;
-            this.VersionRegex = config.SemanticVersionRegex;
             this.Repositories =
                 new IModRepository[]
                 {
                     new ChucklefishRepository(chucklefish),
+                    new CurseForgeRepository(curseForge),
                     new GitHubRepository(github),
                     new ModDropRepository(modDrop),
                     new NexusRepository(nexus)
@@ -86,21 +90,42 @@ namespace StardewModdingAPI.Web.Controllers
 
         /// <summary>Fetch version metadata for the given mods.</summary>
         /// <param name="model">The mod search criteria.</param>
+        /// <param name="version">The requested API version.</param>
         [HttpPost]
-        public async Task<IEnumerable<ModEntryModel>> PostAsync([FromBody] ModSearchModel model)
+        public async Task<IEnumerable<ModEntryModel>> PostAsync([FromBody] ModSearchModel model, [FromRoute] string version)
         {
             if (model?.Mods == null)
                 return new ModEntryModel[0];
 
+            bool legacyMode = SemanticVersion.TryParse(version, out ISemanticVersion parsedVersion) && parsedVersion.IsOlderThan("3.0.0-beta.20191109");
+
             // fetch wiki data
-            WikiModEntry[] wikiData = await this.GetWikiDataAsync();
+            WikiModEntry[] wikiData = this.WikiCache.GetWikiMods().Select(p => p.GetModel()).ToArray();
             IDictionary<string, ModEntryModel> mods = new Dictionary<string, ModEntryModel>(StringComparer.CurrentCultureIgnoreCase);
             foreach (ModSearchEntryModel mod in model.Mods)
             {
                 if (string.IsNullOrWhiteSpace(mod.ID))
                     continue;
 
-                ModEntryModel result = await this.GetModData(mod, wikiData, model.IncludeExtendedMetadata);
+                ModEntryModel result = await this.GetModData(mod, wikiData, model.IncludeExtendedMetadata || legacyMode, model.ApiVersion);
+                if (legacyMode)
+                {
+                    result.Main = result.Metadata.Main;
+                    result.Optional = result.Metadata.Optional;
+                    result.Unofficial = result.Metadata.Unofficial;
+                    result.UnofficialForBeta = result.Metadata.UnofficialForBeta;
+                    result.HasBetaInfo = result.Metadata.BetaCompatibilityStatus != null;
+                    result.SuggestedUpdate = null;
+                    if (!model.IncludeExtendedMetadata)
+                        result.Metadata = null;
+                }
+                else if (!model.IncludeExtendedMetadata && (model.ApiVersion == null || mod.InstalledVersion == null))
+                {
+                    var errors = new List<string>(result.Errors);
+                    errors.Add($"This API can't suggest an update because {nameof(model.ApiVersion)} or {nameof(mod.InstalledVersion)} are null, and you didn't specify {nameof(model.IncludeExtendedMetadata)} to get other info. See the SMAPI technical docs for usage.");
+                    result.Errors = errors.ToArray();
+                }
+
                 mods[mod.ID] = result;
             }
 
@@ -116,19 +141,31 @@ namespace StardewModdingAPI.Web.Controllers
         /// <param name="search">The mod data to match.</param>
         /// <param name="wikiData">The wiki data.</param>
         /// <param name="includeExtendedMetadata">Whether to include extended metadata for each mod.</param>
+        /// <param name="apiVersion">The SMAPI version installed by the player.</param>
         /// <returns>Returns the mod data if found, else <c>null</c>.</returns>
-        private async Task<ModEntryModel> GetModData(ModSearchEntryModel search, WikiModEntry[] wikiData, bool includeExtendedMetadata)
+        private async Task<ModEntryModel> GetModData(ModSearchEntryModel search, WikiModEntry[] wikiData, bool includeExtendedMetadata, ISemanticVersion apiVersion)
         {
-            // crossreference data
+            // cross-reference data
             ModDataRecord record = this.ModDatabase.Get(search.ID);
             WikiModEntry wikiEntry = wikiData.FirstOrDefault(entry => entry.ID.Contains(search.ID.Trim(), StringComparer.InvariantCultureIgnoreCase));
-            string[] updateKeys = this.GetUpdateKeys(search.UpdateKeys, record, wikiEntry).ToArray();
+            UpdateKey[] updateKeys = this.GetUpdateKeys(search.UpdateKeys, record, wikiEntry).ToArray();
 
             // get latest versions
             ModEntryModel result = new ModEntryModel { ID = search.ID };
             IList<string> errors = new List<string>();
-            foreach (string updateKey in updateKeys)
+            ModEntryVersionModel main = null;
+            ModEntryVersionModel optional = null;
+            ModEntryVersionModel unofficial = null;
+            ModEntryVersionModel unofficialForBeta = null;
+            foreach (UpdateKey updateKey in updateKeys)
             {
+                // validate update key
+                if (!updateKey.LooksValid)
+                {
+                    errors.Add($"The update key '{updateKey}' isn't in a valid format. It should contain the site key and mod ID like 'Nexus:541'.");
+                    continue;
+                }
+
                 // fetch data
                 ModInfoModel data = await this.GetInfoForUpdateKeyAsync(updateKey);
                 if (data.Error != null)
@@ -140,76 +177,118 @@ namespace StardewModdingAPI.Web.Controllers
                 // handle main version
                 if (data.Version != null)
                 {
-                    if (!SemanticVersion.TryParse(data.Version, out ISemanticVersion version))
+                    ISemanticVersion version = this.GetMappedVersion(data.Version, wikiEntry?.MapRemoteVersions);
+                    if (version == null)
                     {
                         errors.Add($"The update key '{updateKey}' matches a mod with invalid semantic version '{data.Version}'.");
                         continue;
                     }
 
-                    if (this.IsNewer(version, result.Main?.Version))
-                        result.Main = new ModEntryVersionModel(version, data.Url);
+                    if (this.IsNewer(version, main?.Version))
+                        main = new ModEntryVersionModel(version, data.Url);
                 }
 
                 // handle optional version
                 if (data.PreviewVersion != null)
                 {
-                    if (!SemanticVersion.TryParse(data.PreviewVersion, out ISemanticVersion version))
+                    ISemanticVersion version = this.GetMappedVersion(data.PreviewVersion, wikiEntry?.MapRemoteVersions);
+                    if (version == null)
                     {
                         errors.Add($"The update key '{updateKey}' matches a mod with invalid optional semantic version '{data.PreviewVersion}'.");
                         continue;
                     }
 
-                    if (this.IsNewer(version, result.Optional?.Version))
-                        result.Optional = new ModEntryVersionModel(version, data.Url);
+                    if (this.IsNewer(version, optional?.Version))
+                        optional = new ModEntryVersionModel(version, data.Url);
                 }
             }
 
             // get unofficial version
-            if (wikiEntry?.Compatibility.UnofficialVersion != null && this.IsNewer(wikiEntry.Compatibility.UnofficialVersion, result.Main?.Version) && this.IsNewer(wikiEntry.Compatibility.UnofficialVersion, result.Optional?.Version))
-                result.Unofficial = new ModEntryVersionModel(wikiEntry.Compatibility.UnofficialVersion, $"{this.CompatibilityPageUrl}/#{wikiEntry.Anchor}");
+            if (wikiEntry?.Compatibility.UnofficialVersion != null && this.IsNewer(wikiEntry.Compatibility.UnofficialVersion, main?.Version) && this.IsNewer(wikiEntry.Compatibility.UnofficialVersion, optional?.Version))
+                unofficial = new ModEntryVersionModel(wikiEntry.Compatibility.UnofficialVersion, $"{this.CompatibilityPageUrl}/#{wikiEntry.Anchor}");
 
             // get unofficial version for beta
             if (wikiEntry?.HasBetaInfo == true)
             {
-                result.HasBetaInfo = true;
                 if (wikiEntry.BetaCompatibility.Status == WikiCompatibilityStatus.Unofficial)
                 {
                     if (wikiEntry.BetaCompatibility.UnofficialVersion != null)
                     {
-                        result.UnofficialForBeta = (wikiEntry.BetaCompatibility.UnofficialVersion != null && this.IsNewer(wikiEntry.BetaCompatibility.UnofficialVersion, result.Main?.Version) && this.IsNewer(wikiEntry.BetaCompatibility.UnofficialVersion, result.Optional?.Version))
+                        unofficialForBeta = (wikiEntry.BetaCompatibility.UnofficialVersion != null && this.IsNewer(wikiEntry.BetaCompatibility.UnofficialVersion, main?.Version) && this.IsNewer(wikiEntry.BetaCompatibility.UnofficialVersion, optional?.Version))
                             ? new ModEntryVersionModel(wikiEntry.BetaCompatibility.UnofficialVersion, $"{this.CompatibilityPageUrl}/#{wikiEntry.Anchor}")
                             : null;
                     }
                     else
-                        result.UnofficialForBeta = result.Unofficial;
+                        unofficialForBeta = unofficial;
                 }
             }
 
             // fallback to preview if latest is invalid
-            if (result.Main == null && result.Optional != null)
+            if (main == null && optional != null)
             {
-                result.Main = result.Optional;
-                result.Optional = null;
+                main = optional;
+                optional = null;
             }
 
             // special cases
             if (result.ID == "Pathoschild.SMAPI")
             {
-                if (result.Main != null)
-                    result.Main.Url = "https://smapi.io/";
-                if (result.Optional != null)
-                    result.Optional.Url = "https://smapi.io/";
+                if (main != null)
+                    main.Url = "https://smapi.io/";
+                if (optional != null)
+                    optional.Url = "https://smapi.io/";
+            }
+
+            // get recommended update (if any)
+            ISemanticVersion installedVersion = this.GetMappedVersion(search.InstalledVersion?.ToString(), wikiEntry?.MapLocalVersions);
+            if (apiVersion != null && installedVersion != null)
+            {
+                // get newer versions
+                List<ModEntryVersionModel> updates = new List<ModEntryVersionModel>();
+                if (this.IsRecommendedUpdate(installedVersion, main?.Version, useBetaChannel: true))
+                    updates.Add(main);
+                if (this.IsRecommendedUpdate(installedVersion, optional?.Version, useBetaChannel: installedVersion.IsPrerelease()))
+                    updates.Add(optional);
+                if (this.IsRecommendedUpdate(installedVersion, unofficial?.Version, useBetaChannel: search.IsBroken))
+                    updates.Add(unofficial);
+                if (this.IsRecommendedUpdate(installedVersion, unofficialForBeta?.Version, useBetaChannel: apiVersion.IsPrerelease()))
+                    updates.Add(unofficialForBeta);
+
+                // get newest version
+                ModEntryVersionModel newest = null;
+                foreach (ModEntryVersionModel update in updates)
+                {
+                    if (newest == null || update.Version.IsNewerThan(newest.Version))
+                        newest = update;
+                }
+
+                // set field
+                result.SuggestedUpdate = newest != null
+                    ? new ModEntryVersionModel(newest.Version, newest.Url)
+                    : null;
             }
 
             // add extended metadata
-            if (includeExtendedMetadata && (wikiEntry != null || record != null))
-                result.Metadata = new ModExtendedMetadataModel(wikiEntry, record);
+            if (includeExtendedMetadata)
+                result.Metadata = new ModExtendedMetadataModel(wikiEntry, record, main: main, optional: optional, unofficial: unofficial, unofficialForBeta: unofficialForBeta);
 
             // add result
             result.Errors = errors.ToArray();
             return result;
         }
 
+        /// <summary>Get whether a given version should be offered to the user as an update.</summary>
+        /// <param name="currentVersion">The current semantic version.</param>
+        /// <param name="newVersion">The target semantic version.</param>
+        /// <param name="useBetaChannel">Whether the user enabled the beta channel and should be offered prerelease updates.</param>
+        private bool IsRecommendedUpdate(ISemanticVersion currentVersion, ISemanticVersion newVersion, bool useBetaChannel)
+        {
+            return
+                newVersion != null
+                && newVersion.IsNewerThan(currentVersion)
+                && (useBetaChannel || !newVersion.IsPrerelease());
+        }
+
         /// <summary>Get whether a <paramref name="current"/> version is newer than an <paramref name="other"/> version.</summary>
         /// <param name="current">The current version.</param>
         /// <param name="other">The other version.</param>
@@ -218,60 +297,38 @@ namespace StardewModdingAPI.Web.Controllers
             return current != null && (other == null || other.IsOlderThan(current));
         }
 
-        /// <summary>Get mod data from the wiki compatibility list.</summary>
-        private async Task<WikiModEntry[]> GetWikiDataAsync()
-        {
-            ModToolkit toolkit = new ModToolkit();
-            return await this.Cache.GetOrCreateAsync("_wiki", async entry =>
-            {
-                try
-                {
-                    WikiModEntry[] entries = (await toolkit.GetWikiCompatibilityListAsync()).Mods;
-                    entry.AbsoluteExpiration = DateTimeOffset.UtcNow.AddMinutes(this.SuccessCacheMinutes);
-                    return entries;
-                }
-                catch
-                {
-                    entry.AbsoluteExpiration = DateTimeOffset.UtcNow.AddMinutes(this.ErrorCacheMinutes);
-                    return new WikiModEntry[0];
-                }
-            });
-        }
-
         /// <summary>Get the mod info for an update key.</summary>
         /// <param name="updateKey">The namespaced update key.</param>
-        private async Task<ModInfoModel> GetInfoForUpdateKeyAsync(string updateKey)
+        private async Task<ModInfoModel> GetInfoForUpdateKeyAsync(UpdateKey updateKey)
         {
-            // parse update key
-            UpdateKey parsed = UpdateKey.Parse(updateKey);
-            if (!parsed.LooksValid)
-                return new ModInfoModel($"The update key '{updateKey}' isn't in a valid format. It should contain the site key and mod ID like 'Nexus:541'.");
-
-            // get matching repository
-            if (!this.Repositories.TryGetValue(parsed.Repository, out IModRepository repository))
-                return new ModInfoModel($"There's no mod site with key '{parsed.Repository}'. Expected one of [{string.Join(", ", this.Repositories.Keys)}].");
-
-            // fetch mod info
-            return await this.Cache.GetOrCreateAsync($"{repository.VendorKey}:{parsed.ID}".ToLower(), async entry =>
+            // get mod
+            if (!this.ModCache.TryGetMod(updateKey.Repository, updateKey.ID, out CachedMod mod) || this.ModCache.IsStale(mod.LastUpdated, mod.FetchStatus == RemoteModStatus.TemporaryError ? this.ErrorCacheMinutes : this.SuccessCacheMinutes))
             {
-                ModInfoModel result = await repository.GetModInfoAsync(parsed.ID);
+                // get site
+                if (!this.Repositories.TryGetValue(updateKey.Repository, out IModRepository repository))
+                    return new ModInfoModel().SetError(RemoteModStatus.DoesNotExist, $"There's no mod site with key '{updateKey.Repository}'. Expected one of [{string.Join(", ", this.Repositories.Keys)}].");
+
+                // fetch mod
+                ModInfoModel result = await repository.GetModInfoAsync(updateKey.ID);
                 if (result.Error == null)
                 {
                     if (result.Version == null)
-                        result.Error = $"The update key '{updateKey}' matches a mod with no version number.";
-                    else if (!Regex.IsMatch(result.Version, this.VersionRegex, RegexOptions.CultureInvariant | RegexOptions.IgnoreCase))
-                        result.Error = $"The update key '{updateKey}' matches a mod with invalid semantic version '{result.Version}'.";
+                        result.SetError(RemoteModStatus.InvalidData, $"The update key '{updateKey}' matches a mod with no version number.");
+                    else if (!SemanticVersion.TryParse(result.Version, out _))
+                        result.SetError(RemoteModStatus.InvalidData, $"The update key '{updateKey}' matches a mod with invalid semantic version '{result.Version}'.");
                 }
-                entry.AbsoluteExpiration = DateTimeOffset.UtcNow.AddMinutes(result.Error == null ? this.SuccessCacheMinutes : this.ErrorCacheMinutes);
-                return result;
-            });
+
+                // cache mod
+                this.ModCache.SaveMod(repository.VendorKey, updateKey.ID, result, out mod);
+            }
+            return mod.GetModel();
         }
 
         /// <summary>Get update keys based on the available mod metadata, while maintaining the precedence order.</summary>
         /// <param name="specifiedKeys">The specified update keys.</param>
         /// <param name="record">The mod's entry in SMAPI's internal database.</param>
         /// <param name="entry">The mod's entry in the wiki list.</param>
-        public IEnumerable<string> GetUpdateKeys(string[] specifiedKeys, ModDataRecord record, WikiModEntry entry)
+        private IEnumerable<UpdateKey> GetUpdateKeys(string[] specifiedKeys, ModDataRecord record, WikiModEntry entry)
         {
             IEnumerable<string> GetRaw()
             {
@@ -291,20 +348,70 @@ namespace StardewModdingAPI.Web.Controllers
                 if (entry != null)
                 {
                     if (entry.NexusID.HasValue)
-                        yield return $"Nexus:{entry.NexusID}";
-                    if (entry.ChucklefishID.HasValue)
-                        yield return $"Chucklefish:{entry.ChucklefishID}";
+                        yield return $"{ModRepositoryKey.Nexus}:{entry.NexusID}";
                     if (entry.ModDropID.HasValue)
-                        yield return $"ModDrop:{entry.ModDropID}";
+                        yield return $"{ModRepositoryKey.ModDrop}:{entry.ModDropID}";
+                    if (entry.CurseForgeID.HasValue)
+                        yield return $"{ModRepositoryKey.CurseForge}:{entry.CurseForgeID}";
+                    if (entry.ChucklefishID.HasValue)
+                        yield return $"{ModRepositoryKey.Chucklefish}:{entry.ChucklefishID}";
                 }
             }
 
-            HashSet<string> seen = new HashSet<string>(StringComparer.InvariantCulture);
-            foreach (string key in GetRaw())
+            HashSet<UpdateKey> seen = new HashSet<UpdateKey>();
+            foreach (string rawKey in GetRaw())
             {
-                if (!string.IsNullOrWhiteSpace(key) && seen.Add(key))
+                if (string.IsNullOrWhiteSpace(rawKey))
+                    continue;
+
+                UpdateKey key = UpdateKey.Parse(rawKey);
+                if (seen.Add(key))
                     yield return key;
             }
         }
+
+        /// <summary>Get a semantic local version for update checks.</summary>
+        /// <param name="version">The version to parse.</param>
+        /// <param name="map">A map of version replacements.</param>
+        private ISemanticVersion GetMappedVersion(string version, IDictionary<string, string> map)
+        {
+            // try mapped version
+            string rawNewVersion = this.GetRawMappedVersion(version, map);
+            if (SemanticVersion.TryParse(rawNewVersion, out ISemanticVersion parsedNew))
+                return parsedNew;
+
+            // return original version
+            return SemanticVersion.TryParse(version, out ISemanticVersion parsedOld)
+                ? parsedOld
+                : null;
+        }
+
+        /// <summary>Get a semantic local version for update checks.</summary>
+        /// <param name="version">The version to map.</param>
+        /// <param name="map">A map of version replacements.</param>
+        private string GetRawMappedVersion(string version, IDictionary<string, string> map)
+        {
+            if (version == null || map == null || !map.Any())
+                return version;
+
+            // match exact raw version
+            if (map.ContainsKey(version))
+                return map[version];
+
+            // match parsed version
+            if (SemanticVersion.TryParse(version, out ISemanticVersion parsed))
+            {
+                if (map.ContainsKey(parsed.ToString()))
+                    return map[parsed.ToString()];
+
+                foreach (var pair in map)
+                {
+                    if (SemanticVersion.TryParse(pair.Key, out ISemanticVersion target) && parsed.Equals(target) && SemanticVersion.TryParse(pair.Value, out ISemanticVersion newVersion))
+                        return newVersion.ToString();
+                }
+            }
+
+            return version;
+        }
     }
 }