summaryrefslogtreecommitdiff
path: root/src/StardewModdingAPI/Framework/Models/ModCompatibilityID.cs
blob: 98e70116be198dae1ec1804f1e31ea42a008e28b (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
using System;
using Newtonsoft.Json;

namespace StardewModdingAPI.Framework.Models
{
    /// <summary>Uniquely identifies a mod for compatibility checks.</summary>
    internal class ModCompatibilityID
    {
        /*********
        ** Accessors
        *********/
        /// <summary>The unique mod ID.</summary>
        public string ID { get; set; }

        /// <summary>The mod name to disambiguate non-unique IDs, or <c>null</c> to ignore the mod name.</summary>
        public string Name { get; set; }

        /// <summary>The author name to disambiguate non-unique IDs, or <c>null</c> to ignore the author.</summary>
        public string Author { get; set; }


        /*********
        ** Public methods
        *********/
        /// <summary>Construct an instance.</summary>
        public ModCompatibilityID() { }

        /// <summary>Construct an instance.</summary>
        /// <param name="data">The mod ID or a JSON string matching the <see cref="ModCompatibilityID"/> fields.</param>
        public ModCompatibilityID(string data)
        {
            // JSON can be stuffed into the ID string as a convenience hack to keep JSON mod lists
            // formatted readably. The tradeoff is that the format is a bit more magical, but that's
            // probably acceptable since players aren't meant to edit it. It's also fairly clear what
            // the JSON strings do, if not necessarily how.
            if (data.StartsWith("{"))
                JsonConvert.PopulateObject(data, this);
            else
                this.ID = data;
        }

        /// <summary>Get whether this ID matches a given mod manifest.</summary>
        /// <param name="id">The mod's unique ID, or a substitute ID if it isn't set in the manifest.</param>
        /// <param name="manifest">The manifest to check.</param>
        public bool Matches(string id, IManifest manifest)
        {
            return
                this.ID.Equals(id, StringComparison.InvariantCultureIgnoreCase)
                && (
                    this.Author == null
                    || this.Author.Equals(manifest.Author, StringComparison.InvariantCultureIgnoreCase)
                    || (manifest.ExtraFields.ContainsKey("Authour") && this.Author.Equals(manifest.ExtraFields["Authour"].ToString(), StringComparison.InvariantCultureIgnoreCase))
                )
                && (this.Name == null || this.Name.Equals(manifest.Name, StringComparison.InvariantCultureIgnoreCase));
        }
    }
}