mirror of
https://github.com/jkingsman/Remote-Terminal-for-MeshCore.git
synced 2026-08-11 03:03:03 +02:00
Add repeater region display. Closes #309.
This commit is contained in:
@@ -634,6 +634,35 @@ class RepeaterOwnerInfoResponse(BaseModel):
|
||||
guest_password: str | None = Field(default=None, description="Guest password")
|
||||
|
||||
|
||||
class RepeaterRegionEntry(BaseModel):
|
||||
"""One region from a repeater's region hierarchy dump."""
|
||||
|
||||
name: str = Field(description="Region name ('*' is the wildcard/global root)")
|
||||
depth: int = Field(description="Indentation depth in the hierarchy (0 = root)")
|
||||
flood_allowed: bool = Field(description="True if flood is allowed for this region")
|
||||
is_home: bool = Field(description="True if this is the repeater's home region")
|
||||
|
||||
|
||||
class RepeaterRegionsResponse(BaseModel):
|
||||
"""Region hierarchy and flood permissions from a repeater.
|
||||
|
||||
Primary source is the admin `region` CLI dump — an indented tree capped at
|
||||
~160 chars, so large region sets can be truncated (``truncated`` flags this).
|
||||
When the CLI is unavailable (e.g. guest access), ``source`` is ``"anon"`` and
|
||||
``regions`` is the guest-accessible anon request's flat list of flood-allowed
|
||||
region names only — no hierarchy, no blocked regions, no home marker. See
|
||||
issue #309.
|
||||
"""
|
||||
|
||||
regions: list[RepeaterRegionEntry] = Field(default_factory=list)
|
||||
raw: str | None = Field(default=None, description="Raw CLI dump text as received")
|
||||
truncated: bool = Field(default=False, description="True if the dump was likely truncated")
|
||||
source: Literal["cli", "anon"] | None = Field(
|
||||
default=None,
|
||||
description="'cli' = full admin hierarchy; 'anon' = guest flood-allowed names only",
|
||||
)
|
||||
|
||||
|
||||
class LppSensor(BaseModel):
|
||||
"""A single CayenneLPP sensor reading from req_telemetry_sync."""
|
||||
|
||||
|
||||
@@ -21,6 +21,8 @@ from app.models import (
|
||||
RepeaterNodeInfoResponse,
|
||||
RepeaterOwnerInfoResponse,
|
||||
RepeaterRadioSettingsResponse,
|
||||
RepeaterRegionEntry,
|
||||
RepeaterRegionsResponse,
|
||||
RepeaterStatusResponse,
|
||||
TelemetryHistoryEntry,
|
||||
)
|
||||
@@ -400,6 +402,141 @@ async def repeater_owner_info(public_key: str) -> RepeaterOwnerInfoResponse:
|
||||
return RepeaterOwnerInfoResponse(**results)
|
||||
|
||||
|
||||
# The firmware's `region` dump is written into a fixed ~160-char buffer
|
||||
# (CommonCLI::handleRegionCmd -> RegionMap::exportTo(reply, 160)), so large
|
||||
# region sets get truncated. Flag when the reply lands close to that ceiling.
|
||||
_REGION_DUMP_CAP = 160
|
||||
|
||||
|
||||
def _is_region_name(name: str) -> bool:
|
||||
"""Return True if ``name`` is a valid region name (or the wildcard ``*``).
|
||||
|
||||
Mirrors firmware ``RegionMap::is_name_char``: ``-``, ``$``, ``#``, digits, or
|
||||
any byte ``>= 'A'``. Crucially this excludes spaces, so a firmware that does
|
||||
not support regions (older than v1.10) and replies to `region` with
|
||||
``"Unknown command"`` is rejected here rather than mis-parsed as a region —
|
||||
which lets the endpoint fall back to the anon path or an empty result.
|
||||
"""
|
||||
if name == "*":
|
||||
return True
|
||||
if not name:
|
||||
return False
|
||||
return all(c in "-$#0123456789" or ord(c) >= 0x41 for c in name)
|
||||
|
||||
|
||||
def _parse_region_dump(text: str) -> tuple[list[RepeaterRegionEntry], bool]:
|
||||
"""Parse the repeater `region` CLI dump into a structured hierarchy.
|
||||
|
||||
Firmware emits an indented tree (``RegionMap::printChildRegions``), one entry
|
||||
per line: ``{depth spaces}{name}{^ if home}{ F if flood-allowed}``. The root
|
||||
is the wildcard ``*``. Absence of the trailing `` F`` means flood is denied.
|
||||
|
||||
Lines that are not valid region names are dropped, so an unsupported-command
|
||||
reply parses to no entries. Returns the parsed entries and a best-effort
|
||||
``truncated`` flag (the dump is capped at ~160 chars, and a complete dump
|
||||
ends every line with a newline).
|
||||
"""
|
||||
truncated = len(text) >= _REGION_DUMP_CAP - 2 or (
|
||||
text.strip() != "" and not text.endswith("\n")
|
||||
)
|
||||
entries: list[RepeaterRegionEntry] = []
|
||||
for line in text.split("\n"):
|
||||
if line.strip() == "":
|
||||
continue
|
||||
depth = len(line) - len(line.lstrip(" "))
|
||||
content = line.strip()
|
||||
flood_allowed = content.endswith(" F")
|
||||
if flood_allowed:
|
||||
content = content[:-2].rstrip()
|
||||
is_home = content.endswith("^")
|
||||
if is_home:
|
||||
content = content[:-1]
|
||||
name = content.strip()
|
||||
if not _is_region_name(name):
|
||||
continue
|
||||
entries.append(
|
||||
RepeaterRegionEntry(
|
||||
name=name, depth=depth, flood_allowed=flood_allowed, is_home=is_home
|
||||
)
|
||||
)
|
||||
return entries, truncated
|
||||
|
||||
|
||||
def _parse_anon_region_names(names: str) -> list[RepeaterRegionEntry]:
|
||||
"""Parse the anon regions request's comma-separated flood-allowed names.
|
||||
|
||||
``req_regions_sync`` returns the firmware's ``exportNamesTo(REGION_DENY_FLOOD)``
|
||||
output: a flat, comma-separated list of the region names where flood is
|
||||
*allowed* (``*`` is the wildcard). There is no hierarchy or blocked-region
|
||||
information in this guest-accessible view, so every entry is depth 0 and
|
||||
flood-allowed.
|
||||
"""
|
||||
entries: list[RepeaterRegionEntry] = []
|
||||
for raw_name in names.split(","):
|
||||
name = raw_name.strip().strip("\x00")
|
||||
if not name:
|
||||
continue
|
||||
entries.append(RepeaterRegionEntry(name=name, depth=0, flood_allowed=True, is_home=False))
|
||||
return entries
|
||||
|
||||
|
||||
async def _fetch_anon_flood_allowed_regions(contact: Contact) -> list[RepeaterRegionEntry] | None:
|
||||
"""Guest-accessible fallback: fetch flood-allowed region names via anon request.
|
||||
|
||||
Returns ``None`` when the repeater does not answer (older firmware, out of
|
||||
range) so the caller can leave the pane empty.
|
||||
"""
|
||||
async with radio_manager.radio_operation(
|
||||
"repeater_regions_anon", pause_polling=True, suspend_auto_fetch=True
|
||||
) as mc:
|
||||
await _ensure_on_radio(mc, contact)
|
||||
await asyncio.sleep(1.0) # settle after add_contact
|
||||
try:
|
||||
names = await mc.commands.req_regions_sync(
|
||||
contact.public_key, timeout=10, min_timeout=5
|
||||
)
|
||||
except Exception as exc:
|
||||
logger.debug("anon regions request failed for %s: %s", contact.public_key[:12], exc)
|
||||
return None
|
||||
|
||||
if not names:
|
||||
return None
|
||||
return _parse_anon_region_names(names)
|
||||
|
||||
|
||||
@router.post("/{public_key}/repeater/regions", response_model=RepeaterRegionsResponse)
|
||||
async def repeater_regions(public_key: str) -> RepeaterRegionsResponse:
|
||||
"""Fetch the repeater's region hierarchy and flood permissions.
|
||||
|
||||
Primary path is the admin CLI `region` dump (full hierarchy + allowed/blocked
|
||||
+ home; may be truncated by the firmware's ~160-char cap). When the CLI
|
||||
returns nothing — e.g. guest access, which cannot run CLI commands — it falls
|
||||
back to the guest-accessible anon regions request, which only yields a flat
|
||||
list of flood-allowed region names. See issue #309.
|
||||
"""
|
||||
radio_manager.require_connected()
|
||||
contact = await _resolve_contact_or_404(public_key)
|
||||
_require_repeater(contact)
|
||||
|
||||
results = await _batch_cli_fetch(contact, "repeater_regions", [("region", "regions")])
|
||||
raw = results.get("regions")
|
||||
entries, truncated = _parse_region_dump(raw or "")
|
||||
# The CLI dump always includes the wildcard root, so a non-empty result means
|
||||
# the CLI answered. Empty means no CLI reply (guest / timeout) -> try anon.
|
||||
if entries:
|
||||
return RepeaterRegionsResponse(regions=entries, raw=raw, truncated=truncated, source="cli")
|
||||
|
||||
anon_entries = await _fetch_anon_flood_allowed_regions(contact)
|
||||
if anon_entries is not None:
|
||||
return RepeaterRegionsResponse(
|
||||
regions=anon_entries, raw=raw, truncated=False, source="anon"
|
||||
)
|
||||
|
||||
# Nothing usable from either path (unsupported firmware, guest with no anon
|
||||
# support, or out of range) -> empty, not a truncated dump.
|
||||
return RepeaterRegionsResponse(regions=[], raw=raw, truncated=False, source="cli")
|
||||
|
||||
|
||||
@router.post("/{public_key}/command", response_model=CommandResponse)
|
||||
async def send_repeater_command(public_key: str, request: CommandRequest) -> CommandResponse:
|
||||
"""Send a CLI command to a repeater or room server."""
|
||||
|
||||
Reference in New Issue
Block a user