mtorrent-core 0.5.4

Fundamentals for building asynchronous BitTorrent clients
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
use bitvec::prelude::*;
use bytes::{Buf, BufMut};
use derive_more::Display;
use mtorrent_utils::{benc, net};
use std::collections::{BTreeMap, HashMap, HashSet};
use std::net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr};
use std::{fmt, io};

/// Bitfield from the bitfield message.
pub type Bitfield = BitVec<u8, Msb0>;

#[derive(Debug)]
pub(super) enum PeerMessage {
    KeepAlive,
    Choke,
    Unchoke,
    Interested,
    NotInterested,
    Have {
        piece_index: u32,
    },
    Bitfield {
        bitfield: Bitfield,
    },
    Request {
        index: u32,
        begin: u32,
        length: u32,
    },
    Piece {
        index: u32,
        begin: u32,
        block: Vec<u8>,
    },
    Cancel {
        index: u32,
        begin: u32,
        length: u32,
    },
    DhtPort {
        listen_port: u16,
    },
    Extended {
        id: u8,
        data: Vec<u8>,
    },
}

impl PeerMessage {
    /// Decode message after the first 4 bytes. `src` must contain at least `msg_len` bytes.
    pub(super) fn decode_body<B: Buf>(msg_len: usize, src: &mut B) -> io::Result<Self> {
        fn invalid_data_err(e: impl Into<Box<dyn std::error::Error + Send + Sync>>) -> io::Error {
            io::Error::new(io::ErrorKind::InvalidData, e)
        }

        if msg_len > src.remaining() {
            return Err(invalid_data_err(format!(
                "received incomplete msg ({} instead of {})",
                src.remaining(),
                msg_len
            )));
        }

        if msg_len == 0 {
            return Ok(Self::KeepAlive);
        }

        let id = src.get_u8();
        match id {
            ID_CHOKE => Ok(Self::Choke),
            ID_UNCHOKE => Ok(Self::Unchoke),
            ID_INTERESTED => Ok(Self::Interested),
            ID_NOT_INTERESTED => Ok(Self::NotInterested),
            ID_HAVE => Ok(Self::Have {
                piece_index: src
                    .try_get_u32()
                    .map_err(|_| invalid_data_err("Have is too short"))?,
            }),
            ID_BITFIELD => {
                let mut bitfield_bytes = vec![0u8; msg_len - 1];
                src.copy_to_slice(&mut bitfield_bytes);
                Ok(Self::Bitfield {
                    bitfield: BitVec::try_from_vec(bitfield_bytes)
                        .map_err(|_| invalid_data_err("Bitfield is too long"))?,
                })
            }
            ID_REQUEST => {
                if src.remaining() < 12 {
                    Err(invalid_data_err("Request is too short"))
                } else {
                    let index = src.get_u32();
                    let begin = src.get_u32();
                    let length = src.get_u32();
                    Ok(Self::Request {
                        index,
                        begin,
                        length,
                    })
                }
            }
            ID_CANCEL => {
                if src.remaining() < 12 {
                    Err(invalid_data_err("Cancel is too short"))
                } else {
                    let index = src.get_u32();
                    let begin = src.get_u32();
                    let length = src.get_u32();
                    Ok(Self::Cancel {
                        index,
                        begin,
                        length,
                    })
                }
            }
            ID_PIECE => {
                if msg_len < 9 {
                    Err(invalid_data_err("invalid Piece len"))
                } else {
                    let index = src.get_u32();
                    let begin = src.get_u32();
                    let block_len = msg_len - 9;
                    let data = src
                        .chunk()
                        .get(..block_len)
                        .ok_or_else(|| invalid_data_err("Piece is shorter than expected"))?;
                    let mut block = Vec::with_capacity(block_len);
                    block.extend_from_slice(data);
                    Ok(Self::Piece {
                        index,
                        begin,
                        block,
                    })
                }
            }
            ID_PORT => Ok(Self::DhtPort {
                listen_port: src
                    .try_get_u16()
                    .map_err(|_| invalid_data_err("DhtPort is too short"))?,
            }),
            ID_EXTENDED => {
                if msg_len < 2 {
                    Err(invalid_data_err("invalid Extended len"))
                } else {
                    let id = src.get_u8();
                    let data_len = msg_len - 2;
                    let data = src.chunk().get(..data_len).ok_or_else(|| {
                        invalid_data_err("Extended data is shorter than expected")
                    })?;
                    let mut ext_data = Vec::with_capacity(data_len);
                    ext_data.extend_from_slice(data);
                    Ok(Self::Extended { id, data: ext_data })
                }
            }
            _ => Err(io::Error::new(
                io::ErrorKind::InvalidInput,
                format!("Unknown message type: {id}"),
            )),
        }
    }

