aria2-protocol 0.3.10

Multi-protocol networking stack for aria2-rust: HTTP/HTTPS client, FTP/SFTP, full BitTorrent (DHT/PEX/MSE), and Metalink V3/V4 parser
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
use std::net::SocketAddr;
use std::time::Duration;

use tracing::{debug, info, warn};

use super::request::UdpTrackerRequest;
use super::{
    AnnounceResponse, ConnectionState, MAX_RETRIES, UdpAnnounceParams, UdpError, UdpTrackerClient,
};
use crate::bittorrent::tracker::udp_tracker_protocol::{
    ConnectResponse, UdpAction, UdpEvent, build_announce_request, build_connect_request,
    decode_response_header, parse_announce_response_for_ip, parse_connect_response,
    parse_scrape_response,
};

impl UdpTrackerClient {
    pub async fn announce(
        &mut self,
        params: UdpAnnounceParams<'_>,
        timeout: Duration,
    ) -> Result<AnnounceResponse, UdpError> {
        self.add_announce(
            &params.tracker_addr,
            params.info_hash,
            params.peer_id,
            params.downloaded,
            params.left,
            params.uploaded,
            params.event,
            params.num_want,
            params.port,
        );

        loop {
            if let Some(index) = self.pending.iter().position(|request| {
                !request.is_connect
                    && request.remote_addr == params.tracker_addr
                    && request.info_hash == *params.info_hash
                    && (request.reply.is_some() || request.error.is_some())
            }) {
                let request = self
                    .pending
                    .remove(index)
                    .expect("completed UDP tracker request index is valid");
                if let Some(response) = request.reply {
                    return Ok(response);
                }
                return Err(request.error.unwrap_or(UdpError::MalformedResponse));
            }

            let processed = self.process_one().await;
            if self.has_inflight() {
                if !self.receive_next_with_timeout(timeout).await {
                    self.handle_timeouts_with_timeout(timeout).await;
                }
                continue;
            }
            if !processed {
                return Err(UdpError::Network);
            }
            tokio::task::yield_now().await;
        }
    }

    pub(crate) async fn process_one(&mut self) -> bool {
        loop {
            if self.pending.is_empty() && self.waiting_for_conn.is_empty() {
                return false;
            }

            if let Some(mut req) = self.pending.pop_front() {
                if req.reply.is_some() || req.scrape_results.is_some() || req.error.is_some() {
                    self.pending.push_front(req);
                    return false;
                }

                if req.is_connect {
                    return self.send_connect_request(req).await;
                }

                let host_key = req.remote_addr;

                if let Some(conn) = self.conn_cache.get(&host_key) {
                    if conn.updated_at.elapsed().as_secs()
                        < crate::bittorrent::tracker::udp_tracker_protocol::CONNECTION_ID_TTL_SECS
                    {
                        if !req.scrape_info_hashes.is_empty() {
                            return self.send_scrape(&mut req, conn.id).await;
                        }
                        return self.send_announce(&mut req, conn.id).await;
                    } else {
                        self.conn_cache.remove(&host_key);
                        debug!("Connection cache expired for {}", host_key);
                    }
                }

                if !self.is_connecting_to(&host_key) {
                    self.waiting_for_conn.push_back(req);
                    return self.send_connect(host_key).await;
                }

                self.waiting_for_conn.push_back(req);
                debug!("Waiting for connection to {}", host_key);
                return false;
            } else if let Some(req) = self.waiting_for_conn.pop_front() {
                if self.is_connecting_to(&req.remote_addr) {
                    self.waiting_for_conn.push_front(req);
                    return false;
                }
                self.pending.push_front(req);
            } else {
                return false;
            }
        }
    }

    pub(crate) async fn send_announce(
        &mut self,
        req: &mut UdpTrackerRequest,
        conn_id: u64,
    ) -> bool {
        let txn_id = self.next_txn();
        req.txn_id = txn_id;
        req.dispatched_at = Some(std::time::Instant::now());

        let payload = build_announce_request(
            conn_id,
            txn_id,
            &req.info_hash,
            &req.peer_id,
            req.downloaded,
            req.left,
            req.uploaded,
            req.event,
            0,
            0,
            req.num_want,
            req.port,
        );

        match self.socket.send_to(&payload, req.remote_addr).await {
            Ok(len) => {
                self.txn_map.insert(txn_id, self.inflight.len());
                self.inflight.push_back(std::mem::replace(
                    req,
                    UdpTrackerRequest::new(
                        req.remote_addr,
                        req.info_hash,
                        req.peer_id,
                        req.downloaded,
                        req.left,
                        req.uploaded,
                        req.event,
                        req.num_want,
                        req.port,
                    ),
                ));
                debug!(
                    "Sent ANNOUNCE {} bytes to {} (txn={})",
                    len, req.remote_addr, txn_id
                );
                true
            }
            Err(e) => {
                warn!("Send ANNOUNCE to {} failed: {}", req.remote_addr, e);
                req.fail_count += 1;
                let retry = req.fail_count < MAX_RETRIES;
                req.error = (!retry).then_some(UdpError::Network);
                let replacement = UdpTrackerRequest::new(
                    req.remote_addr,
                    req.info_hash,
                    req.peer_id,
                    req.downloaded,
                    req.left,
                    req.uploaded,
                    req.event,
                    req.num_want,
                    req.port,
                );
                let completed_or_retry = std::mem::replace(req, replacement);
                if retry {
                    self.pending.push_front(completed_or_retry);
                } else {
                    self.pending.push_back(completed_or_retry);
                }
                true
            }
        }
    }

    pub(crate) async fn send_connect(&mut self, addr: SocketAddr) -> bool {
        let mut req =
            UdpTrackerRequest::new(addr, [0u8; 20], [0u8; 20], 0, 0, 0, UdpEvent::None, 0, 0);
        req.is_connect = true;
        self.send_connect_request(req).await
    }

    async fn send_connect_request(&mut self, mut req: UdpTrackerRequest) -> bool {
        let txn_id = self.next_txn();
        let payload = build_connect_request(txn_id);
        req.txn_id = txn_id;
        req.dispatched_at = Some(std::time::Instant::now());

        match self.socket.send_to(&payload, req.remote_addr).await {
            Ok(len) => {
                let addr = req.remote_addr;
                self.txn_map.insert(txn_id, self.inflight.len());
                self.inflight.push_back(req);
                debug!("Sent CONNECT {} bytes to {} (txn={})", len, addr, txn_id);
                true
            }
            Err(e) => {
                warn!("Send CONNECT to {} failed: {}", req.remote_addr, e);
                req.fail_count += 1;
                if req.fail_count < MAX_RETRIES {
                    req.dispatched_at = None;
                    self.pending.push_front(req);
                } else {
                    self.fail_connection_requests(req.remote_addr, UdpError::Network);
                }
                true
            }
        }
    }

    pub(crate) fn has_inflight(&self) -> bool {
        !self.inflight.is_empty()
    }

    pub(crate) async fn receive_next_with_timeout(&mut self, timeout: Duration) -> bool {
        let mut buffer = [0u8; 4096];
        let now = std::time::Instant::now();
        let wait_timeout = self
            .inflight
            .iter()
            .filter_map(|request| {
                request.dispatched_at.map(|dispatched_at| {
                    let request_timeout = super::response_timeout(request.fail_count).min(timeout);
                    request_timeout.saturating_sub(now.saturating_duration_since(dispatched_at))
                })
            })
            .min()
            .unwrap_or(timeout);
        match tokio::time::timeout(wait_timeout, self.socket.recv_from(&mut buffer)).await {
            Ok(Ok((len, from))) => {
                self.handle_response(&buffer[..len], &from).await;
                true
            }
            Ok(Err(error)) => {
                warn!(%error, "UDP tracker receive failed");
                false
            }
            Err(_) => {
                warn!("UDP tracker response timed out");
                false
            }
        }
    }

