-
Notifications
You must be signed in to change notification settings - Fork 114
/
sanitize.go
172 lines (146 loc) · 4.79 KB
/
sanitize.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
// Copyright (c) 2018 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package tally
import (
"bytes"
)
var (
// DefaultReplacementCharacter is the default character used for
// replacements.
DefaultReplacementCharacter = '_'
// AlphanumericRange is the range of alphanumeric characters.
AlphanumericRange = []SanitizeRange{
{rune('a'), rune('z')},
{rune('A'), rune('Z')},
{rune('0'), rune('9')}}
// UnderscoreDashCharacters is a slice of underscore, and
// dash characters.
UnderscoreDashCharacters = []rune{
'-',
'_'}
// UnderscoreDashDotCharacters is a slice of underscore,
// dash, and dot characters.
UnderscoreDashDotCharacters = []rune{
'.',
'-',
'_'}
)
// SanitizeFn returns a sanitized version of the input string.
type SanitizeFn func(string) string
// SanitizeRange is a range of characters (inclusive on both ends).
type SanitizeRange [2]rune
// ValidCharacters is a collection of valid characters.
type ValidCharacters struct {
Ranges []SanitizeRange
Characters []rune
}
// SanitizeOptions are the set of configurable options for sanitisation.
type SanitizeOptions struct {
NameCharacters ValidCharacters
KeyCharacters ValidCharacters
ValueCharacters ValidCharacters
ReplacementCharacter rune
}
// Sanitizer sanitizes the provided input based on the function executed.
type Sanitizer interface {
// Name sanitizes the provided `name` string.
Name(n string) string
// Key sanitizes the provided `key` string.
Key(k string) string
// Value sanitizes the provided `value` string.
Value(v string) string
}
// NewSanitizer returns a new sanitizer based on provided options.
func NewSanitizer(opts SanitizeOptions) Sanitizer {
return sanitizer{
nameFn: opts.NameCharacters.sanitizeFn(opts.ReplacementCharacter),
keyFn: opts.KeyCharacters.sanitizeFn(opts.ReplacementCharacter),
valueFn: opts.ValueCharacters.sanitizeFn(opts.ReplacementCharacter),
}
}
// NoOpSanitizeFn returns the input un-touched.
func NoOpSanitizeFn(v string) string { return v }
// NewNoOpSanitizer returns a sanitizer which returns all inputs un-touched.
func NewNoOpSanitizer() Sanitizer {
return sanitizer{
nameFn: NoOpSanitizeFn,
keyFn: NoOpSanitizeFn,
valueFn: NoOpSanitizeFn,
}
}
type sanitizer struct {
nameFn SanitizeFn
keyFn SanitizeFn
valueFn SanitizeFn
}
func (s sanitizer) Name(n string) string {
return s.nameFn(n)
}
func (s sanitizer) Key(k string) string {
return s.keyFn(k)
}
func (s sanitizer) Value(v string) string {
return s.valueFn(v)
}
func (c *ValidCharacters) sanitizeFn(repChar rune) SanitizeFn {
return func(value string) string {
var buf *bytes.Buffer
for idx, ch := range value {
// first check if the provided character is valid
validCurr := false
for i := 0; !validCurr && i < len(c.Ranges); i++ {
if ch >= c.Ranges[i][0] && ch <= c.Ranges[i][1] {
validCurr = true
break
}
}
for i := 0; !validCurr && i < len(c.Characters); i++ {
if c.Characters[i] == ch {
validCurr = true
break
}
}
// if it's valid, we can optimise allocations by avoiding copying
if validCurr {
if buf == nil {
continue // haven't deviated from string, still no need to init buffer
}
buf.WriteRune(ch) // we've deviated from string, write to buffer
continue
}
// ie the character is invalid, and the buffer has not been initialised
// so we initialise buffer and backfill
if buf == nil {
buf = bytes.NewBuffer(make([]byte, 0, len(value)))
if idx > 0 {
buf.WriteString(value[:idx])
}
}
// write the replacement character
buf.WriteRune(repChar)
}
// return input un-touched if the buffer has been not initialised
if buf == nil {
return value
}
// otherwise, return the newly constructed buffer
return buf.String()
}
}