Skip to content

Commit

Permalink
rm: Move code into helper functions
Browse files Browse the repository at this point in the history
Co-authored-by: Julian Beltz <MJayBeltz@gmail.com>
  • Loading branch information
AnirbanHalder654322 and just-an-engineer committed Aug 14, 2024
1 parent 7864683 commit 21cfb9c
Show file tree
Hide file tree
Showing 4 changed files with 83 additions and 37 deletions.
1 change: 0 additions & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion src/uu/rm/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ path = "src/rm.rs"
clap = { workspace = true }
walkdir = { workspace = true }
uucore = { workspace = true, features = ["fs"] }
regex = { workspace = true }

[target.'cfg(unix)'.dependencies]
libc = { workspace = true }
Expand Down
86 changes: 52 additions & 34 deletions src/uu/rm/src/rm.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,18 @@
// For the full copyright and license information, please view the LICENSE
// file that was distributed with this source code.

// spell-checker:ignore (path) eacces inacc
// spell-checker:ignore (path) eacces inacc rm-r4

use clap::{builder::ValueParser, crate_version, parser::ValueSource, Arg, ArgAction, Command};
use regex::bytes::Regex;
use core::str;
use std::collections::VecDeque;
use std::ffi::{OsStr, OsString};
use std::fs::{self, File, Metadata};
use std::io::ErrorKind;
use std::ops::BitOr;
use std::os::unix::ffi::OsStrExt;

