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.

pull.go 21KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720
  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/models/db"
  11. "code.gitea.io/gitea/models/unit"
  12. user_model "code.gitea.io/gitea/models/user"
  13. "code.gitea.io/gitea/modules/git"
  14. "code.gitea.io/gitea/modules/log"
  15. "code.gitea.io/gitea/modules/setting"
  16. "code.gitea.io/gitea/modules/timeutil"
  17. "code.gitea.io/gitea/modules/util"
  18. )
  19. // PullRequestType defines pull request type
  20. type PullRequestType int
  21. // Enumerate all the pull request types
  22. const (
  23. PullRequestGitea PullRequestType = iota
  24. PullRequestGit
  25. )
  26. // PullRequestStatus defines pull request status
  27. type PullRequestStatus int
  28. // Enumerate all the pull request status
  29. const (
  30. PullRequestStatusConflict PullRequestStatus = iota
  31. PullRequestStatusChecking
  32. PullRequestStatusMergeable
  33. PullRequestStatusManuallyMerged
  34. PullRequestStatusError
  35. PullRequestStatusEmpty
  36. )
  37. // PullRequestFlow the flow of pull request
  38. type PullRequestFlow int
  39. const (
  40. // PullRequestFlowGithub github flow from head branch to base branch
  41. PullRequestFlowGithub PullRequestFlow = iota
  42. // PullRequestFlowAGit Agit flow pull request, head branch is not exist
  43. PullRequestFlowAGit
  44. )
  45. // PullRequest represents relation between pull request and repositories.
  46. type PullRequest struct {
  47. ID int64 `xorm:"pk autoincr"`
  48. Type PullRequestType
  49. Status PullRequestStatus
  50. ConflictedFiles []string `xorm:"TEXT JSON"`
  51. CommitsAhead int
  52. CommitsBehind int
  53. ChangedProtectedFiles []string `xorm:"TEXT JSON"`
  54. IssueID int64 `xorm:"INDEX"`
  55. Issue *Issue `xorm:"-"`
  56. Index int64
  57. HeadRepoID int64 `xorm:"INDEX"`
  58. HeadRepo *Repository `xorm:"-"`
  59. BaseRepoID int64 `xorm:"INDEX"`
  60. BaseRepo *Repository `xorm:"-"`
  61. HeadBranch string
  62. HeadCommitID string `xorm:"-"`
  63. BaseBranch string
  64. ProtectedBranch *ProtectedBranch `xorm:"-"`
  65. MergeBase string `xorm:"VARCHAR(40)"`
  66. HasMerged bool `xorm:"INDEX"`
  67. MergedCommitID string `xorm:"VARCHAR(40)"`
  68. MergerID int64 `xorm:"INDEX"`
  69. Merger *user_model.User `xorm:"-"`
  70. MergedUnix timeutil.TimeStamp `xorm:"updated INDEX"`
  71. isHeadRepoLoaded bool `xorm:"-"`
  72. Flow PullRequestFlow `xorm:"NOT NULL DEFAULT 0"`
  73. }
  74. func init() {
  75. db.RegisterModel(new(PullRequest))
  76. }
  77. // MustHeadUserName returns the HeadRepo's username if failed return blank
  78. func (pr *PullRequest) MustHeadUserName() string {
  79. if err := pr.LoadHeadRepo(); err != nil {
  80. if !IsErrRepoNotExist(err) {
  81. log.Error("LoadHeadRepo: %v", err)
  82. } else {
  83. log.Warn("LoadHeadRepo %d but repository does not exist: %v", pr.HeadRepoID, err)
  84. }
  85. return ""
  86. }
  87. if pr.HeadRepo == nil {
  88. return ""
  89. }
  90. return pr.HeadRepo.OwnerName
  91. }
  92. // Note: don't try to get Issue because will end up recursive querying.
  93. func (pr *PullRequest) loadAttributes(e db.Engine) (err error) {
  94. if pr.HasMerged && pr.Merger == nil {
  95. pr.Merger, err = user_model.GetUserByIDEngine(e, pr.MergerID)
  96. if user_model.IsErrUserNotExist(err) {
  97. pr.MergerID = -1
  98. pr.Merger = user_model.NewGhostUser()
  99. } else if err != nil {
  100. return fmt.Errorf("getUserByID [%d]: %v", pr.MergerID, err)
  101. }
  102. }
  103. return nil
  104. }
  105. // LoadAttributes loads pull request attributes from database
  106. func (pr *PullRequest) LoadAttributes() error {
  107. return pr.loadAttributes(db.GetEngine(db.DefaultContext))
  108. }
  109. func (pr *PullRequest) loadHeadRepo(e db.Engine) (err error) {
  110. if !pr.isHeadRepoLoaded && pr.HeadRepo == nil && pr.HeadRepoID > 0 {
  111. if pr.HeadRepoID == pr.BaseRepoID {
  112. if pr.BaseRepo != nil {
  113. pr.HeadRepo = pr.BaseRepo
  114. return nil
  115. } else if pr.Issue != nil && pr.Issue.Repo != nil {
  116. pr.HeadRepo = pr.Issue.Repo
  117. return nil
  118. }
  119. }
  120. pr.HeadRepo, err = getRepositoryByID(e, pr.HeadRepoID)
  121. if err != nil && !IsErrRepoNotExist(err) { // Head repo maybe deleted, but it should still work
  122. return fmt.Errorf("getRepositoryByID(head): %v", err)
  123. }
  124. pr.isHeadRepoLoaded = true
  125. }
  126. return nil
  127. }
  128. // LoadHeadRepo loads the head repository
  129. func (pr *PullRequest) LoadHeadRepo() error {
  130. return pr.loadHeadRepo(db.GetEngine(db.DefaultContext))
  131. }
  132. // LoadBaseRepo loads the target repository
  133. func (pr *PullRequest) LoadBaseRepo() error {
  134. return pr.loadBaseRepo(db.GetEngine(db.DefaultContext))
  135. }
  136. func (pr *PullRequest) loadBaseRepo(e db.Engine) (err error) {
  137. if pr.BaseRepo != nil {
  138. return nil
  139. }
  140. if pr.HeadRepoID == pr.BaseRepoID && pr.HeadRepo != nil {
  141. pr.BaseRepo = pr.HeadRepo
  142. return nil
  143. }
  144. if pr.Issue != nil && pr.Issue.Repo != nil {
  145. pr.BaseRepo = pr.Issue.Repo
  146. return nil
  147. }
  148. pr.BaseRepo, err = getRepositoryByID(e, pr.BaseRepoID)
  149. if err != nil {
  150. return fmt.Errorf("GetRepositoryByID(base): %v", err)
  151. }
  152. return nil
  153. }
  154. // LoadIssue loads issue information from database
  155. func (pr *PullRequest) LoadIssue() (err error) {
  156. return pr.loadIssue(db.GetEngine(db.DefaultContext))
  157. }
  158. func (pr *PullRequest) loadIssue(e db.Engine) (err error) {
  159. if pr.Issue != nil {
  160. return nil
  161. }
  162. pr.Issue, err = getIssueByID(e, pr.IssueID)
  163. if err == nil {
  164. pr.Issue.PullRequest = pr
  165. }
  166. return err
  167. }
  168. // LoadProtectedBranch loads the protected branch of the base branch
  169. func (pr *PullRequest) LoadProtectedBranch() (err error) {
  170. return pr.loadProtectedBranch(db.GetEngine(db.DefaultContext))
  171. }
  172. func (pr *PullRequest) loadProtectedBranch(e db.Engine) (err error) {
  173. if pr.ProtectedBranch == nil {
  174. if pr.BaseRepo == nil {
  175. if pr.BaseRepoID == 0 {
  176. return nil
  177. }
  178. pr.BaseRepo, err = getRepositoryByID(e, pr.BaseRepoID)
  179. if err != nil {
  180. return
  181. }
  182. }
  183. pr.ProtectedBranch, err = getProtectedBranchBy(e, pr.BaseRepo.ID, pr.BaseBranch)
  184. }
  185. return
  186. }
  187. // GetDefaultMergeMessage returns default message used when merging pull request
  188. func (pr *PullRequest) GetDefaultMergeMessage() string {
  189. if pr.HeadRepo == nil {
  190. var err error
  191. pr.HeadRepo, err = GetRepositoryByID(pr.HeadRepoID)
  192. if err != nil {
  193. log.Error("GetRepositoryById[%d]: %v", pr.HeadRepoID, err)
  194. return ""
  195. }
  196. }
  197. if err := pr.LoadIssue(); err != nil {
  198. log.Error("Cannot load issue %d for PR id %d: Error: %v", pr.IssueID, pr.ID, err)
  199. return ""
  200. }
  201. if err := pr.LoadBaseRepo(); err != nil {
  202. log.Error("LoadBaseRepo: %v", err)
  203. return ""
  204. }
  205. issueReference := "#"
  206. if pr.BaseRepo.UnitEnabled(unit.TypeExternalTracker) {
  207. issueReference = "!"
  208. }
  209. if pr.BaseRepoID == pr.HeadRepoID {
  210. return fmt.Sprintf("Merge pull request '%s' (%s%d) from %s into %s", pr.Issue.Title, issueReference, pr.Issue.Index, pr.HeadBranch, pr.BaseBranch)
  211. }
  212. return fmt.Sprintf("Merge pull request '%s' (%s%d) from %s:%s into %s", pr.Issue.Title, issueReference, pr.Issue.Index, pr.HeadRepo.FullName(), pr.HeadBranch, pr.BaseBranch)
  213. }
  214. // ReviewCount represents a count of Reviews
  215. type ReviewCount struct {
  216. IssueID int64
  217. Type ReviewType
  218. Count int64
  219. }
  220. // GetApprovalCounts returns the approval counts by type
  221. // FIXME: Only returns official counts due to double counting of non-official counts
  222. func (pr *PullRequest) GetApprovalCounts() ([]*ReviewCount, error) {
  223. return pr.getApprovalCounts(db.GetEngine(db.DefaultContext))
  224. }
  225. func (pr *PullRequest) getApprovalCounts(e db.Engine) ([]*ReviewCount, error) {
  226. rCounts := make([]*ReviewCount, 0, 6)
  227. sess := e.Where("issue_id = ?", pr.IssueID)
  228. return rCounts, sess.Select("issue_id, type, count(id) as `count`").Where("official = ? AND dismissed = ?", true, false).GroupBy("issue_id, type").Table("review").Find(&rCounts)
  229. }
  230. // GetApprovers returns the approvers of the pull request
  231. func (pr *PullRequest) GetApprovers() string {
  232. stringBuilder := strings.Builder{}
  233. if err := pr.getReviewedByLines(&stringBuilder); err != nil {
  234. log.Error("Unable to getReviewedByLines: Error: %v", err)
  235. return ""
  236. }
  237. return stringBuilder.String()
  238. }
  239. func (pr *PullRequest) getReviewedByLines(writer io.Writer) error {
  240. maxReviewers := setting.Repository.PullRequest.DefaultMergeMessageMaxApprovers
  241. if maxReviewers == 0 {
  242. return nil
  243. }
  244. ctx, committer, err := db.TxContext()
  245. if err != nil {
  246. return err
  247. }
  248. defer committer.Close()
  249. sess := db.GetEngine(ctx)
  250. // Note: This doesn't page as we only expect a very limited number of reviews
  251. reviews, err := findReviews(sess, FindReviewOptions{
  252. Type: ReviewTypeApprove,
  253. IssueID: pr.IssueID,
  254. OfficialOnly: setting.Repository.PullRequest.DefaultMergeMessageOfficialApproversOnly,
  255. })
  256. if err != nil {
  257. log.Error("Unable to FindReviews for PR ID %d: %v", pr.ID, err)
  258. return err
  259. }
  260. reviewersWritten := 0
  261. for _, review := range reviews {
  262. if maxReviewers > 0 && reviewersWritten > maxReviewers {
  263. break
  264. }
  265. if err := review.loadReviewer(sess); err != nil && !user_model.IsErrUserNotExist(err) {
  266. log.Error("Unable to LoadReviewer[%d] for PR ID %d : %v", review.ReviewerID, pr.ID, err)
  267. return err
  268. } else if review.Reviewer == nil {
  269. continue
  270. }
  271. if _, err := writer.Write([]byte("Reviewed-by: ")); err != nil {
  272. return err
  273. }
  274. if _, err := writer.Write([]byte(review.Reviewer.NewGitSig().String())); err != nil {
  275. return err
  276. }
  277. if _, err := writer.Write([]byte{'\n'}); err != nil {
  278. return err
  279. }
  280. reviewersWritten++
  281. }
  282. return committer.Commit()
  283. }
  284. // GetDefaultSquashMessage returns default message used when squash and merging pull request
  285. func (pr *PullRequest) GetDefaultSquashMessage() string {
  286. if err := pr.LoadIssue(); err != nil {
  287. log.Error("LoadIssue: %v", err)
  288. return ""
  289. }
  290. if err := pr.LoadBaseRepo(); err != nil {
  291. log.Error("LoadBaseRepo: %v", err)
  292. return ""
  293. }
  294. if pr.BaseRepo.UnitEnabled(unit.TypeExternalTracker) {
  295. return fmt.Sprintf("%s (!%d)", pr.Issue.Title, pr.Issue.Index)
  296. }
  297. return fmt.Sprintf("%s (#%d)", pr.Issue.Title, pr.Issue.Index)
  298. }
  299. // GetGitRefName returns git ref for hidden pull request branch
  300. func (pr *PullRequest) GetGitRefName() string {
  301. return fmt.Sprintf("%s%d/head", git.PullPrefix, pr.Index)
  302. }
  303. // IsChecking returns true if this pull request is still checking conflict.
  304. func (pr *PullRequest) IsChecking() bool {
  305. return pr.Status == PullRequestStatusChecking
  306. }
  307. // CanAutoMerge returns true if this pull request can be merged automatically.
  308. func (pr *PullRequest) CanAutoMerge() bool {
  309. return pr.Status == PullRequestStatusMergeable
  310. }
  311. // IsEmpty returns true if this pull request is empty.
  312. func (pr *PullRequest) IsEmpty() bool {
  313. return pr.Status == PullRequestStatusEmpty
  314. }
  315. // MergeStyle represents the approach to merge commits into base branch.
  316. type MergeStyle string
  317. const (
  318. // MergeStyleMerge create merge commit
  319. MergeStyleMerge MergeStyle = "merge"
  320. // MergeStyleRebase rebase before merging
  321. MergeStyleRebase MergeStyle = "rebase"
  322. // MergeStyleRebaseMerge rebase before merging with merge commit (--no-ff)
  323. MergeStyleRebaseMerge MergeStyle = "rebase-merge"
  324. // MergeStyleSquash squash commits into single commit before merging
  325. MergeStyleSquash MergeStyle = "squash"
  326. // MergeStyleManuallyMerged pr has been merged manually, just mark it as merged directly
  327. MergeStyleManuallyMerged MergeStyle = "manually-merged"
  328. // MergeStyleRebaseUpdate not a merge style, used to update pull head by rebase
  329. MergeStyleRebaseUpdate MergeStyle = "rebase-update-only"
  330. )
  331. // SetMerged sets a pull request to merged and closes the corresponding issue
  332. func (pr *PullRequest) SetMerged() (bool, error) {
  333. if pr.HasMerged {
  334. return false, fmt.Errorf("PullRequest[%d] already merged", pr.Index)
  335. }
  336. if pr.MergedCommitID == "" || pr.MergedUnix == 0 || pr.Merger == nil {
  337. return false, fmt.Errorf("Unable to merge PullRequest[%d], some required fields are empty", pr.Index)
  338. }
  339. pr.HasMerged = true
  340. ctx, committer, err := db.TxContext()
  341. if err != nil {
  342. return false, err
  343. }
  344. defer committer.Close()
  345. sess := db.GetEngine(ctx)
  346. if _, err := sess.Exec("UPDATE `issue` SET `repo_id` = `repo_id` WHERE `id` = ?", pr.IssueID); err != nil {
  347. return false, err
  348. }
  349. if _, err := sess.Exec("UPDATE `pull_request` SET `issue_id` = `issue_id` WHERE `id` = ?", pr.ID); err != nil {
  350. return false, err
  351. }
  352. pr.Issue = nil
  353. if err := pr.loadIssue(sess); err != nil {
  354. return false, err
  355. }
  356. if tmpPr, err := getPullRequestByID(sess, pr.ID); err != nil {
  357. return false, err
  358. } else if tmpPr.HasMerged {
  359. if pr.Issue.IsClosed {
  360. return false, nil
  361. }
  362. return false, fmt.Errorf("PullRequest[%d] already merged but it's associated issue [%d] is not closed", pr.Index, pr.IssueID)
  363. } else if pr.Issue.IsClosed {
  364. return false, fmt.Errorf("PullRequest[%d] already closed", pr.Index)
  365. }
  366. if err := pr.Issue.loadRepo(sess); err != nil {
  367. return false, err
  368. }
  369. if err := pr.Issue.Repo.getOwner(sess); err != nil {
  370. return false, err
  371. }
  372. if _, err := pr.Issue.changeStatus(ctx, pr.Merger, true, true); err != nil {
  373. return false, fmt.Errorf("Issue.changeStatus: %v", err)
  374. }
  375. // We need to save all of the data used to compute this merge as it may have already been changed by TestPatch. FIXME: need to set some state to prevent TestPatch from running whilst we are merging.
  376. if _, err := sess.Where("id = ?", pr.ID).Cols("has_merged, status, merge_base, merged_commit_id, merger_id, merged_unix").Update(pr); err != nil {
  377. return false, fmt.Errorf("Failed to update pr[%d]: %v", pr.ID, err)
  378. }
  379. if err := committer.Commit(); err != nil {
  380. return false, fmt.Errorf("Commit: %v", err)
  381. }
  382. return true, nil
  383. }
  384. // NewPullRequest creates new pull request with labels for repository.
  385. func NewPullRequest(repo *Repository, issue *Issue, labelIDs []int64, uuids []string, pr *PullRequest) (err error) {
  386. idx, err := db.GetNextResourceIndex("issue_index", repo.ID)
  387. if err != nil {
  388. return fmt.Errorf("generate pull request index failed: %v", err)
  389. }
  390. issue.Index = idx
  391. ctx, committer, err := db.TxContext()
  392. if err != nil {
  393. return err
  394. }
  395. defer committer.Close()
  396. if err = newIssue(ctx, issue.Poster, NewIssueOptions{
  397. Repo: repo,
  398. Issue: issue,
  399. LabelIDs: labelIDs,
  400. Attachments: uuids,
  401. IsPull: true,
  402. }); err != nil {
  403. if IsErrUserDoesNotHaveAccessToRepo(err) || IsErrNewIssueInsert(err) {
  404. return err
  405. }
  406. return fmt.Errorf("newIssue: %v", err)
  407. }
  408. pr.Index = issue.Index
  409. pr.BaseRepo = repo
  410. pr.IssueID = issue.ID
  411. if err = db.Insert(ctx, pr); err != nil {
  412. return fmt.Errorf("insert pull repo: %v", err)
  413. }
  414. if err = committer.Commit(); err != nil {
  415. return fmt.Errorf("Commit: %v", err)
  416. }
  417. return nil
  418. }
  419. // GetUnmergedPullRequest returns a pull request that is open and has not been merged
  420. // by given head/base and repo/branch.
  421. func GetUnmergedPullRequest(headRepoID, baseRepoID int64, headBranch, baseBranch string, flow PullRequestFlow) (*PullRequest, error) {
  422. pr := new(PullRequest)
  423. has, err := db.GetEngine(db.DefaultContext).
  424. Where("head_repo_id=? AND head_branch=? AND base_repo_id=? AND base_branch=? AND has_merged=? AND flow = ? AND issue.is_closed=?",
  425. headRepoID, headBranch, baseRepoID, baseBranch, false, flow, false).
  426. Join("INNER", "issue", "issue.id=pull_request.issue_id").
  427. Get(pr)
  428. if err != nil {
  429. return nil, err
  430. } else if !has {
  431. return nil, ErrPullRequestNotExist{0, 0, headRepoID, baseRepoID, headBranch, baseBranch}
  432. }
  433. return pr, nil
  434. }
  435. // GetLatestPullRequestByHeadInfo returns the latest pull request (regardless of its status)
  436. // by given head information (repo and branch).
  437. func GetLatestPullRequestByHeadInfo(repoID int64, branch string) (*PullRequest, error) {
  438. pr := new(PullRequest)
  439. has, err := db.GetEngine(db.DefaultContext).
  440. Where("head_repo_id = ? AND head_branch = ? AND flow = ?", repoID, branch, PullRequestFlowGithub).
  441. OrderBy("id DESC").
  442. Get(pr)
  443. if !has {
  444. return nil, err
  445. }
  446. return pr, err
  447. }
  448. // GetPullRequestByIndex returns a pull request by the given index
  449. func GetPullRequestByIndex(repoID, index int64) (*PullRequest, error) {
  450. if index < 1 {
  451. return nil, ErrPullRequestNotExist{}
  452. }
  453. pr := &PullRequest{
  454. BaseRepoID: repoID,
  455. Index: index,
  456. }
  457. has, err := db.GetEngine(db.DefaultContext).Get(pr)
  458. if err != nil {
  459. return nil, err
  460. } else if !has {
  461. return nil, ErrPullRequestNotExist{0, 0, 0, repoID, "", ""}
  462. }
  463. if err = pr.LoadAttributes(); err != nil {
  464. return nil, err
  465. }
  466. if err = pr.LoadIssue(); err != nil {
  467. return nil, err
  468. }
  469. return pr, nil
  470. }
  471. func getPullRequestByID(e db.Engine, id int64) (*PullRequest, error) {
  472. pr := new(PullRequest)
  473. has, err := e.ID(id).Get(pr)
  474. if err != nil {
  475. return nil, err
  476. } else if !has {
  477. return nil, ErrPullRequestNotExist{id, 0, 0, 0, "", ""}
  478. }
  479. return pr, pr.loadAttributes(e)
  480. }
  481. // GetPullRequestByID returns a pull request by given ID.
  482. func GetPullRequestByID(id int64) (*PullRequest, error) {
  483. return getPullRequestByID(db.GetEngine(db.DefaultContext), id)
  484. }
  485. // GetPullRequestByIssueIDWithNoAttributes returns pull request with no attributes loaded by given issue ID.
  486. func GetPullRequestByIssueIDWithNoAttributes(issueID int64) (*PullRequest, error) {
  487. var pr PullRequest
  488. has, err := db.GetEngine(db.DefaultContext).Where("issue_id = ?", issueID).Get(&pr)
  489. if err != nil {
  490. return nil, err
  491. }
  492. if !has {
  493. return nil, ErrPullRequestNotExist{0, issueID, 0, 0, "", ""}
  494. }
  495. return &pr, nil
  496. }
  497. func getPullRequestByIssueID(e db.Engine, issueID int64) (*PullRequest, error) {
  498. pr := &PullRequest{
  499. IssueID: issueID,
  500. }
  501. has, err := e.Get(pr)
  502. if err != nil {
  503. return nil, err
  504. } else if !has {
  505. return nil, ErrPullRequestNotExist{0, issueID, 0, 0, "", ""}
  506. }
  507. return pr, pr.loadAttributes(e)
  508. }
  509. // GetAllUnmergedAgitPullRequestByPoster get all unmerged agit flow pull request
  510. // By poster id.
  511. func GetAllUnmergedAgitPullRequestByPoster(uid int64) ([]*PullRequest, error) {
  512. pulls := make([]*PullRequest, 0, 10)
  513. err := db.GetEngine(db.DefaultContext).
  514. Where("has_merged=? AND flow = ? AND issue.is_closed=? AND issue.poster_id=?",
  515. false, PullRequestFlowAGit, false, uid).
  516. Join("INNER", "issue", "issue.id=pull_request.issue_id").
  517. Find(&pulls)
  518. return pulls, err
  519. }
  520. // GetPullRequestByIssueID returns pull request by given issue ID.
  521. func GetPullRequestByIssueID(issueID int64) (*PullRequest, error) {
  522. return getPullRequestByIssueID(db.GetEngine(db.DefaultContext), issueID)
  523. }
  524. // Update updates all fields of pull request.
  525. func (pr *PullRequest) Update() error {
  526. _, err := db.GetEngine(db.DefaultContext).ID(pr.ID).AllCols().Update(pr)
  527. return err
  528. }
  529. // UpdateCols updates specific fields of pull request.
  530. func (pr *PullRequest) UpdateCols(cols ...string) error {
  531. _, err := db.GetEngine(db.DefaultContext).ID(pr.ID).Cols(cols...).Update(pr)
  532. return err
  533. }
  534. // UpdateColsIfNotMerged updates specific fields of a pull request if it has not been merged
  535. func (pr *PullRequest) UpdateColsIfNotMerged(cols ...string) error {
  536. _, err := db.GetEngine(db.DefaultContext).Where("id = ? AND has_merged = ?", pr.ID, false).Cols(cols...).Update(pr)
  537. return err
  538. }
  539. // IsWorkInProgress determine if the Pull Request is a Work In Progress by its title
  540. func (pr *PullRequest) IsWorkInProgress() bool {
  541. if err := pr.LoadIssue(); err != nil {
  542. log.Error("LoadIssue: %v", err)
  543. return false
  544. }
  545. return HasWorkInProgressPrefix(pr.Issue.Title)
  546. }
  547. // HasWorkInProgressPrefix determines if the given PR title has a Work In Progress prefix
  548. func HasWorkInProgressPrefix(title string) bool {
  549. for _, prefix := range setting.Repository.PullRequest.WorkInProgressPrefixes {
  550. if strings.HasPrefix(strings.ToUpper(title), prefix) {
  551. return true
  552. }
  553. }
  554. return false
  555. }
  556. // IsFilesConflicted determines if the Pull Request has changes conflicting with the target branch.
  557. func (pr *PullRequest) IsFilesConflicted() bool {
  558. return len(pr.ConflictedFiles) > 0
  559. }
  560. // GetWorkInProgressPrefix returns the prefix used to mark the pull request as a work in progress.
  561. // It returns an empty string when none were found
  562. func (pr *PullRequest) GetWorkInProgressPrefix() string {
  563. if err := pr.LoadIssue(); err != nil {
  564. log.Error("LoadIssue: %v", err)
  565. return ""
  566. }
  567. for _, prefix := range setting.Repository.PullRequest.WorkInProgressPrefixes {
  568. if strings.HasPrefix(strings.ToUpper(pr.Issue.Title), prefix) {
  569. return pr.Issue.Title[0:len(prefix)]
  570. }
  571. }
  572. return ""
  573. }
  574. // UpdateCommitDivergence update Divergence of a pull request
  575. func (pr *PullRequest) UpdateCommitDivergence(ahead, behind int) error {
  576. return pr.updateCommitDivergence(db.GetEngine(db.DefaultContext), ahead, behind)
  577. }
  578. func (pr *PullRequest) updateCommitDivergence(e db.Engine, ahead, behind int) error {
  579. if pr.ID == 0 {
  580. return fmt.Errorf("pull ID is 0")
  581. }
  582. pr.CommitsAhead = ahead
  583. pr.CommitsBehind = behind
  584. _, err := e.ID(pr.ID).Cols("commits_ahead", "commits_behind").Update(pr)
  585. return err
  586. }
  587. // IsSameRepo returns true if base repo and head repo is the same
  588. func (pr *PullRequest) IsSameRepo() bool {
  589. return pr.BaseRepoID == pr.HeadRepoID
  590. }
  591. // GetBaseBranchHTMLURL returns the HTML URL of the base branch
  592. func (pr *PullRequest) GetBaseBranchHTMLURL() string {
  593. if err := pr.LoadBaseRepo(); err != nil {
  594. log.Error("LoadBaseRepo: %v", err)
  595. return ""
  596. }
  597. if pr.BaseRepo == nil {
  598. return ""
  599. }
  600. return pr.BaseRepo.HTMLURL() + "/src/branch/" + util.PathEscapeSegments(pr.BaseBranch)
  601. }
  602. // GetHeadBranchHTMLURL returns the HTML URL of the head branch
  603. func (pr *PullRequest) GetHeadBranchHTMLURL() string {
  604. if pr.Flow == PullRequestFlowAGit {
  605. return ""
  606. }
  607. if err := pr.LoadHeadRepo(); err != nil {
  608. log.Error("LoadHeadRepo: %v", err)
  609. return ""
  610. }
  611. if pr.HeadRepo == nil {
  612. return ""
  613. }
  614. return pr.HeadRepo.HTMLURL() + "/src/branch/" + util.PathEscapeSegments(pr.HeadBranch)
  615. }