local_backup.py 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270
  1. """Scheduled local backup service.
  2. Creates ZIP snapshots of the full Bambuddy data (database + data directories)
  3. on a configurable schedule with retention management.
  4. """
  5. import asyncio
  6. import logging
  7. from datetime import datetime, timedelta, timezone
  8. from pathlib import Path
  9. from sqlalchemy import select
  10. from backend.app.core.config import settings as app_settings
  11. from backend.app.core.database import async_session
  12. from backend.app.models.settings import Settings
  13. logger = logging.getLogger(__name__)
  14. SCHEDULE_INTERVALS = {
  15. "hourly": 3600,
  16. "daily": 86400,
  17. "weekly": 604800,
  18. }
  19. def _default_backup_dir() -> Path:
  20. return app_settings.base_dir / "backups"
  21. class LocalBackupService:
  22. """Manages scheduled local backup snapshots with retention."""
  23. def __init__(self):
  24. self._scheduler_task: asyncio.Task | None = None
  25. self._check_interval = 60
  26. self._running: bool = False
  27. self._last_backup_at: str | None = None
  28. self._last_status: str | None = None
  29. self._last_message: str | None = None
  30. self._next_run: datetime | None = None
  31. async def start_scheduler(self):
  32. """Start the background scheduler loop."""
  33. if self._scheduler_task is not None:
  34. return
  35. logger.info("Starting local backup scheduler")
  36. # Seed next_run from settings so the first check has a target
  37. await self._seed_next_run()
  38. self._scheduler_task = asyncio.create_task(self._scheduler_loop())
  39. def stop_scheduler(self):
  40. """Stop the scheduler."""
  41. if self._scheduler_task:
  42. self._scheduler_task.cancel()
  43. self._scheduler_task = None
  44. logger.info("Stopped local backup scheduler")
  45. async def _scheduler_loop(self):
  46. """Main scheduler loop — checks for due backups every minute."""
  47. while True:
  48. try:
  49. await asyncio.sleep(self._check_interval)
  50. await self._check_scheduled_backup()
  51. except asyncio.CancelledError:
  52. break
  53. except Exception as e:
  54. logger.error("Error in local backup scheduler: %s", e)
  55. await asyncio.sleep(60)
  56. async def _seed_next_run(self):
  57. """Load settings and calculate initial next_run."""
  58. try:
  59. settings = await self._load_settings()
  60. if settings.get("enabled"):
  61. self._next_run = self._calculate_next_run(
  62. settings.get("schedule", "daily"),
  63. settings.get("time", "03:00"),
  64. )
  65. except Exception as e:
  66. logger.debug("Could not seed local backup next_run: %s", e)
  67. async def _load_settings(self) -> dict:
  68. """Read local backup settings from the DB."""
  69. async with async_session() as db:
  70. keys = [
  71. "local_backup_enabled",
  72. "local_backup_schedule",
  73. "local_backup_time",
  74. "local_backup_retention",
  75. "local_backup_path",
  76. ]
  77. result = await db.execute(select(Settings).where(Settings.key.in_(keys)))
  78. rows = {r.key: r.value for r in result.scalars().all()}
  79. return {
  80. "enabled": rows.get("local_backup_enabled", "false").lower() == "true",
  81. "schedule": rows.get("local_backup_schedule", "daily"),
  82. "time": rows.get("local_backup_time", "03:00"),
  83. "retention": int(rows.get("local_backup_retention", "5")),
  84. "path": rows.get("local_backup_path", ""),
  85. }
  86. async def _check_scheduled_backup(self):
  87. """Check if a scheduled backup is due and run it."""
  88. settings = await self._load_settings()
  89. if not settings["enabled"]:
  90. self._next_run = None
  91. return
  92. now = datetime.now(timezone.utc)
  93. # If no next_run set, schedule one
  94. if self._next_run is None:
  95. self._next_run = self._calculate_next_run(settings["schedule"], settings["time"])
  96. return
  97. if self._next_run <= now:
  98. logger.info("Running scheduled local backup")
  99. await self.run_backup(settings)
  100. self._next_run = self._calculate_next_run(settings["schedule"], settings["time"])
  101. def _calculate_next_run(self, schedule_type: str, time_str: str = "03:00") -> datetime:
  102. """Calculate the next scheduled run time.
  103. For hourly: next full hour.
  104. For daily/weekly: next occurrence of the configured time (HH:MM).
  105. """
  106. now = datetime.now(timezone.utc)
  107. if schedule_type == "hourly":
  108. # Next full hour
  109. next_run = now.replace(minute=0, second=0, microsecond=0) + timedelta(hours=1)
  110. return next_run
  111. # Parse HH:MM time
  112. try:
  113. parts = time_str.strip().split(":")
  114. hour = int(parts[0])
  115. minute = int(parts[1]) if len(parts) > 1 else 0
  116. except (ValueError, IndexError):
  117. hour, minute = 3, 0
  118. # Next occurrence of this time today or tomorrow
  119. next_run = now.replace(hour=hour, minute=minute, second=0, microsecond=0)
  120. if next_run <= now:
  121. next_run += timedelta(days=1)
  122. if schedule_type == "weekly":
  123. next_run += timedelta(weeks=1)
  124. return next_run
  125. def _resolve_backup_dir(self, path_setting: str) -> Path:
  126. """Resolve the backup output directory from settings."""
  127. if path_setting.strip():
  128. return Path(path_setting.strip())
  129. return _default_backup_dir()
  130. async def run_backup(self, settings: dict | None = None) -> dict:
  131. """Run a backup now. Returns {success, message, filename}."""
  132. if self._running:
  133. return {"success": False, "message": "Backup already in progress"}
  134. self._running = True
  135. try:
  136. if settings is None:
  137. settings = await self._load_settings()
  138. backup_dir = self._resolve_backup_dir(settings["path"])
  139. backup_dir.mkdir(parents=True, exist_ok=True)
  140. from backend.app.api.routes.settings import create_backup_zip
  141. zip_path, filename = await create_backup_zip(output_path=backup_dir)
  142. # Prune old backups
  143. retention = max(1, settings["retention"])
  144. self._prune_backups(backup_dir, retention)
  145. self._last_backup_at = datetime.now(timezone.utc).isoformat()
  146. self._last_status = "success"
  147. self._last_message = filename
  148. logger.info("Local backup created: %s", zip_path)
  149. return {"success": True, "message": "Backup created", "filename": filename}
  150. except Exception as e:
  151. self._last_backup_at = datetime.now(timezone.utc).isoformat()
  152. self._last_status = "failed"
  153. self._last_message = str(e)
  154. logger.error("Local backup failed: %s", e, exc_info=True)
  155. return {"success": False, "message": f"Backup failed: {e}"}
  156. finally:
  157. self._running = False
  158. def _prune_backups(self, backup_dir: Path, retention: int):
  159. """Delete oldest backups exceeding the retention count."""
  160. backups = sorted(
  161. backup_dir.glob("bambuddy-backup-*.zip"),
  162. key=lambda p: p.stat().st_mtime,
  163. reverse=True,
  164. )
  165. for old_backup in backups[retention:]:
  166. try:
  167. old_backup.unlink()
  168. logger.info("Pruned old backup: %s", old_backup.name)
  169. except OSError as e:
  170. logger.warning("Could not delete old backup %s: %s", old_backup.name, e)
  171. def get_status(self) -> dict:
  172. """Return current scheduler status."""
  173. return {
  174. "is_running": self._running,
  175. "last_backup_at": self._last_backup_at,
  176. "last_status": self._last_status,
  177. "last_message": self._last_message,
  178. "next_run": self._next_run.isoformat() if self._next_run else None,
  179. }
  180. def resolve_backup_file(self, path_setting: str, filename: str) -> Path | None:
  181. """Resolve a backup filename to a full path, with safety checks."""
  182. if "/" in filename or "\\" in filename or ".." in filename:
  183. return None
  184. if not filename.startswith("bambuddy-backup-") or not filename.endswith(".zip"):
  185. return None
  186. backup_dir = self._resolve_backup_dir(path_setting)
  187. target = backup_dir / filename
  188. if not target.exists():
  189. return None
  190. return target
  191. def list_backups(self, path_setting: str) -> list[dict]:
  192. """List backup ZIP files in the backup directory."""
  193. backup_dir = self._resolve_backup_dir(path_setting)
  194. if not backup_dir.exists():
  195. return []
  196. backups = []
  197. for f in sorted(backup_dir.glob("bambuddy-backup-*.zip"), key=lambda p: p.stat().st_mtime, reverse=True):
  198. stat = f.stat()
  199. backups.append(
  200. {
  201. "filename": f.name,
  202. "size": stat.st_size,
  203. "created_at": datetime.fromtimestamp(stat.st_mtime, tz=timezone.utc).isoformat(),
  204. }
  205. )
  206. return backups
  207. def delete_backup(self, path_setting: str, filename: str) -> dict:
  208. """Delete a specific backup file. Returns {success, message}."""
  209. # Path traversal protection
  210. if "/" in filename or "\\" in filename or ".." in filename:
  211. return {"success": False, "message": "Invalid filename"}
  212. backup_dir = self._resolve_backup_dir(path_setting)
  213. target = backup_dir / filename
  214. if not target.exists():
  215. return {"success": False, "message": "Backup not found"}
  216. if not target.name.startswith("bambuddy-backup-") or not target.name.endswith(".zip"):
  217. return {"success": False, "message": "Invalid backup file"}
  218. try:
  219. target.unlink()
  220. return {"success": True, "message": "Backup deleted"}
  221. except OSError as e:
  222. return {"success": False, "message": f"Could not delete: {e}"}
  223. local_backup_service = LocalBackupService()