_ 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                 if sys.exc_info()[0]:  # if .trouble has been called from an except block
 235                     tb = u''
 236                     if hasattr(sys.exc_info()[1], 'exc_info') and sys.exc_info()[1].exc_info[0]:
 237                         tb += u''.join(traceback.format_exception(*sys.exc_info()[1].exc_info))
 238                     tb += compat_str(traceback.format_exc())
 239                 else:
 240                     tb_data = traceback.format_list(traceback.extract_stack())
 241                     tb = u''.join(tb_data)
 242             self.to_stderr(tb)
 243         if not self.params.get('ignoreerrors', False):
 244             if sys.exc_info()[0] and hasattr(sys.exc_info()[1], 'exc_info') and sys.exc_info()[1].exc_info[0]:
 245                 exc_info = sys.exc_info()[1].exc_info
 246             else:
 247                 exc_info = sys.exc_info()
 248             raise DownloadError(message, exc_info)
 249         self._download_retcode = 1
 250
 251     def report_warning(self, message):
 252         '''
 253         Print the message to stderr, it will be prefixed with 'WARNING:'
 254         If stderr is a tty file the 'WARNING:' will be colored
 255         '''
 256         if sys.stderr.isatty():
 257             _msg_header=u'\033[0;33mWARNING:\033[0m'
 258         else:
 259             _msg_header=u'WARNING:'
 260         warning_message=u'%s %s' % (_msg_header,message)
 261         self.to_stderr(warning_message)
 262
 263     def report_error(self, message, tb=None):
 264         '''
 265         Do the same as trouble, but prefixes the message with 'ERROR:', colored
 266         in red if stderr is a tty file.
 267         '''
 268         if sys.stderr.isatty():
 269             _msg_header = u'\033[0;31mERROR:\033[0m'
 270         else:
 271             _msg_header = u'ERROR:'
 272         error_message = u'%s %s' % (_msg_header, message)
 273         self.trouble(error_message, tb)
 274
 275     def slow_down(self, start_time, byte_counter):
 276         """Sleep if the download speed is over the rate limit."""
 277         rate_limit = self.params.get('ratelimit', None)
 278         if rate_limit is None or byte_counter == 0:
 279             return
 280         now = time.time()
 281         elapsed = now - start_time
 282         if elapsed <= 0.0:
 283             return
 284         speed = float(byte_counter) / elapsed
 285         if speed > rate_limit:
 286             time.sleep((byte_counter - rate_limit * (now - start_time)) / rate_limit)
 287
 288     def temp_name(self, filename):
 289         """Returns a temporary filename for the given filename."""
 290         if self.params.get('nopart', False) or filename == u'-' or \
 291                 (os.path.exists(encodeFilename(filename)) and not os.path.isfile(encodeFilename(filename))):
 292             return filename
 293         return filename + u'.part'
 294
 295     def undo_temp_name(self, filename):
 296         if filename.endswith(u'.part'):
 297             return filename[:-len(u'.part')]
 298         return filename
 299
 300     def try_rename(self, old_filename, new_filename):
 301         try:
 302             if old_filename == new_filename:
 303                 return
 304             os.rename(encodeFilename(old_filename), encodeFilename(new_filename))
 305         except (IOError, OSError) as err:
 306             self.report_error(u'unable to rename file')
 307
 308     def try_utime(self, filename, last_modified_hdr):
 309         """Try to set the last-modified time of the given file."""
 310         if last_modified_hdr is None:
 311             return
 312         if not os.path.isfile(encodeFilename(filename)):
 313             return
 314         timestr = last_modified_hdr
 315         if timestr is None:
 316             return
 317         filetime = timeconvert(timestr)
 318         if filetime is None:
 319             return filetime
 320         try:
 321             os.utime(filename, (time.time(), filetime))
 322         except:
 323             pass
 324         return filetime
 325
 326     def report_writedescription(self, descfn):
 327         """ Report that the description file is being written """
 328         self.to_screen(u'[info] Writing video description to: ' + descfn)
 329
 330     def report_writesubtitles(self, sub_filename):
 331         """ Report that the subtitles file is being written """
 332         self.to_screen(u'[info] Writing video subtitles to: ' + sub_filename)
 333
 334     def report_writeinfojson(self, infofn):
 335         """ Report that the metadata file has been written """
 336         self.to_screen(u'[info] Video description metadata as JSON to: ' + infofn)
 337
 338     def report_destination(self, filename):
 339         """Report destination filename."""
 340         self.to_screen(u'[download] Destination: ' + filename)
 341
 342     def report_progress(self, percent_str, data_len_str, speed_str, eta_str):
 343         """Report download progress."""
 344         if self.params.get('noprogress', False):
 345             return
 346         if self.params.get('progress_with_newline', False):
 347             self.to_screen(u'[download] %s of %s at %s ETA %s' %
 348                 (percent_str, data_len_str, speed_str, eta_str))
 349         else:
 350             self.to_screen(u'\r[download] %s of %s at %s ETA %s' %
 351                 (percent_str, data_len_str, speed_str, eta_str), skip_eol=True)
 352         self.to_cons_title(u'youtube-dl - %s of %s at %s ETA %s' %
 353                 (percent_str.strip(), data_len_str.strip(), speed_str.strip(), eta_str.strip()))
 354
 355     def report_resuming_byte(self, resume_len):
 356         """Report attempt to resume at given byte."""
 357         self.to_screen(u'[download] Resuming download at byte %s' % resume_len)
 358
 359     def report_retry(self, count, retries):
 360         """Report retry in case of HTTP error 5xx"""
 361         self.to_screen(u'[download] Got server HTTP error. Retrying (attempt %d of %d)...' % (count, retries))
 362
 363     def report_file_already_downloaded(self, file_name):
 364         """Report file has already been fully downloaded."""
 365         try:
 366             self.to_screen(u'[download] %s has already been downloaded' % file_name)
 367         except (UnicodeEncodeError) as err:
 368             self.to_screen(u'[download] The file has already been downloaded')
 369
 370     def report_unable_to_resume(self):
 371         """Report it was impossible to resume download."""
 372         self.to_screen(u'[download] Unable to resume')
 373
 374     def report_finish(self):
 375         """Report download finished."""
 376         if self.params.get('noprogress', False):
 377             self.to_screen(u'[download] Download completed')
 378         else:
 379             self.to_screen(u'')
 380
 381     def increment_downloads(self):
 382         """Increment the ordinal that assigns a number to each file."""
 383         self._num_downloads += 1
 384
 385     def prepare_filename(self, info_dict):
 386         """Generate the output filename."""
 387         try:
 388             template_dict = dict(info_dict)
 389
 390             template_dict['epoch'] = int(time.time())
 391             template_dict['autonumber'] = u'%05d' % self._num_downloads
 392
 393             sanitize = lambda k,v: sanitize_filename(
 394                 u'NA' if v is None else compat_str(v),
 395                 restricted=self.params.get('restrictfilenames'),
 396                 is_id=(k==u'id'))
 397             template_dict = dict((k, sanitize(k, v)) for k,v in template_dict.items())
 398
 399             filename = self.params['outtmpl'] % template_dict
 400             return filename
 401         except KeyError as err:
 402             self.trouble(u'ERROR: Erroneous output template')
 403             return None
 404         except ValueError as err:
 405             self.trouble(u'ERROR: Insufficient system charset ' + repr(preferredencoding()))
 406             return None
 407
 408     def _match_entry(self, info_dict):
 409         """ Returns None iff the file should be downloaded """
 410
 411         title = info_dict['title']
 412         matchtitle = self.params.get('matchtitle', False)
 413         if matchtitle:
 414             if not re.search(matchtitle, title, re.IGNORECASE):
 415                 return u'[download] "' + title + '" title did not match pattern "' + matchtitle + '"'
 416         rejecttitle = self.params.get('rejecttitle', False)
 417         if rejecttitle:
 418             if re.search(rejecttitle, title, re.IGNORECASE):
 419                 return u'"' + title + '" title matched reject pattern "' + rejecttitle + '"'
 420         return None
 421
 422     def process_info(self, info_dict):
 423         """Process a single dictionary returned by an InfoExtractor."""
 424
 425         # Keep for backwards compatibility
 426         info_dict['stitle'] = info_dict['title']
 427
 428         if not 'format' in info_dict:
 429             info_dict['format'] = info_dict['ext']
 430
 431         reason = self._match_entry(info_dict)
 432         if reason is not None:
 433             self.to_screen(u'[download] ' + reason)
 434             return
 435
 436         max_downloads = self.params.get('max_downloads')
 437         if max_downloads is not None:
 438             if self._num_downloads > int(max_downloads):
 439                 raise MaxDownloadsReached()
 440
 441         filename = self.prepare_filename(info_dict)
 442
 443         # Forced printings
 444         if self.params.get('forcetitle', False):
 445             compat_print(info_dict['title'])
 446         if self.params.get('forceurl', False):
 447             compat_print(info_dict['url'])
 448         if self.params.get('forcethumbnail', False) and 'thumbnail' in info_dict:
 449             compat_print(info_dict['thumbnail'])
 450         if self.params.get('forcedescription', False) and 'description' in info_dict:
 451             compat_print(info_dict['description'])
 452         if self.params.get('forcefilename', False) and filename is not None:
 453             compat_print(filename)
 454         if self.params.get('forceformat', False):
 455             compat_print(info_dict['format'])
 456
 457         # Do nothing else if in simulate mode
 458         if self.params.get('simulate', False):
 459             return
 460
 461         if filename is None:
 462             return
 463
 464         try:
 465             dn = os.path.dirname(encodeFilename(filename))
 466             if dn != '' and not os.path.exists(dn): # dn is already encoded
 467                 os.makedirs(dn)
 468         except (OSError, IOError) as err:
 469             self.report_error(u'unable to create directory ' + compat_str(err))
 470             return
 471
 472         if self.params.get('writedescription', False):
 473             try:
 474                 descfn = filename + u'.description'
 475                 self.report_writedescription(descfn)
 476                 with io.open(encodeFilename(descfn), 'w', encoding='utf-8') as descfile:
 477                     descfile.write(info_dict['description'])
 478             except (OSError, IOError):
 479                 self.report_error(u'Cannot write description file ' + descfn)
 480                 return
 481
 482         if self.params.get('writesubtitles', False) and 'subtitles' in info_dict and info_dict['subtitles']:
 483             # subtitles download errors are already managed as troubles in relevant IE
 484             # that way it will silently go on when used with unsupporting IE
 485             subtitle = info_dict['subtitles'][0]
 486             (sub_error, sub_lang, sub) = subtitle
 487             sub_format = self.params.get('subtitlesformat')
 488             if sub_error:
 489                 self.report_warning("Some error while getting the subtitles")
 490             else:
 491                 try:
 492                     sub_filename = filename.rsplit('.', 1)[0] + u'.' + sub_lang + u'.' + sub_format
 493                     self.report_writesubtitles(sub_filename)
 494                     with io.open(encodeFilename(sub_filename), 'w', encoding='utf-8') as subfile:
 495                         subfile.write(sub)
 496                 except (OSError, IOError):
 497                     self.report_error(u'Cannot write subtitles file ' + descfn)
 498                     return
 499             if self.params.get('onlysubtitles', False):
 500                 return
 501
 502         if self.params.get('allsubtitles', False) and 'subtitles' in info_dict and info_dict['subtitles']:
 503             subtitles = info_dict['subtitles']
 504             sub_format = self.params.get('subtitlesformat')
 505             for subtitle in subtitles:
 506                 (sub_error, sub_lang, sub) = subtitle
 507                 if sub_error:
 508                     self.report_warning("Some error while getting the subtitles")
 509                 else:
 510                     try:
 511                         sub_filename = filename.rsplit('.', 1)[0] + u'.' + sub_lang + u'.' + sub_format
 512                         self.report_writesubtitles(sub_filename)
 513                         with io.open(encodeFilename(sub_filename), 'w', encoding='utf-8') as subfile:
 514                                 subfile.write(sub)
 515                     except (OSError, IOError):
 516                         self.trouble(u'ERROR: Cannot write subtitles file ' + descfn)
 517                         return
 518             if self.params.get('onlysubtitles', False):
 519                 return
 520
 521         if self.params.get('writeinfojson', False):
 522             infofn = filename + u'.info.json'
 523             self.report_writeinfojson(infofn)
 524             try:
 525                 json_info_dict = dict((k, v) for k,v in info_dict.items() if not k in ['urlhandle'])
 526                 write_json_file(json_info_dict, encodeFilename(infofn))
 527             except (OSError, IOError):
 528                 self.report_error(u'Cannot write metadata to JSON file ' + infofn)
 529                 return
 530
 531         if not self.params.get('skip_download', False):
 532             if self.params.get('nooverwrites', False) and os.path.exists(encodeFilename(filename)):
 533                 success = True
 534             else:
 535                 try:
 536                     success = self._do_download(filename, info_dict)
 537                 except (OSError, IOError) as err:
 538                     raise UnavailableVideoError()
 539                 except (compat_urllib_error.URLError, compat_http_client.HTTPException, socket.error) as err:
 540                     self.report_error(u'unable to download video data: %s' % str(err))
 541                     return
 542                 except (ContentTooShortError, ) as err:
 543                     self.report_error(u'content too short (expected %s bytes and served %s)' % (err.expected, err.downloaded))
 544                     return
 545
 546             if success:
 547                 try:
 548                     self.post_process(filename, info_dict)
 549                 except (PostProcessingError) as err:
 550                     self.report_error(u'postprocessing: %s' % str(err))
 551                     return
 552
 553     def download(self, url_list):
 554         """Download a given list of URLs."""
 555         if len(url_list) > 1 and self.fixed_template():
 556             raise SameFileError(self.params['outtmpl'])
 557
 558         for url in url_list:
 559             suitable_found = False
 560             for ie in self._ies:
 561                 # Go to next InfoExtractor if not suitable
 562                 if not ie.suitable(url):
 563                     continue
 564
 565                 # Warn if the _WORKING attribute is False
 566                 if not ie.working():
 567                     self.report_warning(u'the program functionality for this site has been marked as broken, '
 568                                         u'and will probably not work. If you want to go on, use the -i option.')
 569
 570                 # Suitable InfoExtractor found
 571                 suitable_found = True
 572
 573                 # Extract information from URL and process it
 574                 try:
 575                     videos = ie.extract(url)
 576                 except ExtractorError as de: # An error we somewhat expected
 577                     self.trouble(u'ERROR: ' + compat_str(de), de.format_traceback())
 578                     break
 579                 except MaxDownloadsReached:
 580                     self.to_screen(u'[info] Maximum number of downloaded files reached.')
 581                     raise
 582                 except Exception as e:
 583                     if self.params.get('ignoreerrors', False):
 584                         self.report_error(u'' + compat_str(e), tb=compat_str(traceback.format_exc()))
 585                         break
 586                     else:
 587                         raise
 588
 589                 if len(videos or []) > 1 and self.fixed_template():
 590                     raise SameFileError(self.params['outtmpl'])
 591
 592                 for video in videos or []:
 593                     video['extractor'] = ie.IE_NAME
 594                     try:
 595                         self.increment_downloads()
 596                         self.process_info(video)
 597                     except UnavailableVideoError:
 598                         self.to_stderr(u"\n")
 599                         self.report_error(u'unable to download video')
 600
 601                 # Suitable InfoExtractor had been found; go to next URL
 602                 break
 603
 604             if not suitable_found:
 605                 self.report_error(u'no suitable InfoExtractor: %s' % url)
 606
 607         return self._download_retcode
 608
 609     def post_process(self, filename, ie_info):
 610         """Run all the postprocessors on the given file."""
 611         info = dict(ie_info)
 612         info['filepath'] = filename
 613         keep_video = None
 614         for pp in self._pps:
 615             try:
 616                 keep_video_wish,new_info = pp.run(info)
 617                 if keep_video_wish is not None:
 618                     if keep_video_wish:
 619                         keep_video = keep_video_wish
 620                     elif keep_video is None:
 621                         # No clear decision yet, let IE decide
 622                         keep_video = keep_video_wish
 623             except PostProcessingError as e:
 624                 self.to_stderr(u'ERROR: ' + e.msg)
 625         if keep_video is False and not self.params.get('keepvideo', False):
 626             try:
 627                 self.to_screen(u'Deleting original file %s (pass -k to keep)' % filename)
 628                 os.remove(encodeFilename(filename))
 629             except (IOError, OSError):
 630                 self.report_warning(u'Unable to remove downloaded video file')
 631
 632     def _download_with_rtmpdump(self, filename, url, player_url, page_url):
 633         self.report_destination(filename)
 634         tmpfilename = self.temp_name(filename)
 635
 636         # Check for rtmpdump first
 637         try:
 638             subprocess.call(['rtmpdump', '-h'], stdout=(open(os.path.devnull, 'w')), stderr=subprocess.STDOUT)
 639         except (OSError, IOError):
 640             self.report_error(u'RTMP download detected but "rtmpdump" could not be run')
 641             return False
 642
 643         # Download using rtmpdump. rtmpdump returns exit code 2 when
 644         # the connection was interrumpted and resuming appears to be
 645         # possible. This is part of rtmpdump's normal usage, AFAIK.
 646         basic_args = ['rtmpdump', '-q', '-r', url, '-o', tmpfilename]
 647         if player_url is not None:
 648             basic_args += ['-W', player_url]
 649         if page_url is not None:
 650             basic_args += ['--pageUrl', page_url]
 651         args = basic_args + [[], ['-e', '-k', '1']][self.params.get('continuedl', False)]
 652         if self.params.get('verbose', False):
 653             try:
 654                 import pipes
 655                 shell_quote = lambda args: ' '.join(map(pipes.quote, args))
 656             except ImportError:
 657                 shell_quote = repr
 658             self.to_screen(u'[debug] rtmpdump command line: ' + shell_quote(args))
 659         retval = subprocess.call(args)
 660         while retval == 2 or retval == 1:
 661             prevsize = os.path.getsize(encodeFilename(tmpfilename))
 662             self.to_screen(u'\r[rtmpdump] %s bytes' % prevsize, skip_eol=True)
 663             time.sleep(5.0) # This seems to be needed
 664             retval = subprocess.call(basic_args + ['-e'] + [[], ['-k', '1']][retval == 1])
 665             cursize = os.path.getsize(encodeFilename(tmpfilename))
 666             if prevsize == cursize and retval == 1:
 667                 break
 668              # Some rtmp streams seem abort after ~ 99.8%. Don't complain for those
 669             if prevsize == cursize and retval == 2 and cursize > 1024:
 670                 self.to_screen(u'\r[rtmpdump] Could not download the whole video. This can happen for some advertisements.')
 671                 retval = 0
 672                 break
 673         if retval == 0:
 674             fsize = os.path.getsize(encodeFilename(tmpfilename))
 675             self.to_screen(u'\r[rtmpdump] %s bytes' % fsize)
 676             self.try_rename(tmpfilename, filename)
 677             self._hook_progress({
 678                 'downloaded_bytes': fsize,
 679                 'total_bytes': fsize,
 680                 'filename': filename,
 681                 'status': 'finished',
 682             })
 683             return True
 684         else:
 685             self.to_stderr(u"\n")
 686             self.report_error(u'rtmpdump exited with code %d' % retval)
 687             return False
 688
 689     def _do_download(self, filename, info_dict):
 690         url = info_dict['url']
 691
 692         # Check file already present
 693         if self.params.get('continuedl', False) and os.path.isfile(encodeFilename(filename)) and not self.params.get('nopart', False):
 694             self.report_file_already_downloaded(filename)
 695             self._hook_progress({
 696                 'filename': filename,
 697                 'status': 'finished',
 698             })
 699             return True
 700
 701         # Attempt to download using rtmpdump
 702         if url.startswith('rtmp'):
 703             return self._download_with_rtmpdump(filename, url,
 704                                                 info_dict.get('player_url', None),
 705                                                 info_dict.get('page_url', None))
 706
 707         tmpfilename = self.temp_name(filename)
 708         stream = None
 709
 710         # Do not include the Accept-Encoding header
 711         headers = {'Youtubedl-no-compression': 'True'}
 712         if 'user_agent' in info_dict:
 713             headers['Youtubedl-user-agent'] = info_dict['user_agent']
 714         basic_request = compat_urllib_request.Request(url, None, headers)
 715         request = compat_urllib_request.Request(url, None, headers)
 716
 717         if self.params.get('test', False):
 718             request.add_header('Range','bytes=0-10240')
 719
 720         # Establish possible resume length
 721         if os.path.isfile(encodeFilename(tmpfilename)):
 722             resume_len = os.path.getsize(encodeFilename(tmpfilename))
 723         else:
 724             resume_len = 0
 725
 726         open_mode = 'wb'
 727         if resume_len != 0:
 728             if self.params.get('continuedl', False):
 729                 self.report_resuming_byte(resume_len)
 730                 request.add_header('Range','bytes=%d-' % resume_len)
 731                 open_mode = 'ab'
 732             else:
 733                 resume_len = 0
 734
 735         count = 0
 736         retries = self.params.get('retries', 0)
 737         while count <= retries:
 738             # Establish connection
 739             try:
 740                 if count == 0 and 'urlhandle' in info_dict:
 741                     data = info_dict['urlhandle']
 742                 data = compat_urllib_request.urlopen(request)
 743                 break
 744             except (compat_urllib_error.HTTPError, ) as err:
 745                 if (err.code < 500 or err.code >= 600) and err.code != 416:
 746                     # Unexpected HTTP error
 747                     raise
 748                 elif err.code == 416:
 749                     # Unable to resume (requested range not satisfiable)
 750                     try:
 751                         # Open the connection again without the range header
 752                         data = compat_urllib_request.urlopen(basic_request)
 753                         content_length = data.info()['Content-Length']
 754                     except (compat_urllib_error.HTTPError, ) as err:
 755                         if err.code < 500 or err.code >= 600:
 756                             raise
 757                     else:
 758                         # Examine the reported length
 759                         if (content_length is not None and
 760                                 (resume_len - 100 < int(content_length) < resume_len + 100)):
 761                             # The file had already been fully downloaded.
 762                             # Explanation to the above condition: in issue #175 it was revealed that
 763                             # YouTube sometimes adds or removes a few bytes from the end of the file,
 764                             # changing the file size slightly and causing problems for some users. So
 765                             # I decided to implement a suggested change and consider the file
 766                             # completely downloaded if the file size differs less than 100 bytes from
 767                             # the one in the hard drive.
 768                             self.report_file_already_downloaded(filename)
 769                             self.try_rename(tmpfilename, filename)
 770                             self._hook_progress({
 771                                 'filename': filename,
 772                                 'status': 'finished',
 773                             })
 774                             return True
 775                         else:
 776                             # The length does not match, we start the download over
 777                             self.report_unable_to_resume()
 778                             open_mode = 'wb'
 779                             break
 780             # Retry
 781             count += 1
 782             if count <= retries:
 783                 self.report_retry(count, retries)
 784
 785         if count > retries:
 786             self.report_error(u'giving up after %s retries' % retries)
 787             return False
 788
 789         data_len = data.info().get('Content-length', None)
 790         if data_len is not None:
 791             data_len = int(data_len) + resume_len
 792             min_data_len = self.params.get("min_filesize", None)
 793             max_data_len =  self.params.get("max_filesize", None)
 794             if min_data_len is not None and data_len < min_data_len:
 795                 self.to_screen(u'\r[download] File is smaller than min-filesize (%s bytes < %s bytes). Aborting.' % (data_len, min_data_len))
 796                 return False
 797             if max_data_len is not None and data_len > max_data_len:
 798                 self.to_screen(u'\r[download] File is larger than max-filesize (%s bytes > %s bytes). Aborting.' % (data_len, max_data_len))
 799                 return False
 800
 801         data_len_str = self.format_bytes(data_len)
 802         byte_counter = 0 + resume_len
 803         block_size = self.params.get('buffersize', 1024)
 804         start = time.time()
 805         while True:
 806             # Download and write
 807             before = time.time()
 808             data_block = data.read(block_size)
 809             after = time.time()
 810             if len(data_block) == 0:
 811                 break
 812             byte_counter += len(data_block)
 813
 814             # Open file just in time
 815             if stream is None:
 816                 try:
 817                     (stream, tmpfilename) = sanitize_open(tmpfilename, open_mode)
 818                     assert stream is not None
 819                     filename = self.undo_temp_name(tmpfilename)
 820                     self.report_destination(filename)
 821                 except (OSError, IOError) as err:
 822                     self.report_error(u'unable to open for writing: %s' % str(err))
 823                     return False
 824             try:
 825                 stream.write(data_block)
 826             except (IOError, OSError) as err:
 827                 self.to_stderr(u"\n")
 828                 self.report_error(u'unable to write data: %s' % str(err))
 829                 return False
 830             if not self.params.get('noresizebuffer', False):
 831                 block_size = self.best_block_size(after - before, len(data_block))
 832
 833             # Progress message
 834             speed_str = self.calc_speed(start, time.time(), byte_counter - resume_len)
 835             if data_len is None:
 836                 self.report_progress('Unknown %', data_len_str, speed_str, 'Unknown ETA')
 837             else:
 838                 percent_str = self.calc_percent(byte_counter, data_len)
 839                 eta_str = self.calc_eta(start, time.time(), data_len - resume_len, byte_counter - resume_len)
 840                 self.report_progress(percent_str, data_len_str, speed_str, eta_str)
 841
 842             self._hook_progress({
 843                 'downloaded_bytes': byte_counter,
 844                 'total_bytes': data_len,
 845                 'tmpfilename': tmpfilename,
 846                 'filename': filename,
 847                 'status': 'downloading',
 848             })
 849
 850             # Apply rate limit
 851             self.slow_down(start, byte_counter - resume_len)
 852
 853         if stream is None:
 854             self.to_stderr(u"\n")
 855             self.report_error(u'Did not get any data blocks')
 856             return False
 857         stream.close()
 858         self.report_finish()
 859         if data_len is not None and byte_counter != data_len:
 860             raise ContentTooShortError(byte_counter, int(data_len))
 861         self.try_rename(tmpfilename, filename)
 862
 863         # Update file modification time
 864         if self.params.get('updatetime', True):
 865             info_dict['filetime'] = self.try_utime(filename, data.info().get('last-modified', None))
 866
 867         self._hook_progress({
 868             'downloaded_bytes': byte_counter,
 869             'total_bytes': byte_counter,
 870             'filename': filename,
 871             'status': 'finished',
 872         })
 873
 874         return True
 875
 876     def _hook_progress(self, status):
 877         for ph in self._progress_hooks:
 878             ph(status)
 879
 880     def add_progress_hook(self, ph):
 881         """ ph gets called on download progress, with a dictionary with the entries
 882         * filename: The final filename
 883         * status: One of "downloading" and "finished"
 884
 885         It can also have some of the following entries:
 886
 887         * downloaded_bytes: Bytes on disks
 888         * total_bytes: Total bytes, None if unknown
 889         * tmpfilename: The filename we're currently writing to
 890
 891         Hooks are guaranteed to be called at least once (with status "finished")
 892         if the download is successful.
 893         """
 894         self._progress_hooks.append(ph)