Title: [208532] trunk
Revision
208532
Author
[email protected]
Date
2016-11-10 02:15:30 -0800 (Thu, 10 Nov 2016)

Log Message

[GTK] New API to notify about dynamically added forms
https://bugs.webkit.org/show_bug.cgi?id=164050

Reviewed by Carlos Garcia Campos.

Source/WebKit2:

This new API exports the WebCore event didAssociateFormControls through the web extension
mechanism. This will help clients (mainly web browsers) to implement robust auto filling
mechanisms. It deals nicely with dynamically created forms (and form controls) as many JS
frameworks do nowadays.

* WebProcess/InjectedBundle/API/gtk/WebKitWebPage.cpp: Added a FormClient implementation of
API::InjectedBundle::FormClient.
(webkitWebPageFormControlsAssociated): Emit the new signal.
(webkit_web_page_class_init): Added the new signal "forms-controls-associated".
(webkitWebPageCreate): Set the WebPage as a FormClient.

Tools:

Added a new test case to verify that dinamically added forms correctly trigger the
"form-controls-associated" signal from WebPage.

* TestWebKitAPI/Tests/WebKit2Gtk/TestWebExtensions.cpp:
(didAssociateFormControlsCallback):
(testWebExtensionFormControlsAssociated):
(beforeAll):
* TestWebKitAPI/Tests/WebKit2Gtk/WebExtensionTest.cpp:
(DelayedSignal::DelayedSignal):
(emitFormControlsAssociated):
(formControlsAssociatedCallback):
(pageCreatedCallback):

Modified Paths

Diff

Modified: trunk/Source/WebKit2/ChangeLog (208531 => 208532)


--- trunk/Source/WebKit2/ChangeLog	2016-11-10 10:08:19 UTC (rev 208531)
+++ trunk/Source/WebKit2/ChangeLog	2016-11-10 10:15:30 UTC (rev 208532)
@@ -1,3 +1,21 @@
+2016-10-27  Sergio Villar Senin  <[email protected]>
+
+        [GTK] New API to notify about dynamically added forms
+        https://bugs.webkit.org/show_bug.cgi?id=164050
+
+        Reviewed by Carlos Garcia Campos.
+
+        This new API exports the WebCore event didAssociateFormControls through the web extension
+        mechanism. This will help clients (mainly web browsers) to implement robust auto filling
+        mechanisms. It deals nicely with dynamically created forms (and form controls) as many JS
+        frameworks do nowadays.
+
+        * WebProcess/InjectedBundle/API/gtk/WebKitWebPage.cpp: Added a FormClient implementation of
+        API::InjectedBundle::FormClient.
+        (webkitWebPageFormControlsAssociated): Emit the new signal.
+        (webkit_web_page_class_init): Added the new signal "forms-controls-associated".
+        (webkitWebPageCreate): Set the WebPage as a FormClient.
+
 2016-11-10  Carlos Alberto Lopez Perez  <[email protected]>
 
         [GTK] Allow to use WebMemorySampler feature.

Modified: trunk/Source/WebKit2/WebProcess/InjectedBundle/API/gtk/WebKitWebPage.cpp (208531 => 208532)


--- trunk/Source/WebKit2/WebProcess/InjectedBundle/API/gtk/WebKitWebPage.cpp	2016-11-10 10:08:19 UTC (rev 208531)
+++ trunk/Source/WebKit2/WebProcess/InjectedBundle/API/gtk/WebKitWebPage.cpp	2016-11-10 10:15:30 UTC (rev 208532)
@@ -31,6 +31,7 @@
 #include "WebKitConsoleMessagePrivate.h"
 #include "WebKitContextMenuPrivate.h"
 #include "WebKitDOMDocumentPrivate.h"
+#include "WebKitDOMElementPrivate.h"
 #include "WebKitFramePrivate.h"
 #include "WebKitMarshal.h"
 #include "WebKitPrivate.h"
@@ -60,6 +61,7 @@
     SEND_REQUEST,
     CONTEXT_MENU,
     CONSOLE_MESSAGE_SENT,
+    FORM_CONTROLS_ASSOCIATED,
 
     LAST_SIGNAL
 };
@@ -340,6 +342,28 @@
     WebKitWebPage* m_webPage;
 };
 
