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.

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