Changeset 237886 in webkit

Timestamp:

Nov 6, 2018 1:58:29 PM (5 years ago)

Author:

pvollan@apple.com

Message:

REGRESSION (r230523): Caps lock indicator not shown in password field
​https://bugs.webkit.org/show_bug.cgi?id=190056

Reviewed by Ryosuke Niwa.

Source/WebCore:

When WindowServer access is blocked, GetCurrentModifiers() always returns 0. Instead of calling
GetCurrentModifiers(), store the current modifiers from the key event argument in the method
WebKit::WebPage::keyEvent, and use the stored value to detect if Caps lock is on. Additionally,
the modifiers needs to be updated when the window becomes active.

Test: fast/events/detect-caps-lock.html

• Sources.txt:
• platform/PlatformKeyboardEvent.h:
• platform/graphics/FontTaggedSettings.cpp:
• platform/mac/KeyEventMac.mm:

(WebCore::PlatformKeyboardEvent::currentCapsLockState):
(WebCore::PlatformKeyboardEvent::getCurrentModifierState):

• testing/Internals.cpp:

(WebCore::Internals::capsLockIsOn):

• testing/Internals.h:
• testing/Internals.idl:

Source/WebKit:

Update cached modifier state in the WebProcess when WebKit::WebPage::keyEvent is called, and
when the window becomes active.

• UIProcess/WebPageProxy.cpp:

(WebKit::WebPageProxy::dispatchActivityStateChange):
(WebKit::WebPageProxy::updateCurrentModifierState):

• UIProcess/WebPageProxy.h:
• WebProcess/WebPage/WebPage.cpp:

(WebKit::WebPage::keyEvent):
(WebKit::WebPage::updateCurrentModifierState):

• WebProcess/WebPage/WebPage.h:
• WebProcess/WebPage/WebPage.messages.in:

Tools:

• WebKitTestRunner/InjectedBundle/Bindings/TestRunner.idl:
• WebKitTestRunner/InjectedBundle/TestRunner.cpp:

(WTR::TestRunner::toggleCapsLock):

• WebKitTestRunner/InjectedBundle/TestRunner.h:
• WebKitTestRunner/TestController.h:
• WebKitTestRunner/TestInvocation.cpp:

(WTR::TestInvocation::didReceiveSynchronousMessageFromInjectedBundle):

• WebKitTestRunner/cocoa/TestControllerCocoa.mm:

(WTR::TestController::toggleCapsLock):

LayoutTests:

• TestExpectations:
• fast/events/detect-caps-lock-expected.txt: Added.
• fast/events/detect-caps-lock.html: Added.
• platform/mac/TestExpectations:

Location:

trunk

Files:

• LayoutTests/ChangeLog (modified) (1 diff)
• LayoutTests/TestExpectations (modified) (1 diff)
• LayoutTests/fast/events/detect-caps-lock-expected.txt (added)
• LayoutTests/fast/events/detect-caps-lock.html (added)
• LayoutTests/platform/mac/TestExpectations (modified) (1 diff)
• Source/WebCore/ChangeLog (modified) (1 diff)
• Source/WebCore/Sources.txt (modified) (1 diff)
• Source/WebCore/platform/PlatformKeyboardEvent.cpp (added)
• Source/WebCore/platform/PlatformKeyboardEvent.h (modified) (2 diffs)
• Source/WebCore/platform/graphics/cairo/GraphicsContextImplCairo.cpp (modified) (1 diff)
• Source/WebCore/platform/mac/KeyEventMac.mm (modified) (2 diffs)
• Source/WebCore/platform/mediarecorder/MediaRecorderPrivate.h (modified) (1 diff)
• Source/WebCore/testing/Internals.cpp (modified) (2 diffs)
• Source/WebCore/testing/Internals.h (modified) (1 diff)
• Source/WebCore/testing/Internals.idl (modified) (1 diff)
• Source/WebKit/ChangeLog (modified) (1 diff)
• Source/WebKit/UIProcess/WebPageProxy.cpp (modified) (3 diffs)
• Source/WebKit/UIProcess/WebPageProxy.h (modified) (1 diff)
• Source/WebKit/WebProcess/WebPage/WebPage.cpp (modified) (2 diffs)
• Source/WebKit/WebProcess/WebPage/WebPage.h (modified) (1 diff)
• Source/WebKit/WebProcess/WebPage/WebPage.messages.in (modified) (1 diff)
• Tools/ChangeLog (modified) (1 diff)
• Tools/WebKitTestRunner/InjectedBundle/Bindings/TestRunner.idl (modified) (1 diff)
• Tools/WebKitTestRunner/InjectedBundle/TestRunner.cpp (modified) (1 diff)
• Tools/WebKitTestRunner/InjectedBundle/TestRunner.h (modified) (1 diff)
• Tools/WebKitTestRunner/TestController.h (modified) (2 diffs)
• Tools/WebKitTestRunner/TestInvocation.cpp (modified) (1 diff)
• Tools/WebKitTestRunner/cocoa/TestControllerCocoa.mm (modified) (1 diff)

