Windows: When an app is updated and its name changes, recreate shortcuts.

chrome/browser/web_applications/web_app_win.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/browser/web_applications/web_app.h"
 
 #include <shlobj.h>
 
 #include "base/command_line.h"
 #include "base/file_util.h"
@@ skipping 111 matching lines @@
           base::StringPrintf(" (%d)", i));
     }
     if (file_util::PathExists(shortcut_file) &&
         ShortcutIsForProfile(shortcut_file, profile_path)) {
       shortcut_paths.push_back(shortcut_file);
     }
   }
   return shortcut_paths;
 }
 
-}  // namespace
-
-namespace web_app {
-
-namespace internals {
-
-// Saves |image| to |icon_file| if the file is outdated and refresh shell's
-// icon cache to ensure correct icon is displayed. Returns true if icon_file
-// is up to date or successfully updated.
-bool CheckAndSaveIcon(const base::FilePath& icon_file,
-                      const gfx::ImageFamily& image) {
-  if (ShouldUpdateIcon(icon_file, image)) {
-    if (SaveIconWithCheckSum(icon_file, image)) {
-      // Refresh shell's icon cache. This call is quite disruptive as user would
-      // see explorer rebuilding the icon cache. It would be great that we find
-      // a better way to achieve this.
-      SHChangeNotify(SHCNE_ASSOCCHANGED, SHCNF_IDLIST | SHCNF_FLUSHNOWAIT,
-                     NULL, NULL);
-    } else {
-      return false;
-    }
-  }
-
-  return true;
-}
-
-bool CreatePlatformShortcuts(
+// Creates application shortcuts in a given set of paths.
+// |shortcut_paths| is a list of directories in which shortcuts should be
+// created. If |pin_to_taskbar| is true, also pins a shortcut to the taskbar.

[koz (OOO until 15th September), 2013/05/17 01:36:19]

There is no |pin_to_taskbar| here.

[Matt Giuca, 2013/05/20 01:02:46]

Thanks, good catch. That comment was from an older iteration of this CL.

+// Returns true on success, false on failure.
+// Must be called on the FILE thread.
+bool CreateShortcutsInPaths(
     const base::FilePath& web_app_path,
     const ShellIntegration::ShortcutInfo& shortcut_info,
-    const ShellIntegration::ShortcutLocations& creation_locations) {
-  DCHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::FILE));
-
-  // Shortcut paths under which to create shortcuts.
-  std::vector<base::FilePath> shortcut_paths =
-      GetShortcutPaths(creation_locations);
-
-  bool pin_to_taskbar = creation_locations.in_quick_launch_bar &&
-                        (base::win::GetVersion() >= base::win::VERSION_WIN7);
-
-  // Create/update the shortcut in the web app path for the "Pin To Taskbar"
-  // option in Win7. We use the web app path shortcut because we will overwrite
-  // it rather than appending unique numbers if the shortcut already exists.
-  // This prevents pinned apps from having unique numbers in their names.
-  if (pin_to_taskbar)
-    shortcut_paths.push_back(web_app_path);
-
-  if (shortcut_paths.empty())
-    return false;
-
+    const std::vector<base::FilePath>& shortcut_paths) {
   // Ensure web_app_path exists.
   if (!file_util::PathExists(web_app_path) &&
       !file_util::CreateDirectory(web_app_path)) {
     return false;
   }
 
   // Generates file name to use with persisted ico and shortcut file.
   base::FilePath file_name =
       web_app::internals::GetSanitizedFileName(shortcut_info.title);
 
@@ skipping 59 matching lines @@
     if (!file_util::PathExists(shortcut_file.DirName()) &&
         !file_util::CreateDirectory(shortcut_file.DirName())) {
       NOTREACHED();
       return false;
     }
     success = base::win::CreateOrUpdateShortcutLink(
         shortcut_file, shortcut_properties,
         base::win::SHORTCUT_CREATE_ALWAYS) && success;
   }
 
-  if (success && pin_to_taskbar) {
-    // Use the web app path shortcut for pinning to avoid having unique numbers
-    // in the application name.
-    base::FilePath shortcut_to_pin = web_app_path.Append(file_name).
-        AddExtension(installer::kLnkExt);
-    success = base::win::TaskbarPinShortcutLink(
-        shortcut_to_pin.value().c_str()) && success;
-  }
-
   return success;
 }
 
+// Deletes all shortcuts for an app, recording the paths at they were found.

[koz (OOO until 15th September), 2013/05/17 01:36:19]

"the paths at they were found" -> "the paths they were found at"

[Matt Giuca, 2013/05/20 01:02:46]

Done.

+// This will search for shortcuts named |title| (not necessarily the title found
+// in |shortcut_info|).

[koz (OOO until 15th September), 2013/05/17 01:36:19]

Could you elaborate slightly on why |title| isn't necessarily the title found in
|shortcut_info|?

[Matt Giuca, 2013/05/20 01:02:46]

