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 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
use std::{
collections::HashMap,
fs::{self, File},
io::{ErrorKind, Read, Seek, SeekFrom, Write},
path::PathBuf,
sync::Arc,
};
use anyhow::Result;
use bytes::Bytes;
use dirs::cache_dir;
use log::{trace, warn};
use walkdir::WalkDir;
use crate::{
backend::{FileType, ReadBackend, WriteBackend},
error::{CacheBackendErrorKind, RusticResult},
id::Id,
};
/// Backend that caches data.
///
/// This backend caches data in a directory.
/// It can be used to cache data from a remote backend.
///
/// # Type Parameters
///
/// * `BE` - The backend to cache.
#[derive(Clone, Debug)]
pub struct CachedBackend {
/// The backend to cache.
be: Arc<dyn WriteBackend>,
/// The cache.
cache: Cache,
}
impl CachedBackend {
/// Create a new [`CachedBackend`] from a given backend.
///
/// # Type Parameters
///
/// * `BE` - The backend to cache.
pub fn new_cache(be: Arc<dyn WriteBackend>, cache: Cache) -> Arc<dyn WriteBackend> {
Arc::new(Self { be, cache })
}
}
impl ReadBackend for CachedBackend {
/// Returns the location of the backend as a String.
fn location(&self) -> String {
self.be.location()
}
/// Lists all files with their size of the given type.
///
/// # Arguments
///
/// * `tpe` - The type of the files to list.
///
/// # Errors
///
/// If the backend does not support listing files.
///
/// # Returns
///
/// A vector of tuples containing the id and size of the files.
fn list_with_size(&self, tpe: FileType) -> Result<Vec<(Id, u32)>> {
let list = self.be.list_with_size(tpe)?;
if tpe.is_cacheable() {
self.cache.remove_not_in_list(tpe, &list)?;
}
Ok(list)
}
/// Reads full data of the given file.
///
/// # Arguments
///
/// * `tpe` - The type of the file.
/// * `id` - The id of the file.
///
/// # Errors
///
/// * [`CacheBackendErrorKind::FromIoError`] - If the file could not be read.
///
/// # Returns
///
/// The data read.
///
/// [`CacheBackendErrorKind::FromIoError`]: crate::error::CacheBackendErrorKind::FromIoError
fn read_full(&self, tpe: FileType, id: &Id) -> Result<Bytes> {
if tpe.is_cacheable() {
match self.cache.read_full(tpe, id) {
Ok(Some(data)) => return Ok(data),
Ok(None) => {}
Err(err) => warn!("Error in cache backend: {err}"),
}
let res = self.be.read_full(tpe, id);
if let Ok(data) = &res {
_ = self.cache.write_bytes(tpe, id, data.clone());
}
res
} else {
self.be.read_full(tpe, id)
}
}
/// Reads partial data of the given file.
///
/// # Arguments
///
/// * `tpe` - The type of the file.
/// * `id` - The id of the file.
/// * `cacheable` - Whether the file is cacheable.
/// * `offset` - The offset to read from.
/// * `length` - The length to read.
///
/// # Errors
///
/// * [`CacheBackendErrorKind::FromIoError`] - If the file could not be read.
///
/// # Returns
///
/// The data read.
///
/// [`CacheBackendErrorKind::FromIoError`]: crate::error::CacheBackendErrorKind::FromIoError
fn read_partial(
&self,
tpe: FileType,
id: &Id,
cacheable: bool,
offset: u32,
length: u32,
) -> Result<Bytes> {
if cacheable || tpe.is_cacheable() {
match self.cache.read_partial(tpe, id, offset, length) {
Ok(Some(data)) => return Ok(data),
Ok(None) => {}
Err(err) => warn!("Error in cache backend: {err}"),
};
// read full file, save to cache and return partial content
match self.be.read_full(tpe, id) {
Ok(data) => {
let range = offset as usize..(offset + length) as usize;
_ = self.cache.write_bytes(tpe, id, data.clone());
Ok(Bytes::copy_from_slice(&data.slice(range)))
}
error => error,
}
} else {
self.be.read_partial(tpe, id, cacheable, offset, length)
}
}
fn needs_warm_up(&self) -> bool {
self.be.needs_warm_up()
}
fn warm_up(&self, tpe: FileType, id: &Id) -> Result<()> {
self.be.warm_up(tpe, id)
}
}
impl WriteBackend for CachedBackend {
/// Creates the backend.
fn create(&self) -> Result<()> {
self.be.create()
}
/// Writes the given data to the given file.
///
/// If the file is cacheable, it will also be written to the cache.
///
/// # Arguments
///
/// * `tpe` - The type of the file.
/// * `id` - The id of the file.
/// * `cacheable` - Whether the file is cacheable.
/// * `buf` - The data to write.
fn write_bytes(&self, tpe: FileType, id: &Id, cacheable: bool, buf: Bytes) -> Result<()> {
if cacheable || tpe.is_cacheable() {
_ = self.cache.write_bytes(tpe, id, buf.clone());
}
self.be.write_bytes(tpe, id, cacheable, buf)
}
/// Removes the given file.
///
/// If the file is cacheable, it will also be removed from the cache.
///
/// # Arguments
///
/// * `tpe` - The type of the file.
/// * `id` - The id of the file.
fn remove(&self, tpe: FileType, id: &Id, cacheable: bool) -> Result<()> {
if cacheable || tpe.is_cacheable() {
_ = self.cache.remove(tpe, id);
}
self.be.remove(tpe, id, cacheable)
}
}
/// Backend that caches data in a directory.
#[derive(Clone, Debug)]
pub struct Cache {
/// The path to the cache.
path: PathBuf,
}
impl Cache {
/// Creates a new [`Cache`] with the given id.
///
/// If no path is given, the cache will be created in the default cache directory.
///
/// # Arguments
///
/// * `id` - The id of the cache.
/// * `path` - The path to the cache.
///
/// # Errors
///
/// * [`CacheBackendErrorKind::NoCacheDirectory`] - If no path is given and the default cache directory could not be determined.
/// * [`CacheBackendErrorKind::FromIoError`] - If the cache directory could not be created.
///
/// [`CacheBackendErrorKind::NoCacheDirectory`]: crate::error::CacheBackendErrorKind::NoCacheDirectory
/// [`CacheBackendErrorKind::FromIoError`]: crate::error::CacheBackendErrorKind::FromIoError
pub fn new(id: Id, path: Option<PathBuf>) -> RusticResult<Self> {
let mut path = path.unwrap_or({
let mut dir = cache_dir().ok_or_else(|| CacheBackendErrorKind::NoCacheDirectory)?;
dir.push("rustic");
dir
});
fs::create_dir_all(&path).map_err(CacheBackendErrorKind::FromIoError)?;
cachedir::ensure_tag(&path).map_err(CacheBackendErrorKind::FromIoError)?;
path.push(id.to_hex());
fs::create_dir_all(&path).map_err(CacheBackendErrorKind::FromIoError)?;
Ok(Self { path })
}
/// Returns the path to the location of this [`Cache`].
///
/// # Panics
///
/// Panics if the path is not valid unicode.
// TODO: Does this need to panic? Result?
#[must_use]
pub fn location(&self) -> &str {
self.path.to_str().unwrap()
}
/// Returns the path to the directory of the given type.
///
/// # Arguments
///
/// * `tpe` - The type of the directory.
/// * `id` - The id of the directory.
#[must_use]
pub fn dir(&self, tpe: FileType, id: &Id) -> PathBuf {
let hex_id = id.to_hex();
self.path.join(tpe.dirname()).join(&hex_id[0..2])
}
/// Returns the path to the given file.
///
/// # Arguments
///
/// * `tpe` - The type of the file.
/// * `id` - The id of the file.
#[must_use]
pub fn path(&self, tpe: FileType, id: &Id) -> PathBuf {
let hex_id = id.to_hex();
self.path
.join(tpe.dirname())
.join(&hex_id[0..2])
.join(hex_id)
}
/// Lists all files with their size of the given type.
///
/// # Arguments
///
/// * `tpe` - The type of the files to list.
///
/// # Errors
///
/// * [`CacheBackendErrorKind::FromIoError`] - If the cache directory could not be read.
/// * [`IdErrorKind::HexError`] - If the string is not a valid hexadecimal string
///
/// [`CacheBackendErrorKind::FromIoError`]: crate::error::CacheBackendErrorKind::FromIoError
/// [`IdErrorKind::HexError`]: crate::error::IdErrorKind::HexError
pub fn list_with_size(&self, tpe: FileType) -> RusticResult<HashMap<Id, u32>> {
let path = self.path.join(tpe.dirname());
let walker = WalkDir::new(path)
.into_iter()
.filter_map(walkdir::Result::ok)
.filter(|e| {
// only use files with length of 64 which are valid hex
e.file_type().is_file()
&& e.file_name().len() == 64
&& e.file_name().is_ascii()
&& e.file_name()
.to_str()
.unwrap()
.chars()
.all(|c| c.is_ascii_digit() || ('a'..='f').contains(&c))
})
.map(|e| {
(
Id::from_hex(e.file_name().to_str().unwrap()).unwrap(),
// handle errors in metadata by returning a size of 0
e.metadata().map_or(0, |m| m.len().try_into().unwrap_or(0)),
)
});
Ok(walker.collect())
}
/// Removes all files from the cache that are not in the given list.
///
/// # Arguments
///
/// * `tpe` - The type of the files.
/// * `list` - The list of files.
///
/// # Errors
///
/// * [`CacheBackendErrorKind::FromIoError`] - If the cache directory could not be read.
///
/// [`CacheBackendErrorKind::FromIoError`]: crate::error::CacheBackendErrorKind::FromIoError
pub fn remove_not_in_list(&self, tpe: FileType, list: &Vec<(Id, u32)>) -> RusticResult<()> {
let mut list_cache = self.list_with_size(tpe)?;
// remove present files from the cache list
for (id, size) in list {
if let Some(cached_size) = list_cache.remove(id) {
if &cached_size != size {
// remove cache files with non-matching size
self.remove(tpe, id)?;
}
}
}
// remove all remaining (i.e. not present in repo) cache files
for id in list_cache.keys() {
self.remove(tpe, id)?;
}
Ok(())
}
/// Reads full data of the given file.
///
/// # Arguments
///
/// * `tpe` - The type of the file.
/// * `id` - The id of the file.
///
/// # Errors
///
/// * [`CacheBackendErrorKind::FromIoError`] - If the file could not be read.
///
/// [`CacheBackendErrorKind::FromIoError`]: crate::error::CacheBackendErrorKind::FromIoError
pub fn read_full(&self, tpe: FileType, id: &Id) -> RusticResult<Option<Bytes>> {
trace!("cache reading tpe: {:?}, id: {}", &tpe, &id);
match fs::read(self.path(tpe, id)) {
Ok(data) => {
trace!("cache hit!");
Ok(Some(data.into()))
}
Err(err) if err.kind() == ErrorKind::NotFound => Ok(None),
Err(err) => Err(CacheBackendErrorKind::FromIoError(err).into()),
}
}
/// Reads partial data of the given file.
///
/// # Arguments
///
/// * `tpe` - The type of the file.
/// * `id` - The id of the file.
/// * `offset` - The offset to read from.
/// * `length` - The length to read.
///
/// # Errors
///
/// * [`CacheBackendErrorKind::FromIoError`] - If the file could not be read.
///
/// [`CacheBackendErrorKind::FromIoError`]: crate::error::CacheBackendErrorKind::FromIoError
pub fn read_partial(
&self,
tpe: FileType,
id: &Id,
offset: u32,
length: u32,
) -> RusticResult<Option<Bytes>> {
trace!(
"cache reading tpe: {:?}, id: {}, offset: {}",
&tpe,
&id,
&offset
);
let mut file = match File::open(self.path(tpe, id)) {
Ok(file) => file,
Err(err) if err.kind() == ErrorKind::NotFound => return Ok(None),
Err(err) => return Err(CacheBackendErrorKind::FromIoError(err).into()),
};
_ = file
.seek(SeekFrom::Start(u64::from(offset)))
.map_err(CacheBackendErrorKind::FromIoError)?;
let mut vec = vec![0; length as usize];
file.read_exact(&mut vec)
.map_err(CacheBackendErrorKind::FromIoError)?;
trace!("cache hit!");
Ok(Some(vec.into()))
}
/// Writes the given data to the given file.
///
/// # Arguments
///
/// * `tpe` - The type of the file.
/// * `id` - The id of the file.
/// * `buf` - The data to write.
///
/// # Errors
///
/// * [`CacheBackendErrorKind::FromIoError`] - If the file could not be written.
///
/// [`CacheBackendErrorKind::FromIoError`]: crate::error::CacheBackendErrorKind::FromIoError
pub fn write_bytes(&self, tpe: FileType, id: &Id, buf: Bytes) -> RusticResult<()> {
trace!("cache writing tpe: {:?}, id: {}", &tpe, &id);
fs::create_dir_all(self.dir(tpe, id)).map_err(CacheBackendErrorKind::FromIoError)?;
let filename = self.path(tpe, id);
let mut file = fs::OpenOptions::new()
.create(true)
.write(true)
.open(filename)
.map_err(CacheBackendErrorKind::FromIoError)?;
file.write_all(&buf)
.map_err(CacheBackendErrorKind::FromIoError)?;
Ok(())
}
/// Removes the given file.
///
/// # Arguments
///
/// * `tpe` - The type of the file.
/// * `id` - The id of the file.
///
/// # Errors
///
/// * [`CacheBackendErrorKind::FromIoError`] - If the file could not be removed.
///
/// [`CacheBackendErrorKind::FromIoError`]: crate::error::CacheBackendErrorKind::FromIoError
pub fn remove(&self, tpe: FileType, id: &Id) -> RusticResult<()> {
trace!("cache writing tpe: {:?}, id: {}", &tpe, &id);
let filename = self.path(tpe, id);
fs::remove_file(filename).map_err(CacheBackendErrorKind::FromIoError)?;
Ok(())
}
}