From 6b26eceb57b8c1bdf245ec02ff979504701ede92 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Thu, 23 Feb 2017 23:36:14 -0500
Subject: move incompatible mod logic into mod registry

---
 src/StardewModdingAPI/Framework/ModRegistry.cs     | 30 ++++++++++++++++
 .../Framework/Models/IncompatibleMod.cs            | 40 +++++++++++++---------
 2 files changed, 54 insertions(+), 16 deletions(-)

(limited to 'src/StardewModdingAPI/Framework')

diff --git a/src/StardewModdingAPI/Framework/ModRegistry.cs b/src/StardewModdingAPI/Framework/ModRegistry.cs
index 209f1928..233deb3c 100644
--- a/src/StardewModdingAPI/Framework/ModRegistry.cs
+++ b/src/StardewModdingAPI/Framework/ModRegistry.cs
@@ -3,6 +3,8 @@ using System.Collections.Generic;
 using System.Diagnostics;
 using System.Linq;
 using System.Reflection;
+using System.Text.RegularExpressions;
+using StardewModdingAPI.Framework.Models;
 
 namespace StardewModdingAPI.Framework
 {
@@ -18,10 +20,21 @@ namespace StardewModdingAPI.Framework
         /// <summary>The friendly mod names treated as deprecation warning sources (assembly full name => mod name).</summary>
         private readonly IDictionary<string, string> ModNamesByAssembly = new Dictionary<string, string>();
 
+        /// <summary>The mod versions which should be disabled due to incompatibility.</summary>
+        private readonly IncompatibleMod[] IncompatibleMods;
+
 
         /*********
         ** Public methods
         *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="incompatibleMods">The mod versions which should be disabled due to incompatibility.</param>
+        public ModRegistry(IEnumerable<IncompatibleMod> incompatibleMods)
+        {
+            this.IncompatibleMods = incompatibleMods.ToArray();
+        }
+
+
         /****
         ** IModRegistry
         ****/
@@ -113,5 +126,22 @@ namespace StardewModdingAPI.Framework
             // no known assembly found
             return null;
         }
+
+        /// <summary>Get a record indicating why a mod is incompatible (if applicable).</summary>
+        /// <param name="manifest">The mod manifest.</param>
+        /// <returns>Returns the incompatibility record if applicable, else <c>null</c>.</returns>
+        internal IncompatibleMod GetIncompatibilityRecord(IManifest manifest)
+        {
+            string key = !string.IsNullOrWhiteSpace(manifest.UniqueID) ? manifest.UniqueID : manifest.EntryDll;
+            return (
+                from mod in this.IncompatibleMods
+                where
+                    mod.ID == key
+                    && (mod.LowerSemanticVersion == null || !manifest.Version.IsOlderThan(mod.LowerSemanticVersion))
+                    && !manifest.Version.IsNewerThan(mod.UpperSemanticVersion)
+                    && (string.IsNullOrWhiteSpace(mod.ForceCompatibleVersion) || !Regex.IsMatch(manifest.Version.ToString(), mod.ForceCompatibleVersion, RegexOptions.IgnoreCase))
+                select mod
+            ).FirstOrDefault();
+        }
     }
 }
\ No newline at end of file
diff --git a/src/StardewModdingAPI/Framework/Models/IncompatibleMod.cs b/src/StardewModdingAPI/Framework/Models/IncompatibleMod.cs
index bcf5639c..29e18ddb 100644
--- a/src/StardewModdingAPI/Framework/Models/IncompatibleMod.cs
+++ b/src/StardewModdingAPI/Framework/Models/IncompatibleMod.cs
@@ -1,4 +1,5 @@
-using System.Text.RegularExpressions;
+using System.Runtime.Serialization;
+using Newtonsoft.Json;
 
 namespace StardewModdingAPI.Framework.Models
 {
@@ -8,6 +9,9 @@ namespace StardewModdingAPI.Framework.Models
         /*********
         ** Accessors
         *********/
+        /****
+        ** From config
+        ****/
         /// <summary>The unique mod ID.</summary>
         public string ID { get; set; }
 
@@ -34,24 +38,28 @@ namespace StardewModdingAPI.Framework.Models
         public string ReasonPhrase { get; set; }
 
 
+        /****
+        ** Injected
+        ****/
+        /// <summary>The semantic version corresponding to <see cref="LowerVersion"/>.</summary>
+        [JsonIgnore]
+        public ISemanticVersion LowerSemanticVersion { get; set; }
+
+        /// <summary>The semantic version corresponding to <see cref="UpperVersion"/>.</summary>
+        [JsonIgnore]
+        public ISemanticVersion UpperSemanticVersion { get; set; }
+
+
         /*********
-        ** Public methods
+        ** Private methods
         *********/
-        /// <summary>Get whether the specified version is compatible according to this metadata.</summary>
-        /// <param name="version">The current version of the matching mod.</param>
-        public bool IsCompatible(ISemanticVersion version)
+        /// <summary>The method called when the model finishes deserialising.</summary>
+        /// <param name="context">The deserialisation context.</param>
+        [OnDeserialized]
+        private void OnDeserialized(StreamingContext context)
         {
-            ISemanticVersion lowerVersion = this.LowerVersion != null ? new SemanticVersion(this.LowerVersion) : null;
-            ISemanticVersion upperVersion = new SemanticVersion(this.UpperVersion);
-
-            // ignore versions not in range
-            if (lowerVersion != null && version.IsOlderThan(lowerVersion))
-                return true;
-            if (version.IsNewerThan(upperVersion))
-                return true;
-
-            // allow versions matching override
-            return !string.IsNullOrWhiteSpace(this.ForceCompatibleVersion) && Regex.IsMatch(version.ToString(), this.ForceCompatibleVersion, RegexOptions.IgnoreCase);
+            this.LowerSemanticVersion = this.LowerVersion != null ? new SemanticVersion(this.LowerVersion) : null;
+            this.UpperSemanticVersion = this.UpperVersion != null ? new SemanticVersion(this.UpperVersion) : null;
         }
     }
 }
-- 
cgit