123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874 |
- // Copyright 2015 The Gogs Authors. All rights reserved.
- // Copyright 2019 The Gitea Authors. All rights reserved.
- // SPDX-License-Identifier: MIT
-
- package issues
-
- import (
- "context"
- "fmt"
- "io"
- "strconv"
- "strings"
-
- "code.gitea.io/gitea/models/db"
- git_model "code.gitea.io/gitea/models/git"
- pull_model "code.gitea.io/gitea/models/pull"
- repo_model "code.gitea.io/gitea/models/repo"
- user_model "code.gitea.io/gitea/models/user"
- "code.gitea.io/gitea/modules/git"
- "code.gitea.io/gitea/modules/log"
- "code.gitea.io/gitea/modules/setting"
- "code.gitea.io/gitea/modules/timeutil"
- "code.gitea.io/gitea/modules/util"
-
- "xorm.io/builder"
- )
-
- // ErrPullRequestNotExist represents a "PullRequestNotExist" kind of error.
- type ErrPullRequestNotExist struct {
- ID int64
- IssueID int64
- HeadRepoID int64
- BaseRepoID int64
- HeadBranch string
- BaseBranch string
- }
-
- // IsErrPullRequestNotExist checks if an error is a ErrPullRequestNotExist.
- func IsErrPullRequestNotExist(err error) bool {
- _, ok := err.(ErrPullRequestNotExist)
- return ok
- }
-
- func (err ErrPullRequestNotExist) Error() string {
- return fmt.Sprintf("pull request does not exist [id: %d, issue_id: %d, head_repo_id: %d, base_repo_id: %d, head_branch: %s, base_branch: %s]",
- err.ID, err.IssueID, err.HeadRepoID, err.BaseRepoID, err.HeadBranch, err.BaseBranch)
- }
-
- func (err ErrPullRequestNotExist) Unwrap() error {
- return util.ErrNotExist
- }
-
- // ErrPullRequestAlreadyExists represents a "PullRequestAlreadyExists"-error
- type ErrPullRequestAlreadyExists struct {
- ID int64
- IssueID int64
- HeadRepoID int64
- BaseRepoID int64
- HeadBranch string
- BaseBranch string
- }
-
- // IsErrPullRequestAlreadyExists checks if an error is a ErrPullRequestAlreadyExists.
- func IsErrPullRequestAlreadyExists(err error) bool {
- _, ok := err.(ErrPullRequestAlreadyExists)
- return ok
- }
-
- // Error does pretty-printing :D
- func (err ErrPullRequestAlreadyExists) Error() string {
- return fmt.Sprintf("pull request already exists for these targets [id: %d, issue_id: %d, head_repo_id: %d, base_repo_id: %d, head_branch: %s, base_branch: %s]",
- err.ID, err.IssueID, err.HeadRepoID, err.BaseRepoID, err.HeadBranch, err.BaseBranch)
- }
-
- func (err ErrPullRequestAlreadyExists) Unwrap() error {
- return util.ErrAlreadyExist
- }
-
- // ErrPullRequestHeadRepoMissing represents a "ErrPullRequestHeadRepoMissing" error
- type ErrPullRequestHeadRepoMissing struct {
- ID int64
- HeadRepoID int64
- }
-
- // IsErrErrPullRequestHeadRepoMissing checks if an error is a ErrPullRequestHeadRepoMissing.
- func IsErrErrPullRequestHeadRepoMissing(err error) bool {
- _, ok := err.(ErrPullRequestHeadRepoMissing)
- return ok
- }
-
- // Error does pretty-printing :D
- func (err ErrPullRequestHeadRepoMissing) Error() string {
- return fmt.Sprintf("pull request head repo missing [id: %d, head_repo_id: %d]",
- err.ID, err.HeadRepoID)
- }
-
- // ErrPullWasClosed is used close a closed pull request
- type ErrPullWasClosed struct {
- ID int64
- Index int64
- }
-
- // IsErrPullWasClosed checks if an error is a ErrErrPullWasClosed.
- func IsErrPullWasClosed(err error) bool {
- _, ok := err.(ErrPullWasClosed)
- return ok
- }
-
- func (err ErrPullWasClosed) Error() string {
- return fmt.Sprintf("Pull request [%d] %d was already closed", err.ID, err.Index)
- }
-
- // PullRequestType defines pull request type
- type PullRequestType int
-
- // Enumerate all the pull request types
- const (
- PullRequestGitea PullRequestType = iota
- PullRequestGit
- )
-
- // PullRequestStatus defines pull request status
- type PullRequestStatus int
-
- // Enumerate all the pull request status
- const (
- PullRequestStatusConflict PullRequestStatus = iota
- PullRequestStatusChecking
- PullRequestStatusMergeable
- PullRequestStatusManuallyMerged
- PullRequestStatusError
- PullRequestStatusEmpty
- PullRequestStatusAncestor
- )
-
- func (status PullRequestStatus) String() string {
- switch status {
- case PullRequestStatusConflict:
- return "CONFLICT"
- case PullRequestStatusChecking:
- return "CHECKING"
- case PullRequestStatusMergeable:
- return "MERGEABLE"
- case PullRequestStatusManuallyMerged:
- return "MANUALLY_MERGED"
- case PullRequestStatusError:
- return "ERROR"
- case PullRequestStatusEmpty:
- return "EMPTY"
- case PullRequestStatusAncestor:
- return "ANCESTOR"
- default:
- return strconv.Itoa(int(status))
- }
- }
-
- // PullRequestFlow the flow of pull request
- type PullRequestFlow int
-
- const (
- // PullRequestFlowGithub github flow from head branch to base branch
- PullRequestFlowGithub PullRequestFlow = iota
- // PullRequestFlowAGit Agit flow pull request, head branch is not exist
- PullRequestFlowAGit
- )
-
- // PullRequest represents relation between pull request and repositories.
- type PullRequest struct {
- ID int64 `xorm:"pk autoincr"`
- Type PullRequestType
- Status PullRequestStatus
- ConflictedFiles []string `xorm:"TEXT JSON"`
- CommitsAhead int
- CommitsBehind int
-
- ChangedProtectedFiles []string `xorm:"TEXT JSON"`
-
- IssueID int64 `xorm:"INDEX"`
- Issue *Issue `xorm:"-"`
- Index int64
-
- HeadRepoID int64 `xorm:"INDEX"`
- HeadRepo *repo_model.Repository `xorm:"-"`
- BaseRepoID int64 `xorm:"INDEX"`
- BaseRepo *repo_model.Repository `xorm:"-"`
- HeadBranch string
- HeadCommitID string `xorm:"-"`
- BaseBranch string
- MergeBase string `xorm:"VARCHAR(40)"`
- AllowMaintainerEdit bool `xorm:"NOT NULL DEFAULT false"`
-
- HasMerged bool `xorm:"INDEX"`
- MergedCommitID string `xorm:"VARCHAR(40)"`
- MergerID int64 `xorm:"INDEX"`
- Merger *user_model.User `xorm:"-"`
- MergedUnix timeutil.TimeStamp `xorm:"updated INDEX"`
-
- isHeadRepoLoaded bool `xorm:"-"`
-
- Flow PullRequestFlow `xorm:"NOT NULL DEFAULT 0"`
- }
-
- func init() {
- db.RegisterModel(new(PullRequest))
- }
-
- // DeletePullsByBaseRepoID deletes all pull requests by the base repository ID
- func DeletePullsByBaseRepoID(ctx context.Context, repoID int64) error {
- deleteCond := builder.Select("id").From("pull_request").Where(builder.Eq{"pull_request.base_repo_id": repoID})
-
- // Delete scheduled auto merges
- if _, err := db.GetEngine(ctx).In("pull_id", deleteCond).
- Delete(&pull_model.AutoMerge{}); err != nil {
- return err
- }
-
- // Delete review states
- if _, err := db.GetEngine(ctx).In("pull_id", deleteCond).
- Delete(&pull_model.ReviewState{}); err != nil {
- return err
- }
-
- _, err := db.DeleteByBean(ctx, &PullRequest{BaseRepoID: repoID})
- return err
- }
-
- // ColorFormat writes a colored string to identify this struct
- func (pr *PullRequest) ColorFormat(s fmt.State) {
- if pr == nil {
- log.ColorFprintf(s, "PR[%d]%s#%d[%s...%s:%s]",
- log.NewColoredIDValue(0),
- log.NewColoredValue("<nil>/<nil>"),
- log.NewColoredIDValue(0),
- log.NewColoredValue("<nil>"),
- log.NewColoredValue("<nil>/<nil>"),
- log.NewColoredValue("<nil>"),
- )
- return
- }
-
- log.ColorFprintf(s, "PR[%d]", log.NewColoredIDValue(pr.ID))
- if pr.BaseRepo != nil {
- log.ColorFprintf(s, "%s#%d[%s...", log.NewColoredValue(pr.BaseRepo.FullName()),
- log.NewColoredIDValue(pr.Index), log.NewColoredValue(pr.BaseBranch))
- } else {
- log.ColorFprintf(s, "Repo[%d]#%d[%s...", log.NewColoredIDValue(pr.BaseRepoID),
- log.NewColoredIDValue(pr.Index), log.NewColoredValue(pr.BaseBranch))
- }
- if pr.HeadRepoID == pr.BaseRepoID {
- log.ColorFprintf(s, "%s]", log.NewColoredValue(pr.HeadBranch))
- } else if pr.HeadRepo != nil {
- log.ColorFprintf(s, "%s:%s]", log.NewColoredValue(pr.HeadRepo.FullName()), log.NewColoredValue(pr.HeadBranch))
- } else {
- log.ColorFprintf(s, "Repo[%d]:%s]", log.NewColoredIDValue(pr.HeadRepoID), log.NewColoredValue(pr.HeadBranch))
- }
- }
-
- // String represents the pr as a simple string
- func (pr *PullRequest) String() string {
- return log.ColorFormatAsString(pr)
- }
-
- // MustHeadUserName returns the HeadRepo's username if failed return blank
- func (pr *PullRequest) MustHeadUserName(ctx context.Context) string {
- if err := pr.LoadHeadRepo(ctx); err != nil {
- if !repo_model.IsErrRepoNotExist(err) {
- log.Error("LoadHeadRepo: %v", err)
- } else {
- log.Warn("LoadHeadRepo %d but repository does not exist: %v", pr.HeadRepoID, err)
- }
- return ""
- }
- if pr.HeadRepo == nil {
- return ""
- }
- return pr.HeadRepo.OwnerName
- }
-
- // LoadAttributes loads pull request attributes from database
- // Note: don't try to get Issue because will end up recursive querying.
- func (pr *PullRequest) LoadAttributes(ctx context.Context) (err error) {
- if pr.HasMerged && pr.Merger == nil {
- pr.Merger, err = user_model.GetUserByID(ctx, pr.MergerID)
- if user_model.IsErrUserNotExist(err) {
- pr.MergerID = -1
- pr.Merger = user_model.NewGhostUser()
- } else if err != nil {
- return fmt.Errorf("getUserByID [%d]: %w", pr.MergerID, err)
- }
- }
-
- return nil
- }
-
- // LoadHeadRepo loads the head repository, pr.HeadRepo will remain nil if it does not exist
- // and thus ErrRepoNotExist will never be returned
- func (pr *PullRequest) LoadHeadRepo(ctx context.Context) (err error) {
- if !pr.isHeadRepoLoaded && pr.HeadRepo == nil && pr.HeadRepoID > 0 {
- if pr.HeadRepoID == pr.BaseRepoID {
- if pr.BaseRepo != nil {
- pr.HeadRepo = pr.BaseRepo
- return nil
- } else if pr.Issue != nil && pr.Issue.Repo != nil {
- pr.HeadRepo = pr.Issue.Repo
- return nil
- }
- }
-
- pr.HeadRepo, err = repo_model.GetRepositoryByID(ctx, pr.HeadRepoID)
- if err != nil && !repo_model.IsErrRepoNotExist(err) { // Head repo maybe deleted, but it should still work
- return fmt.Errorf("pr[%d].LoadHeadRepo[%d]: %w", pr.ID, pr.HeadRepoID, err)
- }
- pr.isHeadRepoLoaded = true
- }
- return nil
- }
-
- // LoadBaseRepo loads the target repository. ErrRepoNotExist may be returned.
- func (pr *PullRequest) LoadBaseRepo(ctx context.Context) (err error) {
- if pr.BaseRepo != nil {
- return nil
- }
-
- if pr.HeadRepoID == pr.BaseRepoID && pr.HeadRepo != nil {
- pr.BaseRepo = pr.HeadRepo
- return nil
- }
-
- if pr.Issue != nil && pr.Issue.Repo != nil {
- pr.BaseRepo = pr.Issue.Repo
- return nil
- }
-
- pr.BaseRepo, err = repo_model.GetRepositoryByID(ctx, pr.BaseRepoID)
- if err != nil {
- return fmt.Errorf("pr[%d].LoadBaseRepo[%d]: %w", pr.ID, pr.BaseRepoID, err)
- }
- return nil
- }
-
- // LoadIssue loads issue information from database
- func (pr *PullRequest) LoadIssue(ctx context.Context) (err error) {
- if pr.Issue != nil {
- return nil
- }
-
- pr.Issue, err = GetIssueByID(ctx, pr.IssueID)
- if err == nil {
- pr.Issue.PullRequest = pr
- }
- return err
- }
-
- // ReviewCount represents a count of Reviews
- type ReviewCount struct {
- IssueID int64
- Type ReviewType
- Count int64
- }
-
- // GetApprovalCounts returns the approval counts by type
- // FIXME: Only returns official counts due to double counting of non-official counts
- func (pr *PullRequest) GetApprovalCounts(ctx context.Context) ([]*ReviewCount, error) {
- rCounts := make([]*ReviewCount, 0, 6)
- sess := db.GetEngine(ctx).Where("issue_id = ?", pr.IssueID)
- 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)
- }
-
- // GetApprovers returns the approvers of the pull request
- func (pr *PullRequest) GetApprovers() string {
- stringBuilder := strings.Builder{}
- if err := pr.getReviewedByLines(&stringBuilder); err != nil {
- log.Error("Unable to getReviewedByLines: Error: %v", err)
- return ""
- }
-
- return stringBuilder.String()
- }
-
- func (pr *PullRequest) getReviewedByLines(writer io.Writer) error {
- maxReviewers := setting.Repository.PullRequest.DefaultMergeMessageMaxApprovers
-
- if maxReviewers == 0 {
- return nil
- }
-
- ctx, committer, err := db.TxContext(db.DefaultContext)
- if err != nil {
- return err
- }
- defer committer.Close()
-
- // Note: This doesn't page as we only expect a very limited number of reviews
- reviews, err := FindReviews(ctx, FindReviewOptions{
- Type: ReviewTypeApprove,
- IssueID: pr.IssueID,
- OfficialOnly: setting.Repository.PullRequest.DefaultMergeMessageOfficialApproversOnly,
- })
- if err != nil {
- log.Error("Unable to FindReviews for PR ID %d: %v", pr.ID, err)
- return err
- }
-
- reviewersWritten := 0
-
- for _, review := range reviews {
- if maxReviewers > 0 && reviewersWritten > maxReviewers {
- break
- }
-
- if err := review.LoadReviewer(ctx); err != nil && !user_model.IsErrUserNotExist(err) {
- log.Error("Unable to LoadReviewer[%d] for PR ID %d : %v", review.ReviewerID, pr.ID, err)
- return err
- } else if review.Reviewer == nil {
- continue
- }
- if _, err := writer.Write([]byte("Reviewed-by: ")); err != nil {
- return err
- }
- if _, err := writer.Write([]byte(review.Reviewer.NewGitSig().String())); err != nil {
- return err
- }
- if _, err := writer.Write([]byte{'\n'}); err != nil {
- return err
- }
- reviewersWritten++
- }
- return committer.Commit()
- }
-
- // GetGitRefName returns git ref for hidden pull request branch
- func (pr *PullRequest) GetGitRefName() string {
- return fmt.Sprintf("%s%d/head", git.PullPrefix, pr.Index)
- }
-
- // IsChecking returns true if this pull request is still checking conflict.
- func (pr *PullRequest) IsChecking() bool {
- return pr.Status == PullRequestStatusChecking
- }
-
- // CanAutoMerge returns true if this pull request can be merged automatically.
- func (pr *PullRequest) CanAutoMerge() bool {
- return pr.Status == PullRequestStatusMergeable
- }
-
- // IsEmpty returns true if this pull request is empty.
- func (pr *PullRequest) IsEmpty() bool {
- return pr.Status == PullRequestStatusEmpty
- }
-
- // IsAncestor returns true if the Head Commit of this PR is an ancestor of the Base Commit
- func (pr *PullRequest) IsAncestor() bool {
- return pr.Status == PullRequestStatusAncestor
- }
-
- // IsFromFork return true if this PR is from a fork.
- func (pr *PullRequest) IsFromFork() bool {
- return pr.HeadRepoID != pr.BaseRepoID
- }
-
- // SetMerged sets a pull request to merged and closes the corresponding issue
- func (pr *PullRequest) SetMerged(ctx context.Context) (bool, error) {
- if pr.HasMerged {
- return false, fmt.Errorf("PullRequest[%d] already merged", pr.Index)
- }
- if pr.MergedCommitID == "" || pr.MergedUnix == 0 || pr.Merger == nil {
- return false, fmt.Errorf("Unable to merge PullRequest[%d], some required fields are empty", pr.Index)
- }
-
- pr.HasMerged = true
- sess := db.GetEngine(ctx)
-
- if _, err := sess.Exec("UPDATE `issue` SET `repo_id` = `repo_id` WHERE `id` = ?", pr.IssueID); err != nil {
- return false, err
- }
-
- if _, err := sess.Exec("UPDATE `pull_request` SET `issue_id` = `issue_id` WHERE `id` = ?", pr.ID); err != nil {
- return false, err
- }
-
- pr.Issue = nil
- if err := pr.LoadIssue(ctx); err != nil {
- return false, err
- }
-
- if tmpPr, err := GetPullRequestByID(ctx, pr.ID); err != nil {
- return false, err
- } else if tmpPr.HasMerged {
- if pr.Issue.IsClosed {
- return false, nil
- }
- return false, fmt.Errorf("PullRequest[%d] already merged but it's associated issue [%d] is not closed", pr.Index, pr.IssueID)
- } else if pr.Issue.IsClosed {
- return false, fmt.Errorf("PullRequest[%d] already closed", pr.Index)
- }
-
- if err := pr.Issue.LoadRepo(ctx); err != nil {
- return false, err
- }
-
- if err := pr.Issue.Repo.LoadOwner(ctx); err != nil {
- return false, err
- }
-
- if _, err := changeIssueStatus(ctx, pr.Issue, pr.Merger, true, true); err != nil {
- return false, fmt.Errorf("Issue.changeStatus: %w", err)
- }
-
- // reset the conflicted files as there cannot be any if we're merged
- pr.ConflictedFiles = []string{}
-
- // 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.
- 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 {
- return false, fmt.Errorf("Failed to update pr[%d]: %w", pr.ID, err)
- }
-
- return true, nil
- }
-
- // NewPullRequest creates new pull request with labels for repository.
- func NewPullRequest(outerCtx context.Context, repo *repo_model.Repository, issue *Issue, labelIDs []int64, uuids []string, pr *PullRequest) (err error) {
- ctx, committer, err := db.TxContext(outerCtx)
- if err != nil {
- return err
- }
- defer committer.Close()
- ctx.WithContext(outerCtx)
-
- idx, err := db.GetNextResourceIndex(ctx, "issue_index", repo.ID)
- if err != nil {
- return fmt.Errorf("generate pull request index failed: %w", err)
- }
-
- issue.Index = idx
-
- if err = NewIssueWithIndex(ctx, issue.Poster, NewIssueOptions{
- Repo: repo,
- Issue: issue,
- LabelIDs: labelIDs,
- Attachments: uuids,
- IsPull: true,
- }); err != nil {
- if repo_model.IsErrUserDoesNotHaveAccessToRepo(err) || IsErrNewIssueInsert(err) {
- return err
- }
- return fmt.Errorf("newIssue: %w", err)
- }
-
- pr.Index = issue.Index
- pr.BaseRepo = repo
- pr.IssueID = issue.ID
- if err = db.Insert(ctx, pr); err != nil {
- return fmt.Errorf("insert pull repo: %w", err)
- }
-
- if err = committer.Commit(); err != nil {
- return fmt.Errorf("Commit: %w", err)
- }
-
- return nil
- }
-
- // GetUnmergedPullRequest returns a pull request that is open and has not been merged
- // by given head/base and repo/branch.
- func GetUnmergedPullRequest(ctx context.Context, headRepoID, baseRepoID int64, headBranch, baseBranch string, flow PullRequestFlow) (*PullRequest, error) {
- pr := new(PullRequest)
- has, err := db.GetEngine(ctx).
- Where("head_repo_id=? AND head_branch=? AND base_repo_id=? AND base_branch=? AND has_merged=? AND flow = ? AND issue.is_closed=?",
- headRepoID, headBranch, baseRepoID, baseBranch, false, flow, false).
- Join("INNER", "issue", "issue.id=pull_request.issue_id").
- Get(pr)
- if err != nil {
- return nil, err
- } else if !has {
- return nil, ErrPullRequestNotExist{0, 0, headRepoID, baseRepoID, headBranch, baseBranch}
- }
-
- return pr, nil
- }
-
- // GetLatestPullRequestByHeadInfo returns the latest pull request (regardless of its status)
- // by given head information (repo and branch).
- func GetLatestPullRequestByHeadInfo(repoID int64, branch string) (*PullRequest, error) {
- pr := new(PullRequest)
- has, err := db.GetEngine(db.DefaultContext).
- Where("head_repo_id = ? AND head_branch = ? AND flow = ?", repoID, branch, PullRequestFlowGithub).
- OrderBy("id DESC").
- Get(pr)
- if !has {
- return nil, err
- }
- return pr, err
- }
-
- // GetPullRequestByIndex returns a pull request by the given index
- func GetPullRequestByIndex(ctx context.Context, repoID, index int64) (*PullRequest, error) {
- if index < 1 {
- return nil, ErrPullRequestNotExist{}
- }
- pr := &PullRequest{
- BaseRepoID: repoID,
- Index: index,
- }
-
- has, err := db.GetEngine(ctx).Get(pr)
- if err != nil {
- return nil, err
- } else if !has {
- return nil, ErrPullRequestNotExist{0, 0, 0, repoID, "", ""}
- }
-
- if err = pr.LoadAttributes(ctx); err != nil {
- return nil, err
- }
- if err = pr.LoadIssue(ctx); err != nil {
- return nil, err
- }
-
- return pr, nil
- }
-
- // GetPullRequestByID returns a pull request by given ID.
- func GetPullRequestByID(ctx context.Context, id int64) (*PullRequest, error) {
- pr := new(PullRequest)
- has, err := db.GetEngine(ctx).ID(id).Get(pr)
- if err != nil {
- return nil, err
- } else if !has {
- return nil, ErrPullRequestNotExist{id, 0, 0, 0, "", ""}
- }
- return pr, pr.LoadAttributes(ctx)
- }
-
- // GetPullRequestByIssueIDWithNoAttributes returns pull request with no attributes loaded by given issue ID.
- func GetPullRequestByIssueIDWithNoAttributes(issueID int64) (*PullRequest, error) {
- var pr PullRequest
- has, err := db.GetEngine(db.DefaultContext).Where("issue_id = ?", issueID).Get(&pr)
- if err != nil {
- return nil, err
- }
- if !has {
- return nil, ErrPullRequestNotExist{0, issueID, 0, 0, "", ""}
- }
- return &pr, nil
- }
-
- // GetPullRequestByIssueID returns pull request by given issue ID.
- func GetPullRequestByIssueID(ctx context.Context, issueID int64) (*PullRequest, error) {
- pr := &PullRequest{
- IssueID: issueID,
- }
- has, err := db.GetByBean(ctx, pr)
- if err != nil {
- return nil, err
- } else if !has {
- return nil, ErrPullRequestNotExist{0, issueID, 0, 0, "", ""}
- }
- return pr, pr.LoadAttributes(ctx)
- }
-
- // GetAllUnmergedAgitPullRequestByPoster get all unmerged agit flow pull request
- // By poster id.
- func GetAllUnmergedAgitPullRequestByPoster(uid int64) ([]*PullRequest, error) {
- pulls := make([]*PullRequest, 0, 10)
-
- err := db.GetEngine(db.DefaultContext).
- Where("has_merged=? AND flow = ? AND issue.is_closed=? AND issue.poster_id=?",
- false, PullRequestFlowAGit, false, uid).
- Join("INNER", "issue", "issue.id=pull_request.issue_id").
- Find(&pulls)
-
- return pulls, err
- }
-
- // Update updates all fields of pull request.
- func (pr *PullRequest) Update() error {
- _, err := db.GetEngine(db.DefaultContext).ID(pr.ID).AllCols().Update(pr)
- return err
- }
-
- // UpdateCols updates specific fields of pull request.
- func (pr *PullRequest) UpdateCols(cols ...string) error {
- _, err := db.GetEngine(db.DefaultContext).ID(pr.ID).Cols(cols...).Update(pr)
- return err
- }
-
- // UpdateColsIfNotMerged updates specific fields of a pull request if it has not been merged
- func (pr *PullRequest) UpdateColsIfNotMerged(ctx context.Context, cols ...string) error {
- _, err := db.GetEngine(ctx).Where("id = ? AND has_merged = ?", pr.ID, false).Cols(cols...).Update(pr)
- return err
- }
-
- // IsWorkInProgress determine if the Pull Request is a Work In Progress by its title
- // Issue must be set before this method can be called.
- func (pr *PullRequest) IsWorkInProgress() bool {
- if err := pr.LoadIssue(db.DefaultContext); err != nil {
- log.Error("LoadIssue: %v", err)
- return false
- }
- return HasWorkInProgressPrefix(pr.Issue.Title)
- }
-
- // HasWorkInProgressPrefix determines if the given PR title has a Work In Progress prefix
- func HasWorkInProgressPrefix(title string) bool {
- for _, prefix := range setting.Repository.PullRequest.WorkInProgressPrefixes {
- if strings.HasPrefix(strings.ToUpper(title), strings.ToUpper(prefix)) {
- return true
- }
- }
- return false
- }
-
- // IsFilesConflicted determines if the Pull Request has changes conflicting with the target branch.
- func (pr *PullRequest) IsFilesConflicted() bool {
- return len(pr.ConflictedFiles) > 0
- }
-
- // GetWorkInProgressPrefix returns the prefix used to mark the pull request as a work in progress.
- // It returns an empty string when none were found
- func (pr *PullRequest) GetWorkInProgressPrefix(ctx context.Context) string {
- if err := pr.LoadIssue(ctx); err != nil {
- log.Error("LoadIssue: %v", err)
- return ""
- }
-
- for _, prefix := range setting.Repository.PullRequest.WorkInProgressPrefixes {
- if strings.HasPrefix(strings.ToUpper(pr.Issue.Title), strings.ToUpper(prefix)) {
- return pr.Issue.Title[0:len(prefix)]
- }
- }
- return ""
- }
-
- // UpdateCommitDivergence update Divergence of a pull request
- func (pr *PullRequest) UpdateCommitDivergence(ctx context.Context, ahead, behind int) error {
- if pr.ID == 0 {
- return fmt.Errorf("pull ID is 0")
- }
- pr.CommitsAhead = ahead
- pr.CommitsBehind = behind
- _, err := db.GetEngine(ctx).ID(pr.ID).Cols("commits_ahead", "commits_behind").Update(pr)
- return err
- }
-
- // IsSameRepo returns true if base repo and head repo is the same
- func (pr *PullRequest) IsSameRepo() bool {
- return pr.BaseRepoID == pr.HeadRepoID
- }
-
- // GetPullRequestsByHeadBranch returns all prs by head branch
- // Since there could be multiple prs with the same head branch, this function returns a slice of prs
- func GetPullRequestsByHeadBranch(ctx context.Context, headBranch string, headRepoID int64) ([]*PullRequest, error) {
- log.Trace("GetPullRequestsByHeadBranch: headBranch: '%s', headRepoID: '%d'", headBranch, headRepoID)
- prs := make([]*PullRequest, 0, 2)
- if err := db.GetEngine(ctx).Where(builder.Eq{"head_branch": headBranch, "head_repo_id": headRepoID}).
- Find(&prs); err != nil {
- return nil, err
- }
- return prs, nil
- }
-
- // GetBaseBranchLink returns the relative URL of the base branch
- func (pr *PullRequest) GetBaseBranchLink() string {
- if err := pr.LoadBaseRepo(db.DefaultContext); err != nil {
- log.Error("LoadBaseRepo: %v", err)
- return ""
- }
- if pr.BaseRepo == nil {
- return ""
- }
- return pr.BaseRepo.Link() + "/src/branch/" + util.PathEscapeSegments(pr.BaseBranch)
- }
-
- // GetHeadBranchLink returns the relative URL of the head branch
- func (pr *PullRequest) GetHeadBranchLink() string {
- if pr.Flow == PullRequestFlowAGit {
- return ""
- }
-
- if err := pr.LoadHeadRepo(db.DefaultContext); err != nil {
- log.Error("LoadHeadRepo: %v", err)
- return ""
- }
- if pr.HeadRepo == nil {
- return ""
- }
- return pr.HeadRepo.Link() + "/src/branch/" + util.PathEscapeSegments(pr.HeadBranch)
- }
-
- // UpdateAllowEdits update if PR can be edited from maintainers
- func UpdateAllowEdits(ctx context.Context, pr *PullRequest) error {
- if _, err := db.GetEngine(ctx).ID(pr.ID).Cols("allow_maintainer_edit").Update(pr); err != nil {
- return err
- }
- return nil
- }
-
- // Mergeable returns if the pullrequest is mergeable.
- func (pr *PullRequest) Mergeable() bool {
- // If a pull request isn't mergable if it's:
- // - Being conflict checked.
- // - Has a conflict.
- // - Received a error while being conflict checked.
- // - Is a work-in-progress pull request.
- return pr.Status != PullRequestStatusChecking && pr.Status != PullRequestStatusConflict &&
- pr.Status != PullRequestStatusError && !pr.IsWorkInProgress()
- }
-
- // HasEnoughApprovals returns true if pr has enough granted approvals.
- func HasEnoughApprovals(ctx context.Context, protectBranch *git_model.ProtectedBranch, pr *PullRequest) bool {
- if protectBranch.RequiredApprovals == 0 {
- return true
- }
- return GetGrantedApprovalsCount(ctx, protectBranch, pr) >= protectBranch.RequiredApprovals
- }
-
- // GetGrantedApprovalsCount returns the number of granted approvals for pr. A granted approval must be authored by a user in an approval whitelist.
- func GetGrantedApprovalsCount(ctx context.Context, protectBranch *git_model.ProtectedBranch, pr *PullRequest) int64 {
- sess := db.GetEngine(ctx).Where("issue_id = ?", pr.IssueID).
- And("type = ?", ReviewTypeApprove).
- And("official = ?", true).
- And("dismissed = ?", false)
- if protectBranch.DismissStaleApprovals {
- sess = sess.And("stale = ?", false)
- }
- approvals, err := sess.Count(new(Review))
- if err != nil {
- log.Error("GetGrantedApprovalsCount: %v", err)
- return 0
- }
-
- return approvals
- }
-
- // MergeBlockedByRejectedReview returns true if merge is blocked by rejected reviews
- func MergeBlockedByRejectedReview(ctx context.Context, protectBranch *git_model.ProtectedBranch, pr *PullRequest) bool {
- if !protectBranch.BlockOnRejectedReviews {
- return false
- }
- rejectExist, err := db.GetEngine(ctx).Where("issue_id = ?", pr.IssueID).
- And("type = ?", ReviewTypeReject).
- And("official = ?", true).
- And("dismissed = ?", false).
- Exist(new(Review))
- if err != nil {
- log.Error("MergeBlockedByRejectedReview: %v", err)
- return true
- }
-
- return rejectExist
- }
-
- // MergeBlockedByOfficialReviewRequests block merge because of some review request to official reviewer
- // of from official review
- func MergeBlockedByOfficialReviewRequests(ctx context.Context, protectBranch *git_model.ProtectedBranch, pr *PullRequest) bool {
- if !protectBranch.BlockOnOfficialReviewRequests {
- return false
- }
- has, err := db.GetEngine(ctx).Where("issue_id = ?", pr.IssueID).
- And("type = ?", ReviewTypeRequest).
- And("official = ?", true).
- Exist(new(Review))
- if err != nil {
- log.Error("MergeBlockedByOfficialReviewRequests: %v", err)
- return true
- }
-
- return has
- }
-
- // MergeBlockedByOutdatedBranch returns true if merge is blocked by an outdated head branch
- func MergeBlockedByOutdatedBranch(protectBranch *git_model.ProtectedBranch, pr *PullRequest) bool {
- return protectBranch.BlockOnOutdatedBranch && pr.CommitsBehind > 0
- }
|