firmware_check.py 20 KB

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