forked from vitessio/vitess
-
Notifications
You must be signed in to change notification settings - Fork 1
/
unicodeloosemd5.go
155 lines (130 loc) · 4.55 KB
/
unicodeloosemd5.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
/*
Copyright 2017 Google Inc.
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 agreedto 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.
*/
package vindexes
import (
"bytes"
"fmt"
"sync"
"unicode/utf8"
"vitess.io/vitess/go/sqltypes"
"vitess.io/vitess/go/vt/key"
"golang.org/x/text/collate"
"golang.org/x/text/language"
)
var (
_ Vindex = (*UnicodeLooseMD5)(nil)
)
// UnicodeLooseMD5 is a vindex that normalizes and hashes unicode strings
// to a keyspace id. It conservatively converts the string to its base
// characters before hashing. This is also known as UCA level 1.
// Ref: http://www.unicode.org/reports/tr10/#Multi_Level_Comparison.
// This is compatible with MySQL's utf8_unicode_ci collation.
type UnicodeLooseMD5 struct {
name string
}
// NewUnicodeLooseMD5 creates a new UnicodeLooseMD5.
func NewUnicodeLooseMD5(name string, _ map[string]string) (Vindex, error) {
return &UnicodeLooseMD5{name: name}, nil
}
// String returns the name of the vindex.
func (vind *UnicodeLooseMD5) String() string {
return vind.name
}
// Cost returns the cost as 1.
func (vind *UnicodeLooseMD5) Cost() int {
return 1
}
// IsUnique returns true since the Vindex is unique.
func (vind *UnicodeLooseMD5) IsUnique() bool {
return true
}
// IsFunctional returns true since the Vindex is functional.
func (vind *UnicodeLooseMD5) IsFunctional() bool {
return true
}
// Verify returns true if ids maps to ksids.
func (vind *UnicodeLooseMD5) Verify(_ VCursor, ids []sqltypes.Value, ksids [][]byte) ([]bool, error) {
out := make([]bool, len(ids))
for i := range ids {
data, err := unicodeHash(ids[i])
if err != nil {
return nil, fmt.Errorf("UnicodeLooseMD5.Verify: %v", err)
}
out[i] = (bytes.Compare(data, ksids[i]) == 0)
}
return out, nil
}
// Map can map ids to key.Destination objects.
func (vind *UnicodeLooseMD5) Map(cursor VCursor, ids []sqltypes.Value) ([]key.Destination, error) {
out := make([]key.Destination, 0, len(ids))
for _, id := range ids {
data, err := unicodeHash(id)
if err != nil {
return nil, fmt.Errorf("UnicodeLooseMD5.Map: %v", err)
}
out = append(out, key.DestinationKeyspaceID(data))
}
return out, nil
}
func unicodeHash(key sqltypes.Value) ([]byte, error) {
collator := collatorPool.Get().(pooledCollator)
defer collatorPool.Put(collator)
norm, err := normalize(collator.col, collator.buf, key.ToBytes())
if err != nil {
return nil, err
}
return binHash(norm), nil
}
func normalize(col *collate.Collator, buf *collate.Buffer, in []byte) ([]byte, error) {
// We cannot pass invalid UTF-8 to the collator.
if !utf8.Valid(in) {
return nil, fmt.Errorf("cannot normalize string containing invalid UTF-8: %q", string(in))
}
// Ref: http://dev.mysql.com/doc/refman/5.6/en/char.html.
// Trailing spaces are ignored by MySQL.
in = bytes.TrimRight(in, " ")
// We use the collation key which can be used to
// perform lexical comparisons.
return col.Key(buf, in), nil
}
// pooledCollator pairs a Collator and a Buffer.
// These pairs are pooled to avoid reallocating for every request,
// which would otherwise be required because they can't be used concurrently.
//
// Note that you must ensure no active references into the buffer remain
// before you return this pair back to the pool.
// That is, either do your processing on the result first, or make a copy.
type pooledCollator struct {
col *collate.Collator
buf *collate.Buffer
}
var collatorPool = sync.Pool{New: newPooledCollator}
func newPooledCollator() interface{} {
// Ref: http://www.unicode.org/reports/tr10/#Introduction.
// Unicode seems to define a universal (or default) order.
// But various locales have conflicting order,
// which they have the right to override.
// Unfortunately, the Go library requires you to specify a locale.
// So, I chose English assuming that it won't override
// the Unicode universal order. But I couldn't find an easy
// way to verify this.
// Also, the locale differences are not an issue for level 1,
// because the conservative comparison makes them all equal.
return pooledCollator{
col: collate.New(language.English, collate.Loose),
buf: new(collate.Buffer),
}
}
func init() {
Register("unicode_loose_md5", NewUnicodeLooseMD5)
}