/* * Copyright (C) 2019 Apple Inc. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF * THE POSSIBILITY OF SUCH DAMAGE. */ #import "config.h" #if PLATFORM(IOS_FAMILY) #import "PlatformUtilities.h" #import "TestNavigationDelegate.h" #import "TestURLSchemeHandler.h" #import "TestWKWebView.h" #import #import #import #import #import #import #import static RetainPtr receivedMessages = adoptNS([@[] mutableCopy]); static bool didReceiveMessage; static bool askedClientForPermission; @interface DeviceOrientationMessageHandler : NSObject @end @implementation DeviceOrientationMessageHandler - (void)userContentController:(WKUserContentController *)userContentController didReceiveScriptMessage:(WKScriptMessage *)message { if ([message body]) [receivedMessages addObject:[message body]]; else [receivedMessages addObject:@""]; didReceiveMessage = true; } @end @interface DeviceOrientationPermissionUIDelegate : NSObject { } - (instancetype)initWithHandler:(Function&&)decisionHandler; @end @implementation DeviceOrientationPermissionUIDelegate { Function _decisionHandler; } - (instancetype)initWithHandler:(Function&&)decisionHandler { self = [super init]; _decisionHandler = WTFMove(decisionHandler); return self; } - (void)_webView:(WKWebView *)webView shouldAllowDeviceOrientationAndMotionAccessRequestedByFrame:(WKFrameInfo *)requestingFrame decisionHandler:(void (^)(BOOL))decisionHandler { decisionHandler(_decisionHandler()); askedClientForPermission = true; } @end enum class DeviceOrientationPermission { Granted, Denied, Default }; static void runDeviceOrientationTest(DeviceOrientationPermission deviceOrientationPermission) { auto configuration = adoptNS([[WKWebViewConfiguration alloc] init]); auto messageHandler = adoptNS([[DeviceOrientationMessageHandler alloc] init]); [[configuration userContentController] addScriptMessageHandler:messageHandler.get() name:@"testHandler"]; auto webView = adoptNS([[TestWKWebView alloc] initWithFrame:NSMakeRect(0, 0, 800, 600) configuration:configuration.get()]); RetainPtr uiDelegate; switch (deviceOrientationPermission) { case DeviceOrientationPermission::Granted: uiDelegate = adoptNS([[DeviceOrientationPermissionUIDelegate alloc] initWithHandler:[] { return true; }]); break; case DeviceOrientationPermission::Denied: uiDelegate = adoptNS([[DeviceOrientationPermissionUIDelegate alloc] initWithHandler:[] { return false; }]); break; case DeviceOrientationPermission::Default: break; } [webView setUIDelegate:uiDelegate.get()]; NSURLRequest *request = [NSURLRequest requestWithURL:[[NSBundle mainBundle] URLForResource:@"simple" withExtension:@"html" subdirectory:@"TestWebKitAPI.resources"]]; [webView loadRequest:request]; [webView _test_waitForDidFinishNavigation]; [webView evaluateJavaScript:@"DeviceOrientationEvent.requestPermission().then((granted) => { webkit.messageHandlers.testHandler.postMessage(granted) });" completionHandler: [&] (id result, NSError *error) { }]; TestWebKitAPI::Util::run(&didReceiveMessage); didReceiveMessage = false; switch (deviceOrientationPermission) { case DeviceOrientationPermission::Granted: EXPECT_WK_STREQ(@"granted", receivedMessages.get()[0]); break; case DeviceOrientationPermission::Denied: case DeviceOrientationPermission::Default: EXPECT_WK_STREQ(@"denied", receivedMessages.get()[0]); break; } bool addedEventListener = false; [webView evaluateJavaScript:@"addEventListener('deviceorientation', (e) => { webkit.messageHandlers.testHandler.postMessage('received-event') });" completionHandler: [&] (id result, NSError *error) { addedEventListener = true; }]; TestWebKitAPI::Util::run(&addedEventListener); addedEventListener = false; [webView _simulateDeviceOrientationChangeWithAlpha:1.0 beta:2.0 gamma:3.0]; if (deviceOrientationPermission == DeviceOrientationPermission::Granted) { TestWebKitAPI::Util::run(&didReceiveMessage); EXPECT_WK_STREQ(@"received-event", receivedMessages.get()[1]); } else { TestWebKitAPI::Util::sleep(0.1); EXPECT_FALSE(didReceiveMessage); } didReceiveMessage = false; } TEST(DeviceOrientation, PermissionDeniedByDefault) { runDeviceOrientationTest(DeviceOrientationPermission::Default); } TEST(DeviceOrientation, PermissionGranted) { runDeviceOrientationTest(DeviceOrientationPermission::Granted); } TEST(DeviceOrientation, PermissionDenied) { runDeviceOrientationTest(DeviceOrientationPermission::Denied); } TEST(DeviceOrientation, RememberPermissionForSession) { auto configuration = adoptNS([[WKWebViewConfiguration alloc] init]); configuration.get().websiteDataStore = [WKWebsiteDataStore defaultDataStore]; auto messageHandler = adoptNS([[DeviceOrientationMessageHandler alloc] init]); [[configuration userContentController] addScriptMessageHandler:messageHandler.get() name:@"testHandler"]; auto webView = adoptNS([[TestWKWebView alloc] initWithFrame:NSMakeRect(0, 0, 800, 600) configuration:configuration.get()]); RetainPtr uiDelegate = adoptNS([[DeviceOrientationPermissionUIDelegate alloc] initWithHandler:[] { return true; }]); [webView setUIDelegate:uiDelegate.get()]; NSURLRequest *request = [NSURLRequest requestWithURL:[[NSBundle mainBundle] URLForResource:@"simple" withExtension:@"html" subdirectory:@"TestWebKitAPI.resources"]]; [webView loadRequest:request]; [webView _test_waitForDidFinishNavigation]; [webView evaluateJavaScript:@"DeviceOrientationEvent.requestPermission().then((granted) => { webkit.messageHandlers.testHandler.postMessage(granted) });" completionHandler: [&] (id result, NSError *error) { }]; TestWebKitAPI::Util::run(&didReceiveMessage); didReceiveMessage = false; EXPECT_TRUE(askedClientForPermission); askedClientForPermission = false; EXPECT_WK_STREQ(@"granted", receivedMessages.get()[0]); // Load the same origin again in a new WebView, it should not ask the client. webView = adoptNS([[TestWKWebView alloc] initWithFrame:NSMakeRect(0, 0, 800, 600) configuration:configuration.get()]); [webView setUIDelegate:uiDelegate.get()]; [webView loadRequest:request]; [webView _test_waitForDidFinishNavigation]; [webView _evaluateJavaScriptWithoutUserGesture:@"DeviceOrientationEvent.requestPermission().then((granted) => { webkit.messageHandlers.testHandler.postMessage(granted) }, (error) => { webkit.messageHandlers.testHandler.postMessage('error'); });" completionHandler: [&] (id result, NSError *error) { }]; TestWebKitAPI::Util::run(&didReceiveMessage); didReceiveMessage = false; EXPECT_WK_STREQ(@"granted", receivedMessages.get()[1]); EXPECT_FALSE(askedClientForPermission); askedClientForPermission = false; // Load the same origin again in a new WebView but this time with a different data store, it should ask the client again. configuration = adoptNS([[WKWebViewConfiguration alloc] init]); configuration.get().websiteDataStore = [WKWebsiteDataStore nonPersistentDataStore]; [[configuration userContentController] addScriptMessageHandler:messageHandler.get() name:@"testHandler"]; auto preferences = [configuration preferences]; [preferences _setSecureContextChecksEnabled: NO]; webView = adoptNS([[TestWKWebView alloc] initWithFrame:NSMakeRect(0, 0, 800, 600) configuration:configuration.get()]); [webView setUIDelegate:uiDelegate.get()]; [webView loadRequest:request]; [webView _test_waitForDidFinishNavigation]; [webView evaluateJavaScript:@"DeviceOrientationEvent.requestPermission().then((granted) => { webkit.messageHandlers.testHandler.postMessage(granted) });" completionHandler: [&] (id result, NSError *error) { }]; TestWebKitAPI::Util::run(&didReceiveMessage); didReceiveMessage = false; EXPECT_TRUE(askedClientForPermission); askedClientForPermission = false; EXPECT_WK_STREQ(@"granted", receivedMessages.get()[2]); // Now go to a different origin, it should ask the client again. NSURLRequest *request2 = [NSURLRequest requestWithURL:[NSURL URLWithString:@"about:blank"]]; [webView loadRequest:request2]; [webView _test_waitForDidFinishNavigation]; [webView evaluateJavaScript:@"DeviceOrientationEvent.requestPermission().then((granted) => { webkit.messageHandlers.testHandler.postMessage(granted) });" completionHandler: [&] (id result, NSError *error) { }]; TestWebKitAPI::Util::run(&didReceiveMessage); didReceiveMessage = false; EXPECT_TRUE(askedClientForPermission); askedClientForPermission = false; EXPECT_WK_STREQ(@"granted", receivedMessages.get()[3]); // Go back to the first origin in a new WebView (same data store) and make sure it does not ask the client. webView = adoptNS([[TestWKWebView alloc] initWithFrame:NSMakeRect(0, 0, 800, 600) configuration:configuration.get()]); [webView setUIDelegate:uiDelegate.get()]; [webView loadRequest:request]; [webView _test_waitForDidFinishNavigation]; [webView _evaluateJavaScriptWithoutUserGesture:@"DeviceOrientationEvent.requestPermission().then((granted) => { webkit.messageHandlers.testHandler.postMessage(granted) }, (error) => { webkit.messageHandlers.testHandler.postMessage('error'); });" completionHandler: [&] (id result, NSError *error) { }]; TestWebKitAPI::Util::run(&didReceiveMessage); didReceiveMessage = false; EXPECT_WK_STREQ(@"granted", receivedMessages.get()[4]); EXPECT_FALSE(askedClientForPermission); askedClientForPermission = false; } TEST(DeviceOrientation, FireOrientationEventsRightAwayIfPermissionAlreadyGranted) { auto configuration = adoptNS([[WKWebViewConfiguration alloc] init]); configuration.get().websiteDataStore = [WKWebsiteDataStore defaultDataStore]; auto messageHandler = adoptNS([[DeviceOrientationMessageHandler alloc] init]); [[configuration userContentController] addScriptMessageHandler:messageHandler.get() name:@"testHandler"]; auto webView = adoptNS([[TestWKWebView alloc] initWithFrame:NSMakeRect(0, 0, 800, 600) configuration:configuration.get()]); RetainPtr uiDelegate = adoptNS([[DeviceOrientationPermissionUIDelegate alloc] initWithHandler:[] { return true; }]); [webView setUIDelegate:uiDelegate.get()]; NSURLRequest *request = [NSURLRequest requestWithURL:[[NSBundle mainBundle] URLForResource:@"simple" withExtension:@"html" subdirectory:@"TestWebKitAPI.resources"]]; [webView loadRequest:request]; [webView _test_waitForDidFinishNavigation]; // Request permission. [webView evaluateJavaScript:@"DeviceOrientationEvent.requestPermission().then((granted) => { webkit.messageHandlers.testHandler.postMessage(granted) });" completionHandler: [&] (id result, NSError *error) { }]; TestWebKitAPI::Util::run(&didReceiveMessage); didReceiveMessage = false; EXPECT_TRUE(askedClientForPermission); askedClientForPermission = false; EXPECT_WK_STREQ(@"granted", receivedMessages.get()[0]); // Go to the same origin again in a new view. webView = adoptNS([[TestWKWebView alloc] initWithFrame:NSMakeRect(0, 0, 800, 600) configuration:configuration.get()]); [webView setUIDelegate:uiDelegate.get()]; [webView loadRequest:request]; [webView _test_waitForDidFinishNavigation]; // This time, we do not request permission but set our event listener. bool addedEventListener = false; [webView evaluateJavaScript:@"addEventListener('deviceorientation', (e) => { webkit.messageHandlers.testHandler.postMessage('received-event') });" completionHandler: [&] (id result, NSError *error) { addedEventListener = true; }]; TestWebKitAPI::Util::run(&addedEventListener); addedEventListener = false; // Simulate a device orientation event. The page's event listener should get called even though it did not request permission, // because it was previously granted permission during this browsing session. [webView _simulateDeviceOrientationChangeWithAlpha:1.0 beta:2.0 gamma:3.0]; TestWebKitAPI::Util::run(&didReceiveMessage); EXPECT_WK_STREQ(@"received-event", receivedMessages.get()[1]); } static const char* mainBytes = R"TESTRESOURCE( )TESTRESOURCE"; enum class ShouldEnableSecureContextChecks { No, Yes }; static void runPermissionSecureContextCheckTest(ShouldEnableSecureContextChecks shouldEnableSecureContextChecks) { auto configuration = adoptNS([[WKWebViewConfiguration alloc] init]); configuration.get().websiteDataStore = [WKWebsiteDataStore defaultDataStore]; auto preferences = [configuration preferences]; [preferences _setSecureContextChecksEnabled:shouldEnableSecureContextChecks == ShouldEnableSecureContextChecks::Yes ? YES : NO]; auto messageHandler = adoptNS([[DeviceOrientationMessageHandler alloc] init]); [[configuration userContentController] addScriptMessageHandler:messageHandler.get() name:@"testHandler"]; auto schemeHandler = adoptNS([[TestURLSchemeHandler alloc] init]); [configuration setURLSchemeHandler:schemeHandler.get() forURLScheme:@"test"]; [schemeHandler setStartURLSchemeTaskHandler:^(WKWebView *, id task) { auto response = adoptNS([[NSURLResponse alloc] initWithURL:task.request.URL MIMEType:@"text/html" expectedContentLength:0 textEncodingName:nil]); [task didReceiveResponse:response.get()]; [task didReceiveData:[NSData dataWithBytes:mainBytes length:strlen(mainBytes)]]; [task didFinish]; }]; auto webView = adoptNS([[TestWKWebView alloc] initWithFrame:NSMakeRect(0, 0, 800, 600) configuration:configuration.get()]); RetainPtr uiDelegate = adoptNS([[DeviceOrientationPermissionUIDelegate alloc] initWithHandler:[] { return true; }]); [webView setUIDelegate:uiDelegate.get()]; NSURLRequest *request = [NSURLRequest requestWithURL:[NSURL URLWithString:@"test://host/main.html"]]; [webView loadRequest:request]; [webView _test_waitForDidFinishNavigation]; [webView evaluateJavaScript:@"requestPermission();" completionHandler:nil]; TestWebKitAPI::Util::run(&didReceiveMessage); didReceiveMessage = false; if (shouldEnableSecureContextChecks == ShouldEnableSecureContextChecks::Yes) { EXPECT_WK_STREQ(@"denied", receivedMessages.get()[0]); return; } EXPECT_WK_STREQ(@"granted", receivedMessages.get()[0]); bool addedEventListener = false; [webView evaluateJavaScript:@"addEventListener('deviceorientation', (e) => { webkit.messageHandlers.testHandler.postMessage('received-event') });" completionHandler: [&] (id result, NSError *error) { addedEventListener = true; }]; TestWebKitAPI::Util::run(&addedEventListener); addedEventListener = false; // Simulate a device orientation event. The page's event listener should get called even though it did not request permission, // because it was previously granted permission during this browsing session. [webView _simulateDeviceOrientationChangeWithAlpha:1.0 beta:2.0 gamma:3.0]; TestWebKitAPI::Util::run(&didReceiveMessage); EXPECT_WK_STREQ(@"received-event", receivedMessages.get()[1]); } TEST(DeviceOrientation, PermissionSecureContextCheck) { runPermissionSecureContextCheckTest(ShouldEnableSecureContextChecks::Yes); } TEST(DeviceOrientation, PermissionSecureContextCheckDisabled) { runPermissionSecureContextCheckTest(ShouldEnableSecureContextChecks::No); } #endif // PLATFORM(IOS_FAMILY)