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 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497
|
import ctypes
import getpass
import logging
import os
import subprocess
import sys
import time
from functools import lru_cache
from typing import Any, Dict, List, Optional
# The original argument list at boot time, before any modifications
_argv = [] # type: List[str]
# The current directory when the application was started
_cwd = os.getcwd()
# Key-value store
_values: Dict[str, str] = {}
# Found Plugin/Python code override directory
_plugin_code_override = False
logger = logging.getLogger("BOOT")
perf_counter_epoch = time.perf_counter()
def init() -> None:
global _argv, _cwd
_cwd = os.getcwd()
_argv = sys.argv.copy()
setup_python_path()
print("sys.path =", sys.path)
def set(key: str, value: str) -> None:
_values[key] = value
def get(key: str, default: str = "") -> str:
return _values.get(key, default)
def setup_logging() -> None:
root = logging.getLogger()
root.setLevel(logging.DEBUG)
ch = logging.StreamHandler(sys.stdout)
ch.setLevel(logging.DEBUG)
# formatter = logging.Formatter(
# "[%(name)s] - %(asctime)s - %(levelname)s - %(message)s")
formatter = logging.Formatter("[%(name)s] %(message)s")
ch.setFormatter(formatter)
root.addHandler(ch)
if "--workspace" in sys.argv:
# Hack
set("fws", "1")
if "--openretro" in sys.argv:
# Hack
set("openretro", "1")
if "--logging" in sys.argv:
setup_logging()
sys.argv.remove("--logging")
@lru_cache()
def executable_dir() -> str:
"""Returns the directory containing the executable (or main script)."""
logger.debug("executable_dir")
logger.debug("sys.executable = %s", sys.executable)
if "python" in os.path.basename(sys.executable):
logger.debug("Using sys.argv[0] instead of python interpreter path")
# We do not want the directory of the (installed) python
# interpreter, but rather the main application script.
logger.debug("sys.argv[0] = %s", repr(sys.argv[0]))
path = os.path.dirname(os.path.abspath(sys.argv[0]))
logger.debug("%s", repr(path))
else:
path = os.path.dirname(sys.executable)
if not os.path.isabs(path):
logger.warning(
"WARNING: executable_dir %s is not absolute", repr(path)
)
print(
f"WARNING: executable_dir {repr(path)} is not absolute",
file=sys.stderr,
)
logger.debug("executable_dir = %s", repr(path))
return path
@lru_cache()
def app_dir() -> str:
"""Returns the (absolute) directory containing the application.
This is the same as the executable_dir, except for macOS where the
directory containing the .app bundle is returned.
"""
app_dir = executable_dir()
if is_macos() and is_frozen():
# Break out of .app/Contents/MacOS
app_dir = os.path.normpath(os.path.join(app_dir, "..", "..", ".."))
return app_dir
@lru_cache()
def plugin_dir() -> Optional[str]:
"""Returns the (absolute) directory containing the plugin (or None)."""
plugin_dir = os.path.join(app_dir(), "..", "..")
if os.path.exists(os.path.join(plugin_dir, "Plugin.ini")):
return plugin_dir
return None
if sys.platform == "win32":
S_OK = 0
CSIDL_DESKTOP = 0
CSIDL_PERSONAL = 5
CSIDL_APPDATA = 26
CSIDL_MYPICTURES = 39
CSIDL_PROFILE = 40
CSIDL_COMMON_DOCUMENTS = 46
from ctypes import windll
from ctypes import wintypes
_SHGetFolderPath = windll.shell32.SHGetFolderPathW
_SHGetFolderPath.argtypes = [
wintypes.HWND,
ctypes.c_int,
wintypes.HANDLE,
wintypes.DWORD,
wintypes.LPCWSTR,
]
def csidl_dir(csidl):
path_buf = ctypes.create_unicode_buffer(wintypes.MAX_PATH)
result = _SHGetFolderPath(0, csidl, 0, 0, path_buf)
if result != S_OK:
raise RuntimeError(
"Could not find common directory for CSIDL {}".format(csidl)
)
return path_buf.value
class WinPathsException(Exception):
pass
def err_unless_zero(result):
if result == 0:
return result
else:
raise WinPathsException(
"Failed to retrieve windows path: %s" % result
)
_SHGetFolderPath.restype = err_unless_zero
@lru_cache()
def user_name() -> str:
name = getpass.getuser()
return name
@lru_cache()
def xdg_user_dir(name: str) -> Optional[str]:
try:
process = subprocess.Popen(
["xdg-user-dir", name], stdout=subprocess.PIPE
)
assert process.stdout is not None
pathBytes = process.stdout.read().strip()
path = pathBytes.decode("UTF-8")
logger.debug("XDG user dir %s => %s", name, repr(path))
except Exception:
return None
else:
return path
@lru_cache()
def home_dir() -> str:
if sys.platform == "win32":
path = csidl_dir(CSIDL_PROFILE)
else:
path = os.path.expanduser("~")
assert isinstance(path, str)
# path = unicode_path(path)
return path
@lru_cache()
def documents_dir(create: bool = False) -> str:
if sys.platform == "win32":
path = csidl_dir(CSIDL_PERSONAL)
elif sys.platform == "darwin":
path = os.path.join(home_dir(), "Documents")
else:
path = xdg_user_dir("DOCUMENTS")
if not path:
path = home_dir()
assert isinstance(path, str)
# path = unicode_path(path)
if create and not os.path.isdir(path):
os.makedirs(path)
return path
def is_portable() -> bool:
return portable_dir() is not None
@lru_cache()
def portable_dir() -> Optional[str]:
path = executable_dir()
last = ""
while not last == path:
portable_ini_path = os.path.join(path, "Portable.ini")
logger.debug("Checking %s", repr(portable_ini_path))
if os.path.exists(portable_ini_path):
logger.debug("Detected portable dir: %s", repr(path))
return path
last = path
path = os.path.dirname(path)
logger.debug("No Portable.ini found in search path")
return None
@lru_cache()
def common_data_dir(create: bool = False) -> str:
if sys.platform == "win32":
path = csidl_dir(CSIDL_APPDATA)
elif sys.platform == "darwin":
path = os.path.join(home_dir(), "Library", "Application Support")
else:
path = os.path.join(home_dir(), ".local", "share")
path = os.environ.get("XDG_DATA_HOME", path)
# path = unicode_path(path)
if create and not os.path.exists(path):
os.makedirs(path)
return path
@lru_cache()
def app_data_dir(app: str) -> str:
return os.path.join(common_data_dir(), app)
@lru_cache()
def app_config_dir(app: str) -> str:
# if not app:
# app = get_app_id()
if sys.platform == "win32":
path = app_data_dir(app)
elif sys.platform == "darwin":
path = os.path.join(home_dir(), "Library", "Preferences", app)
else:
path = os.path.join(home_dir(), ".config")
path = os.environ.get("XDG_CONFIG_HOME", path)
path = os.path.join(path, app)
# path = unicode_path(path)
if not os.path.isdir(path):
os.makedirs(path)
return path
@lru_cache()
def custom_path(name: str) -> Optional[str]:
if get("openretro") == "1":
app_names = ["openretro"]
else:
app_names = ["fs-uae-launcher", "fs-uae"]
for app_name in app_names:
key_path = os.path.join(app_config_dir(app_name), name)
logger.debug("Checking %s", repr(key_path))
if os.path.exists(key_path):
try:
with open(key_path, "r", encoding="UTF-8") as f:
path = f.read().strip()
break
except Exception as e:
logger.debug("Error reading custom path %s", repr(e))
else:
return None
path_lower = path.lower()
if path_lower.startswith("$home/") or path_lower.startswith("$home\\"):
path = os.path.join(home_dir(), path[6:])
elif path_lower.startswith("~/") or path_lower.startswith("~\\"):
path = os.path.join(home_dir(), path[2:])
print(f"custom_path {name!r} -> {path!r}")
logger.debug("custom_path %r -> %r", name, path)
return path
def _getBaseDirectoryBeforeNormalization() -> str:
path: Optional[str]
logger.debug("Find base_dir")
for arg in sys.argv[1:]:
if arg.startswith("--base-dir="):
path = arg[11:]
path = os.path.abspath(path)
logger.debug("Using base_dir via argv: %r", path)
sys.argv.remove(arg)
return path
path = portable_dir()
if path:
return path
if get("openretro") == "1":
logger.debug("Checking OPENRETRO_BASE_DIR")
path = os.environ.get("OPENRETRO_BASE_DIR", "")
if path:
logger.debug("Using base_dir via OPENRETRO_BASE_DIR: %r", path)
return path
else:
logger.debug("Checking FS_UAE_BASE_DIR")
path = os.environ.get("FS_UAE_BASE_DIR", "")
if path:
logger.debug("Using base_dir via FS_UAE_BASE_DIR: %r", path)
return path
path = custom_path("base-dir")
if path:
logger.debug("Using base_dir via custom path config: %r", path)
return path
if get("base_dir_name"):
# path = os.path.join(documents_dir(True), get("base_dir_name"))
path = os.path.join(home_dir(), get("base_dir_name"))
elif get("openretro") == "1":
path = os.path.join(home_dir(), "OpenRetro")
else:
# Check new ~/FS-UAE directory first
path = os.path.join(home_dir(), "FS-UAE")
if os.path.exists(path):
print("- using base_dir $HOME/FS-UAE")
else:
print("- using base_dir $DOCUMENTS/FS-UAE")
# FS-UAE uses Documents/FS-UAE for legacy reasons
path = os.path.join(documents_dir(), "FS-UAE")
assert path is not None
logger.debug("Using default base_dir %r", path)
return path
@lru_cache()
def base_dir() -> str:
path = _getBaseDirectoryBeforeNormalization()
print("Using base_dir =", repr(path))
# It is important to remove any trailing slash, etc. since the exact
# base_dir is used for removing base_dir prefix from other paths.
# Case normalization is important too, but that's done by FSGSDirectories.
path = os.path.normpath(path)
print("After normpath: base_dir =", repr(path))
logger.debug("After normpath, base_dir = %r", path)
if not os.path.exists(path):
os.makedirs(path)
return path
def getBaseDirectory() -> str:
return base_dir()
@lru_cache()
def development() -> bool:
# FIXME: Document option
if "--development-mode=0" in sys.argv:
return False
result = os.path.exists(os.path.join(executable_dir(), "pyproject.toml"))
logger.info("Development mode: %s", result)
return result
def is_frozen() -> bool:
return bool(getattr(sys, "frozen", False))
def is_macos() -> bool:
return sys.platform == "darwin"
def setup_frozen_python_libs() -> None:
return
# libs_dir = os.path.abspath(
# os.path.join(executable_dir(), "..", "..", "Python")
# libs_dirs = [executable_dir()]
# if sys.platform == "darwin":
# # Add .app/Contents/Python to libs_dirs
# libs_dir = os.path.abspath(
# os.path.join(executable_dir(), "..", "Python")
# )
# print(libs_dir, os.path.exists(libs_dir))
# if os.path.exists(libs_dir):
# libs_dirs.append(libs_dir)
# libs_dir = os.path.abspath(
# os.path.join(executable_dir(), "..", "..", "Python")
# )
# print(libs_dir, os.path.exists(libs_dir))
# if os.path.exists(libs_dir):
# libs_dirs.append(libs_dir)
# else:
# libs_dir = os.path.abspath(
# os.path.join(
# executable_dir(), "..", "..", "..", "..", "..", "Python"
# )
# )
# print(libs_dir, os.path.exists(libs_dir))
# if os.path.exists(libs_dir):
# libs_dirs.append(libs_dir)
# for libs_dir in libs_dirs:
# for item in os.listdir(libs_dir):
# if item.endswith(".zip"):
# path = os.path.join(libs_dir, item)
# print("adding", path)
# sys.path.insert(0, path)
def plugin_code_override() -> bool:
return _plugin_code_override
# from importlib.abc import MetaPathFinder
# _python_dir: str
# class OverrideImporter(MetaPathFinder):
# # def find_spec(self, fullname, path, target=None):
# # from importlib.util import spec_from_loader
# # loader = self.find_module(fullname, path)
# # if loader is None:
# # return None
# # spec = spec_from_loader(fullname, loader)
# # print(spec)
# # return spec
# # FIXME: Any
# def find_module(self, fullname: str, path: str) -> Any:
# from importlib.machinery import SourceFileLoader
# print("CustomImporter.find_module", fullname, path)
# # if path is None:
# # raise Exception("")
# if path is None:
# package_path = os.path.join(_python_dir, fullname, "__init__.py")
# print(package_path)
# if os.path.exists(package_path):
# print("->", package_path)
# return SourceFileLoader(fullname, package_path)
# # module_path = os.path.join(_python_dir, f"{fullname}.py")
# # if os.path.exists(module_path):
# # return SourceFileLoader(fullname, module_path)
# else:
# if len(path) == 0:
# return None
# name = fullname.rsplit(".", 1)[-1]
# package_path = os.path.join(path[0], name, "__init__.py")
# print(package_path)
# if os.path.exists(package_path):
# print("->", package_path)
# return SourceFileLoader(fullname, package_path)
# module_path = os.path.join(path[0], f"{name}.py")
# print(module_path)
# if os.path.exists(module_path):
# print("->", module_path)
# return SourceFileLoader(fullname, module_path)
# print("->", None)
# return None
def setup_python_path_frozen() -> None:
"""Allow overriding code from Plugin/Python directory."""
print("setup_python_path_frozen")
# global _python_dir
# base_dir = plugin_dir() or app_dir()
# python_dir = os.path.join(base_dir, "Python")
# # print("Check", python_dir)
# # if os.path.exists(python_dir):
# # # sys.path.insert(0, python_dir)
# # # _plugin_code_override = True
# # _python_dir = python_dir
# # sys.meta_path.insert(0, OverrideImporter())
# # print("sys.meta_path", sys.meta_path)
def setup_python_path() -> None:
# print("setup_python_path")
if is_frozen():
setup_python_path_frozen()
|