rustic_rs/commands/

diff.rs

//! `diff` subcommand

use crate::{Application, RUSTIC_APP, repository::IndexedRepo, status_err};

use abscissa_core::{Command, Runnable, Shutdown};
use clap::ValueHint;
use itertools::{EitherOrBoth, Itertools};
use log::{debug, info};

use std::{
    cmp::Ordering,
    fmt::{Display, Write},
    path::{Path, PathBuf},
};

use anyhow::{Context, Result, bail};

use rustic_core::{
    Excludes, LocalDestination, LocalSource, LocalSourceFilterOptions, LocalSourceSaveOptions,
    LsOptions, ProgressBars, ProgressType, ReadSource, ReadSourceEntry, RusticResult,
    repofile::{Node, NodeType},
};

#[cfg(feature = "tui")]
use crate::commands::tui;

/// `diff` subcommand
#[derive(clap::Parser, Command, Debug)]
pub(crate) struct DiffCmd {
    /// Reference snapshot/path (uses latest, if no snapshot is given, then compare with local path)
    ///
    /// Snapshot can be identified the following ways: "01a2b3c4" or "latest" or "latest~N" (N >= 0)
    #[clap(value_name = "SNAPSHOT1[:PATH1]")]
    snap1: Option<String>,

    /// New snapshot/path (uses PATH2 = PATH1, if not given; uses local path if no snapshot is given)
    ///
    /// Snapshot can be identified the following ways: "01a2b3c4" or "latest" or "latest~N" (N >= 0)
    #[clap(value_name = "SNAPSHOT2[:PATH2]|PATH2", value_hint = ValueHint::AnyPath)]
    snap2: Option<String>,

    /// show differences in metadata
    #[clap(long)]
    metadata: bool,

    /// don't check for different file contents
    #[clap(long)]
    no_content: bool,

    /// only show differences for identical files, this can be used for a bitrot test on the local path
    #[clap(long, conflicts_with = "no_content")]
    only_identical: bool,

    #[cfg(feature = "tui")]
    /// Run in interactive UI mode
    #[clap(long, short)]
    pub interactive: bool,

    /// Exclude options
    #[clap(flatten, next_help_heading = "Exclude options")]
    excludes: Excludes,

    /// Exclude options for local source
    #[clap(flatten, next_help_heading = "Exclude options for local source")]
    ignore_opts: LocalSourceFilterOptions,
}

impl Runnable for DiffCmd {
    fn run(&self) {
        if let Err(err) = RUSTIC_APP
            .config()
            .repository
            .run_indexed(|repo| self.inner_run(repo))
        {
            status_err!("{}", err);
            RUSTIC_APP.shutdown(Shutdown::Crash);
        };
    }
}

