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 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476
//! A library for reading duplicity backups.
//!
//! This library provides utilities to manage duplicity backups [1]. Backup files could be prensent
//! in the local file system, or can be accessed remotely, provided that the right backend is
//! implemented. This is a rust version of the original duplicity project, that is written in
//! Python. The goal is to provide a library to be used for different purposes (e.g. a command
//! line utility, a fusion filesystem, etc.) and to improve overall performances. Compatibility
//! with the original duplicity backup format is guaranteed.
//!
//! [1]: http://duplicity.nongnu.org/
//!
//! # Example
//! In this example we open a directory containing a backup, and print informations about the files
//! in all the snapshots.
//!
//! ```
//! use ruplicity::Backup;
//! use ruplicity::backend::local::LocalBackend;
//! use ruplicity::time_utils::TimeDisplay;
//!
//! // use the local backend to open a path in the file system containing a backup
//! let backend = LocalBackend::new("tests/backups/single_vol");
//! let backup = Backup::new(backend).unwrap();
//! for snapshot in backup.snapshots().unwrap() {
//! println!("Snapshot {}", snapshot.time().into_local_display());
//! println!("{}", snapshot.entries().unwrap());
//! }
//! ```
#![deny(missing_copy_implementations,
missing_docs,
trivial_casts, trivial_numeric_casts,
unsafe_code,
unstable_features,
unused_import_braces, unused_qualifications)]
#![cfg_attr(feature = "nightly", allow(unstable_features))]
#![cfg_attr(feature = "lints", feature(plugin))]
#![cfg_attr(feature = "lints", plugin(clippy))]
extern crate byteorder;
extern crate flate2;
extern crate regex;
extern crate tabwriter;
extern crate tar;
extern crate time;
#[macro_use]
extern crate try_opt;
mod macros;
mod tarext; // TODO #25: remove when tar crate is available
pub mod time_utils;
pub mod backend;
pub mod collections;
pub mod signatures;
use std::cell::{Ref, RefCell};
use std::fmt::{self, Display, Formatter};
use std::io;
use time::Timespec;
pub use backend::Backend;
use collections::{BackupChain, BackupSet, Collections};
use signatures::Chain;
/// A top level representation of a duplicity backup.
#[derive(Debug)]
pub struct Backup<B> {
backend: B,
collections: Collections,
signatures: Vec<RefCell<Option<Chain>>>,
}
/// An iterator over the snapshots in a backup.
pub struct Snapshots<'a> {
set_iter: CollectionsIter<'a>,
chain_id: usize,
sig_id: usize,
backup: &'a ResourceCache,
}
/// A snapshot in a backup.
pub struct Snapshot<'a> {
set: &'a BackupSet,
// the number of the parent backup chain, starting from zero
chain_id: usize,
sig_id: usize,
backup: &'a ResourceCache,
}
/// Contains the files present in a certain backup snapshot.
pub struct SnapshotEntries<'a> {
chain: Ref<'a, Option<Chain>>,
sig_id: usize,
}
struct CollectionsIter<'a> {
chain_iter: collections::ChainIter<'a, BackupChain>,
incset_iter: Option<collections::BackupSetIter<'a>>,
}
/// Allows to be used as an interface for `Backup` struct without generic parameters. This allows
/// to reduce code size, since we don't have to godegen the entire module for different Backend
/// generic parameters. This trait is used as an interface between `Backup` and its inner
/// components.
trait ResourceCache {
fn _collections(&self) -> &Collections;
fn _signature_chain(&self, chain_id: usize) -> io::Result<Ref<Option<Chain>>>;
}
impl<B: Backend> Backup<B> {
/// Opens an existig backup by using the given backend.
///
/// # Errors
/// This function will return an error whenever the backend returns an error in a file
/// operation. If the backend can't provide access to backup files, because they are
/// unavailable or non-existing, an empty backup could be returned.
///
/// # Examples
/// ```
/// use ruplicity::Backup;
/// use ruplicity::backend::local::LocalBackend;
///
/// // use the local backend to open a path in the file system containing a backup
/// let backend = LocalBackend::new("tests/backups/single_vol");
/// let backup = Backup::new(backend).unwrap();
/// println!("Got backup with {} snapshots!", backup.snapshots().unwrap().count());
/// ```
pub fn new(backend: B) -> io::Result<Self> {
let files = try!(backend.file_names());
let collections = Collections::from_filenames(files);
let signatures = collections.signature_chains().map(|_| RefCell::new(None)).collect();
Ok(Backup {
backend: backend,
collections: collections,
signatures: signatures,
})
}
/// Constructs an iterator over the snapshots currently present in this backup.
pub fn snapshots(&self) -> io::Result<Snapshots> {
let set_iter = CollectionsIter {
chain_iter: self.collections.backup_chains(),
incset_iter: None,
};
// in future, when we will add lazy collections,
// this could fail, so we add a Result in advance
Ok(Snapshots {
set_iter: set_iter,
chain_id: 0,
sig_id: 0,
backup: self,
})
}
}
impl<'a> Iterator for Snapshots<'a> {
type Item = Snapshot<'a>;
fn next(&mut self) -> Option<Self::Item> {
// first test if we have a valid iterator to an incset
if let Some(ref mut incset_iter) = self.set_iter.incset_iter {
// we have a set iter, so return the next element if present
if let Some(inc_set) = incset_iter.next() {
self.sig_id += 1;
return Some(Snapshot {
set: inc_set,
chain_id: self.chain_id - 1,
sig_id: self.sig_id,
backup: self.backup,
});
}
}
// the current incset is exausted or not present,
// we need to advance the chain and return the next full set if present,
// otherwise the job is finished
if let Some(chain) = self.set_iter.chain_iter.next() {
self.chain_id += 1;
self.sig_id = 0;
self.set_iter.incset_iter = Some(chain.inc_sets());
Some(Snapshot {
set: chain.full_set(),
chain_id: self.chain_id - 1,
sig_id: self.sig_id,
backup: self.backup,
})
} else {
None
}
}
}
impl<'a> Snapshots<'a> {
/// Returns the low level representation of the snapshots.
pub fn as_collections(&self) -> &Collections {
self.backup._collections()
}
}
impl<'a> Snapshot<'a> {
/// Returns the time in which the snapshot has been taken.
pub fn time(&self) -> Timespec {
self.set.end_time()
}
/// Returns whether the snapshot is a full backup.
///
/// A full snapshot does not depend on previous snapshots.
pub fn is_full(&self) -> bool {
self.set.is_full()
}
/// Returns whether the snapshot is an incremental backup.
///
/// An incremental snapshot depends on all the previous incremental snapshots and the first
/// previous full snapshot. This set of dependent snapshots is called "chain".
pub fn is_incremental(&self) -> bool {
self.set.is_incremental()
}
/// Returns the number of volumes contained in the snapshot.
pub fn num_volumes(&self) -> usize {
self.set.num_volumes()
}
/// Returns the low level representation of the snapshot.
pub fn as_backup_set(&self) -> &BackupSet {
self.set
}
/// Returns the files and directories present in the snapshot.
///
/// Be aware that using this functionality means that all the signature files in the current
/// backup chain must be loaded, and this could take some time, depending on the file access
/// provided by the backend and the signatures size.
pub fn entries(&self) -> io::Result<SnapshotEntries> {
let sig = try!(self.backup._signature_chain(self.chain_id));
if self.sig_id < sig.as_ref().unwrap().snapshots().len() {
Ok(SnapshotEntries {
chain: sig,
sig_id: self.sig_id,
})
} else {
Err(not_found("The signature chain is incomplete"))
}
}
}
impl<'a> SnapshotEntries<'a> {
/// Returns the signatures representation for the entries.
///
/// This function can be used to retrieve information about the files in the snapshot.
pub fn as_signature(&self) -> signatures::SnapshotEntries {
self.chain.as_ref().unwrap().snapshots().nth(self.sig_id).unwrap().files()
}
}
impl<'a> Display for SnapshotEntries<'a> {
fn fmt(&self, f: &mut Formatter) -> fmt::Result {
self.as_signature().into_display().fmt(f)
}
}
impl<B: Backend> ResourceCache for Backup<B> {
fn _collections(&self) -> &Collections {
&self.collections
}
fn _signature_chain(&self, chain_id: usize) -> io::Result<Ref<Option<Chain>>> {
{
// check if there is a cached value
let mut sig = self.signatures[chain_id].borrow_mut();
if sig.is_none() {
// compute signatures now
if let Some(sigchain) = self.collections.signature_chains().nth(chain_id) {
let new_sig = try!(Chain::from_sigchain(sigchain, &self.backend));
*sig = Some(new_sig);
} else {
return Err(not_found("The given backup snapshot does not have a \
corresponding signature"));
}
}
}
// need to close previous scope to borrow again
// return the cached value
Ok(self.signatures[chain_id].borrow())
}
}
fn not_found(msg: &str) -> io::Error {
io::Error::new(io::ErrorKind::NotFound, msg)
}
#[cfg(test)]
mod test {
use super::*;
use backend::local::LocalBackend;
use collections::{BackupSet, Collections};
use signatures::{Chain, Entry};
use time_utils::parse_time_str;
use std::path::{Path, PathBuf};
use time::Timespec;
#[derive(Debug, Eq, PartialEq)]
struct SnapshotTest {
time: Timespec,
is_full: bool,
num_volumes: usize,
}
#[derive(Debug, Clone, Eq, PartialEq)]
struct EntryTest {
path: PathBuf,
mtime: Timespec,
uname: String,
gname: String,
}
impl EntryTest {
pub fn from_entry(file: &Entry) -> Self {
EntryTest {
path: file.path().to_owned(),
mtime: file.mtime(),
uname: file.username().unwrap().to_owned(),
gname: file.groupname().unwrap().to_owned(),
}
}
pub fn from_info(path: &str,
mtime: &str,
uname: &str,
gname: &str)
-> Self {
EntryTest {
path: Path::new(path).to_path_buf(),
mtime: parse_time_str(mtime).unwrap(),
uname: uname.to_owned(),
gname: gname.to_owned(),
}
}
}
fn from_backup_set(set: &BackupSet, full: bool) -> SnapshotTest {
SnapshotTest {
time: set.end_time(),
is_full: full,
num_volumes: set.num_volumes(),
}
}
fn from_collection(coll: &Collections) -> Vec<SnapshotTest> {
let mut result = Vec::new();
for chain in coll.backup_chains() {
result.push(from_backup_set(chain.full_set(), true));
for set in chain.inc_sets() {
result.push(from_backup_set(set, false));
}
}
result
}
fn to_test_snapshot<B: Backend>(backup: &Backup<B>) -> Vec<SnapshotTest> {
backup.snapshots()
.unwrap()
.map(|s| {
assert!(s.is_full() != s.is_incremental());
SnapshotTest {
time: s.time(),
is_full: s.is_full(),
num_volumes: s.num_volumes(),
}
})
.collect()
}
fn single_vol_signature_chain() -> Chain {
let backend = LocalBackend::new("tests/backups/single_vol");
let filenames = backend.file_names().unwrap();
let coll = Collections::from_filenames(filenames);
Chain::from_sigchain(coll.signature_chains().next().unwrap(), &backend).unwrap()
}
fn from_sigchain(chain: &Chain) -> Vec<Vec<EntryTest>> {
chain.snapshots()
.map(|s| {
s.files()
.map(|f| EntryTest::from_entry(&f))
.filter(|f| f.path.to_str().is_some())
.collect::<Vec<_>>()
})
.collect::<Vec<_>>()
}
fn from_backup<B: Backend>(backup: &Backup<B>) -> Vec<Vec<EntryTest>> {
backup.snapshots()
.unwrap()
.map(|s| {
s.entries()
.unwrap()
.as_signature()
.map(|f| EntryTest::from_entry(&f))
.filter(|f| f.path.to_str().is_some())
.collect::<Vec<_>>()
})
.collect::<Vec<_>>()
}
#[test]
fn same_collections_single_vol() {
let backend = LocalBackend::new("tests/backups/single_vol");
let filenames = backend.file_names().unwrap();
let coll = Collections::from_filenames(filenames);
let backup = Backup::new(backend).unwrap();
let expected = from_collection(&coll);
let actual = to_test_snapshot(&backup);
assert_eq!(actual, expected);
}
#[test]
fn same_collections_multi_chain() {
let backend = LocalBackend::new("tests/backups/multi_chain");
let filenames = backend.file_names().unwrap();
let coll = Collections::from_filenames(filenames);
let backup = Backup::new(backend).unwrap();
let expected = from_collection(&coll);
let actual = to_test_snapshot(&backup);
assert_eq!(actual, expected);
}
#[test]
fn same_files() {
let sigchain = single_vol_signature_chain();
let expected = from_sigchain(&sigchain);
let backend = LocalBackend::new("tests/backups/single_vol");
let backup = Backup::new(backend).unwrap();
let actual = from_backup(&backup);
assert_eq!(actual, expected);
}
#[test]
fn multi_chain_files() {
let backend = LocalBackend::new("tests/backups/multi_chain");
let backup = Backup::new(backend).unwrap();
let actual = from_backup(&backup);
let expected = vec![vec![make_entry_test("", "20160108t223141z"),
make_entry_test("file", "20160108t222924z")],
vec![make_entry_test("", "20160108t223153z"),
make_entry_test("file", "20160108t223153z")],
vec![make_entry_test("", "20160108t223206z"),
make_entry_test("file", "20160108t223206z")],
vec![make_entry_test("", "20160108t223215z"),
make_entry_test("file", "20160108t223215z")]];
assert_eq!(actual, expected);
fn make_entry_test(path: &str, mtime: &str) -> EntryTest {
EntryTest::from_info(path, mtime, "michele", "michele")
}
}
}