gitea/modules/git/commit_message.go

// Copyright 2026 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT

package git

import (
	"net/mail"
	"regexp"
	"strings"
	"sync"

	"gitea.dev/modules/charset"
	"gitea.dev/modules/util"
)

// CoAuthoredByTrailer is the canonical token for the `Co-authored-by:` git trailer.
const CoAuthoredByTrailer = "Co-authored-by"

const (
	commitIdentityRoleAuthor    = 1
	commitIdentityRoleCommitter = 2
	commitIdentityRoleCoAuthor  = 3
)

type CommitIdentity struct {
	Name  string
	Email string
	role  int
}

// CommitMessageTrailerValues keys are all in lower-case
type CommitMessageTrailerValues map[string][]string

type CommitMessage struct {
	MessageRaw   string
	messageUTF8  *string
	messageTitle *string
	messageBody  *string

	trailerValues CommitMessageTrailerValues

	allAuthors []*CommitIdentity
}

func (c *CommitMessage) MessageUTF8() string {
	if c.messageUTF8 == nil {
		bs := charset.ToUTF8(util.UnsafeStringToBytes(c.MessageRaw), charset.ConvertOpts{ErrorReplacement: []byte{'?'}})
		c.messageUTF8 = new(util.UnsafeBytesToString(bs))
	}
	return *c.messageUTF8
}

func (c *CommitMessage) MessageTitle() string {
	if c.messageTitle == nil {
		s, _, _ := strings.Cut(strings.TrimSpace(c.MessageUTF8()), "\n")
		c.messageTitle = new(strings.TrimSpace(s))
	}
	return *c.messageTitle
}

func (c *CommitMessage) MessageBody() string {
	if c.messageBody == nil {
		_, s, _ := strings.Cut(strings.TrimSpace(c.MessageUTF8()), "\n")
		c.messageBody = new(strings.TrimSpace(s))
	}
	return *c.messageBody
}

func (c *CommitMessage) MessageTrailer() CommitMessageTrailerValues {
	if c.trailerValues == nil {
		_, _, trailer := CommitMessageSplitTrailer(c.MessageUTF8())
		c.trailerValues = CommitMessageParseTrailer(trailer)
	}
	return c.trailerValues
}

var commitMessageTrailerSplit = sync.OnceValue(func() *regexp.Regexp {
	// ref: https://git-scm.com/docs/git-interpret-trailers
	// TODO: the regexp is not able to perfectly parse the all kinds of trailers
	// It was just copied from legacy code, it is not exactly the same as how Git parses the trailer and not quite right in some cases.
	// For the key characters: it follows RFC 822 field name syntax (or RFC 2822/RFC 5322): printable ASCII characters between 33 and 126 except the colon (:),
	// but maybe we don't want to make it that complicated, so here we only support some common "symbol-like" characters.
	return regexp.MustCompile(`(?s)^(?P<content>.*?)(?P<sep>^|^\n|^-{3,}\n+|\n+-{3,}\n+|\n{2,})(?P<trailer>(?:[A-Za-z0-9][-\w]*:[^\n]*(\n\s+[^\n]*)*\n?)*\n*)$`)
})

// CommitMessageSplitTrailer tries to split the message by the trailer separator
// content + sep + trailer will reconstruct the original message
func CommitMessageSplitTrailer(s string) (content, sep, trailer string) {
	s = util.NormalizeStringEOL(s)
	re := commitMessageTrailerSplit()
	v := re.FindStringSubmatch(s)
	if v == nil {
		return s, "", ""
	}
	return v[re.SubexpIndex("content")], v[re.SubexpIndex("sep")], v[re.SubexpIndex("trailer")]
}

// CommitMessageMerge merges two commit messages with their trailers
func CommitMessageMerge(m1, m2 string) string {
	c1, s1, t1 := CommitMessageSplitTrailer(m1)
	c2, s2, t2 := CommitMessageSplitTrailer(m2)
	c1, t1 = strings.TrimSpace(c1), strings.TrimSpace(t1)
	c2, t2 = strings.TrimSpace(c2), strings.TrimSpace(t2)
	out := strings.Builder{}
	if c1 != "" && c2 != "" {
		out.WriteString(c1)
		out.WriteString("\n\n")
		out.WriteString(c2)
	} else if c1 != "" {
		out.WriteString(c1)
	} else if c2 != "" {
		out.WriteString(c2)
	}
	if t1 != "" || t2 != "" {
		sep := util.Iif(t1 == "", s2, s1)
		sep = util.IfZero(sep, "\n\n")
		if c1 != "" || c2 != "" {
			out.WriteString(sep)
		}
		if t1 != "" {
			out.WriteString(t1)
		}
		if t1 != "" && t2 != "" {
			out.WriteString("\n")
		}
		if t2 != "" {
			out.WriteString(t2)
		}
	}
	return out.String()
}

func CommitMessageParseTrailer(s string) CommitMessageTrailerValues {
	ret := CommitMessageTrailerValues{}
	for line := range strings.SplitSeq(util.NormalizeStringEOL(s), "\n") {
		k, v, ok := strings.Cut(line, ":")
		if !ok {
			continue
		}
		k, v = strings.TrimSpace(k), strings.TrimSpace(v)
		kLower := strings.ToLower(k)
		ret[kLower] = append(ret[kLower], v)
	}
	return ret
}

// AllAuthorIdentities returns all the author and co-authors in the commit. Committer is not included:
// * Author & Co-author: they changed the code (attribution)
// * Committer: they submitted the commit but didn't change the code (e.g.: maintainer signed a commit)
func (c *Commit) AllAuthorIdentities() []*CommitIdentity {
	if c.allAuthors != nil {
		return c.allAuthors
	}
	trailerCoAuthors := c.MessageTrailer()["co-authored-by"]
	c.allAuthors = make([]*CommitIdentity, 0, 1+len(trailerCoAuthors))
	exclude := map[string]int{}
	addAuthor := func(name, email string, role int) {
		if name == "" && email == "" {
			return
		}
		key := strings.ToLower(email)
		if key == "" {
			key = strings.ToLower(name)
		}
		if existingRole := exclude[key]; key != "" && existingRole != 0 {
			return
		}
		c.allAuthors = append(c.allAuthors, &CommitIdentity{Name: name, Email: email, role: role})
		exclude[key] = role
	}

	addAuthor(c.Author.Name, c.Author.Email, commitIdentityRoleAuthor)
	for _, coAuthorValue := range trailerCoAuthors {
		addr, err := mail.ParseAddress(coAuthorValue)
		coAuthorName, coAuthorEmail := coAuthorValue, ""
		if err == nil {
			coAuthorName, coAuthorEmail = addr.Name, addr.Address
		}
		addAuthor(coAuthorName, coAuthorEmail, commitIdentityRoleCoAuthor)
	}
	return c.allAuthors
}

func (c *Commit) CoAuthorIdentities() (coAuthors []*CommitIdentity) {
	all := c.AllAuthorIdentities()
	if len(all) == 0 {
		return nil
	}
	if all[0].role == commitIdentityRoleAuthor {
		return all[1:]
	}
	return all
}