Close web contents modal dialogs on content load start

chrome/browser/ui/webui/print_preview/print_preview_handler.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/ui/webui/print_preview/print_preview_handler.h"
 
 #include <ctype.h>
 
 #include <string>
 
@@ skipping 74 matching lines @@
 // The cloud print OAuth2 scope.
 const char kCloudPrintAuth[] = "https://www.googleapis.com/auth/cloudprint";
 
 enum UserActionBuckets {
   PRINT_TO_PRINTER,
   PRINT_TO_PDF,
   CANCEL,
   FALLBACK_TO_ADVANCED_SETTINGS_DIALOG,
   PREVIEW_FAILED,
   PREVIEW_STARTED,
-  INITIATOR_TAB_CRASHED,  // UNUSED
-  INITIATOR_TAB_CLOSED,
+  INITIATOR_CRASHED,  // UNUSED
+  INITIATOR_CLOSED,
   PRINT_WITH_CLOUD_PRINT,
   USERACTION_BUCKET_BOUNDARY
 };
 
 enum PrintSettingsBuckets {
   LANDSCAPE = 0,
   PORTRAIT,
   COLOR,
   BLACK_AND_WHITE,
   COLLATE,
@@ skipping 43 matching lines @@
                             PRINT_DESTINATION_BUCKET_BOUNDARY);
 }
 
 void ReportGcpPromoHistogram(enum GcpPromoBuckets event) {
   UMA_HISTOGRAM_ENUMERATION("PrintPreview.GcpPromo", event,
                             GCP_PROMO_BUCKET_BOUNDARY);
 }
 
 // Name of a dictionary field holding cloud print related data;
 const char kAppState[] = "appState";
-// Name of a dictionary field holding the initiator tab title.
-const char kInitiatorTabTitle[] = "initiatorTabTitle";
+// Name of a dictionary field holding the initiator title.
+const char kInitiatorTitle[] = "initiatorTitle";
 // Name of a dictionary field holding the measurement system according to the
 // locale.
 const char kMeasurementSystem[] = "measurementSystem";
 // Name of a dictionary field holding the number format according to the locale.
 const char kNumberFormat[] = "numberFormat";
 // Name of a dictionary field specifying whether to print automatically in
 // kiosk mode. See http://crbug.com/31395.
 const char kPrintAutomaticallyInKioskMode[] = "printAutomaticallyInKioskMode";
 // Name of a dictionary field holding the state of selection for document.
 const char kDocumentHasSelection[] = "documentHasSelection";
@@ skipping 266 matching lines @@
   print_preview_ui->OnPrintPreviewRequest(request_id);
   // Add an additional key in order to identify |print_preview_ui| later on
   // when calling PrintPreviewUI::GetCurrentPrintPreviewStatus() on the IO
   // thread.
   settings->SetInteger(printing::kPreviewUIID,
                        print_preview_ui->GetIDForPrintPreviewUI());
 
   // Increment request count.
   ++regenerate_preview_request_count_;
 
-  WebContents* initiator_tab = GetInitiatorTab();
-  if (!initiator_tab) {
-    ReportUserActionHistogram(INITIATOR_TAB_CLOSED);
+  WebContents* initiator = GetInitiator();
+  if (!initiator) {
+    ReportUserActionHistogram(INITIATOR_CLOSED);
     print_preview_ui->OnClosePrintPreviewDialog();
     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();
   }
   if (display_header_footer) {
     settings->SetString(printing::kSettingHeaderFooterTitle,
-                        initiator_tab->GetTitle());
+                        initiator->GetTitle());
     std::string url;
-    NavigationEntry* entry = initiator_tab->GetController().GetActiveEntry();
+    NavigationEntry* entry = initiator->GetController().GetActiveEntry();
     if (entry)
       url = entry->GetVirtualURL().spec();
     settings->SetString(printing::kSettingHeaderFooterURL, url);
   }
 
   bool generate_draft_data = false;
   bool success = settings->GetBoolean(printing::kSettingGenerateDraftData,
                                       &generate_draft_data);
   DCHECK(success);
 
   if (!generate_draft_data) {
     double draft_page_count_double = -1;
     success = args->GetDouble(1, &draft_page_count_double);
     DCHECK(success);
     int draft_page_count = static_cast<int>(draft_page_count_double);
 
     bool preview_modifiable = false;
     success = args->GetBoolean(2, &preview_modifiable);
     DCHECK(success);
 
     if (draft_page_count != -1 && preview_modifiable &&
         print_preview_ui->GetAvailableDraftPageCount() != draft_page_count) {
       settings->SetBoolean(printing::kSettingGenerateDraftData, true);
     }
   }
 
   VLOG(1) << "Print preview request start";
