Files
fish-config/functions/rm.fish
T
rootiest 859f14a6e9 feat(functions): tag CLASSIFICATION across functions/ and conf.d/
Audits every function's interaction with the C1-shadowed commands
(uses-shadow/bypasses-shadow) and general hazards (destructive,
network, blocking-prompt) per the CLASSIFICATION schema.

Delegated the initial mechanical sweep to agy, then reviewed every
file by hand: fixed a systemic double-blank-comment-line formatting
bug from the delegate pass, and corrected several judgment errors
found on review -- three false blocking-prompt tags where a fish
'read' was consuming piped input rather than waiting on a terminal
(open-url.fish, sbver.fish, play-media.fish, now untagged entirely),
a blocking-prompt tag on mkrep.fish despite its documented --yes
escape hatch, an untagged read in jobrunner.fish's own baseless
blocking-prompt claim (removed, along with a destructive tag on
cleanup of its own mktemp output -- the schema explicitly excludes
that), the same own-output-cleanup false positive on
_zellij_dump_log.fish's destructive tag, an interactive fzf-gated
confirmation on logs.fish and replay.fish's piped read misread the
same way as the first three, and a uses-shadow(mkdir) on mkcd.fish
that actually belongs to the _fish_mkdir_p helper it delegates to,
not to mkcd itself.
2026-09-21 21:26:44 -04:00

169 lines
5.7 KiB
Fish

# Copyright (C) 2026 Rootiest
# SPDX-License-Identifier: AGPL-3.0-or-later
# CATEGORY
# 01-file-and-directory
#
# COMPONENT
# aliases/filesystem
#
# CLASSIFICATION
# bypasses-shadow(rm), destructive
#
# SYNOPSIS
# rm [-e [options] | -S | args...]
#
# DESCRIPTION
# Enhanced rm that routes deletions through trash when safe. With no
# arguments, lists current trash contents. -e/--empty empties the trash
# (with optional trash-empty sub-arguments). -S/--secure permanently
# deletes via rm -rf and triggers fstrim. Plain paths and -r/-R are sent
# to trash put; any other flags fall back to system rm.
#
# Opinionated component (C1): when disabled via __fish_config_op_aliases
# (or the __fish_config_opinionated master), behaves exactly like bare
# command rm — no wrapper, no trash, no trapping.
#
# ARGUMENTS
# (none) List current trash contents
# -e, --empty [opts] Empty the trash; opts forwarded to trash empty
# -S, --secure Permanently delete targets and run fstrim (irreversible)
# -r, -R, --recursive Forwarded to trash put alongside path arguments
# args... Files or paths to trash or remove
#
# EXIT STATUS
# 0 Operation succeeded
# 1 trash put failed or file not found
#
# EXAMPLE
# rm file.txt
# rm -e
# rm -S sensitive_key.pem
#
# NOTES
# Falls back to /usr/bin/rm when trash is unavailable.
function rm --description 'Ultimate rm: trash, list, empty, and secure-erase'
# Opinionated guard (C1): fall back to bare command rm when disabled.
if not __fish_config_op_enabled (status current-function)
command rm $argv
return $status
end
# 1. No arguments: Show the Trash contents (Quick view)
if not set -q argv[1]
if type -q trash
echo "🗑️ Current Trash Contents:"
trash list
else
command rm
end
return
end
# 2. Flag: Empty the Trash (-e / --empty)
# We check if the FIRST argument is -e or --empty
if string match -rq -- '^-e$|^--empty$' -- $argv[1]
if type -q trash
# Check if there are arguments after -e (like --within 2weeks)
if set -q argv[2]
# Pass everything after the first argument to trash empty
trash empty $argv[2..-1]
else
# Default behavior if no extra args provided
echo "🧹 Emptying all trash..."
trash empty --all
end
else
echo "Error: 'trash' command not found."
end
return
end
# 3. Flag: Secure Delete (-S / --secure)
if contains -- -S $argv; or contains -- --secure $argv
set -l clean_args
for arg in $argv
if not string match -rq -- '^-S$|^--secure$|^-r$|^-R$|^--recursive$' -- "$arg"
set -a clean_args $arg
end
end
echo "🛡️ Permanent delete + SSD Zeroing..."
command rm -rf $clean_args
fstrim --all 2>/dev/null &
return
end
# 4. Logic: Use 'trash' for simple paths OR recursive flags (-r, -R)
# Bail to real rm if ANY other flags (like -f) are detected
set -l is_safe_for_trash true
for arg in $argv
if string match -q -- "-*" $arg
if not string match -rq -- '^-r$|^-R$|^--recursive$' -- "$arg"
set is_safe_for_trash false
break
end
end
end
if test "$is_safe_for_trash" = true
set -l trash_paths
for arg in $argv
if not string match -rq -- '^-r$|^-R$|^--recursive$' -- "$arg"
set -a trash_paths $arg
end
end
if type -q trash; and set -q trash_paths[1]
set -l trash_output (trash put $trash_paths 2>&1)
set -l exit_status $status
if test $exit_status -ne 0
# 1. Extract the core message (e.g., "No such file or directory")
set -l raw_msg (string replace -r '.*Message: (.+?) \(os error.*' '$1' -- "$trash_output")
# 2. Find which paths are actually missing
set -l culprits
for p in $trash_paths
if not test -e "$p"
set -a culprits "$p"
end
end
# 3. Display Logic
set_color red --bold
echo -n "error: "
set_color normal
echo $raw_msg
if set -q culprits[1]
# If we found missing files, show the user's source paths
for c in $culprits
set_color blue
echo -n " ↳ Source: "
set_color normal
echo $c
end
else
# 1. Strip ANSI escape codes (color) so regex works correctly
# 2. Remove the 'error: ' prefix
# 3. Unescape quotes and trim whitespace
set -l clean_detail (string replace -ra '\e\[[^m]*m' '' -- "$trash_output" \
| string replace -r '^error: ' '' \
| string unescape \
| string trim)
set_color yellow
echo -n " ↳ Technical detail: "
set_color normal
echo $clean_detail
end
end
dbus-send --type=signal /OrgKdeKDirNotify org.kde.KDirNotify.FilesChanged stringArray:"trash:/" >/dev/null 2>&1 &
return $exit_status
end
end
# 5. Fallback: Standard rm for everything else (including -rf)
command rm $argv
end