2 # -*- coding: utf-8 -*-
4 from __future__ import absolute_import
22 class FileDownloader(object):
23 """File Downloader class.
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.
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.
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".
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 .srt file
82 subtitleslang: Language of the subtitles to download
83 test: Download only first bytes to test the downloader.
84 keepvideo: Keep the video file after post-processing
85 min_filesize: Skip files smaller than this size
86 max_filesize: Skip files larger than this size
92 _download_retcode = None
96 def __init__(self, params):
97 """Create a FileDownloader object with the given options."""
100 self._progress_hooks = []
101 self._download_retcode = 0
102 self._num_downloads = 0
103 self._screen_file = [sys.stdout, sys.stderr][params.get('logtostderr', False)]
106 if '%(stitle)s' in self.params['outtmpl']:
107 self.to_stderr(u'WARNING: %(stitle)s is deprecated. Use the %(title)s and the --restrict-filenames flag(which also secures %(uploader)s et al) instead.')
110 def format_bytes(bytes):
113 if type(bytes) is str:
118 exponent = int(math.log(bytes, 1024.0))
119 suffix = 'bkMGTPEZY'[exponent]
120 converted = float(bytes) / float(1024 ** exponent)
121 return '%.2f%s' % (converted, suffix)
124 def calc_percent(byte_counter, data_len):
127 return '%6s' % ('%3.1f%%' % (float(byte_counter) / float(data_len) * 100.0))
130 def calc_eta(start, now, total, current):
134 if current == 0 or dif < 0.001: # One millisecond
136 rate = float(current) / dif
137 eta = int((float(total) - float(current)) / rate)
138 (eta_mins, eta_secs) = divmod(eta, 60)
141 return '%02d:%02d' % (eta_mins, eta_secs)
144 def calc_speed(start, now, bytes):
146 if bytes == 0 or dif < 0.001: # One millisecond
147 return '%10s' % '---b/s'
148 return '%10s' % ('%s/s' % FileDownloader.format_bytes(float(bytes) / dif))
151 def best_block_size(elapsed_time, bytes):
152 new_min = max(bytes / 2.0, 1.0)
153 new_max = min(max(bytes * 2.0, 1.0), 4194304) # Do not surpass 4 MB
154 if elapsed_time < 0.001:
156 rate = bytes / elapsed_time
164 def parse_bytes(bytestr):
165 """Parse a string indicating a byte quantity into an integer."""
166 matchobj = re.match(r'(?i)^(\d+(?:\.\d+)?)([kMGTPEZY]?)$', bytestr)
169 number = float(matchobj.group(1))
170 multiplier = 1024.0 ** 'bkmgtpezy'.index(matchobj.group(2).lower())
171 return int(round(number * multiplier))
173 def add_info_extractor(self, ie):
174 """Add an InfoExtractor object to the end of the list."""
176 ie.set_downloader(self)
178 def add_post_processor(self, pp):
179 """Add a PostProcessor object to the end of the chain."""
181 pp.set_downloader(self)
183 def to_screen(self, message, skip_eol=False):
184 """Print message to stdout if not in quiet mode."""
185 assert type(message) == type(u'')
186 if not self.params.get('quiet', False):
187 terminator = [u'\n', u''][skip_eol]
188 output = message + terminator
189 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
190 output = output.encode(preferredencoding(), 'ignore')
191 self._screen_file.write(output)
192 self._screen_file.flush()
194 def to_stderr(self, message):
195 """Print message to stderr."""
196 assert type(message) == type(u'')
197 output = message + u'\n'
198 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
199 output = output.encode(preferredencoding())
200 sys.stderr.write(output)
202 def to_cons_title(self, message):
203 """Set console/terminal window title to message."""
204 if not self.params.get('consoletitle', False):
206 if os.name == 'nt' and ctypes.windll.kernel32.GetConsoleWindow():
207 # c_wchar_p() might not be necessary if `message` is
208 # already of type unicode()
209 ctypes.windll.kernel32.SetConsoleTitleW(ctypes.c_wchar_p(message))
210 elif 'TERM' in os.environ:
211 self.to_screen('\033]0;%s\007' % message, skip_eol=True)
213 def fixed_template(self):
214 """Checks if the output template is fixed."""
215 return (re.search(u'(?u)%\\(.+?\\)s', self.params['outtmpl']) is None)
217 def trouble(self, message=None, tb=None):
218 """Determine action to take when a download problem appears.
220 Depending on if the downloader has been configured to ignore
221 download errors or not, this method may throw an exception or
222 not when errors are found, after printing the message.
224 tb, if given, is additional traceback information.
226 if message is not None:
227 self.to_stderr(message)
228 if self.params.get('verbose'):
230 tb_data = traceback.format_list(traceback.extract_stack())
231 tb = u''.join(tb_data)
233 if not self.params.get('ignoreerrors', False):
234 raise DownloadError(message)
235 self._download_retcode = 1
237 def slow_down(self, start_time, byte_counter):
238 """Sleep if the download speed is over the rate limit."""
239 rate_limit = self.params.get('ratelimit', None)
240 if rate_limit is None or byte_counter == 0:
243 elapsed = now - start_time
246 speed = float(byte_counter) / elapsed
247 if speed > rate_limit:
248 time.sleep((byte_counter - rate_limit * (now - start_time)) / rate_limit)
250 def temp_name(self, filename):
251 """Returns a temporary filename for the given filename."""
252 if self.params.get('nopart', False) or filename == u'-' or \
253 (os.path.exists(encodeFilename(filename)) and not os.path.isfile(encodeFilename(filename))):
255 return filename + u'.part'
257 def undo_temp_name(self, filename):
258 if filename.endswith(u'.part'):
259 return filename[:-len(u'.part')]
262 def try_rename(self, old_filename, new_filename):
264 if old_filename == new_filename:
266 os.rename(encodeFilename(old_filename), encodeFilename(new_filename))
267 except (IOError, OSError) as err:
268 self.trouble(u'ERROR: unable to rename file')
270 def try_utime(self, filename, last_modified_hdr):
271 """Try to set the last-modified time of the given file."""
272 if last_modified_hdr is None:
274 if not os.path.isfile(encodeFilename(filename)):
276 timestr = last_modified_hdr
279 filetime = timeconvert(timestr)
283 os.utime(filename, (time.time(), filetime))
288 def report_writedescription(self, descfn):
289 """ Report that the description file is being written """
290 self.to_screen(u'[info] Writing video description to: ' + descfn)
292 def report_writesubtitles(self, srtfn):
293 """ Report that the subtitles file is being written """
294 self.to_screen(u'[info] Writing video subtitles to: ' + srtfn)
296 def report_writeinfojson(self, infofn):
297 """ Report that the metadata file has been written """
298 self.to_screen(u'[info] Video description metadata as JSON to: ' + infofn)
300 def report_destination(self, filename):
301 """Report destination filename."""
302 self.to_screen(u'[download] Destination: ' + filename)
304 def report_progress(self, percent_str, data_len_str, speed_str, eta_str):
305 """Report download progress."""
306 if self.params.get('noprogress', False):
308 if self.params.get('newline', True):
309 self.to_screen(u'\r[download] %s of %s at %s ETA %s' %
310 (percent_str, data_len_str, speed_str, eta_str))
311 else: self.to_screen(u'\r[download] %s of %s at %s ETA %s' %
312 (percent_str, data_len_str, speed_str, eta_str), skip_eol=True)
313 self.to_cons_title(u'youtube-dl - %s of %s at %s ETA %s' %
314 (percent_str.strip(), data_len_str.strip(), speed_str.strip(), eta_str.strip()))
316 def report_resuming_byte(self, resume_len):
317 """Report attempt to resume at given byte."""
318 self.to_screen(u'[download] Resuming download at byte %s' % resume_len)
320 def report_retry(self, count, retries):
321 """Report retry in case of HTTP error 5xx"""
322 self.to_screen(u'[download] Got server HTTP error. Retrying (attempt %d of %d)...' % (count, retries))
324 def report_file_already_downloaded(self, file_name):
325 """Report file has already been fully downloaded."""
327 self.to_screen(u'[download] %s has already been downloaded' % file_name)
328 except (UnicodeEncodeError) as err:
329 self.to_screen(u'[download] The file has already been downloaded')
331 def report_unable_to_resume(self):
332 """Report it was impossible to resume download."""
333 self.to_screen(u'[download] Unable to resume')
335 def report_finish(self):
336 """Report download finished."""
337 if self.params.get('noprogress', False):
338 self.to_screen(u'[download] Download completed')
342 def increment_downloads(self):
343 """Increment the ordinal that assigns a number to each file."""
344 self._num_downloads += 1
346 def prepare_filename(self, info_dict):
347 """Generate the output filename."""
349 template_dict = dict(info_dict)
351 template_dict['epoch'] = int(time.time())
352 template_dict['autonumber'] = u'%05d' % self._num_downloads
354 sanitize = lambda k,v: sanitize_filename(
355 u'NA' if v is None else compat_str(v),
356 restricted=self.params.get('restrictfilenames'),
358 template_dict = dict((k, sanitize(k, v)) for k,v in template_dict.items())
360 filename = self.params['outtmpl'] % template_dict
362 except (ValueError, KeyError) as err:
363 self.trouble(u'ERROR: invalid system charset or erroneous output template')
366 def _match_entry(self, info_dict):
367 """ Returns None iff the file should be downloaded """
369 title = info_dict['title']
370 matchtitle = self.params.get('matchtitle', False)
372 matchtitle = matchtitle.decode('utf8')
373 if not re.search(matchtitle, title, re.IGNORECASE):
374 return u'[download] "' + title + '" title did not match pattern "' + matchtitle + '"'
375 rejecttitle = self.params.get('rejecttitle', False)
377 rejecttitle = rejecttitle.decode('utf8')
378 if re.search(rejecttitle, title, re.IGNORECASE):
379 return u'"' + title + '" title matched reject pattern "' + rejecttitle + '"'
382 def process_info(self, info_dict):
383 """Process a single dictionary returned by an InfoExtractor."""
385 # Keep for backwards compatibility
386 info_dict['stitle'] = info_dict['title']
388 if not 'format' in info_dict:
389 info_dict['format'] = info_dict['ext']
391 reason = self._match_entry(info_dict)
392 if reason is not None:
393 self.to_screen(u'[download] ' + reason)
396 max_downloads = self.params.get('max_downloads')
397 if max_downloads is not None:
398 if self._num_downloads > int(max_downloads):
399 raise MaxDownloadsReached()
401 filename = self.prepare_filename(info_dict)
404 if self.params.get('forcetitle', False):
405 compat_print(info_dict['title'])
406 if self.params.get('forceurl', False):
407 compat_print(info_dict['url'])
408 if self.params.get('forcethumbnail', False) and 'thumbnail' in info_dict:
409 compat_print(info_dict['thumbnail'])
410 if self.params.get('forcedescription', False) and 'description' in info_dict:
411 compat_print(info_dict['description'])
412 if self.params.get('forcefilename', False) and filename is not None:
413 compat_print(filename)
414 if self.params.get('forceformat', False):
415 compat_print(info_dict['format'])
417 # Do nothing else if in simulate mode
418 if self.params.get('simulate', False):
425 dn = os.path.dirname(encodeFilename(filename))
426 if dn != '' and not os.path.exists(dn): # dn is already encoded
428 except (OSError, IOError) as err:
429 self.trouble(u'ERROR: unable to create directory ' + compat_str(err))
432 if self.params.get('writedescription', False):
434 descfn = filename + u'.description'
435 self.report_writedescription(descfn)
436 with io.open(encodeFilename(descfn), 'w', encoding='utf-8') as descfile:
437 descfile.write(info_dict['description'])
438 except (OSError, IOError):
439 self.trouble(u'ERROR: Cannot write description file ' + descfn)
442 if self.params.get('writesubtitles', False) and 'subtitles' in info_dict and info_dict['subtitles']:
443 # subtitles download errors are already managed as troubles in relevant IE
444 # that way it will silently go on when used with unsupporting IE
446 srtfn = filename.rsplit('.', 1)[0] + u'.srt'
447 self.report_writesubtitles(srtfn)
448 with io.open(encodeFilename(srtfn), 'w', encoding='utf-8') as srtfile:
449 srtfile.write(info_dict['subtitles'])
450 except (OSError, IOError):
451 self.trouble(u'ERROR: Cannot write subtitles file ' + descfn)
454 if self.params.get('writeinfojson', False):
455 infofn = filename + u'.info.json'
456 self.report_writeinfojson(infofn)
458 json_info_dict = dict((k, v) for k,v in info_dict.items() if not k in ['urlhandle'])
459 write_json_file(json_info_dict, encodeFilename(infofn))
460 except (OSError, IOError):
461 self.trouble(u'ERROR: Cannot write metadata to JSON file ' + infofn)
464 if not self.params.get('skip_download', False):
465 if self.params.get('nooverwrites', False) and os.path.exists(encodeFilename(filename)):
469 success = self._do_download(filename, info_dict)
470 except (OSError, IOError) as err:
471 raise UnavailableVideoError()
472 except (compat_urllib_error.URLError, compat_http_client.HTTPException, socket.error) as err:
473 self.trouble(u'ERROR: unable to download video data: %s' % str(err))
475 except (ContentTooShortError, ) as err:
476 self.trouble(u'ERROR: content too short (expected %s bytes and served %s)' % (err.expected, err.downloaded))
481 self.post_process(filename, info_dict)
482 except (PostProcessingError) as err:
483 self.trouble(u'ERROR: postprocessing: %s' % str(err))
486 def download(self, url_list):
487 """Download a given list of URLs."""
488 if len(url_list) > 1 and self.fixed_template():
489 raise SameFileError(self.params['outtmpl'])
492 suitable_found = False
494 # Go to next InfoExtractor if not suitable
495 if not ie.suitable(url):
498 # Warn if the _WORKING attribute is False
500 self.to_stderr(u'WARNING: the program functionality for this site has been marked as broken, '
501 u'and will probably not work. If you want to go on, use the -i option.')
503 # Suitable InfoExtractor found
504 suitable_found = True
506 # Extract information from URL and process it
508 videos = ie.extract(url)
509 except ExtractorError as de: # An error we somewhat expected
510 self.trouble(u'ERROR: ' + compat_str(de), de.format_traceback())
512 except Exception as e:
513 if self.params.get('ignoreerrors', False):
514 self.trouble(u'ERROR: ' + compat_str(e), tb=compat_str(traceback.format_exc()))
519 if len(videos or []) > 1 and self.fixed_template():
520 raise SameFileError(self.params['outtmpl'])
522 for video in videos or []:
523 video['extractor'] = ie.IE_NAME
525 self.increment_downloads()
526 self.process_info(video)
527 except UnavailableVideoError:
528 self.trouble(u'\nERROR: unable to download video')
530 # Suitable InfoExtractor had been found; go to next URL
533 if not suitable_found:
534 self.trouble(u'ERROR: no suitable InfoExtractor: %s' % url)
536 return self._download_retcode
538 def post_process(self, filename, ie_info):
539 """Run all the postprocessors on the given file."""
541 info['filepath'] = filename
545 keep_video_wish,new_info = pp.run(info)
546 if keep_video_wish is not None:
548 keep_video = keep_video_wish
549 elif keep_video is None:
550 # No clear decision yet, let IE decide
551 keep_video = keep_video_wish
552 except PostProcessingError as e:
553 self.to_stderr(u'ERROR: ' + e.msg)
554 if keep_video is False and not self.params.get('keepvideo', False):
556 self.to_stderr(u'Deleting original file %s (pass -k to keep)' % filename)
557 os.remove(encodeFilename(filename))
558 except (IOError, OSError):
559 self.to_stderr(u'WARNING: Unable to remove downloaded video file')
561 def _download_with_rtmpdump(self, filename, url, player_url, page_url):
562 self.report_destination(filename)
563 tmpfilename = self.temp_name(filename)
565 # Check for rtmpdump first
567 subprocess.call(['rtmpdump', '-h'], stdout=(file(os.path.devnull, 'w')), stderr=subprocess.STDOUT)
568 except (OSError, IOError):
569 self.trouble(u'ERROR: RTMP download detected but "rtmpdump" could not be run')
572 # Download using rtmpdump. rtmpdump returns exit code 2 when
573 # the connection was interrumpted and resuming appears to be
574 # possible. This is part of rtmpdump's normal usage, AFAIK.
575 basic_args = ['rtmpdump', '-q', '-r', url, '-o', tmpfilename]
576 if player_url is not None:
577 basic_args += ['-W', player_url]
578 if page_url is not None:
579 basic_args += ['--pageUrl', page_url]
580 args = basic_args + [[], ['-e', '-k', '1']][self.params.get('continuedl', False)]
581 if self.params.get('verbose', False):
584 shell_quote = lambda args: ' '.join(map(pipes.quote, args))
587 self.to_screen(u'[debug] rtmpdump command line: ' + shell_quote(args))
588 retval = subprocess.call(args)
589 while retval == 2 or retval == 1:
590 prevsize = os.path.getsize(encodeFilename(tmpfilename))
591 self.to_screen(u'\r[rtmpdump] %s bytes' % prevsize, skip_eol=True)
592 time.sleep(5.0) # This seems to be needed
593 retval = subprocess.call(basic_args + ['-e'] + [[], ['-k', '1']][retval == 1])
594 cursize = os.path.getsize(encodeFilename(tmpfilename))
595 if prevsize == cursize and retval == 1:
597 # Some rtmp streams seem abort after ~ 99.8%. Don't complain for those
598 if prevsize == cursize and retval == 2 and cursize > 1024:
599 self.to_screen(u'\r[rtmpdump] Could not download the whole video. This can happen for some advertisements.')
603 fsize = os.path.getsize(encodeFilename(tmpfilename))
604 self.to_screen(u'\r[rtmpdump] %s bytes' % fsize)
605 self.try_rename(tmpfilename, filename)
606 self._hook_progress({
607 'downloaded_bytes': fsize,
608 'total_bytes': fsize,
609 'filename': filename,
610 'status': 'finished',
614 self.trouble(u'\nERROR: rtmpdump exited with code %d' % retval)
617 def _do_download(self, filename, info_dict):
618 url = info_dict['url']
620 # Check file already present
621 if self.params.get('continuedl', False) and os.path.isfile(encodeFilename(filename)) and not self.params.get('nopart', False):
622 self.report_file_already_downloaded(filename)
623 self._hook_progress({
624 'filename': filename,
625 'status': 'finished',
629 # Attempt to download using rtmpdump
630 if url.startswith('rtmp'):
631 return self._download_with_rtmpdump(filename, url,
632 info_dict.get('player_url', None),
633 info_dict.get('page_url', None))
635 tmpfilename = self.temp_name(filename)
638 # Do not include the Accept-Encoding header
639 headers = {'Youtubedl-no-compression': 'True'}
640 if 'user_agent' in info_dict:
641 headers['Youtubedl-user-agent'] = info_dict['user_agent']
642 basic_request = compat_urllib_request.Request(url, None, headers)
643 request = compat_urllib_request.Request(url, None, headers)
645 if self.params.get('test', False):
646 request.add_header('Range','bytes=0-10240')
648 # Establish possible resume length
649 if os.path.isfile(encodeFilename(tmpfilename)):
650 resume_len = os.path.getsize(encodeFilename(tmpfilename))
656 if self.params.get('continuedl', False):
657 self.report_resuming_byte(resume_len)
658 request.add_header('Range','bytes=%d-' % resume_len)
664 retries = self.params.get('retries', 0)
665 while count <= retries:
666 # Establish connection
668 if count == 0 and 'urlhandle' in info_dict:
669 data = info_dict['urlhandle']
670 data = compat_urllib_request.urlopen(request)
672 except (compat_urllib_error.HTTPError, ) as err:
673 if (err.code < 500 or err.code >= 600) and err.code != 416:
674 # Unexpected HTTP error
676 elif err.code == 416:
677 # Unable to resume (requested range not satisfiable)
679 # Open the connection again without the range header
680 data = compat_urllib_request.urlopen(basic_request)
681 content_length = data.info()['Content-Length']
682 except (compat_urllib_error.HTTPError, ) as err:
683 if err.code < 500 or err.code >= 600:
686 # Examine the reported length
687 if (content_length is not None and
688 (resume_len - 100 < int(content_length) < resume_len + 100)):
689 # The file had already been fully downloaded.
690 # Explanation to the above condition: in issue #175 it was revealed that
691 # YouTube sometimes adds or removes a few bytes from the end of the file,
692 # changing the file size slightly and causing problems for some users. So
693 # I decided to implement a suggested change and consider the file
694 # completely downloaded if the file size differs less than 100 bytes from
695 # the one in the hard drive.
696 self.report_file_already_downloaded(filename)
697 self.try_rename(tmpfilename, filename)
698 self._hook_progress({
699 'filename': filename,
700 'status': 'finished',
704 # The length does not match, we start the download over
705 self.report_unable_to_resume()
711 self.report_retry(count, retries)
714 self.trouble(u'ERROR: giving up after %s retries' % retries)
717 data_len = data.info().get('Content-length', None)
718 if data_len is not None:
719 data_len = int(data_len) + resume_len
720 min_data_len = self.params.get("min_filesize", None)
721 max_data_len = self.params.get("max_filesize", None)
722 if min_data_len is not None and data_len < min_data_len:
723 self.to_screen(u'\r[download] File is smaller than min-filesize (%s bytes < %s bytes). Aborting.' % (data_len, min_data_len))
725 if max_data_len is not None and data_len > max_data_len:
726 self.to_screen(u'\r[download] File is larger than max-filesize (%s bytes > %s bytes). Aborting.' % (data_len, max_data_len))
729 data_len_str = self.format_bytes(data_len)
730 byte_counter = 0 + resume_len
731 block_size = self.params.get('buffersize', 1024)
736 data_block = data.read(block_size)
738 if len(data_block) == 0:
740 byte_counter += len(data_block)
742 # Open file just in time
745 (stream, tmpfilename) = sanitize_open(tmpfilename, open_mode)
746 assert stream is not None
747 filename = self.undo_temp_name(tmpfilename)
748 self.report_destination(filename)
749 except (OSError, IOError) as err:
750 self.trouble(u'ERROR: unable to open for writing: %s' % str(err))
753 stream.write(data_block)
754 except (IOError, OSError) as err:
755 self.trouble(u'\nERROR: unable to write data: %s' % str(err))
757 if not self.params.get('noresizebuffer', False):
758 block_size = self.best_block_size(after - before, len(data_block))
761 speed_str = self.calc_speed(start, time.time(), byte_counter - resume_len)
763 self.report_progress('Unknown %', data_len_str, speed_str, 'Unknown ETA')
765 percent_str = self.calc_percent(byte_counter, data_len)
766 eta_str = self.calc_eta(start, time.time(), data_len - resume_len, byte_counter - resume_len)
767 self.report_progress(percent_str, data_len_str, speed_str, eta_str)
769 self._hook_progress({
770 'downloaded_bytes': byte_counter,
771 'total_bytes': data_len,
772 'tmpfilename': tmpfilename,
773 'filename': filename,
774 'status': 'downloading',
778 self.slow_down(start, byte_counter - resume_len)
781 self.trouble(u'\nERROR: Did not get any data blocks')
785 if data_len is not None and byte_counter != data_len:
786 raise ContentTooShortError(byte_counter, int(data_len))
787 self.try_rename(tmpfilename, filename)
789 # Update file modification time
790 if self.params.get('updatetime', True):
791 info_dict['filetime'] = self.try_utime(filename, data.info().get('last-modified', None))
793 self._hook_progress({
794 'downloaded_bytes': byte_counter,
795 'total_bytes': byte_counter,
796 'filename': filename,
797 'status': 'finished',
802 def _hook_progress(self, status):
803 for ph in self._progress_hooks:
806 def add_progress_hook(self, ph):
807 """ ph gets called on download progress, with a dictionary with the entries
808 * filename: The final filename
809 * status: One of "downloading" and "finished"
811 It can also have some of the following entries:
813 * downloaded_bytes: Bytes on disks
814 * total_bytes: Total bytes, None if unknown
815 * tmpfilename: The filename we're currently writing to
817 Hooks are guaranteed to be called at least once (with status "finished")
818 if the download is successful.
820 self._progress_hooks.append(ph)