Delegates for the printing component

chrome/renderer/printing/print_web_view_helper.cc

 // Copyright (c) 2012 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 "chrome/renderer/printing/print_web_view_helper.h"
 
 #include <string>
 
 #include "base/auto_reset.h"
-#include "base/command_line.h"
 #include "base/json/json_writer.h"
 #include "base/logging.h"
 #include "base/message_loop/message_loop.h"
 #include "base/metrics/histogram.h"
 #include "base/process/process_handle.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/strings/stringprintf.h"
 #include "base/strings/utf_string_conversions.h"
-#include "chrome/common/chrome_switches.h"
 #include "chrome/common/print_messages.h"
-#include "chrome/common/render_messages.h"
-#include "chrome/grit/browser_resources.h"
-#include "chrome/renderer/prerender/prerender_helper.h"
+#include "chrome/renderer/printing/print_web_view_helper_delegate.h"
 #include "content/public/common/web_preferences.h"
 #include "content/public/renderer/render_frame.h"
 #include "content/public/renderer/render_thread.h"
 #include "content/public/renderer/render_view.h"
 #include "net/base/escape.h"
 #include "printing/pdf_metafile_skia.h"
 #include "printing/units.h"
 #include "third_party/WebKit/public/platform/WebSize.h"
 #include "third_party/WebKit/public/platform/WebURLRequest.h"
 #include "third_party/WebKit/public/web/WebConsoleMessage.h"
 #include "third_party/WebKit/public/web/WebDocument.h"
 #include "third_party/WebKit/public/web/WebElement.h"
 #include "third_party/WebKit/public/web/WebFrameClient.h"
 #include "third_party/WebKit/public/web/WebLocalFrame.h"
 #include "third_party/WebKit/public/web/WebPlugin.h"
 #include "third_party/WebKit/public/web/WebPluginDocument.h"
 #include "third_party/WebKit/public/web/WebPrintParams.h"
 #include "third_party/WebKit/public/web/WebPrintPresetOptions.h"
 #include "third_party/WebKit/public/web/WebPrintScalingOption.h"
 #include "third_party/WebKit/public/web/WebScriptSource.h"
 #include "third_party/WebKit/public/web/WebSettings.h"
 #include "third_party/WebKit/public/web/WebView.h"
 #include "third_party/WebKit/public/web/WebViewClient.h"
-#include "ui/base/resource/resource_bundle.h"
-
-#if defined(ENABLE_EXTENSIONS)
-#include "chrome/common/extensions/extension_constants.h"
-#include "extensions/common/constants.h"
-#endif  // defined(ENABLE_EXTENSIONS)
 
 using content::WebPreferences;
 
 namespace printing {
 
 namespace {
 
 enum PrintPreviewHelperEvents {
   PREVIEW_EVENT_REQUESTED,
   PREVIEW_EVENT_CACHE_HIT,  // Unused
@@ skipping 340 matching lines @@
   }
 
   if (fit_to_page) {
     double factor = FitPrintParamsToPage(params, &result_params);
     if (scale_factor)
       *scale_factor = factor;
   }
   return result_params;
 }
 
-// Return the PDF object element if |frame| is the out of process PDF extension.
-blink::WebElement GetPdfElement(blink::WebLocalFrame* frame) {
-#if defined(ENABLE_EXTENSIONS)
-  GURL url = frame->document().url();
-  if (url.SchemeIs(extensions::kExtensionScheme) &&

[Vitaly Buka (NO REVIEWS), 2015/01/05 19:57:03]

Is this because of extensions?
Seems components are allowed to deppend on /src/extensions/
Ex. components/renderer_context_menu/context_menu_content_type.cc

[dgn, 2015/01/05 22:45:47]

That was about the extensionId but apparently it's copied in many places
already. I guess it's ok to have it here also.

-      url.host() == extension_misc::kPdfExtensionId) {
-    // <object> with id="plugin" is created in
-    // chrome/browser/resources/pdf/pdf.js.
-    auto plugin_element = frame->document().getElementById("plugin");
-    if (!plugin_element.isNull()) {
-      return plugin_element;
-    }
-    NOTREACHED();
-  }
-#endif  // defined(ENABLE_EXTENSIONS)
-  return blink::WebElement();
-}
-
 }  // namespace
 
 FrameReference::FrameReference(blink::WebLocalFrame* frame) {
   Reset(frame);
 }
 
 FrameReference::FrameReference() {
   Reset(NULL);
 }
 