trunk/LayoutTests/ChangeLog

@@ +1 @@
+2018-11-06  Per Arne Vollan  <pvollan@apple.com>
+
+        REGRESSION (r230523): Caps lock indicator not shown in password field
+        https://bugs.webkit.org/show_bug.cgi?id=190056
+
+        Reviewed by Ryosuke Niwa.
+
+        * TestExpectations:
+        * fast/events/detect-caps-lock-expected.txt: Added.
+        * fast/events/detect-caps-lock.html: Added.
+        * platform/mac/TestExpectations:
+
 2018-11-06  Ali Juma  <ajuma@chromium.org>
 

trunk/LayoutTests/TestExpectations

@@ -422 +422 @@
 
 fast/misc/valid-primary-screen-displayID.html [ Skip ]
+
+fast/events/detect-caps-lock.html [ Skip ]
 
 # This test currently only works for mac-wk2

trunk/LayoutTests/platform/mac/TestExpectations

@@ -40 +40 @@
 fast/text/mac [ Pass ]
 webkit.org/b/181964 fast/text/mac/select-character-before-zero-width-joiner.html [ ImageOnlyFailure ]
+
+[ Mojave+ ] fast/events/detect-caps-lock.html [ Pass ]
 
 #//////////////////////////////////////////////////////////////////////////////////////////

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2018-11-06  Per Arne Vollan  <pvollan@apple.com>
+
+        REGRESSION (r230523): Caps lock indicator not shown in password field
+        https://bugs.webkit.org/show_bug.cgi?id=190056
+
+        Reviewed by Ryosuke Niwa.
+
+        When WindowServer access is blocked, GetCurrentModifiers() always returns 0. Instead of calling
+        GetCurrentModifiers(), store the current modifiers from the key event argument in the method
+        WebKit::WebPage::keyEvent, and use the stored value to detect if Caps lock is on. Additionally,
+        the modifiers needs to be updated when the window becomes active.
+
+        Test: fast/events/detect-caps-lock.html
+
+        * Sources.txt:
+        * platform/PlatformKeyboardEvent.h:
+        * platform/graphics/FontTaggedSettings.cpp:
+        * platform/mac/KeyEventMac.mm:
+        (WebCore::PlatformKeyboardEvent::currentCapsLockState):
+        (WebCore::PlatformKeyboardEvent::getCurrentModifierState):
+        * testing/Internals.cpp:
+        (WebCore::Internals::capsLockIsOn):
+        * testing/Internals.h:
+        * testing/Internals.idl:
+
 2018-11-06  Javier Fernandez  <jfernandez@igalia.com>
 

trunk/Source/WebCore/Sources.txt

@@ -1543 +1543 @@
 platform/Pasteboard.cpp
 platform/PasteboardWriterData.cpp
+platform/PlatformKeyboardEvent.cpp
 platform/PlatformSpeechSynthesisUtterance.cpp
 platform/PlatformSpeechSynthesisVoice.cpp

trunk/Source/WebCore/platform/PlatformKeyboardEvent.h

@@ -136 +136 @@
         bool isSystemKey() const { return m_isSystemKey; }
 
-        static bool currentCapsLockState();
-        static void getCurrentModifierState(bool& shiftKey, bool& ctrlKey, bool& altKey, bool& metaKey);
+        WEBCORE_EXPORT static bool currentCapsLockState();
+        WEBCORE_EXPORT static void getCurrentModifierState(bool& shiftKey, bool& ctrlKey, bool& altKey, bool& metaKey);
+        WEBCORE_EXPORT static void setCurrentModifierState(OptionSet<Modifier>);
+        WEBCORE_EXPORT static OptionSet<Modifier> currentStateOfModifierKeys();
 
 #if PLATFORM(COCOA)
