/* 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 _nsWindowWatcher_h_
#define _nsWindowWatcher_h_

// {a21bfa01-f349-4394-a84c-8de5cf0737d0}
#define NS_WINDOWWATCHER_CID \
  {0xa21bfa01, 0xf349, 0x4394, {0xa8, 0x4c, 0x8d, 0xe5, 0xcf, 0x7, 0x37, 0xd0}}

#include "nsCOMPtr.h"
#include "Units.h"
#include "mozilla/Mutex.h"
#include "nsIWindowCreator.h"  // for stupid compilers
#include "nsIWindowWatcher.h"
#include "nsIOpenWindowInfo.h"
#include "nsIPromptFactory.h"
#include "nsIRemoteTab.h"
#include "nsPIWindowWatcher.h"
#include "nsTArray.h"
#include "mozilla/dom/UserActivation.h"  // mozilla::dom::UserActivation
#include "mozilla/dom/WindowFeatures.h"  // mozilla::dom::WindowFeatures

class nsIURI;
class nsIDocShellTreeItem;
class nsIDocShellTreeOwner;
class nsPIDOMWindowOuter;
class nsWatcherWindowEnumerator;
class nsPromptService;
struct nsWatcherWindowEntry;

class nsWindowWatcher : public nsIWindowWatcher,
                        public nsPIWindowWatcher,
                        public nsIPromptFactory {
  friend class nsWatcherWindowEnumerator;

 public:
  nsWindowWatcher();

  nsresult Init();

  NS_DECL_ISUPPORTS

  NS_DECL_NSIWINDOWWATCHER
  NS_DECL_NSPIWINDOWWATCHER
  NS_DECL_NSIPROMPTFACTORY

  static bool IsWindowOpenLocationModified(
      const mozilla::dom::UserActivation::Modifiers& aModifiers,
      int32_t* aLocation);

  static int32_t GetWindowOpenLocation(
      nsPIDOMWindowOuter* aParent, uint32_t aChromeFlags,
      const mozilla::dom::UserActivation::Modifiers& aModifiers,
      bool aCalledFromJS, bool aIsForPrinting);

  static bool HaveSpecifiedSize(const mozilla::dom::WindowFeatures& features);

  /**
   * Creates a load state from the given uri and the parent window.
   *
   * If `aParent` is present, his function will set
   *  - the triggering window id
   *  - if the triggering window has storage access
   *  - the source `BrowsingContext``
   *  - the triggering browsing context's sandbox flags
   *  - the user gesture activation flag based on the parent document
   *  - the text directive user activation flag; this will consume the parent
   *    document's flag and OR's it with the user gesture activation flag.
   * If `aIsWindowOpen` is true, history handling will be set to "auto".
   *
   * Currently, the returned load state is intended to be passed into
   * `OpenWindowInternal()`.
   * Note that the triggering principal and referrer info are not set by this
   * function.
   */
  static already_AddRefed<nsDocShellLoadState> CreateLoadState(
      nsIURI* aUri, nsPIDOMWindowOuter* aParent, bool aIsWindowOpen = false);

 protected:
  virtual ~nsWindowWatcher();

  friend class nsPromptService;
  bool AddEnumerator(nsWatcherWindowEnumerator* aEnumerator);
  bool RemoveEnumerator(nsWatcherWindowEnumerator* aEnumerator);

  nsWatcherWindowEntry* FindWindowEntry(mozIDOMWindowProxy* aWindow);
  nsresult RemoveWindow(nsWatcherWindowEntry* aInfo);

  // Just like OpenWindowJS, but knows whether it got called via OpenWindowJS
  // (which means called from script) or called via OpenWindow.
  nsresult OpenWindowInternal(
      mozIDOMWindowProxy* aParent, const nsACString& aUrl,
      const nsACString& aName, const nsACString& aFeatures,
      const mozilla::dom::UserActivation::Modifiers& aModifiers,
      bool aCalledFromJS, bool aDialog, bool aNavigate, nsIArray* aArgv,
      bool aIsPopupSpam, bool aForceNoOpener, bool aForceNoReferrer, PrintKind,
      nsDocShellLoadState* aLoadState, mozilla::dom::BrowsingContext** aResult);
  nsresult OpenWindowInternal(
      mozIDOMWindowProxy* aParent, nsIURI* aUri, const nsACString& aName,
      const nsACString& aFeatures,
      const mozilla::dom::UserActivation::Modifiers& aModifiers,
      bool aCalledFromJS, bool aDialog, bool aNavigate, nsIArray* aArgv,
      bool aIsPopupSpam, bool aForceNoOpener, bool aForceNoReferrer, PrintKind,
      nsDocShellLoadState* aLoadState, mozilla::dom::BrowsingContext** aResult);

  static nsresult URIfromURL(const nsACString& aURL,
                             mozIDOMWindowProxy* aParent, nsIURI** aURI);

  static bool ShouldOpenPopup(const mozilla::dom::WindowFeatures& aFeatures);

  static uint32_t CalculateChromeFlagsForContent(
      const mozilla::dom::WindowFeatures& aFeatures,
      const mozilla::dom::UserActivation::Modifiers& aModifiers,
      bool aCalledFromJS, bool* aIsPopupRequested);

  static uint32_t CalculateChromeFlagsForSystem(
      const mozilla::dom::WindowFeatures& aFeatures, bool aDialog,
      bool aChromeURL);

 private:
  MOZ_CAN_RUN_SCRIPT_BOUNDARY nsresult CreateChromeWindow(
      nsIWebBrowserChrome* aParentChrome, uint32_t aChromeFlags,
      nsIOpenWindowInfo* aOpenWindowInfo, nsIWebBrowserChrome** aResult);

 protected:
  nsTArray<nsWatcherWindowEnumerator*> mEnumeratorList;
  nsWatcherWindowEntry* mOldestWindow;
  mozilla::Mutex mListLock MOZ_UNANNOTATED;

  nsCOMPtr<nsIWindowCreator> mWindowCreator;
};

#endif
