mirror of
https://github.com/derrod/legendary.git
synced 2024-06-22 04:20:38 +12:00
288 lines
11 KiB
Python
288 lines
11 KiB
Python
# coding: utf-8
|
|
|
|
import json
|
|
import os
|
|
import logging
|
|
|
|
from pathlib import Path
|
|
|
|
from legendary.models.game import *
|
|
from legendary.utils.config import LGDConf
|
|
from legendary.utils.lfs import clean_filename
|
|
|
|
|
|
class LGDLFS:
|
|
def __init__(self):
|
|
self.log = logging.getLogger('LGDLFS')
|
|
|
|
if config_path := os.environ.get('XDG_CONFIG_HOME'):
|
|
self.path = os.path.join(config_path, 'legendary')
|
|
else:
|
|
self.path = os.path.expanduser('~/.config/legendary')
|
|
|
|
# EGS user info
|
|
self._user_data = None
|
|
# EGS entitlements
|
|
self._entitlements = None
|
|
# EGS asset data
|
|
self._assets = None
|
|
# EGS metadata
|
|
self._game_metadata = dict()
|
|
# Config with game specific settings (e.g. start parameters, env variables)
|
|
self.config = LGDConf(comment_prefixes='/', allow_no_value=True)
|
|
self.config.optionxform = str
|
|
|
|
# ensure folders exist.
|
|
for f in ['', 'manifests', 'metadata', 'tmp']:
|
|
if not os.path.exists(os.path.join(self.path, f)):
|
|
os.makedirs(os.path.join(self.path, f))
|
|
|
|
# if "old" folder exists migrate files and remove it
|
|
if os.path.exists(os.path.join(self.path, 'manifests', 'old')):
|
|
self.log.info('Migrating manifest files from old folders to new, please wait...')
|
|
# remove unversioned manifest files
|
|
for _f in os.listdir(os.path.join(self.path, 'manifests')):
|
|
if '.manifest' not in _f:
|
|
continue
|
|
if '_' not in _f or (_f.startswith('UE_') and _f.count('_') < 2):
|
|
self.log.debug(f'Deleting "{_f}" ...')
|
|
os.remove(os.path.join(self.path, 'manifests', _f))
|
|
|
|
# move files from "old" to the base folder
|
|
for _f in os.listdir(os.path.join(self.path, 'manifests', 'old')):
|
|
try:
|
|
self.log.debug(f'Renaming "{_f}"')
|
|
os.rename(os.path.join(self.path, 'manifests', 'old', _f),
|
|
os.path.join(self.path, 'manifests', _f))
|
|
except Exception as e:
|
|
self.log.warning(f'Renaming manifest file "{_f}" failed: {e!r}')
|
|
|
|
# remove "old" folder
|
|
try:
|
|
os.removedirs(os.path.join(self.path, 'manifests', 'old'))
|
|
except Exception as e:
|
|
self.log.warning(f'Removing "{os.path.join(self.path, "manifests", "old")}" folder failed: '
|
|
f'{e!r}, please remove manually')
|
|
|
|
# try loading config
|
|
try:
|
|
self.config.read(os.path.join(self.path, 'config.ini'))
|
|
except Exception as e:
|
|
self.log.error(f'Unable to read configuration file, please ensure that file is valid! '
|
|
f'(Error: {repr(e)})')
|
|
self.log.warning(f'Continuing with blank config in safe-mode...')
|
|
self.config.read_only = True
|
|
|
|
# make sure "Legendary" section exists
|
|
if 'Legendary' not in self.config:
|
|
self.config['Legendary'] = dict()
|
|
|
|
try:
|
|
self._installed = json.load(open(os.path.join(self.path, 'installed.json')))
|
|
except Exception as e: # todo do not do this
|
|
self._installed = None
|
|
|
|
# load existing app metadata
|
|
for gm_file in os.listdir(os.path.join(self.path, 'metadata')):
|
|
try:
|
|
_meta = json.load(open(os.path.join(self.path, 'metadata', gm_file)))
|
|
self._game_metadata[_meta['app_name']] = _meta
|
|
except Exception as e:
|
|
self.log.debug(f'Loading game meta file "{gm_file}" failed: {e!r}')
|
|
|
|
@property
|
|
def userdata(self):
|
|
if self._user_data is not None:
|
|
return self._user_data
|
|
|
|
try:
|
|
self._user_data = json.load(open(os.path.join(self.path, 'user.json')))
|
|
return self._user_data
|
|
except Exception as e:
|
|
self.log.debug(f'Failed to load user data: {e!r}')
|
|
return None
|
|
|
|
@userdata.setter
|
|
def userdata(self, userdata):
|
|
if userdata is None:
|
|
raise ValueError('Userdata is none!')
|
|
|
|
self._user_data = userdata
|
|
json.dump(userdata, open(os.path.join(self.path, 'user.json'), 'w'),
|
|
indent=2, sort_keys=True)
|
|
|
|
def invalidate_userdata(self):
|
|
self._user_data = None
|
|
if os.path.exists(os.path.join(self.path, 'user.json')):
|
|
os.remove(os.path.join(self.path, 'user.json'))
|
|
|
|
@property
|
|
def entitlements(self):
|
|
if self._entitlements is not None:
|
|
return self._entitlements
|
|
|
|
try:
|
|
self._entitlements = json.load(open(os.path.join(self.path, 'entitlements.json')))
|
|
return self._entitlements
|
|
except Exception as e:
|
|
self.log.debug(f'Failed to load entitlements data: {e!r}')
|
|
return None
|
|
|
|
@entitlements.setter
|
|
def entitlements(self, entitlements):
|
|
if entitlements is None:
|
|
raise ValueError('Entitlements is none!')
|
|
|
|
self._entitlements = entitlements
|
|
json.dump(entitlements, open(os.path.join(self.path, 'entitlements.json'), 'w'),
|
|
indent=2, sort_keys=True)
|
|
|
|
@property
|
|
def assets(self):
|
|
if self._assets is None:
|
|
try:
|
|
self._assets = [GameAsset.from_json(a) for a in
|
|
json.load(open(os.path.join(self.path, 'assets.json')))]
|
|
except Exception as e:
|
|
self.log.debug(f'Failed to load assets data: {e!r}')
|
|
return None
|
|
|
|
return self._assets
|
|
|
|
@assets.setter
|
|
def assets(self, assets):
|
|
if assets is None:
|
|
raise ValueError('Assets is none!')
|
|
|
|
self._assets = assets
|
|
json.dump([a.__dict__ for a in self._assets],
|
|
open(os.path.join(self.path, 'assets.json'), 'w'),
|
|
indent=2, sort_keys=True)
|
|
|
|
def _get_manifest_filename(self, app_name, version):
|
|
fname = clean_filename(f'{app_name}_{version}')
|
|
return os.path.join(self.path, 'manifests', f'{fname}.manifest')
|
|
|
|
def load_manifest(self, app_name, version):
|
|
try:
|
|
return open(self._get_manifest_filename(app_name, version), 'rb').read()
|
|
except FileNotFoundError: # all other errors should propagate
|
|
return None
|
|
|
|
def save_manifest(self, app_name, manifest_data, version):
|
|
with open(self._get_manifest_filename(app_name, version), 'wb') as f:
|
|
f.write(manifest_data)
|
|
|
|
def get_game_meta(self, app_name):
|
|
_meta = self._game_metadata.get(app_name, None)
|
|
if _meta:
|
|
return Game.from_json(_meta)
|
|
return None
|
|
|
|
def set_game_meta(self, app_name, meta):
|
|
json_meta = meta.__dict__
|
|
self._game_metadata[app_name] = json_meta
|
|
meta_file = os.path.join(self.path, 'metadata', f'{app_name}.json')
|
|
json.dump(json_meta, open(meta_file, 'w'), indent=2, sort_keys=True)
|
|
|
|
def delete_game_meta(self, app_name):
|
|
if app_name in self._game_metadata:
|
|
del self._game_metadata[app_name]
|
|
meta_file = os.path.join(self.path, 'metadata', f'{app_name}.json')
|
|
if os.path.exists(meta_file):
|
|
os.remove(meta_file)
|
|
else:
|
|
raise ValueError(f'Game {app_name} does not exist in metadata DB!')
|
|
|
|
def get_tmp_path(self):
|
|
return os.path.join(self.path, 'tmp')
|
|
|
|
def clean_tmp_data(self):
|
|
for f in os.listdir(os.path.join(self.path, 'tmp')):
|
|
try:
|
|
os.remove(os.path.join(self.path, 'tmp', f))
|
|
except Exception as e:
|
|
self.log.warning(f'Failed to delete file "{f}": {e!r}')
|
|
|
|
def clean_metadata(self, app_names):
|
|
for f in os.listdir(os.path.join(self.path, 'metadata')):
|
|
app_name = f.rpartition('.')[0]
|
|
if app_name not in app_names:
|
|
try:
|
|
os.remove(os.path.join(self.path, 'metadata', f))
|
|
except Exception as e:
|
|
self.log.warning(f'Failed to delete file "{f}": {e!r}')
|
|
|
|
def clean_manifests(self, in_use):
|
|
in_use_files = set(f'{clean_filename(f"{app_name}_{version}")}.manifest' for app_name, version in in_use)
|
|
for f in os.listdir(os.path.join(self.path, 'manifests')):
|
|
if f not in in_use_files:
|
|
try:
|
|
os.remove(os.path.join(self.path, 'manifests', f))
|
|
except Exception as e:
|
|
self.log.warning(f'Failed to delete file "{f}": {e!r}')
|
|
|
|
def get_installed_game(self, app_name):
|
|
if self._installed is None:
|
|
try:
|
|
self._installed = json.load(open(os.path.join(self.path, 'installed.json')))
|
|
except Exception as e:
|
|
self.log.debug(f'Failed to load installed game data: {e!r}')
|
|
return None
|
|
|
|
game_json = self._installed.get(app_name, None)
|
|
if game_json:
|
|
return InstalledGame.from_json(game_json)
|
|
return None
|
|
|
|
def set_installed_game(self, app_name, install_info):
|
|
if self._installed is None:
|
|
self._installed = dict()
|
|
|
|
if app_name in self._installed:
|
|
self._installed[app_name].update(install_info.__dict__)
|
|
else:
|
|
self._installed[app_name] = install_info.__dict__
|
|
|
|
json.dump(self._installed, open(os.path.join(self.path, 'installed.json'), 'w'),
|
|
indent=2, sort_keys=True)
|
|
|
|
def remove_installed_game(self, app_name):
|
|
if self._installed is None:
|
|
self.log.warning('Trying to remove a game, but no installed games?!')
|
|
return
|
|
|
|
if app_name in self._installed:
|
|
del self._installed[app_name]
|
|
else:
|
|
self.log.warning('Trying to remove non-installed game:', app_name)
|
|
return
|
|
|
|
json.dump(self._installed, open(os.path.join(self.path, 'installed.json'), 'w'),
|
|
indent=2, sort_keys=True)
|
|
|
|
def get_installed_list(self):
|
|
if not self._installed:
|
|
return []
|
|
|
|
return [InstalledGame.from_json(i) for i in self._installed.values()]
|
|
|
|
def save_config(self):
|
|
# do not save if in read-only mode or file hasn't changed
|
|
if self.config.read_only or not self.config.modified:
|
|
return
|
|
# if config file has been modified externally, back-up the user-modified version before writing
|
|
config_path = os.path.join(self.path, 'config.ini')
|
|
if os.path.exists(config_path):
|
|
if (modtime := int(os.stat(config_path).st_mtime)) != self.config.modtime:
|
|
new_filename = f'config.{modtime}.ini'
|
|
self.log.warning(f'Configuration file has been modified while legendary was running, '
|
|
f'user-modified config will be renamed to "{new_filename}"...')
|
|
os.rename(os.path.join(self.path, 'config.ini'), os.path.join(self.path, new_filename))
|
|
|
|
with open(config_path, 'w') as cf:
|
|
self.config.write(cf)
|
|
|
|
def get_dir_size(self):
|
|
return sum(f.stat().st_size for f in Path(self.path).glob('**/*') if f.is_file())
|