Refactoring and tests for the highly undertested file_util::CreateOrUpdateShortcutLink() method.

chrome/installer/util/shell_util.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.
 //
 // This file defines functions that integrate Chrome in Windows shell. These
 // functions can be used by Chrome as well as Chrome installer. All of the
 // work is done by the local functions defined in anonymous namespace in
 // this class.
 
 #include "chrome/installer/util/shell_util.h"
@@ skipping 14 matching lines @@
 #include "base/memory/scoped_vector.h"
 #include "base/path_service.h"
 #include "base/string16.h"
 #include "base/string_number_conversions.h"
 #include "base/string_split.h"
 #include "base/string_util.h"
 #include "base/utf_string_conversions.h"
 #include "base/values.h"
 #include "base/win/registry.h"
 #include "base/win/scoped_comptr.h"
+#include "base/win/shortcut.h"
 #include "base/win/win_util.h"
 #include "base/win/windows_version.h"
 #include "chrome/common/chrome_constants.h"
 #include "chrome/common/chrome_switches.h"
 #include "chrome/installer/util/browser_distribution.h"
 #include "chrome/installer/util/install_util.h"
 #include "chrome/installer/util/master_preferences.h"
 #include "chrome/installer/util/master_preferences_constants.h"
 
 using base::win::RegKey;
@@ skipping 678 matching lines @@
 // Windows 8.
 bool LaunchApplicationAssociationDialog(const string16& app_id) {
   base::win::ScopedComPtr<IApplicationAssociationRegistrationUI> aarui;
   HRESULT hr = aarui.CreateInstance(CLSID_ApplicationAssociationRegistrationUI);
   if (FAILED(hr))
     return false;
   hr = aarui->LaunchAdvancedAssociationUI(app_id.c_str());
   return SUCCEEDED(hr);
 }
 
-uint32 ConvertShellUtilShortcutOptionsToFileUtil(uint32 options) {
-  uint32 converted_options = 0;
-  if (options & ShellUtil::SHORTCUT_DUAL_MODE)
-    converted_options |= file_util::SHORTCUT_DUAL_MODE;
-  if (options & ShellUtil::SHORTCUT_CREATE_ALWAYS)
-    converted_options |= file_util::SHORTCUT_CREATE_ALWAYS;
-  return converted_options;
-}
-
 // As of r133333, the DelegateExecute verb handler was being registered for
 // Google Chrome installs on Windows 8 even though the binary itself wasn't
 // present.  This affected Chrome 20.0.1115.1 on the dev channel (and anyone who
 // pulled a Canary >= 20.0.1112.0 and installed it manually as Google Chrome).
 // This egregious hack is here to remove the bad values for those installs, and
 // should be removed after a reasonable time, say 2012-08-01.  Anyone on Win8
 // dev channel who hasn't been autoupdated or manually updated by then will have
 // to uninstall and reinstall Chrome to repair.  See http://crbug.com/124666 and
 // http://crbug.com/123994 for gory details.
 // This function is also used to remove DelegateExecute verb handler
@@ skipping 913 matching lines @@
   const FilePath chrome_path(FilePath(chrome_exe).DirName());
 
   installer::MasterPreferences prefs(
       chrome_path.AppendASCII(installer::kDefaultMasterPrefs));
   if (FilePath::CompareEqualIgnoreCase(icon_path, chrome_exe)) {
     prefs.GetInt(installer::master_preferences::kChromeShortcutIconIndex,
                  &icon_index);
   }
 
   const string16 app_id(GetBrowserModelId(dist, chrome_exe));
+  const bool is_dual_mode = ((options & ShellUtil::SHORTCUT_DUAL_MODE) != 0);
+  const base::win::ShortcutOperation operation =
+      (options & ShellUtil::SHORTCUT_CREATE_ALWAYS) != 0 ?
+          base::win::SHORTCUT_CREATE_ALWAYS :
+          base::win::SHORTCUT_UPDATE_EXISTING;
 
