1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
|
import atexit
import os
import shutil
import sys
import traceback
from configparser import ConfigParser, NoSectionError
# noinspection PyUnresolvedReferences
from typing import Dict, Tuple
import fsboot
from fsbc.signal import Signal
from fsbc.util import Version
from launcher.version import VERSION
class Settings(object):
_instance = None
@classmethod
def instance(cls):
if cls._instance is None:
cls._instance = Settings()
return cls._instance
def __init__(self, app=None, path: str = None) -> None:
self.app = app
self.path = path
self.values = {} # type: Dict[str, str]
self._provider = SettingsProvider()
self._loaded = False
self._loading = False
self._atexit_registered = False
self.verbose = True
def set_path(self, path):
self.path = path
def set_provider(self, provider):
self._provider = provider
def get(self, key: str, default="") -> str:
if not self._loading:
self.load()
return self.values.get(key, default)
def set(self, key: str, value: str) -> None:
if not self._loading:
self.load()
if self[key] == value:
self.log_key_value(key, value, extra="(unchanged)")
return
if not self._loading and not self._atexit_registered:
if self.verbose:
print("[SETTINGS] Register atexit save path =", self.path)
atexit.register(self.save)
self._atexit_registered = True
self.log_key_value(key, value)
self.values[key] = value
Signal("setting").notify(key, value)
def __getitem__(self, key: str):
return self.get(key)
def __setitem__(self, key: str, value: str) -> None:
self.set(key, value)
def load(self, force=False):
# print("[SETTINGS] Load", self)
if (not self._loaded) or force:
try:
self._loading = True
self._provider.load(self, verbose=self.verbose)
finally:
self._loading = False
self._loaded = True
# print("[SETTINGS] Loaded, path is", self.path)
def save(self, extra: Dict[str, str] = None) -> None:
if self.verbose:
print("[SETTINGS] Save", self)
self._provider.save(self, extra)
def log_key_value(self, key, value, extra=""):
if (
"username" in key
or "password" in key
or "auth" in key
or "email" in key
):
value = "*CENSORED*"
if extra:
extra = " " + extra
if self.verbose:
print("[SETTINGS] Set {} = {}{}".format(key, value, extra))
class SettingsProvider:
"""Provides default load and save behavior for Settings. You can subclass
this and replace the provider on the Settings instance if you want
customized loading/saving."""
def load(self, settings, verbose=True):
cp = ConfigParser(interpolation=None)
cp.optionxform = str
path = settings.path
if settings.app and not path:
path = settings.app.get_settings_path()
if not path:
if verbose:
print("[SETTINGS] No settings path specified")
path = os.path.join(fsboot.base_dir(), "Data", "Settings.ini")
if verbose:
print("[SETTINGS] Using default", path)
if os.path.exists(path):
if verbose:
print("[SETTINGS] Loading from", path)
else:
if verbose:
print("[SETTINGS] File", path, "does not exist")
# Write current settings path back to Settings instance
settings.path = path
try:
cp.read([path], encoding="UTF-8")
except Exception as e:
if verbose:
print("[SETTINGS] Error loading", repr(e))
return
try:
keys = cp.options("settings")
except NoSectionError:
return
values = {}
for key in sorted(keys):
if key.startswith("__"):
if verbose:
print("[SETTINGS] Ignoring", key)
continue
value = cp.get("settings", key)
values[key] = value
for arg in sys.argv:
if arg.startswith("--settings:"):
arg = arg[11:]
key, value = arg.split("=", 1)
key = key.replace("-", "_")
values[key] = value
for key in sorted(values.keys()):
value = values[key]
key = self.rewrite_key(key)
settings.set(key, value)
try:
version = cp.get("launcher", "version")
except NoSectionError:
version = "0.0.0"
try:
fix_settings(settings, version)
except Exception:
print("[SETTINGS] Error fixing settings")
traceback.print_exc()
def rewrite_key(self, key):
# FIXME: Should be moved to subclass
try:
return key_replacement_table[key]
except KeyError:
return key
def save(self, settings, extra=None):
partial_path = settings.path + ".partial"
print("[SETTINGS] Writing to", partial_path)
save_values = {} # type: Dict[Tuple[str, str], str]
for key, value in settings.values.items():
if key.startswith("__"):
# Temporary setting, do not save
continue
save_values[("settings", str(key))] = str(value)
if extra is not None:
for key, value in extra.items():
try:
section, key = key.split("/")
except ValueError:
section = "settings"
save_values[(section, key)] = value
cp = ConfigParser(interpolation=None)
cp.optionxform = str
# We want the settings section to be listed first.
cp.add_section("settings")
for (section, key) in sorted(save_values.keys()):
value = save_values[(section, key)]
if not value:
# We do not need to write empty values, as non-existing
# keys have an implicit empty value.
continue
if not cp.has_section(section):
cp.add_section(section)
cp.set(section, key, value)
cp.add_section("launcher")
cp.set("launcher", "version", VERSION)
if not os.path.exists(os.path.dirname(partial_path)):
os.makedirs(os.path.dirname(partial_path))
with open(partial_path, "w", encoding="UTF-8", newline="\n") as f:
cp.write(f)
print("[SETTINGS] Moving to", settings.path)
shutil.move(partial_path, settings.path)
def get(key: str) -> str:
return Settings.instance().get(key)
def set(key: str, value: str) -> None:
Settings.instance().set(key, value)
def load() -> None:
Settings.instance().load()
def save() -> None:
Settings.instance().save()
def unload() -> None:
raise NotImplementedError("settings.unload")
def set_path(path: str) -> None:
Settings.instance().set_path(path)
# FIXME: FS-UAE Launcher specific
def fix_settings(settings, version_str):
"""Fix settings, based on the version used top save the newly loaded
settings."""
old = Version(version_str)
if old < Version("2.9.10"):
if settings.get("fullscreen_mode"):
print("[SETTINGS] Reverting fullscreen_mode to default")
settings.set("fullscreen_mode", "")
# FIXME: FS-UAE Launcher specific
key_replacement_table = {
"database_arcade": "arcade_database",
"database_atari": "atari_database",
"database_c64": "c64_database",
"database_cpc": "cpc_database",
"database_dos": "dos_database",
"database_gb": "gb_database",
"database_gba": "gba_database",
"database_gbc": "gbc_database",
"database_nes": "nes_database",
"database_psx": "psx_database",
"database_snes": "snes_database",
}
|