Implementing unified Chrome / App Launcher flow, and migrating old stand-alone App Launcher.

chrome/installer/setup/install.cc

 // 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/installer/setup/install.h"
 
 #include <windows.h>
 #include <shlobj.h>
 #include <time.h>
 
@@ skipping 11 matching lines @@
 #include "base/utf_string_conversions.h"
 #include "base/win/shortcut.h"
 #include "base/win/windows_version.h"
 #include "chrome/common/chrome_constants.h"
 #include "chrome/common/chrome_switches.h"
 #include "chrome/installer/launcher_support/chrome_launcher_support.h"
 #include "chrome/installer/setup/install_worker.h"
 #include "chrome/installer/setup/setup_constants.h"
 #include "chrome/installer/util/auto_launch_util.h"
 #include "chrome/installer/util/browser_distribution.h"
+#include "chrome/installer/util/chrome_app_host_distribution.h"
 #include "chrome/installer/util/create_reg_key_work_item.h"
 #include "chrome/installer/util/delete_after_reboot_helper.h"
 #include "chrome/installer/util/google_update_constants.h"
 #include "chrome/installer/util/helper.h"
 #include "chrome/installer/util/install_util.h"
 #include "chrome/installer/util/master_preferences.h"
 #include "chrome/installer/util/master_preferences_constants.h"
 #include "chrome/installer/util/set_reg_value_work_item.h"
 #include "chrome/installer/util/shell_util.h"
 #include "chrome/installer/util/util_constants.h"
@@ skipping 30 matching lines @@
   switch (location) {
     case ShellUtil::SHORTCUT_LOCATION_DESKTOP:
       message.append("Desktop ");
       break;
     case ShellUtil::SHORTCUT_LOCATION_QUICK_LAUNCH:
       message.append("Quick Launch ");
       break;
     case ShellUtil::SHORTCUT_LOCATION_START_MENU:
       message.append("Start menu ");
       break;
+    case ShellUtil::SHORTCUT_LOCATION_START_MENU_ROOT:

[gab, 2013/05/15 22:42:20]

We will never create Chrome shortcuts at the root, please use paradigm from
https://codereview.chromium.org/13864015/

[huangs, 2013/05/17 20:59:24]

Removing.

+      message.append("Start menu root ");
+      break;
     default:
       NOTREACHED();
   }
 
   message.push_back('"');
   if (properties.has_shortcut_name())
     message.append(UTF16ToUTF8(properties.shortcut_name));
   else
     message.append(UTF16ToUTF8(dist->GetAppShortCutName()));
   message.push_back('"');
@@ skipping 148 matching lines @@
              << ", old version: " << (*current_version)->GetString();
 
   return installer::INSTALL_FAILED;
 }
 
 // Deletes the old "Uninstall Google Chrome" shortcut in the Start menu and, if
 // this is a system-level install, also deletes the old Default user Quick
 // Launch shortcut. Both of these were created prior to Chrome 24; in Chrome 24,
 // the uninstall shortcut was removed and the Default user Quick Launch shortcut
 // was replaced by per-user shortcuts created via Active Setup.
-void CleanupLegacyShortcuts(const InstallerState& installer_state,
-                            BrowserDistribution* dist,
-                            const base::FilePath& chrome_exe) {
+void CleanupLegacyChromeShortcuts(const InstallerState& installer_state,
+                                  BrowserDistribution* dist,
+                                  const base::FilePath& chrome_exe) {
   ShellUtil::ShellChange shortcut_level = installer_state.system_install() ?
       ShellUtil::SYSTEM_LEVEL : ShellUtil::CURRENT_USER;
   base::FilePath uninstall_shortcut_path;
   ShellUtil::GetShortcutPath(ShellUtil::SHORTCUT_LOCATION_START_MENU, dist,
                              shortcut_level, &uninstall_shortcut_path);
   uninstall_shortcut_path = uninstall_shortcut_path.Append(
       dist->GetUninstallLinkName() + installer::kLnkExt);
   file_util::Delete(uninstall_shortcut_path, false);
 
   if (installer_state.system_install()) {
     ShellUtil::RemoveShortcuts(
         ShellUtil::SHORTCUT_LOCATION_QUICK_LAUNCH, dist,
         ShellUtil::SYSTEM_LEVEL, chrome_exe);
   }
 }
 
 // Returns the appropriate shortcut operations for App Launcher,
 // based on state of installation and master_preferences.
 installer::InstallShortcutOperation GetAppLauncherShortcutOperation(
     const InstallationState& original_state,
     const InstallerState& installer_state) {
   const installer::ProductState* original_app_host_state =
       original_state.GetProductState(installer_state.system_install(),
                                      BrowserDistribution::CHROME_APP_HOST);
+  if (installer_state.need_to_migrate_legacy_app_launcher() ||
+      installer_state.create_app_launcher_shortcuts())
+    return installer::INSTALL_SHORTCUT_CREATE_ALL;

[gab, 2013/05/15 22:42:20]

nit: wrap in {}

[huangs, 2013/05/17 20:59:24]

Done.

+
   bool app_launcher_exists = original_app_host_state &&
       original_app_host_state->uninstall_command()
           .HasSwitch(installer::switches::kChromeAppLauncher);
   if (!app_launcher_exists)
     return installer::INSTALL_SHORTCUT_CREATE_ALL;
 
   return installer::INSTALL_SHORTCUT_REPLACE_EXISTING;
 }
 
+// As of M29, App Launcher is unified with Chrome. app_host.exe is deleted, and
+// all shortcuts that target app_host.exe must now target chrome.exe.
+// Shortcuts to the App Launcher also require icons update.
+void MigrateLegacyAppLauncherShortcuts(const InstallerState& installer_state) {
+  LegacyChromeAppHostDistribution legacy_dist;
+  BrowserDistribution* dist = BrowserDistribution::GetSpecificDistribution(
+      BrowserDistribution::CHROME_APP_HOST);
+  base::FilePath app_host_exe(
+      installer_state.target_path().Append(installer::kChromeAppHostExe));
+  base::FilePath chrome_exe(
+      installer_state.target_path().Append(installer::kChromeExe));
+
+  // Remove deprecated start menu folder "Google Chrome App Launcher".
+  ShellUtil::RemoveShortcuts(
+      ShellUtil::SHORTCUT_LOCATION_START_MENU, &legacy_dist,
+      ShellUtil::CURRENT_USER, app_host_exe);
+
+  VLOG(1) << "Migrating legacy App Launcher shortcuts.";
+  ShellUtil::ShortcutLocation update_location_list[] = {
+    ShellUtil::SHORTCUT_LOCATION_DESKTOP,
+    ShellUtil::SHORTCUT_LOCATION_QUICK_LAUNCH,
+    ShellUtil::SHORTCUT_LOCATION_START_MENU_ROOT,
+    ShellUtil::SHORTCUT_LOCATION_TASKBAR_PINS,
+    ShellUtil::SHORTCUT_LOCATION_APP_SHORTCUTS
+  };
+
+  // Using wild card in case duplicate shortcuts exist.
+  string16 name_filter_main(dist->GetAppShortCutName() + L"*" +
+                            installer::kLnkExt);
+
+  ShellUtil::ShortcutProperties updated_properties_app_host_exe(
+      installer_state.system_install() ? ShellUtil::SYSTEM_LEVEL :
+          ShellUtil::CURRENT_USER);
+  updated_properties_app_host_exe.set_target(chrome_exe);
+  updated_properties_app_host_exe.set_icon(
+      installer_state.target_path().Append(dist->GetIconFilename()),
+      dist->GetIconIndex());
+
+  ShellUtil::ShortcutProperties updated_properties_user_generated(
+      installer_state.system_install() ? ShellUtil::SYSTEM_LEVEL :
+          ShellUtil::CURRENT_USER);
+  updated_properties_user_generated.set_target(chrome_exe);
+
+  for (int i = 0; i < arraysize(update_location_list); ++i) {
+    // Migrate App Launcher shortcuts (executable and icon changes).
+    ShellUtil::UpdateShortcutsFilteredByName(
+        update_location_list[i], dist, ShellUtil::CURRENT_USER,
+        name_filter_main, app_host_exe, updated_properties_app_host_exe);
+    // Migrate user-generated shortcuts (executable changes only).
+    ShellUtil::UpdateShortcuts(
+        update_location_list[i], dist, ShellUtil::CURRENT_USER,
+        app_host_exe, updated_properties_user_generated);
+  }
+}
+
 }  // end namespace
 
 namespace installer {
 
 void EscapeXmlAttributeValueInSingleQuotes(string16* att_value) {
   ReplaceChars(*att_value, L"&", L"&amp;", att_value);
   ReplaceChars(*att_value, L"'", L"&apos;", att_value);
   ReplaceChars(*att_value, L"<", L"&lt;", att_value);
 }
 
@@ skipping 229 matching lines @@
     // installed and for the binaries in case of multi-install.
     installer_state.UpdateChannels();
 
     installer_state.UpdateStage(installer::COPYING_PREFERENCES_FILE);
 
     if (result == FIRST_INSTALL_SUCCESS && !prefs_path.empty())
       CopyPreferenceFileForFirstRun(installer_state, prefs_path);
 
     installer_state.UpdateStage(installer::CREATING_SHORTCUTS);
 
+    InstallShortcutLevel install_level = installer_state.system_install() ?
+        ALL_USERS : CURRENT_USER;
+    const base::FilePath chrome_exe(
+        installer_state.target_path().Append(kChromeExe));
+
     const Product* app_launcher_product =
         installer_state.FindProduct(BrowserDistribution::CHROME_APP_HOST);
     // Creates shortcuts for App Launcher.
     if (app_launcher_product) {
-      // TODO(huangs): Remove this check once we have system-level App Host.
-      DCHECK(!installer_state.system_install());
-      const base::FilePath app_host_exe(
-          installer_state.target_path().Append(kChromeAppHostExe));
-      InstallShortcutOperation app_launcher_shortcut_operation =
-          GetAppLauncherShortcutOperation(original_state, installer_state);
-
-      // Always install per-user shortcuts for App Launcher.
-      CreateOrUpdateShortcuts(app_host_exe, *app_launcher_product, prefs,
-                              CURRENT_USER, app_launcher_shortcut_operation);
+      if (installer_state.need_to_migrate_legacy_app_launcher()) {
+        MigrateLegacyAppLauncherShortcuts(installer_state);

[grt (UTC plus 2), 2013/05/16 14:55:52]

Are legacy shortcuts only per-user shortcuts?

[huangs, 2013/05/17 20:59:24]

Yes for the installer, I think so, also for user-created ones.  I made a mistake
in changing the code following (see comments).

+      }
+      if (installer_state.create_app_launcher_shortcuts()) {
+        InstallShortcutOperation app_launcher_shortcut_operation =
+            GetAppLauncherShortcutOperation(original_state, installer_state);
+        CreateOrUpdateShortcuts(chrome_exe, *app_launcher_product, prefs,
+                                install_level, app_launcher_shortcut_operation);

[gab, 2013/05/15 22:42:20]

I would prefer that we keep installing App Launcher shortcut at user-level only
(i.e. one shortcut per location for each user) and use Active Setup instead to
make sure every user gets them (that also takes care of the fact that global
quick launch and taskbar shortcuts don't exist).

Global shortcuts suck, and the only reason they are still used by Chrome (I
tried to get rid of them --
https://docs.google.com/a/google.com/document/d/1FjFbmKVj0BIP7xBXMs4lLgQcrc--...)
is that we can't port old installs that have them (see http://crbug.com/164655
for details).

[huangs, 2013/05/17 20:59:24]

"per-user shortcuts" doesn't mean what I thought it means.

Changing back to CURRENT_USER.

+      }
     }
 
     const Product* chrome_product =
         installer_state.FindProduct(BrowserDistribution::CHROME_BROWSER);
     // Creates shortcuts for Chrome.
     if (chrome_product) {
       BrowserDistribution* chrome_dist = chrome_product->distribution();
-      const base::FilePath chrome_exe(
-          installer_state.target_path().Append(kChromeExe));
-      CleanupLegacyShortcuts(installer_state, chrome_dist, chrome_exe);
+      CleanupLegacyChromeShortcuts(installer_state, chrome_dist, chrome_exe);
 
       // Install per-user shortcuts on user-level installs and all-users
       // shortcuts on system-level installs. Note that Active Setup will take
       // care of installing missing per-user shortcuts on system-level install
       // (i.e., quick launch, taskbar pin, and possibly deleted all-users
       // shortcuts).
-      InstallShortcutLevel install_level = installer_state.system_install() ?
-          ALL_USERS : CURRENT_USER;
-
       InstallShortcutOperation install_operation =
           INSTALL_SHORTCUT_REPLACE_EXISTING;
       if (result == installer::FIRST_INSTALL_SUCCESS ||
           result == installer::INSTALL_REPAIRED ||
           !original_state.GetProductState(installer_state.system_install(),
                                           chrome_dist->GetType())) {
         // Always create the shortcuts on a new install, a repair install, and
         // when the Chrome product is being added to the current install.
         install_operation = INSTALL_SHORTCUT_CREATE_ALL;
       }
@@ skipping 99 matching lines @@
            INSTALL_SHORTCUT_REPLACE_EXISTING :
            INSTALL_SHORTCUT_CREATE_EACH_IF_NO_SYSTEM_LEVEL);
 
   // Read master_preferences copied beside chrome.exe at install.
   MasterPreferences prefs(installation_root.AppendASCII(kDefaultMasterPrefs));
   base::FilePath chrome_exe(installation_root.Append(kChromeExe));
   CreateOrUpdateShortcuts(
       chrome_exe, chrome, prefs, CURRENT_USER, install_operation);
 }
 
 bool InstallFromWebstore(const std::string& app_code) {

[gab, 2013/05/15 22:42:20]

I can't find any callers of this in codesearch... why is this in the installer?

[grt (UTC plus 2), 2013/05/16 14:55:52]

It's called by setup_main.cc, which may not be indexed property for codesearch
due to its Win-only nature.

[huangs, 2013/05/17 20:59:24]

No-op.

[huangs, 2013/05/17 20:59:24]

No-op.

-  base::FilePath app_host_path(chrome_launcher_support::GetAnyAppHostPath());
-  if (app_host_path.empty())
+  base::FilePath chrome_path(chrome_launcher_support::GetAnyChromePath());
+  if (chrome_path.empty())
     return false;
 
-  CommandLine cmd(app_host_path);
+  CommandLine cmd(chrome_path);
   cmd.AppendSwitchASCII(::switches::kInstallFromWebstore, app_code);
   VLOG(1) << "App install command: " << cmd.GetCommandLineString();
   return base::LaunchProcess(cmd, base::LaunchOptions(), NULL);
 }
 
 }  // namespace installer