Changeset 211147 in webkit

Timestamp:

Jan 25, 2017 9:02:58 AM (7 years ago)

Author:

Carlos Garcia Campos

Message:

[GTK] Icon Database should be in private browsing mode for ephemeral web views
​https://bugs.webkit.org/show_bug.cgi?id=167414

Reviewed by Michael Catanzaro.

Source/WebKit2:

This is already done by WebProcessPool for the legacy private session setting, but only checking the setting and not
whether there are ephemeral web pages or not.

• UIProcess/API/gtk/WebKitWebContext.cpp:

(webkitWebContextEnableIconDatabasePrivateBrowsingIfNeeded): Enable icon database private browsing if there's
any ephemeral web view.
(webkitWebContextDisableIconDatabasePrivateBrowsingIfNeeded): Disable icon database private browsing if there
aren't ephemeral web views anymore.
(webkit_web_context_set_favicon_database_directory): Enable icon database private browsing if the web context is ephemeral.
(webkitWebContextCreatePageForWebView): Call webkitWebContextEnableIconDatabasePrivateBrowsingIfNeeded().
(webkitWebContextWebViewDestroyed): Call webkitWebContextDisableIconDatabasePrivateBrowsingIfNeeded().

• UIProcess/API/gtk/WebKitWebView.cpp:

(webkitWebViewDispose): Ensure webkitWebContextWebViewDestroyed is called only once.

Tools:

Add a test case to check ephemeral web views don't write favicons to the database.

• TestWebKitAPI/Tests/WebKit2Gtk/TestWebKitFaviconDatabase.cpp:

(ephemeralViewLoadChanged):
(testPrivateBrowsing):
(testFaviconDatabase):

Location:

trunk

Files:

• Source/WebKit2/ChangeLog (modified) (1 diff)
• Source/WebKit2/UIProcess/API/gtk/WebKitWebContext.cpp (modified) (5 diffs)
• Source/WebKit2/UIProcess/API/gtk/WebKitWebView.cpp (modified) (1 diff)
• Tools/ChangeLog (modified) (1 diff)
• Tools/TestWebKitAPI/Tests/WebKit2Gtk/TestWebKitFaviconDatabase.cpp (modified) (2 diffs)

trunk/Source/WebKit2/ChangeLog

@@ +1 @@
+2017-01-25  Carlos Garcia Campos  <cgarcia@igalia.com>
+
+        [GTK] Icon Database should be in private browsing mode for ephemeral web views
+        https://bugs.webkit.org/show_bug.cgi?id=167414
+
+        Reviewed by Michael Catanzaro.
+
+        This is already done by WebProcessPool for the legacy private session setting, but only checking the setting and not
+        whether there are ephemeral web pages or not.
+
+        * UIProcess/API/gtk/WebKitWebContext.cpp:
+        (webkitWebContextEnableIconDatabasePrivateBrowsingIfNeeded): Enable icon database private browsing if there's
+        any ephemeral web view.
+        (webkitWebContextDisableIconDatabasePrivateBrowsingIfNeeded): Disable icon database private browsing if there
+        aren't ephemeral web views anymore.
+        (webkit_web_context_set_favicon_database_directory): Enable icon database private browsing if the web context is ephemeral.
+        (webkitWebContextCreatePageForWebView): Call webkitWebContextEnableIconDatabasePrivateBrowsingIfNeeded().
+        (webkitWebContextWebViewDestroyed): Call webkitWebContextDisableIconDatabasePrivateBrowsingIfNeeded().
+        * UIProcess/API/gtk/WebKitWebView.cpp:
+        (webkitWebViewDispose): Ensure webkitWebContextWebViewDestroyed is called only once.
+
 2017-01-25  Carlos Garcia Campos  <cgarcia@igalia.com>
 

trunk/Source/WebKit2/UIProcess/API/gtk/WebKitWebContext.cpp

@@ -177 +177 @@
 
     HashMap<uint64_t, WebKitWebView*> webViews;
+    unsigned ephemeralPageCount;
 
     CString webExtensionsDirectory;
@@ -713 +714 @@
 }
 
