webhook.py 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433
  1. import logging
  2. from fastapi import APIRouter, Depends, HTTPException
  3. from pydantic import BaseModel
  4. from sqlalchemy import select
  5. from sqlalchemy.ext.asyncio import AsyncSession
  6. from backend.app.api.routes.print_queue import _assert_can_queue_archive
  7. from backend.app.core.auth import (
  8. ApiKeyActor,
  9. api_key_printer_scope,
  10. check_webhook_permission,
  11. ensure_api_key_printer_access,
  12. get_api_key,
  13. is_auth_enabled,
  14. queue_review_required_for,
  15. resolve_apikey_owner,
  16. )
  17. from backend.app.core.database import get_db
  18. from backend.app.models.api_key import APIKey
  19. from backend.app.models.archive import PrintArchive
  20. from backend.app.models.print_queue import PrintQueueItem
  21. from backend.app.models.printer import Printer
  22. from backend.app.schemas.printer import HMSErrorResponse, hms_error_responses
  23. from backend.app.services.print_confirmation import confirm_outcome_for_new_queue_item
  24. from backend.app.services.print_control import stop_print_by_user
  25. from backend.app.services.print_defaults import default_print_options
  26. from backend.app.services.printer_manager import printer_manager
  27. from backend.app.services.queue_announcements import announce_queue_jobs_added
  28. from backend.app.services.queue_position import next_queue_position
  29. from backend.app.utils.local_time import to_naive_utc
  30. logger = logging.getLogger(__name__)
  31. router = APIRouter(prefix="/webhook", tags=["webhook"])
  32. # Request schemas
  33. class QueueAddRequest(BaseModel):
  34. archive_id: int
  35. printer_id: int
  36. project_id: int | None = None
  37. scheduled_time: str | None = None # ISO format datetime
  38. require_previous_success: bool = False
  39. auto_off_after: bool = False
  40. class QueueAddResponse(BaseModel):
  41. id: int
  42. archive_id: int
  43. printer_id: int
  44. position: int
  45. status: str
  46. message: str
  47. class PrinterStatusResponse(BaseModel):
  48. id: int
  49. name: str
  50. # The printer's own serial, so a client can tell printers apart by what
  51. # they report rather than by Bambuddy's row id (#2919).
  52. serial_number: str
  53. connected: bool
  54. state: str | None
  55. current_print: str | None
  56. progress: float | None
  57. # Minutes, as the printer reports it. Kept for existing clients;
  58. # remaining_seconds is the same estimate in seconds, the unit the
  59. # notification pipeline uses (#2919).
  60. remaining_time: int | None
  61. remaining_seconds: int | None = None
  62. layer_num: int | None = None
  63. total_layers: int | None = None
  64. # Bambu's id for the running job. A new value marks a new print, even when
  65. # two prints of the same file run back to back between two polls. None
  66. # when the job has no id: Bambu reports "0" or "" for local prints (for
  67. # example one started on the printer), the same reading main.py uses.
  68. subtask_id: str | None = None
  69. # Live HMS faults, in the same shape as GET /printers/{id}/status. They
  70. # tell a filament runout apart from someone pressing pause.
  71. hms_errors: list[HMSErrorResponse] = []
  72. class QueueStatusResponse(BaseModel):
  73. printer_id: int
  74. printer_name: str
  75. pending: int
  76. printing: int
  77. items: list[dict]
  78. def _job_id(subtask_id) -> str | None:
  79. """The printer's job id as text, or None when the job has none.
  80. Stored as the printer sent it, so coerce: a numeric id would fail
  81. validation and turn a status poll into a 500.
  82. """
  83. if subtask_id is None:
  84. return None
  85. value = str(subtask_id).strip()
  86. return None if value in ("", "0") else value
  87. # Webhook endpoints
  88. @router.post("/queue/add", response_model=QueueAddResponse)
  89. async def webhook_add_to_queue(
  90. data: QueueAddRequest,
  91. api_key: APIKey = Depends(get_api_key),
  92. db: AsyncSession = Depends(get_db),
  93. ):
  94. """Add a print to the queue via webhook.
  95. Requires 'can_queue' permission.
  96. """
  97. await check_webhook_permission(db, api_key, "queue")
  98. await ensure_api_key_printer_access(db, api_key, data.printer_id)
  99. # Verify archive exists and passes the same source gate as POST /queue/,
  100. # with the key acting for its owner within its printers.
  101. result = await db.execute(select(PrintArchive).where(PrintArchive.id == data.archive_id))
  102. archive = result.scalar_one_or_none()
  103. if not archive:
  104. raise HTTPException(status_code=404, detail="Archive not found")
  105. # Auth off: no owner to act for, as on POST /queue/; the key's printers still apply.
  106. actor = ApiKeyActor(api_key, await resolve_apikey_owner(db, api_key)) if await is_auth_enabled(db) else None
  107. _assert_can_queue_archive(archive, actor, await api_key_printer_scope(db, api_key))
  108. # Verify printer exists
  109. result = await db.execute(select(Printer).where(Printer.id == data.printer_id))
  110. printer = result.scalar_one_or_none()
  111. if not printer:
  112. raise HTTPException(status_code=404, detail="Printer not found")
  113. # Append to the end of the queue: positions are one sequence across all
  114. # pending items, not one per printer (#3200).
  115. next_position = await next_queue_position(db)
  116. # Parse scheduled time if provided
  117. scheduled_time = None
  118. if data.scheduled_time:
  119. from datetime import datetime
  120. try:
  121. # Stored as naive UTC: an offset is converted, not dropped.
  122. scheduled_time = to_naive_utc(datetime.fromisoformat(data.scheduled_time.replace("Z", "+00:00")))
  123. except (ValueError, OverflowError):
  124. raise HTTPException(status_code=400, detail="Invalid scheduled_time format")
  125. # Create queue item
  126. queue_item = PrintQueueItem(
  127. printer_id=data.printer_id,
  128. archive_id=data.archive_id,
  129. project_id=data.project_id,
  130. position=next_position,
  131. scheduled_time=scheduled_time,
  132. require_previous_success=data.require_previous_success,
  133. auto_off_after=data.auto_off_after,
  134. # No dialog to pick this per job, so the install-wide default decides
  135. # whether the finished print asks for a verdict (#1898).
  136. confirm_outcome=await confirm_outcome_for_new_queue_item(db),
  137. # Attribute to the key's owner so the item shows up under `queue:read_own`
  138. # for the person whose key it is. Legacy keys predating per-user ownership
  139. # have no `user_id`, and those rows stay ownerless.
  140. created_by_id=api_key.user_id,
  141. # Waits for someone to start it unless the owner may print without review (#1620)
  142. manual_start=await is_auth_enabled(db) and queue_review_required_for(await resolve_apikey_owner(db, api_key)),
  143. # No print options in the request: the install's defaults.
  144. **await default_print_options(db),
  145. )
  146. db.add(queue_item)
  147. await db.commit()
  148. await db.refresh(queue_item)
  149. await announce_queue_jobs_added(db, [queue_item.id])
  150. return QueueAddResponse(
  151. id=queue_item.id,
  152. archive_id=queue_item.archive_id,
  153. printer_id=queue_item.printer_id,
  154. position=queue_item.position,
  155. status=queue_item.status,
  156. message=f"Added to queue at position {queue_item.position}",
  157. )
  158. @router.post("/printer/{printer_id}/start")
  159. async def webhook_start_print(
  160. printer_id: int,
  161. api_key: APIKey = Depends(get_api_key),
  162. db: AsyncSession = Depends(get_db),
  163. ):
  164. """Trigger the next manual-start queue item on a printer.
  165. Mirrors `POST /print-queue/{item_id}/start`: clears `manual_start` on
  166. the next pending item so the scheduler picks it up — which handles
  167. FTP upload, AMS mapping, and all print options (timelapse,
  168. bed_levelling, etc.) correctly via the queue's stored fields. The
  169. previous implementation called `printer_manager.start_print()`
  170. directly with `archive_id` as the filename arg and no print options,
  171. bypassing the upload step entirely and discarding the user's
  172. workflow choices — it 500'd before ever reaching the printer.
  173. Requires 'can_control_printer' permission.
  174. """
  175. await check_webhook_permission(db, api_key, "control_printer")
  176. await ensure_api_key_printer_access(db, api_key, printer_id)
  177. # Get printer
  178. result = await db.execute(select(Printer).where(Printer.id == printer_id))
  179. printer = result.scalar_one_or_none()
  180. if not printer:
  181. raise HTTPException(status_code=404, detail="Printer not found")
  182. # Get next pending queue item
  183. result = await db.execute(
  184. select(PrintQueueItem)
  185. .where(
  186. PrintQueueItem.printer_id == printer_id,
  187. PrintQueueItem.status == "pending",
  188. )
  189. .order_by(PrintQueueItem.position)
  190. .limit(1)
  191. )
  192. queue_item = result.scalar_one_or_none()
  193. if not queue_item:
  194. raise HTTPException(status_code=404, detail="No pending prints in queue")
  195. # Starting a waiting job is a review decision (#1620): a key whose owner
  196. # needs review for their own jobs can't make one for anybody's
  197. if (
  198. queue_item.manual_start
  199. and await is_auth_enabled(db)
  200. and queue_review_required_for(await resolve_apikey_owner(db, api_key))
  201. ):
  202. raise HTTPException(
  203. status_code=403,
  204. detail="The next job waits for review: someone who can manage all queue jobs has to start it",
  205. )
  206. # Clear manual_start so the scheduler will dispatch. If the item was
  207. # already auto-dispatchable this is a no-op; the scheduler will still
  208. # pick it up on its next tick.
  209. queue_item.manual_start = False
  210. await db.commit()
  211. await db.refresh(queue_item)
  212. logger.info("Webhook started queue item %s on printer %s", queue_item.id, printer_id)
  213. return {"message": "Print started", "queue_item_id": queue_item.id}
  214. # States in which a print can be stopped, as with the Stop button on the
  215. # printer card: printing or paused.
  216. _STOPPABLE_STATES = ("RUNNING", "PAUSE")
  217. def _stop_current_print(printer_id: int) -> None:
  218. """Stop the print on the user's behalf (cancel and stop are the same command)."""
  219. try:
  220. sent = stop_print_by_user(printer_id)
  221. except Exception as e:
  222. logger.error("Failed to stop print on printer %s: %s", printer_id, e)
  223. raise HTTPException(status_code=500, detail=str(e))
  224. if not sent:
  225. raise HTTPException(status_code=503, detail="Printer not connected")
  226. @router.post("/printer/{printer_id}/stop")
  227. async def webhook_stop_print(
  228. printer_id: int,
  229. api_key: APIKey = Depends(get_api_key),
  230. db: AsyncSession = Depends(get_db),
  231. ):
  232. """Stop the current print on a printer.
  233. Requires 'can_control_printer' permission.
  234. """
  235. await check_webhook_permission(db, api_key, "control_printer")
  236. await ensure_api_key_printer_access(db, api_key, printer_id)
  237. status = printer_manager.get_status(printer_id)
  238. # `printer_manager.get_status(...)` returns a ``PrinterState`` dataclass
  239. # (see backend/app/services/bambu_mqtt.py), not a dict — `.get(...)` on it
  240. # raises AttributeError and surfaces as a generic 500 (#1584).
  241. if not status or not status.connected:
  242. raise HTTPException(status_code=503, detail="Printer not connected")
  243. if status.state not in _STOPPABLE_STATES:
  244. raise HTTPException(status_code=409, detail="No print in progress")
  245. _stop_current_print(printer_id)
  246. return {"message": "Print stopped"}
  247. @router.post("/printer/{printer_id}/cancel")
  248. async def webhook_cancel_print(
  249. printer_id: int,
  250. api_key: APIKey = Depends(get_api_key),
  251. db: AsyncSession = Depends(get_db),
  252. ):
  253. """Cancel the current print on a printer.
  254. Requires 'can_control_printer' permission.
  255. """
  256. await check_webhook_permission(db, api_key, "control_printer")
  257. await ensure_api_key_printer_access(db, api_key, printer_id)
  258. status = printer_manager.get_status(printer_id)
  259. # Same dataclass-not-dict shape as stop_print above (#1584).
  260. if not status or not status.connected:
  261. raise HTTPException(status_code=503, detail="Printer not connected")
  262. if status.state not in _STOPPABLE_STATES:
  263. raise HTTPException(status_code=409, detail="No print to cancel")
  264. _stop_current_print(printer_id)
  265. return {"message": "Print cancelled"}
  266. @router.get("/printer/{printer_id}/status", response_model=PrinterStatusResponse)
  267. async def webhook_get_printer_status(
  268. printer_id: int,
  269. api_key: APIKey = Depends(get_api_key),
  270. db: AsyncSession = Depends(get_db),
  271. ):
  272. """Get status of a printer.
  273. Requires 'can_read_status' permission.
  274. """
  275. await check_webhook_permission(db, api_key, "read_status")
  276. await ensure_api_key_printer_access(db, api_key, printer_id)
  277. # Get printer
  278. result = await db.execute(select(Printer).where(Printer.id == printer_id))
  279. printer = result.scalar_one_or_none()
  280. if not printer:
  281. raise HTTPException(status_code=404, detail="Printer not found")
  282. status = printer_manager.get_status(printer_id)
  283. # `printer_manager.get_status(...)` returns a ``PrinterState`` dataclass —
  284. # attribute access, not dict lookup. The previous `.get(...)` calls raised
  285. # AttributeError and surfaced as a generic 500 for any printer that
  286. # actually had a status row (#1584).
  287. if status is None:
  288. return PrinterStatusResponse(
  289. id=printer.id,
  290. name=printer.name,
  291. serial_number=printer.serial_number,
  292. connected=False,
  293. state=None,
  294. current_print=None,
  295. progress=None,
  296. remaining_time=None,
  297. )
  298. return PrinterStatusResponse(
  299. id=printer.id,
  300. name=printer.name,
  301. serial_number=printer.serial_number,
  302. connected=status.connected,
  303. state=status.state,
  304. current_print=status.current_print,
  305. progress=status.progress,
  306. remaining_time=status.remaining_time,
  307. remaining_seconds=status.remaining_time * 60 if status.remaining_time is not None else None,
  308. layer_num=status.layer_num,
  309. total_layers=status.total_layers,
  310. subtask_id=_job_id(status.subtask_id),
  311. hms_errors=hms_error_responses(status.hms_errors),
  312. )
  313. @router.get("/queue", response_model=list[QueueStatusResponse])
  314. async def webhook_get_queue_status(
  315. printer_id: int | None = None,
  316. api_key: APIKey = Depends(get_api_key),
  317. db: AsyncSession = Depends(get_db),
  318. ):
  319. """Get queue status for all printers or a specific printer.
  320. Requires 'can_read_status' permission.
  321. """
  322. await check_webhook_permission(db, api_key, "read_status")
  323. # Get printers
  324. if printer_id:
  325. await ensure_api_key_printer_access(db, api_key, printer_id)
  326. result = await db.execute(select(Printer).where(Printer.id == printer_id))
  327. printers = result.scalars().all()
  328. else:
  329. result = await db.execute(select(Printer))
  330. printers = result.scalars().all()
  331. # Only the printers the key (and its owner) may reach
  332. scope = await api_key_printer_scope(db, api_key)
  333. printers = [p for p in printers if scope.allows(p.id)]
  334. response = []
  335. for printer in printers:
  336. # Get queue items
  337. result = await db.execute(
  338. select(PrintQueueItem)
  339. .where(
  340. PrintQueueItem.printer_id == printer.id,
  341. PrintQueueItem.status.in_(["pending", "printing"]),
  342. )
  343. .order_by(PrintQueueItem.position)
  344. )
  345. items = result.scalars().all()
  346. pending_count = sum(1 for i in items if i.status == "pending")
  347. printing_count = sum(1 for i in items if i.status == "printing")
  348. response.append(
  349. QueueStatusResponse(
  350. printer_id=printer.id,
  351. printer_name=printer.name,
  352. pending=pending_count,
  353. printing=printing_count,
  354. items=[
  355. {
  356. "id": item.id,
  357. "archive_id": item.archive_id,
  358. "position": item.position,
  359. "status": item.status,
  360. }
  361. for item in items
  362. ],
  363. )
  364. )
  365. return response