[GTK][Wayland] Crash when gdk_keymap_get_entries_for_keyval returns TRUE but n_keys=0

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

Reviewed by Carlos Alberto Lopez Perez.

Source/WebKit:

In Wayland gdk_keymap_get_entries_for_keyval() can return TRUE with n_keys=0. We have several places in WebKit
where we just check the return value of gdk_keymap_get_entries_for_keyval() and then use the returned array to
get the first position assuming it has at least one item. This has always worked in X11 because the GDK X11
backend does the right thing, but it's crashing in Wayland now. It should be fixed in GTK+ but in the meantime
it's easy to workaround by also checking n_keys > 0.

* UIProcess/Automation/gtk/WebAutomationSessionGtk.cpp:
(WebKit::doKeyStrokeEvent):

Tools:

Also check the n_keys > 0 when using gdk_keymap_get_entries_for_keyval().

* TestWebKitAPI/Tests/WebKit/gtk/InputMethodFilter.cpp:
(TestWebKitAPI::TestInputMethodFilter::sendKeyEventToFilter):
* TestWebKitAPI/Tests/WebKitGtk/TestPrinting.cpp: Remove duplicated code and use WebViewTest::keyStroke instead.
* TestWebKitAPI/glib/WebKitGLib/gtk/WebViewTestGtk.cpp:
(WebViewTest::keyStroke):
* TestWebKitAPI/gtk/PlatformWebViewGtk.cpp:
(TestWebKitAPI::doKeyStroke):
* WebKitTestRunner/gtk/EventSenderProxyGtk.cpp:
(WTR::EventSenderProxy::keyDown):

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

Author: [email protected]

Source/WebKit/ChangeLog

@@ -1,3 +1,19 @@
+2017-08-31  Carlos Garcia Campos  <[email protected]>
+
+        [GTK][Wayland] Crash when gdk_keymap_get_entries_for_keyval returns TRUE but n_keys=0
+        https://bugs.webkit.org/show_bug.cgi?id=176154
+
+        Reviewed by Carlos Alberto Lopez Perez.
+
+        In Wayland gdk_keymap_get_entries_for_keyval() can return TRUE with n_keys=0. We have several places in WebKit
+        where we just check the return value of gdk_keymap_get_entries_for_keyval() and then use the returned array to
+        get the first position assuming it has at least one item. This has always worked in X11 because the GDK X11
+        backend does the right thing, but it's crashing in Wayland now. It should be fixed in GTK+ but in the meantime
+        it's easy to workaround by also checking n_keys > 0.
+
+        * UIProcess/Automation/gtk/WebAutomationSessionGtk.cpp:
+        (WebKit::doKeyStrokeEvent):
+
 2017-08-30  Dan Bernstein  <[email protected]>
 
         [iOS] REGRESSION (r218144) -[WKContentView targetForAction:withSender:] returns the content view for actions implemented only by the WKWebView, causing a crash

Source/WebKit/UIProcess/Automation/gtk/WebAutomationSessionGtk.cpp

