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