Move dispatching of focus-related events from Node to Element.
[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 "ElementShadow.h"
30 #include "Event.h"
31 #include "EventHandler.h"
32 #include "EventNames.h"
33 #include "FeatureObserver.h"
34 #include "Frame.h"
35 #include "HTMLFieldSetElement.h"
36 #include "HTMLFormElement.h"
37 #include "HTMLInputElement.h"
38 #include "HTMLLegendElement.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 : findFormAncestor());
66     setHasCustomStyleCallbacks();
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 (element->hasTagName(inputTag))
192         return !static_cast<HTMLInputElement*>(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 (element->hasTagName(textareaTag))
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::attach()
212 {
213     PostAttachCallbackDisabler disabler(this);
214
215     HTMLElement::attach();
216
217     // The call to updateFromElement() needs to go after the call through
218     // to the base class's attach() because that can sometimes do a close
219     // on the renderer.
220     if (renderer())
221         renderer()->updateFromElement();
222
223     if (shouldAutofocus(this)) {
224         setAutofocused();
225         ref();
226         queuePostAttachCallback(focusPostAttach, this);
227     }
228 }
229
230 void HTMLFormControlElement::didMoveToNewDocument(Document* oldDocument)
231 {
232     FormAssociatedElement::didMoveToNewDocument(oldDocument);
233     HTMLElement::didMoveToNewDocument(oldDocument);
234 }
235
236 Node::InsertionNotificationRequest HTMLFormControlElement::insertedInto(ContainerNode* insertionPoint)
237 {
238     m_ancestorDisabledState = AncestorDisabledStateUnknown;
239     m_dataListAncestorState = Unknown;
240     setNeedsWillValidateCheck();
241     HTMLElement::insertedInto(insertionPoint);
242     FormAssociatedElement::insertedInto(insertionPoint);
243     return InsertionDone;
244 }
245
246 void HTMLFormControlElement::removedFrom(ContainerNode* insertionPoint)
247 {
248     m_validationMessage = nullptr;
249     m_ancestorDisabledState = AncestorDisabledStateUnknown;
250     m_dataListAncestorState = Unknown;
251     HTMLElement::removedFrom(insertionPoint);
252     FormAssociatedElement::removedFrom(insertionPoint);
253 }
254
255 void HTMLFormControlElement::setChangedSinceLastFormControlChangeEvent(bool changed)
256 {
257     m_wasChangedSinceLastFormControlChangeEvent = changed;
258 }
259
260 void HTMLFormControlElement::dispatchFormControlChangeEvent()
261 {
262     HTMLElement::dispatchChangeEvent();
263     setChangedSinceLastFormControlChangeEvent(false);
264 }
265
266 void HTMLFormControlElement::dispatchFormControlInputEvent()
267 {
268     setChangedSinceLastFormControlChangeEvent(true);
269     HTMLElement::dispatchInputEvent();
270 }
271
272 bool HTMLFormControlElement::isDisabledFormControl() const
273 {
274     if (m_disabled)
275         return true;
276
277     if (m_ancestorDisabledState == AncestorDisabledStateUnknown)
278         updateAncestorDisabledState();
279     if (m_ancestorDisabledState == AncestorDisabledStateDisabled)
280         return true;
281     return HTMLElement::isDisabledFormControl();
282 }
283
284 bool HTMLFormControlElement::isRequired() const
285 {
286     return m_isRequired;
287 }
288
289 static void updateFromElementCallback(Node* node, unsigned)
290 {
291     ASSERT_ARG(node, node->isElementNode());
292     ASSERT_ARG(node, toElement(node)->isFormControlElement());
293     if (RenderObject* renderer = node->renderer())
294         renderer->updateFromElement();
295 }
296
297 void HTMLFormControlElement::didRecalcStyle(StyleChange)
298 {
299     // updateFromElement() can cause the selection to change, and in turn
300     // trigger synchronous layout, so it must not be called during style recalc.
301     if (renderer())
302         queuePostAttachCallback(updateFromElementCallback, this);
303 }
304
305 bool HTMLFormControlElement::supportsFocus() const
306 {
307     return !isDisabledFormControl();
308 }
309
310 bool HTMLFormControlElement::isFocusable() const
311 {
312     // If there's a renderer, make sure the size isn't empty, but if there's no renderer,
313     // it might still be focusable if it's in a canvas subtree (handled in Node::isFocusable).
314     if (renderer() && (!renderer()->isBox() || toRenderBox(renderer())->size().isEmpty()))
315         return false;
316     // HTMLElement::isFocusable handles visibility and calls suportsFocus which
317     // will cover the disabled case.
318     return HTMLElement::isFocusable();
319 }
320
321 bool HTMLFormControlElement::isKeyboardFocusable(KeyboardEvent* event) const
322 {
323     if (isFocusable())
324         if (document()->frame())
325             return document()->frame()->eventHandler()->tabsToAllFormControls(event);
326     return false;
327 }
328
329 bool HTMLFormControlElement::isMouseFocusable() const
330 {
331 #if PLATFORM(GTK) || PLATFORM(QT)
332     return HTMLElement::isMouseFocusable();
333 #else
334     return false;
335 #endif
336 }
337
338 short HTMLFormControlElement::tabIndex() const
339 {
340     // Skip the supportsFocus check in HTMLElement.
341     return Element::tabIndex();
342 }
343
344 bool HTMLFormControlElement::recalcWillValidate() const
345 {
346     if (m_dataListAncestorState == Unknown) {
347         for (ContainerNode* ancestor = parentNode(); ancestor; ancestor = ancestor->parentNode()) {
348             if (ancestor->hasTagName(datalistTag)) {
349                 m_dataListAncestorState = InsideDataList;
350                 break;
351             }
352         }
353         if (m_dataListAncestorState == Unknown)
354             m_dataListAncestorState = NotInsideDataList;
355     }
356     return m_dataListAncestorState == NotInsideDataList && !isDisabledOrReadOnly();
357 }
358
359 bool HTMLFormControlElement::willValidate() const
360 {
361     if (!m_willValidateInitialized || m_dataListAncestorState == Unknown) {
362         m_willValidateInitialized = true;
363         bool newWillValidate = recalcWillValidate();
364         if (m_willValidate != newWillValidate) {
365             m_willValidate = newWillValidate;
366             const_cast<HTMLFormControlElement*>(this)->setNeedsValidityCheck();
367         }
368     } else {
369         // If the following assertion fails, setNeedsWillValidateCheck() is not
370         // called correctly when something which changes recalcWillValidate() result
371         // is updated.
372         ASSERT(m_willValidate == recalcWillValidate());
373     }
374     return m_willValidate;
375 }
376
377 void HTMLFormControlElement::setNeedsWillValidateCheck()
378 {
379     // We need to recalculate willValidate immediately because willValidate change can causes style change.
380     bool newWillValidate = recalcWillValidate();
381     if (m_willValidateInitialized && m_willValidate == newWillValidate)
382         return;
383     m_willValidateInitialized = true;
384     m_willValidate = newWillValidate;
385     setNeedsValidityCheck();
386     setNeedsStyleRecalc();
387     if (!m_willValidate)
388         hideVisibleValidationMessage();
389 }
390
391 void HTMLFormControlElement::updateVisibleValidationMessage()
392 {
393     Page* page = document()->page();
394     if (!page)
395         return;
396     String message;
397     if (renderer() && willValidate())
398         message = validationMessage().stripWhiteSpace();
399     if (!m_validationMessage)
400         m_validationMessage = ValidationMessage::create(this);
401     m_validationMessage->updateValidationMessage(message);
402 }
403
404 void HTMLFormControlElement::hideVisibleValidationMessage()
405 {
406     if (m_validationMessage)
407         m_validationMessage->requestToHideMessage();
408 }
409
410 bool HTMLFormControlElement::checkValidity(Vector<RefPtr<FormAssociatedElement> >* unhandledInvalidControls)
411 {
412     if (!willValidate() || isValidFormControlElement())
413         return true;
414     // An event handler can deref this object.
415     RefPtr<HTMLFormControlElement> protector(this);
416     RefPtr<Document> originalDocument(document());
417     bool needsDefaultAction = dispatchEvent(Event::create(eventNames().invalidEvent, false, true));
418     if (needsDefaultAction && unhandledInvalidControls && inDocument() && originalDocument == document())
419         unhandledInvalidControls->append(this);
420     return false;
421 }
422
423 bool HTMLFormControlElement::isValidFormControlElement()
424 {
425     // If the following assertion fails, setNeedsValidityCheck() is not called
426     // correctly when something which changes validity is updated.
427     ASSERT(m_isValid == validity()->valid());
428     return m_isValid;
429 }
430
431 void HTMLFormControlElement::setNeedsValidityCheck()
432 {
433     bool newIsValid = validity()->valid();
434     if (willValidate() && newIsValid != m_isValid) {
435         // Update style for pseudo classes such as :valid :invalid.
436         setNeedsStyleRecalc();
437     }
438     m_isValid = newIsValid;
439
440     // Updates only if this control already has a validtion message.
441     if (m_validationMessage && m_validationMessage->isVisible()) {
442         // Calls updateVisibleValidationMessage() even if m_isValid is not
443         // changed because a validation message can be chagned.
444         updateVisibleValidationMessage();
445     }
446 }
447
448 void HTMLFormControlElement::setCustomValidity(const String& error)
449 {
450     FormAssociatedElement::setCustomValidity(error);
451     setNeedsValidityCheck();
452 }
453
454 bool HTMLFormControlElement::validationMessageShadowTreeContains(Node* node) const
455 {
456     return m_validationMessage && m_validationMessage->shadowTreeContains(node);
457 }
458
459 void HTMLFormControlElement::dispatchBlurEvent(PassRefPtr<Element> newFocusedElement)
460 {
461     HTMLElement::dispatchBlurEvent(newFocusedElement);
462     hideVisibleValidationMessage();
463 }
464
465 HTMLFormElement* HTMLFormControlElement::virtualForm() const
466 {
467     return FormAssociatedElement::form();
468 }
469
470 bool HTMLFormControlElement::isDefaultButtonForForm() const
471 {
472     return isSuccessfulSubmitButton() && form() && form()->defaultButton() == this;
473 }
474
475 HTMLFormControlElement* HTMLFormControlElement::enclosingFormControlElement(Node* node)
476 {
477     for (; node; node = node->parentNode()) {
478         if (node->isElementNode() && toElement(node)->isFormControlElement())
479             return static_cast<HTMLFormControlElement*>(node);
480     }
481     return 0;
482 }
483
484 } // namespace Webcore