1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878
|
// 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/extensions/api/commands/command_service.h"
#include <vector>
#include "base/lazy_instance.h"
#include "base/prefs/scoped_user_pref_update.h"
#include "base/strings/string_split.h"
#include "base/strings/string_util.h"
#include "base/strings/utf_string_conversions.h"
#include "chrome/app/chrome_command_ids.h"
#include "chrome/browser/extensions/api/commands/commands.h"
#include "chrome/browser/extensions/extension_commands_global_registry.h"
#include "chrome/browser/extensions/extension_keybinding_registry.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/ui/accelerator_utils.h"
#include "chrome/common/extensions/api/commands/commands_handler.h"
#include "chrome/common/extensions/manifest_handlers/ui_overrides_handler.h"
#include "chrome/common/pref_names.h"
#include "components/pref_registry/pref_registry_syncable.h"
#include "content/public/browser/notification_details.h"
#include "content/public/browser/notification_service.h"
#include "extensions/browser/extension_function_registry.h"
#include "extensions/browser/extension_prefs.h"
#include "extensions/browser/extension_registry.h"
#include "extensions/browser/extension_system.h"
#include "extensions/browser/notification_types.h"
#include "extensions/common/feature_switch.h"
#include "extensions/common/manifest_constants.h"
#include "extensions/common/permissions/permissions_data.h"
namespace extensions {
namespace {
const char kExtension[] = "extension";
const char kCommandName[] = "command_name";
const char kGlobal[] = "global";
// A preference that stores keybinding state associated with extension commands.
const char kCommands[] = "commands";
// Preference key name for saving the extension-suggested key.
const char kSuggestedKey[] = "suggested_key";
// Preference key name for saving whether the extension-suggested key was
// actually assigned.
const char kSuggestedKeyWasAssigned[] = "was_assigned";
// A preference that indicates that the initial keybindings for the given
// extension have been set.
const char kInitialBindingsHaveBeenAssigned[] = "initial_keybindings_set";
std::string GetPlatformKeybindingKeyForAccelerator(
const ui::Accelerator& accelerator, const std::string extension_id) {
std::string key = Command::CommandPlatform() + ":" +
Command::AcceleratorToString(accelerator);
// Media keys have a 1-to-many relationship with targets, unlike regular
// shortcut (1-to-1 relationship). That means two or more extensions can
// register for the same media key so the extension ID needs to be added to
// the key to make sure the key is unique.
if (Command::IsMediaKey(accelerator))
key += ":" + extension_id;
return key;
}
bool IsForCurrentPlatform(const std::string& key) {
return StartsWithASCII(key, Command::CommandPlatform() + ":", true);
}
void SetInitialBindingsHaveBeenAssigned(
ExtensionPrefs* prefs, const std::string& extension_id) {
prefs->UpdateExtensionPref(extension_id, kInitialBindingsHaveBeenAssigned,
new base::FundamentalValue(true));
}
bool InitialBindingsHaveBeenAssigned(
const ExtensionPrefs* prefs, const std::string& extension_id) {
bool assigned = false;
if (!prefs || !prefs->ReadPrefAsBoolean(extension_id,
kInitialBindingsHaveBeenAssigned,
&assigned))
return false;
return assigned;
}
// Merge |suggested_key_prefs| into the saved preferences for the extension. We
// merge rather than overwrite to preserve existing was_assigned preferences.
void MergeSuggestedKeyPrefs(
const std::string& extension_id,
ExtensionPrefs* extension_prefs,
scoped_ptr<base::DictionaryValue> suggested_key_prefs) {
const base::DictionaryValue* current_prefs;
if (extension_prefs->ReadPrefAsDictionary(extension_id,
kCommands,
¤t_prefs)) {
scoped_ptr<base::DictionaryValue> new_prefs(current_prefs->DeepCopy());
new_prefs->MergeDictionary(suggested_key_prefs.get());
suggested_key_prefs.reset(new_prefs.release());
}
extension_prefs->UpdateExtensionPref(extension_id,
kCommands,
suggested_key_prefs.release());
}
} // namespace
// static
void CommandService::RegisterProfilePrefs(
user_prefs::PrefRegistrySyncable* registry) {
registry->RegisterDictionaryPref(
prefs::kExtensionCommands,
user_prefs::PrefRegistrySyncable::SYNCABLE_PREF);
}
CommandService::CommandService(content::BrowserContext* context)
: profile_(Profile::FromBrowserContext(context)),
extension_registry_observer_(this) {
ExtensionFunctionRegistry::GetInstance()->
RegisterFunction<GetAllCommandsFunction>();
extension_registry_observer_.Add(ExtensionRegistry::Get(profile_));
}
CommandService::~CommandService() {
}
static base::LazyInstance<BrowserContextKeyedAPIFactory<CommandService> >
g_factory = LAZY_INSTANCE_INITIALIZER;
// static
BrowserContextKeyedAPIFactory<CommandService>*
CommandService::GetFactoryInstance() {
return g_factory.Pointer();
}
// static
CommandService* CommandService::Get(content::BrowserContext* context) {
return BrowserContextKeyedAPIFactory<CommandService>::Get(context);
}
// static
bool CommandService::RemovesBookmarkShortcut(const Extension* extension) {
return UIOverrides::RemovesBookmarkShortcut(extension) &&
(extension->permissions_data()->HasAPIPermission(
APIPermission::kBookmarkManagerPrivate) ||
FeatureSwitch::enable_override_bookmarks_ui()->IsEnabled());
}
// static
bool CommandService::RemovesBookmarkOpenPagesShortcut(
const Extension* extension) {
return UIOverrides::RemovesBookmarkOpenPagesShortcut(extension) &&
(extension->permissions_data()->HasAPIPermission(
APIPermission::kBookmarkManagerPrivate) ||
FeatureSwitch::enable_override_bookmarks_ui()->IsEnabled());
}
bool CommandService::GetBrowserActionCommand(const std::string& extension_id,
QueryType type,
Command* command,
bool* active) const {
return GetExtensionActionCommand(
extension_id, type, command, active, BROWSER_ACTION);
}
bool CommandService::GetPageActionCommand(const std::string& extension_id,
QueryType type,
Command* command,
bool* active) const {
return GetExtensionActionCommand(
extension_id, type, command, active, PAGE_ACTION);
}
bool CommandService::GetNamedCommands(const std::string& extension_id,
QueryType type,
CommandScope scope,
CommandMap* command_map) const {
const ExtensionSet& extensions =
ExtensionRegistry::Get(profile_)->enabled_extensions();
const Extension* extension = extensions.GetByID(extension_id);
CHECK(extension);
command_map->clear();
const CommandMap* commands = CommandsInfo::GetNamedCommands(extension);
if (!commands)
return false;
for (CommandMap::const_iterator iter = commands->begin();
iter != commands->end(); ++iter) {
// Look up to see if the user has overridden how the command should work.
Command saved_command =
FindCommandByName(extension_id, iter->second.command_name());
ui::Accelerator shortcut_assigned = saved_command.accelerator();
if (type == ACTIVE && shortcut_assigned.key_code() == ui::VKEY_UNKNOWN)
continue;
Command command = iter->second;
if (scope != ANY_SCOPE && ((scope == GLOBAL) != saved_command.global()))
continue;
if (type != SUGGESTED && shortcut_assigned.key_code() != ui::VKEY_UNKNOWN)
command.set_accelerator(shortcut_assigned);
command.set_global(saved_command.global());
(*command_map)[iter->second.command_name()] = command;
}
return !command_map->empty();
}
bool CommandService::AddKeybindingPref(
const ui::Accelerator& accelerator,
std::string extension_id,
std::string command_name,
bool allow_overrides,
bool global) {
if (accelerator.key_code() == ui::VKEY_UNKNOWN)
return false;
// Nothing needs to be done if the existing command is the same as the desired
// new one.
Command existing_command = FindCommandByName(extension_id, command_name);
if (existing_command.accelerator() == accelerator &&
existing_command.global() == global)
return true;
// Media Keys are allowed to be used by named command only.
DCHECK(!Command::IsMediaKey(accelerator) ||
(command_name != manifest_values::kPageActionCommandEvent &&
command_name != manifest_values::kBrowserActionCommandEvent));
DictionaryPrefUpdate updater(profile_->GetPrefs(),
prefs::kExtensionCommands);
base::DictionaryValue* bindings = updater.Get();
std::string key = GetPlatformKeybindingKeyForAccelerator(accelerator,
extension_id);
if (bindings->HasKey(key)) {
if (!allow_overrides)
return false; // Already taken.
// If the shortcut has been assigned to another command, it should be
// removed before overriding, so that |ExtensionKeybindingRegistry| can get
// a chance to do clean-up.
const base::DictionaryValue* item = NULL;
bindings->GetDictionary(key, &item);
std::string old_extension_id;
std::string old_command_name;
item->GetString(kExtension, &old_extension_id);
item->GetString(kCommandName, &old_command_name);
RemoveKeybindingPrefs(old_extension_id, old_command_name);
}
// If the command that is taking a new shortcut already has a shortcut, remove
// it before assigning the new one.
if (existing_command.accelerator().key_code() != ui::VKEY_UNKNOWN)
RemoveKeybindingPrefs(extension_id, command_name);
// Set the keybinding pref.
base::DictionaryValue* keybinding = new base::DictionaryValue();
keybinding->SetString(kExtension, extension_id);
keybinding->SetString(kCommandName, command_name);
keybinding->SetBoolean(kGlobal, global);
bindings->Set(key, keybinding);
// Set the was_assigned pref for the suggested key.
scoped_ptr<base::DictionaryValue> command_keys(new base::DictionaryValue);
command_keys->SetBoolean(kSuggestedKeyWasAssigned, true);
scoped_ptr<base::DictionaryValue> suggested_key_prefs(
new base::DictionaryValue);
suggested_key_prefs->Set(command_name, command_keys.release());
MergeSuggestedKeyPrefs(extension_id,
ExtensionPrefs::Get(profile_),
suggested_key_prefs.Pass());
std::pair<const std::string, const std::string> details =
std::make_pair(extension_id, command_name);
content::NotificationService::current()->Notify(
extensions::NOTIFICATION_EXTENSION_COMMAND_ADDED,
content::Source<Profile>(profile_),
content::Details<std::pair<const std::string, const std::string> >(
&details));
return true;
}
void CommandService::OnExtensionWillBeInstalled(
content::BrowserContext* browser_context,
const Extension* extension,
bool is_update,
bool from_ephemeral,
const std::string& old_name) {
UpdateKeybindings(extension);
}
void CommandService::OnExtensionUninstalled(
content::BrowserContext* browser_context,
const Extension* extension,
extensions::UninstallReason reason) {
RemoveKeybindingPrefs(extension->id(), std::string());
}
void CommandService::UpdateKeybindingPrefs(const std::string& extension_id,
const std::string& command_name,
const std::string& keystroke) {
Command command = FindCommandByName(extension_id, command_name);
// The extension command might be assigned another shortcut. Remove that
// shortcut before proceeding.
RemoveKeybindingPrefs(extension_id, command_name);
ui::Accelerator accelerator =
Command::StringToAccelerator(keystroke, command_name);
AddKeybindingPref(accelerator, extension_id, command_name,
true, command.global());
}
bool CommandService::SetScope(const std::string& extension_id,
const std::string& command_name,
bool global) {
Command command = FindCommandByName(extension_id, command_name);
if (global == command.global())
return false;
// Pre-existing shortcuts must be removed before proceeding because the
// handlers for global and non-global extensions are not one and the same.
RemoveKeybindingPrefs(extension_id, command_name);
AddKeybindingPref(command.accelerator(), extension_id,
command_name, true, global);
return true;
}
Command CommandService::FindCommandByName(const std::string& extension_id,
const std::string& command) const {
const base::DictionaryValue* bindings =
profile_->GetPrefs()->GetDictionary(prefs::kExtensionCommands);
for (base::DictionaryValue::Iterator it(*bindings); !it.IsAtEnd();
it.Advance()) {
const base::DictionaryValue* item = NULL;
it.value().GetAsDictionary(&item);
std::string extension;
item->GetString(kExtension, &extension);
if (extension != extension_id)
continue;
std::string command_name;
item->GetString(kCommandName, &command_name);
if (command != command_name)
continue;
// Format stored in Preferences is: "Platform:Shortcut[:ExtensionId]".
std::string shortcut = it.key();
if (!IsForCurrentPlatform(shortcut))
continue;
bool global = false;
item->GetBoolean(kGlobal, &global);
std::vector<std::string> tokens;
base::SplitString(shortcut, ':', &tokens);
CHECK(tokens.size() >= 2);
shortcut = tokens[1];
return Command(command_name, base::string16(), shortcut, global);
}
return Command();
}
bool CommandService::GetSuggestedExtensionCommand(
const std::string& extension_id,
const ui::Accelerator& accelerator,
Command* command,
ExtensionCommandType* command_type) const {
const Extension* extension =
ExtensionRegistry::Get(profile_)
->GetExtensionById(extension_id, ExtensionRegistry::ENABLED);
CHECK(extension);
Command prospective_command;
CommandMap command_map;
if (GetBrowserActionCommand(extension_id,
CommandService::SUGGESTED,
&prospective_command,
nullptr) &&
accelerator == prospective_command.accelerator()) {
if (command)
*command = prospective_command;
if (command_type)
*command_type = BROWSER_ACTION;
return true;
} else if (GetPageActionCommand(extension_id,
CommandService::SUGGESTED,
&prospective_command,
nullptr) &&
accelerator == prospective_command.accelerator()) {
if (command)
*command = prospective_command;
if (command_type)
*command_type = PAGE_ACTION;
return true;
} else if (GetNamedCommands(extension_id,
CommandService::SUGGESTED,
CommandService::REGULAR,
&command_map)) {
for (CommandMap::const_iterator it = command_map.begin();
it != command_map.end();
++it) {
if (accelerator == it->second.accelerator()) {
if (command)
*command = it->second;
if (command_type)
*command_type = NAMED;
return true;
}
}
}
return false;
}
bool CommandService::RequestsBookmarkShortcutOverride(
const Extension* extension) const {
return RemovesBookmarkShortcut(extension) &&
GetSuggestedExtensionCommand(
extension->id(),
chrome::GetPrimaryChromeAcceleratorForCommandId(IDC_BOOKMARK_PAGE),
NULL,
NULL);
}
void CommandService::UpdateKeybindings(const Extension* extension) {
const ExtensionSet& extensions =
ExtensionRegistry::Get(profile_)->enabled_extensions();
// The extension is not added to the profile by this point on first install,
// so don't try to check for existing keybindings.
if (extensions.GetByID(extension->id()))
RemoveRelinquishedKeybindings(extension);
AssignKeybindings(extension);
UpdateExtensionSuggestedCommandPrefs(extension);
RemoveDefunctExtensionSuggestedCommandPrefs(extension);
}
void CommandService::RemoveRelinquishedKeybindings(const Extension* extension) {
// Remove keybindings if they have been removed by the extension and the user
// has not modified them.
CommandMap existing_command_map;
if (GetNamedCommands(extension->id(),
CommandService::ACTIVE,
CommandService::REGULAR,
&existing_command_map)) {
const CommandMap* new_command_map =
CommandsInfo::GetNamedCommands(extension);
for (CommandMap::const_iterator it = existing_command_map.begin();
it != existing_command_map.end(); ++it) {
std::string command_name = it->first;
if (new_command_map->find(command_name) == new_command_map->end() &&
!IsCommandShortcutUserModified(extension, command_name)) {
RemoveKeybindingPrefs(extension->id(), command_name);
}
}
}
Command existing_browser_action_command;
const Command* new_browser_action_command =
CommandsInfo::GetBrowserActionCommand(extension);
if (GetBrowserActionCommand(extension->id(),
CommandService::ACTIVE,
&existing_browser_action_command,
NULL) &&
// The browser action command may be defaulted to an unassigned
// accelerator if a browser action is specified by the extension but a
// keybinding is not declared. See
// CommandsHandler::MaybeSetBrowserActionDefault.
(!new_browser_action_command ||
new_browser_action_command->accelerator().key_code() ==
ui::VKEY_UNKNOWN) &&
!IsCommandShortcutUserModified(
extension,
existing_browser_action_command.command_name())) {
RemoveKeybindingPrefs(extension->id(),
existing_browser_action_command.command_name());
}
Command existing_page_action_command;
if (GetPageActionCommand(extension->id(),
CommandService::ACTIVE,
&existing_page_action_command,
NULL) &&
!CommandsInfo::GetPageActionCommand(extension) &&
!IsCommandShortcutUserModified(
extension,
existing_page_action_command.command_name())) {
RemoveKeybindingPrefs(extension->id(),
existing_page_action_command.command_name());
}
}
void CommandService::AssignKeybindings(const Extension* extension) {
const CommandMap* commands = CommandsInfo::GetNamedCommands(extension);
if (!commands)
return;
ExtensionPrefs* extension_prefs = ExtensionPrefs::Get(profile_);
// TODO(wittman): remove use of this pref after M37 hits stable.
if (!InitialBindingsHaveBeenAssigned(extension_prefs, extension->id()))
SetInitialBindingsHaveBeenAssigned(extension_prefs, extension->id());
for (CommandMap::const_iterator iter = commands->begin();
iter != commands->end(); ++iter) {
const Command command = iter->second;
if (CanAutoAssign(command, extension)) {
AddKeybindingPref(command.accelerator(),
extension->id(),
command.command_name(),
false, // Overwriting not allowed.
command.global());
}
}
const Command* browser_action_command =
CommandsInfo::GetBrowserActionCommand(extension);
if (browser_action_command &&
CanAutoAssign(*browser_action_command, extension)) {
AddKeybindingPref(browser_action_command->accelerator(),
extension->id(),
browser_action_command->command_name(),
false, // Overwriting not allowed.
false); // Not global.
}
const Command* page_action_command =
CommandsInfo::GetPageActionCommand(extension);
if (page_action_command && CanAutoAssign(*page_action_command, extension)) {
AddKeybindingPref(page_action_command->accelerator(),
extension->id(),
page_action_command->command_name(),
false, // Overwriting not allowed.
false); // Not global.
}
}
bool CommandService::CanAutoAssign(const Command &command,
const Extension* extension) {
// Extensions are allowed to auto-assign updated keys if the user has not
// changed from the previous value.
if (IsCommandShortcutUserModified(extension, command.command_name()))
return false;
// Media Keys are non-exclusive, so allow auto-assigning them.
if (Command::IsMediaKey(command.accelerator()))
return true;
if (command.global()) {
using namespace extensions;
if (command.command_name() == manifest_values::kBrowserActionCommandEvent ||
command.command_name() == manifest_values::kPageActionCommandEvent)
return false; // Browser and page actions are not global in nature.
if (extension->permissions_data()->HasAPIPermission(
APIPermission::kCommandsAccessibility))
return true;
// Global shortcuts are restricted to (Ctrl|Command)+Shift+[0-9].
#if defined OS_MACOSX
if (!command.accelerator().IsCmdDown())
return false;
#else
if (!command.accelerator().IsCtrlDown())
return false;
#endif
if (!command.accelerator().IsShiftDown())
return false;
return (command.accelerator().key_code() >= ui::VKEY_0 &&
command.accelerator().key_code() <= ui::VKEY_9);
} else {
// Not a global command, check if Chrome shortcut and whether
// we can override it.
if (command.accelerator() ==
chrome::GetPrimaryChromeAcceleratorForCommandId(IDC_BOOKMARK_PAGE) &&
CommandService::RemovesBookmarkShortcut(extension)) {
// If this check fails it either means we have an API to override a
// key that isn't a ChromeAccelerator (and the API can therefore be
// deprecated) or the IsChromeAccelerator isn't consistently
// returning true for all accelerators.
DCHECK(chrome::IsChromeAccelerator(command.accelerator(), profile_));
return true;
}
return !chrome::IsChromeAccelerator(command.accelerator(), profile_);
}
}
void CommandService::UpdateExtensionSuggestedCommandPrefs(
const Extension* extension) {
scoped_ptr<base::DictionaryValue> suggested_key_prefs(
new base::DictionaryValue);
const CommandMap* commands = CommandsInfo::GetNamedCommands(extension);
if (commands) {
for (CommandMap::const_iterator iter = commands->begin();
iter != commands->end(); ++iter) {
const Command command = iter->second;
scoped_ptr<base::DictionaryValue> command_keys(new base::DictionaryValue);
command_keys->SetString(
kSuggestedKey,
Command::AcceleratorToString(command.accelerator()));
suggested_key_prefs->Set(command.command_name(), command_keys.release());
}
}
const Command* browser_action_command =
CommandsInfo::GetBrowserActionCommand(extension);
// The browser action command may be defaulted to an unassigned accelerator if
// a browser action is specified by the extension but a keybinding is not
// declared. See CommandsHandler::MaybeSetBrowserActionDefault.
if (browser_action_command &&
browser_action_command->accelerator().key_code() != ui::VKEY_UNKNOWN) {
scoped_ptr<base::DictionaryValue> command_keys(new base::DictionaryValue);
command_keys->SetString(
kSuggestedKey,
Command::AcceleratorToString(browser_action_command->accelerator()));
suggested_key_prefs->Set(browser_action_command->command_name(),
command_keys.release());
}
const Command* page_action_command =
CommandsInfo::GetPageActionCommand(extension);
if (page_action_command) {
scoped_ptr<base::DictionaryValue> command_keys(new base::DictionaryValue);
command_keys->SetString(
kSuggestedKey,
Command::AcceleratorToString(page_action_command->accelerator()));
suggested_key_prefs->Set(page_action_command->command_name(),
command_keys.release());
}
// Merge into current prefs, if present.
MergeSuggestedKeyPrefs(extension->id(),
ExtensionPrefs::Get(profile_),
suggested_key_prefs.Pass());
}
void CommandService::RemoveDefunctExtensionSuggestedCommandPrefs(
const Extension* extension) {
ExtensionPrefs* extension_prefs = ExtensionPrefs::Get(profile_);
const base::DictionaryValue* current_prefs = NULL;
extension_prefs->ReadPrefAsDictionary(extension->id(),
kCommands,
¤t_prefs);
if (current_prefs) {
scoped_ptr<base::DictionaryValue> suggested_key_prefs(
current_prefs->DeepCopy());
const CommandMap* named_commands =
CommandsInfo::GetNamedCommands(extension);
const Command* browser_action_command =
CommandsInfo::GetBrowserActionCommand(extension);
for (base::DictionaryValue::Iterator it(*current_prefs);
!it.IsAtEnd(); it.Advance()) {
if (it.key() == manifest_values::kBrowserActionCommandEvent) {
// The browser action command may be defaulted to an unassigned
// accelerator if a browser action is specified by the extension but a
// keybinding is not declared. See
// CommandsHandler::MaybeSetBrowserActionDefault.
if (!browser_action_command ||
browser_action_command->accelerator().key_code() ==
ui::VKEY_UNKNOWN) {
suggested_key_prefs->Remove(it.key(), NULL);
}
} else if (it.key() == manifest_values::kPageActionCommandEvent) {
if (!CommandsInfo::GetPageActionCommand(extension))
suggested_key_prefs->Remove(it.key(), NULL);
} else if (named_commands) {
if (named_commands->find(it.key()) == named_commands->end())
suggested_key_prefs->Remove(it.key(), NULL);
}
}
extension_prefs->UpdateExtensionPref(extension->id(),
kCommands,
suggested_key_prefs.release());
}
}
bool CommandService::IsCommandShortcutUserModified(
const Extension* extension,
const std::string& command_name) {
// Get the previous suggested key, if any.
ui::Accelerator suggested_key;
bool suggested_key_was_assigned = false;
ExtensionPrefs* extension_prefs = ExtensionPrefs::Get(profile_);
const base::DictionaryValue* commands_prefs = NULL;
const base::DictionaryValue* suggested_key_prefs = NULL;
if (extension_prefs->ReadPrefAsDictionary(extension->id(),
kCommands,
&commands_prefs) &&
commands_prefs->GetDictionary(command_name, &suggested_key_prefs)) {
std::string suggested_key_string;
if (suggested_key_prefs->GetString(kSuggestedKey, &suggested_key_string)) {
suggested_key = Command::StringToAccelerator(suggested_key_string,
command_name);
}
suggested_key_prefs->GetBoolean(kSuggestedKeyWasAssigned,
&suggested_key_was_assigned);
}
// Get the active shortcut from the prefs, if any.
Command active_command = FindCommandByName(extension->id(), command_name);
return suggested_key_was_assigned ?
active_command.accelerator() != suggested_key :
active_command.accelerator().key_code() != ui::VKEY_UNKNOWN;
}
bool CommandService::IsKeybindingChanging(const Extension* extension,
const std::string& command_name) {
// Get the new assigned command, if any.
Command new_command;
if (command_name == manifest_values::kBrowserActionCommandEvent) {
new_command = *CommandsInfo::GetBrowserActionCommand(extension);
} else if (command_name == manifest_values::kPageActionCommandEvent) {
new_command = *CommandsInfo::GetPageActionCommand(extension);
} else { // This is a named command.
const CommandMap* named_commands =
CommandsInfo::GetNamedCommands(extension);
if (named_commands) {
CommandMap::const_iterator loc = named_commands->find(command_name);
if (loc != named_commands->end())
new_command = loc->second;
}
}
return Command::StringToAccelerator(
GetSuggestedKeyPref(extension, command_name), command_name) !=
new_command.accelerator();
}
std::string CommandService::GetSuggestedKeyPref(
const Extension* extension,
const std::string& command_name) {
// Get the previous suggested key, if any.
ui::Accelerator suggested_key;
ExtensionPrefs* extension_prefs = ExtensionPrefs::Get(profile_);
const base::DictionaryValue* commands_prefs = NULL;
if (extension_prefs->ReadPrefAsDictionary(extension->id(),
kCommands,
&commands_prefs)) {
const base::DictionaryValue* suggested_key_prefs = NULL;
std::string suggested_key;
if (commands_prefs->GetDictionary(command_name, &suggested_key_prefs) &&
suggested_key_prefs->GetString(kSuggestedKey, &suggested_key)) {
return suggested_key;
}
}
return std::string();
}
void CommandService::RemoveKeybindingPrefs(const std::string& extension_id,
const std::string& command_name) {
DictionaryPrefUpdate updater(profile_->GetPrefs(),
prefs::kExtensionCommands);
base::DictionaryValue* bindings = updater.Get();
typedef std::vector<std::string> KeysToRemove;
KeysToRemove keys_to_remove;
for (base::DictionaryValue::Iterator it(*bindings); !it.IsAtEnd();
it.Advance()) {
// Removal of keybinding preference should be limited to current platform.
if (!IsForCurrentPlatform(it.key()))
continue;
const base::DictionaryValue* item = NULL;
it.value().GetAsDictionary(&item);
std::string extension;
item->GetString(kExtension, &extension);
if (extension == extension_id) {
// If |command_name| is specified, delete only that command. Otherwise,
// delete all commands.
if (!command_name.empty()) {
std::string command;
item->GetString(kCommandName, &command);
if (command_name != command)
continue;
}
keys_to_remove.push_back(it.key());
}
}
for (KeysToRemove::const_iterator it = keys_to_remove.begin();
it != keys_to_remove.end(); ++it) {
std::string key = *it;
bindings->Remove(key, NULL);
std::pair<const std::string, const std::string> details =
std::make_pair(extension_id, command_name);
content::NotificationService::current()->Notify(
extensions::NOTIFICATION_EXTENSION_COMMAND_REMOVED,
content::Source<Profile>(profile_),
content::Details<std::pair<const std::string, const std::string> >(
&details));
}
}
bool CommandService::GetExtensionActionCommand(
const std::string& extension_id,
QueryType query_type,
Command* command,
bool* active,
ExtensionCommandType action_type) const {
const ExtensionSet& extensions =
ExtensionRegistry::Get(profile_)->enabled_extensions();
const Extension* extension = extensions.GetByID(extension_id);
CHECK(extension);
if (active)
*active = false;
const Command* requested_command = NULL;
switch (action_type) {
case BROWSER_ACTION:
requested_command = CommandsInfo::GetBrowserActionCommand(extension);
break;
case PAGE_ACTION:
requested_command = CommandsInfo::GetPageActionCommand(extension);
break;
case NAMED:
NOTREACHED();
return false;
}
if (!requested_command)
return false;
// Look up to see if the user has overridden how the command should work.
Command saved_command =
FindCommandByName(extension_id, requested_command->command_name());
ui::Accelerator shortcut_assigned = saved_command.accelerator();
if (active) {
if (query_type == SUGGESTED) {
*active =
(requested_command->accelerator().key_code() != ui::VKEY_UNKNOWN &&
requested_command->accelerator() == shortcut_assigned);
} else {
*active = (shortcut_assigned.key_code() != ui::VKEY_UNKNOWN);
}
}
if (query_type == ACTIVE && shortcut_assigned.key_code() == ui::VKEY_UNKNOWN)
return false;
*command = *requested_command;
if (query_type != SUGGESTED &&
shortcut_assigned.key_code() != ui::VKEY_UNKNOWN)
command->set_accelerator(shortcut_assigned);
return true;
}
template <>
void
BrowserContextKeyedAPIFactory<CommandService>::DeclareFactoryDependencies() {
DependsOn(ExtensionCommandsGlobalRegistry::GetFactoryInstance());
}
} // namespace extensions
|