Changeset 287014 in webkit

Timestamp:

Dec 14, 2021, 12:12:55 AM (5 years ago)

Author:

Carlos Garcia Campos

Message:

[GTK][a11y] Handle the Embedded method sent by AtkSocket from AccessibilityRootAtspi
​https://bugs.webkit.org/show_bug.cgi?id=234233

Reviewed by Adrian Perez de Castro.

Source/WebCore:

• accessibility/atspi/AccessibilityAtspi.cpp:

(WebCore::AccessibilityAtspi::registerRoot):

• accessibility/atspi/AccessibilityRootAtspi.cpp:

(WebCore::AccessibilityRootAtspi::registerObject):
(WebCore::AccessibilityRootAtspi::embedded):
(WebCore::AccessibilityRootAtspi::setParentPath): Deleted.

• accessibility/atspi/AccessibilityRootAtspi.h:
• accessibility/atspi/xml/Socket.xml:

Source/WebKit:

I added some hacks to send the socket path to the web process using WebKit IPC because Embedded message is not
in the DBus interface. We can simply add the message to the interface definition and handle it instead to
simplify everything.

• UIProcess/ProvisionalPageProxy.cpp:

(WebKit::ProvisionalPageProxy::bindAccessibilityTree):
(WebKit::ProvisionalPageProxy::didReceiveMessage):

• UIProcess/ProvisionalPageProxy.h:

(WebKit::ProvisionalPageProxy::accessibilityPlugID):
(WebKit::ProvisionalPageProxy::CompletionHandler<void): Deleted.

• UIProcess/WebPageProxy.cpp:

(WebKit::WebPageProxy::swapToProvisionalPage):

• UIProcess/WebPageProxy.h:
• UIProcess/WebPageProxy.messages.in:
• UIProcess/gtk/WebPageProxyGtk.cpp:

(WebKit::WebPageProxy::bindAccessibilityTree):

• UIProcess/wpe/WebPageProxyWPE.cpp:

(WebKit::WebPageProxy::bindAccessibilityTree):

• WebProcess/WebPage/gtk/WebPageGtk.cpp:

(WebKit::WebPage::platformInitialize):

Location:

trunk/Source

Files:

• WebCore/ChangeLog (modified) (1 diff)
• WebCore/accessibility/atspi/AccessibilityAtspi.cpp (modified) (1 diff)
• WebCore/accessibility/atspi/AccessibilityRootAtspi.cpp (modified) (5 diffs)
• WebCore/accessibility/atspi/AccessibilityRootAtspi.h (modified) (2 diffs)
• WebCore/accessibility/atspi/xml/Socket.xml (modified) (1 diff)
• WebKit/ChangeLog (modified) (1 diff)
• WebKit/UIProcess/ProvisionalPageProxy.cpp (modified) (2 diffs)
• WebKit/UIProcess/ProvisionalPageProxy.h (modified) (2 diffs)
• WebKit/UIProcess/WebPageProxy.cpp (modified) (1 diff)
• WebKit/UIProcess/WebPageProxy.h (modified) (1 diff)
• WebKit/UIProcess/WebPageProxy.messages.in (modified) (1 diff)
• WebKit/UIProcess/gtk/WebPageProxyGtk.cpp (modified) (2 diffs)
• WebKit/UIProcess/wpe/WebPageProxyWPE.cpp (modified) (2 diffs)
• WebKit/WebProcess/WebPage/gtk/WebPageGtk.cpp (modified) (2 diffs)
• WebKit/WebProcess/WebPage/wpe/WebPageWPE.cpp (modified) (1 diff)

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2021-12-13  Carlos Garcia Campos  <cgarcia@igalia.com>
+
+        [GTK][a11y] Handle the Embedded method sent by AtkSocket from AccessibilityRootAtspi
+        https://bugs.webkit.org/show_bug.cgi?id=234233
+
+        Reviewed by Adrian Perez de Castro.
+
+        * accessibility/atspi/AccessibilityAtspi.cpp:
+        (WebCore::AccessibilityAtspi::registerRoot):
+        * accessibility/atspi/AccessibilityRootAtspi.cpp:
+        (WebCore::AccessibilityRootAtspi::registerObject):
+        (WebCore::AccessibilityRootAtspi::embedded):
+        (WebCore::AccessibilityRootAtspi::setParentPath): Deleted.
+        * accessibility/atspi/AccessibilityRootAtspi.h:
+        * accessibility/atspi/xml/Socket.xml:
+
 2021-12-13  Kate Cheney  <katherine_cheney@apple.com>
 

trunk/Source/WebCore/accessibility/atspi/AccessibilityAtspi.cpp

