You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

issue.go 46KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755
  1. // Copyright 2014 The Gogs Authors. All rights reserved.
  2. // Use of this source code is governed by a MIT-style
  3. // license that can be found in the LICENSE file.
  4. package models
  5. import (
  6. "fmt"
  7. "path"
  8. "regexp"
  9. "sort"
  10. "strings"
  11. "code.gitea.io/gitea/modules/base"
  12. "code.gitea.io/gitea/modules/log"
  13. "code.gitea.io/gitea/modules/setting"
  14. "code.gitea.io/gitea/modules/util"
  15. api "code.gitea.io/sdk/gitea"
  16. "github.com/Unknwon/com"
  17. "github.com/go-xorm/builder"
  18. "github.com/go-xorm/xorm"
  19. )
  20. // Issue represents an issue or pull request of repository.
  21. type Issue struct {
  22. ID int64 `xorm:"pk autoincr"`
  23. RepoID int64 `xorm:"INDEX UNIQUE(repo_index)"`
  24. Repo *Repository `xorm:"-"`
  25. Index int64 `xorm:"UNIQUE(repo_index)"` // Index in one repository.
  26. PosterID int64 `xorm:"INDEX"`
  27. Poster *User `xorm:"-"`
  28. Title string `xorm:"name"`
  29. Content string `xorm:"TEXT"`
  30. RenderedContent string `xorm:"-"`
  31. Labels []*Label `xorm:"-"`
  32. MilestoneID int64 `xorm:"INDEX"`
  33. Milestone *Milestone `xorm:"-"`
  34. Priority int
  35. AssigneeID int64 `xorm:"-"`
  36. Assignee *User `xorm:"-"`
  37. IsClosed bool `xorm:"INDEX"`
  38. IsRead bool `xorm:"-"`
  39. IsPull bool `xorm:"INDEX"` // Indicates whether is a pull request or not.
  40. PullRequest *PullRequest `xorm:"-"`
  41. NumComments int
  42. Ref string
  43. DeadlineUnix util.TimeStamp `xorm:"INDEX"`
  44. CreatedUnix util.TimeStamp `xorm:"INDEX created"`
  45. UpdatedUnix util.TimeStamp `xorm:"INDEX updated"`
  46. ClosedUnix util.TimeStamp `xorm:"INDEX"`
  47. Attachments []*Attachment `xorm:"-"`
  48. Comments []*Comment `xorm:"-"`
  49. Reactions ReactionList `xorm:"-"`
  50. TotalTrackedTime int64 `xorm:"-"`
  51. Assignees []*User `xorm:"-"`
  52. // IsLocked limits commenting abilities to users on an issue
  53. // with write access
  54. IsLocked bool `xorm:"NOT NULL DEFAULT false"`
  55. }
  56. var (
  57. issueTasksPat *regexp.Regexp
  58. issueTasksDonePat *regexp.Regexp
  59. )
  60. const issueTasksRegexpStr = `(^\s*[-*]\s\[[\sx]\]\s.)|(\n\s*[-*]\s\[[\sx]\]\s.)`
  61. const issueTasksDoneRegexpStr = `(^\s*[-*]\s\[[x]\]\s.)|(\n\s*[-*]\s\[[x]\]\s.)`
  62. func init() {
  63. issueTasksPat = regexp.MustCompile(issueTasksRegexpStr)
  64. issueTasksDonePat = regexp.MustCompile(issueTasksDoneRegexpStr)
  65. }
  66. func (issue *Issue) loadTotalTimes(e Engine) (err error) {
  67. opts := FindTrackedTimesOptions{IssueID: issue.ID}
  68. issue.TotalTrackedTime, err = opts.ToSession(e).SumInt(&TrackedTime{}, "time")
  69. if err != nil {
  70. return err
  71. }
  72. return nil
  73. }
  74. // IsOverdue checks if the issue is overdue
  75. func (issue *Issue) IsOverdue() bool {
  76. return util.TimeStampNow() >= issue.DeadlineUnix
  77. }
  78. // LoadRepo loads issue's repository
  79. func (issue *Issue) LoadRepo() error {
  80. return issue.loadRepo(x)
  81. }
  82. func (issue *Issue) loadRepo(e Engine) (err error) {
  83. if issue.Repo == nil {
  84. issue.Repo, err = getRepositoryByID(e, issue.RepoID)
  85. if err != nil {
  86. return fmt.Errorf("getRepositoryByID [%d]: %v", issue.RepoID, err)
  87. }
  88. }
  89. return nil
  90. }
  91. // IsTimetrackerEnabled returns true if the repo enables timetracking
  92. func (issue *Issue) IsTimetrackerEnabled() bool {
  93. return issue.isTimetrackerEnabled(x)
  94. }
  95. func (issue *Issue) isTimetrackerEnabled(e Engine) bool {
  96. if err := issue.loadRepo(e); err != nil {
  97. log.Error(4, fmt.Sprintf("loadRepo: %v", err))
  98. return false
  99. }
  100. return issue.Repo.IsTimetrackerEnabled()
  101. }
  102. // GetPullRequest returns the issue pull request
  103. func (issue *Issue) GetPullRequest() (pr *PullRequest, err error) {
  104. if !issue.IsPull {
  105. return nil, fmt.Errorf("Issue is not a pull request")
  106. }
  107. pr, err = getPullRequestByIssueID(x, issue.ID)
  108. if err != nil {
  109. return nil, err
  110. }
  111. pr.Issue = issue
  112. return
  113. }
  114. func (issue *Issue) loadLabels(e Engine) (err error) {
  115. if issue.Labels == nil {
  116. issue.Labels, err = getLabelsByIssueID(e, issue.ID)
  117. if err != nil {
  118. return fmt.Errorf("getLabelsByIssueID [%d]: %v", issue.ID, err)
  119. }
  120. }
  121. return nil
  122. }
  123. // LoadPoster loads poster
  124. func (issue *Issue) LoadPoster() error {
  125. return issue.loadPoster(x)
  126. }
  127. func (issue *Issue) loadPoster(e Engine) (err error) {
  128. if issue.Poster == nil {
  129. issue.Poster, err = getUserByID(e, issue.PosterID)
  130. if err != nil {
  131. issue.PosterID = -1
  132. issue.Poster = NewGhostUser()
  133. if !IsErrUserNotExist(err) {
  134. return fmt.Errorf("getUserByID.(poster) [%d]: %v", issue.PosterID, err)
  135. }
  136. err = nil
  137. return
  138. }
  139. }
  140. return
  141. }
  142. func (issue *Issue) loadPullRequest(e Engine) (err error) {
  143. if issue.IsPull && issue.PullRequest == nil {
  144. issue.PullRequest, err = getPullRequestByIssueID(e, issue.ID)
  145. if err != nil {
  146. if IsErrPullRequestNotExist(err) {
  147. return err
  148. }
  149. return fmt.Errorf("getPullRequestByIssueID [%d]: %v", issue.ID, err)
  150. }
  151. issue.PullRequest.Issue = issue
  152. }
  153. return nil
  154. }
  155. // LoadPullRequest loads pull request info
  156. func (issue *Issue) LoadPullRequest() error {
  157. return issue.loadPullRequest(x)
  158. }
  159. func (issue *Issue) loadComments(e Engine) (err error) {
  160. return issue.loadCommentsByType(e, CommentTypeUnknown)
  161. }
  162. // LoadDiscussComments loads discuss comments
  163. func (issue *Issue) LoadDiscussComments() error {
  164. return issue.loadCommentsByType(x, CommentTypeComment)
  165. }
  166. func (issue *Issue) loadCommentsByType(e Engine, tp CommentType) (err error) {
  167. if issue.Comments != nil {
  168. return nil
  169. }
  170. issue.Comments, err = findComments(e, FindCommentsOptions{
  171. IssueID: issue.ID,
  172. Type: tp,
  173. })
  174. return err
  175. }
  176. func (issue *Issue) loadReactions(e Engine) (err error) {
  177. if issue.Reactions != nil {
  178. return nil
  179. }
  180. reactions, err := findReactions(e, FindReactionsOptions{
  181. IssueID: issue.ID,
  182. })
  183. if err != nil {
  184. return err
  185. }
  186. // Load reaction user data
  187. if _, err := ReactionList(reactions).loadUsers(e); err != nil {
  188. return err
  189. }
  190. // Cache comments to map
  191. comments := make(map[int64]*Comment)
  192. for _, comment := range issue.Comments {
  193. comments[comment.ID] = comment
  194. }
  195. // Add reactions either to issue or comment
  196. for _, react := range reactions {
  197. if react.CommentID == 0 {
  198. issue.Reactions = append(issue.Reactions, react)
  199. } else if comment, ok := comments[react.CommentID]; ok {
  200. comment.Reactions = append(comment.Reactions, react)
  201. }
  202. }
  203. return nil
  204. }
  205. func (issue *Issue) loadAttributes(e Engine) (err error) {
  206. if err = issue.loadRepo(e); err != nil {
  207. return
  208. }
  209. if err = issue.loadPoster(e); err != nil {
  210. return
  211. }
  212. if err = issue.loadLabels(e); err != nil {
  213. return
  214. }
  215. if issue.Milestone == nil && issue.MilestoneID > 0 {
  216. issue.Milestone, err = getMilestoneByRepoID(e, issue.RepoID, issue.MilestoneID)
  217. if err != nil && !IsErrMilestoneNotExist(err) {
  218. return fmt.Errorf("getMilestoneByRepoID [repo_id: %d, milestone_id: %d]: %v", issue.RepoID, issue.MilestoneID, err)
  219. }
  220. }
  221. if err = issue.loadAssignees(e); err != nil {
  222. return
  223. }
  224. if err = issue.loadPullRequest(e); err != nil && !IsErrPullRequestNotExist(err) {
  225. // It is possible pull request is not yet created.
  226. return err
  227. }
  228. if issue.Attachments == nil {
  229. issue.Attachments, err = getAttachmentsByIssueID(e, issue.ID)
  230. if err != nil {
  231. return fmt.Errorf("getAttachmentsByIssueID [%d]: %v", issue.ID, err)
  232. }
  233. }
  234. if err = issue.loadComments(e); err != nil {
  235. return err
  236. }
  237. if issue.isTimetrackerEnabled(e) {
  238. if err = issue.loadTotalTimes(e); err != nil {
  239. return err
  240. }
  241. }
  242. return issue.loadReactions(e)
  243. }
  244. // LoadAttributes loads the attribute of this issue.
  245. func (issue *Issue) LoadAttributes() error {
  246. return issue.loadAttributes(x)
  247. }
  248. // GetIsRead load the `IsRead` field of the issue
  249. func (issue *Issue) GetIsRead(userID int64) error {
  250. issueUser := &IssueUser{IssueID: issue.ID, UID: userID}
  251. if has, err := x.Get(issueUser); err != nil {
  252. return err
  253. } else if !has {
  254. issue.IsRead = false
  255. return nil
  256. }
  257. issue.IsRead = issueUser.IsRead
  258. return nil
  259. }
  260. // APIURL returns the absolute APIURL to this issue.
  261. func (issue *Issue) APIURL() string {
  262. return issue.Repo.APIURL() + "/" + path.Join("issues", fmt.Sprint(issue.Index))
  263. }
  264. // HTMLURL returns the absolute URL to this issue.
  265. func (issue *Issue) HTMLURL() string {
  266. var path string
  267. if issue.IsPull {
  268. path = "pulls"
  269. } else {
  270. path = "issues"
  271. }
  272. return fmt.Sprintf("%s/%s/%d", issue.Repo.HTMLURL(), path, issue.Index)
  273. }
  274. // DiffURL returns the absolute URL to this diff
  275. func (issue *Issue) DiffURL() string {
  276. if issue.IsPull {
  277. return fmt.Sprintf("%s/pulls/%d.diff", issue.Repo.HTMLURL(), issue.Index)
  278. }
  279. return ""
  280. }
  281. // PatchURL returns the absolute URL to this patch
  282. func (issue *Issue) PatchURL() string {
  283. if issue.IsPull {
  284. return fmt.Sprintf("%s/pulls/%d.patch", issue.Repo.HTMLURL(), issue.Index)
  285. }
  286. return ""
  287. }
  288. // State returns string representation of issue status.
  289. func (issue *Issue) State() api.StateType {
  290. if issue.IsClosed {
  291. return api.StateClosed
  292. }
  293. return api.StateOpen
  294. }
  295. // APIFormat assumes some fields assigned with values:
  296. // Required - Poster, Labels,
  297. // Optional - Milestone, Assignee, PullRequest
  298. func (issue *Issue) APIFormat() *api.Issue {
  299. return issue.apiFormat(x)
  300. }
  301. func (issue *Issue) apiFormat(e Engine) *api.Issue {
  302. issue.loadLabels(e)
  303. apiLabels := make([]*api.Label, len(issue.Labels))
  304. for i := range issue.Labels {
  305. apiLabels[i] = issue.Labels[i].APIFormat()
  306. }
  307. issue.loadPoster(e)
  308. issue.loadRepo(e)
  309. apiIssue := &api.Issue{
  310. ID: issue.ID,
  311. URL: issue.APIURL(),
  312. Index: issue.Index,
  313. Poster: issue.Poster.APIFormat(),
  314. Title: issue.Title,
  315. Body: issue.Content,
  316. Labels: apiLabels,
  317. State: issue.State(),
  318. Comments: issue.NumComments,
  319. Created: issue.CreatedUnix.AsTime(),
  320. Updated: issue.UpdatedUnix.AsTime(),
  321. }
  322. if issue.ClosedUnix != 0 {
  323. apiIssue.Closed = issue.ClosedUnix.AsTimePtr()
  324. }
  325. if issue.Milestone != nil {
  326. apiIssue.Milestone = issue.Milestone.APIFormat()
  327. }
  328. issue.loadAssignees(e)
  329. if len(issue.Assignees) > 0 {
  330. for _, assignee := range issue.Assignees {
  331. apiIssue.Assignees = append(apiIssue.Assignees, assignee.APIFormat())
  332. }
  333. apiIssue.Assignee = issue.Assignees[0].APIFormat() // For compatibility, we're keeping the first assignee as `apiIssue.Assignee`
  334. }
  335. if issue.IsPull {
  336. issue.loadPullRequest(e)
  337. apiIssue.PullRequest = &api.PullRequestMeta{
  338. HasMerged: issue.PullRequest.HasMerged,
  339. }
  340. if issue.PullRequest.HasMerged {
  341. apiIssue.PullRequest.Merged = issue.PullRequest.MergedUnix.AsTimePtr()
  342. }
  343. }
  344. if issue.DeadlineUnix != 0 {
  345. apiIssue.Deadline = issue.DeadlineUnix.AsTimePtr()
  346. }
  347. return apiIssue
  348. }
  349. // HashTag returns unique hash tag for issue.
  350. func (issue *Issue) HashTag() string {
  351. return "issue-" + com.ToStr(issue.ID)
  352. }
  353. // IsPoster returns true if given user by ID is the poster.
  354. func (issue *Issue) IsPoster(uid int64) bool {
  355. return issue.PosterID == uid
  356. }
  357. func (issue *Issue) hasLabel(e Engine, labelID int64) bool {
  358. return hasIssueLabel(e, issue.ID, labelID)
  359. }
  360. // HasLabel returns true if issue has been labeled by given ID.
  361. func (issue *Issue) HasLabel(labelID int64) bool {
  362. return issue.hasLabel(x, labelID)
  363. }
  364. func (issue *Issue) sendLabelUpdatedWebhook(doer *User) {
  365. var err error
  366. if err = issue.loadRepo(x); err != nil {
  367. log.Error(4, "loadRepo: %v", err)
  368. return
  369. }
  370. if err = issue.loadPoster(x); err != nil {
  371. log.Error(4, "loadPoster: %v", err)
  372. return
  373. }
  374. mode, _ := AccessLevel(issue.Poster, issue.Repo)
  375. if issue.IsPull {
  376. if err = issue.loadPullRequest(x); err != nil {
  377. log.Error(4, "loadPullRequest: %v", err)
  378. return
  379. }
  380. if err = issue.PullRequest.LoadIssue(); err != nil {
  381. log.Error(4, "LoadIssue: %v", err)
  382. return
  383. }
  384. err = PrepareWebhooks(issue.Repo, HookEventPullRequest, &api.PullRequestPayload{
  385. Action: api.HookIssueLabelUpdated,
  386. Index: issue.Index,
  387. PullRequest: issue.PullRequest.APIFormat(),
  388. Repository: issue.Repo.APIFormat(AccessModeNone),
  389. Sender: doer.APIFormat(),
  390. })
  391. } else {
  392. err = PrepareWebhooks(issue.Repo, HookEventIssues, &api.IssuePayload{
  393. Action: api.HookIssueLabelUpdated,
  394. Index: issue.Index,
  395. Issue: issue.APIFormat(),
  396. Repository: issue.Repo.APIFormat(mode),
  397. Sender: doer.APIFormat(),
  398. })
  399. }
  400. if err != nil {
  401. log.Error(4, "PrepareWebhooks [is_pull: %v]: %v", issue.IsPull, err)
  402. } else {
  403. go HookQueue.Add(issue.RepoID)
  404. }
  405. }
  406. func (issue *Issue) addLabel(e *xorm.Session, label *Label, doer *User) error {
  407. return newIssueLabel(e, issue, label, doer)
  408. }
  409. // AddLabel adds a new label to the issue.
  410. func (issue *Issue) AddLabel(doer *User, label *Label) error {
  411. if err := NewIssueLabel(issue, label, doer); err != nil {
  412. return err
  413. }
  414. issue.sendLabelUpdatedWebhook(doer)
  415. return nil
  416. }
  417. func (issue *Issue) addLabels(e *xorm.Session, labels []*Label, doer *User) error {
  418. return newIssueLabels(e, issue, labels, doer)
  419. }
  420. // AddLabels adds a list of new labels to the issue.
  421. func (issue *Issue) AddLabels(doer *User, labels []*Label) error {
  422. if err := NewIssueLabels(issue, labels, doer); err != nil {
  423. return err
  424. }
  425. issue.sendLabelUpdatedWebhook(doer)
  426. return nil
  427. }
  428. func (issue *Issue) getLabels(e Engine) (err error) {
  429. if len(issue.Labels) > 0 {
  430. return nil
  431. }
  432. issue.Labels, err = getLabelsByIssueID(e, issue.ID)
  433. if err != nil {
  434. return fmt.Errorf("getLabelsByIssueID: %v", err)
  435. }
  436. return nil
  437. }
  438. func (issue *Issue) removeLabel(e *xorm.Session, doer *User, label *Label) error {
  439. return deleteIssueLabel(e, issue, label, doer)
  440. }
  441. // RemoveLabel removes a label from issue by given ID.
  442. func (issue *Issue) RemoveLabel(doer *User, label *Label) error {
  443. if err := issue.loadRepo(x); err != nil {
  444. return err
  445. }
  446. perm, err := GetUserRepoPermission(issue.Repo, doer)
  447. if err != nil {
  448. return err
  449. }
  450. if !perm.CanWriteIssuesOrPulls(issue.IsPull) {
  451. return ErrLabelNotExist{}
  452. }
  453. if err := DeleteIssueLabel(issue, label, doer); err != nil {
  454. return err
  455. }
  456. issue.sendLabelUpdatedWebhook(doer)
  457. return nil
  458. }
  459. func (issue *Issue) clearLabels(e *xorm.Session, doer *User) (err error) {
  460. if err = issue.getLabels(e); err != nil {
  461. return fmt.Errorf("getLabels: %v", err)
  462. }
  463. for i := range issue.Labels {
  464. if err = issue.removeLabel(e, doer, issue.Labels[i]); err != nil {
  465. return fmt.Errorf("removeLabel: %v", err)
  466. }
  467. }
  468. return nil
  469. }
  470. // ClearLabels removes all issue labels as the given user.
  471. // Triggers appropriate WebHooks, if any.
  472. func (issue *Issue) ClearLabels(doer *User) (err error) {
  473. sess := x.NewSession()
  474. defer sess.Close()
  475. if err = sess.Begin(); err != nil {
  476. return err
  477. }
  478. if err := issue.loadRepo(sess); err != nil {
  479. return err
  480. } else if err = issue.loadPullRequest(sess); err != nil {
  481. return err
  482. }
  483. perm, err := getUserRepoPermission(sess, issue.Repo, doer)
  484. if err != nil {
  485. return err
  486. }
  487. if !perm.CanWriteIssuesOrPulls(issue.IsPull) {
  488. return ErrLabelNotExist{}
  489. }
  490. if err = issue.clearLabels(sess, doer); err != nil {
  491. return err
  492. }
  493. if err = sess.Commit(); err != nil {
  494. return fmt.Errorf("Commit: %v", err)
  495. }
  496. if err = issue.loadPoster(x); err != nil {
  497. return fmt.Errorf("loadPoster: %v", err)
  498. }
  499. mode, _ := AccessLevel(issue.Poster, issue.Repo)
  500. if issue.IsPull {
  501. err = issue.PullRequest.LoadIssue()
  502. if err != nil {
  503. log.Error(4, "LoadIssue: %v", err)
  504. return
  505. }
  506. err = PrepareWebhooks(issue.Repo, HookEventPullRequest, &api.PullRequestPayload{
  507. Action: api.HookIssueLabelCleared,
  508. Index: issue.Index,
  509. PullRequest: issue.PullRequest.APIFormat(),
  510. Repository: issue.Repo.APIFormat(mode),
  511. Sender: doer.APIFormat(),
  512. })
  513. } else {
  514. err = PrepareWebhooks(issue.Repo, HookEventIssues, &api.IssuePayload{
  515. Action: api.HookIssueLabelCleared,
  516. Index: issue.Index,
  517. Issue: issue.APIFormat(),
  518. Repository: issue.Repo.APIFormat(mode),
  519. Sender: doer.APIFormat(),
  520. })
  521. }
  522. if err != nil {
  523. log.Error(4, "PrepareWebhooks [is_pull: %v]: %v", issue.IsPull, err)
  524. } else {
  525. go HookQueue.Add(issue.RepoID)
  526. }
  527. return nil
  528. }
  529. type labelSorter []*Label
  530. func (ts labelSorter) Len() int {
  531. return len([]*Label(ts))
  532. }
  533. func (ts labelSorter) Less(i, j int) bool {
  534. return []*Label(ts)[i].ID < []*Label(ts)[j].ID
  535. }
  536. func (ts labelSorter) Swap(i, j int) {
  537. []*Label(ts)[i], []*Label(ts)[j] = []*Label(ts)[j], []*Label(ts)[i]
  538. }
  539. // ReplaceLabels removes all current labels and add new labels to the issue.
  540. // Triggers appropriate WebHooks, if any.
  541. func (issue *Issue) ReplaceLabels(labels []*Label, doer *User) (err error) {
  542. sess := x.NewSession()
  543. defer sess.Close()
  544. if err = sess.Begin(); err != nil {
  545. return err
  546. }
  547. if err = issue.loadLabels(sess); err != nil {
  548. return err
  549. }
  550. sort.Sort(labelSorter(labels))
  551. sort.Sort(labelSorter(issue.Labels))
  552. var toAdd, toRemove []*Label
  553. addIndex, removeIndex := 0, 0
  554. for addIndex < len(labels) && removeIndex < len(issue.Labels) {
  555. addLabel := labels[addIndex]
  556. removeLabel := issue.Labels[removeIndex]
  557. if addLabel.ID == removeLabel.ID {
  558. addIndex++
  559. removeIndex++
  560. } else if addLabel.ID < removeLabel.ID {
  561. toAdd = append(toAdd, addLabel)
  562. addIndex++
  563. } else {
  564. toRemove = append(toRemove, removeLabel)
  565. removeIndex++
  566. }
  567. }
  568. toAdd = append(toAdd, labels[addIndex:]...)
  569. toRemove = append(toRemove, issue.Labels[removeIndex:]...)
  570. if len(toAdd) > 0 {
  571. if err = issue.addLabels(sess, toAdd, doer); err != nil {
  572. return fmt.Errorf("addLabels: %v", err)
  573. }
  574. }
  575. for _, l := range toRemove {
  576. if err = issue.removeLabel(sess, doer, l); err != nil {
  577. return fmt.Errorf("removeLabel: %v", err)
  578. }
  579. }
  580. return sess.Commit()
  581. }
  582. // ReadBy sets issue to be read by given user.
  583. func (issue *Issue) ReadBy(userID int64) error {
  584. if err := UpdateIssueUserByRead(userID, issue.ID); err != nil {
  585. return err
  586. }
  587. return setNotificationStatusReadIfUnread(x, userID, issue.ID)
  588. }
  589. func updateIssueCols(e Engine, issue *Issue, cols ...string) error {
  590. if _, err := e.ID(issue.ID).Cols(cols...).Update(issue); err != nil {
  591. return err
  592. }
  593. return nil
  594. }
  595. // UpdateIssueCols only updates values of specific columns for given issue.
  596. func UpdateIssueCols(issue *Issue, cols ...string) error {
  597. return updateIssueCols(x, issue, cols...)
  598. }
  599. func (issue *Issue) changeStatus(e *xorm.Session, doer *User, isClosed bool) (err error) {
  600. // Nothing should be performed if current status is same as target status
  601. if issue.IsClosed == isClosed {
  602. return nil
  603. }
  604. // Check for open dependencies
  605. if isClosed && issue.Repo.isDependenciesEnabled(e) {
  606. // only check if dependencies are enabled and we're about to close an issue, otherwise reopening an issue would fail when there are unsatisfied dependencies
  607. noDeps, err := issueNoDependenciesLeft(e, issue)
  608. if err != nil {
  609. return err
  610. }
  611. if !noDeps {
  612. return ErrDependenciesLeft{issue.ID}
  613. }
  614. }
  615. issue.IsClosed = isClosed
  616. if isClosed {
  617. issue.ClosedUnix = util.TimeStampNow()
  618. } else {
  619. issue.ClosedUnix = 0
  620. }
  621. if err = updateIssueCols(e, issue, "is_closed", "closed_unix"); err != nil {
  622. return err
  623. }
  624. // Update issue count of labels
  625. if err = issue.getLabels(e); err != nil {
  626. return err
  627. }
  628. for idx := range issue.Labels {
  629. if issue.IsClosed {
  630. issue.Labels[idx].NumClosedIssues++
  631. } else {
  632. issue.Labels[idx].NumClosedIssues--
  633. }
  634. if err = updateLabel(e, issue.Labels[idx]); err != nil {
  635. return err
  636. }
  637. }
  638. // Update issue count of milestone
  639. if err = changeMilestoneIssueStats(e, issue); err != nil {
  640. return err
  641. }
  642. // New action comment
  643. if _, err = createStatusComment(e, doer, issue); err != nil {
  644. return err
  645. }
  646. return nil
  647. }
  648. // ChangeStatus changes issue status to open or closed.
  649. func (issue *Issue) ChangeStatus(doer *User, isClosed bool) (err error) {
  650. sess := x.NewSession()
  651. defer sess.Close()
  652. if err = sess.Begin(); err != nil {
  653. return err
  654. }
  655. if err = issue.loadRepo(sess); err != nil {
  656. return err
  657. }
  658. if err = issue.loadPoster(sess); err != nil {
  659. return err
  660. }
  661. if err = issue.changeStatus(sess, doer, isClosed); err != nil {
  662. return err
  663. }
  664. if err = sess.Commit(); err != nil {
  665. return fmt.Errorf("Commit: %v", err)
  666. }
  667. sess.Close()
  668. mode, _ := AccessLevel(issue.Poster, issue.Repo)
  669. if issue.IsPull {
  670. if err = issue.loadPullRequest(sess); err != nil {
  671. return err
  672. }
  673. // Merge pull request calls issue.changeStatus so we need to handle separately.
  674. apiPullRequest := &api.PullRequestPayload{
  675. Index: issue.Index,
  676. PullRequest: issue.PullRequest.APIFormat(),
  677. Repository: issue.Repo.APIFormat(mode),
  678. Sender: doer.APIFormat(),
  679. }
  680. if isClosed {
  681. apiPullRequest.Action = api.HookIssueClosed
  682. } else {
  683. apiPullRequest.Action = api.HookIssueReOpened
  684. }
  685. err = PrepareWebhooks(issue.Repo, HookEventPullRequest, apiPullRequest)
  686. } else {
  687. apiIssue := &api.IssuePayload{
  688. Index: issue.Index,
  689. Issue: issue.APIFormat(),
  690. Repository: issue.Repo.APIFormat(mode),
  691. Sender: doer.APIFormat(),
  692. }
  693. if isClosed {
  694. apiIssue.Action = api.HookIssueClosed
  695. } else {
  696. apiIssue.Action = api.HookIssueReOpened
  697. }
  698. err = PrepareWebhooks(issue.Repo, HookEventIssues, apiIssue)
  699. }
  700. if err != nil {
  701. log.Error(4, "PrepareWebhooks [is_pull: %v, is_closed: %v]: %v", issue.IsPull, isClosed, err)
  702. } else {
  703. go HookQueue.Add(issue.Repo.ID)
  704. }
  705. return nil
  706. }
  707. // ChangeTitle changes the title of this issue, as the given user.
  708. func (issue *Issue) ChangeTitle(doer *User, title string) (err error) {
  709. oldTitle := issue.Title
  710. issue.Title = title
  711. sess := x.NewSession()
  712. defer sess.Close()
  713. if err = sess.Begin(); err != nil {
  714. return err
  715. }
  716. if err = updateIssueCols(sess, issue, "name"); err != nil {
  717. return fmt.Errorf("updateIssueCols: %v", err)
  718. }
  719. if err = issue.loadRepo(sess); err != nil {
  720. return fmt.Errorf("loadRepo: %v", err)
  721. }
  722. if _, err = createChangeTitleComment(sess, doer, issue.Repo, issue, oldTitle, title); err != nil {
  723. return fmt.Errorf("createChangeTitleComment: %v", err)
  724. }
  725. if err = sess.Commit(); err != nil {
  726. return err
  727. }
  728. mode, _ := AccessLevel(issue.Poster, issue.Repo)
  729. if issue.IsPull {
  730. if err = issue.loadPullRequest(sess); err != nil {
  731. return fmt.Errorf("loadPullRequest: %v", err)
  732. }
  733. issue.PullRequest.Issue = issue
  734. err = PrepareWebhooks(issue.Repo, HookEventPullRequest, &api.PullRequestPayload{
  735. Action: api.HookIssueEdited,
  736. Index: issue.Index,
  737. Changes: &api.ChangesPayload{
  738. Title: &api.ChangesFromPayload{
  739. From: oldTitle,
  740. },
  741. },
  742. PullRequest: issue.PullRequest.APIFormat(),
  743. Repository: issue.Repo.APIFormat(mode),
  744. Sender: doer.APIFormat(),
  745. })
  746. } else {
  747. err = PrepareWebhooks(issue.Repo, HookEventIssues, &api.IssuePayload{
  748. Action: api.HookIssueEdited,
  749. Index: issue.Index,
  750. Changes: &api.ChangesPayload{
  751. Title: &api.ChangesFromPayload{
  752. From: oldTitle,
  753. },
  754. },
  755. Issue: issue.APIFormat(),
  756. Repository: issue.Repo.APIFormat(mode),
  757. Sender: issue.Poster.APIFormat(),
  758. })
  759. }
  760. if err != nil {
  761. log.Error(4, "PrepareWebhooks [is_pull: %v]: %v", issue.IsPull, err)
  762. } else {
  763. go HookQueue.Add(issue.RepoID)
  764. }
  765. return nil
  766. }
  767. // AddDeletePRBranchComment adds delete branch comment for pull request issue
  768. func AddDeletePRBranchComment(doer *User, repo *Repository, issueID int64, branchName string) error {
  769. issue, err := getIssueByID(x, issueID)
  770. if err != nil {
  771. return err
  772. }
  773. sess := x.NewSession()
  774. defer sess.Close()
  775. if err := sess.Begin(); err != nil {
  776. return err
  777. }
  778. if _, err := createDeleteBranchComment(sess, doer, repo, issue, branchName); err != nil {
  779. return err
  780. }
  781. return sess.Commit()
  782. }
  783. // ChangeContent changes issue content, as the given user.
  784. func (issue *Issue) ChangeContent(doer *User, content string) (err error) {
  785. oldContent := issue.Content
  786. issue.Content = content
  787. if err = UpdateIssueCols(issue, "content"); err != nil {
  788. return fmt.Errorf("UpdateIssueCols: %v", err)
  789. }
  790. mode, _ := AccessLevel(issue.Poster, issue.Repo)
  791. if issue.IsPull {
  792. issue.PullRequest.Issue = issue
  793. err = PrepareWebhooks(issue.Repo, HookEventPullRequest, &api.PullRequestPayload{
  794. Action: api.HookIssueEdited,
  795. Index: issue.Index,
  796. Changes: &api.ChangesPayload{
  797. Body: &api.ChangesFromPayload{
  798. From: oldContent,
  799. },
  800. },
  801. PullRequest: issue.PullRequest.APIFormat(),
  802. Repository: issue.Repo.APIFormat(mode),
  803. Sender: doer.APIFormat(),
  804. })
  805. } else {
  806. err = PrepareWebhooks(issue.Repo, HookEventIssues, &api.IssuePayload{
  807. Action: api.HookIssueEdited,
  808. Index: issue.Index,
  809. Changes: &api.ChangesPayload{
  810. Body: &api.ChangesFromPayload{
  811. From: oldContent,
  812. },
  813. },
  814. Issue: issue.APIFormat(),
  815. Repository: issue.Repo.APIFormat(mode),
  816. Sender: doer.APIFormat(),
  817. })
  818. }
  819. if err != nil {
  820. log.Error(4, "PrepareWebhooks [is_pull: %v]: %v", issue.IsPull, err)
  821. } else {
  822. go HookQueue.Add(issue.RepoID)
  823. }
  824. return nil
  825. }
  826. // GetTasks returns the amount of tasks in the issues content
  827. func (issue *Issue) GetTasks() int {
  828. return len(issueTasksPat.FindAllStringIndex(issue.Content, -1))
  829. }
  830. // GetTasksDone returns the amount of completed tasks in the issues content
  831. func (issue *Issue) GetTasksDone() int {
  832. return len(issueTasksDonePat.FindAllStringIndex(issue.Content, -1))
  833. }
  834. // GetLastEventTimestamp returns the last user visible event timestamp, either the creation of this issue or the close.
  835. func (issue *Issue) GetLastEventTimestamp() util.TimeStamp {
  836. if issue.IsClosed {
  837. return issue.ClosedUnix
  838. }
  839. return issue.CreatedUnix
  840. }
  841. // GetLastEventLabel returns the localization label for the current issue.
  842. func (issue *Issue) GetLastEventLabel() string {
  843. if issue.IsClosed {
  844. if issue.IsPull && issue.PullRequest.HasMerged {
  845. return "repo.pulls.merged_by"
  846. }
  847. return "repo.issues.closed_by"
  848. }
  849. return "repo.issues.opened_by"
  850. }
  851. // NewIssueOptions represents the options of a new issue.
  852. type NewIssueOptions struct {
  853. Repo *Repository
  854. Issue *Issue
  855. LabelIDs []int64
  856. AssigneeIDs []int64
  857. Attachments []string // In UUID format.
  858. IsPull bool
  859. }
  860. func newIssue(e *xorm.Session, doer *User, opts NewIssueOptions) (err error) {
  861. opts.Issue.Title = strings.TrimSpace(opts.Issue.Title)
  862. opts.Issue.Index = opts.Repo.NextIssueIndex()
  863. if opts.Issue.MilestoneID > 0 {
  864. milestone, err := getMilestoneByRepoID(e, opts.Issue.RepoID, opts.Issue.MilestoneID)
  865. if err != nil && !IsErrMilestoneNotExist(err) {
  866. return fmt.Errorf("getMilestoneByID: %v", err)
  867. }
  868. // Assume milestone is invalid and drop silently.
  869. opts.Issue.MilestoneID = 0
  870. if milestone != nil {
  871. opts.Issue.MilestoneID = milestone.ID
  872. opts.Issue.Milestone = milestone
  873. }
  874. }
  875. // Keep the old assignee id thingy for compatibility reasons
  876. if opts.Issue.AssigneeID > 0 {
  877. isAdded := false
  878. // Check if the user has already been passed to issue.AssigneeIDs, if not, add it
  879. for _, aID := range opts.AssigneeIDs {
  880. if aID == opts.Issue.AssigneeID {
  881. isAdded = true
  882. break
  883. }
  884. }
  885. if !isAdded {
  886. opts.AssigneeIDs = append(opts.AssigneeIDs, opts.Issue.AssigneeID)
  887. }
  888. }
  889. // Check for and validate assignees
  890. if len(opts.AssigneeIDs) > 0 {
  891. for _, assigneeID := range opts.AssigneeIDs {
  892. user, err := getUserByID(e, assigneeID)
  893. if err != nil {
  894. return fmt.Errorf("getUserByID [user_id: %d, repo_id: %d]: %v", assigneeID, opts.Repo.ID, err)
  895. }
  896. valid, err := canBeAssigned(e, user, opts.Repo)
  897. if err != nil {
  898. return fmt.Errorf("canBeAssigned [user_id: %d, repo_id: %d]: %v", assigneeID, opts.Repo.ID, err)
  899. }
  900. if !valid {
  901. return ErrUserDoesNotHaveAccessToRepo{UserID: assigneeID, RepoName: opts.Repo.Name}
  902. }
  903. }
  904. }
  905. // Milestone and assignee validation should happen before insert actual object.
  906. if _, err = e.Insert(opts.Issue); err != nil {
  907. return err
  908. }
  909. if opts.Issue.MilestoneID > 0 {
  910. if err = changeMilestoneAssign(e, doer, opts.Issue, -1); err != nil {
  911. return err
  912. }
  913. }
  914. // Insert the assignees
  915. for _, assigneeID := range opts.AssigneeIDs {
  916. err = opts.Issue.changeAssignee(e, doer, assigneeID, true)
  917. if err != nil {
  918. return err
  919. }
  920. }
  921. if opts.IsPull {
  922. _, err = e.Exec("UPDATE `repository` SET num_pulls = num_pulls + 1 WHERE id = ?", opts.Issue.RepoID)
  923. } else {
  924. _, err = e.Exec("UPDATE `repository` SET num_issues = num_issues + 1 WHERE id = ?", opts.Issue.RepoID)
  925. }
  926. if err != nil {
  927. return err
  928. }
  929. if len(opts.LabelIDs) > 0 {
  930. // During the session, SQLite3 driver cannot handle retrieve objects after update something.
  931. // So we have to get all needed labels first.
  932. labels := make([]*Label, 0, len(opts.LabelIDs))
  933. if err = e.In("id", opts.LabelIDs).Find(&labels); err != nil {
  934. return fmt.Errorf("find all labels [label_ids: %v]: %v", opts.LabelIDs, err)
  935. }
  936. if err = opts.Issue.loadPoster(e); err != nil {
  937. return err
  938. }
  939. for _, label := range labels {
  940. // Silently drop invalid labels.
  941. if label.RepoID != opts.Repo.ID {
  942. continue
  943. }
  944. if err = opts.Issue.addLabel(e, label, opts.Issue.Poster); err != nil {
  945. return fmt.Errorf("addLabel [id: %d]: %v", label.ID, err)
  946. }
  947. }
  948. }
  949. if err = newIssueUsers(e, opts.Repo, opts.Issue); err != nil {
  950. return err
  951. }
  952. if len(opts.Attachments) > 0 {
  953. attachments, err := getAttachmentsByUUIDs(e, opts.Attachments)
  954. if err != nil {
  955. return fmt.Errorf("getAttachmentsByUUIDs [uuids: %v]: %v", opts.Attachments, err)
  956. }
  957. for i := 0; i < len(attachments); i++ {
  958. attachments[i].IssueID = opts.Issue.ID
  959. if _, err = e.ID(attachments[i].ID).Update(attachments[i]); err != nil {
  960. return fmt.Errorf("update attachment [id: %d]: %v", attachments[i].ID, err)
  961. }
  962. }
  963. }
  964. return opts.Issue.loadAttributes(e)
  965. }
  966. // NewIssue creates new issue with labels for repository.
  967. func NewIssue(repo *Repository, issue *Issue, labelIDs []int64, assigneeIDs []int64, uuids []string) (err error) {
  968. sess := x.NewSession()
  969. defer sess.Close()
  970. if err = sess.Begin(); err != nil {
  971. return err
  972. }
  973. if err = newIssue(sess, issue.Poster, NewIssueOptions{
  974. Repo: repo,
  975. Issue: issue,
  976. LabelIDs: labelIDs,
  977. Attachments: uuids,
  978. AssigneeIDs: assigneeIDs,
  979. }); err != nil {
  980. if IsErrUserDoesNotHaveAccessToRepo(err) {
  981. return err
  982. }
  983. return fmt.Errorf("newIssue: %v", err)
  984. }
  985. if err = sess.Commit(); err != nil {
  986. return fmt.Errorf("Commit: %v", err)
  987. }
  988. if err = NotifyWatchers(&Action{
  989. ActUserID: issue.Poster.ID,
  990. ActUser: issue.Poster,
  991. OpType: ActionCreateIssue,
  992. Content: fmt.Sprintf("%d|%s", issue.Index, issue.Title),
  993. RepoID: repo.ID,
  994. Repo: repo,
  995. IsPrivate: repo.IsPrivate,
  996. }); err != nil {
  997. log.Error(4, "NotifyWatchers: %v", err)
  998. }
  999. mode, _ := AccessLevel(issue.Poster, issue.Repo)
  1000. if err = PrepareWebhooks(repo, HookEventIssues, &api.IssuePayload{
  1001. Action: api.HookIssueOpened,
  1002. Index: issue.Index,
  1003. Issue: issue.APIFormat(),
  1004. Repository: repo.APIFormat(mode),
  1005. Sender: issue.Poster.APIFormat(),
  1006. }); err != nil {
  1007. log.Error(4, "PrepareWebhooks: %v", err)
  1008. } else {
  1009. go HookQueue.Add(issue.RepoID)
  1010. }
  1011. return nil
  1012. }
  1013. // GetIssueByIndex returns raw issue without loading attributes by index in a repository.
  1014. func GetIssueByIndex(repoID, index int64) (*Issue, error) {
  1015. issue := &Issue{
  1016. RepoID: repoID,
  1017. Index: index,
  1018. }
  1019. has, err := x.Get(issue)
  1020. if err != nil {
  1021. return nil, err
  1022. } else if !has {
  1023. return nil, ErrIssueNotExist{0, repoID, index}
  1024. }
  1025. return issue, nil
  1026. }
  1027. // GetIssueWithAttrsByIndex returns issue by index in a repository.
  1028. func GetIssueWithAttrsByIndex(repoID, index int64) (*Issue, error) {
  1029. issue, err := GetIssueByIndex(repoID, index)
  1030. if err != nil {
  1031. return nil, err
  1032. }
  1033. return issue, issue.LoadAttributes()
  1034. }
  1035. func getIssueByID(e Engine, id int64) (*Issue, error) {
  1036. issue := new(Issue)
  1037. has, err := e.ID(id).Get(issue)
  1038. if err != nil {
  1039. return nil, err
  1040. } else if !has {
  1041. return nil, ErrIssueNotExist{id, 0, 0}
  1042. }
  1043. return issue, nil
  1044. }
  1045. // GetIssueWithAttrsByID returns an issue with attributes by given ID.
  1046. func GetIssueWithAttrsByID(id int64) (*Issue, error) {
  1047. issue, err := getIssueByID(x, id)
  1048. if err != nil {
  1049. return nil, err
  1050. }
  1051. return issue, issue.loadAttributes(x)
  1052. }
  1053. // GetIssueByID returns an issue by given ID.
  1054. func GetIssueByID(id int64) (*Issue, error) {
  1055. return getIssueByID(x, id)
  1056. }
  1057. func getIssuesByIDs(e Engine, issueIDs []int64) ([]*Issue, error) {
  1058. issues := make([]*Issue, 0, 10)
  1059. return issues, e.In("id", issueIDs).Find(&issues)
  1060. }
  1061. func getIssueIDsByRepoID(e Engine, repoID int64) ([]int64, error) {
  1062. var ids = make([]int64, 0, 10)
  1063. err := e.Table("issue").Where("repo_id = ?", repoID).Find(&ids)
  1064. return ids, err
  1065. }
  1066. // GetIssueIDsByRepoID returns all issue ids by repo id
  1067. func GetIssueIDsByRepoID(repoID int64) ([]int64, error) {
  1068. return getIssueIDsByRepoID(x, repoID)
  1069. }
  1070. // GetIssuesByIDs return issues with the given IDs.
  1071. func GetIssuesByIDs(issueIDs []int64) ([]*Issue, error) {
  1072. return getIssuesByIDs(x, issueIDs)
  1073. }
  1074. // IssuesOptions represents options of an issue.
  1075. type IssuesOptions struct {
  1076. RepoIDs []int64 // include all repos if empty
  1077. AssigneeID int64
  1078. PosterID int64
  1079. MentionedID int64
  1080. MilestoneID int64
  1081. Page int
  1082. PageSize int
  1083. IsClosed util.OptionalBool
  1084. IsPull util.OptionalBool
  1085. LabelIDs []int64
  1086. SortType string
  1087. IssueIDs []int64
  1088. }
  1089. // sortIssuesSession sort an issues-related session based on the provided
  1090. // sortType string
  1091. func sortIssuesSession(sess *xorm.Session, sortType string) {
  1092. switch sortType {
  1093. case "oldest":
  1094. sess.Asc("issue.created_unix")
  1095. case "recentupdate":
  1096. sess.Desc("issue.updated_unix")
  1097. case "leastupdate":
  1098. sess.Asc("issue.updated_unix")
  1099. case "mostcomment":
  1100. sess.Desc("issue.num_comments")
  1101. case "leastcomment":
  1102. sess.Asc("issue.num_comments")
  1103. case "priority":
  1104. sess.Desc("issue.priority")
  1105. default:
  1106. sess.Desc("issue.created_unix")
  1107. }
  1108. }
  1109. func (opts *IssuesOptions) setupSession(sess *xorm.Session) error {
  1110. if opts.Page >= 0 && opts.PageSize > 0 {
  1111. var start int
  1112. if opts.Page == 0 {
  1113. start = 0
  1114. } else {
  1115. start = (opts.Page - 1) * opts.PageSize
  1116. }
  1117. sess.Limit(opts.PageSize, start)
  1118. }
  1119. if len(opts.IssueIDs) > 0 {
  1120. sess.In("issue.id", opts.IssueIDs)
  1121. }
  1122. if len(opts.RepoIDs) > 0 {
  1123. // In case repository IDs are provided but actually no repository has issue.
  1124. sess.In("issue.repo_id", opts.RepoIDs)
  1125. }
  1126. switch opts.IsClosed {
  1127. case util.OptionalBoolTrue:
  1128. sess.And("issue.is_closed=?", true)
  1129. case util.OptionalBoolFalse:
  1130. sess.And("issue.is_closed=?", false)
  1131. }
  1132. if opts.AssigneeID > 0 {
  1133. sess.Join("INNER", "issue_assignees", "issue.id = issue_assignees.issue_id").
  1134. And("issue_assignees.assignee_id = ?", opts.AssigneeID)
  1135. }
  1136. if opts.PosterID > 0 {
  1137. sess.And("issue.poster_id=?", opts.PosterID)
  1138. }
  1139. if opts.MentionedID > 0 {
  1140. sess.Join("INNER", "issue_user", "issue.id = issue_user.issue_id").
  1141. And("issue_user.is_mentioned = ?", true).
  1142. And("issue_user.uid = ?", opts.MentionedID)
  1143. }
  1144. if opts.MilestoneID > 0 {
  1145. sess.And("issue.milestone_id=?", opts.MilestoneID)
  1146. }
  1147. switch opts.IsPull {
  1148. case util.OptionalBoolTrue:
  1149. sess.And("issue.is_pull=?", true)
  1150. case util.OptionalBoolFalse:
  1151. sess.And("issue.is_pull=?", false)
  1152. }
  1153. if opts.LabelIDs != nil {
  1154. for i, labelID := range opts.LabelIDs {
  1155. sess.Join("INNER", fmt.Sprintf("issue_label il%d", i),
  1156. fmt.Sprintf("issue.id = il%[1]d.issue_id AND il%[1]d.label_id = %[2]d", i, labelID))
  1157. }
  1158. }
  1159. return nil
  1160. }
  1161. // CountIssuesByRepo map from repoID to number of issues matching the options
  1162. func CountIssuesByRepo(opts *IssuesOptions) (map[int64]int64, error) {
  1163. sess := x.NewSession()
  1164. defer sess.Close()
  1165. if err := opts.setupSession(sess); err != nil {
  1166. return nil, err
  1167. }
  1168. countsSlice := make([]*struct {
  1169. RepoID int64
  1170. Count int64
  1171. }, 0, 10)
  1172. if err := sess.GroupBy("issue.repo_id").
  1173. Select("issue.repo_id AS repo_id, COUNT(*) AS count").
  1174. Table("issue").
  1175. Find(&countsSlice); err != nil {
  1176. return nil, err
  1177. }
  1178. countMap := make(map[int64]int64, len(countsSlice))
  1179. for _, c := range countsSlice {
  1180. countMap[c.RepoID] = c.Count
  1181. }
  1182. return countMap, nil
  1183. }
  1184. // Issues returns a list of issues by given conditions.
  1185. func Issues(opts *IssuesOptions) ([]*Issue, error) {
  1186. sess := x.NewSession()
  1187. defer sess.Close()
  1188. if err := opts.setupSession(sess); err != nil {
  1189. return nil, err
  1190. }
  1191. sortIssuesSession(sess, opts.SortType)
  1192. issues := make([]*Issue, 0, setting.UI.IssuePagingNum)
  1193. if err := sess.Find(&issues); err != nil {
  1194. return nil, fmt.Errorf("Find: %v", err)
  1195. }
  1196. if err := IssueList(issues).LoadAttributes(); err != nil {
  1197. return nil, fmt.Errorf("LoadAttributes: %v", err)
  1198. }
  1199. return issues, nil
  1200. }
  1201. // GetParticipantsByIssueID returns all users who are participated in comments of an issue.
  1202. func GetParticipantsByIssueID(issueID int64) ([]*User, error) {
  1203. return getParticipantsByIssueID(x, issueID)
  1204. }
  1205. func getParticipantsByIssueID(e Engine, issueID int64) ([]*User, error) {
  1206. userIDs := make([]int64, 0, 5)
  1207. if err := e.Table("comment").Cols("poster_id").
  1208. Where("`comment`.issue_id = ?", issueID).
  1209. And("`comment`.type = ?", CommentTypeComment).
  1210. And("`user`.is_active = ?", true).
  1211. And("`user`.prohibit_login = ?", false).
  1212. Join("INNER", "`user`", "`user`.id = `comment`.poster_id").
  1213. Distinct("poster_id").
  1214. Find(&userIDs); err != nil {
  1215. return nil, fmt.Errorf("get poster IDs: %v", err)
  1216. }
  1217. if len(userIDs) == 0 {
  1218. return nil, nil
  1219. }
  1220. users := make([]*User, 0, len(userIDs))
  1221. return users, e.In("id", userIDs).Find(&users)
  1222. }
  1223. // UpdateIssueMentions extracts mentioned people from content and
  1224. // updates issue-user relations for them.
  1225. func UpdateIssueMentions(e Engine, issueID int64, mentions []string) error {
  1226. if len(mentions) == 0 {
  1227. return nil
  1228. }
  1229. for i := range mentions {
  1230. mentions[i] = strings.ToLower(mentions[i])
  1231. }
  1232. users := make([]*User, 0, len(mentions))
  1233. if err := e.In("lower_name", mentions).Asc("lower_name").Find(&users); err != nil {
  1234. return fmt.Errorf("find mentioned users: %v", err)
  1235. }
  1236. ids := make([]int64, 0, len(mentions))
  1237. for _, user := range users {
  1238. ids = append(ids, user.ID)
  1239. if !user.IsOrganization() || user.NumMembers == 0 {
  1240. continue
  1241. }
  1242. memberIDs := make([]int64, 0, user.NumMembers)
  1243. orgUsers, err := getOrgUsersByOrgID(e, user.ID)
  1244. if err != nil {
  1245. return fmt.Errorf("GetOrgUsersByOrgID [%d]: %v", user.ID, err)
  1246. }
  1247. for _, orgUser := range orgUsers {
  1248. memberIDs = append(memberIDs, orgUser.ID)
  1249. }
  1250. ids = append(ids, memberIDs...)
  1251. }
  1252. if err := UpdateIssueUsersByMentions(e, issueID, ids); err != nil {
  1253. return fmt.Errorf("UpdateIssueUsersByMentions: %v", err)
  1254. }
  1255. return nil
  1256. }
  1257. // IssueStats represents issue statistic information.
  1258. type IssueStats struct {
  1259. OpenCount, ClosedCount int64
  1260. YourRepositoriesCount int64
  1261. AssignCount int64
  1262. CreateCount int64
  1263. MentionCount int64
  1264. }
  1265. // Filter modes.
  1266. const (
  1267. FilterModeAll = iota
  1268. FilterModeAssign
  1269. FilterModeCreate
  1270. FilterModeMention
  1271. )
  1272. func parseCountResult(results []map[string][]byte) int64 {
  1273. if len(results) == 0 {
  1274. return 0
  1275. }
  1276. for _, result := range results[0] {
  1277. return com.StrTo(string(result)).MustInt64()
  1278. }
  1279. return 0
  1280. }
  1281. // IssueStatsOptions contains parameters accepted by GetIssueStats.
  1282. type IssueStatsOptions struct {
  1283. RepoID int64
  1284. Labels string
  1285. MilestoneID int64
  1286. AssigneeID int64
  1287. MentionedID int64
  1288. PosterID int64
  1289. IsPull util.OptionalBool
  1290. IssueIDs []int64
  1291. }
  1292. // GetIssueStats returns issue statistic information by given conditions.
  1293. func GetIssueStats(opts *IssueStatsOptions) (*IssueStats, error) {
  1294. stats := &IssueStats{}
  1295. countSession := func(opts *IssueStatsOptions) *xorm.Session {
  1296. sess := x.
  1297. Where("issue.repo_id = ?", opts.RepoID)
  1298. if len(opts.IssueIDs) > 0 {
  1299. sess.In("issue.id", opts.IssueIDs)
  1300. }
  1301. if len(opts.Labels) > 0 && opts.Labels != "0" {
  1302. labelIDs, err := base.StringsToInt64s(strings.Split(opts.Labels, ","))
  1303. if err != nil {
  1304. log.Warn("Malformed Labels argument: %s", opts.Labels)
  1305. } else {
  1306. for i, labelID := range labelIDs {
  1307. sess.Join("INNER", fmt.Sprintf("issue_label il%d", i),
  1308. fmt.Sprintf("issue.id = il%[1]d.issue_id AND il%[1]d.label_id = %[2]d", i, labelID))
  1309. }
  1310. }
  1311. }
  1312. if opts.MilestoneID > 0 {
  1313. sess.And("issue.milestone_id = ?", opts.MilestoneID)
  1314. }
  1315. if opts.AssigneeID > 0 {
  1316. sess.Join("INNER", "issue_assignees", "issue.id = issue_assignees.issue_id").
  1317. And("issue_assignees.assignee_id = ?", opts.AssigneeID)
  1318. }
  1319. if opts.PosterID > 0 {
  1320. sess.And("issue.poster_id = ?", opts.PosterID)
  1321. }
  1322. if opts.MentionedID > 0 {
  1323. sess.Join("INNER", "issue_user", "issue.id = issue_user.issue_id").
  1324. And("issue_user.uid = ?", opts.MentionedID).
  1325. And("issue_user.is_mentioned = ?", true)
  1326. }
  1327. switch opts.IsPull {
  1328. case util.OptionalBoolTrue:
  1329. sess.And("issue.is_pull=?", true)
  1330. case util.OptionalBoolFalse:
  1331. sess.And("issue.is_pull=?", false)
  1332. }
  1333. return sess
  1334. }
  1335. var err error
  1336. stats.OpenCount, err = countSession(opts).
  1337. And("issue.is_closed = ?", false).
  1338. Count(new(Issue))
  1339. if err != nil {
  1340. return stats, err
  1341. }
  1342. stats.ClosedCount, err = countSession(opts).
  1343. And("issue.is_closed = ?", true).
  1344. Count(new(Issue))
  1345. return stats, err
  1346. }
  1347. // UserIssueStatsOptions contains parameters accepted by GetUserIssueStats.
  1348. type UserIssueStatsOptions struct {
  1349. UserID int64
  1350. RepoID int64
  1351. UserRepoIDs []int64
  1352. FilterMode int
  1353. IsPull bool
  1354. IsClosed bool
  1355. }
  1356. // GetUserIssueStats returns issue statistic information for dashboard by given conditions.
  1357. func GetUserIssueStats(opts UserIssueStatsOptions) (*IssueStats, error) {
  1358. var err error
  1359. stats := &IssueStats{}
  1360. cond := builder.NewCond()
  1361. cond = cond.And(builder.Eq{"issue.is_pull": opts.IsPull})
  1362. if opts.RepoID > 0 {
  1363. cond = cond.And(builder.Eq{"issue.repo_id": opts.RepoID})
  1364. }
  1365. switch opts.FilterMode {
  1366. case FilterModeAll:
  1367. stats.OpenCount, err = x.Where(cond).And("is_closed = ?", false).
  1368. And(builder.In("issue.repo_id", opts.UserRepoIDs)).
  1369. Count(new(Issue))
  1370. if err != nil {
  1371. return nil, err
  1372. }
  1373. stats.ClosedCount, err = x.Where(cond).And("is_closed = ?", true).
  1374. And(builder.In("issue.repo_id", opts.UserRepoIDs)).
  1375. Count(new(Issue))
  1376. if err != nil {
  1377. return nil, err
  1378. }
  1379. case FilterModeAssign:
  1380. stats.OpenCount, err = x.Where(cond).And("is_closed = ?", false).
  1381. Join("INNER", "issue_assignees", "issue.id = issue_assignees.issue_id").
  1382. And("issue_assignees.assignee_id = ?", opts.UserID).
  1383. Count(new(Issue))
  1384. if err != nil {
  1385. return nil, err
  1386. }
  1387. stats.ClosedCount, err = x.Where(cond).And("is_closed = ?", true).
  1388. Join("INNER", "issue_assignees", "issue.id = issue_assignees.issue_id").
  1389. And("issue_assignees.assignee_id = ?", opts.UserID).
  1390. Count(new(Issue))
  1391. if err != nil {
  1392. return nil, err
  1393. }
  1394. case FilterModeCreate:
  1395. stats.OpenCount, err = x.Where(cond).And("is_closed = ?", false).
  1396. And("poster_id = ?", opts.UserID).
  1397. Count(new(Issue))
  1398. if err != nil {
  1399. return nil, err
  1400. }
  1401. stats.ClosedCount, err = x.Where(cond).And("is_closed = ?", true).
  1402. And("poster_id = ?", opts.UserID).
  1403. Count(new(Issue))
  1404. if err != nil {
  1405. return nil, err
  1406. }
  1407. }
  1408. cond = cond.And(builder.Eq{"issue.is_closed": opts.IsClosed})
  1409. stats.AssignCount, err = x.Where(cond).
  1410. Join("INNER", "issue_assignees", "issue.id = issue_assignees.issue_id").
  1411. And("issue_assignees.assignee_id = ?", opts.UserID).
  1412. Count(new(Issue))
  1413. if err != nil {
  1414. return nil, err
  1415. }
  1416. stats.CreateCount, err = x.Where(cond).
  1417. And("poster_id = ?", opts.UserID).
  1418. Count(new(Issue))
  1419. if err != nil {
  1420. return nil, err
  1421. }
  1422. stats.YourRepositoriesCount, err = x.Where(cond).
  1423. And(builder.In("issue.repo_id", opts.UserRepoIDs)).
  1424. Count(new(Issue))
  1425. if err != nil {
  1426. return nil, err
  1427. }
  1428. return stats, nil
  1429. }
  1430. // GetRepoIssueStats returns number of open and closed repository issues by given filter mode.
  1431. func GetRepoIssueStats(repoID, uid int64, filterMode int, isPull bool) (numOpen int64, numClosed int64) {
  1432. countSession := func(isClosed, isPull bool, repoID int64) *xorm.Session {
  1433. sess := x.
  1434. Where("is_closed = ?", isClosed).
  1435. And("is_pull = ?", isPull).
  1436. And("repo_id = ?", repoID)
  1437. return sess
  1438. }
  1439. openCountSession := countSession(false, isPull, repoID)
  1440. closedCountSession := countSession(true, isPull, repoID)
  1441. switch filterMode {
  1442. case FilterModeAssign:
  1443. openCountSession.Join("INNER", "issue_assignees", "issue.id = issue_assignees.issue_id").
  1444. And("issue_assignees.assignee_id = ?", uid)
  1445. closedCountSession.Join("INNER", "issue_assignees", "issue.id = issue_assignees.issue_id").
  1446. And("issue_assignees.assignee_id = ?", uid)
  1447. case FilterModeCreate:
  1448. openCountSession.And("poster_id = ?", uid)
  1449. closedCountSession.And("poster_id = ?", uid)
  1450. }
  1451. openResult, _ := openCountSession.Count(new(Issue))
  1452. closedResult, _ := closedCountSession.Count(new(Issue))
  1453. return openResult, closedResult
  1454. }
  1455. func updateIssue(e Engine, issue *Issue) error {
  1456. _, err := e.ID(issue.ID).AllCols().Update(issue)
  1457. if err != nil {
  1458. return err
  1459. }
  1460. return nil
  1461. }
  1462. // UpdateIssue updates all fields of given issue.
  1463. func UpdateIssue(issue *Issue) error {
  1464. return updateIssue(x, issue)
  1465. }
  1466. // UpdateIssueDeadline updates an issue deadline and adds comments. Setting a deadline to 0 means deleting it.
  1467. func UpdateIssueDeadline(issue *Issue, deadlineUnix util.TimeStamp, doer *User) (err error) {
  1468. // if the deadline hasn't changed do nothing
  1469. if issue.DeadlineUnix == deadlineUnix {
  1470. return nil
  1471. }
  1472. sess := x.NewSession()
  1473. defer sess.Close()
  1474. if err := sess.Begin(); err != nil {
  1475. return err
  1476. }
  1477. // Update the deadline
  1478. if err = updateIssueCols(sess, &Issue{ID: issue.ID, DeadlineUnix: deadlineUnix}, "deadline_unix"); err != nil {
  1479. return err
  1480. }
  1481. // Make the comment
  1482. if _, err = createDeadlineComment(sess, doer, issue, deadlineUnix); err != nil {
  1483. return fmt.Errorf("createRemovedDueDateComment: %v", err)
  1484. }
  1485. return sess.Commit()
  1486. }
  1487. // Get Blocked By Dependencies, aka all issues this issue is blocked by.
  1488. func (issue *Issue) getBlockedByDependencies(e Engine) (issueDeps []*Issue, err error) {
  1489. return issueDeps, e.
  1490. Table("issue_dependency").
  1491. Select("issue.*").
  1492. Join("INNER", "issue", "issue.id = issue_dependency.dependency_id").
  1493. Where("issue_id = ?", issue.ID).
  1494. Find(&issueDeps)
  1495. }
  1496. // Get Blocking Dependencies, aka all issues this issue blocks.
  1497. func (issue *Issue) getBlockingDependencies(e Engine) (issueDeps []*Issue, err error) {
  1498. return issueDeps, e.
  1499. Table("issue_dependency").
  1500. Select("issue.*").
  1501. Join("INNER", "issue", "issue.id = issue_dependency.issue_id").
  1502. Where("dependency_id = ?", issue.ID).
  1503. Find(&issueDeps)
  1504. }
  1505. // BlockedByDependencies finds all Dependencies an issue is blocked by
  1506. func (issue *Issue) BlockedByDependencies() ([]*Issue, error) {
  1507. return issue.getBlockedByDependencies(x)
  1508. }
  1509. // BlockingDependencies returns all blocking dependencies, aka all other issues a given issue blocks
  1510. func (issue *Issue) BlockingDependencies() ([]*Issue, error) {
  1511. return issue.getBlockingDependencies(x)
  1512. }