openiddict-core/src/OpenIddict.EntityFramework/OpenIddictEntityFrameworkExtensions.cs

/*
 * Licensed under the Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
 * See https://github.com/openiddict/openiddict-core for more information concerning
 * the license and the contributors participating to this project.
 */

using Microsoft.Extensions.DependencyInjection.Extensions;
using OpenIddict.EntityFramework;
using OpenIddict.EntityFramework.Models;

namespace Microsoft.Extensions.DependencyInjection;

/// <summary>
/// Exposes extensions allowing to register the OpenIddict Entity Framework 6.x services.
/// </summary>
public static class OpenIddictEntityFrameworkExtensions
{
    /// <summary>
    /// Registers the Entity Framework 6.x stores services in the DI container and
    /// configures OpenIddict to use the Entity Framework 6.x entities by default.
    /// </summary>
    /// <param name="builder">The services builder used by OpenIddict to register new services.</param>
    /// <remarks>This extension can be safely called multiple times.</remarks>
    /// <returns>The <see cref="OpenIddictEntityFrameworkBuilder"/> instance.</returns>
    public static OpenIddictEntityFrameworkBuilder UseEntityFramework(this OpenIddictCoreBuilder builder)
    {
        if (builder is null)
        {
            throw new ArgumentNullException(nameof(builder));
        }

        // Since Entity Framework 6.x may be used with databases performing case-insensitive
        // or culture-sensitive comparisons, ensure the additional filtering logic is enforced
        // in case case-sensitive stores were registered before this extension was called.
        builder.Configure(options => options.DisableAdditionalFiltering = false);

        builder.SetDefaultApplicationEntity<OpenIddictEntityFrameworkApplication>()
               .SetDefaultAuthorizationEntity<OpenIddictEntityFrameworkAuthorization>()
               .SetDefaultScopeEntity<OpenIddictEntityFrameworkScope>()
               .SetDefaultTokenEntity<OpenIddictEntityFrameworkToken>();

        builder.ReplaceApplicationStore<OpenIddictEntityFrameworkApplication, OpenIddictEntityFrameworkApplicationStore>()
               .ReplaceAuthorizationStore<OpenIddictEntityFrameworkAuthorization, OpenIddictEntityFrameworkAuthorizationStore>()
               .ReplaceScopeStore<OpenIddictEntityFrameworkScope, OpenIddictEntityFrameworkScopeStore>()
               .ReplaceTokenStore<OpenIddictEntityFrameworkToken, OpenIddictEntityFrameworkTokenStore>();

        // Note: a default context factory is always registered to make debugging easier when
        // no database context type was configured by the user: the default implementation
        // registered here is automatically replaced by the UseDbContext<TContext>() API.
        builder.Services.TryAddScoped<IOpenIddictEntityFrameworkContext>(static provider =>
            throw new InvalidOperationException(SR.GetResourceString(SR.ID0235)));

        return new OpenIddictEntityFrameworkBuilder(builder.Services);
    }

    /// <summary>
    /// Registers the Entity Framework 6.x stores services in the DI container and
    /// configures OpenIddict to use the Entity Framework 6.x entities by default.
    /// </summary>
    /// <param name="builder">The services builder used by OpenIddict to register new services.</param>
    /// <param name="configuration">The configuration delegate used to configure the Entity Framework 6.x services.</param>
    /// <remarks>This extension can be safely called multiple times.</remarks>
    /// <returns>The <see cref="OpenIddictCoreBuilder"/> instance.</returns>
    public static OpenIddictCoreBuilder UseEntityFramework(
        this OpenIddictCoreBuilder builder, Action<OpenIddictEntityFrameworkBuilder> configuration)
    {
        if (builder is null)
        {
            throw new ArgumentNullException(nameof(builder));
        }

        if (configuration is null)
        {
            throw new ArgumentNullException(nameof(configuration));
        }

        configuration(builder.UseEntityFramework());

        return builder;
    }
}