Repository navigation
Expand file tree
/
Copy pathcompression.diff
More file actions
518 lines (493 loc) · 18 KB
/
Copy pathcompression.diff
File metadata and controls
518 lines (493 loc) · 18 KB
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
--- input/input.go
+++ output/output.go
@@ -31,15 +31,7 @@
var defaultPlatform string
var defaultTrustedCIDRs = []*net.IPNet{
- { // 0.0.0.0/0 (IPv4)
- IP: net.IP{0x0, 0x0, 0x0, 0x0},
- Mask: net.IPMask{0x0, 0x0, 0x0, 0x0},
- },
- { // ::/0 (IPv6)
- IP: net.IP{0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0},
- Mask: net.IPMask{0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0},
- },
-}
+ { … 9 line(s) … ⟦tj:d30e8e961b5f84edc079373f424d6a7a⟧ }
var regSafePrefix = regexp.MustCompile("[^a-zA-Z0-9/-]+")
var regRemoveRepeatedChar = regexp.MustCompile("/{2,}")
@@ -89,91 +81,8 @@
type Engine struct {
RouterGroup
- // RedirectTrailingSlash enables automatic redirection if the current route can't be matched but a
- // handler for the path with (without) the trailing slash exists.
- // For example if /foo/ is requested but a route only exists for /foo, the
- // client is redirected to /foo with http status code 301 for GET requests
- // and 307 for all other request methods.
- RedirectTrailingSlash bool
-
- // RedirectFixedPath if enabled, the router tries to fix the current request path, if no
- // handle is registered for it.
- // First superfluous path elements like ../ or // are removed.
- // Afterwards the router does a case-insensitive lookup of the cleaned path.
- // If a handle can be found for this route, the router makes a redirection
- // to the corrected path with status code 301 for GET requests and 307 for
- // all other request methods.
- // For example /FOO and /..//Foo could be redirected to /foo.
- // RedirectTrailingSlash is independent of this option.
- RedirectFixedPath bool
-
- // HandleMethodNotAllowed if enabled, the router checks if another method is allowed for the
- // current route, if the current request can not be routed.
- // If this is the case, the request is answered with 'Method Not Allowed'
- // and HTTP status code 405.
- // If no other Method is allowed, the request is delegated to the NotFound
- // handler.
- HandleMethodNotAllowed bool
-
- // ForwardedByClientIP if enabled, client IP will be parsed from the request's headers that
- // match those stored at `(*gin.Engine).RemoteIPHeaders`. If no IP was
- // fetched, it falls back to the IP obtained from
- // `(*gin.Context).Request.RemoteAddr`.
- ForwardedByClientIP bool
-
- // AppEngine was deprecated.
- // Deprecated: USE `TrustedPlatform` WITH VALUE `gin.PlatformGoogleAppEngine` INSTEAD
- // #726 #755 If enabled, it will trust some headers starting with
- // 'X-AppEngine...' for better integration with that PaaS.
- AppEngine bool
-
- // UseRawPath if enabled, the url.RawPath will be used to find parameters.
- UseRawPath bool
-
- // UnescapePathValues if true, the path value will be unescaped.
- // If UseRawPath is false (by default), the UnescapePathValues effectively is true,
- // as url.Path gonna be used, which is already unescaped.
- UnescapePathValues bool
-
- // RemoveExtraSlash a parameter can be parsed from the URL even with extra slashes.
- // See the PR #1817 and issue #1644
- RemoveExtraSlash bool
-
- // RemoteIPHeaders list of headers used to obtain the client IP when
- // `(*gin.Engine).ForwardedByClientIP` is `true` and
- // `(*gin.Context).Request.RemoteAddr` is matched by at least one of the
- // network origins of list defined by `(*gin.Engine).SetTrustedProxies()`.
- RemoteIPHeaders []string
-
- // TrustedPlatform if set to a constant of value gin.Platform*, trusts the headers set by
- // that platform, for example to determine the client IP
- TrustedPlatform string
-
- // MaxMultipartMemory value of 'maxMemory' param that is given to http.Request's ParseMultipartForm
- // method call.
- MaxMultipartMemory int64
-
- // UseH2C enable h2c support.
- UseH2C bool
-
- // ContextWithFallback enable fallback Context.Deadline(), Context.Done(), Context.Err() and Context.Value() when Context.Request.Context() is not nil.
- ContextWithFallback bool
-
- delims render.Delims
- secureJSONPrefix string
- HTMLRender render.HTMLRender
- FuncMap template.FuncMap
- allNoRoute HandlersChain
- allNoMethod HandlersChain
- noRoute HandlersChain
- noMethod HandlersChain
- pool sync.Pool
- trees methodTrees
- maxParams uint16
- maxSections uint16
- trustedProxies []string
+ { … 83 line(s) … ⟦tj:f78abca3b9da69e14887ab4aa5614f74⟧ }
trustedCIDRs []*net.IPNet
-}
var _ IRouter = (*Engine)(nil)
@@ -255,19 +164,8 @@
// LoadHTMLGlob loads HTML files identified by glob pattern
// and associates the result with HTML renderer.
func (engine *Engine) LoadHTMLGlob(pattern string) {
- left := engine.delims.Left
- right := engine.delims.Right
- templ := template.Must(template.New("").Delims(left, right).Funcs(engine.FuncMap).ParseGlob(pattern))
-
- if IsDebugging() {
- debugPrintLoadTemplate(templ)
- engine.HTMLRender = render.HTMLDebug{Glob: pattern, FuncMap: engine.FuncMap, Delims: engine.delims}
- return
- }
+ { … 12 line(s) … ⟦tj:c1cfa93c3649127a14fde2dd1e2eebdd⟧ }
- engine.SetHTMLTemplate(templ)
-}
-
// LoadHTMLFiles loads a slice of HTML files
// and associates the result with HTML renderer.
func (engine *Engine) LoadHTMLFiles(files ...string) {
@@ -336,27 +234,9 @@
func (engine *Engine) addRoute(method, path string, handlers HandlersChain) {
assert1(path[0] == '/', "path must begin with '/'")
assert1(method != "", "HTTP method can not be empty")
- assert1(len(handlers) > 0, "there must be at least one handler")
-
- debugPrintRoute(method, path, handlers)
-
- root := engine.trees.get(method)
- if root == nil {
- root = new(node)
- root.fullPath = "/"
- engine.trees = append(engine.trees, methodTree{method: method, root: root})
+ { … 18 line(s) … ⟦tj:5deeecbaea67c29b78eef1c2b4c912d6⟧ }
}
- root.addRoute(path, handlers)
- if paramsCount := countParams(path); paramsCount > engine.maxParams {
- engine.maxParams = paramsCount
- }
-
- if sectionsCount := countSections(path); sectionsCount > engine.maxSections {
- engine.maxSections = sectionsCount
- }
-}
-
// Routes returns a slice of registered routes, including some useful information, such as:
// the http method, path and the handler name.
func (engine *Engine) Routes() (routes RoutesInfo) {
@@ -369,65 +249,20 @@
func iterate(path, method string, routes RoutesInfo, root *node) RoutesInfo {
path += root.path
if len(root.handlers) > 0 {
- handlerFunc := root.handlers.Last()
- routes = append(routes, RouteInfo{
- Method: method,
- Path: path,
- Handler: nameOfFunction(handlerFunc),
- HandlerFunc: handlerFunc,
- })
- }
- for _, child := range root.children {
- routes = iterate(path, method, routes, child)
- }
+ { … 11 line(s) … ⟦tj:eede543f50d4fd33f461447a03400d0e⟧ }
return routes
-}
// Run attaches the router to a http.Server and starts listening and serving HTTP requests.
// It is a shortcut for http.ListenAndServe(addr, router)
// Note: this method will block the calling goroutine indefinitely unless an error happens.
func (engine *Engine) Run(addr ...string) (err error) {
- defer func() { debugPrintError(err) }()
+ { … 12 line(s) … ⟦tj:a5a2c24dcee25964ee9ed18f5a2d59ca⟧ }
- if engine.isUnsafeTrustedProxies() {
- debugPrint("[WARNING] You trusted all proxies, this is NOT safe. We recommend you to set a value.\n" +
- "Please check https://pkg.go.dev/github.com/gin-gonic/gin#readme-don-t-trust-all-proxies for details.")
- }
-
- address := resolveAddress(addr)
- debugPrint("Listening and serving HTTP on %s\n", address)
- err = http.ListenAndServe(address, engine.Handler())
- return
-}
-
func (engine *Engine) prepareTrustedCIDRs() ([]*net.IPNet, error) {
if engine.trustedProxies == nil {
return nil, nil
- }
-
- cidr := make([]*net.IPNet, 0, len(engine.trustedProxies))
- for _, trustedProxy := range engine.trustedProxies {
- if !strings.Contains(trustedProxy, "/") {
- ip := parseIP(trustedProxy)
- if ip == nil {
- return cidr, &net.ParseError{Type: "IP address", Text: trustedProxy}
- }
-
- switch len(ip) {
- case net.IPv4len:
- trustedProxy += "/32"
- case net.IPv6len:
- trustedProxy += "/128"
- }
- }
- _, cidrNet, err := net.ParseCIDR(trustedProxy)
- if err != nil {
- return cidr, err
- }
- cidr = append(cidr, cidrNet)
- }
+ { … 23 line(s) … ⟦tj:c388988f790d046f1cf730bb5611f864⟧ }
return cidr, nil
-}
// SetTrustedProxies set a list of network origins (IPv4 addresses,
// IPv4 CIDRs, IPv6 addresses or IPv6 CIDRs) from which to trust
@@ -456,91 +291,34 @@
// isTrustedProxy will check whether the IP address is included in the trusted list according to Engine.trustedCIDRs
func (engine *Engine) isTrustedProxy(ip net.IP) bool {
- if engine.trustedCIDRs == nil {
- return false
- }
- for _, cidr := range engine.trustedCIDRs {
- if cidr.Contains(ip) {
- return true
- }
- }
- return false
-}
+ { … 10 line(s) … ⟦tj:cc54f8165d78b923fdf0d25cd4bf2eeb⟧ }
// validateHeader will parse X-Forwarded-For header and return the trusted client IP address
func (engine *Engine) validateHeader(header string) (clientIP string, valid bool) {
if header == "" {
return "", false
- }
- items := strings.Split(header, ",")
- for i := len(items) - 1; i >= 0; i-- {
- ipStr := strings.TrimSpace(items[i])
- ip := net.ParseIP(ipStr)
- if ip == nil {
- break
- }
-
- // X-Forwarded-For is appended by proxy
- // Check IPs in reverse order and stop when find untrusted proxy
- if (i == 0) || (!engine.isTrustedProxy(ip)) {
- return ipStr, true
- }
- }
+ { … 15 line(s) … ⟦tj:9b0d41c56cad29ffe197448d28883aab⟧ }
return "", false
-}
// parseIP parse a string representation of an IP and returns a net.IP with the
// minimum byte representation or nil if input is invalid.
func parseIP(ip string) net.IP {
- parsedIP := net.ParseIP(ip)
+ { … 10 line(s) … ⟦tj:d17148c18b636f842b70a94dcfadd096⟧ }
- if ipv4 := parsedIP.To4(); ipv4 != nil {
- // return ip in a 4-byte representation
- return ipv4
- }
-
- // return ip in a 16-byte representation or nil
- return parsedIP
-}
-
// RunTLS attaches the router to a http.Server and starts listening and serving HTTPS (secure) requests.
// It is a shortcut for http.ListenAndServeTLS(addr, certFile, keyFile, router)
// Note: this method will block the calling goroutine indefinitely unless an error happens.
func (engine *Engine) RunTLS(addr, certFile, keyFile string) (err error) {
- debugPrint("Listening and serving HTTPS on %s\n", addr)
- defer func() { debugPrintError(err) }()
+ { … 11 line(s) … ⟦tj:c958d59fe4ec9efa0f38345cb2c77914⟧ }
- if engine.isUnsafeTrustedProxies() {
- debugPrint("[WARNING] You trusted all proxies, this is NOT safe. We recommend you to set a value.\n" +
- "Please check https://pkg.go.dev/github.com/gin-gonic/gin#readme-don-t-trust-all-proxies for details.")
- }
-
- err = http.ListenAndServeTLS(addr, certFile, keyFile, engine.Handler())
- return
-}
-
// RunUnix attaches the router to a http.Server and starts listening and serving HTTP requests
// through the specified unix socket (i.e. a file).
// Note: this method will block the calling goroutine indefinitely unless an error happens.
func (engine *Engine) RunUnix(file string) (err error) {
debugPrint("Listening and serving HTTP on unix:/%s", file)
defer func() { debugPrintError(err) }()
-
- if engine.isUnsafeTrustedProxies() {
- debugPrint("[WARNING] You trusted all proxies, this is NOT safe. We recommend you to set a value.\n" +
- "Please check https://github.com/gin-gonic/gin/blob/master/docs/doc.md#dont-trust-all-proxies for details.")
- }
-
- listener, err := net.Listen("unix", file)
- if err != nil {
- return
- }
- defer listener.Close()
- defer os.Remove(file)
-
- err = http.Serve(listener, engine.Handler())
+ { … 14 line(s) … ⟦tj:2e07bf767bb9fe721b12817640f4ec17⟧ }
return
-}
// RunFd attaches the router to a http.Server and starts listening and serving HTTP requests
// through the specified file descriptor.
@@ -548,49 +326,18 @@
func (engine *Engine) RunFd(fd int) (err error) {
debugPrint("Listening and serving HTTP on fd@%d", fd)
defer func() { debugPrintError(err) }()
-
- if engine.isUnsafeTrustedProxies() {
- debugPrint("[WARNING] You trusted all proxies, this is NOT safe. We recommend you to set a value.\n" +
- "Please check https://github.com/gin-gonic/gin/blob/master/docs/doc.md#dont-trust-all-proxies for details.")
- }
-
- f := os.NewFile(uintptr(fd), fmt.Sprintf("fd@%d", fd))
- listener, err := net.FileListener(f)
- if err != nil {
- return
- }
- defer listener.Close()
- err = engine.RunListener(listener)
+ { … 13 line(s) … ⟦tj:c90f1d59d409ceac85b84cae3cc6cb5d⟧ }
return
-}
// RunListener attaches the router to a http.Server and starts listening and serving HTTP requests
// through the specified net.Listener
func (engine *Engine) RunListener(listener net.Listener) (err error) {
- debugPrint("Listening and serving HTTP on listener what's bind with address@%s", listener.Addr())
- defer func() { debugPrintError(err) }()
+ { … 11 line(s) … ⟦tj:62f86923a1025587e486f9457a3f1427⟧ }
- if engine.isUnsafeTrustedProxies() {
- debugPrint("[WARNING] You trusted all proxies, this is NOT safe. We recommend you to set a value.\n" +
- "Please check https://github.com/gin-gonic/gin/blob/master/docs/doc.md#dont-trust-all-proxies for details.")
- }
-
- err = http.Serve(listener, engine.Handler())
- return
-}
-
// ServeHTTP conforms to the http.Handler interface.
func (engine *Engine) ServeHTTP(w http.ResponseWriter, req *http.Request) {
- c := engine.pool.Get().(*Context)
- c.writermem.reset(w)
- c.Request = req
- c.reset()
+ { … 9 line(s) … ⟦tj:088a419231b2bd43ac9fd91324cc0e21⟧ }
- engine.handleHTTPRequest(c)
-
- engine.pool.Put(c)
-}
-
// HandleContext re-enters a context that has been rewritten.
// This can be done by setting c.Request.URL.Path to your new target.
// Disclaimer: You can loop yourself to deal with this, use wisely.
@@ -605,128 +352,28 @@
func (engine *Engine) handleHTTPRequest(c *Context) {
httpMethod := c.Request.Method
rPath := c.Request.URL.Path
- unescape := false
- if engine.UseRawPath && len(c.Request.URL.RawPath) > 0 {
- rPath = c.Request.URL.RawPath
- unescape = engine.UnescapePathValues
- }
-
- if engine.RemoveExtraSlash {
- rPath = cleanPath(rPath)
- }
-
- // Find root of the tree for the given HTTP method
- t := engine.trees
- for i, tl := 0, len(t); i < tl; i++ {
- if t[i].method != httpMethod {
- continue
- }
- root := t[i].root
- // Find route in tree
- value := root.getValue(rPath, c.params, c.skippedNodes, unescape)
- if value.params != nil {
- c.Params = *value.params
- }
- if value.handlers != nil {
- c.handlers = value.handlers
- c.fullPath = value.fullPath
- c.Next()
- c.writermem.WriteHeaderNow()
- return
- }
- if httpMethod != http.MethodConnect && rPath != "/" {
- if value.tsr && engine.RedirectTrailingSlash {
- redirectTrailingSlash(c)
- return
- }
- if engine.RedirectFixedPath && redirectFixedPath(c, root, engine.RedirectFixedPath) {
- return
- }
- }
- break
- }
-
- if engine.HandleMethodNotAllowed {
- // According to RFC 7231 section 6.5.5, MUST generate an Allow header field in response
- // containing a list of the target resource's currently supported methods.
- allowed := make([]string, 0, len(t)-1)
- for _, tree := range engine.trees {
- if tree.method == httpMethod {
- continue
- }
- if value := tree.root.getValue(rPath, nil, c.skippedNodes, unescape); value.handlers != nil {
- allowed = append(allowed, tree.method)
- }
- }
- if len(allowed) > 0 {
- c.handlers = engine.allNoMethod
- c.writermem.Header().Set("Allow", strings.Join(allowed, ", "))
- serveError(c, http.StatusMethodNotAllowed, default405Body)
- return
- }
- }
-
- c.handlers = engine.allNoRoute
+ { … 62 line(s) … ⟦tj:0a6be3fbb3ae01e55804912581bd4de9⟧ }
serveError(c, http.StatusNotFound, default404Body)
-}
var mimePlain = []string{MIMEPlain}
func serveError(c *Context, code int, defaultMessage []byte) {
c.writermem.status = code
c.Next()
- if c.writermem.Written() {
- return
- }
- if c.writermem.Status() == code {
- c.writermem.Header()["Content-Type"] = mimePlain
- _, err := c.Writer.Write(defaultMessage)
- if err != nil {
- debugPrint("cannot write message to writer during serve error: %v", err)
- }
- return
- }
+ { … 11 line(s) … ⟦tj:551439b850d5ee525b3916449dc7d590⟧ }
c.writermem.WriteHeaderNow()
-}
func redirectTrailingSlash(c *Context) {
req := c.Request
p := req.URL.Path
- if prefix := path.Clean(c.Request.Header.Get("X-Forwarded-Prefix")); prefix != "." {
- prefix = regSafePrefix.ReplaceAllString(prefix, "")
- prefix = regRemoveRepeatedChar.ReplaceAllString(prefix, "/")
-
- p = prefix + "/" + req.URL.Path
- }
- req.URL.Path = p + "/"
- if length := len(p); length > 1 && p[length-1] == '/' {
- req.URL.Path = p[:length-1]
- }
+ { … 10 line(s) … ⟦tj:b18e7c6c786f377d0e93c83e5a810f52⟧ }
redirectRequest(c)
-}
func redirectFixedPath(c *Context, root *node, trailingSlash bool) bool {
- req := c.Request
- rPath := req.URL.Path
+ { … 10 line(s) … ⟦tj:d755f6528f617b784bf641fcc85db54f⟧ }
- if fixedPath, ok := root.findCaseInsensitivePath(cleanPath(rPath), trailingSlash); ok {
- req.URL.Path = bytesconv.BytesToString(fixedPath)
- redirectRequest(c)
- return true
- }
- return false
-}
-
func redirectRequest(c *Context) {
- req := c.Request
- rPath := req.URL.Path
- rURL := req.URL.String()
+ { … 12 line(s) … ⟦tj:9ad853a1d85c5d4bfc75a62a27680eea⟧ }
+[omitted blocks are individually retrievable: call tinyjuice_retrieve with the token inside an omission marker to expand just that block]
- code := http.StatusMovedPermanently // Permanent redirect, request with GET method
- if req.Method != http.MethodGet {
- code = http.StatusTemporaryRedirect
- }
- debugPrint("redirecting request %d: %s --> %s", code, rPath, rURL)
- http.Redirect(c.Writer, req, rURL, code)
- c.writermem.WriteHeaderNow()
-}
+[PARTIAL view — full original (23812 bytes): call tinyjuice_retrieve with token "b396db448f7ac685ae9384a0a6bc9712"]
\ No newline at end of file