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