print_queue.py 41 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038
  1. """API routes for print queue management."""
  2. import json
  3. import logging
  4. import zipfile
  5. from datetime import datetime, timezone
  6. from pathlib import Path
  7. import defusedxml.ElementTree as ET
  8. from fastapi import APIRouter, Depends, HTTPException, Query
  9. from sqlalchemy import and_, func, or_, select
  10. from sqlalchemy.ext.asyncio import AsyncSession
  11. from sqlalchemy.orm import selectinload
  12. from backend.app.core.auth import RequirePermissionIfAuthEnabled, require_ownership_permission
  13. from backend.app.core.config import settings
  14. from backend.app.core.database import get_db
  15. from backend.app.core.permissions import Permission
  16. from backend.app.models.archive import PrintArchive
  17. from backend.app.models.library import LibraryFile
  18. from backend.app.models.print_batch import PrintBatch
  19. from backend.app.models.print_queue import PrintQueueItem
  20. from backend.app.models.printer import Printer
  21. from backend.app.models.user import User
  22. from backend.app.schemas.print_queue import (
  23. PrintBatchResponse,
  24. PrintQueueBulkUpdate,
  25. PrintQueueBulkUpdateResponse,
  26. PrintQueueItemCreate,
  27. PrintQueueItemResponse,
  28. PrintQueueItemUpdate,
  29. PrintQueueReorder,
  30. )
  31. from backend.app.services.notification_service import notification_service
  32. from backend.app.utils.printer_models import normalize_printer_model, normalize_printer_model_id
  33. from backend.app.utils.threemf_tools import extract_filament_usage_from_3mf
  34. logger = logging.getLogger(__name__)
  35. router = APIRouter(prefix="/queue", tags=["queue"])
  36. def _extract_filament_types_from_3mf(file_path: Path, plate_id: int | None = None) -> list[str]:
  37. """Extract unique filament types from a 3MF file.
  38. Args:
  39. file_path: Path to the 3MF file
  40. plate_id: Optional plate index to filter for (for multi-plate files)
  41. Returns:
  42. List of unique filament types (e.g., ["PLA", "PETG"])
  43. """
  44. types: set[str] = set()
  45. try:
  46. with zipfile.ZipFile(file_path, "r") as zf:
  47. if "Metadata/slice_info.config" not in zf.namelist():
  48. return []
  49. content = zf.read("Metadata/slice_info.config").decode()
  50. root = ET.fromstring(content)
  51. if plate_id is not None:
  52. # Find the plate element with matching index
  53. for plate_elem in root.findall(".//plate"):
  54. plate_index = None
  55. for meta in plate_elem.findall("metadata"):
  56. if meta.get("key") == "index":
  57. try:
  58. plate_index = int(meta.get("value", "0"))
  59. except ValueError:
  60. pass # Skip plate with unparseable index
  61. break
  62. if plate_index == plate_id:
  63. for filament_elem in plate_elem.findall("filament"):
  64. filament_type = filament_elem.get("type", "")
  65. used_g = filament_elem.get("used_g", "0")
  66. try:
  67. used_grams = float(used_g)
  68. except (ValueError, TypeError):
  69. used_grams = 0
  70. if used_grams > 0 and filament_type:
  71. types.add(filament_type)
  72. break
  73. else:
  74. # No plate_id specified - extract all filaments with used_g > 0
  75. for filament_elem in root.findall(".//filament"):
  76. filament_type = filament_elem.get("type", "")
  77. used_g = filament_elem.get("used_g", "0")
  78. try:
  79. used_grams = float(used_g)
  80. except (ValueError, TypeError):
  81. used_grams = 0
  82. if used_grams > 0 and filament_type:
  83. types.add(filament_type)
  84. except Exception as e:
  85. logger.warning("Failed to extract filament types from %s: %s", file_path, e)
  86. return sorted(types)
  87. def _extract_print_time_from_3mf(file_path: Path, plate_id: int | None = None) -> int | None:
  88. """Extract print time (prediction) from a 3MF file.
  89. Args:
  90. file_path: Path to the 3MF file
  91. plate_id: Optional plate index to filter for (for multi-plate files)
  92. Returns:
  93. Print time in seconds, or None if not found
  94. """
  95. try:
  96. with zipfile.ZipFile(file_path, "r") as zf:
  97. if "Metadata/slice_info.config" not in zf.namelist():
  98. return None
  99. content = zf.read("Metadata/slice_info.config").decode()
  100. root = ET.fromstring(content)
  101. if plate_id is not None:
  102. for plate_elem in root.findall(".//plate"):
  103. plate_index = None
  104. for meta in plate_elem.findall("metadata"):
  105. if meta.get("key") == "index":
  106. try:
  107. plate_index = int(meta.get("value", "0"))
  108. except ValueError:
  109. pass # Skip plate with unparseable index
  110. break
  111. if plate_index == plate_id:
  112. for meta in plate_elem.findall("metadata"):
  113. if meta.get("key") == "prediction":
  114. try:
  115. return int(meta.get("value", "0"))
  116. except ValueError:
  117. return None
  118. break
  119. else:
  120. plate_elem = root.find(".//plate")
  121. if plate_elem is not None:
  122. for meta in plate_elem.findall("metadata"):
  123. if meta.get("key") == "prediction":
  124. try:
  125. return int(meta.get("value", "0"))
  126. except ValueError:
  127. return None
  128. except Exception as e:
  129. logger.warning("Failed to extract print time from %s: %s", file_path, e)
  130. return None
  131. def _enrich_response(item: PrintQueueItem) -> PrintQueueItemResponse:
  132. """Add nested archive/printer/library_file info to response."""
  133. # Parse ams_mapping from JSON string BEFORE model_validate
  134. ams_mapping_parsed = None
  135. if item.ams_mapping:
  136. try:
  137. ams_mapping_parsed = json.loads(item.ams_mapping)
  138. except json.JSONDecodeError:
  139. ams_mapping_parsed = None
  140. # Parse required_filament_types from JSON string
  141. required_filament_types_parsed = None
  142. if item.required_filament_types:
  143. try:
  144. required_filament_types_parsed = json.loads(item.required_filament_types)
  145. except json.JSONDecodeError:
  146. required_filament_types_parsed = None
  147. # Parse filament_overrides from JSON string
  148. filament_overrides_parsed = None
  149. if item.filament_overrides:
  150. try:
  151. filament_overrides_parsed = json.loads(item.filament_overrides)
  152. except json.JSONDecodeError:
  153. filament_overrides_parsed = None
  154. # Create response with parsed ams_mapping
  155. item_dict = {
  156. "id": item.id,
  157. "printer_id": item.printer_id,
  158. "target_model": item.target_model,
  159. "target_location": item.target_location,
  160. "required_filament_types": required_filament_types_parsed,
  161. "filament_overrides": filament_overrides_parsed,
  162. "waiting_reason": item.waiting_reason,
  163. "archive_id": item.archive_id,
  164. "library_file_id": item.library_file_id,
  165. "position": item.position,
  166. "scheduled_time": item.scheduled_time,
  167. "require_previous_success": item.require_previous_success,
  168. "auto_off_after": item.auto_off_after,
  169. "manual_start": item.manual_start,
  170. "ams_mapping": ams_mapping_parsed,
  171. "plate_id": item.plate_id,
  172. "bed_levelling": item.bed_levelling,
  173. "flow_cali": item.flow_cali,
  174. "vibration_cali": item.vibration_cali,
  175. "layer_inspect": item.layer_inspect,
  176. "timelapse": item.timelapse,
  177. "use_ams": item.use_ams,
  178. "status": item.status,
  179. "started_at": item.started_at,
  180. "completed_at": item.completed_at,
  181. "error_message": item.error_message,
  182. "created_at": item.created_at,
  183. # User tracking (Issue #206)
  184. "created_by_id": item.created_by_id,
  185. "created_by_username": item.created_by.username if item.created_by else None,
  186. # Batch grouping
  187. "batch_id": item.batch_id,
  188. "batch_name": item.batch.name if item.batch else None,
  189. # SJF scheduling
  190. "been_jumped": item.been_jumped,
  191. }
  192. response = PrintQueueItemResponse(**item_dict)
  193. if item.archive:
  194. response.archive_name = item.archive.print_name or item.archive.filename
  195. response.archive_thumbnail = item.archive.thumbnail_path
  196. response.print_time_seconds = item.archive.print_time_seconds
  197. response.filament_used_grams = item.archive.filament_used_grams
  198. response.filament_type = item.archive.filament_type
  199. response.filament_color = item.archive.filament_color
  200. response.layer_height = item.archive.layer_height
  201. response.nozzle_diameter = item.archive.nozzle_diameter
  202. response.sliced_for_model = item.archive.sliced_for_model
  203. if item.plate_id:
  204. archive_path = settings.base_dir / item.archive.file_path
  205. if archive_path.exists():
  206. plate_time = _extract_print_time_from_3mf(archive_path, item.plate_id)
  207. plate_weight = sum(f["used_g"] for f in extract_filament_usage_from_3mf(archive_path, item.plate_id))
  208. if plate_time is not None:
  209. response.print_time_seconds = plate_time
  210. if plate_weight > 0:
  211. response.filament_used_grams = plate_weight
  212. if item.library_file:
  213. response.library_file_name = (
  214. item.library_file.file_metadata.get("print_name") if item.library_file.file_metadata else None
  215. )
  216. if not response.library_file_name:
  217. response.library_file_name = item.library_file.filename
  218. response.library_file_thumbnail = item.library_file.thumbnail_path
  219. # Get metadata from library file if no archive
  220. if not item.archive and item.library_file.file_metadata:
  221. response.print_time_seconds = item.library_file.file_metadata.get("print_time_seconds")
  222. response.filament_used_grams = item.library_file.file_metadata.get("filament_used_grams")
  223. response.filament_type = item.library_file.file_metadata.get("filament_type")
  224. response.filament_color = item.library_file.file_metadata.get("filament_color")
  225. response.layer_height = item.library_file.file_metadata.get("layer_height")
  226. response.nozzle_diameter = item.library_file.file_metadata.get("nozzle_diameter")
  227. response.sliced_for_model = item.library_file.file_metadata.get("sliced_for_model")
  228. if item.plate_id:
  229. lib_path = Path(item.library_file.file_path)
  230. library_file_path = lib_path if lib_path.is_absolute() else settings.base_dir / item.library_file.file_path
  231. if library_file_path.exists():
  232. plate_time = _extract_print_time_from_3mf(library_file_path, item.plate_id)
  233. plate_weight = sum(
  234. f["used_g"] for f in extract_filament_usage_from_3mf(library_file_path, item.plate_id)
  235. )
  236. if plate_time is not None:
  237. response.print_time_seconds = plate_time
  238. if plate_weight > 0:
  239. response.filament_used_grams = plate_weight
  240. if item.printer:
  241. response.printer_name = item.printer.name
  242. return response
  243. @router.get("/", response_model=list[PrintQueueItemResponse])
  244. async def list_queue(
  245. printer_id: int | None = Query(None, description="Filter by printer (-1 for unassigned)"),
  246. status: str | None = Query(None, description="Filter by status"),
  247. target_model: str | None = Query(
  248. None, description="Filter by target model (also includes model-based items when combined with printer_id)"
  249. ),
  250. db: AsyncSession = Depends(get_db),
  251. _: User | None = RequirePermissionIfAuthEnabled(Permission.QUEUE_READ),
  252. ):
  253. """List all queue items, optionally filtered by printer or status."""
  254. query = (
  255. select(PrintQueueItem)
  256. .options(
  257. selectinload(PrintQueueItem.archive),
  258. selectinload(PrintQueueItem.printer),
  259. selectinload(PrintQueueItem.library_file),
  260. selectinload(PrintQueueItem.created_by),
  261. selectinload(PrintQueueItem.batch),
  262. )
  263. .order_by(PrintQueueItem.printer_id.nulls_first(), PrintQueueItem.position)
  264. )
  265. if printer_id is not None:
  266. if printer_id == -1:
  267. # Special value: filter for unassigned items
  268. query = query.where(PrintQueueItem.printer_id.is_(None))
  269. else:
  270. # Resolve effective model: prefer explicit param, fall back to printer's DB model.
  271. # This ensures model-based "Any X" items are returned even when the frontend
  272. # doesn't send target_model (e.g. printer.model is NULL on the client side).
  273. effective_model = target_model
  274. if not effective_model:
  275. printer_row = (
  276. await db.execute(select(Printer.model).where(Printer.id == printer_id))
  277. ).scalar_one_or_none()
  278. effective_model = printer_row
  279. if effective_model:
  280. # Include both printer-specific items AND model-based (unassigned) items
  281. query = query.where(
  282. or_(
  283. PrintQueueItem.printer_id == printer_id,
  284. and_(
  285. PrintQueueItem.printer_id.is_(None),
  286. func.lower(PrintQueueItem.target_model) == effective_model.lower(),
  287. ),
  288. )
  289. )
  290. else:
  291. query = query.where(PrintQueueItem.printer_id == printer_id)
  292. elif target_model:
  293. query = query.where(func.lower(PrintQueueItem.target_model) == target_model.lower())
  294. if status:
  295. query = query.where(PrintQueueItem.status == status)
  296. result = await db.execute(query)
  297. items = result.scalars().all()
  298. return [_enrich_response(item) for item in items]
  299. @router.post("/", response_model=PrintQueueItemResponse)
  300. async def add_to_queue(
  301. data: PrintQueueItemCreate,
  302. db: AsyncSession = Depends(get_db),
  303. current_user: User | None = RequirePermissionIfAuthEnabled(Permission.QUEUE_CREATE),
  304. ):
  305. """Add an item to the print queue."""
  306. # Normalize target_model (e.g., "Bambu Lab X1E" / "C13" -> "X1E")
  307. target_model_norm = None
  308. if data.target_model:
  309. target_model_norm = (
  310. normalize_printer_model(data.target_model)
  311. or normalize_printer_model_id(data.target_model)
  312. or data.target_model
  313. )
  314. # Validate that either archive_id or library_file_id is provided
  315. if not data.archive_id and not data.library_file_id:
  316. raise HTTPException(400, "Either archive_id or library_file_id must be provided")
  317. # Cannot specify both printer_id and target_model
  318. if data.printer_id and target_model_norm:
  319. raise HTTPException(400, "Cannot specify both printer_id and target_model")
  320. # Validate printer exists (if assigned)
  321. if data.printer_id is not None:
  322. result = await db.execute(select(Printer).where(Printer.id == data.printer_id))
  323. if not result.scalar_one_or_none():
  324. raise HTTPException(400, "Printer not found")
  325. # Validate target_model has active printers
  326. if target_model_norm:
  327. result = await db.execute(
  328. select(Printer).where(Printer.model == target_model_norm).where(Printer.is_active == True) # noqa: E712
  329. )
  330. if not result.scalars().first():
  331. raise HTTPException(400, f"No active printers for model: {target_model_norm}")
  332. # Validate archive exists (if provided) and get it for filament extraction
  333. archive = None
  334. if data.archive_id:
  335. result = await db.execute(select(PrintArchive).where(PrintArchive.id == data.archive_id))
  336. archive = result.scalar_one_or_none()
  337. if not archive:
  338. raise HTTPException(400, "Archive not found")
  339. # Validate library file exists (if provided) and get it for filament extraction
  340. library_file = None
  341. if data.library_file_id:
  342. result = await db.execute(select(LibraryFile).where(LibraryFile.id == data.library_file_id))
  343. library_file = result.scalar_one_or_none()
  344. if not library_file:
  345. raise HTTPException(400, "Library file not found")
  346. # Extract filament types for model-based assignment (used by scheduler for validation)
  347. required_filament_types = None
  348. if target_model_norm:
  349. # Get file path from archive or library file
  350. file_path = None
  351. if archive:
  352. file_path = settings.base_dir / archive.file_path
  353. elif library_file:
  354. lib_path = Path(library_file.file_path)
  355. file_path = lib_path if lib_path.is_absolute() else settings.base_dir / library_file.file_path
  356. if file_path and file_path.exists():
  357. filament_types = _extract_filament_types_from_3mf(file_path, data.plate_id)
  358. if filament_types:
  359. required_filament_types = json.dumps(filament_types)
  360. logger.info("Extracted filament types for model-based queue: %s", filament_types)
  361. # If filament overrides are provided, update required_filament_types to match override types
  362. filament_overrides_json = None
  363. if data.filament_overrides and target_model_norm:
  364. filament_overrides_json = json.dumps(data.filament_overrides)
  365. # Update required_filament_types from overrides so scheduler validates against overridden types
  366. override_types = sorted({o["type"] for o in data.filament_overrides if "type" in o})
  367. if override_types:
  368. # Merge with existing types (overrides may only cover some slots)
  369. existing_types = set(json.loads(required_filament_types)) if required_filament_types else set()
  370. # Replace types for overridden slots, keep others
  371. all_types = existing_types | set(override_types)
  372. required_filament_types = json.dumps(sorted(all_types))
  373. # Validate quantity
  374. quantity = max(1, data.quantity)
  375. # Create batch if quantity > 1
  376. batch = None
  377. batch_id = None
  378. if quantity > 1:
  379. # Derive batch name from source file
  380. batch_name_base = "Batch"
  381. if archive:
  382. batch_name_base = archive.print_name or archive.filename or "Batch"
  383. elif library_file:
  384. if library_file.file_metadata:
  385. batch_name_base = library_file.file_metadata.get("print_name") or library_file.filename
  386. else:
  387. batch_name_base = library_file.filename
  388. batch_name_base = batch_name_base.replace(".gcode.3mf", "").replace(".3mf", "")
  389. batch = PrintBatch(
  390. name=f"{batch_name_base} ×{quantity}",
  391. archive_id=data.archive_id,
  392. library_file_id=data.library_file_id,
  393. quantity=quantity,
  394. status="active",
  395. created_by_id=current_user.id if current_user else None,
  396. )
  397. db.add(batch)
  398. await db.flush() # Get batch.id before creating items
  399. batch_id = batch.id
  400. # Get next position for this printer (or for unassigned/model-based items)
  401. if data.printer_id is not None:
  402. result = await db.execute(
  403. select(func.max(PrintQueueItem.position))
  404. .where(PrintQueueItem.printer_id == data.printer_id)
  405. .where(PrintQueueItem.status == "pending")
  406. )
  407. else:
  408. # For unassigned/model-based items, get max position across all unassigned
  409. result = await db.execute(
  410. select(func.max(PrintQueueItem.position))
  411. .where(PrintQueueItem.printer_id.is_(None))
  412. .where(PrintQueueItem.status == "pending")
  413. )
  414. max_pos = result.scalar() or 0
  415. # Resolve print_time_seconds for SJF scheduling (cache on item at creation)
  416. cached_print_time = None
  417. if archive:
  418. cached_print_time = archive.print_time_seconds
  419. if data.plate_id:
  420. archive_path = settings.base_dir / archive.file_path
  421. if archive_path.exists():
  422. plate_time = _extract_print_time_from_3mf(archive_path, data.plate_id)
  423. if plate_time is not None:
  424. cached_print_time = plate_time
  425. elif library_file:
  426. if library_file.file_metadata:
  427. cached_print_time = library_file.file_metadata.get("print_time_seconds")
  428. if data.plate_id:
  429. lib_path = Path(library_file.file_path)
  430. library_file_path = lib_path if lib_path.is_absolute() else settings.base_dir / library_file.file_path
  431. if library_file_path.exists():
  432. plate_time = _extract_print_time_from_3mf(library_file_path, data.plate_id)
  433. if plate_time is not None:
  434. cached_print_time = plate_time
  435. ams_mapping_json = json.dumps(data.ams_mapping) if data.ams_mapping else None
  436. items = []
  437. for i in range(quantity):
  438. item = PrintQueueItem(
  439. printer_id=data.printer_id,
  440. target_model=target_model_norm,
  441. target_location=data.target_location,
  442. required_filament_types=required_filament_types,
  443. filament_overrides=filament_overrides_json,
  444. archive_id=data.archive_id,
  445. library_file_id=data.library_file_id,
  446. scheduled_time=data.scheduled_time,
  447. require_previous_success=data.require_previous_success,
  448. auto_off_after=data.auto_off_after,
  449. manual_start=data.manual_start,
  450. ams_mapping=ams_mapping_json,
  451. plate_id=data.plate_id,
  452. bed_levelling=data.bed_levelling,
  453. flow_cali=data.flow_cali,
  454. vibration_cali=data.vibration_cali,
  455. layer_inspect=data.layer_inspect,
  456. timelapse=data.timelapse,
  457. use_ams=data.use_ams,
  458. position=max_pos + 1 + i,
  459. status="pending",
  460. created_by_id=current_user.id if current_user else None,
  461. batch_id=batch_id,
  462. print_time_seconds=cached_print_time,
  463. )
  464. db.add(item)
  465. items.append(item)
  466. await db.commit()
  467. # Refresh the first item for the response
  468. item = items[0]
  469. await db.refresh(item)
  470. await db.refresh(item, ["archive", "printer", "library_file", "created_by", "batch"])
  471. source_name = f"archive {data.archive_id}" if data.archive_id else f"library file {data.library_file_id}"
  472. target_desc = data.printer_id or (f"model {target_model_norm}" if target_model_norm else "unassigned")
  473. qty_desc = f" (×{quantity})" if quantity > 1 else ""
  474. logger.info("Added %s to queue for %s%s", source_name, target_desc, qty_desc)
  475. # MQTT relay - publish queue job added
  476. try:
  477. from backend.app.services.mqtt_relay import mqtt_relay
  478. await mqtt_relay.on_queue_job_added(
  479. job_id=item.id,
  480. filename=item.archive.filename if item.archive else "",
  481. printer_id=item.printer_id,
  482. printer_name=item.printer.name if item.printer else None,
  483. )
  484. except Exception:
  485. pass # Don't fail queue add if MQTT fails
  486. # Send notification for job added
  487. try:
  488. job_name = (
  489. item.archive.filename
  490. if item.archive
  491. else item.library_file.filename
  492. if item.library_file
  493. else f"Job #{item.id}"
  494. )
  495. job_name = job_name.replace(".gcode.3mf", "").replace(".3mf", "")
  496. if quantity > 1:
  497. job_name = f"{job_name} ×{quantity}"
  498. target = (
  499. item.printer.name if item.printer else (f"Any {item.target_model}" if target_model_norm else "Unassigned")
  500. )
  501. await notification_service.on_queue_job_added(
  502. job_name=job_name,
  503. target=target,
  504. db=db,
  505. printer_id=item.printer_id,
  506. printer_name=item.printer.name if item.printer else None,
  507. )
  508. except Exception:
  509. pass # Don't fail queue add if notification fails
  510. return _enrich_response(item)
  511. @router.patch("/bulk", response_model=PrintQueueBulkUpdateResponse)
  512. async def bulk_update_queue_items(
  513. data: PrintQueueBulkUpdate,
  514. db: AsyncSession = Depends(get_db),
  515. auth_result: tuple[User | None, bool] = Depends(
  516. require_ownership_permission(
  517. Permission.QUEUE_UPDATE_ALL,
  518. Permission.QUEUE_UPDATE_OWN,
  519. )
  520. ),
  521. ):
  522. """Bulk update multiple queue items with the same values.
  523. Only pending items can be updated. Non-pending items are skipped.
  524. Items not owned by the user are also skipped (unless user has *_all permission).
  525. """
  526. user, can_modify_all = auth_result
  527. if not data.item_ids:
  528. raise HTTPException(400, "No item IDs provided")
  529. # Get fields to update (exclude item_ids and unset fields)
  530. update_data = data.model_dump(exclude={"item_ids"}, exclude_unset=True)
  531. if not update_data:
  532. raise HTTPException(400, "No fields to update")
  533. # Validate printer_id if being changed
  534. if "printer_id" in update_data and update_data["printer_id"] is not None:
  535. result = await db.execute(select(Printer).where(Printer.id == update_data["printer_id"]))
  536. if not result.scalar_one_or_none():
  537. raise HTTPException(400, "Printer not found")
  538. # Fetch all items
  539. result = await db.execute(select(PrintQueueItem).where(PrintQueueItem.id.in_(data.item_ids)))
  540. items = result.scalars().all()
  541. updated_count = 0
  542. skipped_count = 0
  543. for item in items:
  544. if item.status != "pending":
  545. skipped_count += 1
  546. continue
  547. # Ownership check
  548. if not can_modify_all and item.created_by_id != user.id:
  549. skipped_count += 1
  550. continue
  551. for field, value in update_data.items():
  552. setattr(item, field, value)
  553. updated_count += 1
  554. await db.commit()
  555. logger.info("Bulk updated %s queue items, skipped %s", updated_count, skipped_count)
  556. return PrintQueueBulkUpdateResponse(
  557. updated_count=updated_count,
  558. skipped_count=skipped_count,
  559. message=f"Updated {updated_count} items"
  560. + (f", skipped {skipped_count} non-pending/not-owned" if skipped_count else ""),
  561. )
  562. # --- Batch endpoints ---
  563. @router.get("/batches", response_model=list[PrintBatchResponse])
  564. async def list_batches(
  565. status: str | None = Query(None, description="Filter by status (active, completed, cancelled)"),
  566. db: AsyncSession = Depends(get_db),
  567. current_user: User | None = RequirePermissionIfAuthEnabled(Permission.QUEUE_READ),
  568. ):
  569. """List all print batches with progress stats."""
  570. query = select(PrintBatch).order_by(PrintBatch.created_at.desc())
  571. if status:
  572. query = query.where(PrintBatch.status == status)
  573. result = await db.execute(query)
  574. batches = result.scalars().all()
  575. responses = []
  576. for batch in batches:
  577. responses.append(await _build_batch_response(db, batch))
  578. return responses
  579. @router.get("/batches/{batch_id}", response_model=PrintBatchResponse)
  580. async def get_batch(
  581. batch_id: int,
  582. db: AsyncSession = Depends(get_db),
  583. current_user: User | None = RequirePermissionIfAuthEnabled(Permission.QUEUE_READ),
  584. ):
  585. """Get a print batch with progress stats."""
  586. result = await db.execute(select(PrintBatch).where(PrintBatch.id == batch_id))
  587. batch = result.scalar_one_or_none()
  588. if not batch:
  589. raise HTTPException(404, "Batch not found")
  590. return await _build_batch_response(db, batch)
  591. @router.delete("/batches/{batch_id}")
  592. async def cancel_batch(
  593. batch_id: int,
  594. db: AsyncSession = Depends(get_db),
  595. current_user: User | None = RequirePermissionIfAuthEnabled(Permission.QUEUE_DELETE_ALL),
  596. ):
  597. """Cancel all pending items in a batch and mark batch as cancelled."""
  598. result = await db.execute(select(PrintBatch).where(PrintBatch.id == batch_id))
  599. batch = result.scalar_one_or_none()
  600. if not batch:
  601. raise HTTPException(404, "Batch not found")
  602. # Cancel all pending queue items in this batch
  603. result = await db.execute(
  604. select(PrintQueueItem).where(and_(PrintQueueItem.batch_id == batch_id, PrintQueueItem.status == "pending"))
  605. )
  606. pending_items = result.scalars().all()
  607. cancelled_count = 0
  608. for item in pending_items:
  609. item.status = "cancelled"
  610. cancelled_count += 1
  611. batch.status = "cancelled"
  612. await db.commit()
  613. return {"message": f"Batch cancelled, {cancelled_count} pending items cancelled"}
  614. async def _build_batch_response(db: AsyncSession, batch: PrintBatch) -> PrintBatchResponse:
  615. """Build a batch response with derived counts from queue items."""
  616. # Count queue items by status
  617. result = await db.execute(
  618. select(PrintQueueItem.status, func.count(PrintQueueItem.id))
  619. .where(PrintQueueItem.batch_id == batch.id)
  620. .group_by(PrintQueueItem.status)
  621. )
  622. status_counts = {row[0]: row[1] for row in result.fetchall()}
  623. # Load created_by for username
  624. created_by_username = None
  625. if batch.created_by_id:
  626. result = await db.execute(select(User).where(User.id == batch.created_by_id))
  627. user = result.scalar_one_or_none()
  628. if user:
  629. created_by_username = user.username
  630. return PrintBatchResponse(
  631. id=batch.id,
  632. name=batch.name,
  633. archive_id=batch.archive_id,
  634. library_file_id=batch.library_file_id,
  635. quantity=batch.quantity,
  636. status=batch.status,
  637. created_at=batch.created_at,
  638. created_by_id=batch.created_by_id,
  639. created_by_username=created_by_username,
  640. pending_count=status_counts.get("pending", 0),
  641. printing_count=status_counts.get("printing", 0),
  642. completed_count=status_counts.get("completed", 0),
  643. failed_count=status_counts.get("failed", 0),
  644. cancelled_count=status_counts.get("cancelled", 0),
  645. )
  646. @router.get("/{item_id}", response_model=PrintQueueItemResponse)
  647. async def get_queue_item(
  648. item_id: int,
  649. db: AsyncSession = Depends(get_db),
  650. _: User | None = RequirePermissionIfAuthEnabled(Permission.QUEUE_READ),
  651. ):
  652. """Get a specific queue item."""
  653. result = await db.execute(
  654. select(PrintQueueItem)
  655. .options(
  656. selectinload(PrintQueueItem.archive),
  657. selectinload(PrintQueueItem.printer),
  658. selectinload(PrintQueueItem.library_file),
  659. selectinload(PrintQueueItem.created_by),
  660. selectinload(PrintQueueItem.batch),
  661. )
  662. .where(PrintQueueItem.id == item_id)
  663. )
  664. item = result.scalar_one_or_none()
  665. if not item:
  666. raise HTTPException(404, "Queue item not found")
  667. return _enrich_response(item)
  668. @router.patch("/{item_id}", response_model=PrintQueueItemResponse)
  669. async def update_queue_item(
  670. item_id: int,
  671. data: PrintQueueItemUpdate,
  672. db: AsyncSession = Depends(get_db),
  673. auth_result: tuple[User | None, bool] = Depends(
  674. require_ownership_permission(
  675. Permission.QUEUE_UPDATE_ALL,
  676. Permission.QUEUE_UPDATE_OWN,
  677. )
  678. ),
  679. ):
  680. """Update a queue item."""
  681. user, can_modify_all = auth_result
  682. result = await db.execute(select(PrintQueueItem).where(PrintQueueItem.id == item_id))
  683. item = result.scalar_one_or_none()
  684. if not item:
  685. raise HTTPException(404, "Queue item not found")
  686. # Ownership check
  687. if not can_modify_all:
  688. if item.created_by_id != user.id:
  689. raise HTTPException(403, "You can only update your own queue items")
  690. if item.status != "pending":
  691. raise HTTPException(400, "Can only update pending items")
  692. update_data = data.model_dump(exclude_unset=True)
  693. # Normalize target_model if being updated
  694. if "target_model" in update_data and update_data["target_model"]:
  695. update_data["target_model"] = (
  696. normalize_printer_model(update_data["target_model"])
  697. or normalize_printer_model_id(update_data["target_model"])
  698. or update_data["target_model"]
  699. )
  700. # Cannot specify both printer_id and target_model
  701. new_printer_id = update_data.get("printer_id", item.printer_id)
  702. new_target_model = update_data.get("target_model", item.target_model)
  703. if new_printer_id and new_target_model:
  704. raise HTTPException(400, "Cannot specify both printer_id and target_model")
  705. # Validate new printer_id if being changed (and not None)
  706. if "printer_id" in update_data and update_data["printer_id"] is not None:
  707. result = await db.execute(select(Printer).where(Printer.id == update_data["printer_id"]))
  708. if not result.scalar_one_or_none():
  709. raise HTTPException(400, "Printer not found")
  710. # Validate target_model has active printers
  711. if "target_model" in update_data and update_data["target_model"]:
  712. result = await db.execute(
  713. select(Printer).where(Printer.model == update_data["target_model"]).where(Printer.is_active == True) # noqa: E712
  714. )
  715. if not result.scalars().first():
  716. raise HTTPException(400, f"No active printers for model: {update_data['target_model']}")
  717. # Serialize ams_mapping to JSON for TEXT column storage
  718. if "ams_mapping" in update_data:
  719. update_data["ams_mapping"] = json.dumps(update_data["ams_mapping"]) if update_data["ams_mapping"] else None
  720. # Serialize filament_overrides to JSON for TEXT column storage
  721. if "filament_overrides" in update_data:
  722. update_data["filament_overrides"] = (
  723. json.dumps(update_data["filament_overrides"]) if update_data["filament_overrides"] else None
  724. )
  725. for field, value in update_data.items():
  726. setattr(item, field, value)
  727. await db.commit()
  728. await db.refresh(item, ["archive", "printer", "library_file", "created_by", "batch"])
  729. logger.info("Updated queue item %s", item_id)
  730. return _enrich_response(item)
  731. @router.delete("/{item_id}")
  732. async def delete_queue_item(
  733. item_id: int,
  734. db: AsyncSession = Depends(get_db),
  735. auth_result: tuple[User | None, bool] = Depends(
  736. require_ownership_permission(
  737. Permission.QUEUE_DELETE_ALL,
  738. Permission.QUEUE_DELETE_OWN,
  739. )
  740. ),
  741. ):
  742. """Remove an item from the queue."""
  743. user, can_modify_all = auth_result
  744. result = await db.execute(select(PrintQueueItem).where(PrintQueueItem.id == item_id))
  745. item = result.scalar_one_or_none()
  746. if not item:
  747. raise HTTPException(404, "Queue item not found")
  748. # Ownership check
  749. if not can_modify_all:
  750. if item.created_by_id != user.id:
  751. raise HTTPException(403, "You can only delete your own queue items")
  752. if item.status == "printing":
  753. raise HTTPException(400, "Cannot delete item that is currently printing")
  754. await db.delete(item)
  755. await db.commit()
  756. logger.info("Deleted queue item %s", item_id)
  757. return {"message": "Queue item deleted"}
  758. @router.post("/reorder")
  759. async def reorder_queue(
  760. data: PrintQueueReorder,
  761. db: AsyncSession = Depends(get_db),
  762. _: User | None = RequirePermissionIfAuthEnabled(Permission.QUEUE_UPDATE_ALL),
  763. ):
  764. """Bulk update positions for queue items."""
  765. for reorder_item in data.items:
  766. result = await db.execute(select(PrintQueueItem).where(PrintQueueItem.id == reorder_item.id))
  767. item = result.scalar_one_or_none()
  768. if item and item.status == "pending":
  769. item.position = reorder_item.position
  770. await db.commit()
  771. logger.info("Reordered %s queue items", len(data.items))
  772. return {"message": f"Reordered {len(data.items)} items"}
  773. @router.post("/{item_id}/cancel")
  774. async def cancel_queue_item(
  775. item_id: int,
  776. db: AsyncSession = Depends(get_db),
  777. auth_result: tuple[User | None, bool] = Depends(
  778. require_ownership_permission(
  779. Permission.QUEUE_UPDATE_ALL,
  780. Permission.QUEUE_UPDATE_OWN,
  781. )
  782. ),
  783. ):
  784. """Cancel a pending queue item."""
  785. user, can_modify_all = auth_result
  786. result = await db.execute(select(PrintQueueItem).where(PrintQueueItem.id == item_id))
  787. item = result.scalar_one_or_none()
  788. if not item:
  789. raise HTTPException(404, "Queue item not found")
  790. # Ownership check
  791. if not can_modify_all:
  792. if item.created_by_id != user.id:
  793. raise HTTPException(403, "You can only cancel your own queue items")
  794. if item.status not in ("pending",):
  795. raise HTTPException(400, f"Cannot cancel item with status '{item.status}'")
  796. item.status = "cancelled"
  797. item.completed_at = datetime.now(timezone.utc)
  798. await db.commit()
  799. logger.info("Cancelled queue item %s", item_id)
  800. return {"message": "Queue item cancelled"}
  801. @router.post("/{item_id}/stop")
  802. async def stop_queue_item(
  803. item_id: int,
  804. db: AsyncSession = Depends(get_db),
  805. _: User | None = RequirePermissionIfAuthEnabled(Permission.QUEUE_UPDATE_ALL),
  806. ):
  807. """Stop an actively printing queue item."""
  808. import asyncio
  809. from backend.app.models.smart_plug import SmartPlug
  810. from backend.app.services.printer_manager import printer_manager
  811. from backend.app.services.tasmota import tasmota_service
  812. result = await db.execute(select(PrintQueueItem).where(PrintQueueItem.id == item_id))
  813. item = result.scalar_one_or_none()
  814. if not item:
  815. raise HTTPException(404, "Queue item not found")
  816. if item.status != "printing":
  817. raise HTTPException(400, f"Can only stop items that are printing, current status: '{item.status}'")
  818. # Capture values we need for background task
  819. printer_id = item.printer_id
  820. auto_off_after = item.auto_off_after
  821. # Try to send stop command to printer
  822. stop_sent = False
  823. try:
  824. stop_sent = printer_manager.stop_print(printer_id)
  825. if not stop_sent:
  826. logger.warning("stop_print returned False for printer %s - printer may not be connected", printer_id)
  827. except Exception as e:
  828. logger.error("Error sending stop command for queue item %s: %s", item_id, e)
  829. # Mark this printer as user-stopped BEFORE the first await so that if the
  830. # MQTT on_print_complete callback fires during the db.commit() yield the flag
  831. # is already set and the "failed" status will be correctly overridden to
  832. # "cancelled" (preventing a spurious "print failed" notification).
  833. try:
  834. from backend.app.main import mark_printer_stopped_by_user
  835. mark_printer_stopped_by_user(printer_id)
  836. except Exception as _mark_err:
  837. logger.warning("Failed to mark printer %s as user-stopped: %s", printer_id, _mark_err)
  838. # Update queue item status regardless - if printer is off, print is already stopped
  839. item.status = "cancelled"
  840. item.completed_at = datetime.now(timezone.utc)
  841. item.error_message = "Stopped by user" if stop_sent else "Stopped by user (printer was offline)"
  842. await db.commit()
  843. # Get smart plug info if auto-off is enabled
  844. plug_ip = None
  845. if auto_off_after:
  846. result = await db.execute(select(SmartPlug).where(SmartPlug.printer_id == printer_id))
  847. plug = result.scalar_one_or_none()
  848. if plug and plug.enabled:
  849. plug_ip = plug.ip_address
  850. logger.info("Stopped printing queue item %s (stop command sent: %s)", item_id, stop_sent)
  851. # Schedule background task for cooldown + power off
  852. if plug_ip:
  853. async def cooldown_and_poweroff():
  854. logger.info("Auto-off: Waiting for printer %s to cool down before power off...", printer_id)
  855. await printer_manager.wait_for_cooldown(printer_id, target_temp=50.0, timeout=600)
  856. # Re-fetch plug since we're in a new async context
  857. from backend.app.core.database import async_session
  858. async with async_session() as new_db:
  859. result = await new_db.execute(select(SmartPlug).where(SmartPlug.printer_id == printer_id))
  860. plug = result.scalar_one_or_none()
  861. if plug and plug.enabled:
  862. logger.info("Auto-off: Powering off printer %s", printer_id)
  863. await tasmota_service.turn_off(plug)
  864. asyncio.create_task(cooldown_and_poweroff())
  865. return {"message": "Print stopped" if stop_sent else "Queue item cancelled (printer was offline)"}
  866. @router.post("/{item_id}/start")
  867. async def start_queue_item(
  868. item_id: int,
  869. db: AsyncSession = Depends(get_db),
  870. _: User | None = RequirePermissionIfAuthEnabled(Permission.QUEUE_UPDATE_OWN),
  871. ):
  872. """Manually start a staged (manual_start) queue item.
  873. This clears the manual_start flag so the scheduler will pick it up,
  874. or starts immediately if the printer is ready.
  875. """
  876. result = await db.execute(
  877. select(PrintQueueItem)
  878. .options(
  879. selectinload(PrintQueueItem.archive),
  880. selectinload(PrintQueueItem.printer),
  881. selectinload(PrintQueueItem.batch),
  882. )
  883. .where(PrintQueueItem.id == item_id)
  884. )
  885. item = result.scalar_one_or_none()
  886. if not item:
  887. raise HTTPException(404, "Queue item not found")
  888. if item.status != "pending":
  889. raise HTTPException(400, f"Can only start pending items, current status: '{item.status}'")
  890. # Clear manual_start flag so scheduler picks it up
  891. item.manual_start = False
  892. await db.commit()
  893. await db.refresh(item, ["archive", "printer", "library_file", "created_by", "batch"])
  894. logger.info("Manually started queue item %s (cleared manual_start flag)", item_id)
  895. return _enrich_response(item)