gin/gin.go

480 lines
15 KiB
Go
Raw Normal View History

2014-08-29 17:49:50 +00:00
// Copyright 2014 Manu Martinez-Almeida. All rights reserved.
// Use of this source code is governed by a MIT style
// license that can be found in the LICENSE file.
2014-06-17 23:42:34 +00:00
package gin
import (
"fmt"
2014-06-17 23:42:34 +00:00
"html/template"
2015-05-18 22:45:08 +00:00
"net"
2014-06-17 23:42:34 +00:00
"net/http"
2015-05-18 22:45:08 +00:00
"os"
"path"
2014-07-06 19:09:23 +00:00
"sync"
2015-03-23 03:41:29 +00:00
"github.com/gin-gonic/gin/render"
2014-06-17 23:42:34 +00:00
)
const defaultMultipartMemory = 32 << 20 // 32 MB
2015-05-22 14:55:16 +00:00
2017-09-28 14:54:37 +00:00
var (
default404Body = []byte("404 page not found")
default405Body = []byte("405 method not allowed")
defaultAppEngine bool
)
2014-06-17 23:42:34 +00:00
// HandlerFunc defines the handler used by gin middleware as return value.
2015-06-26 14:05:09 +00:00
type HandlerFunc func(*Context)
// HandlersChain defines a HandlerFunc array.
2015-06-26 14:05:09 +00:00
type HandlersChain []HandlerFunc
// Last returns the last handler in the chain. ie. the last handler is the main own.
2015-06-26 14:05:09 +00:00
func (c HandlersChain) Last() HandlerFunc {
if length := len(c); length > 0 {
2015-06-26 14:05:09 +00:00
return c[length-1]
}
return nil
}
// RouteInfo represents a request route's specification which contains method and path and its handler.
2017-07-05 07:47:36 +00:00
type RouteInfo struct {
Method string
Path string
Handler string
HandlerFunc HandlerFunc
2017-07-05 07:47:36 +00:00
}
2014-06-17 23:42:34 +00:00
// RoutesInfo defines a RouteInfo array.
2017-07-05 07:47:36 +00:00
type RoutesInfo []RouteInfo
// Engine is the framework's instance, it contains the muxer, middleware and configuration settings.
// Create an instance of Engine, by using New() or Default()
type Engine struct {
RouterGroup
// Enables automatic redirection if the current route can't be matched but a
// handler for the path with (without) the trailing slash exists.
// For example if /foo/ is requested but a route only exists for /foo, the
// client is redirected to /foo with http status code 301 for GET requests
// and 307 for all other request methods.
RedirectTrailingSlash bool
// If enabled, the router tries to fix the current request path, if no
// handle is registered for it.
// First superfluous path elements like ../ or // are removed.
// Afterwards the router does a case-insensitive lookup of the cleaned path.
// If a handle can be found for this route, the router makes a redirection
// to the corrected path with status code 301 for GET requests and 307 for
// all other request methods.
// For example /FOO and /..//Foo could be redirected to /foo.
// RedirectTrailingSlash is independent of this option.
RedirectFixedPath bool
// If enabled, the router checks if another method is allowed for the
// current route, if the current request can not be routed.
// If this is the case, the request is answered with 'Method Not Allowed'
// and HTTP status code 405.
// If no other Method is allowed, the request is delegated to the NotFound
// handler.
HandleMethodNotAllowed bool
ForwardedByClientIP bool
// #726 #755 If enabled, it will thrust some headers starting with
// 'X-AppEngine...' for better integration with that PaaS.
AppEngine bool
// If enabled, the url.RawPath will be used to find parameters.
UseRawPath bool
2017-09-28 14:54:37 +00:00
2017-07-05 07:47:36 +00:00
// If true, the path value will be unescaped.
// If UseRawPath is false (by default), the UnescapePathValues effectively is true,
// as url.Path gonna be used, which is already unescaped.
UnescapePathValues bool
// Value of 'maxMemory' param that is given to http.Request's ParseMultipartForm
// method call.
MaxMultipartMemory int64
delims render.Delims
secureJsonPrefix string
HTMLRender render.HTMLRender
FuncMap template.FuncMap
allNoRoute HandlersChain
allNoMethod HandlersChain
noRoute HandlersChain
noMethod HandlersChain
pool sync.Pool
trees methodTrees
2017-07-05 07:47:36 +00:00
}
2014-06-17 23:42:34 +00:00
var _ IRouter = &Engine{}
2015-06-26 14:01:35 +00:00
// New returns a new blank Engine instance without any middleware attached.
// By default the configuration is:
// - RedirectTrailingSlash: true
// - RedirectFixedPath: false
// - HandleMethodNotAllowed: false
// - ForwardedByClientIP: true
// - UseRawPath: false
// - UnescapePathValues: true
2014-07-06 19:09:23 +00:00
func New() *Engine {
debugPrintWARNINGNew()
2015-03-31 19:39:06 +00:00
engine := &Engine{
2015-04-07 10:22:38 +00:00
RouterGroup: RouterGroup{
Handlers: nil,
basePath: "/",
2015-06-10 23:02:38 +00:00
root: true,
2015-04-07 10:22:38 +00:00
},
FuncMap: template.FuncMap{},
2015-03-31 19:39:06 +00:00
RedirectTrailingSlash: true,
RedirectFixedPath: false,
HandleMethodNotAllowed: false,
2015-06-07 11:51:13 +00:00
ForwardedByClientIP: true,
2016-12-05 10:21:59 +00:00
AppEngine: defaultAppEngine,
UseRawPath: false,
UnescapePathValues: true,
MaxMultipartMemory: defaultMultipartMemory,
2015-06-07 11:51:13 +00:00
trees: make(methodTrees, 0, 9),
delims: render.Delims{Left: "{{", Right: "}}"},
secureJsonPrefix: "while(1);",
2015-03-31 19:39:06 +00:00
}
2015-04-07 10:22:38 +00:00
engine.RouterGroup.engine = engine
2014-10-08 19:37:26 +00:00
engine.pool.New = func() interface{} {
2015-03-25 18:33:17 +00:00
return engine.allocateContext()
}
2014-06-17 23:42:34 +00:00
return engine
}
// Default returns an Engine instance with the Logger and Recovery middleware already attached.
2014-06-17 23:42:34 +00:00
func Default() *Engine {
debugPrintWARNINGDefault()
2014-06-17 23:42:34 +00:00
engine := New()
engine.Use(Logger(), Recovery())
2014-06-17 23:42:34 +00:00
return engine
}
2015-06-07 11:51:13 +00:00
func (engine *Engine) allocateContext() *Context {
return &Context{engine: engine}
2015-03-25 18:33:17 +00:00
}
// Delims sets template left and right delims and returns a Engine instance.
func (engine *Engine) Delims(left, right string) *Engine {
engine.delims = render.Delims{Left: left, Right: right}
return engine
}
// SecureJsonPrefix sets the secureJsonPrefix used in Context.SecureJSON.
func (engine *Engine) SecureJsonPrefix(prefix string) *Engine {
engine.secureJsonPrefix = prefix
return engine
}
// LoadHTMLGlob loads HTML files identified by glob pattern
// and associates the result with HTML renderer.
2014-07-15 15:41:56 +00:00
func (engine *Engine) LoadHTMLGlob(pattern string) {
2017-09-28 14:54:37 +00:00
left := engine.delims.Left
right := engine.delims.Right
2018-07-02 03:06:56 +00:00
templ := template.Must(template.New("").Delims(left, right).Funcs(engine.FuncMap).ParseGlob(pattern))
2017-09-28 14:54:37 +00:00
2014-10-08 19:37:26 +00:00
if IsDebugging() {
2018-07-02 03:06:56 +00:00
debugPrintLoadTemplate(templ)
engine.HTMLRender = render.HTMLDebug{Glob: pattern, FuncMap: engine.FuncMap, Delims: engine.delims}
return
2014-08-20 23:04:35 +00:00
}
2017-07-19 12:49:18 +00:00
engine.SetHTMLTemplate(templ)
2014-07-15 15:41:56 +00:00
}
// LoadHTMLFiles loads a slice of HTML files
// and associates the result with HTML renderer.
2014-07-15 15:41:56 +00:00
func (engine *Engine) LoadHTMLFiles(files ...string) {
2014-10-08 19:37:26 +00:00
if IsDebugging() {
engine.HTMLRender = render.HTMLDebug{Files: files, FuncMap: engine.FuncMap, Delims: engine.delims}
return
2014-08-20 23:04:35 +00:00
}
2017-07-19 12:49:18 +00:00
templ := template.Must(template.New("").Delims(engine.delims.Left, engine.delims.Right).Funcs(engine.FuncMap).ParseFiles(files...))
engine.SetHTMLTemplate(templ)
2014-08-20 23:04:35 +00:00
}
// SetHTMLTemplate associate a template with HTML renderer.
2014-08-20 23:04:35 +00:00
func (engine *Engine) SetHTMLTemplate(templ *template.Template) {
2015-06-12 16:09:44 +00:00
if len(engine.trees) > 0 {
debugPrintWARNINGSetHTMLTemplate()
2015-06-12 16:09:44 +00:00
}
engine.HTMLRender = render.HTMLProduction{Template: templ.Funcs(engine.FuncMap)}
}
// SetFuncMap sets the FuncMap used for template.FuncMap.
func (engine *Engine) SetFuncMap(funcMap template.FuncMap) {
engine.FuncMap = funcMap
2014-06-17 23:42:34 +00:00
}
2016-04-14 23:16:46 +00:00
// NoRoute adds handlers for NoRoute. It return a 404 code by default.
2014-07-17 21:42:23 +00:00
func (engine *Engine) NoRoute(handlers ...HandlerFunc) {
2014-07-17 22:29:44 +00:00
engine.noRoute = handlers
2014-10-08 19:37:26 +00:00
engine.rebuild404Handlers()
2014-07-17 22:29:44 +00:00
}
2017-08-16 03:55:50 +00:00
// NoMethod sets the handlers called when... TODO.
func (engine *Engine) NoMethod(handlers ...HandlerFunc) {
engine.noMethod = handlers
engine.rebuild405Handlers()
}
// Use attaches a global middleware to the router. ie. the middleware attached though Use() will be
2015-05-29 19:03:41 +00:00
// included in the handlers chain for every single request. Even 404, 405, static files...
// For example, this is the right place for a logger or error management middleware.
func (engine *Engine) Use(middleware ...HandlerFunc) IRoutes {
engine.RouterGroup.Use(middleware...)
2014-10-08 19:37:26 +00:00
engine.rebuild404Handlers()
engine.rebuild405Handlers()
2015-06-10 23:02:38 +00:00
return engine
2014-10-08 19:37:26 +00:00
}
func (engine *Engine) rebuild404Handlers() {
2015-03-25 15:53:58 +00:00
engine.allNoRoute = engine.combineHandlers(engine.noRoute)
}
func (engine *Engine) rebuild405Handlers() {
2015-03-25 15:53:58 +00:00
engine.allNoMethod = engine.combineHandlers(engine.noMethod)
2014-06-17 23:42:34 +00:00
}
2015-05-19 21:22:35 +00:00
func (engine *Engine) addRoute(method, path string, handlers HandlersChain) {
2016-01-27 23:35:09 +00:00
assert1(path[0] == '/', "path must begin with '/'")
2017-09-28 16:22:35 +00:00
assert1(method != "", "HTTP method can not be empty")
2016-01-27 23:35:09 +00:00
assert1(len(handlers) > 0, "there must be at least one handler")
2015-04-09 10:15:02 +00:00
2016-01-27 23:35:09 +00:00
debugPrintRoute(method, path, handlers)
2015-06-03 23:54:36 +00:00
root := engine.trees.get(method)
2015-03-31 19:39:06 +00:00
if root == nil {
root = new(node)
root.fullPath = "/"
2016-01-27 23:35:09 +00:00
engine.trees = append(engine.trees, methodTree{method: method, root: root})
2015-03-31 19:39:06 +00:00
}
root.addRoute(path, handlers)
}
// Routes returns a slice of registered routes, including some useful information, such as:
// the http method, path and the handler name.
2015-06-18 15:17:22 +00:00
func (engine *Engine) Routes() (routes RoutesInfo) {
2015-06-07 02:20:39 +00:00
for _, tree := range engine.trees {
routes = iterate("", tree.method, routes, tree.root)
2015-06-07 02:20:39 +00:00
}
return routes
}
2015-06-18 15:17:22 +00:00
func iterate(path, method string, routes RoutesInfo, root *node) RoutesInfo {
2015-06-07 02:20:39 +00:00
path += root.path
if len(root.handlers) > 0 {
handlerFunc := root.handlers.Last()
routes = append(routes, RouteInfo{
Method: method,
Path: path,
Handler: nameOfFunction(handlerFunc),
HandlerFunc: handlerFunc,
})
2015-06-07 02:20:39 +00:00
}
2015-07-02 16:42:33 +00:00
for _, child := range root.children {
routes = iterate(path, method, routes, child)
2015-06-07 02:20:39 +00:00
}
return routes
}
// Run attaches the router to a http.Server and starts listening and serving HTTP requests.
2015-05-29 19:03:41 +00:00
// It is a shortcut for http.ListenAndServe(addr, router)
// Note: this method will block the calling goroutine indefinitely unless an error happens.
func (engine *Engine) Run(addr ...string) (err error) {
2015-05-18 22:45:08 +00:00
defer func() { debugPrintError(err) }()
2015-05-09 01:34:43 +00:00
address := resolveAddress(addr)
debugPrint("Listening and serving HTTP on %s\n", address)
err = http.ListenAndServe(address, engine)
2015-05-09 01:34:43 +00:00
return
2015-04-07 10:22:38 +00:00
}
// RunTLS attaches the router to a http.Server and starts listening and serving HTTPS (secure) requests.
2015-05-29 19:03:41 +00:00
// It is a shortcut for http.ListenAndServeTLS(addr, certFile, keyFile, router)
// Note: this method will block the calling goroutine indefinitely unless an error happens.
func (engine *Engine) RunTLS(addr, certFile, keyFile string) (err error) {
2015-04-07 10:22:38 +00:00
debugPrint("Listening and serving HTTPS on %s\n", addr)
2015-05-18 22:45:08 +00:00
defer func() { debugPrintError(err) }()
2015-05-09 01:34:43 +00:00
err = http.ListenAndServeTLS(addr, certFile, keyFile, engine)
2015-05-09 01:34:43 +00:00
return
2015-04-07 10:22:38 +00:00
}
// RunUnix attaches the router to a http.Server and starts listening and serving HTTP requests
// through the specified unix socket (ie. a file).
// Note: this method will block the calling goroutine indefinitely unless an error happens.
2015-05-18 22:45:08 +00:00
func (engine *Engine) RunUnix(file string) (err error) {
debugPrint("Listening and serving HTTP on unix:/%s", file)
defer func() { debugPrintError(err) }()
os.Remove(file)
2015-05-18 22:48:19 +00:00
listener, err := net.Listen("unix", file)
2015-05-18 22:45:08 +00:00
if err != nil {
return
}
defer listener.Close()
os.Chmod(file, 0777)
2015-05-18 22:45:08 +00:00
err = http.Serve(listener, engine)
return
}
// RunFd attaches the router to a http.Server and starts listening and serving HTTP requests
// through the specified file descriptor.
// Note: this method will block the calling goroutine indefinitely unless an error happens.
func (engine *Engine) RunFd(fd int) (err error) {
debugPrint("Listening and serving HTTP on fd@%d", fd)
defer func() { debugPrintError(err) }()
f := os.NewFile(uintptr(fd), fmt.Sprintf("fd@%d", fd))
listener, err := net.FileListener(f)
if err != nil {
return
}
defer listener.Close()
err = http.Serve(listener, engine)
return
}
2017-07-06 01:28:16 +00:00
// ServeHTTP conforms to the http.Handler interface.
2015-03-31 19:39:06 +00:00
func (engine *Engine) ServeHTTP(w http.ResponseWriter, req *http.Request) {
2015-05-18 18:50:46 +00:00
c := engine.pool.Get().(*Context)
c.writermem.reset(w)
c.Request = req
c.reset()
2015-04-07 10:22:38 +00:00
2015-05-28 01:22:34 +00:00
engine.handleHTTPRequest(c)
2015-05-18 18:50:46 +00:00
engine.pool.Put(c)
2015-04-07 10:22:38 +00:00
}
2017-07-06 01:28:16 +00:00
// HandleContext re-enter a context that has been rewritten.
// This can be done by setting c.Request.URL.Path to your new target.
// Disclaimer: You can loop yourself to death with this, use wisely.
func (engine *Engine) HandleContext(c *Context) {
oldIndexValue := c.index
c.reset()
engine.handleHTTPRequest(c)
c.index = oldIndexValue
}
2017-09-28 14:54:37 +00:00
func (engine *Engine) handleHTTPRequest(c *Context) {
httpMethod := c.Request.Method
rPath := c.Request.URL.Path
unescape := false
2017-09-28 14:54:37 +00:00
if engine.UseRawPath && len(c.Request.URL.RawPath) > 0 {
rPath = c.Request.URL.RawPath
unescape = engine.UnescapePathValues
}
rPath = cleanPath(rPath)
2015-04-07 10:22:38 +00:00
// Find root of the tree for the given HTTP method
2015-05-29 19:03:28 +00:00
t := engine.trees
for i, tl := 0, len(t); i < tl; i++ {
if t[i].method != httpMethod {
continue
}
root := t[i].root
// Find route in tree
value := root.getValue(rPath, c.Params, unescape)
if value.handlers != nil {
c.handlers = value.handlers
c.Params = value.params
c.fullPath = value.fullPath
c.Next()
c.writermem.WriteHeaderNow()
return
}
if httpMethod != "CONNECT" && rPath != "/" {
if value.tsr && engine.RedirectTrailingSlash {
redirectTrailingSlash(c)
2015-04-07 10:22:38 +00:00
return
2017-06-13 03:36:05 +00:00
}
if engine.RedirectFixedPath && redirectFixedPath(c, root, engine.RedirectFixedPath) {
return
2015-04-07 10:22:38 +00:00
}
2015-03-31 19:39:06 +00:00
}
break
2015-03-31 19:39:06 +00:00
}
2015-04-07 10:22:38 +00:00
if engine.HandleMethodNotAllowed {
2015-05-29 19:03:28 +00:00
for _, tree := range engine.trees {
if tree.method == httpMethod {
continue
}
if value := tree.root.getValue(rPath, nil, unescape); value.handlers != nil {
c.handlers = engine.allNoMethod
serveError(c, http.StatusMethodNotAllowed, default405Body)
return
2015-04-07 10:22:38 +00:00
}
}
}
2017-09-28 14:54:37 +00:00
c.handlers = engine.allNoRoute
serveError(c, http.StatusNotFound, default404Body)
2014-06-17 23:42:34 +00:00
}
var mimePlain = []string{MIMEPlain}
func serveError(c *Context, code int, defaultMessage []byte) {
c.writermem.status = code
c.Next()
if c.writermem.Written() {
return
}
if c.writermem.Status() == code {
c.writermem.Header()["Content-Type"] = mimePlain
2019-01-18 01:32:53 +00:00
_, err := c.Writer.Write(defaultMessage)
if err != nil {
debugPrint("cannot write message to writer during serve error: %v", err)
}
return
}
c.writermem.WriteHeaderNow()
return
}
func redirectTrailingSlash(c *Context) {
2015-04-07 10:22:38 +00:00
req := c.Request
p := req.URL.Path
if prefix := path.Clean(c.Request.Header.Get("X-Forwarded-Prefix")); prefix != "." {
p = prefix + "/" + req.URL.Path
}
code := http.StatusMovedPermanently // Permanent redirect, request with GET method
2015-04-07 10:22:38 +00:00
if req.Method != "GET" {
code = http.StatusTemporaryRedirect
2015-04-07 10:22:38 +00:00
}
req.URL.Path = p + "/"
if length := len(p); length > 1 && p[length-1] == '/' {
req.URL.Path = p[:length-1]
}
debugPrint("redirecting request %d: %s --> %s", code, p, req.URL.String())
http.Redirect(c.Writer, req, req.URL.String(), code)
c.writermem.WriteHeaderNow()
}
func redirectFixedPath(c *Context, root *node, trailingSlash bool) bool {
req := c.Request
rPath := req.URL.Path
if fixedPath, ok := root.findCaseInsensitivePath(cleanPath(rPath), trailingSlash); ok {
code := http.StatusMovedPermanently // Permanent redirect, request with GET method
if req.Method != "GET" {
code = http.StatusTemporaryRedirect
2015-04-07 10:22:38 +00:00
}
req.URL.Path = string(fixedPath)
debugPrint("redirecting request %d: %s --> %s", code, rPath, req.URL.String())
2015-04-07 10:22:38 +00:00
http.Redirect(c.Writer, req, req.URL.String(), code)
2015-05-05 14:37:33 +00:00
c.writermem.WriteHeaderNow()
2015-04-07 10:22:38 +00:00
return true
}
return false
2014-06-17 23:42:34 +00:00
}