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

third_party/WebKit/Source/modules/media_controls/elements/MediaControlDownloadButtonElement.cpp

 // Copyright 2017 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "modules/media_controls/elements/MediaControlDownloadButtonElement.h"
 
 #include "core/InputTypeNames.h"
 #include "core/events/Event.h"
+#include "core/frame/LocalFrameClient.h"
 #include "core/frame/Settings.h"
 #include "core/html/HTMLAnchorElement.h"
 #include "core/html/HTMLMediaElement.h"
 #include "core/html/media/HTMLMediaElementControlsList.h"
 #include "core/html/media/HTMLMediaSource.h"
 #include "core/page/Page.h"
 #include "modules/media_controls/MediaControlsImpl.h"
 #include "platform/Histogram.h"
+#include "platform/wtf/Functional.h"
 #include "public/platform/Platform.h"
+#include "services/service_manager/public/cpp/interface_provider.h"
 
 namespace blink {
 
 MediaControlDownloadButtonElement::MediaControlDownloadButtonElement(
     MediaControlsImpl& media_controls)
     : MediaControlInputElement(media_controls, kMediaDownloadButton) {
   EnsureUserAgentShadowRoot();
   setType(InputTypeNames::button);
   SetShadowPseudoId(AtomicString("-internal-media-controls-download-button"));
   SetIsWanted(false);
@@ skipping 56 matching lines @@
 bool MediaControlDownloadButtonElement::HasOverflowButton() {
   return true;
 }
 
 void MediaControlDownloadButtonElement::SetIsWanted(bool wanted) {
   MediaControlElement::SetIsWanted(wanted);
 
   if (!IsWanted())
     return;
 
-  DCHECK(IsWanted());
   if (!show_use_counted_) {
     show_use_counted_ = true;
     RecordMetrics(DownloadActionMetrics::kShown);
   }
+
+  // If the button is wanted, show IPH if possible.
+  MaybeDispatchInProductHelpTrigger();
+  UpdateInProductHelpState();
 }
 
 DEFINE_TRACE(MediaControlDownloadButtonElement) {
   visitor->Trace(anchor_);
   MediaControlInputElement::Trace(visitor);
 }
 
 void MediaControlDownloadButtonElement::DefaultEventHandler(Event* event) {
   const KURL& url = MediaElement().currentSrc();
   if (event->type() == EventTypeNames::click &&
@@ skipping 16 matching lines @@
 }
 
 void MediaControlDownloadButtonElement::RecordMetrics(
     DownloadActionMetrics metric) {
   DEFINE_STATIC_LOCAL(EnumerationHistogram, download_action_histogram,
                       ("Media.Controls.Download",
                        static_cast<int>(DownloadActionMetrics::kCount)));
   download_action_histogram.Count(static_cast<int>(metric));
 }
 
+void MediaControlDownloadButtonElement::MaybeDispatchInProductHelpTrigger() {

[mlamouri (slow - plz ping), 2017/07/13 21:14:27]

For what I can see, this setting up the mojo pipe. Is it triggering anything?

[Khushal, 2017/07/17 17:52:21]

MaybeShow would have called UpdateInProductHelpState which triggers showing. Now
this triggers it directly.

+  if (!media_download_in_product_trigger_observed_ && IsWanted() &&
+      !MediaElement().paused() && MediaElement().GetDocument().GetSettings() &&
+      MediaElement()
+          .GetDocument()
+          .GetSettings()
+          ->GetMediaDownloadInProductHelpEnabled()) {

[mlamouri (slow - plz ping), 2017/07/13 21:14:27]

For readability, can you do an early return?

[Khushal, 2017/07/17 17:52:21]

Done.

+    DCHECK(!media_in_product_help_);
+
+    media_download_in_product_trigger_observed_ = true;
+    media_in_product_help_ =
+        WTF::MakeUnique<mojom::blink::MediaInProductHelpPtr>();
+    MediaElement()
+        .GetDocument()
+        .GetFrame()

[mlamouri (slow - plz ping), 2017/07/13 21:14:27]

Can you check that `GetFrame()` doesn't return `nullptr`?

[Khushal, 2017/07/17 17:52:21]

Done.

+        ->Client()
+        ->GetInterfaceProvider()
+        ->GetInterface(mojo::MakeRequest(media_in_product_help_.get()));
+    media_in_product_help_->set_connection_error_handler(
+        ConvertToBaseCallback(WTF::Bind(
+            &MediaControlDownloadButtonElement::DismissDownloadInProductHelp,
+            WrapWeakPersistent(this))));
+    GetMediaControls().MaybeShow();

[mlamouri (slow - plz ping), 2017/07/13 21:14:27]

Does that mean that when a download button will be added, we will show the
controls if they are not already showing?

[Khushal, 2017/07/17 17:52:21]

I updated the code to take the CanShow aspect into account, but yes, if we can
show the controls and a download button is added, this will make them visible.

+  }
+}
+
+void MediaControlDownloadButtonElement::UpdateInProductHelpState() {

[mlamouri (slow - plz ping), 2017/07/13 21:14:27]

Isn't this method actually triggering the UI?

[Khushal, 2017/07/17 17:52:21]

Restructured to move this into MaybeDispatchInProductHelpTrigger.

+  if (!media_in_product_help_)
+    return;
+
+  if (static_cast<MediaControlsImpl&>(GetMediaControls()).IsVisible() &&
+      IsWanted()) {
+    (*media_in_product_help_)
+        ->ShowInProductHelpWidget(VisibleBoundsInVisualViewport());
+    return;
+  }
+
+  DismissDownloadInProductHelp();
+}
+
+void MediaControlDownloadButtonElement::DismissDownloadInProductHelp() {
+  media_in_product_help_.reset();
+  static_cast<MediaControlsImpl&>(GetMediaControls()).HideControlsIfNecessary();
+}
+
+bool MediaControlDownloadButtonElement::IsShowingInProductHelp() const {
+  return !!media_in_product_help_;
+}
+
 }  // namespace blink