libzypp  10.5.0
zypp::media::MediaCurl Class Reference

Implementation class for FTP, HTTP and HTTPS MediaHandler. More...

#include <MediaCurl.h>

Inheritance diagram for zypp::media::MediaCurl:

List of all members.

Classes

class  Callbacks

Public Types

enum  RequestOption {
  OPTION_NONE = 0x0, OPTION_RANGE = 0x1, OPTION_HEAD = 0x02, OPTION_NO_IFMODSINCE = 0x04,
  OPTION_NO_REPORT_START = 0x08
}

Public Member Functions

 ZYPP_DECLARE_FLAGS (RequestOptions, RequestOption)
 MediaCurl (const Url &url_r, const Pathname &attach_point_hint_r)
virtual ~MediaCurl ()
TransferSettingssettings ()

Static Public Member Functions

static void setCookieFile (const Pathname &)

Protected Member Functions

Url clearQueryString (const Url &url) const
virtual void attachTo (bool next=false)
 Call concrete handler to attach the media.
virtual void releaseFrom (const std::string &ejectDev)
 Call concrete handler to release the media.
virtual void getFile (const Pathname &filename) const
 Call concrete handler to provide file below attach point.
virtual void getDir (const Pathname &dirname, bool recurse_r) const
 Call concrete handler to provide directory content (not recursive!) below attach point.
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.
virtual void getDirInfo (filesystem::DirContent &retlist, const Pathname &dirname, bool dots=true) const
 Basically the same as getDirInfo above.
virtual bool getDoesFileExist (const Pathname &filename) const
 Repeatedly calls doGetDoesFileExist() until it successfully returns, fails unexpectedly, or user cancels the operation.
virtual bool doGetDoesFileExist (const Pathname &filename) const
virtual void disconnectFrom ()
virtual void getFileCopy (const Pathname &srcFilename, const Pathname &targetFilename) const
virtual void doGetFileCopy (const Pathname &srcFilename, const Pathname &targetFilename, callback::SendReport< DownloadProgressReport > &_report, RequestOptions options=OPTION_NONE) const
virtual bool checkAttachPoint (const Pathname &apoint) const
 Verify if the specified directory as attach point (root) as requires by the particular media handler implementation.
void checkProtocol (const Url &url) const
 check the url is supported by the curl library
virtual void setupEasy ()
 initializes the curl easy handle with the data from the url
Url getFileUrl (const Pathname &filename) const
 concatenate the attach url and the filename to a complete download url
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 code Code curl returnes timeout Whether we reached timeout, which we need to differentiate in case the codes aborted-by-callback or timeout are returned by curl Otherwise we can't differentiate abort from timeout.
void doGetFileCopyFile (const Pathname &srcFilename, const Pathname &dest, FILE *file, callback::SendReport< DownloadProgressReport > &_report, RequestOptions options=OPTION_NONE) const

Static Protected Member Functions

static int progressCallback (void *clientp, double dltotal, double dlnow, double ultotal, double ulnow)

Protected Attributes

CURL * _curl
char _curlError [CURL_ERROR_SIZE]
curl_slist * _customHeaders
TransferSettings _settings

Private Member Functions

std::string getAuthHint () const
 Return a comma separated list of available authentication methods supported by server.
bool authenticate (const std::string &availAuthTypes, bool firstTry) const
bool detectDirIndex () const

Private Attributes

long _curlDebug
std::string _currentCookieFile

Static Private Attributes

static Pathname _cookieFile = "/var/lib/YaST2/cookies"

Detailed Description

Implementation class for FTP, HTTP and HTTPS MediaHandler.

See also:
MediaHandler

Definition at line 32 of file MediaCurl.h.


Member Enumeration Documentation

Enumerator:
OPTION_NONE 

Defaults.

OPTION_RANGE 

retrieve only a range of the file

OPTION_HEAD 

only issue a HEAD (or equivalent) request

OPTION_NO_IFMODSINCE 

to not add a IFMODSINCE header if target exists

OPTION_NO_REPORT_START 

do not send a start ProgressReport

Definition at line 35 of file MediaCurl.h.


Constructor & Destructor Documentation

zypp::media::MediaCurl::MediaCurl ( const Url url_r,
const Pathname &  attach_point_hint_r 
)

Definition at line 437 of file MediaCurl.cc.

virtual zypp::media::MediaCurl::~MediaCurl ( ) [inline, virtual]

Definition at line 102 of file MediaCurl.h.


Member Function Documentation

zypp::media::MediaCurl::ZYPP_DECLARE_FLAGS ( RequestOptions  ,
RequestOption   
)
Url zypp::media::MediaCurl::clearQueryString ( const Url url) const [protected]

Definition at line 473 of file MediaCurl.cc.

