nu_path/

dots.rs

#[cfg(windows)]
use omnipath::WinPathExt;
use std::path::{Component, Path, PathBuf, Prefix};

/// Normalize the path, expanding occurrences of n-dots.
///
/// It performs the same normalization as `nu_path::components()`, except it also expands n-dots,
/// such as "..." and "....", into multiple "..".
///
/// The resulting path will use platform-specific path separators, regardless of what path separators was used in the input.
pub fn expand_ndots(path: impl AsRef<Path>) -> PathBuf {
    // Returns whether a path component is n-dots.
    fn is_ndots(s: &std::ffi::OsStr) -> bool {
        s.as_encoded_bytes().iter().all(|c| *c == b'.') && s.len() >= 3
    }

    let path = path.as_ref();

    let mut result = PathBuf::with_capacity(path.as_os_str().len());
    let mut has_special_prefix = false;
    for component in crate::components(path) {
        match component {
            Component::Normal(s) if is_ndots(s) => {
                let n = s.len();
                // Push ".." to the path (n - 1) times.
                for _ in 0..n - 1 {
                    result.push("..");
                }
            }
            Component::Prefix(prefix) => {
                match prefix.kind() {
                    Prefix::Disk(_) => {
                        // Here, only the disk letter gets parsed as prefix,
                        // so the following RootDir component makes sense
                    }
                    _ => {
                        has_special_prefix = true;
                    }
                }
                result.push(component)
            }
            Component::RootDir if has_special_prefix => {
                // Ignore; this would add a trailing backslash to the path that wasn't in the input
            }
            _ => result.push(component),
        }
    }

    result
}

/// Normalize the path, expanding occurrences of "." and "..".
///
/// It performs the same normalization as `nu_path::components()`, except it also expands ".."
/// when its preceding component is a normal component, ignoring the possibility of symlinks.
/// In other words, it operates on the lexical structure of the path.
///
/// This won't expand "/.." even though the parent directory of "/" is often
/// considered to be itself.
///
/// The resulting path will use platform-specific path separators, regardless of what path separators was used in the input.
pub fn expand_dots(path: impl AsRef<Path>) -> PathBuf {
    // Check if the last component of the path is a normal component.
    fn last_component_is_normal(path: &Path) -> bool {
        matches!(path.components().next_back(), Some(Component::Normal(_)))
    }

    let path = path.as_ref();

    let mut has_special_prefix = false;
    let mut result = PathBuf::with_capacity(path.as_os_str().len());
    for component in crate::components(path) {
        match component {
            Component::ParentDir if last_component_is_normal(&result) => {
                result.pop();
            }
            Component::CurDir if last_component_is_normal(&result) => {
                // no-op
            }
            Component::Prefix(prefix) => {
                match prefix.kind() {
                    Prefix::Disk(_) => {
                        // Here, only the disk letter gets parsed as prefix,
                        // so the following RootDir component makes sense
                    }
                    _ => {
                        has_special_prefix = true;
                    }
                }
                result.push(component)
            }
            Component::RootDir if has_special_prefix => {
                // Ignore; this would add a trailing backslash to the path that wasn't in the input
            }
            _ => {
                let prev_component = result.components().next_back();
                if prev_component == Some(Component::RootDir) && component == Component::ParentDir {
                    continue;
                }
                result.push(component)
            }
        }
    }

    simiplified(&result)
}

/// Expand ndots, but only if it looks like it probably contains them, because there is some lossy
/// path normalization that happens.
pub fn expand_ndots_safe(path: impl AsRef<Path>) -> PathBuf {
    let string = path.as_ref().to_string_lossy();

    // Use ndots if it contains at least `...`, since that's the minimum trigger point.
    // Don't use it if it contains ://, because that looks like a URL scheme and the path normalization
    // will mess with that.
    // Don't use it if it starts with `./`, as to not break golang wildcard syntax
    // (since generally you're probably not using `./` with ndots)
    if string.contains("...") && !string.contains("://") && !string.starts_with("./") {
        expand_ndots(path)
    } else {
        path.as_ref().to_owned()
    }
}

#[cfg(windows)]
fn simiplified(path: &std::path::Path) -> PathBuf {
    path.to_winuser_path()
        .unwrap_or_else(|_| path.to_path_buf())
}

#[cfg(not(windows))]
fn simiplified(path: &std::path::Path) -> PathBuf {
    path.to_path_buf()
}

#[cfg(test)]
mod test_expand_ndots {
    use super::*;
    use crate::assert_path_eq;

    #[test]
    fn empty_path() {
        let path = Path::new("");
        assert_path_eq!(expand_ndots(path), "");
    }

    #[test]
    fn root_dir() {
        let path = Path::new("/");
        let expected = if cfg!(windows) { "\\" } else { "/" };
        assert_path_eq!(expand_ndots(path), expected);
    }

    #[test]
    fn two_dots() {
        let path = Path::new("..");
        assert_path_eq!(expand_ndots(path), "..");
    }

    #[test]
    fn three_dots() {
        let path = Path::new("...");
        let expected = if cfg!(windows) { r"..\.." } else { "../.." };
        assert_path_eq!(expand_ndots(path), expected);
    }

    #[test]
    fn five_dots() {
        let path = Path::new(".....");
        let expected = if cfg!(windows) {
            r"..\..\..\.."
        } else {
            "../../../.."
        };
        assert_path_eq!(expand_ndots(path), expected);
    }

    #[test]
    fn three_dots_with_trailing_slash() {
        let path = Path::new("/tmp/.../");
        let expected = if cfg!(windows) {
            r"\tmp\..\..\"
        } else {
            "/tmp/../../"
        };
        assert_path_eq!(expand_ndots(path), expected);
    }

