/
encoding.go
259 lines (211 loc) · 6.57 KB
/
encoding.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
// Copyright 2019 Aporeto 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 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 elemental
import (
"bytes"
"fmt"
"mime"
"net/http"
"reflect"
"strings"
"sync"
"github.com/ugorji/go/codec"
)
var (
externalSupportedContentType = map[string]struct{}{}
externalSupportedAcceptType = map[string]struct{}{}
)
// RegisterSupportedContentType registers a new media type
// that elemental should support for Content-Type.
// Note that this needs external intervention to handle encoding.
func RegisterSupportedContentType(mimetype string) {
externalSupportedContentType[mimetype] = struct{}{}
}
// RegisterSupportedAcceptType registers a new media type
// that elemental should support for Accept.
// Note that this needs external intervention to handle decoding.
func RegisterSupportedAcceptType(mimetype string) {
externalSupportedAcceptType[mimetype] = struct{}{}
}
// An Encodable is the interface of objects
// that can hold encoding information.
type Encodable interface {
GetEncoding() EncodingType
}
// A Encoder is an Encodable that can be encoded.
type Encoder interface {
Encode(obj interface{}) (err error)
Encodable
}
// A Decoder is an Encodable that can be decoded.
type Decoder interface {
Decode(dst interface{}) error
Encodable
}
// An EncodingType represents one type of data encoding
type EncodingType string
// Various values for EncodingType.
const (
EncodingTypeJSON EncodingType = "application/json"
EncodingTypeMSGPACK EncodingType = "application/msgpack"
)
var (
jsonHandle = &codec.JsonHandle{}
jsonEncodersPool = sync.Pool{
New: func() interface{} {
return codec.NewEncoder(nil, jsonHandle)
},
}
jsonDecodersPool = sync.Pool{
New: func() interface{} {
return codec.NewDecoder(nil, jsonHandle)
},
}
msgpackHandle = &codec.MsgpackHandle{}
msgpackEncodersPool = sync.Pool{
New: func() interface{} {
return codec.NewEncoder(nil, msgpackHandle)
},
}
msgpackDecodersPool = sync.Pool{
New: func() interface{} {
return codec.NewDecoder(nil, msgpackHandle)
},
}
)
func init() {
// If you need to understand all of this, go there http://ugorji.net/blog/go-codec-primer
// But you should not need to touch that.
jsonHandle.Canonical = true
jsonHandle.MapType = reflect.ValueOf(map[string]interface{}{}).Type()
jsonHandle.MapValueReset = true
msgpackHandle.WriteExt = true
msgpackHandle.Canonical = true
msgpackHandle.TypeInfos = codec.NewTypeInfos([]string{"msgpack"})
msgpackHandle.MapType = reflect.ValueOf(map[string]interface{}{}).Type()
msgpackHandle.MapValueReset = true
}
// Decode decodes the given data using an appropriate decoder chosen
// from the given contentType.
func Decode(encoding EncodingType, data []byte, dest interface{}) error {
var dec *codec.Decoder
switch encoding {
case EncodingTypeMSGPACK:
dec = msgpackDecodersPool.Get().(*codec.Decoder)
defer msgpackDecodersPool.Put(dec)
default:
dec = jsonDecodersPool.Get().(*codec.Decoder)
defer jsonDecodersPool.Put(dec)
encoding = EncodingTypeJSON
}
dec.Reset(bytes.NewBuffer(data))
if err := dec.Decode(dest); err != nil {
return fmt.Errorf("unable to decode %s: %s", encoding, err.Error())
}
return nil
}
// Encode encodes the given object using an appropriate encoder chosen
// from the given acceptType.
func Encode(encoding EncodingType, obj interface{}) ([]byte, error) {
if obj == nil {
return nil, fmt.Errorf("encode received a nil object")
}
var enc *codec.Encoder
switch encoding {
case EncodingTypeMSGPACK:
enc = msgpackEncodersPool.Get().(*codec.Encoder)
defer msgpackEncodersPool.Put(enc)
default:
enc = jsonEncodersPool.Get().(*codec.Encoder)
defer jsonEncodersPool.Put(enc)
encoding = EncodingTypeJSON
}
buf := bytes.NewBuffer(nil)
enc.Reset(buf)
if err := enc.Encode(obj); err != nil {
return nil, fmt.Errorf("unable to encode %s: %s", encoding, err.Error())
}
return buf.Bytes(), nil
}
// Convert converts from one EncodingType to another
func Convert(from EncodingType, to EncodingType, data []byte) ([]byte, error) {
if from == to {
return data, nil
}
m := map[string]interface{}{}
if err := Decode(from, data, &m); err != nil {
return nil, err
}
return Encode(to, m)
}
// EncodingFromHeaders returns the read (Content-Type) and write (Accept) encoding
// from the given http.Header.
func EncodingFromHeaders(header http.Header) (read EncodingType, write EncodingType, err error) {
read = EncodingTypeJSON
write = EncodingTypeJSON
if header == nil {
return read, write, nil
}
if v := header.Get("Content-Type"); v != "" {
ct, _, err := mime.ParseMediaType(v)
if err != nil {
return "", "", NewError("Bad Request", fmt.Sprintf("Invalid Content-Type header: %s", err), "elemental", http.StatusBadRequest)
}
switch ct {
case "application/msgpack":
read = EncodingTypeMSGPACK
case "application/*", "*/*", "application/json":
read = EncodingTypeJSON
default:
var supported bool
for t := range externalSupportedContentType {
if ct == t {
supported = true
break
}
}
if !supported {
return "", "", NewError("Unsupported Media Type", fmt.Sprintf("Cannot find any acceptable Content-Type media type in provided header: %s", v), "elemental", http.StatusUnsupportedMediaType)
}
}
}
if v := header.Get("Accept"); v != "" {
var agreed bool
L:
for _, item := range strings.Split(v, ",") {
at, _, err := mime.ParseMediaType(item)
if err != nil {
return "", "", NewError("Bad Request", fmt.Sprintf("Invalid Accept header: %s", err), "elemental", http.StatusBadRequest)
}
switch at {
case "application/msgpack":
write = EncodingTypeMSGPACK
agreed = true
break L
case "application/*", "*/*", "application/json":
write = EncodingTypeJSON
agreed = true
break L
default:
for t := range externalSupportedAcceptType {
if at == t {
agreed = true
break L
}
}
}
}
if !agreed {
return "", "", NewError("Unsupported Media Type", fmt.Sprintf("Cannot find any acceptable Accept media type in provided header: %s", v), "elemental", http.StatusUnsupportedMediaType)
}
}
return read, write, nil
}