coreapi: Pin option for Object.Put

License: MIT Signed-off-by: Łukasz Magiera <magik6k@gmail.com>
ipfs · Feb 4, 2018 · 5a9ac70 · 5a9ac70
1 parent a804b83
commit 5a9ac70
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 0 deletions.
diff --git a/core/coreapi/interface/interface.go b/core/coreapi/interface/interface.go
@@ -280,6 +280,10 @@ type ObjectAPI interface {
 	// * "base64"
 	WithDataType(t string) options.ObjectPutOption
 
+	// WithPin is an option for Put which specifies whether to pin the added
+	// objects, default is false
+	WithPin(bool) options.ObjectPutOption
+
 	// Get returns the node for the path
 	Get(context.Context, Path) (Node, error)
 

diff --git a/core/coreapi/interface/options/object.go b/core/coreapi/interface/options/object.go
@@ -7,6 +7,7 @@ type ObjectNewSettings struct {
 type ObjectPutSettings struct {
 	InputEnc string
 	DataType string
+	Pin      bool
 }
 
 type ObjectAddLinkSettings struct {
@@ -35,6 +36,7 @@ func ObjectPutOptions(opts ...ObjectPutOption) (*ObjectPutSettings, error) {
 	options := &ObjectPutSettings{
 		InputEnc: "json",
 		DataType: "text",
+		Pin:      false,
 	}
 
 	for _, opt := range opts {
@@ -83,6 +85,13 @@ func (api *ObjectOptions) WithDataType(t string) ObjectPutOption {
 	}
 }
 
+func (api *ObjectOptions) WithPin(pin bool) ObjectPutOption {
+	return func(settings *ObjectPutSettings) error {
+		settings.Pin = pin
+		return nil
+	}
+}
+
 func (api *ObjectOptions) WithCreate(create bool) ObjectAddLinkOption {
 	return func(settings *ObjectAddLinkSettings) error {
 		settings.Create = create

diff --git a/core/coreapi/object.go b/core/coreapi/object.go
@@ -15,6 +15,7 @@ import (
 	caopts "github.com/ipfs/go-ipfs/core/coreapi/interface/options"
 	dag "github.com/ipfs/go-ipfs/merkledag"
 	dagutils "github.com/ipfs/go-ipfs/merkledag/utils"
+	pin "github.com/ipfs/go-ipfs/pin"
 	ft "github.com/ipfs/go-ipfs/unixfs"
 
 	cid "gx/ipfs/QmcZfnkapfECQGcLZaf9B79NRg7cRa9EnZh4LSbkCzwNvY/go-cid"
@@ -119,11 +120,23 @@ func (api *ObjectAPI) Put(ctx context.Context, src io.Reader, opts ...caopts.Obj
 		return nil, err
 	}
 
+	if options.Pin {
+		defer api.node.Blockstore.PinLock().Unlock()
+	}
+
 	err = api.node.DAG.Add(ctx, dagnode)
 	if err != nil {
 		return nil, err
 	}
 
+	if options.Pin {
+		api.node.Pinning.PinWithMode(dagnode.Cid(), pin.Recursive)
+		err = api.node.Pinning.Flush()
+		if err != nil {
+			return nil, err
+		}
+	}
+
 	return api.ParseCid(dagnode.Cid()), nil
 }