選択できるのは25トピックまでです。 トピックは、先頭が英数字で、英数字とダッシュ('-')を使用した35文字以内のものにしてください。

pull.go 22KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802
  1. // Copyright 2015 The Gogs Authors. All rights reserved.
  2. // Copyright 2019 The Gitea Authors. All rights reserved.
  3. // Use of this source code is governed by a MIT-style
  4. // license that can be found in the LICENSE file.
  5. package models
  6. import (
  7. "fmt"
  8. "io"
  9. "strings"
  10. "code.gitea.io/gitea/modules/git"
  11. "code.gitea.io/gitea/modules/log"
  12. "code.gitea.io/gitea/modules/setting"
  13. "code.gitea.io/gitea/modules/timeutil"
  14. )
  15. // PullRequestType defines pull request type
  16. type PullRequestType int
  17. // Enumerate all the pull request types
  18. const (
  19. PullRequestGitea PullRequestType = iota
  20. PullRequestGit
  21. )
  22. // PullRequestStatus defines pull request status
  23. type PullRequestStatus int
  24. // Enumerate all the pull request status
  25. const (
  26. PullRequestStatusConflict PullRequestStatus = iota
  27. PullRequestStatusChecking
  28. PullRequestStatusMergeable
  29. PullRequestStatusManuallyMerged
  30. PullRequestStatusError
  31. )
  32. // PullRequest represents relation between pull request and repositories.
  33. type PullRequest struct {
  34. ID int64 `xorm:"pk autoincr"`
  35. Type PullRequestType
  36. Status PullRequestStatus
  37. ConflictedFiles []string `xorm:"TEXT JSON"`
  38. IssueID int64 `xorm:"INDEX"`
  39. Issue *Issue `xorm:"-"`
  40. Index int64
  41. HeadRepoID int64 `xorm:"INDEX"`
  42. HeadRepo *Repository `xorm:"-"`
  43. BaseRepoID int64 `xorm:"INDEX"`
  44. BaseRepo *Repository `xorm:"-"`
  45. HeadBranch string
  46. BaseBranch string
  47. ProtectedBranch *ProtectedBranch `xorm:"-"`
  48. MergeBase string `xorm:"VARCHAR(40)"`
  49. HasMerged bool `xorm:"INDEX"`
  50. MergedCommitID string `xorm:"VARCHAR(40)"`
  51. MergerID int64 `xorm:"INDEX"`
  52. Merger *User `xorm:"-"`
  53. MergedUnix timeutil.TimeStamp `xorm:"updated INDEX"`
  54. isHeadRepoLoaded bool `xorm:"-"`
  55. }
  56. // MustHeadUserName returns the HeadRepo's username if failed return blank
  57. func (pr *PullRequest) MustHeadUserName() string {
  58. if err := pr.LoadHeadRepo(); err != nil {
  59. if !IsErrRepoNotExist(err) {
  60. log.Error("LoadHeadRepo: %v", err)
  61. } else {
  62. log.Warn("LoadHeadRepo %d but repository does not exist: %v", pr.HeadRepoID, err)
  63. }
  64. return ""
  65. }
  66. if pr.HeadRepo == nil {
  67. return ""
  68. }
  69. return pr.HeadRepo.OwnerName
  70. }
  71. // Note: don't try to get Issue because will end up recursive querying.
  72. func (pr *PullRequest) loadAttributes(e Engine) (err error) {
  73. if pr.HasMerged && pr.Merger == nil {
  74. pr.Merger, err = getUserByID(e, pr.MergerID)
  75. if IsErrUserNotExist(err) {
  76. pr.MergerID = -1
  77. pr.Merger = NewGhostUser()
  78. } else if err != nil {
  79. return fmt.Errorf("getUserByID [%d]: %v", pr.MergerID, err)
  80. }
  81. }
  82. return nil
  83. }
  84. // LoadAttributes loads pull request attributes from database
  85. func (pr *PullRequest) LoadAttributes() error {
  86. return pr.loadAttributes(x)
  87. }
  88. func (pr *PullRequest) loadHeadRepo(e Engine) (err error) {
  89. if !pr.isHeadRepoLoaded && pr.HeadRepo == nil && pr.HeadRepoID > 0 {
  90. if pr.HeadRepoID == pr.BaseRepoID {
  91. if pr.BaseRepo != nil {
  92. pr.HeadRepo = pr.BaseRepo
  93. return nil
  94. } else if pr.Issue != nil && pr.Issue.Repo != nil {
  95. pr.HeadRepo = pr.Issue.Repo
  96. return nil
  97. }
  98. }
  99. pr.HeadRepo, err = getRepositoryByID(e, pr.HeadRepoID)
  100. if err != nil && !IsErrRepoNotExist(err) { // Head repo maybe deleted, but it should still work
  101. return fmt.Errorf("getRepositoryByID(head): %v", err)
  102. }
  103. pr.isHeadRepoLoaded = true
  104. }
  105. return nil
  106. }
  107. // LoadHeadRepo loads the head repository
  108. func (pr *PullRequest) LoadHeadRepo() error {
  109. return pr.loadHeadRepo(x)
  110. }
  111. // LoadBaseRepo loads the target repository
  112. func (pr *PullRequest) LoadBaseRepo() error {
  113. return pr.loadBaseRepo(x)
  114. }
  115. func (pr *PullRequest) loadBaseRepo(e Engine) (err error) {
  116. if pr.BaseRepo != nil {
  117. return nil
  118. }
  119. if pr.HeadRepoID == pr.BaseRepoID && pr.HeadRepo != nil {
  120. pr.BaseRepo = pr.HeadRepo
  121. return nil
  122. }
  123. if pr.Issue != nil && pr.Issue.Repo != nil {
  124. pr.BaseRepo = pr.Issue.Repo
  125. return nil
  126. }
  127. pr.BaseRepo, err = getRepositoryByID(e, pr.BaseRepoID)
  128. if err != nil {
  129. return fmt.Errorf("GetRepositoryByID(base): %v", err)
  130. }
  131. return nil
  132. }
  133. // LoadIssue loads issue information from database
  134. func (pr *PullRequest) LoadIssue() (err error) {
  135. return pr.loadIssue(x)
  136. }
  137. func (pr *PullRequest) loadIssue(e Engine) (err error) {
  138. if pr.Issue != nil {
  139. return nil
  140. }
  141. pr.Issue, err = getIssueByID(e, pr.IssueID)
  142. if err == nil {
  143. pr.Issue.PullRequest = pr
  144. }
  145. return err
  146. }
  147. // LoadProtectedBranch loads the protected branch of the base branch
  148. func (pr *PullRequest) LoadProtectedBranch() (err error) {
  149. return pr.loadProtectedBranch(x)
  150. }
  151. func (pr *PullRequest) loadProtectedBranch(e Engine) (err error) {
  152. if pr.ProtectedBranch == nil {
  153. if pr.BaseRepo == nil {
  154. if pr.BaseRepoID == 0 {
  155. return nil
  156. }
  157. pr.BaseRepo, err = getRepositoryByID(e, pr.BaseRepoID)
  158. if err != nil {
  159. return
  160. }
  161. }
  162. pr.ProtectedBranch, err = getProtectedBranchBy(e, pr.BaseRepo.ID, pr.BaseBranch)
  163. }
  164. return
  165. }
  166. // GetDefaultMergeMessage returns default message used when merging pull request
  167. func (pr *PullRequest) GetDefaultMergeMessage() string {
  168. if pr.HeadRepo == nil {
  169. var err error
  170. pr.HeadRepo, err = GetRepositoryByID(pr.HeadRepoID)
  171. if err != nil {
  172. log.Error("GetRepositoryById[%d]: %v", pr.HeadRepoID, err)
  173. return ""
  174. }
  175. }
  176. if err := pr.LoadIssue(); err != nil {
  177. log.Error("Cannot load issue %d for PR id %d: Error: %v", pr.IssueID, pr.ID, err)
  178. return ""
  179. }
  180. if pr.BaseRepoID == pr.HeadRepoID {
  181. return fmt.Sprintf("Merge pull request '%s' (#%d) from %s into %s", pr.Issue.Title, pr.Issue.Index, pr.HeadBranch, pr.BaseBranch)
  182. }
  183. return fmt.Sprintf("Merge pull request '%s' (#%d) from %s:%s into %s", pr.Issue.Title, pr.Issue.Index, pr.HeadRepo.FullName(), pr.HeadBranch, pr.BaseBranch)
  184. }
  185. // GetCommitMessages returns the commit messages between head and merge base (if there is one)
  186. func (pr *PullRequest) GetCommitMessages() string {
  187. if err := pr.LoadIssue(); err != nil {
  188. log.Error("Cannot load issue %d for PR id %d: Error: %v", pr.IssueID, pr.ID, err)
  189. return ""
  190. }
  191. if err := pr.Issue.LoadPoster(); err != nil {
  192. log.Error("Cannot load poster %d for pr id %d, index %d Error: %v", pr.Issue.PosterID, pr.ID, pr.Index, err)
  193. return ""
  194. }
  195. if pr.HeadRepo == nil {
  196. var err error
  197. pr.HeadRepo, err = GetRepositoryByID(pr.HeadRepoID)
  198. if err != nil {
  199. log.Error("GetRepositoryById[%d]: %v", pr.HeadRepoID, err)
  200. return ""
  201. }
  202. }
  203. gitRepo, err := git.OpenRepository(pr.HeadRepo.RepoPath())
  204. if err != nil {
  205. log.Error("Unable to open head repository: Error: %v", err)
  206. return ""
  207. }
  208. defer gitRepo.Close()
  209. headCommit, err := gitRepo.GetBranchCommit(pr.HeadBranch)
  210. if err != nil {
  211. log.Error("Unable to get head commit: %s Error: %v", pr.HeadBranch, err)
  212. return ""
  213. }
  214. mergeBase, err := gitRepo.GetCommit(pr.MergeBase)
  215. if err != nil {
  216. log.Error("Unable to get merge base commit: %s Error: %v", pr.MergeBase, err)
  217. return ""
  218. }
  219. limit := setting.Repository.PullRequest.DefaultMergeMessageCommitsLimit
  220. list, err := gitRepo.CommitsBetweenLimit(headCommit, mergeBase, limit, 0)
  221. if err != nil {
  222. log.Error("Unable to get commits between: %s %s Error: %v", pr.HeadBranch, pr.MergeBase, err)
  223. return ""
  224. }
  225. maxSize := setting.Repository.PullRequest.DefaultMergeMessageSize
  226. posterSig := pr.Issue.Poster.NewGitSig().String()
  227. authorsMap := map[string]bool{}
  228. authors := make([]string, 0, list.Len())
  229. stringBuilder := strings.Builder{}
  230. element := list.Front()
  231. for element != nil {
  232. commit := element.Value.(*git.Commit)
  233. if maxSize < 0 || stringBuilder.Len() < maxSize {
  234. toWrite := []byte(commit.CommitMessage)
  235. if len(toWrite) > maxSize-stringBuilder.Len() && maxSize > -1 {
  236. toWrite = append(toWrite[:maxSize-stringBuilder.Len()], "..."...)
  237. }
  238. if _, err := stringBuilder.Write(toWrite); err != nil {
  239. log.Error("Unable to write commit message Error: %v", err)
  240. return ""
  241. }
  242. if _, err := stringBuilder.WriteRune('\n'); err != nil {
  243. log.Error("Unable to write commit message Error: %v", err)
  244. return ""
  245. }
  246. }
  247. authorString := commit.Author.String()
  248. if !authorsMap[authorString] && authorString != posterSig {
  249. authors = append(authors, authorString)
  250. authorsMap[authorString] = true
  251. }
  252. element = element.Next()
  253. }
  254. // Consider collecting the remaining authors
  255. if limit >= 0 && setting.Repository.PullRequest.DefaultMergeMessageAllAuthors {
  256. skip := limit
  257. limit = 30
  258. for {
  259. list, err := gitRepo.CommitsBetweenLimit(headCommit, mergeBase, limit, skip)
  260. if err != nil {
  261. log.Error("Unable to get commits between: %s %s Error: %v", pr.HeadBranch, pr.MergeBase, err)
  262. return ""
  263. }
  264. if list.Len() == 0 {
  265. break
  266. }
  267. element := list.Front()
  268. for element != nil {
  269. commit := element.Value.(*git.Commit)
  270. authorString := commit.Author.String()
  271. if !authorsMap[authorString] && authorString != posterSig {
  272. authors = append(authors, authorString)
  273. authorsMap[authorString] = true
  274. }
  275. element = element.Next()
  276. }
  277. }
  278. }
  279. if len(authors) > 0 {
  280. if _, err := stringBuilder.WriteRune('\n'); err != nil {
  281. log.Error("Unable to write to string builder Error: %v", err)
  282. return ""
  283. }
  284. }
  285. for _, author := range authors {
  286. if _, err := stringBuilder.Write([]byte("Co-authored-by: ")); err != nil {
  287. log.Error("Unable to write to string builder Error: %v", err)
  288. return ""
  289. }
  290. if _, err := stringBuilder.Write([]byte(author)); err != nil {
  291. log.Error("Unable to write to string builder Error: %v", err)
  292. return ""
  293. }
  294. if _, err := stringBuilder.WriteRune('\n'); err != nil {
  295. log.Error("Unable to write to string builder Error: %v", err)
  296. return ""
  297. }
  298. }
  299. return stringBuilder.String()
  300. }
  301. // GetApprovers returns the approvers of the pull request
  302. func (pr *PullRequest) GetApprovers() string {
  303. stringBuilder := strings.Builder{}
  304. if err := pr.getReviewedByLines(&stringBuilder); err != nil {
  305. log.Error("Unable to getReviewedByLines: Error: %v", err)
  306. return ""
  307. }
  308. return stringBuilder.String()
  309. }
  310. func (pr *PullRequest) getReviewedByLines(writer io.Writer) error {
  311. maxReviewers := setting.Repository.PullRequest.DefaultMergeMessageMaxApprovers
  312. if maxReviewers == 0 {
  313. return nil
  314. }
  315. sess := x.NewSession()
  316. defer sess.Close()
  317. if err := sess.Begin(); err != nil {
  318. return err
  319. }
  320. // Note: This doesn't page as we only expect a very limited number of reviews
  321. reviews, err := findReviews(sess, FindReviewOptions{
  322. Type: ReviewTypeApprove,
  323. IssueID: pr.IssueID,
  324. OfficialOnly: setting.Repository.PullRequest.DefaultMergeMessageOfficialApproversOnly,
  325. })
  326. if err != nil {
  327. log.Error("Unable to FindReviews for PR ID %d: %v", pr.ID, err)
  328. return err
  329. }
  330. reviewersWritten := 0
  331. for _, review := range reviews {
  332. if maxReviewers > 0 && reviewersWritten > maxReviewers {
  333. break
  334. }
  335. if err := review.loadReviewer(sess); err != nil && !IsErrUserNotExist(err) {
  336. log.Error("Unable to LoadReviewer[%d] for PR ID %d : %v", review.ReviewerID, pr.ID, err)
  337. return err
  338. } else if review.Reviewer == nil {
  339. continue
  340. }
  341. if _, err := writer.Write([]byte("Reviewed-by: ")); err != nil {
  342. return err
  343. }
  344. if _, err := writer.Write([]byte(review.Reviewer.NewGitSig().String())); err != nil {
  345. return err
  346. }
  347. if _, err := writer.Write([]byte{'\n'}); err != nil {
  348. return err
  349. }
  350. reviewersWritten++
  351. }
  352. return sess.Commit()
  353. }
  354. // GetDefaultSquashMessage returns default message used when squash and merging pull request
  355. func (pr *PullRequest) GetDefaultSquashMessage() string {
  356. if err := pr.LoadIssue(); err != nil {
  357. log.Error("LoadIssue: %v", err)
  358. return ""
  359. }
  360. if err := pr.LoadBaseRepo(); err != nil {
  361. log.Error("LoadBaseRepo: %v", err)
  362. return ""
  363. }
  364. if pr.BaseRepo.UnitEnabled(UnitTypeExternalTracker) {
  365. return fmt.Sprintf("%s (!%d)", pr.Issue.Title, pr.Issue.Index)
  366. }
  367. return fmt.Sprintf("%s (#%d)", pr.Issue.Title, pr.Issue.Index)
  368. }
  369. // GetGitRefName returns git ref for hidden pull request branch
  370. func (pr *PullRequest) GetGitRefName() string {
  371. return fmt.Sprintf("refs/pull/%d/head", pr.Index)
  372. }
  373. // IsChecking returns true if this pull request is still checking conflict.
  374. func (pr *PullRequest) IsChecking() bool {
  375. return pr.Status == PullRequestStatusChecking
  376. }
  377. // CanAutoMerge returns true if this pull request can be merged automatically.
  378. func (pr *PullRequest) CanAutoMerge() bool {
  379. return pr.Status == PullRequestStatusMergeable
  380. }
  381. // GetLastCommitStatus returns the last commit status for this pull request.
  382. func (pr *PullRequest) GetLastCommitStatus() (status *CommitStatus, err error) {
  383. if err = pr.LoadHeadRepo(); err != nil {
  384. return nil, err
  385. }
  386. if pr.HeadRepo == nil {
  387. return nil, ErrPullRequestHeadRepoMissing{pr.ID, pr.HeadRepoID}
  388. }
  389. headGitRepo, err := git.OpenRepository(pr.HeadRepo.RepoPath())
  390. if err != nil {
  391. return nil, err
  392. }
  393. defer headGitRepo.Close()
  394. lastCommitID, err := headGitRepo.GetBranchCommitID(pr.HeadBranch)
  395. if err != nil {
  396. return nil, err
  397. }
  398. err = pr.LoadBaseRepo()
  399. if err != nil {
  400. return nil, err
  401. }
  402. statusList, err := GetLatestCommitStatus(pr.BaseRepo, lastCommitID, 0)
  403. if err != nil {
  404. return nil, err
  405. }
  406. return CalcCommitStatus(statusList), nil
  407. }
  408. // MergeStyle represents the approach to merge commits into base branch.
  409. type MergeStyle string
  410. const (
  411. // MergeStyleMerge create merge commit
  412. MergeStyleMerge MergeStyle = "merge"
  413. // MergeStyleRebase rebase before merging
  414. MergeStyleRebase MergeStyle = "rebase"
  415. // MergeStyleRebaseMerge rebase before merging with merge commit (--no-ff)
  416. MergeStyleRebaseMerge MergeStyle = "rebase-merge"
  417. // MergeStyleSquash squash commits into single commit before merging
  418. MergeStyleSquash MergeStyle = "squash"
  419. )
  420. // SetMerged sets a pull request to merged and closes the corresponding issue
  421. func (pr *PullRequest) SetMerged() (bool, error) {
  422. if pr.HasMerged {
  423. return false, fmt.Errorf("PullRequest[%d] already merged", pr.Index)
  424. }
  425. if pr.MergedCommitID == "" || pr.MergedUnix == 0 || pr.Merger == nil {
  426. return false, fmt.Errorf("Unable to merge PullRequest[%d], some required fields are empty", pr.Index)
  427. }
  428. pr.HasMerged = true
  429. sess := x.NewSession()
  430. defer sess.Close()
  431. if err := sess.Begin(); err != nil {
  432. return false, err
  433. }
  434. if _, err := sess.Exec("UPDATE `issue` SET `repo_id` = `repo_id` WHERE `id` = ?", pr.IssueID); err != nil {
  435. return false, err
  436. }
  437. if _, err := sess.Exec("UPDATE `pull_request` SET `issue_id` = `issue_id` WHERE `id` = ?", pr.ID); err != nil {
  438. return false, err
  439. }
  440. pr.Issue = nil
  441. if err := pr.loadIssue(sess); err != nil {
  442. return false, err
  443. }
  444. if tmpPr, err := getPullRequestByID(sess, pr.ID); err != nil {
  445. return false, err
  446. } else if tmpPr.HasMerged {
  447. if pr.Issue.IsClosed {
  448. return false, nil
  449. }
  450. return false, fmt.Errorf("PullRequest[%d] already merged but it's associated issue [%d] is not closed", pr.Index, pr.IssueID)
  451. } else if pr.Issue.IsClosed {
  452. return false, fmt.Errorf("PullRequest[%d] already closed", pr.Index)
  453. }
  454. if err := pr.Issue.loadRepo(sess); err != nil {
  455. return false, err
  456. }
  457. if err := pr.Issue.Repo.getOwner(sess); err != nil {
  458. return false, err
  459. }
  460. if _, err := pr.Issue.changeStatus(sess, pr.Merger, true); err != nil {
  461. return false, fmt.Errorf("Issue.changeStatus: %v", err)
  462. }
  463. if _, err := sess.Where("id = ?", pr.ID).Cols("has_merged, status, merged_commit_id, merger_id, merged_unix").Update(pr); err != nil {
  464. return false, fmt.Errorf("Failed to update pr[%d]: %v", pr.ID, err)
  465. }
  466. if err := sess.Commit(); err != nil {
  467. return false, fmt.Errorf("Commit: %v", err)
  468. }
  469. return true, nil
  470. }
  471. // NewPullRequest creates new pull request with labels for repository.
  472. func NewPullRequest(repo *Repository, pull *Issue, labelIDs []int64, uuids []string, pr *PullRequest) (err error) {
  473. // Retry several times in case INSERT fails due to duplicate key for (repo_id, index); see #7887
  474. i := 0
  475. for {
  476. if err = newPullRequestAttempt(repo, pull, labelIDs, uuids, pr); err == nil {
  477. return nil
  478. }
  479. if !IsErrNewIssueInsert(err) {
  480. return err
  481. }
  482. if i++; i == issueMaxDupIndexAttempts {
  483. break
  484. }
  485. log.Error("NewPullRequest: error attempting to insert the new issue; will retry. Original error: %v", err)
  486. }
  487. return fmt.Errorf("NewPullRequest: too many errors attempting to insert the new issue. Last error was: %v", err)
  488. }
  489. func newPullRequestAttempt(repo *Repository, pull *Issue, labelIDs []int64, uuids []string, pr *PullRequest) (err error) {
  490. sess := x.NewSession()
  491. defer sess.Close()
  492. if err = sess.Begin(); err != nil {
  493. return err
  494. }
  495. if err = newIssue(sess, pull.Poster, NewIssueOptions{
  496. Repo: repo,
  497. Issue: pull,
  498. LabelIDs: labelIDs,
  499. Attachments: uuids,
  500. IsPull: true,
  501. }); err != nil {
  502. if IsErrUserDoesNotHaveAccessToRepo(err) || IsErrNewIssueInsert(err) {
  503. return err
  504. }
  505. return fmt.Errorf("newIssue: %v", err)
  506. }
  507. pr.Index = pull.Index
  508. pr.BaseRepo = repo
  509. pr.IssueID = pull.ID
  510. if _, err = sess.Insert(pr); err != nil {
  511. return fmt.Errorf("insert pull repo: %v", err)
  512. }
  513. if err = sess.Commit(); err != nil {
  514. return fmt.Errorf("Commit: %v", err)
  515. }
  516. return nil
  517. }
  518. // GetUnmergedPullRequest returns a pull request that is open and has not been merged
  519. // by given head/base and repo/branch.
  520. func GetUnmergedPullRequest(headRepoID, baseRepoID int64, headBranch, baseBranch string) (*PullRequest, error) {
  521. pr := new(PullRequest)
  522. has, err := x.
  523. Where("head_repo_id=? AND head_branch=? AND base_repo_id=? AND base_branch=? AND has_merged=? AND issue.is_closed=?",
  524. headRepoID, headBranch, baseRepoID, baseBranch, false, false).
  525. Join("INNER", "issue", "issue.id=pull_request.issue_id").
  526. Get(pr)
  527. if err != nil {
  528. return nil, err
  529. } else if !has {
  530. return nil, ErrPullRequestNotExist{0, 0, headRepoID, baseRepoID, headBranch, baseBranch}
  531. }
  532. return pr, nil
  533. }
  534. // GetLatestPullRequestByHeadInfo returns the latest pull request (regardless of its status)
  535. // by given head information (repo and branch).
  536. func GetLatestPullRequestByHeadInfo(repoID int64, branch string) (*PullRequest, error) {
  537. pr := new(PullRequest)
  538. has, err := x.
  539. Where("head_repo_id = ? AND head_branch = ?", repoID, branch).
  540. OrderBy("id DESC").
  541. Get(pr)
  542. if !has {
  543. return nil, err
  544. }
  545. return pr, err
  546. }
  547. // GetPullRequestByIndex returns a pull request by the given index
  548. func GetPullRequestByIndex(repoID int64, index int64) (*PullRequest, error) {
  549. pr := &PullRequest{
  550. BaseRepoID: repoID,
  551. Index: index,
  552. }
  553. has, err := x.Get(pr)
  554. if err != nil {
  555. return nil, err
  556. } else if !has {
  557. return nil, ErrPullRequestNotExist{0, 0, 0, repoID, "", ""}
  558. }
  559. if err = pr.LoadAttributes(); err != nil {
  560. return nil, err
  561. }
  562. if err = pr.LoadIssue(); err != nil {
  563. return nil, err
  564. }
  565. return pr, nil
  566. }
  567. func getPullRequestByID(e Engine, id int64) (*PullRequest, error) {
  568. pr := new(PullRequest)
  569. has, err := e.ID(id).Get(pr)
  570. if err != nil {
  571. return nil, err
  572. } else if !has {
  573. return nil, ErrPullRequestNotExist{id, 0, 0, 0, "", ""}
  574. }
  575. return pr, pr.loadAttributes(e)
  576. }
  577. // GetPullRequestByID returns a pull request by given ID.
  578. func GetPullRequestByID(id int64) (*PullRequest, error) {
  579. return getPullRequestByID(x, id)
  580. }
  581. // GetPullRequestByIssueIDWithNoAttributes returns pull request with no attributes loaded by given issue ID.
  582. func GetPullRequestByIssueIDWithNoAttributes(issueID int64) (*PullRequest, error) {
  583. var pr PullRequest
  584. has, err := x.Where("issue_id = ?", issueID).Get(&pr)
  585. if err != nil {
  586. return nil, err
  587. }
  588. if !has {
  589. return nil, ErrPullRequestNotExist{0, issueID, 0, 0, "", ""}
  590. }
  591. return &pr, nil
  592. }
  593. func getPullRequestByIssueID(e Engine, issueID int64) (*PullRequest, error) {
  594. pr := &PullRequest{
  595. IssueID: issueID,
  596. }
  597. has, err := e.Get(pr)
  598. if err != nil {
  599. return nil, err
  600. } else if !has {
  601. return nil, ErrPullRequestNotExist{0, issueID, 0, 0, "", ""}
  602. }
  603. return pr, pr.loadAttributes(e)
  604. }
  605. // GetPullRequestByIssueID returns pull request by given issue ID.
  606. func GetPullRequestByIssueID(issueID int64) (*PullRequest, error) {
  607. return getPullRequestByIssueID(x, issueID)
  608. }
  609. // Update updates all fields of pull request.
  610. func (pr *PullRequest) Update() error {
  611. _, err := x.ID(pr.ID).AllCols().Update(pr)
  612. return err
  613. }
  614. // UpdateCols updates specific fields of pull request.
  615. func (pr *PullRequest) UpdateCols(cols ...string) error {
  616. _, err := x.ID(pr.ID).Cols(cols...).Update(pr)
  617. return err
  618. }
  619. // UpdateColsIfNotMerged updates specific fields of a pull request if it has not been merged
  620. func (pr *PullRequest) UpdateColsIfNotMerged(cols ...string) error {
  621. _, err := x.Where("id = ? AND has_merged = ?", pr.ID, false).Cols(cols...).Update(pr)
  622. return err
  623. }
  624. // IsWorkInProgress determine if the Pull Request is a Work In Progress by its title
  625. func (pr *PullRequest) IsWorkInProgress() bool {
  626. if err := pr.LoadIssue(); err != nil {
  627. log.Error("LoadIssue: %v", err)
  628. return false
  629. }
  630. for _, prefix := range setting.Repository.PullRequest.WorkInProgressPrefixes {
  631. if strings.HasPrefix(strings.ToUpper(pr.Issue.Title), prefix) {
  632. return true
  633. }
  634. }
  635. return false
  636. }
  637. // IsFilesConflicted determines if the Pull Request has changes conflicting with the target branch.
  638. func (pr *PullRequest) IsFilesConflicted() bool {
  639. return len(pr.ConflictedFiles) > 0
  640. }
  641. // GetWorkInProgressPrefix returns the prefix used to mark the pull request as a work in progress.
  642. // It returns an empty string when none were found
  643. func (pr *PullRequest) GetWorkInProgressPrefix() string {
  644. if err := pr.LoadIssue(); err != nil {
  645. log.Error("LoadIssue: %v", err)
  646. return ""
  647. }
  648. for _, prefix := range setting.Repository.PullRequest.WorkInProgressPrefixes {
  649. if strings.HasPrefix(strings.ToUpper(pr.Issue.Title), prefix) {
  650. return pr.Issue.Title[0:len(prefix)]
  651. }
  652. }
  653. return ""
  654. }
  655. // IsHeadEqualWithBranch returns if the commits of branchName are available in pull request head
  656. func (pr *PullRequest) IsHeadEqualWithBranch(branchName string) (bool, error) {
  657. var err error
  658. if err = pr.LoadBaseRepo(); err != nil {
  659. return false, err
  660. }
  661. baseGitRepo, err := git.OpenRepository(pr.BaseRepo.RepoPath())
  662. if err != nil {
  663. return false, err
  664. }
  665. baseCommit, err := baseGitRepo.GetBranchCommit(branchName)
  666. if err != nil {
  667. return false, err
  668. }
  669. if err = pr.LoadHeadRepo(); err != nil {
  670. return false, err
  671. }
  672. headGitRepo, err := git.OpenRepository(pr.HeadRepo.RepoPath())
  673. if err != nil {
  674. return false, err
  675. }
  676. headCommit, err := headGitRepo.GetBranchCommit(pr.HeadBranch)
  677. if err != nil {
  678. return false, err
  679. }
  680. return baseCommit.HasPreviousCommit(headCommit.ID)
  681. }
  682. // IsSameRepo returns true if base repo and head repo is the same
  683. func (pr *PullRequest) IsSameRepo() bool {
  684. return pr.BaseRepoID == pr.HeadRepoID
  685. }