settings.py 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765
  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 delete, 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 get_external_login_url(db: AsyncSession) -> str:
  27. """Get the external URL for the login page.
  28. Uses external_url from settings if available, otherwise falls back to APP_URL env var.
  29. Args:
  30. db: Database session
  31. Returns:
  32. Full URL to the login page
  33. """
  34. import os
  35. external_url = await get_setting(db, "external_url")
  36. if external_url:
  37. external_url = external_url.rstrip("/")
  38. else:
  39. external_url = os.environ.get("APP_URL", "http://localhost:5173")
  40. return external_url + "/login"
  41. async def set_setting(db: AsyncSession, key: str, value: str) -> None:
  42. """Set a single setting value."""
  43. from sqlalchemy import func
  44. from sqlalchemy.dialects.sqlite import insert as sqlite_insert
  45. # Use upsert (INSERT ... ON CONFLICT UPDATE) for reliability
  46. stmt = sqlite_insert(Settings).values(key=key, value=value)
  47. stmt = stmt.on_conflict_do_update(index_elements=["key"], set_={"value": value, "updated_at": func.now()})
  48. await db.execute(stmt)
  49. @router.get("", response_model=AppSettings)
  50. @router.get("/", response_model=AppSettings)
  51. async def get_settings(
  52. db: AsyncSession = Depends(get_db),
  53. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_READ),
  54. ):
  55. """Get all application settings."""
  56. settings_dict = DEFAULT_SETTINGS.model_dump()
  57. # Load saved settings from database
  58. result = await db.execute(select(Settings))
  59. db_settings = result.scalars().all()
  60. for setting in db_settings:
  61. if setting.key in settings_dict:
  62. # Parse the value based on the expected type
  63. if setting.key in [
  64. "auto_archive",
  65. "save_thumbnails",
  66. "capture_finish_photo",
  67. "spoolman_enabled",
  68. "spoolman_disable_weight_sync",
  69. "spoolman_report_partial_usage",
  70. "disable_filament_warnings",
  71. "prefer_lowest_filament",
  72. "check_updates",
  73. "check_printer_firmware",
  74. "include_beta_updates",
  75. "virtual_printer_enabled",
  76. "ftp_retry_enabled",
  77. "mqtt_enabled",
  78. "mqtt_use_tls",
  79. "ha_enabled",
  80. "per_printer_mapping_expanded",
  81. "prometheus_enabled",
  82. "user_notifications_enabled",
  83. "queue_drying_enabled",
  84. "queue_drying_block",
  85. "ambient_drying_enabled",
  86. "require_plate_clear",
  87. ]:
  88. settings_dict[setting.key] = setting.value.lower() == "true"
  89. elif setting.key in [
  90. "default_filament_cost",
  91. "energy_cost_per_kwh",
  92. "ams_temp_good",
  93. "ams_temp_fair",
  94. "library_disk_warning_gb",
  95. "low_stock_threshold",
  96. ]:
  97. settings_dict[setting.key] = float(setting.value)
  98. elif setting.key in [
  99. "ams_humidity_good",
  100. "ams_humidity_fair",
  101. "ams_history_retention_days",
  102. "ftp_retry_count",
  103. "ftp_retry_delay",
  104. "ftp_timeout",
  105. "mqtt_port",
  106. "stagger_group_size",
  107. "stagger_interval_minutes",
  108. ]:
  109. settings_dict[setting.key] = int(setting.value)
  110. elif setting.key == "default_printer_id":
  111. # Handle nullable integer
  112. settings_dict[setting.key] = int(setting.value) if setting.value and setting.value != "None" else None
  113. else:
  114. settings_dict[setting.key] = setting.value
  115. # Get Home Assistant settings (with environment variable overrides)
  116. ha_settings = await get_homeassistant_settings(db)
  117. settings_dict.update(ha_settings)
  118. return AppSettings(**settings_dict)
  119. @router.put("/", response_model=AppSettings)
  120. async def update_settings(
  121. settings_update: AppSettingsUpdate,
  122. db: AsyncSession = Depends(get_db),
  123. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_UPDATE),
  124. ):
  125. """Update application settings."""
  126. update_data = settings_update.model_dump(exclude_unset=True)
  127. # Check if any MQTT settings are being updated
  128. mqtt_keys = {
  129. "mqtt_enabled",
  130. "mqtt_broker",
  131. "mqtt_port",
  132. "mqtt_username",
  133. "mqtt_password",
  134. "mqtt_topic_prefix",
  135. "mqtt_use_tls",
  136. }
  137. mqtt_updated = bool(mqtt_keys & set(update_data.keys()))
  138. for key, value in update_data.items():
  139. # Convert value to string for storage
  140. if isinstance(value, bool):
  141. str_value = "true" if value else "false"
  142. elif value is None:
  143. str_value = "None"
  144. else:
  145. str_value = str(value)
  146. await set_setting(db, key, str_value)
  147. await db.commit()
  148. # Expire all objects to ensure fresh reads after commit
  149. db.expire_all()
  150. # Reconfigure MQTT relay if any MQTT settings changed
  151. if mqtt_updated:
  152. try:
  153. from backend.app.services.mqtt_relay import mqtt_relay
  154. mqtt_settings = {
  155. "mqtt_enabled": (await get_setting(db, "mqtt_enabled") or "false") == "true",
  156. "mqtt_broker": await get_setting(db, "mqtt_broker") or "",
  157. "mqtt_port": int(await get_setting(db, "mqtt_port") or "1883"),
  158. "mqtt_username": await get_setting(db, "mqtt_username") or "",
  159. "mqtt_password": await get_setting(db, "mqtt_password") or "",
  160. "mqtt_topic_prefix": await get_setting(db, "mqtt_topic_prefix") or "bambuddy",
  161. "mqtt_use_tls": (await get_setting(db, "mqtt_use_tls") or "false") == "true",
  162. }
  163. await mqtt_relay.configure(mqtt_settings)
  164. except Exception:
  165. pass # Don't fail the settings update if MQTT reconfiguration fails
  166. # Return updated settings
  167. return await get_settings(db)
  168. @router.patch("/", response_model=AppSettings)
  169. @router.patch("", response_model=AppSettings)
  170. async def patch_settings(
  171. settings_update: AppSettingsUpdate,
  172. db: AsyncSession = Depends(get_db),
  173. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_UPDATE),
  174. ):
  175. """Partially update application settings (same as PUT, for REST compatibility)."""
  176. return await update_settings(settings_update, db, _)
  177. @router.post("/reset", response_model=AppSettings)
  178. async def reset_settings(
  179. db: AsyncSession = Depends(get_db),
  180. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_UPDATE),
  181. ):
  182. """Reset all settings to defaults."""
  183. # Delete all settings
  184. result = await db.execute(select(Settings))
  185. for setting in result.scalars().all():
  186. await db.delete(setting)
  187. await db.commit()
  188. return DEFAULT_SETTINGS
  189. @router.get("/default-sidebar-order")
  190. async def get_default_sidebar_order(
  191. db: AsyncSession = Depends(get_db),
  192. ):
  193. """Get the admin-set default sidebar order.
  194. Intentionally unauthenticated: non-admin users need to read this value to apply
  195. the default sidebar order, but may lack SETTINGS_READ permission.
  196. The value is non-sensitive (sidebar item IDs only).
  197. """
  198. value = await get_setting(db, "default_sidebar_order")
  199. return {"default_sidebar_order": value or ""}
  200. @router.get("/check-ffmpeg")
  201. async def check_ffmpeg():
  202. """Check if ffmpeg is installed and available."""
  203. from backend.app.services.camera import get_ffmpeg_path
  204. ffmpeg_path = get_ffmpeg_path()
  205. return {
  206. "installed": ffmpeg_path is not None,
  207. "path": ffmpeg_path,
  208. }
  209. @router.get("/spoolman")
  210. async def get_spoolman_settings(
  211. db: AsyncSession = Depends(get_db),
  212. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_READ),
  213. ):
  214. """Get Spoolman integration settings."""
  215. spoolman_enabled = await get_setting(db, "spoolman_enabled") or "false"
  216. spoolman_url = await get_setting(db, "spoolman_url") or ""
  217. spoolman_sync_mode = await get_setting(db, "spoolman_sync_mode") or "auto"
  218. spoolman_disable_weight_sync = await get_setting(db, "spoolman_disable_weight_sync") or "false"
  219. spoolman_report_partial_usage = await get_setting(db, "spoolman_report_partial_usage") or "true"
  220. return {
  221. "spoolman_enabled": spoolman_enabled,
  222. "spoolman_url": spoolman_url,
  223. "spoolman_sync_mode": spoolman_sync_mode,
  224. "spoolman_disable_weight_sync": spoolman_disable_weight_sync,
  225. "spoolman_report_partial_usage": spoolman_report_partial_usage,
  226. }
  227. @router.put("/spoolman")
  228. async def update_spoolman_settings(
  229. settings: dict,
  230. db: AsyncSession = Depends(get_db),
  231. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_UPDATE),
  232. ):
  233. """Update Spoolman integration settings."""
  234. if "spoolman_enabled" in settings:
  235. old_val = await get_setting(db, "spoolman_enabled") or "false"
  236. new_val = settings["spoolman_enabled"]
  237. await set_setting(db, "spoolman_enabled", new_val)
  238. # Switching to Spoolman: clear built-in inventory slot assignments
  239. if old_val.lower() != "true" and new_val.lower() == "true":
  240. from backend.app.models.spool_assignment import SpoolAssignment
  241. result = await db.execute(delete(SpoolAssignment))
  242. logger.info("Cleared %d spool assignments on switch to Spoolman mode", result.rowcount)
  243. if "spoolman_url" in settings:
  244. await set_setting(db, "spoolman_url", settings["spoolman_url"])
  245. if "spoolman_sync_mode" in settings:
  246. await set_setting(db, "spoolman_sync_mode", settings["spoolman_sync_mode"])
  247. if "spoolman_disable_weight_sync" in settings:
  248. await set_setting(db, "spoolman_disable_weight_sync", settings["spoolman_disable_weight_sync"])
  249. if "spoolman_report_partial_usage" in settings:
  250. await set_setting(db, "spoolman_report_partial_usage", settings["spoolman_report_partial_usage"])
  251. await db.commit()
  252. db.expire_all()
  253. # Return updated settings
  254. return await get_spoolman_settings(db)
  255. async def get_homeassistant_settings(db: AsyncSession) -> dict:
  256. """
  257. Get Home Assistant integration settings.
  258. Environment variables (HA_URL, HA_TOKEN) take precedence over database settings.
  259. """
  260. import os
  261. # Check environment variables first
  262. ha_url_env = os.environ.get("HA_URL")
  263. ha_token_env = os.environ.get("HA_TOKEN")
  264. # Fall back to database values
  265. ha_url = ha_url_env or await get_setting(db, "ha_url") or ""
  266. ha_token = ha_token_env or await get_setting(db, "ha_token") or ""
  267. ha_enabled_db = await get_setting(db, "ha_enabled") or "false"
  268. # Track which settings come from environment
  269. ha_url_from_env = bool(ha_url_env)
  270. ha_token_from_env = bool(ha_token_env)
  271. ha_env_managed = ha_url_from_env and ha_token_from_env
  272. # Auto-enable when both env vars are set, otherwise use database value
  273. if ha_url_env and ha_token_env:
  274. ha_enabled = True
  275. else:
  276. ha_enabled = ha_enabled_db.lower() == "true"
  277. return {
  278. "ha_enabled": ha_enabled,
  279. "ha_url": ha_url,
  280. "ha_token": ha_token,
  281. "ha_url_from_env": ha_url_from_env,
  282. "ha_token_from_env": ha_token_from_env,
  283. "ha_env_managed": ha_env_managed,
  284. }
  285. @router.get("/backup")
  286. async def create_backup(
  287. db: AsyncSession = Depends(get_db),
  288. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_BACKUP),
  289. ):
  290. """Create a complete backup (database + all files) as a ZIP.
  291. This is a simplified backup that includes the entire SQLite database
  292. and all data directories. It is complete by definition and cannot miss data.
  293. """
  294. import shutil
  295. import tempfile
  296. from sqlalchemy import text
  297. from backend.app.core.database import engine
  298. try:
  299. base_dir = app_settings.base_dir
  300. db_path = Path(app_settings.database_url.replace("sqlite+aiosqlite:///", ""))
  301. with tempfile.TemporaryDirectory() as temp_dir:
  302. temp_path = Path(temp_dir)
  303. # 1. Checkpoint WAL to ensure all data is in main db file
  304. async with engine.begin() as conn:
  305. await conn.execute(text("PRAGMA wal_checkpoint(TRUNCATE)"))
  306. # 2. Copy database file
  307. shutil.copy2(db_path, temp_path / "bambuddy.db")
  308. # 3. Copy data directories (if they exist)
  309. dirs_to_backup = [
  310. ("archive", base_dir / "archive"),
  311. ("virtual_printer", base_dir / "virtual_printer"),
  312. ("plate_calibration", app_settings.plate_calibration_dir),
  313. ("icons", base_dir / "icons"),
  314. ("projects", base_dir / "projects"),
  315. ]
  316. for name, src_dir in dirs_to_backup:
  317. if src_dir.exists() and any(src_dir.iterdir()):
  318. try:
  319. shutil.copytree(src_dir, temp_path / name)
  320. except shutil.Error as e:
  321. # Some files may have restricted permissions (e.g., SSL keys)
  322. # Log the error but continue with partial backup
  323. logger.warning("Some files in %s could not be copied: %s", name, e)
  324. except PermissionError as e:
  325. logger.warning("Permission denied copying %s: %s", name, e)
  326. # 4. Create ZIP
  327. zip_buffer = io.BytesIO()
  328. with zipfile.ZipFile(zip_buffer, "w", zipfile.ZIP_DEFLATED) as zf:
  329. for file_path in temp_path.rglob("*"):
  330. if file_path.is_file():
  331. arcname = file_path.relative_to(temp_path)
  332. zf.write(file_path, arcname)
  333. zip_buffer.seek(0)
  334. filename = f"bambuddy-backup-{datetime.now().strftime('%Y%m%d-%H%M%S')}.zip"
  335. return StreamingResponse(
  336. zip_buffer,
  337. media_type="application/zip",
  338. headers={"Content-Disposition": f"attachment; filename={filename}"},
  339. )
  340. except Exception as e:
  341. logger.error("Backup failed: %s", e, exc_info=True)
  342. return JSONResponse(
  343. status_code=500,
  344. content={"success": False, "message": "Backup failed. Check server logs for details."},
  345. )
  346. @router.post("/restore")
  347. async def restore_backup(
  348. file: UploadFile = File(...),
  349. db: AsyncSession = Depends(get_db),
  350. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_RESTORE),
  351. ):
  352. """Restore from a complete backup ZIP.
  353. This is a simplified restore that replaces the database and all data directories
  354. from the backup ZIP. Requires a restart after restore.
  355. """
  356. import shutil
  357. import tempfile
  358. from fastapi import HTTPException
  359. from backend.app.core.database import close_all_connections, init_db, reinitialize_database
  360. from backend.app.services.virtual_printer import virtual_printer_manager
  361. base_dir = app_settings.base_dir
  362. db_path = Path(app_settings.database_url.replace("sqlite+aiosqlite:///", ""))
  363. with tempfile.TemporaryDirectory() as temp_dir:
  364. temp_path = Path(temp_dir)
  365. # 1. Read and extract ZIP
  366. content = await file.read()
  367. # Check if it's a valid ZIP
  368. if not file.filename or not file.filename.endswith(".zip"):
  369. raise HTTPException(400, "Invalid backup file: must be a .zip file")
  370. try:
  371. with zipfile.ZipFile(io.BytesIO(content), "r") as zf:
  372. zf.extractall(temp_path)
  373. except zipfile.BadZipFile:
  374. raise HTTPException(400, "Invalid backup file: not a valid ZIP")
  375. # 2. Validate backup (must have database)
  376. backup_db = temp_path / "bambuddy.db"
  377. if not backup_db.exists():
  378. raise HTTPException(400, "Invalid backup: missing bambuddy.db")
  379. try:
  380. import asyncio
  381. # 3. Stop virtual printer if running (releases file locks)
  382. try:
  383. if virtual_printer_manager.is_enabled:
  384. logger.info("Stopping virtual printer for restore...")
  385. await virtual_printer_manager.configure(enabled=False)
  386. # Give it time to fully release file handles
  387. await asyncio.sleep(1)
  388. except Exception as e:
  389. logger.warning("Failed to stop virtual printer: %s", e)
  390. # 4. Close current database connections
  391. logger.info("Closing database connections...")
  392. await close_all_connections()
  393. # 5. Replace database
  394. logger.info("Restoring database from backup...")
  395. shutil.copy2(backup_db, db_path)
  396. # 6. Replace data directories
  397. # For Docker compatibility: clear contents then copy (don't delete mount points)
  398. dirs_to_restore = [
  399. ("archive", base_dir / "archive"),
  400. ("virtual_printer", base_dir / "virtual_printer"),
  401. ("plate_calibration", app_settings.plate_calibration_dir),
  402. ("icons", base_dir / "icons"),
  403. ("projects", base_dir / "projects"),
  404. ]
  405. skipped_dirs = []
  406. for name, dest_dir in dirs_to_restore:
  407. src_dir = temp_path / name
  408. if src_dir.exists():
  409. logger.info("Restoring %s directory...", name)
  410. try:
  411. # Clear destination contents (not the dir itself - may be Docker mount)
  412. if dest_dir.exists():
  413. for item in dest_dir.iterdir():
  414. try:
  415. if item.is_dir():
  416. shutil.rmtree(item)
  417. else:
  418. item.unlink()
  419. except OSError as e:
  420. logger.warning("Could not delete %s: %s", item, e)
  421. else:
  422. dest_dir.mkdir(parents=True, exist_ok=True)
  423. # Copy contents from backup
  424. for item in src_dir.iterdir():
  425. dest_item = dest_dir / item.name
  426. if item.is_dir():
  427. shutil.copytree(item, dest_item)
  428. else:
  429. shutil.copy2(item, dest_item)
  430. except OSError as e:
  431. logger.warning("Could not restore %s directory: %s", name, e)
  432. skipped_dirs.append(name)
  433. # 7. Reinitialize the database engine and apply schema migrations so that
  434. # tables added after the backup was created (e.g. ams_labels) exist
  435. # immediately, without requiring a manual restart.
  436. await reinitialize_database()
  437. await init_db()
  438. logger.info("Restore complete - restart required")
  439. message = "Backup restored successfully. Please restart Bambuddy for changes to take effect."
  440. if skipped_dirs:
  441. message += f" Note: Some directories could not be restored ({', '.join(skipped_dirs)})."
  442. return {
  443. "success": True,
  444. "message": message,
  445. }
  446. except Exception as e:
  447. logger.error("Restore failed: %s", e, exc_info=True)
  448. return JSONResponse(
  449. status_code=500,
  450. content={"success": False, "message": "Restore failed. Check server logs for details."},
  451. )
  452. @router.get("/network-interfaces")
  453. async def get_network_interfaces(
  454. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_READ),
  455. ):
  456. """Get available network interfaces with all IPs (primary + aliases)."""
  457. from backend.app.services.network_utils import get_all_interface_ips
  458. interfaces = get_all_interface_ips()
  459. return {"interfaces": interfaces}
  460. @router.get("/virtual-printer/models")
  461. async def get_virtual_printer_models(
  462. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_READ),
  463. ):
  464. """Get available virtual printer models."""
  465. from backend.app.services.virtual_printer import (
  466. DEFAULT_VIRTUAL_PRINTER_MODEL,
  467. VIRTUAL_PRINTER_MODELS,
  468. )
  469. return {
  470. "models": VIRTUAL_PRINTER_MODELS,
  471. "default": DEFAULT_VIRTUAL_PRINTER_MODEL,
  472. }
  473. @router.get("/virtual-printer")
  474. async def get_virtual_printer_settings(
  475. db: AsyncSession = Depends(get_db),
  476. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_READ),
  477. ):
  478. """Get virtual printer settings and status."""
  479. from backend.app.services.virtual_printer import (
  480. DEFAULT_VIRTUAL_PRINTER_MODEL,
  481. virtual_printer_manager,
  482. )
  483. enabled = await get_setting(db, "virtual_printer_enabled")
  484. access_code = await get_setting(db, "virtual_printer_access_code")
  485. mode = await get_setting(db, "virtual_printer_mode")
  486. model = await get_setting(db, "virtual_printer_model")
  487. target_printer_id = await get_setting(db, "virtual_printer_target_printer_id")
  488. remote_interface_ip = await get_setting(db, "virtual_printer_remote_interface_ip")
  489. return {
  490. "enabled": enabled == "true" if enabled else False,
  491. "access_code_set": bool(access_code),
  492. "mode": mode or "immediate",
  493. "model": model or DEFAULT_VIRTUAL_PRINTER_MODEL,
  494. "target_printer_id": int(target_printer_id) if target_printer_id else None,
  495. "remote_interface_ip": remote_interface_ip or "",
  496. "status": virtual_printer_manager.get_status(),
  497. }
  498. @router.put("/virtual-printer")
  499. async def update_virtual_printer_settings(
  500. enabled: bool = None,
  501. access_code: str = None,
  502. mode: str = None,
  503. model: str = None,
  504. target_printer_id: int = None,
  505. remote_interface_ip: str = None,
  506. db: AsyncSession = Depends(get_db),
  507. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_UPDATE),
  508. ):
  509. """Update virtual printer settings and restart services if needed.
  510. For proxy mode with SSDP proxy (dual-homed setup):
  511. - remote_interface_ip: IP of interface on slicer's network (LAN B)
  512. - Local interface is auto-detected based on target printer IP
  513. """
  514. from sqlalchemy import select
  515. from backend.app.models.printer import Printer
  516. from backend.app.services.virtual_printer import (
  517. DEFAULT_VIRTUAL_PRINTER_MODEL,
  518. VIRTUAL_PRINTER_MODELS,
  519. virtual_printer_manager,
  520. )
  521. # Get current values
  522. current_enabled = await get_setting(db, "virtual_printer_enabled") == "true"
  523. current_access_code = await get_setting(db, "virtual_printer_access_code") or ""
  524. current_mode = await get_setting(db, "virtual_printer_mode") or "immediate"
  525. current_model = await get_setting(db, "virtual_printer_model") or DEFAULT_VIRTUAL_PRINTER_MODEL
  526. current_target_id_str = await get_setting(db, "virtual_printer_target_printer_id")
  527. current_target_id = int(current_target_id_str) if current_target_id_str else None
  528. current_remote_iface = await get_setting(db, "virtual_printer_remote_interface_ip") or ""
  529. # Apply updates
  530. new_enabled = enabled if enabled is not None else current_enabled
  531. new_access_code = access_code if access_code is not None else current_access_code
  532. new_mode = mode if mode is not None else current_mode
  533. new_model = model if model is not None else current_model
  534. new_target_id = target_printer_id if target_printer_id is not None else current_target_id
  535. new_remote_iface = remote_interface_ip if remote_interface_ip is not None else current_remote_iface
  536. # Validate mode
  537. # "review" is the new name for "queue" (pending review before archiving)
  538. # "print_queue" archives and adds to print queue (unassigned)
  539. # "proxy" is transparent TCP proxy to a real printer
  540. if new_mode not in ("immediate", "queue", "review", "print_queue", "proxy"):
  541. return JSONResponse(
  542. status_code=400,
  543. content={"detail": "Mode must be 'immediate', 'review', 'print_queue', or 'proxy'"},
  544. )
  545. # Normalize legacy "queue" to "review" for storage
  546. if new_mode == "queue":
  547. new_mode = "review"
  548. # Validate model
  549. if model is not None and model not in VIRTUAL_PRINTER_MODELS:
  550. return JSONResponse(
  551. status_code=400,
  552. content={"detail": f"Invalid model. Must be one of: {', '.join(VIRTUAL_PRINTER_MODELS.keys())}"},
  553. )
  554. # Mode-specific validation and printer lookup
  555. target_printer_ip = ""
  556. target_printer_serial = ""
  557. if new_mode == "proxy":
  558. # Proxy mode requires target printer when enabling
  559. if new_enabled and not new_target_id:
  560. # If just switching to proxy mode (not explicitly enabling), auto-disable
  561. if enabled is None:
  562. new_enabled = False
  563. else:
  564. return JSONResponse(
  565. status_code=400,
  566. content={"detail": "Target printer is required for proxy mode"},
  567. )
  568. # Look up printer IP and serial if we have a target
  569. if new_target_id:
  570. result = await db.execute(select(Printer).where(Printer.id == new_target_id))
  571. printer = result.scalar_one_or_none()
  572. if not printer:
  573. return JSONResponse(
  574. status_code=400,
  575. content={"detail": f"Printer with ID {new_target_id} not found"},
  576. )
  577. target_printer_ip = printer.ip_address
  578. target_printer_serial = printer.serial_number
  579. # Access code not required for proxy mode
  580. else:
  581. # Non-proxy modes require access code when enabling
  582. if new_enabled and not new_access_code:
  583. # If just switching modes (not explicitly enabling), auto-disable
  584. if enabled is None:
  585. new_enabled = False
  586. else:
  587. return JSONResponse(
  588. status_code=400,
  589. content={"detail": "Access code is required when enabling virtual printer"},
  590. )
  591. # Validate access code length (Bambu Studio requires exactly 8 characters)
  592. if access_code is not None and access_code and len(access_code) != 8:
  593. return JSONResponse(
  594. status_code=400,
  595. content={"detail": "Access code must be exactly 8 characters"},
  596. )
  597. # Save settings
  598. await set_setting(db, "virtual_printer_enabled", "true" if new_enabled else "false")
  599. if access_code is not None:
  600. await set_setting(db, "virtual_printer_access_code", access_code)
  601. await set_setting(db, "virtual_printer_mode", new_mode)
  602. if model is not None:
  603. await set_setting(db, "virtual_printer_model", model)
  604. if target_printer_id is not None:
  605. await set_setting(db, "virtual_printer_target_printer_id", str(target_printer_id))
  606. if remote_interface_ip is not None:
  607. await set_setting(db, "virtual_printer_remote_interface_ip", remote_interface_ip)
  608. await db.commit()
  609. db.expire_all()
  610. # Reconfigure virtual printer
  611. try:
  612. await virtual_printer_manager.configure(
  613. enabled=new_enabled,
  614. access_code=new_access_code,
  615. mode=new_mode,
  616. model=new_model,
  617. target_printer_ip=target_printer_ip,
  618. target_printer_serial=target_printer_serial,
  619. remote_interface_ip=new_remote_iface,
  620. )
  621. except ValueError as e:
  622. logger.warning("Virtual printer configuration validation error: %s", e)
  623. return JSONResponse(
  624. status_code=400,
  625. content={"detail": "Invalid virtual printer configuration. Check the provided values."},
  626. )
  627. except Exception as e:
  628. logger.error("Failed to configure virtual printer: %s", e, exc_info=True)
  629. return JSONResponse(
  630. status_code=500,
  631. content={"detail": "Failed to configure virtual printer. Check server logs for details."},
  632. )
  633. return await get_virtual_printer_settings(db)
  634. # =============================================================================
  635. # MQTT Relay Settings
  636. # =============================================================================
  637. @router.get("/mqtt/status")
  638. async def get_mqtt_status(
  639. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_READ),
  640. ):
  641. """Get MQTT relay connection status."""
  642. from backend.app.services.mqtt_relay import mqtt_relay
  643. return mqtt_relay.get_status()