print_queue.py 42 KB

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