+class FormClient final : public API::InjectedBundle::FormClient {
+public:
+    explicit FormClient(WebKitWebPage* webPage)
+        : m_webPage(webPage)
+    {
+    }
+
+    void didAssociateFormControls(WebPage*, const Vector<RefPtr<Element>>& elements) override
+    {
+        GRefPtr<GPtrArray> formElements = adoptGRef(g_ptr_array_sized_new(elements.size()));
+        for (size_t i = 0; i < elements.size(); ++i)
+            g_ptr_array_add(formElements.get(), WebKit::kit(elements[i].get()));
+
+        g_signal_emit(m_webPage, signals[FORM_CONTROLS_ASSOCIATED], 0, formElements.get());
+    }
+
+    bool shouldNotifyOnFormChanges(WebPage*) override { return true; }
+
+private:
+    WebKitWebPage* m_webPage;
+};
+
 static void webkitWebPageGetProperty(GObject* object, guint propId, GValue* value, GParamSpec* paramSpec)
 {
     WebKitWebPage* webPage = WEBKIT_WEB_PAGE(object);
@@ -473,6 +497,33 @@
         g_cclosure_marshal_VOID__BOXED,
         G_TYPE_NONE, 1,
         WEBKIT_TYPE_CONSOLE_MESSAGE | G_SIGNAL_TYPE_STATIC_SCOPE);
+
+    /**
+     * WebKitWebPage::form-controls-associated:
+     * @web_page: the #WebKitWebPage on which the signal is emitted
+     * @elements: (element-type WebKit.DOMElement) (transfer none): a #GPtrArray of
+     *     #WebKitDOMElement with the list of forms in the page
+     *
+     * Emitted after form elements (or form associated elements) are associated to a particular web
+     * page. Useful to implement form autofilling with web pages where form fields are dynamically
+     * added (as many JS frameworks do). This might be emitted multiple times for the same web page.
+     *
+     * Note that this signal could be also emitted when form controls are moved between forms. In
+     * those cases the @elements array carries the list of those elements which have moved.
+     *
+     * In any case the members of the @elements array will be alive during signal emission so
+     * clients should take a reference to keep them alive.
+     *
+     * Since: 2.16
+     */
+    signals[FORM_CONTROLS_ASSOCIATED] = g_signal_new(
+        "form-controls-associated",
+        G_TYPE_FROM_CLASS(klass),
+        G_SIGNAL_RUN_LAST,
+        0, 0, nullptr,
+        g_cclosure_marshal_VOID__BOXED,
+        G_TYPE_NONE, 1,
+        G_TYPE_PTR_ARRAY);
 }
 
 WebPage* webkitWebPageGetPage(WebKitWebPage *webPage)
@@ -545,6 +596,7 @@
 
     webPage->setInjectedBundleContextMenuClient(std::make_unique<PageContextMenuClient>(page));
     webPage->setInjectedBundleUIClient(std::make_unique<PageUIClient>(page));
+    webPage->setInjectedBundleFormClient(std::make_unique<FormClient>(page));
 
     return page;
 }

Modified: trunk/Tools/ChangeLog (208531 => 208532)


--- trunk/Tools/ChangeLog	2016-11-10 10:08:19 UTC (rev 208531)
+++ trunk/Tools/ChangeLog	2016-11-10 10:15:30 UTC (rev 208532)
@@ -1,3 +1,23 @@
+2016-10-27  Sergio Villar Senin  <[email protected]>
+
+        [GTK] New API to notify about dynamically added forms
+        https://bugs.webkit.org/show_bug.cgi?id=164050
+
+        Reviewed by Carlos Garcia Campos.
+
+        Added a new test case to verify that dinamically added forms correctly trigger the
+        "form-controls-associated" signal from WebPage.
+
+        * TestWebKitAPI/Tests/WebKit2Gtk/TestWebExtensions.cpp:
+        (didAssociateFormControlsCallback):
+        (testWebExtensionFormControlsAssociated):
+        (beforeAll):
+        * TestWebKitAPI/Tests/WebKit2Gtk/WebExtensionTest.cpp:
+        (DelayedSignal::DelayedSignal):
+        (emitFormControlsAssociated):
+        (formControlsAssociatedCallback):
+        (pageCreatedCallback):
+
 2016-11-09  Ryosuke Niwa  <[email protected]>
 
         WebHTMLView's _attributeStringFromDOMRange should use HTMLConverter instead of NSAttributedString's _initWithDOMRange

Modified: trunk/Tools/TestWebKitAPI/Tests/WebKit2Gtk/TestWebExtensions.cpp (208531 => 208532)


--- trunk/Tools/TestWebKitAPI/Tests/WebKit2Gtk/TestWebExtensions.cpp	2016-11-10 10:08:19 UTC (rev 208531)
+++ trunk/Tools/TestWebKitAPI/Tests/WebKit2Gtk/TestWebExtensions.cpp	2016-11-10 10:15:30 UTC (rev 208532)
@@ -27,6 +27,10 @@
 static WebKitTestBus* bus;
 static GUniquePtr<char> scriptDialogResult;
 
