Changeset 240646 in webkit

Timestamp:

Jan 28, 2019 11:15:00 PM (5 years ago)

Author:

rniwa@webkit.org

Message:

User agent string override for navigator.userAgent should be site specific quirks
​https://bugs.webkit.org/show_bug.cgi?id=193950

Reviewed by Brent Fulgham.

Source/WebCore:

In order to make it possible to toggle the UA string override just for navigator.userAgent via Web Inspector,
we need to put this override behind the site specific quirks. Because WebInspector overrides Page's setting
without updating WKPreferences, there is no way for WKWebView client's to know whether the site specific quirks
had been disabled or not.

• loader/DocumentLoader.h:

(WebCore::DocumentLoader::setCustomJavaScriptUserAgentAsSiteSpecificQuirks):
(WebCore::DocumentLoader::customJavaScriptUserAgentAsSiteSpecificQuirks const):
(WebCore::DocumentLoader::setCustomJavaScriptUserAgent): Deleted.
(WebCore::DocumentLoader::customJavaScriptUserAgent const): Deleted.

• loader/FrameLoader.cpp:

(WebCore::FrameLoader::userAgentForJavaScript const):

Source/WebKit:

Renamed the various member variables, functions, properties and selectors.

• Shared/WebsitePoliciesData.cpp:

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

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

(API::WebsitePolicies::data):

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

(-[_WKWebsitePolicies setCustomJavaScriptUserAgentAsSiteSpecificQuirks:]): Renamed from setCustomJavaScriptUserAgent.
(-[_WKWebsitePolicies customJavaScriptUserAgentAsSiteSpecificQuirks]): Renamed from customJavaScriptUserAgent.

Tools:

Updated per the _WKWebsitePolicies rename.

• TestWebKitAPI/Tests/WebKitCocoa/WebsitePolicies.mm:

(-[CustomJavaScriptUserAgentDelegate _webView:decidePolicyForNavigationAction:userInfo:decisionHandler:]):

Location:

trunk

Files:

• Source/WebCore/ChangeLog (modified) (1 diff)
• Source/WebCore/loader/DocumentLoader.h (modified) (2 diffs)
• Source/WebCore/loader/FrameLoader.cpp (modified) (1 diff)
• Source/WebKit/ChangeLog (modified) (1 diff)
• Source/WebKit/Shared/WebsitePoliciesData.cpp (modified) (4 diffs)
• Source/WebKit/Shared/WebsitePoliciesData.h (modified) (1 diff)
• Source/WebKit/UIProcess/API/APIWebsitePolicies.cpp (modified) (1 diff)
• Source/WebKit/UIProcess/API/APIWebsitePolicies.h (modified) (2 diffs)
• Source/WebKit/UIProcess/API/Cocoa/_WKWebsitePolicies.h (modified) (1 diff)
• Source/WebKit/UIProcess/API/Cocoa/_WKWebsitePolicies.mm (modified) (1 diff)
• Tools/ChangeLog (modified) (1 diff)
• Tools/TestWebKitAPI/Tests/WebKitCocoa/WebsitePolicies.mm (modified) (4 diffs)

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2019-01-28  Ryosuke Niwa  <rniwa@webkit.org>
+
+        User agent string override for navigator.userAgent should be site specific quirks
+        https://bugs.webkit.org/show_bug.cgi?id=193950
+
+        Reviewed by Brent Fulgham.
+
+        In order to make it possible to toggle the UA string override just for navigator.userAgent via Web Inspector,
+        we need to put this override behind the site specific quirks. Because WebInspector overrides Page's setting
+        without updating WKPreferences, there is no way for WKWebView client's to know whether the site specific quirks
+        had been disabled or not.
+
+        * loader/DocumentLoader.h:
+        (WebCore::DocumentLoader::setCustomJavaScriptUserAgentAsSiteSpecificQuirks):
+        (WebCore::DocumentLoader::customJavaScriptUserAgentAsSiteSpecificQuirks const):
+        (WebCore::DocumentLoader::setCustomJavaScriptUserAgent): Deleted.
+        (WebCore::DocumentLoader::customJavaScriptUserAgent const): Deleted.
+        * loader/FrameLoader.cpp:
+        (WebCore::FrameLoader::userAgentForJavaScript const):
+
 2019-01-28  Devin Rousso  <drousso@apple.com>
 

