aria2-core 0.2.2

High-performance download engine core: multi-protocol segmented downloads, rate limiting, config management, 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
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
use std::path::{Path, PathBuf};

use serde::{Deserialize, Serialize};
use tracing::{debug, info};

use aria2_protocol::bittorrent::torrent::parser::InfoDict;

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TorrentFileEntry {
    pub index: usize,
    pub path: String,
    pub length: u64,
    pub completed_length: u64,
}

#[derive(Debug, Clone)]
pub struct FileInfo {
    pub path: Vec<String>,
    pub length: u64,
    pub start_piece: u32,
    pub end_piece: u32,
    pub start_offset_in_piece: u32,
    pub end_offset_in_piece: u32,
    pub absolute_path: PathBuf,
}

#[derive(Clone)]
pub struct MultiFileLayout {
    #[allow(dead_code)] // Base directory for multi-file torrent layouts
    base_dir: PathBuf,
    files: Vec<FileInfo>,
    piece_length: u32,
    total_pieces: u32,
    total_size: u64,
    is_single_file: bool,
}

impl MultiFileLayout {
    pub fn from_info_dict(info: &InfoDict, base_dir: &Path) -> Result<Self, String> {
        let piece_length = info.piece_length;
        let total_pieces = info.pieces.len() as u32;

        if let Some(length) = info.length {
            let name = &info.name;
            let absolute_path = base_dir.join(name);

            let total_size = length;

            let start_piece = 0u32;
            let end_piece = if total_size == 0 {
                0
            } else if total_pieces > 0 {
                total_pieces - 1
            } else {
                0
            };
            let start_offset_in_piece = 0u32;
            let end_offset_in_piece = if total_size == 0 {
                0
            } else {
                ((total_size - 1) % piece_length as u64 + 1) as u32
            };

            let file_info = FileInfo {
                path: vec![name.clone()],
                length,
                start_piece,
                end_piece,
                start_offset_in_piece,
                end_offset_in_piece,
                absolute_path,
            };

            info!(
                "Single-file layout: name={}, length={}, pieces={}",
                name, length, total_pieces
            );

            Ok(Self {
                base_dir: base_dir.to_path_buf(),
                files: vec![file_info],
                piece_length,
                total_pieces,
                total_size,
                is_single_file: true,
            })
        } else if let Some(ref files) = info.files {
            if files.is_empty() {
                return Err("files list is empty".to_string());
            }

            let mut file_infos = Vec::with_capacity(files.len());
            let mut running_offset: u64 = 0;
            let mut computed_total_size: u64 = 0;

            for (i, entry) in files.iter().enumerate() {
                let start_byte = running_offset;
                let end_byte = start_byte + entry.length;

                let pl = piece_length as u64;

                let start_piece = (start_byte / pl) as u32;
                let start_offset_in_piece = (start_byte % pl) as u32;

                let end_piece = if entry.length == 0 && start_byte == 0 || end_byte == 0 {
                    0
                } else {
                    ((end_byte - 1) / pl) as u32
                };
                let end_offset_in_piece = if entry.length == 0 {
                    0
                } else {
                    ((end_byte - 1) % pl + 1) as u32
                };

                // Build path using proper path separators
                let mut path_buf = base_dir.to_path_buf();
                for component in &entry.path {
                    path_buf.push(component);
                }
                let abs_path = path_buf;
                debug!(
                    "File[{}]: path={:?}, bytes=[{}..{}), pieces=[{}..{}] offsets=[{}..{})",
                    i,
                    entry.path,
                    start_byte,
                    end_byte,
                    start_piece,
                    end_piece,
                    start_offset_in_piece,
                    end_offset_in_piece
                );

                file_infos.push(FileInfo {
                    path: entry.path.clone(),
                    length: entry.length,
                    start_piece,
                    end_piece,
                    start_offset_in_piece,
                    end_offset_in_piece,
                    absolute_path: abs_path,
                });

                running_offset = end_byte;
                computed_total_size += entry.length;
            }

            info!(
                "Multi-file layout: {} files, total_size={}, pieces={}",
                file_infos.len(),
                computed_total_size,
                total_pieces
            );

            Ok(Self {
                base_dir: base_dir.to_path_buf(),
                files: file_infos,
                piece_length,
                total_pieces,
                total_size: computed_total_size,
                is_single_file: false,
            })
        } else {
            Err("InfoDict has neither length nor files field".to_string())
        }
    }

    pub fn create_directories(&self) -> Result<(), String> {
        for (i, file) in self.files.iter().enumerate() {
            if let Some(parent) = file.absolute_path.parent() {
                std::fs::create_dir_all(parent).map_err(|e| {
                    format!(
                        "Failed to create directory {:?} for file[{}] {:?}: {}",
                        parent, i, file.path, e
                    )
                })?;
                debug!("Created directory: {:?}", parent);
            }
        }
        Ok(())
    }

