Refactor webview to use //components/printing

Some printing related //android_webview were copied over from
//chrome. Now that the ones in //chrome can move to a component,
webview should also use these files.

Depends on https://codereview.chromium.org/811563008/

BUG=444883, 311308

Review URL: https://codereview.chromium.org/822133003

Cr-Commit-Position: refs/heads/master@{#314307}

android_webview/android_webview.gyp

@@ -103,6 +103,8 @@
         '../components/components.gyp:cdm_renderer',
         '../components/components.gyp:data_reduction_proxy_core_browser',
         '../components/components.gyp:navigation_interception',
+        '../components/components.gyp:printing_common',
+        '../components/components.gyp:printing_renderer',
         '../components/components.gyp:visitedlink_browser',
         '../components/components.gyp:visitedlink_renderer',
         '../components/components.gyp:web_contents_delegate_android',
@@ -235,8 +237,6 @@
         'common/aw_switches.cc',
         'common/aw_switches.h',
         'common/devtools_instrumentation.h',
-        'common/print_messages.cc',
-        'common/print_messages.h',
         'common/render_view_messages.cc',
         'common/render_view_messages.h',
         'common/url_constants.cc',
@@ -254,16 +254,14 @@
         'renderer/aw_message_port_client.h',
         'renderer/aw_permission_client.cc',
         'renderer/aw_permission_client.h',
+        'renderer/aw_print_web_view_helper_delegate.cc',
+        'renderer/aw_print_web_view_helper_delegate.h',
         'renderer/aw_render_process_observer.cc',
         'renderer/aw_render_process_observer.h',
         'renderer/aw_render_frame_ext.cc',
         'renderer/aw_render_frame_ext.h',
         'renderer/aw_render_view_ext.cc',
         'renderer/aw_render_view_ext.h',
-        'renderer/print_web_view_helper.cc',
-        'renderer/print_web_view_helper.h',
-        'renderer/print_web_view_helper_android.cc',
-        'renderer/print_web_view_helper_linux.cc',
         'renderer/print_render_frame_observer.cc',
         'renderer/print_render_frame_observer.h',
       ],

android_webview/browser/DEPS

