File: chrome_saved_desk_delegate.cc

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (470 lines) | stat: -rw-r--r-- 17,980 bytes parent folder | download | duplicates (3)
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
// 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/chrome_saved_desk_delegate.h"

#include "ash/constants/notifier_catalogs.h"
#include "ash/constants/web_app_id_constants.h"
#include "ash/public/cpp/desk_template.h"
#include "ash/public/cpp/system/toast_data.h"
#include "ash/public/cpp/system/toast_manager.h"
#include "ash/public/cpp/window_properties.h"
#include "ash/strings/grit/ash_strings.h"
#include "base/check.h"
#include "base/functional/bind.h"
#include "base/trace_event/trace_event.h"
#include "chrome/app/vector_icons/vector_icons.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/icon_standardizer.h"
#include "chrome/browser/ash/profiles/profile_helper.h"
#include "chrome/browser/favicon/favicon_service_factory.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/profiles/profile_manager.h"
#include "chrome/browser/ui/ash/desks/admin_template_service_factory.h"
#include "chrome/browser/ui/ash/desks/chrome_desks_util.h"
#include "chrome/browser/ui/ash/desks/desks_client.h"
#include "chrome/browser/ui/views/frame/browser_view.h"
#include "chrome/common/webui_url_constants.h"
#include "chrome/grit/theme_resources.h"
#include "components/app_constants/constants.h"
#include "components/app_restore/app_launch_info.h"
#include "components/app_restore/app_restore_data.h"
#include "components/app_restore/app_restore_utils.h"
#include "components/app_restore/full_restore_save_handler.h"
#include "components/app_restore/full_restore_utils.h"
#include "components/app_restore/restore_data.h"
#include "components/app_restore/window_properties.h"
#include "components/desks_storage/core/admin_template_service.h"
#include "components/favicon/core/favicon_service.h"
#include "components/services/app_service/public/cpp/app_registry_cache.h"
#include "components/services/app_service/public/cpp/app_types.h"
#include "components/services/app_service/public/cpp/intent.h"
#include "components/services/app_service/public/cpp/types_util.h"
#include "components/user_manager/user_manager.h"
#include "ui/base/l10n/l10n_util.h"
#include "ui/base/models/image_model.h"
#include "ui/base/resource/resource_bundle.h"
#include "ui/base/themed_vector_icon.h"
#include "ui/color/color_id.h"
#include "ui/color/color_provider.h"
#include "ui/gfx/image/image_skia.h"
#include "ui/wm/core/window_properties.h"
#include "url/gurl.h"

