Components/General/Validator/Castle.Components.Validator/Validators/RegularExpressionValidator.cs

   1 // Copyright 2004-2007 Castle Project - http://www.castleproject.org/
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License");
   4 // you may not use this file except in compliance with the License.
   5 // You may obtain a copy of the License at
   6 //
   7 //     http://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS,
  11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 // See the License for the specific language governing permissions and
  13 // limitations under the License.
  14
  15 namespace Castle.Components.Validator
  16 {
  17         using System;
  18         using System.Collections;
  19         using System.Text.RegularExpressions;
  20
  21         /// <summary>
  22         /// Validate a property using regular expression
  23         /// </summary>
  24         [Serializable]
  25         public class RegularExpressionValidator : AbstractValidator
  26         {
  27                 private readonly Regex regexRule;
  28                 private readonly string expression;
  29
  30                 /// <summary>
  31                 /// Initializes a new instance of the <see cref="RegularExpressionValidator"/> class.
  32                 /// </summary>
  33                 /// <param name="expression">The expression.</param>
  34                 public RegularExpressionValidator(String expression) : this(expression, RegexOptions.Compiled)
  35                 {
  36                 }
  37
  38                 /// <summary>
  39                 /// Initializes a new instance of the <see cref="RegularExpressionValidator"/> class.
  40                 /// </summary>
  41                 /// <param name="expression">The expression.</param>
  42                 /// <param name="options">The regular expression options.</param>
  43                 public RegularExpressionValidator(String expression, RegexOptions options)
  44                 {
  45                         this.expression = expression;
  46                         regexRule = new Regex(expression, options);
  47                 }
  48
  49
  50                 /// <summary>
  51                 /// Gets the regular expression object.
  52                 /// </summary>
  53                 /// <value>The regular expression object.</value>
  54                 public Regex RegexRule
  55                 {
  56                         get { return regexRule; }
  57                 }
  58
  59                 /// <summary>
  60                 /// Gets the expression.
  61                 /// </summary>
  62                 /// <value>The expression.</value>
  63                 public string Expression
  64                 {
  65                         get { return expression; }
  66                 }
  67
  68                 /// <summary>
  69                 /// Validate that the property value match the given regex.  Null or empty values are allowed.
  70                 /// </summary>
  71                 /// <param name="instance"></param>
  72                 /// <param name="fieldValue"></param>
  73                 /// <returns><c>true</c> if the field is OK</returns>
  74                 public override bool IsValid(object instance, object fieldValue)
  75                 {
  76                         if (fieldValue != null && fieldValue.ToString() != "")
  77                         {
  78                                 string value = fieldValue.ToString();
  79
  80                                 if (value.Length > 0)
  81                                 {
  82                                         return regexRule.IsMatch(value);
  83                                 }
  84                         }
  85
  86                         return true;
  87                 }
  88
  89                 /// <summary>
  90                 /// Gets a value indicating whether this validator supports browser validation.
  91                 /// </summary>
  92                 /// <value>
  93                 ///     <see langword="true"/> if browser validation is supported; otherwise, <see langword="false"/>.
  94                 /// </value>
  95                 public override bool SupportsBrowserValidation
  96                 {
  97                         get { return true; }
  98                 }
  99
 100                 /// <summary>
 101                 /// Applies the browser validation by setting up one or
 102                 /// more input rules on <see cref="IBrowserValidationGenerator"/>.
 103                 /// </summary>
 104                 /// <param name="config">The config.</param>
 105                 /// <param name="inputType">Type of the input.</param>
 106                 /// <param name="generator">The generator.</param>
 107                 /// <param name="attributes">The attributes.</param>
 108                 /// <param name="target">The target.</param>
 109                 public override void ApplyBrowserValidation(BrowserValidationConfiguration config, InputElementType inputType,
 110                                                             IBrowserValidationGenerator generator, IDictionary attributes,
 111                                                             string target)
 112                 {
 113                         base.ApplyBrowserValidation(config, inputType, generator, attributes, target);
 114
 115                         generator.SetRegExp(target, expression, BuildErrorMessage());
 116                 }
 117         }
 118 }