    pub fn resolve_file_offset(
        &self,
        piece_idx: u32,
        offset_in_piece: u32,
    ) -> Option<(usize, u64)> {
        let global_byte = piece_idx as u64 * self.piece_length as u64 + offset_in_piece as u64;

        if global_byte >= self.total_size {
            return None;
        }

        for (i, file) in self.files.iter().enumerate() {
            let file_start = file.start_piece as u64 * self.piece_length as u64
                + file.start_offset_in_piece as u64;
            let file_end = file_start + file.length;

            if global_byte >= file_start && global_byte < file_end {
                return Some((i, global_byte - file_start));
            }
        }

        None
    }

    pub fn file_absolute_path(&self, file_index: usize) -> Option<&Path> {
        self.files
            .get(file_index)
            .map(|f| f.absolute_path.as_path())
    }

    pub fn file_completed_bytes(&self, file_idx: usize, bitfield: &[u8]) -> u64 {
        let file = match self.files.get(file_idx) {
            Some(f) => f,
            None => return 0,
        };

        if file.length == 0 {
            return 0;
        }

        let pl = self.piece_length as u64;
        let mut completed: u64 = 0;

        for piece_idx in file.start_piece..=file.end_piece {
            let byte_index = piece_idx as usize / 8;
            let bit_index = 7 - (piece_idx as usize % 8);

            if byte_index >= bitfield.len() {
                break;
            }

            let is_complete = (bitfield[byte_index] >> bit_index) & 1 == 1;

            if !is_complete {
                continue;
            }

            if piece_idx == file.start_piece && piece_idx == file.end_piece {
                completed += file.length;
            } else if piece_idx == file.start_piece {
                let bytes_in_this_piece = pl - file.start_offset_in_piece as u64;
                completed += bytes_in_this_piece.min(file.length);
            } else if piece_idx == file.end_piece {
                completed += file.end_offset_in_piece as u64;
            } else {
                completed += pl;
            }
        }

        completed.min(file.length)
    }

    pub fn file_list(&self) -> Vec<TorrentFileEntry> {
        self.files
            .iter()
            .enumerate()
            .map(|(i, f)| TorrentFileEntry {
                index: i,
                path: f.path.join("/"),
                length: f.length,
                completed_length: 0,
            })
            .collect()
    }

    pub fn is_multi_file(&self) -> bool {
        !self.is_single_file
    }

    pub fn num_files(&self) -> usize {
        self.files.len()
    }

    pub fn total_size(&self) -> u64 {
        self.total_size
    }

    pub fn piece_length(&self) -> u32 {
        self.piece_length
    }

    pub fn total_pieces(&self) -> u32 {
        self.total_pieces
    }

