yt_dlp/update.py

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