|
|
| """
|
| backup_mirror.py -- Timestamped backup mirror of critical Claude files.
|
|
|
| Mirrors the user's most important local state so that a broken hook, a
|
| merge mishap, or a mis-applied heal does not cost them their work. The
|
| following trees are mirrored:
|
|
|
| ~/.claude/settings.json -> settings.json
|
| ~/.claude/skill-manifest.json -> skill-manifest.json
|
| ~/.claude/pending-skills.json -> pending-skills.json
|
| ~/.claude/agents/<name>.md -> agents/<name>.md
|
| ~/.claude/skills/<name>/SKILL.md -> skills/<name>/SKILL.md
|
| ~/.claude/projects/<slug>/memory/*.md -> memory/<slug>/*.md
|
|
|
| Each snapshot lives under ``~/.claude/backups/<timestamp>/`` with a
|
| companion ``manifest.json`` recording the absolute source path, SHA-256
|
| digest, and byte size of every captured file.
|
|
|
| Commands:
|
|
|
| python src/backup_mirror.py create
|
| Take a fresh snapshot. Prints the snapshot directory on stdout.
|
|
|
| python src/backup_mirror.py list
|
| Show snapshots newest-first with file counts and total size.
|
|
|
| python src/backup_mirror.py verify [--snapshot <id>]
|
| Re-hash every file in the snapshot against its manifest entry.
|
| Exit 2 if any hash mismatch or missing file.
|
|
|
| python src/backup_mirror.py restore --snapshot <id> [--dry-run]
|
| Restore the snapshot over the live tree. Without --dry-run this
|
| overwrites live files; with --dry-run it prints what would change.
|
|
|
| python src/backup_mirror.py prune --keep <N>
|
| Delete all but the N newest snapshots. Legacy mode.
|
|
|
| python src/backup_mirror.py prune --policy [--dry-run] [--json]
|
| Apply the configured retention policy (keep_latest + keep_daily).
|
| ``--dry-run`` reports what would be removed without deleting.
|
|
|
| Design notes:
|
|
|
| - Never follows symlinks (os.walk with followlinks=False) to avoid
|
| capturing unrelated trees if the user has symlinked ~/.claude anywhere.
|
| - Per-file size cap (MAX_FILE_BYTES) prevents a rogue multi-GB log from
|
| ballooning backups. Files over the cap are recorded in manifest with
|
| ``skipped: "too_large"`` but their content is not copied.
|
| - Atomic writes via tempfile + os.replace so a crashed snapshot never
|
| leaves a half-written file under the snapshot directory name.
|
| - Restore validates every source digest before touching live files. If
|
| any mismatch is found the restore aborts before any file is modified.
|
| """
|
|
|
| from __future__ import annotations
|
|
|
| import argparse
|
| import hashlib
|
| import json
|
| import os
|
| import shutil
|
| import stat as _stat
|
| import sys
|
| import tempfile
|
| import time
|
| from dataclasses import asdict, dataclass
|
| from pathlib import Path
|
| from typing import TYPE_CHECKING, Iterable
|
|
|
|
|
|
|
|
|
|
|
|
|
| from ctx.utils._fs_utils import (
|
| _fsync_parent_dir,
|
| _replace_with_retry,
|
| atomic_write_text as _atomic_write_text,
|
| )
|
| from backup_config import BackupConfig, from_ctx_config
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| if TYPE_CHECKING:
|
| from backup_config import BackupRetention
|
| from backup_retention import RetentionPlan
|
| from change_detector import ChangeReport
|
|
|
|
|
| CLAUDE_HOME = Path(os.path.expanduser("~/.claude"))
|
|
|
| _CFG: BackupConfig = from_ctx_config()
|
| BACKUPS_DIR = _CFG.snapshot_dir_resolved()
|
|
|
|
|
|
|
|
|
| TOP_FILES: tuple[str, ...] = _CFG.top_files
|
|
|
|
|
| MAX_FILE_BYTES: int = _CFG.max_file_bytes
|
|
|
|
|
| TREE_SOURCES: tuple[tuple[str, str], ...] = tuple(
|
| (t.src, t.dest) for t in _CFG.trees
|
| )
|
|
|
|
|
| MEMORY_GLOB: bool = _CFG.memory_glob
|
|
|
|
|
|
|
|
|
| SNAPSHOT_FMT: str = _CFG.timestamp_format
|
| _SNAPSHOT_TEMP_PREFIX = ".tmp-"
|
|
|
|
|
|
|
|
|
|
|
| @dataclass(frozen=True)
|
| class ManifestEntry:
|
| source: str
|
| dest: str
|
| size: int
|
| sha256: str | None
|
| skipped: str | None
|
|
|
| def to_dict(self) -> dict:
|
| return asdict(self)
|
|
|
|
|
| @dataclass(frozen=True)
|
| class SnapshotInfo:
|
| snapshot_id: str
|
| path: str
|
| created_at: float
|
| file_count: int
|
| total_bytes: int
|
|
|
| def to_dict(self) -> dict:
|
| return asdict(self)
|
|
|
|
|
|
|
|
|
|
|
| def _iter_top_files() -> Iterable[Path]:
|
| for name in TOP_FILES:
|
| p = CLAUDE_HOME / name
|
| if p.is_file():
|
| yield p
|
|
|
|
|
| def _iter_tree(src_rel: str) -> Iterable[Path]:
|
| root = CLAUDE_HOME / src_rel
|
| if not root.is_dir():
|
| return
|
| for dirpath, _dirnames, filenames in os.walk(root, followlinks=False):
|
| for name in filenames:
|
| yield Path(dirpath) / name
|
|
|
|
|
| def _iter_memory_files() -> Iterable[tuple[str, Path]]:
|
| """
|
| Walk ~/.claude/projects/<slug>/memory and yield (slug, path) pairs so
|
| the mirror preserves per-project memory grouping.
|
|
|
| Skipped entirely when MEMORY_GLOB is False (``backup.memory_glob`` in
|
| config). Existing callers get the original behaviour by default.
|
| """
|
| if not MEMORY_GLOB:
|
| return
|
| projects = CLAUDE_HOME / "projects"
|
| if not projects.is_dir():
|
| return
|
| for slug_dir in projects.iterdir():
|
| if not slug_dir.is_dir():
|
| continue
|
| memory_dir = slug_dir / "memory"
|
| if not memory_dir.is_dir():
|
| continue
|
| for dirpath, _dirnames, filenames in os.walk(memory_dir, followlinks=False):
|
| for name in filenames:
|
| yield slug_dir.name, Path(dirpath) / name
|
|
|
|
|
|
|
|
|
|
|
| def _sha256_bytes(data: bytes) -> str:
|
| h = hashlib.sha256()
|
| h.update(data)
|
| return h.hexdigest()
|
|
|
|
|
| def _sha256_file(path: Path) -> str:
|
|
|
|
|
| if path.is_symlink():
|
| raise ValueError(f"refusing to hash symlink: {path}")
|
| h = hashlib.sha256()
|
| with open(path, "rb") as fh:
|
| while True:
|
| chunk = fh.read(1 << 20)
|
| if not chunk:
|
| break
|
| h.update(chunk)
|
| return h.hexdigest()
|
|
|
|
|
| def _atomic_copy(src: Path, dest: Path) -> None:
|
|
|
|
|
| if src.is_symlink():
|
| raise ValueError(f"refusing to copy symlink: {src}")
|
| dest.parent.mkdir(parents=True, exist_ok=True)
|
| fd, tmp = tempfile.mkstemp(prefix=dest.name + ".", dir=str(dest.parent))
|
| try:
|
| os.close(fd)
|
|
|
|
|
|
|
| shutil.copy2(str(src), tmp, follow_symlinks=False)
|
| os.replace(tmp, dest)
|
| except Exception:
|
| try:
|
| os.unlink(tmp)
|
| except OSError:
|
| pass
|
| raise
|
|
|
|
|
| def _contained(candidate: Path, base: Path) -> bool:
|
| """True only if ``candidate`` resolves under ``base`` (no traversal)."""
|
| try:
|
| candidate.resolve(strict=False).relative_to(base.resolve(strict=False))
|
| return True
|
| except ValueError:
|
| return False
|
|
|
|
|
|
|
|
|
|
|
| def _validate_manifest_dest(dest_rel: str) -> Path:
|
| if not isinstance(dest_rel, str) or not dest_rel:
|
| raise ValueError(f"invalid manifest dest: {dest_rel!r}")
|
| if "\x00" in dest_rel or "\\" in dest_rel:
|
| raise ValueError(f"invalid manifest dest: {dest_rel!r}")
|
|
|
|
|
| if dest_rel.startswith("/"):
|
| raise ValueError(f"invalid manifest dest: {dest_rel!r}")
|
| p = Path(dest_rel)
|
| if p.is_absolute() or ".." in p.parts or any(part == "" for part in p.parts):
|
| raise ValueError(f"invalid manifest dest: {dest_rel!r}")
|
| return p
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| _REASON_SAFE_CHARS = "-_."
|
|
|
|
|
| def _sanitize_reason(raw: str) -> str:
|
| """Make ``raw`` safe to embed in a directory name. Caps at 40 chars."""
|
| cleaned = "".join(
|
| c if (c.isalnum() or c in _REASON_SAFE_CHARS) else "-"
|
| for c in raw.lower()
|
| )
|
|
|
| while "--" in cleaned:
|
| cleaned = cleaned.replace("--", "-")
|
| return cleaned.strip("-_.")[:40]
|
|
|
|
|
| def _new_snapshot_id(now: float | None = None,
|
| reason: str | None = None) -> str:
|
| """Build snapshot directory name from SNAPSHOT_FMT + NAME_FORMAT + reason.
|
|
|
| Timestamp gets microsecond precision to avoid collisions under
|
| back-to-back automation. Reason is sanitised to keep the name
|
| filesystem-safe; when a reason is supplied but the configured
|
| ``name_format`` lacks ``{reason}``, the slug is appended with an
|
| underscore separator.
|
| """
|
| ts = now if now is not None else time.time()
|
| base = time.strftime(SNAPSHOT_FMT, time.gmtime(ts))
|
| micro = int((ts - int(ts)) * 1_000_000)
|
| stamp = f"{base[:-1]}.{micro:06d}Z" if base.endswith("Z") else f"{base}.{micro:06d}"
|
|
|
| safe_reason = _sanitize_reason(reason) if reason else ""
|
| fmt = _CFG.name_format
|
| name = fmt.format_map({"timestamp": stamp, "reason": safe_reason})
|
| if safe_reason and "{reason}" not in fmt:
|
| name = f"{name}_{safe_reason}"
|
|
|
| return name.rstrip("-_.")
|
|
|
|
|
| def _publish_snapshot_dir(tmp_path: Path, snap_path: Path) -> None:
|
| if snap_path.exists():
|
| raise FileExistsError(snap_path)
|
| _replace_with_retry(str(tmp_path), snap_path)
|
| _fsync_parent_dir(snap_path.parent)
|
|
|
|
|
| def create_snapshot(backups_dir: Path | None = None,
|
| now: float | None = None,
|
| reason: str | None = None) -> Path:
|
| """Produce a fresh backup snapshot and return its directory.
|
|
|
| ``reason`` is an optional label appended to the snapshot folder so
|
| operators can tell why a snapshot was taken (e.g. ``"post-edit"``,
|
| ``"pre-restore"``, ``"manual"``). Sanitised internally so callers
|
| can pass arbitrary strings without worrying about path escapes.
|
| """
|
|
|
| backups_dir = backups_dir if backups_dir is not None else BACKUPS_DIR
|
| claude_home = CLAUDE_HOME
|
| backups_dir.mkdir(parents=True, exist_ok=True)
|
| snap_id = _new_snapshot_id(now, reason)
|
| snap_path = backups_dir / snap_id
|
| if snap_path.exists():
|
| raise FileExistsError(snap_path)
|
|
|
| entries: list[ManifestEntry] = []
|
| tmp_path = Path(
|
| tempfile.mkdtemp(
|
| prefix=f"{_SNAPSHOT_TEMP_PREFIX}{snap_id}-",
|
| dir=str(backups_dir),
|
| )
|
| )
|
|
|
| try:
|
| for src in _iter_top_files():
|
| entries.append(_capture_file(src, tmp_path, src.name))
|
|
|
| for src_rel, dest_rel in TREE_SOURCES:
|
| root = claude_home / src_rel
|
| for src in _iter_tree(src_rel):
|
| rel = src.relative_to(root)
|
| dest_rel_path = Path(dest_rel) / rel
|
| entries.append(_capture_file(src, tmp_path, dest_rel_path.as_posix()))
|
|
|
| for slug, src in _iter_memory_files():
|
| memory_root = claude_home / "projects" / slug / "memory"
|
| rel = src.relative_to(memory_root)
|
| dest_rel_path = Path("memory") / slug / rel
|
| entries.append(_capture_file(src, tmp_path, dest_rel_path.as_posix()))
|
|
|
| manifest = {
|
| "snapshot_id": snap_id,
|
| "created_at": now if now is not None else time.time(),
|
| "claude_home": str(claude_home),
|
| "reason": reason or None,
|
| "entries": [e.to_dict() for e in entries],
|
| }
|
| _atomic_write_text(
|
| tmp_path / "manifest.json",
|
| json.dumps(manifest, indent=2),
|
| )
|
| _publish_snapshot_dir(tmp_path, snap_path)
|
| except Exception:
|
| if tmp_path.exists():
|
| shutil.rmtree(tmp_path, ignore_errors=True)
|
| raise
|
| return snap_path
|
|
|
|
|
| def _capture_file(src: Path, snap_path: Path, dest_rel: str) -> ManifestEntry:
|
|
|
|
|
| try:
|
| st = os.lstat(src)
|
| except OSError:
|
| return ManifestEntry(
|
| source=str(src),
|
| dest=dest_rel,
|
| size=0,
|
| sha256=None,
|
| skipped="stat_failed",
|
| )
|
| if _stat.S_ISLNK(st.st_mode):
|
| return ManifestEntry(
|
| source=str(src),
|
| dest=dest_rel,
|
| size=int(st.st_size),
|
| sha256=None,
|
| skipped="symlink",
|
| )
|
| size = int(st.st_size)
|
| if size > MAX_FILE_BYTES:
|
| return ManifestEntry(
|
| source=str(src),
|
| dest=dest_rel,
|
| size=size,
|
| sha256=None,
|
| skipped="too_large",
|
| )
|
| dest = snap_path / dest_rel
|
| try:
|
| _atomic_copy(src, dest)
|
| except (OSError, ValueError):
|
| return ManifestEntry(
|
| source=str(src),
|
| dest=dest_rel,
|
| size=size,
|
| sha256=None,
|
| skipped="copy_failed",
|
| )
|
| digest = _sha256_file(dest)
|
| return ManifestEntry(
|
| source=str(src),
|
| dest=dest_rel,
|
| size=size,
|
| sha256=digest,
|
| skipped=None,
|
| )
|
|
|
|
|
|
|
|
|
|
|
| def list_snapshots(backups_dir: Path | None = None) -> list[SnapshotInfo]:
|
| backups_dir = backups_dir if backups_dir is not None else BACKUPS_DIR
|
| if not backups_dir.is_dir():
|
| return []
|
| out: list[SnapshotInfo] = []
|
| for child in sorted(backups_dir.iterdir(), reverse=True):
|
| if not child.is_dir():
|
| continue
|
| if child.name.startswith(_SNAPSHOT_TEMP_PREFIX):
|
| continue
|
| manifest = child / "manifest.json"
|
| if not manifest.is_file():
|
| continue
|
| try:
|
| raw = json.loads(manifest.read_text(encoding="utf-8"))
|
| except (OSError, json.JSONDecodeError):
|
| continue
|
| entries = raw.get("entries") or []
|
| total = sum(int(e.get("size") or 0) for e in entries)
|
| out.append(SnapshotInfo(
|
| snapshot_id=str(raw.get("snapshot_id") or child.name),
|
| path=str(child),
|
| created_at=float(raw.get("created_at") or 0),
|
| file_count=len(entries),
|
| total_bytes=total,
|
| ))
|
| return out
|
|
|
|
|
|
|
|
|
|
|
| @dataclass(frozen=True)
|
| class VerifyReport:
|
| snapshot_id: str
|
| checked: int
|
| missing: tuple[str, ...]
|
| hash_mismatch: tuple[str, ...]
|
| skipped: tuple[str, ...]
|
|
|
| @property
|
| def ok(self) -> bool:
|
| return not self.missing and not self.hash_mismatch
|
|
|
| def to_dict(self) -> dict:
|
| return asdict(self)
|
|
|
|
|
| def verify_snapshot(snap_path: Path) -> VerifyReport:
|
| manifest = json.loads((snap_path / "manifest.json").read_text(encoding="utf-8"))
|
| entries = manifest.get("entries") or []
|
| missing: list[str] = []
|
| mismatch: list[str] = []
|
| skipped: list[str] = []
|
| checked = 0
|
| for raw in entries:
|
| dest_rel_raw = str(raw.get("dest") or "")
|
| expected = raw.get("sha256")
|
| skip_reason = raw.get("skipped")
|
| if skip_reason:
|
| skipped.append(f"{dest_rel_raw}: {skip_reason}")
|
| continue
|
|
|
|
|
|
|
| try:
|
| dest_rel = _validate_manifest_dest(dest_rel_raw)
|
| except ValueError:
|
| mismatch.append(dest_rel_raw)
|
| continue
|
| file_path = snap_path / dest_rel
|
| if not _contained(file_path, snap_path):
|
| mismatch.append(dest_rel_raw)
|
| continue
|
| if not file_path.is_file() or file_path.is_symlink():
|
| missing.append(str(dest_rel))
|
| continue
|
| try:
|
| actual = _sha256_file(file_path)
|
| except ValueError:
|
| mismatch.append(str(dest_rel))
|
| continue
|
| if actual != expected:
|
| mismatch.append(str(dest_rel))
|
| checked += 1
|
| return VerifyReport(
|
| snapshot_id=str(manifest.get("snapshot_id") or snap_path.name),
|
| checked=checked,
|
| missing=tuple(missing),
|
| hash_mismatch=tuple(mismatch),
|
| skipped=tuple(skipped),
|
| )
|
|
|
|
|
|
|
|
|
|
|
| @dataclass(frozen=True)
|
| class RestoreReport:
|
| snapshot_id: str
|
| restored: tuple[str, ...]
|
| skipped: tuple[str, ...]
|
| dry_run: bool
|
|
|
| def to_dict(self) -> dict:
|
| return asdict(self)
|
|
|
|
|
| def restore_snapshot(snap_path: Path,
|
| claude_home: Path | None = None,
|
| dry_run: bool = False) -> RestoreReport:
|
| """
|
| Restore the given snapshot over ``claude_home``. Refuses to start
|
| unless the snapshot verifies clean.
|
| """
|
| claude_home = claude_home if claude_home is not None else CLAUDE_HOME
|
| verify = verify_snapshot(snap_path)
|
| if not verify.ok:
|
| raise RuntimeError(
|
| f"snapshot {verify.snapshot_id} failed verification; "
|
| f"refusing to restore. Missing: {verify.missing}, "
|
| f"hash mismatch: {verify.hash_mismatch}."
|
| )
|
|
|
| manifest = json.loads((snap_path / "manifest.json").read_text(encoding="utf-8"))
|
| entries = manifest.get("entries") or []
|
|
|
| restored: list[str] = []
|
| skipped: list[str] = []
|
| for raw in entries:
|
| dest_rel_raw = str(raw.get("dest") or "")
|
| if raw.get("skipped"):
|
| skipped.append(dest_rel_raw)
|
| continue
|
|
|
|
|
|
|
| dest_rel_path = _validate_manifest_dest(dest_rel_raw)
|
| src = snap_path / dest_rel_path
|
| if not _contained(src, snap_path):
|
| raise ValueError(f"snapshot source escapes snapshot root: {dest_rel_raw!r}")
|
| target = _resolve_restore_target(dest_rel_raw, claude_home)
|
| if not _contained(target, claude_home):
|
| raise ValueError(
|
| f"restore target escapes claude_home: {dest_rel_raw!r}"
|
| )
|
| if not dry_run:
|
| _atomic_copy(src, target)
|
| restored.append(str(target))
|
| return RestoreReport(
|
| snapshot_id=str(manifest.get("snapshot_id") or snap_path.name),
|
| restored=tuple(restored),
|
| skipped=tuple(skipped),
|
| dry_run=dry_run,
|
| )
|
|
|
|
|
| def _resolve_restore_target(dest_rel: str, claude_home: Path) -> Path:
|
| """
|
| Snapshot layout -> live layout. Inverse of the mapping used in
|
| create_snapshot. Rejects any dest that doesn't match a known layout
|
| or that contains traversal segments.
|
| """
|
| rel_path = _validate_manifest_dest(dest_rel)
|
| parts = rel_path.parts
|
|
|
|
|
| if dest_rel in TOP_FILES:
|
| return claude_home / dest_rel
|
|
|
|
|
| if parts[0] == "memory" and len(parts) >= 3:
|
| slug = parts[1]
|
|
|
|
|
|
|
| if "/" in slug or "\\" in slug or slug in {".", ".."}:
|
| raise ValueError(f"invalid memory slug in dest: {dest_rel!r}")
|
| rel = Path(*parts[2:])
|
| return claude_home / "projects" / slug / "memory" / rel
|
|
|
|
|
| for src_rel, dest_head in TREE_SOURCES:
|
| if parts[0] == dest_head:
|
| rel = Path(*parts[1:]) if len(parts) > 1 else Path()
|
| return claude_home / src_rel / rel
|
|
|
| raise ValueError(f"unrecognised dest layout: {dest_rel!r}")
|
|
|
|
|
|
|
|
|
|
|
| def _delete_snapshot_dirs(
|
| snaps_to_remove: Iterable[SnapshotInfo],
|
| backups_dir: Path,
|
| ) -> list[str]:
|
| """Actually delete snapshot directories. Returns IDs successfully removed.
|
|
|
| Refuses to rmtree a symlinked child (which would follow out of
|
| backups_dir) or any path that fails the containment check.
|
| """
|
| removed: list[str] = []
|
| for snap in snaps_to_remove:
|
| snap_path = Path(snap.path)
|
| if snap_path.is_symlink() or not _contained(snap_path, backups_dir):
|
| continue
|
| shutil.rmtree(snap_path, ignore_errors=True)
|
| removed.append(snap.snapshot_id)
|
| return removed
|
|
|
|
|
| def prune_snapshots(keep: int,
|
| backups_dir: Path | None = None) -> tuple[str, ...]:
|
| """Legacy prune: keep only the ``keep`` newest snapshots.
|
|
|
| Retained for backward compatibility. New callers should prefer
|
| :func:`prune_by_policy`, which honours both ``keep_latest`` and
|
| ``keep_daily`` from the active :class:`BackupRetention`.
|
| """
|
| if keep < 0:
|
| raise ValueError(f"keep must be >= 0, got {keep}")
|
| backups_dir = backups_dir if backups_dir is not None else BACKUPS_DIR
|
| snaps = list_snapshots(backups_dir)
|
| to_remove = snaps[keep:]
|
| return tuple(_delete_snapshot_dirs(to_remove, backups_dir))
|
|
|
|
|
| def prune_by_policy(
|
| retention: BackupRetention | None = None,
|
| backups_dir: Path | None = None,
|
| *,
|
| dry_run: bool = False,
|
| now: float | None = None,
|
| ) -> RetentionPlan:
|
| """Prune snapshots according to the configured retention policy.
|
|
|
| Parameters
|
| ----------
|
| retention
|
| Retention policy to apply. Defaults to ``_CFG.retention``.
|
| backups_dir
|
| Root to prune. Defaults to ``BACKUPS_DIR``.
|
| dry_run
|
| When True, compute the plan but delete nothing.
|
| now
|
| Clock override (seconds since epoch) for deterministic tests.
|
|
|
| Returns
|
| -------
|
| RetentionPlan
|
| Structured plan showing what was kept and what was (or would
|
| have been) deleted.
|
| """
|
| from backup_retention import RetentionPlan, plan_prune
|
|
|
| policy = retention if retention is not None else _CFG.retention
|
| backups_dir = backups_dir if backups_dir is not None else BACKUPS_DIR
|
| snaps = list_snapshots(backups_dir)
|
| plan = plan_prune(snaps, policy, now=now)
|
|
|
| if dry_run:
|
| return plan
|
|
|
| by_id = {s.snapshot_id: s for s in snaps}
|
| to_remove = [by_id[i] for i in plan.delete if i in by_id]
|
| removed = _delete_snapshot_dirs(to_remove, backups_dir)
|
|
|
|
|
|
|
| actually_removed = set(removed)
|
| pruned_delete = tuple(i for i in plan.delete if i in actually_removed)
|
| return RetentionPlan(
|
| keep=plan.keep,
|
| delete=pruned_delete,
|
| protected_by_latest=plan.protected_by_latest,
|
| protected_by_daily=plan.protected_by_daily,
|
| )
|
|
|
|
|
|
|
|
|
|
|
| @dataclass(frozen=True)
|
| class SnapshotIfChangedResult:
|
| """Outcome of a snapshot-if-changed run."""
|
|
|
| snapshot_path: Path | None
|
| report: ChangeReport
|
| reason: str | None
|
|
|
| def to_dict(self) -> dict:
|
| return {
|
| "snapshot_path": str(self.snapshot_path) if self.snapshot_path else None,
|
| "reason": self.reason,
|
| "report": self.report.to_dict(),
|
| }
|
|
|
|
|
| def snapshot_if_changed(reason: str | None = None,
|
| backups_dir: Path | None = None,
|
| now: float | None = None) -> SnapshotIfChangedResult:
|
| """Take a new snapshot iff at least one tracked file has changed.
|
|
|
| Compares current SHA-256 hashes of all files under the active
|
| BackupConfig (top_files + trees + optional memory glob) against the
|
| most-recent existing snapshot's manifest. Returns a
|
| :class:`SnapshotIfChangedResult` whose ``snapshot_path`` is ``None``
|
| when nothing has changed — making this cheap to call from a hook
|
| that fires on every tool invocation.
|
| """
|
| from change_detector import detect_changes
|
|
|
| backups_dir = backups_dir if backups_dir is not None else BACKUPS_DIR
|
| snaps = list_snapshots(backups_dir) if backups_dir.is_dir() else []
|
| last_path = Path(snaps[0].path) if snaps else None
|
|
|
| report = detect_changes(_CFG, CLAUDE_HOME, last_path)
|
|
|
| if not report.has_changes and last_path is not None:
|
| return SnapshotIfChangedResult(
|
| snapshot_path=None, report=report, reason=reason,
|
| )
|
|
|
| snap_path = create_snapshot(backups_dir=backups_dir, now=now, reason=reason)
|
|
|
|
|
|
|
| try:
|
| prune_by_policy(backups_dir=backups_dir, now=now)
|
| except (OSError, ValueError) as exc:
|
| print(f"[snapshot-if-changed] prune skipped: {exc}", file=sys.stderr)
|
| return SnapshotIfChangedResult(
|
| snapshot_path=snap_path, report=report, reason=reason,
|
| )
|
|
|
|
|
|
|
|
|
|
|
| def _resolve_snapshot_arg(arg: str | None,
|
| backups_dir: Path) -> Path:
|
| snaps = list_snapshots(backups_dir)
|
| if not snaps:
|
| raise FileNotFoundError("no snapshots exist")
|
| if arg in (None, "", "latest"):
|
| return Path(snaps[0].path)
|
| for s in snaps:
|
| if s.snapshot_id == arg:
|
| return Path(s.path)
|
| raise FileNotFoundError(f"no snapshot matches {arg!r}")
|
|
|
|
|
| def cmd_create(args: argparse.Namespace) -> int:
|
| reason = getattr(args, "reason", None)
|
| snap_path = create_snapshot(reason=reason)
|
| print(str(snap_path))
|
| return 0
|
|
|
|
|
| def cmd_snapshot_if_changed(args: argparse.Namespace) -> int:
|
| reason = getattr(args, "reason", None)
|
| result = snapshot_if_changed(reason=reason)
|
| if args.json:
|
| print(json.dumps(result.to_dict(), indent=2, default=str))
|
| return 0
|
| if result.snapshot_path is None:
|
| baseline = result.report.baseline_snapshot or "none"
|
| print(f"[snapshot-if-changed] no changes since {baseline}")
|
| return 0
|
| rpt = result.report
|
| print(
|
| f"[snapshot-if-changed] {result.snapshot_path.name} "
|
| f"new={len(rpt.new)} changed={len(rpt.changed)} "
|
| f"removed={len(rpt.removed)} unchanged={rpt.unchanged}"
|
| )
|
| return 0
|
|
|
|
|
| def cmd_list(args: argparse.Namespace) -> int:
|
| snaps = list_snapshots()
|
| if args.json:
|
| print(json.dumps([s.to_dict() for s in snaps], indent=2))
|
| return 0
|
| if not snaps:
|
| print("No snapshots.")
|
| return 0
|
| for s in snaps:
|
| ts = time.strftime("%Y-%m-%d %H:%M:%S", time.gmtime(s.created_at))
|
| kb = s.total_bytes / 1024
|
| print(f"{s.snapshot_id} {ts} files={s.file_count} size={kb:.1f} KB")
|
| return 0
|
|
|
|
|
| def cmd_verify(args: argparse.Namespace) -> int:
|
| try:
|
| snap_path = _resolve_snapshot_arg(args.snapshot, BACKUPS_DIR)
|
| except FileNotFoundError as exc:
|
| print(str(exc), file=sys.stderr)
|
| return 1
|
| report = verify_snapshot(snap_path)
|
| if args.json:
|
| print(json.dumps(report.to_dict(), indent=2))
|
| else:
|
| print(
|
| f"[verify] {report.snapshot_id} checked={report.checked} "
|
| f"missing={len(report.missing)} mismatch={len(report.hash_mismatch)}"
|
| )
|
| for m in report.missing:
|
| print(f" missing: {m}")
|
| for m in report.hash_mismatch:
|
| print(f" mismatch: {m}")
|
| return 0 if report.ok else 2
|
|
|
|
|
| def cmd_restore(args: argparse.Namespace) -> int:
|
| try:
|
| snap_path = _resolve_snapshot_arg(args.snapshot, BACKUPS_DIR)
|
| except FileNotFoundError as exc:
|
| print(str(exc), file=sys.stderr)
|
| return 1
|
| try:
|
| report = restore_snapshot(snap_path, dry_run=args.dry_run)
|
| except RuntimeError as exc:
|
| print(f"ERROR: {exc}", file=sys.stderr)
|
| print(
|
| "Run `python src/backup_mirror.py verify --snapshot "
|
| f"{snap_path.name}` to diagnose.",
|
| file=sys.stderr,
|
| )
|
| return 2
|
| label = "[restore:dry-run]" if report.dry_run else "[restore]"
|
| print(f"{label} {report.snapshot_id} files={len(report.restored)} "
|
| f"skipped={len(report.skipped)}")
|
| return 0
|
|
|
|
|
| def cmd_watchdog(args: argparse.Namespace) -> int:
|
| from backup_watchdog import run_watchdog
|
| max_iters = 1 if args.once else None
|
| stats = run_watchdog(
|
| interval=args.interval,
|
| reason_prefix=args.reason_prefix,
|
| max_iterations=max_iters,
|
| )
|
| if args.json:
|
| print(json.dumps(stats.to_dict(), indent=2))
|
| return 0
|
|
|
|
|
| def cmd_prune(args: argparse.Namespace) -> int:
|
| if args.policy:
|
| plan = prune_by_policy(dry_run=args.dry_run)
|
| if args.json:
|
| payload = plan.to_dict()
|
| payload["dry_run"] = bool(args.dry_run)
|
| print(json.dumps(payload, indent=2))
|
| return 0
|
| prefix = "[prune:dry-run]" if args.dry_run else "[prune]"
|
| print(
|
| f"{prefix} kept={len(plan.keep)} removed={len(plan.delete)} "
|
| f"(latest={len(plan.protected_by_latest)} "
|
| f"daily={len(plan.protected_by_daily)})"
|
| )
|
| for r in plan.delete:
|
| print(f" {'would remove' if args.dry_run else 'removed'} {r}")
|
| return 0
|
|
|
| if args.keep is None:
|
| print("prune requires either --policy or --keep N", file=sys.stderr)
|
| return 2
|
| removed = prune_snapshots(args.keep)
|
| for r in removed:
|
| print(f"removed {r}")
|
| print(f"kept {args.keep} newest snapshot(s); removed {len(removed)}.")
|
| return 0
|
|
|
|
|
| def build_parser() -> argparse.ArgumentParser:
|
| p = argparse.ArgumentParser(description="Backup mirror for ~/.claude state.")
|
| sub = p.add_subparsers(dest="cmd", required=True)
|
|
|
| c = sub.add_parser("create", help="Take a new snapshot.")
|
| c.add_argument("--reason", default=None,
|
| help="Short label appended to snapshot folder name.")
|
| c.set_defaults(func=cmd_create)
|
|
|
| sic = sub.add_parser(
|
| "snapshot-if-changed",
|
| help="Snapshot only if any tracked file changed since the last one.",
|
| )
|
| sic.add_argument("--reason", default=None,
|
| help="Short label appended to snapshot folder name.")
|
| sic.add_argument("--json", action="store_true")
|
| sic.set_defaults(func=cmd_snapshot_if_changed)
|
|
|
| ls = sub.add_parser("list", help="List snapshots newest-first.")
|
| ls.add_argument("--json", action="store_true")
|
| ls.set_defaults(func=cmd_list)
|
|
|
| v = sub.add_parser("verify", help="Verify a snapshot against its manifest.")
|
| v.add_argument("--snapshot", default="latest",
|
| help="Snapshot ID or 'latest'.")
|
| v.add_argument("--json", action="store_true")
|
| v.set_defaults(func=cmd_verify)
|
|
|
| r = sub.add_parser("restore", help="Restore a snapshot over the live tree.")
|
| r.add_argument("--snapshot", default="latest")
|
| r.add_argument("--dry-run", action="store_true")
|
| r.set_defaults(func=cmd_restore)
|
|
|
| wd = sub.add_parser(
|
| "watchdog",
|
| help="Poll ~/.claude on an interval and snapshot on change.",
|
| )
|
| wd.add_argument("--interval", type=float, default=60.0,
|
| help="Seconds between polls (clamped to [5, 3600]).")
|
| wd.add_argument("--reason-prefix", default="watchdog",
|
| help="Prefix for the --reason label on each snapshot.")
|
| wd.add_argument("--once", action="store_true",
|
| help="Run exactly one tick and exit.")
|
| wd.add_argument("--json", action="store_true",
|
| help="Print run stats as JSON on exit.")
|
| wd.set_defaults(func=cmd_watchdog)
|
|
|
| pr = sub.add_parser(
|
| "prune",
|
| help="Delete old snapshots. Use --policy for configured retention "
|
| "(keep_latest + keep_daily) or --keep N for legacy mode.",
|
| )
|
| pr.add_argument("--keep", type=int, default=None,
|
| help="Legacy: keep only the N newest snapshots.")
|
| pr.add_argument("--policy", action="store_true",
|
| help="Apply retention policy from config.")
|
| pr.add_argument("--dry-run", action="store_true",
|
| help="Report what would be pruned; delete nothing.")
|
| pr.add_argument("--json", action="store_true",
|
| help="Emit plan as JSON. Only with --policy.")
|
| pr.set_defaults(func=cmd_prune)
|
|
|
| return p
|
|
|
|
|
| def main(argv: Sequence[str] | None = None) -> int:
|
| parser = build_parser()
|
| args = parser.parse_args(argv)
|
| return int(args.func(args))
|
|
|
|
|
|
|
| from typing import Sequence
|
|
|
|
|
| if __name__ == "__main__":
|
| sys.exit(main())
|
|
|