Rename cap-primitives' unlink to remove_file.

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, remove_dir_all, remove_open_dir, remove_open_dir_all, rename,
-    set_permissions, stat, unlink, DirOptions, FollowSymlinks, Permissions,
+    readlink, remove_dir, remove_dir_all, remove_file, remove_open_dir, remove_open_dir_all,
+    rename, set_permissions, stat, DirOptions, FollowSymlinks, Permissions,
 };
 use std::{
     fmt,
@@ -365,7 +365,7 @@ impl Dir {
     #[inline]
     pub fn remove_file<P: AsRef<Path>>(&self, path: P) -> io::Result<()> {
         let file = unsafe { as_sync(&self.std_file) };
-        unlink(&file, path.as_ref())
+        remove_file(&file, path.as_ref())
     }
 
     /// Rename a file or directory to a new name, replacing the original file if to already exists.

cap-primitives/src/fs/mod.rs

@@ -28,14 +28,14 @@ mod read_dir;
 mod readlink;
 mod remove_dir;
 mod remove_dir_all;
+mod remove_file;
 mod remove_open_dir;
 mod rename;
 mod set_permissions;
 mod set_times;
 mod stat;
 mod symlink;
 mod system_time_spec;
-mod unlink;
 
 pub(crate) mod errors;
 pub(crate) mod manually;
@@ -72,14 +72,14 @@ pub use read_dir::*;
 pub use readlink::*;
 pub use remove_dir::*;
 pub use remove_dir_all::*;
+pub use remove_file::*;
 pub use remove_open_dir::*;
 pub use rename::*;
 pub use set_permissions::*;
 pub use set_times::*;
 pub use stat::*;
 pub use symlink::*;
 pub use system_time_spec::*;
-pub use unlink::*;
 
 #[cfg(racy_asserts)]
 fn map_result<T: Clone>(result: &std::io::Result<T>) -> Result<T, (std::io::ErrorKind, String)> {

cap-primitives/src/fs/unlink.rs renamed to cap-primitives/src/fs/remove_file.rs

@@ -1,33 +1,35 @@
-//! This defines `unlink`, the primary entrypoint to sandboxed file removal.
+//! This defines `remove_file`, the primary entrypoint to sandboxed file removal.
 
-use crate::fs::unlink_impl;
+use crate::fs::remove_file_impl;
 #[cfg(racy_asserts)]
-use crate::fs::{manually, map_result, stat_unchecked, unlink_unchecked, FollowSymlinks, Metadata};
+use crate::fs::{
+    manually, map_result, remove_file_unchecked, stat_unchecked, FollowSymlinks, Metadata,
+};
 use std::{fs, io, path::Path};
 
-/// Perform a `unlinkat`-like operation, ensuring that the resolution of the path
-/// never escapes the directory tree rooted at `start`.
+/// Perform a `remove_fileat`-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 unlink(start: &fs::File, path: &Path) -> io::Result<()> {
+pub fn remove_file(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 = unlink_impl(start, path);
+    let result = remove_file_impl(start, path);
 
     #[cfg(racy_asserts)]
     let stat_after = stat_unchecked(start, path, FollowSymlinks::No);
 
     #[cfg(racy_asserts)]
-    check_unlink(start, path, &stat_before, &result, &stat_after);
+    check_remove_file(start, path, &stat_before, &result, &stat_after);
 
     result
 }
 
 #[cfg(racy_asserts)]
 #[allow(clippy::enum_glob_use)]
-fn check_unlink(
+fn check_remove_file(
     start: &fs::File,
     path: &Path,
     stat_before: &io::Result<Metadata>,
@@ -56,13 +58,13 @@ fn check_unlink(
                 path,
                 FollowSymlinks::No,
             )) {
-                Ok(canon) => match map_result(&unlink_unchecked(start, &canon)) {
+                Ok(canon) => match map_result(&remove_file_unchecked(start, &canon)) {
                     Err((_unchecked_kind, _unchecked_message)) => {
                         /* TODO: Check error messages.
                         assert_eq!(
                             kind,
                             unchecked_kind,
-                            "unexpected error kind from unlink start='{:?}', \
+                            "unexpected error kind from remove_file start='{:?}', \
                              path='{}':\nstat_before={:#?}\nresult={:#?}\nstat_after={:#?}",
                             start,
                             path.display(),
@@ -73,7 +75,7 @@ fn check_unlink(
                         assert_eq!(message, unchecked_message);
                         */
                     }
-                    _ => panic!("unsandboxed unlink success"),
+                    _ => panic!("unsandboxed remove_file success"),
                 },
                 Err((_canon_kind, _canon_message)) => {
                     /* TODO: Check error messages.
@@ -85,7 +87,7 @@ fn check_unlink(
         }
 
         other => panic!(
-            "inconsistent unlink checks: start='{:?}' path='{}':\n{:#?}",
+            "inconsistent remove_file checks: start='{:?}' path='{}':\n{:#?}",
             start,
             path.display(),
             other,
@@ -94,15 +96,15 @@ fn check_unlink(
 
     match (result, stat_after) {
         (Ok(()), Ok(_unchecked_metadata)) => panic!(
-            "file still exists after unlink start='{:?}', path='{}'",
+            "file still exists after remove_file start='{:?}', path='{}'",
             start,
             path.display()
         ),
         (Err(e), Ok(unchecked_metadata)) => match e.kind() {
             io::ErrorKind::PermissionDenied => (),
             io::ErrorKind::Other if unchecked_metadata.is_dir() => (),
             _ => panic!(
-                "unexpected error unlinking start='{:?}', path='{}': {:?}",
+                "unexpected error removing file start='{:?}', path='{}': {:?}",
                 start,
                 path.display(),
                 e

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

@@ -8,13 +8,13 @@ mod open_parent;
 #[cfg(not(windows))] // doesn't work on windows; use a windows-specific impl
 mod readlink;
 mod remove_dir;
+mod remove_file;
 mod rename;
 #[cfg(windows)]
 mod set_permissions;
 #[cfg(not(windows))]
 mod set_times_nofollow;
 mod symlink;
-mod unlink;
 
 use open_parent::open_parent;
 
@@ -23,6 +23,7 @@ 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 remove_file::remove_file;
 pub(crate) use rename::rename;
 #[cfg(windows)]
 pub(crate) use set_permissions::set_permissions;
@@ -32,4 +33,3 @@ pub(crate) use set_times_nofollow::set_times_nofollow;
 pub(crate) use symlink::symlink;
 #[cfg(windows)]
 pub(crate) use symlink::{symlink_dir, symlink_file};
-pub(crate) use unlink::unlink;

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

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

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

@@ -19,6 +19,7 @@ mod read_dir_inner;
 mod readlink_unchecked;
 mod remove_dir_all_impl;
 mod remove_dir_unchecked;
+mod remove_file_unchecked;
 mod remove_open_dir_by_searching;
 mod rename_unchecked;
 #[cfg(not(target_os = "linux"))]
@@ -28,7 +29,6 @@ mod set_times_impl;
 mod stat_unchecked;
 mod symlink_unchecked;
 mod times;
-mod unlink_unchecked;
 
 pub(crate) mod errors;
 
@@ -68,7 +68,7 @@ pub(crate) use crate::fs::{
     via_parent::rename as rename_impl,
     via_parent::remove_dir as remove_dir_impl,
     via_parent::symlink as symlink_impl,
-    via_parent::unlink as unlink_impl,
+    via_parent::remove_file as remove_file_impl,
     remove_open_dir_by_searching as remove_open_dir_impl,
 };
 
@@ -93,13 +93,13 @@ 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_file_unchecked::*;
 pub(crate) use remove_open_dir_by_searching::*;
 pub(crate) use rename_unchecked::*;
 pub(crate) use stat_unchecked::*;
 pub(crate) use symlink_unchecked::*;
 #[allow(unused_imports)]
 pub(crate) use times::{set_times_follow_unchecked, set_times_nofollow_unchecked};
-pub(crate) use unlink_unchecked::*;
 
 // On Linux, there is a limit of 40 symlink expansions.
 // Source: https://man7.org/linux/man-pages/man7/path_resolution.7.html

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

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

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

@@ -1,5 +1,5 @@
 use crate::fs::{
-    read_dir, read_dir_unchecked, remove_dir, remove_open_dir, stat, unlink, FollowSymlinks,
+    read_dir, read_dir_unchecked, remove_dir, remove_file, remove_open_dir, stat, FollowSymlinks,
     ReadDir,
 };
 use std::{
@@ -13,7 +13,7 @@ pub(crate) fn remove_dir_all_impl(start: &fs::File, path: &Path) -> io::Result<(
     // 108e90ca78f052c0c1c49c42a22c85620be19712.
     let filetype = stat(start, path, FollowSymlinks::No)?.file_type();
     if filetype.is_symlink() {
-        unlink(start, path)
+        remove_file(start, path)
     } else {
         remove_dir_all_recursive(read_dir(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_file`, but which does not perform
+/// sandboxing.
+pub(crate) fn remove_file_unchecked(start: &fs::File, path: &Path) -> io::Result<()> {
+    unlinkat(start, path, AtFlags::empty())
+}