Feature: Add trash support (#6237)

pkg/file/delete.go

@@ -58,20 +58,33 @@ func newRenamerRemoverImpl() renamerRemoverImpl {
 
 // Deleter is used to safely delete files and directories from the filesystem.
 // During a transaction, files and directories are marked for deletion using
-// the Files and Dirs methods. This will rename the files/directories to be
-// deleted. If the transaction is rolled back, then the files/directories can
-// be restored to their original state with the Abort method. If the
-// transaction is committed, the marked files are then deleted from the
-// filesystem using the Complete method.
+// the Files and Dirs methods. If TrashPath is set, files are moved to trash
+// immediately. Otherwise, they are renamed with a .delete suffix. If the
+// transaction is rolled back, then the files/directories can be restored to
+// their original state with the Rollback method. If the transaction is
+// committed, the marked files are then deleted from the filesystem using the
+// Commit method.
 type Deleter struct {
 	RenamerRemover RenamerRemover
 	files          []string
 	dirs           []string
+	TrashPath      string            // if set, files will be moved to this directory instead of being permanently deleted
+	trashedPaths   map[string]string // map of original path -> trash path (only used when TrashPath is set)
 }
 
 func NewDeleter() *Deleter {
 	return &Deleter{
 		RenamerRemover: newRenamerRemoverImpl(),
+		TrashPath:      "",
+		trashedPaths:   make(map[string]string),
+	}
+}
+
+func NewDeleterWithTrash(trashPath string) *Deleter {
+	return &Deleter{
+		RenamerRemover: newRenamerRemoverImpl(),
+		TrashPath:      trashPath,
+		trashedPaths:   make(map[string]string),
 	}
 }
 
@@ -92,6 +105,17 @@ func (d *Deleter) RegisterHooks(ctx context.Context) {
 // Abort should be called to restore marked files if this function returns an
 // error.
 func (d *Deleter) Files(paths []string) error {
+	return d.filesInternal(paths, false)
+}
+
+// FilesWithoutTrash designates files to be deleted, bypassing the trash directory.
+// Files will be permanently deleted even if TrashPath is configured.
+// This is useful for deleting generated files that can be easily recreated.
+func (d *Deleter) FilesWithoutTrash(paths []string) error {
+	return d.filesInternal(paths, true)
+}
+
+func (d *Deleter) filesInternal(paths []string, bypassTrash bool) error {
 	for _, p := range paths {
 		// fail silently if the file does not exist
 		if _, err := d.RenamerRemover.Stat(p); err != nil {
@@ -103,7 +127,7 @@ func (d *Deleter) Files(paths []string) error {
 			return fmt.Errorf("check file %q exists: %w", p, err)
 		}
 
-		if err := d.renameForDelete(p); err != nil {
+		if err := d.renameForDelete(p, bypassTrash); err != nil {
 			return fmt.Errorf("marking file %q for deletion: %w", p, err)
 		}
 		d.files = append(d.files, p)
@@ -118,6 +142,17 @@ func (d *Deleter) Files(paths []string) error {
 // Abort should be called to restore marked files/directories if this function returns an
 // error.
 func (d *Deleter) Dirs(paths []string) error {
+	return d.dirsInternal(paths, false)
+}
+
+// DirsWithoutTrash designates directories to be deleted, bypassing the trash directory.
+// Directories will be permanently deleted even if TrashPath is configured.
+// This is useful for deleting generated directories that can be easily recreated.
+func (d *Deleter) DirsWithoutTrash(paths []string) error {
+	return d.dirsInternal(paths, true)
+}
+
+func (d *Deleter) dirsInternal(paths []string, bypassTrash bool) error {
 	for _, p := range paths {
 		// fail silently if the file does not exist
 		if _, err := d.RenamerRemover.Stat(p); err != nil {
@@ -129,7 +164,7 @@ func (d *Deleter) Dirs(paths []string) error {
 			return fmt.Errorf("check directory %q exists: %w", p, err)
 		}
 
-		if err := d.renameForDelete(p); err != nil {
+		if err := d.renameForDelete(p, bypassTrash); err != nil {
 			return fmt.Errorf("marking directory %q for deletion: %w", p, err)
 		}
 		d.dirs = append(d.dirs, p)
@@ -150,33 +185,65 @@ func (d *Deleter) Rollback() {
 
 	d.files = nil
 	d.dirs = nil
+	d.trashedPaths = make(map[string]string)
 }
 
 // Commit deletes all files marked for deletion and clears the marked list.
+// When using trash, files have already been moved during renameForDelete, so
+// this just clears the tracking. Otherwise, permanently delete the .delete files.
 // Any errors encountered are logged. All files will be attempted, regardless
 // of the errors encountered.
 func (d *Deleter) Commit() {
-	for _, f := range d.files {
-		if err := d.RenamerRemover.Remove(f + deleteFileSuffix); err != nil {
-			logger.Warnf("Error deleting file %q: %v", f+deleteFileSuffix, err)
+	if d.TrashPath != "" {
+		// Files were already moved to trash during renameForDelete, just clear tracking
+		logger.Debugf("Commit: %d files and %d directories already in trash, clearing tracking", len(d.files), len(d.dirs))
+	} else {
+		// Permanently delete files and directories marked with .delete suffix
+		for _, f := range d.files {
+			if err := d.RenamerRemover.Remove(f + deleteFileSuffix); err != nil {
+				logger.Warnf("Error deleting file %q: %v", f+deleteFileSuffix, err)
+			}
 		}
-	}
 
-	for _, f := range d.dirs {
-		if err := d.RenamerRemover.RemoveAll(f + deleteFileSuffix); err != nil {
-			logger.Warnf("Error deleting directory %q: %v", f+deleteFileSuffix, err)
+		for _, f := range d.dirs {
+			if err := d.RenamerRemover.RemoveAll(f + deleteFileSuffix); err != nil {
+				logger.Warnf("Error deleting directory %q: %v", f+deleteFileSuffix, err)
+			}
 		}
 	}
 
 	d.files = nil
 	d.dirs = nil
+	d.trashedPaths = make(map[string]string)
 }
 
-func (d *Deleter) renameForDelete(path string) error {
+func (d *Deleter) renameForDelete(path string, bypassTrash bool) error {
+	if d.TrashPath != "" && !bypassTrash {
+		// Move file to trash immediately
+		trashDest, err := fsutil.MoveToTrash(path, d.TrashPath)
+		if err != nil {
+			return err
+		}
+		d.trashedPaths[path] = trashDest
+		logger.Infof("Moved %q to trash at %s", path, trashDest)
+		return nil
+	}
+
+	// Standard behavior: rename with .delete suffix (or when bypassing trash)
 	return d.RenamerRemover.Rename(path, path+deleteFileSuffix)
 }
 
 func (d *Deleter) renameForRestore(path string) error {
+	if d.TrashPath != "" {
+		// Restore file from trash
+		trashPath, ok := d.trashedPaths[path]
+		if !ok {
+			return fmt.Errorf("no trash path found for %q", path)
+		}
+		return d.RenamerRemover.Rename(trashPath, path)
+	}
+
+	// Standard behavior: restore from .delete suffix
 	return d.RenamerRemover.Rename(path+deleteFileSuffix, path)
 }