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