Changeset 286602 in webkit

Timestamp:

Dec 7, 2021, 11:35:52 AM (5 years ago)

Author:

Chris Dumez

Message:

Reload web views when toggling the captive portal mode at system level
​https://bugs.webkit.org/show_bug.cgi?id=233900

Reviewed by Brent Fulgham.

Reload web views when toggling the captive portal mode at system level, so that the views end up
being backed by WebProcesses with the proper captive portal mode.

• UIProcess/Cocoa/WebProcessPoolCocoa.mm:

(WebKit::cachedCaptivePortalModeEnabledGlobally):
(WebKit::WebProcessPool::captivePortalModeStateChanged):
(WebKit::captivePortalModeEnabledBySystem):
(WebKit::WebProcessPool::notifyPreferencesChanged):

• UIProcess/WebProcessPool.h:

Location:

trunk/Source/WebKit

Files:

• ChangeLog (modified) (1 diff)
• UIProcess/API/APIPageConfiguration.cpp (modified) (1 diff)
• UIProcess/API/APIPageConfiguration.h (modified) (1 diff)
• UIProcess/API/APIWebsitePolicies.h (modified) (1 diff)
• UIProcess/Cocoa/WebProcessPoolCocoa.mm (modified) (5 diffs)
• UIProcess/WebPageProxy.cpp (modified) (2 diffs)
• UIProcess/WebPageProxy.h (modified) (2 diffs)
• UIProcess/WebProcessPool.h (modified) (1 diff)

trunk/Source/WebKit/ChangeLog

@@ +1 @@
+2021-12-07  Chris Dumez  <cdumez@apple.com>
+
+        Reload web views when toggling the captive portal mode at system level
+        https://bugs.webkit.org/show_bug.cgi?id=233900
+
+        Reviewed by Brent Fulgham.
+
+        Reload web views when toggling the captive portal mode at system level, so that the views end up
+        being backed by WebProcesses with the proper captive portal mode.
+
+        * UIProcess/Cocoa/WebProcessPoolCocoa.mm:
+        (WebKit::cachedCaptivePortalModeEnabledGlobally):
+        (WebKit::WebProcessPool::captivePortalModeStateChanged):
+        (WebKit::captivePortalModeEnabledBySystem):
+        (WebKit::WebProcessPool::notifyPreferencesChanged):
+        * UIProcess/WebProcessPool.h:
+
 2021-12-07  Sihui Liu  <sihui_liu@apple.com>
 

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

@@ -205 +205 @@
 }
 
+bool PageConfiguration::isCaptivePortalModeExplicitlySet() const
+{
+    return m_defaultWebsitePolicies && m_defaultWebsitePolicies->isCaptivePortalModeExplicitlySet();
+}
+
 #if ENABLE(APPLICATION_MANIFEST)
 ApplicationManifest* PageConfiguration::applicationManifest() const

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

@@ -190 +190 @@
 #endif
 
+    bool isCaptivePortalModeExplicitlySet() const;
     bool captivePortalModeEnabled() const;
 

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

@@ -131 +131 @@
     bool captivePortalModeEnabled() const;
     void setCaptivePortalModeEnabled(std::optional<bool> captivePortalModeEnabled) { m_captivePortalModeEnabled = captivePortalModeEnabled; }
+    bool isCaptivePortalModeExplicitlySet() const { return !!m_captivePortalModeEnabled; }
 
     WebCore::MouseEventPolicy mouseEventPolicy() const { return m_mouseEventPolicy; }

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

@@ -27 +27 @@
 #import "WebProcessPool.h"
 
+#import "APINavigation.h"
 #import "AccessibilityPreferences.h"
 #import "AccessibilitySupportSPI.h"
@@ -128 +129 @@
 static CFStringRef AppleColorPreferencesChangedNotification = CFSTR("AppleColorPreferencesChangedNotification");
 #endif
+static const char* const WebKitCaptivePortalModeChangedNotification = "WebKitCaptivePortalModeEnabled";
 
 static NSString * const WebKitSuppressMemoryPressureHandlerDefaultsKey = @"WebKitSuppressMemoryPressureHandler";
@@ -181 +183 @@
 
     [[NSUserDefaults standardUserDefaults] registerDefaults:registrationDictionary];
+}
+
+static std::optional<bool>& cachedCaptivePortalModeEnabledGlobally()
+{
+    static std::optional<bool> cachedCaptivePortalModeEnabledGlobally;
+    return cachedCaptivePortalModeEnabledGlobally;
 }
 
@@ -938 +946 @@
 }
 
