github.com/keybase/client/go@v0.0.0-20241007131713-f10651d043c8/kbfs/libgit/browser.go

// Copyright 2018 Keybase Inc. All rights reserved.
// Use of this source code is governed by a BSD
// license that can be found in the LICENSE file.

package libgit

import (
	"context"
	"io"
	"os"
	"path"
	"strings"
	"time"

	"github.com/keybase/client/go/kbfs/libfs"
	"github.com/keybase/client/go/kbfs/libkbfs"
	"github.com/pkg/errors"
	billy "gopkg.in/src-d/go-billy.v4"
	gogit "gopkg.in/src-d/go-git.v4"
	"gopkg.in/src-d/go-git.v4/plumbing"
	"gopkg.in/src-d/go-git.v4/plumbing/object"
	"gopkg.in/src-d/go-git.v4/storage"
)

const (
	// LFSSubdir is the prefix for the LFS directory under .kbfs_git
	LFSSubdir       = "kbfs_lfs"
	lfsEntryMinSize = 120
	lfsEntryMaxSize = 150
)

func translateGitError(err *error) {
	if *err == nil {
		return
	}
	switch errors.Cause(*err) {
	case object.ErrEntryNotFound:
		*err = os.ErrNotExist
	default:
		return
	}
}

// Browser presents the contents of a git repo as a read-only file
// system, using only the dotgit directory of the repo.
type Browser struct {
	repo       *gogit.Repository
	tree       *object.Tree
	root       string
	mtime      time.Time
	commitHash plumbing.Hash
	lfsFS      billy.Filesystem

	sharedCache sharedInBrowserCache
}

var _ billy.Filesystem = (*Browser)(nil)

// NewBrowser makes a new Browser instance, browsing the given branch
// of the given repo.  If `gitBranchName` is empty,
// "refs/heads/master" is used.  If `gitBranchName` is not empty, but
// it doesn't begin with "refs/", then "refs/heads/" is prepended to
// it.
func NewBrowser(
	repoFS *libfs.FS, clock libkbfs.Clock,
	gitBranchName plumbing.ReferenceName,
	sharedCache sharedInBrowserCache) (*Browser, error) {
	var storage storage.Storer
	storage, err := NewGitConfigWithoutRemotesStorer(repoFS)
	if err != nil {
		return nil, err
	}

	const masterBranch = "refs/heads/master"
	if gitBranchName == "" {
		gitBranchName = masterBranch
	} else if !strings.HasPrefix(string(gitBranchName), "refs/") {
		gitBranchName = "refs/heads/" + gitBranchName
	}

	repo, err := gogit.Open(storage, nil)
	if errors.Cause(err) == gogit.ErrWorktreeNotProvided {
		// This is not a bare repo (it might be for a test).  So we
		// need to pass in a working tree, but since `Browser` is
		// read-only and doesn't even use the worktree, it doesn't
		// matter what we pass in.
		repo, err = gogit.Open(storage, repoFS)
	}

	if err == gogit.ErrRepositoryNotExists && gitBranchName == masterBranch {
		// This repo is not initialized yet, so pretend it's empty.
		return &Browser{
			root:        string(gitBranchName),
			sharedCache: sharedCache,
		}, nil
	} else if err != nil {
		return nil, err
	}

	ref, err := repo.Reference(gitBranchName, true)
	if err == plumbing.ErrReferenceNotFound && gitBranchName == masterBranch {
		// This branch has no commits, so pretend it's empty.
		return &Browser{
			root:        string(gitBranchName),
			sharedCache: sharedCache,
		}, nil
	} else if err != nil {
		return nil, err
	}

	if ref.Type() != plumbing.HashReference {
		return nil, errors.Errorf("can't browse reference type %s", ref.Type())
	}

	c, err := repo.CommitObject(ref.Hash())
	if err != nil {
		return nil, err
	}
	tree, err := c.Tree()
	if err != nil {
		return nil, err
	}

	lfsFS, err := repoFS.Chroot(LFSSubdir)
	if os.IsNotExist(err) {
		lfsFS = nil
	} else if err != nil {
		return nil, err
	}

	return &Browser{
		repo:        repo,
		tree:        tree,
		root:        string(gitBranchName),
		mtime:       c.Author.When,
		commitHash:  c.Hash,
		lfsFS:       lfsFS,
		sharedCache: sharedCache,
	}, nil
}

func (b *Browser) getCommitFile(
	ctx context.Context, hash plumbing.Hash) (*diffFile, error) {
	if b.repo == nil {
		return nil, errors.New("Empty repo")
	}

	commit, err := b.repo.CommitObject(hash)
	if err != nil {
		return nil, err
	}
	return newCommitFile(ctx, commit)
}

///// Read-only functions:

const (
	maxSymlinkLevels = 40 // same as Linux
)

