firmware_check.py 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585
  1. """
  2. Firmware Check Service
  3. Checks for firmware updates by fetching from Bambu Lab's official wiki and firmware
  4. download page. The wiki is used as the primary version source (always up-to-date),
  5. while the download page provides firmware file URLs for offline updates.
  6. """
  7. import logging
  8. import re
  9. import time
  10. from collections.abc import Callable
  11. from dataclasses import dataclass
  12. from pathlib import Path
  13. import httpx
  14. from backend.app.core.config import _data_dir
  15. logger = logging.getLogger(__name__)
  16. # Bambu Lab firmware download page (for download URLs)
  17. BAMBU_FIRMWARE_BASE = "https://bambulab.com"
  18. FIRMWARE_PAGE = "/en/support/firmware-download/all"
  19. # Bambu Lab wiki (primary source for latest version detection)
  20. BAMBU_WIKI_BASE = "https://wiki.bambulab.com"
  21. # Cache TTL in seconds (1 hour)
  22. CACHE_TTL = 3600
  23. # Map Bambuddy model names to Bambu Lab API keys
  24. MODEL_TO_API_KEY = {
  25. "X1": "x1",
  26. "X1C": "x1",
  27. "X1-Carbon": "x1",
  28. "X1 Carbon": "x1",
  29. "P1P": "p1",
  30. "P1S": "p1",
  31. "A1": "a1",
  32. "A1 Mini": "a1-mini",
  33. "A1-Mini": "a1-mini",
  34. "A1mini": "a1-mini",
  35. "H2D": "h2d",
  36. "H2C": "h2c",
  37. "H2S": "h2s",
  38. "P2S": "p2s",
  39. "X1E": "x1e",
  40. "X2D": "x2d",
  41. "H2D Pro": "h2d-pro",
  42. "H2D-Pro": "h2d-pro",
  43. "H2DPRO": "h2d-pro",
  44. # SSDP model codes (DevModel header) — in case raw codes are stored
  45. "O1D": "h2d",
  46. "O1E": "h2d-pro",
  47. "O2D": "h2d-pro",
  48. "O1C": "h2c",
  49. "O1C2": "h2c",
  50. "O1S": "h2s",
  51. "BL-P001": "x1",
  52. "BL-P002": "x1",
  53. "BL-P003": "x1e",
  54. "C11": "p1",
  55. "C12": "p1",
  56. "C13": "p2s",
  57. "N2S": "a1",
  58. "N1": "a1-mini",
  59. "N6": "x2d",
  60. "N7": "p2s",
  61. }
  62. # Reverse mapping: API key to model codes
  63. API_KEY_TO_DEV_MODEL = {
  64. "x1": "BL-P001",
  65. "p1": "C11",
  66. "a1": "N2S",
  67. "a1-mini": "N1",
  68. "h2d": "O1D",
  69. "h2c": "O1C",
  70. "h2s": "O1S",
  71. "p2s": "N7",
  72. "x1e": "C13",
  73. "x2d": "N6",
  74. "h2d-pro": "O1E",
  75. }
  76. # Wiki firmware release history pages (primary version source)
  77. API_KEY_TO_WIKI_PATH = {
  78. "x1": "/en/x1/manual/X1-X1C-firmware-release-history",
  79. "x1e": "/en/x1/manual/X1E-firmware-release-history",
  80. "p1": "/en/p1/manual/p1p-firmware-release-history",
  81. "a1": "/en/a1/manual/a1-firmware-release-history",
  82. "a1-mini": "/en/a1-mini/manual/a1-mini-firmware-release-history",
  83. "h2d": "/en/h2d/manual/h2d-firmware-release-history",
  84. "h2c": "/en/h2c/manual/h2c-firmware-release-history",
  85. "h2s": "/en/h2s/manual/h2s-firmware-release-history",
  86. "p2s": "/en/p2s/manual/p2s-firmware-release-history",
  87. "x2d": "/en/x2d/manual/x2d-firmware-release-history",
  88. "h2d-pro": "/en/h2d-pro/manual/firmware-release-history",
  89. }
  90. @dataclass
  91. class FirmwareVersion:
  92. """Firmware version information."""
  93. version: str
  94. download_url: str
  95. release_notes: str | None = None
  96. release_time: str | None = None
  97. class FirmwareCheckService:
  98. """Service for checking firmware updates from Bambu Lab."""
  99. def __init__(self):
  100. self._build_id: str | None = None
  101. self._build_id_time: float = 0
  102. self._version_cache: dict[str, FirmwareVersion] = {}
  103. self._versions_list_cache: dict[str, list[FirmwareVersion]] = {}
  104. self._cache_time: float = 0
  105. self._client = httpx.AsyncClient(
  106. timeout=30.0,
  107. headers={
  108. "User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36"
  109. },
  110. )
  111. async def _get_build_id(self) -> str | None:
  112. """Fetch the Next.js build ID from Bambu Lab's firmware page."""
  113. # Use cached build ID if still valid (cache for 1 hour)
  114. if self._build_id and (time.time() - self._build_id_time) < CACHE_TTL:
  115. return self._build_id
  116. try:
  117. response = await self._client.get(f"{BAMBU_FIRMWARE_BASE}{FIRMWARE_PAGE}")
  118. if response.status_code == 200:
  119. # Extract buildId from the page
  120. match = re.search(r'"buildId":"([^"]+)"', response.text)
  121. if match:
  122. self._build_id = match.group(1)
  123. self._build_id_time = time.time()
  124. logger.info("Got Bambu Lab build ID: %s", self._build_id)
  125. return self._build_id
  126. logger.warning("Failed to get Bambu Lab page: %s", response.status_code)
  127. except Exception as e:
  128. logger.error("Error fetching Bambu Lab build ID: %s", e)
  129. return self._build_id # Return cached value if available
  130. async def _fetch_version_from_wiki(self, api_key: str) -> str | None:
  131. """Fetch the latest firmware version from Bambu Lab's wiki release history page."""
  132. versions = await self._fetch_all_versions_from_wiki(api_key)
  133. if versions:
  134. logger.debug("Wiki firmware for %s: %s", api_key, versions[0][0])
  135. return versions[0][0]
  136. return None
  137. async def _fetch_all_versions_from_wiki(self, api_key: str) -> list[tuple[str, str | None]]:
  138. """
  139. Fetch all firmware versions from the wiki release history page.
  140. Only extracts versions that appear in section-heading anchors
  141. (e.g. `id="h-01030000-20260303"` or `id="h-0102000020260409"`) —
  142. this excludes version-like numbers mentioned incidentally in
  143. release-note text. The dash separator between version and date is
  144. optional: H2D/X1/H2C/H2S still use it, but P2S and X2D publish
  145. anchors without the dash.
  146. Returns list of (version, release_date_YYYYMMDD | None) tuples, newest first.
  147. """
  148. wiki_path = API_KEY_TO_WIKI_PATH.get(api_key)
  149. if not wiki_path:
  150. return []
  151. try:
  152. url = f"{BAMBU_WIKI_BASE}{wiki_path}"
  153. response = await self._client.get(url, follow_redirects=True)
  154. if response.status_code != 200:
  155. return []
  156. # Primary: heading anchor ids like id="h-01030000-20260303" (dash)
  157. # or id="h-0102000020260409" (no dash, P2S/X2D-style).
  158. anchor_matches = re.findall(r'id="h-(\d{2})(\d{2})(\d{2})(\d{2})-?(\d{8})"', response.text)
  159. seen: set[str] = set()
  160. versions: list[tuple[str, str | None]] = []
  161. for a, b, c, d, date in anchor_matches:
  162. v = f"{a}.{b}.{c}.{d}"
  163. if v in seen:
  164. continue
  165. seen.add(v)
  166. versions.append((v, date))
  167. if versions:
  168. return versions
  169. # Fallback: heading text with "XX.XX.XX.XX (YYYYMMDD)" —
  170. # accept both ASCII "()" and full-width "()" (U+FF08/U+FF09)
  171. # which some pages (A1, A1-mini, P2S) use.
  172. text_matches = re.findall(
  173. r"(\d{2}\.\d{2}\.\d{2}\.\d{2})\s*[(\uff08](\d{8})[)\uff09]",
  174. response.text,
  175. )
  176. for v, date in text_matches:
  177. if v in seen:
  178. continue
  179. seen.add(v)
  180. versions.append((v, date))
  181. return versions
  182. except Exception as e:
  183. logger.debug("Error fetching wiki firmware list for %s: %s", api_key, e)
  184. return []
  185. async def _fetch_all_versions_from_download_page(self, api_key: str) -> list[FirmwareVersion]:
  186. """Fetch all firmware versions from Bambu Lab's download page (newest first)."""
  187. build_id = await self._get_build_id()
  188. if not build_id:
  189. return []
  190. try:
  191. url = f"{BAMBU_FIRMWARE_BASE}/_next/data/{build_id}/en/support/firmware-download/{api_key}.json"
  192. response = await self._client.get(url)
  193. if response.status_code == 200:
  194. data = response.json()
  195. page_props = data.get("pageProps", {})
  196. printer_map = page_props.get("printerMap", {})
  197. printer_data = printer_map.get(api_key, {})
  198. versions = printer_data.get("versions", [])
  199. return [
  200. FirmwareVersion(
  201. version=v.get("version", ""),
  202. download_url=v.get("url", ""),
  203. release_notes=v.get("release_notes_en"),
  204. release_time=v.get("release_time"),
  205. )
  206. for v in versions
  207. if v.get("version")
  208. ]
  209. except Exception as e:
  210. logger.debug("Error fetching download page firmware for %s: %s", api_key, e)
  211. return []
  212. async def _fetch_from_download_page(self, api_key: str) -> FirmwareVersion | None:
  213. """Fetch the latest firmware info from Bambu Lab's download page (has download URLs)."""
  214. versions = await self._fetch_all_versions_from_download_page(api_key)
  215. return versions[0] if versions else None
  216. async def _fetch_firmware_versions(self, api_key: str) -> FirmwareVersion | None:
  217. """Fetch firmware version info, using wiki as primary source and download page as fallback."""
  218. # Try wiki first (always has the latest version)
  219. wiki_version = await self._fetch_version_from_wiki(api_key)
  220. # Try download page (has download URLs, may lag behind wiki)
  221. download_info = await self._fetch_from_download_page(api_key)
  222. if wiki_version:
  223. # Wiki has the latest version — use it, attach download URL if available
  224. download_url = ""
  225. release_notes = None
  226. if download_info and download_info.version == wiki_version:
  227. download_url = download_info.download_url
  228. release_notes = download_info.release_notes
  229. return FirmwareVersion(
  230. version=wiki_version,
  231. download_url=download_url,
  232. release_notes=release_notes,
  233. )
  234. if download_info:
  235. return download_info
  236. logger.warning("Could not fetch firmware info for %s from wiki or download page", api_key)
  237. return None
  238. async def get_latest_version(self, model: str) -> FirmwareVersion | None:
  239. """
  240. Get the latest firmware version for a printer model.
  241. Args:
  242. model: Bambuddy printer model name (e.g., "X1C", "P1S", "H2D")
  243. Returns:
  244. FirmwareVersion if found, None otherwise
  245. """
  246. # Normalize model name
  247. model_upper = model.upper().replace(" ", "").replace("-", "")
  248. # Find the API key for this model
  249. api_key = None
  250. for model_name, key in MODEL_TO_API_KEY.items():
  251. if model_name.upper().replace(" ", "").replace("-", "") == model_upper:
  252. api_key = key
  253. break
  254. if not api_key:
  255. # Try direct lookup with original model
  256. api_key = MODEL_TO_API_KEY.get(model)
  257. if not api_key:
  258. logger.debug("Unknown printer model: %s", model)
  259. return None
  260. # Check cache
  261. cache_key = api_key
  262. if cache_key in self._version_cache and (time.time() - self._cache_time) < CACHE_TTL:
  263. return self._version_cache[cache_key]
  264. # Fetch from API
  265. version = await self._fetch_firmware_versions(api_key)
  266. if version:
  267. self._version_cache[cache_key] = version
  268. self._cache_time = time.time()
  269. return version
  270. def _resolve_api_key(self, model: str) -> str | None:
  271. """Resolve a model name to its Bambu API key."""
  272. model_upper = model.upper().replace(" ", "").replace("-", "")
  273. for name, key in MODEL_TO_API_KEY.items():
  274. if name.upper().replace(" ", "").replace("-", "") == model_upper:
  275. return key
  276. return MODEL_TO_API_KEY.get(model)
  277. @staticmethod
  278. def _version_tuple(v: str) -> tuple[int, ...]:
  279. parts = [int(x) for x in v.split(".")]
  280. while len(parts) < 4:
  281. parts.append(0)
  282. return tuple(parts)
  283. async def get_available_versions(self, model: str) -> list[FirmwareVersion]:
  284. """
  285. Get all announced firmware versions for a model, newest first.
  286. Merges the wiki release history (list of version strings) with the
  287. download page JSON (which provides download URLs + release notes).
  288. Versions present only on the wiki have an empty download_url and
  289. should be treated as "unavailable" for file-based installation.
  290. """
  291. api_key = self._resolve_api_key(model)
  292. if not api_key:
  293. return []
  294. if api_key in self._versions_list_cache and (time.time() - self._cache_time) < CACHE_TTL:
  295. return self._versions_list_cache[api_key]
  296. wiki_versions = await self._fetch_all_versions_from_wiki(api_key)
  297. download_versions = await self._fetch_all_versions_from_download_page(api_key)
  298. by_version: dict[str, FirmwareVersion] = {d.version: d for d in download_versions if d.version}
  299. merged: list[FirmwareVersion] = []
  300. seen: set[str] = set()
  301. for v, wiki_date in wiki_versions:
  302. if v in seen:
  303. continue
  304. seen.add(v)
  305. if v in by_version:
  306. merged.append(by_version[v])
  307. else:
  308. merged.append(FirmwareVersion(version=v, download_url="", release_time=wiki_date))
  309. for d in download_versions:
  310. if d.version and d.version not in seen:
  311. seen.add(d.version)
  312. merged.append(d)
  313. try:
  314. merged.sort(key=lambda fv: self._version_tuple(fv.version), reverse=True)
  315. except (ValueError, AttributeError):
  316. pass
  317. self._versions_list_cache[api_key] = merged
  318. self._cache_time = time.time()
  319. return merged
  320. async def get_version_info(self, model: str, version: str) -> FirmwareVersion | None:
  321. """Find a specific version's info (including download URL) for a model."""
  322. for v in await self.get_available_versions(model):
  323. if v.version == version:
  324. return v
  325. return None
  326. async def check_for_update(self, model: str, current_version: str) -> dict:
  327. """
  328. Check if a firmware update is available for a printer.
  329. Args:
  330. model: Printer model name
  331. current_version: Currently installed firmware version
  332. Returns:
  333. Dict with update info:
  334. - update_available: bool
  335. - current_version: str
  336. - latest_version: str or None
  337. - download_url: str or None
  338. - release_notes: str or None
  339. """
  340. result = {
  341. "update_available": False,
  342. "current_version": current_version,
  343. "latest_version": None,
  344. "download_url": None,
  345. "release_notes": None,
  346. "available_versions": [],
  347. }
  348. available = await self.get_available_versions(model)
  349. result["available_versions"] = [
  350. {
  351. "version": v.version,
  352. "download_url": v.download_url or None,
  353. "file_available": bool(v.download_url),
  354. "release_notes": v.release_notes,
  355. "release_time": v.release_time,
  356. }
  357. for v in available
  358. ]
  359. if not current_version:
  360. return result
  361. latest = available[0] if available else await self.get_latest_version(model)
  362. if not latest:
  363. return result
  364. result["latest_version"] = latest.version
  365. result["download_url"] = latest.download_url or None
  366. result["release_notes"] = latest.release_notes
  367. # Compare versions (format: XX.XX.XX.XX)
  368. try:
  369. current_parts = [int(x) for x in current_version.split(".")]
  370. latest_parts = [int(x) for x in latest.version.split(".")]
  371. # Pad to same length
  372. while len(current_parts) < 4:
  373. current_parts.append(0)
  374. while len(latest_parts) < 4:
  375. latest_parts.append(0)
  376. result["update_available"] = latest_parts > current_parts
  377. except (ValueError, AttributeError):
  378. logger.warning("Could not compare versions: %s vs %s", current_version, latest.version)
  379. return result
  380. async def get_all_latest_versions(self) -> dict[str, FirmwareVersion]:
  381. """
  382. Fetch latest firmware versions for all known printer models.
  383. Returns:
  384. Dict mapping API key to FirmwareVersion
  385. """
  386. results = {}
  387. for api_key in API_KEY_TO_DEV_MODEL:
  388. version = await self._fetch_firmware_versions(api_key)
  389. if version:
  390. results[api_key] = version
  391. return results
  392. def _get_firmware_cache_dir(self) -> Path:
  393. """Get the firmware cache directory, creating it if needed."""
  394. cache_dir = _data_dir / "firmware"
  395. cache_dir.mkdir(parents=True, exist_ok=True)
  396. return cache_dir
  397. async def get_firmware_file_info(self, model: str, version: str | None = None) -> dict | None:
  398. """
  399. Get information about a firmware file for a model.
  400. If `version` is provided, returns info for that specific version (must be
  401. available on the download page). Otherwise returns info for the latest version.
  402. """
  403. if version:
  404. target = await self.get_version_info(model, version)
  405. else:
  406. target = await self.get_latest_version(model)
  407. if not target or not target.download_url:
  408. return None
  409. url_parts = target.download_url.split("/")
  410. filename = url_parts[-1] if url_parts else f"firmware_{model}.bin"
  411. return {
  412. "download_url": target.download_url,
  413. "version": target.version,
  414. "filename": filename,
  415. "release_notes": target.release_notes,
  416. }
  417. async def download_firmware(
  418. self,
  419. model: str,
  420. progress_callback: Callable[[int, int, str], None] | None = None,
  421. version: str | None = None,
  422. ) -> Path | None:
  423. """
  424. Download firmware file for a printer model.
  425. Args:
  426. model: Printer model name (e.g., "X1C", "P1S", "H2D")
  427. progress_callback: Optional callback(bytes_downloaded, total_bytes, status_message)
  428. Returns:
  429. Path to downloaded firmware file, or None on failure
  430. """
  431. if version:
  432. latest = await self.get_version_info(model, version)
  433. else:
  434. latest = await self.get_latest_version(model)
  435. if not latest or not latest.download_url:
  436. logger.warning("No firmware download URL available for model %s version %s", model, version)
  437. return None
  438. # Extract original filename from URL (must preserve for SD card update)
  439. url_parts = latest.download_url.split("/")
  440. original_filename = url_parts[-1] if url_parts else f"firmware_{model}.bin"
  441. # Check if already cached (using original filename so SD card gets the right name)
  442. cached_path = self._get_firmware_cache_dir() / original_filename
  443. if cached_path.exists():
  444. logger.info("Using cached firmware: %s", cached_path)
  445. return cached_path
  446. # Download to temp file first
  447. temp_path = self._get_firmware_cache_dir() / f".downloading_{original_filename}"
  448. try:
  449. logger.info("Downloading firmware from %s", latest.download_url)
  450. if progress_callback:
  451. progress_callback(0, 0, "Starting download...")
  452. async with self._client.stream("GET", latest.download_url) as response:
  453. if response.status_code != 200:
  454. logger.error("Firmware download failed with status %s", response.status_code)
  455. return None
  456. total_size = int(response.headers.get("content-length", 0))
  457. downloaded = 0
  458. with open(temp_path, "wb") as f:
  459. async for chunk in response.aiter_bytes(chunk_size=65536):
  460. f.write(chunk)
  461. downloaded += len(chunk)
  462. if progress_callback:
  463. progress_callback(downloaded, total_size, "Downloading firmware...")
  464. # Move temp to final path, preserving original filename
  465. temp_path.rename(cached_path)
  466. logger.info("Firmware downloaded successfully: %s", cached_path)
  467. if progress_callback:
  468. progress_callback(downloaded, total_size, "Download complete")
  469. return cached_path
  470. except Exception as e:
  471. logger.error("Firmware download failed: %s", e)
  472. if temp_path.exists():
  473. try:
  474. temp_path.unlink()
  475. except OSError:
  476. pass # Best-effort cleanup of failed download temp file
  477. return None
  478. async def close(self):
  479. """Close the HTTP client."""
  480. await self._client.aclose()
  481. # Singleton instance
  482. _firmware_service: FirmwareCheckService | None = None
  483. def get_firmware_service() -> FirmwareCheckService:
  484. """Get the singleton firmware check service instance."""
  485. global _firmware_service
  486. if _firmware_service is None:
  487. _firmware_service = FirmwareCheckService()
  488. return _firmware_service