summaryrefslogtreecommitdiff
path: root/src/SMAPI.Web/Controllers/ModsController.cs
blob: b621ded0aa9e1e222bf48d654cab32c66709b2f0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
using System.Linq;
using System.Text.RegularExpressions;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Options;
using StardewModdingAPI.Web.Framework.Caching.Wiki;
using StardewModdingAPI.Web.Framework.ConfigModels;
using StardewModdingAPI.Web.ViewModels;

namespace StardewModdingAPI.Web.Controllers
{
    /// <summary>Provides user-friendly info about SMAPI mods.</summary>
    internal class ModsController : Controller
    {
        /*********
        ** Fields
        *********/
        /// <summary>The cache in which to store mod metadata.</summary>
        private readonly IWikiCacheRepository Cache;

        /// <summary>The number of minutes before which wiki data should be considered old.</summary>
        private readonly int StaleMinutes;


        /*********
        ** 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(IWikiCacheRepository cache, IOptions<ModCompatibilityListConfig> configProvider)
        {
            ModCompatibilityListConfig config = configProvider.Value;

            this.Cache = cache;
            this.StaleMinutes = config.StaleMinutes;
        }

        /// <summary>Display information for all mods.</summary>
        [HttpGet]
        [Route("mods")]
        public ViewResult Index()
        {
            return this.View("Index", this.FetchData());
        }


        /*********
        ** Private methods
        *********/
        /// <summary>Asynchronously fetch mod metadata from the wiki.</summary>
        public ModListModel FetchData()
        {
            // fetch cached data
            if (!this.Cache.TryGetWikiMetadata(out CachedWikiMetadata metadata))
                return new ModListModel();

            // build model
            return new ModListModel(
                stableVersion: metadata.StableVersion,
                betaVersion: metadata.BetaVersion,
                mods: this.Cache
                    .GetWikiMods()
                    .Select(mod => new ModModel(mod.GetModel()))
                    .OrderBy(p => Regex.Replace(p.Name.ToLower(), "[^a-z0-9]", "")), // ignore case, spaces, and special characters when sorting
                lastUpdated: metadata.LastUpdated,
                isStale: this.Cache.IsStale(metadata.LastUpdated, this.StaleMinutes)
            );
        }
    }
}