namespace {

// Returns the TabStripModel that associates with `window` if the given `window`
// contains a browser frame, otherwise returns nullptr.
TabStripModel* GetTabstripModelForWindowIfAny(aura::Window* window) {
  BrowserView* browser_view =
      BrowserView::GetBrowserViewForNativeWindow(window);
  return browser_view ? browser_view->browser()->tab_strip_model() : nullptr;
}

// Returns the list of URLs that are open in `tab_strip_model`.
std::vector<GURL> GetURLsIfApplicable(TabStripModel& tab_strip_model) {
  std::vector<GURL> urls;
  for (int i = 0; i < tab_strip_model.count(); ++i) {
    urls.push_back(tab_strip_model.GetWebContentsAt(i)->GetLastCommittedURL());
  }
  return urls;
}

// Return true if `app_id` is available to launch from saved desk.
bool IsAppAvailable(apps::AppServiceProxy& app_service_proxy,
                    const std::string& app_id) {
  bool installed = false;
  Profile* app_profile = ProfileManager::GetActiveUserProfile();
  DCHECK(app_profile);

  app_service_proxy.AppRegistryCache().ForOneApp(
      app_id, [&](const apps::AppUpdate& app) {
        installed = apps_util::IsInstalled(app.Readiness());
      });
  if (installed) {
    return true;
  }
  const extensions::Extension* app =
      extensions::ExtensionRegistry::Get(app_profile)
          ->GetInstalledExtension(app_id);
  return app != nullptr;
}

// Updates `out_app_names` with titles of browser apps that aren't available
// on this device.  This is confusingly determined by resolving the `app_name`
// field to an app ID and running said ID through `IsAppAvailable`.  If the
// app is unavailable we append the app_title to `out_app_names`.
void GetUnavailableBrowserAppNames(
    apps::AppServiceProxy& app_service_proxy,
    const app_restore::RestoreData::LaunchList& launch_list,
    std::vector<std::u16string>& out_app_names) {
  for (const auto& [id, restore_data] : launch_list) {
    if (restore_data->browser_extra_info.app_type_browser.value_or(false) &&
        restore_data->browser_extra_info.app_name.has_value()) {
      std::string app_id = app_restore::GetAppIdFromAppName(
          restore_data->browser_extra_info.app_name.value());
      if (!IsAppAvailable(app_service_proxy, app_id)) {
        out_app_names.push_back(
            restore_data->window_info.app_title.value_or(u""));
      }
    }
  }
}

// Returns a vector of human readable unavailable app names from
// `desk_template`.
std::vector<std::u16string> GetUnavailableAppNames(
    const ash::DeskTemplate& saved_desk) {
  const auto& launch_lists =
      saved_desk.desk_restore_data()->app_id_to_launch_list();
  std::vector<std::u16string> app_names;
  auto* app_service_proxy = apps::AppServiceProxyFactory::GetForProfile(
      ProfileManager::GetActiveUserProfile());
  if (!app_service_proxy) {
    return app_names;
  }

  // Return the human readable app names of the unavailable apps on this device.
  for (const auto& [app_id, launch_list] : launch_lists) {
    if (launch_list.empty()) {
      continue;
    }

    // If the app ID is a browser then we need to iterate through its windows
    // to catch uninstalled PWAs.
    if (app_id == app_constants::kChromeAppId) {
      GetUnavailableBrowserAppNames(*app_service_proxy, launch_list, app_names);
    }

    if (!IsAppAvailable(*app_service_proxy, app_id)) {
      // `launch_list` is a list of windows associated with `app_id`, so we only
      // need the title of the first window.
      auto it = launch_list.begin();
      app_restore::AppRestoreData* app_restore_data = it->second.get();
      app_names.push_back(
          app_restore_data->window_info.app_title.value_or(u""));
    }
  }
  return app_names;
}

// Show unavailable app toast based on size of `unavailable_apps`.
void ShowUnavailableAppToast(
    const std::vector<std::u16string>& unavailable_apps) {
  std::u16string toast_string;
  switch (unavailable_apps.size()) {
    case 1:
      toast_string = l10n_util::GetStringFUTF16(
          IDS_ASH_DESKS_TEMPLATES_UNAVAILABLE_APP_TOAST_ONE,
          unavailable_apps[0]);
      break;
    case 2:
      toast_string = l10n_util::GetStringFUTF16(
          IDS_ASH_DESKS_TEMPLATES_UNAVAILABLE_APP_TOAST_TWO,
          unavailable_apps[0], unavailable_apps[1]);
      break;
    default:
      DCHECK_GT(unavailable_apps.size(), 2u);
      toast_string = l10n_util::GetStringFUTF16(
          IDS_ASH_DESKS_TEMPLATES_UNAVAILABLE_APP_TOAST_MORE,
          unavailable_apps[0], unavailable_apps[1],
          base::FormatNumber(unavailable_apps.size() - 2));
      break;
  }

  ash::ToastData toast_data = {
      /*id=*/chrome_desks_util::kAppNotAvailableTemplateToastName,
      ash::ToastCatalogName::kAppNotAvailable,
      /*text=*/toast_string};
  ash::ToastManager::Get()->Show(std::move(toast_data));
}

// Creates a standard icon image via `result`, and then calls `callback` with
// the standardized image.
void ImageResultToImageSkia(
    base::OnceCallback<void(const gfx::ImageSkia&)> callback,
    const favicon_base::FaviconRawBitmapResult& result) {
  TRACE_EVENT0("ui", "chrome_saved_desk_delegate::ImageResultToImageSkia");
  if (!result.is_valid()) {
    std::move(callback).Run(gfx::ImageSkia());
    return;
  }

  auto image =
      gfx::Image::CreateFrom1xPNGBytes(result.bitmap_data).AsImageSkia();
  image.EnsureRepsForSupportedScales();
  std::move(callback).Run(apps::CreateStandardIconImage(image));
}

// Creates a callback for when a app icon image is retrieved which creates a
// standard icon image and then calls `callback` with the standardized image.
base::OnceCallback<void(apps::IconValuePtr icon_value)>
AppIconResultToImageSkia(
    base::OnceCallback<void(const gfx::ImageSkia&)> callback) {
  TRACE_EVENT0("ui", "chrome_saved_desk_delegate::AppIconResultToImageSkia");
  return base::BindOnce(
      [](base::OnceCallback<void(const gfx::ImageSkia&)> image_skia_callback,
         apps::IconValuePtr icon_value) {
        auto image = icon_value->uncompressed;
        image.EnsureRepsForSupportedScales();
        std::move(image_skia_callback)
            .Run(apps::CreateStandardIconImage(image));
      },
      std::move(callback));
}

}  // namespace

