print_queue.py 41 KB

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