From 024489c33827ce8e1463eac199daa996a8a99216 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Fri, 16 Feb 2018 18:50:46 -0500
Subject: overhaul internal mod data format (#439)

The new format is much more concise, reduces the memory footprint by only parsing metadata for loaded mods, and adds support for versioning and defaulting most fields.
---
 src/SMAPI/Framework/ModLoading/ModMetadata.cs |  4 ++--
 src/SMAPI/Framework/ModLoading/ModResolver.cs | 24 ++++++++++--------------
 2 files changed, 12 insertions(+), 16 deletions(-)

(limited to 'src/SMAPI/Framework/ModLoading')

diff --git a/src/SMAPI/Framework/ModLoading/ModMetadata.cs b/src/SMAPI/Framework/ModLoading/ModMetadata.cs
index 30fe211b..1a71920e 100644
--- a/src/SMAPI/Framework/ModLoading/ModMetadata.cs
+++ b/src/SMAPI/Framework/ModLoading/ModMetadata.cs
@@ -18,7 +18,7 @@ namespace StardewModdingAPI.Framework.ModLoading
         public IManifest Manifest { get; }
 
         /// <summary>Metadata about the mod from SMAPI's internal data (if any).</summary>
-        public ModDataRecord DataRecord { get; }
+        public ParsedModDataRecord DataRecord { get; }
 
         /// <summary>The metadata resolution status.</summary>
         public ModMetadataStatus Status { get; private set; }
@@ -41,7 +41,7 @@ namespace StardewModdingAPI.Framework.ModLoading
         /// <param name="directoryPath">The mod's full directory path.</param>
         /// <param name="manifest">The mod manifest.</param>
         /// <param name="dataRecord">Metadata about the mod from SMAPI's internal data (if any).</param>
-        public ModMetadata(string displayName, string directoryPath, IManifest manifest, ModDataRecord dataRecord)
+        public ModMetadata(string displayName, string directoryPath, IManifest manifest, ParsedModDataRecord dataRecord)
         {
             this.DisplayName = displayName;
             this.DirectoryPath = directoryPath;
diff --git a/src/SMAPI/Framework/ModLoading/ModResolver.cs b/src/SMAPI/Framework/ModLoading/ModResolver.cs
index 9802d9e9..6671e880 100644
--- a/src/SMAPI/Framework/ModLoading/ModResolver.cs
+++ b/src/SMAPI/Framework/ModLoading/ModResolver.cs
@@ -53,18 +53,15 @@ namespace StardewModdingAPI.Framework.ModLoading
                     error = $"parsing its manifest failed:\n{ex.GetLogSummary()}";
                 }
 
-                // get internal data record (if any)
-                ModDataRecord dataRecord = null;
+                // parse internal data record (if any)
+                ParsedModDataRecord dataRecord = null;
                 if (manifest != null)
                 {
-                    string key = !string.IsNullOrWhiteSpace(manifest.UniqueID) ? manifest.UniqueID : manifest.EntryDll;
-                    dataRecord = dataRecords.FirstOrDefault(record => record.ID.Matches(key, manifest));
+                    ModDataRecord rawDataRecord = dataRecords.FirstOrDefault(p => p.Matches(manifest));
+                    if (rawDataRecord != null)
+                        dataRecord = rawDataRecord.ParseFieldsFor(manifest);
                 }
 
-                // add default update keys
-                if (manifest != null && manifest.UpdateKeys == null && dataRecord?.UpdateKeys != null)
-                    manifest.UpdateKeys = dataRecord.UpdateKeys;
-
                 // build metadata
                 string displayName = !string.IsNullOrWhiteSpace(manifest?.Name)
                     ? manifest.Name
@@ -93,17 +90,16 @@ namespace StardewModdingAPI.Framework.ModLoading
                     continue;
 
                 // validate compatibility
-                ModCompatibility compatibility = mod.DataRecord?.GetCompatibility(mod.Manifest.Version);
-                switch (compatibility?.Status)
+                switch (mod.DataRecord?.Status)
                 {
                     case ModStatus.Obsolete:
-                        mod.SetStatus(ModMetadataStatus.Failed, $"it's obsolete: {compatibility.ReasonPhrase}");
+                        mod.SetStatus(ModMetadataStatus.Failed, $"it's obsolete: {mod.DataRecord.StatusReasonPhrase}");
                         continue;
 
                     case ModStatus.AssumeBroken:
                         {
                             // get reason
-                            string reasonPhrase = compatibility.ReasonPhrase ?? "it's no longer compatible";
+                            string reasonPhrase = mod.DataRecord.StatusReasonPhrase ?? "it's no longer compatible";
 
                             // get update URLs
                             List<string> updateUrls = new List<string>();
@@ -124,10 +120,10 @@ namespace StardewModdingAPI.Framework.ModLoading
 
                             // build error
                             string error = $"{reasonPhrase}. Please check for a ";
-                            if (mod.Manifest.Version.Equals(compatibility.UpperVersion))
+                            if (mod.DataRecord.StatusUpperVersion == null || mod.Manifest.Version.Equals(mod.DataRecord.StatusUpperVersion))
                                 error += "newer version";
                             else
-                                error += $"version newer than {compatibility.UpperVersion}";
+                                error += $"version newer than {mod.DataRecord.StatusUpperVersion}";
                             error += " at " + string.Join(" or ", updateUrls);
 
                             mod.SetStatus(ModMetadataStatus.Failed, error);
-- 
cgit