dom/html/nsIConstraintValidation.cpp

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #include "nsIConstraintValidation.h"
   7
   8 #include "nsAString.h"
   9 #include "nsGenericHTMLElement.h"
  10 #include "mozilla/dom/HTMLFormElement.h"
  11 #include "mozilla/dom/HTMLFieldSetElement.h"
  12 #include "mozilla/dom/ValidityState.h"
  13 #include "nsIFormControl.h"
  14 #include "nsContentUtils.h"
  15
  16 const uint16_t nsIConstraintValidation::sContentSpecifiedMaxLengthMessage = 256;
  17
  18 using namespace mozilla;
  19 using namespace mozilla::dom;
  20
  21 nsIConstraintValidation::nsIConstraintValidation()
  22   : mValidityBitField(0)
  23   // By default, all elements are subjects to constraint validation.
  24   , mBarredFromConstraintValidation(false)
  25 {
  26 }
  27
  28 nsIConstraintValidation::~nsIConstraintValidation()
  29 {
  30 }
  31
  32 mozilla::dom::ValidityState*
  33 nsIConstraintValidation::Validity()
  34 {
  35   if (!mValidity) {
  36     mValidity = new mozilla::dom::ValidityState(this);
  37   }
  38
  39   return mValidity;
  40 }
  41
  42 nsresult
  43 nsIConstraintValidation::GetValidity(nsIDOMValidityState** aValidity)
  44 {
  45   NS_ENSURE_ARG_POINTER(aValidity);
  46
  47   NS_ADDREF(*aValidity = Validity());
  48
  49   return NS_OK;
  50 }
  51
  52 NS_IMETHODIMP
  53 nsIConstraintValidation::GetValidationMessage(nsAString& aValidationMessage)
  54 {
  55   aValidationMessage.Truncate();
  56
  57   if (IsCandidateForConstraintValidation() && !IsValid()) {
  58     nsCOMPtr<nsIContent> content = do_QueryInterface(this);
  59     NS_ASSERTION(content, "This class should be inherited by HTML elements only!");
  60
  61     nsAutoString authorMessage;
  62     content->GetAttr(kNameSpaceID_None, nsGkAtoms::x_moz_errormessage,
  63                      authorMessage);
  64
  65     if (!authorMessage.IsEmpty()) {
  66       aValidationMessage.Assign(authorMessage);
  67       if (aValidationMessage.Length() > sContentSpecifiedMaxLengthMessage) {
  68         aValidationMessage.Truncate(sContentSpecifiedMaxLengthMessage);
  69       }
  70     } else if (GetValidityState(VALIDITY_STATE_CUSTOM_ERROR)) {
  71       aValidationMessage.Assign(mCustomValidity);
  72       if (aValidationMessage.Length() > sContentSpecifiedMaxLengthMessage) {
  73         aValidationMessage.Truncate(sContentSpecifiedMaxLengthMessage);
  74       }
  75     } else if (GetValidityState(VALIDITY_STATE_TOO_LONG)) {
  76       GetValidationMessage(aValidationMessage, VALIDITY_STATE_TOO_LONG);
  77     } else if (GetValidityState(VALIDITY_STATE_VALUE_MISSING)) {
  78       GetValidationMessage(aValidationMessage, VALIDITY_STATE_VALUE_MISSING);
  79     } else if (GetValidityState(VALIDITY_STATE_TYPE_MISMATCH)) {
  80       GetValidationMessage(aValidationMessage, VALIDITY_STATE_TYPE_MISMATCH);
  81     } else if (GetValidityState(VALIDITY_STATE_PATTERN_MISMATCH)) {
  82       GetValidationMessage(aValidationMessage, VALIDITY_STATE_PATTERN_MISMATCH);
  83     } else if (GetValidityState(VALIDITY_STATE_RANGE_OVERFLOW)) {
  84       GetValidationMessage(aValidationMessage, VALIDITY_STATE_RANGE_OVERFLOW);
  85     } else if (GetValidityState(VALIDITY_STATE_RANGE_UNDERFLOW)) {
  86       GetValidationMessage(aValidationMessage, VALIDITY_STATE_RANGE_UNDERFLOW);
  87     } else if (GetValidityState(VALIDITY_STATE_STEP_MISMATCH)) {
  88       GetValidationMessage(aValidationMessage, VALIDITY_STATE_STEP_MISMATCH);
  89     } else if (GetValidityState(VALIDITY_STATE_BAD_INPUT)) {
  90       GetValidationMessage(aValidationMessage, VALIDITY_STATE_BAD_INPUT);
  91     } else {
  92       // There should not be other validity states.
  93       return NS_ERROR_UNEXPECTED;
  94     }
  95   } else {
  96     aValidationMessage.Truncate();
  97   }
  98
  99   return NS_OK;
 100 }
 101
 102 bool
 103 nsIConstraintValidation::CheckValidity()
 104 {
 105   if (!IsCandidateForConstraintValidation() || IsValid()) {
 106     return true;
 107   }
 108
 109   nsCOMPtr<nsIContent> content = do_QueryInterface(this);
 110   NS_ASSERTION(content, "This class should be inherited by HTML elements only!");
 111
 112   nsContentUtils::DispatchTrustedEvent(content->OwnerDoc(), content,
 113                                        NS_LITERAL_STRING("invalid"),
 114                                        false, true);
 115   return false;
 116 }
 117
 118 nsresult
 119 nsIConstraintValidation::CheckValidity(bool* aValidity)
 120 {
 121   NS_ENSURE_ARG_POINTER(aValidity);
 122
 123   *aValidity = CheckValidity();
 124
 125   return NS_OK;
 126 }
 127
 128 void
 129 nsIConstraintValidation::SetValidityState(ValidityStateType aState,
 130                                           bool aValue)
 131 {
 132   bool previousValidity = IsValid();
 133
 134   if (aValue) {
 135     mValidityBitField |= aState;
 136   } else {
 137     mValidityBitField &= ~aState;
 138   }
 139
 140   // Inform the form and fieldset elements if our validity has changed.
 141   if (previousValidity != IsValid() && IsCandidateForConstraintValidation()) {
 142     nsCOMPtr<nsIFormControl> formCtrl = do_QueryInterface(this);
 143     NS_ASSERTION(formCtrl, "This interface should be used by form elements!");
 144
 145     HTMLFormElement* form =
 146       static_cast<HTMLFormElement*>(formCtrl->GetFormElement());
 147     if (form) {
 148       form->UpdateValidity(IsValid());
 149     }
 150     HTMLFieldSetElement* fieldSet = formCtrl->GetFieldSet();
 151       if (fieldSet) {
 152       fieldSet->UpdateValidity(IsValid());
 153     }
 154   }
 155 }
 156
 157 void
 158 nsIConstraintValidation::SetCustomValidity(const nsAString& aError)
 159 {
 160   mCustomValidity.Assign(aError);
 161   SetValidityState(VALIDITY_STATE_CUSTOM_ERROR, !mCustomValidity.IsEmpty());
 162 }
 163
 164 void
 165 nsIConstraintValidation::SetBarredFromConstraintValidation(bool aBarred)
 166 {
 167   bool previousBarred = mBarredFromConstraintValidation;
 168
 169   mBarredFromConstraintValidation = aBarred;
 170
 171   // Inform the form and fieldset elements if our status regarding constraint
 172   // validation is going to change.
 173   if (!IsValid() && previousBarred != mBarredFromConstraintValidation) {
 174     nsCOMPtr<nsIFormControl> formCtrl = do_QueryInterface(this);
 175     NS_ASSERTION(formCtrl, "This interface should be used by form elements!");
 176
 177     // If the element is going to be barred from constraint validation, we can
 178     // inform the form and fieldset that we are now valid. Otherwise, we are now
 179     // invalid.
 180     HTMLFormElement* form =
 181       static_cast<HTMLFormElement*>(formCtrl->GetFormElement());
 182     if (form) {
 183       form->UpdateValidity(aBarred);
 184     }
 185     HTMLFieldSetElement* fieldSet = formCtrl->GetFieldSet();
 186     if (fieldSet) {
 187       fieldSet->UpdateValidity(aBarred);
 188     }
 189   }
 190 }
 191