yt_dlp/update.py

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