updates.py 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544
  1. """Update checking and management routes."""
  2. import asyncio
  3. import logging
  4. import os
  5. import re
  6. import shutil
  7. import sys
  8. import httpx
  9. from fastapi import APIRouter, BackgroundTasks, Depends
  10. from sqlalchemy import select
  11. from sqlalchemy.ext.asyncio import AsyncSession
  12. from backend.app.core.auth import RequirePermissionIfAuthEnabled
  13. from backend.app.core.config import APP_VERSION, GITHUB_REPO, settings
  14. from backend.app.core.database import get_db
  15. from backend.app.core.permissions import Permission
  16. from backend.app.models.settings import Settings
  17. from backend.app.models.user import User
  18. logger = logging.getLogger(__name__)
  19. router = APIRouter(prefix="/updates", tags=["updates"])
  20. # Global state for update progress
  21. _update_status = {
  22. "status": "idle", # idle, checking, downloading, installing, complete, error
  23. "progress": 0,
  24. "message": "",
  25. "error": None,
  26. }
  27. def _is_docker_environment() -> bool:
  28. """Detect if running inside a Docker container."""
  29. if os.path.exists("/.dockerenv"):
  30. return True
  31. try:
  32. with open("/proc/1/cgroup") as f:
  33. if "docker" in f.read():
  34. return True
  35. except (FileNotFoundError, PermissionError):
  36. pass # cgroup file unavailable; continue with other detection methods
  37. git_dir = settings.base_dir / ".git"
  38. return not git_dir.exists()
  39. def _find_executable(name: str) -> str | None:
  40. """Find an executable in PATH or common locations."""
  41. # Try standard PATH first
  42. path = shutil.which(name)
  43. if path:
  44. return path
  45. # Common locations for executables (useful when running as systemd service)
  46. common_paths = [
  47. f"/usr/bin/{name}",
  48. f"/usr/local/bin/{name}",
  49. f"/opt/homebrew/bin/{name}",
  50. f"/home/linuxbrew/.linuxbrew/bin/{name}",
  51. f"{os.path.expanduser('~')}/.nvm/current/bin/{name}",
  52. f"{os.path.expanduser('~')}/.local/bin/{name}",
  53. ]
  54. for p in common_paths:
  55. if os.path.isfile(p) and os.access(p, os.X_OK):
  56. return p
  57. return None
  58. def parse_version(version: str) -> tuple:
  59. """Parse version string into tuple for comparison.
  60. Returns (major, minor, patch, micro, is_prerelease, prerelease_num)
  61. where is_prerelease is 0 for release, 1 for prerelease.
  62. This ensures releases sort higher than prereleases of same version.
  63. Examples:
  64. "0.1.5" -> (0, 1, 5, 0, 0, 0) # release
  65. "0.1.5b7" -> (0, 1, 5, 0, 1, 7) # beta 7
  66. "0.1.5b10" -> (0, 1, 5, 0, 1, 10) # beta 10
  67. "0.1.8.1" -> (0, 1, 8, 1, 0, 0) # patch release
  68. """
  69. # Remove 'v' prefix if present
  70. version = version.lstrip("v")
  71. # Strip daily build suffix (e.g., "0.2.2b4-daily.20260313" -> "0.2.2b4")
  72. version = re.sub(r"-daily\.\d+$", "", version)
  73. # Match version pattern: major.minor.patch[.micro][b|beta|alpha|rc]N
  74. match = re.match(r"(\d+)\.(\d+)\.(\d+)(?:\.(\d+))?(?:b|beta|alpha|rc)?(\d+)?", version)
  75. if match:
  76. major = int(match.group(1))
  77. minor = int(match.group(2))
  78. patch = int(match.group(3))
  79. micro = int(match.group(4)) if match.group(4) else 0
  80. prerelease_num = int(match.group(5)) if match.group(5) else 0
  81. # Check if this is a prerelease (has b/beta/alpha/rc/daily suffix anywhere)
  82. is_prerelease = 1 if re.search(r"[a-zA-Z]", version) else 0
  83. return (major, minor, patch, micro, is_prerelease, prerelease_num)
  84. # Fallback: try simple split
  85. parts = []
  86. for part in version.split("."):
  87. try:
  88. parts.append(int(part))
  89. except ValueError:
  90. num = "".join(c for c in part if c.isdigit())
  91. parts.append(int(num) if num else 0)
  92. return tuple(parts) + (0, 0, 0)
  93. def is_newer_version(latest: str, current: str) -> bool:
  94. """Check if latest version is newer than current.
  95. Properly handles prerelease versions:
  96. - 0.1.5 > 0.1.5b7 (release is newer than any beta)
  97. - 0.1.5b8 > 0.1.5b7 (later beta is newer)
  98. - 0.1.6b1 > 0.1.5 (next version beta is newer than current release)
  99. """
  100. try:
  101. latest_parsed = parse_version(latest)
  102. current_parsed = parse_version(current)
  103. # Compare (major, minor, patch, micro) first
  104. latest_base = latest_parsed[:4]
  105. current_base = current_parsed[:4]
  106. if latest_base > current_base:
  107. return True
  108. elif latest_base < current_base:
  109. return False
  110. # Same base version - compare prerelease status
  111. # is_prerelease: 0 = release, 1 = prerelease
  112. # Release (0) should be "greater" than prerelease (1)
  113. latest_is_prerelease = latest_parsed[4] if len(latest_parsed) > 4 else 0
  114. current_is_prerelease = current_parsed[4] if len(current_parsed) > 4 else 0
  115. if latest_is_prerelease < current_is_prerelease:
  116. # latest is release, current is prerelease -> latest is newer
  117. return True
  118. elif latest_is_prerelease > current_is_prerelease:
  119. # latest is prerelease, current is release -> latest is NOT newer
  120. return False
  121. # Both are same type (both release or both prerelease)
  122. # Compare prerelease numbers
  123. latest_prerelease_num = latest_parsed[5] if len(latest_parsed) > 5 else 0
  124. current_prerelease_num = current_parsed[5] if len(current_parsed) > 5 else 0
  125. return latest_prerelease_num > current_prerelease_num
  126. except Exception:
  127. return False
  128. @router.get("/version")
  129. async def get_version():
  130. """Get current application version.
  131. Note: Unauthenticated - needed to display version in UI without login.
  132. """
  133. return {
  134. "version": APP_VERSION,
  135. "repo": GITHUB_REPO,
  136. }
  137. @router.get("/check")
  138. async def check_for_updates(
  139. db: AsyncSession = Depends(get_db),
  140. _: User | None = RequirePermissionIfAuthEnabled(Permission.SYSTEM_READ),
  141. ):
  142. """Check GitHub for available updates."""
  143. global _update_status
  144. # Respect the check_updates setting
  145. result = await db.execute(select(Settings).where(Settings.key == "check_updates"))
  146. setting = result.scalar_one_or_none()
  147. if setting and setting.value.lower() == "false":
  148. return {
  149. "update_available": False,
  150. "current_version": APP_VERSION,
  151. "latest_version": None,
  152. "message": "Update checks are disabled",
  153. }
  154. # Check if beta updates should be included
  155. result = await db.execute(select(Settings).where(Settings.key == "include_beta_updates"))
  156. beta_setting = result.scalar_one_or_none()
  157. include_beta = beta_setting and beta_setting.value.lower() == "true"
  158. _update_status = {
  159. "status": "checking",
  160. "progress": 0,
  161. "message": "Checking for updates...",
  162. "error": None,
  163. }
  164. try:
  165. async with httpx.AsyncClient() as client:
  166. response = await client.get(
  167. f"https://api.github.com/repos/{GITHUB_REPO}/releases?per_page=20",
  168. headers={"Accept": "application/vnd.github.v3+json"},
  169. timeout=10.0,
  170. )
  171. if response.status_code == 404:
  172. # No releases yet
  173. _update_status = {
  174. "status": "idle",
  175. "progress": 100,
  176. "message": "No releases found",
  177. "error": None,
  178. }
  179. return {
  180. "update_available": False,
  181. "current_version": APP_VERSION,
  182. "latest_version": None,
  183. "message": "No releases found",
  184. }
  185. response.raise_for_status()
  186. releases = response.json()
  187. # Find the appropriate release based on beta setting
  188. release_data = None
  189. for release in releases:
  190. tag = release.get("tag_name", "")
  191. if include_beta:
  192. # Accept any release (first = newest)
  193. release_data = release
  194. break
  195. else:
  196. # Skip prereleases (based on version parsing, not GitHub flag)
  197. parsed = parse_version(tag)
  198. if parsed[4] == 0: # is_prerelease == 0
  199. release_data = release
  200. break
  201. if not release_data:
  202. _update_status = {
  203. "status": "idle",
  204. "progress": 100,
  205. "message": "No releases found",
  206. "error": None,
  207. }
  208. return {
  209. "update_available": False,
  210. "current_version": APP_VERSION,
  211. "latest_version": None,
  212. "message": "No releases found",
  213. }
  214. latest_version = release_data.get("tag_name", "").lstrip("v")
  215. release_name = release_data.get("name", latest_version)
  216. release_notes = release_data.get("body", "")
  217. release_url = release_data.get("html_url", "")
  218. published_at = release_data.get("published_at", "")
  219. update_available = is_newer_version(latest_version, APP_VERSION)
  220. _update_status = {
  221. "status": "idle",
  222. "progress": 100,
  223. "message": "Update available" if update_available else "Up to date",
  224. "error": None,
  225. }
  226. is_docker = _is_docker_environment()
  227. return {
  228. "update_available": update_available,
  229. "current_version": APP_VERSION,
  230. "latest_version": latest_version,
  231. "release_name": release_name,
  232. "release_notes": release_notes,
  233. "release_url": release_url,
  234. "published_at": published_at,
  235. "is_docker": is_docker,
  236. "update_method": "docker" if is_docker else "git",
  237. }
  238. except httpx.HTTPError as e:
  239. logger.error("Failed to check for updates: %s", e)
  240. _update_status = {
  241. "status": "error",
  242. "progress": 0,
  243. "message": "Failed to check for updates",
  244. "error": "Failed to check for updates",
  245. }
  246. return {
  247. "update_available": False,
  248. "current_version": APP_VERSION,
  249. "latest_version": None,
  250. "error": "Failed to check for updates",
  251. }
  252. async def _perform_update():
  253. """Perform the actual update using git fetch and reset."""
  254. global _update_status
  255. try:
  256. base_dir = settings.base_dir
  257. # Find git executable (may not be in PATH when running as systemd service)
  258. git_path = _find_executable("git")
  259. if not git_path:
  260. _update_status = {
  261. "status": "error",
  262. "progress": 0,
  263. "message": "Git not found",
  264. "error": "Could not find git executable. Please ensure git is installed.",
  265. }
  266. return
  267. logger.info("Using git at: %s", git_path)
  268. # Git config to avoid safe.directory issues
  269. git_config = ["-c", f"safe.directory={base_dir}"]
  270. _update_status = {
  271. "status": "downloading",
  272. "progress": 10,
  273. "message": "Configuring git...",
  274. "error": None,
  275. }
  276. # Ensure remote uses HTTPS (SSH may not be available)
  277. https_url = f"https://github.com/{GITHUB_REPO}.git"
  278. process = await asyncio.create_subprocess_exec(
  279. git_path,
  280. *git_config,
  281. "remote",
  282. "set-url",
  283. "origin",
  284. https_url,
  285. cwd=str(base_dir),
  286. stdout=asyncio.subprocess.PIPE,
  287. stderr=asyncio.subprocess.PIPE,
  288. )
  289. await process.communicate()
  290. _update_status = {
  291. "status": "downloading",
  292. "progress": 20,
  293. "message": "Fetching latest changes...",
  294. "error": None,
  295. }
  296. # Fetch from origin
  297. process = await asyncio.create_subprocess_exec(
  298. git_path,
  299. *git_config,
  300. "fetch",
  301. "origin",
  302. "main",
  303. cwd=str(base_dir),
  304. stdout=asyncio.subprocess.PIPE,
  305. stderr=asyncio.subprocess.PIPE,
  306. )
  307. stdout, stderr = await process.communicate()
  308. if process.returncode != 0:
  309. error_msg = stderr.decode() if stderr else "Git fetch failed"
  310. logger.error("Git fetch failed: %s", error_msg)
  311. _update_status = {
  312. "status": "error",
  313. "progress": 0,
  314. "message": "Failed to fetch updates",
  315. "error": error_msg,
  316. }
  317. return
  318. _update_status = {
  319. "status": "downloading",
  320. "progress": 40,
  321. "message": "Applying updates...",
  322. "error": None,
  323. }
  324. # Hard reset to origin/main (clean update, no merge conflicts)
  325. process = await asyncio.create_subprocess_exec(
  326. git_path,
  327. *git_config,
  328. "reset",
  329. "--hard",
  330. "origin/main",
  331. cwd=str(base_dir),
  332. stdout=asyncio.subprocess.PIPE,
  333. stderr=asyncio.subprocess.PIPE,
  334. )
  335. stdout, stderr = await process.communicate()
  336. if process.returncode != 0:
  337. error_msg = stderr.decode() if stderr else "Git reset failed"
  338. logger.error("Git reset failed: %s", error_msg)
  339. _update_status = {
  340. "status": "error",
  341. "progress": 0,
  342. "message": "Failed to apply updates",
  343. "error": error_msg,
  344. }
  345. return
  346. _update_status = {
  347. "status": "installing",
  348. "progress": 50,
  349. "message": "Installing dependencies...",
  350. "error": None,
  351. }
  352. # Install Python dependencies
  353. process = await asyncio.create_subprocess_exec(
  354. sys.executable,
  355. "-m",
  356. "pip",
  357. "install",
  358. "-r",
  359. "requirements.txt",
  360. "-q",
  361. cwd=str(base_dir),
  362. stdout=asyncio.subprocess.PIPE,
  363. stderr=asyncio.subprocess.PIPE,
  364. )
  365. stdout, stderr = await process.communicate()
  366. if process.returncode != 0:
  367. logger.warning("pip install warning: %s", stderr.decode() if stderr else "unknown")
  368. # Try to build frontend if npm is available (optional - static files are pre-built)
  369. npm_path = _find_executable("npm")
  370. frontend_dir = base_dir / "frontend"
  371. if npm_path and frontend_dir.exists():
  372. _update_status = {
  373. "status": "installing",
  374. "progress": 70,
  375. "message": "Building frontend...",
  376. "error": None,
  377. }
  378. # npm install
  379. process = await asyncio.create_subprocess_exec(
  380. npm_path,
  381. "install",
  382. cwd=str(frontend_dir),
  383. stdout=asyncio.subprocess.PIPE,
  384. stderr=asyncio.subprocess.PIPE,
  385. )
  386. await process.communicate()
  387. # npm run build
  388. process = await asyncio.create_subprocess_exec(
  389. npm_path,
  390. "run",
  391. "build",
  392. cwd=str(frontend_dir),
  393. stdout=asyncio.subprocess.PIPE,
  394. stderr=asyncio.subprocess.PIPE,
  395. )
  396. stdout, stderr = await process.communicate()
  397. if process.returncode != 0:
  398. logger.warning("Frontend build warning: %s", stderr.decode() if stderr else "unknown")
  399. else:
  400. logger.info("npm not found or frontend dir missing - using pre-built static files")
  401. _update_status = {
  402. "status": "complete",
  403. "progress": 100,
  404. "message": "Update complete! Please restart the application.",
  405. "error": None,
  406. }
  407. logger.info("Update completed successfully")
  408. except Exception as e:
  409. logger.error("Update failed: %s", e)
  410. _update_status = {
  411. "status": "error",
  412. "progress": 0,
  413. "message": "Update failed",
  414. "error": "Update failed unexpectedly",
  415. }
  416. @router.post("/apply")
  417. async def apply_update(
  418. background_tasks: BackgroundTasks,
  419. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_UPDATE),
  420. ):
  421. """Apply available update (git pull + rebuild)."""
  422. global _update_status
  423. if _update_status["status"] in ["downloading", "installing"]:
  424. return {
  425. "success": False,
  426. "message": "Update already in progress",
  427. "status": _update_status,
  428. }
  429. # Check if running in Docker
  430. if _is_docker_environment():
  431. return {
  432. "success": False,
  433. "is_docker": True,
  434. "message": (
  435. "Docker installations cannot be updated in-app. "
  436. "Please update via Docker Compose: "
  437. "git pull && docker compose build --pull && docker compose up -d"
  438. ),
  439. }
  440. # Start update in background
  441. background_tasks.add_task(_perform_update)
  442. _update_status = {
  443. "status": "downloading",
  444. "progress": 10,
  445. "message": "Starting update...",
  446. "error": None,
  447. }
  448. return {
  449. "success": True,
  450. "message": "Update started",
  451. "status": _update_status,
  452. }
  453. @router.get("/status")
  454. async def get_update_status(
  455. _: User | None = RequirePermissionIfAuthEnabled(Permission.SYSTEM_READ),
  456. ):
  457. """Get current update status."""
  458. return _update_status