@@ -207 +209 @@
         CompositionResults m_compositionResults;
 #endif
+        
+        // The modifier state is optional, since it is not needed in the UI process or in legacy WebKit.
+        static std::optional<OptionSet<Modifier>> s_currentModifiers;
     };
     

trunk/Source/WebCore/platform/graphics/cairo/GraphicsContextImplCairo.cpp

@@ -31 +31 @@
 
 #include "CairoOperations.h"
+#include "FloatRoundedRect.h"
 #include "Font.h"
 #include "GlyphBuffer.h"
 #include "GraphicsContextPlatformPrivateCairo.h"
+#include "ImageBuffer.h"
+#include "IntRect.h"
+
 
 namespace WebCore {

trunk/Source/WebCore/platform/mac/KeyEventMac.mm

@@ -33 +33 @@
 #import "WindowsKeyboardCodes.h"
 #import <Carbon/Carbon.h>
+#import <wtf/MainThread.h>
 
 namespace WebCore {
@@ -260 +261 @@
 bool PlatformKeyboardEvent::currentCapsLockState()
 {
-    return GetCurrentKeyModifiers() & alphaLock;
+    auto currentModifiers = currentStateOfModifierKeys();
+    return currentModifiers.contains(PlatformEvent::Modifier::CapsLockKey);
 }
 
 void PlatformKeyboardEvent::getCurrentModifierState(bool& shiftKey, bool& ctrlKey, bool& altKey, bool& metaKey)
 {
+    auto currentModifiers = currentStateOfModifierKeys();
+    shiftKey = currentModifiers.contains(PlatformEvent::Modifier::ShiftKey);
+    ctrlKey = currentModifiers.contains(PlatformEvent::Modifier::CtrlKey);
+    altKey = currentModifiers.contains(PlatformEvent::Modifier::AltKey);
+    metaKey = currentModifiers.contains(PlatformEvent::Modifier::MetaKey);
+}
+
+OptionSet<PlatformEvent::Modifier> PlatformKeyboardEvent::currentStateOfModifierKeys()
+{
+#if ENABLE(WEBPROCESS_WINDOWSERVER_BLOCKING)
+    // s_currentModifiers is only set in the WebContent process, not in the UI process.
+    if (s_currentModifiers) {
+        ASSERT(isMainThread());
+        return *s_currentModifiers;
+    }
+#endif
     UInt32 currentModifiers = GetCurrentKeyModifiers();
-    shiftKey = currentModifiers & ::shiftKey;
-    ctrlKey = currentModifiers & ::controlKey;
-    altKey = currentModifiers & ::optionKey;
-    metaKey = currentModifiers & ::cmdKey;
+
+    OptionSet<PlatformEvent::Modifier> modifiers;
+    if (currentModifiers & ::shiftKey)
+        modifiers.add(PlatformEvent::Modifier::ShiftKey);
+    if (currentModifiers & ::controlKey)
+        modifiers.add(PlatformEvent::Modifier::CtrlKey);
+    if (currentModifiers & ::optionKey)
+        modifiers.add(PlatformEvent::Modifier::AltKey);
+    if (currentModifiers & ::cmdKey)
+        modifiers.add(PlatformEvent::Modifier::MetaKey);
+    if (currentModifiers & ::alphaLock)
+        modifiers.add(PlatformEvent::Modifier::CapsLockKey);
+
+    return modifiers;
 }
 

trunk/Source/WebCore/platform/mediarecorder/MediaRecorderPrivate.h

@@ -24 +24 @@
 
 #pragma once
+
+#include <wtf/Forward.h>
 
 #if ENABLE(MEDIA_STREAM)

trunk/Source/WebCore/testing/Internals.cpp

@@ -122 +122 @@
 #include "PageOverlay.h"
 #include "PathUtilities.h"
+#include "PlatformKeyboardEvent.h"
 #include "PlatformMediaSessionManager.h"
 #include "PlatformScreen.h"
@@ -4737 +4738 @@
 }
 
+bool Internals::capsLockIsOn()
+{
+    return WebCore::PlatformKeyboardEvent::currentCapsLockState();
+}
+
 bool Internals::supportsVCPEncoder()
 {

trunk/Source/WebCore/testing/Internals.h

@@ -739 +739 @@
     unsigned primaryScreenDisplayID();
 
+    bool capsLockIsOn();
+        
     bool supportsVCPEncoder();
         

trunk/Source/WebCore/testing/Internals.idl

@@ -710 +710 @@
     unsigned long primaryScreenDisplayID();
 
+    boolean capsLockIsOn();
+
     boolean supportsVCPEncoder();
 

trunk/Source/WebKit/ChangeLog

@@ +1 @@
+2018-11-06  Per Arne Vollan  <pvollan@apple.com>
+
+        REGRESSION (r230523): Caps lock indicator not shown in password field
+        https://bugs.webkit.org/show_bug.cgi?id=190056
+
+        Reviewed by Ryosuke Niwa.
+
+        Update cached modifier state in the WebProcess when WebKit::WebPage::keyEvent is called, and
+        when the window becomes active.
+
+        * UIProcess/WebPageProxy.cpp:
+        (WebKit::WebPageProxy::dispatchActivityStateChange):
+        (WebKit::WebPageProxy::updateCurrentModifierState):
+        * UIProcess/WebPageProxy.h:
+        * WebProcess/WebPage/WebPage.cpp:
+        (WebKit::WebPage::keyEvent):
+        (WebKit::WebPage::updateCurrentModifierState):
+        * WebProcess/WebPage/WebPage.h:
+        * WebProcess/WebPage/WebPage.messages.in:
+
 2018-11-06  Alex Christensen  <achristensen@webkit.org>
 

trunk/Source/WebKit/UIProcess/WebPageProxy.cpp

@@ -146 +146 @@
 #include <WebCore/MediaStreamRequest.h>
 #include <WebCore/PerformanceLoggingClient.h>
+#include <WebCore/PlatformEvent.h>
 #include <WebCore/PublicSuffix.h>
 #include <WebCore/RenderEmbeddedObject.h>
@@ -1561 +1562 @@
     if (changed)
         LOG_WITH_STREAM(ActivityState, stream << "WebPageProxy " << pageID() << " dispatchActivityStateChange: state changed from " << previousActivityState << " to " << m_activityState);
+
+    if ((changed & ActivityState::WindowIsActive) && isViewWindowActive())
+        updateCurrentModifierState();
 
     if ((m_potentiallyChangedActivityStateFlags & ActivityState::IsVisible) && isViewVisible())
@@ -8126 +8130 @@
 }
 
+void WebPageProxy::updateCurrentModifierState()
+{
+#if PLATFORM(MAC) && ENABLE(WEBPROCESS_WINDOWSERVER_BLOCKING)
+    auto modifiers = PlatformKeyboardEvent::currentStateOfModifierKeys();
+    m_process->send(Messages::WebPage::UpdateCurrentModifierState(modifiers), m_pageID);
+#endif
+}
+
 } // namespace WebKit
 