    /// Write message to `dest`. The destination buffer must be big enough.
    pub(super) fn encode<B: BufMut>(&self, dest: &mut B) -> io::Result<()> {
        let len = self.get_length();
        if len + 4 > dest.remaining_mut() {
            return Err(io::Error::new(
                io::ErrorKind::OutOfMemory,
                format!(
                    "buffer too short to encode message ({} < {})",
                    dest.remaining_mut(),
                    len + 4
                ),
            ));
        }

        dest.put_u32(len as u32);

        match self {
            Self::KeepAlive => (),
            Self::Choke => {
                dest.put_u8(ID_CHOKE);
            }
            Self::Unchoke => {
                dest.put_u8(ID_UNCHOKE);
            }
            Self::Interested => {
                dest.put_u8(ID_INTERESTED);
            }
            Self::NotInterested => {
                dest.put_u8(ID_NOT_INTERESTED);
            }
            Self::Have { piece_index } => {
                dest.put_u8(ID_HAVE);
                dest.put_u32(*piece_index);
            }
            Self::Bitfield { bitfield } => {
                dest.put_u8(ID_BITFIELD);
                dest.put_slice(bitfield.as_raw_slice());
            }
            Self::Request {
                index,
                begin,
                length,
            } => {
                dest.put_u8(ID_REQUEST);
                dest.put_u32(*index);
                dest.put_u32(*begin);
                dest.put_u32(*length);
            }
            Self::Piece {
                index,
                begin,
                block,
            } => {
                dest.put_u8(ID_PIECE);
                dest.put_u32(*index);
                dest.put_u32(*begin);
                dest.put_slice(block);
            }
            Self::Cancel {
                index,
                begin,
                length,
            } => {
                dest.put_u8(ID_CANCEL);
                dest.put_u32(*index);
                dest.put_u32(*begin);
                dest.put_u32(*length);
            }
            Self::DhtPort { listen_port } => {
                dest.put_u8(ID_PORT);
                dest.put_u16(*listen_port);
            }
            Self::Extended { id, data } => {
                dest.put_u8(ID_EXTENDED);
                dest.put_u8(*id);
                dest.put_slice(data);
            }
        };
        Ok(())
    }

    fn get_length(&self) -> usize {
        use PeerMessage::*;

        match self {
            KeepAlive => 0,
            Choke | Unchoke | Interested | NotInterested => 1,
            Have { .. } => 5,
            Bitfield { bitfield } => 1 + bitfield.as_raw_slice().len(),
            Request { .. } | Cancel { .. } => 13,
            Piece { block, .. } => 9 + block.len(),
            DhtPort { .. } => 3,
            Extended { data, .. } => 2 + data.len(),
        }
    }
}

const ID_CHOKE: u8 = 0;
const ID_UNCHOKE: u8 = 1;
const ID_INTERESTED: u8 = 2;
const ID_NOT_INTERESTED: u8 = 3;
const ID_HAVE: u8 = 4;
const ID_BITFIELD: u8 = 5;
const ID_REQUEST: u8 = 6;
const ID_PIECE: u8 = 7;
const ID_CANCEL: u8 = 8;
const ID_PORT: u8 = 9;
const ID_EXTENDED: u8 = 20;

// ------

/// Information about a block of data.
#[derive(Clone, Eq, PartialEq, Hash, Debug, Display)]
#[display("ind={piece_index} off={in_piece_offset} len={block_length}")]
pub struct BlockInfo {
    pub piece_index: usize,
    pub in_piece_offset: usize,
    pub block_length: usize,
}

/// Messages pertaining to the upload of data by the peer sending the messages.
#[derive(Clone, Eq, PartialEq, Debug)]
pub enum UploaderMessage {
    Choke,
    Unchoke,
    Have {
        piece_index: usize,
    },
    Bitfield(Bitfield),
    Block(BlockInfo, Vec<u8>),
}

/// Messages pertaining to the download of data by the peer sending the messages.
#[derive(Clone, Eq, PartialEq, Debug)]
pub enum DownloaderMessage {
    Interested,
    NotInterested,
    Request(BlockInfo),
    Cancel(BlockInfo),
}

/// Types of extensions for the [extension protocol](https://www.bittorrent.org/beps/bep_0010.html).
#[derive(Debug, Clone, Copy, Hash, PartialEq, Eq, PartialOrd, Ord)]
pub enum Extension {
    Metadata,
    PeerExchange,
}

