1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524
|
# (C) Copyright 2021 ECMWF.
#
# This software is licensed under the terms of the Apache Licence Version 2.0
# which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
# In applying this licence, ECMWF does not waive the privileges and immunities
# granted to it by virtue of its status as an intergovernmental organisation
# nor does it submit to any jurisdiction.
#
import datetime
import json
import logging
import os
import random
import time
import pytz
import requests
from dateutil.parser import parse as parse_date
from .base import DownloaderBase
from .multipart import DecodeMultipart, PartFilter, compute_byte_ranges
LOG = logging.getLogger(__name__)
class ServerCapabilities:
def __init__(self, accept_ranges, accept_multiple_ranges):
self.accept_ranges = accept_ranges
self.accept_multiple_ranges = accept_multiple_ranges
def NoFilter(x):
return x
def parse_separated_header(value: str):
"""Adapted from https://peps.python.org/pep-0594/#cgi."""
from email.message import Message
m = Message()
m["content-type"] = value
return dict(m.get_params())
class HTTPDownloaderBase(DownloaderBase):
def __init__(
self,
url,
verify=True,
http_headers=None,
fake_headers=None,
range_method=None,
maximum_retries=500,
retry_after=120,
mirrors=None,
session=None,
**kwargs,
):
super().__init__(url, **kwargs)
self._headers = None
self._url = None
self.http_headers = http_headers if http_headers else {}
self.verify = verify
self.fake_headers = fake_headers
self.range_method = range_method
self.retry_after = retry_after
self.maximum_retries = maximum_retries
self.mirrors = mirrors
self.session = requests if session is None else session
def headers(self):
if self._headers is None or self.url != self._url:
self._url = self.url
self._headers = {}
if self.fake_headers is not None:
self._headers = dict(**self.fake_headers)
else:
try:
r = self.robust(self.session.head)(
self.url,
headers=self.http_headers,
verify=self.verify,
timeout=self.timeout,
allow_redirects=True,
auth=self.auth,
)
r.raise_for_status()
for k, v in r.headers.items():
self._headers[k.lower()] = v
LOG.debug(
"HTTP headers %s",
json.dumps(self._headers, sort_keys=True, indent=4),
)
except Exception:
self._url = None
self._headers = {}
if LOG.level == logging.DEBUG:
LOG.exception("HEAD %s", self.url)
LOG.error("Ignoring HEAD exception.")
return self._headers
def extension(self):
ext = super().extension()
if ext == ".unknown":
# Only check for "content-disposition" if
# the URL does not end with an extension
# so we avoid fetching the headers unesseraly
headers = self.headers()
if "content-disposition" in headers:
params = parse_separated_header(headers["content-disposition"])
assert "attachment" in params, params
if "filename" in params:
ext = super().extension(params["filename"])
return ext
def title(self):
headers = self.headers()
if "content-disposition" in headers:
params = parse_separated_header(headers["content-disposition"])
if "filename" in params:
return params["filename"]
return super().title()
def transfer(self, f, pbar):
total = 0
start = time.time()
stream = self.make_stream()
for chunk in stream(chunk_size=self.chunk_size):
self.observer()
if chunk:
f.write(chunk)
total += len(chunk)
pbar.update(len(chunk))
self.statistics_gatherer(
"transfer",
url=self.url,
total=total,
elapsed=time.time() - start,
)
return total
def cache_data(self):
return self.headers()
def out_of_date(self, path, cache_data):
if cache_data is not None:
# TODO: check 'cache-control' to see if we should check the etag
if "cache-control" in cache_data:
pass
if "expires" in cache_data:
if cache_data["expires"] != "0": # HTTP1.0 legacy
try:
expires = parse_date(cache_data["expires"])
now = pytz.UTC.localize(datetime.datetime.utcnow())
if expires > now:
LOG.debug(
"URL %s not expired (%s > %s)", self.url, expires, now
)
return False
except Exception:
LOG.exception(
"Failed to check URL expiry date '%s'",
cache_data["expires"],
)
try:
headers = self.headers()
except requests.exceptions.ConnectionError:
return False
cached_etag = cache_data.get("etag")
remote_etag = headers.get("etag")
if cached_etag != remote_etag and remote_etag is not None:
LOG.warning("Remote content of URL %s has changed", self.url)
return True
else:
LOG.debug("Remote content of URL %s unchanged", self.url)
return False
def check_for_restarts(self, target):
if not self.resume_transfers:
return 0
if not os.path.exists(target):
return 0
# Check if we can restarts the transfer
# TODO: check etags... the file may have changed since
bytes = os.path.getsize(target)
if bytes > 0:
headers = self.headers()
if headers.get("accept-ranges") != "bytes":
LOG.warning(
"%s: %s bytes already download, but server does not support restarts",
target,
bytes,
)
return 0
LOG.info(
"%s: resuming download from byte %s",
target,
bytes,
)
return bytes
def issue_request(self, bytes_ranges=None):
headers = {}
headers.update(self.http_headers)
if bytes_ranges is not None:
headers["range"] = bytes_ranges
LOG.debug("Issue request for %s", self.url)
LOG.debug("Headers: %s", json.dumps(headers, indent=4, sort_keys=True))
r = self.robust(self.session.get)(
self.url,
stream=True,
verify=self.verify,
timeout=self.timeout,
headers=headers,
auth=self.auth,
)
try:
r.raise_for_status()
except Exception as e:
if (
isinstance(e, requests.HTTPError)
and e.response is not None
and e.response.status_code == requests.codes.not_found
):
raise # Keep quiet on 404s
LOG.error("URL %s: %s", self.url, r.text)
raise
return r
def robust(self, call):
return robust(call, self.maximum_retries, self.retry_after, self.mirrors)
class FullHTTPDownloader(HTTPDownloaderBase):
def __repr__(self):
return f"FullHTTPDownloader({self.url})"
def estimate_size(self, target):
assert self.parts is None
size = None
mode = "wb"
skip = 0
headers = self.headers()
if "content-length" in headers:
try:
size = int(headers["content-length"])
except Exception:
LOG.exception("content-length %s", self.url)
# content-length is the size of the encoded body
# so we cannot rely on it to check the file size
trust_size = size is not None and headers.get("content-encoding") is None
# Check if we can restarts the transfer
self.range = None
bytes = self.check_for_restarts(target)
if bytes > 0:
assert size is None or bytes < size, (bytes, size, self.url, target)
skip = bytes
mode = "ab"
self.range = f"bytes={bytes}-"
LOG.debug(
"url estimate_size size=%s mode=%s skip=%s trust_size=%s",
size,
mode,
skip,
trust_size,
)
return (size, mode, skip, trust_size)
def make_stream(self):
request = self.issue_request(self.range)
return request.iter_content
class ServerDoesNotSupportPartsHTTPDownloader(HTTPDownloaderBase):
def __repr__(self):
return f"ServerDoesNotSupportPartsHTTPDownloader({self.url, self.parts})"
def estimate_size(self, target):
size = sum(p.length for p in self.parts)
return (size, "wb", 0, True)
def make_stream(self):
request = self.issue_request()
return PartFilter(self.parts)(request.iter_content)
class SinglePartHTTPDownloader(HTTPDownloaderBase):
def __repr__(self):
return f"SinglePartHTTPDownloader({self.url, self.parts})"
def estimate_size(self, target):
assert len(self.parts) == 1
offset, length = self.parts[0]
start = offset
end = offset + length - 1
bytes = self.check_for_restarts(target)
if bytes > 0:
start += bytes
skip = bytes
mode = "ab"
else:
skip = 0
mode = "wb"
self.bytes_range = f"bytes={start}-{end}"
size = sum(p.length for p in self.parts)
return (size, mode, skip, True)
def make_stream(self):
request = self.issue_request(self.bytes_range)
return request.iter_content
class PartHTTPDownloader(HTTPDownloaderBase):
_server_capabilities = None
def __repr__(self):
return f"PartHTTPDownloader({self.url, self.parts})"
@property
def server_capabilities(self):
if self._server_capabilities is None:
self._server_capabilities = ServerCapabilities(
accept_ranges=False,
accept_multiple_ranges=None,
)
headers = self.headers()
if headers.get("accept-ranges") == "bytes":
self._server_capabilities.accept_ranges = True
# Special case for Azure
# The server does not announce byte-range support, but supports it
# The server will ignore multiple ranges and return everything
# https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-the-range-header-for-blob-service-operations
if headers.get("server", "unknown").startswith("Windows-Azure-Blob"):
self._server_capabilities = ServerCapabilities(
accept_ranges=True,
accept_multiple_ranges=False,
)
# Special case for AWS
# The server will ignore multiple ranges and return everything
if headers.get("server", "unknown").startswith("AmazonS3"):
self._server_capabilities = ServerCapabilities(
accept_ranges=True,
accept_multiple_ranges=False,
)
return self._server_capabilities
def mutate(self, *args, **kwargs):
if not self.server_capabilities.accept_ranges:
LOG.warning(
"Server for %s does not support byte ranges, downloading whole file",
self.url,
)
return ServerDoesNotSupportPartsHTTPDownloader(*args, **kwargs)
if len(self.parts) == 1:
# Special case, we let HTTP to its job, so we can resume transfers if needed
return SinglePartHTTPDownloader(*args, **kwargs)
return self
def split_large_requests(self, parts):
ranges = []
for offset, length in parts:
ranges.append(f"{offset}-{offset+length-1}")
# Nginx default is 4K
# https://stackoverflow.com/questions/686217/maximum-on-http-header-values
bytes_range = f"bytes={','.join(ranges)}"
if len(bytes_range) <= 4000:
return [(bytes_range, parts)]
middle = len(parts) // 2
return self.split_large_requests(parts[:middle]) + self.split_large_requests(
parts[middle:]
)
def estimate_size(self, target):
size = sum(p.length for p in self.parts)
return (size, "wb", 0, True)
def make_stream(self):
# TODO: implement transfer restarts by trimming the list of parts
filter = NoFilter
parts = self.parts
if self.range_method:
rounded, positions = compute_byte_ranges(
self.parts,
self.range_method,
self.url,
self.statistics_gatherer,
)
filter = PartFilter(self.parts, positions)
parts = rounded
splits = self.split_large_requests(parts)
accept_multiple_ranges = self.server_capabilities.accept_multiple_ranges
def iterate_requests(chunk_size):
for bytes_ranges, parts in splits:
if accept_multiple_ranges is False:
request = self.issue_request(bytes_ranges.split(",")[0])
else:
request = self.issue_request(bytes_ranges)
stream = DecodeMultipart(
self.url,
request,
parts,
verify=self.verify,
timeout=self.timeout,
headers=self.http_headers,
)
yield from stream(chunk_size)
return filter(iterate_requests)
RETRIABLE = (
requests.codes.internal_server_error,
requests.codes.bad_gateway,
requests.codes.service_unavailable,
requests.codes.gateway_timeout,
requests.codes.too_many_requests,
requests.codes.request_timeout,
)
def robust(call, maximum_tries=500, retry_after=120, mirrors=None):
def retriable(code):
return code in RETRIABLE
def wrapped(url, *args, **kwargs):
tries = 0
main_url = url
while True:
tries += 1
if tries >= maximum_tries:
# Last attempt, don't do anything
return call(main_url, *args, **kwargs)
try:
r = call(main_url, *args, **kwargs)
except requests.exceptions.SSLError:
raise
except (
requests.exceptions.ConnectionError,
requests.exceptions.ReadTimeout,
) as e:
r = None
LOG.warning(
"Recovering from connection error [%s], attempt %s of %s",
e,
tries,
maximum_tries,
)
if r is not None:
if not retriable(r.status_code):
return r
LOG.warning(
"Recovering from HTTP error [%s %s], attempt %s of %s",
r.status_code,
r.reason,
tries,
maximum_tries,
)
alternate = None
replace = 0
if mirrors is not None:
for key, values in mirrors.items():
if url.startswith(key):
alternate = values
replace = len(key)
if not isinstance(alternate, (list, tuple)):
alternate = [alternate]
if alternate is not None:
mirror = random.choice(alternate)
LOG.warning("Retrying using mirror %s", mirror)
main_url = f"{mirror}{url[replace:]}"
else:
LOG.warning("Retrying in %s seconds", retry_after)
time.sleep(retry_after)
LOG.info("Retrying now...")
return wrapped
|