Allow changing UmbracoMediaPath to an absolute path. Also ensure Imagesharp are handing requests outside of the wwwroot folder.

bergmania · bergmania · commit 7b6539ff777e · 2021-12-21T18:28:46.000+01:00
diff --git a/src/Umbraco.Core/Configuration/Models/GlobalSettings.cs b/src/Umbraco.Core/Configuration/Models/GlobalSettings.cs
@@ -24,6 +24,7 @@ public class GlobalSettings
         internal const string StaticUmbracoCssPath = "~/css";
         internal const string StaticUmbracoScriptsPath = "~/scripts";
         internal const string StaticUmbracoMediaPath = "~/media";
+        internal const string StaticUmbracoMediaUrl = "~/media";
         internal const bool StaticInstallMissingDatabase = false;
         internal const bool StaticDisableElectionForSingleServer = false;
         internal const string StaticNoNodesViewPath = "~/umbraco/UmbracoWebsite/NoNodes.cshtml";
@@ -109,6 +110,13 @@ public class GlobalSettings
         [DefaultValue(StaticUmbracoMediaPath)]
         public string UmbracoMediaPath { get; set; } = StaticUmbracoMediaPath;
 
+
+        /// <summary>
+        /// Gets or sets a value for the Umbraco media url. Starts with "~/".
+        /// </summary>
+        [DefaultValue(StaticUmbracoMediaUrl)]
+        public string UmbracoMediaUrl { get; set; } = StaticUmbracoMediaUrl;
+
         /// <summary>
         /// Gets or sets a value indicating whether to install the database when it is missing.
         /// </summary>
@@ -179,4 +187,4 @@ public class GlobalSettings
         [DefaultValue(StaticSqlWriteLockTimeOut)]
         public TimeSpan SqlWriteLockTimeOut { get; } = TimeSpan.Parse(StaticSqlWriteLockTimeOut);
     }
-}
+}
diff --git a/src/Umbraco.Core/Constants-SystemDirectories.cs b/src/Umbraco.Core/Constants-SystemDirectories.cs
@@ -43,6 +43,8 @@ public static class SystemDirectories
 
             public const string AppPlugins = "/App_Plugins";
             public static string AppPluginIcons => "/Backoffice/Icons";
+            public const string CreatedPackages = "/created-packages";
+
 
             public const string MvcViews = "~/Views";
 
diff --git a/src/Umbraco.Core/Packaging/PackagesRepository.cs b/src/Umbraco.Core/Packaging/PackagesRepository.cs
@@ -93,7 +93,7 @@ public PackagesRepository(
 
             _tempFolderPath = tempFolderPath ?? Constants.SystemDirectories.TempData.EnsureEndsWith('/') + "PackageFiles";
             _packagesFolderPath = packagesFolderPath ?? Constants.SystemDirectories.Packages;
-            _mediaFolderPath = mediaFolderPath ?? globalSettings.Value.UmbracoMediaPath + "/created-packages";
+            _mediaFolderPath = mediaFolderPath ?? Path.Combine(globalSettings.Value.UmbracoMediaPath, Constants.SystemDirectories.CreatedPackages);
 
             _parser = new PackageDefinitionXmlParser();
             _mediaService = mediaService;
diff --git a/src/Umbraco.Infrastructure/DependencyInjection/UmbracoBuilder.FileSystems.cs b/src/Umbraco.Infrastructure/DependencyInjection/UmbracoBuilder.FileSystems.cs
@@ -50,7 +50,7 @@ internal static IUmbracoBuilder AddFileSystems(this IUmbracoBuilder builder)
                 GlobalSettings globalSettings = factory.GetRequiredService<IOptions<GlobalSettings>>().Value;
 
                 var rootPath = hostingEnvironment.MapPathWebRoot(globalSettings.UmbracoMediaPath);
-                var rootUrl = hostingEnvironment.ToAbsolute(globalSettings.UmbracoMediaPath);
+                var rootUrl = hostingEnvironment.ToAbsolute(globalSettings.UmbracoMediaUrl);
                 return new PhysicalFileSystem(ioHelper, hostingEnvironment, logger, rootPath, rootUrl);
             });
 
