mirror of
https://codeberg.org/forgejo/forgejo
synced 2024-08-21 23:21:11 +02:00
This field adds the possibility to set the update date when modifying an issue through the API. A 'NoAutoDate' in-memory field is added in the Issue struct. If the update_at field is set, NoAutoDate is set to true and the Issue's UpdatedUnix field is filled. That information is passed down to the functions that actually updates the database, which have been modified to not auto update dates if requested. A guard is added to the 'EditIssue' API call, to checks that the udpate_at date is between the issue's creation date and the current date (to avoid 'malicious' changes). It also limits the new feature to project's owners and admins. (cherry picked from commitc524d33402
) Add a SetIssueUpdateDate() function in services/issue.go That function is used by some API calls to set the NoAutoDate and UpdatedUnix fields of an Issue if an updated_at date is provided. (cherry picked from commitf061caa655
) Add an updated_at field to the API calls related to Issue's Labels. The update date is applied to the issue's comment created to inform about the modification of the issue's labels. (cherry picked from commitea36cf80f5
) Add an updated_at field to the API call for issue's attachment creation The update date is applied to the issue's comment created to inform about the modification of the issue's content, and is set as the asset creation date. (cherry picked from commit96150971ca
) Checking Issue changes, with and without providing an updated_at date Those unit tests are added: - TestAPIEditIssueWithAutoDate - TestAPIEditIssueWithNoAutoDate - TestAPIAddIssueLabelsWithAutoDate - TestAPIAddIssueLabelsWithNoAutoDate - TestAPICreateIssueAttachmentWithAutoDate - TestAPICreateIssueAttachmentWithNoAutoDate (cherry picked from commit4926a5d7a2
) Add an updated_at field to the API call for issue's comment creation The update date is used as the comment creation date, and is applied to the issue as the update creation date. (cherry picked from commit76c8faecdc
) Add an updated_at field to the API call for issue's comment edition The update date is used as the comment update date, and is applied to the issue as an update date. (cherry picked from commitcf787ad7fd
) Add an updated_at field to the API call for comment's attachment creation The update date is applied to the comment, and is set as the asset creation date. (cherry picked from commit1e4ff424d3
) Checking Comment changes, with and without providing an updated_at date Those unit tests are added: - TestAPICreateCommentWithAutoDate - TestAPICreateCommentWithNoAutoDate - TestAPIEditCommentWithAutoDate - TestAPIEditCommentWithNoAutoDate - TestAPICreateCommentAttachmentWithAutoDate - TestAPICreateCommentAttachmentWithNoAutoDate (cherry picked from commitda932152f1
) Pettier code to set the update time of comments Now uses sess.AllCols().NoAutoToime().SetExpr("updated_unix", ...) XORM is smart enough to compose one single SQL UPDATE which all columns + updated_unix. (cherry picked from commit1f6a42808d
) Issue edition: Keep the max of the milestone and issue update dates. When editing an issue via the API, an updated_at date can be provided. If the EditIssue call changes the issue's milestone, the milestone's update date is to be changed accordingly, but only with a greater value. This ensures that a milestone's update date is the max of all issue's update dates. (cherry picked from commit8f22ea182e
) Rewrite the 'AutoDate' tests using subtests Also add a test to check the permissions to set a date, and a test to check update dates on milestones. The tests related to 'AutoDate' are: - TestAPIEditIssueAutoDate - TestAPIAddIssueLabelsAutoDate - TestAPIEditIssueMilestoneAutoDate - TestAPICreateIssueAttachmentAutoDate - TestAPICreateCommentAutoDate - TestAPIEditCommentWithDate - TestAPICreateCommentAttachmentAutoDate (cherry picked from commit961fd13c55
) (cherry picked from commitd52f4eea44
) (cherry picked from commit3540ea2a43
) Conflicts: services/issue/issue.go https://codeberg.org/forgejo/forgejo/pulls/1415 (cherry picked from commit56720ade00
) Conflicts: routers/api/v1/repo/issue_label.go https://codeberg.org/forgejo/forgejo/pulls/1462 (cherry picked from commit47c78927d6
) (cherry picked from commit2030f3b965
) (cherry picked from commitf02aeb7698
) Conflicts: routers/api/v1/repo/issue_attachment.go routers/api/v1/repo/issue_comment_attachment.go https://codeberg.org/forgejo/forgejo/pulls/1575 (cherry picked from commitd072525b35
) (cherry picked from commit8424d0ab3d
) (cherry picked from commit5cc62caec7
) (cherry picked from commitd6300d5dcd
) [FEAT] allow setting the update date on issues and comments (squash) apply the 'update_at' value to the cross-ref comments (#1676) [this is a follow-up to PR #764] When a comment of issue A referencing issue B is added with a forced 'updated_at' date, that date has to be applied to the comment created in issue B. ----- Comment: While trying my 'RoundUp migration script', I found that this case was forgotten in PR #764 - my apologies... I'll try to write a functional test, base on models/issues/issue_xref_test.go Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/1676 Co-authored-by: fluzz <fluzz@freedroid.org> Co-committed-by: fluzz <fluzz@freedroid.org> (cherry picked from commitac4f727f63
) (cherry picked from commit5110476ee9
) (cherry picked from commit77ba6be1da
) (cherry picked from commit9c8337b5c4
) (cherry picked from commit1d689eb686
) (cherry picked from commit511c519c87
) (cherry picked from commit2f0b4a8f61
) (cherry picked from commitfdd4da111c
) [FEAT] allow setting the update date on issues and comments (squash) do not use token= query param See https://codeberg.org/forgejo/forgejo/commit/33439b733a (cherry picked from commitc5139a75b9
) (cherry picked from commitc7b572c35d
) (cherry picked from commitaec7503ff6
) (cherry picked from commit87c65f2a49
)
926 lines
26 KiB
Go
926 lines
26 KiB
Go
// Copyright 2014 The Gogs Authors. All rights reserved.
|
|
// Copyright 2020 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package issues
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"regexp"
|
|
"slices"
|
|
|
|
"code.gitea.io/gitea/models/db"
|
|
project_model "code.gitea.io/gitea/models/project"
|
|
repo_model "code.gitea.io/gitea/models/repo"
|
|
user_model "code.gitea.io/gitea/models/user"
|
|
"code.gitea.io/gitea/modules/container"
|
|
"code.gitea.io/gitea/modules/log"
|
|
"code.gitea.io/gitea/modules/setting"
|
|
api "code.gitea.io/gitea/modules/structs"
|
|
"code.gitea.io/gitea/modules/timeutil"
|
|
"code.gitea.io/gitea/modules/util"
|
|
|
|
"xorm.io/builder"
|
|
)
|
|
|
|
// ErrIssueNotExist represents a "IssueNotExist" kind of error.
|
|
type ErrIssueNotExist struct {
|
|
ID int64
|
|
RepoID int64
|
|
Index int64
|
|
}
|
|
|
|
// IsErrIssueNotExist checks if an error is a ErrIssueNotExist.
|
|
func IsErrIssueNotExist(err error) bool {
|
|
_, ok := err.(ErrIssueNotExist)
|
|
return ok
|
|
}
|
|
|
|
func (err ErrIssueNotExist) Error() string {
|
|
return fmt.Sprintf("issue does not exist [id: %d, repo_id: %d, index: %d]", err.ID, err.RepoID, err.Index)
|
|
}
|
|
|
|
func (err ErrIssueNotExist) Unwrap() error {
|
|
return util.ErrNotExist
|
|
}
|
|
|
|
// ErrIssueIsClosed represents a "IssueIsClosed" kind of error.
|
|
type ErrIssueIsClosed struct {
|
|
ID int64
|
|
RepoID int64
|
|
Index int64
|
|
}
|
|
|
|
// IsErrIssueIsClosed checks if an error is a ErrIssueNotExist.
|
|
func IsErrIssueIsClosed(err error) bool {
|
|
_, ok := err.(ErrIssueIsClosed)
|
|
return ok
|
|
}
|
|
|
|
func (err ErrIssueIsClosed) Error() string {
|
|
return fmt.Sprintf("issue is closed [id: %d, repo_id: %d, index: %d]", err.ID, err.RepoID, err.Index)
|
|
}
|
|
|
|
// ErrNewIssueInsert is used when the INSERT statement in newIssue fails
|
|
type ErrNewIssueInsert struct {
|
|
OriginalError error
|
|
}
|
|
|
|
// IsErrNewIssueInsert checks if an error is a ErrNewIssueInsert.
|
|
func IsErrNewIssueInsert(err error) bool {
|
|
_, ok := err.(ErrNewIssueInsert)
|
|
return ok
|
|
}
|
|
|
|
func (err ErrNewIssueInsert) Error() string {
|
|
return err.OriginalError.Error()
|
|
}
|
|
|
|
// ErrIssueWasClosed is used when close a closed issue
|
|
type ErrIssueWasClosed struct {
|
|
ID int64
|
|
Index int64
|
|
}
|
|
|
|
// IsErrIssueWasClosed checks if an error is a ErrIssueWasClosed.
|
|
func IsErrIssueWasClosed(err error) bool {
|
|
_, ok := err.(ErrIssueWasClosed)
|
|
return ok
|
|
}
|
|
|
|
func (err ErrIssueWasClosed) Error() string {
|
|
return fmt.Sprintf("Issue [%d] %d was already closed", err.ID, err.Index)
|
|
}
|
|
|
|
// Issue represents an issue or pull request of repository.
|
|
type Issue struct {
|
|
ID int64 `xorm:"pk autoincr"`
|
|
RepoID int64 `xorm:"INDEX UNIQUE(repo_index)"`
|
|
Repo *repo_model.Repository `xorm:"-"`
|
|
Index int64 `xorm:"UNIQUE(repo_index)"` // Index in one repository.
|
|
PosterID int64 `xorm:"INDEX"`
|
|
Poster *user_model.User `xorm:"-"`
|
|
OriginalAuthor string
|
|
OriginalAuthorID int64 `xorm:"index"`
|
|
Title string `xorm:"name"`
|
|
Content string `xorm:"LONGTEXT"`
|
|
RenderedContent string `xorm:"-"`
|
|
Labels []*Label `xorm:"-"`
|
|
MilestoneID int64 `xorm:"INDEX"`
|
|
Milestone *Milestone `xorm:"-"`
|
|
Project *project_model.Project `xorm:"-"`
|
|
Priority int
|
|
AssigneeID int64 `xorm:"-"`
|
|
Assignee *user_model.User `xorm:"-"`
|
|
IsClosed bool `xorm:"INDEX"`
|
|
IsRead bool `xorm:"-"`
|
|
IsPull bool `xorm:"INDEX"` // Indicates whether is a pull request or not.
|
|
PullRequest *PullRequest `xorm:"-"`
|
|
NumComments int
|
|
Ref string
|
|
PinOrder int `xorm:"DEFAULT 0"`
|
|
|
|
DeadlineUnix timeutil.TimeStamp `xorm:"INDEX"`
|
|
|
|
CreatedUnix timeutil.TimeStamp `xorm:"INDEX created"`
|
|
UpdatedUnix timeutil.TimeStamp `xorm:"INDEX updated"`
|
|
ClosedUnix timeutil.TimeStamp `xorm:"INDEX"`
|
|
NoAutoTime bool `xorm:"-"`
|
|
|
|
Attachments []*repo_model.Attachment `xorm:"-"`
|
|
Comments CommentList `xorm:"-"`
|
|
Reactions ReactionList `xorm:"-"`
|
|
TotalTrackedTime int64 `xorm:"-"`
|
|
Assignees []*user_model.User `xorm:"-"`
|
|
|
|
// IsLocked limits commenting abilities to users on an issue
|
|
// with write access
|
|
IsLocked bool `xorm:"NOT NULL DEFAULT false"`
|
|
|
|
// For view issue page.
|
|
ShowRole RoleDescriptor `xorm:"-"`
|
|
}
|
|
|
|
var (
|
|
issueTasksPat = regexp.MustCompile(`(^\s*[-*]\s\[[\sxX]\]\s.)|(\n\s*[-*]\s\[[\sxX]\]\s.)`)
|
|
issueTasksDonePat = regexp.MustCompile(`(^\s*[-*]\s\[[xX]\]\s.)|(\n\s*[-*]\s\[[xX]\]\s.)`)
|
|
)
|
|
|
|
// IssueIndex represents the issue index table
|
|
type IssueIndex db.ResourceIndex
|
|
|
|
func init() {
|
|
db.RegisterModel(new(Issue))
|
|
db.RegisterModel(new(IssueIndex))
|
|
}
|
|
|
|
// LoadTotalTimes load total tracked time
|
|
func (issue *Issue) LoadTotalTimes(ctx context.Context) (err error) {
|
|
opts := FindTrackedTimesOptions{IssueID: issue.ID}
|
|
issue.TotalTrackedTime, err = opts.toSession(db.GetEngine(ctx)).SumInt(&TrackedTime{}, "time")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// IsOverdue checks if the issue is overdue
|
|
func (issue *Issue) IsOverdue() bool {
|
|
if issue.IsClosed {
|
|
return issue.ClosedUnix >= issue.DeadlineUnix
|
|
}
|
|
return timeutil.TimeStampNow() >= issue.DeadlineUnix
|
|
}
|
|
|
|
// LoadRepo loads issue's repository
|
|
func (issue *Issue) LoadRepo(ctx context.Context) (err error) {
|
|
if issue.Repo == nil && issue.RepoID != 0 {
|
|
issue.Repo, err = repo_model.GetRepositoryByID(ctx, issue.RepoID)
|
|
if err != nil {
|
|
return fmt.Errorf("getRepositoryByID [%d]: %w", issue.RepoID, err)
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// IsTimetrackerEnabled returns true if the repo enables timetracking
|
|
func (issue *Issue) IsTimetrackerEnabled(ctx context.Context) bool {
|
|
if err := issue.LoadRepo(ctx); err != nil {
|
|
log.Error(fmt.Sprintf("loadRepo: %v", err))
|
|
return false
|
|
}
|
|
return issue.Repo.IsTimetrackerEnabled(ctx)
|
|
}
|
|
|
|
// GetPullRequest returns the issue pull request
|
|
func (issue *Issue) GetPullRequest(ctx context.Context) (pr *PullRequest, err error) {
|
|
if !issue.IsPull {
|
|
return nil, fmt.Errorf("Issue is not a pull request")
|
|
}
|
|
|
|
pr, err = GetPullRequestByIssueID(ctx, issue.ID)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
pr.Issue = issue
|
|
return pr, err
|
|
}
|
|
|
|
// LoadPoster loads poster
|
|
func (issue *Issue) LoadPoster(ctx context.Context) (err error) {
|
|
if issue.Poster == nil && issue.PosterID != 0 {
|
|
issue.Poster, err = user_model.GetPossibleUserByID(ctx, issue.PosterID)
|
|
if err != nil {
|
|
issue.PosterID = user_model.GhostUserID
|
|
issue.Poster = user_model.NewGhostUser()
|
|
if !user_model.IsErrUserNotExist(err) {
|
|
return fmt.Errorf("getUserByID.(poster) [%d]: %w", issue.PosterID, err)
|
|
}
|
|
return nil
|
|
}
|
|
}
|
|
return err
|
|
}
|
|
|
|
// LoadPullRequest loads pull request info
|
|
func (issue *Issue) LoadPullRequest(ctx context.Context) (err error) {
|
|
if issue.IsPull {
|
|
if issue.PullRequest == nil && issue.ID != 0 {
|
|
issue.PullRequest, err = GetPullRequestByIssueID(ctx, issue.ID)
|
|
if err != nil {
|
|
if IsErrPullRequestNotExist(err) {
|
|
return err
|
|
}
|
|
return fmt.Errorf("getPullRequestByIssueID [%d]: %w", issue.ID, err)
|
|
}
|
|
}
|
|
if issue.PullRequest != nil {
|
|
issue.PullRequest.Issue = issue
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (issue *Issue) loadComments(ctx context.Context) (err error) {
|
|
return issue.loadCommentsByType(ctx, CommentTypeUndefined)
|
|
}
|
|
|
|
// LoadDiscussComments loads discuss comments
|
|
func (issue *Issue) LoadDiscussComments(ctx context.Context) error {
|
|
return issue.loadCommentsByType(ctx, CommentTypeComment)
|
|
}
|
|
|
|
func (issue *Issue) loadCommentsByType(ctx context.Context, tp CommentType) (err error) {
|
|
if issue.Comments != nil {
|
|
return nil
|
|
}
|
|
issue.Comments, err = FindComments(ctx, &FindCommentsOptions{
|
|
IssueID: issue.ID,
|
|
Type: tp,
|
|
})
|
|
return err
|
|
}
|
|
|
|
func (issue *Issue) loadReactions(ctx context.Context) (err error) {
|
|
if issue.Reactions != nil {
|
|
return nil
|
|
}
|
|
reactions, _, err := FindReactions(ctx, FindReactionsOptions{
|
|
IssueID: issue.ID,
|
|
})
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if err = issue.LoadRepo(ctx); err != nil {
|
|
return err
|
|
}
|
|
// Load reaction user data
|
|
if _, err := reactions.LoadUsers(ctx, issue.Repo); err != nil {
|
|
return err
|
|
}
|
|
|
|
// Cache comments to map
|
|
comments := make(map[int64]*Comment)
|
|
for _, comment := range issue.Comments {
|
|
comments[comment.ID] = comment
|
|
}
|
|
// Add reactions either to issue or comment
|
|
for _, react := range reactions {
|
|
if react.CommentID == 0 {
|
|
issue.Reactions = append(issue.Reactions, react)
|
|
} else if comment, ok := comments[react.CommentID]; ok {
|
|
comment.Reactions = append(comment.Reactions, react)
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// LoadMilestone load milestone of this issue.
|
|
func (issue *Issue) LoadMilestone(ctx context.Context) (err error) {
|
|
if (issue.Milestone == nil || issue.Milestone.ID != issue.MilestoneID) && issue.MilestoneID > 0 {
|
|
issue.Milestone, err = GetMilestoneByRepoID(ctx, issue.RepoID, issue.MilestoneID)
|
|
if err != nil && !IsErrMilestoneNotExist(err) {
|
|
return fmt.Errorf("getMilestoneByRepoID [repo_id: %d, milestone_id: %d]: %w", issue.RepoID, issue.MilestoneID, err)
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// LoadAttributes loads the attribute of this issue.
|
|
func (issue *Issue) LoadAttributes(ctx context.Context) (err error) {
|
|
if err = issue.LoadRepo(ctx); err != nil {
|
|
return err
|
|
}
|
|
|
|
if err = issue.LoadPoster(ctx); err != nil {
|
|
return err
|
|
}
|
|
|
|
if err = issue.LoadLabels(ctx); err != nil {
|
|
return err
|
|
}
|
|
|
|
if err = issue.LoadMilestone(ctx); err != nil {
|
|
return err
|
|
}
|
|
|
|
if err = issue.LoadProject(ctx); err != nil {
|
|
return err
|
|
}
|
|
|
|
if err = issue.LoadAssignees(ctx); err != nil {
|
|
return err
|
|
}
|
|
|
|
if err = issue.LoadPullRequest(ctx); err != nil && !IsErrPullRequestNotExist(err) {
|
|
// It is possible pull request is not yet created.
|
|
return err
|
|
}
|
|
|
|
if issue.Attachments == nil {
|
|
issue.Attachments, err = repo_model.GetAttachmentsByIssueID(ctx, issue.ID)
|
|
if err != nil {
|
|
return fmt.Errorf("getAttachmentsByIssueID [%d]: %w", issue.ID, err)
|
|
}
|
|
}
|
|
|
|
if err = issue.loadComments(ctx); err != nil {
|
|
return err
|
|
}
|
|
|
|
if err = issue.Comments.LoadAttributes(ctx); err != nil {
|
|
return err
|
|
}
|
|
if issue.IsTimetrackerEnabled(ctx) {
|
|
if err = issue.LoadTotalTimes(ctx); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
return issue.loadReactions(ctx)
|
|
}
|
|
|
|
// GetIsRead load the `IsRead` field of the issue
|
|
func (issue *Issue) GetIsRead(ctx context.Context, userID int64) error {
|
|
issueUser := &IssueUser{IssueID: issue.ID, UID: userID}
|
|
if has, err := db.GetEngine(ctx).Get(issueUser); err != nil {
|
|
return err
|
|
} else if !has {
|
|
issue.IsRead = false
|
|
return nil
|
|
}
|
|
issue.IsRead = issueUser.IsRead
|
|
return nil
|
|
}
|
|
|
|
// APIURL returns the absolute APIURL to this issue.
|
|
func (issue *Issue) APIURL(ctx context.Context) string {
|
|
if issue.Repo == nil {
|
|
err := issue.LoadRepo(ctx)
|
|
if err != nil {
|
|
log.Error("Issue[%d].APIURL(): %v", issue.ID, err)
|
|
return ""
|
|
}
|
|
}
|
|
return fmt.Sprintf("%s/issues/%d", issue.Repo.APIURL(), issue.Index)
|
|
}
|
|
|
|
// HTMLURL returns the absolute URL to this issue.
|
|
func (issue *Issue) HTMLURL() string {
|
|
var path string
|
|
if issue.IsPull {
|
|
path = "pulls"
|
|
} else {
|
|
path = "issues"
|
|
}
|
|
return fmt.Sprintf("%s/%s/%d", issue.Repo.HTMLURL(), path, issue.Index)
|
|
}
|
|
|
|
// Link returns the issue's relative URL.
|
|
func (issue *Issue) Link() string {
|
|
var path string
|
|
if issue.IsPull {
|
|
path = "pulls"
|
|
} else {
|
|
path = "issues"
|
|
}
|
|
return fmt.Sprintf("%s/%s/%d", issue.Repo.Link(), path, issue.Index)
|
|
}
|
|
|
|
// DiffURL returns the absolute URL to this diff
|
|
func (issue *Issue) DiffURL() string {
|
|
if issue.IsPull {
|
|
return fmt.Sprintf("%s/pulls/%d.diff", issue.Repo.HTMLURL(), issue.Index)
|
|
}
|
|
return ""
|
|
}
|
|
|
|
// PatchURL returns the absolute URL to this patch
|
|
func (issue *Issue) PatchURL() string {
|
|
if issue.IsPull {
|
|
return fmt.Sprintf("%s/pulls/%d.patch", issue.Repo.HTMLURL(), issue.Index)
|
|
}
|
|
return ""
|
|
}
|
|
|
|
// State returns string representation of issue status.
|
|
func (issue *Issue) State() api.StateType {
|
|
if issue.IsClosed {
|
|
return api.StateClosed
|
|
}
|
|
return api.StateOpen
|
|
}
|
|
|
|
// HashTag returns unique hash tag for issue.
|
|
func (issue *Issue) HashTag() string {
|
|
return fmt.Sprintf("issue-%d", issue.ID)
|
|
}
|
|
|
|
// IsPoster returns true if given user by ID is the poster.
|
|
func (issue *Issue) IsPoster(uid int64) bool {
|
|
return issue.OriginalAuthorID == 0 && issue.PosterID == uid
|
|
}
|
|
|
|
// GetTasks returns the amount of tasks in the issues content
|
|
func (issue *Issue) GetTasks() int {
|
|
return len(issueTasksPat.FindAllStringIndex(issue.Content, -1))
|
|
}
|
|
|
|
// GetTasksDone returns the amount of completed tasks in the issues content
|
|
func (issue *Issue) GetTasksDone() int {
|
|
return len(issueTasksDonePat.FindAllStringIndex(issue.Content, -1))
|
|
}
|
|
|
|
// GetLastEventTimestamp returns the last user visible event timestamp, either the creation of this issue or the close.
|
|
func (issue *Issue) GetLastEventTimestamp() timeutil.TimeStamp {
|
|
if issue.IsClosed {
|
|
return issue.ClosedUnix
|
|
}
|
|
return issue.CreatedUnix
|
|
}
|
|
|
|
// GetLastEventLabel returns the localization label for the current issue.
|
|
func (issue *Issue) GetLastEventLabel() string {
|
|
if issue.IsClosed {
|
|
if issue.IsPull && issue.PullRequest.HasMerged {
|
|
return "repo.pulls.merged_by"
|
|
}
|
|
return "repo.issues.closed_by"
|
|
}
|
|
return "repo.issues.opened_by"
|
|
}
|
|
|
|
// GetLastComment return last comment for the current issue.
|
|
func (issue *Issue) GetLastComment(ctx context.Context) (*Comment, error) {
|
|
var c Comment
|
|
exist, err := db.GetEngine(ctx).Where("type = ?", CommentTypeComment).
|
|
And("issue_id = ?", issue.ID).Desc("created_unix").Get(&c)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if !exist {
|
|
return nil, nil
|
|
}
|
|
return &c, nil
|
|
}
|
|
|
|
// GetLastEventLabelFake returns the localization label for the current issue without providing a link in the username.
|
|
func (issue *Issue) GetLastEventLabelFake() string {
|
|
if issue.IsClosed {
|
|
if issue.IsPull && issue.PullRequest.HasMerged {
|
|
return "repo.pulls.merged_by_fake"
|
|
}
|
|
return "repo.issues.closed_by_fake"
|
|
}
|
|
return "repo.issues.opened_by_fake"
|
|
}
|
|
|
|
// GetIssueByIndex returns raw issue without loading attributes by index in a repository.
|
|
func GetIssueByIndex(ctx context.Context, repoID, index int64) (*Issue, error) {
|
|
if index < 1 {
|
|
return nil, ErrIssueNotExist{}
|
|
}
|
|
issue := &Issue{
|
|
RepoID: repoID,
|
|
Index: index,
|
|
}
|
|
has, err := db.GetEngine(ctx).Get(issue)
|
|
if err != nil {
|
|
return nil, err
|
|
} else if !has {
|
|
return nil, ErrIssueNotExist{0, repoID, index}
|
|
}
|
|
return issue, nil
|
|
}
|
|
|
|
// GetIssueWithAttrsByIndex returns issue by index in a repository.
|
|
func GetIssueWithAttrsByIndex(ctx context.Context, repoID, index int64) (*Issue, error) {
|
|
issue, err := GetIssueByIndex(ctx, repoID, index)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return issue, issue.LoadAttributes(ctx)
|
|
}
|
|
|
|
// GetIssueByID returns an issue by given ID.
|
|
func GetIssueByID(ctx context.Context, id int64) (*Issue, error) {
|
|
issue := new(Issue)
|
|
has, err := db.GetEngine(ctx).ID(id).Get(issue)
|
|
if err != nil {
|
|
return nil, err
|
|
} else if !has {
|
|
return nil, ErrIssueNotExist{id, 0, 0}
|
|
}
|
|
return issue, nil
|
|
}
|
|
|
|
// GetIssuesByIDs return issues with the given IDs.
|
|
// If keepOrder is true, the order of the returned issues will be the same as the given IDs.
|
|
func GetIssuesByIDs(ctx context.Context, issueIDs []int64, keepOrder ...bool) (IssueList, error) {
|
|
issues := make([]*Issue, 0, len(issueIDs))
|
|
|
|
if err := db.GetEngine(ctx).In("id", issueIDs).Find(&issues); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
if len(keepOrder) > 0 && keepOrder[0] {
|
|
m := make(map[int64]*Issue, len(issues))
|
|
appended := container.Set[int64]{}
|
|
for _, issue := range issues {
|
|
m[issue.ID] = issue
|
|
}
|
|
issues = issues[:0]
|
|
for _, id := range issueIDs {
|
|
if issue, ok := m[id]; ok && !appended.Contains(id) { // make sure the id is existed and not appended
|
|
appended.Add(id)
|
|
issues = append(issues, issue)
|
|
}
|
|
}
|
|
}
|
|
|
|
return issues, nil
|
|
}
|
|
|
|
// GetIssueIDsByRepoID returns all issue ids by repo id
|
|
func GetIssueIDsByRepoID(ctx context.Context, repoID int64) ([]int64, error) {
|
|
ids := make([]int64, 0, 10)
|
|
err := db.GetEngine(ctx).Table("issue").Cols("id").Where("repo_id = ?", repoID).Find(&ids)
|
|
return ids, err
|
|
}
|
|
|
|
// GetParticipantsIDsByIssueID returns the IDs of all users who participated in comments of an issue,
|
|
// but skips joining with `user` for performance reasons.
|
|
// User permissions must be verified elsewhere if required.
|
|
func GetParticipantsIDsByIssueID(ctx context.Context, issueID int64) ([]int64, error) {
|
|
userIDs := make([]int64, 0, 5)
|
|
return userIDs, db.GetEngine(ctx).
|
|
Table("comment").
|
|
Cols("poster_id").
|
|
Where("issue_id = ?", issueID).
|
|
And("type in (?,?,?)", CommentTypeComment, CommentTypeCode, CommentTypeReview).
|
|
Distinct("poster_id").
|
|
Find(&userIDs)
|
|
}
|
|
|
|
// IsUserParticipantsOfIssue return true if user is participants of an issue
|
|
func IsUserParticipantsOfIssue(ctx context.Context, user *user_model.User, issue *Issue) bool {
|
|
userIDs, err := issue.GetParticipantIDsByIssue(ctx)
|
|
if err != nil {
|
|
log.Error(err.Error())
|
|
return false
|
|
}
|
|
return slices.Contains(userIDs, user.ID)
|
|
}
|
|
|
|
// DependencyInfo represents high level information about an issue which is a dependency of another issue.
|
|
type DependencyInfo struct {
|
|
Issue `xorm:"extends"`
|
|
repo_model.Repository `xorm:"extends"`
|
|
}
|
|
|
|
// GetParticipantIDsByIssue returns all userIDs who are participated in comments of an issue and issue author
|
|
func (issue *Issue) GetParticipantIDsByIssue(ctx context.Context) ([]int64, error) {
|
|
if issue == nil {
|
|
return nil, nil
|
|
}
|
|
userIDs := make([]int64, 0, 5)
|
|
if err := db.GetEngine(ctx).Table("comment").Cols("poster_id").
|
|
Where("`comment`.issue_id = ?", issue.ID).
|
|
And("`comment`.type in (?,?,?)", CommentTypeComment, CommentTypeCode, CommentTypeReview).
|
|
And("`user`.is_active = ?", true).
|
|
And("`user`.prohibit_login = ?", false).
|
|
Join("INNER", "`user`", "`user`.id = `comment`.poster_id").
|
|
Distinct("poster_id").
|
|
Find(&userIDs); err != nil {
|
|
return nil, fmt.Errorf("get poster IDs: %w", err)
|
|
}
|
|
if !slices.Contains(userIDs, issue.PosterID) {
|
|
return append(userIDs, issue.PosterID), nil
|
|
}
|
|
return userIDs, nil
|
|
}
|
|
|
|
// BlockedByDependencies finds all Dependencies an issue is blocked by
|
|
func (issue *Issue) BlockedByDependencies(ctx context.Context, opts db.ListOptions) (issueDeps []*DependencyInfo, err error) {
|
|
sess := db.GetEngine(ctx).
|
|
Table("issue").
|
|
Join("INNER", "repository", "repository.id = issue.repo_id").
|
|
Join("INNER", "issue_dependency", "issue_dependency.dependency_id = issue.id").
|
|
Where("issue_id = ?", issue.ID).
|
|
// sort by repo id then created date, with the issues of the same repo at the beginning of the list
|
|
OrderBy("CASE WHEN issue.repo_id = ? THEN 0 ELSE issue.repo_id END, issue.created_unix DESC", issue.RepoID)
|
|
if opts.Page != 0 {
|
|
sess = db.SetSessionPagination(sess, &opts)
|
|
}
|
|
err = sess.Find(&issueDeps)
|
|
|
|
for _, depInfo := range issueDeps {
|
|
depInfo.Issue.Repo = &depInfo.Repository
|
|
}
|
|
|
|
return issueDeps, err
|
|
}
|
|
|
|
// BlockingDependencies returns all blocking dependencies, aka all other issues a given issue blocks
|
|
func (issue *Issue) BlockingDependencies(ctx context.Context) (issueDeps []*DependencyInfo, err error) {
|
|
err = db.GetEngine(ctx).
|
|
Table("issue").
|
|
Join("INNER", "repository", "repository.id = issue.repo_id").
|
|
Join("INNER", "issue_dependency", "issue_dependency.issue_id = issue.id").
|
|
Where("dependency_id = ?", issue.ID).
|
|
// sort by repo id then created date, with the issues of the same repo at the beginning of the list
|
|
OrderBy("CASE WHEN issue.repo_id = ? THEN 0 ELSE issue.repo_id END, issue.created_unix DESC", issue.RepoID).
|
|
Find(&issueDeps)
|
|
|
|
for _, depInfo := range issueDeps {
|
|
depInfo.Issue.Repo = &depInfo.Repository
|
|
}
|
|
|
|
return issueDeps, err
|
|
}
|
|
|
|
func migratedIssueCond(tp api.GitServiceType) builder.Cond {
|
|
return builder.In("issue_id",
|
|
builder.Select("issue.id").
|
|
From("issue").
|
|
InnerJoin("repository", "issue.repo_id = repository.id").
|
|
Where(builder.Eq{
|
|
"repository.original_service_type": tp,
|
|
}),
|
|
)
|
|
}
|
|
|
|
// RemapExternalUser ExternalUserRemappable interface
|
|
func (issue *Issue) RemapExternalUser(externalName string, externalID, userID int64) error {
|
|
issue.OriginalAuthor = externalName
|
|
issue.OriginalAuthorID = externalID
|
|
issue.PosterID = userID
|
|
return nil
|
|
}
|
|
|
|
// GetUserID ExternalUserRemappable interface
|
|
func (issue *Issue) GetUserID() int64 { return issue.PosterID }
|
|
|
|
// GetExternalName ExternalUserRemappable interface
|
|
func (issue *Issue) GetExternalName() string { return issue.OriginalAuthor }
|
|
|
|
// GetExternalID ExternalUserRemappable interface
|
|
func (issue *Issue) GetExternalID() int64 { return issue.OriginalAuthorID }
|
|
|
|
// HasOriginalAuthor returns if an issue was migrated and has an original author.
|
|
func (issue *Issue) HasOriginalAuthor() bool {
|
|
return issue.OriginalAuthor != "" && issue.OriginalAuthorID != 0
|
|
}
|
|
|
|
var ErrIssueMaxPinReached = util.NewInvalidArgumentErrorf("the max number of pinned issues has been readched")
|
|
|
|
// IsPinned returns if a Issue is pinned
|
|
func (issue *Issue) IsPinned() bool {
|
|
return issue.PinOrder != 0
|
|
}
|
|
|
|
// Pin pins a Issue
|
|
func (issue *Issue) Pin(ctx context.Context, user *user_model.User) error {
|
|
// If the Issue is already pinned, we don't need to pin it twice
|
|
if issue.IsPinned() {
|
|
return nil
|
|
}
|
|
|
|
var maxPin int
|
|
_, err := db.GetEngine(ctx).SQL("SELECT MAX(pin_order) FROM issue WHERE repo_id = ? AND is_pull = ?", issue.RepoID, issue.IsPull).Get(&maxPin)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
// Check if the maximum allowed Pins reached
|
|
if maxPin >= setting.Repository.Issue.MaxPinned {
|
|
return ErrIssueMaxPinReached
|
|
}
|
|
|
|
_, err = db.GetEngine(ctx).Table("issue").
|
|
Where("id = ?", issue.ID).
|
|
Update(map[string]any{
|
|
"pin_order": maxPin + 1,
|
|
})
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
// Add the pin event to the history
|
|
opts := &CreateCommentOptions{
|
|
Type: CommentTypePin,
|
|
Doer: user,
|
|
Repo: issue.Repo,
|
|
Issue: issue,
|
|
}
|
|
if _, err = CreateComment(ctx, opts); err != nil {
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// UnpinIssue unpins a Issue
|
|
func (issue *Issue) Unpin(ctx context.Context, user *user_model.User) error {
|
|
// If the Issue is not pinned, we don't need to unpin it
|
|
if !issue.IsPinned() {
|
|
return nil
|
|
}
|
|
|
|
// This sets the Pin for all Issues that come after the unpined Issue to the correct value
|
|
_, err := db.GetEngine(ctx).Exec("UPDATE issue SET pin_order = pin_order - 1 WHERE repo_id = ? AND is_pull = ? AND pin_order > ?", issue.RepoID, issue.IsPull, issue.PinOrder)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
_, err = db.GetEngine(ctx).Table("issue").
|
|
Where("id = ?", issue.ID).
|
|
Update(map[string]any{
|
|
"pin_order": 0,
|
|
})
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
// Add the unpin event to the history
|
|
opts := &CreateCommentOptions{
|
|
Type: CommentTypeUnpin,
|
|
Doer: user,
|
|
Repo: issue.Repo,
|
|
Issue: issue,
|
|
}
|
|
if _, err = CreateComment(ctx, opts); err != nil {
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// PinOrUnpin pins or unpins a Issue
|
|
func (issue *Issue) PinOrUnpin(ctx context.Context, user *user_model.User) error {
|
|
if !issue.IsPinned() {
|
|
return issue.Pin(ctx, user)
|
|
}
|
|
|
|
return issue.Unpin(ctx, user)
|
|
}
|
|
|
|
// MovePin moves a Pinned Issue to a new Position
|
|
func (issue *Issue) MovePin(ctx context.Context, newPosition int) error {
|
|
// If the Issue is not pinned, we can't move them
|
|
if !issue.IsPinned() {
|
|
return nil
|
|
}
|
|
|
|
if newPosition < 1 {
|
|
return fmt.Errorf("The Position can't be lower than 1")
|
|
}
|
|
|
|
dbctx, committer, err := db.TxContext(ctx)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer committer.Close()
|
|
|
|
var maxPin int
|
|
_, err = db.GetEngine(dbctx).SQL("SELECT MAX(pin_order) FROM issue WHERE repo_id = ? AND is_pull = ?", issue.RepoID, issue.IsPull).Get(&maxPin)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
// If the new Position bigger than the current Maximum, set it to the Maximum
|
|
if newPosition > maxPin+1 {
|
|
newPosition = maxPin + 1
|
|
}
|
|
|
|
// Lower the Position of all Pinned Issue that came after the current Position
|
|
_, err = db.GetEngine(dbctx).Exec("UPDATE issue SET pin_order = pin_order - 1 WHERE repo_id = ? AND is_pull = ? AND pin_order > ?", issue.RepoID, issue.IsPull, issue.PinOrder)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
// Higher the Position of all Pinned Issues that comes after the new Position
|
|
_, err = db.GetEngine(dbctx).Exec("UPDATE issue SET pin_order = pin_order + 1 WHERE repo_id = ? AND is_pull = ? AND pin_order >= ?", issue.RepoID, issue.IsPull, newPosition)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
_, err = db.GetEngine(dbctx).Table("issue").
|
|
Where("id = ?", issue.ID).
|
|
Update(map[string]any{
|
|
"pin_order": newPosition,
|
|
})
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
return committer.Commit()
|
|
}
|
|
|
|
// GetPinnedIssues returns the pinned Issues for the given Repo and type
|
|
func GetPinnedIssues(ctx context.Context, repoID int64, isPull bool) (IssueList, error) {
|
|
issues := make(IssueList, 0)
|
|
|
|
err := db.GetEngine(ctx).
|
|
Table("issue").
|
|
Where("repo_id = ?", repoID).
|
|
And("is_pull = ?", isPull).
|
|
And("pin_order > 0").
|
|
OrderBy("pin_order").
|
|
Find(&issues)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
err = issues.LoadAttributes(ctx)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return issues, nil
|
|
}
|
|
|
|
// IsNewPinnedAllowed returns if a new Issue or Pull request can be pinned
|
|
func IsNewPinAllowed(ctx context.Context, repoID int64, isPull bool) (bool, error) {
|
|
var maxPin int
|
|
_, err := db.GetEngine(ctx).SQL("SELECT COUNT(pin_order) FROM issue WHERE repo_id = ? AND is_pull = ? AND pin_order > 0", repoID, isPull).Get(&maxPin)
|
|
if err != nil {
|
|
return false, err
|
|
}
|
|
|
|
return maxPin < setting.Repository.Issue.MaxPinned, nil
|
|
}
|
|
|
|
// IsErrIssueMaxPinReached returns if the error is, that the User can't pin more Issues
|
|
func IsErrIssueMaxPinReached(err error) bool {
|
|
return err == ErrIssueMaxPinReached
|
|
}
|
|
|
|
// InsertIssues insert issues to database
|
|
func InsertIssues(ctx context.Context, issues ...*Issue) error {
|
|
ctx, committer, err := db.TxContext(ctx)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer committer.Close()
|
|
|
|
for _, issue := range issues {
|
|
if err := insertIssue(ctx, issue); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
return committer.Commit()
|
|
}
|
|
|
|
func insertIssue(ctx context.Context, issue *Issue) error {
|
|
sess := db.GetEngine(ctx)
|
|
if _, err := sess.NoAutoTime().Insert(issue); err != nil {
|
|
return err
|
|
}
|
|
issueLabels := make([]IssueLabel, 0, len(issue.Labels))
|
|
for _, label := range issue.Labels {
|
|
issueLabels = append(issueLabels, IssueLabel{
|
|
IssueID: issue.ID,
|
|
LabelID: label.ID,
|
|
})
|
|
}
|
|
if len(issueLabels) > 0 {
|
|
if _, err := sess.Insert(issueLabels); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
for _, reaction := range issue.Reactions {
|
|
reaction.IssueID = issue.ID
|
|
}
|
|
|
|
if len(issue.Reactions) > 0 {
|
|
if _, err := sess.Insert(issue.Reactions); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|