[downloader/http] Simplify
[youtube-dl] / youtube_dl / downloader / http.py
1 from __future__ import unicode_literals
2
3 import errno
4 import os
5 import socket
6 import time
7 import re
8
9 from .common import FileDownloader
10 from ..compat import (
11     compat_urllib_request,
12     compat_urllib_error,
13 )
14 from ..utils import (
15     ContentTooShortError,
16     encodeFilename,
17     sanitize_open,
18 )
19
20
21 class HttpFD(FileDownloader):
22     def real_download(self, filename, info_dict):
23         url = info_dict['url']
24         tmpfilename = self.temp_name(filename)
25         stream = None
26
27         # Do not include the Accept-Encoding header
28         headers = {'Youtubedl-no-compression': 'True'}
29         add_headers = info_dict.get('http_headers')
30         if add_headers:
31             headers.update(add_headers)
32         basic_request = compat_urllib_request.Request(url, None, headers)
33         request = compat_urllib_request.Request(url, None, headers)
34
35         is_test = self.params.get('test', False)
36
37         if is_test:
38             request.add_header('Range', 'bytes=0-%s' % str(self._TEST_FILE_SIZE - 1))
39
40         # Establish possible resume length
41         if os.path.isfile(encodeFilename(tmpfilename)):
42             resume_len = os.path.getsize(encodeFilename(tmpfilename))
43         else:
44             resume_len = 0
45
46         open_mode = 'wb'
47         if resume_len != 0:
48             if self.params.get('continuedl', True):
49                 self.report_resuming_byte(resume_len)
50                 request.add_header('Range', 'bytes=%d-' % resume_len)
51                 open_mode = 'ab'
52             else:
53                 resume_len = 0
54
55         count = 0
56         retries = self.params.get('retries', 0)
57         while count <= retries:
58             # Establish connection
59             try:
60                 data = self.ydl.urlopen(request)
61                 if resume_len > 0:
62                     content_range = data.headers.get('Content-Range')
63                     if content_range:
64                         content_range_m = re.search(r'bytes (\d+)-', content_range)
65                         # Content-Range is correct - go on
66                     if content_range_m and resume_len == int(content_range_m.group(1)):
67                         break
68                     # Content-Range is invalid - wipe the file and do entire redownload
69                     resume_len = 0
70                     open_mode = 'wb'
71                 break
72             except (compat_urllib_error.HTTPError, ) as err:
73                 if (err.code < 500 or err.code >= 600) and err.code != 416:
74                     # Unexpected HTTP error
75                     raise
76                 elif err.code == 416:
77                     # Unable to resume (requested range not satisfiable)
78                     try:
79                         # Open the connection again without the range header
80                         data = self.ydl.urlopen(basic_request)
81                         content_length = data.info()['Content-Length']
82                     except (compat_urllib_error.HTTPError, ) as err:
83                         if err.code < 500 or err.code >= 600:
84                             raise
85                     else:
86                         # Examine the reported length
87                         if (content_length is not None and
88                                 (resume_len - 100 < int(content_length) < resume_len + 100)):
89                             # The file had already been fully downloaded.
90                             # Explanation to the above condition: in issue #175 it was revealed that
91                             # YouTube sometimes adds or removes a few bytes from the end of the file,
92                             # changing the file size slightly and causing problems for some users. So
93                             # I decided to implement a suggested change and consider the file
94                             # completely downloaded if the file size differs less than 100 bytes from
95                             # the one in the hard drive.
96                             self.report_file_already_downloaded(filename)
97                             self.try_rename(tmpfilename, filename)
98                             self._hook_progress({
99                                 'filename': filename,
100                                 'status': 'finished',
101                                 'downloaded_bytes': resume_len,
102                                 'total_bytes': resume_len,
103                             })
104                             return True
105                         else:
106                             # The length does not match, we start the download over
107                             self.report_unable_to_resume()
108                             resume_len = 0
109                             open_mode = 'wb'
110                             break
111             except socket.error as e:
112                 if e.errno != errno.ECONNRESET:
113                     # Connection reset is no problem, just retry
114                     raise
115
116             # Retry
117             count += 1
118             if count <= retries:
119                 self.report_retry(count, retries)
120
121         if count > retries:
122             self.report_error('giving up after %s retries' % retries)
123             return False
124
125         data_len = data.info().get('Content-length', None)
126
127         # Range HTTP header may be ignored/unsupported by a webserver
128         # (e.g. extractor/scivee.py, extractor/bambuser.py).
129         # However, for a test we still would like to download just a piece of a file.
130         # To achieve this we limit data_len to _TEST_FILE_SIZE and manually control
131         # block size when downloading a file.
132         if is_test and (data_len is None or int(data_len) > self._TEST_FILE_SIZE):
133             data_len = self._TEST_FILE_SIZE
134
135         if data_len is not None:
136             data_len = int(data_len) + resume_len
137             min_data_len = self.params.get("min_filesize", None)
138             max_data_len = self.params.get("max_filesize", None)
139             if min_data_len is not None and data_len < min_data_len:
140                 self.to_screen('\r[download] File is smaller than min-filesize (%s bytes < %s bytes). Aborting.' % (data_len, min_data_len))
141                 return False
142             if max_data_len is not None and data_len > max_data_len:
143                 self.to_screen('\r[download] File is larger than max-filesize (%s bytes > %s bytes). Aborting.' % (data_len, max_data_len))
144                 return False
145
146         byte_counter = 0 + resume_len
147         block_size = self.params.get('buffersize', 1024)
148         start = time.time()
149
150         # measure time over whole while-loop, so slow_down() and best_block_size() work together properly
151         now = None  # needed for slow_down() in the first loop run
152         before = start  # start measuring
153         while True:
154
155             # Download and write
156             data_block = data.read(block_size if not is_test else min(block_size, data_len - byte_counter))
157             byte_counter += len(data_block)
158
159             # exit loop when download is finished
160             if len(data_block) == 0:
161                 break
162
163             # Open destination file just in time
164             if stream is None:
165                 try:
166                     (stream, tmpfilename) = sanitize_open(tmpfilename, open_mode)
167                     assert stream is not None
168                     filename = self.undo_temp_name(tmpfilename)
169                     self.report_destination(filename)
170                 except (OSError, IOError) as err:
171                     self.report_error('unable to open for writing: %s' % str(err))
172                     return False
173
174                 if self.params.get('xattr_set_filesize', False) and data_len is not None:
175                     try:
176                         import xattr
177                         xattr.setxattr(tmpfilename, 'user.ytdl.filesize', str(data_len))
178                     except(OSError, IOError, ImportError) as err:
179                         self.report_error('unable to set filesize xattr: %s' % str(err))
180
181             try:
182                 stream.write(data_block)
183             except (IOError, OSError) as err:
184                 self.to_stderr('\n')
185                 self.report_error('unable to write data: %s' % str(err))
186                 return False
187
188             # Apply rate limit
189             self.slow_down(start, now, byte_counter - resume_len)
190
191             # end measuring of one loop run
192             now = time.time()
193             after = now
194
195             # Adjust block size
196             if not self.params.get('noresizebuffer', False):
197                 block_size = self.best_block_size(after - before, len(data_block))
198
199             before = after
200
201             # Progress message
202             speed = self.calc_speed(start, now, byte_counter - resume_len)
203             if data_len is None:
204                 eta = None
205             else:
206                 eta = self.calc_eta(start, time.time(), data_len - resume_len, byte_counter - resume_len)
207
208             self._hook_progress({
209                 'status': 'downloading',
210                 'downloaded_bytes': byte_counter,
211                 'total_bytes': data_len,
212                 'tmpfilename': tmpfilename,
213                 'filename': filename,
214                 'eta': eta,
215                 'speed': speed,
216                 'elapsed': now - start,
217             })
218
219             if is_test and byte_counter == data_len:
220                 break
221
222         if stream is None:
223             self.to_stderr('\n')
224             self.report_error('Did not get any data blocks')
225             return False
226         if tmpfilename != '-':
227             stream.close()
228
229         if data_len is not None and byte_counter != data_len:
230             raise ContentTooShortError(byte_counter, int(data_len))
231         self.try_rename(tmpfilename, filename)
232
233         # Update file modification time
234         if self.params.get('updatetime', True):
235             info_dict['filetime'] = self.try_utime(filename, data.info().get('last-modified', None))
236
237         self._hook_progress({
238             'downloaded_bytes': byte_counter,
239             'total_bytes': byte_counter,
240             'filename': filename,
241             'status': 'finished',
242             'elapsed': time.time() - start,
243         })
244
245         return True