Installer: adding ResolveShortcutProperties(); updating shortcut icons during shortcut migration.

base/win/shortcut.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 "base/win/shortcut.h"
 
 #include <shellapi.h>
 #include <shlobj.h>
 #include <propkey.h>
 
 #include "base/file_util.h"
 #include "base/threading/thread_restrictions.h"
 #include "base/win/scoped_comptr.h"
+#include "base/win/scoped_propvariant.h"
 #include "base/win/win_util.h"
 #include "base/win/windows_version.h"
 
 namespace base {
 namespace win {
 
 namespace {
 
 // Initializes |i_shell_link| and |i_persist_file| (releasing them first if they
 // are already initialized).
@@ skipping 141 matching lines @@
       SHChangeNotify(SHCNE_ASSOCCHANGED, SHCNF_IDLIST, NULL, NULL);
     } else {
       SHChangeNotify(SHCNE_CREATE, SHCNF_PATH, shortcut_path.value().c_str(),
                      NULL);
     }
   }
 
   return succeeded;
 }
 
+bool ResolveShortcutProperties(const FilePath& shortcut_path,
+                               uint32 options,
+                               ShortcutProperties* properties) {
+  DCHECK(options && properties);
+  base::ThreadRestrictions::AssertIOAllowed();
+
+  if (options & ~ShortcutProperties::PROPERTIES_ALL) {
+    NOTREACHED() << "Unhandled property is used.";
+  }

[gab, 2014/01/03 18:25:52]

No {}

[huangs, 2014/01/03 20:19:35]

Done.

+
+  ScopedComPtr<IShellLink> i_shell_link;
+
+  // Get pointer to the IShellLink interface.
+  if (FAILED(i_shell_link.CreateInstance(CLSID_ShellLink, NULL,
+                                         CLSCTX_INPROC_SERVER))) {
+    return false;
+  }
+
+  ScopedComPtr<IPersistFile> persist;
+  // Query IShellLink for the IPersistFile interface.
+  if (FAILED(persist.QueryFrom(i_shell_link)))
+    return false;
+
+  // Load the shell link.
+  if (FAILED(persist->Load(shortcut_path.value().c_str(), STGM_READ)))
+    return false;
+
+  // Reset |properties|.
+  properties->options = 0;
+
+  WCHAR temp[MAX_PATH];
+  if (options & ShortcutProperties::PROPERTIES_TARGET) {
+    // Try to find the target of a shortcut.
+    if (FAILED(i_shell_link->Resolve(0, SLR_NO_UI | SLR_NOSEARCH)))
+      return false;
+    if (FAILED(i_shell_link->GetPath(temp, MAX_PATH, NULL, SLGP_UNCPRIORITY)))
+      return false;
+    properties->set_target(FilePath(temp));
+  }
+
+  if (options & ShortcutProperties::PROPERTIES_WORKING_DIR) {
+    if (FAILED(i_shell_link->GetWorkingDirectory(temp, MAX_PATH)))
+      return false;
+    properties->set_working_dir(FilePath(temp));
+  }
+
+  if (options & ShortcutProperties::PROPERTIES_ARGUMENTS) {
+    if (FAILED(i_shell_link->GetArguments(temp, MAX_PATH)))
+      return false;
+    properties->set_arguments(temp);
+  }
+
+  if (options & ShortcutProperties::PROPERTIES_DESCRIPTION) {
+    // Note: description length constrained by MAX_PATH.
+    if (FAILED(i_shell_link->GetDescription(temp, MAX_PATH)))
+      return false;
+    properties->set_description(temp);
+  }
+
+  if (options & ShortcutProperties::PROPERTIES_ICON) {
+    int temp_index;
+    if (FAILED(i_shell_link->GetIconLocation(temp, MAX_PATH, &temp_index)))
+      return false;
+    properties->set_icon(FilePath(temp), temp_index);
+  }
+
+  // Windows 7+ options, avoiding unnecessary work.
+  if ((options & ShortcutProperties::PROPERTIES_WIN7) &&
+      GetVersion() >= VERSION_WIN7) {
+    ScopedComPtr<IPropertyStore> property_store;
+    if (FAILED(property_store.QueryFrom(i_shell_link)))
+      return false;
+
+    if (options & ShortcutProperties::PROPERTIES_APP_ID) {
+      ScopedPropVariant pv_app_id;
+      if (property_store->GetValue(PKEY_AppUserModel_ID, pv_app_id.Receive())
+          != S_OK) {

[gab, 2014/01/03 18:25:52]

It's more readable to wrap in a way that the != isn't on its own, e.g.:

      if (property_store->GetValue(PKEY_AppUserModel_ID,
                                   pv_app_id.Receive()) != S_OK) {

[huangs, 2014/01/03 20:19:35]

Done.

+        return false;
+      }
+      switch (pv_app_id.get().vt) {
+        case VT_EMPTY:
+          properties->set_app_id(L"");
+          break;
+        case VT_LPWSTR:
+          properties->set_app_id(pv_app_id.get().pwszVal);
+          break;
+        default:
+          NOTREACHED() << "Unexpected variant type: " << pv_app_id.get().vt;
+      }
+    }
+
+    if (options & ShortcutProperties::PROPERTIES_DUAL_MODE) {
+      ScopedPropVariant pv_dual_mode;
+      if (property_store->GetValue(PKEY_AppUserModel_IsDualMode,
+                                   pv_dual_mode.Receive()) != S_OK) {
+        return false;
+      }
+      switch (pv_dual_mode.get().vt) {
+        case VT_EMPTY:
+          properties->set_dual_mode(false);
+          break;
+        case VT_BOOL:
+          properties->set_dual_mode(pv_dual_mode.get().boolVal == VARIANT_TRUE);
+          break;
+        default:
+          NOTREACHED() << "Unexpected variant type: " << pv_dual_mode.get().vt;
+      }
+    }
+
+    // Implement new properties go here.

[gab, 2014/01/03 18:25:52]

I don't think this comment is required anymore now that we handle all.

It's pretty obvious that if you add a property you must add it somewhere in here
and the end makes sense naturally.

(imagine if every method had a comment saying "new code goes here" :)!)

[huangs, 2014/01/03 20:19:35]

Done; removed.

+  }
+
+  return true;
+}
+
 bool ResolveShortcut(const FilePath& shortcut_path,
                      FilePath* target_path,
                      string16* args) {
-  base::ThreadRestrictions::AssertIOAllowed();
+  uint32 options = 0;
+  if (target_path)
+    options |= ShortcutProperties::PROPERTIES_TARGET;
+  if (args)
+    options |= ShortcutProperties::PROPERTIES_ARGUMENTS;
+  DCHECK(options);
 
-  HRESULT result;
-  ScopedComPtr<IShellLink> i_shell_link;
-
-  // Get pointer to the IShellLink interface.
-  result = i_shell_link.CreateInstance(CLSID_ShellLink, NULL,
-                                       CLSCTX_INPROC_SERVER);
-  if (FAILED(result))
+  ShortcutProperties properties;
+  if (!ResolveShortcutProperties(shortcut_path, options, &properties))
     return false;
 
-  ScopedComPtr<IPersistFile> persist;
-  // Query IShellLink for the IPersistFile interface.
-  result = persist.QueryFrom(i_shell_link);
-  if (FAILED(result))
-    return false;
-
-  // Load the shell link.
-  result = persist->Load(shortcut_path.value().c_str(), STGM_READ);
-  if (FAILED(result))
-    return false;
-
-  WCHAR temp[MAX_PATH];
-  if (target_path) {
-    // Try to find the target of a shortcut.
-    result = i_shell_link->Resolve(0, SLR_NO_UI | SLR_NOSEARCH);
-    if (FAILED(result))
-      return false;
-
-    result = i_shell_link->GetPath(temp, MAX_PATH, NULL, SLGP_UNCPRIORITY);
-    if (FAILED(result))
-      return false;
-
-    *target_path = FilePath(temp);
-  }
-
-  if (args) {
-    result = i_shell_link->GetArguments(temp, MAX_PATH);
-    if (FAILED(result))
-      return false;
-
-    *args = string16(temp);
-  }
+  if (target_path)
+    *target_path = properties.target;
+  if (args)
+    *args = properties.arguments;
   return true;
 }
 
 bool TaskbarPinShortcutLink(const wchar_t* shortcut) {
   base::ThreadRestrictions::AssertIOAllowed();
 
   // "Pin to taskbar" is only supported after Win7.
   if (GetVersion() < VERSION_WIN7)
     return false;
 
   int result = reinterpret_cast<int>(ShellExecute(NULL, L"taskbarpin", shortcut,
       NULL, NULL, 0));
   return result > 32;
 }
 
 bool TaskbarUnpinShortcutLink(const wchar_t* shortcut) {
   base::ThreadRestrictions::AssertIOAllowed();
 
   // "Unpin from taskbar" is only supported after Win7.
-  if (base::win::GetVersion() < base::win::VERSION_WIN7)
+  if (GetVersion() < VERSION_WIN7)
     return false;
 
   int result = reinterpret_cast<int>(ShellExecute(NULL, L"taskbarunpin",
       shortcut, NULL, NULL, 0));
   return result > 32;
 }
 
 }  // namespace win
 }  // namespace base