rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 1 | // Copyright (c) 2009 The Chromium OS Authors. All rights reserved. |
| 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
adlr@google.com | c98a7ed | 2009-12-04 18:54:03 +0000 | [diff] [blame] | 5 | #ifndef CHROMEOS_PLATFORM_UPDATE_ENGINE_LIBCURL_HTTP_FETCHER_H__ |
| 6 | #define CHROMEOS_PLATFORM_UPDATE_ENGINE_LIBCURL_HTTP_FETCHER_H__ |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 7 | |
| 8 | #include <map> |
| 9 | #include <string> |
Bruno Rocha | 7f9aea2 | 2011-09-12 14:31:24 -0700 | [diff] [blame] | 10 | |
| 11 | #include <base/basictypes.h> |
| 12 | #include <base/logging.h> |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 13 | #include <curl/curl.h> |
| 14 | #include <glib.h> |
Bruno Rocha | 7f9aea2 | 2011-09-12 14:31:24 -0700 | [diff] [blame] | 15 | |
| 16 | #include "update_engine/certificate_checker.h" |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 17 | #include "update_engine/http_fetcher.h" |
| 18 | |
| 19 | // This is a concrete implementation of HttpFetcher that uses libcurl to do the |
| 20 | // http work. |
| 21 | |
| 22 | namespace chromeos_update_engine { |
| 23 | |
| 24 | class LibcurlHttpFetcher : public HttpFetcher { |
| 25 | public: |
Darin Petkov | 41c2fcf | 2010-08-25 13:14:48 -0700 | [diff] [blame] | 26 | static const int kMaxRedirects = 10; |
Jay Srinivasan | 32f2357 | 2012-06-05 13:45:07 -0700 | [diff] [blame^] | 27 | static const int kMaxRetryCountOobeComplete = 20; |
| 28 | static const int kMaxRetryCountOobeNotComplete = 3; |
Darin Petkov | 41c2fcf | 2010-08-25 13:14:48 -0700 | [diff] [blame] | 29 | |
Andrew de los Reyes | 4516810 | 2010-11-22 11:13:50 -0800 | [diff] [blame] | 30 | explicit LibcurlHttpFetcher(ProxyResolver* proxy_resolver) |
| 31 | : HttpFetcher(proxy_resolver), |
| 32 | curl_multi_handle_(NULL), |
Darin Petkov | b83371f | 2010-08-17 09:34:49 -0700 | [diff] [blame] | 33 | curl_handle_(NULL), |
Gilad Arnold | 9dd1e7c | 2012-02-16 12:13:36 -0800 | [diff] [blame] | 34 | curl_http_headers_(NULL), |
Darin Petkov | b83371f | 2010-08-17 09:34:49 -0700 | [diff] [blame] | 35 | timeout_source_(NULL), |
| 36 | transfer_in_progress_(false), |
Andrew de los Reyes | 3fd5d30 | 2010-10-07 20:07:18 -0700 | [diff] [blame] | 37 | transfer_size_(0), |
| 38 | bytes_downloaded_(0), |
Gilad Arnold | e4ad250 | 2011-12-29 17:08:54 -0800 | [diff] [blame] | 39 | download_length_(0), |
Andrew de los Reyes | 3fd5d30 | 2010-10-07 20:07:18 -0700 | [diff] [blame] | 40 | resume_offset_(0), |
Darin Petkov | b83371f | 2010-08-17 09:34:49 -0700 | [diff] [blame] | 41 | retry_count_(0), |
Jay Srinivasan | 32f2357 | 2012-06-05 13:45:07 -0700 | [diff] [blame^] | 42 | max_retry_count_(kMaxRetryCountOobeNotComplete), |
Gilad Arnold | 34bf1ee | 2012-02-09 16:16:02 -0800 | [diff] [blame] | 43 | retry_seconds_(20), |
Darin Petkov | a092955 | 2010-11-29 14:19:06 -0800 | [diff] [blame] | 44 | no_network_retry_count_(0), |
| 45 | no_network_max_retries_(0), |
Andrew de los Reyes | 3fd5d30 | 2010-10-07 20:07:18 -0700 | [diff] [blame] | 46 | idle_seconds_(1), |
Andrew de los Reyes | d57d147 | 2010-10-21 13:34:08 -0700 | [diff] [blame] | 47 | force_connection_type_(false), |
| 48 | forced_expensive_connection_(false), |
Darin Petkov | fc7a0ce | 2010-10-25 10:38:37 -0700 | [diff] [blame] | 49 | force_build_type_(false), |
| 50 | forced_official_build_(false), |
Andrew de los Reyes | 3fd5d30 | 2010-10-07 20:07:18 -0700 | [diff] [blame] | 51 | in_write_callback_(false), |
Andrew de los Reyes | 4516810 | 2010-11-22 11:13:50 -0800 | [diff] [blame] | 52 | sent_byte_(false), |
Bruno Rocha | 7f9aea2 | 2011-09-12 14:31:24 -0700 | [diff] [blame] | 53 | terminate_requested_(false), |
| 54 | check_certificate_(CertificateChecker::kNone) {} |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 55 | |
| 56 | // Cleans up all internal state. Does not notify delegate |
| 57 | ~LibcurlHttpFetcher(); |
| 58 | |
Gilad Arnold | e4ad250 | 2011-12-29 17:08:54 -0800 | [diff] [blame] | 59 | virtual void SetOffset(off_t offset) { bytes_downloaded_ = offset; } |
| 60 | |
| 61 | virtual void SetLength(size_t length) { download_length_ = length; } |
| 62 | virtual void UnsetLength() { SetLength(0); } |
Andrew de los Reyes | 3fd5d30 | 2010-10-07 20:07:18 -0700 | [diff] [blame] | 63 | |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 64 | // Begins the transfer if it hasn't already begun. |
| 65 | virtual void BeginTransfer(const std::string& url); |
| 66 | |
Darin Petkov | 9ce452b | 2010-11-17 14:33:28 -0800 | [diff] [blame] | 67 | // If the transfer is in progress, aborts the transfer early. The transfer |
| 68 | // cannot be resumed. |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 69 | virtual void TerminateTransfer(); |
| 70 | |
| 71 | // Suspend the transfer by calling curl_easy_pause(CURLPAUSE_ALL). |
| 72 | virtual void Pause(); |
| 73 | |
| 74 | // Resume the transfer by calling curl_easy_pause(CURLPAUSE_CONT). |
| 75 | virtual void Unpause(); |
| 76 | |
| 77 | // Libcurl sometimes asks to be called back after some time while |
| 78 | // leaving that time unspecified. In that case, we pick a reasonable |
| 79 | // default of one second, but it can be overridden here. This is |
| 80 | // primarily useful for testing. |
| 81 | // From http://curl.haxx.se/libcurl/c/curl_multi_timeout.html: |
| 82 | // if libcurl returns a -1 timeout here, it just means that libcurl |
| 83 | // currently has no stored timeout value. You must not wait too long |
| 84 | // (more than a few seconds perhaps) before you call |
| 85 | // curl_multi_perform() again. |
Darin Petkov | b83371f | 2010-08-17 09:34:49 -0700 | [diff] [blame] | 86 | void set_idle_seconds(int seconds) { idle_seconds_ = seconds; } |
| 87 | |
| 88 | // Sets the retry timeout. Useful for testing. |
| 89 | void set_retry_seconds(int seconds) { retry_seconds_ = seconds; } |
Darin Petkov | fc7a0ce | 2010-10-25 10:38:37 -0700 | [diff] [blame] | 90 | |
Darin Petkov | a092955 | 2010-11-29 14:19:06 -0800 | [diff] [blame] | 91 | void set_no_network_max_retries(int retries) { |
| 92 | no_network_max_retries_ = retries; |
| 93 | } |
| 94 | |
Andrew de los Reyes | d57d147 | 2010-10-21 13:34:08 -0700 | [diff] [blame] | 95 | void SetConnectionAsExpensive(bool is_expensive) { |
| 96 | force_connection_type_ = true; |
| 97 | forced_expensive_connection_ = is_expensive; |
| 98 | } |
Darin Petkov | b83371f | 2010-08-17 09:34:49 -0700 | [diff] [blame] | 99 | |
Darin Petkov | fc7a0ce | 2010-10-25 10:38:37 -0700 | [diff] [blame] | 100 | void SetBuildType(bool is_official) { |
| 101 | force_build_type_ = true; |
| 102 | forced_official_build_ = is_official; |
| 103 | } |
| 104 | |
Bruno Rocha | 7f9aea2 | 2011-09-12 14:31:24 -0700 | [diff] [blame] | 105 | void set_check_certificate( |
| 106 | CertificateChecker::ServerToCheck check_certificate) { |
| 107 | check_certificate_ = check_certificate; |
| 108 | } |
| 109 | |
Gilad Arnold | 48085ba | 2011-11-16 09:36:08 -0800 | [diff] [blame] | 110 | virtual size_t GetBytesDownloaded() { |
| 111 | return static_cast<size_t>(bytes_downloaded_); |
| 112 | } |
| 113 | |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 114 | private: |
Andrew de los Reyes | f3ed8e7 | 2011-02-16 10:35:46 -0800 | [diff] [blame] | 115 | // Callback for when proxy resolution has completed. This begins the |
| 116 | // transfer. |
| 117 | void ProxiesResolved(); |
| 118 | |
Andrew de los Reyes | 3fd5d30 | 2010-10-07 20:07:18 -0700 | [diff] [blame] | 119 | // Asks libcurl for the http response code and stores it in the object. |
| 120 | void GetHttpResponseCode(); |
| 121 | |
Gilad Arnold | 9bedeb5 | 2011-11-17 16:19:57 -0800 | [diff] [blame] | 122 | // Checks whether stored HTTP response is within the success range. |
Gilad Arnold | 48085ba | 2011-11-16 09:36:08 -0800 | [diff] [blame] | 123 | inline bool IsHttpResponseSuccess() { |
| 124 | return (http_response_code_ >= 200 && http_response_code_ < 300); |
| 125 | } |
| 126 | |
Gilad Arnold | 9bedeb5 | 2011-11-17 16:19:57 -0800 | [diff] [blame] | 127 | // Checks whether stored HTTP response is within the error range. This |
| 128 | // includes both errors with the request (4xx) and server errors (5xx). |
| 129 | inline bool IsHttpResponseError() { |
| 130 | return (http_response_code_ >= 400 && http_response_code_ < 600); |
| 131 | } |
| 132 | |
adlr@google.com | c98a7ed | 2009-12-04 18:54:03 +0000 | [diff] [blame] | 133 | // Resumes a transfer where it left off. This will use the |
| 134 | // HTTP Range: header to make a new connection from where the last |
| 135 | // left off. |
| 136 | virtual void ResumeTransfer(const std::string& url); |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 137 | |
| 138 | // These two methods are for glib main loop callbacks. They are called |
| 139 | // when either a file descriptor is ready for work or when a timer |
| 140 | // has fired. The static versions are shims for libcurl which has a C API. |
| 141 | bool FDCallback(GIOChannel *source, GIOCondition condition); |
| 142 | static gboolean StaticFDCallback(GIOChannel *source, |
| 143 | GIOCondition condition, |
| 144 | gpointer data) { |
| 145 | return reinterpret_cast<LibcurlHttpFetcher*>(data)->FDCallback(source, |
| 146 | condition); |
| 147 | } |
Andrew de los Reyes | 3270f74 | 2010-07-15 22:28:14 -0700 | [diff] [blame] | 148 | gboolean TimeoutCallback(); |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 149 | static gboolean StaticTimeoutCallback(gpointer data) { |
| 150 | return reinterpret_cast<LibcurlHttpFetcher*>(data)->TimeoutCallback(); |
| 151 | } |
Darin Petkov | b83371f | 2010-08-17 09:34:49 -0700 | [diff] [blame] | 152 | |
Andrew de los Reyes | 9bbd187 | 2010-07-16 14:52:29 -0700 | [diff] [blame] | 153 | gboolean RetryTimeoutCallback(); |
| 154 | static gboolean StaticRetryTimeoutCallback(void* arg) { |
| 155 | return static_cast<LibcurlHttpFetcher*>(arg)->RetryTimeoutCallback(); |
| 156 | } |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 157 | |
| 158 | // Calls into curl_multi_perform to let libcurl do its work. Returns after |
| 159 | // curl_multi_perform is finished, which may actually be after more than |
| 160 | // one call to curl_multi_perform. This method will set up the glib run |
| 161 | // loop with sources for future work that libcurl will do. |
| 162 | // This method will not block. |
Andrew de los Reyes | 3270f74 | 2010-07-15 22:28:14 -0700 | [diff] [blame] | 163 | // Returns true if we should resume immediately after this call. |
Andrew de los Reyes | cb31933 | 2010-07-19 10:55:01 -0700 | [diff] [blame] | 164 | void CurlPerformOnce(); |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 165 | |
| 166 | // Sets up glib main loop sources as needed by libcurl. This is generally |
| 167 | // the file descriptor of the socket and a timer in case nothing happens |
| 168 | // on the fds. |
| 169 | void SetupMainloopSources(); |
| 170 | |
| 171 | // Callback called by libcurl when new data has arrived on the transfer |
| 172 | size_t LibcurlWrite(void *ptr, size_t size, size_t nmemb); |
| 173 | static size_t StaticLibcurlWrite(void *ptr, size_t size, |
| 174 | size_t nmemb, void *stream) { |
| 175 | return reinterpret_cast<LibcurlHttpFetcher*>(stream)-> |
| 176 | LibcurlWrite(ptr, size, nmemb); |
| 177 | } |
| 178 | |
| 179 | // Cleans up the following if they are non-null: |
| 180 | // curl(m) handles, io_channels_, timeout_source_. |
| 181 | void CleanUp(); |
| 182 | |
Darin Petkov | 9ce452b | 2010-11-17 14:33:28 -0800 | [diff] [blame] | 183 | // Force terminate the transfer. This will invoke the delegate's (if any) |
| 184 | // TransferTerminated callback so, after returning, this fetcher instance may |
| 185 | // be destroyed. |
| 186 | void ForceTransferTermination(); |
| 187 | |
Andrew de los Reyes | d57d147 | 2010-10-21 13:34:08 -0700 | [diff] [blame] | 188 | // Returns whether or not the current network connection is considered |
| 189 | // expensive. |
| 190 | bool ConnectionIsExpensive() const; |
| 191 | |
Darin Petkov | fc7a0ce | 2010-10-25 10:38:37 -0700 | [diff] [blame] | 192 | // Returns whether or not the current build is official. |
| 193 | bool IsOfficialBuild() const; |
| 194 | |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 195 | // Handles for the libcurl library |
| 196 | CURLM *curl_multi_handle_; |
| 197 | CURL *curl_handle_; |
Gilad Arnold | 9dd1e7c | 2012-02-16 12:13:36 -0800 | [diff] [blame] | 198 | struct curl_slist *curl_http_headers_; |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 199 | |
Darin Petkov | 60e1415 | 2010-10-27 16:57:04 -0700 | [diff] [blame] | 200 | // Lists of all read(0)/write(1) file descriptors that we're waiting on from |
| 201 | // the glib main loop. libcurl may open/close descriptors and switch their |
| 202 | // directions so maintain two separate lists so that watch conditions can be |
| 203 | // set appropriately. |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 204 | typedef std::map<int, std::pair<GIOChannel*, guint> > IOChannels; |
Darin Petkov | 60e1415 | 2010-10-27 16:57:04 -0700 | [diff] [blame] | 205 | IOChannels io_channels_[2]; |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 206 | |
| 207 | // if non-NULL, a timer we're waiting on. glib main loop will call us back |
| 208 | // when it fires. |
| 209 | GSource* timeout_source_; |
| 210 | |
| 211 | bool transfer_in_progress_; |
| 212 | |
adlr@google.com | c98a7ed | 2009-12-04 18:54:03 +0000 | [diff] [blame] | 213 | // The transfer size. -1 if not known. |
| 214 | off_t transfer_size_; |
| 215 | |
| 216 | // How many bytes have been downloaded and sent to the delegate. |
| 217 | off_t bytes_downloaded_; |
| 218 | |
Gilad Arnold | e4ad250 | 2011-12-29 17:08:54 -0800 | [diff] [blame] | 219 | // The remaining maximum number of bytes to download. Zero represents an |
| 220 | // unspecified length. |
| 221 | size_t download_length_; |
| 222 | |
adlr@google.com | c98a7ed | 2009-12-04 18:54:03 +0000 | [diff] [blame] | 223 | // If we resumed an earlier transfer, data offset that we used for the |
| 224 | // new connection. 0 otherwise. |
Andrew de los Reyes | 3fd5d30 | 2010-10-07 20:07:18 -0700 | [diff] [blame] | 225 | // In this class, resume refers to resuming a dropped HTTP connection, |
| 226 | // not to resuming an interrupted download. |
adlr@google.com | c98a7ed | 2009-12-04 18:54:03 +0000 | [diff] [blame] | 227 | off_t resume_offset_; |
Darin Petkov | b83371f | 2010-08-17 09:34:49 -0700 | [diff] [blame] | 228 | |
Jay Srinivasan | 32f2357 | 2012-06-05 13:45:07 -0700 | [diff] [blame^] | 229 | // Number of resumes performed so far and the max allowed. |
Andrew de los Reyes | 9bbd187 | 2010-07-16 14:52:29 -0700 | [diff] [blame] | 230 | int retry_count_; |
Jay Srinivasan | 32f2357 | 2012-06-05 13:45:07 -0700 | [diff] [blame^] | 231 | int max_retry_count_; |
adlr@google.com | c98a7ed | 2009-12-04 18:54:03 +0000 | [diff] [blame] | 232 | |
Darin Petkov | b83371f | 2010-08-17 09:34:49 -0700 | [diff] [blame] | 233 | // Seconds to wait before retrying a resume. |
| 234 | int retry_seconds_; |
| 235 | |
Darin Petkov | a092955 | 2010-11-29 14:19:06 -0800 | [diff] [blame] | 236 | // Number of resumes due to no network (e.g., HTTP response code 0). |
| 237 | int no_network_retry_count_; |
| 238 | int no_network_max_retries_; |
| 239 | |
Darin Petkov | b83371f | 2010-08-17 09:34:49 -0700 | [diff] [blame] | 240 | // Seconds to wait before asking libcurl to "perform". |
| 241 | int idle_seconds_; |
Darin Petkov | fc7a0ce | 2010-10-25 10:38:37 -0700 | [diff] [blame] | 242 | |
Andrew de los Reyes | d57d147 | 2010-10-21 13:34:08 -0700 | [diff] [blame] | 243 | // If true, assume the network is expensive or not, according to |
| 244 | // forced_expensive_connection_. (Useful for testing). |
| 245 | bool force_connection_type_; |
| 246 | bool forced_expensive_connection_; |
Darin Petkov | b83371f | 2010-08-17 09:34:49 -0700 | [diff] [blame] | 247 | |
Darin Petkov | fc7a0ce | 2010-10-25 10:38:37 -0700 | [diff] [blame] | 248 | // If true, assume the build is official or not, according to |
| 249 | // forced_official_build_. Useful for testing. |
| 250 | bool force_build_type_; |
| 251 | bool forced_official_build_; |
| 252 | |
Andrew de los Reyes | 3fd5d30 | 2010-10-07 20:07:18 -0700 | [diff] [blame] | 253 | // If true, we are currently performing a write callback on the delegate. |
| 254 | bool in_write_callback_; |
Darin Petkov | a092955 | 2010-11-29 14:19:06 -0800 | [diff] [blame] | 255 | |
Andrew de los Reyes | 4516810 | 2010-11-22 11:13:50 -0800 | [diff] [blame] | 256 | // If true, we have returned at least one byte in the write callback |
| 257 | // to the delegate. |
| 258 | bool sent_byte_; |
Darin Petkov | fc7a0ce | 2010-10-25 10:38:37 -0700 | [diff] [blame] | 259 | |
Andrew de los Reyes | 3fd5d30 | 2010-10-07 20:07:18 -0700 | [diff] [blame] | 260 | // We can't clean everything up while we're in a write callback, so |
| 261 | // if we get a terminate request, queue it until we can handle it. |
| 262 | bool terminate_requested_; |
| 263 | |
Bruno Rocha | 7f9aea2 | 2011-09-12 14:31:24 -0700 | [diff] [blame] | 264 | // Represents which server certificate to be checked against this |
| 265 | // connection's certificate. If no certificate check needs to be performed, |
| 266 | // this should be kNone. |
| 267 | CertificateChecker::ServerToCheck check_certificate_; |
| 268 | |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 269 | DISALLOW_COPY_AND_ASSIGN(LibcurlHttpFetcher); |
| 270 | }; |
| 271 | |
| 272 | } // namespace chromeos_update_engine |
| 273 | |
adlr@google.com | c98a7ed | 2009-12-04 18:54:03 +0000 | [diff] [blame] | 274 | #endif // CHROMEOS_PLATFORM_UPDATE_ENGINE_LIBCURL_HTTP_FETCHER_H__ |