summaryrefslogtreecommitdiff
path: root/src/StardewModdingAPI/Framework/AssemblyRewriting/CacheEntry.cs
blob: 4c3b86fef0e6d9bb300dfed3f949250a58b60504 (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
using System.IO;
using StardewModdingAPI.AssemblyRewriters;

namespace StardewModdingAPI.Framework.AssemblyRewriting
{
    /// <summary>Represents cached metadata for a rewritten assembly.</summary>
    internal class CacheEntry
    {
        /*********
        ** Accessors
        *********/
        /// <summary>The MD5 hash for the original assembly.</summary>
        public readonly string Hash;

        /// <summary>The SMAPI version used to rewrite the assembly.</summary>
        public readonly string ApiVersion;

        /// <summary>The target platform.</summary>
        public readonly Platform Platform;

        /// <summary>The <see cref="System.Environment.MachineName"/> value for the machine used to rewrite the assembly.</summary>
        public readonly string MachineName;

        /// <summary>Whether to use the cached assembly instead of the original assembly.</summary>
        public readonly bool UseCachedAssembly;


        /*********
        ** Public methods
        *********/
        /// <summary>Construct an instance.</summary>
        /// <param name="hash">The MD5 hash for the original assembly.</param>
        /// <param name="apiVersion">The SMAPI version used to rewrite the assembly.</param>
        /// <param name="platform">The target platform.</param>
        /// <param name="machineName">The <see cref="System.Environment.MachineName"/> value for the machine used to rewrite the assembly.</param>
        /// <param name="useCachedAssembly">Whether to use the cached assembly instead of the original assembly.</param>
        public CacheEntry(string hash, string apiVersion, Platform platform, string machineName, bool useCachedAssembly)
        {
            this.Hash = hash;
            this.ApiVersion = apiVersion;
            this.Platform = platform;
            this.MachineName = machineName;
            this.UseCachedAssembly = useCachedAssembly;
        }

        /// <summary>Get whether the cache entry is up-to-date for the given assembly hash.</summary>
        /// <param name="paths">The paths for the cached assembly.</param>
        /// <param name="hash">The MD5 hash of the original assembly.</param>
        /// <param name="currentVersion">The current SMAPI version.</param>
        /// <param name="platform">The target platform.</param>
        /// <param name="machineName">The <see cref="System.Environment.MachineName"/> value for the machine reading the assembly.</param>
        public bool IsUpToDate(CachePaths paths, string hash, ISemanticVersion currentVersion, Platform platform, string machineName)
        {
            return hash == this.Hash
                && this.ApiVersion == currentVersion.ToString()
                && this.Platform == platform
                && this.MachineName == machineName
                && (!this.UseCachedAssembly || File.Exists(paths.Assembly));
        }
    }
}