ChromeSavedDeskDelegate::ChromeSavedDeskDelegate() = default;

ChromeSavedDeskDelegate::~ChromeSavedDeskDelegate() = default;

void ChromeSavedDeskDelegate::GetAppLaunchDataForSavedDesk(
    aura::Window* window,
    GetAppLaunchDataCallback callback) const {
  TRACE_EVENT0("ui", "ChromeSavedDeskDelegate::GetAppLaunchDataForSavedDesk");
  DCHECK(callback);

  const user_manager::User* active_user =
      user_manager::UserManager::Get()->GetActiveUser();
  DCHECK(active_user);
  Profile* user_profile =
      ash::ProfileHelper::Get()->GetProfileByUser(active_user);
  if (!user_profile) {
    std::move(callback).Run({});
    return;
  }

  if (!IsWindowSupportedForSavedDesk(window)) {
    std::move(callback).Run({});
    return;
  }

  // Get `full_restore_data` from FullRestoreSaveHandler which contains all
  // restoring information for all apps running on the device.
  const app_restore::RestoreData* full_restore_data =
      full_restore::FullRestoreSaveHandler::GetInstance()->GetRestoreData(
          user_profile->GetPath());
  if (!full_restore_data) {
    std::move(callback).Run({});
    return;
  }

  const std::string app_id = full_restore::GetAppId(window);
  // TODO: b/296445956 - Implement a long term fix for saving the arc ghost
  // window.
  if (app_id.empty()) {
    std::move(callback).Run({});
    return;
  }

  auto& app_registry_cache =
      apps::AppServiceProxyFactory::GetForProfile(user_profile)
          ->AppRegistryCache();
  const auto app_type = app_registry_cache.GetAppType(app_id);

  // Get the window id needed to fetch app launch info.
  const int32_t window_id = window->GetProperty(app_restore::kWindowIdKey);
  auto app_launch_info =
      std::make_unique<app_restore::AppLaunchInfo>(app_id, window_id);

  if (const std::string* app_name =
          window->GetProperty(app_restore::kBrowserAppNameKey)) {
    app_launch_info->browser_extra_info.app_name = *app_name;
  }

  // Read all other relevant app launching information from `app_restore_data`
  // to `app_launch_info`.
  const app_restore::AppRestoreData* app_restore_data =
      full_restore_data->GetAppRestoreData(app_id, window_id);
  if (app_restore_data) {
    app_launch_info->event_flag = app_restore_data->event_flag;
    app_launch_info->container = app_restore_data->container;
    app_launch_info->disposition = app_restore_data->disposition;
    app_launch_info->file_paths = app_restore_data->file_paths;
    app_launch_info->override_url = app_restore_data->override_url;
    if (app_restore_data->intent) {
      app_launch_info->intent = app_restore_data->intent->Clone();
    }
    app_launch_info->browser_extra_info.app_type_browser =
        app_restore_data->browser_extra_info.app_type_browser;
  }

  if (app_id != app_constants::kChromeAppId &&
      (app_type == apps::AppType::kChromeApp ||
       app_type == apps::AppType::kWeb)) {
    // If these values are not present, we will not be able to restore the
    // application. See http://crbug.com/1232520 for more information.
    if (!app_launch_info->container.has_value() ||
        !app_launch_info->disposition.has_value()) {
      std::move(callback).Run({});
      return;
    }
  }

  if (auto* tab_strip_model = GetTabstripModelForWindowIfAny(window)) {
    app_launch_info->browser_extra_info.urls =
        GetURLsIfApplicable(*tab_strip_model);
    app_launch_info->browser_extra_info.active_tab_index =
        tab_strip_model->active_index();
    int index_of_first_non_pinned_tab =
        tab_strip_model->IndexOfFirstNonPinnedTab();
    // Only set this field if there are pinned tabs. `IndexOfFirstNonPinnedTab`
    // returns 0 if there are no pinned tabs.
    if (index_of_first_non_pinned_tab > 0 &&
        index_of_first_non_pinned_tab <= tab_strip_model->count()) {
      app_launch_info->browser_extra_info.first_non_pinned_tab_index =
          index_of_first_non_pinned_tab;
    }
    if (tab_strip_model->SupportsTabGroups()) {
      app_launch_info->browser_extra_info.tab_group_infos =
          chrome_desks_util::ConvertTabGroupsToTabGroupInfos(
              tab_strip_model->group_model());
    }
    std::move(callback).Run(std::move(app_launch_info));
    return;
  }

  std::move(callback).Run(std::move(app_launch_info));
}

