components/app_modal/javascript_dialog_manager.cc

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "components/app_modal/javascript_dialog_manager.h"
   6
   7 #include "base/bind.h"
   8 #include "base/i18n/rtl.h"
   9 #include "base/strings/utf_string_conversions.h"
  10 #include "components/app_modal/app_modal_dialog.h"
  11 #include "components/app_modal/app_modal_dialog_queue.h"
  12 #include "components/app_modal/javascript_dialog_extensions_client.h"
  13 #include "components/app_modal/javascript_native_dialog_factory.h"
  14 #include "components/app_modal/native_app_modal_dialog.h"
  15 #include "content/public/common/javascript_message_type.h"
  16 #include "grit/components_strings.h"
  17 #include "net/base/net_util.h"
  18 #include "ui/base/l10n/l10n_util.h"
  19
  20 namespace app_modal {
  21 namespace {
  22
  23 class DefaultExtensionsClient : public JavaScriptDialogExtensionsClient {
  24  public:
  25   DefaultExtensionsClient() {}
  26   ~DefaultExtensionsClient() override {}
  27
  28  private:
  29   // JavaScriptDialogExtensionsClient:
  30   void OnDialogOpened(content::WebContents* web_contents) override {}
  31   void OnDialogClosed(content::WebContents* web_contents) override {}
  32   bool GetExtensionName(content::WebContents* web_contents,
  33                         const GURL& origin_url,
  34                         std::string* name_out) override {
  35     return false;
  36   }
  37
  38   DISALLOW_COPY_AND_ASSIGN(DefaultExtensionsClient);
  39 };
  40
  41 bool ShouldDisplaySuppressCheckbox(
  42     ChromeJavaScriptDialogExtraData* extra_data) {
  43   base::TimeDelta time_since_last_message = base::TimeTicks::Now() -
  44       extra_data->last_javascript_message_dismissal_;
  45
  46   // If a WebContents is impolite and displays a second JavaScript
  47   // alert within kJavaScriptMessageExpectedDelay of a previous
  48   // JavaScript alert being dismissed, show a checkbox offering to
  49   // suppress future alerts from this WebContents.
  50   const int kJavaScriptMessageExpectedDelay = 1000;
  51
  52   return time_since_last_message <
  53       base::TimeDelta::FromMilliseconds(kJavaScriptMessageExpectedDelay);
  54 }
  55
  56 }  // namespace
  57
  58 ////////////////////////////////////////////////////////////////////////////////
  59 // JavaScriptDialogManager, public:
  60
  61 // static
  62 JavaScriptDialogManager* JavaScriptDialogManager::GetInstance() {
  63   return Singleton<JavaScriptDialogManager>::get();
  64 }
  65
  66 void JavaScriptDialogManager::SetNativeDialogFactory(
  67     scoped_ptr<JavaScriptNativeDialogFactory> factory) {
  68   native_dialog_factory_ = factory.Pass();
  69 }
  70
  71 void JavaScriptDialogManager::SetExtensionsClient(
  72     scoped_ptr<JavaScriptDialogExtensionsClient> extensions_client) {
  73   extensions_client_ = extensions_client.Pass();
  74 }
  75
  76 ////////////////////////////////////////////////////////////////////////////////
  77 // JavaScriptDialogManager, private:
  78
  79 JavaScriptDialogManager::JavaScriptDialogManager()
  80     : extensions_client_(new DefaultExtensionsClient) {
  81 }
  82
  83 JavaScriptDialogManager::~JavaScriptDialogManager() {
  84 }
  85
  86 void JavaScriptDialogManager::RunJavaScriptDialog(
  87     content::WebContents* web_contents,
  88     const GURL& origin_url,
  89     const std::string& accept_lang,
  90     content::JavaScriptMessageType message_type,
  91     const base::string16& message_text,
  92     const base::string16& default_prompt_text,
  93     const DialogClosedCallback& callback,
  94     bool* did_suppress_message)  {
  95   *did_suppress_message = false;
  96
  97   ChromeJavaScriptDialogExtraData* extra_data =
  98       &javascript_dialog_extra_data_[web_contents];
  99
 100   if (extra_data->suppress_javascript_messages_) {
 101     *did_suppress_message = true;
 102     return;
 103   }
 104
 105   bool is_alert = message_type == content::JAVASCRIPT_MESSAGE_TYPE_ALERT;
 106   base::string16 dialog_title =
 107       GetTitle(web_contents, origin_url, accept_lang, is_alert);
 108
 109   extensions_client_->OnDialogOpened(web_contents);
 110
 111   AppModalDialogQueue::GetInstance()->AddDialog(new JavaScriptAppModalDialog(
 112       web_contents,
 113       &javascript_dialog_extra_data_,
 114       dialog_title,
 115       message_type,
 116       message_text,
 117       default_prompt_text,
 118       ShouldDisplaySuppressCheckbox(extra_data),
 119       false,  // is_before_unload_dialog
 120       false,  // is_reload
 121       base::Bind(&JavaScriptDialogManager::OnDialogClosed,
 122                  base::Unretained(this), web_contents, callback)));
 123 }
 124
 125 void JavaScriptDialogManager::RunBeforeUnloadDialog(
 126     content::WebContents* web_contents,
 127     const base::string16& message_text,
 128     bool is_reload,
 129     const DialogClosedCallback& callback) {
 130   ChromeJavaScriptDialogExtraData* extra_data =
 131       &javascript_dialog_extra_data_[web_contents];
 132
 133   if (extra_data->suppress_javascript_messages_) {
 134     // If a site harassed the user enough for them to put it on mute, then it
 135     // lost its privilege to deny unloading.
 136     callback.Run(true, base::string16());
 137     return;
 138   }
 139
 140   const base::string16 title = l10n_util::GetStringUTF16(is_reload ?
 141       IDS_BEFORERELOAD_MESSAGEBOX_TITLE : IDS_BEFOREUNLOAD_MESSAGEBOX_TITLE);
 142   const base::string16 footer = l10n_util::GetStringUTF16(is_reload ?
 143       IDS_BEFORERELOAD_MESSAGEBOX_FOOTER : IDS_BEFOREUNLOAD_MESSAGEBOX_FOOTER);
 144
 145   base::string16 full_message =
 146       message_text + base::ASCIIToUTF16("\n\n") + footer;
 147
 148   extensions_client_->OnDialogOpened(web_contents);
 149
 150   AppModalDialogQueue::GetInstance()->AddDialog(new JavaScriptAppModalDialog(
 151       web_contents,
 152       &javascript_dialog_extra_data_,
 153       title,
 154       content::JAVASCRIPT_MESSAGE_TYPE_CONFIRM,
 155       full_message,
 156       base::string16(),  // default_prompt_text
 157       ShouldDisplaySuppressCheckbox(extra_data),
 158       true,        // is_before_unload_dialog
 159       is_reload,
 160       base::Bind(&JavaScriptDialogManager::OnDialogClosed,
 161                  base::Unretained(this), web_contents, callback)));
 162 }
 163
 164 bool JavaScriptDialogManager::HandleJavaScriptDialog(
 165     content::WebContents* web_contents,
 166     bool accept,
 167     const base::string16* prompt_override) {
 168   AppModalDialogQueue* dialog_queue = AppModalDialogQueue::GetInstance();
 169   if (!dialog_queue->HasActiveDialog() ||
 170       !dialog_queue->active_dialog()->IsJavaScriptModalDialog() ||
 171       dialog_queue->active_dialog()->web_contents() != web_contents) {
 172     return false;
 173   }
 174   JavaScriptAppModalDialog* dialog = static_cast<JavaScriptAppModalDialog*>(
 175       dialog_queue->active_dialog());
 176   if (accept) {
 177     if (prompt_override)
 178       dialog->SetOverridePromptText(*prompt_override);
 179     dialog->native_dialog()->AcceptAppModalDialog();
 180   } else {
 181     dialog->native_dialog()->CancelAppModalDialog();
 182   }
 183   return true;
 184 }
 185
 186 void JavaScriptDialogManager::ResetDialogState(
 187     content::WebContents* web_contents) {
 188   CancelActiveAndPendingDialogs(web_contents);
 189   javascript_dialog_extra_data_.erase(web_contents);
 190 }
 191
 192 base::string16 JavaScriptDialogManager::GetTitle(
 193     content::WebContents* web_contents,
 194     const GURL& origin_url,
 195     const std::string& accept_lang,
 196     bool is_alert) {
 197   // If the URL hasn't any host, return the default string.
 198   if (!origin_url.has_host()) {
 199       return l10n_util::GetStringUTF16(
 200           is_alert ? IDS_JAVASCRIPT_ALERT_DEFAULT_TITLE
 201                    : IDS_JAVASCRIPT_MESSAGEBOX_DEFAULT_TITLE);
 202   }
 203
 204   // For extensions, show the extension name, but only if the origin of
 205   // the alert matches the top-level WebContents.
 206   std::string name;
 207   if (extensions_client_->GetExtensionName(web_contents, origin_url, &name))
 208     return base::UTF8ToUTF16(name);
 209
 210   // Otherwise, return the formatted URL.
 211   // In this case, force URL to have LTR directionality.
 212   base::string16 url_string = net::FormatUrl(origin_url, accept_lang);
 213   return l10n_util::GetStringFUTF16(
 214       is_alert ? IDS_JAVASCRIPT_ALERT_TITLE
 215       : IDS_JAVASCRIPT_MESSAGEBOX_TITLE,
 216       base::i18n::GetDisplayStringInLTRDirectionality(url_string));
 217 }
 218
 219 void JavaScriptDialogManager::CancelActiveAndPendingDialogs(
 220     content::WebContents* web_contents) {
 221   AppModalDialogQueue* queue = AppModalDialogQueue::GetInstance();
 222   AppModalDialog* active_dialog = queue->active_dialog();
 223   for (AppModalDialogQueue::iterator i = queue->begin();
 224        i != queue->end(); ++i) {
 225     // Invalidating the active dialog might trigger showing a not-yet
 226     // invalidated dialog, so invalidate the active dialog last.
 227     if ((*i) == active_dialog)
 228       continue;
 229     if ((*i)->web_contents() == web_contents)
 230       (*i)->Invalidate();
 231   }
 232   if (active_dialog && active_dialog->web_contents() == web_contents)
 233     active_dialog->Invalidate();
 234 }
 235
 236 void JavaScriptDialogManager::OnDialogClosed(
 237     content::WebContents* web_contents,
 238     DialogClosedCallback callback,
 239     bool success,
 240     const base::string16& user_input) {
 241   // If an extension opened this dialog then the extension may shut down its
 242   // lazy background page after the dialog closes. (Dialogs are closed before
 243   // their WebContents is destroyed so |web_contents| is still valid here.)
 244   extensions_client_->OnDialogClosed(web_contents);
 245
 246   callback.Run(success, user_input);
 247 }
 248
 249 }  // namespace app_modal