The Tor Browser: embedding/browser/webBrowser/nsDocShellTreeOwner.h@129ffea94266 (annotated)

embedding/browser/webBrowser/nsDocShellTreeOwner.h@129ffea94266 (annotated)

embedding/browser/webBrowser/nsDocShellTreeOwner.h

Sat, 03 Jan 2015 20:18:00 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Sat, 03 Jan 2015 20:18:00 +0100
branch: TOR_BUG_3246
changeset 7: 129ffea94266
permissions: -rw-r--r--

Conditionally enable double key logic according to:
private browsing mode or privacy.thirdparty.isolate preference and
implement in GetCookieStringCommon and FindCookie where it counts...
With some reservations of how to convince FindCookie users to test
condition and pass a nullptr when disabling double key logic.

 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
  *
  * 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/. */
 #ifndef nsDocShellTreeOwner_h__
 #define nsDocShellTreeOwner_h__
 // Helper Classes
 #include "nsCOMPtr.h"
 #include "nsString.h"
 // Interfaces Needed
 #include "nsIBaseWindow.h"
 #include "nsIDocShellTreeOwner.h"
 #include "nsIInterfaceRequestor.h"
 #include "nsIInterfaceRequestorUtils.h"
 #include "nsIWebBrowserChrome.h"
 #include "nsIDOMEventListener.h"
 #include "nsIEmbeddingSiteWindow.h"
 #include "nsIWebProgressListener.h"
 #include "nsWeakReference.h"
 #include "nsITimer.h"
 #include "nsIPrompt.h"
 #include "nsIAuthPrompt.h"
 #include "nsITooltipListener.h"
 #include "nsITooltipTextProvider.h"
 #include "nsCTooltipTextProvider.h"
 #include "nsIDroppedLinkHandler.h"
 #include "nsCommandHandler.h"
 namespace mozilla {
 namespace dom {
 class EventTarget;
 }
 }
 class nsWebBrowser;
 class ChromeTooltipListener;
 class ChromeContextMenuListener;
 // {6D10C180-6888-11d4-952B-0020183BF181}
 #define NS_ICDOCSHELLTREEOWNER_IID \
 { 0x6d10c180, 0x6888, 0x11d4, { 0x95, 0x2b, 0x0, 0x20, 0x18, 0x3b, 0xf1, 0x81 } }
 /*
  * This is a fake 'hidden' interface that nsDocShellTreeOwner implements.
  * Classes such as nsCommandHandler can QI for this interface to be
  * sure that they're dealing with a valid nsDocShellTreeOwner and not some
  * other object that implements nsIDocShellTreeOwner.
  */
 class nsICDocShellTreeOwner : public nsISupports
 {
 public:
     NS_DECLARE_STATIC_IID_ACCESSOR(NS_ICDOCSHELLTREEOWNER_IID)
 };
 NS_DEFINE_STATIC_IID_ACCESSOR(nsICDocShellTreeOwner,
                               NS_ICDOCSHELLTREEOWNER_IID)
 class nsDocShellTreeOwner : public nsIDocShellTreeOwner,
                             public nsIBaseWindow,
                             public nsIInterfaceRequestor,
                             public nsIWebProgressListener,
                             public nsIDOMEventListener,
                             public nsICDocShellTreeOwner,
                             public nsSupportsWeakReference
 {
 friend class nsWebBrowser;
 friend class nsCommandHandler;
 public:
     NS_DECL_ISUPPORTS
     NS_DECL_NSIBASEWINDOW
     NS_DECL_NSIDOCSHELLTREEOWNER
     NS_DECL_NSIDOMEVENTLISTENER
     NS_DECL_NSIINTERFACEREQUESTOR
     NS_DECL_NSIWEBPROGRESSLISTENER
 protected:
     nsDocShellTreeOwner();
     virtual ~nsDocShellTreeOwner();
     void WebBrowser(nsWebBrowser* aWebBrowser);
     nsWebBrowser* WebBrowser();
     NS_IMETHOD SetTreeOwner(nsIDocShellTreeOwner* aTreeOwner);
     NS_IMETHOD SetWebBrowserChrome(nsIWebBrowserChrome* aWebBrowserChrome);
     NS_IMETHOD AddChromeListeners();
     NS_IMETHOD RemoveChromeListeners();
     nsresult   FindItemWithNameAcrossWindows(const char16_t* aName,
                  nsIDocShellTreeItem* aRequestor,
                  nsIDocShellTreeItem* aOriginalRequestor,
                  nsIDocShellTreeItem **aFoundItem);
     void       EnsurePrompter();
     void       EnsureAuthPrompter();
     void AddToWatcher();
     void RemoveFromWatcher();
     // These helper functions return the correct instances of the requested
     // interfaces.  If the object passed to SetWebBrowserChrome() implements
     // nsISupportsWeakReference, then these functions call QueryReferent on
     // that object.  Otherwise, they return an addrefed pointer.  If the
     // WebBrowserChrome object doesn't exist, they return nullptr.
     already_AddRefed<nsIWebBrowserChrome>     GetWebBrowserChrome();
     already_AddRefed<nsIEmbeddingSiteWindow>  GetOwnerWin();
     already_AddRefed<nsIInterfaceRequestor>   GetOwnerRequestor();
 protected:
    // Weak References
    nsWebBrowser*           mWebBrowser;
    nsIDocShellTreeOwner*   mTreeOwner;
    nsIDocShellTreeItem*    mPrimaryContentShell;
    nsIWebBrowserChrome*    mWebBrowserChrome;
    nsIEmbeddingSiteWindow* mOwnerWin;
    nsIInterfaceRequestor*  mOwnerRequestor;
    nsWeakPtr               mWebBrowserChromeWeak;   // nsIWebBrowserChrome
     // the objects that listen for chrome events like context menus and tooltips.
     // They are separate objects to avoid circular references between |this|
     // and the DOM. These are strong, owning refs.
    ChromeTooltipListener*         mChromeTooltipListener;
    ChromeContextMenuListener*     mChromeContextMenuListener;
    nsCOMPtr<nsIPrompt>     mPrompter;
    nsCOMPtr<nsIAuthPrompt> mAuthPrompter;
 };
 //
 // class ChromeTooltipListener
 //
 // The class that listens to the chrome events and tells the embedding
 // chrome to show tooltips, as appropriate. Handles registering itself
 // with the DOM with AddChromeListeners() and removing itself with
 // RemoveChromeListeners().
 //
 class ChromeTooltipListener : public nsIDOMEventListener
 {
 public:
   NS_DECL_ISUPPORTS
   ChromeTooltipListener ( nsWebBrowser* inBrowser, nsIWebBrowserChrome* inChrome ) ;
   virtual ~ChromeTooltipListener ( ) ;
   NS_IMETHOD HandleEvent(nsIDOMEvent* aEvent);
   NS_IMETHOD MouseMove(nsIDOMEvent* aMouseEvent);
     // Add/remove the relevant listeners, based on what interfaces
     // the embedding chrome implements.
   NS_IMETHOD AddChromeListeners();
   NS_IMETHOD RemoveChromeListeners();
 private:
     // various delays for tooltips
   enum {
     kTooltipAutoHideTime = 5000        // 5000ms = 5 seconds
   };
   NS_IMETHOD AddTooltipListener();
   NS_IMETHOD RemoveTooltipListener();
   NS_IMETHOD ShowTooltip ( int32_t inXCoords, int32_t inYCoords, const nsAString & inTipText ) ;
   NS_IMETHOD HideTooltip ( ) ;
   nsWebBrowser* mWebBrowser;
   nsCOMPtr<mozilla::dom::EventTarget> mEventTarget;
   nsCOMPtr<nsITooltipTextProvider> mTooltipTextProvider;
     // This must be a strong ref in order to make sure we can hide the tooltip
     // if the window goes away while we're displaying one. If we don't hold
     // a strong ref, the chrome might have been disposed of before we get a chance
     // to tell it, and no one would ever tell us of that fact.
   nsCOMPtr<nsIWebBrowserChrome> mWebBrowserChrome;
   bool mTooltipListenerInstalled;
   nsCOMPtr<nsITimer> mTooltipTimer;
   static void sTooltipCallback ( nsITimer* aTimer, void* aListener ) ;
   int32_t mMouseClientX, mMouseClientY;       // mouse coordinates for last mousemove event we saw
   int32_t mMouseScreenX, mMouseScreenY;       // mouse coordinates for tooltip event
   bool mShowingTooltip;
     // a timer for auto-hiding the tooltip after a certain delay
   nsCOMPtr<nsITimer> mAutoHideTimer;
   static void sAutoHideCallback ( nsITimer* aTimer, void* aListener ) ;
   void CreateAutoHideTimer ( ) ;
     // The node hovered over that fired the timer. This may turn into the node that
     // triggered the tooltip, but only if the timer ever gets around to firing.
     // This is a strong reference, because the tooltip content can be destroyed while we're
     // waiting for the tooltip to pup up, and we need to detect that.
     // It's set only when the tooltip timer is created and launched. The timer must
     // either fire or be cancelled (or possibly released?), and we release this
     // reference in each of those cases. So we don't leak.
   nsCOMPtr<nsIDOMNode> mPossibleTooltipNode;
 }; // ChromeTooltipListener
 //
 // class ChromeContextMenuListener
 //
 // The class that listens to the chrome events and tells the embedding
 // chrome to show context menus, as appropriate. Handles registering itself
 // with the DOM with AddChromeListeners() and removing itself with
 // RemoveChromeListeners().
 //
 class ChromeContextMenuListener : public nsIDOMEventListener
 {
 public:
   NS_DECL_ISUPPORTS
   ChromeContextMenuListener ( nsWebBrowser* inBrowser, nsIWebBrowserChrome* inChrome ) ;
   virtual ~ChromeContextMenuListener ( ) ;
   // nsIDOMContextMenuListener
   NS_IMETHOD HandleEvent(nsIDOMEvent* aEvent);
   // Add/remove the relevant listeners, based on what interfaces
   // the embedding chrome implements.
   NS_IMETHOD AddChromeListeners();
   NS_IMETHOD RemoveChromeListeners();
 private:
   NS_IMETHOD AddContextMenuListener();
   NS_IMETHOD RemoveContextMenuListener();
   bool mContextMenuListenerInstalled;
   nsWebBrowser* mWebBrowser;
   nsCOMPtr<mozilla::dom::EventTarget> mEventTarget;
   nsCOMPtr<nsIWebBrowserChrome> mWebBrowserChrome;
 }; // class ChromeContextMenuListener
 #endif /* nsDocShellTreeOwner_h__ */

The Tor Browser / annotate

embedding/browser/webBrowser/nsDocShellTreeOwner.h@129ffea94266 (annotated)

embedding/browser/webBrowser/nsDocShellTreeOwner.h