577 lines
22 KiB
Rust
577 lines
22 KiB
Rust
//
|
|
// imag - the personal information management suite for the commandline
|
|
// Copyright (C) 2015, 2016 Matthias Beyer <mail@beyermatthias.de> and contributors
|
|
//
|
|
// This library is free software; you can redistribute it and/or
|
|
// modify it under the terms of the GNU Lesser General Public
|
|
// License as published by the Free Software Foundation; version
|
|
// 2.1 of the License.
|
|
//
|
|
// This library is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
// Lesser General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Lesser General Public
|
|
// License along with this library; if not, write to the Free Software
|
|
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
//
|
|
|
|
//! The Ref object is a helper over the link functionality, so one is able to create references to
|
|
//! files outside of the imag store.
|
|
|
|
use std::path::PathBuf;
|
|
use std::ops::Deref;
|
|
use std::ops::DerefMut;
|
|
use std::collections::BTreeMap;
|
|
use std::fs::File;
|
|
use std::fmt::{Display, Error as FmtError, Formatter};
|
|
use std::fs::Permissions;
|
|
use std::result::Result as RResult;
|
|
|
|
use libimagstore::store::FileLockEntry;
|
|
use libimagstore::storeid::StoreId;
|
|
use libimagstore::storeid::IntoStoreId;
|
|
use libimagstore::store::Store;
|
|
use libimagstore::toml_ext::TomlValueExt;
|
|
use libimagerror::into::IntoError;
|
|
|
|
use toml::Value;
|
|
|
|
use error::RefErrorKind as REK;
|
|
use error::MapErrInto;
|
|
use flags::RefFlags;
|
|
use result::Result;
|
|
use hasher::*;
|
|
use module_path::ModuleEntryPath;
|
|
|
|
#[derive(Debug)]
|
|
pub struct Ref<'a>(FileLockEntry<'a>);
|
|
|
|
impl<'a> Ref<'a> {
|
|
|
|
/// Try to build a Ref object based on an existing FileLockEntry object
|
|
pub fn from_filelockentry(fle: FileLockEntry<'a>) -> Result<Ref<'a>> {
|
|
Ref::read_reference(&fle).map(|_| Ref(fle))
|
|
}
|
|
|
|
/// Try to get `si` as Ref object from the store
|
|
pub fn get(store: &'a Store, si: StoreId) -> Result<Ref<'a>> {
|
|
match store.get(si) {
|
|
Err(e) => return Err(REK::StoreReadError.into_error_with_cause(Box::new(e))),
|
|
Ok(None) => return Err(REK::RefNotInStore.into_error()),
|
|
Ok(Some(fle)) => Ref::from_filelockentry(fle),
|
|
}
|
|
}
|
|
|
|
/// Get a Ref object from the store by hash.
|
|
///
|
|
/// Returns None if the hash cannot be found.
|
|
pub fn get_by_hash(store: &'a Store, hash: String) -> Result<Option<Ref<'a>>> {
|
|
ModuleEntryPath::new(hash)
|
|
.into_storeid()
|
|
.and_then(|id| store.get(id))
|
|
.map(|opt_fle| opt_fle.map(|fle| Ref(fle)))
|
|
.map_err(Box::new)
|
|
.map_err(|e| REK::StoreReadError.into_error_with_cause(e))
|
|
}
|
|
|
|
/// Delete a ref by hash
|
|
///
|
|
/// If the returned Result contains an error, the ref might not be deleted.
|
|
pub fn delete_by_hash(store: &'a Store, hash: String) -> Result<()> {
|
|
ModuleEntryPath::new(hash)
|
|
.into_storeid()
|
|
.and_then(|id| store.delete(id))
|
|
.map_err(Box::new)
|
|
.map_err(|e| REK::StoreWriteError.into_error_with_cause(e))
|
|
}
|
|
|
|
fn read_reference(fle: &FileLockEntry<'a>) -> Result<PathBuf> {
|
|
match fle.get_header().read("ref.path") {
|
|
Ok(Some(Value::String(s))) => Ok(PathBuf::from(s)),
|
|
Ok(Some(_)) => Err(REK::HeaderTypeError.into_error()),
|
|
Ok(None) => Err(REK::HeaderFieldMissingError.into_error()),
|
|
Err(e) => Err(REK::StoreReadError.into_error_with_cause(Box::new(e))),
|
|
}
|
|
}
|
|
|
|
pub fn create_with_hasher<H: Hasher>(store: &'a Store, pb: PathBuf, flags: RefFlags, mut h: H)
|
|
-> Result<Ref<'a>>
|
|
{
|
|
if !pb.exists() {
|
|
return Err(REK::RefTargetDoesNotExist.into_error());
|
|
}
|
|
if flags.get_content_hashing() && pb.is_dir() {
|
|
return Err(REK::RefTargetCannotBeHashed.into_error());
|
|
}
|
|
|
|
let (mut fle, content_hash, permissions, canonical_path) = { // scope to be able to fold
|
|
try!(File::open(pb.clone())
|
|
.map_err(Box::new)
|
|
.map_err(|e| REK::RefTargetFileCannotBeOpened.into_error_with_cause(e))
|
|
|
|
// If we were able to open this file,
|
|
// we hash the contents of the file and return (file, hash)
|
|
.and_then(|mut file| {
|
|
let opt_contenthash = if flags.get_content_hashing() {
|
|
Some(try!(h.create_hash(&pb, &mut file)))
|
|
} else {
|
|
None
|
|
};
|
|
|
|
Ok((file, opt_contenthash))
|
|
})
|
|
|
|
// and then we get the permissions if we have to
|
|
// and return (file, content hash, permissions)
|
|
.and_then(|(file, opt_contenthash)| {
|
|
let opt_permissions = if flags.get_permission_tracking() {
|
|
Some(try!(file
|
|
.metadata()
|
|
.map(|md| md.permissions())
|
|
.map_err(Box::new)
|
|
.map_err(|e| REK::RefTargetCannotReadPermissions.into_error_with_cause(e))
|
|
))
|
|
} else {
|
|
None
|
|
};
|
|
|
|
Ok((opt_contenthash, opt_permissions))
|
|
})
|
|
|
|
// and then we try to canonicalize the PathBuf, because we want to store a
|
|
// canonicalized path
|
|
// and return (file, content hash, permissions, canonicalized path)
|
|
.and_then(|(opt_contenthash, opt_permissions)| {
|
|
pb.canonicalize()
|
|
.map(|can| (opt_contenthash, opt_permissions, can))
|
|
// if PathBuf::canonicalize() failed, build an error from the return value
|
|
.map_err(|e| REK::PathCanonicalizationError.into_error_with_cause(Box::new(e)))
|
|
})
|
|
|
|
// and then we hash the canonicalized path
|
|
// and return (file, content hash, permissions, canonicalized path, path hash)
|
|
.and_then(|(opt_contenthash, opt_permissions, can)| {
|
|
let path_hash = try!(Ref::hash_path(&can)
|
|
.map_err(Box::new)
|
|
.map_err(|e| REK::PathHashingError.into_error_with_cause(e))
|
|
);
|
|
|
|
Ok((opt_contenthash, opt_permissions, can, path_hash))
|
|
})
|
|
|
|
// and then we convert the PathBuf of the canonicalized path to a String to be able
|
|
// to save it in the Ref FileLockEntry obj
|
|
// and return
|
|
// (file, content hash, permissions, canonicalized path as String, path hash)
|
|
.and_then(|(opt_conhash, opt_perm, can, path_hash)| {
|
|
match can.to_str().map(String::from) {
|
|
// UTF convert error in PathBuf::to_str(),
|
|
None => Err(REK::PathUTF8Error.into_error()),
|
|
Some(can) => Ok((opt_conhash, opt_perm, can, path_hash))
|
|
}
|
|
})
|
|
|
|
// and then we create the FileLockEntry in the Store
|
|
// and return (filelockentry, content hash, permissions, canonicalized path)
|
|
.and_then(|(opt_conhash, opt_perm, can, path_hash)| {
|
|
let fle = try!(store
|
|
.create(ModuleEntryPath::new(path_hash))
|
|
.map_err(Box::new)
|
|
.map_err(|e| REK::StoreWriteError.into_error_with_cause(e))
|
|
);
|
|
|
|
Ok((fle, opt_conhash, opt_perm, can))
|
|
})
|
|
)
|
|
};
|
|
|
|
for tpl in [
|
|
Some((String::from("ref"), Value::Table(BTreeMap::new()))),
|
|
Some((String::from("ref.permissions"), Value::Table(BTreeMap::new()))),
|
|
Some((String::from("ref.path"), Value::String(canonical_path))),
|
|
Some((String::from("ref.content_hash"), Value::Table(BTreeMap::new()))),
|
|
|
|
content_hash.map(|hash| {
|
|
(format!("ref.content_hash.{}", h.hash_name()), Value::String(hash))
|
|
}),
|
|
permissions.map(|p| {
|
|
(String::from("ref.permissions.ro"), Value::Boolean(p.readonly()))
|
|
}),
|
|
].into_iter()
|
|
{
|
|
match tpl {
|
|
&Some((ref s, ref v)) => {
|
|
match fle.get_header_mut().insert(s, v.clone()) {
|
|
Ok(false) => {
|
|
let e = REK::HeaderFieldAlreadyExistsError.into_error();
|
|
let e = Box::new(e);
|
|
let e = REK::HeaderFieldWriteError.into_error_with_cause(e);
|
|
return Err(e);
|
|
},
|
|
Err(e) => {
|
|
let e = Box::new(e);
|
|
let e = REK::HeaderFieldWriteError.into_error_with_cause(e);
|
|
return Err(e);
|
|
},
|
|
_ => (),
|
|
}
|
|
}
|
|
&None => {
|
|
debug!("Not going to insert.");
|
|
}
|
|
}
|
|
}
|
|
|
|
Ok(Ref(fle))
|
|
}
|
|
|
|
/// Create a Ref object which refers to `pb`
|
|
pub fn create(store: &'a Store, pb: PathBuf, flags: RefFlags) -> Result<Ref<'a>> {
|
|
Ref::create_with_hasher(store, pb, flags, DefaultHasher::new())
|
|
}
|
|
|
|
/// Creates a Hash from a PathBuf by making the PathBuf absolute and then running a hash
|
|
/// algorithm on it
|
|
fn hash_path(pb: &PathBuf) -> Result<String> {
|
|
use crypto::sha1::Sha1;
|
|
use crypto::digest::Digest;
|
|
|
|
match pb.to_str() {
|
|
Some(s) => {
|
|
let mut hasher = Sha1::new();
|
|
hasher.input_str(s);
|
|
Ok(hasher.result_str())
|
|
},
|
|
None => return Err(REK::PathUTF8Error.into_error()),
|
|
}
|
|
}
|
|
|
|
/// Get the hash from the path of the ref
|
|
pub fn get_path_hash(&self) -> Result<String> {
|
|
self.0
|
|
.get_location()
|
|
.clone()
|
|
.into_pathbuf()
|
|
.map_err_into(REK::StoreIdError)
|
|
.and_then(|pb| {
|
|
pb.file_name()
|
|
.and_then(|osstr| osstr.to_str())
|
|
.and_then(|s| s.split("~").next())
|
|
.map(String::from)
|
|
.ok_or(REK::StoreIdError.into_error())
|
|
})
|
|
}
|
|
|
|
/// Get the hash of the link target which is stored in the ref object
|
|
pub fn get_stored_hash(&self) -> Result<String> {
|
|
self.get_stored_hash_with_hasher(&DefaultHasher::new())
|
|
}
|
|
|
|
/// Get the hahs of the link target which is stored in the ref object, which is hashed with a
|
|
/// custom Hasher instance.
|
|
pub fn get_stored_hash_with_hasher<H: Hasher>(&self, h: &H) -> Result<String> {
|
|
match self.0.get_header().read(&format!("ref.content_hash.{}", h.hash_name())[..]) {
|
|
// content hash stored...
|
|
Ok(Some(Value::String(s))) => Ok(s),
|
|
|
|
// content hash header field has wrong type
|
|
Ok(Some(_)) => Err(REK::HeaderTypeError.into_error()),
|
|
|
|
// content hash not stored
|
|
Ok(None) => Err(REK::HeaderFieldMissingError.into_error()),
|
|
|
|
// Error
|
|
Err(e) => Err(REK::StoreReadError.into_error_with_cause(Box::new(e))),
|
|
}
|
|
}
|
|
|
|
/// Get the hash of the link target by reading the link target and hashing the contents
|
|
pub fn get_current_hash(&self) -> Result<String> {
|
|
self.get_current_hash_with_hasher(DefaultHasher::new())
|
|
}
|
|
|
|
/// Get the hash of the link target by reading the link target and hashing the contents with the
|
|
/// custom hasher
|
|
pub fn get_current_hash_with_hasher<H: Hasher>(&self, mut h: H) -> Result<String> {
|
|
self.fs_file()
|
|
.and_then(|pb| {
|
|
File::open(pb.clone())
|
|
.map(|f| (pb, f))
|
|
.map_err(Box::new)
|
|
.map_err(|e| REK::IOError.into_error_with_cause(e))
|
|
})
|
|
.and_then(|(path, mut file)| h.create_hash(&path, &mut file))
|
|
}
|
|
|
|
/// Get the permissions of the file which are present
|
|
fn get_current_permissions(&self) -> Result<Permissions> {
|
|
self.fs_file()
|
|
.and_then(|pb| {
|
|
File::open(pb)
|
|
.map_err(Box::new)
|
|
.map_err(|e| REK::HeaderFieldReadError.into_error_with_cause(e))
|
|
})
|
|
.and_then(|file| {
|
|
file
|
|
.metadata()
|
|
.map(|md| md.permissions())
|
|
.map_err(Box::new)
|
|
.map_err(|e| REK::RefTargetCannotReadPermissions.into_error_with_cause(e))
|
|
})
|
|
}
|
|
|
|
/// check whether the pointer the Ref represents still points to a file which exists
|
|
pub fn fs_link_exists(&self) -> Result<bool> {
|
|
self.fs_file().map(|pathbuf| pathbuf.exists())
|
|
}
|
|
|
|
/// Alias for `r.fs_link_exists() && r.deref().is_file()`
|
|
pub fn is_ref_to_file(&self) -> Result<bool> {
|
|
self.fs_file().map(|pathbuf| pathbuf.is_file())
|
|
}
|
|
|
|
/// Alias for `r.fs_link_exists() && r.deref().is_dir()`
|
|
pub fn is_ref_to_dir(&self) -> Result<bool> {
|
|
self.fs_file().map(|pathbuf| pathbuf.is_dir())
|
|
}
|
|
|
|
/// Alias for `!Ref::fs_link_exists()`
|
|
pub fn is_dangling(&self) -> Result<bool> {
|
|
self.fs_link_exists().map(|b| !b)
|
|
}
|
|
|
|
/// check whether the pointer the Ref represents is valid
|
|
/// This includes:
|
|
/// - Hashsum of the file is still the same as stored in the Ref
|
|
/// - file permissions are still valid
|
|
pub fn fs_link_valid(&self) -> Result<bool> {
|
|
match (self.fs_link_valid_permissions(), self.fs_link_valid_hash()) {
|
|
(Ok(true) , Ok(true)) => Ok(true),
|
|
(Ok(_) , Ok(_)) => Ok(false),
|
|
(Err(e) , _) => Err(e),
|
|
(_ , Err(e)) => Err(e),
|
|
}
|
|
}
|
|
|
|
/// Check whether the file permissions of the referenced file are equal to the stored
|
|
/// permissions
|
|
pub fn fs_link_valid_permissions(&self) -> Result<bool> {
|
|
self.0
|
|
.get_header()
|
|
.read("ref.permissions.ro")
|
|
.map_err(Box::new)
|
|
.map_err(|e| REK::HeaderFieldReadError.into_error_with_cause(e))
|
|
.and_then(|ro| {
|
|
match ro {
|
|
Some(Value::Boolean(b)) => Ok(b),
|
|
Some(_) => Err(REK::HeaderTypeError.into_error()),
|
|
None => Err(REK::HeaderFieldMissingError.into_error()),
|
|
}
|
|
})
|
|
.and_then(|ro| self.get_current_permissions().map(|perm| ro == perm.readonly()))
|
|
.map_err(Box::new)
|
|
.map_err(|e| REK::RefTargetCannotReadPermissions.into_error_with_cause(e))
|
|
}
|
|
|
|
/// Check whether the Hashsum of the referenced file is equal to the stored hashsum
|
|
pub fn fs_link_valid_hash(&self) -> Result<bool> {
|
|
let stored_hash = try!(self.get_stored_hash());
|
|
let current_hash = try!(self.get_current_hash());
|
|
Ok(stored_hash == current_hash)
|
|
}
|
|
|
|
/// Update the Ref by re-checking the file from FS
|
|
/// This errors if the file is not present or cannot be read()
|
|
pub fn update_ref(&mut self) -> Result<()> {
|
|
self.update_ref_with_hasher(&DefaultHasher::new())
|
|
}
|
|
|
|
/// Update the Ref by re-checking the file from FS using the passed Hasher instance
|
|
/// This errors if the file is not present or cannot be read()
|
|
pub fn update_ref_with_hasher<H: Hasher>(&mut self, h: &H) -> Result<()> {
|
|
let current_hash = try!(self.get_current_hash()); // uses the default hasher
|
|
let current_perm = try!(self.get_current_permissions());
|
|
|
|
try!(self.0
|
|
.get_header_mut()
|
|
.set("ref.permissions.ro", Value::Boolean(current_perm.readonly()))
|
|
.map_err(Box::new)
|
|
.map_err(|e| REK::StoreWriteError.into_error_with_cause(e))
|
|
);
|
|
|
|
try!(self.0
|
|
.get_header_mut()
|
|
.set(&format!("ref.content_hash.{}", h.hash_name())[..], Value::String(current_hash))
|
|
.map_err(Box::new)
|
|
.map_err(|e| REK::StoreWriteError.into_error_with_cause(e))
|
|
);
|
|
|
|
Ok(())
|
|
}
|
|
|
|
/// Get the path of the file which is reffered to by this Ref
|
|
pub fn fs_file(&self) -> Result<PathBuf> {
|
|
match self.0.get_header().read("ref.path") {
|
|
Ok(Some(Value::String(ref s))) => Ok(PathBuf::from(s)),
|
|
Ok(Some(_)) => Err(REK::HeaderTypeError.into_error()),
|
|
Ok(None) => Err(REK::HeaderFieldMissingError.into_error()),
|
|
Err(e) => Err(REK::StoreReadError.into_error_with_cause(Box::new(e))),
|
|
}
|
|
}
|
|
|
|
/// Check whether there is a reference to the file at `pb`
|
|
pub fn exists(store: &Store, pb: PathBuf) -> Result<bool> {
|
|
pb.canonicalize()
|
|
.map_err(Box::new)
|
|
.map_err(|e| REK::PathCanonicalizationError.into_error_with_cause(e))
|
|
.and_then(|can| {
|
|
Ref::hash_path(&can)
|
|
.map_err(Box::new)
|
|
.map_err(|e| REK::PathHashingError.into_error_with_cause(e))
|
|
})
|
|
.and_then(|hash| {
|
|
store.retrieve_for_module("ref").map(|iter| (hash, iter))
|
|
.map_err(Box::new)
|
|
.map_err(|e| REK::StoreReadError.into_error_with_cause(e))
|
|
})
|
|
.and_then(|(hash, possible_refs)| {
|
|
// This is kind of a manual Iterator::filter() call what we do here, but with the
|
|
// actual ::filter method we cannot return the error in a nice way, so we do it
|
|
// manually here. If you can come up with a better version of this, feel free to
|
|
// take this note as a todo.
|
|
for r in possible_refs {
|
|
let contains_hash = try!(r.to_str()
|
|
.map_err_into(REK::TypeConversionError)
|
|
.map(|s| s.contains(&hash[..])));
|
|
|
|
if !contains_hash {
|
|
continue;
|
|
}
|
|
|
|
match store.get(r) {
|
|
Ok(Some(fle)) => {
|
|
if Ref::read_reference(&fle).map(|path| path == pb).unwrap_or(false) {
|
|
return Ok(true)
|
|
}
|
|
},
|
|
|
|
Ok(None) => { // Something weird just happened
|
|
return Err(REK::StoreReadError.into_error());
|
|
},
|
|
|
|
Err(e) => {
|
|
return Err(REK::StoreReadError.into_error_with_cause(Box::new(e)));
|
|
},
|
|
}
|
|
}
|
|
|
|
Ok(false)
|
|
})
|
|
}
|
|
|
|
/// Re-find a referenced file
|
|
///
|
|
/// This function tries to re-find a ref by searching all directories in `search_roots` recursively
|
|
/// for a file which matches the hash of the Ref.
|
|
///
|
|
/// If `search_roots` is `None`, it starts at the filesystem root `/`.
|
|
///
|
|
/// If the target cannot be found, this yields a RefTargetDoesNotExist error kind.
|
|
///
|
|
/// # Warning
|
|
///
|
|
/// This option causes heavy I/O as it recursively searches the Filesystem.
|
|
pub fn refind(&self, search_roots: Option<Vec<PathBuf>>) -> Result<PathBuf> {
|
|
self.refind_with_hasher(search_roots, DefaultHasher::new())
|
|
}
|
|
|
|
pub fn refind_with_hasher<H: Hasher>(&self, search_roots: Option<Vec<PathBuf>>, mut h: H)
|
|
-> Result<PathBuf>
|
|
{
|
|
use itertools::Itertools;
|
|
use walkdir::WalkDir;
|
|
|
|
self.get_stored_hash()
|
|
.and_then(|stored_hash| {
|
|
search_roots
|
|
.unwrap_or(vec![PathBuf::from("/")])
|
|
.into_iter()
|
|
.map(|root| {
|
|
WalkDir::new(root)
|
|
.follow_links(false)
|
|
.into_iter()
|
|
.map(|entry| {
|
|
entry
|
|
.map_err(Box::new)
|
|
.map_err(|e| REK::IOError.into_error_with_cause(e))
|
|
.and_then(|entry| {
|
|
let pb = PathBuf::from(entry.path());
|
|
File::open(entry.path())
|
|
.map_err(Box::new)
|
|
.map_err(|e| REK::IOError.into_error_with_cause(e))
|
|
.map(|f| (pb, f))
|
|
})
|
|
.and_then(|(p, mut f)| h.create_hash(&p, &mut f).map(|h| (p, h)))
|
|
.map(|(path, hash)| {
|
|
if hash == stored_hash {
|
|
Some(path)
|
|
} else {
|
|
None
|
|
}
|
|
})
|
|
.map_err(Box::new)
|
|
.map_err(|e| REK::IOError.into_error_with_cause(e))
|
|
})
|
|
.filter_map(|e| e.ok())
|
|
.filter_map(|e| e)
|
|
.next()
|
|
})
|
|
.flatten()
|
|
.next()
|
|
.ok_or(REK::RefTargetDoesNotExist.into_error())
|
|
})
|
|
}
|
|
|
|
}
|
|
|
|
impl<'a> Deref for Ref<'a> {
|
|
type Target = FileLockEntry<'a>;
|
|
|
|
fn deref(&self) -> &FileLockEntry<'a> {
|
|
&self.0
|
|
}
|
|
|
|
}
|
|
|
|
impl<'a> DerefMut for Ref<'a> {
|
|
|
|
fn deref_mut(&mut self) -> &mut FileLockEntry<'a> {
|
|
&mut self.0
|
|
}
|
|
|
|
}
|
|
|
|
impl<'a> Display for Ref<'a> {
|
|
|
|
fn fmt(&self, fmt: &mut Formatter) -> RResult<(), FmtError> {
|
|
let path = self.fs_file()
|
|
.map(|pb| String::from(pb.to_str().unwrap_or("<UTF8-Error>")))
|
|
.unwrap_or(String::from("Could not read Path from reference object"));
|
|
|
|
let hash = self.get_stored_hash().unwrap_or(String::from("<could not read hash>"));
|
|
|
|
write!(fmt, "Ref({} -> {})", hash, path)
|
|
}
|
|
|
|
}
|
|
|
|
impl<'a> Into<FileLockEntry<'a>> for Ref<'a> {
|
|
|
|
fn into(self) -> FileLockEntry<'a> {
|
|
self.0
|
|
}
|
|
|
|
}
|
|
|