    pub fn get_file_info(&self, index: usize) -> Option<&FileInfo> {
        self.files.get(index)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use aria2_protocol::bittorrent::torrent::parser::FileEntry;

    fn make_single_file_info_dict() -> InfoDict {
        InfoDict {
            name: "single_file.bin".to_string(),
            piece_length: 512,
            pieces: vec![[0u8; 20], [1u8; 20]],
            length: Some(1024),
            files: None,
            private: None,
        }
    }

    fn make_multi_file_info_dict() -> InfoDict {
        InfoDict {
            name: "multi_dir".to_string(),
            piece_length: 512,
            pieces: vec![[0u8; 20], [1u8; 20], [2u8; 20]],
            length: None,
            files: Some(vec![
                FileEntry {
                    length: 500,
                    path: vec!["dir1".to_string(), "file1.txt".to_string()],
                },
                FileEntry {
                    length: 524,
                    path: vec!["dir2".to_string(), "file2.dat".to_string()],
                },
                FileEntry {
                    length: 300,
                    path: vec!["dir3".to_string(), "file3.log".to_string()],
                },
            ]),
            private: None,
        }
    }

    #[test]
    fn test_from_info_dict_single_file() {
        let info = make_single_file_info_dict();
        let base = Path::new("/tmp/download");
        let layout = MultiFileLayout::from_info_dict(&info, base).unwrap();

        assert_eq!(layout.num_files(), 1);
        assert!(!layout.is_multi_file());
        assert_eq!(layout.total_size(), 1024);
        assert_eq!(layout.piece_length(), 512);
        assert_eq!(layout.total_pieces(), 2);

        let file = layout.get_file_info(0).unwrap();
        assert_eq!(file.path, vec!["single_file.bin"]);
        assert_eq!(file.length, 1024);
        assert_eq!(file.start_piece, 0);
        assert_eq!(file.end_piece, 1);
        assert_eq!(file.start_offset_in_piece, 0);
        assert_eq!(file.end_offset_in_piece, 512);
    }

    #[test]
    fn test_from_info_dict_multi_file() {
        let info = make_multi_file_info_dict();
        let base = Path::new("/tmp/download");
        let layout = MultiFileLayout::from_info_dict(&info, base).unwrap();

        assert_eq!(layout.num_files(), 3);
        assert!(layout.is_multi_file());
        assert_eq!(layout.total_size(), 1324);

        let f0 = layout.get_file_info(0).unwrap();
        assert_eq!(f0.length, 500);
        assert_eq!(f0.start_piece, 0);
        assert_eq!(f0.end_piece, 0);
        assert_eq!(f0.start_offset_in_piece, 0);
        assert_eq!(f0.end_offset_in_piece, 500);

        let f1 = layout.get_file_info(1).unwrap();
        assert_eq!(f1.length, 524);
        assert_eq!(f1.start_piece, 0);
        assert_eq!(f1.end_piece, 1);
        assert_eq!(f1.start_offset_in_piece, 500);
        assert_eq!(f1.end_offset_in_piece, 512);

        let f2 = layout.get_file_info(2).unwrap();
        assert_eq!(f2.length, 300);
        assert_eq!(f2.start_piece, 2);
        assert_eq!(f2.end_piece, 2);
        assert_eq!(f2.start_offset_in_piece, 0);
        assert_eq!(f2.end_offset_in_piece, 300);
    }

    #[test]
    fn test_from_info_dict_empty_files() {
        let info = InfoDict {
            name: "empty".to_string(),
            piece_length: 512,
            pieces: vec![],
            length: None,
            files: Some(vec![]),
            private: None,
        };
        let base = Path::new("/tmp/download");
        let result = MultiFileLayout::from_info_dict(&info, base);
        assert!(result.is_err());
    }

    #[test]
    fn test_create_directories() {
        let info = make_multi_file_info_dict();
        let temp_dir = tempfile::tempdir().unwrap();
        let base = temp_dir.path();
        let layout = MultiFileLayout::from_info_dict(&info, base).unwrap();

        let result = layout.create_directories();
        assert!(result.is_ok());

        let dir1 = base.join("dir1");
        let dir2 = base.join("dir2");
        let dir3 = base.join("dir3");

        assert!(dir1.exists());
        assert!(dir2.exists());
        assert!(dir3.exists());

        // temp_dir is automatically cleaned up when dropped
    }

    #[test]
    fn test_resolve_file_offset_single_file() {
        let info = make_single_file_info_dict();
        let base = Path::new("/tmp/download");
        let layout = MultiFileLayout::from_info_dict(&info, base).unwrap();

        let result = layout.resolve_file_offset(0, 0);
        assert_eq!(result, Some((0, 0)));

        let result = layout.resolve_file_offset(0, 256);
        assert_eq!(result, Some((0, 256)));

        let result = layout.resolve_file_offset(1, 0);
        assert_eq!(result, Some((0, 512)));

        let result = layout.resolve_file_offset(1, 511);
        assert_eq!(result, Some((0, 1023)));
    }

    #[test]
    fn test_resolve_file_offset_multi_file() {
        let info = make_multi_file_info_dict();
        let base = Path::new("/tmp/download");
        let layout = MultiFileLayout::from_info_dict(&info, base).unwrap();

        let result = layout.resolve_file_offset(0, 0);
        assert_eq!(result, Some((0, 0)));

        let result = layout.resolve_file_offset(0, 499);
        assert_eq!(result, Some((0, 499)));

        let result = layout.resolve_file_offset(0, 500);
        assert_eq!(result, Some((1, 0)));

        let result = layout.resolve_file_offset(1, 0);
        assert_eq!(result, Some((1, 12)));

        let result = layout.resolve_file_offset(1, 200);
        assert_eq!(result, Some((1, 212)));

        let result = layout.resolve_file_offset(2, 50);
        assert_eq!(result, Some((2, 50)));
    }

    #[test]
    fn test_resolve_file_offset_boundary() {
        let info = make_multi_file_info_dict();
        let base = Path::new("/tmp/download");
        let layout = MultiFileLayout::from_info_dict(&info, base).unwrap();

        let result = layout.resolve_file_offset(0, 499);
        assert_eq!(result, Some((0, 499)));

        let result = layout.resolve_file_offset(0, 500);
        assert_eq!(result, Some((1, 0)));

        let result = layout.resolve_file_offset(1, 511);
        assert_eq!(result, Some((1, 523)));

        let result = layout.resolve_file_offset(2, 0);
        assert_eq!(result, Some((2, 0)));
    }

    #[test]
    fn test_resolve_file_offset_out_of_range() {
        let info = make_single_file_info_dict();
        let base = Path::new("/tmp/download");
        let layout = MultiFileLayout::from_info_dict(&info, base).unwrap();

        let result = layout.resolve_file_offset(1, 512);
        assert_eq!(result, None);

        let result = layout.resolve_file_offset(2, 0);
        assert_eq!(result, None);

        let result = layout.resolve_file_offset(u32::MAX, 0);
        assert_eq!(result, None);
    }

    #[test]
    fn test_file_completed_bytes() {
        let info = make_single_file_info_dict();
        let base = Path::new("/tmp/download");
        let layout = MultiFileLayout::from_info_dict(&info, base).unwrap();

        let no_pieces = [0u8; 1];
        assert_eq!(layout.file_completed_bytes(0, &no_pieces), 0);

        let piece0_only = [0b10000000u8];
        assert_eq!(layout.file_completed_bytes(0, &piece0_only), 512);

        let both_pieces = [0b11000000u8];
        assert_eq!(layout.file_completed_bytes(0, &both_pieces), 1024);
    }

    #[test]
    fn test_file_list_returns_correct_entries() {
        let info = make_multi_file_info_dict();
        let base = Path::new("/tmp/download");
        let layout = MultiFileLayout::from_info_dict(&info, base).unwrap();

        let list = layout.file_list();
        assert_eq!(list.len(), 3);

        assert_eq!(list[0].index, 0);
        assert_eq!(list[0].path, "dir1/file1.txt");
        assert_eq!(list[0].length, 500);
        assert_eq!(list[0].completed_length, 0);

        assert_eq!(list[1].index, 1);
        assert_eq!(list[1].path, "dir2/file2.dat");
        assert_eq!(list[1].length, 524);

        assert_eq!(list[2].index, 2);
        assert_eq!(list[2].path, "dir3/file3.log");
        assert_eq!(list[2].length, 300);
    }

    #[test]
    fn test_is_multi_file_flags() {
        let single = make_single_file_info_dict();
        let single_layout = MultiFileLayout::from_info_dict(&single, Path::new("/tmp")).unwrap();
        assert!(!single_layout.is_multi_file());

        let multi = make_multi_file_info_dict();
        let multi_layout = MultiFileLayout::from_info_dict(&multi, Path::new("/tmp")).unwrap();
        assert!(multi_layout.is_multi_file());
    }

    #[test]
    fn test_total_size_matches() {
        let single = make_single_file_info_dict();
        let single_layout = MultiFileLayout::from_info_dict(&single, Path::new("/tmp")).unwrap();
        assert_eq!(single_layout.total_size(), 1024);

        let multi = make_multi_file_info_dict();
        let multi_layout = MultiFileLayout::from_info_dict(&multi, Path::new("/tmp")).unwrap();
        assert_eq!(multi_layout.total_size(), 1324);
        assert_eq!(multi_layout.total_size(), 500 + 524 + 300);
    }

    #[test]
    fn test_file_absolute_path() {
        let info = make_multi_file_info_dict();
        let base = Path::new("/base/dir");
        let layout = MultiFileLayout::from_info_dict(&info, base).unwrap();

        let p0 = layout.file_absolute_path(0).unwrap();
        assert_eq!(p0, Path::new("/base/dir/dir1/file1.txt"));

        let p1 = layout.file_absolute_path(1).unwrap();
        assert_eq!(p1, Path::new("/base/dir/dir2/file2.dat"));

        let p2 = layout.file_absolute_path(2).unwrap();
        assert_eq!(p2, Path::new("/base/dir/dir3/file3.log"));

        assert!(layout.file_absolute_path(3).is_none());
    }

    #[test]
    fn test_file_completed_bytes_multi_file_partial() {
        let info = make_multi_file_info_dict();
        let base = Path::new("/tmp/download");
        let layout = MultiFileLayout::from_info_dict(&info, base).unwrap();

        let only_piece0 = [0b10000000u8];
        assert_eq!(layout.file_completed_bytes(0, &only_piece0), 500);
        assert_eq!(layout.file_completed_bytes(1, &only_piece0), 12);
        assert_eq!(layout.file_completed_bytes(2, &only_piece0), 0);

        let piece0_and_1 = [0b11000000u8];
        assert_eq!(layout.file_completed_bytes(0, &piece0_and_1), 500);
        assert_eq!(layout.file_completed_bytes(1, &piece0_and_1), 524);
        assert_eq!(layout.file_completed_bytes(2, &piece0_and_1), 0);

        let all_pieces = [0b11100000u8];
        assert_eq!(layout.file_completed_bytes(0, &all_pieces), 500);
        assert_eq!(layout.file_completed_bytes(1, &all_pieces), 524);
        assert_eq!(layout.file_completed_bytes(2, &all_pieces), 300);
    }
}