archival 0.14.0

The simplest CMS in existence
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

use std::{
    error::Error,
    io::{Cursor, Read, Seek},
    path::{Path, PathBuf},
};
#[cfg(feature = "verbose-logging")]
use tracing::debug;

pub trait FileSystemAPI: Send + Sync + Default {
    fn root_dir(&self) -> &Path;
    fn exists(&self, path: impl AsRef<Path>) -> Result<bool, Box<dyn Error>>;
    fn is_dir(&self, path: impl AsRef<Path>) -> Result<bool, Box<dyn Error>>;
    fn remove_dir_all(&mut self, path: impl AsRef<Path>) -> Result<(), Box<dyn Error>>;
    fn create_dir_all(&mut self, path: impl AsRef<Path>) -> Result<(), Box<dyn Error>>;
    fn read(&self, path: impl AsRef<Path>) -> Result<Option<Vec<u8>>, Box<dyn Error>>;
    fn read_to_string(&self, path: impl AsRef<Path>) -> Result<Option<String>, Box<dyn Error>>;
    fn delete(&mut self, path: impl AsRef<Path>) -> Result<(), Box<dyn Error>>;
    fn write(&mut self, path: impl AsRef<Path>, contents: Vec<u8>) -> Result<(), Box<dyn Error>>;
    fn write_str(&mut self, path: impl AsRef<Path>, contents: String)
        -> Result<(), Box<dyn Error>>;
    fn walk_dir(
        &self,
        path: impl AsRef<Path>,
        include_dirs: bool,
    ) -> Result<Box<dyn Iterator<Item = PathBuf>>, Box<dyn Error>>;
}

// Orphan rules prevent this blanket impl so it must be implemented for each
// struct individually
// impl<T> std::fmt::Display for T
// where
//     T: FileSystemAPI,
// {
//     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
//         match self.walk_dir("", false) {
//             Ok(paths) => {
//                 write!(
//                     f,
//                     "{}:\n\t{}",
//                     self.root_dir().display(),
//                     paths
//                         .map(|p| p.display().to_string())
//                         .collect::<Vec<_>>()
//                         .join("\n\t")
//                 )
//             }
//             Err(e) => write!(f, "{}: {}", self.root_dir().display(), e),
//         }
//     }
// }

#[cfg(feature = "binary")]
pub trait WatchableFileSystemAPI {
    fn watch(
        &self,
        root: PathBuf,
        watch_paths: Vec<String>,
        changed: impl Fn(Vec<PathBuf>) + Send + Sync + 'static,
    ) -> Result<Box<dyn FnOnce() + '_>, Box<dyn Error>>;
}

fn has_toplevel<S: Read + Seek>(
    archive: &mut zip::ZipArchive<S>,
) -> Result<bool, zip::result::ZipError> {
    let mut toplevel_dir: Option<PathBuf> = None;
    if archive.len() < 2 {
        return Ok(false);
    }

    for i in 0..archive.len() {
        let file = archive.by_index(i)?.mangled_name();
        if let Some(toplevel_dir) = &toplevel_dir {
            if !file.starts_with(toplevel_dir) {
                return Ok(false);
            }
        } else {
            // First iteration
            let comp: PathBuf = file.components().take(1).collect();
            toplevel_dir = Some(comp);
        }
    }
    Ok(true)
}

pub fn unpack_zip(zipball: Vec<u8>, fs: &mut impl FileSystemAPI) -> Result<(), Box<dyn Error>> {
    let mut archive = zip::ZipArchive::new(Cursor::new(zipball))?;

    let do_strip_toplevel = has_toplevel(&mut archive)?;

    for i in 0..archive.len() {
        let mut file = archive.by_index(i)?;
        let mut relative_path = file.mangled_name();

        if do_strip_toplevel {
            let base = relative_path
                .components()
                .take(1)
                .fold(PathBuf::new(), |mut p, c| {
                    p.push(c);
                    p
                });
            relative_path = relative_path.strip_prefix(&base)?.to_path_buf()
        }

        if relative_path.to_string_lossy().is_empty() {
            // Top-level directory
            continue;
        }

        let mut outpath = PathBuf::new();
        outpath.push(relative_path);

        #[cfg(feature = "verbose-logging")]
        debug!("create {}", outpath.display());

        if file.name().ends_with('/') {
            fs.create_dir_all(&outpath)?;
        } else {
            if let Some(p) = outpath.parent() {
                if !fs.exists(p)? {
                    #[cfg(feature = "verbose-logging")]
                    debug!("create {}", p.display());
                    fs.create_dir_all(p)?;
                }
            }
            let mut buffer = vec![];
            file.read_to_end(&mut buffer)?;
            #[cfg(feature = "verbose-logging")]
            debug!("writing file: {}", outpath.display());
            fs.write(&outpath, buffer)?;
        }
    }
    Ok(())
}