desks_storage::DeskModel* ChromeSavedDeskDelegate::GetDeskModel() {
  return DesksClient::Get()->GetDeskModel();
}

desks_storage::AdminTemplateService*
ChromeSavedDeskDelegate::GetAdminTemplateService() {
  return ash::AdminTemplateServiceFactory::GetForProfile(
      ProfileManager::GetPrimaryUserProfile());
}

bool ChromeSavedDeskDelegate::IsWindowPersistable(aura::Window* window) const {
  BrowserView* browser_view =
      BrowserView::GetBrowserViewForNativeWindow(window);
  return !(browser_view && browser_view->GetIncognito()) &&
         window->GetProperty(wm::kPersistableKey);
}

std::optional<gfx::ImageSkia>
ChromeSavedDeskDelegate::MaybeRetrieveIconForSpecialIdentifier(
    const std::string& identifier,
    const ui::ColorProvider* color_provider) const {
  TRACE_EVENT0(
      "ui", "ChromeSavedDeskDelegate::MaybeRetrieveIconForSpecialIdentifier");
  if (identifier == chrome::kChromeUINewTabURL) {
    ui::ResourceBundle& rb = ui::ResourceBundle::GetSharedInstance();
    return apps::CreateStandardIconImage(
        rb.GetImageNamed(IDR_PRODUCT_LOGO_32).AsImageSkia());
  } else if (identifier == ash::DeskTemplate::kIncognitoWindowIdentifier) {
    DCHECK(color_provider);
    gfx::ImageSkia icon =
        ui::ThemedVectorIcon(
            ui::ImageModel::FromVectorIcon(kIncognitoProfileIcon,
                                           ui::kColorAvatarIconIncognito)
                .GetVectorIcon())
            .GetImageSkia(color_provider);
    icon.EnsureRepsForSupportedScales();
    return apps::CreateStandardIconImage(icon);
  }

  return std::nullopt;
}

