]> jfr.im git - yt-dlp.git/blame - youtube_dlc/extractor/common.py
Update to ytdl-2021.01.03
[yt-dlp.git] / youtube_dlc / extractor / common.py
CommitLineData
fd475508 1# coding: utf-8
6a3828fd 2from __future__ import unicode_literals
f1a9d64e 3
d6983cb4 4import base64
f4b1c7ad 5import datetime
3ec05685 6import hashlib
3d3538e4 7import json
4094b6e3 8import netrc
d6983cb4 9import os
773f291d 10import random
d6983cb4
PH
11import re
12import socket
f8c7bed1 13import ssl
d6983cb4 14import sys
4094b6e3 15import time
1bac3455 16import math
d6983cb4 17
8c25f81b 18from ..compat import (
6c22cee6 19 compat_cookiejar_Cookie,
799207e8 20 compat_cookies,
ee0ba927 21 compat_etree_Element,
e9c0cdd3 22 compat_etree_fromstring,
e64b7569 23 compat_getpass,
d391b7e2 24 compat_integer_types,
d6983cb4 25 compat_http_client,
e9c0cdd3
YCH
26 compat_os_name,
27 compat_str,
d6983cb4 28 compat_urllib_error,
98763ee3 29 compat_urllib_parse_unquote,
15707c7e 30 compat_urllib_parse_urlencode,
41d06b04 31 compat_urllib_request,
f0b5d6af 32 compat_urlparse,
e01c3d2e 33 compat_xml_parse_error,
8c25f81b 34)
eb8a4433 35from ..downloader import FileDownloader
48107c19
S
36from ..downloader.f4m import (
37 get_base_url,
38 remove_encrypted_media,
39)
8c25f81b 40from ..utils import (
c342041f 41 NO_DEFAULT,
05900629 42 age_restricted,
02dc0a36 43 base_url,
08f2a92c 44 bug_reports_message,
d6983cb4
PH
45 clean_html,
46 compiled_regex_type,
70f0f5a8 47 determine_ext,
46b18f23 48 determine_protocol,
d493f15c 49 dict_get,
9b9c5355 50 error_to_compat_str,
d6983cb4 51 ExtractorError,
46b18f23 52 extract_attributes,
97f4aecf 53 fix_xml_ampersands,
b14f3a4c 54 float_or_none,
773f291d
S
55 GeoRestrictedError,
56 GeoUtils,
31bb8d3f 57 int_or_none,
a4a554a7 58 js_to_json,
0685d972 59 JSON_LD_RE,
46b18f23
JH
60 mimetype2ext,
61 orderedSet,
d493f15c 62 parse_bitrate,
46b18f23
JH
63 parse_codecs,
64 parse_duration,
4ca2a3cf 65 parse_iso8601,
46b18f23 66 parse_m3u8_attributes,
d493f15c 67 parse_resolution,
55b3e45b 68 RegexNotFoundError,
5c2266df 69 sanitized_Request,
46b18f23 70 sanitize_filename,
d493f15c 71 str_or_none,
ce5b9040 72 str_to_int,
f856816b 73 strip_or_none,
f38de77f 74 unescapeHTML,
647eab45 75 unified_strdate,
6b3a3098 76 unified_timestamp,
46b18f23
JH
77 update_Request,
78 update_url_query,
79 urljoin,
a107193e 80 url_basename,
bebef109 81 url_or_none,
a6571f10 82 xpath_element,
8d6765cf
S
83 xpath_text,
84 xpath_with_ns,
d6983cb4 85)
c342041f 86
d6983cb4
PH
87
88class InfoExtractor(object):
89 """Information Extractor class.
90
91 Information extractors are the classes that, given a URL, extract
92 information about the video (or videos) the URL refers to. This
93 information includes the real video URL, the video title, author and
94 others. The information is stored in a dictionary which is then
5d380852 95 passed to the YoutubeDL. The YoutubeDL processes this
d6983cb4
PH
96 information possibly downloading the video to the file system, among
97 other possible outcomes.
98
cf0649f8 99 The type field determines the type of the result.
fed5d032
PH
100 By far the most common value (and the default if _type is missing) is
101 "video", which indicates a single video.
102
103 For a video, the dictionaries must include the following fields:
d6983cb4
PH
104
105 id: Video identifier.
d6983cb4 106 title: Video title, unescaped.
d67b0b15 107
f49d89ee 108 Additionally, it must contain either a formats entry or a url one:
d67b0b15 109
f49d89ee
PH
110 formats: A list of dictionaries for each format available, ordered
111 from worst to best quality.
112
113 Potential fields:
c790e93a
S
114 * url The mandatory URL representing the media:
115 for plain file media - HTTP URL of this file,
116 for RTMP - RTMP URL,
117 for HLS - URL of the M3U8 media playlist,
118 for HDS - URL of the F4M manifest,
79d2077e
S
119 for DASH
120 - HTTP URL to plain file media (in case of
121 unfragmented media)
122 - URL of the MPD manifest or base URL
123 representing the media if MPD manifest
8ed7a233 124 is parsed from a string (in case of
79d2077e 125 fragmented media)
c790e93a 126 for MSS - URL of the ISM manifest.
86f4d14f
S
127 * manifest_url
128 The URL of the manifest file in case of
c790e93a
S
129 fragmented media:
130 for HLS - URL of the M3U8 master playlist,
131 for HDS - URL of the F4M manifest,
132 for DASH - URL of the MPD manifest,
133 for MSS - URL of the ISM manifest.
10952eb2 134 * ext Will be calculated from URL if missing
d67b0b15
PH
135 * format A human-readable description of the format
136 ("mp4 container with h264/opus").
137 Calculated from the format_id, width, height.
138 and format_note fields if missing.
139 * format_id A short description of the format
5d4f3985
PH
140 ("mp4_h264_opus" or "19").
141 Technically optional, but strongly recommended.
d67b0b15
PH
142 * format_note Additional info about the format
143 ("3D" or "DASH video")
144 * width Width of the video, if known
145 * height Height of the video, if known
f49d89ee 146 * resolution Textual description of width and height
7217e148 147 * tbr Average bitrate of audio and video in KBit/s
d67b0b15
PH
148 * abr Average audio bitrate in KBit/s
149 * acodec Name of the audio codec in use
dd27fd17 150 * asr Audio sampling rate in Hertz
d67b0b15 151 * vbr Average video bitrate in KBit/s
fbb21cf5 152 * fps Frame rate
d67b0b15 153 * vcodec Name of the video codec in use
1394ce65 154 * container Name of the container format
d67b0b15 155 * filesize The number of bytes, if known in advance
9732d77e 156 * filesize_approx An estimate for the number of bytes
d67b0b15 157 * player_url SWF Player URL (used for rtmpdump).
c7deaa4c
PH
158 * protocol The protocol that will be used for the actual
159 download, lower-case.
b04b8852 160 "http", "https", "rtsp", "rtmp", "rtmpe",
af7d5a63 161 "m3u8", "m3u8_native" or "http_dash_segments".
c58c2d63
S
162 * fragment_base_url
163 Base URL for fragments. Each fragment's path
164 value (if present) will be relative to
165 this URL.
166 * fragments A list of fragments of a fragmented media.
167 Each fragment entry must contain either an url
168 or a path. If an url is present it should be
169 considered by a client. Otherwise both path and
170 fragment_base_url must be present. Here is
171 the list of all potential fields:
172 * "url" - fragment's URL
173 * "path" - fragment's path relative to
174 fragment_base_url
a0d5077c
S
175 * "duration" (optional, int or float)
176 * "filesize" (optional, int)
f49d89ee 177 * preference Order number of this format. If this field is
08d13955 178 present and not None, the formats get sorted
38d63d84 179 by this field, regardless of all other values.
f49d89ee
PH
180 -1 for default (order by other properties),
181 -2 or smaller for less than default.
e65566a9
PH
182 < -1000 to hide the format (if there is
183 another one which is strictly better)
32f90364
PH
184 * language Language code, e.g. "de" or "en-US".
185 * language_preference Is this in the language mentioned in
186 the URL?
aff2f4f4
PH
187 10 if it's what the URL is about,
188 -1 for default (don't know),
189 -10 otherwise, other values reserved for now.
5d73273f
PH
190 * quality Order number of the video quality of this
191 format, irrespective of the file format.
192 -1 for default (order by other properties),
193 -2 or smaller for less than default.
c64ed2a3
PH
194 * source_preference Order number for this video source
195 (quality takes higher priority)
196 -1 for default (order by other properties),
197 -2 or smaller for less than default.
d769be6c
PH
198 * http_headers A dictionary of additional HTTP headers
199 to add to the request.
6271f1ca 200 * stretched_ratio If given and not 1, indicates that the
3dee7826
PH
201 video's pixels are not square.
202 width : height ratio as float.
203 * no_resume The server does not support resuming the
204 (HTTP or RTMP) download. Boolean.
00c97e3e
S
205 * downloader_options A dictionary of downloader options as
206 described in FileDownloader
3dee7826 207
c0ba0f48 208 url: Final video URL.
d6983cb4 209 ext: Video filename extension.
d67b0b15
PH
210 format: The video format, defaults to ext (used for --get-format)
211 player_url: SWF Player URL (used for rtmpdump).
2f5865cc 212
d6983cb4
PH
213 The following fields are optional:
214
f5e43bc6 215 alt_title: A secondary title of the video.
0afef30b
PH
216 display_id An alternative identifier for the video, not necessarily
217 unique, but available before title. Typically, id is
218 something like "4234987", title "Dancing naked mole rats",
219 and display_id "dancing-naked-mole-rats"
d5519808 220 thumbnails: A list of dictionaries, with the following entries:
cfb56d1a 221 * "id" (optional, string) - Thumbnail format ID
d5519808 222 * "url"
cfb56d1a 223 * "preference" (optional, int) - quality of the image
d5519808
PH
224 * "width" (optional, int)
225 * "height" (optional, int)
5e1c39ac 226 * "resolution" (optional, string "{width}x{height}",
d5519808 227 deprecated)
2de624fd 228 * "filesize" (optional, int)
d6983cb4 229 thumbnail: Full URL to a video thumbnail image.
f5e43bc6 230 description: Full video description.
d6983cb4 231 uploader: Full name of the video uploader.
2bc0c46f 232 license: License name the video is licensed under.
8a92e51c 233 creator: The creator of the video.
8aab976b 234 release_date: The date (YYYYMMDD) when the video was released.
955c4514 235 timestamp: UNIX timestamp of the moment the video became available.
d6983cb4 236 upload_date: Video upload date (YYYYMMDD).
955c4514 237 If not explicitly set, calculated from timestamp.
d6983cb4 238 uploader_id: Nickname or id of the video uploader.
7bcd2830 239 uploader_url: Full URL to a personal webpage of the video uploader.
6f1f59f3 240 channel: Full name of the channel the video is uploaded on.
0e7b8d3e 241 Note that channel fields may or may not repeat uploader
6f1f59f3
S
242 fields. This depends on a particular extractor.
243 channel_id: Id of the channel.
244 channel_url: Full URL to a channel webpage.
da9ec3b9 245 location: Physical location where the video was filmed.
a504ced0 246 subtitles: The available subtitles as a dictionary in the format
4606c34e
YCH
247 {tag: subformats}. "tag" is usually a language code, and
248 "subformats" is a list sorted from lower to higher
249 preference, each element is a dictionary with the "ext"
250 entry and one of:
a504ced0 251 * "data": The subtitles file contents
10952eb2 252 * "url": A URL pointing to the subtitles file
4bba3716 253 "ext" will be calculated from URL if missing
360e1ca5
JMF
254 automatic_captions: Like 'subtitles', used by the YoutubeIE for
255 automatically generated captions
62d231c0 256 duration: Length of the video in seconds, as an integer or float.
f3d29461 257 view_count: How many users have watched the video on the platform.
19e3dfc9
PH
258 like_count: Number of positive ratings of the video
259 dislike_count: Number of negative ratings of the video
02835c6b 260 repost_count: Number of reposts of the video
2d30521a 261 average_rating: Average rating give by users, the scale used depends on the webpage
19e3dfc9 262 comment_count: Number of comments on the video
dd622d7c
PH
263 comments: A list of comments, each with one or more of the following
264 properties (all but one of text or html optional):
265 * "author" - human-readable name of the comment author
266 * "author_id" - user ID of the comment author
267 * "id" - Comment ID
268 * "html" - Comment as HTML
269 * "text" - Plain text of the comment
270 * "timestamp" - UNIX timestamp of comment
271 * "parent" - ID of the comment this one is replying to.
272 Set to "root" to indicate that this is a
273 comment to the original video.
8dbe9899 274 age_limit: Age restriction for the video, as an integer (years)
cefecac1 275 webpage_url: The URL to the video webpage, if given to youtube-dlc it
9103bbc5
JMF
276 should allow to get the same result again. (It will be set
277 by YoutubeDL if it's missing)
ad3bc6ac
PH
278 categories: A list of categories that the video falls in, for example
279 ["Sports", "Berlin"]
864f24bd 280 tags: A list of tags assigned to the video, e.g. ["sweden", "pop music"]
7267bd53
PH
281 is_live: True, False, or None (=unknown). Whether this video is a
282 live stream that goes on instead of a fixed-length video.
7c80519c 283 start_time: Time in seconds where the reproduction should start, as
10952eb2 284 specified in the URL.
297a564b 285 end_time: Time in seconds where the reproduction should end, as
10952eb2 286 specified in the URL.
55949fed 287 chapters: A list of dictionaries, with the following entries:
288 * "start_time" - The start time of the chapter in seconds
289 * "end_time" - The end time of the chapter in seconds
290 * "title" (optional, string)
d6983cb4 291
7109903e
S
292 The following fields should only be used when the video belongs to some logical
293 chapter or section:
294
295 chapter: Name or title of the chapter the video belongs to.
27bfd4e5
S
296 chapter_number: Number of the chapter the video belongs to, as an integer.
297 chapter_id: Id of the chapter the video belongs to, as a unicode string.
7109903e
S
298
299 The following fields should only be used when the video is an episode of some
8d76bdf1 300 series, programme or podcast:
7109903e
S
301
302 series: Title of the series or programme the video episode belongs to.
303 season: Title of the season the video episode belongs to.
27bfd4e5
S
304 season_number: Number of the season the video episode belongs to, as an integer.
305 season_id: Id of the season the video episode belongs to, as a unicode string.
7109903e
S
306 episode: Title of the video episode. Unlike mandatory video title field,
307 this field should denote the exact title of the video episode
308 without any kind of decoration.
27bfd4e5
S
309 episode_number: Number of the video episode within a season, as an integer.
310 episode_id: Id of the video episode, as a unicode string.
7109903e 311
7a93ab5f
S
312 The following fields should only be used when the media is a track or a part of
313 a music album:
314
315 track: Title of the track.
316 track_number: Number of the track within an album or a disc, as an integer.
317 track_id: Id of the track (useful in case of custom indexing, e.g. 6.iii),
318 as a unicode string.
319 artist: Artist(s) of the track.
320 genre: Genre(s) of the track.
321 album: Title of the album the track belongs to.
322 album_type: Type of the album (e.g. "Demo", "Full-length", "Split", "Compilation", etc).
323 album_artist: List of all artists appeared on the album (e.g.
324 "Ash Borer / Fell Voices" or "Various Artists", useful for splits
325 and compilations).
326 disc_number: Number of the disc or other physical medium the track belongs to,
327 as an integer.
328 release_year: Year (YYYY) when the album was released.
329
deefc05b 330 Unless mentioned otherwise, the fields should be Unicode strings.
d6983cb4 331
d838b1bd
PH
332 Unless mentioned otherwise, None is equivalent to absence of information.
333
fed5d032
PH
334
335 _type "playlist" indicates multiple videos.
b82f815f
PH
336 There must be a key "entries", which is a list, an iterable, or a PagedList
337 object, each element of which is a valid dictionary by this specification.
fed5d032 338
c10c9323 339 Additionally, playlists can have "id", "title", "description", "uploader",
29f7c58a 340 "uploader_id", "uploader_url", "duration" attributes with the same semantics
341 as videos (see above).
fed5d032
PH
342
343
344 _type "multi_video" indicates that there are multiple videos that
345 form a single show, for examples multiple acts of an opera or TV episode.
346 It must have an entries key like a playlist and contain all the keys
347 required for a video at the same time.
348
349
350 _type "url" indicates that the video must be extracted from another
351 location, possibly by a different extractor. Its only required key is:
352 "url" - the next URL to extract.
f58766ce
PH
353 The key "ie_key" can be set to the class name (minus the trailing "IE",
354 e.g. "Youtube") if the extractor class is known in advance.
355 Additionally, the dictionary may have any properties of the resolved entity
356 known in advance, for example "title" if the title of the referred video is
fed5d032
PH
357 known ahead of time.
358
359
360 _type "url_transparent" entities have the same specification as "url", but
361 indicate that the given additional information is more precise than the one
362 associated with the resolved URL.
363 This is useful when a site employs a video service that hosts the video and
364 its technical metadata, but that video service does not embed a useful
365 title, description etc.
366
367
d6983cb4
PH
368 Subclasses of this one should re-define the _real_initialize() and
369 _real_extract() methods and define a _VALID_URL regexp.
370 Probably, they should also be added to the list of extractors.
371
4248dad9 372 _GEO_BYPASS attribute may be set to False in order to disable
773f291d
S
373 geo restriction bypass mechanisms for a particular extractor.
374 Though it won't disable explicit geo restriction bypass based on
504f20dd 375 country code provided with geo_bypass_country.
4248dad9
S
376
377 _GEO_COUNTRIES attribute may contain a list of presumably geo unrestricted
378 countries for this extractor. One of these countries will be used by
379 geo restriction bypass mechanism right away in order to bypass
504f20dd 380 geo restriction, of course, if the mechanism is not disabled.
773f291d 381
5f95927a
S
382 _GEO_IP_BLOCKS attribute may contain a list of presumably geo unrestricted
383 IP blocks in CIDR notation for this extractor. One of these IP blocks
384 will be used by geo restriction bypass mechanism similarly
504f20dd 385 to _GEO_COUNTRIES.
3ccdde8c 386
d6983cb4
PH
387 Finally, the _WORKING attribute should be set to False for broken IEs
388 in order to warn the users and skip the tests.
389 """
390
391 _ready = False
392 _downloader = None
773f291d 393 _x_forwarded_for_ip = None
4248dad9
S
394 _GEO_BYPASS = True
395 _GEO_COUNTRIES = None
5f95927a 396 _GEO_IP_BLOCKS = None
d6983cb4
PH
397 _WORKING = True
398
399 def __init__(self, downloader=None):
400 """Constructor. Receives an optional downloader."""
401 self._ready = False
773f291d 402 self._x_forwarded_for_ip = None
d6983cb4
PH
403 self.set_downloader(downloader)
404
405 @classmethod
406 def suitable(cls, url):
407 """Receives a URL and returns True if suitable for this IE."""
79cb2577
PH
408
409 # This does not use has/getattr intentionally - we want to know whether
410 # we have cached the regexp for *this* class, whereas getattr would also
411 # match the superclass
412 if '_VALID_URL_RE' not in cls.__dict__:
413 cls._VALID_URL_RE = re.compile(cls._VALID_URL)
414 return cls._VALID_URL_RE.match(url) is not None
d6983cb4 415
ed9266db
PH
416 @classmethod
417 def _match_id(cls, url):
418 if '_VALID_URL_RE' not in cls.__dict__:
419 cls._VALID_URL_RE = re.compile(cls._VALID_URL)
420 m = cls._VALID_URL_RE.match(url)
421 assert m
1afd0b0d 422 return compat_str(m.group('id'))
ed9266db 423
d6983cb4
PH
424 @classmethod
425 def working(cls):
426 """Getter method for _WORKING."""
427 return cls._WORKING
428
429 def initialize(self):
430 """Initializes an instance (authentication, etc)."""
5f95927a
S
431 self._initialize_geo_bypass({
432 'countries': self._GEO_COUNTRIES,
433 'ip_blocks': self._GEO_IP_BLOCKS,
434 })
4248dad9
S
435 if not self._ready:
436 self._real_initialize()
437 self._ready = True
438
5f95927a 439 def _initialize_geo_bypass(self, geo_bypass_context):
e39b5d4a
S
440 """
441 Initialize geo restriction bypass mechanism.
442
443 This method is used to initialize geo bypass mechanism based on faking
444 X-Forwarded-For HTTP header. A random country from provided country list
dc0a869e 445 is selected and a random IP belonging to this country is generated. This
e39b5d4a
S
446 IP will be passed as X-Forwarded-For HTTP header in all subsequent
447 HTTP requests.
e39b5d4a
S
448
449 This method will be used for initial geo bypass mechanism initialization
5f95927a
S
450 during the instance initialization with _GEO_COUNTRIES and
451 _GEO_IP_BLOCKS.
e39b5d4a 452
5f95927a 453 You may also manually call it from extractor's code if geo bypass
e39b5d4a 454 information is not available beforehand (e.g. obtained during
5f95927a
S
455 extraction) or due to some other reason. In this case you should pass
456 this information in geo bypass context passed as first argument. It may
457 contain following fields:
458
459 countries: List of geo unrestricted countries (similar
460 to _GEO_COUNTRIES)
461 ip_blocks: List of geo unrestricted IP blocks in CIDR notation
462 (similar to _GEO_IP_BLOCKS)
463
e39b5d4a 464 """
773f291d 465 if not self._x_forwarded_for_ip:
5f95927a
S
466
467 # Geo bypass mechanism is explicitly disabled by user
468 if not self._downloader.params.get('geo_bypass', True):
469 return
470
471 if not geo_bypass_context:
472 geo_bypass_context = {}
473
474 # Backward compatibility: previously _initialize_geo_bypass
475 # expected a list of countries, some 3rd party code may still use
476 # it this way
477 if isinstance(geo_bypass_context, (list, tuple)):
478 geo_bypass_context = {
479 'countries': geo_bypass_context,
480 }
481
482 # The whole point of geo bypass mechanism is to fake IP
483 # as X-Forwarded-For HTTP header based on some IP block or
484 # country code.
485
486 # Path 1: bypassing based on IP block in CIDR notation
487
488 # Explicit IP block specified by user, use it right away
489 # regardless of whether extractor is geo bypassable or not
490 ip_block = self._downloader.params.get('geo_bypass_ip_block', None)
491
492 # Otherwise use random IP block from geo bypass context but only
493 # if extractor is known as geo bypassable
494 if not ip_block:
495 ip_blocks = geo_bypass_context.get('ip_blocks')
496 if self._GEO_BYPASS and ip_blocks:
497 ip_block = random.choice(ip_blocks)
498
499 if ip_block:
500 self._x_forwarded_for_ip = GeoUtils.random_ipv4(ip_block)
501 if self._downloader.params.get('verbose', False):
502 self._downloader.to_screen(
503 '[debug] Using fake IP %s as X-Forwarded-For.'
504 % self._x_forwarded_for_ip)
505 return
506
507 # Path 2: bypassing based on country code
508
509 # Explicit country code specified by user, use it right away
510 # regardless of whether extractor is geo bypassable or not
511 country = self._downloader.params.get('geo_bypass_country', None)
512
513 # Otherwise use random country code from geo bypass context but
514 # only if extractor is known as geo bypassable
515 if not country:
516 countries = geo_bypass_context.get('countries')
517 if self._GEO_BYPASS and countries:
518 country = random.choice(countries)
519
520 if country:
521 self._x_forwarded_for_ip = GeoUtils.random_ipv4(country)
4248dad9 522 if self._downloader.params.get('verbose', False):
6a9cb295 523 self._downloader.to_screen(
eea0716c 524 '[debug] Using fake IP %s (%s) as X-Forwarded-For.'
5f95927a 525 % (self._x_forwarded_for_ip, country.upper()))
d6983cb4
PH
526
527 def extract(self, url):
528 """Extracts URL information and returns it in list of dicts."""
3a5bcd03 529 try:
773f291d
S
530 for _ in range(2):
531 try:
532 self.initialize()
0016b84e
S
533 ie_result = self._real_extract(url)
534 if self._x_forwarded_for_ip:
535 ie_result['__x_forwarded_for_ip'] = self._x_forwarded_for_ip
536 return ie_result
773f291d 537 except GeoRestrictedError as e:
4248dad9
S
538 if self.__maybe_fake_ip_and_retry(e.countries):
539 continue
773f291d 540 raise
3a5bcd03
PH
541 except ExtractorError:
542 raise
543 except compat_http_client.IncompleteRead as e:
dfb1b146 544 raise ExtractorError('A network error has occurred.', cause=e, expected=True)
9650885b 545 except (KeyError, StopIteration) as e:
dfb1b146 546 raise ExtractorError('An extractor error has occurred.', cause=e)
d6983cb4 547
4248dad9 548 def __maybe_fake_ip_and_retry(self, countries):
3089bc74
S
549 if (not self._downloader.params.get('geo_bypass_country', None)
550 and self._GEO_BYPASS
551 and self._downloader.params.get('geo_bypass', True)
552 and not self._x_forwarded_for_ip
553 and countries):
eea0716c
S
554 country_code = random.choice(countries)
555 self._x_forwarded_for_ip = GeoUtils.random_ipv4(country_code)
4248dad9
S
556 if self._x_forwarded_for_ip:
557 self.report_warning(
eea0716c
S
558 'Video is geo restricted. Retrying extraction with fake IP %s (%s) as X-Forwarded-For.'
559 % (self._x_forwarded_for_ip, country_code.upper()))
4248dad9
S
560 return True
561 return False
562
d6983cb4
PH
563 def set_downloader(self, downloader):
564 """Sets the downloader for this IE."""
565 self._downloader = downloader
566
567 def _real_initialize(self):
568 """Real initialization process. Redefine in subclasses."""
569 pass
570
571 def _real_extract(self, url):
572 """Real extraction process. Redefine in subclasses."""
573 pass
574
56c73665
JMF
575 @classmethod
576 def ie_key(cls):
577 """A string for getting the InfoExtractor with get_info_extractor"""
dc519b54 578 return compat_str(cls.__name__[:-2])
56c73665 579
d6983cb4
PH
580 @property
581 def IE_NAME(self):
dc519b54 582 return compat_str(type(self).__name__[:-2])
d6983cb4 583
d391b7e2
S
584 @staticmethod
585 def __can_accept_status_code(err, expected_status):
586 assert isinstance(err, compat_urllib_error.HTTPError)
587 if expected_status is None:
588 return False
589 if isinstance(expected_status, compat_integer_types):
590 return err.code == expected_status
591 elif isinstance(expected_status, (list, tuple)):
592 return err.code in expected_status
593 elif callable(expected_status):
594 return expected_status(err.code) is True
595 else:
596 assert False
597
598 def _request_webpage(self, url_or_request, video_id, note=None, errnote=None, fatal=True, data=None, headers={}, query={}, expected_status=None):
599 """
600 Return the response handle.
601
602 See _download_webpage docstring for arguments specification.
603 """
d6983cb4
PH
604 if note is None:
605 self.report_download_webpage(video_id)
606 elif note is not False:
7cc3570e 607 if video_id is None:
f1a9d64e 608 self.to_screen('%s' % (note,))
7cc3570e 609 else:
f1a9d64e 610 self.to_screen('%s: %s' % (video_id, note))
2132edaa
S
611
612 # Some sites check X-Forwarded-For HTTP header in order to figure out
613 # the origin of the client behind proxy. This allows bypassing geo
614 # restriction by faking this header's value to IP that belongs to some
615 # geo unrestricted country. We will do so once we encounter any
616 # geo restriction error.
617 if self._x_forwarded_for_ip:
618 if 'X-Forwarded-For' not in headers:
619 headers['X-Forwarded-For'] = self._x_forwarded_for_ip
620
41d06b04
S
621 if isinstance(url_or_request, compat_urllib_request.Request):
622 url_or_request = update_Request(
623 url_or_request, data=data, headers=headers, query=query)
624 else:
cdfee168 625 if query:
626 url_or_request = update_url_query(url_or_request, query)
2c0d9c62 627 if data is not None or headers:
41d06b04 628 url_or_request = sanitized_Request(url_or_request, data, headers)
f8c7bed1
S
629 exceptions = [compat_urllib_error.URLError, compat_http_client.HTTPException, socket.error]
630 if hasattr(ssl, 'CertificateError'):
631 exceptions.append(ssl.CertificateError)
d6983cb4 632 try:
dca08720 633 return self._downloader.urlopen(url_or_request)
f8c7bed1 634 except tuple(exceptions) as err:
d391b7e2
S
635 if isinstance(err, compat_urllib_error.HTTPError):
636 if self.__can_accept_status_code(err, expected_status):
95e42d73
XDG
637 # Retain reference to error to prevent file object from
638 # being closed before it can be read. Works around the
639 # effects of <https://bugs.python.org/issue15002>
640 # introduced in Python 3.4.1.
641 err.fp._error = err
d391b7e2
S
642 return err.fp
643
aa94a6d3
PH
644 if errnote is False:
645 return False
d6983cb4 646 if errnote is None:
f1a9d64e 647 errnote = 'Unable to download webpage'
7f8b2714 648
9b9c5355 649 errmsg = '%s: %s' % (errnote, error_to_compat_str(err))
7cc3570e
PH
650 if fatal:
651 raise ExtractorError(errmsg, sys.exc_info()[2], cause=err)
652 else:
653 self._downloader.report_warning(errmsg)
654 return False
d6983cb4 655
d391b7e2
S
656 def _download_webpage_handle(self, url_or_request, video_id, note=None, errnote=None, fatal=True, encoding=None, data=None, headers={}, query={}, expected_status=None):
657 """
658 Return a tuple (page content as string, URL handle).
659
660 See _download_webpage docstring for arguments specification.
661 """
b9d3e163
PH
662 # Strip hashes from the URL (#1038)
663 if isinstance(url_or_request, (compat_str, str)):
664 url_or_request = url_or_request.partition('#')[0]
665
d391b7e2 666 urlh = self._request_webpage(url_or_request, video_id, note, errnote, fatal, data=data, headers=headers, query=query, expected_status=expected_status)
7cc3570e
PH
667 if urlh is False:
668 assert not fatal
669 return False
c9a77969 670 content = self._webpage_read_content(urlh, url_or_request, video_id, note, errnote, fatal, encoding=encoding)
23be51d8
PH
671 return (content, urlh)
672
c9a77969
YCH
673 @staticmethod
674 def _guess_encoding_from_content(content_type, webpage_bytes):
d6983cb4
PH
675 m = re.match(r'[a-zA-Z0-9_.-]+/[a-zA-Z0-9_.-]+\s*;\s*charset=(.+)', content_type)
676 if m:
677 encoding = m.group(1)
678 else:
0d75ae2c 679 m = re.search(br'<meta[^>]+charset=[\'"]?([^\'")]+)[ /\'">]',
f143d86a
PH
680 webpage_bytes[:1024])
681 if m:
682 encoding = m.group(1).decode('ascii')
b60016e8
PH
683 elif webpage_bytes.startswith(b'\xff\xfe'):
684 encoding = 'utf-16'
f143d86a
PH
685 else:
686 encoding = 'utf-8'
c9a77969
YCH
687
688 return encoding
689
4457823d
S
690 def __check_blocked(self, content):
691 first_block = content[:512]
3089bc74
S
692 if ('<title>Access to this site is blocked</title>' in content
693 and 'Websense' in first_block):
4457823d
S
694 msg = 'Access to this webpage has been blocked by Websense filtering software in your network.'
695 blocked_iframe = self._html_search_regex(
696 r'<iframe src="([^"]+)"', content,
697 'Websense information URL', default=None)
698 if blocked_iframe:
699 msg += ' Visit %s for more details' % blocked_iframe
700 raise ExtractorError(msg, expected=True)
701 if '<title>The URL you requested has been blocked</title>' in first_block:
702 msg = (
703 'Access to this webpage has been blocked by Indian censorship. '
704 'Use a VPN or proxy server (with --proxy) to route around it.')
705 block_msg = self._html_search_regex(
706 r'</h1><p>(.*?)</p>',
707 content, 'block message', default=None)
708 if block_msg:
709 msg += ' (Message: "%s")' % block_msg.replace('\n', ' ')
710 raise ExtractorError(msg, expected=True)
3089bc74
S
711 if ('<title>TTK :: Доступ к ресурсу ограничен</title>' in content
712 and 'blocklist.rkn.gov.ru' in content):
4457823d
S
713 raise ExtractorError(
714 'Access to this webpage has been blocked by decision of the Russian government. '
715 'Visit http://blocklist.rkn.gov.ru/ for a block reason.',
716 expected=True)
717
c9a77969
YCH
718 def _webpage_read_content(self, urlh, url_or_request, video_id, note=None, errnote=None, fatal=True, prefix=None, encoding=None):
719 content_type = urlh.headers.get('Content-Type', '')
720 webpage_bytes = urlh.read()
721 if prefix is not None:
722 webpage_bytes = prefix + webpage_bytes
723 if not encoding:
724 encoding = self._guess_encoding_from_content(content_type, webpage_bytes)
d6983cb4 725 if self._downloader.params.get('dump_intermediate_pages', False):
f610dbb0 726 self.to_screen('Dumping request to ' + urlh.geturl())
d6983cb4
PH
727 dump = base64.b64encode(webpage_bytes).decode('ascii')
728 self._downloader.to_screen(dump)
d41e6efc 729 if self._downloader.params.get('write_pages', False):
f610dbb0 730 basen = '%s_%s' % (video_id, urlh.geturl())
c1bce22f 731 if len(basen) > 240:
f1a9d64e 732 h = '___' + hashlib.md5(basen.encode('utf-8')).hexdigest()
c1bce22f
PH
733 basen = basen[:240 - len(h)] + h
734 raw_filename = basen + '.dump'
d41e6efc 735 filename = sanitize_filename(raw_filename, restricted=True)
f1a9d64e 736 self.to_screen('Saving request to ' + filename)
5f58165d
S
737 # Working around MAX_PATH limitation on Windows (see
738 # http://msdn.microsoft.com/en-us/library/windows/desktop/aa365247(v=vs.85).aspx)
e9c0cdd3 739 if compat_os_name == 'nt':
5f58165d
S
740 absfilepath = os.path.abspath(filename)
741 if len(absfilepath) > 259:
742 filename = '\\\\?\\' + absfilepath
d41e6efc
PH
743 with open(filename, 'wb') as outf:
744 outf.write(webpage_bytes)
745
ec0fafbb
AA
746 try:
747 content = webpage_bytes.decode(encoding, 'replace')
748 except LookupError:
749 content = webpage_bytes.decode('utf-8', 'replace')
2410c43d 750
4457823d 751 self.__check_blocked(content)
2410c43d 752
23be51d8 753 return content
d6983cb4 754
d391b7e2
S
755 def _download_webpage(
756 self, url_or_request, video_id, note=None, errnote=None,
757 fatal=True, tries=1, timeout=5, encoding=None, data=None,
758 headers={}, query={}, expected_status=None):
759 """
760 Return the data of the page as a string.
761
762 Arguments:
763 url_or_request -- plain text URL as a string or
764 a compat_urllib_request.Requestobject
765 video_id -- Video/playlist/item identifier (string)
766
767 Keyword arguments:
768 note -- note printed before downloading (string)
769 errnote -- note printed in case of an error (string)
770 fatal -- flag denoting whether error should be considered fatal,
771 i.e. whether it should cause ExtractionError to be raised,
772 otherwise a warning will be reported and extraction continued
773 tries -- number of tries
774 timeout -- sleep interval between tries
775 encoding -- encoding for a page content decoding, guessed automatically
776 when not explicitly specified
777 data -- POST data (bytes)
778 headers -- HTTP headers (dict)
779 query -- URL query (dict)
780 expected_status -- allows to accept failed HTTP requests (non 2xx
781 status code) by explicitly specifying a set of accepted status
782 codes. Can be any of the following entities:
783 - an integer type specifying an exact failed status code to
784 accept
785 - a list or a tuple of integer types specifying a list of
786 failed status codes to accept
787 - a callable accepting an actual failed status code and
788 returning True if it should be accepted
789 Note that this argument does not affect success status codes (2xx)
790 which are always accepted.
791 """
792
995ad69c
TF
793 success = False
794 try_count = 0
795 while success is False:
796 try:
d391b7e2
S
797 res = self._download_webpage_handle(
798 url_or_request, video_id, note, errnote, fatal,
799 encoding=encoding, data=data, headers=headers, query=query,
800 expected_status=expected_status)
995ad69c
TF
801 success = True
802 except compat_http_client.IncompleteRead as e:
803 try_count += 1
804 if try_count >= tries:
805 raise e
806 self._sleep(timeout, video_id)
7cc3570e
PH
807 if res is False:
808 return res
809 else:
810 content, _ = res
811 return content
d6983cb4 812
e0d198c1
S
813 def _download_xml_handle(
814 self, url_or_request, video_id, note='Downloading XML',
815 errnote='Unable to download XML', transform_source=None,
d391b7e2
S
816 fatal=True, encoding=None, data=None, headers={}, query={},
817 expected_status=None):
818 """
ee0ba927 819 Return a tuple (xml as an compat_etree_Element, URL handle).
d391b7e2
S
820
821 See _download_webpage docstring for arguments specification.
822 """
e0d198c1
S
823 res = self._download_webpage_handle(
824 url_or_request, video_id, note, errnote, fatal=fatal,
d391b7e2
S
825 encoding=encoding, data=data, headers=headers, query=query,
826 expected_status=expected_status)
e0d198c1
S
827 if res is False:
828 return res
829 xml_string, urlh = res
830 return self._parse_xml(
831 xml_string, video_id, transform_source=transform_source,
832 fatal=fatal), urlh
833
d391b7e2
S
834 def _download_xml(
835 self, url_or_request, video_id,
836 note='Downloading XML', errnote='Unable to download XML',
837 transform_source=None, fatal=True, encoding=None,
838 data=None, headers={}, query={}, expected_status=None):
839 """
ee0ba927 840 Return the xml as an compat_etree_Element.
d391b7e2
S
841
842 See _download_webpage docstring for arguments specification.
843 """
e0d198c1
S
844 res = self._download_xml_handle(
845 url_or_request, video_id, note=note, errnote=errnote,
846 transform_source=transform_source, fatal=fatal, encoding=encoding,
d391b7e2
S
847 data=data, headers=headers, query=query,
848 expected_status=expected_status)
e0d198c1 849 return res if res is False else res[0]
e01c3d2e
S
850
851 def _parse_xml(self, xml_string, video_id, transform_source=None, fatal=True):
e2b38da9
PH
852 if transform_source:
853 xml_string = transform_source(xml_string)
e01c3d2e
S
854 try:
855 return compat_etree_fromstring(xml_string.encode('utf-8'))
856 except compat_xml_parse_error as ve:
857 errmsg = '%s: Failed to parse XML ' % video_id
858 if fatal:
859 raise ExtractorError(errmsg, cause=ve)
860 else:
861 self.report_warning(errmsg + str(ve))
267ed0c5 862
0fe7783e
S
863 def _download_json_handle(
864 self, url_or_request, video_id, note='Downloading JSON metadata',
865 errnote='Unable to download JSON metadata', transform_source=None,
d391b7e2
S
866 fatal=True, encoding=None, data=None, headers={}, query={},
867 expected_status=None):
868 """
869 Return a tuple (JSON object, URL handle).
870
871 See _download_webpage docstring for arguments specification.
872 """
0fe7783e 873 res = self._download_webpage_handle(
c9a77969 874 url_or_request, video_id, note, errnote, fatal=fatal,
d391b7e2
S
875 encoding=encoding, data=data, headers=headers, query=query,
876 expected_status=expected_status)
0fe7783e
S
877 if res is False:
878 return res
879 json_string, urlh = res
ebb64199 880 return self._parse_json(
0fe7783e
S
881 json_string, video_id, transform_source=transform_source,
882 fatal=fatal), urlh
883
884 def _download_json(
885 self, url_or_request, video_id, note='Downloading JSON metadata',
886 errnote='Unable to download JSON metadata', transform_source=None,
d391b7e2
S
887 fatal=True, encoding=None, data=None, headers={}, query={},
888 expected_status=None):
889 """
890 Return the JSON object as a dict.
891
892 See _download_webpage docstring for arguments specification.
893 """
0fe7783e
S
894 res = self._download_json_handle(
895 url_or_request, video_id, note=note, errnote=errnote,
896 transform_source=transform_source, fatal=fatal, encoding=encoding,
d391b7e2
S
897 data=data, headers=headers, query=query,
898 expected_status=expected_status)
0fe7783e 899 return res if res is False else res[0]
ebb64199
TF
900
901 def _parse_json(self, json_string, video_id, transform_source=None, fatal=True):
81c2f20b
PH
902 if transform_source:
903 json_string = transform_source(json_string)
3d3538e4
PH
904 try:
905 return json.loads(json_string)
906 except ValueError as ve:
e7b6d122
PH
907 errmsg = '%s: Failed to parse JSON ' % video_id
908 if fatal:
909 raise ExtractorError(errmsg, cause=ve)
910 else:
911 self.report_warning(errmsg + str(ve))
3d3538e4 912
f45f96f8 913 def report_warning(self, msg, video_id=None):
f1a9d64e 914 idstr = '' if video_id is None else '%s: ' % video_id
f45f96f8 915 self._downloader.report_warning(
f1a9d64e 916 '[%s] %s%s' % (self.IE_NAME, idstr, msg))
f45f96f8 917
d6983cb4
PH
918 def to_screen(self, msg):
919 """Print msg to screen, prefixing it with '[ie_name]'"""
f1a9d64e 920 self._downloader.to_screen('[%s] %s' % (self.IE_NAME, msg))
d6983cb4
PH
921
922 def report_extraction(self, id_or_name):
923 """Report information extraction."""
f1a9d64e 924 self.to_screen('%s: Extracting information' % id_or_name)
d6983cb4
PH
925
926 def report_download_webpage(self, video_id):
927 """Report webpage download."""
f1a9d64e 928 self.to_screen('%s: Downloading webpage' % video_id)
d6983cb4
PH
929
930 def report_age_confirmation(self):
931 """Report attempt to confirm age."""
f1a9d64e 932 self.to_screen('Confirming age')
d6983cb4 933
fc79158d
JMF
934 def report_login(self):
935 """Report attempt to log in."""
f1a9d64e 936 self.to_screen('Logging in')
fc79158d 937
43e7d3c9
S
938 @staticmethod
939 def raise_login_required(msg='This video is only available for registered users'):
940 raise ExtractorError(
941 '%s. Use --username and --password or --netrc to provide account credentials.' % msg,
942 expected=True)
943
c430802e 944 @staticmethod
773f291d
S
945 def raise_geo_restricted(msg='This video is not available from your location due to geo restriction', countries=None):
946 raise GeoRestrictedError(msg, countries=countries)
c430802e 947
5f6a1245 948 # Methods for following #608
c0d0b01f 949 @staticmethod
830d53bf 950 def url_result(url, ie=None, video_id=None, video_title=None):
10952eb2 951 """Returns a URL that points to a page that should be processed"""
5f6a1245 952 # TODO: ie should be the class used for getting the info
d6983cb4
PH
953 video_info = {'_type': 'url',
954 'url': url,
955 'ie_key': ie}
7012b23c
PH
956 if video_id is not None:
957 video_info['id'] = video_id
830d53bf
S
958 if video_title is not None:
959 video_info['title'] = video_title
d6983cb4 960 return video_info
5f6a1245 961
749ca5ec
S
962 def playlist_from_matches(self, matches, playlist_id=None, playlist_title=None, getter=None, ie=None):
963 urls = orderedSet(
46b18f23
JH
964 self.url_result(self._proto_relative_url(getter(m) if getter else m), ie)
965 for m in matches)
966 return self.playlist_result(
749ca5ec 967 urls, playlist_id=playlist_id, playlist_title=playlist_title)
46b18f23 968
c0d0b01f 969 @staticmethod
acf5cbfe 970 def playlist_result(entries, playlist_id=None, playlist_title=None, playlist_description=None):
d6983cb4
PH
971 """Returns a playlist"""
972 video_info = {'_type': 'playlist',
973 'entries': entries}
974 if playlist_id:
975 video_info['id'] = playlist_id
976 if playlist_title:
977 video_info['title'] = playlist_title
acf5cbfe
S
978 if playlist_description:
979 video_info['description'] = playlist_description
d6983cb4
PH
980 return video_info
981
c342041f 982 def _search_regex(self, pattern, string, name, default=NO_DEFAULT, fatal=True, flags=0, group=None):
d6983cb4
PH
983 """
984 Perform a regex search on the given string, using a single or a list of
985 patterns returning the first matching group.
986 In case of failure return a default value or raise a WARNING or a
55b3e45b 987 RegexNotFoundError, depending on fatal, specifying the field name.
d6983cb4
PH
988 """
989 if isinstance(pattern, (str, compat_str, compiled_regex_type)):
990 mobj = re.search(pattern, string, flags)
991 else:
992 for p in pattern:
993 mobj = re.search(p, string, flags)
c3415d1b
PH
994 if mobj:
995 break
d6983cb4 996
e9c0cdd3 997 if not self._downloader.params.get('no_color') and compat_os_name != 'nt' and sys.stderr.isatty():
f1a9d64e 998 _name = '\033[0;34m%s\033[0m' % name
d6983cb4
PH
999 else:
1000 _name = name
1001
1002 if mobj:
711ede6e
PH
1003 if group is None:
1004 # return the first matching group
1005 return next(g for g in mobj.groups() if g is not None)
1006 else:
1007 return mobj.group(group)
c342041f 1008 elif default is not NO_DEFAULT:
d6983cb4
PH
1009 return default
1010 elif fatal:
f1a9d64e 1011 raise RegexNotFoundError('Unable to extract %s' % _name)
d6983cb4 1012 else:
08f2a92c 1013 self._downloader.report_warning('unable to extract %s' % _name + bug_reports_message())
d6983cb4
PH
1014 return None
1015
c342041f 1016 def _html_search_regex(self, pattern, string, name, default=NO_DEFAULT, fatal=True, flags=0, group=None):
d6983cb4
PH
1017 """
1018 Like _search_regex, but strips HTML tags and unescapes entities.
1019 """
711ede6e 1020 res = self._search_regex(pattern, string, name, default, fatal, flags, group)
d6983cb4
PH
1021 if res:
1022 return clean_html(res).strip()
1023 else:
1024 return res
1025
2118fdd1
RA
1026 def _get_netrc_login_info(self, netrc_machine=None):
1027 username = None
1028 password = None
1029 netrc_machine = netrc_machine or self._NETRC_MACHINE
1030
1031 if self._downloader.params.get('usenetrc', False):
1032 try:
1033 info = netrc.netrc().authenticators(netrc_machine)
1034 if info is not None:
1035 username = info[0]
1036 password = info[2]
1037 else:
dcce092e
S
1038 raise netrc.NetrcParseError(
1039 'No authenticators for %s' % netrc_machine)
2118fdd1 1040 except (IOError, netrc.NetrcParseError) as err:
dcce092e
S
1041 self._downloader.report_warning(
1042 'parsing .netrc: %s' % error_to_compat_str(err))
2118fdd1 1043
dcce092e 1044 return username, password
2118fdd1 1045
1b6712ab 1046 def _get_login_info(self, username_option='username', password_option='password', netrc_machine=None):
fc79158d 1047 """
cf0649f8 1048 Get the login info as (username, password)
32443dd3
S
1049 First look for the manually specified credentials using username_option
1050 and password_option as keys in params dictionary. If no such credentials
1051 available look in the netrc file using the netrc_machine or _NETRC_MACHINE
1052 value.
fc79158d
JMF
1053 If there's no info available, return (None, None)
1054 """
1055 if self._downloader is None:
1056 return (None, None)
1057
fc79158d
JMF
1058 downloader_params = self._downloader.params
1059
1060 # Attempt to use provided username and password or .netrc data
1b6712ab
RA
1061 if downloader_params.get(username_option) is not None:
1062 username = downloader_params[username_option]
1063 password = downloader_params[password_option]
2118fdd1 1064 else:
1b6712ab 1065 username, password = self._get_netrc_login_info(netrc_machine)
5f6a1245 1066
2133565c 1067 return username, password
fc79158d 1068
e64b7569 1069 def _get_tfa_info(self, note='two-factor verification code'):
83317f69 1070 """
1071 Get the two-factor authentication info
1072 TODO - asking the user will be required for sms/phone verify
1073 currently just uses the command line option
1074 If there's no info available, return None
1075 """
1076 if self._downloader is None:
83317f69 1077 return None
1078 downloader_params = self._downloader.params
1079
d800609c 1080 if downloader_params.get('twofactor') is not None:
83317f69 1081 return downloader_params['twofactor']
1082
e64b7569 1083 return compat_getpass('Type %s and press [Return]: ' % note)
83317f69 1084
46720279
JMF
1085 # Helper functions for extracting OpenGraph info
1086 @staticmethod
ab2d5247 1087 def _og_regexes(prop):
448ef1f3 1088 content_re = r'content=(?:"([^"]+?)"|\'([^\']+?)\'|\s*([^\s"\'=<>`]+?))'
22f5f5c6 1089 property_re = (r'(?:name|property)=(?:\'og[:-]%(prop)s\'|"og[:-]%(prop)s"|\s*og[:-]%(prop)s\b)'
7a6d76a6 1090 % {'prop': re.escape(prop)})
78fb87b2 1091 template = r'<meta[^>]+?%s[^>]+?%s'
ab2d5247 1092 return [
78fb87b2
JMF
1093 template % (property_re, content_re),
1094 template % (content_re, property_re),
ab2d5247 1095 ]
46720279 1096
864f24bd
S
1097 @staticmethod
1098 def _meta_regex(prop):
1099 return r'''(?isx)<meta
8b9848ac 1100 (?=[^>]+(?:itemprop|name|property|id|http-equiv)=(["\']?)%s\1)
864f24bd
S
1101 [^>]+?content=(["\'])(?P<content>.*?)\2''' % re.escape(prop)
1102
3c4e6d83 1103 def _og_search_property(self, prop, html, name=None, **kargs):
b070564e
S
1104 if not isinstance(prop, (list, tuple)):
1105 prop = [prop]
46720279 1106 if name is None:
b070564e
S
1107 name = 'OpenGraph %s' % prop[0]
1108 og_regexes = []
1109 for p in prop:
1110 og_regexes.extend(self._og_regexes(p))
1111 escaped = self._search_regex(og_regexes, html, name, flags=re.DOTALL, **kargs)
eb0a8398
PH
1112 if escaped is None:
1113 return None
1114 return unescapeHTML(escaped)
46720279
JMF
1115
1116 def _og_search_thumbnail(self, html, **kargs):
10952eb2 1117 return self._og_search_property('image', html, 'thumbnail URL', fatal=False, **kargs)
46720279
JMF
1118
1119 def _og_search_description(self, html, **kargs):
1120 return self._og_search_property('description', html, fatal=False, **kargs)
1121
1122 def _og_search_title(self, html, **kargs):
1123 return self._og_search_property('title', html, **kargs)
1124
8ffa13e0 1125 def _og_search_video_url(self, html, name='video url', secure=True, **kargs):
a3681973
PH
1126 regexes = self._og_regexes('video') + self._og_regexes('video:url')
1127 if secure:
1128 regexes = self._og_regexes('video:secure_url') + regexes
8ffa13e0 1129 return self._html_search_regex(regexes, html, name, **kargs)
46720279 1130
78338f71
JMF
1131 def _og_search_url(self, html, **kargs):
1132 return self._og_search_property('url', html, **kargs)
1133
40c696e5 1134 def _html_search_meta(self, name, html, display_name=None, fatal=False, **kwargs):
88d9f6c0
S
1135 if not isinstance(name, (list, tuple)):
1136 name = [name]
59040888 1137 if display_name is None:
88d9f6c0 1138 display_name = name[0]
59040888 1139 return self._html_search_regex(
88d9f6c0 1140 [self._meta_regex(n) for n in name],
711ede6e 1141 html, display_name, fatal=fatal, group='content', **kwargs)
59040888
PH
1142
1143 def _dc_search_uploader(self, html):
1144 return self._html_search_meta('dc.creator', html, 'uploader')
1145
8dbe9899
PH
1146 def _rta_search(self, html):
1147 # See http://www.rtalabel.org/index.php?content=howtofaq#single
1148 if re.search(r'(?ix)<meta\s+name="rating"\s+'
1149 r' content="RTA-5042-1996-1400-1577-RTA"',
1150 html):
1151 return 18
1152 return 0
1153
59040888
PH
1154 def _media_rating_search(self, html):
1155 # See http://www.tjg-designs.com/WP/metadata-code-examples-adding-metadata-to-your-web-pages/
1156 rating = self._html_search_meta('rating', html)
1157
1158 if not rating:
1159 return None
1160
1161 RATING_TABLE = {
1162 'safe for kids': 0,
1163 'general': 8,
1164 '14 years': 14,
1165 'mature': 17,
1166 'restricted': 19,
1167 }
d800609c 1168 return RATING_TABLE.get(rating.lower())
59040888 1169
69319969 1170 def _family_friendly_search(self, html):
6ca7732d 1171 # See http://schema.org/VideoObject
ac8491fc
S
1172 family_friendly = self._html_search_meta(
1173 'isFamilyFriendly', html, default=None)
69319969
NJ
1174
1175 if not family_friendly:
1176 return None
1177
1178 RATING_TABLE = {
1179 '1': 0,
1180 'true': 0,
1181 '0': 18,
1182 'false': 18,
1183 }
d800609c 1184 return RATING_TABLE.get(family_friendly.lower())
69319969 1185
0c708f11
JMF
1186 def _twitter_search_player(self, html):
1187 return self._html_search_meta('twitter:player', html,
9e1a5b84 1188 'twitter card player')
0c708f11 1189
95b31e26 1190 def _search_json_ld(self, html, video_id, expected_type=None, **kwargs):
4433bb02 1191 json_ld_list = list(re.finditer(JSON_LD_RE, html))
321b5e08 1192 default = kwargs.get('default', NO_DEFAULT)
321b5e08
S
1193 # JSON-LD may be malformed and thus `fatal` should be respected.
1194 # At the same time `default` may be passed that assumes `fatal=False`
1195 # for _search_regex. Let's simulate the same behavior here as well.
1196 fatal = kwargs.get('fatal', True) if default == NO_DEFAULT else False
4433bb02
S
1197 json_ld = []
1198 for mobj in json_ld_list:
1199 json_ld_item = self._parse_json(
1200 mobj.group('json_ld'), video_id, fatal=fatal)
1201 if not json_ld_item:
1202 continue
1203 if isinstance(json_ld_item, dict):
1204 json_ld.append(json_ld_item)
1205 elif isinstance(json_ld_item, (list, tuple)):
1206 json_ld.extend(json_ld_item)
1207 if json_ld:
1208 json_ld = self._json_ld(json_ld, video_id, fatal=fatal, expected_type=expected_type)
1209 if json_ld:
1210 return json_ld
1211 if default is not NO_DEFAULT:
1212 return default
1213 elif fatal:
1214 raise RegexNotFoundError('Unable to extract JSON-LD')
1215 else:
1216 self._downloader.report_warning('unable to extract JSON-LD %s' % bug_reports_message())
1217 return {}
4ca2a3cf 1218
95b31e26 1219 def _json_ld(self, json_ld, video_id, fatal=True, expected_type=None):
4ca2a3cf
S
1220 if isinstance(json_ld, compat_str):
1221 json_ld = self._parse_json(json_ld, video_id, fatal=fatal)
1222 if not json_ld:
1223 return {}
1224 info = {}
46933a15
S
1225 if not isinstance(json_ld, (list, tuple, dict)):
1226 return info
1227 if isinstance(json_ld, dict):
1228 json_ld = [json_ld]
bae14048 1229
e7e4a6e0
S
1230 INTERACTION_TYPE_MAP = {
1231 'CommentAction': 'comment',
1232 'AgreeAction': 'like',
1233 'DisagreeAction': 'dislike',
1234 'LikeAction': 'like',
1235 'DislikeAction': 'dislike',
1236 'ListenAction': 'view',
1237 'WatchAction': 'view',
1238 'ViewAction': 'view',
1239 }
1240
29f7c58a 1241 def extract_interaction_type(e):
1242 interaction_type = e.get('interactionType')
1243 if isinstance(interaction_type, dict):
1244 interaction_type = interaction_type.get('@type')
1245 return str_or_none(interaction_type)
1246
e7e4a6e0
S
1247 def extract_interaction_statistic(e):
1248 interaction_statistic = e.get('interactionStatistic')
29f7c58a 1249 if isinstance(interaction_statistic, dict):
1250 interaction_statistic = [interaction_statistic]
e7e4a6e0
S
1251 if not isinstance(interaction_statistic, list):
1252 return
1253 for is_e in interaction_statistic:
1254 if not isinstance(is_e, dict):
1255 continue
1256 if is_e.get('@type') != 'InteractionCounter':
1257 continue
29f7c58a 1258 interaction_type = extract_interaction_type(is_e)
1259 if not interaction_type:
e7e4a6e0 1260 continue
ce5b9040
S
1261 # For interaction count some sites provide string instead of
1262 # an integer (as per spec) with non digit characters (e.g. ",")
1263 # so extracting count with more relaxed str_to_int
1264 interaction_count = str_to_int(is_e.get('userInteractionCount'))
e7e4a6e0
S
1265 if interaction_count is None:
1266 continue
1267 count_kind = INTERACTION_TYPE_MAP.get(interaction_type.split('/')[-1])
1268 if not count_kind:
1269 continue
1270 count_key = '%s_count' % count_kind
1271 if info.get(count_key) is not None:
1272 continue
1273 info[count_key] = interaction_count
1274
bae14048
S
1275 def extract_video_object(e):
1276 assert e['@type'] == 'VideoObject'
1277 info.update({
bebef109 1278 'url': url_or_none(e.get('contentUrl')),
bae14048
S
1279 'title': unescapeHTML(e.get('name')),
1280 'description': unescapeHTML(e.get('description')),
bebef109 1281 'thumbnail': url_or_none(e.get('thumbnailUrl') or e.get('thumbnailURL')),
bae14048
S
1282 'duration': parse_duration(e.get('duration')),
1283 'timestamp': unified_timestamp(e.get('uploadDate')),
ad06b99d 1284 'uploader': str_or_none(e.get('author')),
bae14048
S
1285 'filesize': float_or_none(e.get('contentSize')),
1286 'tbr': int_or_none(e.get('bitrate')),
1287 'width': int_or_none(e.get('width')),
1288 'height': int_or_none(e.get('height')),
33a81c2c 1289 'view_count': int_or_none(e.get('interactionCount')),
bae14048 1290 })
e7e4a6e0 1291 extract_interaction_statistic(e)
bae14048 1292
46933a15 1293 for e in json_ld:
4433bb02 1294 if '@context' in e:
46933a15
S
1295 item_type = e.get('@type')
1296 if expected_type is not None and expected_type != item_type:
4433bb02 1297 continue
c69701c6 1298 if item_type in ('TVEpisode', 'Episode'):
440863ad 1299 episode_name = unescapeHTML(e.get('name'))
46933a15 1300 info.update({
440863ad 1301 'episode': episode_name,
46933a15
S
1302 'episode_number': int_or_none(e.get('episodeNumber')),
1303 'description': unescapeHTML(e.get('description')),
1304 })
440863ad
S
1305 if not info.get('title') and episode_name:
1306 info['title'] = episode_name
46933a15 1307 part_of_season = e.get('partOfSeason')
c69701c6 1308 if isinstance(part_of_season, dict) and part_of_season.get('@type') in ('TVSeason', 'Season', 'CreativeWorkSeason'):
458fd30f
S
1309 info.update({
1310 'season': unescapeHTML(part_of_season.get('name')),
1311 'season_number': int_or_none(part_of_season.get('seasonNumber')),
1312 })
d16b3c66 1313 part_of_series = e.get('partOfSeries') or e.get('partOfTVSeries')
c69701c6 1314 if isinstance(part_of_series, dict) and part_of_series.get('@type') in ('TVSeries', 'Series', 'CreativeWorkSeries'):
46933a15 1315 info['series'] = unescapeHTML(part_of_series.get('name'))
391256dc
S
1316 elif item_type == 'Movie':
1317 info.update({
1318 'title': unescapeHTML(e.get('name')),
1319 'description': unescapeHTML(e.get('description')),
1320 'duration': parse_duration(e.get('duration')),
1321 'timestamp': unified_timestamp(e.get('dateCreated')),
1322 })
3931b845 1323 elif item_type in ('Article', 'NewsArticle'):
46933a15
S
1324 info.update({
1325 'timestamp': parse_iso8601(e.get('datePublished')),
1326 'title': unescapeHTML(e.get('headline')),
1327 'description': unescapeHTML(e.get('articleBody')),
1328 })
1329 elif item_type == 'VideoObject':
bae14048 1330 extract_video_object(e)
4433bb02
S
1331 if expected_type is None:
1332 continue
1333 else:
1334 break
c69701c6
S
1335 video = e.get('video')
1336 if isinstance(video, dict) and video.get('@type') == 'VideoObject':
1337 extract_video_object(video)
4433bb02
S
1338 if expected_type is None:
1339 continue
1340 else:
1341 break
4ca2a3cf
S
1342 return dict((k, v) for k, v in info.items() if v is not None)
1343
27713812 1344 @staticmethod
f8da79f8 1345 def _hidden_inputs(html):
586f1cc5 1346 html = re.sub(r'<!--(?:(?!<!--).)*-->', '', html)
201ea3ee 1347 hidden_inputs = {}
c8498368
S
1348 for input in re.findall(r'(?i)(<input[^>]+>)', html):
1349 attrs = extract_attributes(input)
1350 if not input:
201ea3ee 1351 continue
c8498368 1352 if attrs.get('type') not in ('hidden', 'submit'):
201ea3ee 1353 continue
c8498368
S
1354 name = attrs.get('name') or attrs.get('id')
1355 value = attrs.get('value')
1356 if name and value is not None:
1357 hidden_inputs[name] = value
201ea3ee 1358 return hidden_inputs
27713812 1359
cf61d96d
S
1360 def _form_hidden_inputs(self, form_id, html):
1361 form = self._search_regex(
73eb13df 1362 r'(?is)<form[^>]+?id=(["\'])%s\1[^>]*>(?P<form>.+?)</form>' % form_id,
cf61d96d
S
1363 html, '%s form' % form_id, group='form')
1364 return self._hidden_inputs(form)
1365
eb8a4433 1366 class FormatSort:
1367 regex = r' *((?P<reverse>\+)?(?P<field>[a-zA-Z0-9_]+)((?P<seperator>[~:])(?P<limit>.*?))?)? *$'
1368
909d24dd 1369 default = ('hidden', 'has_video', 'extractor', 'lang', 'quality',
eb8a4433 1370 'tbr', 'filesize', 'vbr', 'height', 'width', 'protocol', 'vext',
1371 'abr', 'aext', 'fps', 'filesize_approx', 'source_preference', 'format_id')
1372
1373 settings = {
1374 'vcodec': {'type': 'ordered', 'regex': True,
1375 'order': ['av01', 'vp9', '(h265|he?vc?)', '(h264|avc)', 'vp8', '(mp4v|h263)', 'theora', '', None, 'none']},
1376 'acodec': {'type': 'ordered', 'regex': True,
1377 'order': ['opus', 'vorbis', 'aac', 'mp?4a?', 'mp3', 'e?a?c-?3', 'dts', '', None, 'none']},
1378 'protocol': {'type': 'ordered', 'regex': True,
1379 'order': ['(ht|f)tps', '(ht|f)tp$', 'm3u8.+', 'm3u8', '.*dash', '', 'mms|rtsp', 'none', 'f4']},
1380 'vext': {'type': 'ordered', 'field': 'video_ext',
1381 'order': ('mp4', 'flv', 'webm', '', 'none'), # Why is flv prefered over webm???
1382 'order_free': ('webm', 'mp4', 'flv', '', 'none')},
1383 'aext': {'type': 'ordered', 'field': 'audio_ext',
1384 'order': ('m4a', 'aac', 'mp3', 'ogg', 'opus', 'webm', '', 'none'),
1385 'order_free': ('opus', 'ogg', 'webm', 'm4a', 'mp3', 'aac', '', 'none')},
1386 'hidden': {'visible': False, 'forced': True, 'type': 'extractor', 'max': -1000},
1387 'extractor_preference': {'priority': True, 'type': 'extractor'},
1388 'has_video': {'priority': True, 'field': 'vcodec', 'type': 'boolean', 'not_in_list': ('none',)},
909d24dd 1389 'has_audio': {'priority': False, 'field': 'acodec', 'type': 'boolean', 'not_in_list': ('none',)},
eb8a4433 1390 'language_preference': {'priority': True, 'convert': 'ignore'},
1391 'quality': {'priority': True, 'convert': 'float_none'},
1392 'filesize': {'convert': 'bytes'},
1393 'filesize_approx': {'convert': 'bytes'},
1394 'format_id': {'convert': 'string'},
1395 'height': {'convert': 'float_none'},
1396 'width': {'convert': 'float_none'},
1397 'fps': {'convert': 'float_none'},
1398 'tbr': {'convert': 'float_none'},
1399 'vbr': {'convert': 'float_none'},
1400 'abr': {'convert': 'float_none'},
1401 'asr': {'convert': 'float_none'},
1402 'source_preference': {'convert': 'ignore'},
1403 'codec': {'type': 'combined', 'field': ('vcodec', 'acodec')},
1404 'bitrate': {'type': 'combined', 'field': ('tbr', 'vbr', 'abr'), 'same_limit': True},
1405 'filesize_estimate': {'type': 'combined', 'same_limit': True, 'field': ('filesize', 'filesize_approx')},
1406 'extension': {'type': 'combined', 'field': ('vext', 'aext')},
1407 'dimension': {'type': 'multiple', 'field': ('height', 'width'), 'function': min}, # not named as 'resolution' because such a field exists
1408 'res': {'type': 'alias', 'field': 'dimension'},
1409 'ext': {'type': 'alias', 'field': 'extension'},
1410 'br': {'type': 'alias', 'field': 'bitrate'},
1411 'total_bitrate': {'type': 'alias', 'field': 'tbr'},
1412 'video_bitrate': {'type': 'alias', 'field': 'vbr'},
1413 'audio_bitrate': {'type': 'alias', 'field': 'abr'},
1414 'framerate': {'type': 'alias', 'field': 'fps'},
1415 'lang': {'type': 'alias', 'field': 'language_preference'}, # not named as 'language' because such a field exists
1416 'proto': {'type': 'alias', 'field': 'protocol'},
1417 'source': {'type': 'alias', 'field': 'source_preference'},
1418 'size': {'type': 'alias', 'field': 'filesize_estimate'},
1419 'samplerate': {'type': 'alias', 'field': 'asr'},
1420 'video_ext': {'type': 'alias', 'field': 'vext'},
1421 'audio_ext': {'type': 'alias', 'field': 'aext'},
1422 'video_codec': {'type': 'alias', 'field': 'vcodec'},
1423 'audio_codec': {'type': 'alias', 'field': 'acodec'},
1424 'video': {'type': 'alias', 'field': 'has_video'},
1425 'audio': {'type': 'alias', 'field': 'has_audio'},
1426 'extractor': {'type': 'alias', 'field': 'extractor_preference'},
1427 'preference': {'type': 'alias', 'field': 'extractor_preference'}}
1428
1429 _order = []
1430
1431 def _get_field_setting(self, field, key):
1432 if field not in self.settings:
1433 self.settings[field] = {}
1434 propObj = self.settings[field]
1435 if key not in propObj:
1436 type = propObj.get('type')
1437 if key == 'field':
1438 default = 'preference' if type == 'extractor' else (field,) if type in ('combined', 'multiple') else field
1439 elif key == 'convert':
1440 default = 'order' if type == 'ordered' else 'float_string' if field else 'ignore'
4bcc7bd1 1441 else:
eb8a4433 1442 default = {'type': 'field', 'visible': True, 'order': [], 'not_in_list': (None,), 'function': max}.get(key, None)
1443 propObj[key] = default
1444 return propObj[key]
1445
1446 def _resolve_field_value(self, field, value, convertNone=False):
1447 if value is None:
1448 if not convertNone:
1449 return None
4bcc7bd1 1450 else:
eb8a4433 1451 value = value.lower()
1452 conversion = self._get_field_setting(field, 'convert')
1453 if conversion == 'ignore':
1454 return None
1455 if conversion == 'string':
1456 return value
1457 elif conversion == 'float_none':
1458 return float_or_none(value)
1459 elif conversion == 'bytes':
1460 return FileDownloader.parse_bytes(value)
1461 elif conversion == 'order':
1462 order_free = self._get_field_setting(field, 'order_free')
1463 order_list = order_free if order_free and self._use_free_order else self._get_field_setting(field, 'order')
1464 use_regex = self._get_field_setting(field, 'regex')
1465 list_length = len(order_list)
1466 empty_pos = order_list.index('') if '' in order_list else list_length + 1
1467 if use_regex and value is not None:
1468 for (i, regex) in enumerate(order_list):
1469 if regex and re.match(regex, value):
1470 return list_length - i
1471 return list_length - empty_pos # not in list
1472 else: # not regex or value = None
1473 return list_length - (order_list.index(value) if value in order_list else empty_pos)
1474 else:
1475 if value.isnumeric():
1476 return float(value)
4bcc7bd1 1477 else:
eb8a4433 1478 self.settings[field]['convert'] = 'string'
1479 return value
1480
1481 def evaluate_params(self, params, sort_extractor):
1482 self._use_free_order = params.get('prefer_free_formats', False)
1483 self._sort_user = params.get('format_sort', [])
1484 self._sort_extractor = sort_extractor
1485
1486 def add_item(field, reverse, closest, limit_text):
1487 field = field.lower()
1488 if field in self._order:
1489 return
1490 self._order.append(field)
1491 limit = self._resolve_field_value(field, limit_text)
1492 data = {
1493 'reverse': reverse,
1494 'closest': False if limit is None else closest,
1495 'limit_text': limit_text,
1496 'limit': limit}
1497 if field in self.settings:
1498 self.settings[field].update(data)
1499 else:
1500 self.settings[field] = data
1501
1502 sort_list = (
1503 tuple(field for field in self.default if self._get_field_setting(field, 'forced'))
1504 + (tuple() if params.get('format_sort_force', False)
1505 else tuple(field for field in self.default if self._get_field_setting(field, 'priority')))
1506 + tuple(self._sort_user) + tuple(sort_extractor) + self.default)
1507
1508 for item in sort_list:
1509 match = re.match(self.regex, item)
1510 if match is None:
1511 raise ExtractorError('Invalid format sort string "%s" given by extractor' % item)
1512 field = match.group('field')
1513 if field is None:
1514 continue
1515 if self._get_field_setting(field, 'type') == 'alias':
1516 field = self._get_field_setting(field, 'field')
1517 reverse = match.group('reverse') is not None
1518 closest = match.group('seperator') == '~'
1519 limit_text = match.group('limit')
1520
1521 has_limit = limit_text is not None
1522 has_multiple_fields = self._get_field_setting(field, 'type') == 'combined'
1523 has_multiple_limits = has_limit and has_multiple_fields and not self._get_field_setting(field, 'same_limit')
1524
1525 fields = self._get_field_setting(field, 'field') if has_multiple_fields else (field,)
1526 limits = limit_text.split(":") if has_multiple_limits else (limit_text,) if has_limit else tuple()
1527 limit_count = len(limits)
1528 for (i, f) in enumerate(fields):
1529 add_item(f, reverse, closest,
1530 limits[i] if i < limit_count
1531 else limits[0] if has_limit and not has_multiple_limits
1532 else None)
1533
1534 def print_verbose_info(self, to_screen):
1535 to_screen('[debug] Sort order given by user: %s' % ','.join(self._sort_user))
1536 if self._sort_extractor:
1537 to_screen('[debug] Sort order given by extractor: %s' % ','.join(self._sort_extractor))
1538 to_screen('[debug] Formats sorted by: %s' % ', '.join(['%s%s%s' % (
1539 '+' if self._get_field_setting(field, 'reverse') else '', field,
1540 '%s%s(%s)' % ('~' if self._get_field_setting(field, 'closest') else ':',
1541 self._get_field_setting(field, 'limit_text'),
1542 self._get_field_setting(field, 'limit'))
1543 if self._get_field_setting(field, 'limit_text') is not None else '')
1544 for field in self._order if self._get_field_setting(field, 'visible')]))
1545
1546 def _calculate_field_preference_from_value(self, format, field, type, value):
1547 reverse = self._get_field_setting(field, 'reverse')
1548 closest = self._get_field_setting(field, 'closest')
1549 limit = self._get_field_setting(field, 'limit')
1550
1551 if type == 'extractor':
1552 maximum = self._get_field_setting(field, 'max')
1553 if value is None or (maximum is not None and value >= maximum):
1554 value = 0
1555 elif type == 'boolean':
1556 in_list = self._get_field_setting(field, 'in_list')
1557 not_in_list = self._get_field_setting(field, 'not_in_list')
1558 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
1559 elif type == 'ordered':
1560 value = self._resolve_field_value(field, value, True)
1561
1562 # try to convert to number
1563 val_num = float_or_none(value)
1564 is_num = self._get_field_setting(field, 'convert') != 'string' and val_num is not None
1565 if is_num:
1566 value = val_num
1567
1568 return ((-10, 0) if value is None
1569 else (1, value, 0) if not is_num # if a field has mixed strings and numbers, strings are sorted higher
1570 else (0, -abs(value - limit), value - limit if reverse else limit - value) if closest
1571 else (0, value, 0) if not reverse and (limit is None or value <= limit)
1572 else (0, -value, 0) if limit is None or (reverse and value == limit) or value > limit
1573 else (-1, value, 0))
1574
1575 def _calculate_field_preference(self, format, field):
1576 type = self._get_field_setting(field, 'type') # extractor, boolean, ordered, field, multiple
1577 get_value = lambda f: format.get(self._get_field_setting(f, 'field'))
1578 if type == 'multiple':
1579 type = 'field' # Only 'field' is allowed in multiple for now
1580 actual_fields = self._get_field_setting(field, 'field')
1581
1582 def wrapped_function(values):
1583 values = tuple(filter(lambda x: x is not None, values))
1584 return (self._get_field_setting(field, 'function')(*values) if len(values) > 1
1585 else values[0] if values
1586 else None)
1587
1588 value = wrapped_function((get_value(f) for f in actual_fields))
1589 else:
1590 value = get_value(field)
1591 return self._calculate_field_preference_from_value(format, field, type, value)
1592
1593 def calculate_preference(self, format):
1594 # Determine missing protocol
1595 if not format.get('protocol'):
1596 format['protocol'] = determine_protocol(format)
1597
1598 # Determine missing ext
1599 if not format.get('ext') and 'url' in format:
1600 format['ext'] = determine_ext(format['url'])
1601 if format.get('vcodec') == 'none':
1602 format['audio_ext'] = format['ext']
1603 format['video_ext'] = 'none'
1604 else:
1605 format['video_ext'] = format['ext']
1606 format['audio_ext'] = 'none'
1607 # if format.get('preference') is None and format.get('ext') in ('f4f', 'f4m'): # Not supported?
1608 # format['preference'] = -1000
1609
1610 # Determine missing bitrates
1611 if format.get('tbr') is None:
1612 if format.get('vbr') is not None and format.get('abr') is not None:
1613 format['tbr'] = format.get('vbr', 0) + format.get('abr', 0)
1614 else:
1615 if format.get('vcodec') != "none" and format.get('vbr') is None:
1616 format['vbr'] = format.get('tbr') - format.get('abr', 0)
1617 if format.get('acodec') != "none" and format.get('abr') is None:
1618 format['abr'] = format.get('tbr') - format.get('vbr', 0)
1619
1620 return tuple(self._calculate_field_preference(format, field) for field in self._order)
1621
1622 def _sort_formats(self, formats, field_preference=[]):
1623 if not formats:
1624 raise ExtractorError('No video formats found')
1625 format_sort = self.FormatSort() # params and to_screen are taken from the downloader
1626 format_sort.evaluate_params(self._downloader.params, field_preference)
1627 if self._downloader.params.get('verbose', False):
1628 format_sort.print_verbose_info(self._downloader.to_screen)
1629 formats.sort(key=lambda f: format_sort.calculate_preference(f))
59040888 1630
96a53167
S
1631 def _check_formats(self, formats, video_id):
1632 if formats:
1633 formats[:] = filter(
1634 lambda f: self._is_valid_url(
1635 f['url'], video_id,
1636 item='%s video format' % f.get('format_id') if f.get('format_id') else 'video'),
1637 formats)
1638
f5bdb444
S
1639 @staticmethod
1640 def _remove_duplicate_formats(formats):
1641 format_urls = set()
1642 unique_formats = []
1643 for f in formats:
1644 if f['url'] not in format_urls:
1645 format_urls.add(f['url'])
1646 unique_formats.append(f)
1647 formats[:] = unique_formats
1648
45024183 1649 def _is_valid_url(self, url, video_id, item='video', headers={}):
2f0f6578
S
1650 url = self._proto_relative_url(url, scheme='http:')
1651 # For now assume non HTTP(S) URLs always valid
1652 if not (url.startswith('http://') or url.startswith('https://')):
1653 return True
96a53167 1654 try:
45024183 1655 self._request_webpage(url, video_id, 'Checking %s URL' % item, headers=headers)
96a53167 1656 return True
8bdd16b4 1657 except ExtractorError as e:
25e911a9 1658 self.to_screen(
8bdd16b4 1659 '%s: %s URL is invalid, skipping: %s'
1660 % (video_id, item, error_to_compat_str(e.cause)))
25e911a9 1661 return False
96a53167 1662
20991253 1663 def http_scheme(self):
1ede5b24 1664 """ Either "http:" or "https:", depending on the user's preferences """
20991253
PH
1665 return (
1666 'http:'
1667 if self._downloader.params.get('prefer_insecure', False)
1668 else 'https:')
1669
57c7411f
PH
1670 def _proto_relative_url(self, url, scheme=None):
1671 if url is None:
1672 return url
1673 if url.startswith('//'):
1674 if scheme is None:
1675 scheme = self.http_scheme()
1676 return scheme + url
1677 else:
1678 return url
1679
4094b6e3
PH
1680 def _sleep(self, timeout, video_id, msg_template=None):
1681 if msg_template is None:
f1a9d64e 1682 msg_template = '%(video_id)s: Waiting for %(timeout)s seconds'
4094b6e3
PH
1683 msg = msg_template % {'video_id': video_id, 'timeout': timeout}
1684 self.to_screen(msg)
1685 time.sleep(timeout)
1686
a38436e8 1687 def _extract_f4m_formats(self, manifest_url, video_id, preference=None, f4m_id=None,
4de61310 1688 transform_source=lambda s: fix_xml_ampersands(s).strip(),
7360c06f 1689 fatal=True, m3u8_id=None, data=None, headers={}, query={}):
f036a632
JMF
1690 manifest = self._download_xml(
1691 manifest_url, video_id, 'Downloading f4m manifest',
97f4aecf
S
1692 'Unable to download f4m manifest',
1693 # Some manifests may be malformed, e.g. prosiebensat1 generated manifests
067aa17e 1694 # (see https://github.com/ytdl-org/youtube-dl/issues/6215#issuecomment-121704244)
4de61310 1695 transform_source=transform_source,
7360c06f 1696 fatal=fatal, data=data, headers=headers, query=query)
4de61310
S
1697
1698 if manifest is False:
8d29e47f 1699 return []
31bb8d3f 1700
0fdbb332
S
1701 return self._parse_f4m_formats(
1702 manifest, manifest_url, video_id, preference=preference, f4m_id=f4m_id,
448bb5f3 1703 transform_source=transform_source, fatal=fatal, m3u8_id=m3u8_id)
0fdbb332
S
1704
1705 def _parse_f4m_formats(self, manifest, manifest_url, video_id, preference=None, f4m_id=None,
1706 transform_source=lambda s: fix_xml_ampersands(s).strip(),
448bb5f3 1707 fatal=True, m3u8_id=None):
ee0ba927 1708 if not isinstance(manifest, compat_etree_Element) and not fatal:
d9eb580a
S
1709 return []
1710
cefecac1 1711 # currently youtube-dlc cannot decode the playerVerificationChallenge as Akamai uses Adobe Alchemy
fb72ec58 1712 akamai_pv = manifest.find('{http://ns.adobe.com/f4m/1.0}pv-2.0')
1713 if akamai_pv is not None and ';' in akamai_pv.text:
1714 playerVerificationChallenge = akamai_pv.text.split(';')[0]
1715 if playerVerificationChallenge.strip() != '':
1716 return []
1717
31bb8d3f 1718 formats = []
7a47d07c 1719 manifest_version = '1.0'
b2527359 1720 media_nodes = manifest.findall('{http://ns.adobe.com/f4m/1.0}media')
34e48bed 1721 if not media_nodes:
7a47d07c 1722 manifest_version = '2.0'
34e48bed 1723 media_nodes = manifest.findall('{http://ns.adobe.com/f4m/2.0}media')
b22ca762 1724 # Remove unsupported DRM protected media from final formats
067aa17e 1725 # rendition (see https://github.com/ytdl-org/youtube-dl/issues/8573).
b22ca762
S
1726 media_nodes = remove_encrypted_media(media_nodes)
1727 if not media_nodes:
1728 return formats
48107c19
S
1729
1730 manifest_base_url = get_base_url(manifest)
0a5685b2 1731
a6571f10 1732 bootstrap_info = xpath_element(
0a5685b2
YCH
1733 manifest, ['{http://ns.adobe.com/f4m/1.0}bootstrapInfo', '{http://ns.adobe.com/f4m/2.0}bootstrapInfo'],
1734 'bootstrap info', default=None)
1735
edd6074c
RA
1736 vcodec = None
1737 mime_type = xpath_text(
1738 manifest, ['{http://ns.adobe.com/f4m/1.0}mimeType', '{http://ns.adobe.com/f4m/2.0}mimeType'],
1739 'base URL', default=None)
1740 if mime_type and mime_type.startswith('audio/'):
1741 vcodec = 'none'
1742
b2527359 1743 for i, media_el in enumerate(media_nodes):
77b8b4e6
S
1744 tbr = int_or_none(media_el.attrib.get('bitrate'))
1745 width = int_or_none(media_el.attrib.get('width'))
1746 height = int_or_none(media_el.attrib.get('height'))
1747 format_id = '-'.join(filter(None, [f4m_id, compat_str(i if tbr is None else tbr)]))
448bb5f3
YCH
1748 # If <bootstrapInfo> is present, the specified f4m is a
1749 # stream-level manifest, and only set-level manifests may refer to
1750 # external resources. See section 11.4 and section 4 of F4M spec
1751 if bootstrap_info is None:
1752 media_url = None
1753 # @href is introduced in 2.0, see section 11.6 of F4M spec
1754 if manifest_version == '2.0':
1755 media_url = media_el.attrib.get('href')
1756 if media_url is None:
1757 media_url = media_el.attrib.get('url')
31c746e5
S
1758 if not media_url:
1759 continue
cc357c4d
S
1760 manifest_url = (
1761 media_url if media_url.startswith('http://') or media_url.startswith('https://')
48107c19 1762 else ((manifest_base_url or '/'.join(manifest_url.split('/')[:-1])) + '/' + media_url))
70f0f5a8
S
1763 # If media_url is itself a f4m manifest do the recursive extraction
1764 # since bitrates in parent manifest (this one) and media_url manifest
1765 # may differ leading to inability to resolve the format by requested
1766 # bitrate in f4m downloader
240b6045
YCH
1767 ext = determine_ext(manifest_url)
1768 if ext == 'f4m':
77b8b4e6 1769 f4m_formats = self._extract_f4m_formats(
0fdbb332 1770 manifest_url, video_id, preference=preference, f4m_id=f4m_id,
77b8b4e6
S
1771 transform_source=transform_source, fatal=fatal)
1772 # Sometimes stream-level manifest contains single media entry that
1773 # does not contain any quality metadata (e.g. http://matchtv.ru/#live-player).
1774 # At the same time parent's media entry in set-level manifest may
1775 # contain it. We will copy it from parent in such cases.
1776 if len(f4m_formats) == 1:
1777 f = f4m_formats[0]
1778 f.update({
1779 'tbr': f.get('tbr') or tbr,
1780 'width': f.get('width') or width,
1781 'height': f.get('height') or height,
1782 'format_id': f.get('format_id') if not tbr else format_id,
edd6074c 1783 'vcodec': vcodec,
77b8b4e6
S
1784 })
1785 formats.extend(f4m_formats)
70f0f5a8 1786 continue
240b6045
YCH
1787 elif ext == 'm3u8':
1788 formats.extend(self._extract_m3u8_formats(
1789 manifest_url, video_id, 'mp4', preference=preference,
fac2af3c 1790 m3u8_id=m3u8_id, fatal=fatal))
240b6045 1791 continue
31bb8d3f 1792 formats.append({
77b8b4e6 1793 'format_id': format_id,
31bb8d3f 1794 'url': manifest_url,
30d0b549 1795 'manifest_url': manifest_url,
a6571f10 1796 'ext': 'flv' if bootstrap_info is not None else None,
187ee66c 1797 'protocol': 'f4m',
b2527359 1798 'tbr': tbr,
77b8b4e6
S
1799 'width': width,
1800 'height': height,
edd6074c 1801 'vcodec': vcodec,
60ca389c 1802 'preference': preference,
31bb8d3f 1803 })
31bb8d3f
JMF
1804 return formats
1805
16da9bbc
YCH
1806 def _m3u8_meta_format(self, m3u8_url, ext=None, preference=None, m3u8_id=None):
1807 return {
f207019c 1808 'format_id': '-'.join(filter(None, [m3u8_id, 'meta'])),
704df56d
PH
1809 'url': m3u8_url,
1810 'ext': ext,
1811 'protocol': 'm3u8',
37768f92 1812 'preference': preference - 100 if preference else -100,
704df56d
PH
1813 'resolution': 'multiple',
1814 'format_note': 'Quality selection URL',
16da9bbc
YCH
1815 }
1816
1817 def _extract_m3u8_formats(self, m3u8_url, video_id, ext=None,
1818 entry_protocol='m3u8', preference=None,
1819 m3u8_id=None, note=None, errnote=None,
7360c06f
S
1820 fatal=True, live=False, data=None, headers={},
1821 query={}):
dbd82a1d 1822 res = self._download_webpage_handle(
81515ad9 1823 m3u8_url, video_id,
621ed9f5 1824 note=note or 'Downloading m3u8 information',
13af92fd 1825 errnote=errnote or 'Failed to download m3u8 information',
7360c06f 1826 fatal=fatal, data=data, headers=headers, query=query)
cb252080 1827
dbd82a1d 1828 if res is False:
8d29e47f 1829 return []
cb252080 1830
dbd82a1d 1831 m3u8_doc, urlh = res
37113045 1832 m3u8_url = urlh.geturl()
9cdffeeb 1833
cb252080
S
1834 return self._parse_m3u8_formats(
1835 m3u8_doc, m3u8_url, ext=ext, entry_protocol=entry_protocol,
1836 preference=preference, m3u8_id=m3u8_id, live=live)
1837
1838 def _parse_m3u8_formats(self, m3u8_doc, m3u8_url, ext=None,
1839 entry_protocol='m3u8', preference=None,
1840 m3u8_id=None, live=False):
08a00eef
RA
1841 if '#EXT-X-FAXS-CM:' in m3u8_doc: # Adobe Flash Access
1842 return []
1843
ea229584
RA
1844 if re.search(r'#EXT-X-SESSION-KEY:.*?URI="skd://', m3u8_doc): # Apple FairPlay
1845 return []
1846
ff99fe52 1847 formats = []
0def7587
RA
1848
1849 format_url = lambda u: (
1850 u
1851 if re.match(r'^https?://', u)
1852 else compat_urlparse.urljoin(m3u8_url, u))
1853
cb252080
S
1854 # References:
1855 # 1. https://tools.ietf.org/html/draft-pantos-http-live-streaming-21
067aa17e
S
1856 # 2. https://github.com/ytdl-org/youtube-dl/issues/12211
1857 # 3. https://github.com/ytdl-org/youtube-dl/issues/18923
cb252080
S
1858
1859 # We should try extracting formats only from master playlists [1, 4.3.4],
1860 # i.e. playlists that describe available qualities. On the other hand
1861 # media playlists [1, 4.3.3] should be returned as is since they contain
1862 # just the media without qualities renditions.
9cdffeeb 1863 # Fortunately, master playlist can be easily distinguished from media
cb252080 1864 # playlist based on particular tags availability. As of [1, 4.3.3, 4.3.4]
a0566bbf 1865 # master playlist tags MUST NOT appear in a media playlist and vice versa.
cb252080
S
1866 # As of [1, 4.3.3.1] #EXT-X-TARGETDURATION tag is REQUIRED for every
1867 # media playlist and MUST NOT appear in master playlist thus we can
1868 # clearly detect media playlist with this criterion.
1869
9cdffeeb 1870 if '#EXT-X-TARGETDURATION' in m3u8_doc: # media playlist, return as is
7f32e5dc 1871 return [{
1872 'url': m3u8_url,
1873 'format_id': m3u8_id,
1874 'ext': ext,
1875 'protocol': entry_protocol,
1876 'preference': preference,
1877 }]
cb252080
S
1878
1879 groups = {}
1880 last_stream_inf = {}
1881
1882 def extract_media(x_media_line):
1883 media = parse_m3u8_attributes(x_media_line)
1884 # As per [1, 4.3.4.1] TYPE, GROUP-ID and NAME are REQUIRED
1885 media_type, group_id, name = media.get('TYPE'), media.get('GROUP-ID'), media.get('NAME')
1886 if not (media_type and group_id and name):
1887 return
1888 groups.setdefault(group_id, []).append(media)
1889 if media_type not in ('VIDEO', 'AUDIO'):
1890 return
1891 media_url = media.get('URI')
1892 if media_url:
1893 format_id = []
9211e331 1894 for v in (m3u8_id, group_id, name):
cb252080
S
1895 if v:
1896 format_id.append(v)
1897 f = {
1898 'format_id': '-'.join(format_id),
1899 'url': format_url(media_url),
c89b49f7 1900 'manifest_url': m3u8_url,
cb252080
S
1901 'language': media.get('LANGUAGE'),
1902 'ext': ext,
1903 'protocol': entry_protocol,
1904 'preference': preference,
1905 }
1906 if media_type == 'AUDIO':
1907 f['vcodec'] = 'none'
1908 formats.append(f)
1909
1910 def build_stream_name():
1911 # Despite specification does not mention NAME attribute for
3019cb0c
S
1912 # EXT-X-STREAM-INF tag it still sometimes may be present (see [1]
1913 # or vidio test in TestInfoExtractor.test_parse_m3u8_formats)
ddd258f9 1914 # 1. http://www.vidio.com/watch/165683-dj_ambred-booyah-live-2015
cb252080
S
1915 stream_name = last_stream_inf.get('NAME')
1916 if stream_name:
1917 return stream_name
1918 # If there is no NAME in EXT-X-STREAM-INF it will be obtained
1919 # from corresponding rendition group
1920 stream_group_id = last_stream_inf.get('VIDEO')
1921 if not stream_group_id:
1922 return
1923 stream_group = groups.get(stream_group_id)
1924 if not stream_group:
1925 return stream_group_id
1926 rendition = stream_group[0]
1927 return rendition.get('NAME') or stream_group_id
1928
379306ef 1929 # parse EXT-X-MEDIA tags before EXT-X-STREAM-INF in order to have the
2bfc1d9d
RA
1930 # chance to detect video only formats when EXT-X-STREAM-INF tags
1931 # precede EXT-X-MEDIA tags in HLS manifest such as [3].
1932 for line in m3u8_doc.splitlines():
1933 if line.startswith('#EXT-X-MEDIA:'):
1934 extract_media(line)
1935
704df56d
PH
1936 for line in m3u8_doc.splitlines():
1937 if line.startswith('#EXT-X-STREAM-INF:'):
cb252080 1938 last_stream_inf = parse_m3u8_attributes(line)
704df56d
PH
1939 elif line.startswith('#') or not line.strip():
1940 continue
1941 else:
9c99bef7 1942 tbr = float_or_none(
3089bc74
S
1943 last_stream_inf.get('AVERAGE-BANDWIDTH')
1944 or last_stream_inf.get('BANDWIDTH'), scale=1000)
8dc9d361
S
1945 format_id = []
1946 if m3u8_id:
1947 format_id.append(m3u8_id)
cb252080 1948 stream_name = build_stream_name()
b24d6336
KH
1949 # Bandwidth of live streams may differ over time thus making
1950 # format_id unpredictable. So it's better to keep provided
1951 # format_id intact.
e9c6cdf4 1952 if not live:
ed56f260 1953 format_id.append(stream_name if stream_name else '%d' % (tbr if tbr else len(formats)))
30d0b549 1954 manifest_url = format_url(line.strip())
704df56d 1955 f = {
8dc9d361 1956 'format_id': '-'.join(format_id),
30d0b549 1957 'url': manifest_url,
ff99fe52 1958 'manifest_url': m3u8_url,
704df56d
PH
1959 'tbr': tbr,
1960 'ext': ext,
cb252080 1961 'fps': float_or_none(last_stream_inf.get('FRAME-RATE')),
f0b5d6af
PH
1962 'protocol': entry_protocol,
1963 'preference': preference,
704df56d 1964 }
cb252080 1965 resolution = last_stream_inf.get('RESOLUTION')
704df56d 1966 if resolution:
c4c9b844
S
1967 mobj = re.search(r'(?P<width>\d+)[xX](?P<height>\d+)', resolution)
1968 if mobj:
1969 f['width'] = int(mobj.group('width'))
1970 f['height'] = int(mobj.group('height'))
00f4764c
RA
1971 # Unified Streaming Platform
1972 mobj = re.search(
1973 r'audio.*?(?:%3D|=)(\d+)(?:-video.*?(?:%3D|=)(\d+))?', f['url'])
1974 if mobj:
1975 abr, vbr = mobj.groups()
1976 abr, vbr = float_or_none(abr, 1000), float_or_none(vbr, 1000)
fbb6edd2 1977 f.update({
00f4764c
RA
1978 'vbr': vbr,
1979 'abr': abr,
fbb6edd2 1980 })
cb252080
S
1981 codecs = parse_codecs(last_stream_inf.get('CODECS'))
1982 f.update(codecs)
1983 audio_group_id = last_stream_inf.get('AUDIO')
1984 # As per [1, 4.3.4.1.1] any EXT-X-STREAM-INF tag which
1985 # references a rendition group MUST have a CODECS attribute.
1986 # However, this is not always respected, for example, [2]
1987 # contains EXT-X-STREAM-INF tag which references AUDIO
1988 # rendition group but does not have CODECS and despite
0e7b8d3e
S
1989 # referencing an audio group it represents a complete
1990 # (with audio and video) format. So, for such cases we will
1991 # ignore references to rendition groups and treat them
cb252080
S
1992 # as complete formats.
1993 if audio_group_id and codecs and f.get('vcodec') != 'none':
1994 audio_group = groups.get(audio_group_id)
1995 if audio_group and audio_group[0].get('URI'):
1996 # TODO: update acodec for audio only formats with
1997 # the same GROUP-ID
1998 f['acodec'] = 'none'
704df56d 1999 formats.append(f)
5ef62fc4
RA
2000
2001 # for DailyMotion
2002 progressive_uri = last_stream_inf.get('PROGRESSIVE-URI')
2003 if progressive_uri:
2004 http_f = f.copy()
2005 del http_f['manifest_url']
2006 http_f.update({
2007 'format_id': f['format_id'].replace('hls-', 'http-'),
2008 'protocol': 'http',
2009 'url': progressive_uri,
2010 })
2011 formats.append(http_f)
2012
cb252080 2013 last_stream_inf = {}
704df56d
PH
2014 return formats
2015
a107193e
S
2016 @staticmethod
2017 def _xpath_ns(path, namespace=None):
2018 if not namespace:
2019 return path
2020 out = []
2021 for c in path.split('/'):
2022 if not c or c == '.':
2023 out.append(c)
2024 else:
2025 out.append('{%s}%s' % (namespace, c))
2026 return '/'.join(out)
2027
09f572fb 2028 def _extract_smil_formats(self, smil_url, video_id, fatal=True, f4m_params=None, transform_source=None):
2029 smil = self._download_smil(smil_url, video_id, fatal=fatal, transform_source=transform_source)
a107193e 2030
995029a1
PH
2031 if smil is False:
2032 assert not fatal
2033 return []
e89a2aab 2034
17712eeb 2035 namespace = self._parse_smil_namespace(smil)
a107193e
S
2036
2037 return self._parse_smil_formats(
2038 smil, smil_url, video_id, namespace=namespace, f4m_params=f4m_params)
2039
2040 def _extract_smil_info(self, smil_url, video_id, fatal=True, f4m_params=None):
2041 smil = self._download_smil(smil_url, video_id, fatal=fatal)
2042 if smil is False:
2043 return {}
2044 return self._parse_smil(smil, smil_url, video_id, f4m_params=f4m_params)
2045
09f572fb 2046 def _download_smil(self, smil_url, video_id, fatal=True, transform_source=None):
a107193e
S
2047 return self._download_xml(
2048 smil_url, video_id, 'Downloading SMIL file',
09f572fb 2049 'Unable to download SMIL file', fatal=fatal, transform_source=transform_source)
a107193e
S
2050
2051 def _parse_smil(self, smil, smil_url, video_id, f4m_params=None):
17712eeb 2052 namespace = self._parse_smil_namespace(smil)
a107193e
S
2053
2054 formats = self._parse_smil_formats(
2055 smil, smil_url, video_id, namespace=namespace, f4m_params=f4m_params)
2056 subtitles = self._parse_smil_subtitles(smil, namespace=namespace)
2057
2058 video_id = os.path.splitext(url_basename(smil_url))[0]
2059 title = None
2060 description = None
647eab45 2061 upload_date = None
a107193e
S
2062 for meta in smil.findall(self._xpath_ns('./head/meta', namespace)):
2063 name = meta.attrib.get('name')
2064 content = meta.attrib.get('content')
2065 if not name or not content:
2066 continue
2067 if not title and name == 'title':
2068 title = content
2069 elif not description and name in ('description', 'abstract'):
2070 description = content
647eab45
S
2071 elif not upload_date and name == 'date':
2072 upload_date = unified_strdate(content)
a107193e 2073
1e5bcdec
S
2074 thumbnails = [{
2075 'id': image.get('type'),
2076 'url': image.get('src'),
2077 'width': int_or_none(image.get('width')),
2078 'height': int_or_none(image.get('height')),
2079 } for image in smil.findall(self._xpath_ns('.//image', namespace)) if image.get('src')]
2080
a107193e
S
2081 return {
2082 'id': video_id,
2083 'title': title or video_id,
2084 'description': description,
647eab45 2085 'upload_date': upload_date,
1e5bcdec 2086 'thumbnails': thumbnails,
a107193e
S
2087 'formats': formats,
2088 'subtitles': subtitles,
2089 }
2090
17712eeb
S
2091 def _parse_smil_namespace(self, smil):
2092 return self._search_regex(
2093 r'(?i)^{([^}]+)?}smil$', smil.tag, 'namespace', default=None)
2094
f877c6ae 2095 def _parse_smil_formats(self, smil, smil_url, video_id, namespace=None, f4m_params=None, transform_rtmp_url=None):
a107193e
S
2096 base = smil_url
2097 for meta in smil.findall(self._xpath_ns('./head/meta', namespace)):
2098 b = meta.get('base') or meta.get('httpBase')
2099 if b:
2100 base = b
2101 break
e89a2aab
S
2102
2103 formats = []
2104 rtmp_count = 0
a107193e 2105 http_count = 0
7f32e5dc 2106 m3u8_count = 0
a107193e 2107
81e1c4e2 2108 srcs = []
ad96b4c8
YCH
2109 media = smil.findall(self._xpath_ns('.//video', namespace)) + smil.findall(self._xpath_ns('.//audio', namespace))
2110 for medium in media:
2111 src = medium.get('src')
81e1c4e2 2112 if not src or src in srcs:
a107193e 2113 continue
81e1c4e2 2114 srcs.append(src)
a107193e 2115
ad96b4c8
YCH
2116 bitrate = float_or_none(medium.get('system-bitrate') or medium.get('systemBitrate'), 1000)
2117 filesize = int_or_none(medium.get('size') or medium.get('fileSize'))
2118 width = int_or_none(medium.get('width'))
2119 height = int_or_none(medium.get('height'))
2120 proto = medium.get('proto')
2121 ext = medium.get('ext')
a107193e 2122 src_ext = determine_ext(src)
ad96b4c8 2123 streamer = medium.get('streamer') or base
a107193e
S
2124
2125 if proto == 'rtmp' or streamer.startswith('rtmp'):
2126 rtmp_count += 1
2127 formats.append({
2128 'url': streamer,
2129 'play_path': src,
2130 'ext': 'flv',
2131 'format_id': 'rtmp-%d' % (rtmp_count if bitrate is None else bitrate),
2132 'tbr': bitrate,
2133 'filesize': filesize,
2134 'width': width,
2135 'height': height,
2136 })
f877c6ae
YCH
2137 if transform_rtmp_url:
2138 streamer, src = transform_rtmp_url(streamer, src)
2139 formats[-1].update({
2140 'url': streamer,
2141 'play_path': src,
2142 })
a107193e
S
2143 continue
2144
2145 src_url = src if src.startswith('http') else compat_urlparse.urljoin(base, src)
c349456e 2146 src_url = src_url.strip()
a107193e
S
2147
2148 if proto == 'm3u8' or src_ext == 'm3u8':
7f32e5dc 2149 m3u8_formats = self._extract_m3u8_formats(
2150 src_url, video_id, ext or 'mp4', m3u8_id='hls', fatal=False)
2151 if len(m3u8_formats) == 1:
2152 m3u8_count += 1
2153 m3u8_formats[0].update({
2154 'format_id': 'hls-%d' % (m3u8_count if bitrate is None else bitrate),
2155 'tbr': bitrate,
2156 'width': width,
2157 'height': height,
2158 })
2159 formats.extend(m3u8_formats)
bd21ead2 2160 elif src_ext == 'f4m':
a107193e
S
2161 f4m_url = src_url
2162 if not f4m_params:
2163 f4m_params = {
2164 'hdcore': '3.2.0',
2165 'plugin': 'flowplayer-3.2.0.1',
2166 }
2167 f4m_url += '&' if '?' in f4m_url else '?'
15707c7e 2168 f4m_url += compat_urllib_parse_urlencode(f4m_params)
7e5edcfd 2169 formats.extend(self._extract_f4m_formats(f4m_url, video_id, f4m_id='hds', fatal=False))
bd21ead2
RA
2170 elif src_ext == 'mpd':
2171 formats.extend(self._extract_mpd_formats(
2172 src_url, video_id, mpd_id='dash', fatal=False))
2173 elif re.search(r'\.ism/[Mm]anifest', src_url):
2174 formats.extend(self._extract_ism_formats(
2175 src_url, video_id, ism_id='mss', fatal=False))
2176 elif src_url.startswith('http') and self._is_valid_url(src, video_id):
a107193e
S
2177 http_count += 1
2178 formats.append({
2179 'url': src_url,
2180 'ext': ext or src_ext or 'flv',
2181 'format_id': 'http-%d' % (bitrate or http_count),
2182 'tbr': bitrate,
2183 'filesize': filesize,
2184 'width': width,
2185 'height': height,
2186 })
63757032 2187
e89a2aab
S
2188 return formats
2189
ce00af87 2190 def _parse_smil_subtitles(self, smil, namespace=None, subtitles_lang='en'):
d413095f 2191 urls = []
a107193e
S
2192 subtitles = {}
2193 for num, textstream in enumerate(smil.findall(self._xpath_ns('.//textstream', namespace))):
2194 src = textstream.get('src')
d413095f 2195 if not src or src in urls:
a107193e 2196 continue
d413095f 2197 urls.append(src)
df634be2 2198 ext = textstream.get('ext') or mimetype2ext(textstream.get('type')) or determine_ext(src)
03bc7237 2199 lang = textstream.get('systemLanguage') or textstream.get('systemLanguageName') or textstream.get('lang') or subtitles_lang
a107193e
S
2200 subtitles.setdefault(lang, []).append({
2201 'url': src,
2202 'ext': ext,
2203 })
2204 return subtitles
63757032 2205
47a5cb77 2206 def _extract_xspf_playlist(self, xspf_url, playlist_id, fatal=True):
942acef5 2207 xspf = self._download_xml(
47a5cb77 2208 xspf_url, playlist_id, 'Downloading xpsf playlist',
942acef5
S
2209 'Unable to download xspf manifest', fatal=fatal)
2210 if xspf is False:
2211 return []
47a5cb77
S
2212 return self._parse_xspf(
2213 xspf, playlist_id, xspf_url=xspf_url,
2214 xspf_base_url=base_url(xspf_url))
8d6765cf 2215
47a5cb77 2216 def _parse_xspf(self, xspf_doc, playlist_id, xspf_url=None, xspf_base_url=None):
8d6765cf
S
2217 NS_MAP = {
2218 'xspf': 'http://xspf.org/ns/0/',
2219 's1': 'http://static.streamone.nl/player/ns/0',
2220 }
2221
2222 entries = []
47a5cb77 2223 for track in xspf_doc.findall(xpath_with_ns('./xspf:trackList/xspf:track', NS_MAP)):
8d6765cf 2224 title = xpath_text(
98044462 2225 track, xpath_with_ns('./xspf:title', NS_MAP), 'title', default=playlist_id)
8d6765cf
S
2226 description = xpath_text(
2227 track, xpath_with_ns('./xspf:annotation', NS_MAP), 'description')
2228 thumbnail = xpath_text(
2229 track, xpath_with_ns('./xspf:image', NS_MAP), 'thumbnail')
2230 duration = float_or_none(
2231 xpath_text(track, xpath_with_ns('./xspf:duration', NS_MAP), 'duration'), 1000)
2232
47a5cb77
S
2233 formats = []
2234 for location in track.findall(xpath_with_ns('./xspf:location', NS_MAP)):
2235 format_url = urljoin(xspf_base_url, location.text)
2236 if not format_url:
2237 continue
2238 formats.append({
2239 'url': format_url,
2240 'manifest_url': xspf_url,
2241 'format_id': location.get(xpath_with_ns('s1:label', NS_MAP)),
2242 'width': int_or_none(location.get(xpath_with_ns('s1:width', NS_MAP))),
2243 'height': int_or_none(location.get(xpath_with_ns('s1:height', NS_MAP))),
2244 })
8d6765cf
S
2245 self._sort_formats(formats)
2246
2247 entries.append({
2248 'id': playlist_id,
2249 'title': title,
2250 'description': description,
2251 'thumbnail': thumbnail,
2252 'duration': duration,
2253 'formats': formats,
2254 })
2255 return entries
2256
7360c06f 2257 def _extract_mpd_formats(self, mpd_url, video_id, mpd_id=None, note=None, errnote=None, fatal=True, formats_dict={}, data=None, headers={}, query={}):
47a5cb77 2258 res = self._download_xml_handle(
1bac3455 2259 mpd_url, video_id,
2260 note=note or 'Downloading MPD manifest',
2261 errnote=errnote or 'Failed to download MPD manifest',
7360c06f 2262 fatal=fatal, data=data, headers=headers, query=query)
1bac3455 2263 if res is False:
2d2fa82d 2264 return []
47a5cb77 2265 mpd_doc, urlh = res
c25720ef
RA
2266 if mpd_doc is None:
2267 return []
02dc0a36 2268 mpd_base_url = base_url(urlh.geturl())
1bac3455 2269
91cb6b50 2270 return self._parse_mpd_formats(
47a5cb77 2271 mpd_doc, mpd_id=mpd_id, mpd_base_url=mpd_base_url,
86f4d14f 2272 formats_dict=formats_dict, mpd_url=mpd_url)
2d2fa82d 2273
86f4d14f 2274 def _parse_mpd_formats(self, mpd_doc, mpd_id=None, mpd_base_url='', formats_dict={}, mpd_url=None):
f0948348
S
2275 """
2276 Parse formats from MPD manifest.
2277 References:
2278 1. MPEG-DASH Standard, ISO/IEC 23009-1:2014(E),
2279 http://standards.iso.org/ittf/PubliclyAvailableStandards/c065274_ISO_IEC_23009-1_2014.zip
2280 2. https://en.wikipedia.org/wiki/Dynamic_Adaptive_Streaming_over_HTTP
2281 """
78895bd3
U
2282 if not self._downloader.params.get('dynamic_mpd'):
2283 if mpd_doc.get('type') == 'dynamic':
2284 return []
2d2fa82d 2285
91cb6b50 2286 namespace = self._search_regex(r'(?i)^{([^}]+)?}MPD$', mpd_doc.tag, 'namespace', default=None)
f14be228 2287
2288 def _add_ns(path):
2289 return self._xpath_ns(path, namespace)
2290
675d0016 2291 def is_drm_protected(element):
2292 return element.find(_add_ns('ContentProtection')) is not None
2293
1bac3455 2294 def extract_multisegment_info(element, ms_parent_info):
2295 ms_info = ms_parent_info.copy()
b4c1d6e8
S
2296
2297 # As per [1, 5.3.9.2.2] SegmentList and SegmentTemplate share some
2298 # common attributes and elements. We will only extract relevant
2299 # for us.
2300 def extract_common(source):
2301 segment_timeline = source.find(_add_ns('SegmentTimeline'))
2302 if segment_timeline is not None:
2303 s_e = segment_timeline.findall(_add_ns('S'))
2304 if s_e:
2305 ms_info['total_number'] = 0
2306 ms_info['s'] = []
2307 for s in s_e:
2308 r = int(s.get('r', 0))
2309 ms_info['total_number'] += 1 + r
2310 ms_info['s'].append({
2311 't': int(s.get('t', 0)),
2312 # @d is mandatory (see [1, 5.3.9.6.2, Table 17, page 60])
2313 'd': int(s.attrib['d']),
2314 'r': r,
2315 })
2316 start_number = source.get('startNumber')
2317 if start_number:
2318 ms_info['start_number'] = int(start_number)
2319 timescale = source.get('timescale')
2320 if timescale:
2321 ms_info['timescale'] = int(timescale)
2322 segment_duration = source.get('duration')
2323 if segment_duration:
48504785 2324 ms_info['segment_duration'] = float(segment_duration)
b4c1d6e8
S
2325
2326 def extract_Initialization(source):
2327 initialization = source.find(_add_ns('Initialization'))
2328 if initialization is not None:
2329 ms_info['initialization_url'] = initialization.attrib['sourceURL']
2330
f14be228 2331 segment_list = element.find(_add_ns('SegmentList'))
1bac3455 2332 if segment_list is not None:
b4c1d6e8
S
2333 extract_common(segment_list)
2334 extract_Initialization(segment_list)
f14be228 2335 segment_urls_e = segment_list.findall(_add_ns('SegmentURL'))
1bac3455 2336 if segment_urls_e:
2337 ms_info['segment_urls'] = [segment.attrib['media'] for segment in segment_urls_e]
1bac3455 2338 else:
f14be228 2339 segment_template = element.find(_add_ns('SegmentTemplate'))
1bac3455 2340 if segment_template is not None:
b4c1d6e8 2341 extract_common(segment_template)
e228616c
S
2342 media = segment_template.get('media')
2343 if media:
2344 ms_info['media'] = media
1bac3455 2345 initialization = segment_template.get('initialization')
2346 if initialization:
e228616c 2347 ms_info['initialization'] = initialization
1bac3455 2348 else:
b4c1d6e8 2349 extract_Initialization(segment_template)
1bac3455 2350 return ms_info
b323e170 2351
1bac3455 2352 mpd_duration = parse_duration(mpd_doc.get('mediaPresentationDuration'))
17b598d3 2353 formats = []
f14be228 2354 for period in mpd_doc.findall(_add_ns('Period')):
1bac3455 2355 period_duration = parse_duration(period.get('duration')) or mpd_duration
2356 period_ms_info = extract_multisegment_info(period, {
2357 'start_number': 1,
2358 'timescale': 1,
2359 })
f14be228 2360 for adaptation_set in period.findall(_add_ns('AdaptationSet')):
675d0016 2361 if is_drm_protected(adaptation_set):
2362 continue
1bac3455 2363 adaption_set_ms_info = extract_multisegment_info(adaptation_set, period_ms_info)
f14be228 2364 for representation in adaptation_set.findall(_add_ns('Representation')):
675d0016 2365 if is_drm_protected(representation):
2366 continue
1bac3455 2367 representation_attrib = adaptation_set.attrib.copy()
2368 representation_attrib.update(representation.attrib)
f0948348 2369 # According to [1, 5.3.7.2, Table 9, page 41], @mimeType is mandatory
a6c8b759
YCH
2370 mime_type = representation_attrib['mimeType']
2371 content_type = mime_type.split('/')[0]
1bac3455 2372 if content_type == 'text':
2373 # TODO implement WebVTT downloading
2374 pass
40fcba5e 2375 elif content_type in ('video', 'audio'):
1bac3455 2376 base_url = ''
2377 for element in (representation, adaptation_set, period, mpd_doc):
f14be228 2378 base_url_e = element.find(_add_ns('BaseURL'))
1bac3455 2379 if base_url_e is not None:
2380 base_url = base_url_e.text + base_url
2381 if re.match(r'^https?://', base_url):
2382 break
bb20526b
S
2383 if mpd_base_url and not re.match(r'^https?://', base_url):
2384 if not mpd_base_url.endswith('/') and not base_url.startswith('/'):
2385 mpd_base_url += '/'
1bac3455 2386 base_url = mpd_base_url + base_url
2387 representation_id = representation_attrib.get('id')
d577c796 2388 lang = representation_attrib.get('lang')
51e9094f 2389 url_el = representation.find(_add_ns('BaseURL'))
2390 filesize = int_or_none(url_el.attrib.get('{http://youtube.com/yt/2012/10/10}contentLength') if url_el is not None else None)
e228616c 2391 bandwidth = int_or_none(representation_attrib.get('bandwidth'))
1bac3455 2392 f = {
154c209e 2393 'format_id': '%s-%s' % (mpd_id, representation_id) if mpd_id else representation_id,
86f4d14f 2394 'manifest_url': mpd_url,
a6c8b759 2395 'ext': mimetype2ext(mime_type),
1bac3455 2396 'width': int_or_none(representation_attrib.get('width')),
2397 'height': int_or_none(representation_attrib.get('height')),
9c99bef7 2398 'tbr': float_or_none(bandwidth, 1000),
1bac3455 2399 'asr': int_or_none(representation_attrib.get('audioSamplingRate')),
2400 'fps': int_or_none(representation_attrib.get('frameRate')),
d577c796 2401 'language': lang if lang not in ('mul', 'und', 'zxx', 'mis') else None,
1bac3455 2402 'format_note': 'DASH %s' % content_type,
51e9094f 2403 'filesize': filesize,
126f225b 2404 'container': mimetype2ext(mime_type) + '_dash',
1bac3455 2405 }
7fe15920 2406 f.update(parse_codecs(representation_attrib.get('codecs')))
1bac3455 2407 representation_ms_info = extract_multisegment_info(representation, adaption_set_ms_info)
b4c1d6e8 2408
e228616c 2409 def prepare_template(template_name, identifiers):
eca1f0d1
S
2410 tmpl = representation_ms_info[template_name]
2411 # First of, % characters outside $...$ templates
2412 # must be escaped by doubling for proper processing
2413 # by % operator string formatting used further (see
067aa17e 2414 # https://github.com/ytdl-org/youtube-dl/issues/16867).
eca1f0d1
S
2415 t = ''
2416 in_template = False
2417 for c in tmpl:
2418 t += c
2419 if c == '$':
2420 in_template = not in_template
2421 elif c == '%' and not in_template:
2422 t += c
2423 # Next, $...$ templates are translated to their
2424 # %(...) counterparts to be used with % operator
e228616c
S
2425 t = t.replace('$RepresentationID$', representation_id)
2426 t = re.sub(r'\$(%s)\$' % '|'.join(identifiers), r'%(\1)d', t)
2427 t = re.sub(r'\$(%s)%%([^$]+)\$' % '|'.join(identifiers), r'%(\1)\2', t)
2428 t.replace('$$', '$')
2429 return t
2430
2431 # @initialization is a regular template like @media one
2432 # so it should be handled just the same way (see
067aa17e 2433 # https://github.com/ytdl-org/youtube-dl/issues/11605)
e228616c
S
2434 if 'initialization' in representation_ms_info:
2435 initialization_template = prepare_template(
2436 'initialization',
2437 # As per [1, 5.3.9.4.2, Table 15, page 54] $Number$ and
2438 # $Time$ shall not be included for @initialization thus
2439 # only $Bandwidth$ remains
2440 ('Bandwidth', ))
2441 representation_ms_info['initialization_url'] = initialization_template % {
2442 'Bandwidth': bandwidth,
2443 }
2444
1141e910
S
2445 def location_key(location):
2446 return 'url' if re.match(r'^https?://', location) else 'path'
2447
e228616c
S
2448 if 'segment_urls' not in representation_ms_info and 'media' in representation_ms_info:
2449
2450 media_template = prepare_template('media', ('Number', 'Bandwidth', 'Time'))
1141e910 2451 media_location_key = location_key(media_template)
f0948348
S
2452
2453 # As per [1, 5.3.9.4.4, Table 16, page 55] $Number$ and $Time$
2454 # can't be used at the same time
b4c1d6e8
S
2455 if '%(Number' in media_template and 's' not in representation_ms_info:
2456 segment_duration = None
c110944f 2457 if 'total_number' not in representation_ms_info and 'segment_duration' in representation_ms_info:
b4c1d6e8
S
2458 segment_duration = float_or_none(representation_ms_info['segment_duration'], representation_ms_info['timescale'])
2459 representation_ms_info['total_number'] = int(math.ceil(float(period_duration) / segment_duration))
b4c1d6e8 2460 representation_ms_info['fragments'] = [{
1141e910 2461 media_location_key: media_template % {
b4c1d6e8 2462 'Number': segment_number,
e228616c 2463 'Bandwidth': bandwidth,
b4c1d6e8
S
2464 },
2465 'duration': segment_duration,
2466 } for segment_number in range(
2467 representation_ms_info['start_number'],
2468 representation_ms_info['total_number'] + representation_ms_info['start_number'])]
f0948348 2469 else:
b4c1d6e8
S
2470 # $Number*$ or $Time$ in media template with S list available
2471 # Example $Number*$: http://www.svtplay.se/klipp/9023742/stopptid-om-bjorn-borg
2472 # Example $Time$: https://play.arkena.com/embed/avp/v2/player/media/b41dda37-d8e7-4d3f-b1b5-9a9db578bdfe/1/129411
b4c1d6e8 2473 representation_ms_info['fragments'] = []
f0948348 2474 segment_time = 0
b4c1d6e8
S
2475 segment_d = None
2476 segment_number = representation_ms_info['start_number']
f0948348
S
2477
2478 def add_segment_url():
b4c1d6e8
S
2479 segment_url = media_template % {
2480 'Time': segment_time,
e228616c 2481 'Bandwidth': bandwidth,
b4c1d6e8
S
2482 'Number': segment_number,
2483 }
b4c1d6e8 2484 representation_ms_info['fragments'].append({
1141e910 2485 media_location_key: segment_url,
b4c1d6e8
S
2486 'duration': float_or_none(segment_d, representation_ms_info['timescale']),
2487 })
f0948348
S
2488
2489 for num, s in enumerate(representation_ms_info['s']):
2490 segment_time = s.get('t') or segment_time
b4c1d6e8 2491 segment_d = s['d']
f0948348 2492 add_segment_url()
b4c1d6e8 2493 segment_number += 1
f0948348 2494 for r in range(s.get('r', 0)):
b4c1d6e8 2495 segment_time += segment_d
f0948348 2496 add_segment_url()
b4c1d6e8
S
2497 segment_number += 1
2498 segment_time += segment_d
2499 elif 'segment_urls' in representation_ms_info and 's' in representation_ms_info:
2500 # No media template
2501 # Example: https://www.youtube.com/watch?v=iXZV5uAYMJI
2502 # or any YouTube dashsegments video
2503 fragments = []
d04621da
S
2504 segment_index = 0
2505 timescale = representation_ms_info['timescale']
2506 for s in representation_ms_info['s']:
2507 duration = float_or_none(s['d'], timescale)
b4c1d6e8 2508 for r in range(s.get('r', 0) + 1):
1141e910 2509 segment_uri = representation_ms_info['segment_urls'][segment_index]
b4c1d6e8 2510 fragments.append({
1141e910 2511 location_key(segment_uri): segment_uri,
d04621da 2512 'duration': duration,
b4c1d6e8 2513 })
d04621da 2514 segment_index += 1
b4c1d6e8 2515 representation_ms_info['fragments'] = fragments
41bf647e
PN
2516 elif 'segment_urls' in representation_ms_info:
2517 # Segment URLs with no SegmentTimeline
2518 # Example: https://www.seznam.cz/zpravy/clanek/cesko-zasahne-vitr-o-sile-vichrice-muze-byt-i-zivotu-nebezpecny-39091
067aa17e 2519 # https://github.com/ytdl-org/youtube-dl/pull/14844
41bf647e 2520 fragments = []
603fc4e0
S
2521 segment_duration = float_or_none(
2522 representation_ms_info['segment_duration'],
2523 representation_ms_info['timescale']) if 'segment_duration' in representation_ms_info else None
41bf647e 2524 for segment_url in representation_ms_info['segment_urls']:
603fc4e0 2525 fragment = {
41bf647e 2526 location_key(segment_url): segment_url,
603fc4e0
S
2527 }
2528 if segment_duration:
2529 fragment['duration'] = segment_duration
2530 fragments.append(fragment)
41bf647e 2531 representation_ms_info['fragments'] = fragments
79d2077e
S
2532 # If there is a fragments key available then we correctly recognized fragmented media.
2533 # Otherwise we will assume unfragmented media with direct access. Technically, such
2534 # assumption is not necessarily correct since we may simply have no support for
2535 # some forms of fragmented media renditions yet, but for now we'll use this fallback.
86f4d14f 2536 if 'fragments' in representation_ms_info:
1bac3455 2537 f.update({
79d2077e
S
2538 # NB: mpd_url may be empty when MPD manifest is parsed from a string
2539 'url': mpd_url or base_url,
1141e910 2540 'fragment_base_url': base_url,
b4c1d6e8 2541 'fragments': [],
1bac3455 2542 'protocol': 'http_dash_segments',
df374b52 2543 })
1bac3455 2544 if 'initialization_url' in representation_ms_info:
e228616c 2545 initialization_url = representation_ms_info['initialization_url']
1bac3455 2546 if not f.get('url'):
2547 f['url'] = initialization_url
1141e910 2548 f['fragments'].append({location_key(initialization_url): initialization_url})
b4c1d6e8 2549 f['fragments'].extend(representation_ms_info['fragments'])
79d2077e
S
2550 else:
2551 # Assuming direct URL to unfragmented media.
2552 f['url'] = base_url
2553
9d6ac71c
S
2554 # According to [1, 5.3.5.2, Table 7, page 35] @id of Representation
2555 # is not necessarily unique within a Period thus formats with
2556 # the same `format_id` are quite possible. There are numerous examples
067aa17e
S
2557 # of such manifests (see https://github.com/ytdl-org/youtube-dl/issues/15111,
2558 # https://github.com/ytdl-org/youtube-dl/issues/13919)
9d6ac71c
S
2559 full_info = formats_dict.get(representation_id, {}).copy()
2560 full_info.update(f)
2561 formats.append(full_info)
17b598d3 2562 else:
1bac3455 2563 self.report_warning('Unknown MIME type %s in DASH manifest' % mime_type)
17b598d3
YCH
2564 return formats
2565
7360c06f 2566 def _extract_ism_formats(self, ism_url, video_id, ism_id=None, note=None, errnote=None, fatal=True, data=None, headers={}, query={}):
47a5cb77 2567 res = self._download_xml_handle(
b2758123
RA
2568 ism_url, video_id,
2569 note=note or 'Downloading ISM manifest',
2570 errnote=errnote or 'Failed to download ISM manifest',
7360c06f 2571 fatal=fatal, data=data, headers=headers, query=query)
b2758123
RA
2572 if res is False:
2573 return []
47a5cb77 2574 ism_doc, urlh = res
13b08034
S
2575 if ism_doc is None:
2576 return []
b2758123 2577
7947a1f7 2578 return self._parse_ism_formats(ism_doc, urlh.geturl(), ism_id)
b2758123
RA
2579
2580 def _parse_ism_formats(self, ism_doc, ism_url, ism_id=None):
76d5a363
S
2581 """
2582 Parse formats from ISM manifest.
2583 References:
2584 1. [MS-SSTR]: Smooth Streaming Protocol,
2585 https://msdn.microsoft.com/en-us/library/ff469518.aspx
2586 """
b2758123
RA
2587 if ism_doc.get('IsLive') == 'TRUE' or ism_doc.find('Protection') is not None:
2588 return []
2589
b2758123
RA
2590 duration = int(ism_doc.attrib['Duration'])
2591 timescale = int_or_none(ism_doc.get('TimeScale')) or 10000000
2592
2593 formats = []
2594 for stream in ism_doc.findall('StreamIndex'):
2595 stream_type = stream.get('Type')
2596 if stream_type not in ('video', 'audio'):
2597 continue
2598 url_pattern = stream.attrib['Url']
2599 stream_timescale = int_or_none(stream.get('TimeScale')) or timescale
2600 stream_name = stream.get('Name')
2601 for track in stream.findall('QualityLevel'):
2501d41e 2602 fourcc = track.get('FourCC', 'AACL' if track.get('AudioTag') == '255' else None)
b2758123
RA
2603 # TODO: add support for WVC1 and WMAP
2604 if fourcc not in ('H264', 'AVC1', 'AACL'):
2605 self.report_warning('%s is not a supported codec' % fourcc)
2606 continue
2607 tbr = int(track.attrib['Bitrate']) // 1000
76d5a363
S
2608 # [1] does not mention Width and Height attributes. However,
2609 # they're often present while MaxWidth and MaxHeight are
2610 # missing, so should be used as fallbacks
2611 width = int_or_none(track.get('MaxWidth') or track.get('Width'))
2612 height = int_or_none(track.get('MaxHeight') or track.get('Height'))
b2758123
RA
2613 sampling_rate = int_or_none(track.get('SamplingRate'))
2614
2615 track_url_pattern = re.sub(r'{[Bb]itrate}', track.attrib['Bitrate'], url_pattern)
2616 track_url_pattern = compat_urlparse.urljoin(ism_url, track_url_pattern)
2617
2618 fragments = []
2619 fragment_ctx = {
2620 'time': 0,
2621 }
2622 stream_fragments = stream.findall('c')
2623 for stream_fragment_index, stream_fragment in enumerate(stream_fragments):
2624 fragment_ctx['time'] = int_or_none(stream_fragment.get('t')) or fragment_ctx['time']
2625 fragment_repeat = int_or_none(stream_fragment.get('r')) or 1
2626 fragment_ctx['duration'] = int_or_none(stream_fragment.get('d'))
2627 if not fragment_ctx['duration']:
2628 try:
2629 next_fragment_time = int(stream_fragment[stream_fragment_index + 1].attrib['t'])
2630 except IndexError:
2631 next_fragment_time = duration
1616f9b4 2632 fragment_ctx['duration'] = (next_fragment_time - fragment_ctx['time']) / fragment_repeat
b2758123
RA
2633 for _ in range(fragment_repeat):
2634 fragments.append({
1616f9b4 2635 'url': re.sub(r'{start[ _]time}', compat_str(fragment_ctx['time']), track_url_pattern),
b2758123
RA
2636 'duration': fragment_ctx['duration'] / stream_timescale,
2637 })
2638 fragment_ctx['time'] += fragment_ctx['duration']
2639
2640 format_id = []
2641 if ism_id:
2642 format_id.append(ism_id)
2643 if stream_name:
2644 format_id.append(stream_name)
2645 format_id.append(compat_str(tbr))
2646
2647 formats.append({
2648 'format_id': '-'.join(format_id),
2649 'url': ism_url,
2650 'manifest_url': ism_url,
2651 'ext': 'ismv' if stream_type == 'video' else 'isma',
2652 'width': width,
2653 'height': height,
2654 'tbr': tbr,
2655 'asr': sampling_rate,
2656 'vcodec': 'none' if stream_type == 'audio' else fourcc,
2657 'acodec': 'none' if stream_type == 'video' else fourcc,
2658 'protocol': 'ism',
2659 'fragments': fragments,
2660 '_download_params': {
2661 'duration': duration,
2662 'timescale': stream_timescale,
2663 'width': width or 0,
2664 'height': height or 0,
2665 'fourcc': fourcc,
2666 'codec_private_data': track.get('CodecPrivateData'),
2667 'sampling_rate': sampling_rate,
2668 'channels': int_or_none(track.get('Channels', 2)),
2669 'bits_per_sample': int_or_none(track.get('BitsPerSample', 16)),
2670 'nal_unit_length_field': int_or_none(track.get('NALUnitLengthField', 4)),
2671 },
2672 })
2673 return formats
2674
eeb0a956 2675 def _parse_html5_media_entries(self, base_url, webpage, video_id, m3u8_id=None, m3u8_entry_protocol='m3u8', mpd_id=None, preference=None):
6780154e
S
2676 def absolute_url(item_url):
2677 return urljoin(base_url, item_url)
59bbe491 2678
2679 def parse_content_type(content_type):
2680 if not content_type:
2681 return {}
2682 ctr = re.search(r'(?P<mimetype>[^/]+/[^;]+)(?:;\s*codecs="?(?P<codecs>[^"]+))?', content_type)
2683 if ctr:
2684 mimetype, codecs = ctr.groups()
2685 f = parse_codecs(codecs)
2686 f['ext'] = mimetype2ext(mimetype)
2687 return f
2688 return {}
2689
868f79db 2690 def _media_formats(src, cur_media_type, type_info={}):
520251c0 2691 full_url = absolute_url(src)
82889d4a 2692 ext = type_info.get('ext') or determine_ext(full_url)
87a449c1 2693 if ext == 'm3u8':
520251c0
YCH
2694 is_plain_url = False
2695 formats = self._extract_m3u8_formats(
ad120ae1 2696 full_url, video_id, ext='mp4',
eeb0a956 2697 entry_protocol=m3u8_entry_protocol, m3u8_id=m3u8_id,
b359e977 2698 preference=preference, fatal=False)
87a449c1
S
2699 elif ext == 'mpd':
2700 is_plain_url = False
2701 formats = self._extract_mpd_formats(
b359e977 2702 full_url, video_id, mpd_id=mpd_id, fatal=False)
520251c0
YCH
2703 else:
2704 is_plain_url = True
2705 formats = [{
2706 'url': full_url,
2707 'vcodec': 'none' if cur_media_type == 'audio' else None,
2708 }]
2709 return is_plain_url, formats
2710
59bbe491 2711 entries = []
4328ddf8
S
2712 # amp-video and amp-audio are very similar to their HTML5 counterparts
2713 # so we wll include them right here (see
2714 # https://www.ampproject.org/docs/reference/components/amp-video)
29f7c58a 2715 # For dl8-* tags see https://delight-vr.com/documentation/dl8-video/
2716 _MEDIA_TAG_NAME_RE = r'(?:(?:amp|dl8(?:-live)?)-)?(video|audio)'
2717 media_tags = [(media_tag, media_tag_name, media_type, '')
2718 for media_tag, media_tag_name, media_type
2719 in re.findall(r'(?s)(<(%s)[^>]*/>)' % _MEDIA_TAG_NAME_RE, webpage)]
2aec7256
S
2720 media_tags.extend(re.findall(
2721 # We only allow video|audio followed by a whitespace or '>'.
2722 # Allowing more characters may end up in significant slow down (see
067aa17e 2723 # https://github.com/ytdl-org/youtube-dl/issues/11979, example URL:
2aec7256 2724 # http://www.porntrex.com/maps/videositemap.xml).
29f7c58a 2725 r'(?s)(<(?P<tag>%s)(?:\s+[^>]*)?>)(.*?)</(?P=tag)>' % _MEDIA_TAG_NAME_RE, webpage))
2726 for media_tag, _, media_type, media_content in media_tags:
59bbe491 2727 media_info = {
2728 'formats': [],
2729 'subtitles': {},
2730 }
2731 media_attributes = extract_attributes(media_tag)
f856816b 2732 src = strip_or_none(media_attributes.get('src'))
59bbe491 2733 if src:
dedb1770 2734 _, formats = _media_formats(src, media_type)
520251c0 2735 media_info['formats'].extend(formats)
6780154e 2736 media_info['thumbnail'] = absolute_url(media_attributes.get('poster'))
59bbe491 2737 if media_content:
2738 for source_tag in re.findall(r'<source[^>]+>', media_content):
d493f15c
S
2739 s_attr = extract_attributes(source_tag)
2740 # data-video-src and data-src are non standard but seen
2741 # several times in the wild
f856816b 2742 src = strip_or_none(dict_get(s_attr, ('src', 'data-video-src', 'data-src')))
59bbe491 2743 if not src:
2744 continue
d493f15c 2745 f = parse_content_type(s_attr.get('type'))
868f79db 2746 is_plain_url, formats = _media_formats(src, media_type, f)
520251c0 2747 if is_plain_url:
d493f15c
S
2748 # width, height, res, label and title attributes are
2749 # all not standard but seen several times in the wild
2750 labels = [
2751 s_attr.get(lbl)
2752 for lbl in ('label', 'title')
2753 if str_or_none(s_attr.get(lbl))
2754 ]
2755 width = int_or_none(s_attr.get('width'))
3089bc74
S
2756 height = (int_or_none(s_attr.get('height'))
2757 or int_or_none(s_attr.get('res')))
d493f15c
S
2758 if not width or not height:
2759 for lbl in labels:
2760 resolution = parse_resolution(lbl)
2761 if not resolution:
2762 continue
2763 width = width or resolution.get('width')
2764 height = height or resolution.get('height')
2765 for lbl in labels:
2766 tbr = parse_bitrate(lbl)
2767 if tbr:
2768 break
2769 else:
2770 tbr = None
1ed45499 2771 f.update({
d493f15c
S
2772 'width': width,
2773 'height': height,
2774 'tbr': tbr,
2775 'format_id': s_attr.get('label') or s_attr.get('title'),
1ed45499 2776 })
520251c0
YCH
2777 f.update(formats[0])
2778 media_info['formats'].append(f)
2779 else:
2780 media_info['formats'].extend(formats)
59bbe491 2781 for track_tag in re.findall(r'<track[^>]+>', media_content):
2782 track_attributes = extract_attributes(track_tag)
2783 kind = track_attributes.get('kind')
5968d7d2 2784 if not kind or kind in ('subtitles', 'captions'):
f856816b 2785 src = strip_or_none(track_attributes.get('src'))
59bbe491 2786 if not src:
2787 continue
2788 lang = track_attributes.get('srclang') or track_attributes.get('lang') or track_attributes.get('label')
2789 media_info['subtitles'].setdefault(lang, []).append({
2790 'url': absolute_url(src),
2791 })
5e8e2fa5
S
2792 for f in media_info['formats']:
2793 f.setdefault('http_headers', {})['Referer'] = base_url
5968d7d2 2794 if media_info['formats'] or media_info['subtitles']:
59bbe491 2795 entries.append(media_info)
2796 return entries
2797
c4251b9a 2798 def _extract_akamai_formats(self, manifest_url, video_id, hosts={}):
29f7c58a 2799 signed = 'hdnea=' in manifest_url
2800 if not signed:
2801 # https://learn.akamai.com/en-us/webhelp/media-services-on-demand/stream-packaging-user-guide/GUID-BE6C0F73-1E06-483B-B0EA-57984B91B7F9.html
2802 manifest_url = re.sub(
2803 r'(?:b=[\d,-]+|(?:__a__|attributes)=off|__b__=\d+)&?',
2804 '', manifest_url).strip('?')
2805
c7c43a93 2806 formats = []
70c5802b 2807
e71a4509 2808 hdcore_sign = 'hdcore=3.7.0'
ff6f9a67 2809 f4m_url = re.sub(r'(https?://[^/]+)/i/', r'\1/z/', manifest_url).replace('/master.m3u8', '/manifest.f4m')
c4251b9a
RA
2810 hds_host = hosts.get('hds')
2811 if hds_host:
2812 f4m_url = re.sub(r'(https?://)[^/]+', r'\1' + hds_host, f4m_url)
e71a4509
RA
2813 if 'hdcore=' not in f4m_url:
2814 f4m_url += ('&' if '?' in f4m_url else '?') + hdcore_sign
2815 f4m_formats = self._extract_f4m_formats(
2816 f4m_url, video_id, f4m_id='hds', fatal=False)
2817 for entry in f4m_formats:
2818 entry.update({'extra_param_to_segment_url': hdcore_sign})
2819 formats.extend(f4m_formats)
70c5802b 2820
c4251b9a
RA
2821 m3u8_url = re.sub(r'(https?://[^/]+)/z/', r'\1/i/', manifest_url).replace('/manifest.f4m', '/master.m3u8')
2822 hls_host = hosts.get('hls')
2823 if hls_host:
2824 m3u8_url = re.sub(r'(https?://)[^/]+', r'\1' + hls_host, m3u8_url)
29f7c58a 2825 m3u8_formats = self._extract_m3u8_formats(
c7c43a93 2826 m3u8_url, video_id, 'mp4', 'm3u8_native',
29f7c58a 2827 m3u8_id='hls', fatal=False)
2828 formats.extend(m3u8_formats)
70c5802b 2829
2830 http_host = hosts.get('http')
29f7c58a 2831 if http_host and m3u8_formats and not signed:
2832 REPL_REGEX = r'https?://[^/]+/i/([^,]+),([^/]+),([^/]+)\.csmil/.+'
70c5802b 2833 qualities = re.match(REPL_REGEX, m3u8_url).group(2).split(',')
2834 qualities_length = len(qualities)
29f7c58a 2835 if len(m3u8_formats) in (qualities_length, qualities_length + 1):
70c5802b 2836 i = 0
29f7c58a 2837 for f in m3u8_formats:
2838 if f['vcodec'] != 'none':
70c5802b 2839 for protocol in ('http', 'https'):
2840 http_f = f.copy()
2841 del http_f['manifest_url']
2842 http_url = re.sub(
29f7c58a 2843 REPL_REGEX, protocol + r'://%s/\g<1>%s\3' % (http_host, qualities[i]), f['url'])
70c5802b 2844 http_f.update({
2845 'format_id': http_f['format_id'].replace('hls-', protocol + '-'),
2846 'url': http_url,
2847 'protocol': protocol,
2848 })
29f7c58a 2849 formats.append(http_f)
70c5802b 2850 i += 1
70c5802b 2851
c7c43a93
RA
2852 return formats
2853
6ad02195 2854 def _extract_wowza_formats(self, url, video_id, m3u8_entry_protocol='m3u8_native', skip_protocols=[]):
044eeb14 2855 query = compat_urlparse.urlparse(url).query
6ad02195 2856 url = re.sub(r'/(?:manifest|playlist|jwplayer)\.(?:m3u8|f4m|mpd|smil)', '', url)
240f2622
S
2857 mobj = re.search(
2858 r'(?:(?:http|rtmp|rtsp)(?P<s>s)?:)?(?P<url>//[^?]+)', url)
2859 url_base = mobj.group('url')
2860 http_base_url = '%s%s:%s' % ('http', mobj.group('s') or '', url_base)
6ad02195 2861 formats = []
044eeb14
S
2862
2863 def manifest_url(manifest):
2864 m_url = '%s/%s' % (http_base_url, manifest)
2865 if query:
2866 m_url += '?%s' % query
2867 return m_url
2868
6ad02195
RA
2869 if 'm3u8' not in skip_protocols:
2870 formats.extend(self._extract_m3u8_formats(
044eeb14 2871 manifest_url('playlist.m3u8'), video_id, 'mp4',
6ad02195
RA
2872 m3u8_entry_protocol, m3u8_id='hls', fatal=False))
2873 if 'f4m' not in skip_protocols:
2874 formats.extend(self._extract_f4m_formats(
044eeb14 2875 manifest_url('manifest.f4m'),
6ad02195 2876 video_id, f4m_id='hds', fatal=False))
0384932e
RA
2877 if 'dash' not in skip_protocols:
2878 formats.extend(self._extract_mpd_formats(
044eeb14 2879 manifest_url('manifest.mpd'),
0384932e 2880 video_id, mpd_id='dash', fatal=False))
6ad02195 2881 if re.search(r'(?:/smil:|\.smil)', url_base):
6ad02195
RA
2882 if 'smil' not in skip_protocols:
2883 rtmp_formats = self._extract_smil_formats(
044eeb14 2884 manifest_url('jwplayer.smil'),
6ad02195
RA
2885 video_id, fatal=False)
2886 for rtmp_format in rtmp_formats:
2887 rtsp_format = rtmp_format.copy()
2888 rtsp_format['url'] = '%s/%s' % (rtmp_format['url'], rtmp_format['play_path'])
2889 del rtsp_format['play_path']
2890 del rtsp_format['ext']
2891 rtsp_format.update({
2892 'url': rtsp_format['url'].replace('rtmp://', 'rtsp://'),
2893 'format_id': rtmp_format['format_id'].replace('rtmp', 'rtsp'),
2894 'protocol': 'rtsp',
2895 })
2896 formats.extend([rtmp_format, rtsp_format])
2897 else:
2898 for protocol in ('rtmp', 'rtsp'):
2899 if protocol not in skip_protocols:
2900 formats.append({
f2e2f0c7 2901 'url': '%s:%s' % (protocol, url_base),
6ad02195
RA
2902 'format_id': protocol,
2903 'protocol': protocol,
2904 })
2905 return formats
2906
c73e330e 2907 def _find_jwplayer_data(self, webpage, video_id=None, transform_source=js_to_json):
a4a554a7 2908 mobj = re.search(
ac9c69ac 2909 r'(?s)jwplayer\((?P<quote>[\'"])[^\'" ]+(?P=quote)\)(?!</script>).*?\.setup\s*\((?P<options>[^)]+)\)',
a4a554a7
YCH
2910 webpage)
2911 if mobj:
c73e330e
RU
2912 try:
2913 jwplayer_data = self._parse_json(mobj.group('options'),
2914 video_id=video_id,
2915 transform_source=transform_source)
2916 except ExtractorError:
2917 pass
2918 else:
2919 if isinstance(jwplayer_data, dict):
2920 return jwplayer_data
a4a554a7
YCH
2921
2922 def _extract_jwplayer_data(self, webpage, video_id, *args, **kwargs):
c73e330e
RU
2923 jwplayer_data = self._find_jwplayer_data(
2924 webpage, video_id, transform_source=js_to_json)
a4a554a7
YCH
2925 return self._parse_jwplayer_data(
2926 jwplayer_data, video_id, *args, **kwargs)
2927
2928 def _parse_jwplayer_data(self, jwplayer_data, video_id=None, require_title=True,
2929 m3u8_id=None, mpd_id=None, rtmp_params=None, base_url=None):
2930 # JWPlayer backward compatibility: flattened playlists
2931 # https://github.com/jwplayer/jwplayer/blob/v7.4.3/src/js/api/config.js#L81-L96
2932 if 'playlist' not in jwplayer_data:
2933 jwplayer_data = {'playlist': [jwplayer_data]}
2934
2935 entries = []
2936
2937 # JWPlayer backward compatibility: single playlist item
2938 # https://github.com/jwplayer/jwplayer/blob/v7.7.0/src/js/playlist/playlist.js#L10
2939 if not isinstance(jwplayer_data['playlist'], list):
2940 jwplayer_data['playlist'] = [jwplayer_data['playlist']]
2941
2942 for video_data in jwplayer_data['playlist']:
2943 # JWPlayer backward compatibility: flattened sources
2944 # https://github.com/jwplayer/jwplayer/blob/v7.4.3/src/js/playlist/item.js#L29-L35
2945 if 'sources' not in video_data:
2946 video_data['sources'] = [video_data]
2947
2948 this_video_id = video_id or video_data['mediaid']
2949
1a2192cb
S
2950 formats = self._parse_jwplayer_formats(
2951 video_data['sources'], video_id=this_video_id, m3u8_id=m3u8_id,
2952 mpd_id=mpd_id, rtmp_params=rtmp_params, base_url=base_url)
a4a554a7
YCH
2953
2954 subtitles = {}
2955 tracks = video_data.get('tracks')
2956 if tracks and isinstance(tracks, list):
2957 for track in tracks:
96a2daa1
S
2958 if not isinstance(track, dict):
2959 continue
f4b74272
S
2960 track_kind = track.get('kind')
2961 if not track_kind or not isinstance(track_kind, compat_str):
2962 continue
2963 if track_kind.lower() not in ('captions', 'subtitles'):
a4a554a7
YCH
2964 continue
2965 track_url = urljoin(base_url, track.get('file'))
2966 if not track_url:
2967 continue
2968 subtitles.setdefault(track.get('label') or 'en', []).append({
2969 'url': self._proto_relative_url(track_url)
2970 })
2971
50d808f5 2972 entry = {
a4a554a7 2973 'id': this_video_id,
50d808f5 2974 'title': unescapeHTML(video_data['title'] if require_title else video_data.get('title')),
f81dd65b 2975 'description': clean_html(video_data.get('description')),
6945b9e7 2976 'thumbnail': urljoin(base_url, self._proto_relative_url(video_data.get('image'))),
a4a554a7
YCH
2977 'timestamp': int_or_none(video_data.get('pubdate')),
2978 'duration': float_or_none(jwplayer_data.get('duration') or video_data.get('duration')),
2979 'subtitles': subtitles,
50d808f5
RA
2980 }
2981 # https://github.com/jwplayer/jwplayer/blob/master/src/js/utils/validator.js#L32
2982 if len(formats) == 1 and re.search(r'^(?:http|//).*(?:youtube\.com|youtu\.be)/.+', formats[0]['url']):
2983 entry.update({
2984 '_type': 'url_transparent',
2985 'url': formats[0]['url'],
2986 })
2987 else:
2988 self._sort_formats(formats)
2989 entry['formats'] = formats
2990 entries.append(entry)
a4a554a7
YCH
2991 if len(entries) == 1:
2992 return entries[0]
2993 else:
2994 return self.playlist_result(entries)
2995
ed0cf9b3
S
2996 def _parse_jwplayer_formats(self, jwplayer_sources_data, video_id=None,
2997 m3u8_id=None, mpd_id=None, rtmp_params=None, base_url=None):
bf1b87cd 2998 urls = []
ed0cf9b3 2999 formats = []
1a2192cb 3000 for source in jwplayer_sources_data:
0a268c6e
S
3001 if not isinstance(source, dict):
3002 continue
6945b9e7
RA
3003 source_url = urljoin(
3004 base_url, self._proto_relative_url(source.get('file')))
3005 if not source_url or source_url in urls:
bf1b87cd
RA
3006 continue
3007 urls.append(source_url)
ed0cf9b3
S
3008 source_type = source.get('type') or ''
3009 ext = mimetype2ext(source_type) or determine_ext(source_url)
3010 if source_type == 'hls' or ext == 'm3u8':
3011 formats.extend(self._extract_m3u8_formats(
0236cd0d
S
3012 source_url, video_id, 'mp4', entry_protocol='m3u8_native',
3013 m3u8_id=m3u8_id, fatal=False))
0d9c48de 3014 elif source_type == 'dash' or ext == 'mpd':
ed0cf9b3
S
3015 formats.extend(self._extract_mpd_formats(
3016 source_url, video_id, mpd_id=mpd_id, fatal=False))
b51dc9db
S
3017 elif ext == 'smil':
3018 formats.extend(self._extract_smil_formats(
3019 source_url, video_id, fatal=False))
ed0cf9b3 3020 # https://github.com/jwplayer/jwplayer/blob/master/src/js/providers/default.js#L67
0236cd0d
S
3021 elif source_type.startswith('audio') or ext in (
3022 'oga', 'aac', 'mp3', 'mpeg', 'vorbis'):
ed0cf9b3
S
3023 formats.append({
3024 'url': source_url,
3025 'vcodec': 'none',
3026 'ext': ext,
3027 })
3028 else:
3029 height = int_or_none(source.get('height'))
3030 if height is None:
3031 # Often no height is provided but there is a label in
0236cd0d 3032 # format like "1080p", "720p SD", or 1080.
ed0cf9b3 3033 height = int_or_none(self._search_regex(
0236cd0d 3034 r'^(\d{3,4})[pP]?(?:\b|$)', compat_str(source.get('label') or ''),
ed0cf9b3
S
3035 'height', default=None))
3036 a_format = {
3037 'url': source_url,
3038 'width': int_or_none(source.get('width')),
3039 'height': height,
0236cd0d 3040 'tbr': int_or_none(source.get('bitrate')),
ed0cf9b3
S
3041 'ext': ext,
3042 }
3043 if source_url.startswith('rtmp'):
3044 a_format['ext'] = 'flv'
ed0cf9b3
S
3045 # See com/longtailvideo/jwplayer/media/RTMPMediaProvider.as
3046 # of jwplayer.flash.swf
3047 rtmp_url_parts = re.split(
3048 r'((?:mp4|mp3|flv):)', source_url, 1)
3049 if len(rtmp_url_parts) == 3:
3050 rtmp_url, prefix, play_path = rtmp_url_parts
3051 a_format.update({
3052 'url': rtmp_url,
3053 'play_path': prefix + play_path,
3054 })
3055 if rtmp_params:
3056 a_format.update(rtmp_params)
3057 formats.append(a_format)
3058 return formats
3059
f4b1c7ad
PH
3060 def _live_title(self, name):
3061 """ Generate the title for a live video """
3062 now = datetime.datetime.now()
611c1dd9 3063 now_str = now.strftime('%Y-%m-%d %H:%M')
f4b1c7ad
PH
3064 return name + ' ' + now_str
3065
b14f3a4c
PH
3066 def _int(self, v, name, fatal=False, **kwargs):
3067 res = int_or_none(v, **kwargs)
3068 if 'get_attr' in kwargs:
3069 print(getattr(v, kwargs['get_attr']))
3070 if res is None:
3071 msg = 'Failed to extract %s: Could not parse value %r' % (name, v)
3072 if fatal:
3073 raise ExtractorError(msg)
3074 else:
3075 self._downloader.report_warning(msg)
3076 return res
3077
3078 def _float(self, v, name, fatal=False, **kwargs):
3079 res = float_or_none(v, **kwargs)
3080 if res is None:
3081 msg = 'Failed to extract %s: Could not parse value %r' % (name, v)
3082 if fatal:
3083 raise ExtractorError(msg)
3084 else:
3085 self._downloader.report_warning(msg)
3086 return res
3087
40e41780
TF
3088 def _set_cookie(self, domain, name, value, expire_time=None, port=None,
3089 path='/', secure=False, discard=False, rest={}, **kwargs):
6c22cee6 3090 cookie = compat_cookiejar_Cookie(
4ed2d7b7 3091 0, name, value, port, port is not None, domain, True,
40e41780
TF
3092 domain.startswith('.'), path, True, secure, expire_time,
3093 discard, None, None, rest)
42939b61
JMF
3094 self._downloader.cookiejar.set_cookie(cookie)
3095
799207e8 3096 def _get_cookies(self, url):
3097 """ Return a compat_cookies.SimpleCookie with the cookies for the url """
5c2266df 3098 req = sanitized_Request(url)
799207e8 3099 self._downloader.cookiejar.add_cookie_header(req)
3100 return compat_cookies.SimpleCookie(req.get_header('Cookie'))
3101
e3c1266f 3102 def _apply_first_set_cookie_header(self, url_handle, cookie):
ce2fe4c0
S
3103 """
3104 Apply first Set-Cookie header instead of the last. Experimental.
3105
3106 Some sites (e.g. [1-3]) may serve two cookies under the same name
3107 in Set-Cookie header and expect the first (old) one to be set rather
3108 than second (new). However, as of RFC6265 the newer one cookie
3109 should be set into cookie store what actually happens.
3110 We will workaround this issue by resetting the cookie to
3111 the first one manually.
3112 1. https://new.vk.com/
3113 2. https://github.com/ytdl-org/youtube-dl/issues/9841#issuecomment-227871201
3114 3. https://learning.oreilly.com/
3115 """
e3c1266f
S
3116 for header, cookies in url_handle.headers.items():
3117 if header.lower() != 'set-cookie':
3118 continue
3119 if sys.version_info[0] >= 3:
3120 cookies = cookies.encode('iso-8859-1')
3121 cookies = cookies.decode('utf-8')
3122 cookie_value = re.search(
3123 r'%s=(.+?);.*?\b[Dd]omain=(.+?)(?:[,;]|$)' % cookie, cookies)
3124 if cookie_value:
3125 value, domain = cookie_value.groups()
3126 self._set_cookie(domain, cookie, value)
3127 break
3128
05900629
PH
3129 def get_testcases(self, include_onlymatching=False):
3130 t = getattr(self, '_TEST', None)
3131 if t:
3132 assert not hasattr(self, '_TESTS'), \
3133 '%s has _TEST and _TESTS' % type(self).__name__
3134 tests = [t]
3135 else:
3136 tests = getattr(self, '_TESTS', [])
3137 for t in tests:
3138 if not include_onlymatching and t.get('only_matching', False):
3139 continue
3140 t['name'] = type(self).__name__[:-len('IE')]
3141 yield t
3142
3143 def is_suitable(self, age_limit):
3144 """ Test whether the extractor is generally suitable for the given
3145 age limit (i.e. pornographic sites are not, all others usually are) """
3146
3147 any_restricted = False
3148 for tc in self.get_testcases(include_onlymatching=False):
40090e8d 3149 if tc.get('playlist', []):
05900629
PH
3150 tc = tc['playlist'][0]
3151 is_restricted = age_restricted(
3152 tc.get('info_dict', {}).get('age_limit'), age_limit)
3153 if not is_restricted:
3154 return True
3155 any_restricted = any_restricted or is_restricted
3156 return not any_restricted
3157
a504ced0 3158 def extract_subtitles(self, *args, **kwargs):
3089bc74
S
3159 if (self._downloader.params.get('writesubtitles', False)
3160 or self._downloader.params.get('listsubtitles')):
9868ea49
JMF
3161 return self._get_subtitles(*args, **kwargs)
3162 return {}
a504ced0
JMF
3163
3164 def _get_subtitles(self, *args, **kwargs):
611c1dd9 3165 raise NotImplementedError('This method must be implemented by subclasses')
a504ced0 3166
912e0b7e
YCH
3167 @staticmethod
3168 def _merge_subtitle_items(subtitle_list1, subtitle_list2):
3169 """ Merge subtitle items for one language. Items with duplicated URLs
3170 will be dropped. """
3171 list1_urls = set([item['url'] for item in subtitle_list1])
3172 ret = list(subtitle_list1)
3173 ret.extend([item for item in subtitle_list2 if item['url'] not in list1_urls])
3174 return ret
3175
3176 @classmethod
8c97f819 3177 def _merge_subtitles(cls, subtitle_dict1, subtitle_dict2):
912e0b7e 3178 """ Merge two subtitle dictionaries, language by language. """
912e0b7e
YCH
3179 ret = dict(subtitle_dict1)
3180 for lang in subtitle_dict2:
8c97f819 3181 ret[lang] = cls._merge_subtitle_items(subtitle_dict1.get(lang, []), subtitle_dict2[lang])
912e0b7e
YCH
3182 return ret
3183
360e1ca5 3184 def extract_automatic_captions(self, *args, **kwargs):
3089bc74
S
3185 if (self._downloader.params.get('writeautomaticsub', False)
3186 or self._downloader.params.get('listsubtitles')):
9868ea49
JMF
3187 return self._get_automatic_captions(*args, **kwargs)
3188 return {}
360e1ca5
JMF
3189
3190 def _get_automatic_captions(self, *args, **kwargs):
611c1dd9 3191 raise NotImplementedError('This method must be implemented by subclasses')
360e1ca5 3192
d77ab8e2 3193 def mark_watched(self, *args, **kwargs):
3089bc74
S
3194 if (self._downloader.params.get('mark_watched', False)
3195 and (self._get_login_info()[0] is not None
3196 or self._downloader.params.get('cookiefile') is not None)):
d77ab8e2
S
3197 self._mark_watched(*args, **kwargs)
3198
3199 def _mark_watched(self, *args, **kwargs):
3200 raise NotImplementedError('This method must be implemented by subclasses')
3201
38cce791
YCH
3202 def geo_verification_headers(self):
3203 headers = {}
3204 geo_verification_proxy = self._downloader.params.get('geo_verification_proxy')
3205 if geo_verification_proxy:
3206 headers['Ytdl-request-proxy'] = geo_verification_proxy
3207 return headers
3208
98763ee3
YCH
3209 def _generic_id(self, url):
3210 return compat_urllib_parse_unquote(os.path.splitext(url.rstrip('/').split('/')[-1])[0])
3211
3212 def _generic_title(self, url):
3213 return compat_urllib_parse_unquote(os.path.splitext(url_basename(url))[0])
3214
8dbe9899 3215
d6983cb4
PH
3216class SearchInfoExtractor(InfoExtractor):
3217 """
3218 Base class for paged search queries extractors.
10952eb2 3219 They accept URLs in the format _SEARCH_KEY(|all|[0-9]):{query}
d6983cb4
PH
3220 Instances should define _SEARCH_KEY and _MAX_RESULTS.
3221 """
3222
3223 @classmethod
3224 def _make_valid_url(cls):
3225 return r'%s(?P<prefix>|[1-9][0-9]*|all):(?P<query>[\s\S]+)' % cls._SEARCH_KEY
3226
3227 @classmethod
3228 def suitable(cls, url):
3229 return re.match(cls._make_valid_url(), url) is not None
3230
3231 def _real_extract(self, query):
3232 mobj = re.match(self._make_valid_url(), query)
3233 if mobj is None:
f1a9d64e 3234 raise ExtractorError('Invalid search query "%s"' % query)
d6983cb4
PH
3235
3236 prefix = mobj.group('prefix')
3237 query = mobj.group('query')
3238 if prefix == '':
3239 return self._get_n_results(query, 1)
3240 elif prefix == 'all':
3241 return self._get_n_results(query, self._MAX_RESULTS)
3242 else:
3243 n = int(prefix)
3244 if n <= 0:
f1a9d64e 3245 raise ExtractorError('invalid download number %s for query "%s"' % (n, query))
d6983cb4 3246 elif n > self._MAX_RESULTS:
f1a9d64e 3247 self._downloader.report_warning('%s returns max %i results (you requested %i)' % (self._SEARCH_KEY, self._MAX_RESULTS, n))
d6983cb4
PH
3248 n = self._MAX_RESULTS
3249 return self._get_n_results(query, n)
3250
3251 def _get_n_results(self, query, n):
3252 """Get a specified number of results for a query"""
611c1dd9 3253 raise NotImplementedError('This method must be implemented by subclasses')
0f818663
PH
3254
3255 @property
3256 def SEARCH_KEY(self):
3257 return self._SEARCH_KEY