Add ContainerRootPath option (#20)

* Add ContainerRootPath option

* Make sure the Umbraco media path is used in Umbraco, but the container root path is used for blob client

Author: Swimburger

src/Umbraco.StorageProviders.AzureBlob/AzureBlobFileSystemMiddleware.cs

@@ -26,6 +26,7 @@ public class AzureBlobFileSystemMiddleware : IMiddleware
         private readonly string _name;
         private readonly IAzureBlobFileSystemProvider _fileSystemProvider;
         private string _rootPath;
+        private string _containerRootPath;
         private readonly TimeSpan? _maxAge = TimeSpan.FromDays(7);
 
         /// <summary>
@@ -63,6 +64,7 @@ protected AzureBlobFileSystemMiddleware(string name, IOptionsMonitor<AzureBlobFi
 
             var fileSystemOptions = options.Get(name);
             _rootPath = hostingEnvironment.ToAbsolute(fileSystemOptions.VirtualPath);
+            _containerRootPath = fileSystemOptions.ContainerRootPath ?? _rootPath;
 
             options.OnChange((o, n) => OptionsOnChange(o, n, hostingEnvironment));
         }
@@ -87,7 +89,8 @@ private async Task HandleRequestAsync(HttpContext context, RequestDelegate next)
                 return;
             }
 
-            var blob = _fileSystemProvider.GetFileSystem(_name).GetBlobClient(request.Path);
+            string containerPath = $"{_containerRootPath.TrimEnd('/')}/{(request.Path.Value.Remove(0, _rootPath.Length)).TrimStart('/')}";
+            var blob = _fileSystemProvider.GetFileSystem(_name).GetBlobClient(containerPath);
 
             var blobRequestConditions = GetAccessCondition(context.Request);
 
@@ -98,13 +101,13 @@ private async Task HandleRequestAsync(HttpContext context, RequestDelegate next)
             {
                 properties = await blob.GetPropertiesAsync(blobRequestConditions, context.RequestAborted).ConfigureAwait(false);
             }
-            catch (RequestFailedException ex) when (ex.Status == (int) HttpStatusCode.NotFound)
+            catch (RequestFailedException ex) when (ex.Status == (int)HttpStatusCode.NotFound)
             {
                 // the blob or file does not exist, let other middleware handle it
                 await next(context).ConfigureAwait(false);
                 return;
             }
-            catch (RequestFailedException ex) when (ex.Status == (int) HttpStatusCode.PreconditionFailed)
+            catch (RequestFailedException ex) when (ex.Status == (int)HttpStatusCode.PreconditionFailed)
             {
                 // If-Range or If-Unmodified-Since is not met
                 // if the resource has been modified, we need to send the whole file back with a 200 OK
@@ -113,12 +116,12 @@ private async Task HandleRequestAsync(HttpContext context, RequestDelegate next)
                 properties = await blob.GetPropertiesAsync().ConfigureAwait(false);
                 response.Headers.Append("Content-Range", $"bytes */{properties.Value.ContentLength}");
             }
-            catch (RequestFailedException ex) when (ex.Status == (int) HttpStatusCode.NotModified)
+            catch (RequestFailedException ex) when (ex.Status == (int)HttpStatusCode.NotModified)
             {
                 // If-None-Match or If-Modified-Since is not met
                 // we need to pass the status code back to the client
                 // so it knows it can reuse the cached data
-                response.StatusCode = (int) HttpStatusCode.NotModified;
+                response.StatusCode = (int)HttpStatusCode.NotModified;
                 return;
             }
             // for some reason we get an internal exception type with the message
@@ -140,7 +143,7 @@ private async Task HandleRequestAsync(HttpContext context, RequestDelegate next)
                     // If-None-Match or If-Modified-Since is not met
                     // we need to pass the status code back to the client
                     // so it knows it can reuse the cached data
-                    response.StatusCode = (int) HttpStatusCode.NotModified;
+                    response.StatusCode = (int)HttpStatusCode.NotModified;
                     return;
                 }
             }
@@ -174,7 +177,7 @@ private async Task HandleRequestAsync(HttpContext context, RequestDelegate next)
                 {
                     // no ranges could be parsed
                     response.Clear();
-                    response.StatusCode = (int) HttpStatusCode.RequestedRangeNotSatisfiable;
+                    response.StatusCode = (int)HttpStatusCode.RequestedRangeNotSatisfiable;
                     responseHeaders.ContentRange = new ContentRangeHeaderValue(properties.Value.ContentLength);
                     return;
                 }