    pub(crate) async fn handle_response(&mut self, data: &[u8], from: &SocketAddr) {
        let Some(header) = decode_response_header(data) else {
            if data.len() < 4 {
                warn!("Short response from {}: {} bytes", from, data.len());
            } else {
                warn!("Response too short for txn_id from {}", from);
            }
            return;
        };
        let action_val = header.action;
        let txn_id = header.transaction_id;

        let idx = match self.txn_map.get(&txn_id) {
            Some(&i) => i,
            None => {
                debug!("Unknown txn_id {} from {}", txn_id, from);
                return;
            }
        };

        if idx >= self.inflight.len() {
            warn!(
                "Invalid index {} for txn_id {} (inflight={})",
                idx,
                txn_id,
                self.inflight.len()
            );
            return;
        }

        if self.inflight[idx].remote_addr != *from {
            debug!(
                txn_id,
                expected = %self.inflight[idx].remote_addr,
                received = %from,
                "Ignoring UDP tracker response from an unexpected source"
            );
            return;
        }

        let request = &self.inflight[idx];
        let action_matches_request = match UdpAction::from_i32(action_val) {
            Some(UdpAction::Connect) => request.is_connect && data.len() == 16,
            Some(UdpAction::Announce) => {
                !request.is_connect && request.scrape_info_hashes.is_empty()
            }
            Some(UdpAction::Scrape) => {
                !request.is_connect && !request.scrape_info_hashes.is_empty()
            }
            Some(UdpAction::Error) => data.len() >= 8,
            None => false,
        };
        if !action_matches_request {
            debug!(
                txn_id,
                action = action_val,
                length = data.len(),
                "Ignoring UDP tracker action/request mismatch"
            );
            return;
        }

        self.txn_map.remove(&txn_id);
        let mut req = self.remove_inflight(idx).unwrap_or_else(|| {
            UdpTrackerRequest::new(*from, [0u8; 20], [0u8; 20], 0, 0, 0, UdpEvent::None, 0, 0)
        });

        match UdpAction::from_i32(action_val) {
            Some(UdpAction::Connect) => match parse_connect_response(data) {
                Ok(ConnectResponse { connection_id, .. }) => {
                    info!(
                        "CONNECT response from {}, conn_id=0x{:016X}",
                        from, connection_id
                    );
                    self.conn_cache.insert(
                        *from,
                        ConnectionState {
                            id: connection_id,
                            updated_at: std::time::Instant::now(),
                        },
                    );

                    self.move_connection_waiters_to_pending(from);
                }
                Err(e) => {
                    warn!("Parse CONNECT response from {} failed: {}", from, e);
                    self.fail_connection_requests(*from, UdpError::MalformedResponse);
                }
            },
            Some(UdpAction::Announce) if req.is_connect => {
                warn!("Unexpected ANNOUNCE response for CONNECT from {}", from);
                self.fail_connection_requests(*from, UdpError::MalformedResponse);
            }
            Some(UdpAction::Announce) => {
                match parse_announce_response_for_ip(data, from.ip()) {
                    Ok(resp) => {
                        info!(
                            "ANNOUNCE response from {}: {} peers, interval={}s",
                            from,
                            resp.peers.len(),
                            resp.interval
                        );
                        req.reply = Some(resp);
                        req.error = None;
                    }
                    Err(e) => {
                        warn!("Parse ANNOUNCE response from {} failed: {}", from, e);
                        req.error = Some(UdpError::MalformedResponse);
                    }
                }
                self.pending.push_back(req);
            }
            Some(UdpAction::Error) => {
                let msg_len = (data.len() - 8).min(256);
                let msg = String::from_utf8_lossy(&data[8..8 + msg_len]);
                warn!("Tracker error from {}: {}", from, msg);
                if req.is_connect {
                    self.fail_connection_requests(*from, UdpError::TrackerError);
                } else {
                    req.error = Some(UdpError::TrackerError);
                    self.pending.push_back(req);
                }
            }
            Some(UdpAction::Scrape) if req.is_connect => {
                warn!("Unexpected SCRAPE response for CONNECT from {}", from);
                self.fail_connection_requests(*from, UdpError::MalformedResponse);
            }
            Some(UdpAction::Scrape) => match parse_scrape_response(data) {
                Ok(results) if results.len() == req.scrape_info_hashes.len() => {
                    info!(
                        "SCRAPE response from {}: {} info hashes scraped",
                        from,
                        results.len()
                    );
                    req.scrape_results = Some(results);
                    req.error = None;
                    self.pending.push_back(req);
                }
                Ok(results) => {
                    warn!(
                        tracker = %from,
                        expected = req.scrape_info_hashes.len(),
                        received = results.len(),
                        "SCRAPE response count does not match request"
                    );
                    req.error = Some(UdpError::MalformedResponse);
                    self.pending.push_back(req);
                }
                Err(e) => {
                    warn!("Parse SCRAPE response from {} failed: {}", from, e);
                    req.error = Some(UdpError::MalformedResponse);
                    self.pending.push_back(req);
                }
            },
            _ => {
                warn!("Unexpected tracker action {} from {}", action_val, from);
                if req.is_connect {
                    self.fail_connection_requests(*from, UdpError::MalformedResponse);
                } else {
                    req.error = Some(UdpError::MalformedResponse);
                    self.pending.push_back(req);
                }
            }
        }
    }

