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