Add CacheFolderDepth option

Author: ronaldbarendse

samples/ImageSharp.Web.Sample/Startup.cs

@@ -51,7 +51,6 @@ public void ConfigureServices(IServiceCollection services)
                     return new PhysicalFileSystemCache(
                                 provider.GetRequiredService<IOptions<PhysicalFileSystemCacheOptions>>(),
                                 provider.GetRequiredService<IWebHostEnvironment>(),
-                                provider.GetRequiredService<IOptions<ImageSharpMiddlewareOptions>>(),
                                 provider.GetRequiredService<FormatUtilities>());
                 })
                 .SetCacheKey<UriRelativeLowerInvariantCacheKey>()
@@ -127,7 +126,6 @@ private void ConfigureCustomServicesAndCustomOptions(IServiceCollection services
                     return new PhysicalFileSystemCache(
                         provider.GetRequiredService<IOptions<PhysicalFileSystemCacheOptions>>(),
                         provider.GetRequiredService<IWebHostEnvironment>(),
-                        provider.GetRequiredService<IOptions<ImageSharpMiddlewareOptions>>(),
                         provider.GetRequiredService<FormatUtilities>());
                 })
                 .SetCacheKey<UriRelativeLowerInvariantCacheKey>()

src/ImageSharp.Web/Caching/PhysicalFileSystemCache.cs

@@ -9,7 +9,6 @@
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.Extensions.FileProviders;
 using Microsoft.Extensions.Options;
-using SixLabors.ImageSharp.Web.Middleware;
 using SixLabors.ImageSharp.Web.Resolvers;
 
 namespace SixLabors.ImageSharp.Web.Caching
@@ -34,16 +33,6 @@ public class PhysicalFileSystemCache : IImageCache
         /// </summary>
         private readonly IFileProvider fileProvider;
 
-        /// <summary>
-        /// The cache configuration options.
-        /// </summary>
-        private readonly PhysicalFileSystemCacheOptions cacheOptions;
-
-        /// <summary>
-        /// The middleware configuration options.
-        /// </summary>
-        private readonly ImageSharpMiddlewareOptions options;
-
         /// <summary>
         /// Contains various format helper methods based on the current configuration.
         /// </summary>
@@ -52,35 +41,31 @@ public class PhysicalFileSystemCache : IImageCache
         /// <summary>
         /// Initializes a new instance of the <see cref="PhysicalFileSystemCache"/> class.
         /// </summary>
-        /// <param name="cacheOptions">The cache configuration options.</param>
+        /// <param name="options">The cache configuration options.</param>
         /// <param name="environment">The hosting environment the application is running in.</param>
-        /// <param name="options">The middleware configuration options.</param>
         /// <param name="formatUtilities">Contains various format helper methods based on the current configuration.</param>
         public PhysicalFileSystemCache(
-            IOptions<PhysicalFileSystemCacheOptions> cacheOptions,
+            IOptions<PhysicalFileSystemCacheOptions> options,
 #if NETCOREAPP2_1
             IHostingEnvironment environment,
 #else
             IWebHostEnvironment environment,
 #endif
-            IOptions<ImageSharpMiddlewareOptions> options,
             FormatUtilities formatUtilities)
         {
             Guard.NotNull(environment, nameof(environment));
             Guard.NotNull(options, nameof(options));
             Guard.NotNullOrWhiteSpace(environment.WebRootPath, nameof(environment.WebRootPath));
 
             // Allow configuration of the cache without having to register everything.
-            this.cacheOptions = cacheOptions != null ? cacheOptions.Value : new PhysicalFileSystemCacheOptions();
-            this.cacheRootPath = GetCacheRoot(this.cacheOptions, environment.WebRootPath, environment.ContentRootPath);
-            if (!Directory.Exists(this.cacheRootPath))
-            {
-                Directory.CreateDirectory(this.cacheRootPath);
-            }
+            PhysicalFileSystemCacheOptions cacheOptions = options != null ? options.Value : new PhysicalFileSystemCacheOptions();
+            this.cacheRootPath = GetCacheRoot(cacheOptions, environment.WebRootPath, environment.ContentRootPath);
+            this.cacheFolderDepth = (int)cacheOptions.CacheFolderDepth;
+
+            // Ensure cache directory is created before initializing the file provider
+            Directory.CreateDirectory(this.cacheRootPath);
 
             this.fileProvider = new PhysicalFileProvider(this.cacheRootPath);
-            this.options = options.Value;
-            this.cacheFolderDepth = (int)this.options.CacheHashLength;
             this.formatUtilities = formatUtilities;
         }
 
@@ -124,10 +109,8 @@ public async Task SetAsync(string key, Stream stream, ImageCacheMetadata metadat
             string metaPath = this.ToMetaDataFilePath(path);
             string directory = Path.GetDirectoryName(path);
 
-            if (!Directory.Exists(directory))
-            {
-                Directory.CreateDirectory(directory);
-            }
+            // Ensure cache directory is created before creating files
+            Directory.CreateDirectory(directory);
 
             using (FileStream fileStream = File.Create(imagePath))
             {
@@ -167,6 +150,11 @@ private string ToImageFilePath(string path, in ImageCacheMetadata metaData)
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         internal static unsafe string ToFilePath(string key, int cacheFolderDepth)
         {
+            if (cacheFolderDepth > key.Length)
+            {
+                cacheFolderDepth = key.Length;
+            }
+
             // Each key substring char + separator + key
             int length = (cacheFolderDepth * 2) + key.Length;
             fixed (char* keyPtr = key)

src/ImageSharp.Web/Caching/PhysicalFileSystemCacheOptions.cs

@@ -4,7 +4,7 @@
 namespace SixLabors.ImageSharp.Web.Caching
 {
     /// <summary>
-    /// Configuration options for the <see cref="PhysicalFileSystemCache"/>.
+    /// Configuration options for the <see cref="PhysicalFileSystemCache" />.
     /// </summary>
     public class PhysicalFileSystemCacheOptions
     {
@@ -13,6 +13,11 @@ public class PhysicalFileSystemCacheOptions
         /// </summary>
         public string CacheFolder { get; set; } = "is-cache";
 
+        /// <summary>
+        /// Gets or sets the depth of the nested cache folders structure to store the images.
+        /// </summary>
+        public uint CacheFolderDepth { get; set; } = 8;
+
         /// <summary>
         /// Gets or sets the optional cache root folder.
         /// <para>