blob: 6b56b7f52312962b3a1cd4b9bd8881a4be74b9dd [file] [log] [blame]
// 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 "ui/base/win/shell.h"
#include <dwmapi.h>
#include <shlobj.h> // Must be before propkey.
#include <propkey.h>
#include <shellapi.h>
#include <wrl/client.h>
#include "base/command_line.h"
#include "base/debug/alias.h"
#include "base/files/file.h"
#include "base/files/file_path.h"
#include "base/native_library.h"
#include "base/strings/string_util.h"
#include "base/strings/stringprintf.h"
#include "base/threading/scoped_blocking_call.h"
#include "base/threading/scoped_thread_priority.h"
#include "base/win/win_util.h"
#include "base/win/windows_version.h"
#include "ui/base/ui_base_switches.h"
namespace ui {
namespace win {
namespace {
// Default ShellExecuteEx flags used with "openas", "explore", and default
// verbs.
// SEE_MASK_NOASYNC is specified so that ShellExecuteEx can be invoked from a
// thread whose message loop may not wait around long enough for the
// asynchronous tasks initiated by ShellExecuteEx to complete. Using this flag
// causes ShellExecuteEx() to block until these tasks complete.
const DWORD kDefaultShellExecuteFlags = SEE_MASK_NOASYNC;
// Invokes ShellExecuteExW() with the given parameters.
bool InvokeShellExecute(const base::string16 path,
const base::string16 working_directory,
const base::string16 args,
const base::string16 verb,
DWORD mask) {
base::ScopedBlockingCall scoped_blocking_call(FROM_HERE,
SHELLEXECUTEINFO sei = {sizeof(sei)};
sei.fMask = mask;
sei.nShow = SW_SHOWNORMAL;
sei.lpVerb = (verb.empty() ? nullptr : verb.c_str());
sei.lpFile = path.c_str();
sei.lpDirectory =
(working_directory.empty() ? nullptr : working_directory.c_str());
sei.lpParameters = (args.empty() ? nullptr : args.c_str());
// Mitigate the issues caused by loading DLLs on a background thread
// (http://crbug/973868).
base::ScopedThreadMayLoadLibraryOnBackgroundThread priority_boost(FROM_HERE);
return ::ShellExecuteExW(&sei);
} // namespace
bool OpenFileViaShell(const base::FilePath& full_path) {
// Invoke the default verb on the file with no arguments.
return InvokeShellExecute(full_path.value(), full_path.DirName().value(),
base::string16(), base::string16(),
bool OpenFolderViaShell(const base::FilePath& full_path) {
// The "explore" verb causes the folder at |full_path| to be displayed in a
// file browser. This will fail if |full_path| is not a directory.
return InvokeShellExecute(full_path.value(), full_path.value(),
base::string16(), L"explore",
bool PreventWindowFromPinning(HWND hwnd) {
Microsoft::WRL::ComPtr<IPropertyStore> pps;
SHGetPropertyStoreForWindow(hwnd, IID_PPV_ARGS(pps.GetAddressOf()))))
return false;
return base::win::SetBooleanValueForPropertyStore(
pps.Get(), PKEY_AppUserModel_PreventPinning, true);
// TODO(calamity): investigate moving this out of the UI thread as COM
// operations may spawn nested run loops which can cause issues.
void SetAppDetailsForWindow(const base::string16& app_id,
const base::FilePath& app_icon_path,
int app_icon_index,
const base::string16& relaunch_command,
const base::string16& relaunch_display_name,
HWND hwnd) {
Microsoft::WRL::ComPtr<IPropertyStore> pps;
SHGetPropertyStoreForWindow(hwnd, IID_PPV_ARGS(pps.GetAddressOf()))))
if (!app_id.empty())
base::win::SetAppIdForPropertyStore(pps.Get(), app_id.c_str());
if (!app_icon_path.empty()) {
// Always add the icon index explicitly to prevent bad interaction with the
// index notation when file path has commas.
pps.Get(), PKEY_AppUserModel_RelaunchIconResource,
base::StringPrintf(L"%ls,%d", app_icon_path.value().c_str(),
if (!relaunch_command.empty()) {
pps.Get(), PKEY_AppUserModel_RelaunchCommand,
if (!relaunch_display_name.empty()) {
pps.Get(), PKEY_AppUserModel_RelaunchDisplayNameResource,
void SetAppIdForWindow(const base::string16& app_id, HWND hwnd) {
SetAppDetailsForWindow(app_id, base::FilePath(), 0, base::string16(),
base::string16(), hwnd);
void SetAppIconForWindow(const base::FilePath& app_icon_path,
int app_icon_index,
HWND hwnd) {
SetAppDetailsForWindow(base::string16(), app_icon_path, app_icon_index,
base::string16(), base::string16(), hwnd);
void SetRelaunchDetailsForWindow(const base::string16& relaunch_command,
const base::string16& display_name,
HWND hwnd) {
SetAppDetailsForWindow(base::string16(), base::FilePath(), 0,
relaunch_command, display_name, hwnd);
void ClearWindowPropertyStore(HWND hwnd) {
Microsoft::WRL::ComPtr<IPropertyStore> pps;
SHGetPropertyStoreForWindow(hwnd, IID_PPV_ARGS(pps.GetAddressOf()))))
DWORD property_count;
if (FAILED(pps->GetCount(&property_count)))
PROPVARIANT empty_property_variant = {};
for (DWORD i = property_count; i > 0; i--) {
if (SUCCEEDED(pps->GetAt(i - 1, &key))) {
// Removes the value from |pps|'s array.
pps->SetValue(key, empty_property_variant);
if (FAILED(pps->Commit()))
// Verify none of the keys are leaking.
DCHECK(FAILED(pps->GetCount(&property_count)) || property_count == 0);
bool IsAeroGlassEnabled() {
// For testing in Win8 (where it is not possible to disable composition) the
// user can specify this command line switch to mimic the behavior. In this
// mode, cross-HWND transparency is not supported and various types of
// widgets fallback to more simplified rendering behavior.
if (base::CommandLine::ForCurrentProcess()->HasSwitch(
return false;
// If composition is not enabled, we behave like on XP.
return IsDwmCompositionEnabled();
bool IsDwmCompositionEnabled() {
// As of Windows 8, DWM composition is always enabled.
// In Windows 7 this can change at runtime.
if (base::win::GetVersion() >= base::win::Version::WIN8) {
return true;
BOOL is_enabled;
return SUCCEEDED(DwmIsCompositionEnabled(&is_enabled)) && is_enabled;
} // namespace win
} // namespace ui