mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-09-07 07:03:21 +00:00
Fix #20456 At some point during the 1.17 cycle abbreviated refishs 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 `fullref`s as much as possible. That is where a user has inputted a abbreviated `refish` 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` / `SHA`. 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 `SHA`s if they're used in a `ref` or `refish` field. We must not store a potentially ambiguous `refish` as a `ref`. (Especially when referring a `tag` - 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 the `SHA` pattern.) To that end in order to fix this bug, when parsing issue templates check the provided `Ref` (here a `refish` because almost all users do not know or understand the subtly), if it does not start with `refs/` add the `BranchPrefix` to it. This allows people to make their templates refer to a `tag` but not to a `SHA` directly. (I don't think that is particularly unreasonable but if people disagree I can make the `refish` be checked to see if it matches the `SHA` pattern.) 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` argument can be double-escaped so we remove the incorrect external escape. (The escape added in #17551 is in the right place - unfortunately I missed that the calling function was doing the wrong thing.) Then within `RefURL()` we check if an unprefixed `ref` (therefore potentially a `refish`) matches the `SHA` pattern before assuming that is actually a `commit` - otherwise 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 - which are `refish` as a `ref`. It will keep on causing problems like this. Fix #20456 Signed-off-by: Andrew Thornton <art27@cantab.net> Co-authored-by: Lauris BH <lauris@nix.lv> Co-authored-by: wxiaoguang <wxiaoguang@gmail.com> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
286 lines
8.3 KiB
Go
286 lines
8.3 KiB
Go
// Copyright 2019 The Gitea Authors. All rights reserved.
|
|
// Use of this source code is governed by a MIT-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package issue
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
activities_model "code.gitea.io/gitea/models/activities"
|
|
"code.gitea.io/gitea/models/db"
|
|
issues_model "code.gitea.io/gitea/models/issues"
|
|
access_model "code.gitea.io/gitea/models/perm/access"
|
|
project_model "code.gitea.io/gitea/models/project"
|
|
repo_model "code.gitea.io/gitea/models/repo"
|
|
system_model "code.gitea.io/gitea/models/system"
|
|
user_model "code.gitea.io/gitea/models/user"
|
|
"code.gitea.io/gitea/modules/git"
|
|
"code.gitea.io/gitea/modules/notification"
|
|
"code.gitea.io/gitea/modules/storage"
|
|
)
|
|
|
|
// NewIssue creates new issue with labels for repository.
|
|
func NewIssue(repo *repo_model.Repository, issue *issues_model.Issue, labelIDs []int64, uuids []string, assigneeIDs []int64) error {
|
|
if err := issues_model.NewIssue(repo, issue, labelIDs, uuids); err != nil {
|
|
return err
|
|
}
|
|
|
|
for _, assigneeID := range assigneeIDs {
|
|
if err := AddAssigneeIfNotAssigned(issue, issue.Poster, assigneeID); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
mentions, err := issues_model.FindAndUpdateIssueMentions(db.DefaultContext, issue, issue.Poster, issue.Content)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
notification.NotifyNewIssue(db.DefaultContext, issue, mentions)
|
|
if len(issue.Labels) > 0 {
|
|
notification.NotifyIssueChangeLabels(db.DefaultContext, issue.Poster, issue, issue.Labels, nil)
|
|
}
|
|
if issue.Milestone != nil {
|
|
notification.NotifyIssueChangeMilestone(db.DefaultContext, issue.Poster, issue, 0)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// ChangeTitle changes the title of this issue, as the given user.
|
|
func ChangeTitle(issue *issues_model.Issue, doer *user_model.User, title string) (err error) {
|
|
oldTitle := issue.Title
|
|
issue.Title = title
|
|
|
|
if err = issues_model.ChangeIssueTitle(issue, doer, oldTitle); err != nil {
|
|
return
|
|
}
|
|
|
|
notification.NotifyIssueChangeTitle(db.DefaultContext, doer, issue, oldTitle)
|
|
|
|
return nil
|
|
}
|
|
|
|
// ChangeIssueRef changes the branch of this issue, as the given user.
|
|
func ChangeIssueRef(issue *issues_model.Issue, doer *user_model.User, ref string) error {
|
|
oldRef := issue.Ref
|
|
issue.Ref = ref
|
|
|
|
if err := issues_model.ChangeIssueRef(issue, doer, oldRef); err != nil {
|
|
return err
|
|
}
|
|
|
|
notification.NotifyIssueChangeRef(db.DefaultContext, doer, issue, oldRef)
|
|
|
|
return nil
|
|
}
|
|
|
|
// UpdateAssignees is a helper function to add or delete one or multiple issue assignee(s)
|
|
// Deleting is done the GitHub way (quote from their api documentation):
|
|
// https://developer.github.com/v3/issues/#edit-an-issue
|
|
// "assignees" (array): Logins for Users to assign to this issue.
|
|
// Pass one or more user logins to replace the set of assignees on this Issue.
|
|
// Send an empty array ([]) to clear all assignees from the Issue.
|
|
func UpdateAssignees(issue *issues_model.Issue, oneAssignee string, multipleAssignees []string, doer *user_model.User) (err error) {
|
|
var allNewAssignees []*user_model.User
|
|
|
|
// Keep the old assignee thingy for compatibility reasons
|
|
if oneAssignee != "" {
|
|
// Prevent double adding assignees
|
|
var isDouble bool
|
|
for _, assignee := range multipleAssignees {
|
|
if assignee == oneAssignee {
|
|
isDouble = true
|
|
break
|
|
}
|
|
}
|
|
|
|
if !isDouble {
|
|
multipleAssignees = append(multipleAssignees, oneAssignee)
|
|
}
|
|
}
|
|
|
|
// Loop through all assignees to add them
|
|
for _, assigneeName := range multipleAssignees {
|
|
assignee, err := user_model.GetUserByName(db.DefaultContext, assigneeName)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
allNewAssignees = append(allNewAssignees, assignee)
|
|
}
|
|
|
|
// Delete all old assignees not passed
|
|
if err = DeleteNotPassedAssignee(issue, doer, allNewAssignees); err != nil {
|
|
return err
|
|
}
|
|
|
|
// Add all new assignees
|
|
// Update the assignee. The function will check if the user exists, is already
|
|
// assigned (which he shouldn't as we deleted all assignees before) and
|
|
// has access to the repo.
|
|
for _, assignee := range allNewAssignees {
|
|
// Extra method to prevent double adding (which would result in removing)
|
|
err = AddAssigneeIfNotAssigned(issue, doer, assignee.ID)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
return err
|
|
}
|
|
|
|
// DeleteIssue deletes an issue
|
|
func DeleteIssue(doer *user_model.User, gitRepo *git.Repository, issue *issues_model.Issue) error {
|
|
// load issue before deleting it
|
|
if err := issue.LoadAttributes(gitRepo.Ctx); err != nil {
|
|
return err
|
|
}
|
|
if err := issue.LoadPullRequest(gitRepo.Ctx); err != nil {
|
|
return err
|
|
}
|
|
|
|
// delete entries in database
|
|
if err := deleteIssue(issue); err != nil {
|
|
return err
|
|
}
|
|
|
|
// delete pull request related git data
|
|
if issue.IsPull {
|
|
if err := gitRepo.RemoveReference(fmt.Sprintf("%s%d/head", git.PullPrefix, issue.PullRequest.Index)); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
notification.NotifyDeleteIssue(gitRepo.Ctx, doer, issue)
|
|
|
|
return nil
|
|
}
|
|
|
|
// AddAssigneeIfNotAssigned adds an assignee only if he isn't already assigned to the issue.
|
|
// Also checks for access of assigned user
|
|
func AddAssigneeIfNotAssigned(issue *issues_model.Issue, doer *user_model.User, assigneeID int64) (err error) {
|
|
assignee, err := user_model.GetUserByIDCtx(db.DefaultContext, assigneeID)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
// Check if the user is already assigned
|
|
isAssigned, err := issues_model.IsUserAssignedToIssue(db.DefaultContext, issue, assignee)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if isAssigned {
|
|
// nothing to to
|
|
return nil
|
|
}
|
|
|
|
valid, err := access_model.CanBeAssigned(db.DefaultContext, assignee, issue.Repo, issue.IsPull)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if !valid {
|
|
return repo_model.ErrUserDoesNotHaveAccessToRepo{UserID: assigneeID, RepoName: issue.Repo.Name}
|
|
}
|
|
|
|
_, _, err = ToggleAssignee(issue, doer, assigneeID)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// GetRefEndNamesAndURLs retrieves the ref end names (e.g. refs/heads/branch-name -> branch-name)
|
|
// and their respective URLs.
|
|
func GetRefEndNamesAndURLs(issues []*issues_model.Issue, repoLink string) (map[int64]string, map[int64]string) {
|
|
issueRefEndNames := make(map[int64]string, len(issues))
|
|
issueRefURLs := make(map[int64]string, len(issues))
|
|
for _, issue := range issues {
|
|
if issue.Ref != "" {
|
|
issueRefEndNames[issue.ID] = git.RefEndName(issue.Ref)
|
|
issueRefURLs[issue.ID] = git.RefURL(repoLink, issue.Ref)
|
|
}
|
|
}
|
|
return issueRefEndNames, issueRefURLs
|
|
}
|
|
|
|
// deleteIssue deletes the issue
|
|
func deleteIssue(issue *issues_model.Issue) error {
|
|
ctx, committer, err := db.TxContext(db.DefaultContext)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer committer.Close()
|
|
|
|
e := db.GetEngine(ctx)
|
|
if _, err := e.ID(issue.ID).NoAutoCondition().Delete(issue); err != nil {
|
|
return err
|
|
}
|
|
|
|
if err := repo_model.UpdateRepoIssueNumbers(ctx, issue.RepoID, issue.IsPull, issue.IsClosed); err != nil {
|
|
return err
|
|
}
|
|
|
|
if err := issues_model.UpdateMilestoneCounters(ctx, issue.MilestoneID); err != nil {
|
|
return fmt.Errorf("error updating counters for milestone id %d: %w",
|
|
issue.MilestoneID, err)
|
|
}
|
|
|
|
if err := activities_model.DeleteIssueActions(ctx, issue.RepoID, issue.ID); err != nil {
|
|
return err
|
|
}
|
|
|
|
// find attachments related to this issue and remove them
|
|
if err := issue.LoadAttributes(ctx); err != nil {
|
|
return err
|
|
}
|
|
|
|
for i := range issue.Attachments {
|
|
system_model.RemoveStorageWithNotice(ctx, storage.Attachments, "Delete issue attachment", issue.Attachments[i].RelativePath())
|
|
}
|
|
|
|
// delete all database data still assigned to this issue
|
|
if err := issues_model.DeleteInIssue(ctx, issue.ID,
|
|
&issues_model.ContentHistory{},
|
|
&issues_model.Comment{},
|
|
&issues_model.IssueLabel{},
|
|
&issues_model.IssueDependency{},
|
|
&issues_model.IssueAssignees{},
|
|
&issues_model.IssueUser{},
|
|
&activities_model.Notification{},
|
|
&issues_model.Reaction{},
|
|
&issues_model.IssueWatch{},
|
|
&issues_model.Stopwatch{},
|
|
&issues_model.TrackedTime{},
|
|
&project_model.ProjectIssue{},
|
|
&repo_model.Attachment{},
|
|
&issues_model.PullRequest{},
|
|
); err != nil {
|
|
return err
|
|
}
|
|
|
|
// References to this issue in other issues
|
|
if _, err := db.DeleteByBean(ctx, &issues_model.Comment{
|
|
RefIssueID: issue.ID,
|
|
}); err != nil {
|
|
return err
|
|
}
|
|
|
|
// Delete dependencies for issues in other repositories
|
|
if _, err := db.DeleteByBean(ctx, &issues_model.IssueDependency{
|
|
DependencyID: issue.ID,
|
|
}); err != nil {
|
|
return err
|
|
}
|
|
|
|
// delete from dependent issues
|
|
if _, err := db.DeleteByBean(ctx, &issues_model.Comment{
|
|
DependentIssueID: issue.ID,
|
|
}); err != nil {
|
|
return err
|
|
}
|
|
|
|
return committer.Commit()
|
|
}
|