issue.go 42 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627
  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. "bytes"
  7. "errors"
  8. "fmt"
  9. "io"
  10. "mime/multipart"
  11. "os"
  12. "path"
  13. "strconv"
  14. "strings"
  15. "time"
  16. "github.com/Unknwon/com"
  17. "github.com/go-xorm/xorm"
  18. "github.com/gogits/gogs/modules/base"
  19. "github.com/gogits/gogs/modules/log"
  20. "github.com/gogits/gogs/modules/setting"
  21. gouuid "github.com/gogits/gogs/modules/uuid"
  22. )
  23. var (
  24. ErrWrongIssueCounter = errors.New("Invalid number of issues for this milestone")
  25. ErrAttachmentNotLinked = errors.New("Attachment does not belong to this issue")
  26. ErrMissingIssueNumber = errors.New("No issue number specified")
  27. )
  28. // Issue represents an issue or pull request of repository.
  29. type Issue struct {
  30. ID int64 `xorm:"pk autoincr"`
  31. RepoID int64 `xorm:"INDEX"`
  32. Index int64 // Index in one repository.
  33. Name string
  34. Repo *Repository `xorm:"-"`
  35. PosterID int64
  36. Poster *User `xorm:"-"`
  37. Labels []*Label `xorm:"-"`
  38. MilestoneID int64
  39. Milestone *Milestone `xorm:"-"`
  40. AssigneeID int64
  41. Assignee *User `xorm:"-"`
  42. IsRead bool `xorm:"-"`
  43. IsPull bool // Indicates whether is a pull request or not.
  44. IsClosed bool
  45. Content string `xorm:"TEXT"`
  46. RenderedContent string `xorm:"-"`
  47. Priority int
  48. NumComments int
  49. Deadline time.Time
  50. Created time.Time `xorm:"CREATED"`
  51. Updated time.Time `xorm:"UPDATED"`
  52. Attachments []*Attachment `xorm:"-"`
  53. Comments []*Comment `xorm:"-"`
  54. }
  55. func (i *Issue) AfterSet(colName string, _ xorm.Cell) {
  56. var err error
  57. switch colName {
  58. case "id":
  59. i.Attachments, err = GetAttachmentsByIssueID(i.ID)
  60. if err != nil {
  61. log.Error(3, "GetAttachmentsByIssueID[%d]: %v", i.ID, err)
  62. }
  63. i.Comments, err = GetCommentsByIssueID(i.ID)
  64. if err != nil {
  65. log.Error(3, "GetCommentsByIssueID[%d]: %v", i.ID, err)
  66. }
  67. case "milestone_id":
  68. if i.MilestoneID == 0 {
  69. return
  70. }
  71. i.Milestone, err = GetMilestoneByID(i.MilestoneID)
  72. if err != nil {
  73. log.Error(3, "GetMilestoneById[%d]: %v", i.ID, err)
  74. }
  75. case "assignee_id":
  76. if i.AssigneeID == 0 {
  77. return
  78. }
  79. i.Assignee, err = GetUserByID(i.AssigneeID)
  80. if err != nil {
  81. log.Error(3, "GetUserByID[%d]: %v", i.ID, err)
  82. }
  83. case "created":
  84. now := time.Now()
  85. i.Created = i.Created.Add(now.Sub(now.UTC()))
  86. }
  87. }
  88. // HashTag returns unique hash tag for issue.
  89. func (i *Issue) HashTag() string {
  90. return "issue-" + com.ToStr(i.ID)
  91. }
  92. // IsPoster returns true if given user by ID is the poster.
  93. func (i *Issue) IsPoster(uid int64) bool {
  94. return i.PosterID == uid
  95. }
  96. func (i *Issue) GetPoster() (err error) {
  97. i.Poster, err = GetUserByID(i.PosterID)
  98. if IsErrUserNotExist(err) {
  99. i.PosterID = -1
  100. i.Poster = NewFakeUser()
  101. return nil
  102. }
  103. return err
  104. }
  105. func (i *Issue) hasLabel(e Engine, labelID int64) bool {
  106. return hasIssueLabel(e, i.ID, labelID)
  107. }
  108. // HasLabel returns true if issue has been labeled by given ID.
  109. func (i *Issue) HasLabel(labelID int64) bool {
  110. return i.hasLabel(x, labelID)
  111. }
  112. func (i *Issue) addLabel(e *xorm.Session, label *Label) error {
  113. return newIssueLabel(e, i, label)
  114. }
  115. // AddLabel adds new label to issue by given ID.
  116. func (i *Issue) AddLabel(label *Label) (err error) {
  117. sess := x.NewSession()
  118. defer sessionRelease(sess)
  119. if err = sess.Begin(); err != nil {
  120. return err
  121. }
  122. if err = i.addLabel(sess, label); err != nil {
  123. return err
  124. }
  125. return sess.Commit()
  126. }
  127. func (i *Issue) getLabels(e Engine) (err error) {
  128. if len(i.Labels) > 0 {
  129. return nil
  130. }
  131. i.Labels, err = getLabelsByIssueID(e, i.ID)
  132. if err != nil {
  133. return fmt.Errorf("getLabelsByIssueID: %v", err)
  134. }
  135. return nil
  136. }
  137. // GetLabels retrieves all labels of issue and assign to corresponding field.
  138. func (i *Issue) GetLabels() error {
  139. return i.getLabels(x)
  140. }
  141. func (i *Issue) removeLabel(e *xorm.Session, label *Label) error {
  142. return deleteIssueLabel(e, i, label)
  143. }
  144. // RemoveLabel removes a label from issue by given ID.
  145. func (i *Issue) RemoveLabel(label *Label) (err error) {
  146. sess := x.NewSession()
  147. defer sessionRelease(sess)
  148. if err = sess.Begin(); err != nil {
  149. return err
  150. }
  151. if err = i.removeLabel(sess, label); err != nil {
  152. return err
  153. }
  154. return sess.Commit()
  155. }
  156. func (i *Issue) ClearLabels() (err error) {
  157. sess := x.NewSession()
  158. defer sessionRelease(sess)
  159. if err = sess.Begin(); err != nil {
  160. return err
  161. }
  162. if err = i.getLabels(sess); err != nil {
  163. return err
  164. }
  165. for idx := range i.Labels {
  166. if err = i.removeLabel(sess, i.Labels[idx]); err != nil {
  167. return err
  168. }
  169. }
  170. return sess.Commit()
  171. }
  172. func (i *Issue) GetAssignee() (err error) {
  173. if i.AssigneeID == 0 || i.Assignee != nil {
  174. return nil
  175. }
  176. i.Assignee, err = GetUserByID(i.AssigneeID)
  177. if IsErrUserNotExist(err) {
  178. return nil
  179. }
  180. return err
  181. }
  182. // ReadBy sets issue to be read by given user.
  183. func (i *Issue) ReadBy(uid int64) error {
  184. return UpdateIssueUserByRead(uid, i.ID)
  185. }
  186. func (i *Issue) changeStatus(e *xorm.Session, doer *User, isClosed bool) (err error) {
  187. if i.IsClosed == isClosed {
  188. return nil
  189. }
  190. i.IsClosed = isClosed
  191. if err = updateIssue(e, i); err != nil {
  192. return err
  193. } else if err = updateIssueUsersByStatus(e, i.ID, isClosed); err != nil {
  194. return err
  195. }
  196. // Update labels.
  197. if err = i.getLabels(e); err != nil {
  198. return err
  199. }
  200. for idx := range i.Labels {
  201. if i.IsClosed {
  202. i.Labels[idx].NumClosedIssues++
  203. } else {
  204. i.Labels[idx].NumClosedIssues--
  205. }
  206. if err = updateLabel(e, i.Labels[idx]); err != nil {
  207. return err
  208. }
  209. }
  210. // Update milestone.
  211. if err = changeMilestoneIssueStats(e, i); err != nil {
  212. return err
  213. }
  214. // New action comment.
  215. if _, err = createStatusComment(e, doer, i.Repo, i); err != nil {
  216. return err
  217. }
  218. return nil
  219. }
  220. // ChangeStatus changes issue status to open/closed.
  221. func (i *Issue) ChangeStatus(doer *User, isClosed bool) (err error) {
  222. sess := x.NewSession()
  223. defer sessionRelease(sess)
  224. if err = sess.Begin(); err != nil {
  225. return err
  226. }
  227. if err = i.changeStatus(sess, doer, isClosed); err != nil {
  228. return err
  229. }
  230. return sess.Commit()
  231. }
  232. // CreateIssue creates new issue with labels for repository.
  233. func NewIssue(repo *Repository, issue *Issue, labelIDs []int64, uuids []string) (err error) {
  234. // Check attachments.
  235. attachments := make([]*Attachment, 0, len(uuids))
  236. for _, uuid := range uuids {
  237. attach, err := GetAttachmentByUUID(uuid)
  238. if err != nil {
  239. if IsErrAttachmentNotExist(err) {
  240. continue
  241. }
  242. return fmt.Errorf("GetAttachmentByUUID[%s]: %v", uuid, err)
  243. }
  244. attachments = append(attachments, attach)
  245. }
  246. sess := x.NewSession()
  247. defer sessionRelease(sess)
  248. if err = sess.Begin(); err != nil {
  249. return err
  250. }
  251. if _, err = sess.Insert(issue); err != nil {
  252. return err
  253. } else if _, err = sess.Exec("UPDATE `repository` SET num_issues=num_issues+1 WHERE id=?", issue.RepoID); err != nil {
  254. return err
  255. }
  256. var label *Label
  257. for _, id := range labelIDs {
  258. if id == 0 {
  259. continue
  260. }
  261. label, err = getLabelByID(sess, id)
  262. if err != nil {
  263. return err
  264. }
  265. if err = issue.addLabel(sess, label); err != nil {
  266. return fmt.Errorf("addLabel: %v", err)
  267. }
  268. }
  269. if issue.MilestoneID > 0 {
  270. if err = changeMilestoneAssign(sess, 0, issue); err != nil {
  271. return err
  272. }
  273. }
  274. if err = newIssueUsers(sess, repo, issue); err != nil {
  275. return err
  276. }
  277. for i := range attachments {
  278. attachments[i].IssueID = issue.ID
  279. // No assign value could be 0, so ignore AllCols().
  280. if _, err = sess.Id(attachments[i].ID).Update(attachments[i]); err != nil {
  281. return fmt.Errorf("update attachment[%d]: %v", attachments[i].ID, err)
  282. }
  283. }
  284. // Notify watchers.
  285. act := &Action{
  286. ActUserID: issue.Poster.Id,
  287. ActUserName: issue.Poster.Name,
  288. ActEmail: issue.Poster.Email,
  289. OpType: CREATE_ISSUE,
  290. Content: fmt.Sprintf("%d|%s", issue.Index, issue.Name),
  291. RepoID: repo.ID,
  292. RepoUserName: repo.Owner.Name,
  293. RepoName: repo.Name,
  294. IsPrivate: repo.IsPrivate,
  295. }
  296. if err = notifyWatchers(sess, act); err != nil {
  297. return err
  298. }
  299. return sess.Commit()
  300. }
  301. // GetIssueByRef returns an Issue specified by a GFM reference.
  302. // See https://help.github.com/articles/writing-on-github#references for more information on the syntax.
  303. func GetIssueByRef(ref string) (issue *Issue, err error) {
  304. var issueNumber int64
  305. var repo *Repository
  306. n := strings.IndexByte(ref, byte('#'))
  307. if n == -1 {
  308. return nil, ErrMissingIssueNumber
  309. }
  310. if issueNumber, err = strconv.ParseInt(ref[n+1:], 10, 64); err != nil {
  311. return
  312. }
  313. if repo, err = GetRepositoryByRef(ref[:n]); err != nil {
  314. return
  315. }
  316. return GetIssueByIndex(repo.ID, issueNumber)
  317. }
  318. // GetIssueByIndex returns issue by given index in repository.
  319. func GetIssueByIndex(repoID, index int64) (*Issue, error) {
  320. issue := &Issue{
  321. RepoID: repoID,
  322. Index: index,
  323. }
  324. has, err := x.Get(issue)
  325. if err != nil {
  326. return nil, err
  327. } else if !has {
  328. return nil, ErrIssueNotExist{0, repoID, index}
  329. }
  330. return issue, nil
  331. }
  332. // GetIssueByID returns an issue by given ID.
  333. func GetIssueByID(id int64) (*Issue, error) {
  334. issue := new(Issue)
  335. has, err := x.Id(id).Get(issue)
  336. if err != nil {
  337. return nil, err
  338. } else if !has {
  339. return nil, ErrIssueNotExist{id, 0, 0}
  340. }
  341. return issue, nil
  342. }
  343. // Issues returns a list of issues by given conditions.
  344. func Issues(uid, assigneeID, repoID, posterID, milestoneID int64, page int, isClosed, isMention bool, labels, sortType string) ([]*Issue, error) {
  345. sess := x.Limit(setting.IssuePagingNum, (page-1)*setting.IssuePagingNum)
  346. if repoID > 0 {
  347. sess.Where("issue.repo_id=?", repoID).And("issue.is_closed=?", isClosed)
  348. } else {
  349. sess.Where("issue.is_closed=?", isClosed)
  350. }
  351. if assigneeID > 0 {
  352. sess.And("issue.assignee_id=?", assigneeID)
  353. } else if posterID > 0 {
  354. sess.And("issue.poster_id=?", posterID)
  355. }
  356. if milestoneID > 0 {
  357. sess.And("issue.milestone_id=?", milestoneID)
  358. }
  359. switch sortType {
  360. case "oldest":
  361. sess.Asc("created")
  362. case "recentupdate":
  363. sess.Desc("updated")
  364. case "leastupdate":
  365. sess.Asc("updated")
  366. case "mostcomment":
  367. sess.Desc("num_comments")
  368. case "leastcomment":
  369. sess.Asc("num_comments")
  370. case "priority":
  371. sess.Desc("priority")
  372. default:
  373. sess.Desc("created")
  374. }
  375. labelIDs := base.StringsToInt64s(strings.Split(labels, ","))
  376. if len(labelIDs) > 0 {
  377. validJoin := false
  378. queryStr := "issue.id=issue_label.issue_id"
  379. for _, id := range labelIDs {
  380. if id == 0 {
  381. continue
  382. }
  383. validJoin = true
  384. queryStr += " AND issue_label.label_id=" + com.ToStr(id)
  385. }
  386. if validJoin {
  387. sess.Join("INNER", "issue_label", queryStr)
  388. }
  389. }
  390. if isMention {
  391. queryStr := "issue.id=issue_user.issue_id AND issue_user.is_mentioned=1"
  392. if uid > 0 {
  393. queryStr += " AND issue_user.uid=" + com.ToStr(uid)
  394. }
  395. sess.Join("INNER", "issue_user", queryStr)
  396. }
  397. issues := make([]*Issue, 0, setting.IssuePagingNum)
  398. return issues, sess.Find(&issues)
  399. }
  400. type IssueStatus int
  401. const (
  402. IS_OPEN = iota + 1
  403. IS_CLOSE
  404. )
  405. // GetIssueCountByPoster returns number of issues of repository by poster.
  406. func GetIssueCountByPoster(uid, rid int64, isClosed bool) int64 {
  407. count, _ := x.Where("repo_id=?", rid).And("poster_id=?", uid).And("is_closed=?", isClosed).Count(new(Issue))
  408. return count
  409. }
  410. // .___ ____ ___
  411. // | | ______ ________ __ ____ | | \______ ___________
  412. // | |/ ___// ___/ | \_/ __ \| | / ___// __ \_ __ \
  413. // | |\___ \ \___ \| | /\ ___/| | /\___ \\ ___/| | \/
  414. // |___/____ >____ >____/ \___ >______//____ >\___ >__|
  415. // \/ \/ \/ \/ \/
  416. // IssueUser represents an issue-user relation.
  417. type IssueUser struct {
  418. ID int64 `xorm:"pk autoincr"`
  419. UID int64 `xorm:"uid INDEX"` // User ID.
  420. IssueID int64
  421. RepoID int64 `xorm:"INDEX"`
  422. MilestoneID int64
  423. IsRead bool
  424. IsAssigned bool
  425. IsMentioned bool
  426. IsPoster bool
  427. IsClosed bool
  428. }
  429. func newIssueUsers(e *xorm.Session, repo *Repository, issue *Issue) error {
  430. users, err := repo.GetAssignees()
  431. if err != nil {
  432. return err
  433. }
  434. iu := &IssueUser{
  435. IssueID: issue.ID,
  436. RepoID: repo.ID,
  437. }
  438. // Poster can be anyone.
  439. isNeedAddPoster := true
  440. for _, u := range users {
  441. iu.ID = 0
  442. iu.UID = u.Id
  443. iu.IsPoster = iu.UID == issue.PosterID
  444. if isNeedAddPoster && iu.IsPoster {
  445. isNeedAddPoster = false
  446. }
  447. iu.IsAssigned = iu.UID == issue.AssigneeID
  448. if _, err = e.Insert(iu); err != nil {
  449. return err
  450. }
  451. }
  452. if isNeedAddPoster {
  453. iu.ID = 0
  454. iu.UID = issue.PosterID
  455. iu.IsPoster = true
  456. if _, err = e.Insert(iu); err != nil {
  457. return err
  458. }
  459. }
  460. return nil
  461. }
  462. // NewIssueUsers adds new issue-user relations for new issue of repository.
  463. func NewIssueUsers(repo *Repository, issue *Issue) (err error) {
  464. sess := x.NewSession()
  465. defer sessionRelease(sess)
  466. if err = sess.Begin(); err != nil {
  467. return err
  468. }
  469. if err = newIssueUsers(sess, repo, issue); err != nil {
  470. return err
  471. }
  472. return sess.Commit()
  473. }
  474. // PairsContains returns true when pairs list contains given issue.
  475. func PairsContains(ius []*IssueUser, issueId, uid int64) int {
  476. for i := range ius {
  477. if ius[i].IssueID == issueId &&
  478. ius[i].UID == uid {
  479. return i
  480. }
  481. }
  482. return -1
  483. }
  484. // GetIssueUsers returns issue-user pairs by given repository and user.
  485. func GetIssueUsers(rid, uid int64, isClosed bool) ([]*IssueUser, error) {
  486. ius := make([]*IssueUser, 0, 10)
  487. err := x.Where("is_closed=?", isClosed).Find(&ius, &IssueUser{RepoID: rid, UID: uid})
  488. return ius, err
  489. }
  490. // GetIssueUserPairsByRepoIds returns issue-user pairs by given repository IDs.
  491. func GetIssueUserPairsByRepoIds(rids []int64, isClosed bool, page int) ([]*IssueUser, error) {
  492. if len(rids) == 0 {
  493. return []*IssueUser{}, nil
  494. }
  495. buf := bytes.NewBufferString("")
  496. for _, rid := range rids {
  497. buf.WriteString("repo_id=")
  498. buf.WriteString(com.ToStr(rid))
  499. buf.WriteString(" OR ")
  500. }
  501. cond := strings.TrimSuffix(buf.String(), " OR ")
  502. ius := make([]*IssueUser, 0, 10)
  503. sess := x.Limit(20, (page-1)*20).Where("is_closed=?", isClosed)
  504. if len(cond) > 0 {
  505. sess.And(cond)
  506. }
  507. err := sess.Find(&ius)
  508. return ius, err
  509. }
  510. // GetIssueUserPairsByMode returns issue-user pairs by given repository and user.
  511. func GetIssueUserPairsByMode(uid, rid int64, isClosed bool, page, filterMode int) ([]*IssueUser, error) {
  512. ius := make([]*IssueUser, 0, 10)
  513. sess := x.Limit(20, (page-1)*20).Where("uid=?", uid).And("is_closed=?", isClosed)
  514. if rid > 0 {
  515. sess.And("repo_id=?", rid)
  516. }
  517. switch filterMode {
  518. case FM_ASSIGN:
  519. sess.And("is_assigned=?", true)
  520. case FM_CREATE:
  521. sess.And("is_poster=?", true)
  522. default:
  523. return ius, nil
  524. }
  525. err := sess.Find(&ius)
  526. return ius, err
  527. }
  528. // IssueStats represents issue statistic information.
  529. type IssueStats struct {
  530. OpenCount, ClosedCount int64
  531. AllCount int64
  532. AssignCount int64
  533. CreateCount int64
  534. MentionCount int64
  535. }
  536. // Filter modes.
  537. const (
  538. FM_ALL = iota
  539. FM_ASSIGN
  540. FM_CREATE
  541. FM_MENTION
  542. )
  543. func parseCountResult(results []map[string][]byte) int64 {
  544. if len(results) == 0 {
  545. return 0
  546. }
  547. for _, result := range results[0] {
  548. return com.StrTo(string(result)).MustInt64()
  549. }
  550. return 0
  551. }
  552. // GetIssueStats returns issue statistic information by given conditions.
  553. func GetIssueStats(repoID, uid, labelID, milestoneID, assigneeID int64, isShowClosed bool, filterMode int) *IssueStats {
  554. stats := &IssueStats{}
  555. // issue := new(Issue)
  556. queryStr := "SELECT COUNT(*) FROM `issue` "
  557. if labelID > 0 {
  558. queryStr += "INNER JOIN `issue_label` ON `issue`.id=`issue_label`.issue_id AND `issue_label`.label_id=" + com.ToStr(labelID)
  559. }
  560. baseCond := " WHERE issue.repo_id=? AND issue.is_closed=?"
  561. if milestoneID > 0 {
  562. baseCond += " AND issue.milestone_id=" + com.ToStr(milestoneID)
  563. }
  564. if assigneeID > 0 {
  565. baseCond += " AND assignee_id=" + com.ToStr(assigneeID)
  566. }
  567. switch filterMode {
  568. case FM_ALL, FM_ASSIGN:
  569. resutls, _ := x.Query(queryStr+baseCond, repoID, false)
  570. stats.OpenCount = parseCountResult(resutls)
  571. resutls, _ = x.Query(queryStr+baseCond, repoID, true)
  572. stats.ClosedCount = parseCountResult(resutls)
  573. case FM_CREATE:
  574. baseCond += " AND poster_id=?"
  575. resutls, _ := x.Query(queryStr+baseCond, repoID, false, uid)
  576. stats.OpenCount = parseCountResult(resutls)
  577. resutls, _ = x.Query(queryStr+baseCond, repoID, true, uid)
  578. stats.ClosedCount = parseCountResult(resutls)
  579. case FM_MENTION:
  580. queryStr += " INNER JOIN `issue_user` ON `issue`.id=`issue_user`.issue_id"
  581. baseCond += " AND `issue_user`.uid=? AND `issue_user`.is_mentioned=?"
  582. resutls, _ := x.Query(queryStr+baseCond, repoID, false, uid, true)
  583. stats.OpenCount = parseCountResult(resutls)
  584. resutls, _ = x.Query(queryStr+baseCond, repoID, true, uid, true)
  585. stats.ClosedCount = parseCountResult(resutls)
  586. }
  587. return stats
  588. }
  589. // GetUserIssueStats returns issue statistic information for dashboard by given conditions.
  590. func GetUserIssueStats(uid int64, filterMode int) *IssueStats {
  591. stats := &IssueStats{}
  592. issue := new(Issue)
  593. stats.AssignCount, _ = x.Where("assignee_id=?", uid).And("is_closed=?", false).Count(issue)
  594. stats.CreateCount, _ = x.Where("poster_id=?", uid).And("is_closed=?", false).Count(issue)
  595. return stats
  596. }
  597. func updateIssue(e Engine, issue *Issue) error {
  598. _, err := e.Id(issue.ID).AllCols().Update(issue)
  599. return err
  600. }
  601. // UpdateIssue updates information of issue.
  602. func UpdateIssue(issue *Issue) error {
  603. return updateIssue(x, issue)
  604. }
  605. func updateIssueUsersByStatus(e Engine, issueID int64, isClosed bool) error {
  606. _, err := e.Exec("UPDATE `issue_user` SET is_closed=? WHERE issue_id=?", isClosed, issueID)
  607. return err
  608. }
  609. // UpdateIssueUsersByStatus updates issue-user relations by issue status.
  610. func UpdateIssueUsersByStatus(issueID int64, isClosed bool) error {
  611. return updateIssueUsersByStatus(x, issueID, isClosed)
  612. }
  613. func updateIssueUserByAssignee(e *xorm.Session, issue *Issue) (err error) {
  614. if _, err = e.Exec("UPDATE `issue_user` SET is_assigned=? WHERE issue_id=?", false, issue.ID); err != nil {
  615. return err
  616. }
  617. // Assignee ID equals to 0 means clear assignee.
  618. if issue.AssigneeID > 0 {
  619. if _, err = e.Exec("UPDATE `issue_user` SET is_assigned=? WHERE uid=? AND issue_id=?", true, issue.AssigneeID, issue.ID); err != nil {
  620. return err
  621. }
  622. }
  623. return updateIssue(e, issue)
  624. }
  625. // UpdateIssueUserByAssignee updates issue-user relation for assignee.
  626. func UpdateIssueUserByAssignee(issue *Issue) (err error) {
  627. sess := x.NewSession()
  628. defer sessionRelease(sess)
  629. if err = sess.Begin(); err != nil {
  630. return err
  631. }
  632. if err = updateIssueUserByAssignee(sess, issue); err != nil {
  633. return err
  634. }
  635. return sess.Commit()
  636. }
  637. // UpdateIssueUserByRead updates issue-user relation for reading.
  638. func UpdateIssueUserByRead(uid, issueID int64) error {
  639. _, err := x.Exec("UPDATE `issue_user` SET is_read=? WHERE uid=? AND issue_id=?", true, uid, issueID)
  640. return err
  641. }
  642. // UpdateIssueUsersByMentions updates issue-user pairs by mentioning.
  643. func UpdateIssueUsersByMentions(uids []int64, iid int64) error {
  644. for _, uid := range uids {
  645. iu := &IssueUser{UID: uid, IssueID: iid}
  646. has, err := x.Get(iu)
  647. if err != nil {
  648. return err
  649. }
  650. iu.IsMentioned = true
  651. if has {
  652. _, err = x.Id(iu.ID).AllCols().Update(iu)
  653. } else {
  654. _, err = x.Insert(iu)
  655. }
  656. if err != nil {
  657. return err
  658. }
  659. }
  660. return nil
  661. }
  662. // .____ ___. .__
  663. // | | _____ \_ |__ ____ | |
  664. // | | \__ \ | __ \_/ __ \| |
  665. // | |___ / __ \| \_\ \ ___/| |__
  666. // |_______ (____ /___ /\___ >____/
  667. // \/ \/ \/ \/
  668. // Label represents a label of repository for issues.
  669. type Label struct {
  670. ID int64 `xorm:"pk autoincr"`
  671. RepoID int64 `xorm:"INDEX"`
  672. Name string
  673. Color string `xorm:"VARCHAR(7)"`
  674. NumIssues int
  675. NumClosedIssues int
  676. NumOpenIssues int `xorm:"-"`
  677. IsChecked bool `xorm:"-"`
  678. }
  679. // CalOpenIssues calculates the open issues of label.
  680. func (m *Label) CalOpenIssues() {
  681. m.NumOpenIssues = m.NumIssues - m.NumClosedIssues
  682. }
  683. // NewLabel creates new label of repository.
  684. func NewLabel(l *Label) error {
  685. _, err := x.Insert(l)
  686. return err
  687. }
  688. func getLabelByID(e Engine, id int64) (*Label, error) {
  689. if id <= 0 {
  690. return nil, ErrLabelNotExist{id}
  691. }
  692. l := &Label{ID: id}
  693. has, err := x.Get(l)
  694. if err != nil {
  695. return nil, err
  696. } else if !has {
  697. return nil, ErrLabelNotExist{l.ID}
  698. }
  699. return l, nil
  700. }
  701. // GetLabelByID returns a label by given ID.
  702. func GetLabelByID(id int64) (*Label, error) {
  703. return getLabelByID(x, id)
  704. }
  705. // GetLabelsByRepoID returns all labels that belong to given repository by ID.
  706. func GetLabelsByRepoID(repoID int64) ([]*Label, error) {
  707. labels := make([]*Label, 0, 10)
  708. return labels, x.Where("repo_id=?", repoID).Find(&labels)
  709. }
  710. func getLabelsByIssueID(e Engine, issueID int64) ([]*Label, error) {
  711. issueLabels, err := getIssueLabels(e, issueID)
  712. if err != nil {
  713. return nil, fmt.Errorf("getIssueLabels: %v", err)
  714. }
  715. var label *Label
  716. labels := make([]*Label, 0, len(issueLabels))
  717. for idx := range issueLabels {
  718. label, err = getLabelByID(e, issueLabels[idx].LabelID)
  719. if err != nil && !IsErrLabelNotExist(err) {
  720. return nil, fmt.Errorf("getLabelByID: %v", err)
  721. }
  722. labels = append(labels, label)
  723. }
  724. return labels, nil
  725. }
  726. // GetLabelsByIssueID returns all labels that belong to given issue by ID.
  727. func GetLabelsByIssueID(issueID int64) ([]*Label, error) {
  728. return getLabelsByIssueID(x, issueID)
  729. }
  730. func updateLabel(e Engine, l *Label) error {
  731. _, err := e.Id(l.ID).AllCols().Update(l)
  732. return err
  733. }
  734. // UpdateLabel updates label information.
  735. func UpdateLabel(l *Label) error {
  736. return updateLabel(x, l)
  737. }
  738. // DeleteLabel delete a label of given repository.
  739. func DeleteLabel(repoID, labelID int64) error {
  740. l, err := GetLabelByID(labelID)
  741. if err != nil {
  742. if IsErrLabelNotExist(err) {
  743. return nil
  744. }
  745. return err
  746. }
  747. sess := x.NewSession()
  748. defer sessionRelease(sess)
  749. if err = sess.Begin(); err != nil {
  750. return err
  751. }
  752. if _, err = x.Where("label_id=?", labelID).Delete(new(IssueLabel)); err != nil {
  753. return err
  754. } else if _, err = sess.Delete(l); err != nil {
  755. return err
  756. }
  757. return sess.Commit()
  758. }
  759. // .___ .____ ___. .__
  760. // | | ______ ________ __ ____ | | _____ \_ |__ ____ | |
  761. // | |/ ___// ___/ | \_/ __ \| | \__ \ | __ \_/ __ \| |
  762. // | |\___ \ \___ \| | /\ ___/| |___ / __ \| \_\ \ ___/| |__
  763. // |___/____ >____ >____/ \___ >_______ (____ /___ /\___ >____/
  764. // \/ \/ \/ \/ \/ \/ \/
  765. // IssueLabel represetns an issue-lable relation.
  766. type IssueLabel struct {
  767. ID int64 `xorm:"pk autoincr"`
  768. IssueID int64 `xorm:"UNIQUE(s)"`
  769. LabelID int64 `xorm:"UNIQUE(s)"`
  770. }
  771. func hasIssueLabel(e Engine, issueID, labelID int64) bool {
  772. has, _ := e.Where("issue_id=? AND label_id=?", issueID, labelID).Get(new(IssueLabel))
  773. return has
  774. }
  775. // HasIssueLabel returns true if issue has been labeled.
  776. func HasIssueLabel(issueID, labelID int64) bool {
  777. return hasIssueLabel(x, issueID, labelID)
  778. }
  779. func newIssueLabel(e *xorm.Session, issue *Issue, label *Label) (err error) {
  780. if _, err = e.Insert(&IssueLabel{
  781. IssueID: issue.ID,
  782. LabelID: label.ID,
  783. }); err != nil {
  784. return err
  785. }
  786. label.NumIssues++
  787. if issue.IsClosed {
  788. label.NumClosedIssues++
  789. }
  790. return updateLabel(e, label)
  791. }
  792. // NewIssueLabel creates a new issue-label relation.
  793. func NewIssueLabel(issue *Issue, label *Label) (err error) {
  794. sess := x.NewSession()
  795. defer sessionRelease(sess)
  796. if err = sess.Begin(); err != nil {
  797. return err
  798. }
  799. if err = newIssueLabel(sess, issue, label); err != nil {
  800. return err
  801. }
  802. return sess.Commit()
  803. }
  804. func getIssueLabels(e Engine, issueID int64) ([]*IssueLabel, error) {
  805. issueLabels := make([]*IssueLabel, 0, 10)
  806. return issueLabels, e.Where("issue_id=?", issueID).Asc("label_id").Find(&issueLabels)
  807. }
  808. // GetIssueLabels returns all issue-label relations of given issue by ID.
  809. func GetIssueLabels(issueID int64) ([]*IssueLabel, error) {
  810. return getIssueLabels(x, issueID)
  811. }
  812. func deleteIssueLabel(e *xorm.Session, issue *Issue, label *Label) (err error) {
  813. if _, err = e.Delete(&IssueLabel{
  814. IssueID: issue.ID,
  815. LabelID: label.ID,
  816. }); err != nil {
  817. return err
  818. }
  819. label.NumIssues--
  820. if issue.IsClosed {
  821. label.NumClosedIssues--
  822. }
  823. return updateLabel(e, label)
  824. }
  825. // DeleteIssueLabel deletes issue-label relation.
  826. func DeleteIssueLabel(issue *Issue, label *Label) (err error) {
  827. sess := x.NewSession()
  828. defer sessionRelease(sess)
  829. if err = sess.Begin(); err != nil {
  830. return err
  831. }
  832. if err = deleteIssueLabel(sess, issue, label); err != nil {
  833. return err
  834. }
  835. return sess.Commit()
  836. }
  837. // _____ .__.__ __
  838. // / \ |__| | ____ _______/ |_ ____ ____ ____
  839. // / \ / \| | | _/ __ \ / ___/\ __\/ _ \ / \_/ __ \
  840. // / Y \ | |_\ ___/ \___ \ | | ( <_> ) | \ ___/
  841. // \____|__ /__|____/\___ >____ > |__| \____/|___| /\___ >
  842. // \/ \/ \/ \/ \/
  843. // Milestone represents a milestone of repository.
  844. type Milestone struct {
  845. ID int64 `xorm:"pk autoincr"`
  846. RepoID int64 `xorm:"INDEX"`
  847. Name string
  848. Content string `xorm:"TEXT"`
  849. RenderedContent string `xorm:"-"`
  850. IsClosed bool
  851. NumIssues int
  852. NumClosedIssues int
  853. NumOpenIssues int `xorm:"-"`
  854. Completeness int // Percentage(1-100).
  855. Deadline time.Time
  856. DeadlineString string `xorm:"-"`
  857. IsOverDue bool `xorm:"-"`
  858. ClosedDate time.Time
  859. }
  860. func (m *Milestone) BeforeUpdate() {
  861. if m.NumIssues > 0 {
  862. m.Completeness = m.NumClosedIssues * 100 / m.NumIssues
  863. } else {
  864. m.Completeness = 0
  865. }
  866. }
  867. func (m *Milestone) AfterSet(colName string, _ xorm.Cell) {
  868. if colName == "deadline" {
  869. if m.Deadline.Year() == 9999 {
  870. return
  871. }
  872. m.DeadlineString = m.Deadline.Format("2006-01-02")
  873. if time.Now().After(m.Deadline) {
  874. m.IsOverDue = true
  875. }
  876. }
  877. }
  878. // CalOpenIssues calculates the open issues of milestone.
  879. func (m *Milestone) CalOpenIssues() {
  880. m.NumOpenIssues = m.NumIssues - m.NumClosedIssues
  881. }
  882. // NewMilestone creates new milestone of repository.
  883. func NewMilestone(m *Milestone) (err error) {
  884. sess := x.NewSession()
  885. defer sessionRelease(sess)
  886. if err = sess.Begin(); err != nil {
  887. return err
  888. }
  889. if _, err = sess.Insert(m); err != nil {
  890. return err
  891. }
  892. if _, err = sess.Exec("UPDATE `repository` SET num_milestones=num_milestones+1 WHERE id=?", m.RepoID); err != nil {
  893. return err
  894. }
  895. return sess.Commit()
  896. }
  897. func getMilestoneByID(e Engine, id int64) (*Milestone, error) {
  898. m := &Milestone{ID: id}
  899. has, err := e.Get(m)
  900. if err != nil {
  901. return nil, err
  902. } else if !has {
  903. return nil, ErrMilestoneNotExist{id, 0}
  904. }
  905. return m, nil
  906. }
  907. // GetMilestoneByID returns the milestone of given ID.
  908. func GetMilestoneByID(id int64) (*Milestone, error) {
  909. return getMilestoneByID(x, id)
  910. }
  911. // GetRepoMilestoneByID returns the milestone of given ID and repository.
  912. func GetRepoMilestoneByID(repoID, milestoneID int64) (*Milestone, error) {
  913. m := &Milestone{ID: milestoneID, RepoID: repoID}
  914. has, err := x.Get(m)
  915. if err != nil {
  916. return nil, err
  917. } else if !has {
  918. return nil, ErrMilestoneNotExist{milestoneID, repoID}
  919. }
  920. return m, nil
  921. }
  922. // GetAllRepoMilestones returns all milestones of given repository.
  923. func GetAllRepoMilestones(repoID int64) ([]*Milestone, error) {
  924. miles := make([]*Milestone, 0, 10)
  925. return miles, x.Where("repo_id=?", repoID).Find(&miles)
  926. }
  927. // GetMilestones returns a list of milestones of given repository and status.
  928. func GetMilestones(repoID int64, page int, isClosed bool) ([]*Milestone, error) {
  929. miles := make([]*Milestone, 0, setting.IssuePagingNum)
  930. sess := x.Where("repo_id=? AND is_closed=?", repoID, isClosed)
  931. if page > 0 {
  932. sess = sess.Limit(setting.IssuePagingNum, (page-1)*setting.IssuePagingNum)
  933. }
  934. return miles, sess.Find(&miles)
  935. }
  936. func updateMilestone(e Engine, m *Milestone) error {
  937. _, err := e.Id(m.ID).AllCols().Update(m)
  938. return err
  939. }
  940. // UpdateMilestone updates information of given milestone.
  941. func UpdateMilestone(m *Milestone) error {
  942. return updateMilestone(x, m)
  943. }
  944. func countRepoMilestones(e Engine, repoID int64) int64 {
  945. count, _ := e.Where("repo_id=?", repoID).Count(new(Milestone))
  946. return count
  947. }
  948. // CountRepoMilestones returns number of milestones in given repository.
  949. func CountRepoMilestones(repoID int64) int64 {
  950. return countRepoMilestones(x, repoID)
  951. }
  952. func countRepoClosedMilestones(e Engine, repoID int64) int64 {
  953. closed, _ := e.Where("repo_id=? AND is_closed=?", repoID, true).Count(new(Milestone))
  954. return closed
  955. }
  956. // CountRepoClosedMilestones returns number of closed milestones in given repository.
  957. func CountRepoClosedMilestones(repoID int64) int64 {
  958. return countRepoClosedMilestones(x, repoID)
  959. }
  960. // MilestoneStats returns number of open and closed milestones of given repository.
  961. func MilestoneStats(repoID int64) (open int64, closed int64) {
  962. open, _ = x.Where("repo_id=? AND is_closed=?", repoID, false).Count(new(Milestone))
  963. return open, CountRepoClosedMilestones(repoID)
  964. }
  965. // ChangeMilestoneStatus changes the milestone open/closed status.
  966. func ChangeMilestoneStatus(m *Milestone, isClosed bool) (err error) {
  967. repo, err := GetRepositoryByID(m.RepoID)
  968. if err != nil {
  969. return err
  970. }
  971. sess := x.NewSession()
  972. defer sessionRelease(sess)
  973. if err = sess.Begin(); err != nil {
  974. return err
  975. }
  976. m.IsClosed = isClosed
  977. if err = updateMilestone(sess, m); err != nil {
  978. return err
  979. }
  980. repo.NumMilestones = int(countRepoMilestones(sess, repo.ID))
  981. repo.NumClosedMilestones = int(countRepoClosedMilestones(sess, repo.ID))
  982. if _, err = sess.Id(repo.ID).AllCols().Update(repo); err != nil {
  983. return err
  984. }
  985. return sess.Commit()
  986. }
  987. func changeMilestoneIssueStats(e *xorm.Session, issue *Issue) error {
  988. if issue.MilestoneID == 0 {
  989. return nil
  990. }
  991. m, err := getMilestoneByID(e, issue.MilestoneID)
  992. if err != nil {
  993. return err
  994. }
  995. if issue.IsClosed {
  996. m.NumOpenIssues--
  997. m.NumClosedIssues++
  998. } else {
  999. m.NumOpenIssues++
  1000. m.NumClosedIssues--
  1001. }
  1002. return updateMilestone(e, m)
  1003. }
  1004. // ChangeMilestoneIssueStats updates the open/closed issues counter and progress
  1005. // for the milestone associated witht the given issue.
  1006. func ChangeMilestoneIssueStats(issue *Issue) (err error) {
  1007. sess := x.NewSession()
  1008. defer sessionRelease(sess)
  1009. if err = sess.Begin(); err != nil {
  1010. return err
  1011. }
  1012. if err = changeMilestoneIssueStats(sess, issue); err != nil {
  1013. return err
  1014. }
  1015. return sess.Commit()
  1016. }
  1017. func changeMilestoneAssign(e *xorm.Session, oldMid int64, issue *Issue) error {
  1018. if oldMid > 0 {
  1019. m, err := getMilestoneByID(e, oldMid)
  1020. if err != nil {
  1021. return err
  1022. }
  1023. m.NumIssues--
  1024. if issue.IsClosed {
  1025. m.NumClosedIssues--
  1026. }
  1027. if err = updateMilestone(e, m); err != nil {
  1028. return err
  1029. } else if _, err = e.Exec("UPDATE `issue_user` SET milestone_id=0 WHERE issue_id=?", issue.ID); err != nil {
  1030. return err
  1031. }
  1032. }
  1033. if issue.MilestoneID > 0 {
  1034. m, err := getMilestoneByID(e, issue.MilestoneID)
  1035. if err != nil {
  1036. return err
  1037. }
  1038. m.NumIssues++
  1039. if issue.IsClosed {
  1040. m.NumClosedIssues++
  1041. }
  1042. if m.NumIssues == 0 {
  1043. return ErrWrongIssueCounter
  1044. }
  1045. if err = updateMilestone(e, m); err != nil {
  1046. return err
  1047. } else if _, err = e.Exec("UPDATE `issue_user` SET milestone_id=? WHERE issue_id=?", m.ID, issue.ID); err != nil {
  1048. return err
  1049. }
  1050. }
  1051. return updateIssue(e, issue)
  1052. }
  1053. // ChangeMilestoneAssign changes assignment of milestone for issue.
  1054. func ChangeMilestoneAssign(oldMid int64, issue *Issue) (err error) {
  1055. sess := x.NewSession()
  1056. defer sess.Close()
  1057. if err = sess.Begin(); err != nil {
  1058. return err
  1059. }
  1060. if err = changeMilestoneAssign(sess, oldMid, issue); err != nil {
  1061. return err
  1062. }
  1063. return sess.Commit()
  1064. }
  1065. // DeleteMilestoneByID deletes a milestone by given ID.
  1066. func DeleteMilestoneByID(mid int64) error {
  1067. m, err := GetMilestoneByID(mid)
  1068. if err != nil {
  1069. if IsErrMilestoneNotExist(err) {
  1070. return nil
  1071. }
  1072. return err
  1073. }
  1074. repo, err := GetRepositoryByID(m.RepoID)
  1075. if err != nil {
  1076. return err
  1077. }
  1078. sess := x.NewSession()
  1079. defer sessionRelease(sess)
  1080. if err = sess.Begin(); err != nil {
  1081. return err
  1082. }
  1083. if _, err = sess.Id(m.ID).Delete(m); err != nil {
  1084. return err
  1085. }
  1086. repo.NumMilestones = int(countRepoMilestones(sess, repo.ID))
  1087. repo.NumClosedMilestones = int(countRepoClosedMilestones(sess, repo.ID))
  1088. if _, err = sess.Id(repo.ID).AllCols().Update(repo); err != nil {
  1089. return err
  1090. }
  1091. if _, err = sess.Exec("UPDATE `issue` SET milestone_id=0 WHERE milestone_id=?", m.ID); err != nil {
  1092. return err
  1093. } else if _, err = sess.Exec("UPDATE `issue_user` SET milestone_id=0 WHERE milestone_id=?", m.ID); err != nil {
  1094. return err
  1095. }
  1096. return sess.Commit()
  1097. }
  1098. // _________ __
  1099. // \_ ___ \ ____ _____ _____ ____ _____/ |_
  1100. // / \ \/ / _ \ / \ / \_/ __ \ / \ __\
  1101. // \ \___( <_> ) Y Y \ Y Y \ ___/| | \ |
  1102. // \______ /\____/|__|_| /__|_| /\___ >___| /__|
  1103. // \/ \/ \/ \/ \/
  1104. // CommentType defines whether a comment is just a simple comment, an action (like close) or a reference.
  1105. type CommentType int
  1106. const (
  1107. // Plain comment, can be associated with a commit (CommitId > 0) and a line (Line > 0)
  1108. COMMENT_TYPE_COMMENT CommentType = iota
  1109. COMMENT_TYPE_REOPEN
  1110. COMMENT_TYPE_CLOSE
  1111. // References.
  1112. COMMENT_TYPE_ISSUE_REF
  1113. // Reference from a commit (not part of a pull request)
  1114. COMMENT_TYPE_COMMIT_REF
  1115. // Reference from a comment
  1116. COMMENT_TYPE_COMMENT_REF
  1117. // Reference from a pull request
  1118. COMMENT_TYPE_PULL_REF
  1119. )
  1120. type CommentTag int
  1121. const (
  1122. COMMENT_TAG_NONE CommentTag = iota
  1123. COMMENT_TAG_POSTER
  1124. COMMENT_TAG_ADMIN
  1125. COMMENT_TAG_OWNER
  1126. )
  1127. // Comment represents a comment in commit and issue page.
  1128. type Comment struct {
  1129. ID int64 `xorm:"pk autoincr"`
  1130. Type CommentType
  1131. PosterID int64
  1132. Poster *User `xorm:"-"`
  1133. IssueID int64 `xorm:"INDEX"`
  1134. CommitID int64
  1135. Line int64
  1136. Content string `xorm:"TEXT"`
  1137. RenderedContent string `xorm:"-"`
  1138. Created time.Time `xorm:"CREATED"`
  1139. Attachments []*Attachment `xorm:"-"`
  1140. // For view issue page.
  1141. ShowTag CommentTag `xorm:"-"`
  1142. }
  1143. func (c *Comment) AfterSet(colName string, _ xorm.Cell) {
  1144. var err error
  1145. switch colName {
  1146. case "id":
  1147. c.Attachments, err = GetAttachmentsByCommentID(c.ID)
  1148. if err != nil {
  1149. log.Error(3, "GetAttachmentsByCommentID[%d]: %v", c.ID, err)
  1150. }
  1151. case "poster_id":
  1152. c.Poster, err = GetUserByID(c.PosterID)
  1153. if err != nil {
  1154. if IsErrUserNotExist(err) {
  1155. c.PosterID = -1
  1156. c.Poster = NewFakeUser()
  1157. } else {
  1158. log.Error(3, "GetUserByID[%d]: %v", c.ID, err)
  1159. }
  1160. }
  1161. case "created":
  1162. now := time.Now()
  1163. c.Created = c.Created.Add(now.Sub(now.UTC()))
  1164. }
  1165. }
  1166. // HashTag returns unique hash tag for comment.
  1167. func (c *Comment) HashTag() string {
  1168. return "issuecomment-" + com.ToStr(c.ID)
  1169. }
  1170. // EventTag returns unique event hash tag for comment.
  1171. func (c *Comment) EventTag() string {
  1172. return "event-" + com.ToStr(c.ID)
  1173. }
  1174. func createComment(e *xorm.Session, u *User, repo *Repository, issue *Issue, commitID, line int64, cmtType CommentType, content string, uuids []string) (_ *Comment, err error) {
  1175. comment := &Comment{
  1176. PosterID: u.Id,
  1177. Type: cmtType,
  1178. IssueID: issue.ID,
  1179. CommitID: commitID,
  1180. Line: line,
  1181. Content: content,
  1182. }
  1183. if _, err = e.Insert(comment); err != nil {
  1184. return nil, err
  1185. }
  1186. // Check comment type.
  1187. switch cmtType {
  1188. case COMMENT_TYPE_COMMENT:
  1189. if _, err = e.Exec("UPDATE `issue` SET num_comments=num_comments+1 WHERE id=?", issue.ID); err != nil {
  1190. return nil, err
  1191. }
  1192. // Check attachments.
  1193. attachments := make([]*Attachment, 0, len(uuids))
  1194. for _, uuid := range uuids {
  1195. attach, err := getAttachmentByUUID(e, uuid)
  1196. if err != nil {
  1197. if IsErrAttachmentNotExist(err) {
  1198. continue
  1199. }
  1200. return nil, fmt.Errorf("getAttachmentByUUID[%s]: %v", uuid, err)
  1201. }
  1202. attachments = append(attachments, attach)
  1203. }
  1204. for i := range attachments {
  1205. attachments[i].IssueID = issue.ID
  1206. attachments[i].CommentID = comment.ID
  1207. // No assign value could be 0, so ignore AllCols().
  1208. if _, err = e.Id(attachments[i].ID).Update(attachments[i]); err != nil {
  1209. return nil, fmt.Errorf("update attachment[%d]: %v", attachments[i].ID, err)
  1210. }
  1211. }
  1212. // Notify watchers.
  1213. act := &Action{
  1214. ActUserID: u.Id,
  1215. ActUserName: u.LowerName,
  1216. ActEmail: u.Email,
  1217. OpType: COMMENT_ISSUE,
  1218. Content: fmt.Sprintf("%d|%s", issue.Index, strings.Split(content, "\n")[0]),
  1219. RepoID: repo.ID,
  1220. RepoUserName: repo.Owner.LowerName,
  1221. RepoName: repo.LowerName,
  1222. IsPrivate: repo.IsPrivate,
  1223. }
  1224. if err = notifyWatchers(e, act); err != nil {
  1225. return nil, err
  1226. }
  1227. case COMMENT_TYPE_REOPEN:
  1228. if _, err = e.Exec("UPDATE `repository` SET num_closed_issues=num_closed_issues-1 WHERE id=?", repo.ID); err != nil {
  1229. return nil, err
  1230. }
  1231. case COMMENT_TYPE_CLOSE:
  1232. if _, err = e.Exec("UPDATE `repository` SET num_closed_issues=num_closed_issues+1 WHERE id=?", repo.ID); err != nil {
  1233. return nil, err
  1234. }
  1235. }
  1236. return comment, nil
  1237. }
  1238. func createStatusComment(e *xorm.Session, doer *User, repo *Repository, issue *Issue) (*Comment, error) {
  1239. cmtType := COMMENT_TYPE_CLOSE
  1240. if !issue.IsClosed {
  1241. cmtType = COMMENT_TYPE_REOPEN
  1242. }
  1243. return createComment(e, doer, repo, issue, 0, 0, cmtType, "", nil)
  1244. }
  1245. // CreateComment creates comment of issue or commit.
  1246. func CreateComment(doer *User, repo *Repository, issue *Issue, commitID, line int64, cmtType CommentType, content string, attachments []string) (comment *Comment, err error) {
  1247. sess := x.NewSession()
  1248. defer sessionRelease(sess)
  1249. if err = sess.Begin(); err != nil {
  1250. return nil, err
  1251. }
  1252. comment, err = createComment(sess, doer, repo, issue, commitID, line, cmtType, content, attachments)
  1253. if err != nil {
  1254. return nil, err
  1255. }
  1256. return comment, sess.Commit()
  1257. }
  1258. // CreateIssueComment creates a plain issue comment.
  1259. func CreateIssueComment(doer *User, repo *Repository, issue *Issue, content string, attachments []string) (*Comment, error) {
  1260. return CreateComment(doer, repo, issue, 0, 0, COMMENT_TYPE_COMMENT, content, attachments)
  1261. }
  1262. // GetCommentById returns the comment with the given id
  1263. func GetCommentById(id int64) (*Comment, error) {
  1264. c := new(Comment)
  1265. _, err := x.Id(id).Get(c)
  1266. return c, err
  1267. }
  1268. // GetCommentsByIssueID returns all comments of issue by given ID.
  1269. func GetCommentsByIssueID(issueID int64) ([]*Comment, error) {
  1270. comments := make([]*Comment, 0, 10)
  1271. return comments, x.Where("issue_id=?", issueID).Asc("created").Find(&comments)
  1272. }
  1273. func (c *Comment) AfterDelete() {
  1274. _, err := DeleteAttachmentsByComment(c.ID, true)
  1275. if err != nil {
  1276. log.Info("Could not delete files for comment %d on issue #%d: %s", c.ID, c.IssueID, err)
  1277. }
  1278. }
  1279. // Attachment represent a attachment of issue/comment/release.
  1280. type Attachment struct {
  1281. ID int64 `xorm:"pk autoincr"`
  1282. UUID string `xorm:"uuid UNIQUE"`
  1283. IssueID int64 `xorm:"INDEX"`
  1284. CommentID int64
  1285. ReleaseID int64 `xorm:"INDEX"`
  1286. Name string
  1287. Created time.Time `xorm:"CREATED"`
  1288. }
  1289. // AttachmentLocalPath returns where attachment is stored in local file system based on given UUID.
  1290. func AttachmentLocalPath(uuid string) string {
  1291. return path.Join(setting.AttachmentPath, uuid[0:1], uuid[1:2], uuid)
  1292. }
  1293. // LocalPath returns where attachment is stored in local file system.
  1294. func (attach *Attachment) LocalPath() string {
  1295. return AttachmentLocalPath(attach.UUID)
  1296. }
  1297. // NewAttachment creates a new attachment object.
  1298. func NewAttachment(name string, buf []byte, file multipart.File) (_ *Attachment, err error) {
  1299. attach := &Attachment{
  1300. UUID: gouuid.NewV4().String(),
  1301. Name: name,
  1302. }
  1303. if err = os.MkdirAll(path.Dir(attach.LocalPath()), os.ModePerm); err != nil {
  1304. return nil, fmt.Errorf("MkdirAll: %v", err)
  1305. }
  1306. fw, err := os.Create(attach.LocalPath())
  1307. if err != nil {
  1308. return nil, fmt.Errorf("Create: %v", err)
  1309. }
  1310. defer fw.Close()
  1311. if _, err = fw.Write(buf); err != nil {
  1312. return nil, fmt.Errorf("Write: %v", err)
  1313. } else if _, err = io.Copy(fw, file); err != nil {
  1314. return nil, fmt.Errorf("Copy: %v", err)
  1315. }
  1316. sess := x.NewSession()
  1317. defer sessionRelease(sess)
  1318. if err := sess.Begin(); err != nil {
  1319. return nil, err
  1320. }
  1321. if _, err := sess.Insert(attach); err != nil {
  1322. return nil, err
  1323. }
  1324. return attach, sess.Commit()
  1325. }
  1326. func getAttachmentByUUID(e Engine, uuid string) (*Attachment, error) {
  1327. attach := &Attachment{UUID: uuid}
  1328. has, err := x.Get(attach)
  1329. if err != nil {
  1330. return nil, err
  1331. } else if !has {
  1332. return nil, ErrAttachmentNotExist{0, uuid}
  1333. }
  1334. return attach, nil
  1335. }
  1336. // GetAttachmentByUUID returns attachment by given UUID.
  1337. func GetAttachmentByUUID(uuid string) (*Attachment, error) {
  1338. return getAttachmentByUUID(x, uuid)
  1339. }
  1340. // GetAttachmentsByIssueID returns all attachments for given issue by ID.
  1341. func GetAttachmentsByIssueID(issueID int64) ([]*Attachment, error) {
  1342. attachments := make([]*Attachment, 0, 10)
  1343. return attachments, x.Where("issue_id=? AND comment_id=0", issueID).Find(&attachments)
  1344. }
  1345. // GetAttachmentsByCommentID returns all attachments if comment by given ID.
  1346. func GetAttachmentsByCommentID(commentID int64) ([]*Attachment, error) {
  1347. attachments := make([]*Attachment, 0, 10)
  1348. return attachments, x.Where("comment_id=?", commentID).Find(&attachments)
  1349. }
  1350. // DeleteAttachment deletes the given attachment and optionally the associated file.
  1351. func DeleteAttachment(a *Attachment, remove bool) error {
  1352. _, err := DeleteAttachments([]*Attachment{a}, remove)
  1353. return err
  1354. }
  1355. // DeleteAttachments deletes the given attachments and optionally the associated files.
  1356. func DeleteAttachments(attachments []*Attachment, remove bool) (int, error) {
  1357. for i, a := range attachments {
  1358. if remove {
  1359. if err := os.Remove(a.LocalPath()); err != nil {
  1360. return i, err
  1361. }
  1362. }
  1363. if _, err := x.Delete(a.ID); err != nil {
  1364. return i, err
  1365. }
  1366. }
  1367. return len(attachments), nil
  1368. }
  1369. // DeleteAttachmentsByIssue deletes all attachments associated with the given issue.
  1370. func DeleteAttachmentsByIssue(issueId int64, remove bool) (int, error) {
  1371. attachments, err := GetAttachmentsByIssueID(issueId)
  1372. if err != nil {
  1373. return 0, err
  1374. }
  1375. return DeleteAttachments(attachments, remove)
  1376. }
  1377. // DeleteAttachmentsByComment deletes all attachments associated with the given comment.
  1378. func DeleteAttachmentsByComment(commentId int64, remove bool) (int, error) {
  1379. attachments, err := GetAttachmentsByCommentID(commentId)
  1380. if err != nil {
  1381. return 0, err
  1382. }
  1383. return DeleteAttachments(attachments, remove)
  1384. }