    #[test]
    fn filenames_with_dots() {
        let path = Path::new("...foo.../");
        let expected = if cfg!(windows) {
            r"...foo...\"
        } else {
            "...foo.../"
        };
        assert_path_eq!(expand_ndots(path), expected);
    }

    #[test]
    fn multiple_ndots() {
        let path = Path::new("..././...");
        let expected = if cfg!(windows) {
            r"..\..\..\.."
        } else {
            "../../../.."
        };
        assert_path_eq!(expand_ndots(path), expected);
    }

    #[test]
    fn trailing_dots() {
        let path = Path::new("/foo/bar/..");
        let expected = if cfg!(windows) {
            r"\foo\bar\.."
        } else {
            "/foo/bar/.."
        };
        assert_path_eq!(expand_ndots(path), expected);
    }

    #[test]
    fn leading_dot_slash() {
        let path = Path::new("./...");
        assert_path_eq!(expand_ndots_safe(path), "./...");
    }

    #[test]
    fn unc_share_no_dots() {
        let path = Path::new(r"\\server\share");
        assert_path_eq!(expand_ndots(path), path);
    }

    #[test]
    fn unc_file_no_dots() {
        let path = Path::new(r"\\server\share\dir\file.nu");
        assert_path_eq!(expand_ndots(path), path);
    }

    #[test]
    fn verbatim_no_dots() {
        let path = Path::new(r"\\?\pictures\elephants");
        assert_path_eq!(expand_ndots(path), path);
    }

    #[test]
    fn verbatim_unc_share_no_dots() {
        let path = Path::new(r"\\?\UNC\server\share");
        assert_path_eq!(expand_ndots(path), path);
    }

    #[test]
    fn verbatim_unc_file_no_dots() {
        let path = Path::new(r"\\?\UNC\server\share\dir\file.nu");
        assert_path_eq!(expand_ndots(path), path);
    }

    #[test]
    fn verbatim_disk_no_dots() {
        let path = Path::new(r"\\?\c:\");
        assert_path_eq!(expand_ndots(path), path);
    }

    #[test]
    fn device_path_no_dots() {
        let path = Path::new(r"\\.\CON");
        assert_path_eq!(expand_ndots(path), path);
    }

    #[test]
    fn disk_no_dots() {
        let path = Path::new(r"c:\Users\Ellie\nu_scripts");
        assert_path_eq!(expand_ndots(path), path);
    }
}

#[cfg(test)]
mod test_expand_dots {
    use super::*;
    use crate::assert_path_eq;

    #[test]
    fn empty_path() {
        let path = Path::new("");
        assert_path_eq!(expand_dots(path), "");
    }

    #[test]
    fn single_dot() {
        let path = Path::new("./");
        let expected = if cfg!(windows) { r".\" } else { "./" };
        assert_path_eq!(expand_dots(path), expected);
    }

    #[test]
    fn more_single_dots() {
        let path = Path::new("././.");
        let expected = ".";
        assert_path_eq!(expand_dots(path), expected);
    }

    #[test]
    fn double_dots() {
        let path = Path::new("../../..");
        let expected = if cfg!(windows) {
            r"..\..\.."
        } else {
            "../../.."
        };
        assert_path_eq!(expand_dots(path), expected);
    }

    #[test]
    fn backtrack_once() {
        let path = Path::new("/foo/bar/../baz/");
        let expected = if cfg!(windows) {
            r"\foo\baz\"
        } else {
            "/foo/baz/"
        };
        assert_path_eq!(expand_dots(path), expected);
    }

    #[test]
    fn backtrack_to_root() {
        let path = Path::new("/foo/bar/../../../../baz");
        let expected = if cfg!(windows) { r"\baz" } else { "/baz" };
        assert_path_eq!(expand_dots(path), expected);
    }

    #[test]
    fn unc_share_no_dots() {
        let path = Path::new(r"\\server\share");
        assert_path_eq!(expand_dots(path), path);
    }

    #[test]
    fn unc_file_no_dots() {
        let path = Path::new(r"\\server\share\dir\file.nu");
        assert_path_eq!(expand_dots(path), path);
    }

    #[test]
    #[ignore = "bug in upstream library"]
    fn verbatim_no_dots() {
        // omnipath::windows::sys::Path::to_winuser_path seems to turn this verbatim path into a device path
        let path = Path::new(r"\\?\pictures\elephants");
        assert_path_eq!(expand_dots(path), path);
    }

    #[cfg_attr(not(windows), ignore = "only for Windows")]
    #[test]
    fn verbatim_unc_share_no_dots() {
        let path = Path::new(r"\\?\UNC\server\share");
        let expected = Path::new(r"\\server\share");
        assert_path_eq!(expand_dots(path), expected);
    }

    #[cfg_attr(not(windows), ignore = "only for Windows")]
    #[test]
    fn verbatim_unc_file_no_dots() {
        let path = Path::new(r"\\?\UNC\server\share\dir\file.nu");
        let expected = Path::new(r"\\server\share\dir\file.nu");
        assert_path_eq!(expand_dots(path), expected);
    }

    #[cfg_attr(not(windows), ignore = "only for Windows")]
    #[test]
    fn verbatim_disk_no_dots() {
        let path = Path::new(r"\\?\C:\");
        let expected = Path::new(r"C:\");
        assert_path_eq!(expand_dots(path), expected);
    }

    #[test]
    fn device_path_no_dots() {
        let path = Path::new(r"\\.\CON");
        assert_path_eq!(expand_dots(path), path);
    }

    #[test]
    fn disk_no_dots() {
        let path = Path::new(r"c:\Users\Ellie\nu_scripts");
        assert_path_eq!(expand_dots(path), path);
    }
}