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 22KB

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