// +build linux darwin freebsd netbsd openbsd // +build !nofuse package readonly import ( "context" "fmt" "io" "os" "syscall" core "github.com/ipfs/go-ipfs/core" mdag "github.com/ipfs/go-ipfs/merkledag" path "github.com/ipfs/go-ipfs/path" uio "github.com/ipfs/go-ipfs/unixfs/io" ftpb "github.com/ipfs/go-ipfs/unixfs/pb" logging "gx/ipfs/QmSpJByNKFX1sCsHBEp3R73FL4NF6FnQTEGyNAXHm2GS52/go-log" lgbl "gx/ipfs/QmT4PgCNdv73hnFAqzHqwW44q7M9PWpykSswHDxndquZbc/go-libp2p-loggables" format "gx/ipfs/QmYNyRZJBUYPNrLszFmrBrPJbsBh2vMsefz5gnDpB5M1P6/go-ipld-format" proto "gx/ipfs/QmZ4Qi3GaRbjcx28Sme5eMH7RQjGkt8wHxt2a65oLaeFEV/gogo-protobuf/proto" fuse "gx/ipfs/QmaFNtBAXX4nVMQWbUqNysXyhevUj1k4B1y5uS45LC7Vw9/fuse" fs "gx/ipfs/QmaFNtBAXX4nVMQWbUqNysXyhevUj1k4B1y5uS45LC7Vw9/fuse/fs" ) var log = logging.Logger("fuse/ipfs") // FileSystem is the readonly IPFS Fuse Filesystem. type FileSystem struct { Ipfs *core.IpfsNode } // NewFileSystem constructs new fs using given core.IpfsNode instance. func NewFileSystem(ipfs *core.IpfsNode) *FileSystem { return &FileSystem{Ipfs: ipfs} } // Root constructs the Root of the filesystem, a Root object. func (f FileSystem) Root() (fs.Node, error) { return &Root{Ipfs: f.Ipfs}, nil } // Root is the root object of the filesystem tree. type Root struct { Ipfs *core.IpfsNode } // Attr returns file attributes. func (*Root) Attr(ctx context.Context, a *fuse.Attr) error { a.Mode = os.ModeDir | 0111 // -rw+x return nil } // Lookup performs a lookup under this node. func (s *Root) Lookup(ctx context.Context, name string) (fs.Node, error) { log.Debugf("Root Lookup: '%s'", name) switch name { case "mach_kernel", ".hidden", "._.": // Just quiet some log noise on OS X. return nil, fuse.ENOENT } p, err := path.ParsePath(name) if err != nil { log.Debugf("fuse failed to parse path: %q: %s", name, err) return nil, fuse.ENOENT } nd, err := s.Ipfs.Resolver.ResolvePath(ctx, p) if err != nil { // todo: make this error more versatile. return nil, fuse.ENOENT } switch nd := nd.(type) { case *mdag.ProtoNode: return &Node{Ipfs: s.Ipfs, Nd: nd}, nil case *mdag.RawNode: return &Node{Ipfs: s.Ipfs, Nd: nd}, nil default: log.Error("fuse node was not a protobuf node") return nil, fuse.ENOTSUP } } // ReadDirAll reads a particular directory. Disallowed for root. func (*Root) ReadDirAll(ctx context.Context) ([]fuse.Dirent, error) { log.Debug("read Root") return nil, fuse.EPERM } // Node is the core object representing a filesystem tree node. type Node struct { Ipfs *core.IpfsNode Nd format.Node cached *ftpb.Data } func (s *Node) loadData() error { if pbnd, ok := s.Nd.(*mdag.ProtoNode); ok { s.cached = new(ftpb.Data) return proto.Unmarshal(pbnd.Data(), s.cached) } return nil } // Attr returns the attributes of a given node. func (s *Node) Attr(ctx context.Context, a *fuse.Attr) error { log.Debug("Node attr") if rawnd, ok := s.Nd.(*mdag.RawNode); ok { a.Mode = 0444 a.Size = uint64(len(rawnd.RawData())) a.Blocks = 1 a.Uid = uint32(os.Getuid()) // TODO: should probably cache these calls. No sense making multiple syscalls for each attr call here a.Gid = uint32(os.Getgid()) return nil } if s.cached == nil { if err := s.loadData(); err != nil { return fmt.Errorf("readonly: loadData() failed: %s", err) } } switch s.cached.GetType() { case ftpb.Data_Directory, ftpb.Data_HAMTShard: a.Mode = os.ModeDir | 0555 a.Uid = uint32(os.Getuid()) a.Gid = uint32(os.Getgid()) case ftpb.Data_File: size := s.cached.GetFilesize() a.Mode = 0444 a.Size = uint64(size) a.Blocks = uint64(len(s.Nd.Links())) a.Uid = uint32(os.Getuid()) a.Gid = uint32(os.Getgid()) case ftpb.Data_Raw: a.Mode = 0444 a.Size = uint64(len(s.cached.GetData())) a.Blocks = uint64(len(s.Nd.Links())) a.Uid = uint32(os.Getuid()) a.Gid = uint32(os.Getgid()) case ftpb.Data_Symlink: a.Mode = 0777 | os.ModeSymlink a.Size = uint64(len(s.cached.GetData())) a.Uid = uint32(os.Getuid()) a.Gid = uint32(os.Getgid()) default: return fmt.Errorf("Invalid data type - %s", s.cached.GetType()) } return nil } // Lookup performs a lookup under this node. func (s *Node) Lookup(ctx context.Context, name string) (fs.Node, error) { log.Debugf("Lookup '%s'", name) link, _, err := uio.ResolveUnixfsOnce(ctx, s.Ipfs.DAG, s.Nd, []string{name}) switch err { case os.ErrNotExist, mdag.ErrLinkNotFound: // todo: make this error more versatile. return nil, fuse.ENOENT default: log.Errorf("fuse lookup %q: %s", name, err) return nil, fuse.EIO case nil: // noop } nd, err := s.Ipfs.DAG.Get(ctx, link.Cid) switch err { case mdag.ErrNotFound: default: log.Errorf("fuse lookup %q: %s", name, err) return nil, err case nil: // noop } return &Node{Ipfs: s.Ipfs, Nd: nd}, nil } // ReadDirAll reads the link structure as directory entries func (s *Node) ReadDirAll(ctx context.Context) ([]fuse.Dirent, error) { log.Debug("Node ReadDir") dir, err := uio.NewDirectoryFromNode(s.Ipfs.DAG, s.Nd) if err != nil { return nil, err } var entries []fuse.Dirent err = dir.ForEachLink(ctx, func(lnk *format.Link) error { n := lnk.Name if len(n) == 0 { n = lnk.Cid.String() } // TODO: calling everything a DT_File here might cause issues. But it // will be expensive to query each child. However most shells call an // additional 'stat' on each item in a directory listing, its probably // okay. entries = append(entries, fuse.Dirent{Name: n, Type: fuse.DT_File}) return nil }) if err != nil { return nil, err } if len(entries) > 0 { return entries, nil } return nil, fuse.ENOENT } func (s *Node) Getxattr(ctx context.Context, req *fuse.GetxattrRequest, resp *fuse.GetxattrResponse) error { // TODO: is nil the right response for 'bug off, we aint got none' ? resp.Xattr = nil return nil } func (s *Node) Readlink(ctx context.Context, req *fuse.ReadlinkRequest) (string, error) { if s.cached == nil || s.cached.GetType() != ftpb.Data_Symlink { return "", fuse.Errno(syscall.EINVAL) } return string(s.cached.GetData()), nil } func (s *Node) Read(ctx context.Context, req *fuse.ReadRequest, resp *fuse.ReadResponse) error { c := s.Nd.Cid() // setup our logging event lm := make(lgbl.DeferredMap) lm["fs"] = "ipfs" lm["key"] = func() interface{} { return c.String() } lm["req_offset"] = req.Offset lm["req_size"] = req.Size defer log.EventBegin(ctx, "fuseRead", lm).Done() r, err := uio.NewDagReader(ctx, s.Nd, s.Ipfs.DAG) if err != nil { return err } o, err := r.Seek(req.Offset, io.SeekStart) lm["res_offset"] = o if err != nil { return err } buf := resp.Data[:min(req.Size, int(int64(r.Size())-req.Offset))] n, err := io.ReadFull(r, buf) if err != nil && err != io.EOF { return err } resp.Data = resp.Data[:n] lm["res_size"] = n return nil // may be non-nil / not succeeded } // to check that out Node implements all the interfaces we want type roRoot interface { fs.Node fs.HandleReadDirAller fs.NodeStringLookuper } var _ roRoot = (*Root)(nil) type roNode interface { fs.HandleReadDirAller fs.HandleReader fs.Node fs.NodeStringLookuper fs.NodeReadlinker fs.NodeGetxattrer } var _ roNode = (*Node)(nil) func min(a, b int) int { if a < b { return a } return b }