/// Parsed extended handshake.
#[derive(Default, Clone, Eq, PartialEq, Debug)]
pub struct ExtendedHandshake {
    pub extensions: HashMap<Extension, u8>,
    pub listen_port: Option<u16>,
    pub client_type: Option<String>,
    pub yourip: Option<IpAddr>,
    pub ipv4: Option<Ipv4Addr>,
    pub ipv6: Option<Ipv6Addr>,
    pub request_limit: Option<usize>,
    pub metadata_size: Option<usize>,
}

/// Parsed PEX message.
#[derive(Default, Clone, Eq, PartialEq, Debug, Display)]
#[display("added={added:?} dropped={dropped:?}")]
pub struct PeerExchangeData {
    pub added: HashSet<SocketAddr>,
    pub dropped: HashSet<SocketAddr>,
}

/// Parsed extended message as defined by the [extension protocol](https://www.bittorrent.org/beps/bep_0010.html).
#[derive(Clone, Eq, PartialEq, Debug)]
pub enum ExtendedMessage {
    Handshake(Box<ExtendedHandshake>),
    MetadataRequest {
        piece: usize,
    },
    MetadataBlock {
        piece: usize,
        total_size: usize,
        data: Vec<u8>,
    },
    MetadataReject {
        piece: usize,
    },
    PeerExchange(Box<PeerExchangeData>),
}

impl fmt::Display for ExtendedHandshake {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "ext=[{:?}]", self.extensions)?;
        if let Some(port) = self.listen_port {
            write!(f, " port={port}")?;
        }
        if let Some(client_type) = self.client_type.as_ref() {
            write!(f, " client={client_type}")?;
        }
        if let Some(yourip) = self.yourip {
            write!(f, " yourip={yourip}")?;
        }
        if let Some(ipv4) = self.ipv4 {
            write!(f, " ipv4={ipv4}")?;
        }
        if let Some(ipv6) = self.ipv6 {
            write!(f, " ipv6={ipv6}")?;
        }
        if let Some(reqq) = self.request_limit {
            write!(f, " reqq={reqq}")?;
        }
        if let Some(metasize) = self.metadata_size {
            write!(f, " metasize={metasize}")?;
        }
        Ok(())
    }
}

// ------

impl From<UploaderMessage> for PeerMessage {
    fn from(msg: UploaderMessage) -> Self {
        match msg {
            UploaderMessage::Choke => PeerMessage::Choke,
            UploaderMessage::Unchoke => PeerMessage::Unchoke,
            UploaderMessage::Have { piece_index } => PeerMessage::Have {
                piece_index: piece_index as u32,
            },
            UploaderMessage::Bitfield(bitfield) => PeerMessage::Bitfield { bitfield },
            UploaderMessage::Block(info, data) => PeerMessage::Piece {
                index: info.piece_index as u32,
                begin: info.in_piece_offset as u32,
                block: data,
            },
        }
    }
}

impl TryFrom<PeerMessage> for UploaderMessage {
    type Error = PeerMessage;

    fn try_from(msg: PeerMessage) -> Result<Self, Self::Error> {
        match msg {
            PeerMessage::Choke => Ok(UploaderMessage::Choke),
            PeerMessage::Unchoke => Ok(UploaderMessage::Unchoke),
            PeerMessage::Have { piece_index } => Ok(UploaderMessage::Have {
                piece_index: piece_index as usize,
            }),
            PeerMessage::Bitfield { bitfield } => Ok(UploaderMessage::Bitfield(bitfield)),
            PeerMessage::Piece {
                index,
                begin,
                block,
            } => Ok(UploaderMessage::Block(
                BlockInfo {
                    piece_index: index as usize,
                    in_piece_offset: begin as usize,
                    block_length: block.len(),
                },
                block,
            )),
            _ => Err(msg),
        }
    }
}

impl fmt::Display for UploaderMessage {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            UploaderMessage::Choke => {
                write!(f, "Choke")
            }
            UploaderMessage::Unchoke => {
                write!(f, "Unchoke")
            }
            UploaderMessage::Have { piece_index } => {
                write!(f, "Have[ind={piece_index}]")
            }
            UploaderMessage::Bitfield(bitvec) => {
                write!(f, "Bitfield[len={}]", bitvec.len())
            }
            UploaderMessage::Block(info, _) => {
                write!(f, "Block[{info}]")
            }
        }
    }
}

// ------

impl From<DownloaderMessage> for PeerMessage {
    fn from(msg: DownloaderMessage) -> Self {
        match msg {
            DownloaderMessage::Interested => PeerMessage::Interested,
            DownloaderMessage::NotInterested => PeerMessage::NotInterested,
            DownloaderMessage::Request(info) => PeerMessage::Request {
                index: info.piece_index as u32,
                begin: info.in_piece_offset as u32,
                length: info.block_length as u32,
            },
            DownloaderMessage::Cancel(info) => PeerMessage::Cancel {
                index: info.piece_index as u32,
                begin: info.in_piece_offset as u32,
                length: info.block_length as u32,
            },
        }
    }
}

