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
  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 __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 _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': 'It looks like you installed yt-dlp with a package manager, pip or setup.py; Use that to update',
  68     'other': 'It looks like you are using an unofficial build of yt-dlp; Build the executable again',
  69 }
  70
  71
  72 def is_non_updateable():
  73     return _NON_UPDATEABLE_REASONS.get(detect_variant(), _NON_UPDATEABLE_REASONS['other'])
  74
  75
  76 def _sha256_file(path):
  77     h = hashlib.sha256()
  78     mv = memoryview(bytearray(128 * 1024))
  79     with open(os.path.realpath(path), 'rb', buffering=0) as f:
  80         for n in iter(lambda: f.readinto(mv), 0):
  81             h.update(mv[:n])
  82     return h.hexdigest()
  83
  84
  85 class Updater:
  86     def __init__(self, ydl):
  87         self.ydl = ydl
  88
  89     @functools.cached_property
  90     def _tag(self):
  91         identifier = f'{detect_variant()} {system_identifier()}'
  92         for line in self._download('_update_spec', 'latest').decode().splitlines():
  93             if not line.startswith('lock '):
  94                 continue
  95             _, tag, pattern = line.split(' ', 2)
  96             if re.match(pattern, identifier):
  97                 return f'tags/{tag}'
  98         return 'latest'
  99
 100     @cached_method
 101     def _get_version_info(self, tag):
 102         self.ydl.write_debug(f'Fetching release info: {API_URL}/{tag}')
 103         return json.loads(self.ydl.urlopen(f'{API_URL}/{tag}').read().decode())
 104
 105     @property
 106     def current_version(self):
 107         """Current version"""
 108         return __version__
 109
 110     @property
 111     def new_version(self):
 112         """Version of the latest release"""
 113         return self._get_version_info(self._tag)['tag_name']
 114
 115     @property
 116     def has_update(self):
 117         """Whether there is an update available"""
 118         return version_tuple(__version__) < version_tuple(self.new_version)
 119
 120     @functools.cached_property
 121     def filename(self):
 122         """Filename of the executable"""
 123         return compat_realpath(_get_variant_and_executable_path()[1])
 124
 125     def _download(self, name, tag):
 126         url = traverse_obj(self._get_version_info(tag), (
 127             'assets', lambda _, v: v['name'] == name, 'browser_download_url'), get_all=False)
 128         if not url:
 129             raise Exception('Unable to find download URL')
 130         self.ydl.write_debug(f'Downloading {name} from {url}')
 131         return self.ydl.urlopen(url).read()
 132
 133     @functools.cached_property
 134     def release_name(self):
 135         """The release filename"""
 136         label = _FILE_SUFFIXES[detect_variant()]
 137         if label and platform.architecture()[0][:2] == '32':
 138             label = f'_x86{label}'
 139         return f'yt-dlp{label}'
 140
 141     @functools.cached_property
 142     def release_hash(self):
 143         """Hash of the latest release"""
 144         hash_data = dict(ln.split()[::-1] for ln in self._download('SHA2-256SUMS', self._tag).decode().splitlines())
 145         return hash_data[self.release_name]
 146
 147     def _report_error(self, msg, expected=False):
 148         self.ydl.report_error(msg, tb=False if expected else None)
 149
 150     def _report_permission_error(self, file):
 151         self._report_error(f'Unable to write to {file}; Try running as administrator', True)
 152
 153     def _report_network_error(self, action, delim=';'):
 154         self._report_error(f'Unable to {action}{delim} Visit  https://github.com/{REPOSITORY}/releases/latest', True)
 155
 156     def check_update(self):
 157         """Report whether there is an update available"""
 158         try:
 159             self.ydl.to_screen(
 160                 f'Latest version: {self.new_version}, Current version: {self.current_version}')
 161         except Exception:
 162             return self._report_network_error('obtain version info', delim='; Please try again later or')
 163
 164         if not self.has_update:
 165             return self.ydl.to_screen(f'yt-dlp is up to date ({__version__})')
 166
 167         if not is_non_updateable():
 168             self.ydl.to_screen(f'Current Build Hash {_sha256_file(self.filename)}')
 169         return True
 170
 171     def update(self):
 172         """Update yt-dlp executable to the latest version"""
 173         if not self.check_update():
 174             return
 175         err = is_non_updateable()
 176         if err:
 177             return self._report_error(err, True)
 178         self.ydl.to_screen(f'Updating to version {self.new_version} ...')
 179
 180         directory = os.path.dirname(self.filename)
 181         if not os.access(self.filename, os.W_OK):
 182             return self._report_permission_error(self.filename)
 183         elif not os.access(directory, os.W_OK):
 184             return self._report_permission_error(directory)
 185
 186         new_filename, old_filename = f'{self.filename}.new', f'{self.filename}.old'
 187         if detect_variant() == 'zip':  # Can be replaced in-place
 188             new_filename, old_filename = self.filename, None
 189
 190         try:
 191             if os.path.exists(old_filename or ''):
 192                 os.remove(old_filename)
 193         except OSError:
 194             return self._report_error('Unable to remove the old version')
 195
 196         try:
 197             newcontent = self._download(self.release_name, self._tag)
 198         except OSError:
 199             return self._report_network_error('download latest version')
 200         except Exception:
 201             return self._report_network_error('fetch updates')
 202
 203         try:
 204             expected_hash = self.release_hash
 205         except Exception:
 206             self.ydl.report_warning('no hash information found for the release')
 207         else:
 208             if hashlib.sha256(newcontent).hexdigest() != expected_hash:
 209                 return self._report_network_error('verify the new executable')
 210
 211         try:
 212             with open(new_filename, 'wb') as outf:
 213                 outf.write(newcontent)
 214         except OSError:
 215             return self._report_permission_error(new_filename)
 216
 217         try:
 218             if old_filename:
 219                 os.rename(self.filename, old_filename)
 220         except OSError:
 221             return self._report_error('Unable to move current version')
 222         try:
 223             if old_filename:
 224                 os.rename(new_filename, self.filename)
 225         except OSError:
 226             self._report_error('Unable to overwrite current version')
 227             return os.rename(old_filename, self.filename)
 228
 229         if detect_variant() not in ('win32_exe', 'py2exe'):
 230             if old_filename:
 231                 os.remove(old_filename)
 232         else:
 233             atexit.register(Popen, f'ping 127.0.0.1 -n 5 -w 1000 & del /F "{old_filename}"',
 234                             shell=True, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
 235
 236         self.ydl.to_screen(f'Updated yt-dlp to version {self.new_version}')
 237         return True
 238
 239     @functools.cached_property
 240     def cmd(self):
 241         """The command-line to run the executable, if known"""
 242         # There is no sys.orig_argv in py < 3.10. Also, it can be [] when frozen
 243         if getattr(sys, 'orig_argv', None):
 244             return sys.orig_argv
 245         elif hasattr(sys, 'frozen'):
 246             return sys.argv
 247
 248     def restart(self):
 249         """Restart the executable"""
 250         assert self.cmd, 'Must be frozen or Py >= 3.10'
 251         self.ydl.write_debug(f'Restarting: {shell_quote(self.cmd)}')
 252         _, _, returncode = Popen.run(self.cmd)
 253         return returncode
 254
 255
 256 def run_update(ydl):
 257     """Update the program file with the latest version from the repository
 258     @returns    Whether there was a successful update (No update = False)
 259     """
 260     return Updater(ydl).update()
 261
 262
 263 # Deprecated
 264 def update_self(to_screen, verbose, opener):
 265     import traceback
 266
 267     from .utils import write_string
 268
 269     write_string(
 270         'DeprecationWarning: "yt_dlp.update.update_self" is deprecated and may be removed in a future version. '
 271         'Use "yt_dlp.update.run_update(ydl)" instead\n')
 272
 273     printfn = to_screen
 274
 275     class FakeYDL():
 276         to_screen = printfn
 277
 278         def report_warning(self, msg, *args, **kwargs):
 279             return printfn(f'WARNING: {msg}', *args, **kwargs)
 280
 281         def report_error(self, msg, tb=None):
 282             printfn(f'ERROR: {msg}')
 283             if not verbose:
 284                 return
 285             if tb is None:
 286                 # Copied from YoutubeDL.trouble
 287                 if sys.exc_info()[0]:
 288                     tb = ''
 289                     if hasattr(sys.exc_info()[1], 'exc_info') and sys.exc_info()[1].exc_info[0]:
 290                         tb += ''.join(traceback.format_exception(*sys.exc_info()[1].exc_info))
 291                     tb += traceback.format_exc()
 292                 else:
 293                     tb_data = traceback.format_list(traceback.extract_stack())
 294                     tb = ''.join(tb_data)
 295             if tb:
 296                 printfn(tb)
 297
 298         def write_debug(self, msg, *args, **kwargs):
 299             printfn(f'[debug] {msg}', *args, **kwargs)
 300
 301         def urlopen(self, url):
 302             return opener.open(url)
 303
 304     return run_update(FakeYDL())