aria2-core 0.3.1

aria2-rust core download engine: multi-protocol segmented downloads, rate limiting, configuration, session persistence, and BitTorrent seeding
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
use std::fmt;
use std::net::SocketAddr;
use std::time::Duration;
use tokio::time::timeout;
use tracing::{debug, info, warn};

use aria2_protocol::bittorrent::bencode::codec::BencodeValue;
use aria2_protocol::bittorrent::extension::ut_metadata::{
    ExtensionHandshake, MetadataCollector, UtMetadataMsg,
};
use aria2_protocol::bittorrent::extension::ut_metadata_tracker::UTMetadataRequestTracker;
use aria2_protocol::bittorrent::peer::connection::{PeerAddr, PeerConnection};

const METADATA_MAX_SIZE: u64 = 100 * 1024 * 1024;
const PIECE_SIZE_MIN: u32 = 1024;
const PIECE_SIZE_MAX: u32 = 65536;
const DEFAULT_MAX_ATTEMPTS: usize = 3;

#[derive(Debug, Clone)]
pub enum MetadataExchangeError {
    NoPeersAvailable,
    AllPeersFailed { attempts: usize, last_error: String },
    PeerConnectFailed { addr: String, reason: String },
    PeerTimeout { addr: String },
    UnsupportedPeer { addr: String, reason: String },
    InvalidMetadataSize { size: u64 },
    MetadataTooLarge { size: u64, max: u64 },
    BencodeDecodeFailed { detail: String },
    PieceRejected { piece: u32 },
    PieceTimeout { piece: u32 },
    IncompleteMetadata { expected: u64, received: u64 },
    IoError(String),
}

impl MetadataExchangeError {
    fn is_fatal(&self) -> bool {
        matches!(
            self,
            MetadataExchangeError::MetadataTooLarge { .. }
                | MetadataExchangeError::BencodeDecodeFailed { .. }
                | MetadataExchangeError::NoPeersAvailable
        )
    }

    pub fn addr(&self) -> Option<&str> {
        match self {
            MetadataExchangeError::PeerConnectFailed { addr, .. } => Some(addr),
            MetadataExchangeError::PeerTimeout { addr } => Some(addr),
            MetadataExchangeError::UnsupportedPeer { addr, .. } => Some(addr),
            _ => None,
        }
    }
}

impl fmt::Display for MetadataExchangeError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            MetadataExchangeError::NoPeersAvailable => {
                write!(f, "No peers available for metadata fetch")
            }
            MetadataExchangeError::AllPeersFailed {
                attempts,
                last_error,
            } => {
                write!(
                    f,
                    "All {} peers failed, last error: {}",
                    attempts, last_error
                )
            }
            MetadataExchangeError::PeerConnectFailed { addr, reason } => {
                write!(f, "Connect to {} failed: {}", addr, reason)
            }
            MetadataExchangeError::PeerTimeout { addr } => {
                write!(f, "Connect to {} timed out", addr)
            }
            MetadataExchangeError::UnsupportedPeer { addr, reason } => {
                write!(f, "Peer {} unsupported: {}", addr, reason)
            }
            MetadataExchangeError::InvalidMetadataSize { size } => {
                write!(f, "Invalid metadata_size: {}", size)
            }
            MetadataExchangeError::MetadataTooLarge { size, max } => {
                write!(f, "metadata_size too large: {} (max {})", size, max)
            }
            MetadataExchangeError::BencodeDecodeFailed { detail } => {
                write!(f, "Bencode decode failed: {}", detail)
            }
            MetadataExchangeError::PieceRejected { piece } => {
                write!(f, "Piece {} rejected by peer", piece)
            }
            MetadataExchangeError::PieceTimeout { piece } => {
                write!(f, "ut_metadata timeout for piece {}", piece)
            }
            MetadataExchangeError::IncompleteMetadata { expected, received } => {
                write!(
                    f,
                    "Incomplete metadata collection: expected {} bytes, received {}",
                    expected, received
                )
            }
            MetadataExchangeError::IoError(msg) => write!(f, "IO error: {}", msg),
        }
    }
}

impl std::error::Error for MetadataExchangeError {}

pub struct MetadataExchangeConfig {
    pub max_peers_to_try: usize,
    pub connect_timeout: Duration,
    pub request_timeout: Duration,
    pub piece_size: u32,
    pub max_attempts: usize,
}

impl Default for MetadataExchangeConfig {
    fn default() -> Self {
        Self {
            max_peers_to_try: 5,
            connect_timeout: Duration::from_secs(15),
            request_timeout: Duration::from_secs(10),
            piece_size: 16 * 1024,
            max_attempts: DEFAULT_MAX_ATTEMPTS,
        }
    }
}

impl MetadataExchangeConfig {
    pub fn with_piece_size(mut self, size: u32) -> Self {
        if !(PIECE_SIZE_MIN..=PIECE_SIZE_MAX).contains(&size) {
            warn!(
                "piece_size={} is out of valid range [{}-{}], clamping",
                size, PIECE_SIZE_MIN, PIECE_SIZE_MAX
            );
            self.piece_size = size.clamp(PIECE_SIZE_MIN, PIECE_SIZE_MAX);
        } else {
            self.piece_size = size;
        }
        self
    }

    pub fn with_max_attempts(mut self, attempts: usize) -> Self {
        self.max_attempts = attempts.max(1);
        self
    }
}

pub struct MetadataExchangeSession {
    config: MetadataExchangeConfig,
}

impl MetadataExchangeSession {
    pub fn new(config: MetadataExchangeConfig) -> Self {
        Self { config }
    }

    pub async fn fetch_metadata(
        &self,
        info_hash: &[u8; 20],
        peers: &[SocketAddr],
    ) -> Result<Vec<u8>, MetadataExchangeError> {
        if peers.is_empty() {
            return Err(MetadataExchangeError::NoPeersAvailable);
        }

        let mut attempt_count = 0usize;
        let mut last_error = String::new();

        for peer_addr in peers.iter().take(self.config.max_peers_to_try) {
            if attempt_count >= self.config.max_attempts {
                break;
            }

            match self.exchange_with_peer(info_hash, peer_addr).await {
                Ok(torrent_bytes) => {
                    info!(
                        "Metadata fetched successfully from {} ({} bytes)",
                        peer_addr,
                        torrent_bytes.len()
                    );
                    return Ok(torrent_bytes);
                }
                Err(e) => {
                    attempt_count += 1;
                    last_error = e.to_string();

                    if e.is_fatal() {
                        warn!("Fatal metadata exchange error with {}: {}", peer_addr, e);
                        return Err(e);
                    }

                    warn!(
                        "Recoverable metadata exchange error with {} (attempt {}/{}): {}",
                        peer_addr, attempt_count, self.config.max_attempts, e
                    );
                }
            }
        }

        Err(MetadataExchangeError::AllPeersFailed {
            attempts: attempt_count,
            last_error,
        })
    }

    async fn exchange_with_peer(
        &self,
        info_hash: &[u8; 20],
        peer_addr: &SocketAddr,
    ) -> Result<Vec<u8>, MetadataExchangeError> {
        let addr_str = peer_addr.to_string();
        let addr = PeerAddr::new(&peer_addr.ip().to_string(), peer_addr.port());

        let conn_result = timeout(
            self.config.connect_timeout,
            PeerConnection::connect(&addr, info_hash),
        )
        .await;
        let mut conn = match conn_result {
            Ok(Ok(c)) => c,
            Ok(Err(e)) => {
                return Err(MetadataExchangeError::PeerConnectFailed {
                    addr: addr_str.clone(),
                    reason: e.to_string(),
                });
            }
            Err(_) => {
                return Err(MetadataExchangeError::PeerTimeout {
                    addr: addr_str.clone(),
                });
            }
        };

        debug!("Connected to {}, sending extension handshake", peer_addr);

        let hs_payload = ExtensionHandshake::new(0).to_bencode();
        let hs_encoded = hs_payload.encode();

        conn.stream_write(&[0])
            .await
            .map_err(|e| MetadataExchangeError::IoError(format!("stream_write failed: {}", e)))?;
        conn.stream_write(&hs_encoded)
            .await
            .map_err(|e| MetadataExchangeError::IoError(format!("stream_write failed: {}", e)))?;
        conn.stream_flush()
            .await
            .map_err(|e| MetadataExchangeError::IoError(format!("stream_flush failed: {}", e)))?;

        debug!("Extension handshake sent to {}", peer_addr);

        let remote_hs_data = self.read_extension_message(&mut conn).await?;
        let remote_hs = ExtensionHandshake::parse(&remote_hs_data).ok_or_else(|| {
            MetadataExchangeError::BencodeDecodeFailed {
                detail: "Failed to parse remote extension handshake".to_string(),
            }
        })?;

        let metadata_size = match remote_hs.metadata_size {
            Some(size) => size,
            None => {
                warn!(
                    "Peer {} reported metadata_size=None, skipping...",
                    peer_addr
                );
                return Err(MetadataExchangeError::UnsupportedPeer {
                    addr: addr_str,
                    reason: "Remote did not provide metadata_size".to_string(),
                });
            }
        };

        if metadata_size == 0 {
            warn!("Peer {} reported metadata_size=0, skipping...", peer_addr);
            return Err(MetadataExchangeError::InvalidMetadataSize { size: 0 });
        }

        if metadata_size > METADATA_MAX_SIZE {
            return Err(MetadataExchangeError::MetadataTooLarge {
                size: metadata_size,
                max: METADATA_MAX_SIZE,
            });
        }

        debug!("Remote reports metadata_size={} bytes", metadata_size);

        let num_pieces = metadata_size.div_ceil(self.config.piece_size as u64) as u32;
        let mut collector = MetadataCollector::new(metadata_size, self.config.piece_size);

        // Track in-flight metadata requests with timeout (C++ UTMetadataRequestTracker)
        let mut tracker = UTMetadataRequestTracker::new();

        // Collect pieces, retrying timed-out pieces up to max_attempts times
        let mut retry_counts: std::collections::HashMap<u32, usize> =
            std::collections::HashMap::new();
        let mut pending_pieces: Vec<u32> = (0..num_pieces).collect();

        while !pending_pieces.is_empty() && !collector.is_complete() {
            // Check for timed-out requests and requeue them
            let timed_out = tracker.remove_timeout_entries();
            for idx in timed_out {
                let retries = retry_counts.entry(idx).or_insert(0);
                if *retries < self.config.max_attempts {
                    *retries += 1;
                    debug!(
                        piece = idx,
                        retry = *retries,
                        max = self.config.max_attempts,
                        "Retrying timed-out ut_metadata piece"
                    );
                    pending_pieces.push(idx);
                } else {
                    warn!(
                        piece = idx,
                        retries = *retries,
                        "ut_metadata piece exceeded max retries, giving up"
                    );
                    return Err(MetadataExchangeError::PieceTimeout { piece: idx });
                }
            }

            // Request next pending piece if tracker has capacity
            if tracker.avail() > 0 {
                let piece_idx = match pending_pieces.pop() {
                    Some(idx) => idx,
                    None => break,
                };

                // Skip already-collected pieces (could be from retries)
                if collector.is_complete() {
                    break;
                }

                let req_msg = UtMetadataMsg::Request(piece_idx);
                let encoded = req_msg.encode(20);

                conn.stream_write(&encoded).await.map_err(|e| {
                    MetadataExchangeError::IoError(format!("stream_write failed: {}", e))
                })?;
                conn.stream_flush().await.map_err(|e| {
                    MetadataExchangeError::IoError(format!("stream_flush failed: {}", e))
                })?;

                tracker.add(piece_idx);
            }

            // Wait for a response (with timeout)
            match timeout(
                self.config.request_timeout,
                self.read_ut_metadata_response(&mut conn),
            )
            .await
            {
                Ok(Ok(UtMetadataMsg::Data(recv_piece, data))) => {
                    tracker.remove(recv_piece);
                    collector.add_piece(recv_piece, &data);
                    debug!(
                        "Received piece {}/{} ({} bytes)",
                        recv_piece + 1,
                        num_pieces,
                        data.len()
                    );
                }
                Ok(Ok(UtMetadataMsg::Reject(piece))) => {
                    tracker.remove(piece);
                    debug!("Piece {} rejected by {}", piece, peer_addr);
                    // Requeue for retry
                    let retries = retry_counts.entry(piece).or_insert(0);
                    if *retries < self.config.max_attempts {
                        *retries += 1;
                        pending_pieces.push(piece);
                    } else {
                        return Err(MetadataExchangeError::PieceRejected { piece });
                    }
                }
                Ok(Ok(UtMetadataMsg::Request(_))) => {
                    // Peer is requesting metadata from us; ignore for now
                    // (we're in metadata fetch mode, not serving mode)
                    debug!("Ignoring unexpected ut_metadata Request from peer");
                }
                Ok(Err(inner_err)) => {
                    return Err(MetadataExchangeError::BencodeDecodeFailed {
                        detail: format!("ut_metadata decode error: {}", inner_err),
                    });
                }
                Err(_) => {
                    // The tracker will handle timeout detection on the next
                    // iteration via remove_timeout_entries()
                    debug!("Read timeout waiting for ut_metadata response");
                }
            }
        }

        collector.assemble().ok_or_else(|| {
            let received = (collector.progress() * metadata_size as f64) as u64;
            MetadataExchangeError::IncompleteMetadata {
                expected: metadata_size,
                received,
            }
        })
    }