impl TryFrom<PeerMessage> for DownloaderMessage {
    type Error = PeerMessage;

    fn try_from(msg: PeerMessage) -> Result<Self, Self::Error> {
        match msg {
            PeerMessage::Interested => Ok(DownloaderMessage::Interested),
            PeerMessage::NotInterested => Ok(DownloaderMessage::NotInterested),
            PeerMessage::Request {
                index,
                begin,
                length,
            } => Ok(DownloaderMessage::Request(BlockInfo {
                piece_index: index as usize,
                in_piece_offset: begin as usize,
                block_length: length as usize,
            })),
            PeerMessage::Cancel {
                index,
                begin,
                length,
            } => Ok(DownloaderMessage::Cancel(BlockInfo {
                piece_index: index as usize,
                in_piece_offset: begin as usize,
                block_length: length as usize,
            })),
            _ => Err(msg),
        }
    }
}

impl fmt::Display for DownloaderMessage {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            DownloaderMessage::Interested => {
                write!(f, "Interested")
            }
            DownloaderMessage::NotInterested => {
                write!(f, "NotInterested")
            }
            DownloaderMessage::Request(info) => {
                write!(f, "Request[{info}]")
            }
            DownloaderMessage::Cancel(info) => {
                write!(f, "Cancel[{info}]")
            }
        }
    }
}

// ------

impl Extension {
    const NAME_METADATA: &'static str = "ut_metadata";
    const NAME_PEX: &'static str = "ut_pex";

    const ID_HANDSHAKE: u8 = 0;
    const ID_METADATA: u8 = 1;
    const ID_PEX: u8 = 2;

    fn from_name(name: &str) -> Option<Self> {
        match name {
            Self::NAME_METADATA => Some(Self::Metadata),
            Self::NAME_PEX => Some(Self::PeerExchange),
            _ => None,
        }
    }
    fn name(&self) -> &'static str {
        match self {
            Extension::Metadata => Self::NAME_METADATA,
            Extension::PeerExchange => Self::NAME_PEX,
        }
    }
    /// ID of the extension used locally, i.e. for parsing of incoming messages.
    pub const fn local_id(&self) -> u8 {
        match self {
            Extension::Metadata => Self::ID_METADATA,
            Extension::PeerExchange => Self::ID_PEX,
        }
    }
}

impl ExtendedHandshake {
    const KEY_M: &'static str = "m";
    const KEY_P: &'static str = "p";
    const KEY_V: &'static str = "v";
    const KEY_YOURIP: &'static str = "yourip";
    const KEY_IPV6: &'static str = "ipv6";
    const KEY_IPV4: &'static str = "ipv4";
    const KEY_REQQ: &'static str = "reqq";
    const KEY_METADATA_SIZE: &'static str = "metadata_size";

    fn decode(payload: &[u8]) -> Option<Self> {
        use mtorrent_utils::benc::Element::{self, *};
        if let Dictionary(d) = Element::from_bytes(payload).ok()? {
            let mut root = benc::convert_dictionary(d);
            let mut ret = Self::default();
            if let Some(Integer(port)) = root.remove(Self::KEY_P) {
                ret.listen_port = port.try_into().ok();
            }
            if let Some(ByteString(v)) = root.remove(Self::KEY_V) {
                ret.client_type = String::from_utf8(v).ok();
            }
            if let Some(ByteString(ip)) = root.remove(Self::KEY_YOURIP) {
                if let Some(ipv6_bytes) = ip.get(0..16) {
                    let mut octets = [0u8; 16];
                    octets.copy_from_slice(ipv6_bytes);
                    ret.yourip = Some(IpAddr::V6(Ipv6Addr::from(octets)));
                } else if let Some(ipv4_bytes) = ip.get(0..4) {
                    let mut octets = [0u8; 4];
                    octets.copy_from_slice(ipv4_bytes);
                    ret.yourip = Some(IpAddr::V4(Ipv4Addr::from(octets)));
                }
            }
            if let Some(ByteString(ipv4)) = root.remove(Self::KEY_IPV4) {
                ret.ipv4 = ipv4.get(0..4).map(|bytes| {
                    let mut octets = [0u8; 4];
                    octets.copy_from_slice(bytes);
                    Ipv4Addr::from(octets)
                });
            }
            if let Some(ByteString(ipv6)) = root.remove(Self::KEY_IPV6) {
                ret.ipv6 = ipv6.get(0..16).map(|bytes| {
                    let mut octets = [0u8; 16];
                    octets.copy_from_slice(bytes);
                    Ipv6Addr::from(octets)
                });
            }
            if let Some(Integer(max_requests)) = root.remove(Self::KEY_REQQ) {
                ret.request_limit = max_requests.try_into().ok();
            }
            if let Some(Integer(metasize)) = root.remove(Self::KEY_METADATA_SIZE) {
                ret.metadata_size = metasize.try_into().ok();
            }
            if let Some(Dictionary(d)) = root.remove(Self::KEY_M) {
                ret.extensions = d
                    .into_iter()
                    .filter_map(|(key, value)| match (key, value) {
                        (ByteString(key), Integer(value)) => {
                            let extension_name = String::from_utf8(key).ok()?;
                            let extension = Extension::from_name(&extension_name)?;
                            let id = u8::try_from(value).ok()?;
                            Some((extension, id))
                        }
                        _ => None,
                    })
                    .collect();
            }
            Some(ret)
        } else {
            None
        }
    }

