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

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