diff options
Diffstat (limited to 'backend/decky_loader/plugin')
| -rw-r--r-- | backend/decky_loader/plugin/imports/decky.py | 7 | ||||
| -rw-r--r-- | backend/decky_loader/plugin/imports/decky.pyi | 7 | ||||
| -rw-r--r-- | backend/decky_loader/plugin/messages.py (renamed from backend/decky_loader/plugin/method_call_request.py) | 7 | ||||
| -rw-r--r-- | backend/decky_loader/plugin/plugin.py | 25 | ||||
| -rw-r--r-- | backend/decky_loader/plugin/sandboxed_plugin.py | 49 |
5 files changed, 65 insertions, 30 deletions
diff --git a/backend/decky_loader/plugin/imports/decky.py b/backend/decky_loader/plugin/imports/decky.py index 599d142f..9a784ec4 100644 --- a/backend/decky_loader/plugin/imports/decky.py +++ b/backend/decky_loader/plugin/imports/decky.py @@ -19,7 +19,7 @@ import subprocess import logging import time -from typing import Dict, Any +from typing import TypeVar, Type """ Constants @@ -213,9 +213,10 @@ logger.setLevel(logging.INFO) """ Event handling """ +DataType = TypeVar("DataType") # TODO better docstring im lazy -async def emit_message(message: Dict[Any, Any]) -> None: +async def emit(event: str, data: DataType | None = None, data_type: Type[DataType] | None = None) -> None: """ - Send a message to the frontend. + Send an event to the frontend. """ pass
\ No newline at end of file diff --git a/backend/decky_loader/plugin/imports/decky.pyi b/backend/decky_loader/plugin/imports/decky.pyi index e68b3853..7a0dfa6a 100644 --- a/backend/decky_loader/plugin/imports/decky.pyi +++ b/backend/decky_loader/plugin/imports/decky.pyi @@ -16,7 +16,7 @@ __version__ = '0.1.0' import logging -from typing import Dict, Any +from typing import TypeVar, Type """ Constants @@ -177,8 +177,9 @@ logger: logging.Logger """ Event handling """ +DataType = TypeVar("DataType") # TODO better docstring im lazy -async def emit_message(message: Dict[Any, Any]) -> None: +async def emit(event: str, data: DataType | None = None, data_type: Type[DataType] | None = None) -> None: """ - Send a message to the frontend. + Send an event to the frontend. """
\ No newline at end of file diff --git a/backend/decky_loader/plugin/method_call_request.py b/backend/decky_loader/plugin/messages.py index cebe34f8..d53efbee 100644 --- a/backend/decky_loader/plugin/method_call_request.py +++ b/backend/decky_loader/plugin/messages.py @@ -1,8 +1,15 @@ from typing import Any, TypedDict +from enum import IntEnum from uuid import uuid4 from asyncio import Event +class SocketMessageType(IntEnum): + CALL = 0 + RESPONSE = 1 + EVENT = 2 + class SocketResponseDict(TypedDict): + type: SocketMessageType id: str success: bool res: Any diff --git a/backend/decky_loader/plugin/plugin.py b/backend/decky_loader/plugin/plugin.py index 01fc048c..ce7d2581 100644 --- a/backend/decky_loader/plugin/plugin.py +++ b/backend/decky_loader/plugin/plugin.py @@ -6,11 +6,13 @@ from multiprocessing import Process from .sandboxed_plugin import SandboxedPlugin -from .method_call_request import MethodCallRequest +from .messages import MethodCallRequest, SocketMessageType from ..localplatform.localsocket import LocalSocket from typing import Any, Callable, Coroutine, Dict, List +EmittedEventCallbackType = Callable[[str, Any], Coroutine[Any, Any, Any]] + class PluginWrapper: def __init__(self, file: str, plugin_directory: str, plugin_path: str) -> None: self.file = file @@ -27,18 +29,19 @@ class PluginWrapper: self.name = json["name"] self.author = json["author"] self.flags = json["flags"] + self.api_version = json["api_version"] if "api_version" in json else 0 self.passive = not path.isfile(self.file) self.log = getLogger("plugin") - self.sandboxed_plugin = SandboxedPlugin(self.name, self.passive, self.flags, self.file, self.plugin_directory, self.plugin_path, self.version, self.author) - #TODO: Maybe make LocalSocket not require on_new_message to make this cleaner + self.sandboxed_plugin = SandboxedPlugin(self.name, self.passive, self.flags, self.file, self.plugin_directory, self.plugin_path, self.version, self.author, self.api_version) + # TODO: Maybe make LocalSocket not require on_new_message to make this cleaner self._socket = LocalSocket(self.sandboxed_plugin.on_new_message) self._listener_task: Task[Any] self._method_call_requests: Dict[str, MethodCallRequest] = {} - self.emitted_message_callback: Callable[[Dict[Any, Any]], Coroutine[Any, Any, Any]] + self.emitted_event_callback: EmittedEventCallbackType self.legacy_method_warning = False @@ -51,15 +54,15 @@ class PluginWrapper: line = await self._socket.read_single_line() if line != None: res = loads(line) - if res["id"] == "0": - create_task(self.emitted_message_callback(res["payload"])) - else: + if res["type"] == SocketMessageType.EVENT.value: + create_task(self.emitted_event_callback(res["event"], res["data"])) + elif res["type"] == SocketMessageType.RESPONSE.value: self._method_call_requests.pop(res["id"]).set_result(res) except: pass - def set_emitted_message_callback(self, callback: Callable[[Dict[Any, Any]], Coroutine[Any, Any, Any]]): - self.emitted_message_callback = callback + def set_emitted_event_callback(self, callback: EmittedEventCallbackType): + self.emitted_event_callback = callback async def execute_legacy_method(self, method_name: str, kwargs: Dict[Any, Any]): if not self.legacy_method_warning: @@ -70,7 +73,7 @@ class PluginWrapper: request = MethodCallRequest() await self._socket.get_socket_connection() - await self._socket.write_single_line(dumps({ "method": method_name, "args": kwargs, "id": request.id, "legacy": True }, ensure_ascii=False)) + await self._socket.write_single_line(dumps({ "type": SocketMessageType.CALL, "method": method_name, "args": kwargs, "id": request.id, "legacy": True }, ensure_ascii=False)) self._method_call_requests[request.id] = request return await request.wait_for_result() @@ -81,7 +84,7 @@ class PluginWrapper: request = MethodCallRequest() await self._socket.get_socket_connection() - await self._socket.write_single_line(dumps({ "method": method_name, "args": args, "id": request.id }, ensure_ascii=False)) + await self._socket.write_single_line(dumps({ "type": SocketMessageType.CALL, "method": method_name, "args": args, "id": request.id }, ensure_ascii=False)) self._method_call_requests[request.id] = request return await request.wait_for_result() diff --git a/backend/decky_loader/plugin/sandboxed_plugin.py b/backend/decky_loader/plugin/sandboxed_plugin.py index d07cdc97..0603fc09 100644 --- a/backend/decky_loader/plugin/sandboxed_plugin.py +++ b/backend/decky_loader/plugin/sandboxed_plugin.py @@ -8,13 +8,17 @@ from traceback import format_exc from asyncio import (get_event_loop, new_event_loop, set_event_loop, sleep) -from .method_call_request import SocketResponseDict +from backend.decky_loader.plugin.messages import SocketMessageType + +from .messages import SocketResponseDict, SocketMessageType from ..localplatform.localsocket import LocalSocket from ..localplatform.localplatform import setgid, setuid, get_username, get_home_path from ..customtypes import UserType from .. import helpers -from typing import Any, Dict, List +from typing import List, TypeVar, Type + +DataType = TypeVar("DataType") class SandboxedPlugin: def __init__(self, @@ -25,7 +29,8 @@ class SandboxedPlugin: plugin_directory: str, plugin_path: str, version: str|None, - author: str) -> None: + author: str, + api_version: int) -> None: self.name = name self.passive = passive self.flags = flags @@ -34,6 +39,7 @@ class SandboxedPlugin: self.plugin_directory = plugin_directory self.version = version self.author = author + self.api_version = api_version self.log = getLogger("plugin") @@ -79,10 +85,11 @@ class SandboxedPlugin: sysmodules[key.replace("decky_loader.", "")] = sysmodules[key] from .imports import decky - async def emit_message(message: Dict[Any, Any]): + async def emit_message(event: str, data: DataType | None = None, data_type: Type[DataType] | None = None) -> None: await self._socket.write_single_line_server(dumps({ - "id": "0", - "payload": message + "type": SocketMessageType.EVENT, + "event": event, + "data": data })) # copy the docstring over so we don't have to duplicate it emit_message.__doc__ = decky.emit_message.__doc__ @@ -97,12 +104,21 @@ class SandboxedPlugin: assert spec.loader is not None spec.loader.exec_module(module) # TODO fix self weirdness once plugin.json versioning is done. need this before WS release! - self.Plugin = module.Plugin + if self.api_version > 0: + self.Plugin = module.Plugin() + else: + self.Plugin = module.Plugin if hasattr(self.Plugin, "_migration"): - get_event_loop().run_until_complete(self.Plugin._migration(self.Plugin)) + if self.api_version > 0: + get_event_loop().run_until_complete(self.Plugin._migration()) + else: + get_event_loop().run_until_complete(self.Plugin._migration(self.Plugin)) if hasattr(self.Plugin, "_main"): - get_event_loop().create_task(self.Plugin._main(self.Plugin)) + if self.api_version > 0: + get_event_loop().create_task(self.Plugin._main()) + else: + get_event_loop().create_task(self.Plugin._main(self.Plugin)) get_event_loop().create_task(socket.setup_server()) get_event_loop().run_forever() except: @@ -113,7 +129,10 @@ class SandboxedPlugin: try: self.log.info("Attempting to unload with plugin " + self.name + "'s \"_unload\" function.\n") if hasattr(self.Plugin, "_unload"): - await self.Plugin._unload(self.Plugin) + if self.api_version > 0: + await self.Plugin._unload() + else: + await self.Plugin._unload(self.Plugin) self.log.info("Unloaded " + self.name + "\n") else: self.log.info("Could not find \"_unload\" in " + self.name + "'s main.py" + "\n") @@ -121,7 +140,7 @@ class SandboxedPlugin: self.log.error("Failed to unload " + self.name + "!\n" + format_exc()) exit(0) - async def on_new_message(self, message : str) -> str|None: + async def on_new_message(self, message : str) -> str | None: data = loads(message) if "stop" in data: @@ -133,14 +152,18 @@ class SandboxedPlugin: await self._unload() raise Exception("Closing message listener") - d: SocketResponseDict = {"res": None, "success": True, "id": data["id"]} + d: SocketResponseDict = {"type": SocketMessageType.RESPONSE, "res": None, "success": True, "id": data["id"]} try: if data["legacy"]: + if self.api_version > 0: + raise Exception("Legacy methods may not be used on api_version > 0") # Legacy kwargs d["res"] = await getattr(self.Plugin, data["method"])(self.Plugin, **data["args"]) else: + if self.api_version < 1 : + raise Exception("api_version 1 or newer is required to call methods with index-based arguments") # New args - d["res"] = await getattr(self.Plugin, data["method"])(self.Plugin, *data["args"]) + d["res"] = await getattr(self.Plugin, data["method"])(*data["args"]) except Exception as e: d["res"] = str(e) d["success"] = False |