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
#![cfg(any(doc, all(unix, feature = "std")))]
use std::env;
use std::io;
#[cfg(not(doc))]
use std::os::unix::ffi::OsStrExt;
use std::path::Component;
use std::path::{Path, PathBuf};
pub trait PosixPathExt: Sealed {
/// [Unix only] Make a POSIX path absolute without changing its semantics.
///
/// Unlike canonicalize the path does not need to exist. Symlinks and `..`
/// components will not be resolved.
///
/// # Example
///
/// ```
/// #[cfg(unix)]
/// {
/// use omnipath::posix::PosixPathExt;
/// use std::path::Path;
/// use std::env::current_dir;
///
/// let path = Path::new(r"path/to/..//./file");
/// assert_eq!(
/// path.posix_absolute().unwrap(),
/// current_dir().unwrap().join("path/to/../file")
/// )
/// }
/// ```
fn posix_absolute(&self) -> io::Result<PathBuf>;
/// [Unix only] Make a POSIX path lexically absolute.
///
/// Unlike `canonicalize` the path does not need to exist. Symlinks will not be resolved.
/// Unlike [`posix_absolute`][PosixPathExt::posix_absolute] this resolves `..` components by popping the
/// parent component. This means that it may resolve to a different path
/// than would be resolved by passing the path directly to the OS.
///
/// Usually this is not the preferred behaviour.
///
/// # Example
///
/// ```
/// #[cfg(unix)]
/// {
/// use omnipath::posix::PosixPathExt;
/// use std::path::Path;
/// use std::env::current_dir;
///
/// let path = Path::new(r"path/to/..//./file");
/// assert_eq!(
/// path.posix_lexically_absolute().unwrap(),
/// current_dir().unwrap().join("path/file")
/// )
/// }
/// ```
fn posix_lexically_absolute(&self) -> io::Result<PathBuf>;
/// [Unix only] Make a POSIX path absolute relative to a provided working
/// directory without changing its semantics.
///
/// See [`PosixPathExt::posix_absolute`] for a version of this function that
/// is relative to [`std::env::current_dir()`] instead.
///
/// # Example
///
/// ```
/// #[cfg(unix)]
/// {
/// use omnipath::posix::PosixPathExt;
/// use std::path::Path;
/// let working_dir = Path::new("/tmp");
/// let path = Path::new("path/to/..//./file");
///
/// assert_eq!(
/// &path.posix_absolute_from(working_dir).unwrap(),
/// Path::new("/tmp/path/to/../file"),
/// )
/// }
/// ```
///
/// ```
/// #[cfg(unix)]
/// {
/// use omnipath::posix::PosixPathExt;
/// use std::path::Path;
/// use std::env::current_dir;
/// let root = Path::new("/tmp/foo//.././bar");
/// let path = Path::new(r"path/to/..//./file");
/// assert_eq!(
/// &path.posix_absolute_from(root).unwrap(),
/// Path::new("/tmp/foo/../bar/path/to/../file"),
/// );
/// }
/// ```
fn posix_absolute_from(&self, path: &Path) -> io::Result<PathBuf>;
/// [Unix only] Make a POSIX path lexically absolute relative to a provided
/// current working directory.
///
/// Unlike `canonicalize` the path does not need to exist. Symlinks will not be resolved.
/// Unlike [`posix_absolute`][PosixPathExt::posix_absolute] this resolves `..` components by popping the
/// parent component. This means that it may resolve to a different path
/// than would be resolved by passing the path directly to the OS.
///
/// Usually this is not the preferred behaviour.
///
/// See [`PosixPathExt::posix_lexically_absolute`] for a version of this function that
/// is relative to [`std::env::current_dir()`] instead.
///
/// # Example
///
/// ```
/// #[cfg(unix)]
/// {
/// use omnipath::posix::PosixPathExt;
/// use std::path::Path;
/// use std::env::current_dir;
/// let root = Path::new("/tmp");
/// let path = Path::new(r"path/to/..//./file");
/// assert_eq!(
/// &path.posix_lexically_absolute_from(root).unwrap(),
/// Path::new("/tmp/path/file")
/// );
/// }
/// ```
///
/// ```
/// #[cfg(unix)]
/// {
/// use omnipath::posix::PosixPathExt;
/// use std::path::Path;
/// use std::env::current_dir;
/// let root = Path::new("/tmp/foo//.././bar");
/// let path = Path::new(r"path/to/..//./file");
/// assert_eq!(
/// &path.posix_lexically_absolute_from(root).unwrap(),
/// Path::new("/tmp/bar/path/file")
/// );
/// }
/// ```
fn posix_lexically_absolute_from(&self, cwd: &Path) -> io::Result<PathBuf>;
}
impl PosixPathExt for Path {
fn posix_absolute(&self) -> io::Result<PathBuf> {
posix_absolute_from(self, env::current_dir)
}
fn posix_lexically_absolute(&self) -> io::Result<PathBuf> {
posix_lexically_absolute_from(self, env::current_dir)
}
fn posix_absolute_from(&self, cwd: &Path) -> io::Result<PathBuf> {
if !cwd.is_absolute() {
return Err(cwd_error());
}
posix_absolute_from(self, || posix_absolute_from(cwd, || unreachable!()))
}
fn posix_lexically_absolute_from(&self, cwd: &Path) -> io::Result<PathBuf> {
if !cwd.is_absolute() {
return Err(cwd_error());
}
posix_lexically_absolute_from(self, || {
posix_lexically_absolute_from(cwd, || unreachable!())
})
}
}
fn cwd_error() -> io::Error {
io::Error::new(
io::ErrorKind::InvalidInput,
"expected an absolute path as the current working directory",
)
}
mod private {
pub trait Sealed {}
impl Sealed for std::path::Path {}
}
use private::Sealed;
fn posix_lexically_absolute_from<F>(path: &Path, get_cwd: F) -> io::Result<PathBuf>
where
F: FnOnce() -> io::Result<PathBuf>,
{
// This is mostly a wrapper around collecting `Path::components`, with
// exceptions made where this conflicts with the POSIX specification.
// See 4.13 Pathname Resolution, IEEE Std 1003.1-2017
// https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap04.html#tag_04_13
// Get the components, skipping the redundant leading "." component if it exists.
let mut components = path.strip_prefix(".").unwrap_or(path).components();
let path_os = path.as_os_str().as_bytes();
let mut normalized = if path.is_absolute() {
// "If a pathname begins with two successive <slash> characters, the
// first component following the leading <slash> characters may be
// interpreted in an implementation-defined manner, although more than
// two leading <slash> characters shall be treated as a single <slash>
// character."
if path_os.starts_with(b"//") && !path_os.starts_with(b"///") {
components.next();
PathBuf::from("//")
} else {
PathBuf::new()
}
} else {
get_cwd()?
};
components.for_each(|component| {
if component == Component::ParentDir {
normalized.pop();
} else {
normalized.push(component);
}
});
// "Interfaces using pathname resolution may specify additional constraints
// when a pathname that does not name an existing directory contains at
// least one non- <slash> character and contains one or more trailing
// <slash> characters".
// A trailing <slash> is also meaningful if "a symbolic link is
// encountered during pathname resolution".
if path_os.ends_with(b"/") {
normalized.push("");
}
Ok(normalized)
}
fn posix_absolute_from<F>(path: &Path, get_cwd: F) -> io::Result<PathBuf>
where
F: FnOnce() -> io::Result<PathBuf>,
{
// This is mostly a wrapper around collecting `Path::components`, with
// exceptions made where this conflicts with the POSIX specification.
// See 4.13 Pathname Resolution, IEEE Std 1003.1-2017
// https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap04.html#tag_04_13
// Get the components, skipping the redundant leading "." component if it exists.
let mut components = path.strip_prefix(".").unwrap_or(path).components();
let path_os = path.as_os_str().as_bytes();
let mut normalized = if path.is_absolute() {
// "If a pathname begins with two successive <slash> characters, the
// first component following the leading <slash> characters may be
// interpreted in an implementation-defined manner, although more than
// two leading <slash> characters shall be treated as a single <slash>
// character."
if path_os.starts_with(b"//") && !path_os.starts_with(b"///") {
components.next();
PathBuf::from("//")
} else {
PathBuf::new()
}
} else {
get_cwd()?
};
normalized.extend(components);
// "Interfaces using pathname resolution may specify additional constraints
// when a pathname that does not name an existing directory contains at
// least one non- <slash> character and contains one or more trailing
// <slash> characters".
// A trailing <slash> is also meaningful if "a symbolic link is
// encountered during pathname resolution".
if path_os.ends_with(b"/") {
normalized.push("");
}
Ok(normalized)
}