diff options
Diffstat (limited to 'dom/base/nsGlobalWindowOuter.h')
| -rw-r--r-- | dom/base/nsGlobalWindowOuter.h | 1236 |
1 files changed, 1236 insertions, 0 deletions
diff --git a/dom/base/nsGlobalWindowOuter.h b/dom/base/nsGlobalWindowOuter.h new file mode 100644 index 0000000000..6b3001df08 --- /dev/null +++ b/dom/base/nsGlobalWindowOuter.h @@ -0,0 +1,1236 @@ +/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ +/* vim: set ts=8 sts=2 et sw=2 tw=80: */ +/* 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 nsGlobalWindowOuter_h___ +#define nsGlobalWindowOuter_h___ + +#include "nsPIDOMWindow.h" + +#include "nsTHashtable.h" +#include "nsHashKeys.h" +#include "nsRefPtrHashtable.h" +#include "nsInterfaceHashtable.h" + +// Local Includes +// Helper Classes +#include "nsCOMPtr.h" +#include "nsWeakReference.h" +#include "nsTHashMap.h" +#include "nsCycleCollectionParticipant.h" + +// Interfaces Needed +#include "nsIBrowserDOMWindow.h" +#include "nsIInterfaceRequestor.h" +#include "nsIDOMChromeWindow.h" +#include "nsIScriptGlobalObject.h" +#include "nsIScriptObjectPrincipal.h" +#include "mozilla/EventListenerManager.h" +#include "nsIPrincipal.h" +#include "nsSize.h" +#include "mozilla/FlushType.h" +#include "prclist.h" +#include "mozilla/dom/BindingDeclarations.h" +#include "mozilla/dom/ChromeMessageBroadcaster.h" +#include "mozilla/dom/PopupBlocker.h" +#include "mozilla/dom/StorageEvent.h" +#include "mozilla/dom/StorageEventBinding.h" +#include "mozilla/dom/UnionTypes.h" +#include "mozilla/Attributes.h" +#include "mozilla/LinkedList.h" +#include "nsWrapperCacheInlines.h" +#include "mozilla/dom/EventTarget.h" +#include "mozilla/dom/WindowBinding.h" +#include "Units.h" +#include "nsComponentManagerUtils.h" +#include "nsCheapSets.h" +#include "mozilla/dom/ImageBitmapSource.h" +#include "mozilla/UniquePtr.h" +#include "mozilla/dom/BrowsingContext.h" +#include "X11UndefineNone.h" + +class nsDocShell; +class nsIArray; +class nsIBaseWindow; +class nsIContent; +class nsICSSDeclaration; +class nsIDocShellTreeOwner; +class nsIDOMWindowUtils; +class nsIScrollableFrame; +class nsIControllers; +class nsIPrintSettings; +class nsIScriptContext; +class nsIScriptTimeoutHandler; +class nsIBrowserChild; +class nsITimeoutHandler; +class nsIWebBrowserChrome; +class nsIWebProgressListener; +class mozIDOMWindowProxy; + +class nsDocShellLoadState; +class nsScreen; +class nsHistory; +class nsGlobalWindowObserver; +class nsGlobalWindowInner; +class nsDOMWindowUtils; +struct nsRect; + +class nsWindowSizes; + +namespace mozilla { +class AbstractThread; +class DOMEventTargetHelper; +class ErrorResult; +class ThrottledEventQueue; +namespace dom { +class BarProp; +struct ChannelPixelLayout; +class Console; +class Crypto; +class CustomElementRegistry; +class DocGroup; +class Document; +class External; +class Function; +class Gamepad; +enum class ImageBitmapFormat : uint8_t; +class IncrementalRunnable; +class IntlUtils; +class Location; +class MediaQueryList; +class Navigator; +class OwningExternalOrWindowProxy; +class Promise; +class PostMessageData; +class PostMessageEvent; +class PrintPreviewResultInfo; +struct RequestInit; +class RequestOrUSVString; +class Selection; +struct SizeToContentConstraints; +class SpeechSynthesis; +class Timeout; +class U2F; +class VRDisplay; +enum class VRDisplayEventReason : uint8_t; +class VREventObserver; +class WakeLock; +class Worklet; +namespace cache { +class CacheStorage; +} // namespace cache +class IDBFactory; +} // namespace dom +namespace layout { +class RemotePrintJobChild; +} // namespace layout +} // namespace mozilla + +extern already_AddRefed<nsIScriptTimeoutHandler> NS_CreateJSTimeoutHandler( + JSContext* aCx, nsGlobalWindowInner* aWindow, + mozilla::dom::Function& aFunction, + const mozilla::dom::Sequence<JS::Value>& aArguments, + mozilla::ErrorResult& aError); + +extern already_AddRefed<nsIScriptTimeoutHandler> NS_CreateJSTimeoutHandler( + JSContext* aCx, nsGlobalWindowInner* aWindow, const nsAString& aExpression, + mozilla::ErrorResult& aError); + +extern const JSClass OuterWindowProxyClass; + +//***************************************************************************** +// nsGlobalWindowOuter +//***************************************************************************** + +// nsGlobalWindowOuter inherits PRCList for maintaining a list of all inner +// windows still in memory for any given outer window. This list is needed to +// ensure that mOuterWindow doesn't end up dangling. The nature of PRCList means +// that the window itself is always in the list, and an outer window's list will +// also contain all inner window objects that are still in memory (and in +// reality all inner window object's lists also contain its outer and all other +// inner windows belonging to the same outer window, but that's an unimportant +// side effect of inheriting PRCList). + +class nsGlobalWindowOuter final : public mozilla::dom::EventTarget, + public nsPIDOMWindowOuter, + private nsIDOMWindow + // NOTE: This interface is private, as it's only + // implemented on chrome windows. + , + private nsIDOMChromeWindow, + public nsIScriptGlobalObject, + public nsIScriptObjectPrincipal, + public nsSupportsWeakReference, + public nsIInterfaceRequestor, + public PRCListStr { + public: + using OuterWindowByIdTable = + nsTHashMap<nsUint64HashKey, nsGlobalWindowOuter*>; + + using PrintPreviewResolver = + std::function<void(const mozilla::dom::PrintPreviewResultInfo&)>; + + static void AssertIsOnMainThread() +#ifdef DEBUG + ; +#else + { + } +#endif + + static nsGlobalWindowOuter* Cast(nsPIDOMWindowOuter* aPIWin) { + return static_cast<nsGlobalWindowOuter*>(aPIWin); + } + static const nsGlobalWindowOuter* Cast(const nsPIDOMWindowOuter* aPIWin) { + return static_cast<const nsGlobalWindowOuter*>(aPIWin); + } + static nsGlobalWindowOuter* Cast(mozIDOMWindowProxy* aWin) { + return Cast(nsPIDOMWindowOuter::From(aWin)); + } + + bool IsOuterWindow() const final { return true; } // Overriding EventTarget + + static nsGlobalWindowOuter* GetOuterWindowWithId(uint64_t aWindowID) { + AssertIsOnMainThread(); + + if (!sOuterWindowsById) { + return nullptr; + } + + nsGlobalWindowOuter* outerWindow = sOuterWindowsById->Get(aWindowID); + return outerWindow; + } + + static OuterWindowByIdTable* GetWindowsTable() { + AssertIsOnMainThread(); + + return sOuterWindowsById; + } + + static nsGlobalWindowOuter* FromSupports(nsISupports* supports) { + // Make sure this matches the casts we do in QueryInterface(). + return (nsGlobalWindowOuter*)(mozilla::dom::EventTarget*)supports; + } + + static already_AddRefed<nsGlobalWindowOuter> Create(nsDocShell* aDocShell, + bool aIsChrome); + + // public methods + nsPIDOMWindowOuter* GetPrivateParent(); + + // callback for close event + void ReallyCloseWindow(); + + // nsISupports + NS_DECL_CYCLE_COLLECTING_ISUPPORTS + + // nsWrapperCache + virtual JSObject* WrapObject(JSContext* cx, + JS::Handle<JSObject*> aGivenProto) override { + return EnsureInnerWindow() ? GetWrapper() : nullptr; + } + + // nsIGlobalObject + bool ShouldResistFingerprinting( + RFPTarget aTarget = RFPTarget::Unknown) const final; + mozilla::OriginTrials Trials() const final; + mozilla::dom::FontFaceSet* GetFonts() final; + + // nsIGlobalJSObjectHolder + JSObject* GetGlobalJSObject() final { return GetWrapper(); } + JSObject* GetGlobalJSObjectPreserveColor() const final { + return GetWrapperPreserveColor(); + } + + virtual nsresult EnsureScriptEnvironment() override; + + virtual nsIScriptContext* GetScriptContext() override; + + void PoisonOuterWindowProxy(JSObject* aObject); + + virtual bool IsBlackForCC(bool aTracingNeeded = true) override; + + // nsIScriptObjectPrincipal + virtual nsIPrincipal* GetPrincipal() override; + + virtual nsIPrincipal* GetEffectiveCookiePrincipal() override; + + virtual nsIPrincipal* GetEffectiveStoragePrincipal() override; + + virtual nsIPrincipal* PartitionedPrincipal() override; + + // nsIDOMWindow + NS_DECL_NSIDOMWINDOW + + // nsIDOMChromeWindow (only implemented on chrome windows) + NS_DECL_NSIDOMCHROMEWINDOW + + mozilla::dom::ChromeMessageBroadcaster* GetMessageManager(); + mozilla::dom::ChromeMessageBroadcaster* GetGroupMessageManager( + const nsAString& aGroup); + + nsresult OpenJS(const nsAString& aUrl, const nsAString& aName, + const nsAString& aOptions, + mozilla::dom::BrowsingContext** _retval); + + virtual mozilla::EventListenerManager* GetExistingListenerManager() + const override; + + virtual mozilla::EventListenerManager* GetOrCreateListenerManager() override; + + bool ComputeDefaultWantsUntrusted(mozilla::ErrorResult& aRv) final; + + virtual nsPIDOMWindowOuter* GetOwnerGlobalForBindingsInternal() override; + + virtual nsIGlobalObject* GetOwnerGlobal() const override; + + EventTarget* GetTargetForEventTargetChain() override; + + using mozilla::dom::EventTarget::DispatchEvent; + bool DispatchEvent(mozilla::dom::Event& aEvent, + mozilla::dom::CallerType aCallerType, + mozilla::ErrorResult& aRv) override; + + void GetEventTargetParent(mozilla::EventChainPreVisitor& aVisitor) override; + + nsresult PostHandleEvent(mozilla::EventChainPostVisitor& aVisitor) override; + + // nsPIDOMWindow + virtual nsPIDOMWindowOuter* GetPrivateRoot() override; + + // Outer windows only. + virtual void SetIsBackground(bool aIsBackground) override; + virtual void SetChromeEventHandler( + mozilla::dom::EventTarget* aChromeEventHandler) override; + + // Outer windows only. + virtual void SetInitialPrincipal( + nsIPrincipal* aNewWindowPrincipal, nsIContentSecurityPolicy* aCSP, + const mozilla::Maybe<nsILoadInfo::CrossOriginEmbedderPolicy>& aCoep) + override; + + virtual already_AddRefed<nsISupports> SaveWindowState() override; + MOZ_CAN_RUN_SCRIPT_BOUNDARY virtual nsresult RestoreWindowState( + nsISupports* aState) override; + + virtual bool IsSuspended() const override; + virtual bool IsFrozen() const override; + + virtual nsresult FireDelayedDOMEvents(bool aIncludeSubWindows) override; + + // Outer windows only. + bool WouldReuseInnerWindow(Document* aNewDocument); + + void DetachFromDocShell(bool aIsBeingDiscarded); + + virtual nsresult SetNewDocument( + Document* aDocument, nsISupports* aState, bool aForceReuseInnerWindow, + mozilla::dom::WindowGlobalChild* aActor = nullptr) override; + + // Outer windows only. + static void PrepareForProcessChange(JSObject* aProxy); + + // Outer windows only. + void DispatchDOMWindowCreated(); + + // Outer windows only. + virtual void EnsureSizeAndPositionUpToDate() override; + + virtual void SuppressEventHandling() override; + virtual void UnsuppressEventHandling() override; + + MOZ_CAN_RUN_SCRIPT_BOUNDARY virtual nsGlobalWindowOuter* EnterModalState() + override; + virtual void LeaveModalState() override; + + // Outer windows only. + virtual bool CanClose() override; + virtual void ForceClose() override; + + // Outer windows only. + virtual bool DispatchCustomEvent( + const nsAString& aEventName, + mozilla::ChromeOnlyDispatch aChromeOnlyDispatch) override; + bool DispatchResizeEvent(const mozilla::CSSIntSize& aSize); + + // For accessing protected field mFullscreen + friend class FullscreenTransitionTask; + + // Outer windows only. + nsresult SetFullscreenInternal(FullscreenReason aReason, + bool aIsFullscreen) final; + void FullscreenWillChange(bool aIsFullscreen) final; + void FinishFullscreenChange(bool aIsFullscreen) final; + void ForceFullScreenInWidget() final; + void MacFullscreenMenubarOverlapChanged( + mozilla::DesktopCoord aOverlapAmount) final; + bool SetWidgetFullscreen(FullscreenReason aReason, bool aIsFullscreen, + nsIWidget* aWidget); + bool Fullscreen() const; + + // nsIInterfaceRequestor + NS_DECL_NSIINTERFACEREQUESTOR + + mozilla::dom::Nullable<mozilla::dom::WindowProxyHolder> IndexedGetterOuter( + uint32_t aIndex); + + already_AddRefed<nsPIDOMWindowOuter> GetInProcessTop() override; + // Similar to GetInProcessTop() except that it stops at content frames that + // an extension has permission to access. This is used by the third-party + // util service in order to determine the top window for a channel which is + // used in third-partiness checks. + already_AddRefed<nsPIDOMWindowOuter> + GetTopExcludingExtensionAccessibleContentFrames(nsIURI* aURIBeingLoaded); + nsPIDOMWindowOuter* GetInProcessScriptableTop() override; + inline nsGlobalWindowOuter* GetInProcessTopInternal(); + + inline nsGlobalWindowOuter* GetInProcessScriptableTopInternal(); + + already_AddRefed<mozilla::dom::BrowsingContext> GetChildWindow( + const nsAString& aName); + + // Returns true if we've reached the state in windows of this BC group + // where we ask the user if further dialogs should be blocked. + // + // This function is implemented in terms of + // BrowsingContextGroup::DialogsAreBeingAbused. + bool ShouldPromptToBlockDialogs(); + + // These functions are used for controlling and determining whether dialogs + // (alert, prompt, confirm) are currently allowed in this browsing context + // group. If you want to temporarily disable dialogs, please use + // TemporarilyDisableDialogs, not EnableDialogs/DisableDialogs, because + // correctly determining whether to re-enable dialogs is actually quite + // difficult. + void EnableDialogs(); + void DisableDialogs(); + // Outer windows only. + bool AreDialogsEnabled(); + + class MOZ_RAII TemporarilyDisableDialogs { + public: + explicit TemporarilyDisableDialogs(mozilla::dom::BrowsingContext* aBC); + ~TemporarilyDisableDialogs(); + + private: + // This is the browsing context group whose dialog state we messed + // with. We just want to keep it alive, because we plan to poke at its + // members in our destructor. + RefPtr<mozilla::dom::BrowsingContextGroup> mGroup; + // This is not a AutoRestore<bool> because that would require careful + // member destructor ordering, which is a bit fragile. This way we can + // explicitly restore things before we drop our ref to mGroup. + bool mSavedDialogsEnabled = false; + }; + friend class TemporarilyDisableDialogs; + + nsIScriptContext* GetContextInternal(); + + nsGlobalWindowInner* GetCurrentInnerWindowInternal() const; + + nsGlobalWindowInner* EnsureInnerWindowInternal(); + + bool IsCreatingInnerWindow() const { return mCreatingInnerWindow; } + + bool IsChromeWindow() const { return mIsChrome; } + + // GetScrollFrame does not flush. Callers should do it themselves as needed, + // depending on which info they actually want off the scrollable frame. + nsIScrollableFrame* GetScrollFrame(); + + // Outer windows only. + void UnblockScriptedClosing(); + + static void Init(); + static void ShutDown(); + static bool IsCallerChrome(); + + friend class WindowStateHolder; + + NS_DECL_CYCLE_COLLECTION_SKIPPABLE_SCRIPT_HOLDER_CLASS_AMBIGUOUS( + nsGlobalWindowOuter, mozilla::dom::EventTarget) + + virtual bool TakeFocus(bool aFocus, uint32_t aFocusMethod) override; + virtual void SetReadyForFocus() override; + virtual void PageHidden() override; + + /** + * Set a arguments for this window. This will be set on the window + * right away (if there's an existing document) and it will also be + * installed on the window when the next document is loaded. + * + * This function passes |arguments| back from nsWindowWatcher to + * nsGlobalWindow. + */ + nsresult SetArguments(nsIArray* aArguments); + + bool IsClosedOrClosing() { + return (mIsClosed || mInClose || mHavePendingClose || mCleanedUp); + } + + bool IsCleanedUp() const { return mCleanedUp; } + + virtual void FirePopupBlockedEvent( + Document* aDoc, nsIURI* aPopupURI, const nsAString& aPopupWindowName, + const nsAString& aPopupWindowFeatures) override; + + void AddSizeOfIncludingThis(nsWindowSizes& aWindowSizes) const; + + void AllowScriptsToClose() { mAllowScriptsToClose = true; } + + // Outer windows only. + uint32_t GetAutoActivateVRDisplayID(); + // Outer windows only. + void SetAutoActivateVRDisplayID(uint32_t aAutoActivateVRDisplayID); + +#define EVENT(name_, id_, type_, struct_) \ + mozilla::dom::EventHandlerNonNull* GetOn##name_() { \ + mozilla::EventListenerManager* elm = GetExistingListenerManager(); \ + return elm ? elm->GetEventHandler(nsGkAtoms::on##name_) : nullptr; \ + } \ + void SetOn##name_(mozilla::dom::EventHandlerNonNull* handler) { \ + mozilla::EventListenerManager* elm = GetOrCreateListenerManager(); \ + if (elm) { \ + elm->SetEventHandler(nsGkAtoms::on##name_, handler); \ + } \ + } +#define ERROR_EVENT(name_, id_, type_, struct_) \ + mozilla::dom::OnErrorEventHandlerNonNull* GetOn##name_() { \ + mozilla::EventListenerManager* elm = GetExistingListenerManager(); \ + return elm ? elm->GetOnErrorEventHandler() : nullptr; \ + } \ + void SetOn##name_(mozilla::dom::OnErrorEventHandlerNonNull* handler) { \ + mozilla::EventListenerManager* elm = GetOrCreateListenerManager(); \ + if (elm) { \ + elm->SetEventHandler(handler); \ + } \ + } +#define BEFOREUNLOAD_EVENT(name_, id_, type_, struct_) \ + mozilla::dom::OnBeforeUnloadEventHandlerNonNull* GetOn##name_() { \ + mozilla::EventListenerManager* elm = GetExistingListenerManager(); \ + return elm ? elm->GetOnBeforeUnloadEventHandler() : nullptr; \ + } \ + void SetOn##name_( \ + mozilla::dom::OnBeforeUnloadEventHandlerNonNull* handler) { \ + mozilla::EventListenerManager* elm = GetOrCreateListenerManager(); \ + if (elm) { \ + elm->SetEventHandler(handler); \ + } \ + } +#define WINDOW_ONLY_EVENT EVENT +#define TOUCH_EVENT EVENT +#include "mozilla/EventNameList.h" +#undef TOUCH_EVENT +#undef WINDOW_ONLY_EVENT +#undef BEFOREUNLOAD_EVENT +#undef ERROR_EVENT +#undef EVENT + + nsISupports* GetParentObject() { return nullptr; } + + Document* GetDocument() { return GetDoc(); } + void GetNameOuter(nsAString& aName); + void SetNameOuter(const nsAString& aName, mozilla::ErrorResult& aError); + mozilla::dom::Location* GetLocation() override; + void GetStatusOuter(nsAString& aStatus); + void SetStatusOuter(const nsAString& aStatus); + void CloseOuter(bool aTrustedCaller); + nsresult Close() override; + bool GetClosedOuter(); + bool Closed() override; + void StopOuter(mozilla::ErrorResult& aError); + // TODO: Convert FocusOuter() to MOZ_CAN_RUN_SCRIPT and get rid of the + // kungFuDeathGrip in it. + MOZ_CAN_RUN_SCRIPT_BOUNDARY void FocusOuter( + mozilla::dom::CallerType aCallerType, bool aFromOtherProcess, + uint64_t aActionId); + nsresult Focus(mozilla::dom::CallerType aCallerType) override; + // TODO: Convert BlurOuter() to MOZ_CAN_RUN_SCRIPT and get rid of the + // kungFuDeathGrip in it. + MOZ_CAN_RUN_SCRIPT_BOUNDARY void BlurOuter( + mozilla::dom::CallerType aCallerType); + mozilla::dom::WindowProxyHolder GetFramesOuter(); + uint32_t Length(); + mozilla::dom::Nullable<mozilla::dom::WindowProxyHolder> GetTopOuter(); + + nsresult GetPrompter(nsIPrompt** aPrompt) override; + + protected: + mozilla::dom::Nullable<mozilla::dom::WindowProxyHolder> + GetOpenerWindowOuter(); + // Initializes the mWasOffline member variable + void InitWasOffline(); + + public: + nsPIDOMWindowOuter* GetSameProcessOpener(); + already_AddRefed<mozilla::dom::BrowsingContext> GetOpenerBrowsingContext(); + mozilla::dom::Nullable<mozilla::dom::WindowProxyHolder> GetOpener() override; + mozilla::dom::Nullable<mozilla::dom::WindowProxyHolder> GetParentOuter(); + already_AddRefed<nsPIDOMWindowOuter> GetInProcessParent() override; + nsPIDOMWindowOuter* GetInProcessScriptableParent() override; + nsPIDOMWindowOuter* GetInProcessScriptableParentOrNull() override; + mozilla::dom::Element* GetFrameElement(nsIPrincipal& aSubjectPrincipal); + mozilla::dom::Element* GetFrameElement() override; + mozilla::dom::Nullable<mozilla::dom::WindowProxyHolder> OpenOuter( + const nsAString& aUrl, const nsAString& aName, const nsAString& aOptions, + mozilla::ErrorResult& aError); + nsresult Open(const nsAString& aUrl, const nsAString& aName, + const nsAString& aOptions, nsDocShellLoadState* aLoadState, + bool aForceNoOpener, + mozilla::dom::BrowsingContext** _retval) override; + mozilla::dom::Navigator* GetNavigator() override; + + protected: + bool AlertOrConfirm(bool aAlert, const nsAString& aMessage, + nsIPrincipal& aSubjectPrincipal, + mozilla::ErrorResult& aError); + + public: + void AlertOuter(const nsAString& aMessage, nsIPrincipal& aSubjectPrincipal, + mozilla::ErrorResult& aError); + bool ConfirmOuter(const nsAString& aMessage, nsIPrincipal& aSubjectPrincipal, + mozilla::ErrorResult& aError); + void PromptOuter(const nsAString& aMessage, const nsAString& aInitial, + nsAString& aReturn, nsIPrincipal& aSubjectPrincipal, + mozilla::ErrorResult& aError); + + MOZ_CAN_RUN_SCRIPT void PrintOuter(mozilla::ErrorResult& aError); + + enum class IsPreview : bool { No, Yes }; + enum class IsForWindowDotPrint : bool { No, Yes }; + MOZ_CAN_RUN_SCRIPT mozilla::dom::Nullable<mozilla::dom::WindowProxyHolder> + Print(nsIPrintSettings*, + mozilla::layout::RemotePrintJobChild* aRemotePrintJob, + nsIWebProgressListener*, nsIDocShell*, IsPreview, IsForWindowDotPrint, + PrintPreviewResolver&&, mozilla::ErrorResult&); + mozilla::dom::Selection* GetSelectionOuter(); + already_AddRefed<mozilla::dom::Selection> GetSelection() override; + nsScreen* GetScreen(); + void MoveToOuter(int32_t aXPos, int32_t aYPos, + mozilla::dom::CallerType aCallerType, + mozilla::ErrorResult& aError); + void MoveByOuter(int32_t aXDif, int32_t aYDif, + mozilla::dom::CallerType aCallerType, + mozilla::ErrorResult& aError); + nsresult MoveBy(int32_t aXDif, int32_t aYDif) override; + void ResizeToOuter(int32_t aWidth, int32_t aHeight, + mozilla::dom::CallerType aCallerType, + mozilla::ErrorResult& aError); + void ResizeByOuter(int32_t aWidthDif, int32_t aHeightDif, + mozilla::dom::CallerType aCallerType, + mozilla::ErrorResult& aError); + double GetScrollXOuter(); + double GetScrollYOuter(); + + MOZ_CAN_RUN_SCRIPT_BOUNDARY + void SizeToContentOuter(mozilla::dom::CallerType, + const mozilla::dom::SizeToContentConstraints&, + mozilla::ErrorResult&); + nsIControllers* GetControllersOuter(mozilla::ErrorResult& aError); + nsresult GetControllers(nsIControllers** aControllers) override; + float GetMozInnerScreenXOuter(mozilla::dom::CallerType aCallerType); + float GetMozInnerScreenYOuter(mozilla::dom::CallerType aCallerType); + bool GetFullscreenOuter(); + bool GetFullScreen() override; + void SetFullscreenOuter(bool aFullscreen, mozilla::ErrorResult& aError); + nsresult SetFullScreen(bool aFullscreen) override; + bool FindOuter(const nsAString& aString, bool aCaseSensitive, bool aBackwards, + bool aWrapAround, bool aWholeWord, bool aSearchInFrames, + bool aShowDialog, mozilla::ErrorResult& aError); + + mozilla::dom::Nullable<mozilla::dom::WindowProxyHolder> OpenDialogOuter( + JSContext* aCx, const nsAString& aUrl, const nsAString& aName, + const nsAString& aOptions, + const mozilla::dom::Sequence<JS::Value>& aExtraArgument, + mozilla::ErrorResult& aError); + nsresult OpenDialog(const nsAString& aUrl, const nsAString& aName, + const nsAString& aOptions, nsISupports* aExtraArgument, + mozilla::dom::BrowsingContext** _retval) override; + void UpdateCommands(const nsAString& anAction, mozilla::dom::Selection* aSel, + int16_t aReason) override; + + already_AddRefed<mozilla::dom::BrowsingContext> GetContentInternal( + mozilla::dom::CallerType aCallerType, mozilla::ErrorResult& aError); + void GetContentOuter(JSContext* aCx, JS::MutableHandle<JSObject*> aRetval, + mozilla::dom::CallerType aCallerType, + mozilla::ErrorResult& aError); + + // ChromeWindow bits. Do NOT call these unless your window is in + // fact chrome. + nsIBrowserDOMWindow* GetBrowserDOMWindowOuter(); + void SetBrowserDOMWindowOuter(nsIBrowserDOMWindow* aBrowserWindow); + void SetCursorOuter(const nsACString& aCursor, mozilla::ErrorResult& aError); + + void GetReturnValueOuter(JSContext* aCx, + JS::MutableHandle<JS::Value> aReturnValue, + nsIPrincipal& aSubjectPrincipal, + mozilla::ErrorResult& aError); + void GetReturnValue(JSContext* aCx, JS::MutableHandle<JS::Value> aReturnValue, + nsIPrincipal& aSubjectPrincipal, + mozilla::ErrorResult& aError); + void SetReturnValueOuter(JSContext* aCx, JS::Handle<JS::Value> aReturnValue, + nsIPrincipal& aSubjectPrincipal, + mozilla::ErrorResult& aError); + void SetReturnValue(JSContext* aCx, JS::Handle<JS::Value> aReturnValue, + nsIPrincipal& aSubjectPrincipal, + mozilla::ErrorResult& aError); + + already_AddRefed<nsWindowRoot> GetWindowRootOuter(); + + nsIDOMWindowUtils* WindowUtils(); + + virtual bool IsInSyncOperation() override; + + public: + double GetInnerWidthOuter(mozilla::ErrorResult& aError); + + protected: + nsresult GetInnerWidth(double* aInnerWidth) override; + void SetInnerWidthOuter(double aInnerWidth, + mozilla::dom::CallerType aCallerType, + mozilla::ErrorResult& aError); + + public: + double GetInnerHeightOuter(mozilla::ErrorResult& aError); + + protected: + nsresult GetInnerHeight(double* aInnerHeight) override; + void SetInnerHeightOuter(double aInnerHeight, + mozilla::dom::CallerType aCallerType, + mozilla::ErrorResult& aError); + int32_t GetScreenXOuter(mozilla::dom::CallerType aCallerType, + mozilla::ErrorResult& aError); + void SetScreenXOuter(int32_t aScreenX, mozilla::dom::CallerType aCallerType, + mozilla::ErrorResult& aError); + int32_t GetScreenYOuter(mozilla::dom::CallerType aCallerType, + mozilla::ErrorResult& aError); + void SetScreenYOuter(int32_t aScreenY, mozilla::dom::CallerType aCallerType, + mozilla::ErrorResult& aError); + int32_t GetOuterWidthOuter(mozilla::dom::CallerType aCallerType, + mozilla::ErrorResult& aError); + void SetOuterWidthOuter(int32_t aOuterWidth, + mozilla::dom::CallerType aCallerType, + mozilla::ErrorResult& aError); + int32_t GetOuterHeightOuter(mozilla::dom::CallerType aCallerType, + mozilla::ErrorResult& aError); + void SetOuterHeightOuter(int32_t aOuterHeight, + mozilla::dom::CallerType aCallerType, + mozilla::ErrorResult& aError); + + friend class HashchangeCallback; + friend class mozilla::dom::BarProp; + + // Object Management + virtual ~nsGlobalWindowOuter(); + void DropOuterWindowDocs(); + void CleanUp(); + void ClearControllers(); + // Outer windows only. + void FinalClose(); + + inline void MaybeClearInnerWindow(nsGlobalWindowInner* aExpectedInner); + + // Get the parent, returns null if this is a toplevel window + nsPIDOMWindowOuter* GetInProcessParentInternal(); + + protected: + // Window Control Functions + + // Outer windows only. + virtual nsresult OpenNoNavigate( + const nsAString& aUrl, const nsAString& aName, const nsAString& aOptions, + mozilla::dom::BrowsingContext** _retval) override; + + private: + explicit nsGlobalWindowOuter(uint64_t aWindowID); + + enum class PrintKind : uint8_t { None, InternalPrint, WindowDotPrint }; + + /** + * @param aUrl the URL we intend to load into the window. If aNavigate is + * true, we'll actually load this URL into the window. Otherwise, + * aUrl is advisory; OpenInternal will not load the URL into the + * new window. + * + * @param aName the name to use for the new window + * + * @param aOptions the window options to use for the new window + * + * @param aDialog true when called from variants of OpenDialog. If this is + * true, this method will skip popup blocking checks. The aDialog + * argument is passed on to the window watcher. + * + * @param aCalledNoScript true when called via the [noscript] open() + * and openDialog() methods. When this is true, we do NOT want to use + * the JS stack for things like caller determination. + * + * @param aDoJSFixups true when this is the content-accessible JS version of + * window opening. When true, popups do not cause us to throw, we save + * the caller's principal in the new window for later consumption, and + * we make sure that there is a document in the newly-opened window. + * Note that this last will only be done if the newly-opened window is + * non-chrome. + * + * @param aNavigate true if we should navigate to the provided URL, false + * otherwise. When aNavigate is false, we also skip our can-load + * security check, on the assumption that whoever *actually* loads this + * page will do their own security check. + * + * @param argv The arguments to pass to the new window. The first + * three args, if present, will be aUrl, aName, and aOptions. So this + * param only matters if there are more than 3 arguments. + * + * @param aExtraArgument Another way to pass arguments in. This is mutually + * exclusive with the argv approach. + * + * @param aLoadState to be passed on along to the windowwatcher. + * + * @param aForceNoOpener if true, will act as if "noopener" were passed in + * aOptions, but without affecting any other window + * features. + * + * @param aPrintKind Whether this is a browser created for printing, and + * if so for which kind of print. + * + * @param aReturn [out] The window that was opened, if any. Will be null if + * aForceNoOpener is true of if aOptions contains + * "noopener". + * + * Outer windows only. + */ + nsresult OpenInternal(const nsAString& aUrl, const nsAString& aName, + const nsAString& aOptions, bool aDialog, + bool aContentModal, bool aCalledNoScript, + bool aDoJSFixups, bool aNavigate, nsIArray* argv, + nsISupports* aExtraArgument, + nsDocShellLoadState* aLoadState, bool aForceNoOpener, + PrintKind aPrintKind, + mozilla::dom::BrowsingContext** aReturn); + + public: + nsresult SecurityCheckURL(const char* aURL, nsIURI** aURI); + + mozilla::dom::PopupBlocker::PopupControlState RevisePopupAbuseLevel( + mozilla::dom::PopupBlocker::PopupControlState aState); + void FireAbuseEvents(const nsAString& aPopupURL, + const nsAString& aPopupWindowName, + const nsAString& aPopupWindowFeatures); + + void FlushPendingNotifications(mozilla::FlushType aType); + + // Outer windows only. + void EnsureReflowFlushAndPaint(); + void CheckSecurityWidthAndHeight(int32_t* width, int32_t* height, + mozilla::dom::CallerType aCallerType); + void CheckSecurityLeftAndTop(int32_t* left, int32_t* top, + mozilla::dom::CallerType aCallerType); + + // Outer windows only. + // Arguments to this function should have values in app units + void SetCSSViewportWidthAndHeight(nscoord width, nscoord height); + + static bool CanSetProperty(const char* aPrefName); + + static void MakeMessageWithPrincipal(nsAString& aOutMessage, + nsIPrincipal* aSubjectPrincipal, + bool aUseHostPort, + const char* aNullMessage, + const char* aContentMessage, + const char* aFallbackMessage); + + // Outer windows only. + MOZ_CAN_RUN_SCRIPT_BOUNDARY + bool CanMoveResizeWindows(mozilla::dom::CallerType aCallerType); + + // If aDoFlush is true, we'll flush our own layout; otherwise we'll try to + // just flush our parent and only flush ourselves if we think we need to. + // Outer windows only. + mozilla::CSSPoint GetScrollXY(bool aDoFlush); + + int32_t GetScrollBoundaryOuter(mozilla::Side aSide); + + // Outer windows only. + nsresult GetInnerSize(mozilla::CSSSize& aSize); + mozilla::CSSIntSize GetOuterSize(mozilla::dom::CallerType aCallerType, + mozilla::ErrorResult& aError); + void SetOuterSize(int32_t aLengthCSSPixels, bool aIsWidth, + mozilla::dom::CallerType aCallerType, + mozilla::ErrorResult& aError); + void SetInnerSize(int32_t aLengthCSSPixels, bool aIsWidth, + mozilla::dom::CallerType aCallerType, + mozilla::ErrorResult& aError); + void SetScreenCoord(int32_t aCoordCSSPixels, bool aIsX, + mozilla::dom::CallerType aCallerType, + mozilla::ErrorResult& aError); + nsRect GetInnerScreenRect(); + static mozilla::Maybe<mozilla::CSSIntSize> GetRDMDeviceSize( + const Document& aDocument); + + // Outer windows only. + // If aLookForCallerOnJSStack is true, this method will look at the JS stack + // to determine who the caller is. If it's false, it'll use |this| as the + // caller. + bool WindowExists(const nsAString& aName, bool aForceNoOpener, + bool aLookForCallerOnJSStack); + + already_AddRefed<nsIWidget> GetMainWidget(); + nsIWidget* GetNearestWidget() const; + + bool IsInModalState(); + + // Convenience functions for the methods which call methods of nsIBaseWindow + // because it takes/returns device pixels. Unfortunately, mPresContext may + // have older scale value for the corresponding widget. Therefore, these + // helper methods convert between CSS pixels and device pixels with aWindow. + // + // FIXME(emilio): Seems like updating the pres context dpi sync shouldn't be + // all that much work and should avoid some hackiness? + mozilla::CSSToLayoutDeviceScale CSSToDevScaleForBaseWindow(nsIBaseWindow*); + + void SetFocusedElement(mozilla::dom::Element* aElement, + uint32_t aFocusMethod = 0, + bool aNeedsFocus = false) override; + + uint32_t GetFocusMethod() override; + + bool ShouldShowFocusRing() override; + + public: + already_AddRefed<nsPIWindowRoot> GetTopWindowRoot() override; + + protected: + void NotifyWindowIDDestroyed(const char* aTopic); + + void ClearStatus(); + + void UpdateParentTarget() override; + + protected: + // Helper for getComputedStyle and getDefaultComputedStyle + already_AddRefed<nsICSSDeclaration> GetComputedStyleHelperOuter( + mozilla::dom::Element& aElt, const nsAString& aPseudoElt, + bool aDefaultStylesOnly, mozilla::ErrorResult& aRv); + + // Outer windows only. + void PreloadLocalStorage(); + + mozilla::CSSPoint ScreenEdgeSlop(); + mozilla::CSSCoord ScreenEdgeSlopX() { return ScreenEdgeSlop().X(); } + mozilla::CSSCoord ScreenEdgeSlopY() { return ScreenEdgeSlop().Y(); } + + // Returns CSS pixels based on primary screen. Outer windows only. + mozilla::CSSIntPoint GetScreenXY(mozilla::dom::CallerType aCallerType, + mozilla::ErrorResult& aError); + + void PostMessageMozOuter(JSContext* aCx, JS::Handle<JS::Value> aMessage, + const nsAString& aTargetOrigin, + JS::Handle<JS::Value> aTransfer, + nsIPrincipal& aSubjectPrincipal, + mozilla::ErrorResult& aError); + + public: + /** + * Compute the principal to use for checking against the target principal in a + * postMessage call. + * + * @param aTargetOrigin The value passed as the targetOrigin argument to the + * postMessage call. + * + * @param aTargetOriginURI The origin of the URI contained in aTargetOrigin + * (see GatherPostMessageData). + * + * @param aCallerPrincipal The principal of the incumbent global of the + * postMessage call (see GatherPostMessageData). + * + * @param aSubjectPrincipal The subject principal for the postMessage call. + * + * @param aProvidedPrincipal [out] The principal to use for checking against + * the target's principal. + * + * @return Whether the postMessage call should continue or return now. + */ + bool GetPrincipalForPostMessage(const nsAString& aTargetOrigin, + nsIURI* aTargetOriginURI, + nsIPrincipal* aCallerPrincipal, + nsIPrincipal& aSubjectPrincipal, + nsIPrincipal** aProvidedPrincipal); + + private: + /** + * Gather the necessary data from the caller for a postMessage call. + * + * @param aCx The JSContext. + * + * @param aTargetOrigin The value passed as the targetOrigin argument to the + * postMessage call. + * + * @param aSource [out] The browsing context for the incumbent global. + * + * @param aOrigin [out] The value to use for the origin property of the + * MessageEvent object. + * + * @param aTargetOriginURI [out] The origin of the URI contained in + * aTargetOrigin, null if aTargetOrigin is "/" or "*". + * + * @param aCallerPrincipal [out] The principal of the incumbent global of the + * postMessage call. + * + * @param aCallerInnerWindow [out] Inner window of the caller of + * postMessage, or null if the incumbent global is not a Window. + * + * @param aCallerURI [out] The URI of the document of the incumbent + * global if it's a Window, null otherwise. + * + * @param aCallerAgentCluterId [out] If a non-nullptr is passed, it would + * return the caller's agent cluster id. + * + * @param aScriptLocation [out] If we do not have a caller's URI, then + * use script location as a sourcename for creating an error object. + * + * @param aError [out] The error, if any. + * + * @return Whether the postMessage call should continue or return now. + */ + static bool GatherPostMessageData( + JSContext* aCx, const nsAString& aTargetOrigin, + mozilla::dom::BrowsingContext** aSource, nsAString& aOrigin, + nsIURI** aTargetOriginURI, nsIPrincipal** aCallerPrincipal, + nsGlobalWindowInner** aCallerInnerWindow, nsIURI** aCallerURI, + mozilla::Maybe<nsID>* aCallerAgentClusterId, nsACString* aScriptLocation, + mozilla::ErrorResult& aError); + + // Ask the user if further dialogs should be blocked, if dialogs are currently + // being abused. This is used in the cases where we have no modifiable UI to + // show, in that case we show a separate dialog to ask this question. + bool ConfirmDialogIfNeeded(); + + // Helper called after moving/resizing, to update docShell's presContext + // if we have caused a resolution change by moving across monitors. + void CheckForDPIChange(); + + private: + enum class SecureContextFlags { eDefault, eIgnoreOpener }; + // Called only on outer windows to compute the value that will be returned by + // IsSecureContext() for the inner window that corresponds to aDocument. + bool ComputeIsSecureContext( + Document* aDocument, + SecureContextFlags aFlags = SecureContextFlags::eDefault); + + void SetDocShell(nsDocShell* aDocShell); + + // nsPIDOMWindow{Inner,Outer} should be able to see these helper methods. + friend class nsPIDOMWindowInner; + friend class nsPIDOMWindowOuter; + + void SetIsBackgroundInternal(bool aIsBackground); + + nsresult GetInterfaceInternal(const nsIID& aIID, void** aSink); + + void MaybeAllowStorageForOpenedWindow(nsIURI* aURI); + + bool IsOnlyTopLevelDocumentInSHistory(); + + void MaybeResetWindowName(Document* aNewDocument); + + public: + bool DelayedPrintUntilAfterLoad() const { + return mDelayedPrintUntilAfterLoad; + } + + bool DelayedCloseForPrinting() const { return mDelayedCloseForPrinting; } + + void StopDelayingPrintingUntilAfterLoad() { + mShouldDelayPrintUntilAfterLoad = false; + } + + // Dispatch a runnable related to the global. + virtual nsresult Dispatch(mozilla::TaskCategory aCategory, + already_AddRefed<nsIRunnable>&& aRunnable) override; + + virtual nsISerialEventTarget* EventTargetFor( + mozilla::TaskCategory aCategory) const override; + + virtual mozilla::AbstractThread* AbstractMainThreadFor( + mozilla::TaskCategory aCategory) override; + + protected: + nsresult ProcessWidgetFullscreenRequest(FullscreenReason aReason, + bool aFullscreen); + + // Indicates whether browser window should be in fullscreen mode and the + // reason, e.g. browser fullscreen mode or DOM fullscreen API, which should + // never be ForForceExitFullscreen. Nothing if browser window should not be in + // fullscreen mode. + mozilla::Maybe<FullscreenReason> mFullscreen; + + // Indicates whether new fullscreen request have been made when previous + // fullscreen request is still in-process. + bool mFullscreenHasChangedDuringProcessing : 1; + + using FullscreenRequest = struct FullscreenRequest { + FullscreenRequest(FullscreenReason aReason, bool aFullscreen) + : mReason(aReason), mFullscreen(aFullscreen) { + MOZ_ASSERT( + mReason != FullscreenReason::ForForceExitFullscreen || !mFullscreen, + "FullscreenReason::ForForceExitFullscreen can only be used with " + "exiting fullscreen"); + } + FullscreenReason mReason; + bool mFullscreen : 1; + }; + // The current in-process fullscreen request. Nothing if there is no + // in-process request. + mozilla::Maybe<FullscreenRequest> mInProcessFullscreenRequest; + + bool mForceFullScreenInWidget : 1; + bool mIsClosed : 1; + bool mInClose : 1; + // mHavePendingClose means we've got a termination function set to + // close us when the JS stops executing or that we have a close + // event posted. If this is set, just ignore window.close() calls. + bool mHavePendingClose : 1; + + // Indicates whether scripts are allowed to close this window. + bool mBlockScriptedClosingFlag : 1; + + // Window offline status. Checked to see if we need to fire offline event + bool mWasOffline : 1; + + // Indicates whether we're in the middle of creating an initializing + // a new inner window object. + bool mCreatingInnerWindow : 1; + + // Fast way to tell if this is a chrome window (without having to QI). + bool mIsChrome : 1; + + // whether scripts may close the window, + // even if "dom.allow_scripts_to_close_windows" is false. + bool mAllowScriptsToClose : 1; + + bool mTopLevelOuterContentWindow : 1; + + // Whether we've delayed a print until after load. + bool mDelayedPrintUntilAfterLoad : 1; + // Whether we've delayed a close() operation because there was a pending + // print() operation. + bool mDelayedCloseForPrinting : 1; + // Whether we should delay printing until after load. + bool mShouldDelayPrintUntilAfterLoad : 1; + + nsCOMPtr<nsIScriptContext> mContext; + nsCOMPtr<nsIControllers> mControllers; + + // For |window.arguments|, via |openDialog|. + nsCOMPtr<nsIArray> mArguments; + + RefPtr<nsDOMWindowUtils> mWindowUtils; + nsString mStatus; + + RefPtr<mozilla::dom::Storage> mLocalStorage; + + nsCOMPtr<nsIPrincipal> mDocumentPrincipal; + nsCOMPtr<nsIPrincipal> mDocumentCookiePrincipal; + nsCOMPtr<nsIPrincipal> mDocumentStoragePrincipal; + nsCOMPtr<nsIPrincipal> mDocumentPartitionedPrincipal; + +#ifdef DEBUG + uint32_t mSerial; + + bool mSetOpenerWindowCalled; + nsCOMPtr<nsIURI> mLastOpenedURI; +#endif + + bool mCleanedUp; + + // It's useful when we get matched EnterModalState/LeaveModalState calls, in + // which case the outer window is responsible for unsuspending events on the + // documents. If we don't (for example, if the outer window is closed before + // the LeaveModalState call), then the inner window whose mDoc is in our + // mSuspendedDocs is responsible for unsuspending. + nsTArray<RefPtr<Document>> mSuspendedDocs; + + // This is the CC generation the last time we called CanSkip. + uint32_t mCanSkipCCGeneration; + + // When non-zero, the document should receive a vrdisplayactivate event + // after loading. The value is the ID of the VRDisplay that content should + // begin presentation on. + uint32_t mAutoActivateVRDisplayID; + + static OuterWindowByIdTable* sOuterWindowsById; + + // Members in the mChromeFields member should only be used in chrome windows. + // All accesses to this field should be guarded by a check of mIsChrome. + struct ChromeFields { + nsCOMPtr<nsIBrowserDOMWindow> mBrowserDOMWindow; + // A weak pointer to the PresShell that we are doing fullscreen for. + // The pointer being set indicates we've set the IsInFullscreenChange + // flag on this pres shell. + nsWeakPtr mFullscreenPresShell; + } mChromeFields; + + // Whether the chrome window is currently in a full screen transition. This + // flag is updated from FullscreenTransitionTask. + bool mIsInFullScreenTransition = false; + + friend class nsDOMScriptableHelper; + friend class nsDOMWindowUtils; + friend class mozilla::dom::BrowsingContext; + friend class mozilla::dom::PostMessageEvent; + friend class DesktopNotification; + friend class mozilla::dom::TimeoutManager; + friend class nsGlobalWindowInner; +}; + +// XXX: EWW - This is an awful hack - let's not do this +#include "nsGlobalWindowInner.h" + +inline nsISupports* ToSupports(nsGlobalWindowOuter* p) { + return static_cast<mozilla::dom::EventTarget*>(p); +} + +inline nsISupports* ToCanonicalSupports(nsGlobalWindowOuter* p) { + return static_cast<mozilla::dom::EventTarget*>(p); +} + +inline nsIGlobalObject* nsGlobalWindowOuter::GetOwnerGlobal() const { + return GetCurrentInnerWindowInternal(); +} + +inline nsGlobalWindowOuter* nsGlobalWindowOuter::GetInProcessTopInternal() { + nsCOMPtr<nsPIDOMWindowOuter> top = GetInProcessTop(); + if (top) { + return nsGlobalWindowOuter::Cast(top); + } + return nullptr; +} + +inline nsGlobalWindowOuter* +nsGlobalWindowOuter::GetInProcessScriptableTopInternal() { + nsPIDOMWindowOuter* top = GetInProcessScriptableTop(); + return nsGlobalWindowOuter::Cast(top); +} + +inline nsIScriptContext* nsGlobalWindowOuter::GetContextInternal() { + return mContext; +} + +inline nsGlobalWindowInner* nsGlobalWindowOuter::GetCurrentInnerWindowInternal() + const { + return nsGlobalWindowInner::Cast(mInnerWindow); +} + +inline nsGlobalWindowInner* nsGlobalWindowOuter::EnsureInnerWindowInternal() { + return nsGlobalWindowInner::Cast(EnsureInnerWindow()); +} + +inline void nsGlobalWindowOuter::MaybeClearInnerWindow( + nsGlobalWindowInner* aExpectedInner) { + if (mInnerWindow == aExpectedInner) { + mInnerWindow = nullptr; + } +} + +#endif /* nsGlobalWindowOuter_h___ */ |