bencode/decode.go

   1 package bencode
   2
   3 import (
   4         "bytes"
   5         "errors"
   6         "fmt"
   7         "io"
   8         "math/big"
   9         "reflect"
  10         "runtime"
  11         "strconv"
  12         "sync"
  13 )
  14
  15 type Decoder struct {
  16         r interface {
  17                 io.ByteScanner
  18                 io.Reader
  19         }
  20         // Sum of bytes used to Decode values.
  21         Offset int64
  22         buf    bytes.Buffer
  23 }
  24
  25 func (d *Decoder) Decode(v interface{}) (err error) {
  26         defer func() {
  27                 if err != nil {
  28                         return
  29                 }
  30                 r := recover()
  31                 _, ok := r.(runtime.Error)
  32                 if ok {
  33                         panic(r)
  34                 }
  35                 err, ok = r.(error)
  36                 if !ok && r != nil {
  37                         panic(r)
  38                 }
  39         }()
  40
  41         pv := reflect.ValueOf(v)
  42         if pv.Kind() != reflect.Ptr || pv.IsNil() {
  43                 return &UnmarshalInvalidArgError{reflect.TypeOf(v)}
  44         }
  45
  46         ok, err := d.parseValue(pv.Elem())
  47         if err != nil {
  48                 return
  49         }
  50         if !ok {
  51                 d.throwSyntaxError(d.Offset-1, errors.New("unexpected 'e'"))
  52         }
  53         return
  54 }
  55
  56 func checkForUnexpectedEOF(err error, offset int64) {
  57         if err == io.EOF {
  58                 panic(&SyntaxError{
  59                         Offset: offset,
  60                         What:   io.ErrUnexpectedEOF,
  61                 })
  62         }
  63 }
  64
  65 func (d *Decoder) readByte() byte {
  66         b, err := d.r.ReadByte()
  67         if err != nil {
  68                 checkForUnexpectedEOF(err, d.Offset)
  69                 panic(err)
  70         }
  71
  72         d.Offset++
  73         return b
  74 }
  75
  76 // reads data writing it to 'd.buf' until 'sep' byte is encountered, 'sep' byte
  77 // is consumed, but not included into the 'd.buf'
  78 func (d *Decoder) readUntil(sep byte) {
  79         for {
  80                 b := d.readByte()
  81                 if b == sep {
  82                         return
  83                 }
  84                 d.buf.WriteByte(b)
  85         }
  86 }
  87
  88 func checkForIntParseError(err error, offset int64) {
  89         if err != nil {
  90                 panic(&SyntaxError{
  91                         Offset: offset,
  92                         What:   err,
  93                 })
  94         }
  95 }
  96
  97 func (d *Decoder) throwSyntaxError(offset int64, err error) {
  98         panic(&SyntaxError{
  99                 Offset: offset,
 100                 What:   err,
 101         })
 102 }
 103
 104 // called when 'i' was consumed
 105 func (d *Decoder) parseInt(v reflect.Value) {
 106         start := d.Offset - 1
 107         d.readUntil('e')
 108         if d.buf.Len() == 0 {
 109                 panic(&SyntaxError{
 110                         Offset: start,
 111                         What:   errors.New("empty integer value"),
 112                 })
 113         }
 114
 115         s := bytesAsString(d.buf.Bytes())
 116
 117         switch v.Kind() {
 118         case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
 119                 n, err := strconv.ParseInt(s, 10, 64)
 120                 checkForIntParseError(err, start)
 121
 122                 if v.OverflowInt(n) {
 123                         panic(&UnmarshalTypeError{
 124                                 Value: "integer " + s,
 125                                 Type:  v.Type(),
 126                         })
 127                 }
 128                 v.SetInt(n)
 129         case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
 130                 n, err := strconv.ParseUint(s, 10, 64)
 131                 checkForIntParseError(err, start)
 132
 133                 if v.OverflowUint(n) {
 134                         panic(&UnmarshalTypeError{
 135                                 Value: "integer " + s,
 136                                 Type:  v.Type(),
 137                         })
 138                 }
 139                 v.SetUint(n)
 140         case reflect.Bool:
 141                 v.SetBool(s != "0")
 142         default:
 143                 panic(&UnmarshalTypeError{
 144                         Value: "integer " + s,
 145                         Type:  v.Type(),
 146                 })
 147         }
 148         d.buf.Reset()
 149 }
 150
 151 func (d *Decoder) parseString(v reflect.Value) error {
 152         start := d.Offset - 1
 153
 154         // read the string length first
 155         d.readUntil(':')
 156         length, err := strconv.ParseInt(bytesAsString(d.buf.Bytes()), 10, 0)
 157         checkForIntParseError(err, start)
 158
 159         defer d.buf.Reset()
 160
 161         read := func(b []byte) {
 162                 n, err := io.ReadFull(d.r, b)
 163                 d.Offset += int64(n)
 164                 if err != nil {
 165                         checkForUnexpectedEOF(err, d.Offset)
 166                         panic(&SyntaxError{
 167                                 Offset: d.Offset,
 168                                 What:   errors.New("unexpected I/O error: " + err.Error()),
 169                         })
 170                 }
 171         }
 172
 173         switch v.Kind() {
 174         case reflect.String:
 175                 b := make([]byte, length)
 176                 read(b)
 177                 v.SetString(bytesAsString(b))
 178                 return nil
 179         case reflect.Slice:
 180                 if v.Type().Elem().Kind() != reflect.Uint8 {
 181                         break
 182                 }
 183                 b := make([]byte, length)
 184                 read(b)
 185                 v.SetBytes(b)
 186                 return nil
 187         case reflect.Array:
 188                 if v.Type().Elem().Kind() != reflect.Uint8 {
 189                         break
 190                 }
 191                 d.buf.Grow(int(length))
 192                 b := d.buf.Bytes()[:length]
 193                 read(b)
 194                 reflect.Copy(v, reflect.ValueOf(b))
 195                 return nil
 196         }
 197         d.buf.Grow(int(length))
 198         read(d.buf.Bytes()[:length])
 199         // I believe we return here to support "ignore_unmarshal_type_error".
 200         return &UnmarshalTypeError{
 201                 Value: "string",
 202                 Type:  v.Type(),
 203         }
 204 }
 205
 206 // Info for parsing a dict value.
 207 type dictField struct {
 208         Value reflect.Value // Storage for the parsed value.
 209         // True if field value should be parsed into Value. If false, the value
 210         // should be parsed and discarded.
 211         Ok                       bool
 212         Set                      func() // Call this after parsing into Value.
 213         IgnoreUnmarshalTypeError bool
 214 }
 215
 216 // Returns specifics for parsing a dict field value.
 217 func getDictField(dict reflect.Value, key string) dictField {
 218         // get valuev as a map value or as a struct field
 219         switch dict.Kind() {
 220         case reflect.Map:
 221                 value := reflect.New(dict.Type().Elem()).Elem()
 222                 return dictField{
 223                         Value: value,
 224                         Ok:    true,
 225                         Set: func() {
 226                                 if dict.IsNil() {
 227                                         dict.Set(reflect.MakeMap(dict.Type()))
 228                                 }
 229                                 // Assigns the value into the map.
 230                                 dict.SetMapIndex(reflect.ValueOf(key).Convert(dict.Type().Key()), value)
 231                         },
 232                 }
 233         case reflect.Struct:
 234                 sf, ok := getStructFieldForKey(dict.Type(), key)
 235                 if !ok {
 236                         return dictField{}
 237                 }
 238                 if sf.r.PkgPath != "" {
 239                         panic(&UnmarshalFieldError{
 240                                 Key:   key,
 241                                 Type:  dict.Type(),
 242                                 Field: sf.r,
 243                         })
 244                 }
 245                 return dictField{
 246                         Value: dict.FieldByIndex(sf.r.Index),
 247                         Ok:    true,
 248                         Set:   func() {},
 249                         IgnoreUnmarshalTypeError: sf.tag.IgnoreUnmarshalTypeError(),
 250                 }
 251         default:
 252                 return dictField{}
 253         }
 254 }
 255
 256 type structField struct {
 257         r   reflect.StructField
 258         tag tag
 259 }
 260
 261 var (
 262         structFieldsMu sync.Mutex
 263         structFields   = map[reflect.Type]map[string]structField{}
 264 )
 265
 266 func parseStructFields(struct_ reflect.Type, each func(string, structField)) {
 267         for i, n := 0, struct_.NumField(); i < n; i++ {
 268                 f := struct_.Field(i)
 269                 if f.Anonymous {
 270                         continue
 271                 }
 272                 tagStr := f.Tag.Get("bencode")
 273                 if tagStr == "-" {
 274                         continue
 275                 }
 276                 tag := parseTag(tagStr)
 277                 key := tag.Key()
 278                 if key == "" {
 279                         key = f.Name
 280                 }
 281                 each(key, structField{f, tag})
 282         }
 283 }
 284
 285 func saveStructFields(struct_ reflect.Type) {
 286         m := make(map[string]structField)
 287         parseStructFields(struct_, func(key string, sf structField) {
 288                 m[key] = sf
 289         })
 290         structFields[struct_] = m
 291 }
 292
 293 func getStructFieldForKey(struct_ reflect.Type, key string) (f structField, ok bool) {
 294         structFieldsMu.Lock()
 295         if _, ok := structFields[struct_]; !ok {
 296                 saveStructFields(struct_)
 297         }
 298         f, ok = structFields[struct_][key]
 299         structFieldsMu.Unlock()
 300         return
 301 }
 302
 303 func (d *Decoder) parseDict(v reflect.Value) error {
 304         // so, at this point 'd' byte was consumed, let's just read key/value
 305         // pairs one by one
 306         for {
 307                 var keyStr string
 308                 keyValue := reflect.ValueOf(&keyStr).Elem()
 309                 ok, err := d.parseValue(keyValue)
 310                 if err != nil {
 311                         return fmt.Errorf("error parsing dict key: %s", err)
 312                 }
 313                 if !ok {
 314                         return nil
 315                 }
 316
 317                 df := getDictField(v, keyStr)
 318
 319                 // now we need to actually parse it
 320                 if df.Ok {
 321                         // log.Printf("parsing ok struct field for key %q", keyStr)
 322                         ok, err = d.parseValue(df.Value)
 323                 } else {
 324                         // Discard the value, there's nowhere to put it.
 325                         var if_ interface{}
 326                         if_, ok = d.parseValueInterface()
 327                         if if_ == nil {
 328                                 err = fmt.Errorf("error parsing value for key %q", keyStr)
 329                         }
 330                 }
 331                 if err != nil {
 332                         if _, ok := err.(*UnmarshalTypeError); !ok || !df.IgnoreUnmarshalTypeError {
 333                                 return fmt.Errorf("parsing value for key %q: %s", keyStr, err)
 334                         }
 335                 }
 336                 if !ok {
 337                         return fmt.Errorf("missing value for key %q", keyStr)
 338                 }
 339                 if df.Ok {
 340                         df.Set()
 341                 }
 342         }
 343 }
 344
 345 func (d *Decoder) parseList(v reflect.Value) error {
 346         switch v.Kind() {
 347         case reflect.Array, reflect.Slice:
 348         default:
 349                 panic(&UnmarshalTypeError{
 350                         Value: "array",
 351                         Type:  v.Type(),
 352                 })
 353         }
 354
 355         i := 0
 356         for ; ; i++ {
 357                 if v.Kind() == reflect.Slice && i >= v.Len() {
 358                         v.Set(reflect.Append(v, reflect.Zero(v.Type().Elem())))
 359                 }
 360
 361                 if i < v.Len() {
 362                         ok, err := d.parseValue(v.Index(i))
 363                         if err != nil {
 364                                 return err
 365                         }
 366                         if !ok {
 367                                 break
 368                         }
 369                 } else {
 370                         _, ok := d.parseValueInterface()
 371                         if !ok {
 372                                 break
 373                         }
 374                 }
 375         }
 376
 377         if i < v.Len() {
 378                 if v.Kind() == reflect.Array {
 379                         z := reflect.Zero(v.Type().Elem())
 380                         for n := v.Len(); i < n; i++ {
 381                                 v.Index(i).Set(z)
 382                         }
 383                 } else {
 384                         v.SetLen(i)
 385                 }
 386         }
 387
 388         if i == 0 && v.Kind() == reflect.Slice {
 389                 v.Set(reflect.MakeSlice(v.Type(), 0, 0))
 390         }
 391         return nil
 392 }
 393
 394 func (d *Decoder) readOneValue() bool {
 395         b, err := d.r.ReadByte()
 396         if err != nil {
 397                 panic(err)
 398         }
 399         if b == 'e' {
 400                 d.r.UnreadByte()
 401                 return false
 402         } else {
 403                 d.Offset++
 404                 d.buf.WriteByte(b)
 405         }
 406
 407         switch b {
 408         case 'd', 'l':
 409                 // read until there is nothing to read
 410                 for d.readOneValue() {
 411                 }
 412                 // consume 'e' as well
 413                 b = d.readByte()
 414                 d.buf.WriteByte(b)
 415         case 'i':
 416                 d.readUntil('e')
 417                 d.buf.WriteString("e")
 418         default:
 419                 if b >= '0' && b <= '9' {
 420                         start := d.buf.Len() - 1
 421                         d.readUntil(':')
 422                         length, err := strconv.ParseInt(bytesAsString(d.buf.Bytes()[start:]), 10, 64)
 423                         checkForIntParseError(err, d.Offset-1)
 424
 425                         d.buf.WriteString(":")
 426                         n, err := io.CopyN(&d.buf, d.r, length)
 427                         d.Offset += n
 428                         if err != nil {
 429                                 checkForUnexpectedEOF(err, d.Offset)
 430                                 panic(&SyntaxError{
 431                                         Offset: d.Offset,
 432                                         What:   errors.New("unexpected I/O error: " + err.Error()),
 433                                 })
 434                         }
 435                         break
 436                 }
 437
 438                 d.raiseUnknownValueType(b, d.Offset-1)
 439         }
 440
 441         return true
 442
 443 }
 444
 445 func (d *Decoder) parseUnmarshaler(v reflect.Value) bool {
 446         if !v.Type().Implements(unmarshalerType) {
 447                 if v.Addr().Type().Implements(unmarshalerType) {
 448                         v = v.Addr()
 449                 } else {
 450                         return false
 451                 }
 452         }
 453         d.buf.Reset()
 454         if !d.readOneValue() {
 455                 return false
 456         }
 457         m := v.Interface().(Unmarshaler)
 458         err := m.UnmarshalBencode(d.buf.Bytes())
 459         if err != nil {
 460                 panic(&UnmarshalerError{v.Type(), err})
 461         }
 462         return true
 463 }
 464
 465 // Returns true if there was a value and it's now stored in 'v', otherwise
 466 // there was an end symbol ("e") and no value was stored.
 467 func (d *Decoder) parseValue(v reflect.Value) (bool, error) {
 468         // we support one level of indirection at the moment
 469         if v.Kind() == reflect.Ptr {
 470                 // if the pointer is nil, allocate a new element of the type it
 471                 // points to
 472                 if v.IsNil() {
 473                         v.Set(reflect.New(v.Type().Elem()))
 474                 }
 475                 v = v.Elem()
 476         }
 477
 478         if d.parseUnmarshaler(v) {
 479                 return true, nil
 480         }
 481
 482         // common case: interface{}
 483         if v.Kind() == reflect.Interface && v.NumMethod() == 0 {
 484                 iface, _ := d.parseValueInterface()
 485                 v.Set(reflect.ValueOf(iface))
 486                 return true, nil
 487         }
 488
 489         b, err := d.r.ReadByte()
 490         if err != nil {
 491                 panic(err)
 492         }
 493         d.Offset++
 494
 495         switch b {
 496         case 'e':
 497                 return false, nil
 498         case 'd':
 499                 return true, d.parseDict(v)
 500         case 'l':
 501                 return true, d.parseList(v)
 502         case 'i':
 503                 d.parseInt(v)
 504                 return true, nil
 505         default:
 506                 if b >= '0' && b <= '9' {
 507                         // It's a string.
 508                         d.buf.Reset()
 509                         // Write the first digit of the length to the buffer.
 510                         d.buf.WriteByte(b)
 511                         return true, d.parseString(v)
 512                 }
 513
 514                 d.raiseUnknownValueType(b, d.Offset-1)
 515         }
 516         panic("unreachable")
 517 }
 518
 519 // An unknown bencode type character was encountered.
 520 func (d *Decoder) raiseUnknownValueType(b byte, offset int64) {
 521         panic(&SyntaxError{
 522                 Offset: offset,
 523                 What:   fmt.Errorf("unknown value type %+q", b),
 524         })
 525 }
 526
 527 func (d *Decoder) parseValueInterface() (interface{}, bool) {
 528         b, err := d.r.ReadByte()
 529         if err != nil {
 530                 panic(err)
 531         }
 532         d.Offset++
 533
 534         switch b {
 535         case 'e':
 536                 return nil, false
 537         case 'd':
 538                 return d.parseDictInterface(), true
 539         case 'l':
 540                 return d.parseListInterface(), true
 541         case 'i':
 542                 return d.parseIntInterface(), true
 543         default:
 544                 if b >= '0' && b <= '9' {
 545                         // string
 546                         // append first digit of the length to the buffer
 547                         d.buf.WriteByte(b)
 548                         return d.parseStringInterface(), true
 549                 }
 550
 551                 d.raiseUnknownValueType(b, d.Offset-1)
 552                 panic("unreachable")
 553         }
 554 }
 555
 556 func (d *Decoder) parseIntInterface() (ret interface{}) {
 557         start := d.Offset - 1
 558         d.readUntil('e')
 559         if d.buf.Len() == 0 {
 560                 panic(&SyntaxError{
 561                         Offset: start,
 562                         What:   errors.New("empty integer value"),
 563                 })
 564         }
 565
 566         n, err := strconv.ParseInt(d.buf.String(), 10, 64)
 567         if ne, ok := err.(*strconv.NumError); ok && ne.Err == strconv.ErrRange {
 568                 i := new(big.Int)
 569                 _, ok := i.SetString(d.buf.String(), 10)
 570                 if !ok {
 571                         panic(&SyntaxError{
 572                                 Offset: start,
 573                                 What:   errors.New("failed to parse integer"),
 574                         })
 575                 }
 576                 ret = i
 577         } else {
 578                 checkForIntParseError(err, start)
 579                 ret = n
 580         }
 581
 582         d.buf.Reset()
 583         return
 584 }
 585
 586 func (d *Decoder) parseStringInterface() interface{} {
 587         start := d.Offset - 1
 588
 589         // read the string length first
 590         d.readUntil(':')
 591         length, err := strconv.ParseInt(d.buf.String(), 10, 64)
 592         checkForIntParseError(err, start)
 593
 594         d.buf.Reset()
 595         n, err := io.CopyN(&d.buf, d.r, length)
 596         d.Offset += n
 597         if err != nil {
 598                 checkForUnexpectedEOF(err, d.Offset)
 599                 panic(&SyntaxError{
 600                         Offset: d.Offset,
 601                         What:   errors.New("unexpected I/O error: " + err.Error()),
 602                 })
 603         }
 604
 605         s := d.buf.String()
 606         d.buf.Reset()
 607         return s
 608 }
 609
 610 func (d *Decoder) parseDictInterface() interface{} {
 611         dict := make(map[string]interface{})
 612         for {
 613                 keyi, ok := d.parseValueInterface()
 614                 if !ok {
 615                         break
 616                 }
 617
 618                 key, ok := keyi.(string)
 619                 if !ok {
 620                         panic(&SyntaxError{
 621                                 Offset: d.Offset,
 622                                 What:   errors.New("non-string key in a dict"),
 623                         })
 624                 }
 625
 626                 valuei, ok := d.parseValueInterface()
 627                 if !ok {
 628                         break
 629                 }
 630
 631                 dict[key] = valuei
 632         }
 633         return dict
 634 }
 635
 636 func (d *Decoder) parseListInterface() interface{} {
 637         var list []interface{}
 638         for {
 639                 valuei, ok := d.parseValueInterface()
 640                 if !ok {
 641                         break
 642                 }
 643
 644                 list = append(list, valuei)
 645         }
 646         if list == nil {
 647                 list = make([]interface{}, 0, 0)
 648         }
 649         return list
 650 }