manifest.go

/*
   Copyright The containerd 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 continuity

import (
	"fmt"
	"io"
	"os"
	"sort"

	pb "github.com/containerd/continuity/proto"
	"google.golang.org/protobuf/encoding/prototext"
	"google.golang.org/protobuf/proto"
)

// Manifest provides the contents of a manifest. Users of this struct should
// not typically modify any fields directly.
type Manifest struct {
	// Resources specifies all the resources for a manifest in order by path.
	Resources []Resource
}

func Unmarshal(p []byte) (*Manifest, error) {
	var bm pb.Manifest

	if err := proto.Unmarshal(p, &bm); err != nil {
		return nil, err
	}

	var m Manifest
	for _, b := range bm.Resource {
		r, err := fromProto(b)
		if err != nil {
			return nil, err
		}

		m.Resources = append(m.Resources, r)
	}

	return &m, nil
}

func Marshal(m *Manifest) ([]byte, error) {
	var bm pb.Manifest
	for _, rsrc := range m.Resources {
		bm.Resource = append(bm.Resource, toProto(rsrc))
	}

	return proto.Marshal(&bm)
}

func MarshalText(w io.Writer, m *Manifest) error {
	var bm pb.Manifest
	for _, rsrc := range m.Resources {
		bm.Resource = append(bm.Resource, toProto(rsrc))
	}

	b, err := prototext.Marshal(&bm)
	if err != nil {
		return err
	}
	_, err = w.Write(b)
	return err
}

// BuildManifest creates the manifest for the given context
func BuildManifest(fsContext Context) (*Manifest, error) {
	resourcesByPath := map[string]Resource{}
	hardLinks := newHardlinkManager()

	if err := fsContext.Walk(func(p string, fi os.FileInfo, err error) error {
		if err != nil {
			return fmt.Errorf("error walking %s: %w", p, err)
		}

		if p == string(os.PathSeparator) {
			// skip root
			return nil
		}

		rsrc, err := fsContext.Resource(p, fi)
		if err != nil {
			if err == ErrNotFound {
				return nil
			}
			return fmt.Errorf("failed to get resource %q: %w", p, err)
		}

		// add to the hardlink manager
		if err := hardLinks.Add(fi, rsrc); err == nil {
			// Resource has been accepted by hardlink manager so we don't add
			// it to the resourcesByPath until we merge at the end.
			return nil
		} else if err != errNotAHardLink {
			// handle any other case where we have a proper error.
			return fmt.Errorf("adding hardlink %s: %w", p, err)
		}

		resourcesByPath[p] = rsrc

		return nil
	}); err != nil {
		return nil, err
	}

	// merge and post-process the hardlinks.
	hardLinked, err := hardLinks.Merge()
	if err != nil {
		return nil, err
	}

	for _, rsrc := range hardLinked {
		resourcesByPath[rsrc.Path()] = rsrc
	}

	var resources []Resource
	for _, rsrc := range resourcesByPath {
		resources = append(resources, rsrc)
	}

	sort.Stable(ByPath(resources))

	return &Manifest{
		Resources: resources,
	}, nil
}

// VerifyManifest verifies all the resources in a manifest
// against files from the given context.
func VerifyManifest(fsContext Context, manifest *Manifest) error {
	for _, rsrc := range manifest.Resources {
		if err := fsContext.Verify(rsrc); err != nil {
			return err
		}
	}

	return nil
}

// ApplyManifest applies on the resources in a manifest to
// the given context.
func ApplyManifest(fsContext Context, manifest *Manifest) error {
	for _, rsrc := range manifest.Resources {
		if err := fsContext.Apply(rsrc); err != nil {
			return err
		}
	}

	return nil
}