OLD | NEW |
| (Empty) |
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | |
2 // Use of this source code is governed by a BSD-style license that can be | |
3 // found in the LICENSE file. | |
4 | |
5 #include "base/win/shortcut.h" | |
6 | |
7 #include <shellapi.h> | |
8 #include <shlobj.h> | |
9 #include <propkey.h> | |
10 | |
11 #include "base/files/file_util.h" | |
12 #include "base/threading/thread_restrictions.h" | |
13 #include "base/win/scoped_comptr.h" | |
14 #include "base/win/scoped_propvariant.h" | |
15 #include "base/win/win_util.h" | |
16 #include "base/win/windows_version.h" | |
17 | |
18 namespace base { | |
19 namespace win { | |
20 | |
21 namespace { | |
22 | |
23 // Initializes |i_shell_link| and |i_persist_file| (releasing them first if they | |
24 // are already initialized). | |
25 // If |shortcut| is not NULL, loads |shortcut| into |i_persist_file|. | |
26 // If any of the above steps fail, both |i_shell_link| and |i_persist_file| will | |
27 // be released. | |
28 void InitializeShortcutInterfaces( | |
29 const wchar_t* shortcut, | |
30 ScopedComPtr<IShellLink>* i_shell_link, | |
31 ScopedComPtr<IPersistFile>* i_persist_file) { | |
32 i_shell_link->Release(); | |
33 i_persist_file->Release(); | |
34 if (FAILED(i_shell_link->CreateInstance(CLSID_ShellLink, NULL, | |
35 CLSCTX_INPROC_SERVER)) || | |
36 FAILED(i_persist_file->QueryFrom(i_shell_link->get())) || | |
37 (shortcut && FAILED((*i_persist_file)->Load(shortcut, STGM_READWRITE)))) { | |
38 i_shell_link->Release(); | |
39 i_persist_file->Release(); | |
40 } | |
41 } | |
42 | |
43 } // namespace | |
44 | |
45 ShortcutProperties::ShortcutProperties() | |
46 : icon_index(-1), dual_mode(false), options(0U) { | |
47 } | |
48 | |
49 ShortcutProperties::~ShortcutProperties() { | |
50 } | |
51 | |
52 bool CreateOrUpdateShortcutLink(const FilePath& shortcut_path, | |
53 const ShortcutProperties& properties, | |
54 ShortcutOperation operation) { | |
55 base::ThreadRestrictions::AssertIOAllowed(); | |
56 | |
57 // A target is required unless |operation| is SHORTCUT_UPDATE_EXISTING. | |
58 if (operation != SHORTCUT_UPDATE_EXISTING && | |
59 !(properties.options & ShortcutProperties::PROPERTIES_TARGET)) { | |
60 NOTREACHED(); | |
61 return false; | |
62 } | |
63 | |
64 bool shortcut_existed = PathExists(shortcut_path); | |
65 | |
66 // Interfaces to the old shortcut when replacing an existing shortcut. | |
67 ScopedComPtr<IShellLink> old_i_shell_link; | |
68 ScopedComPtr<IPersistFile> old_i_persist_file; | |
69 | |
70 // Interfaces to the shortcut being created/updated. | |
71 ScopedComPtr<IShellLink> i_shell_link; | |
72 ScopedComPtr<IPersistFile> i_persist_file; | |
73 switch (operation) { | |
74 case SHORTCUT_CREATE_ALWAYS: | |
75 InitializeShortcutInterfaces(NULL, &i_shell_link, &i_persist_file); | |
76 break; | |
77 case SHORTCUT_UPDATE_EXISTING: | |
78 InitializeShortcutInterfaces(shortcut_path.value().c_str(), &i_shell_link, | |
79 &i_persist_file); | |
80 break; | |
81 case SHORTCUT_REPLACE_EXISTING: | |
82 InitializeShortcutInterfaces(shortcut_path.value().c_str(), | |
83 &old_i_shell_link, &old_i_persist_file); | |
84 // Confirm |shortcut_path| exists and is a shortcut by verifying | |
85 // |old_i_persist_file| was successfully initialized in the call above. If | |
86 // so, initialize the interfaces to begin writing a new shortcut (to | |
87 // overwrite the current one if successful). | |
88 if (old_i_persist_file.get()) | |
89 InitializeShortcutInterfaces(NULL, &i_shell_link, &i_persist_file); | |
90 break; | |
91 default: | |
92 NOTREACHED(); | |
93 } | |
94 | |
95 // Return false immediately upon failure to initialize shortcut interfaces. | |
96 if (!i_persist_file.get()) | |
97 return false; | |
98 | |
99 if ((properties.options & ShortcutProperties::PROPERTIES_TARGET) && | |
100 FAILED(i_shell_link->SetPath(properties.target.value().c_str()))) { | |
101 return false; | |
102 } | |
103 | |
104 if ((properties.options & ShortcutProperties::PROPERTIES_WORKING_DIR) && | |
105 FAILED(i_shell_link->SetWorkingDirectory( | |
106 properties.working_dir.value().c_str()))) { | |
107 return false; | |
108 } | |
109 | |
110 if (properties.options & ShortcutProperties::PROPERTIES_ARGUMENTS) { | |
111 if (FAILED(i_shell_link->SetArguments(properties.arguments.c_str()))) | |
112 return false; | |
113 } else if (old_i_persist_file.get()) { | |
114 wchar_t current_arguments[MAX_PATH] = {0}; | |
115 if (SUCCEEDED(old_i_shell_link->GetArguments(current_arguments, | |
116 MAX_PATH))) { | |
117 i_shell_link->SetArguments(current_arguments); | |
118 } | |
119 } | |
120 | |
121 if ((properties.options & ShortcutProperties::PROPERTIES_DESCRIPTION) && | |
122 FAILED(i_shell_link->SetDescription(properties.description.c_str()))) { | |
123 return false; | |
124 } | |
125 | |
126 if ((properties.options & ShortcutProperties::PROPERTIES_ICON) && | |
127 FAILED(i_shell_link->SetIconLocation(properties.icon.value().c_str(), | |
128 properties.icon_index))) { | |
129 return false; | |
130 } | |
131 | |
132 bool has_app_id = | |
133 (properties.options & ShortcutProperties::PROPERTIES_APP_ID) != 0; | |
134 bool has_dual_mode = | |
135 (properties.options & ShortcutProperties::PROPERTIES_DUAL_MODE) != 0; | |
136 if ((has_app_id || has_dual_mode) && | |
137 GetVersion() >= VERSION_WIN7) { | |
138 ScopedComPtr<IPropertyStore> property_store; | |
139 if (FAILED(property_store.QueryFrom(i_shell_link.get())) || | |
140 !property_store.get()) | |
141 return false; | |
142 | |
143 if (has_app_id && | |
144 !SetAppIdForPropertyStore(property_store.get(), | |
145 properties.app_id.c_str())) { | |
146 return false; | |
147 } | |
148 if (has_dual_mode && | |
149 !SetBooleanValueForPropertyStore(property_store.get(), | |
150 PKEY_AppUserModel_IsDualMode, | |
151 properties.dual_mode)) { | |
152 return false; | |
153 } | |
154 } | |
155 | |
156 // Release the interfaces to the old shortcut to make sure it doesn't prevent | |
157 // overwriting it if needed. | |
158 old_i_persist_file.Release(); | |
159 old_i_shell_link.Release(); | |
160 | |
161 HRESULT result = i_persist_file->Save(shortcut_path.value().c_str(), TRUE); | |
162 | |
163 // Release the interfaces in case the SHChangeNotify call below depends on | |
164 // the operations above being fully completed. | |
165 i_persist_file.Release(); | |
166 i_shell_link.Release(); | |
167 | |
168 // If we successfully created/updated the icon, notify the shell that we have | |
169 // done so. | |
170 const bool succeeded = SUCCEEDED(result); | |
171 if (succeeded) { | |
172 if (shortcut_existed) { | |
173 // TODO(gab): SHCNE_UPDATEITEM might be sufficient here; further testing | |
174 // required. | |
175 SHChangeNotify(SHCNE_ASSOCCHANGED, SHCNF_IDLIST, NULL, NULL); | |
176 } else { | |
177 SHChangeNotify(SHCNE_CREATE, SHCNF_PATH, shortcut_path.value().c_str(), | |
178 NULL); | |
179 } | |
180 } | |
181 | |
182 return succeeded; | |
183 } | |
184 | |
185 bool ResolveShortcutProperties(const FilePath& shortcut_path, | |
186 uint32 options, | |
187 ShortcutProperties* properties) { | |
188 DCHECK(options && properties); | |
189 base::ThreadRestrictions::AssertIOAllowed(); | |
190 | |
191 if (options & ~ShortcutProperties::PROPERTIES_ALL) | |
192 NOTREACHED() << "Unhandled property is used."; | |
193 | |
194 ScopedComPtr<IShellLink> i_shell_link; | |
195 | |
196 // Get pointer to the IShellLink interface. | |
197 if (FAILED(i_shell_link.CreateInstance(CLSID_ShellLink, NULL, | |
198 CLSCTX_INPROC_SERVER))) { | |
199 return false; | |
200 } | |
201 | |
202 ScopedComPtr<IPersistFile> persist; | |
203 // Query IShellLink for the IPersistFile interface. | |
204 if (FAILED(persist.QueryFrom(i_shell_link.get()))) | |
205 return false; | |
206 | |
207 // Load the shell link. | |
208 if (FAILED(persist->Load(shortcut_path.value().c_str(), STGM_READ))) | |
209 return false; | |
210 | |
211 // Reset |properties|. | |
212 properties->options = 0; | |
213 | |
214 wchar_t temp[MAX_PATH]; | |
215 if (options & ShortcutProperties::PROPERTIES_TARGET) { | |
216 if (FAILED(i_shell_link->GetPath(temp, MAX_PATH, NULL, SLGP_UNCPRIORITY))) | |
217 return false; | |
218 properties->set_target(FilePath(temp)); | |
219 } | |
220 | |
221 if (options & ShortcutProperties::PROPERTIES_WORKING_DIR) { | |
222 if (FAILED(i_shell_link->GetWorkingDirectory(temp, MAX_PATH))) | |
223 return false; | |
224 properties->set_working_dir(FilePath(temp)); | |
225 } | |
226 | |
227 if (options & ShortcutProperties::PROPERTIES_ARGUMENTS) { | |
228 if (FAILED(i_shell_link->GetArguments(temp, MAX_PATH))) | |
229 return false; | |
230 properties->set_arguments(temp); | |
231 } | |
232 | |
233 if (options & ShortcutProperties::PROPERTIES_DESCRIPTION) { | |
234 // Note: description length constrained by MAX_PATH. | |
235 if (FAILED(i_shell_link->GetDescription(temp, MAX_PATH))) | |
236 return false; | |
237 properties->set_description(temp); | |
238 } | |
239 | |
240 if (options & ShortcutProperties::PROPERTIES_ICON) { | |
241 int temp_index; | |
242 if (FAILED(i_shell_link->GetIconLocation(temp, MAX_PATH, &temp_index))) | |
243 return false; | |
244 properties->set_icon(FilePath(temp), temp_index); | |
245 } | |
246 | |
247 // Windows 7+ options, avoiding unnecessary work. | |
248 if ((options & ShortcutProperties::PROPERTIES_WIN7) && | |
249 GetVersion() >= VERSION_WIN7) { | |
250 ScopedComPtr<IPropertyStore> property_store; | |
251 if (FAILED(property_store.QueryFrom(i_shell_link.get()))) | |
252 return false; | |
253 | |
254 if (options & ShortcutProperties::PROPERTIES_APP_ID) { | |
255 ScopedPropVariant pv_app_id; | |
256 if (property_store->GetValue(PKEY_AppUserModel_ID, | |
257 pv_app_id.Receive()) != S_OK) { | |
258 return false; | |
259 } | |
260 switch (pv_app_id.get().vt) { | |
261 case VT_EMPTY: | |
262 properties->set_app_id(L""); | |
263 break; | |
264 case VT_LPWSTR: | |
265 properties->set_app_id(pv_app_id.get().pwszVal); | |
266 break; | |
267 default: | |
268 NOTREACHED() << "Unexpected variant type: " << pv_app_id.get().vt; | |
269 return false; | |
270 } | |
271 } | |
272 | |
273 if (options & ShortcutProperties::PROPERTIES_DUAL_MODE) { | |
274 ScopedPropVariant pv_dual_mode; | |
275 if (property_store->GetValue(PKEY_AppUserModel_IsDualMode, | |
276 pv_dual_mode.Receive()) != S_OK) { | |
277 return false; | |
278 } | |
279 switch (pv_dual_mode.get().vt) { | |
280 case VT_EMPTY: | |
281 properties->set_dual_mode(false); | |
282 break; | |
283 case VT_BOOL: | |
284 properties->set_dual_mode(pv_dual_mode.get().boolVal == VARIANT_TRUE); | |
285 break; | |
286 default: | |
287 NOTREACHED() << "Unexpected variant type: " << pv_dual_mode.get().vt; | |
288 return false; | |
289 } | |
290 } | |
291 } | |
292 | |
293 return true; | |
294 } | |
295 | |
296 bool ResolveShortcut(const FilePath& shortcut_path, | |
297 FilePath* target_path, | |
298 string16* args) { | |
299 uint32 options = 0; | |
300 if (target_path) | |
301 options |= ShortcutProperties::PROPERTIES_TARGET; | |
302 if (args) | |
303 options |= ShortcutProperties::PROPERTIES_ARGUMENTS; | |
304 DCHECK(options); | |
305 | |
306 ShortcutProperties properties; | |
307 if (!ResolveShortcutProperties(shortcut_path, options, &properties)) | |
308 return false; | |
309 | |
310 if (target_path) | |
311 *target_path = properties.target; | |
312 if (args) | |
313 *args = properties.arguments; | |
314 return true; | |
315 } | |
316 | |
317 bool TaskbarPinShortcutLink(const wchar_t* shortcut) { | |
318 base::ThreadRestrictions::AssertIOAllowed(); | |
319 | |
320 // "Pin to taskbar" is only supported after Win7. | |
321 if (GetVersion() < VERSION_WIN7) | |
322 return false; | |
323 | |
324 intptr_t result = reinterpret_cast<intptr_t>( | |
325 ShellExecute(NULL, L"taskbarpin", shortcut, NULL, NULL, 0)); | |
326 return result > 32; | |
327 } | |
328 | |
329 bool TaskbarUnpinShortcutLink(const wchar_t* shortcut) { | |
330 base::ThreadRestrictions::AssertIOAllowed(); | |
331 | |
332 // "Unpin from taskbar" is only supported after Win7. | |
333 if (GetVersion() < VERSION_WIN7) | |
334 return false; | |
335 | |
336 intptr_t result = reinterpret_cast<intptr_t>( | |
337 ShellExecute(NULL, L"taskbarunpin", shortcut, NULL, NULL, 0)); | |
338 return result > 32; | |
339 } | |
340 | |
341 } // namespace win | |
342 } // namespace base | |
OLD | NEW |