Changeset 225989 in webkit

Timestamp:

Dec 15, 2017, 3:14:33 PM (7 years ago)

Author:

achristensen@apple.com

Message:

Introduce SPI _WKWebsitePolicies.websiteDataStore
​https://bugs.webkit.org/show_bug.cgi?id=180880
<rdar://problem/35535328>

Reviewed by Andy Estes.

Source/WebKit:

The SPI doesn't do anything yet, but it already has some restrictions and tests!
WKWebView._updateWebsitePolicies can't be used to update a WKWebsiteDataStore. Only during navigation.
Even during navigation, we are only supporting the default and ephemeral data stores right now.
This functionality won't be supported in the C API. This is enforced with RELEASE_ASSERTs.
If we change our minds, we can change them and add restrictions similar to the ObjC restrictions.

• Shared/WebsitePoliciesData.cpp:

(WebKit::WebsitePoliciesData::encode const):
(WebKit::WebsitePoliciesData::decode):

• Shared/WebsitePoliciesData.h:
• UIProcess/API/APIWebsitePolicies.cpp:

(API::WebsitePolicies::WebsitePolicies):
(API::WebsitePolicies::setWebsiteDataStore):
(API::WebsitePolicies::data):

• UIProcess/API/APIWebsitePolicies.h:
• UIProcess/API/C/WKFramePolicyListener.cpp:

(WKFramePolicyListenerUseWithPolicies):

• UIProcess/API/C/WKPage.cpp:

(WKPageUpdateWebsitePolicies):

• UIProcess/API/Cocoa/WKWebView.mm:

(-[WKWebView _updateWebsitePolicies:]):

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

(-[_WKWebsitePolicies websiteDataStore]):
(-[_WKWebsitePolicies setWebsiteDataStore:]):

• UIProcess/Cocoa/NavigationState.mm:

(WebKit::NavigationState::NavigationClient::decidePolicyForNavigationAction):

Tools:

• TestWebKitAPI/Tests/WebKitCocoa/WebsitePolicies.mm:

(-[WebsitePoliciesWebsiteDataStoreDelegate _webView:decidePolicyForNavigationAction:decisionHandler:]):
(-[WebsitePoliciesWebsiteDataStoreDelegate webView:startURLSchemeTask:]):
(-[WebsitePoliciesWebsiteDataStoreDelegate webView:stopURLSchemeTask:]):
(TEST):

Location:

trunk

Files:

• Source/WebKit/ChangeLog (modified) (1 diff)
• Source/WebKit/Shared/WebsitePoliciesData.cpp (modified) (3 diffs)
• Source/WebKit/Shared/WebsitePoliciesData.h (modified) (2 diffs)
• Source/WebKit/UIProcess/API/APIWebsitePolicies.cpp (modified) (2 diffs)
• Source/WebKit/UIProcess/API/APIWebsitePolicies.h (modified) (3 diffs)
• Source/WebKit/UIProcess/API/C/WKFramePolicyListener.cpp (modified) (1 diff)
• Source/WebKit/UIProcess/API/C/WKPage.cpp (modified) (1 diff)
• Source/WebKit/UIProcess/API/Cocoa/WKWebView.mm (modified) (1 diff)
• Source/WebKit/UIProcess/API/Cocoa/_WKWebsitePolicies.h (modified) (2 diffs)
• Source/WebKit/UIProcess/API/Cocoa/_WKWebsitePolicies.mm (modified) (1 diff)
• Source/WebKit/UIProcess/Cocoa/NavigationState.mm (modified) (1 diff)
• Tools/ChangeLog (modified) (1 diff)
• Tools/TestWebKitAPI/Tests/WebKitCocoa/WebsitePolicies.mm (modified) (2 diffs)

trunk/Source/WebKit/ChangeLog

