[WPE][GTK] Deprecate and replace webkit_form_submission_request_get_text_fields

https://bugs.webkit.org/show_bug.cgi?id=176725

Reviewed by Carlos Garcia Campos.

Source/WebKit:

The problem is this function returns results in a GHashTable, but many fields can have the
same name, or no name at all, and those fields are currently just dropped. It's impossible
to fix, since the GHashTable is part of the API, so deprecate it and add a new function that
returns two GPtrArrays instead.

* UIProcess/API/glib/WebKitFormSubmissionRequest.cpp:
(webkitFormSubmissionRequestCreate):
(webkit_form_submission_request_get_text_fields):
(webkit_form_submission_request_list_text_fields):
* UIProcess/API/gtk/WebKitFormSubmissionRequest.h:
* UIProcess/API/gtk/docs/webkit2gtk-4.0-sections.txt:
* UIProcess/API/wpe/WebKitFormSubmissionRequest.h:

Tools:

Test the new function.

* TestWebKitAPI/Tests/WebKitGLib/TestWebKitWebView.cpp:
(testWebViewSubmitForm):

git-svn-id: http://svn.webkit.org/repository/webkit/trunk@226264 268f45cc-cd09-0410-ab3c-d52691b4dbfc

Author: [email protected]

Source/WebKit/ChangeLog

@@ -1,3 +1,23 @@
+2017-12-21  Michael Catanzaro  <[email protected]>
+
+        [WPE][GTK] Deprecate and replace webkit_form_submission_request_get_text_fields
+        https://bugs.webkit.org/show_bug.cgi?id=176725
+
+        Reviewed by Carlos Garcia Campos.
+
+        The problem is this function returns results in a GHashTable, but many fields can have the
+        same name, or no name at all, and those fields are currently just dropped. It's impossible
+        to fix, since the GHashTable is part of the API, so deprecate it and add a new function that
+        returns two GPtrArrays instead.
+
+        * UIProcess/API/glib/WebKitFormSubmissionRequest.cpp:
+        (webkitFormSubmissionRequestCreate):
+        (webkit_form_submission_request_get_text_fields):
+        (webkit_form_submission_request_list_text_fields):
+        * UIProcess/API/gtk/WebKitFormSubmissionRequest.h:
+        * UIProcess/API/gtk/docs/webkit2gtk-4.0-sections.txt:
+        * UIProcess/API/wpe/WebKitFormSubmissionRequest.h:
+
 2017-12-21  Youenn Fablet  <[email protected]>
 
         ServiceWorkerThreadProxy should set the correct cookie and cache partitioning options

Source/WebKit/UIProcess/API/glib/WebKitFormSubmissionRequest.cpp

@@ -25,6 +25,7 @@
 #include "WebFormSubmissionListenerProxy.h"
 #include "WebKitFormSubmissionRequestPrivate.h"
 #include <wtf/glib/GRefPtr.h>
+#include <wtf/glib/GUniquePtr.h>
 #include <wtf/glib/WTFGType.h>
 #include <wtf/text/CString.h>
 
@@ -38,15 +39,15 @@ using namespace WebKit;
  * When a form is about to be submitted in a #WebKitWebView, the
  * #WebKitWebView::submit-form signal is emitted. Its request argument
  * contains information about the text fields of the form, that are
- * typically used to store login information, returned in a
- * #GHashTable by the webkit_form_submission_request_get_text_fields()
- * method, and you can finally submit the form with
- * webkit_form_submission_request_submit().
- *
+ * typically used to store login information, returned as lists by
+ * webkit_form_submission_request_list_text_fields(). You can submit the
+ * form with webkit_form_submission_request_submit().
  */
 
 struct _WebKitFormSubmissionRequestPrivate {
     RefPtr<WebFormSubmissionListenerProxy> listener;
+    GRefPtr<GPtrArray> textFieldNames;
+    GRefPtr<GPtrArray> textFieldValues;
     GRefPtr<GHashTable> values;
     bool handledRequest;
 };
