"block rm": move core functionally into blockstore_util package

Note: this code can not go in the "blockstore" package due to a
circular dependency with the "pin" package.

License: MIT
Signed-off-by: Kevin Atkinson <k@kevina.org>

blocks/blockstore/util/remove.go

+package blockstore_util
+
+import (
+	"fmt"
+	"io"
+
+	bs "github.com/ipfs/go-ipfs/blocks/blockstore"
+	"github.com/ipfs/go-ipfs/pin"
+	ds "gx/ipfs/QmbzuUusHqaLLoNTDEVLcSF6vZDHZDLPC7p4bztRvvkXxU/go-datastore"
+	key "gx/ipfs/Qmce4Y4zg3sYr7xKM5UueS67vhNni6EeWgCRnb7MbLJMew/go-key"
+	cid "gx/ipfs/QmfSc2xehWmWLnwwYR91Y8QF4xdASypTFVknutoKQS3GHp/go-cid"
+)
+
+type RemovedBlock struct {
+	Hash  string `json:",omitempty"`
+	Error string `json:",omitempty"`
+}
+
+type RmBlocksOpts struct {
+	Prefix string
+	Quiet  bool
+	Force  bool
+}
+
+func RmBlocks(blocks bs.GCBlockstore, pins pin.Pinner, out chan<- interface{}, cids []*cid.Cid, opts RmBlocksOpts) error {
+	go func() {
+		defer close(out)
+
+		unlocker := blocks.GCLock()
+		defer unlocker.Unlock()
+
+		stillOkay, err := checkIfPinned(pins, cids, out)
+		if err != nil {
+			out <- &RemovedBlock{Error: fmt.Sprintf("pin check failed: %s", err)}
+			return
+		}
+
+		for _, c := range stillOkay {
+			err := blocks.DeleteBlock(key.Key(c.Hash()))
+			if err != nil && opts.Force && (err == bs.ErrNotFound || err == ds.ErrNotFound) {
+				// ignore non-existent blocks
+			} else if err != nil {
+				out <- &RemovedBlock{Hash: c.String(), Error: err.Error()}
+			} else if !opts.Quiet {
+				out <- &RemovedBlock{Hash: c.String()}
+			}
+		}
+	}()
+	return nil
+}
+
+func checkIfPinned(pins pin.Pinner, cids []*cid.Cid, out chan<- interface{}) ([]*cid.Cid, error) {
+	stillOkay := make([]*cid.Cid, 0, len(cids))
+	res, err := pins.CheckIfPinned(cids...)
+	if err != nil {
+		return nil, err
+	}
+	for _, r := range res {
+		if !r.Pinned() {
+			stillOkay = append(stillOkay, r.Key)
+		} else {
+			out <- &RemovedBlock{
+				Hash:  r.Key.String(),
+				Error: r.String(),
+			}
+		}
+	}
+	return stillOkay, nil
+}
+
+type RmError struct {
+	Fatal bool
+	Msg   string
+}
+
+func (err RmError) Error() string { return err.Msg }
+
+func ProcRmOutput(in <-chan interface{}, sout io.Writer, serr io.Writer) *RmError {
+	someFailed := false
+	for res := range in {
+		r := res.(*RemovedBlock)
+		if r.Hash == "" && r.Error != "" {
+			return &RmError{
+				Fatal: true,
+				Msg:   fmt.Sprintf("aborted: %s", r.Error),
+			}
+		} else if r.Error != "" {
+			someFailed = true
+			fmt.Fprintf(serr, "cannot remove %s: %s\n", r.Hash, r.Error)
+		} else {
+			fmt.Fprintf(sout, "removed %s\n", r.Hash)
+		}
+	}
+	if someFailed {
+		return &RmError{
+			Msg: fmt.Sprintf("some blocks not removed"),
+		}
+	}
+	return nil
+}

core/commands/block.go

@@ -9,12 +9,9 @@ import (
 	"strings"
 
 	"github.com/ipfs/go-ipfs/blocks"
-	bs "github.com/ipfs/go-ipfs/blocks/blockstore"
+	util "github.com/ipfs/go-ipfs/blocks/blockstore/util"
 	cmds "github.com/ipfs/go-ipfs/commands"
-	"github.com/ipfs/go-ipfs/pin"
 	u "gx/ipfs/QmZNVWh8LLjAavuQ2JXuFmuYH3C11xo988vSgp7UQrTRj1/go-ipfs-util"
-	ds "gx/ipfs/QmbzuUusHqaLLoNTDEVLcSF6vZDHZDLPC7p4bztRvvkXxU/go-datastore"
-	key "gx/ipfs/Qmce4Y4zg3sYr7xKM5UueS67vhNni6EeWgCRnb7MbLJMew/go-key"
 	cid "gx/ipfs/QmfSc2xehWmWLnwwYR91Y8QF4xdASypTFVknutoKQS3GHp/go-cid"
 )
 
