Merge pull request #1181 from h3xx/master
[youtube-dl] / youtube_dl / FileDownloader.py
1 import math
2 import os
3 import re
4 import subprocess
5 import sys
6 import time
7 import traceback
8
9 if os.name == 'nt':
10     import ctypes
11
12 from .utils import *
13
14
15 class FileDownloader(object):
16     """File Downloader class.
17
18     File downloader objects are the ones responsible of downloading the
19     actual video file and writing it to disk.
20
21     File downloaders accept a lot of parameters. In order not to saturate
22     the object constructor with arguments, it receives a dictionary of
23     options instead.
24
25     Available options:
26
27     verbose:           Print additional info to stdout.
28     quiet:             Do not print messages to stdout.
29     ratelimit:         Download speed limit, in bytes/sec.
30     retries:           Number of times to retry for HTTP error 5xx
31     buffersize:        Size of download buffer in bytes.
32     noresizebuffer:    Do not automatically resize the download buffer.
33     continuedl:        Try to continue downloads if possible.
34     noprogress:        Do not print the progress bar.
35     logtostderr:       Log messages to stderr instead of stdout.
36     consoletitle:      Display progress in console window's titlebar.
37     nopart:            Do not use temporary .part files.
38     updatetime:        Use the Last-modified header to set output file timestamps.
39     test:              Download only first bytes to test the downloader.
40     min_filesize:      Skip files smaller than this size
41     max_filesize:      Skip files larger than this size
42     """
43
44     params = None
45
46     def __init__(self, ydl, params):
47         """Create a FileDownloader object with the given options."""
48         self.ydl = ydl
49         self._progress_hooks = []
50         self.params = params
51
52     @staticmethod
53     def format_bytes(bytes):
54         if bytes is None:
55             return 'N/A'
56         if type(bytes) is str:
57             bytes = float(bytes)
58         if bytes == 0.0:
59             exponent = 0
60         else:
61             exponent = int(math.log(bytes, 1024.0))
62         suffix = ['B','KiB','MiB','GiB','TiB','PiB','EiB','ZiB','YiB'][exponent]
63         converted = float(bytes) / float(1024 ** exponent)
64         return '%.2f%s' % (converted, suffix)
65
66     @staticmethod
67     def calc_percent(byte_counter, data_len):
68         if data_len is None:
69             return '---.-%'
70         return '%6s' % ('%3.1f%%' % (float(byte_counter) / float(data_len) * 100.0))
71
72     @staticmethod
73     def calc_eta(start, now, total, current):
74         if total is None:
75             return '--:--'
76         dif = now - start
77         if current == 0 or dif < 0.001: # One millisecond
78             return '--:--'
79         rate = float(current) / dif
80         eta = int((float(total) - float(current)) / rate)
81         (eta_mins, eta_secs) = divmod(eta, 60)
82         (eta_hours, eta_mins) = divmod(eta_mins, 60)
83         if eta_hours > 99:
84             return '--:--:--'
85         if eta_hours == 0:
86             return '%02d:%02d' % (eta_mins, eta_secs)
87         else:
88             return '%02d:%02d:%02d' % (eta_hours, eta_mins, eta_secs)
89
90     @staticmethod
91     def calc_speed(start, now, bytes):
92         dif = now - start
93         if bytes == 0 or dif < 0.001: # One millisecond
94             return '%10s' % '---b/s'
95         return '%10s' % ('%s/s' % FileDownloader.format_bytes(float(bytes) / dif))
96
97     @staticmethod
98     def best_block_size(elapsed_time, bytes):
99         new_min = max(bytes / 2.0, 1.0)
100         new_max = min(max(bytes * 2.0, 1.0), 4194304) # Do not surpass 4 MB
101         if elapsed_time < 0.001:
102             return int(new_max)
103         rate = bytes / elapsed_time
104         if rate > new_max:
105             return int(new_max)
106         if rate < new_min:
107             return int(new_min)
108         return int(rate)
109
110     @staticmethod
111     def parse_bytes(bytestr):
112         """Parse a string indicating a byte quantity into an integer."""
113         matchobj = re.match(r'(?i)^(\d+(?:\.\d+)?)([kMGTPEZY]?)$', bytestr)
114         if matchobj is None:
115             return None
116         number = float(matchobj.group(1))
117         multiplier = 1024.0 ** 'bkmgtpezy'.index(matchobj.group(2).lower())
118         return int(round(number * multiplier))
119
120     def to_screen(self, *args, **kargs):
121         self.ydl.to_screen(*args, **kargs)
122
123     def to_stderr(self, message):
124         self.ydl.to_screen(message)
125
126     def to_cons_title(self, message):
127         """Set console/terminal window title to message."""
128         if not self.params.get('consoletitle', False):
129             return
130         if os.name == 'nt' and ctypes.windll.kernel32.GetConsoleWindow():
131             # c_wchar_p() might not be necessary if `message` is
132             # already of type unicode()
133             ctypes.windll.kernel32.SetConsoleTitleW(ctypes.c_wchar_p(message))
134         elif 'TERM' in os.environ:
135             self.to_screen('\033]0;%s\007' % message, skip_eol=True)
136
137     def trouble(self, *args, **kargs):
138         self.ydl.trouble(*args, **kargs)
139
140     def report_warning(self, *args, **kargs):
141         self.ydl.report_warning(*args, **kargs)
142
143     def report_error(self, *args, **kargs):
144         self.ydl.report_error(*args, **kargs)
145
146     def slow_down(self, start_time, byte_counter):
147         """Sleep if the download speed is over the rate limit."""
148         rate_limit = self.params.get('ratelimit', None)
149         if rate_limit is None or byte_counter == 0:
150             return
151         now = time.time()
152         elapsed = now - start_time
153         if elapsed <= 0.0:
154             return
155         speed = float(byte_counter) / elapsed
156         if speed > rate_limit:
157             time.sleep((byte_counter - rate_limit * (now - start_time)) / rate_limit)
158
159     def temp_name(self, filename):
160         """Returns a temporary filename for the given filename."""
161         if self.params.get('nopart', False) or filename == u'-' or \
162                 (os.path.exists(encodeFilename(filename)) and not os.path.isfile(encodeFilename(filename))):
163             return filename
164         return filename + u'.part'
165
166     def undo_temp_name(self, filename):
167         if filename.endswith(u'.part'):
168             return filename[:-len(u'.part')]
169         return filename
170
171     def try_rename(self, old_filename, new_filename):
172         try:
173             if old_filename == new_filename:
174                 return
175             os.rename(encodeFilename(old_filename), encodeFilename(new_filename))
176         except (IOError, OSError) as err:
177             self.report_error(u'unable to rename file')
178
179     def try_utime(self, filename, last_modified_hdr):
180         """Try to set the last-modified time of the given file."""
181         if last_modified_hdr is None:
182             return
183         if not os.path.isfile(encodeFilename(filename)):
184             return
185         timestr = last_modified_hdr
186         if timestr is None:
187             return
188         filetime = timeconvert(timestr)
189         if filetime is None:
190             return filetime
191         # Ignore obviously invalid dates
192         if filetime == 0:
193             return
194         try:
195             os.utime(filename, (time.time(), filetime))
196         except:
197             pass
198         return filetime
199
200     def report_destination(self, filename):
201         """Report destination filename."""
202         self.to_screen(u'[download] Destination: ' + filename)
203
204     def report_progress(self, percent_str, data_len_str, speed_str, eta_str):
205         """Report download progress."""
206         if self.params.get('noprogress', False):
207             return
208         clear_line = (u'\x1b[K' if sys.stderr.isatty() and os.name != 'nt' else u'')
209         if self.params.get('progress_with_newline', False):
210             self.to_screen(u'[download] %s of %s at %s ETA %s' %
211                 (percent_str, data_len_str, speed_str, eta_str))
212         else:
213             self.to_screen(u'\r%s[download] %s of %s at %s ETA %s' %
214                 (clear_line, percent_str, data_len_str, speed_str, eta_str), skip_eol=True)
215         self.to_cons_title(u'youtube-dl - %s of %s at %s ETA %s' %
216                 (percent_str.strip(), data_len_str.strip(), speed_str.strip(), eta_str.strip()))
217
218     def report_resuming_byte(self, resume_len):
219         """Report attempt to resume at given byte."""
220         self.to_screen(u'[download] Resuming download at byte %s' % resume_len)
221
222     def report_retry(self, count, retries):
223         """Report retry in case of HTTP error 5xx"""
224         self.to_screen(u'[download] Got server HTTP error. Retrying (attempt %d of %d)...' % (count, retries))
225
226     def report_file_already_downloaded(self, file_name):
227         """Report file has already been fully downloaded."""
228         try:
229             self.to_screen(u'[download] %s has already been downloaded' % file_name)
230         except (UnicodeEncodeError) as err:
231             self.to_screen(u'[download] The file has already been downloaded')
232
233     def report_unable_to_resume(self):
234         """Report it was impossible to resume download."""
235         self.to_screen(u'[download] Unable to resume')
236
237     def report_finish(self, data_len_str, tot_time):
238         """Report download finished."""
239         if self.params.get('noprogress', False):
240             self.to_screen(u'[download] Download completed')
241         else:
242             clear_line = (u'\x1b[K' if sys.stderr.isatty() and os.name != 'nt' else u'')
243             self.to_screen(u'\r%s[download] 100%% of %s in %ss' %
244                 (clear_line, data_len_str, int(tot_time)))
245
246     def _download_with_rtmpdump(self, filename, url, player_url, page_url, play_path, tc_url):
247         self.report_destination(filename)
248         tmpfilename = self.temp_name(filename)
249
250         # Check for rtmpdump first
251         try:
252             subprocess.call(['rtmpdump', '-h'], stdout=(open(os.path.devnull, 'w')), stderr=subprocess.STDOUT)
253         except (OSError, IOError):
254             self.report_error(u'RTMP download detected but "rtmpdump" could not be run')
255             return False
256         verbosity_option = '--verbose' if self.params.get('verbose', False) else '--quiet'
257
258         # Download using rtmpdump. rtmpdump returns exit code 2 when
259         # the connection was interrumpted and resuming appears to be
260         # possible. This is part of rtmpdump's normal usage, AFAIK.
261         basic_args = ['rtmpdump', verbosity_option, '-r', url, '-o', tmpfilename]
262         if player_url is not None:
263             basic_args += ['--swfVfy', player_url]
264         if page_url is not None:
265             basic_args += ['--pageUrl', page_url]
266         if play_path is not None:
267             basic_args += ['--playpath', play_path]
268         if tc_url is not None:
269             basic_args += ['--tcUrl', url]
270         args = basic_args + [[], ['--resume', '--skip', '1']][self.params.get('continuedl', False)]
271         if self.params.get('verbose', False):
272             try:
273                 import pipes
274                 shell_quote = lambda args: ' '.join(map(pipes.quote, args))
275             except ImportError:
276                 shell_quote = repr
277             self.to_screen(u'[debug] rtmpdump command line: ' + shell_quote(args))
278         retval = subprocess.call(args)
279         while retval == 2 or retval == 1:
280             prevsize = os.path.getsize(encodeFilename(tmpfilename))
281             self.to_screen(u'\r[rtmpdump] %s bytes' % prevsize, skip_eol=True)
282             time.sleep(5.0) # This seems to be needed
283             retval = subprocess.call(basic_args + ['-e'] + [[], ['-k', '1']][retval == 1])
284             cursize = os.path.getsize(encodeFilename(tmpfilename))
285             if prevsize == cursize and retval == 1:
286                 break
287              # Some rtmp streams seem abort after ~ 99.8%. Don't complain for those
288             if prevsize == cursize and retval == 2 and cursize > 1024:
289                 self.to_screen(u'\r[rtmpdump] Could not download the whole video. This can happen for some advertisements.')
290                 retval = 0
291                 break
292         if retval == 0:
293             fsize = os.path.getsize(encodeFilename(tmpfilename))
294             self.to_screen(u'\r[rtmpdump] %s bytes' % fsize)
295             self.try_rename(tmpfilename, filename)
296             self._hook_progress({
297                 'downloaded_bytes': fsize,
298                 'total_bytes': fsize,
299                 'filename': filename,
300                 'status': 'finished',
301             })
302             return True
303         else:
304             self.to_stderr(u"\n")
305             self.report_error(u'rtmpdump exited with code %d' % retval)
306             return False
307
308     def _download_with_mplayer(self, filename, url):
309         self.report_destination(filename)
310         tmpfilename = self.temp_name(filename)
311
312         args = ['mplayer', '-really-quiet', '-vo', 'null', '-vc', 'dummy', '-dumpstream', '-dumpfile', tmpfilename, url]
313         # Check for mplayer first
314         try:
315             subprocess.call(['mplayer', '-h'], stdout=(open(os.path.devnull, 'w')), stderr=subprocess.STDOUT)
316         except (OSError, IOError):
317             self.report_error(u'MMS or RTSP download detected but "%s" could not be run' % args[0] )
318             return False
319
320         # Download using mplayer. 
321         retval = subprocess.call(args)
322         if retval == 0:
323             fsize = os.path.getsize(encodeFilename(tmpfilename))
324             self.to_screen(u'\r[%s] %s bytes' % (args[0], fsize))
325             self.try_rename(tmpfilename, filename)
326             self._hook_progress({
327                 'downloaded_bytes': fsize,
328                 'total_bytes': fsize,
329                 'filename': filename,
330                 'status': 'finished',
331             })
332             return True
333         else:
334             self.to_stderr(u"\n")
335             self.report_error(u'mplayer exited with code %d' % retval)
336             return False
337
338     def _download_m3u8_with_ffmpeg(self, filename, url):
339         self.report_destination(filename)
340         tmpfilename = self.temp_name(filename)
341
342         args = ['ffmpeg', '-y', '-i', url, '-f', 'mp4', tmpfilename]
343         # Check for ffmpeg first
344         try:
345             subprocess.call(['ffmpeg', '-h'], stdout=(open(os.path.devnull, 'w')), stderr=subprocess.STDOUT)
346         except (OSError, IOError):
347             self.report_error(u'm3u8 download detected but "%s" could not be run' % args[0] )
348             return False
349
350         retval = subprocess.call(args)
351         if retval == 0:
352             fsize = os.path.getsize(encodeFilename(tmpfilename))
353             self.to_screen(u'\r[%s] %s bytes' % (args[0], fsize))
354             self.try_rename(tmpfilename, filename)
355             self._hook_progress({
356                 'downloaded_bytes': fsize,
357                 'total_bytes': fsize,
358                 'filename': filename,
359                 'status': 'finished',
360             })
361             return True
362         else:
363             self.to_stderr(u"\n")
364             self.report_error(u'ffmpeg exited with code %d' % retval)
365             return False
366
367
368     def _do_download(self, filename, info_dict):
369         url = info_dict['url']
370
371         # Check file already present
372         if self.params.get('continuedl', False) and os.path.isfile(encodeFilename(filename)) and not self.params.get('nopart', False):
373             self.report_file_already_downloaded(filename)
374             self._hook_progress({
375                 'filename': filename,
376                 'status': 'finished',
377             })
378             return True
379
380         # Attempt to download using rtmpdump
381         if url.startswith('rtmp'):
382             return self._download_with_rtmpdump(filename, url,
383                                                 info_dict.get('player_url', None),
384                                                 info_dict.get('page_url', None),
385                                                 info_dict.get('play_path', None),
386                                                 info_dict.get('tc_url', None))
387
388         # Attempt to download using mplayer
389         if url.startswith('mms') or url.startswith('rtsp'):
390             return self._download_with_mplayer(filename, url)
391
392         # m3u8 manifest are downloaded with ffmpeg
393         if determine_ext(url) == u'm3u8':
394             return self._download_m3u8_with_ffmpeg(filename, url)
395
396         tmpfilename = self.temp_name(filename)
397         stream = None
398
399         # Do not include the Accept-Encoding header
400         headers = {'Youtubedl-no-compression': 'True'}
401         if 'user_agent' in info_dict:
402             headers['Youtubedl-user-agent'] = info_dict['user_agent']
403         basic_request = compat_urllib_request.Request(url, None, headers)
404         request = compat_urllib_request.Request(url, None, headers)
405
406         if self.params.get('test', False):
407             request.add_header('Range','bytes=0-10240')
408
409         # Establish possible resume length
410         if os.path.isfile(encodeFilename(tmpfilename)):
411             resume_len = os.path.getsize(encodeFilename(tmpfilename))
412         else:
413             resume_len = 0
414
415         open_mode = 'wb'
416         if resume_len != 0:
417             if self.params.get('continuedl', False):
418                 self.report_resuming_byte(resume_len)
419                 request.add_header('Range','bytes=%d-' % resume_len)
420                 open_mode = 'ab'
421             else:
422                 resume_len = 0
423
424         count = 0
425         retries = self.params.get('retries', 0)
426         while count <= retries:
427             # Establish connection
428             try:
429                 if count == 0 and 'urlhandle' in info_dict:
430                     data = info_dict['urlhandle']
431                 data = compat_urllib_request.urlopen(request)
432                 break
433             except (compat_urllib_error.HTTPError, ) as err:
434                 if (err.code < 500 or err.code >= 600) and err.code != 416:
435                     # Unexpected HTTP error
436                     raise
437                 elif err.code == 416:
438                     # Unable to resume (requested range not satisfiable)
439                     try:
440                         # Open the connection again without the range header
441                         data = compat_urllib_request.urlopen(basic_request)
442                         content_length = data.info()['Content-Length']
443                     except (compat_urllib_error.HTTPError, ) as err:
444                         if err.code < 500 or err.code >= 600:
445                             raise
446                     else:
447                         # Examine the reported length
448                         if (content_length is not None and
449                                 (resume_len - 100 < int(content_length) < resume_len + 100)):
450                             # The file had already been fully downloaded.
451                             # Explanation to the above condition: in issue #175 it was revealed that
452                             # YouTube sometimes adds or removes a few bytes from the end of the file,
453                             # changing the file size slightly and causing problems for some users. So
454                             # I decided to implement a suggested change and consider the file
455                             # completely downloaded if the file size differs less than 100 bytes from
456                             # the one in the hard drive.
457                             self.report_file_already_downloaded(filename)
458                             self.try_rename(tmpfilename, filename)
459                             self._hook_progress({
460                                 'filename': filename,
461                                 'status': 'finished',
462                             })
463                             return True
464                         else:
465                             # The length does not match, we start the download over
466                             self.report_unable_to_resume()
467                             open_mode = 'wb'
468                             break
469             # Retry
470             count += 1
471             if count <= retries:
472                 self.report_retry(count, retries)
473
474         if count > retries:
475             self.report_error(u'giving up after %s retries' % retries)
476             return False
477
478         data_len = data.info().get('Content-length', None)
479         if data_len is not None:
480             data_len = int(data_len) + resume_len
481             min_data_len = self.params.get("min_filesize", None)
482             max_data_len =  self.params.get("max_filesize", None)
483             if min_data_len is not None and data_len < min_data_len:
484                 self.to_screen(u'\r[download] File is smaller than min-filesize (%s bytes < %s bytes). Aborting.' % (data_len, min_data_len))
485                 return False
486             if max_data_len is not None and data_len > max_data_len:
487                 self.to_screen(u'\r[download] File is larger than max-filesize (%s bytes > %s bytes). Aborting.' % (data_len, max_data_len))
488                 return False
489
490         data_len_str = self.format_bytes(data_len)
491         byte_counter = 0 + resume_len
492         block_size = self.params.get('buffersize', 1024)
493         start = time.time()
494         while True:
495             # Download and write
496             before = time.time()
497             data_block = data.read(block_size)
498             after = time.time()
499             if len(data_block) == 0:
500                 break
501             byte_counter += len(data_block)
502
503             # Open file just in time
504             if stream is None:
505                 try:
506                     (stream, tmpfilename) = sanitize_open(tmpfilename, open_mode)
507                     assert stream is not None
508                     filename = self.undo_temp_name(tmpfilename)
509                     self.report_destination(filename)
510                 except (OSError, IOError) as err:
511                     self.report_error(u'unable to open for writing: %s' % str(err))
512                     return False
513             try:
514                 stream.write(data_block)
515             except (IOError, OSError) as err:
516                 self.to_stderr(u"\n")
517                 self.report_error(u'unable to write data: %s' % str(err))
518                 return False
519             if not self.params.get('noresizebuffer', False):
520                 block_size = self.best_block_size(after - before, len(data_block))
521
522             # Progress message
523             speed_str = self.calc_speed(start, time.time(), byte_counter - resume_len)
524             if data_len is None:
525                 self.report_progress('Unknown %', data_len_str, speed_str, 'Unknown ETA')
526             else:
527                 percent_str = self.calc_percent(byte_counter, data_len)
528                 eta_str = self.calc_eta(start, time.time(), data_len - resume_len, byte_counter - resume_len)
529                 self.report_progress(percent_str, data_len_str, speed_str, eta_str)
530
531             self._hook_progress({
532                 'downloaded_bytes': byte_counter,
533                 'total_bytes': data_len,
534                 'tmpfilename': tmpfilename,
535                 'filename': filename,
536                 'status': 'downloading',
537             })
538
539             # Apply rate limit
540             self.slow_down(start, byte_counter - resume_len)
541
542         if stream is None:
543             self.to_stderr(u"\n")
544             self.report_error(u'Did not get any data blocks')
545             return False
546         stream.close()
547         self.report_finish(data_len_str, (time.time() - start))
548         if data_len is not None and byte_counter != data_len:
549             raise ContentTooShortError(byte_counter, int(data_len))
550         self.try_rename(tmpfilename, filename)
551
552         # Update file modification time
553         if self.params.get('updatetime', True):
554             info_dict['filetime'] = self.try_utime(filename, data.info().get('last-modified', None))
555
556         self._hook_progress({
557             'downloaded_bytes': byte_counter,
558             'total_bytes': byte_counter,
559             'filename': filename,
560             'status': 'finished',
561         })
562
563         return True
564
565     def _hook_progress(self, status):
566         for ph in self._progress_hooks:
567             ph(status)
568
569     def add_progress_hook(self, ph):
570         """ ph gets called on download progress, with a dictionary with the entries
571         * filename: The final filename
572         * status: One of "downloading" and "finished"
573
574         It can also have some of the following entries:
575
576         * downloaded_bytes: Bytes on disks
577         * total_bytes: Total bytes, None if unknown
578         * tmpfilename: The filename we're currently writing to
579
580         Hooks are guaranteed to be called at least once (with status "finished")
581         if the download is successful.
582         """
583         self._progress_hooks.append(ph)