+static void webkitWebContextEnableIconDatabasePrivateBrowsingIfNeeded(WebKitWebContext* context, WebKitWebView* webView)
+{
+    if (webkit_web_context_is_ephemeral(context))
+        return;
+    if (!webkit_web_view_is_ephemeral(webView))
+        return;
+
+    if (!context->priv->ephemeralPageCount)
+        context->priv->processPool->iconDatabase()->setPrivateBrowsingEnabled(true);
+    context->priv->ephemeralPageCount++;
+}
+
+static void webkitWebContextDisableIconDatabasePrivateBrowsingIfNeeded(WebKitWebContext* context, WebKitWebView* webView)
+{
+    if (webkit_web_context_is_ephemeral(context))
+        return;
+    if (!webkit_web_view_is_ephemeral(webView))
+        return;
+
+    ASSERT(context->priv->ephemeralPageCount);
+    context->priv->ephemeralPageCount--;
+    if (!context->priv->ephemeralPageCount)
+        context->priv->processPool->iconDatabase()->setPrivateBrowsingEnabled(false);
+}
+
 /**
  * webkit_web_context_set_favicon_database_directory:
@@ -751 +777 @@
     // Setting the path will cause the icon database to be opened.
     priv->processPool->setIconDatabasePath(WebCore::stringFromFileSystemRepresentation(faviconDatabasePath.get()));
+
+    if (webkit_web_context_is_ephemeral(context))
+        priv->processPool->iconDatabase()->setPrivateBrowsingEnabled(true);
 }
 
@@ -1459 +1488 @@
     WebKitWebViewBase* webViewBase = WEBKIT_WEB_VIEW_BASE(webView);
 
+    // FIXME: icon database private mode is global, not per page, so while there are
+    // pages in private mode we need to enable the private mode in the icon database.
+    webkitWebContextEnableIconDatabasePrivateBrowsingIfNeeded(context, webView);
+
     auto pageConfiguration = API::PageConfiguration::create();
     pageConfiguration->setProcessPool(context->priv->processPool.get());
@@ -1478 +1511 @@
 void webkitWebContextWebViewDestroyed(WebKitWebContext* context, WebKitWebView* webView)
 {
+    webkitWebContextDisableIconDatabasePrivateBrowsingIfNeeded(context, webView);
     WebPageProxy* page = webkitWebViewBaseGetPage(WEBKIT_WEB_VIEW_BASE(webView));
     context->priv->webViews.remove(page->pageID());

trunk/Source/WebKit2/UIProcess/API/gtk/WebKitWebView.cpp

@@ -779 +779 @@
         getPage(webView)->pageLoadState().removeObserver(*webView->priv->loadObserver);
         webView->priv->loadObserver.reset();
+
+        // We notify the context here to ensure it's called only once. Ideally we should
+        // call this in finalize, not dispose, but finalize is used internally and we don't
+        // have access to the instance pointer from the private struct destructor.
+        webkitWebContextWebViewDestroyed(webView->priv->context.get(), webView);
     }
-
-    webkitWebContextWebViewDestroyed(webView->priv->context.get(), webView);
 
     G_OBJECT_CLASS(webkit_web_view_parent_class)->dispose(object);

trunk/Tools/ChangeLog

@@ +1 @@
+2017-01-25  Carlos Garcia Campos  <cgarcia@igalia.com>
+
+        [GTK] Icon Database should be in private browsing mode for ephemeral web views
+        https://bugs.webkit.org/show_bug.cgi?id=167414
+
+        Reviewed by Michael Catanzaro.
+
+        Add a test case to check ephemeral web views don't write favicons to the database.
+
+        * TestWebKitAPI/Tests/WebKit2Gtk/TestWebKitFaviconDatabase.cpp:
+        (ephemeralViewLoadChanged):
+        (testPrivateBrowsing):
+        (testFaviconDatabase):
+
 2017-01-25  Carlos Garcia Campos  <cgarcia@igalia.com>
 

trunk/Tools/TestWebKitAPI/Tests/WebKit2Gtk/TestWebKitFaviconDatabase.cpp

@@ -153 +153 @@
 }
 
+static void ephemeralViewLoadChanged(WebKitWebView* webView, WebKitLoadEvent loadEvent, WebViewTest* test)
+{
+    if (loadEvent != WEBKIT_LOAD_FINISHED)
+        return;
+    g_signal_handlers_disconnect_by_func(webView, reinterpret_cast<void*>(ephemeralViewLoadChanged), test);
+    test->quitMainLoop();
+}
+
+static void testPrivateBrowsing(FaviconDatabaseTest* test)
+{
+    GRefPtr<WebKitWebView> webView = WEBKIT_WEB_VIEW(g_object_new(WEBKIT_TYPE_WEB_VIEW,
+        "web-context", test->m_webContext.get(),
+        "is-ephemeral", TRUE,
+        nullptr));
+    g_signal_connect(webView.get(), "load-changed", G_CALLBACK(ephemeralViewLoadChanged), test);
+    webkit_web_view_load_uri(webView.get(), kServer->getURIForPath("/foo").data());
+    g_main_loop_run(test->m_mainLoop);
+
+    // An ephemeral web view should not write to the database.
+    test->getFaviconForPageURIAndWaitUntilReady(kServer->getURIForPath("/foo").data());
+    g_assert(!test->m_favicon);
+    g_assert(test->m_error);
+}
+
 static void testGetFavicon(FaviconDatabaseTest* test)
 {
@@ -229 +253 @@
     testNotInitialized(test);
     testSetDirectory(test);
+    testPrivateBrowsing(test);
     testGetFavicon(test);
     testGetFaviconURI(test);