Use [chi](https://github.com/go-chi/chi) instead of the forked [macaron](https://gitea.com/macaron/macaron). Since macaron and chi have conflicts with session share, this big PR becomes a have-to thing. According my previous idea, we can replace macaron step by step but I'm wrong. :( Below is a list of big changes on this PR. - [x] Define `context.ResponseWriter` interface with an implementation `context.Response`. - [x] Use chi instead of macaron, and also a customize `Route` to wrap chi so that the router usage is similar as before. - [x] Create different routers for `web`, `api`, `internal` and `install` so that the codes will be more clear and no magic . - [x] Use https://github.com/unrolled/render instead of macaron's internal render - [x] Use https://github.com/NYTimes/gziphandler instead of https://gitea.com/macaron/gzip - [x] Use https://gitea.com/go-chi/session which is a modified version of https://gitea.com/macaron/session and removed `nodb` support since it will not be maintained. **BREAK** - [x] Use https://gitea.com/go-chi/captcha which is a modified version of https://gitea.com/macaron/captcha - [x] Use https://gitea.com/go-chi/cache which is a modified version of https://gitea.com/macaron/cache - [x] Use https://gitea.com/go-chi/binding which is a modified version of https://gitea.com/macaron/binding - [x] Use https://github.com/go-chi/cors instead of https://gitea.com/macaron/cors - [x] Dropped https://gitea.com/macaron/i18n and make a new one in `code.gitea.io/gitea/modules/translation` - [x] Move validation form structs from `code.gitea.io/gitea/modules/auth` to `code.gitea.io/gitea/modules/forms` to avoid dependency cycle. - [x] Removed macaron log service because it's not need any more. **BREAK** - [x] All form structs have to be get by `web.GetForm(ctx)` in the route function but not as a function parameter on routes definition. - [x] Move Git HTTP protocol implementation to use routers directly. - [x] Fix the problem that chi routes don't support trailing slash but macaron did. - [x] `/api/v1/swagger` now will be redirect to `/api/swagger` but not render directly so that `APIContext` will not create a html render. Notices: - Chi router don't support request with trailing slash - Integration test `TestUserHeatmap` maybe mysql version related. It's failed on my macOS(mysql 5.7.29 installed via brew) but succeed on CI. Co-authored-by: 6543 <6543@obermui.de>
		
			
				
	
	
		
			440 lines
		
	
	
	
		
			12 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			440 lines
		
	
	
	
		
			12 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
// Copyright 2019 The Gitea Authors. All rights reserved.
 | 
						|
// Use of this source code is governed by a MIT-style
 | 
						|
// license that can be found in the LICENSE file.
 | 
						|
 | 
						|
package repo
 | 
						|
 | 
						|
import (
 | 
						|
	"errors"
 | 
						|
	"net/http"
 | 
						|
 | 
						|
	"code.gitea.io/gitea/models"
 | 
						|
	"code.gitea.io/gitea/modules/context"
 | 
						|
	"code.gitea.io/gitea/modules/convert"
 | 
						|
	api "code.gitea.io/gitea/modules/structs"
 | 
						|
	"code.gitea.io/gitea/modules/web"
 | 
						|
	"code.gitea.io/gitea/routers/api/v1/utils"
 | 
						|
)
 | 
						|
 | 
						|
// GetIssueCommentReactions list reactions of a comment from an issue
 | 
						|
func GetIssueCommentReactions(ctx *context.APIContext) {
 | 
						|
	// swagger:operation GET /repos/{owner}/{repo}/issues/comments/{id}/reactions issue issueGetCommentReactions
 | 
						|
	// ---
 | 
						|
	// summary: Get a list of reactions from a comment of an issue
 | 
						|
	// consumes:
 | 
						|
	// - application/json
 | 
						|
	// produces:
 | 
						|
	// - application/json
 | 
						|
	// parameters:
 | 
						|
	// - name: owner
 | 
						|
	//   in: path
 | 
						|
	//   description: owner of the repo
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// - name: repo
 | 
						|
	//   in: path
 | 
						|
	//   description: name of the repo
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// - name: id
 | 
						|
	//   in: path
 | 
						|
	//   description: id of the comment to edit
 | 
						|
	//   type: integer
 | 
						|
	//   format: int64
 | 
						|
	//   required: true
 | 
						|
	// responses:
 | 
						|
	//   "200":
 | 
						|
	//     "$ref": "#/responses/ReactionList"
 | 
						|
	//   "403":
 | 
						|
	//     "$ref": "#/responses/forbidden"
 | 
						|
 | 
						|
	comment, err := models.GetCommentByID(ctx.ParamsInt64(":id"))
 | 
						|
	if err != nil {
 | 
						|
		if models.IsErrCommentNotExist(err) {
 | 
						|
			ctx.NotFound(err)
 | 
						|
		} else {
 | 
						|
			ctx.Error(http.StatusInternalServerError, "GetCommentByID", err)
 | 
						|
		}
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	if err := comment.LoadIssue(); err != nil {
 | 
						|
		ctx.Error(http.StatusInternalServerError, "comment.LoadIssue", err)
 | 
						|
	}
 | 
						|
 | 
						|
	if !ctx.Repo.CanReadIssuesOrPulls(comment.Issue.IsPull) {
 | 
						|
		ctx.Error(http.StatusForbidden, "GetIssueCommentReactions", errors.New("no permission to get reactions"))
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	reactions, err := models.FindCommentReactions(comment)
 | 
						|
	if err != nil {
 | 
						|
		ctx.Error(http.StatusInternalServerError, "FindIssueReactions", err)
 | 
						|
		return
 | 
						|
	}
 | 
						|
	_, err = reactions.LoadUsers(ctx.Repo.Repository)
 | 
						|
	if err != nil {
 | 
						|
		ctx.Error(http.StatusInternalServerError, "ReactionList.LoadUsers()", err)
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	var result []api.Reaction
 | 
						|
	for _, r := range reactions {
 | 
						|
		result = append(result, api.Reaction{
 | 
						|
			User:     convert.ToUser(r.User, ctx.IsSigned, false),
 | 
						|
			Reaction: r.Type,
 | 
						|
			Created:  r.CreatedUnix.AsTime(),
 | 
						|
		})
 | 
						|
	}
 | 
						|
 | 
						|
	ctx.JSON(http.StatusOK, result)
 | 
						|
}
 | 
						|
 | 
						|
// PostIssueCommentReaction add a reaction to a comment of an issue
 | 
						|
func PostIssueCommentReaction(ctx *context.APIContext) {
 | 
						|
	// swagger:operation POST /repos/{owner}/{repo}/issues/comments/{id}/reactions issue issuePostCommentReaction
 | 
						|
	// ---
 | 
						|
	// summary: Add a reaction to a comment of an issue
 | 
						|
	// consumes:
 | 
						|
	// - application/json
 | 
						|
	// produces:
 | 
						|
	// - application/json
 | 
						|
	// parameters:
 | 
						|
	// - name: owner
 | 
						|
	//   in: path
 | 
						|
	//   description: owner of the repo
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// - name: repo
 | 
						|
	//   in: path
 | 
						|
	//   description: name of the repo
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// - name: id
 | 
						|
	//   in: path
 | 
						|
	//   description: id of the comment to edit
 | 
						|
	//   type: integer
 | 
						|
	//   format: int64
 | 
						|
	//   required: true
 | 
						|
	// - name: content
 | 
						|
	//   in: body
 | 
						|
	//   schema:
 | 
						|
	//     "$ref": "#/definitions/EditReactionOption"
 | 
						|
	// responses:
 | 
						|
	//   "200":
 | 
						|
	//     "$ref": "#/responses/Reaction"
 | 
						|
	//   "201":
 | 
						|
	//     "$ref": "#/responses/Reaction"
 | 
						|
	//   "403":
 | 
						|
	//     "$ref": "#/responses/forbidden"
 | 
						|
 | 
						|
	form := web.GetForm(ctx).(*api.EditReactionOption)
 | 
						|
 | 
						|
	changeIssueCommentReaction(ctx, *form, true)
 | 
						|
}
 | 
						|
 | 
						|
// DeleteIssueCommentReaction remove a reaction from a comment of an issue
 | 
						|
func DeleteIssueCommentReaction(ctx *context.APIContext) {
 | 
						|
	// swagger:operation DELETE /repos/{owner}/{repo}/issues/comments/{id}/reactions issue issueDeleteCommentReaction
 | 
						|
	// ---
 | 
						|
	// summary: Remove a reaction from a comment of an issue
 | 
						|
	// consumes:
 | 
						|
	// - application/json
 | 
						|
	// produces:
 | 
						|
	// - application/json
 | 
						|
	// parameters:
 | 
						|
	// - name: owner
 | 
						|
	//   in: path
 | 
						|
	//   description: owner of the repo
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// - name: repo
 | 
						|
	//   in: path
 | 
						|
	//   description: name of the repo
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// - name: id
 | 
						|
	//   in: path
 | 
						|
	//   description: id of the comment to edit
 | 
						|
	//   type: integer
 | 
						|
	//   format: int64
 | 
						|
	//   required: true
 | 
						|
	// - name: content
 | 
						|
	//   in: body
 | 
						|
	//   schema:
 | 
						|
	//     "$ref": "#/definitions/EditReactionOption"
 | 
						|
	// responses:
 | 
						|
	//   "200":
 | 
						|
	//     "$ref": "#/responses/empty"
 | 
						|
	//   "403":
 | 
						|
	//     "$ref": "#/responses/forbidden"
 | 
						|
 | 
						|
	form := web.GetForm(ctx).(*api.EditReactionOption)
 | 
						|
 | 
						|
	changeIssueCommentReaction(ctx, *form, false)
 | 
						|
}
 | 
						|
 | 
						|
func changeIssueCommentReaction(ctx *context.APIContext, form api.EditReactionOption, isCreateType bool) {
 | 
						|
	comment, err := models.GetCommentByID(ctx.ParamsInt64(":id"))
 | 
						|
	if err != nil {
 | 
						|
		if models.IsErrCommentNotExist(err) {
 | 
						|
			ctx.NotFound(err)
 | 
						|
		} else {
 | 
						|
			ctx.Error(http.StatusInternalServerError, "GetCommentByID", err)
 | 
						|
		}
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	err = comment.LoadIssue()
 | 
						|
	if err != nil {
 | 
						|
		ctx.Error(http.StatusInternalServerError, "comment.LoadIssue() failed", err)
 | 
						|
	}
 | 
						|
 | 
						|
	if comment.Issue.IsLocked && !ctx.Repo.CanWriteIssuesOrPulls(comment.Issue.IsPull) {
 | 
						|
		ctx.Error(http.StatusForbidden, "ChangeIssueCommentReaction", errors.New("no permission to change reaction"))
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	if isCreateType {
 | 
						|
		// PostIssueCommentReaction part
 | 
						|
		reaction, err := models.CreateCommentReaction(ctx.User, comment.Issue, comment, form.Reaction)
 | 
						|
		if err != nil {
 | 
						|
			if models.IsErrForbiddenIssueReaction(err) {
 | 
						|
				ctx.Error(http.StatusForbidden, err.Error(), err)
 | 
						|
			} else if models.IsErrReactionAlreadyExist(err) {
 | 
						|
				ctx.JSON(http.StatusOK, api.Reaction{
 | 
						|
					User:     convert.ToUser(ctx.User, true, true),
 | 
						|
					Reaction: reaction.Type,
 | 
						|
					Created:  reaction.CreatedUnix.AsTime(),
 | 
						|
				})
 | 
						|
			} else {
 | 
						|
				ctx.Error(http.StatusInternalServerError, "CreateCommentReaction", err)
 | 
						|
			}
 | 
						|
			return
 | 
						|
		}
 | 
						|
 | 
						|
		ctx.JSON(http.StatusCreated, api.Reaction{
 | 
						|
			User:     convert.ToUser(ctx.User, true, true),
 | 
						|
			Reaction: reaction.Type,
 | 
						|
			Created:  reaction.CreatedUnix.AsTime(),
 | 
						|
		})
 | 
						|
	} else {
 | 
						|
		// DeleteIssueCommentReaction part
 | 
						|
		err = models.DeleteCommentReaction(ctx.User, comment.Issue, comment, form.Reaction)
 | 
						|
		if err != nil {
 | 
						|
			ctx.Error(http.StatusInternalServerError, "DeleteCommentReaction", err)
 | 
						|
			return
 | 
						|
		}
 | 
						|
		//ToDo respond 204
 | 
						|
		ctx.Status(http.StatusOK)
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
// GetIssueReactions list reactions of an issue
 | 
						|
func GetIssueReactions(ctx *context.APIContext) {
 | 
						|
	// swagger:operation GET /repos/{owner}/{repo}/issues/{index}/reactions issue issueGetIssueReactions
 | 
						|
	// ---
 | 
						|
	// summary: Get a list reactions of an issue
 | 
						|
	// consumes:
 | 
						|
	// - application/json
 | 
						|
	// produces:
 | 
						|
	// - application/json
 | 
						|
	// parameters:
 | 
						|
	// - name: owner
 | 
						|
	//   in: path
 | 
						|
	//   description: owner of the repo
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// - name: repo
 | 
						|
	//   in: path
 | 
						|
	//   description: name of the repo
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// - name: index
 | 
						|
	//   in: path
 | 
						|
	//   description: index of the issue
 | 
						|
	//   type: integer
 | 
						|
	//   format: int64
 | 
						|
	//   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/ReactionList"
 | 
						|
	//   "403":
 | 
						|
	//     "$ref": "#/responses/forbidden"
 | 
						|
 | 
						|
	issue, err := models.GetIssueWithAttrsByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index"))
 | 
						|
	if err != nil {
 | 
						|
		if models.IsErrIssueNotExist(err) {
 | 
						|
			ctx.NotFound()
 | 
						|
		} else {
 | 
						|
			ctx.Error(http.StatusInternalServerError, "GetIssueByIndex", err)
 | 
						|
		}
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	if !ctx.Repo.CanReadIssuesOrPulls(issue.IsPull) {
 | 
						|
		ctx.Error(http.StatusForbidden, "GetIssueReactions", errors.New("no permission to get reactions"))
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	reactions, err := models.FindIssueReactions(issue, utils.GetListOptions(ctx))
 | 
						|
	if err != nil {
 | 
						|
		ctx.Error(http.StatusInternalServerError, "FindIssueReactions", err)
 | 
						|
		return
 | 
						|
	}
 | 
						|
	_, err = reactions.LoadUsers(ctx.Repo.Repository)
 | 
						|
	if err != nil {
 | 
						|
		ctx.Error(http.StatusInternalServerError, "ReactionList.LoadUsers()", err)
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	var result []api.Reaction
 | 
						|
	for _, r := range reactions {
 | 
						|
		result = append(result, api.Reaction{
 | 
						|
			User:     convert.ToUser(r.User, ctx.IsSigned, false),
 | 
						|
			Reaction: r.Type,
 | 
						|
			Created:  r.CreatedUnix.AsTime(),
 | 
						|
		})
 | 
						|
	}
 | 
						|
 | 
						|
	ctx.JSON(http.StatusOK, result)
 | 
						|
}
 | 
						|
 | 
						|
// PostIssueReaction add a reaction to an issue
 | 
						|
func PostIssueReaction(ctx *context.APIContext) {
 | 
						|
	// swagger:operation POST /repos/{owner}/{repo}/issues/{index}/reactions issue issuePostIssueReaction
 | 
						|
	// ---
 | 
						|
	// summary: Add a reaction to an issue
 | 
						|
	// consumes:
 | 
						|
	// - application/json
 | 
						|
	// produces:
 | 
						|
	// - application/json
 | 
						|
	// parameters:
 | 
						|
	// - name: owner
 | 
						|
	//   in: path
 | 
						|
	//   description: owner of the repo
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// - name: repo
 | 
						|
	//   in: path
 | 
						|
	//   description: name of the repo
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// - name: index
 | 
						|
	//   in: path
 | 
						|
	//   description: index of the issue
 | 
						|
	//   type: integer
 | 
						|
	//   format: int64
 | 
						|
	//   required: true
 | 
						|
	// - name: content
 | 
						|
	//   in: body
 | 
						|
	//   schema:
 | 
						|
	//     "$ref": "#/definitions/EditReactionOption"
 | 
						|
	// responses:
 | 
						|
	//   "200":
 | 
						|
	//     "$ref": "#/responses/Reaction"
 | 
						|
	//   "201":
 | 
						|
	//     "$ref": "#/responses/Reaction"
 | 
						|
	//   "403":
 | 
						|
	//     "$ref": "#/responses/forbidden"
 | 
						|
	form := web.GetForm(ctx).(*api.EditReactionOption)
 | 
						|
	changeIssueReaction(ctx, *form, true)
 | 
						|
}
 | 
						|
 | 
						|
// DeleteIssueReaction remove a reaction from an issue
 | 
						|
func DeleteIssueReaction(ctx *context.APIContext) {
 | 
						|
	// swagger:operation DELETE /repos/{owner}/{repo}/issues/{index}/reactions issue issueDeleteIssueReaction
 | 
						|
	// ---
 | 
						|
	// summary: Remove a reaction from an issue
 | 
						|
	// consumes:
 | 
						|
	// - application/json
 | 
						|
	// produces:
 | 
						|
	// - application/json
 | 
						|
	// parameters:
 | 
						|
	// - name: owner
 | 
						|
	//   in: path
 | 
						|
	//   description: owner of the repo
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// - name: repo
 | 
						|
	//   in: path
 | 
						|
	//   description: name of the repo
 | 
						|
	//   type: string
 | 
						|
	//   required: true
 | 
						|
	// - name: index
 | 
						|
	//   in: path
 | 
						|
	//   description: index of the issue
 | 
						|
	//   type: integer
 | 
						|
	//   format: int64
 | 
						|
	//   required: true
 | 
						|
	// - name: content
 | 
						|
	//   in: body
 | 
						|
	//   schema:
 | 
						|
	//     "$ref": "#/definitions/EditReactionOption"
 | 
						|
	// responses:
 | 
						|
	//   "200":
 | 
						|
	//     "$ref": "#/responses/empty"
 | 
						|
	//   "403":
 | 
						|
	//     "$ref": "#/responses/forbidden"
 | 
						|
	form := web.GetForm(ctx).(*api.EditReactionOption)
 | 
						|
	changeIssueReaction(ctx, *form, false)
 | 
						|
}
 | 
						|
 | 
						|
func changeIssueReaction(ctx *context.APIContext, form api.EditReactionOption, isCreateType bool) {
 | 
						|
	issue, err := models.GetIssueWithAttrsByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index"))
 | 
						|
	if err != nil {
 | 
						|
		if models.IsErrIssueNotExist(err) {
 | 
						|
			ctx.NotFound()
 | 
						|
		} else {
 | 
						|
			ctx.Error(http.StatusInternalServerError, "GetIssueByIndex", err)
 | 
						|
		}
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	if issue.IsLocked && !ctx.Repo.CanWriteIssuesOrPulls(issue.IsPull) {
 | 
						|
		ctx.Error(http.StatusForbidden, "ChangeIssueCommentReaction", errors.New("no permission to change reaction"))
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	if isCreateType {
 | 
						|
		// PostIssueReaction part
 | 
						|
		reaction, err := models.CreateIssueReaction(ctx.User, issue, form.Reaction)
 | 
						|
		if err != nil {
 | 
						|
			if models.IsErrForbiddenIssueReaction(err) {
 | 
						|
				ctx.Error(http.StatusForbidden, err.Error(), err)
 | 
						|
			} else if models.IsErrReactionAlreadyExist(err) {
 | 
						|
				ctx.JSON(http.StatusOK, api.Reaction{
 | 
						|
					User:     convert.ToUser(ctx.User, true, true),
 | 
						|
					Reaction: reaction.Type,
 | 
						|
					Created:  reaction.CreatedUnix.AsTime(),
 | 
						|
				})
 | 
						|
			} else {
 | 
						|
				ctx.Error(http.StatusInternalServerError, "CreateCommentReaction", err)
 | 
						|
			}
 | 
						|
			return
 | 
						|
		}
 | 
						|
 | 
						|
		ctx.JSON(http.StatusCreated, api.Reaction{
 | 
						|
			User:     convert.ToUser(ctx.User, true, true),
 | 
						|
			Reaction: reaction.Type,
 | 
						|
			Created:  reaction.CreatedUnix.AsTime(),
 | 
						|
		})
 | 
						|
	} else {
 | 
						|
		// DeleteIssueReaction part
 | 
						|
		err = models.DeleteIssueReaction(ctx.User, issue, form.Reaction)
 | 
						|
		if err != nil {
 | 
						|
			ctx.Error(http.StatusInternalServerError, "DeleteIssueReaction", err)
 | 
						|
			return
 | 
						|
		}
 | 
						|
		//ToDo respond 204
 | 
						|
		ctx.Status(http.StatusOK)
 | 
						|
	}
 | 
						|
}
 |