This source file includes following definitions.
- LogShortcutOperation
- ExecuteAndLogShortcutOperation
- AddChromeToMediaPlayerList
- CopyPreferenceFileForFirstRun
- InstallNewVersion
- CleanupLegacyShortcuts
- GetAppLauncherShortcutOperation
- EscapeXmlAttributeValueInSingleQuotes
- CreateVisualElementsManifest
- CreateOrUpdateShortcuts
- RegisterChromeOnMachine
- InstallOrUpdateProduct
- HandleOsUpgradeForBrowser
- HandleActiveSetupForBrowser
- InstallFromWebstore
#include "chrome/installer/setup/install.h"
#include <windows.h>
#include <shlobj.h>
#include <time.h>
#include <string>
#include "base/command_line.h"
#include "base/file_util.h"
#include "base/files/file_path.h"
#include "base/logging.h"
#include "base/memory/scoped_ptr.h"
#include "base/numerics/safe_conversions.h"
#include "base/path_service.h"
#include "base/process/launch.h"
#include "base/strings/string_util.h"
#include "base/strings/stringprintf.h"
#include "base/strings/utf_string_conversions.h"
#include "base/win/shortcut.h"
#include "base/win/windows_version.h"
#include "chrome/common/chrome_constants.h"
#include "chrome/common/chrome_switches.h"
#include "chrome/installer/launcher_support/chrome_launcher_support.h"
#include "chrome/installer/setup/install_worker.h"
#include "chrome/installer/setup/setup_constants.h"
#include "chrome/installer/util/auto_launch_util.h"
#include "chrome/installer/util/browser_distribution.h"
#include "chrome/installer/util/create_reg_key_work_item.h"
#include "chrome/installer/util/delete_after_reboot_helper.h"
#include "chrome/installer/util/google_update_constants.h"
#include "chrome/installer/util/helper.h"
#include "chrome/installer/util/install_util.h"
#include "chrome/installer/util/master_preferences.h"
#include "chrome/installer/util/master_preferences_constants.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_list.h"
using base::ASCIIToUTF16;
using base::UTF16ToUTF8;
using installer::InstallerState;
using installer::InstallationState;
using installer::Product;
namespace {
void LogShortcutOperation(ShellUtil::ShortcutLocation location,
BrowserDistribution* dist,
const ShellUtil::ShortcutProperties& properties,
ShellUtil::ShortcutOperation operation,
bool failed) {
DCHECK(operation != ShellUtil::SHELL_SHORTCUT_UPDATE_EXISTING);
std::string message;
if (failed)
message.append("Failed: ");
message.append(
(operation == ShellUtil::SHELL_SHORTCUT_CREATE_ALWAYS ||
operation == ShellUtil::SHELL_SHORTCUT_CREATE_IF_NO_SYSTEM_LEVEL) ?
"Creating " : "Overwriting ");
if (failed && operation == ShellUtil::SHELL_SHORTCUT_REPLACE_EXISTING)
message.append("(maybe the shortcut doesn't exist?) ");
message.append((properties.level == ShellUtil::CURRENT_USER) ? "per-user " :
"all-users ");
switch (location) {
case ShellUtil::SHORTCUT_LOCATION_DESKTOP:
message.append("Desktop ");
break;
case ShellUtil::SHORTCUT_LOCATION_QUICK_LAUNCH:
message.append("Quick Launch ");
break;
case ShellUtil::SHORTCUT_LOCATION_START_MENU_CHROME_DIR:
message.append("Start menu/" +
UTF16ToUTF8(dist->GetStartMenuShortcutSubfolder(
BrowserDistribution::SUBFOLDER_CHROME)) +
" ");
break;
case ShellUtil::SHORTCUT_LOCATION_START_MENU_CHROME_APPS_DIR:
message.append("Start menu/" +
UTF16ToUTF8(dist->GetStartMenuShortcutSubfolder(
BrowserDistribution::SUBFOLDER_APPS)) +
" ");
break;
default:
NOTREACHED();
}
message.push_back('"');
if (properties.has_shortcut_name())
message.append(UTF16ToUTF8(properties.shortcut_name));
else
message.append(UTF16ToUTF8(dist->GetDisplayName()));
message.push_back('"');
message.append(" shortcut to ");
message.append(UTF16ToUTF8(properties.target.value()));
if (properties.has_arguments())
message.append(UTF16ToUTF8(properties.arguments));
if (properties.pin_to_taskbar &&
base::win::GetVersion() >= base::win::VERSION_WIN7) {
message.append(" and pinning to the taskbar.");
} else {
message.push_back('.');
}
if (failed)
LOG(WARNING) << message;
else
VLOG(1) << message;
}
void ExecuteAndLogShortcutOperation(
ShellUtil::ShortcutLocation location,
BrowserDistribution* dist,
const ShellUtil::ShortcutProperties& properties,
ShellUtil::ShortcutOperation operation) {
LogShortcutOperation(location, dist, properties, operation, false);
if (!ShellUtil::CreateOrUpdateShortcut(location, dist, properties,
operation)) {
LogShortcutOperation(location, dist, properties, operation, true);
}
}
void AddChromeToMediaPlayerList() {
base::string16 reg_path(installer::kMediaPlayerRegPath);
reg_path.push_back(base::FilePath::kSeparators[0]);
reg_path.append(installer::kChromeExe);
VLOG(1) << "Adding Chrome to Media player list at " << reg_path;
scoped_ptr<WorkItem> work_item(WorkItem::CreateCreateRegKeyWorkItem(
HKEY_LOCAL_MACHINE, reg_path));
if (!work_item.get()->Do())
LOG(ERROR) << "Could not add Chrome to media player inclusion list.";
}
void CopyPreferenceFileForFirstRun(const InstallerState& installer_state,
const base::FilePath& prefs_source_path) {
base::FilePath prefs_dest_path(installer_state.target_path().AppendASCII(
installer::kDefaultMasterPrefs));
if (!base::CopyFile(prefs_source_path, prefs_dest_path)) {
VLOG(1) << "Failed to copy master preferences from:"
<< prefs_source_path.value() << " gle: " << ::GetLastError();
}
}
installer::InstallStatus InstallNewVersion(
const InstallationState& original_state,
const InstallerState& installer_state,
const base::FilePath& setup_path,
const base::FilePath& archive_path,
const base::FilePath& src_path,
const base::FilePath& temp_path,
const Version& new_version,
scoped_ptr<Version>* current_version) {
DCHECK(current_version);
installer_state.UpdateStage(installer::BUILDING);
current_version->reset(installer_state.GetCurrentVersion(original_state));
scoped_ptr<WorkItemList> install_list(WorkItem::CreateWorkItemList());
AddInstallWorkItems(original_state,
installer_state,
setup_path,
archive_path,
src_path,
temp_path,
current_version->get(),
new_version,
install_list.get());
base::FilePath new_chrome_exe(
installer_state.target_path().Append(installer::kChromeNewExe));
installer_state.UpdateStage(installer::EXECUTING);
if (!install_list->Do()) {
installer_state.UpdateStage(installer::ROLLINGBACK);
installer::InstallStatus result =
base::PathExists(new_chrome_exe) && current_version->get() &&
new_version.Equals(*current_version->get()) ?
installer::SAME_VERSION_REPAIR_FAILED :
installer::INSTALL_FAILED;
LOG(ERROR) << "Install failed, rolling back... result: " << result;
install_list->Rollback();
LOG(ERROR) << "Rollback complete. ";
return result;
}
installer_state.UpdateStage(installer::REFRESHING_POLICY);
installer::RefreshElevationPolicy();
if (!current_version->get()) {
VLOG(1) << "First install of version " << new_version.GetString();
return installer::FIRST_INSTALL_SUCCESS;
}
if (new_version.Equals(**current_version)) {
VLOG(1) << "Install repaired of version " << new_version.GetString();
return installer::INSTALL_REPAIRED;
}
if (new_version.CompareTo(**current_version) > 0) {
if (base::PathExists(new_chrome_exe)) {
VLOG(1) << "Version updated to " << new_version.GetString()
<< " while running " << (*current_version)->GetString();
return installer::IN_USE_UPDATED;
}
VLOG(1) << "Version updated to " << new_version.GetString();
return installer::NEW_VERSION_UPDATED;
}
LOG(ERROR) << "Not sure how we got here while updating"
<< ", new version: " << new_version.GetString()
<< ", old version: " << (*current_version)->GetString();
return installer::INSTALL_FAILED;
}
void CleanupLegacyShortcuts(const InstallerState& installer_state,
BrowserDistribution* dist,
const base::FilePath& chrome_exe) {
ShellUtil::ShellChange shortcut_level = installer_state.system_install() ?
ShellUtil::SYSTEM_LEVEL : ShellUtil::CURRENT_USER;
base::FilePath uninstall_shortcut_path;
ShellUtil::GetShortcutPath(ShellUtil::SHORTCUT_LOCATION_START_MENU_CHROME_DIR,
dist, shortcut_level, &uninstall_shortcut_path);
uninstall_shortcut_path = uninstall_shortcut_path.Append(
dist->GetUninstallLinkName() + installer::kLnkExt);
base::DeleteFile(uninstall_shortcut_path, false);
if (installer_state.system_install()) {
ShellUtil::RemoveShortcuts(
ShellUtil::SHORTCUT_LOCATION_QUICK_LAUNCH, dist,
ShellUtil::SYSTEM_LEVEL, chrome_exe);
}
}
installer::InstallShortcutOperation GetAppLauncherShortcutOperation(
const InstallationState& original_state,
const InstallerState& installer_state) {
const installer::ProductState* original_app_host_state =
original_state.GetProductState(installer_state.system_install(),
BrowserDistribution::CHROME_APP_HOST);
bool app_launcher_exists = original_app_host_state &&
original_app_host_state->uninstall_command()
.HasSwitch(installer::switches::kChromeAppLauncher);
if (!app_launcher_exists)
return installer::INSTALL_SHORTCUT_CREATE_ALL;
return installer::INSTALL_SHORTCUT_REPLACE_EXISTING;
}
}
namespace installer {
void EscapeXmlAttributeValueInSingleQuotes(base::string16* att_value) {
base::ReplaceChars(*att_value, L"&", L"&", att_value);
base::ReplaceChars(*att_value, L"'", L"'", att_value);
base::ReplaceChars(*att_value, L"<", L"<", att_value);
}
bool CreateVisualElementsManifest(const base::FilePath& src_path,
const Version& version) {
base::string16 elements_dir(ASCIIToUTF16(version.GetString()));
elements_dir.push_back(base::FilePath::kSeparators[0]);
elements_dir.append(installer::kVisualElements);
if (!base::PathExists(src_path.Append(elements_dir))) {
VLOG(1) << "No visual elements found, not writing "
<< installer::kVisualElementsManifest << " to " << src_path.value();
return true;
} else {
static const char kManifestTemplate[] =
"<Application>\r\n"
" <VisualElements\r\n"
" DisplayName='%1$ls'\r\n"
" Logo='%2$ls\\Logo.png'\r\n"
" SmallLogo='%2$ls\\SmallLogo.png'\r\n"
" ForegroundText='light'\r\n"
" BackgroundColor='#323232'>\r\n"
" <DefaultTile ShowName='allLogos'/>\r\n"
" <SplashScreen Image='%2$ls\\splash-620x300.png'/>\r\n"
" </VisualElements>\r\n"
"</Application>";
const base::string16 manifest_template(ASCIIToUTF16(kManifestTemplate));
BrowserDistribution* dist = BrowserDistribution::GetSpecificDistribution(
BrowserDistribution::CHROME_BROWSER);
base::string16 display_name(dist->GetDisplayName());
EscapeXmlAttributeValueInSingleQuotes(&display_name);
base::string16 manifest16(base::StringPrintf(
manifest_template.c_str(), display_name.c_str(), elements_dir.c_str()));
const std::string manifest(UTF16ToUTF8(manifest16));
int size = base::checked_cast<int>(manifest.size());
if (base::WriteFile(
src_path.Append(installer::kVisualElementsManifest),
manifest.c_str(), size) == size) {
VLOG(1) << "Successfully wrote " << installer::kVisualElementsManifest
<< " to " << src_path.value();
return true;
} else {
PLOG(ERROR) << "Error writing " << installer::kVisualElementsManifest
<< " to " << src_path.value();
return false;
}
}
}
void CreateOrUpdateShortcuts(
const base::FilePath& target,
const Product& product,
const MasterPreferences& prefs,
InstallShortcutLevel install_level,
InstallShortcutOperation install_operation) {
bool do_not_create_any_shortcuts = false;
prefs.GetBool(master_preferences::kDoNotCreateAnyShortcuts,
&do_not_create_any_shortcuts);
if (do_not_create_any_shortcuts)
return;
bool do_not_create_desktop_shortcut = false;
bool do_not_create_quick_launch_shortcut = false;
bool do_not_create_taskbar_shortcut = false;
bool alternate_desktop_shortcut = false;
prefs.GetBool(master_preferences::kDoNotCreateDesktopShortcut,
&do_not_create_desktop_shortcut);
prefs.GetBool(master_preferences::kDoNotCreateQuickLaunchShortcut,
&do_not_create_quick_launch_shortcut);
prefs.GetBool(master_preferences::kDoNotCreateTaskbarShortcut,
&do_not_create_taskbar_shortcut);
prefs.GetBool(master_preferences::kAltShortcutText,
&alternate_desktop_shortcut);
BrowserDistribution* dist = product.distribution();
ShellUtil::ShortcutOperation shortcut_operation;
switch (install_operation) {
case INSTALL_SHORTCUT_CREATE_ALL:
shortcut_operation = ShellUtil::SHELL_SHORTCUT_CREATE_ALWAYS;
break;
case INSTALL_SHORTCUT_CREATE_EACH_IF_NO_SYSTEM_LEVEL:
shortcut_operation = ShellUtil::SHELL_SHORTCUT_CREATE_IF_NO_SYSTEM_LEVEL;
break;
default:
DCHECK(install_operation == INSTALL_SHORTCUT_REPLACE_EXISTING);
shortcut_operation = ShellUtil::SHELL_SHORTCUT_REPLACE_EXISTING;
break;
}
ShellUtil::ShellChange shortcut_level = (install_level == ALL_USERS ?
ShellUtil::SYSTEM_LEVEL : ShellUtil::CURRENT_USER);
ShellUtil::ShortcutProperties base_properties(shortcut_level);
product.AddDefaultShortcutProperties(target, &base_properties);
if (!do_not_create_desktop_shortcut ||
shortcut_operation == ShellUtil::SHELL_SHORTCUT_REPLACE_EXISTING) {
ShellUtil::ShortcutProperties desktop_properties(base_properties);
if (alternate_desktop_shortcut) {
desktop_properties.set_shortcut_name(
dist->GetShortcutName(
BrowserDistribution::SHORTCUT_CHROME_ALTERNATE));
}
ExecuteAndLogShortcutOperation(
ShellUtil::SHORTCUT_LOCATION_DESKTOP, dist, desktop_properties,
shortcut_operation);
if (!alternate_desktop_shortcut &&
shortcut_operation == ShellUtil::SHELL_SHORTCUT_REPLACE_EXISTING) {
desktop_properties.set_shortcut_name(
dist->GetShortcutName(
BrowserDistribution::SHORTCUT_CHROME_ALTERNATE));
ExecuteAndLogShortcutOperation(
ShellUtil::SHORTCUT_LOCATION_DESKTOP, dist, desktop_properties,
shortcut_operation);
}
}
if (!do_not_create_quick_launch_shortcut ||
shortcut_operation == ShellUtil::SHELL_SHORTCUT_REPLACE_EXISTING) {
ShellUtil::ShortcutProperties quick_launch_properties(base_properties);
quick_launch_properties.level = ShellUtil::CURRENT_USER;
ExecuteAndLogShortcutOperation(
ShellUtil::SHORTCUT_LOCATION_QUICK_LAUNCH, dist,
quick_launch_properties, shortcut_operation);
}
ShellUtil::ShortcutProperties start_menu_properties(base_properties);
start_menu_properties.set_dual_mode(true);
if (!do_not_create_taskbar_shortcut &&
(shortcut_operation == ShellUtil::SHELL_SHORTCUT_CREATE_ALWAYS ||
shortcut_operation ==
ShellUtil::SHELL_SHORTCUT_CREATE_IF_NO_SYSTEM_LEVEL)) {
start_menu_properties.set_pin_to_taskbar(true);
}
ExecuteAndLogShortcutOperation(
ShellUtil::SHORTCUT_LOCATION_START_MENU_CHROME_DIR, dist,
start_menu_properties, shortcut_operation);
}
void RegisterChromeOnMachine(const InstallerState& installer_state,
const Product& product,
bool make_chrome_default) {
DCHECK(product.is_chrome());
AddChromeToMediaPlayerList();
BrowserDistribution* dist = product.distribution();
const base::string16 chrome_exe(
installer_state.target_path().Append(installer::kChromeExe).value());
VLOG(1) << "Registering Chrome as browser: " << chrome_exe;
if (make_chrome_default && ShellUtil::CanMakeChromeDefaultUnattended()) {
int level = ShellUtil::CURRENT_USER;
if (installer_state.system_install())
level = level | ShellUtil::SYSTEM_LEVEL;
ShellUtil::MakeChromeDefault(dist, level, chrome_exe, true);
} else {
ShellUtil::RegisterChromeBrowser(dist, chrome_exe, base::string16(), false);
}
}
InstallStatus InstallOrUpdateProduct(
const InstallationState& original_state,
const InstallerState& installer_state,
const base::FilePath& setup_path,
const base::FilePath& archive_path,
const base::FilePath& install_temp_path,
const base::FilePath& src_path,
const base::FilePath& prefs_path,
const MasterPreferences& prefs,
const Version& new_version) {
DCHECK(!installer_state.products().empty());
LOG_IF(ERROR, !RemoveFromMovesPendingReboot(installer_state.target_path()))
<< "Error accessing pending moves value.";
installer_state.UpdateStage(installer::CREATING_VISUAL_MANIFEST);
CreateVisualElementsManifest(src_path, new_version);
scoped_ptr<Version> existing_version;
InstallStatus result = InstallNewVersion(original_state, installer_state,
setup_path, archive_path, src_path, install_temp_path, new_version,
&existing_version);
if (!InstallUtil::GetInstallReturnCode(result)) {
installer_state.UpdateStage(installer::UPDATING_CHANNELS);
installer_state.UpdateChannels();
installer_state.UpdateStage(installer::COPYING_PREFERENCES_FILE);
if (result == FIRST_INSTALL_SUCCESS && !prefs_path.empty())
CopyPreferenceFileForFirstRun(installer_state, prefs_path);
installer_state.UpdateStage(installer::CREATING_SHORTCUTS);
const Product* app_launcher_product =
installer_state.FindProduct(BrowserDistribution::CHROME_APP_HOST);
if (app_launcher_product) {
DCHECK(!installer_state.system_install());
const base::FilePath app_host_exe(
installer_state.target_path().Append(kChromeAppHostExe));
InstallShortcutOperation app_launcher_shortcut_operation =
GetAppLauncherShortcutOperation(original_state, installer_state);
CreateOrUpdateShortcuts(app_host_exe, *app_launcher_product, prefs,
CURRENT_USER, app_launcher_shortcut_operation);
}
const Product* chrome_product =
installer_state.FindProduct(BrowserDistribution::CHROME_BROWSER);
if (chrome_product) {
BrowserDistribution* chrome_dist = chrome_product->distribution();
const base::FilePath chrome_exe(
installer_state.target_path().Append(kChromeExe));
CleanupLegacyShortcuts(installer_state, chrome_dist, chrome_exe);
InstallShortcutLevel install_level = installer_state.system_install() ?
ALL_USERS : CURRENT_USER;
InstallShortcutOperation install_operation =
INSTALL_SHORTCUT_REPLACE_EXISTING;
if (result == installer::FIRST_INSTALL_SUCCESS ||
result == installer::INSTALL_REPAIRED ||
!original_state.GetProductState(installer_state.system_install(),
chrome_dist->GetType())) {
install_operation = INSTALL_SHORTCUT_CREATE_ALL;
}
CreateOrUpdateShortcuts(chrome_exe, *chrome_product, prefs, install_level,
install_operation);
}
if (chrome_product) {
installer_state.UpdateStage(installer::REGISTERING_CHROME);
bool make_chrome_default = false;
prefs.GetBool(master_preferences::kMakeChromeDefault,
&make_chrome_default);
bool force_chrome_default_for_user = false;
if (result == NEW_VERSION_UPDATED ||
result == INSTALL_REPAIRED) {
prefs.GetBool(master_preferences::kMakeChromeDefaultForUser,
&force_chrome_default_for_user);
}
RegisterChromeOnMachine(installer_state, *chrome_product,
make_chrome_default || force_chrome_default_for_user);
if (result == FIRST_INSTALL_SUCCESS) {
installer_state.UpdateStage(installer::CONFIGURE_AUTO_LAUNCH);
bool auto_launch_chrome = false;
prefs.GetBool(
installer::master_preferences::kAutoLaunchChrome,
&auto_launch_chrome);
if (auto_launch_chrome) {
auto_launch_util::EnableForegroundStartAtLogin(
ASCIIToUTF16(chrome::kInitialProfile),
installer_state.target_path());
}
}
}
installer_state.UpdateStage(installer::REMOVING_OLD_VERSIONS);
installer_state.RemoveOldVersionDirectories(
new_version,
existing_version.get(),
install_temp_path);
}
return result;
}
void HandleOsUpgradeForBrowser(const InstallerState& installer_state,
const Product& chrome) {
DCHECK(chrome.is_chrome());
if (base::win::GetVersion() >= base::win::VERSION_WIN8) {
VLOG(1) << "Updating and registering shortcuts.";
MasterPreferences prefs(
installer_state.target_path().AppendASCII(kDefaultMasterPrefs));
InstallShortcutLevel level = installer_state.system_install() ?
ALL_USERS : CURRENT_USER;
base::FilePath chrome_exe(installer_state.target_path().Append(kChromeExe));
CreateOrUpdateShortcuts(
chrome_exe, chrome, prefs, level, INSTALL_SHORTCUT_REPLACE_EXISTING);
RegisterChromeOnMachine(installer_state, chrome, false);
}
}
void HandleActiveSetupForBrowser(const base::FilePath& installation_root,
const Product& chrome,
bool force) {
DCHECK(chrome.is_chrome());
InstallShortcutOperation install_operation =
(!force && InstallUtil::IsFirstRunSentinelPresent() ?
INSTALL_SHORTCUT_REPLACE_EXISTING :
INSTALL_SHORTCUT_CREATE_EACH_IF_NO_SYSTEM_LEVEL);
MasterPreferences prefs(installation_root.AppendASCII(kDefaultMasterPrefs));
base::FilePath chrome_exe(installation_root.Append(kChromeExe));
CreateOrUpdateShortcuts(
chrome_exe, chrome, prefs, CURRENT_USER, install_operation);
}
bool InstallFromWebstore(const std::string& app_code) {
base::FilePath app_host_path(chrome_launcher_support::GetAnyAppHostPath());
if (app_host_path.empty())
return false;
CommandLine cmd(app_host_path);
cmd.AppendSwitchASCII(::switches::kInstallFromWebstore, app_code);
VLOG(1) << "App install command: " << cmd.GetCommandLineString();
return base::LaunchProcess(cmd, base::LaunchOptions(), NULL);
}
}