-
Notifications
You must be signed in to change notification settings - Fork 15k
/
jump_list.cc
358 lines (297 loc) · 11.4 KB
/
jump_list.cc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
// Copyright (c) 2016 GitHub, Inc.
// Use of this source code is governed by the MIT license that can be
// found in the LICENSE file.
#include "shell/browser/ui/win/jump_list.h"
#include <propkey.h> // for PKEY_* constants
#include "base/logging.h"
#include "base/win/scoped_co_mem.h"
#include "base/win/scoped_propvariant.h"
#include "base/win/win_util.h"
namespace {
using electron::JumpListCategory;
using electron::JumpListItem;
using electron::JumpListResult;
bool AppendTask(const JumpListItem& item, IObjectCollection* collection) {
DCHECK(collection);
CComPtr<IShellLink> link;
if (FAILED(link.CoCreateInstance(CLSID_ShellLink)) ||
FAILED(link->SetPath(item.path.value().c_str())) ||
FAILED(link->SetArguments(item.arguments.c_str())) ||
FAILED(link->SetWorkingDirectory(item.working_dir.value().c_str())) ||
FAILED(link->SetDescription(item.description.c_str())))
return false;
// SetDescription limits the size of the parameter to INFOTIPSIZE (1024),
// which suggests rejection when exceeding that limit, but experimentation
// has shown that descriptions longer than 260 characters cause a silent
// failure, despite SetDescription returning the success code S_OK.
if (item.description.size() > 260)
return false;
if (!item.icon_path.empty() &&
FAILED(link->SetIconLocation(item.icon_path.value().c_str(),
item.icon_index)))
return false;
CComQIPtr<IPropertyStore> property_store(link);
if (!base::win::SetStringValueForPropertyStore(property_store, PKEY_Title,
item.title.c_str()))
return false;
return SUCCEEDED(collection->AddObject(link));
}
bool AppendSeparator(IObjectCollection* collection) {
DCHECK(collection);
CComPtr<IShellLink> shell_link;
if (SUCCEEDED(shell_link.CoCreateInstance(CLSID_ShellLink))) {
CComQIPtr<IPropertyStore> property_store(shell_link);
if (base::win::SetBooleanValueForPropertyStore(
property_store, PKEY_AppUserModel_IsDestListSeparator, true))
return SUCCEEDED(collection->AddObject(shell_link));
}
return false;
}
bool AppendFile(const JumpListItem& item, IObjectCollection* collection) {
DCHECK(collection);
CComPtr<IShellItem> file;
if (SUCCEEDED(SHCreateItemFromParsingName(item.path.value().c_str(), NULL,
IID_PPV_ARGS(&file))))
return SUCCEEDED(collection->AddObject(file));
return false;
}
bool GetShellItemFileName(IShellItem* shell_item, base::FilePath* file_name) {
DCHECK(shell_item);
DCHECK(file_name);
base::win::ScopedCoMem<wchar_t> file_name_buffer;
if (SUCCEEDED(
shell_item->GetDisplayName(SIGDN_FILESYSPATH, &file_name_buffer))) {
*file_name = base::FilePath(file_name_buffer.get());
return true;
}
return false;
}
bool ConvertShellLinkToJumpListItem(IShellLink* shell_link,
JumpListItem* item) {
DCHECK(shell_link);
DCHECK(item);
item->type = JumpListItem::Type::TASK;
wchar_t path[MAX_PATH];
if (FAILED(shell_link->GetPath(path, base::size(path), nullptr, 0)))
return false;
item->path = base::FilePath(path);
CComQIPtr<IPropertyStore> property_store = shell_link;
base::win::ScopedPropVariant prop;
if (SUCCEEDED(
property_store->GetValue(PKEY_Link_Arguments, prop.Receive())) &&
(prop.get().vt == VT_LPWSTR)) {
item->arguments = prop.get().pwszVal;
}
if (SUCCEEDED(property_store->GetValue(PKEY_Title, prop.Receive())) &&
(prop.get().vt == VT_LPWSTR)) {
item->title = prop.get().pwszVal;
}
if (SUCCEEDED(shell_link->GetWorkingDirectory(path, base::size(path))))
item->working_dir = base::FilePath(path);
int icon_index;
if (SUCCEEDED(
shell_link->GetIconLocation(path, base::size(path), &icon_index))) {
item->icon_path = base::FilePath(path);
item->icon_index = icon_index;
}
wchar_t item_desc[INFOTIPSIZE];
if (SUCCEEDED(shell_link->GetDescription(item_desc, base::size(item_desc))))
item->description = item_desc;
return true;
}
// Convert IObjectArray of IShellLink & IShellItem to std::vector.
void ConvertRemovedJumpListItems(IObjectArray* in,
std::vector<JumpListItem>* out) {
DCHECK(in);
DCHECK(out);
UINT removed_count;
if (SUCCEEDED(in->GetCount(&removed_count) && (removed_count > 0))) {
out->reserve(removed_count);
JumpListItem item;
IShellItem* shell_item;
IShellLink* shell_link;
for (UINT i = 0; i < removed_count; ++i) {
if (SUCCEEDED(in->GetAt(i, IID_PPV_ARGS(&shell_item)))) {
item.type = JumpListItem::Type::FILE;
GetShellItemFileName(shell_item, &item.path);
out->push_back(item);
shell_item->Release();
} else if (SUCCEEDED(in->GetAt(i, IID_PPV_ARGS(&shell_link)))) {
if (ConvertShellLinkToJumpListItem(shell_link, &item))
out->push_back(item);
shell_link->Release();
}
}
}
}
} // namespace
namespace electron {
JumpListItem::JumpListItem() = default;
JumpListItem::JumpListItem(const JumpListItem&) = default;
JumpListItem::~JumpListItem() = default;
JumpListCategory::JumpListCategory() = default;
JumpListCategory::JumpListCategory(const JumpListCategory&) = default;
JumpListCategory::~JumpListCategory() = default;
JumpList::JumpList(const base::string16& app_id) : app_id_(app_id) {
destinations_.CoCreateInstance(CLSID_DestinationList);
}
JumpList::~JumpList() = default;
bool JumpList::Begin(int* min_items, std::vector<JumpListItem>* removed_items) {
DCHECK(destinations_);
if (!destinations_)
return false;
if (FAILED(destinations_->SetAppID(app_id_.c_str())))
return false;
UINT min_slots;
CComPtr<IObjectArray> removed;
if (FAILED(destinations_->BeginList(&min_slots, IID_PPV_ARGS(&removed))))
return false;
if (min_items)
*min_items = min_slots;
if (removed_items)
ConvertRemovedJumpListItems(removed, removed_items);
return true;
}
bool JumpList::Abort() {
DCHECK(destinations_);
if (!destinations_)
return false;
return SUCCEEDED(destinations_->AbortList());
}
bool JumpList::Commit() {
DCHECK(destinations_);
if (!destinations_)
return false;
return SUCCEEDED(destinations_->CommitList());
}
bool JumpList::Delete() {
DCHECK(destinations_);
if (!destinations_)
return false;
return SUCCEEDED(destinations_->DeleteList(app_id_.c_str()));
}
// This method will attempt to append as many items to the Jump List as
// possible, and will return a single error code even if multiple things
// went wrong in the process. To get detailed information about what went
// wrong enable runtime logging.
JumpListResult JumpList::AppendCategory(const JumpListCategory& category) {
DCHECK(destinations_);
if (!destinations_)
return JumpListResult::GENERIC_ERROR;
if (category.items.empty())
return JumpListResult::SUCCESS;
CComPtr<IObjectCollection> collection;
if (FAILED(collection.CoCreateInstance(CLSID_EnumerableObjectCollection))) {
return JumpListResult::GENERIC_ERROR;
}
auto result = JumpListResult::SUCCESS;
// Keep track of how many items were actually appended to the category.
int appended_count = 0;
for (const auto& item : category.items) {
switch (item.type) {
case JumpListItem::Type::TASK:
if (AppendTask(item, collection))
++appended_count;
else
LOG(ERROR) << "Failed to append task '" << item.title
<< "' "
"to Jump List.";
break;
case JumpListItem::Type::SEPARATOR:
if (category.type == JumpListCategory::Type::TASKS) {
if (AppendSeparator(collection))
++appended_count;
} else {
LOG(ERROR) << "Can't append separator to Jump List category "
<< "'" << category.name << "'. "
<< "Separators are only allowed in the standard 'Tasks' "
"Jump List category.";
result = JumpListResult::CUSTOM_CATEGORY_SEPARATOR_ERROR;
}
break;
case JumpListItem::Type::FILE:
if (AppendFile(item, collection))
++appended_count;
else
LOG(ERROR) << "Failed to append '" << item.path.value()
<< "' "
"to Jump List.";
break;
}
}
if (appended_count == 0)
return result;
if ((static_cast<size_t>(appended_count) < category.items.size()) &&
(result == JumpListResult::SUCCESS)) {
result = JumpListResult::GENERIC_ERROR;
}
CComQIPtr<IObjectArray> items(collection);
if (category.type == JumpListCategory::Type::TASKS) {
if (FAILED(destinations_->AddUserTasks(items))) {
LOG(ERROR) << "Failed to append items to the standard Tasks category.";
if (result == JumpListResult::SUCCESS)
result = JumpListResult::GENERIC_ERROR;
}
} else {
HRESULT hr = destinations_->AppendCategory(category.name.c_str(), items);
if (FAILED(hr)) {
if (hr == static_cast<HRESULT>(0x80040F03)) {
LOG(ERROR) << "Failed to append custom category "
<< "'" << category.name << "' "
<< "to Jump List due to missing file type registration.";
result = JumpListResult::MISSING_FILE_TYPE_REGISTRATION_ERROR;
} else if (hr == E_ACCESSDENIED) {
LOG(ERROR) << "Failed to append custom category "
<< "'" << category.name << "' "
<< "to Jump List due to system privacy settings.";
result = JumpListResult::CUSTOM_CATEGORY_ACCESS_DENIED_ERROR;
} else {
LOG(ERROR) << "Failed to append custom category "
<< "'" << category.name << "' to Jump List.";
if (result == JumpListResult::SUCCESS)
result = JumpListResult::GENERIC_ERROR;
}
}
}
return result;
}
// This method will attempt to append as many categories to the Jump List
// as possible, and will return a single error code even if multiple things
// went wrong in the process. To get detailed information about what went
// wrong enable runtime logging.
JumpListResult JumpList::AppendCategories(
const std::vector<JumpListCategory>& categories) {
DCHECK(destinations_);
if (!destinations_)
return JumpListResult::GENERIC_ERROR;
auto result = JumpListResult::SUCCESS;
for (const auto& category : categories) {
auto latestResult = JumpListResult::SUCCESS;
switch (category.type) {
case JumpListCategory::Type::TASKS:
case JumpListCategory::Type::CUSTOM:
latestResult = AppendCategory(category);
break;
case JumpListCategory::Type::RECENT:
if (FAILED(destinations_->AppendKnownCategory(KDC_RECENT))) {
LOG(ERROR) << "Failed to append Recent category to Jump List.";
latestResult = JumpListResult::GENERIC_ERROR;
}
break;
case JumpListCategory::Type::FREQUENT:
if (FAILED(destinations_->AppendKnownCategory(KDC_FREQUENT))) {
LOG(ERROR) << "Failed to append Frequent category to Jump List.";
latestResult = JumpListResult::GENERIC_ERROR;
}
break;
}
// Keep the first non-generic error code as only one can be returned from
// the function (so try to make it the most useful one).
if (((result == JumpListResult::SUCCESS) ||
(result == JumpListResult::GENERIC_ERROR)) &&
(latestResult != JumpListResult::SUCCESS))
result = latestResult;
}
return result;
}
} // namespace electron