@@ -16,6 +16,7 @@ include_rules = [
   "+components/cdm/browser",
   "+components/data_reduction_proxy/core/browser",
   "+components/navigation_interception",
+  "+components/printing/common",
   "+components/user_prefs",
   "+components/visitedlink/browser",
   "+components/webdata/common",

android_webview/browser/aw_printing_message_filter.cc

@@ -5,7 +5,7 @@
 #include "android_webview/browser/aw_printing_message_filter.h"
 
 #include "android_webview/browser/renderer_host/print_manager.h"
-#include "android_webview/common/print_messages.h"
+#include "components/printing/common/print_messages.h"
 #include "content/public/browser/browser_thread.h"
 #include "content/public/browser/render_view_host.h"
 #include "content/public/browser/web_contents.h"

android_webview/browser/renderer_host/print_manager.cc

@@ -5,12 +5,12 @@
 #include "android_webview/browser/renderer_host/print_manager.h"
 
 #include "android_webview/browser/aw_browser_context.h"
-#include "android_webview/common/print_messages.h"
 #include "android_webview/common/render_view_messages.h"
 #include "base/android/scoped_java_ref.h"
 #include "base/callback.h"
 #include "base/files/file_util.h"
 #include "base/logging.h"
+#include "components/printing/common/print_messages.h"
 #include "content/public/browser/browser_thread.h"
 #include "printing/print_settings.h"
 

android_webview/common/DEPS

 include_rules = [
   "-android_webview",
   "+android_webview/common",
-
-# TODO(sgurun) remove these deps after crbug.com/322276 is resolved
-  "+printing",
-  "+third_party/WebKit/public/web/WebPrintScalingOption.h",
-  "+ui/gfx/native_widget_types.h",
-  "+ui/gfx/rect.h",
-  "+ui/gfx/size.h",
-
-  "+ui/gl/gpu_memory_buffer.h",
+  "+components/printing/common",
 ]

android_webview/common/android_webview_message_generator.h

@@ -5,5 +5,4 @@
 // Multiply-included file, hence no include guard.
 
 #include "android_webview/common/aw_message_port_messages.h"
-#include "android_webview/common/print_messages.h"
 #include "android_webview/common/render_view_messages.h"

android_webview/common/print_messages.cc

-// Copyright 2013 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.
-
-// TODO(sgurun) copied from chrome/common. Remove after crbug.com/322276
-
-#include "android_webview/common/print_messages.h"
-
-#include "base/basictypes.h"
-#include "base/strings/string16.h"
-#include "ui/gfx/geometry/size.h"
-
-PrintMsg_Print_Params::PrintMsg_Print_Params()
-  : page_size(),
-    content_size(),
-    printable_area(),
-    margin_top(0),
-    margin_left(0),
-    dpi(0),
-    min_shrink(0),
-    max_shrink(0),
-    desired_dpi(0),
-    document_cookie(0),
-    selection_only(false),
-    supports_alpha_blend(false),
-    preview_ui_id(-1),
-    preview_request_id(0),
-    is_first_request(false),
-    print_scaling_option(blink::WebPrintScalingOptionSourceSize),
-    print_to_pdf(false),
-    display_header_footer(false),
-    title(),
-    url(),
-    should_print_backgrounds(false) {
-}
-
-PrintMsg_Print_Params::~PrintMsg_Print_Params() {}
-
-void PrintMsg_Print_Params::Reset() {
-  page_size = gfx::Size();
-  content_size = gfx::Size();
-  printable_area = gfx::Rect();
-  margin_top = 0;
-  margin_left = 0;
-  dpi = 0;
-  min_shrink = 0;
-  max_shrink = 0;
-  desired_dpi = 0;
-  document_cookie = 0;
-  selection_only = false;
-  supports_alpha_blend = false;
-  preview_ui_id = -1;
-  preview_request_id = 0;
-  is_first_request = false;
-  print_scaling_option = blink::WebPrintScalingOptionSourceSize;
-  print_to_pdf = false;
-  display_header_footer = false;
-  title = base::string16();
-  url = base::string16();
-  should_print_backgrounds = false;
-}
-
-PrintMsg_PrintPages_Params::PrintMsg_PrintPages_Params()
-  : pages() {
-}
-
-PrintMsg_PrintPages_Params::~PrintMsg_PrintPages_Params() {}
-
-void PrintMsg_PrintPages_Params::Reset() {
-  params.Reset();
-  pages = std::vector<int>();
-}
-
-PrintHostMsg_RequestPrintPreview_Params::
-    PrintHostMsg_RequestPrintPreview_Params()
-    : is_modifiable(false),
-      webnode_only(false),
-      has_selection(false),
-      selection_only(false) {
-}
-
-PrintHostMsg_RequestPrintPreview_Params::
-    ~PrintHostMsg_RequestPrintPreview_Params() {}

android_webview/renderer/DEPS

@@ -5,6 +5,8 @@ include_rules = [
 
   "+components/autofill/content/renderer",
   "+components/cdm/renderer",
+  "+components/printing/common",
+  "+components/printing/renderer",
   "+components/visitedlink/renderer",
 
   "+content/public/renderer",

android_webview/renderer/aw_content_renderer_client.cc

@@ -10,14 +10,15 @@
 #include "android_webview/renderer/aw_key_systems.h"
 #include "android_webview/renderer/aw_message_port_client.h"
 #include "android_webview/renderer/aw_permission_client.h"
+#include "android_webview/renderer/aw_print_web_view_helper_delegate.h"
 #include "android_webview/renderer/aw_render_frame_ext.h"
 #include "android_webview/renderer/aw_render_view_ext.h"
 #include "android_webview/renderer/print_render_frame_observer.h"
-#include "android_webview/renderer/print_web_view_helper.h"
 #include "base/message_loop/message_loop.h"
 #include "base/strings/utf_string_conversions.h"
 #include "components/autofill/content/renderer/autofill_agent.h"
 #include "components/autofill/content/renderer/password_autofill_agent.h"
+#include "components/printing/renderer/print_web_view_helper.h"
 #include "components/visitedlink/renderer/visitedlink_slave.h"
 #include "content/public/common/url_constants.h"
 #include "content/public/renderer/document_state.h"
@@ -147,7 +148,10 @@ void AwContentRendererClient::RenderViewCreated(
     content::RenderView* render_view) {
   AwRenderViewExt::RenderViewCreated(render_view);
 
-  new printing::PrintWebViewHelper(render_view);
+  new printing::PrintWebViewHelper(
+      render_view,
+      scoped_ptr<printing::PrintWebViewHelper::Delegate>(
+          new AwPrintWebViewHelperDelegate()));
 }
 
 bool AwContentRendererClient::HasErrorPage(int http_status_code,

android_webview/renderer/aw_print_web_view_helper_delegate.cc

+// Copyright 2015 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 "android_webview/renderer/aw_print_web_view_helper_delegate.h"
+
+#include "third_party/WebKit/public/web/WebElement.h"
+
+namespace android_webview {
+
+AwPrintWebViewHelperDelegate::~AwPrintWebViewHelperDelegate(){
+}
+
+bool AwPrintWebViewHelperDelegate::CancelPrerender(
+    content::RenderView* render_view, int routing_id) {
+  return false;
+}
+
+blink::WebElement AwPrintWebViewHelperDelegate::GetPdfElement(
+    blink::WebLocalFrame* frame) {
+  return blink::WebElement();
+}
+
+bool AwPrintWebViewHelperDelegate::IsOutOfProcessPdfEnabled() {
+  return false;
+}
+
+bool AwPrintWebViewHelperDelegate::IsPrintPreviewEnabled() {
+  return false;
+}
+
+bool AwPrintWebViewHelperDelegate::IsAskPrintSettingsEnabled() {
+  return false;
+}
+
+bool AwPrintWebViewHelperDelegate::IsScriptedPrintEnabled() {
+  return false;
+}
+
+bool AwPrintWebViewHelperDelegate::OverridePrint(blink::WebLocalFrame* frame) {
+  return false;
+}
+
+}  // namespace android_webview

android_webview/renderer/aw_print_web_view_helper_delegate.h

+// Copyright 2015 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.
+
+#ifndef ANDROID_WEBVIEW_RENDERER_AW_PRINT_WEB_VIEW_HELPER_DELEGATE_H_
+#define ANDROID_WEBVIEW_RENDERER_AW_PRINT_WEB_VIEW_HELPER_DELEGATE_H_
+
+#include "components/printing/renderer/print_web_view_helper.h"
+
+namespace android_webview {
+
+class AwPrintWebViewHelperDelegate
+    : public printing::PrintWebViewHelper::Delegate {
+ public:
+  ~AwPrintWebViewHelperDelegate() override;
+  bool CancelPrerender(content::RenderView* render_view,
+                       int routing_id) override;
+  blink::WebElement GetPdfElement(blink::WebLocalFrame* frame) override;
+  bool IsOutOfProcessPdfEnabled() override;
+  bool IsPrintPreviewEnabled() override;
+  bool IsAskPrintSettingsEnabled() override;
+  bool IsScriptedPrintEnabled() override;
+  bool OverridePrint(blink::WebLocalFrame* frame) override;
+};  // class AwPrintWebViewHelperDelegate
+
+}  // namespace android_webview
+
+#endif  // ANDROID_WEBVIEW_RENDERER_AW_PRINT_WEB_VIEW_HELPER_DELEGATE_H_

android_webview/renderer/print_render_frame_observer.cc

@@ -4,8 +4,8 @@
 
 #include "android_webview/renderer/print_render_frame_observer.h"
 
-#include "android_webview/common/print_messages.h"
-#include "android_webview/renderer/print_web_view_helper.h"
+#include "components/printing/common/print_messages.h"
+#include "components/printing/renderer/print_web_view_helper.h"
 #include "content/public/renderer/render_frame.h"
 
 namespace android_webview {

android_webview/renderer/print_web_view_helper_android.cc

-// Copyright 2013 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.
-
-// All the necessary logic already lives in print_web_view_helper_linux.cc.
-// We need a separate file for Android due to build/filename_rules.gypi rules.
-
-// TODO(sgurun) copied from chrome/renderer. Remove after crbug.com/322276
-
-#include "android_webview/renderer/print_web_view_helper_linux.cc"

android_webview/renderer/print_web_view_helper_linux.cc

-// Copyright 2013 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.
-
-// TODO(sgurun) copied from chrome/renderer. Remove after crbug.com/322276
-
-#include "android_webview/renderer/print_web_view_helper.h"
-
-#include "android_webview/common/print_messages.h"
-#include "base/logging.h"
-#include "base/memory/scoped_ptr.h"
-#include "content/public/renderer/render_thread.h"
-#include "printing/metafile_skia_wrapper.h"
-#include "printing/page_size_margins.h"
-#include "printing/pdf_metafile_skia.h"
-#include "skia/ext/platform_device.h"
-#include "skia/ext/vector_canvas.h"
-#include "third_party/WebKit/public/web/WebLocalFrame.h"
-
-#if !defined(OS_CHROMEOS) && !defined(OS_ANDROID)
-#include "base/process/process_handle.h"
-#else
-#include "base/file_descriptor_posix.h"
-#endif  // !defined(OS_CHROMEOS) && !defined(OS_ANDROID)
-
-namespace printing {
-
-using blink::WebFrame;
-
-bool PrintWebViewHelper::RenderPreviewPage(
-    int page_number,
-    const PrintMsg_Print_Params& print_params) {
-  PrintMsg_PrintPage_Params page_params;
-  page_params.params = print_params;
-  page_params.page_number = page_number;
-  scoped_ptr<PdfMetafileSkia> draft_metafile;
-  PdfMetafileSkia* initial_render_metafile = print_preview_context_.metafile();
-  if (print_preview_context_.IsModifiable() && is_print_ready_metafile_sent_) {
-    draft_metafile.reset(new PdfMetafileSkia);
-    initial_render_metafile = draft_metafile.get();
-  }
-
-  base::TimeTicks begin_time = base::TimeTicks::Now();
-  PrintPageInternal(page_params,
-                    print_preview_context_.GetPrintCanvasSize(),
-                    print_preview_context_.prepared_frame(),
-                    initial_render_metafile);
-  print_preview_context_.RenderedPreviewPage(
-      base::TimeTicks::Now() - begin_time);
-  if (draft_metafile.get()) {
-    draft_metafile->FinishDocument();
-  } else if (print_preview_context_.IsModifiable() &&
-             print_preview_context_.generate_draft_pages()) {
-    DCHECK(!draft_metafile.get());
-    draft_metafile =
-        print_preview_context_.metafile()->GetMetafileForCurrentPage();
-  }
-  return PreviewPageRendered(page_number, draft_metafile.get());
-}
-
-bool PrintWebViewHelper::PrintPagesNative(blink::WebFrame* frame,
-                                          int page_count,
-                                          const gfx::Size& canvas_size) {
-  PdfMetafileSkia metafile;
-  if (!metafile.Init())
-    return false;
-
-  const PrintMsg_PrintPages_Params& params = *print_pages_params_;
-  std::vector<int> printed_pages;
-
-  if (params.pages.empty()) {
-    for (int i = 0; i < page_count; ++i) {
-      printed_pages.push_back(i);
-    }
-  } else {
-    // TODO(vitalybuka): redesign to make more code cross platform.
-    for (size_t i = 0; i < params.pages.size(); ++i) {
-      if (params.pages[i] >= 0 && params.pages[i] < page_count) {
-        printed_pages.push_back(params.pages[i]);
-      }
-    }
-  }
-
-  if (printed_pages.empty())
-    return false;
-
-  PrintMsg_PrintPage_Params page_params;
-  page_params.params = params.params;
-  for (size_t i = 0; i < printed_pages.size(); ++i) {
-    page_params.page_number = printed_pages[i];
-    PrintPageInternal(page_params, canvas_size, frame, &metafile);
-  }
-
-  // blink::printEnd() for PDF should be called before metafile is closed.
-  FinishFramePrinting();
-
-  metafile.FinishDocument();
-
-  // Get the size of the resulting metafile.
-  uint32 buf_size = metafile.GetDataSize();
-  DCHECK_GT(buf_size, 0u);
-
-#if defined(OS_CHROMEOS) || defined(OS_ANDROID)
-  int sequence_number = -1;
-  base::FileDescriptor fd;
-
-  // Ask the browser to open a file for us.
-  Send(new PrintHostMsg_AllocateTempFileForPrinting(routing_id(),
-                                                    &fd,
-                                                    &sequence_number));
-  if (!metafile.SaveToFD(fd))
-    return false;
-
-  // Tell the browser we've finished writing the file.
-  Send(new PrintHostMsg_TempFileForPrintingWritten(routing_id(),
-                                                   sequence_number));
-  return true;
-#else
-  PrintHostMsg_DidPrintPage_Params printed_page_params;
-  printed_page_params.data_size = 0;
-  printed_page_params.document_cookie = params.params.document_cookie;
-
-  {
-    scoped_ptr<base::SharedMemory> shared_mem(
-        content::RenderThread::Get()->HostAllocateSharedMemoryBuffer(
-            buf_size).release());
-    if (!shared_mem.get()) {
-      NOTREACHED() << "AllocateSharedMemoryBuffer failed";
-      return false;
-    }
-
-    if (!shared_mem->Map(buf_size)) {
-      NOTREACHED() << "Map failed";
-      return false;
-    }
-    metafile.GetData(shared_mem->memory(), buf_size);
-    printed_page_params.data_size = buf_size;
-    shared_mem->GiveToProcess(base::GetCurrentProcessHandle(),
-                              &(printed_page_params.metafile_data_handle));
-  }
-
-  for (size_t i = 0; i < printed_pages.size(); ++i) {
-    printed_page_params.page_number = printed_pages[i];
-    Send(new PrintHostMsg_DidPrintPage(routing_id(), printed_page_params));
-    // Send the rest of the pages with an invalid metafile handle.
-    printed_page_params.metafile_data_handle.fd = -1;
-  }
-  return true;
-#endif  // defined(OS_CHROMEOS) || defined(OS_ANDROID)
-}
-
-void PrintWebViewHelper::PrintPageInternal(
-    const PrintMsg_PrintPage_Params& params,
-    const gfx::Size& canvas_size,
-    WebFrame* frame,
-    PdfMetafileSkia* metafile) {
-  PageSizeMargins page_layout_in_points;
-  double scale_factor = 1.0f;
-  ComputePageLayoutInPointsForCss(frame, params.page_number, params.params,
-                                  ignore_css_margins_, &scale_factor,
-                                  &page_layout_in_points);
-  gfx::Size page_size;
-  gfx::Rect content_area;
-  GetPageSizeAndContentAreaFromPageLayout(page_layout_in_points, &page_size,
-                                          &content_area);
-  gfx::Rect canvas_area =
-      params.params.display_header_footer ? gfx::Rect(page_size) : content_area;
-
-  skia::VectorCanvas* canvas =
-      metafile->GetVectorCanvasForNewPage(page_size, canvas_area, scale_factor);
-  if (!canvas)
-    return;
-
-  MetafileSkiaWrapper::SetMetafileOnCanvas(*canvas, metafile);
-  skia::SetIsDraftMode(*canvas, is_print_ready_metafile_sent_);
-
-  if (params.params.display_header_footer) {
-    // |page_number| is 0-based, so 1 is added.
-    // TODO(vitalybuka) : why does it work only with 1.25?
-    PrintHeaderAndFooter(canvas, params.page_number + 1,
-                         print_preview_context_.total_page_count(),
-                         scale_factor / 1.25, page_layout_in_points,
-                         *header_footer_info_, params.params);
-  }
-  RenderPageContent(frame, params.page_number, canvas_area, content_area,
-                    scale_factor, canvas);
-
-  // Done printing. Close the canvas to retrieve the compiled metafile.
-  if (!metafile->FinishPage())
-    NOTREACHED() << "metafile failed";
-}
-
-}  // namespace printing

components/components.gyp

@@ -140,10 +140,8 @@
         'webdata_services.gypi',
       ],
     }],
-    ['android_webview_build == 0 and OS != "ios"', {
+    ['enable_basic_printing==1 or enable_print_preview==1', {
       'includes': [
-        # TODO(dgn) move it to a condition based on whether print is enabled
-        # once the duplicates have been removed from webview.
         'printing.gypi',
       ],
     }],

components/printing/renderer/print_web_view_helper.cc

@@ -756,6 +756,14 @@ void PrepareFrameAndViewForPrint::FinishPrinting() {
   on_ready_.Reset();
 }
 
+bool PrintWebViewHelper::Delegate::IsAskPrintSettingsEnabled() {
+  return true;
+}
+
+bool PrintWebViewHelper::Delegate::IsScriptedPrintEnabled() {
+  return true;
+}
+
 PrintWebViewHelper::PrintWebViewHelper(
     content::RenderView* render_view,
     scoped_ptr<Delegate> delegate)
@@ -785,6 +793,9 @@ void PrintWebViewHelper::DisablePreview() {
 
 bool PrintWebViewHelper::IsScriptInitiatedPrintAllowed(
     blink::WebFrame* frame, bool user_initiated) {
+  if (!delegate_->IsScriptedPrintEnabled())
+    return false;
+
   // If preview is enabled, then the print dialog is tab modal, and the user
   // can always close the tab on a mis-behaving page (the system print dialog
   // is app modal). If the print was initiated through user action, don't
@@ -1259,7 +1270,8 @@ void PrintWebViewHelper::Print(blink::WebLocalFrame* frame,
   }
 
   // Ask the browser to show UI to retrieve the final print settings.
-  if (!GetPrintSettingsFromUser(frame_ref.GetFrame(), node,
+  if (delegate_->IsAskPrintSettingsEnabled() &&
+      !GetPrintSettingsFromUser(frame_ref.GetFrame(), node,
                                 expected_page_count,
                                 is_scripted)) {
     DidFinishPrinting(OK);  // Release resources and fail silently.

components/printing/renderer/print_web_view_helper.h

@@ -85,6 +85,14 @@ class PrintWebViewHelper
 
     virtual bool IsPrintPreviewEnabled() = 0;
 
+    // If true, the user can be asked to provide print settings.
+    // The default implementation returns |true|.
+    virtual bool IsAskPrintSettingsEnabled();
+
+    // If false, window.print() won't do anything.
+    // The default implementation returns |true|.
+    virtual bool IsScriptedPrintEnabled();
+
     // Returns true if printing is overridden and the default behavior should be
     // skipped for |frame|.
     virtual bool OverridePrint(blink::WebLocalFrame* frame) = 0;