shortcut_manager.cc revision f8ee788a64d60abd8f2d742a5fdedde054ecd910
1558790d6acca3451cf3a6b497803a5f07d0bec58Ben Murdoch// Copyright 2013 The Chromium Authors. All rights reserved. 22a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 32a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// found in the LICENSE file. 42a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 5558790d6acca3451cf3a6b497803a5f07d0bec58Ben Murdoch#include "chrome/browser/apps/shortcut_manager.h" 62a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 72a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "base/bind.h" 82a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "base/compiler_specific.h" 9eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#include "base/prefs/pref_service.h" 10868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)#include "base/strings/string16.h" 11868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)#include "base/strings/utf_string_conversions.h" 12eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#include "chrome/browser/browser_process.h" 13eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#include "chrome/browser/extensions/extension_service.h" 14cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#include "chrome/browser/extensions/extension_ui_util.h" 15eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#include "chrome/browser/profiles/profile.h" 16eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#include "chrome/browser/profiles/profile_info_cache.h" 17eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#include "chrome/browser/profiles/profile_manager.h" 182a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "chrome/browser/shell_integration.h" 192a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "chrome/browser/web_applications/web_app.h" 204e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles)#include "chrome/common/pref_names.h" 21cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#include "components/pref_registry/pref_registry_syncable.h" 22eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#include "content/public/browser/browser_thread.h" 23cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#include "extensions/browser/extension_registry.h" 245d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)#include "extensions/browser/extension_system.h" 25f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles)#include "extensions/browser/extension_util.h" 265d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)#include "extensions/common/extension_set.h" 27cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#include "extensions/common/one_shot_event.h" 28a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles) 292a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)using extensions::Extension; 302a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 31c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)namespace { 32c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 3346d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)// This version number is stored in local prefs to check whether app shortcuts 3446d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)// need to be recreated. This might happen when we change various aspects of app 3546d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)// shortcuts like command-line flags or associated icons, binaries, etc. 3646d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)const int kCurrentAppShortcutsVersion = 0; 3746d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) 3846d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)// Delay in seconds before running UpdateShortcutsForAllApps. 3946d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)const int kUpdateShortcutsForAllAppsDelay = 10; 4046d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) 41f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles)void CreateShortcutsForApp(Profile* profile, const Extension* app) { 42a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch web_app::ShortcutLocations creation_locations; 43f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) 44f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) if (extensions::util::IsEphemeralApp(app->id(), profile)) { 45f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) // Ephemeral apps should not have visible shortcuts, but may still require 46f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) // platform-specific handling. 47f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) creation_locations.applications_menu_location = 48f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) web_app::APP_MENU_LOCATION_HIDDEN; 49f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) } else { 50f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) // Creates a shortcut for an app in the Chrome Apps subdir of the 51f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) // applications menu, if there is not already one present. 52f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) creation_locations.applications_menu_location = 53f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) web_app::APP_MENU_LOCATION_SUBDIR_CHROMEAPPS; 54f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) } 55f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) 56c5cede9ae108bb15f6b7a8aea21c7e1fefa2834cBen Murdoch web_app::CreateShortcuts( 57c5cede9ae108bb15f6b7a8aea21c7e1fefa2834cBen Murdoch web_app::SHORTCUT_CREATION_AUTOMATED, creation_locations, profile, app); 58eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch} 59eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch 6046d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)void SetCurrentAppShortcutsVersion(PrefService* prefs) { 6146d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) prefs->SetInteger(prefs::kAppShortcutsVersion, kCurrentAppShortcutsVersion); 62c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)} 63c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 64c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)} // namespace 65c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 664e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles)// static 674e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles)void AppShortcutManager::RegisterProfilePrefs( 684e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) user_prefs::PrefRegistrySyncable* registry) { 694e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // Indicates whether app shortcuts have been created. 7046d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) registry->RegisterIntegerPref( 7146d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) prefs::kAppShortcutsVersion, 0, 724e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) user_prefs::PrefRegistrySyncable::UNSYNCABLE_PREF); 734e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles)} 744e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) 75558790d6acca3451cf3a6b497803a5f07d0bec58Ben MurdochAppShortcutManager::AppShortcutManager(Profile* profile) 762a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) : profile_(profile), 77eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch is_profile_info_cache_observer_(false), 78cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) prefs_(profile->GetPrefs()), 79cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) extension_registry_observer_(this), 80cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) weak_ptr_factory_(this) { 812385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch // Use of g_browser_process requires that we are either on the UI thread, or 822385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch // there are no threads initialized (such as in unit tests). 83ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch DCHECK(!content::BrowserThread::IsThreadInitialized( 84ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch content::BrowserThread::UI) || 85ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch content::BrowserThread::CurrentlyOn(content::BrowserThread::UI)); 862385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch 87cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) extension_registry_observer_.Add( 88cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) extensions::ExtensionRegistry::Get(profile_)); 8946d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) // Wait for extensions to be ready before running 9046d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) // UpdateShortcutsForAllAppsIfNeeded. 91cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) extensions::ExtensionSystem::Get(profile)->ready().Post( 92cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) FROM_HERE, 9346d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) base::Bind(&AppShortcutManager::UpdateShortcutsForAllAppsIfNeeded, 94cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) weak_ptr_factory_.GetWeakPtr())); 95eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch 96eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch ProfileManager* profile_manager = g_browser_process->profile_manager(); 97eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch // profile_manager might be NULL in testing environments. 98eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch if (profile_manager) { 99eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch profile_manager->GetProfileInfoCache().AddObserver(this); 100eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch is_profile_info_cache_observer_ = true; 101eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch } 1022a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)} 1032a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 104558790d6acca3451cf3a6b497803a5f07d0bec58Ben MurdochAppShortcutManager::~AppShortcutManager() { 105eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch if (g_browser_process && is_profile_info_cache_observer_) { 106eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch ProfileManager* profile_manager = g_browser_process->profile_manager(); 107eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch // profile_manager might be NULL in testing environments or during shutdown. 108eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch if (profile_manager) 109eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch profile_manager->GetProfileInfoCache().RemoveObserver(this); 110eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch } 111eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch} 1122a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 113cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)void AppShortcutManager::OnExtensionWillBeInstalled( 114cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) content::BrowserContext* browser_context, 115cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) const Extension* extension, 116cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) bool is_update, 117cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) bool from_ephemeral, 118cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) const std::string& old_name) { 119cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) if (!extension->is_app()) 120cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) return; 121cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 122cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // If the app is being updated, update any existing shortcuts but do not 123cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // create new ones. If it is being installed, automatically create a 124cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // shortcut in the applications menu (e.g., Start Menu). 125cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) if (is_update && !from_ephemeral) { 126cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) web_app::UpdateAllShortcuts( 127cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) base::UTF8ToUTF16(old_name), profile_, extension); 12846d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) } else { 129f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) CreateShortcutsForApp(profile_, extension); 1302a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 1312a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)} 1322a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 133cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)void AppShortcutManager::OnExtensionUninstalled( 134cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) content::BrowserContext* browser_context, 135cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) const Extension* extension) { 136cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) web_app::DeleteAllShortcuts(profile_, extension); 137cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)} 138cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 139558790d6acca3451cf3a6b497803a5f07d0bec58Ben Murdochvoid AppShortcutManager::OnProfileWillBeRemoved( 140eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch const base::FilePath& profile_path) { 141eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch if (profile_path != profile_->GetPath()) 142eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch return; 143eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch content::BrowserThread::PostTask( 144eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch content::BrowserThread::FILE, FROM_HERE, 145eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch base::Bind(&web_app::internals::DeleteAllShortcutsForProfile, 146eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch profile_path)); 147eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch} 148eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch 14946d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)void AppShortcutManager::UpdateShortcutsForAllAppsIfNeeded() { 15046d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) int last_version = prefs_->GetInteger(prefs::kAppShortcutsVersion); 15146d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) if (last_version >= kCurrentAppShortcutsVersion) 152eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch return; 153eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch 15446d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) content::BrowserThread::PostDelayedTask( 15546d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) content::BrowserThread::UI, 15646d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) FROM_HERE, 15746d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) base::Bind(&web_app::UpdateShortcutsForAllApps, 15846d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) profile_, 15946d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) base::Bind(&SetCurrentAppShortcutsVersion, prefs_)), 16046d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) base::TimeDelta::FromSeconds(kUpdateShortcutsForAllAppsDelay)); 161eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch} 162