    fn encode(&self) -> Vec<u8> {
        use mtorrent_utils::benc::Element::{self, *};
        let root = {
            let mut tmp = BTreeMap::new();
            let mut insert = |key: &str, val| {
                tmp.insert(Element::from(key), val);
            };
            if let Some(p) = self.listen_port {
                insert(Self::KEY_P, Integer(p as i64));
            }
            if let Some(v) = self.client_type.as_ref() {
                insert(Self::KEY_V, Element::from(v.as_str()));
            }
            if let Some(ip) = self.yourip {
                let value = match ip {
                    IpAddr::V4(ip) => ByteString(ip.octets().into()),
                    IpAddr::V6(ip) => ByteString(ip.octets().into()),
                };
                insert(Self::KEY_YOURIP, value);
            }
            if let Some(v4) = self.ipv4 {
                insert(Self::KEY_IPV4, ByteString(v4.octets().into()));
            }
            if let Some(v6) = self.ipv6 {
                insert(Self::KEY_IPV6, ByteString(v6.octets().into()));
            }
            if let Some(reqq) = self.request_limit {
                insert(Self::KEY_REQQ, Element::from(reqq as i64));
            }
            if let Some(metasize) = self.metadata_size {
                insert(Self::KEY_METADATA_SIZE, Integer(metasize as i64));
            }
            if !self.extensions.is_empty() {
                let m = self
                    .extensions
                    .iter()
                    .map(|(&extension, &id)| {
                        (Element::from(extension.name()), Element::from(i64::from(id)))
                    })
                    .collect::<BTreeMap<Element, Element>>();
                insert(Self::KEY_M, Dictionary(m));
            }
            Dictionary(tmp)
        };
        root.encode()
    }
}

impl PeerExchangeData {
    const KEY_ADDED_V4: &'static str = "added";
    const KEY_ADDED_V6: &'static str = "added6";
    const KEY_DROPPED_V4: &'static str = "dropped";
    const KEY_DROPPED_V6: &'static str = "dropped6";
    const MAX_PEERS: usize = 50;

    fn decode(payload: &[u8]) -> Option<Self> {
        use benc::Element::{self, *};

        let Dictionary(data) = Element::from_bytes(payload).ok()? else {
            return None;
        };
        let mut root = benc::convert_dictionary(data);

        let mut added = HashSet::new();
        let mut dropped = HashSet::new();

        if let Some(ByteString(s)) = root.remove(Self::KEY_ADDED_V4) {
            added.extend(net::SocketAddrV4BytesIter(&s).map(SocketAddr::V4));
        }
        if let Some(ByteString(s)) = root.remove(Self::KEY_ADDED_V6) {
            added.extend(net::SocketAddrV6BytesIter(&s).map(SocketAddr::V6));
        }
        if let Some(ByteString(s)) = root.remove(Self::KEY_DROPPED_V4) {
            dropped.extend(net::SocketAddrV4BytesIter(&s).map(SocketAddr::V4));
        }
        if let Some(ByteString(s)) = root.remove(Self::KEY_DROPPED_V6) {
            dropped.extend(net::SocketAddrV6BytesIter(&s).map(SocketAddr::V6));
        }
        Some(PeerExchangeData { added, dropped })
    }

