_ Git - youtube-dl/blob - youtube_dl/downloader/http.py

   1 from __future__ import unicode_literals
   2
   3 import errno
   4 import os
   5 import socket
   6 import time
   7 import re
   8
   9 from .common import FileDownloader
  10 from ..compat import (
  11     compat_str,
  12     compat_urllib_error,
  13 )
  14 from ..utils import (
  15     ContentTooShortError,
  16     encodeFilename,
  17     int_or_none,
  18     sanitize_open,
  19     sanitized_Request,
  20     write_xattr,
  21     XAttrMetadataError,
  22     XAttrUnavailableError,
  23 )
  24
  25
  26 class HttpFD(FileDownloader):
  27     def real_download(self, filename, info_dict):
  28         url = info_dict['url']
  29
  30         class DownloadContext(dict):
  31             __getattr__ = dict.get
  32             __setattr__ = dict.__setitem__
  33             __delattr__ = dict.__delitem__
  34
  35         ctx = DownloadContext()
  36         ctx.filename = filename
  37         ctx.tmpfilename = self.temp_name(filename)
  38         ctx.stream = None
  39
  40         # Do not include the Accept-Encoding header
  41         headers = {'Youtubedl-no-compression': 'True'}
  42         add_headers = info_dict.get('http_headers')
  43         if add_headers:
  44             headers.update(add_headers)
  45
  46         is_test = self.params.get('test', False)
  47         chunk_size = self._TEST_FILE_SIZE if is_test else (
  48             self.params.get('http_chunk_size') or 0)
  49
  50         ctx.open_mode = 'wb'
  51         ctx.resume_len = 0
  52         ctx.data_len = None
  53         ctx.block_size = self.params.get('buffersize', 1024)
  54         ctx.start_time = time.time()
  55
  56         if self.params.get('continuedl', True):
  57             # Establish possible resume length
  58             if os.path.isfile(encodeFilename(ctx.tmpfilename)):
  59                 ctx.resume_len = os.path.getsize(
  60                     encodeFilename(ctx.tmpfilename))
  61
  62         ctx.is_resume = ctx.resume_len > 0
  63
  64         count = 0
  65         retries = self.params.get('retries', 0)
  66
  67         class SucceedDownload(Exception):
  68             pass
  69
  70         class RetryDownload(Exception):
  71             def __init__(self, source_error):
  72                 self.source_error = source_error
  73
  74         class NextFragment(Exception):
  75             pass
  76
  77         def set_range(req, start, end):
  78             range_header = 'bytes=%d-' % start
  79             if end:
  80                 range_header += compat_str(end)
  81             req.add_header('Range', range_header)
  82
  83         def establish_connection():
  84             if ctx.resume_len > 0:
  85                 range_start = ctx.resume_len
  86                 if ctx.is_resume:
  87                     self.report_resuming_byte(ctx.resume_len)
  88                 ctx.open_mode = 'ab'
  89             elif chunk_size > 0:
  90                 range_start = 0
  91             else:
  92                 range_start = None
  93             ctx.is_resume = False
  94             range_end = range_start + chunk_size - 1 if chunk_size else None
  95             if range_end and ctx.data_len is not None and range_end >= ctx.data_len:
  96                 range_end = ctx.data_len - 1
  97             has_range = range_start is not None
  98             ctx.has_range = has_range
  99             request = sanitized_Request(url, None, headers)
 100             if has_range:
 101                 set_range(request, range_start, range_end)
 102             # Establish connection
 103             try:
 104                 ctx.data = self.ydl.urlopen(request)
 105                 # When trying to resume, Content-Range HTTP header of response has to be checked
 106                 # to match the value of requested Range HTTP header. This is due to a webservers
 107                 # that don't support resuming and serve a whole file with no Content-Range
 108                 # set in response despite of requested Range (see
 109                 # https://github.com/rg3/youtube-dl/issues/6057#issuecomment-126129799)
 110                 if has_range:
 111                     content_range = ctx.data.headers.get('Content-Range')
 112                     if content_range:
 113                         content_range_m = re.search(r'bytes (\d+)-(\d+)?(?:/(\d+))?', content_range)
 114                         # Content-Range is present and matches requested Range, resume is possible
 115                         if content_range_m:
 116                             if range_start == int(content_range_m.group(1)):
 117                                 content_range_end = int_or_none(content_range_m.group(2))
 118                                 content_len = int_or_none(content_range_m.group(3))
 119                                 accept_content_len = (
 120                                     # Non-chunked download
 121                                     not chunk_size or
 122                                     # Chunked download and requested piece or
 123                                     # its part is promised to be served
 124                                     content_range_end == range_end or
 125                                     content_len < range_end)
 126                                 if accept_content_len:
 127                                     ctx.data_len = content_len
 128                                     return
 129                     # Content-Range is either not present or invalid. Assuming remote webserver is
 130                     # trying to send the whole file, resume is not possible, so wiping the local file
 131                     # and performing entire redownload
 132                     self.report_unable_to_resume()
 133                     ctx.resume_len = 0
 134                     ctx.open_mode = 'wb'
 135                 ctx.data_len = int_or_none(ctx.data.info().get('Content-length', None))
 136                 return
 137             except (compat_urllib_error.HTTPError, ) as err:
 138                 if err.code == 416:
 139                     # Unable to resume (requested range not satisfiable)
 140                     try:
 141                         # Open the connection again without the range header
 142                         ctx.data = self.ydl.urlopen(
 143                             sanitized_Request(url, None, headers))
 144                         content_length = ctx.data.info()['Content-Length']
 145                     except (compat_urllib_error.HTTPError, ) as err:
 146                         if err.code < 500 or err.code >= 600:
 147                             raise
 148                     else:
 149                         # Examine the reported length
 150                         if (content_length is not None and
 151                                 (ctx.resume_len - 100 < int(content_length) < ctx.resume_len + 100)):
 152                             # The file had already been fully downloaded.
 153                             # Explanation to the above condition: in issue #175 it was revealed that
 154                             # YouTube sometimes adds or removes a few bytes from the end of the file,
 155                             # changing the file size slightly and causing problems for some users. So
 156                             # I decided to implement a suggested change and consider the file
 157                             # completely downloaded if the file size differs less than 100 bytes from
 158                             # the one in the hard drive.
 159                             self.report_file_already_downloaded(ctx.filename)
 160                             self.try_rename(ctx.tmpfilename, ctx.filename)
 161                             self._hook_progress({
 162                                 'filename': ctx.filename,
 163                                 'status': 'finished',
 164                                 'downloaded_bytes': ctx.resume_len,
 165                                 'total_bytes': ctx.resume_len,
 166                             })
 167                             raise SucceedDownload()
 168                         else:
 169                             # The length does not match, we start the download over
 170                             self.report_unable_to_resume()
 171                             ctx.resume_len = 0
 172                             ctx.open_mode = 'wb'
 173                             return
 174                 elif err.code < 500 or err.code >= 600:
 175                     # Unexpected HTTP error
 176                     raise
 177                 raise RetryDownload(err)
 178             except socket.error as err:
 179                 if err.errno != errno.ECONNRESET:
 180                     # Connection reset is no problem, just retry
 181                     raise
 182                 raise RetryDownload(err)
 183
 184         def download():
 185             data_len = ctx.data.info().get('Content-length', None)
 186
 187             # Range HTTP header may be ignored/unsupported by a webserver
 188             # (e.g. extractor/scivee.py, extractor/bambuser.py).
 189             # However, for a test we still would like to download just a piece of a file.
 190             # To achieve this we limit data_len to _TEST_FILE_SIZE and manually control
 191             # block size when downloading a file.
 192             if is_test and (data_len is None or int(data_len) > self._TEST_FILE_SIZE):
 193                 data_len = self._TEST_FILE_SIZE
 194
 195             if data_len is not None:
 196                 data_len = int(data_len) + ctx.resume_len
 197                 min_data_len = self.params.get('min_filesize')
 198                 max_data_len = self.params.get('max_filesize')
 199                 if min_data_len is not None and data_len < min_data_len:
 200                     self.to_screen('\r[download] File is smaller than min-filesize (%s bytes < %s bytes). Aborting.' % (data_len, min_data_len))
 201                     return False
 202                 if max_data_len is not None and data_len > max_data_len:
 203                     self.to_screen('\r[download] File is larger than max-filesize (%s bytes > %s bytes). Aborting.' % (data_len, max_data_len))
 204                     return False
 205
 206             byte_counter = 0 + ctx.resume_len
 207             block_size = ctx.block_size
 208             start = time.time()
 209
 210             # measure time over whole while-loop, so slow_down() and best_block_size() work together properly
 211             now = None  # needed for slow_down() in the first loop run
 212             before = start  # start measuring
 213
 214             def retry(e):
 215                 if ctx.tmpfilename != '-':
 216                     ctx.stream.close()
 217                 ctx.stream = None
 218                 ctx.resume_len = os.path.getsize(encodeFilename(ctx.tmpfilename))
 219                 raise RetryDownload(e)
 220
 221             while True:
 222                 try:
 223                     # Download and write
 224                     data_block = ctx.data.read(block_size if not is_test else min(block_size, data_len - byte_counter))
 225                 # socket.timeout is a subclass of socket.error but may not have
 226                 # errno set
 227                 except socket.timeout as e:
 228                     retry(e)
 229                 except socket.error as e:
 230                     if e.errno not in (errno.ECONNRESET, errno.ETIMEDOUT):
 231                         raise
 232                     retry(e)
 233
 234                 byte_counter += len(data_block)
 235
 236                 # exit loop when download is finished
 237                 if len(data_block) == 0:
 238                     break
 239
 240                 # Open destination file just in time
 241                 if ctx.stream is None:
 242                     try:
 243                         ctx.stream, ctx.tmpfilename = sanitize_open(
 244                             ctx.tmpfilename, ctx.open_mode)
 245                         assert ctx.stream is not None
 246                         ctx.filename = self.undo_temp_name(ctx.tmpfilename)
 247                         self.report_destination(ctx.filename)
 248                     except (OSError, IOError) as err:
 249                         self.report_error('unable to open for writing: %s' % str(err))
 250                         return False
 251
 252                     if self.params.get('xattr_set_filesize', False) and data_len is not None:
 253                         try:
 254                             write_xattr(ctx.tmpfilename, 'user.ytdl.filesize', str(data_len).encode('utf-8'))
 255                         except (XAttrUnavailableError, XAttrMetadataError) as err:
 256                             self.report_error('unable to set filesize xattr: %s' % str(err))
 257
 258                 try:
 259                     ctx.stream.write(data_block)
 260                 except (IOError, OSError) as err:
 261                     self.to_stderr('\n')
 262                     self.report_error('unable to write data: %s' % str(err))
 263                     return False
 264
 265                 # Apply rate limit
 266                 self.slow_down(start, now, byte_counter - ctx.resume_len)
 267
 268                 # end measuring of one loop run
 269                 now = time.time()
 270                 after = now
 271
 272                 # Adjust block size
 273                 if not self.params.get('noresizebuffer', False):
 274                     block_size = self.best_block_size(after - before, len(data_block))
 275
 276                 before = after
 277
 278                 # Progress message
 279                 speed = self.calc_speed(start, now, byte_counter - ctx.resume_len)
 280                 if ctx.data_len is None:
 281                     eta = None
 282                 else:
 283                     eta = self.calc_eta(start, time.time(), ctx.data_len - ctx.resume_len, byte_counter - ctx.resume_len)
 284
 285                 self._hook_progress({
 286                     'status': 'downloading',
 287                     'downloaded_bytes': byte_counter,
 288                     'total_bytes': ctx.data_len,
 289                     'tmpfilename': ctx.tmpfilename,
 290                     'filename': ctx.filename,
 291                     'eta': eta,
 292                     'speed': speed,
 293                     'elapsed': now - ctx.start_time,
 294                 })
 295
 296                 if is_test and byte_counter == data_len:
 297                     break
 298
 299             if not is_test and chunk_size and ctx.data_len is not None and byte_counter < ctx.data_len:
 300                 ctx.resume_len = byte_counter
 301                 # ctx.block_size = block_size
 302                 raise NextFragment()
 303
 304             if ctx.stream is None:
 305                 self.to_stderr('\n')
 306                 self.report_error('Did not get any data blocks')
 307                 return False
 308             if ctx.tmpfilename != '-':
 309                 ctx.stream.close()
 310
 311             if data_len is not None and byte_counter != data_len:
 312                 err = ContentTooShortError(byte_counter, int(data_len))
 313                 if count <= retries:
 314                     retry(err)
 315                 raise err
 316
 317             self.try_rename(ctx.tmpfilename, ctx.filename)
 318
 319             # Update file modification time
 320             if self.params.get('updatetime', True):
 321                 info_dict['filetime'] = self.try_utime(ctx.filename, ctx.data.info().get('last-modified', None))
 322
 323             self._hook_progress({
 324                 'downloaded_bytes': byte_counter,
 325                 'total_bytes': byte_counter,
 326                 'filename': ctx.filename,
 327                 'status': 'finished',
 328                 'elapsed': time.time() - ctx.start_time,
 329             })
 330
 331             return True
 332
 333         while count <= retries:
 334             try:
 335                 establish_connection()
 336                 return download()
 337             except RetryDownload as e:
 338                 count += 1
 339                 if count <= retries:
 340                     self.report_retry(e.source_error, count, retries)
 341                 continue
 342             except NextFragment:
 343                 continue
 344             except SucceedDownload:
 345                 return True
 346
 347         self.report_error('giving up after %s retries' % retries)
 348         return False