File: web_app_shim_manager_delegate_mac.cc

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (460 lines) | stat: -rw-r--r-- 17,763 bytes parent folder | download | duplicates (6)
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
// Copyright 2020 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/apps/app_shim/web_app_shim_manager_delegate_mac.h"

#include <algorithm>

#include "base/barrier_closure.h"
#include "base/functional/callback_helpers.h"
#include "base/no_destructor.h"
#include "chrome/browser/apps/app_service/app_launch_params.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_launcher.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/ui/web_applications/web_app_dialogs.h"
#include "chrome/browser/web_applications/os_integration/os_integration_manager.h"
#include "chrome/browser/web_applications/os_integration/web_app_file_handler_manager.h"
#include "chrome/browser/web_applications/web_app.h"
#include "chrome/browser/web_applications/web_app_command_scheduler.h"
#include "chrome/browser/web_applications/web_app_constants.h"
#include "chrome/browser/web_applications/web_app_provider.h"
#include "chrome/browser/web_applications/web_app_registrar.h"
#include "chrome/browser/web_applications/web_app_utils.h"
#include "chrome/common/chrome_switches.h"
#include "components/services/app_service/public/cpp/app_launch_util.h"
#include "net/base/filename_util.h"
#include "third_party/blink/public/common/custom_handlers/protocol_handler_utils.h"

namespace web_app {

namespace {

// Testing hook for BrowserAppLauncher::LaunchAppWithParams
web_app::BrowserAppLauncherForTesting& GetBrowserAppLauncherForTesting() {
  static base::NoDestructor<web_app::BrowserAppLauncherForTesting> instance;
  return *instance;
}

// Launches the app specified by `params` and `file_launches` in the given
// `profile`.
void LaunchAppWithParams(
    Profile* profile,
    apps::AppLaunchParams params,
    const WebAppFileHandlerManager::LaunchInfos& file_launches,
    base::OnceClosure launch_finished_callback) {
  if (!file_launches.empty()) {
    auto barrier_callback = base::BarrierClosure(
        file_launches.size(), std::move(launch_finished_callback));
    for (const auto& [url, files] : file_launches) {
      apps::AppLaunchParams params_copy(params.app_id, params.container,
                                        params.disposition,
                                        params.launch_source);
      params_copy.override_url = url;
      params_copy.launch_files = files;

      if (GetBrowserAppLauncherForTesting()) {
        GetBrowserAppLauncherForTesting().Run(params_copy);
        barrier_callback.Run();
      } else {
        apps::AppServiceProxyFactory::GetForProfile(profile)
            ->BrowserAppLauncher()
            ->LaunchAppWithParams(
                std::move(params_copy),
                base::IgnoreArgs<content::WebContents*>(barrier_callback));
      }
    }
    return;
  }

  if (GetBrowserAppLauncherForTesting()) {
    GetBrowserAppLauncherForTesting().Run(params);
    std::move(launch_finished_callback).Run();
  } else {
    apps::AppServiceProxyFactory::GetForProfile(profile)
        ->BrowserAppLauncher()
        ->LaunchAppWithParams(std::move(params),
                              base::IgnoreArgs<content::WebContents*>(
                                  std::move(launch_finished_callback)));
  }
}

// Cancels the launch of the app for the given `app_id`, potentially resulting
// in the app shim exiting.
void CancelAppLaunch(Profile* profile, const webapps::AppId& app_id) {
  apps::AppShimManager::Get()->OnAppLaunchCancelled(profile, app_id);
}

// Called after the user's preference has been persisted, and the OS
// has been notified of the change.
void OnPersistUserChoiceCompleted(
    apps::AppLaunchParams params,
    const WebAppFileHandlerManager::LaunchInfos& file_launches,
    Profile* profile,
    base::OnceClosure launch_finished_callback,
    bool allowed) {
  if (allowed) {
    LaunchAppWithParams(profile, std::move(params), file_launches,
                        std::move(launch_finished_callback));
  } else {
    CancelAppLaunch(profile, params.app_id);
    std::move(launch_finished_callback).Run();
  }
}

// Called after the user has dismissed the WebAppProtocolHandlerIntentPicker
// dialog.
void UserChoiceDialogCompleted(
    apps::AppLaunchParams params,
    const WebAppFileHandlerManager::LaunchInfos& file_launches,
    Profile* profile,
    base::OnceClosure launch_finished_callback,
    bool allowed,
    bool remember_user_choice) {
  std::optional<GURL> protocol_url = params.protocol_handler_launch_url;
  const bool is_file_launch = !file_launches.empty();
  webapps::AppId app_id = params.app_id;

  auto persist_done = base::BindOnce(
      &OnPersistUserChoiceCompleted, std::move(params), file_launches, profile,
      std::move(launch_finished_callback), allowed);

  if (remember_user_choice) {
    WebAppProvider* provider = WebAppProvider::GetForWebApps(profile);
    ApiApprovalState approval_state =
        allowed ? ApiApprovalState::kAllowed : ApiApprovalState::kDisallowed;
    if (protocol_url) {
      provider->scheduler().UpdateProtocolHandlerUserApproval(
          app_id, protocol_url->scheme(), approval_state,
          std::move(persist_done));
    } else {
      DCHECK(is_file_launch);
      provider->scheduler().PersistFileHandlersUserChoice(
          app_id, allowed, std::move(persist_done));
    }
  } else {
    std::move(persist_done).Run();
  }
}

}  // namespace

void SetBrowserAppLauncherForTesting(
    const BrowserAppLauncherForTesting& launcher) {
  GetBrowserAppLauncherForTesting() = launcher;
}

WebAppShimManagerDelegate::WebAppShimManagerDelegate(
    std::unique_ptr<apps::AppShimManager::Delegate> fallback_delegate)
    : fallback_delegate_(std::move(fallback_delegate)) {}

WebAppShimManagerDelegate::~WebAppShimManagerDelegate() = default;

bool WebAppShimManagerDelegate::ShowAppWindows(Profile* profile,
                                               const webapps::AppId& app_id) {
  if (UseFallback(profile, app_id))
    return fallback_delegate_->ShowAppWindows(profile, app_id);
  // Non-legacy app windows are handled in AppShimManager.
  return false;
}

void WebAppShimManagerDelegate::CloseAppWindows(Profile* profile,
                                                const webapps::AppId& app_id) {
  if (UseFallback(profile, app_id)) {
    fallback_delegate_->CloseAppWindows(profile, app_id);
    return;
  }
  // This is only used by legacy apps.
  // TODO(crbug.com/40902596): This seems to happen in the wild although
  // though shouldn't be possible. Once legacy apps are no longer supported all
  // this legacy app specific code should get deleted entirely.
  // NOTREACHED();
}

bool WebAppShimManagerDelegate::AppIsInstalled(Profile* profile,
                                               const webapps::AppId& app_id) {
  if (UseFallback(profile, app_id)) {
    return fallback_delegate_->AppIsInstalled(profile, app_id);
  }
  if (!profile || !AreWebAppsEnabled(profile)) {
    return false;
  }
  WebAppProvider* provider = WebAppProvider::GetForWebApps(profile);
  CHECK(provider);
  return profile &&
         provider->registrar_unsafe().IsInstallState(
             app_id, {proto::InstallState::SUGGESTED_FROM_ANOTHER_DEVICE,
                      proto::InstallState::INSTALLED_WITHOUT_OS_INTEGRATION,
                      proto::InstallState::INSTALLED_WITH_OS_INTEGRATION});
}

bool WebAppShimManagerDelegate::AppCanCreateHost(Profile* profile,
                                                 const webapps::AppId& app_id) {
  if (UseFallback(profile, app_id))
    return fallback_delegate_->AppCanCreateHost(profile, app_id);
  // A host is only created for use with RemoteCocoa.
  return AppUsesRemoteCocoa(profile, app_id);
}

bool WebAppShimManagerDelegate::AppUsesRemoteCocoa(
    Profile* profile,
    const webapps::AppId& app_id) {
  if (UseFallback(profile, app_id)) {
    return fallback_delegate_->AppUsesRemoteCocoa(profile, app_id);
  }
  // All PWAs, and bookmark apps that open in their own window (not in a browser
  // window) can attach to a host.
  if (!profile || !AreWebAppsEnabled(profile)) {
    return false;
  }
  WebAppProvider* provider = WebAppProvider::GetForWebApps(profile);
  CHECK(provider);
  auto& registrar = provider->registrar_unsafe();
  return registrar.IsInstallState(
             app_id, {proto::InstallState::SUGGESTED_FROM_ANOTHER_DEVICE,
                      proto::InstallState::INSTALLED_WITHOUT_OS_INTEGRATION,
                      proto::InstallState::INSTALLED_WITH_OS_INTEGRATION}) &&
         registrar.GetAppEffectiveDisplayMode(app_id) !=
             web_app::DisplayMode::kBrowser;
}

bool WebAppShimManagerDelegate::AppIsMultiProfile(
    Profile* profile,
    const webapps::AppId& app_id) {
  if (UseFallback(profile, app_id))
    return fallback_delegate_->AppIsMultiProfile(profile, app_id);
  // All PWAs and bookmark apps are multi-profile.
  return AppIsInstalled(profile, app_id);
}

void WebAppShimManagerDelegate::EnableExtension(
    Profile* profile,
    const std::string& extension_id,
    base::OnceCallback<void()> callback) {
  if (UseFallback(profile, extension_id)) {
    fallback_delegate_->EnableExtension(profile, extension_id,
                                        std::move(callback));
    return;
  }
  std::move(callback).Run();
}

void WebAppShimManagerDelegate::LaunchApp(
    Profile* profile,
    const webapps::AppId& app_id,
    const std::vector<base::FilePath>& files,
    const std::vector<GURL>& urls,
    const GURL& override_url,
    chrome::mojom::AppShimLoginItemRestoreState login_item_restore_state,
    base::OnceClosure launch_finished_callback) {
  DCHECK(AppIsInstalled(profile, app_id));
  if (UseFallback(profile, app_id)) {
    fallback_delegate_->LaunchApp(profile, app_id, files, urls, override_url,
                                  login_item_restore_state,
                                  std::move(launch_finished_callback));
    return;
  }
  CHECK(profile);
  CHECK(AreWebAppsEnabled(profile));

  base::ScopedClosureRunner run_launch_finished(
      std::move(launch_finished_callback));

  DisplayMode effective_display_mode = WebAppProvider::GetForWebApps(profile)
                                           ->registrar_unsafe()
                                           .GetAppEffectiveDisplayMode(app_id);

  apps::LaunchContainer launch_container =
      web_app::ConvertDisplayModeToAppLaunchContainer(effective_display_mode);
  apps::LaunchSource launch_source = apps::LaunchSource::kFromCommandLine;
  if (login_item_restore_state !=
      chrome::mojom::AppShimLoginItemRestoreState::kNone) {
    launch_source = apps::LaunchSource::kFromOsLogin;
  }

  apps::AppLaunchParams params(app_id, launch_container,
                               WindowOpenDisposition::NEW_FOREGROUND_TAB,
                               launch_source);
  // Don't assign `files` to `params.launch_files` until we're sure this is a
  // permitted file launch.
  std::vector<base::FilePath> launch_files = files;
  params.override_url = override_url;

  for (const GURL& url : urls) {
    if (!url.is_valid() || !url.has_scheme()) {
      DLOG(ERROR) << "URL is not valid or does not have a scheme.";
      continue;
    }

    // Convert any file: URLs to a filename that can be passed to the OS.
    // If the conversion succeeds, add to the launch_files vector otherwise,
    // drop the url.
    if (url.SchemeIsFile()) {
      base::FilePath file_path;
      if (net::FileURLToFilePath(url, &file_path)) {
        launch_files.push_back(file_path);
      } else {
        DLOG(ERROR) << "Failed to convert file scheme url to file path.";
      }
      continue;
    }

    if (params.protocol_handler_launch_url.has_value()) {
      DLOG(ERROR) << "Protocol launch URL already set.";
      continue;
    }

    // Validate that the scheme is something that could be registered by the PWA
    // via the manifest.
    if (!blink::IsValidCustomHandlerScheme(
            url.scheme(), blink::ProtocolHandlerSecurityLevel::kStrict)) {
      DLOG(ERROR) << "Protocol is not a valid custom handler scheme.";
      continue;
    }

    params.protocol_handler_launch_url = url;
    params.launch_source = apps::LaunchSource::kFromProtocolHandler;
  }

  WebAppProvider* const provider = WebAppProvider::GetForWebApps(profile);
  CHECK(provider);
  WebAppFileHandlerManager::LaunchInfos file_launches;
  if (!params.protocol_handler_launch_url) {
    file_launches = provider->os_integration_manager()
                        .file_handler_manager()
                        .GetMatchingFileHandlerUrls(app_id, launch_files);
  }
  if (GetBrowserAppLauncherForTesting()) {
    LaunchAppWithParams(profile, std::move(params), file_launches,
                        run_launch_finished.Release());
    return;
  }

  if (params.protocol_handler_launch_url.has_value()) {
    GURL protocol_url = params.protocol_handler_launch_url.value();

    // Protocol handlers should prompt the user before launching the app,
    // unless the user has granted or denied permission to this protocol scheme
    // previously.
    web_app::WebAppRegistrar& registrar = provider->registrar_unsafe();
    if (registrar.IsDisallowedLaunchProtocol(app_id, protocol_url.scheme())) {
      CancelAppLaunch(profile, app_id);
      return;
    }

    if (!registrar.IsAllowedLaunchProtocol(app_id, protocol_url.scheme())) {
      ShowWebAppProtocolLaunchDialog(
          std::move(protocol_url), profile, app_id,
          base::BindOnce(&UserChoiceDialogCompleted, std::move(params),
                         WebAppFileHandlerManager::LaunchInfos(), profile,
                         run_launch_finished.Release()));
      return;
    }
  }

  // If there is no matching file handling URL (such as when the API has been
  // disabled), fall back to a normal app launch.
  if (!file_launches.empty()) {
    const WebApp* web_app = provider->registrar_unsafe().GetAppById(app_id);
    DCHECK(web_app);

    if (web_app->file_handler_approval_state() ==
        ApiApprovalState::kRequiresPrompt) {
      ShowWebAppFileLaunchDialog(
          launch_files, profile, app_id,
          base::BindOnce(&UserChoiceDialogCompleted, std::move(params),
                         file_launches, profile,
                         run_launch_finished.Release()));
      return;
    }

    DCHECK_EQ(ApiApprovalState::kAllowed,
              web_app->file_handler_approval_state());
  }

  LaunchAppWithParams(profile, std::move(params), file_launches,
                      run_launch_finished.Release());
}

void WebAppShimManagerDelegate::LaunchShim(
    Profile* profile,
    const webapps::AppId& app_id,
    web_app::LaunchShimUpdateBehavior update_behavior,
    web_app::ShimLaunchMode launch_mode,
    apps::ShimLaunchedCallback launched_callback,
    apps::ShimTerminatedCallback terminated_callback) {
  DCHECK(AppIsInstalled(profile, app_id));
  if (UseFallback(profile, app_id)) {
    fallback_delegate_->LaunchShim(profile, app_id, update_behavior,
                                   launch_mode, std::move(launched_callback),
                                   std::move(terminated_callback));
    return;
  }
  CHECK(profile);
  CHECK(AreWebAppsEnabled(profile));
  WebAppProvider::GetForWebApps(profile)
      ->os_integration_manager()
      .GetShortcutInfoForAppFromRegistrar(
          app_id, base::BindOnce(&web_app::LaunchShim, update_behavior,
                                 launch_mode, std::move(launched_callback),
                                 std::move(terminated_callback)));
}

bool WebAppShimManagerDelegate::HasNonBookmarkAppWindowsOpen() {
  if (fallback_delegate_)
    return fallback_delegate_->HasNonBookmarkAppWindowsOpen();
  // PWAs and bookmark apps do not participate in custom app quit behavior.
  return false;
}

bool WebAppShimManagerDelegate::UseFallback(
    Profile* profile,
    const webapps::AppId& app_id) const {
  if (!profile)
    return false;

  // If |app_id| is installed via WebAppProvider, then use |this| as the
  // delegate.
  auto* provider = WebAppProvider::GetForWebApps(profile);
  if (provider &&
      provider->registrar_unsafe().IsInstallState(
          app_id, {proto::InstallState::SUGGESTED_FROM_ANOTHER_DEVICE,
                   proto::InstallState::INSTALLED_WITHOUT_OS_INTEGRATION,
                   proto::InstallState::INSTALLED_WITH_OS_INTEGRATION})) {
    return false;
  }

  // Use |fallback_delegate_| only if |app_id| is installed for |profile|
  // as an extension.
  return fallback_delegate_->AppIsInstalled(profile, app_id);
}

std::vector<chrome::mojom::ApplicationDockMenuItemPtr>
WebAppShimManagerDelegate::GetAppShortcutsMenuItemInfos(
    Profile* profile,
    const webapps::AppId& app_id) {
  if (UseFallback(profile, app_id))
    return fallback_delegate_->GetAppShortcutsMenuItemInfos(profile, app_id);

  std::vector<chrome::mojom::ApplicationDockMenuItemPtr> dock_menu_items;

  DCHECK(profile);

  auto shortcuts_menu_item_infos = WebAppProvider::GetForWebApps(profile)
                                       ->registrar_unsafe()
                                       .GetAppShortcutsMenuItemInfos(app_id);

  DCHECK_LE(shortcuts_menu_item_infos.size(), kMaxApplicationDockMenuItems);
  for (const auto& shortcuts_menu_item_info : shortcuts_menu_item_infos) {
    auto mojo_item = chrome::mojom::ApplicationDockMenuItem::New();
    mojo_item->name = shortcuts_menu_item_info.name;
    mojo_item->url = shortcuts_menu_item_info.url;
    dock_menu_items.push_back(std::move(mojo_item));
  }

  return dock_menu_items;
}

}  // namespace web_app