Compare commits
31 Commits
v0.1.0
...
flags_impr
| Author | SHA1 | Date | |
|---|---|---|---|
| e5f029738a | |||
| 1fbe499177 | |||
| 662166afb8 | |||
|
|
7197bfce0c | ||
|
|
7ee0e0a99e | ||
| dcd1165066 | |||
|
|
45ebe97a9a | ||
| dfcffb19e4 | |||
| b221fa3534 | |||
| a24cc8f2b9 | |||
|
|
d7330933bc | ||
| ac32bae975 | |||
|
|
b181e31a0c | ||
| 4fd1243472 | |||
|
|
328eeaca7a | ||
| 19b79b26ff | |||
|
|
a67e31c65d | ||
| 9d4608bd34 | |||
|
|
27468ae0d0 | ||
| 8b1d9a81a1 | |||
| 6eb3f5a210 | |||
|
|
9a64bef661 | ||
| 5b46a3af01 | |||
|
|
c8cc694e3c | ||
| 756a6af4ac | |||
| a20bbeb9f8 | |||
| 668d6bbba4 | |||
| 62264ea115 | |||
| d38ec538a4 | |||
| 166f2dfac2 | |||
| ac284d29e3 |
1
.github/CODEOWNERS
vendored
Normal file
1
.github/CODEOWNERS
vendored
Normal file
@@ -0,0 +1 @@
|
||||
* @mdaleo404
|
||||
2
.gitignore
vendored
2
.gitignore
vendored
@@ -1,3 +1,3 @@
|
||||
__pycache__
|
||||
.pytest_cache
|
||||
dist
|
||||
dist
|
||||
18
README.md
18
README.md
@@ -17,17 +17,27 @@ It moves files to a per-user _trash_ instead of permanently deleting them, while
|
||||
|
||||
## Installation
|
||||
|
||||
Install via Poetry:
|
||||
**NOTE:** To use `resrm` with `sudo`, the path to `resrm` must be in the `$PATH` seen by `root`.\
|
||||
Either:
|
||||
|
||||
* install `resrm` as `root` (_preferred_), or
|
||||
* add the path to `resrm` to the `secure_path` parameter in `/etc/sudoers`. For example, where `/home/user/.local/bin` is where `resrm` is:
|
||||
|
||||
``` bash
|
||||
Defaults secure_path="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/home/user/.local/bin"
|
||||
```
|
||||
|
||||
Install via PyPI (_preferred_):
|
||||
|
||||
```bash
|
||||
poetry add resrm
|
||||
pip install resrm
|
||||
```
|
||||
|
||||
Or clone the repo and install locally:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/mdaleo404/resrm.git
|
||||
cd resrm
|
||||
cd resrm/
|
||||
poetry install
|
||||
```
|
||||
|
||||
@@ -63,4 +73,4 @@ resrm --empty
|
||||
|
||||
Normal users: `~/.local/share/resrm/files`
|
||||
|
||||
Root user: `/root/.local/share/resrm/files`
|
||||
Root user: `/root/.local/share/resrm/files`
|
||||
|
||||
0
resrm/poetry.lock → poetry.lock
generated
0
resrm/poetry.lock → poetry.lock
generated
@@ -1,6 +1,6 @@
|
||||
[tool.poetry]
|
||||
name = "resrm"
|
||||
version = "0.1.0"
|
||||
version = "0.2.1"
|
||||
description = "drop-in replacement for rm with undo/restore built-in."
|
||||
authors = ["Marco D'Aleo <marco@marcodaleo.com>"]
|
||||
license = "GPL-3.0-or-later"
|
||||
@@ -1,66 +0,0 @@
|
||||
# resrm
|
||||
|
||||
**resrm** is a safe, drop-in replacement for the Linux `rm` command with **undo/restore support**.
|
||||
It moves files to a per-user _trash_ instead of permanently deleting them, while still allowing full `sudo` support for root-owned files.
|
||||
|
||||
---
|
||||
|
||||
## Features
|
||||
|
||||
- Move files and directories to a **trash folder** instead of permanent deletion
|
||||
- Restore deleted files by **short ID or exact basename**
|
||||
- Empty trash safely
|
||||
- Supports `-r`, `-f`, `-i`, `--perma` options
|
||||
- Works with `sudo` for root-owned files
|
||||
|
||||
---
|
||||
|
||||
## Installation
|
||||
|
||||
Install via Poetry:
|
||||
|
||||
```bash
|
||||
poetry add resrm
|
||||
```
|
||||
|
||||
Or clone the repo and install locally:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/mdaleo404/resrm.git
|
||||
cd resrm
|
||||
poetry install
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
# Move files to trash
|
||||
resrm file1 file2
|
||||
|
||||
# Recursive remove of a directory
|
||||
resrm -r mydir
|
||||
|
||||
# Force remove (ignore nonexistent)
|
||||
resrm -f file
|
||||
|
||||
# Interactive remove
|
||||
resrm -i file
|
||||
|
||||
# Permanent delete (bypass trash)
|
||||
resrm --perma file
|
||||
|
||||
# List trash entries
|
||||
resrm -l
|
||||
|
||||
# Restore a file by ID or basename
|
||||
resrm --restore <id|name>
|
||||
|
||||
# Empty the trash permanently
|
||||
resrm --empty
|
||||
```
|
||||
|
||||
## Trash Location
|
||||
|
||||
Normal users: `~/.local/share/resrm/files`
|
||||
|
||||
Root user: `/root/.local/share/resrm/files`
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
@@ -7,7 +7,7 @@ Basic usage:
|
||||
resrm -r dir # recursive remove (moves dir to trash)
|
||||
resrm -f file # ignore nonexistent, no prompt
|
||||
resrm -i file # interactive prompt before removal
|
||||
resrm --perma file # permanent delete (bypass trash)
|
||||
resrm --skip-trash file # permanent delete (bypass trash)
|
||||
resrm -l # list trash entries (neat table)
|
||||
resrm --restore <id|name> # restore by short-id (8 chars) or exact basename
|
||||
resrm --empty # empty trash entries (permanent)
|
||||
@@ -116,6 +116,43 @@ def find_candidates(identifier: str) -> List[Dict]:
|
||||
if id_matches:
|
||||
return id_matches
|
||||
|
||||
return []
|
||||
|
||||
def restore_many(identifiers: List[str]):
|
||||
"""Restore multiple files, prompting when needed."""
|
||||
for identifier in identifiers:
|
||||
candidates = find_candidates(identifier)
|
||||
|
||||
if not candidates:
|
||||
print(f"No match found for '{identifier}'")
|
||||
continue
|
||||
|
||||
# Only one match - restore immediately
|
||||
if len(candidates) == 1:
|
||||
restore_one(candidates[0])
|
||||
continue
|
||||
|
||||
# Multiple matches - prompt user
|
||||
print(f"Multiple matches for '{identifier}':")
|
||||
for i, entry in enumerate(candidates, start=1):
|
||||
print(f"{i}) {short_id(entry['id'])} {entry['orig_path']} ({entry['timestamp']})")
|
||||
|
||||
try:
|
||||
choice = input("Choose number to restore (or skip): ").strip()
|
||||
except KeyboardInterrupt:
|
||||
print("\nAborted.")
|
||||
return
|
||||
|
||||
if not choice.isdigit():
|
||||
print("Skipped.")
|
||||
continue
|
||||
|
||||
idx = int(choice) - 1
|
||||
if 0 <= idx < len(candidates):
|
||||
restore_one(candidates[idx])
|
||||
else:
|
||||
print("Invalid selection. Skipped.")
|
||||
|
||||
def restore_one(entry: Dict) -> bool:
|
||||
src = TRASH_DIR / entry["id"]
|
||||
dest = Path(entry["orig_path"])
|
||||
@@ -181,7 +218,7 @@ def empty_trash():
|
||||
save_meta(meta)
|
||||
print(f"Trash emptied ({count} entries removed).")
|
||||
|
||||
def move_to_trash(path: Path, interactive: bool, force: bool, recursive: bool, perma: bool):
|
||||
def move_to_trash(path: Path, interactive: bool, force: bool, skip_trash: bool):
|
||||
if not path.exists():
|
||||
if force:
|
||||
return
|
||||
@@ -189,7 +226,7 @@ def move_to_trash(path: Path, interactive: bool, force: bool, recursive: bool, p
|
||||
return
|
||||
|
||||
# Interactive prompt
|
||||
if interactive:
|
||||
if interactive and not force:
|
||||
try:
|
||||
yn = input(f"remove '{path}'? [y/N] ").strip().lower()
|
||||
except KeyboardInterrupt:
|
||||
@@ -199,7 +236,7 @@ def move_to_trash(path: Path, interactive: bool, force: bool, recursive: bool, p
|
||||
return
|
||||
|
||||
# Permanent delete path
|
||||
if perma:
|
||||
if skip_trash:
|
||||
try:
|
||||
if path.is_dir() and not path.is_symlink():
|
||||
shutil.rmtree(path)
|
||||
@@ -209,7 +246,7 @@ def move_to_trash(path: Path, interactive: bool, force: bool, recursive: bool, p
|
||||
print(f"Failed permanent delete: {e}")
|
||||
return
|
||||
|
||||
# 🚫 Prevent non-root user deleting root-owned files
|
||||
# Prevent non-root user deleting root-owned files
|
||||
try:
|
||||
st = path.stat()
|
||||
if st.st_uid == 0 and os.geteuid() != 0:
|
||||
@@ -218,7 +255,7 @@ def move_to_trash(path: Path, interactive: bool, force: bool, recursive: bool, p
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
# 🧭 Detect which trash to use (based on file owner)
|
||||
# Detect which trash to use (based on file owner)
|
||||
try:
|
||||
import pwd
|
||||
owner_uid = path.stat().st_uid
|
||||
@@ -270,20 +307,30 @@ def main(argv: Optional[List[str]] = None):
|
||||
parser = argparse.ArgumentParser(add_help=False)
|
||||
parser.add_argument("paths", nargs="*", help="files to remove")
|
||||
parser.add_argument("-r", action="store_true", help="recursive")
|
||||
parser.add_argument("-f", action="store_true", help="force")
|
||||
parser.add_argument("-f", "--force", action="store_true", help="force")
|
||||
parser.add_argument("-i", action="store_true", help="interactive")
|
||||
parser.add_argument("--perma", action="store_true", help="permanent delete")
|
||||
parser.add_argument("--restore", nargs=1, help="restore by id or basename")
|
||||
parser.add_argument("--skip-trash", action="store_true", help="permanent delete")
|
||||
parser.add_argument("--restore", nargs="+", metavar="item", help="restore by id or basename")
|
||||
parser.add_argument("-l", action="store_true", help="list trash")
|
||||
parser.add_argument("--empty", action="store_true", help="empty the trash permanently")
|
||||
parser.add_argument("--help", action="store_true", help="show help")
|
||||
parser.add_argument("-h", "--help", action="store_true", help="show help")
|
||||
parser.add_argument("-V", "--version", action="store_true", help="show version")
|
||||
args = parser.parse_args(argv)
|
||||
|
||||
# Always print docstring if --help or no args
|
||||
if args.help or not argv:
|
||||
# Always print docstring if -h or --help
|
||||
if args.help:
|
||||
print(__doc__)
|
||||
return
|
||||
|
||||
if args.version:
|
||||
print("resrm 0.2.1")
|
||||
return
|
||||
|
||||
if not args.paths and not (args.l or args.empty or args.restore):
|
||||
print("resrm: missing operand")
|
||||
print("Try 'resrm --help' for more information.")
|
||||
return
|
||||
|
||||
if args.l:
|
||||
list_trash()
|
||||
return
|
||||
@@ -293,7 +340,7 @@ def main(argv: Optional[List[str]] = None):
|
||||
return
|
||||
|
||||
if args.restore:
|
||||
restore(args.restore[0])
|
||||
restore_many(args.restore)
|
||||
return
|
||||
|
||||
if not args.paths:
|
||||
@@ -309,4 +356,4 @@ def main(argv: Optional[List[str]] = None):
|
||||
continue
|
||||
print(f"resrm: cannot remove '{pth}': Is a directory")
|
||||
continue
|
||||
move_to_trash(pth, interactive=args.i, force=args.f, recursive=args.r, perma=args.perma)
|
||||
move_to_trash(pth, interactive=args.i, force=args.force, skip_trash=args.skip_trash)
|
||||
Reference in New Issue
Block a user