1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
|
/* -*- 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/. */
#include "CloseWatcher.h"
#include "mozilla/RefPtr.h"
#include "mozilla/dom/CloseWatcherBinding.h"
#include "mozilla/dom/CloseWatcherManager.h"
#include "mozilla/dom/Event.h"
#include "mozilla/dom/EventBinding.h"
#include "mozilla/dom/ToJSValue.h"
#include "mozilla/dom/WindowContext.h"
#include "nsGlobalWindowInner.h"
namespace mozilla::dom {
NS_IMPL_ISUPPORTS_INHERITED0(CloseWatcher, DOMEventTargetHelper)
already_AddRefed<CloseWatcher> CloseWatcher::Constructor(
const GlobalObject& aGlobal, const CloseWatcherOptions& aOptions,
ErrorResult& aRv) {
nsCOMPtr<nsIGlobalObject> global = do_QueryInterface(aGlobal.GetAsSupports());
RefPtr<nsPIDOMWindowInner> window = global->GetAsInnerWindow();
if (!window || !window->IsFullyActive()) {
aRv.ThrowInvalidStateError("The document is not fully active.");
return nullptr;
}
RefPtr<CloseWatcher> watcher = new CloseWatcher(window);
AbortSignal* signal = nullptr;
if (aOptions.mSignal.WasPassed()) {
signal = &aOptions.mSignal.Value();
}
if (signal && signal->Aborted()) {
return watcher.forget();
}
if (signal) {
watcher->Follow(signal);
}
watcher->AddToWindowsCloseWatcherManager();
return watcher.forget();
}
JSObject* CloseWatcher::WrapObject(JSContext* aCx,
JS::Handle<JSObject*> aGivenProto) {
return CloseWatcher_Binding::Wrap(aCx, this, aGivenProto);
}
// https://html.spec.whatwg.org/multipage/interaction.html#close-watcher-request-close
bool CloseWatcher::RequestToClose(bool aRequireHistoryActionActivation) {
// 1. If closeWatcher is not active, then return true.
// 2. If the result of running closeWatcher's get enabled state is false, then
// return true.
// 3. If closeWatcher's is running cancel action is true, then return true.
// 4. Let window be closeWatcher's window.
// 5. If window's associated Document is not fully active, then return true.
if (!IsActive() || mIsRunningCancelAction) {
return true;
}
MOZ_ASSERT(GetOwnerWindow());
RefPtr<WindowContext> winCtx = GetOwnerWindow()->GetWindowContext();
RefPtr<CloseWatcherManager> manager =
GetOwnerWindow()->EnsureCloseWatcherManager();
EventInit init;
init.mBubbles = false;
// 6. Let canPreventClose be true if window's close watcher manager's groups's
// size is less than window's close watcher manager's allowed number of
// groups, and window has history-action activation; otherwise false.
init.mCancelable =
!aRequireHistoryActionActivation ||
(manager->CanGrow() && winCtx->HasValidHistoryActivation());
RefPtr<Event> event = Event::Constructor(this, u"cancel"_ns, init);
event->SetTrusted(true);
// 7. Set closeWatcher's is running cancel action to true.
mIsRunningCancelAction = true;
// 8. Let shouldContinue be the result of running closeWatcher's cancel action
// given canPreventClose.
DispatchEvent(*event);
// 9. Set closeWatcher's is running cancel action to false.
mIsRunningCancelAction = false;
// 10. If shouldContinue is false, then:
if (event->DefaultPrevented()) {
// 10.2. Consume history-action user activation given window.
winCtx->ConsumeHistoryActivation();
// 10.3. Return false.
return false;
}
// 11. Close closeWatcher.
Close();
// 12. Return true.
return true;
}
// https://html.spec.whatwg.org/multipage/interaction.html#close-watcher-close
void CloseWatcher::Close() {
// 1. If closeWatcher is not active, then return.
// 2. If the result of running closeWatcher's get enabled state is false, then
// return true.
// 3. If closeWatcher's window's associated Document is not fully active, then
// return.
if (!IsActive()) {
return;
}
// 4. Destroy closeWatcher.
Destroy();
EventInit init;
init.mBubbles = false;
init.mCancelable = false;
RefPtr<Event> event = Event::Constructor(this, u"close"_ns, init);
event->SetTrusted(true);
DispatchEvent(*event);
}
void CloseWatcher::AddToWindowsCloseWatcherManager() {
if (auto* window = GetOwnerWindow()) {
window->EnsureCloseWatcherManager()->Add(*this);
window->NotifyCloseWatcherAdded();
}
}
void CloseWatcher::Destroy() {
if (auto* window = GetOwnerWindow()) {
window->EnsureCloseWatcherManager()->Remove(*this);
window->NotifyCloseWatcherRemoved();
}
}
bool CloseWatcher::IsActive() const {
if (!mEnabled) {
return false;
}
if (auto* window = GetOwnerWindow()) {
return window->IsFullyActive() &&
window->EnsureCloseWatcherManager()->Contains(*this);
}
return false;
}
void CloseWatcher::RunAbortAlgorithm() { Destroy(); }
} // namespace mozilla::dom
|