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 // Assume the 'i' is already consumed. Read and validate the rest of an int into the buffer.
 105 func (d *Decoder) readInt() error {
 106         // start := d.Offset - 1
 107         d.readUntil('e')
 108         if err := d.bufLeadingZero(); err != nil {
 109                 return err
 110         }
 111         // if d.buf.Len() == 0 {
 112         //      panic(&SyntaxError{
 113         //              Offset: start,
 114         //              What:   errors.New("empty integer value"),
 115         //      })
 116         // }
 117         return nil
 118 }
 119
 120 // called when 'i' was consumed, for the integer type in v.
 121 func (d *Decoder) parseInt(v reflect.Value) error {
 122         start := d.Offset - 1
 123
 124         if err := d.readInt(); err != nil {
 125                 return err
 126         }
 127         s := bytesAsString(d.buf.Bytes())
 128
 129         switch v.Kind() {
 130         case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
 131                 n, err := strconv.ParseInt(s, 10, 64)
 132                 checkForIntParseError(err, start)
 133
 134                 if v.OverflowInt(n) {
 135                         return &UnmarshalTypeError{
 136                                 BencodeTypeName:     "int",
 137                                 UnmarshalTargetType: v.Type(),
 138                         }
 139                 }
 140                 v.SetInt(n)
 141         case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
 142                 n, err := strconv.ParseUint(s, 10, 64)
 143                 checkForIntParseError(err, start)
 144
 145                 if v.OverflowUint(n) {
 146                         return &UnmarshalTypeError{
 147                                 BencodeTypeName:     "int",
 148                                 UnmarshalTargetType: v.Type(),
 149                         }
 150                 }
 151                 v.SetUint(n)
 152         case reflect.Bool:
 153                 v.SetBool(s != "0")
 154         default:
 155                 return &UnmarshalTypeError{
 156                         BencodeTypeName:     "int",
 157                         UnmarshalTargetType: v.Type(),
 158                 }
 159         }
 160         d.buf.Reset()
 161         return nil
 162 }
 163
 164 func (d *Decoder) bufLeadingZero() error {
 165         b := d.buf.Bytes()
 166         if len(b) > 1 && b[0] == '0' {
 167                 return fmt.Errorf("non-zero integer has leading zeroes: %q", b)
 168         }
 169         return nil
 170 }
 171
 172 func (d *Decoder) parseStringLength() (uint64, error) {
 173         // We should have already consumed the first byte of the length into the Decoder buf.
 174         start := d.Offset - 1
 175         d.readUntil(':')
 176         if err := d.bufLeadingZero(); err != nil {
 177                 return 0, err
 178         }
 179         length, err := strconv.ParseUint(bytesAsString(d.buf.Bytes()), 10, 32)
 180         checkForIntParseError(err, start)
 181         d.buf.Reset()
 182         return length, err
 183 }
 184
 185 func (d *Decoder) parseString(v reflect.Value) error {
 186         length, err := d.parseStringLength()
 187         if err != nil {
 188                 return err
 189         }
 190         defer d.buf.Reset()
 191         read := func(b []byte) {
 192                 n, err := io.ReadFull(d.r, b)
 193                 d.Offset += int64(n)
 194                 if err != nil {
 195                         checkForUnexpectedEOF(err, d.Offset)
 196                         panic(&SyntaxError{
 197                                 Offset: d.Offset,
 198                                 What:   errors.New("unexpected I/O error: " + err.Error()),
 199                         })
 200                 }
 201         }
 202
 203         switch v.Kind() {
 204         case reflect.String:
 205                 b := make([]byte, length)
 206                 read(b)
 207                 v.SetString(bytesAsString(b))
 208                 return nil
 209         case reflect.Slice:
 210                 if v.Type().Elem().Kind() != reflect.Uint8 {
 211                         break
 212                 }
 213                 b := make([]byte, length)
 214                 read(b)
 215                 v.SetBytes(b)
 216                 return nil
 217         case reflect.Array:
 218                 if v.Type().Elem().Kind() != reflect.Uint8 {
 219                         break
 220                 }
 221                 d.buf.Grow(int(length))
 222                 b := d.buf.Bytes()[:length]
 223                 read(b)
 224                 reflect.Copy(v, reflect.ValueOf(b))
 225                 return nil
 226         }
 227         d.buf.Grow(int(length))
 228         read(d.buf.Bytes()[:length])
 229         // I believe we return here to support "ignore_unmarshal_type_error".
 230         return &UnmarshalTypeError{
 231                 BencodeTypeName:     "string",
 232                 UnmarshalTargetType: v.Type(),
 233         }
 234 }
 235
 236 // Info for parsing a dict value.
 237 type dictField struct {
 238         Type reflect.Type
 239         Get  func(value reflect.Value) func(reflect.Value)
 240         Tags tag
 241 }
 242
 243 // Returns specifics for parsing a dict field value.
 244 func getDictField(dict reflect.Type, key string) (_ dictField, err error) {
 245         // get valuev as a map value or as a struct field
 246         switch k := dict.Kind(); k {
 247         case reflect.Map:
 248                 return dictField{
 249                         Type: dict.Elem(),
 250                         Get: func(mapValue reflect.Value) func(reflect.Value) {
 251                                 return func(value reflect.Value) {
 252                                         if mapValue.IsNil() {
 253                                                 mapValue.Set(reflect.MakeMap(dict))
 254                                         }
 255                                         // Assigns the value into the map.
 256                                         // log.Printf("map type: %v", mapValue.Type())
 257                                         mapValue.SetMapIndex(reflect.ValueOf(key).Convert(dict.Key()), value)
 258                                 }
 259                         },
 260                 }, nil
 261         case reflect.Struct:
 262                 return getStructFieldForKey(dict, key), nil
 263                 // if sf.r.PkgPath != "" {
 264                 //      panic(&UnmarshalFieldError{
 265                 //              Key:   key,
 266                 //              Type:  dict.Type(),
 267                 //              Field: sf.r,
 268                 //      })
 269                 // }
 270         default:
 271                 err = fmt.Errorf("can't assign bencode dict items into a %v", k)
 272                 return
 273         }
 274 }
 275
 276 var (
 277         structFieldsMu sync.Mutex
 278         structFields   = map[reflect.Type]map[string]dictField{}
 279 )
 280
 281 func parseStructFields(struct_ reflect.Type, each func(key string, df dictField)) {
 282         for _i, n := 0, struct_.NumField(); _i < n; _i++ {
 283                 i := _i
 284                 f := struct_.Field(i)
 285                 if f.Anonymous {
 286                         t := f.Type
 287                         if t.Kind() == reflect.Ptr {
 288                                 t = t.Elem()
 289                         }
 290                         parseStructFields(t, func(key string, df dictField) {
 291                                 innerGet := df.Get
 292                                 df.Get = func(value reflect.Value) func(reflect.Value) {
 293                                         anonPtr := value.Field(i)
 294                                         if anonPtr.Kind() == reflect.Ptr && anonPtr.IsNil() {
 295                                                 anonPtr.Set(reflect.New(f.Type.Elem()))
 296                                                 anonPtr = anonPtr.Elem()
 297                                         }
 298                                         return innerGet(anonPtr)
 299                                 }
 300                                 each(key, df)
 301                         })
 302                         continue
 303                 }
 304                 tagStr := f.Tag.Get("bencode")
 305                 if tagStr == "-" {
 306                         continue
 307                 }
 308                 tag := parseTag(tagStr)
 309                 key := tag.Key()
 310                 if key == "" {
 311                         key = f.Name
 312                 }
 313                 each(key, dictField{f.Type, func(value reflect.Value) func(reflect.Value) {
 314                         return value.Field(i).Set
 315                 }, tag})
 316         }
 317 }
 318
 319 func saveStructFields(struct_ reflect.Type) {
 320         m := make(map[string]dictField)
 321         parseStructFields(struct_, func(key string, sf dictField) {
 322                 m[key] = sf
 323         })
 324         structFields[struct_] = m
 325 }
 326
 327 func getStructFieldForKey(struct_ reflect.Type, key string) (f dictField) {
 328         structFieldsMu.Lock()
 329         if _, ok := structFields[struct_]; !ok {
 330                 saveStructFields(struct_)
 331         }
 332         f, ok := structFields[struct_][key]
 333         structFieldsMu.Unlock()
 334         if !ok {
 335                 var discard interface{}
 336                 return dictField{
 337                         Type: reflect.TypeOf(discard),
 338                         Get:  func(reflect.Value) func(reflect.Value) { return func(reflect.Value) {} },
 339                         Tags: nil,
 340                 }
 341         }
 342         return
 343 }
 344
 345 func (d *Decoder) parseDict(v reflect.Value) error {
 346         // At this point 'd' byte was consumed, now read key/value pairs
 347         for {
 348                 var keyStr string
 349                 keyValue := reflect.ValueOf(&keyStr).Elem()
 350                 ok, err := d.parseValue(keyValue)
 351                 if err != nil {
 352                         return fmt.Errorf("error parsing dict key: %w", err)
 353                 }
 354                 if !ok {
 355                         return nil
 356                 }
 357
 358                 df, err := getDictField(v.Type(), keyStr)
 359                 if err != nil {
 360                         return fmt.Errorf("parsing bencode dict into %v: %w", v.Type(), err)
 361                 }
 362
 363                 // now we need to actually parse it
 364                 if df.Type == nil {
 365                         // Discard the value, there's nowhere to put it.
 366                         var if_ interface{}
 367                         if_, ok = d.parseValueInterface()
 368                         if if_ == nil {
 369                                 return fmt.Errorf("error parsing value for key %q", keyStr)
 370                         }
 371                         if !ok {
 372                                 return fmt.Errorf("missing value for key %q", keyStr)
 373                         }
 374                         continue
 375                 }
 376                 setValue := reflect.New(df.Type).Elem()
 377                 // log.Printf("parsing into %v", setValue.Type())
 378                 ok, err = d.parseValue(setValue)
 379                 if err != nil {
 380                         var target *UnmarshalTypeError
 381                         if !(errors.As(err, &target) && df.Tags.IgnoreUnmarshalTypeError()) {
 382                                 return fmt.Errorf("parsing value for key %q: %w", keyStr, err)
 383                         }
 384                 }
 385                 if !ok {
 386                         return fmt.Errorf("missing value for key %q", keyStr)
 387                 }
 388                 df.Get(v)(setValue)
 389         }
 390 }
 391
 392 func (d *Decoder) parseList(v reflect.Value) error {
 393         switch v.Kind() {
 394         default:
 395                 // If the list is a singleton of the expected type, use that value. See
 396                 // https://github.com/anacrolix/torrent/issues/297.
 397                 l := reflect.New(reflect.SliceOf(v.Type()))
 398                 if err := d.parseList(l.Elem()); err != nil {
 399                         return err
 400                 }
 401                 if l.Elem().Len() != 1 {
 402                         return &UnmarshalTypeError{
 403                                 BencodeTypeName:     "list",
 404                                 UnmarshalTargetType: v.Type(),
 405                         }
 406                 }
 407                 v.Set(l.Elem().Index(0))
 408                 return nil
 409         case reflect.Array, reflect.Slice:
 410                 // We can work with this. Normal case, fallthrough.
 411         }
 412
 413         i := 0
 414         for ; ; i++ {
 415                 if v.Kind() == reflect.Slice && i >= v.Len() {
 416                         v.Set(reflect.Append(v, reflect.Zero(v.Type().Elem())))
 417                 }
 418
 419                 if i < v.Len() {
 420                         ok, err := d.parseValue(v.Index(i))
 421                         if err != nil {
 422                                 return err
 423                         }
 424                         if !ok {
 425                                 break
 426                         }
 427                 } else {
 428                         _, ok := d.parseValueInterface()
 429                         if !ok {
 430                                 break
 431                         }
 432                 }
 433         }
 434
 435         if i < v.Len() {
 436                 if v.Kind() == reflect.Array {
 437                         z := reflect.Zero(v.Type().Elem())
 438                         for n := v.Len(); i < n; i++ {
 439                                 v.Index(i).Set(z)
 440                         }
 441                 } else {
 442                         v.SetLen(i)
 443                 }
 444         }
 445
 446         if i == 0 && v.Kind() == reflect.Slice {
 447                 v.Set(reflect.MakeSlice(v.Type(), 0, 0))
 448         }
 449         return nil
 450 }
 451
 452 func (d *Decoder) readOneValue() bool {
 453         b, err := d.r.ReadByte()
 454         if err != nil {
 455                 panic(err)
 456         }
 457         if b == 'e' {
 458                 d.r.UnreadByte()
 459                 return false
 460         } else {
 461                 d.Offset++
 462                 d.buf.WriteByte(b)
 463         }
 464
 465         switch b {
 466         case 'd', 'l':
 467                 // read until there is nothing to read
 468                 for d.readOneValue() {
 469                 }
 470                 // consume 'e' as well
 471                 b = d.readByte()
 472                 d.buf.WriteByte(b)
 473         case 'i':
 474                 d.readUntil('e')
 475                 d.buf.WriteString("e")
 476         default:
 477                 if b >= '0' && b <= '9' {
 478                         start := d.buf.Len() - 1
 479                         d.readUntil(':')
 480                         length, err := strconv.ParseInt(bytesAsString(d.buf.Bytes()[start:]), 10, 64)
 481                         checkForIntParseError(err, d.Offset-1)
 482
 483                         d.buf.WriteString(":")
 484                         n, err := io.CopyN(&d.buf, d.r, length)
 485                         d.Offset += n
 486                         if err != nil {
 487                                 checkForUnexpectedEOF(err, d.Offset)
 488                                 panic(&SyntaxError{
 489                                         Offset: d.Offset,
 490                                         What:   errors.New("unexpected I/O error: " + err.Error()),
 491                                 })
 492                         }
 493                         break
 494                 }
 495
 496                 d.raiseUnknownValueType(b, d.Offset-1)
 497         }
 498
 499         return true
 500 }
 501
 502 func (d *Decoder) parseUnmarshaler(v reflect.Value) bool {
 503         if !v.Type().Implements(unmarshalerType) {
 504                 if v.Addr().Type().Implements(unmarshalerType) {
 505                         v = v.Addr()
 506                 } else {
 507                         return false
 508                 }
 509         }
 510         d.buf.Reset()
 511         if !d.readOneValue() {
 512                 return false
 513         }
 514         m := v.Interface().(Unmarshaler)
 515         err := m.UnmarshalBencode(d.buf.Bytes())
 516         if err != nil {
 517                 panic(&UnmarshalerError{v.Type(), err})
 518         }
 519         return true
 520 }
 521
 522 // Returns true if there was a value and it's now stored in 'v', otherwise
 523 // there was an end symbol ("e") and no value was stored.
 524 func (d *Decoder) parseValue(v reflect.Value) (bool, error) {
 525         // we support one level of indirection at the moment
 526         if v.Kind() == reflect.Ptr {
 527                 // if the pointer is nil, allocate a new element of the type it
 528                 // points to
 529                 if v.IsNil() {
 530                         v.Set(reflect.New(v.Type().Elem()))
 531                 }
 532                 v = v.Elem()
 533         }
 534
 535         if d.parseUnmarshaler(v) {
 536                 return true, nil
 537         }
 538
 539         // common case: interface{}
 540         if v.Kind() == reflect.Interface && v.NumMethod() == 0 {
 541                 iface, _ := d.parseValueInterface()
 542                 v.Set(reflect.ValueOf(iface))
 543                 return true, nil
 544         }
 545
 546         b, err := d.r.ReadByte()
 547         if err != nil {
 548                 panic(err)
 549         }
 550         d.Offset++
 551
 552         switch b {
 553         case 'e':
 554                 return false, nil
 555         case 'd':
 556                 return true, d.parseDict(v)
 557         case 'l':
 558                 return true, d.parseList(v)
 559         case 'i':
 560                 return true, d.parseInt(v)
 561         default:
 562                 if b >= '0' && b <= '9' {
 563                         // It's a string.
 564                         d.buf.Reset()
 565                         // Write the first digit of the length to the buffer.
 566                         d.buf.WriteByte(b)
 567                         return true, d.parseString(v)
 568                 }
 569
 570                 d.raiseUnknownValueType(b, d.Offset-1)
 571         }
 572         panic("unreachable")
 573 }
 574
 575 // An unknown bencode type character was encountered.
 576 func (d *Decoder) raiseUnknownValueType(b byte, offset int64) {
 577         panic(&SyntaxError{
 578                 Offset: offset,
 579                 What:   fmt.Errorf("unknown value type %+q", b),
 580         })
 581 }
 582
 583 func (d *Decoder) parseValueInterface() (interface{}, bool) {
 584         b, err := d.r.ReadByte()
 585         if err != nil {
 586                 panic(err)
 587         }
 588         d.Offset++
 589
 590         switch b {
 591         case 'e':
 592                 return nil, false
 593         case 'd':
 594                 return d.parseDictInterface(), true
 595         case 'l':
 596                 return d.parseListInterface(), true
 597         case 'i':
 598                 return d.parseIntInterface(), true
 599         default:
 600                 if b >= '0' && b <= '9' {
 601                         // string
 602                         // append first digit of the length to the buffer
 603                         d.buf.WriteByte(b)
 604                         return d.parseStringInterface(), true
 605                 }
 606
 607                 d.raiseUnknownValueType(b, d.Offset-1)
 608                 panic("unreachable")
 609         }
 610 }
 611
 612 // Called after 'i', for an arbitrary integer size.
 613 func (d *Decoder) parseIntInterface() (ret interface{}) {
 614         start := d.Offset - 1
 615
 616         if err := d.readInt(); err != nil {
 617                 panic(err)
 618         }
 619         n, err := strconv.ParseInt(d.buf.String(), 10, 64)
 620         if ne, ok := err.(*strconv.NumError); ok && ne.Err == strconv.ErrRange {
 621                 i := new(big.Int)
 622                 _, ok := i.SetString(d.buf.String(), 10)
 623                 if !ok {
 624                         panic(&SyntaxError{
 625                                 Offset: start,
 626                                 What:   errors.New("failed to parse integer"),
 627                         })
 628                 }
 629                 ret = i
 630         } else {
 631                 checkForIntParseError(err, start)
 632                 ret = n
 633         }
 634
 635         d.buf.Reset()
 636         return
 637 }
 638
 639 func (d *Decoder) parseStringInterface() string {
 640         length, err := d.parseStringLength()
 641         if err != nil {
 642                 panic(err)
 643         }
 644         b := make([]byte, length)
 645         n, err := io.ReadFull(d.r, b)
 646         d.Offset += int64(n)
 647         if err != nil {
 648                 panic(&SyntaxError{Offset: d.Offset, What: err})
 649         }
 650         return bytesAsString(b)
 651 }
 652
 653 func (d *Decoder) parseDictInterface() interface{} {
 654         dict := make(map[string]interface{})
 655         lastKey := ""
 656         for {
 657                 start := d.Offset
 658                 keyi, ok := d.parseValueInterface()
 659                 if !ok {
 660                         break
 661                 }
 662
 663                 key, ok := keyi.(string)
 664                 if !ok {
 665                         panic(&SyntaxError{
 666                                 Offset: d.Offset,
 667                                 What:   errors.New("non-string key in a dict"),
 668                         })
 669                 }
 670                 if key <= lastKey {
 671                         d.throwSyntaxError(start, fmt.Errorf("dict keys unsorted: %q <= %q", key, lastKey))
 672                 }
 673                 start = d.Offset
 674                 valuei, ok := d.parseValueInterface()
 675                 if !ok {
 676                         d.throwSyntaxError(start, fmt.Errorf("dict elem missing value [key=%v]", key))
 677                 }
 678
 679                 lastKey = key
 680                 dict[key] = valuei
 681         }
 682         return dict
 683 }
 684
 685 func (d *Decoder) parseListInterface() (list []interface{}) {
 686         list = []interface{}{}
 687         valuei, ok := d.parseValueInterface()
 688         for ok {
 689                 list = append(list, valuei)
 690                 valuei, ok = d.parseValueInterface()
 691         }
 692         return
 693 }