Print Preview: Make print preview tab modal.

chrome/browser/ui/webui/print_preview_handler.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/ui/webui/print_preview_handler.h"
 
 #include <ctype.h>
 
 #include <string>
 #include <vector>
 
 #include "base/base64.h"
 #include "base/bind.h"
 #include "base/bind_helpers.h"
 #include "base/i18n/file_util_icu.h"
 #include "base/i18n/number_formatting.h"
 #include "base/json/json_reader.h"
 #include "base/memory/ref_counted.h"
 #include "base/metrics/histogram.h"
 #include "base/path_service.h"
 #include "base/threading/thread.h"
 #include "base/threading/thread_restrictions.h"
 #include "base/utf_string_conversions.h"
 #include "base/values.h"
 #include "chrome/browser/browser_process.h"
 #include "chrome/browser/platform_util.h"
 #include "chrome/browser/prefs/pref_service.h"
-#include "chrome/browser/printing/background_printing_manager.h"
 #include "chrome/browser/printing/cloud_print/cloud_print_url.h"
 #include "chrome/browser/printing/print_dialog_cloud.h"
 #include "chrome/browser/printing/print_job_manager.h"
 #include "chrome/browser/printing/print_preview_tab_controller.h"
 #include "chrome/browser/printing/print_system_task_proxy.h"
 #include "chrome/browser/printing/print_view_manager.h"
 #include "chrome/browser/printing/printer_manager_dialog.h"
 #include "chrome/browser/profiles/profile.h"
-#include "chrome/browser/sessions/restore_tab_helper.h"
-#include "chrome/browser/tabs/tab_strip_model.h"
 #include "chrome/browser/ui/browser_list.h"
 #include "chrome/browser/ui/tab_contents/tab_contents_wrapper.h"
 #include "chrome/browser/ui/webui/cloud_print_signin_dialog.h"
 #include "chrome/browser/ui/webui/print_preview_ui.h"
 #include "chrome/common/chrome_paths.h"
 #include "chrome/common/pref_names.h"
 #include "chrome/common/print_messages.h"
 #include "content/browser/renderer_host/render_view_host.h"
 #include "content/browser/tab_contents/tab_contents.h"
 #include "content/public/browser/browser_thread.h"
@@ skipping 11 matching lines @@
 
 namespace {
 
 enum UserActionBuckets {
   PRINT_TO_PRINTER,
   PRINT_TO_PDF,
   CANCEL,
   FALLBACK_TO_ADVANCED_SETTINGS_DIALOG,
   PREVIEW_FAILED,
   PREVIEW_STARTED,
-  INITIATOR_TAB_CRASHED,
+  INITIATOR_TAB_CRASHED,  // UNUSED
   INITIATOR_TAB_CLOSED,
   PRINT_WITH_CLOUD_PRINT,
   USERACTION_BUCKET_BOUNDARY
 };
 
 enum PrintSettingsBuckets {
   LANDSCAPE,
   PORTRAIT,
   COLOR,
   BLACK_AND_WHITE,
@@ skipping 74 matching lines @@
   if (settings.GetInteger(printing::kSettingDuplexMode, &duplex_mode))
     ReportPrintSettingHistogram(duplex_mode ? DUPLEX : SIMPLEX);
 
   int color_mode;
   if (settings.GetInteger(printing::kSettingColor, &color_mode)) {
     ReportPrintSettingHistogram(
         printing::isColorModelSelected(color_mode) ? COLOR : BLACK_AND_WHITE);
   }
 }
 
-printing::BackgroundPrintingManager* GetBackgroundPrintingManager() {
-  return g_browser_process->background_printing_manager();
-}
-
 }  // namespace
 
 // A Task implementation that stores a PDF file on disk.
 class PrintToPdfTask : public Task {
  public:
   // Takes ownership of |metafile|.
   PrintToPdfTask(printing::Metafile* metafile, const FilePath& path)
       : metafile_(metafile), path_(path) {
     DCHECK(metafile);
   }
@@ skipping 59 matching lines @@
                  base::Unretained(this)));
   web_ui_->RegisterMessageCallback("signIn",
       base::Bind(&PrintPreviewHandler::HandleSignin,
                  base::Unretained(this)));
   web_ui_->RegisterMessageCallback("manageCloudPrinters",
       base::Bind(&PrintPreviewHandler::HandleManageCloudPrint,
                  base::Unretained(this)));
   web_ui_->RegisterMessageCallback("manageLocalPrinters",
       base::Bind(&PrintPreviewHandler::HandleManagePrinters,
                  base::Unretained(this)));
