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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
use super::error::{Error, Result};
use super::utils::collect_file_paths;
#[cfg(feature = "progress_bar")]
use super::utils::progress_bar;
use chrono::{offset::Utc, DateTime};
#[cfg(feature = "progress_bar")]
use indicatif::ProgressIterator;
use lazy_static::lazy_static;
use regex::Regex;
use sha2::{Digest, Sha256};
use std::sync::mpsc;
use std::thread;
use std::{
    fs::{self, File},
    io,
    path::Path,
    path::PathBuf,
};
use tree_magic_mini as magic;

/// Struct representing a reference to an entry in the blob store
#[derive(Debug, Clone)]
pub struct BlobRef {
    /// The value of the reference, i.e. the sha256 hash of the blob
    value: String,
}

/// Struct representing the metadata associated to a blob
#[derive(Debug)]
pub struct BlobMetadata {
    /// The filename of the blob
    pub filename: String,
    /// The mime-type of the blob (e.g. `image/png`)
    pub mime_type: String,
    /// The size of the blob in bytes
    pub size: u64,
    /// The creation timestamp of the blob
    pub created: DateTime<Utc>,
}

/// Returns a [`BlobRef`] instance from a hasher
///
/// # Examples
///
/// ```
/// # use sha2::{Digest, Sha256};
/// # use rstr::BlobRef;
/// let mut hasher = Sha256::new();
/// hasher.update(b"hello world");
/// let blob_ref = BlobRef::from(hasher);
/// assert_eq!(blob_ref.reference(), "b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9");
/// ```
impl From<Sha256> for BlobRef {
    fn from(hasher: Sha256) -> Self {
        BlobRef::new(&format!("{:x}", hasher.finalize())[..]).unwrap()
    }
}

impl BlobRef {
    /// Creates a new [`BlobRef`] from a valid hex representation of the sha256 hash.
    ///
    /// # Errors
    ///
    /// The method will return a [`Error::InvalidRef`] if the input string
    /// - has `len() != 64`
    /// - contains any char except lowercase letters and digits
    ///
    /// # Examples
    /// ```
    /// # use rstr::BlobRef;
    /// let blob_ref = BlobRef::new("f29bc64a9d3732b4b9035125fdb3285f5b6455778edca72414671e0ca3b2e0de");
    /// assert!(blob_ref.is_ok())
    /// ```
    /// ```
    /// # use rstr::BlobRef;
    /// let blob_ref = BlobRef::new("a_short_hash");
    /// assert!(blob_ref.is_err());
    /// let blob_ref = BlobRef::new("....aninvalidhash.29bc64a9d3732b4b9035125fdb3285f5b6455778edca7");
    /// assert!(blob_ref.is_err());
    /// ```

    pub fn new(value: &str) -> Result<BlobRef> {
        lazy_static! {
            static ref VALID_HASH_REGEX: Regex = Regex::new(r"^[a-z0-9]{64}$").unwrap();
        }

        if VALID_HASH_REGEX.is_match(value) {
            Ok(BlobRef {
                value: String::from(value),
            })
        } else {
            Err(Error::InvalidRef)
        }
    }

    /// Converts the blob's reference into a path relative to the root of the blob store.
    ///
    /// # Examples
    ///
    /// ```
    /// # use rstr::BlobRef;
    /// let hash = "f29bc64a9d3732b4b9035125fdb3285f5b6455778edca72414671e0ca3b2e0de";
    /// let blob_ref = BlobRef::new(hash).unwrap();
    /// assert_eq!(blob_ref.to_path().to_str().unwrap(), "f2/9b/c6/4a9d3732b4b9035125fdb3285f5b6455778edca72414671e0ca3b2e0de")
    /// ```
    pub fn to_path(&self) -> PathBuf {
        PathBuf::from(&self.value[0..2])
            .join(&self.value[2..4])
            .join(&self.value[4..6])
            .join(&self.value[6..])
    }

    /// Returns a string reference (hex representation of Sha256 hash) for the blob
    ///
    /// # Examples
    ///
    /// ```
    /// # use rstr::BlobRef;
    /// let hash = "f29bc64a9d3732b4b9035125fdb3285f5b6455778edca72414671e0ca3b2e0de";
    /// let blob_ref = BlobRef::new(hash).unwrap();
    ///
    /// assert_eq!(blob_ref.reference(), hash);
    /// ```
    pub fn reference(&self) -> &str {
        &self.value
    }
}

impl std::fmt::Display for BlobRef {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "BlobRef({})", &self.value[..10])
    }
}

/// Struct for interacting with the blob store
#[derive(Clone, Debug)]
pub struct BlobStore {
    root: PathBuf,
}

type BlobRefAndPath = (PathBuf, BlobRef);

