Print Preview: Properly handle window.print().

chrome/browser/printing/print_view_manager.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/browser/printing/print_view_manager.h"
 
 #include "base/bind.h"
+#include "base/lazy_instance.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/utf_string_conversions.h"
 #include "chrome/browser/browser_process.h"
 #include "chrome/browser/printing/print_job.h"
 #include "chrome/browser/printing/print_job_manager.h"
 #include "chrome/browser/printing/print_preview_tab_controller.h"
 #include "chrome/browser/printing/printer_query.h"
 #include "chrome/browser/printing/print_view_manager_observer.h"
 #include "chrome/browser/ui/tab_contents/tab_contents_wrapper.h"
 #include "chrome/browser/ui/webui/print_preview_ui.h"
@@ skipping 25 matching lines @@
 
   scoped_refptr<printing::PrinterQuery> printer_query;
   print_job_manager->PopPrinterQuery(cookie, &printer_query);
   if (printer_query.get()) {
     BrowserThread::PostTask(
         BrowserThread::IO, FROM_HERE,
         base::Bind(&printing::PrinterQuery::StopWorker, printer_query.get()));
   }
 }
 
+// Keeps track of pending scripted print preview closures.
+// No locking, only access on the UI thread.
+typedef std::map<RenderProcessHost*, base::Closure>
+    ScriptedPrintPreviewClosureMap;
+static base::LazyInstance<ScriptedPrintPreviewClosureMap>
+    g_scripted_print_preview_closure_map(base::LINKER_INITIALIZED);
+
 }  // namespace
 
 namespace printing {
 
 PrintViewManager::PrintViewManager(TabContentsWrapper* tab)
     : TabContentsObserver(tab->tab_contents()),
       tab_(tab),
       number_pages_(0),
       printing_succeeded_(false),
       inside_inner_message_loop_(false),
       observer_(NULL),
-      cookie_(0) {
+      cookie_(0),
+      print_preview_state_(NOT_PREVIEWING),
+      scripted_print_preview_rph_(NULL) {
 #if defined(OS_POSIX) && !defined(OS_MACOSX)
   expecting_first_page_ = true;
 #endif
 }
 
 PrintViewManager::~PrintViewManager() {
+  DCHECK_EQ(NOT_PREVIEWING, print_preview_state_);

[vandebo (ex-Chrome), 2011/11/10 23:59:59]

What if you close a tab/window while previewing?

[Lei Zhang, 2011/11/11 11:45:11]

RemoveInitiatorTab() will call PrintPreviewDone() first.

   ReleasePrinterQuery(cookie_);
   DisconnectFromCurrentPrintJob();
 }
 
 bool PrintViewManager::PrintNow() {
   return PrintNowInternal(new PrintMsg_PrintPages(routing_id()));
 }
 
 bool PrintViewManager::PrintForSystemDialogNow() {
   return PrintNowInternal(new PrintMsg_PrintForSystemDialog(routing_id()));
@@ skipping 15 matching lines @@
     PrintPreviewUI* print_preview_ui =
         static_cast<PrintPreviewUI*>(print_preview_tab->web_ui());
     print_preview_ui->OnShowSystemDialog();
     return true;
   } else {
     return PrintNow();
   }
 }
 
 bool PrintViewManager::PrintPreviewNow() {
+  if (print_preview_state_ != NOT_PREVIEWING) {
+    NOTREACHED();
+    return false;
+  }
+  print_preview_state_ = USER_INITIATED_PREVIEW;
   return PrintNowInternal(new PrintMsg_InitiatePrintPreview(routing_id()));
 }
 
+void PrintViewManager::PrintPreviewDone() {
+  BrowserThread::CurrentlyOn(BrowserThread::UI);
+
+  // Check for spurious call.

[vandebo (ex-Chrome), 2011/11/10 23:59:59]

This makes me sad.  If you can explain why there might be a spurious call that
we should ignore, explaining that here would make me less sad.

[Lei Zhang, 2011/11/11 11:45:11]

This is a defensive move. I'll check whether it's needed or not.

[Lei Zhang, 2011/11/11 22:34:26]

Got rid of this and turned it into a DCHECK.

+  if (print_preview_state_ == NOT_PREVIEWING)
+    return;
+
+  if (print_preview_state_ == SCRIPTED_PREVIEW) {
+    ScriptedPrintPreviewClosureMap& map =
+        g_scripted_print_preview_closure_map.Get();
+    ScriptedPrintPreviewClosureMap::iterator it =
+        map.find(scripted_print_preview_rph_);
+    CHECK(it != map.end());
+    it->second.Run();
+    map.erase(scripted_print_preview_rph_);
+    scripted_print_preview_rph_ = NULL;
+  }
+  print_preview_state_ = NOT_PREVIEWING;
+}
+
 void PrintViewManager::PreviewPrintingRequestCancelled() {
   if (!tab_contents())
     return;
   RenderViewHost* rvh = tab_contents()->render_view_host();
   rvh->Send(new PrintMsg_PreviewPrintingRequestCancelled(rvh->routing_id()));
 }
 
 void PrintViewManager::set_observer(PrintViewManagerObserver* observer) {
   DCHECK(!observer || !observer_);
   observer_ = observer;
@@ skipping 101 matching lines @@
 
 void PrintViewManager::OnPrintingFailed(int cookie) {
   ReleasePrinterQuery(cookie);
 
   content::NotificationService::current()->Notify(
       chrome::NOTIFICATION_PRINT_JOB_RELEASED,
       content::Source<TabContents>(tab_contents()),
       content::NotificationService::NoDetails());
 }
 
+void PrintViewManager::OnScriptedPrintPreview(IPC::Message* reply_msg) {
+  BrowserThread::CurrentlyOn(BrowserThread::UI);
+  if (print_preview_state_ != NOT_PREVIEWING) {
+    // If a user initiated print dialog is already open, ignore the scripted
+    // print message.
+    DCHECK_EQ(USER_INITIATED_PREVIEW, print_preview_state_);
+    Send(reply_msg);
+    return;
+  }
+
+  print_preview_state_ = SCRIPTED_PREVIEW;
+  scripted_print_preview_rph_ = tab_contents()->render_view_host()->process();
+  base::Closure callback =
+      base::Bind(&PrintViewManager::OnScriptedPrintPreviewReply,
+                 base::Unretained(this),
+                 reply_msg);
+  ScriptedPrintPreviewClosureMap& map =
+      g_scripted_print_preview_closure_map.Get();
+  CHECK_EQ(0U, map.count(scripted_print_preview_rph_));
+  map[scripted_print_preview_rph_] = callback;
+
+  PrintNowInternal(new PrintMsg_InitiatePrintPreview(routing_id()));

[vandebo (ex-Chrome), 2011/11/10 23:59:59]

This will trigger GetPrintFrame(), but the caller already set the print frame.

[Lei Zhang, 2011/11/11 11:45:11]

I'm surprised this didn't blow up, fixed.

+}
+
+void PrintViewManager::OnScriptedPrintPreviewReply(IPC::Message* reply_msg) {
+  BrowserThread::CurrentlyOn(BrowserThread::UI);
+  Send(reply_msg);
+}
+
 bool PrintViewManager::OnMessageReceived(const IPC::Message& message) {
   bool handled = true;
   IPC_BEGIN_MESSAGE_MAP(PrintViewManager, message)
     IPC_MESSAGE_HANDLER(PrintHostMsg_DidGetPrintedPagesCount,
                         OnDidGetPrintedPagesCount)
     IPC_MESSAGE_HANDLER(PrintHostMsg_DidGetDocumentCookie,
                         OnDidGetDocumentCookie)
     IPC_MESSAGE_HANDLER(PrintHostMsg_DidShowPrintDialog, OnDidShowPrintDialog)
     IPC_MESSAGE_HANDLER(PrintHostMsg_DidPrintPage, OnDidPrintPage)
     IPC_MESSAGE_HANDLER(PrintHostMsg_PrintingFailed, OnPrintingFailed)
+    IPC_MESSAGE_HANDLER_DELAY_REPLY(PrintHostMsg_ScriptedPrintPreview,
+                                    OnScriptedPrintPreview)
     IPC_MESSAGE_UNHANDLED(handled = false)
   IPC_END_MESSAGE_MAP()
   return handled;
 }
 
 void PrintViewManager::Observe(int type,
                                const content::NotificationSource& source,
                                const content::NotificationDetails& details) {
   switch (type) {
     case chrome::NOTIFICATION_PRINT_JOB_EVENT: {
@@ skipping 261 matching lines @@
 }
 
 bool PrintViewManager::PrintNowInternal(IPC::Message* message) {
   // Don't print / print preview interstitials.
   if (tab_contents()->showing_interstitial_page())
     return false;
   return Send(message);
 }
 
 }  // namespace printing