123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336 |
- // 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 "atom/browser/ui/win/jump_list.h"
- #include <propkey.h> // for PKEY_* constants
- #include "base/win/scoped_co_mem.h"
- #include "base/win/scoped_propvariant.h"
- #include "base/win/win_util.h"
- namespace {
- using atom::JumpListCategory;
- using atom::JumpListItem;
- using atom::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->SetDescription(item.description.c_str())))
- 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, arraysize(path), nullptr, 0)))
- return false;
- 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;
- }
- int icon_index;
- if (SUCCEEDED(
- shell_link->GetIconLocation(path, arraysize(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, arraysize(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 atom {
- JumpList::JumpList(const base::string16& app_id) : app_id_(app_id) {
- destinations_.CoCreateInstance(CLSID_DestinationList);
- }
- 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 {
- auto hr = destinations_->AppendCategory(category.name.c_str(), items);
- if (FAILED(hr)) {
- if (hr == 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 atom
|