impl DiffCmd {
    fn inner_run(&self, repo: IndexedRepo) -> Result<()> {
        let config = RUSTIC_APP.config();

        let self_snap1 = self.snap1.as_deref().unwrap_or_default();
        let self_snap2 = self.snap2.as_deref().unwrap_or_default();
        let (id1, path1) = self
            .snap1
            .as_ref()
            .map_or((Some("latest"), None), |snap1| arg_to_snap_path(snap1));
        let (id2, path2) = self
            .snap2
            .as_ref()
            .map_or((None, None), |snap2| arg_to_snap_path(snap2));

        match (id1, id2) {
            (Some(id1), Some(id2)) => {
                // diff between two snapshots
                let snaps = repo.get_snapshots_from_strs(&[id1, id2], |sn| {
                    config.snapshot_filter.matches(sn)
                })?;

                let snap1 = &snaps[0];
                let snap2 = &snaps[1];
                let path1 = path1.unwrap_or("");
                let path2 = path2.unwrap_or(path1);
                info!(
                    "comparing {}:{path1} ({self_snap1}) with {}:{path2} ({self_snap2})",
                    snap1.id, snap2.id,
                );

                #[cfg(feature = "tui")]
                if self.interactive {
                    use tui::summary::SummaryMap;
                    return tui::run(|progress| {
                        let p = progress.progress(
                            ProgressType::Spinner,
                            "starting rustic in interactive mode...",
                        );
                        p.finish();
                        // create app and run it
                        let diff = tui::Diff::new(
                            &repo,
                            snap1.clone(),
                            snap2.clone(),
                            path1,
                            path2,
                            SummaryMap::default(),
                        )?;
                        tui::run_app(progress.terminal, diff)
                    });
                }

                let node1 = repo.node_from_snapshot_and_path(snap1, path1)?;
                let node2 = repo.node_from_snapshot_and_path(snap2, path2)?;

                let ls_opts = LsOptions::default().excludes(self.excludes.clone());
                diff(
                    repo.ls(&node1, &ls_opts)?,
                    repo.ls(&node2, &ls_opts)?,
                    self.no_content,
                    |_path, node1, node2| Ok(node1.content == node2.content),
                    self.metadata,
                )?;
            }
            (Some(id1), None) => {
                // diff between snapshot and local path
                #[cfg(feature = "tui")]
                if self.interactive {
                    bail!("interactive diff with local path is not yet implemented!");
                }
                let snap1 =
                    repo.get_snapshot_from_str(id1, |sn| config.snapshot_filter.matches(sn))?;
                let (path1, path2) = match (path1, path2) {
                    (Some(path1), Some(path2)) => (path1, path2),
                    (None, Some(path2)) => ("", path2),
                    (Some(""), None) => ("", "."),
                    (Some(path1), None) => (path1, path1),
                    (None, None) => {
                        if snap1.paths.iter().count() == 1 {
                            let path = snap1.paths.iter().next().unwrap();
                            (path.as_str(), path.as_str())
                        } else {
                            ("", ".")
                        }
                    }
                };
                info!(
                    "comparing {}:{path1} ({self_snap1}) with local dir {path2} ({self_snap2})",
                    snap1.id
                );

                let node1 = repo.node_from_snapshot_and_path(&snap1, path1)?;
                let local = LocalDestination::new(path2, false, !node1.is_dir())?;
                let path2 = PathBuf::from(path2);
                let is_dir = path2
                    .metadata()
                    .with_context(|| format!("Error accessing {path2:?}"))?
                    .is_dir();
                let src = LocalSource::new(
                    LocalSourceSaveOptions::default(),
                    &self.excludes,
                    &self.ignore_opts,
                    &[&path2],
                )?
                .entries()
                .map(|item| -> RusticResult<_> {
                    let ReadSourceEntry { path, node, .. } = item?;
                    let path = if is_dir {
                        // remove given path prefix for dirs as local path
                        path.strip_prefix(&path2).unwrap().to_path_buf()
                    } else {
                        // ensure that we really get the filename if local path is a file
                        path2.file_name().unwrap().into()
                    };
                    Ok((path, node))
                });

                if self.only_identical {
                    diff_identical(
                        repo.ls(&node1, &LsOptions::default())?,
                        src,
                        |path, node1, _node2| identical_content_local(&local, &repo, path, node1),
                    )?;
                } else {
                    diff(
                        repo.ls(&node1, &LsOptions::default())?,
                        src,
                        self.no_content,
                        |path, node1, _node2| identical_content_local(&local, &repo, path, node1),
                        self.metadata,
                    )?;
                }
            }
            (None, _) => {
                bail!("cannot use local path as first argument");
            }
        };

        Ok(())
    }
}

/// Split argument into snapshot id and path
///
/// # Arguments
///
/// * `arg` - argument to split
///
/// # Returns
///
/// A tuple of the snapshot id and the path
pub fn arg_to_snap_path(arg: &str) -> (Option<&str>, Option<&str>) {
    match arg.split_once(':') {
        Some(("local", path)) => (None, Some(path)),
        Some((id, path)) => (Some(id), Some(path)),
        None => {
            if arg == "local" {
                (None, None)
            } else if arg.contains('/') {
                (None, Some(arg))
            } else {
                (Some(arg), None)
            }
        }
    }
}

