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