libzypp  15.19.5
MediaCurl.cc
Go to the documentation of this file.
1 /*---------------------------------------------------------------------\
2 | ____ _ __ __ ___ |
3 | |__ / \ / / . \ . \ |
4 | / / \ V /| _/ _/ |
5 | / /__ | | | | | | |
6 | /_____||_| |_| |_| |
7 | |
8 \---------------------------------------------------------------------*/
13 #include <iostream>
14 #include <list>
15 
16 #include "zypp/base/Logger.h"
17 #include "zypp/ExternalProgram.h"
18 #include "zypp/base/String.h"
19 #include "zypp/base/Gettext.h"
20 #include "zypp/base/Sysconfig.h"
21 #include "zypp/base/Gettext.h"
22 
23 #include "zypp/media/MediaCurl.h"
24 #include "zypp/media/ProxyInfo.h"
27 #include "zypp/media/CurlConfig.h"
28 #include "zypp/thread/Once.h"
29 #include "zypp/Target.h"
30 #include "zypp/ZYppFactory.h"
31 #include "zypp/ZConfig.h"
32 
33 #include <cstdlib>
34 #include <sys/types.h>
35 #include <sys/stat.h>
36 #include <sys/mount.h>
37 #include <errno.h>
38 #include <dirent.h>
39 #include <unistd.h>
40 #include <boost/format.hpp>
41 
42 #define DETECT_DIR_INDEX 0
43 #define CONNECT_TIMEOUT 60
44 #define TRANSFER_TIMEOUT_MAX 60 * 60
45 
46 #define EXPLICITLY_NO_PROXY "_none_"
47 
48 #undef CURLVERSION_AT_LEAST
49 #define CURLVERSION_AT_LEAST(M,N,O) LIBCURL_VERSION_NUM >= ((((M)<<8)+(N))<<8)+(O)
50 
51 using namespace std;
52 using namespace zypp::base;
53 
54 namespace
55 {
56  zypp::thread::OnceFlag g_InitOnceFlag = PTHREAD_ONCE_INIT;
57  zypp::thread::OnceFlag g_FreeOnceFlag = PTHREAD_ONCE_INIT;
58 
59  extern "C" void _do_free_once()
60  {
61  curl_global_cleanup();
62  }
63 
64  extern "C" void globalFreeOnce()
65  {
66  zypp::thread::callOnce(g_FreeOnceFlag, _do_free_once);
67  }
68 
69  extern "C" void _do_init_once()
70  {
71  CURLcode ret = curl_global_init( CURL_GLOBAL_ALL );
72  if ( ret != 0 )
73  {
74  WAR << "curl global init failed" << endl;
75  }
76 
77  //
78  // register at exit handler ?
79  // this may cause trouble, because we can protect it
80  // against ourself only.
81  // if the app sets an atexit handler as well, it will
82  // cause a double free while the second of them runs.
83  //
84  //std::atexit( globalFreeOnce);
85  }
86 
87  inline void globalInitOnce()
88  {
89  zypp::thread::callOnce(g_InitOnceFlag, _do_init_once);
90  }
91 
92  int log_curl(CURL *curl, curl_infotype info,
93  char *ptr, size_t len, void *max_lvl)
94  {
95  std::string pfx(" ");
96  long lvl = 0;
97  switch( info)
98  {
99  case CURLINFO_TEXT: lvl = 1; pfx = "*"; break;
100  case CURLINFO_HEADER_IN: lvl = 2; pfx = "<"; break;
101  case CURLINFO_HEADER_OUT: lvl = 2; pfx = ">"; break;
102  default: break;
103  }
104  if( lvl > 0 && max_lvl != NULL && lvl <= *((long *)max_lvl))
105  {
106  std::string msg(ptr, len);
107  std::list<std::string> lines;
108  std::list<std::string>::const_iterator line;
109  zypp::str::split(msg, std::back_inserter(lines), "\r\n");
110  for(line = lines.begin(); line != lines.end(); ++line)
111  {
112  DBG << pfx << " " << *line << endl;
113  }
114  }
115  return 0;
116  }
117 
118  static size_t
119  log_redirects_curl(
120  void *ptr, size_t size, size_t nmemb, void *stream)
121  {
122  // INT << "got header: " << string((char *)ptr, ((char*)ptr) + size*nmemb) << endl;
123 
124  char * lstart = (char *)ptr, * lend = (char *)ptr;
125  size_t pos = 0;
126  size_t max = size * nmemb;
127  while (pos + 1 < max)
128  {
129  // get line
130  for (lstart = lend; *lend != '\n' && pos < max; ++lend, ++pos);
131 
132  // look for "Location"
133  string line(lstart, lend);
134  if (line.find("Location") != string::npos)
135  {
136  DBG << "redirecting to " << line << endl;
137  return max;
138  }
139 
140  // continue with the next line
141  if (pos + 1 < max)
142  {
143  ++lend;
144  ++pos;
145  }
146  else
147  break;
148  }
149 
150  return max;
151  }
152 }
153 
154 namespace zypp {
155  namespace media {
156 
157  namespace {
158  struct ProgressData
159  {
160  ProgressData(CURL *_curl, const long _timeout, const zypp::Url &_url = zypp::Url(),
161  callback::SendReport<DownloadProgressReport> *_report=NULL)
162  : curl(_curl)
163  , timeout(_timeout)
164  , reached(false)
165  , report(_report)
166  , drate_period(-1)
167  , dload_period(0)
168  , secs(0)
169  , drate_avg(-1)
170  , ltime( time(NULL))
171  , dload( 0)
172  , uload( 0)
173  , url(_url)
174  {}
175  CURL *curl;
176  long timeout;
177  bool reached;
178  callback::SendReport<DownloadProgressReport> *report;
179  // download rate of the last period (cca 1 sec)
180  double drate_period;
181  // bytes downloaded at the start of the last period
182  double dload_period;
183  // seconds from the start of the download
184  long secs;
185  // average download rate
186  double drate_avg;
187  // last time the progress was reported
188  time_t ltime;
189  // bytes downloaded at the moment the progress was last reported
190  double dload;
191  // bytes uploaded at the moment the progress was last reported
192  double uload;
194  };
195 
197 
198  inline void escape( string & str_r,
199  const char char_r, const string & escaped_r ) {
200  for ( string::size_type pos = str_r.find( char_r );
201  pos != string::npos; pos = str_r.find( char_r, pos ) ) {
202  str_r.replace( pos, 1, escaped_r );
203  }
204  }
205 
206  inline string escapedPath( string path_r ) {
207  escape( path_r, ' ', "%20" );
208  return path_r;
209  }
210 
211  inline string unEscape( string text_r ) {
212  char * tmp = curl_unescape( text_r.c_str(), 0 );
213  string ret( tmp );
214  curl_free( tmp );
215  return ret;
216  }
217 
218  }
219 
225 {
226  std::string param(url.getQueryParam("timeout"));
227  if( !param.empty())
228  {
229  long num = str::strtonum<long>(param);
230  if( num >= 0 && num <= TRANSFER_TIMEOUT_MAX)
231  s.setTimeout(num);
232  }
233 
234  if ( ! url.getUsername().empty() )
235  {
236  s.setUsername(url.getUsername());
237  if ( url.getPassword().size() )
238  s.setPassword(url.getPassword());
239  }
240  else
241  {
242  // if there is no username, set anonymous auth
243  if ( ( url.getScheme() == "ftp" || url.getScheme() == "tftp" ) && s.username().empty() )
244  s.setAnonymousAuth();
245  }
246 
247  if ( url.getScheme() == "https" )
248  {
249  s.setVerifyPeerEnabled(false);
250  s.setVerifyHostEnabled(false);
251 
252  std::string verify( url.getQueryParam("ssl_verify"));
253  if( verify.empty() ||
254  verify == "yes")
255  {
256  s.setVerifyPeerEnabled(true);
257  s.setVerifyHostEnabled(true);
258  }
259  else if( verify == "no")
260  {
261  s.setVerifyPeerEnabled(false);
262  s.setVerifyHostEnabled(false);
263  }
264  else
265  {
266  std::vector<std::string> flags;
267  std::vector<std::string>::const_iterator flag;
268  str::split( verify, std::back_inserter(flags), ",");
269  for(flag = flags.begin(); flag != flags.end(); ++flag)
270  {
271  if( *flag == "host")
272  s.setVerifyHostEnabled(true);
273  else if( *flag == "peer")
274  s.setVerifyPeerEnabled(true);
275  else
276  ZYPP_THROW(MediaBadUrlException(url, "Unknown ssl_verify flag"));
277  }
278  }
279  }
280 
281  Pathname ca_path( url.getQueryParam("ssl_capath") );
282  if( ! ca_path.empty())
283  {
284  if( !PathInfo(ca_path).isDir() || ! ca_path.absolute())
285  ZYPP_THROW(MediaBadUrlException(url, "Invalid ssl_capath path"));
286  else
288  }
289 
290  Pathname client_cert( url.getQueryParam("ssl_clientcert") );
291  if( ! client_cert.empty())
292  {
293  if( !PathInfo(client_cert).isFile() || !client_cert.absolute())
294  ZYPP_THROW(MediaBadUrlException(url, "Invalid ssl_clientcert file"));
295  else
296  s.setClientCertificatePath(client_cert);
297  }
298  Pathname client_key( url.getQueryParam("ssl_clientkey") );
299  if( ! client_key.empty())
300  {
301  if( !PathInfo(client_key).isFile() || !client_key.absolute())
302  ZYPP_THROW(MediaBadUrlException(url, "Invalid ssl_clientkey file"));
303  else
304  s.setClientKeyPath(client_key);
305  }
306 
307  param = url.getQueryParam( "proxy" );
308  if ( ! param.empty() )
309  {
310  if ( param == EXPLICITLY_NO_PROXY ) {
311  // Workaround TransferSettings shortcoming: With an
312  // empty proxy string, code will continue to look for
313  // valid proxy settings. So set proxy to some non-empty
314  // string, to indicate it has been explicitly disabled.
316  s.setProxyEnabled(false);
317  }
318  else {
319  string proxyport( url.getQueryParam( "proxyport" ) );
320  if ( ! proxyport.empty() ) {
321  param += ":" + proxyport;
322  }
323  s.setProxy(param);
324  s.setProxyEnabled(true);
325  }
326  }
327 
328  param = url.getQueryParam( "proxyuser" );
329  if ( ! param.empty() )
330  {
331  s.setProxyUsername(param);
332  s.setProxyPassword(url.getQueryParam( "proxypass" ));
333  }
334 
335  // HTTP authentication type
336  param = url.getQueryParam("auth");
337  if (!param.empty() && (url.getScheme() == "http" || url.getScheme() == "https"))
338  {
339  try
340  {
341  CurlAuthData::auth_type_str2long(param); // check if we know it
342  }
343  catch (MediaException & ex_r)
344  {
345  DBG << "Rethrowing as MediaUnauthorizedException.";
346  ZYPP_THROW(MediaUnauthorizedException(url, ex_r.msg(), "", ""));
347  }
348  s.setAuthType(param);
349  }
350 
351  // workarounds
352  param = url.getQueryParam("head_requests");
353  if( !param.empty() && param == "no" )
354  s.setHeadRequestsAllowed(false);
355 }
356 
362 {
363  ProxyInfo proxy_info;
364  if ( proxy_info.useProxyFor( url ) )
365  {
366  // We must extract any 'user:pass' from the proxy url
367  // otherwise they won't make it into curl (.curlrc wins).
368  try {
369  Url u( proxy_info.proxy( url ) );
370  s.setProxy( u.asString( url::ViewOption::WITH_SCHEME + url::ViewOption::WITH_HOST + url::ViewOption::WITH_PORT ) );
371  // don't overwrite explicit auth settings
372  if ( s.proxyUsername().empty() )
373  {
374  s.setProxyUsername( u.getUsername( url::E_ENCODED ) );
375  s.setProxyPassword( u.getPassword( url::E_ENCODED ) );
376  }
377  s.setProxyEnabled( true );
378  }
379  catch (...) {} // no proxy if URL is malformed
380  }
381 }
382 
383 Pathname MediaCurl::_cookieFile = "/var/lib/YaST2/cookies";
384 
389 static const char *const anonymousIdHeader()
390 {
391  // we need to add the release and identifier to the
392  // agent string.
393  // The target could be not initialized, and then this information
394  // is guessed.
395  static const std::string _value(
397  "X-ZYpp-AnonymousId: %s",
398  Target::anonymousUniqueId( Pathname()/*guess root*/ ).c_str() ) )
399  );
400  return _value.c_str();
401 }
402 
407 static const char *const distributionFlavorHeader()
408 {
409  // we need to add the release and identifier to the
410  // agent string.
411  // The target could be not initialized, and then this information
412  // is guessed.
413  static const std::string _value(
415  "X-ZYpp-DistributionFlavor: %s",
416  Target::distributionFlavor( Pathname()/*guess root*/ ).c_str() ) )
417  );
418  return _value.c_str();
419 }
420 
425 static const char *const agentString()
426 {
427  // we need to add the release and identifier to the
428  // agent string.
429  // The target could be not initialized, and then this information
430  // is guessed.
431  static const std::string _value(
432  str::form(
433  "ZYpp %s (curl %s) %s"
434  , VERSION
435  , curl_version_info(CURLVERSION_NOW)->version
436  , Target::targetDistribution( Pathname()/*guess root*/ ).c_str()
437  )
438  );
439  return _value.c_str();
440 }
441 
442 // we use this define to unbloat code as this C setting option
443 // and catching exception is done frequently.
445 #define SET_OPTION(opt,val) do { \
446  ret = curl_easy_setopt ( _curl, opt, val ); \
447  if ( ret != 0) { \
448  ZYPP_THROW(MediaCurlSetOptException(_url, _curlError)); \
449  } \
450  } while ( false )
451 
452 #define SET_OPTION_OFFT(opt,val) SET_OPTION(opt,(curl_off_t)val)
453 #define SET_OPTION_LONG(opt,val) SET_OPTION(opt,(long)val)
454 #define SET_OPTION_VOID(opt,val) SET_OPTION(opt,(void*)val)
455 
456 MediaCurl::MediaCurl( const Url & url_r,
457  const Pathname & attach_point_hint_r )
458  : MediaHandler( url_r, attach_point_hint_r,
459  "/", // urlpath at attachpoint
460  true ), // does_download
461  _curl( NULL ),
462  _customHeaders(0L)
463 {
464  _curlError[0] = '\0';
465  _curlDebug = 0L;
466 
467  MIL << "MediaCurl::MediaCurl(" << url_r << ", " << attach_point_hint_r << ")" << endl;
468 
469  globalInitOnce();
470 
471  if( !attachPoint().empty())
472  {
473  PathInfo ainfo(attachPoint());
474  Pathname apath(attachPoint() + "XXXXXX");
475  char *atemp = ::strdup( apath.asString().c_str());
476  char *atest = NULL;
477  if( !ainfo.isDir() || !ainfo.userMayRWX() ||
478  atemp == NULL || (atest=::mkdtemp(atemp)) == NULL)
479  {
480  WAR << "attach point " << ainfo.path()
481  << " is not useable for " << url_r.getScheme() << endl;
482  setAttachPoint("", true);
483  }
484  else if( atest != NULL)
485  ::rmdir(atest);
486 
487  if( atemp != NULL)
488  ::free(atemp);
489  }
490 }
491 
493 {
494  Url curlUrl (url);
495  curlUrl.setUsername( "" );
496  curlUrl.setPassword( "" );
497  curlUrl.setPathParams( "" );
498  curlUrl.setFragment( "" );
499  curlUrl.delQueryParam("cookies");
500  curlUrl.delQueryParam("proxy");
501  curlUrl.delQueryParam("proxyport");
502  curlUrl.delQueryParam("proxyuser");
503  curlUrl.delQueryParam("proxypass");
504  curlUrl.delQueryParam("ssl_capath");
505  curlUrl.delQueryParam("ssl_verify");
506  curlUrl.delQueryParam("ssl_clientcert");
507  curlUrl.delQueryParam("timeout");
508  curlUrl.delQueryParam("auth");
509  curlUrl.delQueryParam("username");
510  curlUrl.delQueryParam("password");
511  curlUrl.delQueryParam("mediahandler");
512  curlUrl.delQueryParam("credentials");
513  curlUrl.delQueryParam("head_requests");
514  return curlUrl;
515 }
516 
518 {
519  return _settings;
520 }
521 
522 
523 void MediaCurl::setCookieFile( const Pathname &fileName )
524 {
525  _cookieFile = fileName;
526 }
527 
529 
530 void MediaCurl::checkProtocol(const Url &url) const
531 {
532  curl_version_info_data *curl_info = NULL;
533  curl_info = curl_version_info(CURLVERSION_NOW);
534  // curl_info does not need any free (is static)
535  if (curl_info->protocols)
536  {
537  const char * const *proto;
538  std::string scheme( url.getScheme());
539  bool found = false;
540  for(proto=curl_info->protocols; !found && *proto; ++proto)
541  {
542  if( scheme == std::string((const char *)*proto))
543  found = true;
544  }
545  if( !found)
546  {
547  std::string msg("Unsupported protocol '");
548  msg += scheme;
549  msg += "'";
551  }
552  }
553 }
554 
556 {
557  {
558  char *ptr = getenv("ZYPP_MEDIA_CURL_DEBUG");
559  _curlDebug = (ptr && *ptr) ? str::strtonum<long>( ptr) : 0L;
560  if( _curlDebug > 0)
561  {
562  curl_easy_setopt( _curl, CURLOPT_VERBOSE, 1L);
563  curl_easy_setopt( _curl, CURLOPT_DEBUGFUNCTION, log_curl);
564  curl_easy_setopt( _curl, CURLOPT_DEBUGDATA, &_curlDebug);
565  }
566  }
567 
568  curl_easy_setopt(_curl, CURLOPT_HEADERFUNCTION, log_redirects_curl);
569  CURLcode ret = curl_easy_setopt( _curl, CURLOPT_ERRORBUFFER, _curlError );
570  if ( ret != 0 ) {
571  ZYPP_THROW(MediaCurlSetOptException(_url, "Error setting error buffer"));
572  }
573 
574  SET_OPTION(CURLOPT_FAILONERROR, 1L);
575  SET_OPTION(CURLOPT_NOSIGNAL, 1L);
576 
577  // create non persistant settings
578  // so that we don't add headers twice
579  TransferSettings vol_settings(_settings);
580 
581  // add custom headers
582  vol_settings.addHeader(anonymousIdHeader());
583  vol_settings.addHeader(distributionFlavorHeader());
584  vol_settings.addHeader("Pragma:");
585 
586  _settings.setTimeout(ZConfig::instance().download_transfer_timeout());
588 
590 
591  // fill some settings from url query parameters
592  try
593  {
595  }
596  catch ( const MediaException &e )
597  {
598  disconnectFrom();
599  ZYPP_RETHROW(e);
600  }
601  // if the proxy was not set (or explicitly unset) by url, then look...
602  if ( _settings.proxy().empty() )
603  {
604  // ...at the system proxy settings
606  }
607 
611  SET_OPTION(CURLOPT_CONNECTTIMEOUT, _settings.connectTimeout());
612  // If a transfer timeout is set, also set CURLOPT_TIMEOUT to an upper limit
613  // just in case curl does not trigger its progress callback frequently
614  // enough.
615  if ( _settings.timeout() )
616  {
617  SET_OPTION(CURLOPT_TIMEOUT, 3600L);
618  }
619 
620  // follow any Location: header that the server sends as part of
621  // an HTTP header (#113275)
622  SET_OPTION(CURLOPT_FOLLOWLOCATION, 1L);
623  // 3 redirects seem to be too few in some cases (bnc #465532)
624  SET_OPTION(CURLOPT_MAXREDIRS, 6L);
625 
626  if ( _url.getScheme() == "https" )
627  {
628 #if CURLVERSION_AT_LEAST(7,19,4)
629  // restrict following of redirections from https to https only
630  SET_OPTION( CURLOPT_REDIR_PROTOCOLS, CURLPROTO_HTTPS );
631 #endif
632 
635  {
636  SET_OPTION(CURLOPT_CAPATH, _settings.certificateAuthoritiesPath().c_str());
637  }
638 
639  if( ! _settings.clientCertificatePath().empty() )
640  {
641  SET_OPTION(CURLOPT_SSLCERT, _settings.clientCertificatePath().c_str());
642  }
643  if( ! _settings.clientKeyPath().empty() )
644  {
645  SET_OPTION(CURLOPT_SSLKEY, _settings.clientKeyPath().c_str());
646  }
647 
648 #ifdef CURLSSLOPT_ALLOW_BEAST
649  // see bnc#779177
650  ret = curl_easy_setopt( _curl, CURLOPT_SSL_OPTIONS, CURLSSLOPT_ALLOW_BEAST );
651  if ( ret != 0 ) {
652  disconnectFrom();
654  }
655 #endif
656  SET_OPTION(CURLOPT_SSL_VERIFYPEER, _settings.verifyPeerEnabled() ? 1L : 0L);
657  SET_OPTION(CURLOPT_SSL_VERIFYHOST, _settings.verifyHostEnabled() ? 2L : 0L);
658  // bnc#903405 - POODLE: libzypp should only talk TLS
659  SET_OPTION(CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1);
660  }
661 
662  SET_OPTION(CURLOPT_USERAGENT, _settings.userAgentString().c_str() );
663 
664  /*---------------------------------------------------------------*
665  CURLOPT_USERPWD: [user name]:[password]
666 
667  Url::username/password -> CURLOPT_USERPWD
668  If not provided, anonymous FTP identification
669  *---------------------------------------------------------------*/
670 
671  if ( _settings.userPassword().size() )
672  {
673  SET_OPTION(CURLOPT_USERPWD, _settings.userPassword().c_str());
674  string use_auth = _settings.authType();
675  if (use_auth.empty())
676  use_auth = "digest,basic"; // our default
677  long auth = CurlAuthData::auth_type_str2long(use_auth);
678  if( auth != CURLAUTH_NONE)
679  {
680  DBG << "Enabling HTTP authentication methods: " << use_auth
681  << " (CURLOPT_HTTPAUTH=" << auth << ")" << std::endl;
682  SET_OPTION(CURLOPT_HTTPAUTH, auth);
683  }
684  }
685 
686  if ( _settings.proxyEnabled() && ! _settings.proxy().empty() )
687  {
688  DBG << "Proxy: '" << _settings.proxy() << "'" << endl;
689  SET_OPTION(CURLOPT_PROXY, _settings.proxy().c_str());
690  SET_OPTION(CURLOPT_PROXYAUTH, CURLAUTH_BASIC|CURLAUTH_DIGEST|CURLAUTH_NTLM );
691  /*---------------------------------------------------------------*
692  * CURLOPT_PROXYUSERPWD: [user name]:[password]
693  *
694  * Url::option(proxyuser and proxypassword) -> CURLOPT_PROXYUSERPWD
695  * If not provided, $HOME/.curlrc is evaluated
696  *---------------------------------------------------------------*/
697 
698  string proxyuserpwd = _settings.proxyUserPassword();
699 
700  if ( proxyuserpwd.empty() )
701  {
702  CurlConfig curlconf;
703  CurlConfig::parseConfig(curlconf); // parse ~/.curlrc
704  if ( curlconf.proxyuserpwd.empty() )
705  DBG << "Proxy: ~/.curlrc does not contain the proxy-user option" << endl;
706  else
707  {
708  proxyuserpwd = curlconf.proxyuserpwd;
709  DBG << "Proxy: using proxy-user from ~/.curlrc" << endl;
710  }
711  }
712  else
713  {
714  DBG << "Proxy: using provided proxy-user '" << _settings.proxyUsername() << "'" << endl;
715  }
716 
717  if ( ! proxyuserpwd.empty() )
718  {
719  SET_OPTION(CURLOPT_PROXYUSERPWD, unEscape( proxyuserpwd ).c_str());
720  }
721  }
722 #if CURLVERSION_AT_LEAST(7,19,4)
723  else if ( _settings.proxy() == EXPLICITLY_NO_PROXY )
724  {
725  // Explicitly disabled in URL (see fillSettingsFromUrl()).
726  // This should also prevent libcurl from looking into the environment.
727  DBG << "Proxy: explicitly NOPROXY" << endl;
728  SET_OPTION(CURLOPT_NOPROXY, "*");
729  }
730 #endif
731  else
732  {
733  DBG << "Proxy: not explicitly set" << endl;
734  DBG << "Proxy: libcurl may look into the environment" << endl;
735  }
736 
738  if ( _settings.minDownloadSpeed() != 0 )
739  {
740  SET_OPTION(CURLOPT_LOW_SPEED_LIMIT, _settings.minDownloadSpeed());
741  // default to 10 seconds at low speed
742  SET_OPTION(CURLOPT_LOW_SPEED_TIME, 60L);
743  }
744 
745 #if CURLVERSION_AT_LEAST(7,15,5)
746  if ( _settings.maxDownloadSpeed() != 0 )
747  SET_OPTION_OFFT(CURLOPT_MAX_RECV_SPEED_LARGE, _settings.maxDownloadSpeed());
748 #endif
749 
750  /*---------------------------------------------------------------*
751  *---------------------------------------------------------------*/
752 
753  _currentCookieFile = _cookieFile.asString();
754  if ( str::strToBool( _url.getQueryParam( "cookies" ), true ) )
755  SET_OPTION(CURLOPT_COOKIEFILE, _currentCookieFile.c_str() );
756  else
757  MIL << "No cookies requested" << endl;
758  SET_OPTION(CURLOPT_COOKIEJAR, _currentCookieFile.c_str() );
759  SET_OPTION(CURLOPT_PROGRESSFUNCTION, &progressCallback );
760  SET_OPTION(CURLOPT_NOPROGRESS, 0L);
761 
762 #if CURLVERSION_AT_LEAST(7,18,0)
763  // bnc #306272
764  SET_OPTION(CURLOPT_PROXY_TRANSFER_MODE, 1L );
765 #endif
766  // append settings custom headers to curl
767  for ( TransferSettings::Headers::const_iterator it = vol_settings.headersBegin();
768  it != vol_settings.headersEnd();
769  ++it )
770  {
771  // MIL << "HEADER " << *it << std::endl;
772 
773  _customHeaders = curl_slist_append(_customHeaders, it->c_str());
774  if ( !_customHeaders )
776  }
777 
778  SET_OPTION(CURLOPT_HTTPHEADER, _customHeaders);
779 }
780 
782 
783 
784 void MediaCurl::attachTo (bool next)
785 {
786  if ( next )
788 
789  if ( !_url.isValid() )
791 
794  {
795  std::string mountpoint = createAttachPoint().asString();
796 
797  if( mountpoint.empty())
799 
800  setAttachPoint( mountpoint, true);
801  }
802 
803  disconnectFrom(); // clean _curl if needed
804  _curl = curl_easy_init();
805  if ( !_curl ) {
807  }
808  try
809  {
810  setupEasy();
811  }
812  catch (Exception & ex)
813  {
814  disconnectFrom();
815  ZYPP_RETHROW(ex);
816  }
817 
818  // FIXME: need a derived class to propelly compare url's
820  setMediaSource(media);
821 }
822 
823 bool
824 MediaCurl::checkAttachPoint(const Pathname &apoint) const
825 {
826  return MediaHandler::checkAttachPoint( apoint, true, true);
827 }
828 
830 
832 {
833  if ( _customHeaders )
834  {
835  curl_slist_free_all(_customHeaders);
836  _customHeaders = 0L;
837  }
838 
839  if ( _curl )
840  {
841  curl_easy_cleanup( _curl );
842  _curl = NULL;
843  }
844 }
845 
847 
848 void MediaCurl::releaseFrom( const std::string & ejectDev )
849 {
850  disconnect();
851 }
852 
853 Url MediaCurl::getFileUrl( const Pathname & filename_r ) const
854 {
855  // Simply extend the URLs pathname. An 'absolute' URL path
856  // is achieved by encoding the leading '/' in an URL path:
857  // URL: ftp://user@server -> ~user
858  // URL: ftp://user@server/ -> ~user
859  // URL: ftp://user@server// -> ~user
860  // URL: ftp://user@server/%2F -> /
861  // ^- this '/' is just a separator
862  Url newurl( _url );
863  newurl.setPathName( ( Pathname("./"+_url.getPathName()) / filename_r ).asString().substr(1) );
864  return newurl;
865 }
866 
868 
869 void MediaCurl::getFile( const Pathname & filename ) const
870 {
871  // Use absolute file name to prevent access of files outside of the
872  // hierarchy below the attach point.
873  getFileCopy(filename, localPath(filename).absolutename());
874 }
875 
877 
878 void MediaCurl::getFileCopy( const Pathname & filename , const Pathname & target) const
879 {
881 
882  Url fileurl(getFileUrl(filename));
883 
884  bool retry = false;
885 
886  do
887  {
888  try
889  {
890  doGetFileCopy(filename, target, report);
891  retry = false;
892  }
893  // retry with proper authentication data
894  catch (MediaUnauthorizedException & ex_r)
895  {
896  if(authenticate(ex_r.hint(), !retry))
897  retry = true;
898  else
899  {
900  report->finish(fileurl, zypp::media::DownloadProgressReport::ACCESS_DENIED, ex_r.asUserHistory());
901  ZYPP_RETHROW(ex_r);
902  }
903  }
904  // unexpected exception
905  catch (MediaException & excpt_r)
906  {
907  // FIXME: error number fix
908  report->finish(fileurl, zypp::media::DownloadProgressReport::ERROR, excpt_r.asUserHistory());
909  ZYPP_RETHROW(excpt_r);
910  }
911  }
912  while (retry);
913 
914  report->finish(fileurl, zypp::media::DownloadProgressReport::NO_ERROR, "");
915 }
916 
918 
919 bool MediaCurl::getDoesFileExist( const Pathname & filename ) const
920 {
921  bool retry = false;
922 
923  do
924  {
925  try
926  {
927  return doGetDoesFileExist( filename );
928  }
929  // authentication problem, retry with proper authentication data
930  catch (MediaUnauthorizedException & ex_r)
931  {
932  if(authenticate(ex_r.hint(), !retry))
933  retry = true;
934  else
935  ZYPP_RETHROW(ex_r);
936  }
937  // unexpected exception
938  catch (MediaException & excpt_r)
939  {
940  ZYPP_RETHROW(excpt_r);
941  }
942  }
943  while (retry);
944 
945  return false;
946 }
947 
949 
950 void MediaCurl::evaluateCurlCode( const Pathname &filename,
951  CURLcode code,
952  bool timeout_reached ) const
953 {
954  if ( code != 0 )
955  {
956  Url url;
957  if (filename.empty())
958  url = _url;
959  else
960  url = getFileUrl(filename);
961  std::string err;
962  try
963  {
964  switch ( code )
965  {
966  case CURLE_UNSUPPORTED_PROTOCOL:
967  case CURLE_URL_MALFORMAT:
968  case CURLE_URL_MALFORMAT_USER:
969  err = " Bad URL";
970  break;
971  case CURLE_LOGIN_DENIED:
972  ZYPP_THROW(
973  MediaUnauthorizedException(url, "Login failed.", _curlError, ""));
974  break;
975  case CURLE_HTTP_RETURNED_ERROR:
976  {
977  long httpReturnCode = 0;
978  CURLcode infoRet = curl_easy_getinfo( _curl,
979  CURLINFO_RESPONSE_CODE,
980  &httpReturnCode );
981  if ( infoRet == CURLE_OK )
982  {
983  string msg = "HTTP response: " + str::numstring( httpReturnCode );
984  switch ( httpReturnCode )
985  {
986  case 401:
987  {
988  string auth_hint = getAuthHint();
989 
990  DBG << msg << " Login failed (URL: " << url.asString() << ")" << std::endl;
991  DBG << "MediaUnauthorizedException auth hint: '" << auth_hint << "'" << std::endl;
992 
994  url, "Login failed.", _curlError, auth_hint
995  ));
996  }
997 
998  case 503: // service temporarily unavailable (bnc #462545)
1000  case 504: // gateway timeout
1002  case 403:
1003  {
1004  string msg403;
1005  if (url.asString().find("novell.com") != string::npos)
1006  msg403 = _("Visit the Novell Customer Center to check whether your registration is valid and has not expired.");
1007  ZYPP_THROW(MediaForbiddenException(url, msg403));
1008  }
1009  case 404:
1011  }
1012 
1013  DBG << msg << " (URL: " << url.asString() << ")" << std::endl;
1015  }
1016  else
1017  {
1018  string msg = "Unable to retrieve HTTP response:";
1019  DBG << msg << " (URL: " << url.asString() << ")" << std::endl;
1021  }
1022  }
1023  break;
1024  case CURLE_FTP_COULDNT_RETR_FILE:
1025 #if CURLVERSION_AT_LEAST(7,16,0)
1026  case CURLE_REMOTE_FILE_NOT_FOUND:
1027 #endif
1028  case CURLE_FTP_ACCESS_DENIED:
1029  case CURLE_TFTP_NOTFOUND:
1030  err = "File not found";
1032  break;
1033  case CURLE_BAD_PASSWORD_ENTERED:
1034  case CURLE_FTP_USER_PASSWORD_INCORRECT:
1035  err = "Login failed";
1036  break;
1037  case CURLE_COULDNT_RESOLVE_PROXY:
1038  case CURLE_COULDNT_RESOLVE_HOST:
1039  case CURLE_COULDNT_CONNECT:
1040  case CURLE_FTP_CANT_GET_HOST:
1041  err = "Connection failed";
1042  break;
1043  case CURLE_WRITE_ERROR:
1044  err = "Write error";
1045  break;
1046  case CURLE_PARTIAL_FILE:
1047  case CURLE_OPERATION_TIMEDOUT:
1048  timeout_reached = true; // fall though to TimeoutException
1049  // fall though...
1050  case CURLE_ABORTED_BY_CALLBACK:
1051  if( timeout_reached )
1052  {
1053  err = "Timeout reached";
1055  }
1056  else
1057  {
1058  err = "User abort";
1059  }
1060  break;
1061  case CURLE_SSL_PEER_CERTIFICATE:
1062  default:
1063  err = "Unrecognized error";
1064  break;
1065  }
1066 
1067  // uhm, no 0 code but unknown curl exception
1069  }
1070  catch (const MediaException & excpt_r)
1071  {
1072  ZYPP_RETHROW(excpt_r);
1073  }
1074  }
1075  else
1076  {
1077  // actually the code is 0, nothing happened
1078  }
1079 }
1080 
1082 
1083 bool MediaCurl::doGetDoesFileExist( const Pathname & filename ) const
1084 {
1085  DBG << filename.asString() << endl;
1086 
1087  if(!_url.isValid())
1089 
1090  if(_url.getHost().empty())
1092 
1093  Url url(getFileUrl(filename));
1094 
1095  DBG << "URL: " << url.asString() << endl;
1096  // Use URL without options and without username and passwd
1097  // (some proxies dislike them in the URL).
1098  // Curl seems to need the just scheme, hostname and a path;
1099  // the rest was already passed as curl options (in attachTo).
1100  Url curlUrl( clearQueryString(url) );
1101 
1102  //
1103  // See also Bug #154197 and ftp url definition in RFC 1738:
1104  // The url "ftp://user@host/foo/bar/file" contains a path,
1105  // that is relative to the user's home.
1106  // The url "ftp://user@host//foo/bar/file" (or also with
1107  // encoded slash as %2f) "ftp://user@host/%2ffoo/bar/file"
1108  // contains an absolute path.
1109  //
1110  string urlBuffer( curlUrl.asString());
1111  CURLcode ret = curl_easy_setopt( _curl, CURLOPT_URL,
1112  urlBuffer.c_str() );
1113  if ( ret != 0 ) {
1115  }
1116 
1117  // instead of returning no data with NOBODY, we return
1118  // little data, that works with broken servers, and
1119  // works for ftp as well, because retrieving only headers
1120  // ftp will return always OK code ?
1121  // See http://curl.haxx.se/docs/knownbugs.html #58
1122  if ( (_url.getScheme() == "http" || _url.getScheme() == "https") &&
1124  ret = curl_easy_setopt( _curl, CURLOPT_NOBODY, 1L );
1125  else
1126  ret = curl_easy_setopt( _curl, CURLOPT_RANGE, "0-1" );
1127 
1128  if ( ret != 0 ) {
1129  curl_easy_setopt( _curl, CURLOPT_NOBODY, 0L);
1130  curl_easy_setopt( _curl, CURLOPT_RANGE, NULL );
1131  /* yes, this is why we never got to get NOBODY working before,
1132  because setting it changes this option too, and we also
1133  need to reset it
1134  See: http://curl.haxx.se/mail/archive-2005-07/0073.html
1135  */
1136  curl_easy_setopt( _curl, CURLOPT_HTTPGET, 1L );
1138  }
1139 
1140  FILE *file = ::fopen( "/dev/null", "w" );
1141  if ( !file ) {
1142  ERR << "fopen failed for /dev/null" << endl;
1143  curl_easy_setopt( _curl, CURLOPT_NOBODY, 0L);
1144  curl_easy_setopt( _curl, CURLOPT_RANGE, NULL );
1145  /* yes, this is why we never got to get NOBODY working before,
1146  because setting it changes this option too, and we also
1147  need to reset it
1148  See: http://curl.haxx.se/mail/archive-2005-07/0073.html
1149  */
1150  curl_easy_setopt( _curl, CURLOPT_HTTPGET, 1L );
1151  if ( ret != 0 ) {
1153  }
1154  ZYPP_THROW(MediaWriteException("/dev/null"));
1155  }
1156 
1157  ret = curl_easy_setopt( _curl, CURLOPT_WRITEDATA, file );
1158  if ( ret != 0 ) {
1159  ::fclose(file);
1160  std::string err( _curlError);
1161  curl_easy_setopt( _curl, CURLOPT_RANGE, NULL );
1162  curl_easy_setopt( _curl, CURLOPT_NOBODY, 0L);
1163  /* yes, this is why we never got to get NOBODY working before,
1164  because setting it changes this option too, and we also
1165  need to reset it
1166  See: http://curl.haxx.se/mail/archive-2005-07/0073.html
1167  */
1168  curl_easy_setopt( _curl, CURLOPT_HTTPGET, 1L );
1169  if ( ret != 0 ) {
1171  }
1173  }
1174 
1175  CURLcode ok = curl_easy_perform( _curl );
1176  MIL << "perform code: " << ok << " [ " << curl_easy_strerror(ok) << " ]" << endl;
1177 
1178  // reset curl settings
1179  if ( _url.getScheme() == "http" || _url.getScheme() == "https" )
1180  {
1181  curl_easy_setopt( _curl, CURLOPT_NOBODY, 0L);
1182  if ( ret != 0 ) {
1184  }
1185 
1186  /* yes, this is why we never got to get NOBODY working before,
1187  because setting it changes this option too, and we also
1188  need to reset it
1189  See: http://curl.haxx.se/mail/archive-2005-07/0073.html
1190  */
1191  curl_easy_setopt( _curl, CURLOPT_HTTPGET, 1L);
1192  if ( ret != 0 ) {
1194  }
1195 
1196  }
1197  else
1198  {
1199  // for FTP we set different options
1200  curl_easy_setopt( _curl, CURLOPT_RANGE, NULL);
1201  if ( ret != 0 ) {
1203  }
1204  }
1205 
1206  // if the code is not zero, close the file
1207  if ( ok != 0 )
1208  ::fclose(file);
1209 
1210  // as we are not having user interaction, the user can't cancel
1211  // the file existence checking, a callback or timeout return code
1212  // will be always a timeout.
1213  try {
1214  evaluateCurlCode( filename, ok, true /* timeout */);
1215  }
1216  catch ( const MediaFileNotFoundException &e ) {
1217  // if the file did not exist then we can return false
1218  return false;
1219  }
1220  catch ( const MediaException &e ) {
1221  // some error, we are not sure about file existence, rethrw
1222  ZYPP_RETHROW(e);
1223  }
1224  // exists
1225  return ( ok == CURLE_OK );
1226 }
1227 
1229 
1230 
1231 #if DETECT_DIR_INDEX
1232 bool MediaCurl::detectDirIndex() const
1233 {
1234  if(_url.getScheme() != "http" && _url.getScheme() != "https")
1235  return false;
1236  //
1237  // try to check the effective url and set the not_a_file flag
1238  // if the url path ends with a "/", what usually means, that
1239  // we've received a directory index (index.html content).
1240  //
1241  // Note: This may be dangerous and break file retrieving in
1242  // case of some server redirections ... ?
1243  //
1244  bool not_a_file = false;
1245  char *ptr = NULL;
1246  CURLcode ret = curl_easy_getinfo( _curl,
1247  CURLINFO_EFFECTIVE_URL,
1248  &ptr);
1249  if ( ret == CURLE_OK && ptr != NULL)
1250  {
1251  try
1252  {
1253  Url eurl( ptr);
1254  std::string path( eurl.getPathName());
1255  if( !path.empty() && path != "/" && *path.rbegin() == '/')
1256  {
1257  DBG << "Effective url ("
1258  << eurl
1259  << ") seems to provide the index of a directory"
1260  << endl;
1261  not_a_file = true;
1262  }
1263  }
1264  catch( ... )
1265  {}
1266  }
1267  return not_a_file;
1268 }
1269 #endif
1270 
1272 
1273 void MediaCurl::doGetFileCopy( const Pathname & filename , const Pathname & target, callback::SendReport<DownloadProgressReport> & report, RequestOptions options ) const
1274 {
1275  Pathname dest = target.absolutename();
1276  if( assert_dir( dest.dirname() ) )
1277  {
1278  DBG << "assert_dir " << dest.dirname() << " failed" << endl;
1279  Url url(getFileUrl(filename));
1280  ZYPP_THROW( MediaSystemException(url, "System error on " + dest.dirname().asString()) );
1281  }
1282  string destNew = target.asString() + ".new.zypp.XXXXXX";
1283  char *buf = ::strdup( destNew.c_str());
1284  if( !buf)
1285  {
1286  ERR << "out of memory for temp file name" << endl;
1287  Url url(getFileUrl(filename));
1288  ZYPP_THROW(MediaSystemException(url, "out of memory for temp file name"));
1289  }
1290 
1291  int tmp_fd = ::mkostemp( buf, O_CLOEXEC );
1292  if( tmp_fd == -1)
1293  {
1294  free( buf);
1295  ERR << "mkstemp failed for file '" << destNew << "'" << endl;
1296  ZYPP_THROW(MediaWriteException(destNew));
1297  }
1298  destNew = buf;
1299  free( buf);
1300 
1301  FILE *file = ::fdopen( tmp_fd, "we" );
1302  if ( !file ) {
1303  ::close( tmp_fd);
1304  filesystem::unlink( destNew );
1305  ERR << "fopen failed for file '" << destNew << "'" << endl;
1306  ZYPP_THROW(MediaWriteException(destNew));
1307  }
1308 
1309  DBG << "dest: " << dest << endl;
1310  DBG << "temp: " << destNew << endl;
1311 
1312  // set IFMODSINCE time condition (no download if not modified)
1313  if( PathInfo(target).isExist() && !(options & OPTION_NO_IFMODSINCE) )
1314  {
1315  curl_easy_setopt(_curl, CURLOPT_TIMECONDITION, CURL_TIMECOND_IFMODSINCE);
1316  curl_easy_setopt(_curl, CURLOPT_TIMEVALUE, (long)PathInfo(target).mtime());
1317  }
1318  else
1319  {
1320  curl_easy_setopt(_curl, CURLOPT_TIMECONDITION, CURL_TIMECOND_NONE);
1321  curl_easy_setopt(_curl, CURLOPT_TIMEVALUE, 0L);
1322  }
1323  try
1324  {
1325  doGetFileCopyFile(filename, dest, file, report, options);
1326  }
1327  catch (Exception &e)
1328  {
1329  ::fclose( file );
1330  filesystem::unlink( destNew );
1331  curl_easy_setopt(_curl, CURLOPT_TIMECONDITION, CURL_TIMECOND_NONE);
1332  curl_easy_setopt(_curl, CURLOPT_TIMEVALUE, 0L);
1333  ZYPP_RETHROW(e);
1334  }
1335 
1336  long httpReturnCode = 0;
1337  CURLcode infoRet = curl_easy_getinfo(_curl,
1338  CURLINFO_RESPONSE_CODE,
1339  &httpReturnCode);
1340  bool modified = true;
1341  if (infoRet == CURLE_OK)
1342  {
1343  DBG << "HTTP response: " + str::numstring(httpReturnCode);
1344  if ( httpReturnCode == 304
1345  || ( httpReturnCode == 213 && (_url.getScheme() == "ftp" || _url.getScheme() == "tftp") ) ) // not modified
1346  {
1347  DBG << " Not modified.";
1348  modified = false;
1349  }
1350  DBG << endl;
1351  }
1352  else
1353  {
1354  WAR << "Could not get the reponse code." << endl;
1355  }
1356 
1357  if (modified || infoRet != CURLE_OK)
1358  {
1359  // apply umask
1360  if ( ::fchmod( ::fileno(file), filesystem::applyUmaskTo( 0644 ) ) )
1361  {
1362  ERR << "Failed to chmod file " << destNew << endl;
1363  }
1364  if (::fclose( file ))
1365  {
1366  ERR << "Fclose failed for file '" << destNew << "'" << endl;
1367  ZYPP_THROW(MediaWriteException(destNew));
1368  }
1369  // move the temp file into dest
1370  if ( rename( destNew, dest ) != 0 ) {
1371  ERR << "Rename failed" << endl;
1373  }
1374  }
1375  else
1376  {
1377  // close and remove the temp file
1378  ::fclose( file );
1379  filesystem::unlink( destNew );
1380  }
1381 
1382  DBG << "done: " << PathInfo(dest) << endl;
1383 }
1384 
1386 
1387 void MediaCurl::doGetFileCopyFile( const Pathname & filename , const Pathname & dest, FILE *file, callback::SendReport<DownloadProgressReport> & report, RequestOptions options ) const
1388 {
1389  DBG << filename.asString() << endl;
1390 
1391  if(!_url.isValid())
1393 
1394  if(_url.getHost().empty())
1396 
1397  Url url(getFileUrl(filename));
1398 
1399  DBG << "URL: " << url.asString() << endl;
1400  // Use URL without options and without username and passwd
1401  // (some proxies dislike them in the URL).
1402  // Curl seems to need the just scheme, hostname and a path;
1403  // the rest was already passed as curl options (in attachTo).
1404  Url curlUrl( clearQueryString(url) );
1405 
1406  //
1407  // See also Bug #154197 and ftp url definition in RFC 1738:
1408  // The url "ftp://user@host/foo/bar/file" contains a path,
1409  // that is relative to the user's home.
1410  // The url "ftp://user@host//foo/bar/file" (or also with
1411  // encoded slash as %2f) "ftp://user@host/%2ffoo/bar/file"
1412  // contains an absolute path.
1413  //
1414  string urlBuffer( curlUrl.asString());
1415  CURLcode ret = curl_easy_setopt( _curl, CURLOPT_URL,
1416  urlBuffer.c_str() );
1417  if ( ret != 0 ) {
1419  }
1420 
1421  ret = curl_easy_setopt( _curl, CURLOPT_WRITEDATA, file );
1422  if ( ret != 0 ) {
1424  }
1425 
1426  // Set callback and perform.
1427  ProgressData progressData(_curl, _settings.timeout(), url, &report);
1428  if (!(options & OPTION_NO_REPORT_START))
1429  report->start(url, dest);
1430  if ( curl_easy_setopt( _curl, CURLOPT_PROGRESSDATA, &progressData ) != 0 ) {
1431  WAR << "Can't set CURLOPT_PROGRESSDATA: " << _curlError << endl;;
1432  }
1433 
1434  ret = curl_easy_perform( _curl );
1435 #if CURLVERSION_AT_LEAST(7,19,4)
1436  // bnc#692260: If the client sends a request with an If-Modified-Since header
1437  // with a future date for the server, the server may respond 200 sending a
1438  // zero size file.
1439  // curl-7.19.4 introduces CURLINFO_CONDITION_UNMET to check this condition.
1440  if ( ftell(file) == 0 && ret == 0 )
1441  {
1442  long httpReturnCode = 33;
1443  if ( curl_easy_getinfo( _curl, CURLINFO_RESPONSE_CODE, &httpReturnCode ) == CURLE_OK && httpReturnCode == 200 )
1444  {
1445  long conditionUnmet = 33;
1446  if ( curl_easy_getinfo( _curl, CURLINFO_CONDITION_UNMET, &conditionUnmet ) == CURLE_OK && conditionUnmet )
1447  {
1448  WAR << "TIMECONDITION unmet - retry without." << endl;
1449  curl_easy_setopt(_curl, CURLOPT_TIMECONDITION, CURL_TIMECOND_NONE);
1450  curl_easy_setopt(_curl, CURLOPT_TIMEVALUE, 0L);
1451  ret = curl_easy_perform( _curl );
1452  }
1453  }
1454  }
1455 #endif
1456 
1457  if ( curl_easy_setopt( _curl, CURLOPT_PROGRESSDATA, NULL ) != 0 ) {
1458  WAR << "Can't unset CURLOPT_PROGRESSDATA: " << _curlError << endl;;
1459  }
1460 
1461  if ( ret != 0 )
1462  {
1463  ERR << "curl error: " << ret << ": " << _curlError
1464  << ", temp file size " << ftell(file)
1465  << " bytes." << endl;
1466 
1467  // the timeout is determined by the progress data object
1468  // which holds whether the timeout was reached or not,
1469  // otherwise it would be a user cancel
1470  try {
1471  evaluateCurlCode( filename, ret, progressData.reached);
1472  }
1473  catch ( const MediaException &e ) {
1474  // some error, we are not sure about file existence, rethrw
1475  ZYPP_RETHROW(e);
1476  }
1477  }
1478 
1479 #if DETECT_DIR_INDEX
1480  if (!ret && detectDirIndex())
1481  {
1483  }
1484 #endif // DETECT_DIR_INDEX
1485 }
1486 
1488 
1489 void MediaCurl::getDir( const Pathname & dirname, bool recurse_r ) const
1490 {
1491  filesystem::DirContent content;
1492  getDirInfo( content, dirname, /*dots*/false );
1493 
1494  for ( filesystem::DirContent::const_iterator it = content.begin(); it != content.end(); ++it ) {
1495  Pathname filename = dirname + it->name;
1496  int res = 0;
1497 
1498  switch ( it->type ) {
1499  case filesystem::FT_NOT_AVAIL: // old directory.yast contains no typeinfo at all
1500  case filesystem::FT_FILE:
1501  getFile( filename );
1502  break;
1503  case filesystem::FT_DIR: // newer directory.yast contain at least directory info
1504  if ( recurse_r ) {
1505  getDir( filename, recurse_r );
1506  } else {
1507  res = assert_dir( localPath( filename ) );
1508  if ( res ) {
1509  WAR << "Ignore error (" << res << ") on creating local directory '" << localPath( filename ) << "'" << endl;
1510  }
1511  }
1512  break;
1513  default:
1514  // don't provide devices, sockets, etc.
1515  break;
1516  }
1517  }
1518 }
1519 
1521 
1522 void MediaCurl::getDirInfo( std::list<std::string> & retlist,
1523  const Pathname & dirname, bool dots ) const
1524 {
1525  getDirectoryYast( retlist, dirname, dots );
1526 }
1527 
1529 
1531  const Pathname & dirname, bool dots ) const
1532 {
1533  getDirectoryYast( retlist, dirname, dots );
1534 }
1535 
1537 
1538 int MediaCurl::progressCallback( void *clientp,
1539  double dltotal, double dlnow,
1540  double ultotal, double ulnow)
1541 {
1542  ProgressData *pdata = reinterpret_cast<ProgressData *>(clientp);
1543  if( pdata)
1544  {
1545  // work around curl bug that gives us old data
1546  long httpReturnCode = 0;
1547  if (curl_easy_getinfo(pdata->curl, CURLINFO_RESPONSE_CODE, &httpReturnCode) != CURLE_OK || httpReturnCode == 0)
1548  return 0;
1549 
1550  time_t now = time(NULL);
1551  if( now > 0)
1552  {
1553  // reset time of last change in case initial time()
1554  // failed or the time was adjusted (goes backward)
1555  if( pdata->ltime <= 0 || pdata->ltime > now)
1556  {
1557  pdata->ltime = now;
1558  }
1559 
1560  // start time counting as soon as first data arrives
1561  // (skip the connection / redirection time at begin)
1562  time_t dif = 0;
1563  if (dlnow > 0 || ulnow > 0)
1564  {
1565  dif = (now - pdata->ltime);
1566  dif = dif > 0 ? dif : 0;
1567 
1568  pdata->secs += dif;
1569  }
1570 
1571  // update the drate_avg and drate_period only after a second has passed
1572  // (this callback is called much more often than a second)
1573  // otherwise the values would be far from accurate when measuring
1574  // the time in seconds
1576 
1577  if ( pdata->secs > 1 && (dif > 0 || dlnow == dltotal ))
1578  pdata->drate_avg = (dlnow / pdata->secs);
1579 
1580  if ( dif > 0 )
1581  {
1582  pdata->drate_period = ((dlnow - pdata->dload_period) / dif);
1583  pdata->dload_period = dlnow;
1584  }
1585  }
1586 
1587  // send progress report first, abort transfer if requested
1588  if( pdata->report)
1589  {
1590  if (!(*(pdata->report))->progress(int( dltotal ? dlnow * 100 / dltotal : 0 ),
1591  pdata->url,
1592  pdata->drate_avg,
1593  pdata->drate_period))
1594  {
1595  return 1; // abort transfer
1596  }
1597  }
1598 
1599  // check if we there is a timeout set
1600  if( pdata->timeout > 0)
1601  {
1602  if( now > 0)
1603  {
1604  bool progress = false;
1605 
1606  // update download data if changed, mark progress
1607  if( dlnow != pdata->dload)
1608  {
1609  progress = true;
1610  pdata->dload = dlnow;
1611  pdata->ltime = now;
1612  }
1613  // update upload data if changed, mark progress
1614  if( ulnow != pdata->uload)
1615  {
1616  progress = true;
1617  pdata->uload = ulnow;
1618  pdata->ltime = now;
1619  }
1620 
1621  if( !progress && (now >= (pdata->ltime + pdata->timeout)))
1622  {
1623  pdata->reached = true;
1624  return 1; // aborts transfer
1625  }
1626  }
1627  }
1628  }
1629  return 0;
1630 }
1631 
1633 {
1634  ProgressData *pdata = reinterpret_cast<ProgressData *>(clientp);
1635  return pdata ? pdata->curl : 0;
1636 }
1637 
1639 
1641 {
1642  long auth_info = CURLAUTH_NONE;
1643 
1644  CURLcode infoRet =
1645  curl_easy_getinfo(_curl, CURLINFO_HTTPAUTH_AVAIL, &auth_info);
1646 
1647  if(infoRet == CURLE_OK)
1648  {
1649  return CurlAuthData::auth_type_long2str(auth_info);
1650  }
1651 
1652  return "";
1653 }
1654 
1656 
1657 bool MediaCurl::authenticate(const string & availAuthTypes, bool firstTry) const
1658 {
1660  Target_Ptr target = zypp::getZYpp()->getTarget();
1661  CredentialManager cm(CredManagerOptions(target ? target->root() : ""));
1662  CurlAuthData_Ptr credentials;
1663 
1664  // get stored credentials
1665  AuthData_Ptr cmcred = cm.getCred(_url);
1666 
1667  if (cmcred && firstTry)
1668  {
1669  credentials.reset(new CurlAuthData(*cmcred));
1670  DBG << "got stored credentials:" << endl << *credentials << endl;
1671  }
1672  // if not found, ask user
1673  else
1674  {
1675 
1676  CurlAuthData_Ptr curlcred;
1677  curlcred.reset(new CurlAuthData());
1679 
1680  // preset the username if present in current url
1681  if (!_url.getUsername().empty() && firstTry)
1682  curlcred->setUsername(_url.getUsername());
1683  // if CM has found some credentials, preset the username from there
1684  else if (cmcred)
1685  curlcred->setUsername(cmcred->username());
1686 
1687  // indicate we have no good credentials from CM
1688  cmcred.reset();
1689 
1690  string prompt_msg = boost::str(boost::format(
1692  _("Authentication required for '%s'")) % _url.asString());
1693 
1694  // set available authentication types from the exception
1695  // might be needed in prompt
1696  curlcred->setAuthType(availAuthTypes);
1697 
1698  // ask user
1699  if (auth_report->prompt(_url, prompt_msg, *curlcred))
1700  {
1701  DBG << "callback answer: retry" << endl
1702  << "CurlAuthData: " << *curlcred << endl;
1703 
1704  if (curlcred->valid())
1705  {
1706  credentials = curlcred;
1707  // if (credentials->username() != _url.getUsername())
1708  // _url.setUsername(credentials->username());
1716  }
1717  }
1718  else
1719  {
1720  DBG << "callback answer: cancel" << endl;
1721  }
1722  }
1723 
1724  // set username and password
1725  if (credentials)
1726  {
1727  // HACK, why is this const?
1728  const_cast<MediaCurl*>(this)->_settings.setUsername(credentials->username());
1729  const_cast<MediaCurl*>(this)->_settings.setPassword(credentials->password());
1730 
1731  // set username and password
1732  CURLcode ret = curl_easy_setopt(_curl, CURLOPT_USERPWD, _settings.userPassword().c_str());
1734 
1735  // set available authentication types from the exception
1736  if (credentials->authType() == CURLAUTH_NONE)
1737  credentials->setAuthType(availAuthTypes);
1738 
1739  // set auth type (seems this must be set _after_ setting the userpwd)
1740  if (credentials->authType() != CURLAUTH_NONE)
1741  {
1742  // FIXME: only overwrite if not empty?
1743  const_cast<MediaCurl*>(this)->_settings.setAuthType(credentials->authTypeAsString());
1744  ret = curl_easy_setopt(_curl, CURLOPT_HTTPAUTH, credentials->authType());
1746  }
1747 
1748  if (!cmcred)
1749  {
1750  credentials->setUrl(_url);
1751  cm.addCred(*credentials);
1752  cm.save();
1753  }
1754 
1755  return true;
1756  }
1757 
1758  return false;
1759 }
1760 
1761 
1762  } // namespace media
1763 } // namespace zypp
1764 //
void setPassword(const std::string &pass, EEncoding eflag=zypp::url::E_DECODED)
Set the password in the URL authority.
Definition: Url.cc:733
std::string userPassword() const
returns the user and password as a user:pass string
int assert_dir(const Pathname &path, unsigned mode)
Like 'mkdir -p'.
Definition: PathInfo.cc:320
Interface to gettext.
void checkProtocol(const Url &url) const
check the url is supported by the curl library
Definition: MediaCurl.cc:530
#define SET_OPTION_OFFT(opt, val)
Definition: MediaCurl.cc:452
#define MIL
Definition: Logger.h:64
#define CONNECT_TIMEOUT
Definition: MediaCurl.cc:43
bool verifyHostEnabled() const
Whether to verify host for ssl.
Pathname clientKeyPath() const
SSL client key file.
#define ZYPP_THROW(EXCPT)
Drops a logline and throws the Exception.
Definition: Exception.h:321
bool authenticate(const std::string &availAuthTypes, bool firstTry) const
Definition: MediaCurl.cc:1657
static ZConfig & instance()
Singleton ctor.
Definition: Resolver.cc:121
virtual void releaseFrom(const std::string &ejectDev)
Call concrete handler to release the media.
Definition: MediaCurl.cc:848
const std::string & msg() const
Return the message string provided to the ctor.
Definition: Exception.h:185
Implementation class for FTP, HTTP and HTTPS MediaHandler.
Definition: MediaCurl.h:32
Flag to request encoded string(s).
Definition: UrlUtils.h:53
long connectTimeout() const
connection timeout
Headers::const_iterator headersEnd() const
end iterators to additional headers
std::string getPathName(EEncoding eflag=zypp::url::E_DECODED) const
Returns the path name from the URL.
Definition: Url.cc:598
void setClientKeyPath(const zypp::Pathname &path)
Sets the SSL client key file.
to not add a IFMODSINCE header if target exists
Definition: MediaCurl.h:44
TransferSettings & settings()
Definition: MediaCurl.cc:517
std::string getHost(EEncoding eflag=zypp::url::E_DECODED) const
Returns the hostname or IP from the URL authority.
Definition: Url.cc:582
Holds transfer setting.
Url clearQueryString(const Url &url) const
Definition: MediaCurl.cc:492
void save()
Saves any unsaved credentials added via addUserCred() or addGlobalCred() methods. ...
std::string escape(const C_Str &str_r, const char sep_r)
Escape desired character c using a backslash.
Definition: String.cc:354
static int progressCallback(void *clientp, double dltotal, double dlnow, double ultotal, double ulnow)
Definition: MediaCurl.cc:1538
void setProxyUsername(const std::string &proxyuser)
sets the proxy user
void setAttachPoint(const Pathname &path, bool temp)
Set a new attach point.
Pathname createAttachPoint() const
Try to create a default / temporary attach point.
Pathname certificateAuthoritiesPath() const
SSL certificate authorities path ( default: /etc/ssl/certs )
void setPathParams(const std::string &params)
Set the path parameters.
Definition: Url.cc:780
void setHeadRequestsAllowed(bool allowed)
set whether HEAD requests are allowed
pthread_once_t OnceFlag
The OnceFlag variable type.
Definition: Once.h:32
std::string getUsername(EEncoding eflag=zypp::url::E_DECODED) const
Returns the username from the URL authority.
Definition: Url.cc:566
long minDownloadSpeed() const
Minimum download speed (bytes per second) until the connection is dropped.
AuthData_Ptr getCred(const Url &url)
Get credentials for the specified url.
void setConnectTimeout(long t)
set the connect timeout
void setUsername(const std::string &user, EEncoding eflag=zypp::url::E_DECODED)
Set the username in the URL authority.
Definition: Url.cc:724
double dload
Definition: MediaCurl.cc:190
virtual void setupEasy()
initializes the curl easy handle with the data from the url
Definition: MediaCurl.cc:555
#define EXPLICITLY_NO_PROXY
Definition: MediaCurl.cc:46
Structure holding values of curlrc options.
Definition: CurlConfig.h:16
bool isValid() const
Verifies the Url.
Definition: Url.cc:483
std::string form(const char *format,...) __attribute__((format(printf
Printf style construction of std::string.
Definition: String.cc:36
Edition * _value
Definition: SysContent.cc:311
virtual bool checkAttachPoint(const Pathname &apoint) const
Verify if the specified directory as attach point (root) as requires by the particular media handler ...
std::string _currentCookieFile
Definition: MediaCurl.h:167
void setProxy(const std::string &proxyhost)
proxy to use if it is enabled
void setFragment(const std::string &fragment, EEncoding eflag=zypp::url::E_DECODED)
Set the fragment string in the URL.
Definition: Url.cc:716
#define ERR
Definition: Logger.h:66
void setPassword(const std::string &password)
sets the auth password
std::string asString() const
Returns a default string representation of the Url object.
Definition: Url.cc:491
void setUsername(const std::string &username)
sets the auth username
bool headRequestsAllowed() const
whether HEAD requests are allowed
void setAnonymousAuth()
sets anonymous authentication (ie: for ftp)
virtual void getFile(const Pathname &filename) const
Call concrete handler to provide file below attach point.
Definition: MediaCurl.cc:869
std::string proxy(const Url &url) const
Definition: ProxyInfo.cc:44
static void setCookieFile(const Pathname &)
Definition: MediaCurl.cc:523
std::string getAuthHint() const
Return a comma separated list of available authentication methods supported by server.
Definition: MediaCurl.cc:1640
#define ZYPP_RETHROW(EXCPT)
Drops a logline and rethrows, updating the CodeLocation.
Definition: Exception.h:329
void setPathName(const std::string &path, EEncoding eflag=zypp::url::E_DECODED)
Set the path name.
Definition: Url.cc:758
static int parseConfig(CurlConfig &config, const std::string &filename="")
Parse a curlrc file and store the result in the config structure.
Definition: CurlConfig.cc:24
void doGetFileCopyFile(const Pathname &srcFilename, const Pathname &dest, FILE *file, callback::SendReport< DownloadProgressReport > &_report, RequestOptions options=OPTION_NONE) const
Definition: MediaCurl.cc:1387
std::string userAgentString() const
user agent string
unsigned split(const C_Str &line_r, TOutputIterator result_r, const C_Str &sepchars_r=" \t")
Split line_r into words.
Definition: String.h:478
void setProxyPassword(const std::string &proxypass)
sets the proxy password
Abstract base class for 'physical' MediaHandler like MediaCD, etc.
Definition: MediaHandler.h:45
void callOnce(OnceFlag &flag, void(*func)())
Call once function.
Definition: Once.h:50
void setAuthType(const std::string &authtype)
set the allowed authentication types
std::string trim(const std::string &s, const Trim trim_r)
Definition: String.cc:213
int unlink(const Pathname &path)
Like 'unlink'.
Definition: PathInfo.cc:653
const Url _url
Url to handle.
Definition: MediaHandler.h:110
virtual bool getDoesFileExist(const Pathname &filename) const
Repeatedly calls doGetDoesFileExist() until it successfully returns, fails unexpectedly, or user cancels the operation.
Definition: MediaCurl.cc:919
void setMediaSource(const MediaSourceRef &ref)
Set new media source reference.
int rename(const Pathname &oldpath, const Pathname &newpath)
Like 'rename'.
Definition: PathInfo.cc:667
Just inherits Exception to separate media exceptions.
long timeout
Definition: MediaCurl.cc:176
void disconnect()
Use concrete handler to isconnect media.
do not send a start ProgressReport
Definition: MediaCurl.h:46
#define WAR
Definition: Logger.h:65
TransferSettings _settings
Definition: MediaCurl.h:174
time_t ltime
Definition: MediaCurl.cc:188
bool reached
Definition: MediaCurl.cc:177
std::list< DirEntry > DirContent
Returned by readdir.
Definition: PathInfo.h:547
bool verifyPeerEnabled() const
Whether to verify peer for ssl.
zypp::Url url
Definition: MediaCurl.cc:193
void setTimeout(long t)
set the transfer timeout
bool useProxyFor(const Url &url_r) const
Return true if enabled and url_r does not match noProxy.
Definition: ProxyInfo.cc:56
#define _(MSG)
Definition: Gettext.h:29
std::string proxyUserPassword() const
returns the proxy user and password as a user:pass string
static const char *const agentString()
initialized only once, this gets the agent string which also includes the curl version ...
Definition: MediaCurl.cc:425
Pathname localPath(const Pathname &pathname) const
Files provided will be available at 'localPath(filename)'.
std::string proxyuserpwd
Definition: CurlConfig.h:39
std::string getQueryParam(const std::string &param, EEncoding eflag=zypp::url::E_DECODED) const
Return the value for the specified query parameter.
Definition: Url.cc:654
bool isUseableAttachPoint(const Pathname &path, bool mtab=true) const
Ask media manager, if the specified path is already used as attach point or if there are another atta...
virtual bool checkAttachPoint(const Pathname &apoint) const
Verify if the specified directory as attach point (root) as requires by the particular media handler ...
Definition: MediaCurl.cc:824
shared_ptr< CurlAuthData > CurlAuthData_Ptr
virtual void getDir(const Pathname &dirname, bool recurse_r) const
Call concrete handler to provide directory content (not recursive!) below attach point.
Definition: MediaCurl.cc:1489
std::string numstring(char n, int w=0)
Definition: String.h:278
virtual void disconnectFrom()
Definition: MediaCurl.cc:831
void getDirectoryYast(std::list< std::string > &retlist, const Pathname &dirname, bool dots=true) const
Retrieve and if available scan dirname/directory.yast.
SolvableIdType size_type
Definition: PoolMember.h:126
bool detectDirIndex() const
Media source internally used by MediaManager and MediaHandler.
Definition: MediaSource.h:36
static std::string auth_type_long2str(long auth_type)
Converts a long of ORed CURLAUTH_* identifiers into a string of comma separated list of authenticatio...
void fillSettingsFromUrl(const Url &url, TransferSettings &s)
Fills the settings structure using options passed on the url for example ?timeout=x&proxy=foo.
Definition: MediaCurl.cc:224
curl_slist * _customHeaders
Definition: MediaCurl.h:173
Headers::const_iterator headersBegin() const
begin iterators to additional headers
void setClientCertificatePath(const zypp::Pathname &path)
Sets the SSL client certificate file.
shared_ptr< AuthData > AuthData_Ptr
Definition: MediaUserAuth.h:69
int rmdir(const Pathname &path)
Like 'rmdir'.
Definition: PathInfo.cc:367
#define SET_OPTION(opt, val)
Definition: MediaCurl.cc:445
Pathname attachPoint() const
Return the currently used attach point.
Url getFileUrl(const Pathname &filename) const
concatenate the attach url and the filename to a complete download url
Definition: MediaCurl.cc:853
Base class for Exception.
Definition: Exception.h:143
virtual void getDirInfo(std::list< std::string > &retlist, const Pathname &dirname, bool dots=true) const
Call concrete handler to provide a content list of directory on media via retlist.
Definition: MediaCurl.cc:1522
const std::string & hint() const
comma separated list of available authentication types
static const char *const distributionFlavorHeader()
initialized only once, this gets the distribution flavor from the target, which we pass in the http h...
Definition: MediaCurl.cc:407
void fillSettingsSystemProxy(const Url &url, TransferSettings &s)
Reads the system proxy configuration and fills the settings structure proxy information.
Definition: MediaCurl.cc:361
callback::SendReport< DownloadProgressReport > * report
Definition: MediaCurl.cc:178
void addHeader(const std::string &header)
add a header, on the form "Foo: Bar"
CURL * curl
Definition: MediaCurl.cc:175
static CURL * progressCallback_getcurl(void *clientp)
Definition: MediaCurl.cc:1632
void setCertificateAuthoritiesPath(const zypp::Pathname &path)
Sets the SSL certificate authorities path.
bool strToBool(const C_Str &str, bool default_r)
Parse str into a bool depending on the default value.
Definition: String.h:404
static long auth_type_str2long(std::string &auth_type_str)
Converts a string of comma separated list of authetication type names into a long of ORed CURLAUTH_* ...
std::string asUserHistory() const
A single (multiline) string composed of asUserString and historyAsString.
Definition: Exception.cc:75
virtual void attachTo(bool next=false)
Call concrete handler to attach the media.
Definition: MediaCurl.cc:784
virtual void getFileCopy(const Pathname &srcFilename, const Pathname &targetFilename) const
Definition: MediaCurl.cc:878
double dload_period
Definition: MediaCurl.cc:182
virtual void doGetFileCopy(const Pathname &srcFilename, const Pathname &targetFilename, callback::SendReport< DownloadProgressReport > &_report, RequestOptions options=OPTION_NONE) const
Definition: MediaCurl.cc:1273
static Pathname _cookieFile
Definition: MediaCurl.h:168
double drate_avg
Definition: MediaCurl.cc:186
mode_t applyUmaskTo(mode_t mode_r)
Modify mode_r according to the current umask ( mode_r & ~getUmask() ).
Definition: PathInfo.h:806
virtual bool doGetDoesFileExist(const Pathname &filename) const
Definition: MediaCurl.cc:1083
std::string getScheme() const
Returns the scheme name of the URL.
Definition: Url.cc:527
std::string authType() const
get the allowed authentication types
double uload
Definition: MediaCurl.cc:192
void addCred(const AuthData &cred)
Add new credentials with user callbacks.
#define TRANSFER_TIMEOUT_MAX
Definition: MediaCurl.cc:44
Curl HTTP authentication data.
Definition: MediaUserAuth.h:74
double drate_period
Definition: MediaCurl.cc:180
char _curlError[CURL_ERROR_SIZE]
Definition: MediaCurl.h:172
void setVerifyPeerEnabled(bool enabled)
Sets whether to verify host for ssl.
Pathname clientCertificatePath() const
SSL client certificate file.
void evaluateCurlCode(const zypp::Pathname &filename, CURLcode code, bool timeout) const
Evaluates a curl return code and throws the right MediaException filename Filename being downloaded c...
Definition: MediaCurl.cc:950
Url url() const
Url used.
Definition: MediaHandler.h:506
std::string proxy() const
proxy host
bool proxyEnabled() const
proxy is enabled
long secs
Definition: MediaCurl.cc:184
Convenience interface for handling authentication data of media user.
void setVerifyHostEnabled(bool enabled)
Sets whether to verify host for ssl.
Url manipulation class.
Definition: Url.h:87
void setUserAgentString(const std::string &agent)
sets the user agent ie: "Mozilla v3"
long maxDownloadSpeed() const
Maximum download speed (bytes per second)
static const char *const anonymousIdHeader()
initialized only once, this gets the anonymous id from the target, which we pass in the http header ...
Definition: MediaCurl.cc:389
void setProxyEnabled(bool enabled)
whether the proxy is used or not
std::string username() const
auth username
#define DBG
Definition: Logger.h:63
std::string getPassword(EEncoding eflag=zypp::url::E_DECODED) const
Returns the password from the URL authority.
Definition: Url.cc:574
void delQueryParam(const std::string &param)
remove the specified query parameter.
Definition: Url.cc:834
std::string proxyUsername() const
proxy auth username
long timeout() const
transfer timeout