use std::path::{Path, PathBuf};
use std::str::from_utf8;
use uucore::display::Quotable;
use uucore::error::{UResult, USimpleError, UUsageError};
use uucore::{format_usage, help_about, help_section, help_usage, prompt_yes, show_error};
Expand Down Expand Up @@ -295,23 +296,6 @@ pub fn remove(files: &[&OsStr], options: &Options) -> bool {

had_err = match file.symlink_metadata() {
Ok(metadata) => {
#[cfg(not(windows))]
let re = Regex::new(r"/\.{1,2}\/*$").unwrap();
if re.is_match(filename.as_bytes()) {
show_error!(
"refusing to remove '.' or '..' directory: skipping '{:}'",
clean_trailing_slashes(filename).display()
);
true
} else if metadata.is_dir() {
handle_dir(file, options)
} else if is_symlink_dir(&metadata) {
remove_dir(file, options)
} else {
remove_file(file, options)
}

#[cfg(windows)]
if metadata.is_dir() {
handle_dir(file, options)
} else if is_symlink_dir(&metadata) {
Expand All @@ -320,6 +304,7 @@ pub fn remove(files: &[&OsStr], options: &Options) -> bool {
remove_file(file, options)
}
}

Err(_e) => {
// TODO: actually print out the specific error
// TODO: When the error is not about missing files
Expand All @@ -346,6 +331,15 @@ pub fn remove(files: &[&OsStr], options: &Options) -> bool {
fn handle_dir(path: &Path, options: &Options) -> bool {
let mut had_err = false;

let cleaned_path = clean_trailing_slashes(path);
if path_is_current_or_parent_directory(cleaned_path) {
show_error!(
"refusing to remove '.' or '..' directory: skipping '{:}'",
cleaned_path.display()
);
return true;
}

let is_root = path.has_root() && path.parent().is_none();
if options.recursive && (!is_root || !options.preserve_root) {
if options.interactive != InteractiveMode::Always && !options.verbose {
Expand Down Expand Up @@ -579,6 +573,24 @@ fn handle_writable_directory(path: &Path, options: &Options, metadata: &Metadata
true
}
}
/// Checks if the path is referring to current or parent directory , if it is referring to current or any parent directory in the file tree e.g '/.....' , '....' . '../..'
fn path_is_current_or_parent_directory(path: &Path) -> bool {
let path_str = path.to_str();
#[cfg(not(windows))]
let directory_separator = "/";
#[cfg(windows)]
let directory_separator = "\\";
if let Some(path) = path_str {
if path.ends_with("..")
|| path.ends_with(".")

Check failure on line 585 in src/uu/rm/src/rm.rs

View workflow job for this annotation

GitHub Actions / Style and Lint (ubuntu-22.04, unix)

ERROR: `cargo clippy`: single-character string constant used as pattern (file:'src/uu/rm/src/rm.rs', line:585)
|| path.ends_with(format!("..{}", directory_separator).as_str())
|| path.ends_with(format!(".{}", directory_separator).as_str())
{
return true;
}
}
false
}

// For windows we can use windows metadata trait and file attributes to see if a directory is readonly
#[cfg(windows)]
Expand Down Expand Up @@ -607,23 +619,29 @@ fn handle_writable_directory(path: &Path, options: &Options, metadata: &Metadata
}

/// Removes trailing slashes, for example 'd/../////' yield 'd/../' required to fix rm-r4 GNU test
fn clean_trailing_slashes(path: &OsStr) -> &Path {
let path_bytes = path.as_bytes();

let mut idx = path_bytes.len() - 1;
// Checks if element at the end is a '/'
if path_bytes[idx] == b'/' {
for i in (0..path_bytes.len()).rev() {
// Will break at the start of the continuous sequence of '/', eg: "abc//////" , will break at
// "abc/"
if path_bytes[i - 1] != b'/' {
idx = i;
break;
fn clean_trailing_slashes(path: &Path) -> &Path {
let path_str = path.to_str();
#[cfg(not(windows))]
let directory_separator = b'/';
#[cfg(windows)]
let directory_separator = b'\\';
if let Some(path_str) = path_str {
let path_bytes = path_str.as_bytes();
let mut idx = path_str.len() - 1;
// Checks if element at the end is a '/'
if path_bytes[idx] == directory_separator {
for i in (0..path_bytes.len()).rev() {
// Will break at the start of the continuous sequence of '/', eg: "abc//////" , will break at
// "abc/"
if path_bytes[i - 1] != directory_separator {
idx = i;
break;
}
}
return Path::new(from_utf8(&path_bytes[0..=idx]).unwrap_or_else(|_| path_str));

Check failure on line 641 in src/uu/rm/src/rm.rs

View workflow job for this annotation

GitHub Actions / Style and Lint (ubuntu-22.04, unix)

ERROR: `cargo clippy`: unnecessary closure used to substitute value for `Result::Err` (file:'src/uu/rm/src/rm.rs', line:641)
}
}

Path::new(OsStr::from_bytes(&path_bytes[0..=idx]))
path
}

fn prompt_descend(path: &Path) -> bool {
Expand Down
32 changes: 31 additions & 1 deletion tests/by-util/test_rm.rs
Original file line number Diff line number Diff line change
Expand Up @@ -678,7 +678,7 @@ fn test_remove_inaccessible_dir() {
}
#[test]
#[cfg(not(windows))]
fn test_rm_invalid_path_rm4() {
fn test_rm_current_or_parent_dir_rm4() {
let ts = TestScenario::new(util_name!());
let at = &ts.fixtures;

Expand Down Expand Up @@ -706,6 +706,36 @@ fn test_rm_invalid_path_rm4() {
assert_eq!(line, answers[idx]);
}
}
#[test]
#[cfg(windows)]
fn test_rm_current_or_parent_dir_rm4_windows() {
let ts = TestScenario::new(util_name!());
let at = &ts.fixtures;

at.mkdir("d");

let answers = [
"rm: refusing to remove '.' or '..' directory: skipping 'd\\.'",
"rm: refusing to remove '.' or '..' directory: skipping 'd\\.\\'",
"rm: refusing to remove '.' or '..' directory: skipping 'd\\.\\'",
"rm: refusing to remove '.' or '..' directory: skipping 'd\\..'",
"rm: refusing to remove '.' or '..' directory: skipping 'd\\..\\'",
];
let std_err_str = ts
.ucmd()
.arg("-rf")
.arg("d\\.")
.arg("d\\.\\")
.arg("d\\.\\\\\\\\")
.arg("d\\..")
.arg("d\\..\\")
.fails()
.stderr_move_str();

for (idx, line) in std_err_str.lines().enumerate() {
assert_eq!(line, answers[idx]);
}
}

#[test]
#[cfg(not(windows))]
Expand Down

0 comments on commit 21cfb9c

Please sign in to comment.