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