_ Git - youtube-dl/blob - youtube_dl/utils.py

   1 #!/usr/bin/env python
   2 # coding: utf-8
   3
   4 from __future__ import unicode_literals
   5
   6 import base64
   7 import binascii
   8 import calendar
   9 import codecs
  10 import contextlib
  11 import ctypes
  12 import datetime
  13 import email.utils
  14 import email.header
  15 import errno
  16 import functools
  17 import gzip
  18 import io
  19 import itertools
  20 import json
  21 import locale
  22 import math
  23 import operator
  24 import os
  25 import platform
  26 import random
  27 import re
  28 import socket
  29 import ssl
  30 import subprocess
  31 import sys
  32 import tempfile
  33 import traceback
  34 import xml.etree.ElementTree
  35 import zlib
  36
  37 from .compat import (
  38     compat_HTMLParseError,
  39     compat_HTMLParser,
  40     compat_basestring,
  41     compat_chr,
  42     compat_etree_fromstring,
  43     compat_expanduser,
  44     compat_html_entities,
  45     compat_html_entities_html5,
  46     compat_http_client,
  47     compat_kwargs,
  48     compat_os_name,
  49     compat_parse_qs,
  50     compat_shlex_quote,
  51     compat_socket_create_connection,
  52     compat_str,
  53     compat_struct_pack,
  54     compat_struct_unpack,
  55     compat_urllib_error,
  56     compat_urllib_parse,
  57     compat_urllib_parse_urlencode,
  58     compat_urllib_parse_urlparse,
  59     compat_urllib_parse_unquote_plus,
  60     compat_urllib_request,
  61     compat_urlparse,
  62     compat_xpath,
  63 )
  64
  65 from .socks import (
  66     ProxyType,
  67     sockssocket,
  68 )
  69
  70
  71 def register_socks_protocols():
  72     # "Register" SOCKS protocols
  73     # In Python < 2.6.5, urlsplit() suffers from bug https://bugs.python.org/issue7904
  74     # URLs with protocols not in urlparse.uses_netloc are not handled correctly
  75     for scheme in ('socks', 'socks4', 'socks4a', 'socks5'):
  76         if scheme not in compat_urlparse.uses_netloc:
  77             compat_urlparse.uses_netloc.append(scheme)
  78
  79
  80 # This is not clearly defined otherwise
  81 compiled_regex_type = type(re.compile(''))
  82
  83 std_headers = {
  84     'User-Agent': 'Mozilla/5.0 (X11; Linux x86_64; rv:10.0) Gecko/20150101 Firefox/47.0 (Chrome)',
  85     'Accept-Charset': 'ISO-8859-1,utf-8;q=0.7,*;q=0.7',
  86     'Accept': 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8',
  87     'Accept-Encoding': 'gzip, deflate',
  88     'Accept-Language': 'en-us,en;q=0.5',
  89 }
  90
  91
  92 USER_AGENTS = {
  93     'Safari': 'Mozilla/5.0 (X11; Linux x86_64; rv:10.0) AppleWebKit/533.20.25 (KHTML, like Gecko) Version/5.0.4 Safari/533.20.27',
  94 }
  95
  96
  97 NO_DEFAULT = object()
  98
  99 ENGLISH_MONTH_NAMES = [
 100     'January', 'February', 'March', 'April', 'May', 'June',
 101     'July', 'August', 'September', 'October', 'November', 'December']
 102
 103 MONTH_NAMES = {
 104     'en': ENGLISH_MONTH_NAMES,
 105     'fr': [
 106         'janvier', 'février', 'mars', 'avril', 'mai', 'juin',
 107         'juillet', 'août', 'septembre', 'octobre', 'novembre', 'décembre'],
 108 }
 109
 110 KNOWN_EXTENSIONS = (
 111     'mp4', 'm4a', 'm4p', 'm4b', 'm4r', 'm4v', 'aac',
 112     'flv', 'f4v', 'f4a', 'f4b',
 113     'webm', 'ogg', 'ogv', 'oga', 'ogx', 'spx', 'opus',
 114     'mkv', 'mka', 'mk3d',
 115     'avi', 'divx',
 116     'mov',
 117     'asf', 'wmv', 'wma',
 118     '3gp', '3g2',
 119     'mp3',
 120     'flac',
 121     'ape',
 122     'wav',
 123     'f4f', 'f4m', 'm3u8', 'smil')
 124
 125 # needed for sanitizing filenames in restricted mode
 126 ACCENT_CHARS = dict(zip('ÂÃÄÀÁÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖŐØŒÙÚÛÜŰÝÞßàáâãäåæçèéêëìíîïðñòóôõöőøœùúûüűýþÿ',
 127                         itertools.chain('AAAAAA', ['AE'], 'CEEEEIIIIDNOOOOOOO', ['OE'], 'UUUUUYP', ['ss'],
 128                                         'aaaaaa', ['ae'], 'ceeeeiiiionooooooo', ['oe'], 'uuuuuypy')))
 129
 130 DATE_FORMATS = (
 131     '%d %B %Y',
 132     '%d %b %Y',
 133     '%B %d %Y',
 134     '%B %dst %Y',
 135     '%B %dnd %Y',
 136     '%B %dth %Y',
 137     '%b %d %Y',
 138     '%b %dst %Y',
 139     '%b %dnd %Y',
 140     '%b %dth %Y',
 141     '%b %dst %Y %I:%M',
 142     '%b %dnd %Y %I:%M',
 143     '%b %dth %Y %I:%M',
 144     '%Y %m %d',
 145     '%Y-%m-%d',
 146     '%Y/%m/%d',
 147     '%Y/%m/%d %H:%M',
 148     '%Y/%m/%d %H:%M:%S',
 149     '%Y-%m-%d %H:%M',
 150     '%Y-%m-%d %H:%M:%S',
 151     '%Y-%m-%d %H:%M:%S.%f',
 152     '%d.%m.%Y %H:%M',
 153     '%d.%m.%Y %H.%M',
 154     '%Y-%m-%dT%H:%M:%SZ',
 155     '%Y-%m-%dT%H:%M:%S.%fZ',
 156     '%Y-%m-%dT%H:%M:%S.%f0Z',
 157     '%Y-%m-%dT%H:%M:%S',
 158     '%Y-%m-%dT%H:%M:%S.%f',
 159     '%Y-%m-%dT%H:%M',
 160     '%b %d %Y at %H:%M',
 161     '%b %d %Y at %H:%M:%S',
 162 )
 163
 164 DATE_FORMATS_DAY_FIRST = list(DATE_FORMATS)
 165 DATE_FORMATS_DAY_FIRST.extend([
 166     '%d-%m-%Y',
 167     '%d.%m.%Y',
 168     '%d.%m.%y',
 169     '%d/%m/%Y',
 170     '%d/%m/%y',
 171     '%d/%m/%Y %H:%M:%S',
 172 ])
 173
 174 DATE_FORMATS_MONTH_FIRST = list(DATE_FORMATS)
 175 DATE_FORMATS_MONTH_FIRST.extend([
 176     '%m-%d-%Y',
 177     '%m.%d.%Y',
 178     '%m/%d/%Y',
 179     '%m/%d/%y',
 180     '%m/%d/%Y %H:%M:%S',
 181 ])
 182
 183 PACKED_CODES_RE = r"}\('(.+)',(\d+),(\d+),'([^']+)'\.split\('\|'\)"
 184
 185
 186 def preferredencoding():
 187     """Get preferred encoding.
 188
 189     Returns the best encoding scheme for the system, based on
 190     locale.getpreferredencoding() and some further tweaks.
 191     """
 192     try:
 193         pref = locale.getpreferredencoding()
 194         'TEST'.encode(pref)
 195     except Exception:
 196         pref = 'UTF-8'
 197
 198     return pref
 199
 200
 201 def write_json_file(obj, fn):
 202     """ Encode obj as JSON and write it to fn, atomically if possible """
 203
 204     fn = encodeFilename(fn)
 205     if sys.version_info < (3, 0) and sys.platform != 'win32':
 206         encoding = get_filesystem_encoding()
 207         # os.path.basename returns a bytes object, but NamedTemporaryFile
 208         # will fail if the filename contains non ascii characters unless we
 209         # use a unicode object
 210         path_basename = lambda f: os.path.basename(fn).decode(encoding)
 211         # the same for os.path.dirname
 212         path_dirname = lambda f: os.path.dirname(fn).decode(encoding)
 213     else:
 214         path_basename = os.path.basename
 215         path_dirname = os.path.dirname
 216
 217     args = {
 218         'suffix': '.tmp',
 219         'prefix': path_basename(fn) + '.',
 220         'dir': path_dirname(fn),
 221         'delete': False,
 222     }
 223
 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         args['mode'] = 'wb'
 228     else:
 229         args.update({
 230             'mode': 'w',
 231             'encoding': 'utf-8',
 232         })
 233
 234     tf = tempfile.NamedTemporaryFile(**compat_kwargs(args))
 235
 236     try:
 237         with tf:
 238             json.dump(obj, tf)
 239         if sys.platform == 'win32':
 240             # Need to remove existing file on Windows, else os.rename raises
 241             # WindowsError or FileExistsError.
 242             try:
 243                 os.unlink(fn)
 244             except OSError:
 245                 pass
 246         os.rename(tf.name, fn)
 247     except Exception:
 248         try:
 249             os.remove(tf.name)
 250         except OSError:
 251             pass
 252         raise
 253
 254
 255 if sys.version_info >= (2, 7):
 256     def find_xpath_attr(node, xpath, key, val=None):
 257         """ Find the xpath xpath[@key=val] """
 258         assert re.match(r'^[a-zA-Z_-]+$', key)
 259         expr = xpath + ('[@%s]' % key if val is None else "[@%s='%s']" % (key, val))
 260         return node.find(expr)
 261 else:
 262     def find_xpath_attr(node, xpath, key, val=None):
 263         for f in node.findall(compat_xpath(xpath)):
 264             if key not in f.attrib:
 265                 continue
 266             if val is None or f.attrib.get(key) == val:
 267                 return f
 268         return None
 269
 270 # On python2.6 the xml.etree.ElementTree.Element methods don't support
 271 # the namespace parameter
 272
 273
 274 def xpath_with_ns(path, ns_map):
 275     components = [c.split(':') for c in path.split('/')]
 276     replaced = []
 277     for c in components:
 278         if len(c) == 1:
 279             replaced.append(c[0])
 280         else:
 281             ns, tag = c
 282             replaced.append('{%s}%s' % (ns_map[ns], tag))
 283     return '/'.join(replaced)
 284
 285
 286 def xpath_element(node, xpath, name=None, fatal=False, default=NO_DEFAULT):
 287     def _find_xpath(xpath):
 288         return node.find(compat_xpath(xpath))
 289
 290     if isinstance(xpath, (str, compat_str)):
 291         n = _find_xpath(xpath)
 292     else:
 293         for xp in xpath:
 294             n = _find_xpath(xp)
 295             if n is not None:
 296                 break
 297
 298     if n is None:
 299         if default is not NO_DEFAULT:
 300             return default
 301         elif fatal:
 302             name = xpath if name is None else name
 303             raise ExtractorError('Could not find XML element %s' % name)
 304         else:
 305             return None
 306     return n
 307
 308
 309 def xpath_text(node, xpath, name=None, fatal=False, default=NO_DEFAULT):
 310     n = xpath_element(node, xpath, name, fatal=fatal, default=default)
 311     if n is None or n == default:
 312         return n
 313     if n.text is None:
 314         if default is not NO_DEFAULT:
 315             return default
 316         elif fatal:
 317             name = xpath if name is None else name
 318             raise ExtractorError('Could not find XML element\'s text %s' % name)
 319         else:
 320             return None
 321     return n.text
 322
 323
 324 def xpath_attr(node, xpath, key, name=None, fatal=False, default=NO_DEFAULT):
 325     n = find_xpath_attr(node, xpath, key)
 326     if n is None:
 327         if default is not NO_DEFAULT:
 328             return default
 329         elif fatal:
 330             name = '%s[@%s]' % (xpath, key) if name is None else name
 331             raise ExtractorError('Could not find XML attribute %s' % name)
 332         else:
 333             return None
 334     return n.attrib[key]
 335
 336
 337 def get_element_by_id(id, html):
 338     """Return the content of the tag with the specified ID in the passed HTML document"""
 339     return get_element_by_attribute('id', id, html)
 340
 341
 342 def get_element_by_class(class_name, html):
 343     """Return the content of the first tag with the specified class in the passed HTML document"""
 344     retval = get_elements_by_class(class_name, html)
 345     return retval[0] if retval else None
 346
 347
 348 def get_element_by_attribute(attribute, value, html, escape_value=True):
 349     retval = get_elements_by_attribute(attribute, value, html, escape_value)
 350     return retval[0] if retval else None
 351
 352
 353 def get_elements_by_class(class_name, html):
 354     """Return the content of all tags with the specified class in the passed HTML document as a list"""
 355     return get_elements_by_attribute(
 356         'class', r'[^\'"]*\b%s\b[^\'"]*' % re.escape(class_name),
 357         html, escape_value=False)
 358
 359
 360 def get_elements_by_attribute(attribute, value, html, escape_value=True):
 361     """Return the content of the tag with the specified attribute in the passed HTML document"""
 362
 363     value = re.escape(value) if escape_value else value
 364
 365     retlist = []
 366     for m in re.finditer(r'''(?xs)
 367         <([a-zA-Z0-9:._-]+)
 368          (?:\s+[a-zA-Z0-9:._-]+(?:=[a-zA-Z0-9:._-]*|="[^"]*"|='[^']*'|))*?
 369          \s+%s=['"]?%s['"]?
 370          (?:\s+[a-zA-Z0-9:._-]+(?:=[a-zA-Z0-9:._-]*|="[^"]*"|='[^']*'|))*?
 371         \s*>
 372         (?P<content>.*?)
 373         </\1>
 374     ''' % (re.escape(attribute), value), html):
 375         res = m.group('content')
 376
 377         if res.startswith('"') or res.startswith("'"):
 378             res = res[1:-1]
 379
 380         retlist.append(unescapeHTML(res))
 381
 382     return retlist
 383
 384
 385 class HTMLAttributeParser(compat_HTMLParser):
 386     """Trivial HTML parser to gather the attributes for a single element"""
 387     def __init__(self):
 388         self.attrs = {}
 389         compat_HTMLParser.__init__(self)
 390
 391     def handle_starttag(self, tag, attrs):
 392         self.attrs = dict(attrs)
 393
 394
 395 def extract_attributes(html_element):
 396     """Given a string for an HTML element such as
 397     <el
 398          a="foo" B="bar" c="&98;az" d=boz
 399          empty= noval entity="&amp;"
 400          sq='"' dq="'"
 401     >
 402     Decode and return a dictionary of attributes.
 403     {
 404         'a': 'foo', 'b': 'bar', c: 'baz', d: 'boz',
 405         'empty': '', 'noval': None, 'entity': '&',
 406         'sq': '"', 'dq': '\''
 407     }.
 408     NB HTMLParser is stricter in Python 2.6 & 3.2 than in later versions,
 409     but the cases in the unit test will work for all of 2.6, 2.7, 3.2-3.5.
 410     """
 411     parser = HTMLAttributeParser()
 412     try:
 413         parser.feed(html_element)
 414         parser.close()
 415     # Older Python may throw HTMLParseError in case of malformed HTML
 416     except compat_HTMLParseError:
 417         pass
 418     return parser.attrs
 419
 420
 421 def clean_html(html):
 422     """Clean an HTML snippet into a readable string"""
 423
 424     if html is None:  # Convenience for sanitizing descriptions etc.
 425         return html
 426
 427     # Newline vs <br />
 428     html = html.replace('\n', ' ')
 429     html = re.sub(r'(?u)\s*<\s*br\s*/?\s*>\s*', '\n', html)
 430     html = re.sub(r'(?u)<\s*/\s*p\s*>\s*<\s*p[^>]*>', '\n', html)
 431     # Strip html tags
 432     html = re.sub('<.*?>', '', html)
 433     # Replace html entities
 434     html = unescapeHTML(html)
 435     return html.strip()
 436
 437
 438 def sanitize_open(filename, open_mode):
 439     """Try to open the given filename, and slightly tweak it if this fails.
 440
 441     Attempts to open the given filename. If this fails, it tries to change
 442     the filename slightly, step by step, until it's either able to open it
 443     or it fails and raises a final exception, like the standard open()
 444     function.
 445
 446     It returns the tuple (stream, definitive_file_name).
 447     """
 448     try:
 449         if filename == '-':
 450             if sys.platform == 'win32':
 451                 import msvcrt
 452                 msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
 453             return (sys.stdout.buffer if hasattr(sys.stdout, 'buffer') else sys.stdout, filename)
 454         stream = open(encodeFilename(filename), open_mode)
 455         return (stream, filename)
 456     except (IOError, OSError) as err:
 457         if err.errno in (errno.EACCES,):
 458             raise
 459
 460         # In case of error, try to remove win32 forbidden chars
 461         alt_filename = sanitize_path(filename)
 462         if alt_filename == filename:
 463             raise
 464         else:
 465             # An exception here should be caught in the caller
 466             stream = open(encodeFilename(alt_filename), open_mode)
 467             return (stream, alt_filename)
 468
 469
 470 def timeconvert(timestr):
 471     """Convert RFC 2822 defined time string into system timestamp"""
 472     timestamp = None
 473     timetuple = email.utils.parsedate_tz(timestr)
 474     if timetuple is not None:
 475         timestamp = email.utils.mktime_tz(timetuple)
 476     return timestamp
 477
 478
 479 def sanitize_filename(s, restricted=False, is_id=False):
 480     """Sanitizes a string so it could be used as part of a filename.
 481     If restricted is set, use a stricter subset of allowed characters.
 482     Set is_id if this is not an arbitrary string, but an ID that should be kept
 483     if possible.
 484     """
 485     def replace_insane(char):
 486         if restricted and char in ACCENT_CHARS:
 487             return ACCENT_CHARS[char]
 488         if char == '?' or ord(char) < 32 or ord(char) == 127:
 489             return ''
 490         elif char == '"':
 491             return '' if restricted else '\''
 492         elif char == ':':
 493             return '_-' if restricted else ' -'
 494         elif char in '\\/|*<>':
 495             return '_'
 496         if restricted and (char in '!&\'()[]{}$;`^,#' or char.isspace()):
 497             return '_'
 498         if restricted and ord(char) > 127:
 499             return '_'
 500         return char
 501
 502     # Handle timestamps
 503     s = re.sub(r'[0-9]+(?::[0-9]+)+', lambda m: m.group(0).replace(':', '_'), s)
 504     result = ''.join(map(replace_insane, s))
 505     if not is_id:
 506         while '__' in result:
 507             result = result.replace('__', '_')
 508         result = result.strip('_')
 509         # Common case of "Foreign band name - English song title"
 510         if restricted and result.startswith('-_'):
 511             result = result[2:]
 512         if result.startswith('-'):
 513             result = '_' + result[len('-'):]
 514         result = result.lstrip('.')
 515         if not result:
 516             result = '_'
 517     return result
 518
 519
 520 def sanitize_path(s):
 521     """Sanitizes and normalizes path on Windows"""
 522     if sys.platform != 'win32':
 523         return s
 524     drive_or_unc, _ = os.path.splitdrive(s)
 525     if sys.version_info < (2, 7) and not drive_or_unc:
 526         drive_or_unc, _ = os.path.splitunc(s)
 527     norm_path = os.path.normpath(remove_start(s, drive_or_unc)).split(os.path.sep)
 528     if drive_or_unc:
 529         norm_path.pop(0)
 530     sanitized_path = [
 531         path_part if path_part in ['.', '..'] else re.sub(r'(?:[/<>:"\|\\?\*]|[\s.]$)', '#', path_part)
 532         for path_part in norm_path]
 533     if drive_or_unc:
 534         sanitized_path.insert(0, drive_or_unc + os.path.sep)
 535     return os.path.join(*sanitized_path)
 536
 537
 538 # Prepend protocol-less URLs with `http:` scheme in order to mitigate the number of
 539 # unwanted failures due to missing protocol
 540 def sanitize_url(url):
 541     return 'http:%s' % url if url.startswith('//') else url
 542
 543
 544 def sanitized_Request(url, *args, **kwargs):
 545     return compat_urllib_request.Request(sanitize_url(url), *args, **kwargs)
 546
 547
 548 def expand_path(s):
 549     """Expand shell variables and ~"""
 550     return os.path.expandvars(compat_expanduser(s))
 551
 552
 553 def orderedSet(iterable):
 554     """ Remove all duplicates from the input iterable """
 555     res = []
 556     for el in iterable:
 557         if el not in res:
 558             res.append(el)
 559     return res
 560
 561
 562 def _htmlentity_transform(entity_with_semicolon):
 563     """Transforms an HTML entity to a character."""
 564     entity = entity_with_semicolon[:-1]
 565
 566     # Known non-numeric HTML entity
 567     if entity in compat_html_entities.name2codepoint:
 568         return compat_chr(compat_html_entities.name2codepoint[entity])
 569
 570     # TODO: HTML5 allows entities without a semicolon. For example,
 571     # '&Eacuteric' should be decoded as 'Éric'.
 572     if entity_with_semicolon in compat_html_entities_html5:
 573         return compat_html_entities_html5[entity_with_semicolon]
 574
 575     mobj = re.match(r'#(x[0-9a-fA-F]+|[0-9]+)', entity)
 576     if mobj is not None:
 577         numstr = mobj.group(1)
 578         if numstr.startswith('x'):
 579             base = 16
 580             numstr = '0%s' % numstr
 581         else:
 582             base = 10
 583         # See https://github.com/rg3/youtube-dl/issues/7518
 584         try:
 585             return compat_chr(int(numstr, base))
 586         except ValueError:
 587             pass
 588
 589     # Unknown entity in name, return its literal representation
 590     return '&%s;' % entity
 591
 592
 593 def unescapeHTML(s):
 594     if s is None:
 595         return None
 596     assert type(s) == compat_str
 597
 598     return re.sub(
 599         r'&([^;]+;)', lambda m: _htmlentity_transform(m.group(1)), s)
 600
 601
 602 def get_subprocess_encoding():
 603     if sys.platform == 'win32' and sys.getwindowsversion()[0] >= 5:
 604         # For subprocess calls, encode with locale encoding
 605         # Refer to http://stackoverflow.com/a/9951851/35070
 606         encoding = preferredencoding()
 607     else:
 608         encoding = sys.getfilesystemencoding()
 609     if encoding is None:
 610         encoding = 'utf-8'
 611     return encoding
 612
 613
 614 def encodeFilename(s, for_subprocess=False):
 615     """
 616     @param s The name of the file
 617     """
 618
 619     assert type(s) == compat_str
 620
 621     # Python 3 has a Unicode API
 622     if sys.version_info >= (3, 0):
 623         return s
 624
 625     # Pass '' directly to use Unicode APIs on Windows 2000 and up
 626     # (Detecting Windows NT 4 is tricky because 'major >= 4' would
 627     # match Windows 9x series as well. Besides, NT 4 is obsolete.)
 628     if not for_subprocess and sys.platform == 'win32' and sys.getwindowsversion()[0] >= 5:
 629         return s
 630
 631     # Jython assumes filenames are Unicode strings though reported as Python 2.x compatible
 632     if sys.platform.startswith('java'):
 633         return s
 634
 635     return s.encode(get_subprocess_encoding(), 'ignore')
 636
 637
 638 def decodeFilename(b, for_subprocess=False):
 639
 640     if sys.version_info >= (3, 0):
 641         return b
 642
 643     if not isinstance(b, bytes):
 644         return b
 645
 646     return b.decode(get_subprocess_encoding(), 'ignore')
 647
 648
 649 def encodeArgument(s):
 650     if not isinstance(s, compat_str):
 651         # Legacy code that uses byte strings
 652         # Uncomment the following line after fixing all post processors
 653         # assert False, 'Internal error: %r should be of type %r, is %r' % (s, compat_str, type(s))
 654         s = s.decode('ascii')
 655     return encodeFilename(s, True)
 656
 657
 658 def decodeArgument(b):
 659     return decodeFilename(b, True)
 660
 661
 662 def decodeOption(optval):
 663     if optval is None:
 664         return optval
 665     if isinstance(optval, bytes):
 666         optval = optval.decode(preferredencoding())
 667
 668     assert isinstance(optval, compat_str)
 669     return optval
 670
 671
 672 def formatSeconds(secs):
 673     if secs > 3600:
 674         return '%d:%02d:%02d' % (secs // 3600, (secs % 3600) // 60, secs % 60)
 675     elif secs > 60:
 676         return '%d:%02d' % (secs // 60, secs % 60)
 677     else:
 678         return '%d' % secs
 679
 680
 681 def make_HTTPS_handler(params, **kwargs):
 682     opts_no_check_certificate = params.get('nocheckcertificate', False)
 683     if hasattr(ssl, 'create_default_context'):  # Python >= 3.4 or 2.7.9
 684         context = ssl.create_default_context(ssl.Purpose.SERVER_AUTH)
 685         if opts_no_check_certificate:
 686             context.check_hostname = False
 687             context.verify_mode = ssl.CERT_NONE
 688         try:
 689             return YoutubeDLHTTPSHandler(params, context=context, **kwargs)
 690         except TypeError:
 691             # Python 2.7.8
 692             # (create_default_context present but HTTPSHandler has no context=)
 693             pass
 694
 695     if sys.version_info < (3, 2):
 696         return YoutubeDLHTTPSHandler(params, **kwargs)
 697     else:  # Python < 3.4
 698         context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
 699         context.verify_mode = (ssl.CERT_NONE
 700                                if opts_no_check_certificate
 701                                else ssl.CERT_REQUIRED)
 702         context.set_default_verify_paths()
 703         return YoutubeDLHTTPSHandler(params, context=context, **kwargs)
 704
 705
 706 def bug_reports_message():
 707     if ytdl_is_updateable():
 708         update_cmd = 'type  youtube-dl -U  to update'
 709     else:
 710         update_cmd = 'see  https://yt-dl.org/update  on how to update'
 711     msg = '; please report this issue on https://yt-dl.org/bug .'
 712     msg += ' Make sure you are using the latest version; %s.' % update_cmd
 713     msg += ' Be sure to call youtube-dl with the --verbose flag and include its complete output.'
 714     return msg
 715
 716
 717 class YoutubeDLError(Exception):
 718     """Base exception for YoutubeDL errors."""
 719     pass
 720
 721
 722 class ExtractorError(YoutubeDLError):
 723     """Error during info extraction."""
 724
 725     def __init__(self, msg, tb=None, expected=False, cause=None, video_id=None):
 726         """ tb, if given, is the original traceback (so that it can be printed out).
 727         If expected is set, this is a normal error message and most likely not a bug in youtube-dl.
 728         """
 729
 730         if sys.exc_info()[0] in (compat_urllib_error.URLError, socket.timeout, UnavailableVideoError):
 731             expected = True
 732         if video_id is not None:
 733             msg = video_id + ': ' + msg
 734         if cause:
 735             msg += ' (caused by %r)' % cause
 736         if not expected:
 737             msg += bug_reports_message()
 738         super(ExtractorError, self).__init__(msg)
 739
 740         self.traceback = tb
 741         self.exc_info = sys.exc_info()  # preserve original exception
 742         self.cause = cause
 743         self.video_id = video_id
 744
 745     def format_traceback(self):
 746         if self.traceback is None:
 747             return None
 748         return ''.join(traceback.format_tb(self.traceback))
 749
 750
 751 class UnsupportedError(ExtractorError):
 752     def __init__(self, url):
 753         super(UnsupportedError, self).__init__(
 754             'Unsupported URL: %s' % url, expected=True)
 755         self.url = url
 756
 757
 758 class RegexNotFoundError(ExtractorError):
 759     """Error when a regex didn't match"""
 760     pass
 761
 762
 763 class GeoRestrictedError(ExtractorError):
 764     """Geographic restriction Error exception.
 765
 766     This exception may be thrown when a video is not available from your
 767     geographic location due to geographic restrictions imposed by a website.
 768     """
 769     def __init__(self, msg, countries=None):
 770         super(GeoRestrictedError, self).__init__(msg, expected=True)
 771         self.msg = msg
 772         self.countries = countries
 773
 774
 775 class DownloadError(YoutubeDLError):
 776     """Download Error exception.
 777
 778     This exception may be thrown by FileDownloader objects if they are not
 779     configured to continue on errors. They will contain the appropriate
 780     error message.
 781     """
 782
 783     def __init__(self, msg, exc_info=None):
 784         """ exc_info, if given, is the original exception that caused the trouble (as returned by sys.exc_info()). """
 785         super(DownloadError, self).__init__(msg)
 786         self.exc_info = exc_info
 787
 788
 789 class SameFileError(YoutubeDLError):
 790     """Same File exception.
 791
 792     This exception will be thrown by FileDownloader objects if they detect
 793     multiple files would have to be downloaded to the same file on disk.
 794     """
 795     pass
 796
 797
 798 class PostProcessingError(YoutubeDLError):
 799     """Post Processing exception.
 800
 801     This exception may be raised by PostProcessor's .run() method to
 802     indicate an error in the postprocessing task.
 803     """
 804
 805     def __init__(self, msg):
 806         super(PostProcessingError, self).__init__(msg)
 807         self.msg = msg
 808
 809
 810 class MaxDownloadsReached(YoutubeDLError):
 811     """ --max-downloads limit has been reached. """
 812     pass
 813
 814
 815 class UnavailableVideoError(YoutubeDLError):
 816     """Unavailable Format exception.
 817
 818     This exception will be thrown when a video is requested
 819     in a format that is not available for that video.
 820     """
 821     pass
 822
 823
 824 class ContentTooShortError(YoutubeDLError):
 825     """Content Too Short exception.
 826
 827     This exception may be raised by FileDownloader objects when a file they
 828     download is too small for what the server announced first, indicating
 829     the connection was probably interrupted.
 830     """
 831
 832     def __init__(self, downloaded, expected):
 833         super(ContentTooShortError, self).__init__(
 834             'Downloaded {0} bytes, expected {1} bytes'.format(downloaded, expected)
 835         )
 836         # Both in bytes
 837         self.downloaded = downloaded
 838         self.expected = expected
 839
 840
 841 class XAttrMetadataError(YoutubeDLError):
 842     def __init__(self, code=None, msg='Unknown error'):
 843         super(XAttrMetadataError, self).__init__(msg)
 844         self.code = code
 845         self.msg = msg
 846
 847         # Parsing code and msg
 848         if (self.code in (errno.ENOSPC, errno.EDQUOT) or
 849                 'No space left' in self.msg or 'Disk quota excedded' in self.msg):
 850             self.reason = 'NO_SPACE'
 851         elif self.code == errno.E2BIG or 'Argument list too long' in self.msg:
 852             self.reason = 'VALUE_TOO_LONG'
 853         else:
 854             self.reason = 'NOT_SUPPORTED'
 855
 856
 857 class XAttrUnavailableError(YoutubeDLError):
 858     pass
 859
 860
 861 def _create_http_connection(ydl_handler, http_class, is_https, *args, **kwargs):
 862     # Working around python 2 bug (see http://bugs.python.org/issue17849) by limiting
 863     # expected HTTP responses to meet HTTP/1.0 or later (see also
 864     # https://github.com/rg3/youtube-dl/issues/6727)
 865     if sys.version_info < (3, 0):
 866         kwargs[b'strict'] = True
 867     hc = http_class(*args, **kwargs)
 868     source_address = ydl_handler._params.get('source_address')
 869     if source_address is not None:
 870         sa = (source_address, 0)
 871         if hasattr(hc, 'source_address'):  # Python 2.7+
 872             hc.source_address = sa
 873         else:  # Python 2.6
 874             def _hc_connect(self, *args, **kwargs):
 875                 sock = compat_socket_create_connection(
 876                     (self.host, self.port), self.timeout, sa)
 877                 if is_https:
 878                     self.sock = ssl.wrap_socket(
 879                         sock, self.key_file, self.cert_file,
 880                         ssl_version=ssl.PROTOCOL_TLSv1)
 881                 else:
 882                     self.sock = sock
 883             hc.connect = functools.partial(_hc_connect, hc)
 884
 885     return hc
 886
 887
 888 def handle_youtubedl_headers(headers):
 889     filtered_headers = headers
 890
 891     if 'Youtubedl-no-compression' in filtered_headers:
 892         filtered_headers = dict((k, v) for k, v in filtered_headers.items() if k.lower() != 'accept-encoding')
 893         del filtered_headers['Youtubedl-no-compression']
 894
 895     return filtered_headers
 896
 897
 898 class YoutubeDLHandler(compat_urllib_request.HTTPHandler):
 899     """Handler for HTTP requests and responses.
 900
 901     This class, when installed with an OpenerDirector, automatically adds
 902     the standard headers to every HTTP request and handles gzipped and
 903     deflated responses from web servers. If compression is to be avoided in
 904     a particular request, the original request in the program code only has
 905     to include the HTTP header "Youtubedl-no-compression", which will be
 906     removed before making the real request.
 907
 908     Part of this code was copied from:
 909
 910     http://techknack.net/python-urllib2-handlers/
 911
 912     Andrew Rowls, the author of that code, agreed to release it to the
 913     public domain.
 914     """
 915
 916     def __init__(self, params, *args, **kwargs):
 917         compat_urllib_request.HTTPHandler.__init__(self, *args, **kwargs)
 918         self._params = params
 919
 920     def http_open(self, req):
 921         conn_class = compat_http_client.HTTPConnection
 922
 923         socks_proxy = req.headers.get('Ytdl-socks-proxy')
 924         if socks_proxy:
 925             conn_class = make_socks_conn_class(conn_class, socks_proxy)
 926             del req.headers['Ytdl-socks-proxy']
 927
 928         return self.do_open(functools.partial(
 929             _create_http_connection, self, conn_class, False),
 930             req)
 931
 932     @staticmethod
 933     def deflate(data):
 934         try:
 935             return zlib.decompress(data, -zlib.MAX_WBITS)
 936         except zlib.error:
 937             return zlib.decompress(data)
 938
 939     def http_request(self, req):
 940         # According to RFC 3986, URLs can not contain non-ASCII characters, however this is not
 941         # always respected by websites, some tend to give out URLs with non percent-encoded
 942         # non-ASCII characters (see telemb.py, ard.py [#3412])
 943         # urllib chokes on URLs with non-ASCII characters (see http://bugs.python.org/issue3991)
 944         # To work around aforementioned issue we will replace request's original URL with
 945         # percent-encoded one
 946         # Since redirects are also affected (e.g. http://www.southpark.de/alle-episoden/s18e09)
 947         # the code of this workaround has been moved here from YoutubeDL.urlopen()
 948         url = req.get_full_url()
 949         url_escaped = escape_url(url)
 950
 951         # Substitute URL if any change after escaping
 952         if url != url_escaped:
 953             req = update_Request(req, url=url_escaped)
 954
 955         for h, v in std_headers.items():
 956             # Capitalize is needed because of Python bug 2275: http://bugs.python.org/issue2275
 957             # The dict keys are capitalized because of this bug by urllib
 958             if h.capitalize() not in req.headers:
 959                 req.add_header(h, v)
 960
 961         req.headers = handle_youtubedl_headers(req.headers)
 962
 963         if sys.version_info < (2, 7) and '#' in req.get_full_url():
 964             # Python 2.6 is brain-dead when it comes to fragments
 965             req._Request__original = req._Request__original.partition('#')[0]
 966             req._Request__r_type = req._Request__r_type.partition('#')[0]
 967
 968         return req
 969
 970     def http_response(self, req, resp):
 971         old_resp = resp
 972         # gzip
 973         if resp.headers.get('Content-encoding', '') == 'gzip':
 974             content = resp.read()
 975             gz = gzip.GzipFile(fileobj=io.BytesIO(content), mode='rb')
 976             try:
 977                 uncompressed = io.BytesIO(gz.read())
 978             except IOError as original_ioerror:
 979                 # There may be junk add the end of the file
 980                 # See http://stackoverflow.com/q/4928560/35070 for details
 981                 for i in range(1, 1024):
 982                     try:
 983                         gz = gzip.GzipFile(fileobj=io.BytesIO(content[:-i]), mode='rb')
 984                         uncompressed = io.BytesIO(gz.read())
 985                     except IOError:
 986                         continue
 987                     break
 988                 else:
 989                     raise original_ioerror
 990             resp = compat_urllib_request.addinfourl(uncompressed, old_resp.headers, old_resp.url, old_resp.code)
 991             resp.msg = old_resp.msg
 992             del resp.headers['Content-encoding']
 993         # deflate
 994         if resp.headers.get('Content-encoding', '') == 'deflate':
 995             gz = io.BytesIO(self.deflate(resp.read()))
 996             resp = compat_urllib_request.addinfourl(gz, old_resp.headers, old_resp.url, old_resp.code)
 997             resp.msg = old_resp.msg
 998             del resp.headers['Content-encoding']
 999         # Percent-encode redirect URL of Location HTTP header to satisfy RFC 3986 (see
1000         # https://github.com/rg3/youtube-dl/issues/6457).
1001         if 300 <= resp.code < 400:
1002             location = resp.headers.get('Location')
1003             if location:
1004                 # As of RFC 2616 default charset is iso-8859-1 that is respected by python 3
1005                 if sys.version_info >= (3, 0):
1006                     location = location.encode('iso-8859-1').decode('utf-8')
1007                 else:
1008                     location = location.decode('utf-8')
1009                 location_escaped = escape_url(location)
1010                 if location != location_escaped:
1011                     del resp.headers['Location']
1012                     if sys.version_info < (3, 0):
1013                         location_escaped = location_escaped.encode('utf-8')
1014                     resp.headers['Location'] = location_escaped
1015         return resp
1016
1017     https_request = http_request
1018     https_response = http_response
1019
1020
1021 def make_socks_conn_class(base_class, socks_proxy):
1022     assert issubclass(base_class, (
1023         compat_http_client.HTTPConnection, compat_http_client.HTTPSConnection))
1024
1025     url_components = compat_urlparse.urlparse(socks_proxy)
1026     if url_components.scheme.lower() == 'socks5':
1027         socks_type = ProxyType.SOCKS5
1028     elif url_components.scheme.lower() in ('socks', 'socks4'):
1029         socks_type = ProxyType.SOCKS4
1030     elif url_components.scheme.lower() == 'socks4a':
1031         socks_type = ProxyType.SOCKS4A
1032
1033     def unquote_if_non_empty(s):
1034         if not s:
1035             return s
1036         return compat_urllib_parse_unquote_plus(s)
1037
1038     proxy_args = (
1039         socks_type,
1040         url_components.hostname, url_components.port or 1080,
1041         True,  # Remote DNS
1042         unquote_if_non_empty(url_components.username),
1043         unquote_if_non_empty(url_components.password),
1044     )
1045
1046     class SocksConnection(base_class):
1047         def connect(self):
1048             self.sock = sockssocket()
1049             self.sock.setproxy(*proxy_args)
1050             if type(self.timeout) in (int, float):
1051                 self.sock.settimeout(self.timeout)
1052             self.sock.connect((self.host, self.port))
1053
1054             if isinstance(self, compat_http_client.HTTPSConnection):
1055                 if hasattr(self, '_context'):  # Python > 2.6
1056                     self.sock = self._context.wrap_socket(
1057                         self.sock, server_hostname=self.host)
1058                 else:
1059                     self.sock = ssl.wrap_socket(self.sock)
1060
1061     return SocksConnection
1062
1063
1064 class YoutubeDLHTTPSHandler(compat_urllib_request.HTTPSHandler):
1065     def __init__(self, params, https_conn_class=None, *args, **kwargs):
1066         compat_urllib_request.HTTPSHandler.__init__(self, *args, **kwargs)
1067         self._https_conn_class = https_conn_class or compat_http_client.HTTPSConnection
1068         self._params = params
1069
1070     def https_open(self, req):
1071         kwargs = {}
1072         conn_class = self._https_conn_class
1073
1074         if hasattr(self, '_context'):  # python > 2.6
1075             kwargs['context'] = self._context
1076         if hasattr(self, '_check_hostname'):  # python 3.x
1077             kwargs['check_hostname'] = self._check_hostname
1078
1079         socks_proxy = req.headers.get('Ytdl-socks-proxy')
1080         if socks_proxy:
1081             conn_class = make_socks_conn_class(conn_class, socks_proxy)
1082             del req.headers['Ytdl-socks-proxy']
1083
1084         return self.do_open(functools.partial(
1085             _create_http_connection, self, conn_class, True),
1086             req, **kwargs)
1087
1088
1089 class YoutubeDLCookieProcessor(compat_urllib_request.HTTPCookieProcessor):
1090     def __init__(self, cookiejar=None):
1091         compat_urllib_request.HTTPCookieProcessor.__init__(self, cookiejar)
1092
1093     def http_response(self, request, response):
1094         # Python 2 will choke on next HTTP request in row if there are non-ASCII
1095         # characters in Set-Cookie HTTP header of last response (see
1096         # https://github.com/rg3/youtube-dl/issues/6769).
1097         # In order to at least prevent crashing we will percent encode Set-Cookie
1098         # header before HTTPCookieProcessor starts processing it.
1099         # if sys.version_info < (3, 0) and response.headers:
1100         #     for set_cookie_header in ('Set-Cookie', 'Set-Cookie2'):
1101         #         set_cookie = response.headers.get(set_cookie_header)
1102         #         if set_cookie:
1103         #             set_cookie_escaped = compat_urllib_parse.quote(set_cookie, b"%/;:@&=+$,!~*'()?#[] ")
1104         #             if set_cookie != set_cookie_escaped:
1105         #                 del response.headers[set_cookie_header]
1106         #                 response.headers[set_cookie_header] = set_cookie_escaped
1107         return compat_urllib_request.HTTPCookieProcessor.http_response(self, request, response)
1108
1109     https_request = compat_urllib_request.HTTPCookieProcessor.http_request
1110     https_response = http_response
1111
1112
1113 def extract_timezone(date_str):
1114     m = re.search(
1115         r'^.{8,}?(?P<tz>Z$| ?(?P<sign>\+|-)(?P<hours>[0-9]{2}):?(?P<minutes>[0-9]{2})$)',
1116         date_str)
1117     if not m:
1118         timezone = datetime.timedelta()
1119     else:
1120         date_str = date_str[:-len(m.group('tz'))]
1121         if not m.group('sign'):
1122             timezone = datetime.timedelta()
1123         else:
1124             sign = 1 if m.group('sign') == '+' else -1
1125             timezone = datetime.timedelta(
1126                 hours=sign * int(m.group('hours')),
1127                 minutes=sign * int(m.group('minutes')))
1128     return timezone, date_str
1129
1130
1131 def parse_iso8601(date_str, delimiter='T', timezone=None):
1132     """ Return a UNIX timestamp from the given date """
1133
1134     if date_str is None:
1135         return None
1136
1137     date_str = re.sub(r'\.[0-9]+', '', date_str)
1138
1139     if timezone is None:
1140         timezone, date_str = extract_timezone(date_str)
1141
1142     try:
1143         date_format = '%Y-%m-%d{0}%H:%M:%S'.format(delimiter)
1144         dt = datetime.datetime.strptime(date_str, date_format) - timezone
1145         return calendar.timegm(dt.timetuple())
1146     except ValueError:
1147         pass
1148
1149
1150 def date_formats(day_first=True):
1151     return DATE_FORMATS_DAY_FIRST if day_first else DATE_FORMATS_MONTH_FIRST
1152
1153
1154 def unified_strdate(date_str, day_first=True):
1155     """Return a string with the date in the format YYYYMMDD"""
1156
1157     if date_str is None:
1158         return None
1159     upload_date = None
1160     # Replace commas
1161     date_str = date_str.replace(',', ' ')
1162     # Remove AM/PM + timezone
1163     date_str = re.sub(r'(?i)\s*(?:AM|PM)(?:\s+[A-Z]+)?', '', date_str)
1164     _, date_str = extract_timezone(date_str)
1165
1166     for expression in date_formats(day_first):
1167         try:
1168             upload_date = datetime.datetime.strptime(date_str, expression).strftime('%Y%m%d')
1169         except ValueError:
1170             pass
1171     if upload_date is None:
1172         timetuple = email.utils.parsedate_tz(date_str)
1173         if timetuple:
1174             try:
1175                 upload_date = datetime.datetime(*timetuple[:6]).strftime('%Y%m%d')
1176             except ValueError:
1177                 pass
1178     if upload_date is not None:
1179         return compat_str(upload_date)
1180
1181
1182 def unified_timestamp(date_str, day_first=True):
1183     if date_str is None:
1184         return None
1185
1186     date_str = re.sub(r'[,|]', '', date_str)
1187
1188     pm_delta = 12 if re.search(r'(?i)PM', date_str) else 0
1189     timezone, date_str = extract_timezone(date_str)
1190
1191     # Remove AM/PM + timezone
1192     date_str = re.sub(r'(?i)\s*(?:AM|PM)(?:\s+[A-Z]+)?', '', date_str)
1193
1194     # Remove unrecognized timezones from ISO 8601 alike timestamps
1195     m = re.search(r'\d{1,2}:\d{1,2}(?:\.\d+)?(?P<tz>\s*[A-Z]+)$', date_str)
1196     if m:
1197         date_str = date_str[:-len(m.group('tz'))]
1198
1199     for expression in date_formats(day_first):
1200         try:
1201             dt = datetime.datetime.strptime(date_str, expression) - timezone + datetime.timedelta(hours=pm_delta)
1202             return calendar.timegm(dt.timetuple())
1203         except ValueError:
1204             pass
1205     timetuple = email.utils.parsedate_tz(date_str)
1206     if timetuple:
1207         return calendar.timegm(timetuple) + pm_delta * 3600
1208
1209
1210 def determine_ext(url, default_ext='unknown_video'):
1211     if url is None:
1212         return default_ext
1213     guess = url.partition('?')[0].rpartition('.')[2]
1214     if re.match(r'^[A-Za-z0-9]+$', guess):
1215         return guess
1216     # Try extract ext from URLs like http://example.com/foo/bar.mp4/?download
1217     elif guess.rstrip('/') in KNOWN_EXTENSIONS:
1218         return guess.rstrip('/')
1219     else:
1220         return default_ext
1221
1222
1223 def subtitles_filename(filename, sub_lang, sub_format):
1224     return filename.rsplit('.', 1)[0] + '.' + sub_lang + '.' + sub_format
1225
1226
1227 def date_from_str(date_str):
1228     """
1229     Return a datetime object from a string in the format YYYYMMDD or
1230     (now|today)[+-][0-9](day|week|month|year)(s)?"""
1231     today = datetime.date.today()
1232     if date_str in ('now', 'today'):
1233         return today
1234     if date_str == 'yesterday':
1235         return today - datetime.timedelta(days=1)
1236     match = re.match(r'(now|today)(?P<sign>[+-])(?P<time>\d+)(?P<unit>day|week|month|year)(s)?', date_str)
1237     if match is not None:
1238         sign = match.group('sign')
1239         time = int(match.group('time'))
1240         if sign == '-':
1241             time = -time
1242         unit = match.group('unit')
1243         # A bad approximation?
1244         if unit == 'month':
1245             unit = 'day'
1246             time *= 30
1247         elif unit == 'year':
1248             unit = 'day'
1249             time *= 365
1250         unit += 's'
1251         delta = datetime.timedelta(**{unit: time})
1252         return today + delta
1253     return datetime.datetime.strptime(date_str, '%Y%m%d').date()
1254
1255
1256 def hyphenate_date(date_str):
1257     """
1258     Convert a date in 'YYYYMMDD' format to 'YYYY-MM-DD' format"""
1259     match = re.match(r'^(\d\d\d\d)(\d\d)(\d\d)$', date_str)
1260     if match is not None:
1261         return '-'.join(match.groups())
1262     else:
1263         return date_str
1264
1265
1266 class DateRange(object):
1267     """Represents a time interval between two dates"""
1268
1269     def __init__(self, start=None, end=None):
1270         """start and end must be strings in the format accepted by date"""
1271         if start is not None:
1272             self.start = date_from_str(start)
1273         else:
1274             self.start = datetime.datetime.min.date()
1275         if end is not None:
1276             self.end = date_from_str(end)
1277         else:
1278             self.end = datetime.datetime.max.date()
1279         if self.start > self.end:
1280             raise ValueError('Date range: "%s" , the start date must be before the end date' % self)
1281
1282     @classmethod
1283     def day(cls, day):
1284         """Returns a range that only contains the given day"""
1285         return cls(day, day)
1286
1287     def __contains__(self, date):
1288         """Check if the date is in the range"""
1289         if not isinstance(date, datetime.date):
1290             date = date_from_str(date)
1291         return self.start <= date <= self.end
1292
1293     def __str__(self):
1294         return '%s - %s' % (self.start.isoformat(), self.end.isoformat())
1295
1296
1297 def platform_name():
1298     """ Returns the platform name as a compat_str """
1299     res = platform.platform()
1300     if isinstance(res, bytes):
1301         res = res.decode(preferredencoding())
1302
1303     assert isinstance(res, compat_str)
1304     return res
1305
1306
1307 def _windows_write_string(s, out):
1308     """ Returns True if the string was written using special methods,
1309     False if it has yet to be written out."""
1310     # Adapted from http://stackoverflow.com/a/3259271/35070
1311
1312     import ctypes
1313     import ctypes.wintypes
1314
1315     WIN_OUTPUT_IDS = {
1316         1: -11,
1317         2: -12,
1318     }
1319
1320     try:
1321         fileno = out.fileno()
1322     except AttributeError:
1323         # If the output stream doesn't have a fileno, it's virtual
1324         return False
1325     except io.UnsupportedOperation:
1326         # Some strange Windows pseudo files?
1327         return False
1328     if fileno not in WIN_OUTPUT_IDS:
1329         return False
1330
1331     GetStdHandle = ctypes.WINFUNCTYPE(
1332         ctypes.wintypes.HANDLE, ctypes.wintypes.DWORD)(
1333         (b'GetStdHandle', ctypes.windll.kernel32))
1334     h = GetStdHandle(WIN_OUTPUT_IDS[fileno])
1335
1336     WriteConsoleW = ctypes.WINFUNCTYPE(
1337         ctypes.wintypes.BOOL, ctypes.wintypes.HANDLE, ctypes.wintypes.LPWSTR,
1338         ctypes.wintypes.DWORD, ctypes.POINTER(ctypes.wintypes.DWORD),
1339         ctypes.wintypes.LPVOID)((b'WriteConsoleW', ctypes.windll.kernel32))
1340     written = ctypes.wintypes.DWORD(0)
1341
1342     GetFileType = ctypes.WINFUNCTYPE(ctypes.wintypes.DWORD, ctypes.wintypes.DWORD)((b'GetFileType', ctypes.windll.kernel32))
1343     FILE_TYPE_CHAR = 0x0002
1344     FILE_TYPE_REMOTE = 0x8000
1345     GetConsoleMode = ctypes.WINFUNCTYPE(
1346         ctypes.wintypes.BOOL, ctypes.wintypes.HANDLE,
1347         ctypes.POINTER(ctypes.wintypes.DWORD))(
1348         (b'GetConsoleMode', ctypes.windll.kernel32))
1349     INVALID_HANDLE_VALUE = ctypes.wintypes.DWORD(-1).value
1350
1351     def not_a_console(handle):
1352         if handle == INVALID_HANDLE_VALUE or handle is None:
1353             return True
1354         return ((GetFileType(handle) & ~FILE_TYPE_REMOTE) != FILE_TYPE_CHAR or
1355                 GetConsoleMode(handle, ctypes.byref(ctypes.wintypes.DWORD())) == 0)
1356
1357     if not_a_console(h):
1358         return False
1359
1360     def next_nonbmp_pos(s):
1361         try:
1362             return next(i for i, c in enumerate(s) if ord(c) > 0xffff)
1363         except StopIteration:
1364             return len(s)
1365
1366     while s:
1367         count = min(next_nonbmp_pos(s), 1024)
1368
1369         ret = WriteConsoleW(
1370             h, s, count if count else 2, ctypes.byref(written), None)
1371         if ret == 0:
1372             raise OSError('Failed to write string')
1373         if not count:  # We just wrote a non-BMP character
1374             assert written.value == 2
1375             s = s[1:]
1376         else:
1377             assert written.value > 0
1378             s = s[written.value:]
1379     return True
1380
1381
1382 def write_string(s, out=None, encoding=None):
1383     if out is None:
1384         out = sys.stderr
1385     assert type(s) == compat_str
1386
1387     if sys.platform == 'win32' and encoding is None and hasattr(out, 'fileno'):
1388         if _windows_write_string(s, out):
1389             return
1390
1391     if ('b' in getattr(out, 'mode', '') or
1392             sys.version_info[0] < 3):  # Python 2 lies about mode of sys.stderr
1393         byt = s.encode(encoding or preferredencoding(), 'ignore')
1394         out.write(byt)
1395     elif hasattr(out, 'buffer'):
1396         enc = encoding or getattr(out, 'encoding', None) or preferredencoding()
1397         byt = s.encode(enc, 'ignore')
1398         out.buffer.write(byt)
1399     else:
1400         out.write(s)
1401     out.flush()
1402
1403
1404 def bytes_to_intlist(bs):
1405     if not bs:
1406         return []
1407     if isinstance(bs[0], int):  # Python 3
1408         return list(bs)
1409     else:
1410         return [ord(c) for c in bs]
1411
1412
1413 def intlist_to_bytes(xs):
1414     if not xs:
1415         return b''
1416     return compat_struct_pack('%dB' % len(xs), *xs)
1417
1418
1419 # Cross-platform file locking
1420 if sys.platform == 'win32':
1421     import ctypes.wintypes
1422     import msvcrt
1423
1424     class OVERLAPPED(ctypes.Structure):
1425         _fields_ = [
1426             ('Internal', ctypes.wintypes.LPVOID),
1427             ('InternalHigh', ctypes.wintypes.LPVOID),
1428             ('Offset', ctypes.wintypes.DWORD),
1429             ('OffsetHigh', ctypes.wintypes.DWORD),
1430             ('hEvent', ctypes.wintypes.HANDLE),
1431         ]
1432
1433     kernel32 = ctypes.windll.kernel32
1434     LockFileEx = kernel32.LockFileEx
1435     LockFileEx.argtypes = [
1436         ctypes.wintypes.HANDLE,     # hFile
1437         ctypes.wintypes.DWORD,      # dwFlags
1438         ctypes.wintypes.DWORD,      # dwReserved
1439         ctypes.wintypes.DWORD,      # nNumberOfBytesToLockLow
1440         ctypes.wintypes.DWORD,      # nNumberOfBytesToLockHigh
1441         ctypes.POINTER(OVERLAPPED)  # Overlapped
1442     ]
1443     LockFileEx.restype = ctypes.wintypes.BOOL
1444     UnlockFileEx = kernel32.UnlockFileEx
1445     UnlockFileEx.argtypes = [
1446         ctypes.wintypes.HANDLE,     # hFile
1447         ctypes.wintypes.DWORD,      # dwReserved
1448         ctypes.wintypes.DWORD,      # nNumberOfBytesToLockLow
1449         ctypes.wintypes.DWORD,      # nNumberOfBytesToLockHigh
1450         ctypes.POINTER(OVERLAPPED)  # Overlapped
1451     ]
1452     UnlockFileEx.restype = ctypes.wintypes.BOOL
1453     whole_low = 0xffffffff
1454     whole_high = 0x7fffffff
1455
1456     def _lock_file(f, exclusive):
1457         overlapped = OVERLAPPED()
1458         overlapped.Offset = 0
1459         overlapped.OffsetHigh = 0
1460         overlapped.hEvent = 0
1461         f._lock_file_overlapped_p = ctypes.pointer(overlapped)
1462         handle = msvcrt.get_osfhandle(f.fileno())
1463         if not LockFileEx(handle, 0x2 if exclusive else 0x0, 0,
1464                           whole_low, whole_high, f._lock_file_overlapped_p):
1465             raise OSError('Locking file failed: %r' % ctypes.FormatError())
1466
1467     def _unlock_file(f):
1468         assert f._lock_file_overlapped_p
1469         handle = msvcrt.get_osfhandle(f.fileno())
1470         if not UnlockFileEx(handle, 0,
1471                             whole_low, whole_high, f._lock_file_overlapped_p):
1472             raise OSError('Unlocking file failed: %r' % ctypes.FormatError())
1473
1474 else:
1475     # Some platforms, such as Jython, is missing fcntl
1476     try:
1477         import fcntl
1478
1479         def _lock_file(f, exclusive):
1480             fcntl.flock(f, fcntl.LOCK_EX if exclusive else fcntl.LOCK_SH)
1481
1482         def _unlock_file(f):
1483             fcntl.flock(f, fcntl.LOCK_UN)
1484     except ImportError:
1485         UNSUPPORTED_MSG = 'file locking is not supported on this platform'
1486
1487         def _lock_file(f, exclusive):
1488             raise IOError(UNSUPPORTED_MSG)
1489
1490         def _unlock_file(f):
1491             raise IOError(UNSUPPORTED_MSG)
1492
1493
1494 class locked_file(object):
1495     def __init__(self, filename, mode, encoding=None):
1496         assert mode in ['r', 'a', 'w']
1497         self.f = io.open(filename, mode, encoding=encoding)
1498         self.mode = mode
1499
1500     def __enter__(self):
1501         exclusive = self.mode != 'r'
1502         try:
1503             _lock_file(self.f, exclusive)
1504         except IOError:
1505             self.f.close()
1506             raise
1507         return self
1508
1509     def __exit__(self, etype, value, traceback):
1510         try:
1511             _unlock_file(self.f)
1512         finally:
1513             self.f.close()
1514
1515     def __iter__(self):
1516         return iter(self.f)
1517
1518     def write(self, *args):
1519         return self.f.write(*args)
1520
1521     def read(self, *args):
1522         return self.f.read(*args)
1523
1524
1525 def get_filesystem_encoding():
1526     encoding = sys.getfilesystemencoding()
1527     return encoding if encoding is not None else 'utf-8'
1528
1529
1530 def shell_quote(args):
1531     quoted_args = []
1532     encoding = get_filesystem_encoding()
1533     for a in args:
1534         if isinstance(a, bytes):
1535             # We may get a filename encoded with 'encodeFilename'
1536             a = a.decode(encoding)
1537         quoted_args.append(compat_shlex_quote(a))
1538     return ' '.join(quoted_args)
1539
1540
1541 def smuggle_url(url, data):
1542     """ Pass additional data in a URL for internal use. """
1543
1544     url, idata = unsmuggle_url(url, {})
1545     data.update(idata)
1546     sdata = compat_urllib_parse_urlencode(
1547         {'__youtubedl_smuggle': json.dumps(data)})
1548     return url + '#' + sdata
1549
1550
1551 def unsmuggle_url(smug_url, default=None):
1552     if '#__youtubedl_smuggle' not in smug_url:
1553         return smug_url, default
1554     url, _, sdata = smug_url.rpartition('#')
1555     jsond = compat_parse_qs(sdata)['__youtubedl_smuggle'][0]
1556     data = json.loads(jsond)
1557     return url, data
1558
1559
1560 def format_bytes(bytes):
1561     if bytes is None:
1562         return 'N/A'
1563     if type(bytes) is str:
1564         bytes = float(bytes)
1565     if bytes == 0.0:
1566         exponent = 0
1567     else:
1568         exponent = int(math.log(bytes, 1024.0))
1569     suffix = ['B', 'KiB', 'MiB', 'GiB', 'TiB', 'PiB', 'EiB', 'ZiB', 'YiB'][exponent]
1570     converted = float(bytes) / float(1024 ** exponent)
1571     return '%.2f%s' % (converted, suffix)
1572
1573
1574 def lookup_unit_table(unit_table, s):
1575     units_re = '|'.join(re.escape(u) for u in unit_table)
1576     m = re.match(
1577         r'(?P<num>[0-9]+(?:[,.][0-9]*)?)\s*(?P<unit>%s)\b' % units_re, s)
1578     if not m:
1579         return None
1580     num_str = m.group('num').replace(',', '.')
1581     mult = unit_table[m.group('unit')]
1582     return int(float(num_str) * mult)
1583
1584
1585 def parse_filesize(s):
1586     if s is None:
1587         return None
1588
1589     # The lower-case forms are of course incorrect and unofficial,
1590     # but we support those too
1591     _UNIT_TABLE = {
1592         'B': 1,
1593         'b': 1,
1594         'bytes': 1,
1595         'KiB': 1024,
1596         'KB': 1000,
1597         'kB': 1024,
1598         'Kb': 1000,
1599         'kb': 1000,
1600         'kilobytes': 1000,
1601         'kibibytes': 1024,
1602         'MiB': 1024 ** 2,
1603         'MB': 1000 ** 2,
1604         'mB': 1024 ** 2,
1605         'Mb': 1000 ** 2,
1606         'mb': 1000 ** 2,
1607         'megabytes': 1000 ** 2,
1608         'mebibytes': 1024 ** 2,
1609         'GiB': 1024 ** 3,
1610         'GB': 1000 ** 3,
1611         'gB': 1024 ** 3,
1612         'Gb': 1000 ** 3,
1613         'gb': 1000 ** 3,
1614         'gigabytes': 1000 ** 3,
1615         'gibibytes': 1024 ** 3,
1616         'TiB': 1024 ** 4,
1617         'TB': 1000 ** 4,
1618         'tB': 1024 ** 4,
1619         'Tb': 1000 ** 4,
1620         'tb': 1000 ** 4,
1621         'terabytes': 1000 ** 4,
1622         'tebibytes': 1024 ** 4,
1623         'PiB': 1024 ** 5,
1624         'PB': 1000 ** 5,
1625         'pB': 1024 ** 5,
1626         'Pb': 1000 ** 5,
1627         'pb': 1000 ** 5,
1628         'petabytes': 1000 ** 5,
1629         'pebibytes': 1024 ** 5,
1630         'EiB': 1024 ** 6,
1631         'EB': 1000 ** 6,
1632         'eB': 1024 ** 6,
1633         'Eb': 1000 ** 6,
1634         'eb': 1000 ** 6,
1635         'exabytes': 1000 ** 6,
1636         'exbibytes': 1024 ** 6,
1637         'ZiB': 1024 ** 7,
1638         'ZB': 1000 ** 7,
1639         'zB': 1024 ** 7,
1640         'Zb': 1000 ** 7,
1641         'zb': 1000 ** 7,
1642         'zettabytes': 1000 ** 7,
1643         'zebibytes': 1024 ** 7,
1644         'YiB': 1024 ** 8,
1645         'YB': 1000 ** 8,
1646         'yB': 1024 ** 8,
1647         'Yb': 1000 ** 8,
1648         'yb': 1000 ** 8,
1649         'yottabytes': 1000 ** 8,
1650         'yobibytes': 1024 ** 8,
1651     }
1652
1653     return lookup_unit_table(_UNIT_TABLE, s)
1654
1655
1656 def parse_count(s):
1657     if s is None:
1658         return None
1659
1660     s = s.strip()
1661
1662     if re.match(r'^[\d,.]+$', s):
1663         return str_to_int(s)
1664
1665     _UNIT_TABLE = {
1666         'k': 1000,
1667         'K': 1000,
1668         'm': 1000 ** 2,
1669         'M': 1000 ** 2,
1670         'kk': 1000 ** 2,
1671         'KK': 1000 ** 2,
1672     }
1673
1674     return lookup_unit_table(_UNIT_TABLE, s)
1675
1676
1677 def month_by_name(name, lang='en'):
1678     """ Return the number of a month by (locale-independently) English name """
1679
1680     month_names = MONTH_NAMES.get(lang, MONTH_NAMES['en'])
1681
1682     try:
1683         return month_names.index(name) + 1
1684     except ValueError:
1685         return None
1686
1687
1688 def month_by_abbreviation(abbrev):
1689     """ Return the number of a month by (locale-independently) English
1690         abbreviations """
1691
1692     try:
1693         return [s[:3] for s in ENGLISH_MONTH_NAMES].index(abbrev) + 1
1694     except ValueError:
1695         return None
1696
1697
1698 def fix_xml_ampersands(xml_str):
1699     """Replace all the '&' by '&amp;' in XML"""
1700     return re.sub(
1701         r'&(?!amp;|lt;|gt;|apos;|quot;|#x[0-9a-fA-F]{,4};|#[0-9]{,4};)',
1702         '&amp;',
1703         xml_str)
1704
1705
1706 def setproctitle(title):
1707     assert isinstance(title, compat_str)
1708
1709     # ctypes in Jython is not complete
1710     # http://bugs.jython.org/issue2148
1711     if sys.platform.startswith('java'):
1712         return
1713
1714     try:
1715         libc = ctypes.cdll.LoadLibrary('libc.so.6')
1716     except OSError:
1717         return
1718     except TypeError:
1719         # LoadLibrary in Windows Python 2.7.13 only expects
1720         # a bytestring, but since unicode_literals turns
1721         # every string into a unicode string, it fails.
1722         return
1723     title_bytes = title.encode('utf-8')
1724     buf = ctypes.create_string_buffer(len(title_bytes))
1725     buf.value = title_bytes
1726     try:
1727         libc.prctl(15, buf, 0, 0, 0)
1728     except AttributeError:
1729         return  # Strange libc, just skip this
1730
1731
1732 def remove_start(s, start):
1733     return s[len(start):] if s is not None and s.startswith(start) else s
1734
1735
1736 def remove_end(s, end):
1737     return s[:-len(end)] if s is not None and s.endswith(end) else s
1738
1739
1740 def remove_quotes(s):
1741     if s is None or len(s) < 2:
1742         return s
1743     for quote in ('"', "'", ):
1744         if s[0] == quote and s[-1] == quote:
1745             return s[1:-1]
1746     return s
1747
1748
1749 def url_basename(url):
1750     path = compat_urlparse.urlparse(url).path
1751     return path.strip('/').split('/')[-1]
1752
1753
1754 def base_url(url):
1755     return re.match(r'https?://[^?#&]+/', url).group()
1756
1757
1758 def urljoin(base, path):
1759     if isinstance(path, bytes):
1760         path = path.decode('utf-8')
1761     if not isinstance(path, compat_str) or not path:
1762         return None
1763     if re.match(r'^(?:https?:)?//', path):
1764         return path
1765     if isinstance(base, bytes):
1766         base = base.decode('utf-8')
1767     if not isinstance(base, compat_str) or not re.match(
1768             r'^(?:https?:)?//', base):
1769         return None
1770     return compat_urlparse.urljoin(base, path)
1771
1772
1773 class HEADRequest(compat_urllib_request.Request):
1774     def get_method(self):
1775         return 'HEAD'
1776
1777
1778 class PUTRequest(compat_urllib_request.Request):
1779     def get_method(self):
1780         return 'PUT'
1781
1782
1783 def int_or_none(v, scale=1, default=None, get_attr=None, invscale=1):
1784     if get_attr:
1785         if v is not None:
1786             v = getattr(v, get_attr, None)
1787     if v == '':
1788         v = None
1789     if v is None:
1790         return default
1791     try:
1792         return int(v) * invscale // scale
1793     except ValueError:
1794         return default
1795
1796
1797 def str_or_none(v, default=None):
1798     return default if v is None else compat_str(v)
1799
1800
1801 def str_to_int(int_str):
1802     """ A more relaxed version of int_or_none """
1803     if int_str is None:
1804         return None
1805     int_str = re.sub(r'[,\.\+]', '', int_str)
1806     return int(int_str)
1807
1808
1809 def float_or_none(v, scale=1, invscale=1, default=None):
1810     if v is None:
1811         return default
1812     try:
1813         return float(v) * invscale / scale
1814     except ValueError:
1815         return default
1816
1817
1818 def strip_or_none(v):
1819     return None if v is None else v.strip()
1820
1821
1822 def parse_duration(s):
1823     if not isinstance(s, compat_basestring):
1824         return None
1825
1826     s = s.strip()
1827
1828     days, hours, mins, secs, ms = [None] * 5
1829     m = re.match(r'(?:(?:(?:(?P<days>[0-9]+):)?(?P<hours>[0-9]+):)?(?P<mins>[0-9]+):)?(?P<secs>[0-9]+)(?P<ms>\.[0-9]+)?Z?$', s)
1830     if m:
1831         days, hours, mins, secs, ms = m.groups()
1832     else:
1833         m = re.match(
1834             r'''(?ix)(?:P?T)?
1835                 (?:
1836                     (?P<days>[0-9]+)\s*d(?:ays?)?\s*
1837                 )?
1838                 (?:
1839                     (?P<hours>[0-9]+)\s*h(?:ours?)?\s*
1840                 )?
1841                 (?:
1842                     (?P<mins>[0-9]+)\s*m(?:in(?:ute)?s?)?\s*
1843                 )?
1844                 (?:
1845                     (?P<secs>[0-9]+)(?P<ms>\.[0-9]+)?\s*s(?:ec(?:ond)?s?)?\s*
1846                 )?Z?$''', s)
1847         if m:
1848             days, hours, mins, secs, ms = m.groups()
1849         else:
1850             m = re.match(r'(?i)(?:(?P<hours>[0-9.]+)\s*(?:hours?)|(?P<mins>[0-9.]+)\s*(?:mins?\.?|minutes?)\s*)Z?$', s)
1851             if m:
1852                 hours, mins = m.groups()
1853             else:
1854                 return None
1855
1856     duration = 0
1857     if secs:
1858         duration += float(secs)
1859     if mins:
1860         duration += float(mins) * 60
1861     if hours:
1862         duration += float(hours) * 60 * 60
1863     if days:
1864         duration += float(days) * 24 * 60 * 60
1865     if ms:
1866         duration += float(ms)
1867     return duration
1868
1869
1870 def prepend_extension(filename, ext, expected_real_ext=None):
1871     name, real_ext = os.path.splitext(filename)
1872     return (
1873         '{0}.{1}{2}'.format(name, ext, real_ext)
1874         if not expected_real_ext or real_ext[1:] == expected_real_ext
1875         else '{0}.{1}'.format(filename, ext))
1876
1877
1878 def replace_extension(filename, ext, expected_real_ext=None):
1879     name, real_ext = os.path.splitext(filename)
1880     return '{0}.{1}'.format(
1881         name if not expected_real_ext or real_ext[1:] == expected_real_ext else filename,
1882         ext)
1883
1884
1885 def check_executable(exe, args=[]):
1886     """ Checks if the given binary is installed somewhere in PATH, and returns its name.
1887     args can be a list of arguments for a short output (like -version) """
1888     try:
1889         subprocess.Popen([exe] + args, stdout=subprocess.PIPE, stderr=subprocess.PIPE).communicate()
1890     except OSError:
1891         return False
1892     return exe
1893
1894
1895 def get_exe_version(exe, args=['--version'],
1896                     version_re=None, unrecognized='present'):
1897     """ Returns the version of the specified executable,
1898     or False if the executable is not present """
1899     try:
1900         # STDIN should be redirected too. On UNIX-like systems, ffmpeg triggers
1901         # SIGTTOU if youtube-dl is run in the background.
1902         # See https://github.com/rg3/youtube-dl/issues/955#issuecomment-209789656
1903         out, _ = subprocess.Popen(
1904             [encodeArgument(exe)] + args,
1905             stdin=subprocess.PIPE,
1906             stdout=subprocess.PIPE, stderr=subprocess.STDOUT).communicate()
1907     except OSError:
1908         return False
1909     if isinstance(out, bytes):  # Python 2.x
1910         out = out.decode('ascii', 'ignore')
1911     return detect_exe_version(out, version_re, unrecognized)
1912
1913
1914 def detect_exe_version(output, version_re=None, unrecognized='present'):
1915     assert isinstance(output, compat_str)
1916     if version_re is None:
1917         version_re = r'version\s+([-0-9._a-zA-Z]+)'
1918     m = re.search(version_re, output)
1919     if m:
1920         return m.group(1)
1921     else:
1922         return unrecognized
1923
1924
1925 class PagedList(object):
1926     def __len__(self):
1927         # This is only useful for tests
1928         return len(self.getslice())
1929
1930
1931 class OnDemandPagedList(PagedList):
1932     def __init__(self, pagefunc, pagesize, use_cache=False):
1933         self._pagefunc = pagefunc
1934         self._pagesize = pagesize
1935         self._use_cache = use_cache
1936         if use_cache:
1937             self._cache = {}
1938
1939     def getslice(self, start=0, end=None):
1940         res = []
1941         for pagenum in itertools.count(start // self._pagesize):
1942             firstid = pagenum * self._pagesize
1943             nextfirstid = pagenum * self._pagesize + self._pagesize
1944             if start >= nextfirstid:
1945                 continue
1946
1947             page_results = None
1948             if self._use_cache:
1949                 page_results = self._cache.get(pagenum)
1950             if page_results is None:
1951                 page_results = list(self._pagefunc(pagenum))
1952             if self._use_cache:
1953                 self._cache[pagenum] = page_results
1954
1955             startv = (
1956                 start % self._pagesize
1957                 if firstid <= start < nextfirstid
1958                 else 0)
1959
1960             endv = (
1961                 ((end - 1) % self._pagesize) + 1
1962                 if (end is not None and firstid <= end <= nextfirstid)
1963                 else None)
1964
1965             if startv != 0 or endv is not None:
1966                 page_results = page_results[startv:endv]
1967             res.extend(page_results)
1968
1969             # A little optimization - if current page is not "full", ie. does
1970             # not contain page_size videos then we can assume that this page
1971             # is the last one - there are no more ids on further pages -
1972             # i.e. no need to query again.
1973             if len(page_results) + startv < self._pagesize:
1974                 break
1975
1976             # If we got the whole page, but the next page is not interesting,
1977             # break out early as well
1978             if end == nextfirstid:
1979                 break
1980         return res
1981
1982
1983 class InAdvancePagedList(PagedList):
1984     def __init__(self, pagefunc, pagecount, pagesize):
1985         self._pagefunc = pagefunc
1986         self._pagecount = pagecount
1987         self._pagesize = pagesize
1988
1989     def getslice(self, start=0, end=None):
1990         res = []
1991         start_page = start // self._pagesize
1992         end_page = (
1993             self._pagecount if end is None else (end // self._pagesize + 1))
1994         skip_elems = start - start_page * self._pagesize
1995         only_more = None if end is None else end - start
1996         for pagenum in range(start_page, end_page):
1997             page = list(self._pagefunc(pagenum))
1998             if skip_elems:
1999                 page = page[skip_elems:]
2000                 skip_elems = None
2001             if only_more is not None:
2002                 if len(page) < only_more:
2003                     only_more -= len(page)
2004                 else:
2005                     page = page[:only_more]
2006                     res.extend(page)
2007                     break
2008             res.extend(page)
2009         return res
2010
2011
2012 def uppercase_escape(s):
2013     unicode_escape = codecs.getdecoder('unicode_escape')
2014     return re.sub(
2015         r'\\U[0-9a-fA-F]{8}',
2016         lambda m: unicode_escape(m.group(0))[0],
2017         s)
2018
2019
2020 def lowercase_escape(s):
2021     unicode_escape = codecs.getdecoder('unicode_escape')
2022     return re.sub(
2023         r'\\u[0-9a-fA-F]{4}',
2024         lambda m: unicode_escape(m.group(0))[0],
2025         s)
2026
2027
2028 def escape_rfc3986(s):
2029     """Escape non-ASCII characters as suggested by RFC 3986"""
2030     if sys.version_info < (3, 0) and isinstance(s, compat_str):
2031         s = s.encode('utf-8')
2032     return compat_urllib_parse.quote(s, b"%/;:@&=+$,!~*'()?#[]")
2033
2034
2035 def escape_url(url):
2036     """Escape URL as suggested by RFC 3986"""
2037     url_parsed = compat_urllib_parse_urlparse(url)
2038     return url_parsed._replace(
2039         netloc=url_parsed.netloc.encode('idna').decode('ascii'),
2040         path=escape_rfc3986(url_parsed.path),
2041         params=escape_rfc3986(url_parsed.params),
2042         query=escape_rfc3986(url_parsed.query),
2043         fragment=escape_rfc3986(url_parsed.fragment)
2044     ).geturl()
2045
2046
2047 def read_batch_urls(batch_fd):
2048     def fixup(url):
2049         if not isinstance(url, compat_str):
2050             url = url.decode('utf-8', 'replace')
2051         BOM_UTF8 = '\xef\xbb\xbf'
2052         if url.startswith(BOM_UTF8):
2053             url = url[len(BOM_UTF8):]
2054         url = url.strip()
2055         if url.startswith(('#', ';', ']')):
2056             return False
2057         return url
2058
2059     with contextlib.closing(batch_fd) as fd:
2060         return [url for url in map(fixup, fd) if url]
2061
2062
2063 def urlencode_postdata(*args, **kargs):
2064     return compat_urllib_parse_urlencode(*args, **kargs).encode('ascii')
2065
2066
2067 def update_url_query(url, query):
2068     if not query:
2069         return url
2070     parsed_url = compat_urlparse.urlparse(url)
2071     qs = compat_parse_qs(parsed_url.query)
2072     qs.update(query)
2073     return compat_urlparse.urlunparse(parsed_url._replace(
2074         query=compat_urllib_parse_urlencode(qs, True)))
2075
2076
2077 def update_Request(req, url=None, data=None, headers={}, query={}):
2078     req_headers = req.headers.copy()
2079     req_headers.update(headers)
2080     req_data = data or req.data
2081     req_url = update_url_query(url or req.get_full_url(), query)
2082     req_get_method = req.get_method()
2083     if req_get_method == 'HEAD':
2084         req_type = HEADRequest
2085     elif req_get_method == 'PUT':
2086         req_type = PUTRequest
2087     else:
2088         req_type = compat_urllib_request.Request
2089     new_req = req_type(
2090         req_url, data=req_data, headers=req_headers,
2091         origin_req_host=req.origin_req_host, unverifiable=req.unverifiable)
2092     if hasattr(req, 'timeout'):
2093         new_req.timeout = req.timeout
2094     return new_req
2095
2096
2097 def _multipart_encode_impl(data, boundary):
2098     content_type = 'multipart/form-data; boundary=%s' % boundary
2099
2100     out = b''
2101     for k, v in data.items():
2102         out += b'--' + boundary.encode('ascii') + b'\r\n'
2103         if isinstance(k, compat_str):
2104             k = k.encode('utf-8')
2105         if isinstance(v, compat_str):
2106             v = v.encode('utf-8')
2107         # RFC 2047 requires non-ASCII field names to be encoded, while RFC 7578
2108         # suggests sending UTF-8 directly. Firefox sends UTF-8, too
2109         content = b'Content-Disposition: form-data; name="' + k + b'"\r\n\r\n' + v + b'\r\n'
2110         if boundary.encode('ascii') in content:
2111             raise ValueError('Boundary overlaps with data')
2112         out += content
2113
2114     out += b'--' + boundary.encode('ascii') + b'--\r\n'
2115
2116     return out, content_type
2117
2118
2119 def multipart_encode(data, boundary=None):
2120     '''
2121     Encode a dict to RFC 7578-compliant form-data
2122
2123     data:
2124         A dict where keys and values can be either Unicode or bytes-like
2125         objects.
2126     boundary:
2127         If specified a Unicode object, it's used as the boundary. Otherwise
2128         a random boundary is generated.
2129
2130     Reference: https://tools.ietf.org/html/rfc7578
2131     '''
2132     has_specified_boundary = boundary is not None
2133
2134     while True:
2135         if boundary is None:
2136             boundary = '---------------' + str(random.randrange(0x0fffffff, 0xffffffff))
2137
2138         try:
2139             out, content_type = _multipart_encode_impl(data, boundary)
2140             break
2141         except ValueError:
2142             if has_specified_boundary:
2143                 raise
2144             boundary = None
2145
2146     return out, content_type
2147
2148
2149 def dict_get(d, key_or_keys, default=None, skip_false_values=True):
2150     if isinstance(key_or_keys, (list, tuple)):
2151         for key in key_or_keys:
2152             if key not in d or d[key] is None or skip_false_values and not d[key]:
2153                 continue
2154             return d[key]
2155         return default
2156     return d.get(key_or_keys, default)
2157
2158
2159 def try_get(src, getter, expected_type=None):
2160     if not isinstance(getter, (list, tuple)):
2161         getter = [getter]
2162     for get in getter:
2163         try:
2164             v = get(src)
2165         except (AttributeError, KeyError, TypeError, IndexError):
2166             pass
2167         else:
2168             if expected_type is None or isinstance(v, expected_type):
2169                 return v
2170
2171
2172 def encode_compat_str(string, encoding=preferredencoding(), errors='strict'):
2173     return string if isinstance(string, compat_str) else compat_str(string, encoding, errors)
2174
2175
2176 US_RATINGS = {
2177     'G': 0,
2178     'PG': 10,
2179     'PG-13': 13,
2180     'R': 16,
2181     'NC': 18,
2182 }
2183
2184
2185 TV_PARENTAL_GUIDELINES = {
2186     'TV-Y': 0,
2187     'TV-Y7': 7,
2188     'TV-G': 0,
2189     'TV-PG': 0,
2190     'TV-14': 14,
2191     'TV-MA': 17,
2192 }
2193
2194
2195 def parse_age_limit(s):
2196     if type(s) == int:
2197         return s if 0 <= s <= 21 else None
2198     if not isinstance(s, compat_basestring):
2199         return None
2200     m = re.match(r'^(?P<age>\d{1,2})\+?$', s)
2201     if m:
2202         return int(m.group('age'))
2203     if s in US_RATINGS:
2204         return US_RATINGS[s]
2205     return TV_PARENTAL_GUIDELINES.get(s)
2206
2207
2208 def strip_jsonp(code):
2209     return re.sub(
2210         r'''(?sx)^
2211             (?:window\.)?(?P<func_name>[a-zA-Z0-9_.$]+)
2212             (?:\s*&&\s*(?P=func_name))?
2213             \s*\(\s*(?P<callback_data>.*)\);?
2214             \s*?(?://[^\n]*)*$''',
2215         r'\g<callback_data>', code)
2216
2217
2218 def js_to_json(code):
2219     COMMENT_RE = r'/\*(?:(?!\*/).)*?\*/|//[^\n]*'
2220     SKIP_RE = r'\s*(?:{comment})?\s*'.format(comment=COMMENT_RE)
2221     INTEGER_TABLE = (
2222         (r'(?s)^(0[xX][0-9a-fA-F]+){skip}:?$'.format(skip=SKIP_RE), 16),
2223         (r'(?s)^(0+[0-7]+){skip}:?$'.format(skip=SKIP_RE), 8),
2224     )
2225
2226     def fix_kv(m):
2227         v = m.group(0)
2228         if v in ('true', 'false', 'null'):
2229             return v
2230         elif v.startswith('/*') or v.startswith('//') or v == ',':
2231             return ""
2232
2233         if v[0] in ("'", '"'):
2234             v = re.sub(r'(?s)\\.|"', lambda m: {
2235                 '"': '\\"',
2236                 "\\'": "'",
2237                 '\\\n': '',
2238                 '\\x': '\\u00',
2239             }.get(m.group(0), m.group(0)), v[1:-1])
2240
2241         for regex, base in INTEGER_TABLE:
2242             im = re.match(regex, v)
2243             if im:
2244                 i = int(im.group(1), base)
2245                 return '"%d":' % i if v.endswith(':') else '%d' % i
2246
2247         return '"%s"' % v
2248
2249     return re.sub(r'''(?sx)
2250         "(?:[^"\\]*(?:\\\\|\\['"nurtbfx/\n]))*[^"\\]*"|
2251         '(?:[^'\\]*(?:\\\\|\\['"nurtbfx/\n]))*[^'\\]*'|
2252         {comment}|,(?={skip}[\]}}])|
2253         [a-zA-Z_][.a-zA-Z_0-9]*|
2254         \b(?:0[xX][0-9a-fA-F]+|0+[0-7]+)(?:{skip}:)?|
2255         [0-9]+(?={skip}:)
2256         '''.format(comment=COMMENT_RE, skip=SKIP_RE), fix_kv, code)
2257
2258
2259 def qualities(quality_ids):
2260     """ Get a numeric quality value out of a list of possible values """
2261     def q(qid):
2262         try:
2263             return quality_ids.index(qid)
2264         except ValueError:
2265             return -1
2266     return q
2267
2268
2269 DEFAULT_OUTTMPL = '%(title)s-%(id)s.%(ext)s'
2270
2271
2272 def limit_length(s, length):
2273     """ Add ellipses to overly long strings """
2274     if s is None:
2275         return None
2276     ELLIPSES = '...'
2277     if len(s) > length:
2278         return s[:length - len(ELLIPSES)] + ELLIPSES
2279     return s
2280
2281
2282 def version_tuple(v):
2283     return tuple(int(e) for e in re.split(r'[-.]', v))
2284
2285
2286 def is_outdated_version(version, limit, assume_new=True):
2287     if not version:
2288         return not assume_new
2289     try:
2290         return version_tuple(version) < version_tuple(limit)
2291     except ValueError:
2292         return not assume_new
2293
2294
2295 def ytdl_is_updateable():
2296     """ Returns if youtube-dl can be updated with -U """
2297     from zipimport import zipimporter
2298
2299     return isinstance(globals().get('__loader__'), zipimporter) or hasattr(sys, 'frozen')
2300
2301
2302 def args_to_str(args):
2303     # Get a short string representation for a subprocess command
2304     return ' '.join(compat_shlex_quote(a) for a in args)
2305
2306
2307 def error_to_compat_str(err):
2308     err_str = str(err)
2309     # On python 2 error byte string must be decoded with proper
2310     # encoding rather than ascii
2311     if sys.version_info[0] < 3:
2312         err_str = err_str.decode(preferredencoding())
2313     return err_str
2314
2315
2316 def mimetype2ext(mt):
2317     if mt is None:
2318         return None
2319
2320     ext = {
2321         'audio/mp4': 'm4a',
2322         # Per RFC 3003, audio/mpeg can be .mp1, .mp2 or .mp3. Here use .mp3 as
2323         # it's the most popular one
2324         'audio/mpeg': 'mp3',
2325     }.get(mt)
2326     if ext is not None:
2327         return ext
2328
2329     _, _, res = mt.rpartition('/')
2330     res = res.split(';')[0].strip().lower()
2331
2332     return {
2333         '3gpp': '3gp',
2334         'smptett+xml': 'tt',
2335         'ttaf+xml': 'dfxp',
2336         'ttml+xml': 'ttml',
2337         'x-flv': 'flv',
2338         'x-mp4-fragmented': 'mp4',
2339         'x-ms-wmv': 'wmv',
2340         'mpegurl': 'm3u8',
2341         'x-mpegurl': 'm3u8',
2342         'vnd.apple.mpegurl': 'm3u8',
2343         'dash+xml': 'mpd',
2344         'f4m+xml': 'f4m',
2345         'hds+xml': 'f4m',
2346         'vnd.ms-sstr+xml': 'ism',
2347         'quicktime': 'mov',
2348         'mp2t': 'ts',
2349     }.get(res, res)
2350
2351
2352 def parse_codecs(codecs_str):
2353     # http://tools.ietf.org/html/rfc6381
2354     if not codecs_str:
2355         return {}
2356     splited_codecs = list(filter(None, map(
2357         lambda str: str.strip(), codecs_str.strip().strip(',').split(','))))
2358     vcodec, acodec = None, None
2359     for full_codec in splited_codecs:
2360         codec = full_codec.split('.')[0]
2361         if codec in ('avc1', 'avc2', 'avc3', 'avc4', 'vp9', 'vp8', 'hev1', 'hev2', 'h263', 'h264', 'mp4v'):
2362             if not vcodec:
2363                 vcodec = full_codec
2364         elif codec in ('mp4a', 'opus', 'vorbis', 'mp3', 'aac', 'ac-3', 'ec-3', 'eac3', 'dtsc', 'dtse', 'dtsh', 'dtsl'):
2365             if not acodec:
2366                 acodec = full_codec
2367         else:
2368             write_string('WARNING: Unknown codec %s\n' % full_codec, sys.stderr)
2369     if not vcodec and not acodec:
2370         if len(splited_codecs) == 2:
2371             return {
2372                 'vcodec': vcodec,
2373                 'acodec': acodec,
2374             }
2375         elif len(splited_codecs) == 1:
2376             return {
2377                 'vcodec': 'none',
2378                 'acodec': vcodec,
2379             }
2380     else:
2381         return {
2382             'vcodec': vcodec or 'none',
2383             'acodec': acodec or 'none',
2384         }
2385     return {}
2386
2387
2388 def urlhandle_detect_ext(url_handle):
2389     getheader = url_handle.headers.get
2390
2391     cd = getheader('Content-Disposition')
2392     if cd:
2393         m = re.match(r'attachment;\s*filename="(?P<filename>[^"]+)"', cd)
2394         if m:
2395             e = determine_ext(m.group('filename'), default_ext=None)
2396             if e:
2397                 return e
2398
2399     return mimetype2ext(getheader('Content-Type'))
2400
2401
2402 def encode_data_uri(data, mime_type):
2403     return 'data:%s;base64,%s' % (mime_type, base64.b64encode(data).decode('ascii'))
2404
2405
2406 def age_restricted(content_limit, age_limit):
2407     """ Returns True iff the content should be blocked """
2408
2409     if age_limit is None:  # No limit set
2410         return False
2411     if content_limit is None:
2412         return False  # Content available for everyone
2413     return age_limit < content_limit
2414
2415
2416 def is_html(first_bytes):
2417     """ Detect whether a file contains HTML by examining its first bytes. """
2418
2419     BOMS = [
2420         (b'\xef\xbb\xbf', 'utf-8'),
2421         (b'\x00\x00\xfe\xff', 'utf-32-be'),
2422         (b'\xff\xfe\x00\x00', 'utf-32-le'),
2423         (b'\xff\xfe', 'utf-16-le'),
2424         (b'\xfe\xff', 'utf-16-be'),
2425     ]
2426     for bom, enc in BOMS:
2427         if first_bytes.startswith(bom):
2428             s = first_bytes[len(bom):].decode(enc, 'replace')
2429             break
2430     else:
2431         s = first_bytes.decode('utf-8', 'replace')
2432
2433     return re.match(r'^\s*<', s)
2434
2435
2436 def determine_protocol(info_dict):
2437     protocol = info_dict.get('protocol')
2438     if protocol is not None:
2439         return protocol
2440
2441     url = info_dict['url']
2442     if url.startswith('rtmp'):
2443         return 'rtmp'
2444     elif url.startswith('mms'):
2445         return 'mms'
2446     elif url.startswith('rtsp'):
2447         return 'rtsp'
2448
2449     ext = determine_ext(url)
2450     if ext == 'm3u8':
2451         return 'm3u8'
2452     elif ext == 'f4m':
2453         return 'f4m'
2454
2455     return compat_urllib_parse_urlparse(url).scheme
2456
2457
2458 def render_table(header_row, data):
2459     """ Render a list of rows, each as a list of values """
2460     table = [header_row] + data
2461     max_lens = [max(len(compat_str(v)) for v in col) for col in zip(*table)]
2462     format_str = ' '.join('%-' + compat_str(ml + 1) + 's' for ml in max_lens[:-1]) + '%s'
2463     return '\n'.join(format_str % tuple(row) for row in table)
2464
2465
2466 def _match_one(filter_part, dct):
2467     COMPARISON_OPERATORS = {
2468         '<': operator.lt,
2469         '<=': operator.le,
2470         '>': operator.gt,
2471         '>=': operator.ge,
2472         '=': operator.eq,
2473         '!=': operator.ne,
2474     }
2475     operator_rex = re.compile(r'''(?x)\s*
2476         (?P<key>[a-z_]+)
2477         \s*(?P<op>%s)(?P<none_inclusive>\s*\?)?\s*
2478         (?:
2479             (?P<intval>[0-9.]+(?:[kKmMgGtTpPeEzZyY]i?[Bb]?)?)|
2480             (?P<quote>["\'])(?P<quotedstrval>(?:\\.|(?!(?P=quote)|\\).)+?)(?P=quote)|
2481             (?P<strval>(?![0-9.])[a-z0-9A-Z]*)
2482         )
2483         \s*$
2484         ''' % '|'.join(map(re.escape, COMPARISON_OPERATORS.keys())))
2485     m = operator_rex.search(filter_part)
2486     if m:
2487         op = COMPARISON_OPERATORS[m.group('op')]
2488         actual_value = dct.get(m.group('key'))
2489         if (m.group('quotedstrval') is not None or
2490             m.group('strval') is not None or
2491             # If the original field is a string and matching comparisonvalue is
2492             # a number we should respect the origin of the original field
2493             # and process comparison value as a string (see
2494             # https://github.com/rg3/youtube-dl/issues/11082).
2495             actual_value is not None and m.group('intval') is not None and
2496                 isinstance(actual_value, compat_str)):
2497             if m.group('op') not in ('=', '!='):
2498                 raise ValueError(
2499                     'Operator %s does not support string values!' % m.group('op'))
2500             comparison_value = m.group('quotedstrval') or m.group('strval') or m.group('intval')
2501             quote = m.group('quote')
2502             if quote is not None:
2503                 comparison_value = comparison_value.replace(r'\%s' % quote, quote)
2504         else:
2505             try:
2506                 comparison_value = int(m.group('intval'))
2507             except ValueError:
2508                 comparison_value = parse_filesize(m.group('intval'))
2509                 if comparison_value is None:
2510                     comparison_value = parse_filesize(m.group('intval') + 'B')
2511                 if comparison_value is None:
2512                     raise ValueError(
2513                         'Invalid integer value %r in filter part %r' % (
2514                             m.group('intval'), filter_part))
2515         if actual_value is None:
2516             return m.group('none_inclusive')
2517         return op(actual_value, comparison_value)
2518
2519     UNARY_OPERATORS = {
2520         '': lambda v: v is not None,
2521         '!': lambda v: v is None,
2522     }
2523     operator_rex = re.compile(r'''(?x)\s*
2524         (?P<op>%s)\s*(?P<key>[a-z_]+)
2525         \s*$
2526         ''' % '|'.join(map(re.escape, UNARY_OPERATORS.keys())))
2527     m = operator_rex.search(filter_part)
2528     if m:
2529         op = UNARY_OPERATORS[m.group('op')]
2530         actual_value = dct.get(m.group('key'))
2531         return op(actual_value)
2532
2533     raise ValueError('Invalid filter part %r' % filter_part)
2534
2535
2536 def match_str(filter_str, dct):
2537     """ Filter a dictionary with a simple string syntax. Returns True (=passes filter) or false """
2538
2539     return all(
2540         _match_one(filter_part, dct) for filter_part in filter_str.split('&'))
2541
2542
2543 def match_filter_func(filter_str):
2544     def _match_func(info_dict):
2545         if match_str(filter_str, info_dict):
2546             return None
2547         else:
2548             video_title = info_dict.get('title', info_dict.get('id', 'video'))
2549             return '%s does not pass filter %s, skipping ..' % (video_title, filter_str)
2550     return _match_func
2551
2552
2553 def parse_dfxp_time_expr(time_expr):
2554     if not time_expr:
2555         return
2556
2557     mobj = re.match(r'^(?P<time_offset>\d+(?:\.\d+)?)s?$', time_expr)
2558     if mobj:
2559         return float(mobj.group('time_offset'))
2560
2561     mobj = re.match(r'^(\d+):(\d\d):(\d\d(?:(?:\.|:)\d+)?)$', time_expr)
2562     if mobj:
2563         return 3600 * int(mobj.group(1)) + 60 * int(mobj.group(2)) + float(mobj.group(3).replace(':', '.'))
2564
2565
2566 def srt_subtitles_timecode(seconds):
2567     return '%02d:%02d:%02d,%03d' % (seconds / 3600, (seconds % 3600) / 60, seconds % 60, (seconds % 1) * 1000)
2568
2569
2570 def dfxp2srt(dfxp_data):
2571     LEGACY_NAMESPACES = (
2572         ('http://www.w3.org/ns/ttml', [
2573             'http://www.w3.org/2004/11/ttaf1',
2574             'http://www.w3.org/2006/04/ttaf1',
2575             'http://www.w3.org/2006/10/ttaf1',
2576         ]),
2577         ('http://www.w3.org/ns/ttml#styling', [
2578             'http://www.w3.org/ns/ttml#style',
2579         ]),
2580     )
2581
2582     SUPPORTED_STYLING = [
2583         'color',
2584         'fontFamily',
2585         'fontSize',
2586         'fontStyle',
2587         'fontWeight',
2588         'textDecoration'
2589     ]
2590
2591     _x = functools.partial(xpath_with_ns, ns_map={
2592         'ttml': 'http://www.w3.org/ns/ttml',
2593         'tts': 'http://www.w3.org/ns/ttml#styling',
2594     })
2595
2596     styles = {}
2597     default_style = {}
2598
2599     class TTMLPElementParser(object):
2600         _out = ''
2601         _unclosed_elements = []
2602         _applied_styles = []
2603
2604         def start(self, tag, attrib):
2605             if tag in (_x('ttml:br'), 'br'):
2606                 self._out += '\n'
2607             else:
2608                 unclosed_elements = []
2609                 style = {}
2610                 element_style_id = attrib.get('style')
2611                 if default_style:
2612                     style.update(default_style)
2613                 if element_style_id:
2614                     style.update(styles.get(element_style_id, {}))
2615                 for prop in SUPPORTED_STYLING:
2616                     prop_val = attrib.get(_x('tts:' + prop))
2617                     if prop_val:
2618                         style[prop] = prop_val
2619                 if style:
2620                     font = ''
2621                     for k, v in sorted(style.items()):
2622                         if self._applied_styles and self._applied_styles[-1].get(k) == v:
2623                             continue
2624                         if k == 'color':
2625                             font += ' color="%s"' % v
2626                         elif k == 'fontSize':
2627                             font += ' size="%s"' % v
2628                         elif k == 'fontFamily':
2629                             font += ' face="%s"' % v
2630                         elif k == 'fontWeight' and v == 'bold':
2631                             self._out += '<b>'
2632                             unclosed_elements.append('b')
2633                         elif k == 'fontStyle' and v == 'italic':
2634                             self._out += '<i>'
2635                             unclosed_elements.append('i')
2636                         elif k == 'textDecoration' and v == 'underline':
2637                             self._out += '<u>'
2638                             unclosed_elements.append('u')
2639                     if font:
2640                         self._out += '<font' + font + '>'
2641                         unclosed_elements.append('font')
2642                     applied_style = {}
2643                     if self._applied_styles:
2644                         applied_style.update(self._applied_styles[-1])
2645                     applied_style.update(style)
2646                     self._applied_styles.append(applied_style)
2647                 self._unclosed_elements.append(unclosed_elements)
2648
2649         def end(self, tag):
2650             if tag not in (_x('ttml:br'), 'br'):
2651                 unclosed_elements = self._unclosed_elements.pop()
2652                 for element in reversed(unclosed_elements):
2653                     self._out += '</%s>' % element
2654                 if unclosed_elements and self._applied_styles:
2655                     self._applied_styles.pop()
2656
2657         def data(self, data):
2658             self._out += data
2659
2660         def close(self):
2661             return self._out.strip()
2662
2663     def parse_node(node):
2664         target = TTMLPElementParser()
2665         parser = xml.etree.ElementTree.XMLParser(target=target)
2666         parser.feed(xml.etree.ElementTree.tostring(node))
2667         return parser.close()
2668
2669     for k, v in LEGACY_NAMESPACES:
2670         for ns in v:
2671             dfxp_data = dfxp_data.replace(ns, k)
2672
2673     dfxp = compat_etree_fromstring(dfxp_data.encode('utf-8'))
2674     out = []
2675     paras = dfxp.findall(_x('.//ttml:p')) or dfxp.findall('.//p')
2676
2677     if not paras:
2678         raise ValueError('Invalid dfxp/TTML subtitle')
2679
2680     repeat = False
2681     while True:
2682         for style in dfxp.findall(_x('.//ttml:style')):
2683             style_id = style.get('id')
2684             parent_style_id = style.get('style')
2685             if parent_style_id:
2686                 if parent_style_id not in styles:
2687                     repeat = True
2688                     continue
2689                 styles[style_id] = styles[parent_style_id].copy()
2690             for prop in SUPPORTED_STYLING:
2691                 prop_val = style.get(_x('tts:' + prop))
2692                 if prop_val:
2693                     styles.setdefault(style_id, {})[prop] = prop_val
2694         if repeat:
2695             repeat = False
2696         else:
2697             break
2698
2699     for p in ('body', 'div'):
2700         ele = xpath_element(dfxp, [_x('.//ttml:' + p), './/' + p])
2701         if ele is None:
2702             continue
2703         style = styles.get(ele.get('style'))
2704         if not style:
2705             continue
2706         default_style.update(style)
2707
2708     for para, index in zip(paras, itertools.count(1)):
2709         begin_time = parse_dfxp_time_expr(para.attrib.get('begin'))
2710         end_time = parse_dfxp_time_expr(para.attrib.get('end'))
2711         dur = parse_dfxp_time_expr(para.attrib.get('dur'))
2712         if begin_time is None:
2713             continue
2714         if not end_time:
2715             if not dur:
2716                 continue
2717             end_time = begin_time + dur
2718         out.append('%d\n%s --> %s\n%s\n\n' % (
2719             index,
2720             srt_subtitles_timecode(begin_time),
2721             srt_subtitles_timecode(end_time),
2722             parse_node(para)))
2723
2724     return ''.join(out)
2725
2726
2727 def cli_option(params, command_option, param):
2728     param = params.get(param)
2729     if param:
2730         param = compat_str(param)
2731     return [command_option, param] if param is not None else []
2732
2733
2734 def cli_bool_option(params, command_option, param, true_value='true', false_value='false', separator=None):
2735     param = params.get(param)
2736     if param is None:
2737         return []
2738     assert isinstance(param, bool)
2739     if separator:
2740         return [command_option + separator + (true_value if param else false_value)]
2741     return [command_option, true_value if param else false_value]
2742
2743
2744 def cli_valueless_option(params, command_option, param, expected_value=True):
2745     param = params.get(param)
2746     return [command_option] if param == expected_value else []
2747
2748
2749 def cli_configuration_args(params, param, default=[]):
2750     ex_args = params.get(param)
2751     if ex_args is None:
2752         return default
2753     assert isinstance(ex_args, list)
2754     return ex_args
2755
2756
2757 class ISO639Utils(object):
2758     # See http://www.loc.gov/standards/iso639-2/ISO-639-2_utf-8.txt
2759     _lang_map = {
2760         'aa': 'aar',
2761         'ab': 'abk',
2762         'ae': 'ave',
2763         'af': 'afr',
2764         'ak': 'aka',
2765         'am': 'amh',
2766         'an': 'arg',
2767         'ar': 'ara',
2768         'as': 'asm',
2769         'av': 'ava',
2770         'ay': 'aym',
2771         'az': 'aze',
2772         'ba': 'bak',
2773         'be': 'bel',
2774         'bg': 'bul',
2775         'bh': 'bih',
2776         'bi': 'bis',
2777         'bm': 'bam',
2778         'bn': 'ben',
2779         'bo': 'bod',
2780         'br': 'bre',
2781         'bs': 'bos',
2782         'ca': 'cat',
2783         'ce': 'che',
2784         'ch': 'cha',
2785         'co': 'cos',
2786         'cr': 'cre',
2787         'cs': 'ces',
2788         'cu': 'chu',
2789         'cv': 'chv',
2790         'cy': 'cym',
2791         'da': 'dan',
2792         'de': 'deu',
2793         'dv': 'div',
2794         'dz': 'dzo',
2795         'ee': 'ewe',
2796         'el': 'ell',
2797         'en': 'eng',
2798         'eo': 'epo',
2799         'es': 'spa',
2800         'et': 'est',
2801         'eu': 'eus',
2802         'fa': 'fas',
2803         'ff': 'ful',
2804         'fi': 'fin',
2805         'fj': 'fij',
2806         'fo': 'fao',
2807         'fr': 'fra',
2808         'fy': 'fry',
2809         'ga': 'gle',
2810         'gd': 'gla',
2811         'gl': 'glg',
2812         'gn': 'grn',
2813         'gu': 'guj',
2814         'gv': 'glv',
2815         'ha': 'hau',
2816         'he': 'heb',
2817         'hi': 'hin',
2818         'ho': 'hmo',
2819         'hr': 'hrv',
2820         'ht': 'hat',
2821         'hu': 'hun',
2822         'hy': 'hye',
2823         'hz': 'her',
2824         'ia': 'ina',
2825         'id': 'ind',
2826         'ie': 'ile',
2827         'ig': 'ibo',
2828         'ii': 'iii',
2829         'ik': 'ipk',
2830         'io': 'ido',
2831         'is': 'isl',
2832         'it': 'ita',
2833         'iu': 'iku',
2834         'ja': 'jpn',
2835         'jv': 'jav',
2836         'ka': 'kat',
2837         'kg': 'kon',
2838         'ki': 'kik',
2839         'kj': 'kua',
2840         'kk': 'kaz',
2841         'kl': 'kal',
2842         'km': 'khm',
2843         'kn': 'kan',
2844         'ko': 'kor',
2845         'kr': 'kau',
2846         'ks': 'kas',
2847         'ku': 'kur',
2848         'kv': 'kom',
2849         'kw': 'cor',
2850         'ky': 'kir',
2851         'la': 'lat',
2852         'lb': 'ltz',
2853         'lg': 'lug',
2854         'li': 'lim',
2855         'ln': 'lin',
2856         'lo': 'lao',
2857         'lt': 'lit',
2858         'lu': 'lub',
2859         'lv': 'lav',
2860         'mg': 'mlg',
2861         'mh': 'mah',
2862         'mi': 'mri',
2863         'mk': 'mkd',
2864         'ml': 'mal',
2865         'mn': 'mon',
2866         'mr': 'mar',
2867         'ms': 'msa',
2868         'mt': 'mlt',
2869         'my': 'mya',
2870         'na': 'nau',
2871         'nb': 'nob',
2872         'nd': 'nde',
2873         'ne': 'nep',
2874         'ng': 'ndo',
2875         'nl': 'nld',
2876         'nn': 'nno',
2877         'no': 'nor',
2878         'nr': 'nbl',
2879         'nv': 'nav',
2880         'ny': 'nya',
2881         'oc': 'oci',
2882         'oj': 'oji',
2883         'om': 'orm',
2884         'or': 'ori',
2885         'os': 'oss',
2886         'pa': 'pan',
2887         'pi': 'pli',
2888         'pl': 'pol',
2889         'ps': 'pus',
2890         'pt': 'por',
2891         'qu': 'que',
2892         'rm': 'roh',
2893         'rn': 'run',
2894         'ro': 'ron',
2895         'ru': 'rus',
2896         'rw': 'kin',
2897         'sa': 'san',
2898         'sc': 'srd',
2899         'sd': 'snd',
2900         'se': 'sme',
2901         'sg': 'sag',
2902         'si': 'sin',
2903         'sk': 'slk',
2904         'sl': 'slv',
2905         'sm': 'smo',
2906         'sn': 'sna',
2907         'so': 'som',
2908         'sq': 'sqi',
2909         'sr': 'srp',
2910         'ss': 'ssw',
2911         'st': 'sot',
2912         'su': 'sun',
2913         'sv': 'swe',
2914         'sw': 'swa',
2915         'ta': 'tam',
2916         'te': 'tel',
2917         'tg': 'tgk',
2918         'th': 'tha',
2919         'ti': 'tir',
2920         'tk': 'tuk',
2921         'tl': 'tgl',
2922         'tn': 'tsn',
2923         'to': 'ton',
2924         'tr': 'tur',
2925         'ts': 'tso',
2926         'tt': 'tat',
2927         'tw': 'twi',
2928         'ty': 'tah',
2929         'ug': 'uig',
2930         'uk': 'ukr',
2931         'ur': 'urd',
2932         'uz': 'uzb',
2933         've': 'ven',
2934         'vi': 'vie',
2935         'vo': 'vol',
2936         'wa': 'wln',
2937         'wo': 'wol',
2938         'xh': 'xho',
2939         'yi': 'yid',
2940         'yo': 'yor',
2941         'za': 'zha',
2942         'zh': 'zho',
2943         'zu': 'zul',
2944     }
2945
2946     @classmethod
2947     def short2long(cls, code):
2948         """Convert language code from ISO 639-1 to ISO 639-2/T"""
2949         return cls._lang_map.get(code[:2])
2950
2951     @classmethod
2952     def long2short(cls, code):
2953         """Convert language code from ISO 639-2/T to ISO 639-1"""
2954         for short_name, long_name in cls._lang_map.items():
2955             if long_name == code:
2956                 return short_name
2957
2958
2959 class ISO3166Utils(object):
2960     # From http://data.okfn.org/data/core/country-list
2961     _country_map = {
2962         'AF': 'Afghanistan',
2963         'AX': 'Åland Islands',
2964         'AL': 'Albania',
2965         'DZ': 'Algeria',
2966         'AS': 'American Samoa',
2967         'AD': 'Andorra',
2968         'AO': 'Angola',
2969         'AI': 'Anguilla',
2970         'AQ': 'Antarctica',
2971         'AG': 'Antigua and Barbuda',
2972         'AR': 'Argentina',
2973         'AM': 'Armenia',
2974         'AW': 'Aruba',
2975         'AU': 'Australia',
2976         'AT': 'Austria',
2977         'AZ': 'Azerbaijan',
2978         'BS': 'Bahamas',
2979         'BH': 'Bahrain',
2980         'BD': 'Bangladesh',
2981         'BB': 'Barbados',
2982         'BY': 'Belarus',
2983         'BE': 'Belgium',
2984         'BZ': 'Belize',
2985         'BJ': 'Benin',
2986         'BM': 'Bermuda',
2987         'BT': 'Bhutan',
2988         'BO': 'Bolivia, Plurinational State of',
2989         'BQ': 'Bonaire, Sint Eustatius and Saba',
2990         'BA': 'Bosnia and Herzegovina',
2991         'BW': 'Botswana',
2992         'BV': 'Bouvet Island',
2993         'BR': 'Brazil',
2994         'IO': 'British Indian Ocean Territory',
2995         'BN': 'Brunei Darussalam',
2996         'BG': 'Bulgaria',
2997         'BF': 'Burkina Faso',
2998         'BI': 'Burundi',
2999         'KH': 'Cambodia',
3000         'CM': 'Cameroon',
3001         'CA': 'Canada',
3002         'CV': 'Cape Verde',
3003         'KY': 'Cayman Islands',
3004         'CF': 'Central African Republic',
3005         'TD': 'Chad',
3006         'CL': 'Chile',
3007         'CN': 'China',
3008         'CX': 'Christmas Island',
3009         'CC': 'Cocos (Keeling) Islands',
3010         'CO': 'Colombia',
3011         'KM': 'Comoros',
3012         'CG': 'Congo',
3013         'CD': 'Congo, the Democratic Republic of the',
3014         'CK': 'Cook Islands',
3015         'CR': 'Costa Rica',
3016         'CI': 'Côte d\'Ivoire',
3017         'HR': 'Croatia',
3018         'CU': 'Cuba',
3019         'CW': 'Curaçao',
3020         'CY': 'Cyprus',
3021         'CZ': 'Czech Republic',
3022         'DK': 'Denmark',
3023         'DJ': 'Djibouti',
3024         'DM': 'Dominica',
3025         'DO': 'Dominican Republic',
3026         'EC': 'Ecuador',
3027         'EG': 'Egypt',
3028         'SV': 'El Salvador',
3029         'GQ': 'Equatorial Guinea',
3030         'ER': 'Eritrea',
3031         'EE': 'Estonia',
3032         'ET': 'Ethiopia',
3033         'FK': 'Falkland Islands (Malvinas)',
3034         'FO': 'Faroe Islands',
3035         'FJ': 'Fiji',
3036         'FI': 'Finland',
3037         'FR': 'France',
3038         'GF': 'French Guiana',
3039         'PF': 'French Polynesia',
3040         'TF': 'French Southern Territories',
3041         'GA': 'Gabon',
3042         'GM': 'Gambia',
3043         'GE': 'Georgia',
3044         'DE': 'Germany',
3045         'GH': 'Ghana',
3046         'GI': 'Gibraltar',
3047         'GR': 'Greece',
3048         'GL': 'Greenland',
3049         'GD': 'Grenada',
3050         'GP': 'Guadeloupe',
3051         'GU': 'Guam',
3052         'GT': 'Guatemala',
3053         'GG': 'Guernsey',
3054         'GN': 'Guinea',
3055         'GW': 'Guinea-Bissau',
3056         'GY': 'Guyana',
3057         'HT': 'Haiti',
3058         'HM': 'Heard Island and McDonald Islands',
3059         'VA': 'Holy See (Vatican City State)',
3060         'HN': 'Honduras',
3061         'HK': 'Hong Kong',
3062         'HU': 'Hungary',
3063         'IS': 'Iceland',
3064         'IN': 'India',
3065         'ID': 'Indonesia',
3066         'IR': 'Iran, Islamic Republic of',
3067         'IQ': 'Iraq',
3068         'IE': 'Ireland',
3069         'IM': 'Isle of Man',
3070         'IL': 'Israel',
3071         'IT': 'Italy',
3072         'JM': 'Jamaica',
3073         'JP': 'Japan',
3074         'JE': 'Jersey',
3075         'JO': 'Jordan',
3076         'KZ': 'Kazakhstan',
3077         'KE': 'Kenya',
3078         'KI': 'Kiribati',
3079         'KP': 'Korea, Democratic People\'s Republic of',
3080         'KR': 'Korea, Republic of',
3081         'KW': 'Kuwait',
3082         'KG': 'Kyrgyzstan',
3083         'LA': 'Lao People\'s Democratic Republic',
3084         'LV': 'Latvia',
3085         'LB': 'Lebanon',
3086         'LS': 'Lesotho',
3087         'LR': 'Liberia',
3088         'LY': 'Libya',
3089         'LI': 'Liechtenstein',
3090         'LT': 'Lithuania',
3091         'LU': 'Luxembourg',
3092         'MO': 'Macao',
3093         'MK': 'Macedonia, the Former Yugoslav Republic of',
3094         'MG': 'Madagascar',
3095         'MW': 'Malawi',
3096         'MY': 'Malaysia',
3097         'MV': 'Maldives',
3098         'ML': 'Mali',
3099         'MT': 'Malta',
3100         'MH': 'Marshall Islands',
3101         'MQ': 'Martinique',
3102         'MR': 'Mauritania',
3103         'MU': 'Mauritius',
3104         'YT': 'Mayotte',
3105         'MX': 'Mexico',
3106         'FM': 'Micronesia, Federated States of',
3107         'MD': 'Moldova, Republic of',
3108         'MC': 'Monaco',
3109         'MN': 'Mongolia',
3110         'ME': 'Montenegro',
3111         'MS': 'Montserrat',
3112         'MA': 'Morocco',
3113         'MZ': 'Mozambique',
3114         'MM': 'Myanmar',
3115         'NA': 'Namibia',
3116         'NR': 'Nauru',
3117         'NP': 'Nepal',
3118         'NL': 'Netherlands',
3119         'NC': 'New Caledonia',
3120         'NZ': 'New Zealand',
3121         'NI': 'Nicaragua',
3122         'NE': 'Niger',
3123         'NG': 'Nigeria',
3124         'NU': 'Niue',
3125         'NF': 'Norfolk Island',
3126         'MP': 'Northern Mariana Islands',
3127         'NO': 'Norway',
3128         'OM': 'Oman',
3129         'PK': 'Pakistan',
3130         'PW': 'Palau',
3131         'PS': 'Palestine, State of',
3132         'PA': 'Panama',
3133         'PG': 'Papua New Guinea',
3134         'PY': 'Paraguay',
3135         'PE': 'Peru',
3136         'PH': 'Philippines',
3137         'PN': 'Pitcairn',
3138         'PL': 'Poland',
3139         'PT': 'Portugal',
3140         'PR': 'Puerto Rico',
3141         'QA': 'Qatar',
3142         'RE': 'Réunion',
3143         'RO': 'Romania',
3144         'RU': 'Russian Federation',
3145         'RW': 'Rwanda',
3146         'BL': 'Saint Barthélemy',
3147         'SH': 'Saint Helena, Ascension and Tristan da Cunha',
3148         'KN': 'Saint Kitts and Nevis',
3149         'LC': 'Saint Lucia',
3150         'MF': 'Saint Martin (French part)',
3151         'PM': 'Saint Pierre and Miquelon',
3152         'VC': 'Saint Vincent and the Grenadines',
3153         'WS': 'Samoa',
3154         'SM': 'San Marino',
3155         'ST': 'Sao Tome and Principe',
3156         'SA': 'Saudi Arabia',
3157         'SN': 'Senegal',
3158         'RS': 'Serbia',
3159         'SC': 'Seychelles',
3160         'SL': 'Sierra Leone',
3161         'SG': 'Singapore',
3162         'SX': 'Sint Maarten (Dutch part)',
3163         'SK': 'Slovakia',
3164         'SI': 'Slovenia',
3165         'SB': 'Solomon Islands',
3166         'SO': 'Somalia',
3167         'ZA': 'South Africa',
3168         'GS': 'South Georgia and the South Sandwich Islands',
3169         'SS': 'South Sudan',
3170         'ES': 'Spain',
3171         'LK': 'Sri Lanka',
3172         'SD': 'Sudan',
3173         'SR': 'Suriname',
3174         'SJ': 'Svalbard and Jan Mayen',
3175         'SZ': 'Swaziland',
3176         'SE': 'Sweden',
3177         'CH': 'Switzerland',
3178         'SY': 'Syrian Arab Republic',
3179         'TW': 'Taiwan, Province of China',
3180         'TJ': 'Tajikistan',
3181         'TZ': 'Tanzania, United Republic of',
3182         'TH': 'Thailand',
3183         'TL': 'Timor-Leste',
3184         'TG': 'Togo',
3185         'TK': 'Tokelau',
3186         'TO': 'Tonga',
3187         'TT': 'Trinidad and Tobago',
3188         'TN': 'Tunisia',
3189         'TR': 'Turkey',
3190         'TM': 'Turkmenistan',
3191         'TC': 'Turks and Caicos Islands',
3192         'TV': 'Tuvalu',
3193         'UG': 'Uganda',
3194         'UA': 'Ukraine',
3195         'AE': 'United Arab Emirates',
3196         'GB': 'United Kingdom',
3197         'US': 'United States',
3198         'UM': 'United States Minor Outlying Islands',
3199         'UY': 'Uruguay',
3200         'UZ': 'Uzbekistan',
3201         'VU': 'Vanuatu',
3202         'VE': 'Venezuela, Bolivarian Republic of',
3203         'VN': 'Viet Nam',
3204         'VG': 'Virgin Islands, British',
3205         'VI': 'Virgin Islands, U.S.',
3206         'WF': 'Wallis and Futuna',
3207         'EH': 'Western Sahara',
3208         'YE': 'Yemen',
3209         'ZM': 'Zambia',
3210         'ZW': 'Zimbabwe',
3211     }
3212
3213     @classmethod
3214     def short2full(cls, code):
3215         """Convert an ISO 3166-2 country code to the corresponding full name"""
3216         return cls._country_map.get(code.upper())
3217
3218
3219 class GeoUtils(object):
3220     # Major IPv4 address blocks per country
3221     _country_ip_map = {
3222         'AD': '85.94.160.0/19',
3223         'AE': '94.200.0.0/13',
3224         'AF': '149.54.0.0/17',
3225         'AG': '209.59.64.0/18',
3226         'AI': '204.14.248.0/21',
3227         'AL': '46.99.0.0/16',
3228         'AM': '46.70.0.0/15',
3229         'AO': '105.168.0.0/13',
3230         'AP': '159.117.192.0/21',
3231         'AR': '181.0.0.0/12',
3232         'AS': '202.70.112.0/20',
3233         'AT': '84.112.0.0/13',
3234         'AU': '1.128.0.0/11',
3235         'AW': '181.41.0.0/18',
3236         'AZ': '5.191.0.0/16',
3237         'BA': '31.176.128.0/17',
3238         'BB': '65.48.128.0/17',
3239         'BD': '114.130.0.0/16',
3240         'BE': '57.0.0.0/8',
3241         'BF': '129.45.128.0/17',
3242         'BG': '95.42.0.0/15',
3243         'BH': '37.131.0.0/17',
3244         'BI': '154.117.192.0/18',
3245         'BJ': '137.255.0.0/16',
3246         'BL': '192.131.134.0/24',
3247         'BM': '196.12.64.0/18',
3248         'BN': '156.31.0.0/16',
3249         'BO': '161.56.0.0/16',
3250         'BQ': '161.0.80.0/20',
3251         'BR': '152.240.0.0/12',
3252         'BS': '24.51.64.0/18',
3253         'BT': '119.2.96.0/19',
3254         'BW': '168.167.0.0/16',
3255         'BY': '178.120.0.0/13',
3256         'BZ': '179.42.192.0/18',
3257         'CA': '99.224.0.0/11',
3258         'CD': '41.243.0.0/16',
3259         'CF': '196.32.200.0/21',
3260         'CG': '197.214.128.0/17',
3261         'CH': '85.0.0.0/13',
3262         'CI': '154.232.0.0/14',
3263         'CK': '202.65.32.0/19',
3264         'CL': '152.172.0.0/14',
3265         'CM': '165.210.0.0/15',
3266         'CN': '36.128.0.0/10',
3267         'CO': '181.240.0.0/12',
3268         'CR': '201.192.0.0/12',
3269         'CU': '152.206.0.0/15',
3270         'CV': '165.90.96.0/19',
3271         'CW': '190.88.128.0/17',
3272         'CY': '46.198.0.0/15',
3273         'CZ': '88.100.0.0/14',
3274         'DE': '53.0.0.0/8',
3275         'DJ': '197.241.0.0/17',
3276         'DK': '87.48.0.0/12',
3277         'DM': '192.243.48.0/20',
3278         'DO': '152.166.0.0/15',
3279         'DZ': '41.96.0.0/12',
3280         'EC': '186.68.0.0/15',
3281         'EE': '90.190.0.0/15',
3282         'EG': '156.160.0.0/11',
3283         'ER': '196.200.96.0/20',
3284         'ES': '88.0.0.0/11',
3285         'ET': '196.188.0.0/14',
3286         'EU': '2.16.0.0/13',
3287         'FI': '91.152.0.0/13',
3288         'FJ': '144.120.0.0/16',
3289         'FM': '119.252.112.0/20',
3290         'FO': '88.85.32.0/19',
3291         'FR': '90.0.0.0/9',
3292         'GA': '41.158.0.0/15',
3293         'GB': '25.0.0.0/8',
3294         'GD': '74.122.88.0/21',
3295         'GE': '31.146.0.0/16',
3296         'GF': '161.22.64.0/18',
3297         'GG': '62.68.160.0/19',
3298         'GH': '45.208.0.0/14',
3299         'GI': '85.115.128.0/19',
3300         'GL': '88.83.0.0/19',
3301         'GM': '160.182.0.0/15',
3302         'GN': '197.149.192.0/18',
3303         'GP': '104.250.0.0/19',
3304         'GQ': '105.235.224.0/20',
3305         'GR': '94.64.0.0/13',
3306         'GT': '168.234.0.0/16',
3307         'GU': '168.123.0.0/16',
3308         'GW': '197.214.80.0/20',
3309         'GY': '181.41.64.0/18',
3310         'HK': '113.252.0.0/14',
3311         'HN': '181.210.0.0/16',
3312         'HR': '93.136.0.0/13',
3313         'HT': '148.102.128.0/17',
3314         'HU': '84.0.0.0/14',
3315         'ID': '39.192.0.0/10',
3316         'IE': '87.32.0.0/12',
3317         'IL': '79.176.0.0/13',
3318         'IM': '5.62.80.0/20',
3319         'IN': '117.192.0.0/10',
3320         'IO': '203.83.48.0/21',
3321         'IQ': '37.236.0.0/14',
3322         'IR': '2.176.0.0/12',
3323         'IS': '82.221.0.0/16',
3324         'IT': '79.0.0.0/10',
3325         'JE': '87.244.64.0/18',
3326         'JM': '72.27.0.0/17',
3327         'JO': '176.29.0.0/16',
3328         'JP': '126.0.0.0/8',
3329         'KE': '105.48.0.0/12',
3330         'KG': '158.181.128.0/17',
3331         'KH': '36.37.128.0/17',
3332         'KI': '103.25.140.0/22',
3333         'KM': '197.255.224.0/20',
3334         'KN': '198.32.32.0/19',
3335         'KP': '175.45.176.0/22',
3336         'KR': '175.192.0.0/10',
3337         'KW': '37.36.0.0/14',
3338         'KY': '64.96.0.0/15',
3339         'KZ': '2.72.0.0/13',
3340         'LA': '115.84.64.0/18',
3341         'LB': '178.135.0.0/16',
3342         'LC': '192.147.231.0/24',
3343         'LI': '82.117.0.0/19',
3344         'LK': '112.134.0.0/15',
3345         'LR': '41.86.0.0/19',
3346         'LS': '129.232.0.0/17',
3347         'LT': '78.56.0.0/13',
3348         'LU': '188.42.0.0/16',
3349         'LV': '46.109.0.0/16',
3350         'LY': '41.252.0.0/14',
3351         'MA': '105.128.0.0/11',
3352         'MC': '88.209.64.0/18',
3353         'MD': '37.246.0.0/16',
3354         'ME': '178.175.0.0/17',
3355         'MF': '74.112.232.0/21',
3356         'MG': '154.126.0.0/17',
3357         'MH': '117.103.88.0/21',
3358         'MK': '77.28.0.0/15',
3359         'ML': '154.118.128.0/18',
3360         'MM': '37.111.0.0/17',
3361         'MN': '49.0.128.0/17',
3362         'MO': '60.246.0.0/16',
3363         'MP': '202.88.64.0/20',
3364         'MQ': '109.203.224.0/19',
3365         'MR': '41.188.64.0/18',
3366         'MS': '208.90.112.0/22',
3367         'MT': '46.11.0.0/16',
3368         'MU': '105.16.0.0/12',
3369         'MV': '27.114.128.0/18',
3370         'MW': '105.234.0.0/16',
3371         'MX': '187.192.0.0/11',
3372         'MY': '175.136.0.0/13',
3373         'MZ': '197.218.0.0/15',
3374         'NA': '41.182.0.0/16',
3375         'NC': '101.101.0.0/18',
3376         'NE': '197.214.0.0/18',
3377         'NF': '203.17.240.0/22',
3378         'NG': '105.112.0.0/12',
3379         'NI': '186.76.0.0/15',
3380         'NL': '145.96.0.0/11',
3381         'NO': '84.208.0.0/13',
3382         'NP': '36.252.0.0/15',
3383         'NR': '203.98.224.0/19',
3384         'NU': '49.156.48.0/22',
3385         'NZ': '49.224.0.0/14',
3386         'OM': '5.36.0.0/15',
3387         'PA': '186.72.0.0/15',
3388         'PE': '186.160.0.0/14',
3389         'PF': '123.50.64.0/18',
3390         'PG': '124.240.192.0/19',
3391         'PH': '49.144.0.0/13',
3392         'PK': '39.32.0.0/11',
3393         'PL': '83.0.0.0/11',
3394         'PM': '70.36.0.0/20',
3395         'PR': '66.50.0.0/16',
3396         'PS': '188.161.0.0/16',
3397         'PT': '85.240.0.0/13',
3398         'PW': '202.124.224.0/20',
3399         'PY': '181.120.0.0/14',
3400         'QA': '37.210.0.0/15',
3401         'RE': '139.26.0.0/16',
3402         'RO': '79.112.0.0/13',
3403         'RS': '178.220.0.0/14',
3404         'RU': '5.136.0.0/13',
3405         'RW': '105.178.0.0/15',
3406         'SA': '188.48.0.0/13',
3407         'SB': '202.1.160.0/19',
3408         'SC': '154.192.0.0/11',
3409         'SD': '154.96.0.0/13',
3410         'SE': '78.64.0.0/12',
3411         'SG': '152.56.0.0/14',
3412         'SI': '188.196.0.0/14',
3413         'SK': '78.98.0.0/15',
3414         'SL': '197.215.0.0/17',
3415         'SM': '89.186.32.0/19',
3416         'SN': '41.82.0.0/15',
3417         'SO': '197.220.64.0/19',
3418         'SR': '186.179.128.0/17',
3419         'SS': '105.235.208.0/21',
3420         'ST': '197.159.160.0/19',
3421         'SV': '168.243.0.0/16',
3422         'SX': '190.102.0.0/20',
3423         'SY': '5.0.0.0/16',
3424         'SZ': '41.84.224.0/19',
3425         'TC': '65.255.48.0/20',
3426         'TD': '154.68.128.0/19',
3427         'TG': '196.168.0.0/14',
3428         'TH': '171.96.0.0/13',
3429         'TJ': '85.9.128.0/18',
3430         'TK': '27.96.24.0/21',
3431         'TL': '180.189.160.0/20',
3432         'TM': '95.85.96.0/19',
3433         'TN': '197.0.0.0/11',
3434         'TO': '175.176.144.0/21',
3435         'TR': '78.160.0.0/11',
3436         'TT': '186.44.0.0/15',
3437         'TV': '202.2.96.0/19',
3438         'TW': '120.96.0.0/11',
3439         'TZ': '156.156.0.0/14',
3440         'UA': '93.72.0.0/13',
3441         'UG': '154.224.0.0/13',
3442         'US': '3.0.0.0/8',
3443         'UY': '167.56.0.0/13',
3444         'UZ': '82.215.64.0/18',
3445         'VA': '212.77.0.0/19',
3446         'VC': '24.92.144.0/20',
3447         'VE': '186.88.0.0/13',
3448         'VG': '172.103.64.0/18',
3449         'VI': '146.226.0.0/16',
3450         'VN': '14.160.0.0/11',
3451         'VU': '202.80.32.0/20',
3452         'WF': '117.20.32.0/21',
3453         'WS': '202.4.32.0/19',
3454         'YE': '134.35.0.0/16',
3455         'YT': '41.242.116.0/22',
3456         'ZA': '41.0.0.0/11',
3457         'ZM': '165.56.0.0/13',
3458         'ZW': '41.85.192.0/19',
3459     }
3460
3461     @classmethod
3462     def random_ipv4(cls, code):
3463         block = cls._country_ip_map.get(code.upper())
3464         if not block:
3465             return None
3466         addr, preflen = block.split('/')
3467         addr_min = compat_struct_unpack('!L', socket.inet_aton(addr))[0]
3468         addr_max = addr_min | (0xffffffff >> int(preflen))
3469         return compat_str(socket.inet_ntoa(
3470             compat_struct_pack('!L', random.randint(addr_min, addr_max))))
3471
3472
3473 class PerRequestProxyHandler(compat_urllib_request.ProxyHandler):
3474     def __init__(self, proxies=None):
3475         # Set default handlers
3476         for type in ('http', 'https'):
3477             setattr(self, '%s_open' % type,
3478                     lambda r, proxy='__noproxy__', type=type, meth=self.proxy_open:
3479                         meth(r, proxy, type))
3480         return compat_urllib_request.ProxyHandler.__init__(self, proxies)
3481
3482     def proxy_open(self, req, proxy, type):
3483         req_proxy = req.headers.get('Ytdl-request-proxy')
3484         if req_proxy is not None:
3485             proxy = req_proxy
3486             del req.headers['Ytdl-request-proxy']
3487
3488         if proxy == '__noproxy__':
3489             return None  # No Proxy
3490         if compat_urlparse.urlparse(proxy).scheme.lower() in ('socks', 'socks4', 'socks4a', 'socks5'):
3491             req.add_header('Ytdl-socks-proxy', proxy)
3492             # youtube-dl's http/https handlers do wrapping the socket with socks
3493             return None
3494         return compat_urllib_request.ProxyHandler.proxy_open(
3495             self, req, proxy, type)
3496
3497
3498 # Both long_to_bytes and bytes_to_long are adapted from PyCrypto, which is
3499 # released into Public Domain
3500 # https://github.com/dlitz/pycrypto/blob/master/lib/Crypto/Util/number.py#L387
3501
3502 def long_to_bytes(n, blocksize=0):
3503     """long_to_bytes(n:long, blocksize:int) : string
3504     Convert a long integer to a byte string.
3505
3506     If optional blocksize is given and greater than zero, pad the front of the
3507     byte string with binary zeros so that the length is a multiple of
3508     blocksize.
3509     """
3510     # after much testing, this algorithm was deemed to be the fastest
3511     s = b''
3512     n = int(n)
3513     while n > 0:
3514         s = compat_struct_pack('>I', n & 0xffffffff) + s
3515         n = n >> 32
3516     # strip off leading zeros
3517     for i in range(len(s)):
3518         if s[i] != b'\000'[0]:
3519             break
3520     else:
3521         # only happens when n == 0
3522         s = b'\000'
3523         i = 0
3524     s = s[i:]
3525     # add back some pad bytes.  this could be done more efficiently w.r.t. the
3526     # de-padding being done above, but sigh...
3527     if blocksize > 0 and len(s) % blocksize:
3528         s = (blocksize - len(s) % blocksize) * b'\000' + s
3529     return s
3530
3531
3532 def bytes_to_long(s):
3533     """bytes_to_long(string) : long
3534     Convert a byte string to a long integer.
3535
3536     This is (essentially) the inverse of long_to_bytes().
3537     """
3538     acc = 0
3539     length = len(s)
3540     if length % 4:
3541         extra = (4 - length % 4)
3542         s = b'\000' * extra + s
3543         length = length + extra
3544     for i in range(0, length, 4):
3545         acc = (acc << 32) + compat_struct_unpack('>I', s[i:i + 4])[0]
3546     return acc
3547
3548
3549 def ohdave_rsa_encrypt(data, exponent, modulus):
3550     '''
3551     Implement OHDave's RSA algorithm. See http://www.ohdave.com/rsa/
3552
3553     Input:
3554         data: data to encrypt, bytes-like object
3555         exponent, modulus: parameter e and N of RSA algorithm, both integer
3556     Output: hex string of encrypted data
3557
3558     Limitation: supports one block encryption only
3559     '''
3560
3561     payload = int(binascii.hexlify(data[::-1]), 16)
3562     encrypted = pow(payload, exponent, modulus)
3563     return '%x' % encrypted
3564
3565
3566 def pkcs1pad(data, length):
3567     """
3568     Padding input data with PKCS#1 scheme
3569
3570     @param {int[]} data        input data
3571     @param {int}   length      target length
3572     @returns {int[]}           padded data
3573     """
3574     if len(data) > length - 11:
3575         raise ValueError('Input data too long for PKCS#1 padding')
3576
3577     pseudo_random = [random.randint(0, 254) for _ in range(length - len(data) - 3)]
3578     return [0, 2] + pseudo_random + [0] + data
3579
3580
3581 def encode_base_n(num, n, table=None):
3582     FULL_TABLE = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
3583     if not table:
3584         table = FULL_TABLE[:n]
3585
3586     if n > len(table):
3587         raise ValueError('base %d exceeds table length %d' % (n, len(table)))
3588
3589     if num == 0:
3590         return table[0]
3591
3592     ret = ''
3593     while num:
3594         ret = table[num % n] + ret
3595         num = num // n
3596     return ret
3597
3598
3599 def decode_packed_codes(code):
3600     mobj = re.search(PACKED_CODES_RE, code)
3601     obfucasted_code, base, count, symbols = mobj.groups()
3602     base = int(base)
3603     count = int(count)
3604     symbols = symbols.split('|')
3605     symbol_table = {}
3606
3607     while count:
3608         count -= 1
3609         base_n_count = encode_base_n(count, base)
3610         symbol_table[base_n_count] = symbols[count] or base_n_count
3611
3612     return re.sub(
3613         r'\b(\w+)\b', lambda mobj: symbol_table[mobj.group(0)],
3614         obfucasted_code)
3615
3616
3617 def parse_m3u8_attributes(attrib):
3618     info = {}
3619     for (key, val) in re.findall(r'(?P<key>[A-Z0-9-]+)=(?P<val>"[^"]+"|[^",]+)(?:,|$)', attrib):
3620         if val.startswith('"'):
3621             val = val[1:-1]
3622         info[key] = val
3623     return info
3624
3625
3626 def urshift(val, n):
3627     return val >> n if val >= 0 else (val + 0x100000000) >> n
3628
3629
3630 # Based on png2str() written by @gdkchan and improved by @yokrysty
3631 # Originally posted at https://github.com/rg3/youtube-dl/issues/9706
3632 def decode_png(png_data):
3633     # Reference: https://www.w3.org/TR/PNG/
3634     header = png_data[8:]
3635
3636     if png_data[:8] != b'\x89PNG\x0d\x0a\x1a\x0a' or header[4:8] != b'IHDR':
3637         raise IOError('Not a valid PNG file.')
3638
3639     int_map = {1: '>B', 2: '>H', 4: '>I'}
3640     unpack_integer = lambda x: compat_struct_unpack(int_map[len(x)], x)[0]
3641
3642     chunks = []
3643
3644     while header:
3645         length = unpack_integer(header[:4])
3646         header = header[4:]
3647
3648         chunk_type = header[:4]
3649         header = header[4:]
3650
3651         chunk_data = header[:length]
3652         header = header[length:]
3653
3654         header = header[4:]  # Skip CRC
3655
3656         chunks.append({
3657             'type': chunk_type,
3658             'length': length,
3659             'data': chunk_data
3660         })
3661
3662     ihdr = chunks[0]['data']
3663
3664     width = unpack_integer(ihdr[:4])
3665     height = unpack_integer(ihdr[4:8])
3666
3667     idat = b''
3668
3669     for chunk in chunks:
3670         if chunk['type'] == b'IDAT':
3671             idat += chunk['data']
3672
3673     if not idat:
3674         raise IOError('Unable to read PNG data.')
3675
3676     decompressed_data = bytearray(zlib.decompress(idat))
3677
3678     stride = width * 3
3679     pixels = []
3680
3681     def _get_pixel(idx):
3682         x = idx % stride
3683         y = idx // stride
3684         return pixels[y][x]
3685
3686     for y in range(height):
3687         basePos = y * (1 + stride)
3688         filter_type = decompressed_data[basePos]
3689
3690         current_row = []
3691
3692         pixels.append(current_row)
3693
3694         for x in range(stride):
3695             color = decompressed_data[1 + basePos + x]
3696             basex = y * stride + x
3697             left = 0
3698             up = 0
3699
3700             if x > 2:
3701                 left = _get_pixel(basex - 3)
3702             if y > 0:
3703                 up = _get_pixel(basex - stride)
3704
3705             if filter_type == 1:  # Sub
3706                 color = (color + left) & 0xff
3707             elif filter_type == 2:  # Up
3708                 color = (color + up) & 0xff
3709             elif filter_type == 3:  # Average
3710                 color = (color + ((left + up) >> 1)) & 0xff
3711             elif filter_type == 4:  # Paeth
3712                 a = left
3713                 b = up
3714                 c = 0
3715
3716                 if x > 2 and y > 0:
3717                     c = _get_pixel(basex - stride - 3)
3718
3719                 p = a + b - c
3720
3721                 pa = abs(p - a)
3722                 pb = abs(p - b)
3723                 pc = abs(p - c)
3724
3725                 if pa <= pb and pa <= pc:
3726                     color = (color + a) & 0xff
3727                 elif pb <= pc:
3728                     color = (color + b) & 0xff
3729                 else:
3730                     color = (color + c) & 0xff
3731
3732             current_row.append(color)
3733
3734     return width, height, pixels
3735
3736
3737 def write_xattr(path, key, value):
3738     # This mess below finds the best xattr tool for the job
3739     try:
3740         # try the pyxattr module...
3741         import xattr
3742
3743         if hasattr(xattr, 'set'):  # pyxattr
3744             # Unicode arguments are not supported in python-pyxattr until
3745             # version 0.5.0
3746             # See https://github.com/rg3/youtube-dl/issues/5498
3747             pyxattr_required_version = '0.5.0'
3748             if version_tuple(xattr.__version__) < version_tuple(pyxattr_required_version):
3749                 # TODO: fallback to CLI tools
3750                 raise XAttrUnavailableError(
3751                     'python-pyxattr is detected but is too old. '
3752                     'youtube-dl requires %s or above while your version is %s. '
3753                     'Falling back to other xattr implementations' % (
3754                         pyxattr_required_version, xattr.__version__))
3755
3756             setxattr = xattr.set
3757         else:  # xattr
3758             setxattr = xattr.setxattr
3759
3760         try:
3761             setxattr(path, key, value)
3762         except EnvironmentError as e:
3763             raise XAttrMetadataError(e.errno, e.strerror)
3764
3765     except ImportError:
3766         if compat_os_name == 'nt':
3767             # Write xattrs to NTFS Alternate Data Streams:
3768             # http://en.wikipedia.org/wiki/NTFS#Alternate_data_streams_.28ADS.29
3769             assert ':' not in key
3770             assert os.path.exists(path)
3771
3772             ads_fn = path + ':' + key
3773             try:
3774                 with open(ads_fn, 'wb') as f:
3775                     f.write(value)
3776             except EnvironmentError as e:
3777                 raise XAttrMetadataError(e.errno, e.strerror)
3778         else:
3779             user_has_setfattr = check_executable('setfattr', ['--version'])
3780             user_has_xattr = check_executable('xattr', ['-h'])
3781
3782             if user_has_setfattr or user_has_xattr:
3783
3784                 value = value.decode('utf-8')
3785                 if user_has_setfattr:
3786                     executable = 'setfattr'
3787                     opts = ['-n', key, '-v', value]
3788                 elif user_has_xattr:
3789                     executable = 'xattr'
3790                     opts = ['-w', key, value]
3791
3792                 cmd = ([encodeFilename(executable, True)] +
3793                        [encodeArgument(o) for o in opts] +
3794                        [encodeFilename(path, True)])
3795
3796                 try:
3797                     p = subprocess.Popen(
3798                         cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, stdin=subprocess.PIPE)
3799                 except EnvironmentError as e:
3800                     raise XAttrMetadataError(e.errno, e.strerror)
3801                 stdout, stderr = p.communicate()
3802                 stderr = stderr.decode('utf-8', 'replace')
3803                 if p.returncode != 0:
3804                     raise XAttrMetadataError(p.returncode, stderr)
3805
3806             else:
3807                 # On Unix, and can't find pyxattr, setfattr, or xattr.
3808                 if sys.platform.startswith('linux'):
3809                     raise XAttrUnavailableError(
3810                         "Couldn't find a tool to set the xattrs. "
3811                         "Install either the python 'pyxattr' or 'xattr' "
3812                         "modules, or the GNU 'attr' package "
3813                         "(which contains the 'setfattr' tool).")
3814                 else:
3815                     raise XAttrUnavailableError(
3816                         "Couldn't find a tool to set the xattrs. "
3817                         "Install either the python 'xattr' module, "
3818                         "or the 'xattr' binary.")
3819
3820
3821 def random_birthday(year_field, month_field, day_field):
3822     return {
3823         year_field: str(random.randint(1950, 1995)),
3824         month_field: str(random.randint(1, 12)),
3825         day_field: str(random.randint(1, 31)),
3826     }