-  web_ui_->RegisterMessageCallback("reloadCrashedInitiatorTab",
-      base::Bind(&PrintPreviewHandler::HandleReloadCrashedInitiatorTab,
-                 base::Unretained(this)));
   web_ui_->RegisterMessageCallback("closePrintPreviewTab",
       base::Bind(&PrintPreviewHandler::HandleClosePreviewTab,
                  base::Unretained(this)));
   web_ui_->RegisterMessageCallback("hidePreview",
       base::Bind(&PrintPreviewHandler::HandleHidePreview,
                  base::Unretained(this)));
   web_ui_->RegisterMessageCallback("cancelPendingPrintRequest",
       base::Bind(&PrintPreviewHandler::HandleCancelPendingPrintRequest,
                  base::Unretained(this)));
   web_ui_->RegisterMessageCallback("saveLastPrinter",
@@ skipping 53 matching lines @@
   // thread.
   settings->SetString(printing::kPreviewUIAddr,
                       print_preview_ui->GetPrintPreviewUIAddress());
 
   // Increment request count.
   ++regenerate_preview_request_count_;
 
   TabContentsWrapper* initiator_tab = GetInitiatorTab();
   if (!initiator_tab) {
     ReportUserActionHistogram(INITIATOR_TAB_CLOSED);
-    print_preview_ui->OnInitiatorTabClosed();
+    print_preview_ui->OnClosePrintPreviewTab();
     return;
   }
 
   // Retrieve the page title and url and send it to the renderer process if
   // headers and footers are to be displayed.
   bool display_header_footer = false;
   if (!settings->GetBoolean(printing::kSettingHeaderFooterEnabled,
                             &display_header_footer)) {
     NOTREACHED();
   }
@@ skipping 74 matching lines @@
   } else if (is_cloud_dialog) {
     HandlePrintWithCloudPrint();
   } else {
     ReportPrintSettingsStats(*settings);
     ReportUserActionHistogram(PRINT_TO_PRINTER);
     UMA_HISTOGRAM_COUNTS("PrintPreview.PageCount.PrintToPrinter",
                          GetPageCountFromSettingsDictionary(*settings));
 
     // This tries to activate the initiator tab as well, so do not clear the
     // association with the initiator tab yet.
-    HidePreviewTab();
+    PrintPreviewUI* print_preview_ui = static_cast<PrintPreviewUI*>(web_ui_);
+    print_preview_ui->OnHidePreviewTab();
 
     // Do this so the initiator tab can open a new print preview tab.
     ClearInitiatorTabDetails();
 
     // The PDF being printed contains only the pages that the user selected,
     // so ignore the page range and print all pages.
     settings->Remove(printing::kSettingPageRange, NULL);
     RenderViewHost* rvh = web_ui_->tab_contents()->render_view_host();
     rvh->Send(new PrintMsg_PrintForPrintPreview(rvh->routing_id(), *settings));
   }