trunk/Source/WebCore/loader/DocumentLoader.h

@@ -272 +272 @@
     const String& customUserAgent() const { return m_customUserAgent; }
 
-    void setCustomJavaScriptUserAgent(const String& customJavaScriptUserAgent) { m_customJavaScriptUserAgent = customJavaScriptUserAgent; }
-    const String& customJavaScriptUserAgent() const { return m_customJavaScriptUserAgent; }
+    void setCustomJavaScriptUserAgentAsSiteSpecificQuirks(const String& customUserAgent) { m_customJavaScriptUserAgentAsSiteSpecificQuirks = customUserAgent; }
+    const String& customJavaScriptUserAgentAsSiteSpecificQuirks() const { return m_customJavaScriptUserAgentAsSiteSpecificQuirks; }
 
     void setCustomNavigatorPlatform(const String& customNavigatorPlatform) { m_customNavigatorPlatform = customNavigatorPlatform; }
@@ -547 +547 @@
 #endif
     String m_customUserAgent;
-    String m_customJavaScriptUserAgent;
+    String m_customJavaScriptUserAgentAsSiteSpecificQuirks;
     String m_customNavigatorPlatform;
     bool m_userContentExtensionsEnabled { true };

trunk/Source/WebCore/loader/FrameLoader.cpp

@@ -2716 +2716 @@
 
     if (auto* documentLoader = m_frame.mainFrame().loader().activeDocumentLoader()) {
-        userAgent = documentLoader->customJavaScriptUserAgent();
+        if (m_frame.settings().needsSiteSpecificQuirks())
+            userAgent = documentLoader->customJavaScriptUserAgentAsSiteSpecificQuirks();
         if (userAgent.isEmpty())
             userAgent = documentLoader->customUserAgent();

trunk/Source/WebKit/ChangeLog

@@ +1 @@
+2019-01-28  Ryosuke Niwa  <rniwa@webkit.org>
+
+        User agent string override for navigator.userAgent should be site specific quirks
+        https://bugs.webkit.org/show_bug.cgi?id=193950
+
+        Reviewed by Brent Fulgham.
+
+        Renamed the various member variables, functions, properties and selectors.
+
+        * Shared/WebsitePoliciesData.cpp:
+        (WebKit::WebsitePoliciesData::encode const):
+        (WebKit::WebsitePoliciesData::decode):
+        (WebKit::WebsitePoliciesData::applyToDocumentLoader):
+        * Shared/WebsitePoliciesData.h:
+        * UIProcess/API/APIWebsitePolicies.cpp:
+        (API::WebsitePolicies::data):
+        * UIProcess/API/APIWebsitePolicies.h:
+        * UIProcess/API/Cocoa/_WKWebsitePolicies.h:
+        * UIProcess/API/Cocoa/_WKWebsitePolicies.mm:
+        (-[_WKWebsitePolicies setCustomJavaScriptUserAgentAsSiteSpecificQuirks:]): Renamed from setCustomJavaScriptUserAgent.
+        (-[_WKWebsitePolicies customJavaScriptUserAgentAsSiteSpecificQuirks]): Renamed from customJavaScriptUserAgent.
+
 2019-01-28  Commit Queue  <commit-queue@webkit.org>
 

trunk/Source/WebKit/Shared/WebsitePoliciesData.cpp

@@ -45 +45 @@
     encoder << websiteDataStoreParameters;
     encoder << customUserAgent;
-    encoder << customJavaScriptUserAgent;
+    encoder << customJavaScriptUserAgentAsSiteSpecificQuirks;
     encoder << customNavigatorPlatform;
 }
