]>
Commit | Line | Data |
---|---|---|
d77c3dfd FV |
1 | #!/usr/bin/env python |
2 | # -*- coding: utf-8 -*- | |
3 | ||
ecc0c5ee PH |
4 | from __future__ import unicode_literals |
5 | ||
912b38b4 | 6 | import calendar |
676eb3f2 | 7 | import codecs |
62e609ab | 8 | import contextlib |
e3946f98 | 9 | import ctypes |
c496ca96 PH |
10 | import datetime |
11 | import email.utils | |
f45c185f | 12 | import errno |
d77c3dfd | 13 | import gzip |
b7ab0590 | 14 | import itertools |
03f9daab | 15 | import io |
f4bfd65f | 16 | import json |
d77c3dfd | 17 | import locale |
02dbf93f | 18 | import math |
d77c3dfd | 19 | import os |
4eb7f1d1 | 20 | import pipes |
c496ca96 | 21 | import platform |
d77c3dfd | 22 | import re |
13ebea79 | 23 | import ssl |
c496ca96 | 24 | import socket |
b53466e1 | 25 | import struct |
1c088fa8 | 26 | import subprocess |
d77c3dfd | 27 | import sys |
181c8655 | 28 | import tempfile |
01951dda | 29 | import traceback |
bcf89ce6 | 30 | import xml.etree.ElementTree |
d77c3dfd | 31 | import zlib |
d77c3dfd | 32 | |
8c25f81b PH |
33 | from .compat import ( |
34 | compat_chr, | |
35 | compat_getenv, | |
36 | compat_html_entities, | |
8c25f81b PH |
37 | compat_parse_qs, |
38 | compat_str, | |
39 | compat_urllib_error, | |
40 | compat_urllib_parse, | |
41 | compat_urllib_parse_urlparse, | |
42 | compat_urllib_request, | |
43 | compat_urlparse, | |
7d4111ed | 44 | shlex_quote, |
8c25f81b | 45 | ) |
4644ac55 S |
46 | |
47 | ||
468e2e92 FV |
48 | # This is not clearly defined otherwise |
49 | compiled_regex_type = type(re.compile('')) | |
50 | ||
3e669f36 | 51 | std_headers = { |
ae8f7871 | 52 | 'User-Agent': 'Mozilla/5.0 (X11; Linux x86_64; rv:10.0) Gecko/20100101 Firefox/10.0 (Chrome)', |
59ae15a5 PH |
53 | 'Accept-Charset': 'ISO-8859-1,utf-8;q=0.7,*;q=0.7', |
54 | 'Accept': 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8', | |
55 | 'Accept-Encoding': 'gzip, deflate', | |
56 | 'Accept-Language': 'en-us,en;q=0.5', | |
3e669f36 | 57 | } |
f427df17 | 58 | |
5f6a1245 | 59 | |
d77c3dfd | 60 | def preferredencoding(): |
59ae15a5 | 61 | """Get preferred encoding. |
d77c3dfd | 62 | |
59ae15a5 PH |
63 | Returns the best encoding scheme for the system, based on |
64 | locale.getpreferredencoding() and some further tweaks. | |
65 | """ | |
66 | try: | |
67 | pref = locale.getpreferredencoding() | |
28e614de | 68 | 'TEST'.encode(pref) |
59ae15a5 PH |
69 | except: |
70 | pref = 'UTF-8' | |
bae611f2 | 71 | |
59ae15a5 | 72 | return pref |
d77c3dfd | 73 | |
f4bfd65f | 74 | |
181c8655 | 75 | def write_json_file(obj, fn): |
1394646a | 76 | """ Encode obj as JSON and write it to fn, atomically if possible """ |
181c8655 | 77 | |
92120217 | 78 | fn = encodeFilename(fn) |
61ee5aeb | 79 | if sys.version_info < (3, 0) and sys.platform != 'win32': |
ec5f6016 JMF |
80 | encoding = get_filesystem_encoding() |
81 | # os.path.basename returns a bytes object, but NamedTemporaryFile | |
82 | # will fail if the filename contains non ascii characters unless we | |
83 | # use a unicode object | |
84 | path_basename = lambda f: os.path.basename(fn).decode(encoding) | |
85 | # the same for os.path.dirname | |
86 | path_dirname = lambda f: os.path.dirname(fn).decode(encoding) | |
87 | else: | |
88 | path_basename = os.path.basename | |
89 | path_dirname = os.path.dirname | |
90 | ||
73159f99 S |
91 | args = { |
92 | 'suffix': '.tmp', | |
ec5f6016 JMF |
93 | 'prefix': path_basename(fn) + '.', |
94 | 'dir': path_dirname(fn), | |
73159f99 S |
95 | 'delete': False, |
96 | } | |
97 | ||
181c8655 PH |
98 | # In Python 2.x, json.dump expects a bytestream. |
99 | # In Python 3.x, it writes to a character stream | |
100 | if sys.version_info < (3, 0): | |
73159f99 | 101 | args['mode'] = 'wb' |
181c8655 | 102 | else: |
73159f99 S |
103 | args.update({ |
104 | 'mode': 'w', | |
105 | 'encoding': 'utf-8', | |
106 | }) | |
107 | ||
108 | tf = tempfile.NamedTemporaryFile(**args) | |
181c8655 PH |
109 | |
110 | try: | |
111 | with tf: | |
112 | json.dump(obj, tf) | |
1394646a IK |
113 | if sys.platform == 'win32': |
114 | # Need to remove existing file on Windows, else os.rename raises | |
115 | # WindowsError or FileExistsError. | |
116 | try: | |
117 | os.unlink(fn) | |
118 | except OSError: | |
119 | pass | |
181c8655 PH |
120 | os.rename(tf.name, fn) |
121 | except: | |
122 | try: | |
123 | os.remove(tf.name) | |
124 | except OSError: | |
125 | pass | |
126 | raise | |
127 | ||
128 | ||
129 | if sys.version_info >= (2, 7): | |
59ae56fa PH |
130 | def find_xpath_attr(node, xpath, key, val): |
131 | """ Find the xpath xpath[@key=val] """ | |
cbf915f3 PH |
132 | assert re.match(r'^[a-zA-Z-]+$', key) |
133 | assert re.match(r'^[a-zA-Z0-9@\s:._-]*$', val) | |
59ae56fa PH |
134 | expr = xpath + u"[@%s='%s']" % (key, val) |
135 | return node.find(expr) | |
136 | else: | |
137 | def find_xpath_attr(node, xpath, key, val): | |
4eefbfdb PH |
138 | # Here comes the crazy part: In 2.6, if the xpath is a unicode, |
139 | # .//node does not match if a node is a direct child of . ! | |
140 | if isinstance(xpath, unicode): | |
141 | xpath = xpath.encode('ascii') | |
142 | ||
59ae56fa PH |
143 | for f in node.findall(xpath): |
144 | if f.attrib.get(key) == val: | |
145 | return f | |
146 | return None | |
147 | ||
d7e66d39 JMF |
148 | # On python2.6 the xml.etree.ElementTree.Element methods don't support |
149 | # the namespace parameter | |
5f6a1245 JW |
150 | |
151 | ||
d7e66d39 JMF |
152 | def xpath_with_ns(path, ns_map): |
153 | components = [c.split(':') for c in path.split('/')] | |
154 | replaced = [] | |
155 | for c in components: | |
156 | if len(c) == 1: | |
157 | replaced.append(c[0]) | |
158 | else: | |
159 | ns, tag = c | |
160 | replaced.append('{%s}%s' % (ns_map[ns], tag)) | |
161 | return '/'.join(replaced) | |
162 | ||
d77c3dfd | 163 | |
bf0ff932 | 164 | def xpath_text(node, xpath, name=None, fatal=False): |
d74bebd5 PH |
165 | if sys.version_info < (2, 7): # Crazy 2.6 |
166 | xpath = xpath.encode('ascii') | |
167 | ||
bf0ff932 PH |
168 | n = node.find(xpath) |
169 | if n is None: | |
170 | if fatal: | |
171 | name = xpath if name is None else name | |
172 | raise ExtractorError('Could not find XML element %s' % name) | |
173 | else: | |
174 | return None | |
175 | return n.text | |
176 | ||
177 | ||
9e6dd238 | 178 | def get_element_by_id(id, html): |
43e8fafd ND |
179 | """Return the content of the tag with the specified ID in the passed HTML document""" |
180 | return get_element_by_attribute("id", id, html) | |
181 | ||
12ea2f30 | 182 | |
43e8fafd ND |
183 | def get_element_by_attribute(attribute, value, html): |
184 | """Return the content of the tag with the specified attribute in the passed HTML document""" | |
9e6dd238 | 185 | |
38285056 PH |
186 | m = re.search(r'''(?xs) |
187 | <([a-zA-Z0-9:._-]+) | |
188 | (?:\s+[a-zA-Z0-9:._-]+(?:=[a-zA-Z0-9:._-]+|="[^"]+"|='[^']+'))*? | |
189 | \s+%s=['"]?%s['"]? | |
190 | (?:\s+[a-zA-Z0-9:._-]+(?:=[a-zA-Z0-9:._-]+|="[^"]+"|='[^']+'))*? | |
191 | \s*> | |
192 | (?P<content>.*?) | |
193 | </\1> | |
194 | ''' % (re.escape(attribute), re.escape(value)), html) | |
195 | ||
196 | if not m: | |
197 | return None | |
198 | res = m.group('content') | |
199 | ||
200 | if res.startswith('"') or res.startswith("'"): | |
201 | res = res[1:-1] | |
a921f407 | 202 | |
38285056 | 203 | return unescapeHTML(res) |
a921f407 | 204 | |
9e6dd238 FV |
205 | |
206 | def clean_html(html): | |
59ae15a5 PH |
207 | """Clean an HTML snippet into a readable string""" |
208 | # Newline vs <br /> | |
209 | html = html.replace('\n', ' ') | |
6b3aef80 FV |
210 | html = re.sub(r'\s*<\s*br\s*/?\s*>\s*', '\n', html) |
211 | html = re.sub(r'<\s*/\s*p\s*>\s*<\s*p[^>]*>', '\n', html) | |
59ae15a5 PH |
212 | # Strip html tags |
213 | html = re.sub('<.*?>', '', html) | |
214 | # Replace html entities | |
215 | html = unescapeHTML(html) | |
7decf895 | 216 | return html.strip() |
9e6dd238 FV |
217 | |
218 | ||
d77c3dfd | 219 | def sanitize_open(filename, open_mode): |
59ae15a5 PH |
220 | """Try to open the given filename, and slightly tweak it if this fails. |
221 | ||
222 | Attempts to open the given filename. If this fails, it tries to change | |
223 | the filename slightly, step by step, until it's either able to open it | |
224 | or it fails and raises a final exception, like the standard open() | |
225 | function. | |
226 | ||
227 | It returns the tuple (stream, definitive_file_name). | |
228 | """ | |
229 | try: | |
28e614de | 230 | if filename == '-': |
59ae15a5 PH |
231 | if sys.platform == 'win32': |
232 | import msvcrt | |
233 | msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY) | |
898280a0 | 234 | return (sys.stdout.buffer if hasattr(sys.stdout, 'buffer') else sys.stdout, filename) |
59ae15a5 PH |
235 | stream = open(encodeFilename(filename), open_mode) |
236 | return (stream, filename) | |
237 | except (IOError, OSError) as err: | |
f45c185f PH |
238 | if err.errno in (errno.EACCES,): |
239 | raise | |
59ae15a5 | 240 | |
f45c185f PH |
241 | # In case of error, try to remove win32 forbidden chars |
242 | alt_filename = os.path.join( | |
b74e86f4 PH |
243 | re.sub('[/<>:"\\|\\\\?\\*]', '#', path_part) |
244 | for path_part in os.path.split(filename) | |
245 | ) | |
f45c185f PH |
246 | if alt_filename == filename: |
247 | raise | |
248 | else: | |
249 | # An exception here should be caught in the caller | |
250 | stream = open(encodeFilename(filename), open_mode) | |
251 | return (stream, alt_filename) | |
d77c3dfd FV |
252 | |
253 | ||
254 | def timeconvert(timestr): | |
59ae15a5 PH |
255 | """Convert RFC 2822 defined time string into system timestamp""" |
256 | timestamp = None | |
257 | timetuple = email.utils.parsedate_tz(timestr) | |
258 | if timetuple is not None: | |
259 | timestamp = email.utils.mktime_tz(timetuple) | |
260 | return timestamp | |
1c469a94 | 261 | |
5f6a1245 | 262 | |
796173d0 | 263 | def sanitize_filename(s, restricted=False, is_id=False): |
59ae15a5 PH |
264 | """Sanitizes a string so it could be used as part of a filename. |
265 | If restricted is set, use a stricter subset of allowed characters. | |
796173d0 | 266 | Set is_id if this is not an arbitrary string, but an ID that should be kept if possible |
59ae15a5 PH |
267 | """ |
268 | def replace_insane(char): | |
269 | if char == '?' or ord(char) < 32 or ord(char) == 127: | |
270 | return '' | |
271 | elif char == '"': | |
272 | return '' if restricted else '\'' | |
273 | elif char == ':': | |
274 | return '_-' if restricted else ' -' | |
275 | elif char in '\\/|*<>': | |
276 | return '_' | |
627dcfff | 277 | if restricted and (char in '!&\'()[]{}$;`^,#' or char.isspace()): |
59ae15a5 PH |
278 | return '_' |
279 | if restricted and ord(char) > 127: | |
280 | return '_' | |
281 | return char | |
282 | ||
28e614de | 283 | result = ''.join(map(replace_insane, s)) |
796173d0 PH |
284 | if not is_id: |
285 | while '__' in result: | |
286 | result = result.replace('__', '_') | |
287 | result = result.strip('_') | |
288 | # Common case of "Foreign band name - English song title" | |
289 | if restricted and result.startswith('-_'): | |
290 | result = result[2:] | |
291 | if not result: | |
292 | result = '_' | |
59ae15a5 | 293 | return result |
d77c3dfd | 294 | |
5f6a1245 | 295 | |
d77c3dfd | 296 | def orderedSet(iterable): |
59ae15a5 PH |
297 | """ Remove all duplicates from the input iterable """ |
298 | res = [] | |
299 | for el in iterable: | |
300 | if el not in res: | |
301 | res.append(el) | |
302 | return res | |
d77c3dfd | 303 | |
912b38b4 | 304 | |
4e408e47 PH |
305 | def _htmlentity_transform(entity): |
306 | """Transforms an HTML entity to a character.""" | |
307 | # Known non-numeric HTML entity | |
308 | if entity in compat_html_entities.name2codepoint: | |
309 | return compat_chr(compat_html_entities.name2codepoint[entity]) | |
310 | ||
311 | mobj = re.match(r'#(x?[0-9]+)', entity) | |
312 | if mobj is not None: | |
313 | numstr = mobj.group(1) | |
28e614de | 314 | if numstr.startswith('x'): |
4e408e47 | 315 | base = 16 |
28e614de | 316 | numstr = '0%s' % numstr |
4e408e47 PH |
317 | else: |
318 | base = 10 | |
319 | return compat_chr(int(numstr, base)) | |
320 | ||
321 | # Unknown entity in name, return its literal representation | |
28e614de | 322 | return ('&%s;' % entity) |
4e408e47 PH |
323 | |
324 | ||
d77c3dfd | 325 | def unescapeHTML(s): |
912b38b4 PH |
326 | if s is None: |
327 | return None | |
328 | assert type(s) == compat_str | |
d77c3dfd | 329 | |
4e408e47 PH |
330 | return re.sub( |
331 | r'&([^;]+);', lambda m: _htmlentity_transform(m.group(1)), s) | |
d77c3dfd | 332 | |
8bf48f23 PH |
333 | |
334 | def encodeFilename(s, for_subprocess=False): | |
59ae15a5 PH |
335 | """ |
336 | @param s The name of the file | |
337 | """ | |
d77c3dfd | 338 | |
8bf48f23 | 339 | assert type(s) == compat_str |
d77c3dfd | 340 | |
59ae15a5 PH |
341 | # Python 3 has a Unicode API |
342 | if sys.version_info >= (3, 0): | |
343 | return s | |
0f00efed | 344 | |
59ae15a5 | 345 | if sys.platform == 'win32' and sys.getwindowsversion()[0] >= 5: |
28e614de | 346 | # Pass '' directly to use Unicode APIs on Windows 2000 and up |
59ae15a5 PH |
347 | # (Detecting Windows NT 4 is tricky because 'major >= 4' would |
348 | # match Windows 9x series as well. Besides, NT 4 is obsolete.) | |
8bf48f23 PH |
349 | if not for_subprocess: |
350 | return s | |
351 | else: | |
352 | # For subprocess calls, encode with locale encoding | |
353 | # Refer to http://stackoverflow.com/a/9951851/35070 | |
354 | encoding = preferredencoding() | |
59ae15a5 | 355 | else: |
6df40dcb | 356 | encoding = sys.getfilesystemencoding() |
8bf48f23 PH |
357 | if encoding is None: |
358 | encoding = 'utf-8' | |
359 | return s.encode(encoding, 'ignore') | |
360 | ||
f07b74fc PH |
361 | |
362 | def encodeArgument(s): | |
363 | if not isinstance(s, compat_str): | |
364 | # Legacy code that uses byte strings | |
365 | # Uncomment the following line after fixing all post processors | |
366 | #assert False, 'Internal error: %r should be of type %r, is %r' % (s, compat_str, type(s)) | |
367 | s = s.decode('ascii') | |
368 | return encodeFilename(s, True) | |
369 | ||
370 | ||
8271226a PH |
371 | def decodeOption(optval): |
372 | if optval is None: | |
373 | return optval | |
374 | if isinstance(optval, bytes): | |
375 | optval = optval.decode(preferredencoding()) | |
376 | ||
377 | assert isinstance(optval, compat_str) | |
378 | return optval | |
1c256f70 | 379 | |
5f6a1245 | 380 | |
4539dd30 PH |
381 | def formatSeconds(secs): |
382 | if secs > 3600: | |
383 | return '%d:%02d:%02d' % (secs // 3600, (secs % 3600) // 60, secs % 60) | |
384 | elif secs > 60: | |
385 | return '%d:%02d' % (secs // 60, secs % 60) | |
386 | else: | |
387 | return '%d' % secs | |
388 | ||
a0ddb8a2 PH |
389 | |
390 | def make_HTTPS_handler(opts_no_check_certificate, **kwargs): | |
13ebea79 PH |
391 | if sys.version_info < (3, 2): |
392 | import httplib | |
393 | ||
394 | class HTTPSConnectionV3(httplib.HTTPSConnection): | |
395 | def __init__(self, *args, **kwargs): | |
396 | httplib.HTTPSConnection.__init__(self, *args, **kwargs) | |
397 | ||
398 | def connect(self): | |
399 | sock = socket.create_connection((self.host, self.port), self.timeout) | |
ac79fa02 | 400 | if getattr(self, '_tunnel_host', False): |
13ebea79 PH |
401 | self.sock = sock |
402 | self._tunnel() | |
403 | try: | |
aa37e3d4 | 404 | self.sock = ssl.wrap_socket(sock, self.key_file, self.cert_file, ssl_version=ssl.PROTOCOL_TLSv1) |
de79c46c | 405 | except ssl.SSLError: |
13ebea79 PH |
406 | self.sock = ssl.wrap_socket(sock, self.key_file, self.cert_file, ssl_version=ssl.PROTOCOL_SSLv23) |
407 | ||
408 | class HTTPSHandlerV3(compat_urllib_request.HTTPSHandler): | |
409 | def https_open(self, req): | |
410 | return self.do_open(HTTPSConnectionV3, req) | |
a0ddb8a2 | 411 | return HTTPSHandlerV3(**kwargs) |
aa37e3d4 PH |
412 | elif hasattr(ssl, 'create_default_context'): # Python >= 3.4 |
413 | context = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH) | |
414 | context.options &= ~ssl.OP_NO_SSLv3 # Allow older, not-as-secure SSLv3 | |
415 | if opts_no_check_certificate: | |
416 | context.verify_mode = ssl.CERT_NONE | |
417 | return compat_urllib_request.HTTPSHandler(context=context, **kwargs) | |
418 | else: # Python < 3.4 | |
419 | context = ssl.SSLContext(ssl.PROTOCOL_SSLv23) | |
ea6d901e | 420 | context.verify_mode = (ssl.CERT_NONE |
dca08720 | 421 | if opts_no_check_certificate |
ea6d901e | 422 | else ssl.CERT_REQUIRED) |
303b479e PH |
423 | context.set_default_verify_paths() |
424 | try: | |
425 | context.load_default_certs() | |
426 | except AttributeError: | |
427 | pass # Python < 3.4 | |
a0ddb8a2 | 428 | return compat_urllib_request.HTTPSHandler(context=context, **kwargs) |
ea6d901e | 429 | |
732ea2f0 | 430 | |
1c256f70 PH |
431 | class ExtractorError(Exception): |
432 | """Error during info extraction.""" | |
5f6a1245 | 433 | |
d11271dd | 434 | def __init__(self, msg, tb=None, expected=False, cause=None, video_id=None): |
9a82b238 PH |
435 | """ tb, if given, is the original traceback (so that it can be printed out). |
436 | If expected is set, this is a normal error message and most likely not a bug in youtube-dl. | |
437 | """ | |
438 | ||
439 | if sys.exc_info()[0] in (compat_urllib_error.URLError, socket.timeout, UnavailableVideoError): | |
440 | expected = True | |
d11271dd PH |
441 | if video_id is not None: |
442 | msg = video_id + ': ' + msg | |
410f3e73 | 443 | if cause: |
28e614de | 444 | msg += ' (caused by %r)' % cause |
9a82b238 | 445 | if not expected: |
732ea2f0 PH |
446 | if ytdl_is_updateable(): |
447 | update_cmd = 'type youtube-dl -U to update' | |
448 | else: | |
449 | update_cmd = 'see https://yt-dl.org/update on how to update' | |
450 | msg += '; please report this issue on https://yt-dl.org/bug .' | |
451 | msg += ' Make sure you are using the latest version; %s.' % update_cmd | |
452 | msg += ' Be sure to call youtube-dl with the --verbose flag and include its complete output.' | |
1c256f70 | 453 | super(ExtractorError, self).__init__(msg) |
d5979c5d | 454 | |
1c256f70 | 455 | self.traceback = tb |
8cc83b8d | 456 | self.exc_info = sys.exc_info() # preserve original exception |
2eabb802 | 457 | self.cause = cause |
d11271dd | 458 | self.video_id = video_id |
1c256f70 | 459 | |
01951dda PH |
460 | def format_traceback(self): |
461 | if self.traceback is None: | |
462 | return None | |
28e614de | 463 | return ''.join(traceback.format_tb(self.traceback)) |
01951dda | 464 | |
1c256f70 | 465 | |
55b3e45b JMF |
466 | class RegexNotFoundError(ExtractorError): |
467 | """Error when a regex didn't match""" | |
468 | pass | |
469 | ||
470 | ||
d77c3dfd | 471 | class DownloadError(Exception): |
59ae15a5 | 472 | """Download Error exception. |
d77c3dfd | 473 | |
59ae15a5 PH |
474 | This exception may be thrown by FileDownloader objects if they are not |
475 | configured to continue on errors. They will contain the appropriate | |
476 | error message. | |
477 | """ | |
5f6a1245 | 478 | |
8cc83b8d FV |
479 | def __init__(self, msg, exc_info=None): |
480 | """ exc_info, if given, is the original exception that caused the trouble (as returned by sys.exc_info()). """ | |
481 | super(DownloadError, self).__init__(msg) | |
482 | self.exc_info = exc_info | |
d77c3dfd FV |
483 | |
484 | ||
485 | class SameFileError(Exception): | |
59ae15a5 | 486 | """Same File exception. |
d77c3dfd | 487 | |
59ae15a5 PH |
488 | This exception will be thrown by FileDownloader objects if they detect |
489 | multiple files would have to be downloaded to the same file on disk. | |
490 | """ | |
491 | pass | |
d77c3dfd FV |
492 | |
493 | ||
494 | class PostProcessingError(Exception): | |
59ae15a5 | 495 | """Post Processing exception. |
d77c3dfd | 496 | |
59ae15a5 PH |
497 | This exception may be raised by PostProcessor's .run() method to |
498 | indicate an error in the postprocessing task. | |
499 | """ | |
5f6a1245 | 500 | |
7851b379 PH |
501 | def __init__(self, msg): |
502 | self.msg = msg | |
d77c3dfd | 503 | |
5f6a1245 | 504 | |
d77c3dfd | 505 | class MaxDownloadsReached(Exception): |
59ae15a5 PH |
506 | """ --max-downloads limit has been reached. """ |
507 | pass | |
d77c3dfd FV |
508 | |
509 | ||
510 | class UnavailableVideoError(Exception): | |
59ae15a5 | 511 | """Unavailable Format exception. |
d77c3dfd | 512 | |
59ae15a5 PH |
513 | This exception will be thrown when a video is requested |
514 | in a format that is not available for that video. | |
515 | """ | |
516 | pass | |
d77c3dfd FV |
517 | |
518 | ||
519 | class ContentTooShortError(Exception): | |
59ae15a5 | 520 | """Content Too Short exception. |
d77c3dfd | 521 | |
59ae15a5 PH |
522 | This exception may be raised by FileDownloader objects when a file they |
523 | download is too small for what the server announced first, indicating | |
524 | the connection was probably interrupted. | |
525 | """ | |
526 | # Both in bytes | |
527 | downloaded = None | |
528 | expected = None | |
d77c3dfd | 529 | |
59ae15a5 PH |
530 | def __init__(self, downloaded, expected): |
531 | self.downloaded = downloaded | |
532 | self.expected = expected | |
d77c3dfd | 533 | |
5f6a1245 | 534 | |
acebc9cd | 535 | class YoutubeDLHandler(compat_urllib_request.HTTPHandler): |
59ae15a5 PH |
536 | """Handler for HTTP requests and responses. |
537 | ||
538 | This class, when installed with an OpenerDirector, automatically adds | |
539 | the standard headers to every HTTP request and handles gzipped and | |
540 | deflated responses from web servers. If compression is to be avoided in | |
541 | a particular request, the original request in the program code only has | |
542 | to include the HTTP header "Youtubedl-No-Compression", which will be | |
543 | removed before making the real request. | |
544 | ||
545 | Part of this code was copied from: | |
546 | ||
547 | http://techknack.net/python-urllib2-handlers/ | |
548 | ||
549 | Andrew Rowls, the author of that code, agreed to release it to the | |
550 | public domain. | |
551 | """ | |
552 | ||
553 | @staticmethod | |
554 | def deflate(data): | |
555 | try: | |
556 | return zlib.decompress(data, -zlib.MAX_WBITS) | |
557 | except zlib.error: | |
558 | return zlib.decompress(data) | |
559 | ||
560 | @staticmethod | |
561 | def addinfourl_wrapper(stream, headers, url, code): | |
562 | if hasattr(compat_urllib_request.addinfourl, 'getcode'): | |
563 | return compat_urllib_request.addinfourl(stream, headers, url, code) | |
564 | ret = compat_urllib_request.addinfourl(stream, headers, url) | |
565 | ret.code = code | |
566 | return ret | |
567 | ||
acebc9cd | 568 | def http_request(self, req): |
33ac271b PH |
569 | for h, v in std_headers.items(): |
570 | if h not in req.headers: | |
571 | req.add_header(h, v) | |
59ae15a5 PH |
572 | if 'Youtubedl-no-compression' in req.headers: |
573 | if 'Accept-encoding' in req.headers: | |
574 | del req.headers['Accept-encoding'] | |
575 | del req.headers['Youtubedl-no-compression'] | |
3446dfb7 | 576 | if 'Youtubedl-user-agent' in req.headers: |
335959e7 PH |
577 | if 'User-agent' in req.headers: |
578 | del req.headers['User-agent'] | |
579 | req.headers['User-agent'] = req.headers['Youtubedl-user-agent'] | |
3446dfb7 | 580 | del req.headers['Youtubedl-user-agent'] |
989b4b2b PH |
581 | |
582 | if sys.version_info < (2, 7) and '#' in req.get_full_url(): | |
583 | # Python 2.6 is brain-dead when it comes to fragments | |
584 | req._Request__original = req._Request__original.partition('#')[0] | |
585 | req._Request__r_type = req._Request__r_type.partition('#')[0] | |
586 | ||
59ae15a5 PH |
587 | return req |
588 | ||
acebc9cd | 589 | def http_response(self, req, resp): |
59ae15a5 PH |
590 | old_resp = resp |
591 | # gzip | |
592 | if resp.headers.get('Content-encoding', '') == 'gzip': | |
aa3e9507 PH |
593 | content = resp.read() |
594 | gz = gzip.GzipFile(fileobj=io.BytesIO(content), mode='rb') | |
595 | try: | |
596 | uncompressed = io.BytesIO(gz.read()) | |
597 | except IOError as original_ioerror: | |
598 | # There may be junk add the end of the file | |
599 | # See http://stackoverflow.com/q/4928560/35070 for details | |
600 | for i in range(1, 1024): | |
601 | try: | |
602 | gz = gzip.GzipFile(fileobj=io.BytesIO(content[:-i]), mode='rb') | |
603 | uncompressed = io.BytesIO(gz.read()) | |
604 | except IOError: | |
605 | continue | |
606 | break | |
607 | else: | |
608 | raise original_ioerror | |
609 | resp = self.addinfourl_wrapper(uncompressed, old_resp.headers, old_resp.url, old_resp.code) | |
59ae15a5 PH |
610 | resp.msg = old_resp.msg |
611 | # deflate | |
612 | if resp.headers.get('Content-encoding', '') == 'deflate': | |
613 | gz = io.BytesIO(self.deflate(resp.read())) | |
614 | resp = self.addinfourl_wrapper(gz, old_resp.headers, old_resp.url, old_resp.code) | |
615 | resp.msg = old_resp.msg | |
616 | return resp | |
0f8d03f8 | 617 | |
acebc9cd PH |
618 | https_request = http_request |
619 | https_response = http_response | |
bf50b038 | 620 | |
5de90176 | 621 | |
305d0683 | 622 | def parse_iso8601(date_str, delimiter='T'): |
912b38b4 PH |
623 | """ Return a UNIX timestamp from the given date """ |
624 | ||
625 | if date_str is None: | |
626 | return None | |
627 | ||
628 | m = re.search( | |
6ad4013d | 629 | r'(\.[0-9]+)?(?:Z$| ?(?P<sign>\+|-)(?P<hours>[0-9]{2}):?(?P<minutes>[0-9]{2})$)', |
912b38b4 PH |
630 | date_str) |
631 | if not m: | |
632 | timezone = datetime.timedelta() | |
633 | else: | |
634 | date_str = date_str[:-len(m.group(0))] | |
635 | if not m.group('sign'): | |
636 | timezone = datetime.timedelta() | |
637 | else: | |
638 | sign = 1 if m.group('sign') == '+' else -1 | |
639 | timezone = datetime.timedelta( | |
640 | hours=sign * int(m.group('hours')), | |
641 | minutes=sign * int(m.group('minutes'))) | |
6ad4013d | 642 | date_format = '%Y-%m-%d{0}%H:%M:%S'.format(delimiter) |
305d0683 | 643 | dt = datetime.datetime.strptime(date_str, date_format) - timezone |
912b38b4 PH |
644 | return calendar.timegm(dt.timetuple()) |
645 | ||
646 | ||
bf50b038 JMF |
647 | def unified_strdate(date_str): |
648 | """Return a string with the date in the format YYYYMMDD""" | |
64e7ad60 PH |
649 | |
650 | if date_str is None: | |
651 | return None | |
652 | ||
bf50b038 | 653 | upload_date = None |
5f6a1245 | 654 | # Replace commas |
026fcc04 | 655 | date_str = date_str.replace(',', ' ') |
bf50b038 | 656 | # %z (UTC offset) is only supported in python>=3.2 |
026fcc04 | 657 | date_str = re.sub(r' ?(\+|-)[0-9]{2}:?[0-9]{2}$', '', date_str) |
19e1d359 JMF |
658 | format_expressions = [ |
659 | '%d %B %Y', | |
0f99566c | 660 | '%d %b %Y', |
19e1d359 JMF |
661 | '%B %d %Y', |
662 | '%b %d %Y', | |
78ff59d0 PP |
663 | '%b %dst %Y %I:%M%p', |
664 | '%b %dnd %Y %I:%M%p', | |
665 | '%b %dth %Y %I:%M%p', | |
19e1d359 | 666 | '%Y-%m-%d', |
fe556f1b | 667 | '%Y/%m/%d', |
4cf96546 | 668 | '%d.%m.%Y', |
19e1d359 | 669 | '%d/%m/%Y', |
423817c4 | 670 | '%d/%m/%y', |
19e1d359 | 671 | '%Y/%m/%d %H:%M:%S', |
99b67fec | 672 | '%d/%m/%Y %H:%M:%S', |
5d73273f | 673 | '%Y-%m-%d %H:%M:%S', |
e9be9a6a | 674 | '%Y-%m-%d %H:%M:%S.%f', |
19e1d359 | 675 | '%d.%m.%Y %H:%M', |
b047de6f | 676 | '%d.%m.%Y %H.%M', |
19e1d359 | 677 | '%Y-%m-%dT%H:%M:%SZ', |
59040888 PH |
678 | '%Y-%m-%dT%H:%M:%S.%fZ', |
679 | '%Y-%m-%dT%H:%M:%S.%f0Z', | |
2e1fa03b | 680 | '%Y-%m-%dT%H:%M:%S', |
7ff5d5c2 | 681 | '%Y-%m-%dT%H:%M:%S.%f', |
5de90176 | 682 | '%Y-%m-%dT%H:%M', |
19e1d359 | 683 | ] |
bf50b038 JMF |
684 | for expression in format_expressions: |
685 | try: | |
686 | upload_date = datetime.datetime.strptime(date_str, expression).strftime('%Y%m%d') | |
5de90176 | 687 | except ValueError: |
bf50b038 | 688 | pass |
42393ce2 PH |
689 | if upload_date is None: |
690 | timetuple = email.utils.parsedate_tz(date_str) | |
691 | if timetuple: | |
692 | upload_date = datetime.datetime(*timetuple[:6]).strftime('%Y%m%d') | |
bf50b038 JMF |
693 | return upload_date |
694 | ||
5f6a1245 | 695 | |
28e614de | 696 | def determine_ext(url, default_ext='unknown_video'): |
f4776371 S |
697 | if url is None: |
698 | return default_ext | |
28e614de | 699 | guess = url.partition('?')[0].rpartition('.')[2] |
73e79f2a PH |
700 | if re.match(r'^[A-Za-z0-9]+$', guess): |
701 | return guess | |
702 | else: | |
cbdbb766 | 703 | return default_ext |
73e79f2a | 704 | |
5f6a1245 | 705 | |
d4051a8e | 706 | def subtitles_filename(filename, sub_lang, sub_format): |
28e614de | 707 | return filename.rsplit('.', 1)[0] + '.' + sub_lang + '.' + sub_format |
d4051a8e | 708 | |
5f6a1245 | 709 | |
bd558525 | 710 | def date_from_str(date_str): |
37254abc JMF |
711 | """ |
712 | Return a datetime object from a string in the format YYYYMMDD or | |
713 | (now|today)[+-][0-9](day|week|month|year)(s)?""" | |
714 | today = datetime.date.today() | |
715 | if date_str == 'now'or date_str == 'today': | |
716 | return today | |
717 | match = re.match('(now|today)(?P<sign>[+-])(?P<time>\d+)(?P<unit>day|week|month|year)(s)?', date_str) | |
718 | if match is not None: | |
719 | sign = match.group('sign') | |
720 | time = int(match.group('time')) | |
721 | if sign == '-': | |
722 | time = -time | |
723 | unit = match.group('unit') | |
5f6a1245 | 724 | # A bad aproximation? |
37254abc JMF |
725 | if unit == 'month': |
726 | unit = 'day' | |
727 | time *= 30 | |
728 | elif unit == 'year': | |
729 | unit = 'day' | |
730 | time *= 365 | |
731 | unit += 's' | |
732 | delta = datetime.timedelta(**{unit: time}) | |
733 | return today + delta | |
bd558525 | 734 | return datetime.datetime.strptime(date_str, "%Y%m%d").date() |
5f6a1245 JW |
735 | |
736 | ||
e63fc1be | 737 | def hyphenate_date(date_str): |
738 | """ | |
739 | Convert a date in 'YYYYMMDD' format to 'YYYY-MM-DD' format""" | |
740 | match = re.match(r'^(\d\d\d\d)(\d\d)(\d\d)$', date_str) | |
741 | if match is not None: | |
742 | return '-'.join(match.groups()) | |
743 | else: | |
744 | return date_str | |
745 | ||
5f6a1245 | 746 | |
bd558525 JMF |
747 | class DateRange(object): |
748 | """Represents a time interval between two dates""" | |
5f6a1245 | 749 | |
bd558525 JMF |
750 | def __init__(self, start=None, end=None): |
751 | """start and end must be strings in the format accepted by date""" | |
752 | if start is not None: | |
753 | self.start = date_from_str(start) | |
754 | else: | |
755 | self.start = datetime.datetime.min.date() | |
756 | if end is not None: | |
757 | self.end = date_from_str(end) | |
758 | else: | |
759 | self.end = datetime.datetime.max.date() | |
37254abc | 760 | if self.start > self.end: |
bd558525 | 761 | raise ValueError('Date range: "%s" , the start date must be before the end date' % self) |
5f6a1245 | 762 | |
bd558525 JMF |
763 | @classmethod |
764 | def day(cls, day): | |
765 | """Returns a range that only contains the given day""" | |
5f6a1245 JW |
766 | return cls(day, day) |
767 | ||
bd558525 JMF |
768 | def __contains__(self, date): |
769 | """Check if the date is in the range""" | |
37254abc JMF |
770 | if not isinstance(date, datetime.date): |
771 | date = date_from_str(date) | |
772 | return self.start <= date <= self.end | |
5f6a1245 | 773 | |
bd558525 | 774 | def __str__(self): |
5f6a1245 | 775 | return '%s - %s' % (self.start.isoformat(), self.end.isoformat()) |
c496ca96 PH |
776 | |
777 | ||
778 | def platform_name(): | |
779 | """ Returns the platform name as a compat_str """ | |
780 | res = platform.platform() | |
781 | if isinstance(res, bytes): | |
782 | res = res.decode(preferredencoding()) | |
783 | ||
784 | assert isinstance(res, compat_str) | |
785 | return res | |
c257baff PH |
786 | |
787 | ||
b58ddb32 PH |
788 | def _windows_write_string(s, out): |
789 | """ Returns True if the string was written using special methods, | |
790 | False if it has yet to be written out.""" | |
791 | # Adapted from http://stackoverflow.com/a/3259271/35070 | |
792 | ||
793 | import ctypes | |
794 | import ctypes.wintypes | |
795 | ||
796 | WIN_OUTPUT_IDS = { | |
797 | 1: -11, | |
798 | 2: -12, | |
799 | } | |
800 | ||
a383a98a PH |
801 | try: |
802 | fileno = out.fileno() | |
803 | except AttributeError: | |
804 | # If the output stream doesn't have a fileno, it's virtual | |
805 | return False | |
b58ddb32 PH |
806 | if fileno not in WIN_OUTPUT_IDS: |
807 | return False | |
808 | ||
809 | GetStdHandle = ctypes.WINFUNCTYPE( | |
810 | ctypes.wintypes.HANDLE, ctypes.wintypes.DWORD)( | |
811 | ("GetStdHandle", ctypes.windll.kernel32)) | |
812 | h = GetStdHandle(WIN_OUTPUT_IDS[fileno]) | |
813 | ||
814 | WriteConsoleW = ctypes.WINFUNCTYPE( | |
815 | ctypes.wintypes.BOOL, ctypes.wintypes.HANDLE, ctypes.wintypes.LPWSTR, | |
816 | ctypes.wintypes.DWORD, ctypes.POINTER(ctypes.wintypes.DWORD), | |
817 | ctypes.wintypes.LPVOID)(("WriteConsoleW", ctypes.windll.kernel32)) | |
818 | written = ctypes.wintypes.DWORD(0) | |
819 | ||
820 | GetFileType = ctypes.WINFUNCTYPE(ctypes.wintypes.DWORD, ctypes.wintypes.DWORD)(("GetFileType", ctypes.windll.kernel32)) | |
821 | FILE_TYPE_CHAR = 0x0002 | |
822 | FILE_TYPE_REMOTE = 0x8000 | |
823 | GetConsoleMode = ctypes.WINFUNCTYPE( | |
824 | ctypes.wintypes.BOOL, ctypes.wintypes.HANDLE, | |
825 | ctypes.POINTER(ctypes.wintypes.DWORD))( | |
826 | ("GetConsoleMode", ctypes.windll.kernel32)) | |
827 | INVALID_HANDLE_VALUE = ctypes.wintypes.DWORD(-1).value | |
828 | ||
829 | def not_a_console(handle): | |
830 | if handle == INVALID_HANDLE_VALUE or handle is None: | |
831 | return True | |
832 | return ((GetFileType(handle) & ~FILE_TYPE_REMOTE) != FILE_TYPE_CHAR | |
833 | or GetConsoleMode(handle, ctypes.byref(ctypes.wintypes.DWORD())) == 0) | |
834 | ||
835 | if not_a_console(h): | |
836 | return False | |
837 | ||
d1b9c912 PH |
838 | def next_nonbmp_pos(s): |
839 | try: | |
840 | return next(i for i, c in enumerate(s) if ord(c) > 0xffff) | |
841 | except StopIteration: | |
842 | return len(s) | |
843 | ||
844 | while s: | |
845 | count = min(next_nonbmp_pos(s), 1024) | |
846 | ||
b58ddb32 | 847 | ret = WriteConsoleW( |
d1b9c912 | 848 | h, s, count if count else 2, ctypes.byref(written), None) |
b58ddb32 PH |
849 | if ret == 0: |
850 | raise OSError('Failed to write string') | |
d1b9c912 PH |
851 | if not count: # We just wrote a non-BMP character |
852 | assert written.value == 2 | |
853 | s = s[1:] | |
854 | else: | |
855 | assert written.value > 0 | |
856 | s = s[written.value:] | |
b58ddb32 PH |
857 | return True |
858 | ||
859 | ||
734f90bb | 860 | def write_string(s, out=None, encoding=None): |
7459e3a2 PH |
861 | if out is None: |
862 | out = sys.stderr | |
8bf48f23 | 863 | assert type(s) == compat_str |
7459e3a2 | 864 | |
b58ddb32 PH |
865 | if sys.platform == 'win32' and encoding is None and hasattr(out, 'fileno'): |
866 | if _windows_write_string(s, out): | |
867 | return | |
868 | ||
7459e3a2 PH |
869 | if ('b' in getattr(out, 'mode', '') or |
870 | sys.version_info[0] < 3): # Python 2 lies about mode of sys.stderr | |
104aa738 PH |
871 | byt = s.encode(encoding or preferredencoding(), 'ignore') |
872 | out.write(byt) | |
873 | elif hasattr(out, 'buffer'): | |
874 | enc = encoding or getattr(out, 'encoding', None) or preferredencoding() | |
875 | byt = s.encode(enc, 'ignore') | |
876 | out.buffer.write(byt) | |
877 | else: | |
8bf48f23 | 878 | out.write(s) |
7459e3a2 PH |
879 | out.flush() |
880 | ||
881 | ||
48ea9cea PH |
882 | def bytes_to_intlist(bs): |
883 | if not bs: | |
884 | return [] | |
885 | if isinstance(bs[0], int): # Python 3 | |
886 | return list(bs) | |
887 | else: | |
888 | return [ord(c) for c in bs] | |
889 | ||
c257baff | 890 | |
cba892fa | 891 | def intlist_to_bytes(xs): |
892 | if not xs: | |
893 | return b'' | |
eb4157fd | 894 | return struct_pack('%dB' % len(xs), *xs) |
c38b1e77 PH |
895 | |
896 | ||
c1c9a79c PH |
897 | # Cross-platform file locking |
898 | if sys.platform == 'win32': | |
899 | import ctypes.wintypes | |
900 | import msvcrt | |
901 | ||
902 | class OVERLAPPED(ctypes.Structure): | |
903 | _fields_ = [ | |
904 | ('Internal', ctypes.wintypes.LPVOID), | |
905 | ('InternalHigh', ctypes.wintypes.LPVOID), | |
906 | ('Offset', ctypes.wintypes.DWORD), | |
907 | ('OffsetHigh', ctypes.wintypes.DWORD), | |
908 | ('hEvent', ctypes.wintypes.HANDLE), | |
909 | ] | |
910 | ||
911 | kernel32 = ctypes.windll.kernel32 | |
912 | LockFileEx = kernel32.LockFileEx | |
913 | LockFileEx.argtypes = [ | |
914 | ctypes.wintypes.HANDLE, # hFile | |
915 | ctypes.wintypes.DWORD, # dwFlags | |
916 | ctypes.wintypes.DWORD, # dwReserved | |
917 | ctypes.wintypes.DWORD, # nNumberOfBytesToLockLow | |
918 | ctypes.wintypes.DWORD, # nNumberOfBytesToLockHigh | |
919 | ctypes.POINTER(OVERLAPPED) # Overlapped | |
920 | ] | |
921 | LockFileEx.restype = ctypes.wintypes.BOOL | |
922 | UnlockFileEx = kernel32.UnlockFileEx | |
923 | UnlockFileEx.argtypes = [ | |
924 | ctypes.wintypes.HANDLE, # hFile | |
925 | ctypes.wintypes.DWORD, # dwReserved | |
926 | ctypes.wintypes.DWORD, # nNumberOfBytesToLockLow | |
927 | ctypes.wintypes.DWORD, # nNumberOfBytesToLockHigh | |
928 | ctypes.POINTER(OVERLAPPED) # Overlapped | |
929 | ] | |
930 | UnlockFileEx.restype = ctypes.wintypes.BOOL | |
931 | whole_low = 0xffffffff | |
932 | whole_high = 0x7fffffff | |
933 | ||
934 | def _lock_file(f, exclusive): | |
935 | overlapped = OVERLAPPED() | |
936 | overlapped.Offset = 0 | |
937 | overlapped.OffsetHigh = 0 | |
938 | overlapped.hEvent = 0 | |
939 | f._lock_file_overlapped_p = ctypes.pointer(overlapped) | |
940 | handle = msvcrt.get_osfhandle(f.fileno()) | |
941 | if not LockFileEx(handle, 0x2 if exclusive else 0x0, 0, | |
942 | whole_low, whole_high, f._lock_file_overlapped_p): | |
943 | raise OSError('Locking file failed: %r' % ctypes.FormatError()) | |
944 | ||
945 | def _unlock_file(f): | |
946 | assert f._lock_file_overlapped_p | |
947 | handle = msvcrt.get_osfhandle(f.fileno()) | |
948 | if not UnlockFileEx(handle, 0, | |
949 | whole_low, whole_high, f._lock_file_overlapped_p): | |
950 | raise OSError('Unlocking file failed: %r' % ctypes.FormatError()) | |
951 | ||
952 | else: | |
953 | import fcntl | |
954 | ||
955 | def _lock_file(f, exclusive): | |
2582bebe | 956 | fcntl.flock(f, fcntl.LOCK_EX if exclusive else fcntl.LOCK_SH) |
c1c9a79c PH |
957 | |
958 | def _unlock_file(f): | |
2582bebe | 959 | fcntl.flock(f, fcntl.LOCK_UN) |
c1c9a79c PH |
960 | |
961 | ||
962 | class locked_file(object): | |
963 | def __init__(self, filename, mode, encoding=None): | |
964 | assert mode in ['r', 'a', 'w'] | |
965 | self.f = io.open(filename, mode, encoding=encoding) | |
966 | self.mode = mode | |
967 | ||
968 | def __enter__(self): | |
969 | exclusive = self.mode != 'r' | |
970 | try: | |
971 | _lock_file(self.f, exclusive) | |
972 | except IOError: | |
973 | self.f.close() | |
974 | raise | |
975 | return self | |
976 | ||
977 | def __exit__(self, etype, value, traceback): | |
978 | try: | |
979 | _unlock_file(self.f) | |
980 | finally: | |
981 | self.f.close() | |
982 | ||
983 | def __iter__(self): | |
984 | return iter(self.f) | |
985 | ||
986 | def write(self, *args): | |
987 | return self.f.write(*args) | |
988 | ||
989 | def read(self, *args): | |
990 | return self.f.read(*args) | |
4eb7f1d1 JMF |
991 | |
992 | ||
4644ac55 S |
993 | def get_filesystem_encoding(): |
994 | encoding = sys.getfilesystemencoding() | |
995 | return encoding if encoding is not None else 'utf-8' | |
996 | ||
997 | ||
4eb7f1d1 | 998 | def shell_quote(args): |
a6a173c2 | 999 | quoted_args = [] |
4644ac55 | 1000 | encoding = get_filesystem_encoding() |
a6a173c2 JMF |
1001 | for a in args: |
1002 | if isinstance(a, bytes): | |
1003 | # We may get a filename encoded with 'encodeFilename' | |
1004 | a = a.decode(encoding) | |
1005 | quoted_args.append(pipes.quote(a)) | |
28e614de | 1006 | return ' '.join(quoted_args) |
9d4660ca PH |
1007 | |
1008 | ||
f4d96df0 PH |
1009 | def takewhile_inclusive(pred, seq): |
1010 | """ Like itertools.takewhile, but include the latest evaluated element | |
1011 | (the first element so that Not pred(e)) """ | |
1012 | for e in seq: | |
1013 | yield e | |
1014 | if not pred(e): | |
1015 | return | |
1016 | ||
1017 | ||
9d4660ca PH |
1018 | def smuggle_url(url, data): |
1019 | """ Pass additional data in a URL for internal use. """ | |
1020 | ||
1021 | sdata = compat_urllib_parse.urlencode( | |
28e614de PH |
1022 | {'__youtubedl_smuggle': json.dumps(data)}) |
1023 | return url + '#' + sdata | |
9d4660ca PH |
1024 | |
1025 | ||
79f82953 | 1026 | def unsmuggle_url(smug_url, default=None): |
9d4660ca | 1027 | if not '#__youtubedl_smuggle' in smug_url: |
79f82953 | 1028 | return smug_url, default |
28e614de PH |
1029 | url, _, sdata = smug_url.rpartition('#') |
1030 | jsond = compat_parse_qs(sdata)['__youtubedl_smuggle'][0] | |
9d4660ca PH |
1031 | data = json.loads(jsond) |
1032 | return url, data | |
02dbf93f PH |
1033 | |
1034 | ||
02dbf93f PH |
1035 | def format_bytes(bytes): |
1036 | if bytes is None: | |
28e614de | 1037 | return 'N/A' |
02dbf93f PH |
1038 | if type(bytes) is str: |
1039 | bytes = float(bytes) | |
1040 | if bytes == 0.0: | |
1041 | exponent = 0 | |
1042 | else: | |
1043 | exponent = int(math.log(bytes, 1024.0)) | |
28e614de | 1044 | suffix = ['B', 'KiB', 'MiB', 'GiB', 'TiB', 'PiB', 'EiB', 'ZiB', 'YiB'][exponent] |
02dbf93f | 1045 | converted = float(bytes) / float(1024 ** exponent) |
28e614de | 1046 | return '%.2f%s' % (converted, suffix) |
f53c966a | 1047 | |
1c088fa8 | 1048 | |
1c088fa8 | 1049 | def get_term_width(): |
4644ac55 | 1050 | columns = compat_getenv('COLUMNS', None) |
1c088fa8 PH |
1051 | if columns: |
1052 | return int(columns) | |
1053 | ||
1054 | try: | |
1055 | sp = subprocess.Popen( | |
1056 | ['stty', 'size'], | |
1057 | stdout=subprocess.PIPE, stderr=subprocess.PIPE) | |
1058 | out, err = sp.communicate() | |
1059 | return int(out.split()[1]) | |
1060 | except: | |
1061 | pass | |
1062 | return None | |
caefb1de PH |
1063 | |
1064 | ||
1065 | def month_by_name(name): | |
1066 | """ Return the number of a month by (locale-independently) English name """ | |
1067 | ||
1068 | ENGLISH_NAMES = [ | |
28e614de PH |
1069 | 'January', 'February', 'March', 'April', 'May', 'June', |
1070 | 'July', 'August', 'September', 'October', 'November', 'December'] | |
caefb1de PH |
1071 | try: |
1072 | return ENGLISH_NAMES.index(name) + 1 | |
1073 | except ValueError: | |
1074 | return None | |
18258362 JMF |
1075 | |
1076 | ||
5aafe895 | 1077 | def fix_xml_ampersands(xml_str): |
18258362 | 1078 | """Replace all the '&' by '&' in XML""" |
5aafe895 PH |
1079 | return re.sub( |
1080 | r'&(?!amp;|lt;|gt;|apos;|quot;|#x[0-9a-fA-F]{,4};|#[0-9]{,4};)', | |
28e614de | 1081 | '&', |
5aafe895 | 1082 | xml_str) |
e3946f98 PH |
1083 | |
1084 | ||
1085 | def setproctitle(title): | |
8bf48f23 | 1086 | assert isinstance(title, compat_str) |
e3946f98 PH |
1087 | try: |
1088 | libc = ctypes.cdll.LoadLibrary("libc.so.6") | |
1089 | except OSError: | |
1090 | return | |
6eefe533 PH |
1091 | title_bytes = title.encode('utf-8') |
1092 | buf = ctypes.create_string_buffer(len(title_bytes)) | |
1093 | buf.value = title_bytes | |
e3946f98 | 1094 | try: |
6eefe533 | 1095 | libc.prctl(15, buf, 0, 0, 0) |
e3946f98 PH |
1096 | except AttributeError: |
1097 | return # Strange libc, just skip this | |
d7dda168 PH |
1098 | |
1099 | ||
1100 | def remove_start(s, start): | |
1101 | if s.startswith(start): | |
1102 | return s[len(start):] | |
1103 | return s | |
29eb5174 PH |
1104 | |
1105 | ||
2b9faf55 PH |
1106 | def remove_end(s, end): |
1107 | if s.endswith(end): | |
1108 | return s[:-len(end)] | |
1109 | return s | |
1110 | ||
1111 | ||
29eb5174 | 1112 | def url_basename(url): |
9b8aaeed | 1113 | path = compat_urlparse.urlparse(url).path |
28e614de | 1114 | return path.strip('/').split('/')[-1] |
aa94a6d3 PH |
1115 | |
1116 | ||
1117 | class HEADRequest(compat_urllib_request.Request): | |
1118 | def get_method(self): | |
1119 | return "HEAD" | |
7217e148 PH |
1120 | |
1121 | ||
9732d77e | 1122 | def int_or_none(v, scale=1, default=None, get_attr=None, invscale=1): |
28746fbd PH |
1123 | if get_attr: |
1124 | if v is not None: | |
1125 | v = getattr(v, get_attr, None) | |
9572013d PH |
1126 | if v == '': |
1127 | v = None | |
9732d77e PH |
1128 | return default if v is None else (int(v) * invscale // scale) |
1129 | ||
9572013d | 1130 | |
40a90862 JMF |
1131 | def str_or_none(v, default=None): |
1132 | return default if v is None else compat_str(v) | |
1133 | ||
9732d77e PH |
1134 | |
1135 | def str_to_int(int_str): | |
48d4681e | 1136 | """ A more relaxed version of int_or_none """ |
9732d77e PH |
1137 | if int_str is None: |
1138 | return None | |
28e614de | 1139 | int_str = re.sub(r'[,\.\+]', '', int_str) |
9732d77e | 1140 | return int(int_str) |
608d11f5 PH |
1141 | |
1142 | ||
9732d77e PH |
1143 | def float_or_none(v, scale=1, invscale=1, default=None): |
1144 | return default if v is None else (float(v) * invscale / scale) | |
43f775e4 PH |
1145 | |
1146 | ||
608d11f5 PH |
1147 | def parse_duration(s): |
1148 | if s is None: | |
1149 | return None | |
1150 | ||
ca7b3246 S |
1151 | s = s.strip() |
1152 | ||
608d11f5 | 1153 | m = re.match( |
6a68bb57 PH |
1154 | r'''(?ix)T? |
1155 | (?: | |
1156 | (?:(?P<hours>[0-9]+)\s*(?:[:h]|hours?)\s*)? | |
1157 | (?P<mins>[0-9]+)\s*(?:[:m]|mins?|minutes?)\s* | |
1158 | )? | |
1159 | (?P<secs>[0-9]+)(?P<ms>\.[0-9]+)?\s*(?:s|secs?|seconds?)?$''', s) | |
608d11f5 PH |
1160 | if not m: |
1161 | return None | |
1162 | res = int(m.group('secs')) | |
1163 | if m.group('mins'): | |
1164 | res += int(m.group('mins')) * 60 | |
1165 | if m.group('hours'): | |
1166 | res += int(m.group('hours')) * 60 * 60 | |
7adcbe75 PH |
1167 | if m.group('ms'): |
1168 | res += float(m.group('ms')) | |
608d11f5 | 1169 | return res |
91d7d0b3 JMF |
1170 | |
1171 | ||
1172 | def prepend_extension(filename, ext): | |
5f6a1245 | 1173 | name, real_ext = os.path.splitext(filename) |
28e614de | 1174 | return '{0}.{1}{2}'.format(name, ext, real_ext) |
d70ad093 PH |
1175 | |
1176 | ||
1177 | def check_executable(exe, args=[]): | |
1178 | """ Checks if the given binary is installed somewhere in PATH, and returns its name. | |
1179 | args can be a list of arguments for a short output (like -version) """ | |
1180 | try: | |
1181 | subprocess.Popen([exe] + args, stdout=subprocess.PIPE, stderr=subprocess.PIPE).communicate() | |
1182 | except OSError: | |
1183 | return False | |
1184 | return exe | |
b7ab0590 PH |
1185 | |
1186 | ||
95807118 PH |
1187 | def get_exe_version(exe, args=['--version'], |
1188 | version_re=r'version\s+([0-9._-a-zA-Z]+)', | |
28e614de | 1189 | unrecognized='present'): |
95807118 PH |
1190 | """ Returns the version of the specified executable, |
1191 | or False if the executable is not present """ | |
1192 | try: | |
1193 | out, err = subprocess.Popen( | |
1194 | [exe] + args, | |
1195 | stdout=subprocess.PIPE, stderr=subprocess.STDOUT).communicate() | |
1196 | except OSError: | |
1197 | return False | |
1198 | firstline = out.partition(b'\n')[0].decode('ascii', 'ignore') | |
1199 | m = re.search(version_re, firstline) | |
1200 | if m: | |
1201 | return m.group(1) | |
1202 | else: | |
1203 | return unrecognized | |
1204 | ||
1205 | ||
b7ab0590 | 1206 | class PagedList(object): |
dd26ced1 PH |
1207 | def __len__(self): |
1208 | # This is only useful for tests | |
1209 | return len(self.getslice()) | |
1210 | ||
9c44d242 PH |
1211 | |
1212 | class OnDemandPagedList(PagedList): | |
1213 | def __init__(self, pagefunc, pagesize): | |
1214 | self._pagefunc = pagefunc | |
1215 | self._pagesize = pagesize | |
1216 | ||
b7ab0590 PH |
1217 | def getslice(self, start=0, end=None): |
1218 | res = [] | |
1219 | for pagenum in itertools.count(start // self._pagesize): | |
1220 | firstid = pagenum * self._pagesize | |
1221 | nextfirstid = pagenum * self._pagesize + self._pagesize | |
1222 | if start >= nextfirstid: | |
1223 | continue | |
1224 | ||
1225 | page_results = list(self._pagefunc(pagenum)) | |
1226 | ||
1227 | startv = ( | |
1228 | start % self._pagesize | |
1229 | if firstid <= start < nextfirstid | |
1230 | else 0) | |
1231 | ||
1232 | endv = ( | |
1233 | ((end - 1) % self._pagesize) + 1 | |
1234 | if (end is not None and firstid <= end <= nextfirstid) | |
1235 | else None) | |
1236 | ||
1237 | if startv != 0 or endv is not None: | |
1238 | page_results = page_results[startv:endv] | |
1239 | res.extend(page_results) | |
1240 | ||
1241 | # A little optimization - if current page is not "full", ie. does | |
1242 | # not contain page_size videos then we can assume that this page | |
1243 | # is the last one - there are no more ids on further pages - | |
1244 | # i.e. no need to query again. | |
1245 | if len(page_results) + startv < self._pagesize: | |
1246 | break | |
1247 | ||
1248 | # If we got the whole page, but the next page is not interesting, | |
1249 | # break out early as well | |
1250 | if end == nextfirstid: | |
1251 | break | |
1252 | return res | |
81c2f20b PH |
1253 | |
1254 | ||
9c44d242 PH |
1255 | class InAdvancePagedList(PagedList): |
1256 | def __init__(self, pagefunc, pagecount, pagesize): | |
1257 | self._pagefunc = pagefunc | |
1258 | self._pagecount = pagecount | |
1259 | self._pagesize = pagesize | |
1260 | ||
1261 | def getslice(self, start=0, end=None): | |
1262 | res = [] | |
1263 | start_page = start // self._pagesize | |
1264 | end_page = ( | |
1265 | self._pagecount if end is None else (end // self._pagesize + 1)) | |
1266 | skip_elems = start - start_page * self._pagesize | |
1267 | only_more = None if end is None else end - start | |
1268 | for pagenum in range(start_page, end_page): | |
1269 | page = list(self._pagefunc(pagenum)) | |
1270 | if skip_elems: | |
1271 | page = page[skip_elems:] | |
1272 | skip_elems = None | |
1273 | if only_more is not None: | |
1274 | if len(page) < only_more: | |
1275 | only_more -= len(page) | |
1276 | else: | |
1277 | page = page[:only_more] | |
1278 | res.extend(page) | |
1279 | break | |
1280 | res.extend(page) | |
1281 | return res | |
1282 | ||
1283 | ||
81c2f20b | 1284 | def uppercase_escape(s): |
676eb3f2 | 1285 | unicode_escape = codecs.getdecoder('unicode_escape') |
81c2f20b | 1286 | return re.sub( |
a612753d | 1287 | r'\\U[0-9a-fA-F]{8}', |
676eb3f2 PH |
1288 | lambda m: unicode_escape(m.group(0))[0], |
1289 | s) | |
b53466e1 | 1290 | |
d05cfe06 S |
1291 | |
1292 | def escape_rfc3986(s): | |
1293 | """Escape non-ASCII characters as suggested by RFC 3986""" | |
1294 | if sys.version_info < (3, 0) and isinstance(s, unicode): | |
1295 | s = s.encode('utf-8') | |
ecc0c5ee | 1296 | return compat_urllib_parse.quote(s, b"%/;:@&=+$,!~*'()?#[]") |
d05cfe06 S |
1297 | |
1298 | ||
1299 | def escape_url(url): | |
1300 | """Escape URL as suggested by RFC 3986""" | |
1301 | url_parsed = compat_urllib_parse_urlparse(url) | |
1302 | return url_parsed._replace( | |
1303 | path=escape_rfc3986(url_parsed.path), | |
1304 | params=escape_rfc3986(url_parsed.params), | |
1305 | query=escape_rfc3986(url_parsed.query), | |
1306 | fragment=escape_rfc3986(url_parsed.fragment) | |
1307 | ).geturl() | |
1308 | ||
b53466e1 | 1309 | try: |
28e614de | 1310 | struct.pack('!I', 0) |
b53466e1 PH |
1311 | except TypeError: |
1312 | # In Python 2.6 (and some 2.7 versions), struct requires a bytes argument | |
1313 | def struct_pack(spec, *args): | |
1314 | if isinstance(spec, compat_str): | |
1315 | spec = spec.encode('ascii') | |
1316 | return struct.pack(spec, *args) | |
1317 | ||
1318 | def struct_unpack(spec, *args): | |
1319 | if isinstance(spec, compat_str): | |
1320 | spec = spec.encode('ascii') | |
1321 | return struct.unpack(spec, *args) | |
1322 | else: | |
1323 | struct_pack = struct.pack | |
1324 | struct_unpack = struct.unpack | |
62e609ab PH |
1325 | |
1326 | ||
1327 | def read_batch_urls(batch_fd): | |
1328 | def fixup(url): | |
1329 | if not isinstance(url, compat_str): | |
1330 | url = url.decode('utf-8', 'replace') | |
28e614de | 1331 | BOM_UTF8 = '\xef\xbb\xbf' |
62e609ab PH |
1332 | if url.startswith(BOM_UTF8): |
1333 | url = url[len(BOM_UTF8):] | |
1334 | url = url.strip() | |
1335 | if url.startswith(('#', ';', ']')): | |
1336 | return False | |
1337 | return url | |
1338 | ||
1339 | with contextlib.closing(batch_fd) as fd: | |
1340 | return [url for url in map(fixup, fd) if url] | |
b74fa8cd JMF |
1341 | |
1342 | ||
1343 | def urlencode_postdata(*args, **kargs): | |
1344 | return compat_urllib_parse.urlencode(*args, **kargs).encode('ascii') | |
bcf89ce6 PH |
1345 | |
1346 | ||
0990305d PH |
1347 | try: |
1348 | etree_iter = xml.etree.ElementTree.Element.iter | |
1349 | except AttributeError: # Python <=2.6 | |
1350 | etree_iter = lambda n: n.findall('.//*') | |
1351 | ||
1352 | ||
bcf89ce6 PH |
1353 | def parse_xml(s): |
1354 | class TreeBuilder(xml.etree.ElementTree.TreeBuilder): | |
1355 | def doctype(self, name, pubid, system): | |
1356 | pass # Ignore doctypes | |
1357 | ||
1358 | parser = xml.etree.ElementTree.XMLParser(target=TreeBuilder()) | |
1359 | kwargs = {'parser': parser} if sys.version_info >= (2, 7) else {} | |
0990305d PH |
1360 | tree = xml.etree.ElementTree.XML(s.encode('utf-8'), **kwargs) |
1361 | # Fix up XML parser in Python 2.x | |
1362 | if sys.version_info < (3, 0): | |
1363 | for n in etree_iter(tree): | |
1364 | if n.text is not None: | |
1365 | if not isinstance(n.text, compat_str): | |
1366 | n.text = n.text.decode('utf-8') | |
1367 | return tree | |
e68301af PH |
1368 | |
1369 | ||
a1a530b0 PH |
1370 | US_RATINGS = { |
1371 | 'G': 0, | |
1372 | 'PG': 10, | |
1373 | 'PG-13': 13, | |
1374 | 'R': 16, | |
1375 | 'NC': 18, | |
1376 | } | |
fac55558 PH |
1377 | |
1378 | ||
146c80e2 S |
1379 | def parse_age_limit(s): |
1380 | if s is None: | |
d838b1bd | 1381 | return None |
146c80e2 | 1382 | m = re.match(r'^(?P<age>\d{1,2})\+?$', s) |
d838b1bd | 1383 | return int(m.group('age')) if m else US_RATINGS.get(s, None) |
146c80e2 S |
1384 | |
1385 | ||
fac55558 | 1386 | def strip_jsonp(code): |
609a61e3 PH |
1387 | return re.sub( |
1388 | r'(?s)^[a-zA-Z0-9_]+\s*\(\s*(.*)\);?\s*?(?://[^\n]*)*$', r'\1', code) | |
478c2c61 PH |
1389 | |
1390 | ||
e05f6939 PH |
1391 | def js_to_json(code): |
1392 | def fix_kv(m): | |
e7b6d122 PH |
1393 | v = m.group(0) |
1394 | if v in ('true', 'false', 'null'): | |
1395 | return v | |
1396 | if v.startswith('"'): | |
1397 | return v | |
1398 | if v.startswith("'"): | |
1399 | v = v[1:-1] | |
1400 | v = re.sub(r"\\\\|\\'|\"", lambda m: { | |
1401 | '\\\\': '\\\\', | |
1402 | "\\'": "'", | |
1403 | '"': '\\"', | |
1404 | }[m.group(0)], v) | |
1405 | return '"%s"' % v | |
e05f6939 PH |
1406 | |
1407 | res = re.sub(r'''(?x) | |
e7b6d122 PH |
1408 | "(?:[^"\\]*(?:\\\\|\\")?)*"| |
1409 | '(?:[^'\\]*(?:\\\\|\\')?)*'| | |
1410 | [a-zA-Z_][a-zA-Z_0-9]* | |
e05f6939 PH |
1411 | ''', fix_kv, code) |
1412 | res = re.sub(r',(\s*\])', lambda m: m.group(1), res) | |
1413 | return res | |
1414 | ||
1415 | ||
478c2c61 PH |
1416 | def qualities(quality_ids): |
1417 | """ Get a numeric quality value out of a list of possible values """ | |
1418 | def q(qid): | |
1419 | try: | |
1420 | return quality_ids.index(qid) | |
1421 | except ValueError: | |
1422 | return -1 | |
1423 | return q | |
1424 | ||
acd69589 PH |
1425 | |
1426 | DEFAULT_OUTTMPL = '%(title)s-%(id)s.%(ext)s' | |
0a871f68 | 1427 | |
a020a0dc PH |
1428 | |
1429 | def limit_length(s, length): | |
1430 | """ Add ellipses to overly long strings """ | |
1431 | if s is None: | |
1432 | return None | |
1433 | ELLIPSES = '...' | |
1434 | if len(s) > length: | |
1435 | return s[:length - len(ELLIPSES)] + ELLIPSES | |
1436 | return s | |
48844745 PH |
1437 | |
1438 | ||
1439 | def version_tuple(v): | |
1440 | return [int(e) for e in v.split('.')] | |
1441 | ||
1442 | ||
1443 | def is_outdated_version(version, limit, assume_new=True): | |
1444 | if not version: | |
1445 | return not assume_new | |
1446 | try: | |
1447 | return version_tuple(version) < version_tuple(limit) | |
1448 | except ValueError: | |
1449 | return not assume_new | |
732ea2f0 PH |
1450 | |
1451 | ||
1452 | def ytdl_is_updateable(): | |
1453 | """ Returns if youtube-dl can be updated with -U """ | |
1454 | from zipimport import zipimporter | |
1455 | ||
1456 | return isinstance(globals().get('__loader__'), zipimporter) or hasattr(sys, 'frozen') | |
7d4111ed PH |
1457 | |
1458 | ||
1459 | def args_to_str(args): | |
1460 | # Get a short string representation for a subprocess command | |
1461 | return ' '.join(shlex_quote(a) for a in args) |