769467 - Add a PrivateBrowsingUtils module with a helper for determining whether a content window is in private browsing mode

Status: RESOLVED FIXED

(Toolkit :: General, defect)

Description

[(no longer active)]

from bug 722984 comment #16)
> Comment on attachment 637581 [details] [diff] [review]
> Patch v3
> 
> I think it would be much simpler in general if there was a global private
> browsing utility function that took a content window and returned whether
> it's "private" using the docshell tree, rather than jumping through hoops in
> various places to use gPrivateBrowsingUI.
> 
> Something like:
> PrivateBrowsingUtils.isWindowPrivate(window)
> 
> isWindowPrivate: function (arbitraryWindow) {
>   return arbitraryWindow.QueryInterface(Ci.nsIInterfaceRequestor)
>      .getInterface(Ci.nsIWebNavigation)
>      .QueryInterface(Ci.nsIDocShellTreeItem)
>      .rootTreeItem.QueryInterface(Ci.nsILoadContext)
>      .usePrivateBrowsing;
> }

Note that the patch here should also switch the existing callers to the new API.

Comment 1

[:Gavin Sharp [email: [e-mail]]]

Bug 722984's patch is another potential consumer (along with your bug 722976).

Comment 2

[Chris Lord [:cwiiis]]

Attachment: Add PrivateBrowsingUtils module

Does as suggested in comment #0

Comment 3

[Dão Gottwald [:dao]]

This patch adds the module in browser/ and the patch in bug 722976 uses it outside of browser/. One of these patches is wrong.

Comment 4

[Chris Lord [:cwiiis]]

Attachment: Add PrivateBrowsingUtils module (in the right place)

Moved from browser/components to dom/base, as discussed on IRC.

Comment 5

[Chris Lord [:cwiiis]]

Attachment: Add PrivateBrowsingUtils module (in the more-right place)

Moving to toolkit/content after discussion on IRC.

Comment 6

[:Gavin Sharp [email: [e-mail]]]

Comment on attachment 638717 [details] [diff] [review]
Add PrivateBrowsingUtils module (in the more-right place)

List it under EXTRA_JS_MODULES instead of EXTRA_PP_JS_MODULES (no need for preprocessing). r=me with that.

Comment 7

[Chris Lord [:cwiiis]]

Attachment: Add PrivateBrowsingUtils module

Attaching final patch for reference, carrying r+.

Pushed to inbound: http://hg.mozilla.org/integration/mozilla-inbound/rev/505d87bc55d4

Let's deal with code using it in a follow-up bug.

Comment 8

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/mozilla-central/rev/505d87bc55d4