Merge pull request #83 from msigley/main

Added Added ApplyDefaultCommandsToQuerylessUrls route option
imazen · Aug 11, 2023 · 9c12ab3 · 9c12ab3
2 parents 51faea9 + 72bb560
commit 9c12ab3
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 3 deletions.
diff --git a/src/Imageflow.Server.Configuration/Executor.cs b/src/Imageflow.Server.Configuration/Executor.cs
@@ -121,7 +121,10 @@ public ImageflowMiddlewareOptions GetImageflowMiddlewareOptions(){
             }      
 
         }
-
+        if (config.RouteDefaults?.ApplyDefaultCommandsToQuerylessUrls ?? false){
+            options.SetApplyDefaultCommandsToQuerylessUrls(true);
+        }
+
         // set security options
         var securityOptions = new SecurityOptions();
         if (config.Security?.MaxDecodeResolution != null){

diff --git a/src/Imageflow.Server.Configuration/MinimalParseStructures.cs b/src/Imageflow.Server.Configuration/MinimalParseStructures.cs
@@ -101,6 +101,7 @@ internal class RouteBase : ITomlMetadataProvider, IValidationCapable
    // public RouteSource? Source { get; set; }
     public string? CacheControl { get; set; }
     public string? ApplyDefaultCommands { get; set; }
+    public bool? ApplyDefaultCommandsToQuerylessUrls { get; set; }
     // public string? ApplyOverrideCommands { get; set; }
     // public string? RequireSignature { get; set; }
 

diff --git a/src/Imageflow.Server.Configuration/minimal.toml b/src/Imageflow.Server.Configuration/minimal.toml
@@ -11,6 +11,7 @@ lowercase_path_remainder = false
 allow_extensionless_urls = false
 cache_control = "public, max-age=2592000"
 apply_default_commands = "quality=76&webp.quality=70&f.sharpen=23&down.filter=mitchell"
+apply_default_commands_to_queryless_urls = false
 
 [[routes]]
 prefix = '/images/'

diff --git a/src/Imageflow.Server/ImageJobInfo.cs b/src/Imageflow.Server/ImageJobInfo.cs
@@ -219,7 +219,7 @@ private bool ProcessRewritesAndAuthorization(HttpContext context, ImageflowMiddl
             }
 
             // Set defaults if keys are missing, but at least 1 supported key is present
-            if (PathHelpers.SupportedQuerystringKeys.Any(args.Query.ContainsKey))
+            if (middlewareOptions.ApplyDefaultCommandsToQuerylessUrls || PathHelpers.SupportedQuerystringKeys.Any(args.Query.ContainsKey))
             {
                 foreach (var pair in middlewareOptions.CommandDefaults)
                 {

diff --git a/src/Imageflow.Server/ImageflowMiddlewareOptions.cs b/src/Imageflow.Server/ImageflowMiddlewareOptions.cs
@@ -55,7 +55,8 @@ public class ImageflowMiddlewareOptions
 
 
         internal readonly Dictionary<string, string> CommandDefaults = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
-
+        public bool ApplyDefaultCommandsToQuerylessUrls { get; set; } = false;
+
         internal readonly Dictionary<string, PresetOptions> Presets = new Dictionary<string, PresetOptions>(StringComparer.OrdinalIgnoreCase);
 
         internal readonly List<ExtensionlessPath> ExtensionlessPaths = new List<ExtensionlessPath>();
@@ -242,5 +243,16 @@ public ImageflowMiddlewareOptions SetDefaultCacheControlString(string cacheContr
             DefaultCacheControlString = cacheControlString;
             return this;
         }
+
+        /// <summary>
+        /// Set to true have the command defaults to all urls, not just ones containing a valid query command.
+        /// </summary>
+        /// <param name="value"></param>
+        /// <returns></returns>
+        public ImageflowMiddlewareOptions SetApplyDefaultCommandsToQuerylessUrls(bool value)
+        {
+            this.ApplyDefaultCommandsToQuerylessUrls = value;
+            return this;
+        }
     }
 }
diff --git a/tests/Imageflow.Server.Configuration.Tests/TestMinimal.cs b/tests/Imageflow.Server.Configuration.Tests/TestMinimal.cs
@@ -87,6 +87,7 @@ public void TestComputedOptions(DeploymentEnvironment environment)
      {"ImageflowMiddlewareOptions.MapWebRoot", "False"},
      {"ImageflowMiddlewareOptions.UsePresetsExclusively", "False"},
      {"ImageflowMiddlewareOptions.DefaultCacheControlString", "public, max-age=20"},
+     {"ImageflowMiddlewareOptions.ApplyDefaultCommandsToQuerylessUrls", "True"},
      {"ImageflowMiddlewareOptions.RequestSignatureOptions", "null"},
      {"ImageflowMiddlewareOptions.JobSecurityOptions.MaxDecodeSize.MaxWidth", "12000"},
      {"ImageflowMiddlewareOptions.JobSecurityOptions.MaxDecodeSize.MaxHeight", "12000"},
@@ -135,6 +136,7 @@ public void TestComputedOptions(DeploymentEnvironment environment)
      {"ImageflowMiddlewareOptions.MapWebRoot", "False"},
      {"ImageflowMiddlewareOptions.UsePresetsExclusively", "False"},
      {"ImageflowMiddlewareOptions.DefaultCacheControlString", "public, max-age=20"},
+     {"ImageflowMiddlewareOptions.ApplyDefaultCommandsToQuerylessUrls", "True"},
      {"ImageflowMiddlewareOptions.RequestSignatureOptions", "null"},
      {"ImageflowMiddlewareOptions.JobSecurityOptions.MaxDecodeSize.MaxWidth", "12000"},
      {"ImageflowMiddlewareOptions.JobSecurityOptions.MaxDecodeSize.MaxHeight", "12000"},
@@ -183,6 +185,7 @@ public void TestComputedOptions(DeploymentEnvironment environment)
      {"ImageflowMiddlewareOptions.MapWebRoot", "False"},
      {"ImageflowMiddlewareOptions.UsePresetsExclusively", "False"},
      {"ImageflowMiddlewareOptions.DefaultCacheControlString", "public, max-age=20"},
+     {"ImageflowMiddlewareOptions.ApplyDefaultCommandsToQuerylessUrls", "True"},
      {"ImageflowMiddlewareOptions.RequestSignatureOptions", "null"},
      {"ImageflowMiddlewareOptions.JobSecurityOptions.MaxDecodeSize.MaxWidth", "12000"},
      {"ImageflowMiddlewareOptions.JobSecurityOptions.MaxDecodeSize.MaxHeight", "12000"},
@@ -232,6 +235,7 @@ public void TestComputedOptions(DeploymentEnvironment environment)
 lowercase_path_remainder = true
 cache_control = "public, max-age=20"
 apply_default_commands = "quality=76"
+apply_default_commands_to_queryless_urls = true
 
 [[routes]]
 prefix = '/images/'