1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
|
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2015 Mark Roszko <mark.roszko@gmail.com>
* Copyright The KiCad Developers, see AUTHORS.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 3
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, you may find one here:
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
* or you may search the http://www.gnu.org website for the version 2 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
// kicad_curl_easy.h **must be** included before any wxWidgets header to avoid conflicts
// at least on Windows/msys2
#include <curl/curl.h>
#include <curl/easy.h>
#include <kicad_curl/kicad_curl.h>
#include <kicad_curl/kicad_curl_easy.h>
#include <cstdarg>
#include <cstddef>
#include <exception>
#include <sstream>
#include <shared_mutex>
#include <wx/app.h>
#include <build_version.h>
#include <ki_exception.h> // THROW_IO_ERROR
#include <kiplatform/app.h>
#include <kiplatform/environment.h>
#include <kiplatform/policy.h>
#include <policy_keys.h>
struct CURL_PROGRESS
{
KICAD_CURL_EASY* m_Curl;
TRANSFER_CALLBACK m_Callback;
curl_off_t m_Last_run_time;
curl_off_t m_Interval;
CURL_PROGRESS( KICAD_CURL_EASY* aCURL, TRANSFER_CALLBACK aCallback, curl_off_t aInterval ) :
m_Curl( aCURL ),
m_Callback( aCallback ),
m_Last_run_time( 0 ),
m_Interval( aInterval )
{
}
};
static size_t write_callback( void* aContents, size_t aSize, size_t aNmemb, void* aUserp )
{
size_t realsize = aSize * aNmemb;
std::string* p = static_cast<std::string*>( aUserp );
p->append( static_cast<const char*>( aContents ), realsize );
return realsize;
}
static size_t stream_write_callback( void* aContents, size_t aSize, size_t aNmemb, void* aUserp )
{
size_t realsize = aSize * aNmemb;
std::ostream* p = static_cast<std::ostream*>( aUserp );
p->write( static_cast<const char*>( aContents ), realsize );
return realsize;
}
#if LIBCURL_VERSION_NUM >= 0x072000 // 7.32.0
static int xferinfo( void* aProgress, curl_off_t aDLtotal, curl_off_t aDLnow, curl_off_t aULtotal,
curl_off_t aULnow )
{
if( KICAD_CURL::IsShuttingDown() )
return 1; // Should abort the operation
CURL_PROGRESS* progress = static_cast<CURL_PROGRESS*>( aProgress );
curl_off_t curtime = 0;
curl_easy_getinfo( progress->m_Curl->GetCurl(), CURLINFO_TOTAL_TIME, &curtime );
if( curtime - progress->m_Last_run_time >= progress->m_Interval )
{
progress->m_Last_run_time = curtime;
return progress->m_Callback( aDLtotal, aDLnow, aULtotal, aULnow );
}
return CURLE_OK;
}
#else
static int progressinfo( void* aProgress, double aDLtotal, double aDLnow, double aULtotal,
double aULnow )
{
return xferinfo( aProgress, static_cast<curl_off_t>( aDLtotal ),
static_cast<curl_off_t>( aDLnow ), static_cast<curl_off_t>( aULtotal ),
static_cast<curl_off_t>( aULnow ) );
}
#endif
KICAD_CURL_EASY::KICAD_CURL_EASY() :
m_headers( nullptr ),
m_curlSharedLock( KICAD_CURL::Mutex() )
{
m_CURL = curl_easy_init();
if( !m_CURL )
THROW_IO_ERROR( "Unable to initialize CURL session" );
curl_easy_setopt( m_CURL, CURLOPT_WRITEFUNCTION, write_callback );
curl_easy_setopt( m_CURL, CURLOPT_WRITEDATA, static_cast<void*>( &m_buffer ) );
// Only allow HTTP and HTTPS protocols
#if LIBCURL_VERSION_NUM >= 0x075500 // version 7.85.0
curl_easy_setopt(m_CURL, CURLOPT_PROTOCOLS_STR, "http,https");
#else
curl_easy_setopt( m_CURL, CURLOPT_PROTOCOLS, CURLPROTO_HTTP | CURLPROTO_HTTPS );
#endif
#ifdef _WIN32
long sslOpts = CURLSSLOPT_NATIVE_CA;
POLICY_CURL_SSL_REVOKE policyState = KIPLATFORM::POLICY::GetPolicyEnum<POLICY_CURL_SSL_REVOKE>(
POLICY_KEY_REQUESTS_CURL_REVOKE );
if( policyState == POLICY_CURL_SSL_REVOKE::BEST_EFFORT )
{
sslOpts |= CURLSSLOPT_REVOKE_BEST_EFFORT;
}
else if( policyState == POLICY_CURL_SSL_REVOKE::NONE )
{
sslOpts |= CURLSSLOPT_NO_REVOKE;
}
// We need this to use the Windows Certificate store
curl_easy_setopt( m_CURL, CURLOPT_SSL_OPTIONS, sslOpts );
#endif
if( wxGetEnv( wxT( "KICAD_CURL_VERBOSE" ), nullptr ) )
{
// note: curl verbose will end up in stderr
curl_easy_setopt( m_CURL, CURLOPT_VERBOSE, 1L );
}
wxPlatformInfo platformInfo;
wxString application( wxS( "KiCad" ) );
wxString version( GetBuildVersion() );
wxString platform = wxS( "(" ) + wxGetOsDescription() + wxS( ";" ) +
GetPlatformGetBitnessName();
#if defined( KICAD_BUILD_ARCH_X64 )
platform << wxS( ";64-bit" );
#elif defined( KICAD_BUILD_ARCH_X86 )
platform << wxS( ";32-bit" );
#elif defined( KICAD_BUILD_ARCH_ARM )
platform << wxS( ";ARM 32-bit" );
#elif defined( KICAD_BUILD_ARCH_ARM64 )
platform << wxS( ";ARM 64-bit" );
#endif
platform << wxS( ")" );
wxString user_agent = wxS( "KiCad/" ) + version + wxS( " " ) + platform + wxS( " " ) +
application;
user_agent << wxS( "/" ) << GetBuildDate();
setOption<const char*>( CURLOPT_USERAGENT, user_agent.ToStdString().c_str() );
setOption( CURLOPT_ACCEPT_ENCODING, "gzip,deflate" );
}
KICAD_CURL_EASY::~KICAD_CURL_EASY()
{
if( m_headers )
curl_slist_free_all( m_headers );
curl_easy_cleanup( m_CURL );
}
int KICAD_CURL_EASY::Perform()
{
if( m_headers )
curl_easy_setopt( m_CURL, CURLOPT_HTTPHEADER, m_headers );
// bonus: retain worst case memory allocation, should re-use occur
m_buffer.clear();
return curl_easy_perform( m_CURL );
}
void KICAD_CURL_EASY::SetHeader( const std::string& aName, const std::string& aValue )
{
std::string header = aName + ':' + aValue;
m_headers = curl_slist_append( m_headers, header.c_str() );
}
template <typename T>
int KICAD_CURL_EASY::setOption( int aOption, T aArg )
{
return curl_easy_setopt( m_CURL, static_cast<CURLoption>( aOption ), aArg );
}
const std::string KICAD_CURL_EASY::GetErrorText( int aCode )
{
return curl_easy_strerror( static_cast<CURLcode>( aCode ) );
}
bool KICAD_CURL_EASY::SetUserAgent( const std::string& aAgent )
{
if( setOption<const char*>( CURLOPT_USERAGENT, aAgent.c_str() ) == CURLE_OK )
return true;
return false;
}
bool KICAD_CURL_EASY::SetPostFields(
const std::vector<std::pair<std::string, std::string>>& aFields )
{
std::string postfields;
for( size_t i = 0; i < aFields.size(); i++ )
{
if( i > 0 )
postfields += "&";
postfields += Escape( aFields[i].first );
postfields += "=";
postfields += Escape( aFields[i].second );
}
if( setOption<const char*>( CURLOPT_COPYPOSTFIELDS, postfields.c_str() ) != CURLE_OK )
return false;
return true;
}
bool KICAD_CURL_EASY::SetPostFields( const std::string& aField )
{
if( setOption<const char*>( CURLOPT_COPYPOSTFIELDS, aField.c_str() ) != CURLE_OK )
return false;
return true;
}
bool KICAD_CURL_EASY::SetURL( const std::string& aURL )
{
if( setOption<const char*>( CURLOPT_URL, aURL.c_str() ) == CURLE_OK )
{
KIPLATFORM::ENV::PROXY_CONFIG cfg;
// Unfortunately on Windows land, proxies can be configured depending on destination url
// So we also check and set any proxy config here
if( KIPLATFORM::ENV::GetSystemProxyConfig( aURL, cfg ) )
{
curl_easy_setopt( m_CURL, CURLOPT_PROXY, static_cast<const char*>( cfg.host.c_str() ) );
if( !cfg.username.empty() )
{
curl_easy_setopt( m_CURL, CURLOPT_PROXYUSERNAME,
static_cast<const char*>( cfg.username.c_str() ) );
}
if( !cfg.password.empty() )
{
curl_easy_setopt( m_CURL, CURLOPT_PROXYPASSWORD,
static_cast<const char*>( cfg.password.c_str() ) );
}
}
return true;
}
return false;
}
bool KICAD_CURL_EASY::SetFollowRedirects( bool aFollow )
{
if( setOption<long>( CURLOPT_FOLLOWLOCATION, ( aFollow ? 1 : 0 ) ) == CURLE_OK )
return true;
return false;
}
std::string KICAD_CURL_EASY::Escape( const std::string& aUrl )
{
char* escaped = curl_easy_escape( m_CURL, aUrl.c_str(), aUrl.length() );
std::string ret( escaped );
curl_free( escaped );
return ret;
}
bool KICAD_CURL_EASY::SetTransferCallback( const TRANSFER_CALLBACK& aCallback, size_t aInterval )
{
progress = std::make_unique<CURL_PROGRESS>( this, aCallback,
static_cast<curl_off_t>( aInterval ) );
#if LIBCURL_VERSION_NUM >= 0x072000 // 7.32.0
setOption( CURLOPT_XFERINFOFUNCTION, xferinfo );
setOption( CURLOPT_XFERINFODATA, progress.get() );
#else
setOption( CURLOPT_PROGRESSFUNCTION, progressinfo );
setOption( CURLOPT_PROGRESSDATA, progress.get() );
#endif
setOption( CURLOPT_NOPROGRESS, 0L );
return true;
}
bool KICAD_CURL_EASY::SetOutputStream( const std::ostream* aOutput )
{
curl_easy_setopt( m_CURL, CURLOPT_WRITEFUNCTION, stream_write_callback );
curl_easy_setopt( m_CURL, CURLOPT_WRITEDATA, reinterpret_cast<const void*>( aOutput ) );
return true;
}
int KICAD_CURL_EASY::GetTransferTotal( uint64_t& aDownloadedBytes ) const
{
#if LIBCURL_VERSION_NUM >= 0x073700 // 7.55.0
curl_off_t dl;
int result = curl_easy_getinfo( m_CURL, CURLINFO_SIZE_DOWNLOAD_T, &dl );
aDownloadedBytes = static_cast<uint64_t>( dl );
#else
double dl;
int result = curl_easy_getinfo( m_CURL, CURLINFO_SIZE_DOWNLOAD, &dl );
aDownloadedBytes = static_cast<uint64_t>( dl );
#endif
return result;
}
int KICAD_CURL_EASY::GetResponseStatusCode()
{
long http_code = 0;
curl_easy_getinfo( m_CURL, CURLINFO_RESPONSE_CODE, &http_code );
return static_cast<int>( http_code );
}
|