summaryrefslogtreecommitdiff
path: root/src/SMAPI.Web/Framework/Caching/Mods/ModCacheMemoryRepository.cs
blob: 338562d85cd29ddf37aeda5e61501c2824fd76f0 (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
71
72
73
74
75
76
77
78
79
80
81
82
#nullable disable

using System;
using System.Collections.Generic;
using System.Linq;
using StardewModdingAPI.Toolkit.Framework.UpdateData;

namespace StardewModdingAPI.Web.Framework.Caching.Mods
{
    /// <summary>Manages cached mod data in-memory.</summary>
    internal class ModCacheMemoryRepository : BaseCacheRepository, IModCacheRepository
    {
        /*********
        ** Fields
        *********/
        /// <summary>The cached mod data indexed by <c>{site key}:{ID}</c>.</summary>
        private readonly IDictionary<string, Cached<IModPage>> Mods = new Dictionary<string, Cached<IModPage>>(StringComparer.OrdinalIgnoreCase);


        /*********
        ** Public methods
        *********/
        /// <summary>Get the cached mod data.</summary>
        /// <param name="site">The mod site to search.</param>
        /// <param name="id">The mod's unique ID within the <paramref name="site"/>.</param>
        /// <param name="mod">The fetched mod.</param>
        /// <param name="markRequested">Whether to update the mod's 'last requested' date.</param>
        public bool TryGetMod(ModSiteKey site, string id, out Cached<IModPage> mod, bool markRequested = true)
        {
            // get mod
            if (!this.Mods.TryGetValue(this.GetKey(site, id), out var cachedMod))
            {
                mod = null;
                return false;
            }

            // bump 'last requested'
            if (markRequested)
                cachedMod.LastRequested = DateTimeOffset.UtcNow;

            mod = cachedMod;
            return true;
        }

        /// <summary>Save data fetched for a mod.</summary>
        /// <param name="site">The mod site on which the mod is found.</param>
        /// <param name="id">The mod's unique ID within the <paramref name="site"/>.</param>
        /// <param name="mod">The mod data.</param>
        public void SaveMod(ModSiteKey site, string id, IModPage mod)
        {
            string key = this.GetKey(site, id);
            this.Mods[key] = new Cached<IModPage>(mod);
        }

        /// <summary>Delete data for mods which haven't been requested within a given time limit.</summary>
        /// <param name="age">The minimum age for which to remove mods.</param>
        public void RemoveStaleMods(TimeSpan age)
        {
            DateTimeOffset minDate = DateTimeOffset.UtcNow.Subtract(age);

            string[] staleKeys = this.Mods
                .Where(p => p.Value.LastRequested < minDate)
                .Select(p => p.Key)
                .ToArray();

            foreach (string key in staleKeys)
                this.Mods.Remove(key);
        }


        /*********
        ** Private methods
        *********/
        /// <summary>Get a cache key.</summary>
        /// <param name="site">The mod site.</param>
        /// <param name="id">The mod ID.</param>
        private string GetKey(ModSiteKey site, string id)
        {
            return $"{site}:{id.Trim()}".ToLower();
        }
    }
}