@@ -224,19 +221,15 @@ It takes a list of base58 encoded multihashs to remove.
 			cids = append(cids, c)
 		}
 		outChan := make(chan interface{})
+		err = util.RmBlocks(n.Blockstore, n.Pinning, outChan, cids, util.RmBlocksOpts{
+			Quiet: quiet,
+			Force: force,
+		})
+		if err != nil {
+			res.SetError(err, cmds.ErrNormal)
+			return
+		}
 		res.SetOutput((<-chan interface{})(outChan))
-		go func() {
-			defer close(outChan)
-			pinning := n.Pinning
-			err := rmBlocks(n.Blockstore, pinning, outChan, cids, rmBlocksOpts{
-				quiet: quiet,
-				force: force,
-			})
-			if err != nil {
-				outChan <- &RemovedBlock{Error: err.Error()}
-			}
-		}()
-		return
 	},
 	PostRun: func(req cmds.Request, res cmds.Response) {
 		if res.Error() != nil {
@@ -249,73 +242,10 @@ It takes a list of base58 encoded multihashs to remove.
 		}
 		res.SetOutput(nil)
 
-		someFailed := false
-		for out := range outChan {
-			o := out.(*RemovedBlock)
-			if o.Hash == "" && o.Error != "" {
-				res.SetError(fmt.Errorf("aborted: %s", o.Error), cmds.ErrNormal)
-				return
-			} else if o.Error != "" {
-				someFailed = true
-				fmt.Fprintf(res.Stderr(), "cannot remove %s: %s\n", o.Hash, o.Error)
-			} else {
-				fmt.Fprintf(res.Stdout(), "removed %s\n", o.Hash)
-			}
-		}
-		if someFailed {
-			res.SetError(fmt.Errorf("some blocks not removed"), cmds.ErrNormal)
+		err := util.ProcRmOutput(outChan, res.Stdout(), res.Stderr())
+		if err != nil {
+			res.SetError(err, cmds.ErrNormal)
 		}
 	},
-	Type: RemovedBlock{},
-}
-
-type RemovedBlock struct {
-	Hash  string `json:",omitempty"`
-	Error string `json:",omitempty"`
-}
-
-type rmBlocksOpts struct {
-	quiet bool
-	force bool
-}
-
-func rmBlocks(blocks bs.GCBlockstore, pins pin.Pinner, out chan<- interface{}, cids []*cid.Cid, opts rmBlocksOpts) error {
-	unlocker := blocks.GCLock()
-	defer unlocker.Unlock()
-
-	stillOkay, err := checkIfPinned(pins, cids, out)
-	if err != nil {
-		return fmt.Errorf("pin check failed: %s", err)
-	}
-
-	for _, c := range stillOkay {
-		err := blocks.DeleteBlock(key.Key(c.Hash()))
-		if err != nil && opts.force && (err == bs.ErrNotFound || err == ds.ErrNotFound) {
-			// ignore non-existent blocks
-		} else if err != nil {
-			out <- &RemovedBlock{Hash: c.String(), Error: err.Error()}
-		} else if !opts.quiet {
-			out <- &RemovedBlock{Hash: c.String()}
-		}
-	}
-	return nil
-}
-
-func checkIfPinned(pins pin.Pinner, cids []*cid.Cid, out chan<- interface{}) ([]*cid.Cid, error) {
-	stillOkay := make([]*cid.Cid, 0, len(cids))
-	res, err := pins.CheckIfPinned(cids...)
-	if err != nil {
-		return nil, err
-	}
-	for _, r := range res {
-		if !r.Pinned() {
-			stillOkay = append(stillOkay, r.Key)
-		} else {
-			out <- &RemovedBlock{
-				Hash:  r.Key.String(),
-				Error: r.String(),
-			}
-		}
-	}
-	return stillOkay, nil
+	Type: util.RemovedBlock{},
 }