@@ -376,6 +379,7 @@ private void OptionsOnChange(AzureBlobFileSystemOptions options, string name, IH
             if (name != _name) return;
 
             _rootPath = hostingEnvironment.ToAbsolute(options.VirtualPath);
+            _containerRootPath = options.ContainerRootPath ?? _rootPath;
         }
     }
 }

src/Umbraco.StorageProviders.AzureBlob/IO/AzureBlobFileSystem.cs

@@ -21,6 +21,7 @@ public class AzureBlobFileSystem : IAzureBlobFileSystem
         private readonly IContentTypeProvider _contentTypeProvider;
         private readonly IIOHelper _ioHelper;
         private readonly string _rootUrl;
+        private readonly string _containerRootPath;
 
         /// <summary>
         ///     Creates a new instance of <see cref="AzureBlobFileSystem" />.
@@ -40,6 +41,7 @@ public AzureBlobFileSystem(AzureBlobFileSystemOptions options, IHostingEnvironme
             _contentTypeProvider = contentTypeProvider ?? throw new ArgumentNullException(nameof(contentTypeProvider));
 
             _rootUrl = EnsureUrlSeparatorChar(hostingEnvironment.ToAbsolute(options.VirtualPath)).TrimEnd('/');
+            _containerRootPath = options.ContainerRootPath ?? _rootUrl;
 
             var client = new BlobServiceClient(options.ConnectionString);
             _container = client.GetBlobContainerClient(options.ContainerName);
@@ -106,7 +108,7 @@ public void AddFile(string path, Stream stream, bool overrideIfExists)
             if (_contentTypeProvider.TryGetContentType(path, out var contentType)) headers.ContentType = contentType;
 
             blob.Upload(stream, headers,
-                conditions: overrideIfExists ? null : new BlobRequestConditions {IfNoneMatch = new ETag("*")});
+                conditions: overrideIfExists ? null : new BlobRequestConditions { IfNoneMatch = new ETag("*") });
         }
 
         /// <inheritdoc />
@@ -124,7 +126,7 @@ public void AddFile(string path, string physicalPath, bool overrideIfExists = tr
             var copyFromUriOperation = destinationBlob.StartCopyFromUri(sourceBlob.Uri,
                 destinationConditions: overrideIfExists
                     ? null
-                    : new BlobRequestConditions {IfNoneMatch = new ETag("*")});
+                    : new BlobRequestConditions { IfNoneMatch = new ETag("*") });
 
             if (copyFromUriOperation?.HasCompleted == false)
                 Task.Run(async () => await copyFromUriOperation.WaitForCompletionAsync().ConfigureAwait(false))
@@ -255,7 +257,7 @@ public BlobClient GetBlobClient(string path)
         {
             if (path == null) throw new ArgumentNullException(nameof(path));
 
-            return _container.GetBlobClient(GetFullPath(path));
+            return _container.GetBlobClient(GetBlobPath(path));
         }
 
         /// <inheritdoc />
@@ -282,5 +284,25 @@ private IEnumerable<BlobHierarchyItem> ListBlobs(string path)
 
             return _container.GetBlobsByHierarchy(prefix: path);
         }
+
+        private string GetBlobPath(string path)
+        {
+            if (path == null) throw new ArgumentNullException(nameof(path));
+
+            path = EnsureUrlSeparatorChar(path);
+
+            if (_ioHelper.PathStartsWith(path, _containerRootPath, '/'))
+            {
+                return path;
+            }
+
+            if (_ioHelper.PathStartsWith(path, _rootUrl, '/'))
+            {
+                path = path[_rootUrl.Length..];
+            }
+
+            path = $"{_containerRootPath}/{path.TrimStart('/')}";
+            return path.Trim('/');
+        }
     }
 }

src/Umbraco.StorageProviders.AzureBlob/IO/AzureBlobFileSystemOptions.cs

@@ -24,6 +24,11 @@ public class AzureBlobFileSystemOptions
         [Required]
         public string ContainerName { get; set; } = null!;
 
+        /// <summary>
+        /// The root path of the container.
+        /// </summary>
+        public string ContainerRootPath { get; set; } = null!;
+
         /// <summary>
         /// The virtual path.
         /// </summary>