]>
git.ipfire.org Git - thirdparty/squid.git/blob - src/HttpHdrRange.cc
2 * Copyright (C) 1996-2023 The Squid Software Foundation and contributors
4 * Squid software is distributed under GPLv2+ license and includes
5 * contributions from numerous individuals and organizations.
6 * Please see the COPYING and CONTRIBUTORS files for details.
9 /* DEBUG: section 64 HTTP Range Header */
12 #include "client_side_request.h"
13 #include "http/Stream.h"
14 #include "HttpHeaderRange.h"
15 #include "HttpHeaderTools.h"
16 #include "HttpReply.h"
21 * Currently only byte ranges are supported
23 * Essentially, there are three types of byte ranges:
25 * 1) first-byte-pos "-" last-byte-pos // range
26 * 2) first-byte-pos "-" // trailer
27 * 3) "-" suffix-length // suffix (last length bytes)
30 * When Range field is parsed, we have no clue about the content
31 * length of the document. Thus, we simply code an "absent" part
32 * using HttpHdrRangeSpec::UnknownPosition constant.
34 * Note: when response length becomes known, we convert any range
35 * spec into type one above. (Canonization process).
39 #define known_spec(s) ((s) > HttpHdrRangeSpec::UnknownPosition)
42 size_t HttpHdrRange::ParsedCount
= 0;
43 int64_t const HttpHdrRangeSpec::UnknownPosition
= -1;
49 HttpHdrRangeSpec::HttpHdrRangeSpec() : offset(UnknownPosition
), length(UnknownPosition
) {}
51 /* parses range-spec and returns new object on success */
53 HttpHdrRangeSpec::Create(const char *field
, int flen
)
55 HttpHdrRangeSpec spec
;
57 if (!spec
.parseInit(field
, flen
))
60 return new HttpHdrRangeSpec(spec
);
64 HttpHdrRangeSpec::parseInit(const char *field
, int flen
)
71 /* is it a suffix-byte-range-spec ? */
73 if (!httpHeaderParseOffset(field
+ 1, &length
) || !known_spec(length
))
76 /* must have a '-' somewhere in _this_ field */
77 if (!((p
= strchr(field
, '-')) && (p
- field
< flen
))) {
78 debugs(64, 2, "invalid (missing '-') range-spec near: '" << field
<< "'");
81 if (!httpHeaderParseOffset(field
, &offset
) || !known_spec(offset
))
86 /* do we have last-pos ? */
87 if (p
- field
< flen
) {
90 if (!httpHeaderParseOffset(p
, &last_pos
) || !known_spec(last_pos
))
93 // RFC 2616 s14.35.1 MUST: last-byte-pos >= first-byte-pos
94 if (last_pos
< offset
) {
95 debugs(64, 2, "invalid (last-byte-pos < first-byte-pos) range-spec near: " << field
);
99 HttpHdrRangeSpec::HttpRange
aSpec (offset
, last_pos
+ 1);
101 length
= aSpec
.size();
109 HttpHdrRangeSpec::packInto(Packable
* p
) const
111 if (!known_spec(offset
)) /* suffix */
112 p
->appendf("-%" PRId64
, length
);
113 else if (!known_spec(length
)) /* trailer */
114 p
->appendf("%" PRId64
"-", offset
);
116 p
->appendf("%" PRId64
"-%" PRId64
, offset
, offset
+ length
- 1);
120 HttpHdrRangeSpec::outputInfo( char const *note
) const
122 debugs(64, 5, "HttpHdrRangeSpec::canonize: " << note
<< ": [" <<
123 offset
<< ", " << offset
+ length
<<
124 ") len: " << length
);
127 /* fills "absent" positions in range specification based on response body size
128 * returns true if the range is still valid
129 * range is valid if its intersection with [0,length-1] is not empty
132 HttpHdrRangeSpec::canonize(int64_t clen
)
135 HttpRange
object(0, clen
);
137 if (!known_spec(offset
)) { /* suffix */
138 assert(known_spec(length
));
139 offset
= object
.intersection(HttpRange (clen
- length
, clen
)).start
;
140 } else if (!known_spec(length
)) { /* trailer */
141 assert(known_spec(offset
));
142 HttpRange newRange
= object
.intersection(HttpRange (offset
, clen
));
143 length
= newRange
.size();
145 /* we have a "range" now, adjust length if needed */
146 assert(known_spec(length
));
148 assert(known_spec(offset
));
150 HttpRange newRange
= object
.intersection (HttpRange (offset
, offset
+ length
));
152 length
= newRange
.size();
159 /* merges recipient with donor if possible; returns true on success
160 * both specs must be canonized prior to merger, of course */
162 HttpHdrRangeSpec::mergeWith(const HttpHdrRangeSpec
* donor
)
165 #if MERGING_BREAKS_NOTHING
166 /* Note: this code works, but some clients may not like its effects */
167 int64_t rhs
= offset
+ length
; /* no -1 ! */
168 const int64_t donor_rhs
= donor
->offset
+ donor
->length
; /* no -1 ! */
169 assert(known_spec(offset
));
170 assert(known_spec(donor
->offset
));
172 assert(donor
->length
> 0);
173 /* do we have a left hand side overlap? */
175 if (donor
->offset
< offset
&& offset
<= donor_rhs
) {
176 offset
= donor
->offset
; /* decrease left offset */
180 /* do we have a right hand side overlap? */
181 if (donor
->offset
<= rhs
&& rhs
< donor_rhs
) {
182 rhs
= donor_rhs
; /* increase right offset */
186 /* adjust length if offsets have been changed */
188 assert(rhs
> offset
);
189 length
= rhs
- offset
;
191 /* does recipient contain donor? */
193 offset
<= donor
->offset
&& donor
->offset
< rhs
;
206 HttpHdrRange::HttpHdrRange() : clen(HttpHdrRangeSpec::UnknownPosition
)
210 HttpHdrRange::ParseCreate(const String
* range_spec
)
212 HttpHdrRange
*r
= new HttpHdrRange
;
214 if (!r
->parseInit(range_spec
)) {
222 /* returns true if ranges are valid; inits HttpHdrRange */
224 HttpHdrRange::parseInit(const String
* range_spec
)
227 const char *pos
= nullptr;
231 debugs(64, 8, "parsing range field: '" << *range_spec
<< "'");
232 /* check range type */
234 if (range_spec
->caseCmp("bytes=", 6))
237 /* skip "bytes="; hack! */
238 pos
= range_spec
->termedBuf() + 6;
240 /* iterate through comma separated list */
241 while (strListGetItem(range_spec
, ',', &item
, &ilen
, &pos
)) {
242 HttpHdrRangeSpec
*spec
= HttpHdrRangeSpec::Create(item
, ilen
);
244 * RFC 2616 section 14.35.1: MUST ignore Range with
245 * at least one syntactically invalid byte-range-specs.
248 while (!specs
.empty()) {
252 debugs(64, 2, "ignoring invalid range field: '" << *range_spec
<< "'");
256 specs
.push_back(spec
);
259 debugs(64, 8, "got range specs: " << specs
.size());
260 return !specs
.empty();
263 HttpHdrRange::~HttpHdrRange()
265 while (!specs
.empty()) {
271 HttpHdrRange::HttpHdrRange(HttpHdrRange
const &old
) :
273 clen(HttpHdrRangeSpec::UnknownPosition
)
275 specs
.reserve(old
.specs
.size());
277 for (const_iterator i
= old
.begin(); i
!= old
.end(); ++i
)
278 specs
.push_back(new HttpHdrRangeSpec ( **i
));
280 assert(old
.specs
.size() == specs
.size());
283 HttpHdrRange::iterator
284 HttpHdrRange::begin()
286 return specs
.begin();
289 HttpHdrRange::iterator
295 HttpHdrRange::const_iterator
296 HttpHdrRange::begin() const
298 return specs
.begin();
301 HttpHdrRange::const_iterator
302 HttpHdrRange::end() const
308 HttpHdrRange::packInto(Packable
* packer
) const
310 const_iterator pos
= begin();
312 while (pos
!= end()) {
314 packer
->append(",", 1);
316 (*pos
)->packInto(packer
);
323 HttpHdrRange::merge (std::vector
<HttpHdrRangeSpec
*> &basis
)
325 /* reset old array */
328 * take one spec from "goods" and merge it with specs from
329 * "specs" (if any) until there is no overlap */
330 iterator i
= basis
.begin();
332 while (i
!= basis
.end()) {
333 if (specs
.size() && (*i
)->mergeWith(specs
.back())) {
334 /* merged with current so get rid of the prev one */
337 continue; /* re-iterate */
340 specs
.push_back (*i
);
344 debugs(64, 3, "HttpHdrRange::merge: had " << basis
.size() <<
345 " specs, merged " << basis
.size() - specs
.size() << " specs");
349 HttpHdrRange::getCanonizedSpecs(std::vector
<HttpHdrRangeSpec
*> ©
)
351 /* canonize each entry and destroy bad ones if any */
353 for (iterator
pos (begin()); pos
!= end(); ++pos
) {
354 if ((*pos
)->canonize(clen
))
355 copy
.push_back (*pos
);
360 debugs(64, 3, "found " << specs
.size() - copy
.size() << " bad specs");
363 #include "HttpHdrContRange.h"
366 * canonizes all range specs within a set preserving the order
367 * returns true if the set is valid after canonization;
368 * the set is valid if
369 * - all range specs are valid and
370 * - there is at least one range spec
373 HttpHdrRange::canonize(HttpReply
*rep
)
377 if (rep
->contentRange())
378 clen
= rep
->contentRange()->elength
;
380 clen
= rep
->content_length
;
382 return canonize (clen
);
386 HttpHdrRange::canonize (int64_t newClen
)
389 debugs(64, 3, "HttpHdrRange::canonize: started with " << specs
.size() <<
390 " specs, clen: " << clen
);
391 std::vector
<HttpHdrRangeSpec
*> goods
;
392 getCanonizedSpecs(goods
);
394 debugs(64, 3, "HttpHdrRange::canonize: finished with " << specs
.size() <<
396 return specs
.size() > 0; // TODO: should return bool
399 /* hack: returns true if range specs are too "complex" for Squid to handle */
400 /* requires that specs are "canonized" first! */
402 HttpHdrRange::isComplex() const
405 /* check that all rangers are in "strong" order */
406 const_iterator
pos (begin());
408 while (pos
!= end()) {
409 /* Ensure typecasts is safe */
410 assert ((*pos
)->offset
>= 0);
412 if ((*pos
)->offset
< offset
)
415 offset
= (*pos
)->offset
+ (*pos
)->length
;
424 * hack: returns true if range specs may be too "complex" when "canonized".
425 * see also: HttpHdrRange::isComplex.
428 HttpHdrRange::willBeComplex() const
430 /* check that all rangers are in "strong" order, */
431 /* as far as we can tell without the content length */
434 for (const_iterator
pos (begin()); pos
!= end(); ++pos
) {
435 if (!known_spec((*pos
)->offset
)) /* ignore unknowns */
438 /* Ensure typecasts is safe */
439 assert ((*pos
)->offset
>= 0);
441 if ((*pos
)->offset
< offset
)
444 offset
= (*pos
)->offset
;
446 if (known_spec((*pos
)->length
)) /* avoid unknowns */
447 offset
+= (*pos
)->length
;
454 * Returns lowest known offset in range spec(s),
455 * or HttpHdrRangeSpec::UnknownPosition
456 * this is used for size limiting
459 HttpHdrRange::firstOffset() const
461 int64_t offset
= HttpHdrRangeSpec::UnknownPosition
;
462 const_iterator pos
= begin();
464 while (pos
!= end()) {
465 if ((*pos
)->offset
< offset
|| !known_spec(offset
))
466 offset
= (*pos
)->offset
;
475 * Returns lowest offset in range spec(s), 0 if unknown.
476 * This is used for finding out where we need to start if all
477 * ranges are combined into one, for example FTP REST.
478 * Use 0 for size if unknown
481 HttpHdrRange::lowestOffset(int64_t size
) const
483 int64_t offset
= HttpHdrRangeSpec::UnknownPosition
;
484 const_iterator pos
= begin();
486 while (pos
!= end()) {
487 int64_t current
= (*pos
)->offset
;
489 if (!known_spec(current
)) {
490 if ((*pos
)->length
> size
|| !known_spec((*pos
)->length
))
491 return 0; /* Unknown. Assume start of file */
493 current
= size
- (*pos
)->length
;
496 if (current
< offset
|| !known_spec(offset
))
502 return known_spec(offset
) ? offset
: 0;
506 * \retval true Fetch only requested ranges. The first range is larger that configured limit.
507 * \retval false Full download. Not a range request, no limit, or the limit is not yet reached.
510 HttpHdrRange::offsetLimitExceeded(const int64_t limit
) const
517 /* 'none' == forced */
520 if (firstOffset() == -1)
524 if (limit
>= firstOffset())
525 /* below the limit */
531 const HttpHdrRangeSpec
*
532 HttpHdrRangeIter::currentSpec() const
541 HttpHdrRangeIter::updateSpec()
543 assert (debt_size
== 0);
547 debt(currentSpec()->length
);
552 HttpHdrRangeIter::debt() const
554 debugs(64, 3, "HttpHdrRangeIter::debt: debt is " << debt_size
);
558 void HttpHdrRangeIter::debt(int64_t newDebt
)
560 debugs(64, 3, "HttpHdrRangeIter::debt: was " << debt_size
<< " now " << newDebt
);