forked from labstack/echo
-
Notifications
You must be signed in to change notification settings - Fork 0
/
context.go
330 lines (287 loc) · 7.56 KB
/
context.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
package echo
import (
"encoding/json"
"encoding/xml"
"io"
"mime"
"net/http"
"os"
"path/filepath"
"time"
"github.com/labstack/echo/engine"
"github.com/labstack/echo/logger"
"net/url"
"bytes"
netContext "golang.org/x/net/context"
"golang.org/x/net/websocket"
)
type (
// Context represents context for the current request. It holds request and
// response objects, path parameters, data and registered handler.
Context interface {
netContext.Context
Request() engine.Request
Response() engine.Response
Socket() *websocket.Conn
Path() string
P(int) string
Param(string) string
Query(string) string
Form(string) string
Set(string, interface{})
Get(string) interface{}
Bind(interface{}) error
Render(int, string, interface{}) error
HTML(int, string) error
String(int, string) error
JSON(int, interface{}) error
JSONBlob(int, []byte) error
JSONP(int, string, interface{}) error
XML(int, interface{}) error
XMLBlob(int, []byte) error
Attachment(string) error
NoContent(int) error
Redirect(int, string) error
Error(err error)
Handle(Context) error
Logger() logger.Logger
Echo() *Echo
Object() *context
}
context struct {
request engine.Request
response engine.Response
socket *websocket.Conn
path string
pnames []string
pvalues []string
query url.Values
store store
handler Handler
echo *Echo
}
store map[string]interface{}
)
const (
indexPage = "index.html"
)
// NewContext creates a Context object.
func NewContext(req engine.Request, res engine.Response, e *Echo) Context {
return &context{
request: req,
response: res,
echo: e,
pvalues: make([]string, *e.maxParam),
store: make(store),
handler: notFoundHandler,
}
}
func (c *context) Handle(ctx Context) error {
return c.handler.Handle(ctx)
}
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{} {
return nil
}
// Request returns *http.Request.
func (c *context) Request() engine.Request {
return c.request
}
// Response returns *Response.
func (c *context) Response() engine.Response {
return c.response
}
// Socket returns *websocket.Conn.
func (c *context) Socket() *websocket.Conn {
return c.socket
}
// Path returns the registered path for the handler.
func (c *context) Path() string {
return c.path
}
// P returns path parameter by index.
func (c *context) P(i int) (value string) {
l := len(c.pnames)
if i < l {
value = c.pvalues[i]
}
return
}
// Param returns path parameter by name.
func (c *context) Param(name string) (value string) {
l := len(c.pnames)
for i, n := range c.pnames {
if n == name && i < l {
value = c.pvalues[i]
break
}
}
return
}
// Query returns query parameter by name.
func (c *context) Query(name string) string {
return c.request.URL().QueryValue(name)
}
// Form returns form parameter by name.
func (c *context) Form(name string) string {
return c.request.FormValue(name)
}
// Get retrieves data from the context.
func (c *context) Get(key string) interface{} {
return c.store[key]
}
// Set saves data in the context.
func (c *context) Set(key string, val interface{}) {
if c.store == nil {
c.store = make(store)
}
c.store[key] = val
}
// Bind binds the request body into specified type `i`. The default binder does
// it based on Content-Type header.
func (c *context) Bind(i interface{}) error {
return c.echo.binder.Bind(c.request, i)
}
// Render renders a template with data and sends a text/html response with status
// code. Templates can be registered using `Echo.SetRenderer()`.
func (c *context) Render(code int, name string, data interface{}) (err error) {
if c.echo.renderer == nil {
return ErrRendererNotRegistered
}
buf := new(bytes.Buffer)
if err = c.echo.renderer.Render(buf, name, data); err != nil {
return
}
c.response.Header().Set(ContentType, TextHTMLCharsetUTF8)
c.response.WriteHeader(code)
c.response.Write(buf.Bytes())
return
}
// HTML sends an HTTP response with status code.
func (c *context) HTML(code int, html string) (err error) {
c.response.Header().Set(ContentType, TextHTMLCharsetUTF8)
c.response.WriteHeader(code)
c.response.Write([]byte(html))
return
}
// String sends a string response with status code.
func (c *context) String(code int, s string) (err error) {
c.response.Header().Set(ContentType, TextPlainCharsetUTF8)
c.response.WriteHeader(code)
c.response.Write([]byte(s))
return
}
// JSON sends a JSON response with status code.
func (c *context) JSON(code int, i interface{}) (err error) {
b, err := json.Marshal(i)
if c.echo.Debug() {
b, err = json.MarshalIndent(i, "", " ")
}
if err != nil {
return err
}
return c.JSONBlob(code, b)
}
// JSONBlob sends a JSON blob response with status code.
func (c *context) JSONBlob(code int, b []byte) (err error) {
c.response.Header().Set(ContentType, ApplicationJSONCharsetUTF8)
c.response.WriteHeader(code)
c.response.Write(b)
return
}
// JSONP sends a JSONP response with status code. It uses `callback` to construct
// the JSONP payload.
func (c *context) JSONP(code int, callback string, i interface{}) (err error) {
b, err := json.Marshal(i)
if err != nil {
return err
}
c.response.Header().Set(ContentType, ApplicationJavaScriptCharsetUTF8)
c.response.WriteHeader(code)
c.response.Write([]byte(callback + "("))
c.response.Write(b)
c.response.Write([]byte(");"))
return
}
// XML sends an XML response with status code.
func (c *context) XML(code int, i interface{}) (err error) {
b, err := xml.Marshal(i)
if c.echo.Debug() {
b, err = xml.MarshalIndent(i, "", " ")
}
if err != nil {
return err
}
return c.XMLBlob(code, b)
}
// XMLBlob sends a XML blob response with status code.
func (c *context) XMLBlob(code int, b []byte) (err error) {
c.response.Header().Set(ContentType, ApplicationXMLCharsetUTF8)
c.response.WriteHeader(code)
c.response.Write([]byte(xml.Header))
c.response.Write(b)
return
}
// Attachment sends specified file as an attachment to the client.
func (c *context) Attachment(file string) (err error) {
f, err := os.Open(file)
if err != nil {
return
}
_, name := filepath.Split(file)
c.response.Header().Set(ContentDisposition, "attachment; filename="+name)
c.response.Header().Set(ContentType, c.detectContentType(file))
c.response.WriteHeader(http.StatusOK)
_, err = io.Copy(c.response, f)
return
}
// NoContent sends a response with no body and a status code.
func (c *context) NoContent(code int) error {
c.response.WriteHeader(code)
return nil
}
// Redirect redirects the request with status code.
func (c *context) Redirect(code int, url string) error {
if code < http.StatusMultipleChoices || code > http.StatusTemporaryRedirect {
return ErrInvalidRedirectCode
}
c.response.Header().Set(Location, url)
c.response.WriteHeader(code)
return nil
}
// Error invokes the registered HTTP error handler. Generally used by middleware.
func (c *context) Error(err error) {
c.echo.httpErrorHandler(err, c)
}
// Echo returns the `Echo` instance.
func (c *context) Echo() *Echo {
return c.echo
}
// Logger returns the `Logger` instance.
func (c *context) Logger() logger.Logger {
return c.echo.logger
}
// Object returns the `context` object.
func (c *context) Object() *context {
return c
}
func (c *context) detectContentType(name string) (t string) {
if t = mime.TypeByExtension(filepath.Ext(name)); t == "" {
t = OctetStream
}
return
}
func (c *context) reset(req engine.Request, res engine.Response) {
c.request = req
c.response = res
c.query = nil
c.store = nil
}