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.report_warning(u'%(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 report_warning(self, message):
239 Print the message to stderr, it will be prefixed with 'WARNING:'
240 If stderr is a tty file the 'WARNING:' will be colored
242 if sys.stderr.isatty():
243 _msg_header=u'\033[0;33mWARNING:\033[0m'
245 _msg_header=u'WARNING:'
246 warning_message=u'%s %s' % (_msg_header,message)
247 self.to_stderr(warning_message)
249 def slow_down(self, start_time, byte_counter):
250 """Sleep if the download speed is over the rate limit."""
251 rate_limit = self.params.get('ratelimit', None)
252 if rate_limit is None or byte_counter == 0:
255 elapsed = now - start_time
258 speed = float(byte_counter) / elapsed
259 if speed > rate_limit:
260 time.sleep((byte_counter - rate_limit * (now - start_time)) / rate_limit)
262 def temp_name(self, filename):
263 """Returns a temporary filename for the given filename."""
264 if self.params.get('nopart', False) or filename == u'-' or \
265 (os.path.exists(encodeFilename(filename)) and not os.path.isfile(encodeFilename(filename))):
267 return filename + u'.part'
269 def undo_temp_name(self, filename):
270 if filename.endswith(u'.part'):
271 return filename[:-len(u'.part')]
274 def try_rename(self, old_filename, new_filename):
276 if old_filename == new_filename:
278 os.rename(encodeFilename(old_filename), encodeFilename(new_filename))
279 except (IOError, OSError) as err:
280 self.trouble(u'ERROR: unable to rename file')
282 def try_utime(self, filename, last_modified_hdr):
283 """Try to set the last-modified time of the given file."""
284 if last_modified_hdr is None:
286 if not os.path.isfile(encodeFilename(filename)):
288 timestr = last_modified_hdr
291 filetime = timeconvert(timestr)
295 os.utime(filename, (time.time(), filetime))
300 def report_writedescription(self, descfn):
301 """ Report that the description file is being written """
302 self.to_screen(u'[info] Writing video description to: ' + descfn)
304 def report_writesubtitles(self, srtfn):
305 """ Report that the subtitles file is being written """
306 self.to_screen(u'[info] Writing video subtitles to: ' + srtfn)
308 def report_writeinfojson(self, infofn):
309 """ Report that the metadata file has been written """
310 self.to_screen(u'[info] Video description metadata as JSON to: ' + infofn)
312 def report_destination(self, filename):
313 """Report destination filename."""
314 self.to_screen(u'[download] Destination: ' + filename)
316 def report_progress(self, percent_str, data_len_str, speed_str, eta_str):
317 """Report download progress."""
318 if self.params.get('noprogress', False):
320 if self.params.get('progress_with_newline', False):
321 self.to_screen(u'[download] %s of %s at %s ETA %s' %
322 (percent_str, data_len_str, speed_str, eta_str))
324 self.to_screen(u'\r[download] %s of %s at %s ETA %s' %
325 (percent_str, data_len_str, speed_str, eta_str), skip_eol=True)
326 self.to_cons_title(u'youtube-dl - %s of %s at %s ETA %s' %
327 (percent_str.strip(), data_len_str.strip(), speed_str.strip(), eta_str.strip()))
329 def report_resuming_byte(self, resume_len):
330 """Report attempt to resume at given byte."""
331 self.to_screen(u'[download] Resuming download at byte %s' % resume_len)
333 def report_retry(self, count, retries):
334 """Report retry in case of HTTP error 5xx"""
335 self.to_screen(u'[download] Got server HTTP error. Retrying (attempt %d of %d)...' % (count, retries))
337 def report_file_already_downloaded(self, file_name):
338 """Report file has already been fully downloaded."""
340 self.to_screen(u'[download] %s has already been downloaded' % file_name)
341 except (UnicodeEncodeError) as err:
342 self.to_screen(u'[download] The file has already been downloaded')
344 def report_unable_to_resume(self):
345 """Report it was impossible to resume download."""
346 self.to_screen(u'[download] Unable to resume')
348 def report_finish(self):
349 """Report download finished."""
350 if self.params.get('noprogress', False):
351 self.to_screen(u'[download] Download completed')
355 def increment_downloads(self):
356 """Increment the ordinal that assigns a number to each file."""
357 self._num_downloads += 1
359 def prepare_filename(self, info_dict):
360 """Generate the output filename."""
362 template_dict = dict(info_dict)
364 template_dict['epoch'] = int(time.time())
365 template_dict['autonumber'] = u'%05d' % self._num_downloads
367 sanitize = lambda k,v: sanitize_filename(
368 u'NA' if v is None else compat_str(v),
369 restricted=self.params.get('restrictfilenames'),
371 template_dict = dict((k, sanitize(k, v)) for k,v in template_dict.items())
373 filename = self.params['outtmpl'] % template_dict
375 except (ValueError, KeyError) as err:
376 self.trouble(u'ERROR: invalid system charset or erroneous output template')
379 def _match_entry(self, info_dict):
380 """ Returns None iff the file should be downloaded """
382 title = info_dict['title']
383 matchtitle = self.params.get('matchtitle', False)
385 if not re.search(matchtitle, title, re.IGNORECASE):
386 return u'[download] "' + title + '" title did not match pattern "' + matchtitle + '"'
387 rejecttitle = self.params.get('rejecttitle', False)
389 if re.search(rejecttitle, title, re.IGNORECASE):
390 return u'"' + title + '" title matched reject pattern "' + rejecttitle + '"'
393 def process_info(self, info_dict):
394 """Process a single dictionary returned by an InfoExtractor."""
396 # Keep for backwards compatibility
397 info_dict['stitle'] = info_dict['title']
399 if not 'format' in info_dict:
400 info_dict['format'] = info_dict['ext']
402 reason = self._match_entry(info_dict)
403 if reason is not None:
404 self.to_screen(u'[download] ' + reason)
407 max_downloads = self.params.get('max_downloads')
408 if max_downloads is not None:
409 if self._num_downloads > int(max_downloads):
410 raise MaxDownloadsReached()
412 filename = self.prepare_filename(info_dict)
415 if self.params.get('forcetitle', False):
416 compat_print(info_dict['title'])
417 if self.params.get('forceurl', False):
418 compat_print(info_dict['url'])
419 if self.params.get('forcethumbnail', False) and 'thumbnail' in info_dict:
420 compat_print(info_dict['thumbnail'])
421 if self.params.get('forcedescription', False) and 'description' in info_dict:
422 compat_print(info_dict['description'])
423 if self.params.get('forcefilename', False) and filename is not None:
424 compat_print(filename)
425 if self.params.get('forceformat', False):
426 compat_print(info_dict['format'])
428 # Do nothing else if in simulate mode
429 if self.params.get('simulate', False):
436 dn = os.path.dirname(encodeFilename(filename))
437 if dn != '' and not os.path.exists(dn): # dn is already encoded
439 except (OSError, IOError) as err:
440 self.trouble(u'ERROR: unable to create directory ' + compat_str(err))
443 if self.params.get('writedescription', False):
445 descfn = filename + u'.description'
446 self.report_writedescription(descfn)
447 with io.open(encodeFilename(descfn), 'w', encoding='utf-8') as descfile:
448 descfile.write(info_dict['description'])
449 except (OSError, IOError):
450 self.trouble(u'ERROR: Cannot write description file ' + descfn)
453 if self.params.get('writesubtitles', False) and 'subtitles' in info_dict and info_dict['subtitles']:
454 # subtitles download errors are already managed as troubles in relevant IE
455 # that way it will silently go on when used with unsupporting IE
457 srtfn = filename.rsplit('.', 1)[0] + u'.srt'
458 self.report_writesubtitles(srtfn)
459 with io.open(encodeFilename(srtfn), 'w', encoding='utf-8') as srtfile:
460 srtfile.write(info_dict['subtitles'])
461 except (OSError, IOError):
462 self.trouble(u'ERROR: Cannot write subtitles file ' + descfn)
465 if self.params.get('writeinfojson', False):
466 infofn = filename + u'.info.json'
467 self.report_writeinfojson(infofn)
469 json_info_dict = dict((k, v) for k,v in info_dict.items() if not k in ['urlhandle'])
470 write_json_file(json_info_dict, encodeFilename(infofn))
471 except (OSError, IOError):
472 self.trouble(u'ERROR: Cannot write metadata to JSON file ' + infofn)
475 if not self.params.get('skip_download', False):
476 if self.params.get('nooverwrites', False) and os.path.exists(encodeFilename(filename)):
480 success = self._do_download(filename, info_dict)
481 except (OSError, IOError) as err:
482 raise UnavailableVideoError()
483 except (compat_urllib_error.URLError, compat_http_client.HTTPException, socket.error) as err:
484 self.trouble(u'ERROR: unable to download video data: %s' % str(err))
486 except (ContentTooShortError, ) as err:
487 self.trouble(u'ERROR: content too short (expected %s bytes and served %s)' % (err.expected, err.downloaded))
492 self.post_process(filename, info_dict)
493 except (PostProcessingError) as err:
494 self.trouble(u'ERROR: postprocessing: %s' % str(err))
497 def download(self, url_list):
498 """Download a given list of URLs."""
499 if len(url_list) > 1 and self.fixed_template():
500 raise SameFileError(self.params['outtmpl'])
503 suitable_found = False
505 # Go to next InfoExtractor if not suitable
506 if not ie.suitable(url):
509 # Warn if the _WORKING attribute is False
511 self.report_warning(u'the program functionality for this site has been marked as broken, '
512 u'and will probably not work. If you want to go on, use the -i option.')
514 # Suitable InfoExtractor found
515 suitable_found = True
517 # Extract information from URL and process it
519 videos = ie.extract(url)
520 except ExtractorError as de: # An error we somewhat expected
521 self.trouble(u'ERROR: ' + compat_str(de), de.format_traceback())
523 except Exception as e:
524 if self.params.get('ignoreerrors', False):
525 self.trouble(u'ERROR: ' + compat_str(e), tb=compat_str(traceback.format_exc()))
530 if len(videos or []) > 1 and self.fixed_template():
531 raise SameFileError(self.params['outtmpl'])
533 for video in videos or []:
534 video['extractor'] = ie.IE_NAME
536 self.increment_downloads()
537 self.process_info(video)
538 except UnavailableVideoError:
539 self.trouble(u'\nERROR: unable to download video')
541 # Suitable InfoExtractor had been found; go to next URL
544 if not suitable_found:
545 self.trouble(u'ERROR: no suitable InfoExtractor: %s' % url)
547 return self._download_retcode
549 def post_process(self, filename, ie_info):
550 """Run all the postprocessors on the given file."""
552 info['filepath'] = filename
556 keep_video_wish,new_info = pp.run(info)
557 if keep_video_wish is not None:
559 keep_video = keep_video_wish
560 elif keep_video is None:
561 # No clear decision yet, let IE decide
562 keep_video = keep_video_wish
563 except PostProcessingError as e:
564 self.to_stderr(u'ERROR: ' + e.msg)
565 if keep_video is False and not self.params.get('keepvideo', False):
567 self.to_screen(u'Deleting original file %s (pass -k to keep)' % filename)
568 os.remove(encodeFilename(filename))
569 except (IOError, OSError):
570 self.report_warning(u'Unable to remove downloaded video file')
572 def _download_with_rtmpdump(self, filename, url, player_url, page_url):
573 self.report_destination(filename)
574 tmpfilename = self.temp_name(filename)
576 # Check for rtmpdump first
578 subprocess.call(['rtmpdump', '-h'], stdout=(open(os.path.devnull, 'w')), stderr=subprocess.STDOUT)
579 except (OSError, IOError):
580 self.trouble(u'ERROR: RTMP download detected but "rtmpdump" could not be run')
583 # Download using rtmpdump. rtmpdump returns exit code 2 when
584 # the connection was interrumpted and resuming appears to be
585 # possible. This is part of rtmpdump's normal usage, AFAIK.
586 basic_args = ['rtmpdump', '-q', '-r', url, '-o', tmpfilename]
587 if player_url is not None:
588 basic_args += ['-W', player_url]
589 if page_url is not None:
590 basic_args += ['--pageUrl', page_url]
591 args = basic_args + [[], ['-e', '-k', '1']][self.params.get('continuedl', False)]
592 if self.params.get('verbose', False):
595 shell_quote = lambda args: ' '.join(map(pipes.quote, args))
598 self.to_screen(u'[debug] rtmpdump command line: ' + shell_quote(args))
599 retval = subprocess.call(args)
600 while retval == 2 or retval == 1:
601 prevsize = os.path.getsize(encodeFilename(tmpfilename))
602 self.to_screen(u'\r[rtmpdump] %s bytes' % prevsize, skip_eol=True)
603 time.sleep(5.0) # This seems to be needed
604 retval = subprocess.call(basic_args + ['-e'] + [[], ['-k', '1']][retval == 1])
605 cursize = os.path.getsize(encodeFilename(tmpfilename))
606 if prevsize == cursize and retval == 1:
608 # Some rtmp streams seem abort after ~ 99.8%. Don't complain for those
609 if prevsize == cursize and retval == 2 and cursize > 1024:
610 self.to_screen(u'\r[rtmpdump] Could not download the whole video. This can happen for some advertisements.')
614 fsize = os.path.getsize(encodeFilename(tmpfilename))
615 self.to_screen(u'\r[rtmpdump] %s bytes' % fsize)
616 self.try_rename(tmpfilename, filename)
617 self._hook_progress({
618 'downloaded_bytes': fsize,
619 'total_bytes': fsize,
620 'filename': filename,
621 'status': 'finished',
625 self.trouble(u'\nERROR: rtmpdump exited with code %d' % retval)
628 def _do_download(self, filename, info_dict):
629 url = info_dict['url']
631 # Check file already present
632 if self.params.get('continuedl', False) and os.path.isfile(encodeFilename(filename)) and not self.params.get('nopart', False):
633 self.report_file_already_downloaded(filename)
634 self._hook_progress({
635 'filename': filename,
636 'status': 'finished',
640 # Attempt to download using rtmpdump
641 if url.startswith('rtmp'):
642 return self._download_with_rtmpdump(filename, url,
643 info_dict.get('player_url', None),
644 info_dict.get('page_url', None))
646 tmpfilename = self.temp_name(filename)
649 # Do not include the Accept-Encoding header
650 headers = {'Youtubedl-no-compression': 'True'}
651 if 'user_agent' in info_dict:
652 headers['Youtubedl-user-agent'] = info_dict['user_agent']
653 basic_request = compat_urllib_request.Request(url, None, headers)
654 request = compat_urllib_request.Request(url, None, headers)
656 if self.params.get('test', False):
657 request.add_header('Range','bytes=0-10240')
659 # Establish possible resume length
660 if os.path.isfile(encodeFilename(tmpfilename)):
661 resume_len = os.path.getsize(encodeFilename(tmpfilename))
667 if self.params.get('continuedl', False):
668 self.report_resuming_byte(resume_len)
669 request.add_header('Range','bytes=%d-' % resume_len)
675 retries = self.params.get('retries', 0)
676 while count <= retries:
677 # Establish connection
679 if count == 0 and 'urlhandle' in info_dict:
680 data = info_dict['urlhandle']
681 data = compat_urllib_request.urlopen(request)
683 except (compat_urllib_error.HTTPError, ) as err:
684 if (err.code < 500 or err.code >= 600) and err.code != 416:
685 # Unexpected HTTP error
687 elif err.code == 416:
688 # Unable to resume (requested range not satisfiable)
690 # Open the connection again without the range header
691 data = compat_urllib_request.urlopen(basic_request)
692 content_length = data.info()['Content-Length']
693 except (compat_urllib_error.HTTPError, ) as err:
694 if err.code < 500 or err.code >= 600:
697 # Examine the reported length
698 if (content_length is not None and
699 (resume_len - 100 < int(content_length) < resume_len + 100)):
700 # The file had already been fully downloaded.
701 # Explanation to the above condition: in issue #175 it was revealed that
702 # YouTube sometimes adds or removes a few bytes from the end of the file,
703 # changing the file size slightly and causing problems for some users. So
704 # I decided to implement a suggested change and consider the file
705 # completely downloaded if the file size differs less than 100 bytes from
706 # the one in the hard drive.
707 self.report_file_already_downloaded(filename)
708 self.try_rename(tmpfilename, filename)
709 self._hook_progress({
710 'filename': filename,
711 'status': 'finished',
715 # The length does not match, we start the download over
716 self.report_unable_to_resume()
722 self.report_retry(count, retries)
725 self.trouble(u'ERROR: giving up after %s retries' % retries)
728 data_len = data.info().get('Content-length', None)
729 if data_len is not None:
730 data_len = int(data_len) + resume_len
731 min_data_len = self.params.get("min_filesize", None)
732 max_data_len = self.params.get("max_filesize", None)
733 if min_data_len is not None and data_len < min_data_len:
734 self.to_screen(u'\r[download] File is smaller than min-filesize (%s bytes < %s bytes). Aborting.' % (data_len, min_data_len))
736 if max_data_len is not None and data_len > max_data_len:
737 self.to_screen(u'\r[download] File is larger than max-filesize (%s bytes > %s bytes). Aborting.' % (data_len, max_data_len))
740 data_len_str = self.format_bytes(data_len)
741 byte_counter = 0 + resume_len
742 block_size = self.params.get('buffersize', 1024)
747 data_block = data.read(block_size)
749 if len(data_block) == 0:
751 byte_counter += len(data_block)
753 # Open file just in time
756 (stream, tmpfilename) = sanitize_open(tmpfilename, open_mode)
757 assert stream is not None
758 filename = self.undo_temp_name(tmpfilename)
759 self.report_destination(filename)
760 except (OSError, IOError) as err:
761 self.trouble(u'ERROR: unable to open for writing: %s' % str(err))
764 stream.write(data_block)
765 except (IOError, OSError) as err:
766 self.trouble(u'\nERROR: unable to write data: %s' % str(err))
768 if not self.params.get('noresizebuffer', False):
769 block_size = self.best_block_size(after - before, len(data_block))
772 speed_str = self.calc_speed(start, time.time(), byte_counter - resume_len)
774 self.report_progress('Unknown %', data_len_str, speed_str, 'Unknown ETA')
776 percent_str = self.calc_percent(byte_counter, data_len)
777 eta_str = self.calc_eta(start, time.time(), data_len - resume_len, byte_counter - resume_len)
778 self.report_progress(percent_str, data_len_str, speed_str, eta_str)
780 self._hook_progress({
781 'downloaded_bytes': byte_counter,
782 'total_bytes': data_len,
783 'tmpfilename': tmpfilename,
784 'filename': filename,
785 'status': 'downloading',
789 self.slow_down(start, byte_counter - resume_len)
792 self.trouble(u'\nERROR: Did not get any data blocks')
796 if data_len is not None and byte_counter != data_len:
797 raise ContentTooShortError(byte_counter, int(data_len))
798 self.try_rename(tmpfilename, filename)
800 # Update file modification time
801 if self.params.get('updatetime', True):
802 info_dict['filetime'] = self.try_utime(filename, data.info().get('last-modified', None))
804 self._hook_progress({
805 'downloaded_bytes': byte_counter,
806 'total_bytes': byte_counter,
807 'filename': filename,
808 'status': 'finished',
813 def _hook_progress(self, status):
814 for ph in self._progress_hooks:
817 def add_progress_hook(self, ph):
818 """ ph gets called on download progress, with a dictionary with the entries
819 * filename: The final filename
820 * status: One of "downloading" and "finished"
822 It can also have some of the following entries:
824 * downloaded_bytes: Bytes on disks
825 * total_bytes: Total bytes, None if unknown
826 * tmpfilename: The filename we're currently writing to
828 Hooks are guaranteed to be called at least once (with status "finished")
829 if the download is successful.
831 self._progress_hooks.append(ph)