2016-10-01 15:35:06 +00:00
|
|
|
//
|
|
|
|
// imag - the personal information management suite for the commandline
|
2018-02-07 01:48:53 +00:00
|
|
|
// Copyright (C) 2015-2018 Matthias Beyer <mail@beyermatthias.de> and contributors
|
2016-10-01 15:35:06 +00:00
|
|
|
//
|
|
|
|
// 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
|
|
|
|
//
|
|
|
|
|
2016-06-09 17:34:25 +00:00
|
|
|
//! 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;
|
2018-02-13 20:11:45 +00:00
|
|
|
use std::result::Result as RResult;
|
2016-06-09 17:34:25 +00:00
|
|
|
|
2018-01-08 22:34:13 +00:00
|
|
|
use libimagentryutil::isa::Is;
|
|
|
|
use libimagentryutil::isa::IsKindHeaderPathProvider;
|
2018-02-13 20:11:45 +00:00
|
|
|
use libimagstore::store::Entry;
|
2016-06-09 17:34:25 +00:00
|
|
|
|
2018-02-13 20:11:45 +00:00
|
|
|
use toml_query::read::TomlValueReadExt;
|
|
|
|
use refstore::UniqueRefPathGenerator;
|
2016-06-14 09:05:38 +00:00
|
|
|
|
2017-09-03 19:39:32 +00:00
|
|
|
use error::Result;
|
2018-02-13 20:11:45 +00:00
|
|
|
use error::RefError as RE;
|
|
|
|
use error::RefErrorKind as REK;
|
2016-06-09 17:34:25 +00:00
|
|
|
|
2017-08-27 18:38:26 +00:00
|
|
|
pub trait Ref {
|
2016-06-09 17:34:25 +00:00
|
|
|
|
2018-01-08 22:34:13 +00:00
|
|
|
/// Check whether the underlying object is actually a ref
|
|
|
|
fn is_ref(&self) -> Result<bool>;
|
|
|
|
|
2018-02-13 20:11:45 +00:00
|
|
|
/// Get the stored hash.
|
2017-08-27 18:38:26 +00:00
|
|
|
///
|
2018-02-13 20:11:45 +00:00
|
|
|
/// Does not need a `UniqueRefPathGenerator` as it reads the hash stored in the header
|
|
|
|
fn get_hash(&self) -> Result<String>;
|
2017-08-27 18:38:26 +00:00
|
|
|
|
2018-02-13 20:11:45 +00:00
|
|
|
/// Get the referenced path.
|
|
|
|
///
|
|
|
|
/// Does not need a `UniqueRefPathGenerator` as it reads the path stored in the header.
|
|
|
|
fn get_path(&self) -> Result<PathBuf>;
|
2016-06-24 15:31:28 +00:00
|
|
|
|
2018-02-13 20:11:45 +00:00
|
|
|
/// Check whether the referenced file still matches its hash
|
|
|
|
fn hash_valid<RPG: UniqueRefPathGenerator>(&self) -> Result<bool>;
|
2016-08-09 16:56:14 +00:00
|
|
|
|
2018-02-13 20:11:45 +00:00
|
|
|
/// Update the stored hash
|
|
|
|
///
|
|
|
|
/// This updates the hash in the header and moves the entry to the appropriate location
|
|
|
|
fn update_hash<RPG: UniqueRefPathGenerator>(&mut self, store: &Store) -> Result<bool>;
|
2016-06-14 09:08:58 +00:00
|
|
|
|
|
|
|
/// Alias for `r.fs_link_exists() && r.deref().is_file()`
|
2017-08-27 18:38:26 +00:00
|
|
|
fn is_ref_to_file(&self) -> Result<bool> {
|
2018-02-13 20:11:45 +00:00
|
|
|
self.get_path().map(|p| p.is_file())
|
2016-06-14 09:09:19 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/// Alias for `r.fs_link_exists() && r.deref().is_dir()`
|
2017-08-27 18:38:26 +00:00
|
|
|
fn is_ref_to_dir(&self) -> Result<bool> {
|
2018-02-13 20:11:45 +00:00
|
|
|
self.get_path().map(|p| p.is_dir())
|
2016-06-09 17:34:25 +00:00
|
|
|
}
|
|
|
|
|
2016-06-14 09:07:18 +00:00
|
|
|
/// Alias for `!Ref::fs_link_exists()`
|
2017-08-27 18:38:26 +00:00
|
|
|
fn is_dangling(&self) -> Result<bool> {
|
2018-02-13 20:11:45 +00:00
|
|
|
self.get_path().map(|p| !p.exists())
|
2016-06-09 17:34:25 +00:00
|
|
|
}
|
|
|
|
|
2018-02-13 20:11:45 +00:00
|
|
|
}
|
2016-06-24 15:39:58 +00:00
|
|
|
|
2018-02-13 20:11:45 +00:00
|
|
|
provide_kindflag_path!(pub IsRef, "ref.is_ref");
|
2016-06-24 15:39:58 +00:00
|
|
|
|
2018-02-13 20:11:45 +00:00
|
|
|
impl Ref for Entry {
|
2016-06-24 15:39:58 +00:00
|
|
|
|
2018-02-13 20:11:45 +00:00
|
|
|
/// Check whether the underlying object is actually a ref
|
|
|
|
fn is_ref(&self) -> Result<bool> {
|
|
|
|
self.is::<IsRef>().map_err(From::from)
|
2016-06-09 17:34:25 +00:00
|
|
|
}
|
|
|
|
|
2018-02-13 20:11:45 +00:00
|
|
|
fn get_hash(&self) -> Result<String> {
|
|
|
|
unimplemented!()
|
2016-06-09 17:34:25 +00:00
|
|
|
}
|
|
|
|
|
2018-02-13 20:11:45 +00:00
|
|
|
fn get_path(&self) -> Result<PathBuf> {
|
|
|
|
unimplemented!()
|
2016-08-09 16:56:14 +00:00
|
|
|
}
|
|
|
|
|
2018-02-13 20:11:45 +00:00
|
|
|
fn hash_valid<RPG: UniqueRefPathGenerator>(&self) -> Result<bool> {
|
|
|
|
unimplemented!()
|
2016-06-09 17:34:25 +00:00
|
|
|
}
|
|
|
|
|
2018-02-13 20:11:45 +00:00
|
|
|
fn update_hash<RPG: UniqueRefPathGenerator>(&mut self, store: &Store) -> Result<bool> {
|
|
|
|
unimplemented!()
|
2016-07-14 18:37:32 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
}
|
|
|
|
|