From 42d2b839505ea80214bc4dbdd8d0afb61af7e537 Mon Sep 17 00:00:00 2001 From: Andrew Thornton Date: Sat, 23 Jul 2022 11:10:27 +0100 Subject: [PATCH] Prepend refs/heads/ to issue template refs Fix #20456 At some point during the 1.17 cycle abbreviated refs to issue branches started breaking. This is likely due serious inconsistencies in our management of refs throughout Gitea - which is a bug needing to be addressed in a different PR. (Likely more than one) We should try to use non-abbreviated refs as much as possible. That is where a user has inputted a abbreviated ref we should add refs/heads/ if it is branch etc. I know people keep writing and merging PRs that remove prefixes from stored content but it is just wrong and it keeps causing problems like this. We should only remove the prefix at the time of presentation as the prefix is the only way of knowing umambiguously and permanently if the ref is referring to a branch, tag or commit. We need to make it so that every ref has the appropriate prefix, and probably also need to come up with some definitely unambiguous way of storing SHAs if they're used in a ref field. We must not store potentially ambiguous refs. (Especially tagnames - there is no reason why users cannot create a branch with the same short name as a tag and vice versa and any attempt to prevent this will fail. You can even create a branch and a tag that matches a SHA1 pattern.) To that end in order to fix this bug, when parsing issue templates check the provided Ref, if it does not start with refs/ add the BranchPrefix to it. This allows people to make their templates refer to a tag. Next we need to handle the issue links that are already written. The links here are created with `git.RefURL` Here we see there is a bug introduced in #17551 whereby the provided Ref can be double-escaped so we remove the incorrect external escape. (The escape added in #17551 is in the right place - unfortunately it missed that the calling function was doing the wrong thing.) Then within RefURL we check if the unprefixed ref could actually be a SHA before defaulting that an unprefixed ref is actually a commit - if not it is assumed to be a branch. This will handle most of the problem cases excepting the very unusual cases where someone has deliberately written a branch to look like a SHA1. But please if something is called a `ref` or interpreted as a `ref` make it a full-ref before storing or using it. By all means if something is a `branch` assume the prefix is removed but always add it back in if you are using it as a `ref`. Stop storing abbreviated branch names and tag names as refs. It will keep on causing problems like this. Fix #20456 Signed-off-by: Andrew Thornton --- modules/context/repo.go | 3 +++ modules/git/utils.go | 3 +++ routers/web/repo/issue.go | 4 ++++ services/issue/issue.go | 3 +-- 4 files changed, 11 insertions(+), 2 deletions(-) diff --git a/modules/context/repo.go b/modules/context/repo.go index 183637391862..ddb63150b186 100644 --- a/modules/context/repo.go +++ b/modules/context/repo.go @@ -1086,6 +1086,9 @@ func (ctx *Context) IssueTemplatesFromDefaultBranch() []api.IssueTemplate { } it.Content = content it.FileName = entry.Name() + if !strings.HasPrefix(it.Ref, "refs/") { // Assume that the ref intended is always a branch - for tags users should use refs/tags/ + it.Ref = "refs/heads/" + it.Ref + } if it.Valid() { issueTemplates = append(issueTemplates, it) } diff --git a/modules/git/utils.go b/modules/git/utils.go index d6bf9f4413cd..1a7041433dab 100644 --- a/modules/git/utils.go +++ b/modules/git/utils.go @@ -100,6 +100,9 @@ func RefURL(repoURL, ref string) string { return repoURL + "/src/branch/" + refName case strings.HasPrefix(ref, TagPrefix): return repoURL + "/src/tag/" + refName + case !SHAPattern.MatchString(ref): + // assume they mean a branch + return repoURL + "/src/branch/" + refName default: return repoURL + "/src/commit/" + refName } diff --git a/routers/web/repo/issue.go b/routers/web/repo/issue.go index e6f9529e31e8..6856c1e0bec7 100644 --- a/routers/web/repo/issue.go +++ b/routers/web/repo/issue.go @@ -782,6 +782,10 @@ func setTemplateIfExists(ctx *context.Context, ctxDataKey string, possibleDirs, } } } + if !strings.HasPrefix(meta.Ref, "refs/") { // Assume that the ref intended is always a branch - for tags users should use refs/tags/ + meta.Ref = "refs/heads/" + meta.Ref + } + ctx.Data["HasSelectedLabel"] = len(labelIDs) > 0 ctx.Data["label_ids"] = strings.Join(labelIDs, ",") ctx.Data["Reference"] = meta.Ref diff --git a/services/issue/issue.go b/services/issue/issue.go index 7131829b03e4..2ea7f06b1576 100644 --- a/services/issue/issue.go +++ b/services/issue/issue.go @@ -18,7 +18,6 @@ import ( "code.gitea.io/gitea/modules/git" "code.gitea.io/gitea/modules/notification" "code.gitea.io/gitea/modules/storage" - "code.gitea.io/gitea/modules/util" ) // NewIssue creates new issue with labels for repository. @@ -201,7 +200,7 @@ func GetRefEndNamesAndURLs(issues []*issues_model.Issue, repoLink string) (map[i for _, issue := range issues { if issue.Ref != "" { issueRefEndNames[issue.ID] = git.RefEndName(issue.Ref) - issueRefURLs[issue.ID] = git.RefURL(repoLink, util.PathEscapeSegments(issue.Ref)) + issueRefURLs[issue.ID] = git.RefURL(repoLink, issue.Ref) } } return issueRefEndNames, issueRefURLs