blob: 63c67c0b7e3221bec4423252f465dd50df6c0fa8 [file] [log] [blame]
Alex Deymoaea4c1c2015-08-19 20:24:43 -07001//
2// Copyright (C) 2009 The Android Open Source Project
3//
4// Licensed under the Apache License, Version 2.0 (the "License");
5// you may not use this file except in compliance with the License.
6// You may obtain a copy of the License at
7//
8// http://www.apache.org/licenses/LICENSE-2.0
9//
10// Unless required by applicable law or agreed to in writing, software
11// distributed under the License is distributed on an "AS IS" BASIS,
12// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13// See the License for the specific language governing permissions and
14// limitations under the License.
15//
rspangler@google.com49fdf182009-10-10 00:57:34 +000016
Alex Deymo14c0da82016-07-20 16:45:45 -070017#include "update_engine/libcurl_http_fetcher.h"
Andrew de los Reyesd57d1472010-10-21 13:34:08 -070018
adlr@google.comc98a7ed2009-12-04 18:54:03 +000019#include <algorithm>
Andrew de los Reyesd57d1472010-10-21 13:34:08 -070020#include <string>
21
Alex Vakulenko4906c1c2014-08-21 13:17:44 -070022#include <base/bind.h>
Alex Deymoc00c98a2015-03-17 17:38:00 -070023#include <base/format_macros.h>
Alex Deymo60ca1a72015-06-18 18:19:15 -070024#include <base/location.h>
Andrew de los Reyesd57d1472010-10-21 13:34:08 -070025#include <base/logging.h>
Alex Vakulenko75039d72014-03-25 12:36:28 -070026#include <base/strings/string_util.h>
27#include <base/strings/stringprintf.h>
Andrew de los Reyesd57d1472010-10-21 13:34:08 -070028
Alex Deymo14c0da82016-07-20 16:45:45 -070029#include "update_engine/certificate_checker.h"
Alex Deymo39910dc2015-11-09 17:04:30 -080030#include "update_engine/common/hardware_interface.h"
31#include "update_engine/common/platform_constants.h"
adlr@google.comc98a7ed2009-12-04 18:54:03 +000032
Alex Deymo60ca1a72015-06-18 18:19:15 -070033using base::TimeDelta;
Alex Vakulenko3f39d5c2015-10-13 09:27:13 -070034using brillo::MessageLoop;
Alex Deymoc4acdf42014-05-28 21:07:10 -070035using std::max;
Andrew de los Reyesd57d1472010-10-21 13:34:08 -070036using std::string;
rspangler@google.com49fdf182009-10-10 00:57:34 +000037
38// This is a concrete implementation of HttpFetcher that uses libcurl to do the
39// http work.
40
41namespace chromeos_update_engine {
42
Andrew de los Reyes9bbd1872010-07-16 14:52:29 -070043namespace {
Andrew de los Reyes5d0783d2010-11-29 18:14:16 -080044const int kNoNetworkRetrySeconds = 10;
Alex Vakulenkod2779df2014-06-16 13:19:00 -070045} // namespace
Andrew de los Reyes9bbd1872010-07-16 14:52:29 -070046
Alex Deymo33e91e72015-12-01 18:26:08 -030047LibcurlHttpFetcher::LibcurlHttpFetcher(ProxyResolver* proxy_resolver,
48 HardwareInterface* hardware)
49 : HttpFetcher(proxy_resolver), hardware_(hardware) {
Alex Deymoc1c17b42015-11-23 03:53:15 -030050 // Dev users want a longer timeout (180 seconds) because they may
51 // be waiting on the dev server to build an image.
52 if (!hardware_->IsOfficialBuild())
53 low_speed_time_seconds_ = kDownloadDevModeLowSpeedTimeSeconds;
Alex Deymo46a9aae2016-05-04 20:20:11 -070054 if (hardware_->IsOOBEEnabled() && !hardware_->IsOOBEComplete(nullptr))
Alex Deymoc1c17b42015-11-23 03:53:15 -030055 max_retry_count_ = kDownloadMaxRetryCountOobeNotComplete;
56}
57
rspangler@google.com49fdf182009-10-10 00:57:34 +000058LibcurlHttpFetcher::~LibcurlHttpFetcher() {
Darin Petkov9ce452b2010-11-17 14:33:28 -080059 LOG_IF(ERROR, transfer_in_progress_)
60 << "Destroying the fetcher while a transfer is in progress.";
Alex Deymo71f67622017-02-03 21:30:24 -080061 CancelProxyResolution();
rspangler@google.com49fdf182009-10-10 00:57:34 +000062 CleanUp();
63}
64
Alex Deymof329b932014-10-30 01:37:48 -070065bool LibcurlHttpFetcher::GetProxyType(const string& proxy,
Gilad Arnold59d9e012013-07-23 16:41:43 -070066 curl_proxytype* out_type) {
Alex Deymo56ccb072016-02-05 00:50:48 -080067 if (base::StartsWith(
68 proxy, "socks5://", base::CompareCase::INSENSITIVE_ASCII) ||
69 base::StartsWith(
70 proxy, "socks://", base::CompareCase::INSENSITIVE_ASCII)) {
Gilad Arnold59d9e012013-07-23 16:41:43 -070071 *out_type = CURLPROXY_SOCKS5_HOSTNAME;
72 return true;
73 }
Alex Deymo56ccb072016-02-05 00:50:48 -080074 if (base::StartsWith(
75 proxy, "socks4://", base::CompareCase::INSENSITIVE_ASCII)) {
Gilad Arnold59d9e012013-07-23 16:41:43 -070076 *out_type = CURLPROXY_SOCKS4A;
77 return true;
78 }
Alex Deymo56ccb072016-02-05 00:50:48 -080079 if (base::StartsWith(
80 proxy, "http://", base::CompareCase::INSENSITIVE_ASCII) ||
81 base::StartsWith(
82 proxy, "https://", base::CompareCase::INSENSITIVE_ASCII)) {
Gilad Arnold59d9e012013-07-23 16:41:43 -070083 *out_type = CURLPROXY_HTTP;
84 return true;
85 }
Alex Deymo56ccb072016-02-05 00:50:48 -080086 if (base::StartsWith(proxy, kNoProxy, base::CompareCase::INSENSITIVE_ASCII)) {
Gilad Arnold59d9e012013-07-23 16:41:43 -070087 // known failure case. don't log.
88 return false;
89 }
90 LOG(INFO) << "Unknown proxy type: " << proxy;
91 return false;
92}
93
Alex Deymof329b932014-10-30 01:37:48 -070094void LibcurlHttpFetcher::ResumeTransfer(const string& url) {
Andrew de los Reyes3270f742010-07-15 22:28:14 -070095 LOG(INFO) << "Starting/Resuming transfer";
rspangler@google.com49fdf182009-10-10 00:57:34 +000096 CHECK(!transfer_in_progress_);
97 url_ = url;
98 curl_multi_handle_ = curl_multi_init();
99 CHECK(curl_multi_handle_);
100
101 curl_handle_ = curl_easy_init();
102 CHECK(curl_handle_);
Alex Deymof2858572016-02-25 11:20:13 -0800103 ignore_failure_ = false;
rspangler@google.com49fdf182009-10-10 00:57:34 +0000104
Andrew de los Reyes45168102010-11-22 11:13:50 -0800105 CHECK(HasProxy());
Gilad Arnoldfbaee242012-04-04 15:59:43 -0700106 bool is_direct = (GetCurrentProxy() == kNoProxy);
107 LOG(INFO) << "Using proxy: " << (is_direct ? "no" : "yes");
108 if (is_direct) {
Andrew de los Reyes45168102010-11-22 11:13:50 -0800109 CHECK_EQ(curl_easy_setopt(curl_handle_,
110 CURLOPT_PROXY,
111 ""), CURLE_OK);
112 } else {
113 CHECK_EQ(curl_easy_setopt(curl_handle_,
114 CURLOPT_PROXY,
115 GetCurrentProxy().c_str()), CURLE_OK);
116 // Curl seems to require us to set the protocol
117 curl_proxytype type;
Gilad Arnold59d9e012013-07-23 16:41:43 -0700118 if (GetProxyType(GetCurrentProxy(), &type)) {
Andrew de los Reyes45168102010-11-22 11:13:50 -0800119 CHECK_EQ(curl_easy_setopt(curl_handle_,
120 CURLOPT_PROXYTYPE,
121 type), CURLE_OK);
122 }
123 }
124
rspangler@google.com49fdf182009-10-10 00:57:34 +0000125 if (post_data_set_) {
adlr@google.comc98a7ed2009-12-04 18:54:03 +0000126 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_POST, 1), CURLE_OK);
127 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_POSTFIELDS,
Alex Vakulenkof68bbbc2015-02-09 12:53:18 -0800128 post_data_.data()),
adlr@google.comc98a7ed2009-12-04 18:54:03 +0000129 CURLE_OK);
130 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_POSTFIELDSIZE,
131 post_data_.size()),
132 CURLE_OK);
Alex Deymofdd6dec2016-03-03 22:35:43 -0800133 }
Gilad Arnold9dd1e7c2012-02-16 12:13:36 -0800134
Alex Deymofdd6dec2016-03-03 22:35:43 -0800135 // Setup extra HTTP headers.
136 if (curl_http_headers_) {
137 curl_slist_free_all(curl_http_headers_);
138 curl_http_headers_ = nullptr;
139 }
140 for (const auto& header : extra_headers_) {
141 // curl_slist_append() copies the string.
142 curl_http_headers_ =
143 curl_slist_append(curl_http_headers_, header.second.c_str());
144 }
145 if (post_data_set_) {
Gilad Arnold9dd1e7c2012-02-16 12:13:36 -0800146 // Set the Content-Type HTTP header, if one was specifically set.
Gilad Arnold9dd1e7c2012-02-16 12:13:36 -0800147 if (post_content_type_ != kHttpContentTypeUnspecified) {
Alex Deymofdd6dec2016-03-03 22:35:43 -0800148 const string content_type_attr = base::StringPrintf(
149 "Content-Type: %s", GetHttpContentTypeString(post_content_type_));
150 curl_http_headers_ =
151 curl_slist_append(curl_http_headers_, content_type_attr.c_str());
Gilad Arnold9dd1e7c2012-02-16 12:13:36 -0800152 } else {
153 LOG(WARNING) << "no content type set, using libcurl default";
154 }
rspangler@google.com49fdf182009-10-10 00:57:34 +0000155 }
Alex Deymofdd6dec2016-03-03 22:35:43 -0800156 CHECK_EQ(
157 curl_easy_setopt(curl_handle_, CURLOPT_HTTPHEADER, curl_http_headers_),
158 CURLE_OK);
rspangler@google.com49fdf182009-10-10 00:57:34 +0000159
Gilad Arnolde4ad2502011-12-29 17:08:54 -0800160 if (bytes_downloaded_ > 0 || download_length_) {
161 // Resume from where we left off.
adlr@google.comc98a7ed2009-12-04 18:54:03 +0000162 resume_offset_ = bytes_downloaded_;
Gilad Arnolde4ad2502011-12-29 17:08:54 -0800163 CHECK_GE(resume_offset_, 0);
164
165 // Compute end offset, if one is specified. As per HTTP specification, this
166 // is an inclusive boundary. Make sure it doesn't overflow.
167 size_t end_offset = 0;
168 if (download_length_) {
169 end_offset = static_cast<size_t>(resume_offset_) + download_length_ - 1;
170 CHECK_LE((size_t) resume_offset_, end_offset);
171 }
172
173 // Create a string representation of the desired range.
Alex Deymoc00c98a2015-03-17 17:38:00 -0700174 string range_str = base::StringPrintf(
175 "%" PRIu64 "-", static_cast<uint64_t>(resume_offset_));
176 if (end_offset)
177 range_str += std::to_string(end_offset);
Gilad Arnolde4ad2502011-12-29 17:08:54 -0800178 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_RANGE, range_str.c_str()),
179 CURLE_OK);
adlr@google.comc98a7ed2009-12-04 18:54:03 +0000180 }
181
182 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_WRITEDATA, this), CURLE_OK);
183 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_WRITEFUNCTION,
184 StaticLibcurlWrite), CURLE_OK);
Chris Sosa77f79e82014-06-02 18:16:24 -0700185 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_URL, url_.c_str()),
Andrew de los Reyesd57d1472010-10-21 13:34:08 -0700186 CURLE_OK);
Andrew de los Reyes3270f742010-07-15 22:28:14 -0700187
David Zeuthen34135a92013-08-06 11:16:16 -0700188 // If the connection drops under |low_speed_limit_bps_| (10
189 // bytes/sec by default) for |low_speed_time_seconds_| (90 seconds,
190 // 180 on non-official builds), reconnect.
191 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_LOW_SPEED_LIMIT,
192 low_speed_limit_bps_),
Andrew de los Reyes3270f742010-07-15 22:28:14 -0700193 CURLE_OK);
David Zeuthen34135a92013-08-06 11:16:16 -0700194 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_LOW_SPEED_TIME,
195 low_speed_time_seconds_),
Andrew de los Reyes3270f742010-07-15 22:28:14 -0700196 CURLE_OK);
David Zeuthen34135a92013-08-06 11:16:16 -0700197 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_CONNECTTIMEOUT,
198 connect_timeout_seconds_),
Andrew de los Reyese72f9c02011-04-20 10:47:40 -0700199 CURLE_OK);
Andrew de los Reyes3270f742010-07-15 22:28:14 -0700200
Darin Petkov41c2fcf2010-08-25 13:14:48 -0700201 // By default, libcurl doesn't follow redirections. Allow up to
David Zeuthen34135a92013-08-06 11:16:16 -0700202 // |kDownloadMaxRedirects| redirections.
Darin Petkov3a4016a2010-09-28 13:54:17 -0700203 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_FOLLOWLOCATION, 1), CURLE_OK);
David Zeuthen34135a92013-08-06 11:16:16 -0700204 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_MAXREDIRS,
205 kDownloadMaxRedirects),
Darin Petkov41c2fcf2010-08-25 13:14:48 -0700206 CURLE_OK);
207
Nam T. Nguyen7d623eb2014-05-13 16:06:28 -0700208 // Lock down the appropriate curl options for HTTP or HTTPS depending on
209 // the url.
Alex Deymoc1c17b42015-11-23 03:53:15 -0300210 if (hardware_->IsOfficialBuild()) {
Alex Deymo56ccb072016-02-05 00:50:48 -0800211 if (base::StartsWith(
212 url_, "http://", base::CompareCase::INSENSITIVE_ASCII)) {
Jay Srinivasanb3f55402012-12-03 18:12:04 -0800213 SetCurlOptionsForHttp();
Alex Deymo56ccb072016-02-05 00:50:48 -0800214 } else if (base::StartsWith(
215 url_, "https://", base::CompareCase::INSENSITIVE_ASCII)) {
Jay Srinivasanb3f55402012-12-03 18:12:04 -0800216 SetCurlOptionsForHttps();
Alex Deymo56ccb072016-02-05 00:50:48 -0800217#if !defined(__CHROMEOS__) && !defined(__BRILLO__)
218 } else if (base::StartsWith(
219 url_, "file://", base::CompareCase::INSENSITIVE_ASCII)) {
220 SetCurlOptionsForFile();
221#endif
222 } else {
223 LOG(ERROR) << "Received invalid URI: " << url_;
224 // Lock down to no protocol supported for the transfer.
225 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_PROTOCOLS, 0), CURLE_OK);
226 }
Jay Srinivasanb3f55402012-12-03 18:12:04 -0800227 } else {
Nam T. Nguyen7d623eb2014-05-13 16:06:28 -0700228 LOG(INFO) << "Not setting http(s) curl options because we are "
229 << "running a dev/test image";
Darin Petkovfc7a0ce2010-10-25 10:38:37 -0700230 }
231
adlr@google.comc98a7ed2009-12-04 18:54:03 +0000232 CHECK_EQ(curl_multi_add_handle(curl_multi_handle_, curl_handle_), CURLM_OK);
rspangler@google.com49fdf182009-10-10 00:57:34 +0000233 transfer_in_progress_ = true;
rspangler@google.com49fdf182009-10-10 00:57:34 +0000234}
235
Jay Srinivasanb3f55402012-12-03 18:12:04 -0800236// Lock down only the protocol in case of HTTP.
237void LibcurlHttpFetcher::SetCurlOptionsForHttp() {
238 LOG(INFO) << "Setting up curl options for HTTP";
239 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_PROTOCOLS, CURLPROTO_HTTP),
240 CURLE_OK);
241 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_REDIR_PROTOCOLS,
242 CURLPROTO_HTTP),
243 CURLE_OK);
244}
245
246// Security lock-down in official builds: makes sure that peer certificate
247// verification is enabled, restricts the set of trusted certificates,
248// restricts protocols to HTTPS, restricts ciphers to HIGH.
249void LibcurlHttpFetcher::SetCurlOptionsForHttps() {
250 LOG(INFO) << "Setting up curl options for HTTPS";
251 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_SSL_VERIFYPEER, 1),
252 CURLE_OK);
Alex Deymo8fd98d82016-06-23 18:22:08 -0700253 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_SSL_VERIFYHOST, 2),
254 CURLE_OK);
Alex Deymo35b35842015-10-20 11:21:56 -0700255 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_CAPATH,
256 constants::kCACertificatesPath),
Jay Srinivasanb3f55402012-12-03 18:12:04 -0800257 CURLE_OK);
258 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_PROTOCOLS, CURLPROTO_HTTPS),
259 CURLE_OK);
260 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_REDIR_PROTOCOLS,
261 CURLPROTO_HTTPS),
262 CURLE_OK);
263 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_SSL_CIPHER_LIST, "HIGH:!ADH"),
264 CURLE_OK);
Alex Deymo33e91e72015-12-01 18:26:08 -0300265 if (server_to_check_ != ServerToCheck::kNone) {
266 CHECK_EQ(
267 curl_easy_setopt(curl_handle_, CURLOPT_SSL_CTX_DATA, &server_to_check_),
268 CURLE_OK);
Jay Srinivasanb3f55402012-12-03 18:12:04 -0800269 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_SSL_CTX_FUNCTION,
270 CertificateChecker::ProcessSSLContext),
271 CURLE_OK);
272 }
273}
274
Alex Deymo56ccb072016-02-05 00:50:48 -0800275// Lock down only the protocol in case of a local file.
276void LibcurlHttpFetcher::SetCurlOptionsForFile() {
277 LOG(INFO) << "Setting up curl options for FILE";
278 CHECK_EQ(curl_easy_setopt(curl_handle_, CURLOPT_PROTOCOLS, CURLPROTO_FILE),
279 CURLE_OK);
280 CHECK_EQ(
281 curl_easy_setopt(curl_handle_, CURLOPT_REDIR_PROTOCOLS, CURLPROTO_FILE),
282 CURLE_OK);
283}
Jay Srinivasanb3f55402012-12-03 18:12:04 -0800284
adlr@google.comc98a7ed2009-12-04 18:54:03 +0000285// Begins the transfer, which must not have already been started.
Alex Deymof329b932014-10-30 01:37:48 -0700286void LibcurlHttpFetcher::BeginTransfer(const string& url) {
Andrew de los Reyesf3ed8e72011-02-16 10:35:46 -0800287 CHECK(!transfer_in_progress_);
288 url_ = url;
Alex Vakulenko4906c1c2014-08-21 13:17:44 -0700289 auto closure = base::Bind(&LibcurlHttpFetcher::ProxiesResolved,
290 base::Unretained(this));
Alex Deymo60ca1a72015-06-18 18:19:15 -0700291 if (!ResolveProxiesForUrl(url_, closure)) {
Andrew de los Reyesf3ed8e72011-02-16 10:35:46 -0800292 LOG(ERROR) << "Couldn't resolve proxies";
293 if (delegate_)
294 delegate_->TransferComplete(this, false);
295 }
296}
297
298void LibcurlHttpFetcher::ProxiesResolved() {
adlr@google.comc98a7ed2009-12-04 18:54:03 +0000299 transfer_size_ = -1;
adlr@google.comc98a7ed2009-12-04 18:54:03 +0000300 resume_offset_ = 0;
Andrew de los Reyes9bbd1872010-07-16 14:52:29 -0700301 retry_count_ = 0;
Darin Petkova0929552010-11-29 14:19:06 -0800302 no_network_retry_count_ = 0;
Darin Petkovcb466212010-08-26 09:40:11 -0700303 http_response_code_ = 0;
Andrew de los Reyes819fef22010-12-17 11:33:58 -0800304 terminate_requested_ = false;
Gilad Arnolda2dee1d2012-04-12 11:50:37 -0700305 sent_byte_ = false;
Alex Deymof2858572016-02-25 11:20:13 -0800306
307 // If we are paused, we delay these two operations until Unpause is called.
308 if (transfer_paused_) {
309 restart_transfer_on_unpause_ = true;
310 return;
311 }
Andrew de los Reyesf3ed8e72011-02-16 10:35:46 -0800312 ResumeTransfer(url_);
Andrew de los Reyes9bbd1872010-07-16 14:52:29 -0700313 CurlPerformOnce();
adlr@google.comc98a7ed2009-12-04 18:54:03 +0000314}
315
Darin Petkov9ce452b2010-11-17 14:33:28 -0800316void LibcurlHttpFetcher::ForceTransferTermination() {
Alex Deymo71f67622017-02-03 21:30:24 -0800317 CancelProxyResolution();
Darin Petkov9ce452b2010-11-17 14:33:28 -0800318 CleanUp();
319 if (delegate_) {
320 // Note that after the callback returns this object may be destroyed.
321 delegate_->TransferTerminated(this);
322 }
323}
324
rspangler@google.com49fdf182009-10-10 00:57:34 +0000325void LibcurlHttpFetcher::TerminateTransfer() {
Darin Petkov9ce452b2010-11-17 14:33:28 -0800326 if (in_write_callback_) {
Andrew de los Reyes3fd5d302010-10-07 20:07:18 -0700327 terminate_requested_ = true;
Darin Petkov9ce452b2010-11-17 14:33:28 -0800328 } else {
329 ForceTransferTermination();
330 }
rspangler@google.com49fdf182009-10-10 00:57:34 +0000331}
332
Alex Deymofdd6dec2016-03-03 22:35:43 -0800333void LibcurlHttpFetcher::SetHeader(const string& header_name,
334 const string& header_value) {
335 string header_line = header_name + ": " + header_value;
336 // Avoid the space if no data on the right side of the semicolon.
337 if (header_value.empty())
338 header_line = header_name + ":";
339 TEST_AND_RETURN(header_line.find('\n') == string::npos);
340 TEST_AND_RETURN(header_name.find(':') == string::npos);
341 extra_headers_[base::ToLowerASCII(header_name)] = header_line;
342}
343
Andrew de los Reyescb319332010-07-19 10:55:01 -0700344void LibcurlHttpFetcher::CurlPerformOnce() {
rspangler@google.com49fdf182009-10-10 00:57:34 +0000345 CHECK(transfer_in_progress_);
346 int running_handles = 0;
347 CURLMcode retcode = CURLM_CALL_MULTI_PERFORM;
348
349 // libcurl may request that we immediately call curl_multi_perform after it
350 // returns, so we do. libcurl promises that curl_multi_perform will not block.
351 while (CURLM_CALL_MULTI_PERFORM == retcode) {
352 retcode = curl_multi_perform(curl_multi_handle_, &running_handles);
Andrew de los Reyes3fd5d302010-10-07 20:07:18 -0700353 if (terminate_requested_) {
Darin Petkov9ce452b2010-11-17 14:33:28 -0800354 ForceTransferTermination();
Andrew de los Reyes3fd5d302010-10-07 20:07:18 -0700355 return;
356 }
rspangler@google.com49fdf182009-10-10 00:57:34 +0000357 }
Alex Deymof2858572016-02-25 11:20:13 -0800358
359 // If the transfer completes while paused, we should ignore the failure once
360 // the fetcher is unpaused.
361 if (running_handles == 0 && transfer_paused_ && !ignore_failure_) {
362 LOG(INFO) << "Connection closed while paused, ignoring failure.";
363 ignore_failure_ = true;
364 }
365
366 if (running_handles != 0 || transfer_paused_) {
367 // There's either more work to do or we are paused, so we just keep the
368 // file descriptors to watch up to date and exit, until we are done with the
369 // work and we are not paused.
370 SetupMessageLoopSources();
371 return;
372 }
373
374 // At this point, the transfer was completed in some way (error, connection
375 // closed or download finished).
376
377 GetHttpResponseCode();
378 if (http_response_code_) {
379 LOG(INFO) << "HTTP response code: " << http_response_code_;
380 no_network_retry_count_ = 0;
381 } else {
382 LOG(ERROR) << "Unable to get http response code.";
383 }
384
385 // we're done!
386 CleanUp();
387
388 // TODO(petkov): This temporary code tries to deal with the case where the
389 // update engine performs an update check while the network is not ready
390 // (e.g., right after resume). Longer term, we should check if the network
391 // is online/offline and return an appropriate error code.
392 if (!sent_byte_ &&
393 http_response_code_ == 0 &&
394 no_network_retry_count_ < no_network_max_retries_) {
395 no_network_retry_count_++;
Alex Deymob20de692017-02-05 07:47:37 +0000396 retry_task_id_ = MessageLoop::current()->PostDelayedTask(
Alex Deymof2858572016-02-25 11:20:13 -0800397 FROM_HERE,
398 base::Bind(&LibcurlHttpFetcher::RetryTimeoutCallback,
399 base::Unretained(this)),
400 TimeDelta::FromSeconds(kNoNetworkRetrySeconds));
401 LOG(INFO) << "No HTTP response, retry " << no_network_retry_count_;
402 } else if ((!sent_byte_ && !IsHttpResponseSuccess()) ||
403 IsHttpResponseError()) {
404 // The transfer completed w/ error and we didn't get any bytes.
405 // If we have another proxy to try, try that.
406 //
407 // TODO(garnold) in fact there are two separate cases here: one case is an
408 // other-than-success return code (including no return code) and no
409 // received bytes, which is necessary due to the way callbacks are
410 // currently processing error conditions; the second is an explicit HTTP
411 // error code, where some data may have been received (as in the case of a
412 // semi-successful multi-chunk fetch). This is a confusing behavior and
413 // should be unified into a complete, coherent interface.
414 LOG(INFO) << "Transfer resulted in an error (" << http_response_code_
415 << "), " << bytes_downloaded_ << " bytes downloaded";
416
417 PopProxy(); // Delete the proxy we just gave up on.
418
419 if (HasProxy()) {
420 // We have another proxy. Retry immediately.
421 LOG(INFO) << "Retrying with next proxy setting";
Alex Deymob20de692017-02-05 07:47:37 +0000422 retry_task_id_ = MessageLoop::current()->PostTask(
Alex Deymof2858572016-02-25 11:20:13 -0800423 FROM_HERE,
424 base::Bind(&LibcurlHttpFetcher::RetryTimeoutCallback,
425 base::Unretained(this)));
Andrew de los Reyes9bbd1872010-07-16 14:52:29 -0700426 } else {
Alex Deymof2858572016-02-25 11:20:13 -0800427 // Out of proxies. Give up.
428 LOG(INFO) << "No further proxies, indicating transfer complete";
429 if (delegate_)
430 delegate_->TransferComplete(this, false); // signal fail
Alex Deymo021a45e2016-03-15 13:12:05 -0700431 return;
Andrew de los Reyes9bbd1872010-07-16 14:52:29 -0700432 }
Alex Deymof2858572016-02-25 11:20:13 -0800433 } else if ((transfer_size_ >= 0) && (bytes_downloaded_ < transfer_size_)) {
434 if (!ignore_failure_)
435 retry_count_++;
436 LOG(INFO) << "Transfer interrupted after downloading "
437 << bytes_downloaded_ << " of " << transfer_size_ << " bytes. "
438 << transfer_size_ - bytes_downloaded_ << " bytes remaining "
439 << "after " << retry_count_ << " attempt(s)";
Darin Petkov192ced42010-07-23 16:20:24 -0700440
Alex Deymof2858572016-02-25 11:20:13 -0800441 if (retry_count_ > max_retry_count_) {
442 LOG(INFO) << "Reached max attempts (" << retry_count_ << ")";
443 if (delegate_)
444 delegate_->TransferComplete(this, false); // signal fail
Alex Deymo021a45e2016-03-15 13:12:05 -0700445 return;
adlr@google.comc98a7ed2009-12-04 18:54:03 +0000446 }
Alex Deymo021a45e2016-03-15 13:12:05 -0700447 // Need to restart transfer
448 LOG(INFO) << "Restarting transfer to download the remaining bytes";
Alex Deymob20de692017-02-05 07:47:37 +0000449 retry_task_id_ = MessageLoop::current()->PostDelayedTask(
Alex Deymo021a45e2016-03-15 13:12:05 -0700450 FROM_HERE,
451 base::Bind(&LibcurlHttpFetcher::RetryTimeoutCallback,
452 base::Unretained(this)),
453 TimeDelta::FromSeconds(retry_seconds_));
rspangler@google.com49fdf182009-10-10 00:57:34 +0000454 } else {
Alex Deymof2858572016-02-25 11:20:13 -0800455 LOG(INFO) << "Transfer completed (" << http_response_code_
456 << "), " << bytes_downloaded_ << " bytes downloaded";
457 if (delegate_) {
458 bool success = IsHttpResponseSuccess();
459 delegate_->TransferComplete(this, success);
460 }
Alex Deymo021a45e2016-03-15 13:12:05 -0700461 return;
rspangler@google.com49fdf182009-10-10 00:57:34 +0000462 }
Alex Deymo021a45e2016-03-15 13:12:05 -0700463 // If we reach this point is because TransferComplete() was not called in any
464 // of the previous branches. The delegate is allowed to destroy the object
465 // once TransferComplete is called so this would be illegal.
Alex Deymof2858572016-02-25 11:20:13 -0800466 ignore_failure_ = false;
rspangler@google.com49fdf182009-10-10 00:57:34 +0000467}
468
469size_t LibcurlHttpFetcher::LibcurlWrite(void *ptr, size_t size, size_t nmemb) {
Gilad Arnold48085ba2011-11-16 09:36:08 -0800470 // Update HTTP response first.
Andrew de los Reyes3fd5d302010-10-07 20:07:18 -0700471 GetHttpResponseCode();
Gilad Arnold48085ba2011-11-16 09:36:08 -0800472 const size_t payload_size = size * nmemb;
473
474 // Do nothing if no payload or HTTP response is an error.
Gilad Arnold9bedeb52011-11-17 16:19:57 -0800475 if (payload_size == 0 || !IsHttpResponseSuccess()) {
Gilad Arnold48085ba2011-11-16 09:36:08 -0800476 LOG(INFO) << "HTTP response unsuccessful (" << http_response_code_
477 << ") or no payload (" << payload_size << "), nothing to do";
478 return 0;
479 }
480
481 sent_byte_ = true;
adlr@google.comc98a7ed2009-12-04 18:54:03 +0000482 {
483 double transfer_size_double;
484 CHECK_EQ(curl_easy_getinfo(curl_handle_,
485 CURLINFO_CONTENT_LENGTH_DOWNLOAD,
486 &transfer_size_double), CURLE_OK);
487 off_t new_transfer_size = static_cast<off_t>(transfer_size_double);
488 if (new_transfer_size > 0) {
489 transfer_size_ = resume_offset_ + new_transfer_size;
490 }
491 }
Gilad Arnold48085ba2011-11-16 09:36:08 -0800492 bytes_downloaded_ += payload_size;
Andrew de los Reyes3fd5d302010-10-07 20:07:18 -0700493 in_write_callback_ = true;
rspangler@google.com49fdf182009-10-10 00:57:34 +0000494 if (delegate_)
Alex Vakulenkof68bbbc2015-02-09 12:53:18 -0800495 delegate_->ReceivedBytes(this, ptr, payload_size);
Andrew de los Reyes3fd5d302010-10-07 20:07:18 -0700496 in_write_callback_ = false;
Gilad Arnold48085ba2011-11-16 09:36:08 -0800497 return payload_size;
rspangler@google.com49fdf182009-10-10 00:57:34 +0000498}
499
500void LibcurlHttpFetcher::Pause() {
Alex Deymof2858572016-02-25 11:20:13 -0800501 if (transfer_paused_) {
502 LOG(ERROR) << "Fetcher already paused.";
503 return;
504 }
505 transfer_paused_ = true;
506 if (!transfer_in_progress_) {
507 // If pause before we started a connection, we don't need to notify curl
508 // about that, we will simply not start the connection later.
509 return;
510 }
rspangler@google.com49fdf182009-10-10 00:57:34 +0000511 CHECK(curl_handle_);
adlr@google.comc98a7ed2009-12-04 18:54:03 +0000512 CHECK_EQ(curl_easy_pause(curl_handle_, CURLPAUSE_ALL), CURLE_OK);
rspangler@google.com49fdf182009-10-10 00:57:34 +0000513}
514
515void LibcurlHttpFetcher::Unpause() {
Alex Deymof2858572016-02-25 11:20:13 -0800516 if (!transfer_paused_) {
517 LOG(ERROR) << "Resume attempted when fetcher not paused.";
518 return;
519 }
520 transfer_paused_ = false;
521 if (restart_transfer_on_unpause_) {
522 restart_transfer_on_unpause_ = false;
523 ResumeTransfer(url_);
524 CurlPerformOnce();
525 return;
526 }
527 if (!transfer_in_progress_) {
528 // If resumed before starting the connection, there's no need to notify
529 // anybody. We will simply start the connection once it is time.
530 return;
531 }
rspangler@google.com49fdf182009-10-10 00:57:34 +0000532 CHECK(curl_handle_);
adlr@google.comc98a7ed2009-12-04 18:54:03 +0000533 CHECK_EQ(curl_easy_pause(curl_handle_, CURLPAUSE_CONT), CURLE_OK);
Alex Deymof2858572016-02-25 11:20:13 -0800534 // Since the transfer is in progress, we need to dispatch a CurlPerformOnce()
535 // now to let the connection continue, otherwise it would be called by the
536 // TimeoutCallback but with a delay.
537 CurlPerformOnce();
rspangler@google.com49fdf182009-10-10 00:57:34 +0000538}
539
Alex Deymo29b81532015-07-09 11:51:49 -0700540// This method sets up callbacks with the MessageLoop.
541void LibcurlHttpFetcher::SetupMessageLoopSources() {
rspangler@google.com49fdf182009-10-10 00:57:34 +0000542 fd_set fd_read;
543 fd_set fd_write;
Darin Petkov60e14152010-10-27 16:57:04 -0700544 fd_set fd_exc;
rspangler@google.com49fdf182009-10-10 00:57:34 +0000545
546 FD_ZERO(&fd_read);
547 FD_ZERO(&fd_write);
Darin Petkov60e14152010-10-27 16:57:04 -0700548 FD_ZERO(&fd_exc);
rspangler@google.com49fdf182009-10-10 00:57:34 +0000549
550 int fd_max = 0;
551
552 // Ask libcurl for the set of file descriptors we should track on its
553 // behalf.
adlr@google.comc98a7ed2009-12-04 18:54:03 +0000554 CHECK_EQ(curl_multi_fdset(curl_multi_handle_, &fd_read, &fd_write,
Darin Petkov60e14152010-10-27 16:57:04 -0700555 &fd_exc, &fd_max), CURLM_OK);
rspangler@google.com49fdf182009-10-10 00:57:34 +0000556
557 // We should iterate through all file descriptors up to libcurl's fd_max or
Darin Petkov60e14152010-10-27 16:57:04 -0700558 // the highest one we're tracking, whichever is larger.
Alex Deymo29b81532015-07-09 11:51:49 -0700559 for (size_t t = 0; t < arraysize(fd_task_maps_); ++t) {
560 if (!fd_task_maps_[t].empty())
561 fd_max = max(fd_max, fd_task_maps_[t].rbegin()->first);
Darin Petkov60e14152010-10-27 16:57:04 -0700562 }
rspangler@google.com49fdf182009-10-10 00:57:34 +0000563
Darin Petkov60e14152010-10-27 16:57:04 -0700564 // For each fd, if we're not tracking it, track it. If we are tracking it, but
565 // libcurl doesn't care about it anymore, stop tracking it. After this loop,
Alex Deymo29b81532015-07-09 11:51:49 -0700566 // there should be exactly as many tasks scheduled in fd_task_maps_[0|1] as
Darin Petkov60e14152010-10-27 16:57:04 -0700567 // there are read/write fds that we're tracking.
568 for (int fd = 0; fd <= fd_max; ++fd) {
569 // Note that fd_exc is unused in the current version of libcurl so is_exc
570 // should always be false.
571 bool is_exc = FD_ISSET(fd, &fd_exc) != 0;
572 bool must_track[2] = {
573 is_exc || (FD_ISSET(fd, &fd_read) != 0), // track 0 -- read
574 is_exc || (FD_ISSET(fd, &fd_write) != 0) // track 1 -- write
575 };
Alex Deymo29b81532015-07-09 11:51:49 -0700576 MessageLoop::WatchMode watch_modes[2] = {
577 MessageLoop::WatchMode::kWatchRead,
578 MessageLoop::WatchMode::kWatchWrite,
579 };
Darin Petkov60e14152010-10-27 16:57:04 -0700580
Alex Deymo29b81532015-07-09 11:51:49 -0700581 for (size_t t = 0; t < arraysize(fd_task_maps_); ++t) {
582 auto fd_task_it = fd_task_maps_[t].find(fd);
583 bool tracked = fd_task_it != fd_task_maps_[t].end();
Darin Petkov60e14152010-10-27 16:57:04 -0700584
585 if (!must_track[t]) {
586 // If we have an outstanding io_channel, remove it.
587 if (tracked) {
Alex Deymo29b81532015-07-09 11:51:49 -0700588 MessageLoop::current()->CancelTask(fd_task_it->second);
589 fd_task_maps_[t].erase(fd_task_it);
Darin Petkov60e14152010-10-27 16:57:04 -0700590 }
591 continue;
rspangler@google.com49fdf182009-10-10 00:57:34 +0000592 }
Darin Petkov60e14152010-10-27 16:57:04 -0700593
594 // If we are already tracking this fd, continue -- nothing to do.
595 if (tracked)
596 continue;
597
Darin Petkov60e14152010-10-27 16:57:04 -0700598 // Track a new fd.
Alex Deymo29b81532015-07-09 11:51:49 -0700599 fd_task_maps_[t][fd] = MessageLoop::current()->WatchFileDescriptor(
600 FROM_HERE,
601 fd,
602 watch_modes[t],
603 true, // persistent
604 base::Bind(&LibcurlHttpFetcher::CurlPerformOnce,
605 base::Unretained(this)));
Darin Petkov60e14152010-10-27 16:57:04 -0700606
Darin Petkov60e14152010-10-27 16:57:04 -0700607 static int io_counter = 0;
608 io_counter++;
609 if (io_counter % 50 == 0) {
610 LOG(INFO) << "io_counter = " << io_counter;
611 }
Andrew de los Reyes3270f742010-07-15 22:28:14 -0700612 }
rspangler@google.com49fdf182009-10-10 00:57:34 +0000613 }
614
Darin Petkovb83371f2010-08-17 09:34:49 -0700615 // Set up a timeout callback for libcurl.
Alex Deymo60ca1a72015-06-18 18:19:15 -0700616 if (timeout_id_ == MessageLoop::kTaskIdNull) {
Alex Deymof2858572016-02-25 11:20:13 -0800617 VLOG(1) << "Setting up timeout source: " << idle_seconds_ << " seconds.";
Alex Deymo60ca1a72015-06-18 18:19:15 -0700618 timeout_id_ = MessageLoop::current()->PostDelayedTask(
619 FROM_HERE,
620 base::Bind(&LibcurlHttpFetcher::TimeoutCallback,
621 base::Unretained(this)),
622 TimeDelta::FromSeconds(idle_seconds_));
rspangler@google.com49fdf182009-10-10 00:57:34 +0000623 }
rspangler@google.com49fdf182009-10-10 00:57:34 +0000624}
625
Alex Deymo60ca1a72015-06-18 18:19:15 -0700626void LibcurlHttpFetcher::RetryTimeoutCallback() {
Alex Deymob20de692017-02-05 07:47:37 +0000627 retry_task_id_ = MessageLoop::kTaskIdNull;
Alex Deymof2858572016-02-25 11:20:13 -0800628 if (transfer_paused_) {
629 restart_transfer_on_unpause_ = true;
630 return;
631 }
Andrew de los Reyes9bbd1872010-07-16 14:52:29 -0700632 ResumeTransfer(url_);
633 CurlPerformOnce();
Andrew de los Reyes9bbd1872010-07-16 14:52:29 -0700634}
635
Alex Deymo60ca1a72015-06-18 18:19:15 -0700636void LibcurlHttpFetcher::TimeoutCallback() {
Alex Deymo60ca1a72015-06-18 18:19:15 -0700637 // We always re-schedule the callback, even if we don't want to be called
638 // anymore. We will remove the event source separately if we don't want to
Andrew de los Reyescb319332010-07-19 10:55:01 -0700639 // be called back.
Alex Deymo60ca1a72015-06-18 18:19:15 -0700640 timeout_id_ = MessageLoop::current()->PostDelayedTask(
641 FROM_HERE,
642 base::Bind(&LibcurlHttpFetcher::TimeoutCallback, base::Unretained(this)),
643 TimeDelta::FromSeconds(idle_seconds_));
Alex Deymof123ae22015-09-24 14:59:43 -0700644
645 // CurlPerformOnce() may call CleanUp(), so we need to schedule our callback
646 // first, since it could be canceled by this call.
647 if (transfer_in_progress_)
648 CurlPerformOnce();
rspangler@google.com49fdf182009-10-10 00:57:34 +0000649}
650
651void LibcurlHttpFetcher::CleanUp() {
Alex Deymob20de692017-02-05 07:47:37 +0000652 MessageLoop::current()->CancelTask(retry_task_id_);
653 retry_task_id_ = MessageLoop::kTaskIdNull;
654
Alex Deymo60ca1a72015-06-18 18:19:15 -0700655 MessageLoop::current()->CancelTask(timeout_id_);
656 timeout_id_ = MessageLoop::kTaskIdNull;
rspangler@google.com49fdf182009-10-10 00:57:34 +0000657
Alex Deymo29b81532015-07-09 11:51:49 -0700658 for (size_t t = 0; t < arraysize(fd_task_maps_); ++t) {
659 for (const auto& fd_taks_pair : fd_task_maps_[t]) {
660 if (!MessageLoop::current()->CancelTask(fd_taks_pair.second)) {
661 LOG(WARNING) << "Error canceling the watch task "
662 << fd_taks_pair.second << " for "
663 << (t ? "writing" : "reading") << " the fd "
664 << fd_taks_pair.first;
665 }
Darin Petkov60e14152010-10-27 16:57:04 -0700666 }
Alex Deymo29b81532015-07-09 11:51:49 -0700667 fd_task_maps_[t].clear();
rspangler@google.com49fdf182009-10-10 00:57:34 +0000668 }
rspangler@google.com49fdf182009-10-10 00:57:34 +0000669
Gilad Arnold9dd1e7c2012-02-16 12:13:36 -0800670 if (curl_http_headers_) {
671 curl_slist_free_all(curl_http_headers_);
Alex Vakulenko88b591f2014-08-28 16:48:57 -0700672 curl_http_headers_ = nullptr;
Gilad Arnold9dd1e7c2012-02-16 12:13:36 -0800673 }
rspangler@google.com49fdf182009-10-10 00:57:34 +0000674 if (curl_handle_) {
675 if (curl_multi_handle_) {
adlr@google.comc98a7ed2009-12-04 18:54:03 +0000676 CHECK_EQ(curl_multi_remove_handle(curl_multi_handle_, curl_handle_),
677 CURLM_OK);
rspangler@google.com49fdf182009-10-10 00:57:34 +0000678 }
679 curl_easy_cleanup(curl_handle_);
Alex Vakulenko88b591f2014-08-28 16:48:57 -0700680 curl_handle_ = nullptr;
rspangler@google.com49fdf182009-10-10 00:57:34 +0000681 }
682 if (curl_multi_handle_) {
adlr@google.comc98a7ed2009-12-04 18:54:03 +0000683 CHECK_EQ(curl_multi_cleanup(curl_multi_handle_), CURLM_OK);
Alex Vakulenko88b591f2014-08-28 16:48:57 -0700684 curl_multi_handle_ = nullptr;
rspangler@google.com49fdf182009-10-10 00:57:34 +0000685 }
686 transfer_in_progress_ = false;
Alex Deymof2858572016-02-25 11:20:13 -0800687 transfer_paused_ = false;
688 restart_transfer_on_unpause_ = false;
rspangler@google.com49fdf182009-10-10 00:57:34 +0000689}
690
Andrew de los Reyes3fd5d302010-10-07 20:07:18 -0700691void LibcurlHttpFetcher::GetHttpResponseCode() {
Alex Vakulenkod2779df2014-06-16 13:19:00 -0700692 long http_response_code = 0; // NOLINT(runtime/int) - curl needs long.
Alex Deymo56ccb072016-02-05 00:50:48 -0800693 if (base::StartsWith(url_, "file://", base::CompareCase::INSENSITIVE_ASCII)) {
694 // Fake out a valid response code for file:// URLs.
695 http_response_code_ = 299;
696 } else if (curl_easy_getinfo(curl_handle_,
697 CURLINFO_RESPONSE_CODE,
698 &http_response_code) == CURLE_OK) {
Andrew de los Reyes3fd5d302010-10-07 20:07:18 -0700699 http_response_code_ = static_cast<int>(http_response_code);
700 }
701}
702
rspangler@google.com49fdf182009-10-10 00:57:34 +0000703} // namespace chromeos_update_engine