mirror of
				https://codeberg.org/forgejo/forgejo.git
				synced 2025-11-04 08:21:11 +00:00 
			
		
		
		
	close #27801 --------- Co-authored-by: silverwind <me@silverwind.io> (cherry picked from commit 62b073e6f31645e446c7e8d6b5a506f61b47924e) Conflicts: - modules/util/util.go Trivial resolution, only picking the newly introduced function - routers/api/v1/swagger/options.go Trivial resolution. We don't have UserBadges, don't pick that part. - templates/swagger/v1_json.tmpl Regenerated.
		
			
				
	
	
		
			425 lines
		
	
	
	
		
			11 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			425 lines
		
	
	
	
		
			11 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
// Copyright 2023 The Gitea Authors. All rights reserved.
 | 
						|
// SPDX-License-Identifier: MIT
 | 
						|
 | 
						|
package repo
 | 
						|
 | 
						|
import (
 | 
						|
	"errors"
 | 
						|
	"net/http"
 | 
						|
 | 
						|
	actions_model "code.gitea.io/gitea/models/actions"
 | 
						|
	"code.gitea.io/gitea/models/db"
 | 
						|
	api "code.gitea.io/gitea/modules/structs"
 | 
						|
	"code.gitea.io/gitea/modules/util"
 | 
						|
	"code.gitea.io/gitea/modules/web"
 | 
						|
	"code.gitea.io/gitea/routers/api/v1/utils"
 | 
						|
	actions_service "code.gitea.io/gitea/services/actions"
 | 
						|
	"code.gitea.io/gitea/services/context"
 | 
						|
	secret_service "code.gitea.io/gitea/services/secrets"
 | 
						|
)
 | 
						|
 | 
						|
// create or update one secret of the repository
 | 
						|
