Changeset 236669 in webkit

Timestamp:

Oct 1, 2018 10:41:25 AM (6 years ago)

Author:

dbates@webkit.org

Message:

[iOS] Wrong key event may be sent to UIKit
​https://bugs.webkit.org/show_bug.cgi?id=189992

Reviewed by Simon Fraser.

Retain a clone of a received UIEvent if it is for a hardware key event so as to ensure that we
notify the UIKit keyboard code of the correct keyboard event.

Currently the UIProcess retains the UIEvent associated with a keyboard event so as to defer
notifying the UIKit keyboard code (via -_handleKeyUIEvent) about a received keyboard event until
after the WebProcess has processed the raw key event. If this UIEvent is for a hardware keyboard
event then it is not sufficient to retain it to preserve its value because UIKit uses a singleton
UIEvent for all hardware keyboard events ;=> its value will be clobbered as each hardware keyboard
event is received. Instead we need to explicitly clone a UIEvent for a hardware key event before
retaining it.

• Platform/spi/ios/UIKitSPI.h: Forward declare SPI.
• UIProcess/ios/WKContentViewInteraction.mm:

(-[WKContentView handleKeyEvent:]): Clone the UIEvent if it is for a hardware key event.

Location:

trunk/Source/WebKit

Files:

• ChangeLog (modified) (1 diff)
• Platform/spi/ios/UIKitSPI.h (modified) (1 diff)
• UIProcess/ios/WKContentViewInteraction.mm (modified) (2 diffs)

trunk/Source/WebKit/ChangeLog

@@ +1 @@
+2018-10-01  Daniel Bates  <dabates@apple.com>
+
+        [iOS] Wrong key event may be sent to UIKit
+        https://bugs.webkit.org/show_bug.cgi?id=189992
+
+        Reviewed by Simon Fraser.
+
+        Retain a clone of a received UIEvent if it is for a hardware key event so as to ensure that we
+        notify the UIKit keyboard code of the correct keyboard event.
+
+        Currently the UIProcess retains the UIEvent associated with a keyboard event so as to defer
+        notifying the UIKit keyboard code (via -_handleKeyUIEvent) about a received keyboard event until
+        after the WebProcess has processed the raw key event. If this UIEvent is for a hardware keyboard
+        event then it is not sufficient to retain it to preserve its value because UIKit uses a singleton
+        UIEvent for all hardware keyboard events ;=> its value will be clobbered as each hardware keyboard
+        event is received. Instead we need to explicitly clone a UIEvent for a hardware key event before
+        retaining it.
+
+        * Platform/spi/ios/UIKitSPI.h: Forward declare SPI.
+        * UIProcess/ios/WKContentViewInteraction.mm:
+        (-[WKContentView handleKeyEvent:]): Clone the UIEvent if it is for a hardware key event.
+
 2018-10-01  Alex Christensen  <achristensen@webkit.org>
 

trunk/Source/WebKit/Platform/spi/ios/UIKitSPI.h

@@ -1004 +1004 @@
 
 @interface UIPhysicalKeyboardEvent ()
+- (UIPhysicalKeyboardEvent *)_cloneEvent NS_RETURNS_RETAINED;
 @property (nonatomic, readonly) CFIndex _keyCode;
 @end

trunk/Source/WebKit/UIProcess/ios/WKContentViewInteraction.mm

@@ -3746 +3746 @@
         return;
 
+    uint16_t keyCode;
+    BOOL isHardwareKeyboardEvent = !!event._hidEvent;
+    if (!isHardwareKeyboardEvent)
+        keyCode = 0;
+    else {
+        UIPhysicalKeyboardEvent *keyEvent = (UIPhysicalKeyboardEvent *)event;
+        keyCode = keyEvent._keyCode;
+        event = [[keyEvent _cloneEvent] autorelease]; // UIKit uses a singleton for hardware keyboard events.
+    }
     WKWebEvent *webEvent = [[[WKWebEvent alloc] initWithKeyEventType:(event._isKeyDown) ? WebEventKeyDown : WebEventKeyUp
                                                            timeStamp:event.timestamp
@@ -3753 +3762 @@
                                                          isRepeating:(event._inputFlags & kUIKeyboardInputRepeat)
                                                            withFlags:event._inputFlags
-                                                             keyCode:event._hidEvent ? ((UIPhysicalKeyboardEvent *)event)._keyCode : 0
+                                                             keyCode:keyCode
                                                             isTabKey:[event._modifiedInput isEqualToString:@"\t"]
                                                         characterSet:WebEventCharacterSetUnicode] autorelease];