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 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825
|
// 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/desks/desks_client.h"
#include <cstddef>
#include <memory>
#include <string>
#include "ash/accessibility/accessibility_controller.h"
#include "ash/constants/ash_features.h"
#include "ash/public/cpp/desk_template.h"
#include "ash/public/cpp/session/session_controller.h"
#include "ash/public/cpp/window_properties.h"
#include "ash/shell.h"
#include "ash/strings/grit/ash_strings.h"
#include "ash/wm/desks/desk.h"
#include "ash/wm/desks/desks_controller.h"
#include "ash/wm/desks/desks_histogram_enums.h"
#include "ash/wm/desks/desks_restore_util.h"
#include "ash/wm/desks/overview_desk_bar_view.h"
#include "ash/wm/desks/templates/saved_desk_util.h"
#include "ash/wm/overview/overview_controller.h"
#include "ash/wm/overview/overview_grid.h"
#include "ash/wm/overview/overview_session.h"
#include "base/functional/bind.h"
#include "base/functional/callback_helpers.h"
#include "base/memory/raw_ptr.h"
#include "base/metrics/histogram_functions.h"
#include "base/scoped_observation.h"
#include "base/task/single_thread_task_runner.h"
#include "base/timer/timer.h"
#include "base/types/expected.h"
#include "base/uuid.h"
#include "base/values.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/ash/floating_workspace/floating_workspace_util.h"
#include "chrome/browser/ash/profiles/profile_helper.h"
#include "chrome/browser/chromeos/extensions/wm/wm_desks_private_events.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/profiles/profile_manager.h"
#include "chrome/browser/sync/desk_sync_service_factory.h"
#include "chrome/browser/ui/ash/desks/admin_template_service_factory.h"
#include "chrome/browser/ui/ash/desks/desks_templates_app_launch_handler.h"
#include "chrome/browser/ui/browser.h"
#include "chrome/browser/ui/browser_list.h"
#include "chrome/browser/ui/browser_window.h"
#include "components/app_constants/constants.h"
#include "components/app_restore/app_restore_info.h"
#include "components/app_restore/window_properties.h"
#include "components/desks_storage/core/desk_model_wrapper.h"
#include "components/desks_storage/core/desk_sync_service.h"
#include "components/desks_storage/core/local_desk_data_manager.h"
#include "components/sessions/core/session_id.h"
#include "ui/aura/client/aura_constants.h"
#include "ui/aura/window.h"
#include "ui/base/l10n/l10n_util.h"
#include "ui/views/widget/widget.h"
namespace {
DesksClient* g_desks_client_instance = nullptr;
// Timeout time used in LaunchPerformanceTracker.
constexpr base::TimeDelta kLaunchPerformanceTimeout = base::Minutes(3);
// Histogram name to track estimated time it takes to load a template. Used by
// LaunchPerformanceTracker. Note that this is in a different spot than the
// other metrics because the class that uses this is owned by `this`.
constexpr char kTimeToLoadTemplateHistogramName[] =
"Ash.DeskTemplate.TimeToLoadTemplate";
// Launch data is cleared after this time.
constexpr base::TimeDelta kClearLaunchDataDuration = base::Seconds(20);
// Returns true if `profile` is a supported profile in desk template feature.
bool IsSupportedProfile(Profile* profile) {
// Public users & guest users are not supported.
return profile && profile->IsRegularProfile();
}
// Creates a set of window IDs for the launch tracker to monitor for.
std::set<int> GetWindowIDSetFromTemplate(
const ash::DeskTemplate* desk_template) {
std::set<int> window_ids;
const app_restore::RestoreData* desk_restore_data =
desk_template->desk_restore_data();
for (const auto& app : desk_restore_data->app_id_to_launch_list()) {
for (const auto& window : app.second) {
window_ids.insert(window.first);
}
}
return window_ids;
}
// Records the time to load a template based on the starting time `time_started`
// passed into this function and a call to base::Time::Now called at the
// beginning of this function.
void RecordTimeToLoadTemplateHistogram(const base::Time time_started) {
base::UmaHistogramMediumTimes(kTimeToLoadTemplateHistogramName,
base::Time::Now() - time_started);
}
// Retrieves desk event router
extensions::WMDesksEventsRouter* GetDeskEventsRouter() {
auto* profile = ProfileManager::GetActiveUserProfile();
if (profile) {
auto* wm_events_api = extensions::WMDesksPrivateEventsAPI::Get(profile);
if (wm_events_api && wm_events_api->desks_event_router()) {
return wm_events_api->desks_event_router();
}
}
return nullptr;
}
} // namespace
// Tracks a set of WindowIDs through the launching process, records a
// launch performance metric when the set of window_ids have all been
// launched
class DesksClient::LaunchPerformanceTracker
: public app_restore::AppRestoreInfo::Observer {
public:
LaunchPerformanceTracker(const std::set<int>& window_ids,
base::Uuid template_id,
DesksClient* templates_client)
: tracked_window_ids_(window_ids),
time_launch_started_(base::Time::Now()),
template_id_(template_id),
templates_client_(templates_client) {
scoped_observation_.Observe(app_restore::AppRestoreInfo::GetInstance());
timeout_timer_ = std::make_unique<base::OneShotTimer>();
timeout_timer_->Start(
FROM_HERE, kLaunchPerformanceTimeout,
base::BindOnce(&DesksClient::LaunchPerformanceTracker::OnTimeout,
weak_ptr_factory_.GetWeakPtr()));
}
LaunchPerformanceTracker(const LaunchPerformanceTracker&) = delete;
LaunchPerformanceTracker& operator=(const LaunchPerformanceTracker&) = delete;
~LaunchPerformanceTracker() override = default;
// Removes window ID from tracked set because the window has been launched.
// app_restore::AppRestoreInfo::Observer:
void OnWidgetInitialized(views::Widget* widget) override {
tracked_window_ids_.erase(widget->GetNativeWindow()->GetProperty(
app_restore::kRestoreWindowIdKey));
MaybeRecordMetric();
}
// Removes `window_id` from the tracked set because the window has already
// been launched by another process.
void OnMovedSingleInstanceApp(int32_t window_id) {
tracked_window_ids_.erase(window_id);
MaybeRecordMetric();
}
private:
// Records performance metric iff `tracked_window_ids_` are empty.
void MaybeRecordMetric() {
if (tracked_window_ids_.empty()) {
RecordTimeToLoadTemplateHistogram(time_launch_started_);
// Remove this tracker. We do this async since this function may be called
// from DesksClient code that iterates over the map of trackers. See
// http://b/271156600 for more info.
base::SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE,
base::BindOnce(&DesksClient::RemoveLaunchPerformanceTracker,
base::Unretained(templates_client_), template_id_));
}
}
// Called when timeout timer runs out. Records time metric.
void OnTimeout() {
tracked_window_ids_.clear();
MaybeRecordMetric();
}
std::set<int> tracked_window_ids_;
base::Time time_launch_started_;
base::Uuid template_id_;
std::unique_ptr<base::OneShotTimer> timeout_timer_;
// Pointer back to the owning templates client. This is done to facilitate
// this object's removal from the mapping of template id's to trackers after
// this object has recorded its metric.
raw_ptr<DesksClient> templates_client_;
base::ScopedObservation<app_restore::AppRestoreInfo,
app_restore::AppRestoreInfo::Observer>
scoped_observation_{this};
base::WeakPtrFactory<LaunchPerformanceTracker> weak_ptr_factory_{this};
};
// Observer for listening to desk related events.
class DesksClient::DeskEventObserver : public ash::DesksController::Observer {
public:
explicit DeskEventObserver(ash::DesksController* source) {
// `DesksController` not initialized in unit test.
if (source) {
obs_.Observe(source);
}
}
DeskEventObserver(const DeskEventObserver& observer) = delete;
DeskEventObserver& operator=(const DeskEventObserver& observer) = delete;
// ScopedObservation handles stopping observing in destruction.
~DeskEventObserver() override = default;
void OnDeskAdded(const ash::Desk* desk, bool from_undo) override {
// If there is listener in ash-chrome, dispatch events.
if (auto* desk_events_router = GetDeskEventsRouter()) {
desk_events_router->OnDeskAdded(desk->uuid(), from_undo);
}
}
void OnDeskRemovalFinalized(const base::Uuid& uuid) override {
// TODO(b/287382267): Add E2E browser test.
if (auto* desk_events_router = GetDeskEventsRouter()) {
desk_events_router->OnDeskRemoved(uuid);
}
}
void OnDeskActivationChanged(const ash::Desk* activated,
const ash::Desk* deactivated) override {
if (auto* desk_events_router = GetDeskEventsRouter()) {
desk_events_router->OnDeskSwitched(activated->uuid(),
deactivated->uuid());
}
}
private:
base::ScopedObservation<ash::DesksController, ash::DesksController::Observer>
obs_{this};
};
DesksClient::DesksClient() : desks_controller_(ash::DesksController::Get()) {
DCHECK(!g_desks_client_instance);
g_desks_client_instance = this;
if (ash::SessionController::Get()) {
ash::SessionController::Get()->AddObserver(this);
}
desk_event_observer_ =
std::make_unique<DeskEventObserver>(ash::DesksController::Get());
}
DesksClient::~DesksClient() {
DCHECK_EQ(this, g_desks_client_instance);
g_desks_client_instance = nullptr;
if (ash::SessionController::Get()) {
ash::SessionController::Get()->RemoveObserver(this);
}
}
// static
DesksClient* DesksClient::Get() {
return g_desks_client_instance;
}
void DesksClient::OnActiveUserSessionChanged(const AccountId& account_id) {
Profile* profile =
ash::ProfileHelper::Get()->GetProfileByAccountId(account_id);
if (profile == active_profile_ || !IsSupportedProfile(profile)) {
return;
}
active_profile_ = profile;
DCHECK(active_profile_);
save_and_recall_desks_storage_manager_ =
std::make_unique<desks_storage::LocalDeskDataManager>(
active_profile_->GetPath(), account_id);
if (ash::features::IsDeskTemplateSyncEnabled() &&
(ash::saved_desk_util::AreDesksTemplatesEnabled() ||
ash::floating_workspace_util::IsFloatingWorkspaceV2Enabled())) {
saved_desk_storage_manager_ =
std::make_unique<desks_storage::DeskModelWrapper>(
save_and_recall_desks_storage_manager_.get());
}
// Ensure that admin templates are ready to go. This will only query from the
// primary profile but it happens early enough to ensure that the model is
// loaded when the user logs in.
ash::AdminTemplateServiceFactory::GetForProfile(
ProfileManager::GetPrimaryUserProfile());
}
// TODO(aprilzhou): Refactor DesksClient to remove unnecessary callback. It's
// causing the code to be less readable.
void DesksClient::CaptureActiveDeskAndSaveTemplate(
CaptureActiveDeskAndSaveTemplateCallback callback,
ash::DeskTemplateType template_type) {
CaptureActiveDesk(
base::BindOnce(&DesksClient::OnCapturedDeskTemplate,
weak_ptr_factory_.GetWeakPtr(), std::move(callback)),
template_type);
}
void DesksClient::CaptureActiveDesk(
CaptureActiveDeskAndSaveTemplateCallback callback,
ash::DeskTemplateType template_type) {
if (!active_profile_) {
std::move(callback).Run(DeskActionError::kNoCurrentUserError,
/*desk_template=*/nullptr);
return;
}
desks_controller_->CaptureActiveDeskAsSavedDesk(
base::BindOnce(
[](CaptureActiveDeskAndSaveTemplateCallback callback,
std::unique_ptr<ash::DeskTemplate> desk_template) {
if (!desk_template) {
std::move(callback).Run(DeskActionError::kUnknownError, {});
return;
}
std::move(callback).Run(std::nullopt, std::move(desk_template));
},
std::move(callback)),
template_type,
/*root_window_to_show=*/nullptr, /*coral_app_id_allowlist=*/{});
}
void DesksClient::DeleteDeskTemplate(const base::Uuid& template_uuid,
DeleteDeskTemplateCallback callback) {
if (!active_profile_) {
std::move(callback).Run(DeskActionError::kNoCurrentUserError);
return;
}
GetDeskModel()->DeleteEntry(
template_uuid,
base::BindOnce(&DesksClient::OnDeleteDeskTemplate,
weak_ptr_factory_.GetWeakPtr(), std::move(callback)));
}
void DesksClient::GetDeskTemplates(GetDeskTemplatesCallback callback) {
if (!active_profile_) {
std::move(callback).Run(DeskActionError::kNoCurrentUserError,
/*desk_templates=*/{});
return;
}
auto result = GetDeskModel()->GetAllEntries();
std::move(callback).Run(
result.status != desks_storage::DeskModel::GetAllEntriesStatus::kOk
? std::make_optional(DeskActionError::kStorageError)
: std::nullopt,
result.entries);
}
void DesksClient::GetTemplateJson(const base::Uuid& uuid,
Profile* profile,
GetTemplateJsonCallback callback) {
if (!active_profile_ || active_profile_ != profile) {
std::move(callback).Run(DeskActionError::kBadProfileError,
/*desk_templates=*/{});
return;
}
apps::AppRegistryCache& app_cache =
apps::AppServiceProxyFactory::GetForProfile(profile)->AppRegistryCache();
GetDeskModel()->GetTemplateJson(
uuid, &app_cache,
base::BindOnce(&DesksClient::OnGetTemplateJson,
weak_ptr_factory_.GetWeakPtr(), std::move(callback)));
}
void DesksClient::LaunchDeskTemplate(
const base::Uuid& template_uuid,
LaunchDeskCallback callback,
const std::u16string& customized_desk_name) {
if (!active_profile_) {
std::move(callback).Run(DeskActionError::kNoCurrentUserError, {});
return;
}
if (launch_template_for_test_) {
OnGetTemplateForDeskLaunch(
std::move(callback), customized_desk_name,
desks_storage::DeskModel::GetEntryByUuidStatus::kOk,
launch_template_for_test_->Clone());
return;
}
desks_storage::DeskModel::GetEntryByUuidResult result =
GetDeskModel()->GetEntryByUUID(template_uuid);
OnGetTemplateForDeskLaunch(std::move(callback), customized_desk_name,
result.status, std::move(result.entry));
}
base::expected<const base::Uuid, DesksClient::DeskActionError>
DesksClient::LaunchEmptyDesk(const std::u16string& customized_desk_name) {
if (!desks_controller_->CanCreateDesks()) {
return base::unexpected(DeskActionError::kDesksCountCheckFailedError);
}
// Don't launch desk if desk is being modified(activated/removed/switched) or
// desk animation is in progress.
if (desks_controller_->AreDesksBeingModified()) {
return base::unexpected(DeskActionError::kDesksBeingModifiedError);
}
const ash::Desk* new_desk = CreateEmptyDeskAndActivate(customized_desk_name);
return new_desk->uuid();
}
std::optional<DesksClient::DeskActionError> DesksClient::RemoveDesk(
const base::Uuid& desk_uuid,
ash::DeskCloseType close_type) {
// Return error if `desk_uuid` is invalid.
if (!desk_uuid.is_valid()) {
return DeskActionError::kInvalidIdError;
}
ash::Desk* desk = desks_controller_->GetDeskByUuid(desk_uuid);
// Can't clean up desk when desk identifier is incorrect.
if (!desk) {
return DeskActionError::kResourceNotFoundError;
}
// Don't remove desk if desk is being modified(activated/removed/switched) or
// desk animation is in progress.
if (desks_controller_->AreDesksBeingModified()) {
return DeskActionError::kDesksBeingModifiedError;
}
// Can't clean up desk when there is no more than 1 desk left.
if (!desks_controller_->CanRemoveDesks()) {
return DeskActionError::kDesksCountCheckFailedError;
}
desks_controller_->RemoveDesk(desk, ash::DesksCreationRemovalSource::kApi,
close_type);
return std::nullopt;
}
base::expected<std::vector<const ash::Desk*>, DesksClient::DeskActionError>
DesksClient::GetAllDesks() {
// There should be at least one default desk.
if (desks_controller_->desks().empty()) {
return base::unexpected(DeskActionError::kUnknownError);
}
std::vector<const ash::Desk*> desks;
for (const auto& desk : desks_controller_->desks()) {
desks.push_back(desk.get());
}
return std::move(desks);
}
void DesksClient::LaunchAppsFromTemplate(
std::unique_ptr<ash::DeskTemplate> desk_template) {
DCHECK(desk_template);
// Generate a unique ID for this launch. It is used to tell different template
// launches apart.
const int32_t launch_id = DesksTemplatesAppLaunchHandler::GetNextLaunchId();
app_restore::RestoreData* restore_data =
desk_template->mutable_desk_restore_data();
if (!restore_data) {
return;
}
if (restore_data->app_id_to_launch_list().empty()) {
return;
}
// Make window IDs of the template unique. This is a requirement for launching
// templates concurrently since the contained window IDs are used as lookup
// keys in many places. We must also do this *before* creating the performance
// tracker below.
restore_data->MakeWindowIdsUniqueForDeskTemplate();
template_ids_to_launch_performance_trackers_[desk_template->uuid()] =
std::make_unique<LaunchPerformanceTracker>(
GetWindowIDSetFromTemplate(desk_template.get()),
desk_template->uuid(), this);
DCHECK(active_profile_);
auto& handler = app_launch_handlers_[launch_id];
// Some tests reach into this class and install a handler ahead of time. In
// all other cases, we create a handler for the launch here.
if (!handler) {
handler = std::make_unique<DesksTemplatesAppLaunchHandler>(
active_profile_, DesksTemplatesAppLaunchHandler::Type::kTemplate);
}
handler->LaunchTemplate(*desk_template, launch_id);
// Install a timer that will clear the launch handler after a given duration.
base::SingleThreadTaskRunner::GetCurrentDefault()->PostDelayedTask(
FROM_HERE,
base::BindOnce(&DesksClient::OnLaunchComplete,
weak_ptr_factory_.GetWeakPtr(), launch_id),
kClearLaunchDataDuration);
}
desks_storage::DeskModel* DesksClient::GetDeskModel() {
// Get local storage only when 1) Desk templates sync is
// disabled or 2) Desk Templates and Floating workspace are disabled. If we
// are unable to get the desk sync service or its bridge, then we default to
// using the local storage.
desks_storage::DeskSyncService* desk_sync_service =
DeskSyncServiceFactory::GetForProfile(active_profile_);
if ((!desk_sync_service || !desk_sync_service->GetDeskModel()) ||
!ash::features::IsDeskTemplateSyncEnabled() ||
(!ash::saved_desk_util::AreDesksTemplatesEnabled() &&
!ash::floating_workspace_util::IsFloatingWorkspaceV2Enabled())) {
DCHECK(save_and_recall_desks_storage_manager_.get());
return save_and_recall_desks_storage_manager_.get();
}
saved_desk_storage_manager_->SetDeskSyncBridge(
static_cast<desks_storage::DeskSyncBridge*>(
desk_sync_service->GetDeskModel()));
return saved_desk_storage_manager_.get();
}
// Sets the preconfigured desk template. Data contains the contents of the JSON
// file with the template information
void DesksClient::SetPolicyPreconfiguredTemplate(
const AccountId& account_id,
std::unique_ptr<std::string> data) {
Profile* profile =
ash::ProfileHelper::Get()->GetProfileByAccountId(account_id);
if (!data || !IsSupportedProfile(profile)) {
return;
}
std::string& in_map_data = preconfigured_desk_templates_json_[account_id];
if (in_map_data == *data) {
return;
}
in_map_data = *data;
if (profile && profile == active_profile_) {
GetDeskModel()->SetPolicyDeskTemplates(*data);
}
}
void DesksClient::RemovePolicyPreconfiguredTemplate(
const AccountId& account_id) {
Profile* profile =
ash::ProfileHelper::Get()->GetProfileByAccountId(account_id);
if (!IsSupportedProfile(profile)) {
return;
}
DCHECK(profile);
preconfigured_desk_templates_json_.erase(account_id);
if (profile == active_profile_) {
GetDeskModel()->RemovePolicyDeskTemplates();
}
}
void DesksClient::NotifyMovedSingleInstanceApp(int32_t window_id) {
for (auto& id_to_tracker : template_ids_to_launch_performance_trackers_) {
id_to_tracker.second->OnMovedSingleInstanceApp(window_id);
}
}
std::optional<DesksClient::DeskActionError>
DesksClient::SetAllDeskPropertyByBrowserSessionId(SessionID browser_session_id,
bool all_desk) {
if (!browser_session_id.is_valid()) {
return DeskActionError::kInvalidIdError;
}
aura::Window* window = GetWindowByBrowserSessionId(browser_session_id);
if (!window) {
return DeskActionError::kResourceNotFoundError;
}
window->SetProperty(aura::client::kWindowWorkspaceKey,
all_desk
? aura::client::kWindowWorkspaceVisibleOnAllWorkspaces
: aura::client::kWindowWorkspaceUnassignedWorkspace);
return std::nullopt;
}
base::Uuid DesksClient::GetActiveDesk() {
return desks_controller_->GetTargetActiveDesk()->uuid();
}
base::expected<const ash::Desk*, DesksClient::DeskActionError>
DesksClient::GetDeskByID(const base::Uuid& desk_uuid) const {
ash::Desk* desk = desks_controller_->GetDeskByUuid(desk_uuid);
if (!desk) {
return base::unexpected(DeskActionError::kResourceNotFoundError);
}
return desk;
}
std::optional<DesksClient::DeskActionError> DesksClient::SwitchDesk(
const base::Uuid& desk_uuid) {
ash::Desk* desk = desks_controller_->GetDeskByUuid(desk_uuid);
if (!desk) {
return DeskActionError::kResourceNotFoundError;
}
// Don't switch desk if desk is being modified(activated/removed/switched) or
// desk animation is in progress.
if (desks_controller_->AreDesksBeingModified()) {
return DeskActionError::kDesksBeingModifiedError;
}
desks_controller_->ActivateDesk(desk, ash::DesksSwitchSource::kApiSwitch);
return std::nullopt;
}
void DesksClient::OnGetTemplateForDeskLaunch(
LaunchDeskCallback callback,
std::u16string customized_desk_name,
desks_storage::DeskModel::GetEntryByUuidStatus status,
std::unique_ptr<ash::DeskTemplate> saved_desk) {
if (status != desks_storage::DeskModel::GetEntryByUuidStatus::kOk) {
std::move(callback).Run(DeskActionError::kStorageError, {});
return;
}
if (!desks_controller_->CanCreateDesks()) {
std::move(callback).Run(DeskActionError::kDesksCountCheckFailedError, {});
return;
}
// We prioritize `customized_desk_name` over the saved desk's name. An example
// is that for call center application use case, we launch the same template
// for different customer and assign desk name to be customer's name.
const auto& template_name = customized_desk_name.empty()
? saved_desk->template_name()
: customized_desk_name;
const ash::Desk* new_desk = desks_controller_->CreateNewDeskForSavedDesk(
saved_desk->type(), template_name);
if (!saved_desk->desk_restore_data()) {
std::move(callback).Run(DeskActionError::kUnknownError, {});
return;
}
// Copy the uuid of the newly created desk to the saved desk. This ensures
// that apps appear on the right desk even if the user switches to another.
saved_desk->SetDeskUuid(new_desk->uuid());
const auto saved_desk_type = saved_desk->type();
const auto uuid = saved_desk->uuid();
// Launch the windows as specified in the saved desk to a new desk.
LaunchAppsFromTemplate(std::move(saved_desk));
if (saved_desk_type == ash::DeskTemplateType::kSaveAndRecall) {
GetDeskModel()->DeleteEntry(
uuid, base::BindOnce(&DesksClient::OnRecallSavedDesk,
weak_ptr_factory_.GetWeakPtr(),
std::move(callback), new_desk->uuid()));
} else {
std::move(callback).Run(std::nullopt, new_desk->uuid());
}
}
void DesksClient::OnCaptureActiveDeskAndSaveTemplate(
DesksClient::CaptureActiveDeskAndSaveTemplateCallback callback,
desks_storage::DeskModel::AddOrUpdateEntryStatus status,
std::unique_ptr<ash::DeskTemplate> desk_template) {
if (status != desks_storage::DeskModel::AddOrUpdateEntryStatus::kOk) {
std::move(callback).Run(DeskActionError::kUnknownError,
std::move(desk_template));
return;
}
const auto saved_desk_type = desk_template->type();
if (saved_desk_type == ash::DeskTemplateType::kSaveAndRecall) {
// TODO(aprilzhou): Now it's the exact copy from ash/wm/desks/templates/
// saved_desk_presenter.cc:Showlibrary. Should be removed once we provide
// API to manage saved desk name.
auto* overview_controller = ash::Shell::Get()->overview_controller();
auto* overview_session = overview_controller->overview_session();
if (!overview_session) {
if (!overview_controller->StartOverview(
ash::OverviewStartAction::kDevTools,
ash::OverviewEnterExitType::kImmediateEnterWithoutFocus)) {
// If for whatever reason we didn't enter overview mode, bail.
std::move(callback).Run(std::nullopt, std::move(desk_template));
return;
}
overview_session = overview_controller->overview_session();
DCHECK(overview_session);
}
overview_session->ShowSavedDeskLibrary(desk_template->uuid(),
desk_template->template_name(),
ash::Shell::GetPrimaryRootWindow());
// We have successfully created a *new* desk template for Save & Recall,
// so we are now going to close all the windows on the active desk and
// also remove the desk.
auto* active_desk = desks_controller_->active_desk();
// If this is the only desk, we have to create a new desk before we can
// remove the current one.
if (!desks_controller_->CanRemoveDesks()) {
desks_controller_->NewDesk(
ash::DesksCreationRemovalSource::kEnsureDefaultDesk);
}
// Remove the current desk, this will be done without animation.
desks_controller_->RemoveDesk(
active_desk, ash::DesksCreationRemovalSource::kSaveAndRecall,
ash::DeskCloseType::kCloseAllWindows);
}
std::move(callback).Run(std::nullopt, std::move(desk_template));
}
void DesksClient::OnDeleteDeskTemplate(
DesksClient::DeleteDeskTemplateCallback callback,
desks_storage::DeskModel::DeleteEntryStatus status) {
std::move(callback).Run(
status != desks_storage::DeskModel::DeleteEntryStatus::kOk
? std::make_optional(DeskActionError::kNoCurrentUserError)
: std::nullopt);
}
void DesksClient::OnRecallSavedDesk(
DesksClient::LaunchDeskCallback callback,
const base::Uuid& desk_id,
desks_storage::DeskModel::DeleteEntryStatus status) {
std::move(callback).Run(
status != desks_storage::DeskModel::DeleteEntryStatus::kOk
? std::make_optional(DeskActionError::kNoCurrentUserError)
: std::nullopt,
desk_id);
}
void DesksClient::OnCapturedDeskTemplate(
CaptureActiveDeskAndSaveTemplateCallback callback,
std::optional<DesksClient::DeskActionError> error,
std::unique_ptr<ash::DeskTemplate> desk_template) {
if (error) {
std::move(callback).Run(error, {});
return;
}
if (!desk_template) {
std::move(callback).Run(DeskActionError::kUnknownError, {});
return;
}
GetDeskModel()->AddOrUpdateEntry(
std::move(desk_template),
base::BindOnce(&DesksClient::OnCaptureActiveDeskAndSaveTemplate,
weak_ptr_factory_.GetWeakPtr(), std::move(callback)));
}
void DesksClient::OnGetTemplateJson(
DesksClient::GetTemplateJsonCallback callback,
desks_storage::DeskModel::GetTemplateJsonStatus status,
const base::Value& json_representation) {
std::move(callback).Run(
status != desks_storage::DeskModel::GetTemplateJsonStatus::kOk
? std::make_optional(DeskActionError::kStorageError)
: std::nullopt,
json_representation);
}
void DesksClient::OnLaunchComplete(int32_t launch_id) {
app_launch_handlers_.erase(launch_id);
}
void DesksClient::RemoveLaunchPerformanceTracker(
const base::Uuid& tracker_uuid) {
template_ids_to_launch_performance_trackers_.erase(tracker_uuid);
}
aura::Window* DesksClient::GetWindowByBrowserSessionId(
SessionID browser_session_id) {
for (Browser* browser : *BrowserList::GetInstance()) {
if (browser->session_id() == browser_session_id) {
return browser->window()->GetNativeWindow();
}
}
return nullptr;
}
const ash::Desk* DesksClient::CreateEmptyDeskAndActivate(
const std::u16string& customized_desk_name) {
DCHECK(desks_controller_->CanCreateDesks());
// If there is an ongoing animation, we should stop it before creating and
// activating the new desk, which triggers its own animation.
desks_controller_->ResetAnimation();
// Desk name was set to a default name upon creation. If
// `customized_desk_name` is provided, override desk name to be
// `customized_desk_name` or `customized_desk_name ({counter})` to resolve
// naming conflicts.
std::u16string desk_name =
desks_controller_->CreateUniqueDeskName(customized_desk_name);
desks_controller_->NewDesk(ash::DesksCreationRemovalSource::kApi);
ash::Desk* desk = desks_controller_->desks().back().get();
if (!desk_name.empty()) {
desk->SetName(desk_name, /*set_by_user=*/true);
ash::Shell::Get()
->accessibility_controller()
->TriggerAccessibilityAlertWithMessage(l10n_util::GetStringFUTF8(
IDS_ASH_VIRTUAL_DESKS_ALERT_NEW_DESK_CREATED, desk_name));
}
// Force update user prefs because `SetName()` does not trigger it.
ash::desks_restore_util::UpdatePrimaryUserDeskNamesPrefs();
desks_controller_->ActivateDesk(desk, ash::DesksSwitchSource::kApiLaunch);
return desk;
}
|