]> jfr.im git - yt-dlp.git/blobdiff - yt_dlp/update.py
[MainStreaming] Add extractor (#2180)
[yt-dlp.git] / yt_dlp / update.py
index c49c78d4b28606f1e6c232273fe26f8730a540a8..f3448568a51fce261b2a7ddce58f7ed655fc1cf8 100644 (file)
@@ -10,7 +10,7 @@
 from zipimport import zipimporter
 
 from .compat import compat_realpath
-from .utils import encode_compat_str
+from .utils import encode_compat_str, Popen, write_string
 
 from .version import __version__
 
@@ -31,38 +31,35 @@ def rsa_verify(message, signature, key):
 '''
 
 
-def update_self(to_screen, verbose, opener):
-    ''' Exists for backward compatibility. Use run_update(ydl) instead '''
+def detect_variant():
+    if hasattr(sys, 'frozen'):
+        prefix = 'mac' if sys.platform == 'darwin' else 'win'
+        if getattr(sys, '_MEIPASS', None):
+            if sys._MEIPASS == os.path.dirname(sys.executable):
+                return f'{prefix}_dir'
+            return f'{prefix}_exe'
+        return 'py2exe'
+    elif isinstance(globals().get('__loader__'), zipimporter):
+        return 'zip'
+    elif os.path.basename(sys.argv[0]) == '__main__.py':
+        return 'source'
+    return 'unknown'
 
-    printfn = to_screen
 
-    class FakeYDL():
-        _opener = opener
-        to_screen = printfn
+_NON_UPDATEABLE_REASONS = {
+    'win_exe': None,
+    'zip': None,
+    'mac_exe': None,
+    'py2exe': None,
+    'win_dir': 'Auto-update is not supported for unpackaged windows executable; Re-download the latest release',
+    'mac_dir': 'Auto-update is not supported for unpackaged MacOS executable; Re-download the latest release',
+    'source': 'You cannot update when running from source code; Use git to pull the latest changes',
+    'unknown': 'It looks like you installed yt-dlp with a package manager, pip, setup.py or a tarball; Use that to update',
+}
 
-        @staticmethod
-        def report_warning(msg, *args, **kwargs):
-            return printfn('WARNING: %s' % msg, *args, **kwargs)
 
-        @staticmethod
-        def report_error(msg, tb=None):
-            printfn('ERROR: %s' % msg)
-            if not verbose:
-                return
-            if tb is None:
-                # Copied from YoutubeDl.trouble
-                if sys.exc_info()[0]:
-                    tb = ''
-                    if hasattr(sys.exc_info()[1], 'exc_info') and sys.exc_info()[1].exc_info[0]:
-                        tb += ''.join(traceback.format_exception(*sys.exc_info()[1].exc_info))
-                    tb += encode_compat_str(traceback.format_exc())
-                else:
-                    tb_data = traceback.format_list(traceback.extract_stack())
-                    tb = ''.join(tb_data)
-            if tb:
-                printfn(tb)
-
-    return run_update(FakeYDL())
+def is_non_updateable():
+    return _NON_UPDATEABLE_REASONS.get(detect_variant(), _NON_UPDATEABLE_REASONS['unknown'])
 
 
 def run_update(ydl):
@@ -73,10 +70,17 @@ def run_update(ydl):
 
     JSON_URL = 'https://api.github.com/repos/yt-dlp/yt-dlp/releases/latest'
 
-    def report_error(msg, network=False, expected=False, delim=';'):
-        if network:
-            msg += '%s Visit  https://github.com/yt-dlp/yt-dlp/releases/latest' % delim
-        ydl.report_error(msg, tb='' if network or expected else None)
+    def report_error(msg, expected=False):
+        ydl.report_error(msg, tb='' if expected else None)
+
+    def report_unable(action, expected=False):
+        report_error(f'Unable to {action}', expected)
+
+    def report_permission_error(file):
+        report_unable(f'write to {file}; Try running as administrator', True)
+
+    def report_network_error(action, delim=';'):
+        report_unable(f'{action}{delim} Visit  https://github.com/yt-dlp/yt-dlp/releases/latest', True)
 
     def calc_sha256sum(path):
         h = hashlib.sha256()
@@ -87,47 +91,39 @@ def calc_sha256sum(path):
                 h.update(mv[:n])
         return h.hexdigest()
 
-    err = None
-    if isinstance(globals().get('__loader__'), zipimporter):
-        # We only support python 3.6 or above
-        if sys.version_info < (3, 6):
-            err = 'This is the last release of yt-dlp for Python version %d.%d! Please update to Python 3.6 or above' % sys.version_info[:2]
-    elif hasattr(sys, 'frozen'):
-        # Python 3.6 supports only vista and above
-        if sys.getwindowsversion()[0] < 6:
-            err = 'This is the last release of yt-dlp for your version of Windows. Please update to Windows Vista or above'
-    else:
-        err = 'It looks like you installed yt-dlp with a package manager, pip, setup.py or a tarball. Please use that to update'
-    if err:
-        return report_error(err, expected=True)
-
-    # sys.executable is set to the full pathname of the exe-file for py2exe
-    # though symlinks are not followed so that we need to do this manually
-    # with help of realpath
-    filename = compat_realpath(sys.executable if hasattr(sys, 'frozen') else sys.argv[0])
-    ydl.to_screen('Current Build Hash %s' % calc_sha256sum(filename))
-
     # Download and check versions info
     try:
         version_info = ydl._opener.open(JSON_URL).read().decode('utf-8')
         version_info = json.loads(version_info)
     except Exception:
-        return report_error('can\'t obtain versions info. Please try again later ', True, delim='or')
+        return report_network_error('obtain version info', delim='; Please try again later or')
 
     def version_tuple(version_str):
         return tuple(map(int, version_str.split('.')))
 
     version_id = version_info['tag_name']
+    ydl.to_screen(f'Latest version: {version_id}, Current version: {__version__}')
     if version_tuple(__version__) >= version_tuple(version_id):
-        ydl.to_screen('yt-dlp is up to date (%s)' % __version__)
+        ydl.to_screen(f'yt-dlp is up to date ({__version__})')
         return
 
-    ydl.to_screen('Updating to version ' + version_id + ' ...')
+    err = is_non_updateable()
+    if err:
+        return report_error(err, True)
+
+    # sys.executable is set to the full pathname of the exe-file for py2exe
+    # though symlinks are not followed so that we need to do this manually
+    # with help of realpath
+    filename = compat_realpath(sys.executable if hasattr(sys, 'frozen') else sys.argv[0])
+    ydl.to_screen(f'Current Build Hash {calc_sha256sum(filename)}')
+    ydl.to_screen(f'Updating to version {version_id} ...')
 
     version_labels = {
         'zip_3': '',
-        'exe_64': '.exe',
-        'exe_32': '_x86.exe',
+        'win_exe_64': '.exe',
+        'py2exe_64': '_min.exe',
+        'win_exe_32': '_x86.exe',
+        'mac_exe_64': '_macos',
     }
 
     def get_bin_info(bin_or_exe, version):
@@ -142,100 +138,98 @@ def get_sha256sum(bin_or_exe, version):
         if not urlh:
             return None
         hash_data = ydl._opener.open(urlh).read().decode('utf-8')
-        if hash_data.startswith('version:'):
-            # Old colon-separated hash file
-            return dict(ln.split(':') for ln in hash_data.splitlines()).get(filename)
-        else:
-            # GNU-style hash file
-            return dict(ln.split()[::-1] for ln in hash_data.splitlines()).get(filename)
+        return dict(ln.split()[::-1] for ln in hash_data.splitlines()).get(filename)
 
     if not os.access(filename, os.W_OK):
-        return report_error('no write permissions on %s' % filename, expected=True)
+        return report_permission_error(filename)
 
     # PyInstaller
-    if hasattr(sys, 'frozen'):
-        exe = filename
-        directory = os.path.dirname(exe)
+    variant = detect_variant()
+    if variant in ('win_exe', 'py2exe'):
+        directory = os.path.dirname(filename)
         if not os.access(directory, os.W_OK):
-            return report_error('no write permissions on %s' % directory, expected=True)
+            return report_permission_error(directory)
         try:
             if os.path.exists(filename + '.old'):
                 os.remove(filename + '.old')
         except (IOError, OSError):
-            return report_error('unable to remove the old version')
+            return report_unable('remove the old version')
 
         try:
             arch = platform.architecture()[0][:2]
-            url = get_bin_info('exe', arch).get('browser_download_url')
+            url = get_bin_info(variant, arch).get('browser_download_url')
             if not url:
-                return report_error('unable to fetch updates', True)
+                return report_network_error('fetch updates')
             urlh = ydl._opener.open(url)
             newcontent = urlh.read()
             urlh.close()
-        except (IOError, OSError, StopIteration):
-            return report_error('unable to download latest version', True)
+        except (IOError, OSError):
+            return report_network_error('download latest version')
 
         try:
-            with open(exe + '.new', 'wb') as outf:
+            with open(filename + '.new', 'wb') as outf:
                 outf.write(newcontent)
         except (IOError, OSError):
-            return report_error('unable to write the new version')
+            return report_permission_error(f'{filename}.new')
 
-        expected_sum = get_sha256sum('exe', arch)
+        expected_sum = get_sha256sum(variant, arch)
         if not expected_sum:
             ydl.report_warning('no hash information found for the release')
-        elif calc_sha256sum(exe + '.new') != expected_sum:
-            report_error('unable to verify the new executable', True)
+        elif calc_sha256sum(filename + '.new') != expected_sum:
+            report_network_error('verify the new executable')
             try:
-                os.remove(exe + '.new')
+                os.remove(filename + '.new')
             except OSError:
-                return report_error('unable to remove corrupt download')
+                return report_unable('remove corrupt download')
 
         try:
-            os.rename(exe, exe + '.old')
+            os.rename(filename, filename + '.old')
         except (IOError, OSError):
-            return report_error('unable to move current version')
+            return report_unable('move current version')
         try:
-            os.rename(exe + '.new', exe)
+            os.rename(filename + '.new', filename)
         except (IOError, OSError):
-            report_error('unable to overwrite current version')
-            os.rename(exe + '.old', exe)
+            report_unable('overwrite current version')
+            os.rename(filename + '.old', filename)
             return
         try:
             # Continues to run in the background
-            subprocess.Popen(
-                'ping 127.0.0.1 -n 5 -w 1000 & del /F "%s.old"' % exe,
+            Popen(
+                'ping 127.0.0.1 -n 5 -w 1000 & del /F "%s.old"' % filename,
                 shell=True, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
             ydl.to_screen('Updated yt-dlp to version %s' % version_id)
             return True  # Exit app
         except OSError:
-            report_error('unable to delete old version')
+            report_unable('delete the old version')
 
-    # Zip unix package
-    elif isinstance(globals().get('__loader__'), zipimporter):
+    elif variant in ('zip', 'mac_exe'):
+        pack_type = '3' if variant == 'zip' else '64'
         try:
-            url = get_bin_info('zip', '3').get('browser_download_url')
+            url = get_bin_info(variant, pack_type).get('browser_download_url')
             if not url:
-                return report_error('unable to fetch updates', True)
+                return report_network_error('fetch updates')
             urlh = ydl._opener.open(url)
             newcontent = urlh.read()
             urlh.close()
-        except (IOError, OSError, StopIteration):
-            return report_error('unable to download latest version', True)
+        except (IOError, OSError):
+            return report_network_error('download the latest version')
 
-        expected_sum = get_sha256sum('zip', '3')
+        expected_sum = get_sha256sum(variant, pack_type)
         if not expected_sum:
             ydl.report_warning('no hash information found for the release')
         elif hashlib.sha256(newcontent).hexdigest() != expected_sum:
-            return report_error('unable to verify the new zip', True)
+            return report_network_error('verify the new package')
 
         try:
             with open(filename, 'wb') as outf:
                 outf.write(newcontent)
         except (IOError, OSError):
-            return report_error('unable to overwrite current version')
+            return report_unable('overwrite current version')
 
-    ydl.to_screen('Updated yt-dlp to version %s; Restart yt-dlp to use the new version' % version_id)
+        ydl.to_screen('Updated yt-dlp to version %s; Restart yt-dlp to use the new version' % version_id)
+        return
+
+    assert False, f'Unhandled variant: {variant}'
 
 
 '''  # UNUSED
@@ -254,3 +248,41 @@ def print_notes(to_screen, versions, fromVersion=__version__):
         for note in notes:
             to_screen(note)
 '''
+
+
+# Deprecated
+def update_self(to_screen, verbose, opener):
+
+    printfn = to_screen
+
+    write_string(
+        'DeprecationWarning: "yt_dlp.update.update_self" is deprecated and may be removed in a future version. '
+        'Use "yt_dlp.update.run_update(ydl)" instead\n')
+
+    class FakeYDL():
+        _opener = opener
+        to_screen = printfn
+
+        @staticmethod
+        def report_warning(msg, *args, **kwargs):
+            return printfn('WARNING: %s' % msg, *args, **kwargs)
+
+        @staticmethod
+        def report_error(msg, tb=None):
+            printfn('ERROR: %s' % msg)
+            if not verbose:
+                return
+            if tb is None:
+                # Copied from YoutubeDl.trouble
+                if sys.exc_info()[0]:
+                    tb = ''
+                    if hasattr(sys.exc_info()[1], 'exc_info') and sys.exc_info()[1].exc_info[0]:
+                        tb += ''.join(traceback.format_exception(*sys.exc_info()[1].exc_info))
+                    tb += encode_compat_str(traceback.format_exc())
+                else:
+                    tb_data = traceback.format_list(traceback.extract_stack())
+                    tb = ''.join(tb_data)
+            if tb:
+                printfn(tb)
+
+    return run_update(FakeYDL())