archive.py 65 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519
  1. import hashlib
  2. import json
  3. import logging
  4. import os
  5. import re
  6. import shutil
  7. import zipfile
  8. from datetime import date, datetime, time, timezone
  9. from pathlib import Path
  10. from defusedxml import ElementTree as ET
  11. from sqlalchemy import and_, or_, select, text
  12. from sqlalchemy.ext.asyncio import AsyncSession
  13. from backend.app.core.config import settings
  14. from backend.app.models.archive import PrintArchive
  15. from backend.app.models.filament import Filament
  16. from backend.app.models.printer import Printer
  17. logger = logging.getLogger(__name__)
  18. def _copy_and_fsync(src: Path, dst: Path, chunk_size: int = 1024 * 1024) -> None:
  19. """Copy src to dst with an explicit chunked read/write and fsync the dst.
  20. Replacement for shutil.copy2 in the archive pipeline. shutil.copy2 uses
  21. Linux sendfile(), which on some kernels/filesystems has returned a short
  22. count on the first call and truncated the destination for larger 3MF
  23. uploads (#1032, observed on Raspberry Pi OS bookworm / armv7l). An
  24. explicit loop with fsync avoids that path and guarantees the dest bytes
  25. are on disk before the caller inspects them as a ZIP.
  26. """
  27. with src.open("rb") as rf, dst.open("wb") as wf:
  28. while True:
  29. buf = rf.read(chunk_size)
  30. if not buf:
  31. break
  32. wf.write(buf)
  33. wf.flush()
  34. os.fsync(wf.fileno())
  35. shutil.copystat(src, dst)
  36. def resolve_display_stem(filename: str) -> str:
  37. """Return a clean human-readable stem from a 3MF/gcode filename.
  38. Bambu Studio's "Send to printer" dialog typically writes files like
  39. ``Plate_1.gcode.3mf`` (a sliced gcode payload wrapped in a 3MF container).
  40. The naive ``Path(filename).stem`` only drops the last suffix, leaving
  41. ``Plate_1.gcode`` — which then surfaces in the archive UI as a confusing
  42. ``Plate_1.gcode`` rather than ``Plate_1`` (#1152 follow-up).
  43. Strip the recognised print-format suffixes in order:
  44. - ``.gcode.3mf`` → bare stem (Bambu Studio FTP send)
  45. - ``.3mf`` → bare stem
  46. - ``.gcode`` → bare stem (rare standalone gcode upload)
  47. Anything else passes through unchanged.
  48. """
  49. name = Path(filename).name # drop any path components
  50. lower = name.lower()
  51. for suffix in (".gcode.3mf", ".3mf", ".gcode"):
  52. if lower.endswith(suffix):
  53. return name[: -len(suffix)]
  54. return Path(name).stem
  55. def peek_plate_index_in_3mf(file_path: Path) -> int | None:
  56. """Return the plate index recorded inside a Bambu 3MF, or None.
  57. Reads only ``Metadata/slice_info.config`` to keep this cheap — used by
  58. the print-start callback to verify that the 3MF we just downloaded over
  59. FTP actually matches the plate the printer is running (#1204). The full
  60. ThreeMFParser does much more work and runs later inside ArchiveService.
  61. """
  62. try:
  63. with zipfile.ZipFile(file_path, "r") as zf:
  64. if "Metadata/slice_info.config" not in zf.namelist():
  65. return None
  66. content = zf.read("Metadata/slice_info.config").decode()
  67. root = ET.fromstring(content)
  68. plate = root.find(".//plate")
  69. if plate is None:
  70. return None
  71. for meta in plate.findall("metadata"):
  72. if meta.get("key") == "index":
  73. value = meta.get("value")
  74. if value:
  75. try:
  76. return int(value)
  77. except ValueError:
  78. return None
  79. except Exception:
  80. return None
  81. return None
  82. _PLATE_SUFFIX_RE = re.compile(r"^(.*?)(\s*-\s*Plate\s+|_plate_)(\d+)$", re.IGNORECASE)
  83. def swap_plate_suffix(name: str | None, target_plate: int) -> str | None:
  84. """Return ``name`` with its trailing plate number replaced, or None.
  85. Bambu Studio names multi-plate uploads ``"<Project> - Plate <N>"`` (and
  86. a lowercase ``"_plate_<N>"`` variant exists too — see
  87. test_print_start_expected_promotion). When MQTT subtask_name lags
  88. across consecutive plates of the same model (#1204) the suffix points
  89. at the previous plate; swapping it gives us the correct upload to
  90. re-fetch from FTP. Returns None if no recognised suffix is present.
  91. """
  92. if not name:
  93. return None
  94. m = _PLATE_SUFFIX_RE.match(name)
  95. if not m:
  96. return None
  97. base, separator, _ = m.groups()
  98. return f"{base}{separator}{target_plate}"
  99. class ThreeMFParser:
  100. """Parser for Bambu Lab 3MF files."""
  101. def __init__(self, file_path: Path, plate_number: int | None = None):
  102. self.file_path = file_path
  103. self.plate_number = plate_number # Which plate was printed (1, 2, 3, etc.)
  104. self.metadata: dict = {}
  105. def parse(self) -> dict:
  106. """Extract metadata from 3MF file."""
  107. try:
  108. with zipfile.ZipFile(self.file_path, "r") as zf:
  109. self._parse_slice_info(zf) # Now sets self.plate_number from slice_info
  110. self._parse_project_settings(zf)
  111. self._parse_gcode_header(zf)
  112. self._parse_3dmodel(zf)
  113. self._extract_thumbnail(zf) # Uses correct plate_number for thumbnail
  114. # Enhance print_name with plate info if this is a multi-plate export
  115. plate_index = self.metadata.get("_plate_index")
  116. if plate_index and plate_index > 1:
  117. # Append plate number to distinguish from other plates
  118. existing_name = self.metadata.get("print_name", "")
  119. if existing_name and f"Plate {plate_index}" not in existing_name:
  120. self.metadata["print_name"] = f"{existing_name} - Plate {plate_index}"
  121. # ALWAYS prefer slice_info values - they contain ONLY filaments actually used in print
  122. # project_settings contains ALL configured filaments (AMS slots), not just used ones
  123. if self.metadata.get("_slice_filament_type"):
  124. self.metadata["filament_type"] = self.metadata["_slice_filament_type"]
  125. if self.metadata.get("_slice_filament_color"):
  126. self.metadata["filament_color"] = self.metadata["_slice_filament_color"]
  127. # Clean up internal keys
  128. self.metadata.pop("_slice_filament_type", None)
  129. self.metadata.pop("_slice_filament_color", None)
  130. self.metadata.pop("_plate_index", None)
  131. except Exception as e:
  132. # Return whatever metadata was extracted before the error, but
  133. # surface the failure so corrupted / truncated 3MF archives are
  134. # visible in support bundles (#1032).
  135. logger.warning(
  136. "ThreeMFParser: failed to parse %s: %s(%s) — returning partial metadata",
  137. self.file_path,
  138. type(e).__name__,
  139. e,
  140. )
  141. return self.metadata
  142. def _parse_slice_info(self, zf: zipfile.ZipFile):
  143. """Parse slice_info.config for print settings and printable objects."""
  144. try:
  145. if "Metadata/slice_info.config" in zf.namelist():
  146. content = zf.read("Metadata/slice_info.config").decode()
  147. root = ET.fromstring(content)
  148. # Extract printer_model_id from plate metadata
  149. # Format: <plate><metadata key="printer_model_id" value="C11" /></plate>
  150. for meta in root.findall(".//metadata"):
  151. key = meta.get("key")
  152. value = meta.get("value")
  153. if key == "printer_model_id" and value:
  154. from backend.app.utils.printer_models import normalize_printer_model_id
  155. normalized = normalize_printer_model_id(value)
  156. if normalized:
  157. self.metadata["sliced_for_model"] = normalized
  158. break
  159. # Find the plate element (single-plate exports only have one plate)
  160. plate = root.find(".//plate")
  161. if plate is not None:
  162. # Extract metadata from plate element
  163. for meta in plate.findall("metadata"):
  164. key = meta.get("key")
  165. value = meta.get("value")
  166. if key == "index" and value:
  167. # Extract plate index - this tells us which plate was exported
  168. try:
  169. extracted_index = int(value)
  170. # Set plate_number if not already set from filename
  171. if not self.plate_number:
  172. self.plate_number = extracted_index
  173. # Store in metadata for print_name generation
  174. self.metadata["_plate_index"] = extracted_index
  175. except ValueError:
  176. pass # Skip non-numeric plate index
  177. elif key == "prediction" and value:
  178. self.metadata["print_time_seconds"] = int(value)
  179. elif key == "weight" and value:
  180. self.metadata["filament_used_grams"] = float(value)
  181. elif key == "curr_bed_type" and value:
  182. self.metadata["bed_type"] = value
  183. # Extract printable objects for skip object functionality
  184. # Objects are stored as <object identify_id="123" name="Part1" skipped="false" />
  185. printable_objects = {}
  186. for obj in plate.findall("object"):
  187. identify_id = obj.get("identify_id")
  188. name = obj.get("name")
  189. skipped = obj.get("skipped", "false")
  190. # Only include objects that are not pre-skipped
  191. if identify_id and name and skipped.lower() != "true":
  192. try:
  193. printable_objects[int(identify_id)] = name
  194. except ValueError:
  195. pass # Skip objects with non-numeric identify_id
  196. if printable_objects:
  197. self.metadata["printable_objects"] = printable_objects
  198. # Get filament info from filaments ACTUALLY USED in the print
  199. # slice_info has <filament id="1" type="PLA" color="#FFFFFF" used_g="100" />
  200. # Only include filaments where used_g > 0
  201. filaments = root.findall(".//filament")
  202. if filaments:
  203. # Collect unique filament types and colors for filaments that are actually used
  204. types = []
  205. colors = []
  206. for f in filaments:
  207. # Check if this filament is actually used in the print
  208. used_g = f.get("used_g", "0")
  209. try:
  210. used_amount = float(used_g)
  211. except (ValueError, TypeError):
  212. used_amount = 0
  213. # Only include if used_g > 0 (filament is actually consumed)
  214. if used_amount > 0:
  215. ftype = f.get("type")
  216. fcolor = f.get("color")
  217. if ftype and ftype not in types:
  218. types.append(ftype)
  219. if fcolor and fcolor not in colors:
  220. colors.append(fcolor)
  221. if types:
  222. self.metadata["_slice_filament_type"] = ", ".join(types)
  223. if colors:
  224. self.metadata["_slice_filament_color"] = ",".join(colors)
  225. # Collect per-slot filament usage for tracking & notifications
  226. filament_slots = []
  227. for f in filaments:
  228. slot_id = f.get("id")
  229. used_g_str = f.get("used_g", "0")
  230. try:
  231. used_g = float(used_g_str)
  232. except (ValueError, TypeError):
  233. used_g = 0
  234. if used_g > 0 and slot_id:
  235. filament_slots.append(
  236. {
  237. "slot_id": int(slot_id),
  238. "used_g": round(used_g, 2),
  239. "type": f.get("type", ""),
  240. "color": f.get("color", ""),
  241. }
  242. )
  243. if filament_slots:
  244. self.metadata["filament_slots"] = filament_slots
  245. except Exception:
  246. pass # Skip unparseable slice_info metadata
  247. def _parse_project_settings(self, zf: zipfile.ZipFile):
  248. """Parse project settings for print configuration."""
  249. try:
  250. if "Metadata/project_settings.config" in zf.namelist():
  251. content = zf.read("Metadata/project_settings.config").decode()
  252. try:
  253. data = json.loads(content)
  254. self._extract_filament_info(data)
  255. self._extract_print_settings(data)
  256. except json.JSONDecodeError:
  257. pass # Skip malformed project_settings JSON
  258. except Exception:
  259. pass # Skip unreadable project settings file
  260. def _parse_gcode_header(self, zf: zipfile.ZipFile):
  261. """Parse G-code file header for total layer count and printer model."""
  262. try:
  263. # Look for plate_1.gcode or similar
  264. gcode_files = [f for f in zf.namelist() if f.endswith(".gcode")]
  265. if not gcode_files:
  266. return
  267. # Read first 4KB of G-code (header contains metadata)
  268. gcode_path = gcode_files[0]
  269. with zf.open(gcode_path) as f:
  270. header = f.read(4096).decode("utf-8", errors="ignore")
  271. # Look for "; total layer number: XX" pattern
  272. match = re.search(r";\s*total\s+layer\s+number[:\s]+(\d+)", header, re.IGNORECASE)
  273. if match:
  274. self.metadata["total_layers"] = int(match.group(1))
  275. # Look for printer_model in gcode header (fallback if not found in slice_info)
  276. # Format: "; printer_model = Bambu Lab X1 Carbon" or "; printer_model = X1C"
  277. if "sliced_for_model" not in self.metadata:
  278. match = re.search(r";\s*printer_model\s*=\s*(.+)", header, re.IGNORECASE)
  279. if match:
  280. from backend.app.utils.printer_models import normalize_printer_model
  281. raw_model = match.group(1).strip()
  282. self.metadata["sliced_for_model"] = normalize_printer_model(raw_model)
  283. except Exception:
  284. pass # G-code header parsing is best-effort; metadata may come from other sources
  285. def _extract_filament_info(self, data: dict):
  286. """Extract filament info, preferring non-support filaments."""
  287. try:
  288. filament_types = data.get("filament_type", [])
  289. filament_colors = data.get("filament_colour", [])
  290. filament_is_support = data.get("filament_is_support", [])
  291. if not filament_types:
  292. return
  293. # Collect all non-support filaments
  294. non_support_types = []
  295. non_support_colors = []
  296. for i, ftype in enumerate(filament_types):
  297. is_support = filament_is_support[i] if i < len(filament_is_support) else "0"
  298. if is_support == "0":
  299. if ftype and ftype not in non_support_types:
  300. non_support_types.append(ftype)
  301. if i < len(filament_colors) and filament_colors[i]:
  302. color = filament_colors[i]
  303. if color not in non_support_colors:
  304. non_support_colors.append(color)
  305. # Fallback to first filament if all are support
  306. if not non_support_types and filament_types:
  307. non_support_types = [filament_types[0]]
  308. if not non_support_colors and filament_colors:
  309. non_support_colors = [filament_colors[0]]
  310. # Store filament type(s)
  311. if non_support_types:
  312. self.metadata["filament_type"] = ", ".join(non_support_types)
  313. # Store all colors as comma-separated (for multi-color display)
  314. if non_support_colors:
  315. self.metadata["filament_color"] = ",".join(non_support_colors)
  316. except Exception:
  317. pass # Filament info is optional; fall back to slice_info values
  318. def _extract_print_settings(self, data: dict):
  319. """Extract print settings from JSON config."""
  320. try:
  321. # Layer height - usually an array, get first value
  322. if "layer_height" in data:
  323. val = data["layer_height"]
  324. if isinstance(val, list) and val:
  325. self.metadata["layer_height"] = float(val[0])
  326. elif isinstance(val, (int, float, str)):
  327. self.metadata["layer_height"] = float(val)
  328. # Nozzle diameter
  329. if "nozzle_diameter" in data:
  330. val = data["nozzle_diameter"]
  331. if isinstance(val, list) and val:
  332. self.metadata["nozzle_diameter"] = float(val[0])
  333. elif isinstance(val, (int, float, str)):
  334. self.metadata["nozzle_diameter"] = float(val)
  335. # Bed temperature - first layer or regular
  336. for key in ["bed_temperature_initial_layer", "bed_temperature"]:
  337. if key in data:
  338. val = data[key]
  339. if isinstance(val, list) and val:
  340. self.metadata["bed_temperature"] = int(float(val[0]))
  341. elif isinstance(val, (int, float, str)):
  342. self.metadata["bed_temperature"] = int(float(val))
  343. break
  344. # Nozzle temperature
  345. for key in ["nozzle_temperature_initial_layer", "nozzle_temperature"]:
  346. if key in data:
  347. val = data[key]
  348. if isinstance(val, list) and val:
  349. self.metadata["nozzle_temperature"] = int(float(val[0]))
  350. elif isinstance(val, (int, float, str)):
  351. self.metadata["nozzle_temperature"] = int(float(val))
  352. break
  353. # Printer model (extract and normalize)
  354. if "printer_model" in data:
  355. from backend.app.utils.printer_models import normalize_printer_model
  356. self.metadata["sliced_for_model"] = normalize_printer_model(data["printer_model"])
  357. # Build plate type — only set from project_settings if slice_info didn't already
  358. # provide it (slice_info is more authoritative as it reflects the exported plate).
  359. if "bed_type" not in self.metadata and "curr_bed_type" in data:
  360. val = data["curr_bed_type"]
  361. if isinstance(val, str) and val.strip():
  362. self.metadata["bed_type"] = val.strip()
  363. except Exception:
  364. pass # Print settings are optional; missing values are left unset
  365. def _extract_settings_from_content(self, content: str):
  366. """Extract print settings from config content."""
  367. settings_map = {
  368. "layer_height": ("layer_height", float),
  369. "nozzle_diameter": ("nozzle_diameter", float),
  370. "bed_temperature": ("bed_temperature", int),
  371. "nozzle_temperature": ("nozzle_temperature", int),
  372. }
  373. for key, (search_key, converter) in settings_map.items():
  374. if key not in self.metadata:
  375. try:
  376. # Try JSON format
  377. if f'"{search_key}"' in content:
  378. start = content.find(f'"{search_key}"')
  379. value_start = content.find(":", start) + 1
  380. value_end = content.find(",", value_start)
  381. if value_end == -1:
  382. value_end = content.find("}", value_start)
  383. value = content[value_start:value_end].strip().strip('"')
  384. self.metadata[key] = converter(value)
  385. except (ValueError, TypeError):
  386. pass # Skip settings with unconvertible values
  387. def _parse_3dmodel(self, zf: zipfile.ZipFile):
  388. """Parse 3D/3dmodel.model for MakerWorld metadata."""
  389. try:
  390. model_path = "3D/3dmodel.model"
  391. if model_path not in zf.namelist():
  392. return
  393. content = zf.read(model_path).decode("utf-8", errors="ignore")
  394. # Parse XML metadata elements
  395. # MakerWorld adds metadata like: <metadata name="Designer">username</metadata>
  396. metadata_pattern = r'<metadata\s+name="([^"]+)"[^>]*>([^<]*)</metadata>'
  397. matches = re.findall(metadata_pattern, content)
  398. makerworld_fields = {}
  399. for name, value in matches:
  400. makerworld_fields[name] = value.strip()
  401. # Check for direct MakerWorld URL in content
  402. url_pattern = r'https?://makerworld\.com/[^\s<>"\']+/models/(\d+)'
  403. url_match = re.search(url_pattern, content)
  404. if url_match:
  405. self.metadata["makerworld_url"] = url_match.group(0)
  406. self.metadata["makerworld_model_id"] = url_match.group(1)
  407. # Extract model ID from DSM reference in image URLs
  408. # Format: https://makerworld.bblmw.com/makerworld/model/DSM00000001275614/...
  409. # The numeric part (1275614) is the MakerWorld model ID
  410. if "makerworld_url" not in self.metadata:
  411. dsm_pattern = r"DSM0+(\d+)"
  412. dsm_match = re.search(dsm_pattern, content)
  413. if dsm_match:
  414. model_id = dsm_match.group(1)
  415. self.metadata["makerworld_url"] = f"https://makerworld.com/en/models/{model_id}"
  416. self.metadata["makerworld_model_id"] = model_id
  417. # Store designer info
  418. if "Designer" in makerworld_fields:
  419. self.metadata["designer"] = makerworld_fields["Designer"]
  420. if "Title" in makerworld_fields:
  421. self.metadata["print_name"] = makerworld_fields["Title"]
  422. except Exception:
  423. pass # MakerWorld/3dmodel metadata is optional
  424. def _extract_thumbnail(self, zf: zipfile.ZipFile):
  425. """Extract thumbnail image from 3MF.
  426. If a plate_number was specified, try to use that plate's thumbnail first.
  427. """
  428. thumbnail_paths = []
  429. # If a specific plate was printed, try that thumbnail first
  430. if self.plate_number:
  431. thumbnail_paths.append(f"Metadata/plate_{self.plate_number}.png")
  432. # Fallback to default paths
  433. thumbnail_paths.extend(
  434. [
  435. "Metadata/plate_1.png",
  436. "Metadata/thumbnail.png",
  437. "Metadata/model_thumbnail.png",
  438. ]
  439. )
  440. for thumb_path in thumbnail_paths:
  441. if thumb_path in zf.namelist():
  442. self.metadata["_thumbnail_data"] = zf.read(thumb_path)
  443. self.metadata["_thumbnail_ext"] = ".png"
  444. break
  445. def extract_printable_objects_from_3mf(
  446. data: bytes, plate_number: int | None = None, include_positions: bool = False
  447. ) -> dict[int, str] | dict[int, dict] | tuple[dict[int, dict], list | None]:
  448. """Extract printable objects from 3MF file bytes.
  449. This is a lightweight function used during print start to get the list
  450. of objects that can be skipped.
  451. Args:
  452. data: Raw bytes of the 3MF file
  453. plate_number: Which plate was printed (1-based), or None for first plate
  454. include_positions: If True, return tuple of (objects dict, bbox_all)
  455. Returns:
  456. If include_positions=False: Dictionary mapping identify_id (int) to object name (str)
  457. If include_positions=True: Tuple of (dict mapping identify_id to {name, x, y}, bbox_all list or None)
  458. """
  459. from io import BytesIO
  460. printable_objects: dict = {}
  461. bbox_all: list | None = None
  462. try:
  463. with zipfile.ZipFile(BytesIO(data), "r") as zf:
  464. if "Metadata/slice_info.config" not in zf.namelist():
  465. return printable_objects
  466. content = zf.read("Metadata/slice_info.config").decode()
  467. root = ET.fromstring(content)
  468. # Find the correct plate
  469. if plate_number:
  470. plate = root.find(f".//plate[@plate_idx='{plate_number}']")
  471. if plate is None:
  472. plate = root.find(".//plate")
  473. else:
  474. plate = root.find(".//plate")
  475. if plate is None:
  476. return printable_objects
  477. # Get actual plate index from metadata (sliced files only have one plate)
  478. plate_idx = plate_number or 1
  479. for meta in plate.findall("metadata"):
  480. if meta.get("key") == "index":
  481. try:
  482. plate_idx = int(meta.get("value", "1"))
  483. except ValueError:
  484. pass # Use default plate_idx if value is non-numeric
  485. break
  486. # Load position data from plate_N.json if we need positions
  487. # Build a lookup by name - use list to handle duplicate names
  488. bbox_by_name: dict[str, list[list]] = {}
  489. if include_positions:
  490. plate_json_path = f"Metadata/plate_{plate_idx}.json"
  491. if plate_json_path in zf.namelist():
  492. try:
  493. plate_json = json.loads(zf.read(plate_json_path).decode())
  494. # Get bbox_all - the bounding box of all objects (used for image bounds)
  495. bbox_all = plate_json.get("bbox_all")
  496. for bbox_obj in plate_json.get("bbox_objects", []):
  497. obj_name = bbox_obj.get("name")
  498. bbox = bbox_obj.get("bbox", [])
  499. if obj_name and len(bbox) >= 4:
  500. if obj_name not in bbox_by_name:
  501. bbox_by_name[obj_name] = []
  502. bbox_by_name[obj_name].append(bbox)
  503. except (json.JSONDecodeError, KeyError):
  504. pass # Position data is optional; objects will lack x/y coordinates
  505. # Extract objects from slice_info.config
  506. for obj in plate.findall("object"):
  507. identify_id = obj.get("identify_id")
  508. name = obj.get("name")
  509. skipped = obj.get("skipped", "false")
  510. if identify_id and name and skipped.lower() != "true":
  511. try:
  512. obj_id = int(identify_id)
  513. if include_positions:
  514. x, y = None, None
  515. # Match by name - pop first bbox to handle duplicates
  516. bboxes = bbox_by_name.get(name)
  517. if bboxes:
  518. bbox = bboxes.pop(0)
  519. # Calculate center from bbox [x_min, y_min, x_max, y_max]
  520. x = (bbox[0] + bbox[2]) / 2
  521. y = (bbox[1] + bbox[3]) / 2
  522. printable_objects[obj_id] = {"name": name, "x": x, "y": y}
  523. else:
  524. printable_objects[obj_id] = name
  525. except ValueError:
  526. pass # Skip objects with non-numeric identify_id
  527. except Exception:
  528. pass # Return empty dict if 3MF is corrupt or unreadable
  529. if include_positions:
  530. return printable_objects, bbox_all
  531. return printable_objects
  532. class ProjectPageParser:
  533. """Parser for extracting project page data from Bambu Lab 3MF files."""
  534. def __init__(self, file_path: Path):
  535. self.file_path = file_path
  536. def parse(self, archive_id: int) -> dict:
  537. """Extract project page metadata and images from 3MF file."""
  538. import html
  539. result = {
  540. "title": None,
  541. "description": None,
  542. "designer": None,
  543. "designer_user_id": None,
  544. "license": None,
  545. "copyright": None,
  546. "creation_date": None,
  547. "modification_date": None,
  548. "origin": None,
  549. "profile_title": None,
  550. "profile_description": None,
  551. "profile_cover": None,
  552. "profile_user_id": None,
  553. "profile_user_name": None,
  554. "design_model_id": None,
  555. "design_profile_id": None,
  556. "design_region": None,
  557. "model_pictures": [],
  558. "profile_pictures": [],
  559. "thumbnails": [],
  560. }
  561. try:
  562. with zipfile.ZipFile(self.file_path, "r") as zf:
  563. # Parse 3D/3dmodel.model for metadata
  564. model_path = "3D/3dmodel.model"
  565. if model_path in zf.namelist():
  566. content = zf.read(model_path).decode("utf-8", errors="ignore")
  567. # Extract metadata elements using regex
  568. # Format: <metadata name="Key">Value</metadata> or <metadata name="Key" />
  569. metadata_pattern = r'<metadata\s+name="([^"]+)"[^>]*>([^<]*)</metadata>'
  570. matches = re.findall(metadata_pattern, content)
  571. field_mapping = {
  572. "Title": "title",
  573. "Description": "description",
  574. "Designer": "designer",
  575. "DesignerUserId": "designer_user_id",
  576. "License": "license",
  577. "Copyright": "copyright",
  578. "CreationDate": "creation_date",
  579. "ModificationDate": "modification_date",
  580. "Origin": "origin",
  581. "ProfileTitle": "profile_title",
  582. "ProfileDescription": "profile_description",
  583. "ProfileCover": "profile_cover",
  584. "ProfileUserId": "profile_user_id",
  585. "ProfileUserName": "profile_user_name",
  586. "DesignModelId": "design_model_id",
  587. "DesignProfileId": "design_profile_id",
  588. "DesignRegion": "design_region",
  589. }
  590. for name, value in matches:
  591. if name in field_mapping:
  592. # Decode HTML entities multiple times (content is often triple-encoded)
  593. decoded = value.strip()
  594. prev = None
  595. while prev != decoded:
  596. prev = decoded
  597. decoded = html.unescape(decoded)
  598. # Normalize non-breaking spaces to regular spaces
  599. decoded = decoded.replace("\xa0", " ")
  600. result[field_mapping[name]] = decoded if decoded else None
  601. # List images in Auxiliaries folder
  602. from urllib.parse import quote
  603. for name in zf.namelist():
  604. if name.startswith("Auxiliaries/Model Pictures/"):
  605. filename = name.split("/")[-1]
  606. if filename:
  607. result["model_pictures"].append(
  608. {
  609. "name": filename,
  610. "path": name,
  611. "url": f"/api/v1/archives/{archive_id}/project-image/{quote(name, safe='')}",
  612. }
  613. )
  614. elif name.startswith("Auxiliaries/Profile Pictures/"):
  615. filename = name.split("/")[-1]
  616. if filename:
  617. result["profile_pictures"].append(
  618. {
  619. "name": filename,
  620. "path": name,
  621. "url": f"/api/v1/archives/{archive_id}/project-image/{quote(name, safe='')}",
  622. }
  623. )
  624. elif name.startswith("Auxiliaries/.thumbnails/"):
  625. filename = name.split("/")[-1]
  626. if filename:
  627. result["thumbnails"].append(
  628. {
  629. "name": filename,
  630. "path": name,
  631. "url": f"/api/v1/archives/{archive_id}/project-image/{quote(name, safe='')}",
  632. }
  633. )
  634. except Exception as e:
  635. result["_error"] = str(e)
  636. return result
  637. def get_image(self, image_path: str) -> tuple[bytes, str] | None:
  638. """Extract an image from the 3MF file.
  639. Returns tuple of (image_data, content_type) or None if not found.
  640. """
  641. try:
  642. with zipfile.ZipFile(self.file_path, "r") as zf:
  643. if image_path in zf.namelist():
  644. data = zf.read(image_path)
  645. # Determine content type from extension
  646. ext = image_path.lower().split(".")[-1]
  647. content_types = {
  648. "png": "image/png",
  649. "jpg": "image/jpeg",
  650. "jpeg": "image/jpeg",
  651. "webp": "image/webp",
  652. "gif": "image/gif",
  653. }
  654. content_type = content_types.get(ext, "application/octet-stream")
  655. return (data, content_type)
  656. except Exception:
  657. pass # Return None if image cannot be extracted from 3MF
  658. return None
  659. def update_metadata(self, updates: dict) -> bool:
  660. """Update project page metadata in the 3MF file.
  661. Args:
  662. updates: Dict with fields to update (title, description, designer, etc.)
  663. Returns:
  664. True if successful, False otherwise.
  665. """
  666. import html
  667. import tempfile
  668. try:
  669. # Read the 3MF file
  670. with zipfile.ZipFile(self.file_path, "r") as zf_read:
  671. # Find and read the 3dmodel.model file
  672. model_path = "3D/3dmodel.model"
  673. if model_path not in zf_read.namelist():
  674. return False
  675. content = zf_read.read(model_path).decode("utf-8")
  676. # Update metadata fields
  677. field_mapping = {
  678. "title": "Title",
  679. "description": "Description",
  680. "designer": "Designer",
  681. "license": "License",
  682. "copyright": "Copyright",
  683. "profile_title": "ProfileTitle",
  684. "profile_description": "ProfileDescription",
  685. }
  686. for field, xml_name in field_mapping.items():
  687. if field in updates and updates[field] is not None:
  688. new_value = html.escape(updates[field])
  689. # Replace existing metadata or we'd need to add it
  690. pattern = rf'(<metadata\s+name="{xml_name}"[^>]*>)[^<]*(</metadata>)'
  691. replacement = rf"\g<1>{new_value}\g<2>"
  692. content = re.sub(pattern, replacement, content)
  693. # Write to a temporary file first
  694. with tempfile.NamedTemporaryFile(delete=False, suffix=".3mf") as tmp:
  695. tmp_path = Path(tmp.name)
  696. # Create new zip with updated content
  697. with zipfile.ZipFile(tmp_path, "w", zipfile.ZIP_DEFLATED) as zf_write:
  698. for item in zf_read.namelist():
  699. if item == model_path:
  700. zf_write.writestr(item, content.encode("utf-8"))
  701. else:
  702. zf_write.writestr(item, zf_read.read(item))
  703. # Replace original file with updated one
  704. shutil.move(tmp_path, self.file_path)
  705. return True
  706. except Exception:
  707. # Clean up temp file if it exists
  708. if "tmp_path" in locals() and tmp_path.exists():
  709. tmp_path.unlink()
  710. return False
  711. async def _null_print_log_thumbnail_paths(db: AsyncSession, archive_id: int) -> None:
  712. """NULL thumbnail_path on PrintLogEntry rows linked to *archive_id*.
  713. Called from both soft- and hard-delete paths before the archive's files
  714. leave disk. The FK on PrintLogEntry.archive_id is ON DELETE SET NULL so
  715. log rows survive the archive — without this clear, their cached
  716. thumbnail_path would still point at a deleted file and the print-log
  717. view would 404-storm on every render (#1348 follow-up). Lazy-NULL on
  718. the GET route self-heals stragglers (e.g. failed prints that never had
  719. a thumbnail written), but eager clear here avoids the one-time storm.
  720. """
  721. from sqlalchemy import update as sa_update
  722. from backend.app.models.print_log import PrintLogEntry
  723. await db.execute(sa_update(PrintLogEntry).where(PrintLogEntry.archive_id == archive_id).values(thumbnail_path=None))
  724. class ArchiveService:
  725. """Service for archiving print jobs."""
  726. def __init__(self, db: AsyncSession):
  727. self.db = db
  728. @staticmethod
  729. def compute_file_hash(file_path: Path) -> str:
  730. """Compute SHA256 hash of a file for duplicate detection."""
  731. sha256 = hashlib.sha256()
  732. with open(file_path, "rb") as f:
  733. # Read in chunks to handle large files
  734. for chunk in iter(lambda: f.read(8192), b""):
  735. sha256.update(chunk)
  736. return sha256.hexdigest()
  737. async def get_duplicate_hashes_and_names(self) -> tuple[set[str], set[tuple[str, str]]]:
  738. """Get all content hashes and (print name, hash) pairs that appear more than once.
  739. For hashes: returns all hashes with > 1 archive (true duplicates).
  740. For name/hash pairs: returns only pairs that have > 1 archive
  741. (i.e., same file archived multiple times, not different files with same name).
  742. Returns a tuple of (duplicate_hashes, duplicate_name_hash_pairs).
  743. """
  744. from sqlalchemy import func
  745. # Soft-deleted archives don't appear in the listing (#1343), so they
  746. # mustn't influence the duplicate-group counts either — otherwise a
  747. # group with 1 live + 4 soft-deleted would still be flagged as a
  748. # duplicate even though the user only sees one row.
  749. result = await self.db.execute(
  750. select(PrintArchive.content_hash)
  751. .where(PrintArchive.content_hash.isnot(None), PrintArchive.deleted_at.is_(None))
  752. .group_by(PrintArchive.content_hash)
  753. .having(func.count(PrintArchive.id) > 1)
  754. )
  755. duplicate_hashes = {row[0] for row in result.all()}
  756. # Find print names that have multiple archives with the SAME hash
  757. # This avoids marking different files with the same name as duplicates
  758. result = await self.db.execute(
  759. select(func.lower(PrintArchive.print_name), PrintArchive.content_hash)
  760. .where(
  761. PrintArchive.print_name.isnot(None),
  762. PrintArchive.content_hash.isnot(None),
  763. PrintArchive.deleted_at.is_(None),
  764. )
  765. .group_by(func.lower(PrintArchive.print_name), PrintArchive.content_hash)
  766. .having(func.count(PrintArchive.id) > 1)
  767. )
  768. duplicate_name_hash_pairs = {(row[0], row[1]) for row in result.all()}
  769. return duplicate_hashes, duplicate_name_hash_pairs
  770. async def find_duplicates(
  771. self,
  772. archive_id: int,
  773. content_hash: str | None = None,
  774. print_name: str | None = None,
  775. makerworld_model_id: str | None = None,
  776. ) -> list[dict]:
  777. """Find duplicate archives based on hash or name matching.
  778. Returns list of dicts with id, print_name, created_at, match_type.
  779. """
  780. duplicates = []
  781. # First, find exact matches by content hash
  782. if content_hash:
  783. result = await self.db.execute(
  784. select(PrintArchive)
  785. .where(
  786. and_(
  787. PrintArchive.content_hash == content_hash,
  788. PrintArchive.id != archive_id,
  789. PrintArchive.deleted_at.is_(None),
  790. )
  791. )
  792. .order_by(PrintArchive.created_at.desc())
  793. .limit(10)
  794. )
  795. for archive in result.scalars().all():
  796. duplicates.append(
  797. {
  798. "id": archive.id,
  799. "print_name": archive.print_name,
  800. "created_at": archive.created_at,
  801. "match_type": "exact",
  802. }
  803. )
  804. # Then, find similar matches by print name or MakerWorld ID
  805. # Prefer strict name+hash matching when hash exists; fallback to name-only for legacy/manual
  806. # archives that may not have a content_hash.
  807. if print_name or makerworld_model_id:
  808. conditions = [PrintArchive.id != archive_id, PrintArchive.deleted_at.is_(None)]
  809. name_conditions = []
  810. if print_name:
  811. if content_hash:
  812. # Match if print names are similar AND have the same hash (same file)
  813. name_conditions.append(
  814. and_(PrintArchive.print_name.ilike(print_name), PrintArchive.content_hash == content_hash)
  815. )
  816. else:
  817. # Fallback for archives without hash data: match by print name only.
  818. name_conditions.append(PrintArchive.print_name.ilike(print_name))
  819. if makerworld_model_id:
  820. # Match by MakerWorld model ID stored in extra_data
  821. from backend.app.core.db_dialect import is_sqlite
  822. if is_sqlite():
  823. from sqlalchemy import func
  824. name_conditions.append(
  825. func.json_extract(PrintArchive.extra_data, "$.makerworld_model_id") == str(makerworld_model_id)
  826. )
  827. else:
  828. name_conditions.append(
  829. text("(extra_data::jsonb->>'makerworld_model_id') = :mw_id").bindparams(
  830. mw_id=str(makerworld_model_id)
  831. )
  832. )
  833. if name_conditions:
  834. conditions.append(or_(*name_conditions))
  835. result = await self.db.execute(
  836. select(PrintArchive).where(and_(*conditions)).order_by(PrintArchive.created_at.desc()).limit(10)
  837. )
  838. for archive in result.scalars().all():
  839. # Don't add if already in duplicates (exact match)
  840. if not any(d["id"] == archive.id for d in duplicates):
  841. duplicates.append(
  842. {
  843. "id": archive.id,
  844. "print_name": archive.print_name,
  845. "created_at": archive.created_at,
  846. "match_type": "similar",
  847. }
  848. )
  849. return duplicates
  850. async def archive_print(
  851. self,
  852. printer_id: int | None,
  853. source_file: Path,
  854. print_data: dict | None = None,
  855. created_by_id: int | None = None,
  856. original_filename: str | None = None,
  857. project_id: int | None = None,
  858. subtask_id: str | None = None,
  859. prefer_filename_for_name: bool = False,
  860. ) -> PrintArchive | None:
  861. """Archive a 3MF file with metadata.
  862. Args:
  863. printer_id: ID of the printer (optional)
  864. source_file: Path to the 3MF file
  865. print_data: Print data from MQTT (optional)
  866. created_by_id: User ID who created this archive (optional, for user tracking)
  867. original_filename: Original human-readable filename (optional, for library files
  868. stored with UUID names)
  869. project_id: Project to associate this archive with (optional, set when triggered
  870. from the project view)
  871. subtask_id: MQTT-provided task identifier (optional). Used to match an
  872. existing archive across a backend restart mid-print so the
  873. original row can be resumed instead of cancelled (#972).
  874. prefer_filename_for_name: When True, use the uploaded filename stem as the
  875. archive's display name even if the 3MF embeds a `print_name` in its
  876. metadata. Used by virtual-printer flows so users who rename a job in
  877. BambuStudio's "send to printer" dialog see that name instead of the
  878. creator-baked title (#1152).
  879. """
  880. # Verify printer exists if specified
  881. if printer_id is not None:
  882. result = await self.db.execute(select(Printer).where(Printer.id == printer_id))
  883. printer = result.scalar_one_or_none()
  884. if not printer:
  885. return None
  886. # Create archive directory structure
  887. timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
  888. display_stem = resolve_display_stem(original_filename if original_filename else source_file.name)
  889. archive_name = f"{timestamp}_{display_stem}"
  890. # Use "unassigned" folder for archives without a printer
  891. printer_folder = str(printer_id) if printer_id is not None else "unassigned"
  892. archive_dir = settings.archive_dir / printer_folder / archive_name
  893. archive_dir.mkdir(parents=True, exist_ok=True)
  894. # Copy 3MF file with an explicit fsync'd loop (avoids a sendfile
  895. # short-read quirk that silently truncated 3MF archives on some
  896. # platforms — see _copy_and_fsync and #1032).
  897. dest_file = archive_dir / source_file.name
  898. _copy_and_fsync(source_file, dest_file)
  899. # If we just archived a 3MF, verify the dest is a valid ZIP before
  900. # going any further. Staying quiet here is how #1032 escaped review —
  901. # the archive row was written but every later zipfile.ZipFile() call
  902. # on the dest failed with "File is not a zip file".
  903. if (
  904. source_file.suffix.lower() == ".3mf"
  905. and zipfile.is_zipfile(source_file)
  906. and not zipfile.is_zipfile(dest_file)
  907. ):
  908. try:
  909. src_size = source_file.stat().st_size
  910. dst_size = dest_file.stat().st_size
  911. except OSError:
  912. src_size = dst_size = -1
  913. logger.error(
  914. "Archive copy corrupted 3MF: src=%s (%s bytes, valid ZIP) -> dst=%s (%s bytes, NOT a ZIP). Refusing to create archive row.",
  915. source_file,
  916. src_size,
  917. dest_file,
  918. dst_size,
  919. )
  920. # Narrow cleanup: remove only the truncated file and the archive
  921. # directory if it's now empty. archive_dir was created with
  922. # exist_ok=True so it could in theory pre-date this call (e.g.
  923. # same-second same-filename collision); rmtree would be too broad.
  924. try:
  925. dest_file.unlink()
  926. except OSError:
  927. pass
  928. try:
  929. archive_dir.rmdir()
  930. except OSError:
  931. pass # directory not empty — leave untouched
  932. return None
  933. # Compute content hash for duplicate detection
  934. content_hash = self.compute_file_hash(dest_file)
  935. # Extract plate number from filename (e.g., "plate_5" from "/data/Metadata/plate_5.gcode")
  936. plate_number = None
  937. if print_data:
  938. filename = print_data.get("filename", "")
  939. match = re.search(r"plate_(\d+)", filename)
  940. if match:
  941. plate_number = int(match.group(1))
  942. # Parse 3MF metadata
  943. parser = ThreeMFParser(dest_file, plate_number=plate_number)
  944. metadata = parser.parse()
  945. # Save thumbnail if present
  946. thumbnail_path = None
  947. if "_thumbnail_data" in metadata:
  948. thumb_file = archive_dir / f"thumbnail{metadata['_thumbnail_ext']}"
  949. thumb_file.write_bytes(metadata["_thumbnail_data"])
  950. thumbnail_path = str(thumb_file.relative_to(settings.base_dir))
  951. del metadata["_thumbnail_data"]
  952. del metadata["_thumbnail_ext"]
  953. # Merge with print data from MQTT
  954. if print_data:
  955. metadata["_print_data"] = print_data
  956. # Determine status and timestamps
  957. status = print_data.get("status", "completed") if print_data else "archived"
  958. started_at = datetime.now(timezone.utc) if status == "printing" else None
  959. completed_at = datetime.now(timezone.utc) if status in ("completed", "failed", "archived") else None
  960. # Calculate cost based on filament usage and type
  961. cost = None
  962. filament_grams = metadata.get("filament_used_grams")
  963. filament_type = metadata.get("filament_type")
  964. if filament_grams and filament_type:
  965. # For multi-material prints, use the first filament type for cost calculation
  966. primary_type = filament_type.split(",")[0].strip()
  967. # Look up filament cost_per_kg from database
  968. filament_result = await self.db.execute(select(Filament).where(Filament.type == primary_type).limit(1))
  969. filament = filament_result.scalar_one_or_none()
  970. if filament:
  971. cost = round((filament_grams / 1000) * filament.cost_per_kg, 2)
  972. else:
  973. # Use default filament cost from settings
  974. from backend.app.api.routes.settings import get_setting
  975. default_cost_setting = await get_setting(self.db, "default_filament_cost")
  976. default_cost_per_kg = float(default_cost_setting) if default_cost_setting else 25.0
  977. cost = round((filament_grams / 1000) * default_cost_per_kg, 2)
  978. # Calculate quantity from printable objects count
  979. # printable_objects is a dict of {identify_id: name} for non-skipped objects
  980. quantity = 1 # Default to 1
  981. printable_objects = metadata.get("printable_objects")
  982. if printable_objects and isinstance(printable_objects, dict):
  983. quantity = len(printable_objects)
  984. logger.debug("Auto-detected %s parts from 3MF printable objects", quantity)
  985. # Create archive record
  986. archive = PrintArchive(
  987. printer_id=printer_id,
  988. filename=original_filename or source_file.name,
  989. file_path=str(dest_file.relative_to(settings.base_dir)),
  990. file_size=dest_file.stat().st_size,
  991. content_hash=content_hash,
  992. thumbnail_path=thumbnail_path,
  993. print_name=display_stem if prefer_filename_for_name else (metadata.get("print_name") or display_stem),
  994. print_time_seconds=metadata.get("print_time_seconds"),
  995. filament_used_grams=metadata.get("filament_used_grams"),
  996. filament_type=metadata.get("filament_type"),
  997. filament_color=metadata.get("filament_color"),
  998. layer_height=metadata.get("layer_height"),
  999. total_layers=metadata.get("total_layers"),
  1000. nozzle_diameter=metadata.get("nozzle_diameter"),
  1001. bed_temperature=metadata.get("bed_temperature"),
  1002. bed_type=metadata.get("bed_type"),
  1003. nozzle_temperature=metadata.get("nozzle_temperature"),
  1004. sliced_for_model=metadata.get("sliced_for_model"),
  1005. makerworld_url=metadata.get("makerworld_url"),
  1006. designer=metadata.get("designer"),
  1007. status=status,
  1008. started_at=started_at,
  1009. completed_at=completed_at,
  1010. cost=cost,
  1011. quantity=quantity,
  1012. extra_data=metadata,
  1013. created_by_id=created_by_id,
  1014. project_id=project_id,
  1015. subtask_id=subtask_id,
  1016. )
  1017. self.db.add(archive)
  1018. await self.db.commit()
  1019. await self.db.refresh(archive)
  1020. return archive
  1021. async def get_archive(self, archive_id: int) -> PrintArchive | None:
  1022. """Get an archive by ID with relationships loaded."""
  1023. from sqlalchemy.orm import selectinload
  1024. result = await self.db.execute(
  1025. select(PrintArchive)
  1026. .options(selectinload(PrintArchive.created_by), selectinload(PrintArchive.project))
  1027. .where(PrintArchive.id == archive_id)
  1028. )
  1029. return result.scalar_one_or_none()
  1030. async def update_archive_status(
  1031. self,
  1032. archive_id: int,
  1033. status: str,
  1034. completed_at: datetime | None = None,
  1035. failure_reason: str | None = None,
  1036. ) -> bool:
  1037. """Update the status of an archive."""
  1038. archive = await self.get_archive(archive_id)
  1039. if not archive:
  1040. return False
  1041. archive.status = status
  1042. if completed_at:
  1043. archive.completed_at = completed_at
  1044. if failure_reason:
  1045. archive.failure_reason = failure_reason
  1046. await self.db.commit()
  1047. return True
  1048. async def list_archives(
  1049. self,
  1050. printer_id: int | None = None,
  1051. project_id: int | None = None,
  1052. date_from: date | None = None,
  1053. date_to: date | None = None,
  1054. limit: int = 50,
  1055. offset: int = 0,
  1056. ) -> list[PrintArchive]:
  1057. """List archives with optional filtering."""
  1058. from sqlalchemy.orm import selectinload
  1059. query = (
  1060. select(PrintArchive)
  1061. .options(selectinload(PrintArchive.project), selectinload(PrintArchive.created_by))
  1062. # Hide soft-deleted rows from the listings (#1343). The stats
  1063. # endpoint deliberately does NOT add this filter so deleted
  1064. # archives keep contributing to Quick Stats.
  1065. .where(PrintArchive.deleted_at.is_(None))
  1066. .order_by(PrintArchive.created_at.desc())
  1067. )
  1068. if printer_id:
  1069. query = query.where(PrintArchive.printer_id == printer_id)
  1070. if project_id:
  1071. query = query.where(PrintArchive.project_id == project_id)
  1072. if date_from:
  1073. dt_from = datetime.combine(date_from, time.min, tzinfo=timezone.utc)
  1074. query = query.where(PrintArchive.created_at >= dt_from)
  1075. if date_to:
  1076. dt_to = datetime.combine(date_to, time.max, tzinfo=timezone.utc)
  1077. query = query.where(PrintArchive.created_at <= dt_to)
  1078. query = query.limit(limit).offset(offset)
  1079. result = await self.db.execute(query)
  1080. return list(result.scalars().all())
  1081. async def soft_delete_archive(self, archive_id: int) -> bool:
  1082. """Soft-delete an archive (#1343).
  1083. Removes the archive's files from disk (it disappears from the listings
  1084. and frees the storage) but flips the row's ``deleted_at`` so the stats
  1085. endpoint keeps counting its filament / energy / time / cost. The user
  1086. can opt into a hard delete via the "Also remove from statistics"
  1087. checkbox in the delete dialog — that path calls ``delete_archive``
  1088. instead and removes the row entirely.
  1089. """
  1090. archive = await self.get_archive(archive_id)
  1091. if not archive:
  1092. return False
  1093. if archive.deleted_at is not None:
  1094. # Already soft-deleted; nothing to do. The files were purged on
  1095. # the first soft-delete pass so there is nothing left on disk.
  1096. return True
  1097. dir_to_delete = self._resolve_archive_dir_for_delete(archive)
  1098. await _null_print_log_thumbnail_paths(self.db, archive_id)
  1099. archive.deleted_at = datetime.now(timezone.utc)
  1100. await self.db.commit()
  1101. if dir_to_delete:
  1102. shutil.rmtree(dir_to_delete, ignore_errors=True)
  1103. return True
  1104. def _resolve_archive_dir_for_delete(self, archive: PrintArchive) -> Path | None:
  1105. """Return the on-disk directory that backs *archive*, after the same
  1106. two safety checks ``delete_archive`` enforces.
  1107. Extracted so soft-delete and hard-delete share the path-resolution
  1108. rules. Returns ``None`` when nothing should be removed from disk
  1109. (no file_path, path outside archive_dir, or path not deep enough).
  1110. """
  1111. if not archive.file_path or not archive.file_path.strip():
  1112. logger.error(
  1113. f"SECURITY: Refusing to delete files for archive {archive.id} - "
  1114. f"file_path is empty or invalid: '{archive.file_path}'"
  1115. )
  1116. return None
  1117. file_path = settings.base_dir / archive.file_path
  1118. if not file_path.exists():
  1119. return None
  1120. archive_dir = file_path.parent
  1121. try:
  1122. relative_path = archive_dir.resolve().relative_to(settings.archive_dir.resolve())
  1123. except ValueError:
  1124. logger.error(
  1125. f"SECURITY: Refusing to delete archive {archive.id} - "
  1126. f"path {archive_dir} is outside archive directory {settings.archive_dir}"
  1127. )
  1128. return None
  1129. if len(relative_path.parts) < 1:
  1130. logger.error(
  1131. f"SECURITY: Refusing to delete archive {archive.id} - "
  1132. f"path {archive_dir} is not deep enough inside archive directory"
  1133. )
  1134. return None
  1135. return archive_dir
  1136. async def delete_archive(self, archive_id: int) -> bool:
  1137. """Delete an archive and its files."""
  1138. archive = await self.get_archive(archive_id)
  1139. if not archive:
  1140. return False
  1141. # Resolve the directory to delete BEFORE committing the DB change
  1142. dir_to_delete: Path | None = None
  1143. if archive.file_path and archive.file_path.strip():
  1144. file_path = settings.base_dir / archive.file_path
  1145. if file_path.exists():
  1146. archive_dir = file_path.parent
  1147. # Safety check 1: archive_dir must be inside archive_dir
  1148. try:
  1149. archive_dir.resolve().relative_to(settings.archive_dir.resolve())
  1150. except ValueError:
  1151. logger.error(
  1152. f"SECURITY: Refusing to delete archive {archive_id} - "
  1153. f"path {archive_dir} is outside archive directory {settings.archive_dir}"
  1154. )
  1155. await self.db.delete(archive)
  1156. await self.db.commit()
  1157. return True
  1158. # Safety check 2: archive_dir must be at least 1 level deep inside archive_dir
  1159. try:
  1160. relative_path = archive_dir.resolve().relative_to(settings.archive_dir.resolve())
  1161. if len(relative_path.parts) < 1:
  1162. logger.error(
  1163. f"SECURITY: Refusing to delete archive {archive_id} - "
  1164. f"path {archive_dir} is not deep enough inside archive directory"
  1165. )
  1166. await self.db.delete(archive)
  1167. await self.db.commit()
  1168. return True
  1169. except ValueError:
  1170. pass # Already handled above
  1171. dir_to_delete = archive_dir
  1172. else:
  1173. logger.error(
  1174. f"SECURITY: Refusing to delete files for archive {archive_id} - "
  1175. f"file_path is empty or invalid: '{archive.file_path}'"
  1176. )
  1177. # NULL stale thumbnail_path on linked PrintLogEntries before the FK
  1178. # SET-NULL cascade fires. The on-disk file is about to be removed by
  1179. # the rmtree below, so the path on any surviving log entry (archive_id
  1180. # gets SET NULL by the FK) would otherwise point at a missing file
  1181. # and produce 404 storms in the print-log view (#1348-followup).
  1182. await _null_print_log_thumbnail_paths(self.db, archive_id)
  1183. # Delete database record FIRST — if the commit fails (e.g. database locked
  1184. # during concurrent bulk deletes), the files stay on disk and nothing is lost.
  1185. await self.db.delete(archive)
  1186. await self.db.commit()
  1187. # Only delete files AFTER the DB commit succeeds to avoid orphaned records
  1188. if dir_to_delete:
  1189. shutil.rmtree(dir_to_delete, ignore_errors=True)
  1190. return True
  1191. async def attach_timelapse(
  1192. self,
  1193. archive_id: int,
  1194. timelapse_data: bytes,
  1195. filename: str = "timelapse.mp4",
  1196. ) -> bool:
  1197. """Attach a timelapse video to an archive.
  1198. Non-MP4 videos (e.g. AVI from P1S) are saved as-is and a background
  1199. task converts them to MP4 for browser compatibility.
  1200. """
  1201. import asyncio
  1202. archive = await self.get_archive(archive_id)
  1203. if not archive:
  1204. return False
  1205. # Get archive directory
  1206. file_path = settings.base_dir / archive.file_path
  1207. archive_dir = file_path.parent
  1208. # Save timelapse - use thread pool to avoid blocking event loop
  1209. # (timelapse files can be 100MB+, sync write blocks for seconds)
  1210. timelapse_file = archive_dir / filename
  1211. await asyncio.to_thread(timelapse_file.write_bytes, timelapse_data)
  1212. # Update archive record
  1213. archive.timelapse_path = str(timelapse_file.relative_to(settings.base_dir))
  1214. await self.db.commit()
  1215. # For non-MP4 videos (e.g. AVI from P1S), kick off background conversion
  1216. if not filename.lower().endswith(".mp4"):
  1217. asyncio.create_task(
  1218. _convert_timelapse_to_mp4(archive_id, timelapse_file),
  1219. name=f"timelapse-convert-{archive_id}",
  1220. )
  1221. return True
  1222. async def _convert_timelapse_to_mp4(archive_id: int, source_path: Path) -> None:
  1223. """Background task: convert non-MP4 timelapse (e.g. AVI from P1S) to MP4.
  1224. Runs with low CPU priority (-threads 1, nice) so it doesn't starve
  1225. other processes on resource-constrained devices like Raspberry Pi.
  1226. """
  1227. import asyncio
  1228. from backend.app.core.database import async_session
  1229. from backend.app.services.camera import get_ffmpeg_path
  1230. logger = logging.getLogger(__name__)
  1231. ffmpeg = get_ffmpeg_path()
  1232. if not ffmpeg:
  1233. logger.info(
  1234. "FFmpeg not available, skipping timelapse conversion for archive %s (file saved as %s)",
  1235. archive_id,
  1236. source_path.suffix,
  1237. )
  1238. return
  1239. mp4_path = source_path.with_suffix(".mp4")
  1240. try:
  1241. cmd = [
  1242. ffmpeg,
  1243. "-y",
  1244. "-i",
  1245. str(source_path),
  1246. "-c:v",
  1247. "libx264",
  1248. "-preset",
  1249. "fast",
  1250. "-crf",
  1251. "23",
  1252. "-threads",
  1253. "1",
  1254. "-movflags",
  1255. "+faststart",
  1256. str(mp4_path),
  1257. ]
  1258. # Try with nice for lower CPU priority (standard on Linux/macOS)
  1259. try:
  1260. process = await asyncio.create_subprocess_exec(
  1261. "nice",
  1262. "-n",
  1263. "19",
  1264. *cmd,
  1265. stdout=asyncio.subprocess.PIPE,
  1266. stderr=asyncio.subprocess.PIPE,
  1267. )
  1268. except FileNotFoundError:
  1269. # nice not available (e.g. Windows), run without
  1270. process = await asyncio.create_subprocess_exec(
  1271. *cmd,
  1272. stdout=asyncio.subprocess.PIPE,
  1273. stderr=asyncio.subprocess.PIPE,
  1274. )
  1275. _, stderr = await process.communicate()
  1276. if process.returncode != 0:
  1277. logger.warning(
  1278. "Timelapse conversion failed for archive %s: %s",
  1279. archive_id,
  1280. stderr.decode()[-500:],
  1281. )
  1282. if mp4_path.exists():
  1283. mp4_path.unlink()
  1284. return
  1285. # Update DB path to the new MP4 file
  1286. async with async_session() as db:
  1287. from backend.app.models.archive import PrintArchive
  1288. result = await db.execute(select(PrintArchive).where(PrintArchive.id == archive_id))
  1289. archive = result.scalar_one_or_none()
  1290. if archive:
  1291. archive.timelapse_path = str(mp4_path.relative_to(settings.base_dir))
  1292. await db.commit()
  1293. # Remove original non-MP4 file
  1294. if source_path.exists():
  1295. source_path.unlink()
  1296. logger.info(
  1297. "Converted timelapse to MP4 for archive %s (%s → %s)",
  1298. archive_id,
  1299. source_path.name,
  1300. mp4_path.name,
  1301. )
  1302. except Exception as e:
  1303. logger.warning("Timelapse conversion error for archive %s: %s", archive_id, e)
  1304. if mp4_path.exists():
  1305. mp4_path.unlink()