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         Type reflect.Type
 209         Get  func(value reflect.Value) func(reflect.Value)
 210         Tags tag
 211 }
 212
 213 // Returns specifics for parsing a dict field value.
 214 func getDictField(dict reflect.Type, key string) dictField {
 215         // get valuev as a map value or as a struct field
 216         switch dict.Kind() {
 217         case reflect.Map:
 218                 return dictField{
 219                         Type: dict.Elem(),
 220                         Get: func(mapValue reflect.Value) func(reflect.Value) {
 221                                 return func(value reflect.Value) {
 222                                         if mapValue.IsNil() {
 223                                                 mapValue.Set(reflect.MakeMap(dict))
 224                                         }
 225                                         // Assigns the value into the map.
 226                                         //log.Printf("map type: %v", mapValue.Type())
 227                                         mapValue.SetMapIndex(reflect.ValueOf(key).Convert(dict.Key()), value)
 228                                 }
 229                         },
 230                 }
 231         case reflect.Struct:
 232                 return getStructFieldForKey(dict, key)
 233                 //if sf.r.PkgPath != "" {
 234                 //      panic(&UnmarshalFieldError{
 235                 //              Key:   key,
 236                 //              Type:  dict.Type(),
 237                 //              Field: sf.r,
 238                 //      })
 239                 //}
 240         default:
 241                 panic("unimplemented")
 242                 return dictField{}
 243         }
 244 }
 245
 246 var (
 247         structFieldsMu sync.Mutex
 248         structFields   = map[reflect.Type]map[string]dictField{}
 249 )
 250
 251 func parseStructFields(struct_ reflect.Type, each func(key string, df dictField)) {
 252         for _i, n := 0, struct_.NumField(); _i < n; _i++ {
 253                 i := _i
 254                 f := struct_.Field(i)
 255                 if f.Anonymous {
 256                         parseStructFields(f.Type.Elem(), func(key string, df dictField) {
 257                                 innerGet := df.Get
 258                                 df.Get = func(value reflect.Value) func(reflect.Value) {
 259                                         anonPtr := value.Field(i)
 260                                         if anonPtr.IsNil() {
 261                                                 anonPtr.Set(reflect.New(f.Type.Elem()))
 262                                         }
 263                                         return innerGet(anonPtr.Elem())
 264                                 }
 265                                 each(key, df)
 266                         })
 267                         continue
 268                 }
 269                 tagStr := f.Tag.Get("bencode")
 270                 if tagStr == "-" {
 271                         continue
 272                 }
 273                 tag := parseTag(tagStr)
 274                 key := tag.Key()
 275                 if key == "" {
 276                         key = f.Name
 277                 }
 278                 each(key, dictField{f.Type, func(value reflect.Value) func(reflect.Value) {
 279                         return value.Field(i).Set
 280                 }, tag})
 281         }
 282 }
 283
 284 func saveStructFields(struct_ reflect.Type) {
 285         m := make(map[string]dictField)
 286         parseStructFields(struct_, func(key string, sf dictField) {
 287                 m[key] = sf
 288         })
 289         structFields[struct_] = m
 290 }
 291
 292 func getStructFieldForKey(struct_ reflect.Type, key string) (f dictField) {
 293         structFieldsMu.Lock()
 294         if _, ok := structFields[struct_]; !ok {
 295                 saveStructFields(struct_)
 296         }
 297         f, ok := structFields[struct_][key]
 298         structFieldsMu.Unlock()
 299         if !ok {
 300                 var discard interface{}
 301                 return dictField{
 302                         Type: reflect.TypeOf(discard),
 303                         Get:  func(reflect.Value) func(reflect.Value) { return func(reflect.Value) {} },
 304                         Tags: nil,
 305                 }
 306         }
 307         return
 308 }
 309
 310 func (d *Decoder) parseDict(v reflect.Value) error {
 311         // so, at this point 'd' byte was consumed, let's just read key/value
 312         // pairs one by one
 313         for {
 314                 var keyStr string
 315                 keyValue := reflect.ValueOf(&keyStr).Elem()
 316                 ok, err := d.parseValue(keyValue)
 317                 if err != nil {
 318                         return fmt.Errorf("error parsing dict key: %s", err)
 319                 }
 320                 if !ok {
 321                         return nil
 322                 }
 323
 324                 df := getDictField(v.Type(), keyStr)
 325
 326                 // now we need to actually parse it
 327                 if df.Type == nil {
 328                         // Discard the value, there's nowhere to put it.
 329                         var if_ interface{}
 330                         if_, ok = d.parseValueInterface()
 331                         if if_ == nil {
 332                                 return fmt.Errorf("error parsing value for key %q", keyStr)
 333                         }
 334                         if !ok {
 335                                 return fmt.Errorf("missing value for key %q", keyStr)
 336                         }
 337                         continue
 338                 }
 339                 setValue := reflect.New(df.Type).Elem()
 340                 //log.Printf("parsing into %v", setValue.Type())
 341                 ok, err = d.parseValue(setValue)
 342                 if err != nil {
 343                         if _, ok := err.(*UnmarshalTypeError); !ok || !df.Tags.IgnoreUnmarshalTypeError() {
 344                                 return fmt.Errorf("parsing value for key %q: %s", keyStr, err)
 345                         }
 346                 }
 347                 if !ok {
 348                         return fmt.Errorf("missing value for key %q", keyStr)
 349                 }
 350                 df.Get(v)(setValue)
 351         }
 352 }
 353
 354 func (d *Decoder) parseList(v reflect.Value) error {
 355         switch v.Kind() {
 356         default:
 357                 // If the list is a singleton of the expected type, use that value. See
 358                 // https://github.com/anacrolix/torrent/issues/297.
 359                 l := reflect.New(reflect.SliceOf(v.Type()))
 360                 if err := d.parseList(l.Elem()); err != nil {
 361                         return err
 362                 }
 363                 if l.Elem().Len() != 1 {
 364                         return &UnmarshalTypeError{
 365                                 Value: "list",
 366                                 Type:  v.Type(),
 367                         }
 368                 }
 369                 v.Set(l.Elem().Index(0))
 370                 return nil
 371         case reflect.Array, reflect.Slice:
 372                 // We can work with this. Normal case, fallthrough.
 373         }
 374
 375         i := 0
 376         for ; ; i++ {
 377                 if v.Kind() == reflect.Slice && i >= v.Len() {
 378                         v.Set(reflect.Append(v, reflect.Zero(v.Type().Elem())))
 379                 }
 380
 381                 if i < v.Len() {
 382                         ok, err := d.parseValue(v.Index(i))
 383                         if err != nil {
 384                                 return err
 385                         }
 386                         if !ok {
 387                                 break
 388                         }
 389                 } else {
 390                         _, ok := d.parseValueInterface()
 391                         if !ok {
 392                                 break
 393                         }
 394                 }
 395         }
 396
 397         if i < v.Len() {
 398                 if v.Kind() == reflect.Array {
 399                         z := reflect.Zero(v.Type().Elem())
 400                         for n := v.Len(); i < n; i++ {
 401                                 v.Index(i).Set(z)
 402                         }
 403                 } else {
 404                         v.SetLen(i)
 405                 }
 406         }
 407
 408         if i == 0 && v.Kind() == reflect.Slice {
 409                 v.Set(reflect.MakeSlice(v.Type(), 0, 0))
 410         }
 411         return nil
 412 }
 413
 414 func (d *Decoder) readOneValue() bool {
 415         b, err := d.r.ReadByte()
 416         if err != nil {
 417                 panic(err)
 418         }
 419         if b == 'e' {
 420                 d.r.UnreadByte()
 421                 return false
 422         } else {
 423                 d.Offset++
 424                 d.buf.WriteByte(b)
 425         }
 426
 427         switch b {
 428         case 'd', 'l':
 429                 // read until there is nothing to read
 430                 for d.readOneValue() {
 431                 }
 432                 // consume 'e' as well
 433                 b = d.readByte()
 434                 d.buf.WriteByte(b)
 435         case 'i':
 436                 d.readUntil('e')
 437                 d.buf.WriteString("e")
 438         default:
 439                 if b >= '0' && b <= '9' {
 440                         start := d.buf.Len() - 1
 441                         d.readUntil(':')
 442                         length, err := strconv.ParseInt(bytesAsString(d.buf.Bytes()[start:]), 10, 64)
 443                         checkForIntParseError(err, d.Offset-1)
 444
 445                         d.buf.WriteString(":")
 446                         n, err := io.CopyN(&d.buf, d.r, length)
 447                         d.Offset += n
 448                         if err != nil {
 449                                 checkForUnexpectedEOF(err, d.Offset)
 450                                 panic(&SyntaxError{
 451                                         Offset: d.Offset,
 452                                         What:   errors.New("unexpected I/O error: " + err.Error()),
 453                                 })
 454                         }
 455                         break
 456                 }
 457
 458                 d.raiseUnknownValueType(b, d.Offset-1)
 459         }
 460
 461         return true
 462
 463 }
 464
 465 func (d *Decoder) parseUnmarshaler(v reflect.Value) bool {
 466         if !v.Type().Implements(unmarshalerType) {
 467                 if v.Addr().Type().Implements(unmarshalerType) {
 468                         v = v.Addr()
 469                 } else {
 470                         return false
 471                 }
 472         }
 473         d.buf.Reset()
 474         if !d.readOneValue() {
 475                 return false
 476         }
 477         m := v.Interface().(Unmarshaler)
 478         err := m.UnmarshalBencode(d.buf.Bytes())
 479         if err != nil {
 480                 panic(&UnmarshalerError{v.Type(), err})
 481         }
 482         return true
 483 }
 484
 485 // Returns true if there was a value and it's now stored in 'v', otherwise
 486 // there was an end symbol ("e") and no value was stored.
 487 func (d *Decoder) parseValue(v reflect.Value) (bool, error) {
 488         // we support one level of indirection at the moment
 489         if v.Kind() == reflect.Ptr {
 490                 // if the pointer is nil, allocate a new element of the type it
 491                 // points to
 492                 if v.IsNil() {
 493                         v.Set(reflect.New(v.Type().Elem()))
 494                 }
 495                 v = v.Elem()
 496         }
 497
 498         if d.parseUnmarshaler(v) {
 499                 return true, nil
 500         }
 501
 502         // common case: interface{}
 503         if v.Kind() == reflect.Interface && v.NumMethod() == 0 {
 504                 iface, _ := d.parseValueInterface()
 505                 v.Set(reflect.ValueOf(iface))
 506                 return true, nil
 507         }
 508
 509         b, err := d.r.ReadByte()
 510         if err != nil {
 511                 panic(err)
 512         }
 513         d.Offset++
 514
 515         switch b {
 516         case 'e':
 517                 return false, nil
 518         case 'd':
 519                 return true, d.parseDict(v)
 520         case 'l':
 521                 return true, d.parseList(v)
 522         case 'i':
 523                 d.parseInt(v)
 524                 return true, nil
 525         default:
 526                 if b >= '0' && b <= '9' {
 527                         // It's a string.
 528                         d.buf.Reset()
 529                         // Write the first digit of the length to the buffer.
 530                         d.buf.WriteByte(b)
 531                         return true, d.parseString(v)
 532                 }
 533
 534                 d.raiseUnknownValueType(b, d.Offset-1)
 535         }
 536         panic("unreachable")
 537 }
 538
 539 // An unknown bencode type character was encountered.
 540 func (d *Decoder) raiseUnknownValueType(b byte, offset int64) {
 541         panic(&SyntaxError{
 542                 Offset: offset,
 543                 What:   fmt.Errorf("unknown value type %+q", b),
 544         })
 545 }
 546
 547 func (d *Decoder) parseValueInterface() (interface{}, bool) {
 548         b, err := d.r.ReadByte()
 549         if err != nil {
 550                 panic(err)
 551         }
 552         d.Offset++
 553
 554         switch b {
 555         case 'e':
 556                 return nil, false
 557         case 'd':
 558                 return d.parseDictInterface(), true
 559         case 'l':
 560                 return d.parseListInterface(), true
 561         case 'i':
 562                 return d.parseIntInterface(), true
 563         default:
 564                 if b >= '0' && b <= '9' {
 565                         // string
 566                         // append first digit of the length to the buffer
 567                         d.buf.WriteByte(b)
 568                         return d.parseStringInterface(), true
 569                 }
 570
 571                 d.raiseUnknownValueType(b, d.Offset-1)
 572                 panic("unreachable")
 573         }
 574 }
 575
 576 func (d *Decoder) parseIntInterface() (ret interface{}) {
 577         start := d.Offset - 1
 578         d.readUntil('e')
 579         if d.buf.Len() == 0 {
 580                 panic(&SyntaxError{
 581                         Offset: start,
 582                         What:   errors.New("empty integer value"),
 583                 })
 584         }
 585
 586         n, err := strconv.ParseInt(d.buf.String(), 10, 64)
 587         if ne, ok := err.(*strconv.NumError); ok && ne.Err == strconv.ErrRange {
 588                 i := new(big.Int)
 589                 _, ok := i.SetString(d.buf.String(), 10)
 590                 if !ok {
 591                         panic(&SyntaxError{
 592                                 Offset: start,
 593                                 What:   errors.New("failed to parse integer"),
 594                         })
 595                 }
 596                 ret = i
 597         } else {
 598                 checkForIntParseError(err, start)
 599                 ret = n
 600         }
 601
 602         d.buf.Reset()
 603         return
 604 }
 605
 606 func (d *Decoder) parseStringInterface() interface{} {
 607         start := d.Offset - 1
 608
 609         // read the string length first
 610         d.readUntil(':')
 611         length, err := strconv.ParseInt(d.buf.String(), 10, 64)
 612         checkForIntParseError(err, start)
 613
 614         d.buf.Reset()
 615         n, err := io.CopyN(&d.buf, d.r, length)
 616         d.Offset += n
 617         if err != nil {
 618                 checkForUnexpectedEOF(err, d.Offset)
 619                 panic(&SyntaxError{
 620                         Offset: d.Offset,
 621                         What:   errors.New("unexpected I/O error: " + err.Error()),
 622                 })
 623         }
 624
 625         s := d.buf.String()
 626         d.buf.Reset()
 627         return s
 628 }
 629
 630 func (d *Decoder) parseDictInterface() interface{} {
 631         dict := make(map[string]interface{})
 632         for {
 633                 keyi, ok := d.parseValueInterface()
 634                 if !ok {
 635                         break
 636                 }
 637
 638                 key, ok := keyi.(string)
 639                 if !ok {
 640                         panic(&SyntaxError{
 641                                 Offset: d.Offset,
 642                                 What:   errors.New("non-string key in a dict"),
 643                         })
 644                 }
 645
 646                 valuei, ok := d.parseValueInterface()
 647                 if !ok {
 648                         break
 649                 }
 650
 651                 dict[key] = valuei
 652         }
 653         return dict
 654 }
 655
 656 func (d *Decoder) parseListInterface() interface{} {
 657         var list []interface{}
 658         for {
 659                 valuei, ok := d.parseValueInterface()
 660                 if !ok {
 661                         break
 662                 }
 663
 664                 list = append(list, valuei)
 665         }
 666         if list == nil {
 667                 list = make([]interface{}, 0, 0)
 668         }
 669         return list
 670 }