Bug 815847 - Part 4: Implement a hidden private window managed by the app shell service; r=bzbarsky

This commit is contained in:
Ehsan Akhgari 2012-12-10 23:49:17 -05:00
parent 8dfd0eb1e5
commit 1c7d34d536
8 changed files with 184 additions and 1 deletions

View File

@ -367,6 +367,15 @@ nsCCUncollectableMarker::Observe(nsISupports* aSubject, const char* aTopic,
nsCOMPtr<nsIDocShellTreeNode> shellTreeNode = do_QueryInterface(shell);
MarkDocShell(shellTreeNode, cleanupJS, prepareForCC);
}
#ifdef MOZ_PER_WINDOW_PRIVATE_BROWSING
appShell->GetHiddenPrivateWindow(getter_AddRefs(hw));
if (hw) {
nsCOMPtr<nsIDocShell> shell;
hw->GetDocShell(getter_AddRefs(shell));
nsCOMPtr<nsIDocShellTreeNode> shellTreeNode = do_QueryInterface(shell);
MarkDocShell(shellTreeNode, cleanupJS, prepareForCC);
}
#endif
}
#ifdef MOZ_XUL

View File

@ -319,7 +319,11 @@ nsAppStartup::Quit(uint32_t aMode)
ferocity = eAttemptQuit;
}
#ifdef XP_MACOSX
#ifdef MOZ_PER_WINDOW_PRIVATE_BROWSING
else if (mConsiderQuitStopper == 2) {
#else
else if (mConsiderQuitStopper == 1) {
#endif
// ... or there is only a hiddenWindow left, and it's useless:
nsCOMPtr<nsIAppShellService> appShell
(do_GetService(NS_APPSHELLSERVICE_CONTRACTID));
@ -332,9 +336,17 @@ nsAppStartup::Quit(uint32_t aMode)
appShell->GetApplicationProvidedHiddenWindow(&usefulHiddenWindow);
nsCOMPtr<nsIXULWindow> hiddenWindow;
appShell->GetHiddenWindow(getter_AddRefs(hiddenWindow));
#ifdef MOZ_PER_WINDOW_PRIVATE_BROWSING
nsCOMPtr<nsIXULWindow> hiddenPrivateWindow;
appShell->GetHiddenPrivateWindow(getter_AddRefs(hiddenPrivateWindow));
// If the remaining windows are useful, we won't quit:
if ((!hiddenWindow && !hiddenPrivateWindow) || usefulHiddenWindow)
return NS_OK;
#else
// If the one window is useful, we won't quit:
if (!hiddenWindow || usefulHiddenWindow)
return NS_OK;
#endif
ferocity = eAttemptQuit;
}

View File

@ -16,7 +16,7 @@ interface nsIAppShell;
struct JSContext;
%}
[scriptable, uuid(EBCD34E2-2E43-45C0-AAC8-E6F1C692B371)]
[scriptable, uuid(76e6364a-5453-47c7-ad83-8c30eff20a75)]
interface nsIAppShellService : nsISupports
{
/**
@ -64,6 +64,24 @@ interface nsIAppShellService : nsISupports
*/
readonly attribute nsIDOMWindow hiddenDOMWindow;
/**
* Return the (singleton) application hidden private window, automatically
* created and maintained by this AppShellService. This window is created
* in private browsing mode.
* @param aResult the hidden private window. Do not unhide hidden window.
* Do not taunt hidden window.
*/
readonly attribute nsIXULWindow hiddenPrivateWindow;
/**
* Return the (singleton) application hidden private window, automatically
* created and maintained by this AppShellService. This window is created
* in private browsing mode.
* @param aResult the hidden private window. Do not unhide hidden window.
* Do not taunt hidden window.
*/
readonly attribute nsIDOMWindow hiddenPrivateDOMWindow;
/**
* Return the (singleton) application hidden window as an nsIDOMWindow,
* and, the corresponding JavaScript context pointer. This is useful

View File

@ -31,5 +31,7 @@ CPPSRCS = \
nsAppShellFactory.cpp \
$(NULL)
PARALLEL_DIRS := test
include $(topsrcdir)/config/rules.mk

View File

@ -109,6 +109,18 @@ nsAppShellService::CreateHiddenWindow()
mHiddenWindow.swap(newWindow);
#ifdef MOZ_PER_WINDOW_PRIVATE_BROWSING
// Create the hidden private window
chromeMask |= nsIWebBrowserChrome::CHROME_PRIVATE_WINDOW;
rv = JustCreateTopWindow(nullptr, url,
chromeMask, initialWidth, initialHeight,
true, getter_AddRefs(newWindow));
NS_ENSURE_SUCCESS(rv, rv);
mHiddenPrivateWindow.swap(newWindow);
#endif
// RegisterTopLevelWindow(newWindow); -- Mac only
return NS_OK;
@ -123,6 +135,14 @@ nsAppShellService::DestroyHiddenWindow()
mHiddenWindow = nullptr;
}
#ifdef MOZ_PER_WINDOW_PRIVATE_BROWSING
if (mHiddenPrivateWindow) {
mHiddenPrivateWindow->Destroy();
mHiddenPrivateWindow = nullptr;
}
#endif
return NS_OK;
}
@ -357,6 +377,12 @@ nsAppShellService::JustCreateTopWindow(nsIXULWindow *aParent,
// Enforce the Private Browsing autoStart pref first.
bool isPrivateBrowsingWindow =
Preferences::GetBool("browser.privatebrowsing.autostart");
#ifdef MOZ_PER_WINDOW_PRIVATE_BROWSING
if (aChromeMask & nsIWebBrowserChrome::CHROME_PRIVATE_WINDOW) {
// Caller requested a private window
isPrivateBrowsingWindow = true;
}
#endif
if (!isPrivateBrowsingWindow) {
// Ensure that we propagate any existing private browsing status
// from the parent, even if it will not actually be used
@ -414,6 +440,42 @@ nsAppShellService::GetHiddenDOMWindow(nsIDOMWindow **aWindow)
return NS_OK;
}
NS_IMETHODIMP
nsAppShellService::GetHiddenPrivateWindow(nsIXULWindow **aWindow)
{
#ifdef MOZ_PER_WINDOW_PRIVATE_BROWSING
NS_ENSURE_ARG_POINTER(aWindow);
*aWindow = mHiddenPrivateWindow;
NS_IF_ADDREF(*aWindow);
return *aWindow ? NS_OK : NS_ERROR_FAILURE;
#else
return NS_ERROR_NOT_IMPLEMENTED;
#endif
}
NS_IMETHODIMP
nsAppShellService::GetHiddenPrivateDOMWindow(nsIDOMWindow **aWindow)
{
#ifdef MOZ_PER_WINDOW_PRIVATE_BROWSING
nsresult rv;
nsCOMPtr<nsIDocShell> docShell;
NS_ENSURE_TRUE(mHiddenPrivateWindow, NS_ERROR_FAILURE);
rv = mHiddenPrivateWindow->GetDocShell(getter_AddRefs(docShell));
NS_ENSURE_SUCCESS(rv, rv);
nsCOMPtr<nsIDOMWindow> hiddenPrivateDOMWindow(do_GetInterface(docShell, &rv));
NS_ENSURE_SUCCESS(rv, rv);
*aWindow = hiddenPrivateDOMWindow;
NS_IF_ADDREF(*aWindow);
return NS_OK;
#else
return NS_ERROR_NOT_IMPLEMENTED;
#endif
}
NS_IMETHODIMP
nsAppShellService::GetHiddenWindowAndJSContext(nsIDOMWindow **aWindow,
JSContext **aJSContext)
@ -531,6 +593,12 @@ nsAppShellService::UnregisterTopLevelWindow(nsIXULWindow* aWindow)
// CreateHiddenWindow() does not register the window, so we're done.
return NS_OK;
}
#ifdef MOZ_PER_WINDOW_PRIVATE_BROWSING
if (aWindow == mHiddenPrivateWindow) {
// CreateHiddenWindow() does not register the window, so we're done.
return NS_OK;
}
#endif
// tell the window mediator
nsCOMPtr<nsIWindowMediator> mediator
@ -568,6 +636,11 @@ nsAppShellService::Observe(nsISupports* aSubject, const char *aTopic,
if (mHiddenWindow) {
mHiddenWindow->Destroy();
}
#ifdef MOZ_PER_WINDOW_PRIVATE_BROWSING
if (mHiddenPrivateWindow) {
mHiddenPrivateWindow->Destroy();
}
#endif
} else {
NS_ERROR("Unexpected observer topic!");
}

View File

@ -41,6 +41,9 @@ protected:
uint32_t CalculateWindowZLevel(nsIXULWindow *aParent, uint32_t aChromeMask);
nsRefPtr<nsWebShellWindow> mHiddenWindow;
#ifdef MOZ_PER_WINDOW_PRIVATE_BROWSING
nsRefPtr<nsWebShellWindow> mHiddenPrivateWindow;
#endif
bool mXPCOMWillShutDown;
bool mXPCOMShuttingDown;
uint16_t mModalWindowCount;

View File

@ -0,0 +1,19 @@
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
DEPTH := @DEPTH@
topsrcdir := @top_srcdir@
srcdir := @srcdir@
VPATH := @srcdir@
relativesrcdir := @relativesrcdir@
include $(DEPTH)/config/autoconf.mk
ifdef MOZ_PER_WINDOW_PRIVATE_BROWSING
MOCHITEST_CHROME_FILES := \
test_hiddenPrivateWindow.xul \
$(NULL)
endif
include $(topsrcdir)/config/rules.mk

View File

@ -0,0 +1,47 @@
<?xml version="1.0"?>
<?xml-stylesheet href="chrome://global/skin" type="text/css"?>
<?xml-stylesheet href="chrome://mochikit/content/tests/SimpleTest/test.css"
type="text/css"?>
<!--
https://bugzilla.mozilla.org/show_bug.cgi?id=815847
-->
<window title="Mozilla Bug 815847"
xmlns:html="http://www.w3.org/1999/xhtml"
xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul">
<title>Test for Bug 815847</title>
<script type="application/javascript"
src="chrome://mochikit/content/tests/SimpleTest/SimpleTest.js" />
<body xmlns="http://www.w3.org/1999/xhtml">
<a target="_blank" href="https://bugzilla.mozilla.org/show_bug.cgi?id=815847">Mozilla Bug 815847</a>
<p id="display"></p>
<div id="content" style="display: none">
</div>
<pre id="test">
</pre>
</body>
<script class="testbody" type="application/javascript">
<![CDATA[
const Cu = Components.utils;
Cu.import('resource://gre/modules/Services.jsm');
Cu.import('resource://gre/modules/PrivateBrowsingUtils.jsm');
ok(Services.appShell.hiddenWindow, "hiddenWindow should exist");
ok(Services.appShell.hiddenDOMWindow, "hiddenDOMWindow should exist");
ok(Services.appShell.hiddenPrivateWindow, "hiddenPrivateWindow should exist");
ok(Services.appShell.hiddenPrivateDOMWindow, "hiddenPrivateDOMWindow should exist");
ok(!PrivateBrowsingUtils.isWindowPrivate(Services.appShell.hiddenWindow.docShell), "hiddenWindow should not be private");
ok(!PrivateBrowsingUtils.isWindowPrivate(Services.appShell.hiddenDOMWindow), "hiddenDOMWindow should not be private");
ok(PrivateBrowsingUtils.isWindowPrivate(Services.appShell.hiddenPrivateWindow.docShell), "hiddenPrivateWindow should be private");
ok(PrivateBrowsingUtils.isWindowPrivate(Services.appShell.hiddenPrivateDOMWindow), "hiddenPrivateDOMWindow should be private");
]]>
</script>
</window>