Move pending state from FullscreenController to Fullscreen

third_party/WebKit/Source/core/dom/Fullscreen.cpp

 /*
  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
  *           (C) 2001 Dirk Mueller (mueller@kde.org)
  *           (C) 2006 Alexey Proskuryakov (ap@webkit.org)
  * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2012 Apple Inc. All
  * rights reserved.
  * Copyright (C) 2008, 2009 Torch Mobile Inc. All rights reserved.
  * (http://www.torchmobile.com/)
  * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies)
@@ skipping 15 matching lines @@
  * Boston, MA 02110-1301, USA.
  *
  */
 
 #include "core/dom/Fullscreen.h"
 
 #include "core/dom/Document.h"
 #include "core/dom/ElementTraversal.h"
 #include "core/dom/StyleEngine.h"
 #include "core/events/Event.h"
-#include "core/frame/FrameHost.h"
 #include "core/frame/HostsUsingFeatures.h"
 #include "core/frame/LocalFrame.h"
 #include "core/frame/Settings.h"
 #include "core/frame/UseCounter.h"
 #include "core/html/HTMLIFrameElement.h"
 #include "core/input/EventHandler.h"
 #include "core/inspector/ConsoleMessage.h"
 #include "core/layout/LayoutBlockFlow.h"
 #include "core/layout/LayoutFullScreen.h"
 #include "core/layout/api/LayoutFullScreenItem.h"
@@ skipping 244 matching lines @@
   if (!forCrossProcessDescendant) {
     if (document.isSecureContext()) {
       UseCounter::count(document, UseCounter::FullscreenSecureOrigin);
     } else {
       UseCounter::count(document, UseCounter::FullscreenInsecureOrigin);
       HostsUsingFeatures::countAnyWorld(
           document, HostsUsingFeatures::Feature::FullscreenInsecureHost);
     }
   }
 
-  // Ignore this request if the document is not in a live frame.
-  if (!document.isActive())
+  // Ignore this call if the document is not in a live frame.
+  if (!document.isActive() || !document.frame())
     return;
 
   // If |element| is on top of |doc|'s fullscreen element stack, terminate these
   // substeps.
   if (&element == fullscreenElementFrom(document))
     return;
 
   do {
     // 1. If any of the following conditions are false, then terminate these
     // steps and queue a task to fire an event named fullscreenerror with its
@@ skipping 79 matching lines @@
         continue;
       }
 
       // 4. Otherwise, do nothing for this document. It stays the same.
     } while (++current != docs.end());
 
     from(document).m_forCrossProcessDescendant = forCrossProcessDescendant;
 
     // 5. Return, and run the remaining steps asynchronously.
     // 6. Optionally, perform some animation.
-    document.frameHost()->chromeClient().enterFullscreenForElement(&element);
+    from(document).m_pendingFullscreenElement = &element;
+    document.frame()->chromeClient().enterFullscreen(*document.frame());
 
     // 7. Optionally, display a message indicating how the user can exit
     // displaying the context object fullscreen.
     return;
   } while (false);
 
   from(document).enqueueErrorEvent(element, requestType);
 }
 
 // https://fullscreen.spec.whatwg.org/#fully-exit-fullscreen
@@ skipping 21 matching lines @@
   DCHECK_EQ(from(doc).m_fullscreenElementStack.size(), 1u);
 
   // 4. Act as if the exitFullscreen() method was invoked on |doc|.
   exitFullscreen(doc);
 }
 
 // https://fullscreen.spec.whatwg.org/#exit-fullscreen
 void Fullscreen::exitFullscreen(Document& document) {
   // The exitFullscreen() method must run these steps:
 
-  // 1. Let doc be the context object. (i.e. "this")
-  if (!document.isActive())
+  // Ignore this call if the document is not in a live frame.
+  if (!document.isActive() || !document.frame())
     return;
 
+  // 1. Let doc be the context object. (i.e. "this")
   // 2. If doc's fullscreen element stack is empty, terminate these steps.
   if (!fullscreenElementFrom(document))
     return;
 
   // 3. Let descendants be all the doc's descendant browsing context's documents
   // with a non-empty fullscreen element stack (if any), ordered so that the
   // child of the doc is last and the document furthest away from the doc is
   // first.
   HeapDeque<Member<Document>> descendants;
-  for (Frame* descendant =
-           document.frame() ? document.frame()->tree().traverseNext() : nullptr;
-       descendant; descendant = descendant->tree().traverseNext()) {
+  for (Frame* descendant = document.frame()->tree().traverseNext(); descendant;
+       descendant = descendant->tree().traverseNext()) {
     if (!descendant->isLocalFrame())
       continue;
     DCHECK(toLocalFrame(descendant)->document());
     if (fullscreenElementFrom(*toLocalFrame(descendant)->document()))
       descendants.prepend(toLocalFrame(descendant)->document());
   }
 
   // 4. For each descendant in descendants, empty descendant's fullscreen
   // element stack, and queue a task to fire an event named fullscreenchange
   // with its bubbles attribute set to true on descendant.
@@ skipping 44 matching lines @@
       }
     }
 
     // 4. Otherwise, set doc to null.
     currentDoc = nullptr;
   }
 
   // 6. Return, and run the remaining steps asynchronously.
   // 7. Optionally, perform some animation.
 
