Refactoring installer shortcut deletion; adding dedicated shortcut update feature.

chrome/installer/util/shell_util.h

 // 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.
 //
 // This file declares methods that are useful for integrating Chrome in
 // Windows shell. These methods are all static and currently part of
 // ShellUtil class.
 
 #ifndef CHROME_INSTALLER_UTIL_SHELL_UTIL_H_
 #define CHROME_INSTALLER_UTIL_SHELL_UTIL_H_
 
 #include <windows.h>
 
 #include <map>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/files/file_path.h"
 #include "base/logging.h"
 #include "base/string16.h"
 #include "chrome/installer/util/work_item_list.h"
 
 class BrowserDistribution;
 
+namespace base {
+  namespace win {
+    struct ShortcutProperties;
+  }  // namespace win
+}  // namespace base
+
 // This is a utility class that provides common shell integration methods
 // that can be used by installer as well as Chrome.
 class ShellUtil {
  public:
   // Input to any methods that make changes to OS shell.
   enum ShellChange {
     CURRENT_USER = 0x1,  // Make any shell changes only at the user level
     SYSTEM_LEVEL = 0x2   // Make any shell changes only at the system level
   };
 
   // Chrome's default handler state for a given protocol.
   enum DefaultState {
     UNKNOWN_DEFAULT,
     NOT_DEFAULT,
     IS_DEFAULT,
   };
 
   // Typical shortcut directories. Resolved in GetShortcutPath().
+  // Also used in ShortcutLocationIsSupported().
   enum ShortcutLocation {
     SHORTCUT_LOCATION_DESKTOP,
     SHORTCUT_LOCATION_QUICK_LAUNCH,
     SHORTCUT_LOCATION_START_MENU,
+    SHORTCUT_LOCATION_TASKBAR_PINS,  // base::win::VERSION_WIN7 +
+    SHORTCUT_LOCATION_APP_SHORTCUTS, // base::win::VERSION_WIN8 +
   };
 
   enum ShortcutOperation {
     // Create a new shortcut (overwriting if necessary).
     SHELL_SHORTCUT_CREATE_ALWAYS,
     // Create the per-user shortcut only if its system-level equivalent (with
     // the same name) is not present.
     SHELL_SHORTCUT_CREATE_IF_NO_SYSTEM_LEVEL,
     // Overwrite an existing shortcut (fail if the shortcut doesn't exist).
     // If the arguments are not specified on the new shortcut, keep the old
@@ skipping 230 matching lines @@
   // Registry value name for the OpenWithProgids entry for file associations.
   static const wchar_t* kRegOpenWithProgids;
 
   // Returns true if |chrome_exe| is registered in HKLM with |suffix|.
   // Note: This only checks one deterministic key in HKLM for |chrome_exe| and
   // doesn't otherwise validate a full Chrome install in HKLM.
   static bool QuickIsChromeRegisteredInHKLM(BrowserDistribution* dist,
                                             const string16& chrome_exe,
                                             const string16& suffix);
 
+  // Returns true if the current Windows version supports the presence of
+  // shortcuts at |location|.
+  static bool ShortcutLocationIsSupported(ShellUtil::ShortcutLocation location);
+
   // Sets |path| to the path for a shortcut at the |location| desired for the
   // given |level| (CURRENT_USER for per-user path and SYSTEM_LEVEL for
   // all-users path).
   // Returns false on failure.
   static bool GetShortcutPath(ShellUtil::ShortcutLocation location,
                               BrowserDistribution* dist,
                               ShellChange level,
                               base::FilePath* path);
 
   // Updates shortcut in |location| (or creates it if |options| specify
   // SHELL_SHORTCUT_CREATE_ALWAYS).
   // |dist| gives the type of browser distribution currently in use.
   // |properties| and |operation| affect this method as described on their
   // invidividual definitions above.
+  // |location| may be one of SHORTCUT_LOCATION_DESKTOP,
+  // SHORTCUT_LOCATION_QUICK_LAUNCH, or SHORTCUT_LOCATION_START_MENU.
   static bool CreateOrUpdateShortcut(
       ShellUtil::ShortcutLocation location,
       BrowserDistribution* dist,
       const ShellUtil::ShortcutProperties& properties,
       ShellUtil::ShortcutOperation operation);
 
   // Returns the string "|icon_path|,|icon_index|" (see, for example,
   // http://msdn.microsoft.com/library/windows/desktop/dd391573.aspx).
   static string16 FormatIconLocation(const string16& icon_path, int icon_index);
 
@@ skipping 170 matching lines @@
   // |protocol| The protocol to register as being capable of handling.s
   // |elevate_if_not_admin| if true will make this method try alternate methods
   // as described above.
   static bool RegisterChromeForProtocol(BrowserDistribution* dist,
                                         const string16& chrome_exe,
                                         const string16& unique_suffix,
                                         const string16& protocol,
                                         bool elevate_if_not_admin);
 
   // Removes installed shortcut(s) at |location|.
+  // |level|: CURRENT_USER to remove per-user shortcuts, or SYSTEM_LEVEL to
+  // remove all-users shortcuts.
   // |target_exe|: Shortcut target exe; shortcuts will only be deleted when
   // their target is |target_exe|.
-  // |level|: CURRENT_USER to remove the per-user shortcut and SYSTEM_LEVEL to
-  // remove the all-users shortcut.
-  // |shortcut_name|: If non-null, remove the shortcut named |shortcut_name| at
-  // location; otherwise remove all shortcuts to |target_exe| at |location|.
   // If |location| is SHORTCUT_LOCATION_START_MENU, the shortcut folder specific
   // to |dist| is deleted.
   // Also attempts to unpin the removed shortcut(s) from the taskbar.

[gab, 2013/05/02 19:20:50]

This part is no longer true.

[huangs, 2013/05/02 20:48:02]

Deleted.

-  // Returns true if the shortcut(s) were successfully deleted (or there were
-  // none at |location| pointing to |target_exe|).
-  static bool RemoveShortcut(ShellUtil::ShortcutLocation location,
-                             BrowserDistribution* dist,
-                             const base::FilePath& target_exe,
-                             ShellChange level,
-                             const string16* shortcut_name);
+  // Returns true if all shortcuts are successfully deleted, including the
+  // vacuous case no shortcuts are found.

[gab, 2013/05/02 19:20:50]

// Returns true if all shortcuts pointing to |target_exe| are successfully
deleted, including the case where no such shortcuts are found.

[huangs, 2013/05/02 20:48:02]

Done.

+  static bool RemoveShortcuts(ShellUtil::ShortcutLocation location,
+                              BrowserDistribution* dist,
+                              ShellChange level,
+                              const base::FilePath& target_exe);
 
-  // Enumerates all shortcuts pinned to the taskbar and deletes those pointing
-  // to |target_exe|.
-  // base::win::TaskbarUnpinShortcutLink() should be prefered, but this is
-  // useful on uninstall as the parent shortcut of a pin might no longer exist
-  // (thus making it impossible to unpin it via that API).
-  static void RemoveTaskbarShortcuts(const string16& target_exe);
-
-  // This will remove all secondary tiles from the start screen for |dist|.
-  static void RemoveStartScreenShortcuts(BrowserDistribution* dist,
-                                         const string16& target_exe);
+  // Iterates over all shortcuts at |location| that targets |target_exe|,
+  // and applies update via |shortcut_properties|.
+  // Returns true if all shortcuts are successfully updated, including the
+  // vacuous case no shortcuts are found.

[gab, 2013/05/02 19:20:50]

I'd suggest:
// Returns true if all shortcuts pointing to |target_exe| are successfully
updated, including the case where no such shortcuts are found.

[huangs, 2013/05/02 20:48:02]

Done.

+  static bool UpdateShortcuts(
+      ShellUtil::ShortcutLocation location,
+      BrowserDistribution* dist,
+      ShellChange level,
+      const base::FilePath& target_exe,
+      const base::win::ShortcutProperties& shortcut_properties);

[gab, 2013/05/02 19:20:50]

Use a ShellUtil::ShortcutProperties and use TranslateShortcutProperties()
internally to map it to a base::win::ShortcutProperties.

This avoids letting the caller take care of details like the working_directory.

[huangs, 2013/05/02 20:48:02]

Done.  Doing translation only once in UpdateShortcuts(), since it would be silly
for ShortcutOpUpdate() to do it repeatedly.

[gab, 2013/05/02 21:23:59]

Indeed :)!

 
   // Sets |suffix| to the base 32 encoding of the md5 hash of this user's sid
   // preceded by a dot.
   // This is guaranteed to be unique on the machine and 27 characters long
   // (including the '.').
   // This suffix is then meant to be added to all registration that may conflict
   // with another user-level Chrome install.
   // Note that prior to Chrome 21, the suffix registered used to be the user's
   // username (see GetOldUserSpecificRegistrySuffix() below). We still honor old
   // installs registered that way, but it was wrong because some of the
@@ skipping 17 matching lines @@
   // required by the base32 standard for inputs that aren't a multiple of 5
   // bytes.
   static string16 ByteArrayToBase32(const uint8* bytes, size_t size);
 
  private:
   DISALLOW_COPY_AND_ASSIGN(ShellUtil);
 };
 
 
 #endif  // CHROME_INSTALLER_UTIL_SHELL_UTIL_H_