From 99cdcdbb60aacdd1ce4ad3987fb5d37ae8b200af Mon Sep 17 00:00:00 2001 From: wheaney <42350981+wheaney@users.noreply.github.com> Date: Tue, 24 Oct 2023 15:03:11 -0700 Subject: [PATCH] Add Plugin.uninstall callback support https://github.com/SteamDeckHomebrew/decky-loader/issues/536 --- backend/src/browser.py | 2 +- backend/src/plugin.py | 25 +++++++++++++++++++++---- contrib/deck.sh | 0 3 files changed, 22 insertions(+), 5 deletions(-) create mode 100755 contrib/deck.sh diff --git a/backend/src/browser.py b/backend/src/browser.py index da8569bee..4aeb40e78 100644 --- a/backend/src/browser.py +++ b/backend/src/browser.py @@ -137,7 +137,7 @@ async def uninstall_plugin(self, name: str): # logger.debug("current plugins: %s", snapshot_string) if name in self.plugins: logger.debug("Plugin %s was found", name) - self.plugins[name].stop() + self.plugins[name].stop(uninstall=True) logger.debug("Plugin %s was stopped", name) del self.plugins[name] logger.debug("Plugin %s was removed from the dictionary", name) diff --git a/backend/src/plugin.py b/backend/src/plugin.py index b57bc5f7f..f232451b5 100644 --- a/backend/src/plugin.py +++ b/backend/src/plugin.py @@ -78,7 +78,7 @@ def _init(self): # append the plugin's `py_modules` to the recognized python paths syspath.append(path.join(environ["DECKY_PLUGIN_DIR"], "py_modules")) - + #TODO: FIX IN A LESS CURSED WAY keys = [key.replace("src.", "") for key in sysmodules if key.startswith("src.")] for key in keys: @@ -113,12 +113,29 @@ async def _unload(self): self.log.error("Failed to unload " + self.name + "!\n" + format_exc()) exit(0) + async def _uninstall(self): + try: + self.log.info("Attempting to uninstall with plugin " + self.name + "'s \"_uninstall\" function.\n") + if hasattr(self.Plugin, "_uninstall"): + await self.Plugin._uninstall(self.Plugin) + self.log.info("Uninstalled " + self.name + "\n") + else: + self.log.info("Could not find \"_uninstall\" in " + self.name + "'s main.py" + "\n") + except: + self.log.error("Failed to uninstall " + self.name + "!\n" + format_exc()) + exit(0) + async def _on_new_message(self, message : str) -> str|None: data = loads(message) if "stop" in data: self.log.info("Calling Loader unload function.") await self._unload() + + if data.get('uninstall'): + self.log.info("Calling Loader uninstall function.") + await self._uninstall() + get_event_loop().stop() while get_event_loop().is_running(): await sleep(0) @@ -141,12 +158,12 @@ def start(self): multiprocessing.Process(target=self._init).start() return self - def stop(self): + def stop(self, uninstall: bool = False): if self.passive: return async def _(self: PluginWrapper): - await self.socket.write_single_line(dumps({ "stop": True }, ensure_ascii=False)) + await self.socket.write_single_line(dumps({ "stop": True, "uninstall": uninstall }, ensure_ascii=False)) await self.socket.close_socket_connection() get_event_loop().create_task(_(self)) @@ -155,7 +172,7 @@ async def execute_method(self, method_name: str, kwargs: Dict[Any, Any]): if self.passive: raise RuntimeError("This plugin is passive (aka does not implement main.py)") async with self.method_call_lock: - # reader, writer = + # reader, writer = await self.socket.get_socket_connection() await self.socket.write_single_line(dumps({ "method": method_name, "args": kwargs }, ensure_ascii=False)) diff --git a/contrib/deck.sh b/contrib/deck.sh new file mode 100755 index 000000000..e69de29bb