mirror of
https://github.com/mofeng-git/One-KVM.git
synced 2026-01-29 00:51:53 +08:00
feat: merge upstream master - version 4.94
Merge upstream PiKVM master branch updates: - Bump version from 4.93 to 4.94 - HID: improved jiggler pattern for better compatibility - Streamer: major refactoring for improved performance and maintainability - Prometheus: tidying GPIO channel name formatting - Web: added __gpio-label class for custom styling - HID: customizable /api/hid/print delay configuration - ATX: independent power/reset regions for better control - OLED: added --fill option for display testing - Web: improved keyboard handling in modal dialogs - Web: enhanced login error messages - Switch: added heartbeat functionality - Web: mouse touch code simplification and refactoring - Configs: use systemd-networkd-wait-online --any by default - PKGBUILD: use cp -r to install systemd units properly - Various bug fixes and performance improvements
This commit is contained in:
mofeng-git
@@ -20,10 +20,10 @@
|
||||
# ========================================================================== #
|
||||
|
||||
|
||||
import asyncio
|
||||
import contextlib
|
||||
import struct
|
||||
|
||||
import typing
|
||||
from typing import Callable
|
||||
from typing import AsyncGenerator
|
||||
|
||||
@@ -51,29 +51,35 @@ class _BaseApiPart:
|
||||
for (key, value) in params.items()
|
||||
if value is not None
|
||||
},
|
||||
) as response:
|
||||
htclient.raise_not_200(response)
|
||||
) as resp:
|
||||
htclient.raise_not_200(resp)
|
||||
|
||||
|
||||
class _AuthApiPart(_BaseApiPart):
|
||||
async def check(self) -> bool:
|
||||
async def check(self, user: str, passwd: str) -> bool:
|
||||
session = self._ensure_http_session()
|
||||
try:
|
||||
async with session.get("/auth/check") as response:
|
||||
htclient.raise_not_200(response)
|
||||
return True
|
||||
async with session.get("/auth/check", headers={
|
||||
"X-KVMD-User": user,
|
||||
"X-KVMD-Passwd": passwd,
|
||||
}) as resp:
|
||||
|
||||
htclient.raise_not_200(resp)
|
||||
return (resp.status == 200) # Just for my paranoia
|
||||
|
||||
except aiohttp.ClientResponseError as ex:
|
||||
if ex.status in [400, 401, 403]:
|
||||
return False
|
||||
raise
|
||||
typing.assert_never("We should't be here")
|
||||
|
||||
|
||||
class _StreamerApiPart(_BaseApiPart):
|
||||
async def get_state(self) -> dict:
|
||||
session = self._ensure_http_session()
|
||||
async with session.get("/streamer") as response:
|
||||
htclient.raise_not_200(response)
|
||||
return (await response.json())["result"]
|
||||
async with session.get("/streamer") as resp:
|
||||
htclient.raise_not_200(resp)
|
||||
return (await resp.json())["result"]
|
||||
|
||||
async def set_params(self, quality: (int | None)=None, desired_fps: (int | None)=None) -> None:
|
||||
await self._set_params(
|
||||
@@ -86,9 +92,9 @@ class _StreamerApiPart(_BaseApiPart):
|
||||
class _HidApiPart(_BaseApiPart):
|
||||
async def get_keymaps(self) -> tuple[str, set[str]]:
|
||||
session = self._ensure_http_session()
|
||||
async with session.get("/hid/keymaps") as response:
|
||||
htclient.raise_not_200(response)
|
||||
result = (await response.json())["result"]
|
||||
async with session.get("/hid/keymaps") as resp:
|
||||
htclient.raise_not_200(resp)
|
||||
result = (await resp.json())["result"]
|
||||
return (result["keymaps"]["default"], set(result["keymaps"]["available"]))
|
||||
|
||||
async def print(self, text: str, limit: int, keymap_name: str) -> None:
|
||||
@@ -97,8 +103,8 @@ class _HidApiPart(_BaseApiPart):
|
||||
url="/hid/print",
|
||||
params={"limit": limit, "keymap": keymap_name},
|
||||
data=text,
|
||||
) as response:
|
||||
htclient.raise_not_200(response)
|
||||
) as resp:
|
||||
htclient.raise_not_200(resp)
|
||||
|
||||
async def set_params(self, keyboard_output: (str | None)=None, mouse_output: (str | None)=None) -> None:
|
||||
await self._set_params(
|
||||
@@ -111,9 +117,9 @@ class _HidApiPart(_BaseApiPart):
|
||||
class _AtxApiPart(_BaseApiPart):
|
||||
async def get_state(self) -> dict:
|
||||
session = self._ensure_http_session()
|
||||
async with session.get("/atx") as response:
|
||||
htclient.raise_not_200(response)
|
||||
return (await response.json())["result"]
|
||||
async with session.get("/atx") as resp:
|
||||
htclient.raise_not_200(resp)
|
||||
return (await resp.json())["result"]
|
||||
|
||||
async def switch_power(self, action: str) -> bool:
|
||||
session = self._ensure_http_session()
|
||||
@@ -121,8 +127,8 @@ class _AtxApiPart(_BaseApiPart):
|
||||
async with session.post(
|
||||
url="/atx/power",
|
||||
params={"action": action},
|
||||
) as response:
|
||||
htclient.raise_not_200(response)
|
||||
) as resp:
|
||||
htclient.raise_not_200(resp)
|
||||
return True
|
||||
except aiohttp.ClientResponseError as ex:
|
||||
if ex.status == 409:
|
||||
@@ -130,51 +136,47 @@ class _AtxApiPart(_BaseApiPart):
|
||||
raise
|
||||
|
||||
|
||||
class _SwitchApiPart(_BaseApiPart):
|
||||
async def set_active_prev(self) -> None:
|
||||
session = self._ensure_http_session()
|
||||
async with session.post("/switch/set_active_prev") as resp:
|
||||
htclient.raise_not_200(resp)
|
||||
|
||||
async def set_active_next(self) -> None:
|
||||
session = self._ensure_http_session()
|
||||
async with session.post("/switch/set_active_next") as resp:
|
||||
htclient.raise_not_200(resp)
|
||||
|
||||
async def set_active(self, port: float) -> None:
|
||||
session = self._ensure_http_session()
|
||||
async with session.post(
|
||||
url="/switch/set_active",
|
||||
params={"port": port},
|
||||
) as resp:
|
||||
htclient.raise_not_200(resp)
|
||||
|
||||
|
||||
# =====
|
||||
class KvmdClientWs:
|
||||
def __init__(self, ws: aiohttp.ClientWebSocketResponse) -> None:
|
||||
self.__ws = ws
|
||||
self.__writer_queue: "asyncio.Queue[tuple[str, dict] | bytes]" = asyncio.Queue()
|
||||
self.__communicated = False
|
||||
|
||||
async def communicate(self) -> AsyncGenerator[tuple[str, dict], None]: # pylint: disable=too-many-branches
|
||||
assert not self.__communicated
|
||||
self.__communicated = True
|
||||
receive_task: (asyncio.Task | None) = None
|
||||
writer_task: (asyncio.Task | None) = None
|
||||
try:
|
||||
while True:
|
||||
if receive_task is None:
|
||||
receive_task = asyncio.create_task(self.__ws.receive())
|
||||
if writer_task is None:
|
||||
writer_task = asyncio.create_task(self.__writer_queue.get())
|
||||
|
||||
done = (await aiotools.wait_first(receive_task, writer_task))[0]
|
||||
|
||||
if receive_task in done:
|
||||
msg = receive_task.result()
|
||||
if msg.type == aiohttp.WSMsgType.TEXT:
|
||||
async for msg in self.__ws:
|
||||
match msg.type:
|
||||
case aiohttp.WSMsgType.TEXT:
|
||||
yield htserver.parse_ws_event(msg.data)
|
||||
elif msg.type == aiohttp.WSMsgType.CLOSE:
|
||||
case aiohttp.WSMsgType.CLOSE:
|
||||
await self.__ws.close()
|
||||
elif msg.type == aiohttp.WSMsgType.CLOSED:
|
||||
case aiohttp.WSMsgType.CLOSED:
|
||||
break
|
||||
else:
|
||||
case _:
|
||||
raise RuntimeError(f"Unhandled WS message type: {msg!r}")
|
||||
receive_task = None
|
||||
|
||||
if writer_task in done:
|
||||
payload = writer_task.result()
|
||||
if isinstance(payload, bytes):
|
||||
await self.__ws.send_bytes(payload)
|
||||
else:
|
||||
await htserver.send_ws_event(self.__ws, *payload)
|
||||
writer_task = None
|
||||
finally:
|
||||
if receive_task:
|
||||
receive_task.cancel()
|
||||
if writer_task:
|
||||
writer_task.cancel()
|
||||
try:
|
||||
await aiotools.shield_fg(self.__ws.close())
|
||||
except Exception:
|
||||
@@ -182,19 +184,33 @@ class KvmdClientWs:
|
||||
finally:
|
||||
self.__communicated = False
|
||||
|
||||
async def send_key_event(self, key: str, state: bool) -> None:
|
||||
mask = (0b01 if state else 0)
|
||||
await self.__writer_queue.put(bytes([1, mask]) + key.encode("ascii"))
|
||||
async def send_key_event(self, key: int, state: bool) -> None:
|
||||
mask = (0b10000000 | int(bool(state)))
|
||||
await self.__send_struct(">BBH", 1, mask, key)
|
||||
|
||||
async def send_mouse_button_event(self, button: str, state: bool) -> None:
|
||||
mask = (0b01 if state else 0)
|
||||
await self.__writer_queue.put(bytes([2, mask]) + button.encode("ascii"))
|
||||
async def send_mouse_button_event(self, button: int, state: bool) -> None:
|
||||
mask = (0b10000000 | int(bool(state)))
|
||||
await self.__send_struct(">BBH", 2, mask, button)
|
||||
|
||||
async def send_mouse_move_event(self, to_x: int, to_y: int) -> None:
|
||||
await self.__writer_queue.put(struct.pack(">bhh", 3, to_x, to_y))
|
||||
await self.__send_struct(">Bhh", 3, to_x, to_y)
|
||||
|
||||
async def send_mouse_relative_event(self, delta_x: int, delta_y: int) -> None:
|
||||
await self.__send_struct(">BBbb", 4, 0, delta_x, delta_y)
|
||||
|
||||
async def send_mouse_wheel_event(self, delta_x: int, delta_y: int) -> None:
|
||||
await self.__writer_queue.put(struct.pack(">bbbb", 5, 0, delta_x, delta_y))
|
||||
await self.__send_struct(">BBbb", 5, 0, delta_x, delta_y)
|
||||
|
||||
async def __send_struct(self, fmt: str, *values: int) -> None:
|
||||
if not self.__communicated:
|
||||
return
|
||||
data = struct.pack(fmt, *values)
|
||||
try:
|
||||
await self.__ws.send_bytes(data)
|
||||
except Exception:
|
||||
# XXX: We don't care about any connection errors
|
||||
# since they will be handled with communication()
|
||||
pass
|
||||
|
||||
|
||||
class KvmdClientSession(BaseHttpClientSession):
|
||||
@@ -204,18 +220,15 @@ class KvmdClientSession(BaseHttpClientSession):
|
||||
self.streamer = _StreamerApiPart(self._ensure_http_session)
|
||||
self.hid = _HidApiPart(self._ensure_http_session)
|
||||
self.atx = _AtxApiPart(self._ensure_http_session)
|
||||
self.switch = _SwitchApiPart(self._ensure_http_session)
|
||||
|
||||
@contextlib.asynccontextmanager
|
||||
async def ws(self) -> AsyncGenerator[KvmdClientWs, None]:
|
||||
async def ws(self, stream: bool=True) -> AsyncGenerator[KvmdClientWs, None]:
|
||||
session = self._ensure_http_session()
|
||||
async with session.ws_connect("/ws", params={"legacy": "0"}) as ws:
|
||||
async with session.ws_connect("/ws", params={"stream": int(stream)}) as ws:
|
||||
yield KvmdClientWs(ws)
|
||||
|
||||
|
||||
class KvmdClient(BaseHttpClient):
|
||||
def make_session(self, user: str="", passwd: str="") -> KvmdClientSession:
|
||||
headers = {
|
||||
"X-KVMD-User": user,
|
||||
"X-KVMD-Passwd": passwd,
|
||||
}
|
||||
return KvmdClientSession(lambda: self._make_http_session(headers))
|
||||
def make_session(self) -> KvmdClientSession:
|
||||
return KvmdClientSession(self._make_http_session)
|
||||
|
||||
@@ -117,25 +117,25 @@ class StreamerSnapshot:
|
||||
class HttpStreamerClientSession(BaseHttpClientSession):
|
||||
async def get_state(self) -> dict:
|
||||
session = self._ensure_http_session()
|
||||
async with session.get("/state") as response:
|
||||
htclient.raise_not_200(response)
|
||||
return (await response.json())["result"]
|
||||
async with session.get("/state") as resp:
|
||||
htclient.raise_not_200(resp)
|
||||
return (await resp.json())["result"]
|
||||
|
||||
async def take_snapshot(self, timeout: float) -> StreamerSnapshot:
|
||||
session = self._ensure_http_session()
|
||||
async with session.get(
|
||||
url="/snapshot",
|
||||
timeout=aiohttp.ClientTimeout(total=timeout),
|
||||
) as response:
|
||||
) as resp:
|
||||
|
||||
htclient.raise_not_200(response)
|
||||
htclient.raise_not_200(resp)
|
||||
return StreamerSnapshot(
|
||||
online=(response.headers["X-UStreamer-Online"] == "true"),
|
||||
width=int(response.headers["X-UStreamer-Width"]),
|
||||
height=int(response.headers["X-UStreamer-Height"]),
|
||||
online=(resp.headers["X-UStreamer-Online"] == "true"),
|
||||
width=int(resp.headers["X-UStreamer-Width"]),
|
||||
height=int(resp.headers["X-UStreamer-Height"]),
|
||||
headers=tuple(
|
||||
(key, value)
|
||||
for (key, value) in tools.sorted_kvs(dict(response.headers))
|
||||
for (key, value) in tools.sorted_kvs(dict(resp.headers))
|
||||
if key.lower().startswith("x-ustreamer-") or key.lower() in [
|
||||
"x-timestamp",
|
||||
"access-control-allow-origin",
|
||||
@@ -144,7 +144,7 @@ class HttpStreamerClientSession(BaseHttpClientSession):
|
||||
"expires",
|
||||
]
|
||||
),
|
||||
data=bytes(await response.read()),
|
||||
data=bytes(await resp.read()),
|
||||
)
|
||||
|
||||
|
||||
@@ -187,10 +187,10 @@ class HttpStreamerClient(BaseHttpClient, BaseStreamerClient):
|
||||
connect=session.timeout.total,
|
||||
sock_read=session.timeout.total,
|
||||
),
|
||||
) as response:
|
||||
) as resp:
|
||||
|
||||
htclient.raise_not_200(response)
|
||||
reader = aiohttp.MultipartReader.from_response(response)
|
||||
htclient.raise_not_200(resp)
|
||||
reader = aiohttp.MultipartReader.from_response(resp)
|
||||
self.__patch_stream_reader(reader.resp.content)
|
||||
|
||||
async def read_frame(key_required: bool) -> dict:
|
||||
|
||||
Reference in New Issue
Block a user