Extend the custom Jump List API
Add `app.getJumpListSettings()` and `app.setJumpList(callback)` that make it possible to fully customize the Jump List of an Electron app. It is now possible to: - Add tasks to the standard `Tasks` category. - Add separators to the standard `Tasks` category. - Add custom categories containing tasks and file links. - Add system managed Recent/Frequent categories. - Remove the custom Jump List.
This commit is contained in:
Vadim Macagon
parent
b5dec9990e
commit
c64294cf60
7 changed files with 897 additions and 41 deletions
332
atom/browser/ui/win/jump_list.cc
Normal file
332
atom/browser/ui/win/jump_list.cc
Normal file
|
|
@ -0,0 +1,332 @@
|
|||
// 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::JumpListItem;
|
||||
using atom::JumpListCategory;
|
||||
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 ((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
|
||||
112
atom/browser/ui/win/jump_list.h
Normal file
112
atom/browser/ui/win/jump_list.h
Normal file
|
|
@ -0,0 +1,112 @@
|
|||
// Copyright (c) 2016 GitHub, Inc.
|
||||
// Use of this source code is governed by the MIT license that can be
|
||||
// found in the LICENSE file.
|
||||
|
||||
#ifndef ATOM_BROWSER_UI_WIN_JUMP_LIST_H_
|
||||
#define ATOM_BROWSER_UI_WIN_JUMP_LIST_H_
|
||||
|
||||
#include <atlbase.h>
|
||||
#include <shobjidl.h>
|
||||
#include <vector>
|
||||
|
||||
#include "base/files/file_path.h"
|
||||
#include "base/macros.h"
|
||||
|
||||
namespace atom {
|
||||
|
||||
enum class JumpListResult : int {
|
||||
SUCCESS = 0,
|
||||
// In JS code this error will manifest as an exception.
|
||||
ARGUMENT_ERROR = 1,
|
||||
// Generic error, the runtime logs may provide some clues.
|
||||
GENERIC_ERROR = 2,
|
||||
// Custom categories can't contain separators.
|
||||
CUSTOM_CATEGORY_SEPARATOR_ERROR = 3,
|
||||
// The app isn't registered to handle a file type found in a custom category.
|
||||
MISSING_FILE_TYPE_REGISTRATION_ERROR = 4,
|
||||
// Custom categories can't be created due to user privacy settings.
|
||||
CUSTOM_CATEGORY_ACCESS_DENIED_ERROR = 5,
|
||||
};
|
||||
|
||||
struct JumpListItem {
|
||||
enum class Type {
|
||||
// A task will launch an app (usually the one that created the Jump List)
|
||||
// with specific arguments.
|
||||
TASK,
|
||||
// Separators can only be inserted between items in the standard Tasks
|
||||
// category, they can't appear in custom categories.
|
||||
SEPARATOR,
|
||||
// A file link will open a file using the app that created the Jump List,
|
||||
// for this to work the app must be registered as a handler for the file
|
||||
// type (though the app doesn't have to be the default handler).
|
||||
FILE
|
||||
};
|
||||
|
||||
Type type = Type::TASK;
|
||||
// For tasks this is the path to the program executable, for file links this
|
||||
// is the full filename.
|
||||
base::FilePath path;
|
||||
base::string16 arguments;
|
||||
base::string16 title;
|
||||
base::string16 description;
|
||||
base::FilePath icon_path;
|
||||
int icon_index = 0;
|
||||
};
|
||||
|
||||
struct JumpListCategory {
|
||||
enum class Type {
|
||||
// A custom category can contain tasks and files, but not separators.
|
||||
CUSTOM,
|
||||
// Frequent/Recent categories are managed by the OS, their name and items
|
||||
// can't be set by the app (though items can be set indirectly).
|
||||
FREQUENT,
|
||||
RECENT,
|
||||
// The standard Tasks category can't be renamed by the app, but the app
|
||||
// can set the items that should appear in this category, and those items
|
||||
// can include tasks, files, and separators.
|
||||
TASKS
|
||||
};
|
||||
|
||||
Type type = Type::TASKS;
|
||||
base::string16 name;
|
||||
std::vector<JumpListItem> items;
|
||||
};
|
||||
|
||||
// Creates or removes a custom Jump List for an app.
|
||||
// See https://msdn.microsoft.com/en-us/library/windows/desktop/gg281362.aspx
|
||||
class JumpList {
|
||||
public:
|
||||
// |app_id| must be the Application User Model ID of the app for which the
|
||||
// custom Jump List should be created/removed, it's usually obtained by
|
||||
// calling GetCurrentProcessExplicitAppUserModelID().
|
||||
explicit JumpList(const base::string16& app_id);
|
||||
|
||||
// Starts a new transaction, must be called before appending any categories,
|
||||
// aborting or committing. After the method returns |min_items| will indicate
|
||||
// the minimum number of items that will be displayed in the Jump List, and
|
||||
// |removed_items| (if not null) will contain all the items the user has
|
||||
// unpinned from the Jump List. Both parameters are optional.
|
||||
bool Begin(int* min_items = nullptr,
|
||||
std::vector<JumpListItem>* removed_items = nullptr);
|
||||
// Abandons any changes queued up since Begin() was called.
|
||||
bool Abort();
|
||||
// Commits any changes queued up since Begin() was called.
|
||||
bool Commit();
|
||||
// Deletes the custom Jump List and restores the default Jump List.
|
||||
bool Delete();
|
||||
// Appends a category to the custom Jump List.
|
||||
JumpListResult AppendCategory(const JumpListCategory& category);
|
||||
// Appends categories to the custom Jump List.
|
||||
JumpListResult AppendCategories(
|
||||
const std::vector<JumpListCategory>& categories);
|
||||
|
||||
private:
|
||||
base::string16 app_id_;
|
||||
CComPtr<ICustomDestinationList> destinations_;
|
||||
|
||||
DISALLOW_COPY_AND_ASSIGN(JumpList);
|
||||
};
|
||||
|
||||
} // namespace atom
|
||||
|
||||
#endif // ATOM_BROWSER_UI_WIN_JUMP_LIST_H_
|
||||
Loading…
Add table
Add a link
Reference in a new issue