add customized printing setting for headless

headless/lib/browser/headless_print_manager.cc

 // 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 "headless/lib/browser/headless_print_manager.h"
 
 #include <utility>
 #include <vector>
 
 #include "base/base64.h"
+#include "base/memory/ptr_util.h"
+#include "base/strings/utf_string_conversions.h"
 #include "components/printing/browser/print_manager_utils.h"
 #include "components/printing/common/print_messages.h"
 #include "printing/pdf_metafile_skia.h"
-#include "printing/print_settings.h"
+#include "printing/print_job_constants.h"
 #include "printing/units.h"
+#include "ui/gfx/geometry/size_f.h"
 
 DEFINE_WEB_CONTENTS_USER_DATA_KEY(printing::HeadlessPrintManager);
 
 namespace printing {
 
-namespace {
+HeadlessPrintSettings::HeadlessPrintSettings()
+    : dpi(kDefaultPdfDpi),
+      paper_type(LETTER),
+      margin_type(DEFAULT_MARGINS),
+      landscape(false),
+      display_header_footer(false),
+      should_print_backgrounds(false),
+      scale(1) {}
 
-// TODO(jzfeng): let the print settings to be configurable.
-const double kTopMarginInInch = 0.25;
-const double kBottomMarginInInch = 0.56;
-const double kLeftMarginInInch = 0.25;
-const double kRightMarginInInch = 0.25;
+HeadlessPrintSettings::HeadlessPrintSettings(const HeadlessPrintSettings& obj) =
+    default;
+HeadlessPrintSettings::~HeadlessPrintSettings() = default;
 
-PrintSettings GetDefaultPDFPrinterSettings() {
+int HeadlessPrintSettings::GetDPI() {

[Eric Seckler, 2017/04/20 09:15:28]

nit: this doesn't always return the DPI, so should probably have a different
method name?

[jzfeng, 2017/04/27 06:56:06]

Removed this method since setting different dpi doesn't really work.

 #if defined(OS_MACOSX)
   // On the Mac, the printable area is in points, use kPointsPerInch to compute
   // its bounds.
-  int dpi = kPointsPerInch;
+  return kPointsPerInch;
 #else
-  int dpi = kDefaultPdfDpi;
+  return dpi;
 #endif
-  gfx::Size physical_size_device_units;
-  gfx::Rect printable_area_device_units;
-  double page_width_in_pixel = kLetterWidthInch * dpi;
-  double page_height_in_pixel = kLetterHeightInch * dpi;
-  physical_size_device_units.SetSize(static_cast<int>(page_width_in_pixel),
-                                     static_cast<int>(page_height_in_pixel));
-  printable_area_device_units.SetRect(
-      static_cast<int>(kLeftMarginInInch * dpi),
-      static_cast<int>(kTopMarginInInch * dpi),
-      page_width_in_pixel - (kLeftMarginInInch + kRightMarginInInch) * dpi,
-      page_height_in_pixel - (kTopMarginInInch + kBottomMarginInInch) * dpi);
-
-  PrintSettings settings;
-  settings.set_dpi(dpi);
-  settings.SetPrinterPrintableArea(physical_size_device_units,
-                                   printable_area_device_units, true);
-  settings.set_should_print_backgrounds(true);
-  return settings;
 }
 
-}  // namespace
+gfx::Size HeadlessPrintSettings::PaperSizeInPixel() {

[Eric Seckler, 2017/04/20 09:15:28]

nit: PaperSizeInPixelsOrPoints

[jzfeng, 2017/04/27 06:56:06]

Change to PaperSizeInPoints.

+  gfx::SizeF paper_size(kLetterWidthInch, kLetterHeightInch);
+  switch (paper_type) {
+    case LEGAL:
+      paper_size.SetSize(kLegalWidthInch, kLegalHeightInch);
+      break;
+    case A4:
+      paper_size.SetSize(kA4WidthInch, kA4HeightInch);
+      break;
+    case A3:
+      paper_size.SetSize(kA3WidthInch, kA3HeightInch);
+      break;
+    default:  // LETTER is used for default fallback.
+      break;
+  }
+  return gfx::Size(paper_size.width() * GetDPI(),
+                   paper_size.height() * GetDPI());
+}
+
+PageMargins HeadlessPrintSettings::MarginInPoints() {
+  PageMargins margins_in_points;
+  margins_in_points.top = margin_top_in_inch * kPointsPerInch;
+  margins_in_points.bottom = margin_bottom_in_inch * kPointsPerInch;
+  margins_in_points.left = margin_left_in_inch * kPointsPerInch;
+  margins_in_points.right = margin_right_in_inch * kPointsPerInch;
+  return margins_in_points;
+}
 
 HeadlessPrintManager::HeadlessPrintManager(content::WebContents* web_contents)
     : PrintManager(web_contents) {
   Reset();
 }
 
 HeadlessPrintManager::~HeadlessPrintManager() {}
 
 // static
 std::string HeadlessPrintManager::PrintResultToString(PrintResult result) {
   switch (result) {
     case PRINT_SUCCESS:
       return std::string();  // no error message
     case PRINTING_FAILED:
       return "Printing failed";
     case INVALID_PRINTER_SETTINGS:
       return "Show invalid printer settings error";
     case INVALID_MEMORY_HANDLE:
       return "Invalid memory handle";
     case METAFILE_MAP_ERROR:
       return "Map to shared memory error";
     case UNEXPECTED_VALID_MEMORY_HANDLE:
       return "Unexpected valide memory handle";
     case METAFILE_INVALID_HEADER:
       return "Invalid metafile header";
     case METAFILE_GET_DATA_ERROR:
       return "Get data from metafile error";
     case SIMULTANEOUS_PRINT_ACTIVE:
       return "The previous printing job hasn't finished";
+    case EXCEED_PAGE_LIMIT:
+      return "Page range exceed page count";

[Eric Seckler, 2017/04/20 09:15:28]

nit: exceeds

[jzfeng, 2017/04/27 06:56:06]

Done.

     default:
       NOTREACHED();
       return "Unknown PrintResult";
   }
 }
 
 // static
 std::unique_ptr<base::DictionaryValue>
 HeadlessPrintManager::PDFContentsToDictionaryValue(const std::string& data) {
   std::string base_64_data;
   base::Base64Encode(data, &base_64_data);
   auto result = base::MakeUnique<base::DictionaryValue>();
   result->SetString("data", base_64_data);
   return result;
 }
 
 void HeadlessPrintManager::GetPDFContents(content::RenderFrameHost* rfh,
+                                          HeadlessPrintSettings settings,
                                           const GetPDFCallback& callback) {
   DCHECK(callback);
 
   if (callback_) {
     callback.Run(SIMULTANEOUS_PRINT_ACTIVE, std::string());
     return;
   }
   printing_rfh_ = rfh;
   callback_ = callback;
+  print_params_ = PrintParams(settings);
   rfh->Send(new PrintMsg_PrintPages(rfh->GetRoutingID()));
 }
 
+std::unique_ptr<PrintMsg_PrintPages_Params> HeadlessPrintManager::PrintParams(
+    HeadlessPrintSettings settings) {
+  PrintSettings print_settings;
+  print_settings.set_dpi(settings.GetDPI());
+  print_settings.set_should_print_backgrounds(
+      settings.should_print_backgrounds);
+  print_settings.set_scale_factor(settings.scale);
+  print_settings.SetOrientation(settings.landscape);
+  print_settings.set_ranges(settings.page_ranges);
+
+  print_settings.set_display_header_footer(settings.display_header_footer);
+  if (print_settings.display_header_footer()) {
+    print_settings.set_url(

[Lei Zhang, 2017/04/20 08:35:58]

Do you need to set the page title as well? Sanitize the URL? (See
PrintPreviewHandler::HandleGetPreview())

[jzfeng, 2017/04/27 06:56:06]

Setting page title doesn't work in most case, since in print_web_view_helper.cc,
there is 

options->SetString("title", title.empty() ? params.title : title);

where title is usually not empty (actually I don't know when would it be empty),
so params.title is not  used.

+        base::UTF8ToUTF16(printing_rfh_->GetLastCommittedURL().spec()));
+  }
+
+  print_settings.set_margin_type(settings.margin_type);
+  if (settings.margin_type == CUSTOM_MARGINS)
+    print_settings.SetCustomMargins(settings.MarginInPoints());
+
+  gfx::Size physical_size_device_units = settings.PaperSizeInPixel();
+  gfx::Rect printable_area_device_units(physical_size_device_units);
+  print_settings.SetPrinterPrintableArea(physical_size_device_units,
+                                         printable_area_device_units, true);
+
+  auto print_params = base::MakeUnique<PrintMsg_PrintPages_Params>();
+  RenderParamsFromPrintSettings(print_settings, &print_params->params);
+  print_params->params.document_cookie = PrintSettings::NewCookie();
+  print_params->pages = PageRange::GetPages(settings.page_ranges);
+  return print_params;
+}
+
 bool HeadlessPrintManager::OnMessageReceived(
     const IPC::Message& message,
     content::RenderFrameHost* render_frame_host) {
   bool handled = true;
   IPC_BEGIN_MESSAGE_MAP(HeadlessPrintManager, message)
     IPC_MESSAGE_HANDLER(PrintHostMsg_ShowInvalidPrinterSettingsError,
                         OnShowInvalidPrinterSettingsError)
     IPC_MESSAGE_HANDLER(PrintHostMsg_DidPrintPage, OnDidPrintPage)
     IPC_MESSAGE_HANDLER_DELAY_REPLY(PrintHostMsg_GetDefaultPrintSettings,
                                     OnGetDefaultPrintSettings)
+    IPC_MESSAGE_HANDLER_DELAY_REPLY(PrintHostMsg_ScriptedPrint, OnScriptedPrint)
     IPC_MESSAGE_UNHANDLED(handled = false)
   IPC_END_MESSAGE_MAP()
   return handled || PrintManager::OnMessageReceived(message, render_frame_host);
 }
 
 void HeadlessPrintManager::OnGetDefaultPrintSettings(IPC::Message* reply_msg) {
-  PrintMsg_Print_Params print_params;
-  RenderParamsFromPrintSettings(GetDefaultPDFPrinterSettings(), &print_params);
-  print_params.document_cookie = PrintSettings::NewCookie();
   PrintHostMsg_GetDefaultPrintSettings::WriteReplyParams(reply_msg,
-                                                         print_params);
+                                                         print_params_->params);
   printing_rfh_->Send(reply_msg);
 }
 
+void HeadlessPrintManager::OnScriptedPrint(
+    const PrintHostMsg_ScriptedPrint_Params& params,
+    IPC::Message* reply_msg) {
+  if (!print_params_->pages.empty() &&
+      print_params_->pages.back() > params.expected_pages_count) {

[Lei Zhang, 2017/04/20 08:35:58]

Is the vector of pages sorted? If the range input is "1-3,9-10,4-6" does back()
return 10 or 6?

[jzfeng, 2017/04/27 06:56:06]

Yes, it is sorted. PageRange::GetPages use a set to store the pages, and convert
it into vector. The default order is ascending.

+    printing_rfh_->Send(reply_msg);
+    ReleaseJob(EXCEED_PAGE_LIMIT);
+    return;
+  }
+
+  PrintHostMsg_ScriptedPrint::WriteReplyParams(reply_msg, *print_params_);
+  printing_rfh_->Send(reply_msg);
+}
+
 void HeadlessPrintManager::OnShowInvalidPrinterSettingsError() {
   ReleaseJob(INVALID_PRINTER_SETTINGS);
 }
 
 void HeadlessPrintManager::OnPrintingFailed(int cookie) {
   ReleaseJob(PRINTING_FAILED);
 }
 
+void HeadlessPrintManager::OnDidGetPrintedPagesCount(int cookie,
+                                                     int number_pages) {
+  PrintManager::OnDidGetPrintedPagesCount(cookie, number_pages);
+  if (!print_params_->pages.empty())
+    number_pages_ = print_params_->pages.size();

[Lei Zhang, 2017/04/20 08:35:58]

Why do we need to do this?

[jzfeng, 2017/04/27 06:56:06]

number_pages returned from the renderer is always the page_count of the file,
not the actual number of printed pages. We need the actual number to check
whether the job has finished in OnDidPrintPage.

[Lei Zhang, 2017/04/27 22:17:46]

Is this the issue described in https://crbug.com/161576 ? I wonder how
PrintManager deals with it.

[jzfeng, 2017/05/02 07:50:55]

The bug you found is right. The reason why chrome is not affected by this is
because, it doesn't use number_pages to check the completeness. As shown in
PrintedDocument::IsComplete, it checks whether all the requested pages have the
metafile instead.

+}
+
 void HeadlessPrintManager::OnDidPrintPage(
     const PrintHostMsg_DidPrintPage_Params& params) {
   if (!callback_) {
     DLOG(ERROR)
         << "Unexpected PrintHostMsg_DidPrintPage message from the renderer";
     return;
   }
 
   const bool metafile_must_be_valid = expecting_first_page_;
   expecting_first_page_ = false;
@@ skipping 28 matching lines @@
     }
   }
 
   if (--number_pages_ == 0)
     ReleaseJob(PRINT_SUCCESS);
 }
 
 void HeadlessPrintManager::Reset() {
   printing_rfh_ = nullptr;
   callback_.Reset();
+  print_params_.reset(nullptr);

[Lei Zhang, 2017/04/20 08:35:58]

There's no need to pass nullptr to std::unique_ptr::reset().

[jzfeng, 2017/04/27 06:56:06]

Done.

   data_.clear();
   expecting_first_page_ = true;
   number_pages_ = 0;
 }
 
 void HeadlessPrintManager::ReleaseJob(PrintResult result) {
   if (!callback_) {
     DLOG(ERROR) << "ReleaseJob is called when callback_ is null. Check whether "
                    "ReleaseJob is called more than once.";
     return;
   }
 
   if (result == PRINT_SUCCESS)
     callback_.Run(result, std::move(data_));
   else
     callback_.Run(result, std::string());
   printing_rfh_->Send(new PrintMsg_PrintingDone(printing_rfh_->GetRoutingID(),
                                                 result == PRINT_SUCCESS));
   Reset();
 }
 
 }  // namespace printing