Rename cap-primitives' rmdir to remove_dir.

Author: sunfishcode

cap-async-std/src/fs/dir.rs

@@ -7,8 +7,8 @@ use async_std::os::wasi::{
 use async_std::{fs, io};
 use cap_primitives::fs::{
     canonicalize, copy, create_dir, hard_link, open, open_ambient_dir, open_dir, read_dir,
-    readlink, remove_dir_all, remove_open_dir, remove_open_dir_all, rename, rmdir, set_permissions,
-    stat, unlink, DirOptions, FollowSymlinks, Permissions,
+    readlink, remove_dir, remove_dir_all, remove_open_dir, remove_open_dir_all, rename,
+    set_permissions, stat, unlink, DirOptions, FollowSymlinks, Permissions,
 };
 use std::{
     fmt,
@@ -318,7 +318,7 @@ impl Dir {
     #[inline]
     pub fn remove_dir<P: AsRef<Path>>(&self, path: P) -> io::Result<()> {
         let file = unsafe { as_sync(&self.std_file) };
-        rmdir(&file, path.as_ref())
+        remove_dir(&file, path.as_ref())
     }
 
     /// Removes a directory at this path, after removing all its contents. Use carefully!

cap-primitives/src/fs/mod.rs

@@ -26,10 +26,10 @@ mod open_unchecked_error;
 mod permissions;
 mod read_dir;
 mod readlink;
+mod remove_dir;
 mod remove_dir_all;
 mod remove_open_dir;
 mod rename;
-mod rmdir;
 mod set_permissions;
 mod set_times;
 mod stat;
@@ -70,10 +70,10 @@ pub use open_options::*;
 pub use permissions::*;
 pub use read_dir::*;
 pub use readlink::*;
+pub use remove_dir::*;
 pub use remove_dir_all::*;
 pub use remove_open_dir::*;
 pub use rename::*;
-pub use rmdir::*;
 pub use set_permissions::*;
 pub use set_times::*;
 pub use stat::*;

cap-primitives/src/fs/rmdir.rs renamed to cap-primitives/src/fs/remove_dir.rs

@@ -1,33 +1,35 @@
-//! This defines `rmdir`, the primary entrypoint to sandboxed file removal.
+//! This defines `remove_dir`, the primary entrypoint to sandboxed file removal.
 
-use crate::fs::rmdir_impl;
+use crate::fs::remove_dir_impl;
 #[cfg(racy_asserts)]
-use crate::fs::{manually, map_result, rmdir_unchecked, stat_unchecked, FollowSymlinks, Metadata};
+use crate::fs::{
+    manually, map_result, remove_dir_unchecked, stat_unchecked, FollowSymlinks, Metadata,
+};
 use std::{fs, io, path::Path};
 
 /// Perform a `rmdirat`-like operation, ensuring that the resolution of the path
 /// never escapes the directory tree rooted at `start`.
 #[cfg_attr(not(racy_asserts), allow(clippy::let_and_return))]
 #[inline]
-pub fn rmdir(start: &fs::File, path: &Path) -> io::Result<()> {
+pub fn remove_dir(start: &fs::File, path: &Path) -> io::Result<()> {
     #[cfg(racy_asserts)]
     let stat_before = stat_unchecked(start, path, FollowSymlinks::No);
 
     // Call the underlying implementation.
-    let result = rmdir_impl(start, path);
+    let result = remove_dir_impl(start, path);
 
     #[cfg(racy_asserts)]
     let stat_after = stat_unchecked(start, path, FollowSymlinks::No);
 
     #[cfg(racy_asserts)]
-    check_rmdir(start, path, &stat_before, &result, &stat_after);
+    check_remove_dir(start, path, &stat_before, &result, &stat_after);
 
     result
 }
 
 #[cfg(racy_asserts)]
 #[allow(clippy::enum_glob_use)]
-fn check_rmdir(
+fn check_remove_dir(
     start: &fs::File,
     path: &Path,
     stat_before: &io::Result<Metadata>,
@@ -51,7 +53,7 @@ fn check_rmdir(
         }
 
         (_, Err((InvalidInput, _)), _) => {
-            // `rmdir(".")` apparently returns `EINVAL`
+            // `remove_dir(".")` apparently returns `EINVAL`
         }
 
         (_, Err((kind, message)), _) => {
@@ -60,13 +62,13 @@ fn check_rmdir(
                 path,
                 FollowSymlinks::No,
             )) {
-                Ok(canon) => match map_result(&rmdir_unchecked(start, &canon)) {
+                Ok(canon) => match map_result(&remove_dir_unchecked(start, &canon)) {
                     Err((_unchecked_kind, _unchecked_message)) => {
                         /* TODO: Check error messages.
                         assert_eq!(
                             kind,
                             unchecked_kind,
-                            "unexpected error kind from rmdir start='{:?}', \
+                            "unexpected error kind from remove_dir start='{:?}', \
                              path='{}':\nstat_before={:#?}\nresult={:#?}\nstat_after={:#?}",
                             start,
                             path.display(),
@@ -78,7 +80,7 @@ fn check_rmdir(
                         */
                     }
                     _ => panic!(
-                        "unsandboxed rmdir success on start={:?} path={:?}; expected {:?}: {}",
+                        "unsandboxed remove_dir success on start={:?} path={:?}; expected {:?}: {}",
                         start, path, kind, message
                     ),
                 },
@@ -92,7 +94,7 @@ fn check_rmdir(
         }
 
         other => panic!(
-            "inconsistent rmdir checks: start='{:?}' path='{}':\n{:#?}",
+            "inconsistent remove_dir checks: start='{:?}' path='{}':\n{:#?}",
             start,
             path.display(),
             other,
@@ -102,16 +104,16 @@ fn check_rmdir(
     match stat_after {
         Ok(_unchecked_metadata) => match &result {
             Ok(()) => panic!(
-                "file still exists after rmdir start='{:?}', path='{}'",
+                "file still exists after remove_dir start='{:?}', path='{}'",
                 start,
                 path.display()
             ),
             Err(e) => match e.kind() {
                 io::ErrorKind::PermissionDenied
-                | io::ErrorKind::InvalidInput // `rmdir(".")` apparently returns `EINVAL`
+                | io::ErrorKind::InvalidInput // `remove_dir(".")` apparently returns `EINVAL`
                 | io::ErrorKind::Other => (),        // directory not empty, among other things
                 _ => panic!(
-                    "unexpected error rmdiring start='{:?}', path='{}': {:?}",
+                    "unexpected error remove_dir'ing start='{:?}', path='{}': {:?}",
                     start,
                     path.display(),
                     e

cap-primitives/src/fs/via_parent/mod.rs

@@ -7,8 +7,8 @@ mod hard_link;
 mod open_parent;
 #[cfg(not(windows))] // doesn't work on windows; use a windows-specific impl
 mod readlink;
+mod remove_dir;
 mod rename;
-mod rmdir;
 #[cfg(windows)]
 mod set_permissions;
 #[cfg(not(windows))]
@@ -22,8 +22,8 @@ pub(crate) use create_dir::create_dir;
 pub(crate) use hard_link::hard_link;
 #[cfg(not(windows))] // doesn't work on windows; use a windows-specific impl
 pub(crate) use readlink::readlink;
+pub(crate) use remove_dir::remove_dir;
 pub(crate) use rename::rename;
-pub(crate) use rmdir::rmdir;
 #[cfg(windows)]
 pub(crate) use set_permissions::set_permissions;
 #[cfg(not(windows))]

cap-primitives/src/fs/via_parent/remove_dir.rs

@@ -0,0 +1,13 @@
+use super::open_parent;
+use crate::fs::{remove_dir_unchecked, MaybeOwnedFile};
+use std::{fs, io, path::Path};
+
+/// Implement `remove_dir` by `open`ing up the parent component of the path and
+/// then calling `remove_dir_unchecked` on the last component.
+pub(crate) fn remove_dir(start: &fs::File, path: &Path) -> io::Result<()> {
+    let start = MaybeOwnedFile::borrowed(start);
+
+    let (dir, basename) = open_parent(start, path)?;
+
+    remove_dir_unchecked(&dir, basename.as_ref())
+}

cap-primitives/src/fs/via_parent/rmdir.rs

@@ -18,9 +18,9 @@ mod permissions_ext;
 mod read_dir_inner;
 mod readlink_unchecked;
 mod remove_dir_all_impl;
+mod remove_dir_unchecked;
 mod remove_open_dir_by_searching;
 mod rename_unchecked;
-mod rmdir_unchecked;
 #[cfg(not(target_os = "linux"))]
 mod set_permissions_impl;
 #[cfg(not(target_os = "linux"))]
@@ -66,7 +66,7 @@ pub(crate) use crate::fs::{
     via_parent::create_dir as create_dir_impl,
     via_parent::readlink as readlink_impl,
     via_parent::rename as rename_impl,
-    via_parent::rmdir as rmdir_impl,
+    via_parent::remove_dir as remove_dir_impl,
     via_parent::symlink as symlink_impl,
     via_parent::unlink as unlink_impl,
     remove_open_dir_by_searching as remove_open_dir_impl,
@@ -92,9 +92,9 @@ pub(crate) use permissions_ext::*;
 pub(crate) use read_dir_inner::*;
 pub(crate) use readlink_unchecked::*;
 pub(crate) use remove_dir_all_impl::*;
+pub(crate) use remove_dir_unchecked::*;
 pub(crate) use remove_open_dir_by_searching::*;
 pub(crate) use rename_unchecked::*;
-pub(crate) use rmdir_unchecked::*;
 pub(crate) use stat_unchecked::*;
 pub(crate) use symlink_unchecked::*;
 #[allow(unused_imports)]

cap-primitives/src/posish/fs/mod.rs

@@ -1,5 +1,5 @@
 use crate::fs::{
-    open_dir, open_dir_unchecked, open_entry_impl, read_dir_unchecked, rmdir_unchecked,
+    open_dir, open_dir_unchecked, open_entry_impl, read_dir_unchecked, remove_dir_unchecked,
     stat_unchecked, unlink_unchecked, DirEntryInner, FollowSymlinks, Metadata, OpenOptions,
     ReadDir,
 };
@@ -53,7 +53,7 @@ impl ReadDirInner {
     }
 
     pub(super) fn remove_dir(&self, file_name: &OsStr) -> io::Result<()> {
-        unsafe { rmdir_unchecked(&self.to_std_file(), file_name.as_ref()) }
+        unsafe { remove_dir_unchecked(&self.to_std_file(), file_name.as_ref()) }
     }
 
     pub(super) fn self_metadata(&self) -> io::Result<Metadata> {

cap-primitives/src/posish/fs/read_dir_inner.rs

@@ -1,5 +1,6 @@
 use crate::fs::{
-    read_dir, read_dir_unchecked, remove_open_dir, rmdir, stat, unlink, FollowSymlinks, ReadDir,
+    read_dir, read_dir_unchecked, remove_dir, remove_open_dir, stat, unlink, FollowSymlinks,
+    ReadDir,
 };
 use std::{
     fs, io,
@@ -15,7 +16,7 @@ pub(crate) fn remove_dir_all_impl(start: &fs::File, path: &Path) -> io::Result<(
         unlink(start, path)
     } else {
         remove_dir_all_recursive(read_dir(start, path)?)?;
-        rmdir(start, path)
+        remove_dir(start, path)
     }
 }
 

cap-primitives/src/posish/fs/remove_dir_all_impl.rs

@@ -0,0 +1,8 @@
+use posish::fs::{unlinkat, AtFlags};
+use std::{fs, io, path::Path};
+
+/// *Unsandboxed* function similar to `remove_dir`, but which does not perform
+/// sandboxing.
+pub(crate) fn remove_dir_unchecked(start: &fs::File, path: &Path) -> io::Result<()> {
+    unlinkat(start, path, AtFlags::REMOVEDIR)
+}