You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

574 lines
23 KiB

11 years ago
11 years ago
  1. import base64
  2. import hashlib
  3. import json
  4. import os
  5. import re
  6. import socket
  7. import sys
  8. import netrc
  9. import xml.etree.ElementTree
  10. from ..utils import (
  11. compat_http_client,
  12. compat_urllib_error,
  13. compat_urllib_parse_urlparse,
  14. compat_str,
  15. clean_html,
  16. compiled_regex_type,
  17. ExtractorError,
  18. RegexNotFoundError,
  19. sanitize_filename,
  20. unescapeHTML,
  21. )
  22. _NO_DEFAULT = object()
  23. class InfoExtractor(object):
  24. """Information Extractor class.
  25. Information extractors are the classes that, given a URL, extract
  26. information about the video (or videos) the URL refers to. This
  27. information includes the real video URL, the video title, author and
  28. others. The information is stored in a dictionary which is then
  29. passed to the FileDownloader. The FileDownloader processes this
  30. information possibly downloading the video to the file system, among
  31. other possible outcomes.
  32. The dictionaries must include the following fields:
  33. id: Video identifier.
  34. title: Video title, unescaped.
  35. Additionally, it must contain either a formats entry or a url one:
  36. formats: A list of dictionaries for each format available, ordered
  37. from worst to best quality.
  38. Potential fields:
  39. * url Mandatory. The URL of the video file
  40. * ext Will be calculated from url if missing
  41. * format A human-readable description of the format
  42. ("mp4 container with h264/opus").
  43. Calculated from the format_id, width, height.
  44. and format_note fields if missing.
  45. * format_id A short description of the format
  46. ("mp4_h264_opus" or "19").
  47. Technically optional, but strongly recommended.
  48. * format_note Additional info about the format
  49. ("3D" or "DASH video")
  50. * width Width of the video, if known
  51. * height Height of the video, if known
  52. * resolution Textual description of width and height
  53. * tbr Average bitrate of audio and video in KBit/s
  54. * abr Average audio bitrate in KBit/s
  55. * acodec Name of the audio codec in use
  56. * asr Audio sampling rate in Hertz
  57. * vbr Average video bitrate in KBit/s
  58. * vcodec Name of the video codec in use
  59. * container Name of the container format
  60. * filesize The number of bytes, if known in advance
  61. * player_url SWF Player URL (used for rtmpdump).
  62. * protocol The protocol that will be used for the actual
  63. download, lower-case.
  64. "http", "https", "rtsp", "rtmp", "m3u8" or so.
  65. * preference Order number of this format. If this field is
  66. present and not None, the formats get sorted
  67. by this field.
  68. -1 for default (order by other properties),
  69. -2 or smaller for less than default.
  70. * quality Order number of the video quality of this
  71. format, irrespective of the file format.
  72. -1 for default (order by other properties),
  73. -2 or smaller for less than default.
  74. url: Final video URL.
  75. ext: Video filename extension.
  76. format: The video format, defaults to ext (used for --get-format)
  77. player_url: SWF Player URL (used for rtmpdump).
  78. The following fields are optional:
  79. display_id An alternative identifier for the video, not necessarily
  80. unique, but available before title. Typically, id is
  81. something like "4234987", title "Dancing naked mole rats",
  82. and display_id "dancing-naked-mole-rats"
  83. thumbnails: A list of dictionaries (with the entries "resolution" and
  84. "url") for the varying thumbnails
  85. thumbnail: Full URL to a video thumbnail image.
  86. description: One-line video description.
  87. uploader: Full name of the video uploader.
  88. upload_date: Video upload date (YYYYMMDD).
  89. uploader_id: Nickname or id of the video uploader.
  90. location: Physical location of the video.
  91. subtitles: The subtitle file contents as a dictionary in the format
  92. {language: subtitles}.
  93. duration: Length of the video in seconds, as an integer.
  94. view_count: How many users have watched the video on the platform.
  95. like_count: Number of positive ratings of the video
  96. dislike_count: Number of negative ratings of the video
  97. comment_count: Number of comments on the video
  98. age_limit: Age restriction for the video, as an integer (years)
  99. webpage_url: The url to the video webpage, if given to youtube-dl it
  100. should allow to get the same result again. (It will be set
  101. by YoutubeDL if it's missing)
  102. Unless mentioned otherwise, the fields should be Unicode strings.
  103. Subclasses of this one should re-define the _real_initialize() and
  104. _real_extract() methods and define a _VALID_URL regexp.
  105. Probably, they should also be added to the list of extractors.
  106. Finally, the _WORKING attribute should be set to False for broken IEs
  107. in order to warn the users and skip the tests.
  108. """
  109. _ready = False
  110. _downloader = None
  111. _WORKING = True
  112. def __init__(self, downloader=None):
  113. """Constructor. Receives an optional downloader."""
  114. self._ready = False
  115. self.set_downloader(downloader)
  116. @classmethod
  117. def suitable(cls, url):
  118. """Receives a URL and returns True if suitable for this IE."""
  119. # This does not use has/getattr intentionally - we want to know whether
  120. # we have cached the regexp for *this* class, whereas getattr would also
  121. # match the superclass
  122. if '_VALID_URL_RE' not in cls.__dict__:
  123. cls._VALID_URL_RE = re.compile(cls._VALID_URL)
  124. return cls._VALID_URL_RE.match(url) is not None
  125. @classmethod
  126. def working(cls):
  127. """Getter method for _WORKING."""
  128. return cls._WORKING
  129. def initialize(self):
  130. """Initializes an instance (authentication, etc)."""
  131. if not self._ready:
  132. self._real_initialize()
  133. self._ready = True
  134. def extract(self, url):
  135. """Extracts URL information and returns it in list of dicts."""
  136. self.initialize()
  137. return self._real_extract(url)
  138. def set_downloader(self, downloader):
  139. """Sets the downloader for this IE."""
  140. self._downloader = downloader
  141. def _real_initialize(self):
  142. """Real initialization process. Redefine in subclasses."""
  143. pass
  144. def _real_extract(self, url):
  145. """Real extraction process. Redefine in subclasses."""
  146. pass
  147. @classmethod
  148. def ie_key(cls):
  149. """A string for getting the InfoExtractor with get_info_extractor"""
  150. return cls.__name__[:-2]
  151. @property
  152. def IE_NAME(self):
  153. return type(self).__name__[:-2]
  154. def _request_webpage(self, url_or_request, video_id, note=None, errnote=None, fatal=True):
  155. """ Returns the response handle """
  156. if note is None:
  157. self.report_download_webpage(video_id)
  158. elif note is not False:
  159. if video_id is None:
  160. self.to_screen(u'%s' % (note,))
  161. else:
  162. self.to_screen(u'%s: %s' % (video_id, note))
  163. try:
  164. return self._downloader.urlopen(url_or_request)
  165. except (compat_urllib_error.URLError, compat_http_client.HTTPException, socket.error) as err:
  166. if errnote is False:
  167. return False
  168. if errnote is None:
  169. errnote = u'Unable to download webpage'
  170. errmsg = u'%s: %s' % (errnote, compat_str(err))
  171. if fatal:
  172. raise ExtractorError(errmsg, sys.exc_info()[2], cause=err)
  173. else:
  174. self._downloader.report_warning(errmsg)
  175. return False
  176. def _download_webpage_handle(self, url_or_request, video_id, note=None, errnote=None, fatal=True):
  177. """ Returns a tuple (page content as string, URL handle) """
  178. # Strip hashes from the URL (#1038)
  179. if isinstance(url_or_request, (compat_str, str)):
  180. url_or_request = url_or_request.partition('#')[0]
  181. urlh = self._request_webpage(url_or_request, video_id, note, errnote, fatal)
  182. if urlh is False:
  183. assert not fatal
  184. return False
  185. content_type = urlh.headers.get('Content-Type', '')
  186. webpage_bytes = urlh.read()
  187. m = re.match(r'[a-zA-Z0-9_.-]+/[a-zA-Z0-9_.-]+\s*;\s*charset=(.+)', content_type)
  188. if m:
  189. encoding = m.group(1)
  190. else:
  191. m = re.search(br'<meta[^>]+charset=[\'"]?([^\'")]+)[ /\'">]',
  192. webpage_bytes[:1024])
  193. if m:
  194. encoding = m.group(1).decode('ascii')
  195. elif webpage_bytes.startswith(b'\xff\xfe'):
  196. encoding = 'utf-16'
  197. else:
  198. encoding = 'utf-8'
  199. if self._downloader.params.get('dump_intermediate_pages', False):
  200. try:
  201. url = url_or_request.get_full_url()
  202. except AttributeError:
  203. url = url_or_request
  204. self.to_screen(u'Dumping request to ' + url)
  205. dump = base64.b64encode(webpage_bytes).decode('ascii')
  206. self._downloader.to_screen(dump)
  207. if self._downloader.params.get('write_pages', False):
  208. try:
  209. url = url_or_request.get_full_url()
  210. except AttributeError:
  211. url = url_or_request
  212. if len(url) > 200:
  213. h = u'___' + hashlib.md5(url.encode('utf-8')).hexdigest()
  214. url = url[:200 - len(h)] + h
  215. raw_filename = ('%s_%s.dump' % (video_id, url))
  216. filename = sanitize_filename(raw_filename, restricted=True)
  217. self.to_screen(u'Saving request to ' + filename)
  218. with open(filename, 'wb') as outf:
  219. outf.write(webpage_bytes)
  220. content = webpage_bytes.decode(encoding, 'replace')
  221. return (content, urlh)
  222. def _download_webpage(self, url_or_request, video_id, note=None, errnote=None, fatal=True):
  223. """ Returns the data of the page as a string """
  224. res = self._download_webpage_handle(url_or_request, video_id, note, errnote, fatal)
  225. if res is False:
  226. return res
  227. else:
  228. content, _ = res
  229. return content
  230. def _download_xml(self, url_or_request, video_id,
  231. note=u'Downloading XML', errnote=u'Unable to download XML',
  232. transform_source=None):
  233. """Return the xml as an xml.etree.ElementTree.Element"""
  234. xml_string = self._download_webpage(url_or_request, video_id, note, errnote)
  235. if transform_source:
  236. xml_string = transform_source(xml_string)
  237. return xml.etree.ElementTree.fromstring(xml_string.encode('utf-8'))
  238. def _download_json(self, url_or_request, video_id,
  239. note=u'Downloading JSON metadata',
  240. errnote=u'Unable to download JSON metadata',
  241. transform_source=None):
  242. json_string = self._download_webpage(url_or_request, video_id, note, errnote)
  243. if transform_source:
  244. json_string = transform_source(json_string)
  245. try:
  246. return json.loads(json_string)
  247. except ValueError as ve:
  248. raise ExtractorError('Failed to download JSON', cause=ve)
  249. def report_warning(self, msg, video_id=None):
  250. idstr = u'' if video_id is None else u'%s: ' % video_id
  251. self._downloader.report_warning(
  252. u'[%s] %s%s' % (self.IE_NAME, idstr, msg))
  253. def to_screen(self, msg):
  254. """Print msg to screen, prefixing it with '[ie_name]'"""
  255. self._downloader.to_screen(u'[%s] %s' % (self.IE_NAME, msg))
  256. def report_extraction(self, id_or_name):
  257. """Report information extraction."""
  258. self.to_screen(u'%s: Extracting information' % id_or_name)
  259. def report_download_webpage(self, video_id):
  260. """Report webpage download."""
  261. self.to_screen(u'%s: Downloading webpage' % video_id)
  262. def report_age_confirmation(self):
  263. """Report attempt to confirm age."""
  264. self.to_screen(u'Confirming age')
  265. def report_login(self):
  266. """Report attempt to log in."""
  267. self.to_screen(u'Logging in')
  268. #Methods for following #608
  269. @staticmethod
  270. def url_result(url, ie=None, video_id=None):
  271. """Returns a url that points to a page that should be processed"""
  272. #TODO: ie should be the class used for getting the info
  273. video_info = {'_type': 'url',
  274. 'url': url,
  275. 'ie_key': ie}
  276. if video_id is not None:
  277. video_info['id'] = video_id
  278. return video_info
  279. @staticmethod
  280. def playlist_result(entries, playlist_id=None, playlist_title=None):
  281. """Returns a playlist"""
  282. video_info = {'_type': 'playlist',
  283. 'entries': entries}
  284. if playlist_id:
  285. video_info['id'] = playlist_id
  286. if playlist_title:
  287. video_info['title'] = playlist_title
  288. return video_info
  289. def _search_regex(self, pattern, string, name, default=_NO_DEFAULT, fatal=True, flags=0):
  290. """
  291. Perform a regex search on the given string, using a single or a list of
  292. patterns returning the first matching group.
  293. In case of failure return a default value or raise a WARNING or a
  294. RegexNotFoundError, depending on fatal, specifying the field name.
  295. """
  296. if isinstance(pattern, (str, compat_str, compiled_regex_type)):
  297. mobj = re.search(pattern, string, flags)
  298. else:
  299. for p in pattern:
  300. mobj = re.search(p, string, flags)
  301. if mobj: break
  302. if os.name != 'nt' and sys.stderr.isatty():
  303. _name = u'\033[0;34m%s\033[0m' % name
  304. else:
  305. _name = name
  306. if mobj:
  307. # return the first matching group
  308. return next(g for g in mobj.groups() if g is not None)
  309. elif default is not _NO_DEFAULT:
  310. return default
  311. elif fatal:
  312. raise RegexNotFoundError(u'Unable to extract %s' % _name)
  313. else:
  314. self._downloader.report_warning(u'unable to extract %s; '
  315. u'please report this issue on http://yt-dl.org/bug' % _name)
  316. return None
  317. def _html_search_regex(self, pattern, string, name, default=_NO_DEFAULT, fatal=True, flags=0):
  318. """
  319. Like _search_regex, but strips HTML tags and unescapes entities.
  320. """
  321. res = self._search_regex(pattern, string, name, default, fatal, flags)
  322. if res:
  323. return clean_html(res).strip()
  324. else:
  325. return res
  326. def _get_login_info(self):
  327. """
  328. Get the the login info as (username, password)
  329. It will look in the netrc file using the _NETRC_MACHINE value
  330. If there's no info available, return (None, None)
  331. """
  332. if self._downloader is None:
  333. return (None, None)
  334. username = None
  335. password = None
  336. downloader_params = self._downloader.params
  337. # Attempt to use provided username and password or .netrc data
  338. if downloader_params.get('username', None) is not None:
  339. username = downloader_params['username']
  340. password = downloader_params['password']
  341. elif downloader_params.get('usenetrc', False):
  342. try:
  343. info = netrc.netrc().authenticators(self._NETRC_MACHINE)
  344. if info is not None:
  345. username = info[0]
  346. password = info[2]
  347. else:
  348. raise netrc.NetrcParseError('No authenticators for %s' % self._NETRC_MACHINE)
  349. except (IOError, netrc.NetrcParseError) as err:
  350. self._downloader.report_warning(u'parsing .netrc: %s' % compat_str(err))
  351. return (username, password)
  352. # Helper functions for extracting OpenGraph info
  353. @staticmethod
  354. def _og_regexes(prop):
  355. content_re = r'content=(?:"([^>]+?)"|\'([^>]+?)\')'
  356. property_re = r'(?:name|property)=[\'"]og:%s[\'"]' % re.escape(prop)
  357. template = r'<meta[^>]+?%s[^>]+?%s'
  358. return [
  359. template % (property_re, content_re),
  360. template % (content_re, property_re),
  361. ]
  362. def _og_search_property(self, prop, html, name=None, **kargs):
  363. if name is None:
  364. name = 'OpenGraph %s' % prop
  365. escaped = self._search_regex(self._og_regexes(prop), html, name, flags=re.DOTALL, **kargs)
  366. if escaped is None:
  367. return None
  368. return unescapeHTML(escaped)
  369. def _og_search_thumbnail(self, html, **kargs):
  370. return self._og_search_property('image', html, u'thumbnail url', fatal=False, **kargs)
  371. def _og_search_description(self, html, **kargs):
  372. return self._og_search_property('description', html, fatal=False, **kargs)
  373. def _og_search_title(self, html, **kargs):
  374. return self._og_search_property('title', html, **kargs)
  375. def _og_search_video_url(self, html, name='video url', secure=True, **kargs):
  376. regexes = self._og_regexes('video')
  377. if secure: regexes = self._og_regexes('video:secure_url') + regexes
  378. return self._html_search_regex(regexes, html, name, **kargs)
  379. def _html_search_meta(self, name, html, display_name=None, fatal=False):
  380. if display_name is None:
  381. display_name = name
  382. return self._html_search_regex(
  383. r'''(?ix)<meta
  384. (?=[^>]+(?:itemprop|name|property)=["\']%s["\'])
  385. [^>]+content=["\']([^"\']+)["\']''' % re.escape(name),
  386. html, display_name, fatal=fatal)
  387. def _dc_search_uploader(self, html):
  388. return self._html_search_meta('dc.creator', html, 'uploader')
  389. def _rta_search(self, html):
  390. # See http://www.rtalabel.org/index.php?content=howtofaq#single
  391. if re.search(r'(?ix)<meta\s+name="rating"\s+'
  392. r' content="RTA-5042-1996-1400-1577-RTA"',
  393. html):
  394. return 18
  395. return 0
  396. def _media_rating_search(self, html):
  397. # See http://www.tjg-designs.com/WP/metadata-code-examples-adding-metadata-to-your-web-pages/
  398. rating = self._html_search_meta('rating', html)
  399. if not rating:
  400. return None
  401. RATING_TABLE = {
  402. 'safe for kids': 0,
  403. 'general': 8,
  404. '14 years': 14,
  405. 'mature': 17,
  406. 'restricted': 19,
  407. }
  408. return RATING_TABLE.get(rating.lower(), None)
  409. def _twitter_search_player(self, html):
  410. return self._html_search_meta('twitter:player', html,
  411. 'twitter card player')
  412. def _sort_formats(self, formats):
  413. if not formats:
  414. raise ExtractorError(u'No video formats found')
  415. def _formats_key(f):
  416. # TODO remove the following workaround
  417. from ..utils import determine_ext
  418. if not f.get('ext') and 'url' in f:
  419. f['ext'] = determine_ext(f['url'])
  420. preference = f.get('preference')
  421. if preference is None:
  422. proto = f.get('protocol')
  423. if proto is None:
  424. proto = compat_urllib_parse_urlparse(f.get('url', '')).scheme
  425. preference = 0 if proto in ['http', 'https'] else -0.1
  426. if f.get('ext') in ['f4f', 'f4m']: # Not yet supported
  427. preference -= 0.5
  428. if f.get('vcodec') == 'none': # audio only
  429. if self._downloader.params.get('prefer_free_formats'):
  430. ORDER = [u'aac', u'mp3', u'm4a', u'webm', u'ogg', u'opus']
  431. else:
  432. ORDER = [u'webm', u'opus', u'ogg', u'mp3', u'aac', u'm4a']
  433. ext_preference = 0
  434. try:
  435. audio_ext_preference = ORDER.index(f['ext'])
  436. except ValueError:
  437. audio_ext_preference = -1
  438. else:
  439. if self._downloader.params.get('prefer_free_formats'):
  440. ORDER = [u'flv', u'mp4', u'webm']
  441. else:
  442. ORDER = [u'webm', u'flv', u'mp4']
  443. try:
  444. ext_preference = ORDER.index(f['ext'])
  445. except ValueError:
  446. ext_preference = -1
  447. audio_ext_preference = 0
  448. return (
  449. preference,
  450. f.get('quality') if f.get('quality') is not None else -1,
  451. f.get('height') if f.get('height') is not None else -1,
  452. f.get('width') if f.get('width') is not None else -1,
  453. ext_preference,
  454. f.get('tbr') if f.get('tbr') is not None else -1,
  455. f.get('vbr') if f.get('vbr') is not None else -1,
  456. f.get('abr') if f.get('abr') is not None else -1,
  457. audio_ext_preference,
  458. f.get('filesize') if f.get('filesize') is not None else -1,
  459. f.get('format_id'),
  460. )
  461. formats.sort(key=_formats_key)
  462. class SearchInfoExtractor(InfoExtractor):
  463. """
  464. Base class for paged search queries extractors.
  465. They accept urls in the format _SEARCH_KEY(|all|[0-9]):{query}
  466. Instances should define _SEARCH_KEY and _MAX_RESULTS.
  467. """
  468. @classmethod
  469. def _make_valid_url(cls):
  470. return r'%s(?P<prefix>|[1-9][0-9]*|all):(?P<query>[\s\S]+)' % cls._SEARCH_KEY
  471. @classmethod
  472. def suitable(cls, url):
  473. return re.match(cls._make_valid_url(), url) is not None
  474. def _real_extract(self, query):
  475. mobj = re.match(self._make_valid_url(), query)
  476. if mobj is None:
  477. raise ExtractorError(u'Invalid search query "%s"' % query)
  478. prefix = mobj.group('prefix')
  479. query = mobj.group('query')
  480. if prefix == '':
  481. return self._get_n_results(query, 1)
  482. elif prefix == 'all':
  483. return self._get_n_results(query, self._MAX_RESULTS)
  484. else:
  485. n = int(prefix)
  486. if n <= 0:
  487. raise ExtractorError(u'invalid download number %s for query "%s"' % (n, query))
  488. elif n > self._MAX_RESULTS:
  489. self._downloader.report_warning(u'%s returns max %i results (you requested %i)' % (self._SEARCH_KEY, self._MAX_RESULTS, n))
  490. n = self._MAX_RESULTS
  491. return self._get_n_results(query, n)
  492. def _get_n_results(self, query, n):
  493. """Get a specified number of results for a query"""
  494. raise NotImplementedError("This method must be implemented by subclasses")
  495. @property
  496. def SEARCH_KEY(self):
  497. return self._SEARCH_KEY