A peer is a named reference to another LibrePortal instance. Phase 2 only
implements kind=backup-channel (friendly label over a hostname that shows
up in a shared backup repo); direct-ssh-direct and direct-ssh-via-relay
(Connect's blind-relay) are reserved enum values for Phase 3.
DB schema (db_create_tables.sh):
CREATE TABLE peers (
id INTEGER PRIMARY KEY AUTOINCREMENT,
name TEXT UNIQUE NOT NULL,
kind TEXT NOT NULL DEFAULT 'backup-channel',
config_json TEXT NOT NULL DEFAULT '{}',
status TEXT DEFAULT 'unknown',
last_seen TEXT,
created_at TEXT DEFAULT CURRENT_TIMESTAMP
);
+ indexes on name and kind.
config_json is kind-specific so new transports don't need a schema
migration. For backup-channel it carries {"hostname":"","loc_idx":N}.
Bash module (scripts/peer/):
peer_helpers.sh _peerDb, peerSqlEscape, peerValidateName/Kind.
peer_add.sh peerAdd <name> <kind> [k=v ...] → INSERT, refresh
generator. Rejects unimplemented kinds early so users
don't create dead-end peer records.
peer_remove.sh peerRemove <name> → DELETE.
peer_list.sh peerList → JSON array; peerGet, peerNameForHostname
(reverse-lookup for the migrate-tab overlay).
peer_check.sh peerCheckReachable, peerCheckAll. For backup-channel
'reachable' = at least one snapshot from that hostname
visible in (preferred|any enabled) location. Updates
status + last_seen so UI dots render without re-probing.
CLI (scripts/cli/commands/peer/):
libreportal peer list
libreportal peer get <name>
libreportal peer add <name> backup-channel hostname=<host> [loc_idx=<n>]
libreportal peer remove <name>
libreportal peer check [name]
Auto-routed by cli_initialize.sh's category-discovery.
WebUI data generator (scripts/webui/data/generators/peers/webui_peers.sh):
Emits data/peers/generated/peers.json with the peerList output and a
generated_at envelope. Hooked into webuiLibrePortalUpdate alongside the
backup generators.
Frontend:
- New top-level /peers route in spa.js (PeersPage class, peers-content.html).
- 'Peers' nav item in the topbar between Backups and the right-side controls.
- Add-peer modal with friendly-name + kind + hostname + preferred-location
selector (populated from the existing backup-locations data).
- Per-peer card with status dot, last-checked time, Check + Remove buttons.
- Phase 3 kinds appear in the kind dropdown as disabled options so users
can see what's coming.
Source-array wiring:
- generate_arrays.sh auto-created files_peer.sh from the new peer/ dir.
- cli_files.sh + app_files.sh include ${peer_scripts[@]} alphabetically.
- files_webui.sh auto-picked-up the new peers/ generator subfolder.
The migrate-tab friendly-name overlay (use peer names in /backup/migrate
when a peer record exists for a hostname) is intentionally deferred — it's
a 5-line frontend lookup once peers.json is loaded; cleaner to add after
Phase 3 ships its peer-detail view.
Signed-off-by: librelad <librelad@digitalangels.vip>
64 lines
2.7 KiB
Bash
64 lines
2.7 KiB
Bash
#!/bin/bash
|
|
|
|
# List peers — JSON array, one row per peer. Used by the WebUI generator and
|
|
# the CLI's `libreportal peer list` command. Output is one line of JSON.
|
|
|
|
peerList()
|
|
{
|
|
local out='['
|
|
local first=1
|
|
local row
|
|
while IFS='|' read -r id name kind config_json status last_seen created_at; do
|
|
[[ -z "$id" ]] && continue
|
|
# Each field is sqlite-escaped (single-quote-doubled) and JSON-encoded
|
|
# on the way out — and config_json is already JSON so we paste it raw.
|
|
local name_e="${name//\\/\\\\}"; name_e="${name_e//\"/\\\"}"
|
|
local kind_e="${kind//\\/\\\\}"; kind_e="${kind_e//\"/\\\"}"
|
|
local status_e="${status//\\/\\\\}"; status_e="${status_e//\"/\\\"}"
|
|
local last_e="${last_seen//\\/\\\\}"; last_e="${last_e//\"/\\\"}"
|
|
local created_e="${created_at//\\/\\\\}"; created_e="${created_e//\"/\\\"}"
|
|
local cfg="${config_json:-{\}}"
|
|
|
|
(( first )) || out+=","
|
|
first=0
|
|
out+="{\"id\":$id,\"name\":\"$name_e\",\"kind\":\"$kind_e\",\"config\":$cfg,\"status\":\"$status_e\",\"last_seen\":\"$last_e\",\"created_at\":\"$created_e\"}"
|
|
done < <(sqlite3 "$(_peerDb)" "SELECT id, name, kind, config_json, COALESCE(status,''), COALESCE(last_seen,''), COALESCE(created_at,'') FROM peers ORDER BY name;" 2>/dev/null)
|
|
out+=']'
|
|
echo "$out"
|
|
}
|
|
|
|
peerGet()
|
|
{
|
|
local name="$1"
|
|
if [[ -z "$name" ]]; then echo "null"; return 1; fi
|
|
local row
|
|
row=$(sqlite3 "$(_peerDb)" "SELECT id, name, kind, config_json, COALESCE(status,''), COALESCE(last_seen,''), COALESCE(created_at,'') FROM peers WHERE name='$(peerSqlEscape "$name")';" 2>/dev/null)
|
|
[[ -z "$row" ]] && { echo "null"; return 1; }
|
|
|
|
local id n k cfg s last created
|
|
IFS='|' read -r id n k cfg s last created <<< "$row"
|
|
local name_e="${n//\\/\\\\}"; name_e="${name_e//\"/\\\"}"
|
|
local kind_e="${k//\\/\\\\}"; kind_e="${kind_e//\"/\\\"}"
|
|
printf '{"id":%s,"name":"%s","kind":"%s","config":%s,"status":"%s","last_seen":"%s","created_at":"%s"}\n' \
|
|
"$id" "$name_e" "$kind_e" "${cfg:-{\}}" "$s" "$last" "$created"
|
|
}
|
|
|
|
# Lookup peer name by hostname. Walks the backup-channel peers, parses their
|
|
# config.hostname, returns the matching peer name (or empty). Cheap; small N.
|
|
peerNameForHostname()
|
|
{
|
|
local hostname="$1"
|
|
[[ -z "$hostname" ]] && return 1
|
|
local row
|
|
while IFS='|' read -r name cfg; do
|
|
[[ -z "$name" ]] && continue
|
|
local h
|
|
h=$(printf '%s' "$cfg" | grep -o '"hostname":"[^"]*"' | head -1 | cut -d'"' -f4)
|
|
if [[ "$h" == "$hostname" ]]; then
|
|
echo "$name"
|
|
return 0
|
|
fi
|
|
done < <(sqlite3 "$(_peerDb)" "SELECT name, config_json FROM peers WHERE kind='backup-channel';" 2>/dev/null)
|
|
return 1
|
|
}
|