trunk/Source/WebKit/UIProcess/WebPageProxy.h

@@ -1852 +1852 @@
 #endif
 
+    void updateCurrentModifierState();
+
     void reportPageLoadResult(const WebCore::ResourceError& = { });
 

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

@@ -2565 +2565 @@
     m_userActivityHysteresis.impulse();
 
+    PlatformKeyboardEvent::setCurrentModifierState(platform(keyboardEvent).modifiers());
+
     CurrentEvent currentEvent(keyboardEvent);
 
@@ -6312 +6314 @@
 #endif // ENABLE(APPLICATION_MANIFEST)
 
+void WebPage::updateCurrentModifierState(OptionSet<PlatformEvent::Modifier> modifiers)
+{
+    PlatformKeyboardEvent::setCurrentModifierState(modifiers);
+}    
+
 } // namespace WebKit
 

trunk/Source/WebKit/WebProcess/WebPage/WebPage.h

@@ -1092 +1092 @@
 #endif
 
+    void updateCurrentModifierState(OptionSet<WebCore::PlatformEvent::Modifier> modifiers);
+
     UserContentControllerIdentifier userContentControllerIdentifier() const { return m_userContentController->identifier(); }
 

trunk/Source/WebKit/WebProcess/WebPage/WebPage.messages.in