impl BlobStore {
    /// Creates a new instance of the `BlobStore` struct used to interact with the blob
    /// store. If the specified blob store root path does not exists, it tries to create
    /// it.
    ///
    /// # Errors
    ///
    /// It errors if the specified path is not a directory or if it does not exist and
    /// cannot be created.
    ///
    /// # Examples
    ///
    /// ```
    /// use rstr::BlobStore;
    ///
    /// let blob_store = BlobStore::new("../tests/test_data_store");
    /// assert!(blob_store.is_ok());
    ///
    /// let blob_store = BlobStore::new("../tests/test_file.txt");
    /// assert!(blob_store.is_err());
    /// ```
    pub fn new<P: AsRef<Path>>(path: P) -> Result<BlobStore> {
        let path = path.as_ref();
        if !path.exists() {
            fs::create_dir_all(path)?
        } else if !path.is_dir() {
            // TODO: return proper error
            return Err(io::Error::from(io::ErrorKind::Other).into());
        }
        Ok(BlobStore { root: path.into() })
    }

    /// Returns an instance of the hasher used to compute the blob reference for a file
    ///
    /// # Examples
    ///
    /// ```
    /// use rstr::BlobStore;
    /// use sha2::{Digest, Sha256};
    ///
    /// let mut hasher = BlobStore::hasher();
    /// hasher.update(b"hello world");
    /// let result = hasher.finalize();
    /// assert_eq!(format!("{:x}", result), "b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9")
    /// ```
    pub fn hasher() -> Sha256 {
        Sha256::new()
    }

    /// Given a `BlobRef` it returns it's path inside the blob store
    fn get_blob_path(&self, blob_ref: &BlobRef) -> PathBuf {
        self.root.join(blob_ref.to_path())
    }

    /// Given a `BlobRef` it returns it's path inside the blob store, including the filename
    ///
    /// # Errors
    ///
    /// It will error if the directory is not present/cannot be read or there is no file.
    fn get_blob_file_path(&self, blob_ref: &BlobRef) -> Result<PathBuf> {
        let mut entries = self.get_blob_path(blob_ref).read_dir()?;
        if let Some(Ok(entry)) = entries.next() {
            return Ok(entry.path());
        };
        Err(Error::BlobNotFound)
    }

    /// Add a file to the blob store given a path.
    ///
    /// # Examples
    ///
    /// ```
    /// use rstr::{BlobStore, BlobRef};
    /// use std::path::PathBuf;
    /// let blob_store = BlobStore::new("../tests/test_data_store/").unwrap();
    ///
    /// let blob_ref: BlobRef = blob_store.add("../tests/test_file.txt").unwrap();
    /// assert!(blob_store.exists(&blob_ref));
    /// assert_eq!(blob_ref.reference(), "f29bc64a9d3732b4b9035125fdb3285f5b6455778edca72414671e0ca3b2e0de");
    /// ```
    pub fn add<P: AsRef<Path>>(&self, path: P) -> Result<BlobRef> {
        let mut file = File::open(&path)?;
        let mut hasher = BlobStore::hasher();

        io::copy(&mut file, &mut hasher)?;
        let blob_ref = BlobRef::from(hasher);

        if !self.exists(&blob_ref) {
            let save_path = self.get_blob_path(&blob_ref);
            fs::create_dir_all(&save_path)?;

            let filename = path.as_ref().file_name().unwrap();
            let save_path = save_path.join(&filename);
            fs::copy(path, save_path)?;
        };

        Ok(blob_ref)
    }

    /// Given a list of paths to files/directories it adds them to the blob store. In the case
    /// of a directory it adds all the files in its children recursively.
    ///
    /// The function iterates over all paths in parallel and adds each file to the blob store.
    ///
    /// It returns two vectors: one containing the paths to the files that were successfully
    /// added together with their generated `BlobRef` and the other containing the list of
    /// paths that errored together with the error.
    ///
    /// # Examples
    ///
    /// ```
    /// # use std::path::Path;
    /// use rstr::{BlobStore, BlobRef};
    ///
    /// let blob_store = BlobStore::new("../tests/test_data_store").unwrap();
    ///
    /// let paths = [Path::new("../tests/test_file.txt")];
    /// let threads: u8 = 8;
    /// let (blob_refs_with_paths, errors) = blob_store.add_files(&paths[..], threads);
    /// let blob_refs: Vec<BlobRef> = blob_refs_with_paths.into_iter().map(|(_, b)| b).collect();
    ///
    /// assert_eq!(blob_refs[0].reference(), "f29bc64a9d3732b4b9035125fdb3285f5b6455778edca72414671e0ca3b2e0de")
    /// ```
    pub fn add_files<P: AsRef<Path>>(
        &self,
        paths: &[P],
        threads: u8,
    ) -> (Vec<BlobRefAndPath>, Vec<(PathBuf, Error)>) {
        let paths: Vec<PathBuf> = paths
            .iter()
            .flat_map(|p| collect_file_paths(p.as_ref()))
            .collect();

        let (tx, rx) = mpsc::channel();

        let chunk_size = std::cmp::max(paths.len() / threads as usize, 1_usize);
        let chunks = paths.chunks(chunk_size);

        for chunk in chunks {
            let tx = tx.clone();
            let chunk = chunk.to_owned();
            let blob_store = self.clone();
            thread::spawn(move || {
                for path in chunk {
                    let blob_ref = blob_store.add(&path);
                    tx.send((path, blob_ref)).expect("err")
                }
            });
        }

        drop(tx);

        let rx_iter = rx.iter();

        #[cfg(feature = "progress_bar")]
        let rx_iter = rx_iter.progress_with(progress_bar(paths.len() as u64));

        let (success, errors): (Vec<_>, Vec<_>) = rx_iter.partition(|(_, b)| b.is_ok());

        let success = success.into_iter().map(|(p, b)| (p, b.unwrap())).collect();
        let errors = errors
            .into_iter()
            .map(|(p, b)| (p, b.unwrap_err()))
            .collect();
        (success, errors)
    }

