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
|
// Copyright 2021 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/ui/ash/shelf/browser_app_shelf_item_controller.h"
#include "ash/public/cpp/shelf_types.h"
#include "base/memory/weak_ptr.h"
#include "base/notreached.h"
#include "base/strings/utf_string_conversions.h"
#include "base/unguessable_token.h"
#include "chrome/browser/apps/app_service/app_service_proxy.h"
#include "chrome/browser/apps/app_service/app_service_proxy_factory.h"
#include "chrome/browser/apps/app_service/browser_app_instance_registry.h"
#include "chrome/browser/ash/crosapi/browser_util.h"
#include "chrome/browser/ui/ash/ash_util.h"
#include "chrome/browser/ui/ash/shelf/chrome_shelf_controller.h"
#include "chrome/browser/ui/ash/shelf/chrome_shelf_controller_util.h"
#include "chrome/browser/ui/ash/shelf/shelf_context_menu.h"
#include "chrome/grit/theme_resources.h"
#include "chromeos/ui/wm/desks/desks_helper.h"
#include "components/app_constants/constants.h"
#include "components/services/app_service/public/cpp/app_types.h"
#include "extensions/common/constants.h"
#include "ui/aura/client/aura_constants.h"
#include "ui/base/resource/resource_bundle.h"
#include "ui/views/widget/native_widget_aura.h"
namespace {
// Returns true if we are trying to launch a lacros window if there isn't
// already one on the active desk.
bool ShouldLaunchNewLacrosWindow(
std::string app_id,
const std::vector<std::pair<int, base::UnguessableToken>>& instances,
const apps::BrowserAppInstanceRegistry& registry) {
if (app_id != app_constants::kLacrosAppId) {
return false;
}
for (auto [cmd_id, instance_id] : instances) {
aura::Window* window = registry.GetWindowByInstanceId(instance_id);
if (window &&
chromeos::DesksHelper::Get(window)->BelongsToActiveDesk(window)) {
return false;
}
}
return true;
}
} // namespace
BrowserAppShelfItemController::BrowserAppShelfItemController(
const ash::ShelfID& shelf_id,
Profile* profile)
: ash::ShelfItemDelegate(shelf_id),
profile_(profile),
registry_(*apps::AppServiceProxyFactory::GetForProfile(profile_)
->BrowserAppInstanceRegistry()) {
registry_observation_.Observe(&*registry_);
// Registers all running instances that started before this shelf item was
// created, for example if a running app is later pinned to the shelf.
registry_->NotifyExistingInstances(this);
LoadIcon(extension_misc::EXTENSION_ICON_BITTY,
base::BindOnce(&BrowserAppShelfItemController::OnLoadBittyIcon,
weak_ptr_factory_.GetWeakPtr()));
}
BrowserAppShelfItemController::~BrowserAppShelfItemController() = default;
// This function is responsible for handling mouse and key events that are
// triggered when Lacros is the Chrome browser and when (1) the Lacros browser
// icon or (2) an Ash-backed SWA icon or (3) a Lacros-backed PWA icon on the
// shelf is clicked, or when the Alt+N accelerator is triggered for the said
// Lacros/SWA/PWA. For Ash-chrome please refer to
// BrowserShortcutShelfItemController. For SWA and PWA when Lacros is disabled
// please refer to AppShortcutShelfItemController.
void BrowserAppShelfItemController::ItemSelected(
std::unique_ptr<ui::Event> event,
int64_t display_id,
ash::ShelfLaunchSource source,
ItemSelectedCallback callback,
const ItemFilterPredicate& filter_predicate) {
auto instances = GetMatchingInstances(filter_predicate);
// Here we check the implicit assumption that the type of the event that gets
// passed in is never ui::ET_KEY_PRESSED. One may find it strange as usually
// ui::ET_KEY_RELEASED comes in pair with ui::ET_KEY_PRESSED, i.e, if we need
// to handle ui::ET_KEY_RELEASED, then we probably need to handle
// ui::ET_KEY_PRESSED too. However this is not the case here. The ui::KeyEvent
// that gets passed in is manufactured as an ui::ET_KEY_RELEASED typed
// KeyEvent right before being passed in. This is similar to the situations of
// BrowserShortcutShelfItemController and AppShortcutShelfItemController.
//
// One other thing regarding the KeyEvent here that one may find confusing is
// that even though the code here says ET_KEY_RELEASED, one only needs to
// conduct a press action (e.g., pressing Alt+1 on a physical device without
// letting go) to trigger this ItemSelected() function call. The subsequent
// key release action is not required. This naming disparity comes from the
// fact that while the key accelerator is triggered and handled by
// ui::AcceleratorManager::Process() with a KeyEvent instance as one of its
// inputs, further down the callstack, the same KeyEvent instance is not
// passed over into ash::Shelf::ActivateShelfItemOnDisplay(). Instead, a new
// KeyEvent instance is fabricated inside
// ash::Shelf::ActivateShelfItemOnDisplay(), with its type being
// ET_KEY_RELEASED, to represent the original KeyEvent, whose type is
// ET_KEY_PRESSED.
//
// The fabrication of the release typed key event was first introduced in this
// CL in 2013.
// https://chromiumcodereview.appspot.com/14551002/patch/41001/42001
//
// A bug is filed to track future works for fixing this confusing naming
// disparity. https://crbug.com/1473895
DCHECK(!(event && event->type() == ui::ET_KEY_PRESSED));
if (event && event->type() == ui::ET_KEY_RELEASED && instances.size() > 0) {
auto target_id = instances[0].second;
if (instances.size() > 1) {
for (size_t i = 0; i < instances.size(); i++) {
if (registry_->IsInstanceActive(instances[i].second) &&
i + 1 < instances.size()) {
target_id = instances[i + 1].second;
}
}
registry_->ActivateInstance(target_id);
} else {
if (registry_->IsInstanceActive(target_id)) {
aura::Window* window = nullptr;
if (shelf_id().app_id == app_constants::kLacrosAppId) {
const apps::BrowserWindowInstance* instance =
registry_->GetBrowserWindowInstanceById(target_id);
window = instance->window;
} else {
const apps::BrowserAppInstance* instance =
registry_->GetAppInstanceById(target_id);
window = instance->window;
}
ash_util::BounceWindow(window);
return;
}
// If however the single instance is not active, the code will fall
// through and the instance will be handled and maximized by the rest of
// the logic in this function that handles mouse events.
}
}
if (instances.size() == 0 ||
ShouldLaunchNewLacrosWindow(app_id(), instances, *registry_)) {
// No instances or if this is a lacros window and there isn't already one on
// the current workspace, launch.
std::move(callback).Run(ash::SHELF_ACTION_NEW_WINDOW_CREATED, {});
ChromeShelfController* chrome_shelf_controller =
ChromeShelfController::instance();
MaybeRecordAppLaunchForScalableIph(
shelf_id().app_id, chrome_shelf_controller->profile(), source);
chrome_shelf_controller->LaunchApp(ash::ShelfID(shelf_id()), source,
ui::EF_NONE, display_id);
} else if (instances.size() == 1) {
// One instance is running, activate it.
const base::UnguessableToken id = instances[0].second;
const bool can_minimize = source != ash::LAUNCH_FROM_APP_LIST &&
source != ash::LAUNCH_FROM_APP_LIST_SEARCH;
ash::ShelfAction action;
if (registry_->IsInstanceActive(id) && can_minimize) {
registry_->MinimizeInstance(id);
action = ash::SHELF_ACTION_WINDOW_MINIMIZED;
} else {
registry_->ActivateInstance(id);
action = ash::SHELF_ACTION_WINDOW_ACTIVATED;
}
std::move(callback).Run(action, {});
} else {
// Multiple instances activated, show the list of running instances.
std::move(callback).Run(
ash::SHELF_ACTION_NONE,
GetAppMenuItems(event ? event->flags() : ui::EF_NONE,
filter_predicate));
}
}
BrowserAppShelfItemController::AppMenuItems
BrowserAppShelfItemController::GetAppMenuItems(
int event_flags,
const ItemFilterPredicate& filter_predicate) {
AppMenuItems items;
for (const auto& pair : GetMatchingInstances(filter_predicate)) {
int command_id = pair.first;
base::UnguessableToken id = pair.second;
if (shelf_id().app_id == app_constants::kLacrosAppId) {
const apps::BrowserWindowInstance* instance =
registry_->GetBrowserWindowInstanceById(id);
DCHECK(instance);
const gfx::Image& icon =
ui::ResourceBundle::GetSharedInstance().GetImageNamed(
instance->is_incognito ? IDR_ASH_SHELF_LIST_INCOGNITO_BROWSER
: IDR_ASH_SHELF_LIST_BROWSER);
items.push_back(
{command_id, instance->window->GetTitle(), icon.AsImageSkia()});
} else {
const apps::BrowserAppInstance* instance =
registry_->GetAppInstanceById(id);
DCHECK(instance);
items.push_back(
{command_id, base::UTF8ToUTF16(instance->title), bitty_icon_});
}
}
return items;
}
void BrowserAppShelfItemController::GetContextMenu(
int64_t display_id,
GetContextMenuCallback callback) {
ChromeShelfController* controller = ChromeShelfController::instance();
const ash::ShelfItem* item = controller->GetItem(shelf_id());
context_menu_ = ShelfContextMenu::Create(controller, item, display_id);
context_menu_->GetMenuModel(std::move(callback));
}
void BrowserAppShelfItemController::ExecuteCommand(bool from_context_menu,
int64_t command_id,
int32_t event_flags,
int64_t display_id) {
// Item selected from menu.
auto it = command_to_instance_map_.find(command_id);
if (it != command_to_instance_map_.end()) {
registry_->ActivateInstance(it->second);
}
}
void BrowserAppShelfItemController::Close() {
apps::AppServiceProxyFactory::GetForProfile(profile_)->StopApp(
shelf_id().app_id);
}
void BrowserAppShelfItemController::OnBrowserWindowAdded(
const apps::BrowserWindowInstance& instance) {
if (!(shelf_id().app_id == app_constants::kLacrosAppId &&
crosapi::browser_util::IsLacrosWindow(instance.window))) {
// Only handle Lacros browser windows.
return;
}
if (!(bitty_icon_.isNull() || medium_icon_.isNull())) {
views::NativeWidgetAura::AssignIconToAuraWindow(instance.window,
bitty_icon_, medium_icon_);
}
int command = ++last_command_id_;
command_to_instance_map_[command] = instance.id;
}
void BrowserAppShelfItemController::OnBrowserWindowRemoved(
const apps::BrowserWindowInstance& instance) {
if (!(shelf_id().app_id == app_constants::kLacrosAppId &&
crosapi::browser_util::IsLacrosWindow(instance.window))) {
// Only handle Lacros browser windows.
return;
}
int command = GetInstanceCommand(instance.id);
command_to_instance_map_.erase(command);
}
void BrowserAppShelfItemController::OnBrowserAppAdded(
const apps::BrowserAppInstance& instance) {
if (shelf_id().app_id != instance.app_id) {
return;
}
// If we are adding a tab to a browser window for the app, then we still want
// the browser window to maintain its own icon.
if (instance.type != apps::BrowserAppInstance::Type::kAppTab &&
!(bitty_icon_.isNull() || medium_icon_.isNull())) {
views::NativeWidgetAura::AssignIconToAuraWindow(instance.window,
bitty_icon_, medium_icon_);
}
int command = ++last_command_id_;
command_to_instance_map_[command] = instance.id;
}
void BrowserAppShelfItemController::OnBrowserAppRemoved(
const apps::BrowserAppInstance& instance) {
if (shelf_id().app_id != instance.app_id) {
return;
}
int command = GetInstanceCommand(instance.id);
command_to_instance_map_.erase(command);
}
std::vector<std::pair<int, base::UnguessableToken>>
BrowserAppShelfItemController::GetMatchingInstances(
const ItemFilterPredicate& filter_predicate) {
// Iterating the map keyed by command ID, so the instances are automatically
// sorted by launch order.
std::vector<std::pair<int, base::UnguessableToken>> result;
for (const auto& pair : command_to_instance_map_) {
base::UnguessableToken id = pair.second;
aura::Window* window = nullptr;
if (shelf_id().app_id == app_constants::kLacrosAppId) {
const apps::BrowserWindowInstance* instance =
registry_->GetBrowserWindowInstanceById(id);
DCHECK(instance);
window = instance->window;
} else {
const apps::BrowserAppInstance* instance =
registry_->GetAppInstanceById(id);
DCHECK(instance);
window = instance->window;
}
if (filter_predicate.is_null() || filter_predicate.Run(window)) {
result.push_back(pair);
}
}
return result;
}
int BrowserAppShelfItemController::GetInstanceCommand(
const base::UnguessableToken& id) {
auto it = base::ranges::find(command_to_instance_map_, id,
&CommandToInstanceMap::value_type::second);
DCHECK(it != command_to_instance_map_.end());
return it->first;
}
void BrowserAppShelfItemController::LoadIcon(int32_t size_hint_in_dip,
apps::LoadIconCallback callback) {
const std::string& app_id = shelf_id().app_id;
auto* proxy = apps::AppServiceProxyFactory::GetForProfile(profile_);
icon_loader_releaser_ =
proxy->LoadIcon(proxy->AppRegistryCache().GetAppType(app_id), app_id,
apps::IconType::kStandard,
// matches favicon size
/* size_hint_in_dip= */ size_hint_in_dip,
/* allow_placeholder_icon= */ false, std::move(callback));
}
void BrowserAppShelfItemController::OnLoadMediumIcon(
apps::IconValuePtr icon_value) {
if (icon_value && icon_value->icon_type == apps::IconType::kStandard) {
medium_icon_ = icon_value->uncompressed;
// At this point, we have loaded both icons needed to assign an icon to the
// Lacros and Ash windows, so we can assign the icons to the instances that
// have already been created.
std::string app_id = shelf_id().app_id;
if (app_id == app_constants::kLacrosAppId) {
for (auto* instance : registry_->GetLacrosBrowserWindowInstances()) {
views::NativeWidgetAura::AssignIconToAuraWindow(
instance->window, bitty_icon_, medium_icon_);
}
} else {
for (auto* instance : registry_->SelectAppInstances(
[&app_id](const apps::BrowserAppInstance& instance) {
return instance.type ==
apps::BrowserAppInstance::Type::kAppWindow &&
app_id == instance.app_id;
})) {
views::NativeWidgetAura::AssignIconToAuraWindow(
instance->window, bitty_icon_, medium_icon_);
}
}
}
}
void BrowserAppShelfItemController::OnLoadBittyIcon(
apps::IconValuePtr icon_value) {
if (icon_value && icon_value->icon_type == apps::IconType::kStandard) {
bitty_icon_ = icon_value->uncompressed;
BrowserAppShelfItemController::LoadIcon(
extension_misc::EXTENSION_ICON_MEDIUM,
base::BindOnce(&BrowserAppShelfItemController::OnLoadMediumIcon,
weak_ptr_factory_.GetWeakPtr()));
}
}
|