diff --git a/src/Umbraco.Infrastructure/Persistence/Repositories/Implement/CreatedPackageSchemaRepository.cs b/src/Umbraco.Infrastructure/Persistence/Repositories/Implement/CreatedPackageSchemaRepository.cs
@@ -76,7 +76,7 @@ public CreatedPackageSchemaRepository(
             _macroService = macroService;
             _contentTypeService = contentTypeService;
             _xmlParser = new PackageDefinitionXmlParser();
-            _mediaFolderPath = mediaFolderPath ?? globalSettings.Value.UmbracoMediaPath + "/created-packages";
+            _mediaFolderPath = mediaFolderPath ?? Path.Combine(globalSettings.Value.UmbracoMediaPath,  Constants.SystemDirectories.CreatedPackages);
             _tempFolderPath =
                 tempFolderPath ?? Constants.SystemDirectories.TempData.EnsureEndsWith('/') + "PackageFiles";
         }
diff --git a/src/Umbraco.Web.BackOffice/Controllers/BackOfficeServerVariables.cs b/src/Umbraco.Web.BackOffice/Controllers/BackOfficeServerVariables.cs
@@ -384,7 +384,7 @@ internal async Task<Dictionary<string, object>> GetServerVariablesAsync()
                     "umbracoSettings", new Dictionary<string, object>
                     {
                         {"umbracoPath", _globalSettings.GetBackOfficePath(_hostingEnvironment)},
-                        {"mediaPath", _hostingEnvironment.ToAbsolute(globalSettings.UmbracoMediaPath).TrimEnd(Constants.CharArrays.ForwardSlash)},
+                        {"mediaPath", _hostingEnvironment.ToAbsolute(globalSettings.UmbracoMediaUrl).TrimEnd(Constants.CharArrays.ForwardSlash)},
                         {"appPluginsPath", _hostingEnvironment.ToAbsolute(Constants.SystemDirectories.AppPlugins).TrimEnd(Constants.CharArrays.ForwardSlash)},
                         {
                             "imageFileTypes",
diff --git a/src/Umbraco.Web.Common/ApplicationBuilder/UmbracoApplicationBuilder.cs b/src/Umbraco.Web.Common/ApplicationBuilder/UmbracoApplicationBuilder.cs
@@ -1,9 +1,13 @@
 using System;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.FileProviders;
 using Microsoft.Extensions.Options;
 using SixLabors.ImageSharp.Web.DependencyInjection;
+using Umbraco.Cms.Core.Configuration.Models;
+using Umbraco.Cms.Core.Hosting;
 using Umbraco.Cms.Core.Services;
+using Umbraco.Cms.Web.Common.ImageProcessors;
 using Umbraco.Extensions;
 
 namespace Umbraco.Cms.Web.Common.ApplicationBuilder
@@ -22,7 +26,7 @@ public UmbracoApplicationBuilder(IApplicationBuilder appBuilder)
         {
             AppBuilder = appBuilder ?? throw new ArgumentNullException(nameof(appBuilder));
             ApplicationServices = appBuilder.ApplicationServices;
-            RuntimeState = appBuilder.ApplicationServices.GetRequiredService<IRuntimeState>();            
+            RuntimeState = appBuilder.ApplicationServices.GetRequiredService<IRuntimeState>();
             _umbracoPipelineStartupOptions = ApplicationServices.GetRequiredService<IOptions<UmbracoPipelineOptions>>();
         }
 
@@ -87,9 +91,19 @@ public void RegisterDefaultRequiredMiddleware()
 
             AppBuilder.UseStatusCodePages();
 
-            // Important we handle image manipulations before the static files, otherwise the querystring is just ignored.            
+            // Important we handle image manipulations before the static files, otherwise the querystring is just ignored.
             AppBuilder.UseImageSharp();
+
+            GlobalSettings globalSettings = AppBuilder.ApplicationServices.GetRequiredService<IOptions<GlobalSettings>>().Value;
+            IUmbracoMediaFileProvider umbracoMediaFileProvider = AppBuilder.ApplicationServices.GetRequiredService<IUmbracoMediaFileProvider>();
+
+            AppBuilder.UseStaticFiles(new StaticFileOptions()
+            {
+                FileProvider = umbracoMediaFileProvider,
+                RequestPath = globalSettings.UmbracoMediaUrl.TrimStart("~")
+            });
             AppBuilder.UseStaticFiles();
+
             AppBuilder.UseUmbracoPluginsStaticFiles();
 
             // UseRouting adds endpoint routing middleware, this means that middlewares registered after this one
diff --git a/src/Umbraco.Web.Common/DependencyInjection/UmbracoBuilder.ImageSharp.cs b/src/Umbraco.Web.Common/DependencyInjection/UmbracoBuilder.ImageSharp.cs
@@ -3,13 +3,17 @@
 using Microsoft.AspNetCore.Http;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.DependencyInjection.Extensions;
+using Microsoft.Extensions.FileProviders;
 using Microsoft.Extensions.Options;
 using Microsoft.Net.Http.Headers;
+using SixLabors.ImageSharp.Web;
 using SixLabors.ImageSharp.Web.Caching;
 using SixLabors.ImageSharp.Web.Commands;
 using SixLabors.ImageSharp.Web.DependencyInjection;
 using SixLabors.ImageSharp.Web.Middleware;
 using SixLabors.ImageSharp.Web.Processors;
+using SixLabors.ImageSharp.Web.Providers;
 using Umbraco.Cms.Core.Configuration.Models;
 using Umbraco.Cms.Core.DependencyInjection;
 using Umbraco.Cms.Web.Common.DependencyInjection;
@@ -28,54 +32,62 @@ public static IServiceCollection AddUmbracoImageSharp(this IUmbracoBuilder build
                 .Get<ImagingSettings>() ?? new ImagingSettings();
 
             builder.Services.AddImageSharp(options =>
-            {
-                // options.Configuration is set using ImageSharpConfigurationOptions below
-                options.BrowserMaxAge = imagingSettings.Cache.BrowserMaxAge;
-                options.CacheMaxAge = imagingSettings.Cache.CacheMaxAge;
-                options.CachedNameLength = imagingSettings.Cache.CachedNameLength;
-
-                // Use configurable maximum width and height (overwrite ImageSharps default)
-                options.OnParseCommandsAsync = context =>
                 {
-                    if (context.Commands.Count == 0)
-                    {
-                        return Task.CompletedTask;
-                    }
+                    // options.Configuration is set using ImageSharpConfigurationOptions below
+                    options.BrowserMaxAge = imagingSettings.Cache.BrowserMaxAge;
+                    options.CacheMaxAge = imagingSettings.Cache.CacheMaxAge;
+                    options.CachedNameLength = imagingSettings.Cache.CachedNameLength;
 
-                    uint width = context.Parser.ParseValue<uint>(context.Commands.GetValueOrDefault(ResizeWebProcessor.Width), context.Culture);
-                    uint height = context.Parser.ParseValue<uint>(context.Commands.GetValueOrDefault(ResizeWebProcessor.Height), context.Culture);
-                    if (width > imagingSettings.Resize.MaxWidth || height > imagingSettings.Resize.MaxHeight)
+                    // Use configurable maximum width and height (overwrite ImageSharps default)
+                    options.OnParseCommandsAsync = context =>
                     {
-                        context.Commands.Remove(ResizeWebProcessor.Width);
-                        context.Commands.Remove(ResizeWebProcessor.Height);
-                    }
+                        if (context.Commands.Count == 0)
+                        {
+                            return Task.CompletedTask;
+                        }
 
-                    return Task.CompletedTask;
-                };
-                options.OnBeforeSaveAsync = _ => Task.CompletedTask;
-                options.OnProcessedAsync = _ => Task.CompletedTask;
-                options.OnPrepareResponseAsync = context =>
-                {
-                    // Change Cache-Control header when cache buster value is present
-                    if (context.Request.Query.ContainsKey("rnd"))
+                        uint width =
+                            context.Parser.ParseValue<uint>(
+                                context.Commands.GetValueOrDefault(ResizeWebProcessor.Width), context.Culture);
+                        uint height = context.Parser.ParseValue<uint>(
+                            context.Commands.GetValueOrDefault(ResizeWebProcessor.Height), context.Culture);
+                        if (width > imagingSettings.Resize.MaxWidth || height > imagingSettings.Resize.MaxHeight)
+                        {
+                            context.Commands.Remove(ResizeWebProcessor.Width);
+                            context.Commands.Remove(ResizeWebProcessor.Height);
+                        }
+
+                        return Task.CompletedTask;
+                    };
+                    options.OnBeforeSaveAsync = _ => Task.CompletedTask;
+                    options.OnProcessedAsync = _ => Task.CompletedTask;
+                    options.OnPrepareResponseAsync = context =>
                     {
-                        var headers = context.Response.GetTypedHeaders();
+                        // Change Cache-Control header when cache buster value is present
+                        if (context.Request.Query.ContainsKey("rnd"))
+                        {
+                            var headers = context.Response.GetTypedHeaders();
 
-                        var cacheControl = headers.CacheControl;
-                        cacheControl.MustRevalidate = false;
-                        cacheControl.Extensions.Add(new NameValueHeaderValue("immutable"));
+                            var cacheControl = headers.CacheControl;
+                            cacheControl.MustRevalidate = false;
+                            cacheControl.Extensions.Add(new NameValueHeaderValue("immutable"));
 
-                        headers.CacheControl = cacheControl;
-                    }
+                            headers.CacheControl = cacheControl;
+                        }
 
-                    return Task.CompletedTask;
-                };
-            })
-                .Configure<PhysicalFileSystemCacheOptions>(options => options.CacheFolder = builder.BuilderHostingEnvironment.MapPathContentRoot(imagingSettings.Cache.CacheFolder))
-                .AddProcessor<CropWebProcessor>();
+                        return Task.CompletedTask;
+                    };
+                })
+                .Configure<PhysicalFileSystemCacheOptions>(options =>
+                    options.CacheFolder =
+                        builder.BuilderHostingEnvironment.MapPathContentRoot(imagingSettings.Cache.CacheFolder))
+                .AddProcessor<CropWebProcessor>()
+                .ClearProviders()
+                .AddProvider<UmbracoImageProvider>();
 
             builder.Services.AddTransient<IConfigureOptions<ImageSharpMiddlewareOptions>, ImageSharpConfigurationOptions>();
 
