asuran 0.1.6

Deduplicating, encrypting, fast, and tamper evident archive format
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261

#![allow(unused_variables)]
use super::{BackupObject, BackupTarget, Listing, Node, NodeType, RestoreObject, RestoreTarget};
use crate::manifest::archive::Extent;
use crate::manifest::driver::{BackupDriver, RestoreDriver};

use async_lock::Lock;
use async_trait::async_trait;
use smol::{blocking, Task};
use walkdir::WalkDir;

use std::collections::HashMap;
use std::fs::{create_dir_all, File};
use std::path::Path;
use std::sync::Arc;

#[derive(Clone)]
/// A type that handles the complexities of dealing with a file system for you.
pub struct FileSystemTarget {
    root_directory: String,
    listing: Arc<Lock<Listing>>,
}

impl FileSystemTarget {
    /// Creates a new `FileSystemTarget` with the given path as its top level directory.
    ///
    /// The `FileSystemTarget` will consider all paths below this directory for backup.
    pub fn new(root_directory: &str) -> FileSystemTarget {
        FileSystemTarget {
            root_directory: root_directory.to_string(),
            listing: Arc::new(Lock::new(Listing::default())),
        }
    }

    pub fn set_root_directory(&mut self, new_root: &str) {
        self.root_directory = new_root.to_string();
    }
}

#[async_trait]
impl BackupTarget<File> for FileSystemTarget {
    async fn backup_paths(&self) -> Listing {
        let mut listing = Listing::default();
        for entry in WalkDir::new(&self.root_directory)
            .into_iter()
            .filter_map(Result::ok)
            .skip(1)
        {
            let rel_path = entry
                .path()
                .strip_prefix(&self.root_directory)
                .expect("Failed getting realtive path in file system target")
                .to_owned();
            let parent_path = rel_path
                .parent()
                .expect("Failed getting parent path in filesystem target");
            let metadata = {
                let path = entry.path().to_owned();

                blocking!(path.metadata().expect("Failed getting file metatdata"))
            };
            // FIXME: Making an assuming that the object is either a file or a directory
            let node_type = if metadata.is_file() {
                NodeType::File
            } else {
                NodeType::Directory {
                    children: Vec::new(),
                }
            };

            let path = rel_path
                .to_str()
                .expect("Path contained non-utf8")
                .to_string();

            let extents = if metadata.is_file() && metadata.len() > 0 {
                Some(vec![Extent {
                    start: 0,
                    end: metadata.len() - 1,
                }])
            } else {
                None
            };

            let node = Node {
                path,
                total_length: metadata.len(),
                total_size: metadata.len(),
                extents,
                node_type,
            };

            listing.add_child(parent_path.to_str().expect("Path contained non-utf8"), node);
        }
        listing
    }
    async fn backup_object(&self, node: Node) -> HashMap<String, BackupObject<File>> {
        let mut output = HashMap::new();
        // FIXME: Store directory metatdata
        if node.is_file() {
            // Get the actual path on the filesystem this referes to
            let root_path = Path::new(&self.root_directory);
            let path = root_path.join(&node.path);
            // Construct the file_object based on the information in the node
            let mut file_object = BackupObject::new(node.total_length);
            // add each extent from the node to the object
            if let Some(extents) = node.extents.as_ref() {
                for extent in extents {
                    let file = {
                        let path = path.clone();

                        blocking!(File::open(&path).expect("Unable to open file"))
                    };
                    file_object.direct_add_range(extent.start, extent.end, file);
                }
            }
            output.insert(String::new(), file_object);
        }
        let path = node.path.clone();
        let parent_path = Path::new(&path)
            .parent()
            .expect("Unable to get parent path")
            .to_str()
            .expect("Invalid utf-8 in path");
        self.listing.lock().await.add_child(parent_path, node);
        output
    }
    async fn backup_listing(&self) -> Listing {
        self.listing.lock().await.clone()
    }
}