@@ +1 @@
+2017-12-15  Alex Christensen  <achristensen@webkit.org>
+
+        Introduce SPI _WKWebsitePolicies.websiteDataStore
+        https://bugs.webkit.org/show_bug.cgi?id=180880
+        <rdar://problem/35535328>
+
+        Reviewed by Andy Estes.
+
+        The SPI doesn't do anything yet, but it already has some restrictions and tests!
+        WKWebView._updateWebsitePolicies can't be used to update a WKWebsiteDataStore.  Only during navigation.
+        Even during navigation, we are only supporting the default and ephemeral data stores right now.
+        This functionality won't be supported in the C API.  This is enforced with RELEASE_ASSERTs.
+        If we change our minds, we can change them and add restrictions similar to the ObjC restrictions.
+
+        * Shared/WebsitePoliciesData.cpp:
+        (WebKit::WebsitePoliciesData::encode const):
+        (WebKit::WebsitePoliciesData::decode):
+        * Shared/WebsitePoliciesData.h:
+        * UIProcess/API/APIWebsitePolicies.cpp:
+        (API::WebsitePolicies::WebsitePolicies):
+        (API::WebsitePolicies::setWebsiteDataStore):
+        (API::WebsitePolicies::data):
+        * UIProcess/API/APIWebsitePolicies.h:
+        * UIProcess/API/C/WKFramePolicyListener.cpp:
+        (WKFramePolicyListenerUseWithPolicies):
+        * UIProcess/API/C/WKPage.cpp:
+        (WKPageUpdateWebsitePolicies):
+        * UIProcess/API/Cocoa/WKWebView.mm:
+        (-[WKWebView _updateWebsitePolicies:]):
+        * UIProcess/API/Cocoa/_WKWebsitePolicies.h:
+        * UIProcess/API/Cocoa/_WKWebsitePolicies.mm:
+        (-[_WKWebsitePolicies websiteDataStore]):
+        (-[_WKWebsitePolicies setWebsiteDataStore:]):
+        * UIProcess/Cocoa/NavigationState.mm:
+        (WebKit::NavigationState::NavigationClient::decidePolicyForNavigationAction):
+
 2017-12-15  Alex Christensen  <achristensen@webkit.org>
 

trunk/Source/WebKit/Shared/WebsitePoliciesData.cpp

@@ -38 +38 @@
     encoder << allowedAutoplayQuirks;
     encoder << customHeaderFields;
+    encoder << websiteDataStoreParameters;
 }
 
@@ -62 +63 @@
         return std::nullopt;
     
+    std::optional<std::optional<WebsiteDataStoreParameters>> websiteDataStoreParameters;
+    decoder >> websiteDataStoreParameters;
+    if (!websiteDataStoreParameters)
+        return std::nullopt;
+    
     return { {
         WTFMove(*contentBlockersEnabled),
@@ -67 +73 @@
         WTFMove(*autoplayPolicy),
         WTFMove(*customHeaderFields),
+        WTFMove(*websiteDataStoreParameters),
     } };
 }

trunk/Source/WebKit/Shared/WebsitePoliciesData.h

@@ -28 +28 @@
 #include "WebsiteAutoplayPolicy.h"
 #include "WebsiteAutoplayQuirk.h"
+#include "WebsiteDataStoreParameters.h"
 #include <WebCore/HTTPHeaderField.h>
 #include <wtf/OptionSet.h>
@@ -49 +50 @@
     WebsiteAutoplayPolicy autoplayPolicy { WebsiteAutoplayPolicy::Default };
     Vector<WebCore::HTTPHeaderField> customHeaderFields;
+    std::optional<WebsiteDataStoreParameters> websiteDataStoreParameters;
     
     void encode(IPC::Encoder&) const;

trunk/Source/WebKit/UIProcess/API/APIWebsitePolicies.cpp

@@ -27 +27 @@
 #include "APIWebsitePolicies.h"
 
