Added optional version param for local file assets. Closes #2061

PiranhaCMS · May 12, 2024 · 8938e3f · 8938e3f
1 parent d03ebad
commit 8938e3f
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 4 deletions.
diff --git a/core/Piranha.Local.FileStorage/Extensions/FileStorageExtensions.cs b/core/Piranha.Local.FileStorage/Extensions/FileStorageExtensions.cs
@@ -21,18 +21,20 @@ public static class FileStorageExtensions
     /// <param name="basePath">The optional base path for where uploaded media is stored.null Default is wwwroot/uploads/</param>
     /// <param name="baseUrl">The optional base url for accessing uploaded media. Default is ~/uploads/</param>
     /// <param name="naming">How uploaded media files should be named</param>
+    /// <param name="generateVersionParam">If a version param should be appended to the public url</param>
     /// <param name="scope">The optional service scope. Default is singleton</param>
     /// <returns>The service collection</returns>
     public static IServiceCollection AddPiranhaFileStorage(
         this IServiceCollection services,
         string basePath = null,
         string baseUrl = null,
         FileStorageNaming naming = FileStorageNaming.UniqueFileNames,
+        bool generateVersionParam = false,
         ServiceLifetime scope = ServiceLifetime.Singleton)
     {
         App.Modules.Register<FileStorageModule>();
 
-        services.Add(new ServiceDescriptor(typeof(IStorage), sp => new FileStorage(basePath, baseUrl, naming), scope));
+        services.Add(new ServiceDescriptor(typeof(IStorage), sp => new FileStorage(basePath, baseUrl, naming, generateVersionParam), scope));
 
         return services;
     }

diff --git a/core/Piranha.Local.FileStorage/Extensions/FileStorageStartupExtensions.cs b/core/Piranha.Local.FileStorage/Extensions/FileStorageStartupExtensions.cs
@@ -21,16 +21,18 @@ public static class FileStorageStartupExtensions
     /// <param name="basePath">The optional base path for where uploaded media is stored.null Default is wwwroot/uploads/</param>
     /// <param name="baseUrl">The optional base url for accessing uploaded media. Default is ~/uploads/</param>
     /// <param name="naming">How uploaded media files should be named</param>
+    /// <param name="generateVersionParam">If a version param should be appended to the public url</param>
     /// <param name="scope">The optional service scope. Default is singleton</param>
     /// <returns>The updated builder</returns>
     public static PiranhaServiceBuilder UseFileStorage(
         this PiranhaServiceBuilder serviceBuilder,
         string basePath = null,
         string baseUrl = null,
         FileStorageNaming naming = FileStorageNaming.UniqueFileNames,
+        bool generateVersionParam = false,
         ServiceLifetime scope = ServiceLifetime.Singleton)
     {
-        serviceBuilder.Services.AddPiranhaFileStorage(basePath, baseUrl, naming, scope);
+        serviceBuilder.Services.AddPiranhaFileStorage(basePath, baseUrl, naming, generateVersionParam, scope);
 
         return serviceBuilder;
     }

diff --git a/core/Piranha.Local.FileStorage/FileStorage.cs b/core/Piranha.Local.FileStorage/FileStorage.cs
@@ -17,17 +17,20 @@ public class FileStorage : IStorage
     private readonly string _basePath = "wwwroot/uploads/";
     private readonly string _baseUrl = "~/uploads/";
     private readonly FileStorageNaming _naming;
+    private readonly bool _versionParam;
 
     /// <summary>
     /// Default constructor.
     /// </summary>
     /// <param name="basePath">The optional base path</param>
     /// <param name="baseUrl">The optional base url</param>
     /// <param name="naming">How uploaded media files should be named</param>
+    /// <param name="generateVersionParam">If a version param should be appended to the public url</param>
     public FileStorage(
         string basePath = null,
         string baseUrl = null,
-        FileStorageNaming naming = FileStorageNaming.UniqueFileNames)
+        FileStorageNaming naming = FileStorageNaming.UniqueFileNames,
+        bool generateVersionParam = false)
     {
         if (!string.IsNullOrEmpty(basePath))
         {
@@ -44,6 +47,7 @@ public FileStorage(
         }
 
         _naming = naming;
+        _versionParam = generateVersionParam;
     }
 
     /// <summary>
@@ -68,7 +72,21 @@ public string GetPublicUrl(Media media, string filename)
     {
         if (media != null && !string.IsNullOrWhiteSpace(filename))
         {
-            return _baseUrl + GetResourceName(media, filename, true);
+            var publicUrl = _baseUrl + GetResourceName(media, filename, true);
+            if (_versionParam)
+            {
+                var versionHash = Math.Abs(media.LastModified.GetHashCode()).ToString();
+
+                if (!publicUrl.Contains("?"))
+                {
+                    publicUrl += $"?version={ versionHash }";
+                }
+                else
+                {
+                    publicUrl += $"&version={ versionHash }";
+                }
+            }
+            return publicUrl;
         }
         return null;
     }