diff --git a/.bumpversion.cfg b/.bumpversion.cfg index 89b70044..926b4e31 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,7 +1,7 @@ [bumpversion] commit = True tag = True -current_version = 4.3 +current_version = 4.20 parse = (?P\d+)\.(?P\d+)(\.(?P\d+)(\-(?P[a-z]+))?)? serialize = {major}.{minor} diff --git a/PKGBUILD b/PKGBUILD index 25873e5b..960ed365 100644 --- a/PKGBUILD +++ b/PKGBUILD @@ -39,7 +39,7 @@ for _variant in "${_variants[@]}"; do pkgname+=(kvmd-platform-$_platform-$_board) done pkgbase=kvmd -pkgver=4.3 +pkgver=4.20 pkgrel=1 pkgdesc="The main PiKVM daemon" url="https://github.com/pikvm/kvmd" @@ -77,6 +77,8 @@ depends=( python-ldap python-zstandard python-mako + python-luma-oled + python-pyusb "libgpiod>=2.1" freetype2 "v4l-utils>=1.22.1-1" @@ -91,7 +93,7 @@ depends=( certbot platform-io-access raspberrypi-utils - "ustreamer>=6.11" + "ustreamer>=6.16" # Systemd UDEV bug "systemd>=248.3-2" @@ -131,6 +133,7 @@ conflicts=( python-aiohttp-pikvm platformio avrdude-pikvm + kvmd-oled ) makedepends=( python-setuptools @@ -206,7 +209,7 @@ for _variant in "${_variants[@]}"; do cd \"kvmd-\$pkgver\" pkgdesc=\"PiKVM platform configs - $_platform for $_board\" - depends=(kvmd=$pkgver-$pkgrel \"linux-rpi-pikvm>=6.6.21-3\") + depends=(kvmd=$pkgver-$pkgrel \"linux-rpi-pikvm>=6.6.45-1\" \"raspberrypi-bootloader-pikvm>=20240818-1\") backup=( etc/sysctl.d/99-kvmd.conf diff --git a/configs/kvmd/main/v4plus-hdmi-rpi4.yaml b/configs/kvmd/main/v4plus-hdmi-rpi4.yaml new file mode 100644 index 00000000..c1e6faff --- /dev/null +++ b/configs/kvmd/main/v4plus-hdmi-rpi4.yaml @@ -0,0 +1,98 @@ +# Don't touch this file otherwise your device may stop working. +# Use override.yaml to modify required settings. +# You can find a working configuration in /usr/share/kvmd/configs.default/kvmd. + +override: !include [override.d, override.yaml] + +logging: !include logging.yaml + +kvmd: + auth: !include auth.yaml + + info: + hw: + ignore_past: true + fan: + unix: /run/kvmd/fan.sock + + hid: + type: otg + mouse_alt: + device: /dev/kvmd-hid-mouse-alt + + atx: + type: gpio + power_led_pin: 4 + hdd_led_pin: 5 + power_switch_pin: 23 + reset_switch_pin: 27 + + msd: + type: otg + + streamer: + h264_bitrate: + default: 5000 + cmd: + - "/usr/bin/ustreamer" + - "--device=/dev/kvmd-video" + - "--persistent" + - "--dv-timings" + - "--format=uyvy" + - "--format-swap-rgb" + - "--buffers=8" + - "--encoder=m2m-image" + - "--workers=3" + - "--quality={quality}" + - "--desired-fps={desired_fps}" + - "--drop-same-frames=30" + - "--unix={unix}" + - "--unix-rm" + - "--unix-mode=0660" + - "--exit-on-parent-death" + - "--process-name-prefix={process_name_prefix}" + - "--notify-parent" + - "--no-log-colors" + - "--jpeg-sink=kvmd::ustreamer::jpeg" + - "--jpeg-sink-mode=0660" + - "--h264-sink=kvmd::ustreamer::h264" + - "--h264-sink-mode=0660" + - "--h264-bitrate={h264_bitrate}" + - "--h264-gop={h264_gop}" + + gpio: + drivers: + __v4_locator__: + type: locator + + scheme: + __v3_usb_breaker__: + pin: 22 + mode: output + initial: true + pulse: false + + __v4_locator__: + driver: __v4_locator__ + pin: 12 + mode: output + pulse: false + + __v4_const1__: + pin: 6 + mode: output + initial: false + switch: false + pulse: false + + +vnc: + memsink: + jpeg: + sink: "kvmd::ustreamer::jpeg" + h264: + sink: "kvmd::ustreamer::h264" + + +otg: + remote_wakeup: true diff --git a/configs/os/services/kvmd-oled-reboot.service b/configs/os/services/kvmd-oled-reboot.service new file mode 100644 index 00000000..23bbca15 --- /dev/null +++ b/configs/os/services/kvmd-oled-reboot.service @@ -0,0 +1,12 @@ +[Unit] +Description=PiKVM - Display reboot message on the OLED +DefaultDependencies=no + +[Service] +Type=oneshot +ExecStart=/bin/bash -c "kill -USR1 `systemctl show -P MainPID kvmd-oled`" +ExecStop=/bin/true +RemainAfterExit=yes + +[Install] +WantedBy=reboot.target diff --git a/configs/os/services/kvmd-oled-shutdown.service b/configs/os/services/kvmd-oled-shutdown.service new file mode 100644 index 00000000..61d94c51 --- /dev/null +++ b/configs/os/services/kvmd-oled-shutdown.service @@ -0,0 +1,14 @@ +[Unit] +Description=PiKVM - Display shutdown message on the OLED +Conflicts=reboot.target +Before=shutdown.target poweroff.target halt.target +DefaultDependencies=no + +[Service] +Type=oneshot +ExecStart=/bin/bash -c "kill -USR2 `systemctl show -P MainPID kvmd-oled`" +ExecStop=/bin/true +RemainAfterExit=yes + +[Install] +WantedBy=shutdown.target diff --git a/configs/os/services/kvmd-oled.service b/configs/os/services/kvmd-oled.service new file mode 100644 index 00000000..ea0d4850 --- /dev/null +++ b/configs/os/services/kvmd-oled.service @@ -0,0 +1,15 @@ +[Unit] +Description=PiKVM - A small OLED daemon +After=systemd-modules-load.service +ConditionPathExists=/dev/i2c-1 + +[Service] +Type=simple +Restart=always +RestartSec=3 +ExecStartPre=/usr/bin/kvmd-oled --interval=3 --clear-on-exit --image=@hello.ppm +ExecStart=/usr/bin/kvmd-oled +TimeoutStopSec=3 + +[Install] +WantedBy=multi-user.target diff --git a/configs/os/services/kvmd-pass.service b/configs/os/services/kvmd-pass.service deleted file mode 100644 index 5d55b5fe..00000000 --- a/configs/os/services/kvmd-pass.service +++ /dev/null @@ -1,15 +0,0 @@ -[Unit] -Description=PiKVM - Video Passthrough on V4 Plus -Wants=dev-kvmd\x2dvideo.device -After=dev-kvmd\x2dvideo.device systemd-modules-load.service - -[Service] -Type=simple -Restart=always -RestartSec=3 - -ExecStart=/usr/bin/ustreamer-v4p --unix-follow /run/kvmd/ustreamer.sock -TimeoutStopSec=10 - -[Install] -WantedBy=multi-user.target diff --git a/configs/os/services/kvmd-tc358743.service b/configs/os/services/kvmd-tc358743.service index c8b8bbf9..494da726 100644 --- a/configs/os/services/kvmd-tc358743.service +++ b/configs/os/services/kvmd-tc358743.service @@ -2,11 +2,11 @@ Description=PiKVM - EDID loader for TC358743 Wants=dev-kvmd\x2dvideo.device After=dev-kvmd\x2dvideo.device systemd-modules-load.service -Before=kvmd.service kvmd-pass.service +Before=kvmd.service [Service] Type=oneshot -ExecStart=/usr/bin/v4l2-ctl --device=/dev/kvmd-video --set-edid=file=/etc/kvmd/tc358743-edid.hex --fix-edid-checksums --info-edid +ExecStart=/usr/bin/v4l2-ctl --device=/dev/kvmd-video --set-edid=file=/etc/kvmd/tc358743-edid.hex --info-edid ExecStop=/usr/bin/v4l2-ctl --device=/dev/kvmd-video --clear-edid RemainAfterExit=true diff --git a/configs/os/sysusers.conf b/configs/os/sysusers.conf index 74ab9069..0359974d 100644 --- a/configs/os/sysusers.conf +++ b/configs/os/sysusers.conf @@ -19,6 +19,7 @@ m kvmd gpio m kvmd uucp m kvmd spi m kvmd systemd-journal +m kvmd kvmd-pst m kvmd-pst kvmd diff --git a/kvmd.install b/kvmd.install index 55bd999d..469fba8c 100644 --- a/kvmd.install +++ b/kvmd.install @@ -27,7 +27,8 @@ post_upgrade() { done chown kvmd /var/lib/kvmd/msd 2>/dev/null || true - chown kvmd-pst /var/lib/kvmd/pst 2>/dev/null || true + chown kvmd-pst:kvmd-pst /var/lib/kvmd/pst 2>/dev/null || true + chmod 1775 /var/lib/kvmd/pst 2>/dev/null || true if [ ! -e /etc/kvmd/nginx/ssl/server.crt ]; then echo "==> Generating KVMD-Nginx certificate ..." @@ -92,6 +93,15 @@ disable_overscan=1 EOF fi + if [[ "$(vercmp "$2" 4.4)" -lt 0 ]]; then + systemctl disable kvmd-pass || true + fi + + if [[ "$(vercmp "$2" 4.5)" -lt 0 ]]; then + sed -i 's/X-kvmd\.pst-user=kvmd-pst/X-kvmd.pst-user=kvmd-pst,X-kvmd.pst-group=kvmd-pst/g' /etc/fstab + touch -t 200701011000 /etc/fstab + fi + # Some update deletes /etc/motd, WTF # shellcheck disable=SC2015,SC2166 [ ! -f /etc/motd -a -f /etc/motd.pacsave ] && mv /etc/motd.pacsave /etc/motd || true diff --git a/kvmd/__init__.py b/kvmd/__init__.py index 11f3622d..32534ec6 100644 --- a/kvmd/__init__.py +++ b/kvmd/__init__.py @@ -20,4 +20,4 @@ # ========================================================================== # -__version__ = "4.3" +__version__ = "4.20" diff --git a/kvmd/aiogp.py b/kvmd/aiogp.py index 7ebe4ade..3ee0ea2b 100644 --- a/kvmd/aiogp.py +++ b/kvmd/aiogp.py @@ -83,9 +83,9 @@ class AioReader: # pylint: disable=too-many-instance-attributes self.__path, consumer=self.__consumer, config={tuple(pins): gpiod.LineSettings(edge_detection=gpiod.line.Edge.BOTH)}, - ) as line_request: + ) as line_req: - line_request.wait_edge_events(0.1) + line_req.wait_edge_events(0.1) self.__values = { pin: _DebouncedValue( initial=bool(value.value), @@ -93,14 +93,14 @@ class AioReader: # pylint: disable=too-many-instance-attributes notifier=self.__notifier, loop=self.__loop, ) - for (pin, value) in zip(pins, line_request.get_values(pins)) + for (pin, value) in zip(pins, line_req.get_values(pins)) } self.__loop.call_soon_threadsafe(self.__notifier.notify) while not self.__stop_event.is_set(): - if line_request.wait_edge_events(1): + if line_req.wait_edge_events(1): new: dict[int, bool] = {} - for event in line_request.read_edge_events(): + for event in line_req.read_edge_events(): (pin, value) = self.__parse_event(event) new[pin] = value for (pin, value) in new.items(): @@ -110,7 +110,7 @@ class AioReader: # pylint: disable=too-many-instance-attributes # Размер буфера ядра - 16 эвентов на линии. При превышении этого числа, # новые эвенты потеряются. Это не баг, это фича, как мне объяснили в LKML. # Штош. Будем с этим жить и синхронизировать состояния при таймауте. - for (pin, value) in zip(pins, line_request.get_values(pins)): + for (pin, value) in zip(pins, line_req.get_values(pins)): self.__values[pin].set(bool(value.value)) # type: ignore def __parse_event(self, event: gpiod.EdgeEvent) -> tuple[int, bool]: diff --git a/kvmd/aiohelpers.py b/kvmd/aiohelpers.py index c3b257d1..70fac32d 100644 --- a/kvmd/aiohelpers.py +++ b/kvmd/aiohelpers.py @@ -42,7 +42,7 @@ async def remount(name: str, base_cmd: list[str], rw: bool) -> bool: if proc.returncode != 0: assert proc.returncode is not None raise subprocess.CalledProcessError(proc.returncode, cmd) - except Exception as err: - logger.error("Can't remount %s storage: %s", name, tools.efmt(err)) + except Exception as ex: + logger.error("Can't remount %s storage: %s", name, tools.efmt(ex)) return False return True diff --git a/kvmd/aiomulti.py b/kvmd/aiomulti.py index 653651cb..a4537204 100644 --- a/kvmd/aiomulti.py +++ b/kvmd/aiomulti.py @@ -59,14 +59,25 @@ def queue_get_last_sync( # pylint: disable=invalid-name # ===== class AioProcessNotifier: def __init__(self) -> None: - self.__queue: "multiprocessing.Queue[None]" = multiprocessing.Queue() + self.__queue: "multiprocessing.Queue[int]" = multiprocessing.Queue() - def notify(self) -> None: - self.__queue.put_nowait(None) + def notify(self, mask: int=0) -> None: + self.__queue.put_nowait(mask) - async def wait(self) -> None: - while not (await queue_get_last(self.__queue, 0.1))[0]: - pass + async def wait(self) -> int: + while True: + mask = await aiotools.run_async(self.__get) + if mask >= 0: + return mask + + def __get(self) -> int: + try: + mask = self.__queue.get(timeout=0.1) + while not self.__queue.empty(): + mask |= self.__queue.get() + return mask + except queue.Empty: + return -1 # ===== diff --git a/kvmd/aiotools.py b/kvmd/aiotools.py index c859e176..a47c94c6 100644 --- a/kvmd/aiotools.py +++ b/kvmd/aiotools.py @@ -112,9 +112,9 @@ def shield_fg(aw: Awaitable): # type: ignore if inner.cancelled(): outer.forced_cancel() else: - err = inner.exception() - if err is not None: - outer.set_exception(err) + ex = inner.exception() + if ex is not None: + outer.set_exception(ex) else: outer.set_result(inner.result()) @@ -232,25 +232,26 @@ async def close_writer(writer: asyncio.StreamWriter) -> bool: # ===== class AioNotifier: def __init__(self) -> None: - self.__queue: "asyncio.Queue[None]" = asyncio.Queue() + self.__queue: "asyncio.Queue[int]" = asyncio.Queue() - def notify(self) -> None: - self.__queue.put_nowait(None) + def notify(self, mask: int=0) -> None: + self.__queue.put_nowait(mask) - async def wait(self, timeout: (float | None)=None) -> None: + async def wait(self, timeout: (float | None)=None) -> int: + mask = 0 if timeout is None: - await self.__queue.get() + mask = await self.__queue.get() else: try: - await asyncio.wait_for( + mask = await asyncio.wait_for( asyncio.ensure_future(self.__queue.get()), timeout=timeout, ) except asyncio.TimeoutError: - return # False + return -1 while not self.__queue.empty(): - await self.__queue.get() - # return True + mask |= await self.__queue.get() + return mask # ===== @@ -296,7 +297,7 @@ class AioExclusiveRegion: def is_busy(self) -> bool: return self.__busy - async def enter(self) -> None: + def enter(self) -> None: if not self.__busy: self.__busy = True try: @@ -308,22 +309,22 @@ class AioExclusiveRegion: return raise self.__exc_type() - async def exit(self) -> None: + def exit(self) -> None: self.__busy = False if self.__notifier: self.__notifier.notify() - async def __aenter__(self) -> None: - await self.enter() + def __enter__(self) -> None: + self.enter() - async def __aexit__( + def __exit__( self, _exc_type: type[BaseException], _exc: BaseException, _tb: types.TracebackType, ) -> None: - await self.exit() + self.exit() async def run_region_task( @@ -338,7 +339,7 @@ async def run_region_task( async def wrapper() -> None: try: - async with region: + with region: entered.set_result(None) await func(*args, **kwargs) except region.get_exc_type(): diff --git a/kvmd/apps/__init__.py b/kvmd/apps/__init__.py index 035b3cc4..cfc39499 100644 --- a/kvmd/apps/__init__.py +++ b/kvmd/apps/__init__.py @@ -33,8 +33,6 @@ import pygments.formatters from .. import tools -from ..mouse import MouseRange - from ..plugins import UnknownPluginError from ..plugins.auth import get_auth_service_class from ..plugins.hid import get_hid_class @@ -171,8 +169,8 @@ def _init_config(config_path: str, override_options: list[str], **load_flags: bo config_path = os.path.expanduser(config_path) try: raw_config: dict = load_yaml_file(config_path) - except Exception as err: - raise SystemExit(f"ConfigError: Can't read config file {config_path!r}:\n{tools.efmt(err)}") + except Exception as ex: + raise SystemExit(f"ConfigError: Can't read config file {config_path!r}:\n{tools.efmt(ex)}") if not isinstance(raw_config, dict): raise SystemExit(f"ConfigError: Top-level of the file {config_path!r} must be a dictionary") @@ -187,8 +185,8 @@ def _init_config(config_path: str, override_options: list[str], **load_flags: bo config = make_config(raw_config, scheme) return config - except (ConfigError, UnknownPluginError) as err: - raise SystemExit(f"ConfigError: {err}") + except (ConfigError, UnknownPluginError) as ex: + raise SystemExit(f"ConfigError: {ex}") def _patch_raw(raw_config: dict) -> None: # pylint: disable=too-many-branches @@ -407,19 +405,7 @@ def _get_config_scheme() -> dict: "hid": { "type": Option("", type=valid_stripped_string_not_empty), - - "keymap": Option("/usr/share/kvmd/keymaps/en-us", type=valid_abs_file), - "ignore_keys": Option([], type=functools.partial(valid_string_list, subval=valid_hid_key)), - - "mouse_x_range": { - "min": Option(MouseRange.MIN, type=valid_hid_mouse_move), - "max": Option(MouseRange.MAX, type=valid_hid_mouse_move), - }, - "mouse_y_range": { - "min": Option(MouseRange.MIN, type=valid_hid_mouse_move), - "max": Option(MouseRange.MAX, type=valid_hid_mouse_move), - }, - + "keymap": Option("/usr/share/kvmd/keymaps/en-us", type=valid_abs_file), # Dynamic content }, @@ -681,9 +667,10 @@ def _get_config_scheme() -> dict: }, "vnc": { - "desired_fps": Option(30, type=valid_stream_fps), - "mouse_output": Option("usb", type=valid_hid_mouse_output), - "keymap": Option("/usr/share/kvmd/keymaps/en-us", type=valid_abs_file), + "desired_fps": Option(30, type=valid_stream_fps), + "mouse_output": Option("usb", type=valid_hid_mouse_output), + "keymap": Option("/usr/share/kvmd/keymaps/en-us", type=valid_abs_file), + "allow_cut_after": Option(3.0, type=valid_float_f0), "server": { "host": Option("", type=valid_ip_or_host, if_empty=""), diff --git a/kvmd/apps/edidconf/__init__.py b/kvmd/apps/edidconf/__init__.py index 66136cb3..e21f797b 100644 --- a/kvmd/apps/edidconf/__init__.py +++ b/kvmd/apps/edidconf/__init__.py @@ -22,259 +22,22 @@ import sys import os -import re -import dataclasses -import contextlib import subprocess import argparse import time -from typing import IO -from typing import Generator from typing import Callable from ...validators.basic import valid_bool from ...validators.basic import valid_int_f0 +from ...edid import EdidNoBlockError +from ...edid import Edid + # from .. import init # ===== -class NoBlockError(Exception): - pass - - -@contextlib.contextmanager -def _smart_open(path: str, mode: str) -> Generator[IO, None, None]: - fd = (0 if "r" in mode else 1) - with (os.fdopen(fd, mode, closefd=False) if path == "-" else open(path, mode)) as file: - yield file - if "w" in mode: - file.flush() - - -@dataclasses.dataclass(frozen=True) -class _CeaBlock: - tag: int - data: bytes - - def __post_init__(self) -> None: - assert 0 < self.tag <= 0b111 - assert 0 < len(self.data) <= 0b11111 - - @property - def size(self) -> int: - return len(self.data) + 1 - - def pack(self) -> bytes: - header = (self.tag << 5) | len(self.data) - return header.to_bytes() + self.data - - @classmethod - def first_from_raw(cls, raw: (bytes | list[int])) -> "_CeaBlock": - assert 0 < raw[0] <= 0xFF - tag = (raw[0] & 0b11100000) >> 5 - data_size = (raw[0] & 0b00011111) - data = bytes(raw[1:data_size + 1]) - return _CeaBlock(tag, data) - - -_CEA = 128 -_CEA_AUDIO = 1 -_CEA_SPEAKERS = 4 - - -class _Edid: - # https://en.wikipedia.org/wiki/Extended_Display_Identification_Data - - def __init__(self, path: str) -> None: - with _smart_open(path, "rb") as file: - data = file.read() - if data.startswith(b"\x00\xFF\xFF\xFF\xFF\xFF\xFF\x00"): - self.__data = list(data) - else: - text = re.sub(r"\s", "", data.decode()) - self.__data = [ - int(text[index:index + 2], 16) - for index in range(0, len(text), 2) - ] - assert len(self.__data) == 256, f"Invalid EDID length: {len(self.__data)}, should be 256 bytes" - assert self.__data[126] == 1, "Zero extensions number" - assert (self.__data[_CEA + 0], self.__data[_CEA + 1]) == (0x02, 0x03), "Can't find CEA extension" - - def write_hex(self, path: str) -> None: - self.__update_checksums() - text = "\n".join( - "".join( - f"{item:0{2}X}" - for item in self.__data[index:index + 16] - ) - for index in range(0, len(self.__data), 16) - ) + "\n" - with _smart_open(path, "w") as file: - file.write(text) - - def write_bin(self, path: str) -> None: - self.__update_checksums() - with _smart_open(path, "wb") as file: - file.write(bytes(self.__data)) - - def __update_checksums(self) -> None: - self.__data[127] = 256 - (sum(self.__data[:127]) % 256) - self.__data[255] = 256 - (sum(self.__data[128:255]) % 256) - - # ===== - - def get_mfc_id(self) -> str: - raw = self.__data[8] << 8 | self.__data[9] - return bytes([ - ((raw >> 10) & 0b11111) + 0x40, - ((raw >> 5) & 0b11111) + 0x40, - (raw & 0b11111) + 0x40, - ]).decode("ascii") - - def set_mfc_id(self, mfc_id: str) -> None: - assert len(mfc_id) == 3, "Mfc ID must be 3 characters long" - data = mfc_id.upper().encode("ascii") - for ch in data: - assert 0x41 <= ch <= 0x5A, "Mfc ID must contain only A-Z characters" - raw = ( - (data[2] - 0x40) - | ((data[1] - 0x40) << 5) - | ((data[0] - 0x40) << 10) - ) - self.__data[8] = (raw >> 8) & 0xFF - self.__data[9] = raw & 0xFF - - # ===== - - def get_product_id(self) -> int: - return (self.__data[10] | self.__data[11] << 8) - - def set_product_id(self, product_id: int) -> None: - assert 0 <= product_id <= 0xFFFF, f"Product ID should be from 0 to {0xFFFF}" - self.__data[10] = product_id & 0xFF - self.__data[11] = (product_id >> 8) & 0xFF - - # ===== - - def get_serial(self) -> int: - return ( - self.__data[12] - | self.__data[13] << 8 - | self.__data[14] << 16 - | self.__data[15] << 24 - ) - - def set_serial(self, serial: int) -> None: - assert 0 <= serial <= 0xFFFFFFFF, f"Serial should be from 0 to {0xFFFFFFFF}" - self.__data[12] = serial & 0xFF - self.__data[13] = (serial >> 8) & 0xFF - self.__data[14] = (serial >> 16) & 0xFF - self.__data[15] = (serial >> 24) & 0xFF - - # ===== - - def get_monitor_name(self) -> str: - return self.__get_dtd_text(0xFC, "Monitor Name") - - def set_monitor_name(self, text: str) -> None: - self.__set_dtd_text(0xFC, "Monitor Name", text) - - def get_monitor_serial(self) -> str: - return self.__get_dtd_text(0xFF, "Monitor Serial") - - def set_monitor_serial(self, text: str) -> None: - self.__set_dtd_text(0xFF, "Monitor Serial", text) - - def __get_dtd_text(self, d_type: int, name: str) -> str: - index = self.__find_dtd_text(d_type, name) - return bytes(self.__data[index:index + 13]).decode("cp437").strip() - - def __set_dtd_text(self, d_type: int, name: str, text: str) -> None: - index = self.__find_dtd_text(d_type, name) - encoded = (text[:13] + "\n" + " " * 12)[:13].encode("cp437") - for (offset, ch) in enumerate(encoded): - self.__data[index + offset] = ch - - def __find_dtd_text(self, d_type: int, name: str) -> int: - for index in [54, 72, 90, 108]: - if self.__data[index + 3] == d_type: - return index + 5 - raise NoBlockError(f"Can't find DTD {name}") - - # ===== CEA ===== - - def get_audio(self) -> bool: - (cbs, _) = self.__parse_cea() - audio = False - speakers = False - for cb in cbs: - if cb.tag == _CEA_AUDIO: - audio = True - elif cb.tag == _CEA_SPEAKERS: - speakers = True - return (audio and speakers and self.__get_basic_audio()) - - def set_audio(self, enabled: bool) -> None: - (cbs, dtds) = self.__parse_cea() - cbs = [cb for cb in cbs if cb.tag not in [_CEA_AUDIO, _CEA_SPEAKERS]] - if enabled: - cbs.append(_CeaBlock(_CEA_AUDIO, b"\x09\x7f\x07")) - cbs.append(_CeaBlock(_CEA_SPEAKERS, b"\x01\x00\x00")) - self.__replace_cea(cbs, dtds) - self.__set_basic_audio(enabled) - - def __get_basic_audio(self) -> bool: - return bool(self.__data[_CEA + 3] & 0b01000000) - - def __set_basic_audio(self, enabled: bool) -> None: - if enabled: - self.__data[_CEA + 3] |= 0b01000000 - else: - self.__data[_CEA + 3] &= (0xFF - 0b01000000) # ~X - - def __parse_cea(self) -> tuple[list[_CeaBlock], bytes]: - cea = self.__data[_CEA:] - dtd_begin = cea[2] - if dtd_begin == 0: - return ([], b"") - - cbs: list[_CeaBlock] = [] - if dtd_begin > 4: - raw = cea[4:dtd_begin] - while len(raw) != 0: - cb = _CeaBlock.first_from_raw(raw) - cbs.append(cb) - raw = raw[cb.size:] - - dtds = b"" - assert dtd_begin >= 4 - raw = cea[dtd_begin:] - while len(raw) > (18 + 1) and raw[0] != 0: - dtds += bytes(raw[:18]) - raw = raw[18:] - - return (cbs, dtds) - - def __replace_cea(self, cbs: list[_CeaBlock], dtds: bytes) -> None: - cbs_packed = b"" - for cb in cbs: - cbs_packed += cb.pack() - - raw = cbs_packed + dtds - assert len(raw) <= (128 - 4 - 1), "Too many CEA blocks or DTDs" - - self.__data[_CEA + 2] = (0 if len(raw) == 0 else (len(cbs_packed) + 4)) - - for index in range(4, 127): - try: - ch = raw[index - 4] - except IndexError: - ch = 0 - self.__data[_CEA + index] = ch - - def _format_bool(value: bool) -> str: return ("yes" if value else "no") @@ -283,7 +46,7 @@ def _make_format_hex(size: int) -> Callable[[int], str]: return (lambda value: ("0x{:0%dX} ({})" % (size * 2)).format(value, value)) -def _print_edid(edid: _Edid) -> None: +def _print_edid(edid: Edid) -> None: for (key, get, fmt) in [ ("Manufacturer ID:", edid.get_mfc_id, str), ("Product ID: ", edid.get_product_id, _make_format_hex(2)), @@ -294,7 +57,7 @@ def _print_edid(edid: _Edid) -> None: ]: try: print(key, fmt(get()), file=sys.stderr) # type: ignore - except NoBlockError: + except EdidNoBlockError: pass @@ -348,12 +111,12 @@ def main(argv: (list[str] | None)=None) -> None: # pylint: disable=too-many-bra help="Presets directory", metavar="") options = parser.parse_args(argv[1:]) - base: (_Edid | None) = None + base: (Edid | None) = None if options.import_preset: imp = options.import_preset if "." in imp: (base_name, imp) = imp.split(".", 1) # v3.1080p-by-default - base = _Edid(os.path.join(options.presets_path, f"{base_name}.hex")) + base = Edid.from_file(os.path.join(options.presets_path, f"{base_name}.hex")) imp = f"_{imp}" options.imp = os.path.join(options.presets_path, f"{imp}.hex") @@ -362,16 +125,16 @@ def main(argv: (list[str] | None)=None) -> None: # pylint: disable=too-many-bra options.export_hex = options.edid_path options.edid_path = options.imp - edid = _Edid(options.edid_path) + edid = Edid.from_file(options.edid_path) changed = False - for cmd in dir(_Edid): + for cmd in dir(Edid): if cmd.startswith("set_"): value = getattr(options, cmd) if value is None and base is not None: try: value = getattr(base, cmd.replace("set_", "get_"))() - except NoBlockError: + except EdidNoBlockError: pass if value is not None: getattr(edid, cmd)(value) @@ -400,8 +163,7 @@ def main(argv: (list[str] | None)=None) -> None: # pylint: disable=too-many-bra "/usr/bin/v4l2-ctl", f"--device={options.device_path}", f"--set-edid=file={orig_edid_path}", - "--fix-edid-checksums", "--info-edid", ], stdout=sys.stderr, check=True) - except subprocess.CalledProcessError as err: - raise SystemExit(str(err)) + except subprocess.CalledProcessError as ex: + raise SystemExit(str(ex)) diff --git a/kvmd/apps/htpasswd/__init__.py b/kvmd/apps/htpasswd/__init__.py index fd006ee2..9e857abc 100644 --- a/kvmd/apps/htpasswd/__init__.py +++ b/kvmd/apps/htpasswd/__init__.py @@ -155,5 +155,5 @@ def main(argv: (list[str] | None)=None) -> None: options = parser.parse_args(argv[1:]) try: options.cmd(config, options) - except ValidatorError as err: - raise SystemExit(str(err)) + except ValidatorError as ex: + raise SystemExit(str(ex)) diff --git a/kvmd/apps/ipmi/server.py b/kvmd/apps/ipmi/server.py index c6e35fae..2fc897f9 100644 --- a/kvmd/apps/ipmi/server.py +++ b/kvmd/apps/ipmi/server.py @@ -101,6 +101,7 @@ class IpmiServer(BaseIpmiServer): # pylint: disable=too-many-instance-attribute # ===== def handle_raw_request(self, request: dict, session: IpmiServerSession) -> None: + # Parameter 'request' has been renamed to 'req' in overriding method handler = { (6, 1): (lambda _, session: self.send_device_id(session)), # Get device ID (6, 7): self.__get_power_state_handler, # Power state @@ -145,13 +146,13 @@ class IpmiServer(BaseIpmiServer): # pylint: disable=too-many-instance-attribute data = [int(result["leds"]["power"]), 0, 0] session.send_ipmi_response(data=data) - def __chassis_control_handler(self, request: dict, session: IpmiServerSession) -> None: + def __chassis_control_handler(self, req: dict, session: IpmiServerSession) -> None: action = { 0: "off_hard", 1: "on", 3: "reset_hard", 5: "off", - }.get(request["data"][0], "") + }.get(req["data"][0], "") if action: if not self.__make_request(session, f"atx.switch_power({action})", "atx.switch_power", action=action): code = 0xC0 # Try again later @@ -171,8 +172,8 @@ class IpmiServer(BaseIpmiServer): # pylint: disable=too-many-instance-attribute async with self.__kvmd.make_session(credentials.kvmd_user, credentials.kvmd_passwd) as kvmd_session: func = functools.reduce(getattr, func_path.split("."), kvmd_session) return (await func(**kwargs)) - except (aiohttp.ClientError, asyncio.TimeoutError) as err: - logger.error("[%s]: Can't perform request %s: %s", session.sockaddr[0], name, err) + except (aiohttp.ClientError, asyncio.TimeoutError) as ex: + logger.error("[%s]: Can't perform request %s: %s", session.sockaddr[0], name, ex) raise return aiotools.run_sync(runner()) diff --git a/kvmd/apps/janus/runner.py b/kvmd/apps/janus/runner.py index e08fade0..9e426021 100644 --- a/kvmd/apps/janus/runner.py +++ b/kvmd/apps/janus/runner.py @@ -11,16 +11,17 @@ from ... import aioproc from ...logging import get_logger +from .stun import StunNatType from .stun import Stun # ===== @dataclasses.dataclass(frozen=True) class _Netcfg: - nat_type: str = dataclasses.field(default="") - src_ip: str = dataclasses.field(default="") - ext_ip: str = dataclasses.field(default="") - stun_host: str = dataclasses.field(default="") + nat_type: StunNatType = dataclasses.field(default=StunNatType.ERROR) + src_ip: str = dataclasses.field(default="") + ext_ip: str = dataclasses.field(default="") + stun_ip: str = dataclasses.field(default="") stun_port: int = dataclasses.field(default=0) @@ -92,8 +93,9 @@ class JanusRunner: # pylint: disable=too-many-instance-attributes async def __get_netcfg(self) -> _Netcfg: src_ip = (self.__get_default_ip() or "0.0.0.0") - (stun, (nat_type, ext_ip)) = await self.__get_stun_info(src_ip) - return _Netcfg(nat_type, src_ip, ext_ip, stun.host, stun.port) + info = await self.__stun.get_info(src_ip, 0) + # В текущей реализации _Netcfg() это копия StunInfo() + return _Netcfg(**dataclasses.asdict(info)) def __get_default_ip(self) -> str: try: @@ -111,17 +113,10 @@ class JanusRunner: # pylint: disable=too-many-instance-attributes for proto in [socket.AF_INET, socket.AF_INET6]: if proto in addrs: return addrs[proto][0]["addr"] - except Exception as err: - get_logger().error("Can't get default IP: %s", tools.efmt(err)) + except Exception as ex: + get_logger().error("Can't get default IP: %s", tools.efmt(ex)) return "" - async def __get_stun_info(self, src_ip: str) -> tuple[Stun, tuple[str, str]]: - try: - return (self.__stun, (await self.__stun.get_info(src_ip, 0))) - except Exception as err: - get_logger().error("Can't get STUN info: %s", tools.efmt(err)) - return (self.__stun, ("", "")) - # ===== @aiotools.atomic_fg @@ -162,7 +157,7 @@ class JanusRunner: # pylint: disable=too-many-instance-attributes async def __start_janus_proc(self, netcfg: _Netcfg) -> None: assert self.__janus_proc is None placeholders = { - "o_stun_server": f"--stun-server={netcfg.stun_host}:{netcfg.stun_port}", + "o_stun_server": f"--stun-server={netcfg.stun_ip}:{netcfg.stun_port}", **{ key: str(value) for (key, value) in dataclasses.asdict(netcfg).items() diff --git a/kvmd/apps/janus/stun.py b/kvmd/apps/janus/stun.py index 5fea9da6..41cd86e7 100644 --- a/kvmd/apps/janus/stun.py +++ b/kvmd/apps/janus/stun.py @@ -4,6 +4,7 @@ import ipaddress import struct import secrets import dataclasses +import enum from ... import tools from ... import aiotools @@ -12,29 +13,39 @@ from ...logging import get_logger # ===== +class StunNatType(enum.Enum): + ERROR = "" + BLOCKED = "Blocked" + OPEN_INTERNET = "Open Internet" + SYMMETRIC_UDP_FW = "Symmetric UDP Firewall" + FULL_CONE_NAT = "Full Cone NAT" + RESTRICTED_NAT = "Restricted NAT" + RESTRICTED_PORT_NAT = "Restricted Port NAT" + SYMMETRIC_NAT = "Symmetric NAT" + CHANGED_ADDR_ERROR = "Error when testing on Changed-IP and Port" + + @dataclasses.dataclass(frozen=True) -class StunAddress: - ip: str +class StunInfo: + nat_type: StunNatType + src_ip: str + ext_ip: str + stun_ip: str + stun_port: int + + +@dataclasses.dataclass(frozen=True) +class _StunAddress: + ip: str port: int @dataclasses.dataclass(frozen=True) -class StunResponse: - ok: bool - ext: (StunAddress | None) = dataclasses.field(default=None) - src: (StunAddress | None) = dataclasses.field(default=None) - changed: (StunAddress | None) = dataclasses.field(default=None) - - -class StunNatType: - BLOCKED = "Blocked" - OPEN_INTERNET = "Open Internet" - SYMMETRIC_UDP_FW = "Symmetric UDP Firewall" - FULL_CONE_NAT = "Full Cone NAT" - RESTRICTED_NAT = "Restricted NAT" - RESTRICTED_PORT_NAT = "Restricted Port NAT" - SYMMETRIC_NAT = "Symmetric NAT" - CHANGED_ADDR_ERROR = "Error when testing on Changed-IP and Port" +class _StunResponse: + ok: bool + ext: (_StunAddress | None) = dataclasses.field(default=None) + src: (_StunAddress | None) = dataclasses.field(default=None) + changed: (_StunAddress | None) = dataclasses.field(default=None) # ===== @@ -50,58 +61,94 @@ class Stun: retries_delay: float, ) -> None: - self.host = host - self.port = port + self.__host = host + self.__port = port self.__timeout = timeout self.__retries = retries self.__retries_delay = retries_delay + self.__stun_ip = "" self.__sock: (socket.socket | None) = None - async def get_info(self, src_ip: str, src_port: int) -> tuple[str, str]: - (family, _, _, _, addr) = socket.getaddrinfo(src_ip, src_port, type=socket.SOCK_DGRAM)[0] + async def get_info(self, src_ip: str, src_port: int) -> StunInfo: + nat_type = StunNatType.ERROR + ext_ip = "" try: - with socket.socket(family, socket.SOCK_DGRAM) as self.__sock: + (src_fam, _, _, _, src_addr) = (await self.__retried_getaddrinfo_udp(src_ip, src_port))[0] + + stun_ips = [ + stun_addr[0] + for (stun_fam, _, _, _, stun_addr) in (await self.__retried_getaddrinfo_udp(self.__host, self.__port)) + if stun_fam == src_fam + ] + if not stun_ips: + raise RuntimeError(f"Can't resolve {src_fam.name} address for STUN") + if not self.__stun_ip or self.__stun_ip not in stun_ips: + # On new IP, changed family, etc. + self.__stun_ip = stun_ips[0] + + with socket.socket(src_fam, socket.SOCK_DGRAM) as self.__sock: self.__sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) self.__sock.settimeout(self.__timeout) - self.__sock.bind(addr) - (nat_type, response) = await self.__get_nat_type(src_ip) - return (nat_type, (response.ext.ip if response.ext is not None else "")) + self.__sock.bind(src_addr) + (nat_type, resp) = await self.__get_nat_type(src_ip) + ext_ip = (resp.ext.ip if resp.ext is not None else "") + except Exception as ex: + get_logger(0).error("Can't get STUN info: %s", tools.efmt(ex)) finally: self.__sock = None - async def __get_nat_type(self, src_ip: str) -> tuple[str, StunResponse]: # pylint: disable=too-many-return-statements - first = await self.__make_request("First probe") + return StunInfo( + nat_type=nat_type, + src_ip=src_ip, + ext_ip=ext_ip, + stun_ip=self.__stun_ip, + stun_port=self.__port, + ) + + async def __retried_getaddrinfo_udp(self, host: str, port: int) -> list: + retries = self.__retries + while True: + try: + return socket.getaddrinfo(host, port, type=socket.SOCK_DGRAM) + except Exception: + retries -= 1 + if retries == 0: + raise + await asyncio.sleep(self.__retries_delay) + + async def __get_nat_type(self, src_ip: str) -> tuple[StunNatType, _StunResponse]: # pylint: disable=too-many-return-statements + first = await self.__make_request("First probe", self.__stun_ip, b"") if not first.ok: return (StunNatType.BLOCKED, first) - request = struct.pack(">HHI", 0x0003, 0x0004, 0x00000006) # Change-Request - response = await self.__make_request("Change request [ext_ip == src_ip]", request) + req = struct.pack(">HHI", 0x0003, 0x0004, 0x00000006) # Change-Request + resp = await self.__make_request("Change request [ext_ip == src_ip]", self.__stun_ip, req) if first.ext is not None and first.ext.ip == src_ip: - if response.ok: - return (StunNatType.OPEN_INTERNET, response) - return (StunNatType.SYMMETRIC_UDP_FW, response) + if resp.ok: + return (StunNatType.OPEN_INTERNET, resp) + return (StunNatType.SYMMETRIC_UDP_FW, resp) - if response.ok: - return (StunNatType.FULL_CONE_NAT, response) + if resp.ok: + return (StunNatType.FULL_CONE_NAT, resp) if first.changed is None: raise RuntimeError(f"Changed addr is None: {first}") - response = await self.__make_request("Change request [ext_ip != src_ip]", addr=first.changed) - if not response.ok: - return (StunNatType.CHANGED_ADDR_ERROR, response) + resp = await self.__make_request("Change request [ext_ip != src_ip]", first.changed, b"") + if not resp.ok: + return (StunNatType.CHANGED_ADDR_ERROR, resp) - if response.ext == first.ext: - request = struct.pack(">HHI", 0x0003, 0x0004, 0x00000002) - response = await self.__make_request("Change port", request, addr=first.changed.ip) - if response.ok: - return (StunNatType.RESTRICTED_NAT, response) - return (StunNatType.RESTRICTED_PORT_NAT, response) + if resp.ext == first.ext: + req = struct.pack(">HHI", 0x0003, 0x0004, 0x00000002) + resp = await self.__make_request("Change port", first.changed.ip, req) + if resp.ok: + return (StunNatType.RESTRICTED_NAT, resp) + return (StunNatType.RESTRICTED_PORT_NAT, resp) - return (StunNatType.SYMMETRIC_NAT, response) + return (StunNatType.SYMMETRIC_NAT, resp) - async def __make_request(self, ctx: str, request: bytes=b"", addr: (StunAddress | str | None)=None) -> StunResponse: + async def __make_request(self, ctx: str, addr: (_StunAddress | str), req: bytes) -> _StunResponse: # TODO: Support IPv6 and RFC 5389 # The first 4 bytes of the response are the Type (2) and Length (2) # The 5th byte is Reserved @@ -111,32 +158,29 @@ class Stun: # More info at: https://tools.ietf.org/html/rfc3489#section-11.2.1 # And at: https://tools.ietf.org/html/rfc5389#section-15.1 - if isinstance(addr, StunAddress): + if isinstance(addr, _StunAddress): addr_t = (addr.ip, addr.port) - elif isinstance(addr, str): - addr_t = (addr, self.port) - else: - assert addr is None - addr_t = (self.host, self.port) + else: # str + addr_t = (addr, self.__port) # https://datatracker.ietf.org/doc/html/rfc5389#section-6 trans_id = b"\x21\x12\xA4\x42" + secrets.token_bytes(12) - (response, error) = (b"", "") + (resp, error) = (b"", "") for _ in range(self.__retries): - (response, error) = await self.__inner_make_request(trans_id, request, addr_t) + (resp, error) = await self.__inner_make_request(trans_id, req, addr_t) if not error: break await asyncio.sleep(self.__retries_delay) if error: get_logger(0).error("%s: Can't perform STUN request after %d retries; last error: %s", ctx, self.__retries, error) - return StunResponse(ok=False) + return _StunResponse(ok=False) - parsed: dict[str, StunAddress] = {} + parsed: dict[str, _StunAddress] = {} offset = 0 - remaining = len(response) + remaining = len(resp) while remaining > 0: - (attr_type, attr_len) = struct.unpack(">HH", response[offset : offset + 4]) # noqa: E203 + (attr_type, attr_len) = struct.unpack(">HH", resp[offset : offset + 4]) # noqa: E203 offset += 4 field = { 0x0001: "ext", # MAPPED-ADDRESS @@ -145,40 +189,40 @@ class Stun: 0x0005: "changed", # CHANGED-ADDRESS }.get(attr_type) if field is not None: - parsed[field] = self.__parse_address(response[offset:], (trans_id if attr_type == 0x0020 else b"")) + parsed[field] = self.__parse_address(resp[offset:], (trans_id if attr_type == 0x0020 else b"")) offset += attr_len remaining -= (4 + attr_len) - return StunResponse(ok=True, **parsed) + return _StunResponse(ok=True, **parsed) - async def __inner_make_request(self, trans_id: bytes, request: bytes, addr: tuple[str, int]) -> tuple[bytes, str]: + async def __inner_make_request(self, trans_id: bytes, req: bytes, addr: tuple[str, int]) -> tuple[bytes, str]: assert self.__sock is not None - request = struct.pack(">HH", 0x0001, len(request)) + trans_id + request # Bind Request + req = struct.pack(">HH", 0x0001, len(req)) + trans_id + req # Bind Request try: - await aiotools.run_async(self.__sock.sendto, request, addr) - except Exception as err: - return (b"", f"Send error: {tools.efmt(err)}") + await aiotools.run_async(self.__sock.sendto, req, addr) + except Exception as ex: + return (b"", f"Send error: {tools.efmt(ex)}") try: - response = (await aiotools.run_async(self.__sock.recvfrom, 2048))[0] - except Exception as err: - return (b"", f"Recv error: {tools.efmt(err)}") + resp = (await aiotools.run_async(self.__sock.recvfrom, 2048))[0] + except Exception as ex: + return (b"", f"Recv error: {tools.efmt(ex)}") - (response_type, payload_len) = struct.unpack(">HH", response[:4]) - if response_type != 0x0101: - return (b"", f"Invalid response type: {response_type:#06x}") - if trans_id != response[4:20]: + (resp_type, payload_len) = struct.unpack(">HH", resp[:4]) + if resp_type != 0x0101: + return (b"", f"Invalid response type: {resp_type:#06x}") + if trans_id != resp[4:20]: return (b"", "Transaction ID mismatch") - return (response[20 : 20 + payload_len], "") # noqa: E203 + return (resp[20 : 20 + payload_len], "") # noqa: E203 - def __parse_address(self, data: bytes, trans_id: bytes) -> StunAddress: + def __parse_address(self, data: bytes, trans_id: bytes) -> _StunAddress: family = data[1] port = struct.unpack(">H", self.__trans_xor(data[2:4], trans_id))[0] if family == 0x01: - return StunAddress(str(ipaddress.IPv4Address(self.__trans_xor(data[4:8], trans_id))), port) + return _StunAddress(str(ipaddress.IPv4Address(self.__trans_xor(data[4:8], trans_id))), port) elif family == 0x02: - return StunAddress(str(ipaddress.IPv6Address(self.__trans_xor(data[4:20], trans_id))), port) + return _StunAddress(str(ipaddress.IPv6Address(self.__trans_xor(data[4:20], trans_id))), port) raise RuntimeError(f"Unknown family; received: {family}") def __trans_xor(self, data: bytes, trans_id: bytes) -> bytes: diff --git a/kvmd/apps/kvmd/__init__.py b/kvmd/apps/kvmd/__init__.py index 7cf8430c..495a320f 100644 --- a/kvmd/apps/kvmd/__init__.py +++ b/kvmd/apps/kvmd/__init__.py @@ -56,7 +56,7 @@ def main(argv: (list[str] | None)=None) -> None: if config.kvmd.msd.type == "otg": msd_kwargs["gadget"] = config.otg.gadget # XXX: Small crutch to pass gadget name to the plugin - hid_kwargs = config.kvmd.hid._unpack(ignore=["type", "keymap", "ignore_keys", "mouse_x_range", "mouse_y_range"]) + hid_kwargs = config.kvmd.hid._unpack(ignore=["type", "keymap"]) if config.kvmd.hid.type == "otg": hid_kwargs["udc"] = config.otg.udc # XXX: Small crutch to pass UDC to the plugin @@ -103,9 +103,6 @@ def main(argv: (list[str] | None)=None) -> None: ), keymap_path=config.hid.keymap, - ignore_keys=config.hid.ignore_keys, - mouse_x_range=(config.hid.mouse_x_range.min, config.hid.mouse_x_range.max), - mouse_y_range=(config.hid.mouse_y_range.min, config.hid.mouse_y_range.max), stream_forever=config.streamer.forever, ).run(**config.server._unpack()) diff --git a/kvmd/apps/kvmd/api/atx.py b/kvmd/apps/kvmd/api/atx.py index b7f74c99..df952b7b 100644 --- a/kvmd/apps/kvmd/api/atx.py +++ b/kvmd/apps/kvmd/api/atx.py @@ -45,9 +45,9 @@ class AtxApi: return make_json_response(await self.__atx.get_state()) @exposed_http("POST", "/atx/power") - async def __power_handler(self, request: Request) -> Response: - action = valid_atx_power_action(request.query.get("action")) - wait = valid_bool(request.query.get("wait", False)) + async def __power_handler(self, req: Request) -> Response: + action = valid_atx_power_action(req.query.get("action")) + wait = valid_bool(req.query.get("wait", False)) await ({ "on": self.__atx.power_on, "off": self.__atx.power_off, @@ -57,9 +57,9 @@ class AtxApi: return make_json_response() @exposed_http("POST", "/atx/click") - async def __click_handler(self, request: Request) -> Response: - button = valid_atx_button(request.query.get("button")) - wait = valid_bool(request.query.get("wait", False)) + async def __click_handler(self, req: Request) -> Response: + button = valid_atx_button(req.query.get("button")) + wait = valid_bool(req.query.get("wait", False)) await ({ "power": self.__atx.click_power, "power_long": self.__atx.click_power_long, diff --git a/kvmd/apps/kvmd/api/auth.py b/kvmd/apps/kvmd/api/auth.py index 0c7d5484..dee4a85d 100644 --- a/kvmd/apps/kvmd/api/auth.py +++ b/kvmd/apps/kvmd/api/auth.py @@ -43,34 +43,34 @@ from ..auth import AuthManager _COOKIE_AUTH_TOKEN = "auth_token" -async def check_request_auth(auth_manager: AuthManager, exposed: HttpExposed, request: Request) -> None: +async def check_request_auth(auth_manager: AuthManager, exposed: HttpExposed, req: Request) -> None: if auth_manager.is_auth_required(exposed): - user = request.headers.get("X-KVMD-User", "") + user = req.headers.get("X-KVMD-User", "") if user: user = valid_user(user) - passwd = request.headers.get("X-KVMD-Passwd", "") - set_request_auth_info(request, f"{user} (xhdr)") + passwd = req.headers.get("X-KVMD-Passwd", "") + set_request_auth_info(req, f"{user} (xhdr)") if not (await auth_manager.authorize(user, valid_passwd(passwd))): raise ForbiddenError() return - token = request.cookies.get(_COOKIE_AUTH_TOKEN, "") + token = req.cookies.get(_COOKIE_AUTH_TOKEN, "") if token: user = auth_manager.check(valid_auth_token(token)) # type: ignore if not user: - set_request_auth_info(request, "- (token)") + set_request_auth_info(req, "- (token)") raise ForbiddenError() - set_request_auth_info(request, f"{user} (token)") + set_request_auth_info(req, f"{user} (token)") return - basic_auth = request.headers.get("Authorization", "") + basic_auth = req.headers.get("Authorization", "") if basic_auth and basic_auth[:6].lower() == "basic ": try: (user, passwd) = base64.b64decode(basic_auth[6:]).decode("utf-8").split(":") except Exception: raise UnauthorizedError() user = valid_user(user) - set_request_auth_info(request, f"{user} (basic)") + set_request_auth_info(req, f"{user} (basic)") if not (await auth_manager.authorize(user, valid_passwd(passwd))): raise ForbiddenError() return @@ -85,9 +85,9 @@ class AuthApi: # ===== @exposed_http("POST", "/auth/login", auth_required=False) - async def __login_handler(self, request: Request) -> Response: + async def __login_handler(self, req: Request) -> Response: if self.__auth_manager.is_auth_enabled(): - credentials = await request.post() + credentials = await req.post() token = await self.__auth_manager.login( user=valid_user(credentials.get("user", "")), passwd=valid_passwd(credentials.get("passwd", "")), @@ -98,9 +98,9 @@ class AuthApi: return make_json_response() @exposed_http("POST", "/auth/logout") - async def __logout_handler(self, request: Request) -> Response: + async def __logout_handler(self, req: Request) -> Response: if self.__auth_manager.is_auth_enabled(): - token = valid_auth_token(request.cookies.get(_COOKIE_AUTH_TOKEN, "")) + token = valid_auth_token(req.cookies.get(_COOKIE_AUTH_TOKEN, "")) self.__auth_manager.logout(token) return make_json_response() diff --git a/kvmd/apps/kvmd/api/export.py b/kvmd/apps/kvmd/api/export.py index 998c5d81..bb048f53 100644 --- a/kvmd/apps/kvmd/api/export.py +++ b/kvmd/apps/kvmd/api/export.py @@ -55,10 +55,9 @@ class ExportApi: @async_lru.alru_cache(maxsize=1, ttl=5) async def __get_prometheus_metrics(self) -> str: - (atx_state, hw_state, fan_state, gpio_state) = await asyncio.gather(*[ + (atx_state, info_state, gpio_state) = await asyncio.gather(*[ self.__atx.get_state(), - self.__info_manager.get_submanager("hw").get_state(), - self.__info_manager.get_submanager("fan").get_state(), + self.__info_manager.get_state(["hw", "fan"]), self.__user_gpio.get_state(), ]) rows: list[str] = [] @@ -72,8 +71,8 @@ class ExportApi: for key in ["online", "state"]: self.__append_prometheus_rows(rows, ch_state["state"], f"pikvm_gpio_{mode}_{key}_{channel}") - self.__append_prometheus_rows(rows, hw_state["health"], "pikvm_hw") # type: ignore - self.__append_prometheus_rows(rows, fan_state, "pikvm_fan") + self.__append_prometheus_rows(rows, info_state["hw"]["health"], "pikvm_hw") # type: ignore + self.__append_prometheus_rows(rows, info_state["fan"], "pikvm_fan") return "\n".join(rows) diff --git a/kvmd/apps/kvmd/api/hid.py b/kvmd/apps/kvmd/api/hid.py index 326daf44..51b9dc00 100644 --- a/kvmd/apps/kvmd/api/hid.py +++ b/kvmd/apps/kvmd/api/hid.py @@ -25,13 +25,12 @@ import stat import functools import struct +from typing import Iterable from typing import Callable from aiohttp.web import Request from aiohttp.web import Response -from ....mouse import MouseRange - from ....keyboard.keysym import build_symmap from ....keyboard.printer import text_to_web_keys @@ -59,12 +58,7 @@ class HidApi: def __init__( self, hid: BaseHid, - keymap_path: str, - ignore_keys: list[str], - - mouse_x_range: tuple[int, int], - mouse_y_range: tuple[int, int], ) -> None: self.__hid = hid @@ -73,11 +67,6 @@ class HidApi: self.__default_keymap_name = os.path.basename(keymap_path) self.__ensure_symmap(self.__default_keymap_name) - self.__ignore_keys = ignore_keys - - self.__mouse_x_range = mouse_x_range - self.__mouse_y_range = mouse_y_range - # ===== @exposed_http("GET", "/hid") @@ -85,22 +74,22 @@ class HidApi: return make_json_response(await self.__hid.get_state()) @exposed_http("POST", "/hid/set_params") - async def __set_params_handler(self, request: Request) -> Response: + async def __set_params_handler(self, req: Request) -> Response: params = { - key: validator(request.query.get(key)) + key: validator(req.query.get(key)) for (key, validator) in [ ("keyboard_output", valid_hid_keyboard_output), ("mouse_output", valid_hid_mouse_output), ("jiggler", valid_bool), ] - if request.query.get(key) is not None + if req.query.get(key) is not None } self.__hid.set_params(**params) # type: ignore return make_json_response() @exposed_http("POST", "/hid/set_connected") - async def __set_connected_handler(self, request: Request) -> Response: - self.__hid.set_connected(valid_bool(request.query.get("connected"))) + async def __set_connected_handler(self, req: Request) -> Response: + self.__hid.set_connected(valid_bool(req.query.get("connected"))) return make_json_response() @exposed_http("POST", "/hid/reset") @@ -128,13 +117,13 @@ class HidApi: return make_json_response(await self.get_keymaps()) @exposed_http("POST", "/hid/print") - async def __print_handler(self, request: Request) -> Response: - text = await request.text() - limit = int(valid_int_f0(request.query.get("limit", 1024))) + async def __print_handler(self, req: Request) -> Response: + text = await req.text() + limit = int(valid_int_f0(req.query.get("limit", 1024))) if limit > 0: text = text[:limit] - symmap = self.__ensure_symmap(request.query.get("keymap", self.__default_keymap_name)) - self.__hid.send_key_events(text_to_web_keys(text, symmap)) + symmap = self.__ensure_symmap(req.query.get("keymap", self.__default_keymap_name)) + self.__hid.send_key_events(text_to_web_keys(text, symmap), no_ignore_keys=True) return make_json_response() def __ensure_symmap(self, keymap_name: str) -> dict[int, dict[int, str]]: @@ -162,8 +151,7 @@ class HidApi: state = valid_bool(data[0]) except Exception: return - if key not in self.__ignore_keys: - self.__hid.send_key_events([(key, state)]) + self.__hid.send_key_event(key, state) @exposed_ws(2) async def __ws_bin_mouse_button_handler(self, _: WsSession, data: bytes) -> None: @@ -182,17 +170,17 @@ class HidApi: to_y = valid_hid_mouse_move(to_y) except Exception: return - self.__send_mouse_move_event(to_x, to_y) + self.__hid.send_mouse_move_event(to_x, to_y) @exposed_ws(4) async def __ws_bin_mouse_relative_handler(self, _: WsSession, data: bytes) -> None: - self.__process_ws_bin_delta_request(data, self.__hid.send_mouse_relative_event) + self.__process_ws_bin_delta_request(data, self.__hid.send_mouse_relative_events) @exposed_ws(5) async def __ws_bin_mouse_wheel_handler(self, _: WsSession, data: bytes) -> None: - self.__process_ws_bin_delta_request(data, self.__hid.send_mouse_wheel_event) + self.__process_ws_bin_delta_request(data, self.__hid.send_mouse_wheel_events) - def __process_ws_bin_delta_request(self, data: bytes, handler: Callable[[int, int], None]) -> None: + def __process_ws_bin_delta_request(self, data: bytes, handler: Callable[[Iterable[tuple[int, int]], bool], None]) -> None: try: squash = valid_bool(data[0]) data = data[1:] @@ -202,7 +190,7 @@ class HidApi: deltas.append((valid_hid_mouse_delta(delta_x), valid_hid_mouse_delta(delta_y))) except Exception: return - self.__send_mouse_delta_event(deltas, squash, handler) + handler(deltas, squash) # ===== @@ -213,8 +201,7 @@ class HidApi: state = valid_bool(event["state"]) except Exception: return - if key not in self.__ignore_keys: - self.__hid.send_key_events([(key, state)]) + self.__hid.send_key_event(key, state) @exposed_ws("mouse_button") async def __ws_mouse_button_handler(self, _: WsSession, event: dict) -> None: @@ -232,17 +219,17 @@ class HidApi: to_y = valid_hid_mouse_move(event["to"]["y"]) except Exception: return - self.__send_mouse_move_event(to_x, to_y) + self.__hid.send_mouse_move_event(to_x, to_y) @exposed_ws("mouse_relative") async def __ws_mouse_relative_handler(self, _: WsSession, event: dict) -> None: - self.__process_ws_delta_event(event, self.__hid.send_mouse_relative_event) + self.__process_ws_delta_event(event, self.__hid.send_mouse_relative_events) @exposed_ws("mouse_wheel") async def __ws_mouse_wheel_handler(self, _: WsSession, event: dict) -> None: - self.__process_ws_delta_event(event, self.__hid.send_mouse_wheel_event) + self.__process_ws_delta_event(event, self.__hid.send_mouse_wheel_events) - def __process_ws_delta_event(self, event: dict, handler: Callable[[int, int], None]) -> None: + def __process_ws_delta_event(self, event: dict, handler: Callable[[Iterable[tuple[int, int]], bool], None]) -> None: try: raw_delta = event["delta"] deltas = [ @@ -252,26 +239,25 @@ class HidApi: squash = valid_bool(event.get("squash", False)) except Exception: return - self.__send_mouse_delta_event(deltas, squash, handler) + handler(deltas, squash) # ===== @exposed_http("POST", "/hid/events/send_key") - async def __events_send_key_handler(self, request: Request) -> Response: - key = valid_hid_key(request.query.get("key")) - if key not in self.__ignore_keys: - if "state" in request.query: - state = valid_bool(request.query["state"]) - self.__hid.send_key_events([(key, state)]) - else: - self.__hid.send_key_events([(key, True), (key, False)]) + async def __events_send_key_handler(self, req: Request) -> Response: + key = valid_hid_key(req.query.get("key")) + if "state" in req.query: + state = valid_bool(req.query["state"]) + self.__hid.send_key_event(key, state) + else: + self.__hid.send_key_events([(key, True), (key, False)]) return make_json_response() @exposed_http("POST", "/hid/events/send_mouse_button") - async def __events_send_mouse_button_handler(self, request: Request) -> Response: - button = valid_hid_mouse_button(request.query.get("button")) - if "state" in request.query: - state = valid_bool(request.query["state"]) + async def __events_send_mouse_button_handler(self, req: Request) -> Response: + button = valid_hid_mouse_button(req.query.get("button")) + if "state" in req.query: + state = valid_bool(req.query["state"]) self.__hid.send_mouse_button_event(button, state) else: self.__hid.send_mouse_button_event(button, True) @@ -279,52 +265,22 @@ class HidApi: return make_json_response() @exposed_http("POST", "/hid/events/send_mouse_move") - async def __events_send_mouse_move_handler(self, request: Request) -> Response: - to_x = valid_hid_mouse_move(request.query.get("to_x")) - to_y = valid_hid_mouse_move(request.query.get("to_y")) - self.__send_mouse_move_event(to_x, to_y) + async def __events_send_mouse_move_handler(self, req: Request) -> Response: + to_x = valid_hid_mouse_move(req.query.get("to_x")) + to_y = valid_hid_mouse_move(req.query.get("to_y")) + self.__hid.send_mouse_move_event(to_x, to_y) return make_json_response() @exposed_http("POST", "/hid/events/send_mouse_relative") - async def __events_send_mouse_relative_handler(self, request: Request) -> Response: - return self.__process_http_delta_event(request, self.__hid.send_mouse_relative_event) + async def __events_send_mouse_relative_handler(self, req: Request) -> Response: + return self.__process_http_delta_event(req, self.__hid.send_mouse_relative_event) @exposed_http("POST", "/hid/events/send_mouse_wheel") - async def __events_send_mouse_wheel_handler(self, request: Request) -> Response: - return self.__process_http_delta_event(request, self.__hid.send_mouse_wheel_event) + async def __events_send_mouse_wheel_handler(self, req: Request) -> Response: + return self.__process_http_delta_event(req, self.__hid.send_mouse_wheel_event) - def __process_http_delta_event(self, request: Request, handler: Callable[[int, int], None]) -> Response: - delta_x = valid_hid_mouse_delta(request.query.get("delta_x")) - delta_y = valid_hid_mouse_delta(request.query.get("delta_y")) + def __process_http_delta_event(self, req: Request, handler: Callable[[int, int], None]) -> Response: + delta_x = valid_hid_mouse_delta(req.query.get("delta_x")) + delta_y = valid_hid_mouse_delta(req.query.get("delta_y")) handler(delta_x, delta_y) return make_json_response() - - # ===== - - def __send_mouse_move_event(self, to_x: int, to_y: int) -> None: - if self.__mouse_x_range != MouseRange.RANGE: - to_x = MouseRange.remap(to_x, *self.__mouse_x_range) - if self.__mouse_y_range != MouseRange.RANGE: - to_y = MouseRange.remap(to_y, *self.__mouse_y_range) - self.__hid.send_mouse_move_event(to_x, to_y) - - def __send_mouse_delta_event( - self, - deltas: list[tuple[int, int]], - squash: bool, - handler: Callable[[int, int], None], - ) -> None: - - if squash: - prev = (0, 0) - for cur in deltas: - if abs(prev[0] + cur[0]) > 127 or abs(prev[1] + cur[1]) > 127: - handler(*prev) - prev = cur - else: - prev = (prev[0] + cur[0], prev[1] + cur[1]) - if prev[0] or prev[1]: - handler(*prev) - else: - for xy in deltas: - handler(*xy) diff --git a/kvmd/apps/kvmd/api/info.py b/kvmd/apps/kvmd/api/info.py index 6a7fbf4e..89d45a84 100644 --- a/kvmd/apps/kvmd/api/info.py +++ b/kvmd/apps/kvmd/api/info.py @@ -20,8 +20,6 @@ # ========================================================================== # -import asyncio - from aiohttp.web import Request from aiohttp.web import Response @@ -41,17 +39,13 @@ class InfoApi: # ===== @exposed_http("GET", "/info") - async def __common_state_handler(self, request: Request) -> Response: - fields = self.__valid_info_fields(request) - results = dict(zip(fields, await asyncio.gather(*[ - self.__info_manager.get_submanager(field).get_state() - for field in fields - ]))) - return make_json_response(results) + async def __common_state_handler(self, req: Request) -> Response: + fields = self.__valid_info_fields(req) + return make_json_response(await self.__info_manager.get_state(fields)) - def __valid_info_fields(self, request: Request) -> list[str]: - subs = self.__info_manager.get_subs() + def __valid_info_fields(self, req: Request) -> list[str]: + available = self.__info_manager.get_subs() return sorted(valid_info_fields( - arg=request.query.get("fields", ",".join(subs)), - variants=subs, - ) or subs) + arg=req.query.get("fields", ",".join(available)), + variants=available, + ) or available) diff --git a/kvmd/apps/kvmd/api/log.py b/kvmd/apps/kvmd/api/log.py index feab39a9..1d31ae8f 100644 --- a/kvmd/apps/kvmd/api/log.py +++ b/kvmd/apps/kvmd/api/log.py @@ -47,12 +47,12 @@ class LogApi: # ===== @exposed_http("GET", "/log") - async def __log_handler(self, request: Request) -> StreamResponse: + async def __log_handler(self, req: Request) -> StreamResponse: if self.__log_reader is None: raise LogReaderDisabledError() - seek = valid_log_seek(request.query.get("seek", 0)) - follow = valid_bool(request.query.get("follow", False)) - response = await start_streaming(request, "text/plain") + seek = valid_log_seek(req.query.get("seek", 0)) + follow = valid_bool(req.query.get("follow", False)) + response = await start_streaming(req, "text/plain") try: async for record in self.__log_reader.poll_log(seek, follow): await response.write(("[%s %s] --- %s" % ( diff --git a/kvmd/apps/kvmd/api/msd.py b/kvmd/apps/kvmd/api/msd.py index dcb6ef62..98e85412 100644 --- a/kvmd/apps/kvmd/api/msd.py +++ b/kvmd/apps/kvmd/api/msd.py @@ -63,32 +63,36 @@ class MsdApi: @exposed_http("GET", "/msd") async def __state_handler(self, _: Request) -> Response: - return make_json_response(await self.__msd.get_state()) + state = await self.__msd.get_state() + if state["storage"] and state["storage"]["parts"]: + state["storage"]["size"] = state["storage"]["parts"][""]["size"] # Legacy API + state["storage"]["free"] = state["storage"]["parts"][""]["free"] # Legacy API + return make_json_response(state) @exposed_http("POST", "/msd/set_params") - async def __set_params_handler(self, request: Request) -> Response: + async def __set_params_handler(self, req: Request) -> Response: params = { - key: validator(request.query.get(param)) + key: validator(req.query.get(param)) for (param, key, validator) in [ ("image", "name", (lambda arg: str(arg).strip() and valid_msd_image_name(arg))), ("cdrom", "cdrom", valid_bool), ("rw", "rw", valid_bool), ] - if request.query.get(param) is not None + if req.query.get(param) is not None } await self.__msd.set_params(**params) # type: ignore return make_json_response() @exposed_http("POST", "/msd/set_connected") - async def __set_connected_handler(self, request: Request) -> Response: - await self.__msd.set_connected(valid_bool(request.query.get("connected"))) + async def __set_connected_handler(self, req: Request) -> Response: + await self.__msd.set_connected(valid_bool(req.query.get("connected"))) return make_json_response() # ===== @exposed_http("GET", "/msd/read") - async def __read_handler(self, request: Request) -> StreamResponse: - name = valid_msd_image_name(request.query.get("image")) + async def __read_handler(self, req: Request) -> StreamResponse: + name = valid_msd_image_name(req.query.get("image")) compressors = { "": ("", None), "none": ("", None), @@ -96,7 +100,7 @@ class MsdApi: "zstd": (".zst", (lambda: zstandard.ZstdCompressor().compressobj())), # pylint: disable=unnecessary-lambda } (suffix, make_compressor) = compressors[check_string_in_list( - arg=request.query.get("compress", ""), + arg=req.query.get("compress", ""), name="Compression mode", variants=set(compressors), )] @@ -127,7 +131,7 @@ class MsdApi: src = compressed() size = -1 - response = await start_streaming(request, "application/octet-stream", size, name + suffix) + response = await start_streaming(req, "application/octet-stream", size, name + suffix) async for chunk in src: await response.write(chunk) return response @@ -135,28 +139,28 @@ class MsdApi: # ===== @exposed_http("POST", "/msd/write") - async def __write_handler(self, request: Request) -> Response: - unsafe_prefix = request.query.get("prefix", "") + "/" - name = valid_msd_image_name(unsafe_prefix + request.query.get("image", "")) - size = valid_int_f0(request.content_length) - remove_incomplete = self.__get_remove_incomplete(request) + async def __write_handler(self, req: Request) -> Response: + unsafe_prefix = req.query.get("prefix", "") + "/" + name = valid_msd_image_name(unsafe_prefix + req.query.get("image", "")) + size = valid_int_f0(req.content_length) + remove_incomplete = self.__get_remove_incomplete(req) written = 0 async with self.__msd.write_image(name, size, remove_incomplete) as writer: chunk_size = writer.get_chunk_size() while True: - chunk = await request.content.read(chunk_size) + chunk = await req.content.read(chunk_size) if not chunk: break written = await writer.write_chunk(chunk) return make_json_response(self.__make_write_info(name, size, written)) @exposed_http("POST", "/msd/write_remote") - async def __write_remote_handler(self, request: Request) -> (Response | StreamResponse): # pylint: disable=too-many-locals - unsafe_prefix = request.query.get("prefix", "") + "/" - url = valid_url(request.query.get("url")) - insecure = valid_bool(request.query.get("insecure", False)) - timeout = valid_float_f01(request.query.get("timeout", 10.0)) - remove_incomplete = self.__get_remove_incomplete(request) + async def __write_remote_handler(self, req: Request) -> (Response | StreamResponse): # pylint: disable=too-many-locals + unsafe_prefix = req.query.get("prefix", "") + "/" + url = valid_url(req.query.get("url")) + insecure = valid_bool(req.query.get("insecure", False)) + timeout = valid_float_f01(req.query.get("timeout", 10.0)) + remove_incomplete = self.__get_remove_incomplete(req) name = "" size = written = 0 @@ -174,7 +178,7 @@ class MsdApi: read_timeout=(7 * 24 * 3600), ) as remote: - name = str(request.query.get("image", "")).strip() + name = str(req.query.get("image", "")).strip() if len(name) == 0: name = htclient.get_filename(remote) name = valid_msd_image_name(unsafe_prefix + name) @@ -184,7 +188,7 @@ class MsdApi: get_logger(0).info("Downloading image %r as %r to MSD ...", url, name) async with self.__msd.write_image(name, size, remove_incomplete) as writer: chunk_size = writer.get_chunk_size() - response = await start_streaming(request, "application/x-ndjson") + response = await start_streaming(req, "application/x-ndjson") await stream_write_info() last_report_ts = 0 async for chunk in remote.content.iter_chunked(chunk_size): @@ -197,16 +201,16 @@ class MsdApi: await stream_write_info() return response - except Exception as err: + except Exception as ex: if response is not None: await stream_write_info() - await stream_json_exception(response, err) - elif isinstance(err, aiohttp.ClientError): - return make_json_exception(err, 400) + await stream_json_exception(response, ex) + elif isinstance(ex, aiohttp.ClientError): + return make_json_exception(ex, 400) raise - def __get_remove_incomplete(self, request: Request) -> (bool | None): - flag: (str | None) = request.query.get("remove_incomplete") + def __get_remove_incomplete(self, req: Request) -> (bool | None): + flag: (str | None) = req.query.get("remove_incomplete") return (valid_bool(flag) if flag is not None else None) def __make_write_info(self, name: str, size: int, written: int) -> dict: @@ -215,8 +219,8 @@ class MsdApi: # ===== @exposed_http("POST", "/msd/remove") - async def __remove_handler(self, request: Request) -> Response: - await self.__msd.remove(valid_msd_image_name(request.query.get("image"))) + async def __remove_handler(self, req: Request) -> Response: + await self.__msd.remove(valid_msd_image_name(req.query.get("image"))) return make_json_response() @exposed_http("POST", "/msd/reset") diff --git a/kvmd/apps/kvmd/api/redfish.py b/kvmd/apps/kvmd/api/redfish.py index 3aaa1812..3b248685 100644 --- a/kvmd/apps/kvmd/api/redfish.py +++ b/kvmd/apps/kvmd/api/redfish.py @@ -88,12 +88,12 @@ class RedfishApi: @exposed_http("GET", "/redfish/v1/Systems/0") async def __server_handler(self, _: Request) -> Response: - (atx_state, meta_state) = await asyncio.gather(*[ + (atx_state, info_state) = await asyncio.gather(*[ self.__atx.get_state(), - self.__info_manager.get_submanager("meta").get_state(), + self.__info_manager.get_state(["meta"]), ]) try: - host = str(meta_state.get("server", {})["host"]) # type: ignore + host = str(info_state["meta"].get("server", {})["host"]) # type: ignore except Exception: host = "" return make_json_response({ @@ -111,10 +111,10 @@ class RedfishApi: }, wrap_result=False) @exposed_http("POST", "/redfish/v1/Systems/0/Actions/ComputerSystem.Reset") - async def __power_handler(self, request: Request) -> Response: + async def __power_handler(self, req: Request) -> Response: try: action = check_string_in_list( - arg=(await request.json())["ResetType"], + arg=(await req.json()).get("ResetType"), name="Redfish ResetType", variants=set(self.__actions), lower=False, diff --git a/kvmd/apps/kvmd/api/streamer.py b/kvmd/apps/kvmd/api/streamer.py index f384eb17..81f255d0 100644 --- a/kvmd/apps/kvmd/api/streamer.py +++ b/kvmd/apps/kvmd/api/streamer.py @@ -52,36 +52,36 @@ class StreamerApi: return make_json_response(await self.__streamer.get_state()) @exposed_http("GET", "/streamer/snapshot") - async def __take_snapshot_handler(self, request: Request) -> Response: + async def __take_snapshot_handler(self, req: Request) -> Response: snapshot = await self.__streamer.take_snapshot( - save=valid_bool(request.query.get("save", False)), - load=valid_bool(request.query.get("load", False)), - allow_offline=valid_bool(request.query.get("allow_offline", False)), + save=valid_bool(req.query.get("save", False)), + load=valid_bool(req.query.get("load", False)), + allow_offline=valid_bool(req.query.get("allow_offline", False)), ) if snapshot: - if valid_bool(request.query.get("ocr", False)): + if valid_bool(req.query.get("ocr", False)): langs = self.__ocr.get_available_langs() return Response( body=(await self.__ocr.recognize( data=snapshot.data, langs=valid_string_list( - arg=str(request.query.get("ocr_langs", "")).strip(), + arg=str(req.query.get("ocr_langs", "")).strip(), subval=(lambda lang: check_string_in_list(lang, "OCR lang", langs)), name="OCR langs list", ), - left=int(valid_number(request.query.get("ocr_left", -1))), - top=int(valid_number(request.query.get("ocr_top", -1))), - right=int(valid_number(request.query.get("ocr_right", -1))), - bottom=int(valid_number(request.query.get("ocr_bottom", -1))), + left=int(valid_number(req.query.get("ocr_left", -1))), + top=int(valid_number(req.query.get("ocr_top", -1))), + right=int(valid_number(req.query.get("ocr_right", -1))), + bottom=int(valid_number(req.query.get("ocr_bottom", -1))), )), headers=dict(snapshot.headers), content_type="text/plain", ) - elif valid_bool(request.query.get("preview", False)): + elif valid_bool(req.query.get("preview", False)): data = await snapshot.make_preview( - max_width=valid_int_f0(request.query.get("preview_max_width", 0)), - max_height=valid_int_f0(request.query.get("preview_max_height", 0)), - quality=valid_stream_quality(request.query.get("preview_quality", 80)), + max_width=valid_int_f0(req.query.get("preview_max_width", 0)), + max_height=valid_int_f0(req.query.get("preview_max_height", 0)), + quality=valid_stream_quality(req.query.get("preview_quality", 80)), ) else: data = snapshot.data @@ -97,25 +97,6 @@ class StreamerApi: self.__streamer.remove_snapshot() return make_json_response() - # ===== - - async def get_ocr(self) -> dict: # XXX: Ugly hack - enabled = self.__ocr.is_available() - default: list[str] = [] - available: list[str] = [] - if enabled: - default = self.__ocr.get_default_langs() - available = self.__ocr.get_available_langs() - return { - "ocr": { - "enabled": enabled, - "langs": { - "default": default, - "available": available, - }, - }, - } - @exposed_http("GET", "/streamer/ocr") async def __ocr_handler(self, _: Request) -> Response: - return make_json_response(await self.get_ocr()) + return make_json_response({"ocr": (await self.__ocr.get_state())}) diff --git a/kvmd/apps/kvmd/api/ugpio.py b/kvmd/apps/kvmd/api/ugpio.py index 3e5f7ca3..b2ac02be 100644 --- a/kvmd/apps/kvmd/api/ugpio.py +++ b/kvmd/apps/kvmd/api/ugpio.py @@ -42,23 +42,20 @@ class UserGpioApi: @exposed_http("GET", "/gpio") async def __state_handler(self, _: Request) -> Response: - return make_json_response({ - "model": (await self.__user_gpio.get_model()), - "state": (await self.__user_gpio.get_state()), - }) + return make_json_response(await self.__user_gpio.get_state()) @exposed_http("POST", "/gpio/switch") - async def __switch_handler(self, request: Request) -> Response: - channel = valid_ugpio_channel(request.query.get("channel")) - state = valid_bool(request.query.get("state")) - wait = valid_bool(request.query.get("wait", False)) + async def __switch_handler(self, req: Request) -> Response: + channel = valid_ugpio_channel(req.query.get("channel")) + state = valid_bool(req.query.get("state")) + wait = valid_bool(req.query.get("wait", False)) await self.__user_gpio.switch(channel, state, wait) return make_json_response() @exposed_http("POST", "/gpio/pulse") - async def __pulse_handler(self, request: Request) -> Response: - channel = valid_ugpio_channel(request.query.get("channel")) - delay = valid_float_f0(request.query.get("delay", 0.0)) - wait = valid_bool(request.query.get("wait", False)) + async def __pulse_handler(self, req: Request) -> Response: + channel = valid_ugpio_channel(req.query.get("channel")) + delay = valid_float_f0(req.query.get("delay", 0.0)) + wait = valid_bool(req.query.get("wait", False)) await self.__user_gpio.pulse(channel, delay, wait) return make_json_response() diff --git a/kvmd/apps/kvmd/info/__init__.py b/kvmd/apps/kvmd/info/__init__.py index 983ef6d6..9ede5489 100644 --- a/kvmd/apps/kvmd/info/__init__.py +++ b/kvmd/apps/kvmd/info/__init__.py @@ -20,6 +20,10 @@ # ========================================================================== # +import asyncio + +from typing import AsyncGenerator + from ....yamlconf import Section from .base import BaseInfoSubmanager @@ -34,17 +38,59 @@ from .fan import FanInfoSubmanager # ===== class InfoManager: def __init__(self, config: Section) -> None: - self.__subs = { + self.__subs: dict[str, BaseInfoSubmanager] = { "system": SystemInfoSubmanager(config.kvmd.streamer.cmd), - "auth": AuthInfoSubmanager(config.kvmd.auth.enabled), - "meta": MetaInfoSubmanager(config.kvmd.info.meta), + "auth": AuthInfoSubmanager(config.kvmd.auth.enabled), + "meta": MetaInfoSubmanager(config.kvmd.info.meta), "extras": ExtrasInfoSubmanager(config), - "hw": HwInfoSubmanager(**config.kvmd.info.hw._unpack()), - "fan": FanInfoSubmanager(**config.kvmd.info.fan._unpack()), + "hw": HwInfoSubmanager(**config.kvmd.info.hw._unpack()), + "fan": FanInfoSubmanager(**config.kvmd.info.fan._unpack()), } + self.__queue: "asyncio.Queue[tuple[str, (dict | None)]]" = asyncio.Queue() def get_subs(self) -> set[str]: return set(self.__subs) - def get_submanager(self, name: str) -> BaseInfoSubmanager: - return self.__subs[name] + async def get_state(self, fields: (list[str] | None)=None) -> dict: + fields = (fields or list(self.__subs)) + return dict(zip(fields, await asyncio.gather(*[ + self.__subs[field].get_state() + for field in fields + ]))) + + async def trigger_state(self) -> None: + await asyncio.gather(*[ + sub.trigger_state() + for sub in self.__subs.values() + ]) + + async def poll_state(self) -> AsyncGenerator[dict, None]: + # ==== Granularity table ==== + # - system -- Partial + # - auth -- Partial + # - meta -- Partial, nullable + # - extras -- Partial, nullable + # - hw -- Partial + # - fan -- Partial + # =========================== + + while True: + (field, value) = await self.__queue.get() + yield {field: value} + + async def systask(self) -> None: + tasks = [ + asyncio.create_task(self.__poller(field)) + for field in self.__subs + ] + try: + await asyncio.gather(*tasks) + except Exception: + for task in tasks: + task.cancel() + await asyncio.gather(*tasks, return_exceptions=True) + raise + + async def __poller(self, field: str) -> None: + async for state in self.__subs[field].poll_state(): + self.__queue.put_nowait((field, state)) diff --git a/kvmd/apps/kvmd/info/auth.py b/kvmd/apps/kvmd/info/auth.py index 2077afff..301cffe3 100644 --- a/kvmd/apps/kvmd/info/auth.py +++ b/kvmd/apps/kvmd/info/auth.py @@ -20,6 +20,10 @@ # ========================================================================== # +from typing import AsyncGenerator + +from .... import aiotools + from .base import BaseInfoSubmanager @@ -27,6 +31,15 @@ from .base import BaseInfoSubmanager class AuthInfoSubmanager(BaseInfoSubmanager): def __init__(self, enabled: bool) -> None: self.__enabled = enabled + self.__notifier = aiotools.AioNotifier() async def get_state(self) -> dict: return {"enabled": self.__enabled} + + async def trigger_state(self) -> None: + self.__notifier.notify() + + async def poll_state(self) -> AsyncGenerator[(dict | None), None]: + while True: + await self.__notifier.wait() + yield (await self.get_state()) diff --git a/kvmd/apps/kvmd/info/base.py b/kvmd/apps/kvmd/info/base.py index 87494e70..d090ed34 100644 --- a/kvmd/apps/kvmd/info/base.py +++ b/kvmd/apps/kvmd/info/base.py @@ -20,7 +20,17 @@ # ========================================================================== # +from typing import AsyncGenerator + + # ===== class BaseInfoSubmanager: async def get_state(self) -> (dict | None): raise NotImplementedError + + async def trigger_state(self) -> None: + raise NotImplementedError + + async def poll_state(self) -> AsyncGenerator[(dict | None), None]: + yield None + raise NotImplementedError diff --git a/kvmd/apps/kvmd/info/extras.py b/kvmd/apps/kvmd/info/extras.py index 6f06b31c..1e69748c 100644 --- a/kvmd/apps/kvmd/info/extras.py +++ b/kvmd/apps/kvmd/info/extras.py @@ -24,6 +24,8 @@ import os import re import asyncio +from typing import AsyncGenerator + from ....logging import get_logger from ....yamlconf import Section @@ -42,13 +44,15 @@ from .base import BaseInfoSubmanager class ExtrasInfoSubmanager(BaseInfoSubmanager): def __init__(self, global_config: Section) -> None: self.__global_config = global_config + self.__notifier = aiotools.AioNotifier() async def get_state(self) -> (dict | None): try: sui = sysunit.SystemdUnitInfo() await sui.open() - except Exception as err: - get_logger(0).error("Can't open systemd bus to get extras state: %s", tools.efmt(err)) + except Exception as ex: + if not os.path.exists("/etc/kvmd/.docker_flag"): + get_logger(0).error("Can't open systemd bus to get extras state: %s", tools.efmt(ex)) sui = None try: extras: dict[str, dict] = {} @@ -66,6 +70,14 @@ class ExtrasInfoSubmanager(BaseInfoSubmanager): if sui is not None: await aiotools.shield_fg(sui.close()) + async def trigger_state(self) -> None: + self.__notifier.notify() + + async def poll_state(self) -> AsyncGenerator[(dict | None), None]: + while True: + await self.__notifier.wait() + yield (await self.get_state()) + def __get_extras_path(self, *parts: str) -> str: return os.path.join(self.__global_config.kvmd.info.extras, *parts) diff --git a/kvmd/apps/kvmd/info/fan.py b/kvmd/apps/kvmd/info/fan.py index 48f4f6d5..8f3f69c8 100644 --- a/kvmd/apps/kvmd/info/fan.py +++ b/kvmd/apps/kvmd/info/fan.py @@ -21,7 +21,6 @@ import copy -import asyncio from typing import AsyncGenerator @@ -53,6 +52,8 @@ class FanInfoSubmanager(BaseInfoSubmanager): self.__timeout = timeout self.__state_poll = state_poll + self.__notifier = aiotools.AioNotifier() + async def get_state(self) -> dict: monitored = await self.__get_monitored() return { @@ -60,24 +61,28 @@ class FanInfoSubmanager(BaseInfoSubmanager): "state": ((await self.__get_fan_state() if monitored else None)), } - async def poll_state(self) -> AsyncGenerator[dict, None]: - prev_state: dict = {} + async def trigger_state(self) -> None: + self.__notifier.notify(1) + + async def poll_state(self) -> AsyncGenerator[(dict | None), None]: + prev: dict = {} while True: if self.__unix_path: - pure = state = await self.get_state() + if (await self.__notifier.wait(timeout=self.__state_poll)) > 0: + prev = {} + new = await self.get_state() + pure = copy.deepcopy(new) if pure["state"] is not None: try: - pure = copy.deepcopy(state) pure["state"]["service"]["now_ts"] = 0 except Exception: pass - if pure != prev_state: - yield state - prev_state = pure - await asyncio.sleep(self.__state_poll) + if pure != prev: + prev = pure + yield new else: + await self.__notifier.wait() yield (await self.get_state()) - await aiotools.wait_infinite() # ===== @@ -87,8 +92,8 @@ class FanInfoSubmanager(BaseInfoSubmanager): async with sysunit.SystemdUnitInfo() as sui: status = await sui.get_status(self.__daemon) return (status[0] or status[1]) - except Exception as err: - get_logger(0).error("Can't get info about the service %r: %s", self.__daemon, tools.efmt(err)) + except Exception as ex: + get_logger(0).error("Can't get info about the service %r: %s", self.__daemon, tools.efmt(ex)) return False async def __get_fan_state(self) -> (dict | None): @@ -97,8 +102,8 @@ class FanInfoSubmanager(BaseInfoSubmanager): async with session.get("http://localhost/state") as response: htclient.raise_not_200(response) return (await response.json())["result"] - except Exception as err: - get_logger(0).error("Can't read fan state: %s", err) + except Exception as ex: + get_logger(0).error("Can't read fan state: %s", ex) return None def __make_http_session(self) -> aiohttp.ClientSession: diff --git a/kvmd/apps/kvmd/info/hw.py b/kvmd/apps/kvmd/info/hw.py index 1bade216..3c444760 100644 --- a/kvmd/apps/kvmd/info/hw.py +++ b/kvmd/apps/kvmd/info/hw.py @@ -22,6 +22,7 @@ import os import asyncio +import copy from typing import Callable from typing import AsyncGenerator @@ -60,6 +61,8 @@ class HwInfoSubmanager(BaseInfoSubmanager): self.__dt_cache: dict[str, str] = {} + self.__notifier = aiotools.AioNotifier() + async def get_state(self) -> dict: ( base, @@ -70,8 +73,8 @@ class HwInfoSubmanager(BaseInfoSubmanager): cpu_temp, mem, ) = await asyncio.gather( - self.__read_dt_file("model"), - self.__read_dt_file("serial-number"), + self.__read_dt_file("model", upper=False), + self.__read_dt_file("serial-number", upper=True), self.__read_platform_file(), self.__get_throttling(), self.__get_cpu_percent(), @@ -97,18 +100,22 @@ class HwInfoSubmanager(BaseInfoSubmanager): }, } + async def trigger_state(self) -> None: + self.__notifier.notify(1) + async def poll_state(self) -> AsyncGenerator[dict, None]: - prev_state: dict = {} + prev: dict = {} while True: - state = await self.get_state() - if state != prev_state: - yield state - prev_state = state - await asyncio.sleep(self.__state_poll) + if (await self.__notifier.wait(timeout=self.__state_poll)) > 0: + prev = {} + new = await self.get_state() + if new != prev: + prev = copy.deepcopy(new) + yield new # ===== - async def __read_dt_file(self, name: str) -> (str | None): + async def __read_dt_file(self, name: str, upper: bool) -> (str | None): if name not in self.__dt_cache: path = os.path.join(f"{env.PROCFS_PREFIX}/proc/device-tree", name) if not os.path.exists(path): @@ -161,8 +168,8 @@ class HwInfoSubmanager(BaseInfoSubmanager): + system_all / total * 100 + (st.steal + st.guest) / total * 100 ) - except Exception as err: - get_logger(0).error("Can't get CPU percent: %s", err) + except Exception as ex: + get_logger(0).error("Can't get CPU percent: %s", ex) return None async def __get_mem(self) -> dict: @@ -173,8 +180,8 @@ class HwInfoSubmanager(BaseInfoSubmanager): "total": st.total, "available": st.available, } - except Exception as err: - get_logger(0).error("Can't get memory info: %s", err) + except Exception as ex: + get_logger(0).error("Can't get memory info: %s", ex) return { "percent": None, "total": None, @@ -217,6 +224,6 @@ class HwInfoSubmanager(BaseInfoSubmanager): return None try: return parser(text) - except Exception as err: - get_logger(0).error("Can't parse [ %s ] output: %r: %s", tools.cmdfmt(cmd), text, tools.efmt(err)) + except Exception as ex: + get_logger(0).error("Can't parse [ %s ] output: %r: %s", tools.cmdfmt(cmd), text, tools.efmt(ex)) return None diff --git a/kvmd/apps/kvmd/info/meta.py b/kvmd/apps/kvmd/info/meta.py index b66b76b1..996e648a 100644 --- a/kvmd/apps/kvmd/info/meta.py +++ b/kvmd/apps/kvmd/info/meta.py @@ -20,6 +20,8 @@ # ========================================================================== # +from typing import AsyncGenerator + from ....logging import get_logger from ....yamlconf.loader import load_yaml_file @@ -33,6 +35,7 @@ from .base import BaseInfoSubmanager class MetaInfoSubmanager(BaseInfoSubmanager): def __init__(self, meta_path: str) -> None: self.__meta_path = meta_path + self.__notifier = aiotools.AioNotifier() async def get_state(self) -> (dict | None): try: @@ -40,3 +43,11 @@ class MetaInfoSubmanager(BaseInfoSubmanager): except Exception: get_logger(0).exception("Can't parse meta") return None + + async def trigger_state(self) -> None: + self.__notifier.notify() + + async def poll_state(self) -> AsyncGenerator[(dict | None), None]: + while True: + await self.__notifier.wait() + yield (await self.get_state()) diff --git a/kvmd/apps/kvmd/info/system.py b/kvmd/apps/kvmd/info/system.py index 462b52c9..d4a450de 100644 --- a/kvmd/apps/kvmd/info/system.py +++ b/kvmd/apps/kvmd/info/system.py @@ -24,8 +24,11 @@ import os import asyncio import platform +from typing import AsyncGenerator + from ....logging import get_logger +from .... import aiotools from .... import aioproc from .... import __version__ @@ -37,6 +40,7 @@ from .base import BaseInfoSubmanager class SystemInfoSubmanager(BaseInfoSubmanager): def __init__(self, streamer_cmd: list[str]) -> None: self.__streamer_cmd = streamer_cmd + self.__notifier = aiotools.AioNotifier() async def get_state(self) -> dict: streamer_info = await self.__get_streamer_info() @@ -50,6 +54,14 @@ class SystemInfoSubmanager(BaseInfoSubmanager): }, } + async def trigger_state(self) -> None: + self.__notifier.notify() + + async def poll_state(self) -> AsyncGenerator[(dict | None), None]: + while True: + await self.__notifier.wait() + yield (await self.get_state()) + # ===== async def __get_streamer_info(self) -> dict: diff --git a/kvmd/apps/kvmd/ocr.py b/kvmd/apps/kvmd/ocr.py index bd30afa6..367c0c80 100644 --- a/kvmd/apps/kvmd/ocr.py +++ b/kvmd/apps/kvmd/ocr.py @@ -37,6 +37,7 @@ from ctypes import c_void_p from ctypes import c_char from typing import Generator +from typing import AsyncGenerator from PIL import ImageOps from PIL import Image as PilImage @@ -76,8 +77,8 @@ def _load_libtesseract() -> (ctypes.CDLL | None): setattr(func, "restype", restype) setattr(func, "argtypes", argtypes) return lib - except Exception as err: - warnings.warn(f"Can't load libtesseract: {err}", RuntimeWarning) + except Exception as ex: + warnings.warn(f"Can't load libtesseract: {ex}", RuntimeWarning) return None @@ -107,9 +108,37 @@ class Ocr: def __init__(self, data_dir_path: str, default_langs: list[str]) -> None: self.__data_dir_path = data_dir_path self.__default_langs = default_langs + self.__notifier = aiotools.AioNotifier() - def is_available(self) -> bool: - return bool(_libtess) + async def get_state(self) -> dict: + enabled = bool(_libtess) + default: list[str] = [] + available: list[str] = [] + if enabled: + default = self.get_default_langs() + available = self.get_available_langs() + return { + "enabled": enabled, + "langs": { + "default": default, + "available": available, + }, + } + + async def trigger_state(self) -> None: + self.__notifier.notify() + + async def poll_state(self) -> AsyncGenerator[dict, None]: + # ===== Granularity table ===== + # - enabled -- Full + # - langs -- Partial + # ============================= + + while True: + await self.__notifier.wait() + yield (await self.get_state()) + + # ===== def get_default_langs(self) -> list[str]: return list(self.__default_langs) diff --git a/kvmd/apps/kvmd/server.py b/kvmd/apps/kvmd/server.py index 44f33f89..ed85bb24 100644 --- a/kvmd/apps/kvmd/server.py +++ b/kvmd/apps/kvmd/server.py @@ -20,8 +20,6 @@ # ========================================================================== # -import asyncio -import operator import dataclasses from typing import Callable @@ -33,6 +31,8 @@ from aiohttp.web import Request from aiohttp.web import Response from aiohttp.web import WebSocketResponse +from ... import __version__ + from ...logging import get_logger from ...errors import OperationError @@ -98,54 +98,46 @@ class StreamerH264NotSupported(OperationError): # ===== -@dataclasses.dataclass(frozen=True) -class _SubsystemEventSource: - get_state: (Callable[[], Coroutine[Any, Any, dict]] | None) = None - poll_state: (Callable[[], AsyncGenerator[dict, None]] | None) = None - - @dataclasses.dataclass class _Subsystem: - name: str - sysprep: (Callable[[], None] | None) - systask: (Callable[[], Coroutine[Any, Any, None]] | None) - cleanup: (Callable[[], Coroutine[Any, Any, dict]] | None) - sources: dict[str, _SubsystemEventSource] + name: str + event_type: str + sysprep: (Callable[[], None] | None) + systask: (Callable[[], Coroutine[Any, Any, None]] | None) + cleanup: (Callable[[], Coroutine[Any, Any, dict]] | None) + trigger_state: (Callable[[], Coroutine[Any, Any, None]] | None) = None + poll_state: (Callable[[], AsyncGenerator[dict, None]] | None) = None + + def __post_init__(self) -> None: + if self.event_type: + assert self.trigger_state + assert self.poll_state @classmethod def make(cls, obj: object, name: str, event_type: str="") -> "_Subsystem": if isinstance(obj, BasePlugin): name = f"{name} ({obj.get_plugin_name()})" - sub = _Subsystem( + return _Subsystem( name=name, + event_type=event_type, sysprep=getattr(obj, "sysprep", None), systask=getattr(obj, "systask", None), cleanup=getattr(obj, "cleanup", None), - sources={}, + trigger_state=getattr(obj, "trigger_state", None), + poll_state=getattr(obj, "poll_state", None), + ) - if event_type: - sub.add_source( - event_type=event_type, - get_state=getattr(obj, "get_state", None), - poll_state=getattr(obj, "poll_state", None), - ) - return sub - - def add_source( - self, - event_type: str, - get_state: (Callable[[], Coroutine[Any, Any, dict]] | None), - poll_state: (Callable[[], AsyncGenerator[dict, None]] | None), - ) -> "_Subsystem": - - assert event_type - assert event_type not in self.sources, (self, event_type) - assert get_state or poll_state, (self, event_type) - self.sources[event_type] = _SubsystemEventSource(get_state, poll_state) - return self class KvmdServer(HttpServer): # pylint: disable=too-many-arguments,too-many-instance-attributes + __EV_GPIO_STATE = "gpio_state" + __EV_HID_STATE = "hid_state" + __EV_ATX_STATE = "atx_state" + __EV_MSD_STATE = "msd_state" + __EV_STREAMER_STATE = "streamer_state" + __EV_OCR_STATE = "ocr_state" + __EV_INFO_STATE = "info_state" + def __init__( # pylint: disable=too-many-arguments,too-many-locals self, auth_manager: AuthManager, @@ -161,9 +153,6 @@ class KvmdServer(HttpServer): # pylint: disable=too-many-arguments,too-many-ins snapshoter: Snapshoter, keymap_path: str, - ignore_keys: list[str], - mouse_x_range: tuple[int, int], - mouse_y_range: tuple[int, int], stream_forever: bool, ) -> None: @@ -177,8 +166,7 @@ class KvmdServer(HttpServer): # pylint: disable=too-many-arguments,too-many-ins self.__stream_forever = stream_forever - self.__hid_api = HidApi(hid, keymap_path, ignore_keys, mouse_x_range, mouse_y_range) # Ugly hack to get keymaps state - self.__streamer_api = StreamerApi(streamer, ocr) # Same hack to get ocr langs state + self.__hid_api = HidApi(hid, keymap_path) # Ugly hack to get keymaps state self.__apis: list[object] = [ self, AuthApi(auth_manager), @@ -188,22 +176,19 @@ class KvmdServer(HttpServer): # pylint: disable=too-many-arguments,too-many-ins self.__hid_api, AtxApi(atx), MsdApi(msd), - self.__streamer_api, + StreamerApi(streamer, ocr), ExportApi(info_manager, atx, user_gpio), RedfishApi(info_manager, atx), ] - self.__subsystems = [ _Subsystem.make(auth_manager, "Auth manager"), - _Subsystem.make(user_gpio, "User-GPIO", "gpio_state").add_source("gpio_model_state", user_gpio.get_model, None), - _Subsystem.make(hid, "HID", "hid_state").add_source("hid_keymaps_state", self.__hid_api.get_keymaps, None), - _Subsystem.make(atx, "ATX", "atx_state"), - _Subsystem.make(msd, "MSD", "msd_state"), - _Subsystem.make(streamer, "Streamer", "streamer_state").add_source("streamer_ocr_state", self.__streamer_api.get_ocr, None), - *[ - _Subsystem.make(info_manager.get_submanager(sub), f"Info manager ({sub})", f"info_{sub}_state",) - for sub in sorted(info_manager.get_subs()) - ], + _Subsystem.make(user_gpio, "User-GPIO", self.__EV_GPIO_STATE), + _Subsystem.make(hid, "HID", self.__EV_HID_STATE), + _Subsystem.make(atx, "ATX", self.__EV_ATX_STATE), + _Subsystem.make(msd, "MSD", self.__EV_MSD_STATE), + _Subsystem.make(streamer, "Streamer", self.__EV_STREAMER_STATE), + _Subsystem.make(ocr, "OCR", self.__EV_OCR_STATE), + _Subsystem.make(info_manager, "Info manager", self.__EV_INFO_STATE), ] self.__streamer_notifier = aiotools.AioNotifier() @@ -213,16 +198,16 @@ class KvmdServer(HttpServer): # pylint: disable=too-many-arguments,too-many-ins # ===== STREAMER CONTROLLER @exposed_http("POST", "/streamer/set_params") - async def __streamer_set_params_handler(self, request: Request) -> Response: + async def __streamer_set_params_handler(self, req: Request) -> Response: current_params = self.__streamer.get_params() for (name, validator, exc_cls) in [ - ("quality", valid_stream_quality, StreamerQualityNotSupported), - ("desired_fps", valid_stream_fps, None), - ("resolution", valid_stream_resolution, StreamerResolutionNotSupported), + ("quality", valid_stream_quality, StreamerQualityNotSupported), + ("desired_fps", valid_stream_fps, None), + ("resolution", valid_stream_resolution, StreamerResolutionNotSupported), ("h264_bitrate", valid_stream_h264_bitrate, StreamerH264NotSupported), - ("h264_gop", valid_stream_h264_gop, StreamerH264NotSupported), + ("h264_gop", valid_stream_h264_gop, StreamerH264NotSupported), ]: - value = request.query.get(name) + value = req.query.get(name) if value: if name not in current_params: assert exc_cls is not None, name @@ -242,24 +227,22 @@ class KvmdServer(HttpServer): # pylint: disable=too-many-arguments,too-many-ins # ===== WEBSOCKET @exposed_http("GET", "/ws") - async def __ws_handler(self, request: Request) -> WebSocketResponse: - stream = valid_bool(request.query.get("stream", True)) - async with self._ws_session(request, stream=stream) as ws: - states = [ - (event_type, src.get_state()) - for sub in self.__subsystems - for (event_type, src) in sub.sources.items() - if src.get_state - ] - events = dict(zip( - map(operator.itemgetter(0), states), - await asyncio.gather(*map(operator.itemgetter(1), states)), - )) - await asyncio.gather(*[ - ws.send_event(event_type, events.pop(event_type)) - for (event_type, _) in states - ]) - await ws.send_event("loop", {}) + async def __ws_handler(self, req: Request) -> WebSocketResponse: + stream = valid_bool(req.query.get("stream", True)) + legacy = valid_bool(req.query.get("legacy", True)) + async with self._ws_session(req, stream=stream, legacy=legacy) as ws: + (major, minor) = __version__.split(".") + await ws.send_event("loop", { + "version": { + "major": int(major), + "minor": int(minor), + }, + }) + for sub in self.__subsystems: + if sub.event_type: + assert sub.trigger_state + await sub.trigger_state() + await self._broadcast_ws_event("hid_keymaps_state", await self.__hid_api.get_keymaps()) # FIXME return (await self._ws_loop(ws)) @exposed_ws("ping") @@ -275,17 +258,17 @@ class KvmdServer(HttpServer): # pylint: disable=too-many-arguments,too-many-ins aioproc.rename_process("main") super().run(**kwargs) - async def _check_request_auth(self, exposed: HttpExposed, request: Request) -> None: - await check_request_auth(self.__auth_manager, exposed, request) + async def _check_request_auth(self, exposed: HttpExposed, req: Request) -> None: + await check_request_auth(self.__auth_manager, exposed, req) async def _init_app(self) -> None: aiotools.create_deadly_task("Stream controller", self.__stream_controller()) for sub in self.__subsystems: if sub.systask: aiotools.create_deadly_task(sub.name, sub.systask()) - for (event_type, src) in sub.sources.items(): - if src.poll_state: - aiotools.create_deadly_task(f"{sub.name} [poller]", self.__poll_state(event_type, src.poll_state())) + if sub.event_type: + assert sub.poll_state + aiotools.create_deadly_task(f"{sub.name} [poller]", self.__poll_state(sub.event_type, sub.poll_state())) aiotools.create_deadly_task("Stream snapshoter", self.__stream_snapshoter()) self._add_exposed(*self.__apis) @@ -347,12 +330,67 @@ class KvmdServer(HttpServer): # pylint: disable=too-many-arguments,too-many-ins prev = cur await self.__streamer_notifier.wait() - async def __poll_state(self, event_type: str, poller: AsyncGenerator[dict, None]) -> None: - async for state in poller: - await self._broadcast_ws_event(event_type, state) - async def __stream_snapshoter(self) -> None: await self.__snapshoter.run( is_live=self.__has_stream_clients, notifier=self.__streamer_notifier, ) + + async def __poll_state(self, event_type: str, poller: AsyncGenerator[dict, None]) -> None: + match event_type: + case self.__EV_GPIO_STATE: + await self.__poll_gpio_state(poller) + case self.__EV_INFO_STATE: + await self.__poll_info_state(poller) + case self.__EV_MSD_STATE: + await self.__poll_msd_state(poller) + case self.__EV_STREAMER_STATE: + await self.__poll_streamer_state(poller) + case self.__EV_OCR_STATE: + await self.__poll_ocr_state(poller) + case _: + async for state in poller: + await self._broadcast_ws_event(event_type, state) + + async def __poll_gpio_state(self, poller: AsyncGenerator[dict, None]) -> None: + prev: dict = {"state": {"inputs": {}, "outputs": {}}} + async for state in poller: + await self._broadcast_ws_event(self.__EV_GPIO_STATE, state, legacy=False) + if "model" in state: # We have only "model"+"state" or "model" event + prev = state + await self._broadcast_ws_event("gpio_model_state", prev["model"], legacy=True) + else: + prev["state"]["inputs"].update(state["state"].get("inputs", {})) + prev["state"]["outputs"].update(state["state"].get("outputs", {})) + await self._broadcast_ws_event(self.__EV_GPIO_STATE, prev["state"], legacy=True) + + async def __poll_info_state(self, poller: AsyncGenerator[dict, None]) -> None: + async for state in poller: + await self._broadcast_ws_event(self.__EV_INFO_STATE, state, legacy=False) + for (key, value) in state.items(): + await self._broadcast_ws_event(f"info_{key}_state", value, legacy=True) + + async def __poll_msd_state(self, poller: AsyncGenerator[dict, None]) -> None: + prev: dict = {"storage": None} + async for state in poller: + await self._broadcast_ws_event(self.__EV_MSD_STATE, state, legacy=False) + prev_storage = prev["storage"] + prev.update(state) + if prev["storage"] is not None and prev_storage is not None: + prev_storage.update(prev["storage"]) + prev["storage"] = prev_storage + if "online" in prev: # Complete/Full + await self._broadcast_ws_event(self.__EV_MSD_STATE, prev, legacy=True) + + async def __poll_streamer_state(self, poller: AsyncGenerator[dict, None]) -> None: + prev: dict = {} + async for state in poller: + await self._broadcast_ws_event(self.__EV_STREAMER_STATE, state, legacy=False) + prev.update(state) + if "features" in prev: # Complete/Full + await self._broadcast_ws_event(self.__EV_STREAMER_STATE, prev, legacy=True) + + async def __poll_ocr_state(self, poller: AsyncGenerator[dict, None]) -> None: + async for state in poller: + await self._broadcast_ws_event(self.__EV_OCR_STATE, state, legacy=False) + await self._broadcast_ws_event("streamer_ocr_state", {"ocr": state}, legacy=True) diff --git a/kvmd/apps/kvmd/streamer.py b/kvmd/apps/kvmd/streamer.py index 26904d40..08c48eb1 100644 --- a/kvmd/apps/kvmd/streamer.py +++ b/kvmd/apps/kvmd/streamer.py @@ -20,22 +20,23 @@ # ========================================================================== # -import io import signal import asyncio import asyncio.subprocess import dataclasses -import functools +import copy from typing import AsyncGenerator from typing import Any import aiohttp -from PIL import Image as PilImage - from ...logging import get_logger +from ...clients.streamer import StreamerSnapshot +from ...clients.streamer import HttpStreamerClient +from ...clients.streamer import HttpStreamerClientSession + from ... import tools from ... import aiotools from ... import aioproc @@ -43,40 +44,6 @@ from ... import htclient # ===== -@dataclasses.dataclass(frozen=True) -class StreamerSnapshot: - online: bool - width: int - height: int - headers: tuple[tuple[str, str], ...] - data: bytes - - async def make_preview(self, max_width: int, max_height: int, quality: int) -> bytes: - assert max_width >= 0 - assert max_height >= 0 - assert quality > 0 - - if max_width == 0 and max_height == 0: - max_width = self.width // 5 - max_height = self.height // 5 - else: - max_width = min((max_width or self.width), self.width) - max_height = min((max_height or self.height), self.height) - - if (max_width, max_height) == (self.width, self.height): - return self.data - return (await aiotools.run_async(self.__inner_make_preview, max_width, max_height, quality)) - - @functools.lru_cache(maxsize=1) - def __inner_make_preview(self, max_width: int, max_height: int, quality: int) -> bytes: - with io.BytesIO(self.data) as snapshot_bio: - with io.BytesIO() as preview_bio: - with PilImage.open(snapshot_bio) as image: - image.thumbnail((max_width, max_height), PilImage.Resampling.LANCZOS) - image.save(preview_bio, format="jpeg", quality=quality) - return preview_bio.getvalue() - - class _StreamerParams: __DESIRED_FPS = "desired_fps" @@ -136,7 +103,7 @@ class _StreamerParams: } def get_limits(self) -> dict: - limits = dict(self.__limits) + limits = copy.deepcopy(self.__limits) if self.__has_resolution: limits[self.__AVAILABLE_RESOLUTIONS] = list(limits[self.__AVAILABLE_RESOLUTIONS]) return limits @@ -170,6 +137,11 @@ class _StreamerParams: class Streamer: # pylint: disable=too-many-instance-attributes + __ST_FULL = 0xFF + __ST_PARAMS = 0x01 + __ST_STREAMER = 0x02 + __ST_SNAPSHOT = 0x04 + def __init__( # pylint: disable=too-many-arguments,too-many-locals self, @@ -203,7 +175,6 @@ class Streamer: # pylint: disable=too-many-instance-attributes self.__state_poll = state_poll self.__unix_path = unix_path - self.__timeout = timeout self.__snapshot_timeout = snapshot_timeout self.__process_name_prefix = process_name_prefix @@ -220,7 +191,13 @@ class Streamer: # pylint: disable=too-many-instance-attributes self.__streamer_task: (asyncio.Task | None) = None self.__streamer_proc: (asyncio.subprocess.Process | None) = None # pylint: disable=no-member - self.__http_session: (aiohttp.ClientSession | None) = None + self.__client = HttpStreamerClient( + name="jpeg", + unix_path=self.__unix_path, + timeout=timeout, + user_agent=htclient.make_user_agent("KVMD"), + ) + self.__client_session: (HttpStreamerClientSession | None) = None self.__snapshot: (StreamerSnapshot | None) = None @@ -289,6 +266,7 @@ class Streamer: # pylint: disable=too-many-instance-attributes def set_params(self, params: dict) -> None: assert not self.__streamer_task + self.__notifier.notify(self.__ST_PARAMS) return self.__params.set_params(params) def get_params(self) -> dict: @@ -297,55 +275,80 @@ class Streamer: # pylint: disable=too-many-instance-attributes # ===== async def get_state(self) -> dict: - streamer_state = None - if self.__streamer_task: - session = self.__ensure_http_session() - try: - async with session.get(self.__make_url("state")) as response: - htclient.raise_not_200(response) - streamer_state = (await response.json())["result"] - except (aiohttp.ClientConnectionError, aiohttp.ServerConnectionError): - pass - except Exception: - get_logger().exception("Invalid streamer response from /state") - - snapshot: (dict | None) = None - if self.__snapshot: - snapshot = dataclasses.asdict(self.__snapshot) - del snapshot["headers"] - del snapshot["data"] - return { + "features": self.__params.get_features(), "limits": self.__params.get_limits(), "params": self.__params.get_params(), - "snapshot": {"saved": snapshot}, - "streamer": streamer_state, - "features": self.__params.get_features(), + "streamer": (await self.__get_streamer_state()), + "snapshot": self.__get_snapshot_state(), } + async def trigger_state(self) -> None: + self.__notifier.notify(self.__ST_FULL) + async def poll_state(self) -> AsyncGenerator[dict, None]: + # ==== Granularity table ==== + # - features -- Full + # - limits -- Partial, paired with params + # - params -- Partial, paired with limits + # - streamer -- Partial, nullable + # - snapshot -- Partial + # =========================== + def signal_handler(*_: Any) -> None: get_logger(0).info("Got SIGUSR2, checking the stream state ...") - self.__notifier.notify() + self.__notifier.notify(self.__ST_STREAMER) get_logger(0).info("Installing SIGUSR2 streamer handler ...") asyncio.get_event_loop().add_signal_handler(signal.SIGUSR2, signal_handler) - waiter_task: (asyncio.Task | None) = None - prev_state: dict = {} + prev: dict = {} while True: - state = await self.get_state() - if state != prev_state: - yield state - prev_state = state + new: dict = {} - if waiter_task is None: - waiter_task = asyncio.create_task(self.__notifier.wait()) - if waiter_task in (await aiotools.wait_first( - asyncio.ensure_future(asyncio.sleep(self.__state_poll)), - waiter_task, - ))[0]: - waiter_task = None + mask = await self.__notifier.wait(timeout=self.__state_poll) + if mask == self.__ST_FULL: + new = await self.get_state() + prev = copy.deepcopy(new) + yield new + continue + + if mask < 0: + mask = self.__ST_STREAMER + + def check_update(key: str, value: (dict | None)) -> None: + if prev.get(key) != value: + new[key] = value + + if mask & self.__ST_PARAMS: + check_update("params", self.__params.get_params()) + if mask & self.__ST_STREAMER: + check_update("streamer", await self.__get_streamer_state()) + if mask & self.__ST_SNAPSHOT: + check_update("snapshot", self.__get_snapshot_state()) + + if new and prev != new: + prev.update(copy.deepcopy(new)) + yield new + + async def __get_streamer_state(self) -> (dict | None): + if self.__streamer_task: + session = self.__ensure_client_session() + try: + return (await session.get_state()) + except (aiohttp.ClientConnectionError, aiohttp.ServerConnectionError): + pass + except Exception: + get_logger().exception("Invalid streamer response from /state") + return None + + def __get_snapshot_state(self) -> dict: + if self.__snapshot: + snapshot = dataclasses.asdict(self.__snapshot) + del snapshot["headers"] + del snapshot["data"] + return {"saved": snapshot} + return {"saved": None} # ===== @@ -353,41 +356,17 @@ class Streamer: # pylint: disable=too-many-instance-attributes if load: return self.__snapshot logger = get_logger() - session = self.__ensure_http_session() + session = self.__ensure_client_session() try: - async with session.get( - self.__make_url("snapshot"), - timeout=self.__snapshot_timeout, - ) as response: - - htclient.raise_not_200(response) - online = (response.headers["X-UStreamer-Online"] == "true") - if online or allow_offline: - snapshot = StreamerSnapshot( - online=online, - width=int(response.headers["X-UStreamer-Width"]), - height=int(response.headers["X-UStreamer-Height"]), - headers=tuple( - (key, value) - for (key, value) in tools.sorted_kvs(dict(response.headers)) - if key.lower().startswith("x-ustreamer-") or key.lower() in [ - "x-timestamp", - "access-control-allow-origin", - "cache-control", - "pragma", - "expires", - ] - ), - data=bytes(await response.read()), - ) - if save: - self.__snapshot = snapshot - self.__notifier.notify() - return snapshot - logger.error("Stream is offline, no signal or so") - - except (aiohttp.ClientConnectionError, aiohttp.ServerConnectionError) as err: - logger.error("Can't connect to streamer: %s", tools.efmt(err)) + snapshot = await session.take_snapshot(self.__snapshot_timeout) + if snapshot.online or allow_offline: + if save: + self.__snapshot = snapshot + self.__notifier.notify(self.__ST_SNAPSHOT) + return snapshot + logger.error("Stream is offline, no signal or so") + except (aiohttp.ClientConnectionError, aiohttp.ServerConnectionError) as ex: + logger.error("Can't connect to streamer: %s", tools.efmt(ex)) except Exception: logger.exception("Invalid streamer response from /snapshot") return None @@ -400,25 +379,14 @@ class Streamer: # pylint: disable=too-many-instance-attributes @aiotools.atomic_fg async def cleanup(self) -> None: await self.ensure_stop(immediately=True) - if self.__http_session: - await self.__http_session.close() - self.__http_session = None + if self.__client_session: + await self.__client_session.close() + self.__client_session = None - # ===== - - def __ensure_http_session(self) -> aiohttp.ClientSession: - if not self.__http_session: - kwargs: dict = { - "headers": {"User-Agent": htclient.make_user_agent("KVMD")}, - "connector": aiohttp.UnixConnector(path=self.__unix_path), - "timeout": aiohttp.ClientTimeout(total=self.__timeout), - } - self.__http_session = aiohttp.ClientSession(**kwargs) - return self.__http_session - - def __make_url(self, handle: str) -> str: - assert not handle.startswith("/"), handle - return f"http://localhost:0/{handle}" + def __ensure_client_session(self) -> HttpStreamerClientSession: + if not self.__client_session: + self.__client_session = self.__client.make_session() + return self.__client_session # ===== @@ -473,8 +441,8 @@ class Streamer: # pylint: disable=too-many-instance-attributes logger.info("%s: %s", name, tools.cmdfmt(cmd)) try: await aioproc.log_process(cmd, logger, prefix=name) - except Exception as err: - logger.exception("Can't execute command: %s", err) + except Exception as ex: + logger.exception("Can't execute command: %s", ex) async def __start_streamer_proc(self) -> None: assert self.__streamer_proc is None diff --git a/kvmd/apps/kvmd/sysunit.py b/kvmd/apps/kvmd/sysunit.py index b967aa58..bcb41c34 100644 --- a/kvmd/apps/kvmd/sysunit.py +++ b/kvmd/apps/kvmd/sysunit.py @@ -35,6 +35,7 @@ class SystemdUnitInfo: self.__bus: (dbus_next.aio.MessageBus | None) = None self.__intr: (dbus_next.introspection.Node | None) = None self.__manager: (dbus_next.aio.proxy_object.ProxyInterface | None) = None + self.__requested = False async def get_status(self, name: str) -> tuple[bool, bool]: assert self.__bus is not None @@ -49,8 +50,9 @@ class SystemdUnitInfo: unit = self.__bus.get_proxy_object("org.freedesktop.systemd1", unit_p, self.__intr) unit_props = unit.get_interface("org.freedesktop.DBus.Properties") started = ((await unit_props.call_get("org.freedesktop.systemd1.Unit", "ActiveState")).value == "active") # type: ignore - except dbus_next.errors.DBusError as err: - if err.type != "org.freedesktop.systemd1.NoSuchUnit": + self.__requested = True + except dbus_next.errors.DBusError as ex: + if ex.type != "org.freedesktop.systemd1.NoSuchUnit": raise started = False enabled = ((await self.__manager.call_get_unit_file_state(name)) in [ # type: ignore @@ -75,8 +77,13 @@ class SystemdUnitInfo: async def close(self) -> None: try: if self.__bus is not None: - self.__bus.disconnect() - await self.__bus.wait_for_disconnect() + try: + # XXX: Workaround for dbus_next bug: https://github.com/pikvm/kvmd/pull/182 + if not self.__requested: + await self.__manager.call_get_default_target() # type: ignore + finally: + self.__bus.disconnect() + await self.__bus.wait_for_disconnect() except Exception: pass self.__manager = None diff --git a/kvmd/apps/kvmd/ugpio.py b/kvmd/apps/kvmd/ugpio.py index 872d5f6c..e4735c61 100644 --- a/kvmd/apps/kvmd/ugpio.py +++ b/kvmd/apps/kvmd/ugpio.py @@ -21,6 +21,7 @@ import asyncio +import copy from typing import AsyncGenerator from typing import Callable @@ -68,12 +69,12 @@ class GpioChannelIsBusyError(IsBusyError, GpioError): class _GpioInput: def __init__( self, - channel: str, + ch: str, config: Section, driver: BaseUserGpioDriver, ) -> None: - self.__channel = channel + self.__ch = ch self.__pin: str = str(config.pin) self.__inverted: bool = config.inverted @@ -100,7 +101,7 @@ class _GpioInput: } def __str__(self) -> str: - return f"Input({self.__channel}, driver={self.__driver}, pin={self.__pin})" + return f"Input({self.__ch}, driver={self.__driver}, pin={self.__pin})" __repr__ = __str__ @@ -108,13 +109,13 @@ class _GpioInput: class _GpioOutput: # pylint: disable=too-many-instance-attributes def __init__( self, - channel: str, + ch: str, config: Section, driver: BaseUserGpioDriver, notifier: aiotools.AioNotifier, ) -> None: - self.__channel = channel + self.__ch = ch self.__pin: str = str(config.pin) self.__inverted: bool = config.inverted @@ -184,7 +185,7 @@ class _GpioOutput: # pylint: disable=too-many-instance-attributes @aiotools.atomic_fg async def __run_action(self, wait: bool, name: str, func: Callable, *args: Any) -> None: if wait: - async with self.__region: + with self.__region: await func(*args) else: await aiotools.run_region_task( @@ -224,7 +225,7 @@ class _GpioOutput: # pylint: disable=too-many-instance-attributes await self.__driver.write(self.__pin, (state ^ self.__inverted)) def __str__(self) -> str: - return f"Output({self.__channel}, driver={self.__driver}, pin={self.__pin})" + return f"Output({self.__ch}, driver={self.__driver}, pin={self.__pin})" __repr__ = __str__ @@ -232,8 +233,6 @@ class _GpioOutput: # pylint: disable=too-many-instance-attributes # ===== class UserGpio: def __init__(self, config: Section, otg_config: Section) -> None: - self.__view = config.view - self.__notifier = aiotools.AioNotifier() self.__drivers = { @@ -249,45 +248,67 @@ class UserGpio: self.__inputs: dict[str, _GpioInput] = {} self.__outputs: dict[str, _GpioOutput] = {} - for (channel, ch_config) in tools.sorted_kvs(config.scheme): + for (ch, ch_config) in tools.sorted_kvs(config.scheme): driver = self.__drivers[ch_config.driver] if ch_config.mode == UserGpioModes.INPUT: - self.__inputs[channel] = _GpioInput(channel, ch_config, driver) + self.__inputs[ch] = _GpioInput(ch, ch_config, driver) else: # output: - self.__outputs[channel] = _GpioOutput(channel, ch_config, driver, self.__notifier) + self.__outputs[ch] = _GpioOutput(ch, ch_config, driver, self.__notifier) - async def get_model(self) -> dict: - return { - "scheme": { - "inputs": {channel: gin.get_scheme() for (channel, gin) in self.__inputs.items()}, - "outputs": { - channel: gout.get_scheme() - for (channel, gout) in self.__outputs.items() - if not gout.is_const() - }, - }, - "view": self.__make_view(), - } + self.__scheme = self.__make_scheme() + self.__view = self.__make_view(config.view) async def get_state(self) -> dict: return { - "inputs": {channel: await gin.get_state() for (channel, gin) in self.__inputs.items()}, + "model": { + "scheme": copy.deepcopy(self.__scheme), + "view": copy.deepcopy(self.__view), + }, + "state": (await self.__get_io_state()), + } + + async def trigger_state(self) -> None: + self.__notifier.notify(1) + + async def poll_state(self) -> AsyncGenerator[dict, None]: + # ==== Granularity table ==== + # - model -- Full + # - state.inputs -- Partial + # - state.outputs -- Partial + # =========================== + + prev: dict = {"inputs": {}, "outputs": {}} + while True: # pylint: disable=too-many-nested-blocks + if (await self.__notifier.wait()) > 0: + full = await self.get_state() + prev = copy.deepcopy(full["state"]) + yield full + else: + new = await self.__get_io_state() + diff: dict = {} + for sub in ["inputs", "outputs"]: + for ch in new[sub]: + if new[sub][ch] != prev[sub].get(ch): + if sub not in diff: + diff[sub] = {} + diff[sub][ch] = new[sub][ch] + if diff: + prev = copy.deepcopy(new) + yield {"state": diff} + + async def __get_io_state(self) -> dict: + return { + "inputs": { + ch: (await gin.get_state()) + for (ch, gin) in self.__inputs.items() + }, "outputs": { - channel: await gout.get_state() - for (channel, gout) in self.__outputs.items() + ch: (await gout.get_state()) + for (ch, gout) in self.__outputs.items() if not gout.is_const() }, } - async def poll_state(self) -> AsyncGenerator[dict, None]: - prev_state: dict = {} - while True: - state = await self.get_state() - if state != prev_state: - yield state - prev_state = state - await self.__notifier.wait() - def sysprep(self) -> None: get_logger(0).info("Preparing User-GPIO drivers ...") for (_, driver) in tools.sorted_kvs(self.__drivers): @@ -307,28 +328,43 @@ class UserGpio: except Exception: get_logger().exception("Can't cleanup driver %s", driver) - async def switch(self, channel: str, state: bool, wait: bool) -> None: - gout = self.__outputs.get(channel) + async def switch(self, ch: str, state: bool, wait: bool) -> None: + gout = self.__outputs.get(ch) if gout is None: raise GpioChannelNotFoundError() await gout.switch(state, wait) - async def pulse(self, channel: str, delay: float, wait: bool) -> None: - gout = self.__outputs.get(channel) + async def pulse(self, ch: str, delay: float, wait: bool) -> None: + gout = self.__outputs.get(ch) if gout is None: raise GpioChannelNotFoundError() await gout.pulse(delay, wait) # ===== - def __make_view(self) -> dict: + def __make_scheme(self) -> dict: return { - "header": {"title": self.__make_view_title()}, - "table": self.__make_view_table(), + "inputs": { + ch: gin.get_scheme() + for (ch, gin) in self.__inputs.items() + }, + "outputs": { + ch: gout.get_scheme() + for (ch, gout) in self.__outputs.items() + if not gout.is_const() + }, } - def __make_view_title(self) -> list[dict]: - raw_title = self.__view["header"]["title"] + # ===== + + def __make_view(self, view: dict) -> dict: + return { + "header": {"title": self.__make_view_title(view)}, + "table": self.__make_view_table(view), + } + + def __make_view_title(self, view: dict) -> list[dict]: + raw_title = view["header"]["title"] title: list[dict] = [] if isinstance(raw_title, list): for item in raw_title: @@ -342,9 +378,9 @@ class UserGpio: title.append(self.__make_item_label(f"#{raw_title}")) return title - def __make_view_table(self) -> list[list[dict] | None]: + def __make_view_table(self, view: dict) -> list[list[dict] | None]: table: list[list[dict] | None] = [] - for row in self.__view["table"]: + for row in view["table"]: if len(row) == 0: table.append(None) continue diff --git a/kvmd/apps/oled/__init__.py b/kvmd/apps/oled/__init__.py new file mode 100644 index 00000000..db96ca2c --- /dev/null +++ b/kvmd/apps/oled/__init__.py @@ -0,0 +1,184 @@ +#!/usr/bin/env python3 +# ========================================================================== # +# # +# KVMD-OLED - A small OLED daemon for PiKVM. # +# # +# Copyright (C) 2018-2024 Maxim Devaev # +# # +# This program is free software: you can redistribute it and/or modify # +# it under the terms of the GNU General Public License as published by # +# the Free Software Foundation, either version 3 of the License, or # +# (at your option) any later version. # +# # +# This program is distributed in the hope that it will be useful, # +# but WITHOUT ANY WARRANTY; without even the implied warranty of # +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # +# GNU General Public License for more details. # +# # +# You should have received a copy of the GNU General Public License # +# along with this program. If not, see . # +# # +# ========================================================================== # + + +import sys +import os +import signal +import itertools +import logging +import time + +import usb.core + +from luma.core import cmdline as luma_cmdline + +from PIL import ImageFont + +from .screen import Screen +from .sensors import Sensors + + +# ===== +_logger = logging.getLogger("oled") + + +# ===== +def _detect_geometry() -> dict: + with open("/proc/device-tree/model") as file: + is_cm4 = ("Compute Module 4" in file.read()) + has_usb = bool(list(usb.core.find(find_all=True))) + if is_cm4 and has_usb: + return {"height": 64, "rotate": 2} + return {"height": 32, "rotate": 0} + + +def _get_data_path(subdir: str, name: str) -> str: + if not name.startswith("@"): + return name # Just a regular system path + name = name[1:] + module_path = sys.modules[__name__].__file__ + assert module_path is not None + return os.path.join(os.path.dirname(module_path), subdir, name) + + +# ===== +def main() -> None: # pylint: disable=too-many-locals,too-many-branches,too-many-statements + logging.basicConfig(level=logging.INFO, format="%(message)s") + logging.getLogger("PIL").setLevel(logging.ERROR) + + parser = luma_cmdline.create_parser(description="Display FQDN and IP on the OLED") + parser.set_defaults(**_detect_geometry()) + + parser.add_argument("--font", default="@ProggySquare.ttf", type=(lambda arg: _get_data_path("fonts", arg)), help="Font path") + parser.add_argument("--font-size", default=16, type=int, help="Font size") + parser.add_argument("--font-spacing", default=2, type=int, help="Font line spacing") + parser.add_argument("--offset-x", default=0, type=int, help="Horizontal offset") + parser.add_argument("--offset-y", default=0, type=int, help="Vertical offset") + parser.add_argument("--interval", default=5, type=int, help="Screens interval") + parser.add_argument("--image", default="", type=(lambda arg: _get_data_path("pics", arg)), help="Display some image, wait a single interval and exit") + parser.add_argument("--text", default="", help="Display some text, wait a single interval and exit") + parser.add_argument("--pipe", action="store_true", help="Read and display lines from stdin until EOF, wait a single interval and exit") + parser.add_argument("--clear-on-exit", action="store_true", help="Clear display on exit") + parser.add_argument("--contrast", default=64, type=int, help="Set OLED contrast, values from 0 to 255") + parser.add_argument("--fahrenheit", action="store_true", help="Display temperature in Fahrenheit instead of Celsius") + options = parser.parse_args(sys.argv[1:]) + if options.config: + config = luma_cmdline.load_config(options.config) + options = parser.parse_args(config + sys.argv[1:]) + + device = luma_cmdline.create_device(options) + device.cleanup = (lambda _: None) + screen = Screen( + device=device, + font=ImageFont.truetype(options.font, options.font_size), + font_spacing=options.font_spacing, + offset=(options.offset_x, options.offset_y), + ) + + if options.display not in luma_cmdline.get_display_types()["emulator"]: + _logger.info("Iface: %s", options.interface) + _logger.info("Display: %s", options.display) + _logger.info("Size: %dx%d", device.width, device.height) + options.contrast = min(max(options.contrast, 0), 255) + _logger.info("Contrast: %d", options.contrast) + device.contrast(options.contrast) + + try: + if options.image: + screen.draw_image(options.image) + time.sleep(options.interval) + + elif options.text: + screen.draw_text(options.text.replace("\\n", "\n")) + time.sleep(options.interval) + + elif options.pipe: + text = "" + for line in sys.stdin: + text += line + if "\0" in text: + screen.draw_text(text.replace("\0", "")) + text = "" + time.sleep(options.interval) + + else: + stop_reason: (str | None) = None + + def sigusr_handler(signum: int, _) -> None: # type: ignore + nonlocal stop_reason + if signum in (signal.SIGINT, signal.SIGTERM): + stop_reason = "" + elif signum == signal.SIGUSR1: + stop_reason = "Rebooting...\nPlease wait" + elif signum == signal.SIGUSR2: + stop_reason = "Halted" + + for signum in [signal.SIGTERM, signal.SIGINT, signal.SIGUSR1, signal.SIGUSR2]: + signal.signal(signum, sigusr_handler) + + hb = itertools.cycle(r"/-\|") # Heartbeat + swim = 0 + + def draw(text: str) -> None: + nonlocal swim + count = 0 + while (count < max(options.interval, 1) * 2) and stop_reason is None: + screen.draw_text( + text=text.replace("__hb__", next(hb)), + offset_x=(3 if swim < 0 else 0), + ) + count += 1 + if swim >= 1200: + swim = -1200 + else: + swim += 1 + time.sleep(0.5) + + sensors = Sensors(options.fahrenheit) + + if device.height >= 64: + while stop_reason is None: + text = "{fqdn}\n{ip}\niface: {iface}\ntemp: {temp}\ncpu: {cpu} mem: {mem}\n(__hb__) {uptime}" + draw(sensors.render(text)) + else: + summary = True + while stop_reason is None: + if summary: + text = "{fqdn}\n(__hb__) {uptime}\ntemp: {temp}" + else: + text = "{ip}\n(__hb__) iface: {iface}\ncpu: {cpu} mem: {mem}" + draw(sensors.render(text)) + summary = (not summary) + + if stop_reason is not None: + if len(stop_reason) > 0: + options.clear_on_exit = False + screen.draw_text(stop_reason) + while len(stop_reason) > 0: + time.sleep(0.1) + + except (SystemExit, KeyboardInterrupt): + pass + + if options.clear_on_exit: + screen.draw_text("") diff --git a/kvmd/apps/oled/__main__.py b/kvmd/apps/oled/__main__.py new file mode 100644 index 00000000..4827fc49 --- /dev/null +++ b/kvmd/apps/oled/__main__.py @@ -0,0 +1,24 @@ +# ========================================================================== # +# # +# KVMD - The main PiKVM daemon. # +# # +# Copyright (C) 2018-2024 Maxim Devaev # +# # +# This program is free software: you can redistribute it and/or modify # +# it under the terms of the GNU General Public License as published by # +# the Free Software Foundation, either version 3 of the License, or # +# (at your option) any later version. # +# # +# This program is distributed in the hope that it will be useful, # +# but WITHOUT ANY WARRANTY; without even the implied warranty of # +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # +# GNU General Public License for more details. # +# # +# You should have received a copy of the GNU General Public License # +# along with this program. If not, see . # +# # +# ========================================================================== # + + +from . import main +main() diff --git a/kvmd/apps/oled/fonts/ProggySquare.ttf b/kvmd/apps/oled/fonts/ProggySquare.ttf new file mode 100644 index 00000000..9118ece5 Binary files /dev/null and b/kvmd/apps/oled/fonts/ProggySquare.ttf differ diff --git a/kvmd/apps/oled/pics/hello.ppm b/kvmd/apps/oled/pics/hello.ppm new file mode 100644 index 00000000..df97a64a Binary files /dev/null and b/kvmd/apps/oled/pics/hello.ppm differ diff --git a/kvmd/apps/oled/pics/pikvm.ppm b/kvmd/apps/oled/pics/pikvm.ppm new file mode 100644 index 00000000..fafaa511 Binary files /dev/null and b/kvmd/apps/oled/pics/pikvm.ppm differ diff --git a/kvmd/apps/oled/screen.py b/kvmd/apps/oled/screen.py new file mode 100644 index 00000000..0e3301bb --- /dev/null +++ b/kvmd/apps/oled/screen.py @@ -0,0 +1,54 @@ +#!/usr/bin/env python3 +# ========================================================================== # +# # +# KVMD-OLED - A small OLED daemon for PiKVM. # +# # +# Copyright (C) 2018-2024 Maxim Devaev # +# # +# This program is free software: you can redistribute it and/or modify # +# it under the terms of the GNU General Public License as published by # +# the Free Software Foundation, either version 3 of the License, or # +# (at your option) any later version. # +# # +# This program is distributed in the hope that it will be useful, # +# but WITHOUT ANY WARRANTY; without even the implied warranty of # +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # +# GNU General Public License for more details. # +# # +# You should have received a copy of the GNU General Public License # +# along with this program. If not, see . # +# # +# ========================================================================== # + + +from luma.core.device import device as luma_device +from luma.core.render import canvas as luma_canvas + +from PIL import Image +from PIL import ImageFont + + +# ===== +class Screen: + def __init__( + self, + device: luma_device, + font: ImageFont.FreeTypeFont, + font_spacing: int, + offset: tuple[int, int], + ) -> None: + + self.__device = device + self.__font = font + self.__font_spacing = font_spacing + self.__offset = offset + + def draw_text(self, text: str, offset_x: int=0) -> None: + with luma_canvas(self.__device) as draw: + offset = list(self.__offset) + offset[0] += offset_x + draw.multiline_text(offset, text, font=self.__font, spacing=self.__font_spacing, fill="white") + + def draw_image(self, image_path: str) -> None: + with luma_canvas(self.__device) as draw: + draw.bitmap(self.__offset, Image.open(image_path).convert("1"), fill="white") diff --git a/kvmd/apps/oled/sensors.py b/kvmd/apps/oled/sensors.py new file mode 100644 index 00000000..26d7a1c5 --- /dev/null +++ b/kvmd/apps/oled/sensors.py @@ -0,0 +1,126 @@ +#!/usr/bin/env python3 +# ========================================================================== # +# # +# KVMD-OLED - A small OLED daemon for PiKVM. # +# # +# Copyright (C) 2018-2024 Maxim Devaev # +# # +# This program is free software: you can redistribute it and/or modify # +# it under the terms of the GNU General Public License as published by # +# the Free Software Foundation, either version 3 of the License, or # +# (at your option) any later version. # +# # +# This program is distributed in the hope that it will be useful, # +# but WITHOUT ANY WARRANTY; without even the implied warranty of # +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # +# GNU General Public License for more details. # +# # +# You should have received a copy of the GNU General Public License # +# along with this program. If not, see . # +# # +# ========================================================================== # + + +import socket +import functools +import datetime +import time + +import netifaces +import psutil + + +# ===== +class Sensors: + def __init__(self, fahrenheit: bool) -> None: + self.__fahrenheit = fahrenheit + self.__sensors = { + "fqdn": socket.getfqdn, + "iface": self.__get_iface, + "ip": self.__get_ip, + "uptime": self.__get_uptime, + "temp": self.__get_temp, + "cpu": self.__get_cpu, + "mem": self.__get_mem, + } + + def render(self, text: str) -> str: + return text.format_map(self) + + def __getitem__(self, key: str) -> str: + return self.__sensors[key]() # type: ignore + + # ===== + + def __get_iface(self) -> str: + return self.__get_netconf(round(time.monotonic() / 0.3))[0] + + def __get_ip(self) -> str: + return self.__get_netconf(round(time.monotonic() / 0.3))[1] + + @functools.lru_cache(maxsize=1) + def __get_netconf(self, ts: int) -> tuple[str, str]: + _ = ts + try: + gws = netifaces.gateways() + if "default" in gws: + for proto in [socket.AF_INET, socket.AF_INET6]: + if proto in gws["default"]: + iface = gws["default"][proto][1] + addrs = netifaces.ifaddresses(iface) + return (iface, addrs[proto][0]["addr"]) + + for iface in netifaces.interfaces(): + if not iface.startswith(("lo", "docker")): + addrs = netifaces.ifaddresses(iface) + for proto in [socket.AF_INET, socket.AF_INET6]: + if proto in addrs: + return (iface, addrs[proto][0]["addr"]) + except Exception: + # _logger.exception("Can't get iface/IP") + pass + return ("", "") + + # ===== + + def __get_uptime(self) -> str: + uptime = datetime.timedelta(seconds=int(time.time() - psutil.boot_time())) + pl = {"days": uptime.days} + (pl["hours"], rem) = divmod(uptime.seconds, 3600) + (pl["mins"], pl["secs"]) = divmod(rem, 60) + return "{days}d {hours}h {mins}m".format(**pl) + + # ===== + + def __get_temp(self) -> str: + try: + with open("/sys/class/thermal/thermal_zone0/temp") as file: + temp = int(file.read().strip()) / 1000 + if self.__fahrenheit: + temp = temp * 9 / 5 + 32 + return f"{temp:.1f}\u00b0F" + return f"{temp:.1f}\u00b0C" + except Exception: + # _logger.exception("Can't read temp") + return "" + + # ===== + + def __get_cpu(self) -> str: + st = psutil.cpu_times_percent() + user = st.user - st.guest + nice = st.nice - st.guest_nice + idle_all = st.idle + st.iowait + system_all = st.system + st.irq + st.softirq + virtual = st.guest + st.guest_nice + total = max(1, user + nice + system_all + idle_all + st.steal + virtual) + percent = int( + st.nice / total * 100 + + st.user / total * 100 + + system_all / total * 100 + + (st.steal + st.guest) / total * 100 + ) + return f"{percent}%" + + def __get_mem(self) -> str: + return f"{int(psutil.virtual_memory().percent)}%" diff --git a/kvmd/apps/otg/__init__.py b/kvmd/apps/otg/__init__.py index a090c1bf..9e212cf6 100644 --- a/kvmd/apps/otg/__init__.py +++ b/kvmd/apps/otg/__init__.py @@ -350,5 +350,5 @@ def main(argv: (list[str] | None)=None) -> None: options = parser.parse_args(argv[1:]) try: options.cmd(config) - except ValidatorError as err: - raise SystemExit(str(err)) + except ValidatorError as ex: + raise SystemExit(str(ex)) diff --git a/kvmd/apps/otgmsd/__init__.py b/kvmd/apps/otgmsd/__init__.py index 0fd0fbe6..cd8f7718 100644 --- a/kvmd/apps/otgmsd/__init__.py +++ b/kvmd/apps/otgmsd/__init__.py @@ -50,9 +50,9 @@ def _set_param(gadget: str, instance: int, param: str, value: str) -> None: try: with open(_get_param_path(gadget, instance, param), "w") as file: file.write(value + "\n") - except OSError as err: - if err.errno == errno.EBUSY: - raise SystemExit(f"Can't change {param!r} value because device is locked: {err}") + except OSError as ex: + if ex.errno == errno.EBUSY: + raise SystemExit(f"Can't change {param!r} value because device is locked: {ex}") raise diff --git a/kvmd/apps/otgnet/__init__.py b/kvmd/apps/otgnet/__init__.py index 3519d98b..35c0bc45 100644 --- a/kvmd/apps/otgnet/__init__.py +++ b/kvmd/apps/otgnet/__init__.py @@ -133,8 +133,8 @@ class _Service: # pylint: disable=too-many-instance-attributes logger.info("CMD: %s", tools.cmdfmt(cmd)) try: return (not (await aioproc.log_process(cmd, logger)).returncode) - except Exception as err: - logger.exception("Can't execute command: %s", err) + except Exception as ex: + logger.exception("Can't execute command: %s", ex) return False # ===== diff --git a/kvmd/apps/pst/server.py b/kvmd/apps/pst/server.py index a22025fe..79bbf7c8 100644 --- a/kvmd/apps/pst/server.py +++ b/kvmd/apps/pst/server.py @@ -50,7 +50,7 @@ class PstServer(HttpServer): # pylint: disable=too-many-arguments,too-many-inst super().__init__() - self.__data_path = os.path.join(fstab.find_pst().root_path, "data") + self.__data_path = fstab.find_pst().root_path self.__ro_retries_delay = ro_retries_delay self.__ro_cleanup_delay = ro_cleanup_delay self.__remount_cmd = remount_cmd @@ -60,8 +60,8 @@ class PstServer(HttpServer): # pylint: disable=too-many-arguments,too-many-inst # ===== WEBSOCKET @exposed_http("GET", "/ws") - async def __ws_handler(self, request: Request) -> WebSocketResponse: - async with self._ws_session(request) as ws: + async def __ws_handler(self, req: Request) -> WebSocketResponse: + async with self._ws_session(req) as ws: await ws.send_event("loop", {}) return (await self._ws_loop(ws)) @@ -128,9 +128,9 @@ class PstServer(HttpServer): # pylint: disable=too-many-arguments,too-many-inst def __is_write_available(self) -> bool: try: return (not (os.statvfs(self.__data_path).f_flag & os.ST_RDONLY)) - except Exception as err: + except Exception as ex: get_logger(0).info("Can't get filesystem state of PST (%s): %s", - self.__data_path, tools.efmt(err)) + self.__data_path, tools.efmt(ex)) return False async def __remount_storage(self, rw: bool) -> bool: diff --git a/kvmd/apps/pstrun/__init__.py b/kvmd/apps/pstrun/__init__.py index f7dd537d..33e1396e 100644 --- a/kvmd/apps/pstrun/__init__.py +++ b/kvmd/apps/pstrun/__init__.py @@ -46,8 +46,8 @@ def _preexec() -> None: if os.isatty(0): try: os.tcsetpgrp(0, os.getpgid(0)) - except Exception as err: - get_logger(0).info("Can't perform tcsetpgrp(0): %s", tools.efmt(err)) + except Exception as ex: + get_logger(0).info("Can't perform tcsetpgrp(0): %s", tools.efmt(ex)) async def _run_process(cmd: list[str], data_path: str) -> asyncio.subprocess.Process: # pylint: disable=no-member diff --git a/kvmd/apps/vnc/__init__.py b/kvmd/apps/vnc/__init__.py index a5d3c781..1e2c486a 100644 --- a/kvmd/apps/vnc/__init__.py +++ b/kvmd/apps/vnc/__init__.py @@ -21,7 +21,7 @@ from ...clients.kvmd import KvmdClient -from ...clients.streamer import StreamFormats +from ...clients.streamer import StreamerFormats from ...clients.streamer import BaseStreamerClient from ...clients.streamer import HttpStreamerClient from ...clients.streamer import MemsinkStreamerClient @@ -51,8 +51,8 @@ def main(argv: (list[str] | None)=None) -> None: return None streamers: list[BaseStreamerClient] = list(filter(None, [ - make_memsink_streamer("h264", StreamFormats.H264), - make_memsink_streamer("jpeg", StreamFormats.JPEG), + make_memsink_streamer("h264", StreamerFormats.H264), + make_memsink_streamer("jpeg", StreamerFormats.JPEG), HttpStreamerClient(name="JPEG", user_agent=user_agent, **config.streamer._unpack()), ])) @@ -71,6 +71,7 @@ def main(argv: (list[str] | None)=None) -> None: desired_fps=config.desired_fps, mouse_output=config.mouse_output, keymap_path=config.keymap, + allow_cut_after=config.allow_cut_after, kvmd=KvmdClient(user_agent=user_agent, **config.kvmd._unpack()), streamers=streamers, diff --git a/kvmd/apps/vnc/rfb/__init__.py b/kvmd/apps/vnc/rfb/__init__.py index ac4e0354..d2c6b50b 100644 --- a/kvmd/apps/vnc/rfb/__init__.py +++ b/kvmd/apps/vnc/rfb/__init__.py @@ -22,6 +22,7 @@ import asyncio import ssl +import time from typing import Callable from typing import Coroutine @@ -64,6 +65,7 @@ class RfbClient(RfbClientStream): # pylint: disable=too-many-instance-attribute width: int, height: int, name: str, + allow_cut_after: float, vnc_passwds: list[str], vencrypt: bool, none_auth_only: bool, @@ -79,6 +81,7 @@ class RfbClient(RfbClientStream): # pylint: disable=too-many-instance-attribute self._width = width self._height = height self.__name = name + self.__allow_cut_after = allow_cut_after self.__vnc_passwds = vnc_passwds self.__vencrypt = vencrypt self.__none_auth_only = none_auth_only @@ -90,6 +93,8 @@ class RfbClient(RfbClientStream): # pylint: disable=too-many-instance-attribute self.__fb_cont_updates = False self.__fb_reset_h264 = False + self.__allow_cut_since_ts = 0.0 + self.__lock = asyncio.Lock() # ===== @@ -120,10 +125,10 @@ class RfbClient(RfbClientStream): # pylint: disable=too-many-instance-attribute except asyncio.CancelledError: logger.info("%s [%s]: Cancelling subtask ...", self._remote, name) raise - except RfbConnectionError as err: - logger.info("%s [%s]: Gone: %s", self._remote, name, err) - except (RfbError, ssl.SSLError) as err: - logger.error("%s [%s]: Error: %s", self._remote, name, err) + except RfbConnectionError as ex: + logger.info("%s [%s]: Gone: %s", self._remote, name, ex) + except (RfbError, ssl.SSLError) as ex: + logger.error("%s [%s]: Error: %s", self._remote, name, ex) except Exception: logger.exception("%s [%s]: Unhandled exception", self._remote, name) @@ -414,6 +419,7 @@ class RfbClient(RfbClientStream): # pylint: disable=too-many-instance-attribute # ===== async def __main_loop(self) -> None: + self.__allow_cut_since_ts = time.monotonic() + self.__allow_cut_after handlers = { 0: self.__handle_set_pixel_format, 2: self.__handle_set_encodings, @@ -499,7 +505,12 @@ class RfbClient(RfbClientStream): # pylint: disable=too-many-instance-attribute async def __handle_client_cut_text(self) -> None: length = (await self._read_struct("cut text length", "xxx L"))[0] text = await self._read_text("cut text data", length) - await self._on_cut_event(text) + if self.__allow_cut_since_ts > 0 and time.monotonic() >= self.__allow_cut_since_ts: + # We should ignore cut event a few seconds after handshake + # because bVNC, AVNC and maybe some other clients perform + # it right after the connection automatically. + # - https://github.com/pikvm/pikvm/issues/1420 + await self._on_cut_event(text) async def __handle_enable_cont_updates(self) -> None: enabled = bool((await self._read_struct("enabled ContUpdates", "B HH HH"))[0]) diff --git a/kvmd/apps/vnc/rfb/errors.py b/kvmd/apps/vnc/rfb/errors.py index 1cf68818..caa4d085 100644 --- a/kvmd/apps/vnc/rfb/errors.py +++ b/kvmd/apps/vnc/rfb/errors.py @@ -29,5 +29,5 @@ class RfbError(Exception): class RfbConnectionError(RfbError): - def __init__(self, msg: str, err: Exception) -> None: - super().__init__(f"{msg}: {tools.efmt(err)}") + def __init__(self, msg: str, ex: Exception) -> None: + super().__init__(f"{msg}: {tools.efmt(ex)}") diff --git a/kvmd/apps/vnc/rfb/stream.py b/kvmd/apps/vnc/rfb/stream.py index 44998617..dc3ceb1b 100644 --- a/kvmd/apps/vnc/rfb/stream.py +++ b/kvmd/apps/vnc/rfb/stream.py @@ -51,22 +51,22 @@ class RfbClientStream: else: fmt = f">{fmt}" return struct.unpack(fmt, await self.__reader.readexactly(struct.calcsize(fmt)))[0] - except (ConnectionError, asyncio.IncompleteReadError) as err: - raise RfbConnectionError(f"Can't read {msg}", err) + except (ConnectionError, asyncio.IncompleteReadError) as ex: + raise RfbConnectionError(f"Can't read {msg}", ex) async def _read_struct(self, msg: str, fmt: str) -> tuple[int, ...]: assert len(fmt) > 1 try: fmt = f">{fmt}" return struct.unpack(fmt, (await self.__reader.readexactly(struct.calcsize(fmt)))) - except (ConnectionError, asyncio.IncompleteReadError) as err: - raise RfbConnectionError(f"Can't read {msg}", err) + except (ConnectionError, asyncio.IncompleteReadError) as ex: + raise RfbConnectionError(f"Can't read {msg}", ex) async def _read_text(self, msg: str, length: int) -> str: try: return (await self.__reader.readexactly(length)).decode("utf-8", errors="ignore") - except (ConnectionError, asyncio.IncompleteReadError) as err: - raise RfbConnectionError(f"Can't read {msg}", err) + except (ConnectionError, asyncio.IncompleteReadError) as ex: + raise RfbConnectionError(f"Can't read {msg}", ex) # ===== @@ -84,8 +84,8 @@ class RfbClientStream: self.__writer.write(struct.pack(f">{fmt}", *values)) if drain: await self.__writer.drain() - except ConnectionError as err: - raise RfbConnectionError(f"Can't write {msg}", err) + except ConnectionError as ex: + raise RfbConnectionError(f"Can't write {msg}", ex) async def _write_reason(self, msg: str, text: str, drain: bool=True) -> None: encoded = text.encode("utf-8", errors="ignore") @@ -94,8 +94,8 @@ class RfbClientStream: self.__writer.write(encoded) if drain: await self.__writer.drain() - except ConnectionError as err: - raise RfbConnectionError(f"Can't write {msg}", err) + except ConnectionError as ex: + raise RfbConnectionError(f"Can't write {msg}", ex) async def _write_fb_update(self, msg: str, width: int, height: int, encoding: int, drain: bool=True) -> None: await self._write_struct( @@ -123,8 +123,8 @@ class RfbClientStream: server_side=True, ssl_handshake_timeout=ssl_timeout, ) - except ConnectionError as err: - raise RfbConnectionError("Can't start TLS", err) + except ConnectionError as ex: + raise RfbConnectionError("Can't start TLS", ex) ssl_reader.set_transport(transport) # type: ignore ssl_writer = asyncio.StreamWriter( diff --git a/kvmd/apps/vnc/server.py b/kvmd/apps/vnc/server.py index 6ec3960e..5abca7b0 100644 --- a/kvmd/apps/vnc/server.py +++ b/kvmd/apps/vnc/server.py @@ -42,7 +42,7 @@ from ...clients.kvmd import KvmdClient from ...clients.streamer import StreamerError from ...clients.streamer import StreamerPermError -from ...clients.streamer import StreamFormats +from ...clients.streamer import StreamerFormats from ...clients.streamer import BaseStreamerClient from ... import tools @@ -81,6 +81,7 @@ class _Client(RfbClient): # pylint: disable=too-many-instance-attributes mouse_output: str, keymap_name: str, symmap: dict[int, dict[int, str]], + allow_cut_after: float, kvmd: KvmdClient, streamers: list[BaseStreamerClient], @@ -100,6 +101,7 @@ class _Client(RfbClient): # pylint: disable=too-many-instance-attributes tls_timeout=tls_timeout, x509_cert_path=x509_cert_path, x509_key_path=x509_key_path, + allow_cut_after=allow_cut_after, vnc_passwds=list(vnc_credentials), vencrypt=vencrypt, none_auth_only=none_auth_only, @@ -175,20 +177,25 @@ class _Client(RfbClient): # pylint: disable=too-many-instance-attributes self.__kvmd_ws = None async def __process_ws_event(self, event_type: str, event: dict) -> None: - if event_type == "info_meta_state": - try: - host = event["server"]["host"] - except Exception: - host = None - else: - if isinstance(host, str): - name = f"PiKVM: {host}" - if self._encodings.has_rename: - await self._send_rename(name) - self.__shared_params.name = name + if event_type == "info_state": + if "meta" in event: + try: + host = event["meta"]["server"]["host"] + except Exception: + host = None + else: + if isinstance(host, str): + name = f"PiKVM: {host}" + if self._encodings.has_rename: + await self._send_rename(name) + self.__shared_params.name = name elif event_type == "hid_state": - if self._encodings.has_leds_state: + if ( + self._encodings.has_leds_state + and ("keyboard" in event) + and ("leds" in event["keyboard"]) + ): await self._send_leds_state(**event["keyboard"]["leds"]) # ===== @@ -210,19 +217,19 @@ class _Client(RfbClient): # pylint: disable=too-many-instance-attributes await self.__queue_frame(frame) else: await self.__queue_frame("No signal") - except StreamerError as err: - if isinstance(err, StreamerPermError): + except StreamerError as ex: + if isinstance(ex, StreamerPermError): streamer = self.__get_default_streamer() - logger.info("%s [streamer]: Permanent error: %s; switching to %s ...", self._remote, err, streamer) + logger.info("%s [streamer]: Permanent error: %s; switching to %s ...", self._remote, ex, streamer) else: - logger.info("%s [streamer]: Waiting for stream: %s", self._remote, err) + logger.info("%s [streamer]: Waiting for stream: %s", self._remote, ex) await self.__queue_frame("Waiting for stream ...") await asyncio.sleep(1) def __get_preferred_streamer(self) -> BaseStreamerClient: formats = { - StreamFormats.JPEG: "has_tight", - StreamFormats.H264: "has_h264", + StreamerFormats.JPEG: "has_tight", + StreamerFormats.H264: "has_h264", } streamer: (BaseStreamerClient | None) = None for streamer in self.__streamers: @@ -248,7 +255,7 @@ class _Client(RfbClient): # pylint: disable=too-many-instance-attributes "data": (await make_text_jpeg(self._width, self._height, self._encodings.tight_jpeg_quality, text)), "width": self._width, "height": self._height, - "format": StreamFormats.JPEG, + "format": StreamerFormats.JPEG, } async def __fb_sender_task_loop(self) -> None: # pylint: disable=too-many-branches @@ -258,21 +265,21 @@ class _Client(RfbClient): # pylint: disable=too-many-instance-attributes frame = await self.__fb_queue.get() if ( last is None # pylint: disable=too-many-boolean-expressions - or frame["format"] == StreamFormats.JPEG + or frame["format"] == StreamerFormats.JPEG or last["format"] != frame["format"] - or (frame["format"] == StreamFormats.H264 and ( + or (frame["format"] == StreamerFormats.H264 and ( frame["key"] or last["width"] != frame["width"] or last["height"] != frame["height"] or len(last["data"]) + len(frame["data"]) > 4194304 )) ): - self.__fb_has_key = (frame["format"] == StreamFormats.H264 and frame["key"]) + self.__fb_has_key = (frame["format"] == StreamerFormats.H264 and frame["key"]) last = frame if self.__fb_queue.qsize() == 0: break continue - assert frame["format"] == StreamFormats.H264 + assert frame["format"] == StreamerFormats.H264 last["data"] += frame["data"] if self.__fb_queue.qsize() == 0: break @@ -294,9 +301,9 @@ class _Client(RfbClient): # pylint: disable=too-many-instance-attributes await self._send_fb_allow_again() continue - if last["format"] == StreamFormats.JPEG: + if last["format"] == StreamerFormats.JPEG: await self._send_fb_jpeg(last["data"]) - elif last["format"] == StreamFormats.H264: + elif last["format"] == StreamerFormats.H264: if not self._encodings.has_h264: raise RfbError("The client doesn't want to accept H264 anymore") if self.__fb_has_key: @@ -439,6 +446,7 @@ class VncServer: # pylint: disable=too-many-instance-attributes desired_fps: int, mouse_output: str, keymap_path: str, + allow_cut_after: float, kvmd: KvmdClient, streamers: list[BaseStreamerClient], @@ -481,8 +489,8 @@ class VncServer: # pylint: disable=too-many-instance-attributes try: async with kvmd.make_session("", "") as kvmd_session: none_auth_only = await kvmd_session.auth.check() - except (aiohttp.ClientError, asyncio.TimeoutError) as err: - logger.error("%s [entry]: Can't check KVMD auth mode: %s", remote, tools.efmt(err)) + except (aiohttp.ClientError, asyncio.TimeoutError) as ex: + logger.error("%s [entry]: Can't check KVMD auth mode: %s", remote, tools.efmt(ex)) return await _Client( @@ -496,6 +504,7 @@ class VncServer: # pylint: disable=too-many-instance-attributes mouse_output=mouse_output, keymap_name=keymap_name, symmap=symmap, + allow_cut_after=allow_cut_after, kvmd=kvmd, streamers=streamers, vnc_credentials=(await self.__vnc_auth_manager.read_credentials())[0], diff --git a/kvmd/apps/vnc/vncauth.py b/kvmd/apps/vnc/vncauth.py index ebda9ef4..46c1a77d 100644 --- a/kvmd/apps/vnc/vncauth.py +++ b/kvmd/apps/vnc/vncauth.py @@ -54,8 +54,8 @@ class VncAuthManager: if self.__enabled: try: return (await self.__inner_read_credentials(), True) - except VncAuthError as err: - get_logger(0).error(str(err)) + except VncAuthError as ex: + get_logger(0).error(str(ex)) except Exception: get_logger(0).exception("Unhandled exception while reading VNCAuth passwd file") return ({}, (not self.__enabled)) diff --git a/kvmd/apps/watchdog/__init__.py b/kvmd/apps/watchdog/__init__.py index 37981d0b..c2b03730 100644 --- a/kvmd/apps/watchdog/__init__.py +++ b/kvmd/apps/watchdog/__init__.py @@ -56,8 +56,8 @@ def _write_int(rtc: int, key: str, value: int) -> None: def _reset_alarm(rtc: int, timeout: int) -> None: try: now = _read_int(rtc, "since_epoch") - except OSError as err: - if err.errno != errno.EINVAL: + except OSError as ex: + if ex.errno != errno.EINVAL: raise raise RtcIsNotAvailableError("Can't read since_epoch right now") if now == 0: @@ -65,8 +65,8 @@ def _reset_alarm(rtc: int, timeout: int) -> None: try: for wake in [0, now + timeout]: _write_int(rtc, "wakealarm", wake) - except OSError as err: - if err.errno != errno.EIO: + except OSError as ex: + if ex.errno != errno.EIO: raise raise RtcIsNotAvailableError("IO error, probably the supercapacitor is not charged") @@ -80,9 +80,9 @@ def _cmd_run(config: Section) -> None: while True: try: _reset_alarm(config.rtc, config.timeout) - except RtcIsNotAvailableError as err: + except RtcIsNotAvailableError as ex: if not fail: - logger.error("RTC%d is not available now: %s; waiting ...", config.rtc, err) + logger.error("RTC%d is not available now: %s; waiting ...", config.rtc, ex) fail = True else: if fail: diff --git a/kvmd/clients/__init__.py b/kvmd/clients/__init__.py index 8d45fdfd..e917c9f6 100644 --- a/kvmd/clients/__init__.py +++ b/kvmd/clients/__init__.py @@ -18,3 +18,67 @@ # along with this program. If not, see . # # # # ========================================================================== # + + +import types + +from typing import Callable +from typing import Self + +import aiohttp + + +# ===== +class BaseHttpClientSession: + def __init__(self, make_http_session: Callable[[], aiohttp.ClientSession]) -> None: + self._make_http_session = make_http_session + self.__http_session: (aiohttp.ClientSession | None) = None + + def _ensure_http_session(self) -> aiohttp.ClientSession: + if not self.__http_session: + self.__http_session = self._make_http_session() + return self.__http_session + + async def close(self) -> None: + if self.__http_session: + await self.__http_session.close() + self.__http_session = None + + async def __aenter__(self) -> Self: + return self + + async def __aexit__( + self, + _exc_type: type[BaseException], + _exc: BaseException, + _tb: types.TracebackType, + ) -> None: + + await self.close() + + +class BaseHttpClient: + def __init__( + self, + unix_path: str, + timeout: float, + user_agent: str, + ) -> None: + + self.__unix_path = unix_path + self.__timeout = timeout + self.__user_agent = user_agent + + def make_session(self) -> BaseHttpClientSession: + raise NotImplementedError + + def _make_http_session(self, headers: (dict[str, str] | None)=None) -> aiohttp.ClientSession: + return aiohttp.ClientSession( + base_url="http://localhost:0", + headers={ + "User-Agent": self.__user_agent, + **(headers or {}), + }, + connector=aiohttp.UnixConnector(path=self.__unix_path), + timeout=aiohttp.ClientTimeout(total=self.__timeout), + ) diff --git a/kvmd/clients/kvmd.py b/kvmd/clients/kvmd.py index 569fb9d0..a0412ce2 100644 --- a/kvmd/clients/kvmd.py +++ b/kvmd/clients/kvmd.py @@ -23,7 +23,6 @@ import asyncio import contextlib import struct -import types from typing import Callable from typing import AsyncGenerator @@ -34,22 +33,19 @@ from .. import aiotools from .. import htclient from .. import htserver +from . import BaseHttpClient +from . import BaseHttpClientSession + # ===== class _BaseApiPart: - def __init__( - self, - ensure_http_session: Callable[[], aiohttp.ClientSession], - make_url: Callable[[str], str], - ) -> None: - + def __init__(self, ensure_http_session: Callable[[], aiohttp.ClientSession]) -> None: self._ensure_http_session = ensure_http_session - self._make_url = make_url async def _set_params(self, handle: str, **params: (int | str | None)) -> None: session = self._ensure_http_session() async with session.post( - url=self._make_url(handle), + url=handle, params={ key: value for (key, value) in params.items() @@ -63,11 +59,11 @@ class _AuthApiPart(_BaseApiPart): async def check(self) -> bool: session = self._ensure_http_session() try: - async with session.get(self._make_url("auth/check")) as response: + async with session.get("/auth/check") as response: htclient.raise_not_200(response) return True - except aiohttp.ClientResponseError as err: - if err.status in [400, 401, 403]: + except aiohttp.ClientResponseError as ex: + if ex.status in [400, 401, 403]: return False raise @@ -75,13 +71,13 @@ class _AuthApiPart(_BaseApiPart): class _StreamerApiPart(_BaseApiPart): async def get_state(self) -> dict: session = self._ensure_http_session() - async with session.get(self._make_url("streamer")) as response: + async with session.get("/streamer") as response: htclient.raise_not_200(response) return (await response.json())["result"] async def set_params(self, quality: (int | None)=None, desired_fps: (int | None)=None) -> None: await self._set_params( - "streamer/set_params", + "/streamer/set_params", quality=quality, desired_fps=desired_fps, ) @@ -90,7 +86,7 @@ class _StreamerApiPart(_BaseApiPart): class _HidApiPart(_BaseApiPart): async def get_keymaps(self) -> tuple[str, set[str]]: session = self._ensure_http_session() - async with session.get(self._make_url("hid/keymaps")) as response: + async with session.get("/hid/keymaps") as response: htclient.raise_not_200(response) result = (await response.json())["result"] return (result["keymaps"]["default"], set(result["keymaps"]["available"])) @@ -98,7 +94,7 @@ class _HidApiPart(_BaseApiPart): async def print(self, text: str, limit: int, keymap_name: str) -> None: session = self._ensure_http_session() async with session.post( - url=self._make_url("hid/print"), + url="/hid/print", params={"limit": limit, "keymap": keymap_name}, data=text, ) as response: @@ -106,7 +102,7 @@ class _HidApiPart(_BaseApiPart): async def set_params(self, keyboard_output: (str | None)=None, mouse_output: (str | None)=None) -> None: await self._set_params( - "hid/set_params", + "/hid/set_params", keyboard_output=keyboard_output, mouse_output=mouse_output, ) @@ -115,7 +111,7 @@ class _HidApiPart(_BaseApiPart): class _AtxApiPart(_BaseApiPart): async def get_state(self) -> dict: session = self._ensure_http_session() - async with session.get(self._make_url("atx")) as response: + async with session.get("/atx") as response: htclient.raise_not_200(response) return (await response.json())["result"] @@ -123,13 +119,13 @@ class _AtxApiPart(_BaseApiPart): session = self._ensure_http_session() try: async with session.post( - url=self._make_url("atx/power"), + url="/atx/power", params={"action": action}, ) as response: htclient.raise_not_200(response) return True - except aiohttp.ClientResponseError as err: - if err.status == 409: + except aiohttp.ClientResponseError as ex: + if ex.status == 409: return False raise @@ -138,7 +134,6 @@ class _AtxApiPart(_BaseApiPart): 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 @@ -200,84 +195,25 @@ class KvmdClientWs: await self.__writer_queue.put(struct.pack(">bbbb", 5, 0, delta_x, delta_y)) -class KvmdClientSession: - def __init__( - self, - make_http_session: Callable[[], aiohttp.ClientSession], - make_url: Callable[[str], str], - ) -> None: - - self.__make_http_session = make_http_session - self.__make_url = make_url - - self.__http_session: (aiohttp.ClientSession | None) = None - - args = (self.__ensure_http_session, make_url) - - self.auth = _AuthApiPart(*args) - self.streamer = _StreamerApiPart(*args) - self.hid = _HidApiPart(*args) - self.atx = _AtxApiPart(*args) +class KvmdClientSession(BaseHttpClientSession): + def __init__(self, make_http_session: Callable[[], aiohttp.ClientSession]) -> None: + super().__init__(make_http_session) + self.auth = _AuthApiPart(self._ensure_http_session) + self.streamer = _StreamerApiPart(self._ensure_http_session) + self.hid = _HidApiPart(self._ensure_http_session) + self.atx = _AtxApiPart(self._ensure_http_session) @contextlib.asynccontextmanager async def ws(self) -> AsyncGenerator[KvmdClientWs, None]: - session = self.__ensure_http_session() - async with session.ws_connect(self.__make_url("ws")) as ws: + session = self._ensure_http_session() + async with session.ws_connect("/ws", params={"legacy": "0"}) as ws: yield KvmdClientWs(ws) - def __ensure_http_session(self) -> aiohttp.ClientSession: - if not self.__http_session: - self.__http_session = self.__make_http_session() - return self.__http_session - async def close(self) -> None: - if self.__http_session: - await self.__http_session.close() - self.__http_session = None - - async def __aenter__(self) -> "KvmdClientSession": - return self - - async def __aexit__( - self, - _exc_type: type[BaseException], - _exc: BaseException, - _tb: types.TracebackType, - ) -> None: - - await self.close() - - -class KvmdClient: - def __init__( - self, - unix_path: str, - timeout: float, - user_agent: str, - ) -> None: - - self.__unix_path = unix_path - self.__timeout = timeout - self.__user_agent = user_agent - - def make_session(self, user: str, passwd: str) -> KvmdClientSession: - return KvmdClientSession( - make_http_session=(lambda: self.__make_http_session(user, passwd)), - make_url=self.__make_url, - ) - - def __make_http_session(self, user: str, passwd: str) -> aiohttp.ClientSession: - kwargs: dict = { - "headers": { - "X-KVMD-User": user, - "X-KVMD-Passwd": passwd, - "User-Agent": self.__user_agent, - }, - "connector": aiohttp.UnixConnector(path=self.__unix_path), - "timeout": aiohttp.ClientTimeout(total=self.__timeout), +class KvmdClient(BaseHttpClient): + def make_session(self, user: str="", passwd: str="") -> KvmdClientSession: + headers = { + "X-KVMD-User": user, + "X-KVMD-Passwd": passwd, } - return aiohttp.ClientSession(**kwargs) - - def __make_url(self, handle: str) -> str: - assert not handle.startswith("/"), handle - return f"http://localhost:0/{handle}" + return KvmdClientSession(lambda: self._make_http_session(headers)) diff --git a/kvmd/clients/streamer.py b/kvmd/clients/streamer.py index 1d8cd601..5369892e 100644 --- a/kvmd/clients/streamer.py +++ b/kvmd/clients/streamer.py @@ -20,7 +20,10 @@ # ========================================================================== # +import io import contextlib +import dataclasses +import functools import types from typing import Callable @@ -31,10 +34,15 @@ from typing import AsyncGenerator import aiohttp import ustreamer +from PIL import Image as PilImage + from .. import tools from .. import aiotools from .. import htclient +from . import BaseHttpClient +from . import BaseHttpClientSession + # ===== class StreamerError(Exception): @@ -50,7 +58,7 @@ class StreamerPermError(StreamerError): # ===== -class StreamFormats: +class StreamerFormats: JPEG = 1195724874 # V4L2_PIX_FMT_JPEG H264 = 875967048 # V4L2_PIX_FMT_H264 _MJPEG = 1196444237 # V4L2_PIX_FMT_MJPEG @@ -68,17 +76,85 @@ class BaseStreamerClient: # ===== +@dataclasses.dataclass(frozen=True) +class StreamerSnapshot: + online: bool + width: int + height: int + headers: tuple[tuple[str, str], ...] + data: bytes + + async def make_preview(self, max_width: int, max_height: int, quality: int) -> bytes: + assert max_width >= 0 + assert max_height >= 0 + assert quality > 0 + + if max_width == 0 and max_height == 0: + max_width = self.width // 5 + max_height = self.height // 5 + else: + max_width = min((max_width or self.width), self.width) + max_height = min((max_height or self.height), self.height) + + if (max_width, max_height) == (self.width, self.height): + return self.data + return (await aiotools.run_async(self.__inner_make_preview, max_width, max_height, quality)) + + @functools.lru_cache(maxsize=1) + def __inner_make_preview(self, max_width: int, max_height: int, quality: int) -> bytes: + with io.BytesIO(self.data) as snapshot_bio: + with io.BytesIO() as preview_bio: + with PilImage.open(snapshot_bio) as image: + image.thumbnail((max_width, max_height), PilImage.Resampling.LANCZOS) + image.save(preview_bio, format="jpeg", quality=quality) + return preview_bio.getvalue() + + +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 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: + + htclient.raise_not_200(response) + return StreamerSnapshot( + online=(response.headers["X-UStreamer-Online"] == "true"), + width=int(response.headers["X-UStreamer-Width"]), + height=int(response.headers["X-UStreamer-Height"]), + headers=tuple( + (key, value) + for (key, value) in tools.sorted_kvs(dict(response.headers)) + if key.lower().startswith("x-ustreamer-") or key.lower() in [ + "x-timestamp", + "access-control-allow-origin", + "cache-control", + "pragma", + "expires", + ] + ), + data=bytes(await response.read()), + ) + + @contextlib.contextmanager -def _http_handle_errors() -> Generator[None, None, None]: +def _http_reading_handle_errors() -> Generator[None, None, None]: try: yield - except Exception as err: # Тут бывают и ассерты, и KeyError, и прочая херня - if isinstance(err, StreamerTempError): + except Exception as ex: # Тут бывают и ассерты, и KeyError, и прочая херня + if isinstance(ex, StreamerTempError): raise - raise StreamerTempError(tools.efmt(err)) + raise StreamerTempError(tools.efmt(ex)) -class HttpStreamerClient(BaseStreamerClient): +class HttpStreamerClient(BaseHttpClient, BaseStreamerClient): def __init__( self, name: str, @@ -87,29 +163,35 @@ class HttpStreamerClient(BaseStreamerClient): user_agent: str, ) -> None: + super().__init__(unix_path, timeout, user_agent) self.__name = name - self.__unix_path = unix_path - self.__timeout = timeout - self.__user_agent = user_agent + + def make_session(self) -> HttpStreamerClientSession: + return HttpStreamerClientSession(self._make_http_session) def get_format(self) -> int: - return StreamFormats.JPEG + return StreamerFormats.JPEG @contextlib.asynccontextmanager async def reading(self) -> AsyncGenerator[Callable[[bool], Awaitable[dict]], None]: - with _http_handle_errors(): - async with self.__make_http_session() as session: + with _http_reading_handle_errors(): + async with self._make_http_session() as session: async with session.get( - url=self.__make_url("stream"), + url="/stream", params={"extra_headers": "1"}, + timeout=aiohttp.ClientTimeout( + connect=session.timeout.total, + sock_read=session.timeout.total, + ), ) as response: + htclient.raise_not_200(response) reader = aiohttp.MultipartReader.from_response(response) self.__patch_stream_reader(reader.resp.content) async def read_frame(key_required: bool) -> dict: _ = key_required - with _http_handle_errors(): + with _http_reading_handle_errors(): frame = await reader.next() # pylint: disable=not-callable if not isinstance(frame, aiohttp.BodyPartReader): raise StreamerTempError("Expected body part") @@ -123,26 +205,11 @@ class HttpStreamerClient(BaseStreamerClient): "width": int(frame.headers["X-UStreamer-Width"]), "height": int(frame.headers["X-UStreamer-Height"]), "data": data, - "format": StreamFormats.JPEG, + "format": StreamerFormats.JPEG, } yield read_frame - def __make_http_session(self) -> aiohttp.ClientSession: - kwargs: dict = { - "headers": {"User-Agent": self.__user_agent}, - "connector": aiohttp.UnixConnector(path=self.__unix_path), - "timeout": aiohttp.ClientTimeout( - connect=self.__timeout, - sock_read=self.__timeout, - ), - } - return aiohttp.ClientSession(**kwargs) - - def __make_url(self, handle: str) -> str: - assert not handle.startswith("/"), handle - return f"http://localhost:0/{handle}" - def __patch_stream_reader(self, reader: aiohttp.StreamReader) -> None: # https://github.com/pikvm/pikvm/issues/92 # Infinite looping in BodyPartReader.read() because _at_eof flag. @@ -162,15 +229,15 @@ class HttpStreamerClient(BaseStreamerClient): # ===== @contextlib.contextmanager -def _memsink_handle_errors() -> Generator[None, None, None]: +def _memsink_reading_handle_errors() -> Generator[None, None, None]: try: yield except StreamerPermError: raise - except FileNotFoundError as err: - raise StreamerTempError(tools.efmt(err)) - except Exception as err: - raise StreamerPermError(tools.efmt(err)) + except FileNotFoundError as ex: + raise StreamerTempError(tools.efmt(ex)) + except Exception as ex: + raise StreamerPermError(tools.efmt(ex)) class MemsinkStreamerClient(BaseStreamerClient): @@ -198,11 +265,11 @@ class MemsinkStreamerClient(BaseStreamerClient): @contextlib.asynccontextmanager async def reading(self) -> AsyncGenerator[Callable[[bool], Awaitable[dict]], None]: - with _memsink_handle_errors(): + with _memsink_reading_handle_errors(): with ustreamer.Memsink(**self.__kwargs) as sink: async def read_frame(key_required: bool) -> dict: - key_required = (key_required and self.__fmt == StreamFormats.H264) - with _memsink_handle_errors(): + key_required = (key_required and self.__fmt == StreamerFormats.H264) + with _memsink_reading_handle_errors(): while True: frame = await aiotools.run_async(sink.wait_frame, key_required) if frame is not None: @@ -211,8 +278,8 @@ class MemsinkStreamerClient(BaseStreamerClient): yield read_frame def __check_format(self, fmt: int) -> None: - if fmt == StreamFormats._MJPEG: # pylint: disable=protected-access - fmt = StreamFormats.JPEG + if fmt == StreamerFormats._MJPEG: # pylint: disable=protected-access + fmt = StreamerFormats.JPEG if fmt != self.__fmt: raise StreamerPermError("Invalid sink format") diff --git a/kvmd/edid.py b/kvmd/edid.py new file mode 100644 index 00000000..bfa62e3c --- /dev/null +++ b/kvmd/edid.py @@ -0,0 +1,269 @@ +# ========================================================================== # +# # +# KVMD - The main PiKVM daemon. # +# # +# Copyright (C) 2018-2024 Maxim Devaev # +# # +# This program is free software: you can redistribute it and/or modify # +# it under the terms of the GNU General Public License as published by # +# the Free Software Foundation, either version 3 of the License, or # +# (at your option) any later version. # +# # +# This program is distributed in the hope that it will be useful, # +# but WITHOUT ANY WARRANTY; without even the implied warranty of # +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # +# GNU General Public License for more details. # +# # +# You should have received a copy of the GNU General Public License # +# along with this program. If not, see . # +# # +# ========================================================================== # + + +import os +import re +import dataclasses +import contextlib + +from typing import IO +from typing import Generator + + +# ===== +class EdidNoBlockError(Exception): + pass + + +@contextlib.contextmanager +def _smart_open(path: str, mode: str) -> Generator[IO, None, None]: + fd = (0 if "r" in mode else 1) + with (os.fdopen(fd, mode, closefd=False) if path == "-" else open(path, mode)) as file: + yield file + if "w" in mode: + file.flush() + + +@dataclasses.dataclass(frozen=True) +class _CeaBlock: + tag: int + data: bytes + + def __post_init__(self) -> None: + assert 0 < self.tag <= 0b111 + assert 0 < len(self.data) <= 0b11111 + + @property + def size(self) -> int: + return len(self.data) + 1 + + def pack(self) -> bytes: + header = (self.tag << 5) | len(self.data) + return header.to_bytes() + self.data + + @classmethod + def first_from_raw(cls, raw: (bytes | list[int])) -> "_CeaBlock": + assert 0 < raw[0] <= 0xFF + tag = (raw[0] & 0b11100000) >> 5 + data_size = (raw[0] & 0b00011111) + data = bytes(raw[1:data_size + 1]) + return _CeaBlock(tag, data) + + +_CEA = 128 +_CEA_AUDIO = 1 +_CEA_SPEAKERS = 4 + + +class Edid: + # https://en.wikipedia.org/wiki/Extended_Display_Identification_Data + + def __init__(self, data: bytes) -> None: + assert len(data) == 256 + self.__data = list(data) + + @classmethod + def from_file(cls, path: str) -> "Edid": + with _smart_open(path, "rb") as file: + data = file.read() + if not data.startswith(b"\x00\xFF\xFF\xFF\xFF\xFF\xFF\x00"): + text = re.sub(r"\s", "", data.decode()) + data = bytes([ + int(text[index:index + 2], 16) + for index in range(0, len(text), 2) + ]) + assert len(data) == 256, f"Invalid EDID length: {len(data)}, should be 256 bytes" + assert data[126] == 1, "Zero extensions number" + assert (data[_CEA + 0], data[_CEA + 1]) == (0x02, 0x03), "Can't find CEA extension" + return Edid(data) + + def write_hex(self, path: str) -> None: + self.__update_checksums() + text = "\n".join( + "".join( + f"{item:0{2}X}" + for item in self.__data[index:index + 16] + ) + for index in range(0, len(self.__data), 16) + ) + "\n" + with _smart_open(path, "w") as file: + file.write(text) + + def write_bin(self, path: str) -> None: + self.__update_checksums() + with _smart_open(path, "wb") as file: + file.write(bytes(self.__data)) + + def __update_checksums(self) -> None: + self.__data[127] = 256 - (sum(self.__data[:127]) % 256) + self.__data[255] = 256 - (sum(self.__data[128:255]) % 256) + + # ===== + + def get_mfc_id(self) -> str: + raw = self.__data[8] << 8 | self.__data[9] + return bytes([ + ((raw >> 10) & 0b11111) + 0x40, + ((raw >> 5) & 0b11111) + 0x40, + (raw & 0b11111) + 0x40, + ]).decode("ascii") + + def set_mfc_id(self, mfc_id: str) -> None: + assert len(mfc_id) == 3, "Mfc ID must be 3 characters long" + data = mfc_id.upper().encode("ascii") + for ch in data: + assert 0x41 <= ch <= 0x5A, "Mfc ID must contain only A-Z characters" + raw = ( + (data[2] - 0x40) + | ((data[1] - 0x40) << 5) + | ((data[0] - 0x40) << 10) + ) + self.__data[8] = (raw >> 8) & 0xFF + self.__data[9] = raw & 0xFF + + # ===== + + def get_product_id(self) -> int: + return (self.__data[10] | self.__data[11] << 8) + + def set_product_id(self, product_id: int) -> None: + assert 0 <= product_id <= 0xFFFF, f"Product ID should be from 0 to {0xFFFF}" + self.__data[10] = product_id & 0xFF + self.__data[11] = (product_id >> 8) & 0xFF + + # ===== + + def get_serial(self) -> int: + return ( + self.__data[12] + | self.__data[13] << 8 + | self.__data[14] << 16 + | self.__data[15] << 24 + ) + + def set_serial(self, serial: int) -> None: + assert 0 <= serial <= 0xFFFFFFFF, f"Serial should be from 0 to {0xFFFFFFFF}" + self.__data[12] = serial & 0xFF + self.__data[13] = (serial >> 8) & 0xFF + self.__data[14] = (serial >> 16) & 0xFF + self.__data[15] = (serial >> 24) & 0xFF + + # ===== + + def get_monitor_name(self) -> str: + return self.__get_dtd_text(0xFC, "Monitor Name") + + def set_monitor_name(self, text: str) -> None: + self.__set_dtd_text(0xFC, "Monitor Name", text) + + def get_monitor_serial(self) -> str: + return self.__get_dtd_text(0xFF, "Monitor Serial") + + def set_monitor_serial(self, text: str) -> None: + self.__set_dtd_text(0xFF, "Monitor Serial", text) + + def __get_dtd_text(self, d_type: int, name: str) -> str: + index = self.__find_dtd_text(d_type, name) + return bytes(self.__data[index:index + 13]).decode("cp437").strip() + + def __set_dtd_text(self, d_type: int, name: str, text: str) -> None: + index = self.__find_dtd_text(d_type, name) + encoded = (text[:13] + "\n" + " " * 12)[:13].encode("cp437") + for (offset, ch) in enumerate(encoded): + self.__data[index + offset] = ch + + def __find_dtd_text(self, d_type: int, name: str) -> int: + for index in [54, 72, 90, 108]: + if self.__data[index + 3] == d_type: + return index + 5 + raise EdidNoBlockError(f"Can't find DTD {name}") + + # ===== CEA ===== + + def get_audio(self) -> bool: + (cbs, _) = self.__parse_cea() + audio = False + speakers = False + for cb in cbs: + if cb.tag == _CEA_AUDIO: + audio = True + elif cb.tag == _CEA_SPEAKERS: + speakers = True + return (audio and speakers and self.__get_basic_audio()) + + def set_audio(self, enabled: bool) -> None: + (cbs, dtds) = self.__parse_cea() + cbs = [cb for cb in cbs if cb.tag not in [_CEA_AUDIO, _CEA_SPEAKERS]] + if enabled: + cbs.append(_CeaBlock(_CEA_AUDIO, b"\x09\x7f\x07")) + cbs.append(_CeaBlock(_CEA_SPEAKERS, b"\x01\x00\x00")) + self.__replace_cea(cbs, dtds) + self.__set_basic_audio(enabled) + + def __get_basic_audio(self) -> bool: + return bool(self.__data[_CEA + 3] & 0b01000000) + + def __set_basic_audio(self, enabled: bool) -> None: + if enabled: + self.__data[_CEA + 3] |= 0b01000000 + else: + self.__data[_CEA + 3] &= (0xFF - 0b01000000) # ~X + + def __parse_cea(self) -> tuple[list[_CeaBlock], bytes]: + cea = self.__data[_CEA:] + dtd_begin = cea[2] + if dtd_begin == 0: + return ([], b"") + + cbs: list[_CeaBlock] = [] + if dtd_begin > 4: + raw = cea[4:dtd_begin] + while len(raw) != 0: + cb = _CeaBlock.first_from_raw(raw) + cbs.append(cb) + raw = raw[cb.size:] + + dtds = b"" + assert dtd_begin >= 4 + raw = cea[dtd_begin:] + while len(raw) > (18 + 1) and raw[0] != 0: + dtds += bytes(raw[:18]) + raw = raw[18:] + + return (cbs, dtds) + + def __replace_cea(self, cbs: list[_CeaBlock], dtds: bytes) -> None: + cbs_packed = b"" + for cb in cbs: + cbs_packed += cb.pack() + + raw = cbs_packed + dtds + assert len(raw) <= (128 - 4 - 1), "Too many CEA blocks or DTDs" + + self.__data[_CEA + 2] = (0 if len(raw) == 0 else (len(cbs_packed) + 4)) + + for index in range(4, 127): + try: + ch = raw[index - 4] + except IndexError: + ch = 0 + self.__data[_CEA + index] = ch diff --git a/kvmd/fstab.py b/kvmd/fstab.py index e7da2de3..3aadaa43 100644 --- a/kvmd/fstab.py +++ b/kvmd/fstab.py @@ -33,6 +33,7 @@ class Partition: mount_path: str root_path: str user: str + group: str # ===== @@ -50,7 +51,7 @@ def _find_single(part_type: str) -> Partition: if len(parts) == 0: if os.path.exists('/var/lib/kvmd/msd'): #set default value - parts = [Partition(mount_path='/var/lib/kvmd/msd', root_path='/var/lib/kvmd/msd', user='kvmd')] + parts = [Partition(mount_path='/var/lib/kvmd/msd', root_path='/var/lib/kvmd/msd',group='kvmd', user='kvmd')] else: raise RuntimeError(f"Can't find {part_type!r} mountpoint") return parts[0] @@ -64,12 +65,13 @@ def _find_partitions(part_type: str, single: bool) -> list[Partition]: if line and not line.startswith("#"): fields = line.split() if len(fields) == 6: - options = dict(re.findall(r"X-kvmd\.%s-(root|user)(?:=([^,]+))?" % (part_type), fields[3])) + options = dict(re.findall(r"X-kvmd\.%s-(root|user|group)(?:=([^,]+))?" % (part_type), fields[3])) if options: parts.append(Partition( mount_path=os.path.normpath(fields[1]), root_path=os.path.normpath(options.get("root", "") or fields[1]), user=options.get("user", ""), + group=options.get("group", ""), )) if single: break diff --git a/kvmd/helpers/remount/__init__.py b/kvmd/helpers/remount/__init__.py index e41bbbfd..54eb7731 100644 --- a/kvmd/helpers/remount/__init__.py +++ b/kvmd/helpers/remount/__init__.py @@ -22,7 +22,9 @@ import sys import os +import stat import pwd +import grp import shutil import subprocess @@ -44,8 +46,8 @@ def _remount(path: str, rw: bool) -> None: _log(f"Remounting {path} to {mode.upper()}-mode ...") try: subprocess.check_call(["/bin/mount", "--options", f"remount,{mode}", path]) - except subprocess.CalledProcessError as err: - raise SystemExit(f"Can't remount: {err}") + except subprocess.CalledProcessError as ex: + raise SystemExit(f"Can't remount: {ex}") def _mkdir(path: str) -> None: @@ -53,8 +55,8 @@ def _mkdir(path: str) -> None: _log(f"MKDIR --- {path}") try: os.mkdir(path) - except Exception as err: - raise SystemExit(f"Can't create directory: {err}") + except Exception as ex: + raise SystemExit(f"Can't create directory: {ex}") def _rmtree(path: str) -> None: @@ -62,8 +64,8 @@ def _rmtree(path: str) -> None: _log(f"RMALL --- {path}") try: shutil.rmtree(path) - except Exception as err: - raise SystemExit(f"Can't remove directory: {err}") + except Exception as ex: + raise SystemExit(f"Can't remove directory: {ex}") def _rm(path: str) -> None: @@ -71,25 +73,43 @@ def _rm(path: str) -> None: _log(f"RM --- {path}") try: os.remove(path) - except Exception as err: - raise SystemExit(f"Can't remove file: {err}") + except Exception as ex: + raise SystemExit(f"Can't remove file: {ex}") def _move(src: str, dest: str) -> None: _log(f"MOVE --- {src} --> {dest}") try: os.rename(src, dest) - except Exception as err: - raise SystemExit(f"Can't move file: {err}") + except Exception as ex: + raise SystemExit(f"Can't move file: {ex}") def _chown(path: str, user: str) -> None: if pwd.getpwuid(os.stat(path).st_uid).pw_name != user: _log(f"CHOWN --- {user} - {path}") try: - shutil.chown(path, user) - except Exception as err: - raise SystemExit(f"Can't change ownership: {err}") + shutil.chown(path, user=user) + except Exception as ex: + raise SystemExit(f"Can't change ownership: {ex}") + + +def _chgrp(path: str, group: str) -> None: + if grp.getgrgid(os.stat(path).st_gid).gr_name != group: + _log(f"CHGRP --- {group} - {path}") + try: + shutil.chown(path, group=group) + except Exception as ex: + raise SystemExit(f"Can't change group: {ex}") + + +def _chmod(path: str, mode: int) -> None: + if stat.S_IMODE(os.stat(path).st_mode) != mode: + _log(f"CHMOD --- 0o{mode:o} - {path}") + try: + os.chmod(path, mode) + except Exception as ex: + raise SystemExit(f"Can't change permissions: {ex}") # ===== @@ -112,13 +132,21 @@ def _fix_msd(part: Partition) -> None: if part.user: _chown(part.root_path, part.user) + if part.group: + _chgrp(part.root_path, part.group) def _fix_pst(part: Partition) -> None: path = os.path.join(part.root_path, "data") _mkdir(path) if part.user: + _chown(part.root_path, part.user) _chown(path, part.user) + if part.group: + _chgrp(part.root_path, part.group) + _chgrp(path, part.group) + if part.user and part.group: + _chmod(part.root_path, 0o1775) # ===== diff --git a/kvmd/htclient.py b/kvmd/htclient.py index 724eddcd..5978b189 100644 --- a/kvmd/htclient.py +++ b/kvmd/htclient.py @@ -36,27 +36,27 @@ def make_user_agent(app: str) -> str: return f"{app}/{__version__}" -def raise_not_200(response: aiohttp.ClientResponse) -> None: - if response.status != 200: - assert response.reason is not None - response.release() +def raise_not_200(resp: aiohttp.ClientResponse) -> None: + if resp.status != 200: + assert resp.reason is not None + resp.release() raise aiohttp.ClientResponseError( - response.request_info, - response.history, - status=response.status, - message=response.reason, - headers=response.headers, + resp.request_info, + resp.history, + status=resp.status, + message=resp.reason, + headers=resp.headers, ) -def get_filename(response: aiohttp.ClientResponse) -> str: +def get_filename(resp: aiohttp.ClientResponse) -> str: try: - disp = response.headers["Content-Disposition"] + disp = resp.headers["Content-Disposition"] parsed = aiohttp.multipart.parse_content_disposition(disp) return str(parsed[1]["filename"]) except Exception: try: - return os.path.basename(response.url.path) + return os.path.basename(resp.url.path) except Exception: raise aiohttp.ClientError("Can't determine filename") @@ -79,6 +79,6 @@ async def download( ), } async with aiohttp.ClientSession(**kwargs) as session: - async with session.get(url, verify_ssl=verify) as response: - raise_not_200(response) - yield response + async with session.get(url, verify_ssl=verify) as resp: # type: ignore + raise_not_200(resp) + yield resp diff --git a/kvmd/htserver.py b/kvmd/htserver.py index 4740ac7a..351c1328 100644 --- a/kvmd/htserver.py +++ b/kvmd/htserver.py @@ -157,7 +157,7 @@ def make_json_response( wrap_result: bool=True, ) -> Response: - response = Response( + resp = Response( text=json.dumps(({ "ok": (status == 200), "result": (result or {}), @@ -167,18 +167,18 @@ def make_json_response( ) if set_cookies: for (key, value) in set_cookies.items(): - response.set_cookie(key, value, httponly=True, samesite="Strict") - return response + resp.set_cookie(key, value, httponly=True, samesite="Strict") + return resp -def make_json_exception(err: Exception, status: (int | None)=None) -> Response: - name = type(err).__name__ - msg = str(err) - if isinstance(err, HttpError): - status = err.status +def make_json_exception(ex: Exception, status: (int | None)=None) -> Response: + name = type(ex).__name__ + msg = str(ex) + if isinstance(ex, HttpError): + status = ex.status else: get_logger().error("API error: %s: %s", name, msg) - assert status is not None, err + assert status is not None, ex return make_json_response({ "error": name, "error_msg": msg, @@ -186,35 +186,35 @@ def make_json_exception(err: Exception, status: (int | None)=None) -> Response: async def start_streaming( - request: Request, + req: Request, content_type: str, content_length: int=-1, file_name: str="", ) -> StreamResponse: - response = StreamResponse(status=200, reason="OK") - response.content_type = content_type + resp = StreamResponse(status=200, reason="OK") + resp.content_type = content_type if content_length >= 0: # pylint: disable=consider-using-min-builtin - response.content_length = content_length + resp.content_length = content_length if file_name: file_name = urllib.parse.quote(file_name, safe="") - response.headers["Content-Disposition"] = f"attachment; filename*=UTF-8''{file_name}" - await response.prepare(request) - return response + resp.headers["Content-Disposition"] = f"attachment; filename*=UTF-8''{file_name}" + await resp.prepare(req) + return resp -async def stream_json(response: StreamResponse, result: dict, ok: bool=True) -> None: - await response.write(json.dumps({ +async def stream_json(resp: StreamResponse, result: dict, ok: bool=True) -> None: + await resp.write(json.dumps({ "ok": ok, "result": result, }).encode("utf-8") + b"\r\n") -async def stream_json_exception(response: StreamResponse, err: Exception) -> None: - name = type(err).__name__ - msg = str(err) +async def stream_json_exception(resp: StreamResponse, ex: Exception) -> None: + name = type(ex).__name__ + msg = str(ex) get_logger().error("API error: %s: %s", name, msg) - await stream_json(response, { + await stream_json(resp, { "error": name, "error_msg": msg, }, False) @@ -249,15 +249,15 @@ def parse_ws_event(msg: str) -> tuple[str, dict]: _REQUEST_AUTH_INFO = "_kvmd_auth_info" -def _format_P(request: BaseRequest, *_, **__) -> str: # type: ignore # pylint: disable=invalid-name - return (getattr(request, _REQUEST_AUTH_INFO, None) or "-") +def _format_P(req: BaseRequest, *_, **__) -> str: # type: ignore # pylint: disable=invalid-name + return (getattr(req, _REQUEST_AUTH_INFO, None) or "-") AccessLogger._format_P = staticmethod(_format_P) # type: ignore # pylint: disable=protected-access -def set_request_auth_info(request: BaseRequest, info: str) -> None: - setattr(request, _REQUEST_AUTH_INFO, info) +def set_request_auth_info(req: BaseRequest, info: str) -> None: + setattr(req, _REQUEST_AUTH_INFO, info) # ===== @@ -318,16 +318,16 @@ class HttpServer: self.__add_exposed_ws(ws_exposed) def __add_exposed_http(self, exposed: HttpExposed) -> None: - async def wrapper(request: Request) -> Response: + async def wrapper(req: Request) -> Response: try: - await self._check_request_auth(exposed, request) - return (await exposed.handler(request)) - except IsBusyError as err: - return make_json_exception(err, 409) - except (ValidatorError, OperationError) as err: - return make_json_exception(err, 400) - except HttpError as err: - return make_json_exception(err) + await self._check_request_auth(exposed, req) + return (await exposed.handler(req)) + except IsBusyError as ex: + return make_json_exception(ex, 409) + except (ValidatorError, OperationError) as ex: + return make_json_exception(ex, 400) + except HttpError as ex: + return make_json_exception(ex) self.__app.router.add_route(exposed.method, exposed.path, wrapper) def __add_exposed_ws(self, exposed: WsExposed) -> None: @@ -342,10 +342,10 @@ class HttpServer: # ===== @contextlib.asynccontextmanager - async def _ws_session(self, request: Request, **kwargs: Any) -> AsyncGenerator[WsSession, None]: + async def _ws_session(self, req: Request, **kwargs: Any) -> AsyncGenerator[WsSession, None]: assert self.__ws_heartbeat is not None wsr = WebSocketResponse(heartbeat=self.__ws_heartbeat) - await wsr.prepare(request) + await wsr.prepare(req) ws = WsSession(wsr, kwargs) async with self.__ws_sessions_lock: @@ -364,8 +364,8 @@ class HttpServer: if msg.type == WSMsgType.TEXT: try: (event_type, event) = parse_ws_event(msg.data) - except Exception as err: - logger.error("Can't parse JSON event from websocket: %r", err) + except Exception as ex: + logger.error("Can't parse JSON event from websocket: %r", ex) else: handler = self.__ws_handlers.get(event_type) if handler: @@ -384,7 +384,7 @@ class HttpServer: break return ws.wsr - async def _broadcast_ws_event(self, event_type: str, event: (dict | None)) -> None: + async def _broadcast_ws_event(self, event_type: str, event: (dict | None), legacy: (bool | None)=None) -> None: if self.__ws_sessions: await asyncio.gather(*[ ws.send_event(event_type, event) @@ -393,6 +393,7 @@ class HttpServer: not ws.wsr.closed and ws.wsr._req is not None # pylint: disable=protected-access and ws.wsr._req.transport is not None # pylint: disable=protected-access + and (legacy is None or ws.kwargs.get("legacy") == legacy) ) ], return_exceptions=True) @@ -417,7 +418,7 @@ class HttpServer: # ===== - async def _check_request_auth(self, exposed: HttpExposed, request: Request) -> None: + async def _check_request_auth(self, exposed: HttpExposed, req: Request) -> None: pass async def _init_app(self) -> None: diff --git a/kvmd/inotify.py b/kvmd/inotify.py index 700247ef..e2cc6251 100644 --- a/kvmd/inotify.py +++ b/kvmd/inotify.py @@ -130,18 +130,25 @@ class InotifyMask: # | OPEN # ) - # Helper for all modify events - ALL_MODIFY_EVENTS = ( + # Helper for all changes events except MODIFY, because it fires on each write() + ALL_CHANGES_EVENTS = ( CLOSE_WRITE | CREATE | DELETE | DELETE_SELF - | MODIFY | MOVE_SELF | MOVED_FROM | MOVED_TO ) + # Helper for typicals events when we need to restart watcher + ALL_RESTART_EVENTS = ( + DELETE_SELF + | MOVE_SELF + | UNMOUNT + | ISDIR + ) + # Special flags for watch() # DONT_FOLLOW = 0x02000000 # Don't follow a symbolic link # EXCL_UNLINK = 0x04000000 # Exclude events on unlinked objects @@ -172,6 +179,10 @@ class InotifyEvent: name: str path: str + @property + def restart(self) -> bool: + return bool(self.mask & InotifyMask.ALL_RESTART_EVENTS) + def __repr__(self) -> str: return ( f" None: + await self.watch(InotifyMask.ALL_CHANGES_EVENTS, *paths) + async def watch(self, mask: int, *paths: str) -> None: for path in paths: path = os.path.normpath(path) @@ -222,7 +236,7 @@ class Inotify: except asyncio.TimeoutError: return None - async def get_series(self, timeout: float) -> list[InotifyEvent]: + async def get_series(self, timeout: float, max_series: int=64) -> list[InotifyEvent]: series: list[InotifyEvent] = [] event = await self.get_event(timeout) if event: @@ -231,6 +245,8 @@ class Inotify: event = await self.get_event(timeout) if event: series.append(event) + if len(series) >= max_series: + break return series def __read_and_queue_events(self) -> None: @@ -271,8 +287,8 @@ class Inotify: while True: try: return os.read(self.__fd, _EVENTS_BUFFER_LENGTH) - except OSError as err: - if err.errno == errno.EINTR: + except OSError as ex: + if ex.errno == errno.EINTR: pass def __enter__(self) -> "Inotify": diff --git a/kvmd/keyboard/keysym.py b/kvmd/keyboard/keysym.py index 5e80d789..2896ca6e 100644 --- a/kvmd/keyboard/keysym.py +++ b/kvmd/keyboard/keysym.py @@ -135,8 +135,8 @@ def _read_keyboard_layout(path: str) -> dict[int, list[At1Key]]: # Keysym to ev try: at1_code = int(parts[1], 16) - except ValueError as err: - logger.error("Syntax error at %s:%d: %s", path, lineno, err) + except ValueError as ex: + logger.error("Syntax error at %s:%d: %s", path, lineno, ex) continue rest = parts[2:] diff --git a/kvmd/network.py b/kvmd/network.py index 22721dd5..fcf67117 100644 --- a/kvmd/network.py +++ b/kvmd/network.py @@ -34,10 +34,10 @@ def is_ipv6_enabled() -> bool: with socket.socket(socket.AF_INET6, socket.SOCK_STREAM) as sock: sock.bind(("::1", 0)) return True - except OSError as err: - if err.errno in [errno.EADDRNOTAVAIL, errno.EAFNOSUPPORT]: + except OSError as ex: + if ex.errno in [errno.EADDRNOTAVAIL, errno.EAFNOSUPPORT]: return False - if err.errno == errno.EADDRINUSE: + if ex.errno == errno.EADDRINUSE: return True raise diff --git a/kvmd/plugins/atx/__init__.py b/kvmd/plugins/atx/__init__.py index e9496a65..d8bea96d 100644 --- a/kvmd/plugins/atx/__init__.py +++ b/kvmd/plugins/atx/__init__.py @@ -48,7 +48,16 @@ class BaseAtx(BasePlugin): async def get_state(self) -> dict: raise NotImplementedError + async def trigger_state(self) -> None: + raise NotImplementedError + async def poll_state(self) -> AsyncGenerator[dict, None]: + # ==== Granularity table ==== + # - enabled -- Full + # - busy -- Partial + # - leds -- Partial + # =========================== + yield {} raise NotImplementedError diff --git a/kvmd/plugins/atx/disabled.py b/kvmd/plugins/atx/disabled.py index d9abec00..60c2fa5b 100644 --- a/kvmd/plugins/atx/disabled.py +++ b/kvmd/plugins/atx/disabled.py @@ -36,6 +36,9 @@ class AtxDisabledError(AtxOperationError): # ===== class Plugin(BaseAtx): + def __init__(self) -> None: + self.__notifier = aiotools.AioNotifier() + async def get_state(self) -> dict: return { "enabled": False, @@ -46,10 +49,13 @@ class Plugin(BaseAtx): }, } + async def trigger_state(self) -> None: + self.__notifier.notify() + async def poll_state(self) -> AsyncGenerator[dict, None]: while True: + await self.__notifier.wait() yield (await self.get_state()) - await aiotools.wait_infinite() # ===== diff --git a/kvmd/plugins/atx/gpio.py b/kvmd/plugins/atx/gpio.py index 6df57bb3..578d2717 100644 --- a/kvmd/plugins/atx/gpio.py +++ b/kvmd/plugins/atx/gpio.py @@ -21,6 +21,7 @@ import asyncio +import copy from typing import AsyncGenerator @@ -76,7 +77,7 @@ class Plugin(BaseAtx): # pylint: disable=too-many-instance-attributes self.__notifier = aiotools.AioNotifier() self.__region = aiotools.AioExclusiveRegion(AtxIsBusyError, self.__notifier) - self.__line_request: (gpiod.LineRequest | None) = None + self.__line_req: (gpiod.LineRequest | None) = None self.__reader = aiogp.AioReader( path=self.__device_path, @@ -108,8 +109,8 @@ class Plugin(BaseAtx): # pylint: disable=too-many-instance-attributes } def sysprep(self) -> None: - assert self.__line_request is None - self.__line_request = gpiod.request_lines( + assert self.__line_req is None + self.__line_req = gpiod.request_lines( self.__device_path, consumer="kvmd::atx", config={ @@ -130,22 +131,26 @@ class Plugin(BaseAtx): # pylint: disable=too-many-instance-attributes }, } + async def trigger_state(self) -> None: + self.__notifier.notify(1) + async def poll_state(self) -> AsyncGenerator[dict, None]: - prev_state: dict = {} + prev: dict = {} while True: - state = await self.get_state() - if state != prev_state: - yield state - prev_state = state - await self.__notifier.wait() + if (await self.__notifier.wait()) > 0: + prev = {} + new = await self.get_state() + if new != prev: + prev = copy.deepcopy(new) + yield new async def systask(self) -> None: await self.__reader.poll() async def cleanup(self) -> None: - if self.__line_request: + if self.__line_req: try: - self.__line_request.release() + self.__line_req.release() except Exception: pass @@ -186,7 +191,7 @@ class Plugin(BaseAtx): # pylint: disable=too-many-instance-attributes @aiotools.atomic_fg async def __click(self, name: str, pin: int, delay: float, wait: bool) -> None: if wait: - async with self.__region: + with self.__region: await self.__inner_click(name, pin, delay) else: await aiotools.run_region_task( @@ -196,11 +201,11 @@ class Plugin(BaseAtx): # pylint: disable=too-many-instance-attributes @aiotools.atomic_fg async def __inner_click(self, name: str, pin: int, delay: float) -> None: - assert self.__line_request + assert self.__line_req try: - self.__line_request.set_value(pin, gpiod.line.Value(True)) + self.__line_req.set_value(pin, gpiod.line.Value(True)) await asyncio.sleep(delay) finally: - self.__line_request.set_value(pin, gpiod.line.Value(False)) + self.__line_req.set_value(pin, gpiod.line.Value(False)) await asyncio.sleep(1) get_logger(0).info("Clicked ATX button %r", name) diff --git a/kvmd/plugins/auth/http.py b/kvmd/plugins/auth/http.py index 54308279..b59218aa 100644 --- a/kvmd/plugins/auth/http.py +++ b/kvmd/plugins/auth/http.py @@ -75,7 +75,7 @@ class Plugin(BaseAuthService): async with session.request( method="POST", url=self.__url, - timeout=self.__timeout, + timeout=aiohttp.ClientTimeout(total=self.__timeout), json={ "user": user, "passwd": passwd, @@ -85,8 +85,8 @@ class Plugin(BaseAuthService): "User-Agent": htclient.make_user_agent("KVMD"), "X-KVMD-User": user, }, - ) as response: - htclient.raise_not_200(response) + ) as resp: + htclient.raise_not_200(resp) return True except Exception: get_logger().exception("Failed HTTP auth request for user %r", user) diff --git a/kvmd/plugins/auth/ldap.py b/kvmd/plugins/auth/ldap.py index fa6b9fff..961a47c7 100644 --- a/kvmd/plugins/auth/ldap.py +++ b/kvmd/plugins/auth/ldap.py @@ -100,10 +100,10 @@ class Plugin(BaseAuthService): return True except ldap.INVALID_CREDENTIALS: pass - except ldap.SERVER_DOWN as err: - get_logger().error("LDAP server is down: %s", tools.efmt(err)) - except Exception as err: - get_logger().error("Unexpected LDAP error: %s", tools.efmt(err)) + except ldap.SERVER_DOWN as ex: + get_logger().error("LDAP server is down: %s", tools.efmt(ex)) + except Exception as ex: + get_logger().error("Unexpected LDAP error: %s", tools.efmt(ex)) finally: if conn is not None: try: diff --git a/kvmd/plugins/auth/radius.py b/kvmd/plugins/auth/radius.py index 92c4632d..f048a2e6 100644 --- a/kvmd/plugins/auth/radius.py +++ b/kvmd/plugins/auth/radius.py @@ -435,10 +435,10 @@ class Plugin(BaseAuthService): timeout=self.__timeout, dict=dct, ) - request = client.CreateAuthPacket(code=pyrad.packet.AccessRequest, User_Name=user) - request["User-Password"] = request.PwCrypt(passwd) - response = client.SendPacket(request) - return (response.code == pyrad.packet.AccessAccept) + req = client.CreateAuthPacket(code=pyrad.packet.AccessRequest, User_Name=user) + req["User-Password"] = req.PwCrypt(passwd) + resp = client.SendPacket(req) + return (resp.code == pyrad.packet.AccessAccept) except Exception: get_logger().exception("Failed RADIUS auth request for user %r", user) return False diff --git a/kvmd/plugins/hid/__init__.py b/kvmd/plugins/hid/__init__.py index 1c2efeec..73ff5d04 100644 --- a/kvmd/plugins/hid/__init__.py +++ b/kvmd/plugins/hid/__init__.py @@ -21,9 +21,11 @@ import asyncio +import functools import time from typing import Iterable +from typing import Callable from typing import AsyncGenerator from typing import Any @@ -31,14 +33,37 @@ from ...yamlconf import Option from ...validators.basic import valid_bool from ...validators.basic import valid_int_f1 +from ...validators.basic import valid_string_list +from ...validators.hid import valid_hid_key +from ...validators.hid import valid_hid_mouse_move + +from ...mouse import MouseRange from .. import BasePlugin from .. import get_plugin_class # ===== -class BaseHid(BasePlugin): - def __init__(self, jiggler_enabled: bool, jiggler_active: bool, jiggler_interval: int) -> None: +class BaseHid(BasePlugin): # pylint: disable=too-many-instance-attributes + def __init__( + self, + ignore_keys: list[str], + + mouse_x_min: int, + mouse_x_max: int, + mouse_y_min: int, + mouse_y_max: int, + + jiggler_enabled: bool, + jiggler_active: bool, + jiggler_interval: int, + ) -> None: + + self.__ignore_keys = ignore_keys + + self.__mouse_x_range = (mouse_x_min, mouse_x_max) + self.__mouse_y_range = (mouse_y_min, mouse_y_max) + self.__jiggler_enabled = jiggler_enabled self.__jiggler_active = jiggler_active self.__jiggler_interval = jiggler_interval @@ -46,8 +71,17 @@ class BaseHid(BasePlugin): self.__activity_ts = 0 @classmethod - def _get_jiggler_options(cls) -> dict[str, Any]: + def _get_base_options(cls) -> dict[str, Any]: return { + "ignore_keys": Option([], type=functools.partial(valid_string_list, subval=valid_hid_key)), + "mouse_x_range": { + "min": Option(MouseRange.MIN, type=valid_hid_mouse_move, unpack_as="mouse_x_min"), + "max": Option(MouseRange.MAX, type=valid_hid_mouse_move, unpack_as="mouse_x_max"), + }, + "mouse_y_range": { + "min": Option(MouseRange.MIN, type=valid_hid_mouse_move, unpack_as="mouse_y_min"), + "max": Option(MouseRange.MAX, type=valid_hid_mouse_move, unpack_as="mouse_y_max"), + }, "jiggler": { "enabled": Option(False, type=valid_bool, unpack_as="jiggler_enabled"), "active": Option(False, type=valid_bool, unpack_as="jiggler_active"), @@ -63,7 +97,23 @@ class BaseHid(BasePlugin): async def get_state(self) -> dict: raise NotImplementedError + async def trigger_state(self) -> None: + raise NotImplementedError + async def poll_state(self) -> AsyncGenerator[dict, None]: + # ==== Granularity table ==== + # - enabled -- Full + # - online -- Partial + # - busy -- Partial + # - connected -- Partial, nullable + # - keyboard.online -- Partial + # - keyboard.outputs -- Partial + # - keyboard.leds -- Partial + # - mouse.online -- Partial + # - mouse.outputs -- Partial, follows with absolute + # - mouse.absolute -- Partial, follows with outputs + # =========================== + yield {} raise NotImplementedError @@ -73,25 +123,6 @@ class BaseHid(BasePlugin): async def cleanup(self) -> None: pass - # ===== - - def send_key_events(self, keys: Iterable[tuple[str, bool]]) -> None: - raise NotImplementedError - - def send_mouse_button_event(self, button: str, state: bool) -> None: - raise NotImplementedError - - def send_mouse_move_event(self, to_x: int, to_y: int) -> None: - _ = to_x - _ = to_y - - def send_mouse_relative_event(self, delta_x: int, delta_y: int) -> None: - _ = delta_x - _ = delta_y - - def send_mouse_wheel_event(self, delta_x: int, delta_y: int) -> None: - raise NotImplementedError - def set_params( self, keyboard_output: (str | None)=None, @@ -104,25 +135,100 @@ class BaseHid(BasePlugin): def set_connected(self, connected: bool) -> None: _ = connected - def clear_events(self) -> None: + # ===== + + def send_key_events(self, keys: Iterable[tuple[str, bool]], no_ignore_keys: bool=False) -> None: + for (key, state) in keys: + if no_ignore_keys or key not in self.__ignore_keys: + self.send_key_event(key, state) + + def send_key_event(self, key: str, state: bool) -> None: + self._send_key_event(key, state) + self.__bump_activity() + + def _send_key_event(self, key: str, state: bool) -> None: raise NotImplementedError # ===== - async def systask(self) -> None: - factor = 1 - while True: - if self.__jiggler_active and (self.__activity_ts + self.__jiggler_interval < int(time.monotonic())): - for _ in range(5): - if self.__jiggler_absolute: - self.send_mouse_move_event(100 * factor, 100 * factor) - else: - self.send_mouse_relative_event(10 * factor, 10 * factor) - factor *= -1 - await asyncio.sleep(0.1) - await asyncio.sleep(1) + def send_mouse_button_event(self, button: str, state: bool) -> None: + self._send_mouse_button_event(button, state) + self.__bump_activity() - def _bump_activity(self) -> None: + def _send_mouse_button_event(self, button: str, state: bool) -> None: + raise NotImplementedError + + # ===== + + def send_mouse_move_event(self, to_x: int, to_y: int) -> None: + if self.__mouse_x_range != MouseRange.RANGE: + to_x = MouseRange.remap(to_x, *self.__mouse_x_range) + if self.__mouse_y_range != MouseRange.RANGE: + to_y = MouseRange.remap(to_y, *self.__mouse_y_range) + self._send_mouse_move_event(to_x, to_y) + self.__bump_activity() + + def _send_mouse_move_event(self, to_x: int, to_y: int) -> None: + _ = to_x # XXX: NotImplementedError + _ = to_y + + # ===== + + def send_mouse_relative_events(self, deltas: Iterable[tuple[int, int]], squash: bool) -> None: + self.__process_mouse_delta_event(deltas, squash, self.send_mouse_relative_event) + + def send_mouse_relative_event(self, delta_x: int, delta_y: int) -> None: + self._send_mouse_relative_event(delta_x, delta_y) + self.__bump_activity() + + def _send_mouse_relative_event(self, delta_x: int, delta_y: int) -> None: + _ = delta_x # XXX: NotImplementedError + _ = delta_y + + # ===== + + def send_mouse_wheel_events(self, deltas: Iterable[tuple[int, int]], squash: bool) -> None: + self.__process_mouse_delta_event(deltas, squash, self.send_mouse_wheel_event) + + def send_mouse_wheel_event(self, delta_x: int, delta_y: int) -> None: + self._send_mouse_wheel_event(delta_x, delta_y) + self.__bump_activity() + + def _send_mouse_wheel_event(self, delta_x: int, delta_y: int) -> None: + raise NotImplementedError + + # ===== + + def clear_events(self) -> None: + self._clear_events() # Don't bump activity here + + def _clear_events(self) -> None: + raise NotImplementedError + + # ===== + + def __process_mouse_delta_event( + self, + deltas: Iterable[tuple[int, int]], + squash: bool, + handler: Callable[[int, int], None], + ) -> None: + + if squash: + prev = (0, 0) + for cur in deltas: + if abs(prev[0] + cur[0]) > 127 or abs(prev[1] + cur[1]) > 127: + handler(*prev) + prev = cur + else: + prev = (prev[0] + cur[0], prev[1] + cur[1]) + if prev[0] or prev[1]: + handler(*prev) + else: + for xy in deltas: + handler(*xy) + + def __bump_activity(self) -> None: self.__activity_ts = int(time.monotonic()) def _set_jiggler_absolute(self, absolute: bool) -> None: @@ -141,6 +247,21 @@ class BaseHid(BasePlugin): }, } + # ===== + + async def systask(self) -> None: + factor = 1 + while True: + if self.__jiggler_active and (self.__activity_ts + self.__jiggler_interval < int(time.monotonic())): + for _ in range(5): + if self.__jiggler_absolute: + self.send_mouse_move_event(100 * factor, 100 * factor) + else: + self.send_mouse_relative_event(10 * factor, 10 * factor) + factor *= -1 + await asyncio.sleep(0.1) + await asyncio.sleep(1) + # ===== def get_hid_class(name: str) -> type[BaseHid]: diff --git a/kvmd/plugins/hid/_mcu/__init__.py b/kvmd/plugins/hid/_mcu/__init__.py index 01411621..d6f04f76 100644 --- a/kvmd/plugins/hid/_mcu/__init__.py +++ b/kvmd/plugins/hid/_mcu/__init__.py @@ -23,9 +23,9 @@ import multiprocessing import contextlib import queue +import copy import time -from typing import Iterable from typing import Generator from typing import AsyncGenerator from typing import Any @@ -91,7 +91,7 @@ class _TempRequestError(_RequestError): # ===== class BasePhyConnection: - def send(self, request: bytes) -> bytes: + def send(self, req: bytes) -> bytes: raise NotImplementedError @@ -108,17 +108,22 @@ class BaseMcuHid(BaseHid, multiprocessing.Process): # pylint: disable=too-many- def __init__( # pylint: disable=too-many-arguments,super-init-not-called self, phy: BasePhy, + + ignore_keys: list[str], + mouse_x_range: dict[str, Any], + mouse_y_range: dict[str, Any], + jiggler: dict[str, Any], + reset_self: bool, read_retries: int, common_retries: int, retries_delay: float, errors_threshold: int, noop: bool, - jiggler: dict[str, Any], **gpio_kwargs: Any, ) -> None: - BaseHid.__init__(self, **jiggler) + BaseHid.__init__(self, ignore_keys=ignore_keys, **mouse_x_range, **mouse_y_range, **jiggler) multiprocessing.Process.__init__(self, daemon=True) self.__read_retries = read_retries @@ -163,7 +168,7 @@ class BaseMcuHid(BaseHid, multiprocessing.Process): # pylint: disable=too-many- "errors_threshold": Option(5, type=valid_int_f0), "noop": Option(False, type=valid_bool), - **cls._get_jiggler_options(), + **cls._get_base_options(), } def sysprep(self) -> None: @@ -212,6 +217,7 @@ class BaseMcuHid(BaseHid, multiprocessing.Process): # pylint: disable=too-many- mouse_outputs["active"] = active_mouse return { + "enabled": True, "online": online, "busy": bool(state["busy"]), "connected": (bool(outputs2 & 0b01000000) if outputs2 & 0b10000000 else None), @@ -232,14 +238,18 @@ class BaseMcuHid(BaseHid, multiprocessing.Process): # pylint: disable=too-many- **self._get_jiggler_state(), } + async def trigger_state(self) -> None: + self.__notifier.notify(1) + async def poll_state(self) -> AsyncGenerator[dict, None]: - prev_state: dict = {} + prev: dict = {} while True: - state = await self.get_state() - if state != prev_state: - yield state - prev_state = state - await self.__notifier.wait() + if (await self.__notifier.wait()) > 0: + prev = {} + new = await self.get_state() + if new != prev: + prev = copy.deepcopy(new) + yield new async def reset(self) -> None: self.__reset_required_event.set() @@ -254,27 +264,6 @@ class BaseMcuHid(BaseHid, multiprocessing.Process): # pylint: disable=too-many- # ===== - def send_key_events(self, keys: Iterable[tuple[str, bool]]) -> None: - for (key, state) in keys: - self.__queue_event(KeyEvent(key, state)) - self._bump_activity() - - def send_mouse_button_event(self, button: str, state: bool) -> None: - self.__queue_event(MouseButtonEvent(button, state)) - self._bump_activity() - - def send_mouse_move_event(self, to_x: int, to_y: int) -> None: - self.__queue_event(MouseMoveEvent(to_x, to_y)) - self._bump_activity() - - def send_mouse_relative_event(self, delta_x: int, delta_y: int) -> None: - self.__queue_event(MouseRelativeEvent(delta_x, delta_y)) - self._bump_activity() - - def send_mouse_wheel_event(self, delta_x: int, delta_y: int) -> None: - self.__queue_event(MouseWheelEvent(delta_x, delta_y)) - self._bump_activity() - def set_params( self, keyboard_output: (str | None)=None, @@ -296,9 +285,23 @@ class BaseMcuHid(BaseHid, multiprocessing.Process): # pylint: disable=too-many- def set_connected(self, connected: bool) -> None: self.__queue_event(SetConnectedEvent(connected), clear=True) - def clear_events(self) -> None: + def _send_key_event(self, key: str, state: bool) -> None: + self.__queue_event(KeyEvent(key, state)) + + def _send_mouse_button_event(self, button: str, state: bool) -> None: + self.__queue_event(MouseButtonEvent(button, state)) + + def _send_mouse_move_event(self, to_x: int, to_y: int) -> None: + self.__queue_event(MouseMoveEvent(to_x, to_y)) + + def _send_mouse_relative_event(self, delta_x: int, delta_y: int) -> None: + self.__queue_event(MouseRelativeEvent(delta_x, delta_y)) + + def _send_mouse_wheel_event(self, delta_x: int, delta_y: int) -> None: + self.__queue_event(MouseWheelEvent(delta_x, delta_y)) + + def _clear_events(self) -> None: self.__queue_event(ClearEvent(), clear=True) - self._bump_activity() def __queue_event(self, event: BaseEvent, clear: bool=False) -> None: if not self.__stop_event.is_set(): @@ -374,7 +377,7 @@ class BaseMcuHid(BaseHid, multiprocessing.Process): # pylint: disable=too-many- self.__set_state_online(False) return False - def __process_request(self, conn: BasePhyConnection, request: bytes) -> bool: # pylint: disable=too-many-branches + def __process_request(self, conn: BasePhyConnection, req: bytes) -> bool: # pylint: disable=too-many-branches logger = get_logger() error_messages: list[str] = [] live_log_errors = False @@ -384,47 +387,47 @@ class BaseMcuHid(BaseHid, multiprocessing.Process): # pylint: disable=too-many- error_retval = False while self.__gpio.is_powered() and common_retries and read_retries: - response = (RESPONSE_LEGACY_OK if self.__noop else conn.send(request)) + resp = (RESPONSE_LEGACY_OK if self.__noop else conn.send(req)) try: - if len(response) < 4: + if len(resp) < 4: read_retries -= 1 - raise _TempRequestError(f"No response from HID: request={request!r}") + raise _TempRequestError(f"No response from HID: request={req!r}") - if not check_response(response): - request = REQUEST_REPEAT + if not check_response(resp): + req = REQUEST_REPEAT raise _TempRequestError("Invalid response CRC; requesting response again ...") - code = response[1] + code = resp[1] if code == 0x48: # Request timeout # pylint: disable=no-else-raise - raise _TempRequestError(f"Got request timeout from HID: request={request!r}") + raise _TempRequestError(f"Got request timeout from HID: request={req!r}") elif code == 0x40: # CRC Error - raise _TempRequestError(f"Got CRC error of request from HID: request={request!r}") + raise _TempRequestError(f"Got CRC error of request from HID: request={req!r}") elif code == 0x45: # Unknown command - raise _PermRequestError(f"HID did not recognize the request={request!r}") + raise _PermRequestError(f"HID did not recognize the request={req!r}") elif code == 0x24: # Rebooted? raise _PermRequestError("No previous command state inside HID, seems it was rebooted") elif code == 0x20: # Legacy done self.__set_state_online(True) return True elif code & 0x80: # Pong/Done with state - self.__set_state_pong(response) + self.__set_state_pong(resp) return True - raise _TempRequestError(f"Invalid response from HID: request={request!r}, response=0x{response!r}") + raise _TempRequestError(f"Invalid response from HID: request={req!r}, response=0x{resp!r}") - except _RequestError as err: + except _RequestError as ex: common_retries -= 1 if live_log_errors: - logger.error(err.msg) + logger.error(ex.msg) else: - error_messages.append(err.msg) + error_messages.append(ex.msg) if len(error_messages) > self.__errors_threshold: for msg in error_messages: logger.error(msg) error_messages = [] live_log_errors = True - if isinstance(err, _PermRequestError): + if isinstance(ex, _PermRequestError): error_retval = True break @@ -440,7 +443,7 @@ class BaseMcuHid(BaseHid, multiprocessing.Process): # pylint: disable=too-many- for msg in error_messages: logger.error(msg) if not (common_retries and read_retries): - logger.error("Can't process HID request due many errors: %r", request) + logger.error("Can't process HID request due many errors: %r", req) return error_retval def __set_state_online(self, online: bool) -> None: @@ -449,11 +452,11 @@ class BaseMcuHid(BaseHid, multiprocessing.Process): # pylint: disable=too-many- def __set_state_busy(self, busy: bool) -> None: self.__state_flags.update(busy=int(busy)) - def __set_state_pong(self, response: bytes) -> None: - status = response[1] << 16 - if len(response) > 4: - status |= (response[2] << 8) | response[3] - reset_required = (1 if response[1] & 0b01000000 else 0) + def __set_state_pong(self, resp: bytes) -> None: + status = resp[1] << 16 + if len(resp) > 4: + status |= (resp[2] << 8) | resp[3] + reset_required = (1 if resp[1] & 0b01000000 else 0) self.__state_flags.update(online=1, busy=reset_required, status=status) if reset_required: if self.__reset_self: diff --git a/kvmd/plugins/hid/_mcu/gpio.py b/kvmd/plugins/hid/_mcu/gpio.py index 0afbcc69..ce1d678b 100644 --- a/kvmd/plugins/hid/_mcu/gpio.py +++ b/kvmd/plugins/hid/_mcu/gpio.py @@ -47,12 +47,12 @@ class Gpio: # pylint: disable=too-many-instance-attributes self.__reset_inverted = reset_inverted self.__reset_delay = reset_delay - self.__line_request: (gpiod.LineRequest | None) = None + self.__line_req: (gpiod.LineRequest | None) = None self.__last_power: (bool | None) = None def __enter__(self) -> None: if self.__power_detect_pin >= 0 or self.__reset_pin >= 0: - assert self.__line_request is None + assert self.__line_req is None config: dict[int, gpiod.LineSettings] = {} if self.__power_detect_pin >= 0: config[self.__power_detect_pin] = gpiod.LineSettings( @@ -65,7 +65,7 @@ class Gpio: # pylint: disable=too-many-instance-attributes output_value=gpiod.line.Value(self.__reset_inverted), ) assert len(config) > 0 - self.__line_request = gpiod.request_lines( + self.__line_req = gpiod.request_lines( self.__device_path, consumer="kvmd::hid", config=config, @@ -78,18 +78,18 @@ class Gpio: # pylint: disable=too-many-instance-attributes _tb: types.TracebackType, ) -> None: - if self.__line_request: + if self.__line_req: try: - self.__line_request.release() + self.__line_req.release() except Exception: pass self.__last_power = None - self.__line_request = None + self.__line_req = None def is_powered(self) -> bool: if self.__power_detect_pin >= 0: - assert self.__line_request - power = bool(self.__line_request.get_value(self.__power_detect_pin).value) + assert self.__line_req + power = bool(self.__line_req.get_value(self.__power_detect_pin).value) if power != self.__last_power: get_logger(0).info("HID power state changed: %s -> %s", self.__last_power, power) self.__last_power = power @@ -98,11 +98,11 @@ class Gpio: # pylint: disable=too-many-instance-attributes def reset(self) -> None: if self.__reset_pin >= 0: - assert self.__line_request + assert self.__line_req try: - self.__line_request.set_value(self.__reset_pin, gpiod.line.Value(not self.__reset_inverted)) + self.__line_req.set_value(self.__reset_pin, gpiod.line.Value(not self.__reset_inverted)) time.sleep(self.__reset_delay) finally: - self.__line_request.set_value(self.__reset_pin, gpiod.line.Value(self.__reset_inverted)) + self.__line_req.set_value(self.__reset_pin, gpiod.line.Value(self.__reset_inverted)) time.sleep(1) get_logger(0).info("Reset HID performed") diff --git a/kvmd/plugins/hid/_mcu/proto.py b/kvmd/plugins/hid/_mcu/proto.py index 76cd5d09..deaf5c15 100644 --- a/kvmd/plugins/hid/_mcu/proto.py +++ b/kvmd/plugins/hid/_mcu/proto.py @@ -184,17 +184,17 @@ class MouseWheelEvent(BaseEvent): # ===== -def check_response(response: bytes) -> bool: - assert len(response) in (4, 8), response - return (bitbang.make_crc16(response[:-2]) == struct.unpack(">H", response[-2:])[0]) +def check_response(resp: bytes) -> bool: + assert len(resp) in (4, 8), resp + return (bitbang.make_crc16(resp[:-2]) == struct.unpack(">H", resp[-2:])[0]) -def _make_request(command: bytes) -> bytes: - assert len(command) == 5, command - request = b"\x33" + command - request += struct.pack(">H", bitbang.make_crc16(request)) - assert len(request) == 8, request - return request +def _make_request(cmd: bytes) -> bytes: + assert len(cmd) == 5, cmd + req = b"\x33" + cmd + req += struct.pack(">H", bitbang.make_crc16(req)) + assert len(req) == 8, req + return req # ===== diff --git a/kvmd/plugins/hid/bt/__init__.py b/kvmd/plugins/hid/bt/__init__.py index ece6b59b..0c95a6d5 100644 --- a/kvmd/plugins/hid/bt/__init__.py +++ b/kvmd/plugins/hid/bt/__init__.py @@ -21,9 +21,9 @@ import multiprocessing +import copy import time -from typing import Iterable from typing import AsyncGenerator from typing import Any @@ -63,6 +63,11 @@ class Plugin(BaseHid): # pylint: disable=too-many-instance-attributes def __init__( # pylint: disable=too-many-arguments,too-many-locals self, + ignore_keys: list[str], + mouse_x_range: dict[str, Any], + mouse_y_range: dict[str, Any], + jiggler: dict[str, Any], + manufacturer: str, product: str, description: str, @@ -78,11 +83,9 @@ class Plugin(BaseHid): # pylint: disable=too-many-instance-attributes max_clients: int, socket_timeout: float, select_timeout: float, - - jiggler: dict[str, Any], ) -> None: - super().__init__(**jiggler) + super().__init__(ignore_keys=ignore_keys, **mouse_x_range, **mouse_y_range, **jiggler) self._set_jiggler_absolute(False) self.__proc: (multiprocessing.Process | None) = None @@ -126,7 +129,7 @@ class Plugin(BaseHid): # pylint: disable=too-many-instance-attributes "socket_timeout": Option(5.0, type=valid_float_f01), "select_timeout": Option(1.0, type=valid_float_f01), - **cls._get_jiggler_options(), + **cls._get_base_options(), } def sysprep(self) -> None: @@ -138,6 +141,7 @@ class Plugin(BaseHid): # pylint: disable=too-many-instance-attributes state = await self.__server.get_state() outputs: dict = {"available": [], "active": ""} return { + "enabled": True, "online": True, "busy": False, "connected": None, @@ -158,14 +162,18 @@ class Plugin(BaseHid): # pylint: disable=too-many-instance-attributes **self._get_jiggler_state(), } + async def trigger_state(self) -> None: + self.__notifier.notify(1) + async def poll_state(self) -> AsyncGenerator[dict, None]: - prev_state: dict = {} + prev: dict = {} while True: - state = await self.get_state() - if state != prev_state: - yield state - prev_state = state - await self.__notifier.wait() + if (await self.__notifier.wait()) > 0: + prev = {} + new = await self.get_state() + if new != prev: + prev = copy.deepcopy(new) + yield new async def reset(self) -> None: self.clear_events() @@ -182,27 +190,6 @@ class Plugin(BaseHid): # pylint: disable=too-many-instance-attributes # ===== - def send_key_events(self, keys: Iterable[tuple[str, bool]]) -> None: - for (key, state) in keys: - self.__server.queue_event(make_keyboard_event(key, state)) - self._bump_activity() - - def send_mouse_button_event(self, button: str, state: bool) -> None: - self.__server.queue_event(MouseButtonEvent(button, state)) - self._bump_activity() - - def send_mouse_relative_event(self, delta_x: int, delta_y: int) -> None: - self.__server.queue_event(MouseRelativeEvent(delta_x, delta_y)) - self._bump_activity() - - def send_mouse_wheel_event(self, delta_x: int, delta_y: int) -> None: - self.__server.queue_event(MouseWheelEvent(delta_x, delta_y)) - self._bump_activity() - - def clear_events(self) -> None: - self.__server.clear_events() - self._bump_activity() - def set_params( self, keyboard_output: (str | None)=None, @@ -216,6 +203,21 @@ class Plugin(BaseHid): # pylint: disable=too-many-instance-attributes self._set_jiggler_active(jiggler) self.__notifier.notify() + def _send_key_event(self, key: str, state: bool) -> None: + self.__server.queue_event(make_keyboard_event(key, state)) + + def _send_mouse_button_event(self, button: str, state: bool) -> None: + self.__server.queue_event(MouseButtonEvent(button, state)) + + def _send_mouse_relative_event(self, delta_x: int, delta_y: int) -> None: + self.__server.queue_event(MouseRelativeEvent(delta_x, delta_y)) + + def _send_mouse_wheel_event(self, delta_x: int, delta_y: int) -> None: + self.__server.queue_event(MouseWheelEvent(delta_x, delta_y)) + + def _clear_events(self) -> None: + self.__server.clear_events() + # ===== def __server_worker(self) -> None: # pylint: disable=too-many-branches diff --git a/kvmd/plugins/hid/bt/server.py b/kvmd/plugins/hid/bt/server.py index 2b6a4307..ad2b6982 100644 --- a/kvmd/plugins/hid/bt/server.py +++ b/kvmd/plugins/hid/bt/server.py @@ -182,8 +182,8 @@ class BtServer: # pylint: disable=too-many-instance-attributes self.__close_client("CTL", client, "ctl_sock") elif data == b"\x71": sock.send(b"\x00") - except Exception as err: - get_logger(0).exception("CTL socket error on %s: %s", client.addr, tools.efmt(err)) + except Exception as ex: + get_logger(0).exception("CTL socket error on %s: %s", client.addr, tools.efmt(ex)) self.__close_client("CTL", client, "ctl_sock") continue @@ -196,8 +196,8 @@ class BtServer: # pylint: disable=too-many-instance-attributes self.__close_client("INT", client, "int_sock") elif data[:2] == b"\xA2\x01": self.__process_leds(data[2]) - except Exception as err: - get_logger(0).exception("INT socket error on %s: %s", client.addr, tools.efmt(err)) + except Exception as ex: + get_logger(0).exception("INT socket error on %s: %s", client.addr, tools.efmt(ex)) self.__close_client("INT", client, "ctl_sock") if qr in ready_read: @@ -279,8 +279,8 @@ class BtServer: # pylint: disable=too-many-instance-attributes assert client.int_sock is not None try: client.int_sock.send(report) - except Exception as err: - get_logger(0).info("Can't send %s report to %s: %s", name, client.addr, tools.efmt(err)) + except Exception as ex: + get_logger(0).info("Can't send %s report to %s: %s", name, client.addr, tools.efmt(ex)) self.__close_client_pair(client) def __clear_modifiers(self) -> None: @@ -371,13 +371,13 @@ class BtServer: # pylint: disable=too-many-instance-attributes logger.info("Publishing ..." if public else "Unpublishing ...") try: self.__iface.set_public(public) - except Exception as err: - logger.error("Can't change public mode: %s", tools.efmt(err)) + except Exception as ex: + logger.error("Can't change public mode: %s", tools.efmt(ex)) def __unpair_client(self, client: _BtClient) -> None: logger = get_logger(0) logger.info("Unpairing %s ...", client.addr) try: self.__iface.unpair(client.addr) - except Exception as err: - logger.error("Can't unpair %s: %s", client.addr, tools.efmt(err)) + except Exception as ex: + logger.error("Can't unpair %s: %s", client.addr, tools.efmt(ex)) diff --git a/kvmd/plugins/hid/ch9329/__init__.py b/kvmd/plugins/hid/ch9329/__init__.py index 4e2be8c9..1b235090 100644 --- a/kvmd/plugins/hid/ch9329/__init__.py +++ b/kvmd/plugins/hid/ch9329/__init__.py @@ -22,9 +22,9 @@ import multiprocessing import queue +import copy import time -from typing import Iterable from typing import AsyncGenerator from typing import Any @@ -54,13 +54,17 @@ from .keyboard import Keyboard class Plugin(BaseHid, multiprocessing.Process): # pylint: disable=too-many-instance-attributes def __init__( # pylint: disable=too-many-arguments,super-init-not-called self, + ignore_keys: list[str], + mouse_x_range: dict[str, Any], + mouse_y_range: dict[str, Any], + jiggler: dict[str, Any], + device_path: str, speed: int, read_timeout: float, - jiggler: dict[str, Any], ) -> None: - BaseHid.__init__(self, **jiggler) + BaseHid.__init__(self, ignore_keys=ignore_keys, **mouse_x_range, **mouse_y_range, **jiggler) multiprocessing.Process.__init__(self, daemon=True) self.__device_path = device_path @@ -88,7 +92,7 @@ class Plugin(BaseHid, multiprocessing.Process): # pylint: disable=too-many-inst "device": Option("/dev/kvmd-hid", type=valid_abs_path, unpack_as="device_path"), "speed": Option(9600, type=valid_tty_speed), "read_timeout": Option(0.3, type=valid_float_f01), - **cls._get_jiggler_options(), + **cls._get_base_options(), } def sysprep(self) -> None: @@ -100,6 +104,7 @@ class Plugin(BaseHid, multiprocessing.Process): # pylint: disable=too-many-inst absolute = self.__mouse.is_absolute() leds = await self.__keyboard.get_leds() return { + "enabled": True, "online": state["online"], "busy": False, "connected": None, @@ -119,14 +124,18 @@ class Plugin(BaseHid, multiprocessing.Process): # pylint: disable=too-many-inst **self._get_jiggler_state(), } + async def trigger_state(self) -> None: + self.__notifier.notify(1) + async def poll_state(self) -> AsyncGenerator[dict, None]: - prev_state: dict = {} + prev: dict = {} while True: - state = await self.get_state() - if state != prev_state: - yield state - prev_state = state - await self.__notifier.wait() + if (await self.__notifier.wait()) > 0: + prev = {} + new = await self.get_state() + if new != prev: + prev = copy.deepcopy(new) + yield new async def reset(self) -> None: self.__reset_required_event.set() @@ -141,27 +150,6 @@ class Plugin(BaseHid, multiprocessing.Process): # pylint: disable=too-many-inst # ===== - def send_key_events(self, keys: Iterable[tuple[str, bool]]) -> None: - for (key, state) in keys: - self.__queue_cmd(self.__keyboard.process_key(key, state)) - self._bump_activity() - - def send_mouse_button_event(self, button: str, state: bool) -> None: - self.__queue_cmd(self.__mouse.process_button(button, state)) - self._bump_activity() - - def send_mouse_move_event(self, to_x: int, to_y: int) -> None: - self.__queue_cmd(self.__mouse.process_move(to_x, to_y)) - self._bump_activity() - - def send_mouse_wheel_event(self, delta_x: int, delta_y: int) -> None: - self.__queue_cmd(self.__mouse.process_wheel(delta_x, delta_y)) - self._bump_activity() - - def send_mouse_relative_event(self, delta_x: int, delta_y: int) -> None: - self.__queue_cmd(self.__mouse.process_relative(delta_x, delta_y)) - self._bump_activity() - def set_params( self, keyboard_output: (str | None)=None, @@ -180,10 +168,22 @@ class Plugin(BaseHid, multiprocessing.Process): # pylint: disable=too-many-inst self._set_jiggler_active(jiggler) self.__notifier.notify() - def set_connected(self, connected: bool) -> None: - pass + def _send_key_event(self, key: str, state: bool) -> None: + self.__queue_cmd(self.__keyboard.process_key(key, state)) - def clear_events(self) -> None: + def _send_mouse_button_event(self, button: str, state: bool) -> None: + self.__queue_cmd(self.__mouse.process_button(button, state)) + + def _send_mouse_move_event(self, to_x: int, to_y: int) -> None: + self.__queue_cmd(self.__mouse.process_move(to_x, to_y)) + + def _send_mouse_wheel_event(self, delta_x: int, delta_y: int) -> None: + self.__queue_cmd(self.__mouse.process_wheel(delta_x, delta_y)) + + def _send_mouse_relative_event(self, delta_x: int, delta_y: int) -> None: + self.__queue_cmd(self.__mouse.process_relative(delta_x, delta_y)) + + def _clear_events(self) -> None: tools.clear_queue(self.__cmd_queue) def __queue_cmd(self, cmd: bytes, clear: bool=False) -> None: @@ -230,9 +230,9 @@ class Plugin(BaseHid, multiprocessing.Process): # pylint: disable=too-many-inst def __process_cmd(self, conn: ChipConnection, cmd: bytes) -> bool: # pylint: disable=too-many-branches try: led_byte = conn.xfer(cmd) - except ChipResponseError as err: + except ChipResponseError as ex: self.__set_state_online(False) - get_logger(0).info(err) + get_logger(0).error("Invalid chip response: %s", tools.efmt(ex)) time.sleep(2) else: if led_byte >= 0: diff --git a/kvmd/plugins/hid/otg/__init__.py b/kvmd/plugins/hid/otg/__init__.py index 3516546d..25424257 100644 --- a/kvmd/plugins/hid/otg/__init__.py +++ b/kvmd/plugins/hid/otg/__init__.py @@ -20,7 +20,8 @@ # ========================================================================== # -from typing import Iterable +import copy + from typing import AsyncGenerator from typing import Any @@ -46,15 +47,20 @@ from .mouse import MouseProcess class Plugin(BaseHid): # pylint: disable=too-many-instance-attributes def __init__( self, + ignore_keys: list[str], + mouse_x_range: dict[str, Any], + mouse_y_range: dict[str, Any], + jiggler: dict[str, Any], + keyboard: dict[str, Any], mouse: dict[str, Any], mouse_alt: dict[str, Any], - jiggler: dict[str, Any], noop: bool, + udc: str, # XXX: Not from options, see /kvmd/apps/kvmd/__init__.py for details ) -> None: - super().__init__(**jiggler) + super().__init__(ignore_keys=ignore_keys, **mouse_x_range, **mouse_y_range, **jiggler) self.__udc = udc @@ -113,7 +119,7 @@ class Plugin(BaseHid): # pylint: disable=too-many-instance-attributes "horizontal_wheel": Option(True, type=valid_bool), }, "noop": Option(False, type=valid_bool), - **cls._get_jiggler_options(), + **cls._get_base_options(), } def sysprep(self) -> None: @@ -128,6 +134,7 @@ class Plugin(BaseHid): # pylint: disable=too-many-instance-attributes keyboard_state = await self.__keyboard_proc.get_state() mouse_state = await self.__mouse_current.get_state() return { + "enabled": True, "online": True, "busy": False, "connected": None, @@ -150,14 +157,18 @@ class Plugin(BaseHid): # pylint: disable=too-many-instance-attributes **self._get_jiggler_state(), } + async def trigger_state(self) -> None: + self.__notifier.notify(1) + async def poll_state(self) -> AsyncGenerator[dict, None]: - prev_state: dict = {} + prev: dict = {} while True: - state = await self.get_state() - if state != prev_state: - yield state - prev_state = state - await self.__notifier.wait() + if (await self.__notifier.wait()) > 0: + prev = {} + new = await self.get_state() + if new != prev: + prev = copy.deepcopy(new) + yield new async def reset(self) -> None: self.__keyboard_proc.send_reset_event() @@ -177,26 +188,6 @@ class Plugin(BaseHid): # pylint: disable=too-many-instance-attributes # ===== - def send_key_events(self, keys: Iterable[tuple[str, bool]]) -> None: - self.__keyboard_proc.send_key_events(keys) - self._bump_activity() - - def send_mouse_button_event(self, button: str, state: bool) -> None: - self.__mouse_current.send_button_event(button, state) - self._bump_activity() - - def send_mouse_move_event(self, to_x: int, to_y: int) -> None: - self.__mouse_current.send_move_event(to_x, to_y) - self._bump_activity() - - def send_mouse_relative_event(self, delta_x: int, delta_y: int) -> None: - self.__mouse_current.send_relative_event(delta_x, delta_y) - self._bump_activity() - - def send_mouse_wheel_event(self, delta_x: int, delta_y: int) -> None: - self.__mouse_current.send_wheel_event(delta_x, delta_y) - self._bump_activity() - def set_params( self, keyboard_output: (str | None)=None, @@ -215,12 +206,26 @@ class Plugin(BaseHid): # pylint: disable=too-many-instance-attributes self._set_jiggler_active(jiggler) self.__notifier.notify() - def clear_events(self) -> None: + def _send_key_event(self, key: str, state: bool) -> None: + self.__keyboard_proc.send_key_event(key, state) + + def _send_mouse_button_event(self, button: str, state: bool) -> None: + self.__mouse_current.send_button_event(button, state) + + def _send_mouse_move_event(self, to_x: int, to_y: int) -> None: + self.__mouse_current.send_move_event(to_x, to_y) + + def _send_mouse_relative_event(self, delta_x: int, delta_y: int) -> None: + self.__mouse_current.send_relative_event(delta_x, delta_y) + + def _send_mouse_wheel_event(self, delta_x: int, delta_y: int) -> None: + self.__mouse_current.send_wheel_event(delta_x, delta_y) + + def _clear_events(self) -> None: self.__keyboard_proc.send_clear_event() self.__mouse_proc.send_clear_event() if self.__mouse_alt_proc: self.__mouse_alt_proc.send_clear_event() - self._bump_activity() # ===== diff --git a/kvmd/plugins/hid/otg/device.py b/kvmd/plugins/hid/otg/device.py index dfab658d..a3bc2739 100644 --- a/kvmd/plugins/hid/otg/device.py +++ b/kvmd/plugins/hid/otg/device.py @@ -192,13 +192,13 @@ class BaseDeviceProcess(multiprocessing.Process): # pylint: disable=too-many-in else: logger.error("HID-%s write() error: written (%s) != report length (%d)", self.__name, written, len(report)) - except Exception as err: - if isinstance(err, OSError) and ( + except Exception as ex: + if isinstance(ex, OSError) and ( # https://github.com/raspberrypi/linux/commit/61b7f805dc2fd364e0df682de89227e94ce88e25 - err.errno == errno.EAGAIN # pylint: disable=no-member - or err.errno == errno.ESHUTDOWN # pylint: disable=no-member + ex.errno == errno.EAGAIN # pylint: disable=no-member + or ex.errno == errno.ESHUTDOWN # pylint: disable=no-member ): - logger.debug("HID-%s busy/unplugged (write): %s", self.__name, tools.efmt(err)) + logger.debug("HID-%s busy/unplugged (write): %s", self.__name, tools.efmt(ex)) else: logger.exception("Can't write report to HID-%s", self.__name) @@ -216,16 +216,16 @@ class BaseDeviceProcess(multiprocessing.Process): # pylint: disable=too-many-in while read: try: read = bool(select.select([self.__fd], [], [], 0)[0]) - except Exception as err: - logger.error("Can't select() for read HID-%s: %s", self.__name, tools.efmt(err)) + except Exception as ex: + logger.error("Can't select() for read HID-%s: %s", self.__name, tools.efmt(ex)) break if read: try: report = os.read(self.__fd, self.__read_size) - except Exception as err: - if isinstance(err, OSError) and err.errno == errno.EAGAIN: # pylint: disable=no-member - logger.debug("HID-%s busy/unplugged (read): %s", self.__name, tools.efmt(err)) + except Exception as ex: + if isinstance(ex, OSError) and ex.errno == errno.EAGAIN: # pylint: disable=no-member + logger.debug("HID-%s busy/unplugged (read): %s", self.__name, tools.efmt(ex)) else: logger.exception("Can't read report from HID-%s", self.__name) else: @@ -255,9 +255,9 @@ class BaseDeviceProcess(multiprocessing.Process): # pylint: disable=too-many-in flags = os.O_NONBLOCK flags |= (os.O_RDWR if self.__read_size else os.O_WRONLY) self.__fd = os.open(self.__device_path, flags) - except Exception as err: + except Exception as ex: logger.error("Can't open HID-%s device %s: %s", - self.__name, self.__device_path, tools.efmt(err)) + self.__name, self.__device_path, tools.efmt(ex)) if self.__fd >= 0: try: @@ -268,8 +268,8 @@ class BaseDeviceProcess(multiprocessing.Process): # pylint: disable=too-many-in else: # Если запись недоступна, то скорее всего устройство отключено logger.debug("HID-%s is busy/unplugged (write select)", self.__name) - except Exception as err: - logger.error("Can't select() for write HID-%s: %s", self.__name, tools.efmt(err)) + except Exception as ex: + logger.error("Can't select() for write HID-%s: %s", self.__name, tools.efmt(ex)) self.__state_flags.update(online=False) return False diff --git a/kvmd/plugins/hid/otg/keyboard.py b/kvmd/plugins/hid/otg/keyboard.py index 9008db06..e82d95a3 100644 --- a/kvmd/plugins/hid/otg/keyboard.py +++ b/kvmd/plugins/hid/otg/keyboard.py @@ -20,7 +20,6 @@ # ========================================================================== # -from typing import Iterable from typing import Generator from typing import Any @@ -68,9 +67,8 @@ class KeyboardProcess(BaseDeviceProcess): self._clear_queue() self._queue_event(ResetEvent()) - def send_key_events(self, keys: Iterable[tuple[str, bool]]) -> None: - for (key, state) in keys: - self._queue_event(make_keyboard_event(key, state)) + def send_key_event(self, key: str, state: bool) -> None: + self._queue_event(make_keyboard_event(key, state)) # ===== diff --git a/kvmd/plugins/hid/serial.py b/kvmd/plugins/hid/serial.py index 4b8e6165..040828b4 100644 --- a/kvmd/plugins/hid/serial.py +++ b/kvmd/plugins/hid/serial.py @@ -44,12 +44,12 @@ class _SerialPhyConnection(BasePhyConnection): def __init__(self, tty: serial.Serial) -> None: self.__tty = tty - def send(self, request: bytes) -> bytes: - assert len(request) == 8 - assert request[0] == 0x33 + def send(self, req: bytes) -> bytes: + assert len(req) == 8 + assert req[0] == 0x33 if self.__tty.in_waiting: self.__tty.read_all() - assert self.__tty.write(request) == 8 + assert self.__tty.write(req) == 8 data = self.__tty.read(4) if len(data) == 4: if data[0] == 0x34: # New response protocol diff --git a/kvmd/plugins/hid/spi.py b/kvmd/plugins/hid/spi.py index dadcc77e..cf58b5de 100644 --- a/kvmd/plugins/hid/spi.py +++ b/kvmd/plugins/hid/spi.py @@ -57,9 +57,9 @@ class _SpiPhyConnection(BasePhyConnection): self.__xfer = xfer self.__read_timeout = read_timeout - def send(self, request: bytes) -> bytes: - assert len(request) == 8 - assert request[0] == 0x33 + def send(self, req: bytes) -> bytes: + assert len(req) == 8 + assert req[0] == 0x33 deadline_ts = time.monotonic() + self.__read_timeout dummy = b"\x00" * 10 @@ -70,26 +70,26 @@ class _SpiPhyConnection(BasePhyConnection): get_logger(0).error("SPI timeout reached while garbage reading") return b"" - self.__xfer(request) + self.__xfer(req) - response: list[int] = [] + resp: list[int] = [] deadline_ts = time.monotonic() + self.__read_timeout found = False while time.monotonic() < deadline_ts: - for byte in self.__xfer(b"\x00" * (9 - len(response))): + for byte in self.__xfer(b"\x00" * (9 - len(resp))): if not found: if byte == 0: continue found = True - response.append(byte) - if len(response) == 8: + resp.append(byte) + if len(resp) == 8: break - if len(response) == 8: + if len(resp) == 8: break else: get_logger(0).error("SPI timeout reached while responce waiting") return b"" - return bytes(response) + return bytes(resp) class _SpiPhy(BasePhy): # pylint: disable=too-many-instance-attributes diff --git a/kvmd/plugins/msd/__init__.py b/kvmd/plugins/msd/__init__.py index e0210921..b2f9d50e 100644 --- a/kvmd/plugins/msd/__init__.py +++ b/kvmd/plugins/msd/__init__.py @@ -117,7 +117,22 @@ class BaseMsd(BasePlugin): async def get_state(self) -> dict: raise NotImplementedError() + async def trigger_state(self) -> None: + raise NotImplementedError() + async def poll_state(self) -> AsyncGenerator[dict, None]: + # ==== Granularity table ==== + # - enabled -- Full + # - online -- Partial + # - busy -- Partial + # - drive -- Partial, nullable + # - storage -- Partial, nullable + # - storage.parts -- Partial + # - storage.images -- Partial + # - storage.downloading -- Partial, nullable + # - storage.uploading -- Partial, nullable + # =========================== + if self is not None: # XXX: Vulture and pylint hack raise NotImplementedError() yield @@ -263,16 +278,18 @@ class MsdFileWriter(BaseMsdWriter): # pylint: disable=too-many-instance-attribu return self.__written - def is_complete(self) -> bool: - return (self.__written >= self.__file_size) - async def open(self) -> "MsdFileWriter": assert self.__file is None get_logger(1).info("Writing %r image (%d bytes) to MSD ...", self.__name, self.__file_size) await aiofiles.os.makedirs(os.path.dirname(self.__path), exist_ok=True) self.__file = await aiofiles.open(self.__path, mode="w+b", buffering=0) # type: ignore + await aiotools.run_async(os.ftruncate, self.__file.fileno(), self.__file_size) # type: ignore return self + async def finish(self) -> bool: + await self.__sync() + return (self.__written >= self.__file_size) + async def close(self) -> None: assert self.__file is not None logger = get_logger() @@ -285,10 +302,7 @@ class MsdFileWriter(BaseMsdWriter): # pylint: disable=too-many-instance-attribu else: # written > size (log, result) = (logger.warning, "OVERFLOW") log("Written %d of %d bytes to MSD image %r: %s", self.__written, self.__file_size, self.__name, result) - try: - await self.__sync() - finally: - await self.__file.close() # type: ignore + await self.__file.close() # type: ignore except Exception: logger.exception("Can't close image writer") diff --git a/kvmd/plugins/msd/disabled.py b/kvmd/plugins/msd/disabled.py index ad49875e..b9f14f6e 100644 --- a/kvmd/plugins/msd/disabled.py +++ b/kvmd/plugins/msd/disabled.py @@ -40,6 +40,9 @@ class MsdDisabledError(MsdOperationError): # ===== class Plugin(BaseMsd): + def __init__(self) -> None: + self.__notifier = aiotools.AioNotifier() + async def get_state(self) -> dict: return { "enabled": False, @@ -49,10 +52,13 @@ class Plugin(BaseMsd): "drive": None, } + async def trigger_state(self) -> None: + self.__notifier.notify() + async def poll_state(self) -> AsyncGenerator[dict, None]: while True: + await self.__notifier.wait() yield (await self.get_state()) - await aiotools.wait_infinite() async def reset(self) -> None: raise MsdDisabledError() diff --git a/kvmd/plugins/msd/otg/__init__.py b/kvmd/plugins/msd/otg/__init__.py index d88e7bc7..92eac741 100644 --- a/kvmd/plugins/msd/otg/__init__.py +++ b/kvmd/plugins/msd/otg/__init__.py @@ -26,12 +26,12 @@ import dataclasses import functools import time import os +import copy from typing import AsyncGenerator from ....logging import get_logger -from ....inotify import InotifyMask from ....inotify import Inotify from ....yamlconf import Option @@ -97,15 +97,17 @@ class _State: @contextlib.asynccontextmanager async def busy(self, check_online: bool=True) -> AsyncGenerator[None, None]: - async with self._region: - async with self._lock: - self.__notifier.notify() - if check_online: - if self.vd is None: - raise MsdOfflineError() - assert self.storage - yield - self.__notifier.notify() + try: + with self._region: + async with self._lock: + self.__notifier.notify() + if check_online: + if self.vd is None: + raise MsdOfflineError() + assert self.storage + yield + finally: + self.__notifier.notify() def is_busy(self) -> bool: return self._region.is_busy() @@ -141,10 +143,11 @@ class Plugin(BaseMsd): # pylint: disable=too-many-instance-attributes self.__notifier = aiotools.AioNotifier() self.__state = _State(self.__notifier) + self.__reset = False logger = get_logger(0) logger.info("Using OTG gadget %r as MSD", gadget) - aiotools.run_sync(self.__reload_state(notify=False)) + aiotools.run_sync(self.__unsafe_reload_state()) @classmethod def get_plugin_options(cls) -> dict: @@ -164,14 +167,13 @@ class Plugin(BaseMsd): # pylint: disable=too-many-instance-attributes }, } + # ===== + async def get_state(self) -> dict: async with self.__state._lock: # pylint: disable=protected-access storage: (dict | None) = None if self.__state.storage: - if self.__writer: - # При загрузке файла показываем актуальную статистику вручную - await self.__storage.reload_parts_info() - + assert self.__state.vd storage = dataclasses.asdict(self.__state.storage) for name in list(storage["images"]): del storage["images"][name]["name"] @@ -185,34 +187,50 @@ class Plugin(BaseMsd): # pylint: disable=too-many-instance-attributes vd: (dict | None) = None if self.__state.vd: + assert self.__state.storage vd = dataclasses.asdict(self.__state.vd) if vd["image"]: del vd["image"]["path"] return { "enabled": True, - "online": (bool(self.__state.vd) and self.__drive.is_enabled()), + "online": (bool(vd) and self.__drive.is_enabled()), "busy": self.__state.is_busy(), "storage": storage, "drive": vd, } - async def poll_state(self) -> AsyncGenerator[dict, None]: - prev_state: dict = {} - while True: - state = await self.get_state() - if state != prev_state: - yield state - prev_state = state - await self.__notifier.wait() + async def trigger_state(self) -> None: + self.__notifier.notify(1) - async def systask(self) -> None: - await self.__watch_inotify() + async def poll_state(self) -> AsyncGenerator[dict, None]: + prev: dict = {} + while True: + if (await self.__notifier.wait()) > 0: + prev = {} + new = await self.get_state() + if not prev or (prev.get("online") != new["online"]): + prev = copy.deepcopy(new) + yield new + else: + diff: dict = {} + for sub in ["busy", "drive"]: + if prev.get(sub) != new[sub]: + diff[sub] = new[sub] + for sub in ["images", "parts", "downloading", "uploading"]: + if (prev.get("storage") or {}).get(sub) != (new["storage"] or {}).get(sub): + if "storage" not in diff: + diff["storage"] = {} + diff["storage"][sub] = new["storage"][sub] + if diff: + prev = copy.deepcopy(new) + yield diff @aiotools.atomic_fg async def reset(self) -> None: async with self.__state.busy(check_online=False): try: + self.__reset = True self.__drive.set_image_path("") self.__drive.set_cdrom_flag(False) self.__drive.set_rw_flag(False) @@ -220,11 +238,6 @@ class Plugin(BaseMsd): # pylint: disable=too-many-instance-attributes except Exception: get_logger(0).exception("Can't reset MSD properly") - @aiotools.atomic_fg - async def cleanup(self) -> None: - await self.__close_reader() - await self.__close_writer() - # ===== @aiotools.atomic_fg @@ -296,11 +309,12 @@ class Plugin(BaseMsd): # pylint: disable=too-many-instance-attributes @contextlib.asynccontextmanager async def read_image(self, name: str) -> AsyncGenerator[MsdFileReader, None]: try: - async with self.__state._region: # pylint: disable=protected-access + with self.__state._region: # pylint: disable=protected-access try: async with self.__state._lock: # pylint: disable=protected-access self.__notifier.notify() self.__STATE_check_disconnected() + image = await self.__STATE_get_storage_image(name) self.__reader = await MsdFileReader( notifier=self.__notifier, @@ -308,7 +322,10 @@ class Plugin(BaseMsd): # pylint: disable=too-many-instance-attributes path=image.path, chunk_size=self.__read_chunk_size, ).open() + + self.__notifier.notify() yield self.__reader + finally: await aiotools.shield_fg(self.__close_reader()) finally: @@ -316,18 +333,40 @@ class Plugin(BaseMsd): # pylint: disable=too-many-instance-attributes @contextlib.asynccontextmanager async def write_image(self, name: str, size: int, remove_incomplete: (bool | None)) -> AsyncGenerator[MsdFileWriter, None]: + image: (Image | None) = None + complete = False + + async def finish_writing() -> None: + # Делаем под блокировкой, чтобы эвент айнотифи не был обработан + # до того, как мы не закончим все процедуры. + async with self.__state._lock: # pylint: disable=protected-access + try: + self.__notifier.notify() + finally: + try: + if image: + await image.set_complete(complete) + finally: + try: + if image and remove_incomplete and not complete: + await image.remove(fatal=False) + finally: + try: + await self.__close_writer() + finally: + if image: + await image.remount_rw(False, fatal=False) + try: - async with self.__state._region: # pylint: disable=protected-access - image: (Image | None) = None + with self.__state._region: # pylint: disable=protected-access try: async with self.__state._lock: # pylint: disable=protected-access self.__notifier.notify() self.__STATE_check_disconnected() - image = await self.__STORAGE_create_new_image(name) + image = await self.__STORAGE_create_new_image(name) await image.remount_rw(True) await image.set_complete(False) - self.__writer = await MsdFileWriter( notifier=self.__notifier, name=image.name, @@ -339,22 +378,12 @@ class Plugin(BaseMsd): # pylint: disable=too-many-instance-attributes self.__notifier.notify() yield self.__writer - await image.set_complete(self.__writer.is_complete()) + complete = await self.__writer.finish() finally: - try: - if image and remove_incomplete and self.__writer and not self.__writer.is_complete(): - await image.remove(fatal=False) - finally: - try: - await aiotools.shield_fg(self.__close_writer()) - finally: - if image: - await aiotools.shield_fg(image.remount_rw(False, fatal=False)) + await aiotools.shield_fg(finish_writing()) finally: - # Между закрытием файла и эвентом айнотифи состояние может быть не обновлено, - # так что форсим обновление вручную, чтобы получить актуальное состояние. - await aiotools.shield_fg(self.__reload_state()) + self.__notifier.notify() @aiotools.atomic_fg async def remove(self, name: str) -> None: @@ -404,17 +433,26 @@ class Plugin(BaseMsd): # pylint: disable=too-many-instance-attributes async def __close_reader(self) -> None: if self.__reader: - await self.__reader.close() - self.__reader = None + try: + await self.__reader.close() + finally: + self.__reader = None async def __close_writer(self) -> None: if self.__writer: - await self.__writer.close() - self.__writer = None + try: + await self.__writer.close() + finally: + self.__writer = None # ===== - async def __watch_inotify(self) -> None: + @aiotools.atomic_fg + async def cleanup(self) -> None: + await self.__close_reader() + await self.__close_writer() + + async def systask(self) -> None: logger = get_logger(0) while True: try: @@ -426,19 +464,25 @@ class Plugin(BaseMsd): # pylint: disable=too-many-instance-attributes await asyncio.sleep(5) with Inotify() as inotify: - await inotify.watch(InotifyMask.ALL_MODIFY_EVENTS, *self.__storage.get_watchable_paths()) - await inotify.watch(InotifyMask.ALL_MODIFY_EVENTS, *self.__drive.get_watchable_paths()) + # Из-за гонки между первым релоадом и установкой вотчеров, + # мы можем потерять какие-то каталоги стораджа, но это допустимо, + # так как всегда есть ручной перезапуск. + await inotify.watch_all_changes(*self.__storage.get_watchable_paths()) + await inotify.watch_all_changes(*self.__drive.get_watchable_paths()) - # После установки вотчеров еще раз проверяем стейт, чтобы ничего не потерять + # После установки вотчеров еще раз проверяем стейт, + # чтобы не потерять состояние привода. await self.__reload_state() while self.__state.vd: # Если живы после предыдущей проверки - need_restart = False + need_restart = self.__reset + self.__reset = False need_reload_state = False for event in (await inotify.get_series(timeout=1)): need_reload_state = True - if event.mask & (InotifyMask.DELETE_SELF | InotifyMask.MOVE_SELF | InotifyMask.UNMOUNT | InotifyMask.ISDIR): - # Если выгрузили OTG, изменили каталоги, что-то отмонтировали или делают еще какую-то странную фигню + if event.restart: + # Если выгрузили OTG, изменили каталоги, что-то отмонтировали или делают еще какую-то странную фигню. + # Проверяется маска InotifyMask.ALL_RESTART_EVENTS logger.info("Got a big inotify event: %s; reinitializing MSD ...", event) need_restart = True break @@ -446,56 +490,71 @@ class Plugin(BaseMsd): # pylint: disable=too-many-instance-attributes break if need_reload_state: await self.__reload_state() + elif self.__writer: + # При загрузке файла обновляем статистику раз в секунду (по таймауту). + # Это не нужно при обычном релоаде, потому что там и так проверяются все разделы. + await self.__reload_parts_info() + except Exception: logger.exception("Unexpected MSD watcher error") - time.sleep(1) + await asyncio.sleep(1) - async def __reload_state(self, notify: bool=True) -> None: - logger = get_logger(0) + async def __reload_state(self) -> None: async with self.__state._lock: # pylint: disable=protected-access - try: - path = self.__drive.get_image_path() - drive_state = _DriveState( - image=((await self.__storage.make_image_by_path(path)) if path else None), - cdrom=self.__drive.get_cdrom_flag(), - rw=self.__drive.get_rw_flag(), - ) + await self.__unsafe_reload_state() + self.__notifier.notify() - await self.__storage.reload() + async def __reload_parts_info(self) -> None: + assert self.__writer # Использовать только при записи образа + async with self.__state._lock: # pylint: disable=protected-access + await self.__storage.reload_parts_info() + self.__notifier.notify() - if self.__state.vd is None and drive_state.image is None: - # Если только что включились и образ не подключен - попробовать - # перемонтировать хранилище (и создать images и meta). - logger.info("Probing to remount storage ...") - await self.__storage.remount_rw(True) - await self.__storage.remount_rw(False) - await self.__setup_initial() + # ===== Don't call this directly ==== - except Exception: - logger.exception("Error while reloading MSD state; switching to offline") - self.__state.storage = None - self.__state.vd = None + async def __unsafe_reload_state(self) -> None: + logger = get_logger(0) + try: + path = self.__drive.get_image_path() + drive_state = _DriveState( + image=((await self.__storage.make_image_by_path(path)) if path else None), + cdrom=self.__drive.get_cdrom_flag(), + rw=self.__drive.get_rw_flag(), + ) + await self.__storage.reload() + + if self.__state.vd is None and drive_state.image is None: + # Если только что включились и образ не подключен - попробовать + # перемонтировать хранилище (и создать images и meta). + logger.info("Probing to remount storage ...") + await self.__storage.remount_rw(True) + await self.__storage.remount_rw(False) + await self.__unsafe_setup_initial() + + except Exception: + logger.exception("Error while reloading MSD state; switching to offline") + self.__state.storage = None + self.__state.vd = None + + else: + self.__state.storage = self.__storage + if drive_state.image: + # При подключенном образе виртуальный стейт заменяется реальным + self.__state.vd = _VirtualDriveState.from_drive_state(drive_state) else: - self.__state.storage = self.__storage - if drive_state.image: - # При подключенном образе виртуальный стейт заменяется реальным + if self.__state.vd is None: + # Если раньше MSD был отключен self.__state.vd = _VirtualDriveState.from_drive_state(drive_state) - else: - if self.__state.vd is None: - # Если раньше MSD был отключен - self.__state.vd = _VirtualDriveState.from_drive_state(drive_state) - image = self.__state.vd.image - if image and (not image.in_storage or not (await image.exists())): - # Если только что отключили ручной образ вне хранилища или ранее выбранный образ был удален - self.__state.vd.image = None + image = self.__state.vd.image + if image and (not image.in_storage or not (await image.exists())): + # Если только что отключили ручной образ вне хранилища или ранее выбранный образ был удален + self.__state.vd.image = None - self.__state.vd.connected = False - if notify: - self.__notifier.notify() + self.__state.vd.connected = False - async def __setup_initial(self) -> None: + async def __unsafe_setup_initial(self) -> None: if self.__initial_image: logger = get_logger(0) image = await self.__storage.make_image_by_name(self.__initial_image) diff --git a/kvmd/plugins/msd/otg/drive.py b/kvmd/plugins/msd/otg/drive.py index 1de88f1a..9c2a158e 100644 --- a/kvmd/plugins/msd/otg/drive.py +++ b/kvmd/plugins/msd/otg/drive.py @@ -88,7 +88,7 @@ class Drive: try: with open(os.path.join(self.__lun_path, param), "w") as file: file.write(value + "\n") - except OSError as err: - if err.errno == errno.EBUSY: + except OSError as ex: + if ex.errno == errno.EBUSY: raise MsdDriveLockedError() raise diff --git a/kvmd/plugins/msd/otg/storage.py b/kvmd/plugins/msd/otg/storage.py index 32f52a2d..046f10fa 100644 --- a/kvmd/plugins/msd/otg/storage.py +++ b/kvmd/plugins/msd/otg/storage.py @@ -169,8 +169,6 @@ class _Part(_PartDc): # ===== @dataclasses.dataclass(frozen=True, eq=False) class _StorageDc: - size: int = dataclasses.field(init=False) - free: int = dataclasses.field(init=False) images: dict[str, Image] = dataclasses.field(init=False) parts: dict[str, _Part] = dataclasses.field(init=False) @@ -185,25 +183,15 @@ class Storage(_StorageDc): self.__images: (dict[str, Image] | None) = None self.__parts: (dict[str, _Part] | None) = None - @property - def size(self) -> int: # API Legacy - assert self.__parts is not None - return self.__parts[""].size - - @property - def free(self) -> int: # API Legacy - assert self.__parts is not None - return self.__parts[""].free - @property def images(self) -> dict[str, Image]: assert self.__images is not None - return self.__images + return dict(self.__images) @property def parts(self) -> dict[str, _Part]: assert self.__parts is not None - return self.__parts + return dict(self.__parts) async def reload(self) -> None: self.__watchable_paths = None @@ -222,6 +210,7 @@ class Storage(_StorageDc): part = _Part(name, root_path) await part._reload() # pylint: disable=protected-access parts[name] = part + assert "" in parts, parts self.__watchable_paths = watchable_paths self.__images = images diff --git a/kvmd/plugins/ugpio/anelpwr.py b/kvmd/plugins/ugpio/anelpwr.py index a9cc432b..af83f0a2 100644 --- a/kvmd/plugins/ugpio/anelpwr.py +++ b/kvmd/plugins/ugpio/anelpwr.py @@ -113,13 +113,13 @@ class Plugin(BaseUserGpioDriver): # pylint: disable=too-many-instance-attribute while True: session = self.__ensure_http_session() try: - async with session.get(f"{self.__url}/strg.cfg") as response: - htclient.raise_not_200(response) - parts = (await response.text()).split(";") + async with session.get(f"{self.__url}/strg.cfg") as resp: + htclient.raise_not_200(resp) + parts = (await resp.text()).split(";") for pin in self.__state: self.__state[pin] = (parts[1 + int(pin) * 5] == "1") - except Exception as err: - get_logger().error("Failed ANELPWR bulk GET request: %s", tools.efmt(err)) + except Exception as ex: + get_logger().error("Failed ANELPWR bulk GET request: %s", tools.efmt(ex)) self.__state = dict.fromkeys(self.__state, None) if self.__state != prev_state: self._notifier.notify() @@ -143,10 +143,10 @@ class Plugin(BaseUserGpioDriver): # pylint: disable=too-many-instance-attribute url=f"{self.__url}/ctrl.htm", data=f"F{pin}={int(state)}", headers={"Content-Type": "text/plain"}, - ) as response: - htclient.raise_not_200(response) - except Exception as err: - get_logger().error("Failed ANELPWR POST request to pin %s: %s", pin, tools.efmt(err)) + ) as resp: + htclient.raise_not_200(resp) + except Exception as ex: + get_logger().error("Failed ANELPWR POST request to pin %s: %s", pin, tools.efmt(ex)) raise GpioDriverOfflineError(self) self.__update_notifier.notify() diff --git a/kvmd/plugins/ugpio/cmd.py b/kvmd/plugins/ugpio/cmd.py index c3392b68..b8581ce3 100644 --- a/kvmd/plugins/ugpio/cmd.py +++ b/kvmd/plugins/ugpio/cmd.py @@ -78,9 +78,9 @@ class Plugin(BaseUserGpioDriver): # pylint: disable=too-many-instance-attribute proc = await aioproc.log_process(self.__cmd, logger=get_logger(0), prefix=str(self)) if proc.returncode != 0: raise RuntimeError(f"Custom command error: retcode={proc.returncode}") - except Exception as err: + except Exception as ex: get_logger(0).error("Can't run custom command [ %s ]: %s", - tools.cmdfmt(self.__cmd), tools.efmt(err)) + tools.cmdfmt(self.__cmd), tools.efmt(ex)) raise GpioDriverOfflineError(self) def __str__(self) -> str: diff --git a/kvmd/plugins/ugpio/cmdret.py b/kvmd/plugins/ugpio/cmdret.py index 0eea78f6..7080a390 100644 --- a/kvmd/plugins/ugpio/cmdret.py +++ b/kvmd/plugins/ugpio/cmdret.py @@ -71,9 +71,9 @@ class Plugin(BaseUserGpioDriver): # pylint: disable=too-many-instance-attribute try: proc = await aioproc.log_process(self.__cmd, logger=get_logger(0), prefix=str(self)) return (proc.returncode == 0) - except Exception as err: + except Exception as ex: get_logger(0).error("Can't run custom command [ %s ]: %s", - tools.cmdfmt(self.__cmd), tools.efmt(err)) + tools.cmdfmt(self.__cmd), tools.efmt(ex)) raise GpioDriverOfflineError(self) async def write(self, pin: str, state: bool) -> None: diff --git a/kvmd/plugins/ugpio/extron.py b/kvmd/plugins/ugpio/extron.py index cb9fe96e..81a66c92 100644 --- a/kvmd/plugins/ugpio/extron.py +++ b/kvmd/plugins/ugpio/extron.py @@ -150,9 +150,9 @@ class Plugin(BaseUserGpioDriver): # pylint: disable=too-many-instance-attribute assert channel is not None self.__send_channel(tty, channel) - except Exception as err: + except Exception as ex: self.__channel_queue.put_nowait(None) - if isinstance(err, serial.SerialException) and err.errno == errno.ENOENT: # pylint: disable=no-member + if isinstance(ex, serial.SerialException) and ex.errno == errno.ENOENT: # pylint: disable=no-member logger.error("Missing %s serial device: %s", self, self.__device_path) else: logger.exception("Unexpected %s error", self) diff --git a/kvmd/plugins/ugpio/ezcoo.py b/kvmd/plugins/ugpio/ezcoo.py index c3502a61..d5bd8ef8 100644 --- a/kvmd/plugins/ugpio/ezcoo.py +++ b/kvmd/plugins/ugpio/ezcoo.py @@ -150,9 +150,9 @@ class Plugin(BaseUserGpioDriver): # pylint: disable=too-many-instance-attribute assert channel is not None self.__send_channel(tty, channel) - except Exception as err: + except Exception as ex: self.__channel_queue.put_nowait(None) - if isinstance(err, serial.SerialException) and err.errno == errno.ENOENT: # pylint: disable=no-member + if isinstance(ex, serial.SerialException) and ex.errno == errno.ENOENT: # pylint: disable=no-member logger.error("Missing %s serial device: %s", self, self.__device_path) else: logger.exception("Unexpected %s error", self) diff --git a/kvmd/plugins/ugpio/gpio.py b/kvmd/plugins/ugpio/gpio.py index 1ae1fbe0..6cda826b 100644 --- a/kvmd/plugins/ugpio/gpio.py +++ b/kvmd/plugins/ugpio/gpio.py @@ -54,7 +54,7 @@ class Plugin(BaseUserGpioDriver): self.__output_pins: dict[int, (bool | None)] = {} self.__reader: (aiogp.AioReader | None) = None - self.__outputs_request: (gpiod.LineRequest | None) = None + self.__outputs_req: (gpiod.LineRequest | None) = None @classmethod def get_plugin_options(cls) -> dict: @@ -74,7 +74,7 @@ class Plugin(BaseUserGpioDriver): def prepare(self) -> None: assert self.__reader is None - assert self.__outputs_request is None + assert self.__outputs_req is None self.__reader = aiogp.AioReader( path=self.__device_path, consumer="kvmd::gpio::inputs", @@ -82,7 +82,7 @@ class Plugin(BaseUserGpioDriver): notifier=self._notifier, ) if self.__output_pins: - self.__outputs_request = gpiod.request_lines( + self.__outputs_req = gpiod.request_lines( self.__device_path, consumer="kvmd::gpiod::outputs", config={ @@ -99,9 +99,9 @@ class Plugin(BaseUserGpioDriver): await self.__reader.poll() async def cleanup(self) -> None: - if self.__outputs_request: + if self.__outputs_req: try: - self.__outputs_request.release() + self.__outputs_req.release() except Exception: pass @@ -110,15 +110,15 @@ class Plugin(BaseUserGpioDriver): pin_int = int(pin) if pin_int in self.__input_pins: return self.__reader.get(pin_int) - assert self.__outputs_request + assert self.__outputs_req assert pin_int in self.__output_pins - return bool(self.__outputs_request.get_value(pin_int).value) + return bool(self.__outputs_req.get_value(pin_int).value) async def write(self, pin: str, state: bool) -> None: - assert self.__outputs_request + assert self.__outputs_req pin_int = int(pin) assert pin_int in self.__output_pins - self.__outputs_request.set_value(pin_int, gpiod.line.Value(state)) + self.__outputs_req.set_value(pin_int, gpiod.line.Value(state)) def __str__(self) -> str: return f"GPIO({self._instance_name})" diff --git a/kvmd/plugins/ugpio/hidrelay.py b/kvmd/plugins/ugpio/hidrelay.py index 894da42c..17f41e27 100644 --- a/kvmd/plugins/ugpio/hidrelay.py +++ b/kvmd/plugins/ugpio/hidrelay.py @@ -93,9 +93,9 @@ class Plugin(BaseUserGpioDriver): try: with self.__ensure_device("probing"): pass - except Exception as err: + except Exception as ex: logger.error("Can't probe %s on %s: %s", - self, self.__device_path, tools.efmt(err)) + self, self.__device_path, tools.efmt(ex)) self.__reset_pins() async def run(self) -> None: @@ -137,9 +137,9 @@ class Plugin(BaseUserGpioDriver): pin, state, self, self.__device_path) try: self.__inner_write(pin, state) - except Exception as err: + except Exception as ex: logger.error("Can't reset pin=%d of %s on %s: %s", - pin, self, self.__device_path, tools.efmt(err)) + pin, self, self.__device_path, tools.efmt(ex)) def __inner_read(self, pin: int) -> bool: assert 0 <= pin <= 7 @@ -168,9 +168,9 @@ class Plugin(BaseUserGpioDriver): get_logger(0).info("Opened %s on %s while %s", self, self.__device_path, context) try: yield self.__device - except Exception as err: + except Exception as ex: get_logger(0).error("Error occured on %s on %s while %s: %s", - self, self.__device_path, context, tools.efmt(err)) + self, self.__device_path, context, tools.efmt(ex)) self.__close_device() raise diff --git a/kvmd/plugins/ugpio/hue.py b/kvmd/plugins/ugpio/hue.py index 2c0e6749..9ed9e206 100644 --- a/kvmd/plugins/ugpio/hue.py +++ b/kvmd/plugins/ugpio/hue.py @@ -111,13 +111,13 @@ class Plugin(BaseUserGpioDriver): # pylint: disable=too-many-instance-attribute while True: session = self.__ensure_http_session() try: - async with session.get(f"{self.__url}/api/{self.__token}/lights") as response: - results = await response.json() + async with session.get(f"{self.__url}/api/{self.__token}/lights") as resp: + results = await resp.json() for pin in self.__state: if pin in results: self.__state[pin] = bool(results[pin]["state"]["on"]) - except Exception as err: - get_logger().error("Failed Hue bulk GET request: %s", tools.efmt(err)) + except Exception as ex: + get_logger().error("Failed Hue bulk GET request: %s", tools.efmt(ex)) self.__state = dict.fromkeys(self.__state, None) if self.__state != prev_state: self._notifier.notify() @@ -140,10 +140,10 @@ class Plugin(BaseUserGpioDriver): # pylint: disable=too-many-instance-attribute async with session.put( url=f"{self.__url}/api/{self.__token}/lights/{pin}/state", json={"on": state}, - ) as response: - htclient.raise_not_200(response) - except Exception as err: - get_logger().error("Failed Hue PUT request to pin %s: %s", pin, tools.efmt(err)) + ) as resp: + htclient.raise_not_200(resp) + except Exception as ex: + get_logger().error("Failed Hue PUT request to pin %s: %s", pin, tools.efmt(ex)) raise GpioDriverOfflineError(self) self.__update_notifier.notify() diff --git a/kvmd/plugins/ugpio/ipmi.py b/kvmd/plugins/ugpio/ipmi.py index 8aec6c3d..37a7a16f 100644 --- a/kvmd/plugins/ugpio/ipmi.py +++ b/kvmd/plugins/ugpio/ipmi.py @@ -153,9 +153,9 @@ class Plugin(BaseUserGpioDriver): # pylint: disable=too-many-instance-attribute proc = await aioproc.log_process(**self.__make_ipmitool_kwargs(action), logger=get_logger(0), prefix=str(self)) if proc.returncode != 0: raise RuntimeError(f"Ipmitool error: retcode={proc.returncode}") - except Exception as err: + except Exception as ex: get_logger(0).error("Can't send IPMI power-%s request to %s:%d: %s", - action, self.__host, self.__port, tools.efmt(err)) + action, self.__host, self.__port, tools.efmt(ex)) raise GpioDriverOfflineError(self) # ===== @@ -171,9 +171,9 @@ class Plugin(BaseUserGpioDriver): # pylint: disable=too-many-instance-attribute self.__online = True return raise RuntimeError(f"Invalid ipmitool response: {text}") - except Exception as err: + except Exception as ex: get_logger(0).error("Can't fetch IPMI power status from %s:%d: %s", - self.__host, self.__port, tools.efmt(err)) + self.__host, self.__port, tools.efmt(ex)) self.__power = False self.__online = False diff --git a/kvmd/plugins/ugpio/locator.py b/kvmd/plugins/ugpio/locator.py index f42116a7..d5cba719 100644 --- a/kvmd/plugins/ugpio/locator.py +++ b/kvmd/plugins/ugpio/locator.py @@ -53,7 +53,7 @@ class Plugin(BaseUserGpioDriver): self.__device_path = device_path self.__tasks: dict[int, (asyncio.Task | None)] = {} - self.__line_request: (gpiod.LineRequest | None) = None + self.__line_req: (gpiod.LineRequest | None) = None @classmethod def get_plugin_options(cls) -> dict: @@ -74,7 +74,7 @@ class Plugin(BaseUserGpioDriver): self.__tasks[int(pin)] = None def prepare(self) -> None: - self.__line_request = gpiod.request_lines( + self.__line_req = gpiod.request_lines( self.__device_path, consumer="kvmd::locator", config={ @@ -94,9 +94,9 @@ class Plugin(BaseUserGpioDriver): for task in tasks: task.cancel() await asyncio.gather(*tasks, return_exceptions=True) - if self.__line_request: + if self.__line_req: try: - self.__line_request.release() + self.__line_req.release() except Exception: pass @@ -115,17 +115,17 @@ class Plugin(BaseUserGpioDriver): async def __blink(self, pin: int) -> None: assert pin in self.__tasks - assert self.__line_request + assert self.__line_req try: state = True while True: - self.__line_request.set_value(pin, gpiod.line.Value(state)) + self.__line_req.set_value(pin, gpiod.line.Value(state)) state = (not state) await asyncio.sleep(0.1) except asyncio.CancelledError: pass finally: - self.__line_request.set_value(pin, gpiod.line.Value(False)) + self.__line_req.set_value(pin, gpiod.line.Value(False)) def __str__(self) -> str: return f"Locator({self._instance_name})" diff --git a/kvmd/plugins/ugpio/noyito.py b/kvmd/plugins/ugpio/noyito.py index f3c04a57..7363e2d4 100644 --- a/kvmd/plugins/ugpio/noyito.py +++ b/kvmd/plugins/ugpio/noyito.py @@ -91,9 +91,9 @@ class Plugin(BaseUserGpioDriver): try: with self.__ensure_device("probing"): pass - except Exception as err: + except Exception as ex: logger.error("Can't probe %s on %s: %s", - self, self.__device_path, tools.efmt(err)) + self, self.__device_path, tools.efmt(ex)) self.__reset_pins() async def cleanup(self) -> None: @@ -119,9 +119,9 @@ class Plugin(BaseUserGpioDriver): pin, state, self, self.__device_path) try: self.__inner_write(pin, state) - except Exception as err: + except Exception as ex: logger.error("Can't reset pin=%d of %s on %s: %s", - pin, self, self.__device_path, tools.efmt(err)) + pin, self, self.__device_path, tools.efmt(ex)) def __inner_write(self, pin: int, state: bool) -> None: assert 0 <= pin <= 7 @@ -144,9 +144,9 @@ class Plugin(BaseUserGpioDriver): get_logger(0).info("Opened %s on %s while %s", self, self.__device_path, context) try: yield self.__device - except Exception as err: + except Exception as ex: get_logger(0).error("Error occured on %s on %s while %s: %s", - self, self.__device_path, context, tools.efmt(err)) + self, self.__device_path, context, tools.efmt(ex)) self.__close_device() raise diff --git a/kvmd/plugins/ugpio/otgconf.py b/kvmd/plugins/ugpio/otgconf.py index 4b85a3f4..4c85b0e8 100644 --- a/kvmd/plugins/ugpio/otgconf.py +++ b/kvmd/plugins/ugpio/otgconf.py @@ -28,7 +28,6 @@ from typing import Any from ...logging import get_logger -from ...inotify import InotifyMask from ...inotify import Inotify from ... import aiotools @@ -82,15 +81,15 @@ class Plugin(BaseUserGpioDriver): await asyncio.sleep(5) with Inotify() as inotify: - await inotify.watch(InotifyMask.ALL_MODIFY_EVENTS, os.path.dirname(self.__udc_path)) - await inotify.watch(InotifyMask.ALL_MODIFY_EVENTS, self.__profile_path) + await inotify.watch_all_changes(os.path.dirname(self.__udc_path)) + await inotify.watch_all_changes(self.__profile_path) self._notifier.notify() while True: need_restart = False need_notify = False for event in (await inotify.get_series(timeout=1)): need_notify = True - if event.mask & (InotifyMask.DELETE_SELF | InotifyMask.MOVE_SELF | InotifyMask.UNMOUNT): + if event.restart: logger.warning("Got fatal inotify event: %s; reinitializing OTG-bind ...", event) need_restart = True break diff --git a/kvmd/plugins/ugpio/pway.py b/kvmd/plugins/ugpio/pway.py index 25a1f454..140cf02a 100644 --- a/kvmd/plugins/ugpio/pway.py +++ b/kvmd/plugins/ugpio/pway.py @@ -153,9 +153,9 @@ class Plugin(BaseUserGpioDriver): # pylint: disable=too-many-instance-attribute assert channel is not None self.__send_channel(tty, channel) - except Exception as err: + except Exception as ex: self.__channel_queue.put_nowait(None) - if isinstance(err, serial.SerialException) and err.errno == errno.ENOENT: # pylint: disable=no-member + if isinstance(ex, serial.SerialException) and ex.errno == errno.ENOENT: # pylint: disable=no-member logger.error("Missing %s serial device: %s", self, self.__device_path) else: logger.exception("Unexpected %s error", self) diff --git a/kvmd/plugins/ugpio/pwm.py b/kvmd/plugins/ugpio/pwm.py index 8aedb771..f202836e 100644 --- a/kvmd/plugins/ugpio/pwm.py +++ b/kvmd/plugins/ugpio/pwm.py @@ -94,18 +94,18 @@ class Plugin(BaseUserGpioDriver): pwm.period_ns = self.__period pwm.duty_cycle_ns = self.__get_duty_cycle(bool(initial)) pwm.enable() - except Exception as err: + except Exception as ex: logger.error("Can't get PWM chip %d channel %d: %s", - self.__chip, pin, tools.efmt(err)) + self.__chip, pin, tools.efmt(ex)) async def cleanup(self) -> None: for (pin, pwm) in self.__pwms.items(): try: pwm.disable() pwm.close() - except Exception as err: + except Exception as ex: get_logger(0).error("Can't cleanup PWM chip %d channel %d: %s", - self.__chip, pin, tools.efmt(err)) + self.__chip, pin, tools.efmt(ex)) async def read(self, pin: str) -> bool: try: diff --git a/kvmd/plugins/ugpio/tesmart.py b/kvmd/plugins/ugpio/tesmart.py index 5a5cd441..bb1d39e1 100644 --- a/kvmd/plugins/ugpio/tesmart.py +++ b/kvmd/plugins/ugpio/tesmart.py @@ -146,9 +146,9 @@ class Plugin(BaseUserGpioDriver): # pylint: disable=too-many-instance-attribute asyncio.ensure_future(self.__reader.readexactly(6)), timeout=self.__timeout, ))[4] - except Exception as err: + except Exception as ex: get_logger(0).error("Can't send command to TESmart KVM [%s]:%d: %s", - self.__host, self.__port, tools.efmt(err)) + self.__host, self.__port, tools.efmt(ex)) await self.__close_device() self.__active = -1 raise GpioDriverOfflineError(self) @@ -168,9 +168,9 @@ class Plugin(BaseUserGpioDriver): # pylint: disable=too-many-instance-attribute asyncio.ensure_future(asyncio.open_connection(self.__host, self.__port)), timeout=self.__timeout, ) - except Exception as err: + except Exception as ex: get_logger(0).error("Can't connect to TESmart KVM [%s]:%d: %s", - self.__host, self.__port, tools.efmt(err)) + self.__host, self.__port, tools.efmt(ex)) raise GpioDriverOfflineError(self) async def __ensure_device_serial(self) -> None: @@ -179,9 +179,9 @@ class Plugin(BaseUserGpioDriver): # pylint: disable=too-many-instance-attribute serial_asyncio.open_serial_connection(url=self.__device_path, baudrate=self.__speed), timeout=self.__timeout, ) - except Exception as err: + except Exception as ex: get_logger(0).error("Can't connect to TESmart KVM [%s]:%d: %s", - self.__device_path, self.__speed, tools.efmt(err)) + self.__device_path, self.__speed, tools.efmt(ex)) raise GpioDriverOfflineError(self) async def __close_device(self) -> None: diff --git a/kvmd/plugins/ugpio/xh_hk4401.py b/kvmd/plugins/ugpio/xh_hk4401.py index 7e064df9..d7a47679 100644 --- a/kvmd/plugins/ugpio/xh_hk4401.py +++ b/kvmd/plugins/ugpio/xh_hk4401.py @@ -157,9 +157,9 @@ class Plugin(BaseUserGpioDriver): # pylint: disable=too-many-instance-attribute if self.__protocol == 2: self.__channel_queue.put_nowait(channel) - except Exception as err: + except Exception as ex: self.__channel_queue.put_nowait(None) - if isinstance(err, serial.SerialException) and err.errno == errno.ENOENT: # pylint: disable=no-member + if isinstance(ex, serial.SerialException) and ex.errno == errno.ENOENT: # pylint: disable=no-member logger.error("Missing %s serial device: %s", self, self.__device_path) else: logger.exception("Unexpected %s error", self) diff --git a/kvmd/tools.py b/kvmd/tools.py index c96ff38f..14a58ab3 100644 --- a/kvmd/tools.py +++ b/kvmd/tools.py @@ -39,8 +39,8 @@ def cmdfmt(cmd: list[str]) -> str: return " ".join(map(shlex.quote, cmd)) -def efmt(err: Exception) -> str: - return f"{type(err).__name__}: {err}" +def efmt(ex: Exception) -> str: + return f"{type(ex).__name__}: {ex}" # ===== diff --git a/kvmd/validators/net.py b/kvmd/validators/net.py index c14dd3f6..301b160e 100644 --- a/kvmd/validators/net.py +++ b/kvmd/validators/net.py @@ -112,8 +112,8 @@ def valid_ssl_ciphers(arg: Any) -> str: arg = valid_stripped_string_not_empty(arg, name) try: ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER).set_ciphers(arg) - except Exception as err: - raise ValidatorError(f"The argument {arg!r} is not a valid {name}: {err}") + except Exception as ex: + raise ValidatorError(f"The argument {arg!r} is not a valid {name}: {ex}") return arg diff --git a/kvmd/validators/os.py b/kvmd/validators/os.py index 7b38f171..94d3a40f 100644 --- a/kvmd/validators/os.py +++ b/kvmd/validators/os.py @@ -55,8 +55,8 @@ def valid_abs_path(arg: Any, type: str="", name: str="") -> str: # pylint: disa if type: try: st = os.stat(arg) - except Exception as err: - raise_error(arg, f"{name}: {err}") + except Exception as ex: + raise_error(arg, f"{name}: {ex}") else: if not getattr(stat, f"S_IS{type.upper()}")(st.st_mode): raise_error(arg, name) diff --git a/kvmd/yamlconf/__init__.py b/kvmd/yamlconf/__init__.py index 42a69cfa..7cd3808d 100644 --- a/kvmd/yamlconf/__init__.py +++ b/kvmd/yamlconf/__init__.py @@ -143,8 +143,8 @@ class Option: def manual_validated(value: Any, *path: str) -> Generator[None, None, None]: try: yield - except (TypeError, ValueError) as err: - raise ConfigError(f"Invalid value {value!r} for key {'/'.join(path)!r}: {err}") + except (TypeError, ValueError) as ex: + raise ConfigError(f"Invalid value {value!r} for key {'/'.join(path)!r}: {ex}") def make_config(raw: dict[str, Any], scheme: dict[str, Any], _keys: tuple[str, ...]=()) -> Section: @@ -185,8 +185,8 @@ def make_config(raw: dict[str, Any], scheme: dict[str, Any], _keys: tuple[str, . else: try: value = option.type(value) - except (TypeError, ValueError) as err: - raise ConfigError(f"Invalid value {value!r} for key {make_full_name(key)!r}: {err}") + except (TypeError, ValueError) as ex: + raise ConfigError(f"Invalid value {value!r} for key {make_full_name(key)!r}: {ex}") config[key] = value config._set_meta( # pylint: disable=protected-access diff --git a/kvmd/yamlconf/loader.py b/kvmd/yamlconf/loader.py index 215cb526..5f879354 100644 --- a/kvmd/yamlconf/loader.py +++ b/kvmd/yamlconf/loader.py @@ -40,9 +40,9 @@ def load_yaml_file(path: str) -> Any: with open(path) as file: try: return yaml.load(file, _YamlLoader) - except Exception as err: + except Exception as ex: # Reraise internal exception as standard ValueError and show the incorrect file - raise ValueError(f"Invalid YAML in the file {path!r}:\n{tools.efmt(err)}") from None + raise ValueError(f"Invalid YAML in the file {path!r}:\n{tools.efmt(ex)}") from None # ===== diff --git a/scripts/kvmd-bootconfig b/scripts/kvmd-bootconfig index b4dc2280..c2fc5c6f 100755 --- a/scripts/kvmd-bootconfig +++ b/scripts/kvmd-bootconfig @@ -50,10 +50,56 @@ fi # shellcheck disable=SC1090 source <(dos2unix < /boot/pikvm.txt) +# shellcheck disable=SC1091 +source /usr/share/kvmd/platform || true + rw -# ========== First boot configuration ========== +# ========== First boot and/or Avahi configuration ========== + +make_avahi_service() { + local _base + local _serial + local _platform + _base=$(tr -d '\0' < /proc/device-tree/model || echo "Unknown base") + _serial=$( (cat /proc/device-tree/serial-number || echo "0000000000000000") | tr -d '\0' | tr '[:lower:]' '[:upper:]') + _platform="$PIKVM_MODEL-$PIKVM_VIDEO-$PIKVM_BOARD" + mkdir -p /etc/avahi/services + cat < /etc/avahi/services/pikvm.service + + + + pikvm-$_serial.local + + _pikvm._tcp + 443 + path=/ + protocol=https + description=PiKVM Web Server + model=$PIKVM_MODEL + video=$PIKVM_VIDEO + board=$PIKVM_BOARD + base=$_base + serial=$_serial + platform=$_platform + + + _https._tcp + 443 + path=/ + protocol=https + description=PiKVM Web Server + model=$PIKVM_MODEL + video=$PIKVM_VIDEO + board=$PIKVM_BOARD + base=$_base + serial=$_serial + model=$_platform + + +end_of_file +} if [ -n "$FIRSTBOOT$FIRST_BOOT" ]; then ( \ @@ -90,11 +136,21 @@ if [ -n "$FIRSTBOOT$FIRST_BOOT" ]; then unset disk part npart label fi + make_avahi_service + # fc-cache is required for installed X server # shellcheck disable=SC2015 which fc-cache && fc-cache || true fi +if [ -n "$ENABLE_AVAHI" ]; then + if [ ! -f /etc/avahi/services/pikvm.service ]; then + make_avahi_service + fi + systemctl enable avahi-daemon || true + touch /boot/pikvm-reboot.txt +fi + # ========== OTG serial ========== diff --git a/scripts/kvmd-gencert b/scripts/kvmd-gencert index b9c6e4f0..245bda7e 100755 --- a/scripts/kvmd-gencert +++ b/scripts/kvmd-gencert @@ -55,7 +55,7 @@ cd "$path" # - https://msol.io/blog/tech/create-a-self-signed-ecc-certificate openssl ecparam -out server.key -name prime256v1 -genkey openssl req -new -x509 -sha256 -nodes -key server.key -out server.crt -days 3650 \ - -subj "/C=RU/ST=Moscow/L=Moscow/O=PiKVM/OU=PiKVM/CN=localhost" + -subj "/C=US/O=PiKVM/OU=PiKVM/CN=localhost" #chown "root:kvmd-$target" "$path"/* chmod 440 "$path/server.key" diff --git a/scripts/kvmd-udev-restart-pass b/scripts/kvmd-udev-restart-pass index 760267eb..4b77897a 100755 --- a/scripts/kvmd-udev-restart-pass +++ b/scripts/kvmd-udev-restart-pass @@ -42,9 +42,6 @@ test -n "$port" if [ "$port" = "HDMI-A-1" ]; then status=$(head -n 1 "/sys/class/drm/$card-$port/status") if [ "$status" = "connected" ]; then - if systemctl is-enabled -q kvmd-pass; then - systemctl restart kvmd-pass || true - fi for pid in $(pgrep -f '^kvmd/streamer: ' || true); do kill "$pid" || true done diff --git a/setup.py b/setup.py index 3b80baac..5fdbeb91 100755 --- a/setup.py +++ b/setup.py @@ -56,7 +56,7 @@ def main() -> None: setup( name="kvmd", - version="4.3", + version="4.20", url="https://github.com/pikvm/kvmd", license="GPLv3", author="Maxim Devaev", @@ -101,6 +101,7 @@ def main() -> None: "kvmd.apps.ngxmkconf", "kvmd.apps.janus", "kvmd.apps.watchdog", + "kvmd.apps.oled", "kvmd.helpers", "kvmd.helpers.remount", "kvmd.helpers.swapfiles", @@ -108,6 +109,7 @@ def main() -> None: package_data={ "kvmd.apps.vnc": ["fonts/*.ttf"], + "kvmd.apps.oled": ["fonts/*.ttf", "pics/*.ppm"], "kvmd": ["i18n/zh/LC_MESSAGES/*.mo"], }, @@ -128,6 +130,7 @@ def main() -> None: "kvmd-nginx-mkconf = kvmd.apps.ngxmkconf:main", "kvmd-janus = kvmd.apps.janus:main", "kvmd-watchdog = kvmd.apps.watchdog:main", + "kvmd-oled = kvmd.apps.oled:main", "kvmd-helper-pst-remount = kvmd.helpers.remount:main", "kvmd-helper-otgmsd-remount = kvmd.helpers.remount:main", "kvmd-helper-swapfiles = kvmd.helpers.swapfiles:main", diff --git a/testenv/linters/eslintrc.js b/testenv/linters/eslintrc.js new file mode 100644 index 00000000..f1923cb7 --- /dev/null +++ b/testenv/linters/eslintrc.js @@ -0,0 +1,57 @@ +const js = require("/usr/lib/node_modules/eslint/node_modules/@eslint/js/src/index.js"); +const globals = require("/usr/lib/node_modules/eslint/node_modules/@eslint/eslintrc/node_modules/globals/index.js"); +const parser = require("/usr/lib/node_modules/@babel/eslint-parser/lib/index.cjs"); + +module.exports = [ + js.configs.recommended, + + { + files: ["**/*.js"], + languageOptions: { + globals: globals.browser, + ecmaVersion: 2015, + parser: parser, + parserOptions: { + ecmaVersion: 2025, + sourceType: "module", + allowImportExportEverywhere: true, + requireConfigFile: false, + }, + }, + }, + + { + rules: { + indent: [ + "error", + "tab", + {SwitchCase: 1}, + ], + "linebreak-style": [ + "error", + "unix", + ], + quotes: [ + "error", + "double", + ], + "quote-props": [ + "error", + "always", + ], + "semi": [ + "error", + "always", + ], + "comma-dangle": [ + "error", + "always-multiline", + ], + "no-unused-vars": [ + "error", + {vars: "local", args: "after-used"}, + ], + }, + }, + +]; diff --git a/testenv/linters/eslintrc.yaml b/testenv/linters/eslintrc.yaml deleted file mode 100644 index 90268506..00000000 --- a/testenv/linters/eslintrc.yaml +++ /dev/null @@ -1,36 +0,0 @@ -env: - browser: true - es6: true - -extends: "eslint:recommended" - -parser: "/usr/lib/node_modules/@babel/eslint-parser" -parserOptions: - ecmaVersion: 6 - sourceType: module - allowImportExportEverywhere: true - requireConfigFile: false - -rules: - indent: - - error - - tab - - SwitchCase: 1 - linebreak-style: - - error - - unix - quotes: - - error - - double - quote-props: - - error - - always - semi: - - error - - always - comma-dangle: - - error - - always-multiline - no-unused-vars: - - error - - {vars: local, args: after-used} diff --git a/testenv/linters/flake8.ini b/testenv/linters/flake8.ini index e37c1dfa..768e0b89 100644 --- a/testenv/linters/flake8.ini +++ b/testenv/linters/flake8.ini @@ -1,8 +1,9 @@ [flake8] inline-quotes = double max-line-length = 160 -ignore = W503, E227, E241, E252, Q003 +ignore = W503, E221, E227, E241, E252, Q003 # W503 line break before binary operator +# E221 multiple spaces before operator # E227 missing whitespace around bitwise or shift operator # E241 multiple spaces after # E252 missing whitespace around parameter equals diff --git a/testenv/linters/pylint.ini b/testenv/linters/pylint.ini index 978a2e43..fd2d8b35 100644 --- a/testenv/linters/pylint.ini +++ b/testenv/linters/pylint.ini @@ -38,6 +38,7 @@ disable = unspecified-encoding, consider-using-f-string, unnecessary-lambda-assignment, + too-many-positional-arguments, # https://github.com/PyCQA/pylint/issues/3882 [CLASSES] diff --git a/testenv/requirements.txt b/testenv/requirements.txt index b35a712a..36d2407a 100644 --- a/testenv/requirements.txt +++ b/testenv/requirements.txt @@ -1,6 +1,8 @@ +python-periphery pyserial-asyncio pyghmi spidev pyrad types-PyYAML types-aiofiles +luma.oled diff --git a/testenv/tests/plugins/auth/test_http.py b/testenv/tests/plugins/auth/test_http.py index 07b41374..252ad85b 100644 --- a/testenv/tests/plugins/auth/test_http.py +++ b/testenv/tests/plugins/auth/test_http.py @@ -32,10 +32,10 @@ from . import get_configured_auth_service # ===== -async def _handle_auth(request: aiohttp.web.BaseRequest) -> aiohttp.web.Response: +async def _handle_auth(req: aiohttp.web.BaseRequest) -> aiohttp.web.Response: status = 400 - if request.method == "POST": - credentials = (await request.json()) + if req.method == "POST": + credentials = (await req.json()) if credentials["user"] == "admin" and credentials["passwd"] == "pass": status = 200 return aiohttp.web.Response(text=str(status), status=status) diff --git a/testenv/tests/test_aiotools.py b/testenv/tests/test_aiotools.py index 048b1f9c..8bb0ccea 100644 --- a/testenv/tests/test_aiotools.py +++ b/testenv/tests/test_aiotools.py @@ -40,14 +40,14 @@ async def test_ok__region__access_one() -> None: async def func() -> None: assert not region.is_busy() - async with region: + with region: assert region.is_busy() assert not region.is_busy() await func() assert not region.is_busy() - await region.exit() + region.exit() assert not region.is_busy() @@ -57,16 +57,16 @@ async def test_fail__region__access_one() -> None: async def func() -> None: assert not region.is_busy() - async with region: + with region: assert region.is_busy() - await region.enter() + region.enter() assert not region.is_busy() with pytest.raises(RegionIsBusyError): await func() assert not region.is_busy() - await region.exit() + region.exit() assert not region.is_busy() @@ -76,21 +76,21 @@ async def test_ok__region__access_two() -> None: region = AioExclusiveRegion(RegionIsBusyError) async def func1() -> None: - async with region: + with region: await asyncio.sleep(1) print("done func1()") async def func2() -> None: await asyncio.sleep(2) print("waiking up func2()") - async with region: + with region: await asyncio.sleep(1) print("done func2()") await asyncio.gather(func1(), func2()) assert not region.is_busy() - await region.exit() + region.exit() assert not region.is_busy() @@ -99,13 +99,13 @@ async def test_fail__region__access_two() -> None: region = AioExclusiveRegion(RegionIsBusyError) async def func1() -> None: - async with region: + with region: await asyncio.sleep(2) print("done func1()") async def func2() -> None: await asyncio.sleep(1) - async with region: + with region: await asyncio.sleep(1) print("done func2()") @@ -114,7 +114,7 @@ async def test_fail__region__access_two() -> None: assert type(results[1]) is RegionIsBusyError # pylint: disable=unidiomatic-typecheck assert not region.is_busy() - await region.exit() + region.exit() assert not region.is_busy() diff --git a/testenv/tox.ini b/testenv/tox.ini index 0d1ed571..5ca65f5d 100644 --- a/testenv/tox.ini +++ b/testenv/tox.ini @@ -1,6 +1,5 @@ [tox] -envlist = flake8, pylint, mypy, vulture, pytest, htmlhint, shellcheck -#envlist = flake8, pylint, mypy, vulture, pytest, eslint, htmlhint, shellcheck +envlist = flake8, pylint, mypy, vulture, pytest, eslint, htmlhint, shellcheck skipsdist = true [testenv] @@ -55,7 +54,7 @@ deps = [testenv:eslint] allowlist_externals = eslint -commands = eslint --cache-location=/tmp --config=testenv/linters/eslintrc.yaml --color --ext .js web/share/js +commands = eslint --cache-location=/tmp --config=testenv/linters/eslintrc.js --color web/share/js [testenv:htmlhint] allowlist_externals = htmlhint diff --git a/web/kvm/index.html b/web/kvm/index.html index a5722260..23b77b61 100644 --- a/web/kvm/index.html +++ b/web/kvm/index.html @@ -372,6 +372,31 @@ +
+ Web UI settings +
+ + + + + + + + + +
Ask page close confirmation: +
+ + +
+
Expand for the entire tab by default: +
+ + +
+
+
+
@@ -404,8 +429,8 @@ @@ -413,17 +438,8 @@ - - - - @@ -622,17 +638,6 @@
Connect HID to Server:Connect main USB to Server:
- - + +
Enable locator LED:
- - -
-
Ask page close confirmation: -
- - + +
-
- - - - - - - - - -
Note:• Don't close the browser page until the upload is complete.
• To speed up the upload, close the stream window.
+
@@ -866,7 +884,7 @@
- +
@@ -2033,6 +2051,639 @@ // If you also want to support this project,
// you can donate on Patreon or Paypal. +
    +
  • A. Isenring
    • +
  • Aaron Graubert
    • +
  • Aaron Heise
    • +
  • Aaron Stein
    • +
  • Accalia
    • +
  • Adam Goodbar
    • +
  • Adam S
    • +
  • Adam Stuart
    • +
  • AdamBomb
    • +
  • adipisicing
    • +
  • Adrian Basham
    • +
  • Adrian Popescu
    • +
  • Ahmed Syed
    • +
  • Alberto Bassi
    • +
  • alejandro
    • +
  • Aleksei Brusianskii
    • +
  • Alessio Curri
    • +
  • Alex T
    • +
  • Alex Z
    • +
  • Alexander Karmanov
    • +
  • Alexander Lahuerta
    • +
  • Alexander Martin
    • +
  • Alexander Pankov
    • +
  • Alexandre Jablonski
    • +
  • Alexey Kamenskiy
    • +
  • alm0241
    • +
  • Alok Anand
    • +
  • Alucard
    • +
  • Ananthaneshan Elampoornan
    • +
  • Andreas Marufke
    • +
  • Andreas Schmid
    • +
  • Andrew Brant
    • +
  • Andrew Melton
    • +
  • Andrew Reusch
    • +
  • Andrew Ruan
    • +
  • Andrzej V
    • +
  • Andy
    • +
  • Andy Keys
    • +
  • Anish Patel
    • +
  • Anix
    • +
  • Anonymous
    • +
  • Anthony Junk
    • +
  • Anton Kovalenko
    • +
  • Armen
    • +
  • Aron Green
    • +
  • Aron Perelman
    • +
  • Artem Simonov
    • +
  • Arthur Mayer
    • +
  • Arthur Woimbée
    • +
  • Ashlesh Chaudhari
    • +
  • Asim Shakour
    • +
  • Augusto Becciu
    • +
  • AVS Computer
    • +
  • awkspace
    • +
  • Badal Patel
    • +
  • baddog
    • +
  • Bao Tin Hoang
    • +
  • Bean Co.
    • +
  • Bela Bargel
    • +
  • Belf Igor
    • +
  • Ben Gordon
    • +
  • Ben Scott
    • +
  • Benedikt Heine
    • +
  • Benedikt Meier
    • +
  • Benjamin Frewert
    • +
  • Benjamin Melancon
    • +
  • Benjamin Schwartz
    • +
  • Benjamin Stegmann
    • +
  • Benni Stauder
    • +
  • Bernhard Fitzke
    • +
  • Beu
    • +
  • bikmaek
    • +
  • bitjoe
    • +
  • Bits and Bytes Computers LLC
    • +
  • Bjoern Petsch
    • +
  • Blair Hasler
    • +
  • Blindside
    • +
  • Blue Frog LLC
    • +
  • Bootstrapper - Programmierung erklärt
    • +
  • Bosco
    • +
  • Bradford King
    • +
  • Brainspore Networks
    • +
  • Branden Shaulis
    • +
  • Brandon Daniels
    • +
  • Brian
    • +
  • Brian Moses
    • +
  • Brian T Mulcahy
    • +
  • Brian Vecchiarelli
    • +
  • Brian White
    • +
  • Bruno Gomes
    • +
  • Bryan Adams
    • +
  • Bryan Montgomery
    • +
  • Buzzer
    • +
  • C P ELSE
    • +
  • Calanish
    • +
  • Cameron Hatcher
    • +
  • Cameron Tacklind
    • +
  • Carl Mercier
    • +
  • Carl-Fredrik Johansson
    • +
  • Carlos Eduardo Porter Herrera
    • +
  • Carlos Garcia
    • +
  • Carlos Manuel Torres
    • +
  • cbad536
    • +
  • César Nascimento
    • +
  • CHINATERA LIMITED
    • +
  • Chris Blackmon
    • +
  • Chris Burton
    • +
  • Chris Campbell
    • +
  • Chris Jackson
    • +
  • Chris Lewis
    • +
  • Chris Rizio
    • +
  • Christi King
    • +
  • Christian Schlögl
    • +
  • Christian Svensson
    • +
  • Christof Maluck
    • +
  • Christoph Dette
    • +
  • Christoffer Lund
    • +
  • Christopher Bulla
    • +
  • Christopher Gelatt
    • +
  • Christopher Hearn
    • +
  • Christopher Mandlbaur
    • +
  • Christopher Mendoza
    • +
  • Christopher Simms
    • +
  • Chucktastic
    • +
  • Cihan VURAL
    • +
  • clauskj3r
    • +
  • Clifford Coleman
    • +
  • Clinton Lee Taylor
    • +
  • Cole Imhoff
    • +
  • Colin Goodman
    • +
  • Corey Layton
    • +
  • Corey Lista
    • +
  • Craig Keenan
    • +
  • Crossfactor
    • +
  • Cruzzer
    • +
  • ctag
    • +
  • Curt Sammer
    • +
  • CyB0rgg
    • +
  • DeMentor
    • +
  • Desmond Whitt
    • +
  • Daegara
    • +
  • DailyAneurism
    • +
  • Damon Meledones
    • +
  • Dan Berkowitz
    • +
  • Dan Brakeley
    • +
  • Daniel Bowder
    • +
  • Daniel Cabrera
    • +
  • Daniel Davila
    • +
  • Danilo Saft
    • +
  • Danne
    • +
  • Dariusz Techmański
    • +
  • David
    • +
  • David Brausewetter
    • +
  • David Davis
    • +
  • David Godibadze
    • +
  • David Howell
    • +
  • David Irvine
    • +
  • David Klinkman
    • +
  • David Niemann
    • +
  • David Shay
    • +
  • David Ye
    • +
  • David York
    • +
  • Denis
    • +
  • Denis Andreev
    • +
  • Denis Yatsenko
    • +
  • Dennis Becker
    • +
  • Dennis Joslin
    • +
  • Dennis Lomet
    • +
  • Derek Jarvis
    • +
  • Derek Yap
    • +
  • Didrik
    • +
  • digitalbaconbits
    • +
  • Dimitrij Jedich
    • +
  • dixon wong
    • +
  • dizztrukshin
    • +
  • Dmitry Shilov
    • +
  • DogeLabs
    • +
  • Dominic Phoon
    • +
  • Dominik Klonowski
    • +
  • Donald Hays
    • +
  • Edmon Abdul Nur
    • +
  • Edward Wang
    • +
  • Egan Ford
    • +
  • Elani Ferri
    • +
  • Elliot Woo
    • +
  • Entt
    • +
  • Eric Phenix
    • +
  • Ethan Shold
    • +
  • Eugene Sukhodolin
    • +
  • ewook
    • +
  • eye-catcher.com
    • +
  • Fabian Druschke
    • +
  • Fabiano Sidler
    • +
  • Far Pin Solutions, LLC
    • +
  • Felyx Gabryel
    • +
  • Fergus McKay
    • +
  • Finn Ebenritter
    • +
  • floppy
    • +
  • fo0bar
    • +
  • Foad Yousef
    • +
  • Foamy
    • +
  • Foli Ayivoh
    • +
  • Folkert Weistra
    • +
  • Francisco Pavon
    • +
  • Frank
    • +
  • Frank Sander
    • +
  • Frederick Czajka
    • +
  • Fredrik Idréus
    • +
  • Garrett Dangerfield
    • +
  • Ge Men
    • +
  • Geekworm
    • +
  • Genkinger Andreas
    • +
  • Geijer
    • +
  • Geoffrey Wright
    • +
  • George Becker
    • +
  • Georgy Brodsky
    • +
  • Gerald
    • +
  • Gerardus Vernimmen
    • +
  • Gernot Neuschröer
    • +
  • Giovanni Fulco
    • +
  • GK
    • +
  • Glen Dragon
    • +
  • Greg Winterstein
    • +
  • Gregory Smith
    • +
  • Gregory Treantos
    • +
  • grewil
    • +
  • Grey Cynic
    • +
  • Guenter Honisch
    • +
  • Guido Bernacchi
    • +
  • Gustin Johnson
    • +
  • György Tamás Vizi
    • +
  • Haiberg GmbH
    • +
  • Haven Zheng
    • +
  • Heibunny
    • +
  • Heikki Tiittanen
    • +
  • Helio Leonardo Pinheiro e Mota
    • +
  • Henrik Ählström
    • +
  • Henry Hood
    • +
  • HimKo
    • +
  • HouseFPV
    • +
  • Howard Simons
    • +
  • HyunohRyu
    • +
  • Icculus
    • +
  • iks
    • +
  • INFO TRX INC
    • +
  • Invader Monks
    • +
  • Ioannis Karageorgos
    • +
  • Isaac
    • +
  • IT Lifesaver
    • +
  • Ivan Ganev
    • +
  • Ivan Josiah Lapis
    • +
  • Ivan Shapovalov
    • +
  • iwbjhbweriuhf
    • +
  • J
    • +
  • J L
    • +
  • Jaanus
    • +
  • Jackson Wyatt
    • +
  • Jacob Karaffa
    • +
  • Jacob Morgan
    • +
  • James Cadd
    • +
  • James Cobb
    • +
  • James Edwards
    • +
  • James Kocher
    • +
  • James Mayhugh
    • +
  • James Noonan
    • +
  • James Ye
    • +
  • Jamie Murphy
    • +
  • Jamie Scott
    • +
  • Jan Niehusmann
    • +
  • Jannick Oursin
    • +
  • Jari Hiltunen
    • +
  • Jason Crossley
    • +
  • Jason Downey
    • +
  • Jason Toland
    • +
  • Jasper Backer
    • +
  • Jay Davis
    • +
  • Jay Isaacs
    • +
  • Jazereel Goh
    • +
  • Jean-Daniel Croteau
    • +
  • Jean-Philippe Guilbault
    • +
  • Jeff
    • +
  • Jeff Bowman
    • +
  • Jeff Urlwin
    • +
  • Jennifer Herting
    • +
  • Jennifer Rowlett
    • +
  • Jeremy Abel
    • +
  • Jeremy Combs
    • +
  • Jeremy Hines
    • +
  • Jerremy Holland
    • +
  • Jerry Nall
    • +
  • Jerry Y. Chen
    • +
  • Jim Bailey
    • +
  • Jim Harbin
    • +
  • Jimmy Burgett
    • +
  • Jimmy Stanley
    • +
  • Joachim Bruening
    • +
  • Joe Hanson
    • +
  • Joe Hinteregger
    • +
  • Joe Ventura
    • +
  • Joel Jacobs
    • +
  • Johannes Heigermose
    • +
  • John Andersen
    • +
  • John Copeland
    • +
  • John F Glenn
    • +
  • John Holmes
    • +
  • John Kelley
    • +
  • John McGovern
    • +
  • Johnny Henson
    • +
  • Jon Ferguy
    • +
  • Jon-Eric
    • +
  • Joni Ruuskanen
    • +
  • Jonas Fischer
    • +
  • Jonathan Slenders
    • +
  • Jonathan Vaughn
    • +
  • Joost Backer
    • +
  • Jordan Blake
    • +
  • Jordi Pakey-Rodriguez
    • +
  • Joris van Embden
    • +
  • Joseph Swift
    • +
  • Josh Nethery
    • +
  • Josh Ricker
    • +
  • Josh VanDeraa
    • +
  • Joshua Futterer
    • +
  • Jozef Riha
    • +
  • Jörgen Fredriksson
    • +
  • Julian Forero
    • +
  • Julian Schneider
    • +
  • Julien Angelier
    • +
  • Justin
    • +
  • Justin Waters
    • +
  • Kai Hadler
    • +
  • Kamil Chyba
    • +
  • Kari Matti Korpi
    • +
  • Karl Dunne
    • +
  • Karl Moos
    • +
  • Keith Muggleton
    • +
  • Ken Lee
    • +
  • Kenneth Younger III
    • +
  • Kenny Hui
    • +
  • KeonWoo PARK
    • +
  • Kevin Bajohr
    • +
  • Kevin Schwartz
    • +
  • Kevin Sherwood
    • +
  • Kiera Kujisawa
    • +
  • Kiran Schuler
    • +
  • Koloman
    • +
  • Konrad Neitzel
    • +
  • Krzysztof Żelaśkiewicz
    • +
  • Lance Ward
    • +
  • Larry Meaney
    • +
  • Lars
    • +
  • Lars Reinhardt
    • +
  • Lee Wilkinson
    • +
  • LeeNX
    • +
  • Leon Siegl
    • +
  • Leonard Feineis
    • +
  • Lewis Wild
    • +
  • Liran
    • +
  • Liviu Dimitriu
    • +
  • Lizardo Hernandez
    • +
  • LoCascio
    • +
  • Lordbob75
    • +
  • Lothar Schweikle-Droll
    • +
  • Louis Müller
    • +
  • LSDTripp
    • +
  • Ľubor Slušný
    • +
  • Luca Di Diomede
    • +
  • Lucio De Carli
    • +
  • Luiz Bizzio
    • +
  • Lukas Bischof
    • +
  • Lukas Kammerer
    • +
  • Lukas Söder
    • +
  • Maksim Terehin
    • +
  • Malcolm Cameron
    • +
  • Manfred Radeschnig
    • +
  • Marc Khouri
    • +
  • Marcin Wilk
    • +
  • Marcio Zimbres
    • +
  • Marco Rossi
    • +
  • Marcos Wolf
    • +
  • Marek Marczykowski-Górecki
    • +
  • Marius
    • +
  • Mar. Balske
    • +
  • Mark Farrell
    • +
  • Mark Gilbert
    • +
  • Mark Knam
    • +
  • Mark Robinson
    • +
  • Markrosoft
    • +
  • Markus Halm
    • +
  • Markus Schicker
    • +
  • Markus Sobczack
    • +
  • Marshall Bjerke
    • +
  • Marten Hermans
    • +
  • Martin Gasser
    • +
  • Martin Hofbauer
    • +
  • Martin Raine
    • +
  • Martin Suelmann
    • +
  • Martin Wilhelmi
    • +
  • Marvin Honderboom
    • +
  • Mateusz Grabowski
    • +
  • Mathias Uhl
    • +
  • Matt Kane
    • +
  • Matthew Cameron
    • +
  • Mauricio Allende
    • +
  • Max Evans
    • +
  • Mecky
    • +
  • Mehmet Aydoğdu
    • +
  • Michael Bartholomew
    • +
  • Michael Bell
    • +
  • Michael Bombe
    • +
  • Michael Collins
    • +
  • Michael Copeland
    • +
  • Michael Ho
    • +
  • Michael Kovacs
    • +
  • Michael Lynch
    • +
  • Michael Pennington
    • +
  • Michael Sage
    • +
  • Michael Stella
    • +
  • Michael Thalmann
    • +
  • Michael Wu
    • +
  • MichaelZ
    • +
  • Michel Bissonnette
    • +
  • Mikael Wikström
    • +
  • Mike Mason
    • +
  • Mikhael Mariano
    • +
  • Milan Múčka
    • +
  • Miles Davis
    • +
  • Minh Tang
    • +
  • Moez Tharani
    • +
  • Morgan Helton
    • +
  • Myron Weber
    • +
  • Murad Khasawneh
    • +
  • N Patel
    • +
  • Nathaniel Griswold
    • +
  • Nelson Lee
    • +
  • nezu
    • +
  • Nicholas Jeppson
    • +
  • Nicholas Kopas
    • +
  • Nicholas Walczak
    • +
  • Nick Leffler
    • +
  • Nick Roethemeier
    • +
  • Nico Baumgartner
    • +
  • Nicolai Kragh-Hansen
    • +
  • Nigel Smith
    • +
  • Nihal Fernando
    • +
  • Nils Orbat
    • +
  • Nis Wechselberg
    • +
  • Nithin Philips
    • +
  • Nod Swal
    • +
  • Nolan Haynes
    • +
  • nubbn
    • +
  • nybble
    • +
  • Oh Be
    • +
  • Oliver Schwarz
    • +
  • Oliver Zimmer
    • +
  • Omar El-Domeiri
    • +
  • Omar Siam
    • +
  • Oscar
    • +
  • Patrick
    • +
  • Patrick Fortin-Ducharme
    • +
  • Patrick McDowell
    • +
  • Patrick Wagstrom
    • +
  • Paul Bishop
    • +
  • Paul De La Rosa
    • +
  • Paul Pietkiewicz
    • +
  • Paul Tan
    • +
  • Pawel Trofimiuk
    • +
  • Peder Madsen
    • +
  • Peter
    • +
  • Peter Drayton
    • +
  • Peter Farrelly
    • +
  • Peter Okelmann
    • +
  • Petra Lohmann
    • +
  • Petri Heiskanen
    • +
  • Phil Wu
    • +
  • Philip Edwards
    • +
  • Philip Merricks
    • +
  • Pierre Brassart
    • +
  • Pierre Peine
    • +
  • posicat
    • +
  • pozitron03
    • +
  • Przemysław Szypowicz
    • +
  • P_Dmitrij
    • +
  • Qteal
    • +
  • Quattro Uno
    • +
  • Quentin Peten
    • +
  • Ralph Borchers
    • +
  • Ranc1d
    • +
  • Randall D Bilbrey
    • +
  • RandomJerk
    • +
  • Raphael Schitz
    • +
  • Ref Chowdhury
    • +
  • René Rathenau
    • +
  • ReysDad
    • +
  • Ricardo Marques
    • +
  • Richard
    • +
  • Richard Bernarts
    • +
  • Richard Fancher
    • +
  • Richard Freemantle
    • +
  • Richard Michael
    • +
  • Rico Cantrell
    • +
  • Rob
    • +
  • Rob Holden
    • +
  • Rob Tongue
    • +
  • Robert Klauco
    • +
  • Robert Weemhoff
    • +
  • Robin Gfatter
    • +
  • Rodion DENISYUK
    • +
  • Rohit Priyadarshi
    • +
  • Rolfs 3D UG
    • +
  • Ronald LeBaron
    • +
  • Ronald Wells
    • +
  • Ronny Haldorsen
    • +
  • rotx
    • +
  • Rufo Sanchez
    • +
  • Russell Scott
    • +
  • Ryan
    • +
  • Ryan Peacock
    • +
  • Samed Ozoglu
    • +
  • Sameul Davies
    • +
  • Samuel Cote
    • +
  • Samuel Vetsch
    • +
  • Samuel Walker
    • +
  • Sarah Foster
    • +
  • Sarten X
    • +
  • Satish Alwani
    • +
  • Scott
    • +
  • Scott Gagon
    • +
  • Scott Spicola
    • +
  • Scott Tusing
    • +
  • Scott Worthington
    • +
  • Scuba
    • +
  • Sean
    • +
  • Sean Akers
    • +
  • SEAT
    • +
  • Sebastian
    • +
  • Seonwoo Lee
    • +
  • Sergey Lukjanov
    • +
  • Seth Jennings
    • +
  • Shane Selling
    • +
  • Shawn Butts
    • +
  • Sheran Gunasekera
    • +
  • Shichun Chen
    • +
  • Shin Guey Wong
    • +
  • Simon Evans
    • +
  • Simon Sundgaard
    • +
  • Simplistic Realities
    • +
  • Sirmo
    • +
  • Snowy Maslov
    • +
  • Solve Technology
    • +
  • srepac
    • +
  • Stefan Bautz
    • +
  • Stefan Müller
    • +
  • Stefan Stemmer
    • +
  • Stefan Vaillant
    • +
  • Stephan Schmidt
    • +
  • Stephen
    • +
  • Stephen Hocking
    • +
  • Steve Jones
    • +
  • Steve Kerr
    • +
  • Steve Ovens
    • +
  • Steve Stringham
    • +
  • Steven Richter
    • +
  • Stratagem Solutions Ltd
    • +
  • Sven Breckler
    • +
  • sudo34
    • +
  • SuperHiTech
    • +
  • Tango_Echo_Alpha
    • +
  • Tarlak Desaydrone
    • +
  • TechBear
    • +
  • techlobo
    • +
  • Ted
    • +
  • Tejun Heo
    • +
  • TheSnowedOne
    • +
  • TheTechGiant
    • +
  • Thomas Charisoulis
    • +
  • Thomas Gitlin
    • +
  • Thomas Hagenmaier
    • +
  • Thomas Hedberg Jensen
    • +
  • Thomas Price
    • +
  • Thomas Søfteland
    • +
  • Tim Lenz
    • +
  • Tim Wilkinson
    • +
  • Timo Brinkmann
    • +
  • Timothee Besset
    • +
  • TitomusPrime
    • +
  • Tobias Schafferhans
    • +
  • Tom Lawson
    • +
  • Tom York
    • +
  • Tomas Kuchta
    • +
  • Tomáš hrubý
    • +
  • Torsten Droste
    • +
  • Torsten Knoll
    • +
  • Tracy Fitch
    • +
  • Tristan Schoening
    • +
  • Truman Kilen
    • +
  • turbochris
    • +
  • tutanak
    • +
  • Tyler
    • +
  • Udo Schroeter
    • +
  • Uli Fahrer
    • +
  • Vasily Lazarev
    • +
  • Vidru Eduard
    • +
  • Vicente Salvador Cubedo
    • +
  • Viktor Aschenbrenner
    • +
  • Viktor Ekmark
    • +
  • Vincent Chov
    • +
  • Vlad Sterescu
    • +
  • Volker Gropp
    • +
  • Walli
    • +
  • Walter_Ego
    • +
  • William Wenzel
    • +
  • Will Froning
    • +
  • William Hooper
    • +
  • William Perrin
    • +
  • William Stearns
    • +
  • Woojin Son
    • +
  • xMdb
    • +
  • Yanko Kaneti
    • +
  • Yaroslav Kulikovskikh
    • +
  • Yethal
    • +
  • Yevgeniy Kuksenko
    • +
  • Yew Kay Yan
    • +
  • Yigal Dar
    • +
  • Yogi
    • +
  • YURI LEE
    • +
  • Yurii Ostapchuk
    • +
  • Zeljko
    • +
  • zgen
    • +
  • Zoltan Magyari
    • +
  • Zsombor Vari
    • +

@@ -2049,9 +2700,17 @@ +
    +
  • + 
    
+      
    • 
+      
  • 
+        
    
+      
    • 
+    

     
   
 
\ No newline at end of file
diff --git a/web/kvm/index.pug b/web/kvm/index.pug
index 27249ea7..379295f4 100644
--- a/web/kvm/index.pug
+++ b/web/kvm/index.pug
@@ -11,14 +11,20 @@ block body
 	include navbar.pug
 	include windows.pug
 
+	ul(class="navbar-bg-tips")
+		li(class="left")
+			pre(id="kvmd-meta-tips-left")
+		li(class="right")
+			pre(id="kvmd-meta-tips-right")
+
 	ul(class="footer")
-		li(class="footer-left")
+		li(class="left")
 			span(id="kvmd-meta-server-host" title="Server name (see System/About)")
 			|   |  
 			span(id="kvmd-version-kvmd" title="KVMD version")
 			|   |  
 			span(id="kvmd-version-streamer" title="Streamer version")
-		li(class="footer-right")
+		li(class="right")
 			a(target="_blank" href="https://pikvm.org" i18n="index_text_10") PiKVM Project
 			|   |  
 			a(target="_blank" href="https://docs.pikvm.org" i18n="index_text_11") Documentation
diff --git a/web/kvm/navbar-msd.pug b/web/kvm/navbar-msd.pug
index 6d41a772..3ba99bdf 100644
--- a/web/kvm/navbar-msd.pug
+++ b/web/kvm/navbar-msd.pug
@@ -72,14 +72,6 @@ li(id="msd-dropdown" class="right feature-disabled")
 				tr(id="msd-new-part" class="hidden")
 					td(i18n="kvm_text70") Upload partition:
 					td(width="100%") #[select(id="msd-new-part-selector")]
-			hr
-			table(class="kv")
-				tr
-					td(class="value" i18n="kvm_text71") Note:
-					td(i18n="kvm_text72") • Don't close the browser page until the upload is complete.
-				tr
-					td
-					td(i18n="kvm_text73") • To speed up the upload, close the stream window.
 		div(id="msd-uploading-sub" class="hidden")
 			hr
 			table(class="kv")
@@ -92,6 +84,15 @@ li(id="msd-dropdown" class="right feature-disabled")
 			div(class="text")
 				div(id="msd-uploading-progress" class="progress")
 					span(id="msd-uploading-progress-value" class="progress-value")
+		div(id="msd-new-tips" class="hidden")
+			hr
+			table(class="kv")
+				tr
+					td(class="value" i18n="kvm_text71") Note:
+					td(i18n="kvm_text72") • Don't close the browser page until the upload is complete.
+				tr
+					td
+					td(i18n="kvm_text73") • To speed up the upload, close the stream window.
 		hr
 		div(class="buttons buttons-row")
 			button(disabled id="msd-connect-button" class="row50" i18n="kvm_text76") Connect drive to Server
diff --git a/web/kvm/navbar-system.pug b/web/kvm/navbar-system.pug
index bdfd58c2..9f9a4f3e 100644
--- a/web/kvm/navbar-system.pug
+++ b/web/kvm/navbar-system.pug
@@ -120,6 +120,14 @@ li(id="system-dropdown" class="right")
 						td(id="hid-mouse-scroll-value" class="value-number")
 					tr
 						+menu_switch_notable("hid-mouse-dot-switch", "Show the blue dot", true, true,  "hid-mouse-dot-switch")
+		details
+			summary(i18n="kvm_text83") Web UI settings
+			div(class="spoiler")
+				table(class="kv")
+					tr
+						+menu_switch_notable("page-close-ask-switch", "Ask page close confirmation", true, true, "page-close-ask-switch")
+					tr
+						+menu_switch_notable("page-full-tab-stream-switch", "Expand for the entire tab by default", true, false,"page-full-tab-stream-switch")
 		table(class="kv")
 			tr(id="hid-connect" class="feature-disabled")
 				+menu_switch_notable("hid-connect-switch", "Connect HID to Server", true, true, "hid-connect-switch")
@@ -132,8 +140,6 @@ li(id="system-dropdown" class="right")
 					"Turning off this switch will disconnect the main USB
from the server.  Are you sure you want to continue?")
 			tr(id="v4-locator" class="feature-disabled")
 				+menu_switch_notable_gpio("__v4_locator__", "Enable locator LED")
-			tr
-				+menu_switch_notable("page-close-ask-switch", "Ask page close confirmation", true, true, "page-close-ask-switch")
 		hr
 		div(class="buttons buttons-row")
 			button(data-force-hide-menu data-show-window="keyboard-window" class="row50" i18n="kvm_text30") • Show keyboard
diff --git a/web/kvm/navbar.pug b/web/kvm/navbar.pug
index 22496fa8..4f42cdaa 100644
--- a/web/kvm/navbar.pug
+++ b/web/kvm/navbar.pug
@@ -17,9 +17,9 @@ mixin menu_switch_notable_gpio(channel, title, confirm_off="")
 	td !{title}:
 	td(align="right")
 		div(class="switch-box")
-			input(disabled type="checkbox" id=`gpio-switch-${channel}` class="gpio-switch"
+			input(disabled type="checkbox" id=`__gpio-switch-${channel}` class=`__gpio-switch-${channel} gpio-switch`
 				data-channel=channel data-confirm-off=confirm_off)
-			label(for=`gpio-switch-${channel}`)
+			label(for=`__gpio-switch-${channel}`)
 				span(class="switch-inner")
 				span(class="switch")
 
diff --git a/web/kvm/window-about.pug b/web/kvm/window-about.pug
index d8d001aa..5d762ea5 100644
--- a/web/kvm/window-about.pug
+++ b/web/kvm/window-about.pug
@@ -41,6 +41,638 @@ div(id="about-window" class="window")
 					| // If you also want to support this project,#[br]
 					| // you can donate on #[a(target="_blank" href="https://www.patreon.com/pikvm") Patreon]
 					| or #[a(target="_blank" href="https://paypal.me/pikvm") Paypal].
+				ul
+					li A. Isenring
+					li Aaron Graubert
+					li Aaron Heise
+					li Aaron Stein
+					li Accalia
+					li Adam Goodbar
+					li Adam S
+					li Adam Stuart
+					li AdamBomb
+					li adipisicing
+					li Adrian Basham
+					li Adrian Popescu
+					li Ahmed Syed
+					li Alberto Bassi
+					li alejandro
+					li Aleksei Brusianskii
+					li Alessio Curri
+					li Alex T
+					li Alex Z
+					li Alexander Karmanov
+					li Alexander Lahuerta
+					li Alexander Martin
+					li Alexander Pankov
+					li Alexandre Jablonski
+					li Alexey Kamenskiy
+					li alm0241
+					li Alok Anand
+					li Alucard
+					li Ananthaneshan Elampoornan
+					li Andreas Marufke
+					li Andreas Schmid
+					li Andrew Brant
+					li Andrew Melton
+					li Andrew Reusch
+					li Andrew Ruan
+					li Andrzej V
+					li Andy
+					li Andy Keys
+					li Anish Patel
+					li Anix
+					li Anonymous
+					li Anthony Junk
+					li Anton Kovalenko
+					li Armen
+					li Aron Green
+					li Aron Perelman
+					li Artem Simonov
+					li Arthur Mayer
+					li Arthur Woimbée
+					li Ashlesh Chaudhari
+					li Asim Shakour
+					li Augusto Becciu
+					li AVS Computer
+					li awkspace
+					li Badal Patel
+					li baddog
+					li Bao Tin Hoang
+					li Bean Co.
+					li Bela Bargel
+					li Belf Igor
+					li Ben Gordon
+					li Ben Scott
+					li Benedikt Heine
+					li Benedikt Meier
+					li Benjamin Frewert
+					li Benjamin Melancon
+					li Benjamin Schwartz
+					li Benjamin Stegmann
+					li Benni Stauder
+					li Bernhard Fitzke
+					li Beu
+					li bikmaek
+					li bitjoe
+					li Bits and Bytes Computers LLC
+					li Bjoern Petsch
+					li Blair Hasler
+					li Blindside
+					li Blue Frog LLC
+					li Bootstrapper - Programmierung erklärt
+					li Bosco
+					li Bradford King
+					li Brainspore Networks
+					li Branden Shaulis
+					li Brandon Daniels
+					li Brian
+					li Brian Moses
+					li Brian T Mulcahy
+					li Brian Vecchiarelli
+					li Brian White
+					li Bruno Gomes
+					li Bryan Adams
+					li Bryan Montgomery
+					li Buzzer
+					li C P ELSE
+					li Calanish
+					li Cameron Hatcher
+					li Cameron Tacklind
+					li Carl Mercier
+					li Carl-Fredrik Johansson
+					li Carlos Eduardo Porter Herrera
+					li Carlos Garcia
+					li Carlos Manuel Torres
+					li cbad536
+					li César Nascimento
+					li CHINATERA LIMITED
+					li Chris Blackmon
+					li Chris Burton
+					li Chris Campbell
+					li Chris Jackson
+					li Chris Lewis
+					li Chris Rizio
+					li Christi King
+					li Christian Schlögl
+					li Christian Svensson
+					li Christof Maluck
+					li Christoph Dette
+					li Christoffer Lund
+					li Christopher Bulla
+					li Christopher Gelatt
+					li Christopher Hearn
+					li Christopher Mandlbaur
+					li Christopher Mendoza
+					li Christopher Simms
+					li Chucktastic
+					li Cihan VURAL
+					li clauskj3r
+					li Clifford Coleman
+					li Clinton Lee Taylor
+					li Cole Imhoff
+					li Colin Goodman
+					li Corey Layton
+					li Corey Lista
+					li Craig Keenan
+					li Crossfactor
+					li Cruzzer
+					li ctag
+					li Curt Sammer
+					li CyB0rgg
+					li DeMentor
+					li Desmond Whitt
+					li Daegara
+					li DailyAneurism
+					li Damon Meledones
+					li Dan Berkowitz
+					li Dan Brakeley
+					li Daniel Bowder
+					li Daniel Cabrera
+					li Daniel Davila
+					li Danilo Saft
+					li Danne
+					li Dariusz Techmański
+					li David
+					li David Brausewetter
+					li David Davis
+					li David Godibadze
+					li David Howell
+					li David Irvine
+					li David Klinkman
+					li David Niemann
+					li David Shay
+					li David Ye
+					li David York
+					li Denis
+					li Denis Andreev
+					li Denis Yatsenko
+					li Dennis Becker
+					li Dennis Joslin
+					li Dennis Lomet
+					li Derek Jarvis
+					li Derek Yap
+					li Didrik
+					li digitalbaconbits
+					li Dimitrij Jedich
+					li dixon wong
+					li dizztrukshin
+					li Dmitry Shilov
+					li DogeLabs
+					li Dominic Phoon
+					li Dominik Klonowski
+					li Donald Hays
+					li Edmon Abdul Nur
+					li Edward Wang
+					li Egan Ford
+					li Elani Ferri
+					li Elliot Woo
+					li Entt
+					li Eric Phenix
+					li Ethan Shold
+					li Eugene Sukhodolin
+					li ewook
+					li eye-catcher.com
+					li Fabian Druschke
+					li Fabiano Sidler
+					li Far Pin Solutions, LLC
+					li Felyx Gabryel
+					li Fergus McKay
+					li Finn Ebenritter
+					li floppy
+					li fo0bar
+					li Foad Yousef
+					li Foamy
+					li Foli Ayivoh
+					li Folkert Weistra
+					li Francisco Pavon
+					li Frank
+					li Frank Sander
+					li Frederick Czajka
+					li Fredrik Idréus
+					li Garrett Dangerfield
+					li Ge Men
+					li Geekworm
+					li Genkinger Andreas
+					li Geijer
+					li Geoffrey Wright
+					li George Becker
+					li Georgy Brodsky
+					li Gerald
+					li Gerardus Vernimmen
+					li Gernot Neuschröer
+					li Giovanni Fulco
+					li GK
+					li Glen Dragon
+					li Greg Winterstein
+					li Gregory Smith
+					li Gregory Treantos
+					li grewil
+					li Grey Cynic
+					li Guenter Honisch
+					li Guido Bernacchi
+					li Gustin Johnson
+					li György Tamás Vizi
+					li Haiberg GmbH
+					li Haven Zheng
+					li Heibunny
+					li Heikki Tiittanen
+					li Helio Leonardo Pinheiro e Mota
+					li Henrik Ählström
+					li Henry Hood
+					li HimKo
+					li HouseFPV
+					li Howard Simons
+					li HyunohRyu
+					li Icculus
+					li iks
+					li INFO TRX INC
+					li Invader Monks
+					li Ioannis Karageorgos
+					li Isaac
+					li IT Lifesaver
+					li Ivan Ganev
+					li Ivan Josiah Lapis
+					li Ivan Shapovalov
+					li iwbjhbweriuhf
+					li J
+					li J L
+					li Jaanus
+					li Jackson Wyatt
+					li Jacob Karaffa
+					li Jacob Morgan
+					li James Cadd
+					li James Cobb
+					li James Edwards
+					li James Kocher
+					li James Mayhugh
+					li James Noonan
+					li James Ye
+					li Jamie Murphy
+					li Jamie Scott
+					li Jan Niehusmann
+					li Jannick Oursin
+					li Jari Hiltunen
+					li Jason Crossley
+					li Jason Downey
+					li Jason Toland
+					li Jasper Backer
+					li Jay Davis
+					li Jay Isaacs
+					li Jazereel Goh
+					li Jean-Daniel Croteau
+					li Jean-Philippe Guilbault
+					li Jeff
+					li Jeff Bowman
+					li Jeff Urlwin
+					li Jennifer Herting
+					li Jennifer Rowlett
+					li Jeremy Abel
+					li Jeremy Combs
+					li Jeremy Hines
+					li Jerremy Holland
+					li Jerry Nall
+					li Jerry Y. Chen
+					li Jim Bailey
+					li Jim Harbin
+					li Jimmy Burgett
+					li Jimmy Stanley
+					li Joachim Bruening
+					li Joe Hanson
+					li Joe Hinteregger
+					li Joe Ventura
+					li Joel Jacobs
+					li Johannes Heigermose
+					li John Andersen
+					li John Copeland
+					li John F Glenn
+					li John Holmes
+					li John Kelley
+					li John McGovern
+					li Johnny Henson
+					li Jon Ferguy
+					li Jon-Eric
+					li Joni Ruuskanen
+					li Jonas Fischer
+					li Jonathan Slenders
+					li Jonathan Vaughn
+					li Joost Backer
+					li Jordan Blake
+					li Jordi Pakey-Rodriguez
+					li Joris van Embden
+					li Joseph Swift
+					li Josh Nethery
+					li Josh Ricker
+					li Josh VanDeraa
+					li Joshua Futterer
+					li Jozef Riha
+					li Jörgen Fredriksson
+					li Julian Forero
+					li Julian Schneider
+					li Julien Angelier
+					li Justin
+					li Justin Waters
+					li Kai Hadler
+					li Kamil Chyba
+					li Kari Matti Korpi
+					li Karl Dunne
+					li Karl Moos
+					li Keith Muggleton
+					li Ken Lee
+					li Kenneth Younger III
+					li Kenny Hui
+					li KeonWoo PARK
+					li Kevin Bajohr
+					li Kevin Schwartz
+					li Kevin Sherwood
+					li Kiera Kujisawa
+					li Kiran Schuler
+					li Koloman
+					li Konrad Neitzel
+					li Krzysztof Żelaśkiewicz
+					li Lance Ward
+					li Larry Meaney
+					li Lars
+					li Lars Reinhardt
+					li Lee Wilkinson
+					li LeeNX
+					li Leon Siegl
+					li Leonard Feineis
+					li Lewis Wild
+					li Liran
+					li Liviu Dimitriu
+					li Lizardo Hernandez
+					li LoCascio
+					li Lordbob75
+					li Lothar Schweikle-Droll
+					li Louis Müller
+					li LSDTripp
+					li Ľubor Slušný
+					li Luca Di Diomede
+					li Lucio De Carli
+					li Luiz Bizzio
+					li Lukas Bischof
+					li Lukas Kammerer
+					li Lukas Söder
+					li Maksim Terehin
+					li Malcolm Cameron
+					li Manfred Radeschnig
+					li Marc Khouri
+					li Marcin Wilk
+					li Marcio Zimbres
+					li Marco Rossi
+					li Marcos Wolf
+					li Marek Marczykowski-Górecki
+					li Marius
+					li Mar. Balske
+					li Mark Farrell
+					li Mark Gilbert
+					li Mark Knam
+					li Mark Robinson
+					li Markrosoft
+					li Markus Halm
+					li Markus Schicker
+					li Markus Sobczack
+					li Marshall Bjerke
+					li Marten Hermans
+					li Martin Gasser
+					li Martin Hofbauer
+					li Martin Raine
+					li Martin Suelmann
+					li Martin Wilhelmi
+					li Marvin Honderboom
+					li Mateusz Grabowski
+					li Mathias Uhl
+					li Matt Kane
+					li Matthew Cameron
+					li Mauricio Allende
+					li Max Evans
+					li Mecky
+					li Mehmet Aydoğdu
+					li Michael Bartholomew
+					li Michael Bell
+					li Michael Bombe
+					li Michael Collins
+					li Michael Copeland
+					li Michael Ho
+					li Michael Kovacs
+					li Michael Lynch
+					li Michael Pennington
+					li Michael Sage
+					li Michael Stella
+					li Michael Thalmann
+					li Michael Wu
+					li MichaelZ
+					li Michel Bissonnette
+					li Mikael Wikström
+					li Mike Mason
+					li Mikhael Mariano
+					li Milan Múčka
+					li Miles Davis
+					li Minh Tang
+					li Moez Tharani
+					li Morgan Helton
+					li Myron Weber
+					li Murad Khasawneh
+					li N Patel
+					li Nathaniel Griswold
+					li Nelson Lee
+					li nezu
+					li Nicholas Jeppson
+					li Nicholas Kopas
+					li Nicholas Walczak
+					li Nick Leffler
+					li Nick Roethemeier
+					li Nico Baumgartner
+					li Nicolai Kragh-Hansen
+					li Nigel Smith
+					li Nihal Fernando
+					li Nils Orbat
+					li Nis Wechselberg
+					li Nithin Philips
+					li Nod Swal
+					li Nolan Haynes
+					li nubbn
+					li nybble
+					li Oh Be
+					li Oliver Schwarz
+					li Oliver Zimmer
+					li Omar El-Domeiri
+					li Omar Siam
+					li Oscar
+					li Patrick
+					li Patrick Fortin-Ducharme
+					li Patrick McDowell
+					li Patrick Wagstrom
+					li Paul Bishop
+					li Paul De La Rosa
+					li Paul Pietkiewicz
+					li Paul Tan
+					li Pawel Trofimiuk
+					li Peder Madsen
+					li Peter
+					li Peter Drayton
+					li Peter Farrelly
+					li Peter Okelmann
+					li Petra Lohmann
+					li Petri Heiskanen
+					li Phil Wu
+					li Philip Edwards
+					li Philip Merricks
+					li Pierre Brassart
+					li Pierre Peine
+					li posicat
+					li pozitron03
+					li Przemysław Szypowicz
+					li P_Dmitrij
+					li Qteal
+					li Quattro Uno
+					li Quentin Peten
+					li Ralph Borchers
+					li Ranc1d
+					li Randall D Bilbrey
+					li RandomJerk
+					li Raphael Schitz
+					li Ref Chowdhury
+					li René Rathenau
+					li ReysDad
+					li Ricardo Marques
+					li Richard
+					li Richard Bernarts
+					li Richard Fancher
+					li Richard Freemantle
+					li Richard Michael
+					li Rico Cantrell
+					li Rob
+					li Rob Holden
+					li Rob Tongue
+					li Robert Klauco
+					li Robert Weemhoff
+					li Robin Gfatter
+					li Rodion DENISYUK
+					li Rohit Priyadarshi
+					li Rolfs 3D UG
+					li Ronald LeBaron
+					li Ronald Wells
+					li Ronny Haldorsen
+					li rotx
+					li Rufo Sanchez
+					li Russell Scott
+					li Ryan
+					li Ryan Peacock
+					li Samed Ozoglu
+					li Sameul Davies
+					li Samuel Cote
+					li Samuel Vetsch
+					li Samuel Walker
+					li Sarah Foster
+					li Sarten X
+					li Satish Alwani
+					li Scott
+					li Scott Gagon
+					li Scott Spicola
+					li Scott Tusing
+					li Scott Worthington
+					li Scuba
+					li Sean
+					li Sean Akers
+					li SEAT
+					li Sebastian
+					li Seonwoo Lee
+					li Sergey Lukjanov
+					li Seth Jennings
+					li Shane Selling
+					li Shawn Butts
+					li Sheran Gunasekera
+					li Shichun Chen
+					li Shin Guey Wong
+					li Simon Evans
+					li Simon Sundgaard
+					li Simplistic Realities
+					li Sirmo
+					li Snowy Maslov
+					li Solve Technology
+					li srepac
+					li Stefan Bautz
+					li Stefan Müller
+					li Stefan Stemmer
+					li Stefan Vaillant
+					li Stephan Schmidt
+					li Stephen
+					li Stephen Hocking
+					li Steve Jones
+					li Steve Kerr
+					li Steve Ovens
+					li Steve Stringham
+					li Steven Richter
+					li Stratagem Solutions Ltd
+					li Sven Breckler
+					li sudo34
+					li SuperHiTech
+					li Tango_Echo_Alpha
+					li Tarlak Desaydrone
+					li TechBear
+					li techlobo
+					li Ted
+					li Tejun Heo
+					li TheSnowedOne
+					li TheTechGiant
+					li Thomas Charisoulis
+					li Thomas Gitlin
+					li Thomas Hagenmaier
+					li Thomas Hedberg Jensen
+					li Thomas Price
+					li Thomas Søfteland
+					li Tim Lenz
+					li Tim Wilkinson
+					li Timo Brinkmann
+					li Timothee Besset
+					li TitomusPrime
+					li Tobias Schafferhans
+					li Tom Lawson
+					li Tom York
+					li Tomas Kuchta
+					li Tomáš hrubý
+					li Torsten Droste
+					li Torsten Knoll
+					li Tracy Fitch
+					li Tristan Schoening
+					li Truman Kilen
+					li turbochris
+					li tutanak
+					li Tyler
+					li Udo Schroeter
+					li Uli Fahrer
+					li Vasily Lazarev
+					li Vidru Eduard
+					li Vicente Salvador Cubedo
+					li Viktor Aschenbrenner
+					li Viktor Ekmark
+					li Vincent Chov
+					li Vlad Sterescu
+					li Volker Gropp
+					li Walli
+					li Walter_Ego
+					li William Wenzel
+					li Will Froning
+					li William Hooper
+					li William Perrin
+					li William Stearns
+					li Woojin Son
+					li xMdb
+					li Yanko Kaneti
+					li Yaroslav Kulikovskikh
+					li Yethal
+					li Yevgeniy Kuksenko
+					li Yew Kay Yan
+					li Yigal Dar
+					li Yogi
+					li YURI LEE
+					li Yurii Ostapchuk
+					li Zeljko
+					li zgen
+					li Zoltan Magyari
+					li Zsombor Vari
 		br
 		p(class="text credits")
 			a(target="_blank" href="https://pikvm.org") PiKVM Project
diff --git a/web/kvm/window-stream.pug b/web/kvm/window-stream.pug
index 0bf317c5..918260ab 100644
--- a/web/kvm/window-stream.pug
+++ b/web/kvm/window-stream.pug
@@ -15,7 +15,7 @@ div(id="stream-window" class="window window-resizable")
 	button(class="window-button-exit-full-tab") ▼
 	div(id="stream-box" class="stream-box-offline")
 		img(id="stream-image" src=`${png_dir}/blank-stream.png`)
-		video(id="stream-video" class="hidden" autoplay playsinline muted)
+		video(id="stream-video" class="hidden" disablePictureInPicture="true" autoplay playsinline muted)
 		div(id="stream-fullscreen-active")
 
 	div(id="stream-mouse-buttons" class="keypad" align="center")
diff --git a/web/login/index.html b/web/login/index.html
index b877f570..72f38846 100644
--- a/web/login/index.html
+++ b/web/login/index.html
@@ -94,7 +94,7 @@
       
     
     
    
-      
  • This site is actively using JavaScript.
    
+      
  • This site is actively using JavaScript.
    
         It doesn't contain ads, but is blocked by some ad filters.
    
         Please turn it off to continue and reload the page.
       
    • 
diff --git a/web/login/index.pug b/web/login/index.pug
index f3d78b1a..aa6e6d3d 100644
--- a/web/login/index.pug
+++ b/web/login/index.pug
@@ -33,7 +33,7 @@ block body
 						td #[button(id="login-button" class="key" i18n="login") Login]
 
 	ul(class="footer")
-		li(class="footer-left" i18n="footer-left")
+		li(class="left"  i18n="footer-left")
 			| This site is actively using JavaScript.#[br]
 			| It doesn't contain ads, but is blocked by some ad filters.#[br]
 			| Please turn it off to continue and reload the page.
diff --git a/web/share/css/kvm/hid.css b/web/share/css/kvm/hid.css
index 5c710ac2..32a92e0f 100644
--- a/web/share/css/kvm/hid.css
+++ b/web/share/css/kvm/hid.css
@@ -24,28 +24,6 @@ div#text-menu {
 	width: 340px;
 }
 
-textarea#hid-pak-text {
-	display: block;
-	resize: none;
-	height: 120px;
-	width: 100%;
-	border: var(--border-default-thin);
-	border-radius: 4px;
-	color: var(--cs-code-default-fg);
-	background-color: var(--cs-code-default-bg);
-	-webkit-appearance:none;
-}
-
-textarea#hid-pak-text::-moz-placeholder {
-	line-height: 60px;
-	text-align: center;
-}
-
-textarea#hid-pak-text::-webkit-input-placeholder {
-	line-height: 60px;
-	text-align: center;
-}
-
 input#hid-recorder-new-script-file {
 	display: none;
 }
diff --git a/web/share/css/main.css b/web/share/css/main.css
index 8e6af465..8a074aa7 100644
--- a/web/share/css/main.css
+++ b/web/share/css/main.css
@@ -123,6 +123,26 @@ select {
 	display: block;
 	width: 100%;
 	padding-left: 5px;
+}
+select[size] {
+	height: auto;
+	padding: 5px;
+}
+select[size]::-webkit-scrollbar {
+	width: 8px;
+	height: 8px;
+}
+select[size]::-webkit-scrollbar-thumb {
+	border-radius: 4px;
+	background: var(--cs-scroll-default-bg);
+}
+@-moz-document url-prefix() {
+	select[size] {
+		scrollbar-width: 8px;
+		scrollbar-color: var(--cs-scroll-default-bg) var(--cs-code-default-bg);
+	}
+}
+select:not([size]) {
 	padding-right: 25px;
 }
 button.small {
@@ -149,22 +169,24 @@ select {
 	-webkit-user-select: none;
 	-moz-user-select: none;
 	user-select: none;
+}
+select:not([size]) {
 	background-image: url("../svg/select-arrow-normal.svg");
 	background-position: center right;
 	background-repeat: no-repeat;
 }
-select:disabled {
+select:not([size]):disabled {
 	background-image: url("../svg/select-arrow-inactive.svg") !important;
 }
-select:active {
+select:not([size]):active {
 	color: var(--cs-control-intensive-fg) !important;
 	background-image: url("../svg/select-arrow-intensive.svg") !important;
 }
-select option {
+select:not([size]) option {
 	color: var(--cs-control-default-fg);
 	background-color: var(--cs-control-default-bg);
 }
-select option.comment {
+select:not([size]) option.comment {
 	color: var(--cs-control-disabled-fg);
 	font-style: italic;
 }
@@ -180,6 +202,26 @@ input[type=text], input[type=password] {
 	height: 30px;
 }
 
+textarea {
+	display: block;
+	resize: none;
+	height: 120px;
+	width: 100%;
+	border: var(--border-default-thin);
+	border-radius: 4px;
+	color: var(--cs-code-default-fg);
+	background-color: var(--cs-code-default-bg);
+	-webkit-appearance:none;
+}
+textarea::-moz-placeholder {
+	line-height: 60px;
+	text-align: center;
+}
+textarea::-webkit-input-placeholder {
+	line-height: 60px;
+	text-align: center;
+}
+
 div.buttons-row {
 	margin: 0;
 	padding: 0;
@@ -218,6 +260,30 @@ div.buttons-row {
 	border-bottom-right-radius: 0;
 }
 
+table.kv {
+	border-spacing: 5px;
+	margin: 0 10px 0 10px;
+	font-size: 12px;
+}
+table.kv td {
+	text-align: left;
+}
+table.kv td.value {
+	font-weight: bold;
+	max-width: 310px;
+	overflow: hidden;
+}
+table.kv td.value-slider {
+	width: 100%;
+}
+table.kv td.value-number {
+	font-weight: bold;
+	max-width: 310px;
+	overflow: hidden;
+	min-width: 40px;
+	max-width: 40px;
+}
+
 ul.footer {
 	list-style-type: none;
 	bottom: 0;
@@ -231,10 +297,10 @@ ul.footer {
 ul.footer li {
 	padding: 0 10px;
 }
-ul.footer li.footer-left {
+ul.footer li.left {
 	float: left;
 }
-ul.footer li.footer-right {
+ul.footer li.right {
 	float: right;
 }
 ul.footer li a {
diff --git a/web/share/css/navbar.css b/web/share/css/navbar.css
index 04d15e05..af704add 100644
--- a/web/share/css/navbar.css
+++ b/web/share/css/navbar.css
@@ -167,30 +167,6 @@ ul#navbar li div.menu div.text {
 	font-size: 14px;
 }
 
-ul#navbar li div.menu table.kv {
-	border-spacing: 5px;
-	margin: 0 10px 0 10px;
-	font-size: 12px;
-}
-ul#navbar li div.menu table.kv td {
-	text-align: left;
-}
-ul#navbar li div.menu table.kv td.value {
-	font-weight: bold;
-	max-width: 310px;
-	overflow: hidden;
-}
-ul#navbar li div.menu table.kv td.value-slider {
-	width: 100%;
-}
-ul#navbar li div.menu table.kv td.value-number {
-	font-weight: bold;
-	max-width: 310px;
-	overflow: hidden;
-	min-width: 40px;
-	max-width: 40px;
-}
-
 ul#navbar li div.menu div.buttons button,
 ul#navbar li div.menu div.buttons select {
 	border-radius: 0;
@@ -222,3 +198,33 @@ ul#navbar li div.menu img.sign {
 	margin-right: 10px;
 	height: 20px;
 }
+
+ul.navbar-bg-tips {
+	list-style-type: none;
+	top: 50px;
+	position: fixed;
+	width: 100%;
+	padding: 0;
+	font-size: 0.7em;
+	line-height: 1.5em;
+	color: var(--cs-page-obscure-fg);
+	z-index: -10;
+}
+ul.navbar-bg-tips li {
+	padding: 0 10px;
+	max-width: 20%;
+}
+ul.navbar-bg-tips li pre {
+	word-break: break-word;
+	white-space: break-spaces;
+	text-align: justify;
+}
+ul.navbar-bg-tips li.left {
+	float: left;
+}
+ul.navbar-bg-tips li.right {
+	float: right;
+}
+ul.navbar-bg-tips li a {
+	color: var(--cs-page-obscure-fg);
+}
diff --git a/web/share/css/x-desktop.css b/web/share/css/x-desktop.css
index a652c61b..732f8aa2 100644
--- a/web/share/css/x-desktop.css
+++ b/web/share/css/x-desktop.css
@@ -23,7 +23,7 @@
 /* ===== main.css ===== */
 
 button:enabled:hover,
-select:enabled:hover,
+select:not([size]):enabled:hover,
 input[type=file]:enabled:hover::-webkit-file-selector-button,
 input[type=file]:enabled:hover::file-selector-button {
 	color: var(--cs-control-hovered-fg);
@@ -31,7 +31,7 @@ input[type=file]:enabled:hover::file-selector-button {
 }
 
 button:active,
-select:active,
+select:not([size]):active,
 input[type=file]:active::-webkit-file-selector-button,
 input[type=file]:active::file-selector-button {
 	color: var(--cs-control-pressed-fg) !important;
@@ -42,7 +42,7 @@ button.key:active,
 select.key:active {
 	box-shadow: none;
 }
-select:enabled:hover {
+select:not([size]):enabled:hover {
 	background-image: url("../svg/select-arrow-intensive.svg") !important;
 }
 
diff --git a/web/share/i18n/i18n_en.json b/web/share/i18n/i18n_en.json
index aa1d01a7..ac3ac0c0 100644
--- a/web/share/i18n/i18n_en.json
+++ b/web/share/i18n/i18n_en.json
@@ -113,6 +113,7 @@
     "kvm_text80":"Record video using the browser API, and will be downloaded automatically",
     "kvm_text81":"Start recording",
     "kvm_text82":"End recording",
+    "kvm_text83":"Web UI settings",
 
     "atx-ask-switch":"Ask click confirmation",
     "hid-recorder-loop-switch":"Infinite loop playback",
@@ -140,5 +141,6 @@
     "msd-message-out-of-storage":"Current image is out of storage",
     "msd-message-rw-enabled":"Read-write mode is enabled",
     "msd-message-downloads":"The image is being downloaded from One-KVM",
-    "msd-message-another-user-uploads":"Another user uploads an image"
+    "msd-message-another-user-uploads":"Another user uploads an image",
+    "page-full-tab-stream-switch":"Expand for the entire tab by default"
 }
\ No newline at end of file
diff --git a/web/share/i18n/i18n_zh.json b/web/share/i18n/i18n_zh.json
index 28c477bf..e1e8ad87 100644
--- a/web/share/i18n/i18n_zh.json
+++ b/web/share/i18n/i18n_zh.json
@@ -113,6 +113,7 @@
     "kvm_text80":"使用浏览器 API 录制视频，结束录制后视频文件会自动下载",
     "kvm_text81":"开始录制",
     "kvm_text82":"结束录制",
+    "kvm_text83":"网页界面设置",
 
     "atx-ask-switch":"点击二次确认",
     "hid-recorder-loop-switch":"无限循环重放",
@@ -140,5 +141,6 @@
     "msd-message-out-of-storage":"当前镜像大小超出存储空间",
     "msd-message-rw-enabled":"读写模式以启用",
     "msd-message-downloads":"正在从 One-KVM 下载镜像",
-    "msd-message-another-user-uploads":"另一个用户正在上传镜像"
+    "msd-message-another-user-uploads":"另一个用户正在上传镜像",
+    "page-full-tab-stream-switch":"自动全屏视频窗口"
 }
\ No newline at end of file
diff --git a/web/share/js/index/main.js b/web/share/js/index/main.js
index a0d05b91..92c7a088 100644
--- a/web/share/js/index/main.js
+++ b/web/share/js/index/main.js
@@ -38,13 +38,13 @@ export function main() {
 
 
 function __loadKvmdInfo() {
-	tools.httpGet("/api/info?fields=auth,meta,extras", function(http) {
+	tools.httpGet("/api/info", {"fields": "auth,meta,extras"}, function(http) {
 		if (http.status === 200) {
 			let info = JSON.parse(http.responseText).result;
 
 			let apps = [];
 			if (info.extras === null) {
-				wm.error("Not all applications in the menu can be displayed
    due an error. See KVMD logs for details.");
+				wm.error("Not all applications in the menu can be displayed due an error.
    See KVMD logs for details.");
 			} else {
 				apps = Object.values(info.extras).sort(function(a, b) {
 					if (a.place < b.place) {
@@ -100,7 +100,7 @@ function __makeApp(id, path, icon, name) {
 			
 				
    
 					
-					${name}
+					${tools.escape(name)}
 				
    
 			    
 		
@@ -108,11 +108,11 @@ function __makeApp(id, path, icon, name) {
 }
 
 function __logout() {
-	tools.httpPost("/api/auth/logout", function(http) {
+	tools.httpPost("/api/auth/logout", null, function(http) {
 		if (http.status === 200 || http.status === 401 || http.status === 403) {
 			document.location.href = "/login";
 		} else {
-			wm.error("Logout error:
    ", http.responseText);
+			wm.error("Logout error", http.responseText);
 		}
 	});
 }
diff --git a/web/share/js/ipmi/main.js b/web/share/js/ipmi/main.js
index 237b4005..26bd1f38 100644
--- a/web/share/js/ipmi/main.js
+++ b/web/share/js/ipmi/main.js
@@ -31,7 +31,7 @@ export function main() {
 }
 
 function __loadKvmdInfo() {
-	tools.httpGet("/api/info", function(http) {
+	tools.httpGet("/api/info", null, function(http) {
 		if (http.status === 200) {
 			let ipmi_port = JSON.parse(http.responseText).result.extras.ipmi.port;
 			let make_item = (comment, ipmi, api) => `
diff --git a/web/share/js/kvm/atx.js b/web/share/js/kvm/atx.js
index 53c290cf..796a4eeb 100644
--- a/web/share/js/kvm/atx.js
+++ b/web/share/js/kvm/atx.js
@@ -32,59 +32,77 @@ export function Atx(__recorder) {
 
 	/************************************************************************/
 
+	var __state = null;
+
 	var __init__ = function() {
 		$("atx-power-led").title = "Power Led";
 		$("atx-hdd-led").title = "Disk Activity Led";
 
 		tools.storage.bindSimpleSwitch($("atx-ask-switch"), "atx.ask", true);
 
-		for (let args of [
-			["atx-power-button", "power", "Are you sure you want to press the power button?"],
-			["atx-power-button-long", "power_long", `
-				Are you sure you want to long press the power button?
    
-				Warning! This could cause data loss on the server.
-			`],
-			["atx-reset-button", "reset", `
-				Are you sure you want to press the reset button?
    
-				Warning! This could case data loss on the server.
-			`],
-		]) {
-			tools.el.setOnClick($(args[0]), () => __clickButton(args[1], args[2]));
-		}
+		tools.el.setOnClick($("atx-power-button"), () => __clickAtx("power"));
+		tools.el.setOnClick($("atx-power-button-long"), () => __clickAtx("power_long"));
+		tools.el.setOnClick($("atx-reset-button"), () => __clickAtx("reset"));
 	};
 
 	/************************************************************************/
 
 	self.setState = function(state) {
-		let buttons_enabled = false;
 		if (state) {
-			tools.feature.setEnabled($("atx-dropdown"), state.enabled);
-			$("atx-power-led").className = (state.busy ? "led-yellow" : (state.leds.power ? "led-green" : "led-gray"));
-			$("atx-hdd-led").className = (state.leds.hdd ? "led-red" : "led-gray");
-			buttons_enabled = !state.busy;
+			if (!__state) {
+				__state = {"leds": {}};
+			}
+			if (state.enabled !== undefined) {
+				__state.enabled = state.enabled;
+				tools.feature.setEnabled($("atx-dropdown"), __state.enabled);
+			}
+			if (__state.enabled !== undefined) {
+				if (state.busy !== undefined) {
+					__state.busy = state.busy;
+					__updateButtons(!__state.busy);
+				}
+				if (state.leds !== undefined) {
+					__state.leds = state.leds;
+				}
+				if (state.busy !== undefined || state.leds !== undefined) {
+					__updateLeds(__state.leds.power, __state.leds.hdd, __state.busy);
+				}
+			}
 		} else {
-			$("atx-power-led").className = "led-gray";
-			$("atx-hdd-led").className = "led-gray";
-		}
-		for (let id of ["atx-power-button", "atx-power-button-long", "atx-reset-button"]) {
-			tools.el.setEnabled($(id), buttons_enabled);
+			__state = null;
+			__updateLeds(false, false, false);
+			__updateButtons(false);
 		}
 	};
 
-	var __clickButton = function(button, confirm_msg) {
+	var __updateLeds = function(power, hdd, busy) {
+		$("atx-power-led").className = (busy ? "led-yellow" : (power ? "led-green" : "led-gray"));
+		$("atx-hdd-led").className = (hdd ? "led-red" : "led-gray");
+	};
+
+	var __updateButtons = function(enabled) {
+		for (let id of ["atx-power-button", "atx-power-button-long", "atx-reset-button"]) {
+			tools.el.setEnabled($(id), enabled);
+		}
+	};
+
+	var __clickAtx = function(button) {
 		let click_button = function() {
-			tools.httpPost(`/api/atx/click?button=${button}`, function(http) {
+			tools.httpPost("/api/atx/click", {"button": button}, function(http) {
 				if (http.status === 409) {
-					wm.error("Performing another ATX operation for other client.
    Please try again later");
+					wm.error("Performing another ATX operation for other client.
    Please try again later.");
 				} else if (http.status !== 200) {
-					wm.error("Click error:
    ", http.responseText);
+					wm.error("Click error", http.responseText);
 				}
 			});
 			__recorder.recordAtxButtonEvent(button);
 		};
 
 		if ($("atx-ask-switch").checked) {
-			wm.confirm(confirm_msg).then(function(ok) {
+			wm.confirm(`
+				Are you sure you want to press the ${button} button?
    
+				Warning! This could case data loss on the server.
+			`).then(function(ok) {
 				if (ok) {
 					click_button();
 				}
diff --git a/web/share/js/kvm/gpio.js b/web/share/js/kvm/gpio.js
index 4bee901a..41d5ee92 100644
--- a/web/share/js/kvm/gpio.js
+++ b/web/share/js/kvm/gpio.js
@@ -23,7 +23,7 @@
 "use strict";
 
 
-import {tools, $, $$$} from "../tools.js";
+import {tools, $, $$} from "../tools.js";
 import {wm} from "../wm.js";
 
 
@@ -32,44 +32,59 @@ export function Gpio(__recorder) {
 
 	/************************************************************************/
 
-	var __state = null;
+	var __has_model = false;
 
 	/************************************************************************/
 
 	self.setState = function(state) {
 		if (state) {
-			for (let channel in state.inputs) {
-				let el = $(`gpio-led-${channel}`);
-				if (el) {
-					__setLedState(el, state.inputs[channel].state);
-				}
+			if (state.model !== undefined) {
+				__has_model = true;
+				__updateModel(state.model);
 			}
-			for (let channel in state.outputs) {
-				for (let type of ["switch", "button"]) {
-					let el = $(`gpio-${type}-${channel}`);
-					if (el) {
-						tools.el.setEnabled(el, state.outputs[channel].online && !state.outputs[channel].busy);
-					}
+			if (__has_model && state.state !== undefined) {
+				if (state.state.inputs !== undefined) {
+					__updateInputs(state.state.inputs);
 				}
-				let el = $(`gpio-switch-${channel}`);
-				if (el) {
-					el.checked = state.outputs[channel].state;
+				if (state.state.outputs !== undefined) {
+					__updateOutputs(state.state.outputs);
 				}
 			}
 		} else {
-			for (let el of $$$(".gpio-led")) {
+			__has_model = false;
+			for (let el of $$("__gpio-led")) {
 				__setLedState(el, false);
 			}
-			for (let selector of [".gpio-switch", ".gpio-button"]) {
-				for (let el of $$$(selector)) {
+			for (let selector of ["__gpio-switch", "__gpio-button"]) {
+				for (let el of $$(selector)) {
 					tools.el.setEnabled(el, false);
 				}
 			}
 		}
-		__state = state;
 	};
 
-	self.setModel = function(model) {
+	var __updateInputs = function(inputs) {
+		for (let ch in inputs) {
+			for (let el of $$(`__gpio-led-${ch}`)) {
+				__setLedState(el, inputs[ch].state);
+			}
+		}
+	};
+
+	var __updateOutputs = function(outputs) {
+		for (let ch in outputs) {
+			for (let type of ["switch", "button"]) {
+				for (let el of $$(`__gpio-${type}-${ch}`)) {
+					tools.el.setEnabled(el, (outputs[ch].online && !outputs[ch].busy));
+				}
+			}
+			for (let el of $$(`__gpio-switch-${ch}`)) {
+				el.checked = outputs[ch].state;
+			}
+		}
+	};
+
+	var __updateModel = function(model) {
 		tools.feature.setEnabled($("gpio-dropdown"), model.view.table.length);
 		if (model.view.table.length) {
 			let title = [];
@@ -84,44 +99,36 @@ export function Gpio(__recorder) {
 			$("gpio-menu-button").innerHTML = title.join(" ");
 		}
 
-		let content = "";
+		let html = "
    ";
 		for (let row of model.view.table) {
 			if (row === null) {
-				content += "
    ";
+				html += "
    ";
 			} else {
-				content += "";
+				html += "";
 				for (let item of row) {
 					if (item.type === "output") {
 						item.scheme = model.scheme.outputs[item.channel];
 					}
-					content += ``;
+					html += ``;
 				}
-				content += "";
+				html += "";
 			}
 		}
-		content += "
    ${__createItem(item)}${__createItem(item)}
    ";
-		$("gpio-menu").innerHTML = content;
+		html += "";
+		$("gpio-menu").innerHTML = html;
 
-		for (let channel in model.scheme.outputs) {
-			let el = $(`gpio-switch-${channel}`);
-			if (el) {
-				tools.el.setOnClick(el, __createAction(el, __switchChannel));
+		for (let ch in model.scheme.outputs) {
+			for (let el of $$(`__gpio-switch-${ch}`)) {
+				tools.el.setOnClick(el, tools.partial(__switchChannel, el));
 			}
-			el = $(`gpio-button-${channel}`);
-			if (el) {
-				tools.el.setOnClick(el, __createAction(el, __pulseChannel));
+			for (let el of $$(`__gpio-button-${ch}`)) {
+				tools.el.setOnClick(el, tools.partial(__pulseChannel, el));
 			}
 		}
 
 		tools.feature.setEnabled($("v3-usb-breaker"), ("__v3_usb_breaker__" in model.scheme.outputs));
 		tools.feature.setEnabled($("v4-locator"), ("__v4_locator__" in model.scheme.outputs));
 		tools.feature.setEnabled($("system-tool-wol"), ("__wol__" in model.scheme.outputs));
-
-		self.setState(__state);
-	};
-
-	var __createAction = function(el, action) {
-		return () => action(el);
 	};
 
 	var __createItem = function(item) {
@@ -129,18 +136,28 @@ export function Gpio(__recorder) {
 			return item.text;
 		} else if (item.type === "input") {
 			return `
-				
+				
 			`;
 		} else if (item.type === "output") {
 			let controls = [];
 			let confirm = (item.confirm ? "Are you sure you want to perform this action?" : "");
 			if (item.scheme["switch"]) {
+				let id = tools.makeId();
 				controls.push(`
 					
    
-						
-