+#define INPUT_ID "input-id"
+#define FORM_ID "form-id"
+#define FORM2_ID "form2-id"
+
 static void testWebExtensionGetTitle(WebViewTest* test, gconstpointer)
 {
     test->loadHtml("<html><head><title>WebKitGTK+ Web Extensions Test</title></head><body></body></html>", 0);
@@ -212,6 +216,65 @@
     g_signal_handler_disconnect(test->m_webView, permissionRequestSignalID);
 }
 
+static void didAssociateFormControlsCallback(GDBusConnection*, const char*, const char*, const char*, const char*, GVariant* result, WebViewTest* test)
+{
+    const char* formIds;
+    g_variant_get(result, "(&s)", &formIds);
+    g_assert(!g_strcmp0(formIds, FORM_ID FORM2_ID) || !g_strcmp0(formIds, INPUT_ID));
+
+    test->quitMainLoop();
+}
+
+static void testWebExtensionFormControlsAssociated(WebViewTest* test, gconstpointer)
+{
+    GUniquePtr<char> extensionBusName(g_strdup_printf("org.webkit.gtk.WebExtensionTest%u", Test::s_webExtensionID));
+    GRefPtr<GDBusProxy> proxy = adoptGRef(bus->createProxy(extensionBusName.get(),
+        "/org/webkit/gtk/WebExtensionTest", "org.webkit.gtk.WebExtensionTest", test->m_mainLoop));
+    GDBusConnection* connection = g_dbus_proxy_get_connection(proxy.get());
+    guint id = g_dbus_connection_signal_subscribe(connection,
+        nullptr,
+        "org.webkit.gtk.WebExtensionTest",
+        "FormControlsAssociated",
+        "/org/webkit/gtk/WebExtensionTest",
+        nullptr,
+        G_DBUS_SIGNAL_FLAGS_NONE,
+        reinterpret_cast<GDBusSignalCallback>(didAssociateFormControlsCallback),
+        test,
+        nullptr);
+    g_assert(id);
+
+    test->loadHtml("<!DOCTYPE html><head><title>WebKitGTK+ Web Extensions Test</title></head><div id=\"placeholder\"/>", 0);
+    test->waitUntilLoadFinished();
+
+    static const char* addFormScript =
+        "var input = document.createElement(\"input\");"
+        "input.id = \"" INPUT_ID "\";"
+        "input.type = \"password\";"
+        "var form = document.createElement(\"form\");"
+        "form.id = \"" FORM_ID "\";"
+        "form.appendChild(input);"
+        "var form2 = document.createElement(\"form\");"
+        "form2.id = \"" FORM2_ID "\";"
+        "var placeholder = document.getElementById(\"placeholder\");"
+        "placeholder.appendChild(form);"
+        "placeholder.appendChild(form2);";
+
+    webkit_web_view_run_javascript(test->m_webView, addFormScript, nullptr, nullptr, nullptr);
+    g_main_loop_run(test->m_mainLoop);
+
+    static const char* moveFormElementScript =
+        "var form = document.getElementById(\"" FORM_ID "\");"
+        "var form2 = document.getElementById(\"" FORM2_ID "\");"
+        "var input = document.getElementById(\"" INPUT_ID "\");"
+        "form.removeChild(input);"
+        "form2.appendChild(input);";
+
+    webkit_web_view_run_javascript(test->m_webView, moveFormElementScript, nullptr, nullptr, nullptr);
+    g_main_loop_run(test->m_mainLoop);
+
+    g_dbus_connection_signal_unsubscribe(connection, id);
+}
+
 void beforeAll()
 {
     bus = new WebKitTestBus();
@@ -224,6 +287,7 @@
     WebViewTest::add("WebKitWebExtension", "window-object-cleared", testWebExtensionWindowObjectCleared);
     WebViewTest::add("WebKitWebExtension", "isolated-world", testWebExtensionIsolatedWorld);
     WebViewTest::add("WebKitWebView", "install-missing-plugins-permission-request", testInstallMissingPluginsPermissionRequest);
+    WebViewTest::add("WebKitWebExtension", "form-controls-associated-signal", testWebExtensionFormControlsAssociated);
 }
 
 void afterAll()

Modified: trunk/Tools/TestWebKitAPI/Tests/WebKit2Gtk/WebExtensionTest.cpp (208531 => 208532)


