using System;
using System.Collections.Generic;
using System.IO;
namespace StardewModdingAPI.Toolkit.Utilities
{
/// Provides an API for case-insensitive relative path lookups within a root directory.
internal class CaseInsensitivePathLookup
{
/*********
** Fields
*********/
/// The root directory path for relative paths.
private readonly string RootPath;
/// A case-insensitive lookup of file paths within the . Each path is listed in both file path and asset name format, so it's usable in both contexts without needing to re-parse paths.
private readonly Lazy> RelativePathCache;
/// The case-insensitive path caches by root path.
private static readonly Dictionary CachedRoots = new(StringComparer.OrdinalIgnoreCase);
/*********
** Public methods
*********/
/// Construct an instance.
/// The root directory path for relative paths.
/// Which directories to scan from the root.
public CaseInsensitivePathLookup(string rootPath, SearchOption searchOption = SearchOption.AllDirectories)
{
this.RootPath = rootPath;
this.RelativePathCache = new(() => this.GetRelativePathCache(searchOption));
}
/// Get the exact capitalization for a given relative file path.
/// The relative path.
/// Returns the resolved path in file path format, else the normalized .
public string GetFilePath(string relativePath)
{
return this.GetImpl(PathUtilities.NormalizePath(relativePath));
}
/// Get the exact capitalization for a given asset name.
/// The relative path.
/// Returns the resolved path in asset name format, else the normalized .
public string GetAssetName(string relativePath)
{
return this.GetImpl(PathUtilities.NormalizeAssetName(relativePath));
}
/// Add a relative path that was just created by a SMAPI API.
/// The relative path. This must already be normalized in asset name or file path format.
public void Add(string relativePath)
{
// skip if cache isn't created yet (no need to add files manually in that case)
if (!this.RelativePathCache.IsValueCreated)
return;
// skip if already cached
if (this.RelativePathCache.Value.ContainsKey(relativePath))
return;
// make sure path exists
relativePath = PathUtilities.NormalizePath(relativePath);
if (!File.Exists(Path.Combine(this.RootPath, relativePath)))
throw new InvalidOperationException($"Can't add relative path '{relativePath}' to the case-insensitive cache for '{this.RootPath}' because that file doesn't exist.");
// cache path
this.CacheRawPath(this.RelativePathCache.Value, relativePath);
}
/// Get a cached dictionary of relative paths within a root path, for case-insensitive file lookups.
/// The root path to scan.
public static CaseInsensitivePathLookup GetCachedFor(string rootPath)
{
rootPath = PathUtilities.NormalizePath(rootPath);
if (!CaseInsensitivePathLookup.CachedRoots.TryGetValue(rootPath, out CaseInsensitivePathLookup? cache))
CaseInsensitivePathLookup.CachedRoots[rootPath] = cache = new CaseInsensitivePathLookup(rootPath);
return cache;
}
/*********
** Private methods
*********/
/// Get the exact capitalization for a given relative path.
/// The relative path. This must already be normalized into asset name or file path format (i.e. using or respectively).
/// Returns the resolved path in the same format if found, else returns the path as-is.
private string GetImpl(string relativePath)
{
// invalid path
if (string.IsNullOrWhiteSpace(relativePath))
return relativePath;
// already cached
if (this.RelativePathCache.Value.TryGetValue(relativePath, out string? resolved))
return resolved;
// keep capitalization as-is
if (File.Exists(Path.Combine(this.RootPath, relativePath)))
{
// file exists but isn't cached for some reason
// cache it now so any later references to it are case-insensitive
this.CacheRawPath(this.RelativePathCache.Value, relativePath);
}
return relativePath;
}
/// Get a case-insensitive lookup of file paths (see ).
/// Which directories to scan from the root.
private Dictionary GetRelativePathCache(SearchOption searchOption)
{
Dictionary cache = new(StringComparer.OrdinalIgnoreCase);
foreach (string path in Directory.EnumerateFiles(this.RootPath, "*", searchOption))
{
string relativePath = path.Substring(this.RootPath.Length + 1);
this.CacheRawPath(cache, relativePath);
}
return cache;
}
/// Add a raw relative path to the cache.
/// The cache to update.
/// The relative path to cache, with its exact filesystem capitalization.
private void CacheRawPath(IDictionary cache, string relativePath)
{
string filePath = PathUtilities.NormalizePath(relativePath);
string assetName = PathUtilities.NormalizeAssetName(relativePath);
cache[filePath] = filePath;
cache[assetName] = assetName;
}
}
}