using System;
using Umbraco.Core.Models;
using Umbraco.Core.Models.PublishedContent;
namespace Umbraco.Core
{
///
/// Provides extension methods for content variations.
///
public static class ContentVariationExtensions
{
///
/// Determines whether the content type is invariant.
///
public static bool VariesByNothing(this IContentTypeBase contentType) => contentType.Variations.VariesByNothing();
///
/// Determines whether the content type varies by culture.
///
/// And then it could also vary by segment.
public static bool VariesByCulture(this IContentTypeBase contentType) => contentType.Variations.VariesByCulture();
///
/// Determines whether the content type varies by segment.
///
/// And then it could also vary by culture.
public static bool VariesBySegment(this IContentTypeBase contentType) => contentType.Variations.VariesBySegment();
///
/// Determines whether the content type varies by culture and segment.
///
public static bool VariesByCultureAndSegment(this IContentTypeBase contentType) => contentType.Variations.VariesByCultureAndSegment();
///
/// Determines whether the property type is invariant.
///
public static bool VariesByNothing(this PropertyType propertyType) => propertyType.Variations.VariesByNothing();
///
/// Determines whether the property type varies by culture.
///
/// And then it could also vary by segment.
public static bool VariesByCulture(this PropertyType propertyType) => propertyType.Variations.VariesByCulture();
///
/// Determines whether the property type varies by segment.
///
/// And then it could also vary by culture.
public static bool VariesBySegment(this PropertyType propertyType) => propertyType.Variations.VariesBySegment();
///
/// Determines whether the property type varies by culture and segment.
///
public static bool VariesByCultureAndSegment(this PropertyType propertyType) => propertyType.Variations.VariesByCultureAndSegment();
///
/// Determines whether the content type is invariant.
///
public static bool VariesByNothing(this PublishedContentType contentType) => contentType.Variations.VariesByNothing();
///
/// Determines whether the content type varies by culture.
///
/// And then it could also vary by segment.
public static bool VariesByCulture(this PublishedContentType contentType) => contentType.Variations.VariesByCulture();
///
/// Determines whether the content type varies by segment.
///
/// And then it could also vary by culture.
public static bool VariesBySegment(this PublishedContentType contentType) => contentType.Variations.VariesBySegment();
///
/// Determines whether the content type varies by culture and segment.
///
public static bool VariesByCultureAndSegment(this PublishedContentType contentType) => contentType.Variations.VariesByCultureAndSegment();
///
/// Determines whether the property type is invariant.
///
public static bool VariesByNothing(this PublishedPropertyType propertyType) => propertyType.Variations.VariesByNothing();
///
/// Determines whether the property type varies by culture.
///
public static bool VariesByCulture(this PublishedPropertyType propertyType) => propertyType.Variations.VariesByCulture();
///
/// Determines whether the property type varies by segment.
///
public static bool VariesBySegment(this PublishedPropertyType propertyType) => propertyType.Variations.VariesBySegment();
///
/// Determines whether the property type varies by culture and segment.
///
public static bool VariesByCultureAndSegment(this PublishedPropertyType propertyType) => propertyType.Variations.VariesByCultureAndSegment();
///
/// Determines whether a variation is invariant.
///
public static bool VariesByNothing(this ContentVariation variation) => variation == ContentVariation.Nothing;
///
/// Determines whether a variation varies by culture.
///
/// And then it could also vary by segment.
public static bool VariesByCulture(this ContentVariation variation) => (variation & ContentVariation.Culture) > 0;
///
/// Determines whether a variation varies by segment.
///
/// And then it could also vary by culture.
public static bool VariesBySegment(this ContentVariation variation) => (variation & ContentVariation.Segment) > 0;
///
/// Determines whether a variation varies by culture and segment.
///
public static bool VariesByCultureAndSegment(this ContentVariation variation) => (variation & ContentVariation.CultureAndSegment) == ContentVariation.CultureAndSegment;
///
/// Validates that a combination of culture and segment is valid for the variation.
///
/// The variation.
/// The culture.
/// The segment.
/// A value indicating whether to perform exact validation.
/// A value indicating whether to support wildcards.
/// A value indicating whether to throw a when the combination is invalid.
/// True if the combination is valid; otherwise false.
///
/// When validation is exact, the combination must match the variation exactly. For instance, if the variation is Culture, then
/// a culture is required. When validation is not strict, the combination must be equivalent, or more restrictive: if the variation is
/// Culture, an invariant combination is ok.
/// Basically, exact is for one content type, or one property type, and !exact is for "all property types" of one content type.
/// Both and can be "*" to indicate "all of them".
///
/// Occurs when the combination is invalid, and is true.
public static bool ValidateVariation(this ContentVariation variation, string culture, string segment, bool exact, bool wildcards, bool throwIfInvalid)
{
culture = culture.NullOrWhiteSpaceAsNull();
segment = segment.NullOrWhiteSpaceAsNull();
bool Validate(bool variesBy, string value)
{
if (variesBy)
{
// varies by
// in exact mode, the value cannot be null (but it can be a wildcard)
// in !wildcards mode, the value cannot be a wildcard (but it can be null)
if ((exact && value == null) || (!wildcards && value == "*"))
return false;
}
else
{
// does not vary by value
// the value cannot have a value
// unless wildcards and it's "*"
if (value != null && (!wildcards || value != "*"))
return false;
}
return true;
}
if (!Validate(variation.VariesByCulture(), culture))
{
if (throwIfInvalid)
throw new NotSupportedException($"Culture value \"{culture ?? ""}\" is invalid.");
return false;
}
if (!Validate(variation.VariesBySegment(), segment))
{
if (throwIfInvalid)
throw new NotSupportedException($"Segment value \"{segment ?? ""}\" is invalid.");
return false;
}
return true;
}
}
}