-
Notifications
You must be signed in to change notification settings - Fork 3
/
route_matchers.go
221 lines (197 loc) · 6.11 KB
/
route_matchers.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
// Copyright 2023 Cisco Systems, Inc. and its affiliates
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// SPDX-License-Identifier: Apache-2.0
package matcher
import (
"context"
"fmt"
"github.com/cisco-open/go-lanai/pkg/utils/matcher"
"github.com/cisco-open/go-lanai/pkg/web"
"net/url"
pathutils "path"
"strings"
)
// routeMatcher implement web.RouteMatcher
type routeMatcher struct {
description string
matchableFunc func(*web.Route) interface{}
delegate matcher.Matcher
}
func (m *routeMatcher) RouteMatches(c context.Context, r *web.Route) (bool, error) {
if m.matchableFunc == nil {
return m.delegate.MatchesWithContext(c, r)
}
return m.delegate.MatchesWithContext(c, m.matchableFunc(r))
}
func (m *routeMatcher) Matches(i interface{}) (bool, error) {
value, err := interfaceToRoute(i)
if err != nil {
return false, err
}
return m.RouteMatches(context.TODO(), value)
}
func (m *routeMatcher) MatchesWithContext(c context.Context, i interface{}) (bool, error) {
value, err := interfaceToRoute(i)
if err != nil {
return false, err
}
return m.RouteMatches(c, value)
}
func (m *routeMatcher) Or(matchers ...matcher.Matcher) matcher.ChainableMatcher {
return matcher.Or(m, matchers...)
}
func (m *routeMatcher) And(matchers ...matcher.Matcher) matcher.ChainableMatcher {
return matcher.And(m, matchers...)
}
func (m *routeMatcher) String() string {
switch stringer, ok :=m.delegate.(fmt.Stringer); {
case len(m.description) != 0:
return m.description
case ok:
return stringer.String()
default:
return "RouteMatcher"
}
}
/**************************
Constructors
***************************/
func AnyRoute() web.RouteMatcher {
return wrapAsRouteMatcher(matcher.Any())
}
func RouteWithMethods(methods...string) web.RouteMatcher {
var delegate matcher.ChainableMatcher
if len(methods) == 0 {
delegate = matcher.Any()
} else {
delegate = matcher.WithString(methods[0], true)
for _,m := range methods[1:] {
delegate = delegate.Or(matcher.WithString(m, true))
}
}
return &routeMatcher{
description: fmt.Sprintf("method %s", delegate.(fmt.Stringer).String()),
matchableFunc: routeMethod,
delegate: delegate,
}
}
// RouteWithPattern checks web.Route's path with prefix
// The prefix syntax is:
//
// prefix:
// { term }
// term:
// '*' matches any sequence of non-path-separators
// '**' matches any sequence of characters, including
// path separators.
// '?' matches any single non-path-separator character
// '[' [ '^' ] { character-range } ']'
// character class (must be non-empty)
// '{' { term } [ ',' { term } ... ] '}'
// c matches character c (c != '*', '?', '\\', '[')
// '\\' c matches character c
//
// character-range:
// c matches character c (c != '\\', '-', ']')
// '\\' c matches character c
// lo '-' hi matches character c for lo <= c <= hi
func RouteWithPattern(pattern string, methods...string) web.RouteMatcher {
pDelegate := matcher.WithPathPattern(pattern)
pMatcher := &routeMatcher{
description: fmt.Sprintf(descTmplPath, pDelegate.(fmt.Stringer).String()),
matchableFunc: routeAbsPath,
delegate: pDelegate,
}
mMatcher := RouteWithMethods(methods...)
return wrapAsRouteMatcher(pMatcher.And(mMatcher))
}
// RouteWithURL is similar with RouteWithPattern, but instead it takes a relative URL path and convert it to pattern
// by extracting "path" part (remove #fragment, ?query and more)
func RouteWithURL(url string, methods...string) web.RouteMatcher {
return RouteWithPattern(PatternFromURL(url), methods...)
}
func RouteWithPrefix(prefix string, methods...string) web.RouteMatcher {
pDelegate := matcher.WithPrefix(prefix, true)
pMatcher := &routeMatcher{
description: fmt.Sprintf(descTmplPath, pDelegate.(fmt.Stringer).String()),
matchableFunc: routeAbsPath,
delegate: pDelegate,
}
mMatcher := RouteWithMethods(methods...)
return wrapAsRouteMatcher(pMatcher.And(mMatcher))
}
func RouteWithRegex(regex string, methods...string) web.RouteMatcher {
pDelegate := matcher.WithRegex(regex)
pMatcher := &routeMatcher{
description: fmt.Sprintf(descTmplPath, pDelegate.(fmt.Stringer).String()),
matchableFunc: routeAbsPath,
delegate: pDelegate,
}
mMatcher := RouteWithMethods(methods...)
return wrapAsRouteMatcher(pMatcher.And(mMatcher))
}
func RouteWithGroup(group string) web.RouteMatcher {
delegate := matcher.WithString(group, false)
return &routeMatcher{
description: fmt.Sprintf("group %s", delegate.(fmt.Stringer).String()),
matchableFunc: routeGroup,
delegate: delegate,
}
}
// PatternFromURL convert relative URL to pattern by necessary operations, such as remove #fragment portion
func PatternFromURL(relativeUrl string) string {
u, e := url.Parse(relativeUrl)
if e != nil {
split := strings.SplitN(relativeUrl, "#", 2)
return split[0]
}
return u.Path
}
/**************************
helpers
***************************/
func interfaceToRoute(i interface{}) (*web.Route, error) {
switch v := i.(type) {
case web.Route:
return &v, nil
case *web.Route:
return v, nil
default:
return nil, fmt.Errorf("RouteMatcher doesn't support %T", i)
}
}
func routeGroup(r *web.Route) interface{} {
return r.Group
}
func routeMethod(r *web.Route) interface{} {
return r.Method
}
func routeAbsPath(r *web.Route) interface{} {
p := pathutils.Join(r.Group, r.Path)
if !pathutils.IsAbs(p) {
p = "/" + p
}
return pathutils.Clean(p)
}
func wrapAsRouteMatcher(m matcher.Matcher) web.RouteMatcher {
var desc string
if stringer, ok := m.(fmt.Stringer); ok {
desc = stringer.String()
}
return &routeMatcher{
description: desc,
delegate: m,
}
}