Make printing work better with OOPIF.

chrome/browser/printing/print_view_manager.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/browser/printing/print_view_manager.h"
 
 #include <map>
+#include <utility>
 
 #include "base/bind.h"
 #include "base/lazy_instance.h"
+#include "base/memory/ptr_util.h"
 #include "chrome/browser/plugins/chrome_plugin_service_filter.h"
 #include "chrome/browser/printing/print_preview_dialog_controller.h"
 #include "chrome/browser/ui/webui/print_preview/print_preview_ui.h"
 #include "chrome/common/chrome_content_client.h"
 #include "components/printing/common/print_messages.h"
 #include "content/public/browser/browser_thread.h"
 #include "content/public/browser/plugin_service.h"
 #include "content/public/browser/render_frame_host.h"
 #include "content/public/browser/render_process_host.h"
 #include "content/public/browser/web_contents.h"
@@ skipping 26 matching lines @@
       render_process_id, render_frame_id, GURL(), pdf_plugin);
 }
 
 }  // namespace
 
 namespace printing {
 
 PrintViewManager::PrintViewManager(content::WebContents* web_contents)
     : PrintViewManagerBase(web_contents),
       print_preview_state_(NOT_PREVIEWING),
+      print_preview_rfh_(nullptr),
+      scripted_print_rfh_(nullptr),
       scripted_print_preview_rph_(nullptr) {
   if (PrintPreviewDialogController::IsPrintPreviewDialog(web_contents)) {
     EnableInternalPDFPluginForContents(
         web_contents->GetRenderProcessHost()->GetID(),
         web_contents->GetMainFrame()->GetRoutingID());
   }
 }
 
 PrintViewManager::~PrintViewManager() {
   DCHECK_EQ(NOT_PREVIEWING, print_preview_state_);
 }
 
 #if defined(ENABLE_BASIC_PRINTING)
 bool PrintViewManager::PrintForSystemDialogNow(
     const base::Closure& dialog_shown_callback) {
   DCHECK(!dialog_shown_callback.is_null());
   DCHECK(on_print_dialog_shown_callback_.is_null());
   on_print_dialog_shown_callback_ = dialog_shown_callback;
-  return PrintNowInternal(new PrintMsg_PrintForSystemDialog(routing_id()));
+
+  int32_t id = print_preview_rfh_->GetRoutingID();
+  return PrintNowInternal(base::MakeUnique<PrintMsg_PrintForSystemDialog>(id));
 }
 
-bool PrintViewManager::BasicPrint() {
+bool PrintViewManager::BasicPrint(content::RenderFrameHost* rfh) {
   PrintPreviewDialogController* dialog_controller =
       PrintPreviewDialogController::GetInstance();
   if (!dialog_controller)
     return false;
 
   content::WebContents* print_preview_dialog =
       dialog_controller->GetPrintPreviewForContents(web_contents());
   if (!print_preview_dialog)
-    return PrintNow();
+    return PrintNow(rfh);
 
   if (!print_preview_dialog->GetWebUI())
     return false;
 
   PrintPreviewUI* print_preview_ui = static_cast<PrintPreviewUI*>(
       print_preview_dialog->GetWebUI()->GetController());
   print_preview_ui->OnShowSystemDialog();
   return true;
 }
 #endif  // defined(ENABLE_BASIC_PRINTING)
 
-bool PrintViewManager::PrintPreviewNow(bool selection_only) {
+bool PrintViewManager::PrintPreviewNow(content::RenderFrameHost* rfh,
+                                       bool has_selection) {
   // Users can send print commands all they want and it is beyond
   // PrintViewManager's control. Just ignore the extra commands.
   // See http://crbug.com/136842 for example.
   if (print_preview_state_ != NOT_PREVIEWING)
     return false;
 
-  if (!PrintNowInternal(new PrintMsg_InitiatePrintPreview(routing_id(),
-                                                          selection_only))) {
+  auto message = base::MakeUnique<PrintMsg_InitiatePrintPreview>(
+      rfh->GetRoutingID(), has_selection);
+  if (!PrintNowInternal(std::move(message)))
     return false;
-  }
 
+  DCHECK(!print_preview_rfh_);
+  print_preview_rfh_ = rfh;
   print_preview_state_ = USER_INITIATED_PREVIEW;
   return true;
 }
 
 void PrintViewManager::PrintPreviewForWebNode() {
   if (print_preview_state_ != NOT_PREVIEWING)
     return;
   print_preview_state_ = USER_INITIATED_PREVIEW;
 }
 
 void PrintViewManager::PrintPreviewDone() {
   DCHECK_CURRENTLY_ON(BrowserThread::UI);
   DCHECK_NE(NOT_PREVIEWING, print_preview_state_);
 
   if (print_preview_state_ == SCRIPTED_PREVIEW) {
     auto& map = g_scripted_print_preview_closure_map.Get();
     auto it = map.find(scripted_print_preview_rph_);
     CHECK(it != map.end());
     it->second.Run();
     map.erase(it);
     scripted_print_preview_rph_ = nullptr;
   }
   print_preview_state_ = NOT_PREVIEWING;
+  print_preview_rfh_ = nullptr;
 }
 
 void PrintViewManager::RenderFrameCreated(
     content::RenderFrameHost* render_frame_host) {
   if (PrintPreviewDialogController::IsPrintPreviewDialog(web_contents())) {
     EnableInternalPDFPluginForContents(render_frame_host->GetProcess()->GetID(),
                                        render_frame_host->GetRoutingID());
   }
 }
 
 void PrintViewManager::RenderProcessGone(base::TerminationStatus status) {

[nasko, 2016/11/02 04:50:37]

Should this change to RenderFrameDeleted?

[Lei Zhang, 2016/11/08 11:13:22]

Not sure. Added a TODO and will get back to it later in this CL.

[nasko, 2016/11/08 22:18:35]

Acknowledged.

   print_preview_state_ = NOT_PREVIEWING;
   PrintViewManagerBase::RenderProcessGone(status);

[nasko, 2016/11/02 04:50:37]

Isn't that gone from the base object?

[Lei Zhang, 2016/11/08 11:13:22]

The inheritance tree is several levels deep.

[nasko, 2016/11/08 22:18:35]

Acknowledged.

 }
 
-void PrintViewManager::OnDidShowPrintDialog() {
-  if (!on_print_dialog_shown_callback_.is_null())
-    on_print_dialog_shown_callback_.Run();
+void PrintViewManager::OnDidShowPrintDialog(content::RenderFrameHost* rfh) {
+  bool has_callback = !on_print_dialog_shown_callback_.is_null();
+  if (!has_callback)
+    return;
+
+  if (rfh != print_preview_rfh_)
+    return;
+
+  on_print_dialog_shown_callback_.Run();
   on_print_dialog_shown_callback_.Reset();
 }
 
 void PrintViewManager::OnSetupScriptedPrintPreview(IPC::Message* reply_msg) {
+  DCHECK(scripted_print_rfh_);
+  content::RenderFrameHost* rfh = scripted_print_rfh_;
+  scripted_print_rfh_ = nullptr;
+
   DCHECK_CURRENTLY_ON(BrowserThread::UI);
   auto& map = g_scripted_print_preview_closure_map.Get();
   content::RenderProcessHost* rph = web_contents()->GetRenderProcessHost();
 
   if (base::ContainsKey(map, rph)) {
     // Renderer already handling window.print() in another View.
     Send(reply_msg);
     return;
   }
 
   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;
   }
 
   PrintPreviewDialogController* dialog_controller =
       PrintPreviewDialogController::GetInstance();
   if (!dialog_controller) {
     Send(reply_msg);
     return;
   }
 
+  DCHECK(!print_preview_rfh_);
+  print_preview_rfh_ = rfh;
   print_preview_state_ = SCRIPTED_PREVIEW;
   map[rph] = base::Bind(&PrintViewManager::OnScriptedPrintPreviewReply,
                         base::Unretained(this), reply_msg);
   scripted_print_preview_rph_ = rph;
 }
 
-void PrintViewManager::OnShowScriptedPrintPreview(bool source_is_modifiable) {
+void PrintViewManager::OnShowScriptedPrintPreview(content::RenderFrameHost* rfh,
+                                                  bool source_is_modifiable) {
+  DCHECK(print_preview_rfh_);
+  if (rfh != print_preview_rfh_)
+    return;
+
   PrintPreviewDialogController* dialog_controller =
       PrintPreviewDialogController::GetInstance();
   if (!dialog_controller) {
     PrintPreviewDone();
     return;
   }
 
   dialog_controller->PrintPreview(web_contents());
   PrintHostMsg_RequestPrintPreview_Params params;
   params.is_modifiable = source_is_modifiable;
   PrintPreviewUI::SetInitialParams(
       dialog_controller->GetPrintPreviewForContents(web_contents()), params);
 }
 
 void PrintViewManager::OnScriptedPrintPreviewReply(IPC::Message* reply_msg) {
   DCHECK_CURRENTLY_ON(BrowserThread::UI);
   Send(reply_msg);
 }
 
-bool PrintViewManager::OnMessageReceived(const IPC::Message& message) {
+bool PrintViewManager::OnMessageReceived(
+    const IPC::Message& message,
+    content::RenderFrameHost* render_frame_host) {
+  if (message.type() == PrintHostMsg_SetupScriptedPrintPreview::ID) {
+    DCHECK(!scripted_print_rfh_);
+    scripted_print_rfh_ = render_frame_host;

[nasko, 2016/11/02 04:50:37]

Is this just a hack to "pass" the RFH as parameter to
OnSetupScriptedPrintPreview?

[Lei Zhang, 2016/11/08 11:13:22]

Yes. IPC_MESSAGE_HANDLER_DELAY_REPLY doesn't seem to work.

[nasko, 2016/11/08 22:18:35]

That macro is a wrapper for IPC_MESSAGE_FORWARD_DELAY_REPLY. Can we use
IPC_MESSAGE_FORWARD_DELAY_REPLY directly and pass in the |render_frame_host| as
the explicit parameter?

[Lei Zhang, 2016/11/11 21:06:48]

I ventured into ipc/ land and came back with a new
IPC_MESSAGE_HANDLER_WITH_PARAM_DELAY_REPLY macro to make this work.
|scripted_print_rfh_| is gone.

+  }
+
   bool handled = true;
-  IPC_BEGIN_MESSAGE_MAP(PrintViewManager, message)
+  IPC_BEGIN_MESSAGE_MAP_WITH_PARAM(PrintViewManager, message, render_frame_host)
     IPC_MESSAGE_HANDLER(PrintHostMsg_DidShowPrintDialog, OnDidShowPrintDialog)
     IPC_MESSAGE_HANDLER_DELAY_REPLY(PrintHostMsg_SetupScriptedPrintPreview,
                                     OnSetupScriptedPrintPreview)
     IPC_MESSAGE_HANDLER(PrintHostMsg_ShowScriptedPrintPreview,
                         OnShowScriptedPrintPreview)
     IPC_MESSAGE_UNHANDLED(handled = false)
   IPC_END_MESSAGE_MAP()
 
-  return handled || PrintViewManagerBase::OnMessageReceived(message);
+  return handled ||
+         PrintViewManagerBase::OnMessageReceived(message, render_frame_host);
 }
 
 }  // namespace printing