Changeset 293444 in webkit

Timestamp:

Apr 26, 2022 12:31:41 PM (3 months ago)

Author:

Ziran Sun

Message:

Constructed FormData object should not contain an entry for the submit button that was used to submit the form
​https://bugs.webkit.org/show_bug.cgi?id=239070

Reviewed by Chris Dumez.

LayoutTests/imported/w3c:

Update test expectation as the sub-test is now passing.

• web-platform-tests/html/semantics/forms/form-submission-0/constructing-form-data-set-expected.txt:

Source/WebCore:

When the activedSubmit flag is set for a submit button, its value is appended to a FormData. In the case of form
submission called in submit event handler, we include submit button when build FormData. The submit button should
not be included though. This patch correct it by calling set the activatedSubmit flag just before or after building
FormData.

Part of the patch is an import of Chromium CL at
​https://codereview.chromium.org/2340213002

• html/DOMFormData.cpp:

(WebCore::DOMFormData::create):

• html/HTMLButtonElement.cpp:

(WebCore::HTMLButtonElement::defaultEventHandler):

• html/HTMLFormElement.cpp:

(WebCore::HTMLFormElement::submit):
(WebCore::HTMLFormElement::constructEntryList):

• html/HTMLFormElement.h:
• html/SubmitInputType.cpp:

(WebCore::SubmitInputType::handleDOMActivateEvent):

• loader/FormSubmission.cpp:

(WebCore::FormSubmission::create):

Location:

trunk

Files:

• LayoutTests/imported/w3c/ChangeLog (modified) (1 diff)
• LayoutTests/imported/w3c/web-platform-tests/html/semantics/forms/form-submission-0/constructing-form-data-set-expected.txt (modified) (1 diff)
• Source/WebCore/ChangeLog (modified) (1 diff)
• Source/WebCore/html/DOMFormData.cpp (modified) (1 diff)
• Source/WebCore/html/HTMLButtonElement.cpp (modified) (1 diff)
• Source/WebCore/html/HTMLFormElement.cpp (modified) (7 diffs)
• Source/WebCore/html/HTMLFormElement.h (modified) (2 diffs)
• Source/WebCore/html/SubmitInputType.cpp (modified) (1 diff)
• Source/WebCore/loader/FormSubmission.cpp (modified) (1 diff)

trunk/LayoutTests/imported/w3c/ChangeLog

@@ +1 @@
+2022-04-26  Ziran Sun  <zsun@igalia.com>
+
+        Constructed FormData object should not contain an entry for the submit button that was used to submit the form
+        https://bugs.webkit.org/show_bug.cgi?id=239070
+
+        Reviewed by Chris Dumez.
+
+        Update test expectation as the sub-test is now passing.
+        * web-platform-tests/html/semantics/forms/form-submission-0/constructing-form-data-set-expected.txt:
+
 2022-04-26  Youenn Fablet  <youenn@apple.com>
 

trunk/LayoutTests/imported/w3c/web-platform-tests/html/semantics/forms/form-submission-0/constructing-form-data-set-expected.txt

@@ -22 +22 @@
 PASS Entries added to "formData" IDL attribute should be submitted.
 PASS Entries added to the "formdata" IDL attribute shouldn't be newline normalized in the resulting FormData
-FAIL The constructed FormData object should not contain an entry for the submit button that was used to submit the form. assert_false: expected false got true
+PASS The constructed FormData object should not contain an entry for the submit button that was used to submit the form.
 

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2022-04-26  Ziran Sun  <zsun@igalia.com>
+
+        Constructed FormData object should not contain an entry for the submit button that was used to submit the form
+        https://bugs.webkit.org/show_bug.cgi?id=239070
+
+        Reviewed by Chris Dumez.
+
+        When the activedSubmit flag is set for a submit button, its value is appended to a FormData. In the case of form
+        submission called in submit event handler, we include submit button when build FormData. The submit button should
+        not be included though. This patch correct it by calling set the activatedSubmit flag just before or after building
+        FormData.
+        
+        Part of the patch is an import of Chromium CL at
+        https://codereview.chromium.org/2340213002
+
+        * html/DOMFormData.cpp:
+        (WebCore::DOMFormData::create):
+        * html/HTMLButtonElement.cpp:
+        (WebCore::HTMLButtonElement::defaultEventHandler):
+        * html/HTMLFormElement.cpp:
+        (WebCore::HTMLFormElement::submit):
+        (WebCore::HTMLFormElement::constructEntryList):
+        * html/HTMLFormElement.h:
+        * html/SubmitInputType.cpp:
+        (WebCore::SubmitInputType::handleDOMActivateEvent):
+        * loader/FormSubmission.cpp:
+        (WebCore::FormSubmission::create):
+
 2022-04-26  Simon Fraser  <simon.fraser@apple.com>
 

trunk/Source/WebCore/html/DOMFormData.cpp

@@ -49 +49 @@
         return formData;
     
-    auto result = form->constructEntryList(WTFMove(formData), nullptr);
+    auto result = form->constructEntryList(nullptr, WTFMove(formData), nullptr);
     
     if (!result)

trunk/Source/WebCore/html/HTMLButtonElement.cpp