#[async_trait]
impl RestoreTarget<File> for FileSystemTarget {
    async fn load_listing(root_path: &str, listing: Listing) -> Self {
        FileSystemTarget {
            root_directory: root_path.to_string(),
            listing: Arc::new(Lock::new(listing)),
        }
    }
    async fn restore_object(&self, node: Node) -> HashMap<String, RestoreObject<File>> {
        let mut output = HashMap::new();
        // Get the actual path on the filesystem this refers to
        let root_path = Path::new(&self.root_directory);
        let rel_path = Path::new(&node.path);
        let path = root_path.join(rel_path);
        // FIXME: currently assumes that nodes are only files or direcotires
        if node.is_directory() {
            // If the node is a directory, just create it
            let path = path.to_owned();
            Task::blocking(async move {
                create_dir_all(path).expect("Unable to create directory (restore_object)")
            })
            .await;
            output
        } else {
            // Get the parent directory, and create it if it does not exist
            let parent_path = path
                .parent()
                .expect("Unable to get parent(restore_object)")
                .to_owned();
            Task::blocking(async move {
                create_dir_all(parent_path).expect("Unable to create parent (restore_object)")
            })
            .await;
            // Check to see if we have any extents
            if let Some(extents) = node.extents.as_ref() {
                // if the extents are empty, just touch the file and leave it
                if extents.is_empty() {
                    let path = path.to_owned();
                    blocking!(File::create(path).expect("Unable to open file"));
                    output
                } else {
                    let mut file_object = RestoreObject::new(node.total_length);
                    for extent in extents {
                        file_object.direct_add_range(
                            extent.start,
                            extent.end,
                            File::create(path.clone()).expect("Unable to open file"),
                        );
                    }
                    output.insert(String::new(), file_object);
                    output
                }
            } else {
                let path = path.to_owned();
                blocking!(File::create(path).expect("Unable to open file"));

                output
            }
        }
    }
    async fn restore_listing(&self) -> Listing {
        self.listing.lock().await.clone()
    }
}

impl BackupDriver<File> for FileSystemTarget {}
impl RestoreDriver<File> for FileSystemTarget {}

#[cfg(test)]
mod tests {
    use super::*;
    use dir_diff;
    use std::fs::{create_dir, File};
    use tempfile::{tempdir, TempDir};

    fn make_test_directory() -> TempDir {
        let root = tempdir().unwrap();
        let root_path = root.path();

        create_dir(root_path.join("A")).unwrap();
        create_dir(root_path.join("B")).unwrap();
        create_dir(root_path.join("B").join("C")).unwrap();

        File::create(root_path.join("1")).unwrap();
        File::create(root_path.join("2")).unwrap();
        File::create(root_path.join("3")).unwrap();
        File::create(root_path.join("A").join("4")).unwrap();
        File::create(root_path.join("B").join("5")).unwrap();
        File::create(root_path.join("B").join("C").join("6")).unwrap();

        root
    }

    #[test]
    fn backup_restore_structure() {
        smol::run(async {
            let input_dir = make_test_directory();
            let root_path = input_dir.path().to_owned();

            let input_target = FileSystemTarget::new(&root_path.display().to_string());

            let listing = input_target.backup_paths().await;
            for node in listing {
                println!("Backing up: {}", node.path);
                input_target.backup_object(node).await;
            }

            let listing = input_target.backup_listing().await;
            println!("{:?}", listing);

            let output_dir = tempdir().unwrap();

            let output_target =
                FileSystemTarget::load_listing(&output_dir.path().display().to_string(), listing)
                    .await;

            let output_listing = output_target.restore_listing().await;
            for entry in output_listing {
                println!("Restore listing:");
                println!(" - {}", entry.path);
                output_target.restore_object(entry).await;
            }

            let _input_path = input_dir.path().display().to_string();
            let _output_path = output_dir.path().display().to_string();

            assert!(!dir_diff::is_different(&input_dir.path(), &output_dir.path()).unwrap());
        });
    }
}