File: kiosk_controller.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 (109 lines) | stat: -rw-r--r-- 4,010 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
// Copyright 2023 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_ASH_APP_MODE_KIOSK_CONTROLLER_H_
#define CHROME_BROWSER_ASH_APP_MODE_KIOSK_CONTROLLER_H_

#include <optional>
#include <vector>

#include "ash/public/cpp/login_accelerators.h"
#include "chrome/browser/ash/app_mode/kiosk_app.h"
#include "chrome/browser/ash/app_mode/kiosk_app_types.h"
#include "chromeos/ash/components/kiosk/vision/internals_page_processor.h"
#include "components/pref_registry/pref_registry_syncable.h"
#include "components/prefs/pref_registry_simple.h"
#include "content/public/browser/web_contents.h"

class Profile;

namespace ash {

class AppLaunchSplashScreen;
class KioskProfileLoadFailedObserver;
class KioskSystemSession;
class LoginDisplayHost;

namespace kiosk_vision {

class TelemetryProcessor;
class InternalsPageProcessor;

}  // namespace kiosk_vision

// Public interface for Kiosk.
class KioskController {
 public:
  static KioskController& Get();

  KioskController();
  virtual ~KioskController();

  virtual std::vector<KioskApp> GetApps() const = 0;
  virtual std::optional<KioskApp> GetAppById(
      const KioskAppId& app_id) const = 0;
  virtual std::optional<KioskApp> GetAutoLaunchApp() const = 0;

  // Launches a kiosk session running the given app.
  virtual void StartSession(const KioskAppId& app,
                            bool is_auto_launch,
                            LoginDisplayHost* host,
                            AppLaunchSplashScreen* splash_screen) = 0;
  // Launches a kiosk session after a browser crash, which is a faster launch
  // without any UI.
  virtual void StartSessionAfterCrash(const KioskAppId& app,
                                      Profile* profile) = 0;

  // Returns true if a kiosk launch is in progress. Will return false at any
  // other time, including when the kiosk launch is finished.
  virtual bool IsSessionStarting() const = 0;

  // Cancels the kiosk session launch, if any is in progress.
  virtual void CancelSessionStart() = 0;

  // Adds/Removes an observer that will be informed if the profile fails to
  // load during launch. Can only be called while a kiosk launch is in progress.
  virtual void AddProfileLoadFailedObserver(
      KioskProfileLoadFailedObserver* observer) = 0;
  virtual void RemoveProfileLoadFailedObserver(
      KioskProfileLoadFailedObserver* observer) = 0;

  virtual bool HandleAccelerator(LoginAcceleratorAction action) = 0;

  // Notify Kiosk that a new guest web content was added.
  virtual void OnGuestAdded(content::WebContents* guest_web_contents) = 0;

  // Returns the `KioskSystemSession`. Can be `nullptr` if called outside a
  // Kiosk session, or before `InitializeSystemSession`.
  virtual KioskSystemSession* GetKioskSystemSession() = 0;

  // Returns the `kiosk_vision::TelemetryProcessor`.
  // Can be `nullptr` in the following cases:
  // * Outside a Kiosk session.
  // * Before `InitializeSystemSession`.
  // * When the Kiosk Vision framework is disabled by policy.
  // * When the Kiosk Vision framework is not yet initialized.
  virtual kiosk_vision::TelemetryProcessor*
  GetKioskVisionTelemetryProcessor() = 0;

  // Returns the `InternalsPageProcessor`.
  // Can be `nullptr` in the following cases:
  // * Outside a Kiosk session.
  // * Before `InitializeSystemSession`.
  // * When the Kiosk Vision framework is disabled by policy.
  // * When the Kiosk Vision framework is not yet initialized.
  // * When the internals page feature flag is disabled.
  virtual kiosk_vision::InternalsPageProcessor*
  GetKioskVisionInternalsPageProcessor() = 0;

  // Registers local state prefs relevant for Kiosk.
  static void RegisterLocalStatePrefs(PrefRegistrySimple* registry);

  // Registers profile prefs relevant for Kiosk.
  static void RegisterProfilePrefs(user_prefs::PrefRegistrySyncable* registry);
};

}  // namespace ash

#endif  // CHROME_BROWSER_ASH_APP_MODE_KIOSK_CONTROLLER_H_