mcs/class/System.Web/System.Web.UI.WebControls/BaseValidator.cs

   1 //
   2 // System.Web.UI.WebControls.BaseValidator
   3 //
   4 // Authors:
   5 //      Chris Toshok (toshok@novell.com)
   6 //
   7 // (C) 2005 Novell, Inc (http://www.novell.com)
   8 //
   9 // Permission is hereby granted, free of charge, to any person obtaining
  10 // a copy of this software and associated documentation files (the
  11 // "Software"), to deal in the Software without restriction, including
  12 // without limitation the rights to use, copy, modify, merge, publish,
  13 // distribute, sublicense, and/or sell copies of the Software, and to
  14 // permit persons to whom the Software is furnished to do so, subject to
  15 // the following conditions:
  16 //
  17 // The above copyright notice and this permission notice shall be
  18 // included in all copies or substantial portions of the Software.
  19 //
  20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  24 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  25 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  26 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  27 //
  28
  29 using System.Web.Configuration;
  30 using System.ComponentModel;
  31 using System.Drawing;
  32 using System.Reflection;
  33 using System.Collections;
  34 using System.Security.Permissions;
  35
  36 namespace System.Web.UI.WebControls {
  37
  38         // CAS
  39         [AspNetHostingPermission (SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal)]
  40         [AspNetHostingPermission (SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal)]
  41         // attributes
  42         [DefaultProperty("ErrorMessage")]
  43         [Designer("System.Web.UI.Design.WebControls.BaseValidatorDesigner, " + Consts.AssemblySystem_Design, "System.ComponentModel.Design.IDesigner")]
  44         public abstract class BaseValidator : Label, IValidator
  45         {
  46                 bool render_uplevel;
  47                 bool valid;
  48                 Color forecolor;
  49
  50                 protected BaseValidator ()
  51                 {
  52                         this.valid = true;
  53                         this.ForeColor = Color.Red;
  54                 }
  55
  56                 // New in NET1.1 sp1
  57                 [Browsable(false)]
  58 #if ONLY_1_1
  59                 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
  60 #endif
  61                 [EditorBrowsable(EditorBrowsableState.Never)]
  62                 public override string AssociatedControlID {
  63                         get {
  64                                 return base.AssociatedControlID;
  65                         }
  66                         set {
  67                                 base.AssociatedControlID = value;
  68                         }
  69                 }
  70
  71 #if NET_2_0
  72                 [Themeable (false)]
  73                 [DefaultValue ("")]
  74                 public virtual string ValidationGroup {
  75                         get { return ViewState.GetString ("ValidationGroup", String.Empty); }
  76                         set { ViewState["ValidationGroup"] = value; }
  77                 }
  78
  79                 [Themeable (false)]
  80                 [DefaultValue (false)]
  81                 public bool SetFocusOnError {
  82                         get { return ViewState.GetBool ("SetFocusOnError", false); }
  83                         set { ViewState["SetFocusOnError"] = value; }
  84                 }
  85
  86                 /* listed in corcompare */
  87                 [MonoTODO("Why override?")]
  88                 [PersistenceMode (PersistenceMode.InnerDefaultProperty)]
  89                 [DefaultValue ("")]
  90                 public override string Text
  91                 {
  92                         get { return base.Text; }
  93                         set { base.Text = value; }
  94                 }
  95 #endif
  96
  97 #if NET_2_0
  98                 [IDReferenceProperty (typeof (Control))]
  99                 [Themeable (false)]
 100 #endif
 101                 [TypeConverter(typeof(System.Web.UI.WebControls.ValidatedControlConverter))]
 102                 [DefaultValue("")]
 103                 [WebSysDescription ("")]
 104                 [WebCategory ("Behavior")]
 105                 public string ControlToValidate {
 106                         get { return ViewState.GetString ("ControlToValidate", String.Empty); }
 107                         set { ViewState ["ControlToValidate"] = value; }
 108                 }
 109
 110 #if NET_2_0
 111                 [Themeable (false)]
 112 #endif
 113 #if ONLY_1_1
 114                 [Bindable(true)]
 115 #endif
 116                 [DefaultValue(ValidatorDisplay.Static)]
 117                 [WebSysDescription ("")]
 118                 [WebCategory ("Appearance")]
 119                 public ValidatorDisplay Display {
 120                         get { return (ValidatorDisplay)ViewState.GetInt ("Display", (int)ValidatorDisplay.Static); }
 121                         set { ViewState ["Display"] = (int)value; }
 122                 }
 123
 124 #if NET_2_0
 125                 [Themeable (false)]
 126 #endif
 127                 [DefaultValue(true)]
 128                 [WebSysDescription ("")]
 129                 [WebCategory ("Behavior")]
 130                 public bool EnableClientScript {
 131                         get { return ViewState.GetBool ("EnableClientScript", true); }
 132                         set { ViewState ["EnableClientScript"] = value; }
 133                 }
 134
 135                 public override bool Enabled {
 136                         get { return ViewState.GetBool ("Enabled", true); }
 137                         set { ViewState ["Enabled"] = value; }
 138                 }
 139
 140 #if NET_2_0
 141                 [Localizable (true)]
 142 #endif
 143 #if ONLY_1_1
 144                 [Bindable(true)]
 145 #endif
 146                 [DefaultValue("")]
 147                 [WebSysDescription ("")]
 148                 [WebCategory ("Appearance")]
 149 #if NET_2_0
 150                 public
 151 #else
 152                 public virtual
 153 #endif
 154                 string ErrorMessage {
 155                         get { return ViewState.GetString ("ErrorMessage", String.Empty); }
 156                         set { ViewState ["ErrorMessage"] = value; }
 157                 }
 158
 159                 [DefaultValue(typeof (Color), "Red")]
 160                 public override Color ForeColor {
 161                         get { return forecolor; }
 162                         set {
 163                                 forecolor = value;
 164                                 base.ForeColor = value;
 165                         }
 166                 }
 167
 168                 [Browsable(false)]
 169                 [DefaultValue(true)]
 170 #if NET_2_0
 171                 [Themeable (false)]
 172 #endif
 173                 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
 174                 [WebSysDescription ("")]
 175                 [WebCategory ("Misc")]
 176 #if NET_2_0
 177                 public
 178 #else
 179                 public virtual
 180 #endif
 181                 bool IsValid {
 182                         get { return valid; }
 183                         set { valid = value; }
 184                 }
 185
 186                 protected bool PropertiesValid {
 187                         get {
 188                                 Control control = NamingContainer.FindControl (ControlToValidate);
 189                                 if (control == null)
 190                                         return false;
 191                                 else
 192                                         return true;
 193                         }
 194                 }
 195
 196                 protected bool RenderUplevel {
 197                         get { return render_uplevel; }
 198                 }
 199
 200                 internal bool GetRenderUplevel ()
 201                 {
 202                         return render_uplevel;
 203                 }
 204
 205                 [MonoTODO()]
 206                 // for 2.0: not XHTML attributes must be registered with RegisterExpandoAttribute
 207                 // when it will be implemented, in this case WebUIValidation_2.0.js muist be refactored
 208                 protected override void AddAttributesToRender (HtmlTextWriter writer)
 209                 {
 210                         /* if we're rendering uplevel, add our attributes */
 211                         if (render_uplevel) {
 212                                 /* force an ID here if we weren't assigned one */
 213                                 if (ID == null)
 214                                         writer.AddAttribute(HtmlTextWriterAttribute.Id, ClientID);
 215
 216                                 if (ControlToValidate != String.Empty)
 217                                         writer.AddAttribute ("controltovalidate", GetControlRenderID (ControlToValidate));
 218
 219                                 if (ErrorMessage != String.Empty)
 220                                         writer.AddAttribute ("errormessage", ErrorMessage);
 221                                 if (Text != String.Empty)
 222                                         writer.AddAttribute ("text", Text);
 223 #if NET_2_0
 224                                 if (ValidationGroup != String.Empty)
 225                                         writer.AddAttribute ("validationgroup", ValidationGroup);
 226
 227                                 if (SetFocusOnError)
 228                                         Page.ClientScript.RegisterExpandoAttribute (ClientID, "focusOnError", "t");
 229 #endif
 230                                 if (!Enabled)
 231                                         writer.AddAttribute ("enabled", "false");
 232
 233 #if NET_2_0
 234                                 if (Enabled && !IsValid) {
 235 #else
 236                                 if (!IsValid) {
 237 #endif
 238                                         writer.AddAttribute ("isvalid", "false");
 239                                 }
 240                                 else {
 241                                         if (Display == ValidatorDisplay.Static)
 242                                                 writer.AddStyleAttribute ("visibility", "hidden");
 243                                         else
 244                                                 writer.AddStyleAttribute ("display", "none");
 245                                 }
 246
 247                                 if (Display != ValidatorDisplay.Static)
 248                                         writer.AddAttribute ("display", Display.ToString());
 249                         }
 250
 251                         base.AddAttributesToRender (writer);
 252                 }
 253
 254                 protected void CheckControlValidationProperty (string name, string propertyName)
 255                 {
 256                         Control control = NamingContainer.FindControl (name);
 257                         PropertyDescriptor prop = null;
 258
 259                         if (control == null)
 260                                 throw new HttpException (String.Format ("Unable to find control id '{0}'.", name));
 261
 262                         prop = BaseValidator.GetValidationProperty (control);
 263                         if (prop == null)
 264                                 throw new HttpException (String.Format ("Unable to find ValidationProperty attribute '{0}' on control '{1}'", propertyName, name));
 265                 }
 266
 267                 protected virtual bool ControlPropertiesValid ()
 268                 {
 269                         if (ControlToValidate.Length == 0) {
 270                                 throw new HttpException (String.Format ("ControlToValidate property of '{0}' cannot be blank.", ID));
 271                         }
 272
 273                         CheckControlValidationProperty (ControlToValidate, "");
 274
 275                         return true;
 276                 }
 277
 278                 protected virtual bool DetermineRenderUplevel ()
 279                 {
 280                         if (!EnableClientScript)
 281                                 return false;
 282 #if TARGET_J2EE
 283                         if (HttpContext.Current == null)
 284                                 return false;
 285
 286                         return (
 287                                 /* From someplace on the web: "JavaScript 1.2
 288                                  * and later (also known as ECMAScript) has
 289                                  * built-in support for regular
 290                                  * expressions" */
 291                                 ((Page.Request.Browser.EcmaScriptVersion.Major == 1
 292                                   && Page.Request.Browser.EcmaScriptVersion.Minor >= 2)
 293                                  || (Page.Request.Browser.EcmaScriptVersion.Major > 1))
 294
 295                                 /* document.getElementById, .getAttribute,
 296                                  * etc, are all DOM level 1.  I don't think we
 297                                  * use anything in level 2.. */
 298                                 && Page.Request.Browser.W3CDomVersion.Major >= 1);
 299 #else
 300                         return UplevelHelper.IsUplevel (
 301                                 System.Web.Configuration.HttpCapabilitiesBase.GetUserAgentForDetection (HttpContext.Current.Request));
 302 #endif
 303                 }
 304
 305                 protected abstract bool EvaluateIsValid ();
 306
 307                 protected string GetControlRenderID (string name)
 308                 {
 309                         Control control = NamingContainer.FindControl (name);
 310                         if (control == null)
 311                                 return null;
 312
 313                         return control.ClientID;
 314                 }
 315
 316                 protected string GetControlValidationValue (string name)
 317                 {
 318                         Control control = NamingContainer.FindControl (name);
 319
 320                         if (control == null)
 321                                 return null;
 322
 323                         PropertyDescriptor prop = BaseValidator.GetValidationProperty (control);
 324                         if (prop == null)
 325                                 return null;
 326
 327                         object o = prop.GetValue (control);
 328
 329                         if (o == null)
 330                                 return String.Empty;
 331
 332                         if (o is ListItem)
 333                                 return ((ListItem) o).Value;
 334
 335                         return o.ToString ();
 336                 }
 337
 338                 public static PropertyDescriptor GetValidationProperty (object o)
 339                 {
 340                         PropertyDescriptorCollection props;
 341                         System.ComponentModel.AttributeCollection col;
 342
 343                         props = TypeDescriptor.GetProperties (o);
 344                         col = TypeDescriptor.GetAttributes (o);
 345
 346                         foreach (Attribute at in col) {
 347                                 ValidationPropertyAttribute vpa = at as ValidationPropertyAttribute;
 348                                 if (vpa != null && vpa.Name != null)
 349                                         return props[vpa.Name];
 350                         }
 351
 352                         return null;
 353                 }
 354
 355 #if NET_2_0
 356                 protected internal
 357 #else
 358                 protected
 359 #endif
 360                 override void OnInit (EventArgs e)
 361                 {
 362                         /* according to an msdn article, this is done here */
 363                         if (Page != null) {
 364                                 Page.Validators.Add (this);
 365
 366 #if NET_2_0
 367                                 Page.GetValidators (ValidationGroup).Add (this);
 368 #endif
 369                         }
 370                         base.OnInit (e);
 371                 }
 372
 373                 bool pre_render_called = false;
 374
 375 #if NET_2_0
 376                 protected internal
 377 #else
 378                 protected
 379 #endif
 380                 override void OnPreRender (EventArgs e)
 381                 {
 382                         base.OnPreRender (e);
 383
 384                         pre_render_called = true;
 385
 386                         ControlPropertiesValid ();
 387
 388                         render_uplevel = DetermineRenderUplevel ();
 389                         if (render_uplevel) {
 390                                 RegisterValidatorCommonScript ();
 391                         }
 392                 }
 393
 394 #if NET_2_0
 395                 protected internal
 396 #else
 397                 protected
 398 #endif
 399                 override void OnUnload (EventArgs e)
 400                 {
 401                         /* according to an msdn article, this is done here */
 402                         if (Page != null) {
 403                                 Page.Validators.Remove (this);
 404
 405 #if NET_2_0
 406                                 if (ValidationGroup != "")
 407                                         Page.GetValidators (ValidationGroup).Remove (this);
 408 #endif
 409
 410                         }
 411                         base.OnUnload (e);
 412                 }
 413
 414                 protected void RegisterValidatorCommonScript ()
 415                 {
 416                         if (!Page.ClientScript.IsClientScriptIncludeRegistered (typeof (BaseValidator), "Mono-System.Web-ValidationClientScriptBlock"))
 417                         {
 418                                 Page.ClientScript.RegisterClientScriptInclude (typeof (BaseValidator), "Mono-System.Web-ValidationClientScriptBlock",
 419                                         Page.ClientScript.GetWebResourceUrl (typeof (BaseValidator),
 420 #if NET_2_0
 421                                                 "WebUIValidation_2.0.js"));
 422                                 string webForm = (Page.IsMultiForm ? Page.theForm : "window");
 423                                 Page.ClientScript.RegisterClientScriptBlock (typeof (BaseValidator), "Mono-System.Web-ValidationClientScriptBlock.Initialize", "WebFormValidation_Initialize(" + webForm + ");", true);
 424                                 Page.ClientScript.RegisterOnSubmitStatement ("Mono-System.Web-ValidationOnSubmitStatement", "if (!" + webForm + ".ValidatorOnSubmit()) return false;");
 425                                 Page.ClientScript.RegisterStartupScript (typeof (BaseValidator), "Mono-System.Web-ValidationStartupScript",
 426 @"
 427 " + webForm + @".Page_ValidationActive = false;
 428 " + webForm + @".ValidatorOnLoad();
 429 " + webForm + @".ValidatorOnSubmit = function () {
 430         if (this.Page_ValidationActive) {
 431                 return this.ValidatorCommonOnSubmit();
 432         }
 433         return true;
 434 }
 435 ", true);
 436 #else
 437                                                 "WebUIValidation.js"));
 438
 439                                 Page.ClientScript.RegisterOnSubmitStatement ("Mono-System.Web-ValidationOnSubmitStatement",
 440                                                                              "if (!ValidatorOnSubmit()) return false;");
 441                                 Page.ClientScript.RegisterStartupScript ("Mono-System.Web-ValidationStartupScript",
 442                                                                          "<script language=\"JavaScript\">\n" +
 443                                                                          "<!--\n" +
 444                                                                          "var Page_ValidationActive = false;\n" +
 445                                                                          "ValidatorOnLoad();\n" +
 446                                                                          "\n" +
 447                                                                          "function ValidatorOnSubmit() {\n" +
 448                                                                          "        if (Page_ValidationActive) {\n" +
 449                                                                          "                if (!ValidatorCommonOnSubmit())\n" +
 450                                                                          "                        return Page_ClientValidate ();\n" +
 451                                                                          "        }\n" +
 452                                                                          "        return true;\n" +
 453                                                                          "}\n" +
 454                                                                          "// -->\n" +
 455                                                                          "</script>\n");
 456 #endif
 457                         }
 458                 }
 459
 460                 protected virtual void RegisterValidatorDeclaration ()
 461                 {
 462                         Page.ClientScript.RegisterArrayDeclaration ("Page_Validators",
 463                                                                     String.Format ("document.getElementById ('{0}')", ClientID));
 464                 }
 465
 466 #if NET_2_0
 467                 protected internal
 468 #else
 469                 protected
 470 #endif
 471                 override void Render (HtmlTextWriter writer)
 472                 {
 473 #if NET_2_0
 474                         if (!Enabled && !EnableClientScript)
 475                                 return;
 476 #endif
 477                         if (render_uplevel) {
 478                                 /* according to an msdn article, this is done here */
 479                                 RegisterValidatorDeclaration ();
 480                         }
 481
 482                         bool render_tags = false;
 483                         bool render_text = false;
 484                         bool render_nbsp = false;
 485                         bool v = IsValid;
 486
 487                         if (!pre_render_called) {
 488                                 render_tags = true;
 489                                 render_text = true;
 490                         }
 491                         else if (render_uplevel) {
 492                                 render_tags = true;
 493 #if NET_2_0
 494                                 render_text = Display != ValidatorDisplay.None;
 495 #else
 496                                 if (Display != ValidatorDisplay.None)
 497                                         render_text = !v || Display == ValidatorDisplay.Dynamic;
 498 #endif
 499                         }
 500                         else {
 501                                 if (Display == ValidatorDisplay.Static) {
 502                                         render_tags = !v;
 503                                         render_text = !v;
 504                                         render_nbsp = v;
 505                                 }
 506                         }
 507
 508                         if (render_tags) {
 509                                 AddAttributesToRender (writer);
 510                                 writer.RenderBeginTag (HtmlTextWriterTag.Span);
 511                         }
 512
 513                         if (render_text || render_nbsp) {
 514                                 string text;
 515                                 if (render_text) {
 516                                         text = Text;
 517                                         if (text == "")
 518                                                 text = ErrorMessage;
 519                                 } else {
 520                                         text = "&nbsp;";
 521                                 }
 522
 523                                 writer.Write (text);
 524                         }
 525
 526
 527                         if (render_tags) {
 528                                 writer.RenderEndTag ();
 529                         }
 530                 }
 531
 532                 /* the docs say "public sealed" here */
 533 #if NET_2_0
 534                 public
 535 #else
 536                 public virtual
 537 #endif
 538                 void Validate ()
 539                 {
 540                         if (Enabled && Visible)
 541                                 IsValid = ControlPropertiesValid () && EvaluateIsValid ();
 542                         else
 543                                 IsValid = true;
 544                 }
 545         }
 546
 547 }