settings.py 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586
  1. import io
  2. import logging
  3. import zipfile
  4. from datetime import datetime
  5. from pathlib import Path
  6. from fastapi import APIRouter, Depends, File, UploadFile
  7. from fastapi.responses import JSONResponse, StreamingResponse
  8. from sqlalchemy import select
  9. from sqlalchemy.ext.asyncio import AsyncSession
  10. from backend.app.core.auth import RequirePermissionIfAuthEnabled
  11. from backend.app.core.config import settings as app_settings
  12. from backend.app.core.database import get_db
  13. from backend.app.core.permissions import Permission
  14. from backend.app.models.settings import Settings
  15. from backend.app.models.user import User
  16. from backend.app.schemas.settings import AppSettings, AppSettingsUpdate
  17. logger = logging.getLogger(__name__)
  18. router = APIRouter(prefix="/settings", tags=["settings"])
  19. # Default settings
  20. DEFAULT_SETTINGS = AppSettings()
  21. async def get_setting(db: AsyncSession, key: str) -> str | None:
  22. """Get a single setting value by key."""
  23. result = await db.execute(select(Settings).where(Settings.key == key))
  24. setting = result.scalar_one_or_none()
  25. return setting.value if setting else None
  26. async def set_setting(db: AsyncSession, key: str, value: str) -> None:
  27. """Set a single setting value."""
  28. from sqlalchemy import func
  29. from sqlalchemy.dialects.sqlite import insert as sqlite_insert
  30. # Use upsert (INSERT ... ON CONFLICT UPDATE) for reliability
  31. stmt = sqlite_insert(Settings).values(key=key, value=value)
  32. stmt = stmt.on_conflict_do_update(index_elements=["key"], set_={"value": value, "updated_at": func.now()})
  33. await db.execute(stmt)
  34. @router.get("", response_model=AppSettings)
  35. @router.get("/", response_model=AppSettings)
  36. async def get_settings(
  37. db: AsyncSession = Depends(get_db),
  38. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_READ),
  39. ):
  40. """Get all application settings."""
  41. settings_dict = DEFAULT_SETTINGS.model_dump()
  42. # Load saved settings from database
  43. result = await db.execute(select(Settings))
  44. db_settings = result.scalars().all()
  45. for setting in db_settings:
  46. if setting.key in settings_dict:
  47. # Parse the value based on the expected type
  48. if setting.key in [
  49. "auto_archive",
  50. "save_thumbnails",
  51. "capture_finish_photo",
  52. "spoolman_enabled",
  53. "check_updates",
  54. "check_printer_firmware",
  55. "virtual_printer_enabled",
  56. "ftp_retry_enabled",
  57. "mqtt_enabled",
  58. "mqtt_use_tls",
  59. "ha_enabled",
  60. "per_printer_mapping_expanded",
  61. "prometheus_enabled",
  62. ]:
  63. settings_dict[setting.key] = setting.value.lower() == "true"
  64. elif setting.key in [
  65. "default_filament_cost",
  66. "energy_cost_per_kwh",
  67. "ams_temp_good",
  68. "ams_temp_fair",
  69. "library_disk_warning_gb",
  70. ]:
  71. settings_dict[setting.key] = float(setting.value)
  72. elif setting.key in [
  73. "ams_humidity_good",
  74. "ams_humidity_fair",
  75. "ams_history_retention_days",
  76. "ftp_retry_count",
  77. "ftp_retry_delay",
  78. "mqtt_port",
  79. ]:
  80. settings_dict[setting.key] = int(setting.value)
  81. elif setting.key == "default_printer_id":
  82. # Handle nullable integer
  83. settings_dict[setting.key] = int(setting.value) if setting.value and setting.value != "None" else None
  84. else:
  85. settings_dict[setting.key] = setting.value
  86. return AppSettings(**settings_dict)
  87. @router.put("/", response_model=AppSettings)
  88. async def update_settings(
  89. settings_update: AppSettingsUpdate,
  90. db: AsyncSession = Depends(get_db),
  91. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_UPDATE),
  92. ):
  93. """Update application settings."""
  94. update_data = settings_update.model_dump(exclude_unset=True)
  95. # Check if any MQTT settings are being updated
  96. mqtt_keys = {
  97. "mqtt_enabled",
  98. "mqtt_broker",
  99. "mqtt_port",
  100. "mqtt_username",
  101. "mqtt_password",
  102. "mqtt_topic_prefix",
  103. "mqtt_use_tls",
  104. }
  105. mqtt_updated = bool(mqtt_keys & set(update_data.keys()))
  106. for key, value in update_data.items():
  107. # Convert value to string for storage
  108. if isinstance(value, bool):
  109. str_value = "true" if value else "false"
  110. elif value is None:
  111. str_value = "None"
  112. else:
  113. str_value = str(value)
  114. await set_setting(db, key, str_value)
  115. await db.commit()
  116. # Expire all objects to ensure fresh reads after commit
  117. db.expire_all()
  118. # Reconfigure MQTT relay if any MQTT settings changed
  119. if mqtt_updated:
  120. try:
  121. from backend.app.services.mqtt_relay import mqtt_relay
  122. mqtt_settings = {
  123. "mqtt_enabled": (await get_setting(db, "mqtt_enabled") or "false") == "true",
  124. "mqtt_broker": await get_setting(db, "mqtt_broker") or "",
  125. "mqtt_port": int(await get_setting(db, "mqtt_port") or "1883"),
  126. "mqtt_username": await get_setting(db, "mqtt_username") or "",
  127. "mqtt_password": await get_setting(db, "mqtt_password") or "",
  128. "mqtt_topic_prefix": await get_setting(db, "mqtt_topic_prefix") or "bambuddy",
  129. "mqtt_use_tls": (await get_setting(db, "mqtt_use_tls") or "false") == "true",
  130. }
  131. await mqtt_relay.configure(mqtt_settings)
  132. except Exception:
  133. pass # Don't fail the settings update if MQTT reconfiguration fails
  134. # Return updated settings
  135. return await get_settings(db)
  136. @router.patch("/", response_model=AppSettings)
  137. @router.patch("", response_model=AppSettings)
  138. async def patch_settings(
  139. settings_update: AppSettingsUpdate,
  140. db: AsyncSession = Depends(get_db),
  141. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_UPDATE),
  142. ):
  143. """Partially update application settings (same as PUT, for REST compatibility)."""
  144. return await update_settings(settings_update, db, _)
  145. @router.post("/reset", response_model=AppSettings)
  146. async def reset_settings(
  147. db: AsyncSession = Depends(get_db),
  148. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_UPDATE),
  149. ):
  150. """Reset all settings to defaults."""
  151. # Delete all settings
  152. result = await db.execute(select(Settings))
  153. for setting in result.scalars().all():
  154. await db.delete(setting)
  155. await db.commit()
  156. return DEFAULT_SETTINGS
  157. @router.get("/check-ffmpeg")
  158. async def check_ffmpeg():
  159. """Check if ffmpeg is installed and available."""
  160. from backend.app.services.camera import get_ffmpeg_path
  161. ffmpeg_path = get_ffmpeg_path()
  162. return {
  163. "installed": ffmpeg_path is not None,
  164. "path": ffmpeg_path,
  165. }
  166. @router.get("/spoolman")
  167. async def get_spoolman_settings(
  168. db: AsyncSession = Depends(get_db),
  169. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_READ),
  170. ):
  171. """Get Spoolman integration settings."""
  172. spoolman_enabled = await get_setting(db, "spoolman_enabled") or "false"
  173. spoolman_url = await get_setting(db, "spoolman_url") or ""
  174. spoolman_sync_mode = await get_setting(db, "spoolman_sync_mode") or "auto"
  175. return {
  176. "spoolman_enabled": spoolman_enabled,
  177. "spoolman_url": spoolman_url,
  178. "spoolman_sync_mode": spoolman_sync_mode,
  179. }
  180. @router.put("/spoolman")
  181. async def update_spoolman_settings(
  182. settings: dict,
  183. db: AsyncSession = Depends(get_db),
  184. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_UPDATE),
  185. ):
  186. """Update Spoolman integration settings."""
  187. if "spoolman_enabled" in settings:
  188. await set_setting(db, "spoolman_enabled", settings["spoolman_enabled"])
  189. if "spoolman_url" in settings:
  190. await set_setting(db, "spoolman_url", settings["spoolman_url"])
  191. if "spoolman_sync_mode" in settings:
  192. await set_setting(db, "spoolman_sync_mode", settings["spoolman_sync_mode"])
  193. await db.commit()
  194. db.expire_all()
  195. # Return updated settings
  196. return await get_spoolman_settings(db)
  197. @router.get("/backup")
  198. async def create_backup(
  199. db: AsyncSession = Depends(get_db),
  200. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_BACKUP),
  201. ):
  202. """Create a complete backup (database + all files) as a ZIP.
  203. This is a simplified backup that includes the entire SQLite database
  204. and all data directories. It is complete by definition and cannot miss data.
  205. """
  206. import shutil
  207. import tempfile
  208. from sqlalchemy import text
  209. from backend.app.core.database import engine
  210. base_dir = app_settings.base_dir
  211. db_path = Path(app_settings.database_url.replace("sqlite+aiosqlite:///", ""))
  212. with tempfile.TemporaryDirectory() as temp_dir:
  213. temp_path = Path(temp_dir)
  214. # 1. Checkpoint WAL to ensure all data is in main db file
  215. async with engine.begin() as conn:
  216. await conn.execute(text("PRAGMA wal_checkpoint(TRUNCATE)"))
  217. # 2. Copy database file
  218. shutil.copy2(db_path, temp_path / "bambuddy.db")
  219. # 3. Copy data directories (if they exist)
  220. dirs_to_backup = [
  221. ("archive", base_dir / "archive"),
  222. ("virtual_printer", base_dir / "virtual_printer"),
  223. ("plate_calibration", app_settings.plate_calibration_dir),
  224. ("icons", base_dir / "icons"),
  225. ("projects", base_dir / "projects"),
  226. ]
  227. for name, src_dir in dirs_to_backup:
  228. if src_dir.exists() and any(src_dir.iterdir()):
  229. shutil.copytree(src_dir, temp_path / name)
  230. # 4. Create ZIP
  231. zip_buffer = io.BytesIO()
  232. with zipfile.ZipFile(zip_buffer, "w", zipfile.ZIP_DEFLATED) as zf:
  233. for file_path in temp_path.rglob("*"):
  234. if file_path.is_file():
  235. arcname = file_path.relative_to(temp_path)
  236. zf.write(file_path, arcname)
  237. zip_buffer.seek(0)
  238. filename = f"bambuddy-backup-{datetime.now().strftime('%Y%m%d-%H%M%S')}.zip"
  239. return StreamingResponse(
  240. zip_buffer,
  241. media_type="application/zip",
  242. headers={"Content-Disposition": f"attachment; filename={filename}"},
  243. )
  244. @router.post("/restore")
  245. async def restore_backup(
  246. file: UploadFile = File(...),
  247. db: AsyncSession = Depends(get_db),
  248. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_RESTORE),
  249. ):
  250. """Restore from a complete backup ZIP.
  251. This is a simplified restore that replaces the database and all data directories
  252. from the backup ZIP. Requires a restart after restore.
  253. """
  254. import shutil
  255. import tempfile
  256. from fastapi import HTTPException
  257. from backend.app.core.database import close_all_connections
  258. from backend.app.services.virtual_printer import virtual_printer_manager
  259. base_dir = app_settings.base_dir
  260. db_path = Path(app_settings.database_url.replace("sqlite+aiosqlite:///", ""))
  261. with tempfile.TemporaryDirectory() as temp_dir:
  262. temp_path = Path(temp_dir)
  263. # 1. Read and extract ZIP
  264. content = await file.read()
  265. # Check if it's a valid ZIP
  266. if not file.filename or not file.filename.endswith(".zip"):
  267. raise HTTPException(400, "Invalid backup file: must be a .zip file")
  268. try:
  269. with zipfile.ZipFile(io.BytesIO(content), "r") as zf:
  270. zf.extractall(temp_path)
  271. except zipfile.BadZipFile:
  272. raise HTTPException(400, "Invalid backup file: not a valid ZIP")
  273. # 2. Validate backup (must have database)
  274. backup_db = temp_path / "bambuddy.db"
  275. if not backup_db.exists():
  276. raise HTTPException(400, "Invalid backup: missing bambuddy.db")
  277. try:
  278. # 3. Stop virtual printer if running (releases file locks)
  279. try:
  280. if virtual_printer_manager.is_enabled:
  281. logger.info("Stopping virtual printer for restore...")
  282. await virtual_printer_manager.configure(enabled=False)
  283. except Exception as e:
  284. logger.warning(f"Failed to stop virtual printer: {e}")
  285. # 4. Close current database connections
  286. logger.info("Closing database connections...")
  287. await close_all_connections()
  288. # 5. Replace database
  289. logger.info("Restoring database from backup...")
  290. shutil.copy2(backup_db, db_path)
  291. # 6. Replace data directories
  292. dirs_to_restore = [
  293. ("archive", base_dir / "archive"),
  294. ("virtual_printer", base_dir / "virtual_printer"),
  295. ("plate_calibration", app_settings.plate_calibration_dir),
  296. ("icons", base_dir / "icons"),
  297. ("projects", base_dir / "projects"),
  298. ]
  299. for name, dest_dir in dirs_to_restore:
  300. src_dir = temp_path / name
  301. if src_dir.exists():
  302. logger.info(f"Restoring {name} directory...")
  303. if dest_dir.exists():
  304. shutil.rmtree(dest_dir)
  305. shutil.copytree(src_dir, dest_dir)
  306. # 7. Note: Virtual printer and database will be reinitialized on restart
  307. # Do NOT try to restart services here - the database session is closed
  308. logger.info("Restore complete - restart required")
  309. return {
  310. "success": True,
  311. "message": "Backup restored successfully. Please restart Bambuddy for changes to take effect.",
  312. }
  313. except Exception as e:
  314. logger.error(f"Restore failed: {e}")
  315. return JSONResponse(
  316. status_code=500,
  317. content={"success": False, "message": f"Restore failed: {str(e)}"},
  318. )
  319. @router.get("/virtual-printer/models")
  320. async def get_virtual_printer_models(
  321. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_READ),
  322. ):
  323. """Get available virtual printer models."""
  324. from backend.app.services.virtual_printer import (
  325. DEFAULT_VIRTUAL_PRINTER_MODEL,
  326. VIRTUAL_PRINTER_MODELS,
  327. )
  328. return {
  329. "models": VIRTUAL_PRINTER_MODELS,
  330. "default": DEFAULT_VIRTUAL_PRINTER_MODEL,
  331. }
  332. @router.get("/virtual-printer")
  333. async def get_virtual_printer_settings(
  334. db: AsyncSession = Depends(get_db),
  335. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_READ),
  336. ):
  337. """Get virtual printer settings and status."""
  338. from backend.app.services.virtual_printer import (
  339. DEFAULT_VIRTUAL_PRINTER_MODEL,
  340. virtual_printer_manager,
  341. )
  342. enabled = await get_setting(db, "virtual_printer_enabled")
  343. access_code = await get_setting(db, "virtual_printer_access_code")
  344. mode = await get_setting(db, "virtual_printer_mode")
  345. model = await get_setting(db, "virtual_printer_model")
  346. target_printer_id = await get_setting(db, "virtual_printer_target_printer_id")
  347. return {
  348. "enabled": enabled == "true" if enabled else False,
  349. "access_code_set": bool(access_code),
  350. "mode": mode or "immediate",
  351. "model": model or DEFAULT_VIRTUAL_PRINTER_MODEL,
  352. "target_printer_id": int(target_printer_id) if target_printer_id else None,
  353. "status": virtual_printer_manager.get_status(),
  354. }
  355. @router.put("/virtual-printer")
  356. async def update_virtual_printer_settings(
  357. enabled: bool = None,
  358. access_code: str = None,
  359. mode: str = None,
  360. model: str = None,
  361. target_printer_id: int = None,
  362. db: AsyncSession = Depends(get_db),
  363. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_UPDATE),
  364. ):
  365. """Update virtual printer settings and restart services if needed."""
  366. from sqlalchemy import select
  367. from backend.app.models.printer import Printer
  368. from backend.app.services.virtual_printer import (
  369. DEFAULT_VIRTUAL_PRINTER_MODEL,
  370. VIRTUAL_PRINTER_MODELS,
  371. virtual_printer_manager,
  372. )
  373. # Get current values
  374. current_enabled = await get_setting(db, "virtual_printer_enabled") == "true"
  375. current_access_code = await get_setting(db, "virtual_printer_access_code") or ""
  376. current_mode = await get_setting(db, "virtual_printer_mode") or "immediate"
  377. current_model = await get_setting(db, "virtual_printer_model") or DEFAULT_VIRTUAL_PRINTER_MODEL
  378. current_target_id_str = await get_setting(db, "virtual_printer_target_printer_id")
  379. current_target_id = int(current_target_id_str) if current_target_id_str else None
  380. # Apply updates
  381. new_enabled = enabled if enabled is not None else current_enabled
  382. new_access_code = access_code if access_code is not None else current_access_code
  383. new_mode = mode if mode is not None else current_mode
  384. new_model = model if model is not None else current_model
  385. new_target_id = target_printer_id if target_printer_id is not None else current_target_id
  386. # Validate mode
  387. # "review" is the new name for "queue" (pending review before archiving)
  388. # "print_queue" archives and adds to print queue (unassigned)
  389. # "proxy" is transparent TCP proxy to a real printer
  390. if new_mode not in ("immediate", "queue", "review", "print_queue", "proxy"):
  391. return JSONResponse(
  392. status_code=400,
  393. content={"detail": "Mode must be 'immediate', 'review', 'print_queue', or 'proxy'"},
  394. )
  395. # Normalize legacy "queue" to "review" for storage
  396. if new_mode == "queue":
  397. new_mode = "review"
  398. # Validate model
  399. if model is not None and model not in VIRTUAL_PRINTER_MODELS:
  400. return JSONResponse(
  401. status_code=400,
  402. content={"detail": f"Invalid model. Must be one of: {', '.join(VIRTUAL_PRINTER_MODELS.keys())}"},
  403. )
  404. # Mode-specific validation and printer lookup
  405. target_printer_ip = ""
  406. target_printer_serial = ""
  407. if new_mode == "proxy":
  408. # Proxy mode requires target printer when enabling
  409. if new_enabled and not new_target_id:
  410. # If just switching to proxy mode (not explicitly enabling), auto-disable
  411. if enabled is None:
  412. new_enabled = False
  413. else:
  414. return JSONResponse(
  415. status_code=400,
  416. content={"detail": "Target printer is required for proxy mode"},
  417. )
  418. # Look up printer IP and serial if we have a target
  419. if new_target_id:
  420. result = await db.execute(select(Printer).where(Printer.id == new_target_id))
  421. printer = result.scalar_one_or_none()
  422. if not printer:
  423. return JSONResponse(
  424. status_code=400,
  425. content={"detail": f"Printer with ID {new_target_id} not found"},
  426. )
  427. target_printer_ip = printer.ip_address
  428. target_printer_serial = printer.serial_number
  429. # Access code not required for proxy mode
  430. else:
  431. # Non-proxy modes require access code when enabling
  432. if new_enabled and not new_access_code:
  433. # If just switching modes (not explicitly enabling), auto-disable
  434. if enabled is None:
  435. new_enabled = False
  436. else:
  437. return JSONResponse(
  438. status_code=400,
  439. content={"detail": "Access code is required when enabling virtual printer"},
  440. )
  441. # Validate access code length (Bambu Studio requires exactly 8 characters)
  442. if access_code is not None and access_code and len(access_code) != 8:
  443. return JSONResponse(
  444. status_code=400,
  445. content={"detail": "Access code must be exactly 8 characters"},
  446. )
  447. # Save settings
  448. await set_setting(db, "virtual_printer_enabled", "true" if new_enabled else "false")
  449. if access_code is not None:
  450. await set_setting(db, "virtual_printer_access_code", access_code)
  451. await set_setting(db, "virtual_printer_mode", new_mode)
  452. if model is not None:
  453. await set_setting(db, "virtual_printer_model", model)
  454. if target_printer_id is not None:
  455. await set_setting(db, "virtual_printer_target_printer_id", str(target_printer_id))
  456. await db.commit()
  457. db.expire_all()
  458. # Reconfigure virtual printer
  459. try:
  460. await virtual_printer_manager.configure(
  461. enabled=new_enabled,
  462. access_code=new_access_code,
  463. mode=new_mode,
  464. model=new_model,
  465. target_printer_ip=target_printer_ip,
  466. target_printer_serial=target_printer_serial,
  467. )
  468. except ValueError as e:
  469. return JSONResponse(
  470. status_code=400,
  471. content={"detail": str(e)},
  472. )
  473. except Exception as e:
  474. return JSONResponse(
  475. status_code=500,
  476. content={"detail": f"Failed to configure virtual printer: {e}"},
  477. )
  478. return await get_virtual_printer_settings(db)
  479. # =============================================================================
  480. # MQTT Relay Settings
  481. # =============================================================================
  482. @router.get("/mqtt/status")
  483. async def get_mqtt_status(
  484. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_READ),
  485. ):
  486. """Get MQTT relay connection status."""
  487. from backend.app.services.mqtt_relay import mqtt_relay
  488. return mqtt_relay.get_status()