]>
Commit | Line | Data |
---|---|---|
f1a9d64e PH |
1 | from __future__ import unicode_literals |
2 | ||
d6983cb4 | 3 | import base64 |
f4b1c7ad | 4 | import datetime |
3ec05685 | 5 | import hashlib |
3d3538e4 | 6 | import json |
4094b6e3 | 7 | import netrc |
d6983cb4 PH |
8 | import os |
9 | import re | |
10 | import socket | |
11 | import sys | |
4094b6e3 | 12 | import time |
267ed0c5 | 13 | import xml.etree.ElementTree |
d6983cb4 | 14 | |
8c25f81b | 15 | from ..compat import ( |
42939b61 | 16 | compat_cookiejar, |
799207e8 | 17 | compat_cookies, |
e64b7569 | 18 | compat_getpass, |
d6983cb4 PH |
19 | compat_http_client, |
20 | compat_urllib_error, | |
a107193e | 21 | compat_urllib_parse, |
c7deaa4c | 22 | compat_urllib_parse_urlparse, |
799207e8 | 23 | compat_urllib_request, |
f0b5d6af | 24 | compat_urlparse, |
d6983cb4 | 25 | compat_str, |
8c25f81b PH |
26 | ) |
27 | from ..utils import ( | |
c342041f | 28 | NO_DEFAULT, |
05900629 | 29 | age_restricted, |
08f2a92c | 30 | bug_reports_message, |
d6983cb4 PH |
31 | clean_html, |
32 | compiled_regex_type, | |
70f0f5a8 | 33 | determine_ext, |
d6983cb4 | 34 | ExtractorError, |
97f4aecf | 35 | fix_xml_ampersands, |
b14f3a4c | 36 | float_or_none, |
31bb8d3f | 37 | int_or_none, |
55b3e45b | 38 | RegexNotFoundError, |
d41e6efc | 39 | sanitize_filename, |
f38de77f | 40 | unescapeHTML, |
647eab45 | 41 | unified_strdate, |
a107193e | 42 | url_basename, |
8d6765cf S |
43 | xpath_text, |
44 | xpath_with_ns, | |
d6983cb4 | 45 | ) |
c342041f | 46 | |
d6983cb4 PH |
47 | |
48 | class InfoExtractor(object): | |
49 | """Information Extractor class. | |
50 | ||
51 | Information extractors are the classes that, given a URL, extract | |
52 | information about the video (or videos) the URL refers to. This | |
53 | information includes the real video URL, the video title, author and | |
54 | others. The information is stored in a dictionary which is then | |
5d380852 | 55 | passed to the YoutubeDL. The YoutubeDL processes this |
d6983cb4 PH |
56 | information possibly downloading the video to the file system, among |
57 | other possible outcomes. | |
58 | ||
cf0649f8 | 59 | The type field determines the type of the result. |
fed5d032 PH |
60 | By far the most common value (and the default if _type is missing) is |
61 | "video", which indicates a single video. | |
62 | ||
63 | For a video, the dictionaries must include the following fields: | |
d6983cb4 PH |
64 | |
65 | id: Video identifier. | |
d6983cb4 | 66 | title: Video title, unescaped. |
d67b0b15 | 67 | |
f49d89ee | 68 | Additionally, it must contain either a formats entry or a url one: |
d67b0b15 | 69 | |
f49d89ee PH |
70 | formats: A list of dictionaries for each format available, ordered |
71 | from worst to best quality. | |
72 | ||
73 | Potential fields: | |
d67b0b15 | 74 | * url Mandatory. The URL of the video file |
10952eb2 | 75 | * ext Will be calculated from URL if missing |
d67b0b15 PH |
76 | * format A human-readable description of the format |
77 | ("mp4 container with h264/opus"). | |
78 | Calculated from the format_id, width, height. | |
79 | and format_note fields if missing. | |
80 | * format_id A short description of the format | |
5d4f3985 PH |
81 | ("mp4_h264_opus" or "19"). |
82 | Technically optional, but strongly recommended. | |
d67b0b15 PH |
83 | * format_note Additional info about the format |
84 | ("3D" or "DASH video") | |
85 | * width Width of the video, if known | |
86 | * height Height of the video, if known | |
f49d89ee | 87 | * resolution Textual description of width and height |
7217e148 | 88 | * tbr Average bitrate of audio and video in KBit/s |
d67b0b15 PH |
89 | * abr Average audio bitrate in KBit/s |
90 | * acodec Name of the audio codec in use | |
dd27fd17 | 91 | * asr Audio sampling rate in Hertz |
d67b0b15 | 92 | * vbr Average video bitrate in KBit/s |
fbb21cf5 | 93 | * fps Frame rate |
d67b0b15 | 94 | * vcodec Name of the video codec in use |
1394ce65 | 95 | * container Name of the container format |
d67b0b15 | 96 | * filesize The number of bytes, if known in advance |
9732d77e | 97 | * filesize_approx An estimate for the number of bytes |
d67b0b15 | 98 | * player_url SWF Player URL (used for rtmpdump). |
c7deaa4c PH |
99 | * protocol The protocol that will be used for the actual |
100 | download, lower-case. | |
b04b8852 PH |
101 | "http", "https", "rtsp", "rtmp", "rtmpe", |
102 | "m3u8", or "m3u8_native". | |
f49d89ee | 103 | * preference Order number of this format. If this field is |
08d13955 | 104 | present and not None, the formats get sorted |
38d63d84 | 105 | by this field, regardless of all other values. |
f49d89ee PH |
106 | -1 for default (order by other properties), |
107 | -2 or smaller for less than default. | |
e65566a9 PH |
108 | < -1000 to hide the format (if there is |
109 | another one which is strictly better) | |
aff2f4f4 PH |
110 | * language_preference Is this in the correct requested |
111 | language? | |
112 | 10 if it's what the URL is about, | |
113 | -1 for default (don't know), | |
114 | -10 otherwise, other values reserved for now. | |
5d73273f PH |
115 | * quality Order number of the video quality of this |
116 | format, irrespective of the file format. | |
117 | -1 for default (order by other properties), | |
118 | -2 or smaller for less than default. | |
c64ed2a3 PH |
119 | * source_preference Order number for this video source |
120 | (quality takes higher priority) | |
121 | -1 for default (order by other properties), | |
122 | -2 or smaller for less than default. | |
d769be6c PH |
123 | * http_headers A dictionary of additional HTTP headers |
124 | to add to the request. | |
6271f1ca | 125 | * stretched_ratio If given and not 1, indicates that the |
3dee7826 PH |
126 | video's pixels are not square. |
127 | width : height ratio as float. | |
128 | * no_resume The server does not support resuming the | |
129 | (HTTP or RTMP) download. Boolean. | |
130 | ||
c0ba0f48 | 131 | url: Final video URL. |
d6983cb4 | 132 | ext: Video filename extension. |
d67b0b15 PH |
133 | format: The video format, defaults to ext (used for --get-format) |
134 | player_url: SWF Player URL (used for rtmpdump). | |
2f5865cc | 135 | |
d6983cb4 PH |
136 | The following fields are optional: |
137 | ||
f5e43bc6 | 138 | alt_title: A secondary title of the video. |
0afef30b PH |
139 | display_id An alternative identifier for the video, not necessarily |
140 | unique, but available before title. Typically, id is | |
141 | something like "4234987", title "Dancing naked mole rats", | |
142 | and display_id "dancing-naked-mole-rats" | |
d5519808 | 143 | thumbnails: A list of dictionaries, with the following entries: |
cfb56d1a | 144 | * "id" (optional, string) - Thumbnail format ID |
d5519808 | 145 | * "url" |
cfb56d1a | 146 | * "preference" (optional, int) - quality of the image |
d5519808 PH |
147 | * "width" (optional, int) |
148 | * "height" (optional, int) | |
149 | * "resolution" (optional, string "{width}x{height"}, | |
150 | deprecated) | |
d6983cb4 | 151 | thumbnail: Full URL to a video thumbnail image. |
f5e43bc6 | 152 | description: Full video description. |
d6983cb4 | 153 | uploader: Full name of the video uploader. |
9bb8e0a3 | 154 | creator: The main artist who created the video. |
8aab976b | 155 | release_date: The date (YYYYMMDD) when the video was released. |
955c4514 | 156 | timestamp: UNIX timestamp of the moment the video became available. |
d6983cb4 | 157 | upload_date: Video upload date (YYYYMMDD). |
955c4514 | 158 | If not explicitly set, calculated from timestamp. |
d6983cb4 | 159 | uploader_id: Nickname or id of the video uploader. |
da9ec3b9 | 160 | location: Physical location where the video was filmed. |
a504ced0 JMF |
161 | subtitles: The available subtitles as a dictionary in the format |
162 | {language: subformats}. "subformats" is a list sorted from | |
163 | lower to higher preference, each element is a dictionary | |
164 | with the "ext" entry and one of: | |
165 | * "data": The subtitles file contents | |
10952eb2 | 166 | * "url": A URL pointing to the subtitles file |
4bba3716 | 167 | "ext" will be calculated from URL if missing |
360e1ca5 JMF |
168 | automatic_captions: Like 'subtitles', used by the YoutubeIE for |
169 | automatically generated captions | |
c0ba0f48 | 170 | duration: Length of the video in seconds, as an integer. |
f3d29461 | 171 | view_count: How many users have watched the video on the platform. |
19e3dfc9 PH |
172 | like_count: Number of positive ratings of the video |
173 | dislike_count: Number of negative ratings of the video | |
02835c6b | 174 | repost_count: Number of reposts of the video |
2d30521a | 175 | average_rating: Average rating give by users, the scale used depends on the webpage |
19e3dfc9 | 176 | comment_count: Number of comments on the video |
dd622d7c PH |
177 | comments: A list of comments, each with one or more of the following |
178 | properties (all but one of text or html optional): | |
179 | * "author" - human-readable name of the comment author | |
180 | * "author_id" - user ID of the comment author | |
181 | * "id" - Comment ID | |
182 | * "html" - Comment as HTML | |
183 | * "text" - Plain text of the comment | |
184 | * "timestamp" - UNIX timestamp of comment | |
185 | * "parent" - ID of the comment this one is replying to. | |
186 | Set to "root" to indicate that this is a | |
187 | comment to the original video. | |
8dbe9899 | 188 | age_limit: Age restriction for the video, as an integer (years) |
10952eb2 | 189 | webpage_url: The URL to the video webpage, if given to youtube-dl it |
9103bbc5 JMF |
190 | should allow to get the same result again. (It will be set |
191 | by YoutubeDL if it's missing) | |
ad3bc6ac PH |
192 | categories: A list of categories that the video falls in, for example |
193 | ["Sports", "Berlin"] | |
864f24bd | 194 | tags: A list of tags assigned to the video, e.g. ["sweden", "pop music"] |
7267bd53 PH |
195 | is_live: True, False, or None (=unknown). Whether this video is a |
196 | live stream that goes on instead of a fixed-length video. | |
7c80519c | 197 | start_time: Time in seconds where the reproduction should start, as |
10952eb2 | 198 | specified in the URL. |
297a564b | 199 | end_time: Time in seconds where the reproduction should end, as |
10952eb2 | 200 | specified in the URL. |
d6983cb4 | 201 | |
deefc05b | 202 | Unless mentioned otherwise, the fields should be Unicode strings. |
d6983cb4 | 203 | |
d838b1bd PH |
204 | Unless mentioned otherwise, None is equivalent to absence of information. |
205 | ||
fed5d032 PH |
206 | |
207 | _type "playlist" indicates multiple videos. | |
b82f815f PH |
208 | There must be a key "entries", which is a list, an iterable, or a PagedList |
209 | object, each element of which is a valid dictionary by this specification. | |
fed5d032 | 210 | |
e0b9d78f S |
211 | Additionally, playlists can have "title", "description" and "id" attributes |
212 | with the same semantics as videos (see above). | |
fed5d032 PH |
213 | |
214 | ||
215 | _type "multi_video" indicates that there are multiple videos that | |
216 | form a single show, for examples multiple acts of an opera or TV episode. | |
217 | It must have an entries key like a playlist and contain all the keys | |
218 | required for a video at the same time. | |
219 | ||
220 | ||
221 | _type "url" indicates that the video must be extracted from another | |
222 | location, possibly by a different extractor. Its only required key is: | |
223 | "url" - the next URL to extract. | |
f58766ce PH |
224 | The key "ie_key" can be set to the class name (minus the trailing "IE", |
225 | e.g. "Youtube") if the extractor class is known in advance. | |
226 | Additionally, the dictionary may have any properties of the resolved entity | |
227 | known in advance, for example "title" if the title of the referred video is | |
fed5d032 PH |
228 | known ahead of time. |
229 | ||
230 | ||
231 | _type "url_transparent" entities have the same specification as "url", but | |
232 | indicate that the given additional information is more precise than the one | |
233 | associated with the resolved URL. | |
234 | This is useful when a site employs a video service that hosts the video and | |
235 | its technical metadata, but that video service does not embed a useful | |
236 | title, description etc. | |
237 | ||
238 | ||
d6983cb4 PH |
239 | Subclasses of this one should re-define the _real_initialize() and |
240 | _real_extract() methods and define a _VALID_URL regexp. | |
241 | Probably, they should also be added to the list of extractors. | |
242 | ||
d6983cb4 PH |
243 | Finally, the _WORKING attribute should be set to False for broken IEs |
244 | in order to warn the users and skip the tests. | |
245 | """ | |
246 | ||
247 | _ready = False | |
248 | _downloader = None | |
249 | _WORKING = True | |
250 | ||
251 | def __init__(self, downloader=None): | |
252 | """Constructor. Receives an optional downloader.""" | |
253 | self._ready = False | |
254 | self.set_downloader(downloader) | |
255 | ||
256 | @classmethod | |
257 | def suitable(cls, url): | |
258 | """Receives a URL and returns True if suitable for this IE.""" | |
79cb2577 PH |
259 | |
260 | # This does not use has/getattr intentionally - we want to know whether | |
261 | # we have cached the regexp for *this* class, whereas getattr would also | |
262 | # match the superclass | |
263 | if '_VALID_URL_RE' not in cls.__dict__: | |
264 | cls._VALID_URL_RE = re.compile(cls._VALID_URL) | |
265 | return cls._VALID_URL_RE.match(url) is not None | |
d6983cb4 | 266 | |
ed9266db PH |
267 | @classmethod |
268 | def _match_id(cls, url): | |
269 | if '_VALID_URL_RE' not in cls.__dict__: | |
270 | cls._VALID_URL_RE = re.compile(cls._VALID_URL) | |
271 | m = cls._VALID_URL_RE.match(url) | |
272 | assert m | |
273 | return m.group('id') | |
274 | ||
d6983cb4 PH |
275 | @classmethod |
276 | def working(cls): | |
277 | """Getter method for _WORKING.""" | |
278 | return cls._WORKING | |
279 | ||
280 | def initialize(self): | |
281 | """Initializes an instance (authentication, etc).""" | |
282 | if not self._ready: | |
283 | self._real_initialize() | |
284 | self._ready = True | |
285 | ||
286 | def extract(self, url): | |
287 | """Extracts URL information and returns it in list of dicts.""" | |
3a5bcd03 PH |
288 | try: |
289 | self.initialize() | |
290 | return self._real_extract(url) | |
291 | except ExtractorError: | |
292 | raise | |
293 | except compat_http_client.IncompleteRead as e: | |
294 | raise ExtractorError('A network error has occured.', cause=e, expected=True) | |
9650885b | 295 | except (KeyError, StopIteration) as e: |
3a5bcd03 | 296 | raise ExtractorError('An extractor error has occured.', cause=e) |
d6983cb4 PH |
297 | |
298 | def set_downloader(self, downloader): | |
299 | """Sets the downloader for this IE.""" | |
300 | self._downloader = downloader | |
301 | ||
302 | def _real_initialize(self): | |
303 | """Real initialization process. Redefine in subclasses.""" | |
304 | pass | |
305 | ||
306 | def _real_extract(self, url): | |
307 | """Real extraction process. Redefine in subclasses.""" | |
308 | pass | |
309 | ||
56c73665 JMF |
310 | @classmethod |
311 | def ie_key(cls): | |
312 | """A string for getting the InfoExtractor with get_info_extractor""" | |
313 | return cls.__name__[:-2] | |
314 | ||
d6983cb4 PH |
315 | @property |
316 | def IE_NAME(self): | |
317 | return type(self).__name__[:-2] | |
318 | ||
7cc3570e | 319 | def _request_webpage(self, url_or_request, video_id, note=None, errnote=None, fatal=True): |
d6983cb4 PH |
320 | """ Returns the response handle """ |
321 | if note is None: | |
322 | self.report_download_webpage(video_id) | |
323 | elif note is not False: | |
7cc3570e | 324 | if video_id is None: |
f1a9d64e | 325 | self.to_screen('%s' % (note,)) |
7cc3570e | 326 | else: |
f1a9d64e | 327 | self.to_screen('%s: %s' % (video_id, note)) |
d6983cb4 | 328 | try: |
dca08720 | 329 | return self._downloader.urlopen(url_or_request) |
d6983cb4 | 330 | except (compat_urllib_error.URLError, compat_http_client.HTTPException, socket.error) as err: |
aa94a6d3 PH |
331 | if errnote is False: |
332 | return False | |
d6983cb4 | 333 | if errnote is None: |
f1a9d64e PH |
334 | errnote = 'Unable to download webpage' |
335 | errmsg = '%s: %s' % (errnote, compat_str(err)) | |
7cc3570e PH |
336 | if fatal: |
337 | raise ExtractorError(errmsg, sys.exc_info()[2], cause=err) | |
338 | else: | |
339 | self._downloader.report_warning(errmsg) | |
340 | return False | |
d6983cb4 | 341 | |
c9a77969 | 342 | def _download_webpage_handle(self, url_or_request, video_id, note=None, errnote=None, fatal=True, encoding=None): |
d6983cb4 | 343 | """ Returns a tuple (page content as string, URL handle) """ |
b9d3e163 PH |
344 | # Strip hashes from the URL (#1038) |
345 | if isinstance(url_or_request, (compat_str, str)): | |
346 | url_or_request = url_or_request.partition('#')[0] | |
347 | ||
7cc3570e PH |
348 | urlh = self._request_webpage(url_or_request, video_id, note, errnote, fatal) |
349 | if urlh is False: | |
350 | assert not fatal | |
351 | return False | |
c9a77969 | 352 | content = self._webpage_read_content(urlh, url_or_request, video_id, note, errnote, fatal, encoding=encoding) |
23be51d8 PH |
353 | return (content, urlh) |
354 | ||
c9a77969 YCH |
355 | @staticmethod |
356 | def _guess_encoding_from_content(content_type, webpage_bytes): | |
d6983cb4 PH |
357 | m = re.match(r'[a-zA-Z0-9_.-]+/[a-zA-Z0-9_.-]+\s*;\s*charset=(.+)', content_type) |
358 | if m: | |
359 | encoding = m.group(1) | |
360 | else: | |
0d75ae2c | 361 | m = re.search(br'<meta[^>]+charset=[\'"]?([^\'")]+)[ /\'">]', |
f143d86a PH |
362 | webpage_bytes[:1024]) |
363 | if m: | |
364 | encoding = m.group(1).decode('ascii') | |
b60016e8 PH |
365 | elif webpage_bytes.startswith(b'\xff\xfe'): |
366 | encoding = 'utf-16' | |
f143d86a PH |
367 | else: |
368 | encoding = 'utf-8' | |
c9a77969 YCH |
369 | |
370 | return encoding | |
371 | ||
372 | def _webpage_read_content(self, urlh, url_or_request, video_id, note=None, errnote=None, fatal=True, prefix=None, encoding=None): | |
373 | content_type = urlh.headers.get('Content-Type', '') | |
374 | webpage_bytes = urlh.read() | |
375 | if prefix is not None: | |
376 | webpage_bytes = prefix + webpage_bytes | |
377 | if not encoding: | |
378 | encoding = self._guess_encoding_from_content(content_type, webpage_bytes) | |
d6983cb4 PH |
379 | if self._downloader.params.get('dump_intermediate_pages', False): |
380 | try: | |
381 | url = url_or_request.get_full_url() | |
382 | except AttributeError: | |
383 | url = url_or_request | |
f1a9d64e | 384 | self.to_screen('Dumping request to ' + url) |
d6983cb4 PH |
385 | dump = base64.b64encode(webpage_bytes).decode('ascii') |
386 | self._downloader.to_screen(dump) | |
d41e6efc PH |
387 | if self._downloader.params.get('write_pages', False): |
388 | try: | |
389 | url = url_or_request.get_full_url() | |
390 | except AttributeError: | |
391 | url = url_or_request | |
5afa7f8b | 392 | basen = '%s_%s' % (video_id, url) |
c1bce22f | 393 | if len(basen) > 240: |
f1a9d64e | 394 | h = '___' + hashlib.md5(basen.encode('utf-8')).hexdigest() |
c1bce22f PH |
395 | basen = basen[:240 - len(h)] + h |
396 | raw_filename = basen + '.dump' | |
d41e6efc | 397 | filename = sanitize_filename(raw_filename, restricted=True) |
f1a9d64e | 398 | self.to_screen('Saving request to ' + filename) |
5f58165d S |
399 | # Working around MAX_PATH limitation on Windows (see |
400 | # http://msdn.microsoft.com/en-us/library/windows/desktop/aa365247(v=vs.85).aspx) | |
401 | if os.name == 'nt': | |
402 | absfilepath = os.path.abspath(filename) | |
403 | if len(absfilepath) > 259: | |
404 | filename = '\\\\?\\' + absfilepath | |
d41e6efc PH |
405 | with open(filename, 'wb') as outf: |
406 | outf.write(webpage_bytes) | |
407 | ||
ec0fafbb AA |
408 | try: |
409 | content = webpage_bytes.decode(encoding, 'replace') | |
410 | except LookupError: | |
411 | content = webpage_bytes.decode('utf-8', 'replace') | |
2410c43d | 412 | |
f1a9d64e PH |
413 | if ('<title>Access to this site is blocked</title>' in content and |
414 | 'Websense' in content[:512]): | |
415 | msg = 'Access to this webpage has been blocked by Websense filtering software in your network.' | |
2410c43d PH |
416 | blocked_iframe = self._html_search_regex( |
417 | r'<iframe src="([^"]+)"', content, | |
f1a9d64e | 418 | 'Websense information URL', default=None) |
2410c43d | 419 | if blocked_iframe: |
f1a9d64e | 420 | msg += ' Visit %s for more details' % blocked_iframe |
2410c43d | 421 | raise ExtractorError(msg, expected=True) |
77b2986b PH |
422 | if '<title>The URL you requested has been blocked</title>' in content[:512]: |
423 | msg = ( | |
424 | 'Access to this webpage has been blocked by Indian censorship. ' | |
425 | 'Use a VPN or proxy server (with --proxy) to route around it.') | |
426 | block_msg = self._html_search_regex( | |
427 | r'</h1><p>(.*?)</p>', | |
428 | content, 'block message', default=None) | |
429 | if block_msg: | |
430 | msg += ' (Message: "%s")' % block_msg.replace('\n', ' ') | |
431 | raise ExtractorError(msg, expected=True) | |
2410c43d | 432 | |
23be51d8 | 433 | return content |
d6983cb4 | 434 | |
c9a77969 | 435 | def _download_webpage(self, url_or_request, video_id, note=None, errnote=None, fatal=True, tries=1, timeout=5, encoding=None): |
d6983cb4 | 436 | """ Returns the data of the page as a string """ |
995ad69c TF |
437 | success = False |
438 | try_count = 0 | |
439 | while success is False: | |
440 | try: | |
c9a77969 | 441 | res = self._download_webpage_handle(url_or_request, video_id, note, errnote, fatal, encoding=encoding) |
995ad69c TF |
442 | success = True |
443 | except compat_http_client.IncompleteRead as e: | |
444 | try_count += 1 | |
445 | if try_count >= tries: | |
446 | raise e | |
447 | self._sleep(timeout, video_id) | |
7cc3570e PH |
448 | if res is False: |
449 | return res | |
450 | else: | |
451 | content, _ = res | |
452 | return content | |
d6983cb4 | 453 | |
2a275ab0 | 454 | def _download_xml(self, url_or_request, video_id, |
f1a9d64e | 455 | note='Downloading XML', errnote='Unable to download XML', |
c9a77969 | 456 | transform_source=None, fatal=True, encoding=None): |
267ed0c5 | 457 | """Return the xml as an xml.etree.ElementTree.Element""" |
28746fbd | 458 | xml_string = self._download_webpage( |
c9a77969 | 459 | url_or_request, video_id, note, errnote, fatal=fatal, encoding=encoding) |
28746fbd PH |
460 | if xml_string is False: |
461 | return xml_string | |
e2b38da9 PH |
462 | if transform_source: |
463 | xml_string = transform_source(xml_string) | |
267ed0c5 JMF |
464 | return xml.etree.ElementTree.fromstring(xml_string.encode('utf-8')) |
465 | ||
3d3538e4 | 466 | def _download_json(self, url_or_request, video_id, |
f1a9d64e PH |
467 | note='Downloading JSON metadata', |
468 | errnote='Unable to download JSON metadata', | |
b090af59 | 469 | transform_source=None, |
c9a77969 | 470 | fatal=True, encoding=None): |
b090af59 | 471 | json_string = self._download_webpage( |
c9a77969 YCH |
472 | url_or_request, video_id, note, errnote, fatal=fatal, |
473 | encoding=encoding) | |
b090af59 PH |
474 | if (not fatal) and json_string is False: |
475 | return None | |
ebb64199 TF |
476 | return self._parse_json( |
477 | json_string, video_id, transform_source=transform_source, fatal=fatal) | |
478 | ||
479 | def _parse_json(self, json_string, video_id, transform_source=None, fatal=True): | |
81c2f20b PH |
480 | if transform_source: |
481 | json_string = transform_source(json_string) | |
3d3538e4 PH |
482 | try: |
483 | return json.loads(json_string) | |
484 | except ValueError as ve: | |
e7b6d122 PH |
485 | errmsg = '%s: Failed to parse JSON ' % video_id |
486 | if fatal: | |
487 | raise ExtractorError(errmsg, cause=ve) | |
488 | else: | |
489 | self.report_warning(errmsg + str(ve)) | |
3d3538e4 | 490 | |
f45f96f8 | 491 | def report_warning(self, msg, video_id=None): |
f1a9d64e | 492 | idstr = '' if video_id is None else '%s: ' % video_id |
f45f96f8 | 493 | self._downloader.report_warning( |
f1a9d64e | 494 | '[%s] %s%s' % (self.IE_NAME, idstr, msg)) |
f45f96f8 | 495 | |
d6983cb4 PH |
496 | def to_screen(self, msg): |
497 | """Print msg to screen, prefixing it with '[ie_name]'""" | |
f1a9d64e | 498 | self._downloader.to_screen('[%s] %s' % (self.IE_NAME, msg)) |
d6983cb4 PH |
499 | |
500 | def report_extraction(self, id_or_name): | |
501 | """Report information extraction.""" | |
f1a9d64e | 502 | self.to_screen('%s: Extracting information' % id_or_name) |
d6983cb4 PH |
503 | |
504 | def report_download_webpage(self, video_id): | |
505 | """Report webpage download.""" | |
f1a9d64e | 506 | self.to_screen('%s: Downloading webpage' % video_id) |
d6983cb4 PH |
507 | |
508 | def report_age_confirmation(self): | |
509 | """Report attempt to confirm age.""" | |
f1a9d64e | 510 | self.to_screen('Confirming age') |
d6983cb4 | 511 | |
fc79158d JMF |
512 | def report_login(self): |
513 | """Report attempt to log in.""" | |
f1a9d64e | 514 | self.to_screen('Logging in') |
fc79158d | 515 | |
43e7d3c9 S |
516 | @staticmethod |
517 | def raise_login_required(msg='This video is only available for registered users'): | |
518 | raise ExtractorError( | |
519 | '%s. Use --username and --password or --netrc to provide account credentials.' % msg, | |
520 | expected=True) | |
521 | ||
c430802e S |
522 | @staticmethod |
523 | def raise_geo_restricted(msg='This video is not available from your location due to geo restriction'): | |
524 | raise ExtractorError( | |
525 | '%s. You might want to use --proxy to workaround.' % msg, | |
526 | expected=True) | |
527 | ||
5f6a1245 | 528 | # Methods for following #608 |
c0d0b01f | 529 | @staticmethod |
830d53bf | 530 | def url_result(url, ie=None, video_id=None, video_title=None): |
10952eb2 | 531 | """Returns a URL that points to a page that should be processed""" |
5f6a1245 | 532 | # TODO: ie should be the class used for getting the info |
d6983cb4 PH |
533 | video_info = {'_type': 'url', |
534 | 'url': url, | |
535 | 'ie_key': ie} | |
7012b23c PH |
536 | if video_id is not None: |
537 | video_info['id'] = video_id | |
830d53bf S |
538 | if video_title is not None: |
539 | video_info['title'] = video_title | |
d6983cb4 | 540 | return video_info |
5f6a1245 | 541 | |
c0d0b01f | 542 | @staticmethod |
acf5cbfe | 543 | def playlist_result(entries, playlist_id=None, playlist_title=None, playlist_description=None): |
d6983cb4 PH |
544 | """Returns a playlist""" |
545 | video_info = {'_type': 'playlist', | |
546 | 'entries': entries} | |
547 | if playlist_id: | |
548 | video_info['id'] = playlist_id | |
549 | if playlist_title: | |
550 | video_info['title'] = playlist_title | |
acf5cbfe S |
551 | if playlist_description: |
552 | video_info['description'] = playlist_description | |
d6983cb4 PH |
553 | return video_info |
554 | ||
c342041f | 555 | def _search_regex(self, pattern, string, name, default=NO_DEFAULT, fatal=True, flags=0, group=None): |
d6983cb4 PH |
556 | """ |
557 | Perform a regex search on the given string, using a single or a list of | |
558 | patterns returning the first matching group. | |
559 | In case of failure return a default value or raise a WARNING or a | |
55b3e45b | 560 | RegexNotFoundError, depending on fatal, specifying the field name. |
d6983cb4 PH |
561 | """ |
562 | if isinstance(pattern, (str, compat_str, compiled_regex_type)): | |
563 | mobj = re.search(pattern, string, flags) | |
564 | else: | |
565 | for p in pattern: | |
566 | mobj = re.search(p, string, flags) | |
c3415d1b PH |
567 | if mobj: |
568 | break | |
d6983cb4 | 569 | |
7e5db8c9 | 570 | if not self._downloader.params.get('no_color') and os.name != 'nt' and sys.stderr.isatty(): |
f1a9d64e | 571 | _name = '\033[0;34m%s\033[0m' % name |
d6983cb4 PH |
572 | else: |
573 | _name = name | |
574 | ||
575 | if mobj: | |
711ede6e PH |
576 | if group is None: |
577 | # return the first matching group | |
578 | return next(g for g in mobj.groups() if g is not None) | |
579 | else: | |
580 | return mobj.group(group) | |
c342041f | 581 | elif default is not NO_DEFAULT: |
d6983cb4 PH |
582 | return default |
583 | elif fatal: | |
f1a9d64e | 584 | raise RegexNotFoundError('Unable to extract %s' % _name) |
d6983cb4 | 585 | else: |
08f2a92c | 586 | self._downloader.report_warning('unable to extract %s' % _name + bug_reports_message()) |
d6983cb4 PH |
587 | return None |
588 | ||
c342041f | 589 | def _html_search_regex(self, pattern, string, name, default=NO_DEFAULT, fatal=True, flags=0, group=None): |
d6983cb4 PH |
590 | """ |
591 | Like _search_regex, but strips HTML tags and unescapes entities. | |
592 | """ | |
711ede6e | 593 | res = self._search_regex(pattern, string, name, default, fatal, flags, group) |
d6983cb4 PH |
594 | if res: |
595 | return clean_html(res).strip() | |
596 | else: | |
597 | return res | |
598 | ||
fc79158d JMF |
599 | def _get_login_info(self): |
600 | """ | |
cf0649f8 | 601 | Get the login info as (username, password) |
fc79158d JMF |
602 | It will look in the netrc file using the _NETRC_MACHINE value |
603 | If there's no info available, return (None, None) | |
604 | """ | |
605 | if self._downloader is None: | |
606 | return (None, None) | |
607 | ||
608 | username = None | |
609 | password = None | |
610 | downloader_params = self._downloader.params | |
611 | ||
612 | # Attempt to use provided username and password or .netrc data | |
613 | if downloader_params.get('username', None) is not None: | |
614 | username = downloader_params['username'] | |
615 | password = downloader_params['password'] | |
616 | elif downloader_params.get('usenetrc', False): | |
617 | try: | |
618 | info = netrc.netrc().authenticators(self._NETRC_MACHINE) | |
619 | if info is not None: | |
620 | username = info[0] | |
621 | password = info[2] | |
622 | else: | |
623 | raise netrc.NetrcParseError('No authenticators for %s' % self._NETRC_MACHINE) | |
624 | except (IOError, netrc.NetrcParseError) as err: | |
f1a9d64e | 625 | self._downloader.report_warning('parsing .netrc: %s' % compat_str(err)) |
5f6a1245 | 626 | |
fc79158d JMF |
627 | return (username, password) |
628 | ||
e64b7569 | 629 | def _get_tfa_info(self, note='two-factor verification code'): |
83317f69 | 630 | """ |
631 | Get the two-factor authentication info | |
632 | TODO - asking the user will be required for sms/phone verify | |
633 | currently just uses the command line option | |
634 | If there's no info available, return None | |
635 | """ | |
636 | if self._downloader is None: | |
83317f69 | 637 | return None |
638 | downloader_params = self._downloader.params | |
639 | ||
640 | if downloader_params.get('twofactor', None) is not None: | |
641 | return downloader_params['twofactor'] | |
642 | ||
e64b7569 | 643 | return compat_getpass('Type %s and press [Return]: ' % note) |
83317f69 | 644 | |
46720279 JMF |
645 | # Helper functions for extracting OpenGraph info |
646 | @staticmethod | |
ab2d5247 | 647 | def _og_regexes(prop): |
448ef1f3 | 648 | content_re = r'content=(?:"([^"]+?)"|\'([^\']+?)\'|\s*([^\s"\'=<>`]+?))' |
7a6d76a6 S |
649 | property_re = (r'(?:name|property)=(?:\'og:%(prop)s\'|"og:%(prop)s"|\s*og:%(prop)s\b)' |
650 | % {'prop': re.escape(prop)}) | |
78fb87b2 | 651 | template = r'<meta[^>]+?%s[^>]+?%s' |
ab2d5247 | 652 | return [ |
78fb87b2 JMF |
653 | template % (property_re, content_re), |
654 | template % (content_re, property_re), | |
ab2d5247 | 655 | ] |
46720279 | 656 | |
864f24bd S |
657 | @staticmethod |
658 | def _meta_regex(prop): | |
659 | return r'''(?isx)<meta | |
8b9848ac | 660 | (?=[^>]+(?:itemprop|name|property|id|http-equiv)=(["\']?)%s\1) |
864f24bd S |
661 | [^>]+?content=(["\'])(?P<content>.*?)\2''' % re.escape(prop) |
662 | ||
3c4e6d83 | 663 | def _og_search_property(self, prop, html, name=None, **kargs): |
46720279 | 664 | if name is None: |
3c4e6d83 | 665 | name = 'OpenGraph %s' % prop |
ab2d5247 | 666 | escaped = self._search_regex(self._og_regexes(prop), html, name, flags=re.DOTALL, **kargs) |
eb0a8398 PH |
667 | if escaped is None: |
668 | return None | |
669 | return unescapeHTML(escaped) | |
46720279 JMF |
670 | |
671 | def _og_search_thumbnail(self, html, **kargs): | |
10952eb2 | 672 | return self._og_search_property('image', html, 'thumbnail URL', fatal=False, **kargs) |
46720279 JMF |
673 | |
674 | def _og_search_description(self, html, **kargs): | |
675 | return self._og_search_property('description', html, fatal=False, **kargs) | |
676 | ||
677 | def _og_search_title(self, html, **kargs): | |
678 | return self._og_search_property('title', html, **kargs) | |
679 | ||
8ffa13e0 | 680 | def _og_search_video_url(self, html, name='video url', secure=True, **kargs): |
a3681973 PH |
681 | regexes = self._og_regexes('video') + self._og_regexes('video:url') |
682 | if secure: | |
683 | regexes = self._og_regexes('video:secure_url') + regexes | |
8ffa13e0 | 684 | return self._html_search_regex(regexes, html, name, **kargs) |
46720279 | 685 | |
78338f71 JMF |
686 | def _og_search_url(self, html, **kargs): |
687 | return self._og_search_property('url', html, **kargs) | |
688 | ||
40c696e5 | 689 | def _html_search_meta(self, name, html, display_name=None, fatal=False, **kwargs): |
59040888 PH |
690 | if display_name is None: |
691 | display_name = name | |
692 | return self._html_search_regex( | |
864f24bd | 693 | self._meta_regex(name), |
711ede6e | 694 | html, display_name, fatal=fatal, group='content', **kwargs) |
59040888 PH |
695 | |
696 | def _dc_search_uploader(self, html): | |
697 | return self._html_search_meta('dc.creator', html, 'uploader') | |
698 | ||
8dbe9899 PH |
699 | def _rta_search(self, html): |
700 | # See http://www.rtalabel.org/index.php?content=howtofaq#single | |
701 | if re.search(r'(?ix)<meta\s+name="rating"\s+' | |
702 | r' content="RTA-5042-1996-1400-1577-RTA"', | |
703 | html): | |
704 | return 18 | |
705 | return 0 | |
706 | ||
59040888 PH |
707 | def _media_rating_search(self, html): |
708 | # See http://www.tjg-designs.com/WP/metadata-code-examples-adding-metadata-to-your-web-pages/ | |
709 | rating = self._html_search_meta('rating', html) | |
710 | ||
711 | if not rating: | |
712 | return None | |
713 | ||
714 | RATING_TABLE = { | |
715 | 'safe for kids': 0, | |
716 | 'general': 8, | |
717 | '14 years': 14, | |
718 | 'mature': 17, | |
719 | 'restricted': 19, | |
720 | } | |
721 | return RATING_TABLE.get(rating.lower(), None) | |
722 | ||
69319969 | 723 | def _family_friendly_search(self, html): |
6ca7732d | 724 | # See http://schema.org/VideoObject |
69319969 NJ |
725 | family_friendly = self._html_search_meta('isFamilyFriendly', html) |
726 | ||
727 | if not family_friendly: | |
728 | return None | |
729 | ||
730 | RATING_TABLE = { | |
731 | '1': 0, | |
732 | 'true': 0, | |
733 | '0': 18, | |
734 | 'false': 18, | |
735 | } | |
736 | return RATING_TABLE.get(family_friendly.lower(), None) | |
737 | ||
0c708f11 JMF |
738 | def _twitter_search_player(self, html): |
739 | return self._html_search_meta('twitter:player', html, | |
9e1a5b84 | 740 | 'twitter card player') |
0c708f11 | 741 | |
27713812 | 742 | @staticmethod |
f8da79f8 | 743 | def _hidden_inputs(html): |
586f1cc5 | 744 | html = re.sub(r'<!--(?:(?!<!--).)*-->', '', html) |
201ea3ee | 745 | hidden_inputs = {} |
73eb13df | 746 | for input in re.findall(r'(?i)<input([^>]+)>', html): |
be0e5dbd | 747 | if not re.search(r'type=(["\'])(?:hidden|submit)\1', input): |
201ea3ee S |
748 | continue |
749 | name = re.search(r'name=(["\'])(?P<value>.+?)\1', input) | |
750 | if not name: | |
751 | continue | |
752 | value = re.search(r'value=(["\'])(?P<value>.*?)\1', input) | |
753 | if not value: | |
754 | continue | |
755 | hidden_inputs[name.group('value')] = value.group('value') | |
756 | return hidden_inputs | |
27713812 | 757 | |
cf61d96d S |
758 | def _form_hidden_inputs(self, form_id, html): |
759 | form = self._search_regex( | |
73eb13df | 760 | r'(?is)<form[^>]+?id=(["\'])%s\1[^>]*>(?P<form>.+?)</form>' % form_id, |
cf61d96d S |
761 | html, '%s form' % form_id, group='form') |
762 | return self._hidden_inputs(form) | |
763 | ||
3ded7bac | 764 | def _sort_formats(self, formats, field_preference=None): |
7e8caf30 | 765 | if not formats: |
f1a9d64e | 766 | raise ExtractorError('No video formats found') |
7e8caf30 | 767 | |
4bcc7bd1 | 768 | def _formats_key(f): |
e6812ac9 PH |
769 | # TODO remove the following workaround |
770 | from ..utils import determine_ext | |
771 | if not f.get('ext') and 'url' in f: | |
772 | f['ext'] = determine_ext(f['url']) | |
773 | ||
3ded7bac S |
774 | if isinstance(field_preference, (list, tuple)): |
775 | return tuple(f.get(field) if f.get(field) is not None else -1 for field in field_preference) | |
776 | ||
4bcc7bd1 PH |
777 | preference = f.get('preference') |
778 | if preference is None: | |
c7deaa4c PH |
779 | proto = f.get('protocol') |
780 | if proto is None: | |
781 | proto = compat_urllib_parse_urlparse(f.get('url', '')).scheme | |
782 | ||
783 | preference = 0 if proto in ['http', 'https'] else -0.1 | |
4bcc7bd1 PH |
784 | if f.get('ext') in ['f4f', 'f4m']: # Not yet supported |
785 | preference -= 0.5 | |
786 | ||
787 | if f.get('vcodec') == 'none': # audio only | |
788 | if self._downloader.params.get('prefer_free_formats'): | |
f1a9d64e | 789 | ORDER = ['aac', 'mp3', 'm4a', 'webm', 'ogg', 'opus'] |
4bcc7bd1 | 790 | else: |
f1a9d64e | 791 | ORDER = ['webm', 'opus', 'ogg', 'mp3', 'aac', 'm4a'] |
4bcc7bd1 PH |
792 | ext_preference = 0 |
793 | try: | |
794 | audio_ext_preference = ORDER.index(f['ext']) | |
795 | except ValueError: | |
796 | audio_ext_preference = -1 | |
797 | else: | |
798 | if self._downloader.params.get('prefer_free_formats'): | |
f1a9d64e | 799 | ORDER = ['flv', 'mp4', 'webm'] |
4bcc7bd1 | 800 | else: |
f1a9d64e | 801 | ORDER = ['webm', 'flv', 'mp4'] |
4bcc7bd1 PH |
802 | try: |
803 | ext_preference = ORDER.index(f['ext']) | |
804 | except ValueError: | |
805 | ext_preference = -1 | |
806 | audio_ext_preference = 0 | |
807 | ||
808 | return ( | |
809 | preference, | |
aff2f4f4 | 810 | f.get('language_preference') if f.get('language_preference') is not None else -1, |
5d73273f | 811 | f.get('quality') if f.get('quality') is not None else -1, |
9933b574 | 812 | f.get('tbr') if f.get('tbr') is not None else -1, |
03cd72b0 | 813 | f.get('filesize') if f.get('filesize') is not None else -1, |
4bcc7bd1 | 814 | f.get('vbr') if f.get('vbr') is not None else -1, |
1a6373ef PH |
815 | f.get('height') if f.get('height') is not None else -1, |
816 | f.get('width') if f.get('width') is not None else -1, | |
1e1896f2 | 817 | ext_preference, |
4bcc7bd1 PH |
818 | f.get('abr') if f.get('abr') is not None else -1, |
819 | audio_ext_preference, | |
2c8e03d9 | 820 | f.get('fps') if f.get('fps') is not None else -1, |
9732d77e | 821 | f.get('filesize_approx') if f.get('filesize_approx') is not None else -1, |
c64ed2a3 | 822 | f.get('source_preference') if f.get('source_preference') is not None else -1, |
74f72824 | 823 | f.get('format_id') if f.get('format_id') is not None else '', |
4bcc7bd1 PH |
824 | ) |
825 | formats.sort(key=_formats_key) | |
59040888 | 826 | |
96a53167 S |
827 | def _check_formats(self, formats, video_id): |
828 | if formats: | |
829 | formats[:] = filter( | |
830 | lambda f: self._is_valid_url( | |
831 | f['url'], video_id, | |
832 | item='%s video format' % f.get('format_id') if f.get('format_id') else 'video'), | |
833 | formats) | |
834 | ||
835 | def _is_valid_url(self, url, video_id, item='video'): | |
2f0f6578 S |
836 | url = self._proto_relative_url(url, scheme='http:') |
837 | # For now assume non HTTP(S) URLs always valid | |
838 | if not (url.startswith('http://') or url.startswith('https://')): | |
839 | return True | |
96a53167 | 840 | try: |
4069766c | 841 | self._request_webpage(url, video_id, 'Checking %s URL' % item) |
96a53167 S |
842 | return True |
843 | except ExtractorError as e: | |
943a1e24 | 844 | if isinstance(e.cause, compat_urllib_error.URLError): |
baa43cba S |
845 | self.to_screen( |
846 | '%s: %s URL is invalid, skipping' % (video_id, item)) | |
96a53167 S |
847 | return False |
848 | raise | |
849 | ||
20991253 | 850 | def http_scheme(self): |
1ede5b24 | 851 | """ Either "http:" or "https:", depending on the user's preferences """ |
20991253 PH |
852 | return ( |
853 | 'http:' | |
854 | if self._downloader.params.get('prefer_insecure', False) | |
855 | else 'https:') | |
856 | ||
57c7411f PH |
857 | def _proto_relative_url(self, url, scheme=None): |
858 | if url is None: | |
859 | return url | |
860 | if url.startswith('//'): | |
861 | if scheme is None: | |
862 | scheme = self.http_scheme() | |
863 | return scheme + url | |
864 | else: | |
865 | return url | |
866 | ||
4094b6e3 PH |
867 | def _sleep(self, timeout, video_id, msg_template=None): |
868 | if msg_template is None: | |
f1a9d64e | 869 | msg_template = '%(video_id)s: Waiting for %(timeout)s seconds' |
4094b6e3 PH |
870 | msg = msg_template % {'video_id': video_id, 'timeout': timeout} |
871 | self.to_screen(msg) | |
872 | time.sleep(timeout) | |
873 | ||
a38436e8 | 874 | def _extract_f4m_formats(self, manifest_url, video_id, preference=None, f4m_id=None, |
4de61310 S |
875 | transform_source=lambda s: fix_xml_ampersands(s).strip(), |
876 | fatal=True): | |
f036a632 JMF |
877 | manifest = self._download_xml( |
878 | manifest_url, video_id, 'Downloading f4m manifest', | |
97f4aecf S |
879 | 'Unable to download f4m manifest', |
880 | # Some manifests may be malformed, e.g. prosiebensat1 generated manifests | |
881 | # (see https://github.com/rg3/youtube-dl/issues/6215#issuecomment-121704244) | |
4de61310 S |
882 | transform_source=transform_source, |
883 | fatal=fatal) | |
884 | ||
885 | if manifest is False: | |
886 | return manifest | |
31bb8d3f JMF |
887 | |
888 | formats = [] | |
7a47d07c | 889 | manifest_version = '1.0' |
b2527359 | 890 | media_nodes = manifest.findall('{http://ns.adobe.com/f4m/1.0}media') |
34e48bed | 891 | if not media_nodes: |
7a47d07c | 892 | manifest_version = '2.0' |
34e48bed | 893 | media_nodes = manifest.findall('{http://ns.adobe.com/f4m/2.0}media') |
b2527359 | 894 | for i, media_el in enumerate(media_nodes): |
7a47d07c | 895 | if manifest_version == '2.0': |
31c746e5 S |
896 | media_url = media_el.attrib.get('href') or media_el.attrib.get('url') |
897 | if not media_url: | |
898 | continue | |
cc357c4d S |
899 | manifest_url = ( |
900 | media_url if media_url.startswith('http://') or media_url.startswith('https://') | |
901 | else ('/'.join(manifest_url.split('/')[:-1]) + '/' + media_url)) | |
70f0f5a8 S |
902 | # If media_url is itself a f4m manifest do the recursive extraction |
903 | # since bitrates in parent manifest (this one) and media_url manifest | |
904 | # may differ leading to inability to resolve the format by requested | |
905 | # bitrate in f4m downloader | |
906 | if determine_ext(manifest_url) == 'f4m': | |
4de61310 S |
907 | f4m_formats = self._extract_f4m_formats( |
908 | manifest_url, video_id, preference, f4m_id, fatal=fatal) | |
909 | if f4m_formats: | |
910 | formats.extend(f4m_formats) | |
70f0f5a8 | 911 | continue |
b2527359 | 912 | tbr = int_or_none(media_el.attrib.get('bitrate')) |
31bb8d3f | 913 | formats.append({ |
e21a55ab | 914 | 'format_id': '-'.join(filter(None, [f4m_id, compat_str(i if tbr is None else tbr)])), |
31bb8d3f JMF |
915 | 'url': manifest_url, |
916 | 'ext': 'flv', | |
b2527359 | 917 | 'tbr': tbr, |
31bb8d3f JMF |
918 | 'width': int_or_none(media_el.attrib.get('width')), |
919 | 'height': int_or_none(media_el.attrib.get('height')), | |
60ca389c | 920 | 'preference': preference, |
31bb8d3f JMF |
921 | }) |
922 | self._sort_formats(formats) | |
923 | ||
924 | return formats | |
925 | ||
f0b5d6af | 926 | def _extract_m3u8_formats(self, m3u8_url, video_id, ext=None, |
60ca389c | 927 | entry_protocol='m3u8', preference=None, |
13af92fd YCH |
928 | m3u8_id=None, note=None, errnote=None, |
929 | fatal=True): | |
f0b5d6af | 930 | |
704df56d | 931 | formats = [{ |
f207019c | 932 | 'format_id': '-'.join(filter(None, [m3u8_id, 'meta'])), |
704df56d PH |
933 | 'url': m3u8_url, |
934 | 'ext': ext, | |
935 | 'protocol': 'm3u8', | |
9fe6ef7a | 936 | 'preference': preference - 1 if preference else -1, |
704df56d PH |
937 | 'resolution': 'multiple', |
938 | 'format_note': 'Quality selection URL', | |
939 | }] | |
940 | ||
f0b5d6af PH |
941 | format_url = lambda u: ( |
942 | u | |
943 | if re.match(r'^https?://', u) | |
944 | else compat_urlparse.urljoin(m3u8_url, u)) | |
945 | ||
37113045 | 946 | m3u8_doc, urlh = self._download_webpage_handle( |
81515ad9 | 947 | m3u8_url, video_id, |
621ed9f5 | 948 | note=note or 'Downloading m3u8 information', |
13af92fd YCH |
949 | errnote=errnote or 'Failed to download m3u8 information', |
950 | fatal=fatal) | |
951 | if m3u8_doc is False: | |
952 | return m3u8_doc | |
37113045 | 953 | m3u8_url = urlh.geturl() |
704df56d | 954 | last_info = None |
fa156077 | 955 | last_media = None |
704df56d PH |
956 | kv_rex = re.compile( |
957 | r'(?P<key>[a-zA-Z_-]+)=(?P<val>"[^"]+"|[^",]+)(?:,|$)') | |
958 | for line in m3u8_doc.splitlines(): | |
959 | if line.startswith('#EXT-X-STREAM-INF:'): | |
960 | last_info = {} | |
961 | for m in kv_rex.finditer(line): | |
962 | v = m.group('val') | |
963 | if v.startswith('"'): | |
964 | v = v[1:-1] | |
965 | last_info[m.group('key')] = v | |
4cd95bcb JMF |
966 | elif line.startswith('#EXT-X-MEDIA:'): |
967 | last_media = {} | |
968 | for m in kv_rex.finditer(line): | |
969 | v = m.group('val') | |
970 | if v.startswith('"'): | |
971 | v = v[1:-1] | |
972 | last_media[m.group('key')] = v | |
704df56d PH |
973 | elif line.startswith('#') or not line.strip(): |
974 | continue | |
975 | else: | |
daebaab6 | 976 | if last_info is None: |
f0b5d6af | 977 | formats.append({'url': format_url(line)}) |
3524cc25 | 978 | continue |
704df56d | 979 | tbr = int_or_none(last_info.get('BANDWIDTH'), scale=1000) |
8dc9d361 S |
980 | format_id = [] |
981 | if m3u8_id: | |
982 | format_id.append(m3u8_id) | |
05d5392c | 983 | last_media_name = last_media.get('NAME') if last_media and last_media.get('TYPE') != 'SUBTITLES' else None |
8dc9d361 | 984 | format_id.append(last_media_name if last_media_name else '%d' % (tbr if tbr else len(formats))) |
704df56d | 985 | f = { |
8dc9d361 | 986 | 'format_id': '-'.join(format_id), |
f0b5d6af | 987 | 'url': format_url(line.strip()), |
704df56d PH |
988 | 'tbr': tbr, |
989 | 'ext': ext, | |
f0b5d6af PH |
990 | 'protocol': entry_protocol, |
991 | 'preference': preference, | |
704df56d PH |
992 | } |
993 | codecs = last_info.get('CODECS') | |
994 | if codecs: | |
9ebf22b7 S |
995 | # TODO: looks like video codec is not always necessarily goes first |
996 | va_codecs = codecs.split(',') | |
997 | if va_codecs[0]: | |
998 | f['vcodec'] = va_codecs[0].partition('.')[0] | |
999 | if len(va_codecs) > 1 and va_codecs[1]: | |
1000 | f['acodec'] = va_codecs[1].partition('.')[0] | |
704df56d PH |
1001 | resolution = last_info.get('RESOLUTION') |
1002 | if resolution: | |
1003 | width_str, height_str = resolution.split('x') | |
1004 | f['width'] = int(width_str) | |
1005 | f['height'] = int(height_str) | |
4cd95bcb JMF |
1006 | if last_media is not None: |
1007 | f['m3u8_media'] = last_media | |
1008 | last_media = None | |
704df56d PH |
1009 | formats.append(f) |
1010 | last_info = {} | |
1011 | self._sort_formats(formats) | |
1012 | return formats | |
1013 | ||
a107193e S |
1014 | @staticmethod |
1015 | def _xpath_ns(path, namespace=None): | |
1016 | if not namespace: | |
1017 | return path | |
1018 | out = [] | |
1019 | for c in path.split('/'): | |
1020 | if not c or c == '.': | |
1021 | out.append(c) | |
1022 | else: | |
1023 | out.append('{%s}%s' % (namespace, c)) | |
1024 | return '/'.join(out) | |
1025 | ||
1026 | def _extract_smil_formats(self, smil_url, video_id, fatal=True, f4m_params=None): | |
1027 | smil = self._download_smil(smil_url, video_id, fatal=fatal) | |
1028 | ||
995029a1 PH |
1029 | if smil is False: |
1030 | assert not fatal | |
1031 | return [] | |
e89a2aab | 1032 | |
17712eeb | 1033 | namespace = self._parse_smil_namespace(smil) |
a107193e S |
1034 | |
1035 | return self._parse_smil_formats( | |
1036 | smil, smil_url, video_id, namespace=namespace, f4m_params=f4m_params) | |
1037 | ||
1038 | def _extract_smil_info(self, smil_url, video_id, fatal=True, f4m_params=None): | |
1039 | smil = self._download_smil(smil_url, video_id, fatal=fatal) | |
1040 | if smil is False: | |
1041 | return {} | |
1042 | return self._parse_smil(smil, smil_url, video_id, f4m_params=f4m_params) | |
1043 | ||
1044 | def _download_smil(self, smil_url, video_id, fatal=True): | |
1045 | return self._download_xml( | |
1046 | smil_url, video_id, 'Downloading SMIL file', | |
1047 | 'Unable to download SMIL file', fatal=fatal) | |
1048 | ||
1049 | def _parse_smil(self, smil, smil_url, video_id, f4m_params=None): | |
17712eeb | 1050 | namespace = self._parse_smil_namespace(smil) |
a107193e S |
1051 | |
1052 | formats = self._parse_smil_formats( | |
1053 | smil, smil_url, video_id, namespace=namespace, f4m_params=f4m_params) | |
1054 | subtitles = self._parse_smil_subtitles(smil, namespace=namespace) | |
1055 | ||
1056 | video_id = os.path.splitext(url_basename(smil_url))[0] | |
1057 | title = None | |
1058 | description = None | |
647eab45 | 1059 | upload_date = None |
a107193e S |
1060 | for meta in smil.findall(self._xpath_ns('./head/meta', namespace)): |
1061 | name = meta.attrib.get('name') | |
1062 | content = meta.attrib.get('content') | |
1063 | if not name or not content: | |
1064 | continue | |
1065 | if not title and name == 'title': | |
1066 | title = content | |
1067 | elif not description and name in ('description', 'abstract'): | |
1068 | description = content | |
647eab45 S |
1069 | elif not upload_date and name == 'date': |
1070 | upload_date = unified_strdate(content) | |
a107193e | 1071 | |
1e5bcdec S |
1072 | thumbnails = [{ |
1073 | 'id': image.get('type'), | |
1074 | 'url': image.get('src'), | |
1075 | 'width': int_or_none(image.get('width')), | |
1076 | 'height': int_or_none(image.get('height')), | |
1077 | } for image in smil.findall(self._xpath_ns('.//image', namespace)) if image.get('src')] | |
1078 | ||
a107193e S |
1079 | return { |
1080 | 'id': video_id, | |
1081 | 'title': title or video_id, | |
1082 | 'description': description, | |
647eab45 | 1083 | 'upload_date': upload_date, |
1e5bcdec | 1084 | 'thumbnails': thumbnails, |
a107193e S |
1085 | 'formats': formats, |
1086 | 'subtitles': subtitles, | |
1087 | } | |
1088 | ||
17712eeb S |
1089 | def _parse_smil_namespace(self, smil): |
1090 | return self._search_regex( | |
1091 | r'(?i)^{([^}]+)?}smil$', smil.tag, 'namespace', default=None) | |
1092 | ||
f877c6ae | 1093 | def _parse_smil_formats(self, smil, smil_url, video_id, namespace=None, f4m_params=None, transform_rtmp_url=None): |
a107193e S |
1094 | base = smil_url |
1095 | for meta in smil.findall(self._xpath_ns('./head/meta', namespace)): | |
1096 | b = meta.get('base') or meta.get('httpBase') | |
1097 | if b: | |
1098 | base = b | |
1099 | break | |
e89a2aab S |
1100 | |
1101 | formats = [] | |
1102 | rtmp_count = 0 | |
a107193e S |
1103 | http_count = 0 |
1104 | ||
1105 | videos = smil.findall(self._xpath_ns('.//video', namespace)) | |
1106 | for video in videos: | |
1107 | src = video.get('src') | |
1108 | if not src: | |
1109 | continue | |
1110 | ||
e7d8e98a | 1111 | bitrate = float_or_none(video.get('system-bitrate') or video.get('systemBitrate'), 1000) |
a107193e S |
1112 | filesize = int_or_none(video.get('size') or video.get('fileSize')) |
1113 | width = int_or_none(video.get('width')) | |
1114 | height = int_or_none(video.get('height')) | |
1115 | proto = video.get('proto') | |
1116 | ext = video.get('ext') | |
1117 | src_ext = determine_ext(src) | |
1118 | streamer = video.get('streamer') or base | |
1119 | ||
1120 | if proto == 'rtmp' or streamer.startswith('rtmp'): | |
1121 | rtmp_count += 1 | |
1122 | formats.append({ | |
1123 | 'url': streamer, | |
1124 | 'play_path': src, | |
1125 | 'ext': 'flv', | |
1126 | 'format_id': 'rtmp-%d' % (rtmp_count if bitrate is None else bitrate), | |
1127 | 'tbr': bitrate, | |
1128 | 'filesize': filesize, | |
1129 | 'width': width, | |
1130 | 'height': height, | |
1131 | }) | |
f877c6ae YCH |
1132 | if transform_rtmp_url: |
1133 | streamer, src = transform_rtmp_url(streamer, src) | |
1134 | formats[-1].update({ | |
1135 | 'url': streamer, | |
1136 | 'play_path': src, | |
1137 | }) | |
a107193e S |
1138 | continue |
1139 | ||
1140 | src_url = src if src.startswith('http') else compat_urlparse.urljoin(base, src) | |
1141 | ||
1142 | if proto == 'm3u8' or src_ext == 'm3u8': | |
3a1341a7 S |
1143 | m3u8_formats = self._extract_m3u8_formats( |
1144 | src_url, video_id, ext or 'mp4', m3u8_id='hls', fatal=False) | |
1145 | if m3u8_formats: | |
1146 | formats.extend(m3u8_formats) | |
a107193e S |
1147 | continue |
1148 | ||
1149 | if src_ext == 'f4m': | |
1150 | f4m_url = src_url | |
1151 | if not f4m_params: | |
1152 | f4m_params = { | |
1153 | 'hdcore': '3.2.0', | |
1154 | 'plugin': 'flowplayer-3.2.0.1', | |
1155 | } | |
1156 | f4m_url += '&' if '?' in f4m_url else '?' | |
41c3a5a7 | 1157 | f4m_url += compat_urllib_parse.urlencode(f4m_params) |
e5851b96 S |
1158 | f4m_formats = self._extract_f4m_formats(f4m_url, video_id, f4m_id='hds', fatal=False) |
1159 | if f4m_formats: | |
1160 | formats.extend(f4m_formats) | |
a107193e S |
1161 | continue |
1162 | ||
c78e4817 | 1163 | if src_url.startswith('http') and self._is_valid_url(src, video_id): |
a107193e S |
1164 | http_count += 1 |
1165 | formats.append({ | |
1166 | 'url': src_url, | |
1167 | 'ext': ext or src_ext or 'flv', | |
1168 | 'format_id': 'http-%d' % (bitrate or http_count), | |
1169 | 'tbr': bitrate, | |
1170 | 'filesize': filesize, | |
1171 | 'width': width, | |
1172 | 'height': height, | |
1173 | }) | |
1174 | continue | |
63757032 | 1175 | |
e89a2aab S |
1176 | self._sort_formats(formats) |
1177 | ||
1178 | return formats | |
1179 | ||
ce00af87 | 1180 | def _parse_smil_subtitles(self, smil, namespace=None, subtitles_lang='en'): |
a107193e S |
1181 | subtitles = {} |
1182 | for num, textstream in enumerate(smil.findall(self._xpath_ns('.//textstream', namespace))): | |
1183 | src = textstream.get('src') | |
1184 | if not src: | |
1185 | continue | |
1186 | ext = textstream.get('ext') or determine_ext(src) | |
1187 | if not ext: | |
1188 | type_ = textstream.get('type') | |
5cdefc46 S |
1189 | SUBTITLES_TYPES = { |
1190 | 'text/vtt': 'vtt', | |
1191 | 'text/srt': 'srt', | |
1192 | 'application/smptett+xml': 'tt', | |
1193 | } | |
1194 | if type_ in SUBTITLES_TYPES: | |
1195 | ext = SUBTITLES_TYPES[type_] | |
03bc7237 | 1196 | lang = textstream.get('systemLanguage') or textstream.get('systemLanguageName') or textstream.get('lang') or subtitles_lang |
a107193e S |
1197 | subtitles.setdefault(lang, []).append({ |
1198 | 'url': src, | |
1199 | 'ext': ext, | |
1200 | }) | |
1201 | return subtitles | |
63757032 | 1202 | |
942acef5 S |
1203 | def _extract_xspf_playlist(self, playlist_url, playlist_id, fatal=True): |
1204 | xspf = self._download_xml( | |
8d6765cf | 1205 | playlist_url, playlist_id, 'Downloading xpsf playlist', |
942acef5 S |
1206 | 'Unable to download xspf manifest', fatal=fatal) |
1207 | if xspf is False: | |
1208 | return [] | |
1209 | return self._parse_xspf(xspf, playlist_id) | |
8d6765cf | 1210 | |
942acef5 | 1211 | def _parse_xspf(self, playlist, playlist_id): |
8d6765cf S |
1212 | NS_MAP = { |
1213 | 'xspf': 'http://xspf.org/ns/0/', | |
1214 | 's1': 'http://static.streamone.nl/player/ns/0', | |
1215 | } | |
1216 | ||
1217 | entries = [] | |
1218 | for track in playlist.findall(xpath_with_ns('./xspf:trackList/xspf:track', NS_MAP)): | |
1219 | title = xpath_text( | |
98044462 | 1220 | track, xpath_with_ns('./xspf:title', NS_MAP), 'title', default=playlist_id) |
8d6765cf S |
1221 | description = xpath_text( |
1222 | track, xpath_with_ns('./xspf:annotation', NS_MAP), 'description') | |
1223 | thumbnail = xpath_text( | |
1224 | track, xpath_with_ns('./xspf:image', NS_MAP), 'thumbnail') | |
1225 | duration = float_or_none( | |
1226 | xpath_text(track, xpath_with_ns('./xspf:duration', NS_MAP), 'duration'), 1000) | |
1227 | ||
1228 | formats = [{ | |
1229 | 'url': location.text, | |
1230 | 'format_id': location.get(xpath_with_ns('s1:label', NS_MAP)), | |
1231 | 'width': int_or_none(location.get(xpath_with_ns('s1:width', NS_MAP))), | |
1232 | 'height': int_or_none(location.get(xpath_with_ns('s1:height', NS_MAP))), | |
1233 | } for location in track.findall(xpath_with_ns('./xspf:location', NS_MAP))] | |
1234 | self._sort_formats(formats) | |
1235 | ||
1236 | entries.append({ | |
1237 | 'id': playlist_id, | |
1238 | 'title': title, | |
1239 | 'description': description, | |
1240 | 'thumbnail': thumbnail, | |
1241 | 'duration': duration, | |
1242 | 'formats': formats, | |
1243 | }) | |
1244 | return entries | |
1245 | ||
f4b1c7ad PH |
1246 | def _live_title(self, name): |
1247 | """ Generate the title for a live video """ | |
1248 | now = datetime.datetime.now() | |
1249 | now_str = now.strftime("%Y-%m-%d %H:%M") | |
1250 | return name + ' ' + now_str | |
1251 | ||
b14f3a4c PH |
1252 | def _int(self, v, name, fatal=False, **kwargs): |
1253 | res = int_or_none(v, **kwargs) | |
1254 | if 'get_attr' in kwargs: | |
1255 | print(getattr(v, kwargs['get_attr'])) | |
1256 | if res is None: | |
1257 | msg = 'Failed to extract %s: Could not parse value %r' % (name, v) | |
1258 | if fatal: | |
1259 | raise ExtractorError(msg) | |
1260 | else: | |
1261 | self._downloader.report_warning(msg) | |
1262 | return res | |
1263 | ||
1264 | def _float(self, v, name, fatal=False, **kwargs): | |
1265 | res = float_or_none(v, **kwargs) | |
1266 | if res is None: | |
1267 | msg = 'Failed to extract %s: Could not parse value %r' % (name, v) | |
1268 | if fatal: | |
1269 | raise ExtractorError(msg) | |
1270 | else: | |
1271 | self._downloader.report_warning(msg) | |
1272 | return res | |
1273 | ||
42939b61 | 1274 | def _set_cookie(self, domain, name, value, expire_time=None): |
810fb84d PH |
1275 | cookie = compat_cookiejar.Cookie( |
1276 | 0, name, value, None, None, domain, None, | |
42939b61 JMF |
1277 | None, '/', True, False, expire_time, '', None, None, None) |
1278 | self._downloader.cookiejar.set_cookie(cookie) | |
1279 | ||
799207e8 | 1280 | def _get_cookies(self, url): |
1281 | """ Return a compat_cookies.SimpleCookie with the cookies for the url """ | |
1282 | req = compat_urllib_request.Request(url) | |
1283 | self._downloader.cookiejar.add_cookie_header(req) | |
1284 | return compat_cookies.SimpleCookie(req.get_header('Cookie')) | |
1285 | ||
05900629 PH |
1286 | def get_testcases(self, include_onlymatching=False): |
1287 | t = getattr(self, '_TEST', None) | |
1288 | if t: | |
1289 | assert not hasattr(self, '_TESTS'), \ | |
1290 | '%s has _TEST and _TESTS' % type(self).__name__ | |
1291 | tests = [t] | |
1292 | else: | |
1293 | tests = getattr(self, '_TESTS', []) | |
1294 | for t in tests: | |
1295 | if not include_onlymatching and t.get('only_matching', False): | |
1296 | continue | |
1297 | t['name'] = type(self).__name__[:-len('IE')] | |
1298 | yield t | |
1299 | ||
1300 | def is_suitable(self, age_limit): | |
1301 | """ Test whether the extractor is generally suitable for the given | |
1302 | age limit (i.e. pornographic sites are not, all others usually are) """ | |
1303 | ||
1304 | any_restricted = False | |
1305 | for tc in self.get_testcases(include_onlymatching=False): | |
1306 | if 'playlist' in tc: | |
1307 | tc = tc['playlist'][0] | |
1308 | is_restricted = age_restricted( | |
1309 | tc.get('info_dict', {}).get('age_limit'), age_limit) | |
1310 | if not is_restricted: | |
1311 | return True | |
1312 | any_restricted = any_restricted or is_restricted | |
1313 | return not any_restricted | |
1314 | ||
a504ced0 | 1315 | def extract_subtitles(self, *args, **kwargs): |
9868ea49 JMF |
1316 | if (self._downloader.params.get('writesubtitles', False) or |
1317 | self._downloader.params.get('listsubtitles')): | |
1318 | return self._get_subtitles(*args, **kwargs) | |
1319 | return {} | |
a504ced0 JMF |
1320 | |
1321 | def _get_subtitles(self, *args, **kwargs): | |
1322 | raise NotImplementedError("This method must be implemented by subclasses") | |
1323 | ||
912e0b7e YCH |
1324 | @staticmethod |
1325 | def _merge_subtitle_items(subtitle_list1, subtitle_list2): | |
1326 | """ Merge subtitle items for one language. Items with duplicated URLs | |
1327 | will be dropped. """ | |
1328 | list1_urls = set([item['url'] for item in subtitle_list1]) | |
1329 | ret = list(subtitle_list1) | |
1330 | ret.extend([item for item in subtitle_list2 if item['url'] not in list1_urls]) | |
1331 | return ret | |
1332 | ||
1333 | @classmethod | |
8c97f819 | 1334 | def _merge_subtitles(cls, subtitle_dict1, subtitle_dict2): |
912e0b7e | 1335 | """ Merge two subtitle dictionaries, language by language. """ |
912e0b7e YCH |
1336 | ret = dict(subtitle_dict1) |
1337 | for lang in subtitle_dict2: | |
8c97f819 | 1338 | ret[lang] = cls._merge_subtitle_items(subtitle_dict1.get(lang, []), subtitle_dict2[lang]) |
912e0b7e YCH |
1339 | return ret |
1340 | ||
360e1ca5 | 1341 | def extract_automatic_captions(self, *args, **kwargs): |
9868ea49 JMF |
1342 | if (self._downloader.params.get('writeautomaticsub', False) or |
1343 | self._downloader.params.get('listsubtitles')): | |
1344 | return self._get_automatic_captions(*args, **kwargs) | |
1345 | return {} | |
360e1ca5 JMF |
1346 | |
1347 | def _get_automatic_captions(self, *args, **kwargs): | |
1348 | raise NotImplementedError("This method must be implemented by subclasses") | |
1349 | ||
8dbe9899 | 1350 | |
d6983cb4 PH |
1351 | class SearchInfoExtractor(InfoExtractor): |
1352 | """ | |
1353 | Base class for paged search queries extractors. | |
10952eb2 | 1354 | They accept URLs in the format _SEARCH_KEY(|all|[0-9]):{query} |
d6983cb4 PH |
1355 | Instances should define _SEARCH_KEY and _MAX_RESULTS. |
1356 | """ | |
1357 | ||
1358 | @classmethod | |
1359 | def _make_valid_url(cls): | |
1360 | return r'%s(?P<prefix>|[1-9][0-9]*|all):(?P<query>[\s\S]+)' % cls._SEARCH_KEY | |
1361 | ||
1362 | @classmethod | |
1363 | def suitable(cls, url): | |
1364 | return re.match(cls._make_valid_url(), url) is not None | |
1365 | ||
1366 | def _real_extract(self, query): | |
1367 | mobj = re.match(self._make_valid_url(), query) | |
1368 | if mobj is None: | |
f1a9d64e | 1369 | raise ExtractorError('Invalid search query "%s"' % query) |
d6983cb4 PH |
1370 | |
1371 | prefix = mobj.group('prefix') | |
1372 | query = mobj.group('query') | |
1373 | if prefix == '': | |
1374 | return self._get_n_results(query, 1) | |
1375 | elif prefix == 'all': | |
1376 | return self._get_n_results(query, self._MAX_RESULTS) | |
1377 | else: | |
1378 | n = int(prefix) | |
1379 | if n <= 0: | |
f1a9d64e | 1380 | raise ExtractorError('invalid download number %s for query "%s"' % (n, query)) |
d6983cb4 | 1381 | elif n > self._MAX_RESULTS: |
f1a9d64e | 1382 | self._downloader.report_warning('%s returns max %i results (you requested %i)' % (self._SEARCH_KEY, self._MAX_RESULTS, n)) |
d6983cb4 PH |
1383 | n = self._MAX_RESULTS |
1384 | return self._get_n_results(query, n) | |
1385 | ||
1386 | def _get_n_results(self, query, n): | |
1387 | """Get a specified number of results for a query""" | |
416a5efc | 1388 | raise NotImplementedError("This method must be implemented by subclasses") |
0f818663 PH |
1389 | |
1390 | @property | |
1391 | def SEARCH_KEY(self): | |
1392 | return self._SEARCH_KEY |