Du kannst nicht mehr als 25 Themen auswählen Themen müssen mit entweder einem Buchstaben oder einer Ziffer beginnen. Sie können Bindestriche („-“) enthalten und bis zu 35 Zeichen lang sein.

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