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
use local_async_utils::prelude::*;
use mtorrent_utils::{benc, net};
use reqwest::{ClientBuilder, Url};
use std::collections::{BTreeMap, HashMap};
use std::net::{IpAddr, SocketAddr};
use std::{fmt, io, str};
use thiserror::Error;

#[derive(Debug, Error)]
pub enum Error {
    #[error("[http]{0}")]
    Http(#[from] reqwest::Error),
    #[error("[benc]{0}")]
    Benc(#[from] benc::ParseError),
    #[error("[response]{0}")]
    Response(String),
    #[error("unsupported")]
    Unsupported,
}

impl From<Error> for io::Error {
    fn from(e: Error) -> Self {
        match e {
            Error::Http(e) => io::Error::new(io::ErrorKind::UnexpectedEof, e),
            Error::Benc(e) => io::Error::new(io::ErrorKind::InvalidData, e),
            Error::Response(s) => io::Error::other(s),
            Error::Unsupported => io::Error::from(io::ErrorKind::Unsupported),
        }
    }
}

const APP_USER_AGENT: &str = concat!(env!("CARGO_PKG_NAME"), "/", env!("CARGO_PKG_VERSION"));

#[derive(Clone)]
pub struct TrackerClient(reqwest::Client);

#[cfg(windows)]
fn set_interface(builder: ClientBuilder, _interface: Option<&str>) -> ClientBuilder {
    builder
}

#[cfg(any(
    target_os = "android",
    target_os = "fuchsia",
    target_os = "illumos",
    target_os = "ios",
    target_os = "linux",
    target_os = "macos",
    target_os = "solaris",
    target_os = "tvos",
    target_os = "visionos",
    target_os = "watchos",
))]
fn set_interface(builder: ClientBuilder, interface: Option<&str>) -> ClientBuilder {
    if let Some(iface) = interface {
        builder.interface(iface)
    } else {
        builder
    }
}

impl TrackerClient {
    pub fn new(local_addr: IpAddr, interface: Option<&str>) -> Result<Self, Error> {
        let builder = reqwest::Client::builder()
            .gzip(true)
            .user_agent(APP_USER_AGENT)
            .local_address(local_addr)
            .timeout(sec!(30));

        let inner = set_interface(builder, interface).build()?;
        Ok(TrackerClient(inner))
    }

    pub async fn announce(
        &self,
        request_builder: TrackerRequestBuilder,
    ) -> Result<AnnounceResponseContent, Error> {
        let announce_url = request_builder.build_announce();
        log::debug!("Sending announce request to {announce_url}");

        let response_data =
            self.0.get(announce_url).send().await?.error_for_status()?.bytes().await?;
        let bencoded = benc::Element::from_bytes(&response_data)?;
        log::debug!("Received announce response: {bencoded}");

        let content = AnnounceResponseContent::from_benc(bencoded)
            .ok_or(Error::Benc(benc::ParseError::ExternalError("Unexpected bencoding".into())))?;

        match content.failure_reason() {
            Some(reason) => Err(Error::Response(reason.to_string())),
            None => Ok(content),
        }
    }

    pub async fn scrape(
        &self,
        request_builder: TrackerRequestBuilder,
    ) -> Result<ScrapeResponseContent, Error> {
        let scrape_url = request_builder.build_scrape().ok_or(Error::Unsupported)?;
        log::debug!("Sending scrape request to {scrape_url}");

        let response_data =
            self.0.get(scrape_url).send().await?.error_for_status()?.bytes().await?;
        let bencoded = benc::Element::from_bytes(&response_data)?;
        log::debug!("Scrape response: {bencoded}");

        let response = ScrapeResponseContent::try_from(bencoded)
            .map_err(|s| Error::Benc(benc::ParseError::ExternalError(s.into())))?;

        Ok(response)
    }
}

pub struct TrackerRequestBuilder {
    base_url: Url,
    query: String,
}

