gin/context.go

564 lines
16 KiB
Go
Raw Normal View History

2014-08-29 21:49:50 +04: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.
package gin
import (
"errors"
2015-05-12 19:33:41 +03:00
"io"
2015-03-26 16:07:01 +03:00
"math"
"net"
"net/http"
"net/url"
"strings"
"time"
2015-03-23 06:39:53 +03:00
"github.com/gin-gonic/gin/binding"
"github.com/gin-gonic/gin/render"
2015-05-18 16:45:24 +03:00
"github.com/manucorporat/sse"
"golang.org/x/net/context"
)
// Content-Type MIME of the most common data formats
const (
2015-04-08 15:24:49 +03:00
MIMEJSON = binding.MIMEJSON
MIMEHTML = binding.MIMEHTML
MIMEXML = binding.MIMEXML
MIMEXML2 = binding.MIMEXML2
MIMEPlain = binding.MIMEPlain
MIMEPOSTForm = binding.MIMEPOSTForm
MIMEMultipartPOSTForm = binding.MIMEMultipartPOSTForm
)
const abortIndex int8 = math.MaxInt8 / 2
// Context is the most important part of gin. It allows us to pass variables between middleware,
// manage the flow, validate the JSON of a request and render a JSON response for example.
type Context struct {
writermem responseWriter
Request *http.Request
Writer ResponseWriter
2015-03-31 18:39:30 +03:00
2015-03-31 22:39:06 +03:00
Params Params
2015-05-07 12:30:01 +03:00
handlers HandlersChain
2015-03-31 18:39:30 +03:00
index int8
engine *Engine
2015-03-31 18:39:30 +03:00
Keys map[string]interface{}
Errors errorMsgs
Accepted []string
}
2015-05-26 17:16:57 +03:00
var _ context.Context = &Context{}
/************************************/
2014-10-08 23:37:26 +04:00
/********** CONTEXT CREATION ********/
/************************************/
2015-03-25 21:33:17 +03:00
func (c *Context) reset() {
2015-04-07 13:22:38 +03:00
c.Writer = &c.writermem
c.Params = c.Params[0:0]
c.handlers = nil
c.index = -1
2015-04-07 13:22:38 +03:00
c.Keys = nil
2014-07-18 02:29:20 +04:00
c.Errors = c.Errors[0:0]
c.Accepted = nil
2014-10-08 23:37:26 +04:00
}
// Copy returns a copy of the current context that can be safely used outside the request's scope.
// This have to be used then the context has to be passed to a goroutine.
func (c *Context) Copy() *Context {
var cp Context = *c
2015-04-09 13:15:02 +03:00
cp.writermem.ResponseWriter = nil
cp.Writer = &cp.writermem
cp.index = abortIndex
cp.handlers = nil
return &cp
}
// HandlerName returns the main handler's name. For example if the handler is "handleGetUsers()", this
2015-07-02 19:42:33 +03:00
// function will return "main.handleGetUsers"
2015-06-25 20:44:52 +03:00
func (c *Context) HandlerName() string {
return nameOfFunction(c.handlers.Last())
}
2014-10-08 23:37:26 +04:00
/************************************/
2015-05-28 04:22:34 +03:00
/*********** FLOW CONTROL ***********/
2014-10-08 23:37:26 +04:00
/************************************/
// Next should be used only inside middleware.
// It executes the pending handlers in the chain inside the calling handler.
// See example in github.
func (c *Context) Next() {
c.index++
s := int8(len(c.handlers))
for ; c.index < s; c.index++ {
c.handlers[c.index](c)
}
}
2016-03-08 08:56:46 +03:00
// IsAborted returns true if the current context was aborted.
2015-05-28 04:22:34 +03:00
func (c *Context) IsAborted() bool {
return c.index >= abortIndex
2015-05-28 04:22:34 +03:00
}
2015-10-27 20:26:05 +03:00
// Abort prevents pending handlers from being called. Note that this will not stop the current handler.
// Let's say you have an authorization middleware that validates that the current request is authorized. If the
// authorization fails (ex: the password does not match), call Abort to ensure the remaining handlers
// for this request are not called.
2014-10-08 23:37:26 +04:00
func (c *Context) Abort() {
c.index = abortIndex
}
// AbortWithStatus calls `Abort()` and writes the headers with the specified status code.
2015-05-28 04:22:34 +03:00
// For example, a failed attempt to authentificate a request could use: context.AbortWithStatus(401).
2014-10-08 23:37:26 +04:00
func (c *Context) AbortWithStatus(code int) {
2016-01-26 16:55:45 +03:00
c.Status(code)
c.Writer.WriteHeaderNow()
2014-10-08 23:37:26 +04:00
c.Abort()
}
// AbortWithError calls `AbortWithStatus()` and `Error()` internally. This method stops the chain, writes the status code and
2015-05-28 04:22:34 +03:00
// pushes the specified error to `c.Errors`.
// See Context.Error() for more details.
2015-05-22 17:39:15 +03:00
func (c *Context) AbortWithError(code int, err error) *Error {
2014-10-08 23:37:26 +04:00
c.AbortWithStatus(code)
2015-05-22 04:25:21 +03:00
return c.Error(err)
}
2014-10-08 23:37:26 +04:00
/************************************/
/********* ERROR MANAGEMENT *********/
/************************************/
// Attaches an error to the current context. The error is pushed to a list of errors.
// It's a good idea to call Error for each error that occurred during the resolution of a request.
2015-07-02 19:42:33 +03:00
// A middleware can be used to collect all the errors
// and push them to a database together, print a log, or append it in the HTTP response.
2015-05-22 17:39:15 +03:00
func (c *Context) Error(err error) *Error {
var parsedError *Error
switch err.(type) {
case *Error:
parsedError = err.(*Error)
default:
parsedError = &Error{
Err: err,
Type: ErrorTypePrivate,
}
}
2015-05-22 17:39:15 +03:00
c.Errors = append(c.Errors, parsedError)
return parsedError
}
/************************************/
/******** METADATA MANAGEMENT********/
/************************************/
2015-07-02 19:42:33 +03:00
// Set is used to store a new key/value pair exclusivelly for this context.
// It also lazy initializes c.Keys if it was not used previously.
2015-05-22 04:25:21 +03:00
func (c *Context) Set(key string, value interface{}) {
if c.Keys == nil {
c.Keys = make(map[string]interface{})
}
2015-05-22 04:25:21 +03:00
c.Keys[key] = value
}
2015-07-02 19:42:33 +03:00
// Get returns the value for the given key, ie: (value, true).
2015-05-28 04:22:34 +03:00
// If the value does not exists it returns (nil, false)
2015-05-22 04:25:21 +03:00
func (c *Context) Get(key string) (value interface{}, exists bool) {
if c.Keys != nil {
2015-05-22 04:25:21 +03:00
value, exists = c.Keys[key]
}
2015-05-22 04:25:21 +03:00
return
}
2015-05-28 04:22:34 +03:00
// Returns the value for the given key if it exists, otherwise it panics.
func (c *Context) MustGet(key string) interface{} {
2015-05-22 04:25:21 +03:00
if value, exists := c.Get(key); exists {
return value
}
2015-05-22 04:25:21 +03:00
panic("Key \"" + key + "\" does not exist")
}
/************************************/
/************ INPUT DATA ************/
/************************************/
2016-01-27 00:40:29 +03:00
// Param returns the value of the URL param.
// It is a shortcut for c.Params.ByName(key)
// router.GET("/user/:id", func(c *gin.Context) {
// // a GET request to /user/john
// id := c.Param("id") // id == "john"
// })
2015-05-26 13:35:05 +03:00
func (c *Context) Param(key string) string {
return c.Params.ByName(key)
}
// Query returns the keyed url query value if it exists,
// othewise it returns an empty string `("")`.
// It is shortcut for `c.Request.URL.Query().Get(key)`
// GET /path?id=1234&name=Manu&value=
// c.Query("id") == "1234"
// c.Query("name") == "Manu"
// c.Query("value") == ""
// c.Query("wtf") == ""
func (c *Context) Query(key string) string {
value, _ := c.GetQuery(key)
return value
}
// DefaultQuery returns the keyed url query value if it exists,
// othewise it returns the specified defaultValue string.
// See: Query() and GetQuery() for further information.
// GET /?name=Manu&lastname=
2016-01-27 00:40:29 +03:00
// c.DefaultQuery("name", "unknown") == "Manu"
// c.DefaultQuery("id", "none") == "none"
// c.DefaultQuery("lastname", "none") == ""
func (c *Context) DefaultQuery(key, defaultValue string) string {
2016-01-29 04:07:44 +03:00
if value, ok := c.GetQuery(key); ok {
return value
}
2015-05-09 04:35:31 +03:00
return defaultValue
}
// GetQuery is like Query(), it returns the keyed url query value
// if it exists `(value, true)` (even when the value is an empty string),
// othewise it returns `("", false)`.
// It is shortcut for `c.Request.URL.Query().Get(key)`
// GET /?name=Manu&lastname=
// ("Manu", true) == c.GetQuery("name")
// ("", false) == c.GetQuery("id")
// ("", true) == c.GetQuery("lastname")
2016-01-29 04:07:44 +03:00
func (c *Context) GetQuery(key string) (string, bool) {
req := c.Request
if values, ok := req.URL.Query()[key]; ok && len(values) > 0 {
return values[0], true
2014-10-09 03:40:42 +04:00
}
return "", false
}
// PostForm returns the specified key from a POST urlencoded form or multipart form
// when it exists, otherwise it returns an empty string `("")`.
func (c *Context) PostForm(key string) string {
value, _ := c.GetPostForm(key)
return value
}
// PostForm returns the specified key from a POST urlencoded form or multipart form
// when it exists, otherwise it returns the specified defaultValue string.
// See: PostForm() and GetPostForm() for further information.
func (c *Context) DefaultPostForm(key, defaultValue string) string {
if value, ok := c.GetPostForm(key); ok {
return value
}
return defaultValue
}
// GetPostForm is like PostForm(key). It returns the specified key from a POST urlencoded
// form or multipart form when it exists `(value, true)` (even when the value is an empty string),
// otherwise it returns ("", false).
// For example, during a PATCH request to update the user's email:
// email=mail@example.com --> ("mail@example.com", true) := GetPostForm("email") // set email to "mail@example.com"
// email= --> ("", true) := GetPostForm("email") // set email to ""
// --> ("", false) := GetPostForm("email") // do nothing with email
2016-01-29 04:07:44 +03:00
func (c *Context) GetPostForm(key string) (string, bool) {
req := c.Request
2015-05-26 17:16:57 +03:00
req.ParseMultipartForm(32 << 20) // 32 MB
2015-05-26 17:31:05 +03:00
if values := req.PostForm[key]; len(values) > 0 {
return values[0], true
}
2015-05-26 17:31:05 +03:00
if req.MultipartForm != nil && req.MultipartForm.File != nil {
if values := req.MultipartForm.Value[key]; len(values) > 0 {
return values[0], true
}
2015-05-26 17:16:57 +03:00
}
return "", false
2014-10-09 03:40:42 +04:00
}
2015-07-02 19:42:33 +03:00
// Bind checks the Content-Type to select a binding engine automatically,
// Depending the "Content-Type" header different bindings are used:
2016-01-27 00:40:29 +03:00
// "application/json" --> JSON binding
// "application/xml" --> XML binding
2015-07-02 19:42:33 +03:00
// otherwise --> returns an error
// It parses the request's body as JSON if Content-Type == "application/json" using JSON or XML as a JSON input.
2015-07-02 19:42:33 +03:00
// It decodes the json payload into the struct specified as a pointer.
// Like ParseBody() but this method also writes a 400 error if the json is not valid.
2015-05-22 04:25:21 +03:00
func (c *Context) Bind(obj interface{}) error {
b := binding.Default(c.Request.Method, c.ContentType())
return c.BindWith(obj, b)
}
2015-07-02 19:42:33 +03:00
// BindJSON is a shortcut for c.BindWith(obj, binding.JSON)
2015-05-22 04:25:21 +03:00
func (c *Context) BindJSON(obj interface{}) error {
return c.BindWith(obj, binding.JSON)
}
2015-07-02 19:42:33 +03:00
// BindWith binds the passed struct pointer using the specified binding engine.
// See the binding package.
2015-05-22 04:25:21 +03:00
func (c *Context) BindWith(obj interface{}, b binding.Binding) error {
if err := b.Bind(c.Request, obj); err != nil {
2015-05-22 17:39:15 +03:00
c.AbortWithError(400, err).SetType(ErrorTypeBind)
2015-05-22 04:25:21 +03:00
return err
}
2015-05-22 04:25:21 +03:00
return nil
}
2015-07-02 19:42:33 +03:00
// ClientIP implements a best effort algorithm to return the real client IP, it parses
2015-05-28 04:22:34 +03:00
// X-Real-IP and X-Forwarded-For in order to work properly with reverse-proxies such us: nginx or haproxy.
2015-03-31 18:44:45 +03:00
func (c *Context) ClientIP() string {
2015-06-07 14:51:13 +03:00
if c.engine.ForwardedByClientIP {
clientIP := strings.TrimSpace(c.requestHeader("X-Real-Ip"))
if len(clientIP) > 0 {
return clientIP
}
clientIP = c.requestHeader("X-Forwarded-For")
if index := strings.IndexByte(clientIP, ','); index >= 0 {
clientIP = clientIP[0:index]
}
clientIP = strings.TrimSpace(clientIP)
if len(clientIP) > 0 {
return clientIP
}
2014-10-09 03:40:42 +04:00
}
if ip, _, err := net.SplitHostPort(strings.TrimSpace(c.Request.RemoteAddr)); err == nil {
return ip
}
return ""
2014-10-09 03:40:42 +04:00
}
2015-07-02 19:42:33 +03:00
// ContentType returns the Content-Type header of the request.
2015-03-31 18:44:45 +03:00
func (c *Context) ContentType() string {
return filterFlags(c.requestHeader("Content-Type"))
}
func (c *Context) requestHeader(key string) string {
if values, _ := c.Request.Header[key]; len(values) > 0 {
return values[0]
}
return ""
}
2014-10-08 23:37:26 +04:00
/************************************/
/******** RESPONSE RENDERING ********/
/************************************/
2016-01-26 16:55:45 +03:00
func (c *Context) Status(code int) {
c.writermem.WriteHeader(code)
}
2015-07-02 19:42:33 +03:00
// Header is a intelligent shortcut for c.Writer.Header().Set(key, value)
// It writes a header in the response.
2015-05-28 04:22:34 +03:00
// If value == "", this method removes the header `c.Writer.Header().Del(key)`
2015-05-18 16:45:24 +03:00
func (c *Context) Header(key, value string) {
if len(value) == 0 {
c.Writer.Header().Del(key)
} else {
c.Writer.Header().Set(key, value)
}
}
2015-09-08 10:37:20 +03:00
func (c *Context) SetCookie(
name string,
value string,
maxAge int,
path string,
domain string,
secure bool,
httpOnly bool,
) {
if path == "" {
path = "/"
}
2016-01-28 02:35:09 +03:00
http.SetCookie(c.Writer, &http.Cookie{
Name: name,
Value: url.QueryEscape(value),
MaxAge: maxAge,
Path: path,
Domain: domain,
Secure: secure,
HttpOnly: httpOnly,
2016-01-28 02:35:09 +03:00
})
}
func (c *Context) Cookie(name string) (string, error) {
cookie, err := c.Request.Cookie(name)
if err != nil {
return "", err
}
val, _ := url.QueryUnescape(cookie.Value)
return val, nil
}
2015-05-18 21:51:52 +03:00
func (c *Context) Render(code int, r render.Render) {
2016-01-26 16:55:45 +03:00
c.Status(code)
2015-06-04 06:25:21 +03:00
if err := r.Render(c.Writer); err != nil {
2016-01-26 20:35:04 +03:00
panic(err)
}
}
2015-07-02 19:42:33 +03:00
// HTML renders the HTTP template specified by its file name.
// It also updates the HTTP code and sets the Content-Type as "text/html".
// See http://golang.org/doc/articles/wiki/
func (c *Context) HTML(code int, name string, obj interface{}) {
instance := c.engine.HTMLRender.Instance(name, obj)
2015-05-18 21:51:52 +03:00
c.Render(code, instance)
2015-05-06 23:31:01 +03:00
}
2015-07-02 19:42:33 +03:00
// IndentedJSON serializes the given struct as pretty JSON (indented + endlines) into the response body.
2015-05-28 04:22:34 +03:00
// It also sets the Content-Type as "application/json".
// WARNING: we recommend to use this only for development propuses since printing pretty JSON is
// more CPU and bandwidth consuming. Use Context.JSON() instead.
2015-05-06 23:31:01 +03:00
func (c *Context) IndentedJSON(code int, obj interface{}) {
2015-05-18 21:51:52 +03:00
c.Render(code, render.IndentedJSON{Data: obj})
}
2015-07-02 19:42:33 +03:00
// JSON serializes the given struct as JSON into the response body.
// It also sets the Content-Type as "application/json".
func (c *Context) JSON(code int, obj interface{}) {
2016-01-26 16:55:45 +03:00
c.Status(code)
if err := render.WriteJSON(c.Writer, obj); err != nil {
2016-01-26 20:35:04 +03:00
panic(err)
}
}
2015-07-02 19:42:33 +03:00
// XML serializes the given struct as XML into the response body.
// It also sets the Content-Type as "application/xml".
func (c *Context) XML(code int, obj interface{}) {
2015-05-18 21:51:52 +03:00
c.Render(code, render.XML{Data: obj})
}
2015-07-02 19:42:33 +03:00
// String writes the given string into the response body.
func (c *Context) String(code int, format string, values ...interface{}) {
2016-01-26 16:55:45 +03:00
c.Status(code)
render.WriteString(c.Writer, format, values)
}
2015-07-02 19:42:33 +03:00
// Redirect returns a HTTP redirect to the specific location.
func (c *Context) Redirect(code int, location string) {
2015-05-18 21:51:52 +03:00
c.Render(-1, render.Redirect{
2015-05-18 16:45:24 +03:00
Code: code,
Location: location,
Request: c.Request,
})
2014-07-29 02:48:02 +04:00
}
// Data writes some data into the body stream and updates the HTTP code.
func (c *Context) Data(code int, contentType string, data []byte) {
2015-05-18 21:51:52 +03:00
c.Render(code, render.Data{
2015-05-18 16:45:24 +03:00
ContentType: contentType,
Data: data,
})
}
2014-07-17 04:01:42 +04:00
// File writes the specified file into the body stream in a efficient way.
2014-07-17 04:01:42 +04:00
func (c *Context) File(filepath string) {
http.ServeFile(c.Writer, c.Request, filepath)
}
// SSEvent writes a Server-Sent Event into the body stream.
2015-05-12 19:33:41 +03:00
func (c *Context) SSEvent(name string, message interface{}) {
2015-05-18 21:51:52 +03:00
c.Render(-1, sse.Event{
2015-05-18 16:45:24 +03:00
Event: name,
Data: message,
})
2015-05-12 19:33:41 +03:00
}
func (c *Context) Stream(step func(w io.Writer) bool) {
2015-05-12 16:17:46 +03:00
w := c.Writer
clientGone := w.CloseNotify()
for {
select {
case <-clientGone:
return
default:
2016-01-26 17:55:30 +03:00
keepOpen := step(w)
2015-05-12 16:17:46 +03:00
w.Flush()
2016-01-26 17:55:30 +03:00
if !keepOpen {
2015-05-12 19:33:41 +03:00
return
}
2015-05-12 16:17:46 +03:00
}
}
}
/************************************/
/******** CONTENT NEGOTIATION *******/
/************************************/
2014-08-31 20:28:18 +04:00
type Negotiate struct {
Offered []string
HTMLName string
2014-08-31 20:28:18 +04:00
HTMLData interface{}
JSONData interface{}
XMLData interface{}
Data interface{}
}
2014-08-31 20:28:18 +04:00
func (c *Context) Negotiate(code int, config Negotiate) {
2014-08-31 20:41:11 +04:00
switch c.NegotiateFormat(config.Offered...) {
2015-03-31 18:51:10 +03:00
case binding.MIMEJSON:
2014-08-31 20:28:18 +04:00
data := chooseData(config.JSONData, config.Data)
c.JSON(code, data)
2015-03-31 18:51:10 +03:00
case binding.MIMEHTML:
2014-08-31 20:28:18 +04:00
data := chooseData(config.HTMLData, config.Data)
c.HTML(code, config.HTMLName, data)
2015-03-31 18:51:10 +03:00
case binding.MIMEXML:
2014-08-31 20:28:18 +04:00
data := chooseData(config.XMLData, config.Data)
c.XML(code, data)
2014-08-31 20:28:18 +04:00
default:
2015-05-22 04:25:21 +03:00
c.AbortWithError(http.StatusNotAcceptable, errors.New("the accepted formats are not offered by the server"))
}
}
func (c *Context) NegotiateFormat(offered ...string) string {
2016-01-28 02:35:09 +03:00
assert1(len(offered) > 0, "you must provide at least one offer")
if c.Accepted == nil {
c.Accepted = parseAccept(c.requestHeader("Accept"))
}
if len(c.Accepted) == 0 {
return offered[0]
}
for _, accepted := range c.Accepted {
for _, offert := range offered {
if accepted == offert {
return offert
}
}
}
return ""
}
func (c *Context) SetAccepted(formats ...string) {
c.Accepted = formats
}
2015-05-22 04:25:21 +03:00
/************************************/
2015-05-26 13:35:05 +03:00
/***** GOLANG.ORG/X/NET/CONTEXT *****/
2015-05-22 04:25:21 +03:00
/************************************/
func (c *Context) Deadline() (deadline time.Time, ok bool) {
return
}
func (c *Context) Done() <-chan struct{} {
return nil
}
func (c *Context) Err() error {
return nil
}
func (c *Context) Value(key interface{}) interface{} {
if key == 0 {
return c.Request
}
if keyAsString, ok := key.(string); ok {
val, _ := c.Get(keyAsString)
return val
}
return nil
}