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
|
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/update_client/op_install.h"
#include <cstdint>
#include <memory>
#include <string>
#include <utility>
#include <vector>
#include "base/files/file.h"
#include "base/files/file_path.h"
#include "base/files/file_util.h"
#include "base/functional/bind.h"
#include "base/functional/callback.h"
#include "base/functional/callback_helpers.h"
#include "base/location.h"
#include "base/logging.h"
#include "base/memory/scoped_refptr.h"
#include "base/task/bind_post_task.h"
#include "base/task/sequenced_task_runner.h"
#include "base/task/thread_pool.h"
#include "base/types/expected.h"
#include "base/values.h"
#include "components/crx_file/crx_verifier.h"
#include "components/update_client/configurator.h"
#include "components/update_client/crx_cache.h"
#include "components/update_client/pipeline_util.h"
#include "components/update_client/protocol_definition.h"
#include "components/update_client/task_traits.h"
#include "components/update_client/unpacker.h"
#include "components/update_client/unzipper.h"
#include "components/update_client/update_client.h"
#include "components/update_client/update_client_errors.h"
#include "third_party/puffin/src/include/puffin/puffpatch.h"
namespace update_client {
namespace {
// The sequence of calls is:
//
// [Original Sequence] [Blocking Pool]
//
// CrxCache::Put (optional)
// Unpack
// Unpacker::Unpack
// Install
// InstallBlocking
// installer->Install
// CallbackChecker::Done
// [lambda to delete unpack path]
// InstallComplete
// [original callback]
// CallbackChecker ensures that a progress callback is not posted after a
// completion callback. It is only accessed and modified on the main sequence.
// Both callbacks maintain a reference to an instance of this class.
class CallbackChecker : public base::RefCountedThreadSafe<CallbackChecker> {
public:
CallbackChecker(
base::OnceCallback<void(const CrxInstaller::Result&)> callback,
CrxInstaller::ProgressCallback progress_callback)
: callback_(std::move(callback)), progress_callback_(progress_callback) {}
CallbackChecker(const CallbackChecker&) = delete;
CallbackChecker& operator=(const CallbackChecker&) = delete;
void Progress(int progress) { progress_callback_.Run(progress); }
void Done(const CrxInstaller::Result& result) {
progress_callback_ = base::DoNothing();
std::move(callback_).Run(result);
}
private:
friend class base::RefCountedThreadSafe<CallbackChecker>;
~CallbackChecker() = default;
base::OnceCallback<void(const CrxInstaller::Result&)> callback_;
CrxInstaller::ProgressCallback progress_callback_;
};
// Runs on the original sequence.
void InstallComplete(
base::OnceCallback<void(const CrxInstaller::Result&)>
installer_result_callback,
base::OnceCallback<void(base::expected<base::FilePath, CategorizedError>)>
callback,
base::RepeatingCallback<void(base::Value::Dict)> event_adder,
base::FilePath crx_file,
const CrxInstaller::Result& result) {
event_adder.Run(
MakeSimpleOperationEvent(result.result, protocol_request::kEventCrx3));
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE, base::BindOnce(std::move(installer_result_callback), result));
if (result.result.category != ErrorCategory::kNone) {
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE,
base::BindOnce(std::move(callback), base::unexpected(result.result)));
return;
}
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE, base::BindOnce(std::move(callback), crx_file));
}
// Runs in the blocking thread pool.
void InstallBlocking(
CrxInstaller::ProgressCallback progress_callback,
base::OnceCallback<void(const CrxInstaller::Result&)> callback,
const base::FilePath& unpack_path,
const std::string& public_key,
std::unique_ptr<CrxInstaller::InstallParams> install_params,
scoped_refptr<CrxInstaller> installer) {
installer->Install(unpack_path, public_key, std::move(install_params),
progress_callback, std::move(callback));
}
// Runs on the original sequence.
void Install(base::OnceCallback<void(const CrxInstaller::Result&)> callback,
std::unique_ptr<CrxInstaller::InstallParams> install_params,
scoped_refptr<CrxInstaller> installer,
CrxInstaller::ProgressCallback progress_callback,
const Unpacker::Result& result) {
if (result.error != UnpackerError::kNone) {
std::move(callback).Run(
CrxInstaller::Result({.category = ErrorCategory::kUnpack,
.code = static_cast<int>(result.error),
.extra = result.extended_error}));
return;
}
progress_callback.Run(-1);
// Prepare the callbacks. Delete unpack_path when the completion
// callback is called.
auto checker = base::MakeRefCounted<CallbackChecker>(
base::BindOnce(
[](base::OnceCallback<void(const CrxInstaller::Result&)> callback,
const base::FilePath& unpack_path,
const CrxInstaller::Result& result) {
base::ThreadPool::PostTaskAndReply(
FROM_HERE, kTaskTraits,
base::BindOnce(IgnoreResult(&base::DeletePathRecursively),
unpack_path),
base::BindOnce(std::move(callback), result));
},
std::move(callback), result.unpack_path),
progress_callback);
// Run installer.
base::ThreadPool::PostTask(
FROM_HERE, kTaskTraits,
base::BindOnce(&InstallBlocking,
base::BindPostTaskToCurrentDefault(base::BindRepeating(
&CallbackChecker::Progress, checker)),
base::BindPostTaskToCurrentDefault(
base::BindOnce(&CallbackChecker::Done, checker)),
result.unpack_path, result.public_key,
std::move(install_params), installer));
}
// Runs on the original sequence.
void Unpack(base::OnceCallback<void(const Unpacker::Result&)> callback,
const base::FilePath& crx_file,
std::unique_ptr<Unzipper> unzipper,
const std::vector<uint8_t>& pk_hash,
crx_file::VerifierFormat crx_format,
base::expected<base::FilePath, UnpackerError> cache_result) {
if (!cache_result.has_value()) {
// Caching is optional: continue with the install, but add a task to clean
// up crx_file.
callback = base::BindOnce(
[](const base::FilePath& crx_file,
base::OnceCallback<void(const Unpacker::Result&)> callback,
const Unpacker::Result& result) {
base::ThreadPool::PostTaskAndReply(
FROM_HERE, kTaskTraits,
base::BindOnce(IgnoreResult(&base::DeleteFile), crx_file),
base::BindOnce(std::move(callback), result));
},
crx_file, std::move(callback));
}
// Unpack the file.
base::ThreadPool::CreateSequencedTaskRunner(kTaskTraits)
->PostTask(
FROM_HERE,
base::BindOnce(
&Unpacker::Unpack, pk_hash,
// If and only if cached, the original path no longer exists.
cache_result.has_value() ? cache_result.value() : crx_file,
std::move(unzipper), crx_format,
base::BindPostTaskToCurrentDefault(std::move(callback))));
}
} // namespace
base::OnceClosure InstallOperation(
scoped_refptr<CrxCache> crx_cache,
std::unique_ptr<Unzipper> unzipper,
crx_file::VerifierFormat crx_format,
const std::string& id,
const std::string& file_hash,
const std::vector<uint8_t>& pk_hash,
scoped_refptr<CrxInstaller> installer,
std::unique_ptr<CrxInstaller::InstallParams> install_params,
base::RepeatingCallback<void(base::Value::Dict)> event_adder,
base::RepeatingCallback<void(ComponentState)> state_tracker,
CrxInstaller::ProgressCallback progress_callback,
base::OnceCallback<void(const CrxInstaller::Result&)>
installer_result_callback,
const base::FilePath& crx_file,
base::OnceCallback<void(base::expected<base::FilePath, CategorizedError>)>
callback) {
state_tracker.Run(ComponentState::kUpdating);
crx_cache->Put(
// TODO(crbug.com/399617574): Remove FP.
crx_file, id, file_hash, /*fp=*/{},
base::BindOnce(
&Unpack,
base::BindOnce(
&Install,
base::BindOnce(&InstallComplete,
std::move(installer_result_callback),
std::move(callback), event_adder, crx_file),
std::move(install_params), installer, progress_callback),
crx_file, std::move(unzipper), pk_hash, crx_format));
return base::DoNothing();
}
} // namespace update_client
|