Fix recovery middleware to render gitea style page. (#13857)
* Some changes to fix recovery * Move Recovery to middlewares * Remove trace code * Fix lint * add session middleware and remove dependent on macaron for sso * Fix panic 500 page rendering * Fix bugs * Fix fmt * Fix vendor * recover unnecessary change * Fix lint and addd some comments about the copied codes. * Use util.StatDir instead of com.StatDir Co-authored-by: 6543 <6543@obermui.de>
This commit is contained in:
parent
126c9331d6
commit
15a475b7db
75 changed files with 5233 additions and 307 deletions
27
vendor/github.com/unrolled/render/.gitignore
generated
vendored
Normal file
27
vendor/github.com/unrolled/render/.gitignore
generated
vendored
Normal file
|
@ -0,0 +1,27 @@
|
|||
# Compiled Object files, Static and Dynamic libs (Shared Objects)
|
||||
*.o
|
||||
*.a
|
||||
*.so
|
||||
|
||||
# Folders
|
||||
_obj
|
||||
_test
|
||||
|
||||
# Architecture specific extensions/prefixes
|
||||
*.[568vq]
|
||||
[568vq].out
|
||||
|
||||
*.cgo1.go
|
||||
*.cgo2.c
|
||||
_cgo_defun.c
|
||||
_cgo_gotypes.go
|
||||
_cgo_export.*
|
||||
|
||||
_testmain.go
|
||||
|
||||
*.exe
|
||||
*.test
|
||||
|
||||
|
||||
*.pem
|
||||
.DS_Store
|
15
vendor/github.com/unrolled/render/.travis.yml
generated
vendored
Normal file
15
vendor/github.com/unrolled/render/.travis.yml
generated
vendored
Normal file
|
@ -0,0 +1,15 @@
|
|||
language: go
|
||||
|
||||
go:
|
||||
- 1.11.x
|
||||
- 1.12.x
|
||||
- tip
|
||||
|
||||
env:
|
||||
- GO111MODULE=on
|
||||
|
||||
install:
|
||||
- go mod download
|
||||
|
||||
script:
|
||||
- go test -v -race -tags=integration
|
20
vendor/github.com/unrolled/render/LICENSE
generated
vendored
Normal file
20
vendor/github.com/unrolled/render/LICENSE
generated
vendored
Normal file
|
@ -0,0 +1,20 @@
|
|||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2014 Cory Jacobsen
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
this software and associated documentation files (the "Software"), to deal in
|
||||
the Software without restriction, including without limitation the rights to
|
||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||
the Software, and to permit persons to whom the Software is furnished to do so,
|
||||
subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
508
vendor/github.com/unrolled/render/README.md
generated
vendored
Normal file
508
vendor/github.com/unrolled/render/README.md
generated
vendored
Normal file
|
@ -0,0 +1,508 @@
|
|||
# Render [](http://godoc.org/github.com/unrolled/render) [](https://travis-ci.org/unrolled/render)
|
||||
|
||||
Render is a package that provides functionality for easily rendering JSON, XML, text, binary data, and HTML templates. This package is based on the [Martini](https://github.com/go-martini/martini) [render](https://github.com/martini-contrib/render) work.
|
||||
|
||||
## Block Deprecation Notice
|
||||
Go 1.6 introduces a new [block](https://github.com/golang/go/blob/release-branch.go1.6/src/html/template/example_test.go#L128) action. This conflicts with Render's included `block` template function. To provide an easy migration path, a new function was created called `partial`. It is a duplicate of the old `block` function. It is advised that all users of the `block` function update their code to avoid any issues in the future. Previous to Go 1.6, Render's `block` functionality will continue to work but a message will be logged urging you to migrate to the new `partial` function.
|
||||
|
||||
## Usage
|
||||
Render can be used with pretty much any web framework providing you can access the `http.ResponseWriter` from your handler. The rendering functions simply wraps Go's existing functionality for marshaling and rendering data.
|
||||
|
||||
- HTML: Uses the [html/template](http://golang.org/pkg/html/template/) package to render HTML templates.
|
||||
- JSON: Uses the [encoding/json](http://golang.org/pkg/encoding/json/) package to marshal data into a JSON-encoded response.
|
||||
- XML: Uses the [encoding/xml](http://golang.org/pkg/encoding/xml/) package to marshal data into an XML-encoded response.
|
||||
- Binary data: Passes the incoming data straight through to the `http.ResponseWriter`.
|
||||
- Text: Passes the incoming string straight through to the `http.ResponseWriter`.
|
||||
|
||||
~~~ go
|
||||
// main.go
|
||||
package main
|
||||
|
||||
import (
|
||||
"encoding/xml"
|
||||
"net/http"
|
||||
|
||||
"github.com/unrolled/render" // or "gopkg.in/unrolled/render.v1"
|
||||
)
|
||||
|
||||
type ExampleXml struct {
|
||||
XMLName xml.Name `xml:"example"`
|
||||
One string `xml:"one,attr"`
|
||||
Two string `xml:"two,attr"`
|
||||
}
|
||||
|
||||
func main() {
|
||||
r := render.New()
|
||||
mux := http.NewServeMux()
|
||||
|
||||
mux.HandleFunc("/", func(w http.ResponseWriter, req *http.Request) {
|
||||
w.Write([]byte("Welcome, visit sub pages now."))
|
||||
})
|
||||
|
||||
mux.HandleFunc("/data", func(w http.ResponseWriter, req *http.Request) {
|
||||
r.Data(w, http.StatusOK, []byte("Some binary data here."))
|
||||
})
|
||||
|
||||
mux.HandleFunc("/text", func(w http.ResponseWriter, req *http.Request) {
|
||||
r.Text(w, http.StatusOK, "Plain text here")
|
||||
})
|
||||
|
||||
mux.HandleFunc("/json", func(w http.ResponseWriter, req *http.Request) {
|
||||
r.JSON(w, http.StatusOK, map[string]string{"hello": "json"})
|
||||
})
|
||||
|
||||
mux.HandleFunc("/jsonp", func(w http.ResponseWriter, req *http.Request) {
|
||||
r.JSONP(w, http.StatusOK, "callbackName", map[string]string{"hello": "jsonp"})
|
||||
})
|
||||
|
||||
mux.HandleFunc("/xml", func(w http.ResponseWriter, req *http.Request) {
|
||||
r.XML(w, http.StatusOK, ExampleXml{One: "hello", Two: "xml"})
|
||||
})
|
||||
|
||||
mux.HandleFunc("/html", func(w http.ResponseWriter, req *http.Request) {
|
||||
// Assumes you have a template in ./templates called "example.tmpl"
|
||||
// $ mkdir -p templates && echo "<h1>Hello {{.}}.</h1>" > templates/example.tmpl
|
||||
r.HTML(w, http.StatusOK, "example", "World")
|
||||
})
|
||||
|
||||
http.ListenAndServe("127.0.0.1:3000", mux)
|
||||
}
|
||||
~~~
|
||||
|
||||
~~~ html
|
||||
<!-- templates/example.tmpl -->
|
||||
<h1>Hello {{.}}.</h1>
|
||||
~~~
|
||||
|
||||
### Available Options
|
||||
Render comes with a variety of configuration options _(Note: these are not the default option values. See the defaults below.)_:
|
||||
|
||||
~~~ go
|
||||
// ...
|
||||
r := render.New(render.Options{
|
||||
Directory: "templates", // Specify what path to load the templates from.
|
||||
FileSystem: &LocalFileSystem{}, // Specify filesystem from where files are loaded.
|
||||
Asset: func(name string) ([]byte, error) { // Load from an Asset function instead of file.
|
||||
return []byte("template content"), nil
|
||||
},
|
||||
AssetNames: func() []string { // Return a list of asset names for the Asset function
|
||||
return []string{"filename.tmpl"}
|
||||
},
|
||||
Layout: "layout", // Specify a layout template. Layouts can call {{ yield }} to render the current template or {{ partial "css" }} to render a partial from the current template.
|
||||
Extensions: []string{".tmpl", ".html"}, // Specify extensions to load for templates.
|
||||
Funcs: []template.FuncMap{AppHelpers}, // Specify helper function maps for templates to access.
|
||||
Delims: render.Delims{"{[{", "}]}"}, // Sets delimiters to the specified strings.
|
||||
Charset: "UTF-8", // Sets encoding for content-types. Default is "UTF-8".
|
||||
DisableCharset: true, // Prevents the charset from being appended to the content type header.
|
||||
IndentJSON: true, // Output human readable JSON.
|
||||
IndentXML: true, // Output human readable XML.
|
||||
PrefixJSON: []byte(")]}',\n"), // Prefixes JSON responses with the given bytes.
|
||||
PrefixXML: []byte("<?xml version='1.0' encoding='UTF-8'?>"), // Prefixes XML responses with the given bytes.
|
||||
HTMLContentType: "application/xhtml+xml", // Output XHTML content type instead of default "text/html".
|
||||
IsDevelopment: true, // Render will now recompile the templates on every HTML response.
|
||||
UnEscapeHTML: true, // Replace ensure '&<>' are output correctly (JSON only).
|
||||
StreamingJSON: true, // Streams the JSON response via json.Encoder.
|
||||
RequirePartials: true, // Return an error if a template is missing a partial used in a layout.
|
||||
DisableHTTPErrorRendering: true, // Disables automatic rendering of http.StatusInternalServerError when an error occurs.
|
||||
})
|
||||
// ...
|
||||
~~~
|
||||
|
||||
### Default Options
|
||||
These are the preset options for Render:
|
||||
|
||||
~~~ go
|
||||
r := render.New()
|
||||
|
||||
// Is the same as the default configuration options:
|
||||
|
||||
r := render.New(render.Options{
|
||||
Directory: "templates",
|
||||
FileSystem: &LocalFileSystem{},
|
||||
Asset: nil,
|
||||
AssetNames: nil,
|
||||
Layout: "",
|
||||
Extensions: []string{".tmpl"},
|
||||
Funcs: []template.FuncMap{},
|
||||
Delims: render.Delims{"{{", "}}"},
|
||||
Charset: "UTF-8",
|
||||
DisableCharset: false,
|
||||
IndentJSON: false,
|
||||
IndentXML: false,
|
||||
PrefixJSON: []byte(""),
|
||||
PrefixXML: []byte(""),
|
||||
BinaryContentType: "application/octet-stream",
|
||||
HTMLContentType: "text/html",
|
||||
JSONContentType: "application/json",
|
||||
JSONPContentType: "application/javascript",
|
||||
TextContentType: "text/plain",
|
||||
XMLContentType: "application/xhtml+xml",
|
||||
IsDevelopment: false,
|
||||
UnEscapeHTML: false,
|
||||
StreamingJSON: false,
|
||||
RequirePartials: false,
|
||||
DisableHTTPErrorRendering: false,
|
||||
})
|
||||
~~~
|
||||
|
||||
### JSON vs Streaming JSON
|
||||
By default, Render does **not** stream JSON to the `http.ResponseWriter`. It instead marshalls your object into a byte array, and if no errors occurred, writes that byte array to the `http.ResponseWriter`. If you would like to use the built it in streaming functionality (`json.Encoder`), you can set the `StreamingJSON` setting to `true`. This will stream the output directly to the `http.ResponseWriter`. Also note that streaming is only implemented in `render.JSON` and not `render.JSONP`, and the `UnEscapeHTML` and `Indent` options are ignored when streaming.
|
||||
|
||||
### Loading Templates
|
||||
By default Render will attempt to load templates with a '.tmpl' extension from the "templates" directory. Templates are found by traversing the templates directory and are named by path and basename. For instance, the following directory structure:
|
||||
|
||||
~~~
|
||||
templates/
|
||||
|
|
||||
|__ admin/
|
||||
| |
|
||||
| |__ index.tmpl
|
||||
| |
|
||||
| |__ edit.tmpl
|
||||
|
|
||||
|__ home.tmpl
|
||||
~~~
|
||||
|
||||
Will provide the following templates:
|
||||
~~~
|
||||
admin/index
|
||||
admin/edit
|
||||
home
|
||||
~~~
|
||||
|
||||
You can also load templates from memory by providing the Asset and AssetNames options,
|
||||
e.g. when generating an asset file using [go-bindata](https://github.com/jteeuwen/go-bindata).
|
||||
|
||||
### Layouts
|
||||
Render provides `yield` and `partial` functions for layouts to access:
|
||||
~~~ go
|
||||
// ...
|
||||
r := render.New(render.Options{
|
||||
Layout: "layout",
|
||||
})
|
||||
// ...
|
||||
~~~
|
||||
|
||||
~~~ html
|
||||
<!-- templates/layout.tmpl -->
|
||||
<html>
|
||||
<head>
|
||||
<title>My Layout</title>
|
||||
<!-- Render the partial template called `css-$current_template` here -->
|
||||
{{ partial "css" }}
|
||||
</head>
|
||||
<body>
|
||||
<!-- render the partial template called `header-$current_template` here -->
|
||||
{{ partial "header" }}
|
||||
<!-- Render the current template here -->
|
||||
{{ yield }}
|
||||
<!-- render the partial template called `footer-$current_template` here -->
|
||||
{{ partial "footer" }}
|
||||
</body>
|
||||
</html>
|
||||
~~~
|
||||
|
||||
`current` can also be called to get the current template being rendered.
|
||||
~~~ html
|
||||
<!-- templates/layout.tmpl -->
|
||||
<html>
|
||||
<head>
|
||||
<title>My Layout</title>
|
||||
</head>
|
||||
<body>
|
||||
This is the {{ current }} page.
|
||||
</body>
|
||||
</html>
|
||||
~~~
|
||||
|
||||
Partials are defined by individual templates as seen below. The partial template's
|
||||
name needs to be defined as "{partial name}-{template name}".
|
||||
~~~ html
|
||||
<!-- templates/home.tmpl -->
|
||||
{{ define "header-home" }}
|
||||
<h1>Home</h1>
|
||||
{{ end }}
|
||||
|
||||
{{ define "footer-home"}}
|
||||
<p>The End</p>
|
||||
{{ end }}
|
||||
~~~
|
||||
|
||||
By default, the template is not required to define all partials referenced in the
|
||||
layout. If you want an error to be returned when a template does not define a
|
||||
partial, set `Options.RequirePartials = true`.
|
||||
|
||||
### Character Encodings
|
||||
Render will automatically set the proper Content-Type header based on which function you call. See below for an example of what the default settings would output (note that UTF-8 is the default, and binary data does not output the charset):
|
||||
~~~ go
|
||||
// main.go
|
||||
package main
|
||||
|
||||
import (
|
||||
"encoding/xml"
|
||||
"net/http"
|
||||
|
||||
"github.com/unrolled/render" // or "gopkg.in/unrolled/render.v1"
|
||||
)
|
||||
|
||||
type ExampleXml struct {
|
||||
XMLName xml.Name `xml:"example"`
|
||||
One string `xml:"one,attr"`
|
||||
Two string `xml:"two,attr"`
|
||||
}
|
||||
|
||||
func main() {
|
||||
r := render.New(render.Options{})
|
||||
mux := http.NewServeMux()
|
||||
|
||||
// This will set the Content-Type header to "application/octet-stream".
|
||||
// Note that this does not receive a charset value.
|
||||
mux.HandleFunc("/data", func(w http.ResponseWriter, req *http.Request) {
|
||||
r.Data(w, http.StatusOK, []byte("Some binary data here."))
|
||||
})
|
||||
|
||||
// This will set the Content-Type header to "application/json; charset=UTF-8".
|
||||
mux.HandleFunc("/json", func(w http.ResponseWriter, req *http.Request) {
|
||||
r.JSON(w, http.StatusOK, map[string]string{"hello": "json"})
|
||||
})
|
||||
|
||||
// This will set the Content-Type header to "text/xml; charset=UTF-8".
|
||||
mux.HandleFunc("/xml", func(w http.ResponseWriter, req *http.Request) {
|
||||
r.XML(w, http.StatusOK, ExampleXml{One: "hello", Two: "xml"})
|
||||
})
|
||||
|
||||
// This will set the Content-Type header to "text/plain; charset=UTF-8".
|
||||
mux.HandleFunc("/text", func(w http.ResponseWriter, req *http.Request) {
|
||||
r.Text(w, http.StatusOK, "Plain text here")
|
||||
})
|
||||
|
||||
// This will set the Content-Type header to "text/html; charset=UTF-8".
|
||||
mux.HandleFunc("/html", func(w http.ResponseWriter, req *http.Request) {
|
||||
// Assumes you have a template in ./templates called "example.tmpl"
|
||||
// $ mkdir -p templates && echo "<h1>Hello {{.}}.</h1>" > templates/example.tmpl
|
||||
r.HTML(w, http.StatusOK, "example", "World")
|
||||
})
|
||||
|
||||
http.ListenAndServe("127.0.0.1:3000", mux)
|
||||
}
|
||||
~~~
|
||||
|
||||
In order to change the charset, you can set the `Charset` within the `render.Options` to your encoding value:
|
||||
~~~ go
|
||||
// main.go
|
||||
package main
|
||||
|
||||
import (
|
||||
"encoding/xml"
|
||||
"net/http"
|
||||
|
||||
"github.com/unrolled/render" // or "gopkg.in/unrolled/render.v1"
|
||||
)
|
||||
|
||||
type ExampleXml struct {
|
||||
XMLName xml.Name `xml:"example"`
|
||||
One string `xml:"one,attr"`
|
||||
Two string `xml:"two,attr"`
|
||||
}
|
||||
|
||||
func main() {
|
||||
r := render.New(render.Options{
|
||||
Charset: "ISO-8859-1",
|
||||
})
|
||||
mux := http.NewServeMux()
|
||||
|
||||
// This will set the Content-Type header to "application/octet-stream".
|
||||
// Note that this does not receive a charset value.
|
||||
mux.HandleFunc("/data", func(w http.ResponseWriter, req *http.Request) {
|
||||
r.Data(w, http.StatusOK, []byte("Some binary data here."))
|
||||
})
|
||||
|
||||
// This will set the Content-Type header to "application/json; charset=ISO-8859-1".
|
||||
mux.HandleFunc("/json", func(w http.ResponseWriter, req *http.Request) {
|
||||
r.JSON(w, http.StatusOK, map[string]string{"hello": "json"})
|
||||
})
|
||||
|
||||
// This will set the Content-Type header to "text/xml; charset=ISO-8859-1".
|
||||
mux.HandleFunc("/xml", func(w http.ResponseWriter, req *http.Request) {
|
||||
r.XML(w, http.StatusOK, ExampleXml{One: "hello", Two: "xml"})
|
||||
})
|
||||
|
||||
// This will set the Content-Type header to "text/plain; charset=ISO-8859-1".
|
||||
mux.HandleFunc("/text", func(w http.ResponseWriter, req *http.Request) {
|
||||
r.Text(w, http.StatusOK, "Plain text here")
|
||||
})
|
||||
|
||||
// This will set the Content-Type header to "text/html; charset=ISO-8859-1".
|
||||
mux.HandleFunc("/html", func(w http.ResponseWriter, req *http.Request) {
|
||||
// Assumes you have a template in ./templates called "example.tmpl"
|
||||
// $ mkdir -p templates && echo "<h1>Hello {{.}}.</h1>" > templates/example.tmpl
|
||||
r.HTML(w, http.StatusOK, "example", "World")
|
||||
})
|
||||
|
||||
http.ListenAndServe("127.0.0.1:3000", mux)
|
||||
}
|
||||
~~~
|
||||
|
||||
### Error Handling
|
||||
|
||||
The rendering functions return any errors from the rendering engine.
|
||||
By default, they will also write the error to the HTTP response and set the status code to 500. You can disable
|
||||
this behavior so that you can handle errors yourself by setting
|
||||
`Options.DisableHTTPErrorRendering: true`.
|
||||
|
||||
~~~go
|
||||
r := render.New(render.Options{
|
||||
DisableHTTPErrorRendering: true,
|
||||
})
|
||||
|
||||
//...
|
||||
|
||||
err := r.HTML(w, http.StatusOK, "example", "World")
|
||||
if err != nil{
|
||||
http.Redirect(w, r, "/my-custom-500", http.StatusFound)
|
||||
}
|
||||
~~~
|
||||
|
||||
## Integration Examples
|
||||
|
||||
### [Echo](https://github.com/labstack/echo)
|
||||
~~~ go
|
||||
// main.go
|
||||
package main
|
||||
|
||||
import (
|
||||
"io"
|
||||
"net/http"
|
||||
|
||||
"github.com/labstack/echo"
|
||||
"github.com/unrolled/render" // or "gopkg.in/unrolled/render.v1"
|
||||
)
|
||||
|
||||
type RenderWrapper struct { // We need to wrap the renderer because we need a different signature for echo.
|
||||
rnd *render.Render
|
||||
}
|
||||
|
||||
func (r *RenderWrapper) Render(w io.Writer, name string, data interface{},c echo.Context) error {
|
||||
return r.rnd.HTML(w, 0, name, data) // The zero status code is overwritten by echo.
|
||||
}
|
||||
|
||||
func main() {
|
||||
r := &RenderWrapper{render.New()}
|
||||
|
||||
e := echo.New()
|
||||
|
||||
e.Renderer = r
|
||||
|
||||
e.GET("/", func(c echo.Context) error {
|
||||
return c.Render(http.StatusOK, "TemplateName", "TemplateData")
|
||||
})
|
||||
|
||||
e.Logger.Fatal(e.Start(":1323"))
|
||||
}
|
||||
~~~
|
||||
|
||||
### [Gin](https://github.com/gin-gonic/gin)
|
||||
~~~ go
|
||||
// main.go
|
||||
package main
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
|
||||
"github.com/gin-gonic/gin"
|
||||
"github.com/unrolled/render" // or "gopkg.in/unrolled/render.v1"
|
||||
)
|
||||
|
||||
func main() {
|
||||
r := render.New(render.Options{
|
||||
IndentJSON: true,
|
||||
})
|
||||
|
||||
router := gin.Default()
|
||||
|
||||
router.GET("/", func(c *gin.Context) {
|
||||
r.JSON(c.Writer, http.StatusOK, map[string]string{"welcome": "This is rendered JSON!"})
|
||||
})
|
||||
|
||||
router.Run(":3000")
|
||||
}
|
||||
~~~
|
||||
|
||||
### [Goji](https://github.com/zenazn/goji)
|
||||
~~~ go
|
||||
// main.go
|
||||
package main
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
|
||||
"github.com/zenazn/goji"
|
||||
"github.com/zenazn/goji/web"
|
||||
"github.com/unrolled/render" // or "gopkg.in/unrolled/render.v1"
|
||||
)
|
||||
|
||||
func main() {
|
||||
r := render.New(render.Options{
|
||||
IndentJSON: true,
|
||||
})
|
||||
|
||||
goji.Get("/", func(c web.C, w http.ResponseWriter, req *http.Request) {
|
||||
r.JSON(w, http.StatusOK, map[string]string{"welcome": "This is rendered JSON!"})
|
||||
})
|
||||
goji.Serve() // Defaults to ":8000".
|
||||
}
|
||||
~~~
|
||||
|
||||
### [Negroni](https://github.com/codegangsta/negroni)
|
||||
~~~ go
|
||||
// main.go
|
||||
package main
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
|
||||
"github.com/urfave/negroni"
|
||||
"github.com/unrolled/render" // or "gopkg.in/unrolled/render.v1"
|
||||
)
|
||||
|
||||
func main() {
|
||||
r := render.New(render.Options{
|
||||
IndentJSON: true,
|
||||
})
|
||||
mux := http.NewServeMux()
|
||||
|
||||
mux.HandleFunc("/", func(w http.ResponseWriter, req *http.Request) {
|
||||
r.JSON(w, http.StatusOK, map[string]string{"welcome": "This is rendered JSON!"})
|
||||
})
|
||||
|
||||
n := negroni.Classic()
|
||||
n.UseHandler(mux)
|
||||
n.Run(":3000")
|
||||
}
|
||||
~~~
|
||||
|
||||
### [Traffic](https://github.com/pilu/traffic)
|
||||
~~~ go
|
||||
// main.go
|
||||
package main
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
|
||||
"github.com/pilu/traffic"
|
||||
"github.com/unrolled/render" // or "gopkg.in/unrolled/render.v1"
|
||||
)
|
||||
|
||||
func main() {
|
||||
r := render.New(render.Options{
|
||||
IndentJSON: true,
|
||||
})
|
||||
|
||||
router := traffic.New()
|
||||
router.Get("/", func(w traffic.ResponseWriter, req *traffic.Request) {
|
||||
r.JSON(w, http.StatusOK, map[string]string{"welcome": "This is rendered JSON!"})
|
||||
})
|
||||
|
||||
router.Run()
|
||||
}
|
||||
~~~
|
46
vendor/github.com/unrolled/render/buffer.go
generated
vendored
Normal file
46
vendor/github.com/unrolled/render/buffer.go
generated
vendored
Normal file
|
@ -0,0 +1,46 @@
|
|||
package render
|
||||
|
||||
import "bytes"
|
||||
|
||||
// bufPool represents a reusable buffer pool for executing templates into.
|
||||
var bufPool *BufferPool
|
||||
|
||||
// BufferPool implements a pool of bytes.Buffers in the form of a bounded channel.
|
||||
// Pulled from the github.com/oxtoacart/bpool package (Apache licensed).
|
||||
type BufferPool struct {
|
||||
c chan *bytes.Buffer
|
||||
}
|
||||
|
||||
// NewBufferPool creates a new BufferPool bounded to the given size.
|
||||
func NewBufferPool(size int) (bp *BufferPool) {
|
||||
return &BufferPool{
|
||||
c: make(chan *bytes.Buffer, size),
|
||||
}
|
||||
}
|
||||
|
||||
// Get gets a Buffer from the BufferPool, or creates a new one if none are
|
||||
// available in the pool.
|
||||
func (bp *BufferPool) Get() (b *bytes.Buffer) {
|
||||
select {
|
||||
case b = <-bp.c:
|
||||
// reuse existing buffer
|
||||
default:
|
||||
// create new buffer
|
||||
b = bytes.NewBuffer([]byte{})
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
// Put returns the given Buffer to the BufferPool.
|
||||
func (bp *BufferPool) Put(b *bytes.Buffer) {
|
||||
b.Reset()
|
||||
select {
|
||||
case bp.c <- b:
|
||||
default: // Discard the buffer if the pool is full.
|
||||
}
|
||||
}
|
||||
|
||||
// Initialize buffer pool for writing templates into.
|
||||
func init() {
|
||||
bufPool = NewBufferPool(64)
|
||||
}
|
55
vendor/github.com/unrolled/render/doc.go
generated
vendored
Normal file
55
vendor/github.com/unrolled/render/doc.go
generated
vendored
Normal file
|
@ -0,0 +1,55 @@
|
|||
/*Package render is a package that provides functionality for easily rendering JSON, XML, binary data, and HTML templates.
|
||||
|
||||
package main
|
||||
|
||||
import (
|
||||
"encoding/xml"
|
||||
"net/http"
|
||||
|
||||
"github.com/unrolled/render" // or "gopkg.in/unrolled/render.v1"
|
||||
)
|
||||
|
||||
type ExampleXml struct {
|
||||
XMLName xml.Name `xml:"example"`
|
||||
One string `xml:"one,attr"`
|
||||
Two string `xml:"two,attr"`
|
||||
}
|
||||
|
||||
func main() {
|
||||
r := render.New()
|
||||
mux := http.NewServeMux()
|
||||
|
||||
mux.HandleFunc("/", func(w http.ResponseWriter, req *http.Request) {
|
||||
w.Write([]byte("Welcome, visit sub pages now."))
|
||||
})
|
||||
|
||||
mux.HandleFunc("/data", func(w http.ResponseWriter, req *http.Request) {
|
||||
r.Data(w, http.StatusOK, []byte("Some binary data here."))
|
||||
})
|
||||
|
||||
mux.HandleFunc("/text", func(w http.ResponseWriter, req *http.Request) {
|
||||
r.Text(w, http.StatusOK, "Plain text here")
|
||||
})
|
||||
|
||||
mux.HandleFunc("/json", func(w http.ResponseWriter, req *http.Request) {
|
||||
r.JSON(w, http.StatusOK, map[string]string{"hello": "json"})
|
||||
})
|
||||
|
||||
mux.HandleFunc("/jsonp", func(w http.ResponseWriter, req *http.Request) {
|
||||
r.JSONP(w, http.StatusOK, "callbackName", map[string]string{"hello": "jsonp"})
|
||||
})
|
||||
|
||||
mux.HandleFunc("/xml", func(w http.ResponseWriter, req *http.Request) {
|
||||
r.XML(w, http.StatusOK, ExampleXml{One: "hello", Two: "xml"})
|
||||
})
|
||||
|
||||
mux.HandleFunc("/html", func(w http.ResponseWriter, req *http.Request) {
|
||||
// Assumes you have a template in ./templates called "example.tmpl".
|
||||
// $ mkdir -p templates && echo "<h1>Hello HTML world.</h1>" > templates/example.tmpl
|
||||
r.HTML(w, http.StatusOK, "example", nil)
|
||||
})
|
||||
|
||||
http.ListenAndServe("0.0.0.0:3000", mux)
|
||||
}
|
||||
*/
|
||||
package render
|
217
vendor/github.com/unrolled/render/engine.go
generated
vendored
Normal file
217
vendor/github.com/unrolled/render/engine.go
generated
vendored
Normal file
|
@ -0,0 +1,217 @@
|
|||
package render
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"encoding/xml"
|
||||
"html/template"
|
||||
"io"
|
||||
"net/http"
|
||||
)
|
||||
|
||||
// Engine is the generic interface for all responses.
|
||||
type Engine interface {
|
||||
Render(io.Writer, interface{}) error
|
||||
}
|
||||
|
||||
// Head defines the basic ContentType and Status fields.
|
||||
type Head struct {
|
||||
ContentType string
|
||||
Status int
|
||||
}
|
||||
|
||||
// Data built-in renderer.
|
||||
type Data struct {
|
||||
Head
|
||||
}
|
||||
|
||||
// HTML built-in renderer.
|
||||
type HTML struct {
|
||||
Head
|
||||
Name string
|
||||
Templates *template.Template
|
||||
}
|
||||
|
||||
// JSON built-in renderer.
|
||||
type JSON struct {
|
||||
Head
|
||||
Indent bool
|
||||
UnEscapeHTML bool
|
||||
Prefix []byte
|
||||
StreamingJSON bool
|
||||
}
|
||||
|
||||
// JSONP built-in renderer.
|
||||
type JSONP struct {
|
||||
Head
|
||||
Indent bool
|
||||
Callback string
|
||||
}
|
||||
|
||||
// Text built-in renderer.
|
||||
type Text struct {
|
||||
Head
|
||||
}
|
||||
|
||||
// XML built-in renderer.
|
||||
type XML struct {
|
||||
Head
|
||||
Indent bool
|
||||
Prefix []byte
|
||||
}
|
||||
|
||||
// Write outputs the header content.
|
||||
func (h Head) Write(w http.ResponseWriter) {
|
||||
w.Header().Set(ContentType, h.ContentType)
|
||||
w.WriteHeader(h.Status)
|
||||
}
|
||||
|
||||
// Render a data response.
|
||||
func (d Data) Render(w io.Writer, v interface{}) error {
|
||||
if hw, ok := w.(http.ResponseWriter); ok {
|
||||
c := hw.Header().Get(ContentType)
|
||||
if c != "" {
|
||||
d.Head.ContentType = c
|
||||
}
|
||||
d.Head.Write(hw)
|
||||
}
|
||||
|
||||
w.Write(v.([]byte))
|
||||
return nil
|
||||
}
|
||||
|
||||
// Render a HTML response.
|
||||
func (h HTML) Render(w io.Writer, binding interface{}) error {
|
||||
// Retrieve a buffer from the pool to write to.
|
||||
out := bufPool.Get()
|
||||
err := h.Templates.ExecuteTemplate(out, h.Name, binding)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if hw, ok := w.(http.ResponseWriter); ok {
|
||||
h.Head.Write(hw)
|
||||
}
|
||||
out.WriteTo(w)
|
||||
|
||||
// Return the buffer to the pool.
|
||||
bufPool.Put(out)
|
||||
return nil
|
||||
}
|
||||
|
||||
// Render a JSON response.
|
||||
func (j JSON) Render(w io.Writer, v interface{}) error {
|
||||
if j.StreamingJSON {
|
||||
return j.renderStreamingJSON(w, v)
|
||||
}
|
||||
|
||||
var result []byte
|
||||
var err error
|
||||
|
||||
if j.Indent {
|
||||
result, err = json.MarshalIndent(v, "", " ")
|
||||
result = append(result, '\n')
|
||||
} else {
|
||||
result, err = json.Marshal(v)
|
||||
}
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Unescape HTML if needed.
|
||||
if j.UnEscapeHTML {
|
||||
result = bytes.Replace(result, []byte("\\u003c"), []byte("<"), -1)
|
||||
result = bytes.Replace(result, []byte("\\u003e"), []byte(">"), -1)
|
||||
result = bytes.Replace(result, []byte("\\u0026"), []byte("&"), -1)
|
||||
}
|
||||
|
||||
// JSON marshaled fine, write out the result.
|
||||
if hw, ok := w.(http.ResponseWriter); ok {
|
||||
j.Head.Write(hw)
|
||||
}
|
||||
if len(j.Prefix) > 0 {
|
||||
w.Write(j.Prefix)
|
||||
}
|
||||
w.Write(result)
|
||||
return nil
|
||||
}
|
||||
|
||||
func (j JSON) renderStreamingJSON(w io.Writer, v interface{}) error {
|
||||
if hw, ok := w.(http.ResponseWriter); ok {
|
||||
j.Head.Write(hw)
|
||||
}
|
||||
if len(j.Prefix) > 0 {
|
||||
w.Write(j.Prefix)
|
||||
}
|
||||
|
||||
return json.NewEncoder(w).Encode(v)
|
||||
}
|
||||
|
||||
// Render a JSONP response.
|
||||
func (j JSONP) Render(w io.Writer, v interface{}) error {
|
||||
var result []byte
|
||||
var err error
|
||||
|
||||
if j.Indent {
|
||||
result, err = json.MarshalIndent(v, "", " ")
|
||||
} else {
|
||||
result, err = json.Marshal(v)
|
||||
}
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// JSON marshaled fine, write out the result.
|
||||
if hw, ok := w.(http.ResponseWriter); ok {
|
||||
j.Head.Write(hw)
|
||||
}
|
||||
w.Write([]byte(j.Callback + "("))
|
||||
w.Write(result)
|
||||
w.Write([]byte(");"))
|
||||
|
||||
// If indenting, append a new line.
|
||||
if j.Indent {
|
||||
w.Write([]byte("\n"))
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// Render a text response.
|
||||
func (t Text) Render(w io.Writer, v interface{}) error {
|
||||
if hw, ok := w.(http.ResponseWriter); ok {
|
||||
c := hw.Header().Get(ContentType)
|
||||
if c != "" {
|
||||
t.Head.ContentType = c
|
||||
}
|
||||
t.Head.Write(hw)
|
||||
}
|
||||
|
||||
w.Write([]byte(v.(string)))
|
||||
return nil
|
||||
}
|
||||
|
||||
// Render an XML response.
|
||||
func (x XML) Render(w io.Writer, v interface{}) error {
|
||||
var result []byte
|
||||
var err error
|
||||
|
||||
if x.Indent {
|
||||
result, err = xml.MarshalIndent(v, "", " ")
|
||||
result = append(result, '\n')
|
||||
} else {
|
||||
result, err = xml.Marshal(v)
|
||||
}
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// XML marshaled fine, write out the result.
|
||||
if hw, ok := w.(http.ResponseWriter); ok {
|
||||
x.Head.Write(hw)
|
||||
}
|
||||
if len(x.Prefix) > 0 {
|
||||
w.Write(x.Prefix)
|
||||
}
|
||||
w.Write(result)
|
||||
return nil
|
||||
}
|
21
vendor/github.com/unrolled/render/fs.go
generated
vendored
Normal file
21
vendor/github.com/unrolled/render/fs.go
generated
vendored
Normal file
|
@ -0,0 +1,21 @@
|
|||
package render
|
||||
|
||||
import (
|
||||
"io/ioutil"
|
||||
"path/filepath"
|
||||
)
|
||||
|
||||
type FileSystem interface {
|
||||
Walk(root string, walkFn filepath.WalkFunc) error
|
||||
ReadFile(filename string) ([]byte, error)
|
||||
}
|
||||
|
||||
type LocalFileSystem struct{}
|
||||
|
||||
func (LocalFileSystem) Walk(root string, walkFn filepath.WalkFunc) error {
|
||||
return filepath.Walk(root, walkFn)
|
||||
}
|
||||
|
||||
func (LocalFileSystem) ReadFile(filename string) ([]byte, error) {
|
||||
return ioutil.ReadFile(filename)
|
||||
}
|
5
vendor/github.com/unrolled/render/go.mod
generated
vendored
Normal file
5
vendor/github.com/unrolled/render/go.mod
generated
vendored
Normal file
|
@ -0,0 +1,5 @@
|
|||
module github.com/unrolled/render
|
||||
|
||||
go 1.12
|
||||
|
||||
require github.com/eknkc/amber v0.0.0-20171010120322-cdade1c07385
|
2
vendor/github.com/unrolled/render/go.sum
generated
vendored
Normal file
2
vendor/github.com/unrolled/render/go.sum
generated
vendored
Normal file
|
@ -0,0 +1,2 @@
|
|||
github.com/eknkc/amber v0.0.0-20171010120322-cdade1c07385 h1:clC1lXBpe2kTj2VHdaIu9ajZQe4kcEY9j0NsnDDBZ3o=
|
||||
github.com/eknkc/amber v0.0.0-20171010120322-cdade1c07385/go.mod h1:0vRUJqYpeSZifjYj7uP3BG/gKcuzL9xWVV/Y+cK33KM=
|
21
vendor/github.com/unrolled/render/helpers.go
generated
vendored
Normal file
21
vendor/github.com/unrolled/render/helpers.go
generated
vendored
Normal file
|
@ -0,0 +1,21 @@
|
|||
// +build go1.6
|
||||
|
||||
package render
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"html/template"
|
||||
)
|
||||
|
||||
// Included helper functions for use when rendering HTML.
|
||||
var helperFuncs = template.FuncMap{
|
||||
"yield": func() (string, error) {
|
||||
return "", fmt.Errorf("yield called with no layout defined")
|
||||
},
|
||||
"partial": func() (string, error) {
|
||||
return "", fmt.Errorf("block called with no layout defined")
|
||||
},
|
||||
"current": func() (string, error) {
|
||||
return "", nil
|
||||
},
|
||||
}
|
26
vendor/github.com/unrolled/render/helpers_pre16.go
generated
vendored
Normal file
26
vendor/github.com/unrolled/render/helpers_pre16.go
generated
vendored
Normal file
|
@ -0,0 +1,26 @@
|
|||
// +build !go1.6
|
||||
|
||||
package render
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"html/template"
|
||||
)
|
||||
|
||||
// Included helper functions for use when rendering HTML.
|
||||
var helperFuncs = template.FuncMap{
|
||||
"yield": func() (string, error) {
|
||||
return "", fmt.Errorf("yield called with no layout defined")
|
||||
},
|
||||
// `block` is deprecated! Use the `partial` below if you need this functionality still.
|
||||
// Otherwise, checkout Go's `block` implementation introduced in 1.6
|
||||
"block": func() (string, error) {
|
||||
return "", fmt.Errorf("block called with no layout defined")
|
||||
},
|
||||
"partial": func() (string, error) {
|
||||
return "", fmt.Errorf("block called with no layout defined")
|
||||
},
|
||||
"current": func() (string, error) {
|
||||
return "", nil
|
||||
},
|
||||
}
|
480
vendor/github.com/unrolled/render/render.go
generated
vendored
Normal file
480
vendor/github.com/unrolled/render/render.go
generated
vendored
Normal file
|
@ -0,0 +1,480 @@
|
|||
package render
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
"html/template"
|
||||
"io"
|
||||
"log"
|
||||
"net/http"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"sync"
|
||||
)
|
||||
|
||||
const (
|
||||
// ContentBinary header value for binary data.
|
||||
ContentBinary = "application/octet-stream"
|
||||
// ContentHTML header value for HTML data.
|
||||
ContentHTML = "text/html"
|
||||
// ContentJSON header value for JSON data.
|
||||
ContentJSON = "application/json"
|
||||
// ContentJSONP header value for JSONP data.
|
||||
ContentJSONP = "application/javascript"
|
||||
// ContentLength header constant.
|
||||
ContentLength = "Content-Length"
|
||||
// ContentText header value for Text data.
|
||||
ContentText = "text/plain"
|
||||
// ContentType header constant.
|
||||
ContentType = "Content-Type"
|
||||
// ContentXHTML header value for XHTML data.
|
||||
ContentXHTML = "application/xhtml+xml"
|
||||
// ContentXML header value for XML data.
|
||||
ContentXML = "text/xml"
|
||||
// Default character encoding.
|
||||
defaultCharset = "UTF-8"
|
||||
)
|
||||
|
||||
// helperFuncs had to be moved out. See helpers.go|helpers_pre16.go files.
|
||||
|
||||
// Delims represents a set of Left and Right delimiters for HTML template rendering.
|
||||
type Delims struct {
|
||||
// Left delimiter, defaults to {{.
|
||||
Left string
|
||||
// Right delimiter, defaults to }}.
|
||||
Right string
|
||||
}
|
||||
|
||||
// Options is a struct for specifying configuration options for the render.Render object.
|
||||
type Options struct {
|
||||
// Directory to load templates. Default is "templates".
|
||||
Directory string
|
||||
// FileSystem to access files
|
||||
FileSystem FileSystem
|
||||
// Asset function to use in place of directory. Defaults to nil.
|
||||
Asset func(name string) ([]byte, error)
|
||||
// AssetNames function to use in place of directory. Defaults to nil.
|
||||
AssetNames func() []string
|
||||
// Layout template name. Will not render a layout if blank (""). Defaults to blank ("").
|
||||
Layout string
|
||||
// Extensions to parse template files from. Defaults to [".tmpl"].
|
||||
Extensions []string
|
||||
// Funcs is a slice of FuncMaps to apply to the template upon compilation. This is useful for helper functions. Defaults to empty map.
|
||||
Funcs []template.FuncMap
|
||||
// Delims sets the action delimiters to the specified strings in the Delims struct.
|
||||
Delims Delims
|
||||
// Appends the given character set to the Content-Type header. Default is "UTF-8".
|
||||
Charset string
|
||||
// If DisableCharset is set to true, it will not append the above Charset value to the Content-Type header. Default is false.
|
||||
DisableCharset bool
|
||||
// Outputs human readable JSON.
|
||||
IndentJSON bool
|
||||
// Outputs human readable XML. Default is false.
|
||||
IndentXML bool
|
||||
// Prefixes the JSON output with the given bytes. Default is false.
|
||||
PrefixJSON []byte
|
||||
// Prefixes the XML output with the given bytes.
|
||||
PrefixXML []byte
|
||||
// Allows changing the binary content type.
|
||||
BinaryContentType string
|
||||
// Allows changing the HTML content type.
|
||||
HTMLContentType string
|
||||
// Allows changing the JSON content type.
|
||||
JSONContentType string
|
||||
// Allows changing the JSONP content type.
|
||||
JSONPContentType string
|
||||
// Allows changing the Text content type.
|
||||
TextContentType string
|
||||
// Allows changing the XML content type.
|
||||
XMLContentType string
|
||||
// If IsDevelopment is set to true, this will recompile the templates on every request. Default is false.
|
||||
IsDevelopment bool
|
||||
// Unescape HTML characters "&<>" to their original values. Default is false.
|
||||
UnEscapeHTML bool
|
||||
// Streams JSON responses instead of marshalling prior to sending. Default is false.
|
||||
StreamingJSON bool
|
||||
// Require that all partials executed in the layout are implemented in all templates using the layout. Default is false.
|
||||
RequirePartials bool
|
||||
// Deprecated: Use the above `RequirePartials` instead of this. As of Go 1.6, blocks are built in. Default is false.
|
||||
RequireBlocks bool
|
||||
// Disables automatic rendering of http.StatusInternalServerError when an error occurs. Default is false.
|
||||
DisableHTTPErrorRendering bool
|
||||
// Enables using partials without the current filename suffix which allows use of the same template in multiple files. e.g {{ partial "carosuel" }} inside the home template will match carosel-home or carosel.
|
||||
// ***NOTE*** - This option should be named RenderPartialsWithoutSuffix as that is what it does. "Prefix" is a typo. Maintaining the existing name for backwards compatibility.
|
||||
RenderPartialsWithoutPrefix bool
|
||||
}
|
||||
|
||||
// HTMLOptions is a struct for overriding some rendering Options for specific HTML call.
|
||||
type HTMLOptions struct {
|
||||
// Layout template name. Overrides Options.Layout.
|
||||
Layout string
|
||||
// Funcs added to Options.Funcs.
|
||||
Funcs template.FuncMap
|
||||
}
|
||||
|
||||
// Render is a service that provides functions for easily writing JSON, XML,
|
||||
// binary data, and HTML templates out to a HTTP Response.
|
||||
type Render struct {
|
||||
// Customize Secure with an Options struct.
|
||||
opt Options
|
||||
templates *template.Template
|
||||
templatesLk sync.Mutex
|
||||
compiledCharset string
|
||||
}
|
||||
|
||||
// New constructs a new Render instance with the supplied options.
|
||||
func New(options ...Options) *Render {
|
||||
var o Options
|
||||
if len(options) > 0 {
|
||||
o = options[0]
|
||||
}
|
||||
|
||||
r := Render{
|
||||
opt: o,
|
||||
}
|
||||
|
||||
r.prepareOptions()
|
||||
r.compileTemplates()
|
||||
|
||||
return &r
|
||||
}
|
||||
|
||||
func (r *Render) prepareOptions() {
|
||||
// Fill in the defaults if need be.
|
||||
if len(r.opt.Charset) == 0 {
|
||||
r.opt.Charset = defaultCharset
|
||||
}
|
||||
if r.opt.DisableCharset == false {
|
||||
r.compiledCharset = "; charset=" + r.opt.Charset
|
||||
}
|
||||
|
||||
if len(r.opt.Directory) == 0 {
|
||||
r.opt.Directory = "templates"
|
||||
}
|
||||
if r.opt.FileSystem == nil {
|
||||
r.opt.FileSystem = &LocalFileSystem{}
|
||||
}
|
||||
if len(r.opt.Extensions) == 0 {
|
||||
r.opt.Extensions = []string{".tmpl"}
|
||||
}
|
||||
if len(r.opt.BinaryContentType) == 0 {
|
||||
r.opt.BinaryContentType = ContentBinary
|
||||
}
|
||||
if len(r.opt.HTMLContentType) == 0 {
|
||||
r.opt.HTMLContentType = ContentHTML
|
||||
}
|
||||
if len(r.opt.JSONContentType) == 0 {
|
||||
r.opt.JSONContentType = ContentJSON
|
||||
}
|
||||
if len(r.opt.JSONPContentType) == 0 {
|
||||
r.opt.JSONPContentType = ContentJSONP
|
||||
}
|
||||
if len(r.opt.TextContentType) == 0 {
|
||||
r.opt.TextContentType = ContentText
|
||||
}
|
||||
if len(r.opt.XMLContentType) == 0 {
|
||||
r.opt.XMLContentType = ContentXML
|
||||
}
|
||||
}
|
||||
|
||||
func (r *Render) compileTemplates() {
|
||||
if r.opt.Asset == nil || r.opt.AssetNames == nil {
|
||||
r.compileTemplatesFromDir()
|
||||
return
|
||||
}
|
||||
r.compileTemplatesFromAsset()
|
||||
}
|
||||
|
||||
func (r *Render) compileTemplatesFromDir() {
|
||||
dir := r.opt.Directory
|
||||
r.templates = template.New(dir)
|
||||
r.templates.Delims(r.opt.Delims.Left, r.opt.Delims.Right)
|
||||
|
||||
// Walk the supplied directory and compile any files that match our extension list.
|
||||
r.opt.FileSystem.Walk(dir, func(path string, info os.FileInfo, err error) error {
|
||||
// Fix same-extension-dirs bug: some dir might be named to: "users.tmpl", "local.html".
|
||||
// These dirs should be excluded as they are not valid golang templates, but files under
|
||||
// them should be treat as normal.
|
||||
// If is a dir, return immediately (dir is not a valid golang template).
|
||||
if info == nil || info.IsDir() {
|
||||
return nil
|
||||
}
|
||||
|
||||
rel, err := filepath.Rel(dir, path)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
ext := ""
|
||||
if strings.Index(rel, ".") != -1 {
|
||||
ext = filepath.Ext(rel)
|
||||
}
|
||||
|
||||
for _, extension := range r.opt.Extensions {
|
||||
if ext == extension {
|
||||
buf, err := r.opt.FileSystem.ReadFile(path)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
name := (rel[0 : len(rel)-len(ext)])
|
||||
tmpl := r.templates.New(filepath.ToSlash(name))
|
||||
|
||||
// Add our funcmaps.
|
||||
for _, funcs := range r.opt.Funcs {
|
||||
tmpl.Funcs(funcs)
|
||||
}
|
||||
|
||||
// Break out if this parsing fails. We don't want any silent server starts.
|
||||
template.Must(tmpl.Funcs(helperFuncs).Parse(string(buf)))
|
||||
break
|
||||
}
|
||||
}
|
||||
return nil
|
||||
})
|
||||
}
|
||||
|
||||
func (r *Render) compileTemplatesFromAsset() {
|
||||
dir := r.opt.Directory
|
||||
r.templates = template.New(dir)
|
||||
r.templates.Delims(r.opt.Delims.Left, r.opt.Delims.Right)
|
||||
|
||||
for _, path := range r.opt.AssetNames() {
|
||||
if !strings.HasPrefix(path, dir) {
|
||||
continue
|
||||
}
|
||||
|
||||
rel, err := filepath.Rel(dir, path)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
ext := ""
|
||||
if strings.Index(rel, ".") != -1 {
|
||||
ext = "." + strings.Join(strings.Split(rel, ".")[1:], ".")
|
||||
}
|
||||
|
||||
for _, extension := range r.opt.Extensions {
|
||||
if ext == extension {
|
||||
|
||||
buf, err := r.opt.Asset(path)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
name := (rel[0 : len(rel)-len(ext)])
|
||||
tmpl := r.templates.New(filepath.ToSlash(name))
|
||||
|
||||
// Add our funcmaps.
|
||||
for _, funcs := range r.opt.Funcs {
|
||||
tmpl.Funcs(funcs)
|
||||
}
|
||||
|
||||
// Break out if this parsing fails. We don't want any silent server starts.
|
||||
template.Must(tmpl.Funcs(helperFuncs).Parse(string(buf)))
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// TemplateLookup is a wrapper around template.Lookup and returns
|
||||
// the template with the given name that is associated with t, or nil
|
||||
// if there is no such template.
|
||||
func (r *Render) TemplateLookup(t string) *template.Template {
|
||||
return r.templates.Lookup(t)
|
||||
}
|
||||
|
||||
func (r *Render) execute(name string, binding interface{}) (*bytes.Buffer, error) {
|
||||
buf := new(bytes.Buffer)
|
||||
return buf, r.templates.ExecuteTemplate(buf, name, binding)
|
||||
}
|
||||
|
||||
func (r *Render) layoutFuncs(name string, binding interface{}) template.FuncMap {
|
||||
return template.FuncMap{
|
||||
"yield": func() (template.HTML, error) {
|
||||
buf, err := r.execute(name, binding)
|
||||
// Return safe HTML here since we are rendering our own template.
|
||||
return template.HTML(buf.String()), err
|
||||
},
|
||||
"current": func() (string, error) {
|
||||
return name, nil
|
||||
},
|
||||
"block": func(partialName string) (template.HTML, error) {
|
||||
log.Print("Render's `block` implementation is now depericated. Use `partial` as a drop in replacement.")
|
||||
fullPartialName := fmt.Sprintf("%s-%s", partialName, name)
|
||||
if r.TemplateLookup(fullPartialName) == nil && r.opt.RenderPartialsWithoutPrefix {
|
||||
fullPartialName = partialName
|
||||
}
|
||||
if r.opt.RequireBlocks || r.TemplateLookup(fullPartialName) != nil {
|
||||
buf, err := r.execute(fullPartialName, binding)
|
||||
// Return safe HTML here since we are rendering our own template.
|
||||
return template.HTML(buf.String()), err
|
||||
}
|
||||
return "", nil
|
||||
},
|
||||
"partial": func(partialName string) (template.HTML, error) {
|
||||
fullPartialName := fmt.Sprintf("%s-%s", partialName, name)
|
||||
if r.TemplateLookup(fullPartialName) == nil && r.opt.RenderPartialsWithoutPrefix {
|
||||
fullPartialName = partialName
|
||||
}
|
||||
if r.opt.RequirePartials || r.TemplateLookup(fullPartialName) != nil {
|
||||
buf, err := r.execute(fullPartialName, binding)
|
||||
// Return safe HTML here since we are rendering our own template.
|
||||
return template.HTML(buf.String()), err
|
||||
}
|
||||
return "", nil
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func (r *Render) prepareHTMLOptions(htmlOpt []HTMLOptions) HTMLOptions {
|
||||
layout := r.opt.Layout
|
||||
funcs := template.FuncMap{}
|
||||
|
||||
for _, tmp := range r.opt.Funcs {
|
||||
for k, v := range tmp {
|
||||
funcs[k] = v
|
||||
}
|
||||
}
|
||||
|
||||
if len(htmlOpt) > 0 {
|
||||
opt := htmlOpt[0]
|
||||
if len(opt.Layout) > 0 {
|
||||
layout = opt.Layout
|
||||
}
|
||||
|
||||
for k, v := range opt.Funcs {
|
||||
funcs[k] = v
|
||||
}
|
||||
}
|
||||
|
||||
return HTMLOptions{
|
||||
Layout: layout,
|
||||
Funcs: funcs,
|
||||
}
|
||||
}
|
||||
|
||||
// Render is the generic function called by XML, JSON, Data, HTML, and can be called by custom implementations.
|
||||
func (r *Render) Render(w io.Writer, e Engine, data interface{}) error {
|
||||
err := e.Render(w, data)
|
||||
if hw, ok := w.(http.ResponseWriter); err != nil && !r.opt.DisableHTTPErrorRendering && ok {
|
||||
http.Error(hw, err.Error(), http.StatusInternalServerError)
|
||||
}
|
||||
return err
|
||||
}
|
||||
|
||||
// Data writes out the raw bytes as binary data.
|
||||
func (r *Render) Data(w io.Writer, status int, v []byte) error {
|
||||
head := Head{
|
||||
ContentType: r.opt.BinaryContentType,
|
||||
Status: status,
|
||||
}
|
||||
|
||||
d := Data{
|
||||
Head: head,
|
||||
}
|
||||
|
||||
return r.Render(w, d, v)
|
||||
}
|
||||
|
||||
// HTML builds up the response from the specified template and bindings.
|
||||
func (r *Render) HTML(w io.Writer, status int, name string, binding interface{}, htmlOpt ...HTMLOptions) error {
|
||||
r.templatesLk.Lock()
|
||||
defer r.templatesLk.Unlock()
|
||||
|
||||
// If we are in development mode, recompile the templates on every HTML request.
|
||||
if r.opt.IsDevelopment {
|
||||
r.compileTemplates()
|
||||
}
|
||||
|
||||
opt := r.prepareHTMLOptions(htmlOpt)
|
||||
if tpl := r.templates.Lookup(name); tpl != nil {
|
||||
if len(opt.Layout) > 0 {
|
||||
tpl.Funcs(r.layoutFuncs(name, binding))
|
||||
name = opt.Layout
|
||||
}
|
||||
|
||||
if len(opt.Funcs) > 0 {
|
||||
tpl.Funcs(opt.Funcs)
|
||||
}
|
||||
}
|
||||
|
||||
head := Head{
|
||||
ContentType: r.opt.HTMLContentType + r.compiledCharset,
|
||||
Status: status,
|
||||
}
|
||||
|
||||
h := HTML{
|
||||
Head: head,
|
||||
Name: name,
|
||||
Templates: r.templates,
|
||||
}
|
||||
|
||||
return r.Render(w, h, binding)
|
||||
}
|
||||
|
||||
// JSON marshals the given interface object and writes the JSON response.
|
||||
func (r *Render) JSON(w io.Writer, status int, v interface{}) error {
|
||||
head := Head{
|
||||
ContentType: r.opt.JSONContentType + r.compiledCharset,
|
||||
Status: status,
|
||||
}
|
||||
|
||||
j := JSON{
|
||||
Head: head,
|
||||
Indent: r.opt.IndentJSON,
|
||||
Prefix: r.opt.PrefixJSON,
|
||||
UnEscapeHTML: r.opt.UnEscapeHTML,
|
||||
StreamingJSON: r.opt.StreamingJSON,
|
||||
}
|
||||
|
||||
return r.Render(w, j, v)
|
||||
}
|
||||
|
||||
// JSONP marshals the given interface object and writes the JSON response.
|
||||
func (r *Render) JSONP(w io.Writer, status int, callback string, v interface{}) error {
|
||||
head := Head{
|
||||
ContentType: r.opt.JSONPContentType + r.compiledCharset,
|
||||
Status: status,
|
||||
}
|
||||
|
||||
j := JSONP{
|
||||
Head: head,
|
||||
Indent: r.opt.IndentJSON,
|
||||
Callback: callback,
|
||||
}
|
||||
|
||||
return r.Render(w, j, v)
|
||||
}
|
||||
|
||||
// Text writes out a string as plain text.
|
||||
func (r *Render) Text(w io.Writer, status int, v string) error {
|
||||
head := Head{
|
||||
ContentType: r.opt.TextContentType + r.compiledCharset,
|
||||
Status: status,
|
||||
}
|
||||
|
||||
t := Text{
|
||||
Head: head,
|
||||
}
|
||||
|
||||
return r.Render(w, t, v)
|
||||
}
|
||||
|
||||
// XML marshals the given interface object and writes the XML response.
|
||||
func (r *Render) XML(w io.Writer, status int, v interface{}) error {
|
||||
head := Head{
|
||||
ContentType: r.opt.XMLContentType + r.compiledCharset,
|
||||
Status: status,
|
||||
}
|
||||
|
||||
x := XML{
|
||||
Head: head,
|
||||
Indent: r.opt.IndentXML,
|
||||
Prefix: r.opt.PrefixXML,
|
||||
}
|
||||
|
||||
return r.Render(w, x, v)
|
||||
}
|
Loading…
Add table
Add a link
Reference in a new issue