123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367 |
- // 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 <objbase.h>
- #include <propkey.h>
- #include <shlobj.h>
- #include <wrl/client.h>
- #include "base/files/file_util.h"
- #include "base/logging.h"
- #include "base/strings/string_util.h"
- #include "base/strings/utf_string_conversions.h"
- #include "base/threading/scoped_blocking_call.h"
- #include "base/win/scoped_propvariant.h"
- #include "base/win/win_util.h"
- #include "base/win/windows_version.h"
- namespace base {
- namespace win {
- namespace {
- using Microsoft::WRL::ComPtr;
- // Initializes |i_shell_link| and |i_persist_file| (releasing them first if they
- // are already initialized).
- // If |shortcut| is not NULL, loads |shortcut| into |i_persist_file|.
- // If any of the above steps fail, both |i_shell_link| and |i_persist_file| will
- // be released.
- void InitializeShortcutInterfaces(const wchar_t* shortcut,
- ComPtr<IShellLink>* i_shell_link,
- ComPtr<IPersistFile>* i_persist_file) {
- // Reset in the inverse order of acquisition.
- i_persist_file->Reset();
- i_shell_link->Reset();
- ComPtr<IShellLink> shell_link;
- if (FAILED(::CoCreateInstance(CLSID_ShellLink, nullptr, CLSCTX_INPROC_SERVER,
- IID_PPV_ARGS(&shell_link)))) {
- return;
- }
- ComPtr<IPersistFile> persist_file;
- if (FAILED(shell_link.As(&persist_file)))
- return;
- if (shortcut && FAILED(persist_file->Load(shortcut, STGM_READWRITE)))
- return;
- i_shell_link->Swap(shell_link);
- i_persist_file->Swap(persist_file);
- }
- } // namespace
- ShortcutProperties::ShortcutProperties() = default;
- ShortcutProperties::ShortcutProperties(const ShortcutProperties& other) =
- default;
- ShortcutProperties::~ShortcutProperties() = default;
- void ShortcutProperties::set_description(const std::wstring& description_in) {
- // Size restriction as per MSDN at http://goo.gl/OdNQq.
- DCHECK_LE(description_in.size(), static_cast<size_t>(INFOTIPSIZE));
- description = description_in;
- options |= PROPERTIES_DESCRIPTION;
- }
- bool CreateOrUpdateShortcutLink(const FilePath& shortcut_path,
- const ShortcutProperties& properties,
- ShortcutOperation operation) {
- ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::MAY_BLOCK);
- // Make sure the parent directories exist when creating the shortcut.
- if (operation == ShortcutOperation::kCreateAlways &&
- !base::CreateDirectory(shortcut_path.DirName())) {
- DLOG(ERROR) << "CreateDirectory " << shortcut_path.DirName() << " failed";
- return false;
- }
- // A target is required unless |operation| is kUpdateExisting.
- if (operation != ShortcutOperation::kUpdateExisting &&
- !(properties.options & ShortcutProperties::PROPERTIES_TARGET)) {
- NOTREACHED();
- return false;
- }
- bool shortcut_existed = PathExists(shortcut_path);
- // Interfaces to the old shortcut when replacing an existing shortcut.
- ComPtr<IShellLink> old_i_shell_link;
- ComPtr<IPersistFile> old_i_persist_file;
- // Interfaces to the shortcut being created/updated.
- ComPtr<IShellLink> i_shell_link;
- ComPtr<IPersistFile> i_persist_file;
- switch (operation) {
- case ShortcutOperation::kCreateAlways:
- InitializeShortcutInterfaces(nullptr, &i_shell_link, &i_persist_file);
- break;
- case ShortcutOperation::kUpdateExisting:
- InitializeShortcutInterfaces(shortcut_path.value().c_str(), &i_shell_link,
- &i_persist_file);
- break;
- case ShortcutOperation::kReplaceExisting:
- InitializeShortcutInterfaces(shortcut_path.value().c_str(),
- &old_i_shell_link, &old_i_persist_file);
- // Confirm |shortcut_path| exists and is a shortcut by verifying
- // |old_i_persist_file| was successfully initialized in the call above. If
- // so, initialize the interfaces to begin writing a new shortcut (to
- // overwrite the current one if successful).
- if (old_i_persist_file.Get())
- InitializeShortcutInterfaces(nullptr, &i_shell_link, &i_persist_file);
- break;
- default:
- NOTREACHED();
- }
- // Return false immediately upon failure to initialize shortcut interfaces.
- if (!i_persist_file.Get())
- return false;
- if ((properties.options & ShortcutProperties::PROPERTIES_TARGET) &&
- FAILED(i_shell_link->SetPath(properties.target.value().c_str()))) {
- return false;
- }
- if ((properties.options & ShortcutProperties::PROPERTIES_WORKING_DIR) &&
- FAILED(i_shell_link->SetWorkingDirectory(
- properties.working_dir.value().c_str()))) {
- return false;
- }
- if (properties.options & ShortcutProperties::PROPERTIES_ARGUMENTS) {
- if (FAILED(i_shell_link->SetArguments(properties.arguments.c_str())))
- return false;
- } else if (old_i_persist_file.Get()) {
- wchar_t current_arguments[MAX_PATH] = {0};
- if (SUCCEEDED(
- old_i_shell_link->GetArguments(current_arguments, MAX_PATH))) {
- i_shell_link->SetArguments(current_arguments);
- }
- }
- if ((properties.options & ShortcutProperties::PROPERTIES_DESCRIPTION) &&
- FAILED(i_shell_link->SetDescription(properties.description.c_str()))) {
- return false;
- }
- if ((properties.options & ShortcutProperties::PROPERTIES_ICON) &&
- FAILED(i_shell_link->SetIconLocation(properties.icon.value().c_str(),
- properties.icon_index))) {
- return false;
- }
- bool has_app_id =
- (properties.options & ShortcutProperties::PROPERTIES_APP_ID) != 0;
- bool has_dual_mode =
- (properties.options & ShortcutProperties::PROPERTIES_DUAL_MODE) != 0;
- bool has_toast_activator_clsid =
- (properties.options &
- ShortcutProperties::PROPERTIES_TOAST_ACTIVATOR_CLSID) != 0;
- if (has_app_id || has_dual_mode || has_toast_activator_clsid) {
- ComPtr<IPropertyStore> property_store;
- if (FAILED(i_shell_link.As(&property_store)) || !property_store.Get())
- return false;
- if (has_app_id && !SetAppIdForPropertyStore(property_store.Get(),
- properties.app_id.c_str())) {
- return false;
- }
- if (has_dual_mode && !SetBooleanValueForPropertyStore(
- property_store.Get(), PKEY_AppUserModel_IsDualMode,
- properties.dual_mode)) {
- return false;
- }
- if (has_toast_activator_clsid &&
- !SetClsidForPropertyStore(property_store.Get(),
- PKEY_AppUserModel_ToastActivatorCLSID,
- properties.toast_activator_clsid)) {
- return false;
- }
- }
- // Release the interfaces to the old shortcut to make sure it doesn't prevent
- // overwriting it if needed.
- old_i_persist_file.Reset();
- old_i_shell_link.Reset();
- HRESULT result = i_persist_file->Save(shortcut_path.value().c_str(), TRUE);
- // Release the interfaces in case the SHChangeNotify call below depends on
- // the operations above being fully completed.
- i_persist_file.Reset();
- i_shell_link.Reset();
- // If we successfully created/updated the icon, notify the shell that we have
- // done so.
- if (!SUCCEEDED(result))
- return false;
- SHChangeNotify(shortcut_existed ? SHCNE_UPDATEITEM : SHCNE_CREATE,
- SHCNF_PATH | SHCNF_FLUSH, shortcut_path.value().c_str(),
- nullptr);
- return true;
- }
- bool ResolveShortcutProperties(const FilePath& shortcut_path,
- uint32_t options,
- ShortcutProperties* properties) {
- DCHECK(options && properties);
- ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::MAY_BLOCK);
- if (options & ~ShortcutProperties::PROPERTIES_ALL)
- NOTREACHED() << "Unhandled property is used.";
- ComPtr<IShellLink> i_shell_link;
- // Get pointer to the IShellLink interface.
- if (FAILED(::CoCreateInstance(CLSID_ShellLink, nullptr, CLSCTX_INPROC_SERVER,
- IID_PPV_ARGS(&i_shell_link)))) {
- return false;
- }
- ComPtr<IPersistFile> persist;
- // Query IShellLink for the IPersistFile interface.
- if (FAILED(i_shell_link.As(&persist)))
- return false;
- // Load the shell link.
- if (FAILED(persist->Load(shortcut_path.value().c_str(), STGM_READ)))
- return false;
- // Reset |properties|.
- properties->options = 0;
- wchar_t temp[MAX_PATH];
- if (options & ShortcutProperties::PROPERTIES_TARGET) {
- if (FAILED(
- i_shell_link->GetPath(temp, MAX_PATH, nullptr, SLGP_UNCPRIORITY))) {
- return false;
- }
- properties->set_target(FilePath(temp));
- }
- if (options & ShortcutProperties::PROPERTIES_WORKING_DIR) {
- if (FAILED(i_shell_link->GetWorkingDirectory(temp, MAX_PATH)))
- return false;
- properties->set_working_dir(FilePath(temp));
- }
- if (options & ShortcutProperties::PROPERTIES_ARGUMENTS) {
- if (FAILED(i_shell_link->GetArguments(temp, MAX_PATH)))
- return false;
- properties->set_arguments(temp);
- }
- if (options & ShortcutProperties::PROPERTIES_DESCRIPTION) {
- // Note: description length constrained by MAX_PATH.
- if (FAILED(i_shell_link->GetDescription(temp, MAX_PATH)))
- return false;
- properties->set_description(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);
- }
- if (options & (ShortcutProperties::PROPERTIES_APP_ID |
- ShortcutProperties::PROPERTIES_DUAL_MODE |
- ShortcutProperties::PROPERTIES_TOAST_ACTIVATOR_CLSID)) {
- ComPtr<IPropertyStore> property_store;
- if (FAILED(i_shell_link.As(&property_store)))
- return false;
- if (options & ShortcutProperties::PROPERTIES_APP_ID) {
- ScopedPropVariant pv_app_id;
- if (property_store->GetValue(PKEY_AppUserModel_ID, pv_app_id.Receive()) !=
- S_OK) {
- return false;
- }
- switch (pv_app_id.get().vt) {
- case VT_EMPTY:
- properties->set_app_id(std::wstring());
- break;
- case VT_LPWSTR:
- properties->set_app_id(pv_app_id.get().pwszVal);
- break;
- default:
- NOTREACHED() << "Unexpected variant type: " << pv_app_id.get().vt;
- return false;
- }
- }
- if (options & ShortcutProperties::PROPERTIES_DUAL_MODE) {
- ScopedPropVariant pv_dual_mode;
- if (property_store->GetValue(PKEY_AppUserModel_IsDualMode,
- pv_dual_mode.Receive()) != S_OK) {
- return false;
- }
- switch (pv_dual_mode.get().vt) {
- case VT_EMPTY:
- properties->set_dual_mode(false);
- break;
- case VT_BOOL:
- properties->set_dual_mode(pv_dual_mode.get().boolVal == VARIANT_TRUE);
- break;
- default:
- NOTREACHED() << "Unexpected variant type: " << pv_dual_mode.get().vt;
- return false;
- }
- }
- if (options & ShortcutProperties::PROPERTIES_TOAST_ACTIVATOR_CLSID) {
- ScopedPropVariant pv_toast_activator_clsid;
- if (property_store->GetValue(PKEY_AppUserModel_ToastActivatorCLSID,
- pv_toast_activator_clsid.Receive()) !=
- S_OK) {
- return false;
- }
- switch (pv_toast_activator_clsid.get().vt) {
- case VT_EMPTY:
- properties->set_toast_activator_clsid(CLSID_NULL);
- break;
- case VT_CLSID:
- properties->set_toast_activator_clsid(
- *(pv_toast_activator_clsid.get().puuid));
- break;
- default:
- NOTREACHED() << "Unexpected variant type: "
- << pv_toast_activator_clsid.get().vt;
- return false;
- }
- }
- }
- return true;
- }
- bool ResolveShortcut(const FilePath& shortcut_path,
- FilePath* target_path,
- std::wstring* args) {
- uint32_t options = 0;
- if (target_path)
- options |= ShortcutProperties::PROPERTIES_TARGET;
- if (args)
- options |= ShortcutProperties::PROPERTIES_ARGUMENTS;
- DCHECK(options);
- ShortcutProperties properties;
- if (!ResolveShortcutProperties(shortcut_path, options, &properties))
- return false;
- if (target_path)
- *target_path = properties.target;
- if (args)
- *args = properties.arguments;
- return true;
- }
- } // namespace win
- } // namespace base
|