12a84fe84764e3674b986092cdb0f98970128db4
[WebKit-https.git] / Source / WebCore / html / HTMLFormElement.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, 2008, 2009 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 "HTMLFormElement.h"
27
28 #include "AutocompleteErrorEvent.h"
29 #include "DOMFormData.h"
30 #include "DOMWindow.h"
31 #include "Document.h"
32 #include "ElementIterator.h"
33 #include "Event.h"
34 #include "EventNames.h"
35 #include "FormController.h"
36 #include "FormData.h"
37 #include "Frame.h"
38 #include "FrameLoader.h"
39 #include "FrameLoaderClient.h"
40 #include "HTMLFieldSetElement.h"
41 #include "HTMLFormControlsCollection.h"
42 #include "HTMLImageElement.h"
43 #include "HTMLInputElement.h"
44 #include "HTMLNames.h"
45 #include "HTMLObjectElement.h"
46 #include "HTMLTableElement.h"
47 #include "NodeRareData.h"
48 #include "Page.h"
49 #include "RenderTextControl.h"
50 #include "ScriptController.h"
51 #include "Settings.h"
52 #include <limits>
53 #include <wtf/Ref.h>
54
55 namespace WebCore {
56
57 using namespace HTMLNames;
58
59 HTMLFormElement::HTMLFormElement(const QualifiedName& tagName, Document& document)
60     : HTMLElement(tagName, document)
61     , m_associatedElementsBeforeIndex(0)
62     , m_associatedElementsAfterIndex(0)
63     , m_wasUserSubmitted(false)
64     , m_isSubmittingOrPreparingForSubmission(false)
65     , m_shouldSubmit(false)
66     , m_isInResetFunction(false)
67     , m_wasDemoted(false)
68 #if ENABLE(REQUEST_AUTOCOMPLETE)
69     , m_requestAutocompletetimer(*this, &HTMLFormElement::requestAutocompleteTimerFired)
70 #endif
71 {
72     ASSERT(hasTagName(formTag));
73 }
74
75 Ref<HTMLFormElement> HTMLFormElement::create(Document& document)
76 {
77     return adoptRef(*new HTMLFormElement(formTag, document));
78 }
79
80 Ref<HTMLFormElement> HTMLFormElement::create(const QualifiedName& tagName, Document& document)
81 {
82     return adoptRef(*new HTMLFormElement(tagName, document));
83 }
84
85 HTMLFormElement::~HTMLFormElement()
86 {
87     document().formController().willDeleteForm(this);
88     if (!shouldAutocomplete())
89         document().unregisterForDocumentSuspensionCallbacks(this);
90
91     m_defaultButton = nullptr;
92     for (auto& associatedElement : m_associatedElements)
93         associatedElement->formWillBeDestroyed();
94     for (auto& imageElement : m_imageElements)
95         imageElement->m_form = nullptr;
96 }
97
98 bool HTMLFormElement::formWouldHaveSecureSubmission(const String& url)
99 {
100     return document().completeURL(url).protocolIs("https");
101 }
102
103 bool HTMLFormElement::rendererIsNeeded(const RenderStyle& style)
104 {
105     if (!m_wasDemoted)
106         return HTMLElement::rendererIsNeeded(style);
107
108     auto parent = parentNode();
109     auto parentRenderer = parent->renderer();
110
111     if (!parentRenderer)
112         return false;
113
114     // FIXME: Shouldn't we also check for table caption (see |formIsTablePart| below).
115     bool parentIsTableElementPart = (parentRenderer->isTable() && is<HTMLTableElement>(*parent))
116         || (parentRenderer->isTableRow() && parent->hasTagName(trTag))
117         || (parentRenderer->isTableSection() && parent->hasTagName(tbodyTag))
118         || (parentRenderer->isRenderTableCol() && parent->hasTagName(colTag))
119         || (parentRenderer->isTableCell() && parent->hasTagName(trTag));
120
121     if (!parentIsTableElementPart)
122         return true;
123
124     EDisplay display = style.display();
125     bool formIsTablePart = display == TABLE || display == INLINE_TABLE || display == TABLE_ROW_GROUP
126         || display == TABLE_HEADER_GROUP || display == TABLE_FOOTER_GROUP || display == TABLE_ROW
127         || display == TABLE_COLUMN_GROUP || display == TABLE_COLUMN || display == TABLE_CELL
128         || display == TABLE_CAPTION;
129
130     return formIsTablePart;
131 }
132
133 Node::InsertionNotificationRequest HTMLFormElement::insertedInto(ContainerNode& insertionPoint)
134 {
135     HTMLElement::insertedInto(insertionPoint);
136     if (insertionPoint.inDocument())
137         document().didAssociateFormControl(this);
138     return InsertionDone;
139 }
140
141 static inline Node* findRoot(Node* n)
142 {
143     Node* root = n;
144     for (; n; n = n->parentNode())
145         root = n;
146     return root;
147 }
148
149 void HTMLFormElement::removedFrom(ContainerNode& insertionPoint)
150 {
151     Node* root = findRoot(this);
152     Vector<FormAssociatedElement*> associatedElements(m_associatedElements);
153     for (auto& associatedElement : associatedElements)
154         associatedElement->formRemovedFromTree(root);
155     HTMLElement::removedFrom(insertionPoint);
156 }
157
158 void HTMLFormElement::handleLocalEvents(Event& event)
159 {
160     Node* targetNode = event.target()->toNode();
161     if (event.eventPhase() != Event::CAPTURING_PHASE && targetNode && targetNode != this && (event.type() == eventNames().submitEvent || event.type() == eventNames().resetEvent)) {
162         event.stopPropagation();
163         return;
164     }
165     HTMLElement::handleLocalEvents(event);
166 }
167
168 unsigned HTMLFormElement::length() const
169 {
170     unsigned len = 0;
171     for (auto& associatedElement : m_associatedElements) {
172         if (associatedElement->isEnumeratable())
173             ++len;
174     }
175     return len;
176 }
177
178 HTMLElement* HTMLFormElement::item(unsigned index)
179 {
180     return elements()->item(index);
181 }
182
183 void HTMLFormElement::submitImplicitly(Event& event, bool fromImplicitSubmissionTrigger)
184 {
185     unsigned submissionTriggerCount = 0;
186     for (auto& formAssociatedElement : m_associatedElements) {
187         if (!is<HTMLFormControlElement>(*formAssociatedElement))
188             continue;
189         HTMLFormControlElement& formElement = downcast<HTMLFormControlElement>(*formAssociatedElement);
190         if (formElement.isSuccessfulSubmitButton()) {
191             if (formElement.renderer()) {
192                 formElement.dispatchSimulatedClick(&event);
193                 return;
194             }
195         } else if (formElement.canTriggerImplicitSubmission())
196             ++submissionTriggerCount;
197     }
198
199     if (!submissionTriggerCount)
200         return;
201
202     // Older iOS apps using WebViews expect the behavior of auto submitting multi-input forms.
203     Settings* settings = document().settings();
204     if (fromImplicitSubmissionTrigger && (submissionTriggerCount == 1 || (settings && settings->allowMultiElementImplicitSubmission())))
205         prepareForSubmission(event);
206 }
207
208 static inline HTMLFormControlElement* submitElementFromEvent(const Event& event)
209 {
210     for (Node* node = event.target()->toNode(); node; node = node->parentNode()) {
211         if (is<HTMLFormControlElement>(*node))
212             return downcast<HTMLFormControlElement>(node);
213     }
214     return nullptr;
215 }
216
217 bool HTMLFormElement::validateInteractively(Event& event)
218 {
219     if (!document().page() || !document().page()->settings().interactiveFormValidationEnabled() || noValidate())
220         return true;
221
222     HTMLFormControlElement* submitElement = submitElementFromEvent(event);
223     if (submitElement && submitElement->formNoValidate())
224         return true;
225
226     for (auto& associatedElement : m_associatedElements) {
227         if (is<HTMLFormControlElement>(*associatedElement))
228             downcast<HTMLFormControlElement>(*associatedElement).hideVisibleValidationMessage();
229     }
230
231     Vector<RefPtr<FormAssociatedElement>> unhandledInvalidControls;
232     if (!checkInvalidControlsAndCollectUnhandled(unhandledInvalidControls))
233         return true;
234     // Because the form has invalid controls, we abort the form submission and
235     // show a validation message on a focusable form control.
236
237     // Needs to update layout now because we'd like to call isFocusable(), which
238     // has !renderer()->needsLayout() assertion.
239     document().updateLayoutIgnorePendingStylesheets();
240
241     Ref<HTMLFormElement> protectedThis(*this);
242
243     // Focus on the first focusable control and show a validation message.
244     for (auto& control : unhandledInvalidControls) {
245         HTMLElement& element = control->asHTMLElement();
246         if (element.inDocument() && element.isFocusable()) {
247             element.scrollIntoViewIfNeeded(false);
248             element.focus();
249             if (is<HTMLFormControlElement>(element))
250                 downcast<HTMLFormControlElement>(element).updateVisibleValidationMessage();
251             break;
252         }
253     }
254
255     // Warn about all of unfocusable controls.
256     if (document().frame()) {
257         for (auto& control : unhandledInvalidControls) {
258             HTMLElement& element = control->asHTMLElement();
259             if (element.inDocument() && element.isFocusable())
260                 continue;
261             String message("An invalid form control with name='%name' is not focusable.");
262             message.replace("%name", control->name());
263             document().addConsoleMessage(MessageSource::Rendering, MessageLevel::Error, message);
264         }
265     }
266
267     return false;
268 }
269
270 void HTMLFormElement::prepareForSubmission(Event& event)
271 {
272     Frame* frame = document().frame();
273     if (m_isSubmittingOrPreparingForSubmission || !frame)
274         return;
275
276     m_isSubmittingOrPreparingForSubmission = true;
277     m_shouldSubmit = false;
278
279     // Interactive validation must be done before dispatching the submit event.
280     if (!validateInteractively(event)) {
281         m_isSubmittingOrPreparingForSubmission = false;
282         return;
283     }
284
285     StringPairVector controlNamesAndValues;
286     getTextFieldValues(controlNamesAndValues);
287     auto formState = FormState::create(this, controlNamesAndValues, &document(), NotSubmittedByJavaScript);
288     frame->loader().client().dispatchWillSendSubmitEvent(WTFMove(formState));
289
290     Ref<HTMLFormElement> protectedThis(*this);
291     // Event handling can result in m_shouldSubmit becoming true, regardless of dispatchEvent() return value.
292     if (dispatchEvent(Event::create(eventNames().submitEvent, true, true)))
293         m_shouldSubmit = true;
294
295     m_isSubmittingOrPreparingForSubmission = false;
296
297     if (m_shouldSubmit)
298         submit(&event, true, true, NotSubmittedByJavaScript);
299 }
300
301 void HTMLFormElement::submit()
302 {
303     submit(0, false, true, NotSubmittedByJavaScript);
304 }
305
306 void HTMLFormElement::submitFromJavaScript()
307 {
308     submit(0, false, ScriptController::processingUserGesture(), SubmittedByJavaScript);
309 }
310
311 void HTMLFormElement::getTextFieldValues(StringPairVector& fieldNamesAndValues) const
312 {
313     ASSERT_ARG(fieldNamesAndValues, fieldNamesAndValues.isEmpty());
314
315     fieldNamesAndValues.reserveCapacity(m_associatedElements.size());
316     for (auto& associatedElement : m_associatedElements) {
317         HTMLElement& element = associatedElement->asHTMLElement();
318         if (!is<HTMLInputElement>(element))
319             continue;
320         HTMLInputElement& input = downcast<HTMLInputElement>(element);
321         if (!input.isTextField())
322             continue;
323         fieldNamesAndValues.append(std::make_pair(input.name().string(), input.value()));
324     }
325 }
326
327 void HTMLFormElement::submit(Event* event, bool activateSubmitButton, bool processingUserGesture, FormSubmissionTrigger formSubmissionTrigger)
328 {
329     FrameView* view = document().view();
330     Frame* frame = document().frame();
331     if (!view || !frame)
332         return;
333
334     if (m_isSubmittingOrPreparingForSubmission) {
335         m_shouldSubmit = true;
336         return;
337     }
338
339     m_isSubmittingOrPreparingForSubmission = true;
340     m_wasUserSubmitted = processingUserGesture;
341
342     RefPtr<HTMLFormControlElement> firstSuccessfulSubmitButton;
343     bool needButtonActivation = activateSubmitButton; // do we need to activate a submit button?
344
345     for (auto& associatedElement : m_associatedElements) {
346         if (!is<HTMLFormControlElement>(*associatedElement))
347             continue;
348         if (needButtonActivation) {
349             HTMLFormControlElement& control = downcast<HTMLFormControlElement>(*associatedElement);
350             if (control.isActivatedSubmit())
351                 needButtonActivation = false;
352             else if (!firstSuccessfulSubmitButton && control.isSuccessfulSubmitButton())
353                 firstSuccessfulSubmitButton = &control;
354         }
355     }
356
357     if (needButtonActivation && firstSuccessfulSubmitButton)
358         firstSuccessfulSubmitButton->setActivatedSubmit(true);
359
360     LockHistory lockHistory = processingUserGesture ? LockHistory::No : LockHistory::Yes;
361     Ref<HTMLFormElement> protectedThis(*this); // Form submission can execute arbitary JavaScript.
362     frame->loader().submitForm(FormSubmission::create(this, m_attributes, event, lockHistory, formSubmissionTrigger));
363
364     if (needButtonActivation && firstSuccessfulSubmitButton)
365         firstSuccessfulSubmitButton->setActivatedSubmit(false);
366
367     m_shouldSubmit = false;
368     m_isSubmittingOrPreparingForSubmission = false;
369 }
370
371 void HTMLFormElement::reset()
372 {
373     Frame* frame = document().frame();
374     if (m_isInResetFunction || !frame)
375         return;
376
377     m_isInResetFunction = true;
378
379     if (!dispatchEvent(Event::create(eventNames().resetEvent, true, true))) {
380         m_isInResetFunction = false;
381         return;
382     }
383
384     for (auto& associatedElement : m_associatedElements) {
385         if (is<HTMLFormControlElement>(*associatedElement))
386             downcast<HTMLFormControlElement>(*associatedElement).reset();
387     }
388
389     m_isInResetFunction = false;
390 }
391
392 #if ENABLE(IOS_AUTOCORRECT_AND_AUTOCAPITALIZE)
393
394 // FIXME: We should look to share this code with class HTMLFormControlElement instead of duplicating the logic.
395
396 bool HTMLFormElement::autocorrect() const
397 {
398     const AtomicString& autocorrectValue = attributeWithoutSynchronization(autocorrectAttr);
399     if (!autocorrectValue.isEmpty())
400         return !equalLettersIgnoringASCIICase(autocorrectValue, "off");
401     if (HTMLFormElement* form = this->form())
402         return form->autocorrect();
403     return true;
404 }
405
406 void HTMLFormElement::setAutocorrect(bool autocorrect)
407 {
408     setAttributeWithoutSynchronization(autocorrectAttr, autocorrect ? AtomicString("on", AtomicString::ConstructFromLiteral) : AtomicString("off", AtomicString::ConstructFromLiteral));
409 }
410
411 WebAutocapitalizeType HTMLFormElement::autocapitalizeType() const
412 {
413     return autocapitalizeTypeForAttributeValue(attributeWithoutSynchronization(autocapitalizeAttr));
414 }
415
416 const AtomicString& HTMLFormElement::autocapitalize() const
417 {
418     return stringForAutocapitalizeType(autocapitalizeType());
419 }
420
421 void HTMLFormElement::setAutocapitalize(const AtomicString& value)
422 {
423     setAttributeWithoutSynchronization(autocapitalizeAttr, value);
424 }
425
426 #endif
427
428 #if ENABLE(REQUEST_AUTOCOMPLETE)
429
430 void HTMLFormElement::requestAutocomplete()
431 {
432     Frame* frame = document().frame();
433     if (!frame)
434         return;
435
436     if (!shouldAutocomplete() || !ScriptController::processingUserGesture()) {
437         finishRequestAutocomplete(AutocompleteResult::ErrorDisabled);
438         return;
439     }
440
441     StringPairVector controlNamesAndValues;
442     getTextFieldValues(controlNamesAndValues);
443
444     RefPtr<FormState> formState = FormState::create(this, controlNamesAndValues, &document(), SubmittedByJavaScript);
445     frame->loader().client().didRequestAutocomplete(formState.release());
446 }
447
448 void HTMLFormElement::finishRequestAutocomplete(AutocompleteResult result)
449 {
450     RefPtr<Event> event;
451     switch (result) {
452     case AutocompleteResult::Success:
453         event = Event::create(eventNames().autocompleteEvent, false, false);
454         break;
455     case AutocompleteResult::ErrorDisabled:
456         event = AutocompleteErrorEvent::create("disabled");
457         break;
458     case AutocompleteResult::ErrorCancel:
459         event = AutocompleteErrorEvent::create("cancel");
460         break;
461     case AutocompleteResult::ErrorInvalid:
462         event = AutocompleteErrorEvent::create("invalid");
463         break;
464     }
465
466     event->setTarget(this);
467     m_pendingAutocompleteEvents.append(WTFMove(event));
468
469     // Dispatch events later as this API is meant to work asynchronously in all situations and implementations.
470     if (!m_requestAutocompleteTimer.isActive())
471         m_requestAutocompleteTimer.startOneShot(0);
472 }
473
474 void HTMLFormElement::requestAutocompleteTimerFired()
475 {
476     Vector<RefPtr<Event>> pendingEvents;
477     m_pendingAutocompleteEvents.swap(pendingEvents);
478     for (auto& pendingEvent : pendingEvents)
479         dispatchEvent(pendingEvent.release());
480 }
481
482 #endif
483
484 void HTMLFormElement::parseAttribute(const QualifiedName& name, const AtomicString& value)
485 {
486     if (name == actionAttr) {
487         m_attributes.parseAction(value);
488         
489         if (!m_attributes.action().isEmpty()) {
490             if (Frame* f = document().frame()) {
491                 Frame& topFrame = f->tree().top();
492                 topFrame.loader().mixedContentChecker().checkFormForMixedContent(topFrame.document()->securityOrigin(), document().completeURL(m_attributes.action()));
493             }
494         }
495     } else if (name == targetAttr)
496         m_attributes.setTarget(value);
497     else if (name == methodAttr)
498         m_attributes.updateMethodType(value);
499     else if (name == enctypeAttr)
500         m_attributes.updateEncodingType(value);
501     else if (name == accept_charsetAttr)
502         m_attributes.setAcceptCharset(value);
503     else if (name == autocompleteAttr) {
504         if (!shouldAutocomplete())
505             document().registerForDocumentSuspensionCallbacks(this);
506         else
507             document().unregisterForDocumentSuspensionCallbacks(this);
508     } else
509         HTMLElement::parseAttribute(name, value);
510 }
511
512 unsigned HTMLFormElement::formElementIndexWithFormAttribute(Element* element, unsigned rangeStart, unsigned rangeEnd)
513 {
514     if (m_associatedElements.isEmpty())
515         return 0;
516
517     ASSERT(rangeStart <= rangeEnd);
518
519     if (rangeStart == rangeEnd)
520         return rangeStart;
521
522     unsigned left = rangeStart;
523     unsigned right = rangeEnd - 1;
524     unsigned short position;
525
526     // Does binary search on m_associatedElements in order to find the index
527     // to be inserted.
528     while (left != right) {
529         unsigned middle = left + ((right - left) / 2);
530         ASSERT(middle < m_associatedElementsBeforeIndex || middle >= m_associatedElementsAfterIndex);
531         position = element->compareDocumentPosition(m_associatedElements[middle]->asHTMLElement());
532         if (position & DOCUMENT_POSITION_FOLLOWING)
533             right = middle;
534         else
535             left = middle + 1;
536     }
537     
538     ASSERT(left < m_associatedElementsBeforeIndex || left >= m_associatedElementsAfterIndex);
539     position = element->compareDocumentPosition(m_associatedElements[left]->asHTMLElement());
540     if (position & DOCUMENT_POSITION_FOLLOWING)
541         return left;
542     return left + 1;
543 }
544
545 unsigned HTMLFormElement::formElementIndex(FormAssociatedElement* associatedElement)
546 {
547     ASSERT(associatedElement);
548
549     HTMLElement& associatedHTMLElement = associatedElement->asHTMLElement();
550
551     // Treats separately the case where this element has the form attribute
552     // for performance consideration.
553     if (associatedHTMLElement.hasAttributeWithoutSynchronization(formAttr)) {
554         unsigned short position = compareDocumentPosition(associatedHTMLElement);
555         if (position & DOCUMENT_POSITION_PRECEDING) {
556             ++m_associatedElementsBeforeIndex;
557             ++m_associatedElementsAfterIndex;
558             return HTMLFormElement::formElementIndexWithFormAttribute(&associatedHTMLElement, 0, m_associatedElementsBeforeIndex - 1);
559         }
560         if (position & DOCUMENT_POSITION_FOLLOWING && !(position & DOCUMENT_POSITION_CONTAINED_BY))
561             return HTMLFormElement::formElementIndexWithFormAttribute(&associatedHTMLElement, m_associatedElementsAfterIndex, m_associatedElements.size());
562     }
563
564     unsigned currentAssociatedElementsAfterIndex = m_associatedElementsAfterIndex;
565     ++m_associatedElementsAfterIndex;
566
567     if (!associatedHTMLElement.isDescendantOf(this))
568         return currentAssociatedElementsAfterIndex;
569
570     // Check for the special case where this element is the very last thing in
571     // the form's tree of children; we don't want to walk the entire tree in that
572     // common case that occurs during parsing; instead we'll just return a value
573     // that says "add this form element to the end of the array".
574     auto descendants = descendantsOfType<HTMLElement>(*this);
575     auto it = descendants.beginAt(associatedHTMLElement);
576     auto end = descendants.end();
577     if (++it == end)
578         return currentAssociatedElementsAfterIndex;
579
580     unsigned i = m_associatedElementsBeforeIndex;
581     for (auto& element : descendants) {
582         if (&element == &associatedHTMLElement)
583             return i;
584         if (!is<HTMLFormControlElement>(element) && !is<HTMLObjectElement>(element))
585             continue;
586         if (element.form() != this)
587             continue;
588         ++i;
589     }
590     return currentAssociatedElementsAfterIndex;
591 }
592
593 void HTMLFormElement::registerFormElement(FormAssociatedElement* e)
594 {
595     m_associatedElements.insert(formElementIndex(e), e);
596
597     if (is<HTMLFormControlElement>(e)) {
598         HTMLFormControlElement& control = downcast<HTMLFormControlElement>(*e);
599         if (control.isSuccessfulSubmitButton()) {
600             if (!m_defaultButton)
601                 control.setNeedsStyleRecalc();
602             else
603                 resetDefaultButton();
604         }
605     }
606 }
607
608 void HTMLFormElement::removeFormElement(FormAssociatedElement* e)
609 {
610     unsigned index = m_associatedElements.find(e);
611     ASSERT_WITH_SECURITY_IMPLICATION(index < m_associatedElements.size());
612     if (index < m_associatedElementsBeforeIndex)
613         --m_associatedElementsBeforeIndex;
614     if (index < m_associatedElementsAfterIndex)
615         --m_associatedElementsAfterIndex;
616     removeFromPastNamesMap(e);
617     m_associatedElements.remove(index);
618
619     if (e == m_defaultButton)
620         resetDefaultButton();
621 }
622
623 void HTMLFormElement::registerInvalidAssociatedFormControl(const HTMLFormControlElement& formControlElement)
624 {
625     ASSERT_WITH_MESSAGE(!is<HTMLFieldSetElement>(formControlElement), "FieldSet are never candidates for constraint validation.");
626     ASSERT(static_cast<const Element&>(formControlElement).matchesInvalidPseudoClass());
627
628     if (m_invalidAssociatedFormControls.isEmpty())
629         setNeedsStyleRecalc();
630     m_invalidAssociatedFormControls.add(&formControlElement);
631 }
632
633 void HTMLFormElement::removeInvalidAssociatedFormControlIfNeeded(const HTMLFormControlElement& formControlElement)
634 {
635     if (m_invalidAssociatedFormControls.remove(&formControlElement)) {
636         if (m_invalidAssociatedFormControls.isEmpty())
637             setNeedsStyleRecalc();
638     }
639 }
640
641 bool HTMLFormElement::isURLAttribute(const Attribute& attribute) const
642 {
643     return attribute.name() == actionAttr || HTMLElement::isURLAttribute(attribute);
644 }
645
646 void HTMLFormElement::registerImgElement(HTMLImageElement* e)
647 {
648     ASSERT(m_imageElements.find(e) == notFound);
649     m_imageElements.append(e);
650 }
651
652 void HTMLFormElement::removeImgElement(HTMLImageElement* e)
653 {
654     removeFromPastNamesMap(e);
655     bool removed = m_imageElements.removeFirst(e);
656     ASSERT_UNUSED(removed, removed);
657 }
658
659 Ref<HTMLFormControlsCollection> HTMLFormElement::elements()
660 {
661     return ensureRareData().ensureNodeLists().addCachedCollection<HTMLFormControlsCollection>(*this, FormControls);
662 }
663
664 Ref<HTMLCollection> HTMLFormElement::elementsForNativeBindings()
665 {
666     return elements();
667 }
668
669 String HTMLFormElement::name() const
670 {
671     return getNameAttribute();
672 }
673
674 bool HTMLFormElement::noValidate() const
675 {
676     return hasAttributeWithoutSynchronization(novalidateAttr);
677 }
678
679 // FIXME: This function should be removed because it does not do the same thing as the
680 // JavaScript binding for action, which treats action as a URL attribute. Last time I
681 // (Darin Adler) removed this, someone added it back, so I am leaving it in for now.
682 String HTMLFormElement::action() const
683 {
684     return attributeWithoutSynchronization(actionAttr);
685 }
686
687 void HTMLFormElement::setAction(const String &value)
688 {
689     setAttributeWithoutSynchronization(actionAttr, value);
690 }
691
692 void HTMLFormElement::setEnctype(const String &value)
693 {
694     setAttributeWithoutSynchronization(enctypeAttr, value);
695 }
696
697 String HTMLFormElement::method() const
698 {
699     return FormSubmission::Attributes::methodString(m_attributes.method());
700 }
701
702 void HTMLFormElement::setMethod(const String &value)
703 {
704     setAttributeWithoutSynchronization(methodAttr, value);
705 }
706
707 String HTMLFormElement::target() const
708 {
709     return attributeWithoutSynchronization(targetAttr);
710 }
711
712 bool HTMLFormElement::wasUserSubmitted() const
713 {
714     return m_wasUserSubmitted;
715 }
716
717 HTMLFormControlElement* HTMLFormElement::defaultButton() const
718 {
719     if (!m_defaultButton) {
720         for (auto& associatedElement : m_associatedElements) {
721             if (!is<HTMLFormControlElement>(*associatedElement))
722                 continue;
723             HTMLFormControlElement& control = downcast<HTMLFormControlElement>(*associatedElement);
724             if (control.isSuccessfulSubmitButton()) {
725                 m_defaultButton = &control;
726                 break;
727             }
728         }
729     }
730     return m_defaultButton;
731 }
732
733 void HTMLFormElement::resetDefaultButton()
734 {
735     if (!m_defaultButton) {
736         // Computing the default button is not cheap, we don't want to do it unless needed.
737         // If there was no default button set, the only style to invalidate is the element
738         // being added to the form. This is done explicitely in registerFormElement().
739         return;
740     }
741
742     HTMLFormControlElement* oldDefault = m_defaultButton;
743     m_defaultButton = nullptr;
744     defaultButton();
745     if (m_defaultButton != oldDefault) {
746         if (oldDefault)
747             oldDefault->setNeedsStyleRecalc();
748         if (m_defaultButton)
749             m_defaultButton->setNeedsStyleRecalc();
750     }
751 }
752
753 bool HTMLFormElement::checkValidity()
754 {
755     Vector<RefPtr<FormAssociatedElement>> controls;
756     return !checkInvalidControlsAndCollectUnhandled(controls);
757 }
758
759 bool HTMLFormElement::checkInvalidControlsAndCollectUnhandled(Vector<RefPtr<FormAssociatedElement>>& unhandledInvalidControls)
760 {
761     Ref<HTMLFormElement> protectedThis(*this);
762     // Copy m_associatedElements because event handlers called from
763     // HTMLFormControlElement::checkValidity() might change m_associatedElements.
764     Vector<RefPtr<FormAssociatedElement>> elements;
765     elements.reserveCapacity(m_associatedElements.size());
766     for (auto& associatedElement : m_associatedElements)
767         elements.append(associatedElement);
768     bool hasInvalidControls = false;
769     for (auto& element : elements) {
770         if (element->form() == this && is<HTMLFormControlElement>(*element)) {
771             HTMLFormControlElement& control = downcast<HTMLFormControlElement>(*element);
772             if (!control.checkValidity(&unhandledInvalidControls) && control.form() == this)
773                 hasInvalidControls = true;
774         }
775     }
776     return hasInvalidControls;
777 }
778
779 #ifndef NDEBUG
780 void HTMLFormElement::assertItemCanBeInPastNamesMap(FormNamedItem* item) const
781 {
782     ASSERT_WITH_SECURITY_IMPLICATION(item);
783     HTMLElement& element = item->asHTMLElement();
784     ASSERT_WITH_SECURITY_IMPLICATION(element.form() == this);
785
786     if (item->isFormAssociatedElement()) {
787         ASSERT_WITH_SECURITY_IMPLICATION(m_associatedElements.find(static_cast<FormAssociatedElement*>(item)) != notFound);
788         return;
789     }
790
791     ASSERT_WITH_SECURITY_IMPLICATION(element.hasTagName(imgTag));
792     ASSERT_WITH_SECURITY_IMPLICATION(m_imageElements.find(&downcast<HTMLImageElement>(element)) != notFound);
793 }
794 #else
795 inline void HTMLFormElement::assertItemCanBeInPastNamesMap(FormNamedItem*) const
796 {
797 }
798 #endif
799
800 HTMLElement* HTMLFormElement::elementFromPastNamesMap(const AtomicString& pastName) const
801 {
802     if (pastName.isEmpty() || !m_pastNamesMap)
803         return nullptr;
804     FormNamedItem* item = m_pastNamesMap->get(pastName.impl());
805     if (!item)
806         return nullptr;
807     assertItemCanBeInPastNamesMap(item);
808     return &item->asHTMLElement();
809 }
810
811 void HTMLFormElement::addToPastNamesMap(FormNamedItem* item, const AtomicString& pastName)
812 {
813     assertItemCanBeInPastNamesMap(item);
814     if (pastName.isEmpty())
815         return;
816     if (!m_pastNamesMap)
817         m_pastNamesMap = std::make_unique<PastNamesMap>();
818     m_pastNamesMap->set(pastName.impl(), item);
819 }
820
821 void HTMLFormElement::removeFromPastNamesMap(FormNamedItem* item)
822 {
823     ASSERT(item);
824     if (!m_pastNamesMap)
825         return;
826
827     for (auto& pastName : m_pastNamesMap->values()) {
828         if (pastName == item)
829             pastName = nullptr; // Keep looping. Single element can have multiple names.
830     }
831 }
832
833 bool HTMLFormElement::matchesValidPseudoClass() const
834 {
835     return m_invalidAssociatedFormControls.isEmpty();
836 }
837
838 bool HTMLFormElement::matchesInvalidPseudoClass() const
839 {
840     return !m_invalidAssociatedFormControls.isEmpty();
841 }
842
843 // FIXME: Use Ref<HTMLElement> for the function result since there are no non-HTML elements returned here.
844 Vector<Ref<Element>> HTMLFormElement::namedElements(const AtomicString& name)
845 {
846     // http://www.whatwg.org/specs/web-apps/current-work/multipage/forms.html#dom-form-nameditem
847     Vector<Ref<Element>> namedItems = elements()->namedItems(name);
848
849     HTMLElement* elementFromPast = elementFromPastNamesMap(name);
850     if (namedItems.size() == 1 && namedItems.first().ptr() != elementFromPast)
851         addToPastNamesMap(downcast<HTMLElement>(namedItems.first().get()).asFormNamedItem(), name);
852     else if (elementFromPast && namedItems.isEmpty())
853         namedItems.append(*elementFromPast);
854
855     return namedItems;
856 }
857
858 void HTMLFormElement::resumeFromDocumentSuspension()
859 {
860     ASSERT(!shouldAutocomplete());
861
862     for (auto& associatedElement : m_associatedElements) {
863         if (is<HTMLFormControlElement>(*associatedElement))
864             downcast<HTMLFormControlElement>(*associatedElement).reset();
865     }
866 }
867
868 void HTMLFormElement::didMoveToNewDocument(Document* oldDocument)
869 {
870     if (!shouldAutocomplete()) {
871         if (oldDocument)
872             oldDocument->unregisterForDocumentSuspensionCallbacks(this);
873         document().registerForDocumentSuspensionCallbacks(this);
874     }
875
876     HTMLElement::didMoveToNewDocument(oldDocument);
877 }
878
879 bool HTMLFormElement::shouldAutocomplete() const
880 {
881     return !equalLettersIgnoringASCIICase(attributeWithoutSynchronization(autocompleteAttr), "off");
882 }
883
884 void HTMLFormElement::finishParsingChildren()
885 {
886     HTMLElement::finishParsingChildren();
887     document().formController().restoreControlStateIn(*this);
888 }
889
890 void HTMLFormElement::copyNonAttributePropertiesFromElement(const Element& source)
891 {
892     m_wasDemoted = static_cast<const HTMLFormElement&>(source).m_wasDemoted;
893     HTMLElement::copyNonAttributePropertiesFromElement(source);
894 }
895
896 HTMLFormElement* HTMLFormElement::findClosestFormAncestor(const Element& startElement)
897 {
898     return const_cast<HTMLFormElement*>(ancestorsOfType<HTMLFormElement>(startElement).first());
899 }
900
901 void HTMLFormElement::setAutocomplete(const AtomicString& value)
902 {
903     setAttributeWithoutSynchronization(autocompleteAttr, value);
904 }
905
906 const AtomicString& HTMLFormElement::autocomplete() const
907 {
908     static NeverDestroyed<AtomicString> on("on", AtomicString::ConstructFromLiteral);
909     static NeverDestroyed<AtomicString> off("off", AtomicString::ConstructFromLiteral);
910
911     return equalIgnoringASCIICase(attributeWithoutSynchronization(autocompleteAttr), "off") ? off : on;
912 }
913
914 } // namespace