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.

333 lines
12 KiB

  1. import base64
  2. import os
  3. import re
  4. import socket
  5. import sys
  6. import netrc
  7. from ..utils import (
  8. compat_http_client,
  9. compat_urllib_error,
  10. compat_urllib_request,
  11. compat_str,
  12. clean_html,
  13. compiled_regex_type,
  14. ExtractorError,
  15. unescapeHTML,
  16. )
  17. class InfoExtractor(object):
  18. """Information Extractor class.
  19. Information extractors are the classes that, given a URL, extract
  20. information about the video (or videos) the URL refers to. This
  21. information includes the real video URL, the video title, author and
  22. others. The information is stored in a dictionary which is then
  23. passed to the FileDownloader. The FileDownloader processes this
  24. information possibly downloading the video to the file system, among
  25. other possible outcomes.
  26. The dictionaries must include the following fields:
  27. id: Video identifier.
  28. url: Final video URL.
  29. title: Video title, unescaped.
  30. ext: Video filename extension.
  31. The following fields are optional:
  32. format: The video format, defaults to ext (used for --get-format)
  33. thumbnails: A list of dictionaries (with the entries "resolution" and
  34. "url") for the varying thumbnails
  35. thumbnail: Full URL to a video thumbnail image.
  36. description: One-line video description.
  37. uploader: Full name of the video uploader.
  38. upload_date: Video upload date (YYYYMMDD).
  39. uploader_id: Nickname or id of the video uploader.
  40. location: Physical location of the video.
  41. player_url: SWF Player URL (used for rtmpdump).
  42. subtitles: The subtitle file contents as a dictionary in the format
  43. {language: subtitles}.
  44. view_count: How many users have watched the video on the platform.
  45. urlhandle: [internal] The urlHandle to be used to download the file,
  46. like returned by urllib.request.urlopen
  47. The fields should all be Unicode strings.
  48. Subclasses of this one should re-define the _real_initialize() and
  49. _real_extract() methods and define a _VALID_URL regexp.
  50. Probably, they should also be added to the list of extractors.
  51. _real_extract() must return a *list* of information dictionaries as
  52. described above.
  53. Finally, the _WORKING attribute should be set to False for broken IEs
  54. in order to warn the users and skip the tests.
  55. """
  56. _ready = False
  57. _downloader = None
  58. _WORKING = True
  59. def __init__(self, downloader=None):
  60. """Constructor. Receives an optional downloader."""
  61. self._ready = False
  62. self.set_downloader(downloader)
  63. @classmethod
  64. def suitable(cls, url):
  65. """Receives a URL and returns True if suitable for this IE."""
  66. return re.match(cls._VALID_URL, url) is not None
  67. @classmethod
  68. def working(cls):
  69. """Getter method for _WORKING."""
  70. return cls._WORKING
  71. def initialize(self):
  72. """Initializes an instance (authentication, etc)."""
  73. if not self._ready:
  74. self._real_initialize()
  75. self._ready = True
  76. def extract(self, url):
  77. """Extracts URL information and returns it in list of dicts."""
  78. self.initialize()
  79. return self._real_extract(url)
  80. def set_downloader(self, downloader):
  81. """Sets the downloader for this IE."""
  82. self._downloader = downloader
  83. def _real_initialize(self):
  84. """Real initialization process. Redefine in subclasses."""
  85. pass
  86. def _real_extract(self, url):
  87. """Real extraction process. Redefine in subclasses."""
  88. pass
  89. @property
  90. def IE_NAME(self):
  91. return type(self).__name__[:-2]
  92. def _request_webpage(self, url_or_request, video_id, note=None, errnote=None):
  93. """ Returns the response handle """
  94. if note is None:
  95. self.report_download_webpage(video_id)
  96. elif note is not False:
  97. self.to_screen(u'%s: %s' % (video_id, note))
  98. try:
  99. return compat_urllib_request.urlopen(url_or_request)
  100. except (compat_urllib_error.URLError, compat_http_client.HTTPException, socket.error) as err:
  101. if errnote is None:
  102. errnote = u'Unable to download webpage'
  103. raise ExtractorError(u'%s: %s' % (errnote, compat_str(err)), sys.exc_info()[2])
  104. def _download_webpage_handle(self, url_or_request, video_id, note=None, errnote=None):
  105. """ Returns a tuple (page content as string, URL handle) """
  106. # Strip hashes from the URL (#1038)
  107. if isinstance(url_or_request, (compat_str, str)):
  108. url_or_request = url_or_request.partition('#')[0]
  109. urlh = self._request_webpage(url_or_request, video_id, note, errnote)
  110. content_type = urlh.headers.get('Content-Type', '')
  111. m = re.match(r'[a-zA-Z0-9_.-]+/[a-zA-Z0-9_.-]+\s*;\s*charset=(.+)', content_type)
  112. if m:
  113. encoding = m.group(1)
  114. else:
  115. encoding = 'utf-8'
  116. webpage_bytes = urlh.read()
  117. if self._downloader.params.get('dump_intermediate_pages', False):
  118. try:
  119. url = url_or_request.get_full_url()
  120. except AttributeError:
  121. url = url_or_request
  122. self.to_screen(u'Dumping request to ' + url)
  123. dump = base64.b64encode(webpage_bytes).decode('ascii')
  124. self._downloader.to_screen(dump)
  125. content = webpage_bytes.decode(encoding, 'replace')
  126. return (content, urlh)
  127. def _download_webpage(self, url_or_request, video_id, note=None, errnote=None):
  128. """ Returns the data of the page as a string """
  129. return self._download_webpage_handle(url_or_request, video_id, note, errnote)[0]
  130. def to_screen(self, msg):
  131. """Print msg to screen, prefixing it with '[ie_name]'"""
  132. self._downloader.to_screen(u'[%s] %s' % (self.IE_NAME, msg))
  133. def report_extraction(self, id_or_name):
  134. """Report information extraction."""
  135. self.to_screen(u'%s: Extracting information' % id_or_name)
  136. def report_download_webpage(self, video_id):
  137. """Report webpage download."""
  138. self.to_screen(u'%s: Downloading webpage' % video_id)
  139. def report_age_confirmation(self):
  140. """Report attempt to confirm age."""
  141. self.to_screen(u'Confirming age')
  142. def report_login(self):
  143. """Report attempt to log in."""
  144. self.to_screen(u'Logging in')
  145. #Methods for following #608
  146. def url_result(self, url, ie=None):
  147. """Returns a url that points to a page that should be processed"""
  148. #TODO: ie should be the class used for getting the info
  149. video_info = {'_type': 'url',
  150. 'url': url,
  151. 'ie_key': ie}
  152. return video_info
  153. def playlist_result(self, entries, playlist_id=None, playlist_title=None):
  154. """Returns a playlist"""
  155. video_info = {'_type': 'playlist',
  156. 'entries': entries}
  157. if playlist_id:
  158. video_info['id'] = playlist_id
  159. if playlist_title:
  160. video_info['title'] = playlist_title
  161. return video_info
  162. def _search_regex(self, pattern, string, name, default=None, fatal=True, flags=0):
  163. """
  164. Perform a regex search on the given string, using a single or a list of
  165. patterns returning the first matching group.
  166. In case of failure return a default value or raise a WARNING or a
  167. ExtractorError, depending on fatal, specifying the field name.
  168. """
  169. if isinstance(pattern, (str, compat_str, compiled_regex_type)):
  170. mobj = re.search(pattern, string, flags)
  171. else:
  172. for p in pattern:
  173. mobj = re.search(p, string, flags)
  174. if mobj: break
  175. if sys.stderr.isatty() and os.name != 'nt':
  176. _name = u'\033[0;34m%s\033[0m' % name
  177. else:
  178. _name = name
  179. if mobj:
  180. # return the first matching group
  181. return next(g for g in mobj.groups() if g is not None)
  182. elif default is not None:
  183. return default
  184. elif fatal:
  185. raise ExtractorError(u'Unable to extract %s' % _name)
  186. else:
  187. self._downloader.report_warning(u'unable to extract %s; '
  188. u'please report this issue on http://yt-dl.org/bug' % _name)
  189. return None
  190. def _html_search_regex(self, pattern, string, name, default=None, fatal=True, flags=0):
  191. """
  192. Like _search_regex, but strips HTML tags and unescapes entities.
  193. """
  194. res = self._search_regex(pattern, string, name, default, fatal, flags)
  195. if res:
  196. return clean_html(res).strip()
  197. else:
  198. return res
  199. def _get_login_info(self):
  200. """
  201. Get the the login info as (username, password)
  202. It will look in the netrc file using the _NETRC_MACHINE value
  203. If there's no info available, return (None, None)
  204. """
  205. if self._downloader is None:
  206. return (None, None)
  207. username = None
  208. password = None
  209. downloader_params = self._downloader.params
  210. # Attempt to use provided username and password or .netrc data
  211. if downloader_params.get('username', None) is not None:
  212. username = downloader_params['username']
  213. password = downloader_params['password']
  214. elif downloader_params.get('usenetrc', False):
  215. try:
  216. info = netrc.netrc().authenticators(self._NETRC_MACHINE)
  217. if info is not None:
  218. username = info[0]
  219. password = info[2]
  220. else:
  221. raise netrc.NetrcParseError('No authenticators for %s' % self._NETRC_MACHINE)
  222. except (IOError, netrc.NetrcParseError) as err:
  223. self._downloader.report_warning(u'parsing .netrc: %s' % compat_str(err))
  224. return (username, password)
  225. # Helper functions for extracting OpenGraph info
  226. @staticmethod
  227. def _og_regex(prop):
  228. return r'<meta.+?property=[\'"]og:%s[\'"].+?content=(?:"(.+?)"|\'(.+?)\')' % re.escape(prop)
  229. def _og_search_property(self, prop, html, name=None, **kargs):
  230. if name is None:
  231. name = 'OpenGraph %s' % prop
  232. escaped = self._search_regex(self._og_regex(prop), html, name, flags=re.DOTALL, **kargs)
  233. return unescapeHTML(escaped)
  234. def _og_search_thumbnail(self, html, **kargs):
  235. return self._og_search_property('image', html, u'thumbnail url', fatal=False, **kargs)
  236. def _og_search_description(self, html, **kargs):
  237. return self._og_search_property('description', html, fatal=False, **kargs)
  238. def _og_search_title(self, html, **kargs):
  239. return self._og_search_property('title', html, **kargs)
  240. def _og_search_video_url(self, html, name='video url', **kargs):
  241. return self._html_search_regex([self._og_regex('video:secure_url'),
  242. self._og_regex('video')],
  243. html, name, **kargs)
  244. class SearchInfoExtractor(InfoExtractor):
  245. """
  246. Base class for paged search queries extractors.
  247. They accept urls in the format _SEARCH_KEY(|all|[0-9]):{query}
  248. Instances should define _SEARCH_KEY and _MAX_RESULTS.
  249. """
  250. @classmethod
  251. def _make_valid_url(cls):
  252. return r'%s(?P<prefix>|[1-9][0-9]*|all):(?P<query>[\s\S]+)' % cls._SEARCH_KEY
  253. @classmethod
  254. def suitable(cls, url):
  255. return re.match(cls._make_valid_url(), url) is not None
  256. def _real_extract(self, query):
  257. mobj = re.match(self._make_valid_url(), query)
  258. if mobj is None:
  259. raise ExtractorError(u'Invalid search query "%s"' % query)
  260. prefix = mobj.group('prefix')
  261. query = mobj.group('query')
  262. if prefix == '':
  263. return self._get_n_results(query, 1)
  264. elif prefix == 'all':
  265. return self._get_n_results(query, self._MAX_RESULTS)
  266. else:
  267. n = int(prefix)
  268. if n <= 0:
  269. raise ExtractorError(u'invalid download number %s for query "%s"' % (n, query))
  270. elif n > self._MAX_RESULTS:
  271. self._downloader.report_warning(u'%s returns max %i results (you requested %i)' % (self._SEARCH_KEY, self._MAX_RESULTS, n))
  272. n = self._MAX_RESULTS
  273. return self._get_n_results(query, n)
  274. def _get_n_results(self, query, n):
  275. """Get a specified number of results for a query"""
  276. raise NotImplementedError("This method must be implemented by sublclasses")
  277. @property
  278. def SEARCH_KEY(self):
  279. return self._SEARCH_KEY