void zypp::media::MediaCurl::attachTo ( bool  next = false) [protected, virtual]

Call concrete handler to attach the media.

Asserted that not already attached, and attachPoint is a directory.

Parameters:
nexttry next available device in turn until end of device list is reached (for media which are accessible through multiple devices like cdroms).
Exceptions:
MediaException

Implements zypp::media::MediaHandler.

Reimplemented in zypp::media::MediaAria2c.

Definition at line 736 of file MediaCurl.cc.

void zypp::media::MediaCurl::releaseFrom ( const std::string &  ejectDev) [protected, virtual]

Call concrete handler to release the media.

If eject is true, and the media is used in one handler instance only, physically eject the media (i.e. CD-ROM).

Asserted that media is attached.

Parameters:
ejectDevDevice to eject. None if empty.
Exceptions:
MediaException

Implements zypp::media::MediaHandler.

Reimplemented in zypp::media::MediaAria2c.

Definition at line 800 of file MediaCurl.cc.

void zypp::media::MediaCurl::getFile ( const Pathname &  filename) const [protected, virtual]

Call concrete handler to provide file below attach point.

Default implementation provided, that returns whether a file is located at 'localRoot + filename'.

Asserted that media is attached.

Exceptions:
MediaException

Implements zypp::media::MediaHandler.

Reimplemented in zypp::media::MediaAria2c.

Definition at line 835 of file MediaCurl.cc.

void zypp::media::MediaCurl::getDir ( const Pathname &  dirname,
bool  recurse_r 
) const [protected, virtual]

Call concrete handler to provide directory content (not recursive!) below attach point.

Return E_not_supported_by_media if media does not support retrieval of directory content.

Default implementation provided, that returns whether a directory is located at 'localRoot + dirname'.

Asserted that media is attached.

Exceptions:
MediaException

Implements zypp::media::MediaHandler.

Reimplemented in zypp::media::MediaAria2c.

Definition at line 1454 of file MediaCurl.cc.

void zypp::media::MediaCurl::getDirInfo ( std::list< std::string > &  retlist,
const Pathname &  dirname,
bool  dots = true 
) const [protected, virtual]

Call concrete handler to provide a content list of directory on media via retlist.

If dots is false entries starting with '.' are not reported.

Return E_not_supported_by_media if media does not support retrieval of directory content.

Default implementation provided, that returns the content of a directory at 'localRoot + dirnname' retrieved via 'readdir'.

Asserted that media is attached and retlist is empty.

Exceptions:
MediaException

Implements zypp::media::MediaHandler.

Reimplemented in zypp::media::MediaAria2c.

Definition at line 1487 of file MediaCurl.cc.

void zypp::media::MediaCurl::getDirInfo ( filesystem::DirContent retlist,
const Pathname &  dirname,
bool  dots = true 
) const [protected, virtual]

Basically the same as getDirInfo above.

The content list is returned as filesystem::DirContent, which includes name and filetype of each directory entry. Retrieving the filetype usg. requires an additional ::stat call for each entry, thus it's more expensive than a simple readdir.

Asserted that media is attached and retlist is empty.

Exceptions:
MediaException

Implements zypp::media::MediaHandler.

Reimplemented in zypp::media::MediaAria2c.

Definition at line 1495 of file MediaCurl.cc.

bool zypp::media::MediaCurl::getDoesFileExist ( const Pathname &  filename) const [protected, virtual]

Repeatedly calls doGetDoesFileExist() until it successfully returns, fails unexpectedly, or user cancels the operation.

This is used to handle authentication or similar retry scenarios on media level.

Implements zypp::media::MediaHandler.

Reimplemented in zypp::media::MediaAria2c.

Definition at line 885 of file MediaCurl.cc.

bool zypp::media::MediaCurl::doGetDoesFileExist ( const Pathname &  filename) const [protected, virtual]
See also:
MediaHandler::getDoesFileExist

Reimplemented in zypp::media::MediaAria2c.

Definition at line 1048 of file MediaCurl.cc.

void zypp::media::MediaCurl::disconnectFrom ( ) [protected, virtual]
Exceptions:
MediaException

Reimplemented from zypp::media::MediaHandler.

Reimplemented in zypp::media::MediaAria2c.

Definition at line 783 of file MediaCurl.cc.

void zypp::media::MediaCurl::getFileCopy ( const Pathname &  srcFilename,
const Pathname &  targetFilename 
) const [protected, virtual]
Exceptions:
MediaException

Reimplemented from zypp::media::MediaHandler.

Reimplemented in zypp::media::MediaAria2c.

Definition at line 844 of file MediaCurl.cc.

