Add ImageflowMiddlewareOptions.HandleExtensionlessRequestsUnder(prefix, comparison)

lilith · lilith · commit 8d50c3d0b31e · 2020-10-29T14:51:50.000-06:00
diff --git a/README.md b/README.md
@@ -182,6 +182,8 @@ namespace Imageflow.Server.Example
                 .SetAllowMemoryCaching(false)
                 // Cache publicly (including on shared proxies and CDNs) for 30 days
                 .SetDefaultCacheControlString("public, max-age=2592000")
+                // Allows extensionless images to be served within the given directory(ies)
+                .HandleExtensionlessRequestsUnder("/customblobs/", StringComparison.OrdinalIgnoreCase)                
                 // Force all paths under "/gallery" to be watermarked
                 .AddRewriteHandler("/gallery", args =>
                 {
diff --git a/examples/Imageflow.Server.Example/Startup.cs b/examples/Imageflow.Server.Example/Startup.cs
@@ -110,6 +110,8 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
                 .SetAllowMemoryCaching(false)
                 // Cache publicly (including on shared proxies and CDNs) for 30 days
                 .SetDefaultCacheControlString("public, max-age=2592000")
+                // Allows extensionless images to be served within the given directory(ies)
+                .HandleExtensionlessRequestsUnder("/customblobs/", StringComparison.OrdinalIgnoreCase)
                 // Force all paths under "/gallery" to be watermarked
                 .AddRewriteHandler("/gallery", args =>
                 {
diff --git a/src/Imageflow.Server/ExtensionlessPath.cs b/src/Imageflow.Server/ExtensionlessPath.cs
@@ -0,0 +1,11 @@
+using System;
+
+namespace Imageflow.Server
+{
+    internal struct ExtensionlessPath
+    {
+        internal string Prefix { get; set; }
+        
+        internal StringComparison PrefixComparison { get; set; }
+    }
+}
diff --git a/src/Imageflow.Server/ImageJobInfo.cs b/src/Imageflow.Server/ImageJobInfo.cs
@@ -13,6 +13,36 @@ namespace Imageflow.Server
 {
     internal class ImageJobInfo
     {
+        public static bool ShouldHandleRequest(HttpContext context, ImageflowMiddlewareOptions options,
+            BlobProvider blobProvider)
+        {
+            // If the path is empty or null we don't handle it
+            var pathValue = context.Request.Path;
+            if (pathValue == null || !pathValue.HasValue)
+                return false;
+
+            var path = pathValue.Value;
+            if (path == null)
+                return false;
+
+            // We handle image request extensions
+            if (PathHelpers.IsImagePath(path))
+            {
+                return true;
+            }
+
+            // Don't do string parsing unless there are actually prefixes configured
+            if (options.ExtensionlessPaths.Count == 0) return false;
+            
+            // If there's no extension, then we can see if it's one of the prefixes we should handle
+            var extension = Path.GetExtension(path);
+            // If there's a non-image extension, we shouldn't handle the request
+            if (!string.IsNullOrEmpty(extension)) return false;
+
+            // Return true if any of the prefixes match
+            return options.ExtensionlessPaths
+                .Any(extensionlessPath => path.StartsWith(extensionlessPath.Prefix, extensionlessPath.PrefixComparison));
+        }
         public ImageJobInfo(HttpContext context, ImageflowMiddlewareOptions options, BlobProvider blobProvider)
         {
             this.options = options;
@@ -210,7 +240,7 @@ private bool VerifySignature(HttpContext context, ImageflowMiddlewareOptions opt
 
             // A missing signature is only a problem if they are required
             if (!options.RequireRequestSignature) return true;
-            
+
             AuthorizedMessage = "Image requests must be signed. No &signature query key found. ";
             return false;
 
@@ -219,6 +249,7 @@ private bool VerifySignature(HttpContext context, ImageflowMiddlewareOptions opt
 
         public bool PrimaryBlobMayExist()
         {
+            // Just returns a lambda for performing the actual fetch, does not actually call .Fetch() on providers
             return primaryBlob.GetBlobResult() != null;
         }
 
diff --git a/src/Imageflow.Server/ImageflowMiddleware.cs b/src/Imageflow.Server/ImageflowMiddleware.cs
@@ -74,14 +74,15 @@ public async Task Invoke(HttpContext context)
                 return;
             }
 
-            // We only handle requests with an image extension, period. 
-            if (!PathHelpers.IsImagePath(path))
+            // We only handle requests with an image extension or if we configured a path prefix for which to handle
+            // extensionless requests
+            
+            if (!ImageJobInfo.ShouldHandleRequest(context, options, blobProvider))
             {
                 await next.Invoke(context);
                 return;
             }
-
-
+            
             var imageJobInfo = new ImageJobInfo(context, options, blobProvider);
 
             if (!imageJobInfo.Authorized)
diff --git a/src/Imageflow.Server/ImageflowMiddlewareOptions.cs b/src/Imageflow.Server/ImageflowMiddlewareOptions.cs
@@ -54,6 +54,8 @@ public ImageflowMiddlewareOptions()
         internal readonly Dictionary<string, PresetOptions> Presets = new Dictionary<string, PresetOptions>(StringComparer.OrdinalIgnoreCase);
 
         internal readonly List<string> SigningKeys = new List<string>();
+        
+        internal readonly List<ExtensionlessPath> ExtensionlessPaths = new List<ExtensionlessPath>();
         /// <summary>
         /// Use this to add default command values if they are missing. Does not affect image requests with no querystring.
         /// Example: AddCommandDefault("down.colorspace", "srgb") reverts to ImageResizer's legacy behavior in scaling shadows and highlights.
@@ -75,6 +77,12 @@ public ImageflowMiddlewareOptions AddPreset(PresetOptions preset)
             Presets[preset.Name] = preset;
             return this;
         }
+
+        public ImageflowMiddlewareOptions HandleExtensionlessRequestsUnder(string prefix, StringComparison prefixComparison = StringComparison.Ordinal)
+        {
+            ExtensionlessPaths.Add(new ExtensionlessPath() { Prefix = prefix, PrefixComparison = prefixComparison});
+            return this;
+        }
         
         public ImageflowMiddlewareOptions AddRequestSigningKey(string key)
         {
diff --git a/src/Imageflow.Server/PathHelpers.cs b/src/Imageflow.Server/PathHelpers.cs
@@ -41,12 +41,9 @@ public static class PathHelpers
         public static IEnumerable<string> AcceptedImageExtensions => suffixes;
         public static IEnumerable<string> SupportedQuerystringKeys => querystringKeys;
 
-        internal static bool IsImagePath(PathString path)
+        internal static bool IsImagePath(string path)
         {
-            if (path == null || !path.HasValue)
-                return false;
-
-            return suffixes.Any(suffix => path.Value.EndsWith(suffix, StringComparison.OrdinalIgnoreCase));
+            return suffixes.Any(suffix => path.EndsWith(suffix, StringComparison.OrdinalIgnoreCase));
         }
 
         public static string SanitizeImageExtension(string extension)
diff --git a/tests/Imageflow.Server.Tests/IntegrationTest.cs b/tests/Imageflow.Server.Tests/IntegrationTest.cs
@@ -29,7 +29,8 @@ public async void TestLocalFiles()
                 .AddResource("images/fire umbrella.jpg", "TestFiles.fire-umbrella-small.jpg")
                 .AddResource("images/logo.png", "TestFiles.imazen_400.png")
                 .AddResource("images/wrong.webp", "TestFiles.imazen_400.png")
-                .AddResource("images/wrong.jpg", "TestFiles.imazen_400.png"))
+                .AddResource("images/wrong.jpg", "TestFiles.imazen_400.png")
+                .AddResource("images/extensionless/file", "TestFiles.imazen_400.png"))
             {
 
                 var hostBuilder = new HostBuilder()
@@ -45,6 +46,7 @@ public async void TestLocalFiles()
                                 .MapPath("/", Path.Combine(contentRoot.PhysicalPath, "images"))
                                 .MapPath("/insensitive", Path.Combine(contentRoot.PhysicalPath, "images"), true)
                                 .MapPath("/sensitive", Path.Combine(contentRoot.PhysicalPath, "images"), false)
+                                .HandleExtensionlessRequestsUnder("/extensionless/")
                                 .AddWatermark(new NamedWatermark("imazen", "/logo.png", new WatermarkOptions()))
                                 .AddWatermark(new NamedWatermark("broken", "/not_there.png", new WatermarkOptions()))
                                 .AddWatermarkingHandler("/", args =>
@@ -88,7 +90,10 @@ await Assert.ThrowsAsync<InvalidOperationException>(async () =>
                 wrongImageExtension2.EnsureSuccessStatusCode();
                 Assert.Equal("image/png", wrongImageExtension2.Content.Headers.ContentType.MediaType);
 
-                
+                using var extensionlessRequest = await client.GetAsync("/extensionless/file");
+                extensionlessRequest.EnsureSuccessStatusCode();
+                Assert.Equal("image/png", extensionlessRequest.Content.Headers.ContentType.MediaType);
+
                 
                 using var response2 = await client.GetAsync("/fire.jpg?width=1");
                 response2.EnsureSuccessStatusCode();
@@ -128,7 +133,8 @@ public async void TestDiskCache()
                 .AddResource("images/fire.jpg", "TestFiles.fire-umbrella-small.jpg")
                 .AddResource("images/logo.png", "TestFiles.imazen_400.png")
                 .AddResource("images/wrong.webp", "TestFiles.imazen_400.png")
-                .AddResource("images/wrong.jpg", "TestFiles.imazen_400.png"))
+                .AddResource("images/wrong.jpg", "TestFiles.imazen_400.png")
+                .AddResource("images/extensionless/file", "TestFiles.imazen_400.png"))
             {
 
                 var diskCacheDir = Path.Combine(contentRoot.PhysicalPath, "diskcache");
@@ -147,6 +153,7 @@ public async void TestDiskCache()
                             app.UseImageflow(new ImageflowMiddlewareOptions()
                                 .SetMapWebRoot(false)
                                 .SetAllowDiskCaching(true)
+                                .HandleExtensionlessRequestsUnder("/extensionless/")
                                 // Maps / to ContentRootPath/images
                                 .MapPath("/", Path.Combine(contentRoot.PhysicalPath, "images")));
                         });
@@ -179,6 +186,9 @@ public async void TestDiskCache()
                 wrongImageExtension2.EnsureSuccessStatusCode();
                 Assert.Equal("image/png", wrongImageExtension2.Content.Headers.ContentType.MediaType);
 
+                using var extensionlessRequest = await client.GetAsync("/extensionless/file");
+                extensionlessRequest.EnsureSuccessStatusCode();
+                Assert.Equal("image/png", extensionlessRequest.Content.Headers.ContentType.MediaType);
 
                 
                 await host.StopAsync(CancellationToken.None);
@@ -383,8 +393,12 @@ public async void TestRequestSigning()
                 var signedEncodedUnmodifiedUrl = Imazen.Common.Helpers.Signatures.SignRequest("/fire%20umbrella.jpg", key);
                 using var signedEncodedUnmodifiedResponse = await client.GetAsync(signedEncodedUnmodifiedUrl);
                 signedEncodedUnmodifiedResponse.EnsureSuccessStatusCode();
-                
-                
+
+                // var unsignedUnmodifiedUrl = "/fire%20umbrella.jpg";
+                // using var unsignedUnmodifiedResponse = await client.GetAsync(unsignedUnmodifiedUrl);
+                // unsignedUnmodifiedResponse.EnsureSuccessStatusCode();
+                //
+                //
                 var signedEncodedUrl = Imazen.Common.Helpers.Signatures.SignRequest("/fire%20umbrella.jpg?width=1", key);
                 using var signedEncodedResponse = await client.GetAsync(signedEncodedUrl);
                 signedEncodedResponse.EnsureSuccessStatusCode();

Original file line number	Diff line number	Diff line change
`@@ -182,6 +182,8 @@ namespace Imageflow.Server.Example`
`182`	`182`	`.SetAllowMemoryCaching(false)`
`183`	`183`	`// Cache publicly (including on shared proxies and CDNs) for 30 days`
`184`	`184`	`.SetDefaultCacheControlString("public, max-age=2592000")`
	`185`	`+ // Allows extensionless images to be served within the given directory(ies)`
	`186`	`+ .HandleExtensionlessRequestsUnder("/customblobs/", StringComparison.OrdinalIgnoreCase)`
`185`	`187`	`// Force all paths under "/gallery" to be watermarked`
`186`	`188`	`.AddRewriteHandler("/gallery", args =>`
`187`	`189`	`{`
Original file line number	Diff line number	Diff line change
`@@ -110,6 +110,8 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)`
`110`	`110`	`.SetAllowMemoryCaching(false)`
`111`	`111`	`// Cache publicly (including on shared proxies and CDNs) for 30 days`
`112`	`112`	`.SetDefaultCacheControlString("public, max-age=2592000")`
	`113`	`+ // Allows extensionless images to be served within the given directory(ies)`
	`114`	`+ .HandleExtensionlessRequestsUnder("/customblobs/", StringComparison.OrdinalIgnoreCase)`
`113`	`115`	`// Force all paths under "/gallery" to be watermarked`
`114`	`116`	`.AddRewriteHandler("/gallery", args =>`
`115`	`117`	`{`
Original file line number	Diff line number	Diff line change
`@@ -74,14 +74,15 @@ public async Task Invoke(HttpContext context)`
`74`	`74`	`return;`
`75`	`75`	`}`
`76`	`76`
`77`		`- // We only handle requests with an image extension, period.`
`78`		`- if (!PathHelpers.IsImagePath(path))`
	`77`	`+ // We only handle requests with an image extension or if we configured a path prefix for which to handle`
	`78`	`+ // extensionless requests`
	`79`	`+`
	`80`	`+ if (!ImageJobInfo.ShouldHandleRequest(context, options, blobProvider))`
`79`	`81`	`{`
`80`	`82`	`await next.Invoke(context);`
`81`	`83`	`return;`
`82`	`84`	`}`
`83`		`-`
`84`		`-`
	`85`	`+`
`85`	`86`	`var imageJobInfo = new ImageJobInfo(context, options, blobProvider);`
`86`	`87`
`87`	`88`	`if (!imageJobInfo.Authorized)`
Original file line number	Diff line number	Diff line change
`@@ -41,12 +41,9 @@ public static class PathHelpers`
`41`	`41`	`public static IEnumerable<string> AcceptedImageExtensions => suffixes;`
`42`	`42`	`public static IEnumerable<string> SupportedQuerystringKeys => querystringKeys;`
`43`	`43`
`44`		`- internal static bool IsImagePath(PathString path)`
	`44`	`+ internal static bool IsImagePath(string path)`
`45`	`45`	`{`
`46`		`- if (path == null \|\| !path.HasValue)`
`47`		`- return false;`
`48`		`-`
`49`		`- return suffixes.Any(suffix => path.Value.EndsWith(suffix, StringComparison.OrdinalIgnoreCase));`
	`46`	`+ return suffixes.Any(suffix => path.EndsWith(suffix, StringComparison.OrdinalIgnoreCase));`
`50`	`47`	`}`
`51`	`48`
`52`	`49`	`public static string SanitizeImageExtension(string extension)`