    fn encode(&self) -> Vec<u8> {
        use mtorrent_utils::benc::Element::{self, *};
        let mut root = BTreeMap::<Element, Element>::new();

        let mut added_ipv4 = Vec::new();
        let mut added_ipv6 = Vec::new();
        for addr in self.added.iter().take(Self::MAX_PEERS) {
            match addr {
                SocketAddr::V4(addr) => {
                    added_ipv4.extend_from_slice(&addr.ip().octets());
                    added_ipv4.extend_from_slice(&u16::to_be_bytes(addr.port()));
                }
                SocketAddr::V6(addr) => {
                    added_ipv6.extend_from_slice(&addr.ip().octets());
                    added_ipv6.extend_from_slice(&u16::to_be_bytes(addr.port()));
                }
            }
        }
        root.insert(Self::KEY_ADDED_V4.into(), ByteString(added_ipv4));
        root.insert(Self::KEY_ADDED_V6.into(), ByteString(added_ipv6));

        let mut dropped_ipv4 = Vec::new();
        let mut dropped_ipv6 = Vec::new();
        for addr in self.dropped.iter().take(Self::MAX_PEERS) {
            match addr {
                SocketAddr::V4(addr) => {
                    dropped_ipv4.extend_from_slice(&addr.ip().octets());
                    dropped_ipv4.extend_from_slice(&u16::to_be_bytes(addr.port()));
                }
                SocketAddr::V6(addr) => {
                    dropped_ipv6.extend_from_slice(&addr.ip().octets());
                    dropped_ipv6.extend_from_slice(&u16::to_be_bytes(addr.port()));
                }
            }
        }
        root.insert(Self::KEY_DROPPED_V4.into(), ByteString(dropped_ipv4));
        root.insert(Self::KEY_DROPPED_V6.into(), ByteString(dropped_ipv6));

        Dictionary(root).encode()
    }
}

enum MetadataMsg {
    Request {
        piece: usize,
    },
    Block {
        piece: usize,
        total_size: usize,
        data: Vec<u8>,
    },
    Reject {
        piece: usize,
    },
}

impl MetadataMsg {
    const TYPE_REQUEST: u8 = 0;
    const TYPE_BLOCK: u8 = 1;
    const TYPE_REJECT: u8 = 2;

    const KEY_TYPE: &'static str = "msg_type";
    const KEY_PIECE: &'static str = "piece";
    const KEY_TOTAL_SIZE: &'static str = "total_size";

    fn decode(mut payload: Vec<u8>) -> Result<Self, Vec<u8>> {
        use benc::Element::{self, *};
        let (bencode, bencode_len) = match Element::from_bytes_with_len(&payload) {
            Ok(b) => b,
            Err(_) => return Err(payload),
        };
        let (msg_type, piece, total_size) = match &bencode {
            Dictionary(d) => {
                let msg_type = d.get(&Element::from(Self::KEY_TYPE)).and_then(|b| match b {
                    Integer(msg_type) => u8::try_from(*msg_type).ok(),
                    _ => None,
                });
                let piece = d.get(&Element::from(Self::KEY_PIECE)).and_then(|b| match b {
                    Integer(piece) => usize::try_from(*piece).ok(),
                    _ => None,
                });
                let total_size =
                    d.get(&Element::from(Self::KEY_TOTAL_SIZE)).and_then(|e| match e {
                        Element::Integer(total_size) => usize::try_from(*total_size).ok(),
                        _ => None,
                    });
                match (msg_type, piece) {
                    (Some(msg_type), Some(piece)) => (msg_type, piece, total_size),
                    _ => return Err(payload),
                }
            }
            _ => return Err(payload),
        };
        match (msg_type, total_size) {
            (Self::TYPE_REQUEST, _) => Ok(Self::Request { piece }),
            (Self::TYPE_REJECT, _) => Ok(Self::Reject { piece }),
            (Self::TYPE_BLOCK, Some(total_size)) => {
                let header_len = bencode_len;
                let total_len = payload.len();
                // remove bencode from the front and retain only the data that follows
                payload.copy_within(header_len..total_len, 0);
                payload.truncate(total_len - header_len);
                Ok(Self::Block {
                    piece,
                    total_size,
                    data: payload,
                })
            }
            _ => Err(payload),
        }
    }

    fn encode(self) -> Vec<u8> {
        use benc::Element::{self, *};
        let mut root = BTreeMap::<Element, Element>::new();
        match self {
            MetadataMsg::Request { piece } => {
                root.insert(Self::KEY_TYPE.into(), Integer(Self::TYPE_REQUEST.into()));
                root.insert(Self::KEY_PIECE.into(), Integer(piece as i64));
                Dictionary(root).encode()
            }
            MetadataMsg::Reject { piece } => {
                root.insert(Self::KEY_TYPE.into(), Integer(Self::TYPE_REJECT.into()));
                root.insert(Self::KEY_PIECE.into(), Integer(piece as i64));
                Dictionary(root).encode()
            }
            MetadataMsg::Block {
                piece,
                total_size,
                mut data,
            } => {
                root.insert(Self::KEY_TYPE.into(), Integer(Self::TYPE_BLOCK.into()));
                root.insert(Self::KEY_PIECE.into(), Integer(piece as i64));
                root.insert(Self::KEY_TOTAL_SIZE.into(), Integer(total_size as i64));
                let header = Dictionary(root).encode();
                let header_len = header.len();
                let data_len = data.len();
                // add header in front of data
                data.resize(data_len + header_len, 0u8);
                data.copy_within(0..data_len, header_len);
                data[0..header_len].copy_from_slice(&header);
                data
            }
        }
    }
}

