File: op_download.cc

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 (205 lines) | stat: -rw-r--r-- 7,655 bytes parent folder | download | duplicates (5)
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
// 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_download.h"

#include <cstdint>
#include <optional>
#include <string>
#include <utility>
#include <vector>

#include "base/files/file_path.h"
#include "base/files/scoped_temp_dir.h"
#include "base/functional/bind.h"
#include "base/functional/callback.h"
#include "base/location.h"
#include "base/logging.h"
#include "base/memory/scoped_refptr.h"
#include "base/task/sequenced_task_runner.h"
#include "base/task/thread_pool.h"
#include "base/types/expected.h"
#include "base/values.h"
#include "build/build_config.h"
#include "components/update_client/cancellation.h"
#include "components/update_client/component.h"
#include "components/update_client/configurator.h"
#include "components/update_client/crx_downloader.h"
#include "components/update_client/crx_downloader_factory.h"
#include "components/update_client/protocol_definition.h"
#include "components/update_client/task_traits.h"
#include "components/update_client/update_client_errors.h"
#include "components/update_client/update_engine.h"
#include "url/gurl.h"

namespace update_client {

namespace {

#if BUILDFLAG(IS_MAC)
// The minimum size of a download to attempt it at background priority.
constexpr int64_t kBackgroundDownloadSizeThreshold = 10'000'000; /*10 MB*/
#else
constexpr int64_t kBackgroundDownloadSizeThreshold = 0;
#endif

bool CanDoBackgroundDownload(bool is_foreground,
                             bool background_downloads_enabled,
                             int64_t size) {
  return !is_foreground && background_downloads_enabled &&
         size >= kBackgroundDownloadSizeThreshold;
}

// Returns a string literal corresponding to the value of the downloader |d|.
const char* DownloaderToString(CrxDownloader::DownloadMetrics::Downloader d) {
  switch (d) {
    case CrxDownloader::DownloadMetrics::kUrlFetcher:
      return "direct";
    case CrxDownloader::DownloadMetrics::kBits:
      return "bits";
    case CrxDownloader::DownloadMetrics::kBackgroundMac:
      return "nsurlsession_background";
    default:
      return "unknown";
  }
}

base::Value::Dict MakeEvent(const CrxDownloader::DownloadMetrics& dm) {
  base::Value::Dict event;
  event.Set("eventtype", protocol_request::kEventDownload);
  event.Set("eventresult", static_cast<int>(dm.error == 0));
  event.Set("downloader", DownloaderToString(dm.downloader));
  if (dm.error) {
    event.Set("errorcode", dm.error);
  }
  if (dm.extra_code1) {
    event.Set("extracode1", dm.extra_code1);
  }
  event.Set("url", dm.url.spec());

  // -1 means that the  byte counts are not known.
  if (dm.total_bytes >= 0 &&
      dm.total_bytes < protocol_request::kProtocolMaxInt) {
    event.Set("total", static_cast<double>(dm.total_bytes));
  }
  if (dm.downloaded_bytes >= 0 &&
      dm.downloaded_bytes < protocol_request::kProtocolMaxInt) {
    event.Set("downloaded", static_cast<double>(dm.downloaded_bytes));
  }
  if (dm.download_time_ms >= 0 &&
      dm.download_time_ms < protocol_request::kProtocolMaxInt) {
    event.Set("download_time_ms", static_cast<double>(dm.download_time_ms));
  }
  return event;
}

void DownloadComplete(
    scoped_refptr<CrxDownloader> crx_downloader,
    scoped_refptr<Cancellation> cancellation,
    base::RepeatingCallback<void(base::Value::Dict)> event_adder,
    base::OnceCallback<void(base::expected<base::FilePath, CategorizedError>)>
        callback,
    const CrxDownloader::Result& download_result) {
  cancellation->Clear();

  for (const auto& metric : crx_downloader->download_metrics()) {
    event_adder.Run(MakeEvent(metric));
  }

  if (cancellation->IsCancelled()) {
    base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
        FROM_HERE,
        base::BindOnce(
            std::move(callback),
            base::unexpected<CategorizedError>(
                {.category = ErrorCategory::kService,
                 .code = static_cast<int>(ServiceError::CANCELLED)})));
    return;
  }

  if (download_result.error) {
    CHECK(download_result.response.empty());
    base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
        FROM_HERE, base::BindOnce(std::move(callback),
                                  base::unexpected<CategorizedError>(
                                      {.category = ErrorCategory::kDownload,
                                       .code = download_result.error,
                                       .extra = download_result.extra_code1})));
    return;
  }
  base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
      FROM_HERE, base::BindOnce(std::move(callback), download_result.response));
}

void HandleAvailableSpace(
    scoped_refptr<Configurator> config,
    scoped_refptr<Cancellation> cancellation,
    bool is_foreground,
    const std::vector<GURL>& urls,
    int64_t size,
    const std::string& hash,
    CrxDownloader::ProgressCallback progress_callback,
    base::RepeatingCallback<void(base::Value::Dict)> event_adder,
    base::OnceCallback<void(base::expected<base::FilePath, CategorizedError>)>
        callback,
    int64_t available_bytes) {
  if (available_bytes / 2 <= size) {
    VLOG(1) << "available_bytes: " << available_bytes
            << ", download size: " << size;
    base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
        FROM_HERE,
        base::BindOnce(
            std::move(callback),
            base::unexpected<CategorizedError>(
                {.category = ErrorCategory::kDownload,
                 .code = static_cast<int>(CrxDownloaderError::DISK_FULL)})));
    return;
  }
  scoped_refptr<CrxDownloader> crx_downloader =
      config->GetCrxDownloaderFactory()->MakeCrxDownloader(
          CanDoBackgroundDownload(is_foreground,
                                  config->EnabledBackgroundDownloader(), size));
  crx_downloader->set_progress_callback(progress_callback);
  cancellation->OnCancel(crx_downloader->StartDownload(
      urls, hash,
      base::BindOnce(&DownloadComplete, crx_downloader, cancellation,
                     event_adder, std::move(callback))));
}

}  // namespace

base::OnceClosure DownloadOperation(
    scoped_refptr<Configurator> config,
    base::RepeatingCallback<int64_t(const base::FilePath&)> get_available_space,
    bool is_foreground,
    const std::vector<GURL>& urls,
    int64_t size,
    const std::string& hash,
    base::RepeatingCallback<void(base::Value::Dict)> event_adder,
    base::RepeatingCallback<void(ComponentState)> state_tracker,
    CrxDownloader::ProgressCallback progress_callback,
    const base::FilePath& file,
    base::OnceCallback<void(base::expected<base::FilePath, CategorizedError>)>
        callback) {
  state_tracker.Run(ComponentState::kDownloading);
  auto cancellation = base::MakeRefCounted<Cancellation>();
  progress_callback.Run(-1, -1);
  base::ThreadPool::PostTaskAndReplyWithResult(
      FROM_HERE, kTaskTraits,
      base::BindOnce(
          [](base::RepeatingCallback<int64_t(const base::FilePath&)>
                 get_available_space) {
            base::ScopedTempDir temp_dir;
            return temp_dir.CreateUniqueTempDir()
                       ? get_available_space.Run(temp_dir.GetPath())
                       : int64_t{0};
          },
          get_available_space),
      base::BindOnce(&HandleAvailableSpace, config, cancellation, is_foreground,
                     urls, size, hash, progress_callback, event_adder,
                     std::move(callback)));
  return base::BindOnce(&Cancellation::Cancel, cancellation);
}

}  // namespace update_client