Changeset 223451 in webkit

Timestamp:

Oct 16, 2017 5:30:24 PM (7 years ago)

Author:

mrajca@apple.com

Message:

Add API support for quirk that lets an arbitrary click allow auto-play.
​https://bugs.webkit.org/show_bug.cgi?id=178227

Reviewed by Alex Christensen.

Source/WebCore:

Added API test.

Instead of hardcoding sites in WebCore, let API clients control which websites opt into the quirk that lets
an arbitrary click allow auto-play via website policies.

• html/MediaElementSession.cpp:

(WebCore::needsArbitraryUserGestureAutoplayQuirk):

• loader/DocumentLoader.h:

Source/WebKit:

Instead of hardcoding sites in WebCore, let API clients control which websites opt into the quirk that lets
an arbitrary click allow auto-play via website policies.

• Shared/WebsitePolicies.h:
• UIProcess/API/C/WKWebsitePolicies.cpp:

(WKWebsitePoliciesSetAllowedAutoplayQuirks):
(WKWebsitePoliciesGetAllowedAutoplayQuirks):

• UIProcess/API/C/WKWebsitePolicies.h:
• UIProcess/API/Cocoa/_WKWebsitePolicies.h:
• UIProcess/API/Cocoa/_WKWebsitePolicies.mm:

(-[_WKWebsitePolicies setAllowedAutoplayQuirks:]):
(-[_WKWebsitePolicies allowedAutoplayQuirks]):

• WebProcess/WebCoreSupport/WebFrameLoaderClient.cpp:

(WebKit::WebFrameLoaderClient::applyToDocumentLoader):

• WebProcess/WebPage/WebPage.cpp:

(WebKit::WebPage::updateWebsitePolicies):

Tools:

• TestWebKitAPI/Tests/WebKitCocoa/WebsitePolicies.mm:

(TEST): Added API test.

Location:

trunk

Files:

• Source/WebCore/ChangeLog (modified) (1 diff)
• Source/WebCore/html/MediaElementSession.cpp (modified) (2 diffs)
• Source/WebCore/loader/DocumentLoader.h (modified) (1 diff)
• Source/WebKit/ChangeLog (modified) (1 diff)
• Source/WebKit/Shared/WebsitePolicies.h (modified) (1 diff)
• Source/WebKit/UIProcess/API/C/WKWebsitePolicies.cpp (modified) (2 diffs)
• Source/WebKit/UIProcess/API/C/WKWebsitePolicies.h (modified) (1 diff)
• Source/WebKit/UIProcess/API/Cocoa/_WKWebsitePolicies.h (modified) (1 diff)
• Source/WebKit/UIProcess/API/Cocoa/_WKWebsitePolicies.mm (modified) (2 diffs)
• Source/WebKit/WebProcess/WebCoreSupport/WebFrameLoaderClient.cpp (modified) (1 diff)
• Source/WebKit/WebProcess/WebPage/WebPage.cpp (modified) (1 diff)
• Tools/ChangeLog (modified) (1 diff)
• Tools/TestWebKitAPI/Tests/WebKitCocoa/WebsitePolicies.mm (modified) (1 diff)

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2017-10-12  Matt Rajca  <mrajca@apple.com>
+
+        Add API support for quirk that lets an arbitrary click allow auto-play.
+        https://bugs.webkit.org/show_bug.cgi?id=178227
+
+        Reviewed by Alex Christensen.
+
+        Added API test.
+        
+        Instead of hardcoding sites in WebCore, let API clients control which websites opt into the quirk that lets
+        an arbitrary click allow auto-play via website policies.
+
+        * html/MediaElementSession.cpp:
+        (WebCore::needsArbitraryUserGestureAutoplayQuirk):
+        * loader/DocumentLoader.h:
+
 2017-10-16  Chris Dumez  <cdumez@apple.com>
 

trunk/Source/WebCore/html/MediaElementSession.cpp

@@ -31 +31 @@
 
 #include "Document.h"
+#include "DocumentLoader.h"
 #include "Frame.h"
 #include "FrameView.h"
@@ -155 +156 @@
         return false;
 
-    auto host = document.url().host();
-    return equalLettersIgnoringASCIICase(host, "washingtonpost.com") || host.endsWithIgnoringASCIICase(".washingtonpost.com");
+    auto* loader = document.loader();
+    return loader && loader->allowedAutoplayQuirks().contains(AutoplayQuirk::ArbitraryUserGestures);
 }
 #endif // PLATFORM(MAC)

