Rename HasCustomCallbacks to HasCustomStyleCallbacks
[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_readOnly(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->disabled() && !(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 oldReadOnly = m_readOnly;
137         m_readOnly = !value.isNull();
138         if (oldReadOnly != m_readOnly) {
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(HTMLMessageSource, 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     static_cast<Element*>(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 bool HTMLFormControlElement::wasChangedSinceLastFormControlChangeEvent() const
256 {
257     return m_wasChangedSinceLastFormControlChangeEvent;
258 }
259
260 void HTMLFormControlElement::setChangedSinceLastFormControlChangeEvent(bool changed)
261 {
262     m_wasChangedSinceLastFormControlChangeEvent = changed;
263 }
264
265 void HTMLFormControlElement::dispatchFormControlChangeEvent()
266 {
267     HTMLElement::dispatchChangeEvent();
268     setChangedSinceLastFormControlChangeEvent(false);
269 }
270
271 void HTMLFormControlElement::dispatchFormControlInputEvent()
272 {
273     setChangedSinceLastFormControlChangeEvent(true);
274     HTMLElement::dispatchInputEvent();
275 }
276
277 bool HTMLFormControlElement::disabled() const
278 {
279     if (m_disabled)
280         return true;
281
282     if (m_ancestorDisabledState == AncestorDisabledStateUnknown)
283         updateAncestorDisabledState();
284     return m_ancestorDisabledState == AncestorDisabledStateDisabled;
285 }
286
287 bool HTMLFormControlElement::isRequired() const
288 {
289     return m_isRequired;
290 }
291
292 static void updateFromElementCallback(Node* node, unsigned)
293 {
294     ASSERT_ARG(node, node->isElementNode());
295     ASSERT_ARG(node, static_cast<Element*>(node)->isFormControlElement());
296     if (RenderObject* renderer = node->renderer())
297         renderer->updateFromElement();
298 }
299
300 void HTMLFormControlElement::didRecalcStyle(StyleChange)
301 {
302     // updateFromElement() can cause the selection to change, and in turn
303     // trigger synchronous layout, so it must not be called during style recalc.
304     if (renderer())
305         queuePostAttachCallback(updateFromElementCallback, this);
306 }
307
308 bool HTMLFormControlElement::supportsFocus() const
309 {
310     return !disabled();
311 }
312
313 bool HTMLFormControlElement::isFocusable() const
314 {
315     // If there's a renderer, make sure the size isn't empty, but if there's no renderer,
316     // it might still be focusable if it's in a canvas subtree (handled in Node::isFocusable).
317     if (renderer() && (!renderer()->isBox() || toRenderBox(renderer())->size().isEmpty()))
318         return false;
319     // HTMLElement::isFocusable handles visibility and calls suportsFocus which
320     // will cover the disabled case.
321     return HTMLElement::isFocusable();
322 }
323
324 bool HTMLFormControlElement::isKeyboardFocusable(KeyboardEvent* event) const
325 {
326     if (isFocusable())
327         if (document()->frame())
328             return document()->frame()->eventHandler()->tabsToAllFormControls(event);
329     return false;
330 }
331
332 bool HTMLFormControlElement::isMouseFocusable() const
333 {
334 #if PLATFORM(GTK) || PLATFORM(QT)
335     return HTMLElement::isMouseFocusable();
336 #else
337     return false;
338 #endif
339 }
340
341 short HTMLFormControlElement::tabIndex() const
342 {
343     // Skip the supportsFocus check in HTMLElement.
344     return Element::tabIndex();
345 }
346
347 bool HTMLFormControlElement::recalcWillValidate() const
348 {
349     if (m_dataListAncestorState == Unknown) {
350         for (ContainerNode* ancestor = parentNode(); ancestor; ancestor = ancestor->parentNode()) {
351             if (ancestor->hasTagName(datalistTag)) {
352                 m_dataListAncestorState = InsideDataList;
353                 break;
354             }
355         }
356         if (m_dataListAncestorState == Unknown)
357             m_dataListAncestorState = NotInsideDataList;
358     }
359     return m_dataListAncestorState == NotInsideDataList && !isDisabledOrReadOnly();
360 }
361
362 bool HTMLFormControlElement::willValidate() const
363 {
364     if (!m_willValidateInitialized || m_dataListAncestorState == Unknown) {
365         m_willValidateInitialized = true;
366         bool newWillValidate = recalcWillValidate();
367         if (m_willValidate != newWillValidate) {
368             m_willValidate = newWillValidate;
369             const_cast<HTMLFormControlElement*>(this)->setNeedsValidityCheck();
370         }
371     } else {
372         // If the following assertion fails, setNeedsWillValidateCheck() is not
373         // called correctly when something which changes recalcWillValidate() result
374         // is updated.
375         ASSERT(m_willValidate == recalcWillValidate());
376     }
377     return m_willValidate;
378 }
379
380 void HTMLFormControlElement::setNeedsWillValidateCheck()
381 {
382     // We need to recalculate willValidate immediately because willValidate change can causes style change.
383     bool newWillValidate = recalcWillValidate();
384     if (m_willValidateInitialized && m_willValidate == newWillValidate)
385         return;
386     m_willValidateInitialized = true;
387     m_willValidate = newWillValidate;
388     setNeedsValidityCheck();
389     setNeedsStyleRecalc();
390     if (!m_willValidate)
391         hideVisibleValidationMessage();
392 }
393
394 void HTMLFormControlElement::updateVisibleValidationMessage()
395 {
396     Page* page = document()->page();
397     if (!page)
398         return;
399     String message;
400     if (renderer() && willValidate())
401         message = validationMessage().stripWhiteSpace();
402     if (!m_validationMessage)
403         m_validationMessage = ValidationMessage::create(this);
404     m_validationMessage->updateValidationMessage(message);
405 }
406
407 void HTMLFormControlElement::hideVisibleValidationMessage()
408 {
409     if (m_validationMessage)
410         m_validationMessage->requestToHideMessage();
411 }
412
413 bool HTMLFormControlElement::checkValidity(Vector<RefPtr<FormAssociatedElement> >* unhandledInvalidControls)
414 {
415     if (!willValidate() || isValidFormControlElement())
416         return true;
417     // An event handler can deref this object.
418     RefPtr<HTMLFormControlElement> protector(this);
419     RefPtr<Document> originalDocument(document());
420     bool needsDefaultAction = dispatchEvent(Event::create(eventNames().invalidEvent, false, true));
421     if (needsDefaultAction && unhandledInvalidControls && inDocument() && originalDocument == document())
422         unhandledInvalidControls->append(this);
423     return false;
424 }
425
426 bool HTMLFormControlElement::isValidFormControlElement()
427 {
428     // If the following assertion fails, setNeedsValidityCheck() is not called
429     // correctly when something which changes validity is updated.
430     ASSERT(m_isValid == validity()->valid());
431     return m_isValid;
432 }
433
434 void HTMLFormControlElement::setNeedsValidityCheck()
435 {
436     bool newIsValid = validity()->valid();
437     if (willValidate() && newIsValid != m_isValid) {
438         // Update style for pseudo classes such as :valid :invalid.
439         setNeedsStyleRecalc();
440     }
441     m_isValid = newIsValid;
442
443     // Updates only if this control already has a validtion message.
444     if (m_validationMessage && m_validationMessage->isVisible()) {
445         // Calls updateVisibleValidationMessage() even if m_isValid is not
446         // changed because a validation message can be chagned.
447         updateVisibleValidationMessage();
448     }
449 }
450
451 void HTMLFormControlElement::setCustomValidity(const String& error)
452 {
453     FormAssociatedElement::setCustomValidity(error);
454     setNeedsValidityCheck();
455 }
456
457 bool HTMLFormControlElement::validationMessageShadowTreeContains(Node* node) const
458 {
459     return m_validationMessage && m_validationMessage->shadowTreeContains(node);
460 }
461
462 void HTMLFormControlElement::dispatchBlurEvent(PassRefPtr<Node> newFocusedNode)
463 {
464     HTMLElement::dispatchBlurEvent(newFocusedNode);
465     hideVisibleValidationMessage();
466 }
467
468 HTMLFormElement* HTMLFormControlElement::virtualForm() const
469 {
470     return FormAssociatedElement::form();
471 }
472
473 bool HTMLFormControlElement::isDefaultButtonForForm() const
474 {
475     return isSuccessfulSubmitButton() && form() && form()->defaultButton() == this;
476 }
477
478 HTMLFormControlElement* HTMLFormControlElement::enclosingFormControlElement(Node* node)
479 {
480     for (; node; node = node->parentNode()) {
481         if (node->isElementNode() && toElement(node)->isFormControlElement())
482             return static_cast<HTMLFormControlElement*>(node);
483     }
484     return 0;
485 }
486
487 void HTMLFormControlElement::reportMemoryUsage(MemoryObjectInfo* memoryObjectInfo) const
488 {
489     MemoryClassInfo info(memoryObjectInfo, this, WebCoreMemoryTypes::DOM);
490     LabelableElement::reportMemoryUsage(memoryObjectInfo);
491     info.addMember(m_validationMessage, "validationMessage");
492 }
493
494 } // namespace Webcore