func (b *Browser) readLink(filename string) (string, error) {
	f, err := b.tree.File(filename)
	if err != nil {
		return "", err
	}
	r, err := f.Reader()
	if err != nil {
		return "", err
	}
	defer r.Close()
	data, err := io.ReadAll(r)
	if err != nil {
		return "", err
	}
	return string(data), nil
}

func (b *Browser) followSymlink(filename string) (string, error) {
	// Otherwise, resolve the symlink and return the underlying FileInfo.
	link, err := b.readLink(filename)
	if err != nil {
		return "", err
	}
	if path.IsAbs(link) {
		return "", errors.Errorf("can't follow absolute link: %s", link)
	}

	parts := strings.Split(filename, "/")
	var parentPath string
	if len(parts) > 0 {
		parentPath = path.Join(parts[:len(parts)-1]...)
	}
	newPath := path.Clean(path.Join(parentPath, link))
	if strings.HasPrefix(newPath, "..") {
		return "", errors.Errorf(
			"cannot follow symlink out of chroot: %s", newPath)
	}
	return newPath, nil
}

// Open implements the billy.Filesystem interface for Browser.
func (b *Browser) Open(filename string) (f billy.File, err error) {
	if b.tree == nil {
		return nil, errors.New("Empty repo")
	}

	defer translateGitError(&err)
	for i := 0; i < maxSymlinkLevels; i++ {
		fi, err := b.Lstat(filename)
		if err != nil {
			return nil, err
		}

		// Check if this is a submodule.
		if sfi, ok := fi.(*submoduleFileInfo); ok {
			return sfi.sf, nil
		}

		// Check if this is LFS.
		if lfsFI, ok := fi.(*lfsFileInfo); ok {
			return b.lfsFS.Open(lfsFI.oid)
		}

		// If it's not a symlink, we can return right away.
		if fi.Mode()&os.ModeSymlink == 0 {
			f, err := b.tree.File(filename)
			if err != nil {
				return nil, err
			}
			return newBrowserFile(f)
		}

		filename, err = b.followSymlink(filename)
		if err != nil {
			return nil, err
		}
	}
	return nil, errors.New("cannot resolve deep symlink chain")
}

// OpenFile implements the billy.Filesystem interface for Browser.
func (b *Browser) OpenFile(filename string, flag int, _ os.FileMode) (
	f billy.File, err error) {
	if b.tree == nil {
		return nil, errors.New("Empty repo")
	}

	if flag&os.O_CREATE != 0 {
		return nil, errors.New("browser can't create files")
	}

	return b.Open(filename)
}

func (b *Browser) fileInfoForLFS(
	filename string, oidLine string, fi os.FileInfo) (
	newFi os.FileInfo, err error) {
	fields := strings.Fields(oidLine)
	// An OID line looks like:
	//     oid sha256:588b3683...
	if len(fields) < 2 || fields[0] != "oid" {
		return fi, nil
	}

	s := strings.Split(fields[1], ":")
	if len(s) < 2 {
		return fi, nil
	}

	oid := s[1]
	// Now look that OID up and make sure it exists.
	lfsFI, err := b.lfsFS.Stat(oid)
	if err != nil {
		return nil, err
	}
	return &lfsFileInfo{
		filename, oid, lfsFI.Size(), b.mtime}, nil
}

// Lstat implements the billy.Filesystem interface for Browser.
func (b *Browser) Lstat(filename string) (fi os.FileInfo, err error) {
	if b.tree == nil {
		return nil, errors.New("Empty repo")
	}

	if strings.HasPrefix(filename, AutogitCommitPrefix) {
		commit := strings.TrimPrefix(filename, AutogitCommitPrefix)
		hash := plumbing.NewHash(commit)
		f, err := b.getCommitFile(context.Background(), hash)
		if err != nil {
			return nil, err
		}
		return f.GetInfo(), nil
	}

	cachePath := path.Join(b.root, filename)
	if fi, ok := b.sharedCache.getFileInfo(b.commitHash, cachePath); ok {
		return fi, nil
	}
	defer translateGitError(&err)
	entry, err := b.tree.FindEntry(filename)
	if err != nil {
		return nil, errors.WithStack(err)
	}

	size, err := b.tree.Size(filename)
	switch errors.Cause(err) {
	case nil:
		// Git doesn't keep track of the mtime of individual files
		// anywhere, so just use the timestamp from the commit.
		fi = &browserFileInfo{entry, size, b.mtime}
	case plumbing.ErrObjectNotFound:
		// This is likely a git submodule.
		sf := newSubmoduleFile(entry.Hash, filename, b.mtime)
		fi = sf.GetInfo()
	default:
		return nil, errors.WithStack(err)
	}

	// If this repo has an LFS subdirectory, check and see if the size
	// of this file is within the size bounds for an LFS object.  If
	// so, read the object and see if it points to LFS or not.
	if b.lfsFS != nil && size >= lfsEntryMinSize && size <= lfsEntryMaxSize {
		f, err := b.tree.File(filename)
		if err != nil {
			return nil, err
		}
		lines, err := f.Lines()
		if err != nil {
			return nil, err
		}
		if len(lines) >= 2 {
			fi, err = b.fileInfoForLFS(filename, lines[1], fi)
			if err != nil {
				return nil, err
			}
		}
	}

	b.sharedCache.setFileInfo(b.commitHash, cachePath, fi)
	return fi, nil
}

