Adds asp-append-version support

src/OrchardCore.Modules/OrchardCore.Liquid/README.md

@@ -231,6 +231,8 @@ Gives access to the current site settings, e.g `Site.SiteName`.
 | `SuperUser` | `admin` | The user name of the site's super user. | 
 | `TimeZoneId` | `America/Los_Angeles` | The site's time zone id as per the tz database, c.f., https://en.wikipedia.org/wiki/List_of_tz_database_time_zones | 
 | `UseCdn` | `false` | Enable/disable the use of a CDN. | 
+| `ResourceDebugMode` | `Disabled` | Provides options for whether src or debug-src is used for loading scripts and stylesheets | 
+| `CdnBaseUrl` | `https://localhost:44300` | If provided a CDN Base url is prepended to local scripts and stylesheets  | 
 
 ### Request
 

src/OrchardCore.Modules/OrchardCore.Media/Filters/MediaFilters.cs

@@ -1,7 +1,8 @@
-using System;
 using System.Threading.Tasks;
 using Fluid;
 using Fluid.Values;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc.ViewFeatures;
 using OrchardCore.Liquid;
 
 namespace OrchardCore.Media.Filters
@@ -76,4 +77,27 @@ public ValueTask<FluidValue> ProcessAsync(FluidValue input, FilterArguments argu
             return new ValueTask<FluidValue>(new StringValue(url));
         }
     }
+
+    public class AppendVersionFilter : ILiquidFilter
+    {
+        private readonly IFileVersionProvider _fileVersionProvider;
+        private readonly IHttpContextAccessor _httpContextAccessor;
+
+        public AppendVersionFilter(
+            IFileVersionProvider fileVersionProvider,
+            IHttpContextAccessor httpContextAccessor)
+        {
+            _fileVersionProvider = fileVersionProvider;
+            _httpContextAccessor = httpContextAccessor;
+        }
+
+        public ValueTask<FluidValue> ProcessAsync(FluidValue input, FilterArguments arguments, TemplateContext ctx)
+        {
+            var url = input.ToStringValue();
+
+            var imageUrl = _fileVersionProvider.AddFileVersionToPath(_httpContextAccessor.HttpContext.Request.PathBase, url);
+
+            return new ValueTask<FluidValue>(new StringValue(imageUrl ?? url));
+        }
+    }
 }

src/OrchardCore.Modules/OrchardCore.Media/Processing/ImageVersionProcessor.cs

@@ -0,0 +1,17 @@
+using System.Collections.Generic;
+using Microsoft.Extensions.Logging;
+using SixLabors.ImageSharp.Web;
+using SixLabors.ImageSharp.Web.Processors;
+
+namespace OrchardCore.Media.Processing
+{
+    public class ImageVersionProcessor : IImageWebProcessor
+    {
+        private static readonly IEnumerable<string> VersionCommands = new[] { "v" };
+
+        public IEnumerable<string> Commands => VersionCommands;
+
+        public FormattedImage Process(FormattedImage image, ILogger logger, IDictionary<string, string> commands)
+            => image;
+    }
+}

src/OrchardCore.Modules/OrchardCore.Media/Processing/MediaFileProvider.cs → src/OrchardCore.Modules/OrchardCore.Media/Processing/MediaResizingFileProvider.cs