    async fn read_extension_message(
        &self,
        conn: &mut PeerConnection,
    ) -> Result<BencodeValue, MetadataExchangeError> {
        let mut len_buf = [0u8; 4];
        conn.stream_read_exact(&mut len_buf).await.map_err(|e| {
            MetadataExchangeError::IoError(format!("Read message length failed: {}", e))
        })?;

        let msg_len = u32::from_be_bytes(len_buf) as usize;
        if msg_len == 0 || msg_len > 10 * 1024 * 1024 {
            return Err(MetadataExchangeError::BencodeDecodeFailed {
                detail: "Invalid extension message length".to_string(),
            });
        }

        let mut payload = vec![0u8; msg_len];
        conn.stream_read_exact(&mut payload).await.map_err(|e| {
            MetadataExchangeError::IoError(format!("Read message body failed: {}", e))
        })?;

        if payload.first().copied() != Some(20u8) {
            return Err(MetadataExchangeError::BencodeDecodeFailed {
                detail: "Expected extended message ID 20".to_string(),
            });
        }

        BencodeValue::decode(&payload[1..])
            .map(|(v, _)| v)
            .map_err(|e| MetadataExchangeError::BencodeDecodeFailed {
                detail: format!("Decode BEncode failed: {}", e),
            })
    }

