libzypp  17.31.27
curlmultiparthandler.h
Go to the documentation of this file.
1 #ifndef ZYPPNG_CURLMULTIPARTHANDLER_H
2 #define ZYPPNG_CURLMULTIPARTHANDLER_H
3 
4 #include <zypp-core/zyppng/base/Base>
5 #include <zypp-core/zyppng/core/ByteArray>
6 #include <zypp-core/Digest.h>
7 #include <zypp-core/zyppng/pipelines/Expected>
8 #include <zypp-curl/ng/network/NetworkRequestError>
9 
10 #include <optional>
11 #include <any>
12 
13 namespace zyppng {
14 
19  public:
20  virtual ~CurlMultiPartDataReceiver() = default;
21 
25  virtual size_t headerfunction ( char *ptr, size_t bytes ) = 0;
26 
32  virtual size_t writefunction ( char *ptr, std::optional<off_t> offset, size_t bytes ) = 0;
33 
41  virtual bool beginRange ( off_t range, std::string &cancelReason ) { return true; };
42 
53  virtual bool finishedRange ( off_t range, bool validated, std::string &cancelReason ) { return true; };
54  };
55 
63  class CurlMultiPartHandler : public Base
64  {
65  public:
66 
67  enum class ProtocolMode{
68  Basic, //< use this mode if no special checks are required in header or write callbacks
69  HTTP //< this mode is used for HTTP and HTTPS downloads
70  };
71 
72  // when requesting ranges from the server, we need to make sure not to request
73  // too many at the same time. Instead we batch our requests and reuse the open
74  // connection until we have the full file.
75  // However different server have different maximum nr of ranges, so we start with
76  // a high number and decrease until we find a rangecount that works
77  constexpr static int _rangeAttempt[] = {
78  255,
79  127,
80  63,
81  15,
82  5,
83  1
84  };
85 
86  enum State {
87  Pending, //< waiting to be dispatched
88  Running, //< currently running
89  Finished, //< finished successfully
90  Error, //< Error, use error function to figure out the issue
91  };
92 
93  using CheckSumBytes = UByteArray;
95 
96  struct Range {
97  size_t start = 0;
98  size_t len = 0;
99  size_t bytesWritten = 0;
100  std::optional<zypp::Digest> _digest = {}; //< zypp::Digest that is updated when data is written, can be used to validate the file contents with a checksum
101 
109  std::optional<size_t> _relevantDigestLen; //< If this is initialized , it defines how many bytes of the resulting checkum are compared
110  std::optional<size_t> _chksumPad; //< If initialized we need to pad the digest with zeros before calculating the final checksum
111  std::any userData; //< Custom data the user can associate with the Range
112 
113  State _rangeState = State::Pending; //< Flag to know if this range has been already requested and if the request was successful
114 
115  void restart();
116  Range clone() const;
117 
118  static Range make ( size_t start, size_t len = 0, std::optional<zypp::Digest> &&digest = {}, CheckSumBytes &&expectedChkSum = CheckSumBytes(), std::any &&userData = std::any(), std::optional<size_t> digestCompareLen = {}, std::optional<size_t> _dataBlockPadding = {} );
119  };
120 
121  CurlMultiPartHandler( ProtocolMode mode, void *easyHandle, std::vector<Range> &ranges, CurlMultiPartDataReceiver &receiver );
123 
124  void *easyHandle() const;
125  bool canRecover() const;
126  bool hasMoreWork() const;
127 
128  bool hasError() const;
129 
130  Code lastError() const;
131  const std::string &lastErrorMessage() const;
132 
133  bool validateRange(Range &rng);
134 
135  bool prepare( );
136  bool prepareToContinue( );
137  void finalize( );
138 
139  bool verifyData( );
140 
141  std::optional<size_t> reportedFileSize() const;
142  std::optional<off_t> currentRange() const;
143 
144  private:
145 
146  void setCode ( Code c, std::string msg, bool force = false );
147 
148  static size_t curl_hdrcallback ( char *ptr, size_t size, size_t nmemb, void *userdata );
149  static size_t curl_wrtcallback ( char *ptr, size_t size, size_t nmemb, void *userdata );
150 
151  size_t hdrcallback ( char *ptr, size_t size, size_t nmemb );
152  size_t wrtcallback ( char *ptr, size_t size, size_t nmemb );
153  bool parseContentRangeHeader(const std::string_view &line, size_t &start, size_t &len, size_t &fileLen);
154  bool parseContentTypeMultiRangeHeader(const std::string_view &line, std::string &boundary);
155  bool checkIfRangeChkSumIsValid( Range &rng );
156  void setRangeState ( Range &rng, State state );
157 
159  void *_easyHandle = nullptr;
161 
162  Code _lastCode = Code::NoError;
163  std::string _lastErrorMsg;
164 
165  bool _allHeadersReceived = false; //< set to true once writefunc was called once e.g. all headers have been received
166  bool _gotContentRangeInfo = false; //< Set to true if the server indicates ranges
167  bool _isMuliPartResponse = false; //< Set to true if the respone is in multipart form
168 
169  std::string _seperatorString;
170  std::vector<char> _rangePrefaceBuffer;
171 
172  std::optional<off_t> _currentRange;
173  std::optional<Range> _currentSrvRange;
174  std::optional<size_t> _reportedFileSize;
175 
177  std::vector<Range> &_requestedRanges;
178  };
179 
180 } // namespace zyppng
181 
182 #endif // ZYPPNG_CURLMULTIPARTHANDLER_H
std::optional< size_t > reportedFileSize() const
CurlMultiPartDataReceiver & _receiver
std::string _seperatorString
The seperator string for multipart responses as defined in RFC 7233 Section 4.1.
The CurlMultiPartHandler class.
virtual ~CurlMultiPartDataReceiver()=default
static Range make(size_t start, size_t len=0, std::optional< zypp::Digest > &&digest={}, CheckSumBytes &&expectedChkSum=CheckSumBytes(), std::any &&userData=std::any(), std::optional< size_t > digestCompareLen={}, std::optional< size_t > _dataBlockPadding={})
size_t hdrcallback(char *ptr, size_t size, size_t nmemb)
NetworkRequestError::Type Code
void setRangeState(Range &rng, State state)
const std::string & lastErrorMessage() const
std::optional< Range > _currentSrvRange
void setCode(Code c, std::string msg, bool force=false)
virtual size_t headerfunction(char *ptr, size_t bytes)=0
CheckSumBytes _checksum
Enables automated checking of downloaded contents against a checksum.
virtual size_t writefunction(char *ptr, std::optional< off_t > offset, size_t bytes)=0
std::vector< Range > & _requestedRanges
the requested ranges that need to be downloaded
CurlMultiPartHandler(ProtocolMode mode, void *easyHandle, std::vector< Range > &ranges, CurlMultiPartDataReceiver &receiver)
virtual bool finishedRange(off_t range, bool validated, std::string &cancelReason)
static size_t curl_wrtcallback(char *ptr, size_t size, size_t nmemb, void *userdata)
static constexpr int _rangeAttempt[]
std::optional< off_t > currentRange() const
std::optional< size_t > _relevantDigestLen
virtual bool beginRange(off_t range, std::string &cancelReason)
std::vector< char > _rangePrefaceBuffer
Here we buffer.
std::optional< zypp::Digest > _digest
std::optional< off_t > _currentRange
std::optional< size_t > _reportedFileSize
Filesize as reported by the content range or byte range headers.
bool parseContentRangeHeader(const std::string_view &line, size_t &start, size_t &len, size_t &fileLen)
static size_t curl_hdrcallback(char *ptr, size_t size, size_t nmemb, void *userdata)
bool parseContentTypeMultiRangeHeader(const std::string_view &line, std::string &boundary)
size_t wrtcallback(char *ptr, size_t size, size_t nmemb)