2016-12-02 14:10:39 +03:00
// Copyright 2016 The Gitea Authors. All rights reserved.
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.
package repo
import (
"fmt"
2018-07-18 00:23:58 +03:00
"net/http"
2016-12-02 14:10:39 +03:00
"strings"
2019-11-03 17:46:32 +03:00
"time"
2016-12-02 14:10:39 +03:00
"code.gitea.io/gitea/models"
2018-01-05 21:56:50 +03:00
"code.gitea.io/gitea/modules/auth"
2016-12-02 14:10:39 +03:00
"code.gitea.io/gitea/modules/context"
2020-01-10 10:53:53 +03:00
"code.gitea.io/gitea/modules/convert"
2019-03-27 12:33:00 +03:00
"code.gitea.io/gitea/modules/git"
2016-12-02 14:10:39 +03:00
"code.gitea.io/gitea/modules/log"
2018-10-18 14:23:05 +03:00
"code.gitea.io/gitea/modules/notification"
2019-05-11 13:21:34 +03:00
api "code.gitea.io/gitea/modules/structs"
2019-08-15 17:46:21 +03:00
"code.gitea.io/gitea/modules/timeutil"
2019-10-25 17:46:37 +03:00
issue_service "code.gitea.io/gitea/services/issue"
2019-09-27 03:22:36 +03:00
pull_service "code.gitea.io/gitea/services/pull"
2016-12-02 14:10:39 +03:00
)
// ListPullRequests returns a list of all PRs
func ListPullRequests ( ctx * context . APIContext , form api . ListPullRequestsOptions ) {
2017-11-13 10:02:25 +03:00
// swagger:operation GET /repos/{owner}/{repo}/pulls repository repoListPullRequests
// ---
// summary: List a repo's pull requests
// produces:
// - application/json
// parameters:
// - name: owner
// in: path
// description: owner of the repo
// type: string
// required: true
// - name: repo
// in: path
// description: name of the repo
// type: string
// required: true
2018-10-21 06:40:42 +03:00
// - name: page
// in: query
// description: Page number
// type: integer
// - name: state
// in: query
// description: "State of pull request: open or closed (optional)"
// type: string
// enum: [closed, open, all]
// - name: sort
// in: query
// description: "Type of sort"
// type: string
// enum: [oldest, recentupdate, leastupdate, mostcomment, leastcomment, priority]
// - name: milestone
// in: query
// description: "ID of the milestone"
// type: integer
// format: int64
// - name: labels
// in: query
// description: "Label IDs"
// type: array
// collectionFormat: multi
// items:
// type: integer
// format: int64
2017-11-13 10:02:25 +03:00
// responses:
// "200":
// "$ref": "#/responses/PullRequestList"
2019-12-20 20:07:12 +03:00
2016-12-02 14:10:39 +03:00
prs , maxResults , err := models . PullRequests ( ctx . Repo . Repository . ID , & models . PullRequestsOptions {
Page : ctx . QueryInt ( "page" ) ,
State : ctx . QueryTrim ( "state" ) ,
SortType : ctx . QueryTrim ( "sort" ) ,
Labels : ctx . QueryStrings ( "labels" ) ,
MilestoneID : ctx . QueryInt64 ( "milestone" ) ,
} )
if err != nil {
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusInternalServerError , "PullRequests" , err )
2016-12-02 14:10:39 +03:00
return
}
apiPrs := make ( [ ] * api . PullRequest , len ( prs ) )
for i := range prs {
2017-11-04 21:10:01 +03:00
if err = prs [ i ] . LoadIssue ( ) ; err != nil {
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusInternalServerError , "LoadIssue" , err )
2017-11-04 21:10:01 +03:00
return
}
if err = prs [ i ] . LoadAttributes ( ) ; err != nil {
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusInternalServerError , "LoadAttributes" , err )
2017-11-04 21:10:01 +03:00
return
}
if err = prs [ i ] . GetBaseRepo ( ) ; err != nil {
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusInternalServerError , "GetBaseRepo" , err )
2017-11-04 21:10:01 +03:00
return
}
if err = prs [ i ] . GetHeadRepo ( ) ; err != nil {
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusInternalServerError , "GetHeadRepo" , err )
2017-11-04 21:10:01 +03:00
return
}
2020-01-10 10:53:53 +03:00
apiPrs [ i ] = convert . ToAPIPullRequest ( prs [ i ] )
2016-12-02 14:10:39 +03:00
}
ctx . SetLinkHeader ( int ( maxResults ) , models . ItemsPerPage )
2019-12-20 20:07:12 +03:00
ctx . JSON ( http . StatusOK , & apiPrs )
2016-12-02 14:10:39 +03:00
}
// GetPullRequest returns a single PR based on index
func GetPullRequest ( ctx * context . APIContext ) {
2017-11-13 10:02:25 +03:00
// swagger:operation GET /repos/{owner}/{repo}/pulls/{index} repository repoGetPullRequest
// ---
// summary: Get a pull request
// produces:
// - application/json
// parameters:
// - name: owner
// in: path
// description: owner of the repo
// type: string
// required: true
// - name: repo
// in: path
// description: name of the repo
// type: string
// required: true
// - name: index
// in: path
// description: index of the pull request to get
// type: integer
2018-10-21 06:40:42 +03:00
// format: int64
2017-11-13 10:02:25 +03:00
// required: true
// responses:
// "200":
// "$ref": "#/responses/PullRequest"
2020-01-09 14:56:32 +03:00
// "404":
// "$ref": "#/responses/notFound"
2019-12-20 20:07:12 +03:00
2016-12-02 14:10:39 +03:00
pr , err := models . GetPullRequestByIndex ( ctx . Repo . Repository . ID , ctx . ParamsInt64 ( ":index" ) )
if err != nil {
if models . IsErrPullRequestNotExist ( err ) {
2019-03-19 05:29:43 +03:00
ctx . NotFound ( )
2016-12-02 14:10:39 +03:00
} else {
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusInternalServerError , "GetPullRequestByIndex" , err )
2016-12-02 14:10:39 +03:00
}
return
}
2017-11-04 21:10:01 +03:00
if err = pr . GetBaseRepo ( ) ; err != nil {
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusInternalServerError , "GetBaseRepo" , err )
2017-11-04 21:10:01 +03:00
return
}
if err = pr . GetHeadRepo ( ) ; err != nil {
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusInternalServerError , "GetHeadRepo" , err )
2017-11-04 21:10:01 +03:00
return
}
2020-01-10 10:53:53 +03:00
ctx . JSON ( http . StatusOK , convert . ToAPIPullRequest ( pr ) )
2016-12-02 14:10:39 +03:00
}
// CreatePullRequest does what it says
func CreatePullRequest ( ctx * context . APIContext , form api . CreatePullRequestOption ) {
2017-11-13 10:02:25 +03:00
// swagger:operation POST /repos/{owner}/{repo}/pulls repository repoCreatePullRequest
// ---
// summary: Create a pull request
// consumes:
// - application/json
// produces:
// - application/json
// parameters:
// - name: owner
// in: path
// description: owner of the repo
// type: string
// required: true
// - name: repo
// in: path
// description: name of the repo
// type: string
// required: true
// - name: body
// in: body
// schema:
// "$ref": "#/definitions/CreatePullRequestOption"
// responses:
// "201":
// "$ref": "#/responses/PullRequest"
2019-12-20 20:07:12 +03:00
// "409":
// "$ref": "#/responses/error"
// "422":
// "$ref": "#/responses/validationError"
2016-12-02 14:10:39 +03:00
var (
repo = ctx . Repo . Repository
labelIDs [ ] int64
assigneeID int64
milestoneID int64
)
// Get repo/branch information
2019-10-18 14:13:31 +03:00
_ , headRepo , headGitRepo , compareInfo , baseBranch , headBranch := parseCompareInfo ( ctx , form )
2016-12-02 14:10:39 +03:00
if ctx . Written ( ) {
return
}
2019-11-13 10:01:19 +03:00
defer headGitRepo . Close ( )
2016-12-02 14:10:39 +03:00
// Check if another PR exists with the same targets
existingPr , err := models . GetUnmergedPullRequest ( headRepo . ID , ctx . Repo . Repository . ID , headBranch , baseBranch )
if err != nil {
if ! models . IsErrPullRequestNotExist ( err ) {
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusInternalServerError , "GetUnmergedPullRequest" , err )
2016-12-02 14:10:39 +03:00
return
}
} else {
err = models . ErrPullRequestAlreadyExists {
ID : existingPr . ID ,
IssueID : existingPr . Index ,
HeadRepoID : existingPr . HeadRepoID ,
BaseRepoID : existingPr . BaseRepoID ,
HeadBranch : existingPr . HeadBranch ,
BaseBranch : existingPr . BaseBranch ,
}
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusConflict , "GetUnmergedPullRequest" , err )
2016-12-02 14:10:39 +03:00
return
}
if len ( form . Labels ) > 0 {
labels , err := models . GetLabelsInRepoByIDs ( ctx . Repo . Repository . ID , form . Labels )
if err != nil {
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusInternalServerError , "GetLabelsInRepoByIDs" , err )
2016-12-02 14:10:39 +03:00
return
}
labelIDs = make ( [ ] int64 , len ( labels ) )
for i := range labels {
labelIDs [ i ] = labels [ i ] . ID
}
}
if form . Milestone > 0 {
milestone , err := models . GetMilestoneByRepoID ( ctx . Repo . Repository . ID , milestoneID )
if err != nil {
if models . IsErrMilestoneNotExist ( err ) {
2019-03-19 05:29:43 +03:00
ctx . NotFound ( )
2016-12-02 14:10:39 +03:00
} else {
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusInternalServerError , "GetMilestoneByRepoID" , err )
2016-12-02 14:10:39 +03:00
}
return
}
milestoneID = milestone . ID
}
2019-08-15 17:46:21 +03:00
var deadlineUnix timeutil . TimeStamp
2018-05-01 22:05:28 +03:00
if form . Deadline != nil {
2019-08-15 17:46:21 +03:00
deadlineUnix = timeutil . TimeStamp ( form . Deadline . Unix ( ) )
2018-05-01 22:05:28 +03:00
}
2016-12-02 14:10:39 +03:00
prIssue := & models . Issue {
2018-05-01 22:05:28 +03:00
RepoID : repo . ID ,
Title : form . Title ,
PosterID : ctx . User . ID ,
Poster : ctx . User ,
MilestoneID : milestoneID ,
AssigneeID : assigneeID ,
IsPull : true ,
Content : form . Body ,
DeadlineUnix : deadlineUnix ,
2016-12-02 14:10:39 +03:00
}
pr := & models . PullRequest {
2019-10-18 14:13:31 +03:00
HeadRepoID : headRepo . ID ,
BaseRepoID : repo . ID ,
HeadBranch : headBranch ,
BaseBranch : baseBranch ,
HeadRepo : headRepo ,
BaseRepo : repo ,
MergeBase : compareInfo . MergeBase ,
Type : models . PullRequestGitea ,
2016-12-02 14:10:39 +03:00
}
2018-05-09 19:29:04 +03:00
// Get all assignee IDs
assigneeIDs , err := models . MakeIDsFromAPIAssigneesToAdd ( form . Assignee , form . Assignees )
if err != nil {
if models . IsErrUserNotExist ( err ) {
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusUnprocessableEntity , "" , fmt . Sprintf ( "Assignee does not exist: [name: %s]" , err ) )
2018-05-09 19:29:04 +03:00
} else {
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusInternalServerError , "AddAssigneeByName" , err )
2018-05-09 19:29:04 +03:00
}
return
}
2019-10-25 17:46:37 +03:00
// Check if the passed assignees is assignable
for _ , aID := range assigneeIDs {
assignee , err := models . GetUserByID ( aID )
if err != nil {
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusInternalServerError , "GetUserByID" , err )
2019-10-25 17:46:37 +03:00
return
}
2018-05-09 19:29:04 +03:00
2019-10-25 17:46:37 +03:00
valid , err := models . CanBeAssigned ( assignee , repo , true )
if err != nil {
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusInternalServerError , "canBeAssigned" , err )
2019-10-25 17:46:37 +03:00
return
}
if ! valid {
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusUnprocessableEntity , "canBeAssigned" , models . ErrUserDoesNotHaveAccessToRepo { UserID : aID , RepoName : repo . Name } )
2019-10-25 17:46:37 +03:00
return
}
}
2019-12-14 01:21:06 +03:00
if err := pull_service . NewPullRequest ( repo , prIssue , labelIDs , [ ] string { } , pr , assigneeIDs ) ; err != nil {
2018-05-09 19:29:04 +03:00
if models . IsErrUserDoesNotHaveAccessToRepo ( err ) {
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusBadRequest , "UserDoesNotHaveAccessToRepo" , err )
2018-05-09 19:29:04 +03:00
return
}
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusInternalServerError , "NewPullRequest" , err )
2016-12-02 14:10:39 +03:00
return
}
2018-10-18 14:23:05 +03:00
notification . NotifyNewPullRequest ( pr )
2016-12-02 14:10:39 +03:00
log . Trace ( "Pull request created: %d/%d" , repo . ID , prIssue . ID )
2020-01-10 10:53:53 +03:00
ctx . JSON ( http . StatusCreated , convert . ToAPIPullRequest ( pr ) )
2016-12-02 14:10:39 +03:00
}
// EditPullRequest does what it says
func EditPullRequest ( ctx * context . APIContext , form api . EditPullRequestOption ) {
2017-11-13 10:02:25 +03:00
// swagger:operation PATCH /repos/{owner}/{repo}/pulls/{index} repository repoEditPullRequest
// ---
2019-11-03 17:46:32 +03:00
// summary: Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.
2017-11-13 10:02:25 +03:00
// consumes:
// - application/json
// produces:
// - application/json
// parameters:
// - name: owner
// in: path
// description: owner of the repo
// type: string
// required: true
// - name: repo
// in: path
// description: name of the repo
// type: string
// required: true
// - name: index
// in: path
// description: index of the pull request to edit
// type: integer
2018-10-21 06:40:42 +03:00
// format: int64
2017-11-13 10:02:25 +03:00
// required: true
// - name: body
// in: body
// schema:
// "$ref": "#/definitions/EditPullRequestOption"
// responses:
// "201":
// "$ref": "#/responses/PullRequest"
2019-12-20 20:07:12 +03:00
// "403":
// "$ref": "#/responses/forbidden"
// "412":
// "$ref": "#/responses/error"
// "422":
// "$ref": "#/responses/validationError"
2016-12-02 14:10:39 +03:00
pr , err := models . GetPullRequestByIndex ( ctx . Repo . Repository . ID , ctx . ParamsInt64 ( ":index" ) )
if err != nil {
if models . IsErrPullRequestNotExist ( err ) {
2019-03-19 05:29:43 +03:00
ctx . NotFound ( )
2016-12-02 14:10:39 +03:00
} else {
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusInternalServerError , "GetPullRequestByIndex" , err )
2016-12-02 14:10:39 +03:00
}
return
}
2019-06-12 22:41:28 +03:00
err = pr . LoadIssue ( )
if err != nil {
ctx . Error ( http . StatusInternalServerError , "LoadIssue" , err )
return
}
2016-12-02 14:10:39 +03:00
issue := pr . Issue
2018-12-13 18:55:43 +03:00
issue . Repo = ctx . Repo . Repository
2016-12-02 14:10:39 +03:00
2018-11-28 14:26:14 +03:00
if ! issue . IsPoster ( ctx . User . ID ) && ! ctx . Repo . CanWrite ( models . UnitTypePullRequests ) {
2019-12-20 20:07:12 +03:00
ctx . Status ( http . StatusForbidden )
2016-12-02 14:10:39 +03:00
return
}
if len ( form . Title ) > 0 {
issue . Title = form . Title
}
if len ( form . Body ) > 0 {
issue . Content = form . Body
}
2019-11-03 17:46:32 +03:00
// Update or remove deadline if set
if form . Deadline != nil || form . RemoveDeadline != nil {
var deadlineUnix timeutil . TimeStamp
if ( form . RemoveDeadline == nil || ! * form . RemoveDeadline ) && ! form . Deadline . IsZero ( ) {
deadline := time . Date ( form . Deadline . Year ( ) , form . Deadline . Month ( ) , form . Deadline . Day ( ) ,
23 , 59 , 59 , 0 , form . Deadline . Location ( ) )
deadlineUnix = timeutil . TimeStamp ( deadline . Unix ( ) )
}
2019-10-28 02:35:20 +03:00
if err := models . UpdateIssueDeadline ( issue , deadlineUnix , ctx . User ) ; err != nil {
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusInternalServerError , "UpdateIssueDeadline" , err )
2019-10-28 02:35:20 +03:00
return
}
issue . DeadlineUnix = deadlineUnix
2018-05-01 22:05:28 +03:00
}
2018-05-09 19:29:04 +03:00
// Add/delete assignees
2016-12-02 14:10:39 +03:00
2019-03-10 00:15:45 +03:00
// Deleting is done the GitHub way (quote from their api documentation):
2018-05-09 19:29:04 +03:00
// https://developer.github.com/v3/issues/#edit-an-issue
// "assignees" (array): Logins for Users to assign to this issue.
// Pass one or more user logins to replace the set of assignees on this Issue.
// Send an empty array ([]) to clear all assignees from the Issue.
2018-11-28 14:26:14 +03:00
if ctx . Repo . CanWrite ( models . UnitTypePullRequests ) && ( form . Assignees != nil || len ( form . Assignee ) > 0 ) {
2019-10-25 17:46:37 +03:00
err = issue_service . UpdateAssignees ( issue , form . Assignee , form . Assignees , ctx . User )
2018-05-09 19:29:04 +03:00
if err != nil {
if models . IsErrUserNotExist ( err ) {
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusUnprocessableEntity , "" , fmt . Sprintf ( "Assignee does not exist: [name: %s]" , err ) )
2018-05-09 19:29:04 +03:00
} else {
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusInternalServerError , "UpdateAssignees" , err )
2018-05-09 19:29:04 +03:00
}
2016-12-02 14:10:39 +03:00
return
}
}
2018-05-09 19:29:04 +03:00
2018-11-28 14:26:14 +03:00
if ctx . Repo . CanWrite ( models . UnitTypePullRequests ) && form . Milestone != 0 &&
2016-12-02 14:10:39 +03:00
issue . MilestoneID != form . Milestone {
oldMilestoneID := issue . MilestoneID
issue . MilestoneID = form . Milestone
2019-11-02 06:33:20 +03:00
if err = issue_service . ChangeMilestoneAssign ( issue , ctx . User , oldMilestoneID ) ; err != nil {
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusInternalServerError , "ChangeMilestoneAssign" , err )
2016-12-02 14:10:39 +03:00
return
}
}
2018-12-01 09:05:57 +03:00
if ctx . Repo . CanWrite ( models . UnitTypePullRequests ) && form . Labels != nil {
2018-11-16 14:12:44 +03:00
labels , err := models . GetLabelsInRepoByIDs ( ctx . Repo . Repository . ID , form . Labels )
if err != nil {
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusInternalServerError , "GetLabelsInRepoByIDsError" , err )
2018-11-16 14:12:44 +03:00
return
}
if err = issue . ReplaceLabels ( labels , ctx . User ) ; err != nil {
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusInternalServerError , "ReplaceLabelsError" , err )
2018-11-16 14:12:44 +03:00
return
}
}
2020-01-02 01:51:10 +03:00
if err = models . UpdateIssueByAPI ( issue ) ; err != nil {
ctx . Error ( http . StatusInternalServerError , "UpdateIssueByAPI" , err )
2016-12-02 14:10:39 +03:00
return
}
if form . State != nil {
2019-10-28 08:26:46 +03:00
if err = issue_service . ChangeStatus ( issue , ctx . User , api . StateClosed == api . StateType ( * form . State ) ) ; err != nil {
2018-07-18 00:23:58 +03:00
if models . IsErrDependenciesLeft ( err ) {
ctx . Error ( http . StatusPreconditionFailed , "DependenciesLeft" , "cannot close this pull request because it still has open dependencies" )
return
}
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusInternalServerError , "ChangeStatus" , err )
2016-12-02 14:10:39 +03:00
return
}
}
// Refetch from database
pr , err = models . GetPullRequestByIndex ( ctx . Repo . Repository . ID , pr . Index )
if err != nil {
if models . IsErrPullRequestNotExist ( err ) {
2019-03-19 05:29:43 +03:00
ctx . NotFound ( )
2016-12-02 14:10:39 +03:00
} else {
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusInternalServerError , "GetPullRequestByIndex" , err )
2016-12-02 14:10:39 +03:00
}
return
}
2017-11-13 10:02:25 +03:00
// TODO this should be 200, not 201
2020-01-10 10:53:53 +03:00
ctx . JSON ( http . StatusCreated , convert . ToAPIPullRequest ( pr ) )
2016-12-02 14:10:39 +03:00
}
// IsPullRequestMerged checks if a PR exists given an index
func IsPullRequestMerged ( ctx * context . APIContext ) {
2017-11-13 10:02:25 +03:00
// swagger:operation GET /repos/{owner}/{repo}/pulls/{index}/merge repository repoPullRequestIsMerged
// ---
// summary: Check if a pull request has been merged
// produces:
// - application/json
// parameters:
// - name: owner
// in: path
// description: owner of the repo
// type: string
// required: true
// - name: repo
// in: path
// description: name of the repo
// type: string
// required: true
// - name: index
// in: path
// description: index of the pull request
// type: integer
2018-10-21 06:40:42 +03:00
// format: int64
2017-11-13 10:02:25 +03:00
// required: true
// responses:
// "204":
// description: pull request has been merged
// "404":
// description: pull request has not been merged
2019-12-20 20:07:12 +03:00
2016-12-02 14:10:39 +03:00
pr , err := models . GetPullRequestByIndex ( ctx . Repo . Repository . ID , ctx . ParamsInt64 ( ":index" ) )
if err != nil {
if models . IsErrPullRequestNotExist ( err ) {
2019-03-19 05:29:43 +03:00
ctx . NotFound ( )
2016-12-02 14:10:39 +03:00
} else {
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusInternalServerError , "GetPullRequestByIndex" , err )
2016-12-02 14:10:39 +03:00
}
return
}
if pr . HasMerged {
2019-12-20 20:07:12 +03:00
ctx . Status ( http . StatusNoContent )
2016-12-02 14:10:39 +03:00
}
2019-03-19 05:29:43 +03:00
ctx . NotFound ( )
2016-12-02 14:10:39 +03:00
}
// MergePullRequest merges a PR given an index
2018-01-05 21:56:50 +03:00
func MergePullRequest ( ctx * context . APIContext , form auth . MergePullRequestForm ) {
2017-11-13 10:02:25 +03:00
// swagger:operation POST /repos/{owner}/{repo}/pulls/{index}/merge repository repoMergePullRequest
// ---
// summary: Merge a pull request
// produces:
// - application/json
// parameters:
// - name: owner
// in: path
// description: owner of the repo
// type: string
// required: true
// - name: repo
// in: path
// description: name of the repo
// type: string
// required: true
// - name: index
// in: path
// description: index of the pull request to merge
// type: integer
2018-10-21 06:40:42 +03:00
// format: int64
2017-11-13 10:02:25 +03:00
// required: true
2019-02-08 11:08:38 +03:00
// - name: body
// in: body
// schema:
// $ref: "#/definitions/MergePullRequestOption"
2017-11-13 10:02:25 +03:00
// responses:
// "200":
// "$ref": "#/responses/empty"
// "405":
// "$ref": "#/responses/empty"
2019-12-20 20:07:12 +03:00
// "409":
// "$ref": "#/responses/error"
2016-12-02 14:10:39 +03:00
pr , err := models . GetPullRequestByIndex ( ctx . Repo . Repository . ID , ctx . ParamsInt64 ( ":index" ) )
if err != nil {
if models . IsErrPullRequestNotExist ( err ) {
2018-01-11 00:34:17 +03:00
ctx . NotFound ( "GetPullRequestByIndex" , err )
2016-12-02 14:10:39 +03:00
} else {
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusInternalServerError , "GetPullRequestByIndex" , err )
2016-12-02 14:10:39 +03:00
}
return
}
if err = pr . GetHeadRepo ( ) ; err != nil {
2018-01-11 00:34:17 +03:00
ctx . ServerError ( "GetHeadRepo" , err )
2016-12-02 14:10:39 +03:00
return
}
2019-06-12 22:41:28 +03:00
err = pr . LoadIssue ( )
if err != nil {
ctx . Error ( http . StatusInternalServerError , "LoadIssue" , err )
return
}
2016-12-02 14:10:39 +03:00
pr . Issue . Repo = ctx . Repo . Repository
if ctx . IsSigned {
// Update issue-user.
if err = pr . Issue . ReadBy ( ctx . User . ID ) ; err != nil {
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusInternalServerError , "ReadBy" , err )
2016-12-02 14:10:39 +03:00
return
}
}
if pr . Issue . IsClosed {
2019-03-19 05:29:43 +03:00
ctx . NotFound ( )
2016-12-02 14:10:39 +03:00
return
}
2020-01-16 17:18:30 +03:00
allowedMerge , err := pull_service . IsUserAllowedToMerge ( pr , ctx . Repo . Permission , ctx . User )
2019-09-18 08:39:45 +03:00
if err != nil {
2020-01-11 10:29:34 +03:00
ctx . Error ( http . StatusInternalServerError , "IsUSerAllowedToMerge" , err )
return
}
if ! allowedMerge {
ctx . Error ( http . StatusMethodNotAllowed , "Merge" , "User not allowed to merge PR" )
2019-09-18 08:39:45 +03:00
return
}
2020-01-11 10:29:34 +03:00
if ! pr . CanAutoMerge ( ) || pr . HasMerged || pr . IsWorkInProgress ( ) {
2019-12-20 20:07:12 +03:00
ctx . Status ( http . StatusMethodNotAllowed )
2019-09-18 08:39:45 +03:00
return
}
2020-01-11 10:29:34 +03:00
if err := pull_service . CheckPRReadyToMerge ( pr ) ; err != nil {
if ! models . IsErrNotAllowedToMerge ( err ) {
ctx . Error ( http . StatusInternalServerError , "CheckPRReadyToMerge" , err )
return
}
if form . ForceMerge != nil && * form . ForceMerge {
if isRepoAdmin , err := models . IsUserRepoAdmin ( pr . BaseRepo , ctx . User ) ; err != nil {
ctx . Error ( http . StatusInternalServerError , "IsUserRepoAdmin" , err )
return
} else if ! isRepoAdmin {
ctx . Error ( http . StatusMethodNotAllowed , "Merge" , "Only repository admin can merge if not all checks are ok (force merge)" )
}
} else {
ctx . Error ( http . StatusMethodNotAllowed , "PR is not ready to be merged" , err )
return
}
}
2020-01-15 11:32:57 +03:00
if _ , err := pull_service . IsSignedIfRequired ( pr , ctx . User ) ; err != nil {
if ! models . IsErrWontSign ( err ) {
ctx . Error ( http . StatusInternalServerError , "IsSignedIfRequired" , err )
return
}
ctx . Error ( http . StatusMethodNotAllowed , fmt . Sprintf ( "Protected branch %s requires signed commits but this merge would not be signed" , pr . BaseBranch ) , err )
return
}
2018-01-05 21:56:50 +03:00
if len ( form . Do ) == 0 {
form . Do = string ( models . MergeStyleMerge )
}
message := strings . TrimSpace ( form . MergeTitleField )
if len ( message ) == 0 {
if models . MergeStyle ( form . Do ) == models . MergeStyleMerge {
message = pr . GetDefaultMergeMessage ( )
}
if models . MergeStyle ( form . Do ) == models . MergeStyleSquash {
message = pr . GetDefaultSquashMessage ( )
}
}
form . MergeMessageField = strings . TrimSpace ( form . MergeMessageField )
if len ( form . MergeMessageField ) > 0 {
message += "\n\n" + form . MergeMessageField
}
2019-09-27 03:22:36 +03:00
if err := pull_service . Merge ( pr , ctx . User , ctx . Repo . GitRepo , models . MergeStyle ( form . Do ) , message ) ; err != nil {
2018-01-05 21:56:50 +03:00
if models . IsErrInvalidMergeStyle ( err ) {
2019-12-20 20:07:12 +03:00
ctx . Status ( http . StatusMethodNotAllowed )
2018-01-05 21:56:50 +03:00
return
2019-11-10 11:42:51 +03:00
} else if models . IsErrMergeConflicts ( err ) {
conflictError := err . ( models . ErrMergeConflicts )
ctx . JSON ( http . StatusConflict , conflictError )
} else if models . IsErrRebaseConflicts ( err ) {
conflictError := err . ( models . ErrRebaseConflicts )
ctx . JSON ( http . StatusConflict , conflictError )
} else if models . IsErrMergeUnrelatedHistories ( err ) {
conflictError := err . ( models . ErrMergeUnrelatedHistories )
ctx . JSON ( http . StatusConflict , conflictError )
} else if models . IsErrMergePushOutOfDate ( err ) {
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusConflict , "Merge" , "merge push out of date" )
2019-11-10 11:42:51 +03:00
return
2018-01-05 21:56:50 +03:00
}
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusInternalServerError , "Merge" , err )
2016-12-02 14:10:39 +03:00
return
}
log . Trace ( "Pull request merged: %d" , pr . ID )
2019-12-20 20:07:12 +03:00
ctx . Status ( http . StatusOK )
2016-12-02 14:10:39 +03:00
}
2019-06-07 23:29:29 +03:00
func parseCompareInfo ( ctx * context . APIContext , form api . CreatePullRequestOption ) ( * models . User , * models . Repository , * git . Repository , * git . CompareInfo , string , string ) {
2016-12-02 14:10:39 +03:00
baseRepo := ctx . Repo . Repository
// Get compared branches information
// format: <base branch>...[<head repo>:]<head branch>
// base<-head: master...head:feature
// same repo: master...feature
// TODO: Validate form first?
baseBranch := form . Base
var (
headUser * models . User
headBranch string
isSameRepo bool
err error
)
// If there is no head repository, it means pull request between same repository.
headInfos := strings . Split ( form . Head , ":" )
if len ( headInfos ) == 1 {
isSameRepo = true
headUser = ctx . Repo . Owner
headBranch = headInfos [ 0 ]
} else if len ( headInfos ) == 2 {
headUser , err = models . GetUserByName ( headInfos [ 0 ] )
if err != nil {
if models . IsErrUserNotExist ( err ) {
2019-05-07 20:20:23 +03:00
ctx . NotFound ( "GetUserByName" )
2016-12-02 14:10:39 +03:00
} else {
2018-01-11 00:34:17 +03:00
ctx . ServerError ( "GetUserByName" , err )
2016-12-02 14:10:39 +03:00
}
return nil , nil , nil , nil , "" , ""
}
headBranch = headInfos [ 1 ]
} else {
2019-03-19 05:29:43 +03:00
ctx . NotFound ( )
2016-12-02 14:10:39 +03:00
return nil , nil , nil , nil , "" , ""
}
ctx . Repo . PullRequest . SameRepo = isSameRepo
log . Info ( "Base branch: %s" , baseBranch )
log . Info ( "Repo path: %s" , ctx . Repo . GitRepo . Path )
// Check if base branch is valid.
if ! ctx . Repo . GitRepo . IsBranchExist ( baseBranch ) {
2019-05-07 20:20:23 +03:00
ctx . NotFound ( "IsBranchExist" )
2016-12-02 14:10:39 +03:00
return nil , nil , nil , nil , "" , ""
}
// Check if current user has fork of repository or in the same repository.
headRepo , has := models . HasForkedRepo ( headUser . ID , baseRepo . ID )
if ! has && ! isSameRepo {
log . Trace ( "parseCompareInfo[%d]: does not have fork or in same repository" , baseRepo . ID )
2019-05-07 20:20:23 +03:00
ctx . NotFound ( "HasForkedRepo" )
2016-12-02 14:10:39 +03:00
return nil , nil , nil , nil , "" , ""
}
var headGitRepo * git . Repository
if isSameRepo {
headRepo = ctx . Repo . Repository
headGitRepo = ctx . Repo . GitRepo
} else {
headGitRepo , err = git . OpenRepository ( models . RepoPath ( headUser . Name , headRepo . Name ) )
if err != nil {
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusInternalServerError , "OpenRepository" , err )
2016-12-02 14:10:39 +03:00
return nil , nil , nil , nil , "" , ""
}
}
2019-05-07 20:20:23 +03:00
// user should have permission to read baseRepo's codes and pulls, NOT headRepo's
permBase , err := models . GetUserRepoPermission ( baseRepo , ctx . User )
2018-11-28 14:26:14 +03:00
if err != nil {
2019-11-13 10:01:19 +03:00
headGitRepo . Close ( )
2018-11-28 14:26:14 +03:00
ctx . ServerError ( "GetUserRepoPermission" , err )
return nil , nil , nil , nil , "" , ""
}
2019-05-07 20:20:23 +03:00
if ! permBase . CanReadIssuesOrPulls ( true ) || ! permBase . CanRead ( models . UnitTypeCode ) {
2019-04-22 23:40:51 +03:00
if log . IsTrace ( ) {
2019-05-07 20:20:23 +03:00
log . Trace ( "Permission Denied: User %-v cannot create/read pull requests or cannot read code in Repo %-v\nUser in baseRepo has Permissions: %-+v" ,
ctx . User ,
baseRepo ,
permBase )
}
2019-11-13 10:01:19 +03:00
headGitRepo . Close ( )
2019-05-07 20:20:23 +03:00
ctx . NotFound ( "Can't read pulls or can't read UnitTypeCode" )
return nil , nil , nil , nil , "" , ""
}
// user should have permission to read headrepo's codes
permHead , err := models . GetUserRepoPermission ( headRepo , ctx . User )
if err != nil {
2019-11-13 10:01:19 +03:00
headGitRepo . Close ( )
2019-05-07 20:20:23 +03:00
ctx . ServerError ( "GetUserRepoPermission" , err )
return nil , nil , nil , nil , "" , ""
}
if ! permHead . CanRead ( models . UnitTypeCode ) {
if log . IsTrace ( ) {
log . Trace ( "Permission Denied: User: %-v cannot read code in Repo: %-v\nUser in headRepo has Permissions: %-+v" ,
2019-04-22 23:40:51 +03:00
ctx . User ,
headRepo ,
2019-05-07 20:20:23 +03:00
permHead )
2019-04-22 23:40:51 +03:00
}
2019-11-13 10:01:19 +03:00
headGitRepo . Close ( )
2019-05-07 20:20:23 +03:00
ctx . NotFound ( "Can't read headRepo UnitTypeCode" )
2016-12-02 14:10:39 +03:00
return nil , nil , nil , nil , "" , ""
}
// Check if head branch is valid.
if ! headGitRepo . IsBranchExist ( headBranch ) {
2019-11-13 10:01:19 +03:00
headGitRepo . Close ( )
2019-03-19 05:29:43 +03:00
ctx . NotFound ( )
2016-12-02 14:10:39 +03:00
return nil , nil , nil , nil , "" , ""
}
2019-06-07 23:29:29 +03:00
compareInfo , err := headGitRepo . GetCompareInfo ( models . RepoPath ( baseRepo . Owner . Name , baseRepo . Name ) , baseBranch , headBranch )
2016-12-02 14:10:39 +03:00
if err != nil {
2019-11-13 10:01:19 +03:00
headGitRepo . Close ( )
2019-12-20 20:07:12 +03:00
ctx . Error ( http . StatusInternalServerError , "GetCompareInfo" , err )
2016-12-02 14:10:39 +03:00
return nil , nil , nil , nil , "" , ""
}
2019-06-07 23:29:29 +03:00
return headUser , headRepo , headGitRepo , compareInfo , baseBranch , headBranch
2016-12-02 14:10:39 +03:00
}