impl From<(ExtendedMessage, u8)> for PeerMessage {
    fn from((extmsg, id): (ExtendedMessage, u8)) -> Self {
        match extmsg {
            ExtendedMessage::Handshake(hs) => PeerMessage::Extended {
                id: Extension::ID_HANDSHAKE,
                data: hs.encode(),
            },
            ExtendedMessage::PeerExchange(pex) => PeerMessage::Extended {
                id,
                data: pex.encode(),
            },
            ExtendedMessage::MetadataRequest { piece } => {
                let msg = MetadataMsg::Request { piece };
                PeerMessage::Extended {
                    id,
                    data: msg.encode(),
                }
            }
            ExtendedMessage::MetadataReject { piece } => {
                let msg = MetadataMsg::Reject { piece };
                PeerMessage::Extended {
                    id,
                    data: msg.encode(),
                }
            }
            ExtendedMessage::MetadataBlock {
                piece,
                total_size,
                data,
            } => {
                let msg = MetadataMsg::Block {
                    piece,
                    total_size,
                    data,
                };
                PeerMessage::Extended {
                    id,
                    data: msg.encode(),
                }
            }
        }
    }
}

impl TryFrom<PeerMessage> for ExtendedMessage {
    type Error = PeerMessage;

    fn try_from(msg: PeerMessage) -> Result<Self, Self::Error> {
        match msg {
            PeerMessage::Extended {
                id: Extension::ID_HANDSHAKE,
                ref data,
            } => {
                let handshake = ExtendedHandshake::decode(data).ok_or(msg)?;
                Ok(ExtendedMessage::Handshake(Box::new(handshake)))
            }
            PeerMessage::Extended {
                id: Extension::ID_PEX,
                ref data,
            } => {
                let peer_data = PeerExchangeData::decode(data).ok_or(msg)?;
                Ok(ExtendedMessage::PeerExchange(Box::new(peer_data)))
            }
            PeerMessage::Extended {
                id: Extension::ID_METADATA,
                data,
            } => match MetadataMsg::decode(data) {
                Ok(MetadataMsg::Request { piece }) => {
                    Ok(ExtendedMessage::MetadataRequest { piece })
                }
                Ok(MetadataMsg::Reject { piece }) => Ok(ExtendedMessage::MetadataReject { piece }),
                Ok(MetadataMsg::Block {
                    piece,
                    total_size,
                    data,
                }) => Ok(ExtendedMessage::MetadataBlock {
                    piece,
                    total_size,
                    data,
                }),
                Err(data) => Err(PeerMessage::Extended {
                    id: Extension::ID_METADATA,
                    data,
                }),
            },
            _ => Err(msg),
        }
    }
}

