Add IFileProvider implementation

Author: ronaldbarendse

src/Umbraco.StorageProviders.AzureBlob/AzureBlobDirectoryContents.cs

@@ -0,0 +1,47 @@
+using System;
+using System.Collections;
+using System.Collections.Generic;
+using System.Linq;
+using Azure.Storage.Blobs;
+using Azure.Storage.Blobs.Models;
+using Microsoft.Extensions.FileProviders;
+
+namespace Umbraco.StorageProviders.AzureBlob
+{
+    /// <summary>
+    /// Represents a virtual hierarchy of Azure Blob Storage blobs.
+    /// </summary>
+    /// <seealso cref="Microsoft.Extensions.FileProviders.IDirectoryContents" />
+    public class AzureBlobDirectoryContents : IDirectoryContents
+    {
+        private readonly BlobContainerClient _containerClient;
+        private readonly IList<BlobHierarchyItem> _items;
+
+        /// <inheritdoc />
+        public bool Exists { get; }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="AzureBlobDirectoryContents" /> class.
+        /// </summary>
+        /// <param name="containerClient">The container client.</param>
+        /// <param name="items">The items.</param>
+        /// <exception cref="System.ArgumentNullException">containerClient
+        /// or
+        /// items</exception>
+        public AzureBlobDirectoryContents(BlobContainerClient containerClient, IList<BlobHierarchyItem> items)
+        {
+            _containerClient = containerClient ?? throw new ArgumentNullException(nameof(containerClient));
+            _items = items ?? throw new ArgumentNullException(nameof(items));
+
+            Exists = _items.Count > 0;
+        }
+
+        /// <inheritdoc />
+        public IEnumerator<IFileInfo> GetEnumerator()
+            => _items.Select<BlobHierarchyItem, IFileInfo>(x => x.IsPrefix
+                    ? new AzureBlobPrefixInfo(x.Prefix)
+                    : new AzureBlobItemInfo(_containerClient.GetBlobClient(x.Blob.Name), x.Blob.Properties)).GetEnumerator();
+
+        IEnumerator IEnumerable.GetEnumerator() => GetEnumerator();
+    }
+}

src/Umbraco.StorageProviders.AzureBlob/AzureBlobFileProvider.cs

@@ -0,0 +1,96 @@
+using System;
+using System.Collections.Generic;
+using System.Net;
+using Azure;
+using Azure.Storage.Blobs;
+using Azure.Storage.Blobs.Models;
+using Microsoft.Extensions.FileProviders;
+using Microsoft.Extensions.Primitives;
+using Umbraco.Cms.Core;
+using Umbraco.Extensions;
+using Umbraco.StorageProviders.AzureBlob.IO;
+
+namespace Umbraco.StorageProviders.AzureBlob
+{
+    /// <summary>
+    /// Represents a read-only Azure Blob Storage file provider.
+    /// </summary>
+    /// <seealso cref="Microsoft.Extensions.FileProviders.IFileProvider" />
+    public class AzureBlobFileProvider : IFileProvider
+    {
+        private readonly BlobContainerClient _containerClient;
+        private readonly string? _containerRootPath;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="AzureBlobFileProvider" /> class.
+        /// </summary>
+        /// <param name="containerClient">The container client.</param>
+        /// <param name="containerRootPath">The container root path.</param>
+        /// <exception cref="System.ArgumentNullException">containerClient</exception>
+        public AzureBlobFileProvider(BlobContainerClient containerClient, string? containerRootPath = null)
+        {
+            _containerClient = containerClient ?? throw new ArgumentNullException(nameof(containerClient));
+            _containerRootPath = containerRootPath?.Trim(Constants.CharArrays.ForwardSlash);
+        }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="AzureBlobFileProvider" /> class.
+        /// </summary>
+        /// <param name="options">The options.</param>
+        /// <exception cref="System.ArgumentNullException">options</exception>
+        public AzureBlobFileProvider(AzureBlobFileSystemOptions options)
+        {
+            if (options is null)
+            {
+                throw new ArgumentNullException(nameof(options));
+            }
+
+            _containerClient = new BlobContainerClient(options.ConnectionString, options.ContainerName);
+            _containerRootPath = options.ContainerRootPath?.Trim(Constants.CharArrays.ForwardSlash);
+        }
+
+        /// <inheritdoc />
+        public IDirectoryContents GetDirectoryContents(string subpath)
+        {
+            var path = GetFullPath(subpath);
+
+            // Get all blobs and iterate to fetch all pages
+            var blobs = new List<BlobHierarchyItem>();
+            foreach (var item in _containerClient.GetBlobsByHierarchy(delimiter: "/", prefix: path))
+            {
+                blobs.Add(item);
+            }
+
+            if (blobs.Count == 0)
+            {
+                return NotFoundDirectoryContents.Singleton;
+            }
+
+            return new AzureBlobDirectoryContents(_containerClient, blobs);
+        }
+
+        /// <inheritdoc />
+        public IFileInfo GetFileInfo(string subpath)
+        {
+            var path = GetFullPath(subpath);
+            var blobClient = _containerClient.GetBlobClient(path);
+
+            BlobProperties properties;
+            try
+            {
+                properties = blobClient.GetProperties().Value;
+            }
+            catch (RequestFailedException ex) when (ex.Status == (int)HttpStatusCode.NotFound)
+            {
+                return new NotFoundFileInfo(AzureBlobItemInfo.ParseName(path));
+            }
+
+            return new AzureBlobItemInfo(blobClient, properties);
+        }
+
+        /// <inheritdoc />
+        public IChangeToken Watch(string filter) => NullChangeToken.Singleton;
+
+        private string GetFullPath(string subpath) => _containerRootPath + subpath.EnsureStartsWith('/');
+    }
+}