-  RenderViewHost* rvh = initiator_tab->GetRenderViewHost();
+  RenderViewHost* rvh = initiator->GetRenderViewHost();
   rvh->Send(new PrintMsg_PrintPreview(rvh->GetRoutingID(), *settings));
 }
 
 void PrintPreviewHandler::HandlePrint(const ListValue* args) {
   ReportStats();
 
   // Record the number of times the user requests to regenerate preview data
   // before printing.
   UMA_HISTOGRAM_COUNTS("PrintPreview.RegeneratePreviewRequest.BeforePrint",
                        regenerate_preview_request_count_);
 
-  WebContents* initiator_tab = GetInitiatorTab();
-  if (initiator_tab) {
-    RenderViewHost* rvh = initiator_tab->GetRenderViewHost();
+  WebContents* initiator = GetInitiator();
+  if (initiator) {
+    RenderViewHost* rvh = initiator->GetRenderViewHost();
     rvh->Send(new PrintMsg_ResetScriptedPrintCount(rvh->GetRoutingID()));
   }
 
   scoped_ptr<DictionaryValue> settings(GetSettingsDictionary(args));
   if (!settings.get())
     return;
 
   // Never try to add headers/footers here. It's already in the generated PDF.
   settings->SetBoolean(printing::kSettingHeaderFooterEnabled, false);
 
@@ skipping 30 matching lines @@
   if (is_cloud_printer) {
     UMA_HISTOGRAM_COUNTS("PrintPreview.PageCount.PrintToCloudPrint",
                          page_count);
     ReportUserActionHistogram(PRINT_WITH_CLOUD_PRINT);
     SendCloudPrintJob(data.get());
   } else {
     UMA_HISTOGRAM_COUNTS("PrintPreview.PageCount.PrintToPrinter", page_count);
     ReportUserActionHistogram(PRINT_TO_PRINTER);
     ReportPrintSettingsStats(*settings);
 
-    // This tries to activate the initiator tab as well, so do not clear the
-    // association with the initiator tab yet.
+    // This tries to activate the initiator as well, so do not clear the
+    // association with the initiator yet.
     PrintPreviewUI* print_preview_ui = static_cast<PrintPreviewUI*>(
         web_ui()->GetController());
     print_preview_ui->OnHidePreviewDialog();
 
-    // Do this so the initiator tab can open a new print preview dialog, while
-    // the current print preview dialog is still handling its print job.
-    ClearInitiatorTabDetails();
+    // Do this so the initiator can open a new print preview dialog, while the
+    // current print preview dialog is still handling its print job.
+    ClearInitiatorDetails();
 
     // 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);
     // Remove selection only flag for the same reason.
     settings->Remove(printing::kSettingShouldPrintSelectionOnly, NULL);
 
     // Set ID to know whether printing is for preview.
     settings->SetInteger(printing::kPreviewUIID,
                          print_preview_ui->GetIDForPrintPreviewUI());
     RenderViewHost* rvh = preview_web_contents()->GetRenderViewHost();
     rvh->Send(new PrintMsg_PrintForPrintPreview(rvh->GetRoutingID(),
                                                 *settings));
 
     // For all other cases above, the preview dialog will stay open until the
     // printing has finished. Then the dialog closes and PrintPreviewDone() gets
     // called. In the case below, since the preview dialog will be hidden and
     // not closed, we need to make this call.
-    if (initiator_tab) {
+    if (initiator) {
       printing::PrintViewManager* print_view_manager =
-          printing::PrintViewManager::FromWebContents(initiator_tab);
+          printing::PrintViewManager::FromWebContents(initiator);
       print_view_manager->PrintPreviewDone();
     }
   }
 }
 
 void PrintPreviewHandler::PrintToPdf() {
   if (print_to_pdf_path_.get()) {
     // User has already selected a path, no need to show the dialog again.
     PostPrintToPdfTask();
   } else if (!select_file_dialog_.get() ||
              !select_file_dialog_->IsRunning(platform_util::GetTopLevel(
                  preview_web_contents()->GetView()->GetNativeView()))) {
     PrintPreviewUI* print_preview_ui = static_cast<PrintPreviewUI*>(
         web_ui()->GetController());
     // Pre-populating select file dialog with print job title.
-    string16 print_job_title_utf16 = print_preview_ui->initiator_tab_title();
+    string16 print_job_title_utf16 = print_preview_ui->initiator_title();
 
 #if defined(OS_WIN)
     base::FilePath::StringType print_job_title(print_job_title_utf16);
 #elif defined(OS_POSIX)
     base::FilePath::StringType print_job_title =
         UTF16ToUTF8(print_job_title_utf16);
 #endif
 
     file_util::ReplaceIllegalCharactersInPath(&print_job_title, '_');
     base::FilePath default_filename(print_job_title);
     default_filename =
         default_filename.ReplaceExtension(FILE_PATH_LITERAL("pdf"));
 
     SelectFile(default_filename);
   }
 }
 
 void PrintPreviewHandler::HandleHidePreview(const ListValue* /*args*/) {
   PrintPreviewUI* print_preview_ui = static_cast<PrintPreviewUI*>(
       web_ui()->GetController());
   print_preview_ui->OnHidePreviewDialog();
 }
 
 void PrintPreviewHandler::HandleCancelPendingPrintRequest(
     const ListValue* /*args*/) {
-  WebContents* initiator_tab = GetInitiatorTab();
-  if (initiator_tab)
-    ClearInitiatorTabDetails();
-  gfx::NativeWindow parent = initiator_tab ?
-      initiator_tab->GetView()->GetTopLevelNativeWindow() :
+  WebContents* initiator = GetInitiator();
+  if (initiator)
+    ClearInitiatorDetails();
+  gfx::NativeWindow parent = initiator ?
+      initiator->GetView()->GetTopLevelNativeWindow() :
       NULL;
   chrome::ShowPrintErrorDialog(parent);
 }
 
 void PrintPreviewHandler::HandleSaveAppState(const ListValue* args) {
   std::string data_to_save;
   printing::StickySettings* sticky_settings = GetStickySettings();
   if (args->GetString(0, &data_to_save) && !data_to_save.empty())
     sticky_settings->StoreAppState(data_to_save);
   sticky_settings->SaveInPrefs(Profile::FromBrowserContext(
@@ skipping 85 matching lines @@
           Referrer(),
           NEW_FOREGROUND_TAB,
           content::PAGE_TRANSITION_LINK,
           false));
 }
 
 void PrintPreviewHandler::HandleShowSystemDialog(const ListValue* /*args*/) {
   ReportStats();
   ReportUserActionHistogram(FALLBACK_TO_ADVANCED_SETTINGS_DIALOG);
 
-  WebContents* initiator_tab = GetInitiatorTab();
-  if (!initiator_tab)
+  WebContents* initiator = GetInitiator();
+  if (!initiator)
     return;
 
   printing::PrintViewManager* print_view_manager =
-      printing::PrintViewManager::FromWebContents(initiator_tab);
+      printing::PrintViewManager::FromWebContents(initiator);
   print_view_manager->set_observer(this);
   print_view_manager->PrintForSystemDialogNow();
 
   // Cancel the pending preview request if exists.
   PrintPreviewUI* print_preview_ui = static_cast<PrintPreviewUI*>(
       web_ui()->GetController());
   print_preview_ui->OnCancelPendingPreviewRequest();
 }
 
 void PrintPreviewHandler::HandleManagePrinters(const ListValue* /*args*/) {
@@ skipping 85 matching lines @@
     }
     default:
       break;
   }
 }
 
 void PrintPreviewHandler::HandleForceOpenNewTab(const ListValue* args) {
   std::string url;
   if (!args->GetString(0, &url))
     return;
-  Browser* browser = chrome::FindBrowserWithWebContents(GetInitiatorTab());
+  Browser* browser = chrome::FindBrowserWithWebContents(GetInitiator());
   if (!browser)
     return;
   chrome::AddSelectedTabWithURL(browser,
                                 GURL(url),
                                 content::PAGE_TRANSITION_LINK);
 }
 
 void PrintPreviewHandler::SendInitialSettings(
     const std::string& default_printer,
     const std::string& cloud_print_data) {
   PrintPreviewUI* print_preview_ui = static_cast<PrintPreviewUI*>(
       web_ui()->GetController());
 
   base::DictionaryValue initial_settings;
-  initial_settings.SetString(kInitiatorTabTitle,
-                             print_preview_ui->initiator_tab_title());
+  initial_settings.SetString(kInitiatorTitle,
+                             print_preview_ui->initiator_title());
   initial_settings.SetBoolean(printing::kSettingPreviewModifiable,
                               print_preview_ui->source_is_modifiable());
   initial_settings.SetString(printing::kSettingPrinterName, default_printer);
   initial_settings.SetBoolean(kDocumentHasSelection,
                               print_preview_ui->source_has_selection());
   initial_settings.SetBoolean(printing::kSettingShouldPrintSelectionOnly,
                               print_preview_ui->print_selection_only());
   printing::StickySettings* sticky_settings = GetStickySettings();
   sticky_settings->RestoreFromPrefs(Profile::FromBrowserContext(
       preview_web_contents()->GetBrowserContext())->GetPrefs());
@@ skipping 59 matching lines @@
                        data->size());
   std::string base64_data;
   if (!base::Base64Encode(raw_data, &base64_data)) {
     NOTREACHED() << "Base64 encoding PDF data.";
   }
   StringValue data_value(base64_data);
 
   web_ui()->CallJavascriptFunction("printToCloud", data_value);
 }
 
