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>
 
@@ skipping 154 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(properties);
+  DCHECK(options);

[gab, 2014/01/02 15:51:46]

Switch order to match argument order (and/or group with &&).

[huangs, 2014/01/02 19:58:22]

Going with && for implicit cast to bool.

+  base::ThreadRestrictions::AssertIOAllowed();
+
+  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;
+
+  properties->options = 0;

[gab, 2014/01/02 15:51:46]

Empty line below (otherwise it feels like this is only related to the block
below).

Also add a comment like:

// Reset |properties|.

above.

[huangs, 2014/01/02 19:58:22]

Done.

+  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_ARGUMENTS) {
+    if (FAILED(i_shell_link->GetArguments(temp, MAX_PATH)))
+      return false;
+
+    properties->set_arguments(string16(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);
+  }
+
+  // Implement other options if the need arise.

[gab, 2014/01/02 15:51:46]

Add to the comment in the header to mention which options are currently
supported.

And add:

// No unsupported options.
DCHECK_EQ(0, options & (~ShortcutProperties::PROPERTIES_TARGET &
                        ~ShortcutProperties::PROPERTIES_ARGUMENTS &
                        ~ShortcutProperties::PROPERTIES_ICON));

at the top of this method.

[huangs, 2014/01/02 19:58:22]

I realized that base\test\test_shortcut_win.cc: ValidateShortcut() 

https://code.google.com/p/chromium/codesearch#chromium/src/base/test/test_sho...

reads everything; so may as well do the work, and add sanity check unit test!

Since everything is in, maybe I won't have to check for unsupported options?
CreateOrUpdateShortcutLink() doesn't check either.

+
+  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;
+  if (!options)
+    return true;  // Vacuous success if we want nothing.

[gab, 2014/01/02 15:51:46]

I don't think it makes sense to call ResolveShortcut and want nothing.

Update the header comment to disallow this and let the DCHECK hit in
ResolveShortcutProperties.

[huangs, 2014/01/02 19:58:22]

Done, but adding DCHECK in this routine.

 
-  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 p;

[gab, 2014/01/02 15:51:46]

s/p/properties

[huangs, 2014/01/02 19:58:22]

Done.

+  if (!ResolveShortcutProperties(shortcut_path, options, &p))
     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 = p.target;
+  if (args)
+    *args = p.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)
     return false;
 
   int result = reinterpret_cast<int>(ShellExecute(NULL, L"taskbarunpin",
       shortcut, NULL, NULL, 0));
   return result > 32;
 }
 
 }  // namespace win
 }  // namespace base