Added Header and Footer support using Skia

chrome/renderer/print_web_view_helper.cc

 // Copyright (c) 2011 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/print_web_view_helper.h"
 
 #include <string>
 
 #include "base/command_line.h"
+#include "base/i18n/time_formatting.h"
 #include "base/logging.h"
 #include "base/metrics/histogram.h"
 #include "base/process_util.h"
+#include "base/time.h"
+#include "base/string_number_conversions.h"

[kmadhusu, 2011/07/14 01:50:15]

nit: ordering

[Aayush Kumar, 2011/07/19 01:20:30]

Done.

 #include "base/utf_string_conversions.h"
 #include "chrome/common/chrome_switches.h"
 #include "chrome/common/print_messages.h"
 #include "chrome/common/render_messages.h"
 #include "chrome/common/url_constants.h"
 #include "chrome/renderer/prerender/prerender_helper.h"
 #include "content/renderer/render_view.h"
 #include "grit/generated_resources.h"
 #include "printing/metafile.h"
 #include "printing/print_job_constants.h"
 #include "printing/units.h"
+#include "skia/ext/vector_platform_device_skia.h"
+#include "third_party/skia/include/core/SkTypeface.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebConsoleMessage.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebDataSource.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebDocument.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebElement.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebFrame.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebNode.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebSize.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebURLRequest.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebURLResponse.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebView.h"
 #include "ui/base/l10n/l10n_util.h"
+#include "ui/base/text/text_elider.h"
 
 #if defined(OS_POSIX)
 #include "content/common/view_messages.h"
 #endif
 
+using base::Time;
 using printing::ConvertPixelsToPoint;
 using printing::ConvertPixelsToPointDouble;
 using printing::ConvertUnit;
 using printing::ConvertUnitDouble;
 using WebKit::WebConsoleMessage;
 using WebKit::WebDocument;
 using WebKit::WebElement;
 using WebKit::WebFrame;
 using WebKit::WebNode;
 using WebKit::WebSize;
@@ skipping 31 matching lines @@
          oldParams.params.min_shrink == newParams.params.min_shrink &&
          oldParams.params.dpi == newParams.params.dpi &&
          oldParams.params.printable_size == newParams.params.printable_size &&
          oldParams.params.selection_only == newParams.params.selection_only &&
          oldParams.params.page_size == newParams.params.page_size &&
          oldParams.params.margin_top == newParams.params.margin_top &&
          oldParams.params.margin_left == newParams.params.margin_left &&
          oldParams.params.supports_alpha_blend ==
              newParams.params.supports_alpha_blend &&
          oldParams.pages.size() == newParams.pages.size() &&
+         oldParams.params.header_footer ==
+             newParams.params.header_footer &&
          std::equal(oldParams.pages.begin(), oldParams.pages.end(),
              newParams.pages.begin());
 }
 
 }  // namespace
 
 PrepareFrameAndViewForPrint::PrepareFrameAndViewForPrint(
     const PrintMsg_Print_Params& print_params,
     WebFrame* frame,
     WebNode* node,
@@ skipping 50 matching lines @@
 }
 
 PrintWebViewHelper::PrintWebViewHelper(RenderView* render_view)
     : RenderViewObserver(render_view),
       RenderViewObserverTracker<PrintWebViewHelper>(render_view),
       print_web_view_(NULL),
       script_initiated_preview_frame_(NULL),
       context_menu_preview_node_(NULL),
       user_cancelled_scripted_print_count_(0),
       notify_browser_of_print_failure_(true),
