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 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
|
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "third_party/blink/renderer/modules/awc/additional_windowing_controls.h"
#include "third_party/blink/public/mojom/frame/frame.mojom-blink.h"
#include "third_party/blink/public/mojom/permissions/permission.mojom-blink.h"
#include "third_party/blink/renderer/bindings/core/v8/script_promise.h"
#include "third_party/blink/renderer/bindings/core/v8/script_promise_resolver.h"
#include "third_party/blink/renderer/bindings/core/v8/v8_throw_dom_exception.h"
#include "third_party/blink/renderer/core/frame/local_dom_window.h"
#include "third_party/blink/renderer/core/frame/local_frame.h"
#include "third_party/blink/renderer/core/page/chrome_client.h"
#include "third_party/blink/renderer/core/page/page.h"
#include "third_party/blink/renderer/platform/bindings/exception_state.h"
#include "third_party/blink/renderer/platform/bindings/script_state.h"
namespace blink {
using mojom::blink::PermissionDescriptor;
using mojom::blink::PermissionDescriptorPtr;
using mojom::blink::PermissionName;
namespace {
using AdditionalWindowingControlsActionCallback =
base::OnceCallback<void(mojom::blink::PermissionStatus)>;
bool IsPermissionGranted(ScriptPromiseResolver<IDLUndefined>* resolver,
mojom::blink::PermissionStatus status) {
if (!resolver->GetScriptState()->ContextIsValid()) {
return false;
}
if (status != mojom::blink::PermissionStatus::GRANTED) {
ScriptState::Scope scope(resolver->GetScriptState());
resolver->Reject(V8ThrowDOMException::CreateOrEmpty(
resolver->GetScriptState()->GetIsolate(),
DOMExceptionCode::kNotAllowedError,
status == mojom::blink::PermissionStatus::DENIED
? "Permission denied."
: "Permission decision deferred."));
return false;
}
return true;
}
bool CanUseWindowingControls(LocalDOMWindow* window,
ExceptionState& exception_state) {
auto* frame = window->GetFrame();
if (!frame || !frame->IsOutermostMainFrame() ||
frame->GetPage()->IsPrerendering()) {
exception_state.ThrowDOMException(
DOMExceptionCode::kInvalidStateError,
"API is only supported in primary top-level browsing contexts.");
return false;
}
// Additional windowing controls (AWC) is a desktop-only feature.
#if BUILDFLAG(IS_ANDROID) || BUILDFLAG(IS_IOS)
exception_state.ThrowDOMException(
DOMExceptionCode::kNotSupportedError,
"API is only supported on Desktop platforms. This excludes mobile "
"platforms.");
return false;
#else
return true;
#endif
}
ScriptPromise<IDLUndefined> MaybePromptWindowManagementPermission(
LocalDOMWindow* window,
ScriptPromiseResolver<IDLUndefined>* resolver,
AdditionalWindowingControlsActionCallback callback) {
auto* permission_service =
window->document()->GetPermissionService(window->GetExecutionContext());
CHECK(permission_service);
auto permission_descriptor = PermissionDescriptor::New();
permission_descriptor->name = PermissionName::WINDOW_MANAGEMENT;
// Only allow the user prompts when the frame has a transient activation.
// Otherwise, resolve or reject the promise with the current permission state.
if (LocalFrame::HasTransientUserActivation(window->GetFrame())) {
LocalFrame::ConsumeTransientUserActivation(window->GetFrame());
permission_service->RequestPermission(std::move(permission_descriptor),
/*user_gesture=*/true,
std::move(callback));
} else {
permission_service->HasPermission(std::move(permission_descriptor),
std::move(callback));
}
return resolver->Promise();
}
void OnMaximizePermissionRequestComplete(
ScriptPromiseResolver<IDLUndefined>* resolver,
LocalDOMWindow* window,
mojom::blink::PermissionStatus status) {
if (!IsPermissionGranted(resolver, status)) {
return;
}
#if !BUILDFLAG(IS_ANDROID) && !BUILDFLAG(IS_IOS)
window->GetFrame()->GetChromeClient().Maximize(*window->GetFrame());
#endif
// TODO(crbug.com/1505666): Add wait for the display state change to be
// completed before resolving the promise.
resolver->Resolve();
}
void OnMinimizePermissionRequestComplete(
ScriptPromiseResolver<IDLUndefined>* resolver,
LocalDOMWindow* window,
mojom::blink::PermissionStatus status) {
if (!IsPermissionGranted(resolver, status)) {
return;
}
#if !BUILDFLAG(IS_ANDROID) && !BUILDFLAG(IS_IOS)
window->GetFrame()->GetChromeClient().Minimize(*window->GetFrame());
#endif
// TODO(crbug.com/1505666): Add wait for the display state change to be
// completed before resolving the promise.
resolver->Resolve();
}
void OnRestorePermissionRequestComplete(
ScriptPromiseResolver<IDLUndefined>* resolver,
LocalDOMWindow* window,
mojom::blink::PermissionStatus status) {
if (!IsPermissionGranted(resolver, status)) {
return;
}
#if !BUILDFLAG(IS_ANDROID) && !BUILDFLAG(IS_IOS)
window->GetFrame()->GetChromeClient().Restore(*window->GetFrame());
#endif
// TODO(crbug.com/1505666): Add wait for the display state change to be
// completed before resolving the promise.
resolver->Resolve();
}
void OnSetResizablePermissionRequestComplete(
ScriptPromiseResolver<IDLUndefined>* resolver,
LocalDOMWindow* window,
bool resizable,
mojom::blink::PermissionStatus status) {
if (!IsPermissionGranted(resolver, status)) {
return;
}
#if !BUILDFLAG(IS_ANDROID) && !BUILDFLAG(IS_IOS)
ChromeClient& chrome_client = window->GetFrame()->GetChromeClient();
chrome_client.SetResizable(resizable, *window->GetFrame());
#endif
// TODO(crbug.com/1505666): Add wait for the resizability change to be
// completed before resolving the promise.
resolver->Resolve();
}
} // namespace
// static
ScriptPromise<IDLUndefined> AdditionalWindowingControls::maximize(
ScriptState* script_state,
LocalDOMWindow& window,
ExceptionState& exception_state) {
if (!CanUseWindowingControls(&window, exception_state)) {
return EmptyPromise();
}
auto* resolver =
MakeGarbageCollected<ScriptPromiseResolver<IDLUndefined>>(script_state);
return MaybePromptWindowManagementPermission(
&window, resolver,
WTF::BindOnce(&OnMaximizePermissionRequestComplete,
WrapPersistent(resolver), WrapPersistent(&window)));
}
// static
ScriptPromise<IDLUndefined> AdditionalWindowingControls::minimize(
ScriptState* script_state,
LocalDOMWindow& window,
ExceptionState& exception_state) {
if (!CanUseWindowingControls(&window, exception_state)) {
return EmptyPromise();
}
auto* resolver =
MakeGarbageCollected<ScriptPromiseResolver<IDLUndefined>>(script_state);
return MaybePromptWindowManagementPermission(
&window, resolver,
WTF::BindOnce(&OnMinimizePermissionRequestComplete,
WrapPersistent(resolver), WrapPersistent(&window)));
}
// static
ScriptPromise<IDLUndefined> AdditionalWindowingControls::restore(
ScriptState* script_state,
LocalDOMWindow& window,
ExceptionState& exception_state) {
if (!CanUseWindowingControls(&window, exception_state)) {
return EmptyPromise();
}
auto* resolver =
MakeGarbageCollected<ScriptPromiseResolver<IDLUndefined>>(script_state);
return MaybePromptWindowManagementPermission(
&window, resolver,
WTF::BindOnce(&OnRestorePermissionRequestComplete,
WrapPersistent(resolver), WrapPersistent(&window)));
}
// static
ScriptPromise<IDLUndefined> AdditionalWindowingControls::setResizable(
ScriptState* script_state,
LocalDOMWindow& window,
bool resizable,
ExceptionState& exception_state) {
if (!CanUseWindowingControls(&window, exception_state)) {
return EmptyPromise();
}
auto* resolver =
MakeGarbageCollected<ScriptPromiseResolver<IDLUndefined>>(script_state);
return MaybePromptWindowManagementPermission(
&window, resolver,
WTF::BindOnce(&OnSetResizablePermissionRequestComplete,
WrapPersistent(resolver), WrapPersistent(&window),
resizable));
}
} // namespace blink
|