From 7fc7a45102f856e84de36fdc5acc0bcb4d99afbb Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com>
Date: Thu, 21 Jan 2021 19:01:57 -0500
Subject: fix some broken mods incorrectly listed as XNB mods

---
 docs/release-notes.md                              |  5 ++-
 .../Framework/ModScanning/ModScanner.cs            | 37 +++++++++++++++-------
 2 files changed, 29 insertions(+), 13 deletions(-)

diff --git a/docs/release-notes.md b/docs/release-notes.md
index 279e43d2..7e3e48e5 100644
--- a/docs/release-notes.md
+++ b/docs/release-notes.md
@@ -9,8 +9,11 @@
 
 ## Upcoming release
 * For players:
-  * Improved game path detection in the installer. The installer now prefers the path registered by Steam or GOG Galaxy, and can also now detect the default install path for manual GOG installs.
+  * Improved game detection in the installer:
+    * The installer now prefers paths registered by Steam or GOG Galaxy.
+    * The installer now detects default manual GOG installs.
   * Fixed compatibility for very old content packs which still load maps from `.xnb` files. These were broken by map loading changes in Stardew Valley 1.5, but SMAPI now corrects them automatically.
+  * Fixed some broken mods incorrectly listed as XNB mods under 'skipped mods'.
 
 * For modders:
   * Added new input APIs:
diff --git a/src/SMAPI.Toolkit/Framework/ModScanning/ModScanner.cs b/src/SMAPI.Toolkit/Framework/ModScanning/ModScanner.cs
index 5eacee9e..b2f09431 100644
--- a/src/SMAPI.Toolkit/Framework/ModScanning/ModScanner.cs
+++ b/src/SMAPI.Toolkit/Framework/ModScanning/ModScanner.cs
@@ -58,16 +58,18 @@ namespace StardewModdingAPI.Toolkit.Framework.ModScanning
             ".lnk"
         };
 
-        /// <summary>The extensions for files which an XNB mod may contain. If a mod doesn't have a <c>manifest.json</c> and contains *only* these file extensions, it should be considered an XNB mod.</summary>
-        private readonly HashSet<string> PotentialXnbModExtensions = new HashSet<string>(StringComparer.OrdinalIgnoreCase)
+        /// <summary>The extensions for packed content files.</summary>
+        private readonly HashSet<string> StrictXnbModExtensions = new HashSet<string>(StringComparer.OrdinalIgnoreCase)
         {
-            // XNB files
             ".xgs",
             ".xnb",
             ".xsb",
-            ".xwb",
+            ".xwb"
+        };
 
-            // unpacking artifacts
+        /// <summary>The extensions for files which an XNB mod may contain, in addition to <see cref="StrictXnbModExtensions"/>.</summary>
+        private readonly HashSet<string> PotentialXnbModExtensions = new HashSet<string>(StringComparer.OrdinalIgnoreCase)
+        {
             ".json",
             ".yaml"
         };
@@ -118,7 +120,7 @@ namespace StardewModdingAPI.Toolkit.Framework.ModScanning
                     return new ModFolder(root, searchFolder, ModType.Invalid, null, ModParseError.EmptyFolder, "it's an empty folder.");
 
                 // XNB mod
-                if (files.All(this.IsPotentialXnbFile))
+                if (this.IsXnbMod(files))
                     return new ModFolder(root, searchFolder, ModType.Xnb, null, ModParseError.XnbMod, "it's not a SMAPI mod (see https://smapi.io/xnb for info).");
 
                 // SMAPI installer
@@ -302,14 +304,25 @@ namespace StardewModdingAPI.Toolkit.Framework.ModScanning
             return !this.IgnoreFilesystemNames.Any(p => p.IsMatch(entry.Name));
         }
 
-        /// <summary>Get whether a file is potentially part of an XNB mod.</summary>
-        /// <param name="entry">The file.</param>
-        private bool IsPotentialXnbFile(FileInfo entry)
+        /// <summary>Get whether a set of files looks like an XNB mod.</summary>
+        /// <param name="files">The files in the mod.</param>
+        private bool IsXnbMod(IEnumerable<FileInfo> files)
         {
-            if (!this.IsRelevant(entry))
-                return true;
+            bool hasXnbFile = false;
+
+            foreach (FileInfo file in files.Where(this.IsRelevant))
+            {
+                if (this.StrictXnbModExtensions.Contains(file.Extension))
+                {
+                    hasXnbFile = true;
+                    continue;
+                }
+
+                if (!this.PotentialXnbModExtensions.Contains(file.Extension))
+                    return false;
+            }
 
-            return this.PotentialXnbModExtensions.Contains(entry.Extension); // use EndsWith to handle cases like image..png
+            return hasXnbFile;
         }
 
         /// <summary>Strip newlines from a string.</summary>
-- 
cgit