-from __future__ import unicode_literals
-
-import io
-import json
-import traceback
+import atexit
+import contextlib
import hashlib
+import json
import os
import platform
+import re
import subprocess
import sys
from zipimport import zipimporter
-from .compat import compat_realpath
-from .utils import encode_compat_str
-
-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
-'''
-
-
-def update_self(to_screen, verbose, opener):
- """
- Update the program file with the latest version from the repository
- Returns whether the program should terminate
- """
-
- JSON_URL = 'https://api.github.com/repos/yt-dlp/yt-dlp/releases/latest'
-
- def calc_sha256sum(path):
- h = hashlib.sha256()
- b = bytearray(128 * 1024)
- mv = memoryview(b)
- 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()
-
- if not isinstance(globals().get('__loader__'), zipimporter) and not hasattr(sys, 'frozen'):
- to_screen('It looks like you installed yt-dlp with a package manager, pip, setup.py or a tarball. Please use that to update.')
- return
-
- # 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])
- to_screen('Current Build Hash %s' % calc_sha256sum(filename))
-
- # Download and check versions info
- try:
- version_info = opener.open(JSON_URL).read().decode('utf-8')
- version_info = json.loads(version_info)
- except Exception:
- if verbose:
- to_screen(encode_compat_str(traceback.format_exc()))
- to_screen('ERROR: can\'t obtain versions info. Please try again later.')
- to_screen('Visit https://github.com/yt-dlp/yt-dlp/releases/latest')
+from .compat import functools # isort: split
+from .compat import compat_realpath, compat_shlex_quote
+from .utils import (
+ Popen,
+ cached_method,
+ deprecation_warning,
+ remove_end,
+ shell_quote,
+ system_identifier,
+ traverse_obj,
+ version_tuple,
+)
+from .version import UPDATE_HINT, VARIANT, __version__
+
+REPOSITORY = 'yt-dlp/yt-dlp'
+API_URL = f'https://api.github.com/repos/{REPOSITORY}/releases'
+
+
+@functools.cache
+def _get_variant_and_executable_path():
+ """@returns (variant, executable_path)"""
+ if getattr(sys, 'frozen', False):
+ path = sys.executable
+ if not hasattr(sys, '_MEIPASS'):
+ return 'py2exe', path
+ elif sys._MEIPASS == os.path.dirname(path):
+ return f'{sys.platform}_dir', path
+ elif sys.platform == 'darwin':
+ machine = '_legacy' if version_tuple(platform.mac_ver()[0]) < (10, 15) else ''
+ else:
+ machine = f'_{platform.machine().lower()}'
+ # Ref: https://en.wikipedia.org/wiki/Uname#Examples
+ if machine[1:] in ('x86', 'x86_64', 'amd64', 'i386', 'i686'):
+ machine = '_x86' if platform.architecture()[0][:2] == '32' else ''
+ return f'{remove_end(sys.platform, "32")}{machine}_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 detect_variant():
+ return VARIANT or _get_variant_and_executable_path()[0]
+
+
+@functools.cache
+def current_git_head():
+ if detect_variant() != 'source':
return
+ with contextlib.suppress(Exception):
+ stdout, _, _ = Popen.run(
+ ['git', 'rev-parse', '--short', 'HEAD'],
+ text=True, cwd=os.path.dirname(os.path.abspath(__file__)),
+ stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+ if re.fullmatch('[0-9a-f]+', stdout.strip()):
+ return stdout.strip()
+
+
+_FILE_SUFFIXES = {
+ 'zip': '',
+ 'py2exe': '_min.exe',
+ 'win_exe': '.exe',
+ 'win_x86_exe': '_x86.exe',
+ 'darwin_exe': '_macos',
+ 'darwin_legacy_exe': '_macos_legacy',
+ 'linux_exe': '_linux',
+ 'linux_aarch64_exe': '_linux_aarch64',
+ 'linux_armv7l_exe': '_linux_armv7l',
+}
+
+_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', 'linux_dir': 'Linux'}.items()},
+ 'source': 'You cannot update when running from source code; Use git to pull the latest changes',
+ 'unknown': 'You installed yt-dlp with a package manager or setup.py; Use that to update',
+ 'other': 'You are using an unofficial build of yt-dlp; Build the executable again',
+}
+
+
+def is_non_updateable():
+ if UPDATE_HINT:
+ return UPDATE_HINT
+ return _NON_UPDATEABLE_REASONS.get(
+ detect_variant(), _NON_UPDATEABLE_REASONS['unknown' if VARIANT else 'other'])
+
+
+def _sha256_file(path):
+ h = hashlib.sha256()
+ 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()
+
+
+class Updater:
+ def __init__(self, ydl):
+ self.ydl = ydl
+
+ @functools.cached_property
+ def _tag(self):
+ if version_tuple(__version__) >= version_tuple(self.latest_version):
+ return 'latest'
+
+ identifier = f'{detect_variant()} {system_identifier()}'
+ for line in self._download('_update_spec', 'latest').decode().splitlines():
+ if not line.startswith('lock '):
+ continue
+ _, tag, pattern = line.split(' ', 2)
+ if re.match(pattern, identifier):
+ return f'tags/{tag}'
+ return 'latest'
+
+ @cached_method
+ def _get_version_info(self, tag):
+ self.ydl.write_debug(f'Fetching release info: {API_URL}/{tag}')
+ return json.loads(self.ydl.urlopen(f'{API_URL}/{tag}').read().decode())
+
+ @property
+ def current_version(self):
+ """Current version"""
+ return __version__
+
+ @property
+ def new_version(self):
+ """Version of the latest release we can update to"""
+ if self._tag.startswith('tags/'):
+ return self._tag[5:]
+ return self._get_version_info(self._tag)['tag_name']
+
+ @property
+ def latest_version(self):
+ """Version of the latest release"""
+ return self._get_version_info('latest')['tag_name']
+
+ @property
+ def has_update(self):
+ """Whether there is an update available"""
+ return version_tuple(__version__) < version_tuple(self.new_version)
+
+ @functools.cached_property
+ def filename(self):
+ """Filename of the executable"""
+ return compat_realpath(_get_variant_and_executable_path()[1])
+
+ def _download(self, name, tag):
+ url = traverse_obj(self._get_version_info(tag), (
+ 'assets', lambda _, v: v['name'] == name, 'browser_download_url'), get_all=False)
+ if not url:
+ raise Exception('Unable to find download URL')
+ self.ydl.write_debug(f'Downloading {name} from {url}')
+ return self.ydl.urlopen(url).read()
+
+ @functools.cached_property
+ def release_name(self):
+ """The release filename"""
+ return f'yt-dlp{_FILE_SUFFIXES[detect_variant()]}'
+
+ @functools.cached_property
+ def release_hash(self):
+ """Hash of the latest release"""
+ hash_data = dict(ln.split()[::-1] for ln in self._download('SHA2-256SUMS', self._tag).decode().splitlines())
+ return hash_data[self.release_name]
+
+ def _report_error(self, msg, expected=False):
+ self.ydl.report_error(msg, tb=False if expected else None)
+ self.ydl._download_retcode = 100
+
+ def _report_permission_error(self, file):
+ self._report_error(f'Unable to write to {file}; Try running as administrator', True)
+
+ def _report_network_error(self, action, delim=';'):
+ self._report_error(f'Unable to {action}{delim} Visit https://github.com/{REPOSITORY}/releases/latest', True)
+
+ def check_update(self):
+ """Report whether there is an update available"""
+ try:
+ self.ydl.to_screen(
+ f'Latest version: {self.latest_version}, Current version: {self.current_version}')
+ if not self.has_update:
+ if self._tag == 'latest':
+ return self.ydl.to_screen(f'yt-dlp is up to date ({__version__})')
+ return self.ydl.report_warning(
+ 'yt-dlp cannot be updated any further since you are on an older Python version')
+ except Exception:
+ return self._report_network_error('obtain version info', delim='; Please try again later or')
+
+ if not is_non_updateable():
+ self.ydl.to_screen(f'Current Build Hash {_sha256_file(self.filename)}')
+ return True
+
+ def update(self):
+ """Update yt-dlp executable to the latest version"""
+ if not self.check_update():
+ return
+ err = is_non_updateable()
+ if err:
+ return self._report_error(err, True)
+ self.ydl.to_screen(f'Updating to version {self.new_version} ...')
- def version_tuple(version_str):
- return tuple(map(int, version_str.split('.')))
+ directory = os.path.dirname(self.filename)
+ if not os.access(self.filename, os.W_OK):
+ return self._report_permission_error(self.filename)
+ elif not os.access(directory, os.W_OK):
+ return self._report_permission_error(directory)
- version_id = version_info['tag_name']
- if version_tuple(__version__) >= version_tuple(version_id):
- to_screen('yt-dlp is up to date (%s)' % __version__)
- return
+ new_filename, old_filename = f'{self.filename}.new', f'{self.filename}.old'
+ if detect_variant() == 'zip': # Can be replaced in-place
+ new_filename, old_filename = self.filename, None
- to_screen('Updating to version ' + version_id + ' ...')
-
- version_labels = {
- 'zip_3': '',
- 'zip_2': '',
- # 'zip_2': '_py2',
- '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):
- label = 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 = opener.open(urlh).read().decode('utf-8')
- hashes = list(map(lambda x: x.split(':'), hash_data.splitlines()))
- return next(
- (i[1] for i in hashes if i[0] == 'yt-dlp%s' % label),
- None)
-
- if not os.access(filename, os.W_OK):
- to_screen('ERROR: no write permissions on %s' % filename)
- return
+ try:
+ if os.path.exists(old_filename or ''):
+ os.remove(old_filename)
+ except OSError:
+ return self._report_error('Unable to remove the old version')
- # PyInstaller
- if hasattr(sys, 'frozen'):
- exe = filename
- directory = os.path.dirname(exe)
- if not os.access(directory, os.W_OK):
- to_screen('ERROR: no write permissions on %s' % directory)
- return
+ try:
+ newcontent = self._download(self.release_name, self._tag)
+ except OSError:
+ return self._report_network_error('download latest version')
+ except Exception:
+ return self._report_network_error('fetch updates')
try:
- arch = platform.architecture()[0][:2]
- url = get_bin_info('exe', arch).get('browser_download_url')
- if not url:
- to_screen('ERROR: unable to fetch updates')
- to_screen('Visit https://github.com/yt-dlp/yt-dlp/releases/latest')
- return
- urlh = opener.open(url)
- newcontent = urlh.read()
- urlh.close()
- except (IOError, OSError, StopIteration):
- if verbose:
- to_screen(encode_compat_str(traceback.format_exc()))
- to_screen('ERROR: unable to download latest version')
- to_screen('Visit https://github.com/yt-dlp/yt-dlp/releases/latest')
- return
+ expected_hash = self.release_hash
+ except Exception:
+ self.ydl.report_warning('no hash information found for the release')
+ else:
+ if hashlib.sha256(newcontent).hexdigest() != expected_hash:
+ return self._report_network_error('verify the new executable')
try:
- with open(exe + '.new', 'wb') as outf:
+ with open(new_filename, 'wb') as outf:
outf.write(newcontent)
- except (IOError, OSError):
- if verbose:
- to_screen(encode_compat_str(traceback.format_exc()))
- to_screen('ERROR: unable to write the new version')
- return
+ except OSError:
+ return self._report_permission_error(new_filename)
- expected_sum = get_sha256sum('exe', arch)
- if not expected_sum:
- to_screen('WARNING: no hash information found for the release')
- elif calc_sha256sum(exe + '.new') != expected_sum:
- to_screen('ERROR: unable to verify the new executable')
- to_screen('Visit https://github.com/yt-dlp/yt-dlp/releases/latest')
+ if old_filename:
+ mask = os.stat(self.filename).st_mode
try:
- os.remove(exe + '.new')
+ os.rename(self.filename, old_filename)
except OSError:
- to_screen('ERROR: unable to remove corrupt download')
- return
+ return self._report_error('Unable to move current version')
- try:
- bat = os.path.join(directory, 'yt-dlp-updater.cmd')
- with io.open(bat, 'w') as batfile:
- batfile.write('''
-@(
- echo.Waiting for file handle to be closed ...
- ping 127.0.0.1 -n 5 -w 1000 > NUL
- move /Y "%s.new" "%s" > NUL
- echo.Updated yt-dlp to version %s.
-)
-@start /b "" cmd /c del "%%~f0"&exit /b
- ''' % (exe, exe, version_id))
-
- subprocess.Popen([bat]) # Continues to run in the background
- return True # Exit app
- except (IOError, OSError):
- if verbose:
- to_screen(encode_compat_str(traceback.format_exc()))
- to_screen('ERROR: unable to overwrite current version')
- return
+ try:
+ os.rename(new_filename, self.filename)
+ except OSError:
+ self._report_error('Unable to overwrite current version')
+ return os.rename(old_filename, self.filename)
- # Zip unix package
- elif isinstance(globals().get('__loader__'), zipimporter):
- try:
- py_ver = platform.python_version()[0]
- url = get_bin_info('zip', py_ver).get('browser_download_url')
- if not url:
- to_screen('ERROR: unable to fetch updates')
- to_screen('Visit https://github.com/yt-dlp/yt-dlp/releases/latest')
- return
- urlh = opener.open(url)
- newcontent = urlh.read()
- urlh.close()
- except (IOError, OSError, StopIteration):
- if verbose:
- to_screen(encode_compat_str(traceback.format_exc()))
- to_screen('ERROR: unable to download latest version')
- to_screen('Visit https://github.com/yt-dlp/yt-dlp/releases/latest')
- return
+ if detect_variant() in ('win32_exe', 'py2exe'):
+ atexit.register(Popen, f'ping 127.0.0.1 -n 5 -w 1000 & del /F "{old_filename}"',
+ shell=True, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
+ elif old_filename:
+ try:
+ os.remove(old_filename)
+ except OSError:
+ self._report_error('Unable to remove the old version')
- expected_sum = get_sha256sum('zip', py_ver)
- if expected_sum and hashlib.sha256(newcontent).hexdigest() != expected_sum:
- to_screen('ERROR: unable to verify the new zip')
- to_screen('Visit https://github.com/yt-dlp/yt-dlp/releases/latest')
- return
+ try:
+ os.chmod(self.filename, mask)
+ except OSError:
+ return self._report_error(
+ f'Unable to set permissions. Run: sudo chmod a+rx {compat_shlex_quote(self.filename)}')
+
+ self.ydl.to_screen(f'Updated yt-dlp to version {self.new_version}')
+ return True
+
+ @functools.cached_property
+ def cmd(self):
+ """The command-line to run the executable, if known"""
+ # There is no sys.orig_argv in py < 3.10. Also, it can be [] when frozen
+ if getattr(sys, 'orig_argv', None):
+ return sys.orig_argv
+ elif getattr(sys, 'frozen', False):
+ return sys.argv
+
+ def restart(self):
+ """Restart the executable"""
+ assert self.cmd, 'Must be frozen or Py >= 3.10'
+ self.ydl.write_debug(f'Restarting: {shell_quote(self.cmd)}')
+ _, _, returncode = Popen.run(self.cmd)
+ return returncode
+
+
+def run_update(ydl):
+ """Update the program file with the latest version from the repository
+ @returns Whether there was a successful update (No update = False)
+ """
+ return Updater(ydl).update()
- try:
- with open(filename, 'wb') as outf:
- outf.write(newcontent)
- except (IOError, OSError):
- if verbose:
- to_screen(encode_compat_str(traceback.format_exc()))
- to_screen('ERROR: unable to overwrite current version')
- return
- to_screen('Updated yt-dlp. Restart yt-dlp to use the new version.')
+# Deprecated
+def update_self(to_screen, verbose, opener):
+ import traceback
+
+ deprecation_warning(f'"{__name__}.update_self" is deprecated and may be removed '
+ f'in a future version. Use "{__name__}.run_update(ydl)" instead')
+ printfn = to_screen
-''' # UNUSED
-def get_notes(versions, fromVersion):
- notes = []
- for v, vdata in sorted(versions.items()):
- if v > fromVersion:
- notes.extend(vdata.get('notes', []))
- return notes
+ class FakeYDL():
+ to_screen = printfn
+ def report_warning(self, msg, *args, **kwargs):
+ return printfn(f'WARNING: {msg}', *args, **kwargs)
-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)
-'''
+ def report_error(self, 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 write_debug(self, msg, *args, **kwargs):
+ printfn(f'[debug] {msg}', *args, **kwargs)
+
+ def urlopen(self, url):
+ return opener.open(url)
+
+ return run_update(FakeYDL())
projects / yt-dlp.git / blobdiff