safe-rm 3.1.2 → 3.1.4

package/bin/rm.sh

@@ -429,17 +429,24 @@ remove(){
 
 
 recursive_remove(){
+  local dir=$1
   local path
-
-  # use `ls -A` instead of `for` to list hidden files.
-  # and `for $1/*` is also weird if `$1` is neithor a dir nor existing that will print "$1/*" directly and rudely.
-  # never use `find $1`, for the searching order is not what we want
-  local list=$(ls -A "$1")
-
-  [[ -n $list ]] && for path in $list; do
-    debug "$LINENO: recursively remove: $1/$path"
-
-    remove "$1/$path"
+  local restore_nullglob=$(shopt -p nullglob)
+  local restore_dotglob=$(shopt -p dotglob)
+
+  # Avoid `ls -A` + unquoted `for` iteration, which splits names by IFS
+  # and breaks paths containing spaces (e.g. "a b" -> "a" + "b").
+  # Use glob expansion with arrays to keep each entry as one element.
+  # dotglob includes hidden files, nullglob avoids a literal "$dir/*" token.
+  shopt -s nullglob dotglob
+  local list=("$dir"/*)
+  eval "$restore_nullglob"
+  eval "$restore_dotglob"
+
+  for path in "${list[@]}"; do
+    debug "$LINENO: recursively remove: $path"
+
+    remove "$path"
   done
 }
 
@@ -483,7 +490,11 @@ do_trash(){
 
 
 get_absolute_path(){
-  echo $(cd "$(dirname "$1")" && pwd)/$(basename "$1")
+  local dir
+  local base
+  dir=$(cd "$(dirname -- "$1")" && pwd)
+  base=$(basename -- "$1")
+  printf '%s/%s\n' "$dir" "$base"
 }
 
 
@@ -521,12 +532,19 @@ applescript_trash(){
 
   [[ "$OPT_VERBOSE" == 1 ]] && list_files "$target"
 
+  # #47: Finder alias resolves symlinks to their targets.
+  # For symbolic links, fallback to `mv`-based trash to remove the link itself.
+  if [[ -L "$target" ]]; then
+    debug "$LINENO: symlink detected, fallback to mac_trash: $target"
+    mac_trash "$target"
+    return $?
+  fi
+
   debug "$LINENO: osascript delete $target"
 
   osascript -e "tell application \"Finder\" to delete (POSIX file \"$target\" as alias)" &> /dev/null
 
-  # TODO: handle osascript errors
-  return 0
+  return $?
 }
 
 
@@ -587,7 +605,7 @@ check_target_to_move(){
 mac_trash(){
   check_target_to_move "$1"
   local move=$_to_move
-  local base=$(basename "$move")
+  local base=$(basename -- "$move")
 
   # foo.jpg => "foo" + ".jpg"
   # foo => "foo" + ""
@@ -609,12 +627,13 @@ mac_trash(){
   [[ "$OPT_VERBOSE" == 1 ]] && list_files "$1"
 
   debug "$LINENO: mv $move to $trash_path"
-  mv "$move" "$trash_path"
+  mv -- "$move" "$trash_path"
+  local status=$?
 
-  [[ "$_traveled" == 1 ]] && cd $__DIRNAME &> /dev/null
+  [[ "$_traveled" == 1 ]] && cd "$__DIRNAME" &> /dev/null
 
-  # default status
-  return 0
+  # Propagate mv status; otherwise callers may treat move failures as success.
+  return $status
 }
 
 
@@ -657,7 +676,7 @@ check_linux_trash_base(){
 linux_trash(){
   check_target_to_move "$1"
   local move=$_to_move
-  local base=$(basename "$move")
+  local base=$(basename -- "$move")
 
   base=$(check_linux_trash_base "$base")
 
@@ -667,7 +686,14 @@ linux_trash(){
 
   # Move the target into the trash
   debug "$LINENO: mv $move to $trash_path"
-  mv "$move" "$trash_path"
+  mv -- "$move" "$trash_path"
+  local move_status=$?
+
+  if [[ $move_status -ne 0 ]]; then
+    # Keep failure visible to remove()/EXIT_CODE and skip writing .trashinfo.
+    [[ "$_traveled" == 1 ]] && cd "$__DIRNAME" &> /dev/null
+    return $move_status
+  fi
 
   # Save linux trash info
   local info_path="$SAFE_RM_TRASH/info/$base.trashinfo"
@@ -677,10 +703,11 @@ linux_trash(){
 Path=$move
 DeletionDate=$trash_time
 EOF
+  local info_status=$?
 
-  [[ "$_traveled" == 1 ]] && cd $__DIRNAME &> /dev/null
+  [[ "$_traveled" == 1 ]] && cd "$__DIRNAME" &> /dev/null
 
-  return 0
+  return $info_status
 }
 
 
@@ -689,15 +716,22 @@ EOF
 #   'coz `find` act a inward searching, unlike rm -v
 list_files(){
   if [[ -d "$1" ]]; then
-    local list=$(ls -A "$1")
+    local restore_nullglob=$(shopt -p nullglob)
+    local restore_dotglob=$(shopt -p dotglob)
+    # Keep traversal behavior aligned with recursive_remove(): no word splitting
+    # for names with spaces, and include dotfiles for rm -v output.
+    shopt -s nullglob dotglob
+    local list=("$1"/*)
+    eval "$restore_nullglob"
+    eval "$restore_dotglob"
     local f
 
-    [[ -n $list ]] && for f in $list; do
-      list_files "$1/$f"
+    for f in "${list[@]}"; do
+      list_files "$f"
     done
   fi
 
-  echo $1
+  echo "$1"
 }
 
 
@@ -733,28 +767,20 @@ for file in "${FILE_NAME[@]}"; do
   fi
 
   # the same check also apply on /. /..
-  if [[ $(basename "$file") == "." || $(basename "$file") == ".." ]]; then
+  if [[ $(basename -- "$file") == "." || $(basename -- "$file") == ".." ]]; then
     error "$COMMAND: \".\" and \"..\" may not be removed"
     EXIT_CODE=1
     continue
   fi
 
-  # deal with wildcard and also, redirect error output
-  ls_result=$(ls -d "$file" 2> /dev/null)
-
-  # debug
-  debug "$LINENO: ls_result: $ls_result"
-
-  if [[ -n "$ls_result" ]]; then
-    for file in "$ls_result"; do
-      remove "$file"
-      status=$?
-      debug "$LINENO: remove returned status: $status"
+  if [[ -e "$file" || -L "$file" ]]; then
+    remove "$file"
+    status=$?
+    debug "$LINENO: remove returned status: $status"
 
-      if [[ ! $status == 0 ]]; then
-        EXIT_CODE=1
-      fi
-    done
+    if [[ ! $status == 0 ]]; then
+      EXIT_CODE=1
+    fi
   elif [[ -z "$OPT_FORCE" ]]; then
     error "$COMMAND: $file: No such file or directory" >&2
     EXIT_CODE=1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "safe-rm",
-  "version": "3.1.2",
+  "version": "3.1.4",
   "description": "A much safer replacement of bash rm with nearly full functionalities and options of the rm command!",
   "bin": {
     "safe-rm": "./bin/rm.sh"

package/test/cases.js

@@ -1,4 +1,5 @@
 const path = require('path')
+const fs = require('fs').promises
 const {v4: uuid} = require('uuid')
 const delay = require('delay')
 
@@ -315,4 +316,255 @@ remove ${dir}? y
 
     t.false(await pathExists(dir), 'directory should be removed')
   })
+
+  !is_as(type) && test(`recursively and interactively with spaces`, async t => {
+    // Regression guard: recursive interactive remove must keep "a b"
+    // as one path and still remove the directory successfully.
+    const {
+      createDir,
+      createFile,
+      runRm,
+      pathExists
+    } = t.context
+
+    const dir = await createDir({
+      name: 'foo'
+    })
+
+    const fileA = await createFile({
+      name: 'a b',
+      under: dir
+    })
+
+    const fileB = await createFile({
+      name: 'c',
+      under: dir
+    })
+
+    const result = await runRm(['-ri', dir], {
+      input: ['y', 'y', 'y', 'y']
+    })
+
+    t.is(result.stderr, '', 'stderr should be empty')
+    t.is(result.code, 0, 'exit code should be 0')
+    t.is(
+      result.stdout,
+      `examine files in directory ${dir}? y
+remove ${fileA}? y
+remove ${fileB}? y
+remove ${dir}? y
+`,
+      'stdout does not match'
+    )
+
+    t.false(await pathExists(dir), 'directory should be removed')
+  })
+
+  !is_as(type) && test(`#47: removes symlink itself instead of target`, async t => {
+    const {
+      createFile,
+      runRm,
+      pathExists
+    } = t.context
+
+    const target = await createFile({
+      name: 'file1'
+    })
+
+    const link = path.join(path.dirname(target), 'file1_sym')
+    await fs.symlink(target, link)
+
+    const result = await runRm([link])
+
+    t.is(result.code, 0, 'exit code should be 0')
+    t.false(await pathExists(link), 'symlink should be removed')
+    t.true(await pathExists(target), 'target file should remain')
+  })
+
+  !is_as(type) && test(`#47: applescript path should also remove symlink itself`, async t => {
+    const {
+      root,
+      createDir,
+      createFile,
+      runRm,
+      pathExists
+    } = t.context
+
+    const home = await createDir({
+      name: 'home',
+      under: root
+    })
+
+    await createDir({
+      name: '.Trash',
+      under: home
+    })
+
+    const mockBin = await createDir({
+      name: 'mock-bin',
+      under: root
+    })
+
+    // Simulate Finder alias behavior: if safe-rm calls osascript with a symlink,
+    // this mock deletes the resolved target. safe-rm should bypass this for symlinks.
+    const mockOsa = await createFile({
+      name: 'osascript',
+      under: mockBin,
+      content: `#!/usr/bin/env bash
+expr=$2
+target=$(printf '%s' "$expr" | cut -d '"' -f2)
+
+if [[ -L "$target" ]]; then
+  resolved=$(readlink "$target")
+  if [[ "$resolved" != /* ]]; then
+    resolved="$(cd "$(dirname "$target")" && pwd)/$resolved"
+  fi
+  /bin/rm -f "$resolved"
+else
+  /bin/rm -rf "$target"
+fi
+`
+    })
+
+    await fs.chmod(mockOsa, 0o755)
+
+    const target = await createFile({
+      name: 'file2'
+    })
+
+    const link = path.join(path.dirname(target), 'file2_sym')
+    await fs.symlink(target, link)
+
+    const result = await runRm([link], {
+      env: {
+        HOME: home,
+        PATH: `${mockBin}:${process.env.PATH}`,
+        SAFE_RM_TRASH: ''
+      }
+    })
+
+    t.is(result.code, 0, 'exit code should be 0')
+    t.false(await pathExists(link), 'symlink should be removed')
+    t.true(await pathExists(target), 'target file should remain')
+  })
+
+  !is_as(type) && test(`removes a dangling symlink`, async t => {
+    const {
+      source_path,
+      runRm
+    } = t.context
+
+    const missingTarget = path.join(source_path, 'missing-target')
+    const link = path.join(source_path, 'dangling_sym')
+    await fs.symlink(missingTarget, link)
+
+    const before = await fs.lstat(link)
+    t.true(before.isSymbolicLink(), 'should create symlink before remove')
+
+    const result = await runRm([link])
+
+    t.is(result.code, 0, 'exit code should be 0')
+    await t.throwsAsync(async () => fs.lstat(link), {
+      code: 'ENOENT'
+    })
+  })
+
+  !is_as(type) && test(`-r should not dereference a directory symlink`, async t => {
+    const {
+      createDir,
+      createFile,
+      runRm,
+      pathExists
+    } = t.context
+
+    const realDir = await createDir({
+      name: 'real-dir'
+    })
+
+    const keep = await createFile({
+      name: 'keep',
+      under: realDir
+    })
+
+    const link = path.join(path.dirname(realDir), 'real-dir-sym')
+    await fs.symlink(realDir, link)
+
+    const result = await runRm(['-r', link])
+
+    t.is(result.code, 0, 'exit code should be 0')
+    await t.throwsAsync(async () => fs.lstat(link), {
+      code: 'ENOENT'
+    })
+    t.true(await pathExists(realDir), 'target directory should remain')
+    t.true(await pathExists(keep), 'target content should remain')
+  })
+
+  !is_as(type) && test(`-ri should not dereference a directory symlink`, async t => {
+    const {
+      createDir,
+      createFile,
+      runRm,
+      pathExists
+    } = t.context
+
+    const realDir = await createDir({
+      name: 'real-dir-i'
+    })
+
+    const keep = await createFile({
+      name: 'keep-i',
+      under: realDir
+    })
+
+    const link = path.join(path.dirname(realDir), 'real-dir-sym-i')
+    await fs.symlink(realDir, link)
+
+    const result = await runRm(['-ri', link], {
+      input: ['y']
+    })
+
+    t.is(result.code, 0, 'exit code should be 0')
+    await t.throwsAsync(async () => fs.lstat(link), {
+      code: 'ENOENT'
+    })
+    t.true(await pathExists(realDir), 'target directory should remain')
+    t.true(await pathExists(keep), 'target content should remain')
+  })
+
+  !is_as(type) && test(`removes a file prefixed with "-" after --`, async t => {
+    const {
+      source_path,
+      createFile,
+      runRm,
+      pathExists
+    } = t.context
+
+    const name = '-dash-file'
+    await createFile({name})
+
+    const result = await runRm(['--', name], {
+      cwd: source_path
+    })
+
+    t.is(result.code, 0, 'exit code should be 0')
+    t.false(await pathExists(name), 'file should be removed')
+  })
+
+  !is_as(type) && test(`removes a file with newline in filename`, async t => {
+    const {
+      createFile,
+      runRm,
+      pathExists
+    } = t.context
+
+    const filename = 'line1\nline2'
+    const filepath = await createFile({
+      name: filename
+    })
+
+    const result = await runRm([filepath])
+
+    t.is(result.code, 0, 'exit code should be 0')
+    t.false(await pathExists(filepath), 'file should be removed')
+  })
 }

package/test/helper.js

@@ -60,7 +60,8 @@ const generateContextMethods = (
   function runRm (args, {
     input = [],
     command = rm_command,
-    env: arg_env = {}
+    env: arg_env = {},
+    cwd
   } = {}) {
     return new Promise((resolve, reject) => {
       const env = {
@@ -73,7 +74,8 @@ const generateContextMethods = (
       }
 
       const child = spawn(command, args, {
-        env
+        env,
+        cwd
       })
       let stdout = ''
       let stderr = ''