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 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712
|
/*
* Copyright (C) 2019-2025 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "config.h"
#include "FullscreenManager.h"
#if ENABLE(FULLSCREEN_API)
#include "Chrome.h"
#include "ChromeClient.h"
#include "Document.h"
#include "DocumentInlines.h"
#include "Element.h"
#include "ElementInlines.h"
#include "EventLoop.h"
#include "EventNames.h"
#include "HTMLDialogElement.h"
#include "HTMLIFrameElement.h"
#include "HTMLMediaElement.h"
#include "JSDOMPromiseDeferred.h"
#include "LocalDOMWindow.h"
#include "LocalFrame.h"
#include "Logging.h"
#include "Page.h"
#include "PseudoClassChangeInvalidation.h"
#include "QualifiedName.h"
#include "Quirks.h"
#include "RenderBlock.h"
#include "SVGElementTypeHelpers.h"
#include "SVGSVGElement.h"
#include "Settings.h"
#include <wtf/LoggerHelper.h>
#include <wtf/TZoneMallocInlines.h>
#if ENABLE(MATHML)
#include "MathMLMathElement.h"
#endif
namespace WebCore {
// MARK: - Constructor.
WTF_MAKE_TZONE_ALLOCATED_IMPL(FullscreenManager);
FullscreenManager::FullscreenManager(Document& document)
: m_document(document)
#if !RELEASE_LOG_DISABLED
, m_logIdentifier(LoggerHelper::uniqueLogIdentifier())
#endif
{
}
// MARK: - fullscreenEnabled attribute.
// https://fullscreen.spec.whatwg.org/#dom-document-fullscreenenabled
bool FullscreenManager::isFullscreenEnabled() const
{
// The fullscreenEnabled attribute must return true if the context object and all ancestor
// browsing context's documents have their fullscreen enabled flag set, or false otherwise.
// Top-level browsing contexts are implied to have their allowFullscreen attribute set.
return PermissionsPolicy::isFeatureEnabled(PermissionsPolicy::Feature::Fullscreen, protectedDocument());
}
// MARK: - Fullscreen element.
// https://fullscreen.spec.whatwg.org/#fullscreen-element
Element* FullscreenManager::fullscreenElement() const
{
for (Ref element : makeReversedRange(document().topLayerElements())) {
if (element->hasFullscreenFlag())
return element.ptr();
}
return nullptr;
}
// MARK: - requestFullscreen() steps.
// https://fullscreen.spec.whatwg.org/#dom-element-requestfullscreen
void FullscreenManager::requestFullscreenForElement(Ref<Element>&& element, FullscreenCheckType checkType, CompletionHandler<void(ExceptionOr<void>)>&& completionHandler, HTMLMediaElementEnums::VideoFullscreenMode mode)
{
auto identifier = LOGIDENTIFIER;
enum class EmitErrorEvent : bool { No, Yes };
auto handleError = [this, element, identifier, weakThis = WeakPtr { *this }](ASCIILiteral message, EmitErrorEvent emitErrorEvent, CompletionHandler<void(ExceptionOr<void>)>&& completionHandler) mutable {
CheckedPtr checkedThis = weakThis.get();
if (!checkedThis)
return completionHandler(Exception { ExceptionCode::TypeError, message });
ERROR_LOG(identifier, message);
if (emitErrorEvent == EmitErrorEvent::Yes) {
m_pendingEvents.append(std::pair { EventType::Error, WTFMove(element) });
protectedDocument()->scheduleRenderingUpdate(RenderingUpdateStep::Fullscreen);
}
completionHandler(Exception { ExceptionCode::TypeError, message });
};
// If pendingDoc is not fully active, then reject promise with a TypeError exception and return promise.
if (!protectedDocument()->isFullyActive())
return handleError("Cannot request fullscreen on a document that is not fully active."_s, EmitErrorEvent::No, WTFMove(completionHandler));
// https://fullscreen.spec.whatwg.org/#fullscreen-element-ready-check
auto fullscreenElementReadyCheck = [checkType] (auto element, auto document) -> ASCIILiteral {
if (!element->isConnected())
return "Cannot request fullscreen on a disconnected element."_s;
if (element->isPopoverShowing())
return "Cannot request fullscreen on an open popover."_s;
if (checkType == EnforceIFrameAllowFullscreenRequirement && !PermissionsPolicy::isFeatureEnabled(PermissionsPolicy::Feature::Fullscreen, document))
return "Fullscreen API is disabled by permissions policy."_s;
return { };
};
auto isElementTypeAllowedForFullscreen = [] (const auto& element) {
if (is<HTMLElement>(element) || is<SVGSVGElement>(element))
return true;
#if ENABLE(MATHML)
if (is<MathMLMathElement>(element))
return true;
#endif
return false;
};
// If any of the following conditions are true, terminate these steps and queue a task to fire
// an event named fullscreenerror with its bubbles attribute set to true on the context object's
// node document:
if (!isElementTypeAllowedForFullscreen(element))
return handleError("Cannot request fullscreen on a non-HTML element."_s, EmitErrorEvent::Yes, WTFMove(completionHandler));
if (is<HTMLDialogElement>(element))
return handleError("Cannot request fullscreen on a <dialog> element."_s, EmitErrorEvent::Yes, WTFMove(completionHandler));
if (auto error = fullscreenElementReadyCheck(element, protectedDocument()))
return handleError(error, EmitErrorEvent::Yes, WTFMove(completionHandler));
if (!document().domWindow() || !document().domWindow()->consumeTransientActivation())
return handleError("Cannot request fullscreen without transient activation."_s, EmitErrorEvent::Yes, WTFMove(completionHandler));
if (UserGestureIndicator::processingUserGesture() && UserGestureIndicator::currentUserGesture()->gestureType() == UserGestureType::EscapeKey)
return handleError("Cannot request fullscreen with Escape key as current gesture."_s, EmitErrorEvent::Yes, WTFMove(completionHandler));
// There is a previously-established user preference, security risk, or platform limitation.
if (!page() || !page()->isFullscreenManagerEnabled())
return handleError("Fullscreen API is disabled."_s, EmitErrorEvent::Yes, WTFMove(completionHandler));
bool hasKeyboardAccess = true;
if (!page()->chrome().client().supportsFullScreenForElement(element, hasKeyboardAccess)) {
// The new full screen API does not accept a "flags" parameter, so fall back to disallowing
// keyboard input if the chrome client refuses to allow keyboard input.
hasKeyboardAccess = false;
if (!page()->chrome().client().supportsFullScreenForElement(element, hasKeyboardAccess))
return handleError("Cannot request fullscreen with unsupported element."_s, EmitErrorEvent::Yes, WTFMove(completionHandler));
}
INFO_LOG(identifier);
protectedDocument()->eventLoop().queueTask(TaskSource::MediaElement, [this, weakThis = WeakPtr { *this }, element = WTFMove(element), scope = CompletionHandlerScope(WTFMove(completionHandler)), hasKeyboardAccess, fullscreenElementReadyCheck, handleError, identifier, mode] () mutable {
auto completionHandler = scope.release();
CheckedPtr checkedThis = weakThis.get();
if (!checkedThis)
return completionHandler(Exception { ExceptionCode::TypeError });
// Don't allow fullscreen if we're inside an exitFullscreen operation.
if (m_pendingExitFullscreen)
return handleError("Fullscreen request aborted by a request to exit fullscreen."_s, EmitErrorEvent::Yes, WTFMove(completionHandler));
// Don't allow fullscreen if document is hidden.
auto document = protectedDocument();
if (document->hidden() && mode != HTMLMediaElementEnums::VideoFullscreenModeInWindow)
return handleError("Cannot request fullscreen in a hidden document."_s, EmitErrorEvent::Yes, WTFMove(completionHandler));
// Fullscreen element ready check.
if (auto error = fullscreenElementReadyCheck(element, protectedDocument()))
return handleError(error, EmitErrorEvent::Yes, WTFMove(completionHandler));
// Don't allow if element changed document.
if (&element->document() != document.ptr())
return handleError("Cannot request fullscreen because the associated document has changed."_s, EmitErrorEvent::Yes, WTFMove(completionHandler));
// A descendant browsing context's document has a non-empty fullscreen element stack.
bool descendantHasNonEmptyStack = false;
for (RefPtr descendant = frame() ? frame()->tree().traverseNext() : nullptr; descendant; descendant = descendant->tree().traverseNext()) {
auto* localFrame = dynamicDowncast<LocalFrame>(descendant.get());
if (!localFrame)
continue;
if (localFrame->document()->fullscreenManager().fullscreenElement()) {
descendantHasNonEmptyStack = true;
break;
}
}
if (descendantHasNonEmptyStack)
return handleError("Cannot request fullscreen because a descendant document already has a fullscreen element."_s, EmitErrorEvent::Yes, WTFMove(completionHandler));
// 5. Return, and run the remaining steps asynchronously.
// 6. Optionally, perform some animation.
m_areKeysEnabledInFullscreen = hasKeyboardAccess;
document->eventLoop().queueTask(TaskSource::MediaElement, [this, weakThis = WTFMove(weakThis), element = WTFMove(element), scope = CompletionHandlerScope(WTFMove(completionHandler)), handleError = WTFMove(handleError), identifier, mode] () mutable {
auto completionHandler = scope.release();
CheckedPtr checkedThis = weakThis.get();
if (!checkedThis)
return completionHandler(Exception { ExceptionCode::TypeError });
RefPtr page = this->page();
if (!page || (this->document().hidden() && mode != HTMLMediaElementEnums::VideoFullscreenModeInWindow) || !element->isConnected())
return handleError("Invalid state when requesting fullscreen."_s, EmitErrorEvent::Yes, WTFMove(completionHandler));
INFO_LOG(identifier, "task - success");
page->chrome().client().enterFullScreenForElement(element, mode, WTFMove(completionHandler), [weakThis = WTFMove(weakThis)] (bool success) {
CheckedPtr checkedThis = weakThis.get();
if (!checkedThis || !success)
return true;
return checkedThis->didEnterFullscreen();
});
});
// 7. Optionally, display a message indicating how the user can exit displaying the context object fullscreen.
});
}
ExceptionOr<void> FullscreenManager::willEnterFullscreen(Element& element, HTMLMediaElementEnums::VideoFullscreenMode mode)
{
#if !ENABLE(VIDEO)
UNUSED_PARAM(mode);
#endif
if (backForwardCacheState() != Document::NotInBackForwardCache) {
ERROR_LOG(LOGIDENTIFIER, "Document in the BackForwardCache; bailing");
return Exception { ExceptionCode::TypeError };
}
// Protect against being called after the document has been removed from the page.
RefPtr protectedPage = page();
if (!protectedPage) {
ERROR_LOG(LOGIDENTIFIER, "Document no longer in page; bailing");
return Exception { ExceptionCode::TypeError };
}
if (!element.isConnected()) {
ERROR_LOG(LOGIDENTIFIER, "Element to fullscreen is disconnected; bailing.");
return Exception { ExceptionCode::TypeError };
}
// The element is an open popover.
if (element.isPopoverShowing()) {
ERROR_LOG(LOGIDENTIFIER, "Element to fullscreen is an open popover; bailing.");
return Exception { ExceptionCode::TypeError, "Cannot request fullscreen on an open popover."_s };
}
INFO_LOG(LOGIDENTIFIER);
ASSERT(page()->isFullscreenManagerEnabled());
#if ENABLE(VIDEO)
if (RefPtr mediaElement = dynamicDowncast<HTMLMediaElement>(element))
mediaElement->willBecomeFullscreenElement(mode);
else
#endif
element.willBecomeFullscreenElement();
Vector<Ref<Element>> ancestors { { element } };
for (RefPtr<Frame> frame = element.document().frame(); frame; frame = frame->tree().parent()) {
if (RefPtr ownerElement = frame->ownerElement())
ancestors.append(ownerElement.releaseNonNull());
}
for (auto ancestor : makeReversedRange(ancestors))
elementEnterFullscreen(ancestor);
if (RefPtr iframe = dynamicDowncast<HTMLIFrameElement>(element))
iframe->setIFrameFullscreenFlag(true);
return { };
}
void FullscreenManager::elementEnterFullscreen(Element& element)
{
auto hideUntil = element.topmostPopoverAncestor(Element::TopLayerElementType::Other);
element.document().hideAllPopoversUntil(hideUntil, FocusPreviousElement::No, FireEvents::No);
auto containingBlockBeforeStyleResolution = SingleThreadWeakPtr<RenderBlock> { };
if (CheckedPtr renderer = element.renderer())
containingBlockBeforeStyleResolution = renderer->containingBlock();
element.setFullscreenFlag(true);
element.document().resolveStyle(Document::ResolveStyleType::Rebuild);
// Remove before adding, so we always add at the end of the top layer.
if (element.isInTopLayer())
element.removeFromTopLayer();
element.addToTopLayer();
queueFullscreenChangeEventForDocument(element.document());
RenderElement::markRendererDirtyAfterTopLayerChange(element.checkedRenderer().get(), containingBlockBeforeStyleResolution.get());
}
bool FullscreenManager::didEnterFullscreen()
{
RefPtr fullscreenElement = this->fullscreenElement();
if (!fullscreenElement) {
ERROR_LOG(LOGIDENTIFIER, "No fullscreenElement; bailing");
return false;
}
if (backForwardCacheState() != Document::NotInBackForwardCache) {
ERROR_LOG(LOGIDENTIFIER, "Document in the BackForwardCache; bailing");
return false;
}
INFO_LOG(LOGIDENTIFIER);
fullscreenElement->didBecomeFullscreenElement();
return true;
}
// MARK: - Simple fullscreen document (exit helper).
// https://fullscreen.spec.whatwg.org/#simple-fullscreen-document
bool FullscreenManager::isSimpleFullscreenDocument() const
{
bool foundFullscreenFlag = false;
for (Ref element : document().topLayerElements()) {
if (element->hasFullscreenFlag()) {
if (foundFullscreenFlag)
return false;
foundFullscreenFlag = true;
}
}
return foundFullscreenFlag;
}
// MARK: - Collect documents to unfullscreen (exit helper).
// https://fullscreen.spec.whatwg.org/#collect-documents-to-unfullscreen
static Vector<Ref<Document>> documentsToUnfullscreen(Frame& firstFrame)
{
Vector<Ref<Document>> documents;
if (RefPtr localFirstFrame = dynamicDowncast<LocalFrame>(firstFrame); localFirstFrame && localFirstFrame->document())
documents.append(*localFirstFrame->document());
for (RefPtr frame = firstFrame.tree().parent(); frame; frame = frame->tree().parent()) {
RefPtr localFrame = dynamicDowncast<LocalFrame>(frame);
if (!localFrame)
continue;
RefPtr document = localFrame->document();
if (!document)
continue;
ASSERT(document->fullscreenManager().fullscreenElement());
if (!document->fullscreenManager().isSimpleFullscreenDocument())
break;
if (RefPtr iframe = dynamicDowncast<HTMLIFrameElement>(document->ownerElement()); iframe && iframe->hasIFrameFullscreenFlag())
break;
documents.append(*document);
}
return documents;
}
// MARK: - Clear fullscreen flags (exit helper).
// https://fullscreen.spec.whatwg.org/#unfullscreen-an-element
static void clearFullscreenFlags(Element& element)
{
element.setFullscreenFlag(false);
if (auto* iframe = dynamicDowncast<HTMLIFrameElement>(element))
iframe->setIFrameFullscreenFlag(false);
}
// MARK: - Exit fullscreen.
// https://fullscreen.spec.whatwg.org/#exit-fullscreen
void FullscreenManager::exitFullscreen(CompletionHandler<void(ExceptionOr<void>)>&& completionHandler)
{
INFO_LOG(LOGIDENTIFIER);
Ref exitingDocument = document();
auto mode = ExitMode::NoResize;
Vector<Ref<Document>> exitDocuments;
if (RefPtr exitingFrame = exitingDocument->frame())
exitDocuments = documentsToUnfullscreen(*exitingFrame);
RefPtr mainFrameDocument = this->mainFrameDocument();
bool exitsTopDocument = exitDocuments.containsIf([&](auto& document) {
return document.ptr() == mainFrameDocument.get();
});
if (!mainFrameDocument || (exitsTopDocument && mainFrameDocument->fullscreenManager().isSimpleFullscreenDocument())) {
mode = ExitMode::Resize;
if (mainFrameDocument)
exitingDocument = *mainFrameDocument;
}
if (RefPtr element = exitingDocument->fullscreenManager().fullscreenElement(); element && !element->isConnected()) {
queueFullscreenChangeEventForDocument(exitingDocument);
clearFullscreenFlags(*element);
element->removeFromTopLayer();
}
m_pendingExitFullscreen = true;
// Return promise, and run the remaining steps in parallel.
exitingDocument->eventLoop().queueTask(TaskSource::MediaElement, [this, scope = CompletionHandlerScope(WTFMove(completionHandler)), weakThis = WeakPtr { *this }, mode, identifier = LOGIDENTIFIER] () mutable {
auto completionHandler = scope.release();
CheckedPtr checkedThis = weakThis.get();
if (!checkedThis)
return completionHandler({ });
RefPtr page = this->page();
if (!page) {
m_pendingExitFullscreen = false;
ERROR_LOG(identifier, "task - Document not in page; bailing.");
return completionHandler({ });
}
// If there is no fullscreen element, bail out early.
RefPtr exitedFullscreenElement = fullscreenElement();
if (!exitedFullscreenElement) {
INFO_LOG(identifier, "task - No fullscreen element.");
m_pendingExitFullscreen = false;
return completionHandler({ });
}
// Notify the chrome of the new full screen element.
if (mode == ExitMode::Resize) {
page->chrome().client().exitFullScreenForElement(exitedFullscreenElement.get(), [weakThis = WTFMove(weakThis), completionHandler = WTFMove(completionHandler)] mutable {
CheckedPtr checkedThis = weakThis.get();
if (!checkedThis)
return completionHandler({ });
checkedThis->didExitFullscreen(WTFMove(completionHandler));
});
} else {
if (RefPtr frame = document().frame())
finishExitFullscreen(*frame, ExitMode::NoResize);
// We just popped off one fullscreen element out of the top layer, query the new one.
if (RefPtr newFullscreenElement = fullscreenElement()) {
page->chrome().client().enterFullScreenForElement(*newFullscreenElement, HTMLMediaElementEnums::VideoFullscreenModeStandard, WTFMove(completionHandler), [weakThis = WTFMove(weakThis)] (bool success) {
CheckedPtr checkedThis = weakThis.get();
if (!checkedThis || !success)
return true;
return checkedThis->didEnterFullscreen();
});
} else
completionHandler({ });
}
});
}
void FullscreenManager::finishExitFullscreen(Frame& currentFrame, ExitMode mode)
{
RefPtr currentLocalFrame = dynamicDowncast<LocalFrame>(currentFrame);
if (currentLocalFrame && currentLocalFrame->document() && !currentLocalFrame->document()->fullscreenManager().fullscreenElement())
return;
// Let descendantDocs be an ordered set consisting of doc’s descendant browsing contexts' active documents whose fullscreen element is non-null, if any, in tree order.
Vector<Ref<Document>> descendantDocuments;
for (RefPtr descendant = currentFrame.tree().traverseNext(); descendant; descendant = descendant->tree().traverseNext()) {
RefPtr localFrame = dynamicDowncast<LocalFrame>(descendant);
if (!localFrame || !localFrame->document())
continue;
if (localFrame->document()->fullscreenManager().fullscreenElement())
descendantDocuments.append(*localFrame->document());
}
auto unfullscreenDocument = [](const Ref<Document>& document) {
Vector<Ref<Element>> toRemove;
for (Ref element : document->topLayerElements()) {
if (!element->hasFullscreenFlag())
continue;
clearFullscreenFlags(element);
toRemove.append(element);
}
for (Ref element : toRemove)
element->removeFromTopLayer();
};
auto exitDocuments = documentsToUnfullscreen(currentFrame);
for (Ref exitDocument : exitDocuments) {
queueFullscreenChangeEventForDocument(exitDocument);
if (mode == ExitMode::Resize)
unfullscreenDocument(exitDocument);
else {
RefPtr fullscreenElement = exitDocument->fullscreenManager().fullscreenElement();
clearFullscreenFlags(*fullscreenElement);
fullscreenElement->removeFromTopLayer();
}
}
for (Ref descendantDocument : makeReversedRange(descendantDocuments)) {
queueFullscreenChangeEventForDocument(descendantDocument);
unfullscreenDocument(descendantDocument);
}
}
bool FullscreenManager::willExitFullscreen()
{
RefPtr fullscreenElement = this->fullscreenElement();
if (!fullscreenElement) {
ERROR_LOG(LOGIDENTIFIER, "No fullscreenElement; bailing");
return false;
}
if (backForwardCacheState() != Document::NotInBackForwardCache) {
ERROR_LOG(LOGIDENTIFIER, "Document in the BackForwardCache; bailing");
return false;
}
INFO_LOG(LOGIDENTIFIER);
fullscreenElement->willStopBeingFullscreenElement();
return true;
}
void FullscreenManager::didExitFullscreen(CompletionHandler<void(ExceptionOr<void>)>&& completionHandler)
{
if (backForwardCacheState() != Document::NotInBackForwardCache) {
ERROR_LOG(LOGIDENTIFIER, "Document in the BackForwardCache; bailing");
m_pendingExitFullscreen = false;
return completionHandler(Exception { ExceptionCode::TypeError });
}
INFO_LOG(LOGIDENTIFIER);
// Get `fullscreenElement()` before `finishExitFullscreen` clears it.
RefPtr exitedFullscreenElement = fullscreenElement();
if (RefPtr frame = document().frame())
finishExitFullscreen(frame->mainFrame(), ExitMode::Resize);
if (exitedFullscreenElement)
exitedFullscreenElement->didStopBeingFullscreenElement();
m_areKeysEnabledInFullscreen = false;
m_pendingExitFullscreen = false;
completionHandler({ });
}
// MARK: - Removing steps.
// https://fullscreen.spec.whatwg.org/#removing-steps
void FullscreenManager::exitRemovedFullscreenElement(Element& element)
{
ASSERT(element.hasFullscreenFlag());
if (fullscreenElement() == &element) {
INFO_LOG(LOGIDENTIFIER, "Fullscreen element removed; exiting fullscreen");
exitFullscreen([] (auto) { });
} else
clearFullscreenFlags(element);
}
// MARK: - Fully exit fullscreen.
// Removes all fullscreen elements from the top layer for all documents.
// https://fullscreen.spec.whatwg.org/#fully-exit-fullscreen
void FullscreenManager::fullyExitFullscreen()
{
RefPtr mainFrameDocument = this->mainFrameDocument();
if (!mainFrameDocument)
LOG_ONCE(SiteIsolation, "Unable to fully perform FullscreenManager::fullyExitFullscreen() without access to the main frame document ");
if (!mainFrameDocument || !mainFrameDocument->fullscreenManager().fullscreenElement()) {
INFO_LOG(LOGIDENTIFIER, "No element to unfullscreen.");
return;
}
INFO_LOG(LOGIDENTIFIER);
m_pendingExitFullscreen = true;
protectedDocument()->eventLoop().queueTask(TaskSource::MediaElement, [this, weakThis = WeakPtr { *this }, mainFrameDocument = WTFMove(mainFrameDocument), identifier = LOGIDENTIFIER] {
#if RELEASE_LOG_DISABLED
UNUSED_PARAM(this);
#endif
CheckedPtr checkedThis = weakThis.get();
if (!checkedThis)
return;
if (!mainFrameDocument->page()) {
INFO_LOG(identifier, "Top document has no page.");
return;
}
// This triggers finishExitFullscreen with ExitMode::Resize, which fully exits the document.
if (RefPtr fullscreenElement = mainFrameDocument->fullscreenManager().fullscreenElement()) {
mainFrameDocument->page()->chrome().client().exitFullScreenForElement(fullscreenElement.get(), [weakThis = WeakPtr { *this }] {
CheckedPtr checkedThis = weakThis.get();
if (!checkedThis)
return;
checkedThis->didExitFullscreen([] (auto) { });
});
} else
INFO_LOG(identifier, "Top document has no fullscreen element");
});
}
// MARK: - Fullscreen rendering update steps / event dispatching.
// https://fullscreen.spec.whatwg.org/#run-the-fullscreen-steps
void FullscreenManager::dispatchPendingEvents()
{
// Since we dispatch events in this function, it's possible that the
// document will be detached and GC'd. We protect it here to make sure we
// can finish the function successfully.
Ref<Document> protectedDocument(document());
// Steps 1-2:
auto pendingEvents = std::exchange(m_pendingEvents, { });
// Step 3:
while (!pendingEvents.isEmpty()) {
auto [eventType, element] = pendingEvents.takeFirst();
// Gaining or losing fullscreen state may change viewport arguments
element->protectedDocument()->updateViewportArguments();
if (&element->document() != &document())
protectedDocument->updateViewportArguments();
#if ENABLE(VIDEO)
if (eventType == EventType::Change) {
if (RefPtr mediaElement = dynamicDowncast<HTMLMediaElement>(element.get()))
mediaElement->enteredOrExitedFullscreen();
}
#endif
// Let target be element if element is connected and its node document is document, and otherwise let target be document.
Ref target = [&]() -> Node& {
if (element->isConnected() && &element->document() == &document())
return element;
return document();
}();
switch (eventType) {
case EventType::Change: {
target->dispatchEvent(Event::create(eventNames().fullscreenchangeEvent, Event::CanBubble::Yes, Event::IsCancelable::No, Event::IsComposed::Yes));
bool shouldEmitUnprefixed = !(target->hasEventListeners(eventNames().webkitfullscreenchangeEvent) && target->hasEventListeners(eventNames().fullscreenchangeEvent)) && !(target->document().hasEventListeners(eventNames().webkitfullscreenchangeEvent) && target->document().hasEventListeners(eventNames().fullscreenchangeEvent));
if (shouldEmitUnprefixed)
target->dispatchEvent(Event::create(eventNames().webkitfullscreenchangeEvent, Event::CanBubble::Yes, Event::IsCancelable::No, Event::IsComposed::Yes));
break;
}
case EventType::Error:
target->dispatchEvent(Event::create(eventNames().fullscreenerrorEvent, Event::CanBubble::Yes, Event::IsCancelable::No, Event::IsComposed::Yes));
target->dispatchEvent(Event::create(eventNames().webkitfullscreenerrorEvent, Event::CanBubble::Yes, Event::IsCancelable::No, Event::IsComposed::Yes));
break;
}
}
}
void FullscreenManager::queueFullscreenChangeEventForDocument(Document& document)
{
RefPtr target = document.fullscreenManager().fullscreenElement();
if (!target) {
ASSERT_NOT_REACHED();
return;
}
document.fullscreenManager().queueFullscreenChangeEventForElement(*target);
document.scheduleRenderingUpdate(RenderingUpdateStep::Fullscreen);
}
// MARK: - Fullscreen animation pseudo-class.
bool FullscreenManager::isAnimatingFullscreen() const
{
return m_isAnimatingFullscreen;
}
void FullscreenManager::setAnimatingFullscreen(bool flag)
{
if (m_isAnimatingFullscreen == flag)
return;
INFO_LOG(LOGIDENTIFIER, flag);
std::optional<Style::PseudoClassChangeInvalidation> styleInvalidation;
if (RefPtr fullscreenElement = this->fullscreenElement())
emplace(styleInvalidation, *fullscreenElement, { { CSSSelector::PseudoClass::InternalAnimatingFullscreenTransition, flag } });
m_isAnimatingFullscreen = flag;
}
// MARK: - Log channel.
#if !RELEASE_LOG_DISABLED
WTFLogChannel& FullscreenManager::logChannel() const
{
return LogFullscreen;
}
#endif
}
#endif
|