Source code

Revision control

Copy as Markdown

Other Tools

/* -*- 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 */
#ifndef mozilla_dom_PopupBlocker_h
#define mozilla_dom_PopupBlocker_h
#include <stdint.h>
#include "mozilla/Attributes.h"
#include "mozilla/TimeStamp.h"
class AutoPopupStatePusherInternal;
class nsIPrincipal;
namespace mozilla {
class WidgetEvent;
namespace dom {
class Event;
class PopupBlocker final {
// Popup control state enum. The values in this enum must go from most
// permissive to least permissive so that it's safe to push state in
// all situations. Pushing popup state onto the stack never makes the
// current popup state less permissive.
// Keep this in sync with PopupBlockerState webidl dictionary!
enum PopupControlState {
openAllowed = 0, // open that window without worries
openControlled, // it's a popup, but allow it
openBlocked, // it's a popup, but not from an allowed event
openAbused, // it's a popup. disallow it, but allow domain override.
openOverridden // disallow window open
static PopupControlState PushPopupControlState(PopupControlState aState,
bool aForce);
static void PopPopupControlState(PopupControlState aState);
static PopupControlState GetPopupControlState();
static void PopupStatePusherCreated();
static void PopupStatePusherDestroyed();
static uint32_t GetPopupPermission(nsIPrincipal* aPrincipal);
static PopupBlocker::PopupControlState GetEventPopupControlState(
WidgetEvent* aEvent, Event* aDOMEvent = nullptr);
// Returns if a external protocol iframe is allowed.
static bool ConsumeTimerTokenForExternalProtocolIframe();
// Returns when the last external protocol iframe has been allowed.
static TimeStamp WhenLastExternalProtocolIframeAllowed();
// Reset the last external protocol iframe timestamp.
static void ResetLastExternalProtocolIframeAllowed();
// These method track the number of popup which is considered as a spam popup.
static void RegisterOpenPopupSpam();
static void UnregisterOpenPopupSpam();
static uint32_t GetOpenPopupSpamCount();
static void Initialize();
static void Shutdown();
} // namespace dom
} // namespace mozilla
# define AUTO_POPUP_STATE_PUSHER AutoPopupStatePusherInternal
# define AUTO_POPUP_STATE_PUSHER AutoPopupStatePusherExternal
// Helper class that helps with pushing and popping popup control
// state. Note that this class looks different from within code that's
// part of the layout library than it does in code outside the layout
// library. We give the two object layouts different names so the symbols
// don't conflict, but code should always use the name
// |AutoPopupStatePusher|.
mozilla::dom::PopupBlocker::PopupControlState aState,
bool aForce = false);
mozilla::dom::PopupBlocker::PopupControlState aState)
: mWindow(aWindow), mOldState(openAbused) {
if (aWindow) {
mOldState = PopupBlocker::PushPopupControlState(aState, false);
if (mWindow) {
nsCOMPtr<nsPIDOMWindowOuter> mWindow;
mozilla::dom::PopupBlocker::PopupControlState mOldState;
#define AutoPopupStatePusher AUTO_POPUP_STATE_PUSHER
#endif // mozilla_PopupBlocker_h