mirror of
				https://github.com/go-gitea/gitea
				synced 2025-11-03 21:08:25 +00:00 
			
		
		
		
	Move macaron to chi (#14293)
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>
This commit is contained in:
		@@ -6,18 +6,21 @@
 | 
			
		||||
package context
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"context"
 | 
			
		||||
	"fmt"
 | 
			
		||||
	"html"
 | 
			
		||||
	"net/http"
 | 
			
		||||
	"net/url"
 | 
			
		||||
	"strings"
 | 
			
		||||
 | 
			
		||||
	"code.gitea.io/gitea/models"
 | 
			
		||||
	"code.gitea.io/gitea/modules/auth/sso"
 | 
			
		||||
	"code.gitea.io/gitea/modules/git"
 | 
			
		||||
	"code.gitea.io/gitea/modules/log"
 | 
			
		||||
	"code.gitea.io/gitea/modules/middlewares"
 | 
			
		||||
	"code.gitea.io/gitea/modules/setting"
 | 
			
		||||
 | 
			
		||||
	"gitea.com/macaron/csrf"
 | 
			
		||||
	"gitea.com/macaron/macaron"
 | 
			
		||||
	"gitea.com/go-chi/session"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// APIContext is a specific macaron context for API service
 | 
			
		||||
@@ -91,7 +94,7 @@ func (ctx *APIContext) Error(status int, title string, obj interface{}) {
 | 
			
		||||
	if status == http.StatusInternalServerError {
 | 
			
		||||
		log.ErrorWithSkip(1, "%s: %s", title, message)
 | 
			
		||||
 | 
			
		||||
		if macaron.Env == macaron.PROD && !(ctx.User != nil && ctx.User.IsAdmin) {
 | 
			
		||||
		if setting.IsProd() && !(ctx.User != nil && ctx.User.IsAdmin) {
 | 
			
		||||
			message = ""
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
@@ -108,7 +111,7 @@ func (ctx *APIContext) InternalServerError(err error) {
 | 
			
		||||
	log.ErrorWithSkip(1, "InternalServerError: %v", err)
 | 
			
		||||
 | 
			
		||||
	var message string
 | 
			
		||||
	if macaron.Env != macaron.PROD || (ctx.User != nil && ctx.User.IsAdmin) {
 | 
			
		||||
	if !setting.IsProd() || (ctx.User != nil && ctx.User.IsAdmin) {
 | 
			
		||||
		message = err.Error()
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
@@ -118,6 +121,20 @@ func (ctx *APIContext) InternalServerError(err error) {
 | 
			
		||||
	})
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
var (
 | 
			
		||||
	apiContextKey interface{} = "default_api_context"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// WithAPIContext set up api context in request
 | 
			
		||||
func WithAPIContext(req *http.Request, ctx *APIContext) *http.Request {
 | 
			
		||||
	return req.WithContext(context.WithValue(req.Context(), apiContextKey, ctx))
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// GetAPIContext returns a context for API routes
 | 
			
		||||
func GetAPIContext(req *http.Request) *APIContext {
 | 
			
		||||
	return req.Context().Value(apiContextKey).(*APIContext)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func genAPILinks(curURL *url.URL, total, pageSize, curPage int) []string {
 | 
			
		||||
	page := NewPagination(total, pageSize, curPage, 0)
 | 
			
		||||
	paginater := page.Paginater
 | 
			
		||||
@@ -172,7 +189,7 @@ func (ctx *APIContext) RequireCSRF() {
 | 
			
		||||
	headerToken := ctx.Req.Header.Get(ctx.csrf.GetHeaderName())
 | 
			
		||||
	formValueToken := ctx.Req.FormValue(ctx.csrf.GetFormName())
 | 
			
		||||
	if len(headerToken) > 0 || len(formValueToken) > 0 {
 | 
			
		||||
		csrf.Validate(ctx.Context.Context, ctx.csrf)
 | 
			
		||||
		Validate(ctx.Context, ctx.csrf)
 | 
			
		||||
	} else {
 | 
			
		||||
		ctx.Context.Error(401, "Missing CSRF token.")
 | 
			
		||||
	}
 | 
			
		||||
@@ -201,42 +218,91 @@ func (ctx *APIContext) CheckForOTP() {
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// APIContexter returns apicontext as macaron middleware
 | 
			
		||||
func APIContexter() macaron.Handler {
 | 
			
		||||
	return func(c *Context) {
 | 
			
		||||
		ctx := &APIContext{
 | 
			
		||||
			Context: c,
 | 
			
		||||
		}
 | 
			
		||||
		c.Map(ctx)
 | 
			
		||||
func APIContexter() func(http.Handler) http.Handler {
 | 
			
		||||
	var csrfOpts = getCsrfOpts()
 | 
			
		||||
 | 
			
		||||
	return func(next http.Handler) http.Handler {
 | 
			
		||||
 | 
			
		||||
		return http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
 | 
			
		||||
			var locale = middlewares.Locale(w, req)
 | 
			
		||||
			var ctx = APIContext{
 | 
			
		||||
				Context: &Context{
 | 
			
		||||
					Resp:    NewResponse(w),
 | 
			
		||||
					Data:    map[string]interface{}{},
 | 
			
		||||
					Locale:  locale,
 | 
			
		||||
					Session: session.GetSession(req),
 | 
			
		||||
					Repo: &Repository{
 | 
			
		||||
						PullRequest: &PullRequest{},
 | 
			
		||||
					},
 | 
			
		||||
					Org: &Organization{},
 | 
			
		||||
				},
 | 
			
		||||
				Org: &APIOrganization{},
 | 
			
		||||
			}
 | 
			
		||||
 | 
			
		||||
			ctx.Req = WithAPIContext(WithContext(req, ctx.Context), &ctx)
 | 
			
		||||
			ctx.csrf = Csrfer(csrfOpts, ctx.Context)
 | 
			
		||||
 | 
			
		||||
			// If request sends files, parse them here otherwise the Query() can't be parsed and the CsrfToken will be invalid.
 | 
			
		||||
			if ctx.Req.Method == "POST" && strings.Contains(ctx.Req.Header.Get("Content-Type"), "multipart/form-data") {
 | 
			
		||||
				if err := ctx.Req.ParseMultipartForm(setting.Attachment.MaxSize << 20); err != nil && !strings.Contains(err.Error(), "EOF") { // 32MB max size
 | 
			
		||||
					ctx.InternalServerError(err)
 | 
			
		||||
					return
 | 
			
		||||
				}
 | 
			
		||||
			}
 | 
			
		||||
 | 
			
		||||
			// Get user from session if logged in.
 | 
			
		||||
			ctx.User, ctx.IsBasicAuth = sso.SignedInUser(ctx.Req, ctx.Resp, &ctx, ctx.Session)
 | 
			
		||||
			if ctx.User != nil {
 | 
			
		||||
				ctx.IsSigned = true
 | 
			
		||||
				ctx.Data["IsSigned"] = ctx.IsSigned
 | 
			
		||||
				ctx.Data["SignedUser"] = ctx.User
 | 
			
		||||
				ctx.Data["SignedUserID"] = ctx.User.ID
 | 
			
		||||
				ctx.Data["SignedUserName"] = ctx.User.Name
 | 
			
		||||
				ctx.Data["IsAdmin"] = ctx.User.IsAdmin
 | 
			
		||||
			} else {
 | 
			
		||||
				ctx.Data["SignedUserID"] = int64(0)
 | 
			
		||||
				ctx.Data["SignedUserName"] = ""
 | 
			
		||||
			}
 | 
			
		||||
 | 
			
		||||
			ctx.Resp.Header().Set(`X-Frame-Options`, `SAMEORIGIN`)
 | 
			
		||||
 | 
			
		||||
			ctx.Data["CsrfToken"] = html.EscapeString(ctx.csrf.GetToken())
 | 
			
		||||
 | 
			
		||||
			next.ServeHTTP(ctx.Resp, ctx.Req)
 | 
			
		||||
		})
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// ReferencesGitRepo injects the GitRepo into the Context
 | 
			
		||||
func ReferencesGitRepo(allowEmpty bool) macaron.Handler {
 | 
			
		||||
	return func(ctx *APIContext) {
 | 
			
		||||
		// Empty repository does not have reference information.
 | 
			
		||||
		if !allowEmpty && ctx.Repo.Repository.IsEmpty {
 | 
			
		||||
			return
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		// For API calls.
 | 
			
		||||
		if ctx.Repo.GitRepo == nil {
 | 
			
		||||
			repoPath := models.RepoPath(ctx.Repo.Owner.Name, ctx.Repo.Repository.Name)
 | 
			
		||||
			gitRepo, err := git.OpenRepository(repoPath)
 | 
			
		||||
			if err != nil {
 | 
			
		||||
				ctx.Error(500, "RepoRef Invalid repo "+repoPath, err)
 | 
			
		||||
func ReferencesGitRepo(allowEmpty bool) func(http.Handler) http.Handler {
 | 
			
		||||
	return func(next http.Handler) http.Handler {
 | 
			
		||||
		return http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
 | 
			
		||||
			ctx := GetAPIContext(req)
 | 
			
		||||
			// Empty repository does not have reference information.
 | 
			
		||||
			if !allowEmpty && ctx.Repo.Repository.IsEmpty {
 | 
			
		||||
				return
 | 
			
		||||
			}
 | 
			
		||||
			ctx.Repo.GitRepo = gitRepo
 | 
			
		||||
			// We opened it, we should close it
 | 
			
		||||
			defer func() {
 | 
			
		||||
				// If it's been set to nil then assume someone else has closed it.
 | 
			
		||||
				if ctx.Repo.GitRepo != nil {
 | 
			
		||||
					ctx.Repo.GitRepo.Close()
 | 
			
		||||
				}
 | 
			
		||||
			}()
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		ctx.Next()
 | 
			
		||||
			// For API calls.
 | 
			
		||||
			if ctx.Repo.GitRepo == nil {
 | 
			
		||||
				repoPath := models.RepoPath(ctx.Repo.Owner.Name, ctx.Repo.Repository.Name)
 | 
			
		||||
				gitRepo, err := git.OpenRepository(repoPath)
 | 
			
		||||
				if err != nil {
 | 
			
		||||
					ctx.Error(500, "RepoRef Invalid repo "+repoPath, err)
 | 
			
		||||
					return
 | 
			
		||||
				}
 | 
			
		||||
				ctx.Repo.GitRepo = gitRepo
 | 
			
		||||
				// We opened it, we should close it
 | 
			
		||||
				defer func() {
 | 
			
		||||
					// If it's been set to nil then assume someone else has closed it.
 | 
			
		||||
					if ctx.Repo.GitRepo != nil {
 | 
			
		||||
						ctx.Repo.GitRepo.Close()
 | 
			
		||||
					}
 | 
			
		||||
				}()
 | 
			
		||||
			}
 | 
			
		||||
 | 
			
		||||
			next.ServeHTTP(w, req)
 | 
			
		||||
		})
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
@@ -266,8 +332,9 @@ func (ctx *APIContext) NotFound(objs ...interface{}) {
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// RepoRefForAPI handles repository reference names when the ref name is not explicitly given
 | 
			
		||||
func RepoRefForAPI() macaron.Handler {
 | 
			
		||||
	return func(ctx *APIContext) {
 | 
			
		||||
func RepoRefForAPI(next http.Handler) http.Handler {
 | 
			
		||||
	return http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
 | 
			
		||||
		ctx := GetAPIContext(req)
 | 
			
		||||
		// Empty repository does not have reference information.
 | 
			
		||||
		if ctx.Repo.Repository.IsEmpty {
 | 
			
		||||
			return
 | 
			
		||||
@@ -319,6 +386,6 @@ func RepoRefForAPI() macaron.Handler {
 | 
			
		||||
			return
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		ctx.Next()
 | 
			
		||||
	}
 | 
			
		||||
		next.ServeHTTP(w, req)
 | 
			
		||||
	})
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user