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"
2019-10-14 11:40:42 +05:30
"net/url"
2017-02-11 09:30:01 +05:30
"strings"
2014-08-26 15:41:15 +05:30
2016-11-10 21:54:48 +05:30
"code.gitea.io/gitea/models"
"code.gitea.io/gitea/modules/auth"
"code.gitea.io/gitea/modules/context"
"code.gitea.io/gitea/modules/log"
2019-05-07 06:42:51 +05:30
"code.gitea.io/gitea/modules/migrations"
2019-07-12 14:25:46 +05:30
"code.gitea.io/gitea/modules/notification"
2016-11-10 21:54:48 +05:30
"code.gitea.io/gitea/modules/setting"
2019-10-14 11:40:42 +05:30
"code.gitea.io/gitea/modules/structs"
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"
2016-11-10 21:54:48 +05:30
"code.gitea.io/gitea/routers/api/v1/convert"
2019-10-01 19:10:17 +05:30
mirror_service "code.gitea.io/gitea/services/mirror"
2019-10-26 12:24:11 +05:30
repo_service "code.gitea.io/gitea/services/repository"
2014-08-26 15:41:15 +05:30
)
2018-08-02 13:40:02 +05:30
var searchOrderByMap = map [ string ] map [ string ] models . SearchOrderBy {
"asc" : {
"alpha" : models . SearchOrderByAlphabetically ,
"created" : models . SearchOrderByOldest ,
"updated" : models . SearchOrderByLeastUpdated ,
"size" : models . SearchOrderBySize ,
"id" : models . SearchOrderByID ,
} ,
"desc" : {
"alpha" : models . SearchOrderByAlphabeticallyReverse ,
"created" : models . SearchOrderByNewest ,
"updated" : models . SearchOrderByRecentUpdated ,
"size" : models . SearchOrderBySizeReverse ,
"id" : models . SearchOrderByIDReverse ,
} ,
}
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-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
2017-11-15 13:40:26 +05:30
// - name: page
// in: query
// description: page number of results to return (1-based)
2017-11-13 12:32:25 +05:30
// type: integer
// - name: limit
// in: query
2017-11-15 13:40:26 +05:30
// description: page size of results, maximum page size is 50
2017-11-13 12:32:25 +05:30
// type: integer
// - 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
2017-11-13 12:32:25 +05:30
// responses:
// "200":
// "$ref": "#/responses/SearchResults"
// "422":
// "$ref": "#/responses/validationError"
2016-03-12 02:03:12 +05:30
opts := & models . SearchRepoOptions {
2019-08-25 22:36:36 +05:30
Keyword : strings . Trim ( ctx . Query ( "q" ) , " " ) ,
OwnerID : ctx . QueryInt64 ( "uid" ) ,
Page : ctx . QueryInt ( "page" ) ,
PageSize : convert . ToCorrectPageSize ( ctx . QueryInt ( "limit" ) ) ,
TopicOnly : ctx . QueryBool ( "topic" ) ,
Collaborate : util . OptionalBoolNone ,
Private : ctx . IsSigned && ( ctx . Query ( "private" ) == "" || ctx . QueryBool ( "private" ) ) ,
UserIsAdmin : ctx . IsUserSiteAdmin ( ) ,
UserID : ctx . Data [ "SignedUserID" ] . ( int64 ) ,
StarredByID : ctx . QueryInt64 ( "starredBy" ) ,
IncludeDescription : ctx . QueryBool ( "includeDesc" ) ,
2017-10-27 02:46:13 +05:30
}
if ctx . QueryBool ( "exclusive" ) {
opts . Collaborate = util . OptionalBoolFalse
}
var mode = ctx . Query ( "mode" )
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
}
2018-08-02 13:40:02 +05:30
var sortMode = ctx . Query ( "sort" )
if len ( sortMode ) > 0 {
var sortOrder = ctx . Query ( "order" )
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 {
2017-05-02 19:05:59 +05:30
ctx . JSON ( 500 , api . SearchError {
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 {
2017-05-02 19:05:59 +05:30
ctx . JSON ( 500 , api . SearchError {
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 {
2017-05-02 19:05:59 +05:30
ctx . JSON ( 500 , api . SearchError {
OK : false ,
Error : err . Error ( ) ,
2017-02-10 07:00:26 +05:30
} )
2014-08-26 15:41:15 +05:30
}
2017-02-10 07:00:26 +05:30
results [ i ] = repo . APIFormat ( accessMode )
2014-08-26 15:41:15 +05:30
}
2016-07-04 14:57:06 +05:30
ctx . SetLinkHeader ( int ( count ) , setting . API . MaxResponseItems )
2017-08-17 07:01:34 +05:30
ctx . Header ( ) . Set ( "X-Total-Count" , fmt . Sprintf ( "%d" , count ) )
2017-05-02 19:05:59 +05:30
ctx . JSON ( 200 , api . SearchResults {
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
2016-03-14 04:19:16 +05:30
func CreateUserRepo ( ctx * context . APIContext , owner * models . 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 {
2015-08-28 16:03:09 +05:30
Name : opt . Name ,
Description : opt . Description ,
2019-09-08 13:58:40 +05:30
IssueLabels : opt . IssueLabels ,
2015-08-28 16:36:18 +05:30
Gitignores : opt . Gitignores ,
2015-08-28 16:03:09 +05:30
License : opt . License ,
2015-08-28 16:36:18 +05:30
Readme : opt . Readme ,
IsPrivate : opt . Private ,
AutoInit : opt . AutoInit ,
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 ) {
ctx . Error ( 409 , "" , "The repository with the same name already exists." )
} else if models . IsErrNameReserved ( err ) ||
2015-03-27 02:41:47 +05:30
models . IsErrNamePatternNotAllowed ( err ) {
2016-03-14 04:19:16 +05:30
ctx . Error ( 422 , "" , err )
2014-12-13 07:00:32 +05:30
} else {
2016-03-14 04:19:16 +05:30
ctx . Error ( 500 , "CreateRepository" , err )
2014-12-13 07:00:32 +05:30
}
return
}
2016-12-06 05:18:51 +05:30
ctx . JSON ( 201 , repo . APIFormat ( models . AccessModeOwner ) )
2014-12-13 07:00:32 +05:30
}
2016-10-07 22:47:27 +05:30
// Create one repository of mine
2016-03-14 04:19:16 +05:30
func Create ( ctx * context . APIContext , opt api . CreateRepoOption ) {
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"
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.
2016-03-14 04:19:16 +05:30
ctx . Error ( 422 , "" , "not allowed creating repository for organization" )
2014-12-13 07:00:32 +05:30
return
}
2015-12-18 09:27:41 +05:30
CreateUserRepo ( ctx , ctx . User , opt )
2014-12-13 07:00:32 +05:30
}
2016-11-24 12:34:31 +05:30
// CreateOrgRepo create one repository of the organization
2016-03-14 04:19:16 +05:30
func CreateOrgRepo ( ctx * context . APIContext , opt api . CreateRepoOption ) {
2017-11-13 12:32:25 +05:30
// swagger:operation POST /org/{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"
// "422":
// "$ref": "#/responses/validationError"
// "403":
// "$ref": "#/responses/forbidden"
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 ) {
2016-03-14 04:19:16 +05:30
ctx . Error ( 422 , "" , err )
2014-12-13 07:00:32 +05:30
} else {
2016-03-14 04:19:16 +05:30
ctx . Error ( 500 , "GetOrgByName" , err )
2014-12-13 07:00:32 +05:30
}
return
}
2019-02-18 21:30:27 +05:30
if ! models . HasOrgVisible ( org , ctx . User ) {
ctx . NotFound ( "HasOrgVisible" , nil )
return
}
2018-07-05 05:21:02 +05:30
if ! ctx . User . IsAdmin {
isOwner , err := org . IsOwnedBy ( ctx . User . ID )
if err != nil {
ctx . ServerError ( "IsOwnedBy" , err )
return
} else if ! isOwner {
ctx . Error ( 403 , "" , "Given user is not owner of organization." )
return
}
2014-12-13 07:00:32 +05:30
}
2015-12-18 09:27:41 +05:30
CreateUserRepo ( ctx , org , opt )
2014-12-13 07:00:32 +05:30
}
2016-11-24 12:34:31 +05:30
// Migrate migrate remote git repository to gitea
2016-03-14 04:19:16 +05:30
func Migrate ( ctx * context . APIContext , form auth . MigrateRepoForm ) {
2017-11-13 12:32:25 +05:30
// swagger:operation POST /repos/migrate repository repoMigrate
// ---
// summary: Migrate a remote git repository
// consumes:
// - application/json
// produces:
// - application/json
// parameters:
// - name: body
// in: body
// schema:
// "$ref": "#/definitions/MigrateRepoForm"
// responses:
// "201":
// "$ref": "#/responses/Repository"
2015-09-03 15:47:33 +05:30
ctxUser := ctx . User
2015-11-25 11:25:37 +05:30
// Not equal means context user is an organization,
// or is another user/organization if current user is admin.
2016-11-27 11:33:59 +05:30
if form . UID != ctxUser . ID {
org , err := models . GetUserByID ( form . UID )
2014-08-29 15:01:53 +05:30
if err != nil {
2015-08-05 08:44:17 +05:30
if models . IsErrUserNotExist ( err ) {
2016-03-14 04:19:16 +05:30
ctx . Error ( 422 , "" , err )
2015-02-22 20:19:25 +05:30
} else {
2016-03-14 04:19:16 +05:30
ctx . Error ( 500 , "GetUserByID" , err )
2015-02-22 20:19:25 +05:30
}
2014-08-29 08:54:37 +05:30
return
}
ctxUser = org
}
if ctx . HasError ( ) {
2016-03-14 04:19:16 +05:30
ctx . Error ( 422 , "" , ctx . GetErrMsg ( ) )
2014-08-29 08:54:37 +05:30
return
}
2018-07-05 04:15:15 +05:30
if ! ctx . User . IsAdmin {
if ! ctxUser . IsOrganization ( ) && ctx . User . ID != ctxUser . ID {
ctx . Error ( 403 , "" , "Given user is not an organization." )
2014-08-29 08:54:37 +05:30
return
}
2018-07-05 04:15:15 +05:30
if ctxUser . IsOrganization ( ) {
// Check ownership of organization.
isOwner , err := ctxUser . IsOwnedBy ( ctx . User . ID )
if err != nil {
ctx . Error ( 500 , "IsOwnedBy" , err )
return
} else if ! isOwner {
ctx . Error ( 403 , "" , "Given user is not owner of organization." )
return
}
}
2014-08-29 08:54:37 +05:30
}
2015-11-04 05:10:52 +05:30
remoteAddr , err := form . ParseRemoteAddr ( ctx . User )
if err != nil {
if models . IsErrInvalidCloneAddr ( err ) {
addrErr := err . ( models . ErrInvalidCloneAddr )
switch {
case addrErr . IsURLError :
2016-03-14 04:19:16 +05:30
ctx . Error ( 422 , "" , err )
2015-11-04 05:10:52 +05:30
case addrErr . IsPermissionDenied :
2016-03-14 04:19:16 +05:30
ctx . Error ( 422 , "" , "You are not allowed to import local repositories." )
2015-11-04 05:10:52 +05:30
case addrErr . IsInvalidPath :
2016-03-14 04:19:16 +05:30
ctx . Error ( 422 , "" , "Invalid local path, it does not exist or not a directory." )
2015-11-04 05:10:52 +05:30
default :
2016-03-14 04:19:16 +05:30
ctx . Error ( 500 , "ParseRemoteAddr" , "Unknown error type (ErrInvalidCloneAddr): " + err . Error ( ) )
2015-11-04 05:10:52 +05:30
}
} else {
2016-03-14 04:19:16 +05:30
ctx . Error ( 500 , "ParseRemoteAddr" , err )
2015-02-22 20:19:25 +05:30
}
2014-08-29 08:54:37 +05:30
return
}
2019-10-14 11:40:42 +05:30
var gitServiceType = structs . PlainGitService
u , err := url . Parse ( remoteAddr )
if err == nil && strings . EqualFold ( u . Host , "github.com" ) {
gitServiceType = structs . GithubService
}
2019-05-07 06:42:51 +05:30
var opts = migrations . MigrateOptions {
2019-10-14 11:40:42 +05:30
CloneAddr : remoteAddr ,
RepoName : form . RepoName ,
Description : form . Description ,
Private : form . Private || setting . Repository . ForcePrivate ,
Mirror : form . Mirror ,
AuthUsername : form . AuthUsername ,
AuthPassword : form . AuthPassword ,
Wiki : form . Wiki ,
Issues : form . Issues ,
Milestones : form . Milestones ,
Labels : form . Labels ,
Comments : true ,
PullRequests : form . PullRequests ,
Releases : form . Releases ,
GitServiceType : gitServiceType ,
2019-05-07 06:42:51 +05:30
}
if opts . Mirror {
opts . Issues = false
opts . Milestones = false
opts . Labels = false
opts . Comments = false
opts . PullRequests = false
opts . Releases = false
}
2019-02-26 19:58:56 +05:30
2019-05-07 06:42:51 +05:30
repo , err := migrations . MigrateRepository ( ctx . User , ctxUser . Name , opts )
if err == nil {
2019-10-26 12:24:11 +05:30
notification . NotifyMigrateRepository ( ctx . User , ctxUser , repo )
2019-07-12 14:25:46 +05:30
2019-05-07 06:42:51 +05:30
log . Trace ( "Repository migrated: %s/%s" , ctxUser . Name , form . RepoName )
ctx . JSON ( 201 , repo . APIFormat ( models . AccessModeAdmin ) )
2015-02-22 20:19:25 +05:30
return
2014-08-29 08:54:37 +05:30
}
2019-05-07 06:42:51 +05:30
switch {
case models . IsErrRepoAlreadyExist ( err ) :
ctx . Error ( 409 , "" , "The repository with the same name already exists." )
case migrations . IsRateLimitError ( err ) :
ctx . Error ( 422 , "" , "Remote visit addressed rate limitation." )
case migrations . IsTwoFactorAuthError ( err ) :
ctx . Error ( 422 , "" , "Remote visit required two factors authentication." )
case models . IsErrReachLimitOfRepo ( err ) :
ctx . Error ( 422 , "" , fmt . Sprintf ( "You have already reached your limit of %d repositories." , ctxUser . MaxCreationLimit ( ) ) )
case models . IsErrNameReserved ( err ) :
ctx . Error ( 422 , "" , fmt . Sprintf ( "The username '%s' is reserved." , err . ( models . ErrNameReserved ) . Name ) )
case models . IsErrNamePatternNotAllowed ( err ) :
ctx . Error ( 422 , "" , fmt . Sprintf ( "The pattern '%s' is not allowed in a username." , err . ( models . ErrNamePatternNotAllowed ) . Pattern ) )
default :
err = util . URLSanitizedError ( err , remoteAddr )
if strings . Contains ( err . Error ( ) , "Authentication failed" ) ||
strings . Contains ( err . Error ( ) , "Bad credentials" ) ||
strings . Contains ( err . Error ( ) , "could not read Username" ) {
ctx . Error ( 422 , "" , fmt . Sprintf ( "Authentication failed: %v." , err ) )
} else if strings . Contains ( err . Error ( ) , "fatal:" ) {
ctx . Error ( 422 , "" , fmt . Sprintf ( "Migration failed: %v." , err ) )
} else {
ctx . Error ( 500 , "MigrateRepository" , err )
}
}
2014-08-29 08:54:37 +05:30
}
2015-10-04 20:39:16 +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"
2017-07-12 06:53:41 +05:30
ctx . JSON ( 200 , ctx . Repo . Repository . APIFormat ( 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"
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 {
ctx . Error ( 500 , "GetRepositoryByID" , err )
}
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 {
2017-07-30 06:43:33 +05:30
ctx . Error ( 500 , "AccessLevel" , err )
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
}
2018-11-28 16:56:14 +05:30
ctx . JSON ( 200 , repo . APIFormat ( perm . AccessMode ) )
2016-10-03 16:05:42 +05:30
}
2019-05-30 20:39:05 +05:30
// Edit edit repository properties
func Edit ( ctx * context . APIContext , opts api . EditRepoOption ) {
// 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"
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
}
}
ctx . JSON ( http . StatusOK , ctx . Repo . Repository . APIFormat ( ctx . Repo . AccessMode ) )
}
// 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
oldRepoName := repo . Name
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 ) {
if err := models . ChangeRepositoryName ( ctx . Repo . Owner , repo . Name , newRepoName ) ; err != nil {
switch {
case models . IsErrRepoAlreadyExist ( err ) :
ctx . Error ( http . StatusUnprocessableEntity , fmt . Sprintf ( "repo name is already taken [name: %s]" , newRepoName ) , err )
case models . IsErrNameReserved ( err ) :
ctx . Error ( http . StatusUnprocessableEntity , fmt . Sprintf ( "repo name is reserved [name: %s]" , newRepoName ) , err )
case models . IsErrNamePatternNotAllowed ( err ) :
ctx . Error ( http . StatusUnprocessableEntity , fmt . Sprintf ( "repo name's pattern is not allowed [name: %s, pattern: %s]" , newRepoName , err . ( models . ErrNamePatternNotAllowed ) . Pattern ) , err )
default :
ctx . Error ( http . StatusUnprocessableEntity , "ChangeRepositoryName" , err )
}
return err
}
err := models . NewRepoRedirect ( ctx . Repo . Owner . ID , repo . ID , repo . Name , newRepoName )
if err != nil {
ctx . Error ( http . StatusUnprocessableEntity , "NewRepoRedirect" , err )
return err
}
if err := models . RenameRepoAction ( ctx . User , oldRepoName , repo ) ; err != nil {
log . Error ( "RenameRepoAction: %v" , err )
ctx . Error ( http . StatusInternalServerError , "RenameRepoActions" , 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 {
* 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
}
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
for _ , tp := range models . MustRepoUnits {
units = append ( units , models . RepoUnit {
RepoID : repo . ID ,
Type : tp ,
Config : new ( models . UnitConfig ) ,
} )
}
2019-08-10 15:02:46 +05:30
if opts . HasIssues == nil {
// If HasIssues setting not touched, rewrite existing repo unit
if unit , err := repo . GetUnit ( models . UnitTypeIssues ) ; err == nil {
units = append ( units , * unit )
} else if unit , err := repo . GetUnit ( models . UnitTypeExternalTracker ) ; err == nil {
units = append ( units , * unit )
}
} else if * opts . HasIssues {
2019-10-02 15:00:41 +05:30
if opts . ExternalTracker != nil {
// 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 ,
Type : models . UnitTypeExternalTracker ,
Config : & models . ExternalTrackerConfig {
ExternalTrackerURL : opts . ExternalTracker . ExternalTrackerURL ,
ExternalTrackerFormat : opts . ExternalTracker . ExternalTrackerFormat ,
ExternalTrackerStyle : opts . ExternalTracker . ExternalTrackerStyle ,
} ,
} )
2019-08-10 15:02:46 +05:30
} else {
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 ,
}
} else if unit , err := repo . GetUnit ( models . UnitTypeIssues ) ; err != nil {
// 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 ,
Type : models . UnitTypeIssues ,
Config : config ,
} )
2019-05-30 20:39:05 +05:30
}
}
2019-08-10 15:02:46 +05:30
if opts . HasWiki == nil {
// If HasWiki setting not touched, rewrite existing repo unit
if unit , err := repo . GetUnit ( models . UnitTypeWiki ) ; err == nil {
units = append ( units , * unit )
} else if unit , err := repo . GetUnit ( models . UnitTypeExternalWiki ) ; err == nil {
units = append ( units , * unit )
2019-05-30 20:39:05 +05:30
}
2019-08-10 15:02:46 +05:30
} else if * opts . HasWiki {
2019-10-02 15:00:41 +05:30
if opts . ExternalWiki != nil {
// 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 ,
Type : models . UnitTypeExternalWiki ,
Config : & models . ExternalWikiConfig {
ExternalWikiURL : opts . ExternalWiki . ExternalWikiURL ,
} ,
} )
} else {
config := & models . UnitConfig { }
units = append ( units , models . RepoUnit {
RepoID : repo . ID ,
Type : models . UnitTypeWiki ,
Config : config ,
} )
}
2019-05-30 20:39:05 +05:30
}
2019-08-10 15:02:46 +05:30
if opts . HasPullRequests == nil {
// If HasPullRequest setting not touched, rewrite existing repo unit
if unit , err := repo . GetUnit ( models . UnitTypePullRequests ) ; err == nil {
units = append ( units , * unit )
}
} else if * opts . HasPullRequests {
// 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.
unit , err := repo . GetUnit ( models . UnitTypePullRequests )
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 {
IgnoreWhitespaceConflicts : false ,
AllowMerge : true ,
AllowRebase : true ,
AllowRebaseMerge : true ,
AllowSquash : true ,
2019-05-30 20:39:05 +05:30
}
2019-08-10 15:02:46 +05:30
} else {
config = unit . PullRequestsConfig ( )
}
2019-05-30 20:39:05 +05:30
2019-08-10 15:02:46 +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
2019-05-30 20:39:05 +05:30
}
2019-08-10 15:02:46 +05:30
units = append ( units , models . RepoUnit {
RepoID : repo . ID ,
Type : models . UnitTypePullRequests ,
Config : config ,
} )
2019-05-30 20:39:05 +05:30
}
if err := models . UpdateRepositoryUnits ( repo , units ) ; err != nil {
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
}
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"
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 {
ctx . Error ( 500 , "CanUserDelete" , err )
return
} else if ! canDelete {
ctx . Error ( 403 , "" , "Given user is not owner of organization." )
return
2015-10-04 20:39:16 +05:30
}
2019-10-26 12:24:11 +05:30
if err := repo_service . DeleteRepository ( ctx . User , repo ) ; err != nil {
2016-03-14 04:19:16 +05:30
ctx . Error ( 500 , "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 )
2015-10-04 20:39:16 +05:30
ctx . Status ( 204 )
}
2017-04-19 16:39:49 +05:30
// MirrorSync adds a mirrored repository to the sync queue
func MirrorSync ( ctx * context . APIContext ) {
2017-11-13 12:32:25 +05:30
// swagger:operation POST /repos/{owner}/{repo}/mirror-sync repository repoMirrorSync
// ---
// summary: Sync a mirrored repository
// produces:
// - application/json
// parameters:
// - name: owner
// in: path
// description: owner of the repo to sync
// type: string
// required: true
// - name: repo
// in: path
// description: name of the repo to sync
// type: string
// required: true
// responses:
// "200":
// "$ref": "#/responses/empty"
2017-04-19 16:39:49 +05:30
repo := ctx . Repo . Repository
2018-11-28 16:56:14 +05:30
if ! ctx . Repo . CanWrite ( models . UnitTypeCode ) {
2017-04-19 16:39:49 +05:30
ctx . Error ( 403 , "MirrorSync" , "Must have write access" )
}
2019-10-01 19:10:17 +05:30
mirror_service . StartToMirror ( repo . ID )
2017-04-19 16:39:49 +05:30
ctx . Status ( 200 )
}