+#include "APIWebsiteDataStore.h"
 #include "WebsitePoliciesData.h"
 
 namespace API {
+
+WebsitePolicies::WebsitePolicies() = default;
+
+WebsitePolicies::WebsitePolicies(bool contentBlockersEnabled, OptionSet<WebKit::WebsiteAutoplayQuirk> allowedAutoplayQuirks, WebKit::WebsiteAutoplayPolicy autoplayPolicy, Vector<WebCore::HTTPHeaderField>&& customHeaderFields, RefPtr<WebsiteDataStore>&& websiteDataStore)
+    : m_contentBlockersEnabled(contentBlockersEnabled)
+    , m_allowedAutoplayQuirks(allowedAutoplayQuirks)
+    , m_autoplayPolicy(autoplayPolicy)
+    , m_customHeaderFields(WTFMove(customHeaderFields))
+    , m_websiteDataStore(WTFMove(websiteDataStore))
+{ }
 
 WebsitePolicies::~WebsitePolicies()
@@ -35 +46 @@
 }
 
+void WebsitePolicies::setWebsiteDataStore(RefPtr<WebsiteDataStore>&& websiteDataStore)
+{
+    m_websiteDataStore = WTFMove(websiteDataStore);
+}
+
 WebKit::WebsitePoliciesData WebsitePolicies::data()
 {
-    return { contentBlockersEnabled(), allowedAutoplayQuirks(), autoplayPolicy(), customHeaderFields() };
+    std::optional<WebKit::WebsiteDataStoreParameters> parameters;
+    if (m_websiteDataStore)
+        parameters = m_websiteDataStore->websiteDataStore().parameters();
+    return { contentBlockersEnabled(), allowedAutoplayQuirks(), autoplayPolicy(), customHeaderFields(), WTFMove(parameters) };
 }
 

trunk/Source/WebKit/UIProcess/API/APIWebsitePolicies.h

@@ -41 +41 @@
 namespace API {
 
+class WebsiteDataStore;
+
 class WebsitePolicies final : public API::ObjectImpl<API::Object::Type::WebsitePolicies> {
 public:
     static Ref<WebsitePolicies> create() { return adoptRef(*new WebsitePolicies); }
-    WebsitePolicies() = default;
+    WebsitePolicies();
     ~WebsitePolicies();
 
@@ -59 +61 @@
     Vector<WebCore::HTTPHeaderField>&& takeCustomHeaderFields() { return WTFMove(m_customHeaderFields); }
     void setCustomHeaderFields(Vector<WebCore::HTTPHeaderField>&& fields) { m_customHeaderFields = WTFMove(fields); }
+    
+    WebsiteDataStore* websiteDataStore() const { return m_websiteDataStore.get(); }
+    void setWebsiteDataStore(RefPtr<WebsiteDataStore>&&);
 
     WebKit::WebsitePoliciesData data();
 
 private:
-    WebsitePolicies(bool contentBlockersEnabled, OptionSet<WebKit::WebsiteAutoplayQuirk> allowedAutoplayQuirks, WebKit::WebsiteAutoplayPolicy autoplayPolicy, Vector<WebCore::HTTPHeaderField>&& customHeaderFields)
-        : m_contentBlockersEnabled(contentBlockersEnabled)
-        , m_allowedAutoplayQuirks(allowedAutoplayQuirks)
-        , m_autoplayPolicy(autoplayPolicy)
-        , m_customHeaderFields(WTFMove(customHeaderFields))
-    { }
+    WebsitePolicies(bool contentBlockersEnabled, OptionSet<WebKit::WebsiteAutoplayQuirk>, WebKit::WebsiteAutoplayPolicy, Vector<WebCore::HTTPHeaderField>&&, RefPtr<WebsiteDataStore>&&);
 
     bool m_contentBlockersEnabled { true };
@@ -74 +74 @@
     WebKit::WebsiteAutoplayPolicy m_autoplayPolicy { WebKit::WebsiteAutoplayPolicy::Default };
     Vector<WebCore::HTTPHeaderField> m_customHeaderFields;
+    RefPtr<WebsiteDataStore> m_websiteDataStore;
 };
 

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

@@ -47 +47 @@
 void WKFramePolicyListenerUseWithPolicies(WKFramePolicyListenerRef policyListenerRef, WKWebsitePoliciesRef websitePolicies)
 {
-    toImpl(policyListenerRef)->use(toImpl(websitePolicies)->data());
+    auto data = toImpl(websitePolicies)->data();
+    RELEASE_ASSERT_WITH_MESSAGE(!data.websiteDataStoreParameters, "Setting WebsitePolicies.WebsiteDataStore is not supported in the C API.");
+    toImpl(policyListenerRef)->use(WTFMove(data));
 }
 

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

@@ -326 +326 @@
 void WKPageUpdateWebsitePolicies(WKPageRef pageRef, WKWebsitePoliciesRef websitePoliciesRef)
 {
-    toImpl(pageRef)->updateWebsitePolicies(toImpl(websitePoliciesRef)->data());
+    auto data = toImpl(websitePoliciesRef)->data();
+    RELEASE_ASSERT_WITH_MESSAGE(!data.websiteDataStoreParameters, "Setting WebsitePolicies.WebsiteDataStore is not supported in the C API.");
+    toImpl(pageRef)->updateWebsitePolicies(WTFMove(data));
 }
 

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

@@ -4239 +4239 @@
 - (void)_updateWebsitePolicies:(_WKWebsitePolicies *)websitePolicies
 {
-    _page->updateWebsitePolicies(websitePolicies->_websitePolicies->data());
+    auto data = websitePolicies->_websitePolicies->data();
+    if (data.websiteDataStoreParameters)
+        [NSException raise:NSInvalidArgumentException format:@"Updating WKWebsiteDataStore is only supported during decidePolicyForNavigationAction."];
+    _page->updateWebsitePolicies(WTFMove(data));
 }
 

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

@@ -41 +41 @@
 } WK_API_AVAILABLE(macosx(10.13), ios(11.0));
 
