101 lines
3.7 KiB
C#
101 lines
3.7 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
using System.Linq;
|
|
using Examine;
|
|
using Examine.LuceneEngine.Providers;
|
|
using Umbraco.Core;
|
|
|
|
namespace Umbraco.Examine
|
|
{
|
|
/// <summary>
|
|
/// Performing basic validation of a value set
|
|
/// </summary>
|
|
public class ValueSetValidator : IValueSetValidator
|
|
{
|
|
public ValueSetValidator(
|
|
IEnumerable<string> includeItemTypes,
|
|
IEnumerable<string> excludeItemTypes,
|
|
IEnumerable<string> includeFields,
|
|
IEnumerable<string> excludeFields)
|
|
{
|
|
IncludeItemTypes = includeItemTypes;
|
|
ExcludeItemTypes = excludeItemTypes;
|
|
IncludeFields = includeFields;
|
|
ExcludeFields = excludeFields;
|
|
ValidIndexCategories = null;
|
|
}
|
|
|
|
protected virtual IEnumerable<string> ValidIndexCategories { get; }
|
|
|
|
/// <summary>
|
|
/// Optional inclusion list of content types to index
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// All other types will be ignored if they do not match this list
|
|
/// </remarks>
|
|
public IEnumerable<string> IncludeItemTypes { get; }
|
|
|
|
/// <summary>
|
|
/// Optional exclusion list of content types to ignore
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Any content type alias matched in this will not be included in the index
|
|
/// </remarks>
|
|
public IEnumerable<string> ExcludeItemTypes { get; }
|
|
|
|
/// <summary>
|
|
/// Optional inclusion list of index fields to index
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// If specified, all other fields in a <see cref="ValueSet"/> will be filtered
|
|
/// </remarks>
|
|
public IEnumerable<string> IncludeFields { get; }
|
|
|
|
/// <summary>
|
|
/// Optional exclusion list of index fields
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// If specified, all fields matching these field names will be filtered from the <see cref="ValueSet"/>
|
|
/// </remarks>
|
|
public IEnumerable<string> ExcludeFields { get; }
|
|
|
|
public virtual ValueSetValidationResult Validate(ValueSet valueSet)
|
|
{
|
|
if (ValidIndexCategories != null && !ValidIndexCategories.InvariantContains(valueSet.Category))
|
|
return ValueSetValidationResult.Failed;
|
|
|
|
//check if this document is of a correct type of node type alias
|
|
if (IncludeItemTypes != null && !IncludeItemTypes.InvariantContains(valueSet.ItemType))
|
|
return ValueSetValidationResult.Failed;
|
|
|
|
//if this node type is part of our exclusion list
|
|
if (ExcludeItemTypes != null && ExcludeItemTypes.InvariantContains(valueSet.ItemType))
|
|
return ValueSetValidationResult.Failed;
|
|
|
|
var isFiltered = false;
|
|
|
|
//filter based on the fields provided (if any)
|
|
if (IncludeFields != null || ExcludeFields != null)
|
|
{
|
|
foreach (var key in valueSet.Values.Keys.ToList())
|
|
{
|
|
if (IncludeFields != null && !IncludeFields.InvariantContains(key))
|
|
{
|
|
valueSet.Values.Remove(key); //remove any value with a key that doesn't match the inclusion list
|
|
isFiltered = true;
|
|
}
|
|
|
|
if (ExcludeFields != null && ExcludeFields.InvariantContains(key))
|
|
{
|
|
valueSet.Values.Remove(key); //remove any value with a key that matches the exclusion list
|
|
isFiltered = true;
|
|
}
|
|
|
|
}
|
|
}
|
|
|
|
return isFiltered ? ValueSetValidationResult.Filtered : ValueSetValidationResult.Valid;
|
|
}
|
|
}
|
|
}
|