@@ skipping 42 matching lines @@
                                page_layout.content_width,
                            page_layout.margin_top + page_layout.margin_bottom +
                                page_layout.content_height);
 
   blink::WebView* web_view = blink::WebView::create(NULL);
   web_view->settings()->setJavaScriptEnabled(true);
 
   blink::WebLocalFrame* frame = blink::WebLocalFrame::create(NULL);
   web_view->setMainFrame(frame);
 
-  base::StringValue html(ResourceBundle::GetSharedInstance().GetLocalizedString(
-      IDR_PRINT_PREVIEW_PAGE));
   // Load page with script to avoid async operations.

[Vitaly Buka (NO REVIEWS), 2015/01/05 19:57:03]

this resource has nothing chrome specific so it should be moved to components as
well

check how it's done for 

https://code.google.com/p/chromium/codesearch#search/&q=IDR_TRANSLATE_JS&sq=p...

[dgn, 2015/01/05 22:45:47]

Acknowledged.

-  ExecuteScript(frame, kPageLoadScriptFormat, html);
+  ExecuteScript(frame, kPageLoadScriptFormat, delegate_->GetPrintPreviewHtml());
 
   scoped_ptr<base::DictionaryValue> options(new base::DictionaryValue());
   options.reset(new base::DictionaryValue());
   options->SetDouble(kSettingHeaderFooterDate, base::Time::Now().ToJsTime());
   options->SetDouble("width", page_size.width);
   options->SetDouble("height", page_size.height);
   options->SetDouble("topMargin", page_layout.margin_top);
   options->SetDouble("bottomMargin", page_layout.margin_bottom);
   options->SetString("pageNumber",
                      base::StringPrintf("%d/%d", page_number, total_pages));
@@ skipping 276 matching lines @@
     if (owns_web_view_) {
       DCHECK(!frame->isLoading());
       owns_web_view_ = false;
       web_view->close();
     }
   }
   frame_.Reset(NULL);
   on_ready_.Reset();
 }
 
-PrintWebViewHelper::PrintWebViewHelper(content::RenderView* render_view)
+PrintWebViewHelper::PrintWebViewHelper(
+    content::RenderView* render_view,
+    scoped_ptr<PrintWebViewHelperDelegate> delegate)
     : content::RenderViewObserver(render_view),
       content::RenderViewObserverTracker<PrintWebViewHelper>(render_view),
       reset_prep_frame_view_(false),
       is_print_ready_metafile_sent_(false),
       ignore_css_margins_(false),
       is_scripted_printing_blocked_(false),
       notify_browser_of_print_failure_(true),
       print_for_preview_(false),
