summaryrefslogtreecommitdiff
path: root/py_modules/lsfg_vk/plugin.py
blob: 76a42501daf8cfb74e9324f2cddade5fce317809 (plain)
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
"""
Main plugin class for the lsfg-vk Decky Loader plugin.

This plugin provides services for installing and managing the lsfg-vk 
Vulkan layer for frame generation on Steam Deck.
"""

import os
from typing import Any, Dict, Optional

import decky

from .installation import InstallationService
from .configuration import ConfigurationService
from .flatpak_service import FlatpakService
from .runtime_service import RuntimeService
from .steam_service import SteamService
from .wrapper_service import WrapperService


class Plugin:
    """
    Main plugin class for lsfg-vk management.
    
    This class provides a unified interface for installation, configuration,
    and Flatpak management services. It implements the Decky Loader plugin lifecycle
    methods (_main, _unload, _uninstall, _migration).
    """
    
    def __init__(self):
        """Initialize the plugin with all necessary services"""
        self.runtime_service = RuntimeService()
        self.steam_service = SteamService()
        self.installation_service = InstallationService(
            runtime_service=self.runtime_service,
            steam_service=self.steam_service,
        )
        self.configuration_service = ConfigurationService(runtime_service=self.runtime_service)
        self.flatpak_service = FlatpakService()
        self.wrapper_service = WrapperService()

    async def install_lsfg_vk(self) -> Dict[str, Any]:
        """Install the bundled lsfg-vk runtime to ~/.local
        
        Returns:
            InstallationResponse dict with success status and message/error
        """
        return self.installation_service.install()

    async def check_lsfg_vk_installed(self) -> Dict[str, Any]:
        """Check if lsfg-vk is already installed
        
        Returns:
            InstallationCheckResponse dict with installation status and paths
        """
        return self.installation_service.check_installation()

    async def uninstall_lsfg_vk(self) -> Dict[str, Any]:
        """Uninstall lsfg-vk by removing the installed files
        
        Returns:
            UninstallationResponse dict with success status and removed files
        """
        return self.installation_service.uninstall()

    async def get_game_configs(self) -> Dict[str, Any]:
        return self.configuration_service.get_game_configs()

    async def get_installed_games(self) -> Dict[str, Any]:
        result = self.steam_service.get_installed_games()
        if not result.get("success"):
            return result

        support_cache: Dict[str, Dict[str, Any]] = {}
        for game in result.get("games", []):
            transport = game.get("transport") if isinstance(game, dict) else None
            if not isinstance(transport, dict) or transport.get("kind") != "flatpak":
                continue
            flatpak_app_id = transport.get("flatpakAppId")
            if not isinstance(flatpak_app_id, str) or not flatpak_app_id:
                continue
            if flatpak_app_id not in support_cache:
                support_cache[flatpak_app_id] = self.flatpak_service.resolve_app_support(
                    flatpak_app_id
                )
            game["flatpakSupport"] = support_cache[flatpak_app_id]
        return result

    async def update_game_config(self, appid: str, game_name: str, config: Dict[str, Any]) -> Dict[str, Any]:
        return self.configuration_service.update_game_config(appid, game_name, config)

    async def reset_game_config(self, appid: str) -> Dict[str, Any]:
        return self.configuration_service.reset_game_config(appid)

    async def reset_all_game_configs(self) -> Dict[str, Any]:
        return self.configuration_service.reset_all_game_configs()

    async def get_workaround_state(self, appid: str) -> Dict[str, Any]:
        return self.wrapper_service.get(appid)

    async def set_workaround_state(
        self,
        appid: str,
        state: Dict[str, Any],
        shortcut_exe: Optional[str] = None,
        command_token_added: bool = False,
        transport: Optional[Dict[str, Any]] = None,
    ) -> Dict[str, Any]:
        return self.wrapper_service.set(
            appid,
            state,
            shortcut_exe,
            command_token_added,
            transport,
        )

    async def remove_workaround_state(self, appid: str) -> Dict[str, Any]:
        return self.wrapper_service.remove(appid)

    async def get_config_file_content(self) -> Dict[str, Any]:
        """Get the current config file content
        
        Returns:
            Dict containing the config file content or error message
        """
        try:
            config_path = self.configuration_service.config_file_path
            if not config_path.exists():
                return {
                    "success": False,
                    "content": None,
                    "path": str(config_path),
                    "error": "Config file does not exist"
                }
            
            content = config_path.read_text(encoding='utf-8')
            return {
                "success": True,
                "content": content,
                "path": str(config_path),
                "error": None
            }
        except Exception as e:
            return {
                "success": False,
                "content": None,
                "path": str(config_path) if 'config_path' in locals() else "unknown",
                "error": f"Error reading config file: {str(e)}"
            }

    async def get_lossless_scaling_branch_status(self) -> Dict[str, Any]:
        return self.steam_service.get_branch_status()

    async def get_flatpak_support_status(self) -> Dict[str, Any]:
        return self.flatpak_service.get_flatpak_support_status()

    async def ensure_flatpak_support(self, flatpak_app_id: str) -> Dict[str, Any]:
        return self.flatpak_service.ensure_app_support(flatpak_app_id)

    async def repair_flatpak_support(self, flatpak_app_id: str) -> Dict[str, Any]:
        return self.flatpak_service.ensure_app_support(flatpak_app_id)

    async def set_flatpak_extension_enabled(self, version: str, enabled: bool) -> Dict[str, Any]:
        return self.flatpak_service.set_extension_enabled(version, enabled)

    async def remove_plugin_owned_flatpak_extensions(self) -> Dict[str, Any]:
        return self.flatpak_service.remove_plugin_owned_extensions()
    
    async def _main(self):
        """
        Main entry point for the plugin.
        
        This method is called by Decky Loader when the plugin is loaded.
        Any initialization code should go here.
        """
        repair = self.wrapper_service.repair()
        if not repair.get("success"):
            decky.logger.error(f"Could not repair lsfg workaround wrapper: {repair.get('error')}")
        decky.logger.info("decky-lsfg-vk plugin loaded")

    async def _unload(self):
        """
        Cleanup tasks when the plugin is unloaded.
        
        This method is called by Decky Loader when the plugin is being unloaded.
        Any cleanup code should go here.
        """
        decky.logger.info("decky-lsfg-vk plugin unloaded")

    async def _uninstall(self):
        """
        Called when the plugin is uninstalled.
        
        This method is called by Decky Loader when the plugin is being uninstalled.
        Performs cleanup of plugin files and flatpak extensions.
        """
        decky.logger.info("decky-lsfg-vk plugin being uninstalled")
        
        # Clean up lsfg-vk files when the plugin is uninstalled
        # Launch integrations are removed with their profiles.  Keep the
        # generated pass-through wrapper if it is still referenced elsewhere;
        # InstallationService only removes files owned by the runtime bundle.
        self.installation_service.cleanup_on_uninstall()
        
        try:
            result = self.flatpak_service.remove_plugin_owned_extensions()
            if not result.get("success"):
                decky.logger.warning(result.get("error"))
        except Exception as error:
            decky.logger.error(f"Error during Flatpak cleanup: {error}")

        decky.logger.info("decky-lsfg-vk plugin uninstall cleanup completed")

    async def _migration(self):
        """
        Migrations that should be performed before entering `_main()`.
        
        This method is called by Decky Loader for plugin migrations.
        Currently migrates logs, settings, and runtime data from old locations.
        """
        decky.logger.info("Running decky-lsfg-vk plugin migrations")
        
        decky.migrate_logs(os.path.join(decky.DECKY_USER_HOME,
                                       ".config", "decky-lossless-scaling-vk", "lossless-scaling-vk.log"))
        
        decky.migrate_settings(
            os.path.join(decky.DECKY_HOME, "settings", "lossless-scaling-vk.json"),
            os.path.join(decky.DECKY_USER_HOME, ".config", "decky-lossless-scaling-vk"))
        
        decky.migrate_runtime(
            os.path.join(decky.DECKY_HOME, "lossless-scaling-vk"),
            os.path.join(decky.DECKY_USER_HOME, ".local", "share", "decky-lossless-scaling-vk"))
        
        decky.logger.info("decky-lsfg-vk plugin migrations completed")