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