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

third_party/WebKit/Source/core/frame/LocalFrame.cpp

 /*
  * Copyright (C) 1998, 1999 Torben Weis <weis@kde.org>
  *                     1999 Lars Knoll <knoll@kde.org>
  *                     1999 Antti Koivisto <koivisto@kde.org>
  *                     2000 Simon Hausmann <hausmann@kde.org>
  *                     2000 Stefan Schimanski <1Stein@gmx.de>
  *                     2001 George Staikos <staikos@kde.org>
  * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Apple Inc. All
  * rights reserved.
  * Copyright (C) 2005 Alexey Proskuryakov <ap@nypop.com>
@@ skipping 36 matching lines @@
 #include "core/frame/ContentSettingsClient.h"
 #include "core/frame/EventHandlerRegistry.h"
 #include "core/frame/FrameConsole.h"
 #include "core/frame/LocalDOMWindow.h"
 #include "core/frame/LocalFrameClient.h"
 #include "core/frame/LocalFrameView.h"
 #include "core/frame/PerformanceMonitor.h"
 #include "core/frame/Settings.h"
 #include "core/frame/VisualViewport.h"
 #include "core/html/HTMLFrameElementBase.h"
+#include "core/html/HTMLMediaElement.h"
 #include "core/html/HTMLPlugInElement.h"
 #include "core/html/PluginDocument.h"
 #include "core/input/EventHandler.h"
 #include "core/inspector/ConsoleMessage.h"
 #include "core/layout/HitTestResult.h"
 #include "core/layout/LayoutView.h"
 #include "core/layout/api/LayoutEmbeddedContentItem.h"
 #include "core/layout/api/LayoutViewItem.h"
 #include "core/layout/compositing/PaintLayerCompositor.h"
 #include "core/loader/DocumentLoader.h"
 #include "core/loader/FrameLoadRequest.h"
 #include "core/loader/NavigationScheduler.h"
 #include "core/page/ChromeClient.h"
 #include "core/page/FocusController.h"
 #include "core/page/Page.h"
 #include "core/page/scrolling/ScrollingCoordinator.h"
 #include "core/paint/ObjectPainter.h"
 #include "core/paint/PaintInfo.h"
 #include "core/paint/PaintLayer.h"
 #include "core/paint/PaintLayerPainter.h"
 #include "core/paint/TransformRecorder.h"
 #include "core/plugins/PluginView.h"
 #include "core/probe/CoreProbes.h"
 #include "core/svg/SVGDocumentExtensions.h"
 #include "core/timing/Performance.h"
+#include "mojo/public/cpp/bindings/strong_binding.h"
 #include "platform/DragImage.h"
 #include "platform/Histogram.h"
 #include "platform/PluginScriptForbiddenScope.h"
 #include "platform/RuntimeEnabledFeatures.h"
 #include "platform/ScriptForbiddenScope.h"
 #include "platform/WebFrameScheduler.h"
 #include "platform/graphics/GraphicsContext.h"
 #include "platform/graphics/StaticBitmapImage.h"
 #include "platform/graphics/paint/ClipRecorder.h"
 #include "platform/graphics/paint/PaintCanvas.h"
 #include "platform/graphics/paint/PaintController.h"
 #include "platform/graphics/paint/PaintRecordBuilder.h"
 #include "platform/graphics/paint/TransformDisplayItem.h"
 #include "platform/instrumentation/resource_coordinator/FrameResourceCoordinator.h"
 #include "platform/json/JSONValues.h"
 #include "platform/loader/fetch/FetchParameters.h"
 #include "platform/loader/fetch/ResourceFetcher.h"
 #include "platform/loader/fetch/ResourceRequest.h"
 #include "platform/plugins/PluginData.h"
 #include "platform/scheduler/renderer/web_view_scheduler.h"
 #include "platform/text/TextStream.h"
 #include "platform/wtf/PtrUtil.h"
 #include "platform/wtf/StdLibExtras.h"
 #include "public/platform/InterfaceProvider.h"
 #include "public/platform/InterfaceRegistry.h"
 #include "public/platform/WebScreenInfo.h"
 #include "public/platform/WebURLRequest.h"
+#include "public/platform/media_in_product_help.mojom-blink.h"
+#include "services/service_manager/public/cpp/bind_source_info.h"
+#include "services/service_manager/public/cpp/interface_provider.h"
 #include "third_party/skia/include/core/SkImage.h"
 #include "third_party/skia/include/core/SkSurface.h"
 
 namespace blink {
 
 using namespace HTMLNames;
 
 namespace {
 
 // Converts from bounds in CSS space to device space based on the given
@@ skipping 146 matching lines @@
   return ToLocalFrame(parent)->TextZoomFactor();
 }
 
 using FrameInitCallbackVector = WTF::Vector<LocalFrame::FrameInitCallback>;
 FrameInitCallbackVector& GetInitializationVector() {
   DEFINE_THREAD_SAFE_STATIC_LOCAL(FrameInitCallbackVector,
                                   initialization_vector, ());
   return initialization_vector;
 }
 
+class MediaInProductHelpDelegateService
+    : public mojom::blink::MediaInProductHelpDelegateService {
+ public:
+  explicit MediaInProductHelpDelegateService(LocalFrame& frame)
+      : frame_(&frame) {}
+  ~MediaInProductHelpDelegateService() override = default;
+
+  // chrome::MediaInProductHelpDelegateService implementation.
+  void WidgetDismissed() override {
+    if (frame_)
+      frame_->NotifyInProductHelpDismissed();
+  }
+
+ private:
+  WeakPersistent<LocalFrame> frame_;
+};
+
+void CreateMediaInProductHelpDelegateService(
+    LocalFrame* frame,
+    mojom::blink::MediaInProductHelpDelegateServiceRequest request) {
+  mojo::MakeStrongBinding(
+      WTF::WrapUnique(new MediaInProductHelpDelegateService(*frame)),
+      std::move(request));
+}
+
 }  // namespace
 
 template class CORE_TEMPLATE_EXPORT Supplement<LocalFrame>;
 
 LocalFrame* LocalFrame::Create(LocalFrameClient* client,
                                Page& page,
                                FrameOwner* owner,
                                InterfaceProvider* interface_provider,
                                InterfaceRegistry* interface_registry) {
   LocalFrame* frame = new LocalFrame(
@@ skipping 90 matching lines @@
   visitor->Trace(dom_window_);
   visitor->Trace(page_popup_owner_);
   visitor->Trace(script_controller_);
   visitor->Trace(editor_);
   visitor->Trace(spell_checker_);
   visitor->Trace(selection_);
   visitor->Trace(event_handler_);
   visitor->Trace(console_);
   visitor->Trace(input_method_controller_);
   visitor->Trace(frame_resource_coordinator_);
+  visitor->Trace(element_with_active_in_product_help_);
   Frame::Trace(visitor);
   Supplementable<LocalFrame>::Trace(visitor);
 }
 
 void LocalFrame::Navigate(Document& origin_document,
                           const KURL& url,
                           bool replace_current_item,
                           UserGestureStatus user_gesture_status) {
   navigation_scheduler_->ScheduleLocationChange(&origin_document, url,
                                                 replace_current_item);
@@ skipping 843 matching lines @@
 
 void LocalFrame::SetViewportIntersectionFromParent(
     const IntRect& viewport_intersection) {
   if (remote_viewport_intersection_ != viewport_intersection) {
     remote_viewport_intersection_ = viewport_intersection;
     if (View())
       View()->ScheduleAnimation();
   }
 }
 
+void LocalFrame::ShowDownloadMediaInProductHelp(HTMLMediaElement& elem) {

[Sam McNally, 2017/06/28 09:19:58]

Could this be handled within MediaControlDownloadButtonElement or
MediaControlsImpl? It doesn't feel like LocalFrame should need to know about
this. It seems to me that the browser is already enforcing one help widget per
WebContents so repeating that here doesn't seem necessary. If the delegate
interface is replaced with a response then the tracking of the element isn't
necessary either.

[Khushal, 2017/06/28 22:28:46]

The element had to be tracked at some place which hears about Layout changes to
send the updated position to the browser.

[Sam McNally, 2017/07/03 09:45:40]

MediaControlsImpl should be able to observe layout via its ResizeObserver.
Having every interested party add some code in LocalFrame for observing layout
doesn't seem very scalable. I'm not sure this captures all changes that might
matter, e.g. CSS visibility changes or scrolling, but I don't think observing
layout in LocalFrame would either.

[Khushal, 2017/07/07 04:18:13]

The ResizeObserver only hears about size changes in the video element, so it
captures less than what a Layout event on the Frame would have. But you're right
that it still ignores multiple changes (scrolling, etc.). Since we dismiss the
UI on any user interaction, in most cases the position of the button remains
static. I've moved the code for sending the rect to MediaControlsImpl and
restricted the update to dismissing the UI when the controls or the button are
hidden.

+  if (!GetSettings() || !GetSettings()->GetMediaDownloadInProductHelpEnabled())
+    return;
+
+  if (element_with_active_in_product_help_ ||
+      media_in_product_help_shown_for_frame_)
+    return;
+
+  if (!Client())
+    return;
+
+  // Add the service to know when this widget is dismissed.
+  GetInterfaceRegistry()->AddInterface(WTF::Bind(
+      &CreateMediaInProductHelpDelegateService, WrapWeakPersistent(this)));
+
+  element_with_active_in_product_help_ = &elem;
+  media_in_product_help_shown_for_frame_ = true;
+}
+
+bool LocalFrame::IsDownloadMediaInProductHelpVisibleForElement(
+    HTMLMediaElement& elem) {
+  return element_with_active_in_product_help_ &&
+         *element_with_active_in_product_help_ == elem;
+}
+
+void LocalFrame::NotifyMediaControlsHidden(HTMLMediaElement& elem) {
+  if (!element_with_active_in_product_help_ ||
+      *element_with_active_in_product_help_ != elem || !Client())
+    return;
+
+  mojom::blink::MediaInProductHelpServicePtr service;
+  Client()->GetInterfaceProvider()->GetInterface(mojo::MakeRequest(&service));
+  service->HideInProductHelpWidget();
+}
+
+void LocalFrame::LayoutUpdated() {
+  if (!element_with_active_in_product_help_ || !Client())
+    return;
+
+  IntRect button_rect;
+  if (!element_with_active_in_product_help_->GetMediaControls()
+           ->GetDownloadButtonRect(button_rect)) {
+    mojom::blink::MediaInProductHelpServicePtr service;
+    Client()->GetInterfaceProvider()->GetInterface(mojo::MakeRequest(&service));
+    service->HideInProductHelpWidget();
+    return;
+  }
+
+  mojom::blink::MediaInProductHelpServicePtr service;
+  Client()->GetInterfaceProvider()->GetInterface(mojo::MakeRequest(&service));
+  service->ShowInProductHelpWidget(button_rect.X(), button_rect.Y(),
+                                   button_rect.Width(), button_rect.Height());
+}
+
+void LocalFrame::NotifyInProductHelpDismissed() {
+  if (element_with_active_in_product_help_ &&
+      element_with_active_in_product_help_->GetMediaControls()) {
+    element_with_active_in_product_help_->GetMediaControls()
+        ->InProductHelpDisabled();
+  }
+  element_with_active_in_product_help_ = nullptr;
+}
+
 }  // namespace blink