aboutsummaryrefslogtreecommitdiffstats
path: root/routers/private/internal.go
diff options
context:
space:
mode:
authorLunny Xiao <xiaolunwen@gmail.com>2021-01-26 23:36:53 +0800
committerGitHub <noreply@github.com>2021-01-26 16:36:53 +0100
commit6433ba0ec3dfde67f45267aa12bd713c4a44c740 (patch)
tree8813388f7e58ff23ad24af9ccbdb5f0350cb3a09 /routers/private/internal.go
parent3adbbb4255c42cde04d59b6ebf5ead7e3edda3e7 (diff)
downloadgitea-6433ba0ec3dfde67f45267aa12bd713c4a44c740.tar.gz
gitea-6433ba0ec3dfde67f45267aa12bd713c4a44c740.zip
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>
Diffstat (limited to 'routers/private/internal.go')
-rw-r--r--routers/private/internal.go82
1 files changed, 52 insertions, 30 deletions
diff --git a/routers/private/internal.go b/routers/private/internal.go
index 4fb267a49a..e541591a38 100644
--- a/routers/private/internal.go
+++ b/routers/private/internal.go
@@ -6,47 +6,69 @@
package private
import (
+ "net/http"
+ "reflect"
"strings"
+ "code.gitea.io/gitea/modules/context"
"code.gitea.io/gitea/modules/log"
"code.gitea.io/gitea/modules/private"
"code.gitea.io/gitea/modules/setting"
+ "code.gitea.io/gitea/modules/web"
- "gitea.com/macaron/binding"
- "gitea.com/macaron/macaron"
+ "gitea.com/go-chi/binding"
)
// CheckInternalToken check internal token is set
-func CheckInternalToken(ctx *macaron.Context) {
- tokens := ctx.Req.Header.Get("Authorization")
- fields := strings.Fields(tokens)
- if len(fields) != 2 || fields[0] != "Bearer" || fields[1] != setting.InternalToken {
- log.Debug("Forbidden attempt to access internal url: Authorization header: %s", tokens)
- ctx.Error(403)
+func CheckInternalToken(next http.Handler) http.Handler {
+ return http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
+ tokens := req.Header.Get("Authorization")
+ fields := strings.Fields(tokens)
+ if len(fields) != 2 || fields[0] != "Bearer" || fields[1] != setting.InternalToken {
+ log.Debug("Forbidden attempt to access internal url: Authorization header: %s", tokens)
+ http.Error(w, http.StatusText(http.StatusForbidden), http.StatusForbidden)
+ } else {
+ next.ServeHTTP(w, req)
+ }
+ })
+}
+
+// bind binding an obj to a handler
+func bind(obj interface{}) http.HandlerFunc {
+ var tp = reflect.TypeOf(obj)
+ for tp.Kind() == reflect.Ptr {
+ tp = tp.Elem()
}
+ return web.Wrap(func(ctx *context.PrivateContext) {
+ var theObj = reflect.New(tp).Interface() // create a new form obj for every request but not use obj directly
+ binding.Bind(ctx.Req, theObj)
+ web.SetForm(ctx, theObj)
+ })
}
-// RegisterRoutes registers all internal APIs routes to web application.
+// Routes registers all internal APIs routes to web application.
// These APIs will be invoked by internal commands for example `gitea serv` and etc.
-func RegisterRoutes(m *macaron.Macaron) {
- bind := binding.Bind
-
- m.Group("/", func() {
- m.Post("/ssh/authorized_keys", AuthorizedPublicKeyByContent)
- m.Post("/ssh/:id/update/:repoid", UpdatePublicKeyInRepo)
- m.Post("/hook/pre-receive/:owner/:repo", bind(private.HookOptions{}), HookPreReceive)
- m.Post("/hook/post-receive/:owner/:repo", bind(private.HookOptions{}), HookPostReceive)
- m.Post("/hook/set-default-branch/:owner/:repo/:branch", SetDefaultBranch)
- m.Get("/serv/none/:keyid", ServNoCommand)
- m.Get("/serv/command/:keyid/:owner/:repo", ServCommand)
- m.Post("/manager/shutdown", Shutdown)
- m.Post("/manager/restart", Restart)
- m.Post("/manager/flush-queues", bind(private.FlushOptions{}), FlushQueues)
- m.Post("/manager/pause-logging", PauseLogging)
- m.Post("/manager/resume-logging", ResumeLogging)
- m.Post("/manager/release-and-reopen-logging", ReleaseReopenLogging)
- m.Post("/manager/add-logger", bind(private.LoggerOptions{}), AddLogger)
- m.Post("/manager/remove-logger/:group/:name", RemoveLogger)
- m.Post("/mail/send", SendEmail)
- }, CheckInternalToken)
+func Routes() *web.Route {
+ var r = web.NewRoute()
+ r.Use(context.PrivateContexter())
+ r.Use(CheckInternalToken)
+
+ r.Post("/ssh/authorized_keys", AuthorizedPublicKeyByContent)
+ r.Post("/ssh/{id}/update/{repoid}", UpdatePublicKeyInRepo)
+ r.Post("/hook/pre-receive/{owner}/{repo}", bind(private.HookOptions{}), HookPreReceive)
+ r.Post("/hook/post-receive/{owner}/{repo}", bind(private.HookOptions{}), HookPostReceive)
+ r.Post("/hook/set-default-branch/{owner}/{repo}/{branch}", SetDefaultBranch)
+ r.Get("/serv/none/{keyid}", ServNoCommand)
+ r.Get("/serv/command/{keyid}/{owner}/{repo}", ServCommand)
+ r.Post("/manager/shutdown", Shutdown)
+ r.Post("/manager/restart", Restart)
+ r.Post("/manager/flush-queues", bind(private.FlushOptions{}), FlushQueues)
+ r.Post("/manager/pause-logging", PauseLogging)
+ r.Post("/manager/resume-logging", ResumeLogging)
+ r.Post("/manager/release-and-reopen-logging", ReleaseReopenLogging)
+ r.Post("/manager/add-logger", bind(private.LoggerOptions{}), AddLogger)
+ r.Post("/manager/remove-logger/{group}/{name}", RemoveLogger)
+ r.Post("/mail/send", SendEmail)
+
+ return r
}