forked from chromium/chromium
-
Notifications
You must be signed in to change notification settings - Fork 0
/
component_installer.h
197 lines (159 loc) · 8.06 KB
/
component_installer.h
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
// Copyright 2014 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_COMPONENT_UPDATER_COMPONENT_INSTALLER_H_
#define COMPONENTS_COMPONENT_UPDATER_COMPONENT_INSTALLER_H_
#include <stdint.h>
#include <memory>
#include <string>
#include <vector>
#include "base/callback_forward.h"
#include "base/files/file_path.h"
#include "base/macros.h"
#include "base/memory/ref_counted.h"
#include "base/threading/thread_checker.h"
#include "base/values.h"
#include "base/version.h"
#include "components/update_client/update_client.h"
namespace base {
class SequencedTaskRunner;
class SingleThreadTaskRunner;
} // namespace base
namespace component_updater {
using RegisterCallback =
base::OnceCallback<bool(const update_client::CrxComponent&)>;
class ComponentUpdateService;
// Components should use a ComponentInstaller by defining a class that
// implements the members of ComponentInstallerPolicy, and then registering a
// ComponentInstaller that has been constructed with an instance of that
// class.
class ComponentInstallerPolicy {
public:
virtual ~ComponentInstallerPolicy();
// Verifies that a working installation resides within the directory specified
// by |install_dir|. |install_dir| is of the form <base directory>/<version>.
// |manifest| should have been read from the manifest file in |install_dir|.
// Called only from a thread belonging to a blocking thread pool.
// The implementation of this function must be efficient since the function
// can be called when Chrome starts.
virtual bool VerifyInstallation(const base::DictionaryValue& manifest,
const base::FilePath& install_dir) const = 0;
// Returns true if the component supports a group policy to enable updates.
// Called once during component registration from the UI thread.
virtual bool SupportsGroupPolicyEnabledComponentUpdates() const = 0;
// Returns true if the network communication related to this component
// must be encrypted.
virtual bool RequiresNetworkEncryption() const = 0;
// OnCustomInstall is called during the installation process. Components that
// require custom installation operations should implement them here.
// Returns false if a custom operation failed, and true otherwise.
// Called only from a thread belonging to a blocking thread pool.
virtual update_client::CrxInstaller::Result OnCustomInstall(
const base::DictionaryValue& manifest,
const base::FilePath& install_dir) = 0;
// OnCustomUninstall is called during the unregister (uninstall) process.
// Components that require custom uninstallation operations should implement
// them here.
// Called only from a thread belonging to a blocking thread pool.
virtual void OnCustomUninstall() = 0;
// ComponentReady is called in two cases:
// 1) After an installation is successfully completed.
// 2) During component registration if the component is already installed.
// In both cases the install is verified before this is called. This method
// is guaranteed to be called before any observers of the component are
// notified of a successful install, and is meant to support follow-on work
// such as updating paths elsewhere in Chrome. Called on the UI thread.
// |version| is the version of the component.
// |install_dir| is the path to the install directory for this version.
// |manifest| is the manifest for this version of the component.
virtual void ComponentReady(
const base::Version& version,
const base::FilePath& install_dir,
std::unique_ptr<base::DictionaryValue> manifest) = 0;
// Returns a relative path that will be appended to the component updater
// root directories to find the data for this particular component.
virtual base::FilePath GetRelativeInstallDir() const = 0;
// Returns the component's SHA2 hash as raw bytes.
virtual void GetHash(std::vector<uint8_t>* hash) const = 0;
// Returns the human-readable name of the component.
virtual std::string GetName() const = 0;
// Returns a container of name-value pairs representing arbitrary,
// installer-defined metadata.
// The installer metadata may be used in the update checks for this component.
// A compatible server may use these attributes to negotiate special update
// rules when issuing an update response.
// Valid values for the name part of an attribute match
// ^[-_a-zA-Z0-9]{1,256}$ and valid values the value part of an attribute
// match ^[-.,;+_=$a-zA-Z0-9]{0,256}$ .
virtual update_client::InstallerAttributes GetInstallerAttributes() const = 0;
};
// Defines the installer for Chrome components. The behavior of this class is
// controlled by an instance of ComponentInstallerPolicy, at construction time.
class ComponentInstaller final : public update_client::CrxInstaller {
public:
ComponentInstaller(
std::unique_ptr<ComponentInstallerPolicy> installer_policy,
scoped_refptr<update_client::ActionHandler> action_handler = nullptr);
// Registers the component for update checks and installs.
// |cus| provides the registration logic.
// The passed |callback| will be called once the initial check for installed
// versions is done and the component has been registered.
void Register(ComponentUpdateService* cus, base::OnceClosure callback);
// Registers the component for update checks and installs.
// |register_callback| is called to do the registration.
// |callback| is called when registration finishes.
void Register(RegisterCallback register_callback, base::OnceClosure callback);
// Overrides from update_client::CrxInstaller.
void OnUpdateError(int error) override;
void Install(const base::FilePath& unpack_path,
const std::string& public_key,
std::unique_ptr<InstallParams> install_params,
ProgressCallback progress_callback,
Callback callback) override;
bool GetInstalledFile(const std::string& file,
base::FilePath* installed_file) override;
// Only user-level component installations can be uninstalled.
bool Uninstall() override;
private:
struct RegistrationInfo : base::RefCountedThreadSafe<RegistrationInfo> {
RegistrationInfo();
base::FilePath install_dir;
base::Version version;
std::string fingerprint;
std::unique_ptr<base::DictionaryValue> manifest;
private:
friend class base::RefCountedThreadSafe<RegistrationInfo>;
~RegistrationInfo();
DISALLOW_COPY_AND_ASSIGN(RegistrationInfo);
};
~ComponentInstaller() override;
// If there is a installation of the component set up alongside Chrome's
// files (as opposed to in the user data directory), sets current_* to the
// values associated with that installation and returns true; otherwise,
// returns false.
bool FindPreinstallation(const base::FilePath& root,
scoped_refptr<RegistrationInfo> registration_info);
update_client::CrxInstaller::Result InstallHelper(
const base::FilePath& unpack_path,
std::unique_ptr<base::DictionaryValue>* manifest,
base::Version* version,
base::FilePath* install_path);
void StartRegistration(scoped_refptr<RegistrationInfo> registration_info);
void FinishRegistration(scoped_refptr<RegistrationInfo> registration_info,
RegisterCallback register_callback,
base::OnceClosure callback);
void ComponentReady(std::unique_ptr<base::DictionaryValue> manifest);
void UninstallOnTaskRunner();
THREAD_CHECKER(thread_checker_);
base::FilePath current_install_dir_;
base::Version current_version_;
std::string current_fingerprint_;
std::unique_ptr<ComponentInstallerPolicy> installer_policy_;
scoped_refptr<update_client::ActionHandler> action_handler_;
scoped_refptr<base::SequencedTaskRunner> task_runner_;
// Posts responses back to the main thread.
scoped_refptr<base::SingleThreadTaskRunner> main_task_runner_;
DISALLOW_COPY_AND_ASSIGN(ComponentInstaller);
};
} // namespace component_updater
#endif // COMPONENTS_COMPONENT_UPDATER_COMPONENT_INSTALLER_H_