]>
Commit | Line | Data |
---|---|---|
6929b41a | 1 | import asyncio |
15dfb392 | 2 | import atexit |
1e399778 | 3 | import base64 |
5bc880b9 | 4 | import binascii |
912b38b4 | 5 | import calendar |
676eb3f2 | 6 | import codecs |
c380cc28 | 7 | import collections |
ab029d7e | 8 | import collections.abc |
62e609ab | 9 | import contextlib |
c496ca96 | 10 | import datetime |
0c265486 | 11 | import email.header |
f8271158 | 12 | import email.utils |
f45c185f | 13 | import errno |
d77c3dfd | 14 | import gzip |
49fa4d9a N |
15 | import hashlib |
16 | import hmac | |
ac668111 | 17 | import html.entities |
18 | import html.parser | |
54007a45 | 19 | import http.client |
20 | import http.cookiejar | |
b1f94422 | 21 | import inspect |
03f9daab | 22 | import io |
79a2e94e | 23 | import itertools |
f4bfd65f | 24 | import json |
d77c3dfd | 25 | import locale |
02dbf93f | 26 | import math |
f8271158 | 27 | import mimetypes |
347de493 | 28 | import operator |
d77c3dfd | 29 | import os |
c496ca96 | 30 | import platform |
773f291d | 31 | import random |
d77c3dfd | 32 | import re |
f8271158 | 33 | import shlex |
c496ca96 | 34 | import socket |
79a2e94e | 35 | import ssl |
ac668111 | 36 | import struct |
1c088fa8 | 37 | import subprocess |
d77c3dfd | 38 | import sys |
181c8655 | 39 | import tempfile |
c380cc28 | 40 | import time |
01951dda | 41 | import traceback |
64fa820c | 42 | import types |
989a01c2 | 43 | import unicodedata |
14f25df2 | 44 | import urllib.error |
f8271158 | 45 | import urllib.parse |
ac668111 | 46 | import urllib.request |
bcf89ce6 | 47 | import xml.etree.ElementTree |
d77c3dfd | 48 | import zlib |
d77c3dfd | 49 | |
6929b41a | 50 | from .compat import functools # isort: split |
8c25f81b | 51 | from .compat import ( |
36e6f62c | 52 | compat_etree_fromstring, |
51098426 | 53 | compat_expanduser, |
f8271158 | 54 | compat_HTMLParseError, |
efa97bdc | 55 | compat_os_name, |
702ccf2d | 56 | compat_shlex_quote, |
8c25f81b | 57 | ) |
ac668111 | 58 | from .dependencies import brotli, certifi, websockets, xattr |
f8271158 | 59 | from .socks import ProxyType, sockssocket |
71aff188 | 60 | |
4644ac55 | 61 | |
51fb4995 YCH |
62 | def register_socks_protocols(): |
63 | # "Register" SOCKS protocols | |
d5ae6bb5 YCH |
64 | # In Python < 2.6.5, urlsplit() suffers from bug https://bugs.python.org/issue7904 |
65 | # URLs with protocols not in urlparse.uses_netloc are not handled correctly | |
51fb4995 | 66 | for scheme in ('socks', 'socks4', 'socks4a', 'socks5'): |
14f25df2 | 67 | if scheme not in urllib.parse.uses_netloc: |
68 | urllib.parse.uses_netloc.append(scheme) | |
51fb4995 YCH |
69 | |
70 | ||
468e2e92 FV |
71 | # This is not clearly defined otherwise |
72 | compiled_regex_type = type(re.compile('')) | |
73 | ||
f7a147e3 S |
74 | |
75 | def random_user_agent(): | |
76 | _USER_AGENT_TPL = 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/%s Safari/537.36' | |
77 | _CHROME_VERSIONS = ( | |
19b4c74d | 78 | '90.0.4430.212', |
79 | '90.0.4430.24', | |
80 | '90.0.4430.70', | |
81 | '90.0.4430.72', | |
82 | '90.0.4430.85', | |
83 | '90.0.4430.93', | |
84 | '91.0.4472.101', | |
85 | '91.0.4472.106', | |
86 | '91.0.4472.114', | |
87 | '91.0.4472.124', | |
88 | '91.0.4472.164', | |
89 | '91.0.4472.19', | |
90 | '91.0.4472.77', | |
91 | '92.0.4515.107', | |
92 | '92.0.4515.115', | |
93 | '92.0.4515.131', | |
94 | '92.0.4515.159', | |
95 | '92.0.4515.43', | |
96 | '93.0.4556.0', | |
97 | '93.0.4577.15', | |
98 | '93.0.4577.63', | |
99 | '93.0.4577.82', | |
100 | '94.0.4606.41', | |
101 | '94.0.4606.54', | |
102 | '94.0.4606.61', | |
103 | '94.0.4606.71', | |
104 | '94.0.4606.81', | |
105 | '94.0.4606.85', | |
106 | '95.0.4638.17', | |
107 | '95.0.4638.50', | |
108 | '95.0.4638.54', | |
109 | '95.0.4638.69', | |
110 | '95.0.4638.74', | |
111 | '96.0.4664.18', | |
112 | '96.0.4664.45', | |
113 | '96.0.4664.55', | |
114 | '96.0.4664.93', | |
115 | '97.0.4692.20', | |
f7a147e3 S |
116 | ) |
117 | return _USER_AGENT_TPL % random.choice(_CHROME_VERSIONS) | |
118 | ||
119 | ||
4390d5ec | 120 | SUPPORTED_ENCODINGS = [ |
121 | 'gzip', 'deflate' | |
122 | ] | |
9b8ee23b | 123 | if brotli: |
4390d5ec | 124 | SUPPORTED_ENCODINGS.append('br') |
125 | ||
3e669f36 | 126 | std_headers = { |
f7a147e3 | 127 | 'User-Agent': random_user_agent(), |
59ae15a5 | 128 | 'Accept': 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8', |
59ae15a5 | 129 | 'Accept-Language': 'en-us,en;q=0.5', |
b1156c1e | 130 | 'Sec-Fetch-Mode': 'navigate', |
3e669f36 | 131 | } |
f427df17 | 132 | |
5f6a1245 | 133 | |
fb37eb25 S |
134 | USER_AGENTS = { |
135 | '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', | |
136 | } | |
137 | ||
138 | ||
bf42a990 | 139 | NO_DEFAULT = object() |
7b2c3f47 | 140 | IDENTITY = lambda x: x |
bf42a990 | 141 | |
7105440c YCH |
142 | ENGLISH_MONTH_NAMES = [ |
143 | 'January', 'February', 'March', 'April', 'May', 'June', | |
144 | 'July', 'August', 'September', 'October', 'November', 'December'] | |
145 | ||
f6717dec S |
146 | MONTH_NAMES = { |
147 | 'en': ENGLISH_MONTH_NAMES, | |
148 | 'fr': [ | |
3e4185c3 S |
149 | 'janvier', 'février', 'mars', 'avril', 'mai', 'juin', |
150 | 'juillet', 'août', 'septembre', 'octobre', 'novembre', 'décembre'], | |
78545664 | 151 | # these follow the genitive grammatical case (dopełniacz) |
152 | # some websites might be using nominative, which will require another month list | |
153 | # https://en.wikibooks.org/wiki/Polish/Noun_cases | |
154 | 'pl': ['stycznia', 'lutego', 'marca', 'kwietnia', 'maja', 'czerwca', | |
155 | 'lipca', 'sierpnia', 'września', 'października', 'listopada', 'grudnia'], | |
f6717dec | 156 | } |
a942d6cb | 157 | |
8f53dc44 | 158 | # From https://github.com/python/cpython/blob/3.11/Lib/email/_parseaddr.py#L36-L42 |
159 | TIMEZONE_NAMES = { | |
160 | 'UT': 0, 'UTC': 0, 'GMT': 0, 'Z': 0, | |
161 | 'AST': -4, 'ADT': -3, # Atlantic (used in Canada) | |
162 | 'EST': -5, 'EDT': -4, # Eastern | |
163 | 'CST': -6, 'CDT': -5, # Central | |
164 | 'MST': -7, 'MDT': -6, # Mountain | |
165 | 'PST': -8, 'PDT': -7 # Pacific | |
166 | } | |
167 | ||
c587cbb7 | 168 | # needed for sanitizing filenames in restricted mode |
c8827027 | 169 | ACCENT_CHARS = dict(zip('ÂÃÄÀÁÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖŐØŒÙÚÛÜŰÝÞßàáâãäåæçèéêëìíîïðñòóôõöőøœùúûüűýþÿ', |
fd35d8cd JW |
170 | itertools.chain('AAAAAA', ['AE'], 'CEEEEIIIIDNOOOOOOO', ['OE'], 'UUUUUY', ['TH', 'ss'], |
171 | 'aaaaaa', ['ae'], 'ceeeeiiiionooooooo', ['oe'], 'uuuuuy', ['th'], 'y'))) | |
c587cbb7 | 172 | |
46f59e89 S |
173 | DATE_FORMATS = ( |
174 | '%d %B %Y', | |
175 | '%d %b %Y', | |
176 | '%B %d %Y', | |
cb655f34 S |
177 | '%B %dst %Y', |
178 | '%B %dnd %Y', | |
9d30c213 | 179 | '%B %drd %Y', |
cb655f34 | 180 | '%B %dth %Y', |
46f59e89 | 181 | '%b %d %Y', |
cb655f34 S |
182 | '%b %dst %Y', |
183 | '%b %dnd %Y', | |
9d30c213 | 184 | '%b %drd %Y', |
cb655f34 | 185 | '%b %dth %Y', |
46f59e89 S |
186 | '%b %dst %Y %I:%M', |
187 | '%b %dnd %Y %I:%M', | |
9d30c213 | 188 | '%b %drd %Y %I:%M', |
46f59e89 S |
189 | '%b %dth %Y %I:%M', |
190 | '%Y %m %d', | |
191 | '%Y-%m-%d', | |
bccdbd22 | 192 | '%Y.%m.%d.', |
46f59e89 | 193 | '%Y/%m/%d', |
81c13222 | 194 | '%Y/%m/%d %H:%M', |
46f59e89 | 195 | '%Y/%m/%d %H:%M:%S', |
1931a55e THD |
196 | '%Y%m%d%H%M', |
197 | '%Y%m%d%H%M%S', | |
4f3fa23e | 198 | '%Y%m%d', |
0c1c6f4b | 199 | '%Y-%m-%d %H:%M', |
46f59e89 S |
200 | '%Y-%m-%d %H:%M:%S', |
201 | '%Y-%m-%d %H:%M:%S.%f', | |
5014558a | 202 | '%Y-%m-%d %H:%M:%S:%f', |
46f59e89 S |
203 | '%d.%m.%Y %H:%M', |
204 | '%d.%m.%Y %H.%M', | |
205 | '%Y-%m-%dT%H:%M:%SZ', | |
206 | '%Y-%m-%dT%H:%M:%S.%fZ', | |
207 | '%Y-%m-%dT%H:%M:%S.%f0Z', | |
208 | '%Y-%m-%dT%H:%M:%S', | |
209 | '%Y-%m-%dT%H:%M:%S.%f', | |
210 | '%Y-%m-%dT%H:%M', | |
c6eed6b8 S |
211 | '%b %d %Y at %H:%M', |
212 | '%b %d %Y at %H:%M:%S', | |
b555ae9b S |
213 | '%B %d %Y at %H:%M', |
214 | '%B %d %Y at %H:%M:%S', | |
a63d9bd0 | 215 | '%H:%M %d-%b-%Y', |
46f59e89 S |
216 | ) |
217 | ||
218 | DATE_FORMATS_DAY_FIRST = list(DATE_FORMATS) | |
219 | DATE_FORMATS_DAY_FIRST.extend([ | |
220 | '%d-%m-%Y', | |
221 | '%d.%m.%Y', | |
222 | '%d.%m.%y', | |
223 | '%d/%m/%Y', | |
224 | '%d/%m/%y', | |
225 | '%d/%m/%Y %H:%M:%S', | |
47304e07 | 226 | '%d-%m-%Y %H:%M', |
46f59e89 S |
227 | ]) |
228 | ||
229 | DATE_FORMATS_MONTH_FIRST = list(DATE_FORMATS) | |
230 | DATE_FORMATS_MONTH_FIRST.extend([ | |
231 | '%m-%d-%Y', | |
232 | '%m.%d.%Y', | |
233 | '%m/%d/%Y', | |
234 | '%m/%d/%y', | |
235 | '%m/%d/%Y %H:%M:%S', | |
236 | ]) | |
237 | ||
06b3fe29 | 238 | PACKED_CODES_RE = r"}\('(.+)',(\d+),(\d+),'([^']+)'\.split\('\|'\)" |
0f60ba6e | 239 | JSON_LD_RE = r'(?is)<script[^>]+type=(["\']?)application/ld\+json\1[^>]*>\s*(?P<json_ld>{.+?}|\[.+?\])\s*</script>' |
06b3fe29 | 240 | |
1d485a1a | 241 | NUMBER_RE = r'\d+(?:\.\d+)?' |
242 | ||
7105440c | 243 | |
0b9c08b4 | 244 | @functools.cache |
d77c3dfd | 245 | def preferredencoding(): |
59ae15a5 | 246 | """Get preferred encoding. |
d77c3dfd | 247 | |
59ae15a5 PH |
248 | Returns the best encoding scheme for the system, based on |
249 | locale.getpreferredencoding() and some further tweaks. | |
250 | """ | |
251 | try: | |
252 | pref = locale.getpreferredencoding() | |
28e614de | 253 | 'TEST'.encode(pref) |
70a1165b | 254 | except Exception: |
59ae15a5 | 255 | pref = 'UTF-8' |
bae611f2 | 256 | |
59ae15a5 | 257 | return pref |
d77c3dfd | 258 | |
f4bfd65f | 259 | |
181c8655 | 260 | def write_json_file(obj, fn): |
1394646a | 261 | """ Encode obj as JSON and write it to fn, atomically if possible """ |
181c8655 | 262 | |
cfb0511d | 263 | tf = tempfile.NamedTemporaryFile( |
264 | prefix=f'{os.path.basename(fn)}.', dir=os.path.dirname(fn), | |
265 | suffix='.tmp', delete=False, mode='w', encoding='utf-8') | |
181c8655 PH |
266 | |
267 | try: | |
268 | with tf: | |
45d86abe | 269 | json.dump(obj, tf, ensure_ascii=False) |
1394646a IK |
270 | if sys.platform == 'win32': |
271 | # Need to remove existing file on Windows, else os.rename raises | |
272 | # WindowsError or FileExistsError. | |
19a03940 | 273 | with contextlib.suppress(OSError): |
1394646a | 274 | os.unlink(fn) |
19a03940 | 275 | with contextlib.suppress(OSError): |
9cd5f54e R |
276 | mask = os.umask(0) |
277 | os.umask(mask) | |
278 | os.chmod(tf.name, 0o666 & ~mask) | |
181c8655 | 279 | os.rename(tf.name, fn) |
70a1165b | 280 | except Exception: |
19a03940 | 281 | with contextlib.suppress(OSError): |
181c8655 | 282 | os.remove(tf.name) |
181c8655 PH |
283 | raise |
284 | ||
285 | ||
cfb0511d | 286 | def find_xpath_attr(node, xpath, key, val=None): |
287 | """ Find the xpath xpath[@key=val] """ | |
288 | assert re.match(r'^[a-zA-Z_-]+$', key) | |
86e5f3ed | 289 | expr = xpath + ('[@%s]' % key if val is None else f"[@{key}='{val}']") |
cfb0511d | 290 | return node.find(expr) |
59ae56fa | 291 | |
d7e66d39 JMF |
292 | # On python2.6 the xml.etree.ElementTree.Element methods don't support |
293 | # the namespace parameter | |
5f6a1245 JW |
294 | |
295 | ||
d7e66d39 JMF |
296 | def xpath_with_ns(path, ns_map): |
297 | components = [c.split(':') for c in path.split('/')] | |
298 | replaced = [] | |
299 | for c in components: | |
300 | if len(c) == 1: | |
301 | replaced.append(c[0]) | |
302 | else: | |
303 | ns, tag = c | |
304 | replaced.append('{%s}%s' % (ns_map[ns], tag)) | |
305 | return '/'.join(replaced) | |
306 | ||
d77c3dfd | 307 | |
a41fb80c | 308 | def xpath_element(node, xpath, name=None, fatal=False, default=NO_DEFAULT): |
578c0745 | 309 | def _find_xpath(xpath): |
f9934b96 | 310 | return node.find(xpath) |
578c0745 | 311 | |
14f25df2 | 312 | if isinstance(xpath, str): |
578c0745 S |
313 | n = _find_xpath(xpath) |
314 | else: | |
315 | for xp in xpath: | |
316 | n = _find_xpath(xp) | |
317 | if n is not None: | |
318 | break | |
d74bebd5 | 319 | |
8e636da4 | 320 | if n is None: |
bf42a990 S |
321 | if default is not NO_DEFAULT: |
322 | return default | |
323 | elif fatal: | |
bf0ff932 PH |
324 | name = xpath if name is None else name |
325 | raise ExtractorError('Could not find XML element %s' % name) | |
326 | else: | |
327 | return None | |
a41fb80c S |
328 | return n |
329 | ||
330 | ||
331 | def xpath_text(node, xpath, name=None, fatal=False, default=NO_DEFAULT): | |
8e636da4 S |
332 | n = xpath_element(node, xpath, name, fatal=fatal, default=default) |
333 | if n is None or n == default: | |
334 | return n | |
335 | if n.text is None: | |
336 | if default is not NO_DEFAULT: | |
337 | return default | |
338 | elif fatal: | |
339 | name = xpath if name is None else name | |
340 | raise ExtractorError('Could not find XML element\'s text %s' % name) | |
341 | else: | |
342 | return None | |
343 | return n.text | |
a41fb80c S |
344 | |
345 | ||
346 | def xpath_attr(node, xpath, key, name=None, fatal=False, default=NO_DEFAULT): | |
347 | n = find_xpath_attr(node, xpath, key) | |
348 | if n is None: | |
349 | if default is not NO_DEFAULT: | |
350 | return default | |
351 | elif fatal: | |
86e5f3ed | 352 | name = f'{xpath}[@{key}]' if name is None else name |
a41fb80c S |
353 | raise ExtractorError('Could not find XML attribute %s' % name) |
354 | else: | |
355 | return None | |
356 | return n.attrib[key] | |
bf0ff932 PH |
357 | |
358 | ||
c487cf00 | 359 | def get_element_by_id(id, html, **kwargs): |
43e8fafd | 360 | """Return the content of the tag with the specified ID in the passed HTML document""" |
c487cf00 | 361 | return get_element_by_attribute('id', id, html, **kwargs) |
43e8fafd | 362 | |
12ea2f30 | 363 | |
c487cf00 | 364 | def get_element_html_by_id(id, html, **kwargs): |
6f32a0b5 | 365 | """Return the html of the tag with the specified ID in the passed HTML document""" |
c487cf00 | 366 | return get_element_html_by_attribute('id', id, html, **kwargs) |
6f32a0b5 ZM |
367 | |
368 | ||
84c237fb | 369 | def get_element_by_class(class_name, html): |
2af12ad9 TC |
370 | """Return the content of the first tag with the specified class in the passed HTML document""" |
371 | retval = get_elements_by_class(class_name, html) | |
372 | return retval[0] if retval else None | |
373 | ||
374 | ||
6f32a0b5 ZM |
375 | def get_element_html_by_class(class_name, html): |
376 | """Return the html of the first tag with the specified class in the passed HTML document""" | |
377 | retval = get_elements_html_by_class(class_name, html) | |
378 | return retval[0] if retval else None | |
379 | ||
380 | ||
c487cf00 | 381 | def get_element_by_attribute(attribute, value, html, **kwargs): |
382 | retval = get_elements_by_attribute(attribute, value, html, **kwargs) | |
2af12ad9 TC |
383 | return retval[0] if retval else None |
384 | ||
385 | ||
c487cf00 | 386 | def get_element_html_by_attribute(attribute, value, html, **kargs): |
387 | retval = get_elements_html_by_attribute(attribute, value, html, **kargs) | |
6f32a0b5 ZM |
388 | return retval[0] if retval else None |
389 | ||
390 | ||
c487cf00 | 391 | def get_elements_by_class(class_name, html, **kargs): |
2af12ad9 TC |
392 | """Return the content of all tags with the specified class in the passed HTML document as a list""" |
393 | return get_elements_by_attribute( | |
64fa820c | 394 | 'class', r'[^\'"]*(?<=[\'"\s])%s(?=[\'"\s])[^\'"]*' % re.escape(class_name), |
84c237fb YCH |
395 | html, escape_value=False) |
396 | ||
397 | ||
6f32a0b5 ZM |
398 | def get_elements_html_by_class(class_name, html): |
399 | """Return the html of all tags with the specified class in the passed HTML document as a list""" | |
400 | return get_elements_html_by_attribute( | |
64fa820c | 401 | 'class', r'[^\'"]*(?<=[\'"\s])%s(?=[\'"\s])[^\'"]*' % re.escape(class_name), |
6f32a0b5 ZM |
402 | html, escape_value=False) |
403 | ||
404 | ||
405 | def get_elements_by_attribute(*args, **kwargs): | |
43e8fafd | 406 | """Return the content of the tag with the specified attribute in the passed HTML document""" |
6f32a0b5 ZM |
407 | return [content for content, _ in get_elements_text_and_html_by_attribute(*args, **kwargs)] |
408 | ||
409 | ||
410 | def get_elements_html_by_attribute(*args, **kwargs): | |
411 | """Return the html of the tag with the specified attribute in the passed HTML document""" | |
412 | return [whole for _, whole in get_elements_text_and_html_by_attribute(*args, **kwargs)] | |
413 | ||
414 | ||
4c9a1a3b | 415 | def get_elements_text_and_html_by_attribute(attribute, value, html, *, tag=r'[\w:.-]+', escape_value=True): |
6f32a0b5 ZM |
416 | """ |
417 | Return the text (content) and the html (whole) of the tag with the specified | |
418 | attribute in the passed HTML document | |
419 | """ | |
c61473c1 M |
420 | if not value: |
421 | return | |
9e6dd238 | 422 | |
86e5f3ed | 423 | quote = '' if re.match(r'''[\s"'`=<>]''', value) else '?' |
0254f162 | 424 | |
84c237fb YCH |
425 | value = re.escape(value) if escape_value else value |
426 | ||
86e5f3ed | 427 | partial_element_re = rf'''(?x) |
4c9a1a3b | 428 | <(?P<tag>{tag}) |
0254f162 | 429 | (?:\s(?:[^>"']|"[^"]*"|'[^']*')*)? |
86e5f3ed | 430 | \s{re.escape(attribute)}\s*=\s*(?P<_q>['"]{quote})(?-x:{value})(?P=_q) |
431 | ''' | |
38285056 | 432 | |
0254f162 ZM |
433 | for m in re.finditer(partial_element_re, html): |
434 | content, whole = get_element_text_and_html_by_tag(m.group('tag'), html[m.start():]) | |
a921f407 | 435 | |
0254f162 ZM |
436 | yield ( |
437 | unescapeHTML(re.sub(r'^(?P<q>["\'])(?P<content>.*)(?P=q)$', r'\g<content>', content, flags=re.DOTALL)), | |
438 | whole | |
439 | ) | |
a921f407 | 440 | |
c5229f39 | 441 | |
ac668111 | 442 | class HTMLBreakOnClosingTagParser(html.parser.HTMLParser): |
6f32a0b5 ZM |
443 | """ |
444 | HTML parser which raises HTMLBreakOnClosingTagException upon reaching the | |
445 | closing tag for the first opening tag it has encountered, and can be used | |
446 | as a context manager | |
447 | """ | |
448 | ||
449 | class HTMLBreakOnClosingTagException(Exception): | |
450 | pass | |
451 | ||
452 | def __init__(self): | |
453 | self.tagstack = collections.deque() | |
ac668111 | 454 | html.parser.HTMLParser.__init__(self) |
6f32a0b5 ZM |
455 | |
456 | def __enter__(self): | |
457 | return self | |
458 | ||
459 | def __exit__(self, *_): | |
460 | self.close() | |
461 | ||
462 | def close(self): | |
463 | # handle_endtag does not return upon raising HTMLBreakOnClosingTagException, | |
464 | # so data remains buffered; we no longer have any interest in it, thus | |
465 | # override this method to discard it | |
466 | pass | |
467 | ||
468 | def handle_starttag(self, tag, _): | |
469 | self.tagstack.append(tag) | |
470 | ||
471 | def handle_endtag(self, tag): | |
472 | if not self.tagstack: | |
473 | raise compat_HTMLParseError('no tags in the stack') | |
474 | while self.tagstack: | |
475 | inner_tag = self.tagstack.pop() | |
476 | if inner_tag == tag: | |
477 | break | |
478 | else: | |
479 | raise compat_HTMLParseError(f'matching opening tag for closing {tag} tag not found') | |
480 | if not self.tagstack: | |
481 | raise self.HTMLBreakOnClosingTagException() | |
482 | ||
483 | ||
46d09f87 | 484 | # XXX: This should be far less strict |
6f32a0b5 ZM |
485 | def get_element_text_and_html_by_tag(tag, html): |
486 | """ | |
487 | For the first element with the specified tag in the passed HTML document | |
488 | return its' content (text) and the whole element (html) | |
489 | """ | |
490 | def find_or_raise(haystack, needle, exc): | |
491 | try: | |
492 | return haystack.index(needle) | |
493 | except ValueError: | |
494 | raise exc | |
495 | closing_tag = f'</{tag}>' | |
496 | whole_start = find_or_raise( | |
497 | html, f'<{tag}', compat_HTMLParseError(f'opening {tag} tag not found')) | |
498 | content_start = find_or_raise( | |
499 | html[whole_start:], '>', compat_HTMLParseError(f'malformed opening {tag} tag')) | |
500 | content_start += whole_start + 1 | |
501 | with HTMLBreakOnClosingTagParser() as parser: | |
502 | parser.feed(html[whole_start:content_start]) | |
503 | if not parser.tagstack or parser.tagstack[0] != tag: | |
504 | raise compat_HTMLParseError(f'parser did not match opening {tag} tag') | |
505 | offset = content_start | |
506 | while offset < len(html): | |
507 | next_closing_tag_start = find_or_raise( | |
508 | html[offset:], closing_tag, | |
509 | compat_HTMLParseError(f'closing {tag} tag not found')) | |
510 | next_closing_tag_end = next_closing_tag_start + len(closing_tag) | |
511 | try: | |
512 | parser.feed(html[offset:offset + next_closing_tag_end]) | |
513 | offset += next_closing_tag_end | |
514 | except HTMLBreakOnClosingTagParser.HTMLBreakOnClosingTagException: | |
515 | return html[content_start:offset + next_closing_tag_start], \ | |
516 | html[whole_start:offset + next_closing_tag_end] | |
517 | raise compat_HTMLParseError('unexpected end of html') | |
518 | ||
519 | ||
ac668111 | 520 | class HTMLAttributeParser(html.parser.HTMLParser): |
8bb56eee | 521 | """Trivial HTML parser to gather the attributes for a single element""" |
b6e0c7d2 | 522 | |
8bb56eee | 523 | def __init__(self): |
c5229f39 | 524 | self.attrs = {} |
ac668111 | 525 | html.parser.HTMLParser.__init__(self) |
8bb56eee BF |
526 | |
527 | def handle_starttag(self, tag, attrs): | |
528 | self.attrs = dict(attrs) | |
7053aa3a | 529 | raise compat_HTMLParseError('done') |
8bb56eee | 530 | |
c5229f39 | 531 | |
ac668111 | 532 | class HTMLListAttrsParser(html.parser.HTMLParser): |
73673ccf FF |
533 | """HTML parser to gather the attributes for the elements of a list""" |
534 | ||
535 | def __init__(self): | |
ac668111 | 536 | html.parser.HTMLParser.__init__(self) |
73673ccf FF |
537 | self.items = [] |
538 | self._level = 0 | |
539 | ||
540 | def handle_starttag(self, tag, attrs): | |
541 | if tag == 'li' and self._level == 0: | |
542 | self.items.append(dict(attrs)) | |
543 | self._level += 1 | |
544 | ||
545 | def handle_endtag(self, tag): | |
546 | self._level -= 1 | |
547 | ||
548 | ||
8bb56eee BF |
549 | def extract_attributes(html_element): |
550 | """Given a string for an HTML element such as | |
551 | <el | |
552 | a="foo" B="bar" c="&98;az" d=boz | |
553 | empty= noval entity="&" | |
554 | sq='"' dq="'" | |
555 | > | |
556 | Decode and return a dictionary of attributes. | |
557 | { | |
558 | 'a': 'foo', 'b': 'bar', c: 'baz', d: 'boz', | |
559 | 'empty': '', 'noval': None, 'entity': '&', | |
560 | 'sq': '"', 'dq': '\'' | |
561 | }. | |
8bb56eee BF |
562 | """ |
563 | parser = HTMLAttributeParser() | |
19a03940 | 564 | with contextlib.suppress(compat_HTMLParseError): |
b4a3d461 S |
565 | parser.feed(html_element) |
566 | parser.close() | |
8bb56eee | 567 | return parser.attrs |
9e6dd238 | 568 | |
c5229f39 | 569 | |
73673ccf FF |
570 | def parse_list(webpage): |
571 | """Given a string for an series of HTML <li> elements, | |
572 | return a dictionary of their attributes""" | |
573 | parser = HTMLListAttrsParser() | |
574 | parser.feed(webpage) | |
575 | parser.close() | |
576 | return parser.items | |
577 | ||
578 | ||
9e6dd238 | 579 | def clean_html(html): |
59ae15a5 | 580 | """Clean an HTML snippet into a readable string""" |
dd622d7c PH |
581 | |
582 | if html is None: # Convenience for sanitizing descriptions etc. | |
583 | return html | |
584 | ||
49185227 | 585 | html = re.sub(r'\s+', ' ', html) |
586 | html = re.sub(r'(?u)\s?<\s?br\s?/?\s?>\s?', '\n', html) | |
587 | html = re.sub(r'(?u)<\s?/\s?p\s?>\s?<\s?p[^>]*>', '\n', html) | |
59ae15a5 PH |
588 | # Strip html tags |
589 | html = re.sub('<.*?>', '', html) | |
590 | # Replace html entities | |
591 | html = unescapeHTML(html) | |
7decf895 | 592 | return html.strip() |
9e6dd238 FV |
593 | |
594 | ||
b7c47b74 | 595 | class LenientJSONDecoder(json.JSONDecoder): |
596 | def __init__(self, *args, transform_source=None, ignore_extra=False, **kwargs): | |
597 | self.transform_source, self.ignore_extra = transform_source, ignore_extra | |
598 | super().__init__(*args, **kwargs) | |
599 | ||
600 | def decode(self, s): | |
601 | if self.transform_source: | |
602 | s = self.transform_source(s) | |
2fa669f7 | 603 | try: |
604 | if self.ignore_extra: | |
605 | return self.raw_decode(s.lstrip())[0] | |
606 | return super().decode(s) | |
607 | except json.JSONDecodeError as e: | |
608 | if e.pos is not None: | |
609 | raise type(e)(f'{e.msg} in {s[e.pos-10:e.pos+10]!r}', s, e.pos) | |
610 | raise | |
b7c47b74 | 611 | |
612 | ||
d77c3dfd | 613 | def sanitize_open(filename, open_mode): |
59ae15a5 PH |
614 | """Try to open the given filename, and slightly tweak it if this fails. |
615 | ||
616 | Attempts to open the given filename. If this fails, it tries to change | |
617 | the filename slightly, step by step, until it's either able to open it | |
618 | or it fails and raises a final exception, like the standard open() | |
619 | function. | |
620 | ||
621 | It returns the tuple (stream, definitive_file_name). | |
622 | """ | |
0edb3e33 | 623 | if filename == '-': |
624 | if sys.platform == 'win32': | |
625 | import msvcrt | |
be5c1ae8 | 626 | |
62b58c09 | 627 | # stdout may be any IO stream, e.g. when using contextlib.redirect_stdout |
daef7911 | 628 | with contextlib.suppress(io.UnsupportedOperation): |
629 | msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY) | |
0edb3e33 | 630 | return (sys.stdout.buffer if hasattr(sys.stdout, 'buffer') else sys.stdout, filename) |
59ae15a5 | 631 | |
0edb3e33 | 632 | for attempt in range(2): |
633 | try: | |
634 | try: | |
89737671 | 635 | if sys.platform == 'win32': |
b506289f | 636 | # FIXME: An exclusive lock also locks the file from being read. |
637 | # Since windows locks are mandatory, don't lock the file on windows (for now). | |
638 | # Ref: https://github.com/yt-dlp/yt-dlp/issues/3124 | |
89737671 | 639 | raise LockingUnsupportedError() |
0edb3e33 | 640 | stream = locked_file(filename, open_mode, block=False).__enter__() |
8a82af35 | 641 | except OSError: |
0edb3e33 | 642 | stream = open(filename, open_mode) |
8a82af35 | 643 | return stream, filename |
86e5f3ed | 644 | except OSError as err: |
0edb3e33 | 645 | if attempt or err.errno in (errno.EACCES,): |
646 | raise | |
647 | old_filename, filename = filename, sanitize_path(filename) | |
648 | if old_filename == filename: | |
649 | raise | |
d77c3dfd FV |
650 | |
651 | ||
652 | def timeconvert(timestr): | |
59ae15a5 PH |
653 | """Convert RFC 2822 defined time string into system timestamp""" |
654 | timestamp = None | |
655 | timetuple = email.utils.parsedate_tz(timestr) | |
656 | if timetuple is not None: | |
657 | timestamp = email.utils.mktime_tz(timetuple) | |
658 | return timestamp | |
1c469a94 | 659 | |
5f6a1245 | 660 | |
5c3895ff | 661 | def sanitize_filename(s, restricted=False, is_id=NO_DEFAULT): |
59ae15a5 | 662 | """Sanitizes a string so it could be used as part of a filename. |
5c3895ff | 663 | @param restricted Use a stricter subset of allowed characters |
664 | @param is_id Whether this is an ID that should be kept unchanged if possible. | |
665 | If unset, yt-dlp's new sanitization rules are in effect | |
59ae15a5 | 666 | """ |
5c3895ff | 667 | if s == '': |
668 | return '' | |
669 | ||
59ae15a5 | 670 | def replace_insane(char): |
c587cbb7 AT |
671 | if restricted and char in ACCENT_CHARS: |
672 | return ACCENT_CHARS[char] | |
91dd88b9 | 673 | elif not restricted and char == '\n': |
5c3895ff | 674 | return '\0 ' |
989a01c2 | 675 | elif is_id is NO_DEFAULT and not restricted and char in '"*:<>?|/\\': |
676 | # Replace with their full-width unicode counterparts | |
677 | return {'/': '\u29F8', '\\': '\u29f9'}.get(char, chr(ord(char) + 0xfee0)) | |
91dd88b9 | 678 | elif char == '?' or ord(char) < 32 or ord(char) == 127: |
59ae15a5 PH |
679 | return '' |
680 | elif char == '"': | |
681 | return '' if restricted else '\'' | |
682 | elif char == ':': | |
5c3895ff | 683 | return '\0_\0-' if restricted else '\0 \0-' |
59ae15a5 | 684 | elif char in '\\/|*<>': |
5c3895ff | 685 | return '\0_' |
686 | if restricted and (char in '!&\'()[]{}$;`^,#' or char.isspace() or ord(char) > 127): | |
687 | return '\0_' | |
59ae15a5 PH |
688 | return char |
689 | ||
db4678e4 | 690 | # Replace look-alike Unicode glyphs |
691 | if restricted and (is_id is NO_DEFAULT or not is_id): | |
989a01c2 | 692 | s = unicodedata.normalize('NFKC', s) |
5c3895ff | 693 | s = re.sub(r'[0-9]+(?::[0-9]+)+', lambda m: m.group(0).replace(':', '_'), s) # Handle timestamps |
28e614de | 694 | result = ''.join(map(replace_insane, s)) |
5c3895ff | 695 | if is_id is NO_DEFAULT: |
ae61d108 | 696 | result = re.sub(r'(\0.)(?:(?=\1)..)+', r'\1', result) # Remove repeated substitute chars |
697 | STRIP_RE = r'(?:\0.|[ _-])*' | |
5c3895ff | 698 | result = re.sub(f'^\0.{STRIP_RE}|{STRIP_RE}\0.$', '', result) # Remove substitute chars from start/end |
699 | result = result.replace('\0', '') or '_' | |
700 | ||
796173d0 PH |
701 | if not is_id: |
702 | while '__' in result: | |
703 | result = result.replace('__', '_') | |
704 | result = result.strip('_') | |
705 | # Common case of "Foreign band name - English song title" | |
706 | if restricted and result.startswith('-_'): | |
707 | result = result[2:] | |
5a42414b PH |
708 | if result.startswith('-'): |
709 | result = '_' + result[len('-'):] | |
a7440261 | 710 | result = result.lstrip('.') |
796173d0 PH |
711 | if not result: |
712 | result = '_' | |
59ae15a5 | 713 | return result |
d77c3dfd | 714 | |
5f6a1245 | 715 | |
c2934512 | 716 | def sanitize_path(s, force=False): |
a2aaf4db | 717 | """Sanitizes and normalizes path on Windows""" |
c2934512 | 718 | if sys.platform == 'win32': |
c4218ac3 | 719 | force = False |
c2934512 | 720 | drive_or_unc, _ = os.path.splitdrive(s) |
c2934512 | 721 | elif force: |
722 | drive_or_unc = '' | |
723 | else: | |
a2aaf4db | 724 | return s |
c2934512 | 725 | |
be531ef1 S |
726 | norm_path = os.path.normpath(remove_start(s, drive_or_unc)).split(os.path.sep) |
727 | if drive_or_unc: | |
a2aaf4db S |
728 | norm_path.pop(0) |
729 | sanitized_path = [ | |
ec85ded8 | 730 | path_part if path_part in ['.', '..'] else re.sub(r'(?:[/<>:"\|\\?\*]|[\s.]$)', '#', path_part) |
a2aaf4db | 731 | for path_part in norm_path] |
be531ef1 S |
732 | if drive_or_unc: |
733 | sanitized_path.insert(0, drive_or_unc + os.path.sep) | |
4abea8ca | 734 | elif force and s and s[0] == os.path.sep: |
c4218ac3 | 735 | sanitized_path.insert(0, os.path.sep) |
a2aaf4db S |
736 | return os.path.join(*sanitized_path) |
737 | ||
738 | ||
8f97a15d | 739 | def sanitize_url(url, *, scheme='http'): |
befa4708 S |
740 | # Prepend protocol-less URLs with `http:` scheme in order to mitigate |
741 | # the number of unwanted failures due to missing protocol | |
21633673 | 742 | if url is None: |
743 | return | |
744 | elif url.startswith('//'): | |
8f97a15d | 745 | return f'{scheme}:{url}' |
befa4708 S |
746 | # Fix some common typos seen so far |
747 | COMMON_TYPOS = ( | |
067aa17e | 748 | # https://github.com/ytdl-org/youtube-dl/issues/15649 |
befa4708 S |
749 | (r'^httpss://', r'https://'), |
750 | # https://bx1.be/lives/direct-tv/ | |
751 | (r'^rmtp([es]?)://', r'rtmp\1://'), | |
752 | ) | |
753 | for mistake, fixup in COMMON_TYPOS: | |
754 | if re.match(mistake, url): | |
755 | return re.sub(mistake, fixup, url) | |
bc6b9bcd | 756 | return url |
17bcc626 S |
757 | |
758 | ||
5435dcf9 | 759 | def extract_basic_auth(url): |
14f25df2 | 760 | parts = urllib.parse.urlsplit(url) |
5435dcf9 HH |
761 | if parts.username is None: |
762 | return url, None | |
14f25df2 | 763 | url = urllib.parse.urlunsplit(parts._replace(netloc=( |
5435dcf9 HH |
764 | parts.hostname if parts.port is None |
765 | else '%s:%d' % (parts.hostname, parts.port)))) | |
766 | auth_payload = base64.b64encode( | |
0f06bcd7 | 767 | ('%s:%s' % (parts.username, parts.password or '')).encode()) |
768 | return url, f'Basic {auth_payload.decode()}' | |
5435dcf9 HH |
769 | |
770 | ||
67dda517 | 771 | def sanitized_Request(url, *args, **kwargs): |
bc6b9bcd | 772 | url, auth_header = extract_basic_auth(escape_url(sanitize_url(url))) |
5435dcf9 HH |
773 | if auth_header is not None: |
774 | headers = args[1] if len(args) >= 2 else kwargs.setdefault('headers', {}) | |
775 | headers['Authorization'] = auth_header | |
ac668111 | 776 | return urllib.request.Request(url, *args, **kwargs) |
67dda517 S |
777 | |
778 | ||
51098426 | 779 | def expand_path(s): |
2fa669f7 | 780 | """Expand shell variables and ~""" |
51098426 S |
781 | return os.path.expandvars(compat_expanduser(s)) |
782 | ||
783 | ||
7e9a6125 | 784 | def orderedSet(iterable, *, lazy=False): |
785 | """Remove all duplicates from the input iterable""" | |
786 | def _iter(): | |
787 | seen = [] # Do not use set since the items can be unhashable | |
788 | for x in iterable: | |
789 | if x not in seen: | |
790 | seen.append(x) | |
791 | yield x | |
792 | ||
793 | return _iter() if lazy else list(_iter()) | |
d77c3dfd | 794 | |
912b38b4 | 795 | |
55b2f099 | 796 | def _htmlentity_transform(entity_with_semicolon): |
4e408e47 | 797 | """Transforms an HTML entity to a character.""" |
55b2f099 YCH |
798 | entity = entity_with_semicolon[:-1] |
799 | ||
4e408e47 | 800 | # Known non-numeric HTML entity |
ac668111 | 801 | if entity in html.entities.name2codepoint: |
802 | return chr(html.entities.name2codepoint[entity]) | |
4e408e47 | 803 | |
62b58c09 L |
804 | # TODO: HTML5 allows entities without a semicolon. |
805 | # E.g. 'Éric' should be decoded as 'Éric'. | |
ac668111 | 806 | if entity_with_semicolon in html.entities.html5: |
807 | return html.entities.html5[entity_with_semicolon] | |
55b2f099 | 808 | |
91757b0f | 809 | mobj = re.match(r'#(x[0-9a-fA-F]+|[0-9]+)', entity) |
4e408e47 PH |
810 | if mobj is not None: |
811 | numstr = mobj.group(1) | |
28e614de | 812 | if numstr.startswith('x'): |
4e408e47 | 813 | base = 16 |
28e614de | 814 | numstr = '0%s' % numstr |
4e408e47 PH |
815 | else: |
816 | base = 10 | |
067aa17e | 817 | # See https://github.com/ytdl-org/youtube-dl/issues/7518 |
19a03940 | 818 | with contextlib.suppress(ValueError): |
ac668111 | 819 | return chr(int(numstr, base)) |
4e408e47 PH |
820 | |
821 | # Unknown entity in name, return its literal representation | |
7a3f0c00 | 822 | return '&%s;' % entity |
4e408e47 PH |
823 | |
824 | ||
d77c3dfd | 825 | def unescapeHTML(s): |
912b38b4 PH |
826 | if s is None: |
827 | return None | |
19a03940 | 828 | assert isinstance(s, str) |
d77c3dfd | 829 | |
4e408e47 | 830 | return re.sub( |
95f3f7c2 | 831 | r'&([^&;]+;)', lambda m: _htmlentity_transform(m.group(1)), s) |
d77c3dfd | 832 | |
8bf48f23 | 833 | |
cdb19aa4 | 834 | def escapeHTML(text): |
835 | return ( | |
836 | text | |
837 | .replace('&', '&') | |
838 | .replace('<', '<') | |
839 | .replace('>', '>') | |
840 | .replace('"', '"') | |
841 | .replace("'", ''') | |
842 | ) | |
843 | ||
844 | ||
f5b1bca9 | 845 | def process_communicate_or_kill(p, *args, **kwargs): |
da4db748 | 846 | deprecation_warning(f'"{__name__}.process_communicate_or_kill" is deprecated and may be removed ' |
847 | f'in a future version. Use "{__name__}.Popen.communicate_or_kill" instead') | |
8a82af35 | 848 | return Popen.communicate_or_kill(p, *args, **kwargs) |
f5b1bca9 | 849 | |
850 | ||
d3c93ec2 | 851 | class Popen(subprocess.Popen): |
852 | if sys.platform == 'win32': | |
853 | _startupinfo = subprocess.STARTUPINFO() | |
854 | _startupinfo.dwFlags |= subprocess.STARTF_USESHOWWINDOW | |
855 | else: | |
856 | _startupinfo = None | |
857 | ||
82ea226c L |
858 | @staticmethod |
859 | def _fix_pyinstaller_ld_path(env): | |
860 | """Restore LD_LIBRARY_PATH when using PyInstaller | |
861 | Ref: https://github.com/pyinstaller/pyinstaller/blob/develop/doc/runtime-information.rst#ld_library_path--libpath-considerations | |
862 | https://github.com/yt-dlp/yt-dlp/issues/4573 | |
863 | """ | |
864 | if not hasattr(sys, '_MEIPASS'): | |
865 | return | |
866 | ||
867 | def _fix(key): | |
868 | orig = env.get(f'{key}_ORIG') | |
869 | if orig is None: | |
870 | env.pop(key, None) | |
871 | else: | |
872 | env[key] = orig | |
873 | ||
874 | _fix('LD_LIBRARY_PATH') # Linux | |
875 | _fix('DYLD_LIBRARY_PATH') # macOS | |
876 | ||
877 | def __init__(self, *args, env=None, text=False, **kwargs): | |
878 | if env is None: | |
879 | env = os.environ.copy() | |
880 | self._fix_pyinstaller_ld_path(env) | |
881 | ||
f0c9fb96 | 882 | if text is True: |
883 | kwargs['universal_newlines'] = True # For 3.6 compatibility | |
884 | kwargs.setdefault('encoding', 'utf-8') | |
885 | kwargs.setdefault('errors', 'replace') | |
82ea226c | 886 | super().__init__(*args, env=env, **kwargs, startupinfo=self._startupinfo) |
d3c93ec2 | 887 | |
888 | def communicate_or_kill(self, *args, **kwargs): | |
8a82af35 | 889 | try: |
890 | return self.communicate(*args, **kwargs) | |
891 | except BaseException: # Including KeyboardInterrupt | |
f0c9fb96 | 892 | self.kill(timeout=None) |
8a82af35 | 893 | raise |
d3c93ec2 | 894 | |
f0c9fb96 | 895 | def kill(self, *, timeout=0): |
896 | super().kill() | |
897 | if timeout != 0: | |
898 | self.wait(timeout=timeout) | |
899 | ||
900 | @classmethod | |
992dc6b4 | 901 | def run(cls, *args, timeout=None, **kwargs): |
f0c9fb96 | 902 | with cls(*args, **kwargs) as proc: |
914491b8 | 903 | default = '' if proc.text_mode else b'' |
992dc6b4 | 904 | stdout, stderr = proc.communicate_or_kill(timeout=timeout) |
914491b8 | 905 | return stdout or default, stderr or default, proc.returncode |
f0c9fb96 | 906 | |
d3c93ec2 | 907 | |
aa49acd1 S |
908 | def get_subprocess_encoding(): |
909 | if sys.platform == 'win32' and sys.getwindowsversion()[0] >= 5: | |
910 | # For subprocess calls, encode with locale encoding | |
911 | # Refer to http://stackoverflow.com/a/9951851/35070 | |
912 | encoding = preferredencoding() | |
913 | else: | |
914 | encoding = sys.getfilesystemencoding() | |
915 | if encoding is None: | |
916 | encoding = 'utf-8' | |
917 | return encoding | |
918 | ||
919 | ||
8bf48f23 | 920 | def encodeFilename(s, for_subprocess=False): |
19a03940 | 921 | assert isinstance(s, str) |
cfb0511d | 922 | return s |
aa49acd1 S |
923 | |
924 | ||
925 | def decodeFilename(b, for_subprocess=False): | |
cfb0511d | 926 | return b |
8bf48f23 | 927 | |
f07b74fc PH |
928 | |
929 | def encodeArgument(s): | |
cfb0511d | 930 | # Legacy code that uses byte strings |
931 | # Uncomment the following line after fixing all post processors | |
14f25df2 | 932 | # assert isinstance(s, str), 'Internal error: %r should be of type %r, is %r' % (s, str, type(s)) |
cfb0511d | 933 | return s if isinstance(s, str) else s.decode('ascii') |
f07b74fc PH |
934 | |
935 | ||
aa49acd1 | 936 | def decodeArgument(b): |
cfb0511d | 937 | return b |
aa49acd1 S |
938 | |
939 | ||
8271226a PH |
940 | def decodeOption(optval): |
941 | if optval is None: | |
942 | return optval | |
943 | if isinstance(optval, bytes): | |
944 | optval = optval.decode(preferredencoding()) | |
945 | ||
14f25df2 | 946 | assert isinstance(optval, str) |
8271226a | 947 | return optval |
1c256f70 | 948 | |
5f6a1245 | 949 | |
aa7785f8 | 950 | _timetuple = collections.namedtuple('Time', ('hours', 'minutes', 'seconds', 'milliseconds')) |
951 | ||
952 | ||
953 | def timetuple_from_msec(msec): | |
954 | secs, msec = divmod(msec, 1000) | |
955 | mins, secs = divmod(secs, 60) | |
956 | hrs, mins = divmod(mins, 60) | |
957 | return _timetuple(hrs, mins, secs, msec) | |
958 | ||
959 | ||
cdb19aa4 | 960 | def formatSeconds(secs, delim=':', msec=False): |
aa7785f8 | 961 | time = timetuple_from_msec(secs * 1000) |
962 | if time.hours: | |
963 | ret = '%d%s%02d%s%02d' % (time.hours, delim, time.minutes, delim, time.seconds) | |
964 | elif time.minutes: | |
965 | ret = '%d%s%02d' % (time.minutes, delim, time.seconds) | |
4539dd30 | 966 | else: |
aa7785f8 | 967 | ret = '%d' % time.seconds |
968 | return '%s.%03d' % (ret, time.milliseconds) if msec else ret | |
4539dd30 | 969 | |
a0ddb8a2 | 970 | |
77562778 | 971 | def _ssl_load_windows_store_certs(ssl_context, storename): |
972 | # Code adapted from _load_windows_store_certs in https://github.com/python/cpython/blob/main/Lib/ssl.py | |
973 | try: | |
974 | certs = [cert for cert, encoding, trust in ssl.enum_certificates(storename) | |
975 | if encoding == 'x509_asn' and ( | |
976 | trust is True or ssl.Purpose.SERVER_AUTH.oid in trust)] | |
977 | except PermissionError: | |
978 | return | |
979 | for cert in certs: | |
19a03940 | 980 | with contextlib.suppress(ssl.SSLError): |
77562778 | 981 | ssl_context.load_verify_locations(cadata=cert) |
a2366922 | 982 | |
77562778 | 983 | |
984 | def make_HTTPS_handler(params, **kwargs): | |
985 | opts_check_certificate = not params.get('nocheckcertificate') | |
986 | context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT) | |
987 | context.check_hostname = opts_check_certificate | |
f81c62a6 | 988 | if params.get('legacyserverconnect'): |
989 | context.options |= 4 # SSL_OP_LEGACY_SERVER_CONNECT | |
4f28b537 | 990 | # Allow use of weaker ciphers in Python 3.10+. See https://bugs.python.org/issue43998 |
991 | context.set_ciphers('DEFAULT') | |
ac8e69dd M |
992 | elif ( |
993 | sys.version_info < (3, 10) | |
994 | and ssl.OPENSSL_VERSION_INFO >= (1, 1, 1) | |
995 | and not ssl.OPENSSL_VERSION.startswith('LibreSSL') | |
996 | ): | |
5b9f253f M |
997 | # Backport the default SSL ciphers and minimum TLS version settings from Python 3.10 [1]. |
998 | # This is to ensure consistent behavior across Python versions, and help avoid fingerprinting | |
999 | # in some situations [2][3]. | |
1000 | # Python 3.10 only supports OpenSSL 1.1.1+ [4]. Because this change is likely | |
1001 | # untested on older versions, we only apply this to OpenSSL 1.1.1+ to be safe. | |
ac8e69dd | 1002 | # LibreSSL is excluded until further investigation due to cipher support issues [5][6]. |
5b9f253f M |
1003 | # 1. https://github.com/python/cpython/commit/e983252b516edb15d4338b0a47631b59ef1e2536 |
1004 | # 2. https://github.com/yt-dlp/yt-dlp/issues/4627 | |
1005 | # 3. https://github.com/yt-dlp/yt-dlp/pull/5294 | |
1006 | # 4. https://peps.python.org/pep-0644/ | |
ac8e69dd M |
1007 | # 5. https://peps.python.org/pep-0644/#libressl-support |
1008 | # 6. https://github.com/yt-dlp/yt-dlp/commit/5b9f253fa0aee996cf1ed30185d4b502e00609c4#commitcomment-89054368 | |
5b9f253f M |
1009 | context.set_ciphers('@SECLEVEL=2:ECDH+AESGCM:ECDH+CHACHA20:ECDH+AES:DHE+AES:!aNULL:!eNULL:!aDSS:!SHA1:!AESCCM') |
1010 | context.minimum_version = ssl.TLSVersion.TLSv1_2 | |
8a82af35 | 1011 | |
77562778 | 1012 | context.verify_mode = ssl.CERT_REQUIRED if opts_check_certificate else ssl.CERT_NONE |
1013 | if opts_check_certificate: | |
d5820461 | 1014 | if has_certifi and 'no-certifi' not in params.get('compat_opts', []): |
1015 | context.load_verify_locations(cafile=certifi.where()) | |
168bbc4f | 1016 | else: |
1017 | try: | |
1018 | context.load_default_certs() | |
1019 | # Work around the issue in load_default_certs when there are bad certificates. See: | |
1020 | # https://github.com/yt-dlp/yt-dlp/issues/1060, | |
1021 | # https://bugs.python.org/issue35665, https://bugs.python.org/issue45312 | |
1022 | except ssl.SSLError: | |
1023 | # enum_certificates is not present in mingw python. See https://github.com/yt-dlp/yt-dlp/issues/1151 | |
1024 | if sys.platform == 'win32' and hasattr(ssl, 'enum_certificates'): | |
1025 | for storename in ('CA', 'ROOT'): | |
1026 | _ssl_load_windows_store_certs(context, storename) | |
1027 | context.set_default_verify_paths() | |
8a82af35 | 1028 | |
bb58c9ed | 1029 | client_certfile = params.get('client_certificate') |
1030 | if client_certfile: | |
1031 | try: | |
1032 | context.load_cert_chain( | |
1033 | client_certfile, keyfile=params.get('client_certificate_key'), | |
1034 | password=params.get('client_certificate_password')) | |
1035 | except ssl.SSLError: | |
1036 | raise YoutubeDLError('Unable to load client certificate') | |
2c6dcb65 | 1037 | |
1038 | # Some servers may reject requests if ALPN extension is not sent. See: | |
1039 | # https://github.com/python/cpython/issues/85140 | |
1040 | # https://github.com/yt-dlp/yt-dlp/issues/3878 | |
1041 | with contextlib.suppress(NotImplementedError): | |
1042 | context.set_alpn_protocols(['http/1.1']) | |
1043 | ||
77562778 | 1044 | return YoutubeDLHTTPSHandler(params, context=context, **kwargs) |
ea6d901e | 1045 | |
732ea2f0 | 1046 | |
5873d4cc | 1047 | def bug_reports_message(before=';'): |
57e0f077 | 1048 | from .update import REPOSITORY |
1049 | ||
1050 | msg = (f'please report this issue on https://github.com/{REPOSITORY}/issues?q= , ' | |
1051 | 'filling out the appropriate issue template. Confirm you are on the latest version using yt-dlp -U') | |
5873d4cc F |
1052 | |
1053 | before = before.rstrip() | |
1054 | if not before or before.endswith(('.', '!', '?')): | |
1055 | msg = msg[0].title() + msg[1:] | |
1056 | ||
1057 | return (before + ' ' if before else '') + msg | |
08f2a92c JMF |
1058 | |
1059 | ||
bf5b9d85 PM |
1060 | class YoutubeDLError(Exception): |
1061 | """Base exception for YoutubeDL errors.""" | |
aa9369a2 | 1062 | msg = None |
1063 | ||
1064 | def __init__(self, msg=None): | |
1065 | if msg is not None: | |
1066 | self.msg = msg | |
1067 | elif self.msg is None: | |
1068 | self.msg = type(self).__name__ | |
1069 | super().__init__(self.msg) | |
bf5b9d85 PM |
1070 | |
1071 | ||
ac668111 | 1072 | network_exceptions = [urllib.error.URLError, http.client.HTTPException, socket.error] |
3158150c | 1073 | if hasattr(ssl, 'CertificateError'): |
1074 | network_exceptions.append(ssl.CertificateError) | |
1075 | network_exceptions = tuple(network_exceptions) | |
1076 | ||
1077 | ||
bf5b9d85 | 1078 | class ExtractorError(YoutubeDLError): |
1c256f70 | 1079 | """Error during info extraction.""" |
5f6a1245 | 1080 | |
1151c407 | 1081 | def __init__(self, msg, tb=None, expected=False, cause=None, video_id=None, ie=None): |
9a82b238 | 1082 | """ tb, if given, is the original traceback (so that it can be printed out). |
7a5c1cfe | 1083 | If expected is set, this is a normal error message and most likely not a bug in yt-dlp. |
9a82b238 | 1084 | """ |
3158150c | 1085 | if sys.exc_info()[0] in network_exceptions: |
9a82b238 | 1086 | expected = True |
d5979c5d | 1087 | |
7265a219 | 1088 | self.orig_msg = str(msg) |
1c256f70 | 1089 | self.traceback = tb |
1151c407 | 1090 | self.expected = expected |
2eabb802 | 1091 | self.cause = cause |
d11271dd | 1092 | self.video_id = video_id |
1151c407 | 1093 | self.ie = ie |
1094 | self.exc_info = sys.exc_info() # preserve original exception | |
5df14442 | 1095 | if isinstance(self.exc_info[1], ExtractorError): |
1096 | self.exc_info = self.exc_info[1].exc_info | |
9bcfe33b | 1097 | super().__init__(self.__msg) |
1151c407 | 1098 | |
9bcfe33b | 1099 | @property |
1100 | def __msg(self): | |
1101 | return ''.join(( | |
1102 | format_field(self.ie, None, '[%s] '), | |
1103 | format_field(self.video_id, None, '%s: '), | |
1104 | self.orig_msg, | |
1105 | format_field(self.cause, None, ' (caused by %r)'), | |
1106 | '' if self.expected else bug_reports_message())) | |
1c256f70 | 1107 | |
01951dda | 1108 | def format_traceback(self): |
497d2fab | 1109 | return join_nonempty( |
1110 | self.traceback and ''.join(traceback.format_tb(self.traceback)), | |
e491d06d | 1111 | self.cause and ''.join(traceback.format_exception(None, self.cause, self.cause.__traceback__)[1:]), |
497d2fab | 1112 | delim='\n') or None |
01951dda | 1113 | |
9bcfe33b | 1114 | def __setattr__(self, name, value): |
1115 | super().__setattr__(name, value) | |
1116 | if getattr(self, 'msg', None) and name not in ('msg', 'args'): | |
1117 | self.msg = self.__msg or type(self).__name__ | |
1118 | self.args = (self.msg, ) # Cannot be property | |
1119 | ||
1c256f70 | 1120 | |
416c7fcb PH |
1121 | class UnsupportedError(ExtractorError): |
1122 | def __init__(self, url): | |
86e5f3ed | 1123 | super().__init__( |
416c7fcb PH |
1124 | 'Unsupported URL: %s' % url, expected=True) |
1125 | self.url = url | |
1126 | ||
1127 | ||
55b3e45b JMF |
1128 | class RegexNotFoundError(ExtractorError): |
1129 | """Error when a regex didn't match""" | |
1130 | pass | |
1131 | ||
1132 | ||
773f291d S |
1133 | class GeoRestrictedError(ExtractorError): |
1134 | """Geographic restriction Error exception. | |
1135 | ||
1136 | This exception may be thrown when a video is not available from your | |
1137 | geographic location due to geographic restrictions imposed by a website. | |
1138 | """ | |
b6e0c7d2 | 1139 | |
0db3bae8 | 1140 | def __init__(self, msg, countries=None, **kwargs): |
1141 | kwargs['expected'] = True | |
86e5f3ed | 1142 | super().__init__(msg, **kwargs) |
773f291d S |
1143 | self.countries = countries |
1144 | ||
1145 | ||
693f0600 | 1146 | class UserNotLive(ExtractorError): |
1147 | """Error when a channel/user is not live""" | |
1148 | ||
1149 | def __init__(self, msg=None, **kwargs): | |
1150 | kwargs['expected'] = True | |
1151 | super().__init__(msg or 'The channel is not currently live', **kwargs) | |
1152 | ||
1153 | ||
bf5b9d85 | 1154 | class DownloadError(YoutubeDLError): |
59ae15a5 | 1155 | """Download Error exception. |
d77c3dfd | 1156 | |
59ae15a5 PH |
1157 | This exception may be thrown by FileDownloader objects if they are not |
1158 | configured to continue on errors. They will contain the appropriate | |
1159 | error message. | |
1160 | """ | |
5f6a1245 | 1161 | |
8cc83b8d FV |
1162 | def __init__(self, msg, exc_info=None): |
1163 | """ exc_info, if given, is the original exception that caused the trouble (as returned by sys.exc_info()). """ | |
86e5f3ed | 1164 | super().__init__(msg) |
8cc83b8d | 1165 | self.exc_info = exc_info |
d77c3dfd FV |
1166 | |
1167 | ||
498f5606 | 1168 | class EntryNotInPlaylist(YoutubeDLError): |
1169 | """Entry not in playlist exception. | |
1170 | ||
1171 | This exception will be thrown by YoutubeDL when a requested entry | |
1172 | is not found in the playlist info_dict | |
1173 | """ | |
aa9369a2 | 1174 | msg = 'Entry not found in info' |
498f5606 | 1175 | |
1176 | ||
bf5b9d85 | 1177 | class SameFileError(YoutubeDLError): |
59ae15a5 | 1178 | """Same File exception. |
d77c3dfd | 1179 | |
59ae15a5 PH |
1180 | This exception will be thrown by FileDownloader objects if they detect |
1181 | multiple files would have to be downloaded to the same file on disk. | |
1182 | """ | |
aa9369a2 | 1183 | msg = 'Fixed output name but more than one file to download' |
1184 | ||
1185 | def __init__(self, filename=None): | |
1186 | if filename is not None: | |
1187 | self.msg += f': {filename}' | |
1188 | super().__init__(self.msg) | |
d77c3dfd FV |
1189 | |
1190 | ||
bf5b9d85 | 1191 | class PostProcessingError(YoutubeDLError): |
59ae15a5 | 1192 | """Post Processing exception. |
d77c3dfd | 1193 | |
59ae15a5 PH |
1194 | This exception may be raised by PostProcessor's .run() method to |
1195 | indicate an error in the postprocessing task. | |
1196 | """ | |
5f6a1245 | 1197 | |
5f6a1245 | 1198 | |
48f79687 | 1199 | class DownloadCancelled(YoutubeDLError): |
1200 | """ Exception raised when the download queue should be interrupted """ | |
1201 | msg = 'The download was cancelled' | |
8b0d7497 | 1202 | |
8b0d7497 | 1203 | |
48f79687 | 1204 | class ExistingVideoReached(DownloadCancelled): |
1205 | """ --break-on-existing triggered """ | |
1206 | msg = 'Encountered a video that is already in the archive, stopping due to --break-on-existing' | |
8b0d7497 | 1207 | |
48f79687 | 1208 | |
1209 | class RejectedVideoReached(DownloadCancelled): | |
1210 | """ --break-on-reject triggered """ | |
1211 | msg = 'Encountered a video that did not match filter, stopping due to --break-on-reject' | |
51d9739f | 1212 | |
1213 | ||
48f79687 | 1214 | class MaxDownloadsReached(DownloadCancelled): |
59ae15a5 | 1215 | """ --max-downloads limit has been reached. """ |
48f79687 | 1216 | msg = 'Maximum number of downloads reached, stopping due to --max-downloads' |
1217 | ||
1218 | ||
f2ebc5c7 | 1219 | class ReExtractInfo(YoutubeDLError): |
1220 | """ Video info needs to be re-extracted. """ | |
1221 | ||
1222 | def __init__(self, msg, expected=False): | |
1223 | super().__init__(msg) | |
1224 | self.expected = expected | |
1225 | ||
1226 | ||
1227 | class ThrottledDownload(ReExtractInfo): | |
48f79687 | 1228 | """ Download speed below --throttled-rate. """ |
aa9369a2 | 1229 | msg = 'The download speed is below throttle limit' |
d77c3dfd | 1230 | |
43b22906 | 1231 | def __init__(self): |
1232 | super().__init__(self.msg, expected=False) | |
f2ebc5c7 | 1233 | |
d77c3dfd | 1234 | |
bf5b9d85 | 1235 | class UnavailableVideoError(YoutubeDLError): |
59ae15a5 | 1236 | """Unavailable Format exception. |
d77c3dfd | 1237 | |
59ae15a5 PH |
1238 | This exception will be thrown when a video is requested |
1239 | in a format that is not available for that video. | |
1240 | """ | |
aa9369a2 | 1241 | msg = 'Unable to download video' |
1242 | ||
1243 | def __init__(self, err=None): | |
1244 | if err is not None: | |
1245 | self.msg += f': {err}' | |
1246 | super().__init__(self.msg) | |
d77c3dfd FV |
1247 | |
1248 | ||
bf5b9d85 | 1249 | class ContentTooShortError(YoutubeDLError): |
59ae15a5 | 1250 | """Content Too Short exception. |
d77c3dfd | 1251 | |
59ae15a5 PH |
1252 | This exception may be raised by FileDownloader objects when a file they |
1253 | download is too small for what the server announced first, indicating | |
1254 | the connection was probably interrupted. | |
1255 | """ | |
d77c3dfd | 1256 | |
59ae15a5 | 1257 | def __init__(self, downloaded, expected): |
86e5f3ed | 1258 | super().__init__(f'Downloaded {downloaded} bytes, expected {expected} bytes') |
2c7ed247 | 1259 | # Both in bytes |
59ae15a5 PH |
1260 | self.downloaded = downloaded |
1261 | self.expected = expected | |
d77c3dfd | 1262 | |
5f6a1245 | 1263 | |
bf5b9d85 | 1264 | class XAttrMetadataError(YoutubeDLError): |
efa97bdc | 1265 | def __init__(self, code=None, msg='Unknown error'): |
86e5f3ed | 1266 | super().__init__(msg) |
efa97bdc | 1267 | self.code = code |
bd264412 | 1268 | self.msg = msg |
efa97bdc YCH |
1269 | |
1270 | # Parsing code and msg | |
3089bc74 | 1271 | if (self.code in (errno.ENOSPC, errno.EDQUOT) |
a0566bbf | 1272 | or 'No space left' in self.msg or 'Disk quota exceeded' in self.msg): |
efa97bdc YCH |
1273 | self.reason = 'NO_SPACE' |
1274 | elif self.code == errno.E2BIG or 'Argument list too long' in self.msg: | |
1275 | self.reason = 'VALUE_TOO_LONG' | |
1276 | else: | |
1277 | self.reason = 'NOT_SUPPORTED' | |
1278 | ||
1279 | ||
bf5b9d85 | 1280 | class XAttrUnavailableError(YoutubeDLError): |
efa97bdc YCH |
1281 | pass |
1282 | ||
1283 | ||
c5a59d93 | 1284 | def _create_http_connection(ydl_handler, http_class, is_https, *args, **kwargs): |
f9934b96 | 1285 | hc = http_class(*args, **kwargs) |
be4a824d | 1286 | source_address = ydl_handler._params.get('source_address') |
8959018a | 1287 | |
be4a824d | 1288 | if source_address is not None: |
8959018a AU |
1289 | # This is to workaround _create_connection() from socket where it will try all |
1290 | # address data from getaddrinfo() including IPv6. This filters the result from | |
1291 | # getaddrinfo() based on the source_address value. | |
1292 | # This is based on the cpython socket.create_connection() function. | |
1293 | # https://github.com/python/cpython/blob/master/Lib/socket.py#L691 | |
1294 | def _create_connection(address, timeout=socket._GLOBAL_DEFAULT_TIMEOUT, source_address=None): | |
1295 | host, port = address | |
1296 | err = None | |
1297 | addrs = socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM) | |
9e21e6d9 S |
1298 | af = socket.AF_INET if '.' in source_address[0] else socket.AF_INET6 |
1299 | ip_addrs = [addr for addr in addrs if addr[0] == af] | |
1300 | if addrs and not ip_addrs: | |
1301 | ip_version = 'v4' if af == socket.AF_INET else 'v6' | |
86e5f3ed | 1302 | raise OSError( |
9e21e6d9 S |
1303 | "No remote IP%s addresses available for connect, can't use '%s' as source address" |
1304 | % (ip_version, source_address[0])) | |
8959018a AU |
1305 | for res in ip_addrs: |
1306 | af, socktype, proto, canonname, sa = res | |
1307 | sock = None | |
1308 | try: | |
1309 | sock = socket.socket(af, socktype, proto) | |
1310 | if timeout is not socket._GLOBAL_DEFAULT_TIMEOUT: | |
1311 | sock.settimeout(timeout) | |
1312 | sock.bind(source_address) | |
1313 | sock.connect(sa) | |
1314 | err = None # Explicitly break reference cycle | |
1315 | return sock | |
86e5f3ed | 1316 | except OSError as _: |
8959018a AU |
1317 | err = _ |
1318 | if sock is not None: | |
1319 | sock.close() | |
1320 | if err is not None: | |
1321 | raise err | |
1322 | else: | |
86e5f3ed | 1323 | raise OSError('getaddrinfo returns an empty list') |
9e21e6d9 S |
1324 | if hasattr(hc, '_create_connection'): |
1325 | hc._create_connection = _create_connection | |
cfb0511d | 1326 | hc.source_address = (source_address, 0) |
be4a824d PH |
1327 | |
1328 | return hc | |
1329 | ||
1330 | ||
87f0e62d | 1331 | def handle_youtubedl_headers(headers): |
992fc9d6 YCH |
1332 | filtered_headers = headers |
1333 | ||
1334 | if 'Youtubedl-no-compression' in filtered_headers: | |
86e5f3ed | 1335 | filtered_headers = {k: v for k, v in filtered_headers.items() if k.lower() != 'accept-encoding'} |
87f0e62d | 1336 | del filtered_headers['Youtubedl-no-compression'] |
87f0e62d | 1337 | |
992fc9d6 | 1338 | return filtered_headers |
87f0e62d YCH |
1339 | |
1340 | ||
ac668111 | 1341 | class YoutubeDLHandler(urllib.request.HTTPHandler): |
59ae15a5 PH |
1342 | """Handler for HTTP requests and responses. |
1343 | ||
1344 | This class, when installed with an OpenerDirector, automatically adds | |
1345 | the standard headers to every HTTP request and handles gzipped and | |
1346 | deflated responses from web servers. If compression is to be avoided in | |
1347 | a particular request, the original request in the program code only has | |
0424ec30 | 1348 | to include the HTTP header "Youtubedl-no-compression", which will be |
59ae15a5 PH |
1349 | removed before making the real request. |
1350 | ||
1351 | Part of this code was copied from: | |
1352 | ||
1353 | http://techknack.net/python-urllib2-handlers/ | |
1354 | ||
1355 | Andrew Rowls, the author of that code, agreed to release it to the | |
1356 | public domain. | |
1357 | """ | |
1358 | ||
be4a824d | 1359 | def __init__(self, params, *args, **kwargs): |
ac668111 | 1360 | urllib.request.HTTPHandler.__init__(self, *args, **kwargs) |
be4a824d PH |
1361 | self._params = params |
1362 | ||
1363 | def http_open(self, req): | |
ac668111 | 1364 | conn_class = http.client.HTTPConnection |
71aff188 YCH |
1365 | |
1366 | socks_proxy = req.headers.get('Ytdl-socks-proxy') | |
1367 | if socks_proxy: | |
1368 | conn_class = make_socks_conn_class(conn_class, socks_proxy) | |
1369 | del req.headers['Ytdl-socks-proxy'] | |
1370 | ||
be4a824d | 1371 | return self.do_open(functools.partial( |
71aff188 | 1372 | _create_http_connection, self, conn_class, False), |
be4a824d PH |
1373 | req) |
1374 | ||
59ae15a5 PH |
1375 | @staticmethod |
1376 | def deflate(data): | |
fc2119f2 | 1377 | if not data: |
1378 | return data | |
59ae15a5 PH |
1379 | try: |
1380 | return zlib.decompress(data, -zlib.MAX_WBITS) | |
1381 | except zlib.error: | |
1382 | return zlib.decompress(data) | |
1383 | ||
4390d5ec | 1384 | @staticmethod |
1385 | def brotli(data): | |
1386 | if not data: | |
1387 | return data | |
9b8ee23b | 1388 | return brotli.decompress(data) |
4390d5ec | 1389 | |
acebc9cd | 1390 | def http_request(self, req): |
51f267d9 S |
1391 | # According to RFC 3986, URLs can not contain non-ASCII characters, however this is not |
1392 | # always respected by websites, some tend to give out URLs with non percent-encoded | |
1393 | # non-ASCII characters (see telemb.py, ard.py [#3412]) | |
1394 | # urllib chokes on URLs with non-ASCII characters (see http://bugs.python.org/issue3991) | |
1395 | # To work around aforementioned issue we will replace request's original URL with | |
1396 | # percent-encoded one | |
1397 | # Since redirects are also affected (e.g. http://www.southpark.de/alle-episoden/s18e09) | |
1398 | # the code of this workaround has been moved here from YoutubeDL.urlopen() | |
1399 | url = req.get_full_url() | |
1400 | url_escaped = escape_url(url) | |
1401 | ||
1402 | # Substitute URL if any change after escaping | |
1403 | if url != url_escaped: | |
15d260eb | 1404 | req = update_Request(req, url=url_escaped) |
51f267d9 | 1405 | |
8b7539d2 | 1406 | for h, v in self._params.get('http_headers', std_headers).items(): |
3d5f7a39 JK |
1407 | # Capitalize is needed because of Python bug 2275: http://bugs.python.org/issue2275 |
1408 | # The dict keys are capitalized because of this bug by urllib | |
1409 | if h.capitalize() not in req.headers: | |
33ac271b | 1410 | req.add_header(h, v) |
87f0e62d | 1411 | |
af14914b | 1412 | if 'Accept-encoding' not in req.headers: |
1413 | req.add_header('Accept-encoding', ', '.join(SUPPORTED_ENCODINGS)) | |
1414 | ||
87f0e62d | 1415 | req.headers = handle_youtubedl_headers(req.headers) |
989b4b2b | 1416 | |
379a4f16 | 1417 | return super().do_request_(req) |
59ae15a5 | 1418 | |
acebc9cd | 1419 | def http_response(self, req, resp): |
59ae15a5 PH |
1420 | old_resp = resp |
1421 | # gzip | |
1422 | if resp.headers.get('Content-encoding', '') == 'gzip': | |
aa3e9507 PH |
1423 | content = resp.read() |
1424 | gz = gzip.GzipFile(fileobj=io.BytesIO(content), mode='rb') | |
1425 | try: | |
1426 | uncompressed = io.BytesIO(gz.read()) | |
86e5f3ed | 1427 | except OSError as original_ioerror: |
aa3e9507 PH |
1428 | # There may be junk add the end of the file |
1429 | # See http://stackoverflow.com/q/4928560/35070 for details | |
1430 | for i in range(1, 1024): | |
1431 | try: | |
1432 | gz = gzip.GzipFile(fileobj=io.BytesIO(content[:-i]), mode='rb') | |
1433 | uncompressed = io.BytesIO(gz.read()) | |
86e5f3ed | 1434 | except OSError: |
aa3e9507 PH |
1435 | continue |
1436 | break | |
1437 | else: | |
1438 | raise original_ioerror | |
ac668111 | 1439 | resp = urllib.request.addinfourl(uncompressed, old_resp.headers, old_resp.url, old_resp.code) |
59ae15a5 | 1440 | resp.msg = old_resp.msg |
c047270c | 1441 | del resp.headers['Content-encoding'] |
59ae15a5 PH |
1442 | # deflate |
1443 | if resp.headers.get('Content-encoding', '') == 'deflate': | |
1444 | gz = io.BytesIO(self.deflate(resp.read())) | |
ac668111 | 1445 | resp = urllib.request.addinfourl(gz, old_resp.headers, old_resp.url, old_resp.code) |
59ae15a5 | 1446 | resp.msg = old_resp.msg |
c047270c | 1447 | del resp.headers['Content-encoding'] |
4390d5ec | 1448 | # brotli |
1449 | if resp.headers.get('Content-encoding', '') == 'br': | |
ac668111 | 1450 | resp = urllib.request.addinfourl( |
4390d5ec | 1451 | io.BytesIO(self.brotli(resp.read())), old_resp.headers, old_resp.url, old_resp.code) |
1452 | resp.msg = old_resp.msg | |
1453 | del resp.headers['Content-encoding'] | |
ad729172 | 1454 | # Percent-encode redirect URL of Location HTTP header to satisfy RFC 3986 (see |
067aa17e | 1455 | # https://github.com/ytdl-org/youtube-dl/issues/6457). |
5a4d9ddb S |
1456 | if 300 <= resp.code < 400: |
1457 | location = resp.headers.get('Location') | |
1458 | if location: | |
1459 | # As of RFC 2616 default charset is iso-8859-1 that is respected by python 3 | |
0f06bcd7 | 1460 | location = location.encode('iso-8859-1').decode() |
5a4d9ddb S |
1461 | location_escaped = escape_url(location) |
1462 | if location != location_escaped: | |
1463 | del resp.headers['Location'] | |
1464 | resp.headers['Location'] = location_escaped | |
59ae15a5 | 1465 | return resp |
0f8d03f8 | 1466 | |
acebc9cd PH |
1467 | https_request = http_request |
1468 | https_response = http_response | |
bf50b038 | 1469 | |
5de90176 | 1470 | |
71aff188 YCH |
1471 | def make_socks_conn_class(base_class, socks_proxy): |
1472 | assert issubclass(base_class, ( | |
ac668111 | 1473 | http.client.HTTPConnection, http.client.HTTPSConnection)) |
71aff188 | 1474 | |
14f25df2 | 1475 | url_components = urllib.parse.urlparse(socks_proxy) |
71aff188 YCH |
1476 | if url_components.scheme.lower() == 'socks5': |
1477 | socks_type = ProxyType.SOCKS5 | |
1478 | elif url_components.scheme.lower() in ('socks', 'socks4'): | |
1479 | socks_type = ProxyType.SOCKS4 | |
51fb4995 YCH |
1480 | elif url_components.scheme.lower() == 'socks4a': |
1481 | socks_type = ProxyType.SOCKS4A | |
71aff188 | 1482 | |
cdd94c2e YCH |
1483 | def unquote_if_non_empty(s): |
1484 | if not s: | |
1485 | return s | |
ac668111 | 1486 | return urllib.parse.unquote_plus(s) |
cdd94c2e | 1487 | |
71aff188 YCH |
1488 | proxy_args = ( |
1489 | socks_type, | |
1490 | url_components.hostname, url_components.port or 1080, | |
1491 | True, # Remote DNS | |
cdd94c2e YCH |
1492 | unquote_if_non_empty(url_components.username), |
1493 | unquote_if_non_empty(url_components.password), | |
71aff188 YCH |
1494 | ) |
1495 | ||
1496 | class SocksConnection(base_class): | |
1497 | def connect(self): | |
1498 | self.sock = sockssocket() | |
1499 | self.sock.setproxy(*proxy_args) | |
19a03940 | 1500 | if isinstance(self.timeout, (int, float)): |
71aff188 YCH |
1501 | self.sock.settimeout(self.timeout) |
1502 | self.sock.connect((self.host, self.port)) | |
1503 | ||
ac668111 | 1504 | if isinstance(self, http.client.HTTPSConnection): |
71aff188 YCH |
1505 | if hasattr(self, '_context'): # Python > 2.6 |
1506 | self.sock = self._context.wrap_socket( | |
1507 | self.sock, server_hostname=self.host) | |
1508 | else: | |
1509 | self.sock = ssl.wrap_socket(self.sock) | |
1510 | ||
1511 | return SocksConnection | |
1512 | ||
1513 | ||
ac668111 | 1514 | class YoutubeDLHTTPSHandler(urllib.request.HTTPSHandler): |
be4a824d | 1515 | def __init__(self, params, https_conn_class=None, *args, **kwargs): |
ac668111 | 1516 | urllib.request.HTTPSHandler.__init__(self, *args, **kwargs) |
1517 | self._https_conn_class = https_conn_class or http.client.HTTPSConnection | |
be4a824d PH |
1518 | self._params = params |
1519 | ||
1520 | def https_open(self, req): | |
4f264c02 | 1521 | kwargs = {} |
71aff188 YCH |
1522 | conn_class = self._https_conn_class |
1523 | ||
4f264c02 JMF |
1524 | if hasattr(self, '_context'): # python > 2.6 |
1525 | kwargs['context'] = self._context | |
1526 | if hasattr(self, '_check_hostname'): # python 3.x | |
1527 | kwargs['check_hostname'] = self._check_hostname | |
71aff188 YCH |
1528 | |
1529 | socks_proxy = req.headers.get('Ytdl-socks-proxy') | |
1530 | if socks_proxy: | |
1531 | conn_class = make_socks_conn_class(conn_class, socks_proxy) | |
1532 | del req.headers['Ytdl-socks-proxy'] | |
1533 | ||
4f28b537 | 1534 | try: |
1535 | return self.do_open( | |
1536 | functools.partial(_create_http_connection, self, conn_class, True), req, **kwargs) | |
1537 | except urllib.error.URLError as e: | |
1538 | if (isinstance(e.reason, ssl.SSLError) | |
1539 | and getattr(e.reason, 'reason', None) == 'SSLV3_ALERT_HANDSHAKE_FAILURE'): | |
1540 | raise YoutubeDLError('SSLV3_ALERT_HANDSHAKE_FAILURE: Try using --legacy-server-connect') | |
1541 | raise | |
be4a824d PH |
1542 | |
1543 | ||
941e881e | 1544 | def is_path_like(f): |
1545 | return isinstance(f, (str, bytes, os.PathLike)) | |
1546 | ||
1547 | ||
ac668111 | 1548 | class YoutubeDLCookieJar(http.cookiejar.MozillaCookieJar): |
f1a8511f S |
1549 | """ |
1550 | See [1] for cookie file format. | |
1551 | ||
1552 | 1. https://curl.haxx.se/docs/http-cookies.html | |
1553 | """ | |
e7e62441 | 1554 | _HTTPONLY_PREFIX = '#HttpOnly_' |
c380cc28 S |
1555 | _ENTRY_LEN = 7 |
1556 | _HEADER = '''# Netscape HTTP Cookie File | |
7a5c1cfe | 1557 | # This file is generated by yt-dlp. Do not edit. |
c380cc28 S |
1558 | |
1559 | ''' | |
1560 | _CookieFileEntry = collections.namedtuple( | |
1561 | 'CookieFileEntry', | |
1562 | ('domain_name', 'include_subdomains', 'path', 'https_only', 'expires_at', 'name', 'value')) | |
e7e62441 | 1563 | |
d76fa1f3 | 1564 | def __init__(self, filename=None, *args, **kwargs): |
1565 | super().__init__(None, *args, **kwargs) | |
941e881e | 1566 | if is_path_like(filename): |
d76fa1f3 | 1567 | filename = os.fspath(filename) |
1568 | self.filename = filename | |
1569 | ||
24146491 | 1570 | @staticmethod |
1571 | def _true_or_false(cndn): | |
1572 | return 'TRUE' if cndn else 'FALSE' | |
1573 | ||
d76fa1f3 | 1574 | @contextlib.contextmanager |
1575 | def open(self, file, *, write=False): | |
941e881e | 1576 | if is_path_like(file): |
d76fa1f3 | 1577 | with open(file, 'w' if write else 'r', encoding='utf-8') as f: |
1578 | yield f | |
1579 | else: | |
1580 | if write: | |
1581 | file.truncate(0) | |
1582 | yield file | |
1583 | ||
24146491 | 1584 | def _really_save(self, f, ignore_discard=False, ignore_expires=False): |
1585 | now = time.time() | |
1586 | for cookie in self: | |
1587 | if (not ignore_discard and cookie.discard | |
1588 | or not ignore_expires and cookie.is_expired(now)): | |
1589 | continue | |
1590 | name, value = cookie.name, cookie.value | |
1591 | if value is None: | |
1592 | # cookies.txt regards 'Set-Cookie: foo' as a cookie | |
1593 | # with no name, whereas http.cookiejar regards it as a | |
1594 | # cookie with no value. | |
1595 | name, value = '', name | |
1596 | f.write('%s\n' % '\t'.join(( | |
1597 | cookie.domain, | |
1598 | self._true_or_false(cookie.domain.startswith('.')), | |
1599 | cookie.path, | |
1600 | self._true_or_false(cookie.secure), | |
1601 | str_or_none(cookie.expires, default=''), | |
1602 | name, value | |
1603 | ))) | |
1604 | ||
1605 | def save(self, filename=None, *args, **kwargs): | |
c380cc28 S |
1606 | """ |
1607 | Save cookies to a file. | |
24146491 | 1608 | Code is taken from CPython 3.6 |
1609 | https://github.com/python/cpython/blob/8d999cbf4adea053be6dbb612b9844635c4dfb8e/Lib/http/cookiejar.py#L2091-L2117 """ | |
c380cc28 | 1610 | |
c380cc28 S |
1611 | if filename is None: |
1612 | if self.filename is not None: | |
1613 | filename = self.filename | |
1614 | else: | |
ac668111 | 1615 | raise ValueError(http.cookiejar.MISSING_FILENAME_TEXT) |
c380cc28 | 1616 | |
24146491 | 1617 | # Store session cookies with `expires` set to 0 instead of an empty string |
1bab3437 S |
1618 | for cookie in self: |
1619 | if cookie.expires is None: | |
1620 | cookie.expires = 0 | |
c380cc28 | 1621 | |
d76fa1f3 | 1622 | with self.open(filename, write=True) as f: |
c380cc28 | 1623 | f.write(self._HEADER) |
24146491 | 1624 | self._really_save(f, *args, **kwargs) |
1bab3437 S |
1625 | |
1626 | def load(self, filename=None, ignore_discard=False, ignore_expires=False): | |
e7e62441 | 1627 | """Load cookies from a file.""" |
1628 | if filename is None: | |
1629 | if self.filename is not None: | |
1630 | filename = self.filename | |
1631 | else: | |
ac668111 | 1632 | raise ValueError(http.cookiejar.MISSING_FILENAME_TEXT) |
e7e62441 | 1633 | |
c380cc28 S |
1634 | def prepare_line(line): |
1635 | if line.startswith(self._HTTPONLY_PREFIX): | |
1636 | line = line[len(self._HTTPONLY_PREFIX):] | |
1637 | # comments and empty lines are fine | |
1638 | if line.startswith('#') or not line.strip(): | |
1639 | return line | |
1640 | cookie_list = line.split('\t') | |
1641 | if len(cookie_list) != self._ENTRY_LEN: | |
ac668111 | 1642 | raise http.cookiejar.LoadError('invalid length %d' % len(cookie_list)) |
c380cc28 S |
1643 | cookie = self._CookieFileEntry(*cookie_list) |
1644 | if cookie.expires_at and not cookie.expires_at.isdigit(): | |
ac668111 | 1645 | raise http.cookiejar.LoadError('invalid expires at %s' % cookie.expires_at) |
c380cc28 S |
1646 | return line |
1647 | ||
e7e62441 | 1648 | cf = io.StringIO() |
d76fa1f3 | 1649 | with self.open(filename) as f: |
e7e62441 | 1650 | for line in f: |
c380cc28 S |
1651 | try: |
1652 | cf.write(prepare_line(line)) | |
ac668111 | 1653 | except http.cookiejar.LoadError as e: |
94aa0644 | 1654 | if f'{line.strip()} '[0] in '[{"': |
ac668111 | 1655 | raise http.cookiejar.LoadError( |
94aa0644 | 1656 | 'Cookies file must be Netscape formatted, not JSON. See ' |
17ffed18 | 1657 | 'https://github.com/yt-dlp/yt-dlp/wiki/FAQ#how-do-i-pass-cookies-to-yt-dlp') |
19a03940 | 1658 | write_string(f'WARNING: skipping cookie file entry due to {e}: {line!r}\n') |
c380cc28 | 1659 | continue |
e7e62441 | 1660 | cf.seek(0) |
1661 | self._really_load(cf, filename, ignore_discard, ignore_expires) | |
1bab3437 S |
1662 | # Session cookies are denoted by either `expires` field set to |
1663 | # an empty string or 0. MozillaCookieJar only recognizes the former | |
1664 | # (see [1]). So we need force the latter to be recognized as session | |
1665 | # cookies on our own. | |
1666 | # Session cookies may be important for cookies-based authentication, | |
1667 | # e.g. usually, when user does not check 'Remember me' check box while | |
1668 | # logging in on a site, some important cookies are stored as session | |
1669 | # cookies so that not recognizing them will result in failed login. | |
1670 | # 1. https://bugs.python.org/issue17164 | |
1671 | for cookie in self: | |
1672 | # Treat `expires=0` cookies as session cookies | |
1673 | if cookie.expires == 0: | |
1674 | cookie.expires = None | |
1675 | cookie.discard = True | |
1676 | ||
1677 | ||
ac668111 | 1678 | class YoutubeDLCookieProcessor(urllib.request.HTTPCookieProcessor): |
a6420bf5 | 1679 | def __init__(self, cookiejar=None): |
ac668111 | 1680 | urllib.request.HTTPCookieProcessor.__init__(self, cookiejar) |
a6420bf5 S |
1681 | |
1682 | def http_response(self, request, response): | |
ac668111 | 1683 | return urllib.request.HTTPCookieProcessor.http_response(self, request, response) |
a6420bf5 | 1684 | |
ac668111 | 1685 | https_request = urllib.request.HTTPCookieProcessor.http_request |
a6420bf5 S |
1686 | https_response = http_response |
1687 | ||
1688 | ||
ac668111 | 1689 | class YoutubeDLRedirectHandler(urllib.request.HTTPRedirectHandler): |
201c1459 | 1690 | """YoutubeDL redirect handler |
1691 | ||
1692 | The code is based on HTTPRedirectHandler implementation from CPython [1]. | |
1693 | ||
1694 | This redirect handler solves two issues: | |
1695 | - ensures redirect URL is always unicode under python 2 | |
1696 | - introduces support for experimental HTTP response status code | |
1697 | 308 Permanent Redirect [2] used by some sites [3] | |
1698 | ||
1699 | 1. https://github.com/python/cpython/blob/master/Lib/urllib/request.py | |
1700 | 2. https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/308 | |
1701 | 3. https://github.com/ytdl-org/youtube-dl/issues/28768 | |
1702 | """ | |
1703 | ||
ac668111 | 1704 | http_error_301 = http_error_303 = http_error_307 = http_error_308 = urllib.request.HTTPRedirectHandler.http_error_302 |
201c1459 | 1705 | |
1706 | def redirect_request(self, req, fp, code, msg, headers, newurl): | |
1707 | """Return a Request or None in response to a redirect. | |
1708 | ||
1709 | This is called by the http_error_30x methods when a | |
1710 | redirection response is received. If a redirection should | |
1711 | take place, return a new Request to allow http_error_30x to | |
1712 | perform the redirect. Otherwise, raise HTTPError if no-one | |
1713 | else should try to handle this url. Return None if you can't | |
1714 | but another Handler might. | |
1715 | """ | |
1716 | m = req.get_method() | |
1717 | if (not (code in (301, 302, 303, 307, 308) and m in ("GET", "HEAD") | |
1718 | or code in (301, 302, 303) and m == "POST")): | |
14f25df2 | 1719 | raise urllib.error.HTTPError(req.full_url, code, msg, headers, fp) |
201c1459 | 1720 | # Strictly (according to RFC 2616), 301 or 302 in response to |
1721 | # a POST MUST NOT cause a redirection without confirmation | |
1722 | # from the user (of urllib.request, in this case). In practice, | |
1723 | # essentially all clients do redirect in this case, so we do | |
1724 | # the same. | |
1725 | ||
201c1459 | 1726 | # Be conciliant with URIs containing a space. This is mainly |
1727 | # redundant with the more complete encoding done in http_error_302(), | |
1728 | # but it is kept for compatibility with other callers. | |
1729 | newurl = newurl.replace(' ', '%20') | |
1730 | ||
1731 | CONTENT_HEADERS = ("content-length", "content-type") | |
1732 | # NB: don't use dict comprehension for python 2.6 compatibility | |
86e5f3ed | 1733 | newheaders = {k: v for k, v in req.headers.items() if k.lower() not in CONTENT_HEADERS} |
afac4caa | 1734 | |
1735 | # A 303 must either use GET or HEAD for subsequent request | |
1736 | # https://datatracker.ietf.org/doc/html/rfc7231#section-6.4.4 | |
1737 | if code == 303 and m != 'HEAD': | |
1738 | m = 'GET' | |
1739 | # 301 and 302 redirects are commonly turned into a GET from a POST | |
1740 | # for subsequent requests by browsers, so we'll do the same. | |
1741 | # https://datatracker.ietf.org/doc/html/rfc7231#section-6.4.2 | |
1742 | # https://datatracker.ietf.org/doc/html/rfc7231#section-6.4.3 | |
1743 | if code in (301, 302) and m == 'POST': | |
1744 | m = 'GET' | |
1745 | ||
ac668111 | 1746 | return urllib.request.Request( |
201c1459 | 1747 | newurl, headers=newheaders, origin_req_host=req.origin_req_host, |
afac4caa | 1748 | unverifiable=True, method=m) |
fca6dba8 S |
1749 | |
1750 | ||
46f59e89 S |
1751 | def extract_timezone(date_str): |
1752 | m = re.search( | |
f137e4c2 | 1753 | r'''(?x) |
1754 | ^.{8,}? # >=8 char non-TZ prefix, if present | |
1755 | (?P<tz>Z| # just the UTC Z, or | |
1756 | (?:(?<=.\b\d{4}|\b\d{2}:\d\d)| # preceded by 4 digits or hh:mm or | |
1757 | (?<!.\b[a-zA-Z]{3}|[a-zA-Z]{4}|..\b\d\d)) # not preceded by 3 alpha word or >= 4 alpha or 2 digits | |
1758 | [ ]? # optional space | |
1759 | (?P<sign>\+|-) # +/- | |
1760 | (?P<hours>[0-9]{2}):?(?P<minutes>[0-9]{2}) # hh[:]mm | |
1761 | $) | |
1762 | ''', date_str) | |
46f59e89 | 1763 | if not m: |
8f53dc44 | 1764 | m = re.search(r'\d{1,2}:\d{1,2}(?:\.\d+)?(?P<tz>\s*[A-Z]+)$', date_str) |
1765 | timezone = TIMEZONE_NAMES.get(m and m.group('tz').strip()) | |
1766 | if timezone is not None: | |
1767 | date_str = date_str[:-len(m.group('tz'))] | |
1768 | timezone = datetime.timedelta(hours=timezone or 0) | |
46f59e89 S |
1769 | else: |
1770 | date_str = date_str[:-len(m.group('tz'))] | |
1771 | if not m.group('sign'): | |
1772 | timezone = datetime.timedelta() | |
1773 | else: | |
1774 | sign = 1 if m.group('sign') == '+' else -1 | |
1775 | timezone = datetime.timedelta( | |
1776 | hours=sign * int(m.group('hours')), | |
1777 | minutes=sign * int(m.group('minutes'))) | |
1778 | return timezone, date_str | |
1779 | ||
1780 | ||
08b38d54 | 1781 | def parse_iso8601(date_str, delimiter='T', timezone=None): |
912b38b4 PH |
1782 | """ Return a UNIX timestamp from the given date """ |
1783 | ||
1784 | if date_str is None: | |
1785 | return None | |
1786 | ||
52c3a6e4 S |
1787 | date_str = re.sub(r'\.[0-9]+', '', date_str) |
1788 | ||
08b38d54 | 1789 | if timezone is None: |
46f59e89 S |
1790 | timezone, date_str = extract_timezone(date_str) |
1791 | ||
19a03940 | 1792 | with contextlib.suppress(ValueError): |
86e5f3ed | 1793 | date_format = f'%Y-%m-%d{delimiter}%H:%M:%S' |
52c3a6e4 S |
1794 | dt = datetime.datetime.strptime(date_str, date_format) - timezone |
1795 | return calendar.timegm(dt.timetuple()) | |
912b38b4 PH |
1796 | |
1797 | ||
46f59e89 S |
1798 | def date_formats(day_first=True): |
1799 | return DATE_FORMATS_DAY_FIRST if day_first else DATE_FORMATS_MONTH_FIRST | |
1800 | ||
1801 | ||
42bdd9d0 | 1802 | def unified_strdate(date_str, day_first=True): |
bf50b038 | 1803 | """Return a string with the date in the format YYYYMMDD""" |
64e7ad60 PH |
1804 | |
1805 | if date_str is None: | |
1806 | return None | |
bf50b038 | 1807 | upload_date = None |
5f6a1245 | 1808 | # Replace commas |
026fcc04 | 1809 | date_str = date_str.replace(',', ' ') |
42bdd9d0 | 1810 | # Remove AM/PM + timezone |
9bb8e0a3 | 1811 | date_str = re.sub(r'(?i)\s*(?:AM|PM)(?:\s+[A-Z]+)?', '', date_str) |
46f59e89 | 1812 | _, date_str = extract_timezone(date_str) |
42bdd9d0 | 1813 | |
46f59e89 | 1814 | for expression in date_formats(day_first): |
19a03940 | 1815 | with contextlib.suppress(ValueError): |
bf50b038 | 1816 | upload_date = datetime.datetime.strptime(date_str, expression).strftime('%Y%m%d') |
42393ce2 PH |
1817 | if upload_date is None: |
1818 | timetuple = email.utils.parsedate_tz(date_str) | |
1819 | if timetuple: | |
19a03940 | 1820 | with contextlib.suppress(ValueError): |
c6b9cf05 | 1821 | upload_date = datetime.datetime(*timetuple[:6]).strftime('%Y%m%d') |
6a750402 | 1822 | if upload_date is not None: |
14f25df2 | 1823 | return str(upload_date) |
bf50b038 | 1824 | |
5f6a1245 | 1825 | |
46f59e89 S |
1826 | def unified_timestamp(date_str, day_first=True): |
1827 | if date_str is None: | |
1828 | return None | |
1829 | ||
8f53dc44 | 1830 | date_str = re.sub(r'\s+', ' ', re.sub( |
1831 | r'(?i)[,|]|(mon|tues?|wed(nes)?|thu(rs)?|fri|sat(ur)?)(day)?', '', date_str)) | |
46f59e89 | 1832 | |
7dc2a74e | 1833 | pm_delta = 12 if re.search(r'(?i)PM', date_str) else 0 |
46f59e89 S |
1834 | timezone, date_str = extract_timezone(date_str) |
1835 | ||
1836 | # Remove AM/PM + timezone | |
1837 | date_str = re.sub(r'(?i)\s*(?:AM|PM)(?:\s+[A-Z]+)?', '', date_str) | |
1838 | ||
deef3195 S |
1839 | # Remove unrecognized timezones from ISO 8601 alike timestamps |
1840 | m = re.search(r'\d{1,2}:\d{1,2}(?:\.\d+)?(?P<tz>\s*[A-Z]+)$', date_str) | |
1841 | if m: | |
1842 | date_str = date_str[:-len(m.group('tz'))] | |
1843 | ||
f226880c PH |
1844 | # Python only supports microseconds, so remove nanoseconds |
1845 | m = re.search(r'^([0-9]{4,}-[0-9]{1,2}-[0-9]{1,2}T[0-9]{1,2}:[0-9]{1,2}:[0-9]{1,2}\.[0-9]{6})[0-9]+$', date_str) | |
1846 | if m: | |
1847 | date_str = m.group(1) | |
1848 | ||
46f59e89 | 1849 | for expression in date_formats(day_first): |
19a03940 | 1850 | with contextlib.suppress(ValueError): |
7dc2a74e | 1851 | dt = datetime.datetime.strptime(date_str, expression) - timezone + datetime.timedelta(hours=pm_delta) |
46f59e89 | 1852 | return calendar.timegm(dt.timetuple()) |
8f53dc44 | 1853 | |
46f59e89 S |
1854 | timetuple = email.utils.parsedate_tz(date_str) |
1855 | if timetuple: | |
8f53dc44 | 1856 | return calendar.timegm(timetuple) + pm_delta * 3600 - timezone.total_seconds() |
46f59e89 S |
1857 | |
1858 | ||
28e614de | 1859 | def determine_ext(url, default_ext='unknown_video'): |
85750f89 | 1860 | if url is None or '.' not in url: |
f4776371 | 1861 | return default_ext |
9cb9a5df | 1862 | guess = url.partition('?')[0].rpartition('.')[2] |
73e79f2a PH |
1863 | if re.match(r'^[A-Za-z0-9]+$', guess): |
1864 | return guess | |
a7aaa398 S |
1865 | # Try extract ext from URLs like http://example.com/foo/bar.mp4/?download |
1866 | elif guess.rstrip('/') in KNOWN_EXTENSIONS: | |
9cb9a5df | 1867 | return guess.rstrip('/') |
73e79f2a | 1868 | else: |
cbdbb766 | 1869 | return default_ext |
73e79f2a | 1870 | |
5f6a1245 | 1871 | |
824fa511 S |
1872 | def subtitles_filename(filename, sub_lang, sub_format, expected_real_ext=None): |
1873 | return replace_extension(filename, sub_lang + '.' + sub_format, expected_real_ext) | |
d4051a8e | 1874 | |
5f6a1245 | 1875 | |
9e62f283 | 1876 | def datetime_from_str(date_str, precision='auto', format='%Y%m%d'): |
3d38b2d6 | 1877 | R""" |
1878 | Return a datetime object from a string. | |
1879 | Supported format: | |
1880 | (now|today|yesterday|DATE)([+-]\d+(microsecond|second|minute|hour|day|week|month|year)s?)? | |
1881 | ||
1882 | @param format strftime format of DATE | |
1883 | @param precision Round the datetime object: auto|microsecond|second|minute|hour|day | |
1884 | auto: round to the unit provided in date_str (if applicable). | |
9e62f283 | 1885 | """ |
1886 | auto_precision = False | |
1887 | if precision == 'auto': | |
1888 | auto_precision = True | |
1889 | precision = 'microsecond' | |
396a76f7 | 1890 | today = datetime_round(datetime.datetime.utcnow(), precision) |
f8795e10 | 1891 | if date_str in ('now', 'today'): |
37254abc | 1892 | return today |
f8795e10 PH |
1893 | if date_str == 'yesterday': |
1894 | return today - datetime.timedelta(days=1) | |
9e62f283 | 1895 | match = re.match( |
3d38b2d6 | 1896 | r'(?P<start>.+)(?P<sign>[+-])(?P<time>\d+)(?P<unit>microsecond|second|minute|hour|day|week|month|year)s?', |
9e62f283 | 1897 | date_str) |
37254abc | 1898 | if match is not None: |
9e62f283 | 1899 | start_time = datetime_from_str(match.group('start'), precision, format) |
1900 | time = int(match.group('time')) * (-1 if match.group('sign') == '-' else 1) | |
37254abc | 1901 | unit = match.group('unit') |
9e62f283 | 1902 | if unit == 'month' or unit == 'year': |
1903 | new_date = datetime_add_months(start_time, time * 12 if unit == 'year' else time) | |
37254abc | 1904 | unit = 'day' |
9e62f283 | 1905 | else: |
1906 | if unit == 'week': | |
1907 | unit = 'day' | |
1908 | time *= 7 | |
1909 | delta = datetime.timedelta(**{unit + 's': time}) | |
1910 | new_date = start_time + delta | |
1911 | if auto_precision: | |
1912 | return datetime_round(new_date, unit) | |
1913 | return new_date | |
1914 | ||
1915 | return datetime_round(datetime.datetime.strptime(date_str, format), precision) | |
1916 | ||
1917 | ||
d49f8db3 | 1918 | def date_from_str(date_str, format='%Y%m%d', strict=False): |
3d38b2d6 | 1919 | R""" |
1920 | Return a date object from a string using datetime_from_str | |
9e62f283 | 1921 | |
3d38b2d6 | 1922 | @param strict Restrict allowed patterns to "YYYYMMDD" and |
1923 | (now|today|yesterday)(-\d+(day|week|month|year)s?)? | |
9e62f283 | 1924 | """ |
3d38b2d6 | 1925 | if strict and not re.fullmatch(r'\d{8}|(now|today|yesterday)(-\d+(day|week|month|year)s?)?', date_str): |
1926 | raise ValueError(f'Invalid date format "{date_str}"') | |
9e62f283 | 1927 | return datetime_from_str(date_str, precision='microsecond', format=format).date() |
1928 | ||
1929 | ||
1930 | def datetime_add_months(dt, months): | |
1931 | """Increment/Decrement a datetime object by months.""" | |
1932 | month = dt.month + months - 1 | |
1933 | year = dt.year + month // 12 | |
1934 | month = month % 12 + 1 | |
1935 | day = min(dt.day, calendar.monthrange(year, month)[1]) | |
1936 | return dt.replace(year, month, day) | |
1937 | ||
1938 | ||
1939 | def datetime_round(dt, precision='day'): | |
1940 | """ | |
1941 | Round a datetime object's time to a specific precision | |
1942 | """ | |
1943 | if precision == 'microsecond': | |
1944 | return dt | |
1945 | ||
1946 | unit_seconds = { | |
1947 | 'day': 86400, | |
1948 | 'hour': 3600, | |
1949 | 'minute': 60, | |
1950 | 'second': 1, | |
1951 | } | |
1952 | roundto = lambda x, n: ((x + n / 2) // n) * n | |
1953 | timestamp = calendar.timegm(dt.timetuple()) | |
1954 | return datetime.datetime.utcfromtimestamp(roundto(timestamp, unit_seconds[precision])) | |
5f6a1245 JW |
1955 | |
1956 | ||
e63fc1be | 1957 | def hyphenate_date(date_str): |
1958 | """ | |
1959 | Convert a date in 'YYYYMMDD' format to 'YYYY-MM-DD' format""" | |
1960 | match = re.match(r'^(\d\d\d\d)(\d\d)(\d\d)$', date_str) | |
1961 | if match is not None: | |
1962 | return '-'.join(match.groups()) | |
1963 | else: | |
1964 | return date_str | |
1965 | ||
5f6a1245 | 1966 | |
86e5f3ed | 1967 | class DateRange: |
bd558525 | 1968 | """Represents a time interval between two dates""" |
5f6a1245 | 1969 | |
bd558525 JMF |
1970 | def __init__(self, start=None, end=None): |
1971 | """start and end must be strings in the format accepted by date""" | |
1972 | if start is not None: | |
d49f8db3 | 1973 | self.start = date_from_str(start, strict=True) |
bd558525 JMF |
1974 | else: |
1975 | self.start = datetime.datetime.min.date() | |
1976 | if end is not None: | |
d49f8db3 | 1977 | self.end = date_from_str(end, strict=True) |
bd558525 JMF |
1978 | else: |
1979 | self.end = datetime.datetime.max.date() | |
37254abc | 1980 | if self.start > self.end: |
bd558525 | 1981 | raise ValueError('Date range: "%s" , the start date must be before the end date' % self) |
5f6a1245 | 1982 | |
bd558525 JMF |
1983 | @classmethod |
1984 | def day(cls, day): | |
1985 | """Returns a range that only contains the given day""" | |
5f6a1245 JW |
1986 | return cls(day, day) |
1987 | ||
bd558525 JMF |
1988 | def __contains__(self, date): |
1989 | """Check if the date is in the range""" | |
37254abc JMF |
1990 | if not isinstance(date, datetime.date): |
1991 | date = date_from_str(date) | |
1992 | return self.start <= date <= self.end | |
5f6a1245 | 1993 | |
bd558525 | 1994 | def __str__(self): |
86e5f3ed | 1995 | return f'{self.start.isoformat()} - {self.end.isoformat()}' |
c496ca96 | 1996 | |
f2df4071 | 1997 | def __eq__(self, other): |
1998 | return (isinstance(other, DateRange) | |
1999 | and self.start == other.start and self.end == other.end) | |
2000 | ||
c496ca96 PH |
2001 | |
2002 | def platform_name(): | |
14f25df2 | 2003 | """ Returns the platform name as a str """ |
da4db748 | 2004 | deprecation_warning(f'"{__name__}.platform_name" is deprecated, use "platform.platform" instead') |
b1f94422 | 2005 | return platform.platform() |
c496ca96 | 2006 | |
b1f94422 | 2007 | |
2008 | @functools.cache | |
2009 | def system_identifier(): | |
2010 | python_implementation = platform.python_implementation() | |
2011 | if python_implementation == 'PyPy' and hasattr(sys, 'pypy_version_info'): | |
2012 | python_implementation += ' version %d.%d.%d' % sys.pypy_version_info[:3] | |
dab284f8 | 2013 | libc_ver = [] |
2014 | with contextlib.suppress(OSError): # We may not have access to the executable | |
2015 | libc_ver = platform.libc_ver() | |
b1f94422 | 2016 | |
17fc3dc4 | 2017 | return 'Python %s (%s %s %s) - %s (%s%s)' % ( |
b1f94422 | 2018 | platform.python_version(), |
2019 | python_implementation, | |
17fc3dc4 | 2020 | platform.machine(), |
b1f94422 | 2021 | platform.architecture()[0], |
2022 | platform.platform(), | |
5b9f253f M |
2023 | ssl.OPENSSL_VERSION, |
2024 | format_field(join_nonempty(*libc_ver, delim=' '), None, ', %s'), | |
b1f94422 | 2025 | ) |
c257baff PH |
2026 | |
2027 | ||
0b9c08b4 | 2028 | @functools.cache |
49fa4d9a | 2029 | def get_windows_version(): |
8a82af35 | 2030 | ''' Get Windows version. returns () if it's not running on Windows ''' |
49fa4d9a N |
2031 | if compat_os_name == 'nt': |
2032 | return version_tuple(platform.win32_ver()[1]) | |
2033 | else: | |
8a82af35 | 2034 | return () |
49fa4d9a N |
2035 | |
2036 | ||
734f90bb | 2037 | def write_string(s, out=None, encoding=None): |
19a03940 | 2038 | assert isinstance(s, str) |
2039 | out = out or sys.stderr | |
7459e3a2 | 2040 | |
fe1daad3 | 2041 | if compat_os_name == 'nt' and supports_terminal_sequences(out): |
3fe75fdc | 2042 | s = re.sub(r'([\r\n]+)', r' \1', s) |
59f943cd | 2043 | |
8a82af35 | 2044 | enc, buffer = None, out |
cfb0511d | 2045 | if 'b' in getattr(out, 'mode', ''): |
c487cf00 | 2046 | enc = encoding or preferredencoding() |
104aa738 | 2047 | elif hasattr(out, 'buffer'): |
8a82af35 | 2048 | buffer = out.buffer |
104aa738 | 2049 | enc = encoding or getattr(out, 'encoding', None) or preferredencoding() |
c487cf00 | 2050 | |
8a82af35 | 2051 | buffer.write(s.encode(enc, 'ignore') if enc else s) |
7459e3a2 PH |
2052 | out.flush() |
2053 | ||
2054 | ||
da4db748 | 2055 | def deprecation_warning(msg, *, printer=None, stacklevel=0, **kwargs): |
2056 | from . import _IN_CLI | |
2057 | if _IN_CLI: | |
2058 | if msg in deprecation_warning._cache: | |
2059 | return | |
2060 | deprecation_warning._cache.add(msg) | |
2061 | if printer: | |
2062 | return printer(f'{msg}{bug_reports_message()}', **kwargs) | |
2063 | return write_string(f'ERROR: {msg}{bug_reports_message()}\n', **kwargs) | |
2064 | else: | |
2065 | import warnings | |
2066 | warnings.warn(DeprecationWarning(msg), stacklevel=stacklevel + 3) | |
2067 | ||
2068 | ||
2069 | deprecation_warning._cache = set() | |
2070 | ||
2071 | ||
48ea9cea PH |
2072 | def bytes_to_intlist(bs): |
2073 | if not bs: | |
2074 | return [] | |
2075 | if isinstance(bs[0], int): # Python 3 | |
2076 | return list(bs) | |
2077 | else: | |
2078 | return [ord(c) for c in bs] | |
2079 | ||
c257baff | 2080 | |
cba892fa | 2081 | def intlist_to_bytes(xs): |
2082 | if not xs: | |
2083 | return b'' | |
ac668111 | 2084 | return struct.pack('%dB' % len(xs), *xs) |
c38b1e77 PH |
2085 | |
2086 | ||
8a82af35 | 2087 | class LockingUnsupportedError(OSError): |
1890fc63 | 2088 | msg = 'File locking is not supported' |
0edb3e33 | 2089 | |
2090 | def __init__(self): | |
2091 | super().__init__(self.msg) | |
2092 | ||
2093 | ||
c1c9a79c PH |
2094 | # Cross-platform file locking |
2095 | if sys.platform == 'win32': | |
fe0918bb | 2096 | import ctypes |
c1c9a79c PH |
2097 | import ctypes.wintypes |
2098 | import msvcrt | |
2099 | ||
2100 | class OVERLAPPED(ctypes.Structure): | |
2101 | _fields_ = [ | |
2102 | ('Internal', ctypes.wintypes.LPVOID), | |
2103 | ('InternalHigh', ctypes.wintypes.LPVOID), | |
2104 | ('Offset', ctypes.wintypes.DWORD), | |
2105 | ('OffsetHigh', ctypes.wintypes.DWORD), | |
2106 | ('hEvent', ctypes.wintypes.HANDLE), | |
2107 | ] | |
2108 | ||
2109 | kernel32 = ctypes.windll.kernel32 | |
2110 | LockFileEx = kernel32.LockFileEx | |
2111 | LockFileEx.argtypes = [ | |
2112 | ctypes.wintypes.HANDLE, # hFile | |
2113 | ctypes.wintypes.DWORD, # dwFlags | |
2114 | ctypes.wintypes.DWORD, # dwReserved | |
2115 | ctypes.wintypes.DWORD, # nNumberOfBytesToLockLow | |
2116 | ctypes.wintypes.DWORD, # nNumberOfBytesToLockHigh | |
2117 | ctypes.POINTER(OVERLAPPED) # Overlapped | |
2118 | ] | |
2119 | LockFileEx.restype = ctypes.wintypes.BOOL | |
2120 | UnlockFileEx = kernel32.UnlockFileEx | |
2121 | UnlockFileEx.argtypes = [ | |
2122 | ctypes.wintypes.HANDLE, # hFile | |
2123 | ctypes.wintypes.DWORD, # dwReserved | |
2124 | ctypes.wintypes.DWORD, # nNumberOfBytesToLockLow | |
2125 | ctypes.wintypes.DWORD, # nNumberOfBytesToLockHigh | |
2126 | ctypes.POINTER(OVERLAPPED) # Overlapped | |
2127 | ] | |
2128 | UnlockFileEx.restype = ctypes.wintypes.BOOL | |
2129 | whole_low = 0xffffffff | |
2130 | whole_high = 0x7fffffff | |
2131 | ||
747c0bd1 | 2132 | def _lock_file(f, exclusive, block): |
c1c9a79c PH |
2133 | overlapped = OVERLAPPED() |
2134 | overlapped.Offset = 0 | |
2135 | overlapped.OffsetHigh = 0 | |
2136 | overlapped.hEvent = 0 | |
2137 | f._lock_file_overlapped_p = ctypes.pointer(overlapped) | |
747c0bd1 | 2138 | |
2139 | if not LockFileEx(msvcrt.get_osfhandle(f.fileno()), | |
2140 | (0x2 if exclusive else 0x0) | (0x0 if block else 0x1), | |
2141 | 0, whole_low, whole_high, f._lock_file_overlapped_p): | |
2cb19820 | 2142 | # NB: No argument form of "ctypes.FormatError" does not work on PyPy |
2143 | raise BlockingIOError(f'Locking file failed: {ctypes.FormatError(ctypes.GetLastError())!r}') | |
c1c9a79c PH |
2144 | |
2145 | def _unlock_file(f): | |
2146 | assert f._lock_file_overlapped_p | |
2147 | handle = msvcrt.get_osfhandle(f.fileno()) | |
747c0bd1 | 2148 | if not UnlockFileEx(handle, 0, whole_low, whole_high, f._lock_file_overlapped_p): |
c1c9a79c PH |
2149 | raise OSError('Unlocking file failed: %r' % ctypes.FormatError()) |
2150 | ||
2151 | else: | |
399a76e6 YCH |
2152 | try: |
2153 | import fcntl | |
c1c9a79c | 2154 | |
a3125791 | 2155 | def _lock_file(f, exclusive, block): |
b63837bc | 2156 | flags = fcntl.LOCK_EX if exclusive else fcntl.LOCK_SH |
2157 | if not block: | |
2158 | flags |= fcntl.LOCK_NB | |
acea8d7c | 2159 | try: |
b63837bc | 2160 | fcntl.flock(f, flags) |
acea8d7c JK |
2161 | except BlockingIOError: |
2162 | raise | |
2163 | except OSError: # AOSP does not have flock() | |
b63837bc | 2164 | fcntl.lockf(f, flags) |
c1c9a79c | 2165 | |
399a76e6 | 2166 | def _unlock_file(f): |
acea8d7c JK |
2167 | try: |
2168 | fcntl.flock(f, fcntl.LOCK_UN) | |
2169 | except OSError: | |
2170 | fcntl.lockf(f, fcntl.LOCK_UN) | |
a3125791 | 2171 | |
399a76e6 | 2172 | except ImportError: |
399a76e6 | 2173 | |
a3125791 | 2174 | def _lock_file(f, exclusive, block): |
0edb3e33 | 2175 | raise LockingUnsupportedError() |
399a76e6 YCH |
2176 | |
2177 | def _unlock_file(f): | |
0edb3e33 | 2178 | raise LockingUnsupportedError() |
c1c9a79c PH |
2179 | |
2180 | ||
86e5f3ed | 2181 | class locked_file: |
0edb3e33 | 2182 | locked = False |
747c0bd1 | 2183 | |
a3125791 | 2184 | def __init__(self, filename, mode, block=True, encoding=None): |
fcfa8853 JK |
2185 | if mode not in {'r', 'rb', 'a', 'ab', 'w', 'wb'}: |
2186 | raise NotImplementedError(mode) | |
2187 | self.mode, self.block = mode, block | |
2188 | ||
2189 | writable = any(f in mode for f in 'wax+') | |
2190 | readable = any(f in mode for f in 'r+') | |
2191 | flags = functools.reduce(operator.ior, ( | |
2192 | getattr(os, 'O_CLOEXEC', 0), # UNIX only | |
2193 | getattr(os, 'O_BINARY', 0), # Windows only | |
2194 | getattr(os, 'O_NOINHERIT', 0), # Windows only | |
2195 | os.O_CREAT if writable else 0, # O_TRUNC only after locking | |
2196 | os.O_APPEND if 'a' in mode else 0, | |
2197 | os.O_EXCL if 'x' in mode else 0, | |
2198 | os.O_RDONLY if not writable else os.O_RDWR if readable else os.O_WRONLY, | |
2199 | )) | |
2200 | ||
98804d03 | 2201 | self.f = os.fdopen(os.open(filename, flags, 0o666), mode, encoding=encoding) |
c1c9a79c PH |
2202 | |
2203 | def __enter__(self): | |
a3125791 | 2204 | exclusive = 'r' not in self.mode |
c1c9a79c | 2205 | try: |
a3125791 | 2206 | _lock_file(self.f, exclusive, self.block) |
0edb3e33 | 2207 | self.locked = True |
86e5f3ed | 2208 | except OSError: |
c1c9a79c PH |
2209 | self.f.close() |
2210 | raise | |
fcfa8853 | 2211 | if 'w' in self.mode: |
131e14dc JK |
2212 | try: |
2213 | self.f.truncate() | |
2214 | except OSError as e: | |
1890fc63 | 2215 | if e.errno not in ( |
2216 | errno.ESPIPE, # Illegal seek - expected for FIFO | |
2217 | errno.EINVAL, # Invalid argument - expected for /dev/null | |
2218 | ): | |
2219 | raise | |
c1c9a79c PH |
2220 | return self |
2221 | ||
0edb3e33 | 2222 | def unlock(self): |
2223 | if not self.locked: | |
2224 | return | |
c1c9a79c | 2225 | try: |
0edb3e33 | 2226 | _unlock_file(self.f) |
c1c9a79c | 2227 | finally: |
0edb3e33 | 2228 | self.locked = False |
c1c9a79c | 2229 | |
0edb3e33 | 2230 | def __exit__(self, *_): |
2231 | try: | |
2232 | self.unlock() | |
2233 | finally: | |
2234 | self.f.close() | |
4eb7f1d1 | 2235 | |
0edb3e33 | 2236 | open = __enter__ |
2237 | close = __exit__ | |
a3125791 | 2238 | |
0edb3e33 | 2239 | def __getattr__(self, attr): |
2240 | return getattr(self.f, attr) | |
a3125791 | 2241 | |
0edb3e33 | 2242 | def __iter__(self): |
2243 | return iter(self.f) | |
a3125791 | 2244 | |
4eb7f1d1 | 2245 | |
0b9c08b4 | 2246 | @functools.cache |
4644ac55 S |
2247 | def get_filesystem_encoding(): |
2248 | encoding = sys.getfilesystemencoding() | |
2249 | return encoding if encoding is not None else 'utf-8' | |
2250 | ||
2251 | ||
4eb7f1d1 | 2252 | def shell_quote(args): |
a6a173c2 | 2253 | quoted_args = [] |
4644ac55 | 2254 | encoding = get_filesystem_encoding() |
a6a173c2 JMF |
2255 | for a in args: |
2256 | if isinstance(a, bytes): | |
2257 | # We may get a filename encoded with 'encodeFilename' | |
2258 | a = a.decode(encoding) | |
aefce8e6 | 2259 | quoted_args.append(compat_shlex_quote(a)) |
28e614de | 2260 | return ' '.join(quoted_args) |
9d4660ca PH |
2261 | |
2262 | ||
2263 | def smuggle_url(url, data): | |
2264 | """ Pass additional data in a URL for internal use. """ | |
2265 | ||
81953d1a RA |
2266 | url, idata = unsmuggle_url(url, {}) |
2267 | data.update(idata) | |
14f25df2 | 2268 | sdata = urllib.parse.urlencode( |
28e614de PH |
2269 | {'__youtubedl_smuggle': json.dumps(data)}) |
2270 | return url + '#' + sdata | |
9d4660ca PH |
2271 | |
2272 | ||
79f82953 | 2273 | def unsmuggle_url(smug_url, default=None): |
83e865a3 | 2274 | if '#__youtubedl_smuggle' not in smug_url: |
79f82953 | 2275 | return smug_url, default |
28e614de | 2276 | url, _, sdata = smug_url.rpartition('#') |
14f25df2 | 2277 | jsond = urllib.parse.parse_qs(sdata)['__youtubedl_smuggle'][0] |
9d4660ca PH |
2278 | data = json.loads(jsond) |
2279 | return url, data | |
02dbf93f PH |
2280 | |
2281 | ||
e0fd9573 | 2282 | def format_decimal_suffix(num, fmt='%d%s', *, factor=1000): |
2283 | """ Formats numbers with decimal sufixes like K, M, etc """ | |
2284 | num, factor = float_or_none(num), float(factor) | |
4c3f8c3f | 2285 | if num is None or num < 0: |
e0fd9573 | 2286 | return None |
eeb2a770 | 2287 | POSSIBLE_SUFFIXES = 'kMGTPEZY' |
2288 | exponent = 0 if num == 0 else min(int(math.log(num, factor)), len(POSSIBLE_SUFFIXES)) | |
2289 | suffix = ['', *POSSIBLE_SUFFIXES][exponent] | |
abbeeebc | 2290 | if factor == 1024: |
2291 | suffix = {'k': 'Ki', '': ''}.get(suffix, f'{suffix}i') | |
e0fd9573 | 2292 | converted = num / (factor ** exponent) |
abbeeebc | 2293 | return fmt % (converted, suffix) |
e0fd9573 | 2294 | |
2295 | ||
02dbf93f | 2296 | def format_bytes(bytes): |
f02d24d8 | 2297 | return format_decimal_suffix(bytes, '%.2f%sB', factor=1024) or 'N/A' |
f53c966a | 2298 | |
1c088fa8 | 2299 | |
64c464a1 | 2300 | def lookup_unit_table(unit_table, s, strict=False): |
2301 | num_re = NUMBER_RE if strict else NUMBER_RE.replace(R'\.', '[,.]') | |
fb47597b | 2302 | units_re = '|'.join(re.escape(u) for u in unit_table) |
64c464a1 | 2303 | m = (re.fullmatch if strict else re.match)( |
2304 | rf'(?P<num>{num_re})\s*(?P<unit>{units_re})\b', s) | |
fb47597b S |
2305 | if not m: |
2306 | return None | |
64c464a1 | 2307 | |
2308 | num = float(m.group('num').replace(',', '.')) | |
fb47597b | 2309 | mult = unit_table[m.group('unit')] |
64c464a1 | 2310 | return round(num * mult) |
2311 | ||
2312 | ||
2313 | def parse_bytes(s): | |
2314 | """Parse a string indicating a byte quantity into an integer""" | |
2315 | return lookup_unit_table( | |
2316 | {u: 1024**i for i, u in enumerate(['', *'KMGTPEZY'])}, | |
2317 | s.upper(), strict=True) | |
fb47597b S |
2318 | |
2319 | ||
be64b5b0 PH |
2320 | def parse_filesize(s): |
2321 | if s is None: | |
2322 | return None | |
2323 | ||
dfb1b146 | 2324 | # The lower-case forms are of course incorrect and unofficial, |
be64b5b0 PH |
2325 | # but we support those too |
2326 | _UNIT_TABLE = { | |
2327 | 'B': 1, | |
2328 | 'b': 1, | |
70852b47 | 2329 | 'bytes': 1, |
be64b5b0 PH |
2330 | 'KiB': 1024, |
2331 | 'KB': 1000, | |
2332 | 'kB': 1024, | |
2333 | 'Kb': 1000, | |
13585d76 | 2334 | 'kb': 1000, |
70852b47 YCH |
2335 | 'kilobytes': 1000, |
2336 | 'kibibytes': 1024, | |
be64b5b0 PH |
2337 | 'MiB': 1024 ** 2, |
2338 | 'MB': 1000 ** 2, | |
2339 | 'mB': 1024 ** 2, | |
2340 | 'Mb': 1000 ** 2, | |
13585d76 | 2341 | 'mb': 1000 ** 2, |
70852b47 YCH |
2342 | 'megabytes': 1000 ** 2, |
2343 | 'mebibytes': 1024 ** 2, | |
be64b5b0 PH |
2344 | 'GiB': 1024 ** 3, |
2345 | 'GB': 1000 ** 3, | |
2346 | 'gB': 1024 ** 3, | |
2347 | 'Gb': 1000 ** 3, | |
13585d76 | 2348 | 'gb': 1000 ** 3, |
70852b47 YCH |
2349 | 'gigabytes': 1000 ** 3, |
2350 | 'gibibytes': 1024 ** 3, | |
be64b5b0 PH |
2351 | 'TiB': 1024 ** 4, |
2352 | 'TB': 1000 ** 4, | |
2353 | 'tB': 1024 ** 4, | |
2354 | 'Tb': 1000 ** 4, | |
13585d76 | 2355 | 'tb': 1000 ** 4, |
70852b47 YCH |
2356 | 'terabytes': 1000 ** 4, |
2357 | 'tebibytes': 1024 ** 4, | |
be64b5b0 PH |
2358 | 'PiB': 1024 ** 5, |
2359 | 'PB': 1000 ** 5, | |
2360 | 'pB': 1024 ** 5, | |
2361 | 'Pb': 1000 ** 5, | |
13585d76 | 2362 | 'pb': 1000 ** 5, |
70852b47 YCH |
2363 | 'petabytes': 1000 ** 5, |
2364 | 'pebibytes': 1024 ** 5, | |
be64b5b0 PH |
2365 | 'EiB': 1024 ** 6, |
2366 | 'EB': 1000 ** 6, | |
2367 | 'eB': 1024 ** 6, | |
2368 | 'Eb': 1000 ** 6, | |
13585d76 | 2369 | 'eb': 1000 ** 6, |
70852b47 YCH |
2370 | 'exabytes': 1000 ** 6, |
2371 | 'exbibytes': 1024 ** 6, | |
be64b5b0 PH |
2372 | 'ZiB': 1024 ** 7, |
2373 | 'ZB': 1000 ** 7, | |
2374 | 'zB': 1024 ** 7, | |
2375 | 'Zb': 1000 ** 7, | |
13585d76 | 2376 | 'zb': 1000 ** 7, |
70852b47 YCH |
2377 | 'zettabytes': 1000 ** 7, |
2378 | 'zebibytes': 1024 ** 7, | |
be64b5b0 PH |
2379 | 'YiB': 1024 ** 8, |
2380 | 'YB': 1000 ** 8, | |
2381 | 'yB': 1024 ** 8, | |
2382 | 'Yb': 1000 ** 8, | |
13585d76 | 2383 | 'yb': 1000 ** 8, |
70852b47 YCH |
2384 | 'yottabytes': 1000 ** 8, |
2385 | 'yobibytes': 1024 ** 8, | |
be64b5b0 PH |
2386 | } |
2387 | ||
fb47597b S |
2388 | return lookup_unit_table(_UNIT_TABLE, s) |
2389 | ||
2390 | ||
2391 | def parse_count(s): | |
2392 | if s is None: | |
be64b5b0 PH |
2393 | return None |
2394 | ||
352d5da8 | 2395 | s = re.sub(r'^[^\d]+\s', '', s).strip() |
fb47597b S |
2396 | |
2397 | if re.match(r'^[\d,.]+$', s): | |
2398 | return str_to_int(s) | |
2399 | ||
2400 | _UNIT_TABLE = { | |
2401 | 'k': 1000, | |
2402 | 'K': 1000, | |
2403 | 'm': 1000 ** 2, | |
2404 | 'M': 1000 ** 2, | |
2405 | 'kk': 1000 ** 2, | |
2406 | 'KK': 1000 ** 2, | |
352d5da8 | 2407 | 'b': 1000 ** 3, |
2408 | 'B': 1000 ** 3, | |
fb47597b | 2409 | } |
be64b5b0 | 2410 | |
352d5da8 | 2411 | ret = lookup_unit_table(_UNIT_TABLE, s) |
2412 | if ret is not None: | |
2413 | return ret | |
2414 | ||
2415 | mobj = re.match(r'([\d,.]+)(?:$|\s)', s) | |
2416 | if mobj: | |
2417 | return str_to_int(mobj.group(1)) | |
be64b5b0 | 2418 | |
2f7ae819 | 2419 | |
5d45484c | 2420 | def parse_resolution(s, *, lenient=False): |
b871d7e9 S |
2421 | if s is None: |
2422 | return {} | |
2423 | ||
5d45484c LNO |
2424 | if lenient: |
2425 | mobj = re.search(r'(?P<w>\d+)\s*[xX×,]\s*(?P<h>\d+)', s) | |
2426 | else: | |
2427 | mobj = re.search(r'(?<![a-zA-Z0-9])(?P<w>\d+)\s*[xX×,]\s*(?P<h>\d+)(?![a-zA-Z0-9])', s) | |
b871d7e9 S |
2428 | if mobj: |
2429 | return { | |
2430 | 'width': int(mobj.group('w')), | |
2431 | 'height': int(mobj.group('h')), | |
2432 | } | |
2433 | ||
17ec8bcf | 2434 | mobj = re.search(r'(?<![a-zA-Z0-9])(\d+)[pPiI](?![a-zA-Z0-9])', s) |
b871d7e9 S |
2435 | if mobj: |
2436 | return {'height': int(mobj.group(1))} | |
2437 | ||
2438 | mobj = re.search(r'\b([48])[kK]\b', s) | |
2439 | if mobj: | |
2440 | return {'height': int(mobj.group(1)) * 540} | |
2441 | ||
2442 | return {} | |
2443 | ||
2444 | ||
0dc41787 | 2445 | def parse_bitrate(s): |
14f25df2 | 2446 | if not isinstance(s, str): |
0dc41787 S |
2447 | return |
2448 | mobj = re.search(r'\b(\d+)\s*kbps', s) | |
2449 | if mobj: | |
2450 | return int(mobj.group(1)) | |
2451 | ||
2452 | ||
a942d6cb | 2453 | def month_by_name(name, lang='en'): |
caefb1de PH |
2454 | """ Return the number of a month by (locale-independently) English name """ |
2455 | ||
f6717dec | 2456 | month_names = MONTH_NAMES.get(lang, MONTH_NAMES['en']) |
a942d6cb | 2457 | |
caefb1de | 2458 | try: |
f6717dec | 2459 | return month_names.index(name) + 1 |
7105440c YCH |
2460 | except ValueError: |
2461 | return None | |
2462 | ||
2463 | ||
2464 | def month_by_abbreviation(abbrev): | |
2465 | """ Return the number of a month by (locale-independently) English | |
2466 | abbreviations """ | |
2467 | ||
2468 | try: | |
2469 | return [s[:3] for s in ENGLISH_MONTH_NAMES].index(abbrev) + 1 | |
caefb1de PH |
2470 | except ValueError: |
2471 | return None | |
18258362 JMF |
2472 | |
2473 | ||
5aafe895 | 2474 | def fix_xml_ampersands(xml_str): |
18258362 | 2475 | """Replace all the '&' by '&' in XML""" |
5aafe895 PH |
2476 | return re.sub( |
2477 | r'&(?!amp;|lt;|gt;|apos;|quot;|#x[0-9a-fA-F]{,4};|#[0-9]{,4};)', | |
28e614de | 2478 | '&', |
5aafe895 | 2479 | xml_str) |
e3946f98 PH |
2480 | |
2481 | ||
2482 | def setproctitle(title): | |
14f25df2 | 2483 | assert isinstance(title, str) |
c1c05c67 | 2484 | |
fe0918bb | 2485 | # Workaround for https://github.com/yt-dlp/yt-dlp/issues/4541 |
2486 | try: | |
2487 | import ctypes | |
2488 | except ImportError: | |
c1c05c67 YCH |
2489 | return |
2490 | ||
e3946f98 | 2491 | try: |
611c1dd9 | 2492 | libc = ctypes.cdll.LoadLibrary('libc.so.6') |
e3946f98 PH |
2493 | except OSError: |
2494 | return | |
2f49bcd6 RC |
2495 | except TypeError: |
2496 | # LoadLibrary in Windows Python 2.7.13 only expects | |
2497 | # a bytestring, but since unicode_literals turns | |
2498 | # every string into a unicode string, it fails. | |
2499 | return | |
0f06bcd7 | 2500 | title_bytes = title.encode() |
6eefe533 PH |
2501 | buf = ctypes.create_string_buffer(len(title_bytes)) |
2502 | buf.value = title_bytes | |
e3946f98 | 2503 | try: |
6eefe533 | 2504 | libc.prctl(15, buf, 0, 0, 0) |
e3946f98 PH |
2505 | except AttributeError: |
2506 | return # Strange libc, just skip this | |
d7dda168 PH |
2507 | |
2508 | ||
2509 | def remove_start(s, start): | |
46bc9b7d | 2510 | return s[len(start):] if s is not None and s.startswith(start) else s |
29eb5174 PH |
2511 | |
2512 | ||
2b9faf55 | 2513 | def remove_end(s, end): |
46bc9b7d | 2514 | return s[:-len(end)] if s is not None and s.endswith(end) else s |
2b9faf55 PH |
2515 | |
2516 | ||
31b2051e S |
2517 | def remove_quotes(s): |
2518 | if s is None or len(s) < 2: | |
2519 | return s | |
2520 | for quote in ('"', "'", ): | |
2521 | if s[0] == quote and s[-1] == quote: | |
2522 | return s[1:-1] | |
2523 | return s | |
2524 | ||
2525 | ||
b6e0c7d2 | 2526 | def get_domain(url): |
ebf99aaf | 2527 | """ |
2528 | This implementation is inconsistent, but is kept for compatibility. | |
2529 | Use this only for "webpage_url_domain" | |
2530 | """ | |
2531 | return remove_start(urllib.parse.urlparse(url).netloc, 'www.') or None | |
b6e0c7d2 U |
2532 | |
2533 | ||
29eb5174 | 2534 | def url_basename(url): |
14f25df2 | 2535 | path = urllib.parse.urlparse(url).path |
28e614de | 2536 | return path.strip('/').split('/')[-1] |
aa94a6d3 PH |
2537 | |
2538 | ||
02dc0a36 | 2539 | def base_url(url): |
7657ec7e | 2540 | return re.match(r'https?://[^?#]+/', url).group() |
02dc0a36 S |
2541 | |
2542 | ||
e34c3361 | 2543 | def urljoin(base, path): |
4b5de77b | 2544 | if isinstance(path, bytes): |
0f06bcd7 | 2545 | path = path.decode() |
14f25df2 | 2546 | if not isinstance(path, str) or not path: |
e34c3361 | 2547 | return None |
fad4ceb5 | 2548 | if re.match(r'^(?:[a-zA-Z][a-zA-Z0-9+-.]*:)?//', path): |
e34c3361 | 2549 | return path |
4b5de77b | 2550 | if isinstance(base, bytes): |
0f06bcd7 | 2551 | base = base.decode() |
14f25df2 | 2552 | if not isinstance(base, str) or not re.match( |
4b5de77b | 2553 | r'^(?:https?:)?//', base): |
e34c3361 | 2554 | return None |
14f25df2 | 2555 | return urllib.parse.urljoin(base, path) |
e34c3361 S |
2556 | |
2557 | ||
ac668111 | 2558 | class HEADRequest(urllib.request.Request): |
aa94a6d3 | 2559 | def get_method(self): |
611c1dd9 | 2560 | return 'HEAD' |
7217e148 PH |
2561 | |
2562 | ||
ac668111 | 2563 | class PUTRequest(urllib.request.Request): |
95cf60e8 S |
2564 | def get_method(self): |
2565 | return 'PUT' | |
2566 | ||
2567 | ||
9732d77e | 2568 | def int_or_none(v, scale=1, default=None, get_attr=None, invscale=1): |
9e907ebd | 2569 | if get_attr and v is not None: |
2570 | v = getattr(v, get_attr, None) | |
1812afb7 S |
2571 | try: |
2572 | return int(v) * invscale // scale | |
31c49255 | 2573 | except (ValueError, TypeError, OverflowError): |
af98f8ff | 2574 | return default |
9732d77e | 2575 | |
9572013d | 2576 | |
40a90862 | 2577 | def str_or_none(v, default=None): |
14f25df2 | 2578 | return default if v is None else str(v) |
40a90862 | 2579 | |
9732d77e PH |
2580 | |
2581 | def str_to_int(int_str): | |
48d4681e | 2582 | """ A more relaxed version of int_or_none """ |
f9934b96 | 2583 | if isinstance(int_str, int): |
348c6bf1 | 2584 | return int_str |
14f25df2 | 2585 | elif isinstance(int_str, str): |
42db58ec S |
2586 | int_str = re.sub(r'[,\.\+]', '', int_str) |
2587 | return int_or_none(int_str) | |
608d11f5 PH |
2588 | |
2589 | ||
9732d77e | 2590 | def float_or_none(v, scale=1, invscale=1, default=None): |
caf80631 S |
2591 | if v is None: |
2592 | return default | |
2593 | try: | |
2594 | return float(v) * invscale / scale | |
5e1271c5 | 2595 | except (ValueError, TypeError): |
caf80631 | 2596 | return default |
43f775e4 PH |
2597 | |
2598 | ||
c7e327c4 S |
2599 | def bool_or_none(v, default=None): |
2600 | return v if isinstance(v, bool) else default | |
2601 | ||
2602 | ||
53cd37ba | 2603 | def strip_or_none(v, default=None): |
14f25df2 | 2604 | return v.strip() if isinstance(v, str) else default |
b72b4431 S |
2605 | |
2606 | ||
af03000a | 2607 | def url_or_none(url): |
14f25df2 | 2608 | if not url or not isinstance(url, str): |
af03000a S |
2609 | return None |
2610 | url = url.strip() | |
29f7c58a | 2611 | return url if re.match(r'^(?:(?:https?|rt(?:m(?:pt?[es]?|fp)|sp[su]?)|mms|ftps?):)?//', url) else None |
af03000a S |
2612 | |
2613 | ||
3e9b66d7 | 2614 | def request_to_url(req): |
ac668111 | 2615 | if isinstance(req, urllib.request.Request): |
3e9b66d7 LNO |
2616 | return req.get_full_url() |
2617 | else: | |
2618 | return req | |
2619 | ||
2620 | ||
e29663c6 | 2621 | def strftime_or_none(timestamp, date_format, default=None): |
2622 | datetime_object = None | |
2623 | try: | |
f9934b96 | 2624 | if isinstance(timestamp, (int, float)): # unix timestamp |
d509c1f5 | 2625 | # Using naive datetime here can break timestamp() in Windows |
2626 | # Ref: https://github.com/yt-dlp/yt-dlp/issues/5185, https://github.com/python/cpython/issues/94414 | |
2627 | datetime_object = datetime.datetime.fromtimestamp(timestamp, datetime.timezone.utc) | |
14f25df2 | 2628 | elif isinstance(timestamp, str): # assume YYYYMMDD |
e29663c6 | 2629 | datetime_object = datetime.datetime.strptime(timestamp, '%Y%m%d') |
9665f15a | 2630 | date_format = re.sub( # Support %s on windows |
2631 | r'(?<!%)(%%)*%s', rf'\g<1>{int(datetime_object.timestamp())}', date_format) | |
e29663c6 | 2632 | return datetime_object.strftime(date_format) |
2633 | except (ValueError, TypeError, AttributeError): | |
2634 | return default | |
2635 | ||
2636 | ||
608d11f5 | 2637 | def parse_duration(s): |
f9934b96 | 2638 | if not isinstance(s, str): |
608d11f5 | 2639 | return None |
ca7b3246 | 2640 | s = s.strip() |
38d79fd1 | 2641 | if not s: |
2642 | return None | |
ca7b3246 | 2643 | |
acaff495 | 2644 | days, hours, mins, secs, ms = [None] * 5 |
8bd1c00b | 2645 | m = re.match(r'''(?x) |
2646 | (?P<before_secs> | |
2647 | (?:(?:(?P<days>[0-9]+):)?(?P<hours>[0-9]+):)?(?P<mins>[0-9]+):)? | |
2648 | (?P<secs>(?(before_secs)[0-9]{1,2}|[0-9]+)) | |
2649 | (?P<ms>[.:][0-9]+)?Z?$ | |
2650 | ''', s) | |
acaff495 | 2651 | if m: |
8bd1c00b | 2652 | days, hours, mins, secs, ms = m.group('days', 'hours', 'mins', 'secs', 'ms') |
acaff495 | 2653 | else: |
2654 | m = re.match( | |
056653bb S |
2655 | r'''(?ix)(?:P? |
2656 | (?: | |
1c1b2f96 | 2657 | [0-9]+\s*y(?:ears?)?,?\s* |
056653bb S |
2658 | )? |
2659 | (?: | |
1c1b2f96 | 2660 | [0-9]+\s*m(?:onths?)?,?\s* |
056653bb S |
2661 | )? |
2662 | (?: | |
1c1b2f96 | 2663 | [0-9]+\s*w(?:eeks?)?,?\s* |
056653bb | 2664 | )? |
8f4b58d7 | 2665 | (?: |
1c1b2f96 | 2666 | (?P<days>[0-9]+)\s*d(?:ays?)?,?\s* |
8f4b58d7 | 2667 | )? |
056653bb | 2668 | T)? |
acaff495 | 2669 | (?: |
1c1b2f96 | 2670 | (?P<hours>[0-9]+)\s*h(?:ours?)?,?\s* |
acaff495 | 2671 | )? |
2672 | (?: | |
1c1b2f96 | 2673 | (?P<mins>[0-9]+)\s*m(?:in(?:ute)?s?)?,?\s* |
acaff495 | 2674 | )? |
2675 | (?: | |
2676 | (?P<secs>[0-9]+)(?P<ms>\.[0-9]+)?\s*s(?:ec(?:ond)?s?)?\s* | |
15846398 | 2677 | )?Z?$''', s) |
acaff495 | 2678 | if m: |
2679 | days, hours, mins, secs, ms = m.groups() | |
2680 | else: | |
15846398 | 2681 | m = re.match(r'(?i)(?:(?P<hours>[0-9.]+)\s*(?:hours?)|(?P<mins>[0-9.]+)\s*(?:mins?\.?|minutes?)\s*)Z?$', s) |
acaff495 | 2682 | if m: |
2683 | hours, mins = m.groups() | |
2684 | else: | |
2685 | return None | |
2686 | ||
acaff495 | 2687 | if ms: |
19a03940 | 2688 | ms = ms.replace(':', '.') |
2689 | return sum(float(part or 0) * mult for part, mult in ( | |
2690 | (days, 86400), (hours, 3600), (mins, 60), (secs, 1), (ms, 1))) | |
91d7d0b3 JMF |
2691 | |
2692 | ||
e65e4c88 | 2693 | def prepend_extension(filename, ext, expected_real_ext=None): |
5f6a1245 | 2694 | name, real_ext = os.path.splitext(filename) |
e65e4c88 | 2695 | return ( |
86e5f3ed | 2696 | f'{name}.{ext}{real_ext}' |
e65e4c88 | 2697 | if not expected_real_ext or real_ext[1:] == expected_real_ext |
86e5f3ed | 2698 | else f'{filename}.{ext}') |
d70ad093 PH |
2699 | |
2700 | ||
b3ed15b7 S |
2701 | def replace_extension(filename, ext, expected_real_ext=None): |
2702 | name, real_ext = os.path.splitext(filename) | |
86e5f3ed | 2703 | return '{}.{}'.format( |
b3ed15b7 S |
2704 | name if not expected_real_ext or real_ext[1:] == expected_real_ext else filename, |
2705 | ext) | |
2706 | ||
2707 | ||
d70ad093 PH |
2708 | def check_executable(exe, args=[]): |
2709 | """ Checks if the given binary is installed somewhere in PATH, and returns its name. | |
2710 | args can be a list of arguments for a short output (like -version) """ | |
2711 | try: | |
f0c9fb96 | 2712 | Popen.run([exe] + args, stdout=subprocess.PIPE, stderr=subprocess.PIPE) |
d70ad093 PH |
2713 | except OSError: |
2714 | return False | |
2715 | return exe | |
b7ab0590 PH |
2716 | |
2717 | ||
7aaf4cd2 | 2718 | def _get_exe_version_output(exe, args): |
95807118 | 2719 | try: |
b64d04c1 | 2720 | # STDIN should be redirected too. On UNIX-like systems, ffmpeg triggers |
7a5c1cfe | 2721 | # SIGTTOU if yt-dlp is run in the background. |
067aa17e | 2722 | # See https://github.com/ytdl-org/youtube-dl/issues/955#issuecomment-209789656 |
1cdda329 | 2723 | stdout, _, ret = Popen.run([encodeArgument(exe)] + args, text=True, |
2724 | stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.STDOUT) | |
2725 | if ret: | |
2726 | return None | |
95807118 PH |
2727 | except OSError: |
2728 | return False | |
f0c9fb96 | 2729 | return stdout |
cae97f65 PH |
2730 | |
2731 | ||
2732 | def detect_exe_version(output, version_re=None, unrecognized='present'): | |
14f25df2 | 2733 | assert isinstance(output, str) |
cae97f65 PH |
2734 | if version_re is None: |
2735 | version_re = r'version\s+([-0-9._a-zA-Z]+)' | |
2736 | m = re.search(version_re, output) | |
95807118 PH |
2737 | if m: |
2738 | return m.group(1) | |
2739 | else: | |
2740 | return unrecognized | |
2741 | ||
2742 | ||
9af98e17 | 2743 | def get_exe_version(exe, args=['--version'], |
1cdda329 | 2744 | version_re=None, unrecognized=('present', 'broken')): |
9af98e17 | 2745 | """ Returns the version of the specified executable, |
2746 | or False if the executable is not present """ | |
1cdda329 | 2747 | unrecognized = variadic(unrecognized) |
2748 | assert len(unrecognized) in (1, 2) | |
9af98e17 | 2749 | out = _get_exe_version_output(exe, args) |
1cdda329 | 2750 | if out is None: |
2751 | return unrecognized[-1] | |
2752 | return out and detect_exe_version(out, version_re, unrecognized[0]) | |
9af98e17 | 2753 | |
2754 | ||
7e88d7d7 | 2755 | def frange(start=0, stop=None, step=1): |
2756 | """Float range""" | |
2757 | if stop is None: | |
2758 | start, stop = 0, start | |
2759 | sign = [-1, 1][step > 0] if step else 0 | |
2760 | while sign * start < sign * stop: | |
2761 | yield start | |
2762 | start += step | |
2763 | ||
2764 | ||
cb89cfc1 | 2765 | class LazyList(collections.abc.Sequence): |
0f06bcd7 | 2766 | """Lazy immutable list from an iterable |
2767 | Note that slices of a LazyList are lists and not LazyList""" | |
483336e7 | 2768 | |
8e5fecc8 | 2769 | class IndexError(IndexError): |
2770 | pass | |
2771 | ||
282f5709 | 2772 | def __init__(self, iterable, *, reverse=False, _cache=None): |
0f06bcd7 | 2773 | self._iterable = iter(iterable) |
2774 | self._cache = [] if _cache is None else _cache | |
2775 | self._reversed = reverse | |
483336e7 | 2776 | |
2777 | def __iter__(self): | |
0f06bcd7 | 2778 | if self._reversed: |
28419ca2 | 2779 | # We need to consume the entire iterable to iterate in reverse |
981052c9 | 2780 | yield from self.exhaust() |
28419ca2 | 2781 | return |
0f06bcd7 | 2782 | yield from self._cache |
2783 | for item in self._iterable: | |
2784 | self._cache.append(item) | |
483336e7 | 2785 | yield item |
2786 | ||
0f06bcd7 | 2787 | def _exhaust(self): |
2788 | self._cache.extend(self._iterable) | |
2789 | self._iterable = [] # Discard the emptied iterable to make it pickle-able | |
2790 | return self._cache | |
28419ca2 | 2791 | |
981052c9 | 2792 | def exhaust(self): |
0f06bcd7 | 2793 | """Evaluate the entire iterable""" |
2794 | return self._exhaust()[::-1 if self._reversed else 1] | |
981052c9 | 2795 | |
28419ca2 | 2796 | @staticmethod |
0f06bcd7 | 2797 | def _reverse_index(x): |
f2df4071 | 2798 | return None if x is None else ~x |
483336e7 | 2799 | |
2800 | def __getitem__(self, idx): | |
2801 | if isinstance(idx, slice): | |
0f06bcd7 | 2802 | if self._reversed: |
2803 | idx = slice(self._reverse_index(idx.start), self._reverse_index(idx.stop), -(idx.step or 1)) | |
e0f2b4b4 | 2804 | start, stop, step = idx.start, idx.stop, idx.step or 1 |
483336e7 | 2805 | elif isinstance(idx, int): |
0f06bcd7 | 2806 | if self._reversed: |
2807 | idx = self._reverse_index(idx) | |
e0f2b4b4 | 2808 | start, stop, step = idx, idx, 0 |
483336e7 | 2809 | else: |
2810 | raise TypeError('indices must be integers or slices') | |
e0f2b4b4 | 2811 | if ((start or 0) < 0 or (stop or 0) < 0 |
2812 | or (start is None and step < 0) | |
2813 | or (stop is None and step > 0)): | |
483336e7 | 2814 | # We need to consume the entire iterable to be able to slice from the end |
2815 | # Obviously, never use this with infinite iterables | |
0f06bcd7 | 2816 | self._exhaust() |
8e5fecc8 | 2817 | try: |
0f06bcd7 | 2818 | return self._cache[idx] |
8e5fecc8 | 2819 | except IndexError as e: |
2820 | raise self.IndexError(e) from e | |
0f06bcd7 | 2821 | n = max(start or 0, stop or 0) - len(self._cache) + 1 |
28419ca2 | 2822 | if n > 0: |
0f06bcd7 | 2823 | self._cache.extend(itertools.islice(self._iterable, n)) |
8e5fecc8 | 2824 | try: |
0f06bcd7 | 2825 | return self._cache[idx] |
8e5fecc8 | 2826 | except IndexError as e: |
2827 | raise self.IndexError(e) from e | |
483336e7 | 2828 | |
2829 | def __bool__(self): | |
2830 | try: | |
0f06bcd7 | 2831 | self[-1] if self._reversed else self[0] |
8e5fecc8 | 2832 | except self.IndexError: |
483336e7 | 2833 | return False |
2834 | return True | |
2835 | ||
2836 | def __len__(self): | |
0f06bcd7 | 2837 | self._exhaust() |
2838 | return len(self._cache) | |
483336e7 | 2839 | |
282f5709 | 2840 | def __reversed__(self): |
0f06bcd7 | 2841 | return type(self)(self._iterable, reverse=not self._reversed, _cache=self._cache) |
282f5709 | 2842 | |
2843 | def __copy__(self): | |
0f06bcd7 | 2844 | return type(self)(self._iterable, reverse=self._reversed, _cache=self._cache) |
282f5709 | 2845 | |
28419ca2 | 2846 | def __repr__(self): |
2847 | # repr and str should mimic a list. So we exhaust the iterable | |
2848 | return repr(self.exhaust()) | |
2849 | ||
2850 | def __str__(self): | |
2851 | return repr(self.exhaust()) | |
2852 | ||
483336e7 | 2853 | |
7be9ccff | 2854 | class PagedList: |
c07a39ae | 2855 | |
2856 | class IndexError(IndexError): | |
2857 | pass | |
2858 | ||
dd26ced1 PH |
2859 | def __len__(self): |
2860 | # This is only useful for tests | |
2861 | return len(self.getslice()) | |
2862 | ||
7be9ccff | 2863 | def __init__(self, pagefunc, pagesize, use_cache=True): |
2864 | self._pagefunc = pagefunc | |
2865 | self._pagesize = pagesize | |
f1d13090 | 2866 | self._pagecount = float('inf') |
7be9ccff | 2867 | self._use_cache = use_cache |
2868 | self._cache = {} | |
2869 | ||
2870 | def getpage(self, pagenum): | |
d8cf8d97 | 2871 | page_results = self._cache.get(pagenum) |
2872 | if page_results is None: | |
f1d13090 | 2873 | page_results = [] if pagenum > self._pagecount else list(self._pagefunc(pagenum)) |
7be9ccff | 2874 | if self._use_cache: |
2875 | self._cache[pagenum] = page_results | |
2876 | return page_results | |
2877 | ||
2878 | def getslice(self, start=0, end=None): | |
2879 | return list(self._getslice(start, end)) | |
2880 | ||
2881 | def _getslice(self, start, end): | |
55575225 | 2882 | raise NotImplementedError('This method must be implemented by subclasses') |
2883 | ||
2884 | def __getitem__(self, idx): | |
f1d13090 | 2885 | assert self._use_cache, 'Indexing PagedList requires cache' |
55575225 | 2886 | if not isinstance(idx, int) or idx < 0: |
2887 | raise TypeError('indices must be non-negative integers') | |
2888 | entries = self.getslice(idx, idx + 1) | |
d8cf8d97 | 2889 | if not entries: |
c07a39ae | 2890 | raise self.IndexError() |
d8cf8d97 | 2891 | return entries[0] |
55575225 | 2892 | |
9c44d242 PH |
2893 | |
2894 | class OnDemandPagedList(PagedList): | |
a44ca5a4 | 2895 | """Download pages until a page with less than maximum results""" |
86e5f3ed | 2896 | |
7be9ccff | 2897 | def _getslice(self, start, end): |
b7ab0590 PH |
2898 | for pagenum in itertools.count(start // self._pagesize): |
2899 | firstid = pagenum * self._pagesize | |
2900 | nextfirstid = pagenum * self._pagesize + self._pagesize | |
2901 | if start >= nextfirstid: | |
2902 | continue | |
2903 | ||
b7ab0590 PH |
2904 | startv = ( |
2905 | start % self._pagesize | |
2906 | if firstid <= start < nextfirstid | |
2907 | else 0) | |
b7ab0590 PH |
2908 | endv = ( |
2909 | ((end - 1) % self._pagesize) + 1 | |
2910 | if (end is not None and firstid <= end <= nextfirstid) | |
2911 | else None) | |
2912 | ||
f1d13090 | 2913 | try: |
2914 | page_results = self.getpage(pagenum) | |
2915 | except Exception: | |
2916 | self._pagecount = pagenum - 1 | |
2917 | raise | |
b7ab0590 PH |
2918 | if startv != 0 or endv is not None: |
2919 | page_results = page_results[startv:endv] | |
7be9ccff | 2920 | yield from page_results |
b7ab0590 PH |
2921 | |
2922 | # A little optimization - if current page is not "full", ie. does | |
2923 | # not contain page_size videos then we can assume that this page | |
2924 | # is the last one - there are no more ids on further pages - | |
2925 | # i.e. no need to query again. | |
2926 | if len(page_results) + startv < self._pagesize: | |
2927 | break | |
2928 | ||
2929 | # If we got the whole page, but the next page is not interesting, | |
2930 | # break out early as well | |
2931 | if end == nextfirstid: | |
2932 | break | |
81c2f20b PH |
2933 | |
2934 | ||
9c44d242 | 2935 | class InAdvancePagedList(PagedList): |
a44ca5a4 | 2936 | """PagedList with total number of pages known in advance""" |
86e5f3ed | 2937 | |
9c44d242 | 2938 | def __init__(self, pagefunc, pagecount, pagesize): |
7be9ccff | 2939 | PagedList.__init__(self, pagefunc, pagesize, True) |
f1d13090 | 2940 | self._pagecount = pagecount |
9c44d242 | 2941 | |
7be9ccff | 2942 | def _getslice(self, start, end): |
9c44d242 | 2943 | start_page = start // self._pagesize |
d37707bd | 2944 | end_page = self._pagecount if end is None else min(self._pagecount, end // self._pagesize + 1) |
9c44d242 PH |
2945 | skip_elems = start - start_page * self._pagesize |
2946 | only_more = None if end is None else end - start | |
2947 | for pagenum in range(start_page, end_page): | |
7be9ccff | 2948 | page_results = self.getpage(pagenum) |
9c44d242 | 2949 | if skip_elems: |
7be9ccff | 2950 | page_results = page_results[skip_elems:] |
9c44d242 PH |
2951 | skip_elems = None |
2952 | if only_more is not None: | |
7be9ccff | 2953 | if len(page_results) < only_more: |
2954 | only_more -= len(page_results) | |
9c44d242 | 2955 | else: |
7be9ccff | 2956 | yield from page_results[:only_more] |
9c44d242 | 2957 | break |
7be9ccff | 2958 | yield from page_results |
9c44d242 PH |
2959 | |
2960 | ||
7e88d7d7 | 2961 | class PlaylistEntries: |
2962 | MissingEntry = object() | |
2963 | is_exhausted = False | |
2964 | ||
2965 | def __init__(self, ydl, info_dict): | |
7e9a6125 | 2966 | self.ydl = ydl |
2967 | ||
2968 | # _entries must be assigned now since infodict can change during iteration | |
2969 | entries = info_dict.get('entries') | |
2970 | if entries is None: | |
2971 | raise EntryNotInPlaylist('There are no entries') | |
2972 | elif isinstance(entries, list): | |
2973 | self.is_exhausted = True | |
2974 | ||
2975 | requested_entries = info_dict.get('requested_entries') | |
bc5c2f8a | 2976 | self.is_incomplete = requested_entries is not None |
7e9a6125 | 2977 | if self.is_incomplete: |
2978 | assert self.is_exhausted | |
bc5c2f8a | 2979 | self._entries = [self.MissingEntry] * max(requested_entries or [0]) |
7e9a6125 | 2980 | for i, entry in zip(requested_entries, entries): |
2981 | self._entries[i - 1] = entry | |
2982 | elif isinstance(entries, (list, PagedList, LazyList)): | |
2983 | self._entries = entries | |
2984 | else: | |
2985 | self._entries = LazyList(entries) | |
7e88d7d7 | 2986 | |
2987 | PLAYLIST_ITEMS_RE = re.compile(r'''(?x) | |
2988 | (?P<start>[+-]?\d+)? | |
2989 | (?P<range>[:-] | |
2990 | (?P<end>[+-]?\d+|inf(?:inite)?)? | |
2991 | (?::(?P<step>[+-]?\d+))? | |
2992 | )?''') | |
2993 | ||
2994 | @classmethod | |
2995 | def parse_playlist_items(cls, string): | |
2996 | for segment in string.split(','): | |
2997 | if not segment: | |
2998 | raise ValueError('There is two or more consecutive commas') | |
2999 | mobj = cls.PLAYLIST_ITEMS_RE.fullmatch(segment) | |
3000 | if not mobj: | |
3001 | raise ValueError(f'{segment!r} is not a valid specification') | |
3002 | start, end, step, has_range = mobj.group('start', 'end', 'step', 'range') | |
3003 | if int_or_none(step) == 0: | |
3004 | raise ValueError(f'Step in {segment!r} cannot be zero') | |
3005 | yield slice(int_or_none(start), float_or_none(end), int_or_none(step)) if has_range else int(start) | |
3006 | ||
3007 | def get_requested_items(self): | |
3008 | playlist_items = self.ydl.params.get('playlist_items') | |
3009 | playlist_start = self.ydl.params.get('playliststart', 1) | |
3010 | playlist_end = self.ydl.params.get('playlistend') | |
3011 | # For backwards compatibility, interpret -1 as whole list | |
3012 | if playlist_end in (-1, None): | |
3013 | playlist_end = '' | |
3014 | if not playlist_items: | |
3015 | playlist_items = f'{playlist_start}:{playlist_end}' | |
3016 | elif playlist_start != 1 or playlist_end: | |
3017 | self.ydl.report_warning('Ignoring playliststart and playlistend because playlistitems was given', only_once=True) | |
3018 | ||
3019 | for index in self.parse_playlist_items(playlist_items): | |
3020 | for i, entry in self[index]: | |
3021 | yield i, entry | |
1ac4fd80 | 3022 | if not entry: |
3023 | continue | |
7e88d7d7 | 3024 | try: |
3025 | # TODO: Add auto-generated fields | |
3026 | self.ydl._match_entry(entry, incomplete=True, silent=True) | |
3027 | except (ExistingVideoReached, RejectedVideoReached): | |
3028 | return | |
3029 | ||
7e9a6125 | 3030 | def get_full_count(self): |
3031 | if self.is_exhausted and not self.is_incomplete: | |
7e88d7d7 | 3032 | return len(self) |
3033 | elif isinstance(self._entries, InAdvancePagedList): | |
3034 | if self._entries._pagesize == 1: | |
3035 | return self._entries._pagecount | |
3036 | ||
7e88d7d7 | 3037 | @functools.cached_property |
3038 | def _getter(self): | |
3039 | if isinstance(self._entries, list): | |
3040 | def get_entry(i): | |
3041 | try: | |
3042 | entry = self._entries[i] | |
3043 | except IndexError: | |
3044 | entry = self.MissingEntry | |
3045 | if not self.is_incomplete: | |
3046 | raise self.IndexError() | |
3047 | if entry is self.MissingEntry: | |
bc5c2f8a | 3048 | raise EntryNotInPlaylist(f'Entry {i + 1} cannot be found') |
7e88d7d7 | 3049 | return entry |
3050 | else: | |
3051 | def get_entry(i): | |
3052 | try: | |
3053 | return type(self.ydl)._handle_extraction_exceptions(lambda _, i: self._entries[i])(self.ydl, i) | |
3054 | except (LazyList.IndexError, PagedList.IndexError): | |
3055 | raise self.IndexError() | |
3056 | return get_entry | |
3057 | ||
3058 | def __getitem__(self, idx): | |
3059 | if isinstance(idx, int): | |
3060 | idx = slice(idx, idx) | |
3061 | ||
3062 | # NB: PlaylistEntries[1:10] => (0, 1, ... 9) | |
3063 | step = 1 if idx.step is None else idx.step | |
3064 | if idx.start is None: | |
3065 | start = 0 if step > 0 else len(self) - 1 | |
3066 | else: | |
3067 | start = idx.start - 1 if idx.start >= 0 else len(self) + idx.start | |
3068 | ||
3069 | # NB: Do not call len(self) when idx == [:] | |
3070 | if idx.stop is None: | |
3071 | stop = 0 if step < 0 else float('inf') | |
3072 | else: | |
3073 | stop = idx.stop - 1 if idx.stop >= 0 else len(self) + idx.stop | |
3074 | stop += [-1, 1][step > 0] | |
3075 | ||
3076 | for i in frange(start, stop, step): | |
3077 | if i < 0: | |
3078 | continue | |
3079 | try: | |
7e9a6125 | 3080 | entry = self._getter(i) |
3081 | except self.IndexError: | |
3082 | self.is_exhausted = True | |
3083 | if step > 0: | |
7e88d7d7 | 3084 | break |
7e9a6125 | 3085 | continue |
7e88d7d7 | 3086 | yield i + 1, entry |
3087 | ||
3088 | def __len__(self): | |
3089 | return len(tuple(self[:])) | |
3090 | ||
3091 | class IndexError(IndexError): | |
3092 | pass | |
3093 | ||
3094 | ||
81c2f20b | 3095 | def uppercase_escape(s): |
676eb3f2 | 3096 | unicode_escape = codecs.getdecoder('unicode_escape') |
81c2f20b | 3097 | return re.sub( |
a612753d | 3098 | r'\\U[0-9a-fA-F]{8}', |
676eb3f2 PH |
3099 | lambda m: unicode_escape(m.group(0))[0], |
3100 | s) | |
0fe2ff78 YCH |
3101 | |
3102 | ||
3103 | def lowercase_escape(s): | |
3104 | unicode_escape = codecs.getdecoder('unicode_escape') | |
3105 | return re.sub( | |
3106 | r'\\u[0-9a-fA-F]{4}', | |
3107 | lambda m: unicode_escape(m.group(0))[0], | |
3108 | s) | |
b53466e1 | 3109 | |
d05cfe06 S |
3110 | |
3111 | def escape_rfc3986(s): | |
3112 | """Escape non-ASCII characters as suggested by RFC 3986""" | |
f9934b96 | 3113 | return urllib.parse.quote(s, b"%/;:@&=+$,!~*'()?#[]") |
d05cfe06 S |
3114 | |
3115 | ||
3116 | def escape_url(url): | |
3117 | """Escape URL as suggested by RFC 3986""" | |
14f25df2 | 3118 | url_parsed = urllib.parse.urlparse(url) |
d05cfe06 | 3119 | return url_parsed._replace( |
efbed08d | 3120 | netloc=url_parsed.netloc.encode('idna').decode('ascii'), |
d05cfe06 S |
3121 | path=escape_rfc3986(url_parsed.path), |
3122 | params=escape_rfc3986(url_parsed.params), | |
3123 | query=escape_rfc3986(url_parsed.query), | |
3124 | fragment=escape_rfc3986(url_parsed.fragment) | |
3125 | ).geturl() | |
3126 | ||
62e609ab | 3127 | |
96b9e9cf | 3128 | def parse_qs(url, **kwargs): |
3129 | return urllib.parse.parse_qs(urllib.parse.urlparse(url).query, **kwargs) | |
4dfbf869 | 3130 | |
3131 | ||
62e609ab PH |
3132 | def read_batch_urls(batch_fd): |
3133 | def fixup(url): | |
14f25df2 | 3134 | if not isinstance(url, str): |
62e609ab | 3135 | url = url.decode('utf-8', 'replace') |
8c04f0be | 3136 | BOM_UTF8 = ('\xef\xbb\xbf', '\ufeff') |
3137 | for bom in BOM_UTF8: | |
3138 | if url.startswith(bom): | |
3139 | url = url[len(bom):] | |
3140 | url = url.lstrip() | |
3141 | if not url or url.startswith(('#', ';', ']')): | |
62e609ab | 3142 | return False |
8c04f0be | 3143 | # "#" cannot be stripped out since it is part of the URI |
962ffcf8 | 3144 | # However, it can be safely stripped out if following a whitespace |
8c04f0be | 3145 | return re.split(r'\s#', url, 1)[0].rstrip() |
62e609ab PH |
3146 | |
3147 | with contextlib.closing(batch_fd) as fd: | |
3148 | return [url for url in map(fixup, fd) if url] | |
b74fa8cd JMF |
3149 | |
3150 | ||
3151 | def urlencode_postdata(*args, **kargs): | |
14f25df2 | 3152 | return urllib.parse.urlencode(*args, **kargs).encode('ascii') |
bcf89ce6 PH |
3153 | |
3154 | ||
38f9ef31 | 3155 | def update_url_query(url, query): |
cacd9966 YCH |
3156 | if not query: |
3157 | return url | |
14f25df2 | 3158 | parsed_url = urllib.parse.urlparse(url) |
3159 | qs = urllib.parse.parse_qs(parsed_url.query) | |
38f9ef31 | 3160 | qs.update(query) |
14f25df2 | 3161 | return urllib.parse.urlunparse(parsed_url._replace( |
3162 | query=urllib.parse.urlencode(qs, True))) | |
16392824 | 3163 | |
8e60dc75 | 3164 | |
c043c246 | 3165 | def update_Request(req, url=None, data=None, headers=None, query=None): |
ed0291d1 | 3166 | req_headers = req.headers.copy() |
c043c246 | 3167 | req_headers.update(headers or {}) |
ed0291d1 S |
3168 | req_data = data or req.data |
3169 | req_url = update_url_query(url or req.get_full_url(), query) | |
95cf60e8 S |
3170 | req_get_method = req.get_method() |
3171 | if req_get_method == 'HEAD': | |
3172 | req_type = HEADRequest | |
3173 | elif req_get_method == 'PUT': | |
3174 | req_type = PUTRequest | |
3175 | else: | |
ac668111 | 3176 | req_type = urllib.request.Request |
ed0291d1 S |
3177 | new_req = req_type( |
3178 | req_url, data=req_data, headers=req_headers, | |
3179 | origin_req_host=req.origin_req_host, unverifiable=req.unverifiable) | |
3180 | if hasattr(req, 'timeout'): | |
3181 | new_req.timeout = req.timeout | |
3182 | return new_req | |
3183 | ||
3184 | ||
10c87c15 | 3185 | def _multipart_encode_impl(data, boundary): |
0c265486 YCH |
3186 | content_type = 'multipart/form-data; boundary=%s' % boundary |
3187 | ||
3188 | out = b'' | |
3189 | for k, v in data.items(): | |
3190 | out += b'--' + boundary.encode('ascii') + b'\r\n' | |
14f25df2 | 3191 | if isinstance(k, str): |
0f06bcd7 | 3192 | k = k.encode() |
14f25df2 | 3193 | if isinstance(v, str): |
0f06bcd7 | 3194 | v = v.encode() |
0c265486 YCH |
3195 | # RFC 2047 requires non-ASCII field names to be encoded, while RFC 7578 |
3196 | # suggests sending UTF-8 directly. Firefox sends UTF-8, too | |
b2ad479d | 3197 | content = b'Content-Disposition: form-data; name="' + k + b'"\r\n\r\n' + v + b'\r\n' |
0c265486 YCH |
3198 | if boundary.encode('ascii') in content: |
3199 | raise ValueError('Boundary overlaps with data') | |
3200 | out += content | |
3201 | ||
3202 | out += b'--' + boundary.encode('ascii') + b'--\r\n' | |
3203 | ||
3204 | return out, content_type | |
3205 | ||
3206 | ||
3207 | def multipart_encode(data, boundary=None): | |
3208 | ''' | |
3209 | Encode a dict to RFC 7578-compliant form-data | |
3210 | ||
3211 | data: | |
3212 | A dict where keys and values can be either Unicode or bytes-like | |
3213 | objects. | |
3214 | boundary: | |
3215 | If specified a Unicode object, it's used as the boundary. Otherwise | |
3216 | a random boundary is generated. | |
3217 | ||
3218 | Reference: https://tools.ietf.org/html/rfc7578 | |
3219 | ''' | |
3220 | has_specified_boundary = boundary is not None | |
3221 | ||
3222 | while True: | |
3223 | if boundary is None: | |
3224 | boundary = '---------------' + str(random.randrange(0x0fffffff, 0xffffffff)) | |
3225 | ||
3226 | try: | |
10c87c15 | 3227 | out, content_type = _multipart_encode_impl(data, boundary) |
0c265486 YCH |
3228 | break |
3229 | except ValueError: | |
3230 | if has_specified_boundary: | |
3231 | raise | |
3232 | boundary = None | |
3233 | ||
3234 | return out, content_type | |
3235 | ||
3236 | ||
304ad45a | 3237 | def variadic(x, allowed_types=(str, bytes, dict)): |
3238 | return x if isinstance(x, collections.abc.Iterable) and not isinstance(x, allowed_types) else (x,) | |
3239 | ||
3240 | ||
86296ad2 | 3241 | def dict_get(d, key_or_keys, default=None, skip_false_values=True): |
a44ca5a4 | 3242 | for val in map(d.get, variadic(key_or_keys)): |
3243 | if val is not None and (val or not skip_false_values): | |
3244 | return val | |
3245 | return default | |
cbecc9b9 S |
3246 | |
3247 | ||
c4f60dd7 | 3248 | def try_call(*funcs, expected_type=None, args=[], kwargs={}): |
3249 | for f in funcs: | |
a32a9a7e | 3250 | try: |
c4f60dd7 | 3251 | val = f(*args, **kwargs) |
ab029d7e | 3252 | except (AttributeError, KeyError, TypeError, IndexError, ValueError, ZeroDivisionError): |
a32a9a7e S |
3253 | pass |
3254 | else: | |
c4f60dd7 | 3255 | if expected_type is None or isinstance(val, expected_type): |
3256 | return val | |
3257 | ||
3258 | ||
3259 | def try_get(src, getter, expected_type=None): | |
3260 | return try_call(*variadic(getter), args=(src,), expected_type=expected_type) | |
329ca3be S |
3261 | |
3262 | ||
90137ca4 | 3263 | def filter_dict(dct, cndn=lambda _, v: v is not None): |
3264 | return {k: v for k, v in dct.items() if cndn(k, v)} | |
3265 | ||
3266 | ||
6cc62232 S |
3267 | def merge_dicts(*dicts): |
3268 | merged = {} | |
3269 | for a_dict in dicts: | |
3270 | for k, v in a_dict.items(): | |
90137ca4 | 3271 | if (v is not None and k not in merged |
3272 | or isinstance(v, str) and merged[k] == ''): | |
6cc62232 S |
3273 | merged[k] = v |
3274 | return merged | |
3275 | ||
3276 | ||
8e60dc75 | 3277 | def encode_compat_str(string, encoding=preferredencoding(), errors='strict'): |
14f25df2 | 3278 | return string if isinstance(string, str) else str(string, encoding, errors) |
8e60dc75 | 3279 | |
16392824 | 3280 | |
a1a530b0 PH |
3281 | US_RATINGS = { |
3282 | 'G': 0, | |
3283 | 'PG': 10, | |
3284 | 'PG-13': 13, | |
3285 | 'R': 16, | |
3286 | 'NC': 18, | |
3287 | } | |
fac55558 PH |
3288 | |
3289 | ||
a8795327 | 3290 | TV_PARENTAL_GUIDELINES = { |
5a16c9d9 RA |
3291 | 'TV-Y': 0, |
3292 | 'TV-Y7': 7, | |
3293 | 'TV-G': 0, | |
3294 | 'TV-PG': 0, | |
3295 | 'TV-14': 14, | |
3296 | 'TV-MA': 17, | |
a8795327 S |
3297 | } |
3298 | ||
3299 | ||
146c80e2 | 3300 | def parse_age_limit(s): |
19a03940 | 3301 | # isinstance(False, int) is True. So type() must be used instead |
c487cf00 | 3302 | if type(s) is int: # noqa: E721 |
a8795327 | 3303 | return s if 0 <= s <= 21 else None |
19a03940 | 3304 | elif not isinstance(s, str): |
d838b1bd | 3305 | return None |
146c80e2 | 3306 | m = re.match(r'^(?P<age>\d{1,2})\+?$', s) |
a8795327 S |
3307 | if m: |
3308 | return int(m.group('age')) | |
5c5fae6d | 3309 | s = s.upper() |
a8795327 S |
3310 | if s in US_RATINGS: |
3311 | return US_RATINGS[s] | |
5a16c9d9 | 3312 | m = re.match(r'^TV[_-]?(%s)$' % '|'.join(k[3:] for k in TV_PARENTAL_GUIDELINES), s) |
b8361187 | 3313 | if m: |
5a16c9d9 | 3314 | return TV_PARENTAL_GUIDELINES['TV-' + m.group(1)] |
b8361187 | 3315 | return None |
146c80e2 S |
3316 | |
3317 | ||
fac55558 | 3318 | def strip_jsonp(code): |
609a61e3 | 3319 | return re.sub( |
5552c9eb | 3320 | r'''(?sx)^ |
e9c671d5 | 3321 | (?:window\.)?(?P<func_name>[a-zA-Z0-9_.$]*) |
5552c9eb YCH |
3322 | (?:\s*&&\s*(?P=func_name))? |
3323 | \s*\(\s*(?P<callback_data>.*)\);? | |
3324 | \s*?(?://[^\n]*)*$''', | |
3325 | r'\g<callback_data>', code) | |
478c2c61 PH |
3326 | |
3327 | ||
8f53dc44 | 3328 | def js_to_json(code, vars={}, *, strict=False): |
5c610515 | 3329 | # vars is a dict of var, val pairs to substitute |
a71b812f SS |
3330 | STRING_QUOTES = '\'"' |
3331 | STRING_RE = '|'.join(rf'{q}(?:\\.|[^\\{q}])*{q}' for q in STRING_QUOTES) | |
c843e685 | 3332 | COMMENT_RE = r'/\*(?:(?!\*/).)*?\*/|//[^\n]*\n' |
86e5f3ed | 3333 | SKIP_RE = fr'\s*(?:{COMMENT_RE})?\s*' |
4195096e | 3334 | INTEGER_TABLE = ( |
86e5f3ed | 3335 | (fr'(?s)^(0[xX][0-9a-fA-F]+){SKIP_RE}:?$', 16), |
3336 | (fr'(?s)^(0+[0-7]+){SKIP_RE}:?$', 8), | |
4195096e S |
3337 | ) |
3338 | ||
a71b812f SS |
3339 | def process_escape(match): |
3340 | JSON_PASSTHROUGH_ESCAPES = R'"\bfnrtu' | |
3341 | escape = match.group(1) or match.group(2) | |
3342 | ||
3343 | return (Rf'\{escape}' if escape in JSON_PASSTHROUGH_ESCAPES | |
3344 | else R'\u00' if escape == 'x' | |
3345 | else '' if escape == '\n' | |
3346 | else escape) | |
3347 | ||
e05f6939 | 3348 | def fix_kv(m): |
e7b6d122 PH |
3349 | v = m.group(0) |
3350 | if v in ('true', 'false', 'null'): | |
3351 | return v | |
421ddcb8 C |
3352 | elif v in ('undefined', 'void 0'): |
3353 | return 'null' | |
8bdd16b4 | 3354 | elif v.startswith('/*') or v.startswith('//') or v.startswith('!') or v == ',': |
a71b812f SS |
3355 | return '' |
3356 | ||
3357 | if v[0] in STRING_QUOTES: | |
3358 | escaped = re.sub(r'(?s)(")|\\(.)', process_escape, v[1:-1]) | |
3359 | return f'"{escaped}"' | |
3360 | ||
3361 | for regex, base in INTEGER_TABLE: | |
3362 | im = re.match(regex, v) | |
3363 | if im: | |
3364 | i = int(im.group(1), base) | |
3365 | return f'"{i}":' if v.endswith(':') else str(i) | |
3366 | ||
3367 | if v in vars: | |
d5f043d1 C |
3368 | try: |
3369 | if not strict: | |
3370 | json.loads(vars[v]) | |
08e29b9f | 3371 | except json.JSONDecodeError: |
d5f043d1 C |
3372 | return json.dumps(vars[v]) |
3373 | else: | |
3374 | return vars[v] | |
89ac4a19 | 3375 | |
a71b812f SS |
3376 | if not strict: |
3377 | return f'"{v}"' | |
5c610515 | 3378 | |
a71b812f | 3379 | raise ValueError(f'Unknown value: {v}') |
e05f6939 | 3380 | |
8072ef2b | 3381 | def create_map(mobj): |
3382 | return json.dumps(dict(json.loads(js_to_json(mobj.group(1) or '[]', vars=vars)))) | |
3383 | ||
8072ef2b | 3384 | code = re.sub(r'new Map\((\[.*?\])?\)', create_map, code) |
8f53dc44 | 3385 | if not strict: |
3386 | code = re.sub(r'new Date\((".+")\)', r'\g<1>', code) | |
f55523cf | 3387 | code = re.sub(r'new \w+\((.*?)\)', lambda m: json.dumps(m.group(0)), code) |
febff4c1 | 3388 | |
a71b812f SS |
3389 | return re.sub(rf'''(?sx) |
3390 | {STRING_RE}| | |
3391 | {COMMENT_RE}|,(?={SKIP_RE}[\]}}])| | |
421ddcb8 | 3392 | void\s0|(?:(?<![0-9])[eE]|[a-df-zA-DF-Z_$])[.a-zA-Z_$0-9]*| |
a71b812f SS |
3393 | \b(?:0[xX][0-9a-fA-F]+|0+[0-7]+)(?:{SKIP_RE}:)?| |
3394 | [0-9]+(?={SKIP_RE}:)| | |
8bdd16b4 | 3395 | !+ |
a71b812f | 3396 | ''', fix_kv, code) |
e05f6939 PH |
3397 | |
3398 | ||
478c2c61 PH |
3399 | def qualities(quality_ids): |
3400 | """ Get a numeric quality value out of a list of possible values """ | |
3401 | def q(qid): | |
3402 | try: | |
3403 | return quality_ids.index(qid) | |
3404 | except ValueError: | |
3405 | return -1 | |
3406 | return q | |
3407 | ||
acd69589 | 3408 | |
119e40ef | 3409 | POSTPROCESS_WHEN = ('pre_process', 'after_filter', 'video', 'before_dl', 'post_process', 'after_move', 'after_video', 'playlist') |
1e43a6f7 | 3410 | |
3411 | ||
de6000d9 | 3412 | DEFAULT_OUTTMPL = { |
3413 | 'default': '%(title)s [%(id)s].%(ext)s', | |
72755351 | 3414 | 'chapter': '%(title)s - %(section_number)03d %(section_title)s [%(id)s].%(ext)s', |
de6000d9 | 3415 | } |
3416 | OUTTMPL_TYPES = { | |
72755351 | 3417 | 'chapter': None, |
de6000d9 | 3418 | 'subtitle': None, |
3419 | 'thumbnail': None, | |
3420 | 'description': 'description', | |
3421 | 'annotation': 'annotations.xml', | |
3422 | 'infojson': 'info.json', | |
08438d2c | 3423 | 'link': None, |
3b603dbd | 3424 | 'pl_video': None, |
5112f26a | 3425 | 'pl_thumbnail': None, |
de6000d9 | 3426 | 'pl_description': 'description', |
3427 | 'pl_infojson': 'info.json', | |
3428 | } | |
0a871f68 | 3429 | |
143db31d | 3430 | # As of [1] format syntax is: |
3431 | # %[mapping_key][conversion_flags][minimum_width][.precision][length_modifier]type | |
3432 | # 1. https://docs.python.org/2/library/stdtypes.html#string-formatting | |
901130bb | 3433 | STR_FORMAT_RE_TMPL = r'''(?x) |
3434 | (?<!%)(?P<prefix>(?:%%)*) | |
143db31d | 3435 | % |
524e2e4f | 3436 | (?P<has_key>\((?P<key>{0})\))? |
752cda38 | 3437 | (?P<format> |
524e2e4f | 3438 | (?P<conversion>[#0\-+ ]+)? |
3439 | (?P<min_width>\d+)? | |
3440 | (?P<precision>\.\d+)? | |
3441 | (?P<len_mod>[hlL])? # unused in python | |
901130bb | 3442 | {1} # conversion type |
752cda38 | 3443 | ) |
143db31d | 3444 | ''' |
3445 | ||
7d1eb38a | 3446 | |
901130bb | 3447 | STR_FORMAT_TYPES = 'diouxXeEfFgGcrs' |
a020a0dc | 3448 | |
7d1eb38a | 3449 | |
a020a0dc PH |
3450 | def limit_length(s, length): |
3451 | """ Add ellipses to overly long strings """ | |
3452 | if s is None: | |
3453 | return None | |
3454 | ELLIPSES = '...' | |
3455 | if len(s) > length: | |
3456 | return s[:length - len(ELLIPSES)] + ELLIPSES | |
3457 | return s | |
48844745 PH |
3458 | |
3459 | ||
3460 | def version_tuple(v): | |
5f9b8394 | 3461 | return tuple(int(e) for e in re.split(r'[-.]', v)) |
48844745 PH |
3462 | |
3463 | ||
3464 | def is_outdated_version(version, limit, assume_new=True): | |
3465 | if not version: | |
3466 | return not assume_new | |
3467 | try: | |
3468 | return version_tuple(version) < version_tuple(limit) | |
3469 | except ValueError: | |
3470 | return not assume_new | |
732ea2f0 PH |
3471 | |
3472 | ||
3473 | def ytdl_is_updateable(): | |
7a5c1cfe | 3474 | """ Returns if yt-dlp can be updated with -U """ |
735d865e | 3475 | |
5d535b4a | 3476 | from .update import is_non_updateable |
732ea2f0 | 3477 | |
5d535b4a | 3478 | return not is_non_updateable() |
7d4111ed PH |
3479 | |
3480 | ||
3481 | def args_to_str(args): | |
3482 | # Get a short string representation for a subprocess command | |
702ccf2d | 3483 | return ' '.join(compat_shlex_quote(a) for a in args) |
2ccd1b10 PH |
3484 | |
3485 | ||
9b9c5355 | 3486 | def error_to_compat_str(err): |
cfb0511d | 3487 | return str(err) |
fdae2358 S |
3488 | |
3489 | ||
a44ca5a4 | 3490 | def error_to_str(err): |
3491 | return f'{type(err).__name__}: {err}' | |
3492 | ||
3493 | ||
2647c933 | 3494 | def mimetype2ext(mt, default=NO_DEFAULT): |
3495 | if not isinstance(mt, str): | |
3496 | if default is not NO_DEFAULT: | |
3497 | return default | |
eb9ee194 S |
3498 | return None |
3499 | ||
2647c933 | 3500 | MAP = { |
3501 | # video | |
f6861ec9 | 3502 | '3gpp': '3gp', |
2647c933 | 3503 | 'mp2t': 'ts', |
3504 | 'mp4': 'mp4', | |
3505 | 'mpeg': 'mpeg', | |
3506 | 'mpegurl': 'm3u8', | |
3507 | 'quicktime': 'mov', | |
3508 | 'webm': 'webm', | |
3509 | 'vp9': 'vp9', | |
f6861ec9 | 3510 | 'x-flv': 'flv', |
2647c933 | 3511 | 'x-m4v': 'm4v', |
3512 | 'x-matroska': 'mkv', | |
3513 | 'x-mng': 'mng', | |
a0d8d704 | 3514 | 'x-mp4-fragmented': 'mp4', |
2647c933 | 3515 | 'x-ms-asf': 'asf', |
a0d8d704 | 3516 | 'x-ms-wmv': 'wmv', |
2647c933 | 3517 | 'x-msvideo': 'avi', |
3518 | ||
3519 | # application (streaming playlists) | |
b4173f15 | 3520 | 'dash+xml': 'mpd', |
b4173f15 | 3521 | 'f4m+xml': 'f4m', |
f164b971 | 3522 | 'hds+xml': 'f4m', |
2647c933 | 3523 | 'vnd.apple.mpegurl': 'm3u8', |
e910fe2f | 3524 | 'vnd.ms-sstr+xml': 'ism', |
2647c933 | 3525 | 'x-mpegurl': 'm3u8', |
3526 | ||
3527 | # audio | |
3528 | 'audio/mp4': 'm4a', | |
3529 | # Per RFC 3003, audio/mpeg can be .mp1, .mp2 or .mp3. | |
3530 | # Using .mp3 as it's the most popular one | |
3531 | 'audio/mpeg': 'mp3', | |
d80ca5de | 3532 | 'audio/webm': 'webm', |
2647c933 | 3533 | 'audio/x-matroska': 'mka', |
3534 | 'audio/x-mpegurl': 'm3u', | |
3535 | 'midi': 'mid', | |
3536 | 'ogg': 'ogg', | |
3537 | 'wav': 'wav', | |
3538 | 'wave': 'wav', | |
3539 | 'x-aac': 'aac', | |
3540 | 'x-flac': 'flac', | |
3541 | 'x-m4a': 'm4a', | |
3542 | 'x-realaudio': 'ra', | |
39e7107d | 3543 | 'x-wav': 'wav', |
9359f3d4 | 3544 | |
2647c933 | 3545 | # image |
3546 | 'avif': 'avif', | |
3547 | 'bmp': 'bmp', | |
3548 | 'gif': 'gif', | |
3549 | 'jpeg': 'jpg', | |
3550 | 'png': 'png', | |
3551 | 'svg+xml': 'svg', | |
3552 | 'tiff': 'tif', | |
3553 | 'vnd.wap.wbmp': 'wbmp', | |
3554 | 'webp': 'webp', | |
3555 | 'x-icon': 'ico', | |
3556 | 'x-jng': 'jng', | |
3557 | 'x-ms-bmp': 'bmp', | |
3558 | ||
3559 | # caption | |
3560 | 'filmstrip+json': 'fs', | |
3561 | 'smptett+xml': 'tt', | |
3562 | 'ttaf+xml': 'dfxp', | |
3563 | 'ttml+xml': 'ttml', | |
3564 | 'x-ms-sami': 'sami', | |
9359f3d4 | 3565 | |
2647c933 | 3566 | # misc |
3567 | 'gzip': 'gz', | |
9359f3d4 F |
3568 | 'json': 'json', |
3569 | 'xml': 'xml', | |
3570 | 'zip': 'zip', | |
9359f3d4 F |
3571 | } |
3572 | ||
2647c933 | 3573 | mimetype = mt.partition(';')[0].strip().lower() |
3574 | _, _, subtype = mimetype.rpartition('/') | |
9359f3d4 | 3575 | |
2647c933 | 3576 | ext = traverse_obj(MAP, mimetype, subtype, subtype.rsplit('+')[-1]) |
3577 | if ext: | |
3578 | return ext | |
3579 | elif default is not NO_DEFAULT: | |
3580 | return default | |
9359f3d4 | 3581 | return subtype.replace('+', '.') |
c460bdd5 PH |
3582 | |
3583 | ||
2814f12b THD |
3584 | def ext2mimetype(ext_or_url): |
3585 | if not ext_or_url: | |
3586 | return None | |
3587 | if '.' not in ext_or_url: | |
3588 | ext_or_url = f'file.{ext_or_url}' | |
3589 | return mimetypes.guess_type(ext_or_url)[0] | |
3590 | ||
3591 | ||
4f3c5e06 | 3592 | def parse_codecs(codecs_str): |
3593 | # http://tools.ietf.org/html/rfc6381 | |
3594 | if not codecs_str: | |
3595 | return {} | |
a0566bbf | 3596 | split_codecs = list(filter(None, map( |
dbf5416a | 3597 | str.strip, codecs_str.strip().strip(',').split(',')))) |
3fe75fdc | 3598 | vcodec, acodec, scodec, hdr = None, None, None, None |
a0566bbf | 3599 | for full_codec in split_codecs: |
d816f61f | 3600 | parts = re.sub(r'0+(?=\d)', '', full_codec).split('.') |
3601 | if parts[0] in ('avc1', 'avc2', 'avc3', 'avc4', 'vp9', 'vp8', 'hev1', 'hev2', | |
3602 | 'h263', 'h264', 'mp4v', 'hvc1', 'av1', 'theora', 'dvh1', 'dvhe'): | |
3603 | if vcodec: | |
3604 | continue | |
3605 | vcodec = full_codec | |
3606 | if parts[0] in ('dvh1', 'dvhe'): | |
3607 | hdr = 'DV' | |
3608 | elif parts[0] == 'av1' and traverse_obj(parts, 3) == '10': | |
3609 | hdr = 'HDR10' | |
3610 | elif parts[:2] == ['vp9', '2']: | |
3611 | hdr = 'HDR10' | |
71082216 | 3612 | elif parts[0] in ('flac', 'mp4a', 'opus', 'vorbis', 'mp3', 'aac', 'ac-4', |
d816f61f | 3613 | 'ac-3', 'ec-3', 'eac3', 'dtsc', 'dtse', 'dtsh', 'dtsl'): |
3614 | acodec = acodec or full_codec | |
3615 | elif parts[0] in ('stpp', 'wvtt'): | |
3616 | scodec = scodec or full_codec | |
4f3c5e06 | 3617 | else: |
19a03940 | 3618 | write_string(f'WARNING: Unknown codec {full_codec}\n') |
3fe75fdc | 3619 | if vcodec or acodec or scodec: |
4f3c5e06 | 3620 | return { |
3621 | 'vcodec': vcodec or 'none', | |
3622 | 'acodec': acodec or 'none', | |
176f1866 | 3623 | 'dynamic_range': hdr, |
3fe75fdc | 3624 | **({'scodec': scodec} if scodec is not None else {}), |
4f3c5e06 | 3625 | } |
b69fd25c | 3626 | elif len(split_codecs) == 2: |
3627 | return { | |
3628 | 'vcodec': split_codecs[0], | |
3629 | 'acodec': split_codecs[1], | |
3630 | } | |
4f3c5e06 | 3631 | return {} |
3632 | ||
3633 | ||
fc61aff4 LL |
3634 | def get_compatible_ext(*, vcodecs, acodecs, vexts, aexts, preferences=None): |
3635 | assert len(vcodecs) == len(vexts) and len(acodecs) == len(aexts) | |
3636 | ||
3637 | allow_mkv = not preferences or 'mkv' in preferences | |
3638 | ||
3639 | if allow_mkv and max(len(acodecs), len(vcodecs)) > 1: | |
3640 | return 'mkv' # TODO: any other format allows this? | |
3641 | ||
3642 | # TODO: All codecs supported by parse_codecs isn't handled here | |
3643 | COMPATIBLE_CODECS = { | |
3644 | 'mp4': { | |
71082216 | 3645 | 'av1', 'hevc', 'avc1', 'mp4a', 'ac-4', # fourcc (m3u8, mpd) |
81b6102d | 3646 | 'h264', 'aacl', 'ec-3', # Set in ISM |
fc61aff4 LL |
3647 | }, |
3648 | 'webm': { | |
3649 | 'av1', 'vp9', 'vp8', 'opus', 'vrbs', | |
3650 | 'vp9x', 'vp8x', # in the webm spec | |
3651 | }, | |
3652 | } | |
3653 | ||
8f84770a | 3654 | sanitize_codec = functools.partial(try_get, getter=lambda x: x[0].split('.')[0].replace('0', '')) |
3655 | vcodec, acodec = sanitize_codec(vcodecs), sanitize_codec(acodecs) | |
fc61aff4 LL |
3656 | |
3657 | for ext in preferences or COMPATIBLE_CODECS.keys(): | |
3658 | codec_set = COMPATIBLE_CODECS.get(ext, set()) | |
3659 | if ext == 'mkv' or codec_set.issuperset((vcodec, acodec)): | |
3660 | return ext | |
3661 | ||
3662 | COMPATIBLE_EXTS = ( | |
3663 | {'mp3', 'mp4', 'm4a', 'm4p', 'm4b', 'm4r', 'm4v', 'ismv', 'isma', 'mov'}, | |
fbb73833 | 3664 | {'webm', 'weba'}, |
fc61aff4 LL |
3665 | ) |
3666 | for ext in preferences or vexts: | |
3667 | current_exts = {ext, *vexts, *aexts} | |
3668 | if ext == 'mkv' or current_exts == {ext} or any( | |
3669 | ext_sets.issuperset(current_exts) for ext_sets in COMPATIBLE_EXTS): | |
3670 | return ext | |
3671 | return 'mkv' if allow_mkv else preferences[-1] | |
3672 | ||
3673 | ||
2647c933 | 3674 | def urlhandle_detect_ext(url_handle, default=NO_DEFAULT): |
79298173 | 3675 | getheader = url_handle.headers.get |
2ccd1b10 | 3676 | |
b55ee18f PH |
3677 | cd = getheader('Content-Disposition') |
3678 | if cd: | |
3679 | m = re.match(r'attachment;\s*filename="(?P<filename>[^"]+)"', cd) | |
3680 | if m: | |
3681 | e = determine_ext(m.group('filename'), default_ext=None) | |
3682 | if e: | |
3683 | return e | |
3684 | ||
2647c933 | 3685 | meta_ext = getheader('x-amz-meta-name') |
3686 | if meta_ext: | |
3687 | e = meta_ext.rpartition('.')[2] | |
3688 | if e: | |
3689 | return e | |
3690 | ||
3691 | return mimetype2ext(getheader('Content-Type'), default=default) | |
05900629 PH |
3692 | |
3693 | ||
1e399778 YCH |
3694 | def encode_data_uri(data, mime_type): |
3695 | return 'data:%s;base64,%s' % (mime_type, base64.b64encode(data).decode('ascii')) | |
3696 | ||
3697 | ||
05900629 | 3698 | def age_restricted(content_limit, age_limit): |
6ec6cb4e | 3699 | """ Returns True iff the content should be blocked """ |
05900629 PH |
3700 | |
3701 | if age_limit is None: # No limit set | |
3702 | return False | |
3703 | if content_limit is None: | |
3704 | return False # Content available for everyone | |
3705 | return age_limit < content_limit | |
61ca9a80 PH |
3706 | |
3707 | ||
88f60feb | 3708 | # List of known byte-order-marks (BOM) |
a904a7f8 L |
3709 | BOMS = [ |
3710 | (b'\xef\xbb\xbf', 'utf-8'), | |
3711 | (b'\x00\x00\xfe\xff', 'utf-32-be'), | |
3712 | (b'\xff\xfe\x00\x00', 'utf-32-le'), | |
3713 | (b'\xff\xfe', 'utf-16-le'), | |
3714 | (b'\xfe\xff', 'utf-16-be'), | |
3715 | ] | |
a904a7f8 L |
3716 | |
3717 | ||
61ca9a80 PH |
3718 | def is_html(first_bytes): |
3719 | """ Detect whether a file contains HTML by examining its first bytes. """ | |
3720 | ||
80e8493e | 3721 | encoding = 'utf-8' |
61ca9a80 | 3722 | for bom, enc in BOMS: |
80e8493e | 3723 | while first_bytes.startswith(bom): |
3724 | encoding, first_bytes = enc, first_bytes[len(bom):] | |
61ca9a80 | 3725 | |
80e8493e | 3726 | return re.match(r'^\s*<', first_bytes.decode(encoding, 'replace')) |
a055469f PH |
3727 | |
3728 | ||
3729 | def determine_protocol(info_dict): | |
3730 | protocol = info_dict.get('protocol') | |
3731 | if protocol is not None: | |
3732 | return protocol | |
3733 | ||
7de837a5 | 3734 | url = sanitize_url(info_dict['url']) |
a055469f PH |
3735 | if url.startswith('rtmp'): |
3736 | return 'rtmp' | |
3737 | elif url.startswith('mms'): | |
3738 | return 'mms' | |
3739 | elif url.startswith('rtsp'): | |
3740 | return 'rtsp' | |
3741 | ||
3742 | ext = determine_ext(url) | |
3743 | if ext == 'm3u8': | |
deae7c17 | 3744 | return 'm3u8' if info_dict.get('is_live') else 'm3u8_native' |
a055469f PH |
3745 | elif ext == 'f4m': |
3746 | return 'f4m' | |
3747 | ||
14f25df2 | 3748 | return urllib.parse.urlparse(url).scheme |
cfb56d1a PH |
3749 | |
3750 | ||
c5e3f849 | 3751 | def render_table(header_row, data, delim=False, extra_gap=0, hide_empty=False): |
3752 | """ Render a list of rows, each as a list of values. | |
3753 | Text after a \t will be right aligned """ | |
ec11a9f4 | 3754 | def width(string): |
c5e3f849 | 3755 | return len(remove_terminal_sequences(string).replace('\t', '')) |
76d321f6 | 3756 | |
3757 | def get_max_lens(table): | |
ec11a9f4 | 3758 | return [max(width(str(v)) for v in col) for col in zip(*table)] |
76d321f6 | 3759 | |
3760 | def filter_using_list(row, filterArray): | |
d16df59d | 3761 | return [col for take, col in itertools.zip_longest(filterArray, row, fillvalue=True) if take] |
76d321f6 | 3762 | |
d16df59d | 3763 | max_lens = get_max_lens(data) if hide_empty else [] |
3764 | header_row = filter_using_list(header_row, max_lens) | |
3765 | data = [filter_using_list(row, max_lens) for row in data] | |
76d321f6 | 3766 | |
cfb56d1a | 3767 | table = [header_row] + data |
76d321f6 | 3768 | max_lens = get_max_lens(table) |
c5e3f849 | 3769 | extra_gap += 1 |
76d321f6 | 3770 | if delim: |
c5e3f849 | 3771 | table = [header_row, [delim * (ml + extra_gap) for ml in max_lens]] + data |
1ed7953a | 3772 | table[1][-1] = table[1][-1][:-extra_gap * len(delim)] # Remove extra_gap from end of delimiter |
ec11a9f4 | 3773 | for row in table: |
3774 | for pos, text in enumerate(map(str, row)): | |
c5e3f849 | 3775 | if '\t' in text: |
3776 | row[pos] = text.replace('\t', ' ' * (max_lens[pos] - width(text))) + ' ' * extra_gap | |
3777 | else: | |
3778 | row[pos] = text + ' ' * (max_lens[pos] - width(text) + extra_gap) | |
3779 | ret = '\n'.join(''.join(row).rstrip() for row in table) | |
ec11a9f4 | 3780 | return ret |
347de493 PH |
3781 | |
3782 | ||
8f18aca8 | 3783 | def _match_one(filter_part, dct, incomplete): |
77b87f05 | 3784 | # TODO: Generalize code with YoutubeDL._build_format_filter |
a047eeb6 | 3785 | STRING_OPERATORS = { |
3786 | '*=': operator.contains, | |
3787 | '^=': lambda attr, value: attr.startswith(value), | |
3788 | '$=': lambda attr, value: attr.endswith(value), | |
3789 | '~=': lambda attr, value: re.search(value, attr), | |
3790 | } | |
347de493 | 3791 | COMPARISON_OPERATORS = { |
a047eeb6 | 3792 | **STRING_OPERATORS, |
3793 | '<=': operator.le, # "<=" must be defined above "<" | |
347de493 | 3794 | '<': operator.lt, |
347de493 | 3795 | '>=': operator.ge, |
a047eeb6 | 3796 | '>': operator.gt, |
347de493 | 3797 | '=': operator.eq, |
347de493 | 3798 | } |
a047eeb6 | 3799 | |
6db9c4d5 | 3800 | if isinstance(incomplete, bool): |
3801 | is_incomplete = lambda _: incomplete | |
3802 | else: | |
3803 | is_incomplete = lambda k: k in incomplete | |
3804 | ||
64fa820c | 3805 | operator_rex = re.compile(r'''(?x) |
347de493 | 3806 | (?P<key>[a-z_]+) |
77b87f05 | 3807 | \s*(?P<negation>!\s*)?(?P<op>%s)(?P<none_inclusive>\s*\?)?\s* |
347de493 | 3808 | (?: |
a047eeb6 | 3809 | (?P<quote>["\'])(?P<quotedstrval>.+?)(?P=quote)| |
3810 | (?P<strval>.+?) | |
347de493 | 3811 | ) |
347de493 | 3812 | ''' % '|'.join(map(re.escape, COMPARISON_OPERATORS.keys()))) |
64fa820c | 3813 | m = operator_rex.fullmatch(filter_part.strip()) |
347de493 | 3814 | if m: |
18f96d12 | 3815 | m = m.groupdict() |
3816 | unnegated_op = COMPARISON_OPERATORS[m['op']] | |
3817 | if m['negation']: | |
77b87f05 MT |
3818 | op = lambda attr, value: not unnegated_op(attr, value) |
3819 | else: | |
3820 | op = unnegated_op | |
18f96d12 | 3821 | comparison_value = m['quotedstrval'] or m['strval'] or m['intval'] |
3822 | if m['quote']: | |
3823 | comparison_value = comparison_value.replace(r'\%s' % m['quote'], m['quote']) | |
3824 | actual_value = dct.get(m['key']) | |
3825 | numeric_comparison = None | |
f9934b96 | 3826 | if isinstance(actual_value, (int, float)): |
e5a088dc S |
3827 | # If the original field is a string and matching comparisonvalue is |
3828 | # a number we should respect the origin of the original field | |
3829 | # and process comparison value as a string (see | |
18f96d12 | 3830 | # https://github.com/ytdl-org/youtube-dl/issues/11082) |
347de493 | 3831 | try: |
18f96d12 | 3832 | numeric_comparison = int(comparison_value) |
347de493 | 3833 | except ValueError: |
18f96d12 | 3834 | numeric_comparison = parse_filesize(comparison_value) |
3835 | if numeric_comparison is None: | |
3836 | numeric_comparison = parse_filesize(f'{comparison_value}B') | |
3837 | if numeric_comparison is None: | |
3838 | numeric_comparison = parse_duration(comparison_value) | |
3839 | if numeric_comparison is not None and m['op'] in STRING_OPERATORS: | |
3840 | raise ValueError('Operator %s only supports string values!' % m['op']) | |
347de493 | 3841 | if actual_value is None: |
6db9c4d5 | 3842 | return is_incomplete(m['key']) or m['none_inclusive'] |
18f96d12 | 3843 | return op(actual_value, comparison_value if numeric_comparison is None else numeric_comparison) |
347de493 PH |
3844 | |
3845 | UNARY_OPERATORS = { | |
1cc47c66 S |
3846 | '': lambda v: (v is True) if isinstance(v, bool) else (v is not None), |
3847 | '!': lambda v: (v is False) if isinstance(v, bool) else (v is None), | |
347de493 | 3848 | } |
64fa820c | 3849 | operator_rex = re.compile(r'''(?x) |
347de493 | 3850 | (?P<op>%s)\s*(?P<key>[a-z_]+) |
347de493 | 3851 | ''' % '|'.join(map(re.escape, UNARY_OPERATORS.keys()))) |
64fa820c | 3852 | m = operator_rex.fullmatch(filter_part.strip()) |
347de493 PH |
3853 | if m: |
3854 | op = UNARY_OPERATORS[m.group('op')] | |
3855 | actual_value = dct.get(m.group('key')) | |
6db9c4d5 | 3856 | if is_incomplete(m.group('key')) and actual_value is None: |
8f18aca8 | 3857 | return True |
347de493 PH |
3858 | return op(actual_value) |
3859 | ||
3860 | raise ValueError('Invalid filter part %r' % filter_part) | |
3861 | ||
3862 | ||
8f18aca8 | 3863 | def match_str(filter_str, dct, incomplete=False): |
6db9c4d5 | 3864 | """ Filter a dictionary with a simple string syntax. |
3865 | @returns Whether the filter passes | |
3866 | @param incomplete Set of keys that is expected to be missing from dct. | |
3867 | Can be True/False to indicate all/none of the keys may be missing. | |
3868 | All conditions on incomplete keys pass if the key is missing | |
8f18aca8 | 3869 | """ |
347de493 | 3870 | return all( |
8f18aca8 | 3871 | _match_one(filter_part.replace(r'\&', '&'), dct, incomplete) |
a047eeb6 | 3872 | for filter_part in re.split(r'(?<!\\)&', filter_str)) |
347de493 PH |
3873 | |
3874 | ||
b1a7cd05 | 3875 | def match_filter_func(filters): |
3876 | if not filters: | |
d1b5f70b | 3877 | return None |
492272fe | 3878 | filters = set(variadic(filters)) |
d1b5f70b | 3879 | |
492272fe | 3880 | interactive = '-' in filters |
3881 | if interactive: | |
3882 | filters.remove('-') | |
3883 | ||
3884 | def _match_func(info_dict, incomplete=False): | |
3885 | if not filters or any(match_str(f, info_dict, incomplete) for f in filters): | |
3886 | return NO_DEFAULT if interactive and not incomplete else None | |
347de493 | 3887 | else: |
3bec830a | 3888 | video_title = info_dict.get('title') or info_dict.get('id') or 'entry' |
b1a7cd05 | 3889 | filter_str = ') | ('.join(map(str.strip, filters)) |
3890 | return f'{video_title} does not pass filter ({filter_str}), skipping ..' | |
347de493 | 3891 | return _match_func |
91410c9b PH |
3892 | |
3893 | ||
f2df4071 | 3894 | class download_range_func: |
3895 | def __init__(self, chapters, ranges): | |
3896 | self.chapters, self.ranges = chapters, ranges | |
3897 | ||
3898 | def __call__(self, info_dict, ydl): | |
0500ee3d | 3899 | if not self.ranges and not self.chapters: |
3900 | yield {} | |
3901 | ||
5ec1b6b7 | 3902 | warning = ('There are no chapters matching the regex' if info_dict.get('chapters') |
56ba69e4 | 3903 | else 'Cannot match chapters since chapter information is unavailable') |
f2df4071 | 3904 | for regex in self.chapters or []: |
5ec1b6b7 | 3905 | for i, chapter in enumerate(info_dict.get('chapters') or []): |
3906 | if re.search(regex, chapter['title']): | |
3907 | warning = None | |
3908 | yield {**chapter, 'index': i} | |
f2df4071 | 3909 | if self.chapters and warning: |
5ec1b6b7 | 3910 | ydl.to_screen(f'[info] {info_dict["id"]}: {warning}') |
3911 | ||
f2df4071 | 3912 | yield from ({'start_time': start, 'end_time': end} for start, end in self.ranges or []) |
5ec1b6b7 | 3913 | |
f2df4071 | 3914 | def __eq__(self, other): |
3915 | return (isinstance(other, download_range_func) | |
3916 | and self.chapters == other.chapters and self.ranges == other.ranges) | |
5ec1b6b7 | 3917 | |
71df9b7f | 3918 | def __repr__(self): |
3919 | return f'{type(self).__name__}({self.chapters}, {self.ranges})' | |
3920 | ||
5ec1b6b7 | 3921 | |
bf6427d2 YCH |
3922 | def parse_dfxp_time_expr(time_expr): |
3923 | if not time_expr: | |
d631d5f9 | 3924 | return |
bf6427d2 | 3925 | |
1d485a1a | 3926 | mobj = re.match(rf'^(?P<time_offset>{NUMBER_RE})s?$', time_expr) |
bf6427d2 YCH |
3927 | if mobj: |
3928 | return float(mobj.group('time_offset')) | |
3929 | ||
db2fe38b | 3930 | mobj = re.match(r'^(\d+):(\d\d):(\d\d(?:(?:\.|:)\d+)?)$', time_expr) |
bf6427d2 | 3931 | if mobj: |
db2fe38b | 3932 | return 3600 * int(mobj.group(1)) + 60 * int(mobj.group(2)) + float(mobj.group(3).replace(':', '.')) |
bf6427d2 YCH |
3933 | |
3934 | ||
c1c924ab | 3935 | def srt_subtitles_timecode(seconds): |
aa7785f8 | 3936 | return '%02d:%02d:%02d,%03d' % timetuple_from_msec(seconds * 1000) |
3937 | ||
3938 | ||
3939 | def ass_subtitles_timecode(seconds): | |
3940 | time = timetuple_from_msec(seconds * 1000) | |
3941 | return '%01d:%02d:%02d.%02d' % (*time[:-1], time.milliseconds / 10) | |
bf6427d2 YCH |
3942 | |
3943 | ||
3944 | def dfxp2srt(dfxp_data): | |
3869028f YCH |
3945 | ''' |
3946 | @param dfxp_data A bytes-like object containing DFXP data | |
3947 | @returns A unicode object containing converted SRT data | |
3948 | ''' | |
5b995f71 | 3949 | LEGACY_NAMESPACES = ( |
3869028f YCH |
3950 | (b'http://www.w3.org/ns/ttml', [ |
3951 | b'http://www.w3.org/2004/11/ttaf1', | |
3952 | b'http://www.w3.org/2006/04/ttaf1', | |
3953 | b'http://www.w3.org/2006/10/ttaf1', | |
5b995f71 | 3954 | ]), |
3869028f YCH |
3955 | (b'http://www.w3.org/ns/ttml#styling', [ |
3956 | b'http://www.w3.org/ns/ttml#style', | |
5b995f71 RA |
3957 | ]), |
3958 | ) | |
3959 | ||
3960 | SUPPORTED_STYLING = [ | |
3961 | 'color', | |
3962 | 'fontFamily', | |
3963 | 'fontSize', | |
3964 | 'fontStyle', | |
3965 | 'fontWeight', | |
3966 | 'textDecoration' | |
3967 | ] | |
3968 | ||
4e335771 | 3969 | _x = functools.partial(xpath_with_ns, ns_map={ |
261f4730 | 3970 | 'xml': 'http://www.w3.org/XML/1998/namespace', |
4e335771 | 3971 | 'ttml': 'http://www.w3.org/ns/ttml', |
5b995f71 | 3972 | 'tts': 'http://www.w3.org/ns/ttml#styling', |
4e335771 | 3973 | }) |
bf6427d2 | 3974 | |
5b995f71 RA |
3975 | styles = {} |
3976 | default_style = {} | |
3977 | ||
86e5f3ed | 3978 | class TTMLPElementParser: |
5b995f71 RA |
3979 | _out = '' |
3980 | _unclosed_elements = [] | |
3981 | _applied_styles = [] | |
bf6427d2 | 3982 | |
2b14cb56 | 3983 | def start(self, tag, attrib): |
5b995f71 RA |
3984 | if tag in (_x('ttml:br'), 'br'): |
3985 | self._out += '\n' | |
3986 | else: | |
3987 | unclosed_elements = [] | |
3988 | style = {} | |
3989 | element_style_id = attrib.get('style') | |
3990 | if default_style: | |
3991 | style.update(default_style) | |
3992 | if element_style_id: | |
3993 | style.update(styles.get(element_style_id, {})) | |
3994 | for prop in SUPPORTED_STYLING: | |
3995 | prop_val = attrib.get(_x('tts:' + prop)) | |
3996 | if prop_val: | |
3997 | style[prop] = prop_val | |
3998 | if style: | |
3999 | font = '' | |
4000 | for k, v in sorted(style.items()): | |
4001 | if self._applied_styles and self._applied_styles[-1].get(k) == v: | |
4002 | continue | |
4003 | if k == 'color': | |
4004 | font += ' color="%s"' % v | |
4005 | elif k == 'fontSize': | |
4006 | font += ' size="%s"' % v | |
4007 | elif k == 'fontFamily': | |
4008 | font += ' face="%s"' % v | |
4009 | elif k == 'fontWeight' and v == 'bold': | |
4010 | self._out += '<b>' | |
4011 | unclosed_elements.append('b') | |
4012 | elif k == 'fontStyle' and v == 'italic': | |
4013 | self._out += '<i>' | |
4014 | unclosed_elements.append('i') | |
4015 | elif k == 'textDecoration' and v == 'underline': | |
4016 | self._out += '<u>' | |
4017 | unclosed_elements.append('u') | |
4018 | if font: | |
4019 | self._out += '<font' + font + '>' | |
4020 | unclosed_elements.append('font') | |
4021 | applied_style = {} | |
4022 | if self._applied_styles: | |
4023 | applied_style.update(self._applied_styles[-1]) | |
4024 | applied_style.update(style) | |
4025 | self._applied_styles.append(applied_style) | |
4026 | self._unclosed_elements.append(unclosed_elements) | |
bf6427d2 | 4027 | |
2b14cb56 | 4028 | def end(self, tag): |
5b995f71 RA |
4029 | if tag not in (_x('ttml:br'), 'br'): |
4030 | unclosed_elements = self._unclosed_elements.pop() | |
4031 | for element in reversed(unclosed_elements): | |
4032 | self._out += '</%s>' % element | |
4033 | if unclosed_elements and self._applied_styles: | |
4034 | self._applied_styles.pop() | |
bf6427d2 | 4035 | |
2b14cb56 | 4036 | def data(self, data): |
5b995f71 | 4037 | self._out += data |
2b14cb56 | 4038 | |
4039 | def close(self): | |
5b995f71 | 4040 | return self._out.strip() |
2b14cb56 | 4041 | |
4042 | def parse_node(node): | |
4043 | target = TTMLPElementParser() | |
4044 | parser = xml.etree.ElementTree.XMLParser(target=target) | |
4045 | parser.feed(xml.etree.ElementTree.tostring(node)) | |
4046 | return parser.close() | |
bf6427d2 | 4047 | |
5b995f71 RA |
4048 | for k, v in LEGACY_NAMESPACES: |
4049 | for ns in v: | |
4050 | dfxp_data = dfxp_data.replace(ns, k) | |
4051 | ||
3869028f | 4052 | dfxp = compat_etree_fromstring(dfxp_data) |
bf6427d2 | 4053 | out = [] |
5b995f71 | 4054 | paras = dfxp.findall(_x('.//ttml:p')) or dfxp.findall('.//p') |
1b0427e6 YCH |
4055 | |
4056 | if not paras: | |
4057 | raise ValueError('Invalid dfxp/TTML subtitle') | |
bf6427d2 | 4058 | |
5b995f71 RA |
4059 | repeat = False |
4060 | while True: | |
4061 | for style in dfxp.findall(_x('.//ttml:style')): | |
261f4730 RA |
4062 | style_id = style.get('id') or style.get(_x('xml:id')) |
4063 | if not style_id: | |
4064 | continue | |
5b995f71 RA |
4065 | parent_style_id = style.get('style') |
4066 | if parent_style_id: | |
4067 | if parent_style_id not in styles: | |
4068 | repeat = True | |
4069 | continue | |
4070 | styles[style_id] = styles[parent_style_id].copy() | |
4071 | for prop in SUPPORTED_STYLING: | |
4072 | prop_val = style.get(_x('tts:' + prop)) | |
4073 | if prop_val: | |
4074 | styles.setdefault(style_id, {})[prop] = prop_val | |
4075 | if repeat: | |
4076 | repeat = False | |
4077 | else: | |
4078 | break | |
4079 | ||
4080 | for p in ('body', 'div'): | |
4081 | ele = xpath_element(dfxp, [_x('.//ttml:' + p), './/' + p]) | |
4082 | if ele is None: | |
4083 | continue | |
4084 | style = styles.get(ele.get('style')) | |
4085 | if not style: | |
4086 | continue | |
4087 | default_style.update(style) | |
4088 | ||
bf6427d2 | 4089 | for para, index in zip(paras, itertools.count(1)): |
d631d5f9 | 4090 | begin_time = parse_dfxp_time_expr(para.attrib.get('begin')) |
7dff0363 | 4091 | end_time = parse_dfxp_time_expr(para.attrib.get('end')) |
d631d5f9 YCH |
4092 | dur = parse_dfxp_time_expr(para.attrib.get('dur')) |
4093 | if begin_time is None: | |
4094 | continue | |
7dff0363 | 4095 | if not end_time: |
d631d5f9 YCH |
4096 | if not dur: |
4097 | continue | |
4098 | end_time = begin_time + dur | |
bf6427d2 YCH |
4099 | out.append('%d\n%s --> %s\n%s\n\n' % ( |
4100 | index, | |
c1c924ab YCH |
4101 | srt_subtitles_timecode(begin_time), |
4102 | srt_subtitles_timecode(end_time), | |
bf6427d2 YCH |
4103 | parse_node(para))) |
4104 | ||
4105 | return ''.join(out) | |
4106 | ||
4107 | ||
c487cf00 | 4108 | def cli_option(params, command_option, param, separator=None): |
66e289ba | 4109 | param = params.get(param) |
c487cf00 | 4110 | return ([] if param is None |
4111 | else [command_option, str(param)] if separator is None | |
4112 | else [f'{command_option}{separator}{param}']) | |
66e289ba S |
4113 | |
4114 | ||
4115 | def cli_bool_option(params, command_option, param, true_value='true', false_value='false', separator=None): | |
4116 | param = params.get(param) | |
c487cf00 | 4117 | assert param in (True, False, None) |
4118 | return cli_option({True: true_value, False: false_value}, command_option, param, separator) | |
66e289ba S |
4119 | |
4120 | ||
4121 | def cli_valueless_option(params, command_option, param, expected_value=True): | |
c487cf00 | 4122 | return [command_option] if params.get(param) == expected_value else [] |
66e289ba S |
4123 | |
4124 | ||
e92caff5 | 4125 | def cli_configuration_args(argdict, keys, default=[], use_compat=True): |
eab9b2bc | 4126 | if isinstance(argdict, (list, tuple)): # for backward compatibility |
e92caff5 | 4127 | if use_compat: |
5b1ecbb3 | 4128 | return argdict |
4129 | else: | |
4130 | argdict = None | |
eab9b2bc | 4131 | if argdict is None: |
5b1ecbb3 | 4132 | return default |
eab9b2bc | 4133 | assert isinstance(argdict, dict) |
4134 | ||
e92caff5 | 4135 | assert isinstance(keys, (list, tuple)) |
4136 | for key_list in keys: | |
e92caff5 | 4137 | arg_list = list(filter( |
4138 | lambda x: x is not None, | |
6606817a | 4139 | [argdict.get(key.lower()) for key in variadic(key_list)])) |
e92caff5 | 4140 | if arg_list: |
4141 | return [arg for args in arg_list for arg in args] | |
4142 | return default | |
66e289ba | 4143 | |
6251555f | 4144 | |
330690a2 | 4145 | def _configuration_args(main_key, argdict, exe, keys=None, default=[], use_compat=True): |
4146 | main_key, exe = main_key.lower(), exe.lower() | |
4147 | root_key = exe if main_key == exe else f'{main_key}+{exe}' | |
4148 | keys = [f'{root_key}{k}' for k in (keys or [''])] | |
4149 | if root_key in keys: | |
4150 | if main_key != exe: | |
4151 | keys.append((main_key, exe)) | |
4152 | keys.append('default') | |
4153 | else: | |
4154 | use_compat = False | |
4155 | return cli_configuration_args(argdict, keys, default, use_compat) | |
4156 | ||
66e289ba | 4157 | |
86e5f3ed | 4158 | class ISO639Utils: |
39672624 YCH |
4159 | # See http://www.loc.gov/standards/iso639-2/ISO-639-2_utf-8.txt |
4160 | _lang_map = { | |
4161 | 'aa': 'aar', | |
4162 | 'ab': 'abk', | |
4163 | 'ae': 'ave', | |
4164 | 'af': 'afr', | |
4165 | 'ak': 'aka', | |
4166 | 'am': 'amh', | |
4167 | 'an': 'arg', | |
4168 | 'ar': 'ara', | |
4169 | 'as': 'asm', | |
4170 | 'av': 'ava', | |
4171 | 'ay': 'aym', | |
4172 | 'az': 'aze', | |
4173 | 'ba': 'bak', | |
4174 | 'be': 'bel', | |
4175 | 'bg': 'bul', | |
4176 | 'bh': 'bih', | |
4177 | 'bi': 'bis', | |
4178 | 'bm': 'bam', | |
4179 | 'bn': 'ben', | |
4180 | 'bo': 'bod', | |
4181 | 'br': 'bre', | |
4182 | 'bs': 'bos', | |
4183 | 'ca': 'cat', | |
4184 | 'ce': 'che', | |
4185 | 'ch': 'cha', | |
4186 | 'co': 'cos', | |
4187 | 'cr': 'cre', | |
4188 | 'cs': 'ces', | |
4189 | 'cu': 'chu', | |
4190 | 'cv': 'chv', | |
4191 | 'cy': 'cym', | |
4192 | 'da': 'dan', | |
4193 | 'de': 'deu', | |
4194 | 'dv': 'div', | |
4195 | 'dz': 'dzo', | |
4196 | 'ee': 'ewe', | |
4197 | 'el': 'ell', | |
4198 | 'en': 'eng', | |
4199 | 'eo': 'epo', | |
4200 | 'es': 'spa', | |
4201 | 'et': 'est', | |
4202 | 'eu': 'eus', | |
4203 | 'fa': 'fas', | |
4204 | 'ff': 'ful', | |
4205 | 'fi': 'fin', | |
4206 | 'fj': 'fij', | |
4207 | 'fo': 'fao', | |
4208 | 'fr': 'fra', | |
4209 | 'fy': 'fry', | |
4210 | 'ga': 'gle', | |
4211 | 'gd': 'gla', | |
4212 | 'gl': 'glg', | |
4213 | 'gn': 'grn', | |
4214 | 'gu': 'guj', | |
4215 | 'gv': 'glv', | |
4216 | 'ha': 'hau', | |
4217 | 'he': 'heb', | |
b7acc835 | 4218 | 'iw': 'heb', # Replaced by he in 1989 revision |
39672624 YCH |
4219 | 'hi': 'hin', |
4220 | 'ho': 'hmo', | |
4221 | 'hr': 'hrv', | |
4222 | 'ht': 'hat', | |
4223 | 'hu': 'hun', | |
4224 | 'hy': 'hye', | |
4225 | 'hz': 'her', | |
4226 | 'ia': 'ina', | |
4227 | 'id': 'ind', | |
b7acc835 | 4228 | 'in': 'ind', # Replaced by id in 1989 revision |
39672624 YCH |
4229 | 'ie': 'ile', |
4230 | 'ig': 'ibo', | |
4231 | 'ii': 'iii', | |
4232 | 'ik': 'ipk', | |
4233 | 'io': 'ido', | |
4234 | 'is': 'isl', | |
4235 | 'it': 'ita', | |
4236 | 'iu': 'iku', | |
4237 | 'ja': 'jpn', | |
4238 | 'jv': 'jav', | |
4239 | 'ka': 'kat', | |
4240 | 'kg': 'kon', | |
4241 | 'ki': 'kik', | |
4242 | 'kj': 'kua', | |
4243 | 'kk': 'kaz', | |
4244 | 'kl': 'kal', | |
4245 | 'km': 'khm', | |
4246 | 'kn': 'kan', | |
4247 | 'ko': 'kor', | |
4248 | 'kr': 'kau', | |
4249 | 'ks': 'kas', | |
4250 | 'ku': 'kur', | |
4251 | 'kv': 'kom', | |
4252 | 'kw': 'cor', | |
4253 | 'ky': 'kir', | |
4254 | 'la': 'lat', | |
4255 | 'lb': 'ltz', | |
4256 | 'lg': 'lug', | |
4257 | 'li': 'lim', | |
4258 | 'ln': 'lin', | |
4259 | 'lo': 'lao', | |
4260 | 'lt': 'lit', | |
4261 | 'lu': 'lub', | |
4262 | 'lv': 'lav', | |
4263 | 'mg': 'mlg', | |
4264 | 'mh': 'mah', | |
4265 | 'mi': 'mri', | |
4266 | 'mk': 'mkd', | |
4267 | 'ml': 'mal', | |
4268 | 'mn': 'mon', | |
4269 | 'mr': 'mar', | |
4270 | 'ms': 'msa', | |
4271 | 'mt': 'mlt', | |
4272 | 'my': 'mya', | |
4273 | 'na': 'nau', | |
4274 | 'nb': 'nob', | |
4275 | 'nd': 'nde', | |
4276 | 'ne': 'nep', | |
4277 | 'ng': 'ndo', | |
4278 | 'nl': 'nld', | |
4279 | 'nn': 'nno', | |
4280 | 'no': 'nor', | |
4281 | 'nr': 'nbl', | |
4282 | 'nv': 'nav', | |
4283 | 'ny': 'nya', | |
4284 | 'oc': 'oci', | |
4285 | 'oj': 'oji', | |
4286 | 'om': 'orm', | |
4287 | 'or': 'ori', | |
4288 | 'os': 'oss', | |
4289 | 'pa': 'pan', | |
4290 | 'pi': 'pli', | |
4291 | 'pl': 'pol', | |
4292 | 'ps': 'pus', | |
4293 | 'pt': 'por', | |
4294 | 'qu': 'que', | |
4295 | 'rm': 'roh', | |
4296 | 'rn': 'run', | |
4297 | 'ro': 'ron', | |
4298 | 'ru': 'rus', | |
4299 | 'rw': 'kin', | |
4300 | 'sa': 'san', | |
4301 | 'sc': 'srd', | |
4302 | 'sd': 'snd', | |
4303 | 'se': 'sme', | |
4304 | 'sg': 'sag', | |
4305 | 'si': 'sin', | |
4306 | 'sk': 'slk', | |
4307 | 'sl': 'slv', | |
4308 | 'sm': 'smo', | |
4309 | 'sn': 'sna', | |
4310 | 'so': 'som', | |
4311 | 'sq': 'sqi', | |
4312 | 'sr': 'srp', | |
4313 | 'ss': 'ssw', | |
4314 | 'st': 'sot', | |
4315 | 'su': 'sun', | |
4316 | 'sv': 'swe', | |
4317 | 'sw': 'swa', | |
4318 | 'ta': 'tam', | |
4319 | 'te': 'tel', | |
4320 | 'tg': 'tgk', | |
4321 | 'th': 'tha', | |
4322 | 'ti': 'tir', | |
4323 | 'tk': 'tuk', | |
4324 | 'tl': 'tgl', | |
4325 | 'tn': 'tsn', | |
4326 | 'to': 'ton', | |
4327 | 'tr': 'tur', | |
4328 | 'ts': 'tso', | |
4329 | 'tt': 'tat', | |
4330 | 'tw': 'twi', | |
4331 | 'ty': 'tah', | |
4332 | 'ug': 'uig', | |
4333 | 'uk': 'ukr', | |
4334 | 'ur': 'urd', | |
4335 | 'uz': 'uzb', | |
4336 | 've': 'ven', | |
4337 | 'vi': 'vie', | |
4338 | 'vo': 'vol', | |
4339 | 'wa': 'wln', | |
4340 | 'wo': 'wol', | |
4341 | 'xh': 'xho', | |
4342 | 'yi': 'yid', | |
e9a50fba | 4343 | 'ji': 'yid', # Replaced by yi in 1989 revision |
39672624 YCH |
4344 | 'yo': 'yor', |
4345 | 'za': 'zha', | |
4346 | 'zh': 'zho', | |
4347 | 'zu': 'zul', | |
4348 | } | |
4349 | ||
4350 | @classmethod | |
4351 | def short2long(cls, code): | |
4352 | """Convert language code from ISO 639-1 to ISO 639-2/T""" | |
4353 | return cls._lang_map.get(code[:2]) | |
4354 | ||
4355 | @classmethod | |
4356 | def long2short(cls, code): | |
4357 | """Convert language code from ISO 639-2/T to ISO 639-1""" | |
4358 | for short_name, long_name in cls._lang_map.items(): | |
4359 | if long_name == code: | |
4360 | return short_name | |
4361 | ||
4362 | ||
86e5f3ed | 4363 | class ISO3166Utils: |
4eb10f66 YCH |
4364 | # From http://data.okfn.org/data/core/country-list |
4365 | _country_map = { | |
4366 | 'AF': 'Afghanistan', | |
4367 | 'AX': 'Åland Islands', | |
4368 | 'AL': 'Albania', | |
4369 | 'DZ': 'Algeria', | |
4370 | 'AS': 'American Samoa', | |
4371 | 'AD': 'Andorra', | |
4372 | 'AO': 'Angola', | |
4373 | 'AI': 'Anguilla', | |
4374 | 'AQ': 'Antarctica', | |
4375 | 'AG': 'Antigua and Barbuda', | |
4376 | 'AR': 'Argentina', | |
4377 | 'AM': 'Armenia', | |
4378 | 'AW': 'Aruba', | |
4379 | 'AU': 'Australia', | |
4380 | 'AT': 'Austria', | |
4381 | 'AZ': 'Azerbaijan', | |
4382 | 'BS': 'Bahamas', | |
4383 | 'BH': 'Bahrain', | |
4384 | 'BD': 'Bangladesh', | |
4385 | 'BB': 'Barbados', | |
4386 | 'BY': 'Belarus', | |
4387 | 'BE': 'Belgium', | |
4388 | 'BZ': 'Belize', | |
4389 | 'BJ': 'Benin', | |
4390 | 'BM': 'Bermuda', | |
4391 | 'BT': 'Bhutan', | |
4392 | 'BO': 'Bolivia, Plurinational State of', | |
4393 | 'BQ': 'Bonaire, Sint Eustatius and Saba', | |
4394 | 'BA': 'Bosnia and Herzegovina', | |
4395 | 'BW': 'Botswana', | |
4396 | 'BV': 'Bouvet Island', | |
4397 | 'BR': 'Brazil', | |
4398 | 'IO': 'British Indian Ocean Territory', | |
4399 | 'BN': 'Brunei Darussalam', | |
4400 | 'BG': 'Bulgaria', | |
4401 | 'BF': 'Burkina Faso', | |
4402 | 'BI': 'Burundi', | |
4403 | 'KH': 'Cambodia', | |
4404 | 'CM': 'Cameroon', | |
4405 | 'CA': 'Canada', | |
4406 | 'CV': 'Cape Verde', | |
4407 | 'KY': 'Cayman Islands', | |
4408 | 'CF': 'Central African Republic', | |
4409 | 'TD': 'Chad', | |
4410 | 'CL': 'Chile', | |
4411 | 'CN': 'China', | |
4412 | 'CX': 'Christmas Island', | |
4413 | 'CC': 'Cocos (Keeling) Islands', | |
4414 | 'CO': 'Colombia', | |
4415 | 'KM': 'Comoros', | |
4416 | 'CG': 'Congo', | |
4417 | 'CD': 'Congo, the Democratic Republic of the', | |
4418 | 'CK': 'Cook Islands', | |
4419 | 'CR': 'Costa Rica', | |
4420 | 'CI': 'Côte d\'Ivoire', | |
4421 | 'HR': 'Croatia', | |
4422 | 'CU': 'Cuba', | |
4423 | 'CW': 'Curaçao', | |
4424 | 'CY': 'Cyprus', | |
4425 | 'CZ': 'Czech Republic', | |
4426 | 'DK': 'Denmark', | |
4427 | 'DJ': 'Djibouti', | |
4428 | 'DM': 'Dominica', | |
4429 | 'DO': 'Dominican Republic', | |
4430 | 'EC': 'Ecuador', | |
4431 | 'EG': 'Egypt', | |
4432 | 'SV': 'El Salvador', | |
4433 | 'GQ': 'Equatorial Guinea', | |
4434 | 'ER': 'Eritrea', | |
4435 | 'EE': 'Estonia', | |
4436 | 'ET': 'Ethiopia', | |
4437 | 'FK': 'Falkland Islands (Malvinas)', | |
4438 | 'FO': 'Faroe Islands', | |
4439 | 'FJ': 'Fiji', | |
4440 | 'FI': 'Finland', | |
4441 | 'FR': 'France', | |
4442 | 'GF': 'French Guiana', | |
4443 | 'PF': 'French Polynesia', | |
4444 | 'TF': 'French Southern Territories', | |
4445 | 'GA': 'Gabon', | |
4446 | 'GM': 'Gambia', | |
4447 | 'GE': 'Georgia', | |
4448 | 'DE': 'Germany', | |
4449 | 'GH': 'Ghana', | |
4450 | 'GI': 'Gibraltar', | |
4451 | 'GR': 'Greece', | |
4452 | 'GL': 'Greenland', | |
4453 | 'GD': 'Grenada', | |
4454 | 'GP': 'Guadeloupe', | |
4455 | 'GU': 'Guam', | |
4456 | 'GT': 'Guatemala', | |
4457 | 'GG': 'Guernsey', | |
4458 | 'GN': 'Guinea', | |
4459 | 'GW': 'Guinea-Bissau', | |
4460 | 'GY': 'Guyana', | |
4461 | 'HT': 'Haiti', | |
4462 | 'HM': 'Heard Island and McDonald Islands', | |
4463 | 'VA': 'Holy See (Vatican City State)', | |
4464 | 'HN': 'Honduras', | |
4465 | 'HK': 'Hong Kong', | |
4466 | 'HU': 'Hungary', | |
4467 | 'IS': 'Iceland', | |
4468 | 'IN': 'India', | |
4469 | 'ID': 'Indonesia', | |
4470 | 'IR': 'Iran, Islamic Republic of', | |
4471 | 'IQ': 'Iraq', | |
4472 | 'IE': 'Ireland', | |
4473 | 'IM': 'Isle of Man', | |
4474 | 'IL': 'Israel', | |
4475 | 'IT': 'Italy', | |
4476 | 'JM': 'Jamaica', | |
4477 | 'JP': 'Japan', | |
4478 | 'JE': 'Jersey', | |
4479 | 'JO': 'Jordan', | |
4480 | 'KZ': 'Kazakhstan', | |
4481 | 'KE': 'Kenya', | |
4482 | 'KI': 'Kiribati', | |
4483 | 'KP': 'Korea, Democratic People\'s Republic of', | |
4484 | 'KR': 'Korea, Republic of', | |
4485 | 'KW': 'Kuwait', | |
4486 | 'KG': 'Kyrgyzstan', | |
4487 | 'LA': 'Lao People\'s Democratic Republic', | |
4488 | 'LV': 'Latvia', | |
4489 | 'LB': 'Lebanon', | |
4490 | 'LS': 'Lesotho', | |
4491 | 'LR': 'Liberia', | |
4492 | 'LY': 'Libya', | |
4493 | 'LI': 'Liechtenstein', | |
4494 | 'LT': 'Lithuania', | |
4495 | 'LU': 'Luxembourg', | |
4496 | 'MO': 'Macao', | |
4497 | 'MK': 'Macedonia, the Former Yugoslav Republic of', | |
4498 | 'MG': 'Madagascar', | |
4499 | 'MW': 'Malawi', | |
4500 | 'MY': 'Malaysia', | |
4501 | 'MV': 'Maldives', | |
4502 | 'ML': 'Mali', | |
4503 | 'MT': 'Malta', | |
4504 | 'MH': 'Marshall Islands', | |
4505 | 'MQ': 'Martinique', | |
4506 | 'MR': 'Mauritania', | |
4507 | 'MU': 'Mauritius', | |
4508 | 'YT': 'Mayotte', | |
4509 | 'MX': 'Mexico', | |
4510 | 'FM': 'Micronesia, Federated States of', | |
4511 | 'MD': 'Moldova, Republic of', | |
4512 | 'MC': 'Monaco', | |
4513 | 'MN': 'Mongolia', | |
4514 | 'ME': 'Montenegro', | |
4515 | 'MS': 'Montserrat', | |
4516 | 'MA': 'Morocco', | |
4517 | 'MZ': 'Mozambique', | |
4518 | 'MM': 'Myanmar', | |
4519 | 'NA': 'Namibia', | |
4520 | 'NR': 'Nauru', | |
4521 | 'NP': 'Nepal', | |
4522 | 'NL': 'Netherlands', | |
4523 | 'NC': 'New Caledonia', | |
4524 | 'NZ': 'New Zealand', | |
4525 | 'NI': 'Nicaragua', | |
4526 | 'NE': 'Niger', | |
4527 | 'NG': 'Nigeria', | |
4528 | 'NU': 'Niue', | |
4529 | 'NF': 'Norfolk Island', | |
4530 | 'MP': 'Northern Mariana Islands', | |
4531 | 'NO': 'Norway', | |
4532 | 'OM': 'Oman', | |
4533 | 'PK': 'Pakistan', | |
4534 | 'PW': 'Palau', | |
4535 | 'PS': 'Palestine, State of', | |
4536 | 'PA': 'Panama', | |
4537 | 'PG': 'Papua New Guinea', | |
4538 | 'PY': 'Paraguay', | |
4539 | 'PE': 'Peru', | |
4540 | 'PH': 'Philippines', | |
4541 | 'PN': 'Pitcairn', | |
4542 | 'PL': 'Poland', | |
4543 | 'PT': 'Portugal', | |
4544 | 'PR': 'Puerto Rico', | |
4545 | 'QA': 'Qatar', | |
4546 | 'RE': 'Réunion', | |
4547 | 'RO': 'Romania', | |
4548 | 'RU': 'Russian Federation', | |
4549 | 'RW': 'Rwanda', | |
4550 | 'BL': 'Saint Barthélemy', | |
4551 | 'SH': 'Saint Helena, Ascension and Tristan da Cunha', | |
4552 | 'KN': 'Saint Kitts and Nevis', | |
4553 | 'LC': 'Saint Lucia', | |
4554 | 'MF': 'Saint Martin (French part)', | |
4555 | 'PM': 'Saint Pierre and Miquelon', | |
4556 | 'VC': 'Saint Vincent and the Grenadines', | |
4557 | 'WS': 'Samoa', | |
4558 | 'SM': 'San Marino', | |
4559 | 'ST': 'Sao Tome and Principe', | |
4560 | 'SA': 'Saudi Arabia', | |
4561 | 'SN': 'Senegal', | |
4562 | 'RS': 'Serbia', | |
4563 | 'SC': 'Seychelles', | |
4564 | 'SL': 'Sierra Leone', | |
4565 | 'SG': 'Singapore', | |
4566 | 'SX': 'Sint Maarten (Dutch part)', | |
4567 | 'SK': 'Slovakia', | |
4568 | 'SI': 'Slovenia', | |
4569 | 'SB': 'Solomon Islands', | |
4570 | 'SO': 'Somalia', | |
4571 | 'ZA': 'South Africa', | |
4572 | 'GS': 'South Georgia and the South Sandwich Islands', | |
4573 | 'SS': 'South Sudan', | |
4574 | 'ES': 'Spain', | |
4575 | 'LK': 'Sri Lanka', | |
4576 | 'SD': 'Sudan', | |
4577 | 'SR': 'Suriname', | |
4578 | 'SJ': 'Svalbard and Jan Mayen', | |
4579 | 'SZ': 'Swaziland', | |
4580 | 'SE': 'Sweden', | |
4581 | 'CH': 'Switzerland', | |
4582 | 'SY': 'Syrian Arab Republic', | |
4583 | 'TW': 'Taiwan, Province of China', | |
4584 | 'TJ': 'Tajikistan', | |
4585 | 'TZ': 'Tanzania, United Republic of', | |
4586 | 'TH': 'Thailand', | |
4587 | 'TL': 'Timor-Leste', | |
4588 | 'TG': 'Togo', | |
4589 | 'TK': 'Tokelau', | |
4590 | 'TO': 'Tonga', | |
4591 | 'TT': 'Trinidad and Tobago', | |
4592 | 'TN': 'Tunisia', | |
4593 | 'TR': 'Turkey', | |
4594 | 'TM': 'Turkmenistan', | |
4595 | 'TC': 'Turks and Caicos Islands', | |
4596 | 'TV': 'Tuvalu', | |
4597 | 'UG': 'Uganda', | |
4598 | 'UA': 'Ukraine', | |
4599 | 'AE': 'United Arab Emirates', | |
4600 | 'GB': 'United Kingdom', | |
4601 | 'US': 'United States', | |
4602 | 'UM': 'United States Minor Outlying Islands', | |
4603 | 'UY': 'Uruguay', | |
4604 | 'UZ': 'Uzbekistan', | |
4605 | 'VU': 'Vanuatu', | |
4606 | 'VE': 'Venezuela, Bolivarian Republic of', | |
4607 | 'VN': 'Viet Nam', | |
4608 | 'VG': 'Virgin Islands, British', | |
4609 | 'VI': 'Virgin Islands, U.S.', | |
4610 | 'WF': 'Wallis and Futuna', | |
4611 | 'EH': 'Western Sahara', | |
4612 | 'YE': 'Yemen', | |
4613 | 'ZM': 'Zambia', | |
4614 | 'ZW': 'Zimbabwe', | |
2f97cc61 | 4615 | # Not ISO 3166 codes, but used for IP blocks |
4616 | 'AP': 'Asia/Pacific Region', | |
4617 | 'EU': 'Europe', | |
4eb10f66 YCH |
4618 | } |
4619 | ||
4620 | @classmethod | |
4621 | def short2full(cls, code): | |
4622 | """Convert an ISO 3166-2 country code to the corresponding full name""" | |
4623 | return cls._country_map.get(code.upper()) | |
4624 | ||
4625 | ||
86e5f3ed | 4626 | class GeoUtils: |
773f291d S |
4627 | # Major IPv4 address blocks per country |
4628 | _country_ip_map = { | |
53896ca5 | 4629 | 'AD': '46.172.224.0/19', |
773f291d S |
4630 | 'AE': '94.200.0.0/13', |
4631 | 'AF': '149.54.0.0/17', | |
4632 | 'AG': '209.59.64.0/18', | |
4633 | 'AI': '204.14.248.0/21', | |
4634 | 'AL': '46.99.0.0/16', | |
4635 | 'AM': '46.70.0.0/15', | |
4636 | 'AO': '105.168.0.0/13', | |
53896ca5 S |
4637 | 'AP': '182.50.184.0/21', |
4638 | 'AQ': '23.154.160.0/24', | |
773f291d S |
4639 | 'AR': '181.0.0.0/12', |
4640 | 'AS': '202.70.112.0/20', | |
53896ca5 | 4641 | 'AT': '77.116.0.0/14', |
773f291d S |
4642 | 'AU': '1.128.0.0/11', |
4643 | 'AW': '181.41.0.0/18', | |
53896ca5 S |
4644 | 'AX': '185.217.4.0/22', |
4645 | 'AZ': '5.197.0.0/16', | |
773f291d S |
4646 | 'BA': '31.176.128.0/17', |
4647 | 'BB': '65.48.128.0/17', | |
4648 | 'BD': '114.130.0.0/16', | |
4649 | 'BE': '57.0.0.0/8', | |
53896ca5 | 4650 | 'BF': '102.178.0.0/15', |
773f291d S |
4651 | 'BG': '95.42.0.0/15', |
4652 | 'BH': '37.131.0.0/17', | |
4653 | 'BI': '154.117.192.0/18', | |
4654 | 'BJ': '137.255.0.0/16', | |
53896ca5 | 4655 | 'BL': '185.212.72.0/23', |
773f291d S |
4656 | 'BM': '196.12.64.0/18', |
4657 | 'BN': '156.31.0.0/16', | |
4658 | 'BO': '161.56.0.0/16', | |
4659 | 'BQ': '161.0.80.0/20', | |
53896ca5 | 4660 | 'BR': '191.128.0.0/12', |
773f291d S |
4661 | 'BS': '24.51.64.0/18', |
4662 | 'BT': '119.2.96.0/19', | |
4663 | 'BW': '168.167.0.0/16', | |
4664 | 'BY': '178.120.0.0/13', | |
4665 | 'BZ': '179.42.192.0/18', | |
4666 | 'CA': '99.224.0.0/11', | |
4667 | 'CD': '41.243.0.0/16', | |
53896ca5 S |
4668 | 'CF': '197.242.176.0/21', |
4669 | 'CG': '160.113.0.0/16', | |
773f291d | 4670 | 'CH': '85.0.0.0/13', |
53896ca5 | 4671 | 'CI': '102.136.0.0/14', |
773f291d S |
4672 | 'CK': '202.65.32.0/19', |
4673 | 'CL': '152.172.0.0/14', | |
53896ca5 | 4674 | 'CM': '102.244.0.0/14', |
773f291d S |
4675 | 'CN': '36.128.0.0/10', |
4676 | 'CO': '181.240.0.0/12', | |
4677 | 'CR': '201.192.0.0/12', | |
4678 | 'CU': '152.206.0.0/15', | |
4679 | 'CV': '165.90.96.0/19', | |
4680 | 'CW': '190.88.128.0/17', | |
53896ca5 | 4681 | 'CY': '31.153.0.0/16', |
773f291d S |
4682 | 'CZ': '88.100.0.0/14', |
4683 | 'DE': '53.0.0.0/8', | |
4684 | 'DJ': '197.241.0.0/17', | |
4685 | 'DK': '87.48.0.0/12', | |
4686 | 'DM': '192.243.48.0/20', | |
4687 | 'DO': '152.166.0.0/15', | |
4688 | 'DZ': '41.96.0.0/12', | |
4689 | 'EC': '186.68.0.0/15', | |
4690 | 'EE': '90.190.0.0/15', | |
4691 | 'EG': '156.160.0.0/11', | |
4692 | 'ER': '196.200.96.0/20', | |
4693 | 'ES': '88.0.0.0/11', | |
4694 | 'ET': '196.188.0.0/14', | |
4695 | 'EU': '2.16.0.0/13', | |
4696 | 'FI': '91.152.0.0/13', | |
4697 | 'FJ': '144.120.0.0/16', | |
53896ca5 | 4698 | 'FK': '80.73.208.0/21', |
773f291d S |
4699 | 'FM': '119.252.112.0/20', |
4700 | 'FO': '88.85.32.0/19', | |
4701 | 'FR': '90.0.0.0/9', | |
4702 | 'GA': '41.158.0.0/15', | |
4703 | 'GB': '25.0.0.0/8', | |
4704 | 'GD': '74.122.88.0/21', | |
4705 | 'GE': '31.146.0.0/16', | |
4706 | 'GF': '161.22.64.0/18', | |
4707 | 'GG': '62.68.160.0/19', | |
53896ca5 S |
4708 | 'GH': '154.160.0.0/12', |
4709 | 'GI': '95.164.0.0/16', | |
773f291d S |
4710 | 'GL': '88.83.0.0/19', |
4711 | 'GM': '160.182.0.0/15', | |
4712 | 'GN': '197.149.192.0/18', | |
4713 | 'GP': '104.250.0.0/19', | |
4714 | 'GQ': '105.235.224.0/20', | |
4715 | 'GR': '94.64.0.0/13', | |
4716 | 'GT': '168.234.0.0/16', | |
4717 | 'GU': '168.123.0.0/16', | |
4718 | 'GW': '197.214.80.0/20', | |
4719 | 'GY': '181.41.64.0/18', | |
4720 | 'HK': '113.252.0.0/14', | |
4721 | 'HN': '181.210.0.0/16', | |
4722 | 'HR': '93.136.0.0/13', | |
4723 | 'HT': '148.102.128.0/17', | |
4724 | 'HU': '84.0.0.0/14', | |
4725 | 'ID': '39.192.0.0/10', | |
4726 | 'IE': '87.32.0.0/12', | |
4727 | 'IL': '79.176.0.0/13', | |
4728 | 'IM': '5.62.80.0/20', | |
4729 | 'IN': '117.192.0.0/10', | |
4730 | 'IO': '203.83.48.0/21', | |
4731 | 'IQ': '37.236.0.0/14', | |
4732 | 'IR': '2.176.0.0/12', | |
4733 | 'IS': '82.221.0.0/16', | |
4734 | 'IT': '79.0.0.0/10', | |
4735 | 'JE': '87.244.64.0/18', | |
4736 | 'JM': '72.27.0.0/17', | |
4737 | 'JO': '176.29.0.0/16', | |
53896ca5 | 4738 | 'JP': '133.0.0.0/8', |
773f291d S |
4739 | 'KE': '105.48.0.0/12', |
4740 | 'KG': '158.181.128.0/17', | |
4741 | 'KH': '36.37.128.0/17', | |
4742 | 'KI': '103.25.140.0/22', | |
4743 | 'KM': '197.255.224.0/20', | |
53896ca5 | 4744 | 'KN': '198.167.192.0/19', |
773f291d S |
4745 | 'KP': '175.45.176.0/22', |
4746 | 'KR': '175.192.0.0/10', | |
4747 | 'KW': '37.36.0.0/14', | |
4748 | 'KY': '64.96.0.0/15', | |
4749 | 'KZ': '2.72.0.0/13', | |
4750 | 'LA': '115.84.64.0/18', | |
4751 | 'LB': '178.135.0.0/16', | |
53896ca5 | 4752 | 'LC': '24.92.144.0/20', |
773f291d S |
4753 | 'LI': '82.117.0.0/19', |
4754 | 'LK': '112.134.0.0/15', | |
53896ca5 | 4755 | 'LR': '102.183.0.0/16', |
773f291d S |
4756 | 'LS': '129.232.0.0/17', |
4757 | 'LT': '78.56.0.0/13', | |
4758 | 'LU': '188.42.0.0/16', | |
4759 | 'LV': '46.109.0.0/16', | |
4760 | 'LY': '41.252.0.0/14', | |
4761 | 'MA': '105.128.0.0/11', | |
4762 | 'MC': '88.209.64.0/18', | |
4763 | 'MD': '37.246.0.0/16', | |
4764 | 'ME': '178.175.0.0/17', | |
4765 | 'MF': '74.112.232.0/21', | |
4766 | 'MG': '154.126.0.0/17', | |
4767 | 'MH': '117.103.88.0/21', | |
4768 | 'MK': '77.28.0.0/15', | |
4769 | 'ML': '154.118.128.0/18', | |
4770 | 'MM': '37.111.0.0/17', | |
4771 | 'MN': '49.0.128.0/17', | |
4772 | 'MO': '60.246.0.0/16', | |
4773 | 'MP': '202.88.64.0/20', | |
4774 | 'MQ': '109.203.224.0/19', | |
4775 | 'MR': '41.188.64.0/18', | |
4776 | 'MS': '208.90.112.0/22', | |
4777 | 'MT': '46.11.0.0/16', | |
4778 | 'MU': '105.16.0.0/12', | |
4779 | 'MV': '27.114.128.0/18', | |
53896ca5 | 4780 | 'MW': '102.70.0.0/15', |
773f291d S |
4781 | 'MX': '187.192.0.0/11', |
4782 | 'MY': '175.136.0.0/13', | |
4783 | 'MZ': '197.218.0.0/15', | |
4784 | 'NA': '41.182.0.0/16', | |
4785 | 'NC': '101.101.0.0/18', | |
4786 | 'NE': '197.214.0.0/18', | |
4787 | 'NF': '203.17.240.0/22', | |
4788 | 'NG': '105.112.0.0/12', | |
4789 | 'NI': '186.76.0.0/15', | |
4790 | 'NL': '145.96.0.0/11', | |
4791 | 'NO': '84.208.0.0/13', | |
4792 | 'NP': '36.252.0.0/15', | |
4793 | 'NR': '203.98.224.0/19', | |
4794 | 'NU': '49.156.48.0/22', | |
4795 | 'NZ': '49.224.0.0/14', | |
4796 | 'OM': '5.36.0.0/15', | |
4797 | 'PA': '186.72.0.0/15', | |
4798 | 'PE': '186.160.0.0/14', | |
4799 | 'PF': '123.50.64.0/18', | |
4800 | 'PG': '124.240.192.0/19', | |
4801 | 'PH': '49.144.0.0/13', | |
4802 | 'PK': '39.32.0.0/11', | |
4803 | 'PL': '83.0.0.0/11', | |
4804 | 'PM': '70.36.0.0/20', | |
4805 | 'PR': '66.50.0.0/16', | |
4806 | 'PS': '188.161.0.0/16', | |
4807 | 'PT': '85.240.0.0/13', | |
4808 | 'PW': '202.124.224.0/20', | |
4809 | 'PY': '181.120.0.0/14', | |
4810 | 'QA': '37.210.0.0/15', | |
53896ca5 | 4811 | 'RE': '102.35.0.0/16', |
773f291d | 4812 | 'RO': '79.112.0.0/13', |
53896ca5 | 4813 | 'RS': '93.86.0.0/15', |
773f291d | 4814 | 'RU': '5.136.0.0/13', |
53896ca5 | 4815 | 'RW': '41.186.0.0/16', |
773f291d S |
4816 | 'SA': '188.48.0.0/13', |
4817 | 'SB': '202.1.160.0/19', | |
4818 | 'SC': '154.192.0.0/11', | |
53896ca5 | 4819 | 'SD': '102.120.0.0/13', |
773f291d | 4820 | 'SE': '78.64.0.0/12', |
53896ca5 | 4821 | 'SG': '8.128.0.0/10', |
773f291d S |
4822 | 'SI': '188.196.0.0/14', |
4823 | 'SK': '78.98.0.0/15', | |
53896ca5 | 4824 | 'SL': '102.143.0.0/17', |
773f291d S |
4825 | 'SM': '89.186.32.0/19', |
4826 | 'SN': '41.82.0.0/15', | |
53896ca5 | 4827 | 'SO': '154.115.192.0/18', |
773f291d S |
4828 | 'SR': '186.179.128.0/17', |
4829 | 'SS': '105.235.208.0/21', | |
4830 | 'ST': '197.159.160.0/19', | |
4831 | 'SV': '168.243.0.0/16', | |
4832 | 'SX': '190.102.0.0/20', | |
4833 | 'SY': '5.0.0.0/16', | |
4834 | 'SZ': '41.84.224.0/19', | |
4835 | 'TC': '65.255.48.0/20', | |
4836 | 'TD': '154.68.128.0/19', | |
4837 | 'TG': '196.168.0.0/14', | |
4838 | 'TH': '171.96.0.0/13', | |
4839 | 'TJ': '85.9.128.0/18', | |
4840 | 'TK': '27.96.24.0/21', | |
4841 | 'TL': '180.189.160.0/20', | |
4842 | 'TM': '95.85.96.0/19', | |
4843 | 'TN': '197.0.0.0/11', | |
4844 | 'TO': '175.176.144.0/21', | |
4845 | 'TR': '78.160.0.0/11', | |
4846 | 'TT': '186.44.0.0/15', | |
4847 | 'TV': '202.2.96.0/19', | |
4848 | 'TW': '120.96.0.0/11', | |
4849 | 'TZ': '156.156.0.0/14', | |
53896ca5 S |
4850 | 'UA': '37.52.0.0/14', |
4851 | 'UG': '102.80.0.0/13', | |
4852 | 'US': '6.0.0.0/8', | |
773f291d | 4853 | 'UY': '167.56.0.0/13', |
53896ca5 | 4854 | 'UZ': '84.54.64.0/18', |
773f291d | 4855 | 'VA': '212.77.0.0/19', |
53896ca5 | 4856 | 'VC': '207.191.240.0/21', |
773f291d | 4857 | 'VE': '186.88.0.0/13', |
53896ca5 | 4858 | 'VG': '66.81.192.0/20', |
773f291d S |
4859 | 'VI': '146.226.0.0/16', |
4860 | 'VN': '14.160.0.0/11', | |
4861 | 'VU': '202.80.32.0/20', | |
4862 | 'WF': '117.20.32.0/21', | |
4863 | 'WS': '202.4.32.0/19', | |
4864 | 'YE': '134.35.0.0/16', | |
4865 | 'YT': '41.242.116.0/22', | |
4866 | 'ZA': '41.0.0.0/11', | |
53896ca5 S |
4867 | 'ZM': '102.144.0.0/13', |
4868 | 'ZW': '102.177.192.0/18', | |
773f291d S |
4869 | } |
4870 | ||
4871 | @classmethod | |
5f95927a S |
4872 | def random_ipv4(cls, code_or_block): |
4873 | if len(code_or_block) == 2: | |
4874 | block = cls._country_ip_map.get(code_or_block.upper()) | |
4875 | if not block: | |
4876 | return None | |
4877 | else: | |
4878 | block = code_or_block | |
773f291d | 4879 | addr, preflen = block.split('/') |
ac668111 | 4880 | addr_min = struct.unpack('!L', socket.inet_aton(addr))[0] |
773f291d | 4881 | addr_max = addr_min | (0xffffffff >> int(preflen)) |
14f25df2 | 4882 | return str(socket.inet_ntoa( |
ac668111 | 4883 | struct.pack('!L', random.randint(addr_min, addr_max)))) |
773f291d S |
4884 | |
4885 | ||
ac668111 | 4886 | class PerRequestProxyHandler(urllib.request.ProxyHandler): |
2461f79d PH |
4887 | def __init__(self, proxies=None): |
4888 | # Set default handlers | |
4889 | for type in ('http', 'https'): | |
4890 | setattr(self, '%s_open' % type, | |
4891 | lambda r, proxy='__noproxy__', type=type, meth=self.proxy_open: | |
4892 | meth(r, proxy, type)) | |
ac668111 | 4893 | urllib.request.ProxyHandler.__init__(self, proxies) |
2461f79d | 4894 | |
91410c9b | 4895 | def proxy_open(self, req, proxy, type): |
2461f79d | 4896 | req_proxy = req.headers.get('Ytdl-request-proxy') |
91410c9b PH |
4897 | if req_proxy is not None: |
4898 | proxy = req_proxy | |
2461f79d PH |
4899 | del req.headers['Ytdl-request-proxy'] |
4900 | ||
4901 | if proxy == '__noproxy__': | |
4902 | return None # No Proxy | |
14f25df2 | 4903 | if urllib.parse.urlparse(proxy).scheme.lower() in ('socks', 'socks4', 'socks4a', 'socks5'): |
71aff188 | 4904 | req.add_header('Ytdl-socks-proxy', proxy) |
7a5c1cfe | 4905 | # yt-dlp's http/https handlers do wrapping the socket with socks |
71aff188 | 4906 | return None |
ac668111 | 4907 | return urllib.request.ProxyHandler.proxy_open( |
91410c9b | 4908 | self, req, proxy, type) |
5bc880b9 YCH |
4909 | |
4910 | ||
0a5445dd YCH |
4911 | # Both long_to_bytes and bytes_to_long are adapted from PyCrypto, which is |
4912 | # released into Public Domain | |
4913 | # https://github.com/dlitz/pycrypto/blob/master/lib/Crypto/Util/number.py#L387 | |
4914 | ||
4915 | def long_to_bytes(n, blocksize=0): | |
4916 | """long_to_bytes(n:long, blocksize:int) : string | |
4917 | Convert a long integer to a byte string. | |
4918 | ||
4919 | If optional blocksize is given and greater than zero, pad the front of the | |
4920 | byte string with binary zeros so that the length is a multiple of | |
4921 | blocksize. | |
4922 | """ | |
4923 | # after much testing, this algorithm was deemed to be the fastest | |
4924 | s = b'' | |
4925 | n = int(n) | |
4926 | while n > 0: | |
ac668111 | 4927 | s = struct.pack('>I', n & 0xffffffff) + s |
0a5445dd YCH |
4928 | n = n >> 32 |
4929 | # strip off leading zeros | |
4930 | for i in range(len(s)): | |
4931 | if s[i] != b'\000'[0]: | |
4932 | break | |
4933 | else: | |
4934 | # only happens when n == 0 | |
4935 | s = b'\000' | |
4936 | i = 0 | |
4937 | s = s[i:] | |
4938 | # add back some pad bytes. this could be done more efficiently w.r.t. the | |
4939 | # de-padding being done above, but sigh... | |
4940 | if blocksize > 0 and len(s) % blocksize: | |
4941 | s = (blocksize - len(s) % blocksize) * b'\000' + s | |
4942 | return s | |
4943 | ||
4944 | ||
4945 | def bytes_to_long(s): | |
4946 | """bytes_to_long(string) : long | |
4947 | Convert a byte string to a long integer. | |
4948 | ||
4949 | This is (essentially) the inverse of long_to_bytes(). | |
4950 | """ | |
4951 | acc = 0 | |
4952 | length = len(s) | |
4953 | if length % 4: | |
4954 | extra = (4 - length % 4) | |
4955 | s = b'\000' * extra + s | |
4956 | length = length + extra | |
4957 | for i in range(0, length, 4): | |
ac668111 | 4958 | acc = (acc << 32) + struct.unpack('>I', s[i:i + 4])[0] |
0a5445dd YCH |
4959 | return acc |
4960 | ||
4961 | ||
5bc880b9 YCH |
4962 | def ohdave_rsa_encrypt(data, exponent, modulus): |
4963 | ''' | |
4964 | Implement OHDave's RSA algorithm. See http://www.ohdave.com/rsa/ | |
4965 | ||
4966 | Input: | |
4967 | data: data to encrypt, bytes-like object | |
4968 | exponent, modulus: parameter e and N of RSA algorithm, both integer | |
4969 | Output: hex string of encrypted data | |
4970 | ||
4971 | Limitation: supports one block encryption only | |
4972 | ''' | |
4973 | ||
4974 | payload = int(binascii.hexlify(data[::-1]), 16) | |
4975 | encrypted = pow(payload, exponent, modulus) | |
4976 | return '%x' % encrypted | |
81bdc8fd YCH |
4977 | |
4978 | ||
f48409c7 YCH |
4979 | def pkcs1pad(data, length): |
4980 | """ | |
4981 | Padding input data with PKCS#1 scheme | |
4982 | ||
4983 | @param {int[]} data input data | |
4984 | @param {int} length target length | |
4985 | @returns {int[]} padded data | |
4986 | """ | |
4987 | if len(data) > length - 11: | |
4988 | raise ValueError('Input data too long for PKCS#1 padding') | |
4989 | ||
4990 | pseudo_random = [random.randint(0, 254) for _ in range(length - len(data) - 3)] | |
4991 | return [0, 2] + pseudo_random + [0] + data | |
4992 | ||
4993 | ||
7b2c3f47 | 4994 | def _base_n_table(n, table): |
4995 | if not table and not n: | |
4996 | raise ValueError('Either table or n must be specified') | |
612f2be5 | 4997 | table = (table or '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ')[:n] |
4998 | ||
44f14eb4 | 4999 | if n and n != len(table): |
612f2be5 | 5000 | raise ValueError(f'base {n} exceeds table length {len(table)}') |
5001 | return table | |
59f898b7 | 5002 | |
5eb6bdce | 5003 | |
7b2c3f47 | 5004 | def encode_base_n(num, n=None, table=None): |
5005 | """Convert given int to a base-n string""" | |
612f2be5 | 5006 | table = _base_n_table(n, table) |
7b2c3f47 | 5007 | if not num: |
5eb6bdce YCH |
5008 | return table[0] |
5009 | ||
7b2c3f47 | 5010 | result, base = '', len(table) |
81bdc8fd | 5011 | while num: |
7b2c3f47 | 5012 | result = table[num % base] + result |
612f2be5 | 5013 | num = num // base |
7b2c3f47 | 5014 | return result |
5015 | ||
5016 | ||
5017 | def decode_base_n(string, n=None, table=None): | |
5018 | """Convert given base-n string to int""" | |
5019 | table = {char: index for index, char in enumerate(_base_n_table(n, table))} | |
5020 | result, base = 0, len(table) | |
5021 | for char in string: | |
5022 | result = result * base + table[char] | |
5023 | return result | |
5024 | ||
5025 | ||
5026 | def decode_base(value, digits): | |
da4db748 | 5027 | deprecation_warning(f'{__name__}.decode_base is deprecated and may be removed ' |
5028 | f'in a future version. Use {__name__}.decode_base_n instead') | |
7b2c3f47 | 5029 | return decode_base_n(value, table=digits) |
f52354a8 YCH |
5030 | |
5031 | ||
5032 | def decode_packed_codes(code): | |
06b3fe29 | 5033 | mobj = re.search(PACKED_CODES_RE, code) |
a0566bbf | 5034 | obfuscated_code, base, count, symbols = mobj.groups() |
f52354a8 YCH |
5035 | base = int(base) |
5036 | count = int(count) | |
5037 | symbols = symbols.split('|') | |
5038 | symbol_table = {} | |
5039 | ||
5040 | while count: | |
5041 | count -= 1 | |
5eb6bdce | 5042 | base_n_count = encode_base_n(count, base) |
f52354a8 YCH |
5043 | symbol_table[base_n_count] = symbols[count] or base_n_count |
5044 | ||
5045 | return re.sub( | |
5046 | r'\b(\w+)\b', lambda mobj: symbol_table[mobj.group(0)], | |
a0566bbf | 5047 | obfuscated_code) |
e154c651 | 5048 | |
5049 | ||
1ced2221 S |
5050 | def caesar(s, alphabet, shift): |
5051 | if shift == 0: | |
5052 | return s | |
5053 | l = len(alphabet) | |
5054 | return ''.join( | |
5055 | alphabet[(alphabet.index(c) + shift) % l] if c in alphabet else c | |
5056 | for c in s) | |
5057 | ||
5058 | ||
5059 | def rot47(s): | |
5060 | return caesar(s, r'''!"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~''', 47) | |
5061 | ||
5062 | ||
e154c651 | 5063 | def parse_m3u8_attributes(attrib): |
5064 | info = {} | |
5065 | for (key, val) in re.findall(r'(?P<key>[A-Z0-9-]+)=(?P<val>"[^"]+"|[^",]+)(?:,|$)', attrib): | |
5066 | if val.startswith('"'): | |
5067 | val = val[1:-1] | |
5068 | info[key] = val | |
5069 | return info | |
1143535d YCH |
5070 | |
5071 | ||
5072 | def urshift(val, n): | |
5073 | return val >> n if val >= 0 else (val + 0x100000000) >> n | |
d3f8e038 YCH |
5074 | |
5075 | ||
5076 | # Based on png2str() written by @gdkchan and improved by @yokrysty | |
067aa17e | 5077 | # Originally posted at https://github.com/ytdl-org/youtube-dl/issues/9706 |
d3f8e038 YCH |
5078 | def decode_png(png_data): |
5079 | # Reference: https://www.w3.org/TR/PNG/ | |
5080 | header = png_data[8:] | |
5081 | ||
5082 | if png_data[:8] != b'\x89PNG\x0d\x0a\x1a\x0a' or header[4:8] != b'IHDR': | |
86e5f3ed | 5083 | raise OSError('Not a valid PNG file.') |
d3f8e038 YCH |
5084 | |
5085 | int_map = {1: '>B', 2: '>H', 4: '>I'} | |
ac668111 | 5086 | unpack_integer = lambda x: struct.unpack(int_map[len(x)], x)[0] |
d3f8e038 YCH |
5087 | |
5088 | chunks = [] | |
5089 | ||
5090 | while header: | |
5091 | length = unpack_integer(header[:4]) | |
5092 | header = header[4:] | |
5093 | ||
5094 | chunk_type = header[:4] | |
5095 | header = header[4:] | |
5096 | ||
5097 | chunk_data = header[:length] | |
5098 | header = header[length:] | |
5099 | ||
5100 | header = header[4:] # Skip CRC | |
5101 | ||
5102 | chunks.append({ | |
5103 | 'type': chunk_type, | |
5104 | 'length': length, | |
5105 | 'data': chunk_data | |
5106 | }) | |
5107 | ||
5108 | ihdr = chunks[0]['data'] | |
5109 | ||
5110 | width = unpack_integer(ihdr[:4]) | |
5111 | height = unpack_integer(ihdr[4:8]) | |
5112 | ||
5113 | idat = b'' | |
5114 | ||
5115 | for chunk in chunks: | |
5116 | if chunk['type'] == b'IDAT': | |
5117 | idat += chunk['data'] | |
5118 | ||
5119 | if not idat: | |
86e5f3ed | 5120 | raise OSError('Unable to read PNG data.') |
d3f8e038 YCH |
5121 | |
5122 | decompressed_data = bytearray(zlib.decompress(idat)) | |
5123 | ||
5124 | stride = width * 3 | |
5125 | pixels = [] | |
5126 | ||
5127 | def _get_pixel(idx): | |
5128 | x = idx % stride | |
5129 | y = idx // stride | |
5130 | return pixels[y][x] | |
5131 | ||
5132 | for y in range(height): | |
5133 | basePos = y * (1 + stride) | |
5134 | filter_type = decompressed_data[basePos] | |
5135 | ||
5136 | current_row = [] | |
5137 | ||
5138 | pixels.append(current_row) | |
5139 | ||
5140 | for x in range(stride): | |
5141 | color = decompressed_data[1 + basePos + x] | |
5142 | basex = y * stride + x | |
5143 | left = 0 | |
5144 | up = 0 | |
5145 | ||
5146 | if x > 2: | |
5147 | left = _get_pixel(basex - 3) | |
5148 | if y > 0: | |
5149 | up = _get_pixel(basex - stride) | |
5150 | ||
5151 | if filter_type == 1: # Sub | |
5152 | color = (color + left) & 0xff | |
5153 | elif filter_type == 2: # Up | |
5154 | color = (color + up) & 0xff | |
5155 | elif filter_type == 3: # Average | |
5156 | color = (color + ((left + up) >> 1)) & 0xff | |
5157 | elif filter_type == 4: # Paeth | |
5158 | a = left | |
5159 | b = up | |
5160 | c = 0 | |
5161 | ||
5162 | if x > 2 and y > 0: | |
5163 | c = _get_pixel(basex - stride - 3) | |
5164 | ||
5165 | p = a + b - c | |
5166 | ||
5167 | pa = abs(p - a) | |
5168 | pb = abs(p - b) | |
5169 | pc = abs(p - c) | |
5170 | ||
5171 | if pa <= pb and pa <= pc: | |
5172 | color = (color + a) & 0xff | |
5173 | elif pb <= pc: | |
5174 | color = (color + b) & 0xff | |
5175 | else: | |
5176 | color = (color + c) & 0xff | |
5177 | ||
5178 | current_row.append(color) | |
5179 | ||
5180 | return width, height, pixels | |
efa97bdc YCH |
5181 | |
5182 | ||
5183 | def write_xattr(path, key, value): | |
6f7563be | 5184 | # Windows: Write xattrs to NTFS Alternate Data Streams: |
5185 | # http://en.wikipedia.org/wiki/NTFS#Alternate_data_streams_.28ADS.29 | |
5186 | if compat_os_name == 'nt': | |
5187 | assert ':' not in key | |
5188 | assert os.path.exists(path) | |
efa97bdc YCH |
5189 | |
5190 | try: | |
6f7563be | 5191 | with open(f'{path}:{key}', 'wb') as f: |
5192 | f.write(value) | |
86e5f3ed | 5193 | except OSError as e: |
efa97bdc | 5194 | raise XAttrMetadataError(e.errno, e.strerror) |
6f7563be | 5195 | return |
efa97bdc | 5196 | |
6f7563be | 5197 | # UNIX Method 1. Use xattrs/pyxattrs modules |
efa97bdc | 5198 | |
6f7563be | 5199 | setxattr = None |
5200 | if getattr(xattr, '_yt_dlp__identifier', None) == 'pyxattr': | |
5201 | # Unicode arguments are not supported in pyxattr until version 0.5.0 | |
5202 | # See https://github.com/ytdl-org/youtube-dl/issues/5498 | |
5203 | if version_tuple(xattr.__version__) >= (0, 5, 0): | |
5204 | setxattr = xattr.set | |
5205 | elif xattr: | |
5206 | setxattr = xattr.setxattr | |
efa97bdc | 5207 | |
6f7563be | 5208 | if setxattr: |
5209 | try: | |
5210 | setxattr(path, key, value) | |
5211 | except OSError as e: | |
5212 | raise XAttrMetadataError(e.errno, e.strerror) | |
5213 | return | |
efa97bdc | 5214 | |
6f7563be | 5215 | # UNIX Method 2. Use setfattr/xattr executables |
5216 | exe = ('setfattr' if check_executable('setfattr', ['--version']) | |
5217 | else 'xattr' if check_executable('xattr', ['-h']) else None) | |
5218 | if not exe: | |
5219 | raise XAttrUnavailableError( | |
5220 | 'Couldn\'t find a tool to set the xattrs. Install either the python "xattr" or "pyxattr" modules or the ' | |
5221 | + ('"xattr" binary' if sys.platform != 'linux' else 'GNU "attr" package (which contains the "setfattr" tool)')) | |
efa97bdc | 5222 | |
0f06bcd7 | 5223 | value = value.decode() |
6f7563be | 5224 | try: |
f0c9fb96 | 5225 | _, stderr, returncode = Popen.run( |
6f7563be | 5226 | [exe, '-w', key, value, path] if exe == 'xattr' else [exe, '-n', key, '-v', value, path], |
e121e3ce | 5227 | text=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE, stdin=subprocess.PIPE) |
6f7563be | 5228 | except OSError as e: |
5229 | raise XAttrMetadataError(e.errno, e.strerror) | |
f0c9fb96 | 5230 | if returncode: |
5231 | raise XAttrMetadataError(returncode, stderr) | |
0c265486 YCH |
5232 | |
5233 | ||
5234 | def random_birthday(year_field, month_field, day_field): | |
aa374bc7 AS |
5235 | start_date = datetime.date(1950, 1, 1) |
5236 | end_date = datetime.date(1995, 12, 31) | |
5237 | offset = random.randint(0, (end_date - start_date).days) | |
5238 | random_date = start_date + datetime.timedelta(offset) | |
0c265486 | 5239 | return { |
aa374bc7 AS |
5240 | year_field: str(random_date.year), |
5241 | month_field: str(random_date.month), | |
5242 | day_field: str(random_date.day), | |
0c265486 | 5243 | } |
732044af | 5244 | |
c76eb41b | 5245 | |
8c53322c L |
5246 | def find_available_port(interface=''): |
5247 | try: | |
5248 | with socket.socket() as sock: | |
5249 | sock.bind((interface, 0)) | |
5250 | return sock.getsockname()[1] | |
5251 | except OSError: | |
5252 | return None | |
5253 | ||
5254 | ||
732044af | 5255 | # Templates for internet shortcut files, which are plain text files. |
e5a998f3 | 5256 | DOT_URL_LINK_TEMPLATE = '''\ |
732044af | 5257 | [InternetShortcut] |
5258 | URL=%(url)s | |
e5a998f3 | 5259 | ''' |
732044af | 5260 | |
e5a998f3 | 5261 | DOT_WEBLOC_LINK_TEMPLATE = '''\ |
732044af | 5262 | <?xml version="1.0" encoding="UTF-8"?> |
5263 | <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"> | |
5264 | <plist version="1.0"> | |
5265 | <dict> | |
5266 | \t<key>URL</key> | |
5267 | \t<string>%(url)s</string> | |
5268 | </dict> | |
5269 | </plist> | |
e5a998f3 | 5270 | ''' |
732044af | 5271 | |
e5a998f3 | 5272 | DOT_DESKTOP_LINK_TEMPLATE = '''\ |
732044af | 5273 | [Desktop Entry] |
5274 | Encoding=UTF-8 | |
5275 | Name=%(filename)s | |
5276 | Type=Link | |
5277 | URL=%(url)s | |
5278 | Icon=text-html | |
e5a998f3 | 5279 | ''' |
732044af | 5280 | |
08438d2c | 5281 | LINK_TEMPLATES = { |
5282 | 'url': DOT_URL_LINK_TEMPLATE, | |
5283 | 'desktop': DOT_DESKTOP_LINK_TEMPLATE, | |
5284 | 'webloc': DOT_WEBLOC_LINK_TEMPLATE, | |
5285 | } | |
5286 | ||
732044af | 5287 | |
5288 | def iri_to_uri(iri): | |
5289 | """ | |
5290 | Converts an IRI (Internationalized Resource Identifier, allowing Unicode characters) to a URI (Uniform Resource Identifier, ASCII-only). | |
5291 | ||
5292 | The function doesn't add an additional layer of escaping; e.g., it doesn't escape `%3C` as `%253C`. Instead, it percent-escapes characters with an underlying UTF-8 encoding *besides* those already escaped, leaving the URI intact. | |
5293 | """ | |
5294 | ||
14f25df2 | 5295 | iri_parts = urllib.parse.urlparse(iri) |
732044af | 5296 | |
5297 | if '[' in iri_parts.netloc: | |
5298 | raise ValueError('IPv6 URIs are not, yet, supported.') | |
5299 | # Querying `.netloc`, when there's only one bracket, also raises a ValueError. | |
5300 | ||
5301 | # The `safe` argument values, that the following code uses, contain the characters that should not be percent-encoded. Everything else but letters, digits and '_.-' will be percent-encoded with an underlying UTF-8 encoding. Everything already percent-encoded will be left as is. | |
5302 | ||
5303 | net_location = '' | |
5304 | if iri_parts.username: | |
f9934b96 | 5305 | net_location += urllib.parse.quote(iri_parts.username, safe=r"!$%&'()*+,~") |
732044af | 5306 | if iri_parts.password is not None: |
f9934b96 | 5307 | net_location += ':' + urllib.parse.quote(iri_parts.password, safe=r"!$%&'()*+,~") |
732044af | 5308 | net_location += '@' |
5309 | ||
0f06bcd7 | 5310 | net_location += iri_parts.hostname.encode('idna').decode() # Punycode for Unicode hostnames. |
732044af | 5311 | # The 'idna' encoding produces ASCII text. |
5312 | if iri_parts.port is not None and iri_parts.port != 80: | |
5313 | net_location += ':' + str(iri_parts.port) | |
5314 | ||
f9934b96 | 5315 | return urllib.parse.urlunparse( |
732044af | 5316 | (iri_parts.scheme, |
5317 | net_location, | |
5318 | ||
f9934b96 | 5319 | urllib.parse.quote_plus(iri_parts.path, safe=r"!$%&'()*+,/:;=@|~"), |
732044af | 5320 | |
5321 | # Unsure about the `safe` argument, since this is a legacy way of handling parameters. | |
f9934b96 | 5322 | urllib.parse.quote_plus(iri_parts.params, safe=r"!$%&'()*+,/:;=@|~"), |
732044af | 5323 | |
5324 | # Not totally sure about the `safe` argument, since the source does not explicitly mention the query URI component. | |
f9934b96 | 5325 | urllib.parse.quote_plus(iri_parts.query, safe=r"!$%&'()*+,/:;=?@{|}~"), |
732044af | 5326 | |
f9934b96 | 5327 | urllib.parse.quote_plus(iri_parts.fragment, safe=r"!#$%&'()*+,/:;=?@{|}~"))) |
732044af | 5328 | |
5329 | # Source for `safe` arguments: https://url.spec.whatwg.org/#percent-encoded-bytes. | |
5330 | ||
5331 | ||
5332 | def to_high_limit_path(path): | |
5333 | if sys.platform in ['win32', 'cygwin']: | |
5334 | # Work around MAX_PATH limitation on Windows. The maximum allowed length for the individual path segments may still be quite limited. | |
e5a998f3 | 5335 | return '\\\\?\\' + os.path.abspath(path) |
732044af | 5336 | |
5337 | return path | |
76d321f6 | 5338 | |
c76eb41b | 5339 | |
7b2c3f47 | 5340 | def format_field(obj, field=None, template='%s', ignore=NO_DEFAULT, default='', func=IDENTITY): |
e0ddbd02 | 5341 | val = traverse_obj(obj, *variadic(field)) |
7b2c3f47 | 5342 | if (not val and val != 0) if ignore is NO_DEFAULT else val in variadic(ignore): |
e0ddbd02 | 5343 | return default |
7b2c3f47 | 5344 | return template % func(val) |
00dd0cd5 | 5345 | |
5346 | ||
5347 | def clean_podcast_url(url): | |
5348 | return re.sub(r'''(?x) | |
5349 | (?: | |
5350 | (?: | |
5351 | chtbl\.com/track| | |
5352 | media\.blubrry\.com| # https://create.blubrry.com/resources/podcast-media-download-statistics/getting-started/ | |
5353 | play\.podtrac\.com | |
5354 | )/[^/]+| | |
5355 | (?:dts|www)\.podtrac\.com/(?:pts/)?redirect\.[0-9a-z]{3,4}| # http://analytics.podtrac.com/how-to-measure | |
5356 | flex\.acast\.com| | |
5357 | pd(?: | |
5358 | cn\.co| # https://podcorn.com/analytics-prefix/ | |
5359 | st\.fm # https://podsights.com/docs/ | |
5360 | )/e | |
5361 | )/''', '', url) | |
ffcb8191 THD |
5362 | |
5363 | ||
5364 | _HEX_TABLE = '0123456789abcdef' | |
5365 | ||
5366 | ||
5367 | def random_uuidv4(): | |
5368 | return re.sub(r'[xy]', lambda x: _HEX_TABLE[random.randint(0, 15)], 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx') | |
0202b52a | 5369 | |
5370 | ||
5371 | def make_dir(path, to_screen=None): | |
5372 | try: | |
5373 | dn = os.path.dirname(path) | |
5374 | if dn and not os.path.exists(dn): | |
5375 | os.makedirs(dn) | |
5376 | return True | |
86e5f3ed | 5377 | except OSError as err: |
0202b52a | 5378 | if callable(to_screen) is not None: |
5379 | to_screen('unable to create directory ' + error_to_compat_str(err)) | |
5380 | return False | |
f74980cb | 5381 | |
5382 | ||
5383 | def get_executable_path(): | |
b5899f4f | 5384 | from .update import _get_variant_and_executable_path |
c487cf00 | 5385 | |
b5899f4f | 5386 | return os.path.dirname(os.path.abspath(_get_variant_and_executable_path()[1])) |
f74980cb | 5387 | |
5388 | ||
8e40b9d1 | 5389 | def get_user_config_dirs(package_name): |
8e40b9d1 M |
5390 | # .config (e.g. ~/.config/package_name) |
5391 | xdg_config_home = os.getenv('XDG_CONFIG_HOME') or compat_expanduser('~/.config') | |
773c272d | 5392 | yield os.path.join(xdg_config_home, package_name) |
8e40b9d1 M |
5393 | |
5394 | # appdata (%APPDATA%/package_name) | |
5395 | appdata_dir = os.getenv('appdata') | |
5396 | if appdata_dir: | |
773c272d | 5397 | yield os.path.join(appdata_dir, package_name) |
8e40b9d1 M |
5398 | |
5399 | # home (~/.package_name) | |
773c272d | 5400 | yield os.path.join(compat_expanduser('~'), f'.{package_name}') |
8e40b9d1 M |
5401 | |
5402 | ||
5403 | def get_system_config_dirs(package_name): | |
8e40b9d1 | 5404 | # /etc/package_name |
773c272d | 5405 | yield os.path.join('/etc', package_name) |
06167fbb | 5406 | |
5407 | ||
325ebc17 | 5408 | def traverse_obj( |
f99bbfc9 | 5409 | obj, *paths, default=NO_DEFAULT, expected_type=None, get_all=True, |
325ebc17 | 5410 | casesense=True, is_user_input=False, traverse_string=False): |
ab029d7e SS |
5411 | """ |
5412 | Safely traverse nested `dict`s and `Sequence`s | |
5413 | ||
5414 | >>> obj = [{}, {"key": "value"}] | |
5415 | >>> traverse_obj(obj, (1, "key")) | |
5416 | "value" | |
5417 | ||
5418 | Each of the provided `paths` is tested and the first producing a valid result will be returned. | |
f99bbfc9 | 5419 | The next path will also be tested if the path branched but no results could be found. |
7b0127e1 | 5420 | Supported values for traversal are `Mapping`, `Sequence` and `re.Match`. |
ab029d7e SS |
5421 | A value of None is treated as the absence of a value. |
5422 | ||
5423 | The paths will be wrapped in `variadic`, so that `'key'` is conveniently the same as `('key', )`. | |
5424 | ||
5425 | The keys in the path can be one of: | |
5426 | - `None`: Return the current object. | |
8e174ba7 | 5427 | - `str`/`int`: Return `obj[key]`. For `re.Match`, return `obj.group(key)`. |
ab029d7e SS |
5428 | - `slice`: Branch out and return all values in `obj[key]`. |
5429 | - `Ellipsis`: Branch out and return a list of all values. | |
5430 | - `tuple`/`list`: Branch out and return a list of all matching values. | |
5431 | Read as: `[traverse_obj(obj, branch) for branch in branches]`. | |
5432 | - `function`: Branch out and return values filtered by the function. | |
5433 | Read as: `[value for key, value in obj if function(key, value)]`. | |
5434 | For `Sequence`s, `key` is the index of the value. | |
5435 | - `dict` Transform the current object and return a matching dict. | |
5436 | Read as: `{key: traverse_obj(obj, path) for key, path in dct.items()}`. | |
5437 | ||
7b0127e1 | 5438 | `tuple`, `list`, and `dict` all support nested paths and branches. |
ab029d7e SS |
5439 | |
5440 | @params paths Paths which to traverse by. | |
5441 | @param default Value to return if the paths do not match. | |
5442 | @param expected_type If a `type`, only accept final values of this type. | |
5443 | If any other callable, try to call the function on each result. | |
5444 | @param get_all If `False`, return the first matching result, otherwise all matching ones. | |
5445 | @param casesense If `False`, consider string dictionary keys as case insensitive. | |
5446 | ||
5447 | The following are only meant to be used by YoutubeDL.prepare_outtmpl and are not part of the API | |
5448 | ||
5449 | @param is_user_input Whether the keys are generated from user input. | |
5450 | If `True` strings get converted to `int`/`slice` if needed. | |
5451 | @param traverse_string Whether to traverse into objects as strings. | |
5452 | If `True`, any non-compatible object will first be | |
5453 | converted into a string and then traversed into. | |
5454 | ||
5455 | ||
5456 | @returns The result of the object traversal. | |
5457 | If successful, `get_all=True`, and the path branches at least once, | |
5458 | then a list of results is returned instead. | |
f99bbfc9 | 5459 | A list is always returned if the last path branches and no `default` is given. |
ab029d7e SS |
5460 | """ |
5461 | is_sequence = lambda x: isinstance(x, collections.abc.Sequence) and not isinstance(x, (str, bytes)) | |
5462 | casefold = lambda k: k.casefold() if isinstance(k, str) else k | |
325ebc17 | 5463 | |
352d63fd | 5464 | if isinstance(expected_type, type): |
5465 | type_test = lambda val: val if isinstance(val, expected_type) else None | |
352d63fd | 5466 | else: |
ab029d7e SS |
5467 | type_test = lambda val: try_call(expected_type or IDENTITY, args=(val,)) |
5468 | ||
5469 | def apply_key(key, obj): | |
5470 | if obj is None: | |
5471 | return | |
5472 | ||
5473 | elif key is None: | |
5474 | yield obj | |
5475 | ||
5476 | elif isinstance(key, (list, tuple)): | |
5477 | for branch in key: | |
5478 | _, result = apply_path(obj, branch) | |
5479 | yield from result | |
5480 | ||
5481 | elif key is ...: | |
5482 | if isinstance(obj, collections.abc.Mapping): | |
5483 | yield from obj.values() | |
5484 | elif is_sequence(obj): | |
5485 | yield from obj | |
7b0127e1 SS |
5486 | elif isinstance(obj, re.Match): |
5487 | yield from obj.groups() | |
ab029d7e SS |
5488 | elif traverse_string: |
5489 | yield from str(obj) | |
5490 | ||
5491 | elif callable(key): | |
5492 | if is_sequence(obj): | |
5493 | iter_obj = enumerate(obj) | |
5494 | elif isinstance(obj, collections.abc.Mapping): | |
5495 | iter_obj = obj.items() | |
7b0127e1 SS |
5496 | elif isinstance(obj, re.Match): |
5497 | iter_obj = enumerate((obj.group(), *obj.groups())) | |
ab029d7e SS |
5498 | elif traverse_string: |
5499 | iter_obj = enumerate(str(obj)) | |
352d63fd | 5500 | else: |
ab029d7e SS |
5501 | return |
5502 | yield from (v for k, v in iter_obj if try_call(key, args=(k, v))) | |
5503 | ||
5504 | elif isinstance(key, dict): | |
5505 | iter_obj = ((k, _traverse_obj(obj, v)) for k, v in key.items()) | |
5506 | yield {k: v if v is not None else default for k, v in iter_obj | |
f99bbfc9 | 5507 | if v is not None or default is not NO_DEFAULT} |
ab029d7e | 5508 | |
7b0127e1 | 5509 | elif isinstance(obj, collections.abc.Mapping): |
ab029d7e SS |
5510 | yield (obj.get(key) if casesense or (key in obj) |
5511 | else next((v for k, v in obj.items() if casefold(k) == key), None)) | |
5512 | ||
7b0127e1 SS |
5513 | elif isinstance(obj, re.Match): |
5514 | if isinstance(key, int) or casesense: | |
5515 | with contextlib.suppress(IndexError): | |
5516 | yield obj.group(key) | |
5517 | return | |
5518 | ||
5519 | if not isinstance(key, str): | |
5520 | return | |
5521 | ||
5522 | yield next((v for k, v in obj.groupdict().items() if casefold(k) == key), None) | |
5523 | ||
ab029d7e SS |
5524 | else: |
5525 | if is_user_input: | |
5526 | key = (int_or_none(key) if ':' not in key | |
5527 | else slice(*map(int_or_none, key.split(':')))) | |
5528 | ||
5529 | if not isinstance(key, (int, slice)): | |
5530 | return | |
5531 | ||
5532 | if not is_sequence(obj): | |
5533 | if not traverse_string: | |
5534 | return | |
5535 | obj = str(obj) | |
5536 | ||
5537 | with contextlib.suppress(IndexError): | |
5538 | yield obj[key] | |
5539 | ||
5540 | def apply_path(start_obj, path): | |
5541 | objs = (start_obj,) | |
5542 | has_branched = False | |
5543 | ||
5544 | for key in variadic(path): | |
5545 | if is_user_input and key == ':': | |
5546 | key = ... | |
5547 | ||
5548 | if not casesense and isinstance(key, str): | |
5549 | key = key.casefold() | |
5550 | ||
5551 | if key is ... or isinstance(key, (list, tuple)) or callable(key): | |
5552 | has_branched = True | |
5553 | ||
5554 | key_func = functools.partial(apply_key, key) | |
5555 | objs = itertools.chain.from_iterable(map(key_func, objs)) | |
5556 | ||
5557 | return has_branched, objs | |
5558 | ||
f99bbfc9 | 5559 | def _traverse_obj(obj, path, use_list=True): |
ab029d7e SS |
5560 | has_branched, results = apply_path(obj, path) |
5561 | results = LazyList(x for x in map(type_test, results) if x is not None) | |
ab029d7e | 5562 | |
f99bbfc9 SS |
5563 | if get_all and has_branched: |
5564 | return results.exhaust() if results or use_list else None | |
5565 | ||
5566 | return results[0] if results else None | |
5567 | ||
5568 | for index, path in enumerate(paths, 1): | |
5569 | use_list = default is NO_DEFAULT and index == len(paths) | |
5570 | result = _traverse_obj(obj, path, use_list) | |
ab029d7e SS |
5571 | if result is not None: |
5572 | return result | |
5573 | ||
f99bbfc9 | 5574 | return None if default is NO_DEFAULT else default |
324ad820 | 5575 | |
5576 | ||
5577 | def traverse_dict(dictn, keys, casesense=True): | |
da4db748 | 5578 | deprecation_warning(f'"{__name__}.traverse_dict" is deprecated and may be removed ' |
5579 | f'in a future version. Use "{__name__}.traverse_obj" instead') | |
ee8dd27a | 5580 | return traverse_obj(dictn, keys, casesense=casesense, is_user_input=True, traverse_string=True) |
6606817a | 5581 | |
5582 | ||
ff91cf74 | 5583 | def get_first(obj, keys, **kwargs): |
5584 | return traverse_obj(obj, (..., *variadic(keys)), **kwargs, get_all=False) | |
5585 | ||
5586 | ||
3e9b66d7 LNO |
5587 | def time_seconds(**kwargs): |
5588 | t = datetime.datetime.now(datetime.timezone(datetime.timedelta(**kwargs))) | |
5589 | return t.timestamp() | |
5590 | ||
5591 | ||
49fa4d9a N |
5592 | # create a JSON Web Signature (jws) with HS256 algorithm |
5593 | # the resulting format is in JWS Compact Serialization | |
5594 | # implemented following JWT https://www.rfc-editor.org/rfc/rfc7519.html | |
5595 | # implemented following JWS https://www.rfc-editor.org/rfc/rfc7515.html | |
5596 | def jwt_encode_hs256(payload_data, key, headers={}): | |
5597 | header_data = { | |
5598 | 'alg': 'HS256', | |
5599 | 'typ': 'JWT', | |
5600 | } | |
5601 | if headers: | |
5602 | header_data.update(headers) | |
0f06bcd7 | 5603 | header_b64 = base64.b64encode(json.dumps(header_data).encode()) |
5604 | payload_b64 = base64.b64encode(json.dumps(payload_data).encode()) | |
5605 | h = hmac.new(key.encode(), header_b64 + b'.' + payload_b64, hashlib.sha256) | |
49fa4d9a N |
5606 | signature_b64 = base64.b64encode(h.digest()) |
5607 | token = header_b64 + b'.' + payload_b64 + b'.' + signature_b64 | |
5608 | return token | |
819e0531 | 5609 | |
5610 | ||
16b0d7e6 | 5611 | # can be extended in future to verify the signature and parse header and return the algorithm used if it's not HS256 |
5612 | def jwt_decode_hs256(jwt): | |
5613 | header_b64, payload_b64, signature_b64 = jwt.split('.') | |
2c98d998 | 5614 | # add trailing ='s that may have been stripped, superfluous ='s are ignored |
5615 | payload_data = json.loads(base64.urlsafe_b64decode(f'{payload_b64}===')) | |
16b0d7e6 | 5616 | return payload_data |
5617 | ||
5618 | ||
53973b4d | 5619 | WINDOWS_VT_MODE = False if compat_os_name == 'nt' else None |
5620 | ||
5621 | ||
7a32c70d | 5622 | @functools.cache |
819e0531 | 5623 | def supports_terminal_sequences(stream): |
5624 | if compat_os_name == 'nt': | |
8a82af35 | 5625 | if not WINDOWS_VT_MODE: |
819e0531 | 5626 | return False |
5627 | elif not os.getenv('TERM'): | |
5628 | return False | |
5629 | try: | |
5630 | return stream.isatty() | |
5631 | except BaseException: | |
5632 | return False | |
5633 | ||
5634 | ||
c53a18f0 | 5635 | def windows_enable_vt_mode(): |
5636 | """Ref: https://bugs.python.org/issue30075 """ | |
8a82af35 | 5637 | if get_windows_version() < (10, 0, 10586): |
53973b4d | 5638 | return |
53973b4d | 5639 | |
c53a18f0 | 5640 | import ctypes |
5641 | import ctypes.wintypes | |
5642 | import msvcrt | |
5643 | ||
5644 | ENABLE_VIRTUAL_TERMINAL_PROCESSING = 0x0004 | |
5645 | ||
5646 | dll = ctypes.WinDLL('kernel32', use_last_error=False) | |
5647 | handle = os.open('CONOUT$', os.O_RDWR) | |
c53a18f0 | 5648 | try: |
5649 | h_out = ctypes.wintypes.HANDLE(msvcrt.get_osfhandle(handle)) | |
5650 | dw_original_mode = ctypes.wintypes.DWORD() | |
5651 | success = dll.GetConsoleMode(h_out, ctypes.byref(dw_original_mode)) | |
5652 | if not success: | |
5653 | raise Exception('GetConsoleMode failed') | |
5654 | ||
5655 | success = dll.SetConsoleMode(h_out, ctypes.wintypes.DWORD( | |
5656 | dw_original_mode.value | ENABLE_VIRTUAL_TERMINAL_PROCESSING)) | |
5657 | if not success: | |
5658 | raise Exception('SetConsoleMode failed') | |
c53a18f0 | 5659 | finally: |
5660 | os.close(handle) | |
53973b4d | 5661 | |
f0795149 | 5662 | global WINDOWS_VT_MODE |
5663 | WINDOWS_VT_MODE = True | |
5664 | supports_terminal_sequences.cache_clear() | |
5665 | ||
53973b4d | 5666 | |
ec11a9f4 | 5667 | _terminal_sequences_re = re.compile('\033\\[[^m]+m') |
5668 | ||
5669 | ||
5670 | def remove_terminal_sequences(string): | |
5671 | return _terminal_sequences_re.sub('', string) | |
5672 | ||
5673 | ||
5674 | def number_of_digits(number): | |
5675 | return len('%d' % number) | |
34921b43 | 5676 | |
5677 | ||
5678 | def join_nonempty(*values, delim='-', from_dict=None): | |
5679 | if from_dict is not None: | |
7b2c3f47 | 5680 | values = (traverse_obj(from_dict, variadic(v)) for v in values) |
34921b43 | 5681 | return delim.join(map(str, filter(None, values))) |
06e57990 | 5682 | |
5683 | ||
27231526 ZM |
5684 | def scale_thumbnails_to_max_format_width(formats, thumbnails, url_width_re): |
5685 | """ | |
5686 | Find the largest format dimensions in terms of video width and, for each thumbnail: | |
5687 | * Modify the URL: Match the width with the provided regex and replace with the former width | |
5688 | * Update dimensions | |
5689 | ||
5690 | This function is useful with video services that scale the provided thumbnails on demand | |
5691 | """ | |
5692 | _keys = ('width', 'height') | |
5693 | max_dimensions = max( | |
86e5f3ed | 5694 | (tuple(format.get(k) or 0 for k in _keys) for format in formats), |
27231526 ZM |
5695 | default=(0, 0)) |
5696 | if not max_dimensions[0]: | |
5697 | return thumbnails | |
5698 | return [ | |
5699 | merge_dicts( | |
5700 | {'url': re.sub(url_width_re, str(max_dimensions[0]), thumbnail['url'])}, | |
5701 | dict(zip(_keys, max_dimensions)), thumbnail) | |
5702 | for thumbnail in thumbnails | |
5703 | ] | |
5704 | ||
5705 | ||
93c8410d LNO |
5706 | def parse_http_range(range): |
5707 | """ Parse value of "Range" or "Content-Range" HTTP header into tuple. """ | |
5708 | if not range: | |
5709 | return None, None, None | |
5710 | crg = re.search(r'bytes[ =](\d+)-(\d+)?(?:/(\d+))?', range) | |
5711 | if not crg: | |
5712 | return None, None, None | |
5713 | return int(crg.group(1)), int_or_none(crg.group(2)), int_or_none(crg.group(3)) | |
5714 | ||
5715 | ||
6b9e832d | 5716 | def read_stdin(what): |
5717 | eof = 'Ctrl+Z' if compat_os_name == 'nt' else 'Ctrl+D' | |
5718 | write_string(f'Reading {what} from STDIN - EOF ({eof}) to end:\n') | |
5719 | return sys.stdin | |
5720 | ||
5721 | ||
a904a7f8 L |
5722 | def determine_file_encoding(data): |
5723 | """ | |
88f60feb | 5724 | Detect the text encoding used |
a904a7f8 L |
5725 | @returns (encoding, bytes to skip) |
5726 | """ | |
5727 | ||
88f60feb | 5728 | # BOM marks are given priority over declarations |
a904a7f8 | 5729 | for bom, enc in BOMS: |
a904a7f8 L |
5730 | if data.startswith(bom): |
5731 | return enc, len(bom) | |
5732 | ||
88f60feb | 5733 | # Strip off all null bytes to match even when UTF-16 or UTF-32 is used. |
5734 | # We ignore the endianness to get a good enough match | |
a904a7f8 | 5735 | data = data.replace(b'\0', b'') |
88f60feb | 5736 | mobj = re.match(rb'(?m)^#\s*coding\s*:\s*(\S+)\s*$', data) |
5737 | return mobj.group(1).decode() if mobj else None, 0 | |
a904a7f8 L |
5738 | |
5739 | ||
06e57990 | 5740 | class Config: |
5741 | own_args = None | |
9e491463 | 5742 | parsed_args = None |
06e57990 | 5743 | filename = None |
5744 | __initialized = False | |
5745 | ||
5746 | def __init__(self, parser, label=None): | |
9e491463 | 5747 | self.parser, self.label = parser, label |
06e57990 | 5748 | self._loaded_paths, self.configs = set(), [] |
5749 | ||
5750 | def init(self, args=None, filename=None): | |
5751 | assert not self.__initialized | |
284a60c5 | 5752 | self.own_args, self.filename = args, filename |
5753 | return self.load_configs() | |
5754 | ||
5755 | def load_configs(self): | |
65662dff | 5756 | directory = '' |
284a60c5 | 5757 | if self.filename: |
5758 | location = os.path.realpath(self.filename) | |
65662dff | 5759 | directory = os.path.dirname(location) |
06e57990 | 5760 | if location in self._loaded_paths: |
5761 | return False | |
5762 | self._loaded_paths.add(location) | |
5763 | ||
284a60c5 | 5764 | self.__initialized = True |
5765 | opts, _ = self.parser.parse_known_args(self.own_args) | |
5766 | self.parsed_args = self.own_args | |
9e491463 | 5767 | for location in opts.config_locations or []: |
6b9e832d | 5768 | if location == '-': |
1060f82f | 5769 | if location in self._loaded_paths: |
5770 | continue | |
5771 | self._loaded_paths.add(location) | |
6b9e832d | 5772 | self.append_config(shlex.split(read_stdin('options'), comments=True), label='stdin') |
5773 | continue | |
65662dff | 5774 | location = os.path.join(directory, expand_path(location)) |
06e57990 | 5775 | if os.path.isdir(location): |
5776 | location = os.path.join(location, 'yt-dlp.conf') | |
5777 | if not os.path.exists(location): | |
9e491463 | 5778 | self.parser.error(f'config location {location} does not exist') |
06e57990 | 5779 | self.append_config(self.read_file(location), location) |
5780 | return True | |
5781 | ||
5782 | def __str__(self): | |
5783 | label = join_nonempty( | |
5784 | self.label, 'config', f'"{self.filename}"' if self.filename else '', | |
5785 | delim=' ') | |
5786 | return join_nonempty( | |
5787 | self.own_args is not None and f'{label[0].upper()}{label[1:]}: {self.hide_login_info(self.own_args)}', | |
5788 | *(f'\n{c}'.replace('\n', '\n| ')[1:] for c in self.configs), | |
5789 | delim='\n') | |
5790 | ||
7a32c70d | 5791 | @staticmethod |
06e57990 | 5792 | def read_file(filename, default=[]): |
5793 | try: | |
a904a7f8 | 5794 | optionf = open(filename, 'rb') |
86e5f3ed | 5795 | except OSError: |
06e57990 | 5796 | return default # silently skip if file is not present |
a904a7f8 L |
5797 | try: |
5798 | enc, skip = determine_file_encoding(optionf.read(512)) | |
5799 | optionf.seek(skip, io.SEEK_SET) | |
5800 | except OSError: | |
5801 | enc = None # silently skip read errors | |
06e57990 | 5802 | try: |
5803 | # FIXME: https://github.com/ytdl-org/youtube-dl/commit/dfe5fa49aed02cf36ba9f743b11b0903554b5e56 | |
a904a7f8 | 5804 | contents = optionf.read().decode(enc or preferredencoding()) |
f9934b96 | 5805 | res = shlex.split(contents, comments=True) |
44a6fcff | 5806 | except Exception as err: |
5807 | raise ValueError(f'Unable to parse "{filename}": {err}') | |
06e57990 | 5808 | finally: |
5809 | optionf.close() | |
5810 | return res | |
5811 | ||
7a32c70d | 5812 | @staticmethod |
06e57990 | 5813 | def hide_login_info(opts): |
86e5f3ed | 5814 | PRIVATE_OPTS = {'-p', '--password', '-u', '--username', '--video-password', '--ap-password', '--ap-username'} |
06e57990 | 5815 | eqre = re.compile('^(?P<key>' + ('|'.join(re.escape(po) for po in PRIVATE_OPTS)) + ')=.+$') |
5816 | ||
5817 | def _scrub_eq(o): | |
5818 | m = eqre.match(o) | |
5819 | if m: | |
5820 | return m.group('key') + '=PRIVATE' | |
5821 | else: | |
5822 | return o | |
5823 | ||
5824 | opts = list(map(_scrub_eq, opts)) | |
5825 | for idx, opt in enumerate(opts): | |
5826 | if opt in PRIVATE_OPTS and idx + 1 < len(opts): | |
5827 | opts[idx + 1] = 'PRIVATE' | |
5828 | return opts | |
5829 | ||
5830 | def append_config(self, *args, label=None): | |
9e491463 | 5831 | config = type(self)(self.parser, label) |
06e57990 | 5832 | config._loaded_paths = self._loaded_paths |
5833 | if config.init(*args): | |
5834 | self.configs.append(config) | |
5835 | ||
7a32c70d | 5836 | @property |
06e57990 | 5837 | def all_args(self): |
5838 | for config in reversed(self.configs): | |
5839 | yield from config.all_args | |
9e491463 | 5840 | yield from self.parsed_args or [] |
5841 | ||
5842 | def parse_known_args(self, **kwargs): | |
5843 | return self.parser.parse_known_args(self.all_args, **kwargs) | |
06e57990 | 5844 | |
5845 | def parse_args(self): | |
9e491463 | 5846 | return self.parser.parse_args(self.all_args) |
da42679b LNO |
5847 | |
5848 | ||
d5d1df8a | 5849 | class WebSocketsWrapper: |
da42679b | 5850 | """Wraps websockets module to use in non-async scopes""" |
abfecb7b | 5851 | pool = None |
da42679b | 5852 | |
3cea3edd | 5853 | def __init__(self, url, headers=None, connect=True): |
059bc4db | 5854 | self.loop = asyncio.new_event_loop() |
9cd08050 | 5855 | # XXX: "loop" is deprecated |
5856 | self.conn = websockets.connect( | |
5857 | url, extra_headers=headers, ping_interval=None, | |
5858 | close_timeout=float('inf'), loop=self.loop, ping_timeout=float('inf')) | |
3cea3edd LNO |
5859 | if connect: |
5860 | self.__enter__() | |
15dfb392 | 5861 | atexit.register(self.__exit__, None, None, None) |
da42679b LNO |
5862 | |
5863 | def __enter__(self): | |
3cea3edd | 5864 | if not self.pool: |
9cd08050 | 5865 | self.pool = self.run_with_loop(self.conn.__aenter__(), self.loop) |
da42679b LNO |
5866 | return self |
5867 | ||
5868 | def send(self, *args): | |
5869 | self.run_with_loop(self.pool.send(*args), self.loop) | |
5870 | ||
5871 | def recv(self, *args): | |
5872 | return self.run_with_loop(self.pool.recv(*args), self.loop) | |
5873 | ||
5874 | def __exit__(self, type, value, traceback): | |
5875 | try: | |
5876 | return self.run_with_loop(self.conn.__aexit__(type, value, traceback), self.loop) | |
5877 | finally: | |
5878 | self.loop.close() | |
15dfb392 | 5879 | self._cancel_all_tasks(self.loop) |
da42679b LNO |
5880 | |
5881 | # taken from https://github.com/python/cpython/blob/3.9/Lib/asyncio/runners.py with modifications | |
5882 | # for contributors: If there's any new library using asyncio needs to be run in non-async, move these function out of this class | |
7a32c70d | 5883 | @staticmethod |
da42679b | 5884 | def run_with_loop(main, loop): |
059bc4db | 5885 | if not asyncio.iscoroutine(main): |
da42679b LNO |
5886 | raise ValueError(f'a coroutine was expected, got {main!r}') |
5887 | ||
5888 | try: | |
5889 | return loop.run_until_complete(main) | |
5890 | finally: | |
5891 | loop.run_until_complete(loop.shutdown_asyncgens()) | |
5892 | if hasattr(loop, 'shutdown_default_executor'): | |
5893 | loop.run_until_complete(loop.shutdown_default_executor()) | |
5894 | ||
7a32c70d | 5895 | @staticmethod |
da42679b | 5896 | def _cancel_all_tasks(loop): |
059bc4db | 5897 | to_cancel = asyncio.all_tasks(loop) |
da42679b LNO |
5898 | |
5899 | if not to_cancel: | |
5900 | return | |
5901 | ||
5902 | for task in to_cancel: | |
5903 | task.cancel() | |
5904 | ||
9cd08050 | 5905 | # XXX: "loop" is removed in python 3.10+ |
da42679b | 5906 | loop.run_until_complete( |
059bc4db | 5907 | asyncio.gather(*to_cancel, loop=loop, return_exceptions=True)) |
da42679b LNO |
5908 | |
5909 | for task in to_cancel: | |
5910 | if task.cancelled(): | |
5911 | continue | |
5912 | if task.exception() is not None: | |
5913 | loop.call_exception_handler({ | |
5914 | 'message': 'unhandled exception during asyncio.run() shutdown', | |
5915 | 'exception': task.exception(), | |
5916 | 'task': task, | |
5917 | }) | |
5918 | ||
5919 | ||
8b7539d2 | 5920 | def merge_headers(*dicts): |
08d30158 | 5921 | """Merge dicts of http headers case insensitively, prioritizing the latter ones""" |
76aa9913 | 5922 | return {k.title(): v for k, v in itertools.chain.from_iterable(map(dict.items, dicts))} |
28787f16 | 5923 | |
5924 | ||
b1f94422 | 5925 | def cached_method(f): |
5926 | """Cache a method""" | |
5927 | signature = inspect.signature(f) | |
5928 | ||
7a32c70d | 5929 | @functools.wraps(f) |
b1f94422 | 5930 | def wrapper(self, *args, **kwargs): |
5931 | bound_args = signature.bind(self, *args, **kwargs) | |
5932 | bound_args.apply_defaults() | |
d5d1df8a | 5933 | key = tuple(bound_args.arguments.values())[1:] |
b1f94422 | 5934 | |
6368e2e6 | 5935 | cache = vars(self).setdefault('_cached_method__cache', {}).setdefault(f.__name__, {}) |
b1f94422 | 5936 | if key not in cache: |
5937 | cache[key] = f(self, *args, **kwargs) | |
5938 | return cache[key] | |
5939 | return wrapper | |
5940 | ||
5941 | ||
28787f16 | 5942 | class classproperty: |
83cc7b8a | 5943 | """property access for class methods with optional caching""" |
5944 | def __new__(cls, func=None, *args, **kwargs): | |
5945 | if not func: | |
5946 | return functools.partial(cls, *args, **kwargs) | |
5947 | return super().__new__(cls) | |
c487cf00 | 5948 | |
83cc7b8a | 5949 | def __init__(self, func, *, cache=False): |
c487cf00 | 5950 | functools.update_wrapper(self, func) |
5951 | self.func = func | |
83cc7b8a | 5952 | self._cache = {} if cache else None |
28787f16 | 5953 | |
5954 | def __get__(self, _, cls): | |
83cc7b8a | 5955 | if self._cache is None: |
5956 | return self.func(cls) | |
5957 | elif cls not in self._cache: | |
5958 | self._cache[cls] = self.func(cls) | |
5959 | return self._cache[cls] | |
19a03940 | 5960 | |
5961 | ||
64fa820c | 5962 | class Namespace(types.SimpleNamespace): |
591bb9d3 | 5963 | """Immutable namespace""" |
591bb9d3 | 5964 | |
7896214c | 5965 | def __iter__(self): |
64fa820c | 5966 | return iter(self.__dict__.values()) |
7896214c | 5967 | |
7a32c70d | 5968 | @property |
64fa820c | 5969 | def items_(self): |
5970 | return self.__dict__.items() | |
9b8ee23b | 5971 | |
5972 | ||
8dc59305 | 5973 | MEDIA_EXTENSIONS = Namespace( |
5974 | common_video=('avi', 'flv', 'mkv', 'mov', 'mp4', 'webm'), | |
5975 | video=('3g2', '3gp', 'f4v', 'mk3d', 'divx', 'mpg', 'ogv', 'm4v', 'wmv'), | |
5976 | common_audio=('aiff', 'alac', 'flac', 'm4a', 'mka', 'mp3', 'ogg', 'opus', 'wav'), | |
fbb73833 | 5977 | audio=('aac', 'ape', 'asf', 'f4a', 'f4b', 'm4b', 'm4p', 'm4r', 'oga', 'ogx', 'spx', 'vorbis', 'wma', 'weba'), |
8dc59305 | 5978 | thumbnails=('jpg', 'png', 'webp'), |
5979 | storyboards=('mhtml', ), | |
5980 | subtitles=('srt', 'vtt', 'ass', 'lrc'), | |
5981 | manifests=('f4f', 'f4m', 'm3u8', 'smil', 'mpd'), | |
5982 | ) | |
5983 | MEDIA_EXTENSIONS.video += MEDIA_EXTENSIONS.common_video | |
5984 | MEDIA_EXTENSIONS.audio += MEDIA_EXTENSIONS.common_audio | |
5985 | ||
5986 | KNOWN_EXTENSIONS = (*MEDIA_EXTENSIONS.video, *MEDIA_EXTENSIONS.audio, *MEDIA_EXTENSIONS.manifests) | |
5987 | ||
5988 | ||
be5c1ae8 | 5989 | class RetryManager: |
5990 | """Usage: | |
5991 | for retry in RetryManager(...): | |
5992 | try: | |
5993 | ... | |
5994 | except SomeException as err: | |
5995 | retry.error = err | |
5996 | continue | |
5997 | """ | |
5998 | attempt, _error = 0, None | |
5999 | ||
6000 | def __init__(self, _retries, _error_callback, **kwargs): | |
6001 | self.retries = _retries or 0 | |
6002 | self.error_callback = functools.partial(_error_callback, **kwargs) | |
6003 | ||
6004 | def _should_retry(self): | |
6005 | return self._error is not NO_DEFAULT and self.attempt <= self.retries | |
6006 | ||
7a32c70d | 6007 | @property |
be5c1ae8 | 6008 | def error(self): |
6009 | if self._error is NO_DEFAULT: | |
6010 | return None | |
6011 | return self._error | |
6012 | ||
7a32c70d | 6013 | @error.setter |
be5c1ae8 | 6014 | def error(self, value): |
6015 | self._error = value | |
6016 | ||
6017 | def __iter__(self): | |
6018 | while self._should_retry(): | |
6019 | self.error = NO_DEFAULT | |
6020 | self.attempt += 1 | |
6021 | yield self | |
6022 | if self.error: | |
6023 | self.error_callback(self.error, self.attempt, self.retries) | |
6024 | ||
7a32c70d | 6025 | @staticmethod |
be5c1ae8 | 6026 | def report_retry(e, count, retries, *, sleep_func, info, warn, error=None, suffix=None): |
6027 | """Utility function for reporting retries""" | |
6028 | if count > retries: | |
6029 | if error: | |
6030 | return error(f'{e}. Giving up after {count - 1} retries') if count > 1 else error(str(e)) | |
6031 | raise e | |
6032 | ||
6033 | if not count: | |
6034 | return warn(e) | |
6035 | elif isinstance(e, ExtractorError): | |
3ce29336 | 6036 | e = remove_end(str_or_none(e.cause) or e.orig_msg, '.') |
be5c1ae8 | 6037 | warn(f'{e}. Retrying{format_field(suffix, None, " %s")} ({count}/{retries})...') |
6038 | ||
6039 | delay = float_or_none(sleep_func(n=count - 1)) if callable(sleep_func) else sleep_func | |
6040 | if delay: | |
6041 | info(f'Sleeping {delay:.2f} seconds ...') | |
6042 | time.sleep(delay) | |
6043 | ||
6044 | ||
0647d925 | 6045 | def make_archive_id(ie, video_id): |
6046 | ie_key = ie if isinstance(ie, str) else ie.ie_key() | |
6047 | return f'{ie_key.lower()} {video_id}' | |
6048 | ||
6049 | ||
a1c5bd82 | 6050 | def truncate_string(s, left, right=0): |
6051 | assert left > 3 and right >= 0 | |
6052 | if s is None or len(s) <= left + right: | |
6053 | return s | |
71df9b7f | 6054 | return f'{s[:left-3]}...{s[-right:] if right else ""}' |
a1c5bd82 | 6055 | |
6056 | ||
5314b521 | 6057 | def orderedSet_from_options(options, alias_dict, *, use_regex=False, start=None): |
6058 | assert 'all' in alias_dict, '"all" alias is required' | |
6059 | requested = list(start or []) | |
6060 | for val in options: | |
6061 | discard = val.startswith('-') | |
6062 | if discard: | |
6063 | val = val[1:] | |
6064 | ||
6065 | if val in alias_dict: | |
6066 | val = alias_dict[val] if not discard else [ | |
6067 | i[1:] if i.startswith('-') else f'-{i}' for i in alias_dict[val]] | |
6068 | # NB: Do not allow regex in aliases for performance | |
6069 | requested = orderedSet_from_options(val, alias_dict, start=requested) | |
6070 | continue | |
6071 | ||
6072 | current = (filter(re.compile(val, re.I).fullmatch, alias_dict['all']) if use_regex | |
6073 | else [val] if val in alias_dict['all'] else None) | |
6074 | if current is None: | |
6075 | raise ValueError(val) | |
6076 | ||
6077 | if discard: | |
6078 | for item in current: | |
6079 | while item in requested: | |
6080 | requested.remove(item) | |
6081 | else: | |
6082 | requested.extend(current) | |
6083 | ||
6084 | return orderedSet(requested) | |
6085 | ||
6086 | ||
d0d74b71 | 6087 | class FormatSorter: |
6088 | regex = r' *((?P<reverse>\+)?(?P<field>[a-zA-Z0-9_]+)((?P<separator>[~:])(?P<limit>.*?))?)? *$' | |
6089 | ||
6090 | default = ('hidden', 'aud_or_vid', 'hasvid', 'ie_pref', 'lang', 'quality', | |
6091 | 'res', 'fps', 'hdr:12', 'vcodec:vp9.2', 'channels', 'acodec', | |
6092 | 'size', 'br', 'asr', 'proto', 'ext', 'hasaud', 'source', 'id') # These must not be aliases | |
6093 | ytdl_default = ('hasaud', 'lang', 'quality', 'tbr', 'filesize', 'vbr', | |
6094 | 'height', 'width', 'proto', 'vext', 'abr', 'aext', | |
6095 | 'fps', 'fs_approx', 'source', 'id') | |
6096 | ||
6097 | settings = { | |
6098 | 'vcodec': {'type': 'ordered', 'regex': True, | |
6099 | 'order': ['av0?1', 'vp0?9.2', 'vp0?9', '[hx]265|he?vc?', '[hx]264|avc', 'vp0?8', 'mp4v|h263', 'theora', '', None, 'none']}, | |
6100 | 'acodec': {'type': 'ordered', 'regex': True, | |
71082216 | 6101 | 'order': ['[af]lac', 'wav|aiff', 'opus', 'vorbis|ogg', 'aac', 'mp?4a?', 'mp3', 'ac-?4', 'e-?a?c-?3', 'ac-?3', 'dts', '', None, 'none']}, |
d0d74b71 | 6102 | 'hdr': {'type': 'ordered', 'regex': True, 'field': 'dynamic_range', |
6103 | 'order': ['dv', '(hdr)?12', r'(hdr)?10\+', '(hdr)?10', 'hlg', '', 'sdr', None]}, | |
6104 | 'proto': {'type': 'ordered', 'regex': True, 'field': 'protocol', | |
6105 | 'order': ['(ht|f)tps', '(ht|f)tp$', 'm3u8.*', '.*dash', 'websocket_frag', 'rtmpe?', '', 'mms|rtsp', 'ws|websocket', 'f4']}, | |
6106 | 'vext': {'type': 'ordered', 'field': 'video_ext', | |
29ca4082 | 6107 | 'order': ('mp4', 'mov', 'webm', 'flv', '', 'none'), |
6108 | 'order_free': ('webm', 'mp4', 'mov', 'flv', '', 'none')}, | |
fbb73833 | 6109 | 'aext': {'type': 'ordered', 'regex': True, 'field': 'audio_ext', |
6110 | 'order': ('m4a', 'aac', 'mp3', 'ogg', 'opus', 'web[am]', '', 'none'), | |
6111 | 'order_free': ('ogg', 'opus', 'web[am]', 'mp3', 'm4a', 'aac', '', 'none')}, | |
d0d74b71 | 6112 | 'hidden': {'visible': False, 'forced': True, 'type': 'extractor', 'max': -1000}, |
6113 | 'aud_or_vid': {'visible': False, 'forced': True, 'type': 'multiple', | |
6114 | 'field': ('vcodec', 'acodec'), | |
6115 | 'function': lambda it: int(any(v != 'none' for v in it))}, | |
6116 | 'ie_pref': {'priority': True, 'type': 'extractor'}, | |
6117 | 'hasvid': {'priority': True, 'field': 'vcodec', 'type': 'boolean', 'not_in_list': ('none',)}, | |
6118 | 'hasaud': {'field': 'acodec', 'type': 'boolean', 'not_in_list': ('none',)}, | |
6119 | 'lang': {'convert': 'float', 'field': 'language_preference', 'default': -1}, | |
6120 | 'quality': {'convert': 'float', 'default': -1}, | |
6121 | 'filesize': {'convert': 'bytes'}, | |
6122 | 'fs_approx': {'convert': 'bytes', 'field': 'filesize_approx'}, | |
6123 | 'id': {'convert': 'string', 'field': 'format_id'}, | |
6124 | 'height': {'convert': 'float_none'}, | |
6125 | 'width': {'convert': 'float_none'}, | |
6126 | 'fps': {'convert': 'float_none'}, | |
6127 | 'channels': {'convert': 'float_none', 'field': 'audio_channels'}, | |
6128 | 'tbr': {'convert': 'float_none'}, | |
6129 | 'vbr': {'convert': 'float_none'}, | |
6130 | 'abr': {'convert': 'float_none'}, | |
6131 | 'asr': {'convert': 'float_none'}, | |
6132 | 'source': {'convert': 'float', 'field': 'source_preference', 'default': -1}, | |
6133 | ||
6134 | 'codec': {'type': 'combined', 'field': ('vcodec', 'acodec')}, | |
6135 | 'br': {'type': 'combined', 'field': ('tbr', 'vbr', 'abr'), 'same_limit': True}, | |
6136 | 'size': {'type': 'combined', 'same_limit': True, 'field': ('filesize', 'fs_approx')}, | |
6137 | 'ext': {'type': 'combined', 'field': ('vext', 'aext')}, | |
6138 | 'res': {'type': 'multiple', 'field': ('height', 'width'), | |
6139 | 'function': lambda it: (lambda l: min(l) if l else 0)(tuple(filter(None, it)))}, | |
6140 | ||
6141 | # Actual field names | |
6142 | 'format_id': {'type': 'alias', 'field': 'id'}, | |
6143 | 'preference': {'type': 'alias', 'field': 'ie_pref'}, | |
6144 | 'language_preference': {'type': 'alias', 'field': 'lang'}, | |
6145 | 'source_preference': {'type': 'alias', 'field': 'source'}, | |
6146 | 'protocol': {'type': 'alias', 'field': 'proto'}, | |
6147 | 'filesize_approx': {'type': 'alias', 'field': 'fs_approx'}, | |
6148 | 'audio_channels': {'type': 'alias', 'field': 'channels'}, | |
6149 | ||
6150 | # Deprecated | |
6151 | 'dimension': {'type': 'alias', 'field': 'res', 'deprecated': True}, | |
6152 | 'resolution': {'type': 'alias', 'field': 'res', 'deprecated': True}, | |
6153 | 'extension': {'type': 'alias', 'field': 'ext', 'deprecated': True}, | |
6154 | 'bitrate': {'type': 'alias', 'field': 'br', 'deprecated': True}, | |
6155 | 'total_bitrate': {'type': 'alias', 'field': 'tbr', 'deprecated': True}, | |
6156 | 'video_bitrate': {'type': 'alias', 'field': 'vbr', 'deprecated': True}, | |
6157 | 'audio_bitrate': {'type': 'alias', 'field': 'abr', 'deprecated': True}, | |
6158 | 'framerate': {'type': 'alias', 'field': 'fps', 'deprecated': True}, | |
6159 | 'filesize_estimate': {'type': 'alias', 'field': 'size', 'deprecated': True}, | |
6160 | 'samplerate': {'type': 'alias', 'field': 'asr', 'deprecated': True}, | |
6161 | 'video_ext': {'type': 'alias', 'field': 'vext', 'deprecated': True}, | |
6162 | 'audio_ext': {'type': 'alias', 'field': 'aext', 'deprecated': True}, | |
6163 | 'video_codec': {'type': 'alias', 'field': 'vcodec', 'deprecated': True}, | |
6164 | 'audio_codec': {'type': 'alias', 'field': 'acodec', 'deprecated': True}, | |
6165 | 'video': {'type': 'alias', 'field': 'hasvid', 'deprecated': True}, | |
6166 | 'has_video': {'type': 'alias', 'field': 'hasvid', 'deprecated': True}, | |
6167 | 'audio': {'type': 'alias', 'field': 'hasaud', 'deprecated': True}, | |
6168 | 'has_audio': {'type': 'alias', 'field': 'hasaud', 'deprecated': True}, | |
6169 | 'extractor': {'type': 'alias', 'field': 'ie_pref', 'deprecated': True}, | |
6170 | 'extractor_preference': {'type': 'alias', 'field': 'ie_pref', 'deprecated': True}, | |
6171 | } | |
6172 | ||
6173 | def __init__(self, ydl, field_preference): | |
6174 | self.ydl = ydl | |
6175 | self._order = [] | |
6176 | self.evaluate_params(self.ydl.params, field_preference) | |
6177 | if ydl.params.get('verbose'): | |
6178 | self.print_verbose_info(self.ydl.write_debug) | |
6179 | ||
6180 | def _get_field_setting(self, field, key): | |
6181 | if field not in self.settings: | |
6182 | if key in ('forced', 'priority'): | |
6183 | return False | |
6184 | self.ydl.deprecated_feature(f'Using arbitrary fields ({field}) for format sorting is ' | |
6185 | 'deprecated and may be removed in a future version') | |
6186 | self.settings[field] = {} | |
6187 | propObj = self.settings[field] | |
6188 | if key not in propObj: | |
6189 | type = propObj.get('type') | |
6190 | if key == 'field': | |
6191 | default = 'preference' if type == 'extractor' else (field,) if type in ('combined', 'multiple') else field | |
6192 | elif key == 'convert': | |
6193 | default = 'order' if type == 'ordered' else 'float_string' if field else 'ignore' | |
6194 | else: | |
6195 | default = {'type': 'field', 'visible': True, 'order': [], 'not_in_list': (None,)}.get(key, None) | |
6196 | propObj[key] = default | |
6197 | return propObj[key] | |
6198 | ||
6199 | def _resolve_field_value(self, field, value, convertNone=False): | |
6200 | if value is None: | |
6201 | if not convertNone: | |
6202 | return None | |
6203 | else: | |
6204 | value = value.lower() | |
6205 | conversion = self._get_field_setting(field, 'convert') | |
6206 | if conversion == 'ignore': | |
6207 | return None | |
6208 | if conversion == 'string': | |
6209 | return value | |
6210 | elif conversion == 'float_none': | |
6211 | return float_or_none(value) | |
6212 | elif conversion == 'bytes': | |
6213 | return parse_bytes(value) | |
6214 | elif conversion == 'order': | |
6215 | order_list = (self._use_free_order and self._get_field_setting(field, 'order_free')) or self._get_field_setting(field, 'order') | |
6216 | use_regex = self._get_field_setting(field, 'regex') | |
6217 | list_length = len(order_list) | |
6218 | empty_pos = order_list.index('') if '' in order_list else list_length + 1 | |
6219 | if use_regex and value is not None: | |
6220 | for i, regex in enumerate(order_list): | |
6221 | if regex and re.match(regex, value): | |
6222 | return list_length - i | |
6223 | return list_length - empty_pos # not in list | |
6224 | else: # not regex or value = None | |
6225 | return list_length - (order_list.index(value) if value in order_list else empty_pos) | |
6226 | else: | |
6227 | if value.isnumeric(): | |
6228 | return float(value) | |
6229 | else: | |
6230 | self.settings[field]['convert'] = 'string' | |
6231 | return value | |
6232 | ||
6233 | def evaluate_params(self, params, sort_extractor): | |
6234 | self._use_free_order = params.get('prefer_free_formats', False) | |
6235 | self._sort_user = params.get('format_sort', []) | |
6236 | self._sort_extractor = sort_extractor | |
6237 | ||
6238 | def add_item(field, reverse, closest, limit_text): | |
6239 | field = field.lower() | |
6240 | if field in self._order: | |
6241 | return | |
6242 | self._order.append(field) | |
6243 | limit = self._resolve_field_value(field, limit_text) | |
6244 | data = { | |
6245 | 'reverse': reverse, | |
6246 | 'closest': False if limit is None else closest, | |
6247 | 'limit_text': limit_text, | |
6248 | 'limit': limit} | |
6249 | if field in self.settings: | |
6250 | self.settings[field].update(data) | |
6251 | else: | |
6252 | self.settings[field] = data | |
6253 | ||
6254 | sort_list = ( | |
6255 | tuple(field for field in self.default if self._get_field_setting(field, 'forced')) | |
6256 | + (tuple() if params.get('format_sort_force', False) | |
6257 | else tuple(field for field in self.default if self._get_field_setting(field, 'priority'))) | |
6258 | + tuple(self._sort_user) + tuple(sort_extractor) + self.default) | |
6259 | ||
6260 | for item in sort_list: | |
6261 | match = re.match(self.regex, item) | |
6262 | if match is None: | |
6263 | raise ExtractorError('Invalid format sort string "%s" given by extractor' % item) | |
6264 | field = match.group('field') | |
6265 | if field is None: | |
6266 | continue | |
6267 | if self._get_field_setting(field, 'type') == 'alias': | |
6268 | alias, field = field, self._get_field_setting(field, 'field') | |
6269 | if self._get_field_setting(alias, 'deprecated'): | |
6270 | self.ydl.deprecated_feature(f'Format sorting alias {alias} is deprecated and may ' | |
6271 | f'be removed in a future version. Please use {field} instead') | |
6272 | reverse = match.group('reverse') is not None | |
6273 | closest = match.group('separator') == '~' | |
6274 | limit_text = match.group('limit') | |
6275 | ||
6276 | has_limit = limit_text is not None | |
6277 | has_multiple_fields = self._get_field_setting(field, 'type') == 'combined' | |
6278 | has_multiple_limits = has_limit and has_multiple_fields and not self._get_field_setting(field, 'same_limit') | |
6279 | ||
6280 | fields = self._get_field_setting(field, 'field') if has_multiple_fields else (field,) | |
6281 | limits = limit_text.split(':') if has_multiple_limits else (limit_text,) if has_limit else tuple() | |
6282 | limit_count = len(limits) | |
6283 | for (i, f) in enumerate(fields): | |
6284 | add_item(f, reverse, closest, | |
6285 | limits[i] if i < limit_count | |
6286 | else limits[0] if has_limit and not has_multiple_limits | |
6287 | else None) | |
6288 | ||
6289 | def print_verbose_info(self, write_debug): | |
6290 | if self._sort_user: | |
6291 | write_debug('Sort order given by user: %s' % ', '.join(self._sort_user)) | |
6292 | if self._sort_extractor: | |
6293 | write_debug('Sort order given by extractor: %s' % ', '.join(self._sort_extractor)) | |
6294 | write_debug('Formats sorted by: %s' % ', '.join(['%s%s%s' % ( | |
6295 | '+' if self._get_field_setting(field, 'reverse') else '', field, | |
6296 | '%s%s(%s)' % ('~' if self._get_field_setting(field, 'closest') else ':', | |
6297 | self._get_field_setting(field, 'limit_text'), | |
6298 | self._get_field_setting(field, 'limit')) | |
6299 | if self._get_field_setting(field, 'limit_text') is not None else '') | |
6300 | for field in self._order if self._get_field_setting(field, 'visible')])) | |
6301 | ||
6302 | def _calculate_field_preference_from_value(self, format, field, type, value): | |
6303 | reverse = self._get_field_setting(field, 'reverse') | |
6304 | closest = self._get_field_setting(field, 'closest') | |
6305 | limit = self._get_field_setting(field, 'limit') | |
6306 | ||
6307 | if type == 'extractor': | |
6308 | maximum = self._get_field_setting(field, 'max') | |
6309 | if value is None or (maximum is not None and value >= maximum): | |
6310 | value = -1 | |
6311 | elif type == 'boolean': | |
6312 | in_list = self._get_field_setting(field, 'in_list') | |
6313 | not_in_list = self._get_field_setting(field, 'not_in_list') | |
6314 | value = 0 if ((in_list is None or value in in_list) and (not_in_list is None or value not in not_in_list)) else -1 | |
6315 | elif type == 'ordered': | |
6316 | value = self._resolve_field_value(field, value, True) | |
6317 | ||
6318 | # try to convert to number | |
6319 | val_num = float_or_none(value, default=self._get_field_setting(field, 'default')) | |
6320 | is_num = self._get_field_setting(field, 'convert') != 'string' and val_num is not None | |
6321 | if is_num: | |
6322 | value = val_num | |
6323 | ||
6324 | return ((-10, 0) if value is None | |
6325 | else (1, value, 0) if not is_num # if a field has mixed strings and numbers, strings are sorted higher | |
6326 | else (0, -abs(value - limit), value - limit if reverse else limit - value) if closest | |
6327 | else (0, value, 0) if not reverse and (limit is None or value <= limit) | |
6328 | else (0, -value, 0) if limit is None or (reverse and value == limit) or value > limit | |
6329 | else (-1, value, 0)) | |
6330 | ||
6331 | def _calculate_field_preference(self, format, field): | |
6332 | type = self._get_field_setting(field, 'type') # extractor, boolean, ordered, field, multiple | |
6333 | get_value = lambda f: format.get(self._get_field_setting(f, 'field')) | |
6334 | if type == 'multiple': | |
6335 | type = 'field' # Only 'field' is allowed in multiple for now | |
6336 | actual_fields = self._get_field_setting(field, 'field') | |
6337 | ||
6338 | value = self._get_field_setting(field, 'function')(get_value(f) for f in actual_fields) | |
6339 | else: | |
6340 | value = get_value(field) | |
6341 | return self._calculate_field_preference_from_value(format, field, type, value) | |
6342 | ||
6343 | def calculate_preference(self, format): | |
6344 | # Determine missing protocol | |
6345 | if not format.get('protocol'): | |
6346 | format['protocol'] = determine_protocol(format) | |
6347 | ||
6348 | # Determine missing ext | |
6349 | if not format.get('ext') and 'url' in format: | |
6350 | format['ext'] = determine_ext(format['url']) | |
6351 | if format.get('vcodec') == 'none': | |
6352 | format['audio_ext'] = format['ext'] if format.get('acodec') != 'none' else 'none' | |
6353 | format['video_ext'] = 'none' | |
6354 | else: | |
6355 | format['video_ext'] = format['ext'] | |
6356 | format['audio_ext'] = 'none' | |
6357 | # if format.get('preference') is None and format.get('ext') in ('f4f', 'f4m'): # Not supported? | |
6358 | # format['preference'] = -1000 | |
6359 | ||
5424dbaf L |
6360 | if format.get('preference') is None and format.get('ext') == 'flv' and re.match('[hx]265|he?vc?', format.get('vcodec') or ''): |
6361 | # HEVC-over-FLV is out-of-spec by FLV's original spec | |
6362 | # ref. https://trac.ffmpeg.org/ticket/6389 | |
6363 | # ref. https://github.com/yt-dlp/yt-dlp/pull/5821 | |
6364 | format['preference'] = -100 | |
6365 | ||
d0d74b71 | 6366 | # Determine missing bitrates |
6367 | if format.get('tbr') is None: | |
6368 | if format.get('vbr') is not None and format.get('abr') is not None: | |
6369 | format['tbr'] = format.get('vbr', 0) + format.get('abr', 0) | |
6370 | else: | |
6371 | if format.get('vcodec') != 'none' and format.get('vbr') is None: | |
6372 | format['vbr'] = format.get('tbr') - format.get('abr', 0) | |
6373 | if format.get('acodec') != 'none' and format.get('abr') is None: | |
6374 | format['abr'] = format.get('tbr') - format.get('vbr', 0) | |
6375 | ||
6376 | return tuple(self._calculate_field_preference(format, field) for field in self._order) | |
6377 | ||
6378 | ||
9b8ee23b | 6379 | # Deprecated |
6380 | has_certifi = bool(certifi) | |
6381 | has_websockets = bool(websockets) | |
8e40b9d1 M |
6382 | |
6383 | ||
6384 | def load_plugins(name, suffix, namespace): | |
6385 | from .plugins import load_plugins | |
6386 | ret = load_plugins(name, suffix) | |
6387 | namespace.update(ret) | |
6388 | return ret |