-  return file_util::CreateOrUpdateShortcutLink(
-      chrome_exe.c_str(),
-      shortcut.c_str(),
-      chrome_path.value().c_str(),
-      arguments.c_str(),
-      description.c_str(),
-      icon_path.c_str(),
-      icon_index,
-      app_id.c_str(),
-      ConvertShellUtilShortcutOptionsToFileUtil(options));
-}
-
-ShellUtil::VerifyShortcutStatus ShellUtil::VerifyChromeShortcut(
-    const string16& exe_path, const string16& shortcut,
-    const string16& description, int icon_index) {
-  base::win::ScopedComPtr<IShellLink> i_shell_link;
-  base::win::ScopedComPtr<IPersistFile> i_persist_file;
-  wchar_t long_path[MAX_PATH] = {0};
-  wchar_t short_path[MAX_PATH] = {0};
-  wchar_t file_path[MAX_PATH] = {0};
-  wchar_t icon_path[MAX_PATH] = {0};
-  wchar_t desc[MAX_PATH] = {0};
-  int index = 0;
-
-  // Get the shortcut's properties.
-  if (FAILED(i_shell_link.CreateInstance(CLSID_ShellLink, NULL,
-                                         CLSCTX_INPROC_SERVER)) ||
-      FAILED(i_persist_file.QueryFrom(i_shell_link)) ||
-      FAILED(i_persist_file->Load(shortcut.c_str(), 0)) ||
-      ::GetLongPathName(exe_path.c_str(), long_path, MAX_PATH) == 0 ||
-      ::GetShortPathName(exe_path.c_str(), short_path, MAX_PATH) == 0 ||
-      FAILED(i_shell_link->GetPath(file_path, MAX_PATH, NULL,
-                                   SLGP_UNCPRIORITY)) ||
-      FAILED(i_shell_link->GetIconLocation(icon_path, MAX_PATH, &index)) ||
-      FAILED(i_shell_link->GetDescription(desc, MAX_PATH)) ||
-      FAILED(i_shell_link->GetDescription(desc, MAX_PATH)))
-    return VERIFY_SHORTCUT_FAILURE_UNEXPECTED;
-
-  FilePath path(file_path);
-  if (path != FilePath(long_path) && path != FilePath(short_path))
-    return VERIFY_SHORTCUT_FAILURE_PATH;
-
-  if (string16(desc) != string16(description))
-    return VERIFY_SHORTCUT_FAILURE_DESCRIPTION;
-
-  if (index != icon_index)
-    return VERIFY_SHORTCUT_FAILURE_ICON_INDEX;
-
-  return VERIFY_SHORTCUT_SUCCESS;
+  // TODO(gab): The shell_util interface will also be refactored in an upcoming
+  // CL to use a ShortcutProperties like interface for its shortcut methods.
+  base::win::ShortcutProperties shortcut_properties;
+  shortcut_properties.set_target(FilePath(chrome_exe));
+  shortcut_properties.set_working_dir(chrome_path);
+  shortcut_properties.set_arguments(arguments);
+  shortcut_properties.set_description(description);
+  shortcut_properties.set_icon(FilePath(icon_path), icon_index);
+  shortcut_properties.set_app_id(app_id);
+  shortcut_properties.set_dual_mode(is_dual_mode);
+  return base::win::CreateOrUpdateShortcutLink(
+      FilePath(shortcut), shortcut_properties, operation);
 }
 
 bool ShellUtil::GetUserSpecificRegistrySuffix(string16* suffix) {
   // Use a thread-safe cache for the user's suffix.
   static base::LazyInstance<UserSpecificRegistrySuffix>::Leaky suffix_instance =
       LAZY_INSTANCE_INITIALIZER;
   return suffix_instance.Get().GetSuffix(suffix);
 }
 
 bool ShellUtil::GetOldUserSpecificRegistrySuffix(string16* suffix) {
@@ skipping 49 matching lines @@
     // are any left...).
     if (free_bits >= 8 && next_byte_index < size) {
       free_bits -= 8;
       bit_stream += bytes[next_byte_index++] << free_bits;
     }
   }
 
   DCHECK_EQ(ret.length(), encoded_length);
   return ret;
 }