impl fmt::Display for ExtendedMessage {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            ExtendedMessage::Handshake(hs) => {
                write!(f, "ExtendedHandshake[{hs}]")
            }
            ExtendedMessage::MetadataRequest { piece } => {
                write!(f, "MetadataRequest[piece={piece}]")
            }
            ExtendedMessage::MetadataBlock { piece, data, .. } => {
                write!(f, "MetadataBlock[piece={} len={}]", piece, data.len())
            }
            ExtendedMessage::MetadataReject { piece } => {
                write!(f, "MetadataReject[piece={piece}]")
            }
            ExtendedMessage::PeerExchange(pex) => {
                write!(f, "PEX[{pex}]")
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_bitfield_is_parsed_correctly() {
        let bits = b"\x82";
        let msg = UploaderMessage::Bitfield(BitVec::from_slice(bits));

        let bitfield = if let UploaderMessage::Bitfield(bitfield) = msg {
            bitfield
        } else {
            panic!()
        };

        assert!(bitfield[0]);
        assert!(!bitfield[1]);
        assert!(!bitfield[2]);
        assert!(!bitfield[3]);

        assert!(!bitfield[4]);
        assert!(!bitfield[5]);
        assert!(bitfield[6]);
        assert!(!bitfield[7]);
    }

    #[test]
    fn test_handshake_payload_is_parsed_correctly() {
        let payload =
            Vec::from(b"d1:md11:ut_metadatai1e6:ut_pexi2ee1:pi6881e1:v13:\xc2\xb5Torrent 1.2e");

        let parsed = ExtendedHandshake::decode(&payload).unwrap();
        assert_eq!(
            HashMap::from([(Extension::Metadata, 1), (Extension::PeerExchange, 2)]),
            parsed.extensions
        );
        assert_eq!(6881, parsed.listen_port.unwrap());
        assert_eq!("µTorrent 1.2", parsed.client_type.as_deref().unwrap());
        assert!(parsed.ipv4.is_none());
        assert!(parsed.ipv6.is_none());
        assert!(parsed.yourip.is_none());
        assert!(parsed.request_limit.is_none());
        assert!(parsed.metadata_size.is_none());

        let data = parsed.encode();
        assert_eq!(payload, data);
    }

    #[test]
    fn test_handshake_payload_is_serialized_correctly() {
        let hs = ExtendedHandshake {
            extensions: HashMap::from([(Extension::Metadata, 1), (Extension::PeerExchange, 2)]),
            listen_port: Some(6881),
            client_type: Some("µTorrent 1.2".to_owned()),
            yourip: None,
            ipv4: None,
            ipv6: None,
            request_limit: None,
            metadata_size: None,
        };
        assert_eq!(
            Vec::from(b"d1:md11:ut_metadatai1e6:ut_pexi2ee1:pi6881e1:v13:\xc2\xb5Torrent 1.2e"),
            hs.encode()
        );
    }

    #[test]
    fn test_metadata_block_payload_is_parsed_correctly() {
        let payload = Vec::from("d8:msg_typei1e5:piecei0e10:total_sizei34256eexxxxxxxx");
        let msg = PeerMessage::Extended {
            id: Extension::ID_METADATA,
            data: payload,
        };
        let parsed = ExtendedMessage::try_from(msg).unwrap();
        assert!(
            parsed
                == ExtendedMessage::MetadataBlock {
                    piece: 0,
                    total_size: 34256,
                    data: Vec::from(b"xxxxxxxx"),
                }
        );
    }

    #[test]
    fn test_metadata_block_payload_is_serialized_correctly() {
        let msg = MetadataMsg::Block {
            piece: 0,
            total_size: 34256,
            data: Vec::from(b"xxxxxxxx"),
        };
        assert_eq!(
            Vec::from("d8:msg_typei1e5:piecei0e10:total_sizei34256eexxxxxxxx"),
            msg.encode()
        );
    }

    #[test]
    fn test_pex_is_parsed_correctly() {
        let payload = vec![
            100, 53, 58, 97, 100, 100, 101, 100, 49, 50, 58, 1, 2, 3, 4, 48, 57, 5, 6, 7, 8, 212,
            49, 54, 58, 97, 100, 100, 101, 100, 54, 51, 54, 58, 0, 8, 0, 7, 0, 6, 0, 5, 0, 4, 0, 3,
            0, 2, 0, 1, 168, 202, 0, 1, 0, 2, 0, 3, 0, 4, 0, 5, 0, 6, 0, 7, 0, 8, 168, 202, 55, 58,
            100, 114, 111, 112, 112, 101, 100, 54, 58, 1, 2, 3, 4, 26, 225, 56, 58, 100, 114, 111,
            112, 112, 101, 100, 54, 49, 56, 58, 0, 1, 0, 2, 0, 3, 0, 4, 0, 5, 0, 6, 0, 7, 0, 8,
            168, 202, 101,
        ];
        let pex = PeerExchangeData::decode(&payload).unwrap();
        assert_eq!(
            pex.added,
            HashSet::from([
                SocketAddr::new(IpAddr::V4(Ipv4Addr::new(1, 2, 3, 4)), 12345),
                SocketAddr::new(IpAddr::V4(Ipv4Addr::new(5, 6, 7, 8)), 54321),
                SocketAddr::new(IpAddr::V6(Ipv6Addr::new(1, 2, 3, 4, 5, 6, 7, 8)), 43210),
                SocketAddr::new(IpAddr::V6(Ipv6Addr::new(8, 7, 6, 5, 4, 3, 2, 1)), 43210)
            ])
        );
        assert_eq!(
            pex.dropped,
            HashSet::from([
                SocketAddr::new(IpAddr::V4(Ipv4Addr::new(1, 2, 3, 4)), 6881),
                SocketAddr::new(IpAddr::V6(Ipv6Addr::new(1, 2, 3, 4, 5, 6, 7, 8)), 43210),
            ])
        );
    }
}