-
Notifications
You must be signed in to change notification settings - Fork 46
/
encoder.go
230 lines (196 loc) · 4.79 KB
/
encoder.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
//
// Copyright 2019 Insolar Technologies GmbH
//
// 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.
//
package reference
import (
"bytes"
"strings"
"sync"
"github.com/pkg/errors"
)
type IdentityEncoder func(ref *Global) (domain, object string)
type EncoderOptions uint8
const (
Parity EncoderOptions = 1 << iota
EncodingSchema
FormatSchema
NilRef = "<nil>" // non-parsable
SchemaV1 = "insolarv1"
)
type Encoder interface {
Encode(ref *Global) (string, error)
EncodeToBuilder(ref *Global, b *strings.Builder) error
EncodeRecord(rec *Local) (string, error)
}
var defaultEncoderOnce sync.Once
var defaultEncoder Encoder
func DefaultEncoder() Encoder {
defaultEncoderOnce.Do(func() {
defaultEncoder = NewBase58Encoder(0)
})
return defaultEncoder
}
type encoder struct {
nameEncoder IdentityEncoder
byteEncoder ByteEncodeFunc
byteEncoderName string
authorityName string
options EncoderOptions
}
func NewBase58Encoder(opts EncoderOptions) Encoder {
return &encoder{
nameEncoder: nil,
byteEncoder: byteEncodeBase58,
byteEncoderName: "base58",
authorityName: "",
options: opts,
}
}
func NewBase64Encoder(opts EncoderOptions) Encoder {
return &encoder{
nameEncoder: nil,
byteEncoder: byteEncodeBase64,
byteEncoderName: "base64",
authorityName: "",
options: opts & FormatSchema,
}
}
func (v encoder) Encode(ref *Global) (string, error) {
b := strings.Builder{}
err := v.EncodeToBuilder(ref, &b)
return b.String(), err
}
func (v encoder) EncodeToBuilder(ref *Global, b *strings.Builder) error {
if ref == nil {
b.WriteString(NilRef)
return nil
}
v.appendPrefix(b)
if ref.IsEmpty() {
b.WriteString("0")
}
if ref.IsRecordScope() {
return v.encodeRecord(&ref.addressLocal, b)
}
var domainName, objectName string
if v.nameEncoder != nil {
domainName, objectName = v.nameEncoder(ref)
}
if objectName != "" {
if IsReservedName(objectName) || !IsValidObjectName(objectName) {
return errors.Errorf("illegal object name from IdentityEncoder: ref=%v, domain='%s', object='%s'", ref, domainName, objectName)
}
b.WriteString(objectName)
} else {
err := v.encodeBinary(&ref.addressLocal, b)
if err != nil {
return err
}
}
switch {
case domainName != "":
if IsReservedName(domainName) || !IsValidDomainName(domainName) {
return errors.Errorf("illegal domain name from IdentityEncoder: ref=%v, domain='%s', object='%s'", ref, domainName, objectName)
}
b.WriteByte('.')
b.WriteString(domainName)
case ref.IsSelfScope():
// nothing
default:
b.WriteByte('.')
err := v.encodeBinary(&ref.addressBase, b)
if err != nil {
return err
}
}
if v.options&Parity != 0 {
parity := ref.GetParity()
if len(parity) > 0 {
b.WriteByte('/')
err := v.byteEncoder(bytes.NewReader(parity), b)
if err != nil {
return err
}
}
}
return nil
}
func (v encoder) appendPrefix(b *strings.Builder) {
if v.options&(EncodingSchema|FormatSchema) != 0 {
b.WriteString(v.byteEncoderName)
if v.options&FormatSchema != 0 {
b.WriteString("+" + SchemaV1)
}
b.WriteByte(':')
}
if len(v.authorityName) > 0 {
b.WriteString("//")
b.WriteString(v.authorityName)
b.WriteByte('/')
}
}
func (v encoder) encodeBinary(rec *Local, b *strings.Builder) error {
if rec.IsEmpty() {
b.WriteByte('0')
return nil
}
pn := rec.GetPulseNumber()
switch {
case pn.IsTimePulse():
b.WriteByte('1')
// full encode
err := v.byteEncoder(rec.AsReader(), b)
if err != nil {
return err
}
case pn.IsSpecial():
b.WriteString("0")
limit := len(rec.hash) - 1
for ; limit >= 0 && rec.hash[limit] == 0; limit-- {
}
limit += 1 + LocalBinaryPulseAndScopeSize
err := v.byteEncoder(rec.asReader(uint8(limit)), b)
if err != nil {
return err
}
default:
panic("unexpected")
}
return nil
}
func (v encoder) encodeRecord(rec *Local, b *strings.Builder) error {
if rec.IsEmpty() {
b.WriteString("0." + RecordDomainName)
return nil
}
if rec.getScope() != 0 {
panic("illegal value")
}
err := v.encodeBinary(rec, b)
if err != nil {
return err
}
b.WriteString("." + RecordDomainName)
return nil
}
func (v encoder) EncodeRecord(rec *Local) (string, error) {
if rec == nil {
return NilRef, nil
}
b := strings.Builder{}
v.appendPrefix(&b)
err := v.encodeRecord(rec, &b)
return b.String(), err
}