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_
@@ skipping 26 matching lines @@
     UNKNOWN_DEFAULT,
     NOT_DEFAULT,
     IS_DEFAULT,
   };
 
   // Typical shortcut directories. Resolved in GetShortcutPath().
   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 434 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|.
-  // |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|.
+  // |target_path|: Shortcut target exe; shortcuts will only be deleted when
+  // their target is |target_path|.
+  // |name_filter|: Wildcard filter to specify specific shortcut file(s),
+  // with optional ".lnk" suffix.
   // 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.
   // Returns true if the shortcut(s) were successfully deleted (or there were
-  // none at |location| pointing to |target_exe|).
+  // none at |location| pointing to |target_path|).
+  static bool RemoveShortcutWithName(ShellUtil::ShortcutLocation location,

[gab, 2013/04/29 19:06:36]

I think that (once a comment above is adressed), there will be no remaning users
of this call and we can thus remove it and unconditionally use *.lnk :).

[huangs, 2013/04/30 03:04:16]

Done.

+                                     BrowserDistribution* dist,
+                                     ShellChange level,
+                                     const base::FilePath& target_path,
+                                     const string16& name_filter);
+
+  // Adaptor for RemoveShortcutWithName() with unconstrained |name_filter|.
   static bool RemoveShortcut(ShellUtil::ShortcutLocation location,
                              BrowserDistribution* dist,
-                             const base::FilePath& target_exe,
                              ShellChange level,
-                             const string16* shortcut_name);
+                             const base::FilePath& target_path);

[gab, 2013/04/29 19:06:36]

Please keep this named |target_exe|, variables ending in _path often refer to
directories rather than files from experience.

[huangs, 2013/04/30 03:04:16]

I wanted to distinguish string16 from FilePath (and called directories
*_folder). Changed.

Since gloves are coming off w.r.t. callers, fixed callers to pass base::FilePath
instead, for uniformity.

 
   // 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);
 
+  // Traverses through installed shortcut(s) in a similar manner as
+  // RemoveShortcut(). For each matched shortcut to |old_target_path|,
+  // update the shortcut so that it points to |new_target_path|.
+  static bool MigrateShortcut(ShellUtil::ShortcutLocation location,
+                              BrowserDistribution* dist,
+                              ShellChange level,
+                              const base::FilePath& old_target_path,
+                              const base::FilePath& new_target_path);
+
+  // Similar to RemoveTaskbarShortcuts(), but performs migration.
+  static void MigrateTaskbarShortcuts(const string16& old_target_exe,
+                                      const string16& new_target_exe);
+
+  // Similar to RemoveStartScreenShortcuts(), but performs migration.
+  static void MigrateStartScreenShortcuts(BrowserDistribution* dist,
+                                          const string16& old_target_exe,
+                                          const string16& new_target_exe);
+
   // 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
   // characters allowed in a username are not allowed in a ProgId.
@@ skipping 16 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_