settings.py 20 KB

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