blob: 645f89e99110791b5be957e6e342ad47d72a7c1d [file] [log] [blame]
Don Newton379ae252019-04-01 12:17:06 -04001// Copyright (C) MongoDB, Inc. 2017-present.
2//
3// Licensed under the Apache License, Version 2.0 (the "License"); you may
4// not use this file except in compliance with the License. You may obtain
5// a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
6
7package bsoncodec
8
9import (
10 "encoding/json"
11 "errors"
12 "fmt"
13 "math"
14 "net/url"
15 "reflect"
16 "strconv"
17 "time"
18
19 "github.com/mongodb/mongo-go-driver/bson/bsonrw"
20 "github.com/mongodb/mongo-go-driver/bson/bsontype"
21 "github.com/mongodb/mongo-go-driver/bson/primitive"
22 "github.com/mongodb/mongo-go-driver/x/bsonx/bsoncore"
23)
24
25var defaultValueDecoders DefaultValueDecoders
26
27// DefaultValueDecoders is a namespace type for the default ValueDecoders used
28// when creating a registry.
29type DefaultValueDecoders struct{}
30
31// RegisterDefaultDecoders will register the decoder methods attached to DefaultValueDecoders with
32// the provided RegistryBuilder.
33//
34// There is no support for decoding map[string]interface{} becuase there is no decoder for
35// interface{}, so users must either register this decoder themselves or use the
36// EmptyInterfaceDecoder avaialble in the bson package.
37func (dvd DefaultValueDecoders) RegisterDefaultDecoders(rb *RegistryBuilder) {
38 if rb == nil {
39 panic(errors.New("argument to RegisterDefaultDecoders must not be nil"))
40 }
41
42 rb.
43 RegisterDecoder(tBinary, ValueDecoderFunc(dvd.BinaryDecodeValue)).
44 RegisterDecoder(tUndefined, ValueDecoderFunc(dvd.UndefinedDecodeValue)).
45 RegisterDecoder(tDateTime, ValueDecoderFunc(dvd.DateTimeDecodeValue)).
46 RegisterDecoder(tNull, ValueDecoderFunc(dvd.NullDecodeValue)).
47 RegisterDecoder(tRegex, ValueDecoderFunc(dvd.RegexDecodeValue)).
48 RegisterDecoder(tDBPointer, ValueDecoderFunc(dvd.DBPointerDecodeValue)).
49 RegisterDecoder(tTimestamp, ValueDecoderFunc(dvd.TimestampDecodeValue)).
50 RegisterDecoder(tMinKey, ValueDecoderFunc(dvd.MinKeyDecodeValue)).
51 RegisterDecoder(tMaxKey, ValueDecoderFunc(dvd.MaxKeyDecodeValue)).
52 RegisterDecoder(tJavaScript, ValueDecoderFunc(dvd.JavaScriptDecodeValue)).
53 RegisterDecoder(tSymbol, ValueDecoderFunc(dvd.SymbolDecodeValue)).
54 RegisterDecoder(tByteSlice, ValueDecoderFunc(dvd.ByteSliceDecodeValue)).
55 RegisterDecoder(tTime, ValueDecoderFunc(dvd.TimeDecodeValue)).
56 RegisterDecoder(tEmpty, ValueDecoderFunc(dvd.EmptyInterfaceDecodeValue)).
57 RegisterDecoder(tOID, ValueDecoderFunc(dvd.ObjectIDDecodeValue)).
58 RegisterDecoder(tDecimal, ValueDecoderFunc(dvd.Decimal128DecodeValue)).
59 RegisterDecoder(tJSONNumber, ValueDecoderFunc(dvd.JSONNumberDecodeValue)).
60 RegisterDecoder(tURL, ValueDecoderFunc(dvd.URLDecodeValue)).
61 RegisterDecoder(tValueUnmarshaler, ValueDecoderFunc(dvd.ValueUnmarshalerDecodeValue)).
62 RegisterDecoder(tUnmarshaler, ValueDecoderFunc(dvd.UnmarshalerDecodeValue)).
63 RegisterDecoder(tCoreDocument, ValueDecoderFunc(dvd.CoreDocumentDecodeValue)).
64 RegisterDecoder(tCodeWithScope, ValueDecoderFunc(dvd.CodeWithScopeDecodeValue)).
65 RegisterDefaultDecoder(reflect.Bool, ValueDecoderFunc(dvd.BooleanDecodeValue)).
66 RegisterDefaultDecoder(reflect.Int, ValueDecoderFunc(dvd.IntDecodeValue)).
67 RegisterDefaultDecoder(reflect.Int8, ValueDecoderFunc(dvd.IntDecodeValue)).
68 RegisterDefaultDecoder(reflect.Int16, ValueDecoderFunc(dvd.IntDecodeValue)).
69 RegisterDefaultDecoder(reflect.Int32, ValueDecoderFunc(dvd.IntDecodeValue)).
70 RegisterDefaultDecoder(reflect.Int64, ValueDecoderFunc(dvd.IntDecodeValue)).
71 RegisterDefaultDecoder(reflect.Uint, ValueDecoderFunc(dvd.UintDecodeValue)).
72 RegisterDefaultDecoder(reflect.Uint8, ValueDecoderFunc(dvd.UintDecodeValue)).
73 RegisterDefaultDecoder(reflect.Uint16, ValueDecoderFunc(dvd.UintDecodeValue)).
74 RegisterDefaultDecoder(reflect.Uint32, ValueDecoderFunc(dvd.UintDecodeValue)).
75 RegisterDefaultDecoder(reflect.Uint64, ValueDecoderFunc(dvd.UintDecodeValue)).
76 RegisterDefaultDecoder(reflect.Float32, ValueDecoderFunc(dvd.FloatDecodeValue)).
77 RegisterDefaultDecoder(reflect.Float64, ValueDecoderFunc(dvd.FloatDecodeValue)).
78 RegisterDefaultDecoder(reflect.Array, ValueDecoderFunc(dvd.ArrayDecodeValue)).
79 RegisterDefaultDecoder(reflect.Map, ValueDecoderFunc(dvd.MapDecodeValue)).
80 RegisterDefaultDecoder(reflect.Slice, ValueDecoderFunc(dvd.SliceDecodeValue)).
81 RegisterDefaultDecoder(reflect.String, ValueDecoderFunc(dvd.StringDecodeValue)).
82 RegisterDefaultDecoder(reflect.Struct, &StructCodec{cache: make(map[reflect.Type]*structDescription), parser: DefaultStructTagParser}).
83 RegisterDefaultDecoder(reflect.Ptr, NewPointerCodec()).
84 RegisterTypeMapEntry(bsontype.Double, tFloat64).
85 RegisterTypeMapEntry(bsontype.String, tString).
86 RegisterTypeMapEntry(bsontype.Array, tA).
87 RegisterTypeMapEntry(bsontype.Binary, tBinary).
88 RegisterTypeMapEntry(bsontype.Undefined, tUndefined).
89 RegisterTypeMapEntry(bsontype.ObjectID, tOID).
90 RegisterTypeMapEntry(bsontype.Boolean, tBool).
91 RegisterTypeMapEntry(bsontype.DateTime, tDateTime).
92 RegisterTypeMapEntry(bsontype.Regex, tRegex).
93 RegisterTypeMapEntry(bsontype.DBPointer, tDBPointer).
94 RegisterTypeMapEntry(bsontype.JavaScript, tJavaScript).
95 RegisterTypeMapEntry(bsontype.Symbol, tSymbol).
96 RegisterTypeMapEntry(bsontype.CodeWithScope, tCodeWithScope).
97 RegisterTypeMapEntry(bsontype.Int32, tInt32).
98 RegisterTypeMapEntry(bsontype.Int64, tInt64).
99 RegisterTypeMapEntry(bsontype.Timestamp, tTimestamp).
100 RegisterTypeMapEntry(bsontype.Decimal128, tDecimal).
101 RegisterTypeMapEntry(bsontype.MinKey, tMinKey).
102 RegisterTypeMapEntry(bsontype.MaxKey, tMaxKey).
103 RegisterTypeMapEntry(bsontype.Type(0), tD)
104}
105
106// BooleanDecodeValue is the ValueDecoderFunc for bool types.
107func (dvd DefaultValueDecoders) BooleanDecodeValue(dctx DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error {
108 if vr.Type() != bsontype.Boolean {
109 return fmt.Errorf("cannot decode %v into a boolean", vr.Type())
110 }
111 if !val.IsValid() || !val.CanSet() || val.Kind() != reflect.Bool {
112 return ValueDecoderError{Name: "BooleanDecodeValue", Kinds: []reflect.Kind{reflect.Bool}, Received: val}
113 }
114
115 b, err := vr.ReadBoolean()
116 val.SetBool(b)
117 return err
118}
119
120// IntDecodeValue is the ValueDecoderFunc for bool types.
121func (dvd DefaultValueDecoders) IntDecodeValue(dc DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error {
122 var i64 int64
123 var err error
124 switch vr.Type() {
125 case bsontype.Int32:
126 i32, err := vr.ReadInt32()
127 if err != nil {
128 return err
129 }
130 i64 = int64(i32)
131 case bsontype.Int64:
132 i64, err = vr.ReadInt64()
133 if err != nil {
134 return err
135 }
136 case bsontype.Double:
137 f64, err := vr.ReadDouble()
138 if err != nil {
139 return err
140 }
141 if !dc.Truncate && math.Floor(f64) != f64 {
142 return errors.New("IntDecodeValue can only truncate float64 to an integer type when truncation is enabled")
143 }
144 if f64 > float64(math.MaxInt64) {
145 return fmt.Errorf("%g overflows int64", f64)
146 }
147 i64 = int64(f64)
148 default:
149 return fmt.Errorf("cannot decode %v into an integer type", vr.Type())
150 }
151
152 if !val.CanSet() {
153 return ValueDecoderError{
154 Name: "IntDecodeValue",
155 Kinds: []reflect.Kind{reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64, reflect.Int},
156 Received: val,
157 }
158 }
159
160 switch val.Kind() {
161 case reflect.Int8:
162 if i64 < math.MinInt8 || i64 > math.MaxInt8 {
163 return fmt.Errorf("%d overflows int8", i64)
164 }
165 case reflect.Int16:
166 if i64 < math.MinInt16 || i64 > math.MaxInt16 {
167 return fmt.Errorf("%d overflows int16", i64)
168 }
169 case reflect.Int32:
170 if i64 < math.MinInt32 || i64 > math.MaxInt32 {
171 return fmt.Errorf("%d overflows int32", i64)
172 }
173 case reflect.Int64:
174 case reflect.Int:
175 if int64(int(i64)) != i64 { // Can we fit this inside of an int
176 return fmt.Errorf("%d overflows int", i64)
177 }
178 default:
179 return ValueDecoderError{
180 Name: "IntDecodeValue",
181 Kinds: []reflect.Kind{reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64, reflect.Int},
182 Received: val,
183 }
184 }
185
186 val.SetInt(i64)
187 return nil
188}
189
190// UintDecodeValue is the ValueDecoderFunc for uint types.
191func (dvd DefaultValueDecoders) UintDecodeValue(dc DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error {
192 var i64 int64
193 var err error
194 switch vr.Type() {
195 case bsontype.Int32:
196 i32, err := vr.ReadInt32()
197 if err != nil {
198 return err
199 }
200 i64 = int64(i32)
201 case bsontype.Int64:
202 i64, err = vr.ReadInt64()
203 if err != nil {
204 return err
205 }
206 case bsontype.Double:
207 f64, err := vr.ReadDouble()
208 if err != nil {
209 return err
210 }
211 if !dc.Truncate && math.Floor(f64) != f64 {
212 return errors.New("UintDecodeValue can only truncate float64 to an integer type when truncation is enabled")
213 }
214 if f64 > float64(math.MaxInt64) {
215 return fmt.Errorf("%g overflows int64", f64)
216 }
217 i64 = int64(f64)
218 default:
219 return fmt.Errorf("cannot decode %v into an integer type", vr.Type())
220 }
221
222 if !val.CanSet() {
223 return ValueDecoderError{
224 Name: "UintDecodeValue",
225 Kinds: []reflect.Kind{reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uint},
226 Received: val,
227 }
228 }
229
230 switch val.Kind() {
231 case reflect.Uint8:
232 if i64 < 0 || i64 > math.MaxUint8 {
233 return fmt.Errorf("%d overflows uint8", i64)
234 }
235 case reflect.Uint16:
236 if i64 < 0 || i64 > math.MaxUint16 {
237 return fmt.Errorf("%d overflows uint16", i64)
238 }
239 case reflect.Uint32:
240 if i64 < 0 || i64 > math.MaxUint32 {
241 return fmt.Errorf("%d overflows uint32", i64)
242 }
243 case reflect.Uint64:
244 if i64 < 0 {
245 return fmt.Errorf("%d overflows uint64", i64)
246 }
247 case reflect.Uint:
248 if i64 < 0 || int64(uint(i64)) != i64 { // Can we fit this inside of an uint
249 return fmt.Errorf("%d overflows uint", i64)
250 }
251 default:
252 return ValueDecoderError{
253 Name: "UintDecodeValue",
254 Kinds: []reflect.Kind{reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uint},
255 Received: val,
256 }
257 }
258
259 val.SetUint(uint64(i64))
260 return nil
261}
262
263// FloatDecodeValue is the ValueDecoderFunc for float types.
264func (dvd DefaultValueDecoders) FloatDecodeValue(ec DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error {
265 var f float64
266 var err error
267 switch vr.Type() {
268 case bsontype.Int32:
269 i32, err := vr.ReadInt32()
270 if err != nil {
271 return err
272 }
273 f = float64(i32)
274 case bsontype.Int64:
275 i64, err := vr.ReadInt64()
276 if err != nil {
277 return err
278 }
279 f = float64(i64)
280 case bsontype.Double:
281 f, err = vr.ReadDouble()
282 if err != nil {
283 return err
284 }
285 default:
286 return fmt.Errorf("cannot decode %v into a float32 or float64 type", vr.Type())
287 }
288
289 if !val.CanSet() {
290 return ValueDecoderError{Name: "FloatDecodeValue", Kinds: []reflect.Kind{reflect.Float32, reflect.Float64}, Received: val}
291 }
292
293 switch val.Kind() {
294 case reflect.Float32:
295 if !ec.Truncate && float64(float32(f)) != f {
296 return errors.New("FloatDecodeValue can only convert float64 to float32 when truncation is allowed")
297 }
298 case reflect.Float64:
299 default:
300 return ValueDecoderError{Name: "FloatDecodeValue", Kinds: []reflect.Kind{reflect.Float32, reflect.Float64}, Received: val}
301 }
302
303 val.SetFloat(f)
304 return nil
305}
306
307// StringDecodeValue is the ValueDecoderFunc for string types.
308func (dvd DefaultValueDecoders) StringDecodeValue(dctx DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error {
309 var str string
310 var err error
311 switch vr.Type() {
312 // TODO(GODRIVER-577): Handle JavaScript and Symbol BSON types when allowed.
313 case bsontype.String:
314 str, err = vr.ReadString()
315 if err != nil {
316 return err
317 }
318 default:
319 return fmt.Errorf("cannot decode %v into a string type", vr.Type())
320 }
321 if !val.CanSet() || val.Kind() != reflect.String {
322 return ValueDecoderError{Name: "StringDecodeValue", Kinds: []reflect.Kind{reflect.String}, Received: val}
323 }
324
325 val.SetString(str)
326 return nil
327}
328
329// JavaScriptDecodeValue is the ValueDecoderFunc for the primitive.JavaScript type.
330func (DefaultValueDecoders) JavaScriptDecodeValue(dctx DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error {
331 if !val.CanSet() || val.Type() != tJavaScript {
332 return ValueDecoderError{Name: "BinaryDecodeValue", Types: []reflect.Type{tJavaScript}, Received: val}
333 }
334
335 if vr.Type() != bsontype.JavaScript {
336 return fmt.Errorf("cannot decode %v into a primitive.JavaScript", vr.Type())
337 }
338
339 js, err := vr.ReadJavascript()
340 if err != nil {
341 return err
342 }
343
344 val.SetString(js)
345 return nil
346}
347
348// SymbolDecodeValue is the ValueDecoderFunc for the primitive.Symbol type.
349func (DefaultValueDecoders) SymbolDecodeValue(dctx DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error {
350 if !val.CanSet() || val.Type() != tSymbol {
351 return ValueDecoderError{Name: "BinaryDecodeValue", Types: []reflect.Type{tSymbol}, Received: val}
352 }
353
354 if vr.Type() != bsontype.Symbol {
355 return fmt.Errorf("cannot decode %v into a primitive.Symbol", vr.Type())
356 }
357
358 symbol, err := vr.ReadSymbol()
359 if err != nil {
360 return err
361 }
362
363 val.SetString(symbol)
364 return nil
365}
366
367// BinaryDecodeValue is the ValueDecoderFunc for Binary.
368func (DefaultValueDecoders) BinaryDecodeValue(dc DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error {
369 if !val.CanSet() || val.Type() != tBinary {
370 return ValueDecoderError{Name: "BinaryDecodeValue", Types: []reflect.Type{tBinary}, Received: val}
371 }
372
373 if vr.Type() != bsontype.Binary {
374 return fmt.Errorf("cannot decode %v into a Binary", vr.Type())
375 }
376
377 data, subtype, err := vr.ReadBinary()
378 if err != nil {
379 return err
380 }
381
382 val.Set(reflect.ValueOf(primitive.Binary{Subtype: subtype, Data: data}))
383 return nil
384}
385
386// UndefinedDecodeValue is the ValueDecoderFunc for Undefined.
387func (DefaultValueDecoders) UndefinedDecodeValue(dc DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error {
388 if !val.CanSet() || val.Type() != tUndefined {
389 return ValueDecoderError{Name: "UndefinedDecodeValue", Types: []reflect.Type{tUndefined}, Received: val}
390 }
391
392 if vr.Type() != bsontype.Undefined {
393 return fmt.Errorf("cannot decode %v into an Undefined", vr.Type())
394 }
395
396 val.Set(reflect.ValueOf(primitive.Undefined{}))
397 return vr.ReadUndefined()
398}
399
400// ObjectIDDecodeValue is the ValueDecoderFunc for primitive.ObjectID.
401func (dvd DefaultValueDecoders) ObjectIDDecodeValue(dc DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error {
402 if !val.CanSet() || val.Type() != tOID {
403 return ValueDecoderError{Name: "ObjectIDDecodeValue", Types: []reflect.Type{tOID}, Received: val}
404 }
405
406 if vr.Type() != bsontype.ObjectID {
407 return fmt.Errorf("cannot decode %v into an ObjectID", vr.Type())
408 }
409 oid, err := vr.ReadObjectID()
410 val.Set(reflect.ValueOf(oid))
411 return err
412}
413
414// DateTimeDecodeValue is the ValueDecoderFunc for DateTime.
415func (DefaultValueDecoders) DateTimeDecodeValue(dc DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error {
416 if !val.CanSet() || val.Type() != tDateTime {
417 return ValueDecoderError{Name: "DateTimeDecodeValue", Types: []reflect.Type{tDateTime}, Received: val}
418 }
419
420 if vr.Type() != bsontype.DateTime {
421 return fmt.Errorf("cannot decode %v into a DateTime", vr.Type())
422 }
423
424 dt, err := vr.ReadDateTime()
425 if err != nil {
426 return err
427 }
428
429 val.Set(reflect.ValueOf(primitive.DateTime(dt)))
430 return nil
431}
432
433// NullDecodeValue is the ValueDecoderFunc for Null.
434func (DefaultValueDecoders) NullDecodeValue(dc DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error {
435 if !val.CanSet() || val.Type() != tNull {
436 return ValueDecoderError{Name: "NullDecodeValue", Types: []reflect.Type{tNull}, Received: val}
437 }
438
439 if vr.Type() != bsontype.Null {
440 return fmt.Errorf("cannot decode %v into a Null", vr.Type())
441 }
442
443 val.Set(reflect.ValueOf(primitive.Null{}))
444 return vr.ReadNull()
445}
446
447// RegexDecodeValue is the ValueDecoderFunc for Regex.
448func (DefaultValueDecoders) RegexDecodeValue(dc DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error {
449 if !val.CanSet() || val.Type() != tRegex {
450 return ValueDecoderError{Name: "RegexDecodeValue", Types: []reflect.Type{tRegex}, Received: val}
451 }
452
453 if vr.Type() != bsontype.Regex {
454 return fmt.Errorf("cannot decode %v into a Regex", vr.Type())
455 }
456
457 pattern, options, err := vr.ReadRegex()
458 if err != nil {
459 return err
460 }
461
462 val.Set(reflect.ValueOf(primitive.Regex{Pattern: pattern, Options: options}))
463 return nil
464}
465
466// DBPointerDecodeValue is the ValueDecoderFunc for DBPointer.
467func (DefaultValueDecoders) DBPointerDecodeValue(dc DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error {
468 if !val.CanSet() || val.Type() != tDBPointer {
469 return ValueDecoderError{Name: "DBPointerDecodeValue", Types: []reflect.Type{tDBPointer}, Received: val}
470 }
471
472 if vr.Type() != bsontype.DBPointer {
473 return fmt.Errorf("cannot decode %v into a DBPointer", vr.Type())
474 }
475
476 ns, pointer, err := vr.ReadDBPointer()
477 if err != nil {
478 return err
479 }
480
481 val.Set(reflect.ValueOf(primitive.DBPointer{DB: ns, Pointer: pointer}))
482 return nil
483}
484
485// TimestampDecodeValue is the ValueDecoderFunc for Timestamp.
486func (DefaultValueDecoders) TimestampDecodeValue(dc DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error {
487 if !val.CanSet() || val.Type() != tTimestamp {
488 return ValueDecoderError{Name: "TimestampDecodeValue", Types: []reflect.Type{tTimestamp}, Received: val}
489 }
490
491 if vr.Type() != bsontype.Timestamp {
492 return fmt.Errorf("cannot decode %v into a Timestamp", vr.Type())
493 }
494
495 t, incr, err := vr.ReadTimestamp()
496 if err != nil {
497 return err
498 }
499
500 val.Set(reflect.ValueOf(primitive.Timestamp{T: t, I: incr}))
501 return nil
502}
503
504// MinKeyDecodeValue is the ValueDecoderFunc for MinKey.
505func (DefaultValueDecoders) MinKeyDecodeValue(dc DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error {
506 if !val.CanSet() || val.Type() != tMinKey {
507 return ValueDecoderError{Name: "MinKeyDecodeValue", Types: []reflect.Type{tMinKey}, Received: val}
508 }
509
510 if vr.Type() != bsontype.MinKey {
511 return fmt.Errorf("cannot decode %v into a MinKey", vr.Type())
512 }
513
514 val.Set(reflect.ValueOf(primitive.MinKey{}))
515 return vr.ReadMinKey()
516}
517
518// MaxKeyDecodeValue is the ValueDecoderFunc for MaxKey.
519func (DefaultValueDecoders) MaxKeyDecodeValue(dc DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error {
520 if !val.CanSet() || val.Type() != tMaxKey {
521 return ValueDecoderError{Name: "MaxKeyDecodeValue", Types: []reflect.Type{tMaxKey}, Received: val}
522 }
523
524 if vr.Type() != bsontype.MaxKey {
525 return fmt.Errorf("cannot decode %v into a MaxKey", vr.Type())
526 }
527
528 val.Set(reflect.ValueOf(primitive.MaxKey{}))
529 return vr.ReadMaxKey()
530}
531
532// Decimal128DecodeValue is the ValueDecoderFunc for primitive.Decimal128.
533func (dvd DefaultValueDecoders) Decimal128DecodeValue(dctx DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error {
534 if vr.Type() != bsontype.Decimal128 {
535 return fmt.Errorf("cannot decode %v into a primitive.Decimal128", vr.Type())
536 }
537
538 if !val.CanSet() || val.Type() != tDecimal {
539 return ValueDecoderError{Name: "Decimal128DecodeValue", Types: []reflect.Type{tDecimal}, Received: val}
540 }
541 d128, err := vr.ReadDecimal128()
542 val.Set(reflect.ValueOf(d128))
543 return err
544}
545
546// JSONNumberDecodeValue is the ValueDecoderFunc for json.Number.
547func (dvd DefaultValueDecoders) JSONNumberDecodeValue(dc DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error {
548 if !val.CanSet() || val.Type() != tJSONNumber {
549 return ValueDecoderError{Name: "JSONNumberDecodeValue", Types: []reflect.Type{tJSONNumber}, Received: val}
550 }
551
552 switch vr.Type() {
553 case bsontype.Double:
554 f64, err := vr.ReadDouble()
555 if err != nil {
556 return err
557 }
558 val.Set(reflect.ValueOf(json.Number(strconv.FormatFloat(f64, 'g', -1, 64))))
559 case bsontype.Int32:
560 i32, err := vr.ReadInt32()
561 if err != nil {
562 return err
563 }
564 val.Set(reflect.ValueOf(json.Number(strconv.FormatInt(int64(i32), 10))))
565 case bsontype.Int64:
566 i64, err := vr.ReadInt64()
567 if err != nil {
568 return err
569 }
570 val.Set(reflect.ValueOf(json.Number(strconv.FormatInt(i64, 10))))
571 default:
572 return fmt.Errorf("cannot decode %v into a json.Number", vr.Type())
573 }
574
575 return nil
576}
577
578// URLDecodeValue is the ValueDecoderFunc for url.URL.
579func (dvd DefaultValueDecoders) URLDecodeValue(dc DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error {
580 if vr.Type() != bsontype.String {
581 return fmt.Errorf("cannot decode %v into a *url.URL", vr.Type())
582 }
583
584 str, err := vr.ReadString()
585 if err != nil {
586 return err
587 }
588
589 u, err := url.Parse(str)
590 if err != nil {
591 return err
592 }
593
594 if !val.CanSet() || val.Type() != tURL {
595 return ValueDecoderError{Name: "URLDecodeValue", Types: []reflect.Type{tURL}, Received: val}
596 }
597
598 val.Set(reflect.ValueOf(u).Elem())
599 return nil
600}
601
602// TimeDecodeValue is the ValueDecoderFunc for time.Time.
603func (dvd DefaultValueDecoders) TimeDecodeValue(dc DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error {
604 if vr.Type() != bsontype.DateTime {
605 return fmt.Errorf("cannot decode %v into a time.Time", vr.Type())
606 }
607
608 dt, err := vr.ReadDateTime()
609 if err != nil {
610 return err
611 }
612
613 if !val.CanSet() || val.Type() != tTime {
614 return ValueDecoderError{Name: "TimeDecodeValue", Types: []reflect.Type{tTime}, Received: val}
615 }
616
617 val.Set(reflect.ValueOf(time.Unix(dt/1000, dt%1000*1000000)))
618 return nil
619}
620
621// ByteSliceDecodeValue is the ValueDecoderFunc for []byte.
622func (dvd DefaultValueDecoders) ByteSliceDecodeValue(dc DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error {
623 if vr.Type() != bsontype.Binary && vr.Type() != bsontype.Null {
624 return fmt.Errorf("cannot decode %v into a []byte", vr.Type())
625 }
626
627 if !val.CanSet() || val.Type() != tByteSlice {
628 return ValueDecoderError{Name: "ByteSliceDecodeValue", Types: []reflect.Type{tByteSlice}, Received: val}
629 }
630
631 if vr.Type() == bsontype.Null {
632 val.Set(reflect.Zero(val.Type()))
633 return vr.ReadNull()
634 }
635
636 data, subtype, err := vr.ReadBinary()
637 if err != nil {
638 return err
639 }
640 if subtype != 0x00 {
641 return fmt.Errorf("ByteSliceDecodeValue can only be used to decode subtype 0x00 for %s, got %v", bsontype.Binary, subtype)
642 }
643
644 val.Set(reflect.ValueOf(data))
645 return nil
646}
647
648// MapDecodeValue is the ValueDecoderFunc for map[string]* types.
649func (dvd DefaultValueDecoders) MapDecodeValue(dc DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error {
650 if !val.CanSet() || val.Kind() != reflect.Map || val.Type().Key().Kind() != reflect.String {
651 return ValueDecoderError{Name: "MapDecodeValue", Kinds: []reflect.Kind{reflect.Map}, Received: val}
652 }
653
654 switch vr.Type() {
655 case bsontype.Type(0), bsontype.EmbeddedDocument:
656 case bsontype.Null:
657 val.Set(reflect.Zero(val.Type()))
658 return vr.ReadNull()
659 default:
660 return fmt.Errorf("cannot decode %v into a %s", vr.Type(), val.Type())
661 }
662
663 dr, err := vr.ReadDocument()
664 if err != nil {
665 return err
666 }
667
668 if val.IsNil() {
669 val.Set(reflect.MakeMap(val.Type()))
670 }
671
672 eType := val.Type().Elem()
673 decoder, err := dc.LookupDecoder(eType)
674 if err != nil {
675 return err
676 }
677
678 if eType == tEmpty {
679 dc.Ancestor = val.Type()
680 }
681
682 keyType := val.Type().Key()
683 for {
684 key, vr, err := dr.ReadElement()
685 if err == bsonrw.ErrEOD {
686 break
687 }
688 if err != nil {
689 return err
690 }
691
692 elem := reflect.New(eType).Elem()
693
694 err = decoder.DecodeValue(dc, vr, elem)
695 if err != nil {
696 return err
697 }
698
699 val.SetMapIndex(reflect.ValueOf(key).Convert(keyType), elem)
700 }
701 return nil
702}
703
704// ArrayDecodeValue is the ValueDecoderFunc for array types.
705func (dvd DefaultValueDecoders) ArrayDecodeValue(dc DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error {
706 if !val.IsValid() || val.Kind() != reflect.Array {
707 return ValueDecoderError{Name: "ArrayDecodeValue", Kinds: []reflect.Kind{reflect.Array}, Received: val}
708 }
709
710 switch vr.Type() {
711 case bsontype.Array:
712 case bsontype.Type(0), bsontype.EmbeddedDocument:
713 if val.Type().Elem() != tE {
714 return fmt.Errorf("cannot decode document into %s", val.Type())
715 }
716 default:
717 return fmt.Errorf("cannot decode %v into an array", vr.Type())
718 }
719
720 var elemsFunc func(DecodeContext, bsonrw.ValueReader, reflect.Value) ([]reflect.Value, error)
721 switch val.Type().Elem() {
722 case tE:
723 elemsFunc = dvd.decodeD
724 default:
725 elemsFunc = dvd.decodeDefault
726 }
727
728 elems, err := elemsFunc(dc, vr, val)
729 if err != nil {
730 return err
731 }
732
733 if len(elems) > val.Len() {
734 return fmt.Errorf("more elements returned in array than can fit inside %s", val.Type())
735 }
736
737 for idx, elem := range elems {
738 val.Index(idx).Set(elem)
739 }
740
741 return nil
742}
743
744// SliceDecodeValue is the ValueDecoderFunc for slice types.
745func (dvd DefaultValueDecoders) SliceDecodeValue(dc DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error {
746 if !val.CanSet() || val.Kind() != reflect.Slice {
747 return ValueDecoderError{Name: "SliceDecodeValue", Kinds: []reflect.Kind{reflect.Slice}, Received: val}
748 }
749
750 switch vr.Type() {
751 case bsontype.Array:
752 case bsontype.Null:
753 val.Set(reflect.Zero(val.Type()))
754 return vr.ReadNull()
755 case bsontype.Type(0), bsontype.EmbeddedDocument:
756 if val.Type().Elem() != tE {
757 return fmt.Errorf("cannot decode document into %s", val.Type())
758 }
759 default:
760 return fmt.Errorf("cannot decode %v into a slice", vr.Type())
761 }
762
763 var elemsFunc func(DecodeContext, bsonrw.ValueReader, reflect.Value) ([]reflect.Value, error)
764 switch val.Type().Elem() {
765 case tE:
766 dc.Ancestor = val.Type()
767 elemsFunc = dvd.decodeD
768 default:
769 elemsFunc = dvd.decodeDefault
770 }
771
772 elems, err := elemsFunc(dc, vr, val)
773 if err != nil {
774 return err
775 }
776
777 if val.IsNil() {
778 val.Set(reflect.MakeSlice(val.Type(), 0, len(elems)))
779 }
780
781 val.SetLen(0)
782 val.Set(reflect.Append(val, elems...))
783
784 return nil
785}
786
787// ValueUnmarshalerDecodeValue is the ValueDecoderFunc for ValueUnmarshaler implementations.
788func (dvd DefaultValueDecoders) ValueUnmarshalerDecodeValue(dc DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error {
789 if !val.IsValid() || (!val.Type().Implements(tValueUnmarshaler) && !reflect.PtrTo(val.Type()).Implements(tValueUnmarshaler)) {
790 return ValueDecoderError{Name: "ValueUnmarshalerDecodeValue", Types: []reflect.Type{tValueUnmarshaler}, Received: val}
791 }
792
793 if val.Kind() == reflect.Ptr && val.IsNil() {
794 if !val.CanSet() {
795 return ValueDecoderError{Name: "ValueUnmarshalerDecodeValue", Types: []reflect.Type{tValueUnmarshaler}, Received: val}
796 }
797 val.Set(reflect.New(val.Type().Elem()))
798 }
799
800 if !val.Type().Implements(tValueUnmarshaler) {
801 if !val.CanAddr() {
802 return ValueDecoderError{Name: "ValueUnmarshalerDecodeValue", Types: []reflect.Type{tValueUnmarshaler}, Received: val}
803 }
804 val = val.Addr() // If they type doesn't implement the interface, a pointer to it must.
805 }
806
807 t, src, err := bsonrw.Copier{}.CopyValueToBytes(vr)
808 if err != nil {
809 return err
810 }
811
812 fn := val.Convert(tValueUnmarshaler).MethodByName("UnmarshalBSONValue")
813 errVal := fn.Call([]reflect.Value{reflect.ValueOf(t), reflect.ValueOf(src)})[0]
814 if !errVal.IsNil() {
815 return errVal.Interface().(error)
816 }
817 return nil
818}
819
820// UnmarshalerDecodeValue is the ValueDecoderFunc for Unmarshaler implementations.
821func (dvd DefaultValueDecoders) UnmarshalerDecodeValue(dc DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error {
822 if !val.IsValid() || (!val.Type().Implements(tUnmarshaler) && !reflect.PtrTo(val.Type()).Implements(tUnmarshaler)) {
823 return ValueDecoderError{Name: "UnmarshalerDecodeValue", Types: []reflect.Type{tUnmarshaler}, Received: val}
824 }
825
826 if val.Kind() == reflect.Ptr && val.IsNil() {
827 if !val.CanSet() {
828 return ValueDecoderError{Name: "UnmarshalerDecodeValue", Types: []reflect.Type{tUnmarshaler}, Received: val}
829 }
830 val.Set(reflect.New(val.Type().Elem()))
831 }
832
833 if !val.Type().Implements(tUnmarshaler) {
834 if !val.CanAddr() {
835 return ValueDecoderError{Name: "UnmarshalerDecodeValue", Types: []reflect.Type{tUnmarshaler}, Received: val}
836 }
837 val = val.Addr() // If they type doesn't implement the interface, a pointer to it must.
838 }
839
840 _, src, err := bsonrw.Copier{}.CopyValueToBytes(vr)
841 if err != nil {
842 return err
843 }
844
845 fn := val.Convert(tUnmarshaler).MethodByName("UnmarshalBSON")
846 errVal := fn.Call([]reflect.Value{reflect.ValueOf(src)})[0]
847 if !errVal.IsNil() {
848 return errVal.Interface().(error)
849 }
850 return nil
851}
852
853// EmptyInterfaceDecodeValue is the ValueDecoderFunc for interface{}.
854func (dvd DefaultValueDecoders) EmptyInterfaceDecodeValue(dc DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error {
855 if !val.CanSet() || val.Type() != tEmpty {
856 return ValueDecoderError{Name: "EmptyInterfaceDecodeValue", Types: []reflect.Type{tEmpty}, Received: val}
857 }
858
859 rtype, err := dc.LookupTypeMapEntry(vr.Type())
860 if err != nil {
861 switch vr.Type() {
862 case bsontype.EmbeddedDocument:
863 if dc.Ancestor != nil {
864 rtype = dc.Ancestor
865 break
866 }
867 rtype = tD
868 case bsontype.Null:
869 val.Set(reflect.Zero(val.Type()))
870 return vr.ReadNull()
871 default:
872 return err
873 }
874 }
875
876 decoder, err := dc.LookupDecoder(rtype)
877 if err != nil {
878 return err
879 }
880
881 elem := reflect.New(rtype).Elem()
882 err = decoder.DecodeValue(dc, vr, elem)
883 if err != nil {
884 return err
885 }
886
887 val.Set(elem)
888 return nil
889}
890
891// CoreDocumentDecodeValue is the ValueDecoderFunc for bsoncore.Document.
892func (DefaultValueDecoders) CoreDocumentDecodeValue(dc DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error {
893 if !val.CanSet() || val.Type() != tCoreDocument {
894 return ValueDecoderError{Name: "CoreDocumentDecodeValue", Types: []reflect.Type{tCoreDocument}, Received: val}
895 }
896
897 if val.IsNil() {
898 val.Set(reflect.MakeSlice(val.Type(), 0, 0))
899 }
900
901 val.SetLen(0)
902
903 cdoc, err := bsonrw.Copier{}.AppendDocumentBytes(val.Interface().(bsoncore.Document), vr)
904 val.Set(reflect.ValueOf(cdoc))
905 return err
906}
907
908func (dvd DefaultValueDecoders) decodeDefault(dc DecodeContext, vr bsonrw.ValueReader, val reflect.Value) ([]reflect.Value, error) {
909 elems := make([]reflect.Value, 0)
910
911 ar, err := vr.ReadArray()
912 if err != nil {
913 return nil, err
914 }
915
916 eType := val.Type().Elem()
917
918 decoder, err := dc.LookupDecoder(eType)
919 if err != nil {
920 return nil, err
921 }
922
923 for {
924 vr, err := ar.ReadValue()
925 if err == bsonrw.ErrEOA {
926 break
927 }
928 if err != nil {
929 return nil, err
930 }
931
932 elem := reflect.New(eType).Elem()
933
934 err = decoder.DecodeValue(dc, vr, elem)
935 if err != nil {
936 return nil, err
937 }
938 elems = append(elems, elem)
939 }
940
941 return elems, nil
942}
943
944// CodeWithScopeDecodeValue is the ValueDecoderFunc for CodeWithScope.
945func (dvd DefaultValueDecoders) CodeWithScopeDecodeValue(dc DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error {
946 if !val.CanSet() || val.Type() != tCodeWithScope {
947 return ValueDecoderError{Name: "CodeWithScopeDecodeValue", Types: []reflect.Type{tCodeWithScope}, Received: val}
948 }
949
950 if vr.Type() != bsontype.CodeWithScope {
951 return fmt.Errorf("cannot decode %v into a primitive.CodeWithScope", vr.Type())
952 }
953
954 code, dr, err := vr.ReadCodeWithScope()
955 if err != nil {
956 return err
957 }
958
959 scope := reflect.New(tD).Elem()
960
961 elems, err := dvd.decodeElemsFromDocumentReader(dc, dr)
962 if err != nil {
963 return err
964 }
965
966 scope.Set(reflect.MakeSlice(tD, 0, len(elems)))
967 scope.Set(reflect.Append(scope, elems...))
968
969 val.Set(reflect.ValueOf(primitive.CodeWithScope{Code: primitive.JavaScript(code), Scope: scope.Interface().(primitive.D)}))
970 return nil
971}
972
973func (dvd DefaultValueDecoders) decodeD(dc DecodeContext, vr bsonrw.ValueReader, _ reflect.Value) ([]reflect.Value, error) {
974 switch vr.Type() {
975 case bsontype.Type(0), bsontype.EmbeddedDocument:
976 default:
977 return nil, fmt.Errorf("cannot decode %v into a D", vr.Type())
978 }
979
980 dr, err := vr.ReadDocument()
981 if err != nil {
982 return nil, err
983 }
984
985 return dvd.decodeElemsFromDocumentReader(dc, dr)
986}
987
988func (DefaultValueDecoders) decodeElemsFromDocumentReader(dc DecodeContext, dr bsonrw.DocumentReader) ([]reflect.Value, error) {
989 decoder, err := dc.LookupDecoder(tEmpty)
990 if err != nil {
991 return nil, err
992 }
993
994 elems := make([]reflect.Value, 0)
995 for {
996 key, vr, err := dr.ReadElement()
997 if err == bsonrw.ErrEOD {
998 break
999 }
1000 if err != nil {
1001 return nil, err
1002 }
1003
1004 val := reflect.New(tEmpty).Elem()
1005 err = decoder.DecodeValue(dc, vr, val)
1006 if err != nil {
1007 return nil, err
1008 }
1009
1010 elems = append(elems, reflect.ValueOf(primitive.E{Key: key, Value: val.Interface()}))
1011 }
1012
1013 return elems, nil
1014}