trunk/Source/WebCore/loader/DocumentLoader.h

@@ -91 +91 @@
     SynthesizedPauseEvents = 1 << 0,
     InheritedUserGestures = 1 << 1,
+    ArbitraryUserGestures = 1 << 2,
 };
 

trunk/Source/WebKit/ChangeLog

@@ +1 @@
+2017-10-12  Matt Rajca  <mrajca@apple.com>
+
+        Add API support for quirk that lets an arbitrary click allow auto-play.
+        https://bugs.webkit.org/show_bug.cgi?id=178227
+
+        Reviewed by Alex Christensen.
+
+        Instead of hardcoding sites in WebCore, let API clients control which websites opt into the quirk that lets
+        an arbitrary click allow auto-play via website policies.
+
+        * Shared/WebsitePolicies.h:
+        * UIProcess/API/C/WKWebsitePolicies.cpp:
+        (WKWebsitePoliciesSetAllowedAutoplayQuirks):
+        (WKWebsitePoliciesGetAllowedAutoplayQuirks):
+        * UIProcess/API/C/WKWebsitePolicies.h:
+        * UIProcess/API/Cocoa/_WKWebsitePolicies.h:
+        * UIProcess/API/Cocoa/_WKWebsitePolicies.mm:
+        (-[_WKWebsitePolicies setAllowedAutoplayQuirks:]):
+        (-[_WKWebsitePolicies allowedAutoplayQuirks]):
+        * WebProcess/WebCoreSupport/WebFrameLoaderClient.cpp:
+        (WebKit::WebFrameLoaderClient::applyToDocumentLoader):
+        * WebProcess/WebPage/WebPage.cpp:
+        (WebKit::WebPage::updateWebsitePolicies):
+
 2017-10-16  Andy Estes  <aestes@apple.com>
 

trunk/Source/WebKit/Shared/WebsitePolicies.h

@@ -44 +44 @@
     SynthesizedPauseEvents = 1 << 0,
     InheritedUserGestures = 1 << 1,
+    ArbitraryUserGestures = 1 << 2,
 };
 

trunk/Source/WebKit/UIProcess/API/C/WKWebsitePolicies.cpp

@@ -89 +89 @@
         quirks |= WebsiteAutoplayQuirk::SynthesizedPauseEvents;
 
+    if (allowedQuirks & kWKWebsiteAutoplayQuirkArbitraryUserGestures)
+        quirks |= WebsiteAutoplayQuirk::ArbitraryUserGestures;
+
     toImpl(websitePolicies)->setAllowedAutoplayQuirks(quirks);
 }
@@ -102 +105 @@
     if (allowedQuirks.contains(WebsiteAutoplayQuirk::InheritedUserGestures))
         quirks |= kWKWebsiteAutoplayQuirkInheritedUserGestures;
+
+    if (allowedQuirks.contains(WebsiteAutoplayQuirk::ArbitraryUserGestures))
+        quirks |= kWKWebsiteAutoplayQuirkArbitraryUserGestures;
 
     return quirks;

trunk/Source/WebKit/UIProcess/API/C/WKWebsitePolicies.h

@@ -45 +45 @@
     kWKWebsiteAutoplayQuirkSynthesizedPauseEvents = 1 << 0,
     kWKWebsiteAutoplayQuirkInheritedUserGestures = 1 << 1,
+    kWKWebsiteAutoplayQuirkArbitraryUserGestures = 1 << 2,
 };
 

trunk/Source/WebKit/UIProcess/API/Cocoa/_WKWebsitePolicies.h

@@ -38 +38 @@
     _WKWebsiteAutoplayQuirkSynthesizedPauseEvents = 1 << 0,
     _WKWebsiteAutoplayQuirkInheritedUserGestures = 1 << 1,
+    _WKWebsiteAutoplayQuirkArbitraryUserGestures = 1 << 2,
 } WK_API_AVAILABLE(macosx(10.13), ios(11.0));
 

trunk/Source/WebKit/UIProcess/API/Cocoa/_WKWebsitePolicies.mm

@@ -68 +68 @@
         quirks |= WebKit::WebsiteAutoplayQuirk::SynthesizedPauseEvents;
 