-      preview_page_count_(0) {
+      preview_page_count_(0),
+      header_footer_interstice(printing::kSettingHeaderFooterInterstice) {
   is_preview_ = switches::IsPrintPreviewEnabled();
 }
 
 PrintWebViewHelper::~PrintWebViewHelper() {}
 
 // Prints |frame| which called window.print().
 void PrintWebViewHelper::PrintPage(WebKit::WebFrame* frame) {
   DCHECK(frame);
 
   // Allow Prerendering to cancel this print request if necessary.
@@ skipping 87 matching lines @@
       render_view()->webview()->mainFrame();
   return true;
 }
 
 void PrintWebViewHelper::OnPrintPages() {
   WebFrame* frame;
   if (GetPrintFrame(&frame))
     Print(frame, NULL);
 }
 
-void PrintWebViewHelper::OnPrintPreview(const DictionaryValue& settings) {
+void PrintWebViewHelper::OnPrintPreview(const DictionaryValue& settings,
+    const DictionaryValue& header_footer_info) {
   DCHECK(is_preview_);
   DCHECK(!context_menu_preview_node_.get() || !script_initiated_preview_frame_);
 
+  header_footer_info_ = header_footer_info.DeepCopy();
+
   if (script_initiated_preview_frame_) {
     // Script initiated print preview.
     PrintPreview(script_initiated_preview_frame_, NULL, settings);
   } else if (context_menu_preview_node_.get()) {
     // User initiated - print node under context menu.
     PrintPreview(context_menu_preview_node_->document().frame(),
                  context_menu_preview_node_.get(), settings);
   } else {
     // User initiated - normal print preview.
     WebFrame* frame;
@@ skipping 209 matching lines @@
 
 void PrintWebViewHelper::didStopLoading() {
   PrintMsg_PrintPages_Params* params = print_pages_params_.get();
   DCHECK(params != NULL);
   PrintPages(*params, print_web_view_->mainFrame(), NULL);
 }
 
 void PrintWebViewHelper::GetPageSizeAndMarginsInPoints(
     WebFrame* frame,
     int page_index,
-    const PrintMsg_Print_Params& default_params,
-    double* content_width_in_points,
-    double* content_height_in_points,
-    double* margin_top_in_points,
-    double* margin_right_in_points,
-    double* margin_bottom_in_points,
-    double* margin_left_in_points) {
+    const PrintMsg_Print_Params& default_params) {
   int dpi = GetDPI(&default_params);
 
   WebSize page_size_in_pixels(
       ConvertUnit(default_params.page_size.width(),
                   dpi, printing::kPixelsPerInch),
       ConvertUnit(default_params.page_size.height(),
                   dpi, printing::kPixelsPerInch));
   int margin_top_in_pixels = ConvertUnit(
       default_params.margin_top,
       dpi, printing::kPixelsPerInch);
@@ skipping 11 matching lines @@
 
   if (frame) {
     frame->pageSizeAndMarginsInPixels(page_index,
                                       page_size_in_pixels,
                                       margin_top_in_pixels,
                                       margin_right_in_pixels,
                                       margin_bottom_in_pixels,
                                       margin_left_in_pixels);
   }
 
-  *content_width_in_points = ConvertPixelsToPoint(page_size_in_pixels.width -
-                                                  margin_left_in_pixels -
-                                                  margin_right_in_pixels);
-  *content_height_in_points = ConvertPixelsToPoint(page_size_in_pixels.height -
-                                                   margin_top_in_pixels -
-                                                   margin_bottom_in_pixels);
+  content_width_in_points = ConvertPixelsToPoint(page_size_in_pixels.width -
+                                                 margin_left_in_pixels -
+                                                 margin_right_in_pixels);
+  content_height_in_points = ConvertPixelsToPoint(page_size_in_pixels.height -
+                                                  margin_top_in_pixels -
+                                                  margin_bottom_in_pixels);
 
   // Invalid page size and/or margins. We just use the default setting.
-  if (*content_width_in_points < 1.0 || *content_height_in_points < 1.0) {
+  if (content_width_in_points < 1.0 || content_height_in_points < 1.0) {
     GetPageSizeAndMarginsInPoints(NULL,
                                   page_index,
-                                  default_params,
-                                  content_width_in_points,
-                                  content_height_in_points,
-                                  margin_top_in_points,
-                                  margin_right_in_points,
-                                  margin_bottom_in_points,
-                                  margin_left_in_points);
+                                  default_params);
     return;
   }
 
-  if (margin_top_in_points)
-    *margin_top_in_points =
-        ConvertPixelsToPointDouble(margin_top_in_pixels);
-  if (margin_right_in_points)
-    *margin_right_in_points =
-        ConvertPixelsToPointDouble(margin_right_in_pixels);
-  if (margin_bottom_in_points)
-    *margin_bottom_in_points =
+  margin_top_in_points = ConvertPixelsToPointDouble(margin_top_in_pixels);
+  margin_right_in_points = ConvertPixelsToPointDouble(margin_right_in_pixels);
+  margin_bottom_in_points =
         ConvertPixelsToPointDouble(margin_bottom_in_pixels);
-  if (margin_left_in_points)
-    *margin_left_in_points =
-        ConvertPixelsToPointDouble(margin_left_in_pixels);
+  margin_left_in_points = ConvertPixelsToPointDouble(margin_left_in_pixels);
 }
 
 bool PrintWebViewHelper::IsModifiable(WebKit::WebFrame* frame,
                                       WebKit::WebNode* node) {
   if (node)
     return false;
   std::string mime(frame->dataSource()->response().mimeType().utf8());
   if (mime == "application/pdf")
     return false;
   return true;
 }
 
 void PrintWebViewHelper::UpdatePrintableSizeInPrintParameters(
     WebFrame* frame,
     WebNode* node,
     PrintMsg_Print_Params* params) {
-  double content_width_in_points;
-  double content_height_in_points;
-  double margin_top_in_points;
-  double margin_right_in_points;
-  double margin_bottom_in_points;
-  double margin_left_in_points;
   PrepareFrameAndViewForPrint prepare(*params, frame, node, frame->view());
-  PrintWebViewHelper::GetPageSizeAndMarginsInPoints(frame, 0, *params,
-      &content_width_in_points, &content_height_in_points,
-      &margin_top_in_points, &margin_right_in_points,
-      &margin_bottom_in_points, &margin_left_in_points);
+  PrintWebViewHelper::GetPageSizeAndMarginsInPoints(frame, 0, *params);
   int dpi = GetDPI(params);
   params->printable_size = gfx::Size(
       static_cast<int>(ConvertUnitDouble(content_width_in_points,
           printing::kPointsPerInch, dpi)),
       static_cast<int>(ConvertUnitDouble(content_height_in_points,
           printing::kPointsPerInch, dpi)));
 
   double page_width_in_points = content_width_in_points +
       margin_left_in_points + margin_right_in_points;
   double page_height_in_points = content_height_in_points +
@@ skipping 53 matching lines @@
   PrintMsg_PrintPages_Params settings;
   settings.params.page_size = gfx::Size(2550, 3300);
   settings.params.printable_size = gfx::Size(2250, 3000);
   settings.params.margin_top = 150;
   settings.params.margin_left = 150;
   settings.params.dpi = 300.0;
   settings.params.min_shrink = 1.25;
   settings.params.max_shrink = 2.0;
   settings.params.desired_dpi = 72;
   settings.params.selection_only = false;
   settings.params.supports_alpha_blend = false;

[kmadhusu, 2011/07/14 01:50:15]

You need to set "settings.header_footer = false;" here

[Aayush Kumar, 2011/07/19 01:20:30]

Done.

   // TODO(abodenha@chromium.org) Parse page ranges from the job_settings.
   print_pages_params_.reset(new PrintMsg_PrintPages_Params(settings));
   return true;
 }
 
 bool PrintWebViewHelper::UpdatePrintSettingsLocal(
     const DictionaryValue& job_settings) {
   PrintMsg_PrintPages_Params settings;
 
   Send(new PrintHostMsg_UpdatePrintSettings(routing_id(),
       print_pages_params_->params.document_cookie, job_settings, &settings));
 
   if (settings.params.dpi < kMinDpi || !settings.params.document_cookie)
     return false;
 
   print_pages_params_.reset(new PrintMsg_PrintPages_Params(settings));
+  bool header_footer;
+  if (!job_settings.GetBoolean(printing::kSettingHeaderFooter, &header_footer))
+    NOTREACHED();
+  print_pages_params_.get()->params.header_footer = header_footer;

[kmadhusu, 2011/07/14 01:50:15]

"print_pages_params_.get()" -> "print_pages_params_->"

[Aayush Kumar, 2011/07/19 01:20:30]

Done.

+
   Send(new PrintHostMsg_DidGetDocumentCookie(routing_id(),
                                              settings.params.document_cookie));
   return true;
 }
 
 bool PrintWebViewHelper::UpdatePrintSettings(
     const DictionaryValue& job_settings) {
   if (job_settings.HasKey(printing::kSettingCloudPrintId)) {
     return UpdatePrintSettingsCloud(job_settings);
   } else {
@@ skipping 156 matching lines @@
   Send(new PrintHostMsg_RequestPrintPreview(routing_id()));
 }
 
 bool PrintWebViewHelper::PreviewPageRendered(int page_number) {
   bool cancel = false;
   Send(new PrintHostMsg_DidPreviewPage(routing_id(), page_number, &cancel));
   if (cancel)
     notify_browser_of_print_failure_ = false;
   return !cancel;
 }
+
+size_t GetString16ByteLength(string16 text) {
+  return text.length()*sizeof(char16);
+}
+
+SkScalar PrintWebViewHelper::GetHorizontalCoordinate(
+    string16 text,
+    SkPaint paint,
+    HorizontalHeaderFooterPosition pos) {
+  SkScalar text_width_in_points = paint.measureText(text.c_str(),
+      GetString16ByteLength(text));
+
+  switch (pos) {

[kmadhusu, 2011/07/14 01:50:15]

Why did you use switch() here and if() in GetVerticalCoordinate() function? 

IMO, GetHorizontalCoordinate() and GetVerticalCoordinate() are similar
functions. Use the same set of conditional statements on these functions.

[Aayush Kumar, 2011/07/19 01:20:30]

Done.

+    case LEFT:

[kmadhusu, 2011/07/14 01:50:15]

nit: curly braces.

http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml?showone=Loops_...

[Aayush Kumar, 2011/07/19 01:20:30]

Done.

+        return margin_left_in_points*(-1) + header_footer_interstice;
+    case RIGHT:
+        return ((content_width_in_points+margin_right_in_points) -

[kmadhusu, 2011/07/14 01:50:15]

nit: add space before and after '+'

[Aayush Kumar, 2011/07/19 01:20:30]

Done.

+                (header_footer_interstice + text_width_in_points));
+    case CENTER:
+        SkScalar available_width = (margin_left_in_points +
+                                    margin_right_in_points +
+                                    content_width_in_points -
+                                    4*header_footer_interstice)/3;
+        return (available_width - margin_left_in_points +
+                  (available_width - text_width_in_points)/2);
+  }
+  NOTREACHED();
+  return 0;
+}
+
+SkScalar PrintWebViewHelper::GetVerticalCoordinate(

[kmadhusu, 2011/07/14 01:50:15]

Are you planning to call GetHorizontalCoordinate() and GetVerticalCoordinate()
seperately from other places?  

I think you can merge them to a single function and make the resulting function
return SkPoint.

Sample:
SkPoint GetHeaderFooterLocation(...);

[Aayush Kumar, 2011/07/19 01:20:30]

Done.

+    SkPaint paint,
+    VerticalHeaderFooterPosition pos) {
+  if (pos == TOP) {
+    return margin_top_in_points*(-1) + header_footer_interstice +
+        paint.getTextSize();
+  } else if (pos == BOTTOM) {
+    return margin_bottom_in_points+content_height_in_points -

[kmadhusu, 2011/07/14 01:50:15]

nit: add space before and after '+'

[Aayush Kumar, 2011/07/19 01:20:30]

Done.

+        header_footer_interstice;
+  } else {
+    NOTREACHED();
+    return 0;
+  }
+}
+
+void PrintWebViewHelper::PrintHeaderFooterText(
+    string16 text,
+    SkPaint paint,
+    const SkRefPtr<skia::VectorCanvas>& canvas,
+    HorizontalHeaderFooterPosition hor_pos,
+    VerticalHeaderFooterPosition ver_pos,
+    float webkit_scale_factor) {
+  SkScalar x_cord = GetHorizontalCoordinate(text, paint, hor_pos) /
+                    webkit_scale_factor;
+  SkScalar y_cord = GetVerticalCoordinate(paint, ver_pos) /
+                    webkit_scale_factor;
+  size_t byte_length = GetString16ByteLength(text);
+
+  canvas->drawText(text.c_str(), byte_length, x_cord, y_cord, paint);
+}
+
+void PrintWebViewHelper::PrintHeaderAndFooter(SkDevice *device,
+        const SkRefPtr<skia::VectorCanvas>& canvas,
+        int page_number, int total_pages, float webkit_scale_factor) {
+
+    // Set the drawing area to draw in the margins.
+    ((skia::VectorPlatformDeviceSkia* )device)->

[kmadhusu, 2011/07/14 01:50:15]

Remove outer paranthesis "(skia::VectorPlatformDeviceSkia* )device->"

[Aayush Kumar, 2011/07/19 01:20:30]

That doesn't work.  It tries to call setDrawingArea on SkDevice object rather
than treating it as a VectorPlatformDeviceSkia object.
On 2011/07/14 01:50:15, kmadhusu wrote:

+        setDrawingArea(SkPDFDevice::kMargin_DrawingArea);
+
+    // Setting up styles for the headers and footers text.
+    SkPaint paint;
+    paint.setColor(SK_ColorBLACK);
+    paint.setTextSize(SkIntToScalar(8)/webkit_scale_factor);

[kmadhusu, 2011/07/14 01:50:15]

Is there any specific reason to use "8"? 

[dpapad, 2011/07/14 15:59:35]

Spaces around /.

[Aayush Kumar, 2011/07/19 01:20:30]

It's what looked good on the page according to me :)
On 2011/07/14 01:50:15, kmadhusu wrote:

[Aayush Kumar, 2011/07/19 01:20:30]

Done.

+    paint.setTypeface(SkTypeface::CreateFromName(NULL, SkTypeface::kNormal));
+    paint.setTextEncoding(SkPaint::kUTF16_TextEncoding);
+
+    // Printing the Date
+    Time now = Time::Now();
+    string16 date = base::TimeFormatShortDateNumeric(now);

[kmadhusu, 2011/07/14 01:50:15]

|now| is used only once. 

Change line 934 to base::TimeFormatShortDateNumeric(Time::Now());

[Aayush Kumar, 2011/07/19 01:20:30]

Done.

+    PrintHeaderFooterText(date, paint, canvas, LEFT, TOP, webkit_scale_factor);
+
+    // Printing the title
+    string16 title;
+    if (!header_footer_info_->GetString("title", &title))

[kmadhusu, 2011/07/14 01:50:15]

"title" -> printing::kSettingHeaderFooterTitle

[Aayush Kumar, 2011/07/19 01:20:30]

Thanks! :)
On 2011/07/14 01:50:15, kmadhusu wrote:
Done.

+      NOTREACHED();
+
+    SkScalar maxTitleSize = (margin_left_in_points +
+                             content_width_in_points +
+                             margin_right_in_points -
+                             4*header_footer_interstice)/3;
+    title = ui::ElideText(title, paint, maxTitleSize, false);
+    PrintHeaderFooterText(title, paint, canvas, CENTER, TOP,
+        webkit_scale_factor);

[kmadhusu, 2011/07/14 01:50:15]

Fix indentation.

PrintHeaderFooterText(title, paint, canvas, CENTER, TOP,
                      webkit_scale_factor);

[Aayush Kumar, 2011/07/19 01:20:30]

Done.

+
+    // Printing the URL
+    std::string url;
+    if (!header_footer_info_->GetString("url", &url))

[kmadhusu, 2011/07/14 01:50:15]

"url" -> printing::kSettingHeaderFooterURL

[Aayush Kumar, 2011/07/19 01:20:30]

Done.

+      NOTREACHED();
+    GURL gurl(url);
+    string16 url_elided = ui::ElideUrl(gurl, paint, maxTitleSize,
+                                       std::string());
+    PrintHeaderFooterText(url_elided, paint, canvas, LEFT, BOTTOM,
+        webkit_scale_factor);

[kmadhusu, 2011/07/14 01:50:15]

Fix indentation

[Aayush Kumar, 2011/07/19 01:20:30]

Done.

+
+    // Printing the page numbers at the bottom right corner of page.
+    string16 page_on_page_total = base::IntToString16(page_number) +
+                                  UTF8ToUTF16("/") +
+                                  base::IntToString16(total_pages);
+    PrintHeaderFooterText(page_on_page_total, paint, canvas, RIGHT, BOTTOM,
+        webkit_scale_factor);
+
+    // Restore the drawing area to draw in the content area.
+    ((skia::VectorPlatformDeviceSkia* )device)->
+        setDrawingArea(SkPDFDevice::kContent_DrawingArea);
+}