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