@@ skipping 23 matching lines @@
     file_util::ReplaceIllegalCharactersInPath(&print_job_title, '_');
     FilePath default_filename(print_job_title);
     default_filename =
         default_filename.ReplaceExtension(FILE_PATH_LITERAL("pdf"));
 
     SelectFile(default_filename);
   }
 }
 
 void PrintPreviewHandler::HandleHidePreview(const ListValue* /*args*/) {
-  HidePreviewTab();
+  PrintPreviewUI* print_preview_ui = static_cast<PrintPreviewUI*>(web_ui_);
+  print_preview_ui->OnHidePreviewTab();
 }
 
 void PrintPreviewHandler::HandleCancelPendingPrintRequest(
     const ListValue* /*args*/) {
   TabContentsWrapper* initiator_tab = GetInitiatorTab();
   if (initiator_tab) {
     ClearInitiatorTabDetails();
   } else {
     // Initiator tab does not exists. Get the wrapper contents of current tab.
     Browser* browser = BrowserList::GetLastActive();
@@ skipping 90 matching lines @@
   // Cancel the pending preview request if exists.
   PrintPreviewUI* print_preview_ui = static_cast<PrintPreviewUI*>(web_ui_);
   print_preview_ui->OnCancelPendingPreviewRequest();
 }
 
 void PrintPreviewHandler::HandleManagePrinters(const ListValue* /*args*/) {
   ++manage_printers_dialog_request_count_;
   printing::PrinterManagerDialog::ShowPrinterManagerDialog();
 }
 
-void PrintPreviewHandler::HandleReloadCrashedInitiatorTab(
-    const ListValue* /*args*/) {
-  ReportStats();
-  ReportUserActionHistogram(INITIATOR_TAB_CRASHED);
-
-  TabContentsWrapper* initiator_tab = GetInitiatorTab();
-  if (!initiator_tab)
-    return;
-
-  TabContents* contents = initiator_tab->tab_contents();
-  contents->OpenURL(contents->GetURL(), GURL(), CURRENT_TAB,
-                    content::PAGE_TRANSITION_RELOAD);
-  ActivateInitiatorTabAndClosePreviewTab();
-}
-
 void PrintPreviewHandler::HandleClosePreviewTab(const ListValue* /*args*/) {
   ReportStats();
   ReportUserActionHistogram(CANCEL);
 
   // Record the number of times the user requests to regenerate preview data
   // before cancelling.
   UMA_HISTOGRAM_COUNTS("PrintPreview.RegeneratePreviewRequest.BeforeCancel",
                        regenerate_preview_request_count_);
-
-  ActivateInitiatorTabAndClosePreviewTab();
 }
 
 void PrintPreviewHandler::ReportStats() {
   UMA_HISTOGRAM_COUNTS("PrintPreview.ManagePrinters",
                        manage_printers_dialog_request_count_);
 }
 
 void PrintPreviewHandler::HandleGetInitiatorTabTitle(
     const ListValue* /*args*/) {
   PrintPreviewUI* print_preview_ui = static_cast<PrintPreviewUI*>(web_ui_);
@@ skipping 21 matching lines @@
       number_format,
       system);
 }
 
 void PrintPreviewHandler::ActivateInitiatorTabAndClosePreviewTab() {
   TabContentsWrapper* initiator_tab = GetInitiatorTab();
   if (initiator_tab) {
     static_cast<RenderViewHostDelegate*>(
         initiator_tab->tab_contents())->Activate();
   }
-  ClosePrintPreviewTab();
+  PrintPreviewUI* print_preview_ui = static_cast<PrintPreviewUI*>(web_ui_);
+  print_preview_ui->OnClosePrintPreviewTab();
 }
 
 void PrintPreviewHandler::SendPrinterCapabilities(
     const DictionaryValue& settings_info) {
   VLOG(1) << "Get printer capabilities finished";
   web_ui_->CallJavascriptFunction("updateWithPrinterCapabilities",
                                   settings_info);
 }
 
 void PrintPreviewHandler::SendDefaultPrinter(
@@ skipping 26 matching lines @@
   print_preview_ui->GetPrintPreviewDataForIndex(
       printing::COMPLETE_PREVIEW_DOCUMENT_INDEX, &data);
   CHECK(data.get());
   DCHECK_GT(data->size(), 0U);
 
   string16 print_job_title_utf16 =
       preview_tab_wrapper()->print_view_manager()->RenderSourceName();
   std::string print_job_title = UTF16ToUTF8(print_job_title_utf16);
   std::string printer_id;
   settings.GetString(printing::kSettingCloudPrintId, &printer_id);
-// BASE64 encode the job data.
+  // BASE64 encode the job data.
   std::string raw_data(reinterpret_cast<const char*>(data->front()),
                        data->size());
   std::string base64_data;
   if (!base::Base64Encode(raw_data, &base64_data)) {
     NOTREACHED() << "Base64 encoding PDF data.";
   }
 
   const char boundary[] = "----CloudPrintFormBoundaryjc9wuprokl8i";
   const char prolog[] = "--%s\r\n"
     "Content-Disposition: form-data; name=\"capabilities\"\r\n\r\n%s\r\n"
     "--%s\r\n"
     "Content-Disposition: form-data; name=\"contentType\"\r\n\r\ndataUrl\r\n"
     "--%s\r\n"
     "Content-Disposition: form-data; name=\"title\"\r\n\r\n%s\r\n"
     "--%s\r\n"
     "Content-Disposition: form-data; name=\"printerid\"\r\n\r\n%s\r\n"
     "--%s\r\n"
     "Content-Disposition: form-data; name=\"content\"\r\n\r\n"
     "data:application/pdf;base64,%s\r\n"
     "--%s\r\n";
 
-// TODO(abodenha@chromium.org) This implies a large copy operation.
-// Profile this and optimize if necessary.
+  // TODO(abodenha@chromium.org) This implies a large copy operation.
+  // Profile this and optimize if necessary.
   std::string final_data;
   base::SStringPrintf(&final_data,
                       prolog,
                       boundary,
                       print_ticket.c_str(),
                       boundary,
                       boundary,
                       print_job_title.c_str(),
                       boundary,
                       printer_id.c_str(),
                       boundary,
                       base64_data.c_str(),
                       boundary);
 
   StringValue data_value(final_data);
 
   web_ui_->CallJavascriptFunction("printToCloud",
                                   data_value);
 }
 
 TabContentsWrapper* PrintPreviewHandler::GetInitiatorTab() const {
   printing::PrintPreviewTabController* tab_controller =
       printing::PrintPreviewTabController::GetInstance();
   if (!tab_controller)
     return NULL;
   return tab_controller->GetInitiatorTab(preview_tab_wrapper());
 }
 
