-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi.py
More file actions
528 lines (434 loc) · 15.2 KB
/
api.py
File metadata and controls
528 lines (434 loc) · 15.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
from contextlib import asynccontextmanager
from datetime import datetime, timezone
from pathlib import Path
import sqlite3
from threading import Event, Thread
from typing import Annotated, Any, Dict, List, Optional, Set
from fastapi import FastAPI, Header, HTTPException, Query
from fastapi.middleware.cors import CORSMiddleware
from fastapi.responses import FileResponse
from pydantic import BaseModel
from config import get_settings
from backend import RouterClient
from ingest import ingest_html_snapshot
from db import connect, init_db
STATE: Dict[str, Any] = {
"last_ingest": None,
"last_result": None,
"last_error": None,
"last_error_at": None,
"consecutive_failures": 0,
}
settings = get_settings()
FAVICON_PATH = Path(__file__).resolve().parent / "static" / "favicon.ico"
class DevicePatchRequest(BaseModel):
friendly_name: Optional[str] = None
category: Optional[str] = None
notes: Optional[str] = None
is_hidden: Optional[bool] = None
is_tracked: Optional[bool] = None
model_config = {"extra": "forbid"}
class HealthResponse(BaseModel):
ok: bool
last_ingest: Optional[str] = None
last_error: Optional[str] = None
last_error_at: Optional[str] = None
consecutive_failures: int
poll_seconds: int
class DeviceSnapshot(BaseModel):
mac: str
status: str
host_name: Optional[str] = None
dhcp_mode: Optional[str] = None
rssi_dbm: Optional[int] = None
connection_type: Optional[str] = None
ipv4: Optional[str] = None
ipv6_global: Optional[str] = None
ipv6_linklocal: Optional[str] = None
friendly_name: Optional[str] = None
category: Optional[str] = None
notes: Optional[str] = None
is_hidden: bool
is_tracked: bool
last_host_name: Optional[str] = None
first_seen: str
last_seen: str
display_name: str
groups: List[str] = []
class DevicesLatestResponse(BaseModel):
seen_at: str
count: int
devices: List[DeviceSnapshot]
class DeviceMetadataResponse(BaseModel):
mac: str
first_seen: str
last_seen: str
last_host_name: Optional[str] = None
notes: Optional[str] = None
friendly_name: Optional[str] = None
category: Optional[str] = None
is_hidden: bool
is_tracked: bool
display_name: str
class GroupSummary(BaseModel):
id: int
name: str
device_count: int = 0
class GroupsResponse(BaseModel):
count: int
groups: List[GroupSummary]
class GroupCreateRequest(BaseModel):
name: str
model_config = {"extra": "forbid"}
class GroupResponse(BaseModel):
id: int
name: str
class BulkGroupAssignRequest(BaseModel):
macs: List[str]
model_config = {"extra": "forbid"}
def require_token(x_token: Optional[str]) -> None:
if x_token != settings.api_token:
raise HTTPException(status_code=401, detail="bad token")
def now_iso_utc() -> str:
return datetime.now(timezone.utc).replace(microsecond=0).isoformat()
def poll_loop(stop_event: Event) -> None:
client = RouterClient(
settings.base_url,
settings.router_username,
settings.router_password,
connect_timeout_seconds=settings.router_connect_timeout_seconds,
read_timeout_seconds=settings.router_read_timeout_seconds,
fetch_retries=settings.router_fetch_retries,
retry_backoff_seconds=settings.router_retry_backoff_seconds,
)
while not stop_event.is_set():
try:
html = client.fetch_connected_devices_html()
result = ingest_html_snapshot(settings.db_path, html)
STATE["last_ingest"] = result.get("seen_at")
STATE["last_result"] = result
STATE["last_error"] = None
STATE["last_error_at"] = None
STATE["consecutive_failures"] = 0
except Exception as e:
STATE["last_error"] = str(e)
STATE["last_error_at"] = now_iso_utc()
STATE["consecutive_failures"] = (
int(STATE.get("consecutive_failures", 0)) + 1
)
failures = int(STATE.get("consecutive_failures", 0))
poll_delay = settings.poll_seconds
if failures > 1:
poll_delay = min(
settings.poll_seconds * failures,
settings.poll_backoff_max_seconds,
)
stop_event.wait(poll_delay)
@asynccontextmanager
async def lifespan(app: FastAPI):
stop_event = Event()
t = Thread(target=poll_loop, args=(stop_event,), daemon=True)
t.start()
try:
yield
finally:
stop_event.set()
t.join(timeout=2)
app = FastAPI(lifespan=lifespan)
app.add_middleware(
CORSMiddleware,
allow_origins=settings.cors_origins,
allow_credentials=True,
allow_methods=["*"],
allow_headers=["*"],
)
def normalize_mac(mac: str) -> str:
return mac.strip().upper()
def to_display_name(device: Dict[str, Any]) -> str:
return (
device.get("friendly_name")
or device.get("host_name")
or device.get("last_host_name")
or device["mac"]
)
def normalize_group_name(name: str) -> str:
normalized = name.strip()
if not normalized:
raise HTTPException(status_code=400, detail="group name cannot be blank")
return normalized
def fetch_group_ids_for_filter(conn, group_id: int, macs: Set[str]) -> Set[str]:
if not macs:
return set()
placeholders = ", ".join(["?"] * len(macs))
rows = conn.execute(
f"""
SELECT mac
FROM device_groups
WHERE group_id = ? AND mac IN ({placeholders})
""",
[group_id, *sorted(macs)],
).fetchall()
return {row["mac"] for row in rows}
def fetch_groups_by_mac(conn, macs: Set[str]) -> Dict[str, List[str]]:
if not macs:
return {}
placeholders = ", ".join(["?"] * len(macs))
rows = conn.execute(
f"""
SELECT dg.mac, g.name
FROM device_groups dg
JOIN groups g ON g.id = dg.group_id
WHERE dg.mac IN ({placeholders})
ORDER BY g.name
""",
sorted(macs),
).fetchall()
by_mac: Dict[str, List[str]] = {mac: [] for mac in macs}
for row in rows:
by_mac[row["mac"]].append(row["name"])
return by_mac
def fetch_latest_devices_payload(group_id: Optional[int] = None) -> Dict[str, Any]:
conn = connect(settings.db_path)
init_db(conn)
try:
if group_id is not None:
group_exists = conn.execute(
"SELECT 1 FROM groups WHERE id = ?", (group_id,)
).fetchone()
if not group_exists:
raise HTTPException(status_code=404, detail="group not found")
row = conn.execute(
"SELECT MAX(seen_at) AS seen_at FROM observations"
).fetchone()
if not row or not row["seen_at"]:
raise HTTPException(
status_code=503, detail=STATE["last_error"] or "no data yet"
)
seen_at = row["seen_at"]
devices = conn.execute(
"""
SELECT
o.mac, o.status, o.host_name, o.dhcp_mode, o.rssi_dbm, o.connection_type,
o.ipv4, o.ipv6_global, o.ipv6_linklocal,
d.friendly_name, d.category, d.notes, d.is_hidden, d.is_tracked,
d.last_host_name, d.first_seen, d.last_seen
FROM observations o
JOIN devices d ON d.mac = o.mac
WHERE o.seen_at = ?
ORDER BY o.status DESC, COALESCE(d.friendly_name, o.host_name, o.mac)
""",
(seen_at,),
).fetchall()
materialized = [dict(d) for d in devices]
macs = {d["mac"] for d in materialized}
groups_by_mac = fetch_groups_by_mac(conn, macs)
if group_id is not None:
allowed_macs = fetch_group_ids_for_filter(conn, group_id, macs)
materialized = [d for d in materialized if d["mac"] in allowed_macs]
finally:
conn.close()
for device in materialized:
device["is_hidden"] = bool(device["is_hidden"])
device["is_tracked"] = bool(device["is_tracked"])
device["display_name"] = to_display_name(device)
device["groups"] = groups_by_mac.get(device["mac"], [])
return {"seen_at": seen_at, "count": len(materialized), "devices": materialized}
@app.get("/health", response_model=HealthResponse)
def health():
return {
"ok": STATE["last_error"] is None,
"last_ingest": STATE["last_ingest"],
"last_error": STATE["last_error"],
"last_error_at": STATE["last_error_at"],
"consecutive_failures": STATE["consecutive_failures"],
"poll_seconds": settings.poll_seconds,
}
@app.get("/favicon.ico", include_in_schema=False)
def favicon():
if not FAVICON_PATH.exists():
raise HTTPException(status_code=404, detail="favicon not found")
return FileResponse(FAVICON_PATH)
@app.get("/devices/latest", response_model=DevicesLatestResponse)
def devices_latest(
x_token: Optional[str] = Header(default=None),
group_id: Annotated[Optional[int], Query(ge=1)] = None,
):
require_token(x_token)
return fetch_latest_devices_payload(group_id=group_id)
@app.get("/devices", response_model=DevicesLatestResponse)
def devices_list(
x_token: Optional[str] = Header(default=None),
group_id: Annotated[Optional[int], Query(ge=1)] = None,
):
require_token(x_token)
return fetch_latest_devices_payload(group_id=group_id)
@app.get("/groups", response_model=GroupsResponse)
def groups_list(x_token: Optional[str] = Header(default=None)):
require_token(x_token)
conn = connect(settings.db_path)
init_db(conn)
try:
groups = conn.execute(
"""
SELECT g.id, g.name, COUNT(dg.mac) AS device_count
FROM groups g
LEFT JOIN device_groups dg ON dg.group_id = g.id
GROUP BY g.id, g.name
ORDER BY g.name
"""
).fetchall()
finally:
conn.close()
payload = [dict(group) for group in groups]
return {"count": len(payload), "groups": payload}
@app.post("/groups", response_model=GroupResponse, status_code=201)
def groups_create(
group: GroupCreateRequest, x_token: Optional[str] = Header(default=None)
):
require_token(x_token)
name = normalize_group_name(group.name)
conn = connect(settings.db_path)
init_db(conn)
try:
try:
conn.execute("INSERT INTO groups(name) VALUES(?)", (name,))
conn.commit()
except sqlite3.IntegrityError as exc:
msg = str(exc).lower()
if "unique" in msg:
raise HTTPException(status_code=409, detail="group already exists")
raise
row = conn.execute(
"SELECT id, name FROM groups WHERE name = ?", (name,)
).fetchone()
finally:
conn.close()
return dict(row)
def require_device_exists(conn, mac_norm: str) -> None:
exists = conn.execute("SELECT 1 FROM devices WHERE mac = ?", (mac_norm,)).fetchone()
if not exists:
raise HTTPException(status_code=404, detail="device not found")
def require_group_exists(conn, group_id: int) -> None:
exists = conn.execute("SELECT 1 FROM groups WHERE id = ?", (group_id,)).fetchone()
if not exists:
raise HTTPException(status_code=404, detail="group not found")
@app.post("/devices/{mac}/groups/{group_id}", status_code=204)
def add_device_group(
mac: str,
group_id: int,
x_token: Optional[str] = Header(default=None),
):
require_token(x_token)
mac_norm = normalize_mac(mac)
conn = connect(settings.db_path)
init_db(conn)
try:
require_device_exists(conn, mac_norm)
require_group_exists(conn, group_id)
conn.execute(
"INSERT OR IGNORE INTO device_groups(mac, group_id) VALUES(?, ?)",
(mac_norm, group_id),
)
conn.commit()
finally:
conn.close()
@app.delete("/devices/{mac}/groups/{group_id}", status_code=204)
def remove_device_group(
mac: str,
group_id: int,
x_token: Optional[str] = Header(default=None),
):
require_token(x_token)
mac_norm = normalize_mac(mac)
conn = connect(settings.db_path)
init_db(conn)
try:
require_device_exists(conn, mac_norm)
require_group_exists(conn, group_id)
conn.execute(
"DELETE FROM device_groups WHERE mac = ? AND group_id = ?",
(mac_norm, group_id),
)
conn.commit()
finally:
conn.close()
@app.post("/groups/{group_id}/devices", status_code=204)
def bulk_assign_group(
group_id: int,
payload: BulkGroupAssignRequest,
x_token: Optional[str] = Header(default=None),
):
require_token(x_token)
macs = sorted({normalize_mac(mac) for mac in payload.macs})
if not macs:
raise HTTPException(status_code=400, detail="macs cannot be empty")
conn = connect(settings.db_path)
init_db(conn)
try:
require_group_exists(conn, group_id)
placeholders = ", ".join(["?"] * len(macs))
found = conn.execute(
f"SELECT mac FROM devices WHERE mac IN ({placeholders})", macs
).fetchall()
found_macs = {row["mac"] for row in found}
missing = [mac for mac in macs if mac not in found_macs]
if missing:
raise HTTPException(
status_code=404,
detail=f"device not found: {missing[0]}",
)
conn.executemany(
"INSERT OR IGNORE INTO device_groups(mac, group_id) VALUES(?, ?)",
[(mac, group_id) for mac in macs],
)
conn.commit()
finally:
conn.close()
@app.patch("/devices/{mac}", response_model=DeviceMetadataResponse)
def update_device(
mac: str, patch: DevicePatchRequest, x_token: Optional[str] = Header(default=None)
):
require_token(x_token)
raw_update_map = patch.model_dump(exclude_unset=True)
update_map: Dict[str, Any] = {}
for field, val in raw_update_map.items():
if field in ("is_hidden", "is_tracked"):
if val is None:
raise HTTPException(status_code=400, detail=f"{field} cannot be null")
update_map[field] = int(bool(val))
else:
update_map[field] = val
if not update_map:
raise HTTPException(status_code=400, detail="no fields to update")
mac_norm = normalize_mac(mac)
conn = connect(settings.db_path)
init_db(conn)
try:
exists = conn.execute(
"SELECT 1 FROM devices WHERE mac = ?", (mac_norm,)
).fetchone()
if not exists:
raise HTTPException(status_code=404, detail="device not found")
set_sql = ", ".join([f"{k} = ?" for k in update_map])
params = list(update_map.values()) + [mac_norm]
conn.execute(f"UPDATE devices SET {set_sql} WHERE mac = ?", params)
conn.commit()
row = conn.execute(
"""
SELECT
mac, first_seen, last_seen, last_host_name,
notes, friendly_name, category, is_hidden, is_tracked
FROM devices
WHERE mac = ?
""",
(mac_norm,),
).fetchone()
finally:
conn.close()
payload = dict(row)
payload["is_hidden"] = bool(payload["is_hidden"])
payload["is_tracked"] = bool(payload["is_tracked"])
payload["display_name"] = (
payload.get("friendly_name") or payload.get("last_host_name") or payload["mac"]
)
return payload