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 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585
|
// 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 "chrome/browser/shell_integration.h"
#include <windows.h>
#include <shlwapi.h>
#include <shobjidl.h>
#include <propkey.h> // Needs to come after shobjidl.h.
#include "base/bind.h"
#include "base/command_line.h"
#include "base/files/file_enumerator.h"
#include "base/files/file_util.h"
#include "base/message_loop/message_loop.h"
#include "base/path_service.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/string_util.h"
#include "base/strings/stringprintf.h"
#include "base/strings/utf_string_conversions.h"
#include "base/win/registry.h"
#include "base/win/scoped_comptr.h"
#include "base/win/scoped_propvariant.h"
#include "base/win/shortcut.h"
#include "base/win/windows_version.h"
#include "chrome/browser/policy/policy_path_parser.h"
#include "chrome/browser/web_applications/web_app.h"
#include "chrome/common/chrome_constants.h"
#include "chrome/common/chrome_paths_internal.h"
#include "chrome/common/chrome_switches.h"
#include "chrome/installer/setup/setup_util.h"
#include "chrome/installer/util/browser_distribution.h"
#include "chrome/installer/util/create_reg_key_work_item.h"
#include "chrome/installer/util/install_util.h"
#include "chrome/installer/util/set_reg_value_work_item.h"
#include "chrome/installer/util/shell_util.h"
#include "chrome/installer/util/util_constants.h"
#include "chrome/installer/util/work_item.h"
#include "chrome/installer/util/work_item_list.h"
#include "content/public/browser/browser_thread.h"
using content::BrowserThread;
namespace {
const wchar_t kAppListAppNameSuffix[] = L"AppList";
// Helper function for ShellIntegration::GetAppId to generates profile id
// from profile path. "profile_id" is composed of sanitized basenames of
// user data dir and profile dir joined by a ".".
base::string16 GetProfileIdFromPath(const base::FilePath& profile_path) {
// Return empty string if profile_path is empty
if (profile_path.empty())
return base::string16();
base::FilePath default_user_data_dir;
// Return empty string if profile_path is in default user data
// dir and is the default profile.
if (chrome::GetDefaultUserDataDirectory(&default_user_data_dir) &&
profile_path.DirName() == default_user_data_dir &&
profile_path.BaseName().value() ==
base::ASCIIToUTF16(chrome::kInitialProfile)) {
return base::string16();
}
// Get joined basenames of user data dir and profile.
base::string16 basenames = profile_path.DirName().BaseName().value() +
L"." + profile_path.BaseName().value();
base::string16 profile_id;
profile_id.reserve(basenames.size());
// Generate profile_id from sanitized basenames.
for (size_t i = 0; i < basenames.length(); ++i) {
if (IsAsciiAlpha(basenames[i]) ||
IsAsciiDigit(basenames[i]) ||
basenames[i] == L'.')
profile_id += basenames[i];
}
return profile_id;
}
base::string16 GetAppListAppName() {
BrowserDistribution* dist = BrowserDistribution::GetDistribution();
base::string16 app_name(dist->GetBaseAppId());
app_name.append(kAppListAppNameSuffix);
return app_name;
}
// Gets expected app id for given Chrome (based on |command_line| and
// |is_per_user_install|).
base::string16 GetExpectedAppId(const base::CommandLine& command_line,
bool is_per_user_install) {
base::FilePath user_data_dir;
if (command_line.HasSwitch(switches::kUserDataDir))
user_data_dir = command_line.GetSwitchValuePath(switches::kUserDataDir);
else
chrome::GetDefaultUserDataDirectory(&user_data_dir);
// Adjust with any policy that overrides any other way to set the path.
policy::path_parser::CheckUserDataDirPolicy(&user_data_dir);
DCHECK(!user_data_dir.empty());
base::FilePath profile_subdir;
if (command_line.HasSwitch(switches::kProfileDirectory)) {
profile_subdir =
command_line.GetSwitchValuePath(switches::kProfileDirectory);
} else {
profile_subdir =
base::FilePath(base::ASCIIToUTF16(chrome::kInitialProfile));
}
DCHECK(!profile_subdir.empty());
base::FilePath profile_path = user_data_dir.Append(profile_subdir);
base::string16 app_name;
if (command_line.HasSwitch(switches::kApp)) {
app_name = base::UTF8ToUTF16(web_app::GenerateApplicationNameFromURL(
GURL(command_line.GetSwitchValueASCII(switches::kApp))));
} else if (command_line.HasSwitch(switches::kAppId)) {
app_name = base::UTF8ToUTF16(
web_app::GenerateApplicationNameFromExtensionId(
command_line.GetSwitchValueASCII(switches::kAppId)));
} else if (command_line.HasSwitch(switches::kShowAppList)) {
app_name = GetAppListAppName();
} else {
BrowserDistribution* dist = BrowserDistribution::GetDistribution();
app_name = ShellUtil::GetBrowserModelId(dist, is_per_user_install);
}
DCHECK(!app_name.empty());
return ShellIntegration::GetAppModelIdForProfile(app_name, profile_path);
}
void MigrateChromiumShortcutsCallback() {
// This should run on the file thread.
DCHECK(BrowserThread::CurrentlyOn(BrowserThread::FILE));
// Get full path of chrome.
base::FilePath chrome_exe;
if (!PathService::Get(base::FILE_EXE, &chrome_exe))
return;
// Locations to check for shortcuts migration.
static const struct {
int location_id;
const wchar_t* sub_dir;
} kLocations[] = {
{
base::DIR_TASKBAR_PINS,
NULL
}, {
base::DIR_USER_DESKTOP,
NULL
}, {
base::DIR_START_MENU,
NULL
}, {
base::DIR_APP_DATA,
L"Microsoft\\Internet Explorer\\Quick Launch\\User Pinned\\StartMenu"
}
};
for (int i = 0; i < arraysize(kLocations); ++i) {
base::FilePath path;
if (!PathService::Get(kLocations[i].location_id, &path)) {
NOTREACHED();
continue;
}
if (kLocations[i].sub_dir)
path = path.Append(kLocations[i].sub_dir);
bool check_dual_mode = (kLocations[i].location_id == base::DIR_START_MENU);
ShellIntegration::MigrateShortcutsInPathInternal(chrome_exe, path,
check_dual_mode);
}
}
// Windows 8 introduced a new protocol->executable binding system which cannot
// be retrieved in the HKCR registry subkey method implemented below. We call
// AssocQueryString with the new Win8-only flag ASSOCF_IS_PROTOCOL instead.
base::string16 GetAppForProtocolUsingAssocQuery(const GURL& url) {
base::string16 url_scheme = base::ASCIIToUTF16(url.scheme());
// Don't attempt to query protocol association on an empty string.
if (url_scheme.empty())
return base::string16();
// Query AssocQueryString for a human-readable description of the program
// that will be invoked given the provided URL spec. This is used only to
// populate the external protocol dialog box the user sees when invoking
// an unknown external protocol.
wchar_t out_buffer[1024];
DWORD buffer_size = arraysize(out_buffer);
HRESULT hr = AssocQueryString(ASSOCF_IS_PROTOCOL,
ASSOCSTR_FRIENDLYAPPNAME,
url_scheme.c_str(),
NULL,
out_buffer,
&buffer_size);
if (FAILED(hr)) {
DLOG(WARNING) << "AssocQueryString failed!";
return base::string16();
}
return base::string16(out_buffer);
}
base::string16 GetAppForProtocolUsingRegistry(const GURL& url) {
base::string16 url_spec = base::ASCIIToUTF16(url.possibly_invalid_spec());
const base::string16 cmd_key_path =
base::ASCIIToUTF16(url.scheme() + "\\shell\\open\\command");
base::win::RegKey cmd_key(HKEY_CLASSES_ROOT,
cmd_key_path.c_str(),
KEY_READ);
size_t split_offset = url_spec.find(L':');
if (split_offset == base::string16::npos)
return base::string16();
const base::string16 parameters = url_spec.substr(split_offset + 1,
url_spec.length() - 1);
base::string16 application_to_launch;
if (cmd_key.ReadValue(NULL, &application_to_launch) == ERROR_SUCCESS) {
ReplaceSubstringsAfterOffset(&application_to_launch,
0,
L"%1",
parameters);
return application_to_launch;
}
return base::string16();
}
ShellIntegration::DefaultWebClientState
GetDefaultWebClientStateFromShellUtilDefaultState(
ShellUtil::DefaultState default_state) {
switch (default_state) {
case ShellUtil::NOT_DEFAULT:
return ShellIntegration::NOT_DEFAULT;
case ShellUtil::IS_DEFAULT:
return ShellIntegration::IS_DEFAULT;
default:
DCHECK_EQ(ShellUtil::UNKNOWN_DEFAULT, default_state);
return ShellIntegration::UNKNOWN_DEFAULT;
}
}
} // namespace
ShellIntegration::DefaultWebClientSetPermission
ShellIntegration::CanSetAsDefaultBrowser() {
BrowserDistribution* distribution = BrowserDistribution::GetDistribution();
if (distribution->GetDefaultBrowserControlPolicy() !=
BrowserDistribution::DEFAULT_BROWSER_FULL_CONTROL)
return SET_DEFAULT_NOT_ALLOWED;
if (ShellUtil::CanMakeChromeDefaultUnattended())
return SET_DEFAULT_UNATTENDED;
else
return SET_DEFAULT_INTERACTIVE;
}
bool ShellIntegration::SetAsDefaultBrowser() {
base::FilePath chrome_exe;
if (!PathService::Get(base::FILE_EXE, &chrome_exe)) {
LOG(ERROR) << "Error getting app exe path";
return false;
}
// From UI currently we only allow setting default browser for current user.
BrowserDistribution* dist = BrowserDistribution::GetDistribution();
if (!ShellUtil::MakeChromeDefault(dist, ShellUtil::CURRENT_USER, chrome_exe,
true /* elevate_if_not_admin */)) {
LOG(ERROR) << "Chrome could not be set as default browser.";
return false;
}
VLOG(1) << "Chrome registered as default browser.";
return true;
}
bool ShellIntegration::SetAsDefaultProtocolClient(const std::string& protocol) {
if (protocol.empty())
return false;
base::FilePath chrome_exe;
if (!PathService::Get(base::FILE_EXE, &chrome_exe)) {
LOG(ERROR) << "Error getting app exe path";
return false;
}
base::string16 wprotocol(base::UTF8ToUTF16(protocol));
BrowserDistribution* dist = BrowserDistribution::GetDistribution();
if (!ShellUtil::MakeChromeDefaultProtocolClient(dist, chrome_exe,
wprotocol)) {
LOG(ERROR) << "Chrome could not be set as default handler for "
<< protocol << ".";
return false;
}
VLOG(1) << "Chrome registered as default handler for " << protocol << ".";
return true;
}
bool ShellIntegration::SetAsDefaultBrowserInteractive() {
base::FilePath chrome_exe;
if (!PathService::Get(base::FILE_EXE, &chrome_exe)) {
NOTREACHED() << "Error getting app exe path";
return false;
}
BrowserDistribution* dist = BrowserDistribution::GetDistribution();
if (!ShellUtil::ShowMakeChromeDefaultSystemUI(dist, chrome_exe)) {
LOG(ERROR) << "Failed to launch the set-default-browser Windows UI.";
return false;
}
VLOG(1) << "Set-default-browser Windows UI completed.";
return true;
}
bool ShellIntegration::SetAsDefaultProtocolClientInteractive(
const std::string& protocol) {
base::FilePath chrome_exe;
if (!PathService::Get(base::FILE_EXE, &chrome_exe)) {
NOTREACHED() << "Error getting app exe path";
return false;
}
BrowserDistribution* dist = BrowserDistribution::GetDistribution();
base::string16 wprotocol(base::UTF8ToUTF16(protocol));
if (!ShellUtil::ShowMakeChromeDefaultProtocolClientSystemUI(dist, chrome_exe,
wprotocol)) {
LOG(ERROR) << "Failed to launch the set-default-client Windows UI.";
return false;
}
VLOG(1) << "Set-default-client Windows UI completed.";
return true;
}
ShellIntegration::DefaultWebClientState ShellIntegration::GetDefaultBrowser() {
return GetDefaultWebClientStateFromShellUtilDefaultState(
ShellUtil::GetChromeDefaultState());
}
ShellIntegration::DefaultWebClientState
ShellIntegration::IsDefaultProtocolClient(const std::string& protocol) {
return GetDefaultWebClientStateFromShellUtilDefaultState(
ShellUtil::GetChromeDefaultProtocolClientState(
base::UTF8ToUTF16(protocol)));
}
base::string16 ShellIntegration::GetApplicationNameForProtocol(
const GURL& url) {
// Windows 8 or above requires a new protocol association query.
if (base::win::GetVersion() >= base::win::VERSION_WIN8)
return GetAppForProtocolUsingAssocQuery(url);
else
return GetAppForProtocolUsingRegistry(url);
}
// There is no reliable way to say which browser is default on a machine (each
// browser can have some of the protocols/shortcuts). So we look for only HTTP
// protocol handler. Even this handler is located at different places in
// registry on XP and Vista:
// - HKCR\http\shell\open\command (XP)
// - HKCU\Software\Microsoft\Windows\Shell\Associations\UrlAssociations\
// http\UserChoice (Vista)
// This method checks if Firefox is defualt browser by checking these
// locations and returns true if Firefox traces are found there. In case of
// error (or if Firefox is not found)it returns the default value which
// is false.
bool ShellIntegration::IsFirefoxDefaultBrowser() {
bool ff_default = false;
if (base::win::GetVersion() >= base::win::VERSION_VISTA) {
base::string16 app_cmd;
base::win::RegKey key(HKEY_CURRENT_USER,
ShellUtil::kRegVistaUrlPrefs, KEY_READ);
if (key.Valid() && (key.ReadValue(L"Progid", &app_cmd) == ERROR_SUCCESS) &&
app_cmd == L"FirefoxURL")
ff_default = true;
} else {
base::string16 key_path(L"http");
key_path.append(ShellUtil::kRegShellOpen);
base::win::RegKey key(HKEY_CLASSES_ROOT, key_path.c_str(), KEY_READ);
base::string16 app_cmd;
if (key.Valid() && (key.ReadValue(L"", &app_cmd) == ERROR_SUCCESS) &&
base::string16::npos !=
base::StringToLowerASCII(app_cmd).find(L"firefox"))
ff_default = true;
}
return ff_default;
}
base::string16 ShellIntegration::GetAppModelIdForProfile(
const base::string16& app_name,
const base::FilePath& profile_path) {
std::vector<base::string16> components;
components.push_back(app_name);
const base::string16 profile_id(GetProfileIdFromPath(profile_path));
if (!profile_id.empty())
components.push_back(profile_id);
return ShellUtil::BuildAppModelId(components);
}
base::string16 ShellIntegration::GetChromiumModelIdForProfile(
const base::FilePath& profile_path) {
BrowserDistribution* dist = BrowserDistribution::GetDistribution();
base::FilePath chrome_exe;
if (!PathService::Get(base::FILE_EXE, &chrome_exe)) {
NOTREACHED();
return dist->GetBaseAppId();
}
return GetAppModelIdForProfile(
ShellUtil::GetBrowserModelId(dist,
InstallUtil::IsPerUserInstall(chrome_exe)),
profile_path);
}
base::string16 ShellIntegration::GetAppListAppModelIdForProfile(
const base::FilePath& profile_path) {
return ShellIntegration::GetAppModelIdForProfile(
GetAppListAppName(), profile_path);
}
void ShellIntegration::MigrateChromiumShortcuts() {
if (base::win::GetVersion() < base::win::VERSION_WIN7)
return;
// This needs to happen eventually (e.g. so that the appid is fixed and the
// run-time Chrome icon is merged with the taskbar shortcut), but this is not
// urgent and shouldn't delay Chrome startup.
static const int64 kMigrateChromiumShortcutsDelaySeconds = 15;
BrowserThread::PostDelayedTask(
BrowserThread::FILE, FROM_HERE,
base::Bind(&MigrateChromiumShortcutsCallback),
base::TimeDelta::FromSeconds(kMigrateChromiumShortcutsDelaySeconds));
}
int ShellIntegration::MigrateShortcutsInPathInternal(
const base::FilePath& chrome_exe,
const base::FilePath& path,
bool check_dual_mode) {
DCHECK(base::win::GetVersion() >= base::win::VERSION_WIN7);
// Enumerate all pinned shortcuts in the given path directly.
base::FileEnumerator shortcuts_enum(
path, false, // not recursive
base::FileEnumerator::FILES, FILE_PATH_LITERAL("*.lnk"));
bool is_per_user_install = InstallUtil::IsPerUserInstall(chrome_exe);
int shortcuts_migrated = 0;
base::FilePath target_path;
base::string16 arguments;
base::win::ScopedPropVariant propvariant;
for (base::FilePath shortcut = shortcuts_enum.Next(); !shortcut.empty();
shortcut = shortcuts_enum.Next()) {
// TODO(gab): Use ProgramCompare instead of comparing FilePaths below once
// it is fixed to work with FilePaths with spaces.
if (!base::win::ResolveShortcut(shortcut, &target_path, &arguments) ||
chrome_exe != target_path) {
continue;
}
base::CommandLine command_line(
base::CommandLine::FromString(base::StringPrintf(
L"\"%ls\" %ls", target_path.value().c_str(), arguments.c_str())));
// Get the expected AppId for this Chrome shortcut.
base::string16 expected_app_id(
GetExpectedAppId(command_line, is_per_user_install));
if (expected_app_id.empty())
continue;
// Load the shortcut.
base::win::ScopedComPtr<IShellLink> shell_link;
base::win::ScopedComPtr<IPersistFile> persist_file;
if (FAILED(shell_link.CreateInstance(CLSID_ShellLink, NULL,
CLSCTX_INPROC_SERVER)) ||
FAILED(persist_file.QueryFrom(shell_link.get())) ||
FAILED(persist_file->Load(shortcut.value().c_str(), STGM_READ))) {
DLOG(WARNING) << "Failed loading shortcut at " << shortcut.value();
continue;
}
// Any properties that need to be updated on the shortcut will be stored in
// |updated_properties|.
base::win::ShortcutProperties updated_properties;
// Validate the existing app id for the shortcut.
base::win::ScopedComPtr<IPropertyStore> property_store;
propvariant.Reset();
if (FAILED(property_store.QueryFrom(shell_link.get())) ||
property_store->GetValue(PKEY_AppUserModel_ID, propvariant.Receive()) !=
S_OK) {
// When in doubt, prefer not updating the shortcut.
NOTREACHED();
continue;
} else {
switch (propvariant.get().vt) {
case VT_EMPTY:
// If there is no app_id set, set our app_id if one is expected.
if (!expected_app_id.empty())
updated_properties.set_app_id(expected_app_id);
break;
case VT_LPWSTR:
if (expected_app_id != base::string16(propvariant.get().pwszVal))
updated_properties.set_app_id(expected_app_id);
break;
default:
NOTREACHED();
continue;
}
}
// Only set dual mode if the expected app id is the default app id.
BrowserDistribution* dist = BrowserDistribution::GetDistribution();
base::string16 default_chromium_model_id(
ShellUtil::GetBrowserModelId(dist, is_per_user_install));
if (check_dual_mode && expected_app_id == default_chromium_model_id) {
propvariant.Reset();
if (property_store->GetValue(PKEY_AppUserModel_IsDualMode,
propvariant.Receive()) != S_OK) {
// When in doubt, prefer to not update the shortcut.
NOTREACHED();
continue;
} else {
switch (propvariant.get().vt) {
case VT_EMPTY:
// If dual_mode is not set at all, make sure it gets set to true.
updated_properties.set_dual_mode(true);
break;
case VT_BOOL:
// If it is set to false, make sure it gets set to true as well.
if (!propvariant.get().boolVal)
updated_properties.set_dual_mode(true);
break;
default:
NOTREACHED();
continue;
}
}
}
persist_file.Release();
shell_link.Release();
// Update the shortcut if some of its properties need to be updated.
if (updated_properties.options &&
base::win::CreateOrUpdateShortcutLink(
shortcut, updated_properties,
base::win::SHORTCUT_UPDATE_EXISTING)) {
++shortcuts_migrated;
}
}
return shortcuts_migrated;
}
base::FilePath ShellIntegration::GetStartMenuShortcut(
const base::FilePath& chrome_exe) {
static const int kFolderIds[] = {
base::DIR_COMMON_START_MENU,
base::DIR_START_MENU,
};
BrowserDistribution* dist = BrowserDistribution::GetDistribution();
base::string16 shortcut_name(
dist->GetShortcutName(BrowserDistribution::SHORTCUT_CHROME));
base::FilePath shortcut;
// Check both the common and the per-user Start Menu folders for system-level
// installs.
size_t folder = InstallUtil::IsPerUserInstall(chrome_exe) ? 1 : 0;
for (; folder < arraysize(kFolderIds); ++folder) {
if (!PathService::Get(kFolderIds[folder], &shortcut)) {
NOTREACHED();
continue;
}
shortcut = shortcut.Append(shortcut_name).Append(shortcut_name +
installer::kLnkExt);
if (base::PathExists(shortcut))
return shortcut;
}
return base::FilePath();
}
|