libzypp 17.31.7
MediaCurl.h
Go to the documentation of this file.
1/*---------------------------------------------------------------------\
2| ____ _ __ __ ___ |
3| |__ / \ / / . \ . \ |
4| / / \ V /| _/ _/ |
5| / /__ | | | | | | |
6| /_____||_| |_| |_| |
7| |
8\---------------------------------------------------------------------*/
12#ifndef ZYPP_MEDIA_MEDIACURL_H
13#define ZYPP_MEDIA_MEDIACURL_H
14
15#include <zypp/base/Flags.h>
16#include <zypp/ZYppCallbacks.h>
18
19#include <curl/curl.h>
20
21namespace zypp {
22 namespace media {
23
25//
26// CLASS NAME : MediaCurl
32{
33 public:
35 {
46 };
48
49 protected:
50
51 Url clearQueryString(const Url &url) const;
52
53 virtual void attachTo (bool next = false) override;
54 virtual void releaseFrom( const std::string & ejectDev ) override;
55 virtual void getFile( const OnMediaLocation & file ) const override;
56 virtual void getDir( const Pathname & dirname, bool recurse_r ) const override;
57 virtual void getDirInfo( std::list<std::string> & retlist,
58 const Pathname & dirname, bool dots = true ) const override;
59 virtual void getDirInfo( filesystem::DirContent & retlist,
60 const Pathname & dirname, bool dots = true ) const override;
66 virtual bool getDoesFileExist( const Pathname & filename ) const override;
67
71 virtual bool doGetDoesFileExist( const Pathname & filename ) const;
72
78 virtual void disconnectFrom() override;
84 virtual void getFileCopy( const OnMediaLocation& srcFile, const Pathname & targetFilename ) const override;
85
91 virtual void doGetFileCopy( const OnMediaLocation &srcFile, const Pathname & targetFilename, callback::SendReport<DownloadProgressReport> & _report, RequestOptions options = OPTION_NONE ) const;
92
93
94 virtual bool checkAttachPoint(const Pathname &apoint) const override;
95
96 public:
97
98 MediaCurl( const Url & url_r,
99 const Pathname & attach_point_hint_r );
100
101 virtual ~MediaCurl() override { try { release(); } catch(...) {} }
102
103 static void setCookieFile( const Pathname & );
104
106 {
107 public:
108 virtual ~Callbacks();
109 virtual bool progress( int percent ) = 0;
110 };
111
112 protected:
114 static int aliveCallback( void *clientp, double dltotal, double dlnow, double ultotal, double ulnow );
116 static int progressCallback( void *clientp, double dltotal, double dlnow, double ultotal, double ulnow );
117 static CURL *progressCallback_getcurl( void *clientp );
122 void checkProtocol(const Url &url) const;
123
128 virtual void setupEasy();
129
142 void evaluateCurlCode(const zypp::Pathname &filename, CURLcode code, bool timeout) const;
143
144 void doGetFileCopyFile( const OnMediaLocation & srcFile, const Pathname & dest, FILE *file, callback::SendReport<DownloadProgressReport> & report, RequestOptions options = OPTION_NONE ) const;
145
146 static void resetExpectedFileSize ( void *clientp, const ByteCount &expectedFileSize );
147
148 private:
153 std::string getAuthHint() const;
154
155 bool authenticate(const std::string & availAuthTypes, bool firstTry) const;
156
157 bool detectDirIndex() const;
158
159 private:
161
164
165 mutable std::string _lastRedirect;
166
167 protected:
168 CURL *_curl;
169 char _curlError[ CURL_ERROR_SIZE ];
170 curl_slist *_customHeaders;
171};
172ZYPP_DECLARE_OPERATORS_FOR_FLAGS(MediaCurl::RequestOptions);
173
175
176 } // namespace media
177} // namespace zypp
178
179#endif // ZYPP_MEDIA_MEDIACURL_H
Store and operate with byte count.
Definition: ByteCount.h:31
Describes a resource file located on a medium.
Url manipulation class.
Definition: Url.h:92
virtual bool progress(int percent)=0
Implementation class for FTP, HTTP and HTTPS MediaHandler.
Definition: MediaCurl.h:32
virtual void setupEasy()
initializes the curl easy handle with the data from the url
Definition: MediaCurl.cc:407
static void setCookieFile(const Pathname &)
Definition: MediaCurl.cc:375
virtual bool getDoesFileExist(const Pathname &filename) const override
Repeatedly calls doGetDoesFileExist() until it successfully returns, fails unexpectedly,...
Definition: MediaCurl.cc:809
@ OPTION_RANGE
retrieve only a range of the file
Definition: MediaCurl.h:39
@ OPTION_NO_IFMODSINCE
to not add a IFMODSINCE header if target exists
Definition: MediaCurl.h:43
@ OPTION_NO_REPORT_START
do not send a start ProgressReport
Definition: MediaCurl.h:45
@ OPTION_HEAD
only issue a HEAD (or equivalent) request
Definition: MediaCurl.h:41
@ OPTION_NONE
Defaults.
Definition: MediaCurl.h:37
virtual void getFile(const OnMediaLocation &file) const override
Call concrete handler to provide file below attach point.
Definition: MediaCurl.cc:736
static void resetExpectedFileSize(void *clientp, const ByteCount &expectedFileSize)
MediaMultiCurl needs to reset the expected filesize in case a metalink file is downloaded otherwise t...
Definition: MediaCurl.cc:1461
std::string _currentCookieFile
Definition: MediaCurl.h:162
static int aliveCallback(void *clientp, double dltotal, double dlnow, double ultotal, double ulnow)
Callback sending just an alive trigger to the UI, without stats (e.g.
Definition: MediaCurl.cc:1404
static Pathname _cookieFile
Definition: MediaCurl.h:163
static int progressCallback(void *clientp, double dltotal, double dlnow, double ultotal, double ulnow)
Callback reporting download progress.
Definition: MediaCurl.cc:1418
virtual void getFileCopy(const OnMediaLocation &srcFile, const Pathname &targetFilename) const override
Definition: MediaCurl.cc:745
virtual void doGetFileCopy(const OnMediaLocation &srcFile, const Pathname &targetFilename, callback::SendReport< DownloadProgressReport > &_report, RequestOptions options=OPTION_NONE) const
Definition: MediaCurl.cc:1138
std::string _lastRedirect
to log/report redirections
Definition: MediaCurl.h:165
Url clearQueryString(const Url &url) const
Definition: MediaCurl.cc:370
virtual void attachTo(bool next=false) override
Call concrete handler to attach the media.
Definition: MediaCurl.cc:668
virtual void getDirInfo(std::list< std::string > &retlist, const Pathname &dirname, bool dots=true) const override
Call concrete handler to provide a content list of directory on media via retlist.
Definition: MediaCurl.cc:1388
char _curlError[CURL_ERROR_SIZE]
Definition: MediaCurl.h:169
void doGetFileCopyFile(const OnMediaLocation &srcFile, const Pathname &dest, FILE *file, callback::SendReport< DownloadProgressReport > &report, RequestOptions options=OPTION_NONE) const
Definition: MediaCurl.cc:1248
void checkProtocol(const Url &url) const
check the url is supported by the curl library
Definition: MediaCurl.cc:382
virtual ~MediaCurl() override
Definition: MediaCurl.h:101
MediaCurl(const Url &url_r, const Pathname &attach_point_hint_r)
Definition: MediaCurl.cc:334
bool detectDirIndex() const
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:840
virtual bool checkAttachPoint(const Pathname &apoint) const override
Verify if the specified directory as attach point (root) as requires by the particular media handler ...
Definition: MediaCurl.cc:703
virtual void getDir(const Pathname &dirname, bool recurse_r) const override
Call concrete handler to provide directory content (not recursive!) below attach point.
Definition: MediaCurl.cc:1355
bool authenticate(const std::string &availAuthTypes, bool firstTry) const
Definition: MediaCurl.cc:1471
static CURL * progressCallback_getcurl(void *clientp)
Definition: MediaCurl.cc:1434
virtual void releaseFrom(const std::string &ejectDev) override
Call concrete handler to release the media.
Definition: MediaCurl.cc:729
virtual void disconnectFrom() override
Definition: MediaCurl.cc:710
virtual bool doGetDoesFileExist(const Pathname &filename) const
Definition: MediaCurl.cc:988
curl_slist * _customHeaders
Definition: MediaCurl.h:170
std::string getAuthHint() const
Return a comma separated list of available authentication methods supported by server.
Definition: MediaCurl.cc:1442
ZYPP_DECLARE_FLAGS(RequestOptions, RequestOption)
Url url() const
Url used.
Definition: MediaHandler.h:503
void release(const std::string &ejectDev="")
Use concrete handler to release the media.
Common baseclass for MediaCurl and MediaNetwork.
std::list< DirEntry > DirContent
Returned by readdir.
Definition: PathInfo.h:518
ZYPP_DECLARE_OPERATORS_FOR_FLAGS(MediaCurl::RequestOptions)
Easy-to use interface to the ZYPP dependency resolver.
Definition: CodePitfalls.doc:2