2016-01-28 20:49:05 +01:00
// Copyright 2016 The Gogs Authors. All rights reserved.
2019-04-19 14:17:27 +02:00
// Copyright 2019 The Gitea Authors. All rights reserved.
2022-11-27 13:20:29 -05:00
// SPDX-License-Identifier: MIT
2016-01-15 19:24:03 +01:00
package repo
import (
2021-06-07 22:52:59 +08:00
"errors"
2020-04-19 04:38:09 +02:00
"fmt"
2019-12-20 18:07:12 +01:00
"net/http"
2020-02-13 00:19:35 +01:00
"code.gitea.io/gitea/models"
2022-06-12 23:51:54 +08:00
git_model "code.gitea.io/gitea/models/git"
2022-03-29 14:29:02 +08:00
"code.gitea.io/gitea/models/organization"
2021-11-24 17:49:20 +08:00
user_model "code.gitea.io/gitea/models/user"
2016-11-10 17:24:48 +01:00
"code.gitea.io/gitea/modules/context"
2019-04-19 14:17:27 +02:00
"code.gitea.io/gitea/modules/git"
2019-05-11 18:21:34 +08:00
api "code.gitea.io/gitea/modules/structs"
2021-01-26 23:36:53 +08:00
"code.gitea.io/gitea/modules/web"
2021-02-03 20:06:13 +01:00
"code.gitea.io/gitea/routers/api/v1/utils"
2022-12-29 03:57:15 +01:00
"code.gitea.io/gitea/services/convert"
2020-10-14 02:50:57 +08:00
pull_service "code.gitea.io/gitea/services/pull"
2020-09-11 22:14:48 +08:00
repo_service "code.gitea.io/gitea/services/repository"
2016-01-15 19:24:03 +01:00
)
2016-11-24 15:04:31 +08:00
// GetBranch get a branch of a repository
2016-03-13 18:49:16 -04:00
func GetBranch ( ctx * context . APIContext ) {
2017-11-12 23:02:25 -08:00
// swagger:operation GET /repos/{owner}/{repo}/branches/{branch} repository repoGetBranch
// ---
2019-11-16 20:39:18 +01:00
// summary: Retrieve a specific branch from a repository, including its effective branch protection
2017-11-12 23:02:25 -08:00
// 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: branch
// in: path
// description: branch to get
// type: string
// required: true
// responses:
// "200":
// "$ref": "#/responses/Branch"
2020-11-14 17:13:55 +01:00
// "404":
// "$ref": "#/responses/notFound"
2019-12-20 18:07:12 +01:00
2020-11-14 17:13:55 +01:00
branchName := ctx . Params ( "*" )
2022-01-19 23:26:57 +00:00
branch , err := ctx . Repo . GitRepo . GetBranch ( branchName )
2016-01-15 19:24:03 +01:00
if err != nil {
2019-04-19 14:17:27 +02:00
if git . IsErrBranchNotExist ( err ) {
2019-03-18 21:29:43 -05:00
ctx . NotFound ( err )
2017-06-11 04:57:28 +02:00
} else {
2019-12-20 18:07:12 +01:00
ctx . Error ( http . StatusInternalServerError , "GetBranch" , err )
2017-06-11 04:57:28 +02:00
}
2016-01-15 19:24:03 +01:00
return
}
2016-02-02 17:07:40 -05:00
2016-01-15 19:24:03 +01:00
c , err := branch . GetCommit ( )
if err != nil {
2019-12-20 18:07:12 +01:00
ctx . Error ( http . StatusInternalServerError , "GetCommit" , err )
2016-01-15 19:24:03 +01:00
return
}
2016-02-02 17:07:40 -05:00
2023-01-16 16:00:22 +08:00
branchProtection , err := git_model . GetFirstMatchProtectedBranchRule ( ctx , ctx . Repo . Repository . ID , branchName )
2019-11-16 20:39:18 +01:00
if err != nil {
2019-12-20 18:07:12 +01:00
ctx . Error ( http . StatusInternalServerError , "GetBranchProtection" , err )
2019-11-16 20:39:18 +01:00
return
}
Add context cache as a request level cache (#22294)
To avoid duplicated load of the same data in an HTTP request, we can set
a context cache to do that. i.e. Some pages may load a user from a
database with the same id in different areas on the same page. But the
code is hidden in two different deep logic. How should we share the
user? As a result of this PR, now if both entry functions accept
`context.Context` as the first parameter and we just need to refactor
`GetUserByID` to reuse the user from the context cache. Then it will not
be loaded twice on an HTTP request.
But of course, sometimes we would like to reload an object from the
database, that's why `RemoveContextData` is also exposed.
The core context cache is here. It defines a new context
```go
type cacheContext struct {
ctx context.Context
data map[any]map[any]any
lock sync.RWMutex
}
var cacheContextKey = struct{}{}
func WithCacheContext(ctx context.Context) context.Context {
return context.WithValue(ctx, cacheContextKey, &cacheContext{
ctx: ctx,
data: make(map[any]map[any]any),
})
}
```
Then you can use the below 4 methods to read/write/del the data within
the same context.
```go
func GetContextData(ctx context.Context, tp, key any) any
func SetContextData(ctx context.Context, tp, key, value any)
func RemoveContextData(ctx context.Context, tp, key any)
func GetWithContextCache[T any](ctx context.Context, cacheGroupKey string, cacheTargetID any, f func() (T, error)) (T, error)
```
Then let's take a look at how `system.GetString` implement it.
```go
func GetSetting(ctx context.Context, key string) (string, error) {
return cache.GetWithContextCache(ctx, contextCacheKey, key, func() (string, error) {
return cache.GetString(genSettingCacheKey(key), func() (string, error) {
res, err := GetSettingNoCache(ctx, key)
if err != nil {
return "", err
}
return res.SettingValue, nil
})
})
}
```
First, it will check if context data include the setting object with the
key. If not, it will query from the global cache which may be memory or
a Redis cache. If not, it will get the object from the database. In the
end, if the object gets from the global cache or database, it will be
set into the context cache.
An object stored in the context cache will only be destroyed after the
context disappeared.
2023-02-15 21:37:34 +08:00
br , err := convert . ToBranch ( ctx , ctx . Repo . Repository , branch , c , branchProtection , ctx . Doer , ctx . Repo . IsAdmin ( ) )
2020-03-21 11:41:33 +08:00
if err != nil {
ctx . Error ( http . StatusInternalServerError , "convert.ToBranch" , err )
return
}
ctx . JSON ( http . StatusOK , br )
2016-01-15 19:24:03 +01:00
}
2020-04-19 04:38:09 +02:00
// DeleteBranch get a branch of a repository
func DeleteBranch ( ctx * context . APIContext ) {
// swagger:operation DELETE /repos/{owner}/{repo}/branches/{branch} repository repoDeleteBranch
// ---
// summary: Delete a specific branch from a repository
// 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: branch
// in: path
// description: branch to delete
// type: string
// required: true
// responses:
// "204":
// "$ref": "#/responses/empty"
// "403":
// "$ref": "#/responses/error"
2020-11-14 17:13:55 +01:00
// "404":
// "$ref": "#/responses/notFound"
2020-04-19 04:38:09 +02:00
2020-11-14 17:13:55 +01:00
branchName := ctx . Params ( "*" )
2020-04-19 04:38:09 +02:00
2022-03-22 08:03:22 +01:00
if err := repo_service . DeleteBranch ( ctx . Doer , ctx . Repo . Repository , ctx . Repo . GitRepo , branchName ) ; err != nil {
2021-06-07 22:52:59 +08:00
switch {
case git . IsErrBranchNotExist ( err ) :
2020-04-19 04:38:09 +02:00
ctx . NotFound ( err )
2021-06-07 22:52:59 +08:00
case errors . Is ( err , repo_service . ErrBranchIsDefault ) :
ctx . Error ( http . StatusForbidden , "DefaultBranch" , fmt . Errorf ( "can not delete default branch" ) )
2023-01-16 16:00:22 +08:00
case errors . Is ( err , git_model . ErrBranchIsProtected ) :
2021-06-07 22:52:59 +08:00
ctx . Error ( http . StatusForbidden , "IsProtectedBranch" , fmt . Errorf ( "branch protected" ) )
default :
ctx . Error ( http . StatusInternalServerError , "DeleteBranch" , err )
2020-04-19 04:38:09 +02:00
}
return
}
ctx . Status ( http . StatusNoContent )
}
2020-05-29 20:16:20 +02:00
// CreateBranch creates a branch for a user's repository
2021-01-26 23:36:53 +08:00
func CreateBranch ( ctx * context . APIContext ) {
2020-05-29 20:16:20 +02:00
// swagger:operation POST /repos/{owner}/{repo}/branches repository repoCreateBranch
// ---
// summary: Create a branch
// 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/CreateBranchRepoOption"
// responses:
// "201":
// "$ref": "#/responses/Branch"
// "404":
// description: The old branch does not exist.
// "409":
// description: The branch with the same name already exists.
2021-01-26 23:36:53 +08:00
opt := web . GetForm ( ctx ) . ( * api . CreateBranchRepoOption )
2020-05-29 20:16:20 +02:00
if ctx . Repo . Repository . IsEmpty {
ctx . Error ( http . StatusNotFound , "" , "Git Repository is empty." )
return
}
if len ( opt . OldBranchName ) == 0 {
opt . OldBranchName = ctx . Repo . Repository . DefaultBranch
}
2022-03-22 08:03:22 +01:00
err := repo_service . CreateNewBranch ( ctx , ctx . Doer , ctx . Repo . Repository , opt . OldBranchName , opt . BranchName )
2020-05-29 20:16:20 +02:00
if err != nil {
if models . IsErrBranchDoesNotExist ( err ) {
ctx . Error ( http . StatusNotFound , "" , "The old branch does not exist" )
}
if models . IsErrTagAlreadyExists ( err ) {
ctx . Error ( http . StatusConflict , "" , "The branch with the same tag already exists." )
} else if models . IsErrBranchAlreadyExists ( err ) || git . IsErrPushOutOfDate ( err ) {
ctx . Error ( http . StatusConflict , "" , "The branch already exists." )
} else if models . IsErrBranchNameConflict ( err ) {
ctx . Error ( http . StatusConflict , "" , "The branch with the same name already exists." )
} else {
ctx . Error ( http . StatusInternalServerError , "CreateRepoBranch" , err )
}
return
}
2022-01-19 23:26:57 +00:00
branch , err := ctx . Repo . GitRepo . GetBranch ( opt . BranchName )
2020-05-29 20:16:20 +02:00
if err != nil {
ctx . Error ( http . StatusInternalServerError , "GetBranch" , err )
return
}
commit , err := branch . GetCommit ( )
if err != nil {
ctx . Error ( http . StatusInternalServerError , "GetCommit" , err )
return
}
2023-01-16 16:00:22 +08:00
branchProtection , err := git_model . GetFirstMatchProtectedBranchRule ( ctx , ctx . Repo . Repository . ID , branch . Name )
2020-05-29 20:16:20 +02:00
if err != nil {
ctx . Error ( http . StatusInternalServerError , "GetBranchProtection" , err )
return
}
Add context cache as a request level cache (#22294)
To avoid duplicated load of the same data in an HTTP request, we can set
a context cache to do that. i.e. Some pages may load a user from a
database with the same id in different areas on the same page. But the
code is hidden in two different deep logic. How should we share the
user? As a result of this PR, now if both entry functions accept
`context.Context` as the first parameter and we just need to refactor
`GetUserByID` to reuse the user from the context cache. Then it will not
be loaded twice on an HTTP request.
But of course, sometimes we would like to reload an object from the
database, that's why `RemoveContextData` is also exposed.
The core context cache is here. It defines a new context
```go
type cacheContext struct {
ctx context.Context
data map[any]map[any]any
lock sync.RWMutex
}
var cacheContextKey = struct{}{}
func WithCacheContext(ctx context.Context) context.Context {
return context.WithValue(ctx, cacheContextKey, &cacheContext{
ctx: ctx,
data: make(map[any]map[any]any),
})
}
```
Then you can use the below 4 methods to read/write/del the data within
the same context.
```go
func GetContextData(ctx context.Context, tp, key any) any
func SetContextData(ctx context.Context, tp, key, value any)
func RemoveContextData(ctx context.Context, tp, key any)
func GetWithContextCache[T any](ctx context.Context, cacheGroupKey string, cacheTargetID any, f func() (T, error)) (T, error)
```
Then let's take a look at how `system.GetString` implement it.
```go
func GetSetting(ctx context.Context, key string) (string, error) {
return cache.GetWithContextCache(ctx, contextCacheKey, key, func() (string, error) {
return cache.GetString(genSettingCacheKey(key), func() (string, error) {
res, err := GetSettingNoCache(ctx, key)
if err != nil {
return "", err
}
return res.SettingValue, nil
})
})
}
```
First, it will check if context data include the setting object with the
key. If not, it will query from the global cache which may be memory or
a Redis cache. If not, it will get the object from the database. In the
end, if the object gets from the global cache or database, it will be
set into the context cache.
An object stored in the context cache will only be destroyed after the
context disappeared.
2023-02-15 21:37:34 +08:00
br , err := convert . ToBranch ( ctx , ctx . Repo . Repository , branch , commit , branchProtection , ctx . Doer , ctx . Repo . IsAdmin ( ) )
2020-05-29 20:16:20 +02:00
if err != nil {
ctx . Error ( http . StatusInternalServerError , "convert.ToBranch" , err )
return
}
ctx . JSON ( http . StatusCreated , br )
}
2016-11-24 15:04:31 +08:00
// ListBranches list all the branches of a repository
2016-03-13 18:49:16 -04:00
func ListBranches ( ctx * context . APIContext ) {
2017-11-12 23:02:25 -08:00
// swagger:operation GET /repos/{owner}/{repo}/branches repository repoListBranches
// ---
// summary: List a repository's branches
// 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
2021-02-03 20:06:13 +01:00
// - name: page
// in: query
// description: page number of results to return (1-based)
// type: integer
// - name: limit
// in: query
// description: page size of results
// type: integer
2017-11-12 23:02:25 -08:00
// responses:
// "200":
// "$ref": "#/responses/BranchList"
2019-12-20 18:07:12 +01:00
2022-12-04 16:57:17 +08:00
var totalNumOfBranches int
var apiBranches [ ] * api . Branch
2021-02-03 20:06:13 +01:00
listOptions := utils . GetListOptions ( ctx )
2016-02-02 17:07:40 -05:00
2022-12-04 16:57:17 +08:00
if ! ctx . Repo . Repository . IsEmpty && ctx . Repo . GitRepo != nil {
2023-01-16 16:00:22 +08:00
rules , err := git_model . FindRepoProtectedBranchRules ( ctx , ctx . Repo . Repository . ID )
if err != nil {
ctx . Error ( http . StatusInternalServerError , "FindMatchedProtectedBranchRules" , err )
return
}
2022-12-04 16:57:17 +08:00
skip , _ := listOptions . GetStartEnd ( )
branches , total , err := ctx . Repo . GitRepo . GetBranches ( skip , listOptions . PageSize )
2019-11-16 20:39:18 +01:00
if err != nil {
2022-12-04 16:57:17 +08:00
ctx . Error ( http . StatusInternalServerError , "GetBranches" , err )
2019-11-16 20:39:18 +01:00
return
}
2022-12-04 16:57:17 +08:00
apiBranches = make ( [ ] * api . Branch , 0 , len ( branches ) )
for i := range branches {
c , err := branches [ i ] . GetCommit ( )
if err != nil {
// Skip if this branch doesn't exist anymore.
if git . IsErrNotExist ( err ) {
total --
continue
}
ctx . Error ( http . StatusInternalServerError , "GetCommit" , err )
return
}
2023-01-16 16:00:22 +08:00
branchProtection := rules . GetFirstMatched ( branches [ i ] . Name )
Add context cache as a request level cache (#22294)
To avoid duplicated load of the same data in an HTTP request, we can set
a context cache to do that. i.e. Some pages may load a user from a
database with the same id in different areas on the same page. But the
code is hidden in two different deep logic. How should we share the
user? As a result of this PR, now if both entry functions accept
`context.Context` as the first parameter and we just need to refactor
`GetUserByID` to reuse the user from the context cache. Then it will not
be loaded twice on an HTTP request.
But of course, sometimes we would like to reload an object from the
database, that's why `RemoveContextData` is also exposed.
The core context cache is here. It defines a new context
```go
type cacheContext struct {
ctx context.Context
data map[any]map[any]any
lock sync.RWMutex
}
var cacheContextKey = struct{}{}
func WithCacheContext(ctx context.Context) context.Context {
return context.WithValue(ctx, cacheContextKey, &cacheContext{
ctx: ctx,
data: make(map[any]map[any]any),
})
}
```
Then you can use the below 4 methods to read/write/del the data within
the same context.
```go
func GetContextData(ctx context.Context, tp, key any) any
func SetContextData(ctx context.Context, tp, key, value any)
func RemoveContextData(ctx context.Context, tp, key any)
func GetWithContextCache[T any](ctx context.Context, cacheGroupKey string, cacheTargetID any, f func() (T, error)) (T, error)
```
Then let's take a look at how `system.GetString` implement it.
```go
func GetSetting(ctx context.Context, key string) (string, error) {
return cache.GetWithContextCache(ctx, contextCacheKey, key, func() (string, error) {
return cache.GetString(genSettingCacheKey(key), func() (string, error) {
res, err := GetSettingNoCache(ctx, key)
if err != nil {
return "", err
}
return res.SettingValue, nil
})
})
}
```
First, it will check if context data include the setting object with the
key. If not, it will query from the global cache which may be memory or
a Redis cache. If not, it will get the object from the database. In the
end, if the object gets from the global cache or database, it will be
set into the context cache.
An object stored in the context cache will only be destroyed after the
context disappeared.
2023-02-15 21:37:34 +08:00
apiBranch , err := convert . ToBranch ( ctx , ctx . Repo . Repository , branches [ i ] , c , branchProtection , ctx . Doer , ctx . Repo . IsAdmin ( ) )
2022-12-04 16:57:17 +08:00
if err != nil {
ctx . Error ( http . StatusInternalServerError , "convert.ToBranch" , err )
return
}
apiBranches = append ( apiBranches , apiBranch )
2020-03-21 11:41:33 +08:00
}
2022-12-04 16:57:17 +08:00
totalNumOfBranches = total
2016-01-15 19:24:03 +01:00
}
2016-02-02 17:07:40 -05:00
2021-08-12 14:43:08 +02:00
ctx . SetLinkHeader ( totalNumOfBranches , listOptions . PageSize )
ctx . SetTotalCountHeader ( int64 ( totalNumOfBranches ) )
2022-12-04 16:57:17 +08:00
ctx . JSON ( http . StatusOK , apiBranches )
2016-01-15 19:24:03 +01:00
}
2020-02-13 00:19:35 +01:00
// GetBranchProtection gets a branch protection
func GetBranchProtection ( ctx * context . APIContext ) {
// swagger:operation GET /repos/{owner}/{repo}/branch_protections/{name} repository repoGetBranchProtection
// ---
// summary: Get a specific branch protection for the repository
// 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: name
// in: path
// description: name of protected branch
// type: string
// required: true
// responses:
// "200":
// "$ref": "#/responses/BranchProtection"
// "404":
// "$ref": "#/responses/notFound"
repo := ctx . Repo . Repository
bpName := ctx . Params ( ":name" )
2023-01-16 16:00:22 +08:00
bp , err := git_model . GetProtectedBranchRuleByName ( ctx , repo . ID , bpName )
2020-02-13 00:19:35 +01:00
if err != nil {
ctx . Error ( http . StatusInternalServerError , "GetProtectedBranchByID" , err )
return
}
if bp == nil || bp . RepoID != repo . ID {
ctx . NotFound ( )
return
}
ctx . JSON ( http . StatusOK , convert . ToBranchProtection ( bp ) )
}
// ListBranchProtections list branch protections for a repo
func ListBranchProtections ( ctx * context . APIContext ) {
// swagger:operation GET /repos/{owner}/{repo}/branch_protections repository repoListBranchProtection
// ---
// summary: List branch protections for a repository
// 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
// responses:
// "200":
// "$ref": "#/responses/BranchProtectionList"
repo := ctx . Repo . Repository
2023-01-16 16:00:22 +08:00
bps , err := git_model . FindRepoProtectedBranchRules ( ctx , repo . ID )
2020-02-13 00:19:35 +01:00
if err != nil {
ctx . Error ( http . StatusInternalServerError , "GetProtectedBranches" , err )
return
}
apiBps := make ( [ ] * api . BranchProtection , len ( bps ) )
for i := range bps {
apiBps [ i ] = convert . ToBranchProtection ( bps [ i ] )
}
ctx . JSON ( http . StatusOK , apiBps )
}
// CreateBranchProtection creates a branch protection for a repo
2021-01-26 23:36:53 +08:00
func CreateBranchProtection ( ctx * context . APIContext ) {
2020-02-13 00:19:35 +01:00
// swagger:operation POST /repos/{owner}/{repo}/branch_protections repository repoCreateBranchProtection
// ---
// summary: Create a branch protections for a repository
// 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/CreateBranchProtectionOption"
// responses:
// "201":
// "$ref": "#/responses/BranchProtection"
// "403":
// "$ref": "#/responses/forbidden"
// "404":
// "$ref": "#/responses/notFound"
// "422":
// "$ref": "#/responses/validationError"
2021-01-26 23:36:53 +08:00
form := web . GetForm ( ctx ) . ( * api . CreateBranchProtectionOption )
2020-02-13 00:19:35 +01:00
repo := ctx . Repo . Repository
2023-01-16 16:00:22 +08:00
ruleName := form . RuleName
if ruleName == "" {
ruleName = form . BranchName //nolint
}
isPlainRule := ! git_model . IsRuleNameSpecial ( ruleName )
var isBranchExist bool
if isPlainRule {
isBranchExist = git . IsBranchExist ( ctx . Req . Context ( ) , ctx . Repo . Repository . RepoPath ( ) , ruleName )
2020-02-13 00:19:35 +01:00
}
2023-01-16 16:00:22 +08:00
protectBranch , err := git_model . GetProtectedBranchRuleByName ( ctx , repo . ID , ruleName )
2020-02-13 00:19:35 +01:00
if err != nil {
ctx . Error ( http . StatusInternalServerError , "GetProtectBranchOfRepoByName" , err )
return
} else if protectBranch != nil {
ctx . Error ( http . StatusForbidden , "Create branch protection" , "Branch protection already exist" )
return
}
var requiredApprovals int64
if form . RequiredApprovals > 0 {
requiredApprovals = form . RequiredApprovals
}
2022-11-19 09:12:33 +01:00
whitelistUsers , err := user_model . GetUserIDsByNames ( ctx , form . PushWhitelistUsernames , false )
2020-02-13 00:19:35 +01:00
if err != nil {
2021-11-24 17:49:20 +08:00
if user_model . IsErrUserNotExist ( err ) {
2020-02-13 00:19:35 +01:00
ctx . Error ( http . StatusUnprocessableEntity , "User does not exist" , err )
return
}
ctx . Error ( http . StatusInternalServerError , "GetUserIDsByNames" , err )
return
}
2022-11-19 09:12:33 +01:00
mergeWhitelistUsers , err := user_model . GetUserIDsByNames ( ctx , form . MergeWhitelistUsernames , false )
2020-02-13 00:19:35 +01:00
if err != nil {
2021-11-24 17:49:20 +08:00
if user_model . IsErrUserNotExist ( err ) {
2020-02-13 00:19:35 +01:00
ctx . Error ( http . StatusUnprocessableEntity , "User does not exist" , err )
return
}
ctx . Error ( http . StatusInternalServerError , "GetUserIDsByNames" , err )
return
}
2022-11-19 09:12:33 +01:00
approvalsWhitelistUsers , err := user_model . GetUserIDsByNames ( ctx , form . ApprovalsWhitelistUsernames , false )
2020-02-13 00:19:35 +01:00
if err != nil {
2021-11-24 17:49:20 +08:00
if user_model . IsErrUserNotExist ( err ) {
2020-02-13 00:19:35 +01:00
ctx . Error ( http . StatusUnprocessableEntity , "User does not exist" , err )
return
}
ctx . Error ( http . StatusInternalServerError , "GetUserIDsByNames" , err )
return
}
var whitelistTeams , mergeWhitelistTeams , approvalsWhitelistTeams [ ] int64
if repo . Owner . IsOrganization ( ) {
2022-03-29 14:29:02 +08:00
whitelistTeams , err = organization . GetTeamIDsByNames ( repo . OwnerID , form . PushWhitelistTeams , false )
2020-02-13 00:19:35 +01:00
if err != nil {
2022-03-29 14:29:02 +08:00
if organization . IsErrTeamNotExist ( err ) {
2020-02-13 00:19:35 +01:00
ctx . Error ( http . StatusUnprocessableEntity , "Team does not exist" , err )
return
}
ctx . Error ( http . StatusInternalServerError , "GetTeamIDsByNames" , err )
return
}
2022-03-29 14:29:02 +08:00
mergeWhitelistTeams , err = organization . GetTeamIDsByNames ( repo . OwnerID , form . MergeWhitelistTeams , false )
2020-02-13 00:19:35 +01:00
if err != nil {
2022-03-29 14:29:02 +08:00
if organization . IsErrTeamNotExist ( err ) {
2020-02-13 00:19:35 +01:00
ctx . Error ( http . StatusUnprocessableEntity , "Team does not exist" , err )
return
}
ctx . Error ( http . StatusInternalServerError , "GetTeamIDsByNames" , err )
return
}
2022-03-29 14:29:02 +08:00
approvalsWhitelistTeams , err = organization . GetTeamIDsByNames ( repo . OwnerID , form . ApprovalsWhitelistTeams , false )
2020-02-13 00:19:35 +01:00
if err != nil {
2022-03-29 14:29:02 +08:00
if organization . IsErrTeamNotExist ( err ) {
2020-02-13 00:19:35 +01:00
ctx . Error ( http . StatusUnprocessableEntity , "Team does not exist" , err )
return
}
ctx . Error ( http . StatusInternalServerError , "GetTeamIDsByNames" , err )
return
}
}
2022-06-12 23:51:54 +08:00
protectBranch = & git_model . ProtectedBranch {
2020-11-29 03:30:46 +08:00
RepoID : ctx . Repo . Repository . ID ,
2023-01-16 16:00:22 +08:00
RuleName : form . RuleName ,
2020-11-29 03:30:46 +08:00
CanPush : form . EnablePush ,
EnableWhitelist : form . EnablePush && form . EnablePushWhitelist ,
EnableMergeWhitelist : form . EnableMergeWhitelist ,
WhitelistDeployKeys : form . EnablePush && form . EnablePushWhitelist && form . PushWhitelistDeployKeys ,
EnableStatusCheck : form . EnableStatusCheck ,
StatusCheckContexts : form . StatusCheckContexts ,
EnableApprovalsWhitelist : form . EnableApprovalsWhitelist ,
RequiredApprovals : requiredApprovals ,
BlockOnRejectedReviews : form . BlockOnRejectedReviews ,
BlockOnOfficialReviewRequests : form . BlockOnOfficialReviewRequests ,
DismissStaleApprovals : form . DismissStaleApprovals ,
RequireSignedCommits : form . RequireSignedCommits ,
ProtectedFilePatterns : form . ProtectedFilePatterns ,
2021-09-11 16:21:17 +02:00
UnprotectedFilePatterns : form . UnprotectedFilePatterns ,
2020-11-29 03:30:46 +08:00
BlockOnOutdatedBranch : form . BlockOnOutdatedBranch ,
2020-02-13 00:19:35 +01:00
}
2022-06-12 23:51:54 +08:00
err = git_model . UpdateProtectBranch ( ctx , ctx . Repo . Repository , protectBranch , git_model . WhitelistOptions {
2020-02-13 00:19:35 +01:00
UserIDs : whitelistUsers ,
TeamIDs : whitelistTeams ,
MergeUserIDs : mergeWhitelistUsers ,
MergeTeamIDs : mergeWhitelistTeams ,
ApprovalsUserIDs : approvalsWhitelistUsers ,
ApprovalsTeamIDs : approvalsWhitelistTeams ,
} )
if err != nil {
ctx . Error ( http . StatusInternalServerError , "UpdateProtectBranch" , err )
return
}
2023-01-16 16:00:22 +08:00
if isBranchExist {
if err = pull_service . CheckPRsForBaseBranch ( ctx . Repo . Repository , form . RuleName ) ; err != nil {
ctx . Error ( http . StatusInternalServerError , "CheckPRsForBaseBranch" , err )
return
}
} else {
if ! isPlainRule {
if ctx . Repo . GitRepo == nil {
ctx . Repo . GitRepo , err = git . OpenRepository ( ctx , ctx . Repo . Repository . RepoPath ( ) )
if err != nil {
ctx . Error ( http . StatusInternalServerError , "OpenRepository" , err )
return
}
defer func ( ) {
ctx . Repo . GitRepo . Close ( )
ctx . Repo . GitRepo = nil
} ( )
}
// FIXME: since we only need to recheck files protected rules, we could improve this
matchedBranches , err := git_model . FindAllMatchedBranches ( ctx , ctx . Repo . GitRepo , form . RuleName )
if err != nil {
ctx . Error ( http . StatusInternalServerError , "FindAllMatchedBranches" , err )
return
}
for _ , branchName := range matchedBranches {
if err = pull_service . CheckPRsForBaseBranch ( ctx . Repo . Repository , branchName ) ; err != nil {
ctx . Error ( http . StatusInternalServerError , "CheckPRsForBaseBranch" , err )
return
}
}
}
2020-10-14 02:50:57 +08:00
}
2020-02-13 00:19:35 +01:00
// Reload from db to get all whitelists
2023-01-16 16:00:22 +08:00
bp , err := git_model . GetProtectedBranchRuleByName ( ctx , ctx . Repo . Repository . ID , form . RuleName )
2020-02-13 00:19:35 +01:00
if err != nil {
ctx . Error ( http . StatusInternalServerError , "GetProtectedBranchByID" , err )
return
}
if bp == nil || bp . RepoID != ctx . Repo . Repository . ID {
ctx . Error ( http . StatusInternalServerError , "New branch protection not found" , err )
return
}
ctx . JSON ( http . StatusCreated , convert . ToBranchProtection ( bp ) )
}
// EditBranchProtection edits a branch protection for a repo
2021-01-26 23:36:53 +08:00
func EditBranchProtection ( ctx * context . APIContext ) {
2020-02-13 00:19:35 +01:00
// swagger:operation PATCH /repos/{owner}/{repo}/branch_protections/{name} repository repoEditBranchProtection
// ---
// summary: Edit a branch protections for a repository. Only fields that are set will be changed
// 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: name
// in: path
// description: name of protected branch
// type: string
// required: true
// - name: body
// in: body
// schema:
// "$ref": "#/definitions/EditBranchProtectionOption"
// responses:
// "200":
// "$ref": "#/responses/BranchProtection"
// "404":
// "$ref": "#/responses/notFound"
// "422":
// "$ref": "#/responses/validationError"
2021-01-26 23:36:53 +08:00
form := web . GetForm ( ctx ) . ( * api . EditBranchProtectionOption )
2020-02-13 00:19:35 +01:00
repo := ctx . Repo . Repository
bpName := ctx . Params ( ":name" )
2023-01-16 16:00:22 +08:00
protectBranch , err := git_model . GetProtectedBranchRuleByName ( ctx , repo . ID , bpName )
2020-02-13 00:19:35 +01:00
if err != nil {
ctx . Error ( http . StatusInternalServerError , "GetProtectedBranchByID" , err )
return
}
if protectBranch == nil || protectBranch . RepoID != repo . ID {
ctx . NotFound ( )
return
}
if form . EnablePush != nil {
if ! * form . EnablePush {
protectBranch . CanPush = false
protectBranch . EnableWhitelist = false
protectBranch . WhitelistDeployKeys = false
} else {
protectBranch . CanPush = true
if form . EnablePushWhitelist != nil {
if ! * form . EnablePushWhitelist {
protectBranch . EnableWhitelist = false
protectBranch . WhitelistDeployKeys = false
} else {
protectBranch . EnableWhitelist = true
if form . PushWhitelistDeployKeys != nil {
protectBranch . WhitelistDeployKeys = * form . PushWhitelistDeployKeys
}
}
}
}
}
if form . EnableMergeWhitelist != nil {
protectBranch . EnableMergeWhitelist = * form . EnableMergeWhitelist
}
if form . EnableStatusCheck != nil {
protectBranch . EnableStatusCheck = * form . EnableStatusCheck
}
if protectBranch . EnableStatusCheck {
protectBranch . StatusCheckContexts = form . StatusCheckContexts
}
if form . RequiredApprovals != nil && * form . RequiredApprovals >= 0 {
protectBranch . RequiredApprovals = * form . RequiredApprovals
}
if form . EnableApprovalsWhitelist != nil {
protectBranch . EnableApprovalsWhitelist = * form . EnableApprovalsWhitelist
}
if form . BlockOnRejectedReviews != nil {
protectBranch . BlockOnRejectedReviews = * form . BlockOnRejectedReviews
}
2020-11-29 03:30:46 +08:00
if form . BlockOnOfficialReviewRequests != nil {
protectBranch . BlockOnOfficialReviewRequests = * form . BlockOnOfficialReviewRequests
}
2020-02-13 00:19:35 +01:00
if form . DismissStaleApprovals != nil {
protectBranch . DismissStaleApprovals = * form . DismissStaleApprovals
}
if form . RequireSignedCommits != nil {
protectBranch . RequireSignedCommits = * form . RequireSignedCommits
}
2020-03-27 00:26:34 +02:00
if form . ProtectedFilePatterns != nil {
protectBranch . ProtectedFilePatterns = * form . ProtectedFilePatterns
}
2021-09-11 16:21:17 +02:00
if form . UnprotectedFilePatterns != nil {
protectBranch . UnprotectedFilePatterns = * form . UnprotectedFilePatterns
}
2020-04-17 03:00:36 +02:00
if form . BlockOnOutdatedBranch != nil {
protectBranch . BlockOnOutdatedBranch = * form . BlockOnOutdatedBranch
}
2020-02-13 00:19:35 +01:00
var whitelistUsers [ ] int64
if form . PushWhitelistUsernames != nil {
2022-11-19 09:12:33 +01:00
whitelistUsers , err = user_model . GetUserIDsByNames ( ctx , form . PushWhitelistUsernames , false )
2020-02-13 00:19:35 +01:00
if err != nil {
2021-11-24 17:49:20 +08:00
if user_model . IsErrUserNotExist ( err ) {
2020-02-13 00:19:35 +01:00
ctx . Error ( http . StatusUnprocessableEntity , "User does not exist" , err )
return
}
ctx . Error ( http . StatusInternalServerError , "GetUserIDsByNames" , err )
return
}
} else {
whitelistUsers = protectBranch . WhitelistUserIDs
}
var mergeWhitelistUsers [ ] int64
if form . MergeWhitelistUsernames != nil {
2022-11-19 09:12:33 +01:00
mergeWhitelistUsers , err = user_model . GetUserIDsByNames ( ctx , form . MergeWhitelistUsernames , false )
2020-02-13 00:19:35 +01:00
if err != nil {
2021-11-24 17:49:20 +08:00
if user_model . IsErrUserNotExist ( err ) {
2020-02-13 00:19:35 +01:00
ctx . Error ( http . StatusUnprocessableEntity , "User does not exist" , err )
return
}
ctx . Error ( http . StatusInternalServerError , "GetUserIDsByNames" , err )
return
}
} else {
mergeWhitelistUsers = protectBranch . MergeWhitelistUserIDs
}
var approvalsWhitelistUsers [ ] int64
if form . ApprovalsWhitelistUsernames != nil {
2022-11-19 09:12:33 +01:00
approvalsWhitelistUsers , err = user_model . GetUserIDsByNames ( ctx , form . ApprovalsWhitelistUsernames , false )
2020-02-13 00:19:35 +01:00
if err != nil {
2021-11-24 17:49:20 +08:00
if user_model . IsErrUserNotExist ( err ) {
2020-02-13 00:19:35 +01:00
ctx . Error ( http . StatusUnprocessableEntity , "User does not exist" , err )
return
}
ctx . Error ( http . StatusInternalServerError , "GetUserIDsByNames" , err )
return
}
} else {
approvalsWhitelistUsers = protectBranch . ApprovalsWhitelistUserIDs
}
var whitelistTeams , mergeWhitelistTeams , approvalsWhitelistTeams [ ] int64
if repo . Owner . IsOrganization ( ) {
if form . PushWhitelistTeams != nil {
2022-03-29 14:29:02 +08:00
whitelistTeams , err = organization . GetTeamIDsByNames ( repo . OwnerID , form . PushWhitelistTeams , false )
2020-02-13 00:19:35 +01:00
if err != nil {
2022-03-29 14:29:02 +08:00
if organization . IsErrTeamNotExist ( err ) {
2020-02-13 00:19:35 +01:00
ctx . Error ( http . StatusUnprocessableEntity , "Team does not exist" , err )
return
}
ctx . Error ( http . StatusInternalServerError , "GetTeamIDsByNames" , err )
return
}
} else {
whitelistTeams = protectBranch . WhitelistTeamIDs
}
if form . MergeWhitelistTeams != nil {
2022-03-29 14:29:02 +08:00
mergeWhitelistTeams , err = organization . GetTeamIDsByNames ( repo . OwnerID , form . MergeWhitelistTeams , false )
2020-02-13 00:19:35 +01:00
if err != nil {
2022-03-29 14:29:02 +08:00
if organization . IsErrTeamNotExist ( err ) {
2020-02-13 00:19:35 +01:00
ctx . Error ( http . StatusUnprocessableEntity , "Team does not exist" , err )
return
}
ctx . Error ( http . StatusInternalServerError , "GetTeamIDsByNames" , err )
return
}
} else {
mergeWhitelistTeams = protectBranch . MergeWhitelistTeamIDs
}
if form . ApprovalsWhitelistTeams != nil {
2022-03-29 14:29:02 +08:00
approvalsWhitelistTeams , err = organization . GetTeamIDsByNames ( repo . OwnerID , form . ApprovalsWhitelistTeams , false )
2020-02-13 00:19:35 +01:00
if err != nil {
2022-03-29 14:29:02 +08:00
if organization . IsErrTeamNotExist ( err ) {
2020-02-13 00:19:35 +01:00
ctx . Error ( http . StatusUnprocessableEntity , "Team does not exist" , err )
return
}
ctx . Error ( http . StatusInternalServerError , "GetTeamIDsByNames" , err )
return
}
} else {
approvalsWhitelistTeams = protectBranch . ApprovalsWhitelistTeamIDs
}
}
2022-06-12 23:51:54 +08:00
err = git_model . UpdateProtectBranch ( ctx , ctx . Repo . Repository , protectBranch , git_model . WhitelistOptions {
2020-02-13 00:19:35 +01:00
UserIDs : whitelistUsers ,
TeamIDs : whitelistTeams ,
MergeUserIDs : mergeWhitelistUsers ,
MergeTeamIDs : mergeWhitelistTeams ,
ApprovalsUserIDs : approvalsWhitelistUsers ,
ApprovalsTeamIDs : approvalsWhitelistTeams ,
} )
if err != nil {
ctx . Error ( http . StatusInternalServerError , "UpdateProtectBranch" , err )
return
}
2023-01-16 16:00:22 +08:00
isPlainRule := ! git_model . IsRuleNameSpecial ( bpName )
var isBranchExist bool
if isPlainRule {
isBranchExist = git . IsBranchExist ( ctx . Req . Context ( ) , ctx . Repo . Repository . RepoPath ( ) , bpName )
}
if isBranchExist {
if err = pull_service . CheckPRsForBaseBranch ( ctx . Repo . Repository , bpName ) ; err != nil {
ctx . Error ( http . StatusInternalServerError , "CheckPrsForBaseBranch" , err )
return
}
} else {
if ! isPlainRule {
if ctx . Repo . GitRepo == nil {
ctx . Repo . GitRepo , err = git . OpenRepository ( ctx , ctx . Repo . Repository . RepoPath ( ) )
if err != nil {
ctx . Error ( http . StatusInternalServerError , "OpenRepository" , err )
return
}
defer func ( ) {
ctx . Repo . GitRepo . Close ( )
ctx . Repo . GitRepo = nil
} ( )
}
// FIXME: since we only need to recheck files protected rules, we could improve this
matchedBranches , err := git_model . FindAllMatchedBranches ( ctx , ctx . Repo . GitRepo , protectBranch . RuleName )
if err != nil {
ctx . Error ( http . StatusInternalServerError , "FindAllMatchedBranches" , err )
return
}
for _ , branchName := range matchedBranches {
if err = pull_service . CheckPRsForBaseBranch ( ctx . Repo . Repository , branchName ) ; err != nil {
ctx . Error ( http . StatusInternalServerError , "CheckPrsForBaseBranch" , err )
return
}
}
}
2020-10-14 02:50:57 +08:00
}
2020-02-13 00:19:35 +01:00
// Reload from db to ensure get all whitelists
2023-01-16 16:00:22 +08:00
bp , err := git_model . GetProtectedBranchRuleByName ( ctx , repo . ID , bpName )
2020-02-13 00:19:35 +01:00
if err != nil {
ctx . Error ( http . StatusInternalServerError , "GetProtectedBranchBy" , err )
return
}
if bp == nil || bp . RepoID != ctx . Repo . Repository . ID {
ctx . Error ( http . StatusInternalServerError , "New branch protection not found" , err )
return
}
ctx . JSON ( http . StatusOK , convert . ToBranchProtection ( bp ) )
}
// DeleteBranchProtection deletes a branch protection for a repo
func DeleteBranchProtection ( ctx * context . APIContext ) {
// swagger:operation DELETE /repos/{owner}/{repo}/branch_protections/{name} repository repoDeleteBranchProtection
// ---
// summary: Delete a specific branch protection for the repository
// 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: name
// in: path
// description: name of protected branch
// type: string
// required: true
// responses:
// "204":
// "$ref": "#/responses/empty"
// "404":
// "$ref": "#/responses/notFound"
repo := ctx . Repo . Repository
bpName := ctx . Params ( ":name" )
2023-01-16 16:00:22 +08:00
bp , err := git_model . GetProtectedBranchRuleByName ( ctx , repo . ID , bpName )
2020-02-13 00:19:35 +01:00
if err != nil {
ctx . Error ( http . StatusInternalServerError , "GetProtectedBranchByID" , err )
return
}
if bp == nil || bp . RepoID != repo . ID {
ctx . NotFound ( )
return
}
2023-01-09 11:50:54 +08:00
if err := git_model . DeleteProtectedBranch ( ctx , ctx . Repo . Repository . ID , bp . ID ) ; err != nil {
2020-02-13 00:19:35 +01:00
ctx . Error ( http . StatusInternalServerError , "DeleteProtectedBranch" , err )
return
}
ctx . Status ( http . StatusNoContent )
}
