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
|
// Copyright 2018 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_WEB_APPLICATIONS_PREINSTALLED_WEB_APP_MANAGER_H_
#define CHROME_BROWSER_WEB_APPLICATIONS_PREINSTALLED_WEB_APP_MANAGER_H_
#include <map>
#include <memory>
#include <optional>
#include <set>
#include <vector>
#include "base/auto_reset.h"
#include "base/functional/callback_forward.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/observer_list.h"
#include "base/observer_list_types.h"
#include "base/values.h"
#include "chrome/browser/web_applications/external_install_options.h"
#include "chrome/browser/web_applications/externally_managed_app_manager.h"
#include "chrome/browser/web_applications/file_utils_wrapper.h"
#include "chrome/browser/web_applications/preinstalled_web_apps/preinstalled_web_apps.h"
#include "url/gurl.h"
namespace user_prefs {
class PrefRegistrySyncable;
}
class Profile;
namespace web_app {
namespace {
struct LoadedConfigs;
struct ParsedConfigs;
} // namespace
class WebAppProvider;
// Installs web apps to be preinstalled on the device (AKA default apps) during
// start up. Will keep the apps installed on the device in sync with the set of
// apps configured for preinstall, adding or removing as necessary. Works very
// similar to WebAppPolicyManager.
class PreinstalledWebAppManager {
public:
using CacheDeviceInfoCallback = base::OnceClosure;
using ConsumeDeviceInfo = base::OnceCallback<void(DeviceInfo)>;
using ConsumeLoadedConfigs = base::OnceCallback<void(LoadedConfigs)>;
using ConsumeParsedConfigs = base::OnceCallback<void(ParsedConfigs)>;
using ConsumeInstallOptions =
base::OnceCallback<void(std::vector<ExternalInstallOptions>)>;
using SynchronizeCallback = ExternallyManagedAppManager::SynchronizeCallback;
using InstallUrl = GURL;
// Observes whether default chrome app migration has completed and
// triggers MostVisitedHandler to refresh the NTP tiles.
class Observer : public base::CheckedObserver {
public:
// Triggered when preinstalled web app synchronization completes and the
// pref kWebAppsMigratedPreinstalledApps is filled.
virtual void OnMigrationRun() = 0;
// Used to destroy the scoped observation instance if
// PreinstalledWebAppManager instance is destroyed before the scoped
// observation, preventing UAF.
virtual void OnDestroyed() = 0;
};
static const char* kHistogramEnabledCount;
static const char* kHistogramDisabledCount;
static const char* kHistogramConfigErrorCount;
static const char* kHistogramCorruptUserUninstallPrefsCount;
static const char* kHistogramInstallResult;
static const char* kHistogramUninstallAndReplaceCount;
static const char* kHistogramInstallCount;
static const char* kHistogramUninstallTotalCount;
static const char* kHistogramUninstallSourceRemovedCount;
static const char* kHistogramUninstallAppRemovedCount;
static const char* kHistogramAppToReplaceStillInstalledCount;
static const char* kHistogramAppToReplaceStillDefaultInstalledCount;
static const char* kHistogramAppToReplaceStillInstalledInShelfCount;
static void RegisterProfilePrefs(user_prefs::PrefRegistrySyncable* registry);
static base::AutoReset<bool> SkipStartupForTesting();
static base::AutoReset<bool> BypassAwaitingDependenciesForTesting();
static base::AutoReset<bool> BypassOfflineManifestRequirementForTesting();
static base::AutoReset<bool> OverridePreviousUserUninstallConfigForTesting();
static base::AutoReset<const base::Value::List*> SetConfigsForTesting(
const base::Value::List* configs);
static base::AutoReset<FileUtilsWrapper*> SetFileUtilsForTesting(
FileUtilsWrapper* file_utils);
explicit PreinstalledWebAppManager(Profile* profile);
PreinstalledWebAppManager(const PreinstalledWebAppManager&) = delete;
PreinstalledWebAppManager& operator=(const PreinstalledWebAppManager&) =
delete;
~PreinstalledWebAppManager();
void SetProvider(base::PassKey<WebAppProvider>, WebAppProvider& provider);
// Loads the preinstalled app configs and synchronizes them with the device's
// installed apps.
void Start(base::OnceClosure on_init_complete);
void LoadAndSynchronizeForTesting(SynchronizeCallback callback);
void LoadForTesting(ConsumeInstallOptions callback);
void AddObserver(PreinstalledWebAppManager::Observer* observer);
void RemoveObserver(PreinstalledWebAppManager::Observer* observer);
// Must be called before `Start`. Similar to `SkipStartupForTesting` but not a
// global setting.
void SetSkipStartupSynchronizeForTesting(bool skip_startup);
// Debugging info used by: chrome://web-app-internals
struct DebugInfo {
DebugInfo();
~DebugInfo();
bool is_start_up_task_complete = false;
std::vector<std::string> parse_errors;
using ConfigWithLog = std::pair<ExternalInstallOptions, std::string>;
std::vector<ConfigWithLog> uninstall_configs;
std::vector<ConfigWithLog> install_configs;
std::vector<ConfigWithLog> ignore_configs;
std::map<InstallUrl, ExternallyManagedAppManager::InstallResult>
install_results;
std::map<InstallUrl, webapps::UninstallResultCode> uninstall_results;
};
const DebugInfo* debug_info() const { return debug_info_.get(); }
private:
// Helper to delay a task until device information is fully initialized in
// ui::DeviceDataManager.
class DeviceDataInitializedEvent;
void LoadAndSynchronize(SynchronizeCallback callback);
void Load(ConsumeInstallOptions callback);
void LoadDeviceInfo(ConsumeDeviceInfo callback);
void CacheDeviceInfo(CacheDeviceInfoCallback callback,
DeviceInfo device_info);
void LoadConfigs(ConsumeLoadedConfigs callback);
void ParseConfigs(ConsumeParsedConfigs callback,
LoadedConfigs loaded_configs);
void PostProcessConfigs(ConsumeInstallOptions callback,
ParsedConfigs parsed_configs);
void Synchronize(SynchronizeCallback callback,
std::vector<ExternalInstallOptions>);
void OnExternalWebAppsSynchronized(
ExternallyManagedAppManager::SynchronizeCallback callback,
std::set<InstallUrl> desired_preferred_apps_for_supported_links,
std::map<InstallUrl, std::vector<webapps::AppId>>
desired_uninstall_and_replaces,
std::map<InstallUrl, ExternallyManagedAppManager::InstallResult>
install_results,
std::map<InstallUrl, webapps::UninstallResultCode> uninstall_results);
void OnStartUpTaskCompleted(
std::map<InstallUrl, ExternallyManagedAppManager::InstallResult>
install_results,
std::map<InstallUrl, webapps::UninstallResultCode> uninstall_results);
// Returns whether this is the first time we've deployed default apps on this
// profile.
bool IsNewUser();
// |force_reinstall_for_milestone| is a major version number. See
// components/version_info/version_info.h.
bool IsReinstallPastMilestoneNeededSinceLastSync(
int force_reinstall_for_milestone);
const raw_ptr<Profile> profile_;
raw_ptr<WebAppProvider> provider_ = nullptr;
bool skip_startup_for_testing_ = false;
std::unique_ptr<DebugInfo> debug_info_;
std::unique_ptr<DeviceDataInitializedEvent> device_data_initialized_event_;
// TODO(http://b/333583704): Revert CL which added this field after migration.
std::optional<DeviceInfo> device_info_;
base::ObserverList<PreinstalledWebAppManager::Observer, /*check_empty=*/true>
observers_;
base::WeakPtrFactory<PreinstalledWebAppManager> weak_ptr_factory_{this};
};
} // namespace web_app
#endif // CHROME_BROWSER_WEB_APPLICATIONS_PREINSTALLED_WEB_APP_MANAGER_H_
|
