Skip to main content

pijul_core/working_copy/
mod.rs

1use chardetng::EncodingDetector;
2
3use crate::pristine::{Inode, InodeMetadata};
4use crate::text_encoding::Encoding;
5
6#[cfg(feature = "ondisk-repos")]
7pub mod filesystem;
8#[cfg(feature = "ondisk-repos")]
9pub use filesystem::FileSystem;
10
11pub mod memory;
12pub use memory::Memory;
13
14pub trait WorkingCopyRead {
15    type Error: std::error::Error + Send;
16    fn file_metadata(&self, file: &str) -> Result<InodeMetadata, Self::Error>;
17    fn read_file(&self, file: &str, buffer: &mut Vec<u8>) -> Result<(), Self::Error>;
18    fn modified_time(&self, file: &str) -> Result<std::time::SystemTime, Self::Error>;
19    /// Read the file into the buffer
20    ///
21    /// Returns the file's text encoding or None if it was a binary file
22    fn decode_file(
23        &self,
24        file: &str,
25        buffer: &mut Vec<u8>,
26    ) -> Result<Option<Encoding>, Self::Error> {
27        let init = buffer.len();
28        self.read_file(file, buffer)?;
29        let slice = &buffer[init..];
30        if looks_binary(slice) {
31            return Ok(None);
32        }
33        let mut detector = EncodingDetector::new();
34        detector.feed(slice, true);
35        if let Some(e) = crate::get_valid_encoding(&detector, None, true, slice) {
36            Ok(Some(Encoding(e)))
37        } else {
38            Ok(None)
39        }
40    }
41}
42
43fn looks_binary(buf: &[u8]) -> bool {
44    if buf.is_empty() {
45        return false;
46    }
47    buf.contains(&0)
48}
49
50pub trait WorkingCopy: WorkingCopyRead {
51    fn is_writable(&self, _path: &str) -> Result<bool, Self::Error> {
52        Ok(true)
53    }
54    fn create_dir_all(&self, path: &str) -> Result<(), Self::Error>;
55    fn remove_path(&self, name: &str, rec: bool) -> Result<(), Self::Error>;
56    fn rename(&self, former: &str, new: &str) -> Result<(), Self::Error>;
57    fn set_permissions(&self, name: &str, permissions: u16) -> Result<(), Self::Error>;
58
59    type Writer: std::io::Write;
60    fn write_file(&self, file: &str, inode: Inode) -> Result<Self::Writer, Self::Error>;
61
62    fn touch(&self, _name: &str, _time: std::time::SystemTime) -> Result<(), Self::Error> {
63        Ok(())
64    }
65}
66
67#[derive(Clone)]
68pub struct Sink {}
69
70pub fn sink() -> Sink {
71    Sink {}
72}
73
74impl WorkingCopyRead for Sink {
75    type Error = std::io::Error;
76    fn file_metadata(&self, _file: &str) -> Result<InodeMetadata, Self::Error> {
77        panic!("file_metadata not implemented: {:?}", _file)
78    }
79    fn read_file(&self, _file: &str, _buffer: &mut Vec<u8>) -> Result<(), Self::Error> {
80        panic!("read_file not implemented: {:?}", _file)
81    }
82    fn modified_time(&self, _file: &str) -> Result<std::time::SystemTime, Self::Error> {
83        panic!("modified_time not implemented: {:?}", _file)
84    }
85}
86
87impl WorkingCopy for Sink {
88    fn is_writable(&self, _path: &str) -> Result<bool, Self::Error> {
89        Ok(false)
90    }
91    fn create_dir_all(&self, _path: &str) -> Result<(), Self::Error> {
92        Ok(())
93    }
94    fn remove_path(&self, _name: &str, _rec: bool) -> Result<(), Self::Error> {
95        Ok(())
96    }
97    fn rename(&self, _former: &str, _new: &str) -> Result<(), Self::Error> {
98        Ok(())
99    }
100    fn set_permissions(&self, _name: &str, _permissions: u16) -> Result<(), Self::Error> {
101        Ok(())
102    }
103
104    type Writer = std::io::Sink;
105    fn write_file(&self, _file: &str, _inode: Inode) -> Result<Self::Writer, Self::Error> {
106        Ok(std::io::sink())
107    }
108}