@@ -91 +91 @@
         return WTF::nullopt;
 
-    Optional<String> customJavaScriptUserAgent;
-    decoder >> customJavaScriptUserAgent;
-    if (!customJavaScriptUserAgent)
+    Optional<String> customJavaScriptUserAgentAsSiteSpecificQuirks;
+    decoder >> customJavaScriptUserAgentAsSiteSpecificQuirks;
+    if (!customJavaScriptUserAgentAsSiteSpecificQuirks)
         return WTF::nullopt;
 
@@ -110 +110 @@
         WTFMove(*websiteDataStoreParameters),
         WTFMove(*customUserAgent),
-        WTFMove(*customJavaScriptUserAgent),
+        WTFMove(*customJavaScriptUserAgentAsSiteSpecificQuirks),
         WTFMove(*customNavigatorPlatform),
     } };
@@ -119 +119 @@
     documentLoader.setCustomHeaderFields(WTFMove(websitePolicies.customHeaderFields));
     documentLoader.setCustomUserAgent(websitePolicies.customUserAgent);
-    documentLoader.setCustomJavaScriptUserAgent(websitePolicies.customJavaScriptUserAgent);
+    documentLoader.setCustomJavaScriptUserAgentAsSiteSpecificQuirks(websitePolicies.customJavaScriptUserAgentAsSiteSpecificQuirks);
     documentLoader.setCustomNavigatorPlatform(websitePolicies.customNavigatorPlatform);
     documentLoader.setDeviceOrientationEventEnabled(websitePolicies.deviceOrientationEventEnabled);

trunk/Source/WebKit/Shared/WebsitePoliciesData.h

@@ -55 +55 @@
     Optional<WebsiteDataStoreParameters> websiteDataStoreParameters;
     String customUserAgent;
-    String customJavaScriptUserAgent;
+    String customJavaScriptUserAgentAsSiteSpecificQuirks;
     String customNavigatorPlatform;
 

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

@@ -58 +58 @@
         parameters = m_websiteDataStore->websiteDataStore().parameters();
     return { contentBlockersEnabled(), deviceOrientationEventEnabled(), allowedAutoplayQuirks(), autoplayPolicy(),
-        customHeaderFields(), popUpPolicy(), WTFMove(parameters), m_customUserAgent, m_customJavaScriptUserAgent, m_customNavigatorPlatform };
+        customHeaderFields(), popUpPolicy(), WTFMove(parameters), m_customUserAgent, m_customJavaScriptUserAgentAsSiteSpecificQuirks, m_customNavigatorPlatform };
 }
 

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

@@ -76 +76 @@
     const WTF::String& customUserAgent() const { return m_customUserAgent; }
 
-    void setCustomJavaScriptUserAgent(const WTF::String& customJavaScriptUserAgent) { m_customJavaScriptUserAgent = customJavaScriptUserAgent; }
-    const WTF::String& customJavaScriptUserAgent() const { return m_customJavaScriptUserAgent; }
+    void setCustomJavaScriptUserAgentAsSiteSpecificQuirks(const WTF::String& customUserAgent) { m_customJavaScriptUserAgentAsSiteSpecificQuirks = customUserAgent; }
+    const WTF::String& customJavaScriptUserAgentAsSiteSpecificQuirks() const { return m_customJavaScriptUserAgentAsSiteSpecificQuirks; }
 
     void setCustomNavigatorPlatform(const WTF::String& customNavigatorPlatform) { m_customNavigatorPlatform = customNavigatorPlatform; }
@@ -93 +93 @@
     RefPtr<WebsiteDataStore> m_websiteDataStore;
     WTF::String m_customUserAgent;
-    WTF::String m_customJavaScriptUserAgent;
+    WTF::String m_customJavaScriptUserAgentAsSiteSpecificQuirks;
     WTF::String m_customNavigatorPlatform;
 };

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

