_ Git - youtube-dl/blob - youtube_dl/FileDownloader.py

   1 #!/usr/bin/env python
   2 # -*- coding: utf-8 -*-
   3
   4 from __future__ import absolute_import
   5
   6 import math
   7 import io
   8 import os
   9 import re
  10 import socket
  11 import subprocess
  12 import sys
  13 import time
  14 import traceback
  15
  16 if os.name == 'nt':
  17     import ctypes
  18
  19 from .utils import *
  20
  21
  22 class FileDownloader(object):
  23     """File Downloader class.
  24
  25     File downloader objects are the ones responsible of downloading the
  26     actual video file and writing it to disk if the user has requested
  27     it, among some other tasks. In most cases there should be one per
  28     program. As, given a video URL, the downloader doesn't know how to
  29     extract all the needed information, task that InfoExtractors do, it
  30     has to pass the URL to one of them.
  31
  32     For this, file downloader objects have a method that allows
  33     InfoExtractors to be registered in a given order. When it is passed
  34     a URL, the file downloader handles it to the first InfoExtractor it
  35     finds that reports being able to handle it. The InfoExtractor extracts
  36     all the information about the video or videos the URL refers to, and
  37     asks the FileDownloader to process the video information, possibly
  38     downloading the video.
  39
  40     File downloaders accept a lot of parameters. In order not to saturate
  41     the object constructor with arguments, it receives a dictionary of
  42     options instead. These options are available through the params
  43     attribute for the InfoExtractors to use. The FileDownloader also
  44     registers itself as the downloader in charge for the InfoExtractors
  45     that are added to it, so this is a "mutual registration".
  46
  47     Available options:
  48
  49     username:          Username for authentication purposes.
  50     password:          Password for authentication purposes.
  51     usenetrc:          Use netrc for authentication instead.
  52     quiet:             Do not print messages to stdout.
  53     forceurl:          Force printing final URL.
  54     forcetitle:        Force printing title.
  55     forcethumbnail:    Force printing thumbnail URL.
  56     forcedescription:  Force printing description.
  57     forcefilename:     Force printing final filename.
  58     simulate:          Do not download the video files.
  59     format:            Video format code.
  60     format_limit:      Highest quality format to try.
  61     outtmpl:           Template for output names.
  62     restrictfilenames: Do not allow "&" and spaces in file names
  63     ignoreerrors:      Do not stop on download errors.
  64     ratelimit:         Download speed limit, in bytes/sec.
  65     nooverwrites:      Prevent overwriting files.
  66     retries:           Number of times to retry for HTTP error 5xx
  67     buffersize:        Size of download buffer in bytes.
  68     noresizebuffer:    Do not automatically resize the download buffer.
  69     continuedl:        Try to continue downloads if possible.
  70     noprogress:        Do not print the progress bar.
  71     playliststart:     Playlist item to start at.
  72     playlistend:       Playlist item to end at.
  73     matchtitle:        Download only matching titles.
  74     rejecttitle:       Reject downloads for matching titles.
  75     logtostderr:       Log messages to stderr instead of stdout.
  76     consoletitle:      Display progress in console window's titlebar.
  77     nopart:            Do not use temporary .part files.
  78     updatetime:        Use the Last-modified header to set output file timestamps.
  79     writedescription:  Write the video description to a .description file
  80     writeinfojson:     Write the video description to a .info.json file
  81     writesubtitles:    Write the video subtitles to a file
  82     onlysubtitles:     Downloads only the subtitles of the video
  83     allsubtitles:      Downloads all the subtitles of the video
  84     listsubtitles:     Lists all available subtitles for the video
  85     subtitlesformat:   Subtitle format [sbv/srt] (default=srt)
  86     subtitleslang:     Language of the subtitles to download
  87     test:              Download only first bytes to test the downloader.
  88     keepvideo:         Keep the video file after post-processing
  89     min_filesize:      Skip files smaller than this size
  90     max_filesize:      Skip files larger than this size
  91     """
  92
  93     params = None
  94     _ies = []
  95     _pps = []
  96     _download_retcode = None
  97     _num_downloads = None
  98     _screen_file = None
  99
 100     def __init__(self, params):
 101         """Create a FileDownloader object with the given options."""
 102         self._ies = []
 103         self._pps = []
 104         self._progress_hooks = []
 105         self._download_retcode = 0
 106         self._num_downloads = 0
 107         self._screen_file = [sys.stdout, sys.stderr][params.get('logtostderr', False)]
 108         self.params = params
 109
 110         if '%(stitle)s' in self.params['outtmpl']:
 111             self.report_warning(u'%(stitle)s is deprecated. Use the %(title)s and the --restrict-filenames flag(which also secures %(uploader)s et al) instead.')
 112
 113     @staticmethod
 114     def format_bytes(bytes):
 115         if bytes is None:
 116             return 'N/A'
 117         if type(bytes) is str:
 118             bytes = float(bytes)
 119         if bytes == 0.0:
 120             exponent = 0
 121         else:
 122             exponent = int(math.log(bytes, 1024.0))
 123         suffix = 'bkMGTPEZY'[exponent]
 124         converted = float(bytes) / float(1024 ** exponent)
 125         return '%.2f%s' % (converted, suffix)
 126
 127     @staticmethod
 128     def calc_percent(byte_counter, data_len):
 129         if data_len is None:
 130             return '---.-%'
 131         return '%6s' % ('%3.1f%%' % (float(byte_counter) / float(data_len) * 100.0))
 132
 133     @staticmethod
 134     def calc_eta(start, now, total, current):
 135         if total is None:
 136             return '--:--'
 137         dif = now - start
 138         if current == 0 or dif < 0.001: # One millisecond
 139             return '--:--'
 140         rate = float(current) / dif
 141         eta = int((float(total) - float(current)) / rate)
 142         (eta_mins, eta_secs) = divmod(eta, 60)
 143         if eta_mins > 99:
 144             return '--:--'
 145         return '%02d:%02d' % (eta_mins, eta_secs)
 146
 147     @staticmethod
 148     def calc_speed(start, now, bytes):
 149         dif = now - start
 150         if bytes == 0 or dif < 0.001: # One millisecond
 151             return '%10s' % '---b/s'
 152         return '%10s' % ('%s/s' % FileDownloader.format_bytes(float(bytes) / dif))
 153
 154     @staticmethod
 155     def best_block_size(elapsed_time, bytes):
 156         new_min = max(bytes / 2.0, 1.0)
 157         new_max = min(max(bytes * 2.0, 1.0), 4194304) # Do not surpass 4 MB
 158         if elapsed_time < 0.001:
 159             return int(new_max)
 160         rate = bytes / elapsed_time
 161         if rate > new_max:
 162             return int(new_max)
 163         if rate < new_min:
 164             return int(new_min)
 165         return int(rate)
 166
 167     @staticmethod
 168     def parse_bytes(bytestr):
 169         """Parse a string indicating a byte quantity into an integer."""
 170         matchobj = re.match(r'(?i)^(\d+(?:\.\d+)?)([kMGTPEZY]?)$', bytestr)
 171         if matchobj is None:
 172             return None
 173         number = float(matchobj.group(1))
 174         multiplier = 1024.0 ** 'bkmgtpezy'.index(matchobj.group(2).lower())
 175         return int(round(number * multiplier))
 176
 177     def add_info_extractor(self, ie):
 178         """Add an InfoExtractor object to the end of the list."""
 179         self._ies.append(ie)
 180         ie.set_downloader(self)
 181
 182     def add_post_processor(self, pp):
 183         """Add a PostProcessor object to the end of the chain."""
 184         self._pps.append(pp)
 185         pp.set_downloader(self)
 186
 187     def to_screen(self, message, skip_eol=False):
 188         """Print message to stdout if not in quiet mode."""
 189         assert type(message) == type(u'')
 190         if not self.params.get('quiet', False):
 191             terminator = [u'\n', u''][skip_eol]
 192             output = message + terminator
 193             if 'b' in getattr(self._screen_file, 'mode', '') or sys.version_info[0] < 3: # Python 2 lies about the mode of sys.stdout/sys.stderr
 194                 output = output.encode(preferredencoding(), 'ignore')
 195             self._screen_file.write(output)
 196             self._screen_file.flush()
 197
 198     def to_stderr(self, message):
 199         """Print message to stderr."""
 200         assert type(message) == type(u'')
 201         output = message + u'\n'
 202         if 'b' in getattr(self._screen_file, 'mode', '') or sys.version_info[0] < 3: # Python 2 lies about the mode of sys.stdout/sys.stderr
 203             output = output.encode(preferredencoding())
 204         sys.stderr.write(output)
 205
 206     def to_cons_title(self, message):
 207         """Set console/terminal window title to message."""
 208         if not self.params.get('consoletitle', False):
 209             return
 210         if os.name == 'nt' and ctypes.windll.kernel32.GetConsoleWindow():
 211             # c_wchar_p() might not be necessary if `message` is
 212             # already of type unicode()
 213             ctypes.windll.kernel32.SetConsoleTitleW(ctypes.c_wchar_p(message))
 214         elif 'TERM' in os.environ:
 215             self.to_screen('\033]0;%s\007' % message, skip_eol=True)
 216
 217     def fixed_template(self):
 218         """Checks if the output template is fixed."""
 219         return (re.search(u'(?u)%\\(.+?\\)s', self.params['outtmpl']) is None)
 220
 221     def trouble(self, message=None, tb=None):
 222         """Determine action to take when a download problem appears.
 223
 224         Depending on if the downloader has been configured to ignore
 225         download errors or not, this method may throw an exception or
 226         not when errors are found, after printing the message.
 227
 228         tb, if given, is additional traceback information.
 229         """
 230         if message is not None:
 231             self.to_stderr(message)
 232         if self.params.get('verbose'):
 233             if tb is None:
 234                 tb_data = traceback.format_list(traceback.extract_stack())
 235                 tb = u''.join(tb_data)
 236             self.to_stderr(tb)
 237         if not self.params.get('ignoreerrors', False):
 238             raise DownloadError(message)
 239         self._download_retcode = 1
 240
 241     def report_warning(self, message):
 242         '''
 243         Print the message to stderr, it will be prefixed with 'WARNING:'
 244         If stderr is a tty file the 'WARNING:' will be colored
 245         '''
 246         if sys.stderr.isatty():
 247             _msg_header=u'\033[0;33mWARNING:\033[0m'
 248         else:
 249             _msg_header=u'WARNING:'
 250         warning_message=u'%s %s' % (_msg_header,message)
 251         self.to_stderr(warning_message)
 252
 253     def slow_down(self, start_time, byte_counter):
 254         """Sleep if the download speed is over the rate limit."""
 255         rate_limit = self.params.get('ratelimit', None)
 256         if rate_limit is None or byte_counter == 0:
 257             return
 258         now = time.time()
 259         elapsed = now - start_time
 260         if elapsed <= 0.0:
 261             return
 262         speed = float(byte_counter) / elapsed
 263         if speed > rate_limit:
 264             time.sleep((byte_counter - rate_limit * (now - start_time)) / rate_limit)
 265
 266     def temp_name(self, filename):
 267         """Returns a temporary filename for the given filename."""
 268         if self.params.get('nopart', False) or filename == u'-' or \
 269                 (os.path.exists(encodeFilename(filename)) and not os.path.isfile(encodeFilename(filename))):
 270             return filename
 271         return filename + u'.part'
 272
 273     def undo_temp_name(self, filename):
 274         if filename.endswith(u'.part'):
 275             return filename[:-len(u'.part')]
 276         return filename
 277
 278     def try_rename(self, old_filename, new_filename):
 279         try:
 280             if old_filename == new_filename:
 281                 return
 282             os.rename(encodeFilename(old_filename), encodeFilename(new_filename))
 283         except (IOError, OSError) as err:
 284             self.trouble(u'ERROR: unable to rename file')
 285
 286     def try_utime(self, filename, last_modified_hdr):
 287         """Try to set the last-modified time of the given file."""
 288         if last_modified_hdr is None:
 289             return
 290         if not os.path.isfile(encodeFilename(filename)):
 291             return
 292         timestr = last_modified_hdr
 293         if timestr is None:
 294             return
 295         filetime = timeconvert(timestr)
 296         if filetime is None:
 297             return filetime
 298         try:
 299             os.utime(filename, (time.time(), filetime))
 300         except:
 301             pass
 302         return filetime
 303
 304     def report_writedescription(self, descfn):
 305         """ Report that the description file is being written """
 306         self.to_screen(u'[info] Writing video description to: ' + descfn)
 307
 308     def report_writesubtitles(self, sub_filename):
 309         """ Report that the subtitles file is being written """
 310         self.to_screen(u'[info] Writing video subtitles to: ' + sub_filename)
 311
 312     def report_writeinfojson(self, infofn):
 313         """ Report that the metadata file has been written """
 314         self.to_screen(u'[info] Video description metadata as JSON to: ' + infofn)
 315
 316     def report_destination(self, filename):
 317         """Report destination filename."""
 318         self.to_screen(u'[download] Destination: ' + filename)
 319
 320     def report_progress(self, percent_str, data_len_str, speed_str, eta_str):
 321         """Report download progress."""
 322         if self.params.get('noprogress', False):
 323             return
 324         if self.params.get('progress_with_newline', False):
 325             self.to_screen(u'[download] %s of %s at %s ETA %s' %
 326                 (percent_str, data_len_str, speed_str, eta_str))
 327         else:
 328             self.to_screen(u'\r[download] %s of %s at %s ETA %s' %
 329                 (percent_str, data_len_str, speed_str, eta_str), skip_eol=True)
 330         self.to_cons_title(u'youtube-dl - %s of %s at %s ETA %s' %
 331                 (percent_str.strip(), data_len_str.strip(), speed_str.strip(), eta_str.strip()))
 332
 333     def report_resuming_byte(self, resume_len):
 334         """Report attempt to resume at given byte."""
 335         self.to_screen(u'[download] Resuming download at byte %s' % resume_len)
 336
 337     def report_retry(self, count, retries):
 338         """Report retry in case of HTTP error 5xx"""
 339         self.to_screen(u'[download] Got server HTTP error. Retrying (attempt %d of %d)...' % (count, retries))
 340
 341     def report_file_already_downloaded(self, file_name):
 342         """Report file has already been fully downloaded."""
 343         try:
 344             self.to_screen(u'[download] %s has already been downloaded' % file_name)
 345         except (UnicodeEncodeError) as err:
 346             self.to_screen(u'[download] The file has already been downloaded')
 347
 348     def report_unable_to_resume(self):
 349         """Report it was impossible to resume download."""
 350         self.to_screen(u'[download] Unable to resume')
 351
 352     def report_finish(self):
 353         """Report download finished."""
 354         if self.params.get('noprogress', False):
 355             self.to_screen(u'[download] Download completed')
 356         else:
 357             self.to_screen(u'')
 358
 359     def increment_downloads(self):
 360         """Increment the ordinal that assigns a number to each file."""
 361         self._num_downloads += 1
 362
 363     def prepare_filename(self, info_dict):
 364         """Generate the output filename."""
 365         try:
 366             template_dict = dict(info_dict)
 367
 368             template_dict['epoch'] = int(time.time())
 369             template_dict['autonumber'] = u'%05d' % self._num_downloads
 370
 371             sanitize = lambda k,v: sanitize_filename(
 372                 u'NA' if v is None else compat_str(v),
 373                 restricted=self.params.get('restrictfilenames'),
 374                 is_id=(k==u'id'))
 375             template_dict = dict((k, sanitize(k, v)) for k,v in template_dict.items())
 376
 377             filename = self.params['outtmpl'] % template_dict
 378             return filename
 379         except KeyError as err:
 380             self.trouble(u'ERROR: Erroneous output template')
 381             return None
 382         except ValueError as err:
 383             self.trouble(u'ERROR: Insufficient system charset ' + repr(preferredencoding()))
 384             return None
 385
 386     def _match_entry(self, info_dict):
 387         """ Returns None iff the file should be downloaded """
 388
 389         title = info_dict['title']
 390         matchtitle = self.params.get('matchtitle', False)
 391         if matchtitle:
 392             if not re.search(matchtitle, title, re.IGNORECASE):
 393                 return u'[download] "' + title + '" title did not match pattern "' + matchtitle + '"'
 394         rejecttitle = self.params.get('rejecttitle', False)
 395         if rejecttitle:
 396             if re.search(rejecttitle, title, re.IGNORECASE):
 397                 return u'"' + title + '" title matched reject pattern "' + rejecttitle + '"'
 398         return None
 399
 400     def process_info(self, info_dict):
 401         """Process a single dictionary returned by an InfoExtractor."""
 402
 403         # Keep for backwards compatibility
 404         info_dict['stitle'] = info_dict['title']
 405
 406         if not 'format' in info_dict:
 407             info_dict['format'] = info_dict['ext']
 408
 409         reason = self._match_entry(info_dict)
 410         if reason is not None:
 411             self.to_screen(u'[download] ' + reason)
 412             return
 413
 414         max_downloads = self.params.get('max_downloads')
 415         if max_downloads is not None:
 416             if self._num_downloads > int(max_downloads):
 417                 raise MaxDownloadsReached()
 418
 419         filename = self.prepare_filename(info_dict)
 420
 421         # Forced printings
 422         if self.params.get('forcetitle', False):
 423             compat_print(info_dict['title'])
 424         if self.params.get('forceurl', False):
 425             compat_print(info_dict['url'])
 426         if self.params.get('forcethumbnail', False) and 'thumbnail' in info_dict:
 427             compat_print(info_dict['thumbnail'])
 428         if self.params.get('forcedescription', False) and 'description' in info_dict:
 429             compat_print(info_dict['description'])
 430         if self.params.get('forcefilename', False) and filename is not None:
 431             compat_print(filename)
 432         if self.params.get('forceformat', False):
 433             compat_print(info_dict['format'])
 434
 435         # Do nothing else if in simulate mode
 436         if self.params.get('simulate', False):
 437             return
 438
 439         if filename is None:
 440             return
 441
 442         try:
 443             dn = os.path.dirname(encodeFilename(filename))
 444             if dn != '' and not os.path.exists(dn): # dn is already encoded
 445                 os.makedirs(dn)
 446         except (OSError, IOError) as err:
 447             self.trouble(u'ERROR: unable to create directory ' + compat_str(err))
 448             return
 449
 450         if self.params.get('writedescription', False):
 451             try:
 452                 descfn = filename + u'.description'
 453                 self.report_writedescription(descfn)
 454                 with io.open(encodeFilename(descfn), 'w', encoding='utf-8') as descfile:
 455                     descfile.write(info_dict['description'])
 456             except (OSError, IOError):
 457                 self.trouble(u'ERROR: Cannot write description file ' + descfn)
 458                 return
 459
 460         if self.params.get('writesubtitles', False) and 'subtitles' in info_dict and info_dict['subtitles']:
 461             # subtitles download errors are already managed as troubles in relevant IE
 462             # that way it will silently go on when used with unsupporting IE
 463             subtitle = info_dict['subtitles'][0]
 464             (sub_error, sub_lang, sub) = subtitle
 465             sub_format = self.params.get('subtitlesformat')
 466             try:
 467                 sub_filename = filename.rsplit('.', 1)[0] + u'.' + sub_lang + u'.' + sub_format
 468                 self.report_writesubtitles(sub_filename)
 469                 with io.open(encodeFilename(sub_filename), 'w', encoding='utf-8') as subfile:
 470                     subfile.write(sub)
 471             except (OSError, IOError):
 472                 self.trouble(u'ERROR: Cannot write subtitles file ' + descfn)
 473                 return
 474             if self.params.get('onlysubtitles', False):
 475                 return
 476
 477         if self.params.get('allsubtitles', False) and 'subtitles' in info_dict and info_dict['subtitles']:
 478             subtitles = info_dict['subtitles']
 479             sub_format = self.params.get('subtitlesformat')
 480             for subtitle in subtitles:
 481                 (sub_error, sub_lang, sub) = subtitle
 482                 try:
 483                     sub_filename = filename.rsplit('.', 1)[0] + u'.' + sub_lang + u'.' + sub_format
 484                     self.report_writesubtitles(sub_filename)
 485                     with io.open(encodeFilename(sub_filename), 'w', encoding='utf-8') as subfile:
 486                             subfile.write(sub)
 487                 except (OSError, IOError):
 488                     self.trouble(u'ERROR: Cannot write subtitles file ' + descfn)
 489                     return
 490             if self.params.get('onlysubtitles', False):
 491                 return
 492
 493         if self.params.get('writeinfojson', False):
 494             infofn = filename + u'.info.json'
 495             self.report_writeinfojson(infofn)
 496             try:
 497                 json_info_dict = dict((k, v) for k,v in info_dict.items() if not k in ['urlhandle'])
 498                 write_json_file(json_info_dict, encodeFilename(infofn))
 499             except (OSError, IOError):
 500                 self.trouble(u'ERROR: Cannot write metadata to JSON file ' + infofn)
 501                 return
 502
 503         if not self.params.get('skip_download', False):
 504             if self.params.get('nooverwrites', False) and os.path.exists(encodeFilename(filename)):
 505                 success = True
 506             else:
 507                 try:
 508                     success = self._do_download(filename, info_dict)
 509                 except (OSError, IOError) as err:
 510                     raise UnavailableVideoError()
 511                 except (compat_urllib_error.URLError, compat_http_client.HTTPException, socket.error) as err:
 512                     self.trouble(u'ERROR: unable to download video data: %s' % str(err))
 513                     return
 514                 except (ContentTooShortError, ) as err:
 515                     self.trouble(u'ERROR: content too short (expected %s bytes and served %s)' % (err.expected, err.downloaded))
 516                     return
 517
 518             if success:
 519                 try:
 520                     self.post_process(filename, info_dict)
 521                 except (PostProcessingError) as err:
 522                     self.trouble(u'ERROR: postprocessing: %s' % str(err))
 523                     return
 524
 525     def download(self, url_list):
 526         """Download a given list of URLs."""
 527         if len(url_list) > 1 and self.fixed_template():
 528             raise SameFileError(self.params['outtmpl'])
 529
 530         for url in url_list:
 531             suitable_found = False
 532             for ie in self._ies:
 533                 # Go to next InfoExtractor if not suitable
 534                 if not ie.suitable(url):
 535                     continue
 536
 537                 # Warn if the _WORKING attribute is False
 538                 if not ie.working():
 539                     self.report_warning(u'the program functionality for this site has been marked as broken, '
 540                                         u'and will probably not work. If you want to go on, use the -i option.')
 541
 542                 # Suitable InfoExtractor found
 543                 suitable_found = True
 544
 545                 # Extract information from URL and process it
 546                 try:
 547                     videos = ie.extract(url)
 548                 except ExtractorError as de: # An error we somewhat expected
 549                     self.trouble(u'ERROR: ' + compat_str(de), de.format_traceback())
 550                     break
 551                 except Exception as e:
 552                     if self.params.get('ignoreerrors', False):
 553                         self.trouble(u'ERROR: ' + compat_str(e), tb=compat_str(traceback.format_exc()))
 554                         break
 555                     else:
 556                         raise
 557
 558                 if len(videos or []) > 1 and self.fixed_template():
 559                     raise SameFileError(self.params['outtmpl'])
 560
 561                 for video in videos or []:
 562                     video['extractor'] = ie.IE_NAME
 563                     try:
 564                         self.increment_downloads()
 565                         self.process_info(video)
 566                     except UnavailableVideoError:
 567                         self.trouble(u'\nERROR: unable to download video')
 568
 569                 # Suitable InfoExtractor had been found; go to next URL
 570                 break
 571
 572             if not suitable_found:
 573                 self.trouble(u'ERROR: no suitable InfoExtractor: %s' % url)
 574
 575         return self._download_retcode
 576
 577     def post_process(self, filename, ie_info):
 578         """Run all the postprocessors on the given file."""
 579         info = dict(ie_info)
 580         info['filepath'] = filename
 581         keep_video = None
 582         for pp in self._pps:
 583             try:
 584                 keep_video_wish,new_info = pp.run(info)
 585                 if keep_video_wish is not None:
 586                     if keep_video_wish:
 587                         keep_video = keep_video_wish
 588                     elif keep_video is None:
 589                         # No clear decision yet, let IE decide
 590                         keep_video = keep_video_wish
 591             except PostProcessingError as e:
 592                 self.to_stderr(u'ERROR: ' + e.msg)
 593         if keep_video is False and not self.params.get('keepvideo', False):
 594             try:
 595                 self.to_screen(u'Deleting original file %s (pass -k to keep)' % filename)
 596                 os.remove(encodeFilename(filename))
 597             except (IOError, OSError):
 598                 self.report_warning(u'Unable to remove downloaded video file')
 599
 600     def _download_with_rtmpdump(self, filename, url, player_url, page_url):
 601         self.report_destination(filename)
 602         tmpfilename = self.temp_name(filename)
 603
 604         # Check for rtmpdump first
 605         try:
 606             subprocess.call(['rtmpdump', '-h'], stdout=(open(os.path.devnull, 'w')), stderr=subprocess.STDOUT)
 607         except (OSError, IOError):
 608             self.trouble(u'ERROR: RTMP download detected but "rtmpdump" could not be run')
 609             return False
 610
 611         # Download using rtmpdump. rtmpdump returns exit code 2 when
 612         # the connection was interrumpted and resuming appears to be
 613         # possible. This is part of rtmpdump's normal usage, AFAIK.
 614         basic_args = ['rtmpdump', '-q', '-r', url, '-o', tmpfilename]
 615         if player_url is not None:
 616             basic_args += ['-W', player_url]
 617         if page_url is not None:
 618             basic_args += ['--pageUrl', page_url]
 619         args = basic_args + [[], ['-e', '-k', '1']][self.params.get('continuedl', False)]
 620         if self.params.get('verbose', False):
 621             try:
 622                 import pipes
 623                 shell_quote = lambda args: ' '.join(map(pipes.quote, args))
 624             except ImportError:
 625                 shell_quote = repr
 626             self.to_screen(u'[debug] rtmpdump command line: ' + shell_quote(args))
 627         retval = subprocess.call(args)
 628         while retval == 2 or retval == 1:
 629             prevsize = os.path.getsize(encodeFilename(tmpfilename))
 630             self.to_screen(u'\r[rtmpdump] %s bytes' % prevsize, skip_eol=True)
 631             time.sleep(5.0) # This seems to be needed
 632             retval = subprocess.call(basic_args + ['-e'] + [[], ['-k', '1']][retval == 1])
 633             cursize = os.path.getsize(encodeFilename(tmpfilename))
 634             if prevsize == cursize and retval == 1:
 635                 break
 636              # Some rtmp streams seem abort after ~ 99.8%. Don't complain for those
 637             if prevsize == cursize and retval == 2 and cursize > 1024:
 638                 self.to_screen(u'\r[rtmpdump] Could not download the whole video. This can happen for some advertisements.')
 639                 retval = 0
 640                 break
 641         if retval == 0:
 642             fsize = os.path.getsize(encodeFilename(tmpfilename))
 643             self.to_screen(u'\r[rtmpdump] %s bytes' % fsize)
 644             self.try_rename(tmpfilename, filename)
 645             self._hook_progress({
 646                 'downloaded_bytes': fsize,
 647                 'total_bytes': fsize,
 648                 'filename': filename,
 649                 'status': 'finished',
 650             })
 651             return True
 652         else:
 653             self.trouble(u'\nERROR: rtmpdump exited with code %d' % retval)
 654             return False
 655
 656     def _do_download(self, filename, info_dict):
 657         url = info_dict['url']
 658
 659         # Check file already present
 660         if self.params.get('continuedl', False) and os.path.isfile(encodeFilename(filename)) and not self.params.get('nopart', False):
 661             self.report_file_already_downloaded(filename)
 662             self._hook_progress({
 663                 'filename': filename,
 664                 'status': 'finished',
 665             })
 666             return True
 667
 668         # Attempt to download using rtmpdump
 669         if url.startswith('rtmp'):
 670             return self._download_with_rtmpdump(filename, url,
 671                                                 info_dict.get('player_url', None),
 672                                                 info_dict.get('page_url', None))
 673
 674         tmpfilename = self.temp_name(filename)
 675         stream = None
 676
 677         # Do not include the Accept-Encoding header
 678         headers = {'Youtubedl-no-compression': 'True'}
 679         if 'user_agent' in info_dict:
 680             headers['Youtubedl-user-agent'] = info_dict['user_agent']
 681         basic_request = compat_urllib_request.Request(url, None, headers)
 682         request = compat_urllib_request.Request(url, None, headers)
 683
 684         if self.params.get('test', False):
 685             request.add_header('Range','bytes=0-10240')
 686
 687         # Establish possible resume length
 688         if os.path.isfile(encodeFilename(tmpfilename)):
 689             resume_len = os.path.getsize(encodeFilename(tmpfilename))
 690         else:
 691             resume_len = 0
 692
 693         open_mode = 'wb'
 694         if resume_len != 0:
 695             if self.params.get('continuedl', False):
 696                 self.report_resuming_byte(resume_len)
 697                 request.add_header('Range','bytes=%d-' % resume_len)
 698                 open_mode = 'ab'
 699             else:
 700                 resume_len = 0
 701
 702         count = 0
 703         retries = self.params.get('retries', 0)
 704         while count <= retries:
 705             # Establish connection
 706             try:
 707                 if count == 0 and 'urlhandle' in info_dict:
 708                     data = info_dict['urlhandle']
 709                 data = compat_urllib_request.urlopen(request)
 710                 break
 711             except (compat_urllib_error.HTTPError, ) as err:
 712                 if (err.code < 500 or err.code >= 600) and err.code != 416:
 713                     # Unexpected HTTP error
 714                     raise
 715                 elif err.code == 416:
 716                     # Unable to resume (requested range not satisfiable)
 717                     try:
 718                         # Open the connection again without the range header
 719                         data = compat_urllib_request.urlopen(basic_request)
 720                         content_length = data.info()['Content-Length']
 721                     except (compat_urllib_error.HTTPError, ) as err:
 722                         if err.code < 500 or err.code >= 600:
 723                             raise
 724                     else:
 725                         # Examine the reported length
 726                         if (content_length is not None and
 727                                 (resume_len - 100 < int(content_length) < resume_len + 100)):
 728                             # The file had already been fully downloaded.
 729                             # Explanation to the above condition: in issue #175 it was revealed that
 730                             # YouTube sometimes adds or removes a few bytes from the end of the file,
 731                             # changing the file size slightly and causing problems for some users. So
 732                             # I decided to implement a suggested change and consider the file
 733                             # completely downloaded if the file size differs less than 100 bytes from
 734                             # the one in the hard drive.
 735                             self.report_file_already_downloaded(filename)
 736                             self.try_rename(tmpfilename, filename)
 737                             self._hook_progress({
 738                                 'filename': filename,
 739                                 'status': 'finished',
 740                             })
 741                             return True
 742                         else:
 743                             # The length does not match, we start the download over
 744                             self.report_unable_to_resume()
 745                             open_mode = 'wb'
 746                             break
 747             # Retry
 748             count += 1
 749             if count <= retries:
 750                 self.report_retry(count, retries)
 751
 752         if count > retries:
 753             self.trouble(u'ERROR: giving up after %s retries' % retries)
 754             return False
 755
 756         data_len = data.info().get('Content-length', None)
 757         if data_len is not None:
 758             data_len = int(data_len) + resume_len
 759             min_data_len = self.params.get("min_filesize", None)
 760             max_data_len =  self.params.get("max_filesize", None)
 761             if min_data_len is not None and data_len < min_data_len:
 762                 self.to_screen(u'\r[download] File is smaller than min-filesize (%s bytes < %s bytes). Aborting.' % (data_len, min_data_len))
 763                 return False
 764             if max_data_len is not None and data_len > max_data_len:
 765                 self.to_screen(u'\r[download] File is larger than max-filesize (%s bytes > %s bytes). Aborting.' % (data_len, max_data_len))
 766                 return False
 767
 768         data_len_str = self.format_bytes(data_len)
 769         byte_counter = 0 + resume_len
 770         block_size = self.params.get('buffersize', 1024)
 771         start = time.time()
 772         while True:
 773             # Download and write
 774             before = time.time()
 775             data_block = data.read(block_size)
 776             after = time.time()
 777             if len(data_block) == 0:
 778                 break
 779             byte_counter += len(data_block)
 780
 781             # Open file just in time
 782             if stream is None:
 783                 try:
 784                     (stream, tmpfilename) = sanitize_open(tmpfilename, open_mode)
 785                     assert stream is not None
 786                     filename = self.undo_temp_name(tmpfilename)
 787                     self.report_destination(filename)
 788                 except (OSError, IOError) as err:
 789                     self.trouble(u'ERROR: unable to open for writing: %s' % str(err))
 790                     return False
 791             try:
 792                 stream.write(data_block)
 793             except (IOError, OSError) as err:
 794                 self.trouble(u'\nERROR: unable to write data: %s' % str(err))
 795                 return False
 796             if not self.params.get('noresizebuffer', False):
 797                 block_size = self.best_block_size(after - before, len(data_block))
 798
 799             # Progress message
 800             speed_str = self.calc_speed(start, time.time(), byte_counter - resume_len)
 801             if data_len is None:
 802                 self.report_progress('Unknown %', data_len_str, speed_str, 'Unknown ETA')
 803             else:
 804                 percent_str = self.calc_percent(byte_counter, data_len)
 805                 eta_str = self.calc_eta(start, time.time(), data_len - resume_len, byte_counter - resume_len)
 806                 self.report_progress(percent_str, data_len_str, speed_str, eta_str)
 807
 808             self._hook_progress({
 809                 'downloaded_bytes': byte_counter,
 810                 'total_bytes': data_len,
 811                 'tmpfilename': tmpfilename,
 812                 'filename': filename,
 813                 'status': 'downloading',
 814             })
 815
 816             # Apply rate limit
 817             self.slow_down(start, byte_counter - resume_len)
 818
 819         if stream is None:
 820             self.trouble(u'\nERROR: Did not get any data blocks')
 821             return False
 822         stream.close()
 823         self.report_finish()
 824         if data_len is not None and byte_counter != data_len:
 825             raise ContentTooShortError(byte_counter, int(data_len))
 826         self.try_rename(tmpfilename, filename)
 827
 828         # Update file modification time
 829         if self.params.get('updatetime', True):
 830             info_dict['filetime'] = self.try_utime(filename, data.info().get('last-modified', None))
 831
 832         self._hook_progress({
 833             'downloaded_bytes': byte_counter,
 834             'total_bytes': byte_counter,
 835             'filename': filename,
 836             'status': 'finished',
 837         })
 838
 839         return True
 840
 841     def _hook_progress(self, status):
 842         for ph in self._progress_hooks:
 843             ph(status)
 844
 845     def add_progress_hook(self, ph):
 846         """ ph gets called on download progress, with a dictionary with the entries
 847         * filename: The final filename
 848         * status: One of "downloading" and "finished"
 849
 850         It can also have some of the following entries:
 851
 852         * downloaded_bytes: Bytes on disks
 853         * total_bytes: Total bytes, None if unknown
 854         * tmpfilename: The filename we're currently writing to
 855
 856         Hooks are guaranteed to be called at least once (with status "finished")
 857         if the download is successful.
 858         """
 859         self._progress_hooks.append(ph)