diff --git a/.gitignore b/.gitignore index c792b2c5a9..e38c71eef8 100644 --- a/.gitignore +++ b/.gitignore @@ -209,3 +209,4 @@ src/Umbraco.Tests.UnitTests/umbraco/Data/TEMP/ /src/Umbraco.Web.UI.NetCore/appsettings.Local.json src/Umbraco.Tests.Integration/DatabaseContextTests.sdf +src/Umbraco.Web.UI.NetCore/umbraco/config/appsettings-schema.json diff --git a/NuGet.Config b/NuGet.Config index f8dc68d26a..955cb08d39 100644 --- a/NuGet.Config +++ b/NuGet.Config @@ -10,5 +10,6 @@ + diff --git a/build/azure-pipelines.yml b/build/azure-pipelines.yml index b2824d8237..1a6ca02fd2 100644 --- a/build/azure-pipelines.yml +++ b/build/azure-pipelines.yml @@ -2,6 +2,7 @@ name: $(TeamProject)_$(Build.DefinitionName)_$(SourceBranchName)_$(Date:yyyyMMdd variables: buildConfiguration: Release SA_PASSWORD: UmbracoIntegration123! + UmbracoBuild: AzurePipeline resources: containers: - container: mssql @@ -14,6 +15,28 @@ resources: - '1433:1433' options: '--name mssql' stages: + - stage: Determine_build_type + displayName: Determine build type + dependsOn: [ ] + jobs: + - job: Set_build_variables + displayName: Set build variables + pool: + vmImage: windows-latest + steps: + - task: PowerShell@1 + displayName: Set $isRelease variable + inputs: + scriptType: inlineScript + inlineScript: > + $isRelease = [regex]::matches($env:BUILD_SOURCEBRANCH,"v\d+\/\d+.\d+.*") + + if ($isRelease.Count -gt 0){ + Write-Host "##vso[build.addbuildtag]Release build" + Write-Host "##vso[task.setvariable variable=isRelease]true" + }else{ + Write-Host "##vso[task.setvariable variable=isRelease]false" + } - stage: Unit_Tests displayName: Unit Tests dependsOn: [] @@ -333,12 +356,10 @@ stages: $version = $ubuild.GetUmbracoVersion() - $isRelease = [regex]::matches($env:BUILD_SOURCEBRANCH,"v\d+\/\d+.\d+.*") - if ($isRelease.Count -gt 0){ $continuous = $version.Semver - Write-Host "##vso[build.addbuildtag]Release build" + } else { @@ -366,11 +387,8 @@ stages: $a.symbols.version.defaultValue = $continuous $a | ConvertTo-Json -depth 32| set-content $templatePath - Write-Host "##vso[build.addbuildtag]Continuous build" - } - Write-Host "##vso[build.updatebuildnumber]$continuous.$(Build.BuildId)" Write-Host "Building: $continuous" @@ -383,6 +401,15 @@ stages: $ubuild = build\build.ps1 -get $ubuild.PrepareBuild("vso") + - task: PowerShell@1 + displayName: Prepare JSON Schema + inputs: + scriptType: inlineScript + inlineScript: | + Write-Host "Working folder: $pwd" + $ubuild = build\build.ps1 -get -continue + + $ubuild.CompileJsonSchema() - task: NodeTool@0 displayName: Use Node 11.x inputs: @@ -448,8 +475,8 @@ stages: condition: succeededOrFailed() - stage: Artifacts_Docs displayName: 'Static Code Documentation' - dependsOn: [] - condition: 'ne(variables[''Umbraco.IsReleaseBuild''], ''false'')' + dependsOn: [Determine_build_type] + condition: 'eq(variables.IsRelease, true)' jobs: - job: Generate_Docs_CSharp timeoutInMinutes: 60 diff --git a/build/build.ps1 b/build/build.ps1 index fb869738f3..c998412744 100644 --- a/build/build.ps1 +++ b/build/build.ps1 @@ -211,6 +211,18 @@ # /p:UmbracoBuild tells the csproj that we are building from PS, not VS }) + $ubuild.DefineMethod("CompileJsonSchema", + { + Write-Host "Generating JSON Schema for AppSettings" + Write-Host "Logging to $($this.BuildTemp)\json.schema.log" + + ## NOTE: Need to specify the outputfile to point to the build temp folder + &dotnet run --project "$($this.SolutionRoot)\src\JsonSchema\JsonSchema.csproj" ` + -c Release > "$($this.BuildTemp)\json.schema.log" ` + -- ` + --outputFile "$($this.BuildTemp)\WebApp\umbraco\config\appsettings-schema.json" + }) + $ubuild.DefineMethod("PrepareTests", { Write-Host "Prepare Tests" @@ -511,6 +523,8 @@ if ($this.OnError()) { return } $this.CompileUmbraco() if ($this.OnError()) { return } + $this.CompileJsonSchema() + if ($this.OnError()) { return } $this.PrepareTests() if ($this.OnError()) { return } $this.CompileTests() diff --git a/build/templates/UmbracoProject/UmbracoProject.csproj b/build/templates/UmbracoProject/UmbracoProject.csproj index 6850940edd..86562f7957 100644 --- a/build/templates/UmbracoProject/UmbracoProject.csproj +++ b/build/templates/UmbracoProject/UmbracoProject.csproj @@ -47,5 +47,6 @@ false + false diff --git a/build/templates/UmbracoProject/appsettings.Development.json b/build/templates/UmbracoProject/appsettings.Development.json index a02bad241d..7b72c085d7 100644 --- a/build/templates/UmbracoProject/appsettings.Development.json +++ b/build/templates/UmbracoProject/appsettings.Development.json @@ -1,5 +1,5 @@ { - "$schema": "https://json.schemastore.org/appsettings.json", + "$schema" : "./umbraco/config/appsettings-schema.json", "Serilog": { "MinimumLevel": { "Default": "Information" diff --git a/build/templates/UmbracoProject/appsettings.json b/build/templates/UmbracoProject/appsettings.json index 324b99f42c..4045341729 100644 --- a/build/templates/UmbracoProject/appsettings.json +++ b/build/templates/UmbracoProject/appsettings.json @@ -1,5 +1,5 @@ { - "$schema": "https://json.schemastore.org/appsettings.json", + "$schema" : "./umbraco/config/appsettings-schema.json", "Serilog": { "MinimumLevel": { "Default": "Information", diff --git a/src/JsonSchema/AppSettings.cs b/src/JsonSchema/AppSettings.cs new file mode 100644 index 0000000000..616d641751 --- /dev/null +++ b/src/JsonSchema/AppSettings.cs @@ -0,0 +1,81 @@ +using Umbraco.Cms.Core.Configuration.Models; +using Umbraco.Forms.Core.Configuration; +using SecuritySettings = Umbraco.Cms.Core.Configuration.Models.SecuritySettings; + +namespace JsonSchema +{ + public class AppSettings + { + public UmbracoDefinition Umbraco { get; set; } + + /// + /// Configuration of Umbraco CMS and packages + /// + public class UmbracoDefinition + { + public CmsDefinition CMS { get; set; } + public FormsDefinition Forms { get; set; } + public DeployDefinition Deploy { get; set; } + + /// + /// Configurations for the Umbraco CMS + /// + public class CmsDefinition + { + public ActiveDirectorySettings ActiveDirectory { get; set; } + public ContentSettings Content { get; set; } + public ExceptionFilterSettings ExceptionFilter { get; set; } + public ModelsBuilderSettings ModelsBuilder { get; set; } + public GlobalSettings Global { get; set; } + public HealthChecksSettings HealthChecks { get; set; } + public HostingSettings Hosting { get; set; } + public ImagingSettings Imaging { get; set; } + public IndexCreatorSettings Examine { get; set; } + public KeepAliveSettings KeepAlive { get; set; } + public LoggingSettings Logging { get; set; } + public MemberPasswordConfigurationSettings MemberPassword { get; set; } + public NuCacheSettings NuCache { get; set; } + public RequestHandlerSettings RequestHandler { get; set; } + public RuntimeSettings Runtime { get; set; } + public SecuritySettings Security { get; set; } + public TourSettings Tours { get; set; } + public TypeFinderSettings TypeFinder { get; set; } + public UserPasswordConfigurationSettings UserPassword { get; set; } + public WebRoutingSettings WebRouting { get; set; } + public UmbracoPluginSettings Plugins { get; set; } + public UnattendedSettings Unattended { get; set; } + public RichTextEditorSettings RichTextEditor { get; set; } + public RuntimeMinificationSettings RuntimeMinification { get; set; } + } + + /// + /// Configurations for the Umbraco Forms package to Umbraco CMS + /// + public class FormsDefinition + { + public FormDesignSettings FormDesign { get; set; } + public PackageOptionSettings Options { get; set; } + public Umbraco.Forms.Core.Configuration.SecuritySettings Security { get; set; } + public FieldTypesDefinition FieldTypes { get; set; } + + /// + /// Configurations for the Umbraco Forms Field Types + /// + public class FieldTypesDefinition + { + public DatePickerSettings DatePicker { get; set; } + public Recaptcha2Settings Recaptcha2 { get; set; } + public Recaptcha3Settings Recaptcha3 { get; set; } + } + } + + /// + /// Configurations for the Umbraco Deploy package to Umbraco CMS + /// + public class DeployDefinition + { + + } + } + } +} diff --git a/src/JsonSchema/JsonSchema.csproj b/src/JsonSchema/JsonSchema.csproj new file mode 100644 index 0000000000..25d4fa5498 --- /dev/null +++ b/src/JsonSchema/JsonSchema.csproj @@ -0,0 +1,32 @@ + + + + Exe + net5.0 + true + + + + + + + + + + + + + + + + $(UserProfile)\.nuget\packages\ + + + + + + + + + + diff --git a/src/JsonSchema/NamespacePrefixedSchemaNameGenerator.cs b/src/JsonSchema/NamespacePrefixedSchemaNameGenerator.cs new file mode 100644 index 0000000000..77b7b8c474 --- /dev/null +++ b/src/JsonSchema/NamespacePrefixedSchemaNameGenerator.cs @@ -0,0 +1,13 @@ +using System; +using NJsonSchema.Generation; + +namespace JsonSchema +{ + public class NamespacePrefixedSchemaNameGenerator : DefaultSchemaNameGenerator + { + public override string Generate(Type type) + { + return type.Namespace.Replace(".", String.Empty) + base.Generate(type); + } + } +} diff --git a/src/JsonSchema/Program.cs b/src/JsonSchema/Program.cs new file mode 100644 index 0000000000..d8b31ad224 --- /dev/null +++ b/src/JsonSchema/Program.cs @@ -0,0 +1,45 @@ +using System; +using System.IO; +using System.Threading.Tasks; +using CommandLine; + +namespace JsonSchema +{ + class Program + { + private class Options + { + [Option('o', "outputFile", Required = false, HelpText = "Set path of the output file.", Default = "../../../../Umbraco.Web.UI.NetCore/umbraco/config/appsettings-schema.json")] + public string OutputFile { get; set; } + } + + public static async Task Main(string[] args) + { + try + { + await Parser.Default.ParseArguments(args) + .WithParsedAsync(Execute); + } + catch (Exception e) + { + Console.WriteLine(e); + throw; + } + + } + + private static async Task Execute(Options options) + { + var generator = new UmbracoJsonSchemaGenerator(); + var schema = await generator.Generate(); + + var path = Path.GetFullPath(Path.Combine(Environment.CurrentDirectory, options.OutputFile)); + Console.WriteLine("Path to use {0}",path); + Directory.CreateDirectory(Path.GetDirectoryName(path)); + Console.WriteLine("Ensured directory exists"); + await File.WriteAllTextAsync(path, schema); + + Console.WriteLine("File written at {0}", path); + } + } +} diff --git a/src/JsonSchema/UmbracoJsonSchemaGenerator.cs b/src/JsonSchema/UmbracoJsonSchemaGenerator.cs new file mode 100644 index 0000000000..b6e516d0c5 --- /dev/null +++ b/src/JsonSchema/UmbracoJsonSchemaGenerator.cs @@ -0,0 +1,57 @@ +using System.Net.Http; +using System.Threading.Tasks; +using Newtonsoft.Json; +using Newtonsoft.Json.Linq; +using NJsonSchema.Generation; + +namespace JsonSchema +{ + /// + /// Generator of the JsonSchema for AppSettings.json including A specific Umbraco version. + /// + public class UmbracoJsonSchemaGenerator + { + private readonly JsonSchemaGenerator _innerGenerator; + private static readonly HttpClient s_client = new HttpClient(); + + /// + /// Creates a new instance of . + /// + /// The prefix to use for definitions generated. + public UmbracoJsonSchemaGenerator() + => _innerGenerator = new JsonSchemaGenerator(new UmbracoJsonSchemaGeneratorSettings()); + + + /// + /// Generates a json representing the JsonSchema for AppSettings.json including A specific Umbraco version.. + /// + public async Task Generate() + { + var umbracoSchema = GenerateUmbracoSchema(); + var officialSchema = await GetOfficialAppSettingsSchema(); + + officialSchema.Merge(umbracoSchema); + + return officialSchema.ToString(); + } + + private async Task GetOfficialAppSettingsSchema() + { + + var response = await s_client.GetAsync("https://json.schemastore.org/appsettings.json"); + + + var result = await response.Content.ReadAsStringAsync(); + + return JsonConvert.DeserializeObject(result); + + } + + private JObject GenerateUmbracoSchema() + { + var schema = _innerGenerator.Generate(typeof(AppSettings)); + + return JsonConvert.DeserializeObject(schema.ToJson()); + } + } +} diff --git a/src/JsonSchema/UmbracoJsonSchemaGeneratorSettings.cs b/src/JsonSchema/UmbracoJsonSchemaGeneratorSettings.cs new file mode 100644 index 0000000000..26af0faae2 --- /dev/null +++ b/src/JsonSchema/UmbracoJsonSchemaGeneratorSettings.cs @@ -0,0 +1,41 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Newtonsoft.Json.Serialization; +using NJsonSchema.Generation; + +namespace JsonSchema +{ + /// + public class UmbracoJsonSchemaGeneratorSettings : JsonSchemaGeneratorSettings + { + /// + /// Creates a new instance of . + /// + /// The prefix to use for definitions generated. + public UmbracoJsonSchemaGeneratorSettings() + { + AlwaysAllowAdditionalObjectProperties = true; + SerializerSettings = new JsonSerializerSettings() + { + ContractResolver = new WritablePropertiesOnlyResolver() + }; + DefaultReferenceTypeNullHandling = ReferenceTypeNullHandling.NotNull; + SchemaNameGenerator = new NamespacePrefixedSchemaNameGenerator(); + SerializerSettings.Converters.Add(new StringEnumConverter()); + IgnoreObsoleteProperties = true; + GenerateExamples = true; + } + + private class WritablePropertiesOnlyResolver : DefaultContractResolver + { + protected override IList CreateProperties(Type type, MemberSerialization memberSerialization) + { + IList props = base.CreateProperties(type, memberSerialization); + return props.Where(p => p.Writable).ToList(); + } + } + } +} diff --git a/src/Umbraco.Core/Configuration/Models/ActiveDirectorySettings.cs b/src/Umbraco.Core/Configuration/Models/ActiveDirectorySettings.cs index 700e3fe3e1..c8544dcebc 100644 --- a/src/Umbraco.Core/Configuration/Models/ActiveDirectorySettings.cs +++ b/src/Umbraco.Core/Configuration/Models/ActiveDirectorySettings.cs @@ -6,6 +6,7 @@ namespace Umbraco.Cms.Core.Configuration.Models /// /// Typed configuration options for active directory settings. /// + [UmbracoOptions(Constants.Configuration.ConfigActiveDirectory)] public class ActiveDirectorySettings { /// diff --git a/src/Umbraco.Core/Configuration/Models/Attributes/UmbracoOptionsAttribute.cs b/src/Umbraco.Core/Configuration/Models/Attributes/UmbracoOptionsAttribute.cs new file mode 100644 index 0000000000..211b6b3d83 --- /dev/null +++ b/src/Umbraco.Core/Configuration/Models/Attributes/UmbracoOptionsAttribute.cs @@ -0,0 +1,16 @@ +using System; + +namespace Umbraco.Cms.Core.Configuration.Models +{ + [AttributeUsage(AttributeTargets.Class, AllowMultiple = false)] + public class UmbracoOptionsAttribute : Attribute + { + public string ConfigurationKey { get; } + public bool BindNonPublicProperties { get; set; } + + public UmbracoOptionsAttribute(string configurationKey) + { + ConfigurationKey = configurationKey; + } + } +} diff --git a/src/Umbraco.Core/Configuration/Models/ConnectionStrings.cs b/src/Umbraco.Core/Configuration/Models/ConnectionStrings.cs index 9e6ab4cff1..bfcb41d992 100644 --- a/src/Umbraco.Core/Configuration/Models/ConnectionStrings.cs +++ b/src/Umbraco.Core/Configuration/Models/ConnectionStrings.cs @@ -6,6 +6,7 @@ namespace Umbraco.Cms.Core.Configuration.Models /// /// Typed configuration options for connection strings. /// + [UmbracoOptions("ConnectionStrings", BindNonPublicProperties = true)] public class ConnectionStrings { // Backing field for UmbracoConnectionString to load from configuration value with key umbracoDbDSN. diff --git a/src/Umbraco.Core/Configuration/Models/ContentImagingSettings.cs b/src/Umbraco.Core/Configuration/Models/ContentImagingSettings.cs index ee21484dab..990b3c61cb 100644 --- a/src/Umbraco.Core/Configuration/Models/ContentImagingSettings.cs +++ b/src/Umbraco.Core/Configuration/Models/ContentImagingSettings.cs @@ -1,6 +1,9 @@ // Copyright (c) Umbraco. // See LICENSE for more details. +using System; +using System.ComponentModel; + namespace Umbraco.Cms.Core.Configuration.Models { /// @@ -20,10 +23,13 @@ namespace Umbraco.Cms.Core.Configuration.Models } }; + internal const string StaticImageFileTypes = "jpeg,jpg,gif,bmp,png,tiff,tif"; + /// /// Gets or sets a value for the collection of accepted image file extensions. /// - public string[] ImageFileTypes { get; set; } = new[] { "jpeg", "jpg", "gif", "bmp", "png", "tiff", "tif" }; + [DefaultValue(StaticImageFileTypes)] + public string[] ImageFileTypes { get; set; } = StaticImageFileTypes.Split(','); /// /// Gets or sets a value for the imaging autofill following media file upload fields. diff --git a/src/Umbraco.Core/Configuration/Models/ContentNotificationSettings.cs b/src/Umbraco.Core/Configuration/Models/ContentNotificationSettings.cs index 2fa92eb4b5..b4ae2b34a1 100644 --- a/src/Umbraco.Core/Configuration/Models/ContentNotificationSettings.cs +++ b/src/Umbraco.Core/Configuration/Models/ContentNotificationSettings.cs @@ -1,6 +1,8 @@ // Copyright (c) Umbraco. // See LICENSE for more details. +using System.ComponentModel; + namespace Umbraco.Cms.Core.Configuration.Models { /// @@ -8,6 +10,8 @@ namespace Umbraco.Cms.Core.Configuration.Models /// public class ContentNotificationSettings { + internal const bool StaticDisableHtmlEmail = false; + /// /// Gets or sets a value for the email address for notifications. /// @@ -16,6 +20,7 @@ namespace Umbraco.Cms.Core.Configuration.Models /// /// Gets or sets a value indicating whether HTML email notifications should be disabled. /// - public bool DisableHtmlEmail { get; set; } = false; + [DefaultValue(StaticDisableHtmlEmail)] + public bool DisableHtmlEmail { get; set; } = StaticDisableHtmlEmail; } } diff --git a/src/Umbraco.Core/Configuration/Models/ContentSettings.cs b/src/Umbraco.Core/Configuration/Models/ContentSettings.cs index 7da55cca99..dcca8c2adb 100644 --- a/src/Umbraco.Core/Configuration/Models/ContentSettings.cs +++ b/src/Umbraco.Core/Configuration/Models/ContentSettings.cs @@ -3,6 +3,7 @@ using System; using System.Collections.Generic; +using System.ComponentModel; using Umbraco.Cms.Core.Macros; namespace Umbraco.Cms.Core.Configuration.Models @@ -10,9 +11,12 @@ namespace Umbraco.Cms.Core.Configuration.Models /// /// Typed configuration options for content settings. /// + [UmbracoOptions(Constants.Configuration.ConfigContent)] public class ContentSettings { - private const string DefaultPreviewBadge = + + internal const bool StaticResolveUrlsFromTextString = false; + internal const string StaticDefaultPreviewBadge = @"
Preview mode @@ -147,6 +151,12 @@ namespace Umbraco.Cms.Core.Configuration.Models "; + internal const string StaticMacroErrors = "Inline"; + internal const string StaticDisallowedUploadFiles = "ashx,aspx,ascx,config,cshtml,vbhtml,asmx,air,axd,xamlx"; + internal const bool StaticShowDeprecatedPropertyEditors = false; + internal const string StaticLoginBackgroundImage = "assets/img/login.jpg"; + internal const string StaticLoginLogoImage = "assets/img/application/umbraco_logo_white.svg"; + /// /// Gets or sets a value for the content notification settings. /// @@ -160,7 +170,8 @@ namespace Umbraco.Cms.Core.Configuration.Models /// /// Gets or sets a value indicating whether URLs should be resolved from text strings. /// - public bool ResolveUrlsFromTextString { get; set; } = false; + [DefaultValue(StaticResolveUrlsFromTextString)] + public bool ResolveUrlsFromTextString { get; set; } = StaticResolveUrlsFromTextString; /// /// Gets or sets a value for the collection of error pages. @@ -170,17 +181,20 @@ namespace Umbraco.Cms.Core.Configuration.Models /// /// Gets or sets a value for the preview badge mark-up. /// - public string PreviewBadge { get; set; } = DefaultPreviewBadge; + [DefaultValue(StaticDefaultPreviewBadge)] + public string PreviewBadge { get; set; } = StaticDefaultPreviewBadge; /// /// Gets or sets a value for the macro error behaviour. /// - public MacroErrorBehaviour MacroErrors { get; set; } = MacroErrorBehaviour.Inline; + [DefaultValue(StaticMacroErrors)] + public MacroErrorBehaviour MacroErrors { get; set; } = Enum.Parse(StaticMacroErrors); /// /// Gets or sets a value for the collection of file extensions that are disallowed for upload. /// - public IEnumerable DisallowedUploadFiles { get; set; } = new[] { "ashx", "aspx", "ascx", "config", "cshtml", "vbhtml", "asmx", "air", "axd", "xamlx" }; + [DefaultValue(StaticDisallowedUploadFiles)] + public IEnumerable DisallowedUploadFiles { get; set; } = StaticDisallowedUploadFiles.Split(','); /// /// Gets or sets a value for the collection of file extensions that are allowed for upload. @@ -190,17 +204,20 @@ namespace Umbraco.Cms.Core.Configuration.Models /// /// Gets or sets a value indicating whether deprecated property editors should be shown. /// - public bool ShowDeprecatedPropertyEditors { get; set; } = false; + [DefaultValue(StaticShowDeprecatedPropertyEditors)] + public bool ShowDeprecatedPropertyEditors { get; set; } = StaticShowDeprecatedPropertyEditors; /// /// Gets or sets a value for the path to the login screen background image. /// - public string LoginBackgroundImage { get; set; } = "assets/img/login.jpg"; + [DefaultValue(StaticLoginBackgroundImage)] + public string LoginBackgroundImage { get; set; } = StaticLoginBackgroundImage; /// /// Gets or sets a value for the path to the login screen logo image. /// - public string LoginLogoImage { get; set; } = "assets/img/application/umbraco_logo_white.svg"; + [DefaultValue(StaticLoginLogoImage)] + public string LoginLogoImage { get; set; } = StaticLoginLogoImage; } diff --git a/src/Umbraco.Core/Configuration/Models/CoreDebugSettings.cs b/src/Umbraco.Core/Configuration/Models/CoreDebugSettings.cs index 1978e02f18..58810a3462 100644 --- a/src/Umbraco.Core/Configuration/Models/CoreDebugSettings.cs +++ b/src/Umbraco.Core/Configuration/Models/CoreDebugSettings.cs @@ -1,21 +1,29 @@ // Copyright (c) Umbraco. // See LICENSE for more details. +using System.ComponentModel; + namespace Umbraco.Cms.Core.Configuration.Models { /// /// Typed configuration options for core debug settings. /// + [UmbracoOptions(Constants.Configuration.ConfigCoreDebug)] public class CoreDebugSettings { + internal const bool StaticLogIncompletedScopes = false; + internal const bool StaticDumpOnTimeoutThreadAbort = false; + /// /// Gets or sets a value indicating whether incompleted scopes should be logged. /// - public bool LogIncompletedScopes { get; set; } = false; + [DefaultValue(StaticLogIncompletedScopes)] + public bool LogIncompletedScopes { get; set; } = StaticLogIncompletedScopes; /// /// Gets or sets a value indicating whether memory dumps on thread abort should be taken. /// - public bool DumpOnTimeoutThreadAbort { get; set; } = false; + [DefaultValue(StaticDumpOnTimeoutThreadAbort)] + public bool DumpOnTimeoutThreadAbort { get; set; } = StaticDumpOnTimeoutThreadAbort; } } diff --git a/src/Umbraco.Core/Configuration/Models/DatabaseServerMessengerSettings.cs b/src/Umbraco.Core/Configuration/Models/DatabaseServerMessengerSettings.cs index d2afea19e7..f1320a199f 100644 --- a/src/Umbraco.Core/Configuration/Models/DatabaseServerMessengerSettings.cs +++ b/src/Umbraco.Core/Configuration/Models/DatabaseServerMessengerSettings.cs @@ -2,6 +2,7 @@ // See LICENSE for more details. using System; +using System.ComponentModel; namespace Umbraco.Cms.Core.Configuration.Models { @@ -10,24 +11,33 @@ namespace Umbraco.Cms.Core.Configuration.Models /// public class DatabaseServerMessengerSettings { + internal const int StaticMaxProcessingInstructionCount = 1000; + internal const string StaticTimeToRetainInstructions = "2.00:00:00"; // TimeSpan.FromDays(2); + internal const string StaticTimeBetweenSyncOperations = "00:00:05"; // TimeSpan.FromSeconds(5); + internal const string StaticTimeBetweenPruneOperations = "00:01:00"; // TimeSpan.FromMinutes(1); + /// /// Gets or sets a value for the maximum number of instructions that can be processed at startup; otherwise the server cold-boots (rebuilds its caches). /// - public int MaxProcessingInstructionCount { get; set; } = 1000; + [DefaultValue(StaticMaxProcessingInstructionCount)] + public int MaxProcessingInstructionCount { get; set; } = StaticMaxProcessingInstructionCount; /// /// Gets or sets a value for the time to keep instructions in the database; records older than this number will be pruned. /// - public TimeSpan TimeToRetainInstructions { get; set; } = TimeSpan.FromDays(2); + [DefaultValue(StaticTimeToRetainInstructions)] + public TimeSpan TimeToRetainInstructions { get; set; } = TimeSpan.Parse(StaticTimeToRetainInstructions); /// /// Gets or sets a value for the time to wait between each sync operations. /// - public TimeSpan TimeBetweenSyncOperations { get; set; } = TimeSpan.FromSeconds(5); + [DefaultValue(StaticTimeBetweenSyncOperations)] + public TimeSpan TimeBetweenSyncOperations { get; set; } = TimeSpan.Parse(StaticTimeBetweenSyncOperations); /// /// Gets or sets a value for the time to wait between each prune operations. /// - public TimeSpan TimeBetweenPruneOperations { get; set; } = TimeSpan.FromMinutes(1); + [DefaultValue(StaticTimeBetweenPruneOperations)] + public TimeSpan TimeBetweenPruneOperations { get; set; } = TimeSpan.Parse(StaticTimeBetweenPruneOperations); } } diff --git a/src/Umbraco.Core/Configuration/Models/DatabaseServerRegistrarSettings.cs b/src/Umbraco.Core/Configuration/Models/DatabaseServerRegistrarSettings.cs index 66d35f6a36..91d293f272 100644 --- a/src/Umbraco.Core/Configuration/Models/DatabaseServerRegistrarSettings.cs +++ b/src/Umbraco.Core/Configuration/Models/DatabaseServerRegistrarSettings.cs @@ -2,6 +2,7 @@ // See LICENSE for more details. using System; +using System.ComponentModel; namespace Umbraco.Cms.Core.Configuration.Models { @@ -10,14 +11,19 @@ namespace Umbraco.Cms.Core.Configuration.Models /// public class DatabaseServerRegistrarSettings { + internal const string StaticWaitTimeBetweenCalls = "00:01:00"; + internal const string StaticStaleServerTimeout = "00:02:00"; + /// /// Gets or sets a value for the amount of time to wait between calls to the database on the background thread. /// - public TimeSpan WaitTimeBetweenCalls { get; set; } = TimeSpan.FromMinutes(1); + [DefaultValue(StaticWaitTimeBetweenCalls)] + public TimeSpan WaitTimeBetweenCalls { get; set; } = TimeSpan.Parse(StaticWaitTimeBetweenCalls); /// /// Gets or sets a value for the time span to wait before considering a server stale, after it has last been accessed. /// - public TimeSpan StaleServerTimeout { get; set; } = TimeSpan.FromMinutes(2); + [DefaultValue(StaticStaleServerTimeout)] + public TimeSpan StaleServerTimeout { get; set; } = TimeSpan.Parse(StaticStaleServerTimeout); } } diff --git a/src/Umbraco.Core/Configuration/Models/ExceptionFilterSettings.cs b/src/Umbraco.Core/Configuration/Models/ExceptionFilterSettings.cs index 0a6bc32351..0d48453071 100644 --- a/src/Umbraco.Core/Configuration/Models/ExceptionFilterSettings.cs +++ b/src/Umbraco.Core/Configuration/Models/ExceptionFilterSettings.cs @@ -1,16 +1,22 @@ // Copyright (c) Umbraco. // See LICENSE for more details. +using System.ComponentModel; + namespace Umbraco.Cms.Core.Configuration.Models { /// /// Typed configuration options for exception filter settings. /// + [UmbracoOptions(Constants.Configuration.ConfigExceptionFilter)] public class ExceptionFilterSettings { + internal const bool StaticDisabled = false; + /// /// Gets or sets a value indicating whether the exception filter is disabled. /// - public bool Disabled { get; set; } = false; + [DefaultValue(StaticDisabled)] + public bool Disabled { get; set; } = StaticDisabled; } } diff --git a/src/Umbraco.Core/Configuration/Models/GlobalSettings.cs b/src/Umbraco.Core/Configuration/Models/GlobalSettings.cs index b27b60ec8e..7799fec5ea 100644 --- a/src/Umbraco.Core/Configuration/Models/GlobalSettings.cs +++ b/src/Umbraco.Core/Configuration/Models/GlobalSettings.cs @@ -2,59 +2,82 @@ // See LICENSE for more details. using System; +using System.ComponentModel; namespace Umbraco.Cms.Core.Configuration.Models { /// /// Typed configuration options for global settings. /// + [UmbracoOptions(Constants.Configuration.ConfigGlobal)] public class GlobalSettings { - internal const string - StaticReservedPaths = "~/app_plugins/,~/install/,~/mini-profiler-resources/,~/umbraco/,"; // must end with a comma! - - internal const string - StaticReservedUrls = "~/.well-known,"; // must end with a comma! + internal const string StaticReservedPaths = "~/app_plugins/,~/install/,~/mini-profiler-resources/,~/umbraco/,"; // must end with a comma! + internal const string StaticReservedUrls = "~/.well-known,"; // must end with a comma! + internal const string StaticTimeOut = "00:20:00"; + internal const string StaticDefaultUILanguage = "en-US"; + internal const bool StaticHideTopLevelNodeFromPath = true; + internal const bool StaticUseHttps = false; + internal const int StaticVersionCheckPeriod = 7; + internal const string StaticUmbracoPath = "~/umbraco"; + internal const string StaticIconsPath = "~/umbraco/assets/icons"; + internal const string StaticUmbracoCssPath = "~/css"; + internal const string StaticUmbracoScriptsPath = "~/scripts"; + internal const string StaticUmbracoMediaPath = "~/media"; + internal const bool StaticInstallMissingDatabase = false; + internal const bool StaticDisableElectionForSingleServer = false; + internal const string StaticNoNodesViewPath = "~/umbraco/UmbracoWebsite/NoNodes.cshtml"; + internal const string StaticSqlWriteLockTimeOut = "00:00:05"; /// /// Gets or sets a value for the reserved URLs. + /// It must end with a comma /// + [DefaultValue(StaticReservedUrls)] public string ReservedUrls { get; set; } = StaticReservedUrls; /// /// Gets or sets a value for the reserved paths. + /// It must end with a comma /// + [DefaultValue(StaticReservedPaths)] public string ReservedPaths { get; set; } = StaticReservedPaths; /// /// Gets or sets a value for the timeout /// - public TimeSpan TimeOut{ get; set; } = TimeSpan.FromMinutes(20); + [DefaultValue(StaticTimeOut)] + public TimeSpan TimeOut { get; set; } = TimeSpan.Parse(StaticTimeOut); /// /// Gets or sets a value for the default UI language. /// - public string DefaultUILanguage { get; set; } = "en-US"; + [DefaultValue(StaticDefaultUILanguage)] + public string DefaultUILanguage { get; set; } = StaticDefaultUILanguage; /// /// Gets or sets a value indicating whether to hide the top level node from the path. /// - public bool HideTopLevelNodeFromPath { get; set; } = true; + [DefaultValue(StaticHideTopLevelNodeFromPath)] + public bool HideTopLevelNodeFromPath { get; set; } = StaticHideTopLevelNodeFromPath; /// /// Gets or sets a value indicating whether HTTPS should be used. /// - public bool UseHttps { get; set; } = false; + [DefaultValue(StaticUseHttps)] + public bool UseHttps { get; set; } = StaticUseHttps; /// /// Gets or sets a value for the version check period in days. /// - public int VersionCheckPeriod { get; set; } = 7; + [DefaultValue(StaticVersionCheckPeriod)] + public int VersionCheckPeriod { get; set; } = StaticVersionCheckPeriod; /// /// Gets or sets a value for the Umbraco back-office path. /// - public string UmbracoPath { get; set; } = "~/umbraco"; + [DefaultValue(StaticUmbracoPath)] + public string UmbracoPath { get; set; } = StaticUmbracoPath; /// /// Gets or sets a value for the Umbraco icons path. @@ -64,32 +87,38 @@ namespace Umbraco.Cms.Core.Configuration.Models /// so this should not be a normal get set it has to have dynamic ability to return the correct /// path given UmbracoPath if this hasn't been explicitly set. /// - public string IconsPath { get; set; } = $"~/umbraco/assets/icons"; + [DefaultValue(StaticIconsPath)] + public string IconsPath { get; set; } = StaticIconsPath; /// /// Gets or sets a value for the Umbraco CSS path. /// - public string UmbracoCssPath { get; set; } = "~/css"; + [DefaultValue(StaticUmbracoCssPath)] + public string UmbracoCssPath { get; set; } = StaticUmbracoCssPath; /// /// Gets or sets a value for the Umbraco scripts path. /// - public string UmbracoScriptsPath { get; set; } = "~/scripts"; + [DefaultValue(StaticUmbracoScriptsPath)] + public string UmbracoScriptsPath { get; set; } = StaticUmbracoScriptsPath; /// /// Gets or sets a value for the Umbraco media path. /// - public string UmbracoMediaPath { get; set; } = "~/media"; + [DefaultValue(StaticUmbracoMediaPath)] + public string UmbracoMediaPath { get; set; } = StaticUmbracoMediaPath; /// /// Gets or sets a value indicating whether to install the database when it is missing. /// - public bool InstallMissingDatabase { get; set; } = false; + [DefaultValue(StaticInstallMissingDatabase)] + public bool InstallMissingDatabase { get; set; } = StaticInstallMissingDatabase; /// /// Gets or sets a value indicating whether to disable the election for a single server. /// - public bool DisableElectionForSingleServer { get; set; } = false; + [DefaultValue(StaticDisableElectionForSingleServer)] + public bool DisableElectionForSingleServer { get; set; } = StaticDisableElectionForSingleServer; /// /// Gets or sets a value for the database factory server version. @@ -105,7 +134,8 @@ namespace Umbraco.Cms.Core.Configuration.Models /// /// Gets or sets a value for the path to the no content view. /// - public string NoNodesViewPath { get; set; } = "~/umbraco/UmbracoWebsite/NoNodes.cshtml"; + [DefaultValue(StaticNoNodesViewPath)] + public string NoNodesViewPath { get; set; } = StaticNoNodesViewPath; /// /// Gets or sets a value for the database server registrar settings. @@ -134,6 +164,7 @@ namespace Umbraco.Cms.Core.Configuration.Models /// The default value is 5000 milliseconds /// /// The timeout in milliseconds. - public TimeSpan SqlWriteLockTimeOut { get; } = TimeSpan.FromMilliseconds(5000); + [DefaultValue(StaticSqlWriteLockTimeOut)] + public TimeSpan SqlWriteLockTimeOut { get; } = TimeSpan.Parse(StaticSqlWriteLockTimeOut); } } diff --git a/src/Umbraco.Core/Configuration/Models/HealthChecksNotificationMethodSettings.cs b/src/Umbraco.Core/Configuration/Models/HealthChecksNotificationMethodSettings.cs index 0ca03d6cc0..2fc621a482 100644 --- a/src/Umbraco.Core/Configuration/Models/HealthChecksNotificationMethodSettings.cs +++ b/src/Umbraco.Core/Configuration/Models/HealthChecksNotificationMethodSettings.cs @@ -2,6 +2,7 @@ // See LICENSE for more details. using System.Collections.Generic; +using System.ComponentModel; using Umbraco.Cms.Core.HealthChecks; namespace Umbraco.Cms.Core.Configuration.Models @@ -11,20 +12,27 @@ namespace Umbraco.Cms.Core.Configuration.Models /// public class HealthChecksNotificationMethodSettings { + internal const bool StaticEnabled = false; + internal const string StaticVerbosity = "Summary"; // Enum + internal const bool StaticFailureOnly = false; + /// /// Gets or sets a value indicating whether the health check notification method is enabled. /// - public bool Enabled { get; set; } = false; + [DefaultValue(StaticEnabled)] + public bool Enabled { get; set; } = StaticEnabled; /// /// Gets or sets a value for the health check notifications reporting verbosity. /// - public HealthCheckNotificationVerbosity Verbosity { get; set; } = HealthCheckNotificationVerbosity.Summary; + [DefaultValue(StaticVerbosity)] + public HealthCheckNotificationVerbosity Verbosity { get; set; } = Enum.Parse(StaticVerbosity); /// /// Gets or sets a value indicating whether the health check notifications should occur on failures only. /// - public bool FailureOnly { get; set; } = false; + [DefaultValue(StaticFailureOnly)] + public bool FailureOnly { get; set; } = StaticFailureOnly; /// /// Gets or sets a value providing provider specific settings for the health check notification method. diff --git a/src/Umbraco.Core/Configuration/Models/HealthChecksNotificationSettings.cs b/src/Umbraco.Core/Configuration/Models/HealthChecksNotificationSettings.cs index 316b494a19..6e082da19f 100644 --- a/src/Umbraco.Core/Configuration/Models/HealthChecksNotificationSettings.cs +++ b/src/Umbraco.Core/Configuration/Models/HealthChecksNotificationSettings.cs @@ -3,6 +3,7 @@ using System; using System.Collections.Generic; +using System.ComponentModel; using System.Linq; namespace Umbraco.Cms.Core.Configuration.Models @@ -12,10 +13,14 @@ namespace Umbraco.Cms.Core.Configuration.Models /// public class HealthChecksNotificationSettings { + internal const bool StaticEnabled = false; + internal const string StaticPeriod = "1.00:00:00"; //TimeSpan.FromHours(24); + /// /// Gets or sets a value indicating whether health check notifications are enabled. /// - public bool Enabled { get; set; } = false; + [DefaultValue(StaticEnabled)] + public bool Enabled { get; set; } = StaticEnabled; /// /// Gets or sets a value for the first run time of a healthcheck notification in crontab format. @@ -25,7 +30,8 @@ namespace Umbraco.Cms.Core.Configuration.Models /// /// Gets or sets a value for the period of the healthcheck notification. /// - public TimeSpan Period { get; set; } = TimeSpan.FromHours(24); + [DefaultValue(StaticPeriod)] + public TimeSpan Period { get; set; } = TimeSpan.Parse(StaticPeriod); /// /// Gets or sets a value for the collection of health check notification methods. diff --git a/src/Umbraco.Core/Configuration/Models/HealthChecksSettings.cs b/src/Umbraco.Core/Configuration/Models/HealthChecksSettings.cs index ba7ccf1371..0d232b9a9b 100644 --- a/src/Umbraco.Core/Configuration/Models/HealthChecksSettings.cs +++ b/src/Umbraco.Core/Configuration/Models/HealthChecksSettings.cs @@ -9,6 +9,7 @@ namespace Umbraco.Cms.Core.Configuration.Models /// /// Typed configuration options for healthchecks settings. /// + [UmbracoOptions(Constants.Configuration.ConfigHealthChecks)] public class HealthChecksSettings { /// diff --git a/src/Umbraco.Core/Configuration/Models/HostingSettings.cs b/src/Umbraco.Core/Configuration/Models/HostingSettings.cs index 981cf8a6db..b9e11e99ca 100644 --- a/src/Umbraco.Core/Configuration/Models/HostingSettings.cs +++ b/src/Umbraco.Core/Configuration/Models/HostingSettings.cs @@ -1,13 +1,19 @@ // Copyright (c) Umbraco. // See LICENSE for more details. +using System.ComponentModel; + namespace Umbraco.Cms.Core.Configuration.Models { /// /// Typed configuration options for hosting settings. /// + [UmbracoOptions(Constants.Configuration.ConfigHosting)] public class HostingSettings { + internal const string StaticLocalTempStorageLocation = "Default"; + internal const bool StaticDebug = false; + /// /// Gets or sets a value for the application virtual path. /// @@ -16,12 +22,14 @@ namespace Umbraco.Cms.Core.Configuration.Models /// /// Gets or sets a value for the location of temporary files. /// - public LocalTempStorage LocalTempStorageLocation { get; set; } = LocalTempStorage.Default; + [DefaultValue(StaticLocalTempStorageLocation)] + public LocalTempStorage LocalTempStorageLocation { get; set; } = Enum.Parse(StaticLocalTempStorageLocation); /// /// Gets or sets a value indicating whether umbraco is running in [debug mode]. /// /// true if [debug mode]; otherwise, false. - public bool Debug { get; set; } = false; + [DefaultValue(StaticDebug)] + public bool Debug { get; set; } = StaticDebug; } } diff --git a/src/Umbraco.Core/Configuration/Models/ImagingCacheSettings.cs b/src/Umbraco.Core/Configuration/Models/ImagingCacheSettings.cs index e9bdd77545..18fc5ccd93 100644 --- a/src/Umbraco.Core/Configuration/Models/ImagingCacheSettings.cs +++ b/src/Umbraco.Core/Configuration/Models/ImagingCacheSettings.cs @@ -2,6 +2,7 @@ // See LICENSE for more details. using System; +using System.ComponentModel; using System.IO; namespace Umbraco.Cms.Core.Configuration.Models @@ -11,24 +12,33 @@ namespace Umbraco.Cms.Core.Configuration.Models /// public class ImagingCacheSettings { + internal const string StaticBrowserMaxAge = "7.00:00:00"; // TimeSpan.FromDays(7); + internal const string StaticCacheMaxAge = "365.00:00:00"; // TimeSpan.FromDays(365); + internal const int StaticCachedNameLength = 8; + internal const string StaticCacheFolder = "../umbraco/mediacache"; + /// /// Gets or sets a value for the browser image cache maximum age. /// - public TimeSpan BrowserMaxAge { get; set; } = TimeSpan.FromDays(7); + [DefaultValue(StaticBrowserMaxAge)] + public TimeSpan BrowserMaxAge { get; set; } = TimeSpan.Parse(StaticBrowserMaxAge); /// /// Gets or sets a value for the image cache maximum age. /// - public TimeSpan CacheMaxAge { get; set; } = TimeSpan.FromDays(365); + [DefaultValue(StaticCacheMaxAge)] + public TimeSpan CacheMaxAge { get; set; } = TimeSpan.Parse(StaticCacheMaxAge); /// /// Gets or sets a value for length of the cached name. /// - public uint CachedNameLength { get; set; } = 8; + [DefaultValue(StaticCachedNameLength)] + public uint CachedNameLength { get; set; } = StaticCachedNameLength; /// /// Gets or sets a value for the cache folder. /// - public string CacheFolder { get; set; } = Path.Combine("..", "umbraco", "mediacache"); + [DefaultValue(StaticCacheFolder)] + public string CacheFolder { get; set; } = StaticCacheFolder; } } diff --git a/src/Umbraco.Core/Configuration/Models/ImagingResizeSettings.cs b/src/Umbraco.Core/Configuration/Models/ImagingResizeSettings.cs index e71ed4f2e4..ff02fdc522 100644 --- a/src/Umbraco.Core/Configuration/Models/ImagingResizeSettings.cs +++ b/src/Umbraco.Core/Configuration/Models/ImagingResizeSettings.cs @@ -1,6 +1,8 @@ // Copyright (c) Umbraco. // See LICENSE for more details. +using System.ComponentModel; + namespace Umbraco.Cms.Core.Configuration.Models { /// @@ -8,14 +10,19 @@ namespace Umbraco.Cms.Core.Configuration.Models /// public class ImagingResizeSettings { + internal const int StaticMaxWidth = 5000; + internal const int StaticMaxHeight = 5000; + /// /// Gets or sets a value for the maximim resize width. /// - public int MaxWidth { get; set; } = 5000; + [DefaultValue(StaticMaxWidth)] + public int MaxWidth { get; set; } = StaticMaxWidth; /// /// Gets or sets a value for the maximim resize height. /// - public int MaxHeight { get; set; } = 5000; + [DefaultValue(StaticMaxHeight)] + public int MaxHeight { get; set; } = StaticMaxHeight; } } diff --git a/src/Umbraco.Core/Configuration/Models/ImagingSettings.cs b/src/Umbraco.Core/Configuration/Models/ImagingSettings.cs index 273e53f384..fde303343c 100644 --- a/src/Umbraco.Core/Configuration/Models/ImagingSettings.cs +++ b/src/Umbraco.Core/Configuration/Models/ImagingSettings.cs @@ -6,6 +6,7 @@ namespace Umbraco.Cms.Core.Configuration.Models /// /// Typed configuration options for imaging settings. /// + [UmbracoOptions(Constants.Configuration.ConfigImaging)] public class ImagingSettings { /// diff --git a/src/Umbraco.Core/Configuration/Models/IndexCreatorSettings.cs b/src/Umbraco.Core/Configuration/Models/IndexCreatorSettings.cs index 52a40b0ee4..c140463b4a 100644 --- a/src/Umbraco.Core/Configuration/Models/IndexCreatorSettings.cs +++ b/src/Umbraco.Core/Configuration/Models/IndexCreatorSettings.cs @@ -8,6 +8,7 @@ namespace Umbraco.Cms.Core.Configuration.Models /// /// Typed configuration options for index creator settings. /// + [UmbracoOptions(Constants.Configuration.ConfigExamine)] public class IndexCreatorSettings { /// diff --git a/src/Umbraco.Core/Configuration/Models/KeepAliveSettings.cs b/src/Umbraco.Core/Configuration/Models/KeepAliveSettings.cs index 898798588c..305df2be8c 100644 --- a/src/Umbraco.Core/Configuration/Models/KeepAliveSettings.cs +++ b/src/Umbraco.Core/Configuration/Models/KeepAliveSettings.cs @@ -1,20 +1,23 @@ // Copyright (c) Umbraco. // See LICENSE for more details. -using System; -using Umbraco.Cms.Core.Hosting; +using System.ComponentModel; namespace Umbraco.Cms.Core.Configuration.Models { /// /// Typed configuration options for keep alive settings. /// + [UmbracoOptions(Constants.Configuration.ConfigKeepAlive)] public class KeepAliveSettings { + internal const bool StaticDisableKeepAliveTask = false; + /// /// Gets or sets a value indicating whether the keep alive task is disabled. /// - public bool DisableKeepAliveTask { get; set; } = false; + [DefaultValue(StaticDisableKeepAliveTask)] + public bool DisableKeepAliveTask { get; set; } = StaticDisableKeepAliveTask; /// /// Gets a value for the keep alive ping URL. diff --git a/src/Umbraco.Core/Configuration/Models/LoggingSettings.cs b/src/Umbraco.Core/Configuration/Models/LoggingSettings.cs index 3f762e7577..2075921c3f 100644 --- a/src/Umbraco.Core/Configuration/Models/LoggingSettings.cs +++ b/src/Umbraco.Core/Configuration/Models/LoggingSettings.cs @@ -2,17 +2,22 @@ // See LICENSE for more details. using System; +using System.ComponentModel; namespace Umbraco.Cms.Core.Configuration.Models { /// /// Typed configuration options for logging settings. /// + [UmbracoOptions(Constants.Configuration.ConfigLogging)] public class LoggingSettings { + internal const string StaticMaxLogAge = "1.00:00:00"; // TimeSpan.FromHours(24); + /// /// Gets or sets a value for the maximum age of a log file. /// - public TimeSpan MaxLogAge { get; set; } = TimeSpan.FromHours(24); + [DefaultValue(StaticMaxLogAge)] + public TimeSpan MaxLogAge { get; set; } = TimeSpan.Parse(StaticMaxLogAge); } } diff --git a/src/Umbraco.Core/Configuration/Models/MemberPasswordConfigurationSettings.cs b/src/Umbraco.Core/Configuration/Models/MemberPasswordConfigurationSettings.cs index 708a7e476d..fa4f0725f7 100644 --- a/src/Umbraco.Core/Configuration/Models/MemberPasswordConfigurationSettings.cs +++ b/src/Umbraco.Core/Configuration/Models/MemberPasswordConfigurationSettings.cs @@ -1,32 +1,49 @@ // Copyright (c) Umbraco. // See LICENSE for more details. +using System.ComponentModel; + namespace Umbraco.Cms.Core.Configuration.Models { /// /// Typed configuration options for member password settings. /// + [UmbracoOptions(Constants.Configuration.ConfigMemberPassword)] public class MemberPasswordConfigurationSettings : IPasswordConfiguration { - /// - public int RequiredLength { get; set; } = 10; + internal const int StaticRequiredLength = 10; + internal const bool StaticRequireNonLetterOrDigit = false; + internal const bool StaticRequireDigit = false; + internal const bool StaticRequireLowercase = false; + internal const bool StaticRequireUppercase = false; + internal const int StaticMaxFailedAccessAttemptsBeforeLockout = 5; /// - public bool RequireNonLetterOrDigit { get; set; } = false; + [DefaultValue(StaticRequiredLength)] + public int RequiredLength { get; set; } = StaticRequiredLength; /// - public bool RequireDigit { get; set; } = false; + [DefaultValue(StaticRequireNonLetterOrDigit)] + public bool RequireNonLetterOrDigit { get; set; } = StaticRequireNonLetterOrDigit; /// - public bool RequireLowercase { get; set; } = false; + [DefaultValue(StaticRequireDigit)] + public bool RequireDigit { get; set; } = StaticRequireDigit; /// - public bool RequireUppercase { get; set; } = false; + [DefaultValue(StaticRequireLowercase)] + public bool RequireLowercase { get; set; } = StaticRequireLowercase; /// + [DefaultValue(StaticRequireUppercase)] + public bool RequireUppercase { get; set; } = StaticRequireUppercase; + + /// + [DefaultValue(Constants.Security.AspNetCoreV3PasswordHashAlgorithmName)] public string HashAlgorithmType { get; set; } = Constants.Security.AspNetCoreV3PasswordHashAlgorithmName; /// - public int MaxFailedAccessAttemptsBeforeLockout { get; set; } = 5; + [DefaultValue(StaticMaxFailedAccessAttemptsBeforeLockout)] + public int MaxFailedAccessAttemptsBeforeLockout { get; set; } = StaticMaxFailedAccessAttemptsBeforeLockout; } } diff --git a/src/Umbraco.Core/Configuration/Models/ModelsBuilderSettings.cs b/src/Umbraco.Core/Configuration/Models/ModelsBuilderSettings.cs index 76e7adc4b4..2cf1f770b7 100644 --- a/src/Umbraco.Core/Configuration/Models/ModelsBuilderSettings.cs +++ b/src/Umbraco.Core/Configuration/Models/ModelsBuilderSettings.cs @@ -1,6 +1,8 @@ // Copyright (c) Umbraco. // See LICENSE for more details. +using System.ComponentModel; +using Umbraco.Cms.Core.Configuration.Models; using Umbraco.Extensions; namespace Umbraco.Cms.Core.Configuration.Models @@ -8,21 +10,26 @@ namespace Umbraco.Cms.Core.Configuration.Models /// /// Typed configuration options for models builder settings. /// + [UmbracoOptions(Constants.Configuration.ConfigModelsBuilder, BindNonPublicProperties = true)] public class ModelsBuilderSettings { private bool _flagOutOfDateModels = true; - - private static string DefaultModelsDirectory => "~/umbraco/models"; + internal const string StaticModelsMode = "InMemoryAuto"; + internal const string StaticModelsDirectory = "~/umbraco/models"; + internal const bool StaticAcceptUnsafeModelsDirectory = false; + internal const int StaticDebugLevel = 0; /// /// Gets or sets a value for the models mode. /// - public ModelsMode ModelsMode { get; set; } = ModelsMode.InMemoryAuto; + [DefaultValue(StaticModelsMode)] + public ModelsMode ModelsMode { get; set; } = Enum.Parse(StaticModelsMode); /// /// Gets or sets a value for models namespace. /// /// That value could be overriden by other (attribute in user's code...). Return default if no value was supplied. + [DefaultValue(Constants.ModelsBuilder.DefaultModelsNamespace)] public string ModelsNamespace { get; set; } = Constants.ModelsBuilder.DefaultModelsNamespace; /// @@ -52,7 +59,8 @@ namespace Umbraco.Cms.Core.Configuration.Models /// Gets or sets a value for the models directory. /// /// Default is ~/umbraco/models but that can be changed. - public string ModelsDirectory { get; set; } = DefaultModelsDirectory; + [DefaultValue(StaticModelsDirectory)] + public string ModelsDirectory { get; set; } = StaticModelsDirectory; /// @@ -62,12 +70,14 @@ namespace Umbraco.Cms.Core.Configuration.Models /// An unsafe value is an absolute path, or a relative path pointing outside /// of the website root. /// - public bool AcceptUnsafeModelsDirectory { get; set; } = false; + [DefaultValue(StaticAcceptUnsafeModelsDirectory)] + public bool AcceptUnsafeModelsDirectory { get; set; } = StaticAcceptUnsafeModelsDirectory; /// /// Gets or sets a value indicating the debug log level. /// /// 0 means minimal (safe on live site), anything else means more and more details (maybe not safe). - public int DebugLevel { get; set; } = 0; + [DefaultValue(StaticDebugLevel)] + public int DebugLevel { get; set; } = StaticDebugLevel; } } diff --git a/src/Umbraco.Core/Configuration/Models/NuCacheSettings.cs b/src/Umbraco.Core/Configuration/Models/NuCacheSettings.cs index 28f8cd8229..bd92b4ba3c 100644 --- a/src/Umbraco.Core/Configuration/Models/NuCacheSettings.cs +++ b/src/Umbraco.Core/Configuration/Models/NuCacheSettings.cs @@ -1,13 +1,19 @@ // Copyright (c) Umbraco. // See LICENSE for more details. +using System.ComponentModel; + namespace Umbraco.Cms.Core.Configuration.Models { /// /// Typed configuration options for NuCache settings. /// + [UmbracoOptions(Constants.Configuration.ConfigNuCache)] public class NuCacheSettings { + internal const string StaticNuCacheSerializerType = "MessagePack"; + internal const int StaticSqlPageSize = 1000; + /// /// Gets or sets a value defining the BTree block size. /// @@ -16,11 +22,13 @@ namespace Umbraco.Cms.Core.Configuration.Models /// /// The serializer type that nucache uses to persist documents in the database. /// - public NuCacheSerializerType NuCacheSerializerType { get; set; } = NuCacheSerializerType.MessagePack; + [DefaultValue(StaticNuCacheSerializerType)] + public NuCacheSerializerType NuCacheSerializerType { get; set; } = Enum.Parse(StaticNuCacheSerializerType); /// /// The paging size to use for nucache SQL queries. /// - public int SqlPageSize { get; set; } = 1000; + [DefaultValue(StaticSqlPageSize)] + public int SqlPageSize { get; set; } = StaticSqlPageSize; } } diff --git a/src/Umbraco.Core/Configuration/Models/RequestHandlerSettings.cs b/src/Umbraco.Core/Configuration/Models/RequestHandlerSettings.cs index 5f5032f7c3..ee223b36c6 100644 --- a/src/Umbraco.Core/Configuration/Models/RequestHandlerSettings.cs +++ b/src/Umbraco.Core/Configuration/Models/RequestHandlerSettings.cs @@ -2,6 +2,7 @@ // See LICENSE for more details. using System.Collections.Generic; +using System.ComponentModel; using Umbraco.Cms.Core.Configuration.UmbracoSettings; using Umbraco.Extensions; @@ -10,8 +11,12 @@ namespace Umbraco.Cms.Core.Configuration.Models /// /// Typed configuration options for request handler settings. /// + [UmbracoOptions(Constants.Configuration.ConfigRequestHandler)] public class RequestHandlerSettings { + internal const bool StaticAddTrailingSlash = true; + internal const string StaticConvertUrlsToAscii = "try"; + internal static readonly CharItem[] DefaultCharCollection = { new CharItem { Char = " ", Replacement = "-" }, @@ -43,12 +48,14 @@ namespace Umbraco.Cms.Core.Configuration.Models /// /// Gets or sets a value indicating whether to add a trailing slash to URLs. /// - public bool AddTrailingSlash { get; set; } = true; + [DefaultValue(StaticAddTrailingSlash)] + public bool AddTrailingSlash { get; set; } = StaticAddTrailingSlash; /// /// Gets or sets a value indicating whether to convert URLs to ASCII (valid values: "true", "try" or "false"). /// - public string ConvertUrlsToAscii { get; set; } = "try"; + [DefaultValue(StaticConvertUrlsToAscii)] + public string ConvertUrlsToAscii { get; set; } = StaticConvertUrlsToAscii; /// /// Gets a value indicating whether URLs should be converted to ASCII. @@ -82,6 +89,7 @@ namespace Umbraco.Cms.Core.Configuration.Models /// /// Gets or sets a value for the default character collection for replacements. /// + /// WB-TODO public IEnumerable CharCollection { get; set; } = DefaultCharCollection; /// diff --git a/src/Umbraco.Core/Configuration/Models/RichTextEditorSettings.cs b/src/Umbraco.Core/Configuration/Models/RichTextEditorSettings.cs index cdd88ca409..6ea563c741 100644 --- a/src/Umbraco.Core/Configuration/Models/RichTextEditorSettings.cs +++ b/src/Umbraco.Core/Configuration/Models/RichTextEditorSettings.cs @@ -1,10 +1,15 @@ -using System.Collections.Generic; +using System.Collections.Generic; +using System.ComponentModel; using Umbraco.Cms.Core.Models.ContentEditing; namespace Umbraco.Cms.Core.Configuration.Models { + [UmbracoOptions(Constants.Configuration.ConfigRichTextEditor)] public class RichTextEditorSettings { + internal const string StaticValidElements = "+a[id|style|rel|data-id|data-udi|rev|charset|hreflang|dir|lang|tabindex|accesskey|type|name|href|target|title|class|onfocus|onblur|onclick|ondblclick|onmousedown|onmouseup|onmouseover|onmousemove|onmouseout|onkeypress|onkeydown|onkeyup],-strong/-b[class|style],-em/-i[class|style],-strike[class|style],-u[class|style],#p[id|style|dir|class|align],-ol[class|reversed|start|style|type],-ul[class|style],-li[class|style],br[class],img[id|dir|lang|longdesc|usemap|style|class|src|onmouseover|onmouseout|border|alt=|title|hspace|vspace|width|height|align|umbracoorgwidth|umbracoorgheight|onresize|onresizestart|onresizeend|rel|data-id],-sub[style|class],-sup[style|class],-blockquote[dir|style|class],-table[border=0|cellspacing|cellpadding|width|height|class|align|summary|style|dir|id|lang|bgcolor|background|bordercolor],-tr[id|lang|dir|class|rowspan|width|height|align|valign|style|bgcolor|background|bordercolor],tbody[id|class],thead[id|class],tfoot[id|class],#td[id|lang|dir|class|colspan|rowspan|width|height|align|valign|style|bgcolor|background|bordercolor|scope],-th[id|lang|dir|class|colspan|rowspan|width|height|align|valign|style|scope],caption[id|lang|dir|class|style],-div[id|dir|class|align|style],-span[class|align|style],-pre[class|align|style],address[class|align|style],-h1[id|dir|class|align|style],-h2[id|dir|class|align|style],-h3[id|dir|class|align|style],-h4[id|dir|class|align|style],-h5[id|dir|class|align|style],-h6[id|style|dir|class|align|style],hr[class|style],small[class|style],dd[id|class|title|style|dir|lang],dl[id|class|title|style|dir|lang],dt[id|class|title|style|dir|lang],object[class|id|width|height|codebase|*],param[name|value|_value|class],embed[type|width|height|src|class|*],map[name|class],area[shape|coords|href|alt|target|class],bdo[class],button[class],iframe[*]"; + internal const string StaticInvalidElements = "font"; + private static readonly string[] s_default_plugins = new[] { "paste", @@ -61,11 +66,34 @@ namespace Umbraco.Cms.Core.Configuration.Models ["entity_encoding"] = "raw" }; + /// + /// HTML RichText Editor TinyMCE Commands + /// + /// WB-TODO Custom Array of objects public RichTextEditorCommand[] Commands { get; set; } = s_default_commands; + + /// + /// HTML RichText Editor TinyMCE Plugins + /// public string[] Plugins { get; set; } = s_default_plugins; + + /// + /// HTML RichText Editor TinyMCE Custom Config + /// + /// WB-TODO Custom Dictionary public IDictionary CustomConfig { get; set; } = s_default_custom_config; - public string ValidElements { get; set; } = "+a[id|style|rel|data-id|data-udi|rev|charset|hreflang|dir|lang|tabindex|accesskey|type|name|href|target|title|class|onfocus|onblur|onclick|ondblclick|onmousedown|onmouseup|onmouseover|onmousemove|onmouseout|onkeypress|onkeydown|onkeyup],-strong/-b[class|style],-em/-i[class|style],-strike[class|style],-u[class|style],#p[id|style|dir|class|align],-ol[class|reversed|start|style|type],-ul[class|style],-li[class|style],br[class],img[id|dir|lang|longdesc|usemap|style|class|src|onmouseover|onmouseout|border|alt=|title|hspace|vspace|width|height|align|umbracoorgwidth|umbracoorgheight|onresize|onresizestart|onresizeend|rel|data-id],-sub[style|class],-sup[style|class],-blockquote[dir|style|class],-table[border=0|cellspacing|cellpadding|width|height|class|align|summary|style|dir|id|lang|bgcolor|background|bordercolor],-tr[id|lang|dir|class|rowspan|width|height|align|valign|style|bgcolor|background|bordercolor],tbody[id|class],thead[id|class],tfoot[id|class],#td[id|lang|dir|class|colspan|rowspan|width|height|align|valign|style|bgcolor|background|bordercolor|scope],-th[id|lang|dir|class|colspan|rowspan|width|height|align|valign|style|scope],caption[id|lang|dir|class|style],-div[id|dir|class|align|style],-span[class|align|style],-pre[class|align|style],address[class|align|style],-h1[id|dir|class|align|style],-h2[id|dir|class|align|style],-h3[id|dir|class|align|style],-h4[id|dir|class|align|style],-h5[id|dir|class|align|style],-h6[id|style|dir|class|align|style],hr[class|style],small[class|style],dd[id|class|title|style|dir|lang],dl[id|class|title|style|dir|lang],dt[id|class|title|style|dir|lang],object[class|id|width|height|codebase|*],param[name|value|_value|class],embed[type|width|height|src|class|*],map[name|class],area[shape|coords|href|alt|target|class],bdo[class],button[class],iframe[*]"; - public string InvalidElements { get; set; } = "font"; + + /// + /// + /// + [DefaultValue(StaticValidElements)] + public string ValidElements { get; set; } = StaticValidElements; + + /// + /// Invalid HTML elements for RichText Editor + /// + [DefaultValue(StaticInvalidElements)] + public string InvalidElements { get; set; } = StaticInvalidElements; public class RichTextEditorCommand { diff --git a/src/Umbraco.Core/Configuration/Models/RuntimeMinificationSettings.cs b/src/Umbraco.Core/Configuration/Models/RuntimeMinificationSettings.cs index fa3519059a..b03528fd0a 100644 --- a/src/Umbraco.Core/Configuration/Models/RuntimeMinificationSettings.cs +++ b/src/Umbraco.Core/Configuration/Models/RuntimeMinificationSettings.cs @@ -1,16 +1,23 @@ -using System; -using System.Collections.Generic; -using System.Text; +using System.ComponentModel; namespace Umbraco.Cms.Core.Configuration.Models { + [UmbracoOptions(Constants.Configuration.ConfigRuntimeMinification)] public class RuntimeMinificationSettings { - public bool UseInMemoryCache { get; set; } = false; + internal const bool StaticUseInMemoryCache = false; + internal const string StaticCacheBuster = "Version"; + + /// + /// Use in memory cache + /// + [DefaultValue(StaticUseInMemoryCache)] + public bool UseInMemoryCache { get; set; } = StaticUseInMemoryCache; /// /// The cache buster type to use /// - public RuntimeMinificationCacheBuster CacheBuster { get; set; } = RuntimeMinificationCacheBuster.Version; + [DefaultValue(StaticCacheBuster)] + public RuntimeMinificationCacheBuster CacheBuster { get; set; } = Enum.Parse(StaticCacheBuster); } } diff --git a/src/Umbraco.Core/Configuration/Models/RuntimeSettings.cs b/src/Umbraco.Core/Configuration/Models/RuntimeSettings.cs index c598dfb86b..64625f153b 100644 --- a/src/Umbraco.Core/Configuration/Models/RuntimeSettings.cs +++ b/src/Umbraco.Core/Configuration/Models/RuntimeSettings.cs @@ -6,6 +6,7 @@ namespace Umbraco.Cms.Core.Configuration.Models /// /// Typed configuration options for runtime settings. /// + [UmbracoOptions(Constants.Configuration.ConfigRuntime)] public class RuntimeSettings { /// diff --git a/src/Umbraco.Core/Configuration/Models/SecuritySettings.cs b/src/Umbraco.Core/Configuration/Models/SecuritySettings.cs index a20e42ed08..48e08d596a 100644 --- a/src/Umbraco.Core/Configuration/Models/SecuritySettings.cs +++ b/src/Umbraco.Core/Configuration/Models/SecuritySettings.cs @@ -1,32 +1,44 @@ // Copyright (c) Umbraco. // See LICENSE for more details. +using System.ComponentModel; + namespace Umbraco.Cms.Core.Configuration.Models { /// /// Typed configuration options for security settings. /// + [UmbracoOptions(Constants.Configuration.ConfigSecurity)] public class SecuritySettings { + internal const bool StaticKeepUserLoggedIn = false; + internal const bool StaticHideDisabledUsersInBackOffice = false; + internal const bool StaticAllowPasswordReset = true; + internal const string StaticAuthCookieName = "UMB_UCONTEXT"; + /// /// Gets or sets a value indicating whether to keep the user logged in. /// - public bool KeepUserLoggedIn { get; set; } = false; + [DefaultValue(StaticKeepUserLoggedIn)] + public bool KeepUserLoggedIn { get; set; } = StaticKeepUserLoggedIn; /// /// Gets or sets a value indicating whether to hide disabled users in the back-office. /// - public bool HideDisabledUsersInBackOffice { get; set; } = false; + [DefaultValue(StaticHideDisabledUsersInBackOffice)] + public bool HideDisabledUsersInBackOffice { get; set; } = StaticHideDisabledUsersInBackOffice; /// /// Gets or sets a value indicating whether to allow user password reset. /// - public bool AllowPasswordReset { get; set; } = true; + [DefaultValue(StaticAllowPasswordReset)] + public bool AllowPasswordReset { get; set; } = StaticAllowPasswordReset; /// /// Gets or sets a value for the authorization cookie name. /// - public string AuthCookieName { get; set; } = "UMB_UCONTEXT"; + [DefaultValue(StaticAuthCookieName)] + public string AuthCookieName { get; set; } = StaticAuthCookieName; /// /// Gets or sets a value for the authorization cookie domain. diff --git a/src/Umbraco.Core/Configuration/Models/SmtpSettings.cs b/src/Umbraco.Core/Configuration/Models/SmtpSettings.cs index 9ad22abaeb..dca2b70558 100644 --- a/src/Umbraco.Core/Configuration/Models/SmtpSettings.cs +++ b/src/Umbraco.Core/Configuration/Models/SmtpSettings.cs @@ -1,6 +1,7 @@ // Copyright (c) Umbraco. // See LICENSE for more details. +using System.ComponentModel; using System.ComponentModel.DataAnnotations; using System.Net.Mail; using Umbraco.Cms.Core.Configuration.Models.Validation; @@ -10,8 +11,8 @@ namespace Umbraco.Cms.Core.Configuration.Models /// /// Matches MailKit.Security.SecureSocketOptions and defined locally to avoid having to take /// a dependency on this external library into Umbraco.Core. - /// See: http://www.mimekit.net/docs/html/T_MailKit_Security_SecureSocketOptions.htm /// + /// public enum SecureSocketOptions { /// @@ -45,6 +46,9 @@ namespace Umbraco.Cms.Core.Configuration.Models /// public class SmtpSettings : ValidatableEntryBase { + internal const string StaticSecureSocketOptions = "Auto"; + internal const string StaticDeliveryMethod = "Network"; + /// /// Gets or sets a value for the SMTP from address to use for messages. /// @@ -65,7 +69,8 @@ namespace Umbraco.Cms.Core.Configuration.Models /// /// Gets or sets a value for the secure socket options. /// - public SecureSocketOptions SecureSocketOptions { get; set; } = SecureSocketOptions.Auto; + [DefaultValue(StaticSecureSocketOptions)] + public SecureSocketOptions SecureSocketOptions { get; set; } = Enum.Parse(StaticSecureSocketOptions); /// /// Gets or sets a value for the SMTP pick-up directory. @@ -75,7 +80,8 @@ namespace Umbraco.Cms.Core.Configuration.Models /// /// Gets or sets a value for the SMTP delivery method. /// - public SmtpDeliveryMethod DeliveryMethod { get; set; } = SmtpDeliveryMethod.Network; + [DefaultValue(StaticDeliveryMethod)] + public SmtpDeliveryMethod DeliveryMethod { get; set; } = Enum.Parse(StaticDeliveryMethod); /// /// Gets or sets a value for the SMTP user name. diff --git a/src/Umbraco.Core/Configuration/Models/TourSettings.cs b/src/Umbraco.Core/Configuration/Models/TourSettings.cs index c61c2316b7..cdc54dfe1f 100644 --- a/src/Umbraco.Core/Configuration/Models/TourSettings.cs +++ b/src/Umbraco.Core/Configuration/Models/TourSettings.cs @@ -1,16 +1,22 @@ // Copyright (c) Umbraco. // See LICENSE for more details. +using System.ComponentModel; + namespace Umbraco.Cms.Core.Configuration.Models { /// /// Typed configuration options for tour settings. /// + [UmbracoOptions(Constants.Configuration.ConfigTours)] public class TourSettings { + internal const bool StaticEnableTours = true; + /// /// Gets or sets a value indicating whether back-office tours are enabled. /// - public bool EnableTours { get; set; } = true; + [DefaultValue(StaticEnableTours)] + public bool EnableTours { get; set; } = StaticEnableTours; } } diff --git a/src/Umbraco.Core/Configuration/Models/TypeFinderSettings.cs b/src/Umbraco.Core/Configuration/Models/TypeFinderSettings.cs index 9c8fc2b9d3..d942f47b4f 100644 --- a/src/Umbraco.Core/Configuration/Models/TypeFinderSettings.cs +++ b/src/Umbraco.Core/Configuration/Models/TypeFinderSettings.cs @@ -6,6 +6,7 @@ namespace Umbraco.Cms.Core.Configuration.Models /// /// Typed configuration options for type finder settings. /// + [UmbracoOptions(Constants.Configuration.ConfigTypeFinder)] public class TypeFinderSettings { /// diff --git a/src/Umbraco.Core/Configuration/Models/UmbracoPluginSettings.cs b/src/Umbraco.Core/Configuration/Models/UmbracoPluginSettings.cs index 6dcad67ce2..d5b74b38dc 100644 --- a/src/Umbraco.Core/Configuration/Models/UmbracoPluginSettings.cs +++ b/src/Umbraco.Core/Configuration/Models/UmbracoPluginSettings.cs @@ -1,4 +1,4 @@ -// Copyright (c) Umbraco. +// Copyright (c) Umbraco. // See LICENSE for more details. using System.Collections.Generic; @@ -8,11 +8,15 @@ namespace Umbraco.Cms.Core.Configuration.Models /// /// Typed configuration options for the plugins. /// + [UmbracoOptions(Constants.Configuration.ConfigPlugins)] public class UmbracoPluginSettings { + + /// /// Gets or sets the allowed file extensions (including the period ".") that should be accessible from the browser. /// + /// WB-TODO public ISet BrowsableFileExtensions { get; set; } = new HashSet(new[] { ".html", // markup diff --git a/src/Umbraco.Core/Configuration/Models/UnattendedSettings.cs b/src/Umbraco.Core/Configuration/Models/UnattendedSettings.cs index 34af683fbe..08020f6e89 100644 --- a/src/Umbraco.Core/Configuration/Models/UnattendedSettings.cs +++ b/src/Umbraco.Core/Configuration/Models/UnattendedSettings.cs @@ -1,3 +1,4 @@ +using System.ComponentModel; using System.ComponentModel.DataAnnotations; namespace Umbraco.Cms.Core.Configuration.Models @@ -6,8 +7,12 @@ namespace Umbraco.Cms.Core.Configuration.Models /// /// Typed configuration options for unattended settings. /// + [UmbracoOptions(Constants.Configuration.ConfigUnattended)] public class UnattendedSettings { + internal const bool StaticInstallUnattended = false; + internal const bool StaticUpgradeUnattended = false; + /// /// Gets or sets a value indicating whether unattended installs are enabled. /// @@ -17,12 +22,14 @@ namespace Umbraco.Cms.Core.Configuration.Models /// If this option is set to true an unattended install will be performed and the runtime enters /// the Run level. /// - public bool InstallUnattended { get; set; } = false; + [DefaultValue(StaticInstallUnattended)] + public bool InstallUnattended { get; set; } = StaticInstallUnattended; /// /// Gets or sets a value indicating whether unattended upgrades are enabled. /// - public bool UpgradeUnattended { get; set; } = false; + [DefaultValue(StaticUpgradeUnattended)] + public bool UpgradeUnattended { get; set; } = StaticUpgradeUnattended; /// /// Gets or sets a value indicating whether unattended package migrations are enabled. diff --git a/src/Umbraco.Core/Configuration/Models/UserPasswordConfigurationSettings.cs b/src/Umbraco.Core/Configuration/Models/UserPasswordConfigurationSettings.cs index f609181460..b53e98f712 100644 --- a/src/Umbraco.Core/Configuration/Models/UserPasswordConfigurationSettings.cs +++ b/src/Umbraco.Core/Configuration/Models/UserPasswordConfigurationSettings.cs @@ -1,32 +1,49 @@ // Copyright (c) Umbraco. // See LICENSE for more details. +using System.ComponentModel; + namespace Umbraco.Cms.Core.Configuration.Models { /// /// Typed configuration options for user password settings. /// + [UmbracoOptions(Constants.Configuration.ConfigUserPassword)] public class UserPasswordConfigurationSettings : IPasswordConfiguration { - /// - public int RequiredLength { get; set; } = 10; + internal const int StaticRequiredLength = 10; + internal const bool StaticRequireNonLetterOrDigit = false; + internal const bool StaticRequireDigit = false; + internal const bool StaticRequireLowercase = false; + internal const bool StaticRequireUppercase = false; + internal const int StaticMaxFailedAccessAttemptsBeforeLockout = 5; /// - public bool RequireNonLetterOrDigit { get; set; } = false; + [DefaultValue(StaticRequiredLength)] + public int RequiredLength { get; set; } = StaticRequiredLength; /// - public bool RequireDigit { get; set; } = false; + [DefaultValue(StaticRequireNonLetterOrDigit)] + public bool RequireNonLetterOrDigit { get; set; } = StaticRequireNonLetterOrDigit; /// - public bool RequireLowercase { get; set; } = false; + [DefaultValue(StaticRequireDigit)] + public bool RequireDigit { get; set; } = StaticRequireDigit; /// - public bool RequireUppercase { get; set; } = false; + [DefaultValue(StaticRequireLowercase)] + public bool RequireLowercase { get; set; } = StaticRequireLowercase; /// + [DefaultValue(StaticRequireUppercase)] + public bool RequireUppercase { get; set; } = StaticRequireUppercase; + + /// + [DefaultValue(Constants.Security.AspNetCoreV3PasswordHashAlgorithmName)] public string HashAlgorithmType { get; set; } = Constants.Security.AspNetCoreV3PasswordHashAlgorithmName; /// - public int MaxFailedAccessAttemptsBeforeLockout { get; set; } = 5; + [DefaultValue(StaticMaxFailedAccessAttemptsBeforeLockout)] + public int MaxFailedAccessAttemptsBeforeLockout { get; set; } = StaticMaxFailedAccessAttemptsBeforeLockout; } } diff --git a/src/Umbraco.Core/Configuration/Models/WebRoutingSettings.cs b/src/Umbraco.Core/Configuration/Models/WebRoutingSettings.cs index 2fe33603ca..629095e32c 100644 --- a/src/Umbraco.Core/Configuration/Models/WebRoutingSettings.cs +++ b/src/Umbraco.Core/Configuration/Models/WebRoutingSettings.cs @@ -1,6 +1,7 @@ // Copyright (c) Umbraco. // See LICENSE for more details. +using System.ComponentModel; using Umbraco.Cms.Core.Models.PublishedContent; namespace Umbraco.Cms.Core.Configuration.Models @@ -8,8 +9,19 @@ namespace Umbraco.Cms.Core.Configuration.Models /// /// Typed configuration options for web routing settings. /// + [UmbracoOptions(Constants.Configuration.ConfigWebRouting)] public class WebRoutingSettings { + + internal const bool StaticTryMatchingEndpointsForAllPages = false; + internal const bool StaticTrySkipIisCustomErrors = false; + internal const bool StaticInternalRedirectPreservesTemplate = false; + internal const bool StaticDisableAlternativeTemplates = false; + internal const bool StaticValidateAlternativeTemplates = false; + internal const bool StaticDisableFindContentByIdPath = false; + internal const bool StaticDisableRedirectUrlTracking = false; + internal const string StaticUrlProviderMode = "Auto"; + /// /// Gets or sets a value indicating whether to check if any routed endpoints match a front-end request before /// the Umbraco dynamic router tries to map the request to an Umbraco content item. @@ -19,42 +31,50 @@ namespace Umbraco.Cms.Core.Configuration.Models /// ASP.NET Core will automatically handle this in all cases. This is more of a backward compatible option since this is what v7/v8 used /// to do. /// - public bool TryMatchingEndpointsForAllPages { get; set; } = false; + [DefaultValue(StaticTryMatchingEndpointsForAllPages)] + public bool TryMatchingEndpointsForAllPages { get; set; } = StaticTryMatchingEndpointsForAllPages; /// /// Gets or sets a value indicating whether IIS custom errors should be skipped. /// - public bool TrySkipIisCustomErrors { get; set; } = false; + [DefaultValue(StaticTrySkipIisCustomErrors)] + public bool TrySkipIisCustomErrors { get; set; } = StaticTrySkipIisCustomErrors; /// /// Gets or sets a value indicating whether an internal redirect should preserve the template. /// - public bool InternalRedirectPreservesTemplate { get; set; } = false; + [DefaultValue(StaticInternalRedirectPreservesTemplate)] + public bool InternalRedirectPreservesTemplate { get; set; } = StaticInternalRedirectPreservesTemplate; /// /// Gets or sets a value indicating whether the use of alternative templates are disabled. /// - public bool DisableAlternativeTemplates { get; set; } = false; + [DefaultValue(StaticDisableAlternativeTemplates)] + public bool DisableAlternativeTemplates { get; set; } = StaticDisableAlternativeTemplates; /// /// Gets or sets a value indicating whether the use of alternative templates should be validated. /// - public bool ValidateAlternativeTemplates { get; set; } = false; + [DefaultValue(StaticValidateAlternativeTemplates)] + public bool ValidateAlternativeTemplates { get; set; } = StaticValidateAlternativeTemplates; /// /// Gets or sets a value indicating whether find content ID by path is disabled. /// - public bool DisableFindContentByIdPath { get; set; } = false; + [DefaultValue(StaticDisableFindContentByIdPath)] + public bool DisableFindContentByIdPath { get; set; } = StaticDisableFindContentByIdPath; /// /// Gets or sets a value indicating whether redirect URL tracking is disabled. /// - public bool DisableRedirectUrlTracking { get; set; } = false; + [DefaultValue(StaticDisableRedirectUrlTracking)] + public bool DisableRedirectUrlTracking { get; set; } = StaticDisableRedirectUrlTracking; /// /// Gets or sets a value for the URL provider mode (). /// - public UrlMode UrlProviderMode { get; set; } = UrlMode.Auto; + [DefaultValue(StaticUrlProviderMode)] + public UrlMode UrlProviderMode { get; set; } = Enum.Parse(StaticUrlProviderMode); /// /// Gets or sets a value for the Umbraco application URL. diff --git a/src/Umbraco.Core/DependencyInjection/UmbracoBuilder.Configuration.cs b/src/Umbraco.Core/DependencyInjection/UmbracoBuilder.Configuration.cs index bd834a5427..b5edfdf818 100644 --- a/src/Umbraco.Core/DependencyInjection/UmbracoBuilder.Configuration.cs +++ b/src/Umbraco.Core/DependencyInjection/UmbracoBuilder.Configuration.cs @@ -1,3 +1,5 @@ +using System; +using System.Reflection; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Options; using Umbraco.Cms.Core.Configuration.Models; @@ -11,12 +13,25 @@ namespace Umbraco.Cms.Core.DependencyInjection public static partial class UmbracoBuilderExtensions { - private static OptionsBuilder AddOptions(IUmbracoBuilder builder, string key) + private static IUmbracoBuilder AddUmbracoOptions(this IUmbracoBuilder builder) where TOptions : class - => builder.Services.AddOptions() - .Bind(builder.Config.GetSection(key)) + { + var umbracoOptionsAttribute = typeof(TOptions).GetCustomAttribute(); + + if (umbracoOptionsAttribute is null) + { + throw new ArgumentException("typeof(TOptions) do not have the UmbracoOptionsAttribute"); + } + + + builder.Services.AddOptions() + .Bind(builder.Config.GetSection(umbracoOptionsAttribute.ConfigurationKey), + o => o.BindNonPublicProperties = umbracoOptionsAttribute.BindNonPublicProperties) .ValidateDataAnnotations(); + return builder; + } + /// /// Add Umbraco configuration services and options /// @@ -30,34 +45,33 @@ namespace Umbraco.Cms.Core.DependencyInjection builder.Services.AddSingleton, UnattendedSettingsValidator>(); // Register configuration sections. - - builder.Services.Configure(builder.Config.GetSection(Constants.Configuration.ConfigModelsBuilder), o => o.BindNonPublicProperties = true); - builder.Services.Configure(builder.Config.GetSection("ConnectionStrings"), o => o.BindNonPublicProperties = true); - - AddOptions(builder, Constants.Configuration.ConfigActiveDirectory); - AddOptions(builder, Constants.Configuration.ConfigContent); - AddOptions(builder, Constants.Configuration.ConfigCoreDebug); - AddOptions(builder, Constants.Configuration.ConfigExceptionFilter); - AddOptions(builder, Constants.Configuration.ConfigGlobal); - AddOptions(builder, Constants.Configuration.ConfigHealthChecks); - AddOptions(builder, Constants.Configuration.ConfigHosting); - AddOptions(builder, Constants.Configuration.ConfigImaging); - AddOptions(builder, Constants.Configuration.ConfigExamine); - AddOptions(builder, Constants.Configuration.ConfigKeepAlive); - AddOptions(builder, Constants.Configuration.ConfigLogging); - AddOptions(builder, Constants.Configuration.ConfigMemberPassword); - AddOptions(builder, Constants.Configuration.ConfigNuCache); - AddOptions(builder, Constants.Configuration.ConfigRequestHandler); - AddOptions(builder, Constants.Configuration.ConfigRuntime); - AddOptions(builder, Constants.Configuration.ConfigSecurity); - AddOptions(builder, Constants.Configuration.ConfigTours); - AddOptions(builder, Constants.Configuration.ConfigTypeFinder); - AddOptions(builder, Constants.Configuration.ConfigUserPassword); - AddOptions(builder, Constants.Configuration.ConfigWebRouting); - AddOptions(builder, Constants.Configuration.ConfigPlugins); - AddOptions(builder, Constants.Configuration.ConfigUnattended); - AddOptions(builder, Constants.Configuration.ConfigRichTextEditor); - AddOptions(builder, Constants.Configuration.ConfigRuntimeMinification); + builder + .AddUmbracoOptions() + .AddUmbracoOptions() + .AddUmbracoOptions() + .AddUmbracoOptions() + .AddUmbracoOptions() + .AddUmbracoOptions() + .AddUmbracoOptions() + .AddUmbracoOptions() + .AddUmbracoOptions() + .AddUmbracoOptions() + .AddUmbracoOptions() + .AddUmbracoOptions() + .AddUmbracoOptions() + .AddUmbracoOptions() + .AddUmbracoOptions() + .AddUmbracoOptions() + .AddUmbracoOptions() + .AddUmbracoOptions() + .AddUmbracoOptions() + .AddUmbracoOptions() + .AddUmbracoOptions() + .AddUmbracoOptions() + .AddUmbracoOptions() + .AddUmbracoOptions() + .AddUmbracoOptions() + .AddUmbracoOptions(); return builder; } diff --git a/src/Umbraco.Core/Umbraco.Core.csproj b/src/Umbraco.Core/Umbraco.Core.csproj index 79ddbf201c..2a30778d80 100644 --- a/src/Umbraco.Core/Umbraco.Core.csproj +++ b/src/Umbraco.Core/Umbraco.Core.csproj @@ -8,6 +8,7 @@ Umbraco CMS Core Contains the core assembly needed to run Umbraco Cms. This package only contains the assembly, and can be used for package development. Use the template in the Umbraco.Templates package to setup Umbraco Umbraco CMS + diff --git a/src/Umbraco.PublishedCache.NuCache/ContentCache.cs b/src/Umbraco.PublishedCache.NuCache/ContentCache.cs index 5428279655..f26b53775f 100644 --- a/src/Umbraco.PublishedCache.NuCache/ContentCache.cs +++ b/src/Umbraco.PublishedCache.NuCache/ContentCache.cs @@ -17,7 +17,7 @@ using Constants = Umbraco.Cms.Core.Constants; namespace Umbraco.Cms.Infrastructure.PublishedCache { - internal class ContentCache : PublishedCacheBase, IPublishedContentCache, INavigableData, IDisposable + public class ContentCache : PublishedCacheBase, IPublishedContentCache, INavigableData, IDisposable { private readonly ContentStore.Snapshot _snapshot; private readonly IAppCache _snapshotCache; diff --git a/src/Umbraco.PublishedCache.NuCache/DomainCache.cs b/src/Umbraco.PublishedCache.NuCache/DomainCache.cs index e957efdbcc..1d389294f9 100644 --- a/src/Umbraco.PublishedCache.NuCache/DomainCache.cs +++ b/src/Umbraco.PublishedCache.NuCache/DomainCache.cs @@ -8,7 +8,7 @@ namespace Umbraco.Cms.Infrastructure.PublishedCache /// /// Implements for NuCache. /// - internal class DomainCache : IDomainCache + public class DomainCache : IDomainCache { private readonly SnapDictionary.Snapshot _snapshot; diff --git a/src/Umbraco.PublishedCache.NuCache/MemberCache.cs b/src/Umbraco.PublishedCache.NuCache/MemberCache.cs index 98e510966a..2eca1515f6 100644 --- a/src/Umbraco.PublishedCache.NuCache/MemberCache.cs +++ b/src/Umbraco.PublishedCache.NuCache/MemberCache.cs @@ -4,7 +4,7 @@ using Umbraco.Cms.Core.PublishedCache; namespace Umbraco.Cms.Infrastructure.PublishedCache { - internal class MemberCache : IPublishedMemberCache + public class MemberCache : IPublishedMemberCache { private readonly IPublishedSnapshotAccessor _publishedSnapshotAccessor; private readonly IVariationContextAccessor _variationContextAccessor; diff --git a/src/Umbraco.PublishedCache.NuCache/PublishedSnapshot.cs b/src/Umbraco.PublishedCache.NuCache/PublishedSnapshot.cs index fc4c64d552..f2d54759c5 100644 --- a/src/Umbraco.PublishedCache.NuCache/PublishedSnapshot.cs +++ b/src/Umbraco.PublishedCache.NuCache/PublishedSnapshot.cs @@ -6,7 +6,7 @@ using Umbraco.Cms.Core.PublishedCache; namespace Umbraco.Cms.Infrastructure.PublishedCache { // implements published snapshot - internal class PublishedSnapshot : IPublishedSnapshot, IDisposable + public class PublishedSnapshot : IPublishedSnapshot, IDisposable { private readonly PublishedSnapshotService _service; private bool _defaultPreview; diff --git a/src/Umbraco.PublishedCache.NuCache/SnapDictionary.cs b/src/Umbraco.PublishedCache.NuCache/SnapDictionary.cs index 192eb65768..bd250027bb 100644 --- a/src/Umbraco.PublishedCache.NuCache/SnapDictionary.cs +++ b/src/Umbraco.PublishedCache.NuCache/SnapDictionary.cs @@ -10,7 +10,7 @@ using Umbraco.Cms.Infrastructure.PublishedCache.Snap; namespace Umbraco.Cms.Infrastructure.PublishedCache { - internal class SnapDictionary + public class SnapDictionary where TValue : class { // read diff --git a/src/Umbraco.Web.Common/Controllers/UmbracoAuthorizedController.cs b/src/Umbraco.Web.Common/Controllers/UmbracoAuthorizedController.cs new file mode 100644 index 0000000000..b949eef8bf --- /dev/null +++ b/src/Umbraco.Web.Common/Controllers/UmbracoAuthorizedController.cs @@ -0,0 +1,16 @@ +using Microsoft.AspNetCore.Authorization; +using Microsoft.AspNetCore.Mvc; +using Umbraco.Cms.Web.Common.Authorization; +using Umbraco.Cms.Web.Common.Filters; + +namespace Umbraco.Cms.Web.Common.Controllers +{ + /// + /// Provides a base class for backoffice authorized controllers. + /// + [Authorize(Policy = AuthorizationPolicies.BackOfficeAccess)] + [DisableBrowserCache] + public abstract class UmbracoAuthorizedController : ControllerBase + { + } +} diff --git a/src/Umbraco.Web.UI.NetCore/Umbraco.Web.UI.NetCore.csproj b/src/Umbraco.Web.UI.NetCore/Umbraco.Web.UI.NetCore.csproj index 1276e9137a..0b345753d0 100644 --- a/src/Umbraco.Web.UI.NetCore/Umbraco.Web.UI.NetCore.csproj +++ b/src/Umbraco.Web.UI.NetCore/Umbraco.Web.UI.NetCore.csproj @@ -27,8 +27,8 @@ - - + + @@ -36,14 +36,14 @@ - + - + @@ -60,7 +60,7 @@ - + @@ -81,5 +81,46 @@ false false + + + $(ProjectDir)wwwroot\umbraco + $(ProjectDir)umbraco\config\appsettings-schema.json + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/Umbraco.Web.UI.NetCore/appsettings.Development.json b/src/Umbraco.Web.UI.NetCore/appsettings.Development.json index 8888a522f4..9cac2c3dd9 100644 --- a/src/Umbraco.Web.UI.NetCore/appsettings.Development.json +++ b/src/Umbraco.Web.UI.NetCore/appsettings.Development.json @@ -1,4 +1,5 @@ { + "$schema" : "./umbraco/config/appsettings-schema.json", "Serilog": { "MinimumLevel": { "Default": "Information", @@ -54,6 +55,5 @@ ] } } - } } diff --git a/src/Umbraco.Web.UI.NetCore/appsettings.json b/src/Umbraco.Web.UI.NetCore/appsettings.json index 1e2d97a018..8fe1993bcb 100644 --- a/src/Umbraco.Web.UI.NetCore/appsettings.json +++ b/src/Umbraco.Web.UI.NetCore/appsettings.json @@ -1,4 +1,5 @@ { + "$schema" : "./umbraco/config/appsettings-schema.json", "ConnectionStrings": { "umbracoDbDSN": "" }, @@ -71,4 +72,4 @@ } } } -} \ No newline at end of file +} diff --git a/src/Umbraco.Web.UI/Umbraco.Web.UI.csproj b/src/Umbraco.Web.UI/Umbraco.Web.UI.csproj index a05b7a4250..a9940193f7 100644 --- a/src/Umbraco.Web.UI/Umbraco.Web.UI.csproj +++ b/src/Umbraco.Web.UI/Umbraco.Web.UI.csproj @@ -100,7 +100,7 @@ all - + 3.5.3 runtime; build; native; contentfiles; analyzers @@ -213,7 +213,7 @@ $(MSBuildExtensionsPath)\Microsoft\VisualStudio\v14.0\Web\Microsoft.Web.Publishing.Tasks.dll $(MSBuildExtensionsPath)\Microsoft\VisualStudio\v15.0\Web\Microsoft.Web.Publishing.Tasks.dll $(MSBuildExtensionsPath)\Microsoft\VisualStudio\v16.0\Web\Microsoft.Web.Publishing.Tasks.dll - $(MSBuildExtensionsPath)\Microsoft\VisualStudio\v17.0\Web\Microsoft.Web.Publishing.Tasks.dll + $(MSBuildExtensionsPath)\Microsoft\VisualStudio\v17.0\Web\Microsoft.Web.Publishing.Tasks.dll $(MSBuildExtensionsPath)\Microsoft\VisualStudio\v17.0\Web\Microsoft.Web.Publishing.Tasks.dll diff --git a/src/Umbraco.Web/PublishedCache/NuCache/DataSource/IContentCacheDataSerializer.cs b/src/Umbraco.Web/PublishedCache/NuCache/DataSource/IContentCacheDataSerializer.cs index d1a83d8452..6e68146526 100644 --- a/src/Umbraco.Web/PublishedCache/NuCache/DataSource/IContentCacheDataSerializer.cs +++ b/src/Umbraco.Web/PublishedCache/NuCache/DataSource/IContentCacheDataSerializer.cs @@ -1,4 +1,6 @@ -using Umbraco.Core.Models; +using Umbraco.Cms.Core.Models; +using Umbraco.Cms.Infrastructure.PublishedCache.DataSource; +using Umbraco.Core.Models; namespace Umbraco.Web.PublishedCache.NuCache.DataSource { @@ -17,7 +19,7 @@ namespace Umbraco.Web.PublishedCache.NuCache.DataSource ContentCacheDataModel Deserialize(IReadOnlyContentBase content, string stringData, byte[] byteData); /// - /// Serializes the + /// Serializes the /// ContentCacheDataSerializationResult Serialize(IReadOnlyContentBase content, ContentCacheDataModel model); } diff --git a/src/Umbraco.Web/PublishedCache/NuCache/DataSource/IDictionaryOfPropertyDataSerializer.cs b/src/Umbraco.Web/PublishedCache/NuCache/DataSource/IDictionaryOfPropertyDataSerializer.cs index a086e3e2f3..e31aec201f 100644 --- a/src/Umbraco.Web/PublishedCache/NuCache/DataSource/IDictionaryOfPropertyDataSerializer.cs +++ b/src/Umbraco.Web/PublishedCache/NuCache/DataSource/IDictionaryOfPropertyDataSerializer.cs @@ -1,5 +1,6 @@ using System.Collections.Generic; using System.IO; +using Umbraco.Cms.Infrastructure.PublishedCache.DataSource; namespace Umbraco.Web.PublishedCache.NuCache.DataSource { @@ -8,4 +9,4 @@ namespace Umbraco.Web.PublishedCache.NuCache.DataSource IDictionary ReadFrom(Stream stream); void WriteTo(IDictionary value, Stream stream); } -} \ No newline at end of file +} diff --git a/src/Umbraco.Web/PublishedCache/NuCache/DataSource/JsonContentNestedDataSerializer.cs b/src/Umbraco.Web/PublishedCache/NuCache/DataSource/JsonContentNestedDataSerializer.cs index 21cd0bf763..7a8e038ac9 100644 --- a/src/Umbraco.Web/PublishedCache/NuCache/DataSource/JsonContentNestedDataSerializer.cs +++ b/src/Umbraco.Web/PublishedCache/NuCache/DataSource/JsonContentNestedDataSerializer.cs @@ -3,8 +3,10 @@ using System; using System.Buffers; using System.Collections.Generic; using System.IO; -using Umbraco.Core.Models; -using Umbraco.Core.Serialization; +using Umbraco.Cms.Core.Models; +using Umbraco.Cms.Infrastructure.PublishedCache.DataSource; +using Umbraco.Cms.Infrastructure.Serialization; + namespace Umbraco.Web.PublishedCache.NuCache.DataSource { @@ -24,6 +26,7 @@ namespace Umbraco.Web.PublishedCache.NuCache.DataSource DateFormatString = "o" }; private readonly JsonNameTable _propertyNameTable = new DefaultJsonNameTable(); + public ContentCacheDataModel Deserialize(IReadOnlyContentBase content, string stringData, byte[] byteData) { if (stringData == null && byteData != null) @@ -39,6 +42,7 @@ namespace Umbraco.Web.PublishedCache.NuCache.DataSource } } + public ContentCacheDataSerializationResult Serialize(IReadOnlyContentBase content, ContentCacheDataModel model) { // note that numeric values (which are Int32) are serialized without their diff --git a/src/Umbraco.Web/PublishedCache/NuCache/DataSource/LazyCompressedString.cs b/src/Umbraco.Web/PublishedCache/NuCache/DataSource/LazyCompressedString.cs index 2be2568f7e..67248b2cce 100644 --- a/src/Umbraco.Web/PublishedCache/NuCache/DataSource/LazyCompressedString.cs +++ b/src/Umbraco.Web/PublishedCache/NuCache/DataSource/LazyCompressedString.cs @@ -2,7 +2,7 @@ using System; using System.Diagnostics; using System.Text; -using Umbraco.Core.Exceptions; +using Umbraco.Cms.Core.Exceptions; namespace Umbraco.Web.PublishedCache.NuCache.DataSource { diff --git a/src/Umbraco.Web/PublishedCache/NuCache/DataSource/MsgPackContentNestedDataSerializer.cs b/src/Umbraco.Web/PublishedCache/NuCache/DataSource/MsgPackContentNestedDataSerializer.cs deleted file mode 100644 index 6ae872ef69..0000000000 --- a/src/Umbraco.Web/PublishedCache/NuCache/DataSource/MsgPackContentNestedDataSerializer.cs +++ /dev/null @@ -1,126 +0,0 @@ -using K4os.Compression.LZ4; -using MessagePack; -using MessagePack.Resolvers; -using System; -using System.Linq; -using System.Text; -using Umbraco.Core.Models; -using Umbraco.Core.PropertyEditors; - -namespace Umbraco.Web.PublishedCache.NuCache.DataSource -{ - - /// - /// Serializes/Deserializes document to the SQL Database as bytes using MessagePack - /// - public class MsgPackContentNestedDataSerializer : IContentCacheDataSerializer - { - private readonly MessagePackSerializerOptions _options; - private readonly IPropertyCacheCompression _propertyOptions; - - public MsgPackContentNestedDataSerializer(IPropertyCacheCompression propertyOptions) - { - _propertyOptions = propertyOptions ?? throw new ArgumentNullException(nameof(propertyOptions)); - - var defaultOptions = ContractlessStandardResolver.Options; - var resolver = CompositeResolver.Create( - - // TODO: We want to be able to intern the strings for aliases when deserializing like we do for Newtonsoft but I'm unsure exactly how - // to do that but it would seem to be with a custom message pack resolver but I haven't quite figured out based on the docs how - // to do that since that is part of the int key -> string mapping operation, might have to see the source code to figure that one out. - // There are docs here on how to build one of these: https://github.com/neuecc/MessagePack-CSharp/blob/master/README.md#low-level-api-imessagepackformattert - // and there are a couple examples if you search on google for them but this will need to be a separate project. - // NOTE: resolver custom types first - // new ContentNestedDataResolver(), - - // finally use standard resolver - defaultOptions.Resolver - ); - - _options = defaultOptions - .WithResolver(resolver) - .WithCompression(MessagePackCompression.Lz4BlockArray); - } - - public string ToJson(byte[] bin) - { - var json = MessagePackSerializer.ConvertToJson(bin, _options); - return json; - } - - public ContentCacheDataModel Deserialize(IReadOnlyContentBase content, string stringData, byte[] byteData) - { - if (byteData != null) - { - var cacheModel = MessagePackSerializer.Deserialize(byteData, _options); - Expand(content, cacheModel); - return cacheModel; - } - else if (stringData != null) - { - // NOTE: We don't really support strings but it's possible if manually used (i.e. tests) - var bin = Convert.FromBase64String(stringData); - var cacheModel = MessagePackSerializer.Deserialize(bin, _options); - Expand(content, cacheModel); - return cacheModel; - } - else - { - return null; - } - } - - public ContentCacheDataSerializationResult Serialize(IReadOnlyContentBase content, ContentCacheDataModel model) - { - Compress(content, model); - var bytes = MessagePackSerializer.Serialize(model, _options); - return new ContentCacheDataSerializationResult(null, bytes); - } - - /// - /// Used during serialization to compress properties - /// - /// - /// - /// This will essentially 'double compress' property data. The MsgPack data as a whole will already be compressed - /// but this will go a step further and double compress property data so that it is stored in the nucache file - /// as compressed bytes and therefore will exist in memory as compressed bytes. That is, until the bytes are - /// read/decompressed as a string to be displayed on the front-end. This allows for potentially a significant - /// memory savings but could also affect performance of first rendering pages while decompression occurs. - /// - private void Compress(IReadOnlyContentBase content, ContentCacheDataModel model) - { - foreach(var propertyAliasToData in model.PropertyData) - { - if (_propertyOptions.IsCompressed(content, propertyAliasToData.Key)) - { - foreach(var property in propertyAliasToData.Value.Where(x => x.Value != null && x.Value is string)) - { - property.Value = LZ4Pickler.Pickle(Encoding.UTF8.GetBytes((string)property.Value), LZ4Level.L00_FAST); - } - } - } - } - - /// - /// Used during deserialization to map the property data as lazy or expand the value - /// - /// - private void Expand(IReadOnlyContentBase content, ContentCacheDataModel nestedData) - { - foreach (var propertyAliasToData in nestedData.PropertyData) - { - if (_propertyOptions.IsCompressed(content, propertyAliasToData.Key)) - { - foreach (var property in propertyAliasToData.Value.Where(x => x.Value != null)) - { - if (property.Value is byte[] byteArrayValue) - { - property.Value = new LazyCompressedString(byteArrayValue); - } - } - } - } - } - } -} diff --git a/src/Umbraco.Web/PublishedCache/NuCache/DataSource/MsgPackContentNestedDataSerializerFactory.cs b/src/Umbraco.Web/PublishedCache/NuCache/DataSource/MsgPackContentNestedDataSerializerFactory.cs deleted file mode 100644 index fcc3fa2bb8..0000000000 --- a/src/Umbraco.Web/PublishedCache/NuCache/DataSource/MsgPackContentNestedDataSerializerFactory.cs +++ /dev/null @@ -1,69 +0,0 @@ -using System.Collections.Concurrent; -using System.Collections.Generic; -using Umbraco.Core.Models; -using Umbraco.Core.PropertyEditors; -using Umbraco.Core.Services; - -namespace Umbraco.Web.PublishedCache.NuCache.DataSource -{ - internal class MsgPackContentNestedDataSerializerFactory : IContentCacheDataSerializerFactory - { - private readonly IContentTypeService _contentTypeService; - private readonly IMediaTypeService _mediaTypeService; - private readonly IMemberTypeService _memberTypeService; - private readonly PropertyEditorCollection _propertyEditors; - private readonly IPropertyCacheCompressionOptions _compressionOptions; - private readonly ConcurrentDictionary<(int, string), bool> _isCompressedCache = new ConcurrentDictionary<(int, string), bool>(); - - public MsgPackContentNestedDataSerializerFactory( - IContentTypeService contentTypeService, - IMediaTypeService mediaTypeService, - IMemberTypeService memberTypeService, - PropertyEditorCollection propertyEditors, - IPropertyCacheCompressionOptions compressionOptions) - { - _contentTypeService = contentTypeService; - _mediaTypeService = mediaTypeService; - _memberTypeService = memberTypeService; - _propertyEditors = propertyEditors; - _compressionOptions = compressionOptions; - } - - public IContentCacheDataSerializer Create(ContentCacheDataSerializerEntityType types) - { - // Depending on which entity types are being requested, we need to look up those content types - // to initialize the compression options. - // We need to initialize these options now so that any data lookups required are completed and are not done while the content cache - // is performing DB queries which will result in errors since we'll be trying to query with open readers. - // NOTE: The calls to GetAll() below should be cached if the data has not been changed. - - var contentTypes = new Dictionary(); - if ((types & ContentCacheDataSerializerEntityType.Document) == ContentCacheDataSerializerEntityType.Document) - { - foreach(var ct in _contentTypeService.GetAll()) - { - contentTypes[ct.Id] = ct; - } - } - if ((types & ContentCacheDataSerializerEntityType.Media) == ContentCacheDataSerializerEntityType.Media) - { - foreach (var ct in _mediaTypeService.GetAll()) - { - contentTypes[ct.Id] = ct; - } - } - if ((types & ContentCacheDataSerializerEntityType.Member) == ContentCacheDataSerializerEntityType.Member) - { - foreach (var ct in _memberTypeService.GetAll()) - { - contentTypes[ct.Id] = ct; - } - } - - var compression = new PropertyCacheCompression(_compressionOptions, contentTypes, _propertyEditors, _isCompressedCache); - var serializer = new MsgPackContentNestedDataSerializer(compression); - - return serializer; - } - } -} diff --git a/src/Umbraco.Web/PublishedCache/NuCache/NuCacheSerializerComponent.cs b/src/Umbraco.Web/PublishedCache/NuCache/NuCacheSerializerComponent.cs index a1d3ed2b12..0075604e33 100644 --- a/src/Umbraco.Web/PublishedCache/NuCache/NuCacheSerializerComponent.cs +++ b/src/Umbraco.Web/PublishedCache/NuCache/NuCacheSerializerComponent.cs @@ -4,9 +4,10 @@ using System.Configuration; using System.Linq; using System.Text; using System.Threading.Tasks; -using Umbraco.Core.Composing; -using Umbraco.Core.Logging; -using Umbraco.Core.Services; +using Umbraco.Cms.Core.Composing; +using Umbraco.Cms.Core.Logging; +using Umbraco.Cms.Core.PublishedCache; +using Umbraco.Cms.Core.Services; namespace Umbraco.Web.PublishedCache.NuCache { @@ -52,7 +53,6 @@ namespace Umbraco.Web.PublishedCache.NuCache if (serializer != currentSerializer) { - _profilingLogger.Warn($"Database NuCache was serialized using {currentSerializer}. Currently configured NuCache serializer {serializer}. Rebuilding Nucache"); using (_profilingLogger.TraceDuration($"Rebuilding NuCache database with {currentSerializer} serializer")) { diff --git a/src/Umbraco.Web/PublishedCache/NuCache/NuCacheSerializerComposer.cs b/src/Umbraco.Web/PublishedCache/NuCache/NuCacheSerializerComposer.cs deleted file mode 100644 index 59a206bc47..0000000000 --- a/src/Umbraco.Web/PublishedCache/NuCache/NuCacheSerializerComposer.cs +++ /dev/null @@ -1,21 +0,0 @@ -using System; -using System.Collections.Generic; -using System.Linq; -using System.Text; -using System.Threading.Tasks; -using Umbraco.Core; -using Umbraco.Core.Composing; - -namespace Umbraco.Web.PublishedCache.NuCache -{ - - [ComposeAfter(typeof(NuCacheComposer))] - [RuntimeLevel(MinLevel = RuntimeLevel.Run)] - public class NuCacheSerializerComposer : ICoreComposer - { - public void Compose(Composition composition) - { - composition.Components().Append(); - } - } -} diff --git a/src/Umbraco.Web/PublishedCache/NuCache/PublishedSnapshotService.cs b/src/Umbraco.Web/PublishedCache/NuCache/PublishedSnapshotService.cs deleted file mode 100644 index f9c25b7b35..0000000000 --- a/src/Umbraco.Web/PublishedCache/NuCache/PublishedSnapshotService.cs +++ /dev/null @@ -1,1876 +0,0 @@ -using System; -using System.Collections.Generic; -using System.Configuration; -using System.Globalization; -using System.IO; -using System.Linq; -using System.Threading; -using CSharpTest.Net.Collections; -using Umbraco.Core; -using Umbraco.Core.Cache; -using Umbraco.Core.Configuration; -using Umbraco.Core.Logging; -using Umbraco.Core.Models; -using Umbraco.Core.Models.Membership; -using Umbraco.Core.Models.PublishedContent; -using Umbraco.Core.Persistence; -using Umbraco.Core.Persistence.Dtos; -using Umbraco.Core.Persistence.Repositories; -using Umbraco.Core.Persistence.Repositories.Implement; -using Umbraco.Core.Scoping; -using Umbraco.Core.Services; -using Umbraco.Core.Services.Changes; -using Umbraco.Core.Services.Implement; -using Umbraco.Core.Strings; -using Umbraco.Core.Sync; -using Umbraco.Web.Cache; -using Umbraco.Web.Install; -using Umbraco.Web.PublishedCache.NuCache.DataSource; -using Umbraco.Web.Routing; -using File = System.IO.File; - -namespace Umbraco.Web.PublishedCache.NuCache -{ - - internal class PublishedSnapshotService : PublishedSnapshotServiceBase - { - private readonly PublishedSnapshotServiceOptions _options; - private readonly IMainDom _mainDom; - private readonly ServiceContext _serviceContext; - private readonly IPublishedContentTypeFactory _publishedContentTypeFactory; - private readonly IScopeProvider _scopeProvider; - private readonly IDataSource _dataSource; - private readonly IProfilingLogger _logger; - private readonly IDocumentRepository _documentRepository; - private readonly IMediaRepository _mediaRepository; - private readonly IMemberRepository _memberRepository; - private readonly IGlobalSettings _globalSettings; - private readonly IEntityXmlSerializer _entitySerializer; - private readonly IPublishedModelFactory _publishedModelFactory; - private readonly IDefaultCultureAccessor _defaultCultureAccessor; - private readonly UrlSegmentProviderCollection _urlSegmentProviders; - private readonly IContentCacheDataSerializerFactory _contentCacheDataSerializerFactory; - private readonly ContentDataSerializer _contentDataSerializer; - - private bool _isReady; - private bool _isReadSet; - private object _isReadyLock; - - private ContentStore _contentStore; - private ContentStore _mediaStore; - private SnapDictionary _domainStore; - private readonly object _storesLock = new object(); - private readonly object _elementsLock = new object(); - - private BPlusTree _localContentDb; - private BPlusTree _localMediaDb; - private bool _localContentDbExists; - private bool _localMediaDbExists; - - private readonly ISyncBootStateAccessor _syncBootStateAccessor; - - // define constant - determines whether to use cache when previewing - // to store eg routes, property converted values, anything - caching - // means faster execution, but uses memory - not sure if we want it - // so making it configurable. - public static readonly bool FullCacheWhenPreviewing = true; - - #region Constructors - - //private static int _singletonCheck; - - public PublishedSnapshotService(PublishedSnapshotServiceOptions options, IMainDom mainDom, IRuntimeState runtime, - ServiceContext serviceContext, IPublishedContentTypeFactory publishedContentTypeFactory, IdkMap idkMap, - IPublishedSnapshotAccessor publishedSnapshotAccessor, IVariationContextAccessor variationContextAccessor, IProfilingLogger logger, IScopeProvider scopeProvider, - IDocumentRepository documentRepository, IMediaRepository mediaRepository, IMemberRepository memberRepository, - IDefaultCultureAccessor defaultCultureAccessor, - IDataSource dataSource, IGlobalSettings globalSettings, - IEntityXmlSerializer entitySerializer, - IPublishedModelFactory publishedModelFactory, - UrlSegmentProviderCollection urlSegmentProviders, - ISyncBootStateAccessor syncBootStateAccessor, - IContentCacheDataSerializerFactory contentCacheDataSerializerFactory, - ContentDataSerializer contentDataSerializer = null) - : base(publishedSnapshotAccessor, variationContextAccessor) - { - - //if (Interlocked.Increment(ref _singletonCheck) > 1) - // throw new Exception("Singleton must be instantiated only once!"); - - _options = options; - _mainDom = mainDom; - _serviceContext = serviceContext; - _publishedContentTypeFactory = publishedContentTypeFactory; - _dataSource = dataSource; - _logger = logger; - _scopeProvider = scopeProvider; - _documentRepository = documentRepository; - _mediaRepository = mediaRepository; - _memberRepository = memberRepository; - _defaultCultureAccessor = defaultCultureAccessor; - _globalSettings = globalSettings; - _urlSegmentProviders = urlSegmentProviders; - _contentCacheDataSerializerFactory = contentCacheDataSerializerFactory; - _contentDataSerializer = contentDataSerializer; - - _syncBootStateAccessor = syncBootStateAccessor; - - _syncBootStateAccessor = syncBootStateAccessor; - - // we need an Xml serializer here so that the member cache can support XPath, - // for members this is done by navigating the serialized-to-xml member - _entitySerializer = entitySerializer; - _publishedModelFactory = publishedModelFactory; - - // we always want to handle repository events, configured or not - // assuming no repository event will trigger before the whole db is ready - // (ideally we'd have Upgrading.App vs Upgrading.Data application states...) - InitializeRepositoryEvents(); - - // however, the cache is NOT available until we are configured, because loading - // content (and content types) from database cannot be consistent (see notes in "Handle - // Notifications" region), so - // - notifications will be ignored - // - trying to obtain a published snapshot from the service will throw - if (runtime.Level != RuntimeLevel.Run) - return; - - if (idkMap != null) - { - idkMap.SetMapper(UmbracoObjectTypes.Document, id => GetUid(_contentStore, id), uid => GetId(_contentStore, uid)); - idkMap.SetMapper(UmbracoObjectTypes.Media, id => GetUid(_mediaStore, id), uid => GetId(_mediaStore, uid)); - } - } - - private int GetId(ContentStore store, Guid uid) - { - EnsureCaches(); - return store.LiveSnapshot.Get(uid)?.Id ?? default; - } - - private Guid GetUid(ContentStore store, int id) - { - EnsureCaches(); - return store.LiveSnapshot.Get(id)?.Uid ?? default; - } - - /// - /// Install phase of - /// - /// - /// This is inside of a lock in MainDom so this is guaranteed to run if MainDom was acquired and guaranteed - /// to not run if MainDom wasn't acquired. - /// If MainDom was not acquired, then _localContentDb and _localMediaDb will remain null which means this appdomain - /// will load in published content via the DB and in that case this appdomain will probably not exist long enough to - /// serve more than a page of content. - /// - private void MainDomRegister() - { - var path = GetLocalFilesPath(); - var localContentDbPath = Path.Combine(path, "NuCache.Content.db"); - var localMediaDbPath = Path.Combine(path, "NuCache.Media.db"); - - _localContentDbExists = File.Exists(localContentDbPath); - _localMediaDbExists = File.Exists(localMediaDbPath); - - // if both local databases exist then GetTree will open them, else new databases will be created - _localContentDb = BTree.GetTree(localContentDbPath, _localContentDbExists, _contentDataSerializer); - _localMediaDb = BTree.GetTree(localMediaDbPath, _localMediaDbExists, _contentDataSerializer); - - _logger.Info("Registered with MainDom, localContentDbExists? {LocalContentDbExists}, localMediaDbExists? {LocalMediaDbExists}", _localContentDbExists, _localMediaDbExists); - } - - /// - /// Release phase of MainDom - /// - /// - /// This will execute on a threadpool thread - /// - private void MainDomRelease() - { - _logger.Debug("Releasing from MainDom..."); - - lock (_storesLock) - { - _logger.Debug("Releasing content store..."); - _contentStore?.ReleaseLocalDb(); //null check because we could shut down before being assigned - _localContentDb = null; - - _logger.Debug("Releasing media store..."); - _mediaStore?.ReleaseLocalDb(); //null check because we could shut down before being assigned - _localMediaDb = null; - - _logger.Info("Released from MainDom"); - } - } - - /// - /// Lazily populates the stores only when they are first requested - /// - internal void EnsureCaches() => LazyInitializer.EnsureInitialized( - ref _isReady, - ref _isReadSet, - ref _isReadyLock, - () => - { - // lock this entire call, we only want a single thread to be accessing the stores at once and within - // the call below to mainDom.Register, a callback may occur on a threadpool thread to MainDomRelease - // at the same time as we are trying to write to the stores. MainDomRelease also locks on _storesLock so - // it will not be able to close the stores until we are done populating (if the store is empty) - lock (_storesLock) - { - if (!_options.IgnoreLocalDb) - { - var registered = _mainDom.Register(MainDomRegister, MainDomRelease); - - // stores are created with a db so they can write to it, but they do not read from it, - // stores need to be populated, happens in OnResolutionFrozen which uses _localDbExists to - // figure out whether it can read the databases or it should populate them from sql - - _logger.Info("Creating the content store, localContentDbExists? {LocalContentDbExists}", _localContentDbExists); - _contentStore = new ContentStore(PublishedSnapshotAccessor, VariationContextAccessor, _logger, _localContentDb); - _logger.Info("Creating the media store, localMediaDbExists? {LocalMediaDbExists}", _localMediaDbExists); - _mediaStore = new ContentStore(PublishedSnapshotAccessor, VariationContextAccessor, _logger, _localMediaDb); - } - else - { - _logger.Info("Creating the content store (local db ignored)"); - _contentStore = new ContentStore(PublishedSnapshotAccessor, VariationContextAccessor, _logger); - _logger.Info("Creating the media store (local db ignored)"); - _mediaStore = new ContentStore(PublishedSnapshotAccessor, VariationContextAccessor, _logger); - } - - _domainStore = new SnapDictionary(); - - SyncBootState bootState = _syncBootStateAccessor.GetSyncBootState(); - - var okContent = false; - var okMedia = false; - - try - { - if (bootState != SyncBootState.ColdBoot && _localContentDbExists) - { - okContent = LockAndLoadContent(scope => LoadContentFromLocalDbLocked(true)); - if (!okContent) - _logger.Warn("Loading content from local db raised warnings, will reload from database."); - } - - if (bootState != SyncBootState.ColdBoot && _localMediaDbExists) - { - okMedia = LockAndLoadMedia(scope => LoadMediaFromLocalDbLocked(true)); - if (!okMedia) - _logger.Warn("Loading media from local db raised warnings, will reload from database."); - } - - if (!okContent) - LockAndLoadContent(scope => LoadContentFromDatabaseLocked(scope, true)); - - if (!okMedia) - LockAndLoadMedia(scope => LoadMediaFromDatabaseLocked(scope, true)); - - LockAndLoadDomains(); - } - catch (Exception ex) - { - _logger.Fatal(ex, "Panic, exception while loading cache data."); - throw; - } - - // finally, cache is ready! - return true; - } - }); - - private void InitializeRepositoryEvents() - { - // TODO: The reason these events are in the repository is for legacy, the events should exist at the service - // level now since we can fire these events within the transaction... so move the events to service level - - // plug repository event handlers - // these trigger within the transaction to ensure consistency - // and are used to maintain the central, database-level XML cache - DocumentRepository.ScopeEntityRemove += OnContentRemovingEntity; - //ContentRepository.RemovedVersion += OnContentRemovedVersion; - DocumentRepository.ScopedEntityRefresh += OnContentRefreshedEntity; - MediaRepository.ScopeEntityRemove += OnMediaRemovingEntity; - //MediaRepository.RemovedVersion += OnMediaRemovedVersion; - MediaRepository.ScopedEntityRefresh += OnMediaRefreshedEntity; - MemberRepository.ScopeEntityRemove += OnMemberRemovingEntity; - //MemberRepository.RemovedVersion += OnMemberRemovedVersion; - MemberRepository.ScopedEntityRefresh += OnMemberRefreshedEntity; - - // plug - ContentTypeService.ScopedRefreshedEntity += OnContentTypeRefreshedEntity; - MediaTypeService.ScopedRefreshedEntity += OnMediaTypeRefreshedEntity; - MemberTypeService.ScopedRefreshedEntity += OnMemberTypeRefreshedEntity; - - LocalizationService.SavedLanguage += OnLanguageSaved; - } - - private void TearDownRepositoryEvents() - { - DocumentRepository.ScopeEntityRemove -= OnContentRemovingEntity; - //ContentRepository.RemovedVersion -= OnContentRemovedVersion; - DocumentRepository.ScopedEntityRefresh -= OnContentRefreshedEntity; - MediaRepository.ScopeEntityRemove -= OnMediaRemovingEntity; - //MediaRepository.RemovedVersion -= OnMediaRemovedVersion; - MediaRepository.ScopedEntityRefresh -= OnMediaRefreshedEntity; - MemberRepository.ScopeEntityRemove -= OnMemberRemovingEntity; - //MemberRepository.RemovedVersion -= OnMemberRemovedVersion; - MemberRepository.ScopedEntityRefresh -= OnMemberRefreshedEntity; - - ContentTypeService.ScopedRefreshedEntity -= OnContentTypeRefreshedEntity; - MediaTypeService.ScopedRefreshedEntity -= OnMediaTypeRefreshedEntity; - MemberTypeService.ScopedRefreshedEntity -= OnMemberTypeRefreshedEntity; - - LocalizationService.SavedLanguage -= OnLanguageSaved; - } - - public override void Dispose() - { - TearDownRepositoryEvents(); - base.Dispose(); - } - - #endregion - - #region Local files - - private string GetLocalFilesPath() - { - var path = Path.Combine(_globalSettings.LocalTempPath, "NuCache"); - - if (!Directory.Exists(path)) - Directory.CreateDirectory(path); - - return path; - } - - private void DeleteLocalFilesForContent() - { - if (_isReady && _localContentDb != null) - throw new InvalidOperationException("Cannot delete local files while the cache uses them."); - - var path = GetLocalFilesPath(); - var localContentDbPath = Path.Combine(path, "NuCache.Content.db"); - if (File.Exists(localContentDbPath)) - File.Delete(localContentDbPath); - } - - private void DeleteLocalFilesForMedia() - { - if (_isReady && _localMediaDb != null) - throw new InvalidOperationException("Cannot delete local files while the cache uses them."); - - var path = GetLocalFilesPath(); - var localMediaDbPath = Path.Combine(path, "NuCache.Media.db"); - if (File.Exists(localMediaDbPath)) - File.Delete(localMediaDbPath); - } - - #endregion - - #region Environment - - public override bool EnsureEnvironment(out IEnumerable errors) - { - // must have app_data and be able to write files into it - var ok = FilePermissionHelper.TryCreateDirectory(GetLocalFilesPath()); - errors = ok ? Enumerable.Empty() : new[] { "NuCache local files." }; - return ok; - } - - #endregion - - #region Populate Stores - - // sudden panic... but in RepeatableRead can a content that I haven't already read, be removed - // before I read it? NO! because the WHOLE content tree is read-locked using WithReadLocked. - // don't panic. - - private bool LockAndLoadContent(Func action) - { - - - // first get a writer, then a scope - // if there already is a scope, the writer will attach to it - // otherwise, it will only exist here - cheap - using (_contentStore.GetScopedWriteLock(_scopeProvider)) - using (var scope = _scopeProvider.CreateScope()) - { - scope.ReadLock(Constants.Locks.ContentTree); - var ok = action(scope); - scope.Complete(); - return ok; - } - } - - private bool LoadContentFromDatabaseLocked(IScope scope, bool onStartup) - { - // locks: - // contentStore is wlocked (1 thread) - // content (and types) are read-locked - - var contentTypes = _serviceContext.ContentTypeService.GetAll().ToList(); - - _contentStore.SetAllContentTypesLocked(contentTypes.Select(x => _publishedContentTypeFactory.CreateContentType(x))); - - using (_logger.TraceDuration("Loading content from database")) - { - // beware! at that point the cache is inconsistent, - // assuming we are going to SetAll content items! - - _localContentDb?.Clear(); - - // IMPORTANT GetAllContentSources sorts kits by level + parentId + sortOrder - var kits = _dataSource.GetAllContentSources(scope); - return onStartup ? _contentStore.SetAllFastSortedLocked(kits, true) : _contentStore.SetAllLocked(kits); - } - } - - private bool LoadContentFromLocalDbLocked(bool onStartup) - { - var contentTypes = _serviceContext.ContentTypeService.GetAll() - .Select(x => _publishedContentTypeFactory.CreateContentType(x)); - _contentStore.SetAllContentTypesLocked(contentTypes); - - using (_logger.TraceDuration("Loading content from local cache file")) - { - // beware! at that point the cache is inconsistent, - // assuming we are going to SetAll content items! - - return LoadEntitiesFromLocalDbLocked(onStartup, _localContentDb, _contentStore, "content"); - } - } - - // keep these around - might be useful - - //private void LoadContentBranch(IContent content) - //{ - // LoadContent(content); - - // foreach (var child in content.Children()) - // LoadContentBranch(child); - //} - - //private void LoadContent(IContent content) - //{ - // var contentService = _serviceContext.ContentService as ContentService; - // var newest = content; - // var published = newest.Published - // ? newest - // : (newest.HasPublishedVersion ? contentService.GetByVersion(newest.PublishedVersionGuid) : null); - - // var contentNode = CreateContentNode(newest, published); - // _contentStore.Set(contentNode); - //} - - private bool LockAndLoadMedia(Func action) - { - // see note in LockAndLoadContent - using (_mediaStore.GetScopedWriteLock(_scopeProvider)) - using (var scope = _scopeProvider.CreateScope()) - { - scope.ReadLock(Constants.Locks.MediaTree); - var ok = action(scope); - scope.Complete(); - return ok; - } - } - - private bool LoadMediaFromDatabaseLocked(IScope scope, bool onStartup) - { - // locks & notes: see content - - var mediaTypes = _serviceContext.MediaTypeService.GetAll() - .Select(x => _publishedContentTypeFactory.CreateContentType(x)); - _mediaStore.SetAllContentTypesLocked(mediaTypes); - - using (_logger.TraceDuration("Loading media from database")) - { - // beware! at that point the cache is inconsistent, - // assuming we are going to SetAll content items! - - _localMediaDb?.Clear(); - - _logger.Debug("Loading media from database..."); - // IMPORTANT GetAllMediaSources sorts kits by level + parentId + sortOrder - var kits = _dataSource.GetAllMediaSources(scope); - return onStartup ? _mediaStore.SetAllFastSortedLocked(kits, true) : _mediaStore.SetAllLocked(kits); - } - } - - private bool LoadMediaFromLocalDbLocked(bool onStartup) - { - var mediaTypes = _serviceContext.MediaTypeService.GetAll() - .Select(x => _publishedContentTypeFactory.CreateContentType(x)); - _mediaStore.SetAllContentTypesLocked(mediaTypes); - - using (_logger.TraceDuration("Loading media from local cache file")) - { - // beware! at that point the cache is inconsistent, - // assuming we are going to SetAll content items! - - return LoadEntitiesFromLocalDbLocked(onStartup, _localMediaDb, _mediaStore, "media"); - } - - } - - private bool LoadEntitiesFromLocalDbLocked(bool onStartup, BPlusTree localDb, ContentStore store, string entityType) - { - var kits = localDb.Select(x => x.Value) - .OrderBy(x => x.Node.Level) - .ThenBy(x => x.Node.ParentContentId) - .ThenBy(x => x.Node.SortOrder) // IMPORTANT sort by level + parentId + sortOrder - .ToList(); - - if (kits.Count == 0) - { - // If there's nothing in the local cache file, we should return false? YES even though the site legitately might be empty. - // Is it possible that the cache file is empty but the database is not? YES... (well, it used to be possible) - // * A new file is created when one doesn't exist, this will only be done when MainDom is acquired - // * The new file will be populated as soon as LoadCachesOnStartup is called - // * If the appdomain is going down the moment after MainDom was acquired and we've created an empty cache file, - // then the MainDom release callback is triggered from on a different thread, which will close the file and - // set the cache file reference to null. At this moment, it is possible that the file is closed and the - // reference is set to null BEFORE LoadCachesOnStartup which would mean that the current appdomain would load - // in the in-mem cache via DB calls, BUT this now means that there is an empty cache file which will be - // loaded by the next appdomain and it won't check if it's empty, it just assumes that since the cache - // file is there, that is correct. - - // Update: We will still return false here even though the above mentioned race condition has been fixed since we now - // lock the entire operation of creating/populating the cache file with the same lock as releasing/closing the cache file - - _logger.Info($"Tried to load {entityType} from the local cache file but it was empty."); - return false; - } - - return onStartup ? store.SetAllFastSortedLocked(kits, false) : store.SetAllLocked(kits); - } - - // keep these around - might be useful - - //private void LoadMediaBranch(IMedia media) - //{ - // LoadMedia(media); - - // foreach (var child in media.Children()) - // LoadMediaBranch(child); - //} - - //private void LoadMedia(IMedia media) - //{ - // var mediaType = _contentTypeCache.Get(PublishedItemType.Media, media.ContentTypeId); - - // var mediaData = new ContentData - // { - // Name = media.Name, - // Published = true, - // Version = media.Version, - // VersionDate = media.UpdateDate, - // WriterId = media.CreatorId, // what else? - // TemplateId = -1, // have none - // Properties = GetPropertyValues(media) - // }; - - // var mediaNode = new ContentNode(media.Id, mediaType, - // media.Level, media.Path, media.SortOrder, - // media.ParentId, media.CreateDate, media.CreatorId, - // null, mediaData); - - // _mediaStore.Set(mediaNode); - //} - - //private Dictionary GetPropertyValues(IContentBase content) - //{ - // var propertyEditorResolver = PropertyEditorResolver.Current; // should inject - - // return content - // .Properties - // .Select(property => - // { - // var e = propertyEditorResolver.GetByAlias(property.PropertyType.PropertyEditorAlias); - // var v = e == null - // ? property.Value - // : e.ValueEditor.ConvertDbToString(property, property.PropertyType, _serviceContext.DataTypeService); - // return new KeyValuePair(property.Alias, v); - // }) - // .ToDictionary(x => x.Key, x => x.Value); - //} - - //private ContentData CreateContentData(IContent content) - //{ - // return new ContentData - // { - // Name = content.Name, - // Published = content.Published, - // Version = content.Version, - // VersionDate = content.UpdateDate, - // WriterId = content.WriterId, - // TemplateId = content.Template == null ? -1 : content.Template.Id, - // Properties = GetPropertyValues(content) - // }; - //} - - //private ContentNode CreateContentNode(IContent newest, IContent published) - //{ - // var contentType = _contentTypeCache.Get(PublishedItemType.Content, newest.ContentTypeId); - - // var draftData = newest.Published - // ? null - // : CreateContentData(newest); - - // var publishedData = newest.Published - // ? CreateContentData(newest) - // : (published == null ? null : CreateContentData(published)); - - // var contentNode = new ContentNode(newest.Id, contentType, - // newest.Level, newest.Path, newest.SortOrder, - // newest.ParentId, newest.CreateDate, newest.CreatorId, - // draftData, publishedData); - - // return contentNode; - //} - - private void LockAndLoadDomains() - { - // see note in LockAndLoadContent - using (_domainStore.GetScopedWriteLock(_scopeProvider)) - using (var scope = _scopeProvider.CreateScope()) - { - scope.ReadLock(Constants.Locks.Domains); - LoadDomainsLocked(); - scope.Complete(); - } - } - - private void LoadDomainsLocked() - { - var domains = _serviceContext.DomainService.GetAll(true); - foreach (var domain in domains - .Where(x => x.RootContentId.HasValue && x.LanguageIsoCode.IsNullOrWhiteSpace() == false) - .Select(x => new Domain(x.Id, x.DomainName, x.RootContentId.Value, CultureInfo.GetCultureInfo(x.LanguageIsoCode), x.IsWildcard))) - { - _domainStore.SetLocked(domain.Id, domain); - } - } - - #endregion - - #region Handle Notifications - - // note: if the service is not ready, ie _isReady is false, then notifications are ignored - - // SetUmbracoVersionStep issues a DistributedCache.Instance.RefreshAll...() call which should cause - // the entire content, media etc caches to reload from database -- and then the app restarts -- however, - // at the time SetUmbracoVersionStep runs, Umbraco is not fully initialized and therefore some property - // value converters, etc are not registered, and rebuilding the NuCache may not work properly. - // - // More details: ApplicationContext.IsConfigured being false, ApplicationEventHandler.ExecuteWhen... is - // called and in most cases events are skipped, so property value converters are not registered or - // removed, so PublishedPropertyType either initializes with the wrong converter, or throws because it - // detects more than one converter for a property type. - // - // It's not an issue for XmlStore - the app restart takes place *after* the install has refreshed the - // cache, and XmlStore just writes a new umbraco.config file upon RefreshAll, so that's OK. - // - // But for NuCache... we cannot rebuild the cache now. So it will NOT work and we are not fixing it, - // because now we should ALWAYS run with the database server messenger, and then the RefreshAll will - // be processed as soon as we are configured and the messenger processes instructions. - - // note: notifications for content type and data type changes should be invoked with the - // pure live model factory, if any, locked and refreshed - see ContentTypeCacheRefresher and - // DataTypeCacheRefresher - - public override void Notify(ContentCacheRefresher.JsonPayload[] payloads, out bool draftChanged, out bool publishedChanged) - { - // no cache, trash everything - if (_isReady == false) - { - DeleteLocalFilesForContent(); - draftChanged = publishedChanged = true; - return; - } - - using (_contentStore.GetScopedWriteLock(_scopeProvider)) - { - NotifyLocked(payloads, out bool draftChanged2, out bool publishedChanged2); - draftChanged = draftChanged2; - publishedChanged = publishedChanged2; - } - - - if (draftChanged || publishedChanged) - ((PublishedSnapshot)CurrentPublishedSnapshot)?.Resync(); - } - - // Calling this method means we have a lock on the contentStore (i.e. GetScopedWriteLock) - private void NotifyLocked(IEnumerable payloads, out bool draftChanged, out bool publishedChanged) - { - publishedChanged = false; - draftChanged = false; - - // locks: - // content (and content types) are read-locked while reading content - // contentStore is wlocked (so readable, only no new views) - // and it can be wlocked by 1 thread only at a time - // contentStore is write-locked during changes - see note above, calls to this method are wrapped in contentStore.GetScopedWriteLock - - foreach (var payload in payloads) - { - _logger.Debug("Notified {ChangeTypes} for content {ContentId}", payload.ChangeTypes, payload.Id); - - if (payload.ChangeTypes.HasType(TreeChangeTypes.RefreshAll)) - { - using (var scope = _scopeProvider.CreateScope()) - { - scope.ReadLock(Constants.Locks.ContentTree); - LoadContentFromDatabaseLocked(scope, false); - scope.Complete(); - } - draftChanged = publishedChanged = true; - continue; - } - - if (payload.ChangeTypes.HasType(TreeChangeTypes.Remove)) - { - if (_contentStore.ClearLocked(payload.Id)) - draftChanged = publishedChanged = true; - continue; - } - - if (payload.ChangeTypes.HasTypesNone(TreeChangeTypes.RefreshNode | TreeChangeTypes.RefreshBranch)) - { - // ?! - continue; - } - - // TODO: should we do some RV check here? (later) - - var capture = payload; - using (var scope = _scopeProvider.CreateScope()) - { - scope.ReadLock(Constants.Locks.ContentTree); - - if (capture.ChangeTypes.HasType(TreeChangeTypes.RefreshBranch)) - { - // ?? should we do some RV check here? - // IMPORTANT GetbranchContentSources sorts kits by level and by sort order - var kits = _dataSource.GetBranchContentSources(scope, capture.Id); - _contentStore.SetBranchLocked(capture.Id, kits); - } - else - { - // ?? should we do some RV check here? - var kit = _dataSource.GetContentSource(scope, capture.Id); - if (kit.IsEmpty) - { - _contentStore.ClearLocked(capture.Id); - } - else - { - _contentStore.SetLocked(kit); - } - } - - scope.Complete(); - } - - // ?? cannot tell really because we're not doing RV checks - draftChanged = publishedChanged = true; - } - } - - /// - public override void Notify(MediaCacheRefresher.JsonPayload[] payloads, out bool anythingChanged) - { - // no cache, trash everything - if (_isReady == false) - { - DeleteLocalFilesForMedia(); - anythingChanged = true; - return; - } - - using (_mediaStore.GetScopedWriteLock(_scopeProvider)) - { - NotifyLocked(payloads, out bool anythingChanged2); - anythingChanged = anythingChanged2; - } - - if (anythingChanged) - ((PublishedSnapshot)CurrentPublishedSnapshot)?.Resync(); - } - - private void NotifyLocked(IEnumerable payloads, out bool anythingChanged) - { - anythingChanged = false; - - // locks: - // see notes for content cache refresher - - foreach (var payload in payloads) - { - _logger.Debug("Notified {ChangeTypes} for media {MediaId}", payload.ChangeTypes, payload.Id); - - if (payload.ChangeTypes.HasType(TreeChangeTypes.RefreshAll)) - { - using (var scope = _scopeProvider.CreateScope()) - { - scope.ReadLock(Constants.Locks.MediaTree); - LoadMediaFromDatabaseLocked(scope, false); - scope.Complete(); - } - anythingChanged = true; - continue; - } - - if (payload.ChangeTypes.HasType(TreeChangeTypes.Remove)) - { - if (_mediaStore.ClearLocked(payload.Id)) - anythingChanged = true; - continue; - } - - if (payload.ChangeTypes.HasTypesNone(TreeChangeTypes.RefreshNode | TreeChangeTypes.RefreshBranch)) - { - // ?! - continue; - } - - // TODO: should we do some RV checks here? (later) - - var capture = payload; - using (var scope = _scopeProvider.CreateScope()) - { - scope.ReadLock(Constants.Locks.MediaTree); - - if (capture.ChangeTypes.HasType(TreeChangeTypes.RefreshBranch)) - { - // ?? should we do some RV check here? - // IMPORTANT GetbranchContentSources sorts kits by level and by sort order - var kits = _dataSource.GetBranchMediaSources(scope, capture.Id); - _mediaStore.SetBranchLocked(capture.Id, kits); - } - else - { - // ?? should we do some RV check here? - var kit = _dataSource.GetMediaSource(scope, capture.Id); - if (kit.IsEmpty) - { - _mediaStore.ClearLocked(capture.Id); - } - else - { - _mediaStore.SetLocked(kit); - } - } - - scope.Complete(); - } - - // ?? cannot tell really because we're not doing RV checks - anythingChanged = true; - } - } - - /// - public override void Notify(ContentTypeCacheRefresher.JsonPayload[] payloads) - { - // no cache, nothing we can do - if (_isReady == false) - return; - - foreach (var payload in payloads) - _logger.Debug("Notified {ChangeTypes} for {ItemType} {ItemId}", payload.ChangeTypes, payload.ItemType, payload.Id); - - Notify(_contentStore, payloads, RefreshContentTypesLocked); - Notify(_mediaStore, payloads, RefreshMediaTypesLocked); - - if (_publishedModelFactory.IsLiveFactoryEnabled()) - { - //In the case of Pure Live - we actually need to refresh all of the content and the media - //see https://github.com/umbraco/Umbraco-CMS/issues/5671 - //The underlying issue is that in Pure Live the ILivePublishedModelFactory will re-compile all of the classes/models - //into a new DLL for the application which includes both content types and media types. - //Since the models in the cache are based on these actual classes, all of the objects in the cache need to be updated - //to use the newest version of the class. - - // NOTE: Ideally this can be run on background threads here which would prevent blocking the UI - // as is the case when saving a content type. Intially one would think that it won't be any different - // between running this here or in another background thread immediately after with regards to how the - // UI will respond because we already know between calling `WithSafeLiveFactoryReset` to reset the PureLive models - // and this code here, that many front-end requests could be attempted to be processed. If that is the case, those pages are going to get a - // model binding error and our ModelBindingExceptionFilter is going to to its magic to reload those pages so the end user is none the wiser. - // So whether or not this executes 'here' or on a background thread immediately wouldn't seem to make any difference except that we can return - // execution to the UI sooner. - // BUT!... there is a difference IIRC. There is still execution logic that continues after this call on this thread with the cache refreshers - // and those cache refreshers need to have the up-to-date data since other user cache refreshers will be expecting the data to be 'live'. If - // we ran this on a background thread then those cache refreshers are going to not get 'live' data when they query the content cache which - // they require. - - // These can be run side by side in parallel. - using (_contentStore.GetScopedWriteLock(_scopeProvider)) - { - NotifyLocked(new[] { new ContentCacheRefresher.JsonPayload(0, null, TreeChangeTypes.RefreshAll) }, out _, out _); - } - - using (_mediaStore.GetScopedWriteLock(_scopeProvider)) - { - NotifyLocked(new[] { new MediaCacheRefresher.JsonPayload(0, null, TreeChangeTypes.RefreshAll) }, out _); - } - } - - ((PublishedSnapshot)CurrentPublishedSnapshot)?.Resync(); - } - - private void Notify(ContentStore store, ContentTypeCacheRefresher.JsonPayload[] payloads, Action, List, List, List> action) - where T : IContentTypeComposition - { - if (payloads.Length == 0) return; //nothing to do - - var nameOfT = typeof(T).Name; - - List removedIds = null, refreshedIds = null, otherIds = null, newIds = null; - - foreach (var payload in payloads) - { - if (payload.ItemType != nameOfT) continue; - - if (payload.ChangeTypes.HasType(ContentTypeChangeTypes.Remove)) - AddToList(ref removedIds, payload.Id); - else if (payload.ChangeTypes.HasType(ContentTypeChangeTypes.RefreshMain)) - AddToList(ref refreshedIds, payload.Id); - else if (payload.ChangeTypes.HasType(ContentTypeChangeTypes.RefreshOther)) - AddToList(ref otherIds, payload.Id); - else if (payload.ChangeTypes.HasType(ContentTypeChangeTypes.Create)) - AddToList(ref newIds, payload.Id); - } - - if (removedIds.IsCollectionEmpty() && refreshedIds.IsCollectionEmpty() && otherIds.IsCollectionEmpty() && newIds.IsCollectionEmpty()) return; - - using (store.GetScopedWriteLock(_scopeProvider)) - { - // ReSharper disable AccessToModifiedClosure - action(removedIds, refreshedIds, otherIds, newIds); - // ReSharper restore AccessToModifiedClosure - } - } - - public override void Notify(DataTypeCacheRefresher.JsonPayload[] payloads) - { - // no cache, nothing we can do - if (_isReady == false) - return; - - var idsA = payloads.Select(x => x.Id).ToArray(); - - foreach (var payload in payloads) - _logger.Debug("Notified {RemovedStatus} for data type {DataTypeId}", - payload.Removed ? "Removed" : "Refreshed", - payload.Id); - - using (_contentStore.GetScopedWriteLock(_scopeProvider)) - using (_mediaStore.GetScopedWriteLock(_scopeProvider)) - { - // TODO: need to add a datatype lock - // this is triggering datatypes reload in the factory, and right after we create some - // content types by loading them ... there's a race condition here, which would require - // some locking on datatypes - _publishedContentTypeFactory.NotifyDataTypeChanges(idsA); - - using (var scope = _scopeProvider.CreateScope()) - { - scope.ReadLock(Constants.Locks.ContentTree); - _contentStore.UpdateDataTypesLocked(idsA, id => CreateContentType(PublishedItemType.Content, id)); - scope.Complete(); - } - - using (var scope = _scopeProvider.CreateScope()) - { - scope.ReadLock(Constants.Locks.MediaTree); - _mediaStore.UpdateDataTypesLocked(idsA, id => CreateContentType(PublishedItemType.Media, id)); - scope.Complete(); - } - } - - ((PublishedSnapshot)CurrentPublishedSnapshot)?.Resync(); - } - - public override void Notify(DomainCacheRefresher.JsonPayload[] payloads) - { - // no cache, nothing we can do - if (_isReady == false) - return; - - // see note in LockAndLoadContent - using (_domainStore.GetScopedWriteLock(_scopeProvider)) - { - foreach (var payload in payloads) - { - switch (payload.ChangeType) - { - case DomainChangeTypes.RefreshAll: - using (var scope = _scopeProvider.CreateScope()) - { - scope.ReadLock(Constants.Locks.Domains); - LoadDomainsLocked(); - scope.Complete(); - } - break; - case DomainChangeTypes.Remove: - _domainStore.ClearLocked(payload.Id); - break; - case DomainChangeTypes.Refresh: - var domain = _serviceContext.DomainService.GetById(payload.Id); - if (domain == null) continue; - if (domain.RootContentId.HasValue == false) continue; // anomaly - if (domain.LanguageIsoCode.IsNullOrWhiteSpace()) continue; // anomaly - var culture = CultureInfo.GetCultureInfo(domain.LanguageIsoCode); - _domainStore.SetLocked(domain.Id, new Domain(domain.Id, domain.DomainName, domain.RootContentId.Value, culture, domain.IsWildcard)); - break; - } - } - } - } - - //Methods used to prevent allocations of lists - private void AddToList(ref List list, int val) => GetOrCreateList(ref list).Add(val); - private List GetOrCreateList(ref List list) => list ?? (list = new List()); - - #endregion - - #region Content Types - - private IReadOnlyCollection CreateContentTypes(PublishedItemType itemType, int[] ids) - { - // XxxTypeService.GetAll(empty) returns everything! - if (ids.Length == 0) - return Array.Empty(); - - IEnumerable contentTypes; - switch (itemType) - { - case PublishedItemType.Content: - contentTypes = _serviceContext.ContentTypeService.GetAll(ids); - break; - case PublishedItemType.Media: - contentTypes = _serviceContext.MediaTypeService.GetAll(ids); - break; - case PublishedItemType.Member: - contentTypes = _serviceContext.MemberTypeService.GetAll(ids); - break; - default: - throw new ArgumentOutOfRangeException(nameof(itemType)); - } - - // some may be missing - not checking here - - return contentTypes.Select(x => _publishedContentTypeFactory.CreateContentType(x)).ToList(); - } - - private IPublishedContentType CreateContentType(PublishedItemType itemType, int id) - { - IContentTypeComposition contentType; - switch (itemType) - { - case PublishedItemType.Content: - contentType = _serviceContext.ContentTypeService.Get(id); - break; - case PublishedItemType.Media: - contentType = _serviceContext.MediaTypeService.Get(id); - break; - case PublishedItemType.Member: - contentType = _serviceContext.MemberTypeService.Get(id); - break; - default: - throw new ArgumentOutOfRangeException(nameof(itemType)); - } - - return contentType == null ? null : _publishedContentTypeFactory.CreateContentType(contentType); - } - - private void RefreshContentTypesLocked(List removedIds, List refreshedIds, List otherIds, List newIds) - { - if (removedIds.IsCollectionEmpty() && refreshedIds.IsCollectionEmpty() && otherIds.IsCollectionEmpty() && newIds.IsCollectionEmpty()) - return; - - // locks: - // content (and content types) are read-locked while reading content - // contentStore is wlocked (so readable, only no new views) - // and it can be wlocked by 1 thread only at a time - - using (var scope = _scopeProvider.CreateScope()) - { - scope.ReadLock(Constants.Locks.ContentTypes); - - var typesA = refreshedIds.IsCollectionEmpty() - ? Array.Empty() - : CreateContentTypes(PublishedItemType.Content, refreshedIds.ToArray()).ToArray(); - - var kits = refreshedIds.IsCollectionEmpty() - ? Array.Empty() - : _dataSource.GetTypeContentSources(scope, refreshedIds).ToArray(); - - _contentStore.UpdateContentTypesLocked(removedIds, typesA, kits); - if (!otherIds.IsCollectionEmpty()) - _contentStore.UpdateContentTypesLocked(CreateContentTypes(PublishedItemType.Content, otherIds.ToArray())); - if (!newIds.IsCollectionEmpty()) - _contentStore.NewContentTypesLocked(CreateContentTypes(PublishedItemType.Content, newIds.ToArray())); - scope.Complete(); - } - } - - private void RefreshMediaTypesLocked(List removedIds, List refreshedIds, List otherIds, List newIds) - { - if (removedIds.IsCollectionEmpty() && refreshedIds.IsCollectionEmpty() && otherIds.IsCollectionEmpty() && newIds.IsCollectionEmpty()) - return; - - // locks: - // media (and content types) are read-locked while reading media - // mediaStore is wlocked (so readable, only no new views) - // and it can be wlocked by 1 thread only at a time - - using (var scope = _scopeProvider.CreateScope()) - { - scope.ReadLock(Constants.Locks.MediaTypes); - - var typesA = refreshedIds == null - ? Array.Empty() - : CreateContentTypes(PublishedItemType.Media, refreshedIds.ToArray()).ToArray(); - - var kits = refreshedIds == null - ? Array.Empty() - : _dataSource.GetTypeMediaSources(scope, refreshedIds).ToArray(); - - _mediaStore.UpdateContentTypesLocked(removedIds, typesA, kits); - if (!otherIds.IsCollectionEmpty()) - _mediaStore.UpdateContentTypesLocked(CreateContentTypes(PublishedItemType.Media, otherIds.ToArray()).ToArray()); - if (!newIds.IsCollectionEmpty()) - _mediaStore.NewContentTypesLocked(CreateContentTypes(PublishedItemType.Media, newIds.ToArray()).ToArray()); - scope.Complete(); - } - } - - #endregion - - #region Create, Get Published Snapshot - - private long _contentGen, _mediaGen, _domainGen; - private IAppCache _elementsCache; - - public override IPublishedSnapshot CreatePublishedSnapshot(string previewToken) - { - EnsureCaches(); - - // no cache, no joy - if (Volatile.Read(ref _isReady) == false) - { - throw new InvalidOperationException("The published snapshot service has not properly initialized."); - } - - var preview = previewToken.IsNullOrWhiteSpace() == false; - return new PublishedSnapshot(this, preview); - } - - // gets a new set of elements - // always creates a new set of elements, - // even though the underlying elements may not change (store snapshots) - public PublishedSnapshot.PublishedSnapshotElements GetElements(bool previewDefault) - { - EnsureCaches(); - - // note: using ObjectCacheAppCache for elements and snapshot caches - // is not recommended because it creates an inner MemoryCache which is a heavy - // thing - better use a dictionary-based cache which "just" creates a concurrent - // dictionary - - // for snapshot cache, DictionaryAppCache MAY be OK but it is not thread-safe, - // nothing like that... - // for elements cache, DictionaryAppCache is a No-No, use something better. - // ie FastDictionaryAppCache (thread safe and all) - - ContentStore.Snapshot contentSnap, mediaSnap; - SnapDictionary.Snapshot domainSnap; - IAppCache elementsCache; - - // Here we are reading/writing to shared objects so we need to lock (can't be _storesLock which manages the actual nucache files - // and would result in a deadlock). Even though we are locking around underlying readlocks (within CreateSnapshot) it's because - // we need to ensure that the result of contentSnap.Gen (etc) and the re-assignment of these values and _elements cache - // are done atomically. - - lock (_elementsLock) - { - var scopeContext = _scopeProvider.Context; - - if (scopeContext == null) - { - contentSnap = _contentStore.CreateSnapshot(); - mediaSnap = _mediaStore.CreateSnapshot(); - domainSnap = _domainStore.CreateSnapshot(); - elementsCache = _elementsCache; - } - else - { - contentSnap = _contentStore.LiveSnapshot; - mediaSnap = _mediaStore.LiveSnapshot; - domainSnap = _domainStore.Test.LiveSnapshot; - elementsCache = _elementsCache; - - // this is tricky - // we are returning elements composed from live snapshots, which we need to replace - // with actual snapshots when the context is gone - but when the action runs, there - // still is a context - so we cannot get elements - just resync = nulls the current - // elements - // just need to make sure nothing gets elements in another enlisted action... so using - // a MaxValue to make sure this one runs last, and it should be ok - - scopeContext.Enlist("Umbraco.Web.PublishedCache.NuCache.PublishedSnapshotService.Resync", () => this, (completed, svc) => - { - ((PublishedSnapshot)svc.CurrentPublishedSnapshot)?.Resync(); - }, int.MaxValue); - } - - - // create a new snapshot cache if snapshots are different gens - if (contentSnap.Gen != _contentGen || mediaSnap.Gen != _mediaGen || domainSnap.Gen != _domainGen || _elementsCache == null) - { - _contentGen = contentSnap.Gen; - _mediaGen = mediaSnap.Gen; - _domainGen = domainSnap.Gen; - elementsCache = _elementsCache = new FastDictionaryAppCache(); - } - } - - var snapshotCache = new DictionaryAppCache(); - - var memberTypeCache = new PublishedContentTypeCache(null, null, _serviceContext.MemberTypeService, _publishedContentTypeFactory, _logger); - - var defaultCulture = _defaultCultureAccessor.DefaultCulture; - var domainCache = new DomainCache(domainSnap, defaultCulture); - - return new PublishedSnapshot.PublishedSnapshotElements - { - ContentCache = new ContentCache(previewDefault, contentSnap, snapshotCache, elementsCache, domainCache, _globalSettings, VariationContextAccessor), - MediaCache = new MediaCache(previewDefault, mediaSnap, VariationContextAccessor), - MemberCache = new MemberCache(previewDefault, snapshotCache, _serviceContext.MemberService, memberTypeCache, PublishedSnapshotAccessor, VariationContextAccessor, _entitySerializer), - DomainCache = domainCache, - SnapshotCache = snapshotCache, - ElementsCache = elementsCache - }; - } - - #endregion - - #region Preview - - public override string EnterPreview(IUser user, int contentId) - { - return "preview"; // anything - } - - public override void RefreshPreview(string previewToken, int contentId) - { - // nothing - } - - public override void ExitPreview(string previewToken) - { - // nothing - } - - #endregion - - #region Handle Repository Events For Database PreCache - - // note: if the service is not ready, ie _isReady is false, then we still handle repository events, - // because we can, we do not need a working published snapshot to do it - the only reason why it could cause an - // issue is if the database table is not ready, but that should be prevented by migrations. - - // we need them to be "repository" events ie to trigger from within the repository transaction, - // because they need to be consistent with the content that is being refreshed/removed - and that - // should be guaranteed by a DB transaction - - private void OnContentRemovingEntity(DocumentRepository sender, DocumentRepository.ScopedEntityEventArgs args) - { - OnRemovedEntity(args.Scope.Database, args.Entity); - } - - private void OnMediaRemovingEntity(MediaRepository sender, MediaRepository.ScopedEntityEventArgs args) - { - OnRemovedEntity(args.Scope.Database, args.Entity); - } - - private void OnMemberRemovingEntity(MemberRepository sender, MemberRepository.ScopedEntityEventArgs args) - { - OnRemovedEntity(args.Scope.Database, args.Entity); - } - - private void OnRemovedEntity(IUmbracoDatabase db, IContentBase item) - { - db.Execute("DELETE FROM cmsContentNu WHERE nodeId=@id", new { id = item.Id }); - } - - private void OnContentRefreshedEntity(DocumentRepository sender, DocumentRepository.ScopedEntityEventArgs args) - { - var db = args.Scope.Database; - var content = (Content)args.Entity; - - var serializer = _contentCacheDataSerializerFactory.Create(ContentCacheDataSerializerEntityType.Document); - - // always refresh the edited data - OnRepositoryRefreshed(serializer, db, content, false); - - // if unpublishing, remove published data from table - if (content.PublishedState == PublishedState.Unpublishing) - db.Execute("DELETE FROM cmsContentNu WHERE nodeId=@id AND published=1", new { id = content.Id }); - - // if publishing, refresh the published data - else if (content.PublishedState == PublishedState.Publishing) - OnRepositoryRefreshed(serializer, db, content, true); - } - - private void OnMediaRefreshedEntity(MediaRepository sender, MediaRepository.ScopedEntityEventArgs args) - { - var serializer = _contentCacheDataSerializerFactory.Create(ContentCacheDataSerializerEntityType.Media); - - var db = args.Scope.Database; - var media = args.Entity; - - // refresh the edited data - OnRepositoryRefreshed(serializer, db, media, false); - } - - private void OnMemberRefreshedEntity(MemberRepository sender, MemberRepository.ScopedEntityEventArgs args) - { - var serializer = _contentCacheDataSerializerFactory.Create(ContentCacheDataSerializerEntityType.Member); - - var db = args.Scope.Database; - var member = args.Entity; - - // refresh the edited data - OnRepositoryRefreshed(serializer, db, member, false); - } - - private void OnRepositoryRefreshed(IContentCacheDataSerializer serializer, IUmbracoDatabase db, IContentBase content, bool published) - { - // use a custom SQL to update row version on each update - //db.InsertOrUpdate(dto); - - var dto = GetDto(content, published, serializer); - db.InsertOrUpdate(dto, - "SET data=@data, dataRaw=@dataRaw, rv=rv+1 WHERE nodeId=@id AND published=@published", - new - { - dataRaw = dto.RawData ?? Array.Empty(), - data = dto.Data, - id = dto.NodeId, - published = dto.Published - }); - } - - private void OnContentTypeRefreshedEntity(IContentTypeService sender, ContentTypeChange.EventArgs args) - { - const ContentTypeChangeTypes types // only for those that have been refreshed - = ContentTypeChangeTypes.RefreshMain | ContentTypeChangeTypes.RefreshOther; - var contentTypeIds = args.Changes.Where(x => x.ChangeTypes.HasTypesAny(types)).Select(x => x.Item.Id).ToArray(); - if (contentTypeIds.Any()) - RebuildContentDbCache(contentTypeIds: contentTypeIds); - } - - private void OnMediaTypeRefreshedEntity(IMediaTypeService sender, ContentTypeChange.EventArgs args) - { - const ContentTypeChangeTypes types // only for those that have been refreshed - = ContentTypeChangeTypes.RefreshMain | ContentTypeChangeTypes.RefreshOther; - var mediaTypeIds = args.Changes.Where(x => x.ChangeTypes.HasTypesAny(types)).Select(x => x.Item.Id).ToArray(); - if (mediaTypeIds.Any()) - RebuildMediaDbCache(contentTypeIds: mediaTypeIds); - } - - private void OnMemberTypeRefreshedEntity(IMemberTypeService sender, ContentTypeChange.EventArgs args) - { - const ContentTypeChangeTypes types // only for those that have been refreshed - = ContentTypeChangeTypes.RefreshMain | ContentTypeChangeTypes.RefreshOther; - var memberTypeIds = args.Changes.Where(x => x.ChangeTypes.HasTypesAny(types)).Select(x => x.Item.Id).ToArray(); - if (memberTypeIds.Any()) - RebuildMemberDbCache(contentTypeIds: memberTypeIds); - } - - /// - /// If a is ever saved with a different culture, we need to rebuild all of the content nucache table - /// - /// - /// - private void OnLanguageSaved(ILocalizationService sender, Core.Events.SaveEventArgs e) - { - //culture changed on an existing language - var cultureChanged = e.SavedEntities.Any(x => !x.WasPropertyDirty(nameof(ILanguage.Id)) && x.WasPropertyDirty(nameof(ILanguage.IsoCode))); - if (cultureChanged) - { - RebuildContentDbCache(); - } - } - - private ContentNuDto GetDto(IContentBase content, bool published, IContentCacheDataSerializer serializer) - { - // should inject these in ctor - // BUT for the time being we decide not to support ConvertDbToXml/String - //var propertyEditorResolver = PropertyEditorResolver.Current; - //var dataTypeService = ApplicationContext.Current.Services.DataTypeService; - - var propertyData = new Dictionary(); - foreach (var prop in content.Properties) - { - var pdatas = new List(); - foreach (var pvalue in prop.Values) - { - // sanitize - properties should be ok but ... never knows - if (!prop.PropertyType.SupportsVariation(pvalue.Culture, pvalue.Segment)) - continue; - - // note: at service level, invariant is 'null', but here invariant becomes 'string.Empty' - var value = published ? pvalue.PublishedValue : pvalue.EditedValue; - if (value != null) - pdatas.Add(new PropertyData { Culture = pvalue.Culture ?? string.Empty, Segment = pvalue.Segment ?? string.Empty, Value = value }); - - //Core.Composing.Current.Logger.Debug($"{content.Id} {prop.Alias} [{pvalue.LanguageId},{pvalue.Segment}] {value} {(published?"pub":"edit")}"); - - //if (value != null) - //{ - // var e = propertyEditorResolver.GetByAlias(prop.PropertyType.PropertyEditorAlias); - - // // We are converting to string, even for database values which are integer or - // // DateTime, which is not optimum. Doing differently would require that we have a way to tell - // // whether the conversion to XML string changes something or not... which we don't, and we - // // don't want to implement it as PropertyValueEditor.ConvertDbToXml/String should die anyway. - - // // Don't think about improving the situation here: this is a corner case and the real - // // thing to do is to get rig of PropertyValueEditor.ConvertDbToXml/String. - - // // Use ConvertDbToString to keep it simple, although everywhere we use ConvertDbToXml and - // // nothing ensures that the two methods are consistent. - - // if (e != null) - // value = e.ValueEditor.ConvertDbToString(prop, prop.PropertyType, dataTypeService); - //} - } - propertyData[prop.Alias] = pdatas.ToArray(); - } - - var cultureData = new Dictionary(); - - // sanitize - names should be ok but ... never knows - if (content.ContentType.VariesByCulture()) - { - var infos = content is IContent document - ? (published - ? document.PublishCultureInfos - : document.CultureInfos) - : content.CultureInfos; - - // ReSharper disable once UseDeconstruction - foreach (var cultureInfo in infos) - { - var cultureIsDraft = !published && content is IContent d && d.IsCultureEdited(cultureInfo.Culture); - cultureData[cultureInfo.Culture] = new CultureVariation - { - Name = cultureInfo.Name, - UrlSegment = content.GetUrlSegment(_urlSegmentProviders, cultureInfo.Culture), - Date = content.GetUpdateDate(cultureInfo.Culture) ?? DateTime.MinValue, - IsDraft = cultureIsDraft - }; - } - } - - //the dictionary that will be serialized - var contentCacheData = new ContentCacheDataModel - { - PropertyData = propertyData, - CultureData = cultureData, - UrlSegment = content.GetUrlSegment(_urlSegmentProviders) - }; - - var serialized = serializer.Serialize(ReadOnlyContentBaseAdapter.Create(content), contentCacheData); - - var dto = new ContentNuDto - { - NodeId = content.Id, - Published = published, - Data = serialized.StringData, - RawData = serialized.ByteData - }; - - //Core.Composing.Current.Logger.Debug(dto.Data); - - return dto; - } - - #endregion - - #region Rebuild Database PreCache - - private const int DefaultSqlPagingSize = 1000; - - private static int GetSqlPagingSize() - { - var appSetting = ConfigurationManager.AppSettings["Umbraco.Web.PublishedCache.NuCache.PublishedSnapshotService.SqlPageSize"]; - return appSetting != null && int.TryParse(appSetting, out var size) ? size : DefaultSqlPagingSize; - } - - public override void Rebuild() - { - _logger.Debug("Rebuilding..."); - var serializer = _contentCacheDataSerializerFactory.Create(ContentCacheDataSerializerEntityType.Document | ContentCacheDataSerializerEntityType.Media | ContentCacheDataSerializerEntityType.Member); - using (var scope = _scopeProvider.CreateScope(repositoryCacheMode: RepositoryCacheMode.Scoped)) - { - scope.ReadLock(Constants.Locks.ContentTree); - scope.ReadLock(Constants.Locks.MediaTree); - scope.ReadLock(Constants.Locks.MemberTree); - - var groupSize = GetSqlPagingSize(); - - RebuildContentDbCacheLocked(serializer, scope, groupSize, null); - RebuildMediaDbCacheLocked(serializer, scope, groupSize, null); - RebuildMemberDbCacheLocked(serializer, scope, groupSize, null); - scope.Complete(); - } - } - - public void RebuildContentDbCache(int groupSize = DefaultSqlPagingSize, IEnumerable contentTypeIds = null) - { - var serializer = _contentCacheDataSerializerFactory.Create(ContentCacheDataSerializerEntityType.Document); - using (var scope = _scopeProvider.CreateScope(repositoryCacheMode: RepositoryCacheMode.Scoped)) - { - scope.ReadLock(Constants.Locks.ContentTree); - RebuildContentDbCacheLocked(serializer, scope, groupSize, contentTypeIds); - scope.Complete(); - } - } - - // assumes content tree lock - private void RebuildContentDbCacheLocked(IContentCacheDataSerializer serializer, IScope scope, int groupSize, IEnumerable contentTypeIds) - { - var contentTypeIdsA = contentTypeIds?.ToArray(); - var contentObjectType = Constants.ObjectTypes.Document; - var db = scope.Database; - - // remove all - if anything fails the transaction will rollback - if (contentTypeIds == null || contentTypeIdsA.Length == 0) - { - // must support SQL-CE - db.Execute(@"DELETE FROM cmsContentNu -WHERE cmsContentNu.nodeId IN ( - SELECT id FROM umbracoNode WHERE umbracoNode.nodeObjectType=@objType -)", - new { objType = contentObjectType }); - } - else - { - // assume number of ctypes won't blow IN(...) - // must support SQL-CE - db.Execute($@"DELETE FROM cmsContentNu -WHERE cmsContentNu.nodeId IN ( - SELECT id FROM umbracoNode - JOIN {Constants.DatabaseSchema.Tables.Content} ON {Constants.DatabaseSchema.Tables.Content}.nodeId=umbracoNode.id - WHERE umbracoNode.nodeObjectType=@objType - AND {Constants.DatabaseSchema.Tables.Content}.contentTypeId IN (@ctypes) -)", - new { objType = contentObjectType, ctypes = contentTypeIdsA }); - } - - // insert back - if anything fails the transaction will rollback - var query = scope.SqlContext.Query(); - if (contentTypeIds != null && contentTypeIdsA.Length > 0) - query = query.WhereIn(x => x.ContentTypeId, contentTypeIdsA); // assume number of ctypes won't blow IN(...) - - long pageIndex = 0; - long processed = 0; - long total; - do - { - // the tree is locked, counting and comparing to total is safe - var descendants = _documentRepository.GetPage(query, pageIndex++, groupSize, out total, null, Ordering.By("Path")); - var items = new List(); - var count = 0; - foreach (var c in descendants) - { - // always the edited version - items.Add(GetDto(c, false, serializer)); - - // and also the published version if it makes any sense - if (c.Published) - items.Add(GetDto(c, true, serializer)); - - count++; - } - - db.BulkInsertRecords(items); - processed += count; - } while (processed < total); - } - - public void RebuildMediaDbCache(int groupSize = DefaultSqlPagingSize, IEnumerable contentTypeIds = null) - { - var serializer = _contentCacheDataSerializerFactory.Create(ContentCacheDataSerializerEntityType.Media); - using (var scope = _scopeProvider.CreateScope(repositoryCacheMode: RepositoryCacheMode.Scoped)) - { - scope.ReadLock(Constants.Locks.MediaTree); - RebuildMediaDbCacheLocked(serializer, scope, groupSize, contentTypeIds); - scope.Complete(); - } - } - - // assumes media tree lock - public void RebuildMediaDbCacheLocked(IContentCacheDataSerializer serializer, IScope scope, int groupSize, IEnumerable contentTypeIds) - { - var contentTypeIdsA = contentTypeIds?.ToArray(); - var mediaObjectType = Constants.ObjectTypes.Media; - var db = scope.Database; - - // remove all - if anything fails the transaction will rollback - if (contentTypeIds == null || contentTypeIdsA.Length == 0) - { - // must support SQL-CE - db.Execute(@"DELETE FROM cmsContentNu -WHERE cmsContentNu.nodeId IN ( - SELECT id FROM umbracoNode WHERE umbracoNode.nodeObjectType=@objType -)", - new { objType = mediaObjectType }); - } - else - { - // assume number of ctypes won't blow IN(...) - // must support SQL-CE - db.Execute($@"DELETE FROM cmsContentNu -WHERE cmsContentNu.nodeId IN ( - SELECT id FROM umbracoNode - JOIN {Constants.DatabaseSchema.Tables.Content} ON {Constants.DatabaseSchema.Tables.Content}.nodeId=umbracoNode.id - WHERE umbracoNode.nodeObjectType=@objType - AND {Constants.DatabaseSchema.Tables.Content}.contentTypeId IN (@ctypes) -)", - new { objType = mediaObjectType, ctypes = contentTypeIdsA }); - } - - // insert back - if anything fails the transaction will rollback - var query = scope.SqlContext.Query(); - if (contentTypeIds != null && contentTypeIdsA.Length > 0) - query = query.WhereIn(x => x.ContentTypeId, contentTypeIdsA); // assume number of ctypes won't blow IN(...) - - long pageIndex = 0; - long processed = 0; - long total; - do - { - // the tree is locked, counting and comparing to total is safe - var descendants = _mediaRepository.GetPage(query, pageIndex++, groupSize, out total, null, Ordering.By("Path")); - var items = descendants.Select(m => GetDto(m, false, serializer)).ToList(); - db.BulkInsertRecords(items); - processed += items.Count; - } while (processed < total); - } - - public void RebuildMemberDbCache(int groupSize = DefaultSqlPagingSize, IEnumerable contentTypeIds = null) - { - var serializer = _contentCacheDataSerializerFactory.Create(ContentCacheDataSerializerEntityType.Member); - using (var scope = _scopeProvider.CreateScope(repositoryCacheMode: RepositoryCacheMode.Scoped)) - { - scope.ReadLock(Constants.Locks.MemberTree); - RebuildMemberDbCacheLocked(serializer, scope, groupSize, contentTypeIds); - scope.Complete(); - } - } - - // assumes member tree lock - public void RebuildMemberDbCacheLocked(IContentCacheDataSerializer serializer, IScope scope, int groupSize, IEnumerable contentTypeIds) - { - var contentTypeIdsA = contentTypeIds?.ToArray(); - var memberObjectType = Constants.ObjectTypes.Member; - var db = scope.Database; - - // remove all - if anything fails the transaction will rollback - if (contentTypeIds == null || contentTypeIdsA.Length == 0) - { - // must support SQL-CE - db.Execute(@"DELETE FROM cmsContentNu -WHERE cmsContentNu.nodeId IN ( - SELECT id FROM umbracoNode WHERE umbracoNode.nodeObjectType=@objType -)", - new { objType = memberObjectType }); - } - else - { - // assume number of ctypes won't blow IN(...) - // must support SQL-CE - db.Execute($@"DELETE FROM cmsContentNu -WHERE cmsContentNu.nodeId IN ( - SELECT id FROM umbracoNode - JOIN {Constants.DatabaseSchema.Tables.Content} ON {Constants.DatabaseSchema.Tables.Content}.nodeId=umbracoNode.id - WHERE umbracoNode.nodeObjectType=@objType - AND {Constants.DatabaseSchema.Tables.Content}.contentTypeId IN (@ctypes) -)", - new { objType = memberObjectType, ctypes = contentTypeIdsA }); - } - - // insert back - if anything fails the transaction will rollback - var query = scope.SqlContext.Query(); - if (contentTypeIds != null && contentTypeIdsA.Length > 0) - query = query.WhereIn(x => x.ContentTypeId, contentTypeIdsA); // assume number of ctypes won't blow IN(...) - - long pageIndex = 0; - long processed = 0; - long total; - do - { - var descendants = _memberRepository.GetPage(query, pageIndex++, groupSize, out total, null, Ordering.By("Path")); - var items = descendants.Select(m => GetDto(m, false, serializer)).ToArray(); - db.BulkInsertRecords(items); - processed += items.Length; - } while (processed < total); - } - - public bool VerifyContentDbCache() - { - using (var scope = _scopeProvider.CreateScope()) - { - scope.ReadLock(Constants.Locks.ContentTree); - var ok = VerifyContentDbCacheLocked(scope); - scope.Complete(); - return ok; - } - } - - // assumes content tree lock - private bool VerifyContentDbCacheLocked(IScope scope) - { - // every document should have a corresponding row for edited properties - // and if published, may have a corresponding row for published properties - - var contentObjectType = Constants.ObjectTypes.Document; - var db = scope.Database; - - var count = db.ExecuteScalar($@"SELECT COUNT(*) -FROM umbracoNode -JOIN {Constants.DatabaseSchema.Tables.Document} ON umbracoNode.id={Constants.DatabaseSchema.Tables.Document}.nodeId -LEFT JOIN cmsContentNu nuEdited ON (umbracoNode.id=nuEdited.nodeId AND nuEdited.published=0) -LEFT JOIN cmsContentNu nuPublished ON (umbracoNode.id=nuPublished.nodeId AND nuPublished.published=1) -WHERE umbracoNode.nodeObjectType=@objType -AND nuEdited.nodeId IS NULL OR ({Constants.DatabaseSchema.Tables.Document}.published=1 AND nuPublished.nodeId IS NULL);" - , new { objType = contentObjectType }); - - return count == 0; - } - - public bool VerifyMediaDbCache() - { - using (var scope = _scopeProvider.CreateScope()) - { - scope.ReadLock(Constants.Locks.MediaTree); - var ok = VerifyMediaDbCacheLocked(scope); - scope.Complete(); - return ok; - } - } - - // assumes media tree lock - public bool VerifyMediaDbCacheLocked(IScope scope) - { - // every media item should have a corresponding row for edited properties - - var mediaObjectType = Constants.ObjectTypes.Media; - var db = scope.Database; - - var count = db.ExecuteScalar(@"SELECT COUNT(*) -FROM umbracoNode -LEFT JOIN cmsContentNu ON (umbracoNode.id=cmsContentNu.nodeId AND cmsContentNu.published=0) -WHERE umbracoNode.nodeObjectType=@objType -AND cmsContentNu.nodeId IS NULL -", new { objType = mediaObjectType }); - - return count == 0; - } - - public bool VerifyMemberDbCache() - { - using (var scope = _scopeProvider.CreateScope()) - { - scope.ReadLock(Constants.Locks.MemberTree); - var ok = VerifyMemberDbCacheLocked(scope); - scope.Complete(); - return ok; - } - } - - // assumes member tree lock - public bool VerifyMemberDbCacheLocked(IScope scope) - { - // every member item should have a corresponding row for edited properties - - var memberObjectType = Constants.ObjectTypes.Member; - var db = scope.Database; - - var count = db.ExecuteScalar(@"SELECT COUNT(*) -FROM umbracoNode -LEFT JOIN cmsContentNu ON (umbracoNode.id=cmsContentNu.nodeId AND cmsContentNu.published=0) -WHERE umbracoNode.nodeObjectType=@objType -AND cmsContentNu.nodeId IS NULL -", new { objType = memberObjectType }); - - return count == 0; - } - - #endregion - - #region Instrument - - public string GetStatus() - { - var dbCacheIsOk = VerifyContentDbCache() - && VerifyMediaDbCache() - && VerifyMemberDbCache(); - - var cg = _contentStore.GenCount; - var mg = _mediaStore.GenCount; - var cs = _contentStore.SnapCount; - var ms = _mediaStore.SnapCount; - var ce = _contentStore.Count; - var me = _mediaStore.Count; - - return - " Database cache is " + (dbCacheIsOk ? "ok" : "NOT ok (rebuild?)") + "." + - " ContentStore contains " + ce + " item" + (ce > 1 ? "s" : "") + - " and has " + cg + " generation" + (cg > 1 ? "s" : "") + - " and " + cs + " snapshot" + (cs > 1 ? "s" : "") + "." + - " MediaStore contains " + me + " item" + (ce > 1 ? "s" : "") + - " and has " + mg + " generation" + (mg > 1 ? "s" : "") + - " and " + ms + " snapshot" + (ms > 1 ? "s" : "") + "."; - } - - public void Collect() - { - EnsureCaches(); - - var contentCollect = _contentStore.CollectAsync(); - var mediaCollect = _mediaStore.CollectAsync(); - System.Threading.Tasks.Task.WaitAll(contentCollect, mediaCollect); - } - - #endregion - - #region Internals/Testing - - internal ContentStore GetContentStore() - { - EnsureCaches(); - return _contentStore; - } - - internal ContentStore GetMediaStore() - { - EnsureCaches(); - return _mediaStore; - } - - #endregion - } -} diff --git a/src/Umbraco.Web/Search/IUmbracoTreeSearcherFields2.cs b/src/Umbraco.Web/Search/IUmbracoTreeSearcherFields2.cs deleted file mode 100644 index da0cd26644..0000000000 --- a/src/Umbraco.Web/Search/IUmbracoTreeSearcherFields2.cs +++ /dev/null @@ -1,30 +0,0 @@ -using System.Collections.Generic; - -namespace Umbraco.Web.Search -{ - // TODO: Merge this interface to IUmbracoTreeSearcherFields for v9. - // We should probably make these method make a little more sense when they are combined so have - // a single method for getting fields to search and fields to load for each category. - public interface IUmbracoTreeSearcherFields2 : IUmbracoTreeSearcherFields - { - /// - /// Set of fields for all node types to be loaded - /// - ISet GetBackOfficeFieldsToLoad(); - - /// - /// Additional set list of fields for Members to be loaded - /// - ISet GetBackOfficeMembersFieldsToLoad(); - - /// - /// Additional set of fields for Media to be loaded - /// - ISet GetBackOfficeMediaFieldsToLoad(); - - /// - /// Additional set of fields for Documents to be loaded - /// - ISet GetBackOfficeDocumentFieldsToLoad(); - } -} diff --git a/src/Umbraco.Web/Umbraco.Web.csproj b/src/Umbraco.Web/Umbraco.Web.csproj index 1b278634d1..f7f18b52ff 100644 --- a/src/Umbraco.Web/Umbraco.Web.csproj +++ b/src/Umbraco.Web/Umbraco.Web.csproj @@ -108,7 +108,7 @@ all - + 3.5.4 @@ -134,6 +134,10 @@ {33085570-9bf2-4065-a9b0-a29d920d13ba} Umbraco.Persistence.SqlCe + + {f6de8da0-07cc-4ef2-8a59-2bc81dbb3830} + Umbraco.PublishedCache.NuCache + @@ -157,160 +161,6 @@ - - Properties\SolutionInfo.cs - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -319,55 +169,7 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -381,242 +183,6 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -634,21 +200,6 @@ - - - - - - - - - - - - - - - @@ -715,21 +266,5 @@ + - - - $(PlatformTargetAsMSBuildArchitecture) - - - - - - - - - - - - \ No newline at end of file diff --git a/src/umbraco.sln b/src/umbraco.sln index a1e714c79a..6214deed2b 100644 --- a/src/umbraco.sln +++ b/src/umbraco.sln @@ -156,6 +156,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Umbraco.Tests.UnitTests", " EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Umbraco.Web.Common", "Umbraco.Web.Common\Umbraco.Web.Common.csproj", "{79E4293D-C92C-4649-AEC8-F1EFD95BDEB1}" EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "JsonSchema", "JsonSchema\JsonSchema.csproj", "{2A5027D9-F71D-4957-929E-F7A56AA1B95A}" +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU @@ -222,6 +224,10 @@ Global {79E4293D-C92C-4649-AEC8-F1EFD95BDEB1}.Debug|Any CPU.Build.0 = Debug|Any CPU {79E4293D-C92C-4649-AEC8-F1EFD95BDEB1}.Release|Any CPU.ActiveCfg = Release|Any CPU {79E4293D-C92C-4649-AEC8-F1EFD95BDEB1}.Release|Any CPU.Build.0 = Release|Any CPU + {2A5027D9-F71D-4957-929E-F7A56AA1B95A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {2A5027D9-F71D-4957-929E-F7A56AA1B95A}.Debug|Any CPU.Build.0 = Debug|Any CPU + {2A5027D9-F71D-4957-929E-F7A56AA1B95A}.Release|Any CPU.ActiveCfg = Release|Any CPU + {2A5027D9-F71D-4957-929E-F7A56AA1B95A}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE