-
Notifications
You must be signed in to change notification settings - Fork 394
/
filter.go
464 lines (393 loc) · 11.4 KB
/
filter.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
// Copyright (C) 2023 Storj Labs, Inc.
// See LICENSE for copying information.
package nodeselection
import (
"encoding/hex"
"fmt"
"os"
"sort"
"strings"
"github.com/zeebo/errs"
"storj.io/common/storj"
"storj.io/common/storj/location"
)
// NodeFilter can decide if a Node should be part of the selection or not.
type NodeFilter interface {
Match(node *SelectedNode) bool
}
// NodeFilterWithAnnotation is a NodeFilter with additional annotations.
type NodeFilterWithAnnotation interface {
NodeFilter
GetAnnotation(name string) string
}
// Annotation can be used as node filters in 'XX && annotation('...')' like struct.
type Annotation struct {
Key string
Value string
}
// Match implements NodeFilter.
func (a Annotation) Match(node *SelectedNode) bool {
return true
}
// GetAnnotation implements NodeFilterWithAnnotation.
func (a Annotation) GetAnnotation(name string) string {
if a.Key == name {
return a.Value
}
return ""
}
func (a Annotation) String() string {
return fmt.Sprintf(`annotation("%s","%s")`, a.Key, a.Value)
}
var _ NodeFilterWithAnnotation = Annotation{}
// AnnotatedNodeFilter is just a NodeFilter with additional annotations.
type AnnotatedNodeFilter struct {
Filter NodeFilter
Annotations []Annotation
}
// GetAnnotation implements NodeFilterWithAnnotation.
func (a AnnotatedNodeFilter) GetAnnotation(name string) string {
for _, a := range a.Annotations {
if a.Key == name {
return a.Value
}
}
if annotated, ok := a.Filter.(NodeFilterWithAnnotation); ok {
return annotated.GetAnnotation(name)
}
return ""
}
// Match implements NodeFilter.
func (a AnnotatedNodeFilter) Match(node *SelectedNode) bool {
return a.Filter.Match(node)
}
func (a AnnotatedNodeFilter) String() string {
var annotationStr []string
for _, annotation := range a.Annotations {
annotationStr = append(annotationStr, annotation.String())
}
return fmt.Sprintf("%s && %s", a.Filter, strings.Join(annotationStr, " && "))
}
// WithAnnotation adds annotations to a NodeFilter.
func WithAnnotation(filter NodeFilter, name string, value string) NodeFilterWithAnnotation {
return AnnotatedNodeFilter{
Filter: filter,
Annotations: []Annotation{
{
Key: name,
Value: value,
},
},
}
}
// GetAnnotation retrieves annotation from AnnotatedNodeFilter.
func GetAnnotation(filter NodeFilter, name string) string {
if annotated, ok := filter.(NodeFilterWithAnnotation); ok {
return annotated.GetAnnotation(name)
}
return ""
}
var _ NodeFilterWithAnnotation = AnnotatedNodeFilter{}
// NodeFilters is a collection of multiple node filters (all should vote with true).
type NodeFilters []NodeFilter
// NodeFilterFunc is helper to use func as NodeFilter.
type NodeFilterFunc func(node *SelectedNode) bool
// Match implements NodeFilter interface.
func (n NodeFilterFunc) Match(node *SelectedNode) bool {
return n(node)
}
// ExcludeAllFilter will never select any node.
type ExcludeAllFilter struct{}
// Match implements NodeFilter interface.
func (ExcludeAllFilter) Match(node *SelectedNode) bool { return false }
// Match implements NodeFilter interface.
func (n NodeFilters) Match(node *SelectedNode) bool {
for _, filter := range n {
if !filter.Match(node) {
return false
}
}
return true
}
// OrFilter will include the node, if at lest one of the filters are matched.
type OrFilter []NodeFilter
// Match implements NodeFilter interface.
func (n OrFilter) Match(node *SelectedNode) bool {
for _, filter := range n {
if filter.Match(node) {
return true
}
}
return false
}
func (n OrFilter) String() string {
var parts []string
for _, filter := range n {
parts = append(parts, fmt.Sprintf("%s", filter))
}
return "(" + strings.Join(parts, " || ") + ")"
}
// WithCountryFilter is a helper to create a new filter with additional CountryFilter.
func (n NodeFilters) WithCountryFilter(permit location.Set) NodeFilters {
return append(n, NewCountryFilter(permit))
}
// WithExcludedIDs is a helper to create a new filter with additional WithExcludedIDs.
func (n NodeFilters) WithExcludedIDs(ds []storj.NodeID) NodeFilters {
return append(n, ExcludedIDs(ds))
}
func (n NodeFilters) String() string {
if len(n) == 1 {
return fmt.Sprintf("%s", n[0])
}
var res []string
for _, filter := range n {
res = append(res, fmt.Sprintf("%s", filter))
}
sort.Strings(res)
return "(" + strings.Join(res, " && ") + ")"
}
// GetAnnotation implements NodeFilterWithAnnotation.
func (n NodeFilters) GetAnnotation(name string) string {
for _, filter := range n {
if annotated, ok := filter.(NodeFilterWithAnnotation); ok {
value := annotated.GetAnnotation(name)
if value != "" {
return value
}
}
}
return ""
}
var _ NodeFilterWithAnnotation = NodeFilters{}
// CountryFilter can select nodes based on the condition of the country code.
type CountryFilter struct {
permit location.Set
}
// NewCountryFilter creates a new CountryFilter.
func NewCountryFilter(permit location.Set) *CountryFilter {
return &CountryFilter{
permit: permit,
}
}
// NewCountryFilterFromString parses country definitions like 'hu','!hu','*','none' and creates a CountryFilter.
func NewCountryFilterFromString(countries []string) (*CountryFilter, error) {
var set location.Set
for _, country := range countries {
apply := func(modified location.Set, code ...location.CountryCode) location.Set {
return modified.With(code...)
}
if country[0] == '!' {
apply = func(modified location.Set, code ...location.CountryCode) location.Set {
return modified.Without(code...)
}
country = country[1:]
}
switch strings.ToLower(country) {
case "all", "*", "any":
set = location.NewFullSet()
case "none":
set = apply(set, location.None)
case "eu":
set = apply(set, EuCountries...)
case "eea":
set = apply(set, EuCountries...)
set = apply(set, EeaCountriesWithoutEu...)
default:
code := location.ToCountryCode(country)
if code == location.None {
return nil, errs.New("invalid country code %q", code)
}
set = apply(set, code)
}
}
return NewCountryFilter(set), nil
}
// Match implements NodeFilter interface.
func (p *CountryFilter) Match(node *SelectedNode) bool {
return p.permit.Contains(node.CountryCode)
}
func (p *CountryFilter) String() string {
var included, excluded []string
for country, iso := range location.CountryISOCode {
if p.permit.Contains(location.CountryCode(country)) {
included = append(included, iso)
} else {
excluded = append(excluded, "!"+iso)
}
}
if len(excluded) < len(included) {
sort.Strings(excluded)
return fmt.Sprintf(`country("*","%s")`, strings.Join(excluded, `","`))
}
sort.Strings(included)
return fmt.Sprintf(`country("%s")`, strings.Join(included, `","`))
}
var _ NodeFilter = &CountryFilter{}
// ExcludedNetworks will exclude nodes with specified networks.
type ExcludedNetworks []string
// Match implements NodeFilter interface.
func (e ExcludedNetworks) Match(node *SelectedNode) bool {
for _, id := range e {
if id == node.LastNet {
return false
}
}
return true
}
var _ NodeFilter = ExcludedNetworks{}
// ExcludedNodeNetworks exclude nodes which has same net as the one of the specified.
type ExcludedNodeNetworks []*SelectedNode
// Match implements NodeFilter interface.
func (e ExcludedNodeNetworks) Match(node *SelectedNode) bool {
for _, n := range e {
if node.LastNet == n.LastNet {
return false
}
}
return true
}
var _ NodeFilter = ExcludedNodeNetworks{}
// ExcludedIDs can blacklist NodeIDs.
type ExcludedIDs []storj.NodeID
// Match implements NodeFilter interface.
func (e ExcludedIDs) Match(node *SelectedNode) bool {
for _, id := range e {
if id == node.ID {
return false
}
}
return true
}
var _ NodeFilter = ExcludedIDs{}
// ValueMatch defines how to compare tag value with the defined one.
type ValueMatch func(a []byte, b []byte) bool
// TagFilter matches nodes with specific tags.
type TagFilter struct {
signer storj.NodeID
name string
value []byte
match ValueMatch
}
// NewTagFilter creates a new tag filter.
func NewTagFilter(id storj.NodeID, name string, value []byte, match ValueMatch) TagFilter {
return TagFilter{
signer: id,
name: name,
value: value,
match: match,
}
}
// Match implements NodeFilter interface.
func (t TagFilter) Match(node *SelectedNode) bool {
for _, tag := range node.Tags {
if tag.Name == t.name && t.match(tag.Value, t.value) && tag.Signer == t.signer {
return true
}
}
return false
}
func (t TagFilter) String() string {
return fmt.Sprintf(`tag("%s","%s","%s")`, t.signer, t.name, string(t.value))
}
var _ NodeFilter = TagFilter{}
// ExcludeFilter excludes only the matched nodes.
type ExcludeFilter struct {
matchToExclude NodeFilter
}
// Match implements NodeFilter interface.
func (e ExcludeFilter) Match(node *SelectedNode) bool {
return !e.matchToExclude.Match(node)
}
func (e ExcludeFilter) String() string {
return fmt.Sprintf("exclude(%s)", e.matchToExclude)
}
// NewExcludeFilter creates filter, nodes matching the given filter will be excluded.
func NewExcludeFilter(filter NodeFilter) ExcludeFilter {
return ExcludeFilter{
matchToExclude: filter,
}
}
var _ NodeFilter = ExcludeFilter{}
// AnyFilter matches all the nodes.
type AnyFilter struct{}
// Match implements NodeFilter interface.
func (a AnyFilter) Match(node *SelectedNode) bool {
return true
}
var _ NodeFilter = AnyFilter{}
// AllowedNodesFilter is a special filter which enables only the selected nodes.
type AllowedNodesFilter []storj.NodeID
// AllowedNodesFromFile loads a list of allowed NodeIDs from a text file. One ID per line.
func AllowedNodesFromFile(file string) (AllowedNodesFilter, error) {
l := AllowedNodesFilter{}
raw, err := os.ReadFile(file)
if err != nil {
return l, errs.Wrap(err)
}
for _, line := range strings.Split(string(raw), "\n") {
line = strings.TrimSpace(line)
if line == "" || strings.HasPrefix(line, "#") {
continue
}
id, err := parseHexOrBase58ID(line)
if err != nil {
return l, errs.Wrap(err)
}
l = append(l, id)
}
return l, nil
}
func parseHexOrBase58ID(line string) (storj.NodeID, error) {
id, err := storj.NodeIDFromString(line)
if err == nil {
return id, nil
}
raw, err := hex.DecodeString(line)
if err != nil {
return storj.NodeID{}, errs.New("Line is neither hex nor base58 nodeID: %s", line)
}
id, err = storj.NodeIDFromBytes(raw)
if err != nil {
return storj.NodeID{}, errs.New("Line is neither hex nor base58 nodeID: %s", line)
}
return id, nil
}
// Match implements NodeFilter.
func (n AllowedNodesFilter) Match(node *SelectedNode) bool {
for _, white := range n {
if node.ID == white {
return true
}
}
return false
}
var _ NodeFilter = AllowedNodesFilter{}
// AttributeFilter selects nodes based on dynamic node attributes (eg. vetted=true or tag:owner=...).
type AttributeFilter struct {
attribute NodeAttribute
value interface{}
}
// NewAttributeFilter creates new attribute filter. Value should be string or stringNotMatch.
func NewAttributeFilter(attr string, value interface{}) (*AttributeFilter, error) {
attribute, err := CreateNodeAttribute(attr)
if err != nil {
return nil, err
}
return &AttributeFilter{
value: value,
attribute: attribute,
}, nil
}
// Match implements NodeFilter.
func (a *AttributeFilter) Match(node *SelectedNode) bool {
attribute := a.attribute(*node)
switch v := a.value.(type) {
case stringNotMatch:
return attribute != string(v)
case string:
return attribute == a.value
default:
return false
}
}
var _ NodeFilter = &AttributeFilter{}