41 Commits

Author SHA1 Message Date
github-actions[bot]
2a85084c8f chore(release): 0.7.0 2026-03-12 20:26:12 +00:00
6cc6dc5b42 Merge pull request 'chore(release): 0.7.0' (#18) from release/0.7.0 into main
Reviewed-on: #18
2026-03-12 20:17:15 +00:00
a4c07d9d2d Merge pull request 'feat: improve templates' (#17) from feat/improve-templates into develop
Reviewed-on: #17
2026-03-12 20:16:05 +00:00
a697ae6661 fix(ack_handler.py): fix error by importing annotations 2026-03-12 21:14:34 +01:00
acbcb3364e feat(web_server.py): add debug parameter to JudasWebServer.run() 2026-03-12 20:43:29 +01:00
762256c3cd fix(client_details.html): fix up code for AJAX loading 2026-03-12 20:42:45 +01:00
c442dca520 refactor(panel.html): use new base template 2026-03-12 20:42:15 +01:00
12c5de9f11 refactor(index.html): use new base template 2026-03-12 20:42:03 +01:00
aa562a0eab chore(base.html): remove leftover code 2026-03-12 20:41:33 +01:00
865112c823 chore(style.css): adjust styles 2026-03-12 20:41:08 +01:00
1d764bd77d feat(header.html): add header template 2026-03-12 20:34:30 +01:00
6f4bc3aa0f feat(base.html): add base template 2026-03-12 20:34:17 +01:00
14ea136fbb feat(panel.js): move js from inline to separate script 2026-03-12 20:33:38 +01:00
78f9508753 feat(panel.html): use ?query instead of #hash for client selection 2026-03-09 21:19:05 +01:00
github-actions[bot]
11bf344cb5 chore(release): 0.7.0-dev.1 2026-03-08 19:47:31 +00:00
5ee8eca11b Merge pull request 'chore(release): 0.7.0-dev.1' (#16) from release/0.7.0-dev.1 into main
Reviewed-on: #16
2026-03-08 19:46:56 +00:00
f18935f793 Merge pull request 'feat/add-basic-telemetry' (#15) from feat/add-basic-telemetry into develop
Reviewed-on: #15
2026-03-08 19:43:13 +00:00
d7b136851b feat(client_details.html): add temporary initial telemetry display 2026-03-08 20:38:59 +01:00
7e9a9e6eed feat(backend_server.py): add initial_telemetry support 2026-03-08 20:38:32 +01:00
6ed03ab74d feat(client.py): add Client.initial_telemetry property 2026-03-08 20:38:01 +01:00
40c08d0169 feat(initial_handler.py): add handler for TELEMETRY/INTIIAL msgs 2026-03-08 20:37:26 +01:00
3d13d24116 build(uv.lock): update judas_protocol to 0.9.1 2026-03-05 22:29:48 +01:00
28b57b6964 build(uv.lock): update judas_protocol to 0.9.0 2026-03-05 21:26:34 +01:00
github-actions[bot]
6a024bbfc6 chore(release): 0.6.0 2026-03-05 19:59:49 +00:00
e5ca1066fd Merge pull request 'chore(release): 0.6.0' (#14) from release/0.6.0 into main
Reviewed-on: #14
2026-03-05 19:59:05 +00:00
61be674258 chore: remove cache/ directory 2026-03-05 20:52:41 +01:00
72d51b451f feat(backend_server.py): add notice to known_clients.yaml 2026-03-05 20:52:18 +01:00
efbf99f356 refactor(backend_server.py): if known_clients.yaml not present, call _save_known_clients() 2026-03-05 20:51:53 +01:00
f46d27164b chore(.gitignore): ignore config/known_clients.yaml as it's generated automatically 2026-03-05 20:38:26 +01:00
f13f243b5b chore(__main__.py): set logging level for werkzeug to WARNING 2026-03-05 13:14:08 +01:00
fbb75c263c fix(backend_server.py): fix double-connection handling 2026-03-05 13:05:48 +01:00
0e7c948668 feat(config/): add config/ directory 2026-03-04 09:23:54 +01:00
35899d3668 refactor(backend_server.py): move known_clients.yaml to config/ 2026-03-04 09:23:21 +01:00
88d349090e fix(backend_server.py): fix double disconnect if client.inbound empty 2026-03-03 22:20:36 +01:00
332238b403 chore(__init__.py): correct version 2026-03-03 21:55:56 +01:00
e54cc479b5 chore(handler/__init__.py): add AckHandler to __all__ 2026-03-03 20:56:18 +01:00
97fc17fbb3 feat(hello_handler.py): remove client from pending_hello if recv'd HELLO 2026-03-03 20:55:39 +01:00
f5b14fc610 feat(backend_server.py): add timeout on HELLO 2026-03-03 20:55:39 +01:00
bf1ad0ead0 feat(ack_handler.py): add handling for ACKs 2026-03-03 20:55:39 +01:00
a9bace8aca feat(backend_server.py): add ACK_TIMEOUT constant 2026-03-03 20:42:16 +01:00
c88e39c735 feat(backend_server.py): track message ACKs and resend if no ACK recv'd within 5 seconds 2026-03-03 20:39:53 +01:00
21 changed files with 553 additions and 304 deletions

3
.gitignore vendored
View File

@@ -45,3 +45,6 @@ logs/
# Sphinx
docs/_build/
docs/ref/modules/
# known clients
config/known_clients.yaml

View File

@@ -2,6 +2,98 @@
All notable changes to this project will be documented in this file.
## [0.7.0] - 2026-03-12
### Bug Fixes
- [`a697ae6`](https://github.com/pufereq/template-repo/commit/a697ae666114ed0adfa78db7accfd81d26850111) **ack_handler.py**: fix error by importing annotations
- [`762256c`](https://github.com/pufereq/template-repo/commit/762256c3cdee4bfc8dbdbfa6d2997656486f9557) **client_details.html**: fix up code for AJAX loading
### Features
- [`acbcb33`](https://github.com/pufereq/template-repo/commit/acbcb3364e7b682bb67ee329d12626e9df0d627d) **web_server.py**: add `debug` parameter to `JudasWebServer.run()`
- [`1d764bd`](https://github.com/pufereq/template-repo/commit/1d764bd77d031123054ab86f073fb27823363532) **header.html**: add header template
- [`6f4bc3a`](https://github.com/pufereq/template-repo/commit/6f4bc3aa0f7f1a4aefe8b2d8405d4fc49c6c744d) **base.html**: add base template
- [`14ea136`](https://github.com/pufereq/template-repo/commit/14ea136fbbad447d1eb668fcc09aadb75de88ee3) **panel.js**: move js from inline to separate script
- [`78f9508`](https://github.com/pufereq/template-repo/commit/78f9508753ae47c681cff115fb960bea6bb12e20) **panel.html**: use ?query instead of #hash for client selection
### Miscellaneous Tasks
- [`aa562a0`](https://github.com/pufereq/template-repo/commit/aa562a0eab3a4ce10f225d03c9927ace6ee66678) **base.html**: remove leftover code
- [`865112c`](https://github.com/pufereq/template-repo/commit/865112c823a65d761d929c69574c47b57559804d) **style.css**: adjust styles
### Refactor
- [`c442dca`](https://github.com/pufereq/template-repo/commit/c442dca520ff381b17cd49863e5189066882f73d) **panel.html**: use new base template
- [`12c5de9`](https://github.com/pufereq/template-repo/commit/12c5de9f114d955c6b309f6020829595d125bec2) **index.html**: use new base template
## [0.7.0-dev.1] - 2026-03-08
### Features
- [`d7b1368`](https://github.com/pufereq/template-repo/commit/d7b136851bafa2c20e1634bd5568f4bac839177f) **client_details.html**: add temporary initial telemetry display
- [`7e9a9e6`](https://github.com/pufereq/template-repo/commit/7e9a9e6eede6cc926fef64c626434e65984befbc) **backend_server.py**: add `initial_telemetry` support
- [`6ed03ab`](https://github.com/pufereq/template-repo/commit/6ed03ab74de8e91d13b5f1971a3f4cec890e4fef) **client.py**: add `Client.initial_telemetry` property
- [`40c08d0`](https://github.com/pufereq/template-repo/commit/40c08d01693973f29f13c133a11fc5f166891a25) **initial_handler.py**: add handler for `TELEMETRY/INTIIAL` msgs
### Build
- [`3d13d24`](https://github.com/pufereq/template-repo/commit/3d13d241168b011c0044eb64db4b0fe70878d748) **uv.lock**: update judas_protocol to 0.9.1
- [`28b57b6`](https://github.com/pufereq/template-repo/commit/28b57b6964bfcd6ce78f2a77822f7221f6e4f7e5) **uv.lock**: update judas_protocol to 0.9.0
## [0.6.0] - 2026-03-05
### Bug Fixes
- [`fbb75c2`](https://github.com/pufereq/template-repo/commit/fbb75c263c13726d7e1c3fa28fb4e8f1f8cf0a17) **backend_server.py**: fix double-connection handling
- [`88d3490`](https://github.com/pufereq/template-repo/commit/88d349090e6e3605800656cc3e85779bf4b417c3) **backend_server.py**: fix double disconnect if client.inbound empty
- [`e308a07`](https://github.com/pufereq/template-repo/commit/e308a07dabcf20d9b080ce12a8928760dcde3057) **backend_server.py**: call `_initialize_handlers()` on init
- [`ead2224`](https://github.com/pufereq/template-repo/commit/ead22240660ff9f723c36ee35fa5918c33a0c66d) **backend_server.py**: do not disconnect a client if Exception raised on msg handling
- [`6446fe8`](https://github.com/pufereq/template-repo/commit/6446fe883cea4268992efc9f97cdb493af416576) **backend_server.py**: check if client to disconnect has an open socket
### Features
- [`72d51b4`](https://github.com/pufereq/template-repo/commit/72d51b451fc11ebe2f38d5e50bf263f9f441b03c) **backend_server.py**: add notice to known_clients.yaml
- [`0e7c948`](https://github.com/pufereq/template-repo/commit/0e7c9486683be4ceb91203109986f0b9fc83eb8b) **config/**: add `config/` directory
- [`97fc17f`](https://github.com/pufereq/template-repo/commit/97fc17fbb3ed5d681a4f5a0d488b7a2b09ab35df) **hello_handler.py**: remove client from `pending_hello` if recv'd HELLO
- [`f5b14fc`](https://github.com/pufereq/template-repo/commit/f5b14fc6109e83730c4b13aaecf6f4314c0136a4) **backend_server.py**: add timeout on HELLO
- [`bf1ad0e`](https://github.com/pufereq/template-repo/commit/bf1ad0ead0e4fc35c20d0d747cca05388b223d35) **ack_handler.py**: add handling for ACKs
- [`a9bace8`](https://github.com/pufereq/template-repo/commit/a9bace8acaab07e6e5d02155a9966c6381ad107e) **backend_server.py**: add `ACK_TIMEOUT` constant
- [`c88e39c`](https://github.com/pufereq/template-repo/commit/c88e39c7355b6f8c982198e6e56da2d09d17c61f) **backend_server.py**: track message ACKs and resend if no ACK recv'd within 5 seconds
- [`dafe418`](https://github.com/pufereq/template-repo/commit/dafe418916485258694949538eda151d7da33695) **backend_server.py**: add warning if received an unknown message (no handler)
- [`0ed478a`](https://github.com/pufereq/template-repo/commit/0ed478a88efa46f2f28b24371ad68010ecbf88d0) **backend_server.py**: implement message handling
- [`c952413`](https://github.com/pufereq/template-repo/commit/c952413d912b7a5d2000bc48c11a4d9274533caf) **hello_handler.py**: add HELLO message handler
- [`882c878`](https://github.com/pufereq/template-repo/commit/882c8780e15ec827fac1854cf7419b71d9a41a4f) **base_handler.py**: add `BaseHandler` class for message handling
- [`faecc38`](https://github.com/pufereq/template-repo/commit/faecc382610daf890c90074809085560931fd178) **client_status.py**: move `ClientStatus` enum to own module
### Miscellaneous Tasks
- [`61be674`](https://github.com/pufereq/template-repo/commit/61be674258dcce8a5b54efddb7d1d856c6cba9bc) remove `cache/` directory
- [`f46d271`](https://github.com/pufereq/template-repo/commit/f46d27164b79107abe405b221c9d424add55a723) **.gitignore**: ignore `config/known_clients.yaml` as it's generated automatically
- [`f13f243`](https://github.com/pufereq/template-repo/commit/f13f243b5b389d84acaa4ab933a234a00c6a981c) **__main__.py**: set logging level for werkzeug to WARNING
- [`332238b`](https://github.com/pufereq/template-repo/commit/332238b403782a08a8974b9267071f8d0ff5f006) **__init__.py**: correct version
- [`e54cc47`](https://github.com/pufereq/template-repo/commit/e54cc479b5f6bb3fb887803122fea0c551e27ee2) **handler/__init__.py**: add `AckHandler` to `__all__`
- [`ee38141`](https://github.com/pufereq/template-repo/commit/ee381414a931ed9d7562410e08c9de5cdc7b94e7) **backend_server.py**: remove redundant HELLO msg handling
- [`ec58a52`](https://github.com/pufereq/template-repo/commit/ec58a5257a3007a6edd502eb3967d92a9b652358) **handler/__init__.py**: add module init
- [`d3f68d3`](https://github.com/pufereq/template-repo/commit/d3f68d3baff8b903be125b0da7a88b415cd56bac) **backend/__init__.py**: add `Client` and `ClientStatus` to `__all__`
- [`bda10a6`](https://github.com/pufereq/template-repo/commit/bda10a6248478e99dfb42d8c605996cafdaf1e6e) **cache/**: add cache/ directory
### Refactor
- [`efbf99f`](https://github.com/pufereq/template-repo/commit/efbf99f356c20fbd48937f1c4e8df0a2d57f0651) **backend_server.py**: if known_clients.yaml not present, call `_save_known_clients()`
- [`35899d3`](https://github.com/pufereq/template-repo/commit/35899d366823c2878330eb06dc703f2965f61c3f) **backend_server.py**: move `known_clients.yaml` to `config/`
- [`3eb681e`](https://github.com/pufereq/template-repo/commit/3eb681e233fa151c2476581854c947bdc77b4900) **backend_server.py**: move loading known clients to its own method
- [`fa2da20`](https://github.com/pufereq/template-repo/commit/fa2da207a9cf3d90cdbfb5977033fee21d449528) **backend_server.py**: refactor calls to Message class constructors after protocol changes
### Styling
- [`62acc4b`](https://github.com/pufereq/template-repo/commit/62acc4b181cd359557909fa94f0cb0e6a4109255) **client.py**: correct property typing
### Build
- [`c64a258`](https://github.com/pufereq/template-repo/commit/c64a2582439e5ef1ab68bb9c588f7c4644bb4e07) **uv.lock**: update judas_protocol to 0.8.0
- [`f41a777`](https://github.com/pufereq/template-repo/commit/f41a7774ec5cb4997005ac8e31ed7bdc3541a8d6) **uv.lock**: update judas_protocol to 0.7.0
## [0.5.0] - 2026-02-28
### Features

View File

@@ -4,7 +4,7 @@ build-backend = "uv_build"
[project]
name = "judas_server"
version = "0.5.0"
version = "0.7.0"
description = "The backbone of the remote PC fleet management system."
readme = "README.md"
authors = []

View File

@@ -1 +1 @@
__version__: str = "0.1.0"
__version__: str = "0.5.0"

View File

@@ -12,6 +12,8 @@ if __name__ == "__main__":
format="%(asctime)s : [%(levelname)s] : %(threadName)s : %(name)s :: %(message)s",
)
lg.getLogger("werkzeug").setLevel(lg.WARNING)
ladygaga_logger = lg.getLogger(f"{__name__}.LAGA_DYGA")
ladygaga_logger.info(LADY_GAGA)

View File

@@ -6,13 +6,17 @@ import selectors
import socket
import threading
import time
from typing import TYPE_CHECKING, Any
from typing import TYPE_CHECKING, Any, Final
from judas_protocol.types import TelemetryAction
import yaml
from judas_protocol import Category, ControlAction, Message
from judas_server.backend.client import Client, ClientStatus
from judas_server.backend.handler.hello_handler import HelloHandler
from judas_server.backend.handler.telemetry.initial_handler import (
InitialTelemetryHandler,
)
if TYPE_CHECKING:
from typing import Callable
@@ -21,6 +25,9 @@ if TYPE_CHECKING:
class BackendServer:
ACK_TIMEOUT: Final[float] = 5.0 # seconds
HELLO_TIMEOUT: Final[float] = 3.0 # seconds
def __init__(self, host: str = "0.0.0.0", port: int = 3692) -> None:
"""Initialize the backend server.
@@ -46,32 +53,40 @@ class BackendServer:
)
self.clients: dict[str, Client] = {}
self.known_clients: dict[str, dict[str, str | float]] = (
self._load_known_clients()
)
self.known_clients: dict[str, dict[str, str | float]] = {}
self.known_clients = self._load_known_clients()
self.message_handlers: dict[
tuple[Category, ActionType], Callable[[Client, Message], None]
] = {}
self._initialize_handlers()
self.pending_acks: list[tuple[Client, Message, float]] = []
self.pending_hello: dict[Client, float] = {}
self.running: bool = False
def _initialize_handlers(self) -> None:
"""Initialize message handlers."""
hello_handler = HelloHandler(self)
initial_telemetry_handler = InitialTelemetryHandler(self)
self.message_handlers[(Category.CONTROL, ControlAction.HELLO)] = (
hello_handler.handle
)
self.message_handlers[
(Category.TELEMETRY, TelemetryAction.INITIAL)
] = initial_telemetry_handler.handle
def _load_known_clients(self) -> dict[str, dict[str, str | float]]:
"""Load the list of known clients from a YAML file and validate."""
known_clients: dict[str, dict[str, str | float]] = {}
try:
with open("cache/known_clients.yaml", "r") as f:
with open("config/known_clients.yaml", "r") as f:
data = yaml.safe_load(f)
if not isinstance(data, dict):
@@ -102,14 +117,16 @@ class BackendServer:
client.last_seen = float(
known_clients[client_id].get("last_seen", 0.0)
)
client.initial_telemetry = known_clients[client_id].get( # type: ignore
"initial_telemetry", None
)
self.clients[client_id] = client
except FileNotFoundError:
self.logger.warning(
"known_clients.yaml not found, creating empty known clients list"
)
with open("cache/known_clients.yaml", "w") as f:
yaml.safe_dump({"known_clients": {}}, f)
self._save_known_clients()
except Exception as e:
self.logger.error(f"Error loading known clients: {e}")
raise
@@ -118,7 +135,12 @@ class BackendServer:
def _save_known_clients(self) -> None:
"""Save the list of known clients to a YAML file."""
with open("cache/known_clients.yaml", "w") as f:
with open("config/known_clients.yaml", "w") as f:
f.write(
"# This file is automatically generated by BackendServer.\n"
+ "# Do not edit manually.\n"
+ f"# Generated at: {time.strftime('%Y-%m-%d %H:%M:%S', time.localtime())}\n\n"
)
yaml.safe_dump({"known_clients": self.known_clients}, f)
self.logger.debug("Saved known clients")
@@ -141,6 +163,22 @@ class BackendServer:
)
time.sleep(1)
def send(self, client: Client, msg: Message) -> None:
"""Send a message to a client.
Args:
client (Client): The client to send the message to.
msg (Message): The message to send.
"""
msg_bytes: bytes = msg.to_bytes()
self.logger.info(
f"[>] Sending message {msg.id} to {client}, category: {msg.category}, action: {msg.action}, ack_required: {msg.ack_required}"
)
self.logger.debug(f"[>] Message bytes: {msg_bytes!r}")
if msg.ack_required:
self.pending_acks.append((client, msg, time.time()))
client.outbound += msg_bytes
def send_ack(self, client: Client, target_id: str) -> None:
"""Send an ACK message to a client.
@@ -148,9 +186,9 @@ class BackendServer:
client (Client): The client to send the ACK to.
target_id (str): The id of the ACK'd message.
"""
ack: bytes = Message.Control.ack(target_id=target_id).to_bytes()
ack: Message = Message.Control.ack(target_id=target_id)
self.logger.info(f"[>] Sending ACK to {client}")
client.outbound += ack
self.send(client, ack)
def send_close(self, client: Client) -> None:
"""Send a CLOSE message to a client.
@@ -158,9 +196,9 @@ class BackendServer:
Args:
client (Client): The client to send the CLOSE message to.
"""
close_msg: bytes = Message.Control.close().to_bytes()
close_msg: Message = Message.Control.close()
self.logger.info(f"[>] Sending CLOSE to {client}")
client.outbound += close_msg
self.send(client, close_msg)
def _accept_connection(self, sock: socket.socket) -> None:
"""Accept a new client connection.
@@ -176,6 +214,8 @@ class BackendServer:
events = selectors.EVENT_READ | selectors.EVENT_WRITE
self.selector.register(conn, events, data=client)
self.pending_hello[client] = time.time()
self.logger.info(f"[+] Registered client {client}, HELLO pending...")
def _disconnect(self, client: Client) -> None:
@@ -186,7 +226,7 @@ class BackendServer:
"""
self.logger.info(f"[-] Disconnecting {client}...")
if client.socket is None:
if client.socket is None or client.socket._closed:
self.logger.warning(
f"Client {client} has no socket, nothing to disconnect."
)
@@ -250,9 +290,6 @@ class BackendServer:
try:
if mask & selectors.EVENT_READ:
self._receive_inbound(sock, client)
if not client.inbound:
self._disconnect(client)
return
while b"\n" in client.inbound:
line, client.inbound = client.inbound.split(b"\n", 1)
@@ -335,6 +372,25 @@ class BackendServer:
and now - client.last_seen > 60 * 60 * 24 # 24 hours
):
self.clients[client.id].status = ClientStatus.STALE
# check pending ACKs
for client, msg, timestamp in self.pending_acks[:]:
if time.time() - timestamp > self.ACK_TIMEOUT:
self.logger.warning(
f"ACK timeout for message {msg.id} to {client}, resending..."
)
self.send(client, msg)
self.pending_acks.remove((client, msg, timestamp))
# check pending HELLOs
for client, timestamp in list(self.pending_hello.items()):
if time.time() - timestamp > self.HELLO_TIMEOUT:
self.logger.warning(
f"HELLO timeout for {client}, disconnecting..."
)
self._disconnect(client)
del self.pending_hello[client]
time.sleep(0.001) # prevent 100% CPU usage
except Exception as e:
@@ -355,4 +411,5 @@ class BackendServer:
"addr": client.addr,
"last_seen": client.last_seen,
"status": client.status,
"initial_telemetry": client.initial_telemetry,
}

View File

@@ -6,6 +6,7 @@ from __future__ import annotations
import logging as lg
import socket
import time
from typing import Any
from judas_server.backend.client_status import ClientStatus
@@ -41,6 +42,8 @@ class Client:
self.inbound: bytes = b""
self.outbound: bytes = b""
self.initial_telemetry: dict[str, Any] | None = None
def __str__(self) -> str:
if self.addr:
return f"Client({self.id} ({self.addr[0]}:{self.addr[1]}))"

View File

@@ -1,4 +1,5 @@
from .base_handler import BaseHandler
from .hello_handler import HelloHandler
from .ack_handler import AckHandler
__all__ = ["BaseHandler", "HelloHandler"]
__all__ = ["BaseHandler", "HelloHandler", "AckHandler"]

View File

@@ -0,0 +1,28 @@
# -*- coding: utf-8 -*-
from __future__ import annotations
from typing import TYPE_CHECKING
from .base_handler import BaseHandler
if TYPE_CHECKING:
from judas_protocol import Message
from judas_server.backend import BackendServer, Client
class AckHandler(BaseHandler):
def __init__(self, backend_server: BackendServer) -> None:
super().__init__(backend_server)
def handle(self, client: Client, message: Message) -> None:
pending_acks = self.backend_server.pending_acks
if message.id in pending_acks:
del pending_acks[message.id]
self.logger.debug(
f"[*] Received ACK for message {message.id} from {client}."
)
else:
self.logger.warning(
f"[!] Received ACK for unknown (or ACK'd) message {message.id} from {client}."
)

View File

@@ -44,7 +44,8 @@ class HelloHandler(BaseHandler):
# check if client already connected, if so disconnect old client and register new one
if (
client.id in self.backend_server.clients
and self.backend_server.clients[client.id].status == "connected"
and self.backend_server.clients[client.id].status
== ClientStatus.ONLINE
):
old_client: Client = self.backend_server.clients[client.id]
self.backend_server.logger.warning(
@@ -58,6 +59,7 @@ class HelloHandler(BaseHandler):
"last_seen": client.last_seen
}
del self.backend_server.pending_hello[client]
self.backend_server._save_known_clients()
client.status = ClientStatus.ONLINE

View File

@@ -0,0 +1,33 @@
# -*- coding: utf-8 -*-
"""Initial telemetry handler."""
from __future__ import annotations
from typing import TYPE_CHECKING
from judas_protocol import Message
from judas_server.backend.handler.base_handler import BaseHandler
if TYPE_CHECKING:
from judas_server.backend import BackendServer
from judas_server.backend.client import Client
class InitialTelemetryHandler(BaseHandler):
"""Handles the initial telemetry message from a client."""
def __init__(self, backend_server: BackendServer) -> None:
"""Initialize the handler."""
super().__init__(backend_server)
def handle(self, client: Client, message: Message) -> None:
"""Handle the initial telemetry message."""
self.logger.debug(
f"Handling initial telemetry message from {client}..."
)
client.initial_telemetry = message.payload
self.backend_server.known_clients[client.id]["initial_telemetry"] = ( # type: ignore
message.payload
)

View File

@@ -16,6 +16,7 @@ body {
background-color: var(--ctp-base);
font-family: sans-serif;
color: var(--ctp-text);
min-height: 100vh;
}
.fi {
@@ -62,15 +63,13 @@ main {
aside {
width: 20rem;
background-color: var(--ctp-base);
border-right: 2px solid var(--ctp-mantle);
border-right: 4px solid var(--ctp-mantle);
}
#content {
display: flex;
flex-direction: column;
gap: 1rem;
flex-grow: 1;
padding: 1rem;
}
header a {

View File

@@ -0,0 +1,163 @@
$(document).ready(function () {
const socket = io();
const showNotify = (message) => {
$("#notify").stop().fadeIn();
$("#notify").text(message);
setTimeout(() => {
$("#notify").fadeOut();
}, 3000);
};
const loadClientDetails = (clientId) => {
fetch(`/client/${clientId}`)
.then((response) => response.text())
.then((html) => {
$("#content").html(html);
})
.catch((error) => {
console.error("Error fetching client details:", error);
});
};
// load client_details for the client specified in the URL
const urlParams = new URLSearchParams(window.location.search);
const clientId = urlParams.get("client");
if (clientId) {
loadClientDetails(clientId);
$(`#client-list a[href="?client=${clientId}"]`).addClass("active");
}
$("#notify").hide();
socket.on("connect", () => {
console.log("Connected to server");
$("#no-connection-message").hide();
showNotify("Connected to server");
});
socket.on("disconnect", () => {
console.log("Disconnected from server");
$("#no-connection-message").show();
showNotify("Disconnected from server");
});
socket.on("update_data", (data) => {
const clientList = $("#client-list");
const existingItems = {};
// Index current <li> by clientId
clientList.children("li").each(function () {
const a = $(this).find("a");
if (a.length) {
const clientId = a.attr("href").substring(1);
existingItems[clientId] = $(this);
}
});
// Track which clientIds are still present
const seen = new Set();
Object.entries(data).forEach(([clientId, client]) => {
seen.add(clientId);
// Build icon
const iconElement = document.createElement("i");
switch (client.status) {
case "online":
iconElement.className = "fi fi-sr-play text-ctp-green";
break;
case "offline":
iconElement.className = "fi fi-sr-stop text-ctp-red";
break;
case "pending":
iconElement.className = "fi fi-sr-pending text-ctp-yellow";
break;
case "stale":
iconElement.className = "fi fi-sr-skull text-ctp-text";
break;
default:
iconElement.className = "fi fi-rr-question text-ctp-gray";
}
// Time since last seen
const lastSeen = new Date(client.last_seen * 1000);
const now = new Date();
const timeSinceLastSeen = Math.floor((now - lastSeen) / 1000);
const days = Math.floor(timeSinceLastSeen / 86400);
const hours = Math.floor((timeSinceLastSeen % 86400) / 3600);
const minutes = Math.floor((timeSinceLastSeen % 3600) / 60);
const seconds = timeSinceLastSeen % 60;
let timeSinceLastSeenText = "";
if (days > 0) timeSinceLastSeenText += `${days}d `;
if (hours > 0) timeSinceLastSeenText += `${hours}h `;
if (minutes > 0) timeSinceLastSeenText += `${minutes}m `;
if (seconds > 0) timeSinceLastSeenText += `${seconds}s`;
timeSinceLastSeenText = timeSinceLastSeenText.trim() || "0s";
let statusText = `${client.id} (${timeSinceLastSeenText})`;
// check if <li> exists
if (existingItems[clientId]) {
// update if needed
const li = existingItems[clientId];
const a = li.find("a");
if (a.text() !== statusText) {
a.text(statusText);
}
li.attr(
"title",
`Status: ${client.status}\nLast Seen: ${lastSeen.toISOString()}`,
);
// update icon
const icon = li.find("i")[0];
if (icon) {
icon.className = iconElement.className;
}
} else {
// add new <li>
const li = $("<li></li>");
li.append(iconElement);
const a = $("<a></a>")
.text(statusText)
.attr("href", `?client=${clientId}`);
li.attr(
"title",
`Status: ${client.status}\nLast Seen: ${lastSeen.toISOString()}`,
);
li.append(a);
clientList.append(li);
}
});
// Remove <li> for clients no longer present
Object.keys(existingItems).forEach((clientId) => {
if (!seen.has(clientId)) {
existingItems[clientId].remove();
}
});
// Re-bind click handlers
$("#client-list li > a")
.off("click")
.on("click", function (e) {
let clientId = $(this).attr("href").substring(1);
// this is client=clientId
clientId = clientId.replace("client=", "");
loadClientDetails(clientId);
$("#client-list a").removeClass("bg-ctp-surface0");
$(this).addClass("bg-ctp-surface0");
e.preventDefault();
let newUrl = `${window.location.pathname}?client=${clientId}`;
window.history.pushState({ path: newUrl }, "", newUrl);
});
});
});

View File

@@ -0,0 +1,39 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>{% block title %}{% endblock %} judas</title>
<link
rel="stylesheet"
href="{{ url_for('static', filename='css/style.css') }}"
/>
<link rel="stylesheet" href="https://cdn-uicons.flaticon.com/2.6.0/uicons-regular-rounded/css/uicons-regular-rounded.css" />
<link rel="stylesheet" href="https://cdn-uicons.flaticon.com/2.6.0/uicons-regular-straight/css/uicons-regular-straight.css" />
<link rel="stylesheet" href="https://cdn-uicons.flaticon.com/2.6.0/uicons-solid-rounded/css/uicons-solid-rounded.css" />
<link rel="stylesheet" href="https://cdn-uicons.flaticon.com/2.6.0/uicons-solid-straight/css/uicons-solid-straight.css" />
<link rel="stylesheet" href="https://cdn-uicons.flaticon.com/2.6.0/uicons-bold-rounded/css/uicons-bold-rounded.css" />
<script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
<script src="https://cdn.socket.io/4.8.1/socket.io.min.js"></script>
<script>
const socket = io();
socket.on("connect", () => {
console.log("Connected to server");
$("#no-connection-message").hide();
});
socket.on("disconnect", () => {
console.log("Disconnected from server");
$("#no-connection-message").show();
});
</script>
</head>
<body>
{% include "base/header.html" %}
<!-- -->
{% block content %}{% endblock %}
<!-- -->
{% block scripts %}{% endblock %}
</body>
</html>

View File

@@ -0,0 +1,13 @@
<header class="flex items-center justify-between px-4 py-2 bg-ctp-crust">
<h2 class="text-2xl font-bold font-mono text-ctp-blue"><a href="{{ url_for('index.index') }}">judas</a></h2>
<p id="no-connection-message" class="flex align-center justify-center gap-2 text-ctp-red">
<i class="fi fi-rr-link-slash text-xl"></i>
<span> No connection to server </span>
</p>
{% if current_user.is_authenticated %}
<a class="btn-primary" href="{{ url_for('auth.logout') }}">Logout</a>
{% else %}
<a class="button" href="{{ url_for('auth.login') }}">Login</a>
{% endif %}
</header>

View File

@@ -1,24 +1,26 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Details for client {{ client.id }}</title>
<link
rel="stylesheet"
href="{{ url_for('static', filename='css/style.css') }}"
/>
</head>
<body>
<div class="details-header">
<p>Machine {{ client.id }}</p>
</div>
<div class="details-container">
<div class="details-sidebar">
<ul>
<li>
<a href="?tab=summary">
<i class="fi fi-ss-summary-check"></i>
<span>Summary</span>
</a>
</li>
</ul>
</div>
<div class="details-content">
<h1>Details for client {{ client.id }}</h1>
<p><strong>ID:</strong> {{ client.id }}</p>
<p><strong>IP Address:</strong> {{ client.addr[0] }}</p>
<p><strong>Port:</strong> {{ client.addr[1] }}</p>
<p>
<strong>Last Seen:</strong>
<span id="last-seen">{{ client.last_seen }}</span>
</p>
</body>
</div>
</div>
<script>
function updateLastSeen() {
@@ -28,6 +30,17 @@
lastSeenElement.textContent = lastSeenDate.toLocaleString();
}
$(".details-sidebar > ul > li > a").click(function (e) {
e.preventDefault();
const tab = $(this).attr("href").split("=")[1];
const urlParams = new URLSearchParams(window.location.search);
urlParams.set("tab", tab);
window.history.pushState(
{},
"",
`${window.location.pathname}?${urlParams}`,
);
});
updateLastSeen();
</script>
</html>

View File

@@ -1,37 +1,24 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>judas</title>
<link rel="stylesheet" href="{{ url_for('static', filename='css/style.css') }}">
</head>
<body>
<div id="wrapper">
<header>
<h2><a href="{{ url_for('index.index') }}">judas</a></h2>
{% if logged %}
<p><a class="button" href="{{ url_for('auth.logout') }}">Logout</a></p>
{% else %}
<p><a class="button" href="{{ url_for('auth.login') }}">Login</a></p>
{% endif %}
</header>
<main class="center">
<div id="content">
<div>
{% extends "base/base.html" %}
{% block title %}home{% endblock %}
{% block content %}
<div id="content" class="center">
<div style="margin-top: 2rem">
<p>Welcome to</p>
<h2 id="typing-text" style="font-size: 3rem;">judas</h2>
<h2 id="typing-text" style="font-size: 3rem">judas</h2>
<p>a remote PC fleet management system</p>
</div>
<p style="color: var(--ctp-red);"><strong>Notice:</strong> Please use this system responsibly and in accordance with all applicable laws and organizational policies.</p>
<p style="color: var(--ctp-red)"><strong>Notice:</strong> Please use this system responsibly and in accordance with all applicable laws and organizational policies.</p>
{% if logged %}
<p><a class="button" href="{{ url_for('panel.panel') }}">Go to panel</a></p>
{% else %}
<p>Please <a href="{{ url_for('auth.login')}}" class="link">log in</a> to manage your remote PCs.</p>
{% endif %}
</div>
</main>
</div>
{% endblock %}
{% block scripts %}
<script>
var i = 0;
var txt = document.getElementById("typing-text").innerHTML;
@@ -52,5 +39,4 @@
typeWriter();
</script>
</body>
</html>
{% endblock %}

View File

@@ -1,203 +1,16 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>judas panel</title>
<link
rel="stylesheet"
href="{{ url_for('static', filename='css/style.css') }}"
/>
<script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
<script src="https://cdn.socket.io/4.8.1/socket.io.min.js"></script>
<script>
$(document).ready(function () {
const socket = io();
{% extends "base/base.html" %}
const showNotify = (message) => {
$("#notify").stop().fadeIn();
$("#notify").text(message);
setTimeout(() => {
$("#notify").fadeOut();
}, 3000);
};
{% block title %}panel{% endblock %}
const loadClientDetails = (clientId) => {
fetch(`/client/${clientId}`)
.then((response) => response.text())
.then((html) => {
$("#content").html(html);
})
.catch((error) => {
console.error("Error fetching client details:", error);
});
};
// load client_details for the client specified in the URL hash
const hash = window.location.hash;
if (hash) {
const clientId = hash.substring(1);
loadClientDetails(clientId);
}
$("#notify").hide();
socket.on("connect", () => {
console.log("Connected to server");
$("#no-connection-message").hide();
showNotify("Connected to server");
});
socket.on("disconnect", () => {
console.log("Disconnected from server");
$("#no-connection-message").show();
showNotify("Disconnected from server");
});
socket.on("update_data", (data) => {
const clientList = $("#client-list");
const existingItems = {};
// Index current <li> by clientId
clientList.children("li").each(function () {
const a = $(this).find("a");
if (a.length) {
const clientId = a.attr("href").substring(1);
existingItems[clientId] = $(this);
}
});
// Track which clientIds are still present
const seen = new Set();
Object.entries(data).forEach(([clientId, client]) => {
seen.add(clientId);
// Build icon
const iconElement = document.createElement("i");
switch (client.status) {
case "online":
iconElement.className = "fi fi-sr-play";
iconElement.style.color = "var(--ctp-green)";
break;
case "offline":
iconElement.className = "fi fi-sr-stop";
iconElement.style.color = "var(--ctp-red)";
break;
case "pending":
iconElement.className = "fi fi-sr-pending";
iconElement.style.color = "var(--ctp-yellow)";
break;
case "stale":
iconElement.className = "fi fi-sr-skull";
iconElement.style.color = "var(--ctp-orange)";
break;
default:
iconElement.className = "fi fi-rr-question";
iconElement.style.color = "var(--ctp-gray)";
}
// Time since last seen
const lastSeen = new Date(client.last_seen * 1000);
const now = new Date();
const timeSinceLastSeen = Math.floor((now - lastSeen) / 1000);
const days = Math.floor(timeSinceLastSeen / 86400);
const hours = Math.floor((timeSinceLastSeen % 86400) / 3600);
const minutes = Math.floor((timeSinceLastSeen % 3600) / 60);
const seconds = timeSinceLastSeen % 60;
let timeSinceLastSeenText = "";
if (days > 0) timeSinceLastSeenText += `${days}d `;
if (hours > 0) timeSinceLastSeenText += `${hours}h `;
if (minutes > 0) timeSinceLastSeenText += `${minutes}m `;
if (seconds > 0) timeSinceLastSeenText += `${seconds}s`;
timeSinceLastSeenText = timeSinceLastSeenText.trim() || "0s";
let statusText = `${client.id} (${timeSinceLastSeenText})`;
// check if <li> exists
if (existingItems[clientId]) {
// update if needed
const li = existingItems[clientId];
const a = li.find("a");
if (a.text() !== statusText) {
a.text(statusText);
}
li.attr(
"title",
`Status: ${client.status}\nLast Seen: ${lastSeen.toISOString()}`,
);
// update icon
const icon = li.find("i")[0];
if (icon) {
icon.className = iconElement.className;
icon.style.color = iconElement.style.color;
}
} else {
// add new <li>
const li = $("<li></li>");
li.append(iconElement);
const a = $("<a></a>")
.text(statusText)
.attr("href", `#${clientId}`);
li.attr(
"title",
`Status: ${client.status}\nLast Seen: ${lastSeen.toISOString()}`,
);
li.append(a);
clientList.append(li);
}
});
// Remove <li> for clients no longer present
Object.keys(existingItems).forEach((clientId) => {
if (!seen.has(clientId)) {
existingItems[clientId].remove();
}
});
// Re-bind click handlers
$("#client-list li > a")
.off("click")
.on("click", function (e) {
const href = $(this).attr("href");
if (href.startsWith("#")) {
const clientId = href.substring(1);
loadClientDetails(clientId);
$("#client-list li > a").removeClass("active");
$(this).addClass("active");
}
});
if (window.location.hash) {
const clientId = window.location.hash.substring(1);
loadClientDetails(clientId);
}
});
});
</script>
</head>
<body>
<div id="wrapper">
<header>
<h2><a href="{{ url_for('index.index') }}">judas</a></h2>
<p id="no-connection-message">
<i class="fi fi-rr-link-slash"></i>
<span> No connection to server </span>
</p>
<a class="button" href="{{ url_for('auth.logout') }}">Logout</a>
</header>
<div id="notify"></div>
<main>
<aside>
{% block content %}
<main class="flex grow h-full">
<aside class="border-r-4 border-r-ctp-mantle">
<ul id="client-list"></ul>
</aside>
<div id="content"></div>
<div id="content" class="grow"></div>
</main>
</div>
</body>
</html>
{% endblock %}
{% block scripts %}
<script src="{{ url_for('static', filename='js/panel.js') }}"></script>
{% endblock %}

View File

@@ -68,7 +68,9 @@ class JudasWebServer:
self.app.register_blueprint(client_details.bp)
api.emit_polled_data(self.app, self.socketio)
def run(self, host: str = "0.0.0.0", port: int = 5000) -> None:
def run(
self, host: str = "0.0.0.0", port: int = 5000, debug: bool = False
) -> None:
self.logger.info(f"Starting web server on {host}:{port}...")
self.socketio.run(app=self.app, host=host, port=port)
self.socketio.run(app=self.app, host=host, port=port, debug=debug)
self.logger.info("Server stopped.")

6
uv.lock generated
View File

@@ -358,12 +358,12 @@ wheels = [
[[package]]
name = "judas-protocol"
version = "0.8.0"
source = { git = "https://gitea.pufereq.pl/judas/judas_protocol.git#a805ccf38edffadc1b8c8b276e60758c86516cd3" }
version = "0.9.1"
source = { git = "https://gitea.pufereq.pl/judas/judas_protocol.git#085c34f232f95313d66db48a7d17bc25c92a35ae" }
[[package]]
name = "judas-server"
version = "0.5.0"
version = "0.7.0"
source = { editable = "." }
dependencies = [
{ name = "flask" },