-  FrameHost* host = document.frameHost();
-
-  // Speculative fix for engaget.com/videos per crbug.com/336239.
-  // FIXME: This check is wrong. We DCHECK(document->isActive()) above
-  // so this should be redundant and should be removed!
-  if (!host)
-    return;
-
-  // Only exit out of full screen window mode if there are no remaining elements
-  // in the full screen stack.
+  // Only exit fullscreen mode if the fullscreen element stack is empty.
   if (!newTop) {
-    host->chromeClient().exitFullscreen(document.frame());
+    document.frame()->chromeClient().exitFullscreen(*document.frame());
     return;
   }
 
-  // Otherwise, notify the chrome of the new full screen element.
-  host->chromeClient().enterFullscreenForElement(newTop);
+  // Otherwise, enter fullscreen for the fullscreen element stack's top element.
+  from(document).m_pendingFullscreenElement = newTop;
+  from(document).didEnterFullscreen();
 }
 
 // https://fullscreen.spec.whatwg.org/#dom-document-fullscreenenabled
 bool Fullscreen::fullscreenEnabled(Document& document) {
   // The fullscreenEnabled attribute's getter must return true if the context
   // object is allowed to use the feature indicated by attribute name
   // allowfullscreen and fullscreen is supported, and false otherwise.
   return allowedToUseFullscreen(document.frame()) &&
          fullscreenIsSupported(document);
 }
 
