Printing on Windows via PDF

chrome/browser/printing/pdf_to_emf_converter.cc

-// Copyright 2013 The Chromium Authors. All rights reserved.
+// Copyright 2014 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/browser/local_discovery/pwg_raster_converter.h"
+#include "chrome/browser/printing/pdf_to_emf_converter.h"
 
 #include "base/bind_helpers.h"
 #include "base/cancelable_callback.h"
 #include "base/file_util.h"
 #include "base/files/file.h"
 #include "base/files/scoped_temp_dir.h"
 #include "base/logging.h"
 #include "chrome/common/chrome_utility_messages.h"
 #include "content/public/browser/browser_thread.h"
 #include "content/public/browser/child_process_data.h"
 #include "content/public/browser/utility_process_host.h"
 #include "content/public/browser/utility_process_host_client.h"
 
-namespace local_discovery {
+namespace printing {
 
 namespace {
 
 using content::BrowserThread;
 
 class FileHandlers {
  public:
   FileHandlers() {}
 
   ~FileHandlers() {
     DCHECK(BrowserThread::CurrentlyOn(BrowserThread::FILE));
   }
 
   void Init(base::RefCountedMemory* data);
   bool IsValid();
 
-  base::FilePath GetPwgPath() const {
-    return temp_dir_.path().AppendASCII("output.pwg");
+  base::FilePath GetEmfPath() const {
+    return temp_dir_.path().AppendASCII("output.emf");
   }
 
   base::FilePath GetPdfPath() const {
     return temp_dir_.path().AppendASCII("input.pdf");
   }
 
   IPC::PlatformFileForTransit GetPdfForProcess(base::ProcessHandle process) {
     DCHECK(pdf_file_.IsValid());
     IPC::PlatformFileForTransit transit =
         IPC::TakeFileHandleForProcess(pdf_file_.Pass(), process);
     return transit;
   }
 
-  IPC::PlatformFileForTransit GetPwgForProcess(base::ProcessHandle process) {
-    DCHECK(pwg_file_.IsValid());
-    IPC::PlatformFileForTransit transit =
-        IPC::TakeFileHandleForProcess(pwg_file_.Pass(), process);
-    return transit;
+  const base::FilePath& GetBasePath() const {
+    return temp_dir_.path();
   }
 
  private:
   base::ScopedTempDir temp_dir_;
   base::File pdf_file_;
-  base::File pwg_file_;
 };
 
 void FileHandlers::Init(base::RefCountedMemory* data) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::FILE));
 
   if (!temp_dir_.CreateUniqueTempDir()) {
     return;
   }
 
   if (static_cast<int>(data->size()) !=
       base::WriteFile(GetPdfPath(), data->front_as<char>(), data->size())) {
     return;
   }
 
   // Reopen in read only mode.
   pdf_file_.Initialize(GetPdfPath(),
                        base::File::FLAG_OPEN | base::File::FLAG_READ);
-  pwg_file_.Initialize(
-      GetPwgPath(),
-      base::File::FLAG_CREATE_ALWAYS | base::File::FLAG_APPEND);
 }
 
 bool FileHandlers::IsValid() {
-  return pdf_file_.IsValid() && pwg_file_.IsValid();
+  return pdf_file_.IsValid();
 }
 
-// Converts PDF into PWG raster.
+// Converts PDF into EMF.
 // Class uses 3 threads: UI, IO and FILE.
 // Internal workflow is following:
 // 1. Create instance on the UI thread. (files_, settings_,)
 // 2. Create file on the FILE thread.
 // 3. Start utility process and start conversion on the IO thread.
 // 4. Run result callback on the UI thread.
 // 5. Instance is destroyed from any thread that has the last reference.
 // 6. FileHandlers destroyed on the FILE thread.
 //    This step posts |FileHandlers| to be destroyed on the FILE thread.
 // All these steps work sequentially, so no data should be accessed
 // simultaneously by several threads.
-class PwgUtilityProcessHostClient : public content::UtilityProcessHostClient {
+class PdfToEmfUtilityProcessHostClient
+    : public content::UtilityProcessHostClient {
  public:
-  explicit PwgUtilityProcessHostClient(
-      const printing::PdfRenderSettings& settings,
-      const printing::PwgRasterSettings& bitmap_settings);
+  explicit PdfToEmfUtilityProcessHostClient(
+      const printing::PdfRenderSettings& settings);
 
   void Convert(base::RefCountedMemory* data,
-               const PWGRasterConverter::ResultCallback& callback);
+               const PdfToEmfConverter::ResultCallback& callback);
 
   // UtilityProcessHostClient implementation.
   virtual void OnProcessCrashed(int exit_code) OVERRIDE;
   virtual bool OnMessageReceived(const IPC::Message& message) OVERRIDE;
 
  private:
-  virtual ~PwgUtilityProcessHostClient();
+  virtual ~PdfToEmfUtilityProcessHostClient();
 
   // Message handlers.
   void OnProcessStarted();
-  void OnSucceeded();
+  void OnSucceeded(int highest_rendered_page_number, double scale_factor);
   void OnFailed();
 
-  void RunCallback(bool success);
+  void RunCallback(int highest_rendered_page_number, double scale_factor);
 
   void StartProcessOnIOThread();
 
-  void RunCallbackOnUIThread(bool success);
+  void RunCallbackOnUIThread(int highest_rendered_page_number,
+                             double scale_factor);
   void OnFilesReadyOnUIThread();
 
   scoped_ptr<FileHandlers> files_;
   printing::PdfRenderSettings settings_;
-  printing::PwgRasterSettings bitmap_settings_;
-  PWGRasterConverter::ResultCallback callback_;
+  PdfToEmfConverter::ResultCallback callback_;
   base::WeakPtr<content::UtilityProcessHost> utility_process_host_;
 
-  DISALLOW_COPY_AND_ASSIGN(PwgUtilityProcessHostClient);
+  DISALLOW_COPY_AND_ASSIGN(PdfToEmfUtilityProcessHostClient);
 };
 
-PwgUtilityProcessHostClient::PwgUtilityProcessHostClient(
-    const printing::PdfRenderSettings& settings,
-    const printing::PwgRasterSettings& bitmap_settings)
-    : settings_(settings), bitmap_settings_(bitmap_settings) {}
-
-PwgUtilityProcessHostClient::~PwgUtilityProcessHostClient() {
+PdfToEmfUtilityProcessHostClient::PdfToEmfUtilityProcessHostClient(
+    const printing::PdfRenderSettings& settings)
+    : settings_(settings) {}
+
+PdfToEmfUtilityProcessHostClient::~PdfToEmfUtilityProcessHostClient() {
   // Delete temp directory.
   BrowserThread::DeleteSoon(BrowserThread::FILE, FROM_HERE, files_.release());
 }
 
-void PwgUtilityProcessHostClient::Convert(
+void PdfToEmfUtilityProcessHostClient::Convert(
     base::RefCountedMemory* data,
-    const PWGRasterConverter::ResultCallback& callback) {
+    const PdfToEmfConverter::ResultCallback& callback) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   callback_ = callback;
   CHECK(!files_);
   files_.reset(new FileHandlers());
   BrowserThread::PostTaskAndReply(
-      BrowserThread::FILE, FROM_HERE,
-      base::Bind(&FileHandlers::Init, base::Unretained(files_.get()),
+      BrowserThread::FILE,
+      FROM_HERE,
+      base::Bind(&FileHandlers::Init,
+                 base::Unretained(files_.get()),
                  make_scoped_refptr(data)),
-      base::Bind(&PwgUtilityProcessHostClient::OnFilesReadyOnUIThread, this));
-}
-
-void PwgUtilityProcessHostClient::OnProcessCrashed(int exit_code) {
+      base::Bind(&PdfToEmfUtilityProcessHostClient::OnFilesReadyOnUIThread,
+                 this));
+}
+
+void PdfToEmfUtilityProcessHostClient::OnProcessCrashed(int exit_code) {
   OnFailed();
 }
 
-bool PwgUtilityProcessHostClient::OnMessageReceived(
+bool PdfToEmfUtilityProcessHostClient::OnMessageReceived(
   const IPC::Message& message) {
   bool handled = true;
-  IPC_BEGIN_MESSAGE_MAP(PwgUtilityProcessHostClient, message)
+  IPC_BEGIN_MESSAGE_MAP(PdfToEmfUtilityProcessHostClient, message)
     IPC_MESSAGE_HANDLER(ChromeUtilityHostMsg_ProcessStarted, OnProcessStarted)
     IPC_MESSAGE_HANDLER(
-        ChromeUtilityHostMsg_RenderPDFPagesToPWGRaster_Succeeded, OnSucceeded)
-    IPC_MESSAGE_HANDLER(ChromeUtilityHostMsg_RenderPDFPagesToPWGRaster_Failed,
+        ChromeUtilityHostMsg_RenderPDFPagesToMetafile_Succeeded, OnSucceeded)
+    IPC_MESSAGE_HANDLER(ChromeUtilityHostMsg_RenderPDFPagesToMetafile_Failed,
                         OnFailed)
     IPC_MESSAGE_UNHANDLED(handled = false)
   IPC_END_MESSAGE_MAP()
   return handled;
 }
 
-void PwgUtilityProcessHostClient::OnProcessStarted() {
+void PdfToEmfUtilityProcessHostClient::OnProcessStarted() {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
   if (!utility_process_host_) {
-    RunCallbackOnUIThread(false);
+    RunCallbackOnUIThread(-1, 0.0);
     return;
   }
 
   base::ProcessHandle process = utility_process_host_->GetData().handle;
-  utility_process_host_->Send(new ChromeUtilityMsg_RenderPDFPagesToPWGRaster(
-      files_->GetPdfForProcess(process),
-      settings_,
-      bitmap_settings_,
-      files_->GetPwgForProcess(process)));
+  // Only converting one page at a time.
+  printing::PageRange page_range;
+  page_range.from = 0;
+  page_range.to = 0;
+  std::vector<printing::PageRange> range;
+  range.push_back(page_range);
+  utility_process_host_->Send(
+      new ChromeUtilityMsg_RenderPDFToMetafile(
+          files_->GetPdfForProcess(process),
+          files_->GetEmfPath(),
+          settings_));
   utility_process_host_.reset();
 }
 
-void PwgUtilityProcessHostClient::OnSucceeded() {
-  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
-  RunCallback(true);
-}
-
-void PwgUtilityProcessHostClient::OnFailed() {
-  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
-  RunCallback(false);
-}
-
-void PwgUtilityProcessHostClient::OnFilesReadyOnUIThread() {
+void PdfToEmfUtilityProcessHostClient::OnSucceeded(
+    int highest_rendered_page_number,
+    double scale_factor) {
+  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
+  RunCallback(highest_rendered_page_number, scale_factor);

[Vitaly Buka (NO REVIEWS), 2014/05/13 23:54:33]

why do you need highest_rendered_page_number if only the first page was requesed

[scottmg, 2014/05/14 00:34:48]

Ah, oops, that one-page code above was old/unused. Deleted it. The new message
ChromeUtilityMsg_RenderPDFToMetafile converts all pages in the pdf (which will
only contain the pages requested by preview) and outputs each page to a separate
metafile.

The highest_rendered_page_number is just used to build the vector of filenames
to pass back to PrintViewManagerBase::OnPdfToEmfConverted.

+}
+
+void PdfToEmfUtilityProcessHostClient::OnFailed() {
+  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
+  RunCallback(-1, 0.0);
+}
+
+void PdfToEmfUtilityProcessHostClient::OnFilesReadyOnUIThread() {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   if (!files_->IsValid()) {
-    RunCallbackOnUIThread(false);
+    RunCallbackOnUIThread(-1, 0.0);
     return;
   }
   BrowserThread::PostTask(
-      BrowserThread::IO, FROM_HERE,
-      base::Bind(&PwgUtilityProcessHostClient::StartProcessOnIOThread, this));
-}
-
-void PwgUtilityProcessHostClient::StartProcessOnIOThread() {
+      BrowserThread::IO,
+      FROM_HERE,
+      base::Bind(&PdfToEmfUtilityProcessHostClient::StartProcessOnIOThread,
+                 this));
+}
+
+void PdfToEmfUtilityProcessHostClient::StartProcessOnIOThread() {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
   utility_process_host_ =
       content::UtilityProcessHost::Create(
           this,
           base::MessageLoop::current()->message_loop_proxy())->AsWeakPtr();
+  // NOTE: This process _must_ be sandboxed, otherwise the pdf dll will load
+  // gdiplus.dll, change how rendering happens, and not be able to correctly

[Vitaly Buka (NO REVIEWS), 2014/05/13 23:54:33]

so --no-sandbox will fail printing?

[scottmg, 2014/05/14 00:34:48]

Yes! This took me far too long to figure out as I had --no-sandbox to make
attaching/debugging easier and didn't think that it'd be the cause of the
problems I was seeing (weird scale issues).

It would be best to add a flag or something to pdf.dll to force it not to load
gdiplus.dll, but I'm not sure how/where we carry/submit patches on that.

[Vitaly Buka (NO REVIEWS), 2014/05/14 03:51:18]

I guess we need to check this in PDF module.
We can address this in separate CL later.

On 2014/05/14 00:34:48, scottmg wrote:

+  // generate when sent to a metafile DC.
+  utility_process_host_->SetExposedDir(files_->GetBasePath());
   utility_process_host_->Send(new ChromeUtilityMsg_StartupPing);
 }
 
-void PwgUtilityProcessHostClient::RunCallback(bool success) {
+void PdfToEmfUtilityProcessHostClient::RunCallback(
+    int highest_rendered_page_number,
+    double scale_factor) {
   BrowserThread::PostTask(
-      BrowserThread::UI, FROM_HERE,
-      base::Bind(&PwgUtilityProcessHostClient::RunCallbackOnUIThread, this,
-                 success));
-}
-
-void PwgUtilityProcessHostClient::RunCallbackOnUIThread(bool success) {
+      BrowserThread::UI,
+      FROM_HERE,
+      base::Bind(&PdfToEmfUtilityProcessHostClient::RunCallbackOnUIThread,
+                 this,
+                 highest_rendered_page_number,
+                 scale_factor));
+}
+
+void PdfToEmfUtilityProcessHostClient::RunCallbackOnUIThread(
+    int highest_rendered_page_number,
+    double scale_factor) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
+  std::vector<base::FilePath> page_filenames;
+  for (int i = 0; i <= highest_rendered_page_number; ++i) {
+    page_filenames.push_back(files_->GetEmfPath().InsertBeforeExtensionASCII(
+        base::StringPrintf(".%d", i)));
+  }
   if (!callback_.is_null()) {
-    BrowserThread::PostTask(BrowserThread::UI, FROM_HERE,
-                            base::Bind(callback_, success,
-                                       files_->GetPwgPath()));
+    BrowserThread::PostTask(
+        BrowserThread::UI,
+        FROM_HERE,
+        base::Bind(callback_, scale_factor, page_filenames));
     callback_.Reset();
   }
 }
 
-class PWGRasterConverterImpl : public PWGRasterConverter {
+class PdfToEmfConverterImpl : public PdfToEmfConverter {
  public:
-  PWGRasterConverterImpl();
-
-  virtual ~PWGRasterConverterImpl();
+  PdfToEmfConverterImpl();
+
+  virtual ~PdfToEmfConverterImpl();
 
   virtual void Start(base::RefCountedMemory* data,
                      const printing::PdfRenderSettings& conversion_settings,
-                     const printing::PwgRasterSettings& bitmap_settings,
                      const ResultCallback& callback) OVERRIDE;
 
  private:
-  scoped_refptr<PwgUtilityProcessHostClient> utility_client_;
+  scoped_refptr<PdfToEmfUtilityProcessHostClient> utility_client_;
   base::CancelableCallback<ResultCallback::RunType> callback_;
 
-  DISALLOW_COPY_AND_ASSIGN(PWGRasterConverterImpl);
+  DISALLOW_COPY_AND_ASSIGN(PdfToEmfConverterImpl);
 };
 
-PWGRasterConverterImpl::PWGRasterConverterImpl() {
-}
-
-PWGRasterConverterImpl::~PWGRasterConverterImpl() {
-}
-
-void PWGRasterConverterImpl::Start(
+PdfToEmfConverterImpl::PdfToEmfConverterImpl() {
+}
+
+PdfToEmfConverterImpl::~PdfToEmfConverterImpl() {
+}
+
+void PdfToEmfConverterImpl::Start(
     base::RefCountedMemory* data,
     const printing::PdfRenderSettings& conversion_settings,
-    const printing::PwgRasterSettings& bitmap_settings,
     const ResultCallback& callback) {
   // Rebind cancelable callback to avoid calling callback if
-  // PWGRasterConverterImpl is destroyed.
+  // PdfToEmfConverterImpl is destroyed.
   callback_.Reset(callback);
-  utility_client_ =
-      new PwgUtilityProcessHostClient(conversion_settings, bitmap_settings);
+  utility_client_ = new PdfToEmfUtilityProcessHostClient(conversion_settings);
   utility_client_->Convert(data, callback_.callback());
 }
 
 }  // namespace
 
 // static
-scoped_ptr<PWGRasterConverter> PWGRasterConverter::CreateDefault() {
-  return scoped_ptr<PWGRasterConverter>(new PWGRasterConverterImpl());
-}
-
-}  // namespace local_discovery
+scoped_ptr<PdfToEmfConverter> PdfToEmfConverter::CreateDefault() {
+  return scoped_ptr<PdfToEmfConverter>(new PdfToEmfConverterImpl());
+}
+
+}  // namespace printing