The code to look for an ancestor form element is duplicated in three different places
[WebKit-https.git] / Source / WebCore / html / HTMLFormControlElement.cpp
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2001 Dirk Mueller (mueller@kde.org)
5  * Copyright (C) 2004, 2005, 2006, 2007 Apple Inc. All rights reserved.
6  *           (C) 2006 Alexey Proskuryakov (ap@nypop.com)
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public License
19  * along with this library; see the file COPYING.LIB.  If not, write to
20  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21  * Boston, MA 02110-1301, USA.
22  *
23  */
24
25 #include "config.h"
26 #include "HTMLFormControlElement.h"
27
28 #include "Attribute.h"
29 #include "Event.h"
30 #include "EventHandler.h"
31 #include "EventNames.h"
32 #include "FeatureObserver.h"
33 #include "Frame.h"
34 #include "HTMLFieldSetElement.h"
35 #include "HTMLFormElement.h"
36 #include "HTMLInputElement.h"
37 #include "HTMLLegendElement.h"
38 #include "HTMLTextAreaElement.h"
39 #include "RenderBox.h"
40 #include "RenderTheme.h"
41 #include "ScriptEventListener.h"
42 #include "ValidationMessage.h"
43 #include "ValidityState.h"
44 #include <wtf/Vector.h>
45
46 namespace WebCore {
47
48 using namespace HTMLNames;
49 using namespace std;
50
51 HTMLFormControlElement::HTMLFormControlElement(const QualifiedName& tagName, Document* document, HTMLFormElement* form)
52     : LabelableElement(tagName, document)
53     , m_disabled(false)
54     , m_isReadOnly(false)
55     , m_isRequired(false)
56     , m_valueMatchesRenderer(false)
57     , m_ancestorDisabledState(AncestorDisabledStateUnknown)
58     , m_dataListAncestorState(Unknown)
59     , m_willValidateInitialized(false)
60     , m_willValidate(true)
61     , m_isValid(true)
62     , m_wasChangedSinceLastFormControlChangeEvent(false)
63     , m_hasAutofocused(false)
64 {
65     setForm(form ? form : HTMLFormElement::findClosestFormAncestor(*this));
66     setHasCustomStyleResolveCallbacks();
67 }
68
69 HTMLFormControlElement::~HTMLFormControlElement()
70 {
71 }
72
73 String HTMLFormControlElement::formEnctype() const
74 {
75     const AtomicString& formEnctypeAttr = fastGetAttribute(formenctypeAttr);
76     if (formEnctypeAttr.isNull())
77         return emptyString();
78     return FormSubmission::Attributes::parseEncodingType(formEnctypeAttr);
79 }
80
81 void HTMLFormControlElement::setFormEnctype(const String& value)
82 {
83     setAttribute(formenctypeAttr, value);
84 }
85
86 String HTMLFormControlElement::formMethod() const
87 {
88     const AtomicString& formMethodAttr = fastGetAttribute(formmethodAttr);
89     if (formMethodAttr.isNull())
90         return emptyString();
91     return FormSubmission::Attributes::methodString(FormSubmission::Attributes::parseMethodType(formMethodAttr));
92 }
93
94 void HTMLFormControlElement::setFormMethod(const String& value)
95 {
96     setAttribute(formmethodAttr, value);
97 }
98
99 bool HTMLFormControlElement::formNoValidate() const
100 {
101     return fastHasAttribute(formnovalidateAttr);
102 }
103
104 void HTMLFormControlElement::updateAncestorDisabledState() const
105 {
106     HTMLFieldSetElement* fieldSetAncestor = 0;
107     ContainerNode* legendAncestor = 0;
108     for (ContainerNode* ancestor = parentNode(); ancestor; ancestor = ancestor->parentNode()) {
109         if (!legendAncestor && ancestor->hasTagName(legendTag))
110             legendAncestor = ancestor;
111         if (ancestor->hasTagName(fieldsetTag)) {
112             fieldSetAncestor = static_cast<HTMLFieldSetElement*>(ancestor);
113             break;
114         }
115     }
116     m_ancestorDisabledState = (fieldSetAncestor && fieldSetAncestor->isDisabledFormControl() && !(legendAncestor && legendAncestor == fieldSetAncestor->legend())) ? AncestorDisabledStateDisabled : AncestorDisabledStateEnabled;
117 }
118
119 void HTMLFormControlElement::ancestorDisabledStateWasChanged()
120 {
121     m_ancestorDisabledState = AncestorDisabledStateUnknown;
122     disabledAttributeChanged();
123 }
124
125 void HTMLFormControlElement::parseAttribute(const QualifiedName& name, const AtomicString& value)
126 {
127     if (name == formAttr) {
128         formAttributeChanged();
129         FeatureObserver::observe(document(), FeatureObserver::FormAttribute);
130     } else if (name == disabledAttr) {
131         bool oldDisabled = m_disabled;
132         m_disabled = !value.isNull();
133         if (oldDisabled != m_disabled)
134             disabledAttributeChanged();
135     } else if (name == readonlyAttr) {
136         bool wasReadOnly = m_isReadOnly;
137         m_isReadOnly = !value.isNull();
138         if (wasReadOnly != m_isReadOnly) {
139             setNeedsWillValidateCheck();
140             setNeedsStyleRecalc();
141             if (renderer() && renderer()->style()->hasAppearance())
142                 renderer()->theme()->stateChanged(renderer(), ReadOnlyState);
143         }
144     } else if (name == requiredAttr) {
145         bool wasRequired = m_isRequired;
146         m_isRequired = !value.isNull();
147         if (wasRequired != m_isRequired)
148             requiredAttributeChanged();
149         FeatureObserver::observe(document(), FeatureObserver::RequiredAttribute);
150     } else if (name == autofocusAttr) {
151         HTMLElement::parseAttribute(name, value);
152         FeatureObserver::observe(document(), FeatureObserver::AutoFocusAttribute);
153     } else
154         HTMLElement::parseAttribute(name, value);
155 }
156
157 void HTMLFormControlElement::disabledAttributeChanged()
158 {
159     setNeedsWillValidateCheck();
160     didAffectSelector(AffectedSelectorDisabled | AffectedSelectorEnabled);
161     if (renderer() && renderer()->style()->hasAppearance())
162         renderer()->theme()->stateChanged(renderer(), EnabledState);
163 }
164
165 void HTMLFormControlElement::requiredAttributeChanged()
166 {
167     setNeedsValidityCheck();
168     // Style recalculation is needed because style selectors may include
169     // :required and :optional pseudo-classes.
170     setNeedsStyleRecalc();
171 }
172
173 static bool shouldAutofocus(HTMLFormControlElement* element)
174 {
175     if (!element->fastHasAttribute(autofocusAttr))
176         return false;
177     if (!element->renderer())
178         return false;
179     if (element->document()->ignoreAutofocus())
180         return false;
181     if (element->document()->isSandboxed(SandboxAutomaticFeatures)) {
182         // FIXME: This message should be moved off the console once a solution to https://bugs.webkit.org/show_bug.cgi?id=103274 exists.
183         element->document()->addConsoleMessage(SecurityMessageSource, ErrorMessageLevel, "Blocked autofocusing on a form control because the form's frame is sandboxed and the 'allow-scripts' permission is not set.");
184         return false;
185     }
186     if (element->hasAutofocused())
187         return false;
188
189     // FIXME: Should this set of hasTagName checks be replaced by a
190     // virtual member function?
191     if (isHTMLInputElement(element))
192         return !toHTMLInputElement(element)->isInputTypeHidden();
193     if (element->hasTagName(selectTag))
194         return true;
195     if (element->hasTagName(keygenTag))
196         return true;
197     if (element->hasTagName(buttonTag))
198         return true;
199     if (isHTMLTextAreaElement(element))
200         return true;
201
202     return false;
203 }
204
205 static void focusPostAttach(Node* element, unsigned)
206
207     toElement(element)->focus(); 
208     element->deref(); 
209 }
210
211 void HTMLFormControlElement::didAttachRenderers()
212 {
213     // The call to updateFromElement() needs to go after the call through
214     // to the base class's attach() because that can sometimes do a close
215     // on the renderer.
216     if (renderer())
217         renderer()->updateFromElement();
218
219     if (shouldAutofocus(this)) {
220         setAutofocused();
221         ref();
222         queuePostAttachCallback(focusPostAttach, this);
223     }
224 }
225
226 void HTMLFormControlElement::didMoveToNewDocument(Document* oldDocument)
227 {
228     FormAssociatedElement::didMoveToNewDocument(oldDocument);
229     HTMLElement::didMoveToNewDocument(oldDocument);
230 }
231
232 Node::InsertionNotificationRequest HTMLFormControlElement::insertedInto(ContainerNode* insertionPoint)
233 {
234     m_ancestorDisabledState = AncestorDisabledStateUnknown;
235     m_dataListAncestorState = Unknown;
236     setNeedsWillValidateCheck();
237     HTMLElement::insertedInto(insertionPoint);
238     FormAssociatedElement::insertedInto(insertionPoint);
239     return InsertionDone;
240 }
241
242 void HTMLFormControlElement::removedFrom(ContainerNode* insertionPoint)
243 {
244     m_validationMessage = nullptr;
245     m_ancestorDisabledState = AncestorDisabledStateUnknown;
246     m_dataListAncestorState = Unknown;
247     HTMLElement::removedFrom(insertionPoint);
248     FormAssociatedElement::removedFrom(insertionPoint);
249 }
250
251 void HTMLFormControlElement::setChangedSinceLastFormControlChangeEvent(bool changed)
252 {
253     m_wasChangedSinceLastFormControlChangeEvent = changed;
254 }
255
256 void HTMLFormControlElement::dispatchChangeEvent()
257 {
258     dispatchScopedEvent(Event::create(eventNames().changeEvent, true, false));
259 }
260
261 void HTMLFormControlElement::dispatchFormControlChangeEvent()
262 {
263     dispatchChangeEvent();
264     setChangedSinceLastFormControlChangeEvent(false);
265 }
266
267 void HTMLFormControlElement::dispatchFormControlInputEvent()
268 {
269     setChangedSinceLastFormControlChangeEvent(true);
270     HTMLElement::dispatchInputEvent();
271 }
272
273 bool HTMLFormControlElement::isDisabledFormControl() const
274 {
275     if (m_disabled)
276         return true;
277
278     if (m_ancestorDisabledState == AncestorDisabledStateUnknown)
279         updateAncestorDisabledState();
280     if (m_ancestorDisabledState == AncestorDisabledStateDisabled)
281         return true;
282     return HTMLElement::isDisabledFormControl();
283 }
284
285 bool HTMLFormControlElement::isRequired() const
286 {
287     return m_isRequired;
288 }
289
290 static void updateFromElementCallback(Node* node, unsigned)
291 {
292     ASSERT_ARG(node, node->isElementNode());
293     ASSERT_ARG(node, toElement(node)->isFormControlElement());
294     if (RenderObject* renderer = node->renderer())
295         renderer->updateFromElement();
296 }
297
298 void HTMLFormControlElement::didRecalcStyle(Style::Change)
299 {
300     // updateFromElement() can cause the selection to change, and in turn
301     // trigger synchronous layout, so it must not be called during style recalc.
302     if (renderer())
303         queuePostAttachCallback(updateFromElementCallback, this);
304 }
305
306 bool HTMLFormControlElement::supportsFocus() const
307 {
308     return !isDisabledFormControl();
309 }
310
311 bool HTMLFormControlElement::isFocusable() const
312 {
313     // If there's a renderer, make sure the size isn't empty, but if there's no renderer,
314     // it might still be focusable if it's in a canvas subtree (handled in Node::isFocusable).
315     if (renderer() && (!renderer()->isBox() || toRenderBox(renderer())->size().isEmpty()))
316         return false;
317     // HTMLElement::isFocusable handles visibility and calls suportsFocus which
318     // will cover the disabled case.
319     return HTMLElement::isFocusable();
320 }
321
322 bool HTMLFormControlElement::isKeyboardFocusable(KeyboardEvent* event) const
323 {
324     if (isFocusable())
325         if (document()->frame())
326             return document()->frame()->eventHandler().tabsToAllFormControls(event);
327     return false;
328 }
329
330 bool HTMLFormControlElement::isMouseFocusable() const
331 {
332 #if PLATFORM(GTK) || PLATFORM(QT)
333     return HTMLElement::isMouseFocusable();
334 #else
335     return false;
336 #endif
337 }
338
339 short HTMLFormControlElement::tabIndex() const
340 {
341     // Skip the supportsFocus check in HTMLElement.
342     return Element::tabIndex();
343 }
344
345 bool HTMLFormControlElement::recalcWillValidate() const
346 {
347     if (m_dataListAncestorState == Unknown) {
348         for (ContainerNode* ancestor = parentNode(); ancestor; ancestor = ancestor->parentNode()) {
349             if (ancestor->hasTagName(datalistTag)) {
350                 m_dataListAncestorState = InsideDataList;
351                 break;
352             }
353         }
354         if (m_dataListAncestorState == Unknown)
355             m_dataListAncestorState = NotInsideDataList;
356     }
357     return m_dataListAncestorState == NotInsideDataList && !isDisabledOrReadOnly();
358 }
359
360 bool HTMLFormControlElement::willValidate() const
361 {
362     if (!m_willValidateInitialized || m_dataListAncestorState == Unknown) {
363         m_willValidateInitialized = true;
364         bool newWillValidate = recalcWillValidate();
365         if (m_willValidate != newWillValidate) {
366             m_willValidate = newWillValidate;
367             const_cast<HTMLFormControlElement*>(this)->setNeedsValidityCheck();
368         }
369     } else {
370         // If the following assertion fails, setNeedsWillValidateCheck() is not
371         // called correctly when something which changes recalcWillValidate() result
372         // is updated.
373         ASSERT(m_willValidate == recalcWillValidate());
374     }
375     return m_willValidate;
376 }
377
378 void HTMLFormControlElement::setNeedsWillValidateCheck()
379 {
380     // We need to recalculate willValidate immediately because willValidate change can causes style change.
381     bool newWillValidate = recalcWillValidate();
382     if (m_willValidateInitialized && m_willValidate == newWillValidate)
383         return;
384     m_willValidateInitialized = true;
385     m_willValidate = newWillValidate;
386     setNeedsValidityCheck();
387     setNeedsStyleRecalc();
388     if (!m_willValidate)
389         hideVisibleValidationMessage();
390 }
391
392 void HTMLFormControlElement::updateVisibleValidationMessage()
393 {
394     Page* page = document()->page();
395     if (!page)
396         return;
397     String message;
398     if (renderer() && willValidate())
399         message = validationMessage().stripWhiteSpace();
400     if (!m_validationMessage)
401         m_validationMessage = ValidationMessage::create(this);
402     m_validationMessage->updateValidationMessage(message);
403 }
404
405 void HTMLFormControlElement::hideVisibleValidationMessage()
406 {
407     if (m_validationMessage)
408         m_validationMessage->requestToHideMessage();
409 }
410
411 bool HTMLFormControlElement::checkValidity(Vector<RefPtr<FormAssociatedElement> >* unhandledInvalidControls)
412 {
413     if (!willValidate() || isValidFormControlElement())
414         return true;
415     // An event handler can deref this object.
416     RefPtr<HTMLFormControlElement> protector(this);
417     RefPtr<Document> originalDocument(document());
418     bool needsDefaultAction = dispatchEvent(Event::create(eventNames().invalidEvent, false, true));
419     if (needsDefaultAction && unhandledInvalidControls && inDocument() && originalDocument == document())
420         unhandledInvalidControls->append(this);
421     return false;
422 }
423
424 bool HTMLFormControlElement::isValidFormControlElement()
425 {
426     // If the following assertion fails, setNeedsValidityCheck() is not called
427     // correctly when something which changes validity is updated.
428     ASSERT(m_isValid == validity()->valid());
429     return m_isValid;
430 }
431
432 void HTMLFormControlElement::setNeedsValidityCheck()
433 {
434     bool newIsValid = validity()->valid();
435     if (willValidate() && newIsValid != m_isValid) {
436         // Update style for pseudo classes such as :valid :invalid.
437         setNeedsStyleRecalc();
438     }
439     m_isValid = newIsValid;
440
441     // Updates only if this control already has a validtion message.
442     if (m_validationMessage && m_validationMessage->isVisible()) {
443         // Calls updateVisibleValidationMessage() even if m_isValid is not
444         // changed because a validation message can be chagned.
445         updateVisibleValidationMessage();
446     }
447 }
448
449 void HTMLFormControlElement::setCustomValidity(const String& error)
450 {
451     FormAssociatedElement::setCustomValidity(error);
452     setNeedsValidityCheck();
453 }
454
455 bool HTMLFormControlElement::validationMessageShadowTreeContains(const Node* node) const
456 {
457     return m_validationMessage && m_validationMessage->shadowTreeContains(node);
458 }
459
460 void HTMLFormControlElement::dispatchBlurEvent(PassRefPtr<Element> newFocusedElement)
461 {
462     HTMLElement::dispatchBlurEvent(newFocusedElement);
463     hideVisibleValidationMessage();
464 }
465
466 HTMLFormElement* HTMLFormControlElement::virtualForm() const
467 {
468     return FormAssociatedElement::form();
469 }
470
471 bool HTMLFormControlElement::isDefaultButtonForForm() const
472 {
473     return isSuccessfulSubmitButton() && form() && form()->defaultButton() == this;
474 }
475
476 HTMLFormControlElement* HTMLFormControlElement::enclosingFormControlElement(Node* node)
477 {
478     for (; node; node = node->parentNode()) {
479         if (node->isElementNode() && toElement(node)->isFormControlElement())
480             return static_cast<HTMLFormControlElement*>(node);
481     }
482     return 0;
483 }
484
485 } // namespace Webcore