+void WebProcessPool::captivePortalModeStateChanged()
+{
+    cachedCaptivePortalModeEnabledGlobally() = std::nullopt;
+    auto isNowEnabled = captivePortalModeEnabledBySystem();
+
+    WEBPROCESSPOOL_RELEASE_LOG(Loading, "WebProcessPool::captivePortalModeStateChanged() isNowEnabled=%d", isNowEnabled);
+
+    for (auto& process : m_processes) {
+        bool processHasCaptivePortalModeEnabled = process->captivePortalMode() == WebProcessProxy::CaptivePortalMode::Enabled;
+        if (processHasCaptivePortalModeEnabled == isNowEnabled)
+            continue;
+
+        for (auto& page : process->pages()) {
+            // When the captive portal mode changes globally at system level, we reload every page that relied on the system setting (rather
+            // than being explicitly opted in/out by the client app at navigation or PageConfiguration level).
+            if (page->isCaptivePortalModeExplicitlySet())
+                continue;
+
+            WEBPROCESSPOOL_RELEASE_LOG(Loading, "WebProcessPool::captivePortalModeStateChanged() Reloading page with pageProxyID=%" PRIu64 " due to captive portal mode change", page->identifier().toUInt64());
+            page->reload({ });
+        }
+    }
+}
+
 bool captivePortalModeEnabledBySystem()
 {
-    static std::optional<bool> cachedCaptivePortalModeEnabledGlobally;
-    // FIXME: We should invalidate the cached value when the NSUserDefault changes.
-    if (!cachedCaptivePortalModeEnabledGlobally) {
+    auto& cachedState = cachedCaptivePortalModeEnabledGlobally();
+    if (!cachedState) {
         // FIXME: Using NSUserDefaults is a temporary workaround. This setting should be stored elsewhere (TCC?).
-        cachedCaptivePortalModeEnabledGlobally = [[NSUserDefaults standardUserDefaults] boolForKey:@"WebKitCaptivePortalModeEnabled"];
-    }
-    return *cachedCaptivePortalModeEnabledGlobally;
+        cachedState = [[NSUserDefaults standardUserDefaults] boolForKey:[NSString stringWithUTF8String:WebKitCaptivePortalModeChangedNotification]];
+    }
+    return *cachedState;
 }
 
@@ -1016 +1047 @@
         webAuthnProcess->send(Messages::WebAuthnProcess::NotifyPreferencesChanged(domain, key, encodedValue), 0);
 #endif
+
+    if (key == WebKitCaptivePortalModeChangedNotification)
+        captivePortalModeStateChanged();
 }
 #endif // ENABLE(CFPREFS_DIRECT_MODE)

trunk/Source/WebKit/UIProcess/WebPageProxy.cpp

@@ -863 +863 @@
     else
         m_process = processPool.processForRegistrableDomain(m_websiteDataStore.get(), registrableDomain, shouldEnableCaptivePortalMode() ? WebProcessProxy::CaptivePortalMode::Enabled : WebProcessProxy::CaptivePortalMode::Disabled);
+
     m_hasRunningProcess = true;
+    m_isCaptivePortalModeExplicitlySet = m_configuration->isCaptivePortalModeExplicitlySet();
 
     m_process->addExistingWebPage(*this, WebProcessProxy::BeginsUsingDataStore::Yes);
@@ -3451 +3453 @@
     }
 
+    m_isCaptivePortalModeExplicitlySet = policies ? policies->isCaptivePortalModeExplicitlySet() : m_configuration->isCaptivePortalModeExplicitlySet();
     auto captivePortalMode = (policies ? policies->captivePortalModeEnabled() : shouldEnableCaptivePortalMode()) ? WebProcessProxy::CaptivePortalMode::Enabled : WebProcessProxy::CaptivePortalMode::Disabled;
     process().processPool().processForNavigation(*this, *navigation, sourceProcess.copyRef(), sourceURL, processSwapRequestedByClient, captivePortalMode, frameInfo, WTFMove(websiteDataStore), [this, protectedThis = Ref { *this }, policyAction, navigation = Ref { *navigation }, navigationAction = WTFMove(navigationAction), sourceProcess = sourceProcess.copyRef(),

trunk/Source/WebKit/UIProcess/WebPageProxy.h

@@ -497 +497 @@
     void addPreviouslyVisitedPath(const String&);
 
+    bool isCaptivePortalModeExplicitlySet() const { return m_isCaptivePortalModeExplicitlySet; }
     bool shouldEnableCaptivePortalMode() const;
 
@@ -3140 +3141 @@
     bool m_isRunningModalJavaScriptDialog { false };
     bool m_isSuspended { false };
+    bool m_isCaptivePortalModeExplicitlySet { false };
 
     std::optional<PrivateClickMeasurementAndMetadata> m_privateClickMeasurement;

trunk/Source/WebKit/UIProcess/WebProcessPool.h

@@ -549 +549 @@
     void registerNotificationObservers();
     void unregisterNotificationObservers();
+
+    void captivePortalModeStateChanged();
 #endif