mirror of https://github.com/gin-gonic/gin.git
140 lines
3.5 KiB
Go
140 lines
3.5 KiB
Go
// 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 (
|
|
"github.com/gin-gonic/gin/render"
|
|
"github.com/julienschmidt/httprouter"
|
|
"html/template"
|
|
"math"
|
|
"net/http"
|
|
"sync"
|
|
)
|
|
|
|
const (
|
|
AbortIndex = math.MaxInt8 / 2
|
|
MIMEJSON = "application/json"
|
|
MIMEHTML = "text/html"
|
|
MIMEXML = "application/xml"
|
|
MIMEXML2 = "text/xml"
|
|
MIMEPlain = "text/plain"
|
|
MIMEPOSTForm = "application/x-www-form-urlencoded"
|
|
)
|
|
|
|
type (
|
|
HandlerFunc func(*Context)
|
|
|
|
// Represents the web framework, it wraps the blazing fast httprouter multiplexer and a list of global middlewares.
|
|
Engine struct {
|
|
*RouterGroup
|
|
HTMLRender render.Render
|
|
pool sync.Pool
|
|
allNoRoute []HandlerFunc
|
|
noRoute []HandlerFunc
|
|
router *httprouter.Router
|
|
}
|
|
)
|
|
|
|
func (engine *Engine) handle404(w http.ResponseWriter, req *http.Request) {
|
|
c := engine.createContext(w, req, nil, engine.allNoRoute)
|
|
// set 404 by default, useful for logging
|
|
c.Writer.WriteHeader(404)
|
|
c.Next()
|
|
if !c.Writer.Written() {
|
|
if c.Writer.Status() == 404 {
|
|
c.Data(-1, MIMEPlain, []byte("404 page not found"))
|
|
} else {
|
|
c.Writer.WriteHeaderNow()
|
|
}
|
|
}
|
|
engine.reuseContext(c)
|
|
}
|
|
|
|
// Returns a new blank Engine instance without any middleware attached.
|
|
// The most basic configuration
|
|
func New() *Engine {
|
|
engine := &Engine{}
|
|
engine.RouterGroup = &RouterGroup{
|
|
Handlers: nil,
|
|
absolutePath: "/",
|
|
engine: engine,
|
|
}
|
|
engine.router = httprouter.New()
|
|
engine.router.NotFound = engine.handle404
|
|
engine.pool.New = func() interface{} {
|
|
c := &Context{Engine: engine}
|
|
c.Writer = &c.writermem
|
|
return c
|
|
}
|
|
return engine
|
|
}
|
|
|
|
// Returns a Engine instance with the Logger and Recovery already attached.
|
|
func Default() *Engine {
|
|
engine := New()
|
|
engine.Use(Recovery(), Logger())
|
|
return engine
|
|
}
|
|
|
|
func (engine *Engine) LoadHTMLGlob(pattern string) {
|
|
if IsDebugging() {
|
|
render.HTMLDebug.AddGlob(pattern)
|
|
engine.HTMLRender = render.HTMLDebug
|
|
} else {
|
|
templ := template.Must(template.ParseGlob(pattern))
|
|
engine.SetHTMLTemplate(templ)
|
|
}
|
|
}
|
|
|
|
func (engine *Engine) LoadHTMLFiles(files ...string) {
|
|
if IsDebugging() {
|
|
render.HTMLDebug.AddFiles(files...)
|
|
engine.HTMLRender = render.HTMLDebug
|
|
} else {
|
|
templ := template.Must(template.ParseFiles(files...))
|
|
engine.SetHTMLTemplate(templ)
|
|
}
|
|
}
|
|
|
|
func (engine *Engine) SetHTMLTemplate(templ *template.Template) {
|
|
engine.HTMLRender = render.HTMLRender{
|
|
Template: templ,
|
|
}
|
|
}
|
|
|
|
// Adds handlers for NoRoute. It return a 404 code by default.
|
|
func (engine *Engine) NoRoute(handlers ...HandlerFunc) {
|
|
engine.noRoute = handlers
|
|
engine.rebuild404Handlers()
|
|
}
|
|
|
|
func (engine *Engine) Use(middlewares ...HandlerFunc) {
|
|
engine.RouterGroup.Use(middlewares...)
|
|
engine.rebuild404Handlers()
|
|
}
|
|
|
|
func (engine *Engine) rebuild404Handlers() {
|
|
engine.allNoRoute = engine.combineHandlers(engine.noRoute)
|
|
}
|
|
|
|
// ServeHTTP makes the router implement the http.Handler interface.
|
|
func (engine *Engine) ServeHTTP(writer http.ResponseWriter, request *http.Request) {
|
|
engine.router.ServeHTTP(writer, request)
|
|
}
|
|
|
|
func (engine *Engine) Run(addr string) {
|
|
debugPrint("Listening and serving HTTP on %s", addr)
|
|
if err := http.ListenAndServe(addr, engine); err != nil {
|
|
panic(err)
|
|
}
|
|
}
|
|
|
|
func (engine *Engine) RunTLS(addr string, cert string, key string) {
|
|
debugPrint("Listening and serving HTTPS on %s", addr)
|
|
if err := http.ListenAndServeTLS(addr, cert, key, engine); err != nil {
|
|
panic(err)
|
|
}
|
|
}
|