Umbraco-CMS/src/Umbraco.Infrastructure/Install/InstallSteps/NewInstallStep.cs

using System.Collections.Specialized;
using System.Text;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Options;
using Newtonsoft.Json;
using Umbraco.Cms.Core.Configuration.Models;
using Umbraco.Cms.Core.Install.Models;
using Umbraco.Cms.Core.Models;
using Umbraco.Cms.Core.Security;
using Umbraco.Cms.Core.Services;
using Umbraco.Cms.Core.Web;
using Umbraco.Cms.Infrastructure.Migrations.Install;
using Umbraco.Cms.Infrastructure.Persistence;
using Umbraco.Cms.Web.Common.DependencyInjection;
using Umbraco.Extensions;
using Constants = Umbraco.Cms.Core.Constants;

namespace Umbraco.Cms.Infrastructure.Install.InstallSteps
{
    /// <summary>
    /// This is the first UI step for a brand new install
    /// </summary>
    /// <remarks>
    /// By default this will show the user view which is the most basic information to configure a new install, but if an install get's interrupted because of an
    /// error, etc... and the end-user refreshes the installer then we cannot show the user screen because they've already entered that information so instead we'll
    /// display a simple continue installation view.
    /// </remarks>
    [InstallSetupStep(InstallationType.NewInstall, "User", 20, "")]
    public class NewInstallStep : InstallSetupStep<UserModel>
    {
        private readonly IUserService _userService;
        private readonly DatabaseBuilder _databaseBuilder;
        private readonly IHttpClientFactory _httpClientFactory;
        private readonly UserPasswordConfigurationSettings _passwordConfiguration;
        private readonly SecuritySettings _securitySettings;
        private readonly IOptionsMonitor<ConnectionStrings> _connectionStrings;
        private readonly ICookieManager _cookieManager;
        private readonly IBackOfficeUserManager _userManager;
        private readonly IDbProviderFactoryCreator _dbProviderFactoryCreator;
        private readonly IEnumerable<IDatabaseProviderMetadata> _databaseProviderMetadata;
        private readonly ILocalizedTextService _localizedTextService;
        private readonly IMetricsConsentService _metricsConsentService;

        public NewInstallStep(
            IUserService userService,
            DatabaseBuilder databaseBuilder,
            IHttpClientFactory httpClientFactory,
            IOptions<UserPasswordConfigurationSettings> passwordConfiguration,
            IOptions<SecuritySettings> securitySettings,
            IOptionsMonitor<ConnectionStrings> connectionStrings,
            ICookieManager cookieManager,
            IBackOfficeUserManager userManager,
            IDbProviderFactoryCreator dbProviderFactoryCreator,
            IEnumerable<IDatabaseProviderMetadata> databaseProviderMetadata,
            ILocalizedTextService localizedTextService,
            IMetricsConsentService metricsConsentService)
        {
            _userService = userService ?? throw new ArgumentNullException(nameof(userService));
            _databaseBuilder = databaseBuilder ?? throw new ArgumentNullException(nameof(databaseBuilder));
            _httpClientFactory = httpClientFactory;
            _passwordConfiguration = passwordConfiguration.Value ?? throw new ArgumentNullException(nameof(passwordConfiguration));
            _securitySettings = securitySettings.Value ?? throw new ArgumentNullException(nameof(securitySettings));
            _connectionStrings = connectionStrings;
            _cookieManager = cookieManager;
            _userManager = userManager ?? throw new ArgumentNullException(nameof(userManager));
            _dbProviderFactoryCreator = dbProviderFactoryCreator ?? throw new ArgumentNullException(nameof(dbProviderFactoryCreator));
            _databaseProviderMetadata = databaseProviderMetadata;
            _localizedTextService = localizedTextService;
            _metricsConsentService = metricsConsentService;
        }

        // Scheduled for removal in V12
        [Obsolete("Please use constructor that takes an IMetricsConsentService and ILocalizedTextService instead")]
        public NewInstallStep(
            IUserService userService,
            DatabaseBuilder databaseBuilder,
            IHttpClientFactory httpClientFactory,
            IOptions<UserPasswordConfigurationSettings> passwordConfiguration,
            IOptions<SecuritySettings> securitySettings,
            IOptionsMonitor<ConnectionStrings> connectionStrings,
            ICookieManager cookieManager,
            IBackOfficeUserManager userManager,
            IDbProviderFactoryCreator dbProviderFactoryCreator,
            IEnumerable<IDatabaseProviderMetadata> databaseProviderMetadata)
        : this(
            userService,
            databaseBuilder,
            httpClientFactory,
            passwordConfiguration,
            securitySettings,
            connectionStrings,
            cookieManager,
            userManager,
            dbProviderFactoryCreator,
            databaseProviderMetadata,
            StaticServiceProvider.Instance.GetRequiredService<ILocalizedTextService>(),
            StaticServiceProvider.Instance.GetRequiredService<IMetricsConsentService>())
        {
        }