--- trunk/Tools/TestWebKitAPI/Tests/WebKit2Gtk/WebExtensionTest.cpp	2016-11-10 10:08:19 UTC (rev 208531)
+++ trunk/Tools/TestWebKitAPI/Tests/WebKit2Gtk/WebExtensionTest.cpp	2016-11-10 10:15:30 UTC (rev 208532)
@@ -51,6 +51,9 @@
     "  <method name='RemoveAVPluginsFromGSTRegistry'>"
     "  </method>"
     "  <signal name='DocumentLoaded'/>"
+    "  <signal name='FormControlsAssociated'>"
+    "   <arg type='s' name='formIds' direction='out'/>"
+    "  </signal>"
     "  <signal name='URIChanged'>"
     "   <arg type='s' name='uri' direction='out'/>"
     "  </signal>"
@@ -61,6 +64,7 @@
 typedef enum {
     DocumentLoadedSignal,
     URIChangedSignal,
+    FormControlsAssociatedSignal,
 } DelayedSignalType;
 
 struct DelayedSignal {
@@ -69,14 +73,14 @@
     {
     }
 
-    DelayedSignal(DelayedSignalType type, const char* uri)
+    DelayedSignal(DelayedSignalType type, const char* str)
         : type(type)
-        , uri(uri)
+        , str(str)
     {
     }
 
     DelayedSignalType type;
-    CString uri;
+    CString str;
 };
 
 Deque<DelayedSignal> delayedSignalsQueue;
@@ -238,6 +242,36 @@
     webkit_dom_dom_window_webkit_message_handlers_post_message(window.get(), "console", messageString.get());
 }
 
+
+static void emitFormControlsAssociated(GDBusConnection* connection, const char* formIds)
+{
+    bool ok = g_dbus_connection_emit_signal(
+        connection,
+        nullptr,
+        "/org/webkit/gtk/WebExtensionTest",
+        "org.webkit.gtk.WebExtensionTest",
+        "FormControlsAssociated",
+        g_variant_new("(s)", formIds),
+        nullptr);
+    g_assert(ok);
+}
+
+static void formControlsAssociatedCallback(WebKitWebPage* webPage, GPtrArray* formElements, WebKitWebExtension* extension)
+{
+    GString* formIdsBuilder = g_string_new(nullptr);
+    for (int i = 0; i < formElements->len; ++i) {
+        g_assert(WEBKIT_DOM_IS_ELEMENT(g_ptr_array_index(formElements, i)));
+        auto domElement = WEBKIT_DOM_ELEMENT(g_ptr_array_index(formElements, i));
+        g_string_append(formIdsBuilder, webkit_dom_element_get_id(domElement));
+    }
+    GUniquePtr<char> formIds(g_string_free(formIdsBuilder, FALSE));
+    gpointer data = "" "dbus-connection");
+    if (data)
+        emitFormControlsAssociated(G_DBUS_CONNECTION(data), formIds.get());
+    else
+        delayedSignalsQueue.append(DelayedSignal(FormControlsAssociatedSignal, formIds.get()));
+}
+
 static void pageCreatedCallback(WebKitWebExtension* extension, WebKitWebPage* webPage, gpointer)
 {
     g_signal_connect(webPage, "document-loaded", G_CALLBACK(documentLoadedCallback), extension);
@@ -245,6 +279,7 @@
     g_signal_connect(webPage, "send-request", G_CALLBACK(sendRequestCallback), nullptr);
     g_signal_connect(webPage, "context-menu", G_CALLBACK(contextMenuCallback), nullptr);
     g_signal_connect(webPage, "console-message-sent", G_CALLBACK(consoleMessageSentCallback), nullptr);
+    g_signal_connect(webPage, "form-controls-associated", G_CALLBACK(formControlsAssociatedCallback), extension);
 }
 
 static JSValueRef echoCallback(JSContextRef jsContext, JSObjectRef, JSObjectRef, size_t argumentCount, const JSValueRef arguments[], JSValueRef*)
@@ -361,8 +396,11 @@
             emitDocumentLoaded(connection);
             break;
         case URIChangedSignal:
-            emitURIChanged(connection, delayedSignal.uri.data());
+            emitURIChanged(connection, delayedSignal.str.data());
             break;
+        case FormControlsAssociatedSignal:
+            emitFormControlsAssociated(connection, delayedSignal.str.data());
+            break;
         }
     }
 }
_______________________________________________
webkit-changes mailing list
[email protected]
https://lists.webkit.org/mailman/listinfo/webkit-changes

Reply via email to