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.

793 lines
34 KiB

11 years ago
11 years ago
11 years ago
  1. #!/usr/bin/env python
  2. # -*- coding: utf-8 -*-
  3. from __future__ import absolute_import
  4. import errno
  5. import io
  6. import os
  7. import re
  8. import shutil
  9. import socket
  10. import sys
  11. import time
  12. import traceback
  13. from .utils import *
  14. from .extractor import get_info_extractor, gen_extractors
  15. from .FileDownloader import FileDownloader
  16. class YoutubeDL(object):
  17. """YoutubeDL class.
  18. YoutubeDL objects are the ones responsible of downloading the
  19. actual video file and writing it to disk if the user has requested
  20. it, among some other tasks. In most cases there should be one per
  21. program. As, given a video URL, the downloader doesn't know how to
  22. extract all the needed information, task that InfoExtractors do, it
  23. has to pass the URL to one of them.
  24. For this, YoutubeDL objects have a method that allows
  25. InfoExtractors to be registered in a given order. When it is passed
  26. a URL, the YoutubeDL object handles it to the first InfoExtractor it
  27. finds that reports being able to handle it. The InfoExtractor extracts
  28. all the information about the video or videos the URL refers to, and
  29. YoutubeDL process the extracted information, possibly using a File
  30. Downloader to download the video.
  31. YoutubeDL objects accept a lot of parameters. In order not to saturate
  32. the object constructor with arguments, it receives a dictionary of
  33. options instead. These options are available through the params
  34. attribute for the InfoExtractors to use. The YoutubeDL also
  35. registers itself as the downloader in charge for the InfoExtractors
  36. that are added to it, so this is a "mutual registration".
  37. Available options:
  38. username: Username for authentication purposes.
  39. password: Password for authentication purposes.
  40. videopassword: Password for acces a video.
  41. usenetrc: Use netrc for authentication instead.
  42. verbose: Print additional info to stdout.
  43. quiet: Do not print messages to stdout.
  44. forceurl: Force printing final URL.
  45. forcetitle: Force printing title.
  46. forceid: Force printing ID.
  47. forcethumbnail: Force printing thumbnail URL.
  48. forcedescription: Force printing description.
  49. forcefilename: Force printing final filename.
  50. simulate: Do not download the video files.
  51. format: Video format code.
  52. format_limit: Highest quality format to try.
  53. outtmpl: Template for output names.
  54. restrictfilenames: Do not allow "&" and spaces in file names
  55. ignoreerrors: Do not stop on download errors.
  56. nooverwrites: Prevent overwriting files.
  57. playliststart: Playlist item to start at.
  58. playlistend: Playlist item to end at.
  59. matchtitle: Download only matching titles.
  60. rejecttitle: Reject downloads for matching titles.
  61. logtostderr: Log messages to stderr instead of stdout.
  62. writedescription: Write the video description to a .description file
  63. writeinfojson: Write the video description to a .info.json file
  64. writeannotations: Write the video annotations to a .annotations.xml file
  65. writethumbnail: Write the thumbnail image to a file
  66. writesubtitles: Write the video subtitles to a file
  67. writeautomaticsub: Write the automatic subtitles to a file
  68. allsubtitles: Downloads all the subtitles of the video
  69. (requires writesubtitles or writeautomaticsub)
  70. listsubtitles: Lists all available subtitles for the video
  71. subtitlesformat: Subtitle format [srt/sbv/vtt] (default=srt)
  72. subtitleslangs: List of languages of the subtitles to download
  73. keepvideo: Keep the video file after post-processing
  74. daterange: A DateRange object, download only if the upload_date is in the range.
  75. skip_download: Skip the actual download of the video file
  76. cachedir: Location of the cache files in the filesystem.
  77. None to disable filesystem cache.
  78. noplaylist: Download single video instead of a playlist if in doubt.
  79. age_limit: An integer representing the user's age in years.
  80. Unsuitable videos for the given age are skipped.
  81. downloadarchive: File name of a file where all downloads are recorded.
  82. Videos already present in the file are not downloaded
  83. again.
  84. The following parameters are not used by YoutubeDL itself, they are used by
  85. the FileDownloader:
  86. nopart, updatetime, buffersize, ratelimit, min_filesize, max_filesize, test,
  87. noresizebuffer, retries, continuedl, noprogress, consoletitle
  88. """
  89. params = None
  90. _ies = []
  91. _pps = []
  92. _download_retcode = None
  93. _num_downloads = None
  94. _screen_file = None
  95. def __init__(self, params):
  96. """Create a FileDownloader object with the given options."""
  97. self._ies = []
  98. self._ies_instances = {}
  99. self._pps = []
  100. self._progress_hooks = []
  101. self._download_retcode = 0
  102. self._num_downloads = 0
  103. self._screen_file = [sys.stdout, sys.stderr][params.get('logtostderr', False)]
  104. if (sys.version_info >= (3,) and sys.platform != 'win32' and
  105. sys.getfilesystemencoding() in ['ascii', 'ANSI_X3.4-1968']
  106. and not params['restrictfilenames']):
  107. # On Python 3, the Unicode filesystem API will throw errors (#1474)
  108. self.report_warning(
  109. u'Assuming --restrict-filenames since file system encoding '
  110. u'cannot encode all charactes. '
  111. u'Set the LC_ALL environment variable to fix this.')
  112. params['restrictfilenames'] = True
  113. self.params = params
  114. self.fd = FileDownloader(self, self.params)
  115. if '%(stitle)s' in self.params['outtmpl']:
  116. self.report_warning(u'%(stitle)s is deprecated. Use the %(title)s and the --restrict-filenames flag(which also secures %(uploader)s et al) instead.')
  117. def add_info_extractor(self, ie):
  118. """Add an InfoExtractor object to the end of the list."""
  119. self._ies.append(ie)
  120. self._ies_instances[ie.ie_key()] = ie
  121. ie.set_downloader(self)
  122. def get_info_extractor(self, ie_key):
  123. """
  124. Get an instance of an IE with name ie_key, it will try to get one from
  125. the _ies list, if there's no instance it will create a new one and add
  126. it to the extractor list.
  127. """
  128. ie = self._ies_instances.get(ie_key)
  129. if ie is None:
  130. ie = get_info_extractor(ie_key)()
  131. self.add_info_extractor(ie)
  132. return ie
  133. def add_default_info_extractors(self):
  134. """
  135. Add the InfoExtractors returned by gen_extractors to the end of the list
  136. """
  137. for ie in gen_extractors():
  138. self.add_info_extractor(ie)
  139. def add_post_processor(self, pp):
  140. """Add a PostProcessor object to the end of the chain."""
  141. self._pps.append(pp)
  142. pp.set_downloader(self)
  143. def to_screen(self, message, skip_eol=False):
  144. """Print message to stdout if not in quiet mode."""
  145. if not self.params.get('quiet', False):
  146. terminator = [u'\n', u''][skip_eol]
  147. output = message + terminator
  148. write_string(output, self._screen_file)
  149. def to_stderr(self, message):
  150. """Print message to stderr."""
  151. assert type(message) == type(u'')
  152. output = message + u'\n'
  153. if 'b' in getattr(self._screen_file, 'mode', '') or sys.version_info[0] < 3: # Python 2 lies about the mode of sys.stdout/sys.stderr
  154. output = output.encode(preferredencoding())
  155. sys.stderr.write(output)
  156. def fixed_template(self):
  157. """Checks if the output template is fixed."""
  158. return (re.search(u'(?u)%\\(.+?\\)s', self.params['outtmpl']) is None)
  159. def trouble(self, message=None, tb=None):
  160. """Determine action to take when a download problem appears.
  161. Depending on if the downloader has been configured to ignore
  162. download errors or not, this method may throw an exception or
  163. not when errors are found, after printing the message.
  164. tb, if given, is additional traceback information.
  165. """
  166. if message is not None:
  167. self.to_stderr(message)
  168. if self.params.get('verbose'):
  169. if tb is None:
  170. if sys.exc_info()[0]: # if .trouble has been called from an except block
  171. tb = u''
  172. if hasattr(sys.exc_info()[1], 'exc_info') and sys.exc_info()[1].exc_info[0]:
  173. tb += u''.join(traceback.format_exception(*sys.exc_info()[1].exc_info))
  174. tb += compat_str(traceback.format_exc())
  175. else:
  176. tb_data = traceback.format_list(traceback.extract_stack())
  177. tb = u''.join(tb_data)
  178. self.to_stderr(tb)
  179. if not self.params.get('ignoreerrors', False):
  180. if sys.exc_info()[0] and hasattr(sys.exc_info()[1], 'exc_info') and sys.exc_info()[1].exc_info[0]:
  181. exc_info = sys.exc_info()[1].exc_info
  182. else:
  183. exc_info = sys.exc_info()
  184. raise DownloadError(message, exc_info)
  185. self._download_retcode = 1
  186. def report_warning(self, message):
  187. '''
  188. Print the message to stderr, it will be prefixed with 'WARNING:'
  189. If stderr is a tty file the 'WARNING:' will be colored
  190. '''
  191. if sys.stderr.isatty() and os.name != 'nt':
  192. _msg_header = u'\033[0;33mWARNING:\033[0m'
  193. else:
  194. _msg_header = u'WARNING:'
  195. warning_message = u'%s %s' % (_msg_header, message)
  196. self.to_stderr(warning_message)
  197. def report_error(self, message, tb=None):
  198. '''
  199. Do the same as trouble, but prefixes the message with 'ERROR:', colored
  200. in red if stderr is a tty file.
  201. '''
  202. if sys.stderr.isatty() and os.name != 'nt':
  203. _msg_header = u'\033[0;31mERROR:\033[0m'
  204. else:
  205. _msg_header = u'ERROR:'
  206. error_message = u'%s %s' % (_msg_header, message)
  207. self.trouble(error_message, tb)
  208. def report_writedescription(self, descfn):
  209. """ Report that the description file is being written """
  210. self.to_screen(u'[info] Writing video description to: ' + descfn)
  211. def report_writesubtitles(self, sub_filename):
  212. """ Report that the subtitles file is being written """
  213. self.to_screen(u'[info] Writing video subtitles to: ' + sub_filename)
  214. def report_writeinfojson(self, infofn):
  215. """ Report that the metadata file has been written """
  216. self.to_screen(u'[info] Video description metadata as JSON to: ' + infofn)
  217. def report_writeannotations(self, annofn):
  218. """ Report that the annotations file has been written. """
  219. self.to_screen(u'[info] Writing video annotations to: ' + annofn)
  220. def report_file_already_downloaded(self, file_name):
  221. """Report file has already been fully downloaded."""
  222. try:
  223. self.to_screen(u'[download] %s has already been downloaded' % file_name)
  224. except (UnicodeEncodeError) as err:
  225. self.to_screen(u'[download] The file has already been downloaded')
  226. def increment_downloads(self):
  227. """Increment the ordinal that assigns a number to each file."""
  228. self._num_downloads += 1
  229. def prepare_filename(self, info_dict):
  230. """Generate the output filename."""
  231. try:
  232. template_dict = dict(info_dict)
  233. template_dict['epoch'] = int(time.time())
  234. autonumber_size = self.params.get('autonumber_size')
  235. if autonumber_size is None:
  236. autonumber_size = 5
  237. autonumber_templ = u'%0' + str(autonumber_size) + u'd'
  238. template_dict['autonumber'] = autonumber_templ % self._num_downloads
  239. if template_dict.get('playlist_index') is not None:
  240. template_dict['playlist_index'] = u'%05d' % template_dict['playlist_index']
  241. sanitize = lambda k, v: sanitize_filename(
  242. u'NA' if v is None else compat_str(v),
  243. restricted=self.params.get('restrictfilenames'),
  244. is_id=(k == u'id'))
  245. template_dict = dict((k, sanitize(k, v))
  246. for k, v in template_dict.items())
  247. tmpl = os.path.expanduser(self.params['outtmpl'])
  248. filename = tmpl % template_dict
  249. return filename
  250. except KeyError as err:
  251. self.report_error(u'Erroneous output template')
  252. return None
  253. except ValueError as err:
  254. self.report_error(u'Error in output template: ' + str(err) + u' (encoding: ' + repr(preferredencoding()) + ')')
  255. return None
  256. def _match_entry(self, info_dict):
  257. """ Returns None iff the file should be downloaded """
  258. title = info_dict['title']
  259. matchtitle = self.params.get('matchtitle', False)
  260. if matchtitle:
  261. if not re.search(matchtitle, title, re.IGNORECASE):
  262. return u'[download] "' + title + '" title did not match pattern "' + matchtitle + '"'
  263. rejecttitle = self.params.get('rejecttitle', False)
  264. if rejecttitle:
  265. if re.search(rejecttitle, title, re.IGNORECASE):
  266. return u'"' + title + '" title matched reject pattern "' + rejecttitle + '"'
  267. date = info_dict.get('upload_date', None)
  268. if date is not None:
  269. dateRange = self.params.get('daterange', DateRange())
  270. if date not in dateRange:
  271. return u'[download] %s upload date is not in range %s' % (date_from_str(date).isoformat(), dateRange)
  272. age_limit = self.params.get('age_limit')
  273. if age_limit is not None:
  274. if age_limit < info_dict.get('age_limit', 0):
  275. return u'Skipping "' + title + '" because it is age restricted'
  276. if self.in_download_archive(info_dict):
  277. return (u'%(title)s has already been recorded in archive'
  278. % info_dict)
  279. return None
  280. @staticmethod
  281. def add_extra_info(info_dict, extra_info):
  282. '''Set the keys from extra_info in info dict if they are missing'''
  283. for key, value in extra_info.items():
  284. info_dict.setdefault(key, value)
  285. def extract_info(self, url, download=True, ie_key=None, extra_info={}):
  286. '''
  287. Returns a list with a dictionary for each video we find.
  288. If 'download', also downloads the videos.
  289. extra_info is a dict containing the extra values to add to each result
  290. '''
  291. if ie_key:
  292. ies = [self.get_info_extractor(ie_key)]
  293. else:
  294. ies = self._ies
  295. for ie in ies:
  296. if not ie.suitable(url):
  297. continue
  298. if not ie.working():
  299. self.report_warning(u'The program functionality for this site has been marked as broken, '
  300. u'and will probably not work.')
  301. try:
  302. ie_result = ie.extract(url)
  303. if ie_result is None: # Finished already (backwards compatibility; listformats and friends should be moved here)
  304. break
  305. if isinstance(ie_result, list):
  306. # Backwards compatibility: old IE result format
  307. ie_result = {
  308. '_type': 'compat_list',
  309. 'entries': ie_result,
  310. }
  311. if 'extractor' not in ie_result:
  312. ie_result['extractor'] = ie.IE_NAME
  313. return self.process_ie_result(ie_result, download, extra_info)
  314. except ExtractorError as de: # An error we somewhat expected
  315. self.report_error(compat_str(de), de.format_traceback())
  316. break
  317. except Exception as e:
  318. if self.params.get('ignoreerrors', False):
  319. self.report_error(compat_str(e), tb=compat_str(traceback.format_exc()))
  320. break
  321. else:
  322. raise
  323. else:
  324. self.report_error(u'no suitable InfoExtractor: %s' % url)
  325. def process_ie_result(self, ie_result, download=True, extra_info={}):
  326. """
  327. Take the result of the ie(may be modified) and resolve all unresolved
  328. references (URLs, playlist items).
  329. It will also download the videos if 'download'.
  330. Returns the resolved ie_result.
  331. """
  332. result_type = ie_result.get('_type', 'video') # If not given we suppose it's a video, support the default old system
  333. if result_type == 'video':
  334. self.add_extra_info(ie_result, extra_info)
  335. return self.process_video_result(ie_result)
  336. elif result_type == 'url':
  337. # We have to add extra_info to the results because it may be
  338. # contained in a playlist
  339. return self.extract_info(ie_result['url'],
  340. download,
  341. ie_key=ie_result.get('ie_key'),
  342. extra_info=extra_info)
  343. elif result_type == 'playlist':
  344. self.add_extra_info(ie_result, extra_info)
  345. # We process each entry in the playlist
  346. playlist = ie_result.get('title', None) or ie_result.get('id', None)
  347. self.to_screen(u'[download] Downloading playlist: %s' % playlist)
  348. playlist_results = []
  349. n_all_entries = len(ie_result['entries'])
  350. playliststart = self.params.get('playliststart', 1) - 1
  351. playlistend = self.params.get('playlistend', -1)
  352. if playlistend == -1:
  353. entries = ie_result['entries'][playliststart:]
  354. else:
  355. entries = ie_result['entries'][playliststart:playlistend]
  356. n_entries = len(entries)
  357. self.to_screen(u"[%s] playlist '%s': Collected %d video ids (downloading %d of them)" %
  358. (ie_result['extractor'], playlist, n_all_entries, n_entries))
  359. for i, entry in enumerate(entries, 1):
  360. self.to_screen(u'[download] Downloading video #%s of %s' % (i, n_entries))
  361. extra = {
  362. 'playlist': playlist,
  363. 'playlist_index': i + playliststart,
  364. 'extractor': ie_result['extractor'],
  365. }
  366. entry_result = self.process_ie_result(entry,
  367. download=download,
  368. extra_info=extra)
  369. playlist_results.append(entry_result)
  370. ie_result['entries'] = playlist_results
  371. return ie_result
  372. elif result_type == 'compat_list':
  373. def _fixup(r):
  374. self.add_extra_info(r,
  375. {'extractor': ie_result['extractor']})
  376. return r
  377. ie_result['entries'] = [
  378. self.process_ie_result(_fixup(r), download, extra_info)
  379. for r in ie_result['entries']
  380. ]
  381. return ie_result
  382. else:
  383. raise Exception('Invalid result type: %s' % result_type)
  384. def select_format(self, format_spec, available_formats):
  385. if format_spec == 'best' or format_spec is None:
  386. return available_formats[-1]
  387. elif format_spec == 'worst':
  388. return available_formats[0]
  389. else:
  390. extensions = [u'mp4', u'flv', u'webm', u'3gp']
  391. if format_spec in extensions:
  392. filter_f = lambda f: f['ext'] == format_spec
  393. else:
  394. filter_f = lambda f: f['format_id'] == format_spec
  395. matches = list(filter(filter_f, available_formats))
  396. if matches:
  397. return matches[-1]
  398. return None
  399. def process_video_result(self, info_dict, download=True):
  400. assert info_dict.get('_type', 'video') == 'video'
  401. if 'playlist' not in info_dict:
  402. # It isn't part of a playlist
  403. info_dict['playlist'] = None
  404. info_dict['playlist_index'] = None
  405. # This extractors handle format selection themselves
  406. if info_dict['extractor'] in [u'youtube', u'Youku']:
  407. if download:
  408. self.process_info(info_dict)
  409. return info_dict
  410. # We now pick which formats have to be downloaded
  411. if info_dict.get('formats') is None:
  412. # There's only one format available
  413. formats = [info_dict]
  414. else:
  415. formats = info_dict['formats']
  416. # We check that all the formats have the format and format_id fields
  417. for (i, format) in enumerate(formats):
  418. if format.get('format_id') is None:
  419. format['format_id'] = compat_str(i)
  420. if format.get('format') is None:
  421. format['format'] = u'{id} - {res}{note}'.format(
  422. id=format['format_id'],
  423. res=self.format_resolution(format),
  424. note=u' ({0})'.format(format['format_note']) if format.get('format_note') is not None else '',
  425. )
  426. # Automatically determine file extension if missing
  427. if 'ext' not in format:
  428. format['ext'] = determine_ext(format['url'])
  429. if self.params.get('listformats', None):
  430. self.list_formats(info_dict)
  431. return
  432. format_limit = self.params.get('format_limit', None)
  433. if format_limit:
  434. formats = list(takewhile_inclusive(
  435. lambda f: f['format_id'] != format_limit, formats
  436. ))
  437. if self.params.get('prefer_free_formats'):
  438. def _free_formats_key(f):
  439. try:
  440. ext_ord = [u'flv', u'mp4', u'webm'].index(f['ext'])
  441. except ValueError:
  442. ext_ord = -1
  443. # We only compare the extension if they have the same height and width
  444. return (f.get('height'), f.get('width'), ext_ord)
  445. formats = sorted(formats, key=_free_formats_key)
  446. req_format = self.params.get('format', 'best')
  447. if req_format is None:
  448. req_format = 'best'
  449. formats_to_download = []
  450. # The -1 is for supporting YoutubeIE
  451. if req_format in ('-1', 'all'):
  452. formats_to_download = formats
  453. else:
  454. # We can accept formats requestd in the format: 34/5/best, we pick
  455. # the first that is available, starting from left
  456. req_formats = req_format.split('/')
  457. for rf in req_formats:
  458. selected_format = self.select_format(rf, formats)
  459. if selected_format is not None:
  460. formats_to_download = [selected_format]
  461. break
  462. if not formats_to_download:
  463. raise ExtractorError(u'requested format not available',
  464. expected=True)
  465. if download:
  466. if len(formats_to_download) > 1:
  467. self.to_screen(u'[info] %s: downloading video in %s formats' % (info_dict['id'], len(formats_to_download)))
  468. for format in formats_to_download:
  469. new_info = dict(info_dict)
  470. new_info.update(format)
  471. self.process_info(new_info)
  472. # We update the info dict with the best quality format (backwards compatibility)
  473. info_dict.update(formats_to_download[-1])
  474. return info_dict
  475. def process_info(self, info_dict):
  476. """Process a single resolved IE result."""
  477. assert info_dict.get('_type', 'video') == 'video'
  478. #We increment the download the download count here to match the previous behaviour.
  479. self.increment_downloads()
  480. info_dict['fulltitle'] = info_dict['title']
  481. if len(info_dict['title']) > 200:
  482. info_dict['title'] = info_dict['title'][:197] + u'...'
  483. # Keep for backwards compatibility
  484. info_dict['stitle'] = info_dict['title']
  485. if not 'format' in info_dict:
  486. info_dict['format'] = info_dict['ext']
  487. reason = self._match_entry(info_dict)
  488. if reason is not None:
  489. self.to_screen(u'[download] ' + reason)
  490. return
  491. max_downloads = self.params.get('max_downloads')
  492. if max_downloads is not None:
  493. if self._num_downloads > int(max_downloads):
  494. raise MaxDownloadsReached()
  495. filename = self.prepare_filename(info_dict)
  496. # Forced printings
  497. if self.params.get('forcetitle', False):
  498. compat_print(info_dict['title'])
  499. if self.params.get('forceid', False):
  500. compat_print(info_dict['id'])
  501. if self.params.get('forceurl', False):
  502. # For RTMP URLs, also include the playpath
  503. compat_print(info_dict['url'] + info_dict.get('play_path', u''))
  504. if self.params.get('forcethumbnail', False) and info_dict.get('thumbnail') is not None:
  505. compat_print(info_dict['thumbnail'])
  506. if self.params.get('forcedescription', False) and info_dict.get('description') is not None:
  507. compat_print(info_dict['description'])
  508. if self.params.get('forcefilename', False) and filename is not None:
  509. compat_print(filename)
  510. if self.params.get('forceformat', False):
  511. compat_print(info_dict['format'])
  512. # Do nothing else if in simulate mode
  513. if self.params.get('simulate', False):
  514. return
  515. if filename is None:
  516. return
  517. try:
  518. dn = os.path.dirname(encodeFilename(filename))
  519. if dn != '' and not os.path.exists(dn):
  520. os.makedirs(dn)
  521. except (OSError, IOError) as err:
  522. self.report_error(u'unable to create directory ' + compat_str(err))
  523. return
  524. if self.params.get('writedescription', False):
  525. try:
  526. descfn = filename + u'.description'
  527. self.report_writedescription(descfn)
  528. with io.open(encodeFilename(descfn), 'w', encoding='utf-8') as descfile:
  529. descfile.write(info_dict['description'])
  530. except (KeyError, TypeError):
  531. self.report_warning(u'There\'s no description to write.')
  532. except (OSError, IOError):
  533. self.report_error(u'Cannot write description file ' + descfn)
  534. return
  535. if self.params.get('writeannotations', False):
  536. try:
  537. annofn = filename + u'.annotations.xml'
  538. self.report_writeannotations(annofn)
  539. with io.open(encodeFilename(annofn), 'w', encoding='utf-8') as annofile:
  540. annofile.write(info_dict['annotations'])
  541. except (KeyError, TypeError):
  542. self.report_warning(u'There are no annotations to write.')
  543. except (OSError, IOError):
  544. self.report_error(u'Cannot write annotations file: ' + annofn)
  545. return
  546. subtitles_are_requested = any([self.params.get('writesubtitles', False),
  547. self.params.get('writeautomaticsub')])
  548. if subtitles_are_requested and 'subtitles' in info_dict and info_dict['subtitles']:
  549. # subtitles download errors are already managed as troubles in relevant IE
  550. # that way it will silently go on when used with unsupporting IE
  551. subtitles = info_dict['subtitles']
  552. sub_format = self.params.get('subtitlesformat')
  553. for sub_lang in subtitles.keys():
  554. sub = subtitles[sub_lang]
  555. if sub is None:
  556. continue
  557. try:
  558. sub_filename = subtitles_filename(filename, sub_lang, sub_format)
  559. self.report_writesubtitles(sub_filename)
  560. with io.open(encodeFilename(sub_filename), 'w', encoding='utf-8') as subfile:
  561. subfile.write(sub)
  562. except (OSError, IOError):
  563. self.report_error(u'Cannot write subtitles file ' + descfn)
  564. return
  565. if self.params.get('writeinfojson', False):
  566. infofn = filename + u'.info.json'
  567. self.report_writeinfojson(infofn)
  568. try:
  569. json_info_dict = dict((k, v) for k, v in info_dict.items() if not k in ['urlhandle'])
  570. write_json_file(json_info_dict, encodeFilename(infofn))
  571. except (OSError, IOError):
  572. self.report_error(u'Cannot write metadata to JSON file ' + infofn)
  573. return
  574. if self.params.get('writethumbnail', False):
  575. if info_dict.get('thumbnail') is not None:
  576. thumb_format = determine_ext(info_dict['thumbnail'], u'jpg')
  577. thumb_filename = filename.rpartition('.')[0] + u'.' + thumb_format
  578. self.to_screen(u'[%s] %s: Downloading thumbnail ...' %
  579. (info_dict['extractor'], info_dict['id']))
  580. try:
  581. uf = compat_urllib_request.urlopen(info_dict['thumbnail'])
  582. with open(thumb_filename, 'wb') as thumbf:
  583. shutil.copyfileobj(uf, thumbf)
  584. self.to_screen(u'[%s] %s: Writing thumbnail to: %s' %
  585. (info_dict['extractor'], info_dict['id'], thumb_filename))
  586. except (compat_urllib_error.URLError, compat_http_client.HTTPException, socket.error) as err:
  587. self.report_warning(u'Unable to download thumbnail "%s": %s' %
  588. (info_dict['thumbnail'], compat_str(err)))
  589. if not self.params.get('skip_download', False):
  590. if self.params.get('nooverwrites', False) and os.path.exists(encodeFilename(filename)):
  591. success = True
  592. else:
  593. try:
  594. success = self.fd._do_download(filename, info_dict)
  595. except (compat_urllib_error.URLError, compat_http_client.HTTPException, socket.error) as err:
  596. self.report_error(u'unable to download video data: %s' % str(err))
  597. return
  598. except (OSError, IOError) as err:
  599. raise UnavailableVideoError(err)
  600. except (ContentTooShortError, ) as err:
  601. self.report_error(u'content too short (expected %s bytes and served %s)' % (err.expected, err.downloaded))
  602. return
  603. if success:
  604. try:
  605. self.post_process(filename, info_dict)
  606. except (PostProcessingError) as err:
  607. self.report_error(u'postprocessing: %s' % str(err))
  608. return
  609. self.record_download_archive(info_dict)
  610. def download(self, url_list):
  611. """Download a given list of URLs."""
  612. if len(url_list) > 1 and self.fixed_template():
  613. raise SameFileError(self.params['outtmpl'])
  614. for url in url_list:
  615. try:
  616. #It also downloads the videos
  617. videos = self.extract_info(url)
  618. except UnavailableVideoError:
  619. self.report_error(u'unable to download video')
  620. except MaxDownloadsReached:
  621. self.to_screen(u'[info] Maximum number of downloaded files reached.')
  622. raise
  623. return self._download_retcode
  624. def post_process(self, filename, ie_info):
  625. """Run all the postprocessors on the given file."""
  626. info = dict(ie_info)
  627. info['filepath'] = filename
  628. keep_video = None
  629. for pp in self._pps:
  630. try:
  631. keep_video_wish, new_info = pp.run(info)
  632. if keep_video_wish is not None:
  633. if keep_video_wish:
  634. keep_video = keep_video_wish
  635. elif keep_video is None:
  636. # No clear decision yet, let IE decide
  637. keep_video = keep_video_wish
  638. except PostProcessingError as e:
  639. self.report_error(e.msg)
  640. if keep_video is False and not self.params.get('keepvideo', False):
  641. try:
  642. self.to_screen(u'Deleting original file %s (pass -k to keep)' % filename)
  643. os.remove(encodeFilename(filename))
  644. except (IOError, OSError):
  645. self.report_warning(u'Unable to remove downloaded video file')
  646. def in_download_archive(self, info_dict):
  647. fn = self.params.get('download_archive')
  648. if fn is None:
  649. return False
  650. vid_id = info_dict['extractor'] + u' ' + info_dict['id']
  651. try:
  652. with locked_file(fn, 'r', encoding='utf-8') as archive_file:
  653. for line in archive_file:
  654. if line.strip() == vid_id:
  655. return True
  656. except IOError as ioe:
  657. if ioe.errno != errno.ENOENT:
  658. raise
  659. return False
  660. def record_download_archive(self, info_dict):
  661. fn = self.params.get('download_archive')
  662. if fn is None:
  663. return
  664. vid_id = info_dict['extractor'] + u' ' + info_dict['id']
  665. with locked_file(fn, 'a', encoding='utf-8') as archive_file:
  666. archive_file.write(vid_id + u'\n')
  667. @staticmethod
  668. def format_resolution(format, default='unknown'):
  669. if format.get('_resolution') is not None:
  670. return format['_resolution']
  671. if format.get('height') is not None:
  672. if format.get('width') is not None:
  673. res = u'%sx%s' % (format['width'], format['height'])
  674. else:
  675. res = u'%sp' % format['height']
  676. else:
  677. res = default
  678. return res
  679. def list_formats(self, info_dict):
  680. def line(format):
  681. return (u'%-15s%-10s%-12s%s' % (
  682. format['format_id'],
  683. format['ext'],
  684. self.format_resolution(format),
  685. format.get('format_note', ''),
  686. )
  687. )
  688. formats = info_dict.get('formats', [info_dict])
  689. formats_s = list(map(line, formats))
  690. if len(formats) > 1:
  691. formats_s[0] += (' ' if formats[0].get('format_note') else '') + '(worst)'
  692. formats_s[-1] += (' ' if formats[-1].get('format_note') else '') + '(best)'
  693. header_line = line({
  694. 'format_id': u'format code', 'ext': u'extension',
  695. '_resolution': u'resolution', 'format_note': u'note'})
  696. self.to_screen(u'[info] Available formats for %s:\n%s\n%s' %
  697. (info_dict['id'], header_line, u"\n".join(formats_s)))