-WebContents* PrintPreviewHandler::GetInitiatorTab() const {
+WebContents* PrintPreviewHandler::GetInitiator() const {
   printing::PrintPreviewDialogController* dialog_controller =
       printing::PrintPreviewDialogController::GetInstance();
   if (!dialog_controller)
     return NULL;
-  return dialog_controller->GetInitiatorTab(preview_web_contents());
+  return dialog_controller->GetInitiator(preview_web_contents());
 }
 
 void PrintPreviewHandler::OnPrintDialogShown() {
   ClosePreviewDialog();
 }
 
 void PrintPreviewHandler::SelectFile(const base::FilePath& default_filename) {
   ui::SelectFileDialog::FileTypeInfo file_type_info;
   file_type_info.extensions.resize(1);
   file_type_info.extensions[0].push_back(FILE_PATH_LITERAL("pdf"));
@@ skipping 21 matching lines @@
       sticky_settings->save_path()->Append(default_filename),
       &file_type_info,
       0,
       base::FilePath::StringType(),
       platform_util::GetTopLevel(
           preview_web_contents()->GetView()->GetNativeView()),
       NULL);
 }
 
 void PrintPreviewHandler::OnPrintPreviewDialogDestroyed() {
-  WebContents* initiator_tab = GetInitiatorTab();
-  if (!initiator_tab)
+  WebContents* initiator = GetInitiator();
+  if (!initiator)
     return;
 
   printing::PrintViewManager* print_view_manager =
-      printing::PrintViewManager::FromWebContents(initiator_tab);
+      printing::PrintViewManager::FromWebContents(initiator);
   print_view_manager->set_observer(NULL);
 }
 
 void PrintPreviewHandler::OnPrintPreviewFailed() {
   if (reported_failed_preview_)
     return;
   reported_failed_preview_ = true;
   ReportUserActionHistogram(PREVIEW_FAILED);
 }
 
