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