@@ -17,15 +17,15 @@
 
 namespace OrchardCore.Media.Processing
 {
-    public class MediaFileProvider : IImageProvider
+    public class MediaResizingFileProvider : IImageProvider
     {
         public static int[] DefaultSizes = new[] { 16, 32, 50, 100, 160, 240, 480, 600, 1024, 2048 };
 
         private readonly IMediaFileStore _mediaStore;
         private readonly FormatUtilities _formatUtilities;
         private readonly int[] _supportedSizes;
 
-        public MediaFileProvider(
+        public MediaResizingFileProvider(
             IMediaFileStore mediaStore,
             IOptions<ImageSharpMiddlewareOptions> options,
             IShellConfiguration shellConfiguration)

src/OrchardCore.Modules/OrchardCore.Media/README.md

@@ -107,6 +107,18 @@ Resizes the image using the same functionality as `max` then removes any image a
 
 `<img src="~/media/animals/kittens.jpg?width=100&height=240&rmode=crop" />`
 
+### `append_version`
+
+Appends a version hash for an asset. Can be piped together with the other media filters.
+
+#### Input
+
+`{{ 'animals/kittens.jpg' | asset_url | append_version | img_tag }}`
+
+#### Output
+
+`<img src="~/media/animals/kittens.jpg?v=Ailxbj_jQtYc9LRXKa21DygRzmQqc3OfN1XxSaQ3UWE" />`
+
 ## Razor Helpers
 
 To obtain the correct URL for an asset, use the `AssetUrl` helper extension method on the view's base `Orchard` property, e.g.:
@@ -117,16 +129,39 @@ To obtain the correct URL for a resized asset use `AssetUrl` with the optional w
 
 `@Orchard.AssetUrl(Model.Paths[0], width: 100 , height: 240, resizeMode: ResizeMode.Crop)`
 
+To append a version hash for an asset use `AssetUrl` with the append version parameter, e.g.:
+
+`@Orchard.AssetUrl(Model.Paths[0], appendVersion: true)`
+
+or with resizing options as well, noting that the version hash is based on the source image
+
+`@Orchard.AssetUrl(Model.Paths[0], width: 100 , height: 240, resizeMode: ResizeMode.Crop, appendVersion: true)`
+
 ### Razor image resizing tag helpers
 
-To use the image tag helpers add `@addTagHelper *, OrchardCore.Media` to `_ViewImports.cshtml`. `asset-src` is used to obtain the correct URL for the asset and set the `src` attribute. Width, height and resize mode can be set using `img-width`, `img-height` and `img-resize-mode` respectively. e.g.:
+To use the image tag helpers add `@addTagHelper *, OrchardCore.Media` to `_ViewImports.cshtml`. 
+
+`asset-src` is used to obtain the correct URL for the asset and set the `src` attribute. Width, height and resize mode can be set using `img-width`, `img-height` and `img-resize-mode` respectively. e.g.:
 
 `<img asset-src="Model.Paths[0]" alt="..." img-width="100" img-height="240" img-resize-mode="Crop" />`
 
 Alternatively the Asset Url can be resolved independently and the `src` attribute used:
 
 `<img src="@Orchard.AssetUrl(Model.Paths[0])" alt="..." img-width="100" img-height="240" img-resize-mode="Crop" />`
 
+### Razor append version
+`asp-append-version` support is available on the OrchardCore tag helpers and MVC tag helpers.
+
+`<img asset-src="Model.Paths[0]" alt="..." asp-append-version="true" />`
+
+Alternatively the Asset Url can be resolved independently and the `src` attribute used:
+
+`<img src="@Orchard.AssetUrl(Model.Paths[0])" alt="..." asp-append-version="true" />`
+
+Or when using the MVC tag helpers and the image is resolved from static assets, i.e. wwwroot
+
+`<img src="/favicon.ico" asp-append-version="true"/>`
+
 > The Razor Helper is accessible on the `Orchard` property if the view is using Orchard Core's Razor base class, or by injecting `OrchardCore.IOrchardHelper` in all other cases.
 
 ## Deployment Step Editor

src/OrchardCore.Modules/OrchardCore.Media/Razor/OrchardRazorHelperExtensions.cs

@@ -1,3 +1,4 @@
+using Microsoft.AspNetCore.Mvc.ViewFeatures;
 using Microsoft.Extensions.DependencyInjection;
 using OrchardCore;
 using OrchardCore.Media;
@@ -8,7 +9,7 @@ public static class OrchardRazorHelperExtensions
     /// <summary>
     /// Returns the relative URL of the specifier asset path with optional resizing parameters.
     /// </summary>
-    public static string AssetUrl(this IOrchardHelper orchardHelper, string assetPath, int? width = null, int? height = null, ResizeMode resizeMode = ResizeMode.Undefined)
+    public static string AssetUrl(this IOrchardHelper orchardHelper, string assetPath, int? width = null, int? height = null, ResizeMode resizeMode = ResizeMode.Undefined, bool appendVersion = false)
     {
         var mediaFileStore = orchardHelper.HttpContext.RequestServices.GetService<IMediaFileStore>();
 
@@ -19,7 +20,15 @@ public static string AssetUrl(this IOrchardHelper orchardHelper, string assetPat
 
         var resolvedAssetPath = mediaFileStore.MapPathToPublicUrl(assetPath);
 
-        return orchardHelper.ImageResizeUrl(resolvedAssetPath, width, height, resizeMode);
+        var resizedUrl = orchardHelper.ImageResizeUrl(resolvedAssetPath, width, height, resizeMode);
+
+        if (appendVersion)
+        {
+            var fileVersionProvider = orchardHelper.HttpContext.RequestServices.GetService<IFileVersionProvider>();
+
+            resizedUrl = fileVersionProvider.AddFileVersionToPath(orchardHelper.HttpContext.Request.PathBase, resizedUrl);
+        }
+        return resizedUrl;
     }
 
     /// <summary>

src/OrchardCore.Modules/OrchardCore.Media/Services/MediaFileProvider.cs

@@ -0,0 +1,18 @@
+using Microsoft.Extensions.FileProviders;
+using Microsoft.Extensions.FileProviders.Physical;
+
+namespace OrchardCore.Media.Services
+{
+    public class MediaFileProvider : PhysicalFileProvider, IMediaFileProvider
+    {
+        public string VirtualPathBase { get; set; }
+        public MediaFileProvider(string virtualPathBase, string root) : base(root)
+        {
+            VirtualPathBase = virtualPathBase;
+        }
+        public MediaFileProvider(string virtualPathBase, string root, ExclusionFilters filters) : base(root, filters)
+        {
+            VirtualPathBase = virtualPathBase;
+        }
+    }
+}

src/OrchardCore.Modules/OrchardCore.Media/Startup.cs

@@ -76,6 +76,25 @@ public Startup(IShellConfiguration shellConfiguration)
 
         public override void ConfigureServices(IServiceCollection services)
         {
+            services.AddSingleton<IMediaFileProvider>(serviceProvider =>
+            {
+                var shellOptions = serviceProvider.GetRequiredService<IOptions<ShellOptions>>();
+                var shellSettings = serviceProvider.GetRequiredService<ShellSettings>();
+
+                var mediaPath = GetMediaPath(shellOptions.Value, shellSettings);
+
+                if (!Directory.Exists(mediaPath))
+                {
+                    Directory.CreateDirectory(mediaPath);
+                }
+                return new MediaFileProvider(AssetsUrlPrefix, mediaPath);
+            });
+
+            services.AddSingleton<IFileProvider>(serviceProvider =>
+            {
+                return serviceProvider.GetRequiredService<IMediaFileProvider>();
+            });
+
             services.AddSingleton<IMediaFileStore>(serviceProvider =>
             {
                 var shellOptions = serviceProvider.GetRequiredService<IOptions<ShellOptions>>();
@@ -107,6 +126,7 @@ public override void ConfigureServices(IServiceCollection services)
             services.AddLiquidFilter<MediaUrlFilter>("asset_url");
             services.AddLiquidFilter<ResizeUrlFilter>("resize_url");
             services.AddLiquidFilter<ImageTagFilter>("img_tag");
+            services.AddLiquidFilter<AppendVersionFilter>("append_version");
 
             // ImageSharp
 
@@ -145,9 +165,10 @@ public override void ConfigureServices(IServiceCollection services)
             .SetMemoryAllocator<ArrayPoolMemoryAllocator>()
             .SetCache<PhysicalFileSystemCache>()
             .SetCacheHash<CacheHash>()
-            .AddProvider<MediaFileProvider>()
+            .AddProvider<MediaResizingFileProvider>()
             .AddProcessor<ResizeWebProcessor>()
             .AddProcessor<FormatWebProcessor>()
+            .AddProcessor<ImageVersionProcessor>()
             .AddProcessor<BackgroundColorWebProcessor>();
 
             // Media Field
@@ -169,15 +190,7 @@ public override void ConfigureServices(IServiceCollection services)
 
         public override void Configure(IApplicationBuilder app, IRouteBuilder routes, IServiceProvider serviceProvider)
         {
-            var shellOptions = serviceProvider.GetRequiredService<IOptions<ShellOptions>>();
-            var shellSettings = serviceProvider.GetRequiredService<ShellSettings>();
-
-            var mediaPath = GetMediaPath(shellOptions.Value, shellSettings);
-
-            if (!Directory.Exists(mediaPath))
-            {
-                Directory.CreateDirectory(mediaPath);
-            }
+            var mediaFileProvider = serviceProvider.GetRequiredService<IMediaFileProvider>();
 
             // ImageSharp before the static file provider
             app.UseImageSharp();
@@ -186,7 +199,7 @@ public override void Configure(IApplicationBuilder app, IRouteBuilder routes, IS
             {
                 // The tenant's prefix is already implied by the infrastructure
                 RequestPath = AssetsUrlPrefix,
-                FileProvider = new PhysicalFileProvider(mediaPath),
+                FileProvider = mediaFileProvider,
                 ServeUnknownFileTypes = true,
             });
         }

src/OrchardCore.Modules/OrchardCore.Media/TagHelpers/ImageTagHelper.cs

@@ -1,3 +1,5 @@
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc.ViewFeatures;
 using Microsoft.AspNetCore.Razor.TagHelpers;
 
 namespace OrchardCore.Media.TagHelpers
@@ -7,16 +9,39 @@ public class ImageTagHelper : TagHelper
     {
         private const string AssetSrcAttributeName = "asset-src";
 
+        private const string AppendVersionAttributeName = "append-version";
+
         private readonly IMediaFileStore _mediaFileStore;
 
+        private readonly IFileVersionProvider _fileVersionProvider;
+
+        private readonly IHttpContextAccessor _httpContextAccessor;
+
+        //private string _pathBase;
+
         public override int Order => -10;
 
         [HtmlAttributeName(AssetSrcAttributeName)]
         public string AssetSrc { get; set; }
 
-        public ImageTagHelper(IMediaFileStore mediaFileStore)
+        /// <summary>
+        /// Value indicating if file version should be appended to the src urls.
+        /// </summary>
+        /// <remarks>
+        /// If <c>true</c> then a query string "v" with the encoded content of the file is added.
+        /// </remarks>
+        [HtmlAttributeName(AppendVersionAttributeName)]
+        public bool AppendVersion { get; set; }
+
+        public ImageTagHelper(
+            IMediaFileStore mediaFileStore,
+            IHttpContextAccessor httpContextAccessor,
+            IFileVersionProvider fileVersionProvider
+            )
         {
             _mediaFileStore = mediaFileStore;
+            _httpContextAccessor = httpContextAccessor;
+            _fileVersionProvider = fileVersionProvider;
         }
 
         public override void Process(TagHelperContext context, TagHelperOutput output)
@@ -28,6 +53,11 @@ public override void Process(TagHelperContext context, TagHelperOutput output)
 
             var resolvedSrc = _mediaFileStore != null ? _mediaFileStore.MapPathToPublicUrl(AssetSrc) : AssetSrc;
             output.Attributes.SetAttribute("src", resolvedSrc);
+
+            if (AppendVersion && _fileVersionProvider != null)
+            {
+                output.Attributes.SetAttribute("src", _fileVersionProvider.AddFileVersionToPath(_httpContextAccessor.HttpContext.Request.PathBase, resolvedSrc));
+            }
         }
     }
 }