]> jfr.im git - yt-dlp.git/blame - youtube_dl/YoutubeDL.py
[npo] Add support for audio
[yt-dlp.git] / youtube_dl / YoutubeDL.py
CommitLineData
8222d8de 1#!/usr/bin/env python
dcdb292f 2# coding: utf-8
8222d8de 3
6febd1c1 4from __future__ import absolute_import, unicode_literals
8222d8de 5
26e63931 6import collections
31bd3925 7import contextlib
317f7ab6 8import copy
9d2ecdbc 9import datetime
c1c9a79c 10import errno
31bd3925 11import fileinput
8222d8de 12import io
b82f815f 13import itertools
8694c600 14import json
62fec3b2 15import locale
083c9df9 16import operator
8222d8de 17import os
dca08720 18import platform
8222d8de
JMF
19import re
20import shutil
dca08720 21import subprocess
8222d8de
JMF
22import socket
23import sys
24import time
67134eab 25import tokenize
8222d8de 26import traceback
75822ca7 27import random
8222d8de 28
8c25f81b 29from .compat import (
82d8a8b6 30 compat_basestring,
dca08720 31 compat_cookiejar,
4644ac55 32 compat_expanduser,
003c69a8 33 compat_get_terminal_size,
ce02ed60 34 compat_http_client,
4f026faf 35 compat_kwargs,
d0d9ade4 36 compat_numeric_types,
e9c0cdd3 37 compat_os_name,
ce02ed60 38 compat_str,
67134eab 39 compat_tokenize_tokenize,
ce02ed60
PH
40 compat_urllib_error,
41 compat_urllib_request,
8b172c2e 42 compat_urllib_request_DataHandler,
8c25f81b
PH
43)
44from .utils import (
eedb7ba5
S
45 age_restricted,
46 args_to_str,
ce02ed60
PH
47 ContentTooShortError,
48 date_from_str,
49 DateRange,
acd69589 50 DEFAULT_OUTTMPL,
ce02ed60 51 determine_ext,
b5559424 52 determine_protocol,
ce02ed60 53 DownloadError,
c0384f22 54 encode_compat_str,
ce02ed60 55 encodeFilename,
9b9c5355 56 error_to_compat_str,
ce02ed60 57 ExtractorError,
02dbf93f 58 format_bytes,
525ef922 59 formatSeconds,
773f291d
S
60 GeoRestrictedError,
61 ISO3166Utils,
ce02ed60 62 locked_file,
dca08720 63 make_HTTPS_handler,
ce02ed60 64 MaxDownloadsReached,
b7ab0590 65 PagedList,
083c9df9 66 parse_filesize,
91410c9b 67 PerRequestProxyHandler,
dca08720 68 platform_name,
eedb7ba5 69 PostProcessingError,
ce02ed60 70 preferredencoding,
eedb7ba5 71 prepend_extension,
51fb4995 72 register_socks_protocols,
cfb56d1a 73 render_table,
eedb7ba5 74 replace_extension,
ce02ed60
PH
75 SameFileError,
76 sanitize_filename,
1bb5c511 77 sanitize_path,
dcf77cf1 78 sanitize_url,
67dda517 79 sanitized_Request,
e5660ee6 80 std_headers,
ce02ed60 81 subtitles_filename,
ce02ed60 82 UnavailableVideoError,
29eb5174 83 url_basename,
58b1f00d 84 version_tuple,
ce02ed60
PH
85 write_json_file,
86 write_string,
6a3f4c3f 87 YoutubeDLCookieProcessor,
dca08720 88 YoutubeDLHandler,
ce02ed60 89)
a0e07d31 90from .cache import Cache
e0986e31 91from .extractor import get_info_extractor, gen_extractor_classes, _LAZY_LOADER
3bc2ddcc 92from .downloader import get_suitable_downloader
4c83c967 93from .downloader.rtmp import rtmpdump_version
4f026faf 94from .postprocessor import (
f17f8651 95 FFmpegFixupM3u8PP,
62cd676c 96 FFmpegFixupM4aPP,
6271f1ca 97 FFmpegFixupStretchedPP,
4f026faf
PH
98 FFmpegMergerPP,
99 FFmpegPostProcessor,
100 get_postprocessor,
101)
dca08720 102from .version import __version__
8222d8de 103
e9c0cdd3
YCH
104if compat_os_name == 'nt':
105 import ctypes
106
8222d8de
JMF
107
108class YoutubeDL(object):
109 """YoutubeDL class.
110
111 YoutubeDL objects are the ones responsible of downloading the
112 actual video file and writing it to disk if the user has requested
113 it, among some other tasks. In most cases there should be one per
114 program. As, given a video URL, the downloader doesn't know how to
115 extract all the needed information, task that InfoExtractors do, it
116 has to pass the URL to one of them.
117
118 For this, YoutubeDL objects have a method that allows
119 InfoExtractors to be registered in a given order. When it is passed
120 a URL, the YoutubeDL object handles it to the first InfoExtractor it
121 finds that reports being able to handle it. The InfoExtractor extracts
122 all the information about the video or videos the URL refers to, and
123 YoutubeDL process the extracted information, possibly using a File
124 Downloader to download the video.
125
126 YoutubeDL objects accept a lot of parameters. In order not to saturate
127 the object constructor with arguments, it receives a dictionary of
128 options instead. These options are available through the params
129 attribute for the InfoExtractors to use. The YoutubeDL also
130 registers itself as the downloader in charge for the InfoExtractors
131 that are added to it, so this is a "mutual registration".
132
133 Available options:
134
135 username: Username for authentication purposes.
136 password: Password for authentication purposes.
180940e0 137 videopassword: Password for accessing a video.
1da50aa3
S
138 ap_mso: Adobe Pass multiple-system operator identifier.
139 ap_username: Multiple-system operator account username.
140 ap_password: Multiple-system operator account password.
8222d8de
JMF
141 usenetrc: Use netrc for authentication instead.
142 verbose: Print additional info to stdout.
143 quiet: Do not print messages to stdout.
ad8915b7 144 no_warnings: Do not print out anything for warnings.
8222d8de
JMF
145 forceurl: Force printing final URL.
146 forcetitle: Force printing title.
147 forceid: Force printing ID.
148 forcethumbnail: Force printing thumbnail URL.
149 forcedescription: Force printing description.
150 forcefilename: Force printing final filename.
525ef922 151 forceduration: Force printing duration.
8694c600 152 forcejson: Force printing info_dict as JSON.
63e0be34
PH
153 dump_single_json: Force printing the info_dict of the whole playlist
154 (or video) as a single JSON line.
8222d8de 155 simulate: Do not download the video files.
d8600787 156 format: Video format code. See options.py for more information.
8222d8de
JMF
157 outtmpl: Template for output names.
158 restrictfilenames: Do not allow "&" and spaces in file names
159 ignoreerrors: Do not stop on download errors.
d22dec74 160 force_generic_extractor: Force downloader to use the generic extractor
8222d8de
JMF
161 nooverwrites: Prevent overwriting files.
162 playliststart: Playlist item to start at.
163 playlistend: Playlist item to end at.
c14e88f0 164 playlist_items: Specific indices of playlist to download.
ff815fe6 165 playlistreverse: Download playlist items in reverse order.
75822ca7 166 playlistrandom: Download playlist items in random order.
8222d8de
JMF
167 matchtitle: Download only matching titles.
168 rejecttitle: Reject downloads for matching titles.
8bf9319e 169 logger: Log messages to a logging.Logger instance.
8222d8de
JMF
170 logtostderr: Log messages to stderr instead of stdout.
171 writedescription: Write the video description to a .description file
172 writeinfojson: Write the video description to a .info.json file
1fb07d10 173 writeannotations: Write the video annotations to a .annotations.xml file
8222d8de 174 writethumbnail: Write the thumbnail image to a file
ec82d85a 175 write_all_thumbnails: Write all thumbnail formats to files
8222d8de 176 writesubtitles: Write the video subtitles to a file
741dd8ea 177 writeautomaticsub: Write the automatically generated subtitles to a file
8222d8de 178 allsubtitles: Downloads all the subtitles of the video
0b7f3118 179 (requires writesubtitles or writeautomaticsub)
8222d8de 180 listsubtitles: Lists all available subtitles for the video
a504ced0 181 subtitlesformat: The format code for subtitles
aa6a10c4 182 subtitleslangs: List of languages of the subtitles to download
8222d8de
JMF
183 keepvideo: Keep the video file after post-processing
184 daterange: A DateRange object, download only if the upload_date is in the range.
185 skip_download: Skip the actual download of the video file
c35f9e72 186 cachedir: Location of the cache files in the filesystem.
a0e07d31 187 False to disable filesystem cache.
47192f92 188 noplaylist: Download single video instead of a playlist if in doubt.
8dbe9899
PH
189 age_limit: An integer representing the user's age in years.
190 Unsuitable videos for the given age are skipped.
5fe18bdb
PH
191 min_views: An integer representing the minimum view count the video
192 must have in order to not be skipped.
193 Videos without view count information are always
194 downloaded. None for no limit.
195 max_views: An integer representing the maximum view count.
196 Videos that are more popular than that are not
197 downloaded.
198 Videos without view count information are always
199 downloaded. None for no limit.
200 download_archive: File name of a file where all downloads are recorded.
c1c9a79c
PH
201 Videos already present in the file are not downloaded
202 again.
dca08720 203 cookiefile: File name where cookies should be read from and dumped to.
a1ee09e8 204 nocheckcertificate:Do not verify SSL certificates
7e8c0af0
PH
205 prefer_insecure: Use HTTP instead of HTTPS to retrieve information.
206 At the moment, this is only supported by YouTube.
a1ee09e8 207 proxy: URL of the proxy server to use
38cce791
YCH
208 geo_verification_proxy: URL of the proxy to use for IP address verification
209 on geo-restricted sites. (Experimental)
e344693b 210 socket_timeout: Time to wait for unresponsive hosts, in seconds
0783b09b
PH
211 bidi_workaround: Work around buggy terminals without bidirectional text
212 support, using fridibi
a0ddb8a2 213 debug_printtraffic:Print out sent and received HTTP traffic
7b0817e8 214 include_ads: Download ads as well
04b4d394
PH
215 default_search: Prepend this string if an input url is not valid.
216 'auto' for elaborate guessing
62fec3b2 217 encoding: Use this encoding instead of the system-specified.
e8ee972c 218 extract_flat: Do not resolve URLs, return the immediate result.
057a5206
PH
219 Pass in 'in_playlist' to only show this behavior for
220 playlist items.
4f026faf 221 postprocessors: A list of dictionaries, each with an entry
71b640cc
PH
222 * key: The name of the postprocessor. See
223 youtube_dl/postprocessor/__init__.py for a list.
4f026faf
PH
224 as well as any further keyword arguments for the
225 postprocessor.
71b640cc
PH
226 progress_hooks: A list of functions that get called on download
227 progress, with a dictionary with the entries
5cda4eda 228 * status: One of "downloading", "error", or "finished".
ee69b99a 229 Check this first and ignore unknown values.
71b640cc 230
5cda4eda 231 If status is one of "downloading", or "finished", the
ee69b99a
PH
232 following properties may also be present:
233 * filename: The final filename (always present)
5cda4eda 234 * tmpfilename: The filename we're currently writing to
71b640cc
PH
235 * downloaded_bytes: Bytes on disk
236 * total_bytes: Size of the whole file, None if unknown
5cda4eda
PH
237 * total_bytes_estimate: Guess of the eventual file size,
238 None if unavailable.
239 * elapsed: The number of seconds since download started.
71b640cc
PH
240 * eta: The estimated time in seconds, None if unknown
241 * speed: The download speed in bytes/second, None if
242 unknown
5cda4eda
PH
243 * fragment_index: The counter of the currently
244 downloaded video fragment.
245 * fragment_count: The number of fragments (= individual
246 files that will be merged)
71b640cc
PH
247
248 Progress hooks are guaranteed to be called at least once
249 (with status "finished") if the download is successful.
45598f15 250 merge_output_format: Extension to use when merging formats.
6271f1ca
PH
251 fixup: Automatically correct known faults of the file.
252 One of:
253 - "never": do nothing
254 - "warn": only emit a warning
255 - "detect_or_warn": check whether we can do anything
62cd676c 256 about it, warn otherwise (default)
be4a824d 257 source_address: (Experimental) Client-side IP address to bind to.
6ec6cb4e 258 call_home: Boolean, true iff we are allowed to contact the
8bfa7545 259 youtube-dl servers for debugging.
7aa589a5
S
260 sleep_interval: Number of seconds to sleep before each download when
261 used alone or a lower bound of a range for randomized
262 sleep before each download (minimum possible number
263 of seconds to sleep) when used along with
264 max_sleep_interval.
265 max_sleep_interval:Upper bound of a range for randomized sleep before each
266 download (maximum possible number of seconds to sleep).
267 Must only be used along with sleep_interval.
268 Actual sleep time will be a random float from range
269 [sleep_interval; max_sleep_interval].
cfb56d1a
PH
270 listformats: Print an overview of available video formats and exit.
271 list_thumbnails: Print a table of all thumbnails and exit.
347de493
PH
272 match_filter: A function that gets called with the info_dict of
273 every video.
274 If it returns a message, the video is ignored.
275 If it returns None, the video is downloaded.
276 match_filter_func in utils.py is one example for this.
7e5db8c9 277 no_color: Do not emit color codes in output.
0a840f58 278 geo_bypass: Bypass geographic restriction via faking X-Forwarded-For
773f291d 279 HTTP header (experimental)
0a840f58 280 geo_bypass_country:
773f291d
S
281 Two-letter ISO 3166-2 country code that will be used for
282 explicit geographic restriction bypassing via faking
283 X-Forwarded-For HTTP header (experimental)
71b640cc 284
85729c51
PH
285 The following options determine which downloader is picked:
286 external_downloader: Executable of the external downloader to call.
287 None or unset for standard (built-in) downloader.
bf09af3a
S
288 hls_prefer_native: Use the native HLS downloader instead of ffmpeg/avconv
289 if True, otherwise use ffmpeg/avconv if False, otherwise
290 use downloader suggested by extractor if None.
fe7e0c98 291
8222d8de 292 The following parameters are not used by YoutubeDL itself, they are used by
c75f0b36 293 the downloader (see youtube_dl/downloader/common.py):
8222d8de 294 nopart, updatetime, buffersize, ratelimit, min_filesize, max_filesize, test,
881e6a1f 295 noresizebuffer, retries, continuedl, noprogress, consoletitle,
7d106a65 296 xattr_set_filesize, external_downloader_args, hls_use_mpegts.
76b1bd67
JMF
297
298 The following options are used by the post processors:
299 prefer_ffmpeg: If True, use ffmpeg instead of avconv if both are available,
300 otherwise prefer avconv.
f72b0a60
S
301 postprocessor_args: A list of additional command-line arguments for the
302 postprocessor.
8222d8de
JMF
303 """
304
305 params = None
306 _ies = []
307 _pps = []
308 _download_retcode = None
309 _num_downloads = None
310 _screen_file = None
311
3511266b 312 def __init__(self, params=None, auto_init=True):
8222d8de 313 """Create a FileDownloader object with the given options."""
e9f9a10f
JMF
314 if params is None:
315 params = {}
8222d8de 316 self._ies = []
56c73665 317 self._ies_instances = {}
8222d8de 318 self._pps = []
933605d7 319 self._progress_hooks = []
8222d8de
JMF
320 self._download_retcode = 0
321 self._num_downloads = 0
322 self._screen_file = [sys.stdout, sys.stderr][params.get('logtostderr', False)]
0783b09b 323 self._err_file = sys.stderr
4abf617b
S
324 self.params = {
325 # Default parameters
326 'nocheckcertificate': False,
327 }
328 self.params.update(params)
a0e07d31 329 self.cache = Cache(self)
34308b30 330
be5df5ee
S
331 def check_deprecated(param, option, suggestion):
332 if self.params.get(param) is not None:
333 self.report_warning(
334 '%s is deprecated. Use %s instead.' % (option, suggestion))
335 return True
336 return False
337
338 if check_deprecated('cn_verification_proxy', '--cn-verification-proxy', '--geo-verification-proxy'):
38cce791
YCH
339 if self.params.get('geo_verification_proxy') is None:
340 self.params['geo_verification_proxy'] = self.params['cn_verification_proxy']
341
be5df5ee
S
342 check_deprecated('autonumber_size', '--autonumber-size', 'output template with %(autonumber)0Nd, where N in the number of digits')
343 check_deprecated('autonumber', '--auto-number', '-o "%(autonumber)s-%(title)s.%(ext)s"')
344 check_deprecated('usetitle', '--title', '-o "%(title)s-%(id)s.%(ext)s"')
345
0783b09b 346 if params.get('bidi_workaround', False):
1c088fa8
PH
347 try:
348 import pty
349 master, slave = pty.openpty()
003c69a8 350 width = compat_get_terminal_size().columns
1c088fa8
PH
351 if width is None:
352 width_args = []
353 else:
354 width_args = ['-w', str(width)]
5d681e96 355 sp_kwargs = dict(
1c088fa8
PH
356 stdin=subprocess.PIPE,
357 stdout=slave,
358 stderr=self._err_file)
5d681e96
PH
359 try:
360 self._output_process = subprocess.Popen(
361 ['bidiv'] + width_args, **sp_kwargs
362 )
363 except OSError:
5d681e96
PH
364 self._output_process = subprocess.Popen(
365 ['fribidi', '-c', 'UTF-8'] + width_args, **sp_kwargs)
366 self._output_channel = os.fdopen(master, 'rb')
1c088fa8 367 except OSError as ose:
66e7ace1 368 if ose.errno == errno.ENOENT:
6febd1c1 369 self.report_warning('Could not find fribidi executable, ignoring --bidi-workaround . Make sure that fribidi is an executable file in one of the directories in your $PATH.')
1c088fa8
PH
370 else:
371 raise
0783b09b 372
34308b30 373 if (sys.version_info >= (3,) and sys.platform != 'win32' and
8fb3ac36
PH
374 sys.getfilesystemencoding() in ['ascii', 'ANSI_X3.4-1968'] and
375 not params.get('restrictfilenames', False)):
34308b30
PH
376 # On Python 3, the Unicode filesystem API will throw errors (#1474)
377 self.report_warning(
6febd1c1 378 'Assuming --restrict-filenames since file system encoding '
1b725173 379 'cannot encode all characters. '
6febd1c1 380 'Set the LC_ALL environment variable to fix this.')
4a98cdbf 381 self.params['restrictfilenames'] = True
34308b30 382
486dd09e
PH
383 if isinstance(params.get('outtmpl'), bytes):
384 self.report_warning(
385 'Parameter outtmpl is bytes, but should be a unicode string. '
386 'Put from __future__ import unicode_literals at the top of your code file or consider switching to Python 3.x.')
387
dca08720
PH
388 self._setup_opener()
389
3511266b
PH
390 if auto_init:
391 self.print_debug_header()
392 self.add_default_info_extractors()
393
4f026faf
PH
394 for pp_def_raw in self.params.get('postprocessors', []):
395 pp_class = get_postprocessor(pp_def_raw['key'])
396 pp_def = dict(pp_def_raw)
397 del pp_def['key']
398 pp = pp_class(self, **compat_kwargs(pp_def))
399 self.add_post_processor(pp)
400
71b640cc
PH
401 for ph in self.params.get('progress_hooks', []):
402 self.add_progress_hook(ph)
403
51fb4995
YCH
404 register_socks_protocols()
405
7d4111ed
PH
406 def warn_if_short_id(self, argv):
407 # short YouTube ID starting with dash?
408 idxs = [
409 i for i, a in enumerate(argv)
410 if re.match(r'^-[0-9A-Za-z_-]{10}$', a)]
411 if idxs:
412 correct_argv = (
413 ['youtube-dl'] +
414 [a for i, a in enumerate(argv) if i not in idxs] +
415 ['--'] + [argv[i] for i in idxs]
416 )
417 self.report_warning(
418 'Long argument string detected. '
419 'Use -- to separate parameters and URLs, like this:\n%s\n' %
420 args_to_str(correct_argv))
421
8222d8de
JMF
422 def add_info_extractor(self, ie):
423 """Add an InfoExtractor object to the end of the list."""
424 self._ies.append(ie)
e52d7f85
JMF
425 if not isinstance(ie, type):
426 self._ies_instances[ie.ie_key()] = ie
427 ie.set_downloader(self)
8222d8de 428
56c73665
JMF
429 def get_info_extractor(self, ie_key):
430 """
431 Get an instance of an IE with name ie_key, it will try to get one from
432 the _ies list, if there's no instance it will create a new one and add
433 it to the extractor list.
434 """
435 ie = self._ies_instances.get(ie_key)
436 if ie is None:
437 ie = get_info_extractor(ie_key)()
438 self.add_info_extractor(ie)
439 return ie
440
023fa8c4
JMF
441 def add_default_info_extractors(self):
442 """
443 Add the InfoExtractors returned by gen_extractors to the end of the list
444 """
e52d7f85 445 for ie in gen_extractor_classes():
023fa8c4
JMF
446 self.add_info_extractor(ie)
447
8222d8de
JMF
448 def add_post_processor(self, pp):
449 """Add a PostProcessor object to the end of the chain."""
450 self._pps.append(pp)
451 pp.set_downloader(self)
452
933605d7
JMF
453 def add_progress_hook(self, ph):
454 """Add the progress hook (currently only for the file downloader)"""
455 self._progress_hooks.append(ph)
8ab470f1 456
1c088fa8 457 def _bidi_workaround(self, message):
5d681e96 458 if not hasattr(self, '_output_channel'):
1c088fa8
PH
459 return message
460
5d681e96 461 assert hasattr(self, '_output_process')
11b85ce6 462 assert isinstance(message, compat_str)
6febd1c1
PH
463 line_count = message.count('\n') + 1
464 self._output_process.stdin.write((message + '\n').encode('utf-8'))
5d681e96 465 self._output_process.stdin.flush()
6febd1c1 466 res = ''.join(self._output_channel.readline().decode('utf-8')
9e1a5b84 467 for _ in range(line_count))
6febd1c1 468 return res[:-len('\n')]
1c088fa8 469
8222d8de 470 def to_screen(self, message, skip_eol=False):
0783b09b
PH
471 """Print message to stdout if not in quiet mode."""
472 return self.to_stdout(message, skip_eol, check_quiet=True)
473
734f90bb 474 def _write_string(self, s, out=None):
b58ddb32 475 write_string(s, out=out, encoding=self.params.get('encoding'))
734f90bb 476
0783b09b 477 def to_stdout(self, message, skip_eol=False, check_quiet=False):
8222d8de 478 """Print message to stdout if not in quiet mode."""
8bf9319e 479 if self.params.get('logger'):
43afe285 480 self.params['logger'].debug(message)
0783b09b 481 elif not check_quiet or not self.params.get('quiet', False):
1c088fa8 482 message = self._bidi_workaround(message)
6febd1c1 483 terminator = ['\n', ''][skip_eol]
8222d8de 484 output = message + terminator
1c088fa8 485
734f90bb 486 self._write_string(output, self._screen_file)
8222d8de
JMF
487
488 def to_stderr(self, message):
489 """Print message to stderr."""
11b85ce6 490 assert isinstance(message, compat_str)
8bf9319e 491 if self.params.get('logger'):
43afe285
IB
492 self.params['logger'].error(message)
493 else:
1c088fa8 494 message = self._bidi_workaround(message)
6febd1c1 495 output = message + '\n'
734f90bb 496 self._write_string(output, self._err_file)
8222d8de 497
1e5b9a95
PH
498 def to_console_title(self, message):
499 if not self.params.get('consoletitle', False):
500 return
e9c0cdd3 501 if compat_os_name == 'nt' and ctypes.windll.kernel32.GetConsoleWindow():
1e5b9a95
PH
502 # c_wchar_p() might not be necessary if `message` is
503 # already of type unicode()
504 ctypes.windll.kernel32.SetConsoleTitleW(ctypes.c_wchar_p(message))
505 elif 'TERM' in os.environ:
734f90bb 506 self._write_string('\033]0;%s\007' % message, self._screen_file)
1e5b9a95 507
bdde425c
PH
508 def save_console_title(self):
509 if not self.params.get('consoletitle', False):
510 return
511 if 'TERM' in os.environ:
efd6c574 512 # Save the title on stack
734f90bb 513 self._write_string('\033[22;0t', self._screen_file)
bdde425c
PH
514
515 def restore_console_title(self):
516 if not self.params.get('consoletitle', False):
517 return
518 if 'TERM' in os.environ:
efd6c574 519 # Restore the title from stack
734f90bb 520 self._write_string('\033[23;0t', self._screen_file)
bdde425c
PH
521
522 def __enter__(self):
523 self.save_console_title()
524 return self
525
526 def __exit__(self, *args):
527 self.restore_console_title()
f89197d7 528
dca08720
PH
529 if self.params.get('cookiefile') is not None:
530 self.cookiejar.save()
bdde425c 531
8222d8de
JMF
532 def trouble(self, message=None, tb=None):
533 """Determine action to take when a download problem appears.
534
535 Depending on if the downloader has been configured to ignore
536 download errors or not, this method may throw an exception or
537 not when errors are found, after printing the message.
538
539 tb, if given, is additional traceback information.
540 """
541 if message is not None:
542 self.to_stderr(message)
543 if self.params.get('verbose'):
544 if tb is None:
545 if sys.exc_info()[0]: # if .trouble has been called from an except block
6febd1c1 546 tb = ''
8222d8de 547 if hasattr(sys.exc_info()[1], 'exc_info') and sys.exc_info()[1].exc_info[0]:
6febd1c1 548 tb += ''.join(traceback.format_exception(*sys.exc_info()[1].exc_info))
c0384f22 549 tb += encode_compat_str(traceback.format_exc())
8222d8de
JMF
550 else:
551 tb_data = traceback.format_list(traceback.extract_stack())
6febd1c1 552 tb = ''.join(tb_data)
8222d8de
JMF
553 self.to_stderr(tb)
554 if not self.params.get('ignoreerrors', False):
555 if sys.exc_info()[0] and hasattr(sys.exc_info()[1], 'exc_info') and sys.exc_info()[1].exc_info[0]:
556 exc_info = sys.exc_info()[1].exc_info
557 else:
558 exc_info = sys.exc_info()
559 raise DownloadError(message, exc_info)
560 self._download_retcode = 1
561
562 def report_warning(self, message):
563 '''
564 Print the message to stderr, it will be prefixed with 'WARNING:'
565 If stderr is a tty file the 'WARNING:' will be colored
566 '''
6d07ce01
JMF
567 if self.params.get('logger') is not None:
568 self.params['logger'].warning(message)
8222d8de 569 else:
ad8915b7
PH
570 if self.params.get('no_warnings'):
571 return
e9c0cdd3 572 if not self.params.get('no_color') and self._err_file.isatty() and compat_os_name != 'nt':
6d07ce01
JMF
573 _msg_header = '\033[0;33mWARNING:\033[0m'
574 else:
575 _msg_header = 'WARNING:'
576 warning_message = '%s %s' % (_msg_header, message)
577 self.to_stderr(warning_message)
8222d8de
JMF
578
579 def report_error(self, message, tb=None):
580 '''
581 Do the same as trouble, but prefixes the message with 'ERROR:', colored
582 in red if stderr is a tty file.
583 '''
e9c0cdd3 584 if not self.params.get('no_color') and self._err_file.isatty() and compat_os_name != 'nt':
6febd1c1 585 _msg_header = '\033[0;31mERROR:\033[0m'
8222d8de 586 else:
6febd1c1
PH
587 _msg_header = 'ERROR:'
588 error_message = '%s %s' % (_msg_header, message)
8222d8de
JMF
589 self.trouble(error_message, tb)
590
8222d8de
JMF
591 def report_file_already_downloaded(self, file_name):
592 """Report file has already been fully downloaded."""
593 try:
6febd1c1 594 self.to_screen('[download] %s has already been downloaded' % file_name)
ce02ed60 595 except UnicodeEncodeError:
6febd1c1 596 self.to_screen('[download] The file has already been downloaded')
8222d8de 597
8222d8de
JMF
598 def prepare_filename(self, info_dict):
599 """Generate the output filename."""
600 try:
601 template_dict = dict(info_dict)
602
603 template_dict['epoch'] = int(time.time())
604 autonumber_size = self.params.get('autonumber_size')
605 if autonumber_size is None:
606 autonumber_size = 5
89db639d 607 template_dict['autonumber'] = self.params.get('autonumber_start', 1) - 1 + self._num_downloads
17b75c0d
PH
608 if template_dict.get('resolution') is None:
609 if template_dict.get('width') and template_dict.get('height'):
610 template_dict['resolution'] = '%dx%d' % (template_dict['width'], template_dict['height'])
611 elif template_dict.get('height'):
805ef3c6 612 template_dict['resolution'] = '%sp' % template_dict['height']
17b75c0d 613 elif template_dict.get('width'):
51ce9117 614 template_dict['resolution'] = '%dx?' % template_dict['width']
8222d8de 615
586a91b6 616 sanitize = lambda k, v: sanitize_filename(
45598aab 617 compat_str(v),
1bb5c511 618 restricted=self.params.get('restrictfilenames'),
6febd1c1 619 is_id=(k == 'id'))
d0d9ade4 620 template_dict = dict((k, v if isinstance(v, compat_numeric_types) else sanitize(k, v))
45598aab 621 for k, v in template_dict.items()
f0e14fdd 622 if v is not None and not isinstance(v, (list, tuple, dict)))
6febd1c1 623 template_dict = collections.defaultdict(lambda: 'NA', template_dict)
8222d8de 624
b3613d36 625 outtmpl = self.params.get('outtmpl', DEFAULT_OUTTMPL)
d0d9ade4 626
89db639d
S
627 # For fields playlist_index and autonumber convert all occurrences
628 # of %(field)s to %(field)0Nd for backward compatibility
629 field_size_compat_map = {
630 'playlist_index': len(str(template_dict['n_entries'])),
631 'autonumber': autonumber_size,
632 }
633 FIELD_SIZE_COMPAT_RE = r'(?<!%)%\((?P<field>autonumber|playlist_index)\)s'
634 mobj = re.search(FIELD_SIZE_COMPAT_RE, outtmpl)
635 if mobj:
636 outtmpl = re.sub(
637 FIELD_SIZE_COMPAT_RE,
638 r'%%(\1)0%dd' % field_size_compat_map[mobj.group('field')],
639 outtmpl)
640
d0d9ade4
S
641 NUMERIC_FIELDS = set((
642 'width', 'height', 'tbr', 'abr', 'asr', 'vbr', 'fps', 'filesize', 'filesize_approx',
643 'upload_year', 'upload_month', 'upload_day',
644 'duration', 'view_count', 'like_count', 'dislike_count', 'repost_count',
645 'average_rating', 'comment_count', 'age_limit',
646 'start_time', 'end_time',
647 'chapter_number', 'season_number', 'episode_number',
b3175982 648 'track_number', 'disc_number', 'release_year',
89db639d 649 'playlist_index',
d0d9ade4
S
650 ))
651
652 # Missing numeric fields used together with integer presentation types
653 # in format specification will break the argument substitution since
654 # string 'NA' is returned for missing fields. We will patch output
655 # template for missing fields to meet string presentation type.
656 for numeric_field in NUMERIC_FIELDS:
657 if numeric_field not in template_dict:
658 # As of [1] format syntax is:
659 # %[mapping_key][conversion_flags][minimum_width][.precision][length_modifier]type
660 # 1. https://docs.python.org/2/library/stdtypes.html#string-formatting
661 FORMAT_RE = r'''(?x)
662 (?<!%)
663 %
664 \({0}\) # mapping key
665 (?:[#0\-+ ]+)? # conversion flags (optional)
666 (?:\d+)? # minimum field width (optional)
667 (?:\.\d+)? # precision (optional)
668 [hlL]? # length modifier (optional)
669 [diouxXeEfFgGcrs%] # conversion type
670 '''
671 outtmpl = re.sub(
672 FORMAT_RE.format(numeric_field),
673 r'%({0})s'.format(numeric_field), outtmpl)
674
4644ac55 675 tmpl = compat_expanduser(outtmpl)
586a91b6 676 filename = tmpl % template_dict
3a0d2f52
S
677 # Temporary fix for #4787
678 # 'Treat' all problem characters by passing filename through preferredencoding
679 # to workaround encoding issues with subprocess on python2 @ Windows
680 if sys.version_info < (3, 0) and sys.platform == 'win32':
681 filename = encodeFilename(filename, True).decode(preferredencoding())
b3613d36 682 return sanitize_path(filename)
8222d8de 683 except ValueError as err:
6febd1c1 684 self.report_error('Error in output template: ' + str(err) + ' (encoding: ' + repr(preferredencoding()) + ')')
8222d8de
JMF
685 return None
686
442c37b7 687 def _match_entry(self, info_dict, incomplete):
6ec6cb4e 688 """ Returns None iff the file should be downloaded """
8222d8de 689
6febd1c1 690 video_title = info_dict.get('title', info_dict.get('id', 'video'))
7012b23c
PH
691 if 'title' in info_dict:
692 # This can happen when we're just evaluating the playlist
693 title = info_dict['title']
694 matchtitle = self.params.get('matchtitle', False)
695 if matchtitle:
696 if not re.search(matchtitle, title, re.IGNORECASE):
6febd1c1 697 return '"' + title + '" title did not match pattern "' + matchtitle + '"'
7012b23c
PH
698 rejecttitle = self.params.get('rejecttitle', False)
699 if rejecttitle:
700 if re.search(rejecttitle, title, re.IGNORECASE):
6febd1c1 701 return '"' + title + '" title matched reject pattern "' + rejecttitle + '"'
d800609c 702 date = info_dict.get('upload_date')
8222d8de
JMF
703 if date is not None:
704 dateRange = self.params.get('daterange', DateRange())
705 if date not in dateRange:
6febd1c1 706 return '%s upload date is not in range %s' % (date_from_str(date).isoformat(), dateRange)
d800609c 707 view_count = info_dict.get('view_count')
5fe18bdb
PH
708 if view_count is not None:
709 min_views = self.params.get('min_views')
710 if min_views is not None and view_count < min_views:
6febd1c1 711 return 'Skipping %s, because it has not reached minimum view count (%d/%d)' % (video_title, view_count, min_views)
5fe18bdb
PH
712 max_views = self.params.get('max_views')
713 if max_views is not None and view_count > max_views:
6febd1c1 714 return 'Skipping %s, because it has exceeded the maximum view count (%d/%d)' % (video_title, view_count, max_views)
05900629 715 if age_restricted(info_dict.get('age_limit'), self.params.get('age_limit')):
347de493 716 return 'Skipping "%s" because it is age restricted' % video_title
c1c9a79c 717 if self.in_download_archive(info_dict):
6febd1c1 718 return '%s has already been recorded in archive' % video_title
347de493 719
442c37b7
PH
720 if not incomplete:
721 match_filter = self.params.get('match_filter')
722 if match_filter is not None:
723 ret = match_filter(info_dict)
724 if ret is not None:
725 return ret
347de493 726
8222d8de 727 return None
fe7e0c98 728
b6c45014
JMF
729 @staticmethod
730 def add_extra_info(info_dict, extra_info):
731 '''Set the keys from extra_info in info dict if they are missing'''
732 for key, value in extra_info.items():
733 info_dict.setdefault(key, value)
734
7fc3fa05 735 def extract_info(self, url, download=True, ie_key=None, extra_info={},
61aa5ba3 736 process=True, force_generic_extractor=False):
8222d8de
JMF
737 '''
738 Returns a list with a dictionary for each video we find.
739 If 'download', also downloads the videos.
740 extra_info is a dict containing the extra values to add to each result
613b2d9d 741 '''
fe7e0c98 742
61aa5ba3 743 if not ie_key and force_generic_extractor:
d22dec74
S
744 ie_key = 'Generic'
745
8222d8de 746 if ie_key:
56c73665 747 ies = [self.get_info_extractor(ie_key)]
8222d8de
JMF
748 else:
749 ies = self._ies
750
751 for ie in ies:
752 if not ie.suitable(url):
753 continue
754
e52d7f85 755 ie = self.get_info_extractor(ie.ie_key())
8222d8de 756 if not ie.working():
6febd1c1
PH
757 self.report_warning('The program functionality for this site has been marked as broken, '
758 'and will probably not work.')
8222d8de
JMF
759
760 try:
761 ie_result = ie.extract(url)
5f6a1245 762 if ie_result is None: # Finished already (backwards compatibility; listformats and friends should be moved here)
8222d8de
JMF
763 break
764 if isinstance(ie_result, list):
765 # Backwards compatibility: old IE result format
8222d8de
JMF
766 ie_result = {
767 '_type': 'compat_list',
768 'entries': ie_result,
769 }
ea38e55f 770 self.add_default_extra_info(ie_result, ie, url)
7fc3fa05
PH
771 if process:
772 return self.process_ie_result(ie_result, download, extra_info)
773 else:
774 return ie_result
773f291d
S
775 except GeoRestrictedError as e:
776 msg = e.msg
777 if e.countries:
778 msg += '\nThis video is available in %s.' % ', '.join(
779 map(ISO3166Utils.short2full, e.countries))
780 msg += '\nYou might want to use a VPN or a proxy server (with --proxy) to workaround.'
781 self.report_error(msg)
782 break
fb043a6e 783 except ExtractorError as e: # An error we somewhat expected
2c74e6fa 784 self.report_error(compat_str(e), e.format_traceback())
8222d8de 785 break
d3e5bbf4
PH
786 except MaxDownloadsReached:
787 raise
8222d8de
JMF
788 except Exception as e:
789 if self.params.get('ignoreerrors', False):
9b9c5355 790 self.report_error(error_to_compat_str(e), tb=encode_compat_str(traceback.format_exc()))
8222d8de
JMF
791 break
792 else:
793 raise
794 else:
1a489545 795 self.report_error('no suitable InfoExtractor for URL %s' % url)
fe7e0c98 796
ea38e55f
PH
797 def add_default_extra_info(self, ie_result, ie, url):
798 self.add_extra_info(ie_result, {
799 'extractor': ie.IE_NAME,
800 'webpage_url': url,
801 'webpage_url_basename': url_basename(url),
802 'extractor_key': ie.ie_key(),
803 })
804
8222d8de
JMF
805 def process_ie_result(self, ie_result, download=True, extra_info={}):
806 """
807 Take the result of the ie(may be modified) and resolve all unresolved
808 references (URLs, playlist items).
809
810 It will also download the videos if 'download'.
811 Returns the resolved ie_result.
812 """
e8ee972c
PH
813 result_type = ie_result.get('_type', 'video')
814
057a5206 815 if result_type in ('url', 'url_transparent'):
134c6ea8 816 ie_result['url'] = sanitize_url(ie_result['url'])
057a5206
PH
817 extract_flat = self.params.get('extract_flat', False)
818 if ((extract_flat == 'in_playlist' and 'playlist' in extra_info) or
819 extract_flat is True):
057a5206
PH
820 if self.params.get('forcejson', False):
821 self.to_stdout(json.dumps(ie_result))
e8ee972c
PH
822 return ie_result
823
8222d8de 824 if result_type == 'video':
b6c45014 825 self.add_extra_info(ie_result, extra_info)
feee2ecf 826 return self.process_video_result(ie_result, download=download)
8222d8de
JMF
827 elif result_type == 'url':
828 # We have to add extra_info to the results because it may be
829 # contained in a playlist
830 return self.extract_info(ie_result['url'],
831 download,
832 ie_key=ie_result.get('ie_key'),
833 extra_info=extra_info)
7fc3fa05
PH
834 elif result_type == 'url_transparent':
835 # Use the information from the embedding page
836 info = self.extract_info(
837 ie_result['url'], ie_key=ie_result.get('ie_key'),
838 extra_info=extra_info, download=False, process=False)
839
412c617d
PH
840 force_properties = dict(
841 (k, v) for k, v in ie_result.items() if v is not None)
b286f201 842 for f in ('_type', 'url', 'ie_key'):
412c617d
PH
843 if f in force_properties:
844 del force_properties[f]
845 new_result = info.copy()
846 new_result.update(force_properties)
7fc3fa05
PH
847
848 assert new_result.get('_type') != 'url_transparent'
7fc3fa05
PH
849
850 return self.process_ie_result(
851 new_result, download=download, extra_info=extra_info)
42e12102 852 elif result_type == 'playlist' or result_type == 'multi_video':
8222d8de 853 # We process each entry in the playlist
d800609c 854 playlist = ie_result.get('title') or ie_result.get('id')
6febd1c1 855 self.to_screen('[download] Downloading playlist: %s' % playlist)
8222d8de
JMF
856
857 playlist_results = []
858
8222d8de 859 playliststart = self.params.get('playliststart', 1) - 1
d800609c 860 playlistend = self.params.get('playlistend')
a19fd00c 861 # For backwards compatibility, interpret -1 as whole list
8222d8de 862 if playlistend == -1:
a19fd00c 863 playlistend = None
8222d8de 864
d800609c 865 playlistitems_str = self.params.get('playlist_items')
c14e88f0
PH
866 playlistitems = None
867 if playlistitems_str is not None:
868 def iter_playlistitems(format):
869 for string_segment in format.split(','):
870 if '-' in string_segment:
871 start, end = string_segment.split('-')
872 for item in range(int(start), int(end) + 1):
873 yield int(item)
874 else:
875 yield int(string_segment)
876 playlistitems = iter_playlistitems(playlistitems_str)
877
b82f815f
PH
878 ie_entries = ie_result['entries']
879 if isinstance(ie_entries, list):
880 n_all_entries = len(ie_entries)
c14e88f0 881 if playlistitems:
3884dcf3
JMF
882 entries = [
883 ie_entries[i - 1] for i in playlistitems
884 if -n_all_entries <= i - 1 < n_all_entries]
c14e88f0
PH
885 else:
886 entries = ie_entries[playliststart:playlistend]
b7ab0590
PH
887 n_entries = len(entries)
888 self.to_screen(
611c1dd9 889 '[%s] playlist %s: Collected %d video ids (downloading %d of them)' %
b7ab0590 890 (ie_result['extractor'], playlist, n_all_entries, n_entries))
b82f815f 891 elif isinstance(ie_entries, PagedList):
c14e88f0
PH
892 if playlistitems:
893 entries = []
894 for item in playlistitems:
895 entries.extend(ie_entries.getslice(
896 item - 1, item
897 ))
898 else:
899 entries = ie_entries.getslice(
900 playliststart, playlistend)
b7ab0590
PH
901 n_entries = len(entries)
902 self.to_screen(
611c1dd9 903 '[%s] playlist %s: Downloading %d videos' %
b7ab0590 904 (ie_result['extractor'], playlist, n_entries))
b82f815f 905 else: # iterable
c14e88f0
PH
906 if playlistitems:
907 entry_list = list(ie_entries)
908 entries = [entry_list[i - 1] for i in playlistitems]
909 else:
910 entries = list(itertools.islice(
911 ie_entries, playliststart, playlistend))
b82f815f
PH
912 n_entries = len(entries)
913 self.to_screen(
611c1dd9 914 '[%s] playlist %s: Downloading %d videos' %
b82f815f 915 (ie_result['extractor'], playlist, n_entries))
8222d8de 916
ff815fe6
MS
917 if self.params.get('playlistreverse', False):
918 entries = entries[::-1]
919
75822ca7
TC
920 if self.params.get('playlistrandom', False):
921 random.shuffle(entries)
922
0016b84e
S
923 x_forwarded_for = ie_result.get('__x_forwarded_for_ip')
924
fe7e0c98 925 for i, entry in enumerate(entries, 1):
734ea11e 926 self.to_screen('[download] Downloading video %s of %s' % (i, n_entries))
0016b84e
S
927 # This __x_forwarded_for_ip thing is a bit ugly but requires
928 # minimal changes
929 if x_forwarded_for:
930 entry['__x_forwarded_for_ip'] = x_forwarded_for
8222d8de 931 extra = {
c6b4132a 932 'n_entries': n_entries,
fe7e0c98 933 'playlist': playlist,
a1cf99d0
PH
934 'playlist_id': ie_result.get('id'),
935 'playlist_title': ie_result.get('title'),
fe7e0c98 936 'playlist_index': i + playliststart,
b6c45014 937 'extractor': ie_result['extractor'],
9103bbc5 938 'webpage_url': ie_result['webpage_url'],
29eb5174 939 'webpage_url_basename': url_basename(ie_result['webpage_url']),
be97abc2 940 'extractor_key': ie_result['extractor_key'],
fe7e0c98 941 }
7012b23c 942
442c37b7 943 reason = self._match_entry(entry, incomplete=True)
7012b23c 944 if reason is not None:
6febd1c1 945 self.to_screen('[download] ' + reason)
7012b23c
PH
946 continue
947
8222d8de
JMF
948 entry_result = self.process_ie_result(entry,
949 download=download,
950 extra_info=extra)
951 playlist_results.append(entry_result)
952 ie_result['entries'] = playlist_results
371c3b79 953 self.to_screen('[download] Finished downloading playlist: %s' % playlist)
8222d8de
JMF
954 return ie_result
955 elif result_type == 'compat_list':
c9bf4114
PH
956 self.report_warning(
957 'Extractor %s returned a compat_list result. '
958 'It needs to be updated.' % ie_result.get('extractor'))
5f6a1245 959
8222d8de 960 def _fixup(r):
9e1a5b84
JW
961 self.add_extra_info(
962 r,
9103bbc5
JMF
963 {
964 'extractor': ie_result['extractor'],
965 'webpage_url': ie_result['webpage_url'],
29eb5174 966 'webpage_url_basename': url_basename(ie_result['webpage_url']),
be97abc2 967 'extractor_key': ie_result['extractor_key'],
9e1a5b84
JW
968 }
969 )
8222d8de
JMF
970 return r
971 ie_result['entries'] = [
b6c45014 972 self.process_ie_result(_fixup(r), download, extra_info)
8222d8de
JMF
973 for r in ie_result['entries']
974 ]
975 return ie_result
976 else:
977 raise Exception('Invalid result type: %s' % result_type)
978
67134eab
JMF
979 def _build_format_filter(self, filter_spec):
980 " Returns a function to filter the formats according to the filter_spec "
083c9df9
PH
981
982 OPERATORS = {
983 '<': operator.lt,
984 '<=': operator.le,
985 '>': operator.gt,
986 '>=': operator.ge,
987 '=': operator.eq,
988 '!=': operator.ne,
989 }
67134eab 990 operator_rex = re.compile(r'''(?x)\s*
2ec19e95 991 (?P<key>width|height|tbr|abr|vbr|asr|filesize|fps)
083c9df9
PH
992 \s*(?P<op>%s)(?P<none_inclusive>\s*\?)?\s*
993 (?P<value>[0-9.]+(?:[kKmMgGtTpPeEzZyY]i?[Bb]?)?)
67134eab 994 $
083c9df9 995 ''' % '|'.join(map(re.escape, OPERATORS.keys())))
67134eab 996 m = operator_rex.search(filter_spec)
9ddb6925
S
997 if m:
998 try:
999 comparison_value = int(m.group('value'))
1000 except ValueError:
1001 comparison_value = parse_filesize(m.group('value'))
1002 if comparison_value is None:
1003 comparison_value = parse_filesize(m.group('value') + 'B')
1004 if comparison_value is None:
1005 raise ValueError(
1006 'Invalid value %r in format specification %r' % (
67134eab 1007 m.group('value'), filter_spec))
9ddb6925
S
1008 op = OPERATORS[m.group('op')]
1009
083c9df9 1010 if not m:
9ddb6925
S
1011 STR_OPERATORS = {
1012 '=': operator.eq,
1013 '!=': operator.ne,
10d33b34
YCH
1014 '^=': lambda attr, value: attr.startswith(value),
1015 '$=': lambda attr, value: attr.endswith(value),
1016 '*=': lambda attr, value: value in attr,
9ddb6925 1017 }
67134eab 1018 str_operator_rex = re.compile(r'''(?x)
d5aacf9a 1019 \s*(?P<key>ext|acodec|vcodec|container|protocol|format_id)
9ddb6925 1020 \s*(?P<op>%s)(?P<none_inclusive>\s*\?)?
b0df5223 1021 \s*(?P<value>[a-zA-Z0-9._-]+)
67134eab 1022 \s*$
9ddb6925 1023 ''' % '|'.join(map(re.escape, STR_OPERATORS.keys())))
67134eab 1024 m = str_operator_rex.search(filter_spec)
9ddb6925
S
1025 if m:
1026 comparison_value = m.group('value')
1027 op = STR_OPERATORS[m.group('op')]
083c9df9 1028
9ddb6925 1029 if not m:
67134eab 1030 raise ValueError('Invalid filter specification %r' % filter_spec)
083c9df9
PH
1031
1032 def _filter(f):
1033 actual_value = f.get(m.group('key'))
1034 if actual_value is None:
1035 return m.group('none_inclusive')
1036 return op(actual_value, comparison_value)
67134eab
JMF
1037 return _filter
1038
1039 def build_format_selector(self, format_spec):
1040 def syntax_error(note, start):
1041 message = (
1042 'Invalid format specification: '
1043 '{0}\n\t{1}\n\t{2}^'.format(note, format_spec, ' ' * start[1]))
1044 return SyntaxError(message)
1045
1046 PICKFIRST = 'PICKFIRST'
1047 MERGE = 'MERGE'
1048 SINGLE = 'SINGLE'
0130afb7 1049 GROUP = 'GROUP'
67134eab
JMF
1050 FormatSelector = collections.namedtuple('FormatSelector', ['type', 'selector', 'filters'])
1051
1052 def _parse_filter(tokens):
1053 filter_parts = []
1054 for type, string, start, _, _ in tokens:
1055 if type == tokenize.OP and string == ']':
1056 return ''.join(filter_parts)
1057 else:
1058 filter_parts.append(string)
1059
232541df 1060 def _remove_unused_ops(tokens):
17cc1534 1061 # Remove operators that we don't use and join them with the surrounding strings
232541df
JMF
1062 # for example: 'mp4' '-' 'baseline' '-' '16x9' is converted to 'mp4-baseline-16x9'
1063 ALLOWED_OPS = ('/', '+', ',', '(', ')')
1064 last_string, last_start, last_end, last_line = None, None, None, None
1065 for type, string, start, end, line in tokens:
1066 if type == tokenize.OP and string == '[':
1067 if last_string:
1068 yield tokenize.NAME, last_string, last_start, last_end, last_line
1069 last_string = None
1070 yield type, string, start, end, line
1071 # everything inside brackets will be handled by _parse_filter
1072 for type, string, start, end, line in tokens:
1073 yield type, string, start, end, line
1074 if type == tokenize.OP and string == ']':
1075 break
1076 elif type == tokenize.OP and string in ALLOWED_OPS:
1077 if last_string:
1078 yield tokenize.NAME, last_string, last_start, last_end, last_line
1079 last_string = None
1080 yield type, string, start, end, line
1081 elif type in [tokenize.NAME, tokenize.NUMBER, tokenize.OP]:
1082 if not last_string:
1083 last_string = string
1084 last_start = start
1085 last_end = end
1086 else:
1087 last_string += string
1088 if last_string:
1089 yield tokenize.NAME, last_string, last_start, last_end, last_line
1090
cf2ac6df 1091 def _parse_format_selection(tokens, inside_merge=False, inside_choice=False, inside_group=False):
67134eab
JMF
1092 selectors = []
1093 current_selector = None
1094 for type, string, start, _, _ in tokens:
1095 # ENCODING is only defined in python 3.x
1096 if type == getattr(tokenize, 'ENCODING', None):
1097 continue
1098 elif type in [tokenize.NAME, tokenize.NUMBER]:
1099 current_selector = FormatSelector(SINGLE, string, [])
1100 elif type == tokenize.OP:
cf2ac6df
JMF
1101 if string == ')':
1102 if not inside_group:
1103 # ')' will be handled by the parentheses group
1104 tokens.restore_last_token()
67134eab 1105 break
cf2ac6df 1106 elif inside_merge and string in ['/', ',']:
0130afb7
JMF
1107 tokens.restore_last_token()
1108 break
cf2ac6df
JMF
1109 elif inside_choice and string == ',':
1110 tokens.restore_last_token()
1111 break
1112 elif string == ',':
0a31a350
JMF
1113 if not current_selector:
1114 raise syntax_error('"," must follow a format selector', start)
67134eab
JMF
1115 selectors.append(current_selector)
1116 current_selector = None
1117 elif string == '/':
d96d604e
JMF
1118 if not current_selector:
1119 raise syntax_error('"/" must follow a format selector', start)
67134eab 1120 first_choice = current_selector
cf2ac6df 1121 second_choice = _parse_format_selection(tokens, inside_choice=True)
f5f4a27a 1122 current_selector = FormatSelector(PICKFIRST, (first_choice, second_choice), [])
67134eab
JMF
1123 elif string == '[':
1124 if not current_selector:
1125 current_selector = FormatSelector(SINGLE, 'best', [])
1126 format_filter = _parse_filter(tokens)
1127 current_selector.filters.append(format_filter)
0130afb7
JMF
1128 elif string == '(':
1129 if current_selector:
1130 raise syntax_error('Unexpected "("', start)
cf2ac6df
JMF
1131 group = _parse_format_selection(tokens, inside_group=True)
1132 current_selector = FormatSelector(GROUP, group, [])
67134eab
JMF
1133 elif string == '+':
1134 video_selector = current_selector
cf2ac6df 1135 audio_selector = _parse_format_selection(tokens, inside_merge=True)
0a31a350
JMF
1136 if not video_selector or not audio_selector:
1137 raise syntax_error('"+" must be between two format selectors', start)
cf2ac6df 1138 current_selector = FormatSelector(MERGE, (video_selector, audio_selector), [])
67134eab
JMF
1139 else:
1140 raise syntax_error('Operator not recognized: "{0}"'.format(string), start)
1141 elif type == tokenize.ENDMARKER:
1142 break
1143 if current_selector:
1144 selectors.append(current_selector)
1145 return selectors
1146
1147 def _build_selector_function(selector):
1148 if isinstance(selector, list):
1149 fs = [_build_selector_function(s) for s in selector]
1150
317f7ab6 1151 def selector_function(ctx):
67134eab 1152 for f in fs:
317f7ab6 1153 for format in f(ctx):
67134eab
JMF
1154 yield format
1155 return selector_function
0130afb7
JMF
1156 elif selector.type == GROUP:
1157 selector_function = _build_selector_function(selector.selector)
67134eab
JMF
1158 elif selector.type == PICKFIRST:
1159 fs = [_build_selector_function(s) for s in selector.selector]
1160
317f7ab6 1161 def selector_function(ctx):
67134eab 1162 for f in fs:
317f7ab6 1163 picked_formats = list(f(ctx))
67134eab
JMF
1164 if picked_formats:
1165 return picked_formats
1166 return []
1167 elif selector.type == SINGLE:
1168 format_spec = selector.selector
1169
317f7ab6
S
1170 def selector_function(ctx):
1171 formats = list(ctx['formats'])
bb8e5536
JMF
1172 if not formats:
1173 return
5acfa126
JMF
1174 if format_spec == 'all':
1175 for f in formats:
1176 yield f
1177 elif format_spec in ['best', 'worst', None]:
67134eab
JMF
1178 format_idx = 0 if format_spec == 'worst' else -1
1179 audiovideo_formats = [
1180 f for f in formats
1181 if f.get('vcodec') != 'none' and f.get('acodec') != 'none']
1182 if audiovideo_formats:
1183 yield audiovideo_formats[format_idx]
317f7ab6
S
1184 # for extractors with incomplete formats (audio only (soundcloud)
1185 # or video only (imgur)) we will fallback to best/worst
1186 # {video,audio}-only format
1187 elif ctx['incomplete_formats']:
67134eab
JMF
1188 yield formats[format_idx]
1189 elif format_spec == 'bestaudio':
1190 audio_formats = [
1191 f for f in formats
1192 if f.get('vcodec') == 'none']
1193 if audio_formats:
1194 yield audio_formats[-1]
1195 elif format_spec == 'worstaudio':
1196 audio_formats = [
1197 f for f in formats
1198 if f.get('vcodec') == 'none']
1199 if audio_formats:
1200 yield audio_formats[0]
1201 elif format_spec == 'bestvideo':
1202 video_formats = [
1203 f for f in formats
1204 if f.get('acodec') == 'none']
1205 if video_formats:
1206 yield video_formats[-1]
1207 elif format_spec == 'worstvideo':
1208 video_formats = [
1209 f for f in formats
1210 if f.get('acodec') == 'none']
1211 if video_formats:
1212 yield video_formats[0]
1213 else:
1214 extensions = ['mp4', 'flv', 'webm', '3gp', 'm4a', 'mp3', 'ogg', 'aac', 'wav']
1215 if format_spec in extensions:
1216 filter_f = lambda f: f['ext'] == format_spec
1217 else:
1218 filter_f = lambda f: f['format_id'] == format_spec
1219 matches = list(filter(filter_f, formats))
1220 if matches:
1221 yield matches[-1]
1222 elif selector.type == MERGE:
1223 def _merge(formats_info):
1224 format_1, format_2 = [f['format_id'] for f in formats_info]
1225 # The first format must contain the video and the
1226 # second the audio
1227 if formats_info[0].get('vcodec') == 'none':
1228 self.report_error('The first format must '
1229 'contain the video, try using '
1230 '"-f %s+%s"' % (format_2, format_1))
1231 return
3d24bbfb
S
1232 # Formats must be opposite (video+audio)
1233 if formats_info[0].get('acodec') == 'none' and formats_info[1].get('acodec') == 'none':
1234 self.report_error(
1235 'Both formats %s and %s are video-only, you must specify "-f video+audio"'
1236 % (format_1, format_2))
1237 return
67134eab
JMF
1238 output_ext = (
1239 formats_info[0]['ext']
1240 if self.params.get('merge_output_format') is None
1241 else self.params['merge_output_format'])
1242 return {
1243 'requested_formats': formats_info,
1244 'format': '%s+%s' % (formats_info[0].get('format'),
1245 formats_info[1].get('format')),
1246 'format_id': '%s+%s' % (formats_info[0].get('format_id'),
1247 formats_info[1].get('format_id')),
1248 'width': formats_info[0].get('width'),
1249 'height': formats_info[0].get('height'),
1250 'resolution': formats_info[0].get('resolution'),
1251 'fps': formats_info[0].get('fps'),
1252 'vcodec': formats_info[0].get('vcodec'),
1253 'vbr': formats_info[0].get('vbr'),
1254 'stretched_ratio': formats_info[0].get('stretched_ratio'),
1255 'acodec': formats_info[1].get('acodec'),
1256 'abr': formats_info[1].get('abr'),
1257 'ext': output_ext,
1258 }
1259 video_selector, audio_selector = map(_build_selector_function, selector.selector)
083c9df9 1260
317f7ab6
S
1261 def selector_function(ctx):
1262 for pair in itertools.product(
1263 video_selector(copy.deepcopy(ctx)), audio_selector(copy.deepcopy(ctx))):
67134eab 1264 yield _merge(pair)
083c9df9 1265
67134eab 1266 filters = [self._build_format_filter(f) for f in selector.filters]
083c9df9 1267
317f7ab6
S
1268 def final_selector(ctx):
1269 ctx_copy = copy.deepcopy(ctx)
67134eab 1270 for _filter in filters:
317f7ab6
S
1271 ctx_copy['formats'] = list(filter(_filter, ctx_copy['formats']))
1272 return selector_function(ctx_copy)
67134eab 1273 return final_selector
083c9df9 1274
67134eab 1275 stream = io.BytesIO(format_spec.encode('utf-8'))
0130afb7 1276 try:
232541df 1277 tokens = list(_remove_unused_ops(compat_tokenize_tokenize(stream.readline)))
0130afb7
JMF
1278 except tokenize.TokenError:
1279 raise syntax_error('Missing closing/opening brackets or parenthesis', (0, len(format_spec)))
1280
1281 class TokenIterator(object):
1282 def __init__(self, tokens):
1283 self.tokens = tokens
1284 self.counter = 0
1285
1286 def __iter__(self):
1287 return self
1288
1289 def __next__(self):
1290 if self.counter >= len(self.tokens):
1291 raise StopIteration()
1292 value = self.tokens[self.counter]
1293 self.counter += 1
1294 return value
1295
1296 next = __next__
1297
1298 def restore_last_token(self):
1299 self.counter -= 1
1300
1301 parsed_selector = _parse_format_selection(iter(TokenIterator(tokens)))
67134eab 1302 return _build_selector_function(parsed_selector)
a9c58ad9 1303
e5660ee6
JMF
1304 def _calc_headers(self, info_dict):
1305 res = std_headers.copy()
1306
1307 add_headers = info_dict.get('http_headers')
1308 if add_headers:
1309 res.update(add_headers)
1310
1311 cookies = self._calc_cookies(info_dict)
1312 if cookies:
1313 res['Cookie'] = cookies
1314
0016b84e
S
1315 if 'X-Forwarded-For' not in res:
1316 x_forwarded_for_ip = info_dict.get('__x_forwarded_for_ip')
1317 if x_forwarded_for_ip:
1318 res['X-Forwarded-For'] = x_forwarded_for_ip
1319
e5660ee6
JMF
1320 return res
1321
1322 def _calc_cookies(self, info_dict):
5c2266df 1323 pr = sanitized_Request(info_dict['url'])
e5660ee6 1324 self.cookiejar.add_cookie_header(pr)
662435f7 1325 return pr.get_header('Cookie')
e5660ee6 1326
dd82ffea
JMF
1327 def process_video_result(self, info_dict, download=True):
1328 assert info_dict.get('_type', 'video') == 'video'
1329
bec1fad2
PH
1330 if 'id' not in info_dict:
1331 raise ExtractorError('Missing "id" field in extractor result')
1332 if 'title' not in info_dict:
1333 raise ExtractorError('Missing "title" field in extractor result')
1334
be6217b2
S
1335 if not isinstance(info_dict['id'], compat_str):
1336 self.report_warning('"id" field is not a string - forcing string conversion')
1337 info_dict['id'] = compat_str(info_dict['id'])
1338
dd82ffea
JMF
1339 if 'playlist' not in info_dict:
1340 # It isn't part of a playlist
1341 info_dict['playlist'] = None
1342 info_dict['playlist_index'] = None
1343
d5519808 1344 thumbnails = info_dict.get('thumbnails')
cfb56d1a
PH
1345 if thumbnails is None:
1346 thumbnail = info_dict.get('thumbnail')
1347 if thumbnail:
a7a14d95 1348 info_dict['thumbnails'] = thumbnails = [{'url': thumbnail}]
d5519808 1349 if thumbnails:
be6d7229 1350 thumbnails.sort(key=lambda t: (
d37708fc
RA
1351 t.get('preference') if t.get('preference') is not None else -1,
1352 t.get('width') if t.get('width') is not None else -1,
1353 t.get('height') if t.get('height') is not None else -1,
1354 t.get('id') if t.get('id') is not None else '', t.get('url')))
f6c24009 1355 for i, t in enumerate(thumbnails):
dcf77cf1 1356 t['url'] = sanitize_url(t['url'])
9603e8a7 1357 if t.get('width') and t.get('height'):
d5519808 1358 t['resolution'] = '%dx%d' % (t['width'], t['height'])
f6c24009
PH
1359 if t.get('id') is None:
1360 t['id'] = '%d' % i
d5519808 1361
b7b72db9 1362 if self.params.get('list_thumbnails'):
1363 self.list_thumbnails(info_dict)
1364 return
1365
536a55da
S
1366 thumbnail = info_dict.get('thumbnail')
1367 if thumbnail:
1368 info_dict['thumbnail'] = sanitize_url(thumbnail)
1369 elif thumbnails:
d5519808
PH
1370 info_dict['thumbnail'] = thumbnails[-1]['url']
1371
c9ae7b95 1372 if 'display_id' not in info_dict and 'id' in info_dict:
0afef30b
PH
1373 info_dict['display_id'] = info_dict['id']
1374
955c4514 1375 if info_dict.get('upload_date') is None and info_dict.get('timestamp') is not None:
a55e36f4
S
1376 # Working around out-of-range timestamp values (e.g. negative ones on Windows,
1377 # see http://bugs.python.org/issue1646728)
1378 try:
1379 upload_date = datetime.datetime.utcfromtimestamp(info_dict['timestamp'])
1380 info_dict['upload_date'] = upload_date.strftime('%Y%m%d')
1381 except (ValueError, OverflowError, OSError):
1382 pass
9d2ecdbc 1383
33d2fc2f
S
1384 # Auto generate title fields corresponding to the *_number fields when missing
1385 # in order to always have clean titles. This is very common for TV series.
1386 for field in ('chapter', 'season', 'episode'):
1387 if info_dict.get('%s_number' % field) is not None and not info_dict.get(field):
1388 info_dict[field] = '%s %d' % (field.capitalize(), info_dict['%s_number' % field])
1389
4bba3716
S
1390 subtitles = info_dict.get('subtitles')
1391 if subtitles:
1392 for _, subtitle in subtitles.items():
1393 for subtitle_format in subtitle:
33f3040a
S
1394 if subtitle_format.get('url'):
1395 subtitle_format['url'] = sanitize_url(subtitle_format['url'])
5b1d8575 1396 if subtitle_format.get('ext') is None:
4bba3716
S
1397 subtitle_format['ext'] = determine_ext(subtitle_format['url']).lower()
1398
a504ced0 1399 if self.params.get('listsubtitles', False):
360e1ca5
JMF
1400 if 'automatic_captions' in info_dict:
1401 self.list_subtitles(info_dict['id'], info_dict.get('automatic_captions'), 'automatic captions')
4bba3716 1402 self.list_subtitles(info_dict['id'], subtitles, 'subtitles')
a504ced0 1403 return
360e1ca5 1404 info_dict['requested_subtitles'] = self.process_subtitles(
4bba3716 1405 info_dict['id'], subtitles,
360e1ca5 1406 info_dict.get('automatic_captions'))
a504ced0 1407
dd82ffea
JMF
1408 # We now pick which formats have to be downloaded
1409 if info_dict.get('formats') is None:
1410 # There's only one format available
1411 formats = [info_dict]
1412 else:
1413 formats = info_dict['formats']
1414
db95dc13
PH
1415 if not formats:
1416 raise ExtractorError('No video formats found!')
1417
181c7053
S
1418 formats_dict = {}
1419
dd82ffea 1420 # We check that all the formats have the format and format_id fields
db95dc13 1421 for i, format in enumerate(formats):
bec1fad2
PH
1422 if 'url' not in format:
1423 raise ExtractorError('Missing "url" key in result (index %d)' % i)
1424
dcf77cf1
S
1425 format['url'] = sanitize_url(format['url'])
1426
dd82ffea 1427 if format.get('format_id') is None:
8016c922 1428 format['format_id'] = compat_str(i)
e2effb08
S
1429 else:
1430 # Sanitize format_id from characters used in format selector expression
ec85ded8 1431 format['format_id'] = re.sub(r'[\s,/+\[\]()]', '_', format['format_id'])
181c7053
S
1432 format_id = format['format_id']
1433 if format_id not in formats_dict:
1434 formats_dict[format_id] = []
1435 formats_dict[format_id].append(format)
1436
1437 # Make sure all formats have unique format_id
1438 for format_id, ambiguous_formats in formats_dict.items():
1439 if len(ambiguous_formats) > 1:
1440 for i, format in enumerate(ambiguous_formats):
1441 format['format_id'] = '%s-%d' % (format_id, i)
1442
1443 for i, format in enumerate(formats):
8c51aa65 1444 if format.get('format') is None:
6febd1c1 1445 format['format'] = '{id} - {res}{note}'.format(
8c51aa65
JMF
1446 id=format['format_id'],
1447 res=self.format_resolution(format),
6febd1c1 1448 note=' ({0})'.format(format['format_note']) if format.get('format_note') is not None else '',
8c51aa65 1449 )
c1002e96 1450 # Automatically determine file extension if missing
5b1d8575 1451 if format.get('ext') is None:
cce929ea 1452 format['ext'] = determine_ext(format['url']).lower()
b5559424
S
1453 # Automatically determine protocol if missing (useful for format
1454 # selection purposes)
6f0be937 1455 if format.get('protocol') is None:
b5559424 1456 format['protocol'] = determine_protocol(format)
e5660ee6
JMF
1457 # Add HTTP headers, so that external programs can use them from the
1458 # json output
1459 full_format_info = info_dict.copy()
1460 full_format_info.update(format)
1461 format['http_headers'] = self._calc_headers(full_format_info)
0016b84e
S
1462 # Remove private housekeeping stuff
1463 if '__x_forwarded_for_ip' in info_dict:
1464 del info_dict['__x_forwarded_for_ip']
dd82ffea 1465
4bcc7bd1 1466 # TODO Central sorting goes here
99e206d5 1467
f89197d7 1468 if formats[0] is not info_dict:
b3d9ef88
JMF
1469 # only set the 'formats' fields if the original info_dict list them
1470 # otherwise we end up with a circular reference, the first (and unique)
f89197d7 1471 # element in the 'formats' field in info_dict is info_dict itself,
dfb1b146 1472 # which can't be exported to json
b3d9ef88 1473 info_dict['formats'] = formats
cfb56d1a 1474 if self.params.get('listformats'):
bfaae0a7 1475 self.list_formats(info_dict)
1476 return
1477
de3ef3ed 1478 req_format = self.params.get('format')
a9c58ad9 1479 if req_format is None:
feccf29c 1480 req_format_list = []
3749e36e 1481 if (self.params.get('outtmpl', DEFAULT_OUTTMPL) != '-' and
8250c32f 1482 not info_dict.get('is_live')):
7fcb605b 1483 merger = FFmpegMergerPP(self)
97fcf1bb 1484 if merger.available and merger.can_merge():
7fcb605b 1485 req_format_list.append('bestvideo+bestaudio')
feccf29c
S
1486 req_format_list.append('best')
1487 req_format = '/'.join(req_format_list)
5acfa126 1488 format_selector = self.build_format_selector(req_format)
317f7ab6
S
1489
1490 # While in format selection we may need to have an access to the original
1491 # format set in order to calculate some metrics or do some processing.
1492 # For now we need to be able to guess whether original formats provided
1493 # by extractor are incomplete or not (i.e. whether extractor provides only
1494 # video-only or audio-only formats) for proper formats selection for
1495 # extractors with such incomplete formats (see
1496 # https://github.com/rg3/youtube-dl/pull/5556).
1497 # Since formats may be filtered during format selection and may not match
1498 # the original formats the results may be incorrect. Thus original formats
1499 # or pre-calculated metrics should be passed to format selection routines
1500 # as well.
1501 # We will pass a context object containing all necessary additional data
1502 # instead of just formats.
1503 # This fixes incorrect format selection issue (see
1504 # https://github.com/rg3/youtube-dl/issues/10083).
2e221ca3 1505 incomplete_formats = (
317f7ab6 1506 # All formats are video-only or
2e221ca3 1507 all(f.get('vcodec') != 'none' and f.get('acodec') == 'none' for f in formats) or
317f7ab6 1508 # all formats are audio-only
2e221ca3 1509 all(f.get('vcodec') == 'none' and f.get('acodec') != 'none' for f in formats))
317f7ab6
S
1510
1511 ctx = {
1512 'formats': formats,
1513 'incomplete_formats': incomplete_formats,
1514 }
1515
1516 formats_to_download = list(format_selector(ctx))
dd82ffea 1517 if not formats_to_download:
6febd1c1 1518 raise ExtractorError('requested format not available',
78a3a9f8 1519 expected=True)
dd82ffea
JMF
1520
1521 if download:
1522 if len(formats_to_download) > 1:
6febd1c1 1523 self.to_screen('[info] %s: downloading video in %s formats' % (info_dict['id'], len(formats_to_download)))
dd82ffea
JMF
1524 for format in formats_to_download:
1525 new_info = dict(info_dict)
1526 new_info.update(format)
1527 self.process_info(new_info)
1528 # We update the info dict with the best quality format (backwards compatibility)
1529 info_dict.update(formats_to_download[-1])
1530 return info_dict
1531
98c70d6f 1532 def process_subtitles(self, video_id, normal_subtitles, automatic_captions):
a504ced0 1533 """Select the requested subtitles and their format"""
98c70d6f
JMF
1534 available_subs = {}
1535 if normal_subtitles and self.params.get('writesubtitles'):
1536 available_subs.update(normal_subtitles)
1537 if automatic_captions and self.params.get('writeautomaticsub'):
1538 for lang, cap_info in automatic_captions.items():
360e1ca5
JMF
1539 if lang not in available_subs:
1540 available_subs[lang] = cap_info
1541
4d171848
JMF
1542 if (not self.params.get('writesubtitles') and not
1543 self.params.get('writeautomaticsub') or not
1544 available_subs):
1545 return None
a504ced0
JMF
1546
1547 if self.params.get('allsubtitles', False):
1548 requested_langs = available_subs.keys()
1549 else:
1550 if self.params.get('subtitleslangs', False):
1551 requested_langs = self.params.get('subtitleslangs')
1552 elif 'en' in available_subs:
1553 requested_langs = ['en']
1554 else:
1555 requested_langs = [list(available_subs.keys())[0]]
1556
1557 formats_query = self.params.get('subtitlesformat', 'best')
1558 formats_preference = formats_query.split('/') if formats_query else []
1559 subs = {}
1560 for lang in requested_langs:
1561 formats = available_subs.get(lang)
1562 if formats is None:
1563 self.report_warning('%s subtitles not available for %s' % (lang, video_id))
1564 continue
a504ced0
JMF
1565 for ext in formats_preference:
1566 if ext == 'best':
1567 f = formats[-1]
1568 break
1569 matches = list(filter(lambda f: f['ext'] == ext, formats))
1570 if matches:
1571 f = matches[-1]
1572 break
1573 else:
1574 f = formats[-1]
1575 self.report_warning(
1576 'No subtitle format found matching "%s" for language %s, '
1577 'using %s' % (formats_query, lang, f['ext']))
1578 subs[lang] = f
1579 return subs
1580
8222d8de
JMF
1581 def process_info(self, info_dict):
1582 """Process a single resolved IE result."""
1583
1584 assert info_dict.get('_type', 'video') == 'video'
fd288278
PH
1585
1586 max_downloads = self.params.get('max_downloads')
1587 if max_downloads is not None:
1588 if self._num_downloads >= int(max_downloads):
1589 raise MaxDownloadsReached()
8222d8de
JMF
1590
1591 info_dict['fulltitle'] = info_dict['title']
1592 if len(info_dict['title']) > 200:
6febd1c1 1593 info_dict['title'] = info_dict['title'][:197] + '...'
8222d8de 1594
11b85ce6 1595 if 'format' not in info_dict:
8222d8de
JMF
1596 info_dict['format'] = info_dict['ext']
1597
442c37b7 1598 reason = self._match_entry(info_dict, incomplete=False)
8222d8de 1599 if reason is not None:
6febd1c1 1600 self.to_screen('[download] ' + reason)
8222d8de
JMF
1601 return
1602
fd288278 1603 self._num_downloads += 1
8222d8de 1604
e72c7e41 1605 info_dict['_filename'] = filename = self.prepare_filename(info_dict)
8222d8de
JMF
1606
1607 # Forced printings
1608 if self.params.get('forcetitle', False):
0783b09b 1609 self.to_stdout(info_dict['fulltitle'])
8222d8de 1610 if self.params.get('forceid', False):
0783b09b 1611 self.to_stdout(info_dict['id'])
8222d8de 1612 if self.params.get('forceurl', False):
16ae61f6 1613 if info_dict.get('requested_formats') is not None:
1614 for f in info_dict['requested_formats']:
1615 self.to_stdout(f['url'] + f.get('play_path', ''))
1616 else:
1617 # For RTMP URLs, also include the playpath
1618 self.to_stdout(info_dict['url'] + info_dict.get('play_path', ''))
216d71d0 1619 if self.params.get('forcethumbnail', False) and info_dict.get('thumbnail') is not None:
0783b09b 1620 self.to_stdout(info_dict['thumbnail'])
216d71d0 1621 if self.params.get('forcedescription', False) and info_dict.get('description') is not None:
0783b09b 1622 self.to_stdout(info_dict['description'])
8222d8de 1623 if self.params.get('forcefilename', False) and filename is not None:
0783b09b 1624 self.to_stdout(filename)
525ef922
PH
1625 if self.params.get('forceduration', False) and info_dict.get('duration') is not None:
1626 self.to_stdout(formatSeconds(info_dict['duration']))
8222d8de 1627 if self.params.get('forceformat', False):
0783b09b 1628 self.to_stdout(info_dict['format'])
9d153818 1629 if self.params.get('forcejson', False):
0783b09b 1630 self.to_stdout(json.dumps(info_dict))
8222d8de
JMF
1631
1632 # Do nothing else if in simulate mode
1633 if self.params.get('simulate', False):
1634 return
1635
1636 if filename is None:
1637 return
1638
1639 try:
e5a11a22 1640 dn = os.path.dirname(sanitize_path(encodeFilename(filename)))
d26e981d 1641 if dn and not os.path.exists(dn):
8222d8de
JMF
1642 os.makedirs(dn)
1643 except (OSError, IOError) as err:
9b9c5355 1644 self.report_error('unable to create directory ' + error_to_compat_str(err))
8222d8de
JMF
1645 return
1646
1647 if self.params.get('writedescription', False):
2699da80 1648 descfn = replace_extension(filename, 'description', info_dict.get('ext'))
7b6fefc9 1649 if self.params.get('nooverwrites', False) and os.path.exists(encodeFilename(descfn)):
6febd1c1 1650 self.to_screen('[info] Video description is already present')
f00fd51d
JMF
1651 elif info_dict.get('description') is None:
1652 self.report_warning('There\'s no description to write.')
7b6fefc9
PH
1653 else:
1654 try:
6febd1c1 1655 self.to_screen('[info] Writing video description to: ' + descfn)
7b6fefc9
PH
1656 with io.open(encodeFilename(descfn), 'w', encoding='utf-8') as descfile:
1657 descfile.write(info_dict['description'])
7b6fefc9 1658 except (OSError, IOError):
6febd1c1 1659 self.report_error('Cannot write description file ' + descfn)
7b6fefc9 1660 return
8222d8de 1661
1fb07d10 1662 if self.params.get('writeannotations', False):
98727e12 1663 annofn = replace_extension(filename, 'annotations.xml', info_dict.get('ext'))
7b6fefc9 1664 if self.params.get('nooverwrites', False) and os.path.exists(encodeFilename(annofn)):
6febd1c1 1665 self.to_screen('[info] Video annotations are already present')
7b6fefc9
PH
1666 else:
1667 try:
6febd1c1 1668 self.to_screen('[info] Writing video annotations to: ' + annofn)
7b6fefc9
PH
1669 with io.open(encodeFilename(annofn), 'w', encoding='utf-8') as annofile:
1670 annofile.write(info_dict['annotations'])
1671 except (KeyError, TypeError):
6febd1c1 1672 self.report_warning('There are no annotations to write.')
7b6fefc9 1673 except (OSError, IOError):
6febd1c1 1674 self.report_error('Cannot write annotations file: ' + annofn)
7b6fefc9 1675 return
1fb07d10 1676
c4a91be7 1677 subtitles_are_requested = any([self.params.get('writesubtitles', False),
0b7f3118 1678 self.params.get('writeautomaticsub')])
c4a91be7 1679
c84dd8a9 1680 if subtitles_are_requested and info_dict.get('requested_subtitles'):
8222d8de
JMF
1681 # subtitles download errors are already managed as troubles in relevant IE
1682 # that way it will silently go on when used with unsupporting IE
c84dd8a9 1683 subtitles = info_dict['requested_subtitles']
0f2c0d33 1684 ie = self.get_info_extractor(info_dict['extractor_key'])
a504ced0
JMF
1685 for sub_lang, sub_info in subtitles.items():
1686 sub_format = sub_info['ext']
1687 if sub_info.get('data') is not None:
1688 sub_data = sub_info['data']
1689 else:
1690 try:
0f2c0d33
JMF
1691 sub_data = ie._download_webpage(
1692 sub_info['url'], info_dict['id'], note=False)
1693 except ExtractorError as err:
a504ced0 1694 self.report_warning('Unable to download subtitle for "%s": %s' %
9b9c5355 1695 (sub_lang, error_to_compat_str(err.cause)))
a504ced0 1696 continue
8222d8de 1697 try:
d4051a8e 1698 sub_filename = subtitles_filename(filename, sub_lang, sub_format)
7b6fefc9 1699 if self.params.get('nooverwrites', False) and os.path.exists(encodeFilename(sub_filename)):
6febd1c1 1700 self.to_screen('[info] Video subtitle %s.%s is already_present' % (sub_lang, sub_format))
7b6fefc9 1701 else:
6febd1c1 1702 self.to_screen('[info] Writing video subtitles to: ' + sub_filename)
b1927f4e
YCH
1703 # Use newline='' to prevent conversion of newline characters
1704 # See https://github.com/rg3/youtube-dl/issues/10268
7f832413 1705 with io.open(encodeFilename(sub_filename), 'w', encoding='utf-8', newline='') as subfile:
a504ced0 1706 subfile.write(sub_data)
8222d8de 1707 except (OSError, IOError):
e4db1951 1708 self.report_error('Cannot write subtitles file ' + sub_filename)
8222d8de
JMF
1709 return
1710
8222d8de 1711 if self.params.get('writeinfojson', False):
b29e0000 1712 infofn = replace_extension(filename, 'info.json', info_dict.get('ext'))
7b6fefc9 1713 if self.params.get('nooverwrites', False) and os.path.exists(encodeFilename(infofn)):
6febd1c1 1714 self.to_screen('[info] Video description metadata is already present')
7b6fefc9 1715 else:
6febd1c1 1716 self.to_screen('[info] Writing video description metadata as JSON to: ' + infofn)
7b6fefc9 1717 try:
cb202fd2 1718 write_json_file(self.filter_requested_info(info_dict), infofn)
7b6fefc9 1719 except (OSError, IOError):
6febd1c1 1720 self.report_error('Cannot write metadata to JSON file ' + infofn)
7b6fefc9 1721 return
8222d8de 1722
ec82d85a 1723 self._write_thumbnails(info_dict, filename)
8222d8de
JMF
1724
1725 if not self.params.get('skip_download', False):
4340deca
P
1726 try:
1727 def dl(name, info):
a055469f 1728 fd = get_suitable_downloader(info, self.params)(self, self.params)
4340deca
P
1729 for ph in self._progress_hooks:
1730 fd.add_progress_hook(ph)
1731 if self.params.get('verbose'):
1732 self.to_stdout('[debug] Invoking downloader on %r' % info.get('url'))
1733 return fd.download(name, info)
ee69b99a 1734
4340deca
P
1735 if info_dict.get('requested_formats') is not None:
1736 downloaded = []
1737 success = True
d47aeb22 1738 merger = FFmpegMergerPP(self)
f740fae2 1739 if not merger.available:
4340deca
P
1740 postprocessors = []
1741 self.report_warning('You have requested multiple '
1742 'formats but ffmpeg or avconv are not installed.'
4a5a898a 1743 ' The formats won\'t be merged.')
6350728b 1744 else:
4340deca 1745 postprocessors = [merger]
81cd954a
S
1746
1747 def compatible_formats(formats):
1748 video, audio = formats
1749 # Check extension
1750 video_ext, audio_ext = audio.get('ext'), video.get('ext')
1751 if video_ext and audio_ext:
1752 COMPATIBLE_EXTS = (
b2758123 1753 ('mp3', 'mp4', 'm4a', 'm4p', 'm4b', 'm4r', 'm4v', 'ismv', 'isma'),
81cd954a
S
1754 ('webm')
1755 )
1756 for exts in COMPATIBLE_EXTS:
1757 if video_ext in exts and audio_ext in exts:
1758 return True
1759 # TODO: Check acodec/vcodec
1760 return False
1761
38c6902b
S
1762 filename_real_ext = os.path.splitext(filename)[1][1:]
1763 filename_wo_ext = (
1764 os.path.splitext(filename)[0]
1765 if filename_real_ext == info_dict['ext']
1766 else filename)
81cd954a 1767 requested_formats = info_dict['requested_formats']
c0dea0a7 1768 if self.params.get('merge_output_format') is None and not compatible_formats(requested_formats):
38c6902b 1769 info_dict['ext'] = 'mkv'
4a5a898a
S
1770 self.report_warning(
1771 'Requested formats are incompatible for merge and will be merged into mkv.')
38c6902b
S
1772 # Ensure filename always has a correct extension for successful merge
1773 filename = '%s.%s' % (filename_wo_ext, info_dict['ext'])
5b5fbc08
JMF
1774 if os.path.exists(encodeFilename(filename)):
1775 self.to_screen(
1776 '[download] %s has already been downloaded and '
1777 'merged' % filename)
1778 else:
81cd954a 1779 for f in requested_formats:
5b5fbc08
JMF
1780 new_info = dict(info_dict)
1781 new_info.update(f)
1782 fname = self.prepare_filename(new_info)
666a9a2b 1783 fname = prepend_extension(fname, 'f%s' % f['format_id'], new_info['ext'])
5b5fbc08
JMF
1784 downloaded.append(fname)
1785 partial_success = dl(fname, new_info)
1786 success = success and partial_success
1787 info_dict['__postprocessors'] = postprocessors
1788 info_dict['__files_to_merge'] = downloaded
4340deca
P
1789 else:
1790 # Just a single file
1791 success = dl(filename, info_dict)
1792 except (compat_urllib_error.URLError, compat_http_client.HTTPException, socket.error) as err:
7960b056 1793 self.report_error('unable to download video data: %s' % error_to_compat_str(err))
4340deca
P
1794 return
1795 except (OSError, IOError) as err:
1796 raise UnavailableVideoError(err)
1797 except (ContentTooShortError, ) as err:
1798 self.report_error('content too short (expected %s bytes and served %s)' % (err.expected, err.downloaded))
1799 return
8222d8de 1800
e38cafe9 1801 if success and filename != '-':
6271f1ca 1802 # Fixup content
62cd676c
PH
1803 fixup_policy = self.params.get('fixup')
1804 if fixup_policy is None:
1805 fixup_policy = 'detect_or_warn'
1806
d1e4a464
S
1807 INSTALL_FFMPEG_MESSAGE = 'Install ffmpeg or avconv to fix this automatically.'
1808
6271f1ca
PH
1809 stretched_ratio = info_dict.get('stretched_ratio')
1810 if stretched_ratio is not None and stretched_ratio != 1:
6271f1ca
PH
1811 if fixup_policy == 'warn':
1812 self.report_warning('%s: Non-uniform pixel ratio (%s)' % (
1813 info_dict['id'], stretched_ratio))
1814 elif fixup_policy == 'detect_or_warn':
1815 stretched_pp = FFmpegFixupStretchedPP(self)
1816 if stretched_pp.available:
1817 info_dict.setdefault('__postprocessors', [])
1818 info_dict['__postprocessors'].append(stretched_pp)
1819 else:
1820 self.report_warning(
d1e4a464
S
1821 '%s: Non-uniform pixel ratio (%s). %s'
1822 % (info_dict['id'], stretched_ratio, INSTALL_FFMPEG_MESSAGE))
6271f1ca 1823 else:
62cd676c
PH
1824 assert fixup_policy in ('ignore', 'never')
1825
d1e4a464
S
1826 if (info_dict.get('requested_formats') is None and
1827 info_dict.get('container') == 'm4a_dash'):
62cd676c 1828 if fixup_policy == 'warn':
d1e4a464
S
1829 self.report_warning(
1830 '%s: writing DASH m4a. '
1831 'Only some players support this container.'
1832 % info_dict['id'])
62cd676c
PH
1833 elif fixup_policy == 'detect_or_warn':
1834 fixup_pp = FFmpegFixupM4aPP(self)
1835 if fixup_pp.available:
1836 info_dict.setdefault('__postprocessors', [])
1837 info_dict['__postprocessors'].append(fixup_pp)
1838 else:
1839 self.report_warning(
d1e4a464
S
1840 '%s: writing DASH m4a. '
1841 'Only some players support this container. %s'
1842 % (info_dict['id'], INSTALL_FFMPEG_MESSAGE))
62cd676c
PH
1843 else:
1844 assert fixup_policy in ('ignore', 'never')
6271f1ca 1845
d1e4a464
S
1846 if (info_dict.get('protocol') == 'm3u8_native' or
1847 info_dict.get('protocol') == 'm3u8' and
1848 self.params.get('hls_prefer_native')):
f17f8651 1849 if fixup_policy == 'warn':
1850 self.report_warning('%s: malformated aac bitstream.' % (
1851 info_dict['id']))
1852 elif fixup_policy == 'detect_or_warn':
1853 fixup_pp = FFmpegFixupM3u8PP(self)
1854 if fixup_pp.available:
1855 info_dict.setdefault('__postprocessors', [])
1856 info_dict['__postprocessors'].append(fixup_pp)
1857 else:
1858 self.report_warning(
d1e4a464
S
1859 '%s: malformated aac bitstream. %s'
1860 % (info_dict['id'], INSTALL_FFMPEG_MESSAGE))
f17f8651 1861 else:
1862 assert fixup_policy in ('ignore', 'never')
1863
8222d8de
JMF
1864 try:
1865 self.post_process(filename, info_dict)
1866 except (PostProcessingError) as err:
6febd1c1 1867 self.report_error('postprocessing: %s' % str(err))
8222d8de 1868 return
cd58dc3e 1869 self.record_download_archive(info_dict)
8222d8de
JMF
1870
1871 def download(self, url_list):
1872 """Download a given list of URLs."""
acd69589 1873 outtmpl = self.params.get('outtmpl', DEFAULT_OUTTMPL)
0c75c3fa 1874 if (len(url_list) > 1 and
8fb3ac36
PH
1875 '%' not in outtmpl and
1876 self.params.get('max_downloads') != 1):
acd69589 1877 raise SameFileError(outtmpl)
8222d8de
JMF
1878
1879 for url in url_list:
1880 try:
5f6a1245 1881 # It also downloads the videos
61aa5ba3
S
1882 res = self.extract_info(
1883 url, force_generic_extractor=self.params.get('force_generic_extractor', False))
8222d8de 1884 except UnavailableVideoError:
6febd1c1 1885 self.report_error('unable to download video')
8222d8de 1886 except MaxDownloadsReached:
6febd1c1 1887 self.to_screen('[info] Maximum number of downloaded files reached.')
8222d8de 1888 raise
63e0be34
PH
1889 else:
1890 if self.params.get('dump_single_json', False):
1891 self.to_stdout(json.dumps(res))
8222d8de
JMF
1892
1893 return self._download_retcode
1894
1dcc4c0c 1895 def download_with_info_file(self, info_filename):
31bd3925
JMF
1896 with contextlib.closing(fileinput.FileInput(
1897 [info_filename], mode='r',
1898 openhook=fileinput.hook_encoded('utf-8'))) as f:
1899 # FileInput doesn't have a read method, we can't call json.load
cb202fd2 1900 info = self.filter_requested_info(json.loads('\n'.join(f)))
d4943898
JMF
1901 try:
1902 self.process_ie_result(info, download=True)
1903 except DownloadError:
1904 webpage_url = info.get('webpage_url')
1905 if webpage_url is not None:
6febd1c1 1906 self.report_warning('The info failed to download, trying with "%s"' % webpage_url)
d4943898
JMF
1907 return self.download([webpage_url])
1908 else:
1909 raise
1910 return self._download_retcode
1dcc4c0c 1911
cb202fd2
S
1912 @staticmethod
1913 def filter_requested_info(info_dict):
1914 return dict(
1915 (k, v) for k, v in info_dict.items()
1916 if k not in ['requested_formats', 'requested_subtitles'])
1917
8222d8de
JMF
1918 def post_process(self, filename, ie_info):
1919 """Run all the postprocessors on the given file."""
1920 info = dict(ie_info)
1921 info['filepath'] = filename
6350728b
JMF
1922 pps_chain = []
1923 if ie_info.get('__postprocessors') is not None:
1924 pps_chain.extend(ie_info['__postprocessors'])
1925 pps_chain.extend(self._pps)
1926 for pp in pps_chain:
71646e46 1927 files_to_delete = []
8222d8de 1928 try:
592e97e8 1929 files_to_delete, info = pp.run(info)
8222d8de 1930 except PostProcessingError as e:
bbcbf4d4 1931 self.report_error(e.msg)
592e97e8
JMF
1932 if files_to_delete and not self.params.get('keepvideo', False):
1933 for old_filename in files_to_delete:
f3ff1a36 1934 self.to_screen('Deleting original file %s (pass -k to keep)' % old_filename)
592e97e8
JMF
1935 try:
1936 os.remove(encodeFilename(old_filename))
1937 except (IOError, OSError):
1938 self.report_warning('Unable to remove downloaded original file')
c1c9a79c 1939
5db07df6
PH
1940 def _make_archive_id(self, info_dict):
1941 # Future-proof against any change in case
1942 # and backwards compatibility with prior versions
d31209a1 1943 extractor = info_dict.get('extractor_key')
7012b23c
PH
1944 if extractor is None:
1945 if 'id' in info_dict:
1946 extractor = info_dict.get('ie_key') # key in a playlist
1947 if extractor is None:
5db07df6 1948 return None # Incomplete video information
6febd1c1 1949 return extractor.lower() + ' ' + info_dict['id']
5db07df6
PH
1950
1951 def in_download_archive(self, info_dict):
1952 fn = self.params.get('download_archive')
1953 if fn is None:
1954 return False
1955
1956 vid_id = self._make_archive_id(info_dict)
1957 if vid_id is None:
7012b23c 1958 return False # Incomplete video information
5db07df6 1959
c1c9a79c
PH
1960 try:
1961 with locked_file(fn, 'r', encoding='utf-8') as archive_file:
1962 for line in archive_file:
1963 if line.strip() == vid_id:
1964 return True
1965 except IOError as ioe:
1966 if ioe.errno != errno.ENOENT:
1967 raise
1968 return False
1969
1970 def record_download_archive(self, info_dict):
1971 fn = self.params.get('download_archive')
1972 if fn is None:
1973 return
5db07df6
PH
1974 vid_id = self._make_archive_id(info_dict)
1975 assert vid_id
c1c9a79c 1976 with locked_file(fn, 'a', encoding='utf-8') as archive_file:
6febd1c1 1977 archive_file.write(vid_id + '\n')
dd82ffea 1978
8c51aa65 1979 @staticmethod
8abeeb94 1980 def format_resolution(format, default='unknown'):
fb04e403
PH
1981 if format.get('vcodec') == 'none':
1982 return 'audio only'
f49d89ee
PH
1983 if format.get('resolution') is not None:
1984 return format['resolution']
8c51aa65
JMF
1985 if format.get('height') is not None:
1986 if format.get('width') is not None:
6febd1c1 1987 res = '%sx%s' % (format['width'], format['height'])
8c51aa65 1988 else:
6febd1c1 1989 res = '%sp' % format['height']
f49d89ee 1990 elif format.get('width') is not None:
388ae76b 1991 res = '%dx?' % format['width']
8c51aa65 1992 else:
8abeeb94 1993 res = default
8c51aa65
JMF
1994 return res
1995
c57f7757
PH
1996 def _format_note(self, fdict):
1997 res = ''
1998 if fdict.get('ext') in ['f4f', 'f4m']:
1999 res += '(unsupported) '
32f90364
PH
2000 if fdict.get('language'):
2001 if res:
2002 res += ' '
9016d76f 2003 res += '[%s] ' % fdict['language']
c57f7757
PH
2004 if fdict.get('format_note') is not None:
2005 res += fdict['format_note'] + ' '
2006 if fdict.get('tbr') is not None:
2007 res += '%4dk ' % fdict['tbr']
2008 if fdict.get('container') is not None:
2009 if res:
2010 res += ', '
2011 res += '%s container' % fdict['container']
2012 if (fdict.get('vcodec') is not None and
2013 fdict.get('vcodec') != 'none'):
2014 if res:
2015 res += ', '
2016 res += fdict['vcodec']
91c7271a 2017 if fdict.get('vbr') is not None:
c57f7757
PH
2018 res += '@'
2019 elif fdict.get('vbr') is not None and fdict.get('abr') is not None:
2020 res += 'video@'
2021 if fdict.get('vbr') is not None:
2022 res += '%4dk' % fdict['vbr']
fbb21cf5 2023 if fdict.get('fps') is not None:
5d583bdf
S
2024 if res:
2025 res += ', '
2026 res += '%sfps' % fdict['fps']
c57f7757
PH
2027 if fdict.get('acodec') is not None:
2028 if res:
2029 res += ', '
2030 if fdict['acodec'] == 'none':
2031 res += 'video only'
2032 else:
2033 res += '%-5s' % fdict['acodec']
2034 elif fdict.get('abr') is not None:
2035 if res:
2036 res += ', '
2037 res += 'audio'
2038 if fdict.get('abr') is not None:
2039 res += '@%3dk' % fdict['abr']
2040 if fdict.get('asr') is not None:
2041 res += ' (%5dHz)' % fdict['asr']
2042 if fdict.get('filesize') is not None:
2043 if res:
2044 res += ', '
2045 res += format_bytes(fdict['filesize'])
9732d77e
PH
2046 elif fdict.get('filesize_approx') is not None:
2047 if res:
2048 res += ', '
2049 res += '~' + format_bytes(fdict['filesize_approx'])
c57f7757 2050 return res
91c7271a 2051
c57f7757 2052 def list_formats(self, info_dict):
94badb25 2053 formats = info_dict.get('formats', [info_dict])
b81a359e
PH
2054 table = [
2055 [f['format_id'], f['ext'], self.format_resolution(f), self._format_note(f)]
2056 for f in formats
e65566a9 2057 if f.get('preference') is None or f['preference'] >= -1000]
94badb25 2058 if len(formats) > 1:
b81a359e 2059 table[-1][-1] += (' ' if table[-1][-1] else '') + '(best)'
57dd9a8f 2060
b81a359e 2061 header_line = ['format code', 'extension', 'resolution', 'note']
cfb56d1a 2062 self.to_screen(
b81a359e
PH
2063 '[info] Available formats for %s:\n%s' %
2064 (info_dict['id'], render_table(header_line, table)))
cfb56d1a
PH
2065
2066 def list_thumbnails(self, info_dict):
2067 thumbnails = info_dict.get('thumbnails')
2068 if not thumbnails:
b7b72db9 2069 self.to_screen('[info] No thumbnails present for %s' % info_dict['id'])
2070 return
cfb56d1a
PH
2071
2072 self.to_screen(
2073 '[info] Thumbnails for %s:' % info_dict['id'])
2074 self.to_screen(render_table(
2075 ['ID', 'width', 'height', 'URL'],
2076 [[t['id'], t.get('width', 'unknown'), t.get('height', 'unknown'), t['url']] for t in thumbnails]))
dca08720 2077
360e1ca5 2078 def list_subtitles(self, video_id, subtitles, name='subtitles'):
a504ced0 2079 if not subtitles:
360e1ca5 2080 self.to_screen('%s has no %s' % (video_id, name))
a504ced0 2081 return
a504ced0 2082 self.to_screen(
edab9dbf
JMF
2083 'Available %s for %s:' % (name, video_id))
2084 self.to_screen(render_table(
2085 ['Language', 'formats'],
2086 [[lang, ', '.join(f['ext'] for f in reversed(formats))]
2087 for lang, formats in subtitles.items()]))
a504ced0 2088
dca08720
PH
2089 def urlopen(self, req):
2090 """ Start an HTTP download """
82d8a8b6 2091 if isinstance(req, compat_basestring):
67dda517 2092 req = sanitized_Request(req)
19a41fc6 2093 return self._opener.open(req, timeout=self._socket_timeout)
dca08720
PH
2094
2095 def print_debug_header(self):
2096 if not self.params.get('verbose'):
2097 return
62fec3b2 2098
4192b51c
PH
2099 if type('') is not compat_str:
2100 # Python 2.6 on SLES11 SP1 (https://github.com/rg3/youtube-dl/issues/3326)
2101 self.report_warning(
2102 'Your Python is broken! Update to a newer and supported version')
2103
c6afed48
PH
2104 stdout_encoding = getattr(
2105 sys.stdout, 'encoding', 'missing (%s)' % type(sys.stdout).__name__)
b0472057 2106 encoding_str = (
734f90bb
PH
2107 '[debug] Encodings: locale %s, fs %s, out %s, pref %s\n' % (
2108 locale.getpreferredencoding(),
2109 sys.getfilesystemencoding(),
c6afed48 2110 stdout_encoding,
b0472057 2111 self.get_encoding()))
4192b51c 2112 write_string(encoding_str, encoding=None)
734f90bb
PH
2113
2114 self._write_string('[debug] youtube-dl version ' + __version__ + '\n')
e0986e31
JMF
2115 if _LAZY_LOADER:
2116 self._write_string('[debug] Lazy loading extractors enabled' + '\n')
dca08720
PH
2117 try:
2118 sp = subprocess.Popen(
2119 ['git', 'rev-parse', '--short', 'HEAD'],
2120 stdout=subprocess.PIPE, stderr=subprocess.PIPE,
2121 cwd=os.path.dirname(os.path.abspath(__file__)))
2122 out, err = sp.communicate()
2123 out = out.decode().strip()
2124 if re.match('[0-9a-f]+', out):
734f90bb 2125 self._write_string('[debug] Git HEAD: ' + out + '\n')
70a1165b 2126 except Exception:
dca08720
PH
2127 try:
2128 sys.exc_clear()
70a1165b 2129 except Exception:
dca08720 2130 pass
d28b5171
PH
2131 self._write_string('[debug] Python version %s - %s\n' % (
2132 platform.python_version(), platform_name()))
2133
73fac4e9 2134 exe_versions = FFmpegPostProcessor.get_versions(self)
4c83c967 2135 exe_versions['rtmpdump'] = rtmpdump_version()
d28b5171
PH
2136 exe_str = ', '.join(
2137 '%s %s' % (exe, v)
2138 for exe, v in sorted(exe_versions.items())
2139 if v
2140 )
2141 if not exe_str:
2142 exe_str = 'none'
2143 self._write_string('[debug] exe versions: %s\n' % exe_str)
dca08720
PH
2144
2145 proxy_map = {}
2146 for handler in self._opener.handlers:
2147 if hasattr(handler, 'proxies'):
2148 proxy_map.update(handler.proxies)
734f90bb 2149 self._write_string('[debug] Proxy map: ' + compat_str(proxy_map) + '\n')
dca08720 2150
58b1f00d
PH
2151 if self.params.get('call_home', False):
2152 ipaddr = self.urlopen('https://yt-dl.org/ip').read().decode('utf-8')
2153 self._write_string('[debug] Public IP address: %s\n' % ipaddr)
2154 latest_version = self.urlopen(
2155 'https://yt-dl.org/latest/version').read().decode('utf-8')
2156 if version_tuple(latest_version) > version_tuple(__version__):
2157 self.report_warning(
2158 'You are using an outdated version (newest version: %s)! '
2159 'See https://yt-dl.org/update if you need help updating.' %
2160 latest_version)
2161
e344693b 2162 def _setup_opener(self):
6ad14cab 2163 timeout_val = self.params.get('socket_timeout')
19a41fc6 2164 self._socket_timeout = 600 if timeout_val is None else float(timeout_val)
6ad14cab 2165
dca08720
PH
2166 opts_cookiefile = self.params.get('cookiefile')
2167 opts_proxy = self.params.get('proxy')
2168
2169 if opts_cookiefile is None:
2170 self.cookiejar = compat_cookiejar.CookieJar()
2171 else:
3e169233 2172 opts_cookiefile = compat_expanduser(opts_cookiefile)
dca08720
PH
2173 self.cookiejar = compat_cookiejar.MozillaCookieJar(
2174 opts_cookiefile)
2175 if os.access(opts_cookiefile, os.R_OK):
2176 self.cookiejar.load()
2177
6a3f4c3f 2178 cookie_processor = YoutubeDLCookieProcessor(self.cookiejar)
dca08720
PH
2179 if opts_proxy is not None:
2180 if opts_proxy == '':
2181 proxies = {}
2182 else:
2183 proxies = {'http': opts_proxy, 'https': opts_proxy}
2184 else:
2185 proxies = compat_urllib_request.getproxies()
2186 # Set HTTPS proxy to HTTP one if given (https://github.com/rg3/youtube-dl/issues/805)
2187 if 'http' in proxies and 'https' not in proxies:
2188 proxies['https'] = proxies['http']
91410c9b 2189 proxy_handler = PerRequestProxyHandler(proxies)
a0ddb8a2
PH
2190
2191 debuglevel = 1 if self.params.get('debug_printtraffic') else 0
be4a824d
PH
2192 https_handler = make_HTTPS_handler(self.params, debuglevel=debuglevel)
2193 ydlh = YoutubeDLHandler(self.params, debuglevel=debuglevel)
8b172c2e 2194 data_handler = compat_urllib_request_DataHandler()
6240b0a2
JMF
2195
2196 # When passing our own FileHandler instance, build_opener won't add the
2197 # default FileHandler and allows us to disable the file protocol, which
2198 # can be used for malicious purposes (see
e37afbe0 2199 # https://github.com/rg3/youtube-dl/issues/8227)
6240b0a2
JMF
2200 file_handler = compat_urllib_request.FileHandler()
2201
2202 def file_open(*args, **kwargs):
30e2f2d7 2203 raise compat_urllib_error.URLError('file:// scheme is explicitly disabled in youtube-dl for security reasons')
6240b0a2
JMF
2204 file_handler.file_open = file_open
2205
2206 opener = compat_urllib_request.build_opener(
2207 proxy_handler, https_handler, cookie_processor, ydlh, data_handler, file_handler)
2461f79d 2208
dca08720
PH
2209 # Delete the default user-agent header, which would otherwise apply in
2210 # cases where our custom HTTP handler doesn't come into play
2211 # (See https://github.com/rg3/youtube-dl/issues/1309 for details)
2212 opener.addheaders = []
2213 self._opener = opener
62fec3b2
PH
2214
2215 def encode(self, s):
2216 if isinstance(s, bytes):
2217 return s # Already encoded
2218
2219 try:
2220 return s.encode(self.get_encoding())
2221 except UnicodeEncodeError as err:
2222 err.reason = err.reason + '. Check your system encoding configuration or use the --encoding option.'
2223 raise
2224
2225 def get_encoding(self):
2226 encoding = self.params.get('encoding')
2227 if encoding is None:
2228 encoding = preferredencoding()
2229 return encoding
ec82d85a
PH
2230
2231 def _write_thumbnails(self, info_dict, filename):
2232 if self.params.get('writethumbnail', False):
2233 thumbnails = info_dict.get('thumbnails')
2234 if thumbnails:
2235 thumbnails = [thumbnails[-1]]
2236 elif self.params.get('write_all_thumbnails', False):
2237 thumbnails = info_dict.get('thumbnails')
2238 else:
2239 return
2240
2241 if not thumbnails:
2242 # No thumbnails present, so return immediately
2243 return
2244
2245 for t in thumbnails:
2246 thumb_ext = determine_ext(t['url'], 'jpg')
2247 suffix = '_%s' % t['id'] if len(thumbnails) > 1 else ''
2248 thumb_display_id = '%s ' % t['id'] if len(thumbnails) > 1 else ''
82245a6d 2249 t['filename'] = thumb_filename = os.path.splitext(filename)[0] + suffix + '.' + thumb_ext
ec82d85a
PH
2250
2251 if self.params.get('nooverwrites', False) and os.path.exists(encodeFilename(thumb_filename)):
2252 self.to_screen('[%s] %s: Thumbnail %sis already present' %
2253 (info_dict['extractor'], info_dict['id'], thumb_display_id))
2254 else:
2255 self.to_screen('[%s] %s: Downloading thumbnail %s...' %
2256 (info_dict['extractor'], info_dict['id'], thumb_display_id))
2257 try:
2258 uf = self.urlopen(t['url'])
d3d89c32 2259 with open(encodeFilename(thumb_filename), 'wb') as thumbf:
ec82d85a
PH
2260 shutil.copyfileobj(uf, thumbf)
2261 self.to_screen('[%s] %s: Writing thumbnail %sto: %s' %
2262 (info_dict['extractor'], info_dict['id'], thumb_display_id, thumb_filename))
2263 except (compat_urllib_error.URLError, compat_http_client.HTTPException, socket.error) as err:
2264 self.report_warning('Unable to download thumbnail "%s": %s' %
9b9c5355 2265 (t['url'], error_to_compat_str(err)))