Done.

+// |shortcut_paths| will be populated with a list of directories where shortcuts
+// for this app were found (and deleted). It may be NULL.
+void DeleteAndRememberShortcuts(
+    const base::FilePath& web_app_path,
+    const ShellIntegration::ShortcutInfo& shortcut_info,
+    const string16& title,
+    bool unpin_from_taskbar,
+    std::vector<base::FilePath>* shortcut_paths) {
+  DCHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::FILE));
+
+  // Get all possible locations for shortcuts.
+  ShellIntegration::ShortcutLocations all_shortcut_locations;
+  all_shortcut_locations.in_applications_menu = true;
+  all_shortcut_locations.in_quick_launch_bar = true;
+  all_shortcut_locations.on_desktop = true;
+  // Delete shortcuts from the Chrome Apps subdirectory.
+  // This matches the subdir name set by CreateApplicationShortcutView::Accept
+  // for Chrome apps (not URL apps, but this function does not apply for them).
+  all_shortcut_locations.applications_menu_subdir =
+      web_app::GetAppShortcutsSubdirName();
+  std::vector<base::FilePath> all_paths = web_app::internals::GetShortcutPaths(
+      all_shortcut_locations);
+  if (base::win::GetVersion() >= base::win::VERSION_WIN7)
+    all_paths.push_back(web_app_path);
+
+  for (std::vector<base::FilePath>::const_iterator i = all_paths.begin();
+       i != all_paths.end(); ++i) {
+    std::vector<base::FilePath> shortcut_files =
+        MatchingShortcutsForProfileAndExtension(*i, shortcut_info.profile_path,
+            title);
+    if (shortcut_paths != NULL && !shortcut_files.empty()) {
+      shortcut_paths->push_back(*i);
+    }
+    for (std::vector<base::FilePath>::const_iterator j = shortcut_files.begin();
+         j != shortcut_files.end(); ++j) {
+      // Any shortcut could have been pinned, either by chrome or the user, so
+      // they are all unpinned.
+      if (unpin_from_taskbar)
+        base::win::TaskbarUnpinShortcutLink(j->value().c_str());
+      file_util::Delete(*j, false);
+    }
+  }
+}
+
+}  // namespace
+
+namespace web_app {
+
+namespace internals {
+
+// Saves |image| to |icon_file| if the file is outdated and refresh shell's
+// icon cache to ensure correct icon is displayed. Returns true if icon_file
+// is up to date or successfully updated.
+bool CheckAndSaveIcon(const base::FilePath& icon_file,
+                      const gfx::ImageFamily& image) {
+  if (ShouldUpdateIcon(icon_file, image)) {
+    if (SaveIconWithCheckSum(icon_file, image)) {
+      // Refresh shell's icon cache. This call is quite disruptive as user would
+      // see explorer rebuilding the icon cache. It would be great that we find
+      // a better way to achieve this.
+      SHChangeNotify(SHCNE_ASSOCCHANGED, SHCNF_IDLIST | SHCNF_FLUSHNOWAIT,
+                     NULL, NULL);
+    } else {
+      return false;
+    }
+  }
+
+  return true;
+}
+
+bool CreatePlatformShortcuts(
+    const base::FilePath& web_app_path,
+    const ShellIntegration::ShortcutInfo& shortcut_info,
+    const ShellIntegration::ShortcutLocations& creation_locations) {
+  DCHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::FILE));
+
+  // Shortcut paths under which to create shortcuts.
+  std::vector<base::FilePath> shortcut_paths =
+      GetShortcutPaths(creation_locations);
+
+  bool pin_to_taskbar = creation_locations.in_quick_launch_bar &&
+                        (base::win::GetVersion() >= base::win::VERSION_WIN7);
+
+  // Create/update the shortcut in the web app path for the "Pin To Taskbar"
+  // option in Win7. We use the web app path shortcut because we will overwrite
+  // it rather than appending unique numbers if the shortcut already exists.
+  // This prevents pinned apps from having unique numbers in their names.
+  if (pin_to_taskbar)
+    shortcut_paths.push_back(web_app_path);
+
+  if (shortcut_paths.empty())
+    return false;
+
+  if (!CreateShortcutsInPaths(web_app_path, shortcut_info, shortcut_paths))
+    return false;
+
+  if (pin_to_taskbar) {
+    base::FilePath file_name =
+        web_app::internals::GetSanitizedFileName(shortcut_info.title);
+    // Use the web app path shortcut for pinning to avoid having unique numbers
+    // in the application name.
+    base::FilePath shortcut_to_pin = web_app_path.Append(file_name).
+        AddExtension(installer::kLnkExt);
+    if (!base::win::TaskbarPinShortcutLink(shortcut_to_pin.value().c_str()))
+      return false;
+  }
+
+  return true;
+}
+
 void UpdatePlatformShortcuts(
     const base::FilePath& web_app_path,
+    const string16& old_app_title,
     const ShellIntegration::ShortcutInfo& shortcut_info) {
   DCHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::FILE));
 
   // Generates file name to use with persisted ico and shortcut file.
   base::FilePath file_name =
       web_app::internals::GetSanitizedFileName(shortcut_info.title);
 