-void PrintPreviewHandler::ClosePrintPreviewTab() {
-  TabContentsWrapper* tab =
-      TabContentsWrapper::GetCurrentWrapperForContents(preview_tab());
-  if (!tab)
-    return;
-  Browser* preview_tab_browser = BrowserList::FindBrowserWithID(
-      tab->restore_tab_helper()->window_id().id());
-  if (!preview_tab_browser)
-    return;
-  TabStripModel* tabstrip = preview_tab_browser->tabstrip_model();
-  int index = tabstrip->GetIndexOfTabContents(tab);
-  if (index == TabStripModel::kNoTab)
-    return;
-
-  // Keep print preview tab out of the recently closed tab list, because
-  // re-opening that page will just display a non-functional print preview page.
-  tabstrip->CloseTabContentsAt(index, TabStripModel::CLOSE_NONE);
-}
-
 void PrintPreviewHandler::OnPrintDialogShown() {
   ActivateInitiatorTabAndClosePreviewTab();
 }
 
 void PrintPreviewHandler::SelectFile(const FilePath& default_filename) {
   SelectFileDialog::FileTypeInfo file_type_info;
   file_type_info.extensions.resize(1);
   file_type_info.extensions[0].push_back(FILE_PATH_LITERAL("pdf"));
 
   // Initializing last_saved_path_ if it is not already initialized.
@@ skipping 68 matching lines @@
   BrowserThread::PostTask(BrowserThread::FILE, FROM_HERE, task);
   print_to_pdf_path_.reset();
   ActivateInitiatorTabAndClosePreviewTab();
 }
 
 void PrintPreviewHandler::FileSelectionCanceled(void* params) {
   PrintPreviewUI* print_preview_ui = static_cast<PrintPreviewUI*>(web_ui_);
   print_preview_ui->OnFileSelectionCancelled();
 }
 
-void PrintPreviewHandler::HidePreviewTab() {
-  if (GetBackgroundPrintingManager()->HasPrintPreviewTab(preview_tab_wrapper()))
-    return;
-  GetBackgroundPrintingManager()->OwnPrintPreviewTab(preview_tab_wrapper());
-}
-
 void PrintPreviewHandler::ClearInitiatorTabDetails() {
   TabContentsWrapper* initiator_tab = GetInitiatorTab();
   if (!initiator_tab)
     return;
 
   // We no longer require the initiator tab details. Remove those details
   // associated with the preview tab to allow the initiator tab to create
   // another preview tab.
   printing::PrintPreviewTabController* tab_controller =
       printing::PrintPreviewTabController::GetInstance();
   if (tab_controller)
     tab_controller->EraseInitiatorTabInfo(preview_tab_wrapper());
 }