from __future__ import unicode_literals
-import io
-import json
-import traceback
import hashlib
+import json
import os
import platform
import subprocess
import sys
+import traceback
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__
'''
-def update_self(to_screen, verbose, opener):
+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'
+
+
+_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',
+}
+
+
+def is_non_updateable():
+ return _NON_UPDATEABLE_REASONS.get(detect_variant(), _NON_UPDATEABLE_REASONS['unknown'])
+
+
+def run_update(ydl):
"""
Update the program file with the latest version from the repository
Returns whether the program should terminate
JSON_URL = 'https://api.github.com/repos/yt-dlp/yt-dlp/releases/latest'
+ 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()
b = bytearray(128 * 1024)
h.update(mv[:n])
return h.hexdigest()
- if not isinstance(globals().get('__loader__'), zipimporter) and not hasattr(sys, 'frozen'):
- to_screen('It looks like you installed yt-dlp with a package manager, pip, setup.py or a tarball. Please use that to update.')
- return
-
- # 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])
- to_screen('Current Build Hash %s' % calc_sha256sum(filename))
-
# Download and check versions info
try:
- version_info = opener.open(JSON_URL).read().decode('utf-8')
+ version_info = ydl._opener.open(JSON_URL).read().decode('utf-8')
version_info = json.loads(version_info)
except Exception:
- if verbose:
- to_screen(encode_compat_str(traceback.format_exc()))
- to_screen('ERROR: can\'t obtain versions info. Please try again later.')
- to_screen('Visit https://github.com/yt-dlp/yt-dlp/releases/latest')
- return
+ 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):
- to_screen('yt-dlp is up to date (%s)' % __version__)
+ ydl.to_screen(f'yt-dlp is up to date ({__version__})')
return
- 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': '',
- 'zip_2': '',
- # 'zip_2': '_py2',
- '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):
label = version_labels['%s_%s' % (bin_or_exe, version)]
- return next(
- (i for i in version_info['assets'] if i['name'] == 'yt-dlp%s' % label),
- {})
+ return next((i for i in version_info['assets'] if i['name'] == 'yt-dlp%s' % label), {})
def get_sha256sum(bin_or_exe, version):
- label = version_labels['%s_%s' % (bin_or_exe, version)]
+ filename = 'yt-dlp%s' % version_labels['%s_%s' % (bin_or_exe, version)]
urlh = next(
- (i for i in version_info['assets']
- if i['name'] in ('SHA2-256SUMS')), {}).get('browser_download_url')
+ (i for i in version_info['assets'] if i['name'] in ('SHA2-256SUMS')),
+ {}).get('browser_download_url')
if not urlh:
return None
- hash_data = opener.open(urlh).read().decode('utf-8')
- hashes = list(map(lambda x: x.split(':'), hash_data.splitlines()))
- return next(
- (i[1] for i in hashes if i[0] == 'yt-dlp%s' % label),
- None)
+ hash_data = ydl._opener.open(urlh).read().decode('utf-8')
+ return dict(ln.split()[::-1] for ln in hash_data.splitlines()).get(filename)
if not os.access(filename, os.W_OK):
- to_screen('ERROR: no write permissions on %s' % filename)
- return
+ 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):
- to_screen('ERROR: no write permissions on %s' % directory)
- return
+ return report_permission_error(directory)
+ try:
+ if os.path.exists(filename + '.old'):
+ os.remove(filename + '.old')
+ except (IOError, OSError):
+ 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:
- to_screen('ERROR: unable to fetch updates')
- to_screen('Visit https://github.com/yt-dlp/yt-dlp/releases/latest')
- return
- urlh = opener.open(url)
+ return report_network_error('fetch updates')
+ urlh = ydl._opener.open(url)
newcontent = urlh.read()
urlh.close()
- except (IOError, OSError, StopIteration):
- if verbose:
- to_screen(encode_compat_str(traceback.format_exc()))
- to_screen('ERROR: unable to download latest version')
- to_screen('Visit https://github.com/yt-dlp/yt-dlp/releases/latest')
- return
+ 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):
- if verbose:
- to_screen(encode_compat_str(traceback.format_exc()))
- to_screen('ERROR: unable to write the new version')
- return
+ return report_permission_error(f'{filename}.new')
- expected_sum = get_sha256sum('exe', arch)
+ expected_sum = get_sha256sum(variant, arch)
if not expected_sum:
- to_screen('WARNING: no hash information found for the release')
- elif calc_sha256sum(exe + '.new') != expected_sum:
- to_screen('ERROR: unable to verify the new executable')
- to_screen('Visit https://github.com/yt-dlp/yt-dlp/releases/latest')
+ ydl.report_warning('no hash information found for the release')
+ 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:
- to_screen('ERROR: unable to remove corrupt download')
- return
+ return report_unable('remove corrupt download')
try:
- bat = os.path.join(directory, 'yt-dlp-updater.cmd')
- with io.open(bat, 'w') as batfile:
- batfile.write('''
-@(
- echo.Waiting for file handle to be closed ...
- ping 127.0.0.1 -n 5 -w 1000 > NUL
- move /Y "%s.new" "%s" > NUL
- echo.Updated yt-dlp to version %s.
-)
-@start /b "" cmd /c del "%%~f0"&exit /b
- ''' % (exe, exe, version_id))
-
- subprocess.Popen([bat]) # Continues to run in the background
- return True # Exit app
+ os.rename(filename, filename + '.old')
except (IOError, OSError):
- if verbose:
- to_screen(encode_compat_str(traceback.format_exc()))
- to_screen('ERROR: unable to overwrite current version')
+ return report_unable('move current version')
+ try:
+ os.rename(filename + '.new', filename)
+ except (IOError, OSError):
+ report_unable('overwrite current version')
+ os.rename(filename + '.old', filename)
return
+ try:
+ # Continues to run in the background
+ 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_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:
- py_ver = platform.python_version()[0]
- url = get_bin_info('zip', py_ver).get('browser_download_url')
+ url = get_bin_info(variant, pack_type).get('browser_download_url')
if not url:
- to_screen('ERROR: unable to fetch updates')
- to_screen('Visit https://github.com/yt-dlp/yt-dlp/releases/latest')
- return
- urlh = opener.open(url)
+ return report_network_error('fetch updates')
+ urlh = ydl._opener.open(url)
newcontent = urlh.read()
urlh.close()
- except (IOError, OSError, StopIteration):
- if verbose:
- to_screen(encode_compat_str(traceback.format_exc()))
- to_screen('ERROR: unable to download latest version')
- to_screen('Visit https://github.com/yt-dlp/yt-dlp/releases/latest')
- return
+ except (IOError, OSError):
+ return report_network_error('download the latest version')
+
+ 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_network_error('verify the new package')
try:
- with open(filename + '.new', 'wb') as outf:
+ with open(filename, 'wb') as outf:
outf.write(newcontent)
except (IOError, OSError):
- if verbose:
- to_screen(encode_compat_str(traceback.format_exc()))
- to_screen('ERROR: unable to write the new version')
- return
+ return report_unable('overwrite current version')
- expected_sum = get_sha256sum('zip', py_ver)
- if expected_sum and calc_sha256sum(filename + '.new') != expected_sum:
- to_screen('ERROR: unable to verify the new zip')
- to_screen('Visit https://github.com/yt-dlp/yt-dlp/releases/latest')
- try:
- os.remove(filename + '.new')
- except OSError:
- to_screen('ERROR: unable to remove corrupt zip')
- return
-
- try:
- os.rename(filename + '.new', filename)
- except OSError:
- to_screen('ERROR: unable to overwrite current version')
- return
+ ydl.to_screen('Updated yt-dlp to version %s; Restart yt-dlp to use the new version' % version_id)
+ return
- to_screen('Updated yt-dlp. Restart yt-dlp to use the new version.')
+ assert False, f'Unhandled variant: {variant}'
''' # UNUSED
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())