Files
Umbraco-CMS/src/Umbraco.Web.Common/Extensions/UmbracoCoreServiceCollectionExtensions.cs

202 lines
9.0 KiB
C#
Raw Normal View History

using System;
using System.Data.Common;
using System.Reflection;
2020-02-24 16:18:47 +01:00
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Http;
2020-03-16 14:02:08 +01:00
using Microsoft.Extensions.Configuration;
2020-02-18 08:32:06 +01:00
using Microsoft.Extensions.DependencyInjection;
2020-03-24 10:51:53 +01:00
using Smidge;
using Smidge.Nuglify;
2020-02-25 08:56:58 +01:00
using Umbraco.Composing;
2020-03-16 14:02:08 +01:00
using Umbraco.Configuration;
2020-03-16 19:14:04 +01:00
using Umbraco.Core;
2020-02-24 16:18:47 +01:00
using Umbraco.Core.Cache;
using Umbraco.Core.Composing;
2020-02-24 16:18:47 +01:00
using Umbraco.Core.Configuration;
using Umbraco.Core.IO;
using Umbraco.Core.Logging;
using Umbraco.Core.Logging.Serilog;
using Umbraco.Core.Persistence;
2020-02-25 08:56:58 +01:00
using Umbraco.Core.Runtime;
2020-03-31 12:22:11 +02:00
using Umbraco.Web.Common.AspNetCore;
using Umbraco.Web.Common.Runtime.Profiler;
2020-02-18 08:32:06 +01:00
2020-03-31 12:22:11 +02:00
namespace Umbraco.Web.Common.Extensions
2020-02-18 08:32:06 +01:00
{
public static class UmbracoCoreServiceCollectionExtensions
2020-02-18 08:32:06 +01:00
{
/// <summary>
/// Adds the Umbraco Configuration requirements
/// </summary>
/// <param name="services"></param>
/// <param name="configuration"></param>
/// <returns></returns>
public static IServiceCollection AddUmbracoConfiguration(this IServiceCollection services, IConfiguration configuration)
2020-03-17 17:56:00 +01:00
{
if (configuration == null) throw new ArgumentNullException(nameof(configuration));
2020-03-23 16:39:27 +11:00
2020-03-17 17:56:00 +01:00
var configsFactory = new AspNetCoreConfigsFactory(configuration);
var configs = configsFactory.Create();
2020-03-17 17:56:00 +01:00
services.AddSingleton(configs);
return services;
}
/// <summary>
/// Adds the Umbraco Back Core requirements
/// </summary>
/// <param name="services"></param>
/// <param name="webHostEnvironment"></param>
/// <returns></returns>
public static IServiceCollection AddUmbracoCore(this IServiceCollection services, IWebHostEnvironment webHostEnvironment)
{
if (!UmbracoServiceProviderFactory.IsActive)
throw new InvalidOperationException("Ensure to add UseUmbraco() in your Program.cs after ConfigureWebHostDefaults to enable Umbraco's service provider factory");
var umbContainer = UmbracoServiceProviderFactory.UmbracoContainer;
services.AddUmbracoCore(webHostEnvironment, umbContainer, Assembly.GetEntryAssembly());
return services;
2020-03-13 19:10:21 +11:00
}
/// <summary>
/// Adds the Umbraco Back Core requirements
/// </summary>
/// <param name="services"></param>
/// <param name="webHostEnvironment"></param>
/// <param name="umbContainer"></param>
/// <param name="entryAssembly"></param>
/// <returns></returns>
public static IServiceCollection AddUmbracoCore(this IServiceCollection services, IWebHostEnvironment webHostEnvironment, IRegister umbContainer, Assembly entryAssembly)
2020-02-18 08:32:06 +01:00
{
if (services is null) throw new ArgumentNullException(nameof(services));
var container = umbContainer;
if (container is null) throw new ArgumentNullException(nameof(container));
if (entryAssembly is null) throw new ArgumentNullException(nameof(entryAssembly));
// Special case! The generic host adds a few default services but we need to manually add this one here NOW because
// we resolve it before the host finishes configuring in the call to CreateCompositionRoot
2020-03-16 14:02:08 +01:00
services.AddSingleton<IHttpContextAccessor, HttpContextAccessor>();
2020-02-24 16:18:47 +01:00
CreateCompositionRoot(services, webHostEnvironment, out var logger, out var configs, out var ioHelper, out var hostingEnvironment, out var backOfficeInfo, out var profiler);
2020-03-13 19:10:21 +11:00
var globalSettings = configs.Global();
var umbracoVersion = new UmbracoVersion(globalSettings);
2020-03-13 19:10:21 +11:00
// TODO: Currently we are not passing in any TypeFinderConfig (with ITypeFinderSettings) which we should do, however
// this is not critical right now and would require loading in some config before boot time so just leaving this as-is for now.
var typeFinder = new TypeFinder(logger, new DefaultUmbracoAssemblyProvider(entryAssembly));
2020-03-13 19:10:21 +11:00
var coreRuntime = GetCoreRuntime(
configs,
umbracoVersion,
ioHelper,
logger,
profiler,
hostingEnvironment,
backOfficeInfo,
2020-03-13 19:10:21 +11:00
typeFinder);
var factory = coreRuntime.Configure(container);
2020-02-18 08:32:06 +01:00
return services;
}
private static IRuntime GetCoreRuntime(Configs configs, IUmbracoVersion umbracoVersion, IIOHelper ioHelper, ILogger logger,
2020-03-13 19:10:21 +11:00
IProfiler profiler, Core.Hosting.IHostingEnvironment hostingEnvironment, IBackOfficeInfo backOfficeInfo,
ITypeFinder typeFinder)
{
var connectionStringConfig = configs.ConnectionStrings()[Constants.System.UmbracoConnectionName];
var dbProviderFactoryCreator = new SqlServerDbProviderFactoryCreator(
connectionStringConfig?.ProviderName,
DbProviderFactories.GetFactory);
// Determine if we should use the sql main dom or the default
var globalSettings = configs.Global();
var connStrings = configs.ConnectionStrings();
var appSettingMainDomLock = globalSettings.MainDomLock;
var mainDomLock = appSettingMainDomLock == "SqlMainDomLock"
? (IMainDomLock)new SqlMainDomLock(logger, globalSettings, connStrings, dbProviderFactoryCreator)
: new MainDomSemaphoreLock(logger, hostingEnvironment);
var mainDom = new MainDom(logger, mainDomLock);
var coreRuntime = new CoreRuntime(configs, umbracoVersion, ioHelper, logger, profiler, new AspNetCoreBootPermissionsChecker(),
hostingEnvironment, backOfficeInfo, dbProviderFactoryCreator, mainDom, typeFinder);
return coreRuntime;
}
2020-02-25 08:56:58 +01:00
private static IServiceCollection CreateCompositionRoot(IServiceCollection services, IWebHostEnvironment webHostEnvironment,
out ILogger logger, out Configs configs, out IIOHelper ioHelper, out Core.Hosting.IHostingEnvironment hostingEnvironment,
out IBackOfficeInfo backOfficeInfo, out IProfiler profiler)
2020-02-24 16:18:47 +01:00
{
// TODO: We need to avoid this, surely there's a way? See ContainerTests.BuildServiceProvider_Before_Host_Is_Configured
2020-02-24 16:18:47 +01:00
var serviceProvider = services.BuildServiceProvider();
2020-03-13 19:10:21 +11:00
var httpContextAccessor = serviceProvider.GetRequiredService<IHttpContextAccessor>();
2020-02-24 16:18:47 +01:00
configs = serviceProvider.GetService<Configs>();
2020-03-23 16:39:27 +11:00
if (configs == null)
throw new InvalidOperationException($"Could not resolve type {typeof(Configs)} from the container, ensure {nameof(AddUmbracoConfiguration)} is called before calling {nameof(AddUmbracoCore)}");
2020-02-24 16:18:47 +01:00
2020-03-16 19:14:04 +01:00
var hostingSettings = configs.Hosting();
var coreDebug = configs.CoreDebug();
var globalSettings = configs.Global();
2020-02-24 16:18:47 +01:00
hostingEnvironment = new AspNetCoreHostingEnvironment(hostingSettings, webHostEnvironment, httpContextAccessor);
ioHelper = new IOHelper(hostingEnvironment, globalSettings);
logger = SerilogLogger.CreateWithDefaultConfiguration(hostingEnvironment,
new AspNetCoreSessionIdResolver(httpContextAccessor),
// TODO: We need to avoid this, surely there's a way? See ContainerTests.BuildServiceProvider_Before_Host_Is_Configured
() => services.BuildServiceProvider().GetService<IRequestCache>(), coreDebug, ioHelper,
new AspNetCoreMarchal());
backOfficeInfo = new AspNetCoreBackOfficeInfo(globalSettings);
profiler = GetWebProfiler(hostingEnvironment, httpContextAccessor);
2020-02-24 16:18:47 +01:00
2020-02-25 08:56:58 +01:00
Current.Initialize(logger, configs, ioHelper, hostingEnvironment, backOfficeInfo, profiler);
2020-03-16 14:02:08 +01:00
return services;
2020-02-24 16:18:47 +01:00
}
2020-03-24 10:51:53 +01:00
public static IServiceCollection AddUmbracoRuntimeMinifier(this IServiceCollection services,
IConfiguration configuration)
2020-03-24 10:51:53 +01:00
{
services.AddSmidge(configuration.GetSection(Constants.Configuration.ConfigRuntimeMinification));
services.AddSmidgeNuglify();
2020-03-24 10:51:53 +01:00
return services;
}
private static IProfiler GetWebProfiler(Umbraco.Core.Hosting.IHostingEnvironment hostingEnvironment, IHttpContextAccessor httpContextAccessor)
{
// create and start asap to profile boot
if (!hostingEnvironment.IsDebugMode)
{
// should let it be null, that's how MiniProfiler is meant to work,
// but our own IProfiler expects an instance so let's get one
return new VoidProfiler();
}
var webProfiler = new WebProfiler(httpContextAccessor);
webProfiler.StartBoot();
return webProfiler;
}
private class AspNetCoreBootPermissionsChecker : IUmbracoBootPermissionChecker
{
public void ThrowIfNotPermissions()
{
// nothing to check
}
}
2020-02-18 08:32:06 +01:00
}
}