2 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include <dali/internal/imaging/common/file-download.h>
22 #include <curl/curl.h>
23 #include <dali/integration-api/debug.h>
29 #include <dali/internal/system/common/file-writer.h>
31 using namespace Dali::Integration;
35 namespace TizenPlatform
37 namespace // unnamed namespace
39 const int CONNECTION_TIMEOUT_SECONDS(30L);
40 const int TIMEOUT_SECONDS(120L);
41 const long VERBOSE_MODE = 0L; // 0 == off, 1 == on
42 const long CLOSE_CONNECTION_ON_ERROR = 1L; // 0 == off, 1 == on
43 const long EXCLUDE_HEADER = 0L;
44 const long INCLUDE_HEADER = 1L;
45 const long INCLUDE_BODY = 0L;
46 const long EXCLUDE_BODY = 1L;
49 * Curl library environment. Direct initialize ensures it's constructed before adaptor
50 * or application creates any threads.
52 static Dali::TizenPlatform::Network::CurlEnvironment gCurlEnvironment;
54 void ConfigureCurlOptions(CURL* curlHandle, const std::string& url)
56 curl_easy_setopt(curlHandle, CURLOPT_URL, url.c_str());
57 curl_easy_setopt(curlHandle, CURLOPT_VERBOSE, VERBOSE_MODE);
59 // CURLOPT_FAILONERROR is not fail-safe especially when authentication is involved ( see manual )
60 // Removed CURLOPT_FAILONERROR option
61 curl_easy_setopt(curlHandle, CURLOPT_CONNECTTIMEOUT, CONNECTION_TIMEOUT_SECONDS);
62 curl_easy_setopt(curlHandle, CURLOPT_TIMEOUT, TIMEOUT_SECONDS);
63 curl_easy_setopt(curlHandle, CURLOPT_HEADER, INCLUDE_HEADER);
64 curl_easy_setopt(curlHandle, CURLOPT_NOBODY, EXCLUDE_BODY);
65 curl_easy_setopt(curlHandle, CURLOPT_FOLLOWLOCATION, 1L);
66 curl_easy_setopt(curlHandle, CURLOPT_MAXREDIRS, 5L);
68 // If the proxy variable is set, ensure it's also used.
69 // In theory, this variable should be used by the curl library; however, something
71 char* proxy = std::getenv("http_proxy");
74 curl_easy_setopt(curlHandle, CURLOPT_PROXY, proxy);
78 // Without a write function or a buffer (file descriptor) to write to, curl will pump out
79 // header/body contents to stdout
80 size_t DummyWrite(char* ptr, size_t size, size_t nmemb, void* userdata)
87 std::vector<uint8_t> data;
90 size_t ChunkLoader(char* ptr, size_t size, size_t nmemb, void* userdata)
92 std::vector<ChunkData>* chunks = static_cast<std::vector<ChunkData>*>(userdata);
93 int numBytes = size * nmemb;
94 chunks->push_back(ChunkData());
95 ChunkData& chunkData = (*chunks)[chunks->size() - 1];
96 chunkData.data.reserve(numBytes);
97 memcpy(&chunkData.data[0], ptr, numBytes);
101 CURLcode DownloadFileDataWithSize(CURL* curlHandle, Dali::Vector<uint8_t>& dataBuffer, size_t dataSize)
103 CURLcode result(CURLE_OK);
106 Dali::Internal::Platform::FileWriter fileWriter(dataBuffer, dataSize);
107 FILE* dataBufferFilePointer = fileWriter.GetFile();
108 if(NULL != dataBufferFilePointer)
110 // we only want the body which contains the file data
111 curl_easy_setopt(curlHandle, CURLOPT_HEADER, EXCLUDE_HEADER);
112 curl_easy_setopt(curlHandle, CURLOPT_NOBODY, INCLUDE_BODY);
114 // disable the write callback, and get curl to write directly into our data buffer
115 curl_easy_setopt(curlHandle, CURLOPT_WRITEFUNCTION, NULL);
116 curl_easy_setopt(curlHandle, CURLOPT_WRITEDATA, dataBufferFilePointer);
118 // synchronous request of the body data
119 result = curl_easy_perform(curlHandle);
124 CURLcode DownloadFileDataByChunk(CURL* curlHandle, Dali::Vector<uint8_t>& dataBuffer, size_t& dataSize)
127 std::vector<ChunkData> chunks;
129 // we only want the body which contains the file data
130 curl_easy_setopt(curlHandle, CURLOPT_HEADER, EXCLUDE_HEADER);
131 curl_easy_setopt(curlHandle, CURLOPT_NOBODY, INCLUDE_BODY);
133 // Enable the write callback.
134 curl_easy_setopt(curlHandle, CURLOPT_WRITEFUNCTION, ChunkLoader);
135 curl_easy_setopt(curlHandle, CURLOPT_WRITEDATA, &chunks);
137 // synchronous request of the body data
138 CURLcode result = curl_easy_perform(curlHandle);
140 // chunks should now contain all of the chunked data. Reassemble into a single vector
142 for(size_t i = 0; i < chunks.size(); ++i)
144 dataSize += chunks[i].data.capacity();
146 dataBuffer.Resize(dataSize);
149 for(size_t i = 0; i < chunks.size(); ++i)
151 memcpy(&dataBuffer[offset], &chunks[i].data[0], chunks[i].data.capacity());
152 offset += chunks[i].data.capacity();
158 bool DownloadFile(CURL* curlHandle,
159 const std::string& url,
160 Dali::Vector<uint8_t>& dataBuffer,
162 size_t maximumAllowedSizeBytes,
165 CURLcode result(CURLE_OK);
168 // setup curl to download just the header so we can extract the content length
169 ConfigureCurlOptions(curlHandle, url);
170 curl_easy_setopt(curlHandle, CURLOPT_WRITEFUNCTION, DummyWrite);
171 if(errorBuffer != nullptr)
176 // perform the request to get the header
177 result = curl_easy_perform(curlHandle);
179 if(result != CURLE_OK)
181 if(errorBuffer != nullptr)
183 DALI_LOG_ERROR("Failed to download http header for \"%s\" with error code %d (%s)\n", url.c_str(), result, &errorBuffer[0]);
187 DALI_LOG_ERROR("Failed to download http header for \"%s\" with error code %d\n", url.c_str(), result);
192 // get the content length, -1 == size is not known
193 curl_easy_getinfo(curlHandle, CURLINFO_CONTENT_LENGTH_DOWNLOAD, &size);
195 if(size >= maximumAllowedSizeBytes)
197 DALI_LOG_ERROR("File content length %f > max allowed %zu \"%s\" \n", size, maximumAllowedSizeBytes, url.c_str());
202 // If we know the size up front, allocate once and avoid chunk copies.
203 dataSize = static_cast<size_t>(size);
204 result = DownloadFileDataWithSize(curlHandle, dataBuffer, dataSize);
208 result = DownloadFileDataByChunk(curlHandle, dataBuffer, dataSize);
211 if(result != CURLE_OK)
213 if(errorBuffer != nullptr)
215 DALI_LOG_ERROR("Failed to download image file \"%s\" with error code %d\n", url.c_str(), result);
219 DALI_LOG_ERROR("Failed to download image file \"%s\" with error code %d (%s)\n", url.c_str(), result, errorBuffer);
226 } // unnamed namespace
230 CurlEnvironment::CurlEnvironment()
232 // Must be called before we attempt any loads. e.g. by using curl_easy_init()
233 // and before we start any threads.
234 curl_global_init(CURL_GLOBAL_ALL);
237 CurlEnvironment::~CurlEnvironment()
239 curl_global_cleanup();
242 bool DownloadRemoteFileIntoMemory(const std::string& url,
243 Dali::Vector<uint8_t>& dataBuffer,
245 size_t maximumAllowedSizeBytes)
251 DALI_LOG_WARNING("empty url requested \n");
255 // start a libcurl easy session, this internally calls curl_global_init, if we ever have more than one download
256 // thread we need to explicity call curl_global_init() on startup from a single thread.
258 CURL* curlHandle = curl_easy_init();
261 std::vector<char> errorBuffer(CURL_ERROR_SIZE);
262 curl_easy_setopt(curlHandle, CURLOPT_ERRORBUFFER, &errorBuffer[0]);
263 result = DownloadFile(curlHandle, url, dataBuffer, dataSize, maximumAllowedSizeBytes, &errorBuffer[0]);
266 curl_easy_cleanup(curlHandle);
271 } // namespace Network
273 } // namespace TizenPlatform