Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Delete empty parent directories on gopass rm -r #1725

Merged
merged 1 commit into from
Jan 19, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions internal/action/delete.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"fmt"

"github.com/gopasspw/gopass/pkg/ctxutil"
"github.com/gopasspw/gopass/pkg/debug"
"github.com/gopasspw/gopass/pkg/termio"

"github.com/urfave/cli/v2"
Expand Down Expand Up @@ -39,17 +40,21 @@ func (s *Action) Delete(c *cli.Context) error {
}

if recursive {
debug.Log("pruning %q", name)
if err := s.Store.Prune(ctx, name); err != nil {
return ExitError(ExitUnknown, err, "failed to prune '%s': %s", name, err)
}
debug.Log("pruned %q", name)
return nil
}

// deletes a single key from a YAML doc
if key != "" {
debug.Log("removing key %q from %q", key, name)
return s.deleteKeyFromYAML(ctx, name, key)
}

debug.Log("removing entry %q", name)
if err := s.Store.Delete(ctx, name); err != nil {
return ExitError(ExitIO, err, "Can not delete '%s': %s", name, err)
}
Expand Down
65 changes: 63 additions & 2 deletions internal/backend/storage/fs/fsck.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@ package fs

import (
"context"
"io/ioutil"
"os"
"path/filepath"
"sort"
"strings"
"syscall"

"github.com/gopasspw/gopass/internal/out"
Expand All @@ -23,7 +26,7 @@ func (s *Store) Fsck(ctx context.Context) error {
dirs := make(map[string]struct{}, len(entries))
for _, entry := range entries {
pcb()
debug.Log("Checking %s", entry)
debug.Log("checking entry %q", entry)

filename := filepath.Join(s.path, entry)
dirs[filepath.Dir(filename)] = struct{}{}
Expand All @@ -34,11 +37,18 @@ func (s *Store) Fsck(ctx context.Context) error {
}

for dir := range dirs {
debug.Log("checking dir %q", dir)
if err := s.fsckCheckDir(ctx, dir); err != nil {
return err
}
}
return nil

if err := s.fsckCheckEmptyDirs(); err != nil {
return err
}

debug.Log("checking root dir %q", s.path)
return s.fsckCheckDir(ctx, s.path)
}

func (s *Store) fsckCheckFile(ctx context.Context, filename string) error {
Expand Down Expand Up @@ -90,3 +100,54 @@ func (s *Store) fsckCheckDir(ctx context.Context, dirname string) error {
}
return nil
}

func (s *Store) fsckCheckEmptyDirs() error {
v := []string{}
if err := filepath.Walk(s.path, func(fp string, fi os.FileInfo, ferr error) error {
if ferr != nil {
return ferr
}
if !fi.IsDir() {
return nil
}
if strings.HasPrefix(fi.Name(), ".") {
return filepath.SkipDir
}
if fp == s.path {
return nil
}

// add candidate
debug.Log("adding candidate %q", fp)
v = append(v, fp)
return nil
}); err != nil {
return err
}

// start with longest path (deepest dir)
sort.Slice(v, func(i, j int) bool {
return len(v[i]) > len(v[j])
})

for _, d := range v {
if err := fsckRemoveEmptyDir(d); err != nil {
return err
}
}
return nil
}

func fsckRemoveEmptyDir(fp string) error {
ls, err := ioutil.ReadDir(fp)
if err != nil {
return err
}
if len(ls) > 0 {
debug.Log("dir %q is not empty (%d)", fp, len(ls))
return nil
}

debug.Log("removing %q ...", fp)
return os.Remove(fp)
}
8 changes: 7 additions & 1 deletion internal/backend/storage/fs/store.go
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ func (s *Store) removeEmptyParentDirectories(path string) error {
return nil
}

debug.Log("removing empty parent dir: %q", parent)
err := os.Remove(parent)
switch {
case err == nil:
Expand Down Expand Up @@ -162,7 +163,12 @@ func (s *Store) IsDir(ctx context.Context, name string) bool {
func (s *Store) Prune(ctx context.Context, prefix string) error {
path := filepath.Join(s.path, filepath.Clean(prefix))
debug.Log("Purning %s from %s", prefix, path)
return os.RemoveAll(path)

if err := os.RemoveAll(path); err != nil {
return err
}

return s.removeEmptyParentDirectories(path)
}

// Name returns the name of this backend
Expand Down
4 changes: 4 additions & 0 deletions internal/store/leaf/move.go
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@ func (s *Store) delete(ctx context.Context, name string, recurse bool) error {
}
}
if err := s.deleteSingle(ctx, path); err != nil {
// might fail if we deleted the root of a tree which isn't a secret
// itself
if !recurse {
return err
}
Expand Down Expand Up @@ -115,6 +117,7 @@ func (s *Store) deleteRecurse(ctx context.Context, name, path string) error {

debug.Log("Pruning %s", name)
if err := s.storage.Prune(ctx, name); err != nil {
debug.Log("storage.Prune(%v) failed", name)
return err
}

Expand All @@ -124,6 +127,7 @@ func (s *Store) deleteRecurse(ctx context.Context, name, path string) error {
}
return errors.Wrapf(err, "failed to add '%s' to git", path)
}
debug.Log("pruned")
return nil
}

Expand Down
3 changes: 1 addition & 2 deletions internal/store/leaf/move_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -280,8 +280,7 @@ func TestPrune(t *testing.T) {
assert.Error(t, err)

// delete empty folder
assert.NoError(t, s.Prune(ctx, "foo/"))
assert.Error(t, s.Prune(ctx, "foo/"))
assert.Error(t, s.Prune(ctx, "foo/"), "delete non-existing entry")
}
},
},
Expand Down