@@ -142 +142 @@
 
             if (auto currentForm = form()) {
-                if (m_type == SUBMIT) {
-                    SetForScope activatedSubmitState(m_isActivatedSubmit, true);
+                if (m_type == SUBMIT)
                     currentForm->submitIfPossible(&event, this);
-                }
 
                 if (m_type == RESET)

trunk/Source/WebCore/html/HTMLFormElement.cpp

@@ -324 +324 @@
 
     if (m_shouldSubmit)
-        submit(event, true, !submitter, trigger, submitter);
+        submit(event, !submitter, trigger, submitter);
 }
 
 void HTMLFormElement::submit()
 {
-    submit(nullptr, false, true, NotSubmittedByJavaScript);
+    submit(nullptr, true, NotSubmittedByJavaScript);
 }
 
 void HTMLFormElement::submitFromJavaScript()
 {
-    submit(nullptr, false, UserGestureIndicator::processingUserGesture(), SubmittedByJavaScript);
+    submit(nullptr, UserGestureIndicator::processingUserGesture(), SubmittedByJavaScript);
 }
 
@@ -394 +394 @@
 }
 
-void HTMLFormElement::submit(Event* event, bool activateSubmitButton, bool processingUserGesture, FormSubmissionTrigger trigger, HTMLFormControlElement* submitter)
+void HTMLFormElement::submit(Event* event, bool processingUserGesture, FormSubmissionTrigger trigger, HTMLFormControlElement* submitter)
 {
     // The submitIfPossible function also does this check, but we need to do it here
@@ -417 +417 @@
     m_wasUserSubmitted = processingUserGesture;
 
-    auto firstSuccessfulSubmitButton = findSubmitButton(submitter, activateSubmitButton);
-    if (firstSuccessfulSubmitButton)
-        firstSuccessfulSubmitButton->setActivatedSubmit(true);
+    if (event && !submitter) {
+        // In a case of implicit submission without a submit button, 'submit' event handler might add a submit button. We search for a submit button again.
+        auto associatedElements = copyAssociatedElementsVector();
+        for (auto& element : associatedElements) {
+            if (auto* control = dynamicDowncast<HTMLFormControlElement>(element.get()); control && control->isSuccessfulSubmitButton()) {
+                submitter = control;
+                break;
+            }
+        }
+    }
 
     Ref protectedThis { *this }; // Form submission can execute arbitary JavaScript.
@@ -444 +451 @@
     else
         frame->loader().submitForm(WTFMove(formSubmission));
-
-    if (firstSuccessfulSubmitButton)
-        firstSuccessfulSubmitButton->setActivatedSubmit(false);
 
     m_shouldSubmit = false;
@@ -1017 +1021 @@
 }
 
-RefPtr<DOMFormData> HTMLFormElement::constructEntryList(Ref<DOMFormData>&& domFormData, StringPairVector* formValues)
+RefPtr<DOMFormData> HTMLFormElement::constructEntryList(RefPtr<HTMLFormControlElement>&& submitter, Ref<DOMFormData>&& domFormData, StringPairVector* formValues)
 {
     // https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#constructing-form-data-set
@@ -1026 +1030 @@
     
     SetForScope isConstructingEntryListScope(m_isConstructingEntryList, true);
+
+    if (submitter)
+        submitter->setActivatedSubmit(true);
     
     for (auto& control : this->copyAssociatedElementsVector()) {
@@ -1041 +1048 @@
     
     dispatchEvent(FormDataEvent::create(eventNames().formdataEvent, Event::CanBubble::Yes, Event::IsCancelable::No, Event::IsComposed::No, domFormData.copyRef()));
+
+    if (submitter)
+        submitter->setActivatedSubmit(false);
     
     return domFormData->clone();

trunk/Source/WebCore/html/HTMLFormElement.h

@@ -128 +128 @@
     static HTMLFormElement* findClosestFormAncestor(const Element&);
     
-    RefPtr<DOMFormData> constructEntryList(Ref<DOMFormData>&&, StringPairVector*);
+    RefPtr<DOMFormData> constructEntryList(RefPtr<HTMLFormControlElement>&&, Ref<DOMFormData>&&, StringPairVector*);
     
 private:
@@ -147 +147 @@
     void copyNonAttributePropertiesFromElement(const Element&) final;
 
-    void submit(Event*, bool activateSubmitButton, bool processingUserGesture, FormSubmissionTrigger, HTMLFormControlElement* submitter = nullptr);
+    void submit(Event*, bool processingUserGesture, FormSubmissionTrigger, HTMLFormControlElement* submitter = nullptr);
 
     void submitDialog(Ref<FormSubmission>&&);

trunk/Source/WebCore/html/SubmitInputType.cpp

@@ -75 +75 @@
     protectedElement->document().updateLayoutIgnorePendingStylesheets();
 
-    protectedElement->setActivatedSubmit(true);
     if (RefPtr currentForm = protectedElement->form())
         currentForm->submitIfPossible(&event, element()); // Event handlers can run.
-    protectedElement->setActivatedSubmit(false);
     event.setDefaultHandled();
 }

trunk/Source/WebCore/loader/FormSubmission.cpp

@@ -214 +214 @@
     StringPairVector formValues;
 
-    auto result = form.constructEntryList(WTFMove(domFormData), &formValues);
+    auto result = form.constructEntryList(submitter.copyRef(), WTFMove(domFormData), &formValues);
     RELEASE_ASSERT(result);
     domFormData = result.releaseNonNull();