forgejo/modules/git/notes.go

// Copyright 2019 The Gitea Authors. All rights reserved.
// Copyright 2025 The Forgejo Authors. All rights reserved.
// SPDX-License-Identifier: MIT

package git

import (
	"context"
	"io"
	"os"

	"forgejo.org/modules/log"
)

// NotesRef is the git ref where Gitea will look for git-notes data.
// The value ("refs/notes/commits") is the default ref used by git-notes.
const NotesRef = "refs/notes/commits"

// Note stores information about a note created using git-notes.
type Note struct {
	Message []byte
	Commit  *Commit
}

// GetNote retrieves the git-notes data for a given commit.
func GetNote(ctx context.Context, repo *Repository, commitID string) (*Note, error) {
	log.Trace("Searching for git note corresponding to the commit %q in the repository %q", commitID, repo.Path)
	notes, err := repo.GetCommit(NotesRef)
	if err != nil {
		if !IsErrNotExist(err) {
			log.Error("Unable to get commit from ref %q. Error: %v", NotesRef, err)
		}
		return nil, err
	}

	path := ""

	tree := &notes.Tree
	log.Trace("Found tree with ID %q while searching for git note corresponding to the commit %q", tree.ID, commitID)

	var entry *TreeEntry
	originalCommitID := commitID
	for len(commitID) > 2 {
		entry, err = tree.GetTreeEntryByPath(commitID)
		if err == nil {
			path += commitID
			break
		}
		if IsErrNotExist(err) {
			tree, err = tree.SubTree(commitID[0:2])
			path += commitID[0:2] + "/"
			commitID = commitID[2:]
		}
		if err != nil {
			// Err may have been updated by the SubTree we need to recheck if it's again an ErrNotExist
			if !IsErrNotExist(err) {
				log.Error("Unable to find git note corresponding to the commit %q. Error: %v", originalCommitID, err)
			}
			return nil, err
		}
	}

	blob := entry.Blob()
	dataRc, err := blob.DataAsync()
	if err != nil {
		log.Error("Unable to read blob with ID %q. Error: %v", blob.ID, err)
		return nil, err
	}
	closed := false
	defer func() {
		if !closed {
			_ = dataRc.Close()
		}
	}()
	d, err := io.ReadAll(dataRc)
	if err != nil {
		log.Error("Unable to read blob with ID %q. Error: %v", blob.ID, err)
		return nil, err
	}
	_ = dataRc.Close()
	closed = true

	lastCommit, err := repo.getCommitByPathWithID(notes.ID, path)
	if err != nil {
		log.Error("Unable to get the commit for the path %q. Error: %v", path, err)
		return nil, err
	}

	return &Note{Message: d, Commit: lastCommit}, nil
}

func SetNote(ctx context.Context, repo *Repository, commitID, notes, doerName, doerEmail string) error {
	_, err := repo.GetCommit(commitID)
	if err != nil {
		return err
	}

	env := append(os.Environ(),
		"GIT_AUTHOR_NAME="+doerName,
		"GIT_AUTHOR_EMAIL="+doerEmail,
		"GIT_COMMITTER_NAME="+doerName,
		"GIT_COMMITTER_EMAIL="+doerEmail,
	)

	cmd := NewCommand(ctx, "notes", "add", "-f", "-m")
	cmd.AddDynamicArguments(notes, commitID)

	_, stderr, err := cmd.RunStdString(&RunOpts{Dir: repo.Path, Env: env})
	if err != nil {
		log.Error("Error while running git notes add: %s", stderr)
		return err
	}

	return nil
}

func RemoveNote(ctx context.Context, repo *Repository, commitID string) error {
	cmd := NewCommand(ctx, "notes", "remove")
	cmd.AddDynamicArguments(commitID)

	_, stderr, err := cmd.RunStdString(&RunOpts{Dir: repo.Path})
	if err != nil {
		log.Error("Error while running git notes remove: %s", stderr)
		return err
	}

	return nil
}