-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathweb_service.py
More file actions
352 lines (300 loc) · 11.8 KB
/
web_service.py
File metadata and controls
352 lines (300 loc) · 11.8 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
#!/usr/bin/env python3
"""
AdGuard Home Log Summary Web Service
Provides REST API endpoints for:
- Fetching logs from router
- Querying raw logs and aggregated summaries via DuckDB
"""
from pathlib import Path
from typing import Optional
from fastapi import FastAPI, Query, HTTPException
from fastapi.middleware.cors import CORSMiddleware
from fastapi.staticfiles import StaticFiles
from fastapi.responses import FileResponse
from pydantic import BaseModel
# Import database module
from database import (
init_database, query_client_summary,
query_domain_summary, query_base_domain_summary, get_database_stats,
delete_logs_before_date, delete_logs_by_domain,
add_ignored_domain, remove_ignored_domain, get_ignored_domains
)
# Load .env configuration
ENV_FILE = Path(__file__).parent / ".env"
def load_env() -> dict:
"""Load environment variables from .env file."""
env = {}
if ENV_FILE.exists():
with open(ENV_FILE, "r") as f:
for line in f:
line = line.strip()
if line and not line.startswith("#") and "=" in line:
key, value = line.split("=", 1)
env[key.strip()] = value.strip()
return env
ENV = load_env()
WEB_HOST = ENV.get("WEB_HOST", "0.0.0.0")
WEB_PORT = int(ENV.get("WEB_PORT", "8080"))
# Import functions from existing scripts
from fetch_logs import run_fetch
# Directories
SCRIPT_DIR = Path(__file__).parent
STATIC_DIR = SCRIPT_DIR / "static"
app = FastAPI(
title="AdGuard Home Log Summary API",
description="API for managing and querying AdGuard Home DNS logs",
version="2.0.0"
)
# Enable CORS for frontend
app.add_middleware(
CORSMiddleware,
allow_origins=["*"],
allow_credentials=True,
allow_methods=["*"],
allow_headers=["*"],
)
# Response models
class OperationResponse(BaseModel):
success: bool
message: str
class FetchResponse(OperationResponse):
entries_fetched: int = 0
class DeleteResponse(OperationResponse):
rows_deleted: int = 0
requests_deleted: int = 0
class IgnoredDomainRequest(BaseModel):
domain: str
notes: str = None
# Pagination defaults
DEFAULT_PAGE_SIZE = 500
MAX_PAGE_SIZE = 2000
# Initialize database on startup
@app.on_event("startup")
async def startup_event():
init_database()
# API Endpoints
@app.post("/api/update-logs", response_model=FetchResponse)
async def update_logs():
"""
Fetch new logs from the router.
Executes fetch_logs.py with confirmation bypassed.
"""
try:
result = run_fetch(skip_confirmation=True)
return FetchResponse(
success=result["success"],
message=result["message"],
entries_fetched=result["entries_fetched"]
)
except Exception as e:
raise HTTPException(status_code=500, detail=str(e))
@app.get("/api/stats")
async def get_stats():
"""Get database statistics."""
try:
stats = get_database_stats()
return stats
except Exception as e:
raise HTTPException(status_code=500, detail=str(e))
@app.get("/api/query-log-summary")
async def get_query_log_summary(
date: Optional[str] = Query(None, description="Date (exact match, YYYY-MM-DD)"),
date_from: Optional[str] = Query(None, description="Start date (YYYY-MM-DD)"),
date_to: Optional[str] = Query(None, description="End date (YYYY-MM-DD)"),
qh: Optional[str] = Query(None, description="Domain (wildcard search)"),
qt: Optional[str] = Query(None, description="Query type (wildcard search)"),
cp: Optional[str] = Query(None, description="Client protocol (exact match)"),
ip: Optional[str] = Query(None, description="IP address (exact match)"),
client: Optional[str] = Query(None, description="Client name (wildcard search)"),
is_filtered: Optional[bool] = Query(None, description="Filter status"),
filter_rule: Optional[str] = Query(None, description="Filter rule (wildcard search)"),
count_gte: Optional[int] = Query(None, description="Count >= value"),
count_lte: Optional[int] = Query(None, description="Count <= value"),
sort_by: str = Query("count", description="Column to sort by"),
sort_asc: bool = Query(False, description="Sort ascending"),
page: int = Query(1, ge=1, description="Page number"),
page_size: int = Query(DEFAULT_PAGE_SIZE, ge=1, le=MAX_PAGE_SIZE, description="Records per page"),
):
"""
Get client summary data (aggregated by Date/IP/Client/Domain/Type/Protocol/Filtered/FilterRule).
"""
try:
result = query_client_summary(
date=date,
date_from=date_from,
date_to=date_to,
ip=ip,
client=client,
domain=qh,
query_type=qt,
client_protocol=cp,
is_filtered=is_filtered,
filter_rule=filter_rule,
count_gte=count_gte,
count_lte=count_lte,
sort_by=sort_by,
sort_asc=sort_asc,
page=page,
page_size=page_size,
)
return result
except Exception as e:
raise HTTPException(status_code=500, detail=str(e))
@app.get("/api/domain-summary")
async def get_domain_summary(
date: Optional[str] = Query(None, description="Date (exact match, YYYY-MM-DD)"),
qh: Optional[str] = Query(None, description="Domain (wildcard search)"),
qt: Optional[str] = Query(None, description="Query type (exact match)"),
cp: Optional[str] = Query(None, description="Client protocol (exact match)"),
is_filtered: Optional[bool] = Query(None, description="Filter status"),
count_gte: Optional[int] = Query(None, description="Count >= value"),
count_lte: Optional[int] = Query(None, description="Count <= value"),
sort_by: str = Query("count", description="Column to sort by"),
sort_asc: bool = Query(False, description="Sort ascending"),
page: int = Query(1, ge=1, description="Page number"),
page_size: int = Query(DEFAULT_PAGE_SIZE, ge=1, le=MAX_PAGE_SIZE, description="Records per page"),
):
"""
Get domain summary data (aggregated by Date/Domain/Type/Protocol/Filtered).
Each row represents a unique combination of these fields with a count.
"""
try:
result = query_domain_summary(
date=date,
domain=qh,
query_type=qt,
client_protocol=cp,
is_filtered=is_filtered,
count_gte=count_gte,
count_lte=count_lte,
sort_by=sort_by,
sort_asc=sort_asc,
page=page,
page_size=page_size,
)
return result
except Exception as e:
raise HTTPException(status_code=500, detail=str(e))
@app.get("/api/base-domain-summary")
async def get_base_domain_summary(
qh: Optional[str] = Query(None, description="Base domain (wildcard search)"),
qt: Optional[str] = Query(None, description="Query type (exact match)"),
cp: Optional[str] = Query(None, description="Client protocol (exact match)"),
is_filtered: Optional[bool] = Query(None, description="Filter status"),
count_gte: Optional[int] = Query(None, description="Count >= value"),
count_lte: Optional[int] = Query(None, description="Count <= value"),
max_count_gte: Optional[int] = Query(None, description="Max count >= value"),
max_count_lte: Optional[int] = Query(None, description="Max count <= value"),
sort_by: str = Query("count", description="Column to sort by"),
sort_asc: bool = Query(False, description="Sort ascending"),
page: int = Query(1, ge=1, description="Page number"),
page_size: int = Query(DEFAULT_PAGE_SIZE, ge=1, le=MAX_PAGE_SIZE, description="Records per page"),
):
"""
Get base domain summary data (aggregated by BaseDomain/Type/Protocol/Filtered).
Includes total count and max count per day.
"""
try:
result = query_base_domain_summary(
domain=qh,
query_type=qt,
client_protocol=cp,
is_filtered=is_filtered,
count_gte=count_gte,
count_lte=count_lte,
max_count_gte=max_count_gte,
max_count_lte=max_count_lte,
sort_by=sort_by,
sort_asc=sort_asc,
page=page,
page_size=page_size,
)
return result
except Exception as e:
raise HTTPException(status_code=500, detail=str(e))
# Delete operations
@app.delete("/api/logs/before-date/{date}", response_model=DeleteResponse)
async def api_delete_logs_before_date(date: str):
"""Delete all log records before the specified date."""
try:
result = delete_logs_before_date(date)
return DeleteResponse(
success=True,
message=f"Deleted {result['rows_deleted']:,} rows ({result['requests_deleted']:,} requests) before {date}",
rows_deleted=result['rows_deleted'],
requests_deleted=result['requests_deleted']
)
except Exception as e:
raise HTTPException(status_code=500, detail=str(e))
@app.delete("/api/logs/by-domain/{domain:path}", response_model=DeleteResponse)
async def api_delete_logs_by_domain(domain: str):
"""Delete all log records matching the specified domain."""
try:
result = delete_logs_by_domain(domain)
return DeleteResponse(
success=True,
message=f"Deleted {result['rows_deleted']:,} rows ({result['requests_deleted']:,} requests) for domain '{domain}'",
rows_deleted=result['rows_deleted'],
requests_deleted=result['requests_deleted']
)
except Exception as e:
raise HTTPException(status_code=500, detail=str(e))
# Ignored domains management
@app.get("/api/ignored-domains")
async def api_get_ignored_domains(
search: Optional[str] = Query(None, description="Wildcard search filter")
):
"""Get list of all ignored domains."""
try:
domains = get_ignored_domains(search=search)
return {"domains": domains, "count": len(domains)}
except Exception as e:
raise HTTPException(status_code=500, detail=str(e))
@app.post("/api/ignored-domains", response_model=OperationResponse)
async def api_add_ignored_domain(request: IgnoredDomainRequest):
"""Add a domain to the ignore list."""
try:
success = add_ignored_domain(request.domain, request.notes)
if success:
return OperationResponse(
success=True,
message=f"Added '{request.domain}' to ignored domains"
)
else:
return OperationResponse(
success=False,
message=f"Domain '{request.domain}' already exists in ignored domains"
)
except Exception as e:
raise HTTPException(status_code=500, detail=str(e))
@app.delete("/api/ignored-domains/{domain:path}", response_model=OperationResponse)
async def api_remove_ignored_domain(domain: str):
"""Remove a domain from the ignore list."""
try:
success = remove_ignored_domain(domain)
if success:
return OperationResponse(
success=True,
message=f"Removed '{domain}' from ignored domains"
)
else:
return OperationResponse(
success=False,
message=f"Domain '{domain}' not found in ignored domains"
)
except Exception as e:
raise HTTPException(status_code=500, detail=str(e))
# Serve static files and frontend
@app.get("/")
async def serve_frontend():
"""Serve the main frontend page."""
index_path = STATIC_DIR / "index.html"
if not index_path.exists():
raise HTTPException(status_code=404, detail="Frontend not found")
return FileResponse(index_path)
# Mount static files directory
if STATIC_DIR.exists():
app.mount("/static", StaticFiles(directory=str(STATIC_DIR)), name="static")
if __name__ == "__main__":
import uvicorn
uvicorn.run(app, host=WEB_HOST, port=WEB_PORT)