yt_dlp/update.py

   1 import atexit
   2 import contextlib
   3 import hashlib
   4 import json
   5 import os
   6 import platform
   7 import re
   8 import subprocess
   9 import sys
  10 from zipimport import zipimporter
  11
  12 from .compat import functools  # isort: split
  13 from .compat import compat_realpath, compat_shlex_quote
  14 from .utils import (
  15     Popen,
  16     cached_method,
  17     deprecation_warning,
  18     shell_quote,
  19     system_identifier,
  20     traverse_obj,
  21     version_tuple,
  22 )
  23 from .version import UPDATE_HINT, VARIANT, __version__
  24
  25 REPOSITORY = 'yt-dlp/yt-dlp'
  26 API_URL = f'https://api.github.com/repos/{REPOSITORY}/releases'
  27
  28
  29 @functools.cache
  30 def _get_variant_and_executable_path():
  31     """@returns (variant, executable_path)"""
  32     if hasattr(sys, 'frozen'):
  33         path = sys.executable
  34         if not hasattr(sys, '_MEIPASS'):
  35             return 'py2exe', path
  36         if sys._MEIPASS == os.path.dirname(path):
  37             return f'{sys.platform}_dir', path
  38         if sys.platform == 'darwin' and version_tuple(platform.mac_ver()[0]) < (10, 15):
  39             return 'darwin_legacy_exe', path
  40         return f'{sys.platform}_exe', path
  41
  42     path = os.path.dirname(__file__)
  43     if isinstance(__loader__, zipimporter):
  44         return 'zip', os.path.join(path, '..')
  45     elif (os.path.basename(sys.argv[0]) in ('__main__.py', '-m')
  46           and os.path.exists(os.path.join(path, '../.git/HEAD'))):
  47         return 'source', path
  48     return 'unknown', path
  49
  50
  51 def detect_variant():
  52     return VARIANT or _get_variant_and_executable_path()[0]
  53
  54
  55 @functools.cache
  56 def current_git_head():
  57     if detect_variant() != 'source':
  58         return
  59     with contextlib.suppress(Exception):
  60         stdout, _, _ = Popen.run(
  61             ['git', 'rev-parse', '--short', 'HEAD'],
  62             text=True, cwd=os.path.dirname(os.path.abspath(__file__)),
  63             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
  64         if re.fullmatch('[0-9a-f]+', stdout.strip()):
  65             return stdout.strip()
  66
  67
  68 _FILE_SUFFIXES = {
  69     'zip': '',
  70     'py2exe': '_min.exe',
  71     'win32_exe': '.exe',
  72     'darwin_exe': '_macos',
  73     'darwin_legacy_exe': '_macos_legacy',
  74     'linux_exe': '_linux',
  75 }
  76
  77 _NON_UPDATEABLE_REASONS = {
  78     **{variant: None for variant in _FILE_SUFFIXES},  # Updatable
  79     **{variant: f'Auto-update is not supported for unpackaged {name} executable; Re-download the latest release'
  80        for variant, name in {'win32_dir': 'Windows', 'darwin_dir': 'MacOS', 'linux_dir': 'Linux'}.items()},
  81     'source': 'You cannot update when running from source code; Use git to pull the latest changes',
  82     'unknown': 'You installed yt-dlp with a package manager or setup.py; Use that to update',
  83     'other': 'You are using an unofficial build of yt-dlp; Build the executable again',
  84 }
  85
  86
  87 def is_non_updateable():
  88     if UPDATE_HINT:
  89         return UPDATE_HINT
  90     return _NON_UPDATEABLE_REASONS.get(
  91         detect_variant(), _NON_UPDATEABLE_REASONS['unknown' if VARIANT else 'other'])
  92
  93
  94 def _sha256_file(path):
  95     h = hashlib.sha256()
  96     mv = memoryview(bytearray(128 * 1024))
  97     with open(os.path.realpath(path), 'rb', buffering=0) as f:
  98         for n in iter(lambda: f.readinto(mv), 0):
  99             h.update(mv[:n])
 100     return h.hexdigest()
 101
 102
 103 class Updater:
 104     def __init__(self, ydl):
 105         self.ydl = ydl
 106
 107     @functools.cached_property
 108     def _tag(self):
 109         if version_tuple(__version__) >= version_tuple(self.latest_version):
 110             return 'latest'
 111
 112         identifier = f'{detect_variant()} {system_identifier()}'
 113         for line in self._download('_update_spec', 'latest').decode().splitlines():
 114             if not line.startswith('lock '):
 115                 continue
 116             _, tag, pattern = line.split(' ', 2)
 117             if re.match(pattern, identifier):
 118                 return f'tags/{tag}'
 119         return 'latest'
 120
 121     @cached_method
 122     def _get_version_info(self, tag):
 123         self.ydl.write_debug(f'Fetching release info: {API_URL}/{tag}')
 124         return json.loads(self.ydl.urlopen(f'{API_URL}/{tag}').read().decode())
 125
 126     @property
 127     def current_version(self):
 128         """Current version"""
 129         return __version__
 130
 131     @property
 132     def new_version(self):
 133         """Version of the latest release we can update to"""
 134         if self._tag.startswith('tags/'):
 135             return self._tag[5:]
 136         return self._get_version_info(self._tag)['tag_name']
 137
 138     @property
 139     def latest_version(self):
 140         """Version of the latest release"""
 141         return self._get_version_info('latest')['tag_name']
 142
 143     @property
 144     def has_update(self):
 145         """Whether there is an update available"""
 146         return version_tuple(__version__) < version_tuple(self.new_version)
 147
 148     @functools.cached_property
 149     def filename(self):
 150         """Filename of the executable"""
 151         return compat_realpath(_get_variant_and_executable_path()[1])
 152
 153     def _download(self, name, tag):
 154         url = traverse_obj(self._get_version_info(tag), (
 155             'assets', lambda _, v: v['name'] == name, 'browser_download_url'), get_all=False)
 156         if not url:
 157             raise Exception('Unable to find download URL')
 158         self.ydl.write_debug(f'Downloading {name} from {url}')
 159         return self.ydl.urlopen(url).read()
 160
 161     @functools.cached_property
 162     def release_name(self):
 163         """The release filename"""
 164         label = _FILE_SUFFIXES[detect_variant()]
 165         if label and platform.architecture()[0][:2] == '32':
 166             label = f'_x86{label}'
 167         return f'yt-dlp{label}'
 168
 169     @functools.cached_property
 170     def release_hash(self):
 171         """Hash of the latest release"""
 172         hash_data = dict(ln.split()[::-1] for ln in self._download('SHA2-256SUMS', self._tag).decode().splitlines())
 173         return hash_data[self.release_name]
 174
 175     def _report_error(self, msg, expected=False):
 176         self.ydl.report_error(msg, tb=False if expected else None)
 177         self.ydl._download_retcode = 100
 178
 179     def _report_permission_error(self, file):
 180         self._report_error(f'Unable to write to {file}; Try running as administrator', True)
 181
 182     def _report_network_error(self, action, delim=';'):
 183         self._report_error(f'Unable to {action}{delim} Visit  https://github.com/{REPOSITORY}/releases/latest', True)
 184
 185     def check_update(self):
 186         """Report whether there is an update available"""
 187         try:
 188             self.ydl.to_screen(
 189                 f'Latest version: {self.latest_version}, Current version: {self.current_version}')
 190             if not self.has_update:
 191                 if self._tag == 'latest':
 192                     return self.ydl.to_screen(f'yt-dlp is up to date ({__version__})')
 193                 return self.ydl.report_warning(
 194                     'yt-dlp cannot be updated any further since you are on an older Python version')
 195         except Exception:
 196             return self._report_network_error('obtain version info', delim='; Please try again later or')
 197
 198         if not is_non_updateable():
 199             self.ydl.to_screen(f'Current Build Hash {_sha256_file(self.filename)}')
 200         return True
 201
 202     def update(self):
 203         """Update yt-dlp executable to the latest version"""
 204         if not self.check_update():
 205             return
 206         err = is_non_updateable()
 207         if err:
 208             return self._report_error(err, True)
 209         self.ydl.to_screen(f'Updating to version {self.new_version} ...')
 210
 211         directory = os.path.dirname(self.filename)
 212         if not os.access(self.filename, os.W_OK):
 213             return self._report_permission_error(self.filename)
 214         elif not os.access(directory, os.W_OK):
 215             return self._report_permission_error(directory)
 216
 217         new_filename, old_filename = f'{self.filename}.new', f'{self.filename}.old'
 218         if detect_variant() == 'zip':  # Can be replaced in-place
 219             new_filename, old_filename = self.filename, None
 220
 221         try:
 222             if os.path.exists(old_filename or ''):
 223                 os.remove(old_filename)
 224         except OSError:
 225             return self._report_error('Unable to remove the old version')
 226
 227         try:
 228             newcontent = self._download(self.release_name, self._tag)
 229         except OSError:
 230             return self._report_network_error('download latest version')
 231         except Exception:
 232             return self._report_network_error('fetch updates')
 233
 234         try:
 235             expected_hash = self.release_hash
 236         except Exception:
 237             self.ydl.report_warning('no hash information found for the release')
 238         else:
 239             if hashlib.sha256(newcontent).hexdigest() != expected_hash:
 240                 return self._report_network_error('verify the new executable')
 241
 242         try:
 243             with open(new_filename, 'wb') as outf:
 244                 outf.write(newcontent)
 245         except OSError:
 246             return self._report_permission_error(new_filename)
 247
 248         if old_filename:
 249             mask = os.stat(self.filename).st_mode
 250             try:
 251                 os.rename(self.filename, old_filename)
 252             except OSError:
 253                 return self._report_error('Unable to move current version')
 254
 255             try:
 256                 os.rename(new_filename, self.filename)
 257             except OSError:
 258                 self._report_error('Unable to overwrite current version')
 259                 return os.rename(old_filename, self.filename)
 260
 261         if detect_variant() in ('win32_exe', 'py2exe'):
 262             atexit.register(Popen, f'ping 127.0.0.1 -n 5 -w 1000 & del /F "{old_filename}"',
 263                             shell=True, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
 264         elif old_filename:
 265             try:
 266                 os.remove(old_filename)
 267             except OSError:
 268                 self._report_error('Unable to remove the old version')
 269
 270             try:
 271                 os.chmod(self.filename, mask)
 272             except OSError:
 273                 return self._report_error(
 274                     f'Unable to set permissions. Run: sudo chmod a+rx {compat_shlex_quote(self.filename)}')
 275
 276         self.ydl.to_screen(f'Updated yt-dlp to version {self.new_version}')
 277         return True
 278
 279     @functools.cached_property
 280     def cmd(self):
 281         """The command-line to run the executable, if known"""
 282         # There is no sys.orig_argv in py < 3.10. Also, it can be [] when frozen
 283         if getattr(sys, 'orig_argv', None):
 284             return sys.orig_argv
 285         elif hasattr(sys, 'frozen'):
 286             return sys.argv
 287
 288     def restart(self):
 289         """Restart the executable"""
 290         assert self.cmd, 'Must be frozen or Py >= 3.10'
 291         self.ydl.write_debug(f'Restarting: {shell_quote(self.cmd)}')
 292         _, _, returncode = Popen.run(self.cmd)
 293         return returncode
 294
 295
 296 def run_update(ydl):
 297     """Update the program file with the latest version from the repository
 298     @returns    Whether there was a successful update (No update = False)
 299     """
 300     return Updater(ydl).update()
 301
 302
 303 # Deprecated
 304 def update_self(to_screen, verbose, opener):
 305     import traceback
 306
 307     deprecation_warning(f'"{__name__}.update_self" is deprecated and may be removed '
 308                         f'in a future version. Use "{__name__}.run_update(ydl)" instead')
 309
 310     printfn = to_screen
 311
 312     class FakeYDL():
 313         to_screen = printfn
 314
 315         def report_warning(self, msg, *args, **kwargs):
 316             return printfn(f'WARNING: {msg}', *args, **kwargs)
 317
 318         def report_error(self, msg, tb=None):
 319             printfn(f'ERROR: {msg}')
 320             if not verbose:
 321                 return
 322             if tb is None:
 323                 # Copied from YoutubeDL.trouble
 324                 if sys.exc_info()[0]:
 325                     tb = ''
 326                     if hasattr(sys.exc_info()[1], 'exc_info') and sys.exc_info()[1].exc_info[0]:
 327                         tb += ''.join(traceback.format_exception(*sys.exc_info()[1].exc_info))
 328                     tb += traceback.format_exc()
 329                 else:
 330                     tb_data = traceback.format_list(traceback.extract_stack())
 331                     tb = ''.join(tb_data)
 332             if tb:
 333                 printfn(tb)
 334
 335         def write_debug(self, msg, *args, **kwargs):
 336             printfn(f'[debug] {msg}', *args, **kwargs)
 337
 338         def urlopen(self, url):
 339             return opener.open(url)
 340
 341     return run_update(FakeYDL())