+  if (old_app_title != shortcut_info.title) {
+    // The app's title has changed. Delete all existing app shortcuts and
+    // recreate them in any locations they already existed (but do not add them
+    // to locations where they do not currently exist).
+    std::vector<base::FilePath> shortcut_paths;
+    // Do not unpin shortcuts from the task bar. If a shortcut is pinned, it
+    // will not be renamed, but at least it will continue to work.

[Matt Giuca, 2013/05/16 06:40:23]

This is not ideal, but I want to leave it as-is for now, and I will file a
separate low-priority bug about it. The consequences of not fixing this are
simply that if the user right-clicks or tooltips the pinned shortcut, they will
see the old name. I don't consider this as important as the Start Menu shortcut,
where the text is shown directly to the user.

[Matt Giuca, 2013/05/20 01:02:46]

Actually, I think this is important to do now. If we don't do it now, we won't
be able to do it in the future, since we'll forget the old app name and will
never be able to clean up those shortcuts.

[Matt Giuca, 2013/05/23 02:36:24]

Done.

+    DeleteAndRememberShortcuts(web_app_path, shortcut_info, old_app_title,
+                               false, &shortcut_paths);
+    CreateShortcutsInPaths(web_app_path, shortcut_info, shortcut_paths);
+  }
+
   // If an icon file exists, and is out of date, replace it with the new icon
   // and let the shell know the icon has been modified.
   base::FilePath icon_file = web_app_path.Append(file_name).AddExtension(
       FILE_PATH_LITERAL(".ico"));
   if (file_util::PathExists(icon_file)) {
     web_app::internals::CheckAndSaveIcon(icon_file, shortcut_info.favicon);
   }
 }
 
 void DeletePlatformShortcuts(
     const base::FilePath& web_app_path,
     const ShellIntegration::ShortcutInfo& shortcut_info) {
-  DCHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::FILE));
-
-  // Get all possible locations for shortcuts.
-  ShellIntegration::ShortcutLocations all_shortcut_locations;
-  all_shortcut_locations.in_applications_menu = true;
-  all_shortcut_locations.in_quick_launch_bar = true;
-  all_shortcut_locations.on_desktop = true;
-  // Delete shortcuts from the Chrome Apps subdirectory.
-  // This matches the subdir name set by CreateApplicationShortcutView::Accept
-  // for Chrome apps (not URL apps, but this function does not apply for them).
-  string16 start_menu_subdir = GetAppShortcutsSubdirName();
-  all_shortcut_locations.applications_menu_subdir = start_menu_subdir;
-  std::vector<base::FilePath> shortcut_paths = GetShortcutPaths(
-      all_shortcut_locations);
-  if (base::win::GetVersion() >= base::win::VERSION_WIN7)
-    shortcut_paths.push_back(web_app_path);
-
-  for (std::vector<base::FilePath>::const_iterator i = shortcut_paths.begin();
-       i != shortcut_paths.end(); ++i) {
-    std::vector<base::FilePath> shortcut_files =
-        MatchingShortcutsForProfileAndExtension(*i, shortcut_info.profile_path,
-            shortcut_info.title);
-    for (std::vector<base::FilePath>::const_iterator j = shortcut_files.begin();
-         j != shortcut_files.end(); ++j) {
-      // Any shortcut could have been pinned, either by chrome or the user, so
-      // they are all unpinned.
-      base::win::TaskbarUnpinShortcutLink(j->value().c_str());
-      file_util::Delete(*j, false);
-    }
-  }
+  DeleteAndRememberShortcuts(web_app_path, shortcut_info, shortcut_info.title,
+                             true, NULL);
 
   // If there are no more shortcuts in the Chrome Apps subdirectory, remove it.
   base::FilePath chrome_apps_dir;
   if (PathService::Get(base::DIR_START_MENU, &chrome_apps_dir)) {
-    chrome_apps_dir = chrome_apps_dir.Append(start_menu_subdir);
+    chrome_apps_dir = chrome_apps_dir.Append(GetAppShortcutsSubdirName());
     if (file_util::IsDirectoryEmpty(chrome_apps_dir))
       file_util::Delete(chrome_apps_dir, false);
   }
 }
 
 std::vector<base::FilePath> GetShortcutPaths(
     const ShellIntegration::ShortcutLocations& creation_locations) {
   // Shortcut paths under which to create shortcuts.
   std::vector<base::FilePath> shortcut_paths;
   // Locations to add to shortcut_paths.
@@ skipping 38 matching lines @@
         path = path.Append(locations[i].subdir);
       shortcut_paths.push_back(path);
     }
   }
   return shortcut_paths;
 }
 
 }  // namespace internals
 
 }  // namespace web_app