Merge branch 'feature/close_issue_with_state' of github.com:sillyguodong/gitea into feature/close_issue_with_state

Author: lunny

models/issues/comment.go

@@ -1297,6 +1297,11 @@ func (c *Comment) HasOriginalAuthor() bool {
 	return c.OriginalAuthor != "" && c.OriginalAuthorID != 0
 }
 
+func (c *Comment) GetIssueClosedStatus() int {
+	n, _ := strconv.Atoi(c.Content)
+	return n
+}
+
 // InsertIssueComments inserts many comments of issues.
 func InsertIssueComments(ctx context.Context, comments []*Comment) error {
 	if len(comments) == 0 {

models/issues/dependency_test.go

@@ -49,7 +49,8 @@ func TestCreateIssueDependency(t *testing.T) {
 	assert.False(t, left)
 
 	// Close #2 and check again
-	_, err = issues_model.ChangeIssueStatus(db.DefaultContext, issue2, user1, true)
+	issue2.IsClosed = true
+	_, err = issues_model.ChangeIssueStatus(db.DefaultContext, issue2, user1)
 	assert.NoError(t, err)
 
 	left, err = issues_model.IssueNoDependenciesLeft(db.DefaultContext, issue1)

models/issues/issue.go

@@ -94,6 +94,15 @@ func (err ErrIssueWasClosed) Error() string {
 	return fmt.Sprintf("Issue [%d] %d was already closed", err.ID, err.Index)
 }
 
+type IssueClosedStatus int8
+
+const (
+	IssueClosedStatusCommon   IssueClosedStatus = iota // 0 close issue without any state.
+	IssueClosedStatusArchived                          // 1
+	IssueClosedStatusResolved                          // 2
+	IssueClosedStatusStale                             // 3
+)
+
 var ErrIssueAlreadyChanged = util.NewInvalidArgumentErrorf("the issue is already changed")
 
 // Issue represents an issue or pull request of repository.
@@ -121,6 +130,7 @@ type Issue struct {
 	Assignee          *user_model.User `xorm:"-"`
 	isAssigneeLoaded  bool             `xorm:"-"`
 	IsClosed          bool             `xorm:"INDEX"`
+	ClosedStatus     IssueClosedStatus `xorm:"NOT NULL DEFAULT 0"`
 	IsRead            bool             `xorm:"-"`
 	IsPull            bool             `xorm:"INDEX"` // Indicates whether is a pull request or not.
 	PullRequest       *PullRequest     `xorm:"-"`

models/issues/issue_update.go

@@ -6,6 +6,7 @@ package issues
 import (
 	"context"
 	"fmt"
+	"strconv"
 	"strings"
 
 	"code.gitea.io/gitea/models/db"
@@ -33,26 +34,27 @@ func UpdateIssueCols(ctx context.Context, issue *Issue, cols ...string) error {
 	return nil
 }
 
-func changeIssueStatus(ctx context.Context, issue *Issue, doer *user_model.User, isClosed, isMergePull bool) (*Comment, error) {
+func changeIssueStatus(ctx context.Context, issue *Issue, doer *user_model.User, isMergePull bool) (*Comment, error) {
 	// Reload the issue
 	currentIssue, err := GetIssueByID(ctx, issue.ID)
 	if err != nil {
 		return nil, err
 	}
 
 	// Nothing should be performed if current status is same as target status
-	if currentIssue.IsClosed == isClosed {
-		if !issue.IsPull {
-			return nil, ErrIssueWasClosed{
+	if currentIssue.IsClosed == issue.IsClosed {
+		if issue.IsPull {
+			return nil, ErrPullWasClosed{
 				ID: issue.ID,
 			}
 		}
-		return nil, ErrPullWasClosed{
-			ID: issue.ID,
+		if currentIssue.ClosedStatus == issue.ClosedStatus {
+			return nil, ErrIssueWasClosed{
+				ID: issue.ID,
+			}
 		}
 	}
 
-	issue.IsClosed = isClosed
 	return doChangeIssueStatus(ctx, issue, doer, isMergePull)
 }
 
@@ -76,7 +78,7 @@ func doChangeIssueStatus(ctx context.Context, issue *Issue, doer *user_model.Use
 		issue.ClosedUnix = 0
 	}
 
-	if err := UpdateIssueCols(ctx, issue, "is_closed", "closed_unix"); err != nil {
+	if err := UpdateIssueCols(ctx, issue, "is_closed", "closed_status", "closed_unix"); err != nil {
 		return nil, err
 	}
 
@@ -104,30 +106,36 @@ func doChangeIssueStatus(ctx context.Context, issue *Issue, doer *user_model.Use
 
 	// New action comment
 	cmtType := CommentTypeClose
+	var content string
+	if !issue.IsPull && issue.IsClosed {
+		content = strconv.Itoa(int(issue.ClosedStatus))
+	}
+
 	if !issue.IsClosed {
 		cmtType = CommentTypeReopen
 	} else if isMergePull {
 		cmtType = CommentTypeMergePull
 	}
 
 	return CreateComment(ctx, &CreateCommentOptions{
-		Type:  cmtType,
-		Doer:  doer,
-		Repo:  issue.Repo,
-		Issue: issue,
+		Type:    cmtType,
+		Doer:    doer,
+		Repo:    issue.Repo,
+		Issue:   issue,
+		Content: content,
 	})
 }
 
 // ChangeIssueStatus changes issue status to open or closed.
-func ChangeIssueStatus(ctx context.Context, issue *Issue, doer *user_model.User, isClosed bool) (*Comment, error) {
+func ChangeIssueStatus(ctx context.Context, issue *Issue, doer *user_model.User) (*Comment, error) {
 	if err := issue.LoadRepo(ctx); err != nil {
 		return nil, err
 	}
 	if err := issue.LoadPoster(ctx); err != nil {
 		return nil, err
 	}
 
-	return changeIssueStatus(ctx, issue, doer, isClosed, false)
+	return changeIssueStatus(ctx, issue, doer, false)
 }
 
 // ChangeIssueTitle changes the title of this issue, as the given user.
@@ -434,6 +442,71 @@ func UpdateIssueMentions(ctx context.Context, issueID int64, mentions []*user_mo
 	return nil
 }
 
+// UpdateIssueByAPI updates all allowed fields of given issue.
+// If the issue status is changed a statusChangeComment is returned
+// similarly if the title is changed the titleChanged bool is set to true
+func UpdateIssueByAPI(issue *Issue, doer *user_model.User) (statusChangeComment *Comment, titleChanged bool, err error) {
+	ctx, committer, err := db.TxContext(db.DefaultContext)
+	if err != nil {
+		return nil, false, err
+	}
+	defer committer.Close()
+
+	if err := issue.LoadRepo(ctx); err != nil {
+		return nil, false, fmt.Errorf("loadRepo: %w", err)
+	}
+
+	// Reload the issue
+	currentIssue, err := GetIssueByID(ctx, issue.ID)
+	if err != nil {
+		return nil, false, err
+	}
+
+	if _, err := db.GetEngine(ctx).ID(issue.ID).Cols(
+		"name", "content", "milestone_id", "priority",
+		"deadline_unix", "updated_unix", "is_locked").
+		Update(issue); err != nil {
+		return nil, false, err
+	}
+
+	titleChanged = currentIssue.Title != issue.Title
+	if titleChanged {
+		opts := &CreateCommentOptions{
+			Type:     CommentTypeChangeTitle,
+			Doer:     doer,
+			Repo:     issue.Repo,
+			Issue:    issue,
+			OldTitle: currentIssue.Title,
+			NewTitle: issue.Title,
+		}
+		_, err := CreateComment(ctx, opts)
+		if err != nil {
+			return nil, false, fmt.Errorf("createComment: %w", err)
+		}
+	}
+
+	if issue.IsPull {
+		if currentIssue.IsClosed != issue.IsClosed {
+			statusChangeComment, err = doChangeIssueStatus(ctx, issue, doer, false)
+			if err != nil {
+				return nil, false, err
+			}
+		}
+	} else {
+		if currentIssue.IsClosed != issue.IsClosed || currentIssue.ClosedStatus != issue.ClosedStatus {
+			statusChangeComment, err = doChangeIssueStatus(ctx, issue, doer, false)
+			if err != nil {
+				return nil, false, err
+			}
+		}
+	}
+
+	if err := issue.AddCrossReferences(ctx, doer, true); err != nil {
+		return nil, false, err
+	}
+	return statusChangeComment, titleChanged, committer.Commit()
+}
+
 // UpdateIssueDeadline updates an issue deadline and adds comments. Setting a deadline to 0 means deleting it.
 func UpdateIssueDeadline(ctx context.Context, issue *Issue, deadlineUnix timeutil.TimeStamp, doer *user_model.User) (err error) {
 	// if the deadline hasn't changed do nothing

models/issues/issue_xref_test.go

@@ -98,7 +98,8 @@ func TestXRef_ResolveCrossReferences(t *testing.T) {
 	i1 := testCreateIssue(t, 1, 2, "title1", "content1", false)
 	i2 := testCreateIssue(t, 1, 2, "title2", "content2", false)
 	i3 := testCreateIssue(t, 1, 2, "title3", "content3", false)
-	_, err := issues_model.ChangeIssueStatus(db.DefaultContext, i3, d, true)
+	i3.IsClosed = true
+	_, err := issues_model.ChangeIssueStatus(db.DefaultContext, i3, d)
 	assert.NoError(t, err)
 
 	pr := testCreatePR(t, 1, 2, "titlepr", fmt.Sprintf("closes #%d", i1.Index))

models/issues/pull.go

@@ -543,7 +543,8 @@ func (pr *PullRequest) SetMerged(ctx context.Context) (bool, error) {
 		return false, err
 	}
 
-	if _, err := changeIssueStatus(ctx, pr.Issue, pr.Merger, true, true); err != nil {
+	pr.Issue.IsClosed = true
+	if _, err := changeIssueStatus(ctx, pr.Issue, pr.Merger, true); err != nil {
 		return false, fmt.Errorf("Issue.changeStatus: %w", err)
 	}
 

models/migrations/migrations.go

@@ -601,6 +601,8 @@ var migrations = []Migration{
 	NewMigration("Add metadata column for comment table", v1_23.AddCommentMetaDataColumn),
 	// v304 -> v305
 	NewMigration("Add index for release sha1", v1_23.AddIndexForReleaseSha1),
+	// v305 -> v306
+	NewMigration("Add column of closed_status to issue table", v1_23.AddClosedStatusToIssue),
 }
 
 // GetCurrentDBVersion returns the current db version

models/migrations/v1_23/v305.go

@@ -0,0 +1,18 @@
+// Copyright 2024 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package v1_23 //nolint
+
+import (
+	issues_model "code.gitea.io/gitea/models/issues"
+
+	"xorm.io/xorm"
+)
+
+func AddClosedStatusToIssue(x *xorm.Engine) error {
+	type Issue struct {
+		ClosedStatus issues_model.IssueClosedStatus `xorm:"NOT NULL DEFAULT 0"`
+	}
+
+	return x.Sync(new(Issue))
+}

modules/structs/issue.go

@@ -25,6 +25,12 @@ const (
 	StateAll StateType = "all"
 )
 
+const (
+	ClosedStatusArchived = "archived"
+	ClosedStatusResolved = "resolved"
+	ClosedStatusStale    = "stale"
+)
+
 // PullRequestMeta PR info if an issue is a PR
 type PullRequestMeta struct {
 	HasMerged        bool       `json:"merged"`
@@ -113,6 +119,7 @@ type EditIssueOption struct {
 	// swagger:strfmt date-time
 	Deadline       *time.Time `json:"due_date"`
 	RemoveDeadline *bool      `json:"unset_due_date"`
+	ClosedStatus   *string    `json:"closed_status"`
 }
 
 // EditDeadlineOption options for creating a deadline

options/locale/locale_en-US.ini

@@ -498,6 +498,9 @@ issue.action.force_push = <b>%[1]s</b> force-pushed the <b>%[2]s</b> from %[3]s
 issue.action.push_1 = <b>@%[1]s</b> pushed %[3]d commit to %[2]s
 issue.action.push_n = <b>@%[1]s</b> pushed %[3]d commits to %[2]s
 issue.action.close = <b>@%[1]s</b> closed #%[2]d.
+issue.action.close_as_archived = <b>@%[1]s</b> closed as archived #%[2]d.
+issue.action.close_as_resolved = <b>@%[1]s</b> closed as resolved #%[2]d.
+issue.action.close_as_stale = <b>@%[1]s</b> closed as stale #%[2]d.
 issue.action.reopen = <b>@%[1]s</b> reopened #%[2]d.
 issue.action.merge = <b>@%[1]s</b> merged #%[2]d into %[3]s.
 issue.action.approve = <b>@%[1]s</b> approved this pull request.
@@ -1575,6 +1578,9 @@ issues.reopen_comment_issue = Reopen with Comment
 issues.create_comment = Comment
 issues.comment.blocked_user = Cannot create or edit comment because you are blocked by the poster or repository owner.
 issues.closed_at = `closed this issue <a id="%[1]s" href="#%[1]s">%[2]s</a>`
+issues.closed_as_archived_at = `closed this issue as archived <a id="%[1]s" href="#%[1]s">%[2]s</a>`
+issues.closed_as_resolved_at = `closed this issue as resolved <a id="%[1]s" href="#%[1]s">%[2]s</a>`
+issues.closed_as_stale_at = `closed this issue as stale <a id="%[1]s" href="#%[1]s">%[2]s</a>`
 issues.reopened_at = `reopened this issue <a id="%[1]s" href="#%[1]s">%[2]s</a>`
 issues.commit_ref_at = `referenced this issue from a commit <a id="%[1]s" href="#%[1]s">%[2]s</a>`
 issues.ref_issue_from = `<a href="%[3]s">referenced this issue %[4]s</a> <a id="%[1]s" href="#%[1]s">%[2]s</a>`
@@ -1596,6 +1602,19 @@ issues.role.first_time_contributor = First-time contributor
 issues.role.first_time_contributor_helper = This is the first contribution of this user to the repository.
 issues.role.contributor = Contributor
 issues.role.contributor_helper = This user has previously committed to the repository.
+issues.close_as.reopen = Reopen
+issues.close_as.common = Close Issue
+issues.close_as.archived = Close as archived
+issues.close_as.resolved = Close as resolved
+issues.close_as.stale = Close as stale
+issues.comment_and_close_as.reopen = Comment and Reopen
+issues.comment_and_close_as.common = Comment and Close Issue
+issues.comment_and_close_as.archived = Comment and Close as archived
+issues.comment_and_close_as.resolved = Comment and Close as resolved
+issues.comment_and_close_as.stale = Comment and Close as stale
+issues.poster = Poster
+issues.collaborator = Collaborator
+issues.owner = Owner
 issues.re_request_review=Re-request review
 issues.is_stale = There have been changes to this PR since this review
 issues.remove_request_review=Remove review request
@@ -1898,6 +1917,7 @@ pulls.update_branch_success = Branch update was successful
 pulls.update_not_allowed = You are not allowed to update branch
 pulls.outdated_with_base_branch = This branch is out-of-date with the base branch
 pulls.close = Close Pull Request
+pulls.comment_and_close = Comment and close Pull Request
 pulls.closed_at = `closed this pull request <a id="%[1]s" href="#%[1]s">%[2]s</a>`
 pulls.reopened_at = `reopened this pull request <a id="%[1]s" href="#%[1]s">%[2]s</a>`
 pulls.cmd_instruction_hint = `View <a class="show-instruction">command line instructions</a>.`