void ChromeSavedDeskDelegate::GetFaviconForUrl(
    const std::string& page_url,
    base::OnceCallback<void(const gfx::ImageSkia&)> callback,
    base::CancelableTaskTracker* tracker) const {
  TRACE_EVENT0("ui", "ChromeSavedDeskDelegate::GetFaviconForUrl");

  favicon::FaviconService* favicon_service =
      FaviconServiceFactory::GetForProfile(
          ProfileManager::GetActiveUserProfile(),
          ServiceAccessType::EXPLICIT_ACCESS);

  favicon_service->GetRawFaviconForPageURL(
      GURL(page_url), {favicon_base::IconType::kFavicon}, 0,
      /*fallback_to_host=*/false,
      base::BindOnce(&ImageResultToImageSkia, std::move(callback)), tracker);
}

void ChromeSavedDeskDelegate::GetIconForAppId(
    const std::string& app_id,
    int desired_icon_size,
    base::OnceCallback<void(const gfx::ImageSkia&)> callback) const {
  TRACE_EVENT0("ui", "ChromeSavedDeskDelegate::GetIconForAppId");
  auto* app_service_proxy = apps::AppServiceProxyFactory::GetForProfile(
      ProfileManager::GetActiveUserProfile());
  if (!app_service_proxy) {
    std::move(callback).Run(gfx::ImageSkia());
    return;
  }

  app_service_proxy->LoadIcon(app_id, apps::IconType::kStandard,
                              desired_icon_size,
                              /*allow_placeholder_icon=*/false,
                              AppIconResultToImageSkia(std::move(callback)));
}

bool ChromeSavedDeskDelegate::IsAppAvailable(const std::string& app_id) const {
  Profile* app_profile = ProfileManager::GetActiveUserProfile();
  DCHECK(app_profile);

  auto* app_service_proxy =
      apps::AppServiceProxyFactory::GetForProfile(app_profile);
  CHECK(app_service_proxy);

  return ::IsAppAvailable(*app_service_proxy, app_id);
}

void ChromeSavedDeskDelegate::LaunchAppsFromSavedDesk(
    std::unique_ptr<ash::DeskTemplate> saved_desk) {
  std::vector<std::u16string> unavailable_apps =
      GetUnavailableAppNames(*saved_desk);
  // Show app unavailable toast.
  if (!unavailable_apps.empty()) {
    ShowUnavailableAppToast(unavailable_apps);
  }
  DesksClient::Get()->LaunchAppsFromTemplate(std::move(saved_desk));
}

// Returns true if `window` is supported in desk templates feature.
bool ChromeSavedDeskDelegate::IsWindowSupportedForSavedDesk(
    aura::Window* window) const {
  if (!window) {
    return false;
  }

  const auto* app_id = window->GetProperty(ash::kAppIDKey);
  // Feedback app is not saved, see http://b/301479278.
  if (app_id && *app_id == ash::kOsFeedbackAppId) {
    return false;
  }

  if (!ash::DeskTemplate::IsAppTypeSupported(window)) {
    return false;
  }

  // Exclude incognito browser window.
  return IsWindowPersistable(window);
}

std::string ChromeSavedDeskDelegate::GetAppShortName(
    const std::string& app_id) {
  TRACE_EVENT0("ui", "ChromeSavedDeskDelegate::GetAppShortName");
  std::string name;
  auto* profile = ProfileManager::GetActiveUserProfile();
  auto* app_service_proxy =
      apps::AppServiceProxyFactory::IsAppServiceAvailableForProfile(profile)
          ? apps::AppServiceProxyFactory::GetForProfile(profile)
          : nullptr;
  if (!app_service_proxy) {
    return name;
  }

  app_service_proxy->AppRegistryCache().ForOneApp(
      app_id,
      [&name](const apps::AppUpdate& update) { name = update.ShortName(); });
  return name;
}