src/Umbraco.StorageProviders.AzureBlob/AzureBlobItemInfo.cs

@@ -0,0 +1,88 @@
+using System;
+using System.IO;
+using Azure.Storage.Blobs;
+using Azure.Storage.Blobs.Models;
+using Microsoft.Extensions.FileProviders;
+
+namespace Umbraco.StorageProviders.AzureBlob
+{
+    /// <summary>
+    /// Represents an Azure Blob Storage blob item.
+    /// </summary>
+    /// <seealso cref="Microsoft.Extensions.FileProviders.IFileInfo" />
+    public class AzureBlobItemInfo : IFileInfo
+    {
+        private readonly BlobClient _blobClient;
+
+        /// <inheritdoc />
+        public bool Exists => true;
+
+        /// <inheritdoc />
+        public bool IsDirectory => false;
+
+        /// <inheritdoc />
+        public DateTimeOffset LastModified { get; }
+
+        /// <inheritdoc />
+        public long Length { get; }
+
+        /// <inheritdoc />
+        public string Name { get; }
+
+        /// <inheritdoc />
+        public string PhysicalPath => null!;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="AzureBlobItemInfo" /> class.
+        /// </summary>
+        /// <param name="blobClient">The blob client.</param>
+        /// <exception cref="System.ArgumentNullException">blobClient</exception>
+        protected AzureBlobItemInfo(BlobClient blobClient)
+        {
+            _blobClient = blobClient ?? throw new ArgumentNullException(nameof(blobClient));
+
+            Name = ParseName(blobClient.Name);
+        }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="AzureBlobItemInfo" /> class.
+        /// </summary>
+        /// <param name="blobClient">The blob client.</param>
+        /// <param name="properties">The properties.</param>
+        /// <exception cref="System.ArgumentNullException">properties</exception>
+        public AzureBlobItemInfo(BlobClient blobClient, BlobProperties properties)
+            : this(blobClient)
+        {
+            if (properties == null)
+            {
+                throw new ArgumentNullException(nameof(properties));
+            }
+
+            LastModified = properties.LastModified;
+            Length = properties.ContentLength;
+        }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="AzureBlobItemInfo" /> class.
+        /// </summary>
+        /// <param name="blobClient">The blob client.</param>
+        /// <param name="properties">The properties.</param>
+        /// <exception cref="System.ArgumentNullException">properties</exception>
+        public AzureBlobItemInfo(BlobClient blobClient, BlobItemProperties properties)
+            : this(blobClient)
+        {
+            if (properties == null)
+            {
+                throw new ArgumentNullException(nameof(properties));
+            }
+
+            LastModified = properties.LastModified.GetValueOrDefault();
+            Length = properties.ContentLength.GetValueOrDefault(-1);
+        }
+
+        /// <inheritdoc />
+        public Stream CreateReadStream() => _blobClient.OpenRead();
+
+        internal static string ParseName(string path) => path.Substring(path.LastIndexOf('/') + 1);
+    }
+}

src/Umbraco.StorageProviders.AzureBlob/AzureBlobPrefixInfo.cs

@@ -0,0 +1,55 @@
+using System;
+using System.IO;
+using Microsoft.Extensions.FileProviders;
+
+namespace Umbraco.StorageProviders.AzureBlob
+{
+    /// <summary>
+    /// Represents an Azure Blob Storage prefix.
+    /// </summary>
+    /// <seealso cref="Microsoft.Extensions.FileProviders.IFileInfo" />
+    public class AzureBlobPrefixInfo : IFileInfo
+    {
+        /// <inheritdoc />
+        public bool Exists => true;
+
+        /// <inheritdoc />
+        public bool IsDirectory => true;
+
+        /// <inheritdoc />
+        public DateTimeOffset LastModified => default;
+
+        /// <inheritdoc />
+        public long Length => -1;
+
+        /// <inheritdoc />
+        public string Name { get; }
+
+        /// <inheritdoc />
+        public string PhysicalPath => null!;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="AzureBlobPrefixInfo"/> class.
+        /// </summary>
+        /// <param name="prefix">The prefix.</param>
+        public AzureBlobPrefixInfo(string prefix)
+        {
+            if (prefix == null)
+            {
+                throw new ArgumentNullException(nameof(prefix));
+            }
+
+            Name = ParseName(prefix);
+        }
+
+        /// <inheritdoc />
+        public Stream CreateReadStream() => throw new InvalidOperationException();
+
+        private static string ParseName(string prefix)
+        {
+            var name = prefix.TrimEnd('/');
+
+            return name.Substring(name.LastIndexOf('/') + 1);
+        }
+    }
+}