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 20 matching lines @@
 #include "core/dom/Fullscreen.h"
 #include "core/dom/MutationCallback.h"
 #include "core/dom/MutationObserver.h"
 #include "core/dom/MutationObserverInit.h"
 #include "core/dom/MutationRecord.h"
 #include "core/dom/ResizeObserver.h"
 #include "core/dom/ResizeObserverEntry.h"
 #include "core/dom/TaskRunnerHelper.h"
 #include "core/events/KeyboardEvent.h"
 #include "core/events/MouseEvent.h"
+#include "core/frame/LocalFrameClient.h"
 #include "core/frame/Settings.h"
 #include "core/frame/UseCounter.h"
 #include "core/html/HTMLMediaElement.h"
 #include "core/html/HTMLVideoElement.h"
 #include "core/html/media/AutoplayPolicy.h"
 #include "core/html/media/HTMLMediaElementControlsList.h"
 #include "core/html/track/TextTrackContainer.h"
 #include "core/html/track/TextTrackList.h"
 #include "core/layout/LayoutObject.h"
 #include "core/layout/LayoutTheme.h"
@@ skipping 16 matching lines @@
 #include "modules/media_controls/elements/MediaControlPlayButtonElement.h"
 #include "modules/media_controls/elements/MediaControlRemainingTimeDisplayElement.h"
 #include "modules/media_controls/elements/MediaControlTextTrackListElement.h"
 #include "modules/media_controls/elements/MediaControlTimelineElement.h"
 #include "modules/media_controls/elements/MediaControlToggleClosedCaptionsButtonElement.h"
 #include "modules/media_controls/elements/MediaControlVolumeSliderElement.h"
 #include "modules/remoteplayback/HTMLMediaElementRemotePlayback.h"
 #include "modules/remoteplayback/RemotePlayback.h"
 #include "platform/EventDispatchForbiddenScope.h"
 #include "platform/RuntimeEnabledFeatures.h"
+#include "platform/wtf/Functional.h"
+#include "services/service_manager/public/cpp/interface_provider.h"
 
 namespace blink {
 
 namespace {
 
 // TODO(steimel): should have better solution than hard-coding pixel values.
 // Defined in core/css/mediaControls.css, core/css/mediaControlsAndroid.css,
 // and core/paint/MediaControlsPainter.cpp.
 constexpr int kOverlayPlayButtonWidth = 48;
 constexpr int kOverlayPlayButtonHeight = 48;
@@ skipping 469 matching lines @@
 
 void MediaControlsImpl::OnControlsListUpdated() {
   BatchedControlUpdate batch(this);
 
   fullscreen_button_->SetIsWanted(ShouldShowFullscreenButton(MediaElement()));
 
   RefreshCastButtonVisibilityWithoutUpdate();
 
   download_button_->SetIsWanted(
       download_button_->ShouldDisplayDownloadButton());
+  UpdateDownloadInProductHelpState();
 }
 
 LayoutObject* MediaControlsImpl::PanelLayoutObject() {
   return panel_->GetLayoutObject();
 }
 
 LayoutObject* MediaControlsImpl::ContainerLayoutObject() {
   return GetLayoutObject();
 }
 
 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();
+  UpdateDownloadInProductHelpState();
 }
 
 void MediaControlsImpl::Hide() {
   panel_->SetIsWanted(false);
   panel_->SetIsDisplayed(false);
   if (overlay_play_button_)
     overlay_play_button_->SetIsWanted(false);
+  UpdateDownloadInProductHelpState();
 }
 
 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 (media_in_product_help_)
+    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 308 matching lines @@
   UpdateCurrentTimeDisplay();
 
   // Update the timeline (the UI with the seek marker).
   timeline_->SetDuration(duration);
 }
 
 void MediaControlsImpl::OnPlay() {
   UpdatePlayState();
   timeline_->SetPosition(MediaElement().currentTime());
   UpdateCurrentTimeDisplay();
+  MaybeDispatchDownloadIPHTrigger();
 }
 
 void MediaControlsImpl::OnPlaying() {
   timeline_->OnPlaying();
 
   StartHideMediaControlsTimer();
 }
 
 void MediaControlsImpl::OnPause() {
   UpdatePlayState();
@@ skipping 225 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::MaybeDispatchDownloadIPHTrigger() {

[whywhat, 2017/07/10 15:29:28]

nit: I think we should either use IPH or InProductHelp everywhere consistently,
no exceptions.

[Khushal, 2017/07/10 20:38:02]

Done.

+  if (!media_download_in_product_trigger_observed_ &&
+      download_button_->IsWanted() &&
+      MediaElement().GetDocument().GetSettings() &&
+      MediaElement()
+          .GetDocument()
+          .GetSettings()
+          ->GetMediaDownloadInProductHelpEnabled()) {
+    DCHECK(!media_in_product_help_);
+
+    media_download_in_product_trigger_observed_ = true;
+    media_in_product_help_ =
+        WTF::MakeUnique<mojom::blink::MediaInProductHelpPtr>();
+    MediaElement()
+        .GetDocument()
+        .GetFrame()
+        ->Client()
+        ->GetInterfaceProvider()
+        ->GetInterface(mojo::MakeRequest(media_in_product_help_.get()));
+    media_in_product_help_->set_connection_error_handler(ConvertToBaseCallback(
+        WTF::Bind(&MediaControlsImpl::DismissDownloadInProductHelp,
+                  WrapWeakPersistent(this))));
+    MaybeShow();
+  }
+}
+
+void MediaControlsImpl::UpdateDownloadInProductHelpState() {
+  if (!media_in_product_help_)
+    return;
+
+  if (IsVisible() && download_button_->IsWanted()) {
+    (*media_in_product_help_)
+        ->ShowInProductHelpWidget(
+            download_button_->VisibleBoundsInVisualViewport());
+    return;
+  }
+
+  DismissDownloadInProductHelp();
+}
+
+void MediaControlsImpl::DismissDownloadInProductHelp() {
+  media_in_product_help_.reset();
+  if (ShouldHideMediaControls())
+    StartHideMediaControlsTimer();
+}
+
 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_);
@@ skipping 10 matching lines @@
   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_);
   MediaControls::Trace(visitor);
   HTMLDivElement::Trace(visitor);
 }
 
 }  // namespace blink