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 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
|
// Copyright 2017 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/services/unzip/public/cpp/unzip.h"
#include <string>
#include <utility>
#include "base/check.h"
#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/logging.h"
#include "base/memory/ref_counted.h"
#include "base/memory/scoped_refptr.h"
#include "base/metrics/histogram_functions.h"
#include "base/sequence_checker.h"
#include "base/strings/strcat.h"
#include "base/task/bind_post_task.h"
#include "base/task/sequenced_task_runner.h"
#include "base/task/thread_pool.h"
#include "base/time/time.h"
#include "components/services/storage/public/cpp/filesystem/filesystem_impl.h"
#include "components/services/unzip/public/mojom/unzipper.mojom.h"
#include "mojo/public/cpp/bindings/receiver.h"
#include "mojo/public/cpp/bindings/remote.h"
#include "mojo/public/cpp/bindings/self_owned_receiver.h"
namespace unzip {
namespace {
std::string Redact(const base::FilePath& path) {
return LOG_IS_ON(INFO) ? base::StrCat({"'", path.AsUTF8Unsafe(), "'"})
: "(redacted)";
}
bool CheckZipFileValid(const base::FilePath& zip_path,
const base::File& zip_file) {
if (!zip_file.IsValid()) {
LOG(ERROR) << "Cannot open ZIP archive " << Redact(zip_path) << ": "
<< base::File::ErrorToString(zip_file.error_details());
return false;
}
return true;
}
// An UnzipOperation is a cancellable invocation of Unzip. To support
// cancellation, it maintains the completion callback as a class member.
// UnzipOperations represent only a single operation and must not be reused.
class UnzipOperation : public base::RefCountedThreadSafe<UnzipOperation>,
public unzip::mojom::UnzipFilter,
public unzip::mojom::UnzipListener {
public:
UnzipOperation(UnzipFilterCallback filter_callback,
UnzipListenerCallback listener_callback,
UnzipCallback callback)
: filter_callback_(filter_callback),
listener_callback_(listener_callback),
callback_(std::move(callback)) {
// UnzipOperation is created on one sequence but forever used on another.
DETACH_FROM_SEQUENCE(sequence_checker_);
}
// Start must be called only once. May block.
void Start(mojo::PendingRemote<mojom::Unzipper> unzipper,
const base::FilePath& zip_path,
const base::FilePath& output_dir,
mojom::UnzipOptionsPtr options) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
unzipper_.Bind(std::move(unzipper));
// Open zip_path.
base::File zip_file(zip_path,
base::File::FLAG_OPEN | base::File::FLAG_READ);
if (!CheckZipFileValid(zip_path, zip_file)) {
Done(false);
return;
}
// Set up unzipper remotes/receivers.
unzipper_.set_disconnect_handler(
base::BindOnce(&UnzipOperation::Done, this, false));
mojo::PendingRemote<storage::mojom::Directory> directory_remote;
mojo::MakeSelfOwnedReceiver(
std::make_unique<storage::FilesystemImpl>(
// kTrusted is set to allow the unzipping process to handle all
// types of files.
output_dir, storage::FilesystemImpl::ClientType::kTrusted),
directory_remote.InitWithNewPipeAndPassReceiver());
mojo::PendingRemote<unzip::mojom::UnzipFilter> filter_remote;
filter_receiver_.Bind(filter_remote.InitWithNewPipeAndPassReceiver());
// Start unzipping.
unzipper_->Unzip(std::move(zip_file), std::move(directory_remote),
std::move(options), std::move(filter_remote),
listener_receiver_.BindNewPipeAndPassRemote(),
base::BindOnce(&UnzipOperation::Done, this));
}
// Resets the unzipper remote and triggers the completion callback.
void Cancel() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
Done(false);
}
private:
// Done may be called multiple times, for example if cancellation is posted
// to a task runner, but concurrently, the job completes or the remote
// disconnects.
void Done(bool result) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
std::move(callback_).Run(result);
callback_ = base::DoNothing();
unzipper_.reset();
}
private:
friend class base::RefCountedThreadSafe<UnzipOperation>;
~UnzipOperation() override = default;
// unzip::mojom::UnzipFilter implementation:
void ShouldUnzipFile(const base::FilePath& path,
ShouldUnzipFileCallback callback) override {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
std::move(callback).Run(filter_callback_.Run(path));
}
// unzip::mojom::UnzipListener implementation:
void OnProgress(uint64_t bytes) override {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
listener_callback_.Run(bytes);
}
SEQUENCE_CHECKER(sequence_checker_);
mojo::Remote<mojom::Unzipper> unzipper_;
mojo::Receiver<unzip::mojom::UnzipFilter> filter_receiver_{this};
UnzipFilterCallback filter_callback_;
mojo::Receiver<unzip::mojom::UnzipListener> listener_receiver_{this};
UnzipListenerCallback listener_callback_;
UnzipCallback callback_;
};
class DetectEncodingParams : public base::RefCounted<DetectEncodingParams> {
public:
DetectEncodingParams(mojo::PendingRemote<mojom::Unzipper> unzipper,
DetectEncodingCallback callback)
: unzipper_(std::move(unzipper)), callback_(std::move(callback)) {}
mojo::Remote<mojom::Unzipper>& unzipper() { return unzipper_; }
void InvokeCallback(int encoding) {
if (callback_) {
base::UmaHistogramEnumeration("Unzipper.DetectEncoding.Result",
static_cast<Encoding>(encoding),
Encoding::NUM_ENCODINGS);
base::UmaHistogramTimes("Unzipper.DetectEncoding.Time",
base::TimeTicks::Now() - start_time_);
std::move(callback_).Run(static_cast<Encoding>(encoding));
}
unzipper_.reset();
}
private:
friend class base::RefCounted<DetectEncodingParams>;
~DetectEncodingParams() = default;
// The Remote is stored so it does not get deleted before the callback runs.
mojo::Remote<mojom::Unzipper> unzipper_;
DetectEncodingCallback callback_;
const base::TimeTicks start_time_ = base::TimeTicks::Now();
};
class GetExtractedInfoParams : public base::RefCounted<GetExtractedInfoParams> {
public:
GetExtractedInfoParams(mojo::PendingRemote<mojom::Unzipper> unzipper,
GetExtractedInfoCallback callback)
: unzipper_(std::move(unzipper)), callback_(std::move(callback)) {}
mojo::Remote<mojom::Unzipper>& unzipper() { return unzipper_; }
void InvokeCallback(mojom::InfoPtr info) {
if (callback_) {
// TODO(crbug.com/953256) Add UMA timing.
std::move(callback_).Run(std::move(info));
}
unzipper_.reset();
}
private:
friend class base::RefCounted<GetExtractedInfoParams>;
~GetExtractedInfoParams() = default;
// The Remote is stored so it does not get deleted before the callback runs.
mojo::Remote<mojom::Unzipper> unzipper_;
GetExtractedInfoCallback callback_;
};
// A DecodeOperation is a cancellable invocation of DecodeXz.
class DecodeOperation : public base::RefCountedThreadSafe<DecodeOperation> {
public:
DecodeOperation(const base::FilePath& out_path,
base::OnceCallback<void(bool)> callback)
: out_path_(out_path), callback_(std::move(callback)) {
// DecodeOperation is created on one sequence but forever used on another.
DETACH_FROM_SEQUENCE(sequence_checker_);
}
// Start must be called only once. May block.
void Start(mojo::PendingRemote<mojom::Unzipper> unzipper,
const base::FilePath& in_path) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
base::File in(in_path, base::File::FLAG_OPEN | base::File::FLAG_READ |
base::File::FLAG_WIN_EXCLUSIVE_WRITE |
base::File::FLAG_WIN_SEQUENTIAL_SCAN |
base::File::FLAG_WIN_SHARE_DELETE);
if (!in.IsValid()) {
Done(false);
return;
}
base::File out(out_path_, base::File::FLAG_CREATE | base::File::FLAG_READ |
base::File::FLAG_WRITE |
base::File::FLAG_WIN_EXCLUSIVE_WRITE |
base::File::FLAG_WIN_SEQUENTIAL_SCAN |
base::File::FLAG_WIN_SHARE_DELETE);
if (!out.IsValid()) {
Done(false);
return;
}
unzipper_.Bind(std::move(unzipper));
unzipper_.set_disconnect_handler(
base::BindOnce(&DecodeOperation::Done, this, false));
unzipper_->DecodeXz(std::move(in), std::move(out),
base::BindOnce(&DecodeOperation::Done, this));
}
// Resets the unzipper remote and triggers the completion callback.
void Cancel() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
Done(false);
}
private:
// `Done` may be called multiple times, for example if cancellation is posted
// to a task runner, but concurrently, the job completes or the remote
// disconnects.
void Done(bool result) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (!result && unzipper_.is_bound()) {
base::GetDeleteFileCallback(out_path_).Run();
}
std::move(callback_).Run(result);
callback_ = base::DoNothing();
unzipper_.reset();
}
private:
friend class base::RefCountedThreadSafe<DecodeOperation>;
~DecodeOperation() = default;
SEQUENCE_CHECKER(sequence_checker_);
mojo::Remote<mojom::Unzipper> unzipper_;
const base::FilePath out_path_;
base::OnceCallback<void(bool)> callback_;
};
void DoDetectEncoding(mojo::PendingRemote<mojom::Unzipper> unzipper,
const base::FilePath& zip_path,
DetectEncodingCallback result_callback) {
base::File zip_file(zip_path, base::File::FLAG_OPEN | base::File::FLAG_READ);
if (!zip_file.IsValid()) {
LOG(ERROR) << "Cannot open ZIP archive " << Redact(zip_path) << ": "
<< base::File::ErrorToString(zip_file.error_details());
std::move(result_callback).Run(UNKNOWN_ENCODING);
return;
}
// |result_callback| is shared between the connection error handler and the
// DetectEncoding call using a refcounted DetectEncodingParams object that
// owns |result_callback|.
auto params = base::MakeRefCounted<DetectEncodingParams>(
std::move(unzipper), std::move(result_callback));
params->unzipper().set_disconnect_handler(base::BindOnce(
&DetectEncodingParams::InvokeCallback, params, UNKNOWN_ENCODING));
params->unzipper()->DetectEncoding(
std::move(zip_file),
base::BindOnce(&DetectEncodingParams::InvokeCallback, params));
}
void DoGetExtractedInfo(mojo::PendingRemote<mojom::Unzipper> unzipper,
const base::FilePath& zip_path,
GetExtractedInfoCallback result_callback) {
base::File zip_file(zip_path, base::File::FLAG_OPEN | base::File::FLAG_READ);
unzip::mojom::InfoPtr info = unzip::mojom::Info::New(false, 0, false, false);
if (!zip_file.IsValid()) {
LOG(ERROR) << "Cannot open ZIP archive " << Redact(zip_path) << ": "
<< base::File::ErrorToString(zip_file.error_details());
std::move(result_callback).Run(std::move(info));
return;
}
// |result_callback| is shared between the connection error handler and the
// GetExtractedInfo call using a refcounted GetExtractedInfoParams object that
// owns |result_callback|.
auto params = base::MakeRefCounted<GetExtractedInfoParams>(
std::move(unzipper), std::move(result_callback));
params->unzipper().set_disconnect_handler(base::BindOnce(
&GetExtractedInfoParams::InvokeCallback, params, std::move(info)));
params->unzipper()->GetExtractedInfo(
std::move(zip_file),
base::BindOnce(&GetExtractedInfoParams::InvokeCallback, params));
}
} // namespace
base::OnceClosure Unzip(mojo::PendingRemote<mojom::Unzipper> unzipper,
const base::FilePath& zip_file,
const base::FilePath& output_dir,
mojom::UnzipOptionsPtr options,
UnzipFilterCallback filter_callback,
UnzipListenerCallback listener_callback,
UnzipCallback result_callback) {
CHECK(result_callback);
auto unzip_operation = base::MakeRefCounted<UnzipOperation>(
filter_callback,
base::BindPostTaskToCurrentDefault(std::move(listener_callback)),
base::BindPostTaskToCurrentDefault(std::move(result_callback)));
const scoped_refptr<base::SequencedTaskRunner> runner =
base::ThreadPool::CreateSequencedTaskRunner(
{base::TaskPriority::USER_VISIBLE, base::MayBlock(),
base::TaskShutdownBehavior::SKIP_ON_SHUTDOWN});
runner->PostTask(FROM_HERE,
base::BindOnce(&UnzipOperation::Start, unzip_operation,
std::move(unzipper), zip_file, output_dir,
std::move(options)));
return base::BindPostTask(
runner, base::BindOnce(&UnzipOperation::Cancel, unzip_operation));
}
void DetectEncoding(mojo::PendingRemote<mojom::Unzipper> unzipper,
const base::FilePath& zip_path,
DetectEncodingCallback result_callback) {
base::ThreadPool::CreateSequencedTaskRunner(
{base::TaskPriority::USER_VISIBLE, base::MayBlock(),
base::TaskShutdownBehavior::SKIP_ON_SHUTDOWN})
->PostTask(FROM_HERE, base::BindOnce(&DoDetectEncoding,
std::move(unzipper), zip_path,
base::BindPostTaskToCurrentDefault(
std::move(result_callback))));
}
void GetExtractedInfo(mojo::PendingRemote<mojom::Unzipper> unzipper,
const base::FilePath& zip_path,
GetExtractedInfoCallback result_callback) {
base::ThreadPool::CreateSequencedTaskRunner(
{base::TaskPriority::USER_VISIBLE, base::MayBlock(),
base::TaskShutdownBehavior::SKIP_ON_SHUTDOWN})
->PostTask(FROM_HERE, base::BindOnce(&DoGetExtractedInfo,
std::move(unzipper), zip_path,
base::BindPostTaskToCurrentDefault(
std::move(result_callback))));
}
UnzipFilterCallback AllContents() {
return base::BindRepeating([](const base::FilePath&) { return true; });
}
base::OnceClosure DecodeXz(mojo::PendingRemote<mojom::Unzipper> unzipper,
const base::FilePath& in_file,
const base::FilePath& out_file,
base::OnceCallback<void(bool)> callback) {
auto op =
base::MakeRefCounted<DecodeOperation>(out_file, std::move(callback));
const scoped_refptr<base::SequencedTaskRunner> runner =
base::ThreadPool::CreateSequencedTaskRunner(
{base::TaskPriority::USER_VISIBLE, base::MayBlock(),
base::TaskShutdownBehavior::SKIP_ON_SHUTDOWN});
runner->PostTask(FROM_HERE, base::BindOnce(&DecodeOperation::Start, op,
std::move(unzipper), in_file));
return base::BindPostTask(runner,
base::BindOnce(&DecodeOperation::Cancel, op));
}
} // namespace unzip
|