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