+    if (allowedQuirks & _WKWebsiteAutoplayQuirkArbitraryUserGestures)
+        quirks |= WebKit::WebsiteAutoplayQuirk::ArbitraryUserGestures;
+
     _websitePolicies->setAllowedAutoplayQuirks(quirks);
 }
@@ -81 +84 @@
     if (allowedQuirks.contains(WebKit::WebsiteAutoplayQuirk::SynthesizedPauseEvents))
         quirks |= _WKWebsiteAutoplayQuirkSynthesizedPauseEvents;
+
+    if (allowedQuirks.contains(WebKit::WebsiteAutoplayQuirk::ArbitraryUserGestures))
+        quirks |= _WKWebsiteAutoplayQuirkArbitraryUserGestures;
 
     return quirks;

trunk/Source/WebKit/WebProcess/WebCoreSupport/WebFrameLoaderClient.cpp

@@ -782 +782 @@
         quirks |= AutoplayQuirk::SynthesizedPauseEvents;
 
+    if (allowedQuirks.contains(WebsiteAutoplayQuirk::ArbitraryUserGestures))
+        quirks |= AutoplayQuirk::ArbitraryUserGestures;
+
     documentLoader->setAllowedAutoplayQuirks(quirks);
 

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

@@ -5699 +5699 @@
         quirks |= AutoplayQuirk::SynthesizedPauseEvents;
 
+    if (allowedQuirks.contains(WebsiteAutoplayQuirk::ArbitraryUserGestures))
+        quirks |= AutoplayQuirk::ArbitraryUserGestures;
+
     documentLoader->setAllowedAutoplayQuirks(quirks);
 

trunk/Tools/ChangeLog

@@ +1 @@
+2017-10-12  Matt Rajca  <mrajca@apple.com>
+
+        Add API support for quirk that lets an arbitrary click allow auto-play.
+        https://bugs.webkit.org/show_bug.cgi?id=178227
+
+        Reviewed by Alex Christensen.
+
+        * TestWebKitAPI/Tests/WebKitCocoa/WebsitePolicies.mm:
+        (TEST): Added API test.
+
 2017-10-16  Maureen Daum  <mdaum@apple.com>
 

trunk/Tools/TestWebKitAPI/Tests/WebKitCocoa/WebsitePolicies.mm

@@ -565 +565 @@
     [webView stringByEvaluatingJavaScript:@"playVideo()"];
     runUntilReceivesAutoplayEvent(kWKAutoplayEventDidPreventFromAutoplaying);
+}
+
+TEST(WebKit, WebsitePoliciesArbitraryUserGestureQuirk)
+{
+    auto configuration = adoptNS([[WKWebViewConfiguration alloc] init]);
+    auto webView = adoptNS([[TestWKWebView alloc] initWithFrame:NSMakeRect(0, 0, 800, 600) configuration:configuration.get()]);
+
+    auto delegate = adoptNS([[AutoplayPoliciesDelegate alloc] init]);
+    [webView setNavigationDelegate:delegate.get()];
+
+    WKRetainPtr<WKPreferencesRef> preferences(AdoptWK, WKPreferencesCreate());
+    WKPreferencesSetNeedsSiteSpecificQuirks(preferences.get(), true);
+    WKPageGroupSetPreferences(WKPageGetPageGroup([webView _pageForTesting]), preferences.get());
+
+    [delegate setAllowedAutoplayQuirksForURL:^_WKWebsiteAutoplayQuirk(NSURL *url)
+    {
+        return _WKWebsiteAutoplayQuirkArbitraryUserGestures;
+    }];
+    [delegate setAutoplayPolicyForURL:^(NSURL *)
+    {
+        return _WKWebsiteAutoplayPolicyDeny;
+    }];
+
+    NSURLRequest *request = [NSURLRequest requestWithURL:[[NSBundle mainBundle] URLForResource:@"autoplay-check" withExtension:@"html" subdirectory:@"TestWebKitAPI.resources"]];
+    [webView loadRequest:request];
+    [webView waitForMessage:@"did-not-play"];
+
+    const NSPoint clickPoint = NSMakePoint(760, 560);
+    [webView mouseDownAtPoint:clickPoint simulatePressure:NO];
+    [webView mouseUpAtPoint:clickPoint];
+
+    [webView stringByEvaluatingJavaScript:@"playVideo()"];
+    [webView waitForMessage:@"autoplayed"];
 }