+      delegate_(delegate.Pass()),
       print_node_in_progress_(false),
       is_loading_(false),
       is_scripted_preview_delayed_(false),
       weak_ptr_factory_(this) {
-  if (CommandLine::ForCurrentProcess()->HasSwitch(

[Vitaly Buka (NO REVIEWS), 2015/01/05 19:57:03]

this switch could go to components
not sure yet if we will have other switches there

[dgn, 2015/01/05 22:45:47]

Replaced with a constructor argument

-          switches::kDisablePrintPreview)) {
+  if (delegate_->PrintPreviewDisabled()) {
     DisablePreview();
   }
 }
 
 PrintWebViewHelper::~PrintWebViewHelper() {}
 
 // static
 void PrintWebViewHelper::DisablePreview() {
   g_is_preview_enabled_ = false;
 }
@@ skipping 19 matching lines @@
     on_stop_loading_closure_.Run();
     on_stop_loading_closure_.Reset();
   }
 }
 
 // Prints |frame| which called window.print().
 void PrintWebViewHelper::PrintPage(blink::WebLocalFrame* frame,
                                    bool user_initiated) {
   DCHECK(frame);
 
-  // Allow Prerendering to cancel this print request if necessary.
-  if (prerender::PrerenderHelper::IsPrerendering(
-          render_view()->GetMainRenderFrame())) {
-    Send(new ChromeViewHostMsg_CancelPrerenderForPrinting(routing_id()));
+  // In Chrome, allows prerendering to cancel this print request if necessary.
+  IPC::Message* cancel_message = delegate_->GetScriptedPrintCancelMessage(
+          render_view(), routing_id());
+  if (cancel_message) {
+    Send(cancel_message);
     return;
   }
 
   if (!IsScriptInitiatedPrintAllowed(frame, user_initiated))
     return;
 
   if (!g_is_preview_enabled_) {
     Print(frame, blink::WebNode(), true);
   } else {
     print_preview_context_.InitWithFrame(frame);
@@ skipping 38 matching lines @@
   if (pdf_element.isNull()) {
     NOTREACHED();
     return;
   }
 
   // The out-of-process plugin element is nested within a frame. In tests, there
   // may not be an iframe containing the out-of-process plugin, so continue with
   // the element with ID "pdf-viewer" if it isn't an iframe.
   blink::WebLocalFrame* plugin_frame = pdf_element.document().frame();
   blink::WebElement plugin_element = pdf_element;
-  if (switches::OutOfProcessPdfEnabled() &&
+  if (delegate_->OutOfProcessPdfEnabled() &&
       pdf_element.hasHTMLTagName("iframe")) {
     plugin_frame = blink::WebLocalFrame::fromFrameOwnerElement(pdf_element);
-    plugin_element = GetPdfElement(plugin_frame);
+    plugin_element = delegate_->GetPdfElement(plugin_frame);
     if (plugin_element.isNull()) {
       NOTREACHED();
       return;
     }
   }
 
   // Set |print_for_preview_| flag and autoreset it to back to original
   // on return.
   base::AutoReset<bool> set_printing_flag(&print_for_preview_, true);
 
@@ skipping 39 matching lines @@
   return true;
 }
 
 #if defined(ENABLE_BASIC_PRINTING)
 void PrintWebViewHelper::OnPrintPages() {
   blink::WebLocalFrame* frame;
   if (!GetPrintFrame(&frame))
     return;
   // If we are printing a PDF extension frame, find the plugin node and print
   // that instead.
-  auto plugin = GetPdfElement(frame);
+  auto plugin = delegate_->GetPdfElement(frame);
   Print(frame, plugin, false);
 }
 
 void PrintWebViewHelper::OnPrintForSystemDialog() {
   blink::WebLocalFrame* frame = print_preview_context_.source_frame();
   if (!frame) {
     NOTREACHED();
     return;
   }
   Print(frame, print_preview_context_.source_node(), false);
@@ skipping 234 matching lines @@
 void PrintWebViewHelper::SetScriptedPrintBlocked(bool blocked) {
   is_scripted_printing_blocked_ = blocked;
 }
 
 void PrintWebViewHelper::OnInitiatePrintPreview(bool selection_only) {
   blink::WebLocalFrame* frame = NULL;
   GetPrintFrame(&frame);
   DCHECK(frame);
   // If we are printing a PDF extension frame, find the plugin node and print
   // that instead.
-  auto plugin = GetPdfElement(frame);
+  auto plugin = delegate_->GetPdfElement(frame);
   if (!plugin.isNull()) {
     PrintNode(plugin);
     return;
   }
   print_preview_context_.InitWithFrame(frame);
   RequestPrintPreview(selection_only ?
                       PRINT_PREVIEW_USER_INITIATED_SELECTION :
                       PRINT_PREVIEW_USER_INITIATED_ENTIRE_FRAME);
 }
 
@@ skipping 817 matching lines @@
       blink::WebConsoleMessage::LevelWarning, message));
   return false;
 }
 
 void PrintWebViewHelper::ScriptingThrottler::Reset() {
   // Reset counter on successful print.
   count_ = 0;
 }
 
 }  // namespace printing