-from __future__ import unicode_literals
-
import hashlib
import json
import os
import platform
import subprocess
import sys
-import traceback
from zipimport import zipimporter
+from .compat import functools # isort: split
from .compat import compat_realpath
-from .utils import encode_compat_str
-
+from .utils import Popen, traverse_obj, version_tuple
from .version import __version__
-''' # Not signed
-def rsa_verify(message, signature, key):
- from hashlib import sha256
- assert isinstance(message, bytes)
- byte_size = (len(bin(key[0])) - 2 + 8 - 1) // 8
- signature = ('%x' % pow(int(signature, 16), key[1], key[0])).encode()
- signature = (byte_size * 2 - len(signature)) * b'0' + signature
- asn1 = b'3031300d060960864801650304020105000420'
- asn1 += sha256(message).hexdigest().encode()
- if byte_size < len(asn1) // 2 + 11:
- return False
- expected = b'0001' + (byte_size - len(asn1) // 2 - 3) * b'ff' + b'00' + asn1
- return expected == signature
-'''
+RELEASE_JSON_URL = 'https://api.github.com/repos/yt-dlp/yt-dlp/releases/latest'
-def detect_variant():
+@functools.cache
+def _get_variant_and_executable_path():
+ """@returns (variant, executable_path)"""
if hasattr(sys, 'frozen'):
- if getattr(sys, '_MEIPASS', None):
- if sys._MEIPASS == os.path.dirname(sys.executable):
- return 'dir'
- return 'exe'
- return 'py2exe'
- elif isinstance(globals().get('__loader__'), zipimporter):
- return 'zip'
- elif os.path.basename(sys.argv[0]) == '__main__.py':
- return 'source'
- return 'unknown'
-
-
-_NON_UPDATEABLE_REASONS = {
- 'exe': None,
- 'zip': None,
- 'dir': 'Auto-update is not supported for unpackaged windows executable. Re-download the latest release',
- 'py2exe': 'There is no official release for py2exe executable. Build it again with the latest source code',
- 'source': 'You cannot update when running from source code',
- 'unknown': 'It looks like you installed yt-dlp with a package manager, pip, setup.py or a tarball. Use that to update',
-}
-
+ path = sys.executable
+ if not hasattr(sys, '_MEIPASS'):
+ return 'py2exe', path
+ if sys._MEIPASS == os.path.dirname(path):
+ return f'{sys.platform}_dir', path
+ return f'{sys.platform}_exe', path
+
+ path = os.path.dirname(__file__)
+ if isinstance(__loader__, zipimporter):
+ return 'zip', os.path.join(path, '..')
+ elif (os.path.basename(sys.argv[0]) in ('__main__.py', '-m')
+ and os.path.exists(os.path.join(path, '../.git/HEAD'))):
+ return 'source', path
+ return 'unknown', path
-def is_non_updateable():
- return _NON_UPDATEABLE_REASONS.get(detect_variant(), _NON_UPDATEABLE_REASONS['unknown'])
+def detect_variant():
+ return _get_variant_and_executable_path()[0]
-def update_self(to_screen, verbose, opener):
- ''' Exists for backward compatibility. Use run_update(ydl) instead '''
- printfn = to_screen
+_FILE_SUFFIXES = {
+ 'zip': '',
+ 'py2exe': '_min.exe',
+ 'win32_exe': '.exe',
+ 'darwin_exe': '_macos',
+}
- class FakeYDL():
- _opener = opener
- to_screen = printfn
+_NON_UPDATEABLE_REASONS = {
+ **{variant: None for variant in _FILE_SUFFIXES}, # Updatable
+ **{variant: f'Auto-update is not supported for unpackaged {name} executable; Re-download the latest release'
+ for variant, name in {'win32_dir': 'Windows', 'darwin_dir': 'MacOS'}.items()},
+ 'source': 'You cannot update when running from source code; Use git to pull the latest changes',
+ 'unknown': 'It looks like you installed yt-dlp with a package manager, pip or setup.py; Use that to update',
+ 'other': 'It looks like you are using an unofficial build of yt-dlp; Build the executable again',
+}
- @staticmethod
- def report_warning(msg, *args, **kwargs):
- return printfn('WARNING: %s' % msg, *args, **kwargs)
- @staticmethod
- def report_error(msg, tb=None):
- printfn('ERROR: %s' % msg)
- if not verbose:
- return
- if tb is None:
- # Copied from YoutubeDl.trouble
- if sys.exc_info()[0]:
- tb = ''
- if hasattr(sys.exc_info()[1], 'exc_info') and sys.exc_info()[1].exc_info[0]:
- tb += ''.join(traceback.format_exception(*sys.exc_info()[1].exc_info))
- tb += encode_compat_str(traceback.format_exc())
- else:
- tb_data = traceback.format_list(traceback.extract_stack())
- tb = ''.join(tb_data)
- if tb:
- printfn(tb)
-
- return run_update(FakeYDL())
+def is_non_updateable():
+ return _NON_UPDATEABLE_REASONS.get(detect_variant(), _NON_UPDATEABLE_REASONS['other'])
def run_update(ydl):
Returns whether the program should terminate
"""
- JSON_URL = 'https://api.github.com/repos/yt-dlp/yt-dlp/releases/latest'
+ def report_error(msg, expected=False):
+ ydl.report_error(msg, tb=False if expected else None)
- def report_error(msg, network=False, expected=False, delim=';'):
- if network:
- msg += '%s Visit https://github.com/yt-dlp/yt-dlp/releases/latest' % delim
- ydl.report_error(msg, tb='' if network or expected else None)
+ def report_unable(action, expected=False):
+ report_error(f'Unable to {action}', expected)
+
+ def report_permission_error(file):
+ report_unable(f'write to {file}; Try running as administrator', True)
+
+ def report_network_error(action, delim=';'):
+ report_unable(f'{action}{delim} Visit https://github.com/yt-dlp/yt-dlp/releases/latest', True)
def calc_sha256sum(path):
h = hashlib.sha256()
- b = bytearray(128 * 1024)
- mv = memoryview(b)
+ mv = memoryview(bytearray(128 * 1024))
with open(os.path.realpath(path), 'rb', buffering=0) as f:
for n in iter(lambda: f.readinto(mv), 0):
h.update(mv[:n])
return h.hexdigest()
- # Download and check versions info
try:
- version_info = ydl._opener.open(JSON_URL).read().decode('utf-8')
- version_info = json.loads(version_info)
+ version_info = json.loads(ydl.urlopen(RELEASE_JSON_URL).read().decode())
except Exception:
- return report_error('can\'t obtain versions info. Please try again later ', True, delim='or')
-
- def version_tuple(version_str):
- return tuple(map(int, version_str.split('.')))
+ return report_network_error('obtain version info', delim='; Please try again later or')
version_id = version_info['tag_name']
+ ydl.to_screen(f'Latest version: {version_id}, Current version: {__version__}')
if version_tuple(__version__) >= version_tuple(version_id):
ydl.to_screen(f'yt-dlp is up to date ({__version__})')
return
err = is_non_updateable()
if err:
- ydl.to_screen(f'Latest version: {version_id}, Current version: {__version__}')
- return report_error(err, expected=True)
-
- # sys.executable is set to the full pathname of the exe-file for py2exe
- # though symlinks are not followed so that we need to do this manually
- # with help of realpath
- filename = compat_realpath(sys.executable if hasattr(sys, 'frozen') else sys.argv[0])
- ydl.to_screen(f'Current version {__version__}; Build Hash {calc_sha256sum(filename)}')
+ return report_error(err, True)
+
+ variant, filename = _get_variant_and_executable_path()
+ filename = compat_realpath(filename) # Absolute path, following symlinks
+
+ label = _FILE_SUFFIXES[variant]
+ if label and platform.architecture()[0][:2] == '32':
+ label = f'_x86{label}'
+ release_name = f'yt-dlp{label}'
+
+ ydl.to_screen(f'Current Build Hash {calc_sha256sum(filename)}')
ydl.to_screen(f'Updating to version {version_id} ...')
- version_labels = {
- 'zip_3': '',
- 'exe_64': '.exe',
- 'exe_32': '_x86.exe',
- }
-
- def get_bin_info(bin_or_exe, version):
- label = version_labels['%s_%s' % (bin_or_exe, version)]
- return next((i for i in version_info['assets'] if i['name'] == 'yt-dlp%s' % label), {})
-
- def get_sha256sum(bin_or_exe, version):
- filename = 'yt-dlp%s' % version_labels['%s_%s' % (bin_or_exe, version)]
- urlh = next(
- (i for i in version_info['assets'] if i['name'] in ('SHA2-256SUMS')),
- {}).get('browser_download_url')
- if not urlh:
- return None
- hash_data = ydl._opener.open(urlh).read().decode('utf-8')
- return dict(ln.split()[::-1] for ln in hash_data.splitlines()).get(filename)
+ def get_file(name, fatal=True):
+ error = report_network_error if fatal else lambda _: None
+ url = traverse_obj(
+ version_info, ('assets', lambda _, v: v['name'] == name, 'browser_download_url'), get_all=False)
+ if not url:
+ return error('fetch updates')
+ try:
+ return ydl.urlopen(url).read()
+ except OSError:
+ return error('download latest version')
+
+ def verify(content):
+ if not content:
+ return False
+ hash_data = get_file('SHA2-256SUMS', fatal=False) or b''
+ expected = dict(ln.split()[::-1] for ln in hash_data.decode().splitlines()).get(release_name)
+ if not expected:
+ ydl.report_warning('no hash information found for the release')
+ elif hashlib.sha256(content).hexdigest() != expected:
+ return report_network_error('verify the new executable')
+ return True
+ directory = os.path.dirname(filename)
if not os.access(filename, os.W_OK):
- return report_error('no write permissions on %s' % filename, expected=True)
+ return report_permission_error(filename)
+ elif not os.access(directory, os.W_OK):
+ return report_permission_error(directory)
- # PyInstaller
- if hasattr(sys, 'frozen'):
- exe = filename
- directory = os.path.dirname(exe)
- if not os.access(directory, os.W_OK):
- return report_error('no write permissions on %s' % directory, expected=True)
- try:
- if os.path.exists(filename + '.old'):
- os.remove(filename + '.old')
- except (IOError, OSError):
- return report_error('unable to remove the old version')
+ new_filename, old_filename = f'{filename}.new', f'{filename}.old'
+ if variant == 'zip': # Can be replaced in-place
+ new_filename, old_filename = filename, None
- try:
- arch = platform.architecture()[0][:2]
- url = get_bin_info('exe', arch).get('browser_download_url')
- if not url:
- return report_error('unable to fetch updates', True)
- urlh = ydl._opener.open(url)
- newcontent = urlh.read()
- urlh.close()
- except (IOError, OSError, StopIteration):
- return report_error('unable to download latest version', True)
+ try:
+ if os.path.exists(old_filename or ''):
+ os.remove(old_filename)
+ except OSError:
+ return report_unable('remove the old version')
- try:
- with open(exe + '.new', 'wb') as outf:
- outf.write(newcontent)
- except (IOError, OSError):
- return report_error('unable to write the new version')
+ newcontent = get_file(release_name)
+ if not verify(newcontent):
+ return
+ try:
+ with open(new_filename, 'wb') as outf:
+ outf.write(newcontent)
+ except OSError:
+ return report_permission_error(new_filename)
- expected_sum = get_sha256sum('exe', arch)
- if not expected_sum:
- ydl.report_warning('no hash information found for the release')
- elif calc_sha256sum(exe + '.new') != expected_sum:
- report_error('unable to verify the new executable', True)
- try:
- os.remove(exe + '.new')
- except OSError:
- return report_error('unable to remove corrupt download')
+ try:
+ if old_filename:
+ os.rename(filename, old_filename)
+ except OSError:
+ return report_unable('move current version')
+ try:
+ if old_filename:
+ os.rename(new_filename, filename)
+ except OSError:
+ report_unable('overwrite current version')
+ os.rename(old_filename, filename)
+ return
- try:
- os.rename(exe, exe + '.old')
- except (IOError, OSError):
- return report_error('unable to move current version')
- try:
- os.rename(exe + '.new', exe)
- except (IOError, OSError):
- report_error('unable to overwrite current version')
- os.rename(exe + '.old', exe)
- return
- try:
- # Continues to run in the background
- subprocess.Popen(
- 'ping 127.0.0.1 -n 5 -w 1000 & del /F "%s.old"' % exe,
- shell=True, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
- ydl.to_screen('Updated yt-dlp to version %s' % version_id)
- return True # Exit app
- except OSError:
- report_error('unable to delete old version')
+ if variant not in ('win32_exe', 'py2exe'):
+ if old_filename:
+ os.remove(old_filename)
+ ydl.to_screen(f'Updated yt-dlp to version {version_id}; Restart yt-dlp to use the new version')
+ return
- # Zip unix package
- elif isinstance(globals().get('__loader__'), zipimporter):
- try:
- url = get_bin_info('zip', '3').get('browser_download_url')
- if not url:
- return report_error('unable to fetch updates', True)
- urlh = ydl._opener.open(url)
- newcontent = urlh.read()
- urlh.close()
- except (IOError, OSError, StopIteration):
- return report_error('unable to download latest version', True)
-
- expected_sum = get_sha256sum('zip', '3')
- if not expected_sum:
- ydl.report_warning('no hash information found for the release')
- elif hashlib.sha256(newcontent).hexdigest() != expected_sum:
- return report_error('unable to verify the new zip', True)
+ try:
+ # Continues to run in the background
+ Popen(f'ping 127.0.0.1 -n 5 -w 1000 & del /F "{old_filename}"',
+ shell=True, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
+ ydl.to_screen(f'Updated yt-dlp to version {version_id}')
+ return True # Exit app
+ except OSError:
+ report_unable('delete the old version')
- try:
- with open(filename, 'wb') as outf:
- outf.write(newcontent)
- except (IOError, OSError):
- return report_error('unable to overwrite current version')
-
- ydl.to_screen('Updated yt-dlp to version %s; Restart yt-dlp to use the new version' % version_id)
-
-
-''' # UNUSED
-def get_notes(versions, fromVersion):
- notes = []
- for v, vdata in sorted(versions.items()):
- if v > fromVersion:
- notes.extend(vdata.get('notes', []))
- return notes
-
-
-def print_notes(to_screen, versions, fromVersion=__version__):
- notes = get_notes(versions, fromVersion)
- if notes:
- to_screen('PLEASE NOTE:')
- for note in notes:
- to_screen(note)
-'''
+
+# Deprecated
+def update_self(to_screen, verbose, opener):
+ import traceback
+ from .utils import write_string
+
+ write_string(
+ 'DeprecationWarning: "yt_dlp.update.update_self" is deprecated and may be removed in a future version. '
+ 'Use "yt_dlp.update.run_update(ydl)" instead\n')
+
+ printfn = to_screen
+
+ class FakeYDL():
+ to_screen = printfn
+
+ @staticmethod
+ def report_warning(msg, *args, **kwargs):
+ return printfn(f'WARNING: {msg}', *args, **kwargs)
+
+ @staticmethod
+ def report_error(msg, tb=None):
+ printfn(f'ERROR: {msg}')
+ if not verbose:
+ return
+ if tb is None:
+ # Copied from YoutubeDL.trouble
+ if sys.exc_info()[0]:
+ tb = ''
+ if hasattr(sys.exc_info()[1], 'exc_info') and sys.exc_info()[1].exc_info[0]:
+ tb += ''.join(traceback.format_exception(*sys.exc_info()[1].exc_info))
+ tb += traceback.format_exc()
+ else:
+ tb_data = traceback.format_list(traceback.extract_stack())
+ tb = ''.join(tb_data)
+ if tb:
+ printfn(tb)
+
+ def urlopen(self, url):
+ return opener.open(url)
+
+ return run_update(FakeYDL())
projects / yt-dlp.git / blobdiff