You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1639 lines
51 KiB

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