chown(2) requires root on every Unix-ish kernel. Restoring 39k files as a non-root user produces 39k EPERM syscalls plus 39k matching debug log lines, all for an operation that can't possibly succeed. Skip the syscall entirely when euid != 0, and emit one warning at the end of the restore so the user knows the on-disk UID/GID will reflect the running user rather than the original owner.
909 lines
28 KiB
Go
909 lines
28 KiB
Go
package vaultik
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"crypto/sha256"
|
|
"encoding/hex"
|
|
"fmt"
|
|
"io"
|
|
"math"
|
|
"os"
|
|
"path/filepath"
|
|
"time"
|
|
|
|
"filippo.io/age"
|
|
"github.com/dustin/go-humanize"
|
|
"github.com/spf13/afero"
|
|
"sneak.berlin/go/vaultik/internal/blobgen"
|
|
"sneak.berlin/go/vaultik/internal/database"
|
|
"sneak.berlin/go/vaultik/internal/log"
|
|
"sneak.berlin/go/vaultik/internal/snapshot"
|
|
"sneak.berlin/go/vaultik/internal/types"
|
|
)
|
|
|
|
// RestoreOptions contains options for the restore operation
|
|
type RestoreOptions struct {
|
|
SnapshotID string
|
|
TargetDir string
|
|
Paths []string // Optional paths to restore (empty = all)
|
|
Verify bool // Verify restored files by checking chunk hashes
|
|
SkipErrors bool // Continue past file-restore errors instead of aborting
|
|
}
|
|
|
|
// RestoreResult contains statistics from a restore operation
|
|
type RestoreResult struct {
|
|
FilesRestored int
|
|
BytesRestored int64
|
|
BlobsDownloaded int
|
|
BytesDownloaded int64
|
|
Duration time.Duration
|
|
// Verification results (only populated if Verify option is set)
|
|
FilesVerified int
|
|
BytesVerified int64
|
|
FilesFailed int
|
|
FailedFiles []string // Paths of files that failed verification
|
|
}
|
|
|
|
// Restore restores files from a snapshot to the target directory
|
|
func (v *Vaultik) Restore(opts *RestoreOptions) error {
|
|
startTime := time.Now()
|
|
|
|
identity, err := v.prepareRestoreIdentity()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
log.Info("Starting restore operation",
|
|
"snapshot_id", opts.SnapshotID,
|
|
"target_dir", opts.TargetDir,
|
|
"paths", opts.Paths,
|
|
)
|
|
|
|
// Step 1: Download and decrypt the snapshot metadata database
|
|
log.Info("Downloading snapshot metadata...")
|
|
tempDB, err := v.downloadSnapshotDB(opts.SnapshotID, identity)
|
|
if err != nil {
|
|
return fmt.Errorf("downloading snapshot database: %w", err)
|
|
}
|
|
defer func() {
|
|
if err := tempDB.Close(); err != nil {
|
|
log.Debug("Failed to close temp database", "error", err)
|
|
}
|
|
// Clean up temp file
|
|
if err := v.Fs.Remove(tempDB.Path()); err != nil {
|
|
log.Debug("Failed to remove temp database", "error", err)
|
|
}
|
|
}()
|
|
|
|
repos := database.NewRepositories(tempDB)
|
|
|
|
// Step 2: Get list of files to restore
|
|
files, err := v.getFilesToRestore(v.ctx, repos, opts.Paths)
|
|
if err != nil {
|
|
return fmt.Errorf("getting files to restore: %w", err)
|
|
}
|
|
|
|
if len(files) == 0 {
|
|
log.Warn("No files found to restore")
|
|
v.UI.Warning("No files found to restore.")
|
|
return nil
|
|
}
|
|
|
|
log.Info("Found files to restore", "count", len(files))
|
|
v.UI.Info("Found %s files to restore.", v.UI.Count(len(files)))
|
|
|
|
// Step 3: Create target directory
|
|
if err := v.Fs.MkdirAll(opts.TargetDir, 0755); err != nil {
|
|
return fmt.Errorf("creating target directory: %w", err)
|
|
}
|
|
|
|
// Step 4: Build a map of chunks to blobs for efficient restoration
|
|
chunkToBlobMap, err := v.buildChunkToBlobMap(v.ctx, repos)
|
|
if err != nil {
|
|
return fmt.Errorf("building chunk-to-blob map: %w", err)
|
|
}
|
|
|
|
// Step 5: Restore files
|
|
result, err := v.restoreAllFiles(files, repos, opts, identity, chunkToBlobMap)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
result.Duration = time.Since(startTime)
|
|
|
|
log.Info("Restore complete",
|
|
"files_restored", result.FilesRestored,
|
|
"bytes_restored", humanize.Bytes(uint64(result.BytesRestored)),
|
|
"blobs_downloaded", result.BlobsDownloaded,
|
|
"bytes_downloaded", humanize.Bytes(uint64(result.BytesDownloaded)),
|
|
"duration", result.Duration,
|
|
)
|
|
|
|
v.UI.Complete("Restored %s files (%s) in %s.",
|
|
v.UI.Count(result.FilesRestored),
|
|
v.UI.Size(result.BytesRestored),
|
|
v.UI.Duration(result.Duration),
|
|
)
|
|
|
|
if os.Geteuid() != 0 {
|
|
v.UI.Warning("Restore did not preserve file ownership: chown(2) requires root. Re-run as root (e.g. with sudo) if you need original UID/GID preserved.")
|
|
}
|
|
|
|
if result.FilesFailed > 0 {
|
|
v.UI.Warning("%d file(s) failed to restore:", result.FilesFailed)
|
|
for _, path := range result.FailedFiles {
|
|
v.UI.Detail("%s", v.UI.Path(path))
|
|
}
|
|
}
|
|
|
|
// Run verification if requested
|
|
if opts.Verify {
|
|
if err := v.handleRestoreVerification(repos, files, opts, result); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
if result.FilesFailed > 0 {
|
|
return fmt.Errorf("%d file(s) failed to restore", result.FilesFailed)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// prepareRestoreIdentity validates that an age secret key is configured and parses it
|
|
func (v *Vaultik) prepareRestoreIdentity() (age.Identity, error) {
|
|
if v.Config.AgeSecretKey == "" {
|
|
return nil, fmt.Errorf("decryption key required for restore\n\nSet the VAULTIK_AGE_SECRET_KEY environment variable to your age private key:\n export VAULTIK_AGE_SECRET_KEY='AGE-SECRET-KEY-...'")
|
|
}
|
|
|
|
identity, err := age.ParseX25519Identity(v.Config.AgeSecretKey)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("parsing age secret key: %w", err)
|
|
}
|
|
return identity, nil
|
|
}
|
|
|
|
// restoreAllFiles processes files in blob-locality order: drain every
|
|
// file whose blob set is on disk, download the missing blobs for the
|
|
// pending file with the smallest uncached count, repeat. This keeps
|
|
// peak cache occupancy near 1 even on snapshots whose path order
|
|
// interleaves blobs, and lets the sweeper free each blob the moment
|
|
// its file set is exhausted.
|
|
func (v *Vaultik) restoreAllFiles(
|
|
files []*database.File,
|
|
repos *database.Repositories,
|
|
opts *RestoreOptions,
|
|
identity age.Identity,
|
|
chunkToBlobMap map[string]*database.BlobChunk,
|
|
) (*RestoreResult, error) {
|
|
result := &RestoreResult{}
|
|
|
|
// The restore-side blob cache is unbounded — restores may read any
|
|
// blob many times across deduplicated files and we want to avoid
|
|
// re-downloading until we can prove a blob is no longer needed.
|
|
// Cleanup is driven by the sweeper below, not by LRU.
|
|
blobCache, err := newBlobDiskCache(math.MaxInt64)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("creating blob cache: %w", err)
|
|
}
|
|
if v.restoreCacheObserver != nil {
|
|
v.restoreCacheObserver(blobCache)
|
|
}
|
|
defer func() {
|
|
if v.restoreCacheObserver != nil {
|
|
v.restoreCacheObserver(blobCache)
|
|
}
|
|
_ = blobCache.Close()
|
|
}()
|
|
|
|
// Per-restore sweep state: every blob_size_limit/100 bytes written,
|
|
// scan the cache and delete any blob whose remaining file references
|
|
// are all already restored.
|
|
sweeper := newRestoreSweeper(v.ctx, repos, blobCache, v.Config.BlobSizeLimit.Int64()/100)
|
|
|
|
// Pre-fetch every blob row once so chunk extraction can map a
|
|
// blob_id to its hash without a DB round-trip per chunk.
|
|
blobsByID, err := repos.Blobs.GetAll(v.ctx)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("fetching blob index: %w", err)
|
|
}
|
|
blobIDToHash := make(map[string]string, len(blobsByID))
|
|
blobByHash := make(map[string]*database.Blob, len(blobsByID))
|
|
for id, blob := range blobsByID {
|
|
hash := blob.Hash.String()
|
|
blobIDToHash[id] = hash
|
|
blobByHash[hash] = blob
|
|
}
|
|
|
|
plan, err := newRestorePlan(v.ctx, repos, files, chunkToBlobMap, blobIDToHash)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("building restore plan: %w", err)
|
|
}
|
|
|
|
// Index files by ID so the loop can look them up by the IDs the
|
|
// plan hands back.
|
|
filesByID := make(map[types.FileID]*database.File, len(files))
|
|
for _, f := range files {
|
|
filesByID[f.ID] = f
|
|
}
|
|
|
|
// Calculate total bytes expected for percentage / ETA arithmetic.
|
|
var totalBytesExpected int64
|
|
for _, file := range files {
|
|
totalBytesExpected += file.Size
|
|
}
|
|
|
|
v.UI.Begin("Restoring %s files (%s) to %s.",
|
|
v.UI.Count(len(files)),
|
|
v.UI.Size(totalBytesExpected),
|
|
v.UI.Path(opts.TargetDir))
|
|
|
|
session := &restoreSession{
|
|
v: v,
|
|
ctx: v.ctx,
|
|
repos: repos,
|
|
opts: opts,
|
|
identity: identity,
|
|
chunkToBlobMap: chunkToBlobMap,
|
|
blobByHash: blobByHash,
|
|
blobIDToHash: blobIDToHash,
|
|
blobCache: blobCache,
|
|
sweeper: sweeper,
|
|
result: result,
|
|
runningAsRoot: os.Geteuid() == 0,
|
|
}
|
|
|
|
// Periodic progress output, matching the snapshot create cadence.
|
|
startTime := time.Now()
|
|
lastStatusTime := startTime
|
|
const statusInterval = 15 * time.Second
|
|
|
|
processed := 0
|
|
for plan.hasPending() {
|
|
if v.ctx.Err() != nil {
|
|
return nil, v.ctx.Err()
|
|
}
|
|
|
|
fileID, ready := plan.popReady()
|
|
if !ready {
|
|
// No file is fully cache-served. First free any blobs
|
|
// whose file sets are exhausted — without this, the
|
|
// blob whose last file we just finished would still be
|
|
// cached when we Put the next one, briefly pushing
|
|
// peak occupancy from 1 to 2.
|
|
sweeper.sweep()
|
|
|
|
// Pick the pending file with the smallest uncached
|
|
// blob set and download its blobs. After each blob
|
|
// lands, the plan moves any pending file whose set
|
|
// just emptied onto the ready queue.
|
|
next := plan.pickNextDownload()
|
|
if next.IsZero() {
|
|
break
|
|
}
|
|
for _, hash := range plan.blobsNeeded(next) {
|
|
blob, ok := blobByHash[hash]
|
|
if !ok {
|
|
return nil, fmt.Errorf("blob hash %s missing from blob index", hash[:16])
|
|
}
|
|
if err := session.downloadBlobToCache(hash, blob.CompressedSize); err != nil {
|
|
return nil, fmt.Errorf("downloading blob %s: %w", hash[:16], err)
|
|
}
|
|
result.BlobsDownloaded++
|
|
result.BytesDownloaded += blob.CompressedSize
|
|
plan.markBlobCached(hash)
|
|
}
|
|
continue
|
|
}
|
|
|
|
file := filesByID[fileID]
|
|
if err := session.restoreFile(file); err != nil {
|
|
log.Error("Failed to restore file", "path", file.Path, "error", err)
|
|
if !opts.SkipErrors {
|
|
return nil, fmt.Errorf("restoring %s: %w (pass --skip-errors to continue past restore failures)", file.Path, err)
|
|
}
|
|
v.UI.Error("Failed to restore %s: %v. Skipping (--skip-errors).", v.UI.Path(file.Path.String()), err)
|
|
result.FilesFailed++
|
|
result.FailedFiles = append(result.FailedFiles, file.Path.String())
|
|
plan.finishFile(fileID)
|
|
continue
|
|
}
|
|
|
|
// Record the file as restored so the sweeper can free blobs
|
|
// once all referencing files are done, and drop it from the
|
|
// plan's indexes so future picks ignore it.
|
|
sweeper.fileRestored(fileID.String())
|
|
plan.finishFile(fileID)
|
|
processed++
|
|
|
|
if time.Since(lastStatusTime) >= statusInterval {
|
|
v.printRestoreProgress(processed, len(files), result.BytesRestored, totalBytesExpected, startTime)
|
|
lastStatusTime = time.Now()
|
|
}
|
|
|
|
// Structured progress log for --verbose / JSON consumers.
|
|
if processed%100 == 0 || processed == len(files) {
|
|
log.Info("Restore progress",
|
|
"files", fmt.Sprintf("%d/%d", processed, len(files)),
|
|
"bytes", humanize.Bytes(uint64(result.BytesRestored)),
|
|
)
|
|
}
|
|
}
|
|
|
|
return result, nil
|
|
}
|
|
|
|
// printRestoreProgress emits a periodic restore-phase status line via
|
|
// the UI writer, mirroring scanner.printProcessingProgress so the two
|
|
// long-running commands have the same on-screen rhythm.
|
|
func (v *Vaultik) printRestoreProgress(filesDone, totalFiles int, bytesDone, totalBytes int64, startTime time.Time) {
|
|
elapsed := time.Since(startTime)
|
|
pct := float64(bytesDone) / float64(totalBytes) * 100
|
|
byteRate := float64(bytesDone) / elapsed.Seconds()
|
|
fileRate := float64(filesDone) / elapsed.Seconds()
|
|
|
|
remainingBytes := totalBytes - bytesDone
|
|
var eta time.Duration
|
|
if byteRate > 0 && remainingBytes > 0 {
|
|
eta = time.Duration(float64(remainingBytes)/byteRate) * time.Second
|
|
}
|
|
|
|
if eta > 0 {
|
|
v.UI.Progress("Restore: %s/%s files (%s), %s/%s, %s, %.0f files/sec, restore elapsed: %s, restore ETA: %s (est remain %s).",
|
|
v.UI.Count(filesDone),
|
|
v.UI.Count(totalFiles),
|
|
v.UI.Percent(pct),
|
|
v.UI.Size(bytesDone),
|
|
v.UI.Size(totalBytes),
|
|
v.UI.Speed(byteRate),
|
|
fileRate,
|
|
v.UI.Duration(elapsed),
|
|
v.UI.Time(time.Now().Add(eta)),
|
|
v.UI.Duration(eta))
|
|
return
|
|
}
|
|
v.UI.Progress("Restore: %s/%s files (%s), %s/%s, %s, %.0f files/sec, restore elapsed: %s.",
|
|
v.UI.Count(filesDone),
|
|
v.UI.Count(totalFiles),
|
|
v.UI.Percent(pct),
|
|
v.UI.Size(bytesDone),
|
|
v.UI.Size(totalBytes),
|
|
v.UI.Speed(byteRate),
|
|
fileRate,
|
|
v.UI.Duration(elapsed))
|
|
}
|
|
|
|
// handleRestoreVerification runs post-restore verification if requested
|
|
func (v *Vaultik) handleRestoreVerification(
|
|
repos *database.Repositories,
|
|
files []*database.File,
|
|
opts *RestoreOptions,
|
|
result *RestoreResult,
|
|
) error {
|
|
if err := v.verifyRestoredFiles(v.ctx, repos, files, opts.TargetDir, result); err != nil {
|
|
return fmt.Errorf("verification failed: %w", err)
|
|
}
|
|
|
|
if result.FilesFailed > 0 {
|
|
v.UI.Error("Verification failed: %s files did not match expected checksums.",
|
|
v.UI.Count(result.FilesFailed))
|
|
for _, path := range result.FailedFiles {
|
|
v.UI.Detail("%s", v.UI.Path(path))
|
|
}
|
|
return fmt.Errorf("%d files failed verification", result.FilesFailed)
|
|
}
|
|
|
|
v.UI.Complete("Verified %s files (%s).",
|
|
v.UI.Count(result.FilesVerified),
|
|
v.UI.Size(result.BytesVerified))
|
|
return nil
|
|
}
|
|
|
|
// downloadSnapshotDB downloads and decrypts the snapshot metadata
|
|
// database. The snapshotID is the human ID; we hash it to the remote
|
|
// key for the storage path.
|
|
func (v *Vaultik) downloadSnapshotDB(snapshotID string, identity age.Identity) (*database.DB, error) {
|
|
// Download encrypted database from storage
|
|
dbKey := fmt.Sprintf("metadata/%s/db.zst.age", snapshot.RemoteSnapshotKey(snapshotID))
|
|
|
|
reader, err := v.Storage.Get(v.ctx, dbKey)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("downloading %s: %w", dbKey, err)
|
|
}
|
|
defer func() { _ = reader.Close() }()
|
|
|
|
// Read all data
|
|
encryptedData, err := io.ReadAll(reader)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("reading encrypted data: %w", err)
|
|
}
|
|
log.Debug("Downloaded encrypted database", "size", humanize.Bytes(uint64(len(encryptedData))))
|
|
|
|
// Decrypt and decompress using blobgen.Reader
|
|
blobReader, err := blobgen.NewReader(bytes.NewReader(encryptedData), identity)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("creating decryption reader: %w", err)
|
|
}
|
|
defer func() { _ = blobReader.Close() }()
|
|
|
|
// Read the binary SQLite database
|
|
dbData, err := io.ReadAll(blobReader)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("decrypting and decompressing: %w", err)
|
|
}
|
|
log.Debug("Decrypted database", "size", humanize.Bytes(uint64(len(dbData))))
|
|
|
|
// Create a temporary database file and write the binary SQLite data directly
|
|
tempFile, err := afero.TempFile(v.Fs, "", "vaultik-restore-*.db")
|
|
if err != nil {
|
|
return nil, fmt.Errorf("creating temp file: %w", err)
|
|
}
|
|
tempPath := tempFile.Name()
|
|
|
|
// Write the binary SQLite database directly
|
|
if _, err := tempFile.Write(dbData); err != nil {
|
|
_ = tempFile.Close()
|
|
_ = v.Fs.Remove(tempPath)
|
|
return nil, fmt.Errorf("writing database file: %w", err)
|
|
}
|
|
if err := tempFile.Close(); err != nil {
|
|
_ = v.Fs.Remove(tempPath)
|
|
return nil, fmt.Errorf("closing temp file: %w", err)
|
|
}
|
|
log.Debug("Created restore database", "path", tempPath)
|
|
|
|
// Open the database
|
|
db, err := database.New(v.ctx, tempPath)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("opening restore database: %w", err)
|
|
}
|
|
|
|
return db, nil
|
|
}
|
|
|
|
// getFilesToRestore returns the list of files to restore based on path filters
|
|
func (v *Vaultik) getFilesToRestore(ctx context.Context, repos *database.Repositories, pathFilters []string) ([]*database.File, error) {
|
|
// If no filters, get all files
|
|
if len(pathFilters) == 0 {
|
|
return repos.Files.ListAll(ctx)
|
|
}
|
|
|
|
// Get files matching the path filters
|
|
var result []*database.File
|
|
seen := make(map[string]bool)
|
|
|
|
for _, filter := range pathFilters {
|
|
// Normalize the filter path
|
|
filter = filepath.Clean(filter)
|
|
|
|
// Get files with this prefix
|
|
files, err := repos.Files.ListByPrefix(ctx, filter)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("listing files with prefix %s: %w", filter, err)
|
|
}
|
|
|
|
for _, file := range files {
|
|
if !seen[file.ID.String()] {
|
|
seen[file.ID.String()] = true
|
|
result = append(result, file)
|
|
}
|
|
}
|
|
}
|
|
|
|
return result, nil
|
|
}
|
|
|
|
// buildChunkToBlobMap creates a mapping from chunk hash to blob information
|
|
func (v *Vaultik) buildChunkToBlobMap(ctx context.Context, repos *database.Repositories) (map[string]*database.BlobChunk, error) {
|
|
// Query all blob_chunks
|
|
query := `SELECT blob_id, chunk_hash, offset, length FROM blob_chunks`
|
|
rows, err := repos.DB().Conn().QueryContext(ctx, query)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("querying blob_chunks: %w", err)
|
|
}
|
|
defer func() { _ = rows.Close() }()
|
|
|
|
result := make(map[string]*database.BlobChunk)
|
|
for rows.Next() {
|
|
var bc database.BlobChunk
|
|
var blobIDStr, chunkHashStr string
|
|
if err := rows.Scan(&blobIDStr, &chunkHashStr, &bc.Offset, &bc.Length); err != nil {
|
|
return nil, fmt.Errorf("scanning blob_chunk: %w", err)
|
|
}
|
|
blobID, err := types.ParseBlobID(blobIDStr)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("parsing blob ID: %w", err)
|
|
}
|
|
bc.BlobID = blobID
|
|
bc.ChunkHash = types.ChunkHash(chunkHashStr)
|
|
result[chunkHashStr] = &bc
|
|
}
|
|
|
|
return result, rows.Err()
|
|
}
|
|
|
|
// restoreSession holds every piece of per-restore state shared by the
|
|
// restore-time methods. Each restore builds one of these from the
|
|
// snapshot's metadata and then drives the file loop through methods on
|
|
// it. Keeping this state on the struct rather than threading it
|
|
// through every function signature keeps the inner-loop call sites
|
|
// readable: restoreFile(file) instead of a ten-argument helper.
|
|
type restoreSession struct {
|
|
v *Vaultik
|
|
ctx context.Context
|
|
repos *database.Repositories
|
|
opts *RestoreOptions
|
|
identity age.Identity
|
|
chunkToBlobMap map[string]*database.BlobChunk
|
|
blobByHash map[string]*database.Blob
|
|
blobIDToHash map[string]string
|
|
blobCache *blobDiskCache
|
|
sweeper *restoreSweeper
|
|
result *RestoreResult
|
|
// runningAsRoot gates chown(2). On every Unix-ish kernel, only
|
|
// root can chown a file to an arbitrary UID/GID — non-root chown
|
|
// always fails with EPERM. Attempting it anyway produces N
|
|
// guaranteed-failed syscalls + N noisy debug lines, so we skip
|
|
// the call entirely as non-root and emit one warning at the end
|
|
// of the restore explaining that ownership was not preserved.
|
|
runningAsRoot bool
|
|
}
|
|
|
|
// restoreFile dispatches to the right per-kind restorer.
|
|
func (s *restoreSession) restoreFile(file *database.File) error {
|
|
targetPath := filepath.Join(s.opts.TargetDir, file.Path.String())
|
|
parentDir := filepath.Dir(targetPath)
|
|
if err := s.v.Fs.MkdirAll(parentDir, 0755); err != nil {
|
|
return fmt.Errorf("creating parent directory: %w", err)
|
|
}
|
|
if file.IsSymlink() {
|
|
return s.restoreSymlink(file, targetPath)
|
|
}
|
|
if file.Mode&uint32(os.ModeDir) != 0 {
|
|
return s.restoreDirectory(file, targetPath)
|
|
}
|
|
return s.restoreRegularFile(file, targetPath)
|
|
}
|
|
|
|
// restoreSymlink restores a symbolic link.
|
|
func (s *restoreSession) restoreSymlink(file *database.File, targetPath string) error {
|
|
_ = s.v.Fs.Remove(targetPath)
|
|
// afero.MemMapFs doesn't support symlinks, so route real-FS
|
|
// symlinks through os.
|
|
if _, ok := s.v.Fs.(*afero.OsFs); ok {
|
|
if err := os.Symlink(file.LinkTarget.String(), targetPath); err != nil {
|
|
return fmt.Errorf("creating symlink: %w", err)
|
|
}
|
|
} else {
|
|
log.Debug("Symlink creation not supported on this filesystem", "path", file.Path, "target", file.LinkTarget)
|
|
}
|
|
s.result.FilesRestored++
|
|
log.Debug("Restored symlink", "path", file.Path, "target", file.LinkTarget)
|
|
return nil
|
|
}
|
|
|
|
// restoreDirectory restores a directory with its permissions, mtime,
|
|
// and (on real filesystems, with sufficient privileges) ownership.
|
|
func (s *restoreSession) restoreDirectory(file *database.File, targetPath string) error {
|
|
if err := s.v.Fs.MkdirAll(targetPath, os.FileMode(file.Mode)); err != nil {
|
|
return fmt.Errorf("creating directory: %w", err)
|
|
}
|
|
if err := s.v.Fs.Chmod(targetPath, os.FileMode(file.Mode)); err != nil {
|
|
log.Debug("Failed to set directory permissions", "path", targetPath, "error", err)
|
|
}
|
|
if s.runningAsRoot {
|
|
if _, ok := s.v.Fs.(*afero.OsFs); ok {
|
|
if err := os.Chown(targetPath, int(file.UID), int(file.GID)); err != nil {
|
|
log.Debug("Failed to set directory ownership", "path", targetPath, "error", err)
|
|
}
|
|
}
|
|
}
|
|
if err := s.v.Fs.Chtimes(targetPath, file.MTime, file.MTime); err != nil {
|
|
log.Debug("Failed to set directory mtime", "path", targetPath, "error", err)
|
|
}
|
|
s.result.FilesRestored++
|
|
return nil
|
|
}
|
|
|
|
// restoreRegularFile reconstructs a regular file by reading chunks
|
|
// directly out of cached blobs via ReadAt. The expectation when this
|
|
// method runs is that every blob this file needs is already in the
|
|
// disk cache — the planner guarantees that by only marking files
|
|
// "ready" once their full blob set is on disk.
|
|
func (s *restoreSession) restoreRegularFile(file *database.File, targetPath string) error {
|
|
fileStart := time.Now()
|
|
|
|
t0 := time.Now()
|
|
fileChunks, err := s.repos.FileChunks.GetByFileID(s.ctx, file.ID)
|
|
fileChunksQueryDur := time.Since(t0)
|
|
if err != nil {
|
|
return fmt.Errorf("getting file chunks: %w", err)
|
|
}
|
|
|
|
t0 = time.Now()
|
|
outFile, err := s.v.Fs.Create(targetPath)
|
|
createDur := time.Since(t0)
|
|
if err != nil {
|
|
return fmt.Errorf("creating output file: %w", err)
|
|
}
|
|
defer func() { _ = outFile.Close() }()
|
|
|
|
var (
|
|
readAtDur time.Duration
|
|
writeDur time.Duration
|
|
sweeperDur time.Duration
|
|
bytesWritten int64
|
|
)
|
|
|
|
for _, fc := range fileChunks {
|
|
chunkHashStr := fc.ChunkHash.String()
|
|
blobChunk, ok := s.chunkToBlobMap[chunkHashStr]
|
|
if !ok {
|
|
return fmt.Errorf("chunk %s not found in any blob", chunkHashStr[:16])
|
|
}
|
|
blobHash, ok := s.blobIDToHash[blobChunk.BlobID.String()]
|
|
if !ok {
|
|
return fmt.Errorf("blob id %s missing from hash index", blobChunk.BlobID)
|
|
}
|
|
|
|
t0 = time.Now()
|
|
chunkData, err := s.blobCache.ReadAt(blobHash, blobChunk.Offset, blobChunk.Length)
|
|
readAtDur += time.Since(t0)
|
|
if err != nil {
|
|
return fmt.Errorf("reading chunk %s from cached blob %s: %w", fc.ChunkHash[:16], blobHash[:16], err)
|
|
}
|
|
|
|
t0 = time.Now()
|
|
n, err := outFile.Write(chunkData)
|
|
writeDur += time.Since(t0)
|
|
if err != nil {
|
|
return fmt.Errorf("writing chunk: %w", err)
|
|
}
|
|
bytesWritten += int64(n)
|
|
|
|
t0 = time.Now()
|
|
s.sweeper.chunkRestored(int64(n))
|
|
sweeperDur += time.Since(t0)
|
|
}
|
|
|
|
log.Debug("Restored regular file (timings)",
|
|
"path", file.Path,
|
|
"chunks", len(fileChunks),
|
|
"bytes_written", bytesWritten,
|
|
"ms_total", time.Since(fileStart).Milliseconds(),
|
|
"ms_file_chunks_query", fileChunksQueryDur.Milliseconds(),
|
|
"ms_create", createDur.Milliseconds(),
|
|
"ms_readat", readAtDur.Milliseconds(),
|
|
"ms_writes", writeDur.Milliseconds(),
|
|
"ms_sweeper", sweeperDur.Milliseconds(),
|
|
)
|
|
|
|
if err := outFile.Close(); err != nil {
|
|
return fmt.Errorf("closing output file: %w", err)
|
|
}
|
|
if err := s.v.Fs.Chmod(targetPath, os.FileMode(file.Mode)); err != nil {
|
|
log.Debug("Failed to set file permissions", "path", targetPath, "error", err)
|
|
}
|
|
if s.runningAsRoot {
|
|
if _, ok := s.v.Fs.(*afero.OsFs); ok {
|
|
if err := os.Chown(targetPath, int(file.UID), int(file.GID)); err != nil {
|
|
log.Debug("Failed to set file ownership", "path", targetPath, "error", err)
|
|
}
|
|
}
|
|
}
|
|
if err := s.v.Fs.Chtimes(targetPath, file.MTime, file.MTime); err != nil {
|
|
log.Debug("Failed to set file mtime", "path", targetPath, "error", err)
|
|
}
|
|
|
|
s.result.FilesRestored++
|
|
s.result.BytesRestored += bytesWritten
|
|
|
|
log.Debug("Restored file", "path", file.Path, "size", humanize.Bytes(uint64(bytesWritten)))
|
|
return nil
|
|
}
|
|
|
|
// downloadBlobToCache streams a blob from remote storage straight into
|
|
// the disk cache, decrypting and decompressing on the fly. The
|
|
// plaintext never lives fully in memory — io.Copy through
|
|
// blobDiskCache.PutFromReader uses a 32 KiB buffer regardless of blob
|
|
// size, which is what makes multi-GB blobs tractable on machines with
|
|
// less RAM than the blob.
|
|
func (s *restoreSession) downloadBlobToCache(blobHash string, expectedSize int64) error {
|
|
start := time.Now()
|
|
|
|
t0 := time.Now()
|
|
rc, err := s.v.FetchAndDecryptBlob(s.ctx, blobHash, expectedSize, s.identity)
|
|
fetchSetupDur := time.Since(t0)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
t0 = time.Now()
|
|
written, copyErr := s.blobCache.PutFromReader(blobHash, rc)
|
|
streamDur := time.Since(t0)
|
|
closeErr := rc.Close()
|
|
if copyErr != nil {
|
|
return copyErr
|
|
}
|
|
if closeErr != nil {
|
|
return closeErr
|
|
}
|
|
|
|
log.Debug("Streamed blob into disk cache",
|
|
"hash", blobHash[:16],
|
|
"compressed_bytes", expectedSize,
|
|
"plaintext_bytes", written,
|
|
"ms_total", time.Since(start).Milliseconds(),
|
|
"ms_fetch_setup", fetchSetupDur.Milliseconds(),
|
|
"ms_stream_decrypt_decompress", streamDur.Milliseconds(),
|
|
)
|
|
return nil
|
|
}
|
|
|
|
// verifyRestoredFiles verifies that all restored files match their expected chunk hashes
|
|
func (v *Vaultik) verifyRestoredFiles(
|
|
ctx context.Context,
|
|
repos *database.Repositories,
|
|
files []*database.File,
|
|
targetDir string,
|
|
result *RestoreResult,
|
|
) error {
|
|
// Calculate total bytes to verify for progress bar
|
|
var totalBytes int64
|
|
regularFiles := make([]*database.File, 0, len(files))
|
|
for _, file := range files {
|
|
// Skip symlinks and directories - only verify regular files
|
|
if file.IsSymlink() || file.Mode&uint32(os.ModeDir) != 0 {
|
|
continue
|
|
}
|
|
regularFiles = append(regularFiles, file)
|
|
totalBytes += file.Size
|
|
}
|
|
|
|
if len(regularFiles) == 0 {
|
|
log.Info("No regular files to verify")
|
|
return nil
|
|
}
|
|
|
|
log.Info("Verifying restored files",
|
|
"files", len(regularFiles),
|
|
"bytes", humanize.Bytes(uint64(totalBytes)),
|
|
)
|
|
v.UI.Begin("Verifying %s files (%s).",
|
|
v.UI.Count(len(regularFiles)),
|
|
v.UI.Size(totalBytes))
|
|
|
|
startTime := time.Now()
|
|
lastStatusTime := startTime
|
|
const statusInterval = 15 * time.Second
|
|
|
|
var bytesProcessed int64
|
|
for i, file := range regularFiles {
|
|
if ctx.Err() != nil {
|
|
return ctx.Err()
|
|
}
|
|
|
|
targetPath := filepath.Join(targetDir, file.Path.String())
|
|
bytesVerified, err := v.verifyFile(ctx, repos, file, targetPath)
|
|
if err != nil {
|
|
log.Error("File verification failed", "path", file.Path, "error", err)
|
|
result.FilesFailed++
|
|
result.FailedFiles = append(result.FailedFiles, file.Path.String())
|
|
} else {
|
|
result.FilesVerified++
|
|
result.BytesVerified += bytesVerified
|
|
}
|
|
bytesProcessed += file.Size
|
|
|
|
if time.Since(lastStatusTime) >= statusInterval {
|
|
v.printVerifyProgress(i+1, len(regularFiles), bytesProcessed, totalBytes, startTime)
|
|
lastStatusTime = time.Now()
|
|
}
|
|
}
|
|
|
|
log.Info("Verification complete",
|
|
"files_verified", result.FilesVerified,
|
|
"bytes_verified", humanize.Bytes(uint64(result.BytesVerified)),
|
|
"files_failed", result.FilesFailed,
|
|
)
|
|
|
|
return nil
|
|
}
|
|
|
|
// printVerifyProgress emits a periodic verify-phase status line. Same
|
|
// shape as the restore progress line so user-facing pacing is uniform
|
|
// across the two phases.
|
|
func (v *Vaultik) printVerifyProgress(filesDone, totalFiles int, bytesDone, totalBytes int64, startTime time.Time) {
|
|
elapsed := time.Since(startTime)
|
|
pct := float64(bytesDone) / float64(totalBytes) * 100
|
|
byteRate := float64(bytesDone) / elapsed.Seconds()
|
|
fileRate := float64(filesDone) / elapsed.Seconds()
|
|
|
|
remainingBytes := totalBytes - bytesDone
|
|
var eta time.Duration
|
|
if byteRate > 0 && remainingBytes > 0 {
|
|
eta = time.Duration(float64(remainingBytes)/byteRate) * time.Second
|
|
}
|
|
|
|
if eta > 0 {
|
|
v.UI.Progress("Verify: %s/%s files (%s), %s/%s, %s, %.0f files/sec, verify elapsed: %s, verify ETA: %s (est remain %s).",
|
|
v.UI.Count(filesDone),
|
|
v.UI.Count(totalFiles),
|
|
v.UI.Percent(pct),
|
|
v.UI.Size(bytesDone),
|
|
v.UI.Size(totalBytes),
|
|
v.UI.Speed(byteRate),
|
|
fileRate,
|
|
v.UI.Duration(elapsed),
|
|
v.UI.Time(time.Now().Add(eta)),
|
|
v.UI.Duration(eta))
|
|
return
|
|
}
|
|
v.UI.Progress("Verify: %s/%s files (%s), %s/%s, %s, %.0f files/sec, verify elapsed: %s.",
|
|
v.UI.Count(filesDone),
|
|
v.UI.Count(totalFiles),
|
|
v.UI.Percent(pct),
|
|
v.UI.Size(bytesDone),
|
|
v.UI.Size(totalBytes),
|
|
v.UI.Speed(byteRate),
|
|
fileRate,
|
|
v.UI.Duration(elapsed))
|
|
}
|
|
|
|
// verifyFile verifies a single restored file by checking its chunk hashes
|
|
func (v *Vaultik) verifyFile(
|
|
ctx context.Context,
|
|
repos *database.Repositories,
|
|
file *database.File,
|
|
targetPath string,
|
|
) (int64, error) {
|
|
// Get file chunks in order
|
|
fileChunks, err := repos.FileChunks.GetByFileID(ctx, file.ID)
|
|
if err != nil {
|
|
return 0, fmt.Errorf("getting file chunks: %w", err)
|
|
}
|
|
|
|
// Open the restored file
|
|
f, err := v.Fs.Open(targetPath)
|
|
if err != nil {
|
|
return 0, fmt.Errorf("opening file: %w", err)
|
|
}
|
|
defer func() { _ = f.Close() }()
|
|
|
|
// Verify each chunk
|
|
var bytesVerified int64
|
|
for _, fc := range fileChunks {
|
|
// Get chunk size from database
|
|
chunk, err := repos.Chunks.GetByHash(ctx, fc.ChunkHash.String())
|
|
if err != nil {
|
|
return bytesVerified, fmt.Errorf("getting chunk %s: %w", fc.ChunkHash.String()[:16], err)
|
|
}
|
|
|
|
// Read chunk data from file
|
|
chunkData := make([]byte, chunk.Size)
|
|
n, err := io.ReadFull(f, chunkData)
|
|
if err != nil {
|
|
return bytesVerified, fmt.Errorf("reading chunk data: %w", err)
|
|
}
|
|
if int64(n) != chunk.Size {
|
|
return bytesVerified, fmt.Errorf("short read: expected %d bytes, got %d", chunk.Size, n)
|
|
}
|
|
|
|
// Calculate hash and compare
|
|
hash := sha256.Sum256(chunkData)
|
|
actualHash := hex.EncodeToString(hash[:])
|
|
expectedHash := fc.ChunkHash.String()
|
|
|
|
if actualHash != expectedHash {
|
|
return bytesVerified, fmt.Errorf("chunk %d hash mismatch: expected %s, got %s",
|
|
fc.Idx, expectedHash[:16], actualHash[:16])
|
|
}
|
|
|
|
bytesVerified += int64(n)
|
|
}
|
|
|
|
log.Debug("File verified", "path", file.Path, "bytes", bytesVerified, "chunks", len(fileChunks))
|
|
return bytesVerified, nil
|
|
}
|