func CreateOrUpdateSecret(ctx *context.APIContext) {
 | 
						|
	// swagger:operation PUT /repos/{owner}/{repo}/actions/secrets/{secretname} repository updateRepoSecret
 | 
						|
	// ---
 | 
						|
	// summary: Create or Update a secret value in a repository
 | 
						|
	// consumes:
 | 
						|
	// - application/json
 | 
						|
	// produces:
 | 
						|
	// - application/json
 | 
						|
	// parameters:
 | 
						|
	// - name: owner
 | 
						|
	//   in: path
 | 
						|
	//   description: owner of the repository
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// - name: repo
 | 
						|
	//   in: path
 | 
						|
	//   description: name of the repository
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// - name: secretname
 | 
						|
	//   in: path
 | 
						|
	//   description: name of the secret
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// - name: body
 | 
						|
	//   in: body
 | 
						|
	//   schema:
 | 
						|
	//     "$ref": "#/definitions/CreateOrUpdateSecretOption"
 | 
						|
	// responses:
 | 
						|
	//   "201":
 | 
						|
	//     description: response when creating a secret
 | 
						|
	//   "204":
 | 
						|
	//     description: response when updating a secret
 | 
						|
	//   "400":
 | 
						|
	//     "$ref": "#/responses/error"
 | 
						|
	//   "404":
 | 
						|
	//     "$ref": "#/responses/notFound"
 | 
						|
 | 
						|
	owner := ctx.Repo.Owner
 | 
						|
	repo := ctx.Repo.Repository
 | 
						|
 | 
						|
	opt := web.GetForm(ctx).(*api.CreateOrUpdateSecretOption)
 | 
						|
 | 
						|
	_, created, err := secret_service.CreateOrUpdateSecret(ctx, owner.ID, repo.ID, ctx.Params("secretname"), opt.Data)
 | 
						|
	if err != nil {
 | 
						|
		if errors.Is(err, util.ErrInvalidArgument) {
 | 
						|
			ctx.Error(http.StatusBadRequest, "CreateOrUpdateSecret", err)
 | 
						|
		} else if errors.Is(err, util.ErrNotExist) {
 | 
						|
			ctx.Error(http.StatusNotFound, "CreateOrUpdateSecret", err)
 | 
						|
		} else {
 | 
						|
			ctx.Error(http.StatusInternalServerError, "CreateOrUpdateSecret", err)
 | 
						|
		}
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	if created {
 | 
						|
		ctx.Status(http.StatusCreated)
 | 
						|
	} else {
 | 
						|
		ctx.Status(http.StatusNoContent)
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
// DeleteSecret delete one secret of the repository
 | 
						|
func DeleteSecret(ctx *context.APIContext) {
 | 
						|
	// swagger:operation DELETE /repos/{owner}/{repo}/actions/secrets/{secretname} repository deleteRepoSecret
 | 
						|
	// ---
 | 
						|
	// summary: Delete a secret in a repository
 | 
						|
	// consumes:
 | 
						|
	// - application/json
 | 
						|
	// produces:
 | 
						|
	// - application/json
 | 
						|
	// parameters:
 | 
						|
	// - name: owner
 | 
						|
	//   in: path
 | 
						|
	//   description: owner of the repository
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// - name: repo
 | 
						|
	//   in: path
 | 
						|
	//   description: name of the repository
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// - name: secretname
 | 
						|
	//   in: path
 | 
						|
	//   description: name of the secret
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// responses:
 | 
						|
	//   "204":
 | 
						|
	//     description: delete one secret of the organization
 | 
						|
	//   "400":
 | 
						|
	//     "$ref": "#/responses/error"
 | 
						|
	//   "404":
 | 
						|
	//     "$ref": "#/responses/notFound"
 | 
						|
 | 
						|
	owner := ctx.Repo.Owner
 | 
						|
	repo := ctx.Repo.Repository
 | 
						|
 | 
						|
	err := secret_service.DeleteSecretByName(ctx, owner.ID, repo.ID, ctx.Params("secretname"))
 | 
						|
	if err != nil {
 | 
						|
		if errors.Is(err, util.ErrInvalidArgument) {
 | 
						|
			ctx.Error(http.StatusBadRequest, "DeleteSecret", err)
 | 
						|
		} else if errors.Is(err, util.ErrNotExist) {
 | 
						|
			ctx.Error(http.StatusNotFound, "DeleteSecret", err)
 | 
						|
		} else {
 | 
						|
			ctx.Error(http.StatusInternalServerError, "DeleteSecret", err)
 | 
						|
		}
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	ctx.Status(http.StatusNoContent)
 | 
						|
}
 | 
						|
 | 
						|
// GetVariable get a repo-level variable
 | 
						|
func GetVariable(ctx *context.APIContext) {
 | 
						|
	// swagger:operation GET /repos/{owner}/{repo}/actions/variables/{variablename} repository getRepoVariable
 | 
						|
	// ---
 | 
						|
	// summary: Get a repo-level variable
 | 
						|
	// produces:
 | 
						|
	// - application/json
 | 
						|
	// parameters:
 | 
						|
	// - name: owner
 | 
						|
	//   in: path
 | 
						|
	//   description: name of the owner
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// - name: repo
 | 
						|
	//   in: path
 | 
						|
	//   description: name of the repository
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// - name: variablename
 | 
						|
	//   in: path
 | 
						|
	//   description: name of the variable
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// responses:
 | 
						|
	//   "200":
 | 
						|
	//			"$ref": "#/responses/ActionVariable"
 | 
						|
	//   "400":
 | 
						|
	//     "$ref": "#/responses/error"
 | 
						|
	//   "404":
 | 
						|
	//     "$ref": "#/responses/notFound"
 | 
						|
	v, err := actions_service.GetVariable(ctx, actions_model.FindVariablesOpts{
 | 
						|
		RepoID: ctx.Repo.Repository.ID,
 | 
						|
		Name:   ctx.Params("variablename"),
 | 
						|
	})
 | 
						|
	if err != nil {
 | 
						|
		if errors.Is(err, util.ErrNotExist) {
 | 
						|
			ctx.Error(http.StatusNotFound, "GetVariable", err)
 | 
						|
		} else {
 | 
						|
			ctx.Error(http.StatusInternalServerError, "GetVariable", err)
 | 
						|
		}
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	variable := &api.ActionVariable{
 | 
						|
		OwnerID: v.OwnerID,
 | 
						|
		RepoID:  v.RepoID,
 | 
						|
		Name:    v.Name,
 | 
						|
		Data:    v.Data,
 | 
						|
	}
 | 
						|
 | 
						|
	ctx.JSON(http.StatusOK, variable)
 | 
						|
}
 | 
						|
 | 
						|
// DeleteVariable delete a repo-level variable
 | 
						|
func DeleteVariable(ctx *context.APIContext) {
 | 
						|
	// swagger:operation DELETE /repos/{owner}/{repo}/actions/variables/{variablename} repository deleteRepoVariable
 | 
						|
	// ---
 | 
						|
	// summary: Delete a repo-level variable
 | 
						|
	// produces:
 | 
						|
	// - application/json
 | 
						|
	// parameters:
 | 
						|
	// - name: owner
 | 
						|
	//   in: path
 | 
						|
	//   description: name of the owner
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// - name: repo
 | 
						|
	//   in: path
 | 
						|
	//   description: name of the repository
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// - name: variablename
 | 
						|
	//   in: path
 | 
						|
	//   description: name of the variable
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// responses:
 | 
						|
	//   "200":
 | 
						|
	//			"$ref": "#/responses/ActionVariable"
 | 
						|
	//   "201":
 | 
						|
	//     description: response when deleting a variable
 | 
						|
	//   "204":
 | 
						|
	//     description: response when deleting a variable
 | 
						|
	//   "400":
 | 
						|
	//     "$ref": "#/responses/error"
 | 
						|
	//   "404":
 | 
						|
	//     "$ref": "#/responses/notFound"
 | 
						|
 | 
						|
	if err := actions_service.DeleteVariableByName(ctx, 0, ctx.Repo.Repository.ID, ctx.Params("variablename")); err != nil {
 | 
						|
		if errors.Is(err, util.ErrInvalidArgument) {
 | 
						|
			ctx.Error(http.StatusBadRequest, "DeleteVariableByName", err)
 | 
						|
		} else if errors.Is(err, util.ErrNotExist) {
 | 
						|
			ctx.Error(http.StatusNotFound, "DeleteVariableByName", err)
 | 
						|
		} else {
 | 
						|
			ctx.Error(http.StatusInternalServerError, "DeleteVariableByName", err)
 | 
						|
		}
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	ctx.Status(http.StatusNoContent)
 | 
						|
}
 | 
						|
 | 
						|
// CreateVariable create a repo-level variable
 | 
						|
func CreateVariable(ctx *context.APIContext) {
 | 
						|
	// swagger:operation POST /repos/{owner}/{repo}/actions/variables/{variablename} repository createRepoVariable
 | 
						|
	// ---
 | 
						|
	// summary: Create a repo-level variable
 | 
						|
	// produces:
 | 
						|
	// - application/json
 | 
						|
	// parameters:
 | 
						|
	// - name: owner
 | 
						|
	//   in: path
 | 
						|
	//   description: name of the owner
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// - name: repo
 | 
						|
	//   in: path
 | 
						|
	//   description: name of the repository
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// - name: variablename
 | 
						|
	//   in: path
 | 
						|
	//   description: name of the variable
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// - name: body
 | 
						|
	//   in: body
 | 
						|
	//   schema:
 | 
						|
	//     "$ref": "#/definitions/CreateVariableOption"
 | 
						|
	// responses:
 | 
						|
	//   "201":
 | 
						|
	//     description: response when creating a repo-level variable
 | 
						|
	//   "204":
 | 
						|
	//     description: response when creating a repo-level variable
 | 
						|
	//   "400":
 | 
						|
	//     "$ref": "#/responses/error"
 | 
						|
	//   "404":
 | 
						|
	//     "$ref": "#/responses/notFound"
 | 
						|
 | 
						|
	opt := web.GetForm(ctx).(*api.CreateVariableOption)
 | 
						|
 | 
						|
	repoID := ctx.Repo.Repository.ID
 | 
						|
	variableName := ctx.Params("variablename")
 | 
						|
 | 
						|
	v, err := actions_service.GetVariable(ctx, actions_model.FindVariablesOpts{
 | 
						|
		RepoID: repoID,
 | 
						|
		Name:   variableName,
 | 
						|
	})
 | 
						|
	if err != nil && !errors.Is(err, util.ErrNotExist) {
 | 
						|
		ctx.Error(http.StatusInternalServerError, "GetVariable", err)
 | 
						|
		return
 | 
						|
	}
 | 
						|
	if v != nil && v.ID > 0 {
 | 
						|
		ctx.Error(http.StatusConflict, "VariableNameAlreadyExists", util.NewAlreadyExistErrorf("variable name %s already exists", variableName))
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	if _, err := actions_service.CreateVariable(ctx, 0, repoID, variableName, opt.Value); err != nil {
 | 
						|
		if errors.Is(err, util.ErrInvalidArgument) {
 | 
						|
			ctx.Error(http.StatusBadRequest, "CreateVariable", err)
 | 
						|
		} else {
 | 
						|
			ctx.Error(http.StatusInternalServerError, "CreateVariable", err)
 | 
						|
		}
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	ctx.Status(http.StatusNoContent)
 | 
						|
}
 | 
						|
 | 
						|
// UpdateVariable update a repo-level variable
 | 
						|
func UpdateVariable(ctx *context.APIContext) {
 | 
						|
	// swagger:operation PUT /repos/{owner}/{repo}/actions/variables/{variablename} repository updateRepoVariable
 | 
						|
	// ---
 | 
						|
	// summary: Update a repo-level variable
 | 
						|
	// produces:
 | 
						|
	// - application/json
 | 
						|
	// parameters:
 | 
						|
	// - name: owner
 | 
						|
	//   in: path
 | 
						|
	//   description: name of the owner
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// - name: repo
 | 
						|
	//   in: path
 | 
						|
	//   description: name of the repository
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// - name: variablename
 | 
						|
	//   in: path
 | 
						|
	//   description: name of the variable
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// - name: body
 | 
						|
	//   in: body
 | 
						|
	//   schema:
 | 
						|
	//     "$ref": "#/definitions/UpdateVariableOption"
 | 
						|
	// responses:
 | 
						|
	//   "201":
 | 
						|
	//     description: response when updating a repo-level variable
 | 
						|
	//   "204":
 | 
						|
	//     description: response when updating a repo-level variable
 | 
						|
	//   "400":
 | 
						|
	//     "$ref": "#/responses/error"
 | 
						|
	//   "404":
 | 
						|
	//     "$ref": "#/responses/notFound"
 | 
						|
 | 
						|
	opt := web.GetForm(ctx).(*api.UpdateVariableOption)
 | 
						|
 | 
						|
	v, err := actions_service.GetVariable(ctx, actions_model.FindVariablesOpts{
 | 
						|
		RepoID: ctx.Repo.Repository.ID,
 | 
						|
		Name:   ctx.Params("variablename"),
 | 
						|
	})
 | 
						|
	if err != nil {
 | 
						|
		if errors.Is(err, util.ErrNotExist) {
 | 
						|
			ctx.Error(http.StatusNotFound, "GetVariable", err)
 | 
						|
		} else {
 | 
						|
			ctx.Error(http.StatusInternalServerError, "GetVariable", err)
 | 
						|
		}
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	if opt.Name == "" {
 | 
						|
		opt.Name = ctx.Params("variablename")
 | 
						|
	}
 | 
						|
	if _, err := actions_service.UpdateVariable(ctx, v.ID, opt.Name, opt.Value); err != nil {
 | 
						|
		if errors.Is(err, util.ErrInvalidArgument) {
 | 
						|
			ctx.Error(http.StatusBadRequest, "UpdateVariable", err)
 | 
						|
		} else {
 | 
						|
			ctx.Error(http.StatusInternalServerError, "UpdateVariable", err)
 | 
						|
		}
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	ctx.Status(http.StatusNoContent)
 | 
						|
}
 | 
						|
 | 
						|
// ListVariables list repo-level variables
 | 
						|
func ListVariables(ctx *context.APIContext) {
 | 
						|
	// swagger:operation GET /repos/{owner}/{repo}/actions/variables repository getRepoVariablesList
 | 
						|
	// ---
 | 
						|
	// summary: Get repo-level variables list
 | 
						|
	// produces:
 | 
						|
	// - application/json
 | 
						|
	// parameters:
 | 
						|
	// - name: owner
 | 
						|
	//   in: path
 | 
						|
	//   description: name of the owner
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// - name: repo
 | 
						|
	//   in: path
 | 
						|
	//   description: name of the repository
 | 
						|
	//   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/VariableList"
 | 
						|
	//   "400":
 | 
						|
	//     "$ref": "#/responses/error"
 | 
						|
	//   "404":
 | 
						|
	//     "$ref": "#/responses/notFound"
 | 
						|
 | 
						|
	vars, count, err := db.FindAndCount[actions_model.ActionVariable](ctx, &actions_model.FindVariablesOpts{
 | 
						|
		RepoID:      ctx.Repo.Repository.ID,
 | 
						|
		ListOptions: utils.GetListOptions(ctx),
 | 
						|
	})
 | 
						|
	if err != nil {
 | 
						|
		ctx.Error(http.StatusInternalServerError, "FindVariables", err)
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	variables := make([]*api.ActionVariable, len(vars))
 | 
						|
	for i, v := range vars {
 | 
						|
		variables[i] = &api.ActionVariable{
 | 
						|
			OwnerID: v.OwnerID,
 | 
						|
			RepoID:  v.RepoID,
 | 
						|
			Name:    v.Name,
 | 
						|
		}
 | 
						|
	}
 | 
						|
 | 
						|
	ctx.SetTotalCountHeader(count)
 | 
						|
	ctx.JSON(http.StatusOK, variables)
 | 
						|
}
 |