default_value_decoders.go 31 KB

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