virtual_printers.py 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420
  1. import logging
  2. from fastapi import APIRouter, Depends
  3. from fastapi.responses import JSONResponse
  4. from pydantic import BaseModel
  5. from sqlalchemy import select
  6. from sqlalchemy.ext.asyncio import AsyncSession
  7. from backend.app.core.auth import RequirePermissionIfAuthEnabled
  8. from backend.app.core.database import get_db
  9. from backend.app.core.permissions import Permission
  10. from backend.app.models.user import User
  11. logger = logging.getLogger(__name__)
  12. router = APIRouter(prefix="/virtual-printers", tags=["virtual-printers"])
  13. class VirtualPrinterCreate(BaseModel):
  14. name: str = "Bambuddy"
  15. enabled: bool = False
  16. mode: str = "immediate"
  17. model: str | None = None
  18. access_code: str | None = None
  19. target_printer_id: int | None = None
  20. auto_dispatch: bool = True
  21. bind_ip: str | None = None
  22. remote_interface_ip: str | None = None
  23. class VirtualPrinterUpdate(BaseModel):
  24. name: str | None = None
  25. enabled: bool | None = None
  26. mode: str | None = None
  27. model: str | None = None
  28. access_code: str | None = None
  29. target_printer_id: int | None = None
  30. auto_dispatch: bool | None = None
  31. bind_ip: str | None = None
  32. remote_interface_ip: str | None = None
  33. def _resolve_printer_model(printer_model: str | None) -> str | None:
  34. """Map a printer's model (display name or SSDP code) to a valid VP SSDP model code.
  35. Printers store display names like 'X1C' while VPs need SSDP codes like 'BL-P001'.
  36. """
  37. if not printer_model:
  38. return None
  39. from backend.app.services.virtual_printer import VIRTUAL_PRINTER_MODELS
  40. from backend.app.services.virtual_printer.manager import DISPLAY_NAME_TO_MODEL_CODE
  41. # Already a valid SSDP model code
  42. if printer_model in VIRTUAL_PRINTER_MODELS:
  43. return printer_model
  44. # Map display name to SSDP code
  45. return DISPLAY_NAME_TO_MODEL_CODE.get(printer_model)
  46. def _vp_to_dict(vp, status: dict | None = None) -> dict:
  47. """Convert VirtualPrinter model to response dict."""
  48. from backend.app.services.virtual_printer import VIRTUAL_PRINTER_MODELS
  49. from backend.app.services.virtual_printer.manager import DEFAULT_VIRTUAL_PRINTER_MODEL, _get_serial_for_model
  50. model_code = vp.model or DEFAULT_VIRTUAL_PRINTER_MODEL
  51. serial = _get_serial_for_model(model_code, vp.serial_suffix)
  52. return {
  53. "id": vp.id,
  54. "name": vp.name,
  55. "enabled": vp.enabled,
  56. "mode": vp.mode,
  57. "model": model_code,
  58. "model_name": VIRTUAL_PRINTER_MODELS.get(model_code, model_code),
  59. "access_code_set": bool(vp.access_code),
  60. "serial": serial,
  61. "target_printer_id": vp.target_printer_id,
  62. "auto_dispatch": vp.auto_dispatch,
  63. "bind_ip": vp.bind_ip,
  64. "remote_interface_ip": vp.remote_interface_ip,
  65. "position": vp.position,
  66. "status": status or {"running": False, "pending_files": 0},
  67. }
  68. @router.get("")
  69. async def list_virtual_printers(
  70. db: AsyncSession = Depends(get_db),
  71. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_READ),
  72. ):
  73. """List all virtual printers with status."""
  74. from backend.app.models.virtual_printer import VirtualPrinter
  75. from backend.app.services.virtual_printer import VIRTUAL_PRINTER_MODELS, virtual_printer_manager
  76. result = await db.execute(select(VirtualPrinter).order_by(VirtualPrinter.position, VirtualPrinter.id))
  77. vps = result.scalars().all()
  78. printers = []
  79. for vp in vps:
  80. instance = virtual_printer_manager.get_instance(vp.id)
  81. status = instance.get_status() if instance else {"running": False, "pending_files": 0}
  82. printers.append(_vp_to_dict(vp, status))
  83. return {
  84. "printers": printers,
  85. "models": VIRTUAL_PRINTER_MODELS,
  86. }
  87. @router.post("")
  88. async def create_virtual_printer(
  89. body: VirtualPrinterCreate,
  90. db: AsyncSession = Depends(get_db),
  91. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_UPDATE),
  92. ):
  93. """Create a new virtual printer."""
  94. from backend.app.models.virtual_printer import VirtualPrinter
  95. from backend.app.services.virtual_printer import VIRTUAL_PRINTER_MODELS, virtual_printer_manager
  96. from backend.app.services.virtual_printer.manager import DEFAULT_VIRTUAL_PRINTER_MODEL
  97. # Validate mode
  98. if body.mode not in ("immediate", "review", "print_queue", "proxy"):
  99. return JSONResponse(status_code=400, content={"detail": "Invalid mode"})
  100. # Validate model
  101. if body.model and body.model not in VIRTUAL_PRINTER_MODELS:
  102. return JSONResponse(
  103. status_code=400,
  104. content={"detail": f"Invalid model. Must be one of: {', '.join(VIRTUAL_PRINTER_MODELS.keys())}"},
  105. )
  106. # Validate access code length
  107. if body.access_code and len(body.access_code) != 8:
  108. return JSONResponse(status_code=400, content={"detail": "Access code must be exactly 8 characters"})
  109. # Validation when enabling
  110. if body.enabled:
  111. if not body.bind_ip:
  112. return JSONResponse(status_code=400, content={"detail": "Bind IP is required when enabling"})
  113. if body.mode == "proxy":
  114. if not body.target_printer_id:
  115. return JSONResponse(status_code=400, content={"detail": "Target printer is required for proxy mode"})
  116. else:
  117. if not body.access_code:
  118. return JSONResponse(status_code=400, content={"detail": "Access code is required when enabling"})
  119. # Validate proxy target printer exists
  120. target_printer = None
  121. if body.target_printer_id:
  122. from backend.app.models.printer import Printer
  123. result = await db.execute(select(Printer).where(Printer.id == body.target_printer_id))
  124. target_printer = result.scalar_one_or_none()
  125. if not target_printer:
  126. return JSONResponse(
  127. status_code=400, content={"detail": f"Printer with ID {body.target_printer_id} not found"}
  128. )
  129. # Validate bind_ip uniqueness (against all enabled VPs)
  130. if body.bind_ip:
  131. result = await db.execute(
  132. select(VirtualPrinter).where(
  133. VirtualPrinter.bind_ip == body.bind_ip,
  134. VirtualPrinter.enabled == True, # noqa: E712
  135. )
  136. )
  137. if result.scalar_one_or_none():
  138. return JSONResponse(status_code=400, content={"detail": f"Bind IP {body.bind_ip} is already in use"})
  139. # Generate next serial suffix
  140. result = await db.execute(select(VirtualPrinter.serial_suffix).order_by(VirtualPrinter.id.desc()))
  141. last_suffix = result.scalar()
  142. if last_suffix:
  143. try:
  144. next_num = int(last_suffix) + 1
  145. new_suffix = str(next_num).zfill(9)
  146. except ValueError:
  147. new_suffix = "391800002"
  148. else:
  149. new_suffix = "391800001"
  150. # Get next position
  151. result = await db.execute(select(VirtualPrinter.position).order_by(VirtualPrinter.position.desc()))
  152. last_pos = result.scalar()
  153. next_pos = (last_pos or 0) + 1
  154. vp = VirtualPrinter(
  155. name=body.name,
  156. enabled=body.enabled,
  157. mode=body.mode,
  158. model=body.model
  159. or _resolve_printer_model(target_printer.model if target_printer and body.mode == "proxy" else None)
  160. or DEFAULT_VIRTUAL_PRINTER_MODEL,
  161. access_code=body.access_code,
  162. target_printer_id=body.target_printer_id,
  163. auto_dispatch=body.auto_dispatch,
  164. bind_ip=body.bind_ip,
  165. remote_interface_ip=body.remote_interface_ip,
  166. serial_suffix=new_suffix,
  167. position=next_pos,
  168. )
  169. db.add(vp)
  170. await db.commit()
  171. await db.refresh(vp)
  172. logger.info("Created virtual printer: %s (id=%d)", vp.name, vp.id)
  173. # Sync services if enabled
  174. if body.enabled:
  175. try:
  176. await virtual_printer_manager.sync_from_db()
  177. except Exception as e:
  178. logger.error("Failed to start virtual printer after create: %s", e)
  179. return _vp_to_dict(vp)
  180. @router.get("/{vp_id}")
  181. async def get_virtual_printer(
  182. vp_id: int,
  183. db: AsyncSession = Depends(get_db),
  184. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_READ),
  185. ):
  186. """Get a single virtual printer with status."""
  187. from backend.app.models.virtual_printer import VirtualPrinter
  188. from backend.app.services.virtual_printer import virtual_printer_manager
  189. result = await db.execute(select(VirtualPrinter).where(VirtualPrinter.id == vp_id))
  190. vp = result.scalar_one_or_none()
  191. if not vp:
  192. return JSONResponse(status_code=404, content={"detail": "Virtual printer not found"})
  193. instance = virtual_printer_manager.get_instance(vp.id)
  194. status = instance.get_status() if instance else {"running": False, "pending_files": 0}
  195. return _vp_to_dict(vp, status)
  196. @router.put("/{vp_id}")
  197. async def update_virtual_printer(
  198. vp_id: int,
  199. body: VirtualPrinterUpdate,
  200. db: AsyncSession = Depends(get_db),
  201. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_UPDATE),
  202. ):
  203. """Update a virtual printer."""
  204. from backend.app.models.virtual_printer import VirtualPrinter
  205. from backend.app.services.virtual_printer import VIRTUAL_PRINTER_MODELS, virtual_printer_manager
  206. result = await db.execute(select(VirtualPrinter).where(VirtualPrinter.id == vp_id))
  207. vp = result.scalar_one_or_none()
  208. if not vp:
  209. return JSONResponse(status_code=404, content={"detail": "Virtual printer not found"})
  210. logger.debug(
  211. "Update VP %d: body=%s, current state: mode=%s, enabled=%s, access_code_set=%s, bind_ip=%s, target=%s",
  212. vp_id,
  213. body.model_dump(exclude_unset=True),
  214. vp.mode,
  215. vp.enabled,
  216. bool(vp.access_code),
  217. vp.bind_ip,
  218. vp.target_printer_id,
  219. )
  220. # Apply updates
  221. if body.name is not None:
  222. vp.name = body.name
  223. if body.mode is not None:
  224. if body.mode not in ("immediate", "review", "print_queue", "proxy"):
  225. return JSONResponse(status_code=400, content={"detail": "Invalid mode"})
  226. vp.mode = body.mode
  227. if body.model is not None:
  228. if body.model not in VIRTUAL_PRINTER_MODELS:
  229. return JSONResponse(
  230. status_code=400,
  231. content={"detail": f"Invalid model. Must be one of: {', '.join(VIRTUAL_PRINTER_MODELS.keys())}"},
  232. )
  233. vp.model = body.model
  234. if body.access_code is not None:
  235. if body.access_code and len(body.access_code) != 8:
  236. return JSONResponse(status_code=400, content={"detail": "Access code must be exactly 8 characters"})
  237. vp.access_code = body.access_code
  238. if body.target_printer_id is not None:
  239. from backend.app.models.printer import Printer
  240. result = await db.execute(select(Printer).where(Printer.id == body.target_printer_id))
  241. target_printer = result.scalar_one_or_none()
  242. if not target_printer:
  243. return JSONResponse(
  244. status_code=400, content={"detail": f"Printer with ID {body.target_printer_id} not found"}
  245. )
  246. vp.target_printer_id = body.target_printer_id
  247. # Auto-inherit model from target printer in proxy mode (unless user explicitly set model)
  248. if body.model is None and vp.mode == "proxy" and target_printer.model:
  249. vp.model = _resolve_printer_model(target_printer.model) or target_printer.model
  250. if body.auto_dispatch is not None:
  251. vp.auto_dispatch = body.auto_dispatch
  252. if body.bind_ip is not None:
  253. vp.bind_ip = body.bind_ip
  254. if body.remote_interface_ip is not None:
  255. vp.remote_interface_ip = body.remote_interface_ip
  256. # Auto-inherit model when switching to proxy mode with existing target printer
  257. if body.mode == "proxy" and body.model is None and body.target_printer_id is None and vp.target_printer_id:
  258. from backend.app.models.printer import Printer as PrinterModel
  259. result = await db.execute(select(PrinterModel).where(PrinterModel.id == vp.target_printer_id))
  260. existing_target = result.scalar_one_or_none()
  261. if existing_target and existing_target.model:
  262. vp.model = _resolve_printer_model(existing_target.model) or existing_target.model
  263. # Determine final enabled state
  264. explicitly_enabling = body.enabled is True
  265. new_enabled = body.enabled if body.enabled is not None else vp.enabled
  266. effective_mode = vp.mode
  267. if explicitly_enabling:
  268. # User is explicitly toggling on — enforce all requirements
  269. if not vp.bind_ip:
  270. logger.warning("Update VP %d rejected: no bind_ip", vp_id)
  271. return JSONResponse(status_code=400, content={"detail": "Bind IP is required when enabling"})
  272. # Validate bind_ip uniqueness (against all enabled VPs)
  273. existing = await db.execute(
  274. select(VirtualPrinter).where(
  275. VirtualPrinter.bind_ip == vp.bind_ip,
  276. VirtualPrinter.id != vp_id,
  277. VirtualPrinter.enabled == True, # noqa: E712
  278. )
  279. )
  280. conflict = existing.scalar_one_or_none()
  281. if conflict:
  282. logger.warning(
  283. "Update VP %d rejected: bind_ip %s already in use by VP %d (enabled=%s, mode=%s)",
  284. vp_id,
  285. vp.bind_ip,
  286. conflict.id,
  287. conflict.enabled,
  288. conflict.mode,
  289. )
  290. return JSONResponse(
  291. status_code=400,
  292. content={"detail": f"Bind IP {vp.bind_ip} is already in use by '{conflict.name}'"},
  293. )
  294. if effective_mode == "proxy":
  295. if not vp.target_printer_id:
  296. logger.warning("Update VP %d rejected: no target_printer_id for proxy mode", vp_id)
  297. return JSONResponse(status_code=400, content={"detail": "Target printer is required for proxy mode"})
  298. else:
  299. if not vp.access_code:
  300. logger.warning(
  301. "Update VP %d rejected: no access_code for non-proxy enable (mode=%s)", vp_id, effective_mode
  302. )
  303. return JSONResponse(status_code=400, content={"detail": "Access code is required when enabling"})
  304. elif new_enabled and body.enabled is None:
  305. # VP is already enabled and user is changing other fields —
  306. # auto-disable if new state doesn't meet requirements
  307. if not vp.bind_ip:
  308. new_enabled = False
  309. elif effective_mode == "proxy":
  310. if not vp.target_printer_id:
  311. new_enabled = False
  312. else:
  313. if not vp.access_code:
  314. new_enabled = False
  315. vp.enabled = new_enabled
  316. await db.commit()
  317. await db.refresh(vp)
  318. logger.info("Updated virtual printer: %s (id=%d)", vp.name, vp.id)
  319. # Sync services
  320. try:
  321. await virtual_printer_manager.sync_from_db()
  322. except Exception as e:
  323. logger.error("Failed to sync virtual printers after update: %s", e)
  324. instance = virtual_printer_manager.get_instance(vp.id)
  325. status = instance.get_status() if instance else {"running": False, "pending_files": 0}
  326. return _vp_to_dict(vp, status)
  327. @router.delete("/{vp_id}")
  328. async def delete_virtual_printer(
  329. vp_id: int,
  330. db: AsyncSession = Depends(get_db),
  331. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_UPDATE),
  332. ):
  333. """Delete a virtual printer."""
  334. from sqlalchemy import delete as sql_delete
  335. from backend.app.models.virtual_printer import VirtualPrinter
  336. from backend.app.services.virtual_printer import virtual_printer_manager
  337. result = await db.execute(select(VirtualPrinter).where(VirtualPrinter.id == vp_id))
  338. vp = result.scalar_one_or_none()
  339. if not vp:
  340. return JSONResponse(status_code=404, content={"detail": "Virtual printer not found"})
  341. vp_name = vp.name
  342. # Stop instance if running
  343. await virtual_printer_manager.remove_instance(vp_id)
  344. # Delete from DB
  345. await db.execute(sql_delete(VirtualPrinter).where(VirtualPrinter.id == vp_id))
  346. await db.commit()
  347. logger.info("Deleted virtual printer: %s (id=%d)", vp_name, vp_id)
  348. # Resync remaining services
  349. try:
  350. await virtual_printer_manager.sync_from_db()
  351. except Exception as e:
  352. logger.error("Failed to sync virtual printers after delete: %s", e)
  353. return {"detail": "Deleted", "id": vp_id}