firmware_check.py 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450
  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._cache_time: float = 0
  100. self._client = httpx.AsyncClient(
  101. timeout=30.0,
  102. headers={
  103. "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"
  104. },
  105. )
  106. async def _get_build_id(self) -> str | None:
  107. """Fetch the Next.js build ID from Bambu Lab's firmware page."""
  108. # Use cached build ID if still valid (cache for 1 hour)
  109. if self._build_id and (time.time() - self._build_id_time) < CACHE_TTL:
  110. return self._build_id
  111. try:
  112. response = await self._client.get(f"{BAMBU_FIRMWARE_BASE}{FIRMWARE_PAGE}")
  113. if response.status_code == 200:
  114. # Extract buildId from the page
  115. match = re.search(r'"buildId":"([^"]+)"', response.text)
  116. if match:
  117. self._build_id = match.group(1)
  118. self._build_id_time = time.time()
  119. logger.info("Got Bambu Lab build ID: %s", self._build_id)
  120. return self._build_id
  121. logger.warning("Failed to get Bambu Lab page: %s", response.status_code)
  122. except Exception as e:
  123. logger.error("Error fetching Bambu Lab build ID: %s", e)
  124. return self._build_id # Return cached value if available
  125. async def _fetch_version_from_wiki(self, api_key: str) -> str | None:
  126. """Fetch the latest firmware version from Bambu Lab's wiki release history page."""
  127. wiki_path = API_KEY_TO_WIKI_PATH.get(api_key)
  128. if not wiki_path:
  129. return None
  130. try:
  131. url = f"{BAMBU_WIKI_BASE}{wiki_path}"
  132. response = await self._client.get(url, follow_redirects=True)
  133. if response.status_code == 200:
  134. # Extract version strings (format: XX.XX.XX.XX), first match is the latest
  135. versions = re.findall(r"(\d{2}\.\d{2}\.\d{2}\.\d{2})", response.text)
  136. if versions:
  137. logger.debug("Wiki firmware for %s: %s", api_key, versions[0])
  138. return versions[0]
  139. else:
  140. logger.debug("Wiki firmware page for %s returned %s", api_key, response.status_code)
  141. except Exception as e:
  142. logger.debug("Error fetching wiki firmware for %s: %s", api_key, e)
  143. return None
  144. async def _fetch_from_download_page(self, api_key: str) -> FirmwareVersion | None:
  145. """Fetch firmware info from Bambu Lab's download page (has download URLs)."""
  146. build_id = await self._get_build_id()
  147. if not build_id:
  148. return None
  149. try:
  150. url = f"{BAMBU_FIRMWARE_BASE}/_next/data/{build_id}/en/support/firmware-download/{api_key}.json"
  151. response = await self._client.get(url)
  152. if response.status_code == 200:
  153. data = response.json()
  154. page_props = data.get("pageProps", {})
  155. printer_map = page_props.get("printerMap", {})
  156. printer_data = printer_map.get(api_key, {})
  157. versions = printer_data.get("versions", [])
  158. if versions:
  159. latest = versions[0]
  160. return FirmwareVersion(
  161. version=latest.get("version", ""),
  162. download_url=latest.get("url", ""),
  163. release_notes=latest.get("release_notes_en"),
  164. release_time=latest.get("release_time"),
  165. )
  166. except Exception as e:
  167. logger.debug("Error fetching download page firmware for %s: %s", api_key, e)
  168. return None
  169. async def _fetch_firmware_versions(self, api_key: str) -> FirmwareVersion | None:
  170. """Fetch firmware version info, using wiki as primary source and download page as fallback."""
  171. # Try wiki first (always has the latest version)
  172. wiki_version = await self._fetch_version_from_wiki(api_key)
  173. # Try download page (has download URLs, may lag behind wiki)
  174. download_info = await self._fetch_from_download_page(api_key)
  175. if wiki_version:
  176. # Wiki has the latest version — use it, attach download URL if available
  177. download_url = ""
  178. release_notes = None
  179. if download_info and download_info.version == wiki_version:
  180. download_url = download_info.download_url
  181. release_notes = download_info.release_notes
  182. return FirmwareVersion(
  183. version=wiki_version,
  184. download_url=download_url,
  185. release_notes=release_notes,
  186. )
  187. if download_info:
  188. return download_info
  189. logger.warning("Could not fetch firmware info for %s from wiki or download page", api_key)
  190. return None
  191. async def get_latest_version(self, model: str) -> FirmwareVersion | None:
  192. """
  193. Get the latest firmware version for a printer model.
  194. Args:
  195. model: Bambuddy printer model name (e.g., "X1C", "P1S", "H2D")
  196. Returns:
  197. FirmwareVersion if found, None otherwise
  198. """
  199. # Normalize model name
  200. model_upper = model.upper().replace(" ", "").replace("-", "")
  201. # Find the API key for this model
  202. api_key = None
  203. for model_name, key in MODEL_TO_API_KEY.items():
  204. if model_name.upper().replace(" ", "").replace("-", "") == model_upper:
  205. api_key = key
  206. break
  207. if not api_key:
  208. # Try direct lookup with original model
  209. api_key = MODEL_TO_API_KEY.get(model)
  210. if not api_key:
  211. logger.debug("Unknown printer model: %s", model)
  212. return None
  213. # Check cache
  214. cache_key = api_key
  215. if cache_key in self._version_cache and (time.time() - self._cache_time) < CACHE_TTL:
  216. return self._version_cache[cache_key]
  217. # Fetch from API
  218. version = await self._fetch_firmware_versions(api_key)
  219. if version:
  220. self._version_cache[cache_key] = version
  221. self._cache_time = time.time()
  222. return version
  223. async def check_for_update(self, model: str, current_version: str) -> dict:
  224. """
  225. Check if a firmware update is available for a printer.
  226. Args:
  227. model: Printer model name
  228. current_version: Currently installed firmware version
  229. Returns:
  230. Dict with update info:
  231. - update_available: bool
  232. - current_version: str
  233. - latest_version: str or None
  234. - download_url: str or None
  235. - release_notes: str or None
  236. """
  237. result = {
  238. "update_available": False,
  239. "current_version": current_version,
  240. "latest_version": None,
  241. "download_url": None,
  242. "release_notes": None,
  243. }
  244. if not current_version:
  245. return result
  246. latest = await self.get_latest_version(model)
  247. if not latest:
  248. return result
  249. result["latest_version"] = latest.version
  250. result["download_url"] = latest.download_url
  251. result["release_notes"] = latest.release_notes
  252. # Compare versions (format: XX.XX.XX.XX)
  253. try:
  254. current_parts = [int(x) for x in current_version.split(".")]
  255. latest_parts = [int(x) for x in latest.version.split(".")]
  256. # Pad to same length
  257. while len(current_parts) < 4:
  258. current_parts.append(0)
  259. while len(latest_parts) < 4:
  260. latest_parts.append(0)
  261. result["update_available"] = latest_parts > current_parts
  262. except (ValueError, AttributeError):
  263. logger.warning("Could not compare versions: %s vs %s", current_version, latest.version)
  264. return result
  265. async def get_all_latest_versions(self) -> dict[str, FirmwareVersion]:
  266. """
  267. Fetch latest firmware versions for all known printer models.
  268. Returns:
  269. Dict mapping API key to FirmwareVersion
  270. """
  271. results = {}
  272. for api_key in API_KEY_TO_DEV_MODEL:
  273. version = await self._fetch_firmware_versions(api_key)
  274. if version:
  275. results[api_key] = version
  276. return results
  277. def _get_firmware_cache_dir(self) -> Path:
  278. """Get the firmware cache directory, creating it if needed."""
  279. cache_dir = _data_dir / "firmware"
  280. cache_dir.mkdir(parents=True, exist_ok=True)
  281. return cache_dir
  282. async def get_firmware_file_info(self, model: str) -> dict | None:
  283. """
  284. Get information about the firmware file for a model.
  285. Returns:
  286. Dict with download_url, version, filename, and estimated_size (if available)
  287. """
  288. latest = await self.get_latest_version(model)
  289. if not latest or not latest.download_url:
  290. return None
  291. # Extract filename from URL
  292. url_parts = latest.download_url.split("/")
  293. filename = url_parts[-1] if url_parts else f"firmware_{model}.bin"
  294. return {
  295. "download_url": latest.download_url,
  296. "version": latest.version,
  297. "filename": filename,
  298. "release_notes": latest.release_notes,
  299. }
  300. async def download_firmware(
  301. self,
  302. model: str,
  303. progress_callback: Callable[[int, int, str], None] | None = None,
  304. ) -> Path | None:
  305. """
  306. Download firmware file for a printer model.
  307. Args:
  308. model: Printer model name (e.g., "X1C", "P1S", "H2D")
  309. progress_callback: Optional callback(bytes_downloaded, total_bytes, status_message)
  310. Returns:
  311. Path to downloaded firmware file, or None on failure
  312. """
  313. latest = await self.get_latest_version(model)
  314. if not latest or not latest.download_url:
  315. logger.warning("No firmware download URL available for model: %s", model)
  316. return None
  317. # Extract original filename from URL (must preserve for SD card update)
  318. url_parts = latest.download_url.split("/")
  319. original_filename = url_parts[-1] if url_parts else f"firmware_{model}.bin"
  320. # Check if already cached (using original filename so SD card gets the right name)
  321. cached_path = self._get_firmware_cache_dir() / original_filename
  322. if cached_path.exists():
  323. logger.info("Using cached firmware: %s", cached_path)
  324. return cached_path
  325. # Download to temp file first
  326. temp_path = self._get_firmware_cache_dir() / f".downloading_{original_filename}"
  327. try:
  328. logger.info("Downloading firmware from %s", latest.download_url)
  329. if progress_callback:
  330. progress_callback(0, 0, "Starting download...")
  331. async with self._client.stream("GET", latest.download_url) as response:
  332. if response.status_code != 200:
  333. logger.error("Firmware download failed with status %s", response.status_code)
  334. return None
  335. total_size = int(response.headers.get("content-length", 0))
  336. downloaded = 0
  337. with open(temp_path, "wb") as f:
  338. async for chunk in response.aiter_bytes(chunk_size=65536):
  339. f.write(chunk)
  340. downloaded += len(chunk)
  341. if progress_callback:
  342. progress_callback(downloaded, total_size, "Downloading firmware...")
  343. # Move temp to final path, preserving original filename
  344. temp_path.rename(cached_path)
  345. logger.info("Firmware downloaded successfully: %s", cached_path)
  346. if progress_callback:
  347. progress_callback(downloaded, total_size, "Download complete")
  348. return cached_path
  349. except Exception as e:
  350. logger.error("Firmware download failed: %s", e)
  351. if temp_path.exists():
  352. try:
  353. temp_path.unlink()
  354. except OSError:
  355. pass # Best-effort cleanup of failed download temp file
  356. return None
  357. async def close(self):
  358. """Close the HTTP client."""
  359. await self._client.aclose()
  360. # Singleton instance
  361. _firmware_service: FirmwareCheckService | None = None
  362. def get_firmware_service() -> FirmwareCheckService:
  363. """Get the singleton firmware check service instance."""
  364. global _firmware_service
  365. if _firmware_service is None:
  366. _firmware_service = FirmwareCheckService()
  367. return _firmware_service