@@ -60 +60 @@
 @property (nonatomic, strong) WKWebsiteDataStore *websiteDataStore WK_API_AVAILABLE(macosx(10.13.4), ios(11.3));
 @property (nonatomic, copy) NSString *customUserAgent WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
-@property (nonatomic, copy) NSString *customJavaScriptUserAgent WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
+@property (nonatomic, copy) NSString *customJavaScriptUserAgentAsSiteSpecificQuirks WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
 @property (nonatomic, copy) NSString *customNavigatorPlatform WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
 @property (nonatomic) BOOL deviceOrientationEventEnabled WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));

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

@@ -210 +210 @@
 }
 
-- (void)setCustomJavaScriptUserAgent:(NSString *)customUserAgent
-{
-    _websitePolicies->setCustomJavaScriptUserAgent(customUserAgent);
-}
-
-- (NSString *)customJavaScriptUserAgent
-{
-    return _websitePolicies->customJavaScriptUserAgent();
+- (void)setCustomJavaScriptUserAgentAsSiteSpecificQuirks:(NSString *)customUserAgent
+{
+    _websitePolicies->setCustomJavaScriptUserAgentAsSiteSpecificQuirks(customUserAgent);
+}
+
+- (NSString *)customJavaScriptUserAgentAsSiteSpecificQuirks
+{
+    return _websitePolicies->customJavaScriptUserAgentAsSiteSpecificQuirks();
 }
 

trunk/Tools/ChangeLog

@@ +1 @@
+2019-01-28  Ryosuke Niwa  <rniwa@webkit.org>
+
+        User agent string override for navigator.userAgent should be site specific quirks
+        https://bugs.webkit.org/show_bug.cgi?id=193950
+
+        Reviewed by Brent Fulgham.
+
+        Updated per the _WKWebsitePolicies rename.
+
+        * TestWebKitAPI/Tests/WebKitCocoa/WebsitePolicies.mm:
+        (-[CustomJavaScriptUserAgentDelegate _webView:decidePolicyForNavigationAction:userInfo:decisionHandler:]):
+
 2019-01-28  Ross Kirsling  <ross.kirsling@sony.com>
 

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

@@ -30 +30 @@
 #import <WebKit/WKNavigationDelegatePrivate.h>
 #import <WebKit/WKPagePrivate.h>
+#import <WebKit/WKPreferencesPrivate.h>
 #import <WebKit/WKPreferencesRefPrivate.h>
 #import <WebKit/WKUIDelegatePrivate.h>
@@ -1115 +1116 @@
     _WKWebsitePolicies *websitePolicies = [[[_WKWebsitePolicies alloc] init] autorelease];
     if (navigationAction.targetFrame.mainFrame) {
-        [websitePolicies setCustomJavaScriptUserAgent:@"Foo Custom JavaScript UserAgent"];
+        [websitePolicies setCustomJavaScriptUserAgentAsSiteSpecificQuirks:@"Foo Custom JavaScript UserAgent"];
         if (_setCustomUserAgent)
             [websitePolicies setCustomUserAgent:@"Foo Custom Request UserAgent"];
@@ -1143 +1144 @@
     }];
     [configuration setURLSchemeHandler:schemeHandler.get() forURLScheme:@"test"];
+    [configuration preferences]._needsSiteSpecificQuirks = YES;
 
     auto webView = adoptNS([[TestWKWebView alloc] initWithFrame:NSMakeRect(0, 0, 800, 600) configuration:configuration.get()]);
@@ -1174 +1176 @@
     }];
     [configuration setURLSchemeHandler:schemeHandler.get() forURLScheme:@"test"];
+    [configuration preferences]._needsSiteSpecificQuirks = YES;
 
     auto webView = adoptNS([[TestWKWebView alloc] initWithFrame:NSMakeRect(0, 0, 800, 600) configuration:configuration.get()]);