From 4e2d7f2550b05e410735f51beac76ed040178cf4 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com>
Date: Fri, 1 Apr 2022 23:42:37 -0400
Subject: make mod file paths case-insensitive in all SMAPI APIs

---
 src/SMAPI/Framework/ContentPack.cs | 38 ++++++++++++--------------------------
 1 file changed, 12 insertions(+), 26 deletions(-)

(limited to 'src/SMAPI/Framework/ContentPack.cs')

diff --git a/src/SMAPI/Framework/ContentPack.cs b/src/SMAPI/Framework/ContentPack.cs
index 3920354e..e02ef88b 100644
--- a/src/SMAPI/Framework/ContentPack.cs
+++ b/src/SMAPI/Framework/ContentPack.cs
@@ -1,9 +1,8 @@
 using System;
-using System.Collections.Generic;
 using System.IO;
 using StardewModdingAPI.Framework.ModHelpers;
 using StardewModdingAPI.Toolkit.Serialization;
-using StardewModdingAPI.Toolkit.Utilities;
+using StardewModdingAPI.Utilities;
 
 namespace StardewModdingAPI.Framework
 {
@@ -16,8 +15,8 @@ namespace StardewModdingAPI.Framework
         /// <summary>Encapsulates SMAPI's JSON file parsing.</summary>
         private readonly JsonHelper JsonHelper;
 
-        /// <summary>A cache of case-insensitive => exact relative paths within the content pack, for case-insensitive file lookups on Linux/macOS.</summary>
-        private readonly IDictionary<string, string> RelativePaths = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
+        /// <summary>A case-insensitive lookup of relative paths within the <see cref="DirectoryPath"/>.</summary>
+        private readonly CaseInsensitivePathCache RelativePathCache;
 
 
         /*********
@@ -48,19 +47,15 @@ namespace StardewModdingAPI.Framework
         /// <param name="content">Provides an API for loading content assets from the content pack's folder.</param>
         /// <param name="translation">Provides translations stored in the content pack's <c>i18n</c> folder.</param>
         /// <param name="jsonHelper">Encapsulates SMAPI's JSON file parsing.</param>
-        public ContentPack(string directoryPath, IManifest manifest, IModContentHelper content, TranslationHelper translation, JsonHelper jsonHelper)
+        /// <param name="relativePathCache">A case-insensitive lookup of relative paths within the <paramref name="directoryPath"/>.</param>
+        public ContentPack(string directoryPath, IManifest manifest, IModContentHelper content, TranslationHelper translation, JsonHelper jsonHelper, CaseInsensitivePathCache relativePathCache)
         {
             this.DirectoryPath = directoryPath;
             this.Manifest = manifest;
             this.ModContent = content;
             this.TranslationImpl = translation;
             this.JsonHelper = jsonHelper;
-
-            foreach (string path in Directory.EnumerateFiles(this.DirectoryPath, "*", SearchOption.AllDirectories))
-            {
-                string relativePath = path.Substring(this.DirectoryPath.Length + 1);
-                this.RelativePaths[relativePath] = relativePath;
-            }
+            this.RelativePathCache = relativePathCache;
         }
 
         /// <inheritdoc />
@@ -90,8 +85,7 @@ namespace StardewModdingAPI.Framework
             FileInfo file = this.GetFile(path, out path);
             this.JsonHelper.WriteJsonFile(file.FullName, data);
 
-            if (!this.RelativePaths.ContainsKey(path))
-                this.RelativePaths[path] = path;
+            this.RelativePathCache.Add(path);
         }
 
         /// <inheritdoc />
@@ -112,18 +106,6 @@ namespace StardewModdingAPI.Framework
         /*********
         ** Private methods
         *********/
-        /// <summary>Get the real relative path from a case-insensitive path.</summary>
-        /// <param name="relativePath">The normalized relative path.</param>
-        private string GetCaseInsensitiveRelativePath(string relativePath)
-        {
-            if (!PathUtilities.IsSafeRelativePath(relativePath))
-                throw new InvalidOperationException($"You must call {nameof(IContentPack)} methods with a relative path.");
-
-            return !string.IsNullOrWhiteSpace(relativePath) && this.RelativePaths.TryGetValue(relativePath, out string caseInsensitivePath)
-                ? caseInsensitivePath
-                : relativePath;
-        }
-
         /// <summary>Get the underlying file info.</summary>
         /// <param name="relativePath">The normalized file path relative to the content pack directory.</param>
         private FileInfo GetFile(string relativePath)
@@ -136,7 +118,11 @@ namespace StardewModdingAPI.Framework
         /// <param name="actualRelativePath">The relative path after case-insensitive matching.</param>
         private FileInfo GetFile(string relativePath, out string actualRelativePath)
         {
-            actualRelativePath = this.GetCaseInsensitiveRelativePath(relativePath);
+            if (!PathUtilities.IsSafeRelativePath(relativePath))
+                throw new InvalidOperationException($"You must call {nameof(IContentPack)} methods with a relative path.");
+
+            actualRelativePath = this.RelativePathCache.GetFilePath(relativePath);
+
             return new FileInfo(Path.Combine(this.DirectoryPath, actualRelativePath));
         }
     }
-- 
cgit