shortcut_manager.cc revision 46d4c2bc3267f3f028f39e7e311b0f89aba2e4fd
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"
8868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)#include "base/command_line.h"
92a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "base/compiler_specific.h"
10eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#include "base/prefs/pref_service.h"
11868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)#include "base/strings/string16.h"
12868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)#include "base/strings/utf_string_conversions.h"
13eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#include "chrome/browser/browser_process.h"
14eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#include "chrome/browser/extensions/extension_service.h"
15cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#include "chrome/browser/extensions/extension_ui_util.h"
16eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#include "chrome/browser/profiles/profile.h"
17eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#include "chrome/browser/profiles/profile_info_cache.h"
18eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#include "chrome/browser/profiles/profile_manager.h"
192a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "chrome/browser/shell_integration.h"
202a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "chrome/browser/web_applications/web_app.h"
21868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)#include "chrome/common/chrome_switches.h"
224e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles)#include "chrome/common/pref_names.h"
23cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#include "components/pref_registry/pref_registry_syncable.h"
24eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#include "content/public/browser/browser_thread.h"
25cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#include "extensions/browser/extension_registry.h"
265d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)#include "extensions/browser/extension_system.h"
275d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)#include "extensions/common/extension_set.h"
28cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#include "extensions/common/one_shot_event.h"
29a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)
302a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)using extensions::Extension;
312a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)
32c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)namespace {
33c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)
3446d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)// This version number is stored in local prefs to check whether app shortcuts
3546d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)// need to be recreated. This might happen when we change various aspects of app
3646d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)// shortcuts like command-line flags or associated icons, binaries, etc.
3746d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)const int kCurrentAppShortcutsVersion = 0;
3846d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)
3946d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)// Delay in seconds before running UpdateShortcutsForAllApps.
4046d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)const int kUpdateShortcutsForAllAppsDelay = 10;
4146d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)
42eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch// Creates a shortcut for an application in the applications menu, if there is
43eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch// not already one present.
44c5cede9ae108bb15f6b7a8aea21c7e1fefa2834cBen Murdochvoid CreateShortcutsInApplicationsMenu(Profile* profile,
45c5cede9ae108bb15f6b7a8aea21c7e1fefa2834cBen Murdoch                                       const Extension* app) {
46a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch  web_app::ShortcutLocations creation_locations;
47c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)  // Create the shortcut in the Chrome Apps subdir.
48a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)  creation_locations.applications_menu_location =
49a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch      web_app::APP_MENU_LOCATION_SUBDIR_CHROMEAPPS;
50c5cede9ae108bb15f6b7a8aea21c7e1fefa2834cBen Murdoch  web_app::CreateShortcuts(
51c5cede9ae108bb15f6b7a8aea21c7e1fefa2834cBen Murdoch      web_app::SHORTCUT_CREATION_AUTOMATED, creation_locations, profile, app);
52eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch}
53eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch
5446d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)void SetCurrentAppShortcutsVersion(PrefService* prefs) {
5546d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)  prefs->SetInteger(prefs::kAppShortcutsVersion, kCurrentAppShortcutsVersion);
56c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)}
57c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)
58c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)}  // namespace
59c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)
604e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles)// static
614e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles)void AppShortcutManager::RegisterProfilePrefs(
624e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles)    user_prefs::PrefRegistrySyncable* registry) {
634e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles)  // Indicates whether app shortcuts have been created.
6446d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)  registry->RegisterIntegerPref(
6546d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)      prefs::kAppShortcutsVersion, 0,
664e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles)      user_prefs::PrefRegistrySyncable::UNSYNCABLE_PREF);
674e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles)}
684e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles)
69558790d6acca3451cf3a6b497803a5f07d0bec58Ben MurdochAppShortcutManager::AppShortcutManager(Profile* profile)
702a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)    : profile_(profile),
71eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch      is_profile_info_cache_observer_(false),
72cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)      prefs_(profile->GetPrefs()),
73cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)      extension_registry_observer_(this),
74cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)      weak_ptr_factory_(this) {
752385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch  // Use of g_browser_process requires that we are either on the UI thread, or
762385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch  // there are no threads initialized (such as in unit tests).
77ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch  DCHECK(!content::BrowserThread::IsThreadInitialized(
78ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch             content::BrowserThread::UI) ||
79ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch         content::BrowserThread::CurrentlyOn(content::BrowserThread::UI));
802385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch
81cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)  extension_registry_observer_.Add(
82cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)      extensions::ExtensionRegistry::Get(profile_));
8346d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)  // Wait for extensions to be ready before running
8446d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)  // UpdateShortcutsForAllAppsIfNeeded.
85cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)  extensions::ExtensionSystem::Get(profile)->ready().Post(
86cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)      FROM_HERE,
8746d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)      base::Bind(&AppShortcutManager::UpdateShortcutsForAllAppsIfNeeded,
88cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)                 weak_ptr_factory_.GetWeakPtr()));
89eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch
90eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch  ProfileManager* profile_manager = g_browser_process->profile_manager();
91eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch  // profile_manager might be NULL in testing environments.
92eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch  if (profile_manager) {
93eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch    profile_manager->GetProfileInfoCache().AddObserver(this);
94eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch    is_profile_info_cache_observer_ = true;
95eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch  }
962a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)}
972a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)
98558790d6acca3451cf3a6b497803a5f07d0bec58Ben MurdochAppShortcutManager::~AppShortcutManager() {
99eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch  if (g_browser_process && is_profile_info_cache_observer_) {
100eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch    ProfileManager* profile_manager = g_browser_process->profile_manager();
101eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch    // profile_manager might be NULL in testing environments or during shutdown.
102eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch    if (profile_manager)
103eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch      profile_manager->GetProfileInfoCache().RemoveObserver(this);
104eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch  }
105eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch}
1062a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)
107cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)void AppShortcutManager::OnExtensionWillBeInstalled(
108cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)    content::BrowserContext* browser_context,
109cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)    const Extension* extension,
110cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)    bool is_update,
111cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)    bool from_ephemeral,
112cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)    const std::string& old_name) {
113cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)  if (!extension->is_app())
114cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)    return;
115cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)
116cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)  // If the app is being updated, update any existing shortcuts but do not
117cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)  // create new ones. If it is being installed, automatically create a
118cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)  // shortcut in the applications menu (e.g., Start Menu).
119cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)  if (is_update && !from_ephemeral) {
120cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)    web_app::UpdateAllShortcuts(
121cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)        base::UTF8ToUTF16(old_name), profile_, extension);
12246d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)  } else {
123cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)    CreateShortcutsInApplicationsMenu(profile_, extension);
1242a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  }
1252a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)}
1262a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)
127cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)void AppShortcutManager::OnExtensionUninstalled(
128cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)    content::BrowserContext* browser_context,
129cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)    const Extension* extension) {
130cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)  web_app::DeleteAllShortcuts(profile_, extension);
131cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)}
132cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)
133558790d6acca3451cf3a6b497803a5f07d0bec58Ben Murdochvoid AppShortcutManager::OnProfileWillBeRemoved(
134eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch    const base::FilePath& profile_path) {
135eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch  if (profile_path != profile_->GetPath())
136eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch    return;
137eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch  content::BrowserThread::PostTask(
138eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch      content::BrowserThread::FILE, FROM_HERE,
139eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch      base::Bind(&web_app::internals::DeleteAllShortcutsForProfile,
140eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch                 profile_path));
141eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch}
142eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch
14346d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)void AppShortcutManager::UpdateShortcutsForAllAppsIfNeeded() {
14446d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)  int last_version = prefs_->GetInteger(prefs::kAppShortcutsVersion);
14546d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)  if (last_version >= kCurrentAppShortcutsVersion)
146eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch    return;
147eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch
14846d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)  content::BrowserThread::PostDelayedTask(
14946d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)      content::BrowserThread::UI,
15046d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)      FROM_HERE,
15146d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)      base::Bind(&web_app::UpdateShortcutsForAllApps,
15246d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)                 profile_,
15346d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)                 base::Bind(&SetCurrentAppShortcutsVersion, prefs_)),
15446d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)      base::TimeDelta::FromSeconds(kUpdateShortcutsForAllAppsDelay));
155eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch}
156