        public override async Task<InstallSetupResult?> ExecuteAsync(UserModel user)
        {
            var admin = _userService.GetUserById(Constants.Security.SuperUserId);
            if (admin == null)
            {
                throw new InvalidOperationException("Could not find the super user!");
            }
            admin.Email = user.Email.Trim();
            admin.Name = user.Name!.Trim();
            admin.Username = user.Email.Trim();

            _userService.Save(admin);

            var membershipUser = await _userManager.FindByIdAsync(Constants.Security.SuperUserIdAsString);
            if (membershipUser == null)
            {
                throw new InvalidOperationException(
                    $"No user found in membership provider with id of {Constants.Security.SuperUserIdAsString}.");
            }

            //To change the password here we actually need to reset it since we don't have an old one to use to change
            var resetToken = await _userManager.GeneratePasswordResetTokenAsync(membershipUser);
            if (string.IsNullOrWhiteSpace(resetToken))
                throw new InvalidOperationException("Could not reset password: unable to generate internal reset token");

            var resetResult = await _userManager.ChangePasswordWithResetAsync(membershipUser.Id, resetToken, user.Password.Trim());
            if (!resetResult.Succeeded)
                throw new InvalidOperationException("Could not reset password: " + string.Join(", ", resetResult.Errors.ToErrorMessage()));

            _metricsConsentService.SetConsentLevel(user.TelemetryLevel);

            if (user.SubscribeToNewsLetter)
            {
                var values = new NameValueCollection { { "name", admin.Name }, { "email", admin.Email } };
                var content = new StringContent(JsonConvert.SerializeObject(values), Encoding.UTF8, "application/json");

                HttpClient httpClient = _httpClientFactory.CreateClient();

                try
                {
                    var response = httpClient.PostAsync("https://shop.umbraco.com/base/Ecom/SubmitEmail/installer.aspx", content).Result;
                }
                catch { /* fail in silence */ }
            }

            return null;
        }

        /// <summary>
        /// Return a custom view model for this step
        /// </summary>
        public override object ViewModel
        {
            get
            {
                var quickInstallSettings = _databaseProviderMetadata.GetAvailable(true)
                    .Select(x => new
                    {
                        displayName = x.DisplayName,
                        defaultDatabaseName = x.DefaultDatabaseName,
                    })
                    .FirstOrDefault();

                return new
                {
                    minCharLength = _passwordConfiguration.RequiredLength,
                    minNonAlphaNumericLength = _passwordConfiguration.GetMinNonAlphaNumericChars(),
                    quickInstallSettings,
                    customInstallAvailable = !GetInstallState().HasFlag(InstallState.ConnectionStringConfigured),
                    consentLevels = Enum.GetValues(typeof(TelemetryLevel)).Cast<TelemetryLevel>().ToList().Select(level => new
                    {
                        level,
                        description = GetTelemetryLevelDescription(level),
                    }),
                };
            }
        }

        public override string View
        {
            get
            {
                return ShowView()
                    // the user UI
                    ? "user"
                    // continue install UI
                    : "continueinstall";
            }
        }

        private string GetTelemetryLevelDescription(TelemetryLevel telemetryLevel) => telemetryLevel switch
        {
            TelemetryLevel.Minimal => _localizedTextService.Localize("analytics", "minimalLevelDescription"),
            TelemetryLevel.Basic => _localizedTextService.Localize("analytics", "basicLevelDescription"),
            TelemetryLevel.Detailed => _localizedTextService.Localize("analytics", "detailedLevelDescription"),
            _ => throw new ArgumentOutOfRangeException(nameof(telemetryLevel), $"Did not expect telemetry level of {telemetryLevel}")
        };

        private InstallState GetInstallState()
        {
            var installState = InstallState.Unknown;


            // TODO: we need to do a null check here since this could be entirely missing and we end up with a null ref
            // exception in the installer.

            var databaseSettings = _connectionStrings.Get(Constants.System.UmbracoConnectionName);

            var hasConnString = databaseSettings != null && _databaseBuilder.IsDatabaseConfigured;
            if (hasConnString)
            {
                installState = (installState | InstallState.HasConnectionString) & ~InstallState.Unknown;
            }

            var connStringConfigured = databaseSettings?.IsConnectionStringConfigured() ?? false;
            if (connStringConfigured)
            {
                installState = (installState | InstallState.ConnectionStringConfigured) & ~InstallState.Unknown;
            }


            var factory = _dbProviderFactoryCreator.CreateFactory(databaseSettings?.ProviderName);
            var canConnect = connStringConfigured && DbConnectionExtensions.IsConnectionAvailable(databaseSettings?.ConnectionString, factory);
            if (canConnect)
            {
                installState = (installState | InstallState.CanConnect) & ~InstallState.Unknown;
            }

            var umbracoInstalled = canConnect ? _databaseBuilder.IsUmbracoInstalled() : false;
            if (umbracoInstalled)
            {
                installState = (installState | InstallState.UmbracoInstalled) & ~InstallState.Unknown;
            }

            var hasNonDefaultUser = umbracoInstalled ? _databaseBuilder.HasSomeNonDefaultUser() : false;
            if (hasNonDefaultUser)
            {
                installState = (installState | InstallState.HasNonDefaultUser) & ~InstallState.Unknown;
            }

            return installState;
        }

        private bool ShowView()
        {
            var installState = GetInstallState();

            return installState.HasFlag(InstallState.Unknown)
                || !installState.HasFlag(InstallState.UmbracoInstalled);
        }

        public override bool RequiresExecution(UserModel model)
        {
            var installState = GetInstallState();

            if (installState.HasFlag(InstallState.Unknown))
            {
                // In this one case when it's a brand new install and nothing has been configured, make sure the
                // back office cookie is cleared so there's no old cookies lying around causing problems
                _cookieManager.ExpireCookie(_securitySettings.AuthCookieName);
            }

            return installState.HasFlag(InstallState.Unknown)
                || !installState.HasFlag(InstallState.HasNonDefaultUser);
        }

        [Flags]
        private enum InstallState : short
        {
            // This is an easy way to avoid 0 enum assignment and not worry about
            // manual calcs. https://www.codeproject.com/Articles/396851/Ending-the-Great-Debate-on-Enum-Flags
            Unknown = 1,
            HasVersion = 1 << 1,
            HasConnectionString = 1 << 2,
            ConnectionStringConfigured = 1 << 3,
            CanConnect = 1 << 4,
            UmbracoInstalled = 1 << 5,
            HasNonDefaultUser = 1 << 6
        }
    }
}