2 // Copyright (C) 2007 Christoph Sommer <christoph.sommer@2007.expires.deltadevelopment.de>
3 // 2014 Ingo Ruhnke <grumbel@gmail.com>
5 // This program is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
10 // This program is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 // GNU General Public License for more details.
15 // You should have received a copy of the GNU General Public License
16 // along with this program. If not, see <http://www.gnu.org/licenses/>.
18 #include "addon/downloader.hpp"
27 #include "util/log.hpp"
32 size_t my_curl_string_append(void* ptr, size_t size, size_t nmemb, void* userdata)
34 std::string& s = *static_cast<std::string*>(userdata);
35 std::string buf(static_cast<char*>(ptr), size * nmemb);
37 log_debug << "read " << size * nmemb << " bytes of data..." << std::endl;
41 size_t my_curl_physfs_write(void* ptr, size_t size, size_t nmemb, void* userdata)
43 PHYSFS_file* f = static_cast<PHYSFS_file*>(userdata);
44 PHYSFS_sint64 written = PHYSFS_write(f, ptr, size, nmemb);
45 log_debug << "read " << size * nmemb << " bytes of data..." << std::endl;
46 return size * written;
52 TransferStatus::abort()
54 m_downloader.abort(id);
58 TransferStatus::update()
60 m_downloader.update();
66 Downloader& m_downloader;
71 std::array<char, CURL_ERROR_SIZE> m_error_buffer;
73 TransferStatusPtr m_status;
74 std::unique_ptr<PHYSFS_file, int(*)(PHYSFS_File*)> m_fout;
77 Transfer(Downloader& downloader, TransferId id,
78 const std::string& url,
79 const std::string& outfile) :
80 m_downloader(downloader),
84 m_error_buffer({'\0'}),
85 m_status(new TransferStatus(downloader, id)),
86 m_fout(PHYSFS_openWrite(outfile.c_str()), PHYSFS_close)
90 std::ostringstream out;
91 out << "PHYSFS_openRead() failed: " << PHYSFS_getLastError();
92 throw std::runtime_error(out.str());
95 m_handle = curl_easy_init();
98 throw std::runtime_error("curl_easy_init() failed");
102 curl_easy_setopt(m_handle, CURLOPT_URL, url.c_str());
103 curl_easy_setopt(m_handle, CURLOPT_USERAGENT, "SuperTux/" PACKAGE_VERSION " libcURL");
105 curl_easy_setopt(m_handle, CURLOPT_WRITEDATA, this);
106 curl_easy_setopt(m_handle, CURLOPT_WRITEFUNCTION, &Transfer::on_data_wrap);
108 curl_easy_setopt(m_handle, CURLOPT_ERRORBUFFER, m_error_buffer.data());
109 curl_easy_setopt(m_handle, CURLOPT_NOSIGNAL, 1);
110 curl_easy_setopt(m_handle, CURLOPT_FAILONERROR, 1);
111 curl_easy_setopt(m_handle, CURLOPT_FOLLOWLOCATION, 1);
113 curl_easy_setopt(m_handle, CURLOPT_NOPROGRESS, 0);
114 curl_easy_setopt(m_handle, CURLOPT_XFERINFODATA, this);
115 curl_easy_setopt(m_handle, CURLOPT_XFERINFOFUNCTION, &Transfer::on_progress_wrap);
121 curl_easy_cleanup(m_handle);
124 TransferStatusPtr get_status() const
129 const char* get_error_buffer() const
131 return m_error_buffer.data();
134 TransferId get_id() const
139 CURL* get_curl_handle() const
144 std::string get_url() const
149 size_t on_data(void* ptr, size_t size, size_t nmemb)
151 PHYSFS_write(m_fout.get(), ptr, size, nmemb);
155 void on_progress(curl_off_t dltotal, curl_off_t dlnow,
156 curl_off_t ultotal, curl_off_t ulnow)
158 m_status->dltotal = dltotal;
159 m_status->dlnow = dlnow;
161 m_status->ultotal = ultotal;
162 m_status->ulnow = ulnow;
166 static size_t on_data_wrap(char* ptr, size_t size, size_t nmemb, void* userdata)
168 return static_cast<Transfer*>(userdata)->on_data(ptr, size, nmemb);
171 static void on_progress_wrap(void* userdata,
172 curl_off_t dltotal, curl_off_t dlnow,
173 curl_off_t ultotal, curl_off_t ulnow)
175 return static_cast<Transfer*>(userdata)->on_progress(dltotal, dlnow, ultotal, ulnow);
179 Transfer(const Transfer&) = delete;
180 Transfer& operator=(const Transfer&) = delete;
183 Downloader::Downloader() :
186 m_next_transfer_id(1)
188 curl_global_init(CURL_GLOBAL_ALL);
189 m_multi_handle = curl_multi_init();
192 throw std::runtime_error("curl_multi_init() failed");
196 Downloader::~Downloader()
198 for(auto& transfer : m_transfers)
200 curl_multi_remove_handle(m_multi_handle, transfer->get_curl_handle());
204 curl_multi_cleanup(m_multi_handle);
205 curl_global_cleanup();
209 Downloader::download(const std::string& url,
210 size_t (*write_func)(void* ptr, size_t size, size_t nmemb, void* userdata),
213 log_info << "Downloading " << url << std::endl;
215 char error_buffer[CURL_ERROR_SIZE+1];
217 CURL* curl_handle = curl_easy_init();
218 curl_easy_setopt(curl_handle, CURLOPT_URL, url.c_str());
219 curl_easy_setopt(curl_handle, CURLOPT_USERAGENT, "SuperTux/" PACKAGE_VERSION " libcURL");
220 curl_easy_setopt(curl_handle, CURLOPT_WRITEFUNCTION, write_func);
221 curl_easy_setopt(curl_handle, CURLOPT_WRITEDATA, userdata);
222 curl_easy_setopt(curl_handle, CURLOPT_ERRORBUFFER, error_buffer);
223 curl_easy_setopt(curl_handle, CURLOPT_NOPROGRESS, 1);
224 curl_easy_setopt(curl_handle, CURLOPT_NOSIGNAL, 1);
225 curl_easy_setopt(curl_handle, CURLOPT_FAILONERROR, 1);
226 curl_easy_setopt(curl_handle, CURLOPT_FOLLOWLOCATION, 1);
227 CURLcode result = curl_easy_perform(curl_handle);
228 curl_easy_cleanup(curl_handle);
230 if (result != CURLE_OK)
232 std::string why = error_buffer[0] ? error_buffer : "unhandled error";
233 throw std::runtime_error(url + ": download failed: " + why);
238 Downloader::download(const std::string& url)
241 download(url, my_curl_string_append, &result);
246 Downloader::download(const std::string& url, const std::string& filename)
248 std::unique_ptr<PHYSFS_file, int(*)(PHYSFS_File*)> fout(PHYSFS_openWrite(filename.c_str()),
250 download(url, my_curl_physfs_write, fout.get());
254 Downloader::abort(TransferId id)
256 auto it = std::find_if(m_transfers.begin(), m_transfers.end(),
257 [&id](const std::unique_ptr<Transfer>& rhs)
259 return id == rhs->get_id();
261 if (it == m_transfers.end())
263 log_warning << "transfer not found: " << id << std::endl;
267 TransferStatusPtr status = (*it)->get_status();
269 curl_multi_remove_handle(m_multi_handle, (*it)->get_curl_handle());
270 m_transfers.erase(it);
272 for(auto& callback : status->callbacks)
278 catch(const std::exception& err)
280 log_warning << "Illegal exception in Downloader: " << err.what() << std::endl;
289 // read data from the network
292 while((ret = curl_multi_perform(m_multi_handle, &running_handles)) == CURLM_CALL_MULTI_PERFORM)
294 log_debug << "updating" << std::endl;
297 // check if any downloads got finished
300 while ((msg = curl_multi_info_read(m_multi_handle, &msgs_in_queue)))
306 log_info << "Download completed with " << msg->data.result << std::endl;
307 curl_multi_remove_handle(m_multi_handle, msg->easy_handle);
309 auto it = std::find_if(m_transfers.begin(), m_transfers.end(),
310 [&msg](const std::unique_ptr<Transfer>& rhs) {
311 return rhs->get_curl_handle() == msg->easy_handle;
313 assert(it != m_transfers.end());
314 TransferStatusPtr status = (*it)->get_status();
315 status->error_msg = (*it)->get_error_buffer();
316 m_transfers.erase(it);
318 if (msg->data.result == CURLE_OK)
321 for(auto& callback : status->callbacks)
327 catch(const std::exception& err)
330 log_warning << "Exception in Downloader: " << err.what() << std::endl;
331 status->error_msg = err.what();
337 log_warning << "Error: " << curl_easy_strerror(msg->data.result) << std::endl;
338 for(auto& callback : status->callbacks)
344 catch(const std::exception& err)
346 log_warning << "Illegal exception in Downloader: " << err.what() << std::endl;
354 log_warning << "unhandled cURL message: " << msg->msg << std::endl;
361 Downloader::request_download(const std::string& url, const std::string& outfile)
363 std::unique_ptr<Transfer> transfer(new Transfer(*this, m_next_transfer_id++, url, outfile));
364 curl_multi_add_handle(m_multi_handle, transfer->get_curl_handle());
365 m_transfers.push_back(std::move(transfer));
366 return m_transfers.back()->get_status();