vikunja-api/vendor/github.com/labstack/echo/v4/group.go

125 lines
4.3 KiB
Go
Raw Normal View History

2018-06-10 11:11:41 +02:00
package echo
import (
2019-03-24 10:13:40 +01:00
"net/http"
2018-06-10 11:11:41 +02:00
)
type (
// Group is a set of sub-routes for a specified route. It can be used for inner
// routes that share a common middleware or functionality that should be separate
// from the parent echo instance while still inheriting from it.
Group struct {
2019-05-07 21:42:24 +02:00
common
host string
2018-06-10 11:11:41 +02:00
prefix string
middleware []MiddlewareFunc
echo *Echo
}
)
// Use implements `Echo#Use()` for sub-routes within the Group.
func (g *Group) Use(middleware ...MiddlewareFunc) {
g.middleware = append(g.middleware, middleware...)
2019-05-07 21:42:24 +02:00
if len(g.middleware) == 0 {
return
}
2018-06-10 11:11:41 +02:00
// Allow all requests to reach the group as they might get dropped if router
// doesn't find a match, making none of the group middleware process.
2019-05-07 21:42:24 +02:00
g.Any("", NotFoundHandler)
g.Any("/*", NotFoundHandler)
2018-06-10 11:11:41 +02:00
}
// CONNECT implements `Echo#CONNECT()` for sub-routes within the Group.
2018-11-03 16:05:45 +01:00
func (g *Group) CONNECT(path string, h HandlerFunc, m ...MiddlewareFunc) *Route {
2019-03-24 10:13:40 +01:00
return g.Add(http.MethodConnect, path, h, m...)
2018-06-10 11:11:41 +02:00
}
// DELETE implements `Echo#DELETE()` for sub-routes within the Group.
2018-11-03 16:05:45 +01:00
func (g *Group) DELETE(path string, h HandlerFunc, m ...MiddlewareFunc) *Route {
2019-03-24 10:13:40 +01:00
return g.Add(http.MethodDelete, path, h, m...)
2018-06-10 11:11:41 +02:00
}
// GET implements `Echo#GET()` for sub-routes within the Group.
2018-11-03 16:05:45 +01:00
func (g *Group) GET(path string, h HandlerFunc, m ...MiddlewareFunc) *Route {
2019-03-24 10:13:40 +01:00
return g.Add(http.MethodGet, path, h, m...)
2018-06-10 11:11:41 +02:00
}
// HEAD implements `Echo#HEAD()` for sub-routes within the Group.
2018-11-03 16:05:45 +01:00
func (g *Group) HEAD(path string, h HandlerFunc, m ...MiddlewareFunc) *Route {
2019-03-24 10:13:40 +01:00
return g.Add(http.MethodHead, path, h, m...)
2018-06-10 11:11:41 +02:00
}
// OPTIONS implements `Echo#OPTIONS()` for sub-routes within the Group.
2018-11-03 16:05:45 +01:00
func (g *Group) OPTIONS(path string, h HandlerFunc, m ...MiddlewareFunc) *Route {
2019-03-24 10:13:40 +01:00
return g.Add(http.MethodOptions, path, h, m...)
2018-06-10 11:11:41 +02:00
}
// PATCH implements `Echo#PATCH()` for sub-routes within the Group.
2018-11-03 16:05:45 +01:00
func (g *Group) PATCH(path string, h HandlerFunc, m ...MiddlewareFunc) *Route {
2019-03-24 10:13:40 +01:00
return g.Add(http.MethodPatch, path, h, m...)
2018-06-10 11:11:41 +02:00
}
// POST implements `Echo#POST()` for sub-routes within the Group.
2018-11-03 16:05:45 +01:00
func (g *Group) POST(path string, h HandlerFunc, m ...MiddlewareFunc) *Route {
2019-03-24 10:13:40 +01:00
return g.Add(http.MethodPost, path, h, m...)
2018-06-10 11:11:41 +02:00
}
// PUT implements `Echo#PUT()` for sub-routes within the Group.
2018-11-03 16:05:45 +01:00
func (g *Group) PUT(path string, h HandlerFunc, m ...MiddlewareFunc) *Route {
2019-03-24 10:13:40 +01:00
return g.Add(http.MethodPut, path, h, m...)
2018-06-10 11:11:41 +02:00
}
// TRACE implements `Echo#TRACE()` for sub-routes within the Group.
2018-11-03 16:05:45 +01:00
func (g *Group) TRACE(path string, h HandlerFunc, m ...MiddlewareFunc) *Route {
2019-03-24 10:13:40 +01:00
return g.Add(http.MethodTrace, path, h, m...)
2018-06-10 11:11:41 +02:00
}
// Any implements `Echo#Any()` for sub-routes within the Group.
2018-11-03 16:05:45 +01:00
func (g *Group) Any(path string, handler HandlerFunc, middleware ...MiddlewareFunc) []*Route {
routes := make([]*Route, len(methods))
for i, m := range methods {
routes[i] = g.Add(m, path, handler, middleware...)
2018-06-10 11:11:41 +02:00
}
2018-11-03 16:05:45 +01:00
return routes
2018-06-10 11:11:41 +02:00
}
// Match implements `Echo#Match()` for sub-routes within the Group.
2018-11-03 16:05:45 +01:00
func (g *Group) Match(methods []string, path string, handler HandlerFunc, middleware ...MiddlewareFunc) []*Route {
routes := make([]*Route, len(methods))
for i, m := range methods {
routes[i] = g.Add(m, path, handler, middleware...)
2018-06-10 11:11:41 +02:00
}
2018-11-03 16:05:45 +01:00
return routes
2018-06-10 11:11:41 +02:00
}
// Group creates a new sub-group with prefix and optional sub-group-level middleware.
2019-05-07 21:42:24 +02:00
func (g *Group) Group(prefix string, middleware ...MiddlewareFunc) (sg *Group) {
2018-11-03 16:05:45 +01:00
m := make([]MiddlewareFunc, 0, len(g.middleware)+len(middleware))
2018-06-10 11:11:41 +02:00
m = append(m, g.middleware...)
m = append(m, middleware...)
2019-05-07 21:42:24 +02:00
sg = g.echo.Group(g.prefix+prefix, m...)
sg.host = g.host
return
2018-06-10 11:11:41 +02:00
}
// Static implements `Echo#Static()` for sub-routes within the Group.
func (g *Group) Static(prefix, root string) {
2019-05-07 21:42:24 +02:00
g.static(prefix, root, g.GET)
2018-06-10 11:11:41 +02:00
}
// File implements `Echo#File()` for sub-routes within the Group.
func (g *Group) File(path, file string) {
2019-05-07 21:42:24 +02:00
g.file(g.prefix+path, file, g.GET)
2018-06-10 11:11:41 +02:00
}
2018-11-03 16:05:45 +01:00
// Add implements `Echo#Add()` for sub-routes within the Group.
func (g *Group) Add(method, path string, handler HandlerFunc, middleware ...MiddlewareFunc) *Route {
2018-06-10 11:11:41 +02:00
// Combine into a new slice to avoid accidentally passing the same slice for
// multiple routes, which would lead to later add() calls overwriting the
// middleware from earlier calls.
2018-11-03 16:05:45 +01:00
m := make([]MiddlewareFunc, 0, len(g.middleware)+len(middleware))
2018-06-10 11:11:41 +02:00
m = append(m, g.middleware...)
m = append(m, middleware...)
2019-05-07 21:42:24 +02:00
return g.echo.add(g.host, method, g.prefix+path, handler, m...)
2018-06-10 11:11:41 +02:00
}