impl TryFrom<&str> for TrackerRequestBuilder {
    type Error = url::ParseError;

    fn try_from(announce_url: &str) -> Result<Self, Self::Error> {
        Ok(TrackerRequestBuilder {
            base_url: Url::parse(announce_url)?,
            query: String::with_capacity(128),
        })
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum AnnounceEvent {
    Started,
    Stopped,
    Completed,
}

impl TrackerRequestBuilder {
    pub fn info_hash(&mut self, data: &[u8]) -> &mut Self {
        self.append_bytes("info_hash", data)
    }

    pub fn peer_id(&mut self, data: &[u8]) -> &mut Self {
        self.append_bytes("peer_id", data)
    }

    pub fn port(&mut self, port: u16) -> &mut Self {
        self.append_tostring("port", port)
    }

    pub fn bytes_uploaded(&mut self, count: usize) -> &mut Self {
        self.append_tostring("uploaded", count)
    }

    pub fn bytes_downloaded(&mut self, count: usize) -> &mut Self {
        self.append_tostring("downloaded", count)
    }

    pub fn bytes_left(&mut self, count: usize) -> &mut Self {
        self.append_tostring("left", count)
    }

    pub fn event(&mut self, event: AnnounceEvent) -> &mut Self {
        let value = match event {
            AnnounceEvent::Started => "started",
            AnnounceEvent::Stopped => "stopped",
            AnnounceEvent::Completed => "completed",
        };
        self.append_tostring("event", value)
    }

    pub fn numwant(&mut self, num_want: usize) -> &mut Self {
        self.append_tostring("numwant", num_want)
    }

    pub fn compact_support(&mut self) -> &mut Self {
        self.query.push_str("&compact=1");
        self
    }

    pub fn no_peer_id(&mut self) -> &mut Self {
        self.query.push_str("&no_peer_id=1");
        self
    }

    fn build_announce(mut self) -> Url {
        if let Some(substr) = self.query.get(1..) {
            self.base_url.set_query(Some(substr));
        }
        self.base_url
    }

    fn build_scrape(mut self) -> Option<Url> {
        if self.base_url.path() != "/announce" {
            None
        } else {
            self.base_url.set_path("scrape");
            if let Some(substr) = self.query.get(1..) {
                self.base_url.set_query(Some(substr));
            }
            Some(self.base_url)
        }
    }

    fn append_bytes(&mut self, name: &str, data: &[u8]) -> &mut Self {
        let value = form_urlencoded::byte_serialize(data).collect::<String>();
        self.query.push('&');
        self.query.push_str(name);
        self.query.push('=');
        self.query.push_str(value.as_str());
        self
    }

    fn append_tostring<T: ToString>(&mut self, name: &str, value: T) -> &mut Self {
        let mut encoder = form_urlencoded::Serializer::new(String::with_capacity(64));
        encoder.append_pair(name, value.to_string().as_str());
        self.query.push('&');
        self.query.push_str(encoder.finish().as_str());
        self
    }
}

// -------------------------------------------------------------------------------------------------

#[derive(Debug, Clone)]
pub struct ScrapeResponseEntry {
    #[expect(dead_code)]
    pub name: Option<String>,
    pub complete: usize,
    pub downloaded: usize,
    pub incomplete: usize,
}

#[derive(Debug, Clone)]
pub struct ScrapeResponseContent {
    pub files: HashMap<[u8; 20], ScrapeResponseEntry>,
}

impl TryFrom<benc::Element> for ScrapeResponseContent {
    type Error = &'static str;

    fn try_from(bencode: benc::Element) -> Result<Self, Self::Error> {
        fn convert_entry(value: benc::Element) -> Option<ScrapeResponseEntry> {
            let benc::Element::Dictionary(entry) = value else {
                return None;
            };
            let mut entry = benc::convert_dictionary(entry);

            if let Some(benc::Element::Integer(complete)) = entry.remove("complete")
                && let Some(benc::Element::Integer(downloaded)) = entry.remove("downloaded")
                && let Some(benc::Element::Integer(incomplete)) = entry.remove("incomplete")
            {
                Some(ScrapeResponseEntry {
                    name: entry.remove("name").and_then(|e| match e {
                        benc::Element::ByteString(name) => String::from_utf8(name).ok(),
                        _ => None,
                    }),
                    complete: complete.try_into().ok()?,
                    downloaded: downloaded.try_into().ok()?,
                    incomplete: incomplete.try_into().ok()?,
                })
            } else {
                None
            }
        }

        let benc::Element::Dictionary(mut root) = bencode else {
            return Err("root element is not a dictionary");
        };

        let Some(benc::Element::Dictionary(files)) = root.remove(&"files".to_owned().into()) else {
            return Err("no 'files' in the root dictionary");
        };

        let mut ret = HashMap::with_capacity(files.len());
        for (key, value) in files {
            if let benc::Element::ByteString(info_hash) = key
                && let Ok(info_hash) = <[u8; 20]>::try_from(info_hash)
                && let Some(entry) = convert_entry(value)
            {
                ret.insert(info_hash, entry);
            }
        }

        Ok(Self { files: ret })
    }
}

#[derive(Debug, Clone)]
pub struct AnnounceResponseContent {
    root: BTreeMap<String, benc::Element>,
}

impl AnnounceResponseContent {
    pub fn from_benc(e: benc::Element) -> Option<Self> {
        match e {
            benc::Element::Dictionary(dict) => Some(AnnounceResponseContent {
                root: benc::convert_dictionary(dict),
            }),
            _ => None,
        }
    }

    fn failure_reason(&self) -> Option<&str> {
        if let Some(benc::Element::ByteString(data)) = self.root.get("failure reason") {
            str::from_utf8(data).ok()
        } else {
            None
        }
    }

    pub fn warning_message(&self) -> Option<&str> {
        if let Some(benc::Element::ByteString(data)) = self.root.get("warning message") {
            str::from_utf8(data).ok()
        } else {
            None
        }
    }

    pub fn interval(&self) -> Option<usize> {
        if let Some(benc::Element::Integer(data)) = self.root.get("interval") {
            usize::try_from(*data).ok()
        } else {
            None
        }
    }

    pub fn tracker_id(&self) -> Option<&str> {
        if let Some(benc::Element::ByteString(data)) = self.root.get("tracker id") {
            str::from_utf8(data).ok()
        } else {
            None
        }
    }

    pub fn complete(&self) -> Option<usize> {
        if let Some(benc::Element::Integer(data)) = self.root.get("complete") {
            usize::try_from(*data).ok()
        } else {
            None
        }
    }

    pub fn incomplete(&self) -> Option<usize> {
        if let Some(benc::Element::Integer(data)) = self.root.get("incomplete") {
            usize::try_from(*data).ok()
        } else {
            None
        }
    }

    pub fn peers(&self) -> Option<Vec<SocketAddr>> {
        match (self.root.get("peers"), self.root.get("peers6")) {
            (None, None) => None,
            (peers, ipv6_peers) => {
                let mut all_peers = Vec::new();
                match peers {
                    Some(benc::Element::ByteString(data)) => {
                        all_peers.extend(net::SocketAddrV4BytesIter(data).map(SocketAddr::V4));
                    }
                    Some(benc::Element::List(list)) => {
                        all_peers.extend(dictionary_peers(list));
                    }
                    _ => (),
                }
                if let Some(benc::Element::ByteString(data)) = ipv6_peers {
                    all_peers.extend(net::SocketAddrV6BytesIter(data).map(SocketAddr::V6))
                }
                Some(all_peers)
            }
        }
    }
}

impl fmt::Display for AnnounceResponseContent {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        if let Some(warning) = self.warning_message() {
            write!(f, "warning={warning} ")?;
        }
        if let Some(tracker_id) = self.tracker_id() {
            write!(f, "tracker_id={tracker_id} ")?;
        }
        if let Some(interval) = self.interval() {
            write!(f, "interval={interval} ")?;
        }
        if let Some(complete) = self.complete() {
            write!(f, "complete={complete} ")?;
        }
        if let Some(incomplete) = self.incomplete() {
            write!(f, "incomplete={incomplete} ")?;
        }
        if let Some(peers) = self.peers() {
            write!(f, "peers={peers:?}")?;
        }
        Ok(())
    }
}

fn dictionary_peers(data: &[benc::Element]) -> impl Iterator<Item = SocketAddr> + '_ {
    fn to_addr_and_port(dict: &BTreeMap<benc::Element, benc::Element>) -> Option<SocketAddr> {
        let ip = dict.get(&benc::Element::from("ip"))?;
        let port = dict.get(&benc::Element::from("port"))?;
        match (ip, port) {
            (benc::Element::ByteString(ip), benc::Element::Integer(port)) => Some(SocketAddr::new(
                str::from_utf8(ip).ok()?.parse().ok()?,
                u16::try_from(*port).ok()?,
            )),
            _ => None,
        }
    }
    data.iter().filter_map(|e: &benc::Element| -> Option<SocketAddr> {
        match e {
            benc::Element::Dictionary(dict) => to_addr_and_port(dict),
            _ => None,
        }
    })
}

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

    #[test]
    fn test_announce_uri() {
        let hash =
            b"\x12\x34\x56\x78\x9a\xbc\xde\xf1\x23\x45\x67\x89\xab\xcd\xef\x12\x34\x56\x78\x9a";
        let url_base = "http://example.com/announce";

        let mut builder = TrackerRequestBuilder::try_from(url_base).unwrap();
        builder
            .info_hash(hash)
            .bytes_left(42)
            .bytes_uploaded(3)
            .no_peer_id()
            .numwant(50);

        let uri = builder.build_announce();

        assert_eq!(
            "http://example.com/announce?info_hash=%124Vx%9A%BC%DE%F1%23Eg%89%AB%CD%EF%124Vx%9A&left=42&uploaded=3&no_peer_id=1&numwant=50",
            uri.as_str()
        );
    }

    #[test]
    fn test_announce_uri_no_path() {
        let hash =
            b"\x12\x34\x56\x78\x9a\xbc\xde\xf1\x23\x45\x67\x89\xab\xcd\xef\x12\x34\x56\x78\x9a";
        let url_base = "http://example.com";

        let mut builder = TrackerRequestBuilder::try_from(url_base).unwrap();
        builder
            .info_hash(hash)
            .bytes_left(42)
            .bytes_uploaded(3)
            .no_peer_id()
            .numwant(50);

        let uri = builder.build_announce();

        assert_eq!(
            "http://example.com/?info_hash=%124Vx%9A%BC%DE%F1%23Eg%89%AB%CD%EF%124Vx%9A&left=42&uploaded=3&no_peer_id=1&numwant=50",
            uri.as_str()
        );
    }

    #[test]
    fn test_scrape_uri() {
        let hash1 =
            b"\x12\x34\x56\x78\x9a\xbc\xde\xf1\x23\x45\x67\x89\xab\xcd\xef\x12\x34\x56\x78\x9a";
        let hash2 =
            b"\x12\x34\x56\x78\x9a\xbc\xde\xf1\x23\x45\x67\x89\xab\xcd\xef\x12\x34\x56\x78\x9b";
        let url_base = "http://example.com/announce";

        let mut builder = TrackerRequestBuilder::try_from(url_base).unwrap();
        builder.info_hash(hash1);
        builder.info_hash(hash2);
        let uri = builder.build_scrape();

        assert_eq!(
            "http://example.com/scrape?info_hash=%124Vx%9A%BC%DE%F1%23Eg%89%AB%CD%EF%124Vx%9A&info_hash=%124Vx%9A%BC%DE%F1%23Eg%89%AB%CD%EF%124Vx%9B",
            uri.unwrap().as_str()
        );
    }

    #[test]
    fn test_unsupported_scrape_uri() {
        let url_base = "http://example.com";

        let builder = TrackerRequestBuilder::try_from(url_base).unwrap();
        let uri = builder.build_scrape();

        assert!(uri.is_none());
    }

    #[test]
    fn test_parse_ipv4_and_ipv6_in_announce_response() {
        let response_data = "d8:completei146e10:incompletei4e8:intervali1800e5:peersld2:ip14:185.125.190.597:peer id20:T03I--00RleC9iXCylpi4:porti6902eed2:ip36:2a01:e0a:352:2450:211:32ff:fed8:cacb7:peer id20:-TR2930-r6di5h9fx1t74:porti63810eed2:ip39:2600:1700:dc40:2830:c423:6cff:fe78:e2ea7:peer id20:-TR3000-j0qob7o6v6xt4:porti51413eed2:ip36:2001:9e8:f123:700:211:32ff:fe97:ebfe7:peer id20:-TR2930-3118vqmbf7b84:porti16881eeee";

        let entity = benc::Element::from_bytes(response_data.as_bytes()).unwrap();
        let response_content = AnnounceResponseContent::from_benc(entity)
            .ok_or(Error::Benc(benc::ParseError::ExternalError("Unexpected bencoding".into())))
            .unwrap();

        let peers = response_content.peers().unwrap();
        assert_eq!(4, peers.len());
        assert_eq!(1, peers.iter().filter(|addr| addr.is_ipv4()).count());
        assert_eq!(3, peers.iter().filter(|addr| addr.is_ipv6()).count());
    }

    #[test]
    fn test_parse_compact_ipv4_and_ipv6_in_announce_response() {
        let response_data = "d8:intervali1800e5:peers6:addrpn6:peers618:addraddraddraddrpne";

        let entity = benc::Element::from_bytes(response_data.as_bytes()).unwrap();
        let response_content = AnnounceResponseContent::from_benc(entity)
            .ok_or(Error::Benc(benc::ParseError::ExternalError("Unexpected bencoding".into())))
            .unwrap();

        let peers = response_content.peers().unwrap();
        assert_eq!(2, peers.len());

        let ipv4 = *peers.iter().find(|addr| addr.is_ipv4()).expect("no ipv4 peer");
        assert_eq!(ipv4, "97.100.100.114:28782".parse().unwrap());

        let ipv6 = *peers.iter().find(|addr| addr.is_ipv6()).expect("no ipv6 peer");
        assert_eq!(ipv6, "[6164:6472:6164:6472:6164:6472:6164:6472]:28782".parse().unwrap());
    }

    #[ignore]
    #[tokio::test]
    async fn test_https_scrape_and_announce() {
        let tracker_url = "https://torrent.ubuntu.com/announce";
        let client = TrackerClient::new(Ipv4Addr::UNSPECIFIED.into(), None).unwrap();

        let request = TrackerRequestBuilder::try_from(tracker_url).unwrap();
        let response = client.scrape(request).await.unwrap_or_else(|e| panic!("Scrape error: {e}"));
        assert!(!response.files.is_empty());

        for (info_hash, info) in response.files {
            println!("Announce for torrent: {info:?}");
            let mut request = TrackerRequestBuilder::try_from(tracker_url).unwrap();
            request
                .info_hash(&info_hash)
                .peer_id(&[b'm'; 20])
                .bytes_left(0)
                .bytes_uploaded(0)
                .bytes_downloaded(0)
                // .compact_support()
                .port(6666);

            let response =
                client.announce(request).await.unwrap_or_else(|e| panic!("Announce error: {e}"));

            let peer_count = response.peers().unwrap().len();
            let seeders = response.complete().unwrap();
            let leechers = response.incomplete().unwrap();
            assert!(peer_count <= seeders + leechers);
        }
    }
}