-void Fullscreen::didEnterFullscreenForElement(Element* element) {
-  DCHECK(element);
+void Fullscreen::didEnterFullscreen() {
   if (!document()->isActive() || !document()->frame())
     return;
 
+  // Start the timer for events enqueued by |requestFullscreen()|. The hover
+  // state update is scheduled first so that it's done when the events fire.
+  document()->frame()->eventHandler().scheduleHoverStateUpdate();
+  m_eventQueueTimer.startOneShot(0, BLINK_FROM_HERE);
+
+  Element* element = m_pendingFullscreenElement.release();
+  if (!element)
+    return;
+
   if (m_currentFullScreenElement == element)
     return;
 
+  if (!element->isConnected() || &element->document() != document()) {
+    // The element was removed or has moved to another document since the
+    // |requestFullscreen()| call. Exit fullscreen again to recover.
+    // TODO(foolip): Fire a fullscreenerror event. This is currently difficult
+    // because the fullscreenchange event has already been enqueued and possibly
+    // even fired. https://crbug.com/402376
+    LocalFrame& frame = *document()->frame();
+    frame.chromeClient().exitFullscreen(frame);
+    return;
+  }
+
   if (m_fullScreenLayoutObject)
     m_fullScreenLayoutObject->unwrapLayoutObject();
 
   Element* previousElement = m_currentFullScreenElement;
   m_currentFullScreenElement = element;
 
   // Create a placeholder block for a the full-screen element, to keep the page
   // from reflowing when the element is removed from the normal flow. Only do
   // this for a LayoutBox, as only a box will have a frameRect. The placeholder
   // will be created in setFullScreenLayoutObject() during layout.
@@ skipping 27 matching lines @@
 
   m_currentFullScreenElement
       ->setContainsFullScreenElementOnAncestorsCrossingFrameBoundaries(true);
 
   document()->styleEngine().ensureUAStyleForFullscreen();
   m_currentFullScreenElement->pseudoStateChanged(CSSSelector::PseudoFullScreen);
 
   // FIXME: This should not call updateStyleAndLayoutTree.
   document()->updateStyleAndLayoutTree();
 
-  document()->frame()->eventHandler().scheduleHoverStateUpdate();
-
-  m_eventQueueTimer.startOneShot(0, BLINK_FROM_HERE);
-
   document()->frame()->chromeClient().fullscreenElementChanged(previousElement,
                                                                element);
 }
 
 void Fullscreen::didExitFullscreen() {
   if (!document()->isActive() || !document()->frame())
     return;
 
+  // Start the timer for events enqueued by |exitFullscreen()|. The hover state
+  // update is scheduled first so that it's done when the events fire.
+  document()->frame()->eventHandler().scheduleHoverStateUpdate();
+  m_eventQueueTimer.startOneShot(0, BLINK_FROM_HERE);
+
+  // If fullscreen was canceled by the browser, e.g. if the user pressed Esc,
+  // then |exitFullscreen()| was never called. Let |fullyExitFullscreen()| clear
+  // the fullscreen element stack and fire any events as necessary.
+  // TODO(foolip): Remove this when state changes and events are synchronized
+  // with animation frames. https://crbug.com/402376
+  fullyExitFullscreen(*document());
+
   if (!m_currentFullScreenElement)
     return;
 
   if (m_forCrossProcessDescendant)
     m_currentFullScreenElement->setContainsFullScreenElement(false);
 
   m_currentFullScreenElement
       ->setContainsFullScreenElementOnAncestorsCrossingFrameBoundaries(false);
 
   if (m_fullScreenLayoutObject)
     LayoutFullScreenItem(m_fullScreenLayoutObject).unwrapLayoutObject();
 
   document()->styleEngine().ensureUAStyleForFullscreen();
   m_currentFullScreenElement->pseudoStateChanged(CSSSelector::PseudoFullScreen);
   Element* previousElement = m_currentFullScreenElement;
   m_currentFullScreenElement = nullptr;
 
-  document()->frame()->eventHandler().scheduleHoverStateUpdate();
-
-  // When fullyExitFullscreen is called, we call exitFullscreen on the
-  // topDocument(). That means that the events will be queued there. So if we
-  // have no events here, start the timer on the exiting document.
-  Document* exitingDocument = document();
-  if (m_eventQueue.isEmpty())
-    exitingDocument = &topmostLocalAncestor(*document());
-  DCHECK(exitingDocument);
-  from(*exitingDocument).m_eventQueueTimer.startOneShot(0, BLINK_FROM_HERE);
-
   m_forCrossProcessDescendant = false;
 
   document()->frame()->chromeClient().fullscreenElementChanged(previousElement,
                                                                nullptr);
 }
 
 void Fullscreen::setFullScreenLayoutObject(LayoutFullScreen* layoutObject) {
   if (layoutObject == m_fullScreenLayoutObject)
     return;
 
@@ skipping 28 matching lines @@
     DCHECK(document.hasFullscreenSupplement());
     Fullscreen& fullscreen = from(document);
     EventTarget* target = fullscreen.fullscreenElement();
     if (!target)
       target = fullscreen.currentFullScreenElement();
     if (!target)
       target = &document;
     event = createEvent(EventTypeNames::webkitfullscreenchange, *target);
   }
   m_eventQueue.append(event);
-  // NOTE: The timer is started in
-  // didEnterFullscreenForElement/didExitFullscreen.
+  // NOTE: The timer is started in didEnterFullscreen/didExitFullscreen.
 }
 
 void Fullscreen::enqueueErrorEvent(Element& element, RequestType requestType) {
   Event* event;
   if (requestType == UnprefixedRequest)
     event = createEvent(EventTypeNames::fullscreenerror, element.document());
   else
     event = createEvent(EventTypeNames::webkitfullscreenerror, element);
   m_eventQueue.append(event);
   m_eventQueueTimer.startOneShot(0, BLINK_FROM_HERE);
@@ skipping 52 matching lines @@
 
   m_fullscreenElementStack.pop_back();
 }
 
 void Fullscreen::pushFullscreenElementStack(Element& element,
                                             RequestType requestType) {
   m_fullscreenElementStack.append(std::make_pair(&element, requestType));
 }
 
 DEFINE_TRACE(Fullscreen) {
+  visitor->trace(m_pendingFullscreenElement);
+  visitor->trace(m_fullscreenElementStack);
   visitor->trace(m_currentFullScreenElement);
-  visitor->trace(m_fullscreenElementStack);
   visitor->trace(m_eventQueue);
   Supplement<Document>::trace(visitor);
   ContextLifecycleObserver::trace(visitor);
 }
 
 }  // namespace blink