mirror of
https://github.com/astaxie/beego.git
synced 2024-11-27 07:41:27 +00:00
263 lines
6.8 KiB
Go
263 lines
6.8 KiB
Go
// Copyright 2014 beego Author. All Rights Reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
// Package context provide the context utils
|
|
// Usage:
|
|
//
|
|
// import "github.com/astaxie/beego/context"
|
|
//
|
|
// ctx := context.Context{Request:req,ResponseWriter:rw}
|
|
//
|
|
// more docs http://beego.me/docs/module/context.md
|
|
package context
|
|
|
|
import (
|
|
"bufio"
|
|
"crypto/hmac"
|
|
"crypto/sha256"
|
|
"encoding/base64"
|
|
"errors"
|
|
"fmt"
|
|
"net"
|
|
"net/http"
|
|
"strconv"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/astaxie/beego/core/utils"
|
|
)
|
|
|
|
// Commonly used mime-types
|
|
const (
|
|
ApplicationJSON = "application/json"
|
|
ApplicationXML = "application/xml"
|
|
ApplicationYAML = "application/x-yaml"
|
|
TextXML = "text/xml"
|
|
)
|
|
|
|
// NewContext return the Context with Input and Output
|
|
func NewContext() *Context {
|
|
return &Context{
|
|
Input: NewInput(),
|
|
Output: NewOutput(),
|
|
}
|
|
}
|
|
|
|
// Context Http request context struct including BeegoInput, BeegoOutput, http.Request and http.ResponseWriter.
|
|
// BeegoInput and BeegoOutput provides an api to operate request and response more easily.
|
|
type Context struct {
|
|
Input *BeegoInput
|
|
Output *BeegoOutput
|
|
Request *http.Request
|
|
ResponseWriter *Response
|
|
_xsrfToken string
|
|
}
|
|
|
|
// Reset initializes Context, BeegoInput and BeegoOutput
|
|
func (ctx *Context) Reset(rw http.ResponseWriter, r *http.Request) {
|
|
ctx.Request = r
|
|
if ctx.ResponseWriter == nil {
|
|
ctx.ResponseWriter = &Response{}
|
|
}
|
|
ctx.ResponseWriter.reset(rw)
|
|
ctx.Input.Reset(ctx)
|
|
ctx.Output.Reset(ctx)
|
|
ctx._xsrfToken = ""
|
|
}
|
|
|
|
// Redirect redirects to localurl with http header status code.
|
|
func (ctx *Context) Redirect(status int, localurl string) {
|
|
http.Redirect(ctx.ResponseWriter, ctx.Request, localurl, status)
|
|
}
|
|
|
|
// Abort stops the request.
|
|
// If beego.ErrorMaps exists, panic body.
|
|
func (ctx *Context) Abort(status int, body string) {
|
|
ctx.Output.SetStatus(status)
|
|
panic(body)
|
|
}
|
|
|
|
// WriteString writes a string to response body.
|
|
func (ctx *Context) WriteString(content string) {
|
|
ctx.ResponseWriter.Write([]byte(content))
|
|
}
|
|
|
|
// GetCookie gets a cookie from a request for a given key.
|
|
// (Alias of BeegoInput.Cookie)
|
|
func (ctx *Context) GetCookie(key string) string {
|
|
return ctx.Input.Cookie(key)
|
|
}
|
|
|
|
// SetCookie sets a cookie for a response.
|
|
// (Alias of BeegoOutput.Cookie)
|
|
func (ctx *Context) SetCookie(name string, value string, others ...interface{}) {
|
|
ctx.Output.Cookie(name, value, others...)
|
|
}
|
|
|
|
// GetSecureCookie gets a secure cookie from a request for a given key.
|
|
func (ctx *Context) GetSecureCookie(Secret, key string) (string, bool) {
|
|
val := ctx.Input.Cookie(key)
|
|
if val == "" {
|
|
return "", false
|
|
}
|
|
|
|
parts := strings.SplitN(val, "|", 3)
|
|
|
|
if len(parts) != 3 {
|
|
return "", false
|
|
}
|
|
|
|
vs := parts[0]
|
|
timestamp := parts[1]
|
|
sig := parts[2]
|
|
|
|
h := hmac.New(sha256.New, []byte(Secret))
|
|
fmt.Fprintf(h, "%s%s", vs, timestamp)
|
|
|
|
if fmt.Sprintf("%02x", h.Sum(nil)) != sig {
|
|
return "", false
|
|
}
|
|
res, _ := base64.URLEncoding.DecodeString(vs)
|
|
return string(res), true
|
|
}
|
|
|
|
// SetSecureCookie sets a secure cookie for a response.
|
|
func (ctx *Context) SetSecureCookie(Secret, name, value string, others ...interface{}) {
|
|
vs := base64.URLEncoding.EncodeToString([]byte(value))
|
|
timestamp := strconv.FormatInt(time.Now().UnixNano(), 10)
|
|
h := hmac.New(sha256.New, []byte(Secret))
|
|
fmt.Fprintf(h, "%s%s", vs, timestamp)
|
|
sig := fmt.Sprintf("%02x", h.Sum(nil))
|
|
cookie := strings.Join([]string{vs, timestamp, sig}, "|")
|
|
ctx.Output.Cookie(name, cookie, others...)
|
|
}
|
|
|
|
// XSRFToken creates and returns an xsrf token string
|
|
func (ctx *Context) XSRFToken(key string, expire int64) string {
|
|
if ctx._xsrfToken == "" {
|
|
token, ok := ctx.GetSecureCookie(key, "_xsrf")
|
|
if !ok {
|
|
token = string(utils.RandomCreateBytes(32))
|
|
ctx.SetSecureCookie(key, "_xsrf", token, expire, "", "", true, true)
|
|
}
|
|
ctx._xsrfToken = token
|
|
}
|
|
return ctx._xsrfToken
|
|
}
|
|
|
|
// CheckXSRFCookie checks if the XSRF token in this request is valid or not.
|
|
// The token can be provided in the request header in the form "X-Xsrftoken" or "X-CsrfToken"
|
|
// or in form field value named as "_xsrf".
|
|
func (ctx *Context) CheckXSRFCookie() bool {
|
|
token := ctx.Input.Query("_xsrf")
|
|
if token == "" {
|
|
token = ctx.Request.Header.Get("X-Xsrftoken")
|
|
}
|
|
if token == "" {
|
|
token = ctx.Request.Header.Get("X-Csrftoken")
|
|
}
|
|
if token == "" {
|
|
ctx.Abort(422, "422")
|
|
return false
|
|
}
|
|
if ctx._xsrfToken != token {
|
|
ctx.Abort(417, "417")
|
|
return false
|
|
}
|
|
return true
|
|
}
|
|
|
|
// RenderMethodResult renders the return value of a controller method to the output
|
|
func (ctx *Context) RenderMethodResult(result interface{}) {
|
|
if result != nil {
|
|
renderer, ok := result.(Renderer)
|
|
if !ok {
|
|
err, ok := result.(error)
|
|
if ok {
|
|
renderer = errorRenderer(err)
|
|
} else {
|
|
renderer = jsonRenderer(result)
|
|
}
|
|
}
|
|
renderer.Render(ctx)
|
|
}
|
|
}
|
|
|
|
// Response is a wrapper for the http.ResponseWriter
|
|
// Started: if true, response was already written to so the other handler will not be executed
|
|
type Response struct {
|
|
http.ResponseWriter
|
|
Started bool
|
|
Status int
|
|
Elapsed time.Duration
|
|
}
|
|
|
|
func (r *Response) reset(rw http.ResponseWriter) {
|
|
r.ResponseWriter = rw
|
|
r.Status = 0
|
|
r.Started = false
|
|
}
|
|
|
|
// Write writes the data to the connection as part of a HTTP reply,
|
|
// and sets `Started` to true.
|
|
// Started: if true, the response was already sent
|
|
func (r *Response) Write(p []byte) (int, error) {
|
|
r.Started = true
|
|
return r.ResponseWriter.Write(p)
|
|
}
|
|
|
|
// WriteHeader sends a HTTP response header with status code,
|
|
// and sets `Started` to true.
|
|
func (r *Response) WriteHeader(code int) {
|
|
if r.Status > 0 {
|
|
//prevent multiple response.WriteHeader calls
|
|
return
|
|
}
|
|
r.Status = code
|
|
r.Started = true
|
|
r.ResponseWriter.WriteHeader(code)
|
|
}
|
|
|
|
// Hijack hijacker for http
|
|
func (r *Response) Hijack() (net.Conn, *bufio.ReadWriter, error) {
|
|
hj, ok := r.ResponseWriter.(http.Hijacker)
|
|
if !ok {
|
|
return nil, nil, errors.New("webserver doesn't support hijacking")
|
|
}
|
|
return hj.Hijack()
|
|
}
|
|
|
|
// Flush http.Flusher
|
|
func (r *Response) Flush() {
|
|
if f, ok := r.ResponseWriter.(http.Flusher); ok {
|
|
f.Flush()
|
|
}
|
|
}
|
|
|
|
// CloseNotify http.CloseNotifier
|
|
func (r *Response) CloseNotify() <-chan bool {
|
|
if cn, ok := r.ResponseWriter.(http.CloseNotifier); ok {
|
|
return cn.CloseNotify()
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// Pusher http.Pusher
|
|
func (r *Response) Pusher() (pusher http.Pusher) {
|
|
if pusher, ok := r.ResponseWriter.(http.Pusher); ok {
|
|
return pusher
|
|
}
|
|
return nil
|
|
}
|