    pub(crate) async fn handle_timeouts_with_timeout(&mut self, timeout: Duration) {
        let now = std::time::Instant::now();
        let expired: Vec<usize> = self
            .inflight
            .iter()
            .enumerate()
            .filter(|(_, r)| {
                r.dispatched_at.is_some_and(|dispatched_at| {
                    now.saturating_duration_since(dispatched_at)
                        >= super::response_timeout(r.fail_count).min(timeout)
                })
            })
            .map(|(i, _)| i)
            .collect();

        for idx in expired.into_iter().rev() {
            if idx < self.inflight.len() {
                let mut req = self.remove_inflight(idx).unwrap_or_else(|| {
                    UdpTrackerRequest::new(
                        std::net::SocketAddr::V4(std::net::SocketAddrV4::new(
                            std::net::Ipv4Addr::UNSPECIFIED,
                            0,
                        )),
                        [0u8; 20],
                        [0u8; 20],
                        0,
                        0,
                        0,
                        UdpEvent::None,
                        0,
                        0,
                    )
                });
                if req.txn_id != 0 {
                    self.txn_map.remove(&req.txn_id);
                }
                req.fail_count += 1;
                if req.fail_count < MAX_RETRIES {
                    debug!(
                        "Timeout retry {}/{} for txn_id={}",
                        req.fail_count, MAX_RETRIES, req.txn_id
                    );
                    req.dispatched_at = None;
                    self.pending.push_back(req);
                } else if req.is_connect {
                    warn!("CONNECT retries exhausted for {}", req.remote_addr);
                    self.fail_connection_requests(req.remote_addr, UdpError::Timeout);
                } else {
                    warn!("Max retries exceeded for txn_id={}", req.txn_id);
                    req.error = Some(UdpError::Timeout);
                    self.pending.push_back(req);
                }
            }
        }

        let stale_addrs: Vec<SocketAddr> = self
            .conn_cache
            .iter()
            .filter(|(_, s)| {
                s.updated_at.elapsed().as_secs()
                    > crate::bittorrent::tracker::udp_tracker_protocol::CONNECTION_ID_TTL_SECS
            })
            .map(|(&a, _)| a)
            .collect();

        for addr in stale_addrs {
            self.conn_cache.remove(&addr);
            debug!("Removed stale connection cache for {}", addr);
        }
    }

    pub(crate) fn is_connecting_to(&self, addr: &SocketAddr) -> bool {
        self.inflight
            .iter()
            .any(|r| r.is_connect && &r.remote_addr == addr)
    }

    fn remove_inflight(&mut self, index: usize) -> Option<UdpTrackerRequest> {
        let request = self.inflight.remove(index)?;
        for mapped_index in self.txn_map.values_mut() {
            if *mapped_index > index {
                *mapped_index -= 1;
            }
        }
        Some(request)
    }

    fn move_connection_waiters_to_pending(&mut self, addr: &SocketAddr) {
        let mut waiting = std::mem::take(&mut self.waiting_for_conn);
        while let Some(request) = waiting.pop_front() {
            if &request.remote_addr == addr {
                self.pending.push_back(request);
            } else {
                self.waiting_for_conn.push_back(request);
            }
        }
    }

    fn fail_connection_requests(&mut self, addr: SocketAddr, error: UdpError) {
        let mut waiting = std::mem::take(&mut self.waiting_for_conn);
        while let Some(mut request) = waiting.pop_front() {
            if request.remote_addr == addr {
                request.error = Some(error);
                self.pending.push_back(request);
            } else {
                self.waiting_for_conn.push_back(request);
            }
        }

        let mut pending = std::mem::take(&mut self.pending);
        while let Some(mut request) = pending.pop_front() {
            if request.remote_addr == addr && !request.is_connect && request.error.is_none() {
                request.error = Some(error);
            }
            self.pending.push_back(request);
        }
    }
}