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('progress_with_newline', False):
309 self.to_screen(u'[download] %s of %s at %s ETA %s' %
310 (percent_str, data_len_str, speed_str, eta_str))
312 self.to_screen(u'\r[download] %s of %s at %s ETA %s' %
313 (percent_str, data_len_str, speed_str, eta_str), skip_eol=True)
314 self.to_cons_title(u'youtube-dl - %s of %s at %s ETA %s' %
315 (percent_str.strip(), data_len_str.strip(), speed_str.strip(), eta_str.strip()))
317 def report_resuming_byte(self, resume_len):
318 """Report attempt to resume at given byte."""
319 self.to_screen(u'[download] Resuming download at byte %s' % resume_len)
321 def report_retry(self, count, retries):
322 """Report retry in case of HTTP error 5xx"""
323 self.to_screen(u'[download] Got server HTTP error. Retrying (attempt %d of %d)...' % (count, retries))
325 def report_file_already_downloaded(self, file_name):
326 """Report file has already been fully downloaded."""
328 self.to_screen(u'[download] %s has already been downloaded' % file_name)
329 except (UnicodeEncodeError) as err:
330 self.to_screen(u'[download] The file has already been downloaded')
332 def report_unable_to_resume(self):
333 """Report it was impossible to resume download."""
334 self.to_screen(u'[download] Unable to resume')
336 def report_finish(self):
337 """Report download finished."""
338 if self.params.get('noprogress', False):
339 self.to_screen(u'[download] Download completed')
343 def increment_downloads(self):
344 """Increment the ordinal that assigns a number to each file."""
345 self._num_downloads += 1
347 def prepare_filename(self, info_dict):
348 """Generate the output filename."""
350 template_dict = dict(info_dict)
352 template_dict['epoch'] = int(time.time())
353 template_dict['autonumber'] = u'%05d' % self._num_downloads
355 sanitize = lambda k,v: sanitize_filename(
356 u'NA' if v is None else compat_str(v),
357 restricted=self.params.get('restrictfilenames'),
359 template_dict = dict((k, sanitize(k, v)) for k,v in template_dict.items())
361 filename = self.params['outtmpl'] % template_dict
363 except (ValueError, KeyError) as err:
364 self.trouble(u'ERROR: invalid system charset or erroneous output template')
367 def _match_entry(self, info_dict):
368 """ Returns None iff the file should be downloaded """
370 title = info_dict['title']
371 matchtitle = self.params.get('matchtitle', False)
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 if re.search(rejecttitle, title, re.IGNORECASE):
378 return u'"' + title + '" title matched reject pattern "' + rejecttitle + '"'
381 def extract_info(self, url):
383 Returns a list with a dictionary for each video we find.
385 suitable_found = False
387 # Go to next InfoExtractor if not suitable
388 if not ie.suitable(url):
391 # Warn if the _WORKING attribute is False
393 self.to_stderr(u'WARNING: the program functionality for this site has been marked as broken, '
394 u'and will probably not work. If you want to go on, use the -i option.')
396 # Suitable InfoExtractor found
397 suitable_found = True
399 # Extract information from URL and process it
401 videos = ie.extract(url)
402 for video in videos or []:
403 if not 'extractor' in video:
404 #The extractor has already been set somewher else
405 video['extractor'] = ie.IE_NAME
407 except ExtractorError as de: # An error we somewhat expected
408 self.trouble(u'ERROR: ' + compat_str(de), de.format_traceback())
410 except Exception as e:
411 if self.params.get('ignoreerrors', False):
412 self.trouble(u'ERROR: ' + compat_str(e), tb=compat_str(traceback.format_exc()))
416 if not suitable_found:
417 self.trouble(u'ERROR: no suitable InfoExtractor: %s' % url)
419 def process_info(self, info_dict):
420 """Process a single dictionary returned by an InfoExtractor."""
422 # Keep for backwards compatibility
423 info_dict['stitle'] = info_dict['title']
425 if not 'format' in info_dict:
426 info_dict['format'] = info_dict['ext']
428 reason = self._match_entry(info_dict)
429 if reason is not None:
430 self.to_screen(u'[download] ' + reason)
433 max_downloads = self.params.get('max_downloads')
434 if max_downloads is not None:
435 if self._num_downloads > int(max_downloads):
436 raise MaxDownloadsReached()
438 filename = self.prepare_filename(info_dict)
441 if self.params.get('forcetitle', False):
442 compat_print(info_dict['title'])
443 if self.params.get('forceurl', False):
444 compat_print(info_dict['url'])
445 if self.params.get('forcethumbnail', False) and 'thumbnail' in info_dict:
446 compat_print(info_dict['thumbnail'])
447 if self.params.get('forcedescription', False) and 'description' in info_dict:
448 compat_print(info_dict['description'])
449 if self.params.get('forcefilename', False) and filename is not None:
450 compat_print(filename)
451 if self.params.get('forceformat', False):
452 compat_print(info_dict['format'])
454 # Do nothing else if in simulate mode
455 if self.params.get('simulate', False):
462 dn = os.path.dirname(encodeFilename(filename))
463 if dn != '' and not os.path.exists(dn): # dn is already encoded
465 except (OSError, IOError) as err:
466 self.trouble(u'ERROR: unable to create directory ' + compat_str(err))
469 if self.params.get('writedescription', False):
471 descfn = filename + u'.description'
472 self.report_writedescription(descfn)
473 with io.open(encodeFilename(descfn), 'w', encoding='utf-8') as descfile:
474 descfile.write(info_dict['description'])
475 except (OSError, IOError):
476 self.trouble(u'ERROR: Cannot write description file ' + descfn)
479 if self.params.get('writesubtitles', False) and 'subtitles' in info_dict and info_dict['subtitles']:
480 # subtitles download errors are already managed as troubles in relevant IE
481 # that way it will silently go on when used with unsupporting IE
483 srtfn = filename.rsplit('.', 1)[0] + u'.srt'
484 self.report_writesubtitles(srtfn)
485 with io.open(encodeFilename(srtfn), 'w', encoding='utf-8') as srtfile:
486 srtfile.write(info_dict['subtitles'])
487 except (OSError, IOError):
488 self.trouble(u'ERROR: Cannot write subtitles file ' + descfn)
491 if self.params.get('writeinfojson', False):
492 infofn = filename + u'.info.json'
493 self.report_writeinfojson(infofn)
495 json_info_dict = dict((k, v) for k,v in info_dict.items() if not k in ['urlhandle'])
496 write_json_file(json_info_dict, encodeFilename(infofn))
497 except (OSError, IOError):
498 self.trouble(u'ERROR: Cannot write metadata to JSON file ' + infofn)
501 if not self.params.get('skip_download', False):
502 if self.params.get('nooverwrites', False) and os.path.exists(encodeFilename(filename)):
506 success = self._do_download(filename, info_dict)
507 except (OSError, IOError) as err:
508 raise UnavailableVideoError()
509 except (compat_urllib_error.URLError, compat_http_client.HTTPException, socket.error) as err:
510 self.trouble(u'ERROR: unable to download video data: %s' % str(err))
512 except (ContentTooShortError, ) as err:
513 self.trouble(u'ERROR: content too short (expected %s bytes and served %s)' % (err.expected, err.downloaded))
518 self.post_process(filename, info_dict)
519 except (PostProcessingError) as err:
520 self.trouble(u'ERROR: postprocessing: %s' % str(err))
523 def download(self, url_list):
524 """Download a given list of URLs."""
525 if len(url_list) > 1 and self.fixed_template():
526 raise SameFileError(self.params['outtmpl'])
529 videos = self.extract_info(url)
531 for video in videos or []:
533 self.increment_downloads()
534 self.process_info(video)
535 except UnavailableVideoError:
536 self.trouble(u'\nERROR: unable to download video')
538 return self._download_retcode
540 def post_process(self, filename, ie_info):
541 """Run all the postprocessors on the given file."""
543 info['filepath'] = filename
547 keep_video_wish,new_info = pp.run(info)
548 if keep_video_wish is not None:
550 keep_video = keep_video_wish
551 elif keep_video is None:
552 # No clear decision yet, let IE decide
553 keep_video = keep_video_wish
554 except PostProcessingError as e:
555 self.to_stderr(u'ERROR: ' + e.msg)
556 if keep_video is False and not self.params.get('keepvideo', False):
558 self.to_screen(u'Deleting original file %s (pass -k to keep)' % filename)
559 os.remove(encodeFilename(filename))
560 except (IOError, OSError):
561 self.to_stderr(u'WARNING: Unable to remove downloaded video file')
563 def _download_with_rtmpdump(self, filename, url, player_url, page_url):
564 self.report_destination(filename)
565 tmpfilename = self.temp_name(filename)
567 # Check for rtmpdump first
569 subprocess.call(['rtmpdump', '-h'], stdout=(file(os.path.devnull, 'w')), stderr=subprocess.STDOUT)
570 except (OSError, IOError):
571 self.trouble(u'ERROR: RTMP download detected but "rtmpdump" could not be run')
574 # Download using rtmpdump. rtmpdump returns exit code 2 when
575 # the connection was interrumpted and resuming appears to be
576 # possible. This is part of rtmpdump's normal usage, AFAIK.
577 basic_args = ['rtmpdump', '-q', '-r', url, '-o', tmpfilename]
578 if player_url is not None:
579 basic_args += ['-W', player_url]
580 if page_url is not None:
581 basic_args += ['--pageUrl', page_url]
582 args = basic_args + [[], ['-e', '-k', '1']][self.params.get('continuedl', False)]
583 if self.params.get('verbose', False):
586 shell_quote = lambda args: ' '.join(map(pipes.quote, args))
589 self.to_screen(u'[debug] rtmpdump command line: ' + shell_quote(args))
590 retval = subprocess.call(args)
591 while retval == 2 or retval == 1:
592 prevsize = os.path.getsize(encodeFilename(tmpfilename))
593 self.to_screen(u'\r[rtmpdump] %s bytes' % prevsize, skip_eol=True)
594 time.sleep(5.0) # This seems to be needed
595 retval = subprocess.call(basic_args + ['-e'] + [[], ['-k', '1']][retval == 1])
596 cursize = os.path.getsize(encodeFilename(tmpfilename))
597 if prevsize == cursize and retval == 1:
599 # Some rtmp streams seem abort after ~ 99.8%. Don't complain for those
600 if prevsize == cursize and retval == 2 and cursize > 1024:
601 self.to_screen(u'\r[rtmpdump] Could not download the whole video. This can happen for some advertisements.')
605 fsize = os.path.getsize(encodeFilename(tmpfilename))
606 self.to_screen(u'\r[rtmpdump] %s bytes' % fsize)
607 self.try_rename(tmpfilename, filename)
608 self._hook_progress({
609 'downloaded_bytes': fsize,
610 'total_bytes': fsize,
611 'filename': filename,
612 'status': 'finished',
616 self.trouble(u'\nERROR: rtmpdump exited with code %d' % retval)
619 def _do_download(self, filename, info_dict):
620 url = info_dict['url']
622 # Check file already present
623 if self.params.get('continuedl', False) and os.path.isfile(encodeFilename(filename)) and not self.params.get('nopart', False):
624 self.report_file_already_downloaded(filename)
625 self._hook_progress({
626 'filename': filename,
627 'status': 'finished',
631 # Attempt to download using rtmpdump
632 if url.startswith('rtmp'):
633 return self._download_with_rtmpdump(filename, url,
634 info_dict.get('player_url', None),
635 info_dict.get('page_url', None))
637 tmpfilename = self.temp_name(filename)
640 # Do not include the Accept-Encoding header
641 headers = {'Youtubedl-no-compression': 'True'}
642 if 'user_agent' in info_dict:
643 headers['Youtubedl-user-agent'] = info_dict['user_agent']
644 basic_request = compat_urllib_request.Request(url, None, headers)
645 request = compat_urllib_request.Request(url, None, headers)
647 if self.params.get('test', False):
648 request.add_header('Range','bytes=0-10240')
650 # Establish possible resume length
651 if os.path.isfile(encodeFilename(tmpfilename)):
652 resume_len = os.path.getsize(encodeFilename(tmpfilename))
658 if self.params.get('continuedl', False):
659 self.report_resuming_byte(resume_len)
660 request.add_header('Range','bytes=%d-' % resume_len)
666 retries = self.params.get('retries', 0)
667 while count <= retries:
668 # Establish connection
670 if count == 0 and 'urlhandle' in info_dict:
671 data = info_dict['urlhandle']
672 data = compat_urllib_request.urlopen(request)
674 except (compat_urllib_error.HTTPError, ) as err:
675 if (err.code < 500 or err.code >= 600) and err.code != 416:
676 # Unexpected HTTP error
678 elif err.code == 416:
679 # Unable to resume (requested range not satisfiable)
681 # Open the connection again without the range header
682 data = compat_urllib_request.urlopen(basic_request)
683 content_length = data.info()['Content-Length']
684 except (compat_urllib_error.HTTPError, ) as err:
685 if err.code < 500 or err.code >= 600:
688 # Examine the reported length
689 if (content_length is not None and
690 (resume_len - 100 < int(content_length) < resume_len + 100)):
691 # The file had already been fully downloaded.
692 # Explanation to the above condition: in issue #175 it was revealed that
693 # YouTube sometimes adds or removes a few bytes from the end of the file,
694 # changing the file size slightly and causing problems for some users. So
695 # I decided to implement a suggested change and consider the file
696 # completely downloaded if the file size differs less than 100 bytes from
697 # the one in the hard drive.
698 self.report_file_already_downloaded(filename)
699 self.try_rename(tmpfilename, filename)
700 self._hook_progress({
701 'filename': filename,
702 'status': 'finished',
706 # The length does not match, we start the download over
707 self.report_unable_to_resume()
713 self.report_retry(count, retries)
716 self.trouble(u'ERROR: giving up after %s retries' % retries)
719 data_len = data.info().get('Content-length', None)
720 if data_len is not None:
721 data_len = int(data_len) + resume_len
722 min_data_len = self.params.get("min_filesize", None)
723 max_data_len = self.params.get("max_filesize", None)
724 if min_data_len is not None and data_len < min_data_len:
725 self.to_screen(u'\r[download] File is smaller than min-filesize (%s bytes < %s bytes). Aborting.' % (data_len, min_data_len))
727 if max_data_len is not None and data_len > max_data_len:
728 self.to_screen(u'\r[download] File is larger than max-filesize (%s bytes > %s bytes). Aborting.' % (data_len, max_data_len))
731 data_len_str = self.format_bytes(data_len)
732 byte_counter = 0 + resume_len
733 block_size = self.params.get('buffersize', 1024)
738 data_block = data.read(block_size)
740 if len(data_block) == 0:
742 byte_counter += len(data_block)
744 # Open file just in time
747 (stream, tmpfilename) = sanitize_open(tmpfilename, open_mode)
748 assert stream is not None
749 filename = self.undo_temp_name(tmpfilename)
750 self.report_destination(filename)
751 except (OSError, IOError) as err:
752 self.trouble(u'ERROR: unable to open for writing: %s' % str(err))
755 stream.write(data_block)
756 except (IOError, OSError) as err:
757 self.trouble(u'\nERROR: unable to write data: %s' % str(err))
759 if not self.params.get('noresizebuffer', False):
760 block_size = self.best_block_size(after - before, len(data_block))
763 speed_str = self.calc_speed(start, time.time(), byte_counter - resume_len)
765 self.report_progress('Unknown %', data_len_str, speed_str, 'Unknown ETA')
767 percent_str = self.calc_percent(byte_counter, data_len)
768 eta_str = self.calc_eta(start, time.time(), data_len - resume_len, byte_counter - resume_len)
769 self.report_progress(percent_str, data_len_str, speed_str, eta_str)
771 self._hook_progress({
772 'downloaded_bytes': byte_counter,
773 'total_bytes': data_len,
774 'tmpfilename': tmpfilename,
775 'filename': filename,
776 'status': 'downloading',
780 self.slow_down(start, byte_counter - resume_len)
783 self.trouble(u'\nERROR: Did not get any data blocks')
787 if data_len is not None and byte_counter != data_len:
788 raise ContentTooShortError(byte_counter, int(data_len))
789 self.try_rename(tmpfilename, filename)
791 # Update file modification time
792 if self.params.get('updatetime', True):
793 info_dict['filetime'] = self.try_utime(filename, data.info().get('last-modified', None))
795 self._hook_progress({
796 'downloaded_bytes': byte_counter,
797 'total_bytes': byte_counter,
798 'filename': filename,
799 'status': 'finished',
804 def _hook_progress(self, status):
805 for ph in self._progress_hooks:
808 def add_progress_hook(self, ph):
809 """ ph gets called on download progress, with a dictionary with the entries
810 * filename: The final filename
811 * status: One of "downloading" and "finished"
813 It can also have some of the following entries:
815 * downloaded_bytes: Bytes on disks
816 * total_bytes: Total bytes, None if unknown
817 * tmpfilename: The filename we're currently writing to
819 Hooks are guaranteed to be called at least once (with status "finished")
820 if the download is successful.
822 self._progress_hooks.append(ph)