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