yt-dlp/yt_dlp/update.py

230 lines
7.7 KiB
Python
Raw Normal View History

import hashlib
2012-12-30 18:49:14 +00:00
import json
2013-11-17 15:47:52 +00:00
import os
import platform
import subprocess
import sys
2012-12-30 18:49:14 +00:00
from zipimport import zipimporter
from .compat import functools # isort: split
from .compat import compat_realpath
from .utils import Popen, traverse_obj, version_tuple
2012-12-30 18:49:14 +00:00
from .version import __version__
2014-11-23 19:41:03 +00:00
RELEASE_JSON_URL = 'https://api.github.com/repos/yt-dlp/yt-dlp/releases/latest'
@functools.cache
def _get_variant_and_executable_path():
2022-04-17 17:18:50 +00:00
"""@returns (variant, executable_path)"""
if hasattr(sys, 'frozen'):
2022-04-17 17:18:50 +00:00
path = sys.executable
if not hasattr(sys, '_MEIPASS'):
return 'py2exe', path
if sys._MEIPASS == os.path.dirname(path):
return f'{sys.platform}_dir', path
return f'{sys.platform}_exe', path
path = os.path.dirname(__file__)
2022-04-17 17:18:50 +00:00
if isinstance(__loader__, zipimporter):
return 'zip', os.path.join(path, '..')
elif os.path.basename(sys.argv[0]) == '__main__.py':
2022-04-17 17:18:50 +00:00
return 'source', path
return 'unknown', path
def detect_variant():
return _get_variant_and_executable_path()[0]
_FILE_SUFFIXES = {
'zip': '',
'py2exe': '_min.exe',
'win32_exe': '.exe',
'darwin_exe': '_macos',
}
_NON_UPDATEABLE_REASONS = {
**{variant: None for variant in _FILE_SUFFIXES}, # Updatable
**{variant: f'Auto-update is not supported for unpackaged {name} executable; Re-download the latest release'
for variant, name in {'win32_dir': 'Windows', 'darwin_dir': 'MacOS'}.items()},
'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 or setup.py; Use that to update',
'other': 'It looks like you are using an unofficial build of yt-dlp; Build the executable again',
}
def is_non_updateable():
return _NON_UPDATEABLE_REASONS.get(detect_variant(), _NON_UPDATEABLE_REASONS['other'])
def run_update(ydl):
"""
Update the program file with the latest version from the repository
Returns whether the program should terminate
"""
2012-12-30 18:49:14 +00:00
def report_error(msg, expected=False):
2022-04-17 17:18:50 +00:00
ydl.report_error(msg, tb=False 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):
2020-10-31 07:57:55 +00:00
h = hashlib.sha256()
mv = memoryview(bytearray(128 * 1024))
with open(os.path.realpath(path), 'rb', buffering=0) as f:
2020-10-31 07:57:55 +00:00
for n in iter(lambda: f.readinto(mv), 0):
h.update(mv[:n])
return h.hexdigest()
try:
version_info = json.loads(ydl.urlopen(RELEASE_JSON_URL).read().decode())
except Exception:
return report_network_error('obtain version info', delim='; Please try again later or')
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(f'yt-dlp is up to date ({__version__})')
return
err = is_non_updateable()
if err:
return report_error(err, True)
2012-12-30 18:49:14 +00:00
variant, filename = _get_variant_and_executable_path()
2022-04-17 17:18:50 +00:00
filename = compat_realpath(filename) # Absolute path, following symlinks
label = _FILE_SUFFIXES[variant]
if label and platform.architecture()[0][:2] == '32':
label = f'_x86{label}'
release_name = f'yt-dlp{label}'
2021-12-01 00:16:15 +00:00
ydl.to_screen(f'Current Build Hash {calc_sha256sum(filename)}')
ydl.to_screen(f'Updating to version {version_id} ...')
2013-02-21 23:36:23 +00:00
def get_file(name, fatal=True):
error = report_network_error if fatal else lambda _: None
url = traverse_obj(
version_info, ('assets', lambda _, v: v['name'] == name, 'browser_download_url'), get_all=False)
if not url:
return error('fetch updates')
try:
return ydl.urlopen(url).read()
except OSError:
return error('download latest version')
def verify(content):
if not content:
return False
hash_data = get_file('SHA2-256SUMS', fatal=False) or b''
expected = dict(ln.split()[::-1] for ln in hash_data.decode().splitlines()).get(release_name)
if not expected:
ydl.report_warning('no hash information found for the release')
elif hashlib.sha256(content).hexdigest() != expected:
return report_network_error('verify the new executable')
return True
directory = os.path.dirname(filename)
if not os.access(filename, os.W_OK):
return report_permission_error(filename)
elif not os.access(directory, os.W_OK):
return report_permission_error(directory)
2012-12-30 18:49:14 +00:00
new_filename, old_filename = f'{filename}.new', f'{filename}.old'
if variant == 'zip': # Can be replaced in-place
new_filename, old_filename = filename, None
2012-12-30 18:49:14 +00:00
try:
if os.path.exists(old_filename or ''):
os.remove(old_filename)
except OSError:
return report_unable('remove the old version')
newcontent = get_file(release_name)
if not verify(newcontent):
return
try:
with open(new_filename, 'wb') as outf:
outf.write(newcontent)
except OSError:
return report_permission_error(new_filename)
try:
if old_filename:
os.rename(filename, old_filename)
except OSError:
return report_unable('move current version')
try:
if old_filename:
os.rename(new_filename, filename)
except OSError:
report_unable('overwrite current version')
os.rename(old_filename, filename)
return
2012-12-30 18:49:14 +00:00
if variant not in ('win32_exe', 'py2exe'):
if old_filename:
os.remove(old_filename)
ydl.to_screen(f'Updated yt-dlp to version {version_id}; Restart yt-dlp to use the new version')
return
try:
# Continues to run in the background
Popen(f'ping 127.0.0.1 -n 5 -w 1000 & del /F "{old_filename}"',
shell=True, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
ydl.to_screen(f'Updated yt-dlp to version {version_id}')
return True # Exit app
except OSError:
report_unable('delete the old version')
2013-02-21 23:36:23 +00:00
2014-11-23 19:41:03 +00:00
2021-11-29 17:46:06 +00:00
# Deprecated
def update_self(to_screen, verbose, opener):
import traceback
from .utils import write_string
2021-11-29 17:46:06 +00:00
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')
printfn = to_screen
class FakeYDL():
to_screen = printfn
@staticmethod
def report_warning(msg, *args, **kwargs):
return printfn(f'WARNING: {msg}', *args, **kwargs)
@staticmethod
def report_error(msg, tb=None):
printfn(f'ERROR: {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 += traceback.format_exc()
else:
tb_data = traceback.format_list(traceback.extract_stack())
tb = ''.join(tb_data)
if tb:
printfn(tb)
def urlopen(self, url):
return opener.open(url)
return run_update(FakeYDL())