rustic_core 0.11.0

rustic_core - library for fast, encrypted, deduplicated backups that powers rustic-rs
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

use std::path::PathBuf;

use derive_setters::Setters;
use serde::{Deserialize, Serialize};

use crate::{
    ErrorKind, IndexedFull, Open, Repository, RusticError, RusticResult, StringList,
    blob::tree::{
        modify::ModifierChange,
        rewrite::{RewriteTreesOptions, Rewriter},
    },
    repofile::{SnapshotFile, SnapshotModification},
};

/// Options for rewrite
#[cfg_attr(feature = "clap", derive(clap::Parser))]
#[cfg_attr(feature = "merge", derive(conflate::Merge))]
#[derive(Clone, Debug, Default, Setters, Serialize, Deserialize)]
#[serde(default, rename_all = "kebab-case", deny_unknown_fields)]
#[setters(into)]
#[non_exhaustive]
pub struct RewriteOptions {
    /// remove original snapshots
    #[cfg_attr(feature = "clap", clap(long))]
    #[cfg_attr(feature = "merge", merge(strategy = conflate::bool::overwrite_false))]
    pub forget: bool,

    /// Tags to add to rewritten snapshots [default: "rewrite" if original snapshots are not removed]
    #[cfg_attr(feature = "clap", clap(long, value_name = "TAG[,TAG,..]"))]
    #[cfg_attr(feature = "merge", merge(strategy = conflate::option::overwrite_none))]
    pub tags_rewritten: Option<StringList>,

    /// Snapshot modifications
    #[cfg_attr(feature = "clap", clap(flatten))]
    pub modification: SnapshotModification,

    /// Dry-run: Don't save any modification
    #[cfg_attr(feature = "clap", clap(long))]
    #[cfg_attr(feature = "merge", merge(strategy = conflate::bool::overwrite_false))]
    pub dry_run: bool,
}

pub(crate) fn rewrite_snapshots_and_trees<S: IndexedFull>(
    repo: &Repository<S>,
    snapshots: Vec<SnapshotFile>,
    opts: &RewriteOptions,
    tree_opts: &RewriteTreesOptions,
) -> RusticResult<Vec<SnapshotFile>> {
    let config_file = repo.config();
    if opts.forget && config_file.append_only == Some(true) {
        return Err(RusticError::new(
            ErrorKind::AppendOnly,
            "Removing snapshots is not allowed in append-only repositories. Please disable append-only mode first, if you know what you are doing. Aborting.",
        ));
    }
    let mut rewriter = Rewriter::new(
        repo.dbe(),
        repo.index(),
        repo.config(),
        tree_opts,
        opts.dry_run,
    )?;

    let snapshots: Vec<_> = snapshots
        .into_iter()
        .map(|mut sn| {
            #[allow(clippy::useless_let_if_seq)] // false positive lint
            let mut changed = sn.modify(&opts.modification)?;

            if let ModifierChange::Changed(new_tree) =
                rewriter.rewrite_tree(PathBuf::new(), sn.tree)?
            {
                sn.tree = new_tree;
                changed = true;
            }

            if let Some(summary) = rewriter.summary(&sn.tree) {
                let mut snap_summary = sn.summary.clone().unwrap_or_default();
                snap_summary.total_files_processed = summary.files;
                snap_summary.total_bytes_processed = summary.size;
                snap_summary.total_dirs_processed = summary.dirs;
                changed |= sn.summary.is_none_or(|sum| sum != snap_summary);
                sn.summary = Some(snap_summary);
            }

            Ok(changed.then_some(sn))
        })
        .filter_map(Result::transpose)
        .collect::<RusticResult<_>>()?;

    rewriter.finalize()?;

    process_snapshots(repo, snapshots, opts)
}

pub(crate) fn rewrite_snapshots<S: Open>(
    repo: &Repository<S>,
    snapshots: Vec<SnapshotFile>,
    opts: &RewriteOptions,
) -> RusticResult<Vec<SnapshotFile>> {
    let config_file = repo.config();
    if opts.forget && config_file.append_only == Some(true) {
        return Err(RusticError::new(
            ErrorKind::AppendOnly,
            "Removing snapshots is not allowed in append-only repositories. Please disable append-only mode first, if you know what you are doing. Aborting.",
        ));
    }
    let snapshots: Vec<_> = snapshots
        .into_iter()
        .map(|mut sn| Ok(sn.modify(&opts.modification)?.then_some(sn)))
        .filter_map(Result::transpose)
        .collect::<RusticResult<_>>()?;

    process_snapshots(repo, snapshots, opts)
}

fn process_snapshots<S: Open>(
    repo: &Repository<S>,
    mut snapshots: Vec<SnapshotFile>,
    opts: &RewriteOptions,
) -> RusticResult<Vec<SnapshotFile>> {
    if !snapshots.is_empty() && !opts.dry_run {
        match (&opts.tags_rewritten, opts.forget) {
            (Some(tags), _) => snapshots
                .iter_mut()
                .for_each(|sn| _ = sn.add_tags(vec![tags.clone()])),
            (None, false) => snapshots
                .iter_mut()
                .for_each(|sn| sn.tags.add("rewrite".to_string())),
            (None, true) => {}
        }

        repo.save_snapshots(snapshots.clone())?;
        if opts.forget {
            let old_snap_ids: Vec<_> = snapshots.iter().map(|sn| sn.id).collect();
            repo.delete_snapshots(&old_snap_ids)?;
        }
    }

    Ok(snapshots)
}