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
|
// Copyright 2017 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_DOWNLOAD_PUBLIC_BACKGROUND_SERVICE_DOWNLOAD_PARAMS_H_
#define COMPONENTS_DOWNLOAD_PUBLIC_BACKGROUND_SERVICE_DOWNLOAD_PARAMS_H_
#include <map>
#include <string>
#include "base/callback.h"
#include "base/time/time.h"
#include "components/download/public/background_service/clients.h"
#include "net/base/isolation_info.h"
#include "net/http/http_request_headers.h"
#include "net/traffic_annotation/network_traffic_annotation.h"
#include "services/network/public/mojom/fetch_api.mojom-shared.h"
#include "third_party/abseil-cpp/absl/types/optional.h"
#include "url/gurl.h"
namespace download {
// The parameters describing when to run a download. This allows the caller to
// specify restrictions on what impact this download will have on the device
// (battery, network conditions, priority, etc.). On iOS, the network and
// battery requirements are mapped to NSURLSessionConfiguration.discretionary.
struct SchedulingParams {
public:
enum class NetworkRequirements {
// The download can occur under all network conditions.
NONE = 0,
// The download should occur when the network isn't metered. However if the
// device does not provide that opportunity over a long period of time, the
// DownloadService may start allowing these downloads to run on metered
// networks as well.
OPTIMISTIC = 1,
// The download can occur only if the network isn't metered.
UNMETERED = 2,
// Last value of the enum.
COUNT = 3,
};
enum class BatteryRequirements {
// The download can occur under all battery scenarios.
BATTERY_INSENSITIVE = 0,
// The download can only occur when device is charging or above optimal
// battery percentage.
BATTERY_SENSITIVE = 1,
// Download can only occur when the device is charging.
BATTERY_CHARGING = 2,
// Last value of the enum.
COUNT = 3,
};
enum class Priority {
// The lowest priority. Requires that the device is idle or Chrome is
// running. Gets paused or postponed during on-going navigation.
LOW = 0,
// The normal priority. Requires that the device is idle or Chrome is
// running. Gets paused or postponed during on-going navigation.
NORMAL = 1,
// The highest background priority. Does not require the device to be idle.
HIGH = 2,
// The highest priority. This will act (scheduling requirements aside) as a
// user-initiated download.
UI = 3,
// The default priority for all tasks unless overridden.
DEFAULT = NORMAL,
// Last value of the enum.
COUNT = 4,
};
SchedulingParams();
SchedulingParams(const SchedulingParams& other) = default;
~SchedulingParams() = default;
bool operator==(const SchedulingParams& rhs) const;
// Cancel the download after this time. Will cancel in-progress downloads.
// base::Time::Max() if not specified. Not supported on iOS.
base::Time cancel_time;
// The suggested priority. Non-UI priorities may not be honored by the
// DownloadService based on internal criteria and settings.
Priority priority;
NetworkRequirements network_requirements;
BatteryRequirements battery_requirements;
};
// The parameters describing how to build the request when starting a download.
struct RequestParams {
public:
RequestParams();
RequestParams(const RequestParams& other);
~RequestParams();
GURL url;
// The request method ("GET" is the default value).
std::string method;
net::HttpRequestHeaders request_headers;
// If the request will fetch HTTP error response body and treat them as
// a successful download. Not supported on iOS.
bool fetch_error_body;
// Whether the download is not trustworthy and requires safe browsing checks.
// Not supported on iOS.
bool require_safety_checks;
// The credentials mode of the request. Not supported on iOS.
::network::mojom::CredentialsMode credentials_mode;
// The isolation info of the request, this won't be persisted to db and will
// be invalidate during download resumption in new browser session. Not
// supported on iOS.
absl::optional<net::IsolationInfo> isolation_info;
// First-party URL redirect policy: During server redirects, whether the
// first-party URL for cookies will need to be changed. Download is normally
// considered a main frame navigation. However, this is not true for
// background fetch.
bool update_first_party_url_on_redirect = true;
};
// The parameters that describe a download request made to the DownloadService.
// The |client| needs to be properly created and registered for this service for
// the download to be accepted.
struct DownloadParams {
using CustomData = std::map<std::string, std::string>;
enum StartResult {
// The download is accepted and persisted.
ACCEPTED,
// The DownloadService has too many downloads. Backoff and retry.
BACKOFF,
// The DownloadService has no knowledge of the DownloadClient associated
// with this request.
UNEXPECTED_CLIENT,
// Failed to create the download. The guid is already in use.
UNEXPECTED_GUID,
// The download was cancelled by the Client while it was being persisted.
CLIENT_CANCELLED,
// The DownloadService was unable to accept and persist this download due to
// an internal error like the underlying DB store failing to write to disk.
INTERNAL_ERROR,
// TODO(dtrainor): Add more error codes.
// The count of entries for the enum.
COUNT,
};
using StartCallback =
base::OnceCallback<void(const std::string&, StartResult)>;
DownloadParams();
~DownloadParams();
DownloadParams(DownloadParams&& other);
DownloadParams& operator=(DownloadParams&& other);
// The feature that is requesting this download.
DownloadClient client;
// A unique GUID that represents this download. See |base::GenerateGUID()|.
std::string guid;
// A callback that will be notified if this download has been accepted and
// persisted by the DownloadService.
StartCallback callback;
// Custom key value pair to store custom data for various purposes. Has a 1024
// bytes size limit for each key or value. Will be sent back to clients when
// download is completed or failed. Not supported on iOS.
CustomData custom_data;
// The parameters that determine under what device conditions this download
// will occur.
SchedulingParams scheduling_params;
// The parameters that define the actual download request to make.
RequestParams request_params;
// Traffic annotation for the network request.
net::MutableNetworkTrafficAnnotationTag traffic_annotation;
};
} // namespace download
#endif // COMPONENTS_DOWNLOAD_PUBLIC_BACKGROUND_SERVICE_DOWNLOAD_PARAMS_H_
|
