diff options
Diffstat (limited to 'yt_dlp/update.py')
| -rw-r--r-- | yt_dlp/update.py | 248 |
1 files changed, 110 insertions, 138 deletions
diff --git a/yt_dlp/update.py b/yt_dlp/update.py index 861e2495b..3de7c7209 100644 --- a/yt_dlp/update.py +++ b/yt_dlp/update.py @@ -4,27 +4,29 @@ import os import platform import subprocess import sys -import traceback from zipimport import zipimporter -from .compat import compat_realpath, functools -from .utils import Popen, encode_compat_str, write_string +from .compat import functools # isort: split +from .compat import compat_realpath +from .utils import Popen, traverse_obj, version_tuple from .version import __version__ +RELEASE_JSON_URL = 'https://api.github.com/repos/yt-dlp/yt-dlp/releases/latest' + + @functools.cache -def get_variant_and_executable_path(): +def _get_variant_and_executable_path(): """@returns (variant, executable_path)""" if hasattr(sys, 'frozen'): path = sys.executable - prefix = 'mac' if sys.platform == 'darwin' else 'win' - if getattr(sys, '_MEIPASS', None): - if sys._MEIPASS == os.path.dirname(sys.executable): - return f'{prefix}_dir', path - return f'{prefix}_exe', path - return 'py2exe', path - - path = os.path.join(os.path.dirname(__file__), '..') + 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]) == '__main__.py': @@ -33,23 +35,28 @@ def get_variant_and_executable_path(): def detect_variant(): - return get_variant_and_executable_path()[0] + return _get_variant_and_executable_path()[0] +_FILE_SUFFIXES = { + 'zip': '', + 'py2exe': '_min.exe', + 'win32_exe': '.exe', + 'darwin_exe': '_macos', +} + _NON_UPDATEABLE_REASONS = { - 'win_exe': None, - 'zip': None, - 'mac_exe': None, - 'py2exe': None, - 'win_dir': 'Auto-update is not supported for unpackaged windows executable; Re-download the latest release', - 'mac_dir': 'Auto-update is not supported for unpackaged MacOS executable; Re-download the latest release', + **{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', } def is_non_updateable(): - return _NON_UPDATEABLE_REASONS.get(detect_variant(), _NON_UPDATEABLE_REASONS['unknown']) + return _NON_UPDATEABLE_REASONS.get(detect_variant(), _NON_UPDATEABLE_REASONS['other']) def run_update(ydl): @@ -58,8 +65,6 @@ 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) @@ -74,23 +79,17 @@ def run_update(ydl): 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() - version_info = json.loads(version_info) + version_info = json.loads(ydl.urlopen(RELEASE_JSON_URL).read().decode()) except Exception: return report_network_error('obtain version info', delim='; Please try again later or') - def version_tuple(version_str): - return tuple(map(int, version_str.split('.'))) - 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): @@ -101,157 +100,130 @@ def run_update(ydl): if err: return report_error(err, True) - variant, filename = get_variant_and_executable_path() + 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': '', - 'win_exe_64': '.exe', - 'py2exe_64': '_min.exe', - 'win_exe_32': '_x86.exe', - 'mac_exe_64': '_macos', - } - - def get_bin_info(bin_or_exe, version): - label = version_labels[f'{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[f'{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() - return dict(ln.split()[::-1] for ln in hash_data.splitlines()).get(filename) - - if not os.access(filename, os.W_OK): - return report_permission_error(filename) - - if variant in ('win_exe', 'py2exe'): - directory = os.path.dirname(filename) - if not os.access(directory, os.W_OK): - return report_permission_error(directory) + 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: - if os.path.exists(filename + '.old'): - os.remove(filename + '.old') + return ydl.urlopen(url).read() except OSError: - return report_unable('remove the old version') - - try: - arch = platform.architecture()[0][:2] - url = get_bin_info(variant, arch).get('browser_download_url') - if not url: - return report_network_error('fetch updates') - urlh = ydl._opener.open(url) - newcontent = urlh.read() - urlh.close() - except OSError: - return report_network_error('download latest version') - - try: - with open(filename + '.new', 'wb') as outf: - outf.write(newcontent) - except OSError: - return report_permission_error(f'{filename}.new') - - expected_sum = get_sha256sum(variant, arch) - if not expected_sum: + 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 calc_sha256sum(filename + '.new') != expected_sum: - report_network_error('verify the new executable') - try: - os.remove(filename + '.new') - except OSError: - return report_unable('remove corrupt download') + elif hashlib.sha256(content).hexdigest() != expected: + return report_network_error('verify the new executable') + return True - try: - os.rename(filename, filename + '.old') - except OSError: - return report_unable('move current version') - try: - os.rename(filename + '.new', filename) - except OSError: - report_unable('overwrite current version') - os.rename(filename + '.old', filename) - return - try: - # Continues to run in the background - Popen( - 'ping 127.0.0.1 -n 5 -w 1000 & del /F "%s.old"' % filename, - 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_unable('delete the old version') + directory = os.path.dirname(filename) + if not os.access(filename, os.W_OK): + return report_permission_error(filename) + elif not os.access(directory, os.W_OK): + return report_permission_error(directory) - elif variant in ('zip', 'mac_exe'): - pack_type = '3' if variant == 'zip' else '64' - try: - url = get_bin_info(variant, pack_type).get('browser_download_url') - if not url: - return report_network_error('fetch updates') - urlh = ydl._opener.open(url) - newcontent = urlh.read() - urlh.close() - except OSError: - return report_network_error('download the latest 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 - expected_sum = get_sha256sum(variant, pack_type) - if not expected_sum: - ydl.report_warning('no hash information found for the release') - elif hashlib.sha256(newcontent).hexdigest() != expected_sum: - return report_network_error('verify the new package') + try: + if os.path.exists(old_filename or ''): + os.remove(old_filename) + except OSError: + return report_unable('remove the old version') - try: - with open(filename, 'wb') as outf: - outf.write(newcontent) - except OSError: - return report_unable('overwrite current 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) + + 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 - ydl.to_screen('Updated yt-dlp to version %s; Restart yt-dlp to use the new version' % version_id) + 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 - assert False, f'Unhandled variant: {variant}' + 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') # Deprecated def update_self(to_screen, verbose, opener): - - printfn = to_screen + 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(): - _opener = opener to_screen = printfn @staticmethod def report_warning(msg, *args, **kwargs): - return printfn('WARNING: %s' % msg, *args, **kwargs) + return printfn(f'WARNING: {msg}', *args, **kwargs) @staticmethod def report_error(msg, tb=None): - printfn('ERROR: %s' % msg) + printfn(f'ERROR: {msg}') if not verbose: return if tb is None: - # Copied from YoutubeDl.trouble + # 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()) + 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()) |