@@ -528 +528 @@
 
     SetDefersLoading(bool defersLoading)
+
+    UpdateCurrentModifierState(OptionSet<WebCore::PlatformEvent::Modifier> modifiers)
 }

trunk/Tools/ChangeLog

@@ +1 @@
+2018-11-06  Per Arne Vollan  <pvollan@apple.com>
+
+        REGRESSION (r230523): Caps lock indicator not shown in password field
+        https://bugs.webkit.org/show_bug.cgi?id=190056
+
+        Reviewed by Ryosuke Niwa.
+
+        * WebKitTestRunner/InjectedBundle/Bindings/TestRunner.idl:
+        * WebKitTestRunner/InjectedBundle/TestRunner.cpp:
+        (WTR::TestRunner::toggleCapsLock):
+        * WebKitTestRunner/InjectedBundle/TestRunner.h:
+        * WebKitTestRunner/TestController.h:
+        * WebKitTestRunner/TestInvocation.cpp:
+        (WTR::TestInvocation::didReceiveSynchronousMessageFromInjectedBundle):
+        * WebKitTestRunner/cocoa/TestControllerCocoa.mm:
+        (WTR::TestController::toggleCapsLock):
+
 2018-11-06  Sihui Liu  <sihui_liu@apple.com>
 

trunk/Tools/WebKitTestRunner/InjectedBundle/Bindings/TestRunner.idl

@@ -360 +360 @@
     void cleanUpKeychain(DOMString attrLabel);
     boolean keyExistsInKeychain(DOMString attrLabel, DOMString applicationTagBase64);
+
+    void toggleCapsLock();
 };

trunk/Tools/WebKitTestRunner/InjectedBundle/TestRunner.cpp

@@ -2514 +2514 @@
 }
 
+void TestRunner::toggleCapsLock()
+{
+    WKRetainPtr<WKStringRef> messageName(AdoptWK, WKStringCreateWithUTF8CString("ToggleCapsLock"));
+    WKBundlePostSynchronousMessage(InjectedBundle::singleton().bundle(), messageName.get(), nullptr, nullptr);
+}
+
 } // namespace WTR

trunk/Tools/WebKitTestRunner/InjectedBundle/TestRunner.h

@@ -478 +478 @@
     bool keyExistsInKeychain(JSStringRef attrLabel, JSStringRef applicationTagBase64);
 
+    void toggleCapsLock();
+
 private:
     TestRunner();

trunk/Tools/WebKitTestRunner/TestController.h

@@ -261 +261 @@
     bool keyExistsInKeychain(const String& attrLabel, const String& applicationTagBase64);
 
+    void toggleCapsLock();
+
 private:
     WKRetainPtr<WKPageConfigurationRef> generatePageConfiguration(WKContextConfigurationRef);
@@ -489 +491 @@
     bool m_didReceiveServerRedirectForProvisionalNavigation { false };
 
+    bool m_capsLockOn { false };
+
     WKRetainPtr<WKArrayRef> m_openPanelFileURLs;
 

trunk/Tools/WebKitTestRunner/TestInvocation.cpp

@@ -1504 +1504 @@
     }
 
+#if PLATFORM(MAC)
+    if (WKStringIsEqualToUTF8CString(messageName, "ToggleCapsLock")) {
+        TestController::singleton().toggleCapsLock();
+        return nullptr;
+    }
+#endif
+
     ASSERT_NOT_REACHED();
     return nullptr;

trunk/Tools/WebKitTestRunner/cocoa/TestControllerCocoa.mm

@@ -352 +352 @@
 }
 
+#if PLATFORM(MAC)
+void TestController::toggleCapsLock()
+{
+    m_capsLockOn = !m_capsLockOn;
+    NSEvent *fakeEvent = [NSEvent keyEventWithType:NSEventTypeFlagsChanged
+        location:NSZeroPoint
+        modifierFlags:m_capsLockOn ? NSEventModifierFlagCapsLock : 0
+        timestamp:0
+        windowNumber:[mainWebView()->platformWindow() windowNumber]
+        context:nullptr
+        characters:@""
+        charactersIgnoringModifiers:@""
+        isARepeat:NO
+        keyCode:57];
+    
+    [mainWebView()->platformWindow() sendEvent:fakeEvent];
+}
+#endif
+
 } // namespace WTR