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