mirror of
				https://github.com/go-gitea/gitea
				synced 2025-11-03 21:08:25 +00:00 
			
		
		
		
	Continuation of https://github.com/go-gitea/gitea/pull/34678. --------- Signed-off-by: silverwind <me@silverwind.io>
		
			
				
	
	
		
			372 lines
		
	
	
		
			10 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			372 lines
		
	
	
		
			10 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
// Copyright 2016 The Gogs Authors. All rights reserved.
 | 
						|
// Copyright 2018 The Gitea Authors. All rights reserved.
 | 
						|
// SPDX-License-Identifier: MIT
 | 
						|
 | 
						|
package repo
 | 
						|
 | 
						|
import (
 | 
						|
	"errors"
 | 
						|
	"net/http"
 | 
						|
	"strings"
 | 
						|
 | 
						|
	"code.gitea.io/gitea/models/perm"
 | 
						|
	access_model "code.gitea.io/gitea/models/perm/access"
 | 
						|
	repo_model "code.gitea.io/gitea/models/repo"
 | 
						|
	user_model "code.gitea.io/gitea/models/user"
 | 
						|
	api "code.gitea.io/gitea/modules/structs"
 | 
						|
	"code.gitea.io/gitea/modules/web"
 | 
						|
	"code.gitea.io/gitea/routers/api/v1/utils"
 | 
						|
	"code.gitea.io/gitea/services/context"
 | 
						|
	"code.gitea.io/gitea/services/convert"
 | 
						|
	issue_service "code.gitea.io/gitea/services/issue"
 | 
						|
	pull_service "code.gitea.io/gitea/services/pull"
 | 
						|
	repo_service "code.gitea.io/gitea/services/repository"
 | 
						|
)
 | 
						|
 | 
						|
// ListCollaborators list a repository's collaborators
 | 
						|
