File: kiosk_browser_session.h

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 (127 lines) | stat: -rw-r--r-- 4,346 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
// Copyright 2015 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_CHROMEOS_APP_MODE_KIOSK_BROWSER_SESSION_H_
#define CHROME_BROWSER_CHROMEOS_APP_MODE_KIOSK_BROWSER_SESSION_H_

#include <memory>
#include <optional>
#include <string>

#include "base/functional/callback.h"
#include "base/functional/callback_forward.h"
#include "base/memory/raw_ptr.h"
#include "chrome/browser/chromeos/app_mode/kiosk_browser_window_handler.h"
#include "chrome/browser/chromeos/app_mode/kiosk_metrics_service.h"
#include "ppapi/buildflags/buildflags.h"

class PrefRegistrySimple;
class PrefService;
class Profile;
class Browser;

namespace content {
class WebContents;
}

namespace extensions {
class AppWindow;
}

namespace chromeos {

class KioskSessionPluginHandler;
class KioskSessionPluginHandlerDelegate;

// KioskBrowserSession maintains a kiosk session and handles its lifetime.
class KioskBrowserSession {
 public:
  explicit KioskBrowserSession(Profile* profile);
  KioskBrowserSession(Profile* profile,
                      base::OnceClosure attempt_user_exit,
                      PrefService* local_state);
  KioskBrowserSession(const KioskBrowserSession&) = delete;
  KioskBrowserSession& operator=(const KioskBrowserSession&) = delete;
  virtual ~KioskBrowserSession();

  static std::unique_ptr<KioskBrowserSession> CreateForTesting(
      Profile* profile,
      base::OnceClosure attempt_user_exit,
      PrefService* local_state,
      const std::vector<std::string>& crash_dirs);

  static void RegisterLocalStatePrefs(PrefRegistrySimple* registry);

  static void RegisterProfilePrefs(user_prefs::PrefRegistrySyncable* registry);

  // Initializes an app session for Chrome App Kiosk.
  void InitForChromeAppKiosk(const std::string& app_id);

  // Initializes an app session for Web kiosk.
  // `web_app_name` is std::nullopt for ash-side of the web kiosk with Lacros.
  void InitForWebKiosk(const std::optional<std::string>& web_app_name);

  // Initializes an app session for Isolated Web App Kiosk.
  void InitForIwaKiosk(const std::optional<std::string>& app_name);

  // Invoked when GuestViewManager adds a guest web contents.
  void OnGuestAdded(content::WebContents* guest_web_contents);

  Browser* GetSettingsBrowserForTesting();
  void SetOnHandleBrowserCallbackForTesting(
      base::RepeatingCallback<void(bool is_closing)> callback);

  KioskSessionPluginHandlerDelegate* GetPluginHandlerDelegateForTesting();

  bool is_shutting_down() const { return is_shutting_down_; }

 private:
  // AppWindowHandler watches for app window and exits the session when the
  // last window of a given app is closed. This class is only used for Chrome
  // App Kiosk.
  class AppWindowHandler;

  // PluginHandlerDelegateImpl handles callbacks from `plugin_handler_`.
  class PluginHandlerDelegateImpl;

  KioskBrowserSession(Profile* profile,
                      base::OnceClosure attempt_user_exit,
                      std::unique_ptr<KioskMetricsService> metrics_service);

  // Create a `browser_window_handler_` object.
  void CreateBrowserWindowHandler(
      const std::optional<std::string>& web_app_name);

  Profile* profile() const { return profile_; }

  void OnHandledNewBrowserWindow(bool is_closing);
  void OnAppWindowAdded(extensions::AppWindow* app_window);
  void Shutdown();

  bool is_shutting_down_ = false;

  // Owned by `ProfileManager`.
  raw_ptr<Profile, DanglingUntriaged> profile_ = nullptr;

  std::unique_ptr<AppWindowHandler> app_window_handler_;
  std::unique_ptr<KioskBrowserWindowHandler> browser_window_handler_;
#if BUILDFLAG(ENABLE_PLUGINS)
  std::unique_ptr<PluginHandlerDelegateImpl> plugin_handler_delegate_;
  // Initialized only for Chrome app kiosks in `InitForChromeAppKiosk`.
  std::unique_ptr<KioskSessionPluginHandler> plugin_handler_;
#endif

  base::OnceClosure attempt_user_exit_;
  const std::unique_ptr<KioskMetricsService> metrics_service_;

  // Is called whenever a new browser creation was handled by the
  // BrowserWindowHandler.
  base::RepeatingCallback<void(bool is_closing)> on_handle_browser_callback_;

  base::WeakPtrFactory<KioskBrowserSession> weak_ptr_factory_{this};
};

}  // namespace chromeos

#endif  // CHROME_BROWSER_CHROMEOS_APP_MODE_KIOSK_BROWSER_SESSION_H_