+@class WKWebsiteDataStore;
+
 WK_CLASS_AVAILABLE(macosx(10.12.3), ios(10.3))
 @interface _WKWebsitePolicies : NSObject
@@ -48 +50 @@
 @property (nonatomic) _WKWebsiteAutoplayPolicy autoplayPolicy WK_API_AVAILABLE(macosx(10.13), ios(11.0));
 @property (nonatomic, copy) NSDictionary<NSString *, NSString *> *customHeaderFields WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
+@property (nonatomic, strong) WKWebsiteDataStore *websiteDataStore WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
 
 @end

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

@@ -147 +147 @@
 }
 
+- (WKWebsiteDataStore *)websiteDataStore
+{
+    auto* store = _websitePolicies->websiteDataStore();
+    return store ? WebKit::wrapper(*store) : nil;
+}
+
+- (void)setWebsiteDataStore:(WKWebsiteDataStore *)websiteDataStore
+{
+    _websitePolicies->setWebsiteDataStore(websiteDataStore->_websiteDataStore.get());
+}
+
 - (NSString *)description
 {

trunk/Source/WebKit/UIProcess/Cocoa/NavigationState.mm

@@ -467 +467 @@
 
         std::optional<WebsitePoliciesData> data;
-        if (websitePolicies)
+        if (websitePolicies) {
             data = websitePolicies->_websitePolicies->data();
+            if (data->websiteDataStoreParameters) {
+                auto& sessionID = data->websiteDataStoreParameters->networkSessionParameters.sessionID;
+                if (!sessionID.isEphemeral() && sessionID != PAL::SessionID::defaultSessionID())
+                    [NSException raise:NSInvalidArgumentException format:@"_WKWebsitePolicies.websiteDataStore must be nil, default, or non-persistent."];
+            }
+        }
 
         switch (actionPolicy) {

trunk/Tools/ChangeLog

@@ +1 @@
+2017-12-15  Alex Christensen  <achristensen@webkit.org>
+
+        Introduce SPI _WKWebsitePolicies.websiteDataStore
+        https://bugs.webkit.org/show_bug.cgi?id=180880
+        <rdar://problem/35535328>
+
+        Reviewed by Andy Estes.
+
+        * TestWebKitAPI/Tests/WebKitCocoa/WebsitePolicies.mm:
+        (-[WebsitePoliciesWebsiteDataStoreDelegate _webView:decidePolicyForNavigationAction:decisionHandler:]):
+        (-[WebsitePoliciesWebsiteDataStoreDelegate webView:startURLSchemeTask:]):
+        (-[WebsitePoliciesWebsiteDataStoreDelegate webView:stopURLSchemeTask:]):
+        (TEST):
+
 2017-12-15  Nael Ouedraogo  <nael.ouedraogo@crf.canon.fr>
 

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

@@ -35 +35 @@
 #import <WebKit/WKUserContentControllerPrivate.h>
 #import <WebKit/WKWebViewPrivate.h>
+#import <WebKit/WKWebsiteDataStorePrivate.h>
 #import <WebKit/_WKUserContentExtensionStorePrivate.h>
+#import <WebKit/_WKWebsiteDataStoreConfiguration.h>
 #import <WebKit/_WKWebsitePolicies.h>
 #import <wtf/MainThread.h>
@@ -786 +788 @@
 }
 
+static bool done;
+
+@interface WebsitePoliciesWebsiteDataStoreDelegate : NSObject <WKNavigationDelegatePrivate, WKURLSchemeHandler>
+@end
+
+@implementation WebsitePoliciesWebsiteDataStoreDelegate
+
+- (void)_webView:(WKWebView *)webView decidePolicyForNavigationAction:(WKNavigationAction *)navigationAction decisionHandler:(void (^)(WKNavigationActionPolicy, _WKWebsitePolicies *))decisionHandler
+{
+    if ([navigationAction.request.URL.path isEqualToString:@"/invalid"]) {
+        _WKWebsitePolicies *websitePolicies = [[[_WKWebsitePolicies alloc] init] autorelease];
+        websitePolicies.websiteDataStore = [[[WKWebsiteDataStore alloc] _initWithConfiguration:[[[_WKWebsiteDataStoreConfiguration alloc] init] autorelease]] autorelease];
+
+        bool sawException = false;
+        @try {
+            decisionHandler(WKNavigationActionPolicyAllow, websitePolicies);
+        } @catch (NSException *exception) {
+            sawException = true;
+        }
+        EXPECT_TRUE(sawException);
+
+        done = true;
+    }
+}
+
+- (void)webView:(WKWebView *)webView startURLSchemeTask:(id <WKURLSchemeTask>)urlSchemeTask
+{
+}
+
+- (void)webView:(WKWebView *)webView stopURLSchemeTask:(id <WKURLSchemeTask>)urlSchemeTask
+{
+}
+
+@end
+
+TEST(WebKit, UpdateWebsitePoliciesInvalid)
+{
+    auto delegate = adoptNS([[WebsitePoliciesWebsiteDataStoreDelegate alloc] init]);
+    auto configuration = adoptNS([[WKWebViewConfiguration alloc] init]);
+    [configuration setURLSchemeHandler:delegate.get() forURLScheme:@"test"];
+    auto webView = adoptNS([[WKWebView alloc] initWithFrame:NSMakeRect(0, 0, 800, 600) configuration:configuration.get()]);
+    [webView setNavigationDelegate:delegate.get()];
+
+    auto policies = adoptNS([[_WKWebsitePolicies alloc] init]);
+    [policies setWebsiteDataStore:[WKWebsiteDataStore nonPersistentDataStore]];
+    bool sawException = false;
+    @try {
+        [webView _updateWebsitePolicies:policies.get()];
+    } @catch (NSException *exception) {
+        sawException = true;
+    }
+    EXPECT_TRUE(sawException);
+    
+    [webView loadRequest:[NSURLRequest requestWithURL:[NSURL URLWithString:@"test:///invalid"]]];
+    TestWebKitAPI::Util::run(&done);
+}
+
+// FIXME: Use _WKWebsitePolicies.websiteDataStore and test that it is used.
 
 #endif // WK_API_ENABLED