Merge branch 'develop' into stable

2 files changed, 97 insertions, 16 deletions

diff --git a/src/StardewModdingAPI.Toolkit/Framework/ModScanning/ModFolder.cs b/src/StardewModdingAPI.Toolkit/Framework/ModScanning/ModFolder.cs
index 4aaa3f83..bb467b36 100644
--- a/src/StardewModdingAPI.Toolkit/Framework/ModScanning/ModFolder.cs
+++ b/src/StardewModdingAPI.Toolkit/Framework/ModScanning/ModFolder.cs
@@ -2,6 +2,7 @@ using System.Collections.Generic;
 using System.IO;
 using System.Linq;
 using StardewModdingAPI.Toolkit.Serialisation.Models;
+using StardewModdingAPI.Toolkit.Utilities;
 
 namespace StardewModdingAPI.Toolkit.Framework.ModScanning
 {
@@ -11,11 +12,11 @@ namespace StardewModdingAPI.Toolkit.Framework.ModScanning
         /*********
         ** Accessors
         *********/
-        /// <summary>The Mods subfolder containing this mod.</summary>
-        public DirectoryInfo SearchDirectory { get; }
+        /// <summary>A suggested display name for the mod folder.</summary>
+        public string DisplayName { get; }
 
-        /// <summary>The folder containing manifest.json.</summary>
-        public DirectoryInfo ActualDirectory { get; }
+        /// <summary>The folder containing the mod's manifest.json.</summary>
+        public DirectoryInfo Directory { get; }
 
         /// <summary>The mod manifest.</summary>
         public Manifest Manifest { get; }
@@ -23,21 +24,31 @@ namespace StardewModdingAPI.Toolkit.Framework.ModScanning
         /// <summary>The error which occurred parsing the manifest, if any.</summary>
         public string ManifestParseError { get; }
 
+        /// <summary>Whether the mod should be loaded by default. This is <c>false</c> if it was found within a folder whose name starts with a dot.</summary>
+        public bool ShouldBeLoaded { get; }
+
 
         /*********
         ** Public methods
         *********/
         /// <summary>Construct an instance.</summary>
-        /// <param name="searchDirectory">The Mods subfolder containing this mod.</param>
-        /// <param name="actualDirectory">The folder containing manifest.json.</param>
+        /// <param name="root">The root folder containing mods.</param>
+        /// <param name="directory">The folder containing the mod's manifest.json.</param>
         /// <param name="manifest">The mod manifest.</param>
         /// <param name="manifestParseError">The error which occurred parsing the manifest, if any.</param>
-        public ModFolder(DirectoryInfo searchDirectory, DirectoryInfo actualDirectory, Manifest manifest, string manifestParseError = null)
+        /// <param name="shouldBeLoaded">Whether the mod should be loaded by default. This should be <c>false</c> if it was found within a folder whose name starts with a dot.</param>
+        public ModFolder(DirectoryInfo root, DirectoryInfo directory, Manifest manifest, string manifestParseError = null, bool shouldBeLoaded = true)
         {
-            this.SearchDirectory = searchDirectory;
-            this.ActualDirectory = actualDirectory;
+            // save info
+            this.Directory = directory;
             this.Manifest = manifest;
             this.ManifestParseError = manifestParseError;
+            this.ShouldBeLoaded = shouldBeLoaded;
+
+            // set display name
+            this.DisplayName = manifest?.Name;
+            if (string.IsNullOrWhiteSpace(this.DisplayName))
+                this.DisplayName = PathUtilities.GetRelativePath(root.FullName, directory.FullName);
         }
 
         /// <summary>Get the update keys for a mod.</summary>
diff --git a/src/StardewModdingAPI.Toolkit/Framework/ModScanning/ModScanner.cs b/src/StardewModdingAPI.Toolkit/Framework/ModScanning/ModScanner.cs
index f1cce4a4..106c294f 100644
--- a/src/StardewModdingAPI.Toolkit/Framework/ModScanning/ModScanner.cs
+++ b/src/StardewModdingAPI.Toolkit/Framework/ModScanning/ModScanner.cs
@@ -16,6 +16,23 @@ namespace StardewModdingAPI.Toolkit.Framework.ModScanning
         /// <summary>The JSON helper with which to read manifests.</summary>
         private readonly JsonHelper JsonHelper;
 
+        /// <summary>A list of filesystem entry names to ignore when checking whether a folder should be treated as a mod.</summary>
+        private readonly HashSet<string> IgnoreFilesystemEntries = new HashSet<string>(StringComparer.InvariantCultureIgnoreCase)
+        {
+            ".DS_Store",
+            "mcs",
+            "Thumbs.db"
+        };
+
+        /// <summary>The extensions for files which an XNB mod may contain. If a mod contains *only* these file extensions, it should be considered an XNB mod.</summary>
+        private readonly HashSet<string> PotentialXnbModExtensions = new HashSet<string>(StringComparer.InvariantCultureIgnoreCase)
+        {
+            ".md",
+            ".png",
+            ".txt",
+            ".xnb"
+        };
+
 
         /*********
         ** Public methods
@@ -31,19 +48,28 @@ namespace StardewModdingAPI.Toolkit.Framework.ModScanning
         /// <param name="rootPath">The root folder containing mods.</param>
         public IEnumerable<ModFolder> GetModFolders(string rootPath)
         {
-            foreach (DirectoryInfo folder in new DirectoryInfo(rootPath).EnumerateDirectories())
-                yield return this.ReadFolder(rootPath, folder);
+            DirectoryInfo root = new DirectoryInfo(rootPath);
+            return this.GetModFolders(root, root);
         }
 
         /// <summary>Extract information from a mod folder.</summary>
-        /// <param name="rootPath">The root folder containing mods.</param>
+        /// <param name="root">The root folder containing mods.</param>
         /// <param name="searchFolder">The folder to search for a mod.</param>
-        public ModFolder ReadFolder(string rootPath, DirectoryInfo searchFolder)
+        public ModFolder ReadFolder(DirectoryInfo root, DirectoryInfo searchFolder)
         {
             // find manifest.json
             FileInfo manifestFile = this.FindManifest(searchFolder);
+
+            // set appropriate invalid-mod error
             if (manifestFile == null)
-                return new ModFolder(searchFolder, null, null, "it doesn't have a manifest.");
+            {
+                FileInfo[] files = searchFolder.GetFiles("*", SearchOption.AllDirectories).Where(this.IsRelevant).ToArray();
+                if (!files.Any())
+                    return new ModFolder(root, searchFolder, null, "it's an empty folder.");
+                if (files.All(file => this.PotentialXnbModExtensions.Contains(file.Extension)))
+                    return new ModFolder(root, searchFolder, null, "it's an older XNB mod which replaces game files (not run through SMAPI).");
+                return new ModFolder(root, searchFolder, null, "it contains files, but none of them are manifest.json.");
+            }
 
             // read mod info
             Manifest manifest = null;
@@ -51,7 +77,7 @@ namespace StardewModdingAPI.Toolkit.Framework.ModScanning
             {
                 try
                 {
-                    if (!this.JsonHelper.ReadJsonFileIfExists<Manifest>(manifestFile.FullName, out manifest))
+                    if (!this.JsonHelper.ReadJsonFileIfExists<Manifest>(manifestFile.FullName, out manifest) || manifest == null)
                         manifestError = "its manifest is invalid.";
                 }
                 catch (SParseException ex)
@@ -64,13 +90,37 @@ namespace StardewModdingAPI.Toolkit.Framework.ModScanning
                 }
             }
 
-            return new ModFolder(searchFolder, manifestFile.Directory, manifest, manifestError);
+            return new ModFolder(root, manifestFile.Directory, manifest, manifestError);
         }
 
 
         /*********
         ** Private methods
         *********/
+        /// <summary>Recursively extract information about all mods in the given folder.</summary>
+        /// <param name="root">The root mod folder.</param>
+        /// <param name="folder">The folder to search for mods.</param>
+        public IEnumerable<ModFolder> GetModFolders(DirectoryInfo root, DirectoryInfo folder)
+        {
+            // skip
+            if (folder.FullName != root.FullName && folder.Name.StartsWith("."))
+                yield return new ModFolder(root, folder, null, "ignored folder because its name starts with a dot.", shouldBeLoaded: false);
+
+            // recurse into subfolders
+            else if (this.IsModSearchFolder(root, folder))
+            {
+                foreach (DirectoryInfo subfolder in folder.EnumerateDirectories())
+                {
+                    foreach (ModFolder match in this.GetModFolders(root, subfolder))
+                        yield return match;
+                }
+            }
+
+            // treat as mod folder
+            else
+                yield return this.ReadFolder(root, folder);
+        }
+
         /// <summary>Find the manifest for a mod folder.</summary>
         /// <param name="folder">The folder to search.</param>
         private FileInfo FindManifest(DirectoryInfo folder)
@@ -94,5 +144,25 @@ namespace StardewModdingAPI.Toolkit.Framework.ModScanning
                 return null;
             }
         }
+
+        /// <summary>Get whether a given folder should be treated as a search folder (i.e. look for subfolders containing mods).</summary>
+        /// <param name="root">The root mod folder.</param>
+        /// <param name="folder">The folder to search for mods.</param>
+        private bool IsModSearchFolder(DirectoryInfo root, DirectoryInfo folder)
+        {
+            if (root.FullName == folder.FullName)
+                return true;
+
+            DirectoryInfo[] subfolders = folder.GetDirectories().Where(this.IsRelevant).ToArray();
+            FileInfo[] files = folder.GetFiles().Where(this.IsRelevant).ToArray();
+            return subfolders.Any() && !files.Any();
+        }
+
+        /// <summary>Get whether a file or folder is relevant when deciding how to process a mod folder.</summary>
+        /// <param name="entry">The file or folder.</param>
+        private bool IsRelevant(FileSystemInfo entry)
+        {
+            return !this.IgnoreFilesystemEntries.Contains(entry.Name);
+        }
     }
 }