// Stat implements the billy.Filesystem interface for Browser.
func (b *Browser) Stat(filename string) (fi os.FileInfo, err error) {
	defer translateGitError(&err)
	for i := 0; i < maxSymlinkLevels; i++ {
		fi, err := b.Lstat(filename)
		if err != nil {
			return nil, err
		}
		// If it's not a symlink, we can return right away.
		if fi.Mode()&os.ModeSymlink == 0 {
			return fi, nil
		}

		filename, err = b.followSymlink(filename)
		if err != nil {
			return nil, err
		}
	}
	return nil, errors.New("cannot resolve deep symlink chain")
}

// Join implements the billy.Filesystem interface for Browser.
func (b *Browser) Join(elem ...string) string {
	return path.Clean(path.Join(elem...))
}

// ReadDir implements the billy.Filesystem interface for Browser.
func (b *Browser) ReadDir(p string) (fis []os.FileInfo, err error) {
	if p == "" {
		p = "."
	}

	if b.tree == nil {
		if p == "." {
			// Branch with no commits.
			return nil, nil
		}
		return nil, errors.New("Empty repo")
	}

	cachePath := path.Join(b.root, p)

	if fis, ok := b.sharedCache.getChildrenFileInfos(
		b.commitHash, cachePath); ok {
		return fis, nil
	}

	defer translateGitError(&err)
	var dirTree *object.Tree
	if p == "." {
		dirTree = b.tree
	} else {
		dirTree, err = b.tree.Tree(p)
		if err != nil {
			return nil, err
		}
	}

	childrenPathsToCache := make([]string, 0, len(dirTree.Entries))
	for _, e := range dirTree.Entries {
		fi, err := b.Lstat(path.Join(p, e.Name))
		if err != nil {
			return nil, err
		}
		fis = append(fis, fi)
		childrenPathsToCache = append(childrenPathsToCache, path.Join(cachePath, e.Name))
	}
	b.sharedCache.setChildrenPaths(
		b.commitHash, cachePath, childrenPathsToCache)

	return fis, nil
}

// Readlink implements the billy.Filesystem interface for Browser.
func (b *Browser) Readlink(link string) (target string, err error) {
	defer translateGitError(&err)
	fi, err := b.Lstat(link)
	if err != nil {
		return "", err
	}
	// If it's not a symlink, error right away.
	if fi.Mode()&os.ModeSymlink == 0 {
		return "", errors.New("not a symlink")
	}

	return b.readLink(link)
}

// Chroot implements the billy.Filesystem interface for Browser.
func (b *Browser) Chroot(p string) (newFS billy.Filesystem, err error) {
	if b.tree == nil {
		return nil, errors.New("Empty repo")
	}

	defer translateGitError(&err)
	newTree, err := b.tree.Tree(p)
	if err != nil {
		return nil, err
	}
	return &Browser{
		tree:        newTree,
		root:        b.Join(b.root, p),
		mtime:       b.mtime,
		commitHash:  b.commitHash,
		sharedCache: b.sharedCache,
	}, nil
}

// Root implements the billy.Filesystem interface for Browser.
func (b *Browser) Root() string {
	return b.root
}

///// Modifying functions (not supported):

// Create implements the billy.Filesystem interface for Browser.
func (b *Browser) Create(_ string) (billy.File, error) {
	return nil, errors.New("browser cannot create files")
}

// Rename implements the billy.Filesystem interface for Browser.
func (b *Browser) Rename(_, _ string) (err error) {
	return errors.New("browser cannot rename files")
}

// Remove implements the billy.Filesystem interface for Browser.
func (b *Browser) Remove(_ string) (err error) {
	return errors.New("browser cannot remove files")
}

// TempFile implements the billy.Filesystem interface for Browser.
func (b *Browser) TempFile(_, _ string) (billy.File, error) {
	return nil, errors.New("browser cannot make temp files")
}

// MkdirAll implements the billy.Filesystem interface for Browser.
func (b *Browser) MkdirAll(_ string, _ os.FileMode) (err error) {
	return errors.New("browser cannot mkdir")
}

// Symlink implements the billy.Filesystem interface for Browser.
func (b *Browser) Symlink(_, _ string) (err error) {
	return errors.New("browser cannot make symlinks")
}