@@ -145,7 +145,7 @@ static void doKeyStrokeEvent(GdkEventType type, GtkWidget* widget, unsigned keyV
     // When synthesizing an event, an invalid hardware_keycode value can cause it to be badly processed by GTK+.
     GUniqueOutPtr<GdkKeymapKey> keys;
     int keysCount;
-    if (gdk_keymap_get_entries_for_keyval(gdk_keymap_get_default(), keyVal, &keys.outPtr(), &keysCount))
+    if (gdk_keymap_get_entries_for_keyval(gdk_keymap_get_default(), keyVal, &keys.outPtr(), &keysCount) && keysCount)
         event->key.hardware_keycode = keys.get()[0].keycode;
 
     gtk_main_do_event(event.get());

Tools/ChangeLog

@@ -1,3 +1,22 @@
+2017-08-31  Carlos Garcia Campos  <[email protected]>
+
+        [GTK][Wayland] Crash when gdk_keymap_get_entries_for_keyval returns TRUE but n_keys=0
+        https://bugs.webkit.org/show_bug.cgi?id=176154
+
+        Reviewed by Carlos Alberto Lopez Perez.
+
+        Also check the n_keys > 0 when using gdk_keymap_get_entries_for_keyval().
+
+        * TestWebKitAPI/Tests/WebKit/gtk/InputMethodFilter.cpp:
+        (TestWebKitAPI::TestInputMethodFilter::sendKeyEventToFilter):
+        * TestWebKitAPI/Tests/WebKitGtk/TestPrinting.cpp: Remove duplicated code and use WebViewTest::keyStroke instead.
+        * TestWebKitAPI/glib/WebKitGLib/gtk/WebViewTestGtk.cpp:
+        (WebViewTest::keyStroke):
+        * TestWebKitAPI/gtk/PlatformWebViewGtk.cpp:
+        (TestWebKitAPI::doKeyStroke):
+        * WebKitTestRunner/gtk/EventSenderProxyGtk.cpp:
+        (WTR::EventSenderProxy::keyDown):
+
 2017-08-31  Carlos Garcia Campos  <[email protected]>
 
         Unreviewed. Fix GTK+ test /webkit2/WebKitAutomationSession/request-session.

Tools/TestWebKitAPI/Tests/WebKit/gtk/InputMethodFilter.cpp

@@ -67,7 +67,7 @@ class TestInputMethodFilter : public InputMethodFilter {
 
         GUniqueOutPtr<GdkKeymapKey> keys;
         gint nKeys;
-        if (gdk_keymap_get_entries_for_keyval(gdk_keymap_get_default(), gdkKeyValue, &keys.outPtr(), &nKeys))
+        if (gdk_keymap_get_entries_for_keyval(gdk_keymap_get_default(), gdkKeyValue, &keys.outPtr(), &nKeys) && nKeys)
             event->key.hardware_keycode = keys.get()[0].keycode;
 
         filterKeyEvent(&event->key);

Tools/TestWebKitAPI/Tests/WebKitGtk/TestPrinting.cpp

@@ -365,32 +365,6 @@ class PrintCustomWidgetTest: public WebViewTest {
         g_main_loop_quit(m_mainLoop);
     }
 
-    void sendKeyEvent(unsigned gdkKeyValue, GdkEventType type, unsigned modifiers)
-    {
-        GdkEvent* event = gdk_event_new(type);
-        event->key.keyval = gdkKeyValue;
-        event->key.state = modifiers;
-        event->key.window = gtk_widget_get_window(GTK_WIDGET(m_webView));
-        event->key.time = GDK_CURRENT_TIME;
-        g_object_ref(event->key.window);
-        gdk_event_set_device(event, gdk_device_manager_get_client_pointer(gdk_display_get_device_manager(gdk_display_get_default())));
-
-        GUniqueOutPtr<GdkKeymapKey> keys;
-        gint nKeys;
-        if (gdk_keymap_get_entries_for_keyval(gdk_keymap_get_default(), gdkKeyValue, &keys.outPtr(), &nKeys))
-            event->key.hardware_keycode = keys.get()[0].keycode;
-
-        gtk_main_do_event(event);
-
-        gdk_event_free(event);
-    }
-
-    void sendKeyPressAndReleaseEvent(unsigned gdkKeyValue, unsigned modifiers = 0)
-    {
-        sendKeyEvent(gdkKeyValue, GDK_KEY_PRESS, modifiers);
-        sendKeyEvent(gdkKeyValue, GDK_KEY_RELEASE, modifiers);
-    }
-
     void createWebKitPrintOperation()
     {
         m_printOperation = adoptGRef(webkit_print_operation_new(m_webView));
@@ -410,23 +384,23 @@ class PrintCustomWidgetTest: public WebViewTest {
     void startPrinting()
     {
         // To start printing it is enough to press the Return key
-        sendKeyPressAndReleaseEvent(GDK_KEY_Return);
+        keyStroke(GDK_KEY_Return);
     }
 
     void jumpToFirstPrinter()
     {
         // Initially the GtkNotebook has focus, so we just need to press the Tab
         // key to jump to the first printer
-        sendKeyPressAndReleaseEvent(GDK_KEY_Tab);
+        keyStroke(GDK_KEY_Tab);
     }
 
     void jumpToCustomWidget()
     {
         // Jump back to the GtkNotebook
-        sendKeyPressAndReleaseEvent(GDK_KEY_Tab, GDK_SHIFT_MASK);
+        keyStroke(GDK_KEY_Tab, GDK_SHIFT_MASK);
         // Custom widget is on the third tab
-        sendKeyPressAndReleaseEvent(GDK_KEY_Right);
-        sendKeyPressAndReleaseEvent(GDK_KEY_Right);
+        keyStroke(GDK_KEY_Right);
+        keyStroke(GDK_KEY_Right);
     }
 
     void openDialogMoveThroughItAndWaitUntilClosed()

Tools/TestWebKitAPI/glib/WebKitGLib/gtk/WebViewTestGtk.cpp

@@ -148,7 +148,7 @@ void WebViewTest::keyStroke(unsigned keyVal, unsigned keyModifiers)
     // When synthesizing an event, an invalid hardware_keycode value can cause it to be badly processed by GTK+.
     GUniqueOutPtr<GdkKeymapKey> keys;
     int keysCount;
-    if (gdk_keymap_get_entries_for_keyval(gdk_keymap_get_default(), keyVal, &keys.outPtr(), &keysCount))
+    if (gdk_keymap_get_entries_for_keyval(gdk_keymap_get_default(), keyVal, &keys.outPtr(), &keysCount) && keysCount)
         event->key.hardware_keycode = keys.get()[0].keycode;
 
     gtk_main_do_event(event.get());

Tools/TestWebKitAPI/gtk/PlatformWebViewGtk.cpp

@@ -95,7 +95,7 @@ static void doKeyStroke(GtkWidget* viewWidget, unsigned int keyVal)
     // When synthesizing an event, an invalid hardware_keycode value can cause it to be badly processed by GTK+.
     GUniqueOutPtr<GdkKeymapKey> keys;
     int keysCount;
-    if (gdk_keymap_get_entries_for_keyval(gdk_keymap_get_default(), keyVal, &keys.outPtr(), &keysCount))
+    if (gdk_keymap_get_entries_for_keyval(gdk_keymap_get_default(), keyVal, &keys.outPtr(), &keysCount) && keysCount)
         event->key.hardware_keycode = keys.get()[0].keycode;
 
     gtk_main_do_event(event.get());

Tools/WebKitTestRunner/gtk/EventSenderProxyGtk.cpp

@@ -315,7 +315,7 @@ void EventSenderProxy::keyDown(WKStringRef keyRef, WKEventModifiers wkModifiers,
 
     GUniqueOutPtr<GdkKeymapKey> keys;
     gint nKeys;
-    if (gdk_keymap_get_entries_for_keyval(gdk_keymap_get_default(), gdkKeySym, &keys.outPtr(), &nKeys))
+    if (gdk_keymap_get_entries_for_keyval(gdk_keymap_get_default(), gdkKeySym, &keys.outPtr(), &nKeys) && nKeys)
         pressEvent->key.hardware_keycode = keys.get()[0].keycode;
 
     GdkEvent* releaseEvent = gdk_event_copy(pressEvent);