Repository navigation
Expand file tree
/
Copy pathroute.go
More file actions
205 lines (181 loc) · 5.37 KB
/
Copy pathroute.go
File metadata and controls
205 lines (181 loc) · 5.37 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
// SPDX-License-Identifier: MIT
// SPDX-FileCopyrightText: © 2015 LabStack LLC and Echo contributors
package echo
import (
"bytes"
"errors"
"fmt"
"reflect"
"runtime"
"strings"
)
// Route contains information to adding/registering new route with the router.
// Method+Path pair uniquely identifies the Route. It is mandatory to provide Method+Path fields.
type Route struct {
Method string
Path string
Name string
// HandlerFunc is a function that handles HTTP requests. This could be left nil when the Router implementation allows
// fallback to default/global handlers in certain situations.
Handler HandlerFunc
Middlewares []MiddlewareFunc
// allowOverwrite permits this route to replace an existing route with the same method+path,
// overriding the router's AllowOverwritingRoute config for this specific registration.
allowOverwrite bool
}
// ToRouteInfo converts Route to RouteInfo
func (r Route) ToRouteInfo(params []string) RouteInfo {
name := r.Name
if name == "" {
name = r.Method + ":" + r.Path
}
return RouteInfo{
Method: r.Method,
Path: r.Path,
Parameters: append([]string(nil), params...),
Name: name,
}
}
// WithPrefix recreates Route with added group prefix and group middlewares it is grouped to.
func (r Route) WithPrefix(pathPrefix string, middlewares []MiddlewareFunc) Route {
r.Path = pathPrefix + r.Path
if len(middlewares) > 0 {
m := make([]MiddlewareFunc, 0, len(middlewares)+len(r.Middlewares))
m = append(m, middlewares...)
m = append(m, r.Middlewares...)
r.Middlewares = m
}
return r
}
// RouteInfo contains information about registered Route.
type RouteInfo struct {
Name string
Method string
Path string
Parameters []string
// NOTE: handler and middlewares are not exposed because handler could be already wrapping middlewares. Therefore,
// it is not always 100% known if handler function already wraps middlewares or not. In Echo handler could be one
// function or several functions wrapping each other.
}
// Clone creates copy of RouteInfo
func (r RouteInfo) Clone() RouteInfo {
return RouteInfo{
Name: r.Name,
Method: r.Method,
Path: r.Path,
Parameters: append([]string(nil), r.Parameters...),
}
}
// Reverse reverses route to URL string by replacing path parameters with given params values.
func (r RouteInfo) Reverse(pathValues ...any) string {
uri := new(bytes.Buffer)
nextValue := 0
walkRoutePath(r.Path, func(part routePathPart) {
switch part.kind {
case staticKind:
uri.WriteString(part.value)
case paramKind:
if nextValue < len(pathValues) {
fmt.Fprint(uri, pathValues[nextValue])
nextValue++
} else {
// placeholder for a missing value. An escaped colon in a param name is written without its backslash.
uri.WriteByte(paramLabel)
uri.WriteString(strings.ReplaceAll(part.value, `\:`, ":"))
}
case anyKind:
if nextValue < len(pathValues) {
fmt.Fprint(uri, pathValues[nextValue])
nextValue++
} else {
uri.WriteString(strings.ReplaceAll(part.value, `\:`, ":"))
}
}
})
return uri.String()
}
// HandlerName returns string name for given function.
func HandlerName(h HandlerFunc) string {
t := reflect.ValueOf(h).Type()
if t.Kind() == reflect.Func {
return runtime.FuncForPC(reflect.ValueOf(h).Pointer()).Name()
}
return t.String()
}
// Clone creates copy of Routes
func (r Routes) Clone() Routes {
result := make(Routes, len(r))
for i, route := range r {
result[i] = route.Clone()
}
return result
}
// Reverse reverses route to URL string by replacing path parameters with given params values.
func (r Routes) Reverse(routeName string, pathValues ...any) (string, error) {
for _, rr := range r {
if rr.Name == routeName {
return rr.Reverse(pathValues...), nil
}
}
return "", errors.New("route not found")
}
// FindByMethodPath searched for matching route info by method and path
func (r Routes) FindByMethodPath(method string, path string) (RouteInfo, error) {
if r == nil {
return RouteInfo{}, errors.New("route not found by method and path")
}
for _, rr := range r {
if rr.Method == method && rr.Path == path {
return rr, nil
}
}
return RouteInfo{}, errors.New("route not found by method and path")
}
// FilterByMethod searched for matching route info by method
func (r Routes) FilterByMethod(method string) (Routes, error) {
if r == nil {
return nil, errors.New("route not found by method")
}
result := make(Routes, 0)
for _, rr := range r {
if rr.Method == method {
result = append(result, rr)
}
}
if len(result) == 0 {
return nil, errors.New("route not found by method")
}
return result, nil
}
// FilterByPath searched for matching route info by path
func (r Routes) FilterByPath(path string) (Routes, error) {
if r == nil {
return nil, errors.New("route not found by path")
}
result := make(Routes, 0)
for _, rr := range r {
if rr.Path == path {
result = append(result, rr)
}
}
if len(result) == 0 {
return nil, errors.New("route not found by path")
}
return result, nil
}
// FilterByName searched for matching route info by name
func (r Routes) FilterByName(name string) (Routes, error) {
if r == nil {
return nil, errors.New("route not found by name")
}
result := make(Routes, 0)
for _, rr := range r {
if rr.Name == name {
result = append(result, rr)
}
}
if len(result) == 0 {
return nil, errors.New("route not found by name")
}
return result, nil
}