Added BlobFileStoreFactory to allow DefaultAzureCredential or Connectionstring authentication for Azure Blob storage

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

@@ -95,22 +95,22 @@ public override void ConfigureServices(IServiceCollection services)
                 services.AddSingleton<IMediaFileStoreCache>(serviceProvider =>
                     serviceProvider.GetRequiredService<IMediaFileStoreCacheFileProvider>());
 
+                // Register the BlobFileStorageFactory
+                services.AddAzureBlobFileStorage();
+
                 // Replace the default media file store with a blob file store.
                 services.Replace(ServiceDescriptor.Singleton<IMediaFileStore>(serviceProvider =>
                 {
                     var blobStorageOptions = serviceProvider.GetRequiredService<IOptions<MediaBlobStorageOptions>>().Value;
                     var shellOptions = serviceProvider.GetRequiredService<IOptions<ShellOptions>>();
                     var shellSettings = serviceProvider.GetRequiredService<ShellSettings>();
                     var mediaOptions = serviceProvider.GetRequiredService<IOptions<MediaOptions>>().Value;
-                    var clock = serviceProvider.GetRequiredService<IClock>();
-                    var contentTypeProvider = serviceProvider.GetRequiredService<IContentTypeProvider>();
                     var mediaEventHandlers = serviceProvider.GetServices<IMediaEventHandler>();
                     var mediaCreatingEventHandlers = serviceProvider.GetServices<IMediaCreatingEventHandler>();
                     var logger = serviceProvider.GetRequiredService<ILogger<DefaultMediaFileStore>>();
+                    var blobStoreFactory = serviceProvider.GetRequiredService<BlobFileStoreFactory>();
 
-                    var fileStore = new BlobFileStore(blobStorageOptions, clock, contentTypeProvider);
-
-                    var mediaPath = GetMediaPath(shellOptions.Value, shellSettings, mediaOptions.AssetsPath);
+                    var fileStore = blobStoreFactory.Create(blobStorageOptions);
 
                     var mediaUrlBase = "/" + fileStore.Combine(shellSettings.RequestUrlPrefix, mediaOptions.AssetsRequestPath);
 

src/OrchardCore/OrchardCore.FileStorage.AzureBlob/AzureBlobFileStorageOrchardCoreBuilderExtensions.cs

@@ -0,0 +1,17 @@
+using Microsoft.Extensions.DependencyInjection;
+
+namespace OrchardCore.FileStorage.AzureBlob;
+public static class AzureBlobFileStorageOrchardCoreBuilderExtensions
+{
+    /// <summary>
+    /// This registers the AzureBlobFileStorage components.
+    /// Note: this method is safe to call more then once.
+    /// </summary>
+    /// <param name="builder"></param>
+    /// <returns></returns>
+    public static OrchardCoreBuilder AddAzureBlobFileStorage(this OrchardCoreBuilder builder)
+    {
+        builder.ApplicationServices.AddAzureBlobFileStorage();
+        return builder;
+    }
+}

src/OrchardCore/OrchardCore.FileStorage.AzureBlob/AzureBlobFileStorageServiceCollectionExtensions.cs

@@ -0,0 +1,21 @@
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.DependencyInjection.Extensions;
+
+namespace OrchardCore.FileStorage.AzureBlob;
+
+public static class AzureBlobFileStorageServiceCollectionExtensions
+{
+    /// <summary>
+    /// Registers the BlobFileStorage services in the ServiceCollection.
+    /// Note: this method can be called multiple times
+    /// </summary>
+    /// <param name="services"></param>
+    /// <returns></returns>
+    public static IServiceCollection AddAzureBlobFileStorage(this IServiceCollection services)
+    {
+        // always use TryXXX methods because this method can be called multiple times
+        // by different modules (currently: Azure Media and Azure Shells module)
+        services.TryAddSingleton<BlobFileStoreFactory>();
+        return services;
+    }
+}

src/OrchardCore/OrchardCore.FileStorage.AzureBlob/BlobFileStore.cs

@@ -8,6 +8,7 @@
 using Azure.Storage.Blobs;
 using Azure.Storage.Blobs.Models;
 using Microsoft.AspNetCore.StaticFiles;
+using Microsoft.Extensions.Options;
 using OrchardCore.Modules;
 
 namespace OrchardCore.FileStorage.AzureBlob
@@ -39,23 +40,21 @@ public class BlobFileStore : IFileStore
     {
         private const string _directoryMarkerFileName = "OrchardCore.Media.txt";
 
-        private readonly BlobStorageOptions _options;
         private readonly IClock _clock;
         private readonly BlobContainerClient _blobContainer;
         private readonly IContentTypeProvider _contentTypeProvider;
         private readonly string _basePrefix = null;
 
-        public BlobFileStore(BlobStorageOptions options, IClock clock, IContentTypeProvider contentTypeProvider)
+        public BlobFileStore(BlobContainerClient blobContainerClient, string basePath, IClock clock, IContentTypeProvider contentTypeProvider)
         {
-            _options = options;
             _clock = clock;
             _contentTypeProvider = contentTypeProvider;
 
-            _blobContainer = new BlobContainerClient(_options.ConnectionString, _options.ContainerName);
+            _blobContainer = blobContainerClient;
 
-            if (!String.IsNullOrEmpty(_options.BasePath))
+            if (!String.IsNullOrEmpty(basePath))
             {
-                _basePrefix = NormalizePrefix(_options.BasePath);
+                _basePrefix = NormalizePrefix(basePath);
             }
         }
 
@@ -69,7 +68,7 @@ public async Task<IFileStoreEntry> GetFileInfoAsync(string path)
 
                 return new BlobFile(path, properties.Value.ContentLength, properties.Value.LastModified);
             }
-            catch (RequestFailedException ex) when (ex.ErrorCode == BlobErrorCode.BlobNotFound) 
+            catch (RequestFailedException ex) when (ex.ErrorCode == BlobErrorCode.BlobNotFound)
             {
                 // Instead of ExistsAsync() check which is 'slow' if we're expecting to find the blob we rely on the exception
                 return null;
@@ -402,7 +401,7 @@ public async Task<string> CreateFileFromStreamAsync(string path, Stream inputStr
 
         private BlobClient GetBlobReference(string path)
         {
-            var blobPath = this.Combine(_options.BasePath, path);
+            var blobPath = this.Combine(_basePrefix, path);
             var blob = _blobContainer.GetBlobClient(blobPath);
 
             return blob;

src/OrchardCore/OrchardCore.FileStorage.AzureBlob/BlobFileStoreFactory.cs

@@ -0,0 +1,63 @@
+using System;
+using Azure.Storage.Blobs;
+using Microsoft.AspNetCore.StaticFiles;
+using Microsoft.Extensions.Azure;
+using Microsoft.Extensions.DependencyInjection;
+using OrchardCore.Modules;
+
+namespace OrchardCore.FileStorage.AzureBlob;
+public class BlobFileStoreFactory
+{
+    private readonly IAzureClientFactory<BlobServiceClient> _clientFactory;
+    private readonly IServiceProvider _serviceProvider;
+
+    private const string DefaultStorageName = "Default";
+
+    public BlobFileStoreFactory(IAzureClientFactory<BlobServiceClient> clientFactory, IServiceProvider serviceProvider)
+    {
+        _clientFactory = clientFactory;
+        _serviceProvider = serviceProvider;
+    }
+
+    /// <summary>
+    /// Creates a <see cref="BlobFileStore"/> from <see cref="BlobStorageOptions"/>
+    /// If a connectionstring is specified, it will use the connectionstring
+    /// otherwise it will try to get the BlobServiceClient configured with the specified name in the BlobServiceName property
+    /// </summary>
+    /// <param name="options"></param>
+    /// <returns></returns>
+    public virtual BlobFileStore Create(BlobStorageOptions options)
+    {
+        var containerClient = CreateContainerClientFromOptions(options);
+
+        return new BlobFileStore(
+            containerClient,
+            options.BasePath,
+            _serviceProvider.GetRequiredService<IClock>(),
+            _serviceProvider.GetRequiredService<IContentTypeProvider>());
+    }
+
+
+    private BlobContainerClient CreateContainerClientFromOptions(BlobStorageOptions options)
+    {
+        // return a container client from connectionstring, if specified
+        if (!String.IsNullOrEmpty(options.ConnectionString))
+        {
+            return new BlobContainerClient(options.ConnectionString, options.ContainerName);
+        }
+
+        // else use the clientFactory to lookup a BlobService with the specified name
+        if (!String.IsNullOrEmpty(options.BlobServiceName))
+        {
+            return _clientFactory
+                .CreateClient(options.BlobServiceName)
+                .GetBlobContainerClient(options.ContainerName);
+        }
+
+        // fall-back to the default registered blob storage
+        return _clientFactory
+            .CreateClient(DefaultStorageName)
+            .GetBlobContainerClient(options.ContainerName);
+    }
+
+}

src/OrchardCore/OrchardCore.FileStorage.AzureBlob/BlobStorageOptions.cs

@@ -1,3 +1,5 @@
+using Azure.Core;
+
 namespace OrchardCore.FileStorage.AzureBlob
 {
     public abstract class BlobStorageOptions
@@ -7,6 +9,13 @@ public abstract class BlobStorageOptions
         /// </summary>
         public string ConnectionString { get; set; }
 
+        /// <summary>
+        /// The reference to a named AzureClient.
+        /// The client needs to be registered using the AddAzureClients extension method.
+        /// more info: https://learn.microsoft.com/en-us/dotnet/azure/sdk/dependency-injection#configure-multiple-service-clients-with-different-names
+        /// </summary>
+        public string BlobServiceName { get; set; }
+
         /// <summary>
         /// The Azure Blob container name.
         /// </summary>

src/OrchardCore/OrchardCore.FileStorage.AzureBlob/OrchardCore.FileStorage.AzureBlob.csproj

@@ -16,6 +16,7 @@
 
   <ItemGroup>
     <PackageReference Include="Azure.Storage.Blobs" />
+    <PackageReference Include="Microsoft.Extensions.Azure" Version="1.6.0" />
   </ItemGroup>
 
   <ItemGroup>

src/OrchardCore/OrchardCore.Shells.Azure/Extensions/BlobShellsOrchardCoreBuilderExtensions.cs

@@ -24,6 +24,9 @@ public static OrchardCoreBuilder AddAzureShellsConfiguration(this OrchardCoreBui
 
             services.TryAddSingleton<IContentTypeProvider, FileExtensionContentTypeProvider>();
 
+            // register the azure blob file storage services
+            builder.AddAzureBlobFileStorage();
+
             services.AddSingleton<IShellsFileStore>(sp =>
             {
                 var configuration = sp.GetRequiredService<IConfiguration>();
@@ -34,10 +37,9 @@ public static OrchardCoreBuilder AddAzureShellsConfiguration(this OrchardCoreBui
                         "The 'OrchardCore.Shells.Azure' configuration section must be defined");
                 }
 
-                var clock = sp.GetRequiredService<IClock>();
-                var contentTypeProvider = sp.GetRequiredService<IContentTypeProvider>();
+                var blobFileStoreFactory = sp.GetRequiredService<BlobFileStoreFactory>();
 
-                var fileStore = new BlobFileStore(blobOptions, clock, contentTypeProvider);
+                var fileStore = blobFileStoreFactory.Create(blobOptions);
 
                 return new BlobShellsFileStore(fileStore);
             });