chrome/blink: Add functionality for in-product help for media elements.

third_party/WebKit/Source/modules/media_controls/MediaControlsImpl.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 34 matching lines @@
 #include "core/html/track/TextTrackList.h"
 #include "core/layout/LayoutObject.h"
 #include "core/layout/LayoutTheme.h"
 #include "core/page/SpatialNavigation.h"
 #include "core/resize_observer/ResizeObserver.h"
 #include "core/resize_observer/ResizeObserverEntry.h"
 #include "modules/media_controls/MediaControlsMediaEventListener.h"
 #include "modules/media_controls/MediaControlsOrientationLockDelegate.h"
 #include "modules/media_controls/MediaControlsRotateToFullscreenDelegate.h"
 #include "modules/media_controls/MediaControlsWindowEventListener.h"
+#include "modules/media_controls/MediaDownloadInProductHelpManager.h"
 #include "modules/media_controls/elements/MediaControlCastButtonElement.h"
 #include "modules/media_controls/elements/MediaControlCurrentTimeDisplayElement.h"
 #include "modules/media_controls/elements/MediaControlDownloadButtonElement.h"
 #include "modules/media_controls/elements/MediaControlFullscreenButtonElement.h"
 #include "modules/media_controls/elements/MediaControlMuteButtonElement.h"
 #include "modules/media_controls/elements/MediaControlOverflowMenuButtonElement.h"
 #include "modules/media_controls/elements/MediaControlOverflowMenuListElement.h"
 #include "modules/media_controls/elements/MediaControlOverlayEnclosureElement.h"
 #include "modules/media_controls/elements/MediaControlOverlayPlayButtonElement.h"
 #include "modules/media_controls/elements/MediaControlPanelElement.h"