    /// Given a [`BlobRef`] it retrieves the associated file and returns it as a byte-array.
    ///
    /// # Examples
    ///
    /// ```
    /// use rstr::{BlobStore, BlobRef};
    ///
    /// let blob_store = BlobStore::new("../tests/test_data_store").unwrap();
    /// let reference = "f29bc64a9d3732b4b9035125fdb3285f5b6455778edca72414671e0ca3b2e0de";
    /// let blob_ref = BlobRef::new(reference).unwrap();
    ///
    /// let content = blob_store.get(&blob_ref).unwrap();
    ///
    /// assert_eq!(content, &[
    ///     84, 104, 105, 115, 32, 105, 115, 32, 97, 32, 116, 101, 115, 116, 32, 102, 105, 108,
    ///     101, 46,
    /// ]);
    /// ```
    pub fn get(&self, blob_ref: &BlobRef) -> Result<Vec<u8>> {
        Ok(fs::read(&self.get_blob_file_path(blob_ref)?)?)
    }

    /// Returns `true` if there is a file associated with the [`BlobRef`] in the blob store
    ///
    /// # Examples
    ///
    /// ```
    /// use rstr::{BlobStore, BlobRef};
    ///
    /// let blob_store = BlobStore::new("../tests/test_data_store/").unwrap();
    /// let blob_ref = BlobRef::new("f29bc64a9d3732b4b9035125fdb3285f5b6455778edca72414671e0ca3b2e0de").unwrap();
    ///
    /// assert!(blob_store.exists(&blob_ref))
    /// ```
    pub fn exists(&self, blob_ref: &BlobRef) -> bool {
        let dir = self.get_blob_path(blob_ref);
        dir.exists() && dir.read_dir().unwrap().next().is_some()
    }

    /// Given a [`BlobRef`] it deletes the corresponding blob from the blob store
    ///
    /// # Examples
    ///
    /// ```no_run
    /// # use rstr::{BlobStore, BlobRef};
    /// let blob_store = BlobStore::new("/path/to/blob/store").unwrap();
    ///
    /// let blob_ref = BlobRef::new("b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9").unwrap();
    /// assert!(blob_store.exists(&blob_ref));
    ///
    /// blob_store.delete(&blob_ref);
    /// assert!(!blob_store.exists(&blob_ref));
    /// ```
    /// # Errors
    ///
    /// See [`fs::remove_dir_all`].
    pub fn delete(&self, blob_ref: &BlobRef) -> Result<()> {
        Ok(fs::remove_dir_all(self.get_blob_path(blob_ref))?)
    }

    /// Given a [`BlobRef`] returns the metadata relative to the referenced blob. For more
    /// details on the metadata returned see `BlobMetadata`.
    ///
    /// The mime type is inferred from the file's magic number as a string.
    /// It defaults to "application/octet-stream" if it cannot determine the type.
    /// We use the [`tree_magic_mini`] crate to infer the mime type.
    ///
    /// # Errors
    ///
    /// Will return an error if the file cannot be found/opened or if [`std::fs::metadata`]
    /// fails.
    pub fn metadata(&self, blob_ref: &BlobRef) -> Result<BlobMetadata> {
        let file_path = self.get_blob_file_path(blob_ref)?;

        let mime = magic::from_filepath(&file_path).unwrap_or("application/octet-stream");

        let filename = file_path.file_name().unwrap().to_str().unwrap().to_string();

        let metadata = fs::metadata(file_path)?;
        Ok(BlobMetadata {
            mime_type: String::from(mime),
            filename,
            size: metadata.len(),
            created: metadata.created()?.into(),
        })
    }
}

impl BlobMetadata {
    pub fn created_str(&self) -> String {
        self.created
            .to_rfc3339_opts(chrono::SecondsFormat::Secs, false)
    }
}