softpath 0.2.2

A human-friendly file and directory path manipulation library for Rust.
Documentation 
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

use crate::error::SoftPathError;
use std::fs;
use std::path::{Path, PathBuf};

/// Internal trait providing default implementations for common path operations
pub(crate) trait PathOps {
    fn as_path(&self) -> &Path;

    fn create_file_impl(&self) -> Result<(), SoftPathError> {
        let path = self.as_path().to_path_buf();
        crate::utils::check_path_traversal(&path)?;
        crate::utils::check_symlink_cycles(&path)?;
        
        // Validate parent directory separately to prevent TOCTOU
        if let Some(parent) = path.parent() {
            crate::utils::check_path_traversal(parent)?;
            crate::utils::check_symlink_cycles(parent)?;
            // Use create_dir_all which is more atomic than separate checks
            fs::create_dir_all(parent)?;
        }
        
        // Use OpenOptions for more controlled file creation
        use std::fs::OpenOptions;
        OpenOptions::new()
            .write(true)
            .create_new(true) // Fails if file already exists, preventing race conditions
            .open(&path)
            .map_err(|e| {
                if e.kind() == std::io::ErrorKind::AlreadyExists {
                    std::io::Error::new(
                        std::io::ErrorKind::AlreadyExists,
                        format!("File already exists: {}", path.display())
                    )
                } else {
                    e
                }
            })?;
        Ok(())
    }

    fn write_string_impl(&self, contents: &str) -> Result<(), SoftPathError> {
        let path = self.as_path().to_path_buf();
        crate::utils::check_path_traversal(&path)?;
        crate::utils::check_symlink_cycles(&path)?;
        
        // Validate parent directory separately to prevent TOCTOU
        if let Some(parent) = path.parent() {
            crate::utils::check_path_traversal(parent)?;
            crate::utils::check_symlink_cycles(parent)?;
            fs::create_dir_all(parent)?;
        }
        
        // Use atomic write operation with temporary file to reduce TOCTOU risks
        use std::io::Write;
        let temp_path = path.with_extension("tmp");
        
        // Write to temporary file first
        {
            let mut temp_file = fs::File::create(&temp_path)?;
            temp_file.write_all(contents.as_bytes())?;
            temp_file.sync_all()?; // Ensure data is written to disk
        }
        
        // Atomically rename temporary file to target (atomic on most filesystems)
        fs::rename(&temp_path, &path)?;
        Ok(())
    }

    fn remove_impl(&self) -> Result<(), SoftPathError> {
        let path = self.as_path().to_path_buf();
        crate::utils::check_path_traversal(&path)?;
        crate::utils::check_symlink_cycles(&path)?;
        if path.is_dir() {
            fs::remove_dir_all(path)?;
        } else {
            fs::remove_file(path)?;
        }
        Ok(())
    }

    fn is_empty_impl(&self) -> Result<bool, SoftPathError> {
        let path = self.as_path().to_path_buf();
        crate::utils::check_path_traversal(&path)?;
        crate::utils::check_symlink_cycles(&path)?;
        if path.is_file() {
            Ok(fs::metadata(&path)?.len() == 0)
        } else if path.is_dir() {
            Ok(fs::read_dir(&path)?.next().is_none())
        } else {
            Ok(false)
        }
    }

    fn is_hidden_impl(&self) -> Result<bool, SoftPathError> {
        let path = self.as_path().to_path_buf();
        crate::utils::check_path_traversal(&path)?;
        crate::utils::check_symlink_cycles(&path)?;
        #[cfg(windows)]
        {
            use std::os::windows::fs::MetadataExt;
            let attr = fs::metadata(&path)?.file_attributes();
            Ok((attr & 0x2) != 0) // FILE_ATTRIBUTE_HIDDEN
        }
        #[cfg(unix)]
        {
            Ok(path
                .file_name()
                .map(|s| s.to_string_lossy().to_string())
                .is_some_and(|s| s.starts_with('.')))
        }
    }
}

// Basic PathOps implementations
impl PathOps for PathBuf {
    fn as_path(&self) -> &Path {
        self.as_path()
    }
}

impl PathOps for &Path {
    fn as_path(&self) -> &Path {
        self
    }
}