@@ -74,9 +75,12 @@ WebKitFormSubmissionRequest* webkitFormSubmissionRequestCreate(const Vector<std:
 {
     WebKitFormSubmissionRequest* request = WEBKIT_FORM_SUBMISSION_REQUEST(g_object_new(WEBKIT_TYPE_FORM_SUBMISSION_REQUEST, nullptr));
     if (values.size()) {
-        request->priv->values = adoptGRef(g_hash_table_new_full(g_str_hash, g_str_equal, g_free, g_free));
-        for (const auto& pair : values)
-            g_hash_table_insert(request->priv->values.get(), g_strdup(pair.first.utf8().data()), g_strdup(pair.second.utf8().data()));
+        request->priv->textFieldNames = adoptGRef(g_ptr_array_new_full(values.size(), g_free));
+        request->priv->textFieldValues = adoptGRef(g_ptr_array_new_full(values.size(), g_free));
+        for (size_t i = 0; i < values.size(); i++) {
+            g_ptr_array_add(request->priv->textFieldNames.get(), g_strdup(values[i].first.utf8().data()));
+            g_ptr_array_add(request->priv->textFieldValues.get(), g_strdup(values[i].second.utf8().data()));
+        }
     }
     request->priv->listener = WTFMove(listener);
     return request;
@@ -87,18 +91,62 @@ WebKitFormSubmissionRequest* webkitFormSubmissionRequestCreate(const Vector<std:
  * @request: a #WebKitFormSubmissionRequest
  *
  * Get a #GHashTable with the values of the text fields contained in the form
- * associated to @request.
+ * associated to @request. Note that fields will be missing if the form
+ * contains multiple text input elements with the same name, so this
+ * function does not reliably return all text fields.
+ *
+ * Returns: (allow-none) (transfer none): a #GHashTable with the form
+ *    text fields, or %NULL if the form doesn't contain text fields.
  *
- * Returns: (transfer none): a #GHashTable with the form text fields, or %NULL if the
- *    form doesn't contain text fields.
+ * Deprecated: 2.20. Use webkit_form_submission_request_list_text_fields() instead.
  */
 GHashTable* webkit_form_submission_request_get_text_fields(WebKitFormSubmissionRequest* request)
 {
     g_return_val_if_fail(WEBKIT_IS_FORM_SUBMISSION_REQUEST(request), nullptr);
 
+    if (!request->priv->values && request->priv->textFieldNames->len) {
+        request->priv->values = adoptGRef(g_hash_table_new_full(g_str_hash, g_str_equal, g_free, g_free));
+        for (unsigned i = 0; i < request->priv->textFieldNames->len; i++) {
+            GUniquePtr<char> name(g_strdup(static_cast<char*>(request->priv->textFieldNames->pdata[i])));
+            GUniquePtr<char> value(g_strdup(static_cast<char*>(request->priv->textFieldValues->pdata[i])));
+            g_hash_table_insert(request->priv->values.get(), name.release(), value.release());
+        }
+    }
+
     return request->priv->values.get();
 }
 
+/**
+ * webkit_form_submission_request_list_text_fields:
+ * @request: a #WebKitFormSubmissionRequest
+ * @field_names: (out) (optional) (element-type utf8) (transfer none):
+ *    names of the text fields in the form
+ * @field_values: (out) (optional) (element-type utf8) (transfer none):
+ *    values of the text fields in the form
+ *
+ * Get lists with the names and values of the text fields contained in
+ * the form associated to @request. Note that names and values may be
+ * %NULL.
+ *
+ * If this function returns %FALSE, then both @field_names and
+ * @field_values will be empty.
+ *
+ * Returns: %TRUE if the form contains text fields, or %FALSE otherwise
+ *
+ * Since: 2.20
+ */
+gboolean webkit_form_submission_request_list_text_fields(WebKitFormSubmissionRequest* request, GPtrArray** fieldNames, GPtrArray** fieldValues)
+{
+    g_return_val_if_fail(WEBKIT_IS_FORM_SUBMISSION_REQUEST(request), FALSE);
+
+    if (fieldNames)
+        *fieldNames = request->priv->textFieldNames.get();
+    if (fieldValues)
+        *fieldValues = request->priv->textFieldValues.get();
+
+    return !!request->priv->textFieldNames->len;
+}
+
 /**
  * webkit_form_submission_request_submit:
  * @request: a #WebKitFormSubmissionRequest

Source/WebKit/UIProcess/API/gtk/WebKitFormSubmissionRequest.h

@@ -57,13 +57,18 @@ struct _WebKitFormSubmissionRequestClass {
 };
 
 WEBKIT_API GType
-webkit_form_submission_request_get_type        (void);
+webkit_form_submission_request_get_type         (void);
 
-WEBKIT_API GHashTable *
-webkit_form_submission_request_get_text_fields (WebKitFormSubmissionRequest *request);
+WEBKIT_DEPRECATED_FOR(webkit_form_submission_request_list_text_fields) GHashTable *
+webkit_form_submission_request_get_text_fields  (WebKitFormSubmissionRequest  *request);
+
+WEBKIT_API gboolean
+webkit_form_submission_request_list_text_fields (WebKitFormSubmissionRequest  *request,
+                                                 GPtrArray                   **field_names,
+                                                 GPtrArray                   **field_values);
 
 WEBKIT_API void
-webkit_form_submission_request_submit          (WebKitFormSubmissionRequest *request);
+webkit_form_submission_request_submit           (WebKitFormSubmissionRequest  *request);
 
 G_END_DECLS
 

Source/WebKit/UIProcess/API/gtk/docs/webkit2gtk-4.0-sections.txt

@@ -1238,6 +1238,7 @@ webkit_option_menu_item_get_type
 <FILE>WebKitFormSubmissionRequest</FILE>
 WebKitFormSubmissionRequest
 webkit_form_submission_request_get_text_fields
+webkit_form_submission_request_list_text_fields
 webkit_form_submission_request_submit
 
 <SUBSECTION Standard>

Source/WebKit/UIProcess/API/wpe/WebKitFormSubmissionRequest.h

@@ -57,13 +57,18 @@ struct _WebKitFormSubmissionRequestClass {
 };
 
 WEBKIT_API GType
-webkit_form_submission_request_get_type        (void);
+webkit_form_submission_request_get_type         (void);
 
-WEBKIT_API GHashTable *
-webkit_form_submission_request_get_text_fields (WebKitFormSubmissionRequest *request);
+WEBKIT_DEPRECATED_FOR(webkit_form_submission_request_list_text_fields) GHashTable *
+webkit_form_submission_request_get_text_fields  (WebKitFormSubmissionRequest  *request);
+
+WEBKIT_API gboolean
+webkit_form_submission_request_list_text_fields (WebKitFormSubmissionRequest  *request,
+                                                 GPtrArray                   **field_names,
+                                                 GPtrArray                   **field_values);
 
 WEBKIT_API void
-webkit_form_submission_request_submit          (WebKitFormSubmissionRequest *request);
+webkit_form_submission_request_submit           (WebKitFormSubmissionRequest  *request);
 
 G_END_DECLS
 

Tools/ChangeLog

@@ -1,3 +1,15 @@
+2017-12-21  Michael Catanzaro  <[email protected]>
+
+        [WPE][GTK] Deprecate and replace webkit_form_submission_request_get_text_fields
+        https://bugs.webkit.org/show_bug.cgi?id=176725
+
+        Reviewed by Carlos Garcia Campos.
+
+        Test the new function.
+
+        * TestWebKitAPI/Tests/WebKitGLib/TestWebKitWebView.cpp:
+        (testWebViewSubmitForm):
+
 2017-12-22  Jonathan Bedard  <[email protected]>
 
         webkitpy: Refactor simulator code (Part 1)

Tools/TestWebKitAPI/Tests/WebKitGLib/TestWebKitWebView.cpp

@@ -475,10 +475,26 @@ class FormClientTest: public WebViewTest {
         quitMainLoop();
     }
 
-    GHashTable* waitUntilFormSubmittedAndGetTextFields()
+    GHashTable* getTextFieldsAsHashTable()
     {
-        g_main_loop_run(m_mainLoop);
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
         return webkit_form_submission_request_get_text_fields(m_request.get());
+#pragma GCC diagnostic pop
+    }
+
+    GPtrArray* getTextFieldNames()
+    {
+        GPtrArray* names;
+        webkit_form_submission_request_list_text_fields(m_request.get(), &names, nullptr);
+        return names;
+    }
+
+    GPtrArray* getTextFieldValues()
+    {
+        GPtrArray* values;
+        webkit_form_submission_request_list_text_fields(m_request.get(), nullptr, &values);
+        return values;
     }
 
     static gboolean doClickIdleCallback(FormClientTest* test)
@@ -492,6 +508,7 @@ class FormClientTest: public WebViewTest {
         m_submitPositionX = x;
         m_submitPositionY = y;
         g_idle_add(reinterpret_cast<GSourceFunc>(doClickIdleCallback), this);
+        g_main_loop_run(m_mainLoop);
     }
 
     int m_submitPositionX;
@@ -508,6 +525,8 @@ static void testWebViewSubmitForm(FormClientTest* test, gconstpointer)
         " <form action='#'>"
         "  <input type='text' name='text1' value='value1'>"
         "  <input type='text' name='text2' value='value2'>"
+        "  <input type='text' value='value3'>"
+        "  <input type='text' name='text2'>"
         "  <input type='password' name='password' value='secret'>"
         "  <textarea cols='5' rows='5' name='textarea'>Text</textarea>"
         "  <input type='hidden' name='hidden1' value='hidden1'>"
@@ -519,12 +538,31 @@ static void testWebViewSubmitForm(FormClientTest* test, gconstpointer)
     test->waitUntilLoadFinished();
 
     test->submitFormAtPosition(5, 5);
-    GHashTable* values = test->waitUntilFormSubmittedAndGetTextFields();
+    GHashTable* tableValues = test->getTextFieldsAsHashTable();
+    g_assert(tableValues);
+    g_assert_cmpuint(g_hash_table_size(tableValues), ==, 4);
+    g_assert_cmpstr(static_cast<char*>(g_hash_table_lookup(tableValues, "text1")), ==, "value1");
+    g_assert_cmpstr(static_cast<char*>(g_hash_table_lookup(tableValues, "")), ==, "value3");
+    g_assert_cmpstr(static_cast<char*>(g_hash_table_lookup(tableValues, "text2")), ==, "");
+    g_assert_cmpstr(static_cast<char*>(g_hash_table_lookup(tableValues, "password")), ==, "secret");
+
+    GPtrArray* names = test->getTextFieldNames();
+    g_assert(names);
+    g_assert_cmpuint(names->len, ==, 5);
+    g_assert_cmpstr(static_cast<char*>(names->pdata[0]), ==, "text1");
+    g_assert_cmpstr(static_cast<char*>(names->pdata[1]), ==, "text2");
+    g_assert_cmpstr(static_cast<char*>(names->pdata[2]), ==, "");
+    g_assert_cmpstr(static_cast<char*>(names->pdata[3]), ==, "text2");
+    g_assert_cmpstr(static_cast<char*>(names->pdata[4]), ==, "password");
+
+    GPtrArray* values = test->getTextFieldValues();
     g_assert(values);
-    g_assert_cmpuint(g_hash_table_size(values), ==, 3);
-    g_assert_cmpstr(static_cast<char*>(g_hash_table_lookup(values, "text1")), ==, "value1");
-    g_assert_cmpstr(static_cast<char*>(g_hash_table_lookup(values, "text2")), ==, "value2");
-    g_assert_cmpstr(static_cast<char*>(g_hash_table_lookup(values, "password")), ==, "secret");
+    g_assert_cmpuint(values->len, ==, 5);
+    g_assert_cmpstr(static_cast<char*>(values->pdata[0]), ==, "value1");
+    g_assert_cmpstr(static_cast<char*>(values->pdata[1]), ==, "value2");
+    g_assert_cmpstr(static_cast<char*>(values->pdata[2]), ==, "value3");
+    g_assert_cmpstr(static_cast<char*>(values->pdata[3]), ==, "");
+    g_assert_cmpstr(static_cast<char*>(values->pdata[4]), ==, "secret");
 }
 #endif // PLATFORM(GTK)