a7f3e106434fdcb486a8db63b7e886dd36cc1a09
[youtube-dl] / youtube_dl / FileDownloader.py
1 #!/usr/bin/env python
2 # -*- coding: utf-8 -*-
3
4 from __future__ import absolute_import
5
6 import math
7 import io
8 import os
9 import re
10 import socket
11 import subprocess
12 import sys
13 import time
14 import traceback
15
16 if os.name == 'nt':
17     import ctypes
18
19 from .utils import *
20
21
22 class FileDownloader(object):
23     """File Downloader class.
24
25     File downloader objects are the ones responsible of downloading the
26     actual video file and writing it to disk if the user has requested
27     it, among some other tasks. In most cases there should be one per
28     program. As, given a video URL, the downloader doesn't know how to
29     extract all the needed information, task that InfoExtractors do, it
30     has to pass the URL to one of them.
31
32     For this, file downloader objects have a method that allows
33     InfoExtractors to be registered in a given order. When it is passed
34     a URL, the file downloader handles it to the first InfoExtractor it
35     finds that reports being able to handle it. The InfoExtractor extracts
36     all the information about the video or videos the URL refers to, and
37     asks the FileDownloader to process the video information, possibly
38     downloading the video.
39
40     File downloaders accept a lot of parameters. In order not to saturate
41     the object constructor with arguments, it receives a dictionary of
42     options instead. These options are available through the params
43     attribute for the InfoExtractors to use. The FileDownloader also
44     registers itself as the downloader in charge for the InfoExtractors
45     that are added to it, so this is a "mutual registration".
46
47     Available options:
48
49     username:          Username for authentication purposes.
50     password:          Password for authentication purposes.
51     usenetrc:          Use netrc for authentication instead.
52     quiet:             Do not print messages to stdout.
53     forceurl:          Force printing final URL.
54     forcetitle:        Force printing title.
55     forcethumbnail:    Force printing thumbnail URL.
56     forcedescription:  Force printing description.
57     forcefilename:     Force printing final filename.
58     simulate:          Do not download the video files.
59     format:            Video format code.
60     format_limit:      Highest quality format to try.
61     outtmpl:           Template for output names.
62     restrictfilenames: Do not allow "&" and spaces in file names
63     ignoreerrors:      Do not stop on download errors.
64     ratelimit:         Download speed limit, in bytes/sec.
65     nooverwrites:      Prevent overwriting files.
66     retries:           Number of times to retry for HTTP error 5xx
67     buffersize:        Size of download buffer in bytes.
68     noresizebuffer:    Do not automatically resize the download buffer.
69     continuedl:        Try to continue downloads if possible.
70     noprogress:        Do not print the progress bar.
71     playliststart:     Playlist item to start at.
72     playlistend:       Playlist item to end at.
73     matchtitle:        Download only matching titles.
74     rejecttitle:       Reject downloads for matching titles.
75     logtostderr:       Log messages to stderr instead of stdout.
76     consoletitle:      Display progress in console window's titlebar.
77     nopart:            Do not use temporary .part files.
78     updatetime:        Use the Last-modified header to set output file timestamps.
79     writedescription:  Write the video description to a .description file
80     writeinfojson:     Write the video description to a .info.json file
81     writesubtitles:    Write the video subtitles to a .srt file
82     subtitleslang:     Language of the subtitles to download
83     test:              Download only first bytes to test the downloader.
84     """
85
86     params = None
87     _ies = []
88     _pps = []
89     _download_retcode = None
90     _num_downloads = None
91     _screen_file = None
92
93     def __init__(self, params):
94         """Create a FileDownloader object with the given options."""
95         self._ies = []
96         self._pps = []
97         self._download_retcode = 0
98         self._num_downloads = 0
99         self._screen_file = [sys.stdout, sys.stderr][params.get('logtostderr', False)]
100         self.params = params
101
102         if '%(stitle)s' in self.params['outtmpl']:
103             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.')
104
105     @staticmethod
106     def format_bytes(bytes):
107         if bytes is None:
108             return 'N/A'
109         if type(bytes) is str:
110             bytes = float(bytes)
111         if bytes == 0.0:
112             exponent = 0
113         else:
114             exponent = int(math.log(bytes, 1024.0))
115         suffix = 'bkMGTPEZY'[exponent]
116         converted = float(bytes) / float(1024 ** exponent)
117         return '%.2f%s' % (converted, suffix)
118
119     @staticmethod
120     def calc_percent(byte_counter, data_len):
121         if data_len is None:
122             return '---.-%'
123         return '%6s' % ('%3.1f%%' % (float(byte_counter) / float(data_len) * 100.0))
124
125     @staticmethod
126     def calc_eta(start, now, total, current):
127         if total is None:
128             return '--:--'
129         dif = now - start
130         if current == 0 or dif < 0.001: # One millisecond
131             return '--:--'
132         rate = float(current) / dif
133         eta = int((float(total) - float(current)) / rate)
134         (eta_mins, eta_secs) = divmod(eta, 60)
135         if eta_mins > 99:
136             return '--:--'
137         return '%02d:%02d' % (eta_mins, eta_secs)
138
139     @staticmethod
140     def calc_speed(start, now, bytes):
141         dif = now - start
142         if bytes == 0 or dif < 0.001: # One millisecond
143             return '%10s' % '---b/s'
144         return '%10s' % ('%s/s' % FileDownloader.format_bytes(float(bytes) / dif))
145
146     @staticmethod
147     def best_block_size(elapsed_time, bytes):
148         new_min = max(bytes / 2.0, 1.0)
149         new_max = min(max(bytes * 2.0, 1.0), 4194304) # Do not surpass 4 MB
150         if elapsed_time < 0.001:
151             return int(new_max)
152         rate = bytes / elapsed_time
153         if rate > new_max:
154             return int(new_max)
155         if rate < new_min:
156             return int(new_min)
157         return int(rate)
158
159     @staticmethod
160     def parse_bytes(bytestr):
161         """Parse a string indicating a byte quantity into an integer."""
162         matchobj = re.match(r'(?i)^(\d+(?:\.\d+)?)([kMGTPEZY]?)$', bytestr)
163         if matchobj is None:
164             return None
165         number = float(matchobj.group(1))
166         multiplier = 1024.0 ** 'bkmgtpezy'.index(matchobj.group(2).lower())
167         return int(round(number * multiplier))
168
169     def add_info_extractor(self, ie):
170         """Add an InfoExtractor object to the end of the list."""
171         self._ies.append(ie)
172         ie.set_downloader(self)
173
174     def add_post_processor(self, pp):
175         """Add a PostProcessor object to the end of the chain."""
176         self._pps.append(pp)
177         pp.set_downloader(self)
178
179     def to_screen(self, message, skip_eol=False):
180         """Print message to stdout if not in quiet mode."""
181         assert type(message) == type(u'')
182         if not self.params.get('quiet', False):
183             terminator = [u'\n', u''][skip_eol]
184             output = message + terminator
185             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
186                 output = output.encode(preferredencoding(), 'ignore')
187             self._screen_file.write(output)
188             self._screen_file.flush()
189
190     def to_stderr(self, message):
191         """Print message to stderr."""
192         assert type(message) == type(u'')
193         output = message + u'\n'
194         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
195             output = output.encode(preferredencoding())
196         sys.stderr.write(output)
197
198     def to_cons_title(self, message):
199         """Set console/terminal window title to message."""
200         if not self.params.get('consoletitle', False):
201             return
202         if os.name == 'nt' and ctypes.windll.kernel32.GetConsoleWindow():
203             # c_wchar_p() might not be necessary if `message` is
204             # already of type unicode()
205             ctypes.windll.kernel32.SetConsoleTitleW(ctypes.c_wchar_p(message))
206         elif 'TERM' in os.environ:
207             sys.stderr.write('\033]0;%s\007' % message.encode(preferredencoding()))
208
209     def fixed_template(self):
210         """Checks if the output template is fixed."""
211         return (re.search(u'(?u)%\\(.+?\\)s', self.params['outtmpl']) is None)
212
213     def trouble(self, message=None):
214         """Determine action to take when a download problem appears.
215
216         Depending on if the downloader has been configured to ignore
217         download errors or not, this method may throw an exception or
218         not when errors are found, after printing the message.
219         """
220         if message is not None:
221             self.to_stderr(message)
222         if self.params.get('verbose'):
223             self.to_stderr(u''.join(traceback.format_list(traceback.extract_stack())))
224         if not self.params.get('ignoreerrors', False):
225             raise DownloadError(message)
226         self._download_retcode = 1
227
228     def slow_down(self, start_time, byte_counter):
229         """Sleep if the download speed is over the rate limit."""
230         rate_limit = self.params.get('ratelimit', None)
231         if rate_limit is None or byte_counter == 0:
232             return
233         now = time.time()
234         elapsed = now - start_time
235         if elapsed <= 0.0:
236             return
237         speed = float(byte_counter) / elapsed
238         if speed > rate_limit:
239             time.sleep((byte_counter - rate_limit * (now - start_time)) / rate_limit)
240
241     def temp_name(self, filename):
242         """Returns a temporary filename for the given filename."""
243         if self.params.get('nopart', False) or filename == u'-' or \
244                 (os.path.exists(encodeFilename(filename)) and not os.path.isfile(encodeFilename(filename))):
245             return filename
246         return filename + u'.part'
247
248     def undo_temp_name(self, filename):
249         if filename.endswith(u'.part'):
250             return filename[:-len(u'.part')]
251         return filename
252
253     def try_rename(self, old_filename, new_filename):
254         try:
255             if old_filename == new_filename:
256                 return
257             os.rename(encodeFilename(old_filename), encodeFilename(new_filename))
258         except (IOError, OSError) as err:
259             self.trouble(u'ERROR: unable to rename file')
260
261     def try_utime(self, filename, last_modified_hdr):
262         """Try to set the last-modified time of the given file."""
263         if last_modified_hdr is None:
264             return
265         if not os.path.isfile(encodeFilename(filename)):
266             return
267         timestr = last_modified_hdr
268         if timestr is None:
269             return
270         filetime = timeconvert(timestr)
271         if filetime is None:
272             return filetime
273         try:
274             os.utime(filename, (time.time(), filetime))
275         except:
276             pass
277         return filetime
278
279     def report_writedescription(self, descfn):
280         """ Report that the description file is being written """
281         self.to_screen(u'[info] Writing video description to: ' + descfn)
282
283     def report_writesubtitles(self, srtfn):
284         """ Report that the subtitles file is being written """
285         self.to_screen(u'[info] Writing video subtitles to: ' + srtfn)
286
287     def report_writeinfojson(self, infofn):
288         """ Report that the metadata file has been written """
289         self.to_screen(u'[info] Video description metadata as JSON to: ' + infofn)
290
291     def report_destination(self, filename):
292         """Report destination filename."""
293         self.to_screen(u'[download] Destination: ' + filename)
294
295     def report_progress(self, percent_str, data_len_str, speed_str, eta_str):
296         """Report download progress."""
297         if self.params.get('noprogress', False):
298             return
299         self.to_screen(u'\r[download] %s of %s at %s ETA %s' %
300                 (percent_str, data_len_str, speed_str, eta_str), skip_eol=True)
301         self.to_cons_title(u'youtube-dl - %s of %s at %s ETA %s' %
302                 (percent_str.strip(), data_len_str.strip(), speed_str.strip(), eta_str.strip()))
303
304     def report_resuming_byte(self, resume_len):
305         """Report attempt to resume at given byte."""
306         self.to_screen(u'[download] Resuming download at byte %s' % resume_len)
307
308     def report_retry(self, count, retries):
309         """Report retry in case of HTTP error 5xx"""
310         self.to_screen(u'[download] Got server HTTP error. Retrying (attempt %d of %d)...' % (count, retries))
311
312     def report_file_already_downloaded(self, file_name):
313         """Report file has already been fully downloaded."""
314         try:
315             self.to_screen(u'[download] %s has already been downloaded' % file_name)
316         except (UnicodeEncodeError) as err:
317             self.to_screen(u'[download] The file has already been downloaded')
318
319     def report_unable_to_resume(self):
320         """Report it was impossible to resume download."""
321         self.to_screen(u'[download] Unable to resume')
322
323     def report_finish(self):
324         """Report download finished."""
325         if self.params.get('noprogress', False):
326             self.to_screen(u'[download] Download completed')
327         else:
328             self.to_screen(u'')
329
330     def increment_downloads(self):
331         """Increment the ordinal that assigns a number to each file."""
332         self._num_downloads += 1
333
334     def prepare_filename(self, info_dict):
335         """Generate the output filename."""
336         try:
337             template_dict = dict(info_dict)
338
339             template_dict['epoch'] = int(time.time())
340             template_dict['autonumber'] = u'%05d' % self._num_downloads
341
342             sanitize = lambda k,v: sanitize_filename(
343                 u'NA' if v is None else compat_str(v),
344                 restricted=self.params.get('restrictfilenames'),
345                 is_id=(k==u'id'))
346             template_dict = dict((k, sanitize(k, v)) for k,v in template_dict.items())
347
348             filename = self.params['outtmpl'] % template_dict
349             return filename
350         except (ValueError, KeyError) as err:
351             self.trouble(u'ERROR: invalid system charset or erroneous output template')
352             return None
353
354     def _match_entry(self, info_dict):
355         """ Returns None iff the file should be downloaded """
356
357         title = info_dict['title']
358         matchtitle = self.params.get('matchtitle', False)
359         if matchtitle:
360             matchtitle = matchtitle.decode('utf8')
361             if not re.search(matchtitle, title, re.IGNORECASE):
362                 return u'[download] "' + title + '" title did not match pattern "' + matchtitle + '"'
363         rejecttitle = self.params.get('rejecttitle', False)
364         if rejecttitle:
365             rejecttitle = rejecttitle.decode('utf8')
366             if re.search(rejecttitle, title, re.IGNORECASE):
367                 return u'"' + title + '" title matched reject pattern "' + rejecttitle + '"'
368         return None
369
370     def process_info(self, info_dict):
371         """Process a single dictionary returned by an InfoExtractor."""
372
373         # Keep for backwards compatibility
374         info_dict['stitle'] = info_dict['title']
375
376         if not 'format' in info_dict:
377             info_dict['format'] = info_dict['ext']
378
379         reason = self._match_entry(info_dict)
380         if reason is not None:
381             self.to_screen(u'[download] ' + reason)
382             return
383
384         max_downloads = self.params.get('max_downloads')
385         if max_downloads is not None:
386             if self._num_downloads > int(max_downloads):
387                 raise MaxDownloadsReached()
388
389         filename = self.prepare_filename(info_dict)
390
391         # Forced printings
392         if self.params.get('forcetitle', False):
393             compat_print(info_dict['title'])
394         if self.params.get('forceurl', False):
395             compat_print(info_dict['url'])
396         if self.params.get('forcethumbnail', False) and 'thumbnail' in info_dict:
397             compat_print(info_dict['thumbnail'])
398         if self.params.get('forcedescription', False) and 'description' in info_dict:
399             compat_print(info_dict['description'])
400         if self.params.get('forcefilename', False) and filename is not None:
401             compat_print(filename)
402         if self.params.get('forceformat', False):
403             compat_print(info_dict['format'])
404
405         # Do nothing else if in simulate mode
406         if self.params.get('simulate', False):
407             return
408
409         if filename is None:
410             return
411
412         try:
413             dn = os.path.dirname(encodeFilename(filename))
414             if dn != '' and not os.path.exists(dn): # dn is already encoded
415                 os.makedirs(dn)
416         except (OSError, IOError) as err:
417             self.trouble(u'ERROR: unable to create directory ' + compat_str(err))
418             return
419
420         if self.params.get('writedescription', False):
421             try:
422                 descfn = filename + u'.description'
423                 self.report_writedescription(descfn)
424                 descfile = open(encodeFilename(descfn), 'wb')
425                 try:
426                     descfile.write(info_dict['description'].encode('utf-8'))
427                 finally:
428                     descfile.close()
429             except (OSError, IOError):
430                 self.trouble(u'ERROR: Cannot write description file ' + descfn)
431                 return
432
433         if self.params.get('writesubtitles', False) and 'subtitles' in info_dict and info_dict['subtitles']:
434             # subtitles download errors are already managed as troubles in relevant IE
435             # that way it will silently go on when used with unsupporting IE
436             try:
437                 srtfn = filename.rsplit('.', 1)[0] + u'.srt'
438                 self.report_writesubtitles(srtfn)
439                 srtfile = open(encodeFilename(srtfn), 'wb')
440                 try:
441                     srtfile.write(info_dict['subtitles'].encode('utf-8'))
442                 finally:
443                     srtfile.close()
444             except (OSError, IOError):
445                 self.trouble(u'ERROR: Cannot write subtitles file ' + descfn)
446                 return
447
448         if self.params.get('writeinfojson', False):
449             infofn = filename + u'.info.json'
450             self.report_writeinfojson(infofn)
451             try:
452                 json_info_dict = dict((k, v) for k,v in info_dict.items() if not k in ['urlhandle'])
453                 write_json_file(json_info_dict, encodeFilename(infofn))
454             except (OSError, IOError):
455                 self.trouble(u'ERROR: Cannot write metadata to JSON file ' + infofn)
456                 return
457
458         if not self.params.get('skip_download', False):
459             if self.params.get('nooverwrites', False) and os.path.exists(encodeFilename(filename)):
460                 success = True
461             else:
462                 try:
463                     success = self._do_download(filename, info_dict)
464                 except (OSError, IOError) as err:
465                     raise UnavailableVideoError()
466                 except (compat_urllib_error.URLError, compat_http_client.HTTPException, socket.error) as err:
467                     self.trouble(u'ERROR: unable to download video data: %s' % str(err))
468                     return
469                 except (ContentTooShortError, ) as err:
470                     self.trouble(u'ERROR: content too short (expected %s bytes and served %s)' % (err.expected, err.downloaded))
471                     return
472
473             if success:
474                 try:
475                     self.post_process(filename, info_dict)
476                 except (PostProcessingError) as err:
477                     self.trouble(u'ERROR: postprocessing: %s' % str(err))
478                     return
479
480     def download(self, url_list):
481         """Download a given list of URLs."""
482         if len(url_list) > 1 and self.fixed_template():
483             raise SameFileError(self.params['outtmpl'])
484
485         for url in url_list:
486             suitable_found = False
487             for ie in self._ies:
488                 # Go to next InfoExtractor if not suitable
489                 if not ie.suitable(url):
490                     continue
491
492                 # Warn if the _WORKING attribute is False
493                 if not ie.working():
494                     self.trouble(u'WARNING: the program functionality for this site has been marked as broken, '
495                                  u'and will probably not work. If you want to go on, use the -i option.')
496
497                 # Suitable InfoExtractor found
498                 suitable_found = True
499
500                 # Extract information from URL and process it
501                 videos = ie.extract(url)
502                 for video in videos or []:
503                     video['extractor'] = ie.IE_NAME
504                     try:
505                         self.increment_downloads()
506                         self.process_info(video)
507                     except UnavailableVideoError:
508                         self.trouble(u'\nERROR: unable to download video')
509
510                 # Suitable InfoExtractor had been found; go to next URL
511                 break
512
513             if not suitable_found:
514                 self.trouble(u'ERROR: no suitable InfoExtractor: %s' % url)
515
516         return self._download_retcode
517
518     def post_process(self, filename, ie_info):
519         """Run the postprocessing chain on the given file."""
520         info = dict(ie_info)
521         info['filepath'] = filename
522         for pp in self._pps:
523             info = pp.run(info)
524             if info is None:
525                 break
526
527     def _download_with_rtmpdump(self, filename, url, player_url):
528         self.report_destination(filename)
529         tmpfilename = self.temp_name(filename)
530
531         # Check for rtmpdump first
532         try:
533             subprocess.call(['rtmpdump', '-h'], stdout=(file(os.path.devnull, 'w')), stderr=subprocess.STDOUT)
534         except (OSError, IOError):
535             self.trouble(u'ERROR: RTMP download detected but "rtmpdump" could not be run')
536             return False
537
538         # Download using rtmpdump. rtmpdump returns exit code 2 when
539         # the connection was interrumpted and resuming appears to be
540         # possible. This is part of rtmpdump's normal usage, AFAIK.
541         basic_args = ['rtmpdump', '-q'] + [[], ['-W', player_url]][player_url is not None] + ['-r', url, '-o', tmpfilename]
542         args = basic_args + [[], ['-e', '-k', '1']][self.params.get('continuedl', False)]
543         if self.params.get('verbose', False):
544             try:
545                 import pipes
546                 shell_quote = lambda args: ' '.join(map(pipes.quote, args))
547             except ImportError:
548                 shell_quote = repr
549             self.to_screen(u'[debug] rtmpdump command line: ' + shell_quote(args))
550         retval = subprocess.call(args)
551         while retval == 2 or retval == 1:
552             prevsize = os.path.getsize(encodeFilename(tmpfilename))
553             self.to_screen(u'\r[rtmpdump] %s bytes' % prevsize, skip_eol=True)
554             time.sleep(5.0) # This seems to be needed
555             retval = subprocess.call(basic_args + ['-e'] + [[], ['-k', '1']][retval == 1])
556             cursize = os.path.getsize(encodeFilename(tmpfilename))
557             if prevsize == cursize and retval == 1:
558                 break
559              # Some rtmp streams seem abort after ~ 99.8%. Don't complain for those
560             if prevsize == cursize and retval == 2 and cursize > 1024:
561                 self.to_screen(u'\r[rtmpdump] Could not download the whole video. This can happen for some advertisements.')
562                 retval = 0
563                 break
564         if retval == 0:
565             self.to_screen(u'\r[rtmpdump] %s bytes' % os.path.getsize(encodeFilename(tmpfilename)))
566             self.try_rename(tmpfilename, filename)
567             return True
568         else:
569             self.trouble(u'\nERROR: rtmpdump exited with code %d' % retval)
570             return False
571
572     def _do_download(self, filename, info_dict):
573         url = info_dict['url']
574         player_url = info_dict.get('player_url', None)
575
576         # Check file already present
577         if self.params.get('continuedl', False) and os.path.isfile(encodeFilename(filename)) and not self.params.get('nopart', False):
578             self.report_file_already_downloaded(filename)
579             return True
580
581         # Attempt to download using rtmpdump
582         if url.startswith('rtmp'):
583             return self._download_with_rtmpdump(filename, url, player_url)
584
585         tmpfilename = self.temp_name(filename)
586         stream = None
587
588         # Do not include the Accept-Encoding header
589         headers = {'Youtubedl-no-compression': 'True'}
590         basic_request = compat_urllib_request.Request(url, None, headers)
591         request = compat_urllib_request.Request(url, None, headers)
592
593         if self.params.get('test', False):
594             request.add_header('Range','bytes=0-10240')
595
596         # Establish possible resume length
597         if os.path.isfile(encodeFilename(tmpfilename)):
598             resume_len = os.path.getsize(encodeFilename(tmpfilename))
599         else:
600             resume_len = 0
601
602         open_mode = 'wb'
603         if resume_len != 0:
604             if self.params.get('continuedl', False):
605                 self.report_resuming_byte(resume_len)
606                 request.add_header('Range','bytes=%d-' % resume_len)
607                 open_mode = 'ab'
608             else:
609                 resume_len = 0
610
611         count = 0
612         retries = self.params.get('retries', 0)
613         while count <= retries:
614             # Establish connection
615             try:
616                 if count == 0 and 'urlhandle' in info_dict:
617                     data = info_dict['urlhandle']
618                 data = compat_urllib_request.urlopen(request)
619                 break
620             except (compat_urllib_error.HTTPError, ) as err:
621                 if (err.code < 500 or err.code >= 600) and err.code != 416:
622                     # Unexpected HTTP error
623                     raise
624                 elif err.code == 416:
625                     # Unable to resume (requested range not satisfiable)
626                     try:
627                         # Open the connection again without the range header
628                         data = compat_urllib_request.urlopen(basic_request)
629                         content_length = data.info()['Content-Length']
630                     except (compat_urllib_error.HTTPError, ) as err:
631                         if err.code < 500 or err.code >= 600:
632                             raise
633                     else:
634                         # Examine the reported length
635                         if (content_length is not None and
636                                 (resume_len - 100 < int(content_length) < resume_len + 100)):
637                             # The file had already been fully downloaded.
638                             # Explanation to the above condition: in issue #175 it was revealed that
639                             # YouTube sometimes adds or removes a few bytes from the end of the file,
640                             # changing the file size slightly and causing problems for some users. So
641                             # I decided to implement a suggested change and consider the file
642                             # completely downloaded if the file size differs less than 100 bytes from
643                             # the one in the hard drive.
644                             self.report_file_already_downloaded(filename)
645                             self.try_rename(tmpfilename, filename)
646                             return True
647                         else:
648                             # The length does not match, we start the download over
649                             self.report_unable_to_resume()
650                             open_mode = 'wb'
651                             break
652             # Retry
653             count += 1
654             if count <= retries:
655                 self.report_retry(count, retries)
656
657         if count > retries:
658             self.trouble(u'ERROR: giving up after %s retries' % retries)
659             return False
660
661         data_len = data.info().get('Content-length', None)
662         if data_len is not None:
663             data_len = int(data_len) + resume_len
664         data_len_str = self.format_bytes(data_len)
665         byte_counter = 0 + resume_len
666         block_size = self.params.get('buffersize', 1024)
667         start = time.time()
668         while True:
669             # Download and write
670             before = time.time()
671             data_block = data.read(block_size)
672             after = time.time()
673             if len(data_block) == 0:
674                 break
675             byte_counter += len(data_block)
676
677             # Open file just in time
678             if stream is None:
679                 try:
680                     (stream, tmpfilename) = sanitize_open(tmpfilename, open_mode)
681                     assert stream is not None
682                     filename = self.undo_temp_name(tmpfilename)
683                     self.report_destination(filename)
684                 except (OSError, IOError) as err:
685                     self.trouble(u'ERROR: unable to open for writing: %s' % str(err))
686                     return False
687             try:
688                 stream.write(data_block)
689             except (IOError, OSError) as err:
690                 self.trouble(u'\nERROR: unable to write data: %s' % str(err))
691                 return False
692             if not self.params.get('noresizebuffer', False):
693                 block_size = self.best_block_size(after - before, len(data_block))
694
695             # Progress message
696             speed_str = self.calc_speed(start, time.time(), byte_counter - resume_len)
697             if data_len is None:
698                 self.report_progress('Unknown %', data_len_str, speed_str, 'Unknown ETA')
699             else:
700                 percent_str = self.calc_percent(byte_counter, data_len)
701                 eta_str = self.calc_eta(start, time.time(), data_len - resume_len, byte_counter - resume_len)
702                 self.report_progress(percent_str, data_len_str, speed_str, eta_str)
703
704             # Apply rate limit
705             self.slow_down(start, byte_counter - resume_len)
706
707         if stream is None:
708             self.trouble(u'\nERROR: Did not get any data blocks')
709             return False
710         stream.close()
711         self.report_finish()
712         if data_len is not None and byte_counter != data_len:
713             raise ContentTooShortError(byte_counter, int(data_len))
714         self.try_rename(tmpfilename, filename)
715
716         # Update file modification time
717         if self.params.get('updatetime', True):
718             info_dict['filetime'] = self.try_utime(filename, data.info().get('last-modified', None))
719
720         return True