gitroast/models/issue.go

1369 lines
35 KiB
Go
Raw Normal View History

2014-03-20 20:04:56 +00:00
// Copyright 2014 The Gogs 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 models
2014-03-22 17:50:50 +00:00
import (
2014-03-22 20:00:46 +00:00
"errors"
"fmt"
"sort"
2014-03-22 17:50:50 +00:00
"strings"
"time"
2016-11-11 12:11:45 +00:00
api "code.gitea.io/sdk/gitea"
2014-07-26 04:24:27 +00:00
"github.com/Unknwon/com"
2016-11-10 15:16:32 +00:00
"github.com/go-xorm/xorm"
2014-05-13 18:49:20 +00:00
"code.gitea.io/gitea/modules/base"
"code.gitea.io/gitea/modules/log"
"code.gitea.io/gitea/modules/setting"
2017-01-25 02:43:02 +00:00
"code.gitea.io/gitea/modules/util"
2014-03-22 17:50:50 +00:00
)
2014-03-22 20:00:46 +00:00
var (
2016-11-22 11:24:39 +00:00
errMissingIssueNumber = errors.New("No issue number specified")
2014-03-22 20:00:46 +00:00
)
2014-03-22 17:50:50 +00:00
// Issue represents an issue or pull request of repository.
2014-03-20 20:04:56 +00:00
type Issue struct {
ID int64 `xorm:"pk autoincr"`
RepoID int64 `xorm:"INDEX UNIQUE(repo_index)"`
2014-03-29 14:24:42 +00:00
Repo *Repository `xorm:"-"`
Index int64 `xorm:"UNIQUE(repo_index)"` // Index in one repository.
2017-01-06 15:14:33 +00:00
PosterID int64 `xorm:"INDEX"`
Poster *User `xorm:"-"`
Title string `xorm:"name"`
Content string `xorm:"TEXT"`
RenderedContent string `xorm:"-"`
Labels []*Label `xorm:"-"`
MilestoneID int64 `xorm:"INDEX"`
Milestone *Milestone `xorm:"-"`
Priority int
2017-01-06 15:14:33 +00:00
AssigneeID int64 `xorm:"INDEX"`
Assignee *User `xorm:"-"`
IsClosed bool `xorm:"INDEX"`
IsRead bool `xorm:"-"`
2017-01-06 15:14:33 +00:00
IsPull bool `xorm:"INDEX"` // Indicates whether is a pull request or not.
PullRequest *PullRequest `xorm:"-"`
2014-03-29 14:24:42 +00:00
NumComments int
Deadline time.Time `xorm:"-"`
2017-01-06 15:14:33 +00:00
DeadlineUnix int64 `xorm:"INDEX"`
Created time.Time `xorm:"-"`
2017-01-06 15:14:33 +00:00
CreatedUnix int64 `xorm:"INDEX"`
Updated time.Time `xorm:"-"`
2017-01-06 15:14:33 +00:00
UpdatedUnix int64 `xorm:"INDEX"`
Attachments []*Attachment `xorm:"-"`
2015-08-13 08:07:11 +00:00
Comments []*Comment `xorm:"-"`
}
2016-11-24 08:41:11 +00:00
// BeforeInsert is invoked from XORM before inserting an object of this type.
2016-08-24 23:05:56 +00:00
func (issue *Issue) BeforeInsert() {
issue.CreatedUnix = time.Now().Unix()
issue.UpdatedUnix = issue.CreatedUnix
}
2016-11-24 08:41:11 +00:00
// BeforeUpdate is invoked from XORM before updating this object.
2016-08-24 23:05:56 +00:00
func (issue *Issue) BeforeUpdate() {
issue.UpdatedUnix = time.Now().Unix()
issue.DeadlineUnix = issue.Deadline.Unix()
}
2016-11-24 08:41:11 +00:00
// AfterSet is invoked from XORM after setting the value of a field of
// this object.
2016-08-24 23:05:56 +00:00
func (issue *Issue) AfterSet(colName string, _ xorm.Cell) {
2015-08-05 12:23:08 +00:00
switch colName {
2016-08-26 20:40:53 +00:00
case "deadline_unix":
issue.Deadline = time.Unix(issue.DeadlineUnix, 0).Local()
case "created_unix":
issue.Created = time.Unix(issue.CreatedUnix, 0).Local()
case "updated_unix":
issue.Updated = time.Unix(issue.UpdatedUnix, 0).Local()
}
}
2015-08-13 08:07:11 +00:00
2016-12-17 11:49:17 +00:00
func (issue *Issue) loadRepo(e Engine) (err error) {
2016-08-26 20:40:53 +00:00
if issue.Repo == nil {
issue.Repo, err = getRepositoryByID(e, issue.RepoID)
if err != nil {
2016-08-26 20:40:53 +00:00
return fmt.Errorf("getRepositoryByID [%d]: %v", issue.RepoID, err)
}
2016-08-26 20:40:53 +00:00
}
2016-12-17 11:49:17 +00:00
return nil
}
// GetPullRequest returns the issue pull request
func (issue *Issue) GetPullRequest() (pr *PullRequest, err error) {
if !issue.IsPull {
return nil, fmt.Errorf("Issue is not a pull request")
}
pr, err = getPullRequestByIssueID(x, issue.ID)
return
}
func (issue *Issue) loadLabels(e Engine) (err error) {
if issue.Labels == nil {
issue.Labels, err = getLabelsByIssueID(e, issue.ID)
if err != nil {
return fmt.Errorf("getLabelsByIssueID [%d]: %v", issue.ID, err)
}
2016-12-17 11:49:17 +00:00
}
return nil
}
func (issue *Issue) loadPoster(e Engine) (err error) {
2016-08-26 20:40:53 +00:00
if issue.Poster == nil {
issue.Poster, err = getUserByID(e, issue.PosterID)
if err != nil {
issue.PosterID = -1
issue.Poster = NewGhostUser()
if !IsErrUserNotExist(err) {
2016-08-26 20:40:53 +00:00
return fmt.Errorf("getUserByID.(poster) [%d]: %v", issue.PosterID, err)
}
2016-11-09 05:07:01 +00:00
err = nil
return
}
2016-08-26 20:40:53 +00:00
}
return
}
func (issue *Issue) loadAttributes(e Engine) (err error) {
if err = issue.loadRepo(e); err != nil {
return
}
if err = issue.loadPoster(e); err != nil {
return
}
if err = issue.loadLabels(e); err != nil {
return
2016-08-26 20:40:53 +00:00
}
2016-08-26 20:40:53 +00:00
if issue.Milestone == nil && issue.MilestoneID > 0 {
issue.Milestone, err = getMilestoneByRepoID(e, issue.RepoID, issue.MilestoneID)
if err != nil {
2016-08-26 20:40:53 +00:00
return fmt.Errorf("getMilestoneByRepoID [repo_id: %d, milestone_id: %d]: %v", issue.RepoID, issue.MilestoneID, err)
}
2015-08-05 12:23:08 +00:00
}
2016-08-26 20:40:53 +00:00
if issue.Assignee == nil && issue.AssigneeID > 0 {
issue.Assignee, err = getUserByID(e, issue.AssigneeID)
if err != nil {
2016-08-26 20:40:53 +00:00
return fmt.Errorf("getUserByID.(assignee) [%d]: %v", issue.AssigneeID, err)
}
}
if issue.IsPull && issue.PullRequest == nil {
// It is possible pull request is not yet created.
issue.PullRequest, err = getPullRequestByIssueID(e, issue.ID)
if err != nil && !IsErrPullRequestNotExist(err) {
return fmt.Errorf("getPullRequestByIssueID [%d]: %v", issue.ID, err)
}
}
2016-08-26 20:40:53 +00:00
if issue.Attachments == nil {
issue.Attachments, err = getAttachmentsByIssueID(e, issue.ID)
if err != nil {
return fmt.Errorf("getAttachmentsByIssueID [%d]: %v", issue.ID, err)
}
}
if issue.Comments == nil {
issue.Comments, err = getCommentsByIssueID(e, issue.ID)
if err != nil {
return fmt.Errorf("getCommentsByIssueID [%d]: %v", issue.ID, err)
}
}
return nil
}
2016-11-24 08:41:11 +00:00
// LoadAttributes loads the attribute of this issue.
func (issue *Issue) LoadAttributes() error {
return issue.loadAttributes(x)
2015-08-19 16:12:43 +00:00
}
// GetIsRead load the `IsRead` field of the issue
func (issue *Issue) GetIsRead(userID int64) error {
issueUser := &IssueUser{IssueID: issue.ID, UID: userID}
if has, err := x.Get(issueUser); err != nil {
return err
} else if !has {
2017-02-09 03:47:24 +00:00
issue.IsRead = false
return nil
}
issue.IsRead = issueUser.IsRead
return nil
}
2016-11-24 08:41:11 +00:00
// 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)
}
2016-12-02 11:10:39 +00:00
// 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.
2016-11-22 11:24:39 +00:00
func (issue *Issue) State() api.StateType {
if issue.IsClosed {
2016-11-29 08:25:47 +00:00
return api.StateClosed
}
2016-11-29 08:25:47 +00:00
return api.StateOpen
}
2016-11-22 11:24:39 +00:00
// APIFormat assumes some fields assigned with values:
// Required - Poster, Labels,
// Optional - Milestone, Assignee, PullRequest
func (issue *Issue) APIFormat() *api.Issue {
apiLabels := make([]*api.Label, len(issue.Labels))
for i := range issue.Labels {
apiLabels[i] = issue.Labels[i].APIFormat()
}
apiIssue := &api.Issue{
ID: issue.ID,
Index: issue.Index,
Poster: issue.Poster.APIFormat(),
Title: issue.Title,
Body: issue.Content,
Labels: apiLabels,
State: issue.State(),
Comments: issue.NumComments,
Created: issue.Created,
Updated: issue.Updated,
}
if issue.Milestone != nil {
apiIssue.Milestone = issue.Milestone.APIFormat()
}
if issue.Assignee != nil {
apiIssue.Assignee = issue.Assignee.APIFormat()
}
if issue.IsPull {
apiIssue.PullRequest = &api.PullRequestMeta{
HasMerged: issue.PullRequest.HasMerged,
}
if issue.PullRequest.HasMerged {
apiIssue.PullRequest.Merged = &issue.PullRequest.Merged
}
}
return apiIssue
}
// HashTag returns unique hash tag for issue.
2016-11-22 11:24:39 +00:00
func (issue *Issue) HashTag() string {
return "issue-" + com.ToStr(issue.ID)
}
2015-08-13 08:07:11 +00:00
// IsPoster returns true if given user by ID is the poster.
2016-11-22 11:24:39 +00:00
func (issue *Issue) IsPoster(uid int64) bool {
return issue.PosterID == uid
2015-08-13 08:07:11 +00:00
}
2016-11-22 11:24:39 +00:00
func (issue *Issue) hasLabel(e Engine, labelID int64) bool {
return hasIssueLabel(e, issue.ID, labelID)
}
// HasLabel returns true if issue has been labeled by given ID.
2016-11-22 11:24:39 +00:00
func (issue *Issue) HasLabel(labelID int64) bool {
return issue.hasLabel(x, labelID)
}
func (issue *Issue) sendLabelUpdatedWebhook(doer *User) {
var err error
if issue.IsPull {
err = issue.PullRequest.LoadIssue()
if err != nil {
log.Error(4, "LoadIssue: %v", err)
return
}
err = PrepareWebhooks(issue.Repo, HookEventPullRequest, &api.PullRequestPayload{
Action: api.HookIssueLabelUpdated,
Index: issue.Index,
PullRequest: issue.PullRequest.APIFormat(),
Repository: issue.Repo.APIFormat(AccessModeNone),
Sender: doer.APIFormat(),
})
}
if err != nil {
log.Error(4, "PrepareWebhooks [is_pull: %v]: %v", issue.IsPull, err)
} else {
go HookQueue.Add(issue.RepoID)
}
}
func (issue *Issue) addLabel(e *xorm.Session, label *Label, doer *User) error {
return newIssueLabel(e, issue, label, doer)
}
// AddLabel adds a new label to the issue.
func (issue *Issue) AddLabel(doer *User, label *Label) error {
if err := NewIssueLabel(issue, label, doer); err != nil {
return err
}
issue.sendLabelUpdatedWebhook(doer)
return nil
}
func (issue *Issue) addLabels(e *xorm.Session, labels []*Label, doer *User) error {
return newIssueLabels(e, issue, labels, doer)
}
// AddLabels adds a list of new labels to the issue.
func (issue *Issue) AddLabels(doer *User, labels []*Label) error {
if err := NewIssueLabels(issue, labels, doer); err != nil {
return err
}
issue.sendLabelUpdatedWebhook(doer)
return nil
}
func (issue *Issue) getLabels(e Engine) (err error) {
if len(issue.Labels) > 0 {
2014-05-24 06:31:58 +00:00
return nil
}
issue.Labels, err = getLabelsByIssueID(e, issue.ID)
if err != nil {
return fmt.Errorf("getLabelsByIssueID: %v", err)
2014-05-24 06:31:58 +00:00
}
return nil
}
func (issue *Issue) removeLabel(e *xorm.Session, doer *User, label *Label) error {
return deleteIssueLabel(e, issue, label, doer)
}
// RemoveLabel removes a label from issue by given ID.
func (issue *Issue) RemoveLabel(doer *User, label *Label) error {
2016-12-17 11:49:17 +00:00
if err := issue.loadRepo(x); err != nil {
return err
}
if has, err := HasAccess(doer, issue.Repo, AccessModeWrite); err != nil {
return err
} else if !has {
return ErrLabelNotExist{}
}
if err := DeleteIssueLabel(issue, label, doer); err != nil {
return err
}
issue.sendLabelUpdatedWebhook(doer)
return nil
}
func (issue *Issue) clearLabels(e *xorm.Session, doer *User) (err error) {
if err = issue.getLabels(e); err != nil {
return fmt.Errorf("getLabels: %v", err)
}
for i := range issue.Labels {
if err = issue.removeLabel(e, doer, issue.Labels[i]); err != nil {
return fmt.Errorf("removeLabel: %v", err)
}
}
return nil
}
2016-11-24 08:41:11 +00:00
// ClearLabels removes all issue labels as the given user.
// Triggers appropriate WebHooks, if any.
func (issue *Issue) ClearLabels(doer *User) (err error) {
sess := x.NewSession()
defer sessionRelease(sess)
if err = sess.Begin(); err != nil {
return err
}
2016-12-17 11:49:17 +00:00
if err := issue.loadRepo(sess); err != nil {
return err
}
if has, err := hasAccess(sess, doer, issue.Repo, AccessModeWrite); err != nil {
return err
} else if !has {
return ErrLabelNotExist{}
}
if err = issue.clearLabels(sess, doer); err != nil {
return err
}
if err = sess.Commit(); err != nil {
return fmt.Errorf("Commit: %v", err)
}
if issue.IsPull {
err = issue.PullRequest.LoadIssue()
if err != nil {
log.Error(4, "LoadIssue: %v", err)
return
}
err = PrepareWebhooks(issue.Repo, HookEventPullRequest, &api.PullRequestPayload{
Action: api.HookIssueLabelCleared,
Index: issue.Index,
PullRequest: issue.PullRequest.APIFormat(),
Repository: issue.Repo.APIFormat(AccessModeNone),
Sender: doer.APIFormat(),
})
}
if err != nil {
log.Error(4, "PrepareWebhooks [is_pull: %v]: %v", issue.IsPull, err)
} else {
go HookQueue.Add(issue.RepoID)
}
return nil
}
type labelSorter []*Label
func (ts labelSorter) Len() int {
return len([]*Label(ts))
}
func (ts labelSorter) Less(i, j int) bool {
return []*Label(ts)[i].ID < []*Label(ts)[j].ID
}
func (ts labelSorter) Swap(i, j int) {
[]*Label(ts)[i], []*Label(ts)[j] = []*Label(ts)[j], []*Label(ts)[i]
}
// ReplaceLabels removes all current labels and add new labels to the issue.
2016-11-24 08:41:11 +00:00
// Triggers appropriate WebHooks, if any.
func (issue *Issue) ReplaceLabels(labels []*Label, doer *User) (err error) {
sess := x.NewSession()
defer sessionRelease(sess)
if err = sess.Begin(); err != nil {
return err
}
if err = issue.loadLabels(sess); err != nil {
return err
}
sort.Sort(labelSorter(labels))
sort.Sort(labelSorter(issue.Labels))
var toAdd, toRemove []*Label
for _, l := range labels {
var exist bool
for _, oriLabel := range issue.Labels {
if oriLabel.ID == l.ID {
exist = true
break
}
}
if !exist {
toAdd = append(toAdd, l)
}
}
for _, oriLabel := range issue.Labels {
var exist bool
for _, l := range labels {
if oriLabel.ID == l.ID {
exist = true
break
}
}
if !exist {
toRemove = append(toRemove, oriLabel)
}
}
if len(toAdd) > 0 {
if err = issue.addLabels(sess, toAdd, doer); err != nil {
return fmt.Errorf("addLabels: %v", err)
}
}
if len(toRemove) > 0 {
for _, l := range toRemove {
if err = issue.removeLabel(sess, doer, l); err != nil {
return fmt.Errorf("removeLabel: %v", err)
}
}
}
return sess.Commit()
}
2016-11-24 08:41:11 +00:00
// GetAssignee sets the Assignee attribute of this issue.
2016-11-22 11:24:39 +00:00
func (issue *Issue) GetAssignee() (err error) {
if issue.AssigneeID == 0 || issue.Assignee != nil {
2014-05-08 16:24:11 +00:00
return nil
}
2016-11-22 11:24:39 +00:00
issue.Assignee, err = GetUserByID(issue.AssigneeID)
2015-08-05 03:14:17 +00:00
if IsErrUserNotExist(err) {
2014-05-24 06:31:58 +00:00
return nil
}
2014-05-08 16:24:11 +00:00
return err
}
2015-08-12 10:44:09 +00:00
// ReadBy sets issue to be read by given user.
func (issue *Issue) ReadBy(userID int64) error {
if err := UpdateIssueUserByRead(userID, issue.ID); err != nil {
return err
}
if err := setNotificationStatusReadIfUnread(x, userID, issue.ID); err != nil {
return err
}
return nil
2014-07-23 19:15:47 +00:00
}
func updateIssueCols(e Engine, issue *Issue, cols ...string) error {
2017-01-25 02:43:02 +00:00
if _, err := e.Id(issue.ID).Cols(cols...).Update(issue); err != nil {
return err
}
UpdateIssueIndexer(issue)
return nil
}
// UpdateIssueCols only updates values of specific columns for given issue.
func UpdateIssueCols(issue *Issue, cols ...string) error {
return updateIssueCols(x, issue, cols...)
}
2016-11-22 11:24:39 +00:00
func (issue *Issue) changeStatus(e *xorm.Session, doer *User, repo *Repository, isClosed bool) (err error) {
// Nothing should be performed if current status is same as target status
2016-11-22 11:24:39 +00:00
if issue.IsClosed == isClosed {
2015-08-13 08:07:11 +00:00
return nil
}
2016-11-22 11:24:39 +00:00
issue.IsClosed = isClosed
2015-08-13 08:07:11 +00:00
2016-11-22 11:24:39 +00:00
if err = updateIssueCols(e, issue, "is_closed"); err != nil {
2015-08-13 08:07:11 +00:00
return err
}
// Update issue count of labels
2016-11-22 11:24:39 +00:00
if err = issue.getLabels(e); err != nil {
2015-08-13 08:07:11 +00:00
return err
}
2016-11-22 11:24:39 +00:00
for idx := range issue.Labels {
if issue.IsClosed {
issue.Labels[idx].NumClosedIssues++
2015-08-13 08:07:11 +00:00
} else {
2016-11-22 11:24:39 +00:00
issue.Labels[idx].NumClosedIssues--
2015-08-13 08:07:11 +00:00
}
2016-11-22 11:24:39 +00:00
if err = updateLabel(e, issue.Labels[idx]); err != nil {
2015-08-13 08:07:11 +00:00
return err
}
}
// Update issue count of milestone
2016-11-22 11:24:39 +00:00
if err = changeMilestoneIssueStats(e, issue); err != nil {
2015-08-13 08:07:11 +00:00
return err
}
// New action comment
2016-11-22 11:24:39 +00:00
if _, err = createStatusComment(e, doer, repo, issue); err != nil {
2015-08-13 08:07:11 +00:00
return err
}
return nil
}
// ChangeStatus changes issue status to open or closed.
func (issue *Issue) ChangeStatus(doer *User, repo *Repository, isClosed bool) (err error) {
2015-08-13 08:07:11 +00:00
sess := x.NewSession()
defer sessionRelease(sess)
if err = sess.Begin(); err != nil {
return err
}
if err = issue.changeStatus(sess, doer, repo, isClosed); err != nil {
2015-08-13 08:07:11 +00:00
return err
}
if err = sess.Commit(); err != nil {
return fmt.Errorf("Commit: %v", err)
}
if issue.IsPull {
// Merge pull request calls issue.changeStatus so we need to handle separately.
issue.PullRequest.Issue = issue
apiPullRequest := &api.PullRequestPayload{
Index: issue.Index,
PullRequest: issue.PullRequest.APIFormat(),
Repository: repo.APIFormat(AccessModeNone),
Sender: doer.APIFormat(),
}
if isClosed {
apiPullRequest.Action = api.HookIssueClosed
} else {
2016-11-29 08:25:47 +00:00
apiPullRequest.Action = api.HookIssueReOpened
}
err = PrepareWebhooks(repo, HookEventPullRequest, apiPullRequest)
}
if err != nil {
log.Error(4, "PrepareWebhooks [is_pull: %v, is_closed: %v]: %v", issue.IsPull, isClosed, err)
} else {
go HookQueue.Add(repo.ID)
}
return nil
}
2016-11-24 08:41:11 +00:00
// ChangeTitle changes the title of this issue, as the given user.
func (issue *Issue) ChangeTitle(doer *User, title string) (err error) {
oldTitle := issue.Title
issue.Title = title
2017-02-05 14:36:00 +00:00
sess := x.NewSession()
defer sess.Close()
if err = sess.Begin(); err != nil {
return err
}
if err = updateIssueCols(sess, issue, "name"); err != nil {
return fmt.Errorf("updateIssueCols: %v", err)
}
if _, err = createChangeTitleComment(sess, doer, issue.Repo, issue, oldTitle, title); err != nil {
return fmt.Errorf("createChangeTitleComment: %v", err)
}
if err = sess.Commit(); err != nil {
return err
}
if issue.IsPull {
issue.PullRequest.Issue = issue
err = PrepareWebhooks(issue.Repo, HookEventPullRequest, &api.PullRequestPayload{
Action: api.HookIssueEdited,
Index: issue.Index,
Changes: &api.ChangesPayload{
Title: &api.ChangesFromPayload{
From: oldTitle,
},
},
PullRequest: issue.PullRequest.APIFormat(),
Repository: issue.Repo.APIFormat(AccessModeNone),
Sender: doer.APIFormat(),
})
}
if err != nil {
log.Error(4, "PrepareWebhooks [is_pull: %v]: %v", issue.IsPull, err)
} else {
go HookQueue.Add(issue.RepoID)
}
return nil
2015-08-13 08:07:11 +00:00
}
// AddDeletePRBranchComment adds delete branch comment for pull request issue
func AddDeletePRBranchComment(doer *User, repo *Repository, issueID int64, branchName string) error {
issue, err := getIssueByID(x, issueID)
if err != nil {
return err
}
sess := x.NewSession()
defer sess.Close()
if err := sess.Begin(); err != nil {
return err
}
if _, err := createDeleteBranchComment(sess, doer, repo, issue, branchName); err != nil {
return err
}
return sess.Commit()
}
2016-11-24 08:41:11 +00:00
// ChangeContent changes issue content, as the given user.
func (issue *Issue) ChangeContent(doer *User, content string) (err error) {
oldContent := issue.Content
issue.Content = content
if err = UpdateIssueCols(issue, "content"); err != nil {
return fmt.Errorf("UpdateIssueCols: %v", err)
}
if issue.IsPull {
issue.PullRequest.Issue = issue
err = PrepareWebhooks(issue.Repo, HookEventPullRequest, &api.PullRequestPayload{
Action: api.HookIssueEdited,
Index: issue.Index,
Changes: &api.ChangesPayload{
Body: &api.ChangesFromPayload{
From: oldContent,
},
},
PullRequest: issue.PullRequest.APIFormat(),
Repository: issue.Repo.APIFormat(AccessModeNone),
Sender: doer.APIFormat(),
})
}
if err != nil {
log.Error(4, "PrepareWebhooks [is_pull: %v]: %v", issue.IsPull, err)
} else {
go HookQueue.Add(issue.RepoID)
}
return nil
}
2016-11-24 08:41:11 +00:00
// ChangeAssignee changes the Asssignee field of this issue.
func (issue *Issue) ChangeAssignee(doer *User, assigneeID int64) (err error) {
var oldAssigneeID = issue.AssigneeID
issue.AssigneeID = assigneeID
if err = UpdateIssueUserByAssignee(issue); err != nil {
return fmt.Errorf("UpdateIssueUserByAssignee: %v", err)
}
sess := x.NewSession()
defer sess.Close()
if err = issue.loadRepo(sess); err != nil {
return fmt.Errorf("loadRepo: %v", err)
}
if _, err = createAssigneeComment(sess, doer, issue.Repo, issue, oldAssigneeID, assigneeID); err != nil {
return fmt.Errorf("createAssigneeComment: %v", err)
}
issue.Assignee, err = GetUserByID(issue.AssigneeID)
if err != nil && !IsErrUserNotExist(err) {
log.Error(4, "GetUserByID [assignee_id: %v]: %v", issue.AssigneeID, err)
2015-10-25 07:10:22 +00:00
return nil
}
// Error not nil here means user does not exist, which is remove assignee.
isRemoveAssignee := err != nil
if issue.IsPull {
issue.PullRequest.Issue = issue
apiPullRequest := &api.PullRequestPayload{
Index: issue.Index,
PullRequest: issue.PullRequest.APIFormat(),
Repository: issue.Repo.APIFormat(AccessModeNone),
Sender: doer.APIFormat(),
}
if isRemoveAssignee {
apiPullRequest.Action = api.HookIssueUnassigned
} else {
apiPullRequest.Action = api.HookIssueAssigned
}
if err := PrepareWebhooks(issue.Repo, HookEventPullRequest, apiPullRequest); err != nil {
log.Error(4, "PrepareWebhooks [is_pull: %v, remove_assignee: %v]: %v", issue.IsPull, isRemoveAssignee, err)
return nil
}
}
go HookQueue.Add(issue.RepoID)
return nil
2015-10-25 07:10:22 +00:00
}
2016-11-24 08:41:11 +00:00
// NewIssueOptions represents the options of a new issue.
type NewIssueOptions struct {
Repo *Repository
Issue *Issue
LableIDs []int64
Attachments []string // In UUID format.
IsPull bool
}
func newIssue(e *xorm.Session, doer *User, opts NewIssueOptions) (err error) {
opts.Issue.Title = strings.TrimSpace(opts.Issue.Title)
opts.Issue.Index = opts.Repo.NextIssueIndex()
if opts.Issue.MilestoneID > 0 {
2016-08-24 23:05:56 +00:00
milestone, err := getMilestoneByRepoID(e, opts.Issue.RepoID, opts.Issue.MilestoneID)
if err != nil && !IsErrMilestoneNotExist(err) {
return fmt.Errorf("getMilestoneByID: %v", err)
}
// Assume milestone is invalid and drop silently.
opts.Issue.MilestoneID = 0
if milestone != nil {
opts.Issue.MilestoneID = milestone.ID
opts.Issue.Milestone = milestone
}
}
if opts.Issue.AssigneeID > 0 {
assignee, err := getUserByID(e, opts.Issue.AssigneeID)
if err != nil && !IsErrUserNotExist(err) {
return fmt.Errorf("getUserByID: %v", err)
}
// Assume assignee is invalid and drop silently.
opts.Issue.AssigneeID = 0
if assignee != nil {
2016-11-07 16:20:37 +00:00
valid, err := hasAccess(e, assignee, opts.Repo, AccessModeWrite)
if err != nil {
return fmt.Errorf("hasAccess [user_id: %d, repo_id: %d]: %v", assignee.ID, opts.Repo.ID, err)
}
if valid {
opts.Issue.AssigneeID = assignee.ID
opts.Issue.Assignee = assignee
}
}
}
// Milestone and assignee validation should happen before insert actual object.
if _, err = e.Insert(opts.Issue); err != nil {
2014-05-07 16:09:30 +00:00
return err
2015-09-02 20:18:09 +00:00
}
if opts.Issue.MilestoneID > 0 {
if err = changeMilestoneAssign(e, doer, opts.Issue, -1); err != nil {
return err
}
}
if opts.Issue.AssigneeID > 0 {
if err = opts.Issue.loadRepo(e); err != nil {
return err
}
if _, err = createAssigneeComment(e, doer, opts.Issue.Repo, opts.Issue, -1, opts.Issue.AssigneeID); err != nil {
return err
}
}
if opts.IsPull {
_, err = e.Exec("UPDATE `repository` SET num_pulls = num_pulls + 1 WHERE id = ?", opts.Issue.RepoID)
2015-09-02 20:18:09 +00:00
} else {
_, err = e.Exec("UPDATE `repository` SET num_issues = num_issues + 1 WHERE id = ?", opts.Issue.RepoID)
2015-09-02 20:18:09 +00:00
}
if err != nil {
2014-05-07 16:09:30 +00:00
return err
2014-03-27 16:48:29 +00:00
}
if len(opts.LableIDs) > 0 {
2016-11-21 19:08:21 +00:00
// During the session, SQLite3 driver cannot handle retrieve objects after update something.
// So we have to get all needed labels first.
labels := make([]*Label, 0, len(opts.LableIDs))
if err = e.In("id", opts.LableIDs).Find(&labels); err != nil {
return fmt.Errorf("find all labels [label_ids: %v]: %v", opts.LableIDs, err)
}
if err = opts.Issue.loadPoster(e); err != nil {
return err
}
for _, label := range labels {
// Silently drop invalid labels.
if label.RepoID != opts.Repo.ID {
continue
}
if err = opts.Issue.addLabel(e, label, opts.Issue.Poster); err != nil {
return fmt.Errorf("addLabel [id: %d]: %v", label.ID, err)
}
2015-08-10 08:52:08 +00:00
}
}
if err = newIssueUsers(e, opts.Repo, opts.Issue); err != nil {
return err
}
2017-01-25 02:43:02 +00:00
UpdateIssueIndexer(opts.Issue)
if len(opts.Attachments) > 0 {
attachments, err := getAttachmentsByUUIDs(e, opts.Attachments)
2015-09-01 23:07:02 +00:00
if err != nil {
return fmt.Errorf("getAttachmentsByUUIDs [uuids: %v]: %v", opts.Attachments, err)
2015-09-01 23:07:02 +00:00
}
for i := 0; i < len(attachments); i++ {
attachments[i].IssueID = opts.Issue.ID
if _, err = e.Id(attachments[i].ID).Update(attachments[i]); err != nil {
return fmt.Errorf("update attachment [id: %d]: %v", attachments[i].ID, err)
}
2015-08-11 15:24:40 +00:00
}
}
return opts.Issue.loadAttributes(e)
2015-09-01 23:07:02 +00:00
}
// NewIssue creates new issue with labels for repository.
func NewIssue(repo *Repository, issue *Issue, labelIDs []int64, uuids []string) (err error) {
sess := x.NewSession()
defer sessionRelease(sess)
if err = sess.Begin(); err != nil {
return err
}
if err = newIssue(sess, issue.Poster, NewIssueOptions{
Repo: repo,
Issue: issue,
LableIDs: labelIDs,
Attachments: uuids,
}); err != nil {
2015-09-01 23:07:02 +00:00
return fmt.Errorf("newIssue: %v", err)
}
if err = sess.Commit(); err != nil {
return fmt.Errorf("Commit: %v", err)
}
if err = NotifyWatchers(&Action{
2016-07-23 17:08:22 +00:00
ActUserID: issue.Poster.ID,
2015-08-10 15:31:59 +00:00
ActUserName: issue.Poster.Name,
OpType: ActionCreateIssue,
Content: fmt.Sprintf("%d|%s", issue.Index, issue.Title),
2015-08-10 15:31:59 +00:00
RepoID: repo.ID,
RepoUserName: repo.Owner.Name,
RepoName: repo.Name,
IsPrivate: repo.IsPrivate,
}); err != nil {
log.Error(4, "NotifyWatchers: %v", err)
}
if err = issue.MailParticipants(); err != nil {
log.Error(4, "MailParticipants: %v", err)
2015-08-10 15:31:59 +00:00
}
return nil
2014-03-20 20:04:56 +00:00
}
// GetIssueByRef returns an Issue specified by a GFM reference.
// See https://help.github.com/articles/writing-on-github#references for more information on the syntax.
func GetIssueByRef(ref string) (*Issue, error) {
n := strings.IndexByte(ref, byte('#'))
if n == -1 {
2016-11-22 11:24:39 +00:00
return nil, errMissingIssueNumber
}
index, err := com.StrTo(ref[n+1:]).Int64()
if err != nil {
return nil, err
}
repo, err := GetRepositoryByRef(ref[:n])
if err != nil {
return nil, err
}
issue, err := GetIssueByIndex(repo.ID, index)
if err != nil {
return nil, err
}
return issue, issue.LoadAttributes()
}
2016-11-22 11:24:39 +00:00
// GetRawIssueByIndex returns raw issue without loading attributes by index in a repository.
2016-08-26 20:40:53 +00:00
func GetRawIssueByIndex(repoID, index int64) (*Issue, error) {
issue := &Issue{
RepoID: repoID,
Index: index,
}
2014-06-21 04:51:41 +00:00
has, err := x.Get(issue)
2014-03-22 20:00:46 +00:00
if err != nil {
return nil, err
} else if !has {
return nil, ErrIssueNotExist{0, repoID, index}
2014-03-22 20:00:46 +00:00
}
2016-08-26 20:40:53 +00:00
return issue, nil
}
// GetIssueByIndex returns issue by index in a repository.
func GetIssueByIndex(repoID, index int64) (*Issue, error) {
issue, err := GetRawIssueByIndex(repoID, index)
if err != nil {
return nil, err
}
return issue, issue.LoadAttributes()
2014-03-22 20:00:46 +00:00
}
func getIssueByID(e Engine, id int64) (*Issue, error) {
issue := new(Issue)
has, err := e.Id(id).Get(issue)
if err != nil {
return nil, err
} else if !has {
return nil, ErrIssueNotExist{id, 0, 0}
}
return issue, issue.LoadAttributes()
}
// GetIssueByID returns an issue by given ID.
func GetIssueByID(id int64) (*Issue, error) {
return getIssueByID(x, id)
}
2016-11-24 08:41:11 +00:00
// IssuesOptions represents options of an issue.
2015-09-02 20:18:09 +00:00
type IssuesOptions struct {
RepoID int64
AssigneeID int64
2015-09-02 20:18:09 +00:00
PosterID int64
MentionedID int64
2015-09-02 20:18:09 +00:00
MilestoneID int64
RepoIDs []int64
Page int
2017-01-25 02:43:02 +00:00
IsClosed util.OptionalBool
IsPull util.OptionalBool
2015-09-02 20:18:09 +00:00
Labels string
SortType string
2017-01-25 02:43:02 +00:00
IssueIDs []int64
2015-09-02 20:18:09 +00:00
}
2017-01-01 18:15:09 +00:00
// sortIssuesSession sort an issues-related session based on the provided
// sortType string
func sortIssuesSession(sess *xorm.Session, sortType string) {
switch sortType {
case "oldest":
sess.Asc("issue.created_unix")
case "recentupdate":
sess.Desc("issue.updated_unix")
case "leastupdate":
sess.Asc("issue.updated_unix")
case "mostcomment":
sess.Desc("issue.num_comments")
case "leastcomment":
sess.Asc("issue.num_comments")
case "priority":
sess.Desc("issue.priority")
default:
sess.Desc("issue.created_unix")
}
}
2015-08-04 14:24:04 +00:00
// Issues returns a list of issues by given conditions.
2015-09-02 20:18:09 +00:00
func Issues(opts *IssuesOptions) ([]*Issue, error) {
2017-01-25 02:43:02 +00:00
var sess *xorm.Session
if opts.Page >= 0 {
var start int
if opts.Page == 0 {
start = 0
} else {
start = (opts.Page - 1) * setting.UI.IssuePagingNum
}
sess = x.Limit(setting.UI.IssuePagingNum, start)
} else {
sess = x.NewSession()
defer sess.Close()
}
2017-01-25 02:43:02 +00:00
if len(opts.IssueIDs) > 0 {
sess.In("issue.id", opts.IssueIDs)
}
2014-03-22 20:00:46 +00:00
2015-09-02 20:18:09 +00:00
if opts.RepoID > 0 {
2016-11-12 12:06:33 +00:00
sess.And("issue.repo_id=?", opts.RepoID)
} else if len(opts.RepoIDs) > 0 {
// In case repository IDs are provided but actually no repository has issue.
2016-11-12 12:06:33 +00:00
sess.In("issue.repo_id", opts.RepoIDs)
2014-03-22 20:00:46 +00:00
}
2017-01-25 02:43:02 +00:00
switch opts.IsClosed {
case util.OptionalBoolTrue:
sess.And("issue.is_closed=?", true)
2017-01-25 02:43:02 +00:00
case util.OptionalBoolFalse:
sess.And("issue.is_closed=?", false)
2017-01-25 02:43:02 +00:00
}
2014-03-22 20:00:46 +00:00
2015-09-02 20:18:09 +00:00
if opts.AssigneeID > 0 {
sess.And("issue.assignee_id=?", opts.AssigneeID)
}
if opts.PosterID > 0 {
sess.And("issue.poster_id=?", opts.PosterID)
2014-03-22 17:50:50 +00:00
}
if opts.MentionedID > 0 {
sess.Join("INNER", "issue_user", "issue.id = issue_user.issue_id").
And("issue_user.is_mentioned = ?", true).
And("issue_user.uid = ?", opts.MentionedID)
}
2015-09-02 20:18:09 +00:00
if opts.MilestoneID > 0 {
sess.And("issue.milestone_id=?", opts.MilestoneID)
2014-03-22 17:50:50 +00:00
}
2017-01-25 02:43:02 +00:00
switch opts.IsPull {
case util.OptionalBoolTrue:
sess.And("issue.is_pull=?", true)
2017-01-25 02:43:02 +00:00
case util.OptionalBoolFalse:
sess.And("issue.is_pull=?", false)
2017-01-25 02:43:02 +00:00
}
2015-09-02 20:18:09 +00:00
2017-01-01 18:15:09 +00:00
sortIssuesSession(sess, opts.SortType)
2014-03-22 17:50:50 +00:00
if len(opts.Labels) > 0 && opts.Labels != "0" {
labelIDs, err := base.StringsToInt64s(strings.Split(opts.Labels, ","))
if err != nil {
return nil, err
}
if len(labelIDs) > 0 {
2016-11-10 15:16:32 +00:00
sess.
Join("INNER", "issue_label", "issue.id = issue_label.issue_id").
In("issue_label.label_id", labelIDs)
2016-04-26 04:22:03 +00:00
}
}
2016-07-23 16:23:54 +00:00
issues := make([]*Issue, 0, setting.UI.IssuePagingNum)
2016-08-26 20:40:53 +00:00
if err := sess.Find(&issues); err != nil {
return nil, fmt.Errorf("Find: %v", err)
}
// FIXME: use IssueList to improve performance.
for i := range issues {
if err := issues[i].LoadAttributes(); err != nil {
return nil, fmt.Errorf("LoadAttributes [%d]: %v", issues[i].ID, err)
}
}
return issues, nil
2014-03-22 17:50:50 +00:00
}
// UpdateIssueMentions extracts mentioned people from content and
// updates issue-user relations for them.
func UpdateIssueMentions(e Engine, issueID int64, mentions []string) error {
if len(mentions) == 0 {
return nil
}
for i := range mentions {
mentions[i] = strings.ToLower(mentions[i])
}
users := make([]*User, 0, len(mentions))
if err := e.In("lower_name", mentions).Asc("lower_name").Find(&users); err != nil {
return fmt.Errorf("find mentioned users: %v", err)
}
ids := make([]int64, 0, len(mentions))
for _, user := range users {
2016-07-23 17:08:22 +00:00
ids = append(ids, user.ID)
if !user.IsOrganization() || user.NumMembers == 0 {
continue
}
memberIDs := make([]int64, 0, user.NumMembers)
2016-07-23 17:08:22 +00:00
orgUsers, err := GetOrgUsersByOrgID(user.ID)
if err != nil {
2016-07-23 17:08:22 +00:00
return fmt.Errorf("GetOrgUsersByOrgID [%d]: %v", user.ID, err)
}
for _, orgUser := range orgUsers {
memberIDs = append(memberIDs, orgUser.ID)
}
ids = append(ids, memberIDs...)
}
if err := UpdateIssueUsersByMentions(e, issueID, ids); err != nil {
return fmt.Errorf("UpdateIssueUsersByMentions: %v", err)
}
return nil
}
2014-05-07 16:09:30 +00:00
// IssueStats represents issue statistic information.
type IssueStats struct {
OpenCount, ClosedCount int64
AllCount int64
AssignCount int64
CreateCount int64
MentionCount int64
}
// Filter modes.
const (
2016-11-07 16:24:59 +00:00
FilterModeAll = iota
FilterModeAssign
FilterModeCreate
FilterModeMention
2014-05-07 16:09:30 +00:00
)
func parseCountResult(results []map[string][]byte) int64 {
if len(results) == 0 {
return 0
}
for _, result := range results[0] {
return com.StrTo(string(result)).MustInt64()
}
return 0
}
2016-11-24 08:41:11 +00:00
// IssueStatsOptions contains parameters accepted by GetIssueStats.
2015-09-02 20:18:09 +00:00
type IssueStatsOptions struct {
RepoID int64
Labels string
2015-09-02 20:18:09 +00:00
MilestoneID int64
AssigneeID int64
MentionedID int64
PosterID int64
2015-09-02 20:18:09 +00:00
IsPull bool
2017-01-25 02:43:02 +00:00
IssueIDs []int64
2015-09-02 20:18:09 +00:00
}
// GetIssueStats returns issue statistic information by given conditions.
2017-01-25 02:43:02 +00:00
func GetIssueStats(opts *IssueStatsOptions) (*IssueStats, error) {
2014-05-07 16:09:30 +00:00
stats := &IssueStats{}
2015-07-24 18:52:25 +00:00
countSession := func(opts *IssueStatsOptions) *xorm.Session {
2016-11-10 15:16:32 +00:00
sess := x.
Where("issue.repo_id = ?", opts.RepoID).
And("is_pull = ?", opts.IsPull)
2017-01-25 02:43:02 +00:00
if len(opts.IssueIDs) > 0 {
sess.In("issue.id", opts.IssueIDs)
}
if len(opts.Labels) > 0 && opts.Labels != "0" {
labelIDs, err := base.StringsToInt64s(strings.Split(opts.Labels, ","))
if err != nil {
log.Warn("Malformed Labels argument: %s", opts.Labels)
} else if len(labelIDs) > 0 {
sess.Join("INNER", "issue_label", "issue.id = issue_id").
2016-11-10 15:16:32 +00:00
In("label_id", labelIDs)
2016-04-26 04:22:03 +00:00
}
}
if opts.MilestoneID > 0 {
sess.And("issue.milestone_id = ?", opts.MilestoneID)
}
if opts.AssigneeID > 0 {
sess.And("assignee_id = ?", opts.AssigneeID)
}
if opts.PosterID > 0 {
sess.And("poster_id = ?", opts.PosterID)
}
2015-07-24 18:52:25 +00:00
if opts.MentionedID > 0 {
sess.Join("INNER", "issue_user", "issue.id = issue_user.issue_id").
And("issue_user.uid = ?", opts.MentionedID).
And("issue_user.is_mentioned = ?", true)
}
return sess
2015-07-24 18:52:25 +00:00
}
2017-01-25 02:43:02 +00:00
var err error
stats.OpenCount, err = countSession(opts).
And("is_closed = ?", false).
Count(&Issue{})
2017-01-25 02:43:02 +00:00
if err != nil {
return nil, err
}
stats.ClosedCount, err = countSession(opts).
And("is_closed = ?", true).
Count(&Issue{})
2017-01-25 02:43:02 +00:00
if err != nil {
return nil, err
}
return stats, nil
2014-05-07 16:09:30 +00:00
}
// GetUserIssueStats returns issue statistic information for dashboard by given conditions.
2015-09-02 20:18:09 +00:00
func GetUserIssueStats(repoID, uid int64, repoIDs []int64, filterMode int, isPull bool) *IssueStats {
2014-05-07 16:09:30 +00:00
stats := &IssueStats{}
2015-08-25 14:58:34 +00:00
countSession := func(isClosed, isPull bool, repoID int64, repoIDs []int64) *xorm.Session {
2016-11-10 15:16:32 +00:00
sess := x.
Where("issue.is_closed = ?", isClosed).
And("issue.is_pull = ?", isPull)
2015-09-02 20:18:09 +00:00
2016-11-12 12:06:33 +00:00
if repoID > 0 {
2016-04-26 04:22:03 +00:00
sess.And("repo_id = ?", repoID)
2016-11-12 12:06:33 +00:00
} else if len(repoIDs) > 0 {
2016-04-26 04:22:03 +00:00
sess.In("repo_id", repoIDs)
}
return sess
2015-09-02 20:18:09 +00:00
}
stats.AssignCount, _ = countSession(false, isPull, repoID, repoIDs).
And("assignee_id = ?", uid).
Count(&Issue{})
stats.CreateCount, _ = countSession(false, isPull, repoID, repoIDs).
And("poster_id = ?", uid).
Count(&Issue{})
openCountSession := countSession(false, isPull, repoID, repoIDs)
closedCountSession := countSession(true, isPull, repoID, repoIDs)
2015-09-02 20:18:09 +00:00
2015-08-25 14:58:34 +00:00
switch filterMode {
2016-11-07 16:24:59 +00:00
case FilterModeAssign:
openCountSession.And("assignee_id = ?", uid)
closedCountSession.And("assignee_id = ?", uid)
2016-11-07 16:24:59 +00:00
case FilterModeCreate:
openCountSession.And("poster_id = ?", uid)
closedCountSession.And("poster_id = ?", uid)
2015-08-25 14:58:34 +00:00
}
stats.OpenCount, _ = openCountSession.Count(&Issue{})
stats.ClosedCount, _ = closedCountSession.Count(&Issue{})
2014-05-07 16:09:30 +00:00
return stats
}
2015-08-25 14:58:34 +00:00
// GetRepoIssueStats returns number of open and closed repository issues by given filter mode.
2015-09-02 20:18:09 +00:00
func GetRepoIssueStats(repoID, uid int64, filterMode int, isPull bool) (numOpen int64, numClosed int64) {
countSession := func(isClosed, isPull bool, repoID int64) *xorm.Session {
2016-11-10 15:16:32 +00:00
sess := x.
2017-02-09 09:59:57 +00:00
Where("is_closed = ?", isClosed).
2016-04-26 04:22:03 +00:00
And("is_pull = ?", isPull).
And("repo_id = ?", repoID)
2015-09-02 20:18:09 +00:00
return sess
2015-09-02 20:18:09 +00:00
}
openCountSession := countSession(false, isPull, repoID)
closedCountSession := countSession(true, isPull, repoID)
2015-08-25 14:58:34 +00:00
switch filterMode {
2016-11-07 16:24:59 +00:00
case FilterModeAssign:
openCountSession.And("assignee_id = ?", uid)
closedCountSession.And("assignee_id = ?", uid)
2016-11-07 16:24:59 +00:00
case FilterModeCreate:
openCountSession.And("poster_id = ?", uid)
closedCountSession.And("poster_id = ?", uid)
2015-08-25 14:58:34 +00:00
}
openResult, _ := openCountSession.Count(&Issue{})
closedResult, _ := closedCountSession.Count(&Issue{})
return openResult, closedResult
2015-08-25 14:58:34 +00:00
}
2015-08-10 10:57:57 +00:00
func updateIssue(e Engine, issue *Issue) error {
_, err := e.Id(issue.ID).AllCols().Update(issue)
2017-01-25 02:43:02 +00:00
if err != nil {
return err
}
UpdateIssueIndexer(issue)
return nil
2015-08-10 10:57:57 +00:00
}
// UpdateIssue updates all fields of given issue.
func UpdateIssue(issue *Issue) error {
return updateIssue(x, issue)
}