116 lines
5.3 KiB
C#
116 lines
5.3 KiB
C#
using System.ComponentModel.DataAnnotations.Resources;
|
|
using System.Diagnostics.CodeAnalysis;
|
|
using System.Globalization;
|
|
using System.Text.RegularExpressions;
|
|
|
|
namespace System.ComponentModel.DataAnnotations {
|
|
/// <summary>
|
|
/// Regular expression validation attribute
|
|
/// </summary>
|
|
[AttributeUsage(AttributeTargets.Property | AttributeTargets.Field | AttributeTargets.Parameter, AllowMultiple = false)]
|
|
[SuppressMessage("Microsoft.Performance", "CA1813:AvoidUnsealedAttributes", Justification = "We want users to be able to extend this class")]
|
|
public class RegularExpressionAttribute : ValidationAttribute {
|
|
/// <summary>
|
|
/// Gets the regular expression pattern to use
|
|
/// </summary>
|
|
public string Pattern { get; private set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the timeout to use when matching the regular expression pattern (in milliseconds)
|
|
/// (-1 means never timeout).
|
|
/// </summary>
|
|
public int MatchTimeoutInMilliseconds { get; set; } = GetDefaultTimeout();
|
|
|
|
private Regex Regex { get; set; }
|
|
|
|
/// <summary>
|
|
/// Constructor that accepts the regular expression pattern
|
|
/// </summary>
|
|
/// <param name="pattern">The regular expression to use. It cannot be null.</param>
|
|
public RegularExpressionAttribute(string pattern)
|
|
: base(() => DataAnnotationsResources.RegexAttribute_ValidationError) {
|
|
this.Pattern = pattern;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Override of <see cref="ValidationAttribute.IsValid(object)"/>
|
|
/// </summary>
|
|
/// <remarks>This override performs the specific regular expression matching of the given <paramref name="value"/></remarks>
|
|
/// <param name="value">The value to test for validity.</param>
|
|
/// <returns><c>true</c> if the given value matches the current regular expression pattern</returns>
|
|
/// <exception cref="InvalidOperationException"> is thrown if the current attribute is ill-formed.</exception>
|
|
/// <exception cref="ArgumentException"> is thrown if the <see cref="Pattern"/> is not a valid regular expression.</exception>
|
|
#if !SILVERLIGHT
|
|
public
|
|
#else
|
|
internal
|
|
#endif
|
|
override bool IsValid(object value) {
|
|
this.SetupRegex();
|
|
|
|
// Convert the value to a string
|
|
string stringValue = Convert.ToString(value, CultureInfo.CurrentCulture);
|
|
|
|
// Automatically pass if value is null or empty. RequiredAttribute should be used to assert a value is not empty.
|
|
if (String.IsNullOrEmpty(stringValue)) {
|
|
return true;
|
|
}
|
|
|
|
Match m = this.Regex.Match(stringValue);
|
|
|
|
// We are looking for an exact match, not just a search hit. This matches what
|
|
// the RegularExpressionValidator control does
|
|
return (m.Success && m.Index == 0 && m.Length == stringValue.Length);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Override of <see cref="ValidationAttribute.FormatErrorMessage"/>
|
|
/// </summary>
|
|
/// <remarks>This override provide a formatted error message describing the pattern</remarks>
|
|
/// <param name="name">The user-visible name to include in the formatted message.</param>
|
|
/// <returns>The localized message to present to the user</returns>
|
|
/// <exception cref="InvalidOperationException"> is thrown if the current attribute is ill-formed.</exception>
|
|
/// <exception cref="ArgumentException"> is thrown if the <see cref="Pattern"/> is not a valid regular expression.</exception>
|
|
public override string FormatErrorMessage(string name) {
|
|
this.SetupRegex();
|
|
|
|
return String.Format(CultureInfo.CurrentCulture, ErrorMessageString, name, this.Pattern);
|
|
}
|
|
|
|
|
|
/// <summary>
|
|
/// Sets up the <see cref="Regex"/> property from the <see cref="Pattern"/> property.
|
|
/// </summary>
|
|
/// <exception cref="ArgumentException"> is thrown if the current <see cref="Pattern"/> cannot be parsed</exception>
|
|
/// <exception cref="InvalidOperationException"> is thrown if the current attribute is ill-formed.</exception>
|
|
/// <exception cref="ArgumentOutOfRangeException"> thrown if <see cref="MatchTimeoutInMilliseconds" /> is negative (except -1),
|
|
/// zero or greater than approximately 24 days </exception>
|
|
private void SetupRegex() {
|
|
if (this.Regex == null) {
|
|
if (string.IsNullOrEmpty(this.Pattern)) {
|
|
throw new InvalidOperationException(DataAnnotationsResources.RegularExpressionAttribute_Empty_Pattern);
|
|
}
|
|
Regex = MatchTimeoutInMilliseconds == -1
|
|
? new Regex(Pattern)
|
|
: Regex = new Regex(Pattern, default(RegexOptions), TimeSpan.FromMilliseconds((double)MatchTimeoutInMilliseconds));
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Returns the default MatchTimeout based on UseLegacyRegExTimeout switch.
|
|
/// </summary>
|
|
private static int GetDefaultTimeout() {
|
|
#if !MONO
|
|
if (LocalAppContextSwitches.UseLegacyRegExTimeout) {
|
|
return -1;
|
|
}
|
|
else
|
|
#endif
|
|
{
|
|
return 2000;
|
|
}
|
|
|
|
}
|
|
}
|
|
}
|