gitea/services/gitdiff/submodule.go

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

package gitdiff

import (
	"context"
	"html/template"

	"code.gitea.io/gitea/modules/base"
	"code.gitea.io/gitea/modules/git"
	"code.gitea.io/gitea/modules/htmlutil"
	"code.gitea.io/gitea/modules/log"
)

type SubmoduleDiffInfo struct {
	SubmoduleName string
	SubmoduleFile *git.CommitSubmoduleFile // it might be nil if the submodule is not found or unable to parse
	NewRefID      string
	PreviousRefID string
}

func (si *SubmoduleDiffInfo) PopulateURL(repoLink string, diffFile *DiffFile, leftCommit, rightCommit *git.Commit) {
	si.SubmoduleName = diffFile.Name
	submoduleCommit := rightCommit // If the submodule is added or updated, check at the right commit
	if diffFile.IsDeleted {
		submoduleCommit = leftCommit // If the submodule is deleted, check at the left commit
	}
	if submoduleCommit == nil {
		return
	}

	submoduleFullPath := diffFile.GetDiffFileName()
	submodule, err := submoduleCommit.GetSubModule(submoduleFullPath)
	if err != nil {
		log.Error("Unable to PopulateURL for submodule %q: GetSubModule: %v", submoduleFullPath, err)
		return // ignore the error, do not cause 500 errors for end users
	}
	if submodule != nil {
		si.SubmoduleFile = git.NewCommitSubmoduleFile(repoLink, submoduleFullPath, submodule.URL, submoduleCommit.ID.String())
	}
}

func (si *SubmoduleDiffInfo) CommitRefIDLinkHTML(ctx context.Context, commitID string) template.HTML {
	webLink := si.SubmoduleFile.SubmoduleWebLinkTree(ctx, commitID)
	if webLink == nil {
		return htmlutil.HTMLFormat("%s", base.ShortSha(commitID))
	}
	return htmlutil.HTMLFormat(`<a href="%s">%s</a>`, webLink.CommitWebLink, base.ShortSha(commitID))
}

func (si *SubmoduleDiffInfo) CompareRefIDLinkHTML(ctx context.Context) template.HTML {
	webLink := si.SubmoduleFile.SubmoduleWebLinkCompare(ctx, si.PreviousRefID, si.NewRefID)
	if webLink == nil {
		return htmlutil.HTMLFormat("%s...%s", base.ShortSha(si.PreviousRefID), base.ShortSha(si.NewRefID))
	}
	return htmlutil.HTMLFormat(`<a href="%s">%s...%s</a>`, webLink.CommitWebLink, base.ShortSha(si.PreviousRefID), base.ShortSha(si.NewRefID))
}

func (si *SubmoduleDiffInfo) SubmoduleRepoLinkHTML(ctx context.Context) template.HTML {
	webLink := si.SubmoduleFile.SubmoduleWebLinkTree(ctx)
	if webLink == nil {
		return htmlutil.HTMLFormat("%s", si.SubmoduleName)
	}
	return htmlutil.HTMLFormat(`<a href="%s">%s</a>`, webLink.RepoWebLink, si.SubmoduleName)
}