coreapi: separate path into two types

magik6k · magik6k · commit 4598c0e30c7a · 2018-03-26T12:15:16.000+02:00
License: MIT
Signed-off-by: Łukasz Magiera &lt;magik6k@gmail.com&gt;
diff --git a/core/coreapi/block.go b/core/coreapi/block.go
@@ -23,11 +23,11 @@ type BlockAPI struct {
 }
 
 type BlockStat struct {
-	path coreiface.Path
+	path coreiface.ResolvedPath
 	size int
 }
 
-func (api *BlockAPI) Put(ctx context.Context, src io.Reader, opts ...caopts.BlockPutOption) (coreiface.Path, error) {
+func (api *BlockAPI) Put(ctx context.Context, src io.Reader, opts ...caopts.BlockPutOption) (coreiface.ResolvedPath, error) {
 	settings, err := caopts.BlockPutOptions(opts...)
 	if err != nil {
 		return nil, err
@@ -72,7 +72,12 @@ func (api *BlockAPI) Put(ctx context.Context, src io.Reader, opts ...caopts.Bloc
 }
 
 func (api *BlockAPI) Get(ctx context.Context, p coreiface.Path) (io.Reader, error) {
-	b, err := api.node.Blocks.GetBlock(ctx, p.Cid())
+	rp, err := api.ResolvePath(ctx, p)
+	if err != nil {
+		return nil, err
+	}
+
+	b, err := api.node.Blocks.GetBlock(ctx, rp.Cid())
 	if err != nil {
 		return nil, err
 	}
@@ -81,11 +86,16 @@ func (api *BlockAPI) Get(ctx context.Context, p coreiface.Path) (io.Reader, erro
 }
 
 func (api *BlockAPI) Rm(ctx context.Context, p coreiface.Path, opts ...caopts.BlockRmOption) error {
+	rp, err := api.ResolvePath(ctx, p)
+	if err != nil {
+		return err
+	}
+
 	settings, err := caopts.BlockRmOptions(opts...)
 	if err != nil {
 		return err
 	}
-	cids := []*cid.Cid{p.Cid()}
+	cids := []*cid.Cid{rp.Cid()}
 	o := util.RmBlocksOpts{Force: settings.Force}
 
 	out, err := util.RmBlocks(api.node.Blockstore, api.node.Pinning, cids, o)
@@ -114,7 +124,12 @@ func (api *BlockAPI) Rm(ctx context.Context, p coreiface.Path, opts ...caopts.Bl
 }
 
 func (api *BlockAPI) Stat(ctx context.Context, p coreiface.Path) (coreiface.BlockStat, error) {
-	b, err := api.node.Blocks.GetBlock(ctx, p.Cid())
+	rp, err := api.ResolvePath(ctx, p)
+	if err != nil {
+		return nil, err
+	}
+
+	b, err := api.node.Blocks.GetBlock(ctx, rp.Cid())
 	if err != nil {
 		return nil, err
 	}
@@ -129,6 +144,6 @@ func (bs *BlockStat) Size() int {
 	return bs.size
 }
 
-func (bs *BlockStat) Path() coreiface.Path {
+func (bs *BlockStat) Path() coreiface.ResolvedPath {
 	return bs.path
 }
diff --git a/core/coreapi/coreapi.go b/core/coreapi/coreapi.go
@@ -3,17 +3,15 @@ package coreapi
 import (
 	core "github.com/ipfs/go-ipfs/core"
 	coreiface "github.com/ipfs/go-ipfs/core/coreapi/interface"
-	caopts "github.com/ipfs/go-ipfs/core/coreapi/interface/options"
 )
 
 type CoreAPI struct {
 	node *core.IpfsNode
-	*caopts.ApiOptions
 }
 
 // NewCoreAPI creates new instance of IPFS CoreAPI backed by go-ipfs Node.
 func NewCoreAPI(n *core.IpfsNode) coreiface.CoreAPI {
-	api := &CoreAPI{n, nil}
+	api := &CoreAPI{n}
 	return api
 }
 
diff --git a/core/coreapi/dag.go b/core/coreapi/dag.go
@@ -23,7 +23,7 @@ type DagAPI struct {
 // Put inserts data using specified format and input encoding. Unless used with
 // `WithCodes` or `WithHash`, the defaults "dag-cbor" and "sha256" are used.
 // Returns the path of the inserted data.
-func (api *DagAPI) Put(ctx context.Context, src io.Reader, opts ...caopts.DagPutOption) (coreiface.Path, error) {
+func (api *DagAPI) Put(ctx context.Context, src io.Reader, opts ...caopts.DagPutOption) (coreiface.ResolvedPath, error) {
 	settings, err := caopts.DagPutOptions(opts...)
 	if err != nil {
 		return nil, err
diff --git a/core/coreapi/dag_test.go b/core/coreapi/dag_test.go
@@ -70,7 +70,7 @@ func TestPath(t *testing.T) {
 		t.Error(err)
 	}
 
-	p, err := api.ParsePath(ctx, path.Join(res.Cid().String(), "lnk"))
+	p, err := api.ParsePath(path.Join(res.Cid().String(), "lnk"))
 	if err != nil {
 		t.Error(err)
 	}
diff --git a/core/coreapi/interface/block.go b/core/coreapi/interface/block.go
@@ -13,13 +13,13 @@ type BlockStat interface {
 	Size() int
 
 	// Path returns path to the block
-	Path() Path
+	Path() ResolvedPath
 }
 
 // BlockAPI specifies the interface to the block layer
 type BlockAPI interface {
 	// Put imports raw block data, hashing it using specified settings.
-	Put(context.Context, io.Reader, ...options.BlockPutOption) (Path, error)
+	Put(context.Context, io.Reader, ...options.BlockPutOption) (ResolvedPath, error)
 
 	// WithFormat is an option for Put which specifies the multicodec to use to
 	// serialize the object. Default is "v0"
diff --git a/core/coreapi/interface/coreapi.go b/core/coreapi/interface/coreapi.go
@@ -5,8 +5,6 @@ package iface
 import (
 	"context"
 
-	options "github.com/ipfs/go-ipfs/core/coreapi/interface/options"
-
 	cid "gx/ipfs/QmcZfnkapfECQGcLZaf9B79NRg7cRa9EnZh4LSbkCzwNvY/go-cid"
 	ipld "gx/ipfs/Qme5bWv7wtjUNGsK2BNGVUFPKiuxWrsqrtvYwCLRw8YFES/go-ipld-format"
 )
@@ -35,19 +33,15 @@ type CoreAPI interface {
 	Object() ObjectAPI
 
 	// ResolvePath resolves the path using Unixfs resolver
-	ResolvePath(context.Context, Path) (Path, error)
+	ResolvePath(context.Context, Path) (ResolvedPath, error)
 
 	// ResolveNode resolves the path (if not resolved already) using Unixfs
 	// resolver, gets and returns the resolved Node
 	ResolveNode(context.Context, Path) (ipld.Node, error)
 
 	// ParsePath parses string path to a Path
-	ParsePath(context.Context, string, ...options.ParsePathOption) (Path, error)
-
-	// WithResolve is an option for ParsePath which when set to true tells
-	// ParsePath to also resolve the path
-	WithResolve(bool) options.ParsePathOption
+	ParsePath(context.Context, string) (Path, error)
 
 	// ParseCid creates new path from the provided CID
-	ParseCid(*cid.Cid) Path
+	ParseCid(*cid.Cid) ResolvedPath
 }
diff --git a/core/coreapi/interface/dag.go b/core/coreapi/interface/dag.go
@@ -14,7 +14,7 @@ type DagAPI interface {
 	// Put inserts data using specified format and input encoding.
 	// Unless used with WithCodec or WithHash, the defaults "dag-cbor" and
 	// "sha256" are used.
-	Put(ctx context.Context, src io.Reader, opts ...options.DagPutOption) (Path, error)
+	Put(ctx context.Context, src io.Reader, opts ...options.DagPutOption) (ResolvedPath, error)
 
 	// WithInputEnc is an option for Put which specifies the input encoding of the
 	// data. Default is "json", most formats/codecs support "raw"
diff --git a/core/coreapi/interface/object.go b/core/coreapi/interface/object.go
@@ -46,7 +46,7 @@ type ObjectAPI interface {
 	WithType(string) options.ObjectNewOption
 
 	// Put imports the data into merkledag
-	Put(context.Context, io.Reader, ...options.ObjectPutOption) (Path, error)
+	Put(context.Context, io.Reader, ...options.ObjectPutOption) (ResolvedPath, error)
 
 	// WithInputEnc is an option for Put which specifies the input encoding of the
 	// data. Default is "json".
@@ -79,18 +79,18 @@ type ObjectAPI interface {
 	// AddLink adds a link under the specified path. child path can point to a
 	// subdirectory within the patent which must be present (can be overridden
 	// with WithCreate option).
-	AddLink(ctx context.Context, base Path, name string, child Path, opts ...options.ObjectAddLinkOption) (Path, error)
+	AddLink(ctx context.Context, base Path, name string, child Path, opts ...options.ObjectAddLinkOption) (ResolvedPath, error)
 
 	// WithCreate is an option for AddLink which specifies whether create required
 	// directories for the child
 	WithCreate(create bool) options.ObjectAddLinkOption
 
 	// RmLink removes a link from the node
-	RmLink(ctx context.Context, base Path, link string) (Path, error)
+	RmLink(ctx context.Context, base Path, link string) (ResolvedPath, error)
 
 	// AppendData appends data to the node
-	AppendData(context.Context, Path, io.Reader) (Path, error)
+	AppendData(context.Context, Path, io.Reader) (ResolvedPath, error)
 
 	// SetData sets the data contained in the node
-	SetData(context.Context, Path, io.Reader) (Path, error)
+	SetData(context.Context, Path, io.Reader) (ResolvedPath, error)
 }
diff --git a/core/coreapi/interface/options/path.go b/core/coreapi/interface/options/path.go
diff --git a/core/coreapi/interface/path.go b/core/coreapi/interface/path.go
@@ -6,13 +6,24 @@ import (
 
 // Path is a generic wrapper for paths used in the API. A path can be resolved
 // to a CID using one of Resolve functions in the API.
+// TODO: figure out/explain namespaces
 type Path interface {
 	// String returns the path as a string.
 	String() string
+
+	// Namespace returns the first component of the path
+	Namespace() string
+}
+
+// ResolvedPath is a resolved Path
+type ResolvedPath interface {
 	// Cid returns cid referred to by path
 	Cid() *cid.Cid
+
 	// Root returns cid of root path
 	Root() *cid.Cid
-	// Resolved returns whether path has been fully resolved
-	Resolved() bool
+
+	//TODO: Path remainder
+
+	Path
 }
diff --git a/core/coreapi/interface/pin.go b/core/coreapi/interface/pin.go
@@ -9,7 +9,7 @@ import (
 // Pin holds information about pinned resource
 type Pin interface {
 	// Path to the pinned object
-	Path() Path
+	Path() ResolvedPath
 
 	// Type of the pin
 	Type() string
@@ -27,7 +27,7 @@ type PinStatus interface {
 // BadPinNode is a node that has been marked as bad by Pin.Verify
 type BadPinNode interface {
 	// Path is the path of the node
-	Path() Path
+	Path() ResolvedPath
 
 	// Err is the reason why the node has been marked as bad
 	Err() error
diff --git a/core/coreapi/interface/unixfs.go b/core/coreapi/interface/unixfs.go
@@ -10,7 +10,7 @@ import (
 // UnixfsAPI is the basic interface to immutable files in IPFS
 type UnixfsAPI interface {
 	// Add imports the data from the reader into merkledag file
-	Add(context.Context, io.Reader) (Path, error)
+	Add(context.Context, io.Reader) (ResolvedPath, error)
 
 	// Cat returns a reader for the file
 	Cat(context.Context, Path) (Reader, error)
diff --git a/core/coreapi/object.go b/core/coreapi/object.go
@@ -59,7 +59,7 @@ func (api *ObjectAPI) New(ctx context.Context, opts ...caopts.ObjectNewOption) (
 	return n, nil
 }
 
-func (api *ObjectAPI) Put(ctx context.Context, src io.Reader, opts ...caopts.ObjectPutOption) (coreiface.Path, error) {
+func (api *ObjectAPI) Put(ctx context.Context, src io.Reader, opts ...caopts.ObjectPutOption) (coreiface.ResolvedPath, error) {
 	options, err := caopts.ObjectPutOptions(opts...)
 	if err != nil {
 		return nil, err
@@ -183,7 +183,7 @@ func (api *ObjectAPI) Stat(ctx context.Context, path coreiface.Path) (*coreiface
 	return out, nil
 }
 
-func (api *ObjectAPI) AddLink(ctx context.Context, base coreiface.Path, name string, child coreiface.Path, opts ...caopts.ObjectAddLinkOption) (coreiface.Path, error) {
+func (api *ObjectAPI) AddLink(ctx context.Context, base coreiface.Path, name string, child coreiface.Path, opts ...caopts.ObjectAddLinkOption) (coreiface.ResolvedPath, error) {
 	options, err := caopts.ObjectAddLinkOptions(opts...)
 	if err != nil {
 		return nil, err
@@ -224,7 +224,7 @@ func (api *ObjectAPI) AddLink(ctx context.Context, base coreiface.Path, name str
 	return api.ParseCid(nnode.Cid()), nil
 }
 
-func (api *ObjectAPI) RmLink(ctx context.Context, base coreiface.Path, link string) (coreiface.Path, error) {
+func (api *ObjectAPI) RmLink(ctx context.Context, base coreiface.Path, link string) (coreiface.ResolvedPath, error) {
 	baseNd, err := api.core().ResolveNode(ctx, base)
 	if err != nil {
 		return nil, err
@@ -250,15 +250,15 @@ func (api *ObjectAPI) RmLink(ctx context.Context, base coreiface.Path, link stri
 	return api.ParseCid(nnode.Cid()), nil
 }
 
-func (api *ObjectAPI) AppendData(ctx context.Context, path coreiface.Path, r io.Reader) (coreiface.Path, error) {
+func (api *ObjectAPI) AppendData(ctx context.Context, path coreiface.Path, r io.Reader) (coreiface.ResolvedPath, error) {
 	return api.patchData(ctx, path, r, true)
 }
 
-func (api *ObjectAPI) SetData(ctx context.Context, path coreiface.Path, r io.Reader) (coreiface.Path, error) {
+func (api *ObjectAPI) SetData(ctx context.Context, path coreiface.Path, r io.Reader) (coreiface.ResolvedPath, error) {
 	return api.patchData(ctx, path, r, false)
 }
 
-func (api *ObjectAPI) patchData(ctx context.Context, path coreiface.Path, r io.Reader, appendData bool) (coreiface.Path, error) {
+func (api *ObjectAPI) patchData(ctx context.Context, path coreiface.Path, r io.Reader, appendData bool) (coreiface.ResolvedPath, error) {
 	nd, err := api.core().ResolveNode(ctx, path)
 	if err != nil {
 		return nil, err
diff --git a/core/coreapi/path.go b/core/coreapi/path.go
diff --git a/core/coreapi/pin.go b/core/coreapi/pin.go
diff --git a/core/coreapi/unixfs.go b/core/coreapi/unixfs.go
diff --git a/core/coreapi/unixfs_test.go b/core/coreapi/unixfs_test.go
diff --git a/path/path.go b/path/path.go

Original file line number	Diff line number	Diff line change
`@@ -3,17 +3,15 @@ package coreapi`
`3`	`3`	`import (`
`4`	`4`	`core "github.com/ipfs/go-ipfs/core"`
`5`	`5`	`coreiface "github.com/ipfs/go-ipfs/core/coreapi/interface"`
`6`		`- caopts "github.com/ipfs/go-ipfs/core/coreapi/interface/options"`
`7`	`6`	`)`
`8`	`7`
`9`	`8`	`type CoreAPI struct {`
`10`	`9`	`node *core.IpfsNode`
`11`		`- *caopts.ApiOptions`
`12`	`10`	`}`
`13`	`11`
`14`	`12`	`// NewCoreAPI creates new instance of IPFS CoreAPI backed by go-ipfs Node.`
`15`	`13`	`func NewCoreAPI(n *core.IpfsNode) coreiface.CoreAPI {`
`16`		`- api := &CoreAPI{n, nil}`
	`14`	`+ api := &CoreAPI{n}`
`17`	`15`	`return api`
`18`	`16`	`}`
`19`	`17`
Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ func TestPath(t *testing.T) {`
`70`	`70`	`t.Error(err)`
`71`	`71`	`}`
`72`	`72`
`73`		`- p, err := api.ParsePath(ctx, path.Join(res.Cid().String(), "lnk"))`
	`73`	`+ p, err := api.ParsePath(path.Join(res.Cid().String(), "lnk"))`
`74`	`74`	`if err != nil {`
`75`	`75`	`t.Error(err)`
`76`	`76`	`}`