yv01p/Umbraco-CMS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added configuration validation for content imaging settings.

Browse Source
This commit is contained in:
Andy Butland
2020-09-18 12:02:12 +02:00
parent 1f8d7f18be
commit eb62789b68
8 changed files with 77 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/Umbraco.Core/Configuration/ContentSettingsExtensions.cs
View File

@@ -39,7 +39,7 @@ namespace Umbraco.Core.Configuration
/// <param name="contentSettings"></param>
/// <param name="propertyTypeAlias">The property type alias.</param>
/// <returns>The auto-fill configuration for the specified property alias, or null.</returns>
public static IImagingAutoFillUploadField GetConfig(this ContentSettings contentSettings, string propertyTypeAlias)
public static ImagingAutoFillUploadField GetConfig(this ContentSettings contentSettings, string propertyTypeAlias)
{
var autoFillConfigs = contentSettings.Imaging.AutoFillImageProperties;
return autoFillConfigs?.FirstOrDefault(x => x.Alias == propertyTypeAlias);

10
src/Umbraco.Core/Configuration/Models/ContentErrorPage.cs
View File

@@ -1,8 +1,10 @@
using System;
using System.ComponentModel.DataAnnotations;
using Umbraco.Core.Configuration.Models.Validation;
namespace Umbraco.Core.Configuration.Models
{
public class ContentErrorPage
public class ContentErrorPage : ValidatableEntryBase
{
public int ContentId { get; set; }
@@ -16,12 +18,12 @@ namespace Umbraco.Core.Configuration.Models
public bool HasContentXPath => !string.IsNullOrEmpty(ContentXPath);
[Required]
public string Culture { get; set; }
public bool IsValid()
internal override bool IsValid()
{
// Entry is valid if Culture and one and only one of ContentId, ContentKey or ContentXPath is provided.
return !string.IsNullOrWhiteSpace(Culture) &&
return base.IsValid() &&
((HasContentId ? 1 : 0) + (HasContentKey ? 1 : 0) + (HasContentXPath ? 1 : 0) == 1);
}
}

22
src/Umbraco.Core/Configuration/Models/ContentImagingSettings.cs
View File

@@ -1,7 +1,4 @@
using System.Collections.Generic;
using Umbraco.Core.Configuration.UmbracoSettings;
namespace Umbraco.Core.Configuration.Models
namespace Umbraco.Core.Configuration.Models
{
public class ContentImagingSettings
{
@@ -17,21 +14,8 @@ namespace Umbraco.Core.Configuration.Models
}
};
public IEnumerable<string> ImageFileTypes { get; set; } = new[] { "jpeg", "jpg", "gif", "bmp", "png", "tiff", "tif" };
public string[] ImageFileTypes { get; set; } = new[] { "jpeg", "jpg", "gif", "bmp", "png", "tiff", "tif" };
public IEnumerable<IImagingAutoFillUploadField> AutoFillImageProperties { get; set; } = DefaultImagingAutoFillUploadField;
private class ImagingAutoFillUploadField : IImagingAutoFillUploadField
{
public string Alias { get; set; }
public string WidthFieldAlias { get; set; }
public string HeightFieldAlias { get; set; }
public string LengthFieldAlias { get; set; }
public string ExtensionFieldAlias { get; set; }
}
public ImagingAutoFillUploadField[] AutoFillImageProperties { get; set; } = DefaultImagingAutoFillUploadField;
}
}

23
src/Umbraco.Core/Configuration/Models/ImagingAutoFillUploadField.cs Normal file
View File

@@ -0,0 +1,23 @@
using System.ComponentModel.DataAnnotations;
using Umbraco.Core.Configuration.Models.Validation;
namespace Umbraco.Core.Configuration.Models
{
public class ImagingAutoFillUploadField : ValidatableEntryBase
{
[Required]
public string Alias { get; set; }
[Required]
public string WidthFieldAlias { get; set; }
[Required]
public string HeightFieldAlias { get; set; }
[Required]
public string LengthFieldAlias { get; set; }
[Required]
public string ExtensionFieldAlias { get; set; }
}
}

12
src/Umbraco.Core/Configuration/Models/Validation/ConfigurationValidationBase.cs
View File

@@ -23,5 +23,17 @@ namespace Umbraco.Core.Configuration.Models.Validation
var validValues = Enum.GetValues(enumType).OfType<object>().Select(x => x.ToString().ToFirstLowerInvariant());
return ValidateStringIsOneOfValidValues(configPath, value, validValues, out message);
}
public bool ValidateCollection(string configPath, IEnumerable<ValidatableEntryBase> values, string validationDescription, out string message)
{
if (values.Any(x => !x.IsValid()))
{
message = $"Configuration entry {configPath} contains one or more invalid values. {validationDescription}.";
return false;
}
message = string.Empty;
return true;
}
}
}

20
src/Umbraco.Core/Configuration/Models/Validation/ContentSettingsValidation.cs
View File