/// Check if the content of a file in a snapshot is identical to the content of a local file
///
/// # Arguments
///
/// * `local` - local destination
/// * `repo` - repository
/// * `path` - path of the file in the snapshot
/// * `node` - node of the file in the snapshot
///
/// # Errors
///
/// * [`RepositoryErrorKind::IdNotFound`] - If the id of a blob is not found in the repository
///
/// # Returns
///
/// `true` if the content of the file in the snapshot is identical to the content of the local file,
/// `false` otherwise
///
/// [`RepositoryErrorKind::IdNotFound`]: rustic_core::error::RepositoryErrorKind::IdNotFound
fn identical_content_local(
    local: &LocalDestination,
    repo: &IndexedRepo,
    path: &Path,
    node: &Node,
) -> Result<bool> {
    let Some(mut open_file) = local.get_matching_file(path, node.meta.size) else {
        return Ok(false);
    };

    for id in node.content.iter().flatten() {
        let ie = repo.get_index_entry(id)?;
        let length: u64 = ie.data_length().into();
        if !id.blob_matches_reader(length, &mut open_file) {
            return Ok(false);
        }
    }
    Ok(true)
}

#[derive(Clone, Copy)]
pub enum NodeTypeDiff {
    Identical,
    Added,
    Removed,
    Changed,
    MetaDataChanged,
}

#[derive(Clone, Copy)]
pub enum NodeDiff {
    File(NodeTypeDiff),
    Dir(NodeTypeDiff),
    Symlink(NodeTypeDiff),
    Other(NodeTypeDiff),
    TypeChanged,
}
use NodeTypeDiff::*;

impl NodeDiff {
    pub fn from_node_type(t: &NodeType, diff: NodeTypeDiff) -> Self {
        match t {
            NodeType::File => Self::File(diff),
            NodeType::Dir => Self::Dir(diff),
            NodeType::Symlink { .. } => Self::Symlink(diff),
            _ => Self::Other(diff),
        }
    }

    pub fn from(
        node1: Option<&Node>,
        node2: Option<&Node>,
        equal_content: impl Fn(&Node, &Node) -> bool,
    ) -> Self {
        Self::try_from(node1, node2, |node1, node2| Ok(equal_content(node1, node2))).unwrap()
    }

    pub fn try_from(
        node1: Option<&Node>,
        node2: Option<&Node>,
        equal_content: impl Fn(&Node, &Node) -> Result<bool>,
    ) -> Result<Self> {
        let result = match (node1, node2) {
            (None, Some(node2)) => Self::from_node_type(&node2.node_type, Added),
            (Some(node1), None) => Self::from_node_type(&node1.node_type, Removed),
            (Some(node1), Some(node2)) => {
                let are_both_symlink = matches!(&node1.node_type, NodeType::Symlink { .. })
                    && matches!(&node2.node_type, NodeType::Symlink { .. });
                match &node1.node_type {
                    // if node1.node_type != node2.node_type, they could be different symlinks,
                    // for this reason we check:
                    // that their type is different AND that they are not both symlinks
                    tpe if tpe != &node2.node_type && !are_both_symlink => Self::TypeChanged,
                    NodeType::Symlink { .. }
                        if node1.node_type.to_link() != node2.node_type.to_link() =>
                    {
                        Self::Symlink(Changed)
                    }
                    t => {
                        if !equal_content(node1, node2)? {
                            Self::from_node_type(t, Changed)
                        } else if node1.meta != node2.meta {
                            Self::from_node_type(t, MetaDataChanged)
                        } else {
                            Self::from_node_type(t, Identical)
                        }
                    }
                }
            }
            (None, None) => bail!("nothing to compare!"),
        };
        Ok(result)
    }

    pub fn is_identical(self) -> bool {
        match self {
            Self::File(diff) | Self::Dir(diff) | Self::Symlink(diff) | Self::Other(diff) => {
                matches!(diff, Identical)
            }
            Self::TypeChanged => false,
        }
    }

    pub fn ignore_metadata(self) -> Self {
        match self {
            Self::File(MetaDataChanged) => Self::File(Identical),
            Self::Dir(MetaDataChanged) => Self::Dir(Identical),
            Self::Symlink(MetaDataChanged) => Self::Symlink(Identical),
            Self::Other(MetaDataChanged) => Self::Other(Identical),
            d => d,
        }
    }
}

impl Display for NodeDiff {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let c = match self {
            Self::File(diff) | Self::Dir(diff) | Self::Symlink(diff) | Self::Other(diff) => {
                match diff {
                    Identical => '=',
                    Added => '+',
                    Removed => '-',
                    Changed => 'M',
                    MetaDataChanged => 'U',
                }
            }
            Self::TypeChanged => 'T',
        };
        f.write_char(c)
    }
}

#[derive(Default)]
pub struct DiffTypeStatistic {
    pub identical: usize,
    pub added: usize,
    pub removed: usize,
    pub changed: usize,
    pub metadata_changed: usize,
}

impl DiffTypeStatistic {
    pub fn apply(&mut self, diff: NodeTypeDiff) {
        match diff {
            Identical => self.identical += 1,
            Added => self.added += 1,
            Removed => self.removed += 1,
            Changed => self.changed += 1,
            MetaDataChanged => self.metadata_changed += 1,
        }
    }

    pub fn is_empty(&self) -> bool {
        self.identical + self.added + self.removed + self.changed + self.metadata_changed == 0
    }
}

impl Display for DiffTypeStatistic {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_fmt(format_args!(
            "{} =, {} +, {} -, {} M, {} U",
            self.identical, self.added, self.removed, self.changed, self.metadata_changed
        ))?;
        Ok(())
    }
}

/// Statistics about the differences listed with the [`DiffCmd`] command
#[derive(Default)]
pub struct DiffStatistics {
    pub files: DiffTypeStatistic,
    pub dirs: DiffTypeStatistic,
    pub symlinks: DiffTypeStatistic,
    pub others: DiffTypeStatistic,
    pub node_type_changed: usize,
}

impl DiffStatistics {
    pub fn apply(&mut self, diff: NodeDiff) {
        match diff {
            NodeDiff::File(t) => self.files.apply(t),
            NodeDiff::Dir(t) => self.dirs.apply(t),
            NodeDiff::Symlink(t) => self.symlinks.apply(t),
            NodeDiff::Other(t) => self.others.apply(t),
            NodeDiff::TypeChanged => self.node_type_changed += 1,
        };
    }
}

impl Display for DiffStatistics {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        if !self.files.is_empty() {
            f.write_fmt(format_args!("Files   : {}\n", self.files))?;
        }
        if !self.dirs.is_empty() {
            f.write_fmt(format_args!("Dirs    : {}\n", self.dirs))?;
        }
        if !self.symlinks.is_empty() {
            f.write_fmt(format_args!("Symlinks: {}\n", self.symlinks))?;
        }
        if !self.others.is_empty() {
            f.write_fmt(format_args!("Others  : {}\n", self.others))?;
        }

        // node type change
        if self.node_type_changed != 0 {
            f.write_fmt(format_args!(
                "NodeType:\t{} changed\n",
                self.node_type_changed
            ))?;
        }

        Ok(())
    }
}

/// Compare two streams of nodes and print the differences
///
/// # Arguments
///
/// * `tree_streamer1` - first stream of nodes
/// * `tree_streamer2` - second stream of nodes
/// * `no_content` - don't check for different file contents
/// * `file_identical` - function to check if the content of two files is identical
/// * `metadata` - show differences in metadata
///
/// # Errors
///
// TODO!: add errors!
fn diff(
    tree_streamer1: impl Iterator<Item = RusticResult<(PathBuf, Node)>>,
    tree_streamer2: impl Iterator<Item = RusticResult<(PathBuf, Node)>>,
    no_content: bool,
    file_identical: impl Fn(&Path, &Node, &Node) -> Result<bool>,
    metadata: bool,
) -> Result<()> {
    let compare_streamer = tree_streamer1.merge_join_by(tree_streamer2, |left, right| {
        let Ok(left) = left else {
            return Ordering::Less;
        };
        let Ok(right) = right else {
            return Ordering::Greater;
        };
        left.0.cmp(&right.0)
    });

    let mut diff_statistics = DiffStatistics::default();

    for item in compare_streamer {
        let (path, node1, node2) = match item {
            EitherOrBoth::Left(l) => {
                let l = l?;
                (l.0, Some(l.1), None)
            }
            EitherOrBoth::Right(r) => {
                let r = r?;
                (r.0, None, Some(r.1))
            }
            EitherOrBoth::Both(l, r) => {
                let (r, l) = (r?, l?);
                (l.0, Some(l.1), Some(r.1))
            }
        };

        let mut diff = NodeDiff::try_from(node1.as_ref(), node2.as_ref(), |n1, n2| {
            Ok(match n1.node_type {
                NodeType::File => no_content || file_identical(&path, n1, n2)?,
                NodeType::Dir => true,
                _ => false,
            })
        })?;
        if !metadata {
            diff = diff.ignore_metadata();
        }

        if !diff.is_identical() {
            println!("{diff}    {path:?}");
        }
        diff_statistics.apply(diff);
    }

    println!("{diff_statistics}");
    Ok(())
}

fn diff_identical(
    mut tree_streamer1: impl Iterator<Item = RusticResult<(PathBuf, Node)>>,
    mut tree_streamer2: impl Iterator<Item = RusticResult<(PathBuf, Node)>>,
    file_identical: impl Fn(&Path, &Node, &Node) -> Result<bool>,
) -> Result<()> {
    let mut item1 = tree_streamer1.next().transpose()?;
    let mut item2 = tree_streamer2.next().transpose()?;

    let mut checked: usize = 0;

    loop {
        match (&item1, &item2) {
            (None, None) => break,
            (Some(i1), None) => {
                let path = &i1.0;
                debug!("not checking {}: not present in target", path.display());
                item1 = tree_streamer1.next().transpose()?;
            }
            (None, Some(i2)) => {
                let path = &i2.0;
                debug!("not checking {}: not present in source", path.display());
                item2 = tree_streamer2.next().transpose()?;
            }
            (Some(i1), Some(i2)) if i1.0 < i2.0 => {
                let path = &i1.0;
                debug!("not checking {}: not present in target", path.display());
                item1 = tree_streamer1.next().transpose()?;
            }
            (Some(i1), Some(i2)) if i1.0 > i2.0 => {
                let path = &i2.0;
                debug!("not checking {}: not present in source", path.display());
                item2 = tree_streamer2.next().transpose()?;
            }
            (Some(i1), Some(i2)) => {
                let path = &i1.0;
                let node1 = &i1.1;
                let node2 = &i2.1;

                if matches!(&node1.node_type, NodeType::File)
                    && matches!(&node2.node_type, NodeType::File)
                    && node1.meta == node2.meta
                {
                    debug!("checking {}", path.display());
                    checked += 1;
                    if !file_identical(path, node1, node2)? {
                        println!("M    {path:?}");
                    }
                } else {
                    debug!("not checking {}: metadata changed", path.display());
                }
                item1 = tree_streamer1.next().transpose()?;
                item2 = tree_streamer2.next().transpose()?;
            }
        }
    }
    println!("checked {checked} files.");
    Ok(())
}