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