@@ -1,4 +1,5 @@
using System.Collections.Generic;
using System;
using System.Collections.Generic;
using System.Linq;
using Microsoft.Extensions.Options;
using Umbraco.Core.Macros;
@@ -20,6 +21,11 @@ namespace Umbraco.Core.Configuration.Models.Validation
return ValidateOptionsResult.Fail(message);
}
if (!ValidateAutoFillImageProperties(options.Imaging.AutoFillImageProperties, out message))
{
return ValidateOptionsResult.Fail(message);
}
return ValidateOptionsResult.Success;
}
@@ -30,14 +36,12 @@ namespace Umbraco.Core.Configuration.Models.Validation
private bool ValidateError404Collection(IEnumerable<ContentErrorPage> values, out string message)
{
if (values.Any(x => !x.IsValid()))
{
message = $"Configuration entry Content:Error404Collection contains one or more invalid values. Culture and one and only one of ContentId, ContentKey and ContentXPath must be specified for each entry.";
return false;
}
return ValidateCollection("Content:Error404Collection", values, "Culture and one and only one of ContentId, ContentKey and ContentXPath must be specified for each entry", out message);
}
message = string.Empty;
return true;
private bool ValidateAutoFillImageProperties(IEnumerable<ImagingAutoFillUploadField> values, out string message)
{
return ValidateCollection("Content:Imaging:AutoFillImageProperties", values, "Alias, WidthFieldAlias, HeightFieldAlias, LengthFieldAlias and ExtensionFieldAlias must be specified for each entry", out message);
}
}
}

15
src/Umbraco.Core/Configuration/Models/Validation/ValidatableEntryBase.cs Normal file
View File

@@ -0,0 +1,15 @@
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
namespace Umbraco.Core.Configuration.Models.Validation
{
public abstract class ValidatableEntryBase
{
internal virtual bool IsValid()
{
var ctx = new ValidationContext(this);
var results = new List<ValidationResult>();
return Validator.TryValidateObject(this, ctx, results, true);
}
}
}

11
src/Umbraco.Infrastructure/Media/UploadAutoFillProperties.cs
View File

@@ -5,7 +5,6 @@ using Microsoft.Extensions.Options;
using Umbraco.Core;
using Umbraco.Core.Configuration;
using Umbraco.Core.Configuration.Models;
using Umbraco.Core.Configuration.UmbracoSettings;
using Umbraco.Core.IO;
using Umbraco.Core.Logging;
using Umbraco.Core.Models;
@@ -38,7 +37,7 @@ namespace Umbraco.Web.Media
/// <param name="autoFillConfig">The auto-fill configuration.</param>
/// <param name="culture">Variation language.</param>
/// <param name="segment">Variation segment.</param>
public void Reset(IContentBase content, IImagingAutoFillUploadField autoFillConfig, string culture, string segment)
public void Reset(IContentBase content, ImagingAutoFillUploadField autoFillConfig, string culture, string segment)
{
if (content == null) throw new ArgumentNullException(nameof(content));
if (autoFillConfig == null) throw new ArgumentNullException(nameof(autoFillConfig));
@@ -55,7 +54,7 @@ namespace Umbraco.Web.Media
/// <remarks>The <paramref name="filepath"/> parameter is the path relative to the filesystem.</remarks>
/// <param name="culture">Variation language.</param>
/// <param name="segment">Variation segment.</param>
public void Populate(IContentBase content, IImagingAutoFillUploadField autoFillConfig, string filepath, string culture, string segment)
public void Populate(IContentBase content, ImagingAutoFillUploadField autoFillConfig, string filepath, string culture, string segment)
{
if (content == null) throw new ArgumentNullException(nameof(content));
if (autoFillConfig == null) throw new ArgumentNullException(nameof(autoFillConfig));
@@ -94,7 +93,7 @@ namespace Umbraco.Web.Media
/// <param name="filestream">The stream containing the file data.</param>
/// <param name="culture">Variation language.</param>
/// <param name="segment">Variation segment.</param>
public void Populate(IContentBase content, IImagingAutoFillUploadField autoFillConfig, string filepath, Stream filestream, string culture, string segment)
public void Populate(IContentBase content, ImagingAutoFillUploadField autoFillConfig, string filepath, Stream filestream, string culture, string segment)
{
if (content == null) throw new ArgumentNullException(nameof(content));
if (autoFillConfig == null) throw new ArgumentNullException(nameof(autoFillConfig));
@@ -112,7 +111,7 @@ namespace Umbraco.Web.Media
}
}
private static void SetProperties(IContentBase content, IImagingAutoFillUploadField autoFillConfig, Size? size, long length, string extension, string culture, string segment)
private static void SetProperties(IContentBase content, ImagingAutoFillUploadField autoFillConfig, Size? size, long length, string extension, string culture, string segment)
{
if (content == null) throw new ArgumentNullException(nameof(content));
if (autoFillConfig == null) throw new ArgumentNullException(nameof(autoFillConfig));
@@ -130,7 +129,7 @@ namespace Umbraco.Web.Media
content.Properties[autoFillConfig.ExtensionFieldAlias].SetValue(extension, culture, segment);
}
private static void ResetProperties(IContentBase content, IImagingAutoFillUploadField autoFillConfig, string culture, string segment)
private static void ResetProperties(IContentBase content, ImagingAutoFillUploadField autoFillConfig, string culture, string segment)
{
if (content == null) throw new ArgumentNullException(nameof(content));
if (autoFillConfig == null) throw new ArgumentNullException(nameof(autoFillConfig));