chrome/browser/extensions/extension_context_menu_model.cc

   1 // Copyright (c) 2012 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 "chrome/browser/extensions/extension_context_menu_model.h"
   6
   7 #include "base/prefs/pref_service.h"
   8 #include "base/strings/utf_string_conversions.h"
   9 #include "chrome/app/chrome_command_ids.h"
  10 #include "chrome/browser/extensions/active_script_controller.h"
  11 #include "chrome/browser/extensions/api/extension_action/extension_action_api.h"
  12 #include "chrome/browser/extensions/context_menu_matcher.h"
  13 #include "chrome/browser/extensions/extension_action.h"
  14 #include "chrome/browser/extensions/extension_action_manager.h"
  15 #include "chrome/browser/extensions/extension_tab_util.h"
  16 #include "chrome/browser/extensions/menu_manager.h"
  17 #include "chrome/browser/profiles/profile.h"
  18 #include "chrome/browser/sessions/session_tab_helper.h"
  19 #include "chrome/browser/ui/browser.h"
  20 #include "chrome/browser/ui/browser_window.h"
  21 #include "chrome/browser/ui/chrome_pages.h"
  22 #include "chrome/browser/ui/tabs/tab_strip_model.h"
  23 #include "chrome/common/extensions/extension_constants.h"
  24 #include "chrome/common/pref_names.h"
  25 #include "chrome/common/url_constants.h"
  26 #include "chrome/grit/chromium_strings.h"
  27 #include "chrome/grit/generated_resources.h"
  28 #include "chrome/grit/theme_resources.h"
  29 #include "content/public/browser/web_contents.h"
  30 #include "content/public/common/context_menu_params.h"
  31 #include "extensions/browser/extension_prefs.h"
  32 #include "extensions/browser/extension_registry.h"
  33 #include "extensions/browser/extension_system.h"
  34 #include "extensions/browser/management_policy.h"
  35 #include "extensions/browser/uninstall_reason.h"
  36 #include "extensions/common/extension.h"
  37 #include "extensions/common/feature_switch.h"
  38 #include "extensions/common/manifest_handlers/options_page_info.h"
  39 #include "extensions/common/manifest_url_handlers.h"
  40 #include "ui/base/l10n/l10n_util.h"
  41 #include "ui/base/resource/resource_bundle.h"
  42 #include "ui/gfx/image/image.h"
  43
  44 using content::OpenURLParams;
  45 using content::Referrer;
  46 using content::WebContents;
  47 using extensions::Extension;
  48 using extensions::ExtensionActionAPI;
  49 using extensions::ExtensionPrefs;
  50 using extensions::MenuItem;
  51 using extensions::MenuManager;
  52
  53 namespace {
  54
  55 // Returns true if the given |item| is of the given |type|.
  56 bool MenuItemMatchesAction(ExtensionContextMenuModel::ActionType type,
  57                            const MenuItem* item) {
  58   if (type == ExtensionContextMenuModel::NO_ACTION)
  59     return false;
  60
  61   const MenuItem::ContextList& contexts = item->contexts();
  62
  63   if (contexts.Contains(MenuItem::ALL))
  64     return true;
  65   if (contexts.Contains(MenuItem::PAGE_ACTION) &&
  66       (type == ExtensionContextMenuModel::PAGE_ACTION))
  67     return true;
  68   if (contexts.Contains(MenuItem::BROWSER_ACTION) &&
  69       (type == ExtensionContextMenuModel::BROWSER_ACTION))
  70     return true;
  71
  72   return false;
  73 }
  74
  75 // Returns the id for the visibility command for the given |extension|, or -1
  76 // if none should be shown.
  77 int GetVisibilityStringId(
  78     Profile* profile,
  79     const Extension* extension,
  80     ExtensionContextMenuModel::ButtonVisibility button_visibility) {
  81   DCHECK(profile);
  82   int string_id = -1;
  83   if (!extensions::FeatureSwitch::extension_action_redesign()->IsEnabled()) {
  84     // Without the toolbar redesign, we only show the visibility toggle for
  85     // browser actions, and only give the option to hide.
  86     if (extensions::ExtensionActionManager::Get(profile)->GetBrowserAction(
  87             *extension)) {
  88       string_id = IDS_EXTENSIONS_HIDE_BUTTON;
  89     }
  90   } else {
  91     // With the redesign, we display "show" or "hide" based on the icon's
  92     // visibility, and can have "transitively shown" buttons that are shown
  93     // only while the button has a popup or menu visible.
  94     switch (button_visibility) {
  95       case (ExtensionContextMenuModel::VISIBLE):
  96         string_id = IDS_EXTENSIONS_HIDE_BUTTON_IN_MENU;
  97         break;
  98       case (ExtensionContextMenuModel::TRANSITIVELY_VISIBLE):
  99         string_id = IDS_EXTENSIONS_KEEP_BUTTON_IN_TOOLBAR;
 100         break;
 101       case (ExtensionContextMenuModel::OVERFLOWED):
 102         string_id = IDS_EXTENSIONS_SHOW_BUTTON_IN_TOOLBAR;
 103         break;
 104     }
 105   }
 106   return string_id;
 107 }
 108
 109 // Returns true if the given |extension| is required to remain installed by
 110 // policy.
 111 bool IsExtensionRequiredByPolicy(const Extension* extension,
 112                                  Profile* profile) {
 113   extensions::ManagementPolicy* policy =
 114       extensions::ExtensionSystem::Get(profile)->management_policy();
 115   return !policy->UserMayModifySettings(extension, nullptr) ||
 116          policy->MustRemainInstalled(extension, nullptr);
 117 }
 118
 119 }  // namespace
 120
 121 ExtensionContextMenuModel::ExtensionContextMenuModel(
 122     const Extension* extension,
 123     Browser* browser,
 124     ButtonVisibility button_visibility,
 125     PopupDelegate* delegate)
 126     : SimpleMenuModel(this),
 127       extension_id_(extension->id()),
 128       is_component_(extensions::Manifest::IsComponentLocation(
 129                         extension->location())),
 130       browser_(browser),
 131       profile_(browser->profile()),
 132       delegate_(delegate),
 133       action_type_(NO_ACTION),
 134       extension_items_count_(0) {
 135   InitMenu(extension, button_visibility);
 136
 137   if (profile_->GetPrefs()->GetBoolean(prefs::kExtensionsUIDeveloperMode) &&
 138       delegate_ &&
 139       !is_component_) {
 140     AddSeparator(ui::NORMAL_SEPARATOR);
 141     AddItemWithStringId(INSPECT_POPUP, IDS_EXTENSION_ACTION_INSPECT_POPUP);
 142   }
 143 }
 144
 145 ExtensionContextMenuModel::ExtensionContextMenuModel(const Extension* extension,
 146                                                      Browser* browser)
 147     : ExtensionContextMenuModel(extension, browser, VISIBLE, nullptr) {
 148 }
 149
 150 bool ExtensionContextMenuModel::IsCommandIdChecked(int command_id) const {
 151   if (command_id >= IDC_EXTENSIONS_CONTEXT_CUSTOM_FIRST &&
 152       command_id <= IDC_EXTENSIONS_CONTEXT_CUSTOM_LAST)
 153     return extension_items_->IsCommandIdChecked(command_id);
 154   return false;
 155 }
 156
 157 bool ExtensionContextMenuModel::IsCommandIdEnabled(int command_id) const {
 158   const Extension* extension = GetExtension();
 159   if (!extension)
 160     return false;
 161
 162   if (command_id >= IDC_EXTENSIONS_CONTEXT_CUSTOM_FIRST &&
 163       command_id <= IDC_EXTENSIONS_CONTEXT_CUSTOM_LAST) {
 164     return extension_items_->IsCommandIdEnabled(command_id);
 165   } else if (command_id == CONFIGURE) {
 166     return extensions::OptionsPageInfo::HasOptionsPage(extension);
 167   } else if (command_id == NAME) {
 168     // The NAME links to the Homepage URL. If the extension doesn't have a
 169     // homepage, we just disable this menu item. We also disable for component
 170     // extensions, because it doesn't make sense to link to a webstore page or
 171     // chrome://extensions.
 172     return extensions::ManifestURL::GetHomepageURL(extension).is_valid() &&
 173         !is_component_;
 174   } else if (command_id == INSPECT_POPUP) {
 175     WebContents* web_contents = GetActiveWebContents();
 176     if (!web_contents)
 177       return false;
 178
 179     return extension_action_ &&
 180         extension_action_->HasPopup(SessionTabHelper::IdForTab(web_contents));
 181   } else if (command_id == UNINSTALL) {
 182     return !IsExtensionRequiredByPolicy(extension, profile_);
 183   }
 184   return true;
 185 }
 186
 187 bool ExtensionContextMenuModel::GetAcceleratorForCommandId(
 188     int command_id, ui::Accelerator* accelerator) {
 189   return false;
 190 }
 191
 192 void ExtensionContextMenuModel::ExecuteCommand(int command_id,
 193                                                int event_flags) {
 194   const Extension* extension = GetExtension();
 195   if (!extension)
 196     return;
 197
 198   if (command_id >= IDC_EXTENSIONS_CONTEXT_CUSTOM_FIRST &&
 199       command_id <= IDC_EXTENSIONS_CONTEXT_CUSTOM_LAST) {
 200     WebContents* web_contents =
 201         browser_->tab_strip_model()->GetActiveWebContents();
 202     DCHECK(extension_items_);
 203     extension_items_->ExecuteCommand(
 204         command_id, web_contents, content::ContextMenuParams());
 205     return;
 206   }
 207
 208   switch (command_id) {
 209     case NAME: {
 210       OpenURLParams params(extensions::ManifestURL::GetHomepageURL(extension),
 211                            Referrer(), NEW_FOREGROUND_TAB,
 212                            ui::PAGE_TRANSITION_LINK, false);
 213       browser_->OpenURL(params);
 214       break;
 215     }
 216     case ALWAYS_RUN: {
 217       WebContents* web_contents = GetActiveWebContents();
 218       if (web_contents) {
 219         extensions::ActiveScriptController::GetForWebContents(web_contents)
 220             ->AlwaysRunOnVisibleOrigin(extension);
 221       }
 222       break;
 223     }
 224     case CONFIGURE:
 225       DCHECK(extensions::OptionsPageInfo::HasOptionsPage(extension));
 226       extensions::ExtensionTabUtil::OpenOptionsPage(extension, browser_);
 227       break;
 228     case TOGGLE_VISIBILITY: {
 229       ExtensionActionAPI* api = ExtensionActionAPI::Get(profile_);
 230       bool visible = api->GetBrowserActionVisibility(extension->id());
 231       api->SetBrowserActionVisibility(extension->id(), !visible);
 232       break;
 233     }
 234     case UNINSTALL: {
 235       AddRef();  // Balanced in OnExtensionUninstallDialogClosed().
 236       extension_uninstall_dialog_.reset(
 237           extensions::ExtensionUninstallDialog::Create(
 238               profile_, browser_->window()->GetNativeWindow(), this));
 239       extension_uninstall_dialog_->ConfirmUninstall(
 240           extension, extensions::UNINSTALL_REASON_USER_INITIATED);
 241       break;
 242     }
 243     case MANAGE: {
 244       chrome::ShowExtensions(browser_, extension->id());
 245       break;
 246     }
 247     case INSPECT_POPUP: {
 248       delegate_->InspectPopup();
 249       break;
 250     }
 251     default:
 252      NOTREACHED() << "Unknown option";
 253      break;
 254   }
 255 }
 256
 257 void ExtensionContextMenuModel::OnExtensionUninstallDialogClosed(
 258     bool did_start_uninstall,
 259     const base::string16& error) {
 260   Release();
 261 }
 262
 263 ExtensionContextMenuModel::~ExtensionContextMenuModel() {}
 264
 265 void ExtensionContextMenuModel::InitMenu(const Extension* extension,
 266                                          ButtonVisibility button_visibility) {
 267   DCHECK(extension);
 268
 269   extensions::ExtensionActionManager* extension_action_manager =
 270       extensions::ExtensionActionManager::Get(profile_);
 271   extension_action_ = extension_action_manager->GetBrowserAction(*extension);
 272   if (!extension_action_) {
 273     extension_action_ = extension_action_manager->GetPageAction(*extension);
 274     if (extension_action_)
 275       action_type_ = PAGE_ACTION;
 276   } else {
 277     action_type_ = BROWSER_ACTION;
 278   }
 279
 280   extension_items_.reset(new extensions::ContextMenuMatcher(
 281       profile_, this, this, base::Bind(MenuItemMatchesAction, action_type_)));
 282
 283   std::string extension_name = extension->name();
 284   // Ampersands need to be escaped to avoid being treated like
 285   // mnemonics in the menu.
 286   base::ReplaceChars(extension_name, "&", "&&", &extension_name);
 287   AddItem(NAME, base::UTF8ToUTF16(extension_name));
 288   AppendExtensionItems();
 289   AddSeparator(ui::NORMAL_SEPARATOR);
 290
 291   // Add the "Always Allow" item for adding persisted permissions for script
 292   // injections if there is an active action for this extension. Note that this
 293   // will add it to *all* extension action context menus, not just the one
 294   // attached to the script injection request icon, but that's okay.
 295   WebContents* web_contents = GetActiveWebContents();
 296   if (web_contents &&
 297       extensions::ActiveScriptController::GetForWebContents(web_contents)
 298           ->WantsToRun(extension)) {
 299     AddItemWithStringId(ALWAYS_RUN, IDS_EXTENSIONS_ALWAYS_RUN);
 300   }
 301
 302   if (!is_component_ || extensions::OptionsPageInfo::HasOptionsPage(extension))
 303     AddItemWithStringId(CONFIGURE, IDS_EXTENSIONS_OPTIONS_MENU_ITEM);
 304
 305   if (!is_component_) {
 306     bool is_required_by_policy =
 307         IsExtensionRequiredByPolicy(extension, profile_);
 308     int message_id = is_required_by_policy ?
 309         IDS_EXTENSIONS_INSTALLED_BY_ADMIN : IDS_EXTENSIONS_UNINSTALL;
 310     AddItem(UNINSTALL, l10n_util::GetStringUTF16(message_id));
 311     if (is_required_by_policy) {
 312       int uninstall_index = GetIndexOfCommandId(UNINSTALL);
 313       SetIcon(uninstall_index,
 314               ui::ResourceBundle::GetSharedInstance().GetImageNamed(
 315                   IDR_CONTROLLED_SETTING_MANDATORY));
 316     }
 317   }
 318
 319   // Add a toggle visibility (show/hide) if the extension icon is shown on the
 320   // toolbar.
 321   int visibility_string_id =
 322       GetVisibilityStringId(profile_, extension, button_visibility);
 323   if (visibility_string_id != -1)
 324     AddItemWithStringId(TOGGLE_VISIBILITY, visibility_string_id);
 325
 326   if (!is_component_) {
 327     AddSeparator(ui::NORMAL_SEPARATOR);
 328     AddItemWithStringId(MANAGE, IDS_MANAGE_EXTENSION);
 329   }
 330 }
 331
 332 const Extension* ExtensionContextMenuModel::GetExtension() const {
 333   return extensions::ExtensionRegistry::Get(profile_)
 334       ->enabled_extensions()
 335       .GetByID(extension_id_);
 336 }
 337
 338 void ExtensionContextMenuModel::AppendExtensionItems() {
 339   extension_items_->Clear();
 340
 341   MenuManager* menu_manager = MenuManager::Get(profile_);
 342   if (!menu_manager ||
 343       !menu_manager->MenuItems(MenuItem::ExtensionKey(extension_id_)))
 344     return;
 345
 346   AddSeparator(ui::NORMAL_SEPARATOR);
 347
 348   extension_items_count_ = 0;
 349   extension_items_->AppendExtensionItems(MenuItem::ExtensionKey(extension_id_),
 350                                          base::string16(),
 351                                          &extension_items_count_,
 352                                          true);  // is_action_menu
 353 }
 354
 355 content::WebContents* ExtensionContextMenuModel::GetActiveWebContents() const {
 356   return browser_->tab_strip_model()->GetActiveWebContents();
 357 }