    async fn read_ut_metadata_response(
        &self,
        conn: &mut PeerConnection,
    ) -> Result<UtMetadataMsg, MetadataExchangeError> {
        let mut len_buf = [0u8; 4];
        conn.stream_read_exact(&mut len_buf).await.map_err(|e| {
            MetadataExchangeError::IoError(format!("Read ut_metadata length failed: {}", e))
        })?;

        let msg_len = u32::from_be_bytes(len_buf) as usize;
        if msg_len == 0 || msg_len > 10 * 1024 * 1024 {
            return Err(MetadataExchangeError::BencodeDecodeFailed {
                detail: "Invalid ut_metadata message length".to_string(),
            });
        }

        let mut payload = vec![0u8; msg_len];
        conn.stream_read_exact(&mut payload).await.map_err(|e| {
            MetadataExchangeError::IoError(format!("Read ut_metadata body failed: {}", e))
        })?;

        UtMetadataMsg::decode(&payload).map_err(|e| MetadataExchangeError::BencodeDecodeFailed {
            detail: format!("ut_metadata decode failed: {}", e),
        })
    }
}

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

    #[test]
    fn test_config_default() {
        let cfg = MetadataExchangeConfig::default();
        assert_eq!(cfg.max_peers_to_try, 5);
        assert_eq!(cfg.piece_size, 16 * 1024);
        assert_eq!(cfg.max_attempts, DEFAULT_MAX_ATTEMPTS);
    }

    #[test]
    fn test_fetch_metadata_no_peers() {
        let session = MetadataExchangeSession::new(MetadataExchangeConfig::default());
        let target_hash = [0u8; 20];
        let peers: Vec<SocketAddr> = vec![];

        let rt = tokio::runtime::Runtime::new().unwrap();
        let result = rt.block_on(session.fetch_metadata(&target_hash, &peers));

        assert!(result.is_err());
        match result.unwrap_err() {
            MetadataExchangeError::NoPeersAvailable => {}
            other => panic!("Expected NoPeersAvailable, got {:?}", other),
        }
    }

    #[tokio::test]
    async fn test_read_extension_message_invalid_length_zero() {
        let session = MetadataExchangeSession::new(MetadataExchangeConfig::default());
        let _ = session;
    }

    #[test]
    fn test_error_enum_variant_count() {
        let _ = MetadataExchangeError::NoPeersAvailable;
        let _ = MetadataExchangeError::AllPeersFailed {
            attempts: 0,
            last_error: String::new(),
        };
        let _ = MetadataExchangeError::PeerConnectFailed {
            addr: String::new(),
            reason: String::new(),
        };
        let _ = MetadataExchangeError::PeerTimeout {
            addr: String::new(),
        };
        let _ = MetadataExchangeError::UnsupportedPeer {
            addr: String::new(),
            reason: String::new(),
        };
        let _ = MetadataExchangeError::InvalidMetadataSize { size: 0 };
        let _ = MetadataExchangeError::MetadataTooLarge { size: 0, max: 0 };
        let _ = MetadataExchangeError::BencodeDecodeFailed {
            detail: String::new(),
        };
        let _ = MetadataExchangeError::PieceRejected { piece: 0 };
        let _ = MetadataExchangeError::PieceTimeout { piece: 0 };
        let _ = MetadataExchangeError::IncompleteMetadata {
            expected: 0,
            received: 0,
        };
        let _ = MetadataExchangeError::IoError(String::new());
    }

    #[test]
    fn test_fatal_vs_recoverable_errors() {
        let fatal = MetadataExchangeError::MetadataTooLarge {
            size: 200_000_000,
            max: METADATA_MAX_SIZE,
        };
        assert!(fatal.is_fatal());

        let fatal2 = MetadataExchangeError::BencodeDecodeFailed {
            detail: "bad".to_string(),
        };
        assert!(fatal2.is_fatal());

        let recoverable = MetadataExchangeError::PeerTimeout {
            addr: "1.2.3.4:6881".to_string(),
        };
        assert!(!recoverable.is_fatal());

        let recoverable2 = MetadataExchangeError::InvalidMetadataSize { size: 0 };
        assert!(!recoverable2.is_fatal());
    }

    #[test]
    fn test_display_impl() {
        let err = MetadataExchangeError::NoPeersAvailable;
        assert!(err.to_string().contains("No peers"));

        let err = MetadataExchangeError::MetadataTooLarge {
            size: 200_000_000,
            max: METADATA_MAX_SIZE,
        };
        let display = err.to_string();
        assert!(display.contains("too large"));
        assert!(display.contains("200000000"));
    }

    #[test]
    fn test_with_piece_size_builder() {
        let cfg = MetadataExchangeConfig::default().with_piece_size(8192);
        assert_eq!(cfg.piece_size, 8192);

        let cfg_clamped_low = MetadataExchangeConfig::default().with_piece_size(512);
        assert_eq!(cfg_clamped_low.piece_size, PIECE_SIZE_MIN);

        let cfg_clamped_high = MetadataExchangeConfig::default().with_piece_size(128_000);
        assert_eq!(cfg_clamped_high.piece_size, PIECE_SIZE_MAX);
    }

    #[test]
    fn test_with_max_attempts_builder() {
        let cfg = MetadataExchangeConfig::default().with_max_attempts(5);
        assert_eq!(cfg.max_attempts, 5);

        let cfg_zero = MetadataExchangeConfig::default().with_max_attempts(0);
        assert_eq!(cfg_zero.max_attempts, 1);
    }
}