+            builder.Services.AddUnique<IUmbracoMediaFileProvider, UmbracoMediaFileProvider>();
             return builder.Services;
         }
     }
diff --git a/src/Umbraco.Web.Common/ImageProcessors/IUmbracoMediaFileProvider.cs b/src/Umbraco.Web.Common/ImageProcessors/IUmbracoMediaFileProvider.cs
@@ -0,0 +1,8 @@
+﻿using Microsoft.Extensions.FileProviders;
+
+namespace Umbraco.Cms.Web.Common.ImageProcessors
+{
+    public interface IUmbracoMediaFileProvider : IFileProvider
+    {
+    }
+}
diff --git a/src/Umbraco.Web.Common/ImageProcessors/UmbracoMediaFileProvider.cs b/src/Umbraco.Web.Common/ImageProcessors/UmbracoMediaFileProvider.cs
@@ -0,0 +1,15 @@
+﻿using Microsoft.Extensions.FileProviders;
+using Microsoft.Extensions.Options;
+using Umbraco.Cms.Core.Configuration.Models;
+using Umbraco.Cms.Core.Hosting;
+
+namespace Umbraco.Cms.Web.Common.ImageProcessors
+{
+    internal class UmbracoMediaFileProvider : PhysicalFileProvider, IUmbracoMediaFileProvider
+    {
+        public UmbracoMediaFileProvider(IHostingEnvironment hostingEnvironment, IOptions<GlobalSettings> globalSettings)
+            : base(hostingEnvironment.MapPathWebRoot(globalSettings.Value.UmbracoMediaPath))
+        {
+        }
+    }
+}
diff --git a/src/Umbraco.Web.Common/ImageProcessors/UmbracoMediaPhysicalFileSystemProvider.cs b/src/Umbraco.Web.Common/ImageProcessors/UmbracoMediaPhysicalFileSystemProvider.cs
@@ -0,0 +1,53 @@
+﻿using System;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Http.Extensions;
+using Microsoft.Extensions.FileProviders;
+using Microsoft.Extensions.Options;
+using SixLabors.ImageSharp.Web;
+using SixLabors.ImageSharp.Web.Providers;
+using SixLabors.ImageSharp.Web.Resolvers;
+using Umbraco.Cms.Core.Configuration.Models;
+using Umbraco.Extensions;
+
+namespace Umbraco.Cms.Web.Common.ImageProcessors
+{
+    public class UmbracoImageProvider : IImageProvider
+    {
+        private readonly IFileProvider _fileProvider;
+        private readonly FormatUtilities _formatUtilities;
+        private readonly string _mediaUrlPrefix;
+
+        public UmbracoImageProvider(IUmbracoMediaFileProvider fileProvider, FormatUtilities formatUtilities, IOptions<GlobalSettings> globalSettings)
+        {
+            _fileProvider = fileProvider;
+            _formatUtilities = formatUtilities;
+            _mediaUrlPrefix = globalSettings.Value.UmbracoMediaUrl.TrimStart(Core.Constants.CharArrays.Tilde);
+        }
+
+        /// <inheritdoc/>
+        public bool IsValidRequest(HttpContext context) => _formatUtilities.GetExtensionFromUri(context.Request.GetDisplayUrl()) != null;
+
+        /// <inheritdoc/>
+        public Task<IImageResolver> GetAsync(HttpContext context)
+        {
+            // Path has already been correctly parsed before here.
+            IFileInfo fileInfo = _fileProvider.GetFileInfo(context.Request.Path.Value.TrimStart(_mediaUrlPrefix));
+
+            // Check to see if the file exists.
+            if (!fileInfo.Exists)
+            {
+                return Task.FromResult<IImageResolver>(null);
+            }
+
+            var metadata = new ImageMetadata(fileInfo.LastModified.UtcDateTime, fileInfo.Length);
+            return Task.FromResult<IImageResolver>(new PhysicalFileSystemResolver(fileInfo, metadata));
+        }
+
+        /// <inheritdoc/>
+        public ProcessingBehavior ProcessingBehavior { get; } = ProcessingBehavior.CommandOnly;
+
+        /// <inheritdoc/>
+        public Func<HttpContext, bool> Match { get; set; } = _ => true;
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@ public CreatedPackageSchemaRepository(`
`76`	`76`	`_macroService = macroService;`
`77`	`77`	`_contentTypeService = contentTypeService;`
`78`	`78`	`_xmlParser = new PackageDefinitionXmlParser();`
`79`		`- _mediaFolderPath = mediaFolderPath ?? globalSettings.Value.UmbracoMediaPath + "/created-packages";`
	`79`	`+ _mediaFolderPath = mediaFolderPath ?? Path.Combine(globalSettings.Value.UmbracoMediaPath, Constants.SystemDirectories.CreatedPackages);`
`80`	`80`	`_tempFolderPath =`
`81`	`81`	`tempFolderPath ?? Constants.SystemDirectories.TempData.EnsureEndsWith('/') + "PackageFiles";`
`82`	`82`	`}`
Original file line number	Diff line number	Diff line change
`@@ -384,7 +384,7 @@ internal async Task<Dictionary<string, object>> GetServerVariablesAsync()`
`384`	`384`	`"umbracoSettings", new Dictionary<string, object>`
`385`	`385`	`{`
`386`	`386`	`{"umbracoPath", _globalSettings.GetBackOfficePath(_hostingEnvironment)},`
`387`		`- {"mediaPath", _hostingEnvironment.ToAbsolute(globalSettings.UmbracoMediaPath).TrimEnd(Constants.CharArrays.ForwardSlash)},`
	`387`	`+ {"mediaPath", _hostingEnvironment.ToAbsolute(globalSettings.UmbracoMediaUrl).TrimEnd(Constants.CharArrays.ForwardSlash)},`
`388`	`388`	`{"appPluginsPath", _hostingEnvironment.ToAbsolute(Constants.SystemDirectories.AppPlugins).TrimEnd(Constants.CharArrays.ForwardSlash)},`
`389`	`389`	`{`
`390`	`390`	`"imageFileTypes",`