@@ skipping 38 matching lines @@
   print_to_pdf_path_.reset();
   ClosePreviewDialog();
 }
 
 void PrintPreviewHandler::FileSelectionCanceled(void* params) {
   PrintPreviewUI* print_preview_ui = static_cast<PrintPreviewUI*>(
       web_ui()->GetController());
   print_preview_ui->OnFileSelectionCancelled();
 }
 
-void PrintPreviewHandler::ClearInitiatorTabDetails() {
-  WebContents* initiator_tab = GetInitiatorTab();
-  if (!initiator_tab)
+void PrintPreviewHandler::ClearInitiatorDetails() {
+  WebContents* initiator = GetInitiator();
+  if (!initiator)
     return;
 
-  // We no longer require the initiator tab details. Remove those details
-  // associated with the preview dialog to allow the initiator tab to create
-  // another preview dialog.
+  // We no longer require the initiator details. Remove those details associated
+  // with the preview dialog to allow the initiator to create another preview
+  // dialog.
   printing::PrintPreviewDialogController* dialog_controller =
       printing::PrintPreviewDialogController::GetInstance();
   if (dialog_controller)
-    dialog_controller->EraseInitiatorTabInfo(preview_web_contents());
+    dialog_controller->EraseInitiatorInfo(preview_web_contents());
 }
 
 bool PrintPreviewHandler::GetPreviewDataAndTitle(
     scoped_refptr<base::RefCountedBytes>* data,
     string16* title) const {
   PrintPreviewUI* print_preview_ui = static_cast<PrintPreviewUI*>(
       web_ui()->GetController());
   scoped_refptr<base::RefCountedBytes> tmp_data;
   print_preview_ui->GetPrintPreviewDataForIndex(
       printing::COMPLETE_PREVIEW_DOCUMENT_INDEX, &tmp_data);
 
   if (!tmp_data.get()) {
     // Nothing to print, no preview available.
     return false;
   }
   DCHECK(tmp_data->size() && tmp_data->front());
 
   *data = tmp_data;
-  *title = print_preview_ui->initiator_tab_title();
+  *title = print_preview_ui->initiator_title();
   return true;
 }