func ListCollaborators(ctx *context.APIContext) {
 | 
						|
	// swagger:operation GET /repos/{owner}/{repo}/collaborators repository repoListCollaborators
 | 
						|
	// ---
 | 
						|
	// summary: List a repository's collaborators
 | 
						|
	// 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: 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
 | 
						|
	// responses:
 | 
						|
	//   "200":
 | 
						|
	//     "$ref": "#/responses/UserList"
 | 
						|
	//   "404":
 | 
						|
	//     "$ref": "#/responses/notFound"
 | 
						|
 | 
						|
	collaborators, total, err := repo_model.GetCollaborators(ctx, &repo_model.FindCollaborationOptions{
 | 
						|
		ListOptions: utils.GetListOptions(ctx),
 | 
						|
		RepoID:      ctx.Repo.Repository.ID,
 | 
						|
	})
 | 
						|
	if err != nil {
 | 
						|
		ctx.APIErrorInternal(err)
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	users := make([]*api.User, len(collaborators))
 | 
						|
	for i, collaborator := range collaborators {
 | 
						|
		users[i] = convert.ToUser(ctx, collaborator.User, ctx.Doer)
 | 
						|
	}
 | 
						|
 | 
						|
	ctx.SetTotalCountHeader(total)
 | 
						|
	ctx.JSON(http.StatusOK, users)
 | 
						|
}
 | 
						|
 | 
						|
// IsCollaborator check if a user is a collaborator of a repository
 | 
						|
func IsCollaborator(ctx *context.APIContext) {
 | 
						|
	// swagger:operation GET /repos/{owner}/{repo}/collaborators/{collaborator} repository repoCheckCollaborator
 | 
						|
	// ---
 | 
						|
	// summary: Check if a user is a collaborator of 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: collaborator
 | 
						|
	//   in: path
 | 
						|
	//   description: username of the user to check for being a collaborator
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// responses:
 | 
						|
	//   "204":
 | 
						|
	//     "$ref": "#/responses/empty"
 | 
						|
	//   "404":
 | 
						|
	//     "$ref": "#/responses/notFound"
 | 
						|
	//   "422":
 | 
						|
	//     "$ref": "#/responses/validationError"
 | 
						|
 | 
						|
	user, err := user_model.GetUserByName(ctx, ctx.PathParam("collaborator"))
 | 
						|
	if err != nil {
 | 
						|
		if user_model.IsErrUserNotExist(err) {
 | 
						|
			ctx.APIError(http.StatusUnprocessableEntity, err)
 | 
						|
		} else {
 | 
						|
			ctx.APIErrorInternal(err)
 | 
						|
		}
 | 
						|
		return
 | 
						|
	}
 | 
						|
	isColab, err := repo_model.IsCollaborator(ctx, ctx.Repo.Repository.ID, user.ID)
 | 
						|
	if err != nil {
 | 
						|
		ctx.APIErrorInternal(err)
 | 
						|
		return
 | 
						|
	}
 | 
						|
	if isColab {
 | 
						|
		ctx.Status(http.StatusNoContent)
 | 
						|
	} else {
 | 
						|
		ctx.APIErrorNotFound()
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
// AddOrUpdateCollaborator add or update a collaborator to a repository
 | 
						|
func AddOrUpdateCollaborator(ctx *context.APIContext) {
 | 
						|
	// swagger:operation PUT /repos/{owner}/{repo}/collaborators/{collaborator} repository repoAddCollaborator
 | 
						|
	// ---
 | 
						|
	// summary: Add or Update a collaborator to 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: collaborator
 | 
						|
	//   in: path
 | 
						|
	//   description: username of the user to add or update as a collaborator
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// - name: body
 | 
						|
	//   in: body
 | 
						|
	//   schema:
 | 
						|
	//     "$ref": "#/definitions/AddCollaboratorOption"
 | 
						|
	// responses:
 | 
						|
	//   "204":
 | 
						|
	//     "$ref": "#/responses/empty"
 | 
						|
	//   "403":
 | 
						|
	//     "$ref": "#/responses/forbidden"
 | 
						|
	//   "404":
 | 
						|
	//     "$ref": "#/responses/notFound"
 | 
						|
	//   "422":
 | 
						|
	//     "$ref": "#/responses/validationError"
 | 
						|
 | 
						|
	form := web.GetForm(ctx).(*api.AddCollaboratorOption)
 | 
						|
 | 
						|
	collaborator, err := user_model.GetUserByName(ctx, ctx.PathParam("collaborator"))
 | 
						|
	if err != nil {
 | 
						|
		if user_model.IsErrUserNotExist(err) {
 | 
						|
			ctx.APIError(http.StatusUnprocessableEntity, err)
 | 
						|
		} else {
 | 
						|
			ctx.APIErrorInternal(err)
 | 
						|
		}
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	if !collaborator.IsActive {
 | 
						|
		ctx.APIErrorInternal(errors.New("collaborator's account is inactive"))
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	p := perm.AccessModeWrite
 | 
						|
	if form.Permission != nil {
 | 
						|
		p = perm.ParseAccessMode(*form.Permission, perm.AccessModeRead, perm.AccessModeWrite, perm.AccessModeAdmin)
 | 
						|
	}
 | 
						|
 | 
						|
	if err := repo_service.AddOrUpdateCollaborator(ctx, ctx.Repo.Repository, collaborator, p); err != nil {
 | 
						|
		if errors.Is(err, user_model.ErrBlockedUser) {
 | 
						|
			ctx.APIError(http.StatusForbidden, err)
 | 
						|
		} else {
 | 
						|
			ctx.APIErrorInternal(err)
 | 
						|
		}
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	ctx.Status(http.StatusNoContent)
 | 
						|
}
 | 
						|
 | 
						|
// DeleteCollaborator delete a collaborator from a repository
 | 
						|
func DeleteCollaborator(ctx *context.APIContext) {
 | 
						|
	// swagger:operation DELETE /repos/{owner}/{repo}/collaborators/{collaborator} repository repoDeleteCollaborator
 | 
						|
	// ---
 | 
						|
	// summary: Delete a collaborator 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: collaborator
 | 
						|
	//   in: path
 | 
						|
	//   description: username of the collaborator to delete
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// responses:
 | 
						|
	//   "204":
 | 
						|
	//     "$ref": "#/responses/empty"
 | 
						|
	//   "404":
 | 
						|
	//     "$ref": "#/responses/notFound"
 | 
						|
	//   "422":
 | 
						|
	//     "$ref": "#/responses/validationError"
 | 
						|
 | 
						|
	collaborator, err := user_model.GetUserByName(ctx, ctx.PathParam("collaborator"))
 | 
						|
	if err != nil {
 | 
						|
		if user_model.IsErrUserNotExist(err) {
 | 
						|
			ctx.APIError(http.StatusUnprocessableEntity, err)
 | 
						|
		} else {
 | 
						|
			ctx.APIErrorInternal(err)
 | 
						|
		}
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	if err := repo_service.DeleteCollaboration(ctx, ctx.Repo.Repository, collaborator); err != nil {
 | 
						|
		ctx.APIErrorInternal(err)
 | 
						|
		return
 | 
						|
	}
 | 
						|
	ctx.Status(http.StatusNoContent)
 | 
						|
}
 | 
						|
 | 
						|
// GetRepoPermissions gets repository permissions for a user
 | 
						|
func GetRepoPermissions(ctx *context.APIContext) {
 | 
						|
	// swagger:operation GET /repos/{owner}/{repo}/collaborators/{collaborator}/permission repository repoGetRepoPermissions
 | 
						|
	// ---
 | 
						|
	// summary: Get repository permissions for a user
 | 
						|
	// 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: collaborator
 | 
						|
	//   in: path
 | 
						|
	//   description: username of the collaborator whose permissions are to be obtained
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// responses:
 | 
						|
	//   "200":
 | 
						|
	//     "$ref": "#/responses/RepoCollaboratorPermission"
 | 
						|
	//   "404":
 | 
						|
	//     "$ref": "#/responses/notFound"
 | 
						|
	//   "403":
 | 
						|
	//     "$ref": "#/responses/forbidden"
 | 
						|
 | 
						|
	collaboratorUsername := ctx.PathParam("collaborator")
 | 
						|
	if !ctx.Doer.IsAdmin && !strings.EqualFold(ctx.Doer.LowerName, collaboratorUsername) && !ctx.IsUserRepoAdmin() {
 | 
						|
		ctx.APIError(http.StatusForbidden, "Only admins can query all permissions, repo admins can query all repo permissions, collaborators can query only their own")
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	collaborator, err := user_model.GetUserByName(ctx, collaboratorUsername)
 | 
						|
	if err != nil {
 | 
						|
		if user_model.IsErrUserNotExist(err) {
 | 
						|
			ctx.APIError(http.StatusNotFound, err)
 | 
						|
		} else {
 | 
						|
			ctx.APIErrorInternal(err)
 | 
						|
		}
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	permission, err := access_model.GetUserRepoPermission(ctx, ctx.Repo.Repository, collaborator)
 | 
						|
	if err != nil {
 | 
						|
		ctx.APIErrorInternal(err)
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	ctx.JSON(http.StatusOK, convert.ToUserAndPermission(ctx, collaborator, ctx.ContextUser, permission.AccessMode))
 | 
						|
}
 | 
						|
 | 
						|
// GetReviewers return all users that can be requested to review in this repo
 | 
						|
func GetReviewers(ctx *context.APIContext) {
 | 
						|
	// swagger:operation GET /repos/{owner}/{repo}/reviewers repository repoGetReviewers
 | 
						|
	// ---
 | 
						|
	// summary: Return all users that can be requested to review in this repo
 | 
						|
	// 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/UserList"
 | 
						|
	//   "404":
 | 
						|
	//     "$ref": "#/responses/notFound"
 | 
						|
 | 
						|
	canChooseReviewer := issue_service.CanDoerChangeReviewRequests(ctx, ctx.Doer, ctx.Repo.Repository, 0)
 | 
						|
	if !canChooseReviewer {
 | 
						|
		ctx.APIError(http.StatusForbidden, errors.New("doer has no permission to get reviewers"))
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	reviewers, err := pull_service.GetReviewers(ctx, ctx.Repo.Repository, ctx.Doer.ID, 0)
 | 
						|
	if err != nil {
 | 
						|
		ctx.APIErrorInternal(err)
 | 
						|
		return
 | 
						|
	}
 | 
						|
	ctx.JSON(http.StatusOK, convert.ToUsers(ctx, ctx.Doer, reviewers))
 | 
						|
}
 | 
						|
 | 
						|
// GetAssignees return all users that have write access and can be assigned to issues
 | 
						|
func GetAssignees(ctx *context.APIContext) {
 | 
						|
	// swagger:operation GET /repos/{owner}/{repo}/assignees repository repoGetAssignees
 | 
						|
	// ---
 | 
						|
	// summary: Return all users that have write access and can be assigned to issues
 | 
						|
	// 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/UserList"
 | 
						|
	//   "404":
 | 
						|
	//     "$ref": "#/responses/notFound"
 | 
						|
 | 
						|
	assignees, err := repo_model.GetRepoAssignees(ctx, ctx.Repo.Repository)
 | 
						|
	if err != nil {
 | 
						|
		ctx.APIErrorInternal(err)
 | 
						|
		return
 | 
						|
	}
 | 
						|
	ctx.JSON(http.StatusOK, convert.ToUsers(ctx, ctx.Doer, assignees))
 | 
						|
}
 |