perkeep/pkg/fs/xattr.go

// +build linux darwin

/*
Copyright 2013 The Perkeep Authors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package fs

import (
	"context"
	"encoding/base64"
	"log"
	"strings"
	"sync"

	"perkeep.org/pkg/blob"
	"perkeep.org/pkg/schema"
	"perkeep.org/pkg/search"

	"bazil.org/fuse"
)

// xattrPrefix is the permanode attribute prefix used for record
// extended attributes.
const xattrPrefix = "xattr:"

// xattr provides common support for extended attributes for various
// file and directory implementations (fuse.Node) within the FUSE services.
type xattr struct {
	typeName  string // for logging
	fs        *CamliFileSystem
	permanode blob.Ref

	// mu guards xattrs.  Both mu and the xattrs map are provided by the
	// fuse.Node when the struct is created.
	mu *sync.Mutex

	// This is a pointer to the particular fuse.Node's location of its
	// xattr map so that it can be initialized commonly when the fuse.Node
	// calls xattr.load(*search.DescribedPermanode)
	xattrs *map[string][]byte
}

// load is invoked after the creation of a fuse.Node that may contain extended
// attributes.  This creates the node's xattr map as well as fills it with any
// extended attributes found in the permanode's claims.
func (x *xattr) load(p *search.DescribedPermanode) {
	x.mu.Lock()
	defer x.mu.Unlock()

	*x.xattrs = map[string][]byte{}
	for k, v := range p.Attr {
		if strings.HasPrefix(k, xattrPrefix) {
			name := k[len(xattrPrefix):]
			val, err := base64.StdEncoding.DecodeString(v[0])
			if err != nil {
				log.Printf("Base64 decoding error on attribute %v: %v", name, err)
				continue
			}
			(*x.xattrs)[name] = val
		}
	}
}

func (x *xattr) set(ctx context.Context, req *fuse.SetxattrRequest) error {
	log.Printf("%s.setxattr(%q) -> %q", x.typeName, req.Name, req.Xattr)

	claim := schema.NewSetAttributeClaim(x.permanode, xattrPrefix+req.Name,
		base64.StdEncoding.EncodeToString(req.Xattr))
	_, err := x.fs.client.UploadAndSignBlob(ctx, claim)
	if err != nil {
		log.Printf("Error setting xattr: %v", err)
		return fuse.EIO
	}

	val := make([]byte, len(req.Xattr))
	copy(val, req.Xattr)
	x.mu.Lock()
	(*x.xattrs)[req.Name] = val
	x.mu.Unlock()

	return nil
}

func (x *xattr) remove(ctx context.Context, req *fuse.RemovexattrRequest) error {
	log.Printf("%s.Removexattr(%q)", x.typeName, req.Name)

	claim := schema.NewDelAttributeClaim(x.permanode, xattrPrefix+req.Name, "")
	_, err := x.fs.client.UploadAndSignBlob(ctx, claim)

	if err != nil {
		log.Printf("Error removing xattr: %v", err)
		return fuse.EIO
	}

	x.mu.Lock()
	delete(*x.xattrs, req.Name)
	x.mu.Unlock()

	return nil
}

func (x *xattr) get(req *fuse.GetxattrRequest, res *fuse.GetxattrResponse) error {
	x.mu.Lock()
	defer x.mu.Unlock()

	val, found := (*x.xattrs)[req.Name]

	if !found {
		return fuse.ErrNoXattr
	}

	res.Xattr = val

	return nil
}

func (x *xattr) list(req *fuse.ListxattrRequest, res *fuse.ListxattrResponse) error {
	x.mu.Lock()
	defer x.mu.Unlock()

	for k := range *x.xattrs {
		res.Xattr = append(res.Xattr, k...)
		res.Xattr = append(res.Xattr, '\x00')
	}
	return nil
}