2014-08-26 15:41:15 +05:30
// Copyright 2014 The Gogs Authors. All rights reserved.
2018-11-28 16:56:14 +05:30
// Copyright 2018 The Gitea Authors. All rights reserved.
2014-08-26 15:41:15 +05:30
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.
2015-12-05 03:46:42 +05:30
package repo
2014-08-26 15:41:15 +05:30
import (
2017-08-17 07:01:34 +05:30
"fmt"
2017-10-27 02:46:13 +05:30
"net/http"
2017-02-11 09:30:01 +05:30
"strings"
2021-01-03 05:17:47 +05:30
"time"
2014-08-26 15:41:15 +05:30
2016-11-10 21:54:48 +05:30
"code.gitea.io/gitea/models"
2021-11-24 15:19:20 +05:30
"code.gitea.io/gitea/models/db"
2021-11-10 01:27:58 +05:30
unit_model "code.gitea.io/gitea/models/unit"
2021-11-24 15:19:20 +05:30
user_model "code.gitea.io/gitea/models/user"
2016-11-10 21:54:48 +05:30
"code.gitea.io/gitea/modules/context"
2020-12-03 03:08:30 +05:30
"code.gitea.io/gitea/modules/convert"
2019-11-17 12:00:01 +05:30
"code.gitea.io/gitea/modules/git"
2016-11-10 21:54:48 +05:30
"code.gitea.io/gitea/modules/log"
"code.gitea.io/gitea/modules/setting"
2019-08-23 22:10:30 +05:30
api "code.gitea.io/gitea/modules/structs"
2017-10-27 02:46:13 +05:30
"code.gitea.io/gitea/modules/util"
2019-10-02 15:00:41 +05:30
"code.gitea.io/gitea/modules/validation"
2021-01-26 21:06:53 +05:30
"code.gitea.io/gitea/modules/web"
2020-01-25 00:30:29 +05:30
"code.gitea.io/gitea/routers/api/v1/utils"
2019-10-26 12:24:11 +05:30
repo_service "code.gitea.io/gitea/services/repository"
2014-08-26 15:41:15 +05:30
)
2021-11-24 15:19:20 +05:30
var searchOrderByMap = map [ string ] map [ string ] db . SearchOrderBy {
2018-08-02 13:40:02 +05:30
"asc" : {
2021-11-24 15:19:20 +05:30
"alpha" : db . SearchOrderByAlphabetically ,
"created" : db . SearchOrderByOldest ,
"updated" : db . SearchOrderByLeastUpdated ,
"size" : db . SearchOrderBySize ,
"id" : db . SearchOrderByID ,
2018-08-02 13:40:02 +05:30
} ,
"desc" : {
2021-11-24 15:19:20 +05:30
"alpha" : db . SearchOrderByAlphabeticallyReverse ,
"created" : db . SearchOrderByNewest ,
"updated" : db . SearchOrderByRecentUpdated ,
"size" : db . SearchOrderBySizeReverse ,
"id" : db . SearchOrderByIDReverse ,
2018-08-02 13:40:02 +05:30
} ,
}
2016-11-24 12:34:31 +05:30
// Search repositories via options
2016-03-14 04:19:16 +05:30
func Search ( ctx * context . APIContext ) {
2017-11-13 12:32:25 +05:30
// swagger:operation GET /repos/search repository repoSearch
// ---
// summary: Search for repositories
// produces:
// - application/json
// parameters:
// - name: q
// in: query
// description: keyword
// type: string
2019-08-24 08:47:10 +05:30
// - name: topic
// in: query
// description: Limit search to repositories with keyword as topic
// type: boolean
2019-08-25 22:36:36 +05:30
// - name: includeDesc
// in: query
// description: include search of keyword within repository description
// type: boolean
2017-11-13 12:32:25 +05:30
// - name: uid
// in: query
2017-11-15 13:40:26 +05:30
// description: search only for repos that the user with the given id owns or contributes to
// type: integer
2018-10-21 09:10:42 +05:30
// format: int64
2019-11-11 20:45:29 +05:30
// - name: priority_owner_id
// in: query
// description: repo owner to prioritize in the results
// type: integer
// format: int64
2020-12-28 01:28:03 +05:30
// - name: team_id
// in: query
// description: search only for repos that belong to the given team id
// type: integer
// format: int64
2019-05-15 20:54:39 +05:30
// - name: starredBy
// in: query
// description: search only for repos that the user with the given id has starred
// type: integer
// format: int64
// - name: private
// in: query
// description: include private repositories this user has access to (defaults to true)
// type: boolean
2020-05-21 06:45:30 +05:30
// - name: is_private
2020-05-17 01:37:01 +05:30
// in: query
2020-05-21 06:45:30 +05:30
// description: show only pubic, private or all repositories (defaults to all)
2020-05-17 01:37:01 +05:30
// type: boolean
2019-11-11 20:45:29 +05:30
// - name: template
// in: query
// description: include template repositories this user has access to (defaults to true)
// type: boolean
2020-05-17 01:37:01 +05:30
// - name: archived
// in: query
// description: show only archived, non-archived or all repositories (defaults to all)
// type: boolean
2017-11-13 12:32:25 +05:30
// - name: mode
// in: query
// description: type of repository to search for. Supported values are
// "fork", "source", "mirror" and "collaborative"
// type: string
// - name: exclusive
// in: query
2017-11-15 13:40:26 +05:30
// description: if `uid` is given, search only for repos that the user owns
2017-11-13 12:32:25 +05:30
// type: boolean
2018-08-02 13:40:02 +05:30
// - name: sort
// in: query
// description: sort repos by attribute. Supported values are
// "alpha", "created", "updated", "size", and "id".
// Default is "alpha"
// type: string
// - name: order
// in: query
// description: sort order, either "asc" (ascending) or "desc" (descending).
// Default is "asc", ignored if "sort" is not specified.
// type: string
2020-01-25 00:30:29 +05:30
// - name: page
// in: query
// description: page number of results to return (1-based)
// type: integer
// - name: limit
// in: query
2020-06-09 10:27:38 +05:30
// description: page size of results
2020-01-25 00:30:29 +05:30
// type: integer
2017-11-13 12:32:25 +05:30
// responses:
// "200":
// "$ref": "#/responses/SearchResults"
// "422":
// "$ref": "#/responses/validationError"
2019-12-20 22:37:12 +05:30
2016-03-12 02:03:12 +05:30
opts := & models . SearchRepoOptions {
2020-01-25 00:30:29 +05:30
ListOptions : utils . GetListOptions ( ctx ) ,
2020-01-13 23:03:46 +05:30
Actor : ctx . User ,
2021-08-11 20:38:52 +05:30
Keyword : ctx . FormTrim ( "q" ) ,
2021-07-29 07:12:15 +05:30
OwnerID : ctx . FormInt64 ( "uid" ) ,
PriorityOwnerID : ctx . FormInt64 ( "priority_owner_id" ) ,
TeamID : ctx . FormInt64 ( "team_id" ) ,
TopicOnly : ctx . FormBool ( "topic" ) ,
2019-08-25 22:36:36 +05:30
Collaborate : util . OptionalBoolNone ,
2021-08-11 06:01:13 +05:30
Private : ctx . IsSigned && ( ctx . FormString ( "private" ) == "" || ctx . FormBool ( "private" ) ) ,
2019-11-11 20:45:29 +05:30
Template : util . OptionalBoolNone ,
2021-07-29 07:12:15 +05:30
StarredByID : ctx . FormInt64 ( "starredBy" ) ,
IncludeDescription : ctx . FormBool ( "includeDesc" ) ,
2017-10-27 02:46:13 +05:30
}
2021-08-11 06:01:13 +05:30
if ctx . FormString ( "template" ) != "" {
2021-07-29 07:12:15 +05:30
opts . Template = util . OptionalBoolOf ( ctx . FormBool ( "template" ) )
2019-11-11 20:45:29 +05:30
}
2021-07-29 07:12:15 +05:30
if ctx . FormBool ( "exclusive" ) {
2017-10-27 02:46:13 +05:30
opts . Collaborate = util . OptionalBoolFalse
}
2021-08-11 06:01:13 +05:30
var mode = ctx . FormString ( "mode" )
2017-10-27 02:46:13 +05:30
switch mode {
case "source" :
opts . Fork = util . OptionalBoolFalse
opts . Mirror = util . OptionalBoolFalse
case "fork" :
opts . Fork = util . OptionalBoolTrue
case "mirror" :
opts . Mirror = util . OptionalBoolTrue
case "collaborative" :
opts . Mirror = util . OptionalBoolFalse
opts . Collaborate = util . OptionalBoolTrue
case "" :
default :
ctx . Error ( http . StatusUnprocessableEntity , "" , fmt . Errorf ( "Invalid search mode: \"%s\"" , mode ) )
return
2014-08-26 15:41:15 +05:30
}
2021-08-11 06:01:13 +05:30
if ctx . FormString ( "archived" ) != "" {
2021-07-29 07:12:15 +05:30
opts . Archived = util . OptionalBoolOf ( ctx . FormBool ( "archived" ) )
2020-05-17 01:37:01 +05:30
}
2021-08-11 06:01:13 +05:30
if ctx . FormString ( "is_private" ) != "" {
2021-07-29 07:12:15 +05:30
opts . IsPrivate = util . OptionalBoolOf ( ctx . FormBool ( "is_private" ) )
2020-05-21 06:45:30 +05:30
}
2021-08-11 06:01:13 +05:30
var sortMode = ctx . FormString ( "sort" )
2018-08-02 13:40:02 +05:30
if len ( sortMode ) > 0 {
2021-08-11 06:01:13 +05:30
var sortOrder = ctx . FormString ( "order" )
2018-08-02 13:40:02 +05:30
if len ( sortOrder ) == 0 {
sortOrder = "asc"
}
if searchModeMap , ok := searchOrderByMap [ sortOrder ] ; ok {
if orderBy , ok := searchModeMap [ sortMode ] ; ok {
opts . OrderBy = orderBy
} else {
ctx . Error ( http . StatusUnprocessableEntity , "" , fmt . Errorf ( "Invalid sort mode: \"%s\"" , sortMode ) )
return
}
} else {
ctx . Error ( http . StatusUnprocessableEntity , "" , fmt . Errorf ( "Invalid sort order: \"%s\"" , sortOrder ) )
return
}
}
2017-10-27 02:46:13 +05:30
var err error
2019-08-25 22:36:36 +05:30
repos , count , err := models . SearchRepository ( opts )
2014-08-26 15:41:15 +05:30
if err != nil {
2019-12-20 22:37:12 +05:30
ctx . JSON ( http . StatusInternalServerError , api . SearchError {
2017-05-02 19:05:59 +05:30
OK : false ,
Error : err . Error ( ) ,
2014-08-26 15:41:15 +05:30
} )
return
}
2014-11-15 03:41:30 +05:30
results := make ( [ ] * api . Repository , len ( repos ) )
2017-02-10 07:00:26 +05:30
for i , repo := range repos {
if err = repo . GetOwner ( ) ; err != nil {
2019-12-20 22:37:12 +05:30
ctx . JSON ( http . StatusInternalServerError , api . SearchError {
2017-05-02 19:05:59 +05:30
OK : false ,
Error : err . Error ( ) ,
2014-08-26 15:41:15 +05:30
} )
return
}
2018-11-28 16:56:14 +05:30
accessMode , err := models . AccessLevel ( ctx . User , repo )
2017-02-10 07:00:26 +05:30
if err != nil {
2019-12-20 22:37:12 +05:30
ctx . JSON ( http . StatusInternalServerError , api . SearchError {
2017-05-02 19:05:59 +05:30
OK : false ,
Error : err . Error ( ) ,
2017-02-10 07:00:26 +05:30
} )
2014-08-26 15:41:15 +05:30
}
2020-12-03 03:08:30 +05:30
results [ i ] = convert . ToRepo ( repo , accessMode )
2014-08-26 15:41:15 +05:30
}
2020-01-25 00:30:29 +05:30
ctx . SetLinkHeader ( int ( count ) , opts . PageSize )
2021-08-12 18:13:08 +05:30
ctx . SetTotalCountHeader ( count )
2019-12-20 22:37:12 +05:30
ctx . JSON ( http . StatusOK , api . SearchResults {
2017-05-02 19:05:59 +05:30
OK : true ,
Data : results ,
2014-08-26 15:41:15 +05:30
} )
}
2014-08-29 08:54:37 +05:30
2016-11-24 12:34:31 +05:30
// CreateUserRepo create a repository for a user
2021-11-24 15:19:20 +05:30
func CreateUserRepo ( ctx * context . APIContext , owner * user_model . User , opt api . CreateRepoOption ) {
2019-02-22 03:37:58 +05:30
if opt . AutoInit && opt . Readme == "" {
opt . Readme = "Default"
}
2019-10-26 12:24:11 +05:30
repo , err := repo_service . CreateRepository ( ctx . User , owner , models . CreateRepoOptions {
2020-03-27 00:44:51 +05:30
Name : opt . Name ,
Description : opt . Description ,
IssueLabels : opt . IssueLabels ,
Gitignores : opt . Gitignores ,
License : opt . License ,
Readme : opt . Readme ,
IsPrivate : opt . Private ,
AutoInit : opt . AutoInit ,
DefaultBranch : opt . DefaultBranch ,
2020-09-19 22:14:55 +05:30
TrustModel : models . ToTrustModel ( opt . TrustModel ) ,
2020-09-25 10:48:37 +05:30
IsTemplate : opt . Template ,
2015-08-28 16:03:09 +05:30
} )
2014-12-13 07:00:32 +05:30
if err != nil {
2019-03-15 19:49:09 +05:30
if models . IsErrRepoAlreadyExist ( err ) {
2019-12-20 22:37:12 +05:30
ctx . Error ( http . StatusConflict , "" , "The repository with the same name already exists." )
2021-11-24 15:19:20 +05:30
} else if db . IsErrNameReserved ( err ) ||
db . IsErrNamePatternNotAllowed ( err ) {
2019-12-20 22:37:12 +05:30
ctx . Error ( http . StatusUnprocessableEntity , "" , err )
2014-12-13 07:00:32 +05:30
} else {
2019-12-20 22:37:12 +05:30
ctx . Error ( http . StatusInternalServerError , "CreateRepository" , err )
2014-12-13 07:00:32 +05:30
}
return
}
2020-09-16 04:12:19 +05:30
// reload repo from db to get a real state after creation
repo , err = models . GetRepositoryByID ( repo . ID )
if err != nil {
ctx . Error ( http . StatusInternalServerError , "GetRepositoryByID" , err )
}
2020-12-03 03:08:30 +05:30
ctx . JSON ( http . StatusCreated , convert . ToRepo ( repo , models . AccessModeOwner ) )
2014-12-13 07:00:32 +05:30
}
2016-10-07 22:47:27 +05:30
// Create one repository of mine
2021-01-26 21:06:53 +05:30
func Create ( ctx * context . APIContext ) {
2017-11-13 12:32:25 +05:30
// swagger:operation POST /user/repos repository user createCurrentUserRepo
// ---
// summary: Create a repository
// consumes:
// - application/json
// produces:
// - application/json
// parameters:
// - name: body
// in: body
// schema:
// "$ref": "#/definitions/CreateRepoOption"
// responses:
// "201":
// "$ref": "#/responses/Repository"
2019-05-30 20:39:05 +05:30
// "409":
// description: The repository with the same name already exists.
// "422":
// "$ref": "#/responses/validationError"
2021-01-26 21:06:53 +05:30
opt := web . GetForm ( ctx ) . ( * api . CreateRepoOption )
2014-12-13 07:00:32 +05:30
if ctx . User . IsOrganization ( ) {
2017-11-13 12:32:25 +05:30
// Shouldn't reach this condition, but just in case.
2019-12-20 22:37:12 +05:30
ctx . Error ( http . StatusUnprocessableEntity , "" , "not allowed creating repository for organization" )
2014-12-13 07:00:32 +05:30
return
}
2021-01-26 21:06:53 +05:30
CreateUserRepo ( ctx , ctx . User , * opt )
2014-12-13 07:00:32 +05:30
}
2021-07-05 20:59:08 +05:30
// Generate Create a repository using a template
func Generate ( ctx * context . APIContext ) {
// swagger:operation POST /repos/{template_owner}/{template_repo}/generate repository generateRepo
// ---
// summary: Create a repository using a template
// consumes:
// - application/json
// produces:
// - application/json
// parameters:
// - name: template_owner
// in: path
// description: name of the template repository owner
// type: string
// required: true
// - name: template_repo
// in: path
// description: name of the template repository
// type: string
// required: true
// - name: body
// in: body
// schema:
// "$ref": "#/definitions/GenerateRepoOption"
// responses:
// "201":
// "$ref": "#/responses/Repository"
// "403":
// "$ref": "#/responses/forbidden"
// "404":
// "$ref": "#/responses/notFound"
// "409":
// description: The repository with the same name already exists.
// "422":
// "$ref": "#/responses/validationError"
form := web . GetForm ( ctx ) . ( * api . GenerateRepoOption )
if ! ctx . Repo . Repository . IsTemplate {
ctx . Error ( http . StatusUnprocessableEntity , "" , "this is not a template repo" )
return
}
if ctx . User . IsOrganization ( ) {
ctx . Error ( http . StatusUnprocessableEntity , "" , "not allowed creating repository for organization" )
return
}
opts := models . GenerateRepoOptions {
Name : form . Name ,
Description : form . Description ,
Private : form . Private ,
GitContent : form . GitContent ,
Topics : form . Topics ,
GitHooks : form . GitHooks ,
Webhooks : form . Webhooks ,
Avatar : form . Avatar ,
IssueLabels : form . Labels ,
}
if ! opts . IsValid ( ) {
ctx . Error ( http . StatusUnprocessableEntity , "" , "must select at least one template item" )
return
}
ctxUser := ctx . User
var err error
if form . Owner != ctxUser . Name {
2021-11-24 15:19:20 +05:30
ctxUser , err = user_model . GetUserByName ( form . Owner )
2021-07-05 20:59:08 +05:30
if err != nil {
2021-11-24 15:19:20 +05:30
if user_model . IsErrUserNotExist ( err ) {
2021-07-05 20:59:08 +05:30
ctx . JSON ( http . StatusNotFound , map [ string ] interface { } {
2021-07-15 23:49:39 +05:30
"error" : "request owner `" + form . Owner + "` does not exist" ,
2021-07-05 20:59:08 +05:30
} )
return
}
2021-07-15 23:49:39 +05:30
ctx . Error ( http . StatusInternalServerError , "GetUserByName" , err )
return
}
if ! ctx . User . IsAdmin && ! ctxUser . IsOrganization ( ) {
ctx . Error ( http . StatusForbidden , "" , "Only admin can generate repository for other user." )
2021-07-05 20:59:08 +05:30
return
}
if ! ctx . User . IsAdmin {
2021-11-19 17:11:40 +05:30
canCreate , err := models . OrgFromUser ( ctxUser ) . CanCreateOrgRepo ( ctx . User . ID )
2021-07-05 20:59:08 +05:30
if err != nil {
ctx . ServerError ( "CanCreateOrgRepo" , err )
return
} else if ! canCreate {
ctx . Error ( http . StatusForbidden , "" , "Given user is not allowed to create repository in organization." )
return
}
}
}
repo , err := repo_service . GenerateRepository ( ctx . User , ctxUser , ctx . Repo . Repository , opts )
if err != nil {
if models . IsErrRepoAlreadyExist ( err ) {
ctx . Error ( http . StatusConflict , "" , "The repository with the same name already exists." )
2021-11-24 15:19:20 +05:30
} else if db . IsErrNameReserved ( err ) ||
db . IsErrNamePatternNotAllowed ( err ) {
2021-07-05 20:59:08 +05:30
ctx . Error ( http . StatusUnprocessableEntity , "" , err )
} else {
ctx . Error ( http . StatusInternalServerError , "CreateRepository" , err )
}
return
}
log . Trace ( "Repository generated [%d]: %s/%s" , repo . ID , ctxUser . Name , repo . Name )
ctx . JSON ( http . StatusCreated , convert . ToRepo ( repo , models . AccessModeOwner ) )
}
2020-01-09 22:10:01 +05:30
// CreateOrgRepoDeprecated create one repository of the organization
2021-01-26 21:06:53 +05:30
func CreateOrgRepoDeprecated ( ctx * context . APIContext ) {
2020-01-09 22:10:01 +05:30
// swagger:operation POST /org/{org}/repos organization createOrgRepoDeprecated
2017-11-13 12:32:25 +05:30
// ---
// summary: Create a repository in an organization
2020-01-09 22:10:01 +05:30
// deprecated: true
2017-11-13 12:32:25 +05:30
// consumes:
// - application/json
// produces:
// - application/json
// parameters:
// - name: org
// in: path
// description: name of organization
// type: string
// required: true
// - name: body
// in: body
// schema:
// "$ref": "#/definitions/CreateRepoOption"
// responses:
// "201":
// "$ref": "#/responses/Repository"
// "422":
// "$ref": "#/responses/validationError"
// "403":
// "$ref": "#/responses/forbidden"
2019-12-20 22:37:12 +05:30
2021-01-26 21:06:53 +05:30
CreateOrgRepo ( ctx )
2020-01-09 22:10:01 +05:30
}
// CreateOrgRepo create one repository of the organization
2021-01-26 21:06:53 +05:30
func CreateOrgRepo ( ctx * context . APIContext ) {
2020-01-09 22:10:01 +05:30
// swagger:operation POST /orgs/{org}/repos organization createOrgRepo
// ---
// summary: Create a repository in an organization
// consumes:
// - application/json
// produces:
// - application/json
// parameters:
// - name: org
// in: path
// description: name of organization
// type: string
// required: true
// - name: body
// in: body
// schema:
// "$ref": "#/definitions/CreateRepoOption"
// responses:
// "201":
// "$ref": "#/responses/Repository"
// "404":
// "$ref": "#/responses/notFound"
// "403":
// "$ref": "#/responses/forbidden"
2021-01-26 21:06:53 +05:30
opt := web . GetForm ( ctx ) . ( * api . CreateRepoOption )
2014-12-13 07:00:32 +05:30
org , err := models . GetOrgByName ( ctx . Params ( ":org" ) )
if err != nil {
2017-07-06 19:00:19 +05:30
if models . IsErrOrgNotExist ( err ) {
2019-12-20 22:37:12 +05:30
ctx . Error ( http . StatusUnprocessableEntity , "" , err )
2014-12-13 07:00:32 +05:30
} else {
2019-12-20 22:37:12 +05:30
ctx . Error ( http . StatusInternalServerError , "GetOrgByName" , err )
2014-12-13 07:00:32 +05:30
}
return
}
2021-11-19 17:11:40 +05:30
if ! models . HasOrgOrUserVisible ( org . AsUser ( ) , ctx . User ) {
2021-06-27 01:23:14 +05:30
ctx . NotFound ( "HasOrgOrUserVisible" , nil )
2019-02-18 21:30:27 +05:30
return
}
2018-07-05 05:21:02 +05:30
if ! ctx . User . IsAdmin {
2019-11-20 16:57:49 +05:30
canCreate , err := org . CanCreateOrgRepo ( ctx . User . ID )
2018-07-05 05:21:02 +05:30
if err != nil {
2020-09-21 01:50:14 +05:30
ctx . Error ( http . StatusInternalServerError , "CanCreateOrgRepo" , err )
2018-07-05 05:21:02 +05:30
return
2019-11-20 16:57:49 +05:30
} else if ! canCreate {
2019-12-20 22:37:12 +05:30
ctx . Error ( http . StatusForbidden , "" , "Given user is not allowed to create repository in organization." )
2018-07-05 05:21:02 +05:30
return
}
2014-12-13 07:00:32 +05:30
}
2021-11-19 17:11:40 +05:30
CreateUserRepo ( ctx , org . AsUser ( ) , * opt )
2014-12-13 07:00:32 +05:30
}
2016-10-07 22:47:27 +05:30
// Get one repository
2016-03-14 04:19:16 +05:30
func Get ( ctx * context . APIContext ) {
2017-11-13 12:32:25 +05:30
// swagger:operation GET /repos/{owner}/{repo} repository repoGet
// ---
// summary: Get 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/Repository"
2019-12-20 22:37:12 +05:30
2020-12-03 03:08:30 +05:30
ctx . JSON ( http . StatusOK , convert . ToRepo ( ctx . Repo . Repository , ctx . Repo . AccessMode ) )
2015-10-23 03:16:07 +05:30
}
2016-10-03 16:05:42 +05:30
// GetByID returns a single Repository
func GetByID ( ctx * context . APIContext ) {
2017-11-13 12:32:25 +05:30
// swagger:operation GET /repositories/{id} repository repoGetByID
// ---
// summary: Get a repository by id
// produces:
// - application/json
// parameters:
// - name: id
// in: path
// description: id of the repo to get
// type: integer
2018-10-21 09:10:42 +05:30
// format: int64
2017-11-13 12:32:25 +05:30
// required: true
// responses:
// "200":
// "$ref": "#/responses/Repository"
2019-12-20 22:37:12 +05:30
2016-10-03 16:05:42 +05:30
repo , err := models . GetRepositoryByID ( ctx . ParamsInt64 ( ":id" ) )
if err != nil {
if models . IsErrRepoNotExist ( err ) {
2019-03-19 07:59:43 +05:30
ctx . NotFound ( )
2016-10-03 16:05:42 +05:30
} else {
2019-12-20 22:37:12 +05:30
ctx . Error ( http . StatusInternalServerError , "GetRepositoryByID" , err )
2016-10-03 16:05:42 +05:30
}
return
}
2018-11-28 16:56:14 +05:30
perm , err := models . GetUserRepoPermission ( repo , ctx . User )
2016-12-06 05:18:51 +05:30
if err != nil {
2019-12-20 22:37:12 +05:30
ctx . Error ( http . StatusInternalServerError , "AccessLevel" , err )
2017-07-30 06:43:33 +05:30
return
2018-11-28 16:56:14 +05:30
} else if ! perm . HasAccess ( ) {
2019-03-19 07:59:43 +05:30
ctx . NotFound ( )
2016-12-06 05:18:51 +05:30
return
}
2020-12-03 03:08:30 +05:30
ctx . JSON ( http . StatusOK , convert . ToRepo ( repo , perm . AccessMode ) )
2016-10-03 16:05:42 +05:30
}
2019-05-30 20:39:05 +05:30
// Edit edit repository properties
2021-01-26 21:06:53 +05:30
func Edit ( ctx * context . APIContext ) {
2019-05-30 20:39:05 +05:30
// swagger:operation PATCH /repos/{owner}/{repo} repository repoEdit
// ---
// summary: Edit a repository's properties. Only fields that are set will be changed.
// produces:
// - application/json
// parameters:
// - name: owner
// in: path
// description: owner of the repo to edit
// type: string
// required: true
// - name: repo
// in: path
// description: name of the repo to edit
// type: string
// required: true
// required: true
// - name: body
// in: body
// description: "Properties of a repo that you can edit"
// schema:
// "$ref": "#/definitions/EditRepoOption"
// responses:
// "200":
// "$ref": "#/responses/Repository"
// "403":
// "$ref": "#/responses/forbidden"
// "422":
// "$ref": "#/responses/validationError"
2019-12-20 22:37:12 +05:30
2021-01-26 21:06:53 +05:30
opts := * web . GetForm ( ctx ) . ( * api . EditRepoOption )
2019-05-30 20:39:05 +05:30
if err := updateBasicProperties ( ctx , opts ) ; err != nil {
return
}
if err := updateRepoUnits ( ctx , opts ) ; err != nil {
return
}
if opts . Archived != nil {
if err := updateRepoArchivedState ( ctx , opts ) ; err != nil {
return
}
}
2021-01-03 05:17:47 +05:30
if opts . MirrorInterval != nil {
if err := updateMirrorInterval ( ctx , opts ) ; err != nil {
return
}
}
2021-07-14 01:01:59 +05:30
repo , err := models . GetRepositoryByID ( ctx . Repo . Repository . ID )
if err != nil {
ctx . InternalServerError ( err )
return
}
ctx . JSON ( http . StatusOK , convert . ToRepo ( repo , ctx . Repo . AccessMode ) )
2019-05-30 20:39:05 +05:30
}
// updateBasicProperties updates the basic properties of a repo: Name, Description, Website and Visibility
func updateBasicProperties ( ctx * context . APIContext , opts api . EditRepoOption ) error {
owner := ctx . Repo . Owner
repo := ctx . Repo . Repository
newRepoName := repo . Name
if opts . Name != nil {
newRepoName = * opts . Name
}
// Check if repository name has been changed and not just a case change
if repo . LowerName != strings . ToLower ( newRepoName ) {
2019-11-15 13:36:11 +05:30
if err := repo_service . ChangeRepositoryName ( ctx . User , repo , newRepoName ) ; err != nil {
2019-05-30 20:39:05 +05:30
switch {
case models . IsErrRepoAlreadyExist ( err ) :
ctx . Error ( http . StatusUnprocessableEntity , fmt . Sprintf ( "repo name is already taken [name: %s]" , newRepoName ) , err )
2021-11-24 15:19:20 +05:30
case db . IsErrNameReserved ( err ) :
2019-05-30 20:39:05 +05:30
ctx . Error ( http . StatusUnprocessableEntity , fmt . Sprintf ( "repo name is reserved [name: %s]" , newRepoName ) , err )
2021-11-24 15:19:20 +05:30
case db . IsErrNamePatternNotAllowed ( err ) :
ctx . Error ( http . StatusUnprocessableEntity , fmt . Sprintf ( "repo name's pattern is not allowed [name: %s, pattern: %s]" , newRepoName , err . ( db . ErrNamePatternNotAllowed ) . Pattern ) , err )
2019-05-30 20:39:05 +05:30
default :
ctx . Error ( http . StatusUnprocessableEntity , "ChangeRepositoryName" , err )
}
return err
}
log . Trace ( "Repository name changed: %s/%s -> %s" , ctx . Repo . Owner . Name , repo . Name , newRepoName )
}
// Update the name in the repo object for the response
repo . Name = newRepoName
repo . LowerName = strings . ToLower ( newRepoName )
if opts . Description != nil {
repo . Description = * opts . Description
}
if opts . Website != nil {
repo . Website = * opts . Website
}
visibilityChanged := false
if opts . Private != nil {
// Visibility of forked repository is forced sync with base repository.
if repo . IsFork {
2021-03-11 23:39:52 +05:30
if err := repo . GetBaseRepo ( ) ; err != nil {
ctx . Error ( http . StatusInternalServerError , "Unable to load base repository" , err )
return err
}
2019-05-30 20:39:05 +05:30
* opts . Private = repo . BaseRepo . IsPrivate
}
visibilityChanged = repo . IsPrivate != * opts . Private
// when ForcePrivate enabled, you could change public repo to private, but only admin users can change private to public
if visibilityChanged && setting . Repository . ForcePrivate && ! * opts . Private && ! ctx . User . IsAdmin {
err := fmt . Errorf ( "cannot change private repository to public" )
ctx . Error ( http . StatusUnprocessableEntity , "Force Private enabled" , err )
return err
}
repo . IsPrivate = * opts . Private
}
2019-11-11 20:45:29 +05:30
if opts . Template != nil {
repo . IsTemplate = * opts . Template
}
2021-05-08 17:41:36 +05:30
if ctx . Repo . GitRepo == nil && ! repo . IsEmpty {
2021-02-12 01:23:41 +05:30
var err error
ctx . Repo . GitRepo , err = git . OpenRepository ( ctx . Repo . Repository . RepoPath ( ) )
if err != nil {
ctx . Error ( http . StatusInternalServerError , "Unable to OpenRepository" , err )
return err
}
defer ctx . Repo . GitRepo . Close ( )
}
// Default branch only updated if changed and exist or the repository is empty
2021-05-08 17:41:36 +05:30
if opts . DefaultBranch != nil && repo . DefaultBranch != * opts . DefaultBranch && ( repo . IsEmpty || ctx . Repo . GitRepo . IsBranchExist ( * opts . DefaultBranch ) ) {
if ! repo . IsEmpty {
if err := ctx . Repo . GitRepo . SetDefaultBranch ( * opts . DefaultBranch ) ; err != nil {
if ! git . IsErrUnsupportedVersion ( err ) {
ctx . Error ( http . StatusInternalServerError , "SetDefaultBranch" , err )
return err
}
2019-11-17 12:00:01 +05:30
}
}
repo . DefaultBranch = * opts . DefaultBranch
}
2019-05-30 20:39:05 +05:30
if err := models . UpdateRepository ( repo , visibilityChanged ) ; err != nil {
ctx . Error ( http . StatusInternalServerError , "UpdateRepository" , err )
return err
}
log . Trace ( "Repository basic settings updated: %s/%s" , owner . Name , repo . Name )
return nil
}
// updateRepoUnits updates repo units: Issue settings, Wiki settings, PR settings
func updateRepoUnits ( ctx * context . APIContext , opts api . EditRepoOption ) error {
owner := ctx . Repo . Owner
repo := ctx . Repo . Repository
var units [ ] models . RepoUnit
2021-11-10 01:27:58 +05:30
var deleteUnitTypes [ ] unit_model . Type
2019-05-30 20:39:05 +05:30
2020-01-17 13:04:37 +05:30
if opts . HasIssues != nil {
2021-11-10 01:27:58 +05:30
if * opts . HasIssues && opts . ExternalTracker != nil && ! unit_model . TypeExternalTracker . UnitGlobalDisabled ( ) {
2019-10-02 15:00:41 +05:30
// Check that values are valid
if ! validation . IsValidExternalURL ( opts . ExternalTracker . ExternalTrackerURL ) {
err := fmt . Errorf ( "External tracker URL not valid" )
ctx . Error ( http . StatusUnprocessableEntity , "Invalid external tracker URL" , err )
return err
}
if len ( opts . ExternalTracker . ExternalTrackerFormat ) != 0 && ! validation . IsValidExternalTrackerURLFormat ( opts . ExternalTracker . ExternalTrackerFormat ) {
err := fmt . Errorf ( "External tracker URL format not valid" )
ctx . Error ( http . StatusUnprocessableEntity , "Invalid external tracker URL format" , err )
return err
2019-05-30 20:39:05 +05:30
}
2019-10-02 15:00:41 +05:30
units = append ( units , models . RepoUnit {
RepoID : repo . ID ,
2021-11-10 01:27:58 +05:30
Type : unit_model . TypeExternalTracker ,
2019-10-02 15:00:41 +05:30
Config : & models . ExternalTrackerConfig {
ExternalTrackerURL : opts . ExternalTracker . ExternalTrackerURL ,
ExternalTrackerFormat : opts . ExternalTracker . ExternalTrackerFormat ,
ExternalTrackerStyle : opts . ExternalTracker . ExternalTrackerStyle ,
} ,
} )
2021-11-10 01:27:58 +05:30
deleteUnitTypes = append ( deleteUnitTypes , unit_model . TypeIssues )
} else if * opts . HasIssues && opts . ExternalTracker == nil && ! unit_model . TypeIssues . UnitGlobalDisabled ( ) {
2019-10-02 15:00:41 +05:30
// Default to built-in tracker
var config * models . IssuesConfig
if opts . InternalTracker != nil {
config = & models . IssuesConfig {
EnableTimetracker : opts . InternalTracker . EnableTimeTracker ,
AllowOnlyContributorsToTrackTime : opts . InternalTracker . AllowOnlyContributorsToTrackTime ,
EnableDependencies : opts . InternalTracker . EnableIssueDependencies ,
}
2021-11-10 01:27:58 +05:30
} else if unit , err := repo . GetUnit ( unit_model . TypeIssues ) ; err != nil {
2019-10-02 15:00:41 +05:30
// Unit type doesn't exist so we make a new config file with default values
config = & models . IssuesConfig {
EnableTimetracker : true ,
AllowOnlyContributorsToTrackTime : true ,
EnableDependencies : true ,
}
} else {
config = unit . IssuesConfig ( )
}
units = append ( units , models . RepoUnit {
RepoID : repo . ID ,
2021-11-10 01:27:58 +05:30
Type : unit_model . TypeIssues ,
2019-10-02 15:00:41 +05:30
Config : config ,
} )
2021-11-10 01:27:58 +05:30
deleteUnitTypes = append ( deleteUnitTypes , unit_model . TypeExternalTracker )
2020-01-17 13:04:37 +05:30
} else if ! * opts . HasIssues {
2021-11-10 01:27:58 +05:30
if ! unit_model . TypeExternalTracker . UnitGlobalDisabled ( ) {
deleteUnitTypes = append ( deleteUnitTypes , unit_model . TypeExternalTracker )
2020-01-17 13:04:37 +05:30
}
2021-11-10 01:27:58 +05:30
if ! unit_model . TypeIssues . UnitGlobalDisabled ( ) {
deleteUnitTypes = append ( deleteUnitTypes , unit_model . TypeIssues )
2020-01-17 13:04:37 +05:30
}
2019-05-30 20:39:05 +05:30
}
}
2020-01-17 13:04:37 +05:30
if opts . HasWiki != nil {
2021-11-10 01:27:58 +05:30
if * opts . HasWiki && opts . ExternalWiki != nil && ! unit_model . TypeExternalWiki . UnitGlobalDisabled ( ) {
2019-10-02 15:00:41 +05:30
// Check that values are valid
if ! validation . IsValidExternalURL ( opts . ExternalWiki . ExternalWikiURL ) {
err := fmt . Errorf ( "External wiki URL not valid" )
ctx . Error ( http . StatusUnprocessableEntity , "" , "Invalid external wiki URL" )
return err
}
units = append ( units , models . RepoUnit {
RepoID : repo . ID ,
2021-11-10 01:27:58 +05:30
Type : unit_model . TypeExternalWiki ,
2019-10-02 15:00:41 +05:30
Config : & models . ExternalWikiConfig {
ExternalWikiURL : opts . ExternalWiki . ExternalWikiURL ,
} ,
} )
2021-11-10 01:27:58 +05:30
deleteUnitTypes = append ( deleteUnitTypes , unit_model . TypeWiki )
} else if * opts . HasWiki && opts . ExternalWiki == nil && ! unit_model . TypeWiki . UnitGlobalDisabled ( ) {
2019-10-02 15:00:41 +05:30
config := & models . UnitConfig { }
units = append ( units , models . RepoUnit {
RepoID : repo . ID ,
2021-11-10 01:27:58 +05:30
Type : unit_model . TypeWiki ,
2019-10-02 15:00:41 +05:30
Config : config ,
} )
2021-11-10 01:27:58 +05:30
deleteUnitTypes = append ( deleteUnitTypes , unit_model . TypeExternalWiki )
2020-01-17 13:04:37 +05:30
} else if ! * opts . HasWiki {
2021-11-10 01:27:58 +05:30
if ! unit_model . TypeExternalWiki . UnitGlobalDisabled ( ) {
deleteUnitTypes = append ( deleteUnitTypes , unit_model . TypeExternalWiki )
2020-01-17 13:04:37 +05:30
}
2021-11-10 01:27:58 +05:30
if ! unit_model . TypeWiki . UnitGlobalDisabled ( ) {
deleteUnitTypes = append ( deleteUnitTypes , unit_model . TypeWiki )
2020-01-17 13:04:37 +05:30
}
2019-10-02 15:00:41 +05:30
}
2019-05-30 20:39:05 +05:30
}
2020-01-17 13:04:37 +05:30
if opts . HasPullRequests != nil {
2021-11-10 01:27:58 +05:30
if * opts . HasPullRequests && ! unit_model . TypePullRequests . UnitGlobalDisabled ( ) {
2020-01-17 13:04:37 +05:30
// We do allow setting individual PR settings through the API, so
// we get the config settings and then set them
// if those settings were provided in the opts.
2021-11-10 01:27:58 +05:30
unit , err := repo . GetUnit ( unit_model . TypePullRequests )
2020-01-17 13:04:37 +05:30
var config * models . PullRequestsConfig
if err != nil {
// Unit type doesn't exist so we make a new config file with default values
config = & models . PullRequestsConfig {
2021-07-13 04:56:25 +05:30
IgnoreWhitespaceConflicts : false ,
AllowMerge : true ,
AllowRebase : true ,
AllowRebaseMerge : true ,
AllowSquash : true ,
AllowManualMerge : true ,
AutodetectManualMerge : false ,
DefaultDeleteBranchAfterMerge : false ,
DefaultMergeStyle : models . MergeStyleMerge ,
2020-01-17 13:04:37 +05:30
}
} else {
config = unit . PullRequestsConfig ( )
2019-05-30 20:39:05 +05:30
}
2020-01-17 13:04:37 +05:30
if opts . IgnoreWhitespaceConflicts != nil {
config . IgnoreWhitespaceConflicts = * opts . IgnoreWhitespaceConflicts
}
if opts . AllowMerge != nil {
config . AllowMerge = * opts . AllowMerge
}
if opts . AllowRebase != nil {
config . AllowRebase = * opts . AllowRebase
}
if opts . AllowRebaseMerge != nil {
config . AllowRebaseMerge = * opts . AllowRebaseMerge
}
if opts . AllowSquash != nil {
config . AllowSquash = * opts . AllowSquash
}
2021-03-04 09:11:23 +05:30
if opts . AllowManualMerge != nil {
config . AllowManualMerge = * opts . AllowManualMerge
}
if opts . AutodetectManualMerge != nil {
config . AutodetectManualMerge = * opts . AutodetectManualMerge
}
2021-07-13 04:56:25 +05:30
if opts . DefaultDeleteBranchAfterMerge != nil {
config . DefaultDeleteBranchAfterMerge = * opts . DefaultDeleteBranchAfterMerge
}
2021-03-27 20:25:40 +05:30
if opts . DefaultMergeStyle != nil {
config . DefaultMergeStyle = models . MergeStyle ( * opts . DefaultMergeStyle )
}
2019-08-10 15:02:46 +05:30
2020-01-17 13:04:37 +05:30
units = append ( units , models . RepoUnit {
RepoID : repo . ID ,
2021-11-10 01:27:58 +05:30
Type : unit_model . TypePullRequests ,
2020-01-17 13:04:37 +05:30
Config : config ,
} )
2021-11-10 01:27:58 +05:30
} else if ! * opts . HasPullRequests && ! unit_model . TypePullRequests . UnitGlobalDisabled ( ) {
deleteUnitTypes = append ( deleteUnitTypes , unit_model . TypePullRequests )
2020-01-17 13:04:37 +05:30
}
2019-05-30 20:39:05 +05:30
}
2021-11-10 01:27:58 +05:30
if opts . HasProjects != nil && ! unit_model . TypeProjects . UnitGlobalDisabled ( ) {
2020-08-17 08:37:38 +05:30
if * opts . HasProjects {
units = append ( units , models . RepoUnit {
RepoID : repo . ID ,
2021-11-10 01:27:58 +05:30
Type : unit_model . TypeProjects ,
2020-08-17 08:37:38 +05:30
} )
} else {
2021-11-10 01:27:58 +05:30
deleteUnitTypes = append ( deleteUnitTypes , unit_model . TypeProjects )
2020-08-17 08:37:38 +05:30
}
}
2020-01-17 13:04:37 +05:30
if err := models . UpdateRepositoryUnits ( repo , units , deleteUnitTypes ) ; err != nil {
2019-05-30 20:39:05 +05:30
ctx . Error ( http . StatusInternalServerError , "UpdateRepositoryUnits" , err )
return err
}
log . Trace ( "Repository advanced settings updated: %s/%s" , owner . Name , repo . Name )
return nil
}
// updateRepoArchivedState updates repo's archive state
func updateRepoArchivedState ( ctx * context . APIContext , opts api . EditRepoOption ) error {
repo := ctx . Repo . Repository
// archive / un-archive
if opts . Archived != nil {
if repo . IsMirror {
err := fmt . Errorf ( "repo is a mirror, cannot archive/un-archive" )
ctx . Error ( http . StatusUnprocessableEntity , err . Error ( ) , err )
return err
}
if * opts . Archived {
if err := repo . SetArchiveRepoState ( * opts . Archived ) ; err != nil {
log . Error ( "Tried to archive a repo: %s" , err )
ctx . Error ( http . StatusInternalServerError , "ArchiveRepoState" , err )
return err
}
log . Trace ( "Repository was archived: %s/%s" , ctx . Repo . Owner . Name , repo . Name )
} else {
if err := repo . SetArchiveRepoState ( * opts . Archived ) ; err != nil {
log . Error ( "Tried to un-archive a repo: %s" , err )
ctx . Error ( http . StatusInternalServerError , "ArchiveRepoState" , err )
return err
}
log . Trace ( "Repository was un-archived: %s/%s" , ctx . Repo . Owner . Name , repo . Name )
}
}
return nil
}
2021-01-03 05:17:47 +05:30
// updateMirrorInterval updates the repo's mirror Interval
func updateMirrorInterval ( ctx * context . APIContext , opts api . EditRepoOption ) error {
repo := ctx . Repo . Repository
if opts . MirrorInterval != nil {
if ! repo . IsMirror {
err := fmt . Errorf ( "repo is not a mirror, can not change mirror interval" )
ctx . Error ( http . StatusUnprocessableEntity , err . Error ( ) , err )
return err
}
if err := repo . GetMirror ( ) ; err != nil {
log . Error ( "Failed to get mirror: %s" , err )
ctx . Error ( http . StatusInternalServerError , "MirrorInterval" , err )
return err
}
if interval , err := time . ParseDuration ( * opts . MirrorInterval ) ; err == nil {
repo . Mirror . Interval = interval
if err := models . UpdateMirror ( repo . Mirror ) ; err != nil {
log . Error ( "Failed to Set Mirror Interval: %s" , err )
ctx . Error ( http . StatusUnprocessableEntity , "MirrorInterval" , err )
return err
}
log . Trace ( "Repository %s/%s Mirror Interval was Updated to %s" , ctx . Repo . Owner . Name , repo . Name , interval )
} else {
log . Error ( "Wrong format for MirrorInternal Sent: %s" , err )
ctx . Error ( http . StatusUnprocessableEntity , "MirrorInterval" , err )
return err
}
}
return nil
}
2016-10-07 22:47:27 +05:30
// Delete one repository
2016-03-14 04:19:16 +05:30
func Delete ( ctx * context . APIContext ) {
2017-11-13 12:32:25 +05:30
// swagger:operation DELETE /repos/{owner}/{repo} repository repoDelete
// ---
// summary: Delete a repository
// produces:
// - application/json
// parameters:
// - name: owner
// in: path
// description: owner of the repo to delete
// type: string
// required: true
// - name: repo
// in: path
// description: name of the repo to delete
// type: string
// required: true
// responses:
// "204":
// "$ref": "#/responses/empty"
// "403":
// "$ref": "#/responses/forbidden"
2019-12-20 22:37:12 +05:30
2016-11-15 04:03:58 +05:30
owner := ctx . Repo . Owner
repo := ctx . Repo . Repository
2015-10-04 20:39:16 +05:30
2019-10-26 12:24:11 +05:30
canDelete , err := repo . CanUserDelete ( ctx . User )
if err != nil {
2019-12-20 22:37:12 +05:30
ctx . Error ( http . StatusInternalServerError , "CanUserDelete" , err )
2019-10-26 12:24:11 +05:30
return
} else if ! canDelete {
2019-12-20 22:37:12 +05:30
ctx . Error ( http . StatusForbidden , "" , "Given user is not owner of organization." )
2019-10-26 12:24:11 +05:30
return
2015-10-04 20:39:16 +05:30
}
2021-05-15 01:49:38 +05:30
if ctx . Repo . GitRepo != nil {
ctx . Repo . GitRepo . Close ( )
}
2019-10-26 12:24:11 +05:30
if err := repo_service . DeleteRepository ( ctx . User , repo ) ; err != nil {
2019-12-20 22:37:12 +05:30
ctx . Error ( http . StatusInternalServerError , "DeleteRepository" , err )
2015-10-04 20:39:16 +05:30
return
}
2015-10-23 03:16:07 +05:30
log . Trace ( "Repository deleted: %s/%s" , owner . Name , repo . Name )
2019-12-20 22:37:12 +05:30
ctx . Status ( http . StatusNoContent )
2015-10-04 20:39:16 +05:30
}
2020-09-11 20:18:39 +05:30
// GetIssueTemplates returns the issue templates for a repository
func GetIssueTemplates ( ctx * context . APIContext ) {
// swagger:operation GET /repos/{owner}/{repo}/issue_templates repository repoGetIssueTemplates
// ---
// summary: Get available issue templates 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/IssueTemplates"
ctx . JSON ( http . StatusOK , ctx . IssueTemplatesFromDefaultBranch ( ) )
}