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

first pass at a tar importer #1680

Merged
merged 3 commits into from
Sep 11, 2015
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
1 change: 1 addition & 0 deletions core/commands/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ var rootSubcommands = map[string]*cmds.Command{
"resolve": ResolveCmd,
"stats": StatsCmd,
"swarm": SwarmCmd,
"tar": TarCmd,
"tour": tourCmd,
"file": unixfs.UnixFSCmd,
"update": UpdateCmd,
Expand Down
113 changes: 113 additions & 0 deletions core/commands/tar.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
package commands

import (
"io"
"strings"

cmds "github.com/ipfs/go-ipfs/commands"
core "github.com/ipfs/go-ipfs/core"
path "github.com/ipfs/go-ipfs/path"
tar "github.com/ipfs/go-ipfs/tar"
)

var TarCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "utility functions for tar files in ipfs",
},

Subcommands: map[string]*cmds.Command{
"add": tarAddCmd,
"cat": tarCatCmd,
},
}

var tarAddCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "import a tar file into ipfs",
ShortDescription: `
'ipfs tar add' will parse a tar file and create a merkledag structure to represent it.
`,
},

Arguments: []cmds.Argument{
cmds.FileArg("file", true, false, "tar file to add").EnableStdin(),
},
Run: func(req cmds.Request, res cmds.Response) {
nd, err := req.InvocContext().GetNode()
if err != nil {
res.SetError(err, cmds.ErrNormal)
return
}

fi, err := req.Files().NextFile()
if err != nil {
res.SetError(err, cmds.ErrNormal)
return
}

node, err := tar.ImportTar(fi, nd.DAG)
if err != nil {
res.SetError(err, cmds.ErrNormal)
return
}

k, err := node.Key()
if err != nil {
res.SetError(err, cmds.ErrNormal)
return
}

fi.FileName()
res.SetOutput(&AddedObject{
Name: fi.FileName(),
Hash: k.B58String(),
})
},
Type: AddedObject{},
Marshalers: cmds.MarshalerMap{
cmds.Text: func(res cmds.Response) (io.Reader, error) {
o := res.Output().(*AddedObject)
return strings.NewReader(o.Hash), nil
},
},
}

var tarCatCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "export a tar file from ipfs",
ShortDescription: `
'ipfs tar cat' will export a tar file from a previously imported one in ipfs
`,
},

Arguments: []cmds.Argument{
cmds.StringArg("path", true, false, "ipfs path of archive to export").EnableStdin(),
},
Run: func(req cmds.Request, res cmds.Response) {
nd, err := req.InvocContext().GetNode()
if err != nil {
res.SetError(err, cmds.ErrNormal)
return
}

p, err := path.ParsePath(req.Arguments()[0])
if err != nil {
res.SetError(err, cmds.ErrNormal)
return
}

root, err := core.Resolve(req.Context(), nd, p)
if err != nil {
res.SetError(err, cmds.ErrNormal)
return
}

r, err := tar.ExportTar(req.Context(), root, nd.DAG)
if err != nil {
res.SetError(err, cmds.ErrNormal)
return
}

res.SetOutput(r)
},
}
185 changes: 185 additions & 0 deletions tar/format.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,185 @@
package tarfmt

import (
"archive/tar"
"bytes"
"errors"
"io"
"io/ioutil"

importer "github.com/ipfs/go-ipfs/importer"
chunk "github.com/ipfs/go-ipfs/importer/chunk"
dag "github.com/ipfs/go-ipfs/merkledag"
uio "github.com/ipfs/go-ipfs/unixfs/io"

context "github.com/ipfs/go-ipfs/Godeps/_workspace/src/golang.org/x/net/context"
)

var blockSize = 512
var zeroBlock = make([]byte, blockSize)

func marshalHeader(h *tar.Header) ([]byte, error) {
buf := new(bytes.Buffer)
w := tar.NewWriter(buf)
err := w.WriteHeader(h)
if err != nil {
return nil, err
}
return buf.Bytes(), nil
}

func ImportTar(r io.Reader, ds dag.DAGService) (*dag.Node, error) {
rall, err := ioutil.ReadAll(r)
if err != nil {
return nil, err
}

r = bytes.NewReader(rall)

tr := tar.NewReader(r)

root := new(dag.Node)
root.Data = []byte("ipfs/tar")

for {
h, err := tr.Next()
if err != nil {
if err == io.EOF {
break
}
return nil, err
}

header := new(dag.Node)

headerBytes, err := marshalHeader(h)
if err != nil {
return nil, err
}

header.Data = headerBytes

if h.Size > 0 {
spl := chunk.NewRabin(tr, uint64(chunk.DefaultBlockSize))
nd, err := importer.BuildDagFromReader(ds, spl, nil)
if err != nil {
return nil, err
}

err = header.AddNodeLinkClean("data", nd)
if err != nil {
return nil, err
}
}

_, err = ds.Add(header)
if err != nil {
return nil, err
}

err = root.AddNodeLinkClean(h.Name, header)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so the root is going to get massive (thousands of links). we dont have sharding yet, so maybe this should work like the path bubble-up

if err != nil {
return nil, err
}
}

_, err = ds.Add(root)
if err != nil {
return nil, err
}

return root, nil
}

type tarReader struct {
links []*dag.Link
ds dag.DAGService

hdrBuf *bytes.Reader
fileRead *countReader
pad int

ctx context.Context
}

func (tr *tarReader) Read(b []byte) (int, error) {
if tr.hdrBuf != nil {
n, err := tr.hdrBuf.Read(b)
if err == io.EOF {
tr.hdrBuf = nil
return n, nil
}
return n, err
}
if tr.fileRead != nil {
n, err := tr.fileRead.Read(b)
if err == io.EOF {
nr := tr.fileRead.n
tr.pad = (blockSize - (nr % blockSize)) % blockSize
tr.fileRead.Close()
tr.fileRead = nil
return n, nil
}
return n, err
}
if tr.pad > 0 {
n := copy(b, zeroBlock[:tr.pad])
tr.pad -= n
return n, nil
}

if len(tr.links) == 0 {
return 0, io.EOF
}

next := tr.links[0]
tr.links = tr.links[1:]

headerNd, err := next.GetNode(tr.ctx, tr.ds)
if err != nil {
return 0, err
}

tr.hdrBuf = bytes.NewReader(headerNd.Data)
if len(headerNd.Links) > 0 {
data, err := headerNd.Links[0].GetNode(tr.ctx, tr.ds)
if err != nil {
return 0, err
}

dr, err := uio.NewDagReader(tr.ctx, data, tr.ds)
if err != nil {
return 0, err
}

tr.fileRead = &countReader{r: dr}
}

return tr.Read(b)
}

func ExportTar(ctx context.Context, root *dag.Node, ds dag.DAGService) (io.Reader, error) {
if string(root.Data) != "ipfs/tar" {
return nil, errors.New("not an ipfs tarchive")
}
return &tarReader{
links: root.Links,
ds: ds,
ctx: ctx,
}, nil
}

type countReader struct {
r io.ReadCloser
n int
}

func (r *countReader) Read(b []byte) (int, error) {
n, err := r.r.Read(b)
r.n += n
return n, err
}

func (r *countReader) Close() error {
return r.r.Close()
}