@@ skipping 225 matching lines @@
       resize_observer_(ResizeObserver::Create(
           media_element.GetDocument(),
           new MediaControlsResizeObserverDelegate(this))),
       element_size_changed_timer_(
           TaskRunnerHelper::Get(TaskType::kUnspecedTimer,
                                 &media_element.GetDocument()),
           this,
           &MediaControlsImpl::ElementSizeChangedTimerFired),
       keep_showing_until_timer_fires_(false) {
   resize_observer_->observe(&media_element);
+  CreateDownloadInProductHelp();

[mlamouri (slow - plz ping), 2017/08/16 13:09:30]

Can you move this in ::Create()?

[Khushal, 2017/08/16 19:01:22]

Done.

 }
 
 MediaControlsImpl* MediaControlsImpl::Create(HTMLMediaElement& media_element,
                                              ShadowRoot& shadow_root) {
   MediaControlsImpl* controls = new MediaControlsImpl(media_element);
   controls->SetShadowPseudoId(AtomicString("-webkit-media-controls"));
   controls->InitializeControls();
   controls->Reset();
 
   if (RuntimeEnabledFeatures::VideoFullscreenOrientationLockEnabled() &&
@@ skipping 254 matching lines @@
 }
 
 void MediaControlsImpl::MaybeShow() {
   panel_->SetIsWanted(true);
   panel_->SetIsDisplayed(true);
   if (overlay_play_button_)
     overlay_play_button_->UpdateDisplayType();
   // Only make the controls visible if they won't get hidden by OnTimeUpdate.
   if (MediaElement().paused() || !ShouldHideMediaControls())
     MakeOpaque();
+  if (download_iph_manager_)
+    download_iph_manager_->SetControlsState(true);

[mlamouri (slow - plz ping), 2017/08/16 13:09:30]

Similar to the download button "state", could this be "SetControlsVisibility"? I
assume this is what it's actually used for, is that correct?

[Khushal, 2017/08/16 19:01:22]

I wasn't sure if I should call it SetControlsVisibility since it states whether
the controls can show, not necessarily that they are. But the param passed is
|can_show| so I guess that should make it obvious.

 }
 
 void MediaControlsImpl::Hide() {
   panel_->SetIsWanted(false);
   panel_->SetIsDisplayed(false);
   if (overlay_play_button_)
     overlay_play_button_->SetIsWanted(false);
+  if (download_iph_manager_)
+    download_iph_manager_->SetControlsState(false);
 }
 
 bool MediaControlsImpl::IsVisible() const {
   return panel_->IsOpaque();
 }
 
 void MediaControlsImpl::MakeOpaque() {
   panel_->MakeOpaque();
 }
 
@@ skipping 35 matching lines @@
   const bool ignore_focus = behavior_flags & kIgnoreFocus;
   if (!ignore_focus && (MediaElement().IsFocused() ||
                         contains(GetDocument().FocusedElement()))) {
     return false;
   }
 
   // Don't hide the media controls when a panel is showing.
   if (text_track_list_->IsWanted() || overflow_list_->IsWanted())
     return false;
 
+  // Don't hide the media controls while the in product help is showing.
+  if (download_iph_manager_ && download_iph_manager_->IsShowingInProductHelp())
+    return false;
+
   return true;
 }
 
 void MediaControlsImpl::UpdatePlayState() {
   if (is_paused_for_scrubbing_)
     return;
 
   if (overlay_play_button_)
     overlay_play_button_->UpdateDisplayType();
   play_button_->UpdateDisplayType();
@@ skipping 163 matching lines @@
     }
 
     return;
   }
 
   if (event->type() == EventTypeNames::pointerover) {
     if (!ContainsRelatedTarget(event)) {
       is_mouse_over_controls_ = true;
       if (!MediaElement().paused()) {
         MakeOpaque();
-        if (ShouldHideMediaControls())
-          StartHideMediaControlsTimer();
+        StartHideMediaControlsIfNecessary();
       }
     }
     return;
   }
 
   if (event->type() == EventTypeNames::pointerout) {
     if (!ContainsRelatedTarget(event)) {
       is_mouse_over_controls_ = false;
       StopHideMediaControlsTimer();
     }
@@ skipping 124 matching lines @@
   UpdateCurrentTimeDisplay();
 
   // Update the timeline (the UI with the seek marker).
   timeline_->SetDuration(duration);
 }
 
 void MediaControlsImpl::OnPlay() {
   UpdatePlayState();
   timeline_->SetPosition(MediaElement().currentTime());
   UpdateCurrentTimeDisplay();
+
+  if (download_iph_manager_)
+    download_iph_manager_->SetPlayState(true);

[mlamouri (slow - plz ping), 2017/08/16 13:09:30]

This should probably be called "Playback" instead of "Play" or "SetIsPlaying()"
would work too.

[Khushal, 2017/08/16 19:01:22]

Done.

 }
 
 void MediaControlsImpl::OnPlaying() {
   timeline_->OnPlaying();
 
   StartHideMediaControlsTimer();
 }
 
 void MediaControlsImpl::OnPause() {
   UpdatePlayState();
   timeline_->SetPosition(MediaElement().currentTime());
   UpdateCurrentTimeDisplay();
   MakeOpaque();
 
   StopHideMediaControlsTimer();
+
+  if (download_iph_manager_)
+    download_iph_manager_->SetPlayState(false);
 }
 
 void MediaControlsImpl::OnTextTracksAddedOrRemoved() {
   toggle_closed_captions_button_->SetIsWanted(
       MediaElement().HasClosedCaptions());
   BatchedControlUpdate batch(this);
 }
 
 void MediaControlsImpl::OnTextTracksChanged() {
   toggle_closed_captions_button_->UpdateDisplayType();
@@ skipping 223 matching lines @@
 
 void MediaControlsImpl::HideAllMenus() {
   window_event_listener_->Stop();
 
   if (overflow_list_->IsWanted())
     overflow_list_->SetIsWanted(false);
   if (text_track_list_->IsWanted())
     text_track_list_->SetVisible(false);
 }
 
+void MediaControlsImpl::StartHideMediaControlsIfNecessary() {
+  if (ShouldHideMediaControls())
+    StartHideMediaControlsTimer();
+}
+
+const MediaControlDownloadButtonElement& MediaControlsImpl::DownloadButton()
+    const {
+  return *download_button_;
+}
+
+void MediaControlsImpl::DidDismissDownloadInProductHelp() {
+  StartHideMediaControlsIfNecessary();
+}
+
+MediaDownloadInProductHelpManager* MediaControlsImpl::DownloadInProductHelp() {
+  return download_iph_manager_;
+}
+
+void MediaControlsImpl::CreateDownloadInProductHelp() {
+  // Is showing in-product help enabled?
+  if (!MediaElement().GetDocument().GetSettings() ||
+      !MediaElement()
+           .GetDocument()
+           .GetSettings()
+           ->GetMediaDownloadInProductHelpEnabled()) {
+    return;
+  }
+
+  // Download in-product-help is only shown for videos.
+  if (!MediaElement().IsHTMLVideoElement())
+    return;
+
+  download_iph_manager_ = new MediaDownloadInProductHelpManager(*this);
+}
+
 DEFINE_TRACE(MediaControlsImpl) {
   visitor->Trace(element_mutation_callback_);
   visitor->Trace(resize_observer_);
   visitor->Trace(panel_);
   visitor->Trace(overlay_play_button_);
   visitor->Trace(overlay_enclosure_);
   visitor->Trace(play_button_);
   visitor->Trace(current_time_display_);
   visitor->Trace(timeline_);
   visitor->Trace(mute_button_);
   visitor->Trace(volume_slider_);
   visitor->Trace(toggle_closed_captions_button_);
   visitor->Trace(fullscreen_button_);
   visitor->Trace(download_button_);
   visitor->Trace(duration_display_);
   visitor->Trace(enclosure_);
   visitor->Trace(text_track_list_);
   visitor->Trace(overflow_menu_);
   visitor->Trace(overflow_list_);
   visitor->Trace(cast_button_);
   visitor->Trace(overlay_cast_button_);
   visitor->Trace(media_event_listener_);
   visitor->Trace(window_event_listener_);
   visitor->Trace(orientation_lock_delegate_);
   visitor->Trace(rotate_to_fullscreen_delegate_);
+  visitor->Trace(download_iph_manager_);
   MediaControls::Trace(visitor);
   HTMLDivElement::Trace(visitor);
 }
 
 }  // namespace blink