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 11KB

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