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