summaryrefslogtreecommitdiff
path: root/py_modules
diff options
context:
space:
mode:
authorxXJSONDeruloXx <danielhimebauch@gmail.com>2026-09-10 14:32:00 -0400
committerxXJSONDeruloXx <danielhimebauch@gmail.com>2026-09-10 14:32:00 -0400
commit684929fe850b744ef841475f88cf2a3189fbb986 (patch)
treec2241fc8f5d193963497cce901ea71c1fcc00971 /py_modules
parentde74f0d2499159ed1cf8f628a166302146ae1f13 (diff)
downloaddecky-lsfg-vk-684929fe850b744ef841475f88cf2a3189fbb986.tar.gz
decky-lsfg-vk-684929fe850b744ef841475f88cf2a3189fbb986.zip
refactor: make Flatpak support plugin-level
Diffstat (limited to 'py_modules')
-rw-r--r--py_modules/lsfg_vk/flatpak_service.py466
-rw-r--r--py_modules/lsfg_vk/plugin.py41
-rw-r--r--py_modules/lsfg_vk/steam_service.py39
-rw-r--r--py_modules/lsfg_vk/wrapper_service.py210
4 files changed, 316 insertions, 440 deletions
diff --git a/py_modules/lsfg_vk/flatpak_service.py b/py_modules/lsfg_vk/flatpak_service.py
index f486b74..842d5ca 100644
--- a/py_modules/lsfg_vk/flatpak_service.py
+++ b/py_modules/lsfg_vk/flatpak_service.py
@@ -1,4 +1,4 @@
-"""Flatpak runtime support for classified Steam targets."""
+"""Plugin-level Flatpak capability for the bundled lsfg-vk Vulkan layers."""
from __future__ import annotations
@@ -10,7 +10,7 @@ import shutil
import subprocess
import threading
from pathlib import Path
-from typing import Dict, Optional, Set
+from typing import Dict, Optional, Set, Tuple
from .base_service import BaseService
from .constants import (
@@ -22,15 +22,12 @@ from .constants import (
class FlatpakService(BaseService):
+ """Install the shared Flatpak layer and own only the grants we add."""
+
EXTENSION_ID = "org.freedesktop.Platform.VulkanLayer.lsfgvk"
SUPPORTED_RUNTIMES = ("23.08", "24.08", "25.08")
- DERIVED_RUNTIME_IDS = {"org.gnome.Platform", "org.kde.Platform"}
- RUNTIME_METADATA_SECTION = "Extension org.freedesktop.Platform.GL"
OWNERSHIP_FILENAME = "flatpak_extensions.json"
- OWNERSHIP_VERSION = 1
- APP_ID_PATTERN = re.compile(
- r"^[A-Za-z0-9][A-Za-z0-9-]*(?:\.[A-Za-z0-9][A-Za-z0-9-]*)+$"
- )
+ OWNERSHIP_VERSION = 2
def __init__(self, logger=None):
super().__init__(logger)
@@ -74,12 +71,6 @@ class FlatpakService(BaseService):
return subprocess.run(command, env=env, **kwargs)
@classmethod
- def _validate_app_id(cls, app_id: str) -> str:
- if not isinstance(app_id, str) or not cls.APP_ID_PATTERN.fullmatch(app_id):
- raise ValueError("Invalid Flatpak application ID")
- return app_id
-
- @classmethod
def _validate_runtime(cls, branch: str) -> str:
if branch not in cls.SUPPORTED_RUNTIMES:
raise ValueError(
@@ -89,33 +80,6 @@ class FlatpakService(BaseService):
return branch
@classmethod
- def runtime_branch_from_ref(cls, runtime_ref: str) -> str:
- parts = runtime_ref.strip().split("/") if isinstance(runtime_ref, str) else []
- if len(parts) != 3 or parts[0] != "org.freedesktop.Platform":
- raise ValueError(f"Unsupported Flatpak runtime reference: {runtime_ref}")
- return cls._validate_runtime(parts[2])
-
- @classmethod
- def runtime_branch_from_metadata(cls, metadata: str) -> str:
- section = None
- versions = []
- for raw_line in metadata.splitlines() if isinstance(metadata, str) else []:
- line = raw_line.strip()
- if line.startswith("[") and line.endswith("]"):
- section = line[1:-1].strip()
- continue
- if section != cls.RUNTIME_METADATA_SECTION:
- continue
- key, separator, value = line.partition("=")
- if separator and key.strip() == "versions":
- versions.extend(part.strip() for part in value.split(";"))
- for value in versions:
- for branch in cls.SUPPORTED_RUNTIMES:
- if value == branch or value.startswith(f"{branch}-"):
- return branch
- raise ValueError("Could not determine a supported Freedesktop base runtime from Flatpak metadata")
-
- @classmethod
def _extension_ref(cls, branch: str) -> str:
return f"{cls.EXTENSION_ID}/x86_64/{cls._validate_runtime(branch)}"
@@ -145,26 +109,44 @@ class FlatpakService(BaseService):
installed.add(fields[2])
return installed
- def _owned_branches(self) -> Set[str]:
+ @staticmethod
+ def _validate_filesystem_path(value: object) -> str:
+ if not isinstance(value, str) or not value or "\x00" in value:
+ raise ValueError("Flatpak filesystem ownership entries must be non-empty strings")
+ path = Path(value)
+ if not path.is_absolute() or str(path) != value:
+ raise ValueError("Flatpak filesystem ownership entries must be normalized absolute paths")
+ return value
+
+ def _read_ownership(self) -> Tuple[Set[str], Set[str]]:
path = self.ownership_path
if not path.exists() and not path.is_symlink():
- return set()
+ return set(), set()
if path.is_symlink() or not path.is_file():
raise RuntimeError("Flatpak ownership metadata is not a regular file")
try:
data = json.loads(path.read_text(encoding="utf-8"))
+ version = data.get("version")
branches = data.get("plugin_owned_branches")
- if data.get("version") != self.OWNERSHIP_VERSION or not isinstance(branches, list):
+ filesystems = data.get("plugin_owned_filesystems", [])
+ if version not in (1, self.OWNERSHIP_VERSION) or not isinstance(branches, list):
+ raise ValueError("invalid ownership metadata")
+ if version == self.OWNERSHIP_VERSION and not isinstance(filesystems, list):
+ raise ValueError("invalid ownership metadata")
+ owned_branches = {self._validate_runtime(branch) for branch in branches}
+ if len(owned_branches) != len(branches):
raise ValueError("invalid ownership metadata")
- owned = {self._validate_runtime(branch) for branch in branches}
- if len(owned) != len(branches):
+ owned_filesystems = {
+ self._validate_filesystem_path(filesystem) for filesystem in filesystems
+ }
+ if len(owned_filesystems) != len(filesystems):
raise ValueError("invalid ownership metadata")
- return owned
+ return owned_branches, owned_filesystems
except (OSError, json.JSONDecodeError, TypeError, ValueError) as error:
raise RuntimeError(f"Could not trust Flatpak ownership metadata: {error}") from error
- def _write_owned_branches(self, branches: Set[str]) -> None:
- if not branches:
+ def _write_ownership(self, branches: Set[str], filesystems: Set[str]) -> None:
+ if not branches and not filesystems:
self.ownership_path.unlink(missing_ok=True)
return
self._write_file(
@@ -173,136 +155,192 @@ class FlatpakService(BaseService):
{
"version": self.OWNERSHIP_VERSION,
"plugin_owned_branches": sorted(branches),
+ "plugin_owned_filesystems": sorted(filesystems),
},
indent=2,
) + "\n",
)
- def get_extension_status(self):
+ def _configured_lossless_scaling_directory(self) -> Path:
+ default = self.user_home / ".local/share/Steam/steamapps/common/Lossless Scaling"
+ if not self.config_file_path.exists():
+ return default
try:
- available = self.check_flatpak_available()
- installed = self._installed_extension_branches() if available else set()
- return self._success_response(
- dict,
- "Flatpak runtime extension status retrieved" if available else "Flatpak is not available",
- available=available,
- extension_id=self.EXTENSION_ID,
- supported_branches=list(self.SUPPORTED_RUNTIMES),
- installed_branches=sorted(installed),
+ content = self.config_file_path.read_text(encoding="utf-8")
+ match = re.search(
+ r'(?m)^[ \t]*dll[ \t]*=[ \t]*"((?:\\.|[^"\\])*)"',
+ content,
)
+ if not match:
+ return default
+ configured_dll = json.loads('"' + match.group(1) + '"')
+ if not configured_dll:
+ return default
+ if configured_dll.startswith("~/"):
+ return self.user_home / configured_dll[2:]
+ configured_path = Path(configured_dll)
+ return configured_path.parent if configured_path.is_absolute() else default
+ except Exception:
+ return default
+
+ def _filesystem_grant_paths(self) -> Tuple[str, ...]:
+ paths = (
+ str(self.config_dir),
+ str(self._configured_lossless_scaling_directory()),
+ )
+ return tuple(dict.fromkeys(paths))
+
+ @staticmethod
+ def _parse_filesystems(output: str) -> Dict[str, str]:
+ entries: Dict[str, str] = {}
+ for raw_line in output.splitlines() if isinstance(output, str) else []:
+ line = raw_line.strip()
+ if not line.startswith("filesystems="):
+ continue
+ for raw_entry in line.partition("=")[2].split(";"):
+ entry = raw_entry.strip()
+ if not entry:
+ continue
+ for mode in ("ro", "rw", "create"):
+ suffix = f":{mode}"
+ if entry.endswith(suffix):
+ entries[entry[:-len(suffix)]] = mode
+ break
+ else:
+ entries[entry] = "rw"
+ return entries
+
+ def _global_filesystems(self) -> Dict[str, str]:
+ result = self._run_flatpak_command(
+ ["override", "--user", "--show"],
+ capture_output=True,
+ text=True,
+ )
+ if result.returncode != 0:
+ raise OSError(result.stderr.strip() or "Could not read Flatpak global overrides")
+ return self._parse_filesystems(result.stdout)
+
+ def _status(self, message: Optional[str] = None):
+ available = self.check_flatpak_available()
+ owned_branches, owned_filesystems = self._read_ownership()
+ installed = self._installed_extension_branches() if available else set()
+ filesystems = self._global_filesystems() if available else {}
+ grant_paths = self._filesystem_grant_paths()
+ filesystem_grants = [
+ {
+ "path": path,
+ "present": path in filesystems,
+ "read_only": filesystems.get(path) == "ro",
+ }
+ for path in grant_paths
+ ]
+ ready = available and all(branch in installed for branch in self.SUPPORTED_RUNTIMES) and all(
+ grant["present"] for grant in filesystem_grants
+ )
+ return self._success_response(
+ dict,
+ message or ("Flatpak support is ready" if ready else "Flatpak support needs setup"),
+ available=available,
+ ready=ready,
+ extension_id=self.EXTENSION_ID,
+ supported_branches=list(self.SUPPORTED_RUNTIMES),
+ installed_branches=sorted(installed),
+ filesystem_grants=filesystem_grants,
+ missing_filesystem_grants=[
+ grant["path"] for grant in filesystem_grants if not grant["present"]
+ ],
+ plugin_owned_branches=sorted(owned_branches),
+ plugin_owned_filesystems=sorted(owned_filesystems),
+ )
+
+ def get_extension_status(self):
+ try:
+ if not self.check_flatpak_available():
+ return self._status("Flatpak is not available")
+ return self._status()
except Exception as error:
return self._error_response(
dict,
str(error),
available=False,
+ ready=False,
extension_id=self.EXTENSION_ID,
supported_branches=list(self.SUPPORTED_RUNTIMES),
installed_branches=[],
+ filesystem_grants=[],
+ missing_filesystem_grants=list(self._filesystem_grant_paths()),
)
get_flatpak_support_status = get_extension_status
- def _resolve_runtime(self, app_id: str):
- self._validate_app_id(app_id)
- if not self.check_flatpak_available():
- raise FileNotFoundError("Flatpak is not available on this system")
+ def _install_branch(self, branch: str) -> None:
+ bundle = self._bundled_extension_path(branch)
+ if not bundle.is_file():
+ raise FileNotFoundError(
+ f"Bundled Flatpak extension not found at {bundle}; reinstall the plugin"
+ )
result = self._run_flatpak_command(
- ["info", "--show-runtime", app_id],
+ ["install", "--user", "--noninteractive", "--or-update", str(bundle)],
capture_output=True,
text=True,
)
if result.returncode != 0:
- raise OSError(result.stderr.strip() or f"Could not inspect Flatpak app {app_id}")
- runtime = result.stdout.strip().splitlines()[0] if result.stdout.strip() else ""
- parts = runtime.split("/")
- if len(parts) != 3:
- raise ValueError(f"Unsupported Flatpak runtime reference: {runtime}")
- if parts[0] == "org.freedesktop.Platform":
- branch = self._validate_runtime(parts[2])
- elif parts[0] in self.DERIVED_RUNTIME_IDS:
- metadata_result = self._run_flatpak_command(
- ["info", "--show-metadata", runtime],
- capture_output=True,
- text=True,
+ raise OSError(result.stderr.strip() or "Flatpak installation failed")
+ if branch not in self._installed_extension_branches("user"):
+ raise RuntimeError(
+ f"Flatpak install completed but {self._extension_ref(branch)} was not visible afterwards"
)
- if metadata_result.returncode != 0:
- raise OSError(
- metadata_result.stderr.strip()
- or f"Could not inspect Flatpak runtime {runtime}"
- )
- branch = self.runtime_branch_from_metadata(metadata_result.stdout)
- else:
- raise ValueError(f"Unsupported Flatpak runtime reference: {runtime}")
- return runtime, branch
- def resolve_app_support(self, app_id: str):
+ def _add_filesystem_grant(self, path: str) -> None:
+ result = self._run_flatpak_command(
+ ["override", "--user", f"--filesystem={path}:ro"],
+ capture_output=True,
+ text=True,
+ )
+ if result.returncode != 0:
+ raise OSError(result.stderr.strip() or f"Could not grant Flatpak access to {path}")
+ current = self._global_filesystems()
+ if current.get(path) != "ro":
+ raise RuntimeError(f"Flatpak did not confirm the read-only grant for {path}")
+
+ def ensure_plugin_support(self):
+ """Make the shared layer and exact read-only grants available once."""
try:
- app_id = self._validate_app_id(app_id)
- runtime, branch = self._resolve_runtime(app_id)
- installed = self._installed_extension_branches()
- ready = branch in installed
- return self._success_response(
- dict,
- f"lsfg-vk support is ready for {app_id}" if ready
- else f"lsfg-vk runtime extension {branch} is required for {app_id}",
- flatpak_app_id=app_id,
- runtime=runtime,
- runtime_branch=branch,
- support_status="ready" if ready else "needs-runtime",
- extension_installed=ready,
- installed_branches=sorted(installed),
- )
- except ValueError as error:
- return self._success_response(
- dict,
- str(error),
- flatpak_app_id=app_id,
- runtime=None,
- runtime_branch=None,
- support_status="unsupported",
- extension_installed=False,
- installed_branches=[],
- error=str(error),
- )
+ with self._lock:
+ if not self.check_flatpak_available():
+ return self._status("Flatpak is not available")
+ owned_branches, owned_filesystems = self._read_ownership()
+ installed = self._installed_extension_branches()
+ for branch in self.SUPPORTED_RUNTIMES:
+ if branch in installed:
+ continue
+ self._install_branch(branch)
+ installed.add(branch)
+ owned_branches.add(branch)
+ self._write_ownership(owned_branches, owned_filesystems)
+
+ current_filesystems = self._global_filesystems()
+ for path in self._filesystem_grant_paths():
+ if path in current_filesystems:
+ continue
+ self._add_filesystem_grant(path)
+ owned_filesystems.add(path)
+ self._write_ownership(owned_branches, owned_filesystems)
+
+ return self._status("Flatpak support is ready")
except Exception as error:
return self._error_response(
dict,
str(error),
- flatpak_app_id=app_id,
- runtime=None,
- runtime_branch=None,
- support_status="error",
- extension_installed=False,
+ available=self.check_flatpak_available(),
+ ready=False,
+ extension_id=self.EXTENSION_ID,
+ supported_branches=list(self.SUPPORTED_RUNTIMES),
installed_branches=[],
+ filesystem_grants=[],
+ missing_filesystem_grants=list(self._filesystem_grant_paths()),
)
- def install_extension(self, branch: str):
- try:
- branch = self._validate_runtime(branch)
- if not self.check_flatpak_available():
- raise FileNotFoundError("Flatpak is not available on this system")
- with self._lock:
- if branch in self._installed_extension_branches():
- return self._extension_result(branch, True, False, "already installed")
- bundle = self._bundled_extension_path(branch)
- if not bundle.is_file():
- raise FileNotFoundError(f"Bundled Flatpak extension not found at {bundle}; reinstall the plugin")
- result = self._run_flatpak_command(
- ["install", "--user", "--noninteractive", "--or-update", str(bundle)],
- capture_output=True,
- text=True,
- )
- if result.returncode != 0:
- raise OSError(result.stderr.strip() or "Flatpak installation failed")
- if branch not in self._installed_extension_branches("user"):
- raise RuntimeError(f"Flatpak install completed but {self._extension_ref(branch)} was not visible afterwards")
- owned = self._owned_branches()
- owned.add(branch)
- self._write_owned_branches(owned)
- return self._extension_result(branch, True, False, "installed")
- except Exception as error:
- return self._error_response(dict, str(error), runtime_branch=branch, installed=False, enabled=False)
-
def _remove_extension(self, branch: str) -> bool:
if branch not in self._installed_extension_branches("user"):
return False
@@ -314,111 +352,89 @@ class FlatpakService(BaseService):
if result.returncode != 0:
raise OSError(result.stderr.strip() or "Flatpak uninstall failed")
if branch in self._installed_extension_branches("user"):
- raise RuntimeError(f"Flatpak uninstall completed but {self._extension_ref(branch)} is still installed")
- return True
-
- def _extension_result(self, branch: str, installed: bool, removed: bool, verb: str):
- return self._success_response(
- dict,
- f"lsfg-vk {branch} runtime extension {verb}",
- runtime_branch=branch,
- installed=installed,
- enabled=installed,
- removed=removed,
- )
-
- def uninstall_extension(self, branch: str):
- try:
- branch = self._validate_runtime(branch)
- if not self.check_flatpak_available():
- raise FileNotFoundError("Flatpak is not available on this system")
- with self._lock:
- owned = self._owned_branches()
- if branch not in owned:
- installed = branch in self._installed_extension_branches()
- return self._extension_result(branch, installed, False, "preserved (not plugin-owned)")
- removed = self._remove_extension(branch)
- owned.remove(branch)
- self._write_owned_branches(owned)
- installed = branch in self._installed_extension_branches()
- return self._extension_result(branch, installed, removed, "uninstalled")
- except Exception as error:
- return self._error_response(
- dict,
- str(error),
- runtime_branch=branch,
- removed=False,
- installed=False,
- enabled=False,
+ raise RuntimeError(
+ f"Flatpak uninstall completed but {self._extension_ref(branch)} is still installed"
)
+ return True
- def ensure_extension(self, branch: str):
- try:
- branch = self._validate_runtime(branch)
- if branch in self._installed_extension_branches():
- return self._extension_result(branch, True, False, "is ready")
- except Exception as error:
- return self._error_response(dict, str(error), runtime_branch=branch, support_status="error")
- return self.install_extension(branch)
-
- def ensure_app_support(self, app_id: str):
- resolved = self.resolve_app_support(app_id)
- if not resolved.get("success") or resolved.get("support_status") != "needs-runtime":
- return resolved
- result = self.ensure_extension(resolved["runtime_branch"])
- if not result.get("success"):
- return self._error_response(
- dict,
- result.get("error") or "Could not install the required Flatpak runtime extension",
- flatpak_app_id=app_id,
- runtime=resolved.get("runtime"),
- runtime_branch=resolved.get("runtime_branch"),
- support_status="error",
- extension_installed=False,
+ def _remove_filesystem_grant(self, path: str) -> bool:
+ current = self._global_filesystems()
+ if path not in current:
+ return False
+ if current[path] != "ro":
+ raise RuntimeError(
+ f"Refusing to remove Flatpak grant for {path}; its permissions changed externally"
)
- return self.resolve_app_support(app_id)
-
- def set_extension_enabled(self, branch: str, enabled: bool):
- if type(enabled) is not bool:
- return self._error_response(dict, "enabled must be a boolean", runtime_branch=branch, installed=False, enabled=False)
- return self.install_extension(branch) if enabled else self.uninstall_extension(branch)
+ result = self._run_flatpak_command(
+ ["override", "--user", f"--nofilesystem={path}"],
+ capture_output=True,
+ text=True,
+ )
+ if result.returncode != 0:
+ raise OSError(result.stderr.strip() or f"Could not remove Flatpak access to {path}")
+ if path in self._global_filesystems():
+ raise RuntimeError(f"Flatpak filesystem grant for {path} is still present")
+ return True
def remove_plugin_owned_extensions(self):
+ """Remove only positively owned user branches and exact filesystem grants."""
try:
with self._lock:
- owned = self._owned_branches()
- if not owned:
+ owned_branches, owned_filesystems = self._read_ownership()
+ if not owned_branches and not owned_filesystems:
return self._success_response(
dict,
- "No plugin-owned Flatpak extensions to remove",
+ "No plugin-owned Flatpak state to remove",
removed_branches=[],
preserved_branches=[],
+ removed_filesystem_grants=[],
+ preserved_filesystem_grants=[],
ownership_uncertain=False,
)
if not self.check_flatpak_available():
- raise RuntimeError("Flatpak is not available; plugin-owned extension metadata was preserved")
- removed, failures = [], []
- for branch in sorted(owned):
+ raise RuntimeError(
+ "Flatpak is not available; plugin-owned state metadata was preserved"
+ )
+
+ removed_branches, preserved_branches = [], []
+ remaining_branches = set(owned_branches)
+ for branch in sorted(owned_branches):
try:
self._remove_extension(branch)
- removed.append(branch)
+ removed_branches.append(branch)
+ remaining_branches.discard(branch)
+ except Exception as error:
+ preserved_branches.append(f"{branch}: {error}")
+
+ removed_filesystems, preserved_filesystems = [], []
+ remaining_filesystems = set(owned_filesystems)
+ for path in sorted(owned_filesystems):
+ try:
+ self._remove_filesystem_grant(path)
+ removed_filesystems.append(path)
+ remaining_filesystems.discard(path)
except Exception as error:
- failures.append(f"{branch}: {error}")
- remaining = owned - set(removed)
- self._write_owned_branches(remaining)
+ preserved_filesystems.append(f"{path}: {error}")
+
+ self._write_ownership(remaining_branches, remaining_filesystems)
+ failures = [*preserved_branches, *preserved_filesystems]
if failures:
return self._error_response(
dict,
"; ".join(failures),
- removed_branches=removed,
- preserved_branches=sorted(remaining),
+ removed_branches=removed_branches,
+ preserved_branches=preserved_branches,
+ removed_filesystem_grants=removed_filesystems,
+ preserved_filesystem_grants=preserved_filesystems,
ownership_uncertain=False,
)
return self._success_response(
dict,
- "Plugin-owned Flatpak extensions removed",
- removed_branches=removed,
+ "Plugin-owned Flatpak state removed",
+ removed_branches=removed_branches,
preserved_branches=[],
+ removed_filesystem_grants=removed_filesystems,
+ preserved_filesystem_grants=[],
ownership_uncertain=False,
)
except Exception as error:
@@ -427,5 +443,7 @@ class FlatpakService(BaseService):
str(error),
removed_branches=[],
preserved_branches=[],
+ removed_filesystem_grants=[],
+ preserved_filesystem_grants=[],
ownership_uncertain=True,
)
diff --git a/py_modules/lsfg_vk/plugin.py b/py_modules/lsfg_vk/plugin.py
index 13df7a4..282ed96 100644
--- a/py_modules/lsfg_vk/plugin.py
+++ b/py_modules/lsfg_vk/plugin.py
@@ -24,7 +24,14 @@ class Plugin:
self.wrapper_service = WrapperService()
async def install_lsfg_vk(self):
- return self.installation_service.install()
+ result = self.installation_service.install()
+ if not result.get("success"):
+ return result
+ flatpak = self.flatpak_service.ensure_plugin_support()
+ result["flatpak_support"] = flatpak
+ if not flatpak.get("success"):
+ decky.logger.warning(f"Flatpak support setup was not completed: {flatpak.get('error')}")
+ return result
async def check_lsfg_vk_installed(self):
return self.installation_service.check_installation()
@@ -36,21 +43,7 @@ class Plugin:
return self.configuration_service.get_game_configs()
async def get_installed_games(self):
- result = self.steam_service.get_installed_games()
- if not result.get("success"):
- return result
- cache: Dict[str, Dict[str, Any]] = {}
- for game in result.get("games", []):
- transport = game.get("transport", {})
- if transport.get("kind") != "flatpak":
- continue
- app_id = transport.get("flatpakAppId")
- if not app_id:
- continue
- if app_id not in cache:
- cache[app_id] = self.flatpak_service.resolve_app_support(app_id)
- game["flatpakSupport"] = cache[app_id]
- return result
+ return self.steam_service.get_installed_games()
async def update_game_config(self, appid: str, game_name: str, config: Dict[str, Any]):
return self.configuration_service.update_game_config(appid, game_name, config)
@@ -150,19 +143,21 @@ class Plugin:
async def get_flatpak_support_status(self):
return self.flatpak_service.get_flatpak_support_status()
- async def ensure_flatpak_support(self, flatpak_app_id: str):
- return self.flatpak_service.ensure_app_support(flatpak_app_id)
-
- async def repair_flatpak_support(self, flatpak_app_id: str):
- return self.flatpak_service.ensure_app_support(flatpak_app_id)
+ async def ensure_flatpak_support(self):
+ return self.flatpak_service.ensure_plugin_support()
- async def set_flatpak_extension_enabled(self, version: str, enabled: bool):
- return self.flatpak_service.set_extension_enabled(version, enabled)
+ async def repair_flatpak_support(self):
+ return self.flatpak_service.ensure_plugin_support()
async def _main(self):
repair = self.wrapper_service.repair()
if not repair.get("success"):
decky.logger.error(f"Could not repair lsfg workaround wrapper: {repair.get('error')}")
+ installation = self.installation_service.check_installation()
+ if installation.get("installed"):
+ flatpak = self.flatpak_service.ensure_plugin_support()
+ if not flatpak.get("success"):
+ decky.logger.warning(f"Could not ensure Flatpak support: {flatpak.get('error')}")
decky.logger.info("decky-lsfg-vk plugin loaded")
async def _unload(self):
diff --git a/py_modules/lsfg_vk/steam_service.py b/py_modules/lsfg_vk/steam_service.py
index a952fcb..a7c0083 100644
--- a/py_modules/lsfg_vk/steam_service.py
+++ b/py_modules/lsfg_vk/steam_service.py
@@ -10,8 +10,11 @@ from .constants import (
WRAPPER_FILENAME,
)
-_FLATPAK_APP_ID = re.compile(r"^[A-Za-z0-9][A-Za-z0-9-]*(?:\.[A-Za-z0-9][A-Za-z0-9-]*)+$")
-_WRAPPER_TOKEN = f"~/{WRAPPER_FILENAME}"
+
+_DIRECT_FLATPAK_TARGETS = {
+ ("/usr/bin/flatpak",),
+ ("~/.lsfg", "/usr/bin/flatpak"),
+}
def _split_command(value: Optional[str]) -> Optional[list[str]]:
@@ -23,34 +26,14 @@ def _split_command(value: Optional[str]) -> Optional[list[str]]:
return None
-def _is_managed_wrapper(value: str) -> bool:
- if value in {_WRAPPER_TOKEN, f"$HOME/{WRAPPER_FILENAME}"}:
- return True
- path = Path(value)
- return path.is_absolute() and path.name == WRAPPER_FILENAME
-
+def classify_shortcut_transport(executable: Optional[str], _launch_options: Optional[str] = None) -> Dict[str, object]:
+ """Recognize only the direct Flatpak executable Target.
-def classify_shortcut_transport(executable: Optional[str], launch_options: Optional[str] = None) -> Dict[str, object]:
+ Launch scripts and wrapper commands remain host targets. Their launch
+ options are intentionally opaque to the plugin.
+ """
executable_tokens = _split_command(executable)
- option_tokens = _split_command(launch_options)
- if executable_tokens is None or option_tokens is None or not executable_tokens:
- return {"kind": "host"}
- direct_flatpak = executable_tokens[0] in {"flatpak", "/usr/bin/flatpak"}
- managed_wrapper = len(executable_tokens) == 1 and _is_managed_wrapper(executable_tokens[0])
- if not direct_flatpak and not managed_wrapper:
- return {"kind": "host"}
- arguments = [*executable_tokens[1:], *option_tokens]
- if not arguments or arguments[0] != "run":
- return {"kind": "host"}
- for argument in arguments[1:]:
- if argument == "--" or argument.startswith("-"):
- continue
- return (
- {"kind": "flatpak", "flatpakAppId": argument}
- if _FLATPAK_APP_ID.fullmatch(argument)
- else {"kind": "host"}
- )
- return {"kind": "host"}
+ return {"kind": "flatpak"} if tuple(executable_tokens or ()) in _DIRECT_FLATPAK_TARGETS else {"kind": "host"}
def _first_string(values: Dict[str, object], *keys: str) -> Optional[str]:
diff --git a/py_modules/lsfg_vk/wrapper_service.py b/py_modules/lsfg_vk/wrapper_service.py
index 980f7ae..807a1c3 100644
--- a/py_modules/lsfg_vk/wrapper_service.py
+++ b/py_modules/lsfg_vk/wrapper_service.py
@@ -6,7 +6,6 @@ import json
import re
import shlex
import threading
-from pathlib import Path
from typing import Any, Dict, Optional, Tuple
from .base_service import BaseService
@@ -43,6 +42,7 @@ class WrapperService(BaseService):
"__GLX_VENDOR_LIBRARY_NAME",
"GALLIUM_DRIVER",
"DXVK_FRAME_RATE",
+ "LSFGVK_FLATPAK",
)
def __init__(self, logger=None):
@@ -92,44 +92,28 @@ class WrapperService(BaseService):
if not isinstance(raw, dict):
raise ValueError("Workaround transport must be an object")
kind = raw.get("kind")
- if kind == "host":
- return {"kind": "host"}
- if kind == "flatpak":
- app_id = raw.get("flatpakAppId")
- if (
- not isinstance(app_id, str)
- or not re.fullmatch(
- r"^[A-Za-z0-9][A-Za-z0-9-]*(?:\.[A-Za-z0-9][A-Za-z0-9-]*)+$",
- app_id,
- )
- ):
- raise ValueError("Flatpak transport requires a valid application ID")
- return {"kind": "flatpak", "flatpakAppId": app_id}
+ if kind in ("host", "flatpak"):
+ # Flatpak app IDs are deliberately not part of plugin state. The
+ # only special target is the direct /usr/bin/flatpak shortcut.
+ return {"kind": kind}
raise ValueError("Workaround transport must be host or flatpak")
@classmethod
def _validate_entry(cls, raw: Any) -> Dict[str, Any]:
if not isinstance(raw, dict):
raise ValueError("Workaround AppID entry must be an object")
+ transport = cls._validate_transport(raw.get("transport"))
entry = {
"state": cls._validate_state(raw.get("state")),
"command_token_added": raw.get("command_token_added", False),
- # Version 1 entries had no transport field. They are preserved as
- # host entries until the shortcut is explicitly repaired with the
- # backend's classified transport.
- "transport": cls._validate_transport(raw.get("transport")),
}
if type(entry["command_token_added"]) is not bool:
raise ValueError("command_token_added must be a boolean")
- if entry["transport"]["kind"] == "flatpak" and "shortcut_exe" in raw and raw["shortcut_exe"] is not None:
- shortcut_exe = raw["shortcut_exe"]
- if (
- not isinstance(shortcut_exe, str)
- or not shortcut_exe.startswith("/")
- or "\x00" in shortcut_exe
- or not shortcut_exe.strip()
- ):
- raise ValueError("shortcut_exe must be an absolute executable path")
+ if transport["kind"] == "flatpak":
+ shortcut_exe = raw.get("shortcut_exe")
+ if shortcut_exe != "/usr/bin/flatpak":
+ raise ValueError("Flatpak workaround state must save /usr/bin/flatpak")
+ entry["transport"] = transport
entry["shortcut_exe"] = shortcut_exe
return entry
@@ -160,11 +144,11 @@ class WrapperService(BaseService):
if self.sidecar_path.is_symlink() or not self.sidecar_path.is_file():
raise RuntimeError("Workaround state path is not a regular file")
try:
- raw = json.loads(self.sidecar_path.read_text(encoding="utf-8"))
+ content = self.sidecar_path.read_text(encoding="utf-8")
+ raw = json.loads(content)
except (OSError, json.JSONDecodeError) as error:
raise RuntimeError(f"Could not read workaround state: {error}") from error
- document = self._validate_document(raw)
- return document, True, self.sidecar_path.read_text(encoding="utf-8")
+ return self._validate_document(raw), True, content
def _wrapper_marker(self) -> bool:
if self.wrapper_path.is_symlink() or not self.wrapper_path.exists():
@@ -190,20 +174,19 @@ class WrapperService(BaseService):
def _shell(value: str) -> str:
return shlex.quote(value)
- @staticmethod
- def _direct_flatpak_tokens(value: str) -> Optional[list[str]]:
- """Parse the supported full executable form: /usr/bin/flatpak run APP."""
- try:
- tokens = shlex.split(value, posix=True)
- except ValueError:
- return None
- if len(tokens) >= 3 and Path(tokens[0]).name == "flatpak" and tokens[1] == "run":
- return tokens
- return None
-
- @classmethod
- def _state_lines(cls, state: Dict[str, Any], shortcut_exe: Optional[str]) -> list[str]:
- lines = [" unset " + " ".join(cls.MANAGED_ENV_KEYS)]
+ def _state_lines(self, state: Dict[str, Any], shortcut_exe: Optional[str]) -> list[str]:
+ lines = [
+ " unset " + " ".join(self.MANAGED_ENV_KEYS),
+ ' SteamAppId="$appid"',
+ " export SteamAppId",
+ f" LSFGVK_CONFIG={self._shell(str(self.config_file_path))}",
+ " export LSFGVK_CONFIG",
+ ]
+ if shortcut_exe:
+ lines.extend([
+ " LSFGVK_FLATPAK=1",
+ " export LSFGVK_FLATPAK",
+ ])
if state["disableGamescopeWsi"]:
lines.extend([" ENABLE_GAMESCOPE_WSI=0", " export ENABLE_GAMESCOPE_WSI"])
if state["disableHdr"]:
@@ -235,68 +218,9 @@ class WrapperService(BaseService):
" fi",
" export DXVK_CONFIG",
])
- lines.append(f" shortcut_exe={cls._shell(shortcut_exe or '')}")
+ lines.append(f" shortcut_exe={self._shell(shortcut_exe or '')}")
return lines
- def _dll_directory(self) -> Path:
- if self.config_file_path.exists():
- try:
- content = self.config_file_path.read_text(encoding="utf-8")
- match = re.search(
- r'(?m)^[ \t]*dll[ \t]*=[ \t]*"((?:\\.|[^"\\])*)"',
- content,
- )
- if match:
- configured_dll = json.loads('"' + match.group(1) + '"')
- if configured_dll:
- return Path(configured_dll).parent
- except Exception:
- pass
- return self.user_home / ".local/share/Steam/steamapps/common/Lossless Scaling"
-
- def _flatpak_args(self, state: Dict[str, Any]) -> list[str]:
- config_dir = str(self.config_dir)
- config_file = str(self.config_file_path)
- dll_dir = str(self._dll_directory())
- args = [
- self._shell(f"--filesystem={config_dir}:rw"),
- self._shell(f"--filesystem={dll_dir}:ro"),
- self._shell(f"--env=LSFGVK_CONFIG={config_file}"),
- '"--env=LSFGVK_FLATPAK=1"',
- '"--env=SteamAppId=$appid"',
- '"--unset-env=DISABLE_LSFGVK" "--unset-env=DISABLE_LSFG"',
- '"--unset-env=DISABLE_GAMESCOPE_WSI"',
- '"--unset-env=ENABLE_GAMESCOPE_WSI"' if not state["disableGamescopeWsi"] else
- '"--env=ENABLE_GAMESCOPE_WSI=0"',
- '"--unset-env=DXVK_HDR"' if not state["disableHdr"] else
- '"--env=DXVK_HDR=0"',
- '"--unset-env=SteamDeck"' if not state["disableSteamdeckMode"] else
- '"--env=SteamDeck=0"',
- '"--unset-env=DISABLE_VKBASALT" "--unset-env=ENABLE_VKBASALT"',
- ]
- if state["disableVkbasalt"]:
- args.append('"--env=DISABLE_VKBASALT=1"')
- args.extend([
- '"--unset-env=MESA_LOADER_DRIVER_OVERRIDE" "--unset-env=__GLX_VENDOR_LIBRARY_NAME" "--unset-env=GALLIUM_DRIVER"',
- ])
- if state["enableZink"]:
- args.extend([
- '"--env=__GLX_VENDOR_LIBRARY_NAME=mesa"',
- '"--env=MESA_LOADER_DRIVER_OVERRIDE=zink"',
- '"--env=GALLIUM_DRIVER=zink"',
- ])
- args.extend([
- '"--unset-env=DXVK_FRAME_RATE"',
- ])
- static_args = " ".join(args)
- return [
- ' if [ -n "${DXVK_CONFIG+x}" ]; then',
- f' set -- "$flatpak_command" {static_args} "--env=DXVK_CONFIG=$DXVK_CONFIG" "$@"',
- " else",
- f' set -- "$flatpak_command" {static_args} "$@"',
- " fi",
- ]
-
def _render_wrapper(self, document: Dict[str, Any]) -> str:
lines = [
"#!/bin/sh",
@@ -332,55 +256,9 @@ class WrapperService(BaseService):
"esac",
"",
'if [ -n "$shortcut_exe" ]; then',
- ])
- # The arguments are emitted per branch below so the values are static and
- # the wrapper never needs a JSON parser or another helper executable.
- lines.append(' case "$appid" in')
- for appid in sorted(document["apps"], key=lambda value: int(value)):
- entry = document["apps"][appid]
- transport = entry.get("transport", {"kind": "host"})
- if transport.get("kind") != "flatpak":
- continue
- shortcut_exe = entry.get("shortcut_exe", "")
- direct_flatpak_tokens = self._direct_flatpak_tokens(shortcut_exe)
- if direct_flatpak_tokens is None and Path(shortcut_exe).name != "flatpak":
- raise ValueError(
- f"Flatpak target {appid} does not use a direct flatpak executable"
- )
- lines.append(f" {appid})")
- lines.extend([
- *(
- [
- f" shortcut_exe={self._shell(direct_flatpak_tokens[0])}",
- " set -- "
- + " ".join(self._shell(token) for token in direct_flatpak_tokens[1:])
- + ' "$@"',
- ]
- if direct_flatpak_tokens
- else []
- ),
- ' if [ "${1-}" != "run" ]; then',
- ' echo "lsfg-vk: Flatpak shortcut must use direct flatpak run transport" >&2',
- " exit 64",
- " fi",
- ' flatpak_command="$1"',
- " shift",
- " flatpak_target=",
- ' for flatpak_arg in "$@"; do',
- ' case "$flatpak_arg" in',
- ' -*) ;;',
- ' *) flatpak_target="$flatpak_arg"; break ;;',
- " esac",
- " done",
- f' if [ "$flatpak_target" != {self._shell(transport["flatpakAppId"])} ]; then',
- ' echo "lsfg-vk: Flatpak shortcut application ID changed externally" >&2',
- " exit 64",
- " fi",
- ])
- lines.extend(self._flatpak_args(entry["state"]))
- lines.append(" ;;")
- lines.extend([
- " esac",
+ ' if [ "${1-}" = "$shortcut_exe" ]; then',
+ " shift",
+ " fi",
' exec "$shortcut_exe" "$@"',
"fi",
'exec "$@"',
@@ -396,7 +274,11 @@ class WrapperService(BaseService):
old_sidecar_exists = self.sidecar_path.exists()
old_sidecar = self.sidecar_path.read_text(encoding="utf-8") if old_sidecar_exists else None
old_wrapper_exists = self.wrapper_path.exists() or self.wrapper_path.is_symlink()
- old_wrapper = self.wrapper_path.read_text(encoding="utf-8") if old_wrapper_exists and not self.wrapper_path.is_symlink() else None
+ old_wrapper = (
+ self.wrapper_path.read_text(encoding="utf-8")
+ if old_wrapper_exists and not self.wrapper_path.is_symlink()
+ else None
+ )
try:
self._write_document(document)
self._write_file(self.wrapper_path, self._render_wrapper(document), 0o755)
@@ -465,24 +347,22 @@ class WrapperService(BaseService):
document, _, _ = self._read_document()
previous_entry = document["apps"].get(normalized)
selected_transport = self._validate_transport(
- transport
- if transport is not None
- else (
- previous_entry.get("transport")
- if previous_entry
- else None
+ transport if transport is not None else (
+ previous_entry.get("transport") if previous_entry else None
)
)
entry: Dict[str, Any] = {
"state": validated_state,
"command_token_added": bool(command_token_added),
- "transport": selected_transport,
}
if selected_transport["kind"] == "flatpak":
- if shortcut_exe is not None:
- entry = self._validate_entry({**entry, "shortcut_exe": shortcut_exe})
- elif previous_entry and "shortcut_exe" in previous_entry:
- entry["shortcut_exe"] = previous_entry["shortcut_exe"]
+ selected_shortcut = shortcut_exe or (
+ previous_entry.get("shortcut_exe") if previous_entry else None
+ )
+ if selected_shortcut != "/usr/bin/flatpak":
+ raise ValueError("Flatpak workaround state must save /usr/bin/flatpak")
+ entry["transport"] = selected_transport
+ entry["shortcut_exe"] = selected_shortcut
document["apps"][normalized] = entry
self._write_pair(document)
return self._response(document, normalized)