2 * Copyright (c) 2017 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 <dali/integration-api/debug.h>
24 #include <curl/curl.h>
25 #include <openssl/crypto.h>
29 #include <dali/internal/system/common/file-writer.h>
31 #ifdef TPK_CURL_ENABLED
32 #include <tpkp_curl.h>
33 #endif // TPK_CURL_ENABLED
35 using namespace Dali::Integration;
40 namespace TizenPlatform
43 namespace // unnamed namespace
46 const int CONNECTION_TIMEOUT_SECONDS( 30L );
47 const long VERBOSE_MODE = 0L; // 0 == off, 1 == on
48 const long CLOSE_CONNECTION_ON_ERROR = 1L; // 0 == off, 1 == on
49 const long EXCLUDE_HEADER = 0L;
50 const long INCLUDE_HEADER = 1L;
51 const long INCLUDE_BODY = 0L;
52 const long EXCLUDE_BODY = 1L;
55 * Curl library environment. Direct initialize ensures it's constructed before adaptor
56 * or application creates any threads.
58 static Dali::TizenPlatform::Network::CurlEnvironment gCurlEnvironment;
60 void ConfigureCurlOptions( CURL* curlHandle, const std::string& url )
62 curl_easy_setopt( curlHandle, CURLOPT_URL, url.c_str() );
63 curl_easy_setopt( curlHandle, CURLOPT_VERBOSE, VERBOSE_MODE );
65 // CURLOPT_FAILONERROR is not fail-safe especially when authentication is involved ( see manual )
66 // Removed CURLOPT_FAILONERROR option
67 curl_easy_setopt( curlHandle, CURLOPT_CONNECTTIMEOUT, CONNECTION_TIMEOUT_SECONDS );
68 curl_easy_setopt( curlHandle, CURLOPT_HEADER, INCLUDE_HEADER );
69 curl_easy_setopt( curlHandle, CURLOPT_NOBODY, EXCLUDE_BODY );
71 #ifdef TPK_CURL_ENABLED
72 // Apply certificate pinning on Tizen
73 curl_easy_setopt( curlHandle, CURLOPT_SSL_CTX_FUNCTION, tpkp_curl_ssl_ctx_callback );
74 #endif // TPK_CURL_ENABLED
77 // Without a write function or a buffer (file descriptor) to write to, curl will pump out
78 // header/body contents to stdout
79 size_t DummyWrite(char *ptr, size_t size, size_t nmemb, void *userdata)
86 std::vector< uint8_t > data;
89 size_t ChunkLoader(char *ptr, size_t size, size_t nmemb, void *userdata)
91 std::vector<ChunkData>* chunks = static_cast<std::vector<ChunkData>*>( userdata );
92 int numBytes = size*nmemb;
93 chunks->push_back( ChunkData() );
94 ChunkData& chunkData = (*chunks)[chunks->size()-1];
95 chunkData.data.reserve( numBytes );
96 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 )
164 CURLcode result( CURLE_OK );
167 // setup curl to download just the header so we can extract the content length
168 ConfigureCurlOptions( curlHandle, url );
170 curl_easy_setopt( curlHandle, CURLOPT_WRITEFUNCTION, DummyWrite);
172 // perform the request to get the header
173 result = curl_easy_perform( curlHandle );
175 if( result != CURLE_OK)
177 DALI_LOG_ERROR( "Failed to download http header for \"%s\" with error code %d\n", url.c_str(), result );
181 // get the content length, -1 == size is not known
182 curl_easy_getinfo( curlHandle,CURLINFO_CONTENT_LENGTH_DOWNLOAD , &size );
185 if( size >= maximumAllowedSizeBytes )
187 DALI_LOG_ERROR( "File content length %f > max allowed %zu \"%s\" \n", size, maximumAllowedSizeBytes, url.c_str() );
192 // If we know the size up front, allocate once and avoid chunk copies.
193 dataSize = static_cast<size_t>( size );
194 result = DownloadFileDataWithSize( curlHandle, dataBuffer, dataSize );
198 result = DownloadFileDataByChunk( curlHandle, dataBuffer, dataSize );
201 if( result != CURLE_OK )
203 DALI_LOG_ERROR( "Failed to download image file \"%s\" with error code %d\n", url.c_str(), result );
210 } // unnamed namespace
216 std::mutex* CurlEnvironment::mMutexs = NULL;
218 CurlEnvironment::CurlEnvironment()
220 // Must be called before we attempt any loads. e.g. by using curl_easy_init()
221 // and before we start any threads.
222 curl_global_init(CURL_GLOBAL_ALL);
224 // libcurl with openssl needs locking_function and thread id for threadsafe
225 // https://curl.haxx.se/libcurl/c/threadsafe.html
226 // https://www.openssl.org/docs/man1.0.2/crypto/threads.html#DESCRIPTION
227 // SetLockingFunction sets locking_function and get thread id by the guide.
228 SetLockingFunction();
231 CurlEnvironment::~CurlEnvironment()
233 UnsetLockingFunction();
235 curl_global_cleanup();
238 // libcurl with openssl needs locking_function and thread id for threadsafe
239 // https://curl.haxx.se/libcurl/c/threadsafe.html
240 // https://www.openssl.org/docs/man1.0.2/crypto/threads.html#DESCRIPTION
241 void CurlEnvironment::OnOpenSSLLocking( int mode, int n, const char* file, int line )
243 if( mode & CRYPTO_LOCK )
253 unsigned long CurlEnvironment::GetThreadId()
255 // If dali uses c++ thread, we may replace pthread_self() to this_thread::get_id()
256 return static_cast< unsigned long >( pthread_self() );
259 void CurlEnvironment::SetLockingFunction()
261 if( mMutexs != NULL )
266 mMutexs = new std::mutex[ CRYPTO_num_locks() ];
268 CRYPTO_set_id_callback( &CurlEnvironment::GetThreadId );
269 CRYPTO_set_locking_callback( &CurlEnvironment::OnOpenSSLLocking );
272 void CurlEnvironment::UnsetLockingFunction()
274 if( mMutexs == NULL )
279 CRYPTO_set_id_callback( NULL );
280 CRYPTO_set_locking_callback( NULL );
285 bool DownloadRemoteFileIntoMemory( const std::string& url,
286 Dali::Vector<uint8_t>& dataBuffer,
288 size_t maximumAllowedSizeBytes )
292 DALI_LOG_WARNING("empty url requested \n");
296 // start a libcurl easy session, this internally calls curl_global_init, if we ever have more than one download
297 // thread we need to explicity call curl_global_init() on startup from a single thread.
299 CURL* curlHandle = curl_easy_init();
301 bool result = DownloadFile( curlHandle, url, dataBuffer, dataSize, maximumAllowedSizeBytes);
304 curl_easy_cleanup( curlHandle );
306 #ifdef TPK_CURL_ENABLED
307 // Clean up tpkp(the module for certificate pinning) resources on Tizen
309 #endif // TPK_CURL_ENABLED
314 } // namespace Network
316 } // namespace TizenPlatform