gitbucket.core.controller.api.ApiPullRequestControllerBase.scala Maven / Gradle / Ivy
package gitbucket.core.controller.api
import gitbucket.core.api._
import gitbucket.core.controller.ControllerBase
import gitbucket.core.model.{Account, Issue, PullRequest, Repository}
import gitbucket.core.service._
import gitbucket.core.service.IssuesService.IssueSearchCondition
import gitbucket.core.service.PullRequestService.PullRequestLimit
import gitbucket.core.util.Directory.getRepositoryDir
import gitbucket.core.util.Implicits._
import gitbucket.core.util.JGitUtil.CommitInfo
import gitbucket.core.util._
import org.eclipse.jgit.api.Git
import org.scalatra.{Conflict, MethodNotAllowed, NoContent, Ok}
import scala.util.Using
import scala.jdk.CollectionConverters._
trait ApiPullRequestControllerBase extends ControllerBase {
self: AccountService
with IssuesService
with PullRequestService
with RepositoryService
with MergeService
with ReferrerAuthenticator
with ReadableUsersAuthenticator
with WritableUsersAuthenticator =>
/*
* i. Link Relations
* https://developer.github.com/v3/pulls/#link-relations
*/
/*
* ii. List pull requests
* https://developer.github.com/v3/pulls/#list-pull-requests
*/
get("/api/v3/repos/:owner/:repository/pulls")(referrersOnly { repository =>
val page = IssueSearchCondition.page(request)
// TODO: more api spec condition
val condition = IssueSearchCondition(request)
val baseOwner = getAccountByUserName(repository.owner).get
val issues: List[(Issue, Account, Int, PullRequest, Repository, Account, List[Account])] =
searchPullRequestByApi(
condition = condition,
offset = (page - 1) * PullRequestLimit,
limit = PullRequestLimit,
repos = repository.owner -> repository.name
)
JsonFormat(issues.map { case (issue, issueUser, commentCount, pullRequest, headRepo, headOwner, assignees) =>
ApiPullRequest(
issue = issue,
pullRequest = pullRequest,
headRepo = ApiRepository(headRepo, ApiUser(headOwner)),
baseRepo = ApiRepository(repository, ApiUser(baseOwner)),
user = ApiUser(issueUser),
labels = getIssueLabels(repository.owner, repository.name, issue.issueId)
.map(ApiLabel(_, RepositoryName(repository))),
assignees = assignees.map(ApiUser.apply),
mergedComment = getMergedComment(repository.owner, repository.name, issue.issueId)
)
})
})
/*
* iii. Get a single pull request
* https://developer.github.com/v3/pulls/#get-a-single-pull-request
*/
get("/api/v3/repos/:owner/:repository/pulls/:id")(referrersOnly { repository =>
(for {
issueId <- params("id").toIntOpt
} yield {
JsonFormat(getApiPullRequest(repository, issueId))
}) getOrElse NotFound()
})
/*
* iv. Create a pull request
* https://developer.github.com/v3/pulls/#create-a-pull-request
* requested #1843
*/
post("/api/v3/repos/:owner/:repository/pulls")(readableUsersOnly { repository =>
(for {
data <- extractFromJsonBody[Either[CreateAPullRequest, CreateAPullRequestAlt]]
} yield {
data match {
case Left(createPullReq) =>
val (reqOwner, reqBranch) = parseCompareIdentifier(createPullReq.head, repository.owner)
getRepository(reqOwner, repository.name)
.flatMap { forkedRepository =>
getPullRequestCommitFromTo(repository, forkedRepository, createPullReq.base, reqBranch) match {
case (Some(commitIdFrom), Some(commitIdTo)) =>
val issueId = insertIssue(
owner = repository.owner,
repository = repository.name,
loginUser = context.loginAccount.get.userName,
title = createPullReq.title,
content = createPullReq.body,
milestoneId = None,
priorityId = None,
isPullRequest = true
)
createPullRequest(
originRepository = repository,
issueId = issueId,
originBranch = createPullReq.base,
requestUserName = reqOwner,
requestRepositoryName = repository.name,
requestBranch = reqBranch,
commitIdFrom = commitIdFrom.getName,
commitIdTo = commitIdTo.getName,
isDraft = createPullReq.draft.getOrElse(false),
loginAccount = context.loginAccount.get,
settings = context.settings
)
getApiPullRequest(repository, issueId).map(JsonFormat(_))
case _ =>
None
}
}
.getOrElse {
NotFound()
}
case Right(createPullReqAlt) =>
val (reqOwner, reqBranch) = parseCompareIdentifier(createPullReqAlt.head, repository.owner)
getRepository(reqOwner, repository.name)
.flatMap { forkedRepository =>
getPullRequestCommitFromTo(repository, forkedRepository, createPullReqAlt.base, reqBranch) match {
case (Some(commitIdFrom), Some(commitIdTo)) =>
changeIssueToPullRequest(repository.owner, repository.name, createPullReqAlt.issue)
createPullRequest(
originRepository = repository,
issueId = createPullReqAlt.issue,
originBranch = createPullReqAlt.base,
requestUserName = reqOwner,
requestRepositoryName = repository.name,
requestBranch = reqBranch,
commitIdFrom = commitIdFrom.getName,
commitIdTo = commitIdTo.getName,
isDraft = false,
loginAccount = context.loginAccount.get,
settings = context.settings
)
getApiPullRequest(repository, createPullReqAlt.issue).map(JsonFormat(_))
case _ =>
None
}
}
.getOrElse {
NotFound()
}
}
})
})
/*
* v. Update a pull request
* https://docs.github.com/en/rest/reference/pulls#update-a-pull-request
*/
patch("/api/v3/repos/:owner/:repository/pulls/:id")(referrersOnly { repository =>
(for {
issueId <- params("id").toIntOpt
account <- context.loginAccount
settings = context.settings
data <- extractFromJsonBody[UpdateAPullRequest]
} yield {
updatePullRequestsByApi(
repository,
issueId,
account,
settings,
data.title,
data.body,
data.state,
data.base
)
JsonFormat(getApiPullRequest(repository, issueId))
}) getOrElse NotFound()
})
/*
* vi. List commits on a pull request
* https://developer.github.com/v3/pulls/#list-commits-on-a-pull-request
*/
get("/api/v3/repos/:owner/:repository/pulls/:id/commits")(referrersOnly { repository =>
val owner = repository.owner
val name = repository.name
params("id").toIntOpt.flatMap { issueId =>
getPullRequest(owner, name, issueId) map { case (issue, pullreq) =>
Using.resource(Git.open(getRepositoryDir(owner, name))) { git =>
val oldId = git.getRepository.resolve(pullreq.commitIdFrom)
val newId = git.getRepository.resolve(pullreq.commitIdTo)
val repoFullName = RepositoryName(repository)
val commits = git.log
.addRange(oldId, newId)
.call
.iterator
.asScala
.map { c =>
ApiCommitListItem(new CommitInfo(c), repoFullName)
}
.toList
JsonFormat(commits)
}
}
} getOrElse NotFound()
})
/*
* vii. List pull requests files
* https://developer.github.com/v3/pulls/#list-pull-requests-files
*/
/*
* viii. Get if a pull request has been merged
* https://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged
*/
get("/api/v3/repos/:owner/:repository/pulls/:id/merge")(referrersOnly { repository =>
(for {
issueId <- params("id").toIntOpt
(issue, pullReq) <- getPullRequest(repository.owner, repository.name, issueId)
} yield {
if (checkConflict(repository.owner, repository.name, pullReq.branch, issueId).isDefined) {
NoContent
} else {
NotFound()
}
}).getOrElse(NotFound())
})
/*
* ix. Merge a pull request (Merge Button)
* https://docs.github.com/en/rest/reference/pulls#merge-a-pull-request
*/
put("/api/v3/repos/:owner/:repository/pulls/:id/merge")(referrersOnly { repository =>
(for {
// TODO: crash when body is empty
// TODO: Implement sha parameter
data <- extractFromJsonBody[MergeAPullRequest]
issueId <- params("id").toIntOpt
(issue, pullReq) <- getPullRequest(repository.owner, repository.name, issueId)
} yield {
if (checkConflict(repository.owner, repository.name, pullReq.branch, issueId).isDefined) {
Conflict(
JsonFormat(
FailToMergePrResponse(
message = "Head branch was modified. Review and try the merge again.",
documentation_url = "https://docs.github.com/en/rest/reference/pulls#merge-a-pull-request",
)
)
)
} else {
if (issue.closed) {
MethodNotAllowed(
JsonFormat(
FailToMergePrResponse(
message = "Pull Request is not mergeable, Closed",
documentation_url = "https://docs.github.com/en/rest/reference/pulls#merge-a-pull-request",
)
)
)
} else {
val strategy =
if (data.merge_method.getOrElse("merge-commit") == "merge") "merge-commit"
else data.merge_method.getOrElse("merge-commit")
mergePullRequest(
repository,
issueId,
context.loginAccount.get,
data.commit_message.getOrElse(""), // TODO: Implement commit_title
strategy,
pullReq.isDraft,
context.settings
) match {
case Right(objectId) =>
Ok(
JsonFormat(
SuccessToMergePrResponse(
sha = objectId.toString,
merged = true,
message = "Pull Request successfully merged"
)
)
)
case Left(message) =>
MethodNotAllowed(
JsonFormat(
FailToMergePrResponse(
message = "Pull Request is not mergeable",
documentation_url = "https://docs.github.com/en/rest/reference/pulls#merge-a-pull-request",
)
)
)
}
}
}
})
})
/*
* x. Labels, assignees, and milestones
* https://developer.github.com/v3/pulls/#labels-assignees-and-milestones
*/
private def getApiPullRequest(repository: RepositoryService.RepositoryInfo, issueId: Int): Option[ApiPullRequest] = {
for {
(issue, pullRequest) <- getPullRequest(repository.owner, repository.name, issueId)
users = getAccountsByUserNames(
Set(repository.owner, pullRequest.requestUserName, issue.openedUserName),
Set.empty
)
baseOwner <- users.get(repository.owner)
headOwner <- users.get(pullRequest.requestUserName)
issueUser <- users.get(issue.openedUserName)
assignees = getIssueAssignees(repository.owner, repository.name, issueId).flatMap { assignedUser =>
getAccountByUserName(assignedUser.assigneeUserName, false)
}
headRepo <- getRepository(pullRequest.requestUserName, pullRequest.requestRepositoryName)
} yield {
ApiPullRequest(
issue = issue,
pullRequest = pullRequest,
headRepo = ApiRepository(headRepo, ApiUser(headOwner)),
baseRepo = ApiRepository(repository, ApiUser(baseOwner)),
user = ApiUser(issueUser),
labels = getIssueLabels(repository.owner, repository.name, issue.issueId)
.map(ApiLabel(_, RepositoryName(repository))),
assignees = assignees.map(ApiUser.apply),
mergedComment = getMergedComment(repository.owner, repository.name, issue.issueId)
)
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy