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_label.go 12KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477
  1. // Copyright 2016 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. "html/template"
  8. "regexp"
  9. "strconv"
  10. "strings"
  11. api "code.gitea.io/gitea/modules/structs"
  12. "xorm.io/builder"
  13. "xorm.io/xorm"
  14. )
  15. var labelColorPattern = regexp.MustCompile("#([a-fA-F0-9]{6})")
  16. // GetLabelTemplateFile loads the label template file by given name,
  17. // then parses and returns a list of name-color pairs and optionally description.
  18. func GetLabelTemplateFile(name string) ([][3]string, error) {
  19. data, err := getRepoInitFile("label", name)
  20. if err != nil {
  21. return nil, fmt.Errorf("getRepoInitFile: %v", err)
  22. }
  23. lines := strings.Split(string(data), "\n")
  24. list := make([][3]string, 0, len(lines))
  25. for i := 0; i < len(lines); i++ {
  26. line := strings.TrimSpace(lines[i])
  27. if len(line) == 0 {
  28. continue
  29. }
  30. parts := strings.SplitN(line, ";", 2)
  31. fields := strings.SplitN(parts[0], " ", 2)
  32. if len(fields) != 2 {
  33. return nil, fmt.Errorf("line is malformed: %s", line)
  34. }
  35. if !labelColorPattern.MatchString(fields[0]) {
  36. return nil, fmt.Errorf("bad HTML color code in line: %s", line)
  37. }
  38. var description string
  39. if len(parts) > 1 {
  40. description = strings.TrimSpace(parts[1])
  41. }
  42. fields[1] = strings.TrimSpace(fields[1])
  43. list = append(list, [3]string{fields[1], fields[0], description})
  44. }
  45. return list, nil
  46. }
  47. // Label represents a label of repository for issues.
  48. type Label struct {
  49. ID int64 `xorm:"pk autoincr"`
  50. RepoID int64 `xorm:"INDEX"`
  51. Name string
  52. Description string
  53. Color string `xorm:"VARCHAR(7)"`
  54. NumIssues int
  55. NumClosedIssues int
  56. NumOpenIssues int `xorm:"-"`
  57. IsChecked bool `xorm:"-"`
  58. QueryString string
  59. IsSelected bool
  60. }
  61. // APIFormat converts a Label to the api.Label format
  62. func (label *Label) APIFormat() *api.Label {
  63. return &api.Label{
  64. ID: label.ID,
  65. Name: label.Name,
  66. Color: strings.TrimLeft(label.Color, "#"),
  67. Description: label.Description,
  68. }
  69. }
  70. // CalOpenIssues calculates the open issues of label.
  71. func (label *Label) CalOpenIssues() {
  72. label.NumOpenIssues = label.NumIssues - label.NumClosedIssues
  73. }
  74. // LoadSelectedLabelsAfterClick calculates the set of selected labels when a label is clicked
  75. func (label *Label) LoadSelectedLabelsAfterClick(currentSelectedLabels []int64) {
  76. var labelQuerySlice []string
  77. labelSelected := false
  78. labelID := strconv.FormatInt(label.ID, 10)
  79. for _, s := range currentSelectedLabels {
  80. if s == label.ID {
  81. labelSelected = true
  82. } else if s > 0 {
  83. labelQuerySlice = append(labelQuerySlice, strconv.FormatInt(s, 10))
  84. }
  85. }
  86. if !labelSelected {
  87. labelQuerySlice = append(labelQuerySlice, labelID)
  88. }
  89. label.IsSelected = labelSelected
  90. label.QueryString = strings.Join(labelQuerySlice, ",")
  91. }
  92. // ForegroundColor calculates the text color for labels based
  93. // on their background color.
  94. func (label *Label) ForegroundColor() template.CSS {
  95. if strings.HasPrefix(label.Color, "#") {
  96. if color, err := strconv.ParseUint(label.Color[1:], 16, 64); err == nil {
  97. r := float32(0xFF & (color >> 16))
  98. g := float32(0xFF & (color >> 8))
  99. b := float32(0xFF & color)
  100. luminance := (0.2126*r + 0.7152*g + 0.0722*b) / 255
  101. if luminance < 0.66 {
  102. return template.CSS("#fff")
  103. }
  104. }
  105. }
  106. // default to black
  107. return template.CSS("#000")
  108. }
  109. func initalizeLabels(e Engine, repoID int64, labelTemplate string) error {
  110. list, err := GetLabelTemplateFile(labelTemplate)
  111. if err != nil {
  112. return ErrIssueLabelTemplateLoad{labelTemplate, err}
  113. }
  114. labels := make([]*Label, len(list))
  115. for i := 0; i < len(list); i++ {
  116. labels[i] = &Label{
  117. RepoID: repoID,
  118. Name: list[i][0],
  119. Description: list[i][2],
  120. Color: list[i][1],
  121. }
  122. }
  123. for _, label := range labels {
  124. if err = newLabel(e, label); err != nil {
  125. return err
  126. }
  127. }
  128. return nil
  129. }
  130. // InitalizeLabels adds a label set to a repository using a template
  131. func InitalizeLabels(repoID int64, labelTemplate string) error {
  132. return initalizeLabels(x, repoID, labelTemplate)
  133. }
  134. func newLabel(e Engine, label *Label) error {
  135. _, err := e.Insert(label)
  136. return err
  137. }
  138. // NewLabel creates a new label for a repository
  139. func NewLabel(label *Label) error {
  140. return newLabel(x, label)
  141. }
  142. // NewLabels creates new labels for a repository.
  143. func NewLabels(labels ...*Label) error {
  144. sess := x.NewSession()
  145. defer sess.Close()
  146. if err := sess.Begin(); err != nil {
  147. return err
  148. }
  149. for _, label := range labels {
  150. if err := newLabel(sess, label); err != nil {
  151. return err
  152. }
  153. }
  154. return sess.Commit()
  155. }
  156. // getLabelInRepoByName returns a label by Name in given repository.
  157. // If pass repoID as 0, then ORM will ignore limitation of repository
  158. // and can return arbitrary label with any valid ID.
  159. func getLabelInRepoByName(e Engine, repoID int64, labelName string) (*Label, error) {
  160. if len(labelName) == 0 {
  161. return nil, ErrLabelNotExist{0, repoID}
  162. }
  163. l := &Label{
  164. Name: labelName,
  165. RepoID: repoID,
  166. }
  167. has, err := e.Get(l)
  168. if err != nil {
  169. return nil, err
  170. } else if !has {
  171. return nil, ErrLabelNotExist{0, l.RepoID}
  172. }
  173. return l, nil
  174. }
  175. // getLabelInRepoByID returns a label by ID in given repository.
  176. // If pass repoID as 0, then ORM will ignore limitation of repository
  177. // and can return arbitrary label with any valid ID.
  178. func getLabelInRepoByID(e Engine, repoID, labelID int64) (*Label, error) {
  179. if labelID <= 0 {
  180. return nil, ErrLabelNotExist{labelID, repoID}
  181. }
  182. l := &Label{
  183. ID: labelID,
  184. RepoID: repoID,
  185. }
  186. has, err := e.Get(l)
  187. if err != nil {
  188. return nil, err
  189. } else if !has {
  190. return nil, ErrLabelNotExist{l.ID, l.RepoID}
  191. }
  192. return l, nil
  193. }
  194. // GetLabelByID returns a label by given ID.
  195. func GetLabelByID(id int64) (*Label, error) {
  196. return getLabelInRepoByID(x, 0, id)
  197. }
  198. // GetLabelInRepoByName returns a label by name in given repository.
  199. func GetLabelInRepoByName(repoID int64, labelName string) (*Label, error) {
  200. return getLabelInRepoByName(x, repoID, labelName)
  201. }
  202. // GetLabelIDsInRepoByNames returns a list of labelIDs by names in a given
  203. // repository.
  204. // it silently ignores label names that do not belong to the repository.
  205. func GetLabelIDsInRepoByNames(repoID int64, labelNames []string) ([]int64, error) {
  206. labelIDs := make([]int64, 0, len(labelNames))
  207. return labelIDs, x.Table("label").
  208. Where("repo_id = ?", repoID).
  209. In("name", labelNames).
  210. Asc("name").
  211. Cols("id").
  212. Find(&labelIDs)
  213. }
  214. // GetLabelInRepoByID returns a label by ID in given repository.
  215. func GetLabelInRepoByID(repoID, labelID int64) (*Label, error) {
  216. return getLabelInRepoByID(x, repoID, labelID)
  217. }
  218. // GetLabelsInRepoByIDs returns a list of labels by IDs in given repository,
  219. // it silently ignores label IDs that do not belong to the repository.
  220. func GetLabelsInRepoByIDs(repoID int64, labelIDs []int64) ([]*Label, error) {
  221. labels := make([]*Label, 0, len(labelIDs))
  222. return labels, x.
  223. Where("repo_id = ?", repoID).
  224. In("id", labelIDs).
  225. Asc("name").
  226. Find(&labels)
  227. }
  228. // GetLabelsByRepoID returns all labels that belong to given repository by ID.
  229. func GetLabelsByRepoID(repoID int64, sortType string) ([]*Label, error) {
  230. labels := make([]*Label, 0, 10)
  231. sess := x.Where("repo_id = ?", repoID)
  232. switch sortType {
  233. case "reversealphabetically":
  234. sess.Desc("name")
  235. case "leastissues":
  236. sess.Asc("num_issues")
  237. case "mostissues":
  238. sess.Desc("num_issues")
  239. default:
  240. sess.Asc("name")
  241. }
  242. return labels, sess.Find(&labels)
  243. }
  244. func getLabelsByIssueID(e Engine, issueID int64) ([]*Label, error) {
  245. var labels []*Label
  246. return labels, e.Where("issue_label.issue_id = ?", issueID).
  247. Join("LEFT", "issue_label", "issue_label.label_id = label.id").
  248. Asc("label.name").
  249. Find(&labels)
  250. }
  251. // GetLabelsByIssueID returns all labels that belong to given issue by ID.
  252. func GetLabelsByIssueID(issueID int64) ([]*Label, error) {
  253. return getLabelsByIssueID(x, issueID)
  254. }
  255. func updateLabel(e Engine, l *Label) error {
  256. _, err := e.ID(l.ID).
  257. SetExpr("num_issues",
  258. builder.Select("count(*)").From("issue_label").
  259. Where(builder.Eq{"label_id": l.ID}),
  260. ).
  261. SetExpr("num_closed_issues",
  262. builder.Select("count(*)").From("issue_label").
  263. InnerJoin("issue", "issue_label.issue_id = issue.id").
  264. Where(builder.Eq{
  265. "issue_label.label_id": l.ID,
  266. "issue.is_closed": true,
  267. }),
  268. ).
  269. AllCols().Update(l)
  270. return err
  271. }
  272. // UpdateLabel updates label information.
  273. func UpdateLabel(l *Label) error {
  274. return updateLabel(x, l)
  275. }
  276. // DeleteLabel delete a label of given repository.
  277. func DeleteLabel(repoID, labelID int64) error {
  278. _, err := GetLabelInRepoByID(repoID, labelID)
  279. if err != nil {
  280. if IsErrLabelNotExist(err) {
  281. return nil
  282. }
  283. return err
  284. }
  285. sess := x.NewSession()
  286. defer sess.Close()
  287. if err = sess.Begin(); err != nil {
  288. return err
  289. }
  290. if _, err = sess.ID(labelID).Delete(new(Label)); err != nil {
  291. return err
  292. } else if _, err = sess.
  293. Where("label_id = ?", labelID).
  294. Delete(new(IssueLabel)); err != nil {
  295. return err
  296. }
  297. // Clear label id in comment table
  298. if _, err = sess.Where("label_id = ?", labelID).Cols("label_id").Update(&Comment{}); err != nil {
  299. return err
  300. }
  301. return sess.Commit()
  302. }
  303. // .___ .____ ___. .__
  304. // | | ______ ________ __ ____ | | _____ \_ |__ ____ | |
  305. // | |/ ___// ___/ | \_/ __ \| | \__ \ | __ \_/ __ \| |
  306. // | |\___ \ \___ \| | /\ ___/| |___ / __ \| \_\ \ ___/| |__
  307. // |___/____ >____ >____/ \___ >_______ (____ /___ /\___ >____/
  308. // \/ \/ \/ \/ \/ \/ \/
  309. // IssueLabel represents an issue-label relation.
  310. type IssueLabel struct {
  311. ID int64 `xorm:"pk autoincr"`
  312. IssueID int64 `xorm:"UNIQUE(s)"`
  313. LabelID int64 `xorm:"UNIQUE(s)"`
  314. }
  315. func hasIssueLabel(e Engine, issueID, labelID int64) bool {
  316. has, _ := e.Where("issue_id = ? AND label_id = ?", issueID, labelID).Get(new(IssueLabel))
  317. return has
  318. }
  319. // HasIssueLabel returns true if issue has been labeled.
  320. func HasIssueLabel(issueID, labelID int64) bool {
  321. return hasIssueLabel(x, issueID, labelID)
  322. }
  323. func newIssueLabel(e *xorm.Session, issue *Issue, label *Label, doer *User) (err error) {
  324. if _, err = e.Insert(&IssueLabel{
  325. IssueID: issue.ID,
  326. LabelID: label.ID,
  327. }); err != nil {
  328. return err
  329. }
  330. if err = issue.loadRepo(e); err != nil {
  331. return
  332. }
  333. if _, err = createLabelComment(e, doer, issue.Repo, issue, label, true); err != nil {
  334. return err
  335. }
  336. return updateLabel(e, label)
  337. }
  338. // NewIssueLabel creates a new issue-label relation.
  339. func NewIssueLabel(issue *Issue, label *Label, doer *User) (err error) {
  340. if HasIssueLabel(issue.ID, label.ID) {
  341. return nil
  342. }
  343. sess := x.NewSession()
  344. defer sess.Close()
  345. if err = sess.Begin(); err != nil {
  346. return err
  347. }
  348. if err = newIssueLabel(sess, issue, label, doer); err != nil {
  349. return err
  350. }
  351. return sess.Commit()
  352. }
  353. func newIssueLabels(e *xorm.Session, issue *Issue, labels []*Label, doer *User) (err error) {
  354. for i := range labels {
  355. if hasIssueLabel(e, issue.ID, labels[i].ID) {
  356. continue
  357. }
  358. if err = newIssueLabel(e, issue, labels[i], doer); err != nil {
  359. return fmt.Errorf("newIssueLabel: %v", err)
  360. }
  361. }
  362. return nil
  363. }
  364. // NewIssueLabels creates a list of issue-label relations.
  365. func NewIssueLabels(issue *Issue, labels []*Label, doer *User) (err error) {
  366. sess := x.NewSession()
  367. defer sess.Close()
  368. if err = sess.Begin(); err != nil {
  369. return err
  370. }
  371. if err = newIssueLabels(sess, issue, labels, doer); err != nil {
  372. return err
  373. }
  374. return sess.Commit()
  375. }
  376. func deleteIssueLabel(e *xorm.Session, issue *Issue, label *Label, doer *User) (err error) {
  377. if count, err := e.Delete(&IssueLabel{
  378. IssueID: issue.ID,
  379. LabelID: label.ID,
  380. }); err != nil {
  381. return err
  382. } else if count == 0 {
  383. return nil
  384. }
  385. if err = issue.loadRepo(e); err != nil {
  386. return
  387. }
  388. if _, err = createLabelComment(e, doer, issue.Repo, issue, label, false); err != nil {
  389. return err
  390. }
  391. return updateLabel(e, label)
  392. }
  393. // DeleteIssueLabel deletes issue-label relation.
  394. func DeleteIssueLabel(issue *Issue, label *Label, doer *User) (err error) {
  395. sess := x.NewSession()
  396. defer sess.Close()
  397. if err = sess.Begin(); err != nil {
  398. return err
  399. }
  400. if err = deleteIssueLabel(sess, issue, label, doer); err != nil {
  401. return err
  402. }
  403. return sess.Commit()
  404. }