void zypp::media::MediaCurl::doGetFileCopy ( const Pathname &  srcFilename,
const Pathname &  targetFilename,
callback::SendReport< DownloadProgressReport > &  _report,
RequestOptions  options = OPTION_NONE 
) const [protected, virtual]
Exceptions:
MediaException

Reimplemented in zypp::media::MediaMultiCurl.

Definition at line 1238 of file MediaCurl.cc.

bool zypp::media::MediaCurl::checkAttachPoint ( const Pathname &  apoint) const [protected, virtual]

Verify if the specified directory as attach point (root) as requires by the particular media handler implementation.

Parameters:
apointThe directory to check.
Returns:
True, if the directory checks succeeded.

Reimplemented from zypp::media::MediaHandler.

Reimplemented in zypp::media::MediaAria2c.

Definition at line 776 of file MediaCurl.cc.

TransferSettings & zypp::media::MediaCurl::settings ( )

Definition at line 495 of file MediaCurl.cc.

void zypp::media::MediaCurl::setCookieFile ( const Pathname &  fileName) [static]

Definition at line 501 of file MediaCurl.cc.

int zypp::media::MediaCurl::progressCallback ( void *  clientp,
double  dltotal,
double  dlnow,
double  ultotal,
double  ulnow 
) [static, protected]
Todo:
more accurate download rate computationn, e.g. compute average value from last 5 seconds, or work with milliseconds instead of seconds

Definition at line 1503 of file MediaCurl.cc.

void zypp::media::MediaCurl::checkProtocol ( const Url url) const [protected]

check the url is supported by the curl library

Exceptions:
MediaBadUrlExceptionif there is a problem

Definition at line 508 of file MediaCurl.cc.

void zypp::media::MediaCurl::setupEasy ( ) [protected, virtual]

initializes the curl easy handle with the data from the url

Exceptions:
MediaCurlSetOptExceptionif there is a problem

Connect timeout

Speed limits

Reimplemented in zypp::media::MediaMultiCurl.

Definition at line 533 of file MediaCurl.cc.

Url zypp::media::MediaCurl::getFileUrl ( const Pathname &  filename) const [protected]

concatenate the attach url and the filename to a complete download url

Definition at line 805 of file MediaCurl.cc.

void zypp::media::MediaCurl::evaluateCurlCode ( const zypp::Pathname &  filename,
CURLcode  code,
bool  timeout 
) const [protected]

Evaluates a curl return code and throws the right MediaException filename Filename being downloaded code Code curl returnes timeout Whether we reached timeout, which we need to differentiate in case the codes aborted-by-callback or timeout are returned by curl Otherwise we can't differentiate abort from timeout.

Here you may want to pass the progress data object timeout-reached value, or just true if you are not doing user interaction.

Exceptions:
MediaExceptionIf there is a problem

Definition at line 916 of file MediaCurl.cc.

void zypp::media::MediaCurl::doGetFileCopyFile ( const Pathname &  srcFilename,
const Pathname &  dest,
FILE *  file,
callback::SendReport< DownloadProgressReport > &  _report,
RequestOptions  options = OPTION_NONE 
) const [protected]

Definition at line 1352 of file MediaCurl.cc.

string zypp::media::MediaCurl::getAuthHint ( ) const [private]

Return a comma separated list of available authentication methods supported by server.

Definition at line 1594 of file MediaCurl.cc.

bool zypp::media::MediaCurl::authenticate ( const std::string &  availAuthTypes,
bool  firstTry 
) const [private]
Todo:
need a way to pass different CredManagerOptions here
Todo:
add comma to the message for the next release
Todo:
find a way to save the url with changed username back to repoinfo or dont store urls with username (and either forbid more repos with the same url and different user, or return a set of credentials from CM and try them one by one)

Reimplemented in zypp::media::MediaAria2c.

Definition at line 1611 of file MediaCurl.cc.

bool zypp::media::MediaCurl::detectDirIndex ( ) const [private]

Member Data Documentation

Definition at line 164 of file MediaCurl.h.

Reimplemented in zypp::media::MediaAria2c.

Definition at line 166 of file MediaCurl.h.

Pathname zypp::media::MediaCurl::_cookieFile = "/var/lib/YaST2/cookies" [static, private]

Reimplemented in zypp::media::MediaAria2c.

Definition at line 167 of file MediaCurl.h.

CURL* zypp::media::MediaCurl::_curl [protected]

Definition at line 170 of file MediaCurl.h.

char zypp::media::MediaCurl::_curlError[CURL_ERROR_SIZE] [protected]

Definition at line 171 of file MediaCurl.h.

curl_slist* zypp::media::MediaCurl::_customHeaders [protected]

Definition at line 172 of file MediaCurl.h.

Definition at line 173 of file MediaCurl.h.


The documentation for this class was generated from the following files: