-
Notifications
You must be signed in to change notification settings - Fork 11
/
context_x_request.go
618 lines (537 loc) · 14.8 KB
/
context_x_request.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
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
package echo
import (
"fmt"
"io"
"mime/multipart"
"os"
"path/filepath"
"strconv"
"strings"
"github.com/webx-top/echo/engine"
"github.com/webx-top/echo/param"
)
// Request returns *http.Request.
func (c *XContext) Request() engine.Request {
return c.request
}
// Path returns the registered path for the handler.
func (c *XContext) Path() string {
return c.path
}
// P returns path parameter by index.
func (c *XContext) P(i int, defaults ...string) (value string) {
l := len(c.pvalues)
if i < l {
value = c.pvalues[i]
}
if len(value) == 0 && len(defaults) > 0 {
return defaults[0]
}
return
}
func (c *XContext) Px(n int, defaults ...string) param.String {
return param.String(c.P(n, defaults...))
}
// Param returns path parameter by name.
func (c *XContext) Param(name string, defaults ...string) (value string) {
l := len(c.pvalues)
for i, n := range c.pnames {
if i < l && n == name {
value = c.pvalues[i]
break
}
}
if len(value) == 0 && len(defaults) > 0 {
return defaults[0]
}
return
}
func (c *XContext) Paramx(name string, defaults ...string) param.String {
return param.String(c.Param(name, defaults...))
}
func (c *XContext) ParamNames() []string {
return c.pnames
}
func (c *XContext) ParamValues() []string {
return c.pvalues[:len(c.pvalues)]
}
func (c *XContext) SetParamNames(names ...string) {
c.pnames = names
l := len(names)
if *c.echo.maxParam < l {
*c.echo.maxParam = l
}
if len(c.pvalues) < l {
// Keeping the old pvalues just for backward compatibility, but it sounds that doesn't make sense to keep them,
// probably those values will be overriden in a Context#SetParamValues
newPvalues := make([]string, l)
copy(newPvalues, c.pvalues)
c.pvalues = newPvalues
}
}
func (c *XContext) SetParamValues(values ...string) {
// NOTE: Don't just set c.pvalues = values, because it has to have length c.echo.maxParam at all times
// It will brake the Router#Find code
limit := len(values)
if limit > *c.echo.maxParam {
limit = *c.echo.maxParam
}
for i := 0; i < limit; i++ {
c.pvalues[i] = values[i]
}
}
func (c *XContext) AddHostParam(name string, value string) {
c.hnames = append(c.hnames, name)
c.hvalues = append(c.hvalues, value)
}
func (c *XContext) SetHostParamNames(names ...string) {
c.hnames = names
}
func (c *XContext) SetHostParamValues(values ...string) {
c.hvalues = values
}
func (c *XContext) HostParamNames() []string {
return c.hnames
}
func (c *XContext) HostParamValues() []string {
return c.hvalues[:len(c.hvalues)]
}
// HostP returns host parameter by index.
func (c *XContext) HostP(i int, defaults ...string) (value string) {
l := len(c.hvalues)
if i < l {
value = c.hvalues[i]
}
if len(value) == 0 && len(defaults) > 0 {
return defaults[0]
}
return
}
// HostParam returns host parameter by name.
func (c *XContext) HostParam(name string, defaults ...string) (value string) {
l := len(c.hvalues)
for i, n := range c.hnames {
if i < l && n == name {
value = c.hvalues[i]
break
}
}
if len(value) == 0 && len(defaults) > 0 {
return defaults[0]
}
return
}
// Query returns query parameter by name.
func (c *XContext) Query(name string, defaults ...string) (value string) {
value = c.request.URL().QueryValue(name)
if len(value) == 0 && len(defaults) > 0 {
return defaults[0]
}
return
}
func (c *XContext) Queryx(name string, defaults ...string) param.String {
return param.String(c.Query(name, defaults...))
}
func (c *XContext) QueryValues(name string) []string {
return c.request.URL().QueryValues(name)
}
func (c *XContext) QueryxValues(name string) param.StringSlice {
return param.StringSlice(c.request.URL().QueryValues(name))
}
func (c *XContext) Queries() map[string][]string {
return c.request.URL().Query()
}
// Form returns form parameter by name.
func (c *XContext) Form(name string, defaults ...string) (value string) {
value = c.request.FormValue(name)
if len(value) == 0 && len(defaults) > 0 {
return defaults[0]
}
return
}
func (c *XContext) Formx(name string, defaults ...string) param.String {
return param.String(c.Form(name, defaults...))
}
func (c *XContext) FormValues(name string) []string {
return c.request.Form().Gets(name)
}
func (c *XContext) FormxValues(name string) param.StringSlice {
return param.StringSlice(c.request.Form().Gets(name))
}
func (c *XContext) Forms() map[string][]string {
return c.request.Form().All()
}
// Bind binds the request body into specified type `i`. The default binder does
// it based on Content-Type header.
func (c *XContext) Bind(i interface{}, filter ...FormDataFilter) error {
return c.echo.binder.Bind(i, c, filter...)
}
func (c *XContext) BindAndValidate(i interface{}, filter ...FormDataFilter) error {
return c.echo.binder.BindAndValidate(i, c, filter...)
}
func (c *XContext) MustBind(i interface{}, filter ...FormDataFilter) error {
return c.echo.binder.MustBind(i, c, filter...)
}
func (c *XContext) MustBindAndValidate(i interface{}, filter ...FormDataFilter) error {
return c.echo.binder.MustBindAndValidate(i, c, filter...)
}
func (c *XContext) BindWithDecoder(i interface{}, valueDecoders BinderValueCustomDecoders, filter ...FormDataFilter) error {
return c.echo.binder.BindWithDecoder(i, c, valueDecoders, filter...)
}
func (c *XContext) BindAndValidateWithDecoder(i interface{}, valueDecoders BinderValueCustomDecoders, filter ...FormDataFilter) error {
return c.echo.binder.BindAndValidateWithDecoder(i, c, valueDecoders, filter...)
}
func (c *XContext) MustBindWithDecoder(i interface{}, valueDecoders BinderValueCustomDecoders, filter ...FormDataFilter) error {
return c.echo.binder.MustBindWithDecoder(i, c, valueDecoders, filter...)
}
func (c *XContext) MustBindAndValidateWithDecoder(i interface{}, valueDecoders BinderValueCustomDecoders, filter ...FormDataFilter) error {
return c.echo.binder.MustBindAndValidateWithDecoder(i, c, valueDecoders, filter...)
}
func (c *XContext) Header(name string) string {
return c.Request().Header().Get(name)
}
func (c *XContext) IsAjax() bool {
return c.Header(`X-Requested-With`) == `XMLHttpRequest`
}
func (c *XContext) IsPjax() bool {
return len(c.Header(`X-PJAX`)) > 0 || len(c.PjaxContainer()) > 0
}
func (c *XContext) PjaxContainer() string {
container := c.Header(`X-PJAX-Container`)
if len(container) > 0 {
return container
}
return c.Query(`_pjax`)
}
func (c *XContext) Method() string {
return c.Request().Method()
}
func (c *XContext) Format() string {
if len(c.format) == 0 {
c.format = c.ResolveFormat()
}
return c.format
}
func (c *XContext) IsMethod(method string) bool {
return strings.EqualFold(c.Method(), method)
}
// IsPost CREATE:在服务器新建一个资源
func (c *XContext) IsPost() bool {
return c.IsMethod(POST)
}
// IsGet SELECT:从服务器取出资源(一项或多项)
func (c *XContext) IsGet() bool {
return c.IsMethod(GET)
}
// IsPut UPDATE:在服务器更新资源(客户端提供改变后的完整资源)
func (c *XContext) IsPut() bool {
return c.IsMethod(PUT)
}
// IsDel DELETE:从服务器删除资源
func (c *XContext) IsDel() bool {
return c.IsMethod(DELETE)
}
// IsHead 获取资源的元数据
func (c *XContext) IsHead() bool {
return c.IsMethod(HEAD)
}
// IsPatch UPDATE:在服务器更新资源(客户端提供改变的属性)
func (c *XContext) IsPatch() bool {
return c.IsMethod(PATCH)
}
// IsOptions 获取信息,关于资源的哪些属性是客户端可以改变的
func (c *XContext) IsOptions() bool {
return c.IsMethod(OPTIONS)
}
func (c *XContext) IsSecure() bool {
return c.Scheme() == `https`
}
// IsWebsocket returns boolean of this request is in webSocket.
func (c *XContext) IsWebsocket() bool {
upgrade := c.Header(`Upgrade`)
return strings.EqualFold(upgrade, `websocket`)
}
// IsUpload returns boolean of whether file uploads in this request or not..
func (c *XContext) IsUpload() bool {
return c.ResolveContentType() == MIMEMultipartForm
}
// ResolveContentType Get the content type.
// e.g. From `multipart/form-data; boundary=--` to `multipart/form-data`
// If none is specified, returns `text/html` by default.
func (c *XContext) ResolveContentType() string {
contentType := c.Header(HeaderContentType)
if len(contentType) == 0 {
return `text/html`
}
return strings.ToLower(strings.TrimSpace(strings.SplitN(contentType, `;`, 2)[0]))
}
// ResolveFormat maps the request's Accept MIME type declaration to
// a Request.Format attribute, specifically `html`, `xml`, `json`, or `txt`,
// returning a default of `html` when Accept header cannot be mapped to a
// value above.
func (c *XContext) ResolveFormat() string {
if format := c.Query(`format`); len(format) > 0 {
return format
}
if c.withFormatExtension {
urlPath := c.Request().URL().Path()
if pos := strings.LastIndex(urlPath, `.`); pos > -1 {
return strings.ToLower(urlPath[pos+1:])
}
}
info := c.Accept()
for _, accepts := range info.Accepts {
for _, accept := range accepts.Type {
if format, ok := c.echo.acceptFormats[accept.Mime]; ok {
return format
}
}
}
if format, ok := c.echo.acceptFormats[`*`]; ok {
return format
}
return `html`
}
func (c *XContext) Accept() *Accepts {
if c.accept != nil {
return c.accept
}
c.accept = NewAccepts(c.Header(HeaderAccept))
if c.echo.parseHeaderAccept {
return c.accept.Advance()
}
return c.accept.Simple(3)
}
// Protocol returns request protocol name, such as HTTP/1.1 .
func (c *XContext) Protocol() string {
return c.Request().Proto()
}
// Site returns base site url as scheme://domain/ type.
func (c *XContext) Site() string {
return c.Scheme() + `://` + c.Request().Host() + `/`
}
func (c *XContext) FullRequestURI() string {
return c.Scheme() + `://` + c.Request().Host() + c.RequestURI()
}
func (c *XContext) RequestURI() string {
if len(c.Request().URI()) == 0 {
q := c.Request().URL().RawQuery()
if len(q) > 0 {
q = `?` + q
}
return c.Request().URL().Path() + q
}
return c.Request().URI()
}
// Scheme returns request scheme as `http` or `https`.
func (c *XContext) Scheme() string {
scheme := c.Header(HeaderXForwardedProto)
if len(scheme) > 0 {
return scheme
}
return c.Request().Scheme()
}
// Domain returns host name.
// Alias of Host method.
func (c *XContext) Domain() string {
return c.Host()
}
// Host returns host name.
// if no host info in request, return localhost.
func (c *XContext) Host() string {
host := c.Request().Host()
if len(host) > 0 {
delim := `:`
var isIPv6 bool
if host[0] == '[' {
isIPv6 = true
delim = `]:`
}
hostParts := strings.SplitN(host, delim, 2)
if len(hostParts) == 2 {
host = hostParts[0]
if isIPv6 {
host += `]`
}
}
return host
}
return `localhost`
}
// Proxy returns proxy client ips slice.
func (c *XContext) Proxy() []string {
if ips := c.Header(`X-Forwarded-For`); len(ips) > 0 {
return strings.Split(ips, `,`)
}
return []string{}
}
// Referer returns http referer header.
func (c *XContext) Referer() string {
return c.Header(`Referer`)
}
func (c *XContext) RealIP() string {
if len(c.realIP) > 0 {
return c.realIP
}
c.realIP = c.echo.RealIPConfig().ClientIP(c.Request().RemoteAddress(), c.Header)
return c.realIP
}
// Port returns request client port.
// when error or empty, return 80.
func (c *XContext) Port() int {
host := c.Request().Host()
delim := `:`
if len(host) > 0 && host[0] == '[' {
delim = `]:`
}
parts := strings.SplitN(host, delim, 2)
if len(parts) > 1 {
port, _ := strconv.Atoi(parts[1])
return port
}
return 80
}
// MapForm 映射表单数据到结构体
// ParseStruct mapping forms' name and values to struct's field
// For example:
//
// <form>
// <input name=`user.id`/>
// <input name=`user.name`/>
// <input name=`user.age`/>
// </form>
//
// type User struct {
// Id int64
// Name string
// Age string
// }
//
// var user User
// err := c.MapForm(&user,`user`)
func (c *XContext) MapForm(i interface{}, names ...string) error {
return c.MapData(i, c.Request().Form().All(), names...)
}
func (c *XContext) SaveUploadedFile(fieldName string, saveAbsPath string, saveFileName ...func(*multipart.FileHeader) (string, error)) (*multipart.FileHeader, error) {
fileSrc, fileHdr, err := c.Request().FormFile(fieldName)
if err != nil {
return fileHdr, err
}
defer fileSrc.Close()
// Destination
fileName := fileHdr.Filename
if len(saveFileName) > 0 && saveFileName[0] != nil {
fileName, err = saveFileName[0](fileHdr)
if err != nil {
return fileHdr, err
}
}
fileDst, err := os.Create(filepath.Join(saveAbsPath, fileName))
if err != nil {
return fileHdr, err
}
defer fileDst.Close()
// Copy
if _, err = io.Copy(fileDst, fileSrc); err != nil {
return fileHdr, err
}
return fileHdr, nil
}
func (c *XContext) SaveUploadedFileToWriter(fieldName string, writer io.Writer) (*multipart.FileHeader, error) {
fileSrc, fileHdr, err := c.Request().FormFile(fieldName)
if err != nil {
return fileHdr, err
}
defer fileSrc.Close()
if _, err = io.Copy(writer, fileSrc); err != nil {
return fileHdr, err
}
return fileHdr, nil
}
func (c *XContext) SaveUploadedFiles(fieldName string, savePath func(*multipart.FileHeader) (string, error)) error {
m, err := c.Request().MultipartForm()
if err != nil {
return err
}
files, ok := m.File[fieldName]
if !ok {
return fmt.Errorf(`%w: %s`, ErrNotFoundFileInput, fieldName)
}
var dstFile string
for _, fileHdr := range files {
//for each fileheader, get a handle to the actual file
file, err := fileHdr.Open()
if err != nil {
file.Close()
return err
}
dstFile, err = savePath(fileHdr)
if err != nil {
file.Close()
return err
}
if len(dstFile) == 0 {
file.Close()
continue
}
//create destination file making sure the path is writeable.
dst, err := os.Create(dstFile)
if err != nil {
file.Close()
return err
}
//copy the uploaded file to the destination file
if _, err := io.Copy(dst, file); err != nil {
file.Close()
dst.Close()
return err
}
file.Close()
dst.Close()
}
return nil
}
func (c *XContext) SaveUploadedFilesToWriter(fieldName string, writer func(*multipart.FileHeader) (io.Writer, error)) error {
m, err := c.Request().MultipartForm()
if err != nil {
return err
}
files, ok := m.File[fieldName]
if !ok {
return fmt.Errorf(`%w: %s`, ErrNotFoundFileInput, fieldName)
}
var w io.Writer
for _, fileHdr := range files {
//for each fileheader, get a handle to the actual file
file, err := fileHdr.Open()
if err != nil {
file.Close()
return err
}
w, err = writer(fileHdr)
if err != nil {
file.Close()
return err
}
if w == nil {
continue
}
//copy the uploaded file to the destination file
if _, err := io.Copy(w, file); err != nil {
file.Close()
if v, ok := w.(Closer); ok {
v.Close()
}
return err
}
file.Close()
if v, ok := w.(Closer); ok {
v.Close()
}
}
return nil
}
// HasAnyRequest 是否提交了参数
func (c *XContext) HasAnyRequest() bool {
return len(c.Request().Form().All()) > 0
}