// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chrome/browser/profiles/profile_shortcut_manager_win.h"
#include <shlobj.h> // For SHChangeNotify().
#include <stddef.h>
#include <memory>
#include <set>
#include <string>
#include <string_view>
#include <vector>
#include "base/command_line.h"
#include "base/containers/contains.h"
#include "base/files/file_enumerator.h"
#include "base/files/file_util.h"
#include "base/functional/bind.h"
#include "base/logging.h"
#include "base/memory/raw_ref.h"
#include "base/path_service.h"
#include "base/ranges/algorithm.h"
#include "base/strings/strcat.h"
#include "base/strings/string_util.h"
#include "base/strings/stringprintf.h"
#include "base/strings/utf_string_conversions.h"
#include "base/task/thread_pool.h"
#include "base/threading/scoped_blocking_call.h"
#include "base/win/shortcut.h"
#include "base/win/windows_version.h"
#include "chrome/browser/browser_process.h"
#include "chrome/browser/policy/policy_path_parser.h"
#include "chrome/browser/profiles/profile_attributes_entry.h"
#include "chrome/browser/profiles/profile_attributes_storage.h"
#include "chrome/browser/profiles/profile_avatar_icon_util.h"
#include "chrome/browser/profiles/profile_manager.h"
#include "chrome/browser/shell_integration_win.h"
#include "chrome/browser/win/app_icon.h"
#include "chrome/common/chrome_paths.h"
#include "chrome/common/chrome_paths_internal.h"
#include "chrome/common/chrome_switches.h"
#include "chrome/common/pref_names.h"
#include "chrome/grit/branded_strings.h"
#include "chrome/installer/util/install_util.h"
#include "chrome/installer/util/shell_util.h"
#include "components/prefs/pref_service.h"
#include "content/public/browser/browser_task_traits.h"
#include "content/public/browser/browser_thread.h"
#include "skia/ext/image_operations.h"
#include "skia/ext/platform_canvas.h"
#include "third_party/skia/include/core/SkRRect.h"
#include "ui/base/l10n/l10n_util.h"
#include "ui/base/resource/resource_bundle.h"
#include "ui/gfx/icon_util.h"
#include "ui/gfx/image/image.h"
#include "ui/gfx/image/image_family.h"
using content::BrowserThread;
namespace {
// Characters that are not allowed in Windows filenames. Taken from
// http://msdn.microsoft.com/en-us/library/aa365247.aspx
const char16_t kReservedCharacters[] =
u"<>:\"/"
u"\\|?*"
u"\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0A\x0B\x0C\x0D\x0E\x0F\x10\x11\x12"
u"\x13\x14\x15\x16\x17\x18\x19\x1A\x1B\x1C\x1D\x1E\x1F";
// The maximum number of characters allowed in profile shortcuts' file names.
// Warning: migration code will be needed if this is changed later, since
// existing shortcuts might no longer be found if the name is generated
// differently than it was when a shortcut was originally created.
const int kMaxProfileShortcutFileNameLength = 64;
// Incrementing this number will cause profile icons to be regenerated on
// profile startup (it should be incremented whenever the product/avatar icons
// change, etc).
const int kCurrentProfileIconVersion = 10;
bool disabled_for_unit_tests = false;
bool disable_unpinning_for_unit_tests = false;
bool disable_oop_shortcut_update_or_create_for_unit_tests = false;
// Updates the preferences with the current icon version on icon creation
// success.
void OnProfileIconCreateSuccess(base::FilePath profile_path) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
if (!g_browser_process->profile_manager())
return;
Profile* profile =
g_browser_process->profile_manager()->GetProfileByPath(profile_path);
if (profile) {
profile->GetPrefs()->SetInteger(prefs::kProfileIconVersion,
kCurrentProfileIconVersion);
}
}
// Creates a desktop shortcut icon file (.ico) on the disk for a given profile,
// badging the icon with the profile avatar.
// Returns a path to the shortcut icon file on disk, which is empty if this
// fails. Use index 0 when assigning the resulting file as the icon. If both
// given bitmaps are empty, an unbadged icon is created.
// Returns the path to the created icon on success and an empty base::FilePath
// on failure.
// TODO(calamity): Ideally we'd just copy the app icon verbatim from the exe's
// resources in the case of an unbadged icon.
base::FilePath CreateOrUpdateShortcutIconForProfile(
const base::FilePath& profile_path,
const SkBitmap& avatar_bitmap_2x) {
base::ScopedBlockingCall scoped_blocking_call(FROM_HERE,
base::BlockingType::MAY_BLOCK);
if (!base::PathExists(profile_path))
return base::FilePath();
std::unique_ptr<gfx::ImageFamily> family = GetAppIconImageFamily();
if (!family)
return base::FilePath();
// TODO(mgiuca): A better approach would be to badge each image in the
// ImageFamily (scaling the badge to the correct size), and then re-export the
// family (as opposed to making a family with just 48 and 256, then scaling
// those images to about a dozen different sizes).
SkBitmap app_icon_bitmap = family
->CreateExact(profiles::kShortcutIconSizeWin,
profiles::kShortcutIconSizeWin)
.AsBitmap();
if (app_icon_bitmap.isNull())
return base::FilePath();
gfx::ImageFamily badged_bitmaps;
if (!avatar_bitmap_2x.empty()) {
badged_bitmaps.Add(gfx::Image::CreateFrom1xBitmap(
profiles::GetBadgedWinIconBitmapForAvatar(app_icon_bitmap,
avatar_bitmap_2x)));
}
SkBitmap large_app_icon_bitmap =
family->CreateExact(IconUtil::kLargeIconSize, IconUtil::kLargeIconSize)
.AsBitmap();
if (!large_app_icon_bitmap.isNull() && !avatar_bitmap_2x.empty()) {
badged_bitmaps.Add(gfx::Image::CreateFrom1xBitmap(
profiles::GetBadgedWinIconBitmapForAvatar(large_app_icon_bitmap,
avatar_bitmap_2x)));
}
// If we have no badged bitmaps, we should just use the default chrome icon.
if (badged_bitmaps.empty()) {
badged_bitmaps.Add(gfx::Image::CreateFrom1xBitmap(app_icon_bitmap));
if (!large_app_icon_bitmap.isNull()) {
badged_bitmaps.Add(gfx::Image::CreateFrom1xBitmap(large_app_icon_bitmap));
}
}
// Finally, write the .ico file containing this new bitmap.
const base::FilePath icon_path =
profiles::internal::GetProfileIconPath(profile_path);
const bool had_icon = base::PathExists(icon_path);
if (!IconUtil::CreateIconFileFromImageFamily(badged_bitmaps, icon_path)) {
// This can happen if the profile directory is deleted between the beginning
// of this function and here.
return base::FilePath();
}
if (had_icon) {
// This invalidates the Windows icon cache and causes the icon changes to
// register with the taskbar and desktop. SHCNE_ASSOCCHANGED will cause a
// desktop flash and we would like to avoid that if possible.
SHChangeNotify(SHCNE_ASSOCCHANGED, SHCNF_IDLIST, nullptr, nullptr);
// On Win 11, SHCNE_ASSOCCHANGED doesn't update the taskbar icons, so find
// the affected shortcuts and tell Windows they've changed.
// TODO:(crbug.com/1287111) Find all affected shortcuts, e.g., desktop, and
// remove the SHCNE_ASSOCCHANGED notification, to avoid flashing the
// desktop (and taskbar on Win 10). Remove Win 11 version check.
if (base::win::GetVersion() >= base::win::Version::WIN11) {
std::vector<base::FilePath> pinned_shortcuts =
profiles::internal::GetPinnedShortCutsForProfile(profile_path);
for (const auto& shortcut : pinned_shortcuts) {
SHChangeNotify(SHCNE_UPDATEITEM, SHCNF_PATH, shortcut.value().c_str(),
nullptr);
}
}
} else {
SHChangeNotify(SHCNE_CREATE, SHCNF_PATH, icon_path.value().c_str(),
nullptr);
}
content::GetUIThreadTaskRunner({})->PostTask(
FROM_HERE, base::BindOnce(&OnProfileIconCreateSuccess, profile_path));
return icon_path;
}
// Gets the user and system directories for desktop shortcuts. Parameters may
// be NULL if a directory type is not needed. Returns true on success.
bool GetDesktopShortcutsDirectories(
base::FilePath* user_shortcuts_directory,
base::FilePath* system_shortcuts_directory) {
if (user_shortcuts_directory &&
!ShellUtil::GetShortcutPath(ShellUtil::SHORTCUT_LOCATION_DESKTOP,
ShellUtil::CURRENT_USER,
user_shortcuts_directory)) {
return false;
}
if (system_shortcuts_directory &&
!ShellUtil::GetShortcutPath(ShellUtil::SHORTCUT_LOCATION_DESKTOP,
ShellUtil::SYSTEM_LEVEL,
system_shortcuts_directory)) {
return false;
}
return true;
}
bool IsChromeShortcut(const base::FilePath& path,
const base::FilePath& chrome_exe,
std::wstring* command_line) {
base::ScopedBlockingCall scoped_blocking_call(FROM_HERE,
base::BlockingType::MAY_BLOCK);
if (path.Extension() != installer::kLnkExt)
return false;
base::FilePath target_path;
if (!base::win::ResolveShortcut(path, &target_path, command_line))
return false;
// One of the paths may be in short (elided) form. Compare long paths to
// ensure these are still properly matched.
return MakeLongFilePath(target_path) == MakeLongFilePath(chrome_exe);
}
// A functor checks if |path| is the Chrome desktop shortcut (|chrome_exe|)
// that have the specified |command_line|. If |include_empty_command_lines| is
// true Chrome desktop shortcuts with empty command lines will also be included.
struct ChromeCommandLineFilter {
const raw_ref<const base::FilePath> chrome_exe;
const raw_ref<const std::wstring> command_line;
bool include_empty_command_lines;
ChromeCommandLineFilter(const base::FilePath& chrome_exe,
const std::wstring& command_line,
bool include_empty_command_lines)
: chrome_exe(chrome_exe),
command_line(command_line),
include_empty_command_lines(include_empty_command_lines) {}
bool operator()(const base::FilePath& path) const {
std::wstring shortcut_command_line;
if (!IsChromeShortcut(path, *chrome_exe, &shortcut_command_line)) {
return false;
}
// TODO(asvitkine): Change this to build a CommandLine object and ensure all
// args from |command_line| are present in the shortcut's CommandLine. This
// will be more robust when |command_line| contains multiple args.
if ((shortcut_command_line.empty() && include_empty_command_lines) ||
(shortcut_command_line.find(*command_line) != std::wstring::npos)) {
return true;
}
return false;
}
};
// Get the file paths of files optionally filtered by `filter`.
std::set<base::FilePath> ListDirContents(
const base::FilePath& start_dir,
bool recursive,
const ChromeCommandLineFilter* filter) {
std::set<base::FilePath> result;
base::FileEnumerator enumerator(
start_dir, recursive,
base::FileEnumerator::FILES | base::FileEnumerator::DIRECTORIES);
for (base::FilePath path = enumerator.Next(); !path.empty();
path = enumerator.Next()) {
if (!filter || (*filter)(path))
result.insert(path);
}
return result;
}
std::set<base::FilePath> ListUserDesktopContents(
const ChromeCommandLineFilter* filter) {
base::FilePath desktop_directory;
if (!GetDesktopShortcutsDirectories(&desktop_directory, nullptr))
return std::set<base::FilePath>();
return ListDirContents(desktop_directory, /*recursive=*/false, filter);
}
// Get the file paths of implicit apps sub-dirs filtered by `filter`.
std::set<base::FilePath> ListImplicitAppContents(
const ChromeCommandLineFilter* filter) {
base::FilePath implicit_apps_path;
if (!base::PathService::Get(base::DIR_IMPLICIT_APP_SHORTCUTS,
&implicit_apps_path)) {
return std::set<base::FilePath>();
}
return ListDirContents(implicit_apps_path, /*recursive=*/true, filter);
}
// Renames the given desktop shortcut and informs the shell of this change.
bool RenameDesktopShortcut(const base::FilePath& old_shortcut_path,
const base::FilePath& new_shortcut_path) {
if (!base::Move(old_shortcut_path, new_shortcut_path))
return false;
// Notify the shell of the rename, which allows the icon to keep its position
// on the desktop when renamed. Note: This only works if either SHCNF_FLUSH or
// SHCNF_FLUSHNOWAIT is specified as a flag.
SHChangeNotify(SHCNE_RENAMEITEM, SHCNF_PATH | SHCNF_FLUSHNOWAIT,
old_shortcut_path.value().c_str(),
new_shortcut_path.value().c_str());
return true;
}
// Renames an existing Chrome desktop profile shortcut.
// |profile_shortcuts| are Chrome desktop shortcuts for the profile (there can
// be several).
// |desktop_contents| is the collection of all user desktop shortcuts
// (not only Chrome). It is used to make an unique shortcut for the
// |new_profile_name| among all shortcuts.
// This function updates |profile_shortcuts| and |desktop_contents| respectively
// when renaming occurs.
void RenameChromeDesktopShortcutForProfile(
const std::u16string& old_profile_name,
const std::u16string& new_profile_name,
std::set<base::FilePath>* profile_shortcuts,
std::set<base::FilePath>* desktop_contents) {
DCHECK(profile_shortcuts);
DCHECK(desktop_contents);
base::ScopedBlockingCall scoped_blocking_call(FROM_HERE,
base::BlockingType::MAY_BLOCK);
base::FilePath user_shortcuts_directory;
base::FilePath system_shortcuts_directory;
if (!GetDesktopShortcutsDirectories(&user_shortcuts_directory,
&system_shortcuts_directory)) {
return;
}
// Get a new unique shortcut name.
const std::wstring new_shortcut_filename =
profiles::internal::GetUniqueShortcutFilenameForProfile(
new_profile_name, *desktop_contents);
const base::FilePath new_shortcut_path =
user_shortcuts_directory.Append(new_shortcut_filename);
if (!profile_shortcuts->empty()) {
// From all profile_shortcuts choose the one with a known (canonical) name.
profiles::internal::ShortcutFilenameMatcher matcher(old_profile_name);
auto it = base::ranges::find_if(
*profile_shortcuts, [&matcher](const base::FilePath& p) {
return matcher.IsCanonical(p.BaseName().value());
});
// If all profile_shortcuts were renamed by user, respect it and do not
// rename.
if (it == profile_shortcuts->end())
return;
const base::FilePath old_shortcut_path = *it;
// Rename the old shortcut unless a system-level shortcut exists at the
// destination, in which case the old shortcut is simply deleted.
const base::FilePath possible_new_system_shortcut =
system_shortcuts_directory.Append(new_shortcut_filename);
if (base::PathExists(possible_new_system_shortcut)) {
if (base::DeleteFile(old_shortcut_path)) {
profile_shortcuts->erase(old_shortcut_path);
desktop_contents->erase(old_shortcut_path);
} else {
DLOG(ERROR) << "Could not delete Windows profile desktop shortcut.";
}
} else {
if (RenameDesktopShortcut(old_shortcut_path, new_shortcut_path)) {
profile_shortcuts->erase(old_shortcut_path);
desktop_contents->erase(old_shortcut_path);
profile_shortcuts->insert(new_shortcut_path);
desktop_contents->insert(new_shortcut_path);
} else {
DLOG(ERROR) << "Could not rename Windows profile desktop shortcut.";
}
}
} else {
// If the shortcut does not exist, it may have been deleted by the user.
// It's also possible that a system-level shortcut exists instead - this
// should only be the case for the original Chrome shortcut from an
// installation. If that's the case, copy that one over - it will get its
// properties updated by
// |CreateOrUpdateDesktopShortcutsAndIconForProfile()|.
const auto old_shortcut_filename =
profiles::internal::GetShortcutFilenameForProfile(old_profile_name);
const base::FilePath possible_old_system_shortcut =
system_shortcuts_directory.Append(old_shortcut_filename);
if (base::PathExists(possible_old_system_shortcut)) {
if (base::CopyFile(possible_old_system_shortcut, new_shortcut_path)) {
profile_shortcuts->insert(new_shortcut_path);
desktop_contents->insert(new_shortcut_path);
} else {
DLOG(ERROR) << "Could not copy Windows profile desktop shortcut.";
}
}
}
}
struct CreateOrUpdateShortcutsParams {
CreateOrUpdateShortcutsParams(
base::FilePath profile_path,
ProfileShortcutManagerWin::CreateOrUpdateMode create_mode,
ProfileShortcutManagerWin::NonProfileShortcutAction action,
bool single_profile,
bool incognito = false)
: create_mode(create_mode),
action(action),
profile_path(profile_path),
single_profile(single_profile),
incognito(incognito) {}
~CreateOrUpdateShortcutsParams() {}
ProfileShortcutManagerWin::CreateOrUpdateMode create_mode;
ProfileShortcutManagerWin::NonProfileShortcutAction action;
// The path for this profile.
base::FilePath profile_path;
// The profile name before this update. Empty on create.
std::u16string old_profile_name;
// The new profile name.
std::u16string profile_name;
// If true, this is for a shortcut to a single profile, which won't have a
// badged icon or the name of profile in the shortcut name.
bool single_profile;
// If true, this adds an incognito switch that allows the user to open an
// incognito window directly from the desktop shortcut.
bool incognito;
// Avatar image for this profile.
SkBitmap avatar_image_2x;
};
// Updates all desktop shortcuts for the given profile to have the specified
// parameters. If |params.create_mode| is CREATE_WHEN_NONE_FOUND, a new shortcut
// is created if no existing ones were found. Whether non-profile shortcuts
// should be updated is specified by |params.action|. File and COM operations
// must be allowed on the calling thread.
void CreateOrUpdateDesktopShortcutsAndIconForProfile(
const CreateOrUpdateShortcutsParams& params) {
base::ScopedBlockingCall scoped_blocking_call(FROM_HERE,
base::BlockingType::MAY_BLOCK);
const base::FilePath shortcut_icon = CreateOrUpdateShortcutIconForProfile(
params.profile_path, params.avatar_image_2x);
if (shortcut_icon.empty() ||
params.create_mode ==
ProfileShortcutManagerWin::CREATE_OR_UPDATE_ICON_ONLY) {
return;
}
base::FilePath chrome_exe;
if (!base::PathService::Get(base::FILE_EXE, &chrome_exe)) {
NOTREACHED_IN_MIGRATION();
return;
}
std::set<base::FilePath> desktop_contents =
ListUserDesktopContents(/*filter=*/nullptr);
const std::wstring command_line =
profiles::internal::CreateProfileShortcutFlags(params.profile_path,
params.incognito);
ChromeCommandLineFilter filter(
chrome_exe, command_line,
params.action == ProfileShortcutManagerWin::UPDATE_NON_PROFILE_SHORTCUTS);
std::set<base::FilePath> shortcuts;
// Do not call ListUserDesktopContents again (but with filter) to avoid
// excess work inside it. Just reuse non-filtered desktop_contents.
// We need both of them (desktop_contents and shortcuts) later.
base::ranges::copy_if(desktop_contents,
std::inserter(shortcuts, shortcuts.begin()), filter);
if (params.old_profile_name != params.profile_name || params.single_profile) {
RenameChromeDesktopShortcutForProfile(
params.old_profile_name,
params.single_profile ? std::u16string() : params.profile_name,
&shortcuts, &desktop_contents);
}
// Rename default named profile shortcuts as well, e.g., Chrome.lnk, by
// passing "" for the old profile name.
if (params.action ==
ProfileShortcutManagerWin::UPDATE_NON_PROFILE_SHORTCUTS) {
RenameChromeDesktopShortcutForProfile(std::u16string(), params.profile_name,
&shortcuts, &desktop_contents);
}
ShellUtil::ShortcutProperties properties(ShellUtil::CURRENT_USER);
ShellUtil::AddDefaultShortcutProperties(chrome_exe, &properties);
// All shortcuts will point to a profile, but only set the shortcut icon
// if we're not generating a shortcut in the single profile case.
properties.set_arguments(command_line);
if (!params.single_profile)
properties.set_icon(shortcut_icon, 0);
properties.set_app_id(
shell_integration::win::GetAppUserModelIdForBrowser(params.profile_path));
ShellUtil::ShortcutOperation operation =
ShellUtil::SHELL_SHORTCUT_REPLACE_EXISTING;
if (params.create_mode == ProfileShortcutManagerWin::CREATE_WHEN_NONE_FOUND &&
shortcuts.empty()) {
const std::wstring shortcut_name =
profiles::internal::GetUniqueShortcutFilenameForProfile(
params.single_profile ? std::u16string() : params.profile_name,
desktop_contents);
shortcuts.insert(base::FilePath(shortcut_name));
operation = ShellUtil::SHELL_SHORTCUT_CREATE_IF_NO_SYSTEM_LEVEL;
}
// `shortcut_operation` will be the same for each shortcut.
base::win::ShortcutOperation shortcut_operation;
std::vector<base::win::ShortcutProperties> shortcuts_properties;
std::vector<base::FilePath> shortcuts_to_create_or_update;
for (const auto& shortcut : shortcuts) {
const base::FilePath shortcut_name = shortcut.BaseName().RemoveExtension();
properties.set_shortcut_name(shortcut_name.value());
bool should_install_shortcut;
base::win::ShortcutProperties shortcut_properties;
base::FilePath shortcut_path;
ShellUtil::TranslateShortcutCreationOrUpdateInfo(
ShellUtil::SHORTCUT_LOCATION_DESKTOP, properties, operation,
shortcut_operation, shortcut_properties, should_install_shortcut,
shortcut_path);
if (should_install_shortcut) {
if (!disable_oop_shortcut_update_or_create_for_unit_tests) {
shortcuts_to_create_or_update.push_back(std::move(shortcut_path));
shortcuts_properties.push_back(std::move(shortcut_properties));
} else {
base::win::CreateOrUpdateShortcutLink(
shortcut_path, shortcut_properties, shortcut_operation);
}
}
}
if (!shortcuts_to_create_or_update.empty()) {
shell_integration::win::CreateOrUpdateShortcuts(
shortcuts_to_create_or_update, shortcuts_properties, shortcut_operation,
base::DoNothing());
}
}
// Returns true if any desktop shortcuts exist with target |chrome_exe|,
// regardless of their command line arguments.
bool ChromeDesktopShortcutsExist(const base::FilePath& chrome_exe) {
base::FilePath user_shortcuts_directory;
if (!GetDesktopShortcutsDirectories(&user_shortcuts_directory, nullptr))
return false;
base::FileEnumerator enumerator(user_shortcuts_directory, false,
base::FileEnumerator::FILES);
for (base::FilePath path = enumerator.Next(); !path.empty();
path = enumerator.Next()) {
if (IsChromeShortcut(path, chrome_exe, nullptr))
return true;
}
return false;
}
void DeleteDesktopShortcuts(
const std::set<base::FilePath>& shortcuts,
bool ensure_shortcuts_remain,
const std::optional<base::FilePath>& default_profile_path,
const base::FilePath& chrome_exe) {
base::ScopedBlockingCall scoped_blocking_call(FROM_HERE,
base::BlockingType::MAY_BLOCK);
for (const auto& shortcut : shortcuts) {
// Use base::DeleteFile() instead of ShellUtil::RemoveShortcuts(), as the
// latter causes non-profile taskbar shortcuts to be removed since it
// doesn't consider the command-line of the shortcuts it deletes.
// TODO(huangs): Refactor with ShellUtil::RemoveShortcuts().
base::DeleteFile(shortcut);
// Notify the shell that the shortcut was deleted to ensure desktop refresh.
SHChangeNotify(SHCNE_DELETE, SHCNF_PATH, shortcut.value().c_str(), nullptr);
}
// If |ensure_shortcuts_remain| is true and deleting this profile caused the
// last shortcuts to be removed, re-create a regular single profile shortcut
// pointing at the default profile.
const bool had_shortcuts = !shortcuts.empty();
if (ensure_shortcuts_remain && had_shortcuts &&
!ChromeDesktopShortcutsExist(chrome_exe)) {
ShellUtil::ShortcutProperties properties(ShellUtil::CURRENT_USER);
ShellUtil::AddDefaultShortcutProperties(chrome_exe, &properties);
if (default_profile_path.has_value()) {
properties.set_arguments(profiles::internal::CreateProfileShortcutFlags(
default_profile_path.value()));
}
properties.set_shortcut_name(
profiles::internal::GetShortcutFilenameForProfile(std::u16string()));
ShellUtil::CreateOrUpdateShortcut(
ShellUtil::SHORTCUT_LOCATION_DESKTOP, properties,
ShellUtil::SHELL_SHORTCUT_CREATE_IF_NO_SYSTEM_LEVEL);
}
}
// Deletes all desktop shortcuts for the specified profile, and unpins them,
// if pinned. If |ensure_shortcuts_remain| is true, then a regular non-profile
// shortcut will be created if this function would otherwise delete the last
// Chrome desktop shortcut(s). File and COM operations must be allowed on the
// calling thread. |default_profile_path| is used to create the command line for
// the shortcutcreated if |ensure_shortcuts_remain| is true and the last desktop
// shortcut was deleted.
void UnpinAndDeleteDesktopShortcuts(
const base::FilePath& profile_path,
const std::optional<base::FilePath>& default_profile_path,
bool ensure_shortcuts_remain) {
base::ScopedBlockingCall scoped_blocking_call(FROM_HERE,
base::BlockingType::MAY_BLOCK);
base::FilePath chrome_exe;
if (!base::PathService::Get(base::FILE_EXE, &chrome_exe)) {
NOTREACHED_IN_MIGRATION();
return;
}
const std::wstring command_line =
profiles::internal::CreateProfileShortcutFlags(profile_path);
ChromeCommandLineFilter filter(chrome_exe, command_line, false);
std::set<base::FilePath> shortcuts = ListUserDesktopContents(&filter);
if (shortcuts.empty()) {
shortcuts = ListImplicitAppContents(&filter);
if (shortcuts.empty())
return;
}
std::vector<base::FilePath> shortcuts_vector(shortcuts.begin(),
shortcuts.end());
// Unpinning is done out-of-process, which isn't allowed in unit tests.
if (disable_unpinning_for_unit_tests) {
DeleteDesktopShortcuts(shortcuts, ensure_shortcuts_remain,
default_profile_path, chrome_exe);
return;
}
shell_integration::win::UnpinShortcuts(
shortcuts_vector, base::BindOnce(&DeleteDesktopShortcuts, shortcuts,
ensure_shortcuts_remain,
default_profile_path, chrome_exe));
}
// Returns true if profile at |profile_path| has any shortcuts. Does not
// consider non-profile shortcuts. File and COM operations must be allowed on
// the calling thread.
bool HasAnyProfileShortcuts(const base::FilePath& profile_path) {
base::ScopedBlockingCall scoped_blocking_call(FROM_HERE,
base::BlockingType::MAY_BLOCK);
base::FilePath chrome_exe;
if (!base::PathService::Get(base::FILE_EXE, &chrome_exe)) {
NOTREACHED_IN_MIGRATION();
return false;
}
const std::wstring command_line =
profiles::internal::CreateProfileShortcutFlags(profile_path);
ChromeCommandLineFilter filter(chrome_exe, command_line, false);
return !ListUserDesktopContents(&filter).empty();
}
// Replaces any reserved characters with spaces, and trims the resulting string
// to prevent any leading and trailing spaces. Also makes sure that the
// resulting filename doesn't exceed |kMaxProfileShortcutFileNameLength|.
// TODO(macourteau): find a way to limit the total path's length to MAX_PATH
// instead of limiting the profile's name to |kMaxProfileShortcutFileNameLength|
// characters.
std::wstring SanitizeShortcutProfileNameString(
const std::u16string& profile_name) {
std::u16string sanitized = profile_name;
size_t pos = sanitized.find_first_of(kReservedCharacters);
while (pos != std::u16string::npos) {
sanitized[pos] = L' ';
pos = sanitized.find_first_of(kReservedCharacters, pos + 1);
}
base::TrimWhitespace(sanitized, base::TRIM_LEADING, &sanitized);
if (sanitized.size() > kMaxProfileShortcutFileNameLength)
sanitized.erase(kMaxProfileShortcutFileNameLength);
base::TrimWhitespace(sanitized, base::TRIM_TRAILING, &sanitized);
return base::AsWString(sanitized);
}
} // namespace
namespace profiles {
const base::FilePath::StringPieceType kProfileIconFileName =
FILE_PATH_LITERAL("Google Profile.ico");
namespace internal {
base::FilePath GetProfileIconPath(const base::FilePath& profile_path) {
return profile_path.Append(kProfileIconFileName);
}
std::wstring GetShortcutFilenameForProfile(const std::u16string& profile_name) {
std::wstring shortcut_name;
if (!profile_name.empty()) {
shortcut_name.append(SanitizeShortcutProfileNameString(profile_name));
shortcut_name.append(L" - ");
shortcut_name.append(
base::AsWString(l10n_util::GetStringUTF16(IDS_SHORT_PRODUCT_NAME)));
} else {
shortcut_name.append(InstallUtil::GetShortcutName());
}
return shortcut_name + installer::kLnkExt;
}
std::wstring GetUniqueShortcutFilenameForProfile(
const std::u16string& profile_name,
const std::set<base::FilePath>& excludes) {
std::set<std::wstring> excludes_names;
base::ranges::transform(
excludes, std::inserter(excludes_names, excludes_names.begin()),
[](const base::FilePath& e) { return e.BaseName().value(); });
const auto base_name = GetShortcutFilenameForProfile(profile_name);
auto name = base_name;
const base::FilePath base_path(base_name);
for (int uniquifier = 1; excludes_names.count(name) > 0; ++uniquifier) {
const auto suffix = base::StringPrintf(" (%d)", uniquifier);
name = base_path.InsertBeforeExtensionASCII(suffix).value();
}
return name;
}
// Corresponds to GetUniqueShortcutFilenameForProfile.
ShortcutFilenameMatcher::ShortcutFilenameMatcher(
const std::u16string& profile_name)
: profile_shortcut_filename_(GetShortcutFilenameForProfile(profile_name)),
lnk_ext_(installer::kLnkExt),
profile_shortcut_name_(profile_shortcut_filename_) {
DCHECK(base::EndsWith(profile_shortcut_name_, lnk_ext_));
profile_shortcut_name_.remove_suffix(lnk_ext_.size());
}
bool ShortcutFilenameMatcher::IsCanonical(const std::wstring& filename) const {
if (filename == profile_shortcut_filename_)
return true;
std::wstring_view shortcut_suffix = filename;
if (!base::StartsWith(shortcut_suffix, profile_shortcut_name_))
return false;
shortcut_suffix.remove_prefix(profile_shortcut_name_.size());
if (!base::EndsWith(shortcut_suffix, lnk_ext_))
return false;
shortcut_suffix.remove_suffix(lnk_ext_.size());
if (shortcut_suffix.size() < 4 || !base::StartsWith(shortcut_suffix, L" (") ||
!base::EndsWith(shortcut_suffix, L")")) {
return false;
}
return std::all_of(shortcut_suffix.begin() + 2, shortcut_suffix.end() - 1,
iswdigit);
}
std::wstring CreateProfileShortcutFlags(const base::FilePath& profile_path,
const bool incognito) {
std::wstring flags =
base::StrCat({L"--", base::ASCIIToWide(switches::kProfileDirectory),
L"=\"", profile_path.BaseName().value(), L"\""});
if (incognito) {
flags.append(L" --" + base::ASCIIToWide(switches::kIncognito));
}
return flags;
}
// Returns true iff `shortcut` is a shortcut to the currently running version
// of Chrome.exe, and specifies `profile_path` as its profile_dir.
bool IsChromeShortcutForProfile(const base::FilePath& shortcut,
const base::FilePath& profile_path) {
base::FilePath chrome_exe;
if (!base::PathService::Get(base::FILE_EXE, &chrome_exe)) {
NOTREACHED_IN_MIGRATION();
return false;
}
std::wstring cmd_line_string;
if (!IsChromeShortcut(shortcut, chrome_exe, &cmd_line_string))
return false;
cmd_line_string.insert(0, chrome_exe.value() + L" ");
base::CommandLine shortcut_cmd_line =
base::CommandLine::FromString(cmd_line_string);
return shortcut_cmd_line.HasSwitch(switches::kProfileDirectory) &&
shortcut_cmd_line.GetSwitchValuePath(switches::kProfileDirectory) ==
profile_path.BaseName();
}
// Returns a vector of Chrome.exe shortcuts for profile `profile_path` in the
// directory `shortcut_dir`.
const std::vector<base::FilePath> FindChromeShortcutsForProfile(
const base::FilePath& shortcut_dir,
const base::FilePath& profile_path) {
std::vector<base::FilePath> shortcut_paths;
// Find all shortcuts for this profile.
base::FileEnumerator files(shortcut_dir, false, base::FileEnumerator::FILES,
FILE_PATH_LITERAL("*.lnk"));
base::FilePath shortcut_file = files.Next();
while (!shortcut_file.empty()) {
if (IsChromeShortcutForProfile(shortcut_file, profile_path))
shortcut_paths.push_back(shortcut_file);
shortcut_file = files.Next();
}
return shortcut_paths;
}
const std::vector<base::FilePath> GetPinnedShortCutsForProfile(
const base::FilePath& profile_path) {
std::vector<base::FilePath> pinned_shortcuts;
// Find matching shortcuts in taskbar pin directories.
base::FilePath taskbar_pins_dir;
if (base::PathService::Get(base::DIR_TASKBAR_PINS, &taskbar_pins_dir)) {
const std::vector<base::FilePath> shortcut_files =
FindChromeShortcutsForProfile(taskbar_pins_dir, profile_path);
pinned_shortcuts.insert(pinned_shortcuts.end(), shortcut_files.begin(),
shortcut_files.end());
}
// Check all folders in ImplicitAppShortcuts.
base::FilePath implicit_app_shortcuts_dir;
if (base::PathService::Get(base::DIR_IMPLICIT_APP_SHORTCUTS,
&implicit_app_shortcuts_dir)) {
base::FileEnumerator directory_enum(implicit_app_shortcuts_dir, false,
base::FileEnumerator::DIRECTORIES);
for (base::FilePath directory = directory_enum.Next(); !directory.empty();
directory = directory_enum.Next()) {
const std::vector<base::FilePath> shortcut_files =
FindChromeShortcutsForProfile(directory, profile_path);
pinned_shortcuts.insert(pinned_shortcuts.end(), shortcut_files.begin(),
shortcut_files.end());
}
}
return pinned_shortcuts;
}
} // namespace internal
} // namespace profiles
void ProfileShortcutManager::DisableForUnitTests() {
disabled_for_unit_tests = true;
}
// static
bool ProfileShortcutManager::IsFeatureEnabled() {
if (disabled_for_unit_tests)
return false;
base::CommandLine* command_line = base::CommandLine::ForCurrentProcess();
if (command_line->HasSwitch(switches::kEnableProfileShortcutManager))
return true;
base::FilePath policy_user_data_dir;
policy::path_parser::CheckUserDataDirPolicy(&policy_user_data_dir);
base::FilePath user_data_dir;
bool success = base::PathService::Get(chrome::DIR_USER_DATA, &user_data_dir);
DCHECK(success);
base::FilePath default_user_data_dir;
success = chrome::GetDefaultUserDataDirectory(&default_user_data_dir);
DCHECK(success);
return user_data_dir == default_user_data_dir ||
user_data_dir == policy_user_data_dir;
}
// static
std::unique_ptr<ProfileShortcutManager> ProfileShortcutManager::Create(
ProfileManager* manager) {
return std::make_unique<ProfileShortcutManagerWin>(manager);
}
ProfileShortcutManagerWin::ProfileShortcutManagerWin(ProfileManager* manager)
: profile_manager_(manager) {
profile_manager_->GetProfileAttributesStorage().AddObserver(this);
profile_manager_->AddObserver(this);
}
ProfileShortcutManagerWin::~ProfileShortcutManagerWin() {
profile_manager_->RemoveObserver(this);
profile_manager_->GetProfileAttributesStorage().RemoveObserver(this);
}
void ProfileShortcutManagerWin::DisableUnpinningForTests() {
disable_unpinning_for_unit_tests = true;
}
void ProfileShortcutManagerWin::DisableOutOfProcessShortcutOpsForTests() {
disable_oop_shortcut_update_or_create_for_unit_tests = true;
}
void ProfileShortcutManagerWin::CreateOrUpdateProfileIcon(
const base::FilePath& profile_path) {
CreateOrUpdateShortcutsForProfileAtPath(
profile_path, CREATE_OR_UPDATE_ICON_ONLY, IGNORE_NON_PROFILE_SHORTCUTS,
/*incognito=*/false);
}
void ProfileShortcutManagerWin::CreateProfileShortcut(
const base::FilePath& profile_path) {
CreateOrUpdateShortcutsForProfileAtPath(profile_path, CREATE_WHEN_NONE_FOUND,
IGNORE_NON_PROFILE_SHORTCUTS,
/*incognito=*/false);
}
void ProfileShortcutManagerWin::RemoveProfileShortcuts(
const base::FilePath& profile_path) {
base::ThreadPool::CreateCOMSTATaskRunner({base::MayBlock()})
->PostTask(FROM_HERE, base::BindOnce(&UnpinAndDeleteDesktopShortcuts,
profile_path, std::nullopt, false));
}
void ProfileShortcutManagerWin::HasProfileShortcuts(
const base::FilePath& profile_path,
base::OnceCallback<void(bool)> callback) {
base::ThreadPool::CreateCOMSTATaskRunner({base::MayBlock()})
->PostTaskAndReplyWithResult(
FROM_HERE, base::BindOnce(&HasAnyProfileShortcuts, profile_path),
std::move(callback));
}
void ProfileShortcutManagerWin::GetShortcutProperties(
const base::FilePath& profile_path,
base::CommandLine* command_line,
std::wstring* name,
base::FilePath* icon_path) {
base::FilePath chrome_exe;
if (!base::PathService::Get(base::FILE_EXE, &chrome_exe)) {
NOTREACHED_IN_MIGRATION();
return;
}
ProfileAttributesStorage& storage =
profile_manager_->GetProfileAttributesStorage();
ProfileAttributesEntry* entry =
storage.GetProfileAttributesWithPath(profile_path);
DCHECK(entry);
// The shortcut shouldn't include the profile name if there is only 1 profile.
std::u16string shortcut_profile_name;
if (storage.GetNumberOfProfiles() > 1u)
shortcut_profile_name = entry->GetName();
*name = base::FilePath(profiles::internal::GetShortcutFilenameForProfile(
shortcut_profile_name))
.RemoveExtension()
.value();
command_line->ParseFromString(
L"\"" + chrome_exe.value() + L"\" " +
profiles::internal::CreateProfileShortcutFlags(profile_path));
*icon_path = profiles::internal::GetProfileIconPath(profile_path);
}
void ProfileShortcutManagerWin::OnProfileAdded(
const base::FilePath& profile_path) {
CreateOrUpdateProfileIcon(profile_path);
if (profile_manager_->GetProfileAttributesStorage().GetNumberOfProfiles() ==
2u) {
// When the second profile is added, make existing non-profile and
// non-badged shortcuts point to the first profile and be badged/named
// appropriately.
CreateOrUpdateShortcutsForProfileAtPath(
GetOtherProfilePath(profile_path), UPDATE_EXISTING_ONLY,
UPDATE_NON_PROFILE_SHORTCUTS, /*incognito=*/false);
}
}
void ProfileShortcutManagerWin::OnProfileWasRemoved(
const base::FilePath& profile_path,
const std::u16string& profile_name) {
ProfileAttributesStorage& storage =
profile_manager_->GetProfileAttributesStorage();
// If there is only one profile remaining, remove the badging information
// from an existing shortcut.
const bool deleting_down_to_last_profile =
(storage.GetNumberOfProfiles() == 1u);
if (deleting_down_to_last_profile) {
// This is needed to unbadge the icon.
CreateOrUpdateShortcutsForProfileAtPath(
storage.GetAllProfilesAttributes().front()->GetPath(),
UPDATE_EXISTING_ONLY, IGNORE_NON_PROFILE_SHORTCUTS,
/*incognito=*/false);
}
base::FilePath first_profile_path;
std::vector<ProfileAttributesEntry*> all_profiles =
storage.GetAllProfilesAttributes();
if (all_profiles.size() > 0)
first_profile_path = all_profiles[0]->GetPath();
base::ThreadPool::CreateCOMSTATaskRunner({base::MayBlock()})
->PostTask(FROM_HERE, base::BindOnce(&UnpinAndDeleteDesktopShortcuts,
profile_path, first_profile_path,
deleting_down_to_last_profile));
}
void ProfileShortcutManagerWin::OnProfileNameChanged(
const base::FilePath& profile_path,
const std::u16string& old_profile_name) {
CreateOrUpdateShortcutsForProfileAtPath(profile_path, UPDATE_EXISTING_ONLY,
IGNORE_NON_PROFILE_SHORTCUTS,
/*incognito=*/false);
}
void ProfileShortcutManagerWin::OnProfileAvatarChanged(
const base::FilePath& profile_path) {
CreateOrUpdateProfileIcon(profile_path);
}
void ProfileShortcutManagerWin::OnProfileHighResAvatarLoaded(
const base::FilePath& profile_path) {
if (base::Contains(profiles_with_pending_avatar_load_, profile_path)) {
profiles_with_pending_avatar_load_.erase(profile_path);
CreateOrUpdateProfileIcon(profile_path);
}
}
void ProfileShortcutManagerWin::OnProfileAdded(Profile* profile) {
if (profile->GetPrefs()->GetInteger(prefs::kProfileIconVersion) <
kCurrentProfileIconVersion) {
const base::FilePath profile_path = profile->GetPath();
// Ensure the profile's icon file has been created.
CreateOrUpdateProfileIcon(profile_path);
ProfileAttributesStorage& storage =
profile_manager_->GetProfileAttributesStorage();
const ProfileAttributesEntry* entry =
storage.GetProfileAttributesWithPath(profile_path);
// If GAIA picture is not yet loaded, the profile icon will be updated when
// it loads.
if (entry && !entry->GetLastDownloadedGAIAPictureUrlWithSize().empty() &&
!entry->IsGAIAPictureLoaded()) {
profiles_with_pending_avatar_load_.insert(profile_path);
}
}
}
base::FilePath ProfileShortcutManagerWin::GetOtherProfilePath(
const base::FilePath& profile_path) {
const ProfileAttributesStorage& storage =
profile_manager_->GetProfileAttributesStorage();
DCHECK_EQ(2u, storage.GetNumberOfProfiles());
// Get the index of the current profile, in order to find the index of the
// other profile.
std::vector<ProfileAttributesEntry*> entries =
g_browser_process->profile_manager()
->GetProfileAttributesStorage()
.GetAllProfilesAttributes();
for (ProfileAttributesEntry* entry : entries) {
base::FilePath path = entry->GetPath();
if (path != profile_path)
return path;
}
NOTREACHED_IN_MIGRATION();
return base::FilePath();
}
void ProfileShortcutManagerWin::CreateOrUpdateShortcutsForProfileAtPath(
const base::FilePath& profile_path,
CreateOrUpdateMode create_mode,
NonProfileShortcutAction action,
bool incognito) {
DCHECK(!BrowserThread::IsThreadInitialized(BrowserThread::UI) ||
BrowserThread::CurrentlyOn(BrowserThread::UI));
ProfileAttributesStorage& storage =
profile_manager_->GetProfileAttributesStorage();
ProfileAttributesEntry* entry =
storage.GetProfileAttributesWithPath(profile_path);
if (!entry)
return;
bool remove_badging = storage.GetNumberOfProfiles() == 1u;
CreateOrUpdateShortcutsParams params(profile_path, create_mode, action,
/*single_profile=*/remove_badging,
incognito);
params.old_profile_name = entry->GetShortcutName();
// Exit early if the mode is to update existing profile shortcuts only and
// none were ever created for this profile, per the shortcut name not being
// set in the profile attributes storage.
if (params.old_profile_name.empty() && create_mode == UPDATE_EXISTING_ONLY &&
action == IGNORE_NON_PROFILE_SHORTCUTS) {
return;
}
if (remove_badging) {
// Only one profile left, so make the shortcut point at it.
std::vector<ProfileAttributesEntry*> all_profiles =
storage.GetAllProfilesAttributes();
if (all_profiles.size() == 1)
params.profile_name = all_profiles[0]->GetName();
} else {
params.profile_name = entry->GetName();
params.avatar_image_2x = profiles::GetWin2xAvatarImage(entry);
}
base::ThreadPool::CreateCOMSTATaskRunner({base::MayBlock()})
->PostTask(FROM_HERE,
base::BindOnce(
&CreateOrUpdateDesktopShortcutsAndIconForProfile, params));
entry->SetShortcutName(params.profile_name);
}
Codebase Browser
chromium