Media Controls: don't activate buttons when tapping on hidden controls.

third_party/WebKit/Source/core/html/shadow/MediaControls.cpp

 /*
  * Copyright (C) 2011, 2012 Apple Inc. All rights reserved.
  * Copyright (C) 2011, 2012 Google 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
@@ skipping 115 matching lines @@
           WTF::bind(&MediaControls::hideAllMenus, wrapWeakPersistent(this)))),
       m_hideMediaControlsTimer(this,
                                &MediaControls::hideMediaControlsTimerFired),
       m_hideTimerBehaviorFlags(IgnoreNone),
       m_isMouseOverControls(false),
       m_isPausedForScrubbing(false),
       m_panelWidthChangedTimer(this,
                                &MediaControls::panelWidthChangedTimerFired),
       m_panelWidth(0),
       m_allowHiddenVolumeControls(
-          RuntimeEnabledFeatures::newMediaPlaybackUiEnabled()) {}
+          RuntimeEnabledFeatures::newMediaPlaybackUiEnabled()),
+      m_keepShowingUntilTimerFires(false) {}
 
 MediaControls* MediaControls::create(HTMLMediaElement& mediaElement) {
   MediaControls* controls = new MediaControls(mediaElement);
   controls->setShadowPseudoId(AtomicString("-webkit-media-controls"));
   controls->initializeControls();
   return controls;
 }
 
 // The media controls DOM structure looks like:
 //
@@ skipping 237 matching lines @@
   }
 }
 
 void MediaControls::hide() {
   m_panel->setIsWanted(false);
   m_panel->setIsDisplayed(false);
   if (m_overlayPlayButton)
     m_overlayPlayButton->setIsWanted(false);
 }
 
+bool MediaControls::isVisible() const {
+  return m_panel->isOpaque();
+}
+
 void MediaControls::makeOpaque() {
   m_panel->makeOpaque();
 }
 
 void MediaControls::makeTransparent() {
   m_panel->makeTransparent();
 }
 
 bool MediaControls::shouldHideMediaControls(unsigned behaviorFlags) const {
   // Never hide for a media element without visual representation.
   if (!mediaElement().isHTMLVideoElement() || !mediaElement().hasVideo() ||
-      mediaElement().isPlayingRemotely())
+      mediaElement().isPlayingRemotely()) {
     return false;
+  }
+
+  // Keep the controls visible as long as the timer is running.
+  const bool ignoreWaitForTimer = behaviorFlags & IgnoreWaitForTimer;
+  if (!ignoreWaitForTimer && m_keepShowingUntilTimerFires)
+    return false;
+
   // Don't hide if the mouse is over the controls.
   const bool ignoreControlsHover = behaviorFlags & IgnoreControlsHover;
   if (!ignoreControlsHover && m_panel->isHovered())
     return false;
+
   // Don't hide if the mouse is over the video area.
   const bool ignoreVideoHover = behaviorFlags & IgnoreVideoHover;
   if (!ignoreVideoHover && m_isMouseOverControls)
     return false;
+
   // Don't hide if focus is on the HTMLMediaElement or within the
   // controls/shadow tree. (Perform the checks separately to avoid going
   // through all the potential ancestor hosts for the focused element.)
   const bool ignoreFocus = behaviorFlags & IgnoreFocus;
   if (!ignoreFocus &&
-      (mediaElement().isFocused() || contains(document().focusedElement())))
+      (mediaElement().isFocused() || contains(document().focusedElement()))) {
     return false;
+  }
+
   // Don't hide the media controls when a panel is showing.
   if (m_textTrackList->isWanted() || m_overflowList->isWanted())
     return false;
+
   return true;
 }
 
 void MediaControls::playbackStarted() {
   BatchedControlUpdate batch(this);
 
   if (!RuntimeEnabledFeatures::newMediaPlaybackUiEnabled()) {
     m_currentTimeDisplay->setIsWanted(true);
     m_durationDisplay->setIsWanted(false);
   }
 
   updatePlayState();
   m_timeline->setPosition(mediaElement().currentTime());
   updateCurrentTimeDisplay();
 
   startHideMediaControlsTimer();
 }
 
 void MediaControls::playbackProgressed() {
   m_timeline->setPosition(mediaElement().currentTime());
   updateCurrentTimeDisplay();
 
-  if (shouldHideMediaControls())
+  if (isVisible() && shouldHideMediaControls())
     makeTransparent();
 }
 
 void MediaControls::playbackStopped() {
   updatePlayState();
   m_timeline->setPosition(mediaElement().currentTime());
   updateCurrentTimeDisplay();
   makeOpaque();
 
   stopHideMediaControlsTimer();
@@ skipping 175 matching lines @@
   m_overlayCastButton->setIsPlayingRemotely(false);
 }
 
 void MediaControls::defaultEventHandler(Event* event) {
   HTMLDivElement::defaultEventHandler(event);
 
   // Add IgnoreControlsHover to m_hideTimerBehaviorFlags when we see a touch
   // event, to allow the hide-timer to do the right thing when it fires.
   // FIXME: Preferably we would only do this when we're actually handling the
   // event here ourselves.
-  bool wasLastEventTouch =
+  bool isTouchEvent =
       event->isTouchEvent() || event->isGestureEvent() ||
       (event->isMouseEvent() && toMouseEvent(event)->fromTouch());
-  m_hideTimerBehaviorFlags |=
-      wasLastEventTouch ? IgnoreControlsHover : IgnoreNone;
+  m_hideTimerBehaviorFlags |= isTouchEvent ? IgnoreControlsHover : IgnoreNone;
+
+  // Touch events are treated differently to avoid fake mouse events to trigger
+  // random behavior. The expect behaviour for touch is that a tap will show the
+  // controls and they will hide when the timer to hide fires.
+  if (isTouchEvent) {
+    if (event->type() != EventTypeNames::gesturetap)
+      return;
+
+    if (!containsRelatedTarget(event)) {

[Zhiqiang Zhang (Slow), 2016/10/19 10:02:04]

IIUC, the following logic is to handle the event before it goes into the panel,
right?

[mlamouri (slow - plz ping), 2016/10/20 10:32:06]

Only the "setDefaultHandled" (to avoid the default handlers to run).

The rest is to get the panel to show up for 3 seconds.

+      if (!mediaElement().paused()) {
+        if (!isVisible()) {
+          makeOpaque();
+          // When the panel switches from invisible to visible, we need to mark
+          // the event handled to avoid buttons below the tap to be activated.
+          event->setDefaultHandled();
+        }
+        if (shouldHideMediaControls(IgnoreWaitForTimer)) {
+          m_keepShowingUntilTimerFires = true;
+          startHideMediaControlsTimer();
+        }
+      }
+    }
+
+    return;
+  }
 
   if (event->type() == EventTypeNames::mouseover) {
     if (!containsRelatedTarget(event)) {
       m_isMouseOverControls = true;
       if (!mediaElement().paused()) {
         makeOpaque();
         if (shouldHideMediaControls())
           startHideMediaControlsTimer();
       }
     }
@@ skipping 16 matching lines @@
     if (shouldHideMediaControls(IgnoreVideoHover))
       startHideMediaControlsTimer();
     return;
   }
 }
 
 void MediaControls::hideMediaControlsTimerFired(TimerBase*) {
   unsigned behaviorFlags =
       m_hideTimerBehaviorFlags | IgnoreFocus | IgnoreVideoHover;
   m_hideTimerBehaviorFlags = IgnoreNone;
+  m_keepShowingUntilTimerFires = false;
 
   if (mediaElement().paused())
     return;
 
   if (!shouldHideMediaControls(behaviorFlags))
     return;
 
   makeTransparent();
   m_overlayCastButton->setIsWanted(false);
 }
 
 void MediaControls::startHideMediaControlsTimer() {
   m_hideMediaControlsTimer.startOneShot(
       timeWithoutMouseMovementBeforeHidingMediaControls, BLINK_FROM_HERE);
 }
 
 void MediaControls::stopHideMediaControlsTimer() {
+  m_keepShowingUntilTimerFires = false;
   m_hideMediaControlsTimer.stop();
 }
 
 void MediaControls::resetHideMediaControlsTimer() {
   stopHideMediaControlsTimer();
   if (!mediaElement().paused())
     startHideMediaControlsTimer();
 }
 
 bool MediaControls::containsRelatedTarget(Event* event) {
@@ skipping 208 matching lines @@
   visitor->trace(m_textTrackList);
   visitor->trace(m_overflowMenu);
   visitor->trace(m_overflowList);
   visitor->trace(m_castButton);
   visitor->trace(m_overlayCastButton);
   visitor->trace(m_windowEventListener);
   HTMLDivElement::trace(visitor);
 }
 
 }  // namespace blink