@@ -74 +74 @@
             ensureCache();
             String path = makeString("/org/a11y/webkit/accessible/", createCanonicalUUIDString().replace('-', '_'));
-            Vector<unsigned, 2> registeredObjects;
+            Vector<unsigned, 3> registeredObjects;
             registeredObjects.reserveInitialCapacity(interfaces.size());
             for (const auto& interface : interfaces) {

trunk/Source/WebCore/accessibility/atspi/AccessibilityRootAtspi.cpp

@@ -49 +49 @@
 GDBusInterfaceVTable AccessibilityRootAtspi::s_accessibleFunctions = {
     // method_call
-    [](GDBusConnection*, const gchar* sender, const gchar*, const gchar*, const gchar* methodName, GVariant* parameters, GDBusMethodInvocation* invocation, gpointer userData) {
+    [](GDBusConnection*, const gchar*, const gchar*, const gchar*, const gchar* methodName, GVariant* parameters, GDBusMethodInvocation* invocation, gpointer userData) {
         RELEASE_ASSERT(!isMainThread());
         auto& rootObject = *static_cast<AccessibilityRootAtspi*>(userData);
@@ -59 +59 @@
             g_dbus_method_invocation_return_value(invocation, g_variant_new("(s)", _("filler")));
         else if (!g_strcmp0(methodName, "GetState")) {
-#if USE(GTK4)
-            // FIXME: we need a way to get the parent atspi reference in GTK4.
-#else
-            // Since we don't have a way to know the unique name of the UI process, right after calling
-            // atk_socket_embed() the UI process calls atk_object_ref_state_set() to force a GetState message.
-            // We use this first GetState message to set the sender as the parent unique name.
-            if (rootObject.m_parentUniqueName.isNull())
-                rootObject.m_parentUniqueName = sender;
-#endif
             GVariantBuilder builder = G_VARIANT_BUILDER_INIT(G_VARIANT_TYPE("(au)"));
 
@@ -155 +146 @@
 };
 
+GDBusInterfaceVTable AccessibilityRootAtspi::s_socketFunctions = {
+    // method_call
+    [](GDBusConnection*, const gchar* sender, const gchar*, const gchar*, const gchar* methodName, GVariant* parameters, GDBusMethodInvocation* invocation, gpointer userData) {
+        RELEASE_ASSERT(!isMainThread());
+        auto& rootObject = *static_cast<AccessibilityRootAtspi*>(userData);
+        if (!g_strcmp0(methodName, "Embedded")) {
+            const char* path;
+            g_variant_get(parameters, "(&s)", &path);
+            rootObject.embedded(sender, path);
+            g_dbus_method_invocation_return_value(invocation, nullptr);
+        }
+    },
+    // get_property
+    nullptr,
+    // set_property,
+    nullptr,
+    // padding
+    nullptr
+};
+
 void AccessibilityRootAtspi::registerObject(CompletionHandler<void(const String&)>&& completionHandler)
 {
@@ -163 +174 @@
     Vector<std::pair<GDBusInterfaceInfo*, GDBusInterfaceVTable*>> interfaces;
     interfaces.append({ const_cast<GDBusInterfaceInfo*>(&webkit_accessible_interface), &s_accessibleFunctions });
+    interfaces.append({ const_cast<GDBusInterfaceInfo*>(&webkit_socket_interface), &s_socketFunctions });
     interfaces.append({ const_cast<GDBusInterfaceInfo*>(&webkit_component_interface), &s_componentFunctions });
     m_atspi.registerRoot(*this, WTFMove(interfaces), WTFMove(completionHandler));
@@ -182 +194 @@
 }
 
-void AccessibilityRootAtspi::setParentPath(String&& path)
-{
-    RELEASE_ASSERT(isMainThread());
-    m_parentPath = WTFMove(path);
+void AccessibilityRootAtspi::embedded(const char* parentUniqueName, const char* parentPath)
+{
+    RELEASE_ASSERT(!isMainThread());
+    m_parentUniqueName = parentUniqueName;
+    m_parentPath = parentPath;
 }
 

trunk/Source/WebCore/accessibility/atspi/AccessibilityRootAtspi.h

@@ -42 +42 @@
     void unregisterObject();
     void setPath(String&&);
-    void setParentPath(String&&);
 
     const String& path() const { return m_path; }
@@ -56 +55 @@
     AccessibilityRootAtspi(Page&, AccessibilityAtspi&);
 
+    void embedded(const char* parentUniqueName, const char* parentPath);
     IntRect frameRect(uint32_t) const;
 
     static GDBusInterfaceVTable s_accessibleFunctions;
+    static GDBusInterfaceVTable s_socketFunctions;
     static GDBusInterfaceVTable s_componentFunctions;
 

trunk/Source/WebCore/accessibility/atspi/xml/Socket.xml

@@ -15 +15 @@
   </method>
 
+  <method name="Embedded">
+    <arg direction="in" name="socketPath" type="s"/>
+    <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="QSpiObjectReference"/>
+  </method>
+
   <signal name="Available">
     <arg direction="in" name="socket" type="(so)"/>

trunk/Source/WebKit/ChangeLog

@@ +1 @@
+2021-12-13  Carlos Garcia Campos  <cgarcia@igalia.com>
+
+        [GTK][a11y] Handle the Embedded method sent by AtkSocket from AccessibilityRootAtspi
+        https://bugs.webkit.org/show_bug.cgi?id=234233
+
+        Reviewed by Adrian Perez de Castro.
+
+        I added some hacks to send the socket path to the web process using WebKit IPC because Embedded message is not
+        in the DBus interface. We can simply add the message to the interface definition and handle it instead to
+        simplify everything.
+
+        * UIProcess/ProvisionalPageProxy.cpp:
+        (WebKit::ProvisionalPageProxy::bindAccessibilityTree):
+        (WebKit::ProvisionalPageProxy::didReceiveMessage):
+        * UIProcess/ProvisionalPageProxy.h:
+        (WebKit::ProvisionalPageProxy::accessibilityPlugID):
+        (WebKit::ProvisionalPageProxy::CompletionHandler<void): Deleted.
+        * UIProcess/WebPageProxy.cpp:
+        (WebKit::WebPageProxy::swapToProvisionalPage):
+        * UIProcess/WebPageProxy.h:
+        * UIProcess/WebPageProxy.messages.in:
+        * UIProcess/gtk/WebPageProxyGtk.cpp:
+        (WebKit::WebPageProxy::bindAccessibilityTree):
+        * UIProcess/wpe/WebPageProxyWPE.cpp:
+        (WebKit::WebPageProxy::bindAccessibilityTree):
+        * WebProcess/WebPage/gtk/WebPageGtk.cpp:
+        (WebKit::WebPage::platformInitialize):
+
 2021-12-13  John Wilander  <wilander@apple.com>
 

trunk/Source/WebKit/UIProcess/ProvisionalPageProxy.cpp

@@ -445 +445 @@
 
 #if PLATFORM(GTK) || PLATFORM(WPE)
-void ProvisionalPageProxy::bindAccessibilityTree(const String& plugID, CompletionHandler<void(String&&)>&& completionHandler)
+void ProvisionalPageProxy::bindAccessibilityTree(const String& plugID)
 {
     m_accessibilityPlugID = plugID;
-    m_accessibilityBindCompletionHandler = WTFMove(completionHandler);
 }
 #endif
@@ -513 +512 @@
 #if PLATFORM(GTK) || PLATFORM(WPE)
     if (decoder.messageName() == Messages::WebPageProxy::BindAccessibilityTree::name()) {
-        IPC::handleMessageAsync<Messages::WebPageProxy::BindAccessibilityTree>(connection, decoder, this, &ProvisionalPageProxy::bindAccessibilityTree);
+        IPC::handleMessage<Messages::WebPageProxy::BindAccessibilityTree>(connection, decoder, this, &ProvisionalPageProxy::bindAccessibilityTree);
         return;
     }

trunk/Source/WebKit/UIProcess/ProvisionalPageProxy.h

@@ -97 +97 @@
 #if PLATFORM(GTK) || PLATFORM(WPE)
     const String& accessibilityPlugID() { return m_accessibilityPlugID; }
-    CompletionHandler<void(String&&)> takeAccessibilityBindCompletionHandler() { return std::exchange(m_accessibilityBindCompletionHandler, nullptr); }
 #endif
 #if HAVE(VISIBILITY_PROPAGATION_VIEW)
@@ -150 +149 @@
 #endif
 #if PLATFORM(GTK) || PLATFORM(WPE)
-    void bindAccessibilityTree(const String&, CompletionHandler<void(String&&)>&&);
+    void bindAccessibilityTree(const String&);
 #endif
 #if ENABLE(CONTENT_FILTERING)

trunk/Source/WebKit/UIProcess/WebPageProxy.cpp

@@ -989 +989 @@
 #endif
 #if PLATFORM(GTK) || PLATFORM(WPE)
-    if (auto completionHandler = provisionalPage->takeAccessibilityBindCompletionHandler())
-        bindAccessibilityTree(provisionalPage->accessibilityPlugID(), WTFMove(completionHandler));
+    auto accessibilityPlugID = provisionalPage->accessibilityPlugID();
+    if (!accessibilityPlugID.isEmpty())
+        bindAccessibilityTree(accessibilityPlugID);
 #endif
 }

trunk/Source/WebKit/UIProcess/WebPageProxy.h

@@ -2291 +2291 @@
 
 #if PLATFORM(GTK) || PLATFORM(WPE)
-    void bindAccessibilityTree(const String&, CompletionHandler<void(String&&)>&&);
+    void bindAccessibilityTree(const String&);
 #endif
 

trunk/Source/WebKit/UIProcess/WebPageProxy.messages.in

@@ -180 +180 @@
 #if PLATFORM(GTK) || PLATFORM(WPE)
     # Support for connecting the Accessibility worlds of the UI and the Web processes
-    BindAccessibilityTree(String plugID) -> (String socketPath) Async
+    BindAccessibilityTree(String plugID)
 
     SetInputMethodState(std::optional<WebKit::InputMethodState> state);

trunk/Source/WebKit/UIProcess/gtk/WebPageProxyGtk.cpp

@@ -50 +50 @@
 }
 
-void WebPageProxy::bindAccessibilityTree(const String& plugID, CompletionHandler<void(String&&)>&& completionHandler)
+void WebPageProxy::bindAccessibilityTree(const String& plugID)
 {
 #if USE(GTK4)
@@ -58 +58 @@
     auto* accessible = gtk_widget_get_accessible(viewWidget());
     atk_socket_embed(ATK_SOCKET(accessible), const_cast<char*>(plugID.utf8().data()));
-#if USE(ATSPI)
-    // ATK doesn't have API to get the atspi reference of an object, but we know the id is stored
-    // as an object user data as "spi-dbus-id". To let the web process know about the unique name, we call
-    // atk_object_ref_state_set() that sends a GetState message to the web process root object.
-    g_object_unref(atk_object_ref_state_set(accessible));
-    completionHandler(makeString("/org/a11y/atspi/accessible/", GPOINTER_TO_INT(g_object_get_data(G_OBJECT(accessible), "spi-dbus-id"))));
-#else
-    completionHandler({ });
-#endif
     atk_object_notify_state_change(accessible, ATK_STATE_TRANSIENT, FALSE);
 #endif

trunk/Source/WebKit/UIProcess/wpe/WebPageProxyWPE.cpp

@@ -46 +46 @@
 }
 
-void WebPageProxy::bindAccessibilityTree(const String& plugID, CompletionHandler<void(String&&)>&& completionHandler)
+void WebPageProxy::bindAccessibilityTree(const String& plugID)
 {
 #if USE(ATK)
@@ -52 +52 @@
     atk_socket_embed(ATK_SOCKET(accessible), const_cast<char*>(plugID.utf8().data()));
     atk_object_notify_state_change(accessible, ATK_STATE_TRANSIENT, FALSE);
-    completionHandler({ });
 #endif
 }

trunk/Source/WebKit/WebProcess/WebPage/gtk/WebPageGtk.cpp

@@ -65 +65 @@
     m_accessibilityObject = adoptGRef(webkitWebPageAccessibilityObjectNew(this));
     GUniquePtr<gchar> plugID(atk_plug_get_id(ATK_PLUG(m_accessibilityObject.get())));
-    sendWithAsyncReply(Messages::WebPageProxy::BindAccessibilityTree(String(plugID.get())), [](String&&) { });
+    send(Messages::WebPageProxy::BindAccessibilityTree(String(plugID.get())));
 #elif USE(ATSPI)
 #if USE(GTK4)
@@ -73 +73 @@
         m_accessibilityRootObject = AccessibilityRootAtspi::create(*page, WebProcess::singleton().accessibilityAtspi());
         m_accessibilityRootObject->registerObject([&](const String& plugID) {
-            // ATK uses a custom DBus message to send the socket path to the AtkPlug object. GDBus doesn't allow
-            // to send a message that is not defined in the interface, so we use the WebKit IPC to get the socket
-            // path from the UI process.
-            sendWithAsyncReply(Messages::WebPageProxy::BindAccessibilityTree(plugID), [&](String&& socketPath) {
-                m_accessibilityRootObject->setParentPath(WTFMove(socketPath));
-            });
+            send(Messages::WebPageProxy::BindAccessibilityTree(plugID));
         });
     }

trunk/Source/WebKit/WebProcess/WebPage/wpe/WebPageWPE.cpp

@@ -46 +46 @@
     m_accessibilityObject = adoptGRef(webkitWebPageAccessibilityObjectNew(this));
     GUniquePtr<gchar> plugID(atk_plug_get_id(ATK_PLUG(m_accessibilityObject.get())));
-    sendWithAsyncReply(Messages::WebPageProxy::BindAccessibilityTree(String(plugID.get())), [](String&&) { });
+    send(Messages::WebPageProxy::BindAccessibilityTree(String(plugID.get())));
 #endif
 }