memora 0.6.3

// Copyright 2020 Andreas Kurth
//
// SPDX-License-Identifier: (Apache-2.0 OR MIT)

//! Filesystem utilities

use crate::error::{Error, Result};
use log::{debug, trace};
use std::fs;
use std::path::{Path, PathBuf};

/// Recursively create a directory and all of its parent components if they are missing.
pub fn create_dir<P: AsRef<Path>>(path: P) -> Result<()> {
    let path = path.as_ref();
    trace!("Recursively creating directory {:?}.", path);
    std::fs::create_dir_all(path)
        .map_err(|cause| Error::chain(format!("Could not create directory {:?}:", path), cause))
}

/// Return the file type of a path without following symlinks.
pub fn file_type<P: AsRef<Path>>(path: P) -> Result<std::fs::FileType> {
    let path = path.as_ref();
    trace!("Determining file type of {:?}.", path);
    let metadata = path
        .symlink_metadata()
        .map_err(|cause| Error::chain(format!("Could not get metadata of {:?}:", path), cause))?;
    Ok(metadata.file_type())
}

/// Copy symlink without dereferencing it.  If the target already exists, it is overwritten.
fn copy_symlink<P: AsRef<Path>, Q: AsRef<Path>>(from: P, to: Q) -> Result<()> {
    let from = from.as_ref();
    let to = to.as_ref();
    trace!("Copying symlink {:?} to {:?}.", from, to);
    let link_target = std::fs::read_link(from).map_err(|cause| {
        Error::chain(format!("Could not read source symlink {:?}:", from), cause)
    })?;
    // Remove `to` to prevent collisions if it exists.
    let _foo = std::fs::remove_file(to);
    std::os::unix::fs::symlink(link_target, to).map_err(|cause| {
        Error::chain(
            format!("Could not create destination symlink {:?}:", to),
            cause,
        )
    })?;
    Ok(())
}

/// Recursively create parent components to a path if they are missing.
pub fn create_parents<P: AsRef<Path>>(path: P) -> Result<()> {
    let path = path.as_ref();
    trace!("Creating parents of {:?}.", path);
    let path_parent = match path.parent() {
        None => Error::result(format!(
            "Could not determine parent directory of {:?}",
            path
        )),
        Some(p) => Ok(p),
    }?;
    create_dir(&path_parent)
}

/// Recursively copy path `from` to path `to`.
///
/// - `to` must not be a subpath of `from`.
/// - If parent directories of `to` do not exist, they are created.
/// - Symlinks are not followed but copied "verbatim".
/// - Files that exist under `to` and under `from` are overwritten with the file under `from`.
/// - Files that exist under `to` but not under `from` are not touched.
pub fn copy<P, Q>(from: P, to: Q) -> Result<()>
where
    P: AsRef<Path>,
    Q: AsRef<Path>,
{
    let from = from.as_ref();
    let to = to.as_ref();
    debug!("Copying {:?} to {:?}.", from, to);
    // The case when `from` itself is a symlink needs to be handled specially because `WalkDir`
    // always dereferences the given (top-level) path.
    if file_type(from)?.is_symlink() {
        trace!("From path is a symlink.");
        create_parents(to)?;
        copy_symlink(from, to)?;
    } else {
        for entry in walkdir::WalkDir::new(from).follow_links(false) {
            // Determine path to entry.
            let entry_path = entry
                .as_ref()
                .map_err(|_cause| Error::new(format!("Cannot handle filesystem entry {:?}", entry)))
                .map(|entry| entry.path())?;
            // Determine relative path of *from* entry.
            let relative_from = entry_path.strip_prefix(from).map_err(|cause| {
                Error::chain(format!("Cannot relativize path {:?}:", entry_path), cause)
            })?;
            let from = entry_path;
            // Determine absolute path of *to* entry.
            let to = if relative_from != Path::new("") {
                to.join(relative_from)
            } else {
                PathBuf::from(to)
            };
            trace!("Copying {:?} to {:?}.", from, to);
            // Create parent directory of `to` (if it does not exist).
            create_parents(&to)?;
            // Query metadata (without following symlinks).
            let filetype = file_type(&from)?;
            if filetype.is_file() {
                // Copy `from` file using standard `fs::copy`.
                fs::copy(&from, &to).map_err(|cause| {
                    Error::chain(
                        format!("Could not copy file {:?} to {:?}!", from, to),
                        cause,
                    )
                })?;
            } else if filetype.is_dir() {
                create_dir(&to)?;
            } else if filetype.is_symlink() {
                copy_symlink(&from, &to)?;
            } else {
                Error::result(format!("Can not copy file type {:?}", filetype))?;
            }
        }
    }
    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::error::{Error, Result};
    use crate::test_util::{create_file, create_symlink, write_file};
    use std::path::PathBuf;
    use tempdir::TempDir;

    fn setup() -> Result<(TempDir, TempDir)> {
        fn create_tmp_dir(suffix: &str) -> Result<TempDir> {
            TempDir::new(&format!("memora-test-fs{}", suffix))
                .map_err(|cause| Error::chain("Could not create temporary directory:", cause))
        }
        let src_dir = create_tmp_dir("-src")?;
        let dst_dir = create_tmp_dir("-dst")?;
        Ok((src_dir, dst_dir))
    }

    fn setup_single_file(path: &Path) -> Result<(TempDir, TempDir, PathBuf, PathBuf)> {
        let (src_dir, dst_dir) = setup()?;
        let src_path = src_dir.path().join(&path);
        if let Some(parent) = src_path.parent() {
            create_dir(parent)?;
        };
        let mut src_file = create_file(&src_path)?;
        write_file(&mut src_file, "some content")?;
        let dst_path = dst_dir.path().join(&path);
        Ok((src_dir, dst_dir, src_path, dst_path))
    }

    fn diff<P: AsRef<Path> + std::fmt::Debug>(f1: P, f2: P) -> Result<()> {
        if file_diff::diff(f1.as_ref().to_str().unwrap(), f2.as_ref().to_str().unwrap()) {
            Ok(())
        } else {
            Error::result(format!("file {:?} differs from file {:?}", &f1, &f2))
        }
    }

    #[test]
    /// Copy file that is new at destination.
    fn copy_file_new() -> Result<()> {
        let (_src_dir, _dst_dir, src_path, dst_path) = setup_single_file(Path::new("some_file"))?;
        copy(&src_path, &dst_path)?;
        diff(&src_path, &dst_path)
    }

    #[test]
    /// Copy file that exists at destination, overwriting the latter.
    fn copy_file_existing() -> Result<()> {
        let (_src_dir, _dst_dir, src_path, dst_path) = setup_single_file(Path::new("some_file"))?;
        let mut dst_file = create_file(&dst_path)?;
        write_file(&mut dst_file, "other content")?;
        copy(&src_path, &dst_path)?;
        diff(&src_path, &dst_path)
    }

    #[test]
    /// Copy file that is new at destination and is part of a subdirectory that does not exist at
    /// destination.
    fn copy_file_new_subdir() -> Result<()> {
        let (_src_dir, _dst_dir, src_path, dst_path) =
            setup_single_file(Path::new("subdir/some_file"))?;
        copy(&src_path, &dst_path)?;
        diff(&src_path, &dst_path)
    }

    #[test]
    /// Copy symlink to nonexisting target.
    fn copy_symlink_to_nonexisting_target() -> Result<()> {
        let (src_dir, dst_dir) = setup()?;
        let src_path = src_dir.path().join("sym_link");
        create_symlink(Path::new("sym_target"), &src_path)?;
        let dst_path = dst_dir.path().join("sym_link");
        copy(&src_path, &dst_path)?;
        assert_eq!(src_path.read_link().unwrap(), dst_path.read_link().unwrap());
        Ok(())
    }

    #[test]
    /// Copy symlink to existing target.
    fn copy_symlink_to_existing_target() -> Result<()> {
        let (src_dir, dst_dir) = setup()?;
        let src_path = src_dir.path().join("sym_link");
        create_symlink(Path::new("sym_target"), &src_path)?;
        let dst_path = dst_dir.path().join("sym_link");
        create_file(&dst_path)?;
        copy(&src_path, &dst_path)?;
        assert_eq!(src_path.read_link().unwrap(), dst_path.read_link().unwrap());
        Ok(())
    }

    #[test]
    /// Copy directory with a symlink to a nonexisting file to another directory that partially
    /// exists.
    fn copy_dir() -> Result<()> {
        let (src_dir, dst_dir, src_file, dst_file) =
            setup_single_file(Path::new("some/subdir/file"))?;
        {
            create_parents(&dst_file)?;
            let mut dst_file = create_file(&dst_file)?;
            write_file(&mut dst_file, "bad")?;
        }
        let src_path = src_dir.path().join("some");
        let nonexisting = Path::new("some/nonexisting/path");
        create_symlink(nonexisting, &src_path.join("some_symlink"))?;
        let dst_path = dst_dir.path().join("some");
        create_dir(dst_path.join("subdir"))?;
        create_file(dst_path.join("subdir/another_file"))?;
        create_dir(dst_path.join("another_subdir"))?;
        copy(&src_path, &dst_path)?;
        assert!(dst_file.is_file());
        diff(&src_file, &dst_file)?;
        assert!(dst_path.join("subdir/another_file").is_file());
        assert!(dst_path.join("another_subdir").is_dir());
        let dst_symlink = dst_path.join("some_symlink");
        assert!(dst_symlink
            .symlink_metadata()
            .unwrap()
            .file_type()
            .is_symlink());
        assert_eq!(dst_symlink.read_link().unwrap(), nonexisting);
        Ok(())
    }
}