aria2-core 0.3.0

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
587
588
589
590
591
592
//! BitTorrent category options: seeding, DHT, PEX, peers, encryption, uTP.

use crate::config::{OptionCategory, OptionDef, OptionType, OptionValue};

impl crate::config::OptionRegistry {
    /// Register BitTorrent-specific options: seeding, DHT, PEX, peer management.
    pub fn register_bt_options(&mut self) {
        // --- Seeding Settings ---
        self.register(OptionDef {
            name: "seed-time".into(),
            opt_type: OptionType::Float,
            short_name: Some('G'),
            // aria2_original uses NO_DEFAULT_VALUE here. A configured zero
            // must remain distinguishable from an omitted option because it
            // explicitly disables the seed-time criterion.
            default_value: OptionValue::None,
            description: "Seeding time in minutes (0=infinite)".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "seed-ratio".into(),
            opt_type: OptionType::Float,
            short_name: Some('g'),
            default_value: OptionValue::Float(1.0),
            description: "Share ratio threshold".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });

        // --- Peer Management ---
        self.register(OptionDef {
            name: "bt-max-peers".into(),
            opt_type: OptionType::Integer,
            short_name: Some('B'),
            default_value: OptionValue::Int(55),
            min: Some(0),
            description: "Max peers per torrent".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "bt-request-peer-speed-limit".into(),
            opt_type: OptionType::Size,
            default_value: OptionValue::Int((50 * 1024) as i64),
            description: "Min peer speed to stay connected".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "bt-max-open-files".into(),
            opt_type: OptionType::Integer,
            default_value: OptionValue::Int(100),
            min: Some(1),
            description: "Max open files for BT".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        // --- Torrent Behavior ---
        self.register(OptionDef {
            name: "bt-seed-unverified".into(),
            opt_type: OptionType::Boolean,
            default_value: OptionValue::Bool(false),
            description: "Seed without verifying hash".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "bt-save-metadata".into(),
            opt_type: OptionType::Boolean,
            default_value: OptionValue::Bool(false),
            description: "Save metadata as .torrent file".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });

        // --- Encryption ---
        self.register(OptionDef {
            name: "bt-force-encryption".into(),
            opt_type: OptionType::Boolean,
            short_name: Some('X'),
            default_value: OptionValue::Bool(false),
            description: "Force BT encryption".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "bt-min-crypto-level".into(),
            opt_type: OptionType::Enum,
            default_value: OptionValue::Str("plain".into()),
            allowed_values: &["plain", "arc4"],
            description: "Min crypto level (plain/arc4)".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });

        // --- DHT / LPD / PEX ---
        self.register(OptionDef {
            name: "bt-enable-lpd".into(),
            opt_type: OptionType::Boolean,
            default_value: OptionValue::Bool(false),
            description: "Enable Local Peer Discovery".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "enable-lpd".into(),
            opt_type: OptionType::Boolean,
            default_value: OptionValue::Bool(false),
            description: "Enable Local Peer Discovery (alias for bt-enable-lpd)".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "lpd-listen-port".into(),
            opt_type: OptionType::Integer,
            default_value: OptionValue::Int(6771),
            min: Some(1024),
            max: Some(65535),
            description: "UDP port for Local Peer Discovery".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "bt-enable-web-seed".into(),
            opt_type: OptionType::Boolean,
            default_value: OptionValue::Bool(true),
            description: "Enable web seed (HTTP/FTP seeding)".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "enable-dht".into(),
            opt_type: OptionType::Boolean,
            default_value: OptionValue::Bool(true),
            description: "Enable DHT".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "dht-listen-port".into(),
            opt_type: OptionType::IntegerRange,
            default_value: OptionValue::Str("6881-6999".into()),
            min: Some(1024),
            max: Some(65535),
            description: "DHT listen port".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "dht-entry-point".into(),
            opt_type: OptionType::List,
            description: "DHT bootstrap nodes (host:port format, comma-separated)".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "dht-file-path".into(),
            opt_type: OptionType::Path,
            description: "Path to DHT routing table file for persistence".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "dht-message-path".into(),
            opt_type: OptionType::Path,
            description: "DHT message cache path (deprecated, use dht-file-path instead)".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "enable-peer-exchange".into(),
            opt_type: OptionType::Boolean,
            default_value: OptionValue::Bool(true),
            description: "Enable PEX".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });

        // --- Torrent Handling ---
        self.register(OptionDef {
            name: "follow-torrent".into(),
            opt_type: OptionType::Enum,
            default_value: OptionValue::Str("true".into()),
            allowed_values: &["true", "false", "mem"],
            description: "Auto-handle .torrent (true/false/mem)".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });

        // --- Event Hooks ---
        self.register(OptionDef {
            name: "on-bt-download-complete".into(),
            opt_type: OptionType::String,
            description: "Command on BT download complete".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "on-bt-download-error".into(),
            opt_type: OptionType::String,
            description: "Command on BT download error".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });

        // --- Listening Port ---
        self.register(OptionDef {
            name: "listen-port".into(),
            opt_type: OptionType::IntegerRange,
            short_name: Some('L'),
            default_value: OptionValue::Str("6881-6999".into()),
            min: Some(1024),
            max: Some(65535),
            description: "Listening port range".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });

        // --- Piece Selection Priority (G2) ---
        self.register(OptionDef {
            name: "bt-prioritize-piece".into(),
            opt_type: OptionType::PiecePriority,
            description:
                "Prioritize pieces at the head or tail of each file (head[=SIZE],tail[=SIZE])"
                    .into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });

        // --- BT Additional Options ---
        self.register(OptionDef {
            name: "bt-detach-seed-only".into(),
            opt_type: OptionType::Boolean,
            default_value: OptionValue::Bool(false),
            description: "Detach seed-only downloads from main session".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "bt-enable-hook-after-hash-check".into(),
            opt_type: OptionType::Boolean,
            default_value: OptionValue::Bool(true),
            description: "Run hook after hash check (--on-bt-download-complete/error)".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "bt-exclude-tracker".into(),
            opt_type: OptionType::List,
            description: "Comma-separated list of tracker announce URIs to exclude".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "bt-external-ip".into(),
            opt_type: OptionType::String,
            description: "External IP address for BitTorrent".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "bt-hash-check-seed".into(),
            opt_type: OptionType::Boolean,
            default_value: OptionValue::Bool(true),
            description: "Seed after hash check when --check-integrity is used".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "bt-load-saved-metadata".into(),
            opt_type: OptionType::Boolean,
            default_value: OptionValue::Bool(false),
            description: "Load saved metadata from previous session".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "bt-lpd-interface".into(),
            opt_type: OptionType::String,
            description: "Network interface for Local Peer Discovery".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "bt-metadata-only".into(),
            opt_type: OptionType::Boolean,
            default_value: OptionValue::Bool(false),
            description: "Download only torrent metadata".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "bt-remove-unselected-file".into(),
            opt_type: OptionType::Boolean,
            default_value: OptionValue::Bool(false),
            description: "Remove unselected files when --select-file is used".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "bt-require-crypto".into(),
            opt_type: OptionType::Boolean,
            default_value: OptionValue::Bool(false),
            description: "Require BitTorrent message encryption".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "bt-stop-timeout".into(),
            opt_type: OptionType::Integer,
            default_value: OptionValue::Int(0),
            min: Some(0),
            description: "Stop BT download after N seconds without progress (0=disabled)".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "bt-tracker".into(),
            opt_type: OptionType::List,
            description: "Comma-separated list of tracker announce URIs".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "bt-tracker-source".into(),
            opt_type: OptionType::List,
            default_value: OptionValue::List(vec![
                aria2_protocol::bittorrent::tracker::public_list::DEFAULT_TRACKER_SOURCE
                    .to_string(),
            ]),
            cumulative_delimiter: Some("\n"),
            description: "Remote public tracker list sources".into(),
            category: OptionCategory::BitTorrent,
            // Rust-only extension. Keep it out of the original
            // getGlobalOption/getOption projections while retaining the
            // explicit extension option for local configuration and RPC.
            expose_in_aria2_rpc: false,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "bt-tracker-update-interval".into(),
            opt_type: OptionType::Integer,
            default_value: OptionValue::Int(86_400),
            min: Some(1),
            description: "Public tracker list refresh interval in seconds".into(),
            category: OptionCategory::BitTorrent,
            expose_in_aria2_rpc: false,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "enable-public-trackers".into(),
            opt_type: OptionType::Boolean,
            default_value: OptionValue::Bool(true),
            description: "Use public trackers in addition to torrent trackers".into(),
            category: OptionCategory::BitTorrent,
            expose_in_aria2_rpc: false,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "bt-tracker-connect-timeout".into(),
            opt_type: OptionType::Integer,
            default_value: OptionValue::Int(60),
            min: Some(1),
            max: Some(600),
            description: "Connect timeout for tracker in seconds".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "bt-tracker-interval".into(),
            opt_type: OptionType::Integer,
            default_value: OptionValue::Int(0),
            min: Some(0),
            description: "Tracker announce interval in seconds (0=use tracker's value)".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "bt-tracker-timeout".into(),
            opt_type: OptionType::Integer,
            default_value: OptionValue::Int(60),
            min: Some(1),
            max: Some(600),
            description: "Timeout for tracker in seconds".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "dht-message-timeout".into(),
            opt_type: OptionType::Integer,
            default_value: OptionValue::Int(10),
            min: Some(1),
            max: Some(60),
            description: "DHT message timeout in seconds".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "enable-dht6".into(),
            opt_type: OptionType::Boolean,
            default_value: OptionValue::Bool(false),
            description: "Enable IPv6 DHT".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "dht-listen-addr6".into(),
            opt_type: OptionType::String,
            description: "IPv6 address for DHT to listen on".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "peer-id-prefix".into(),
            opt_type: OptionType::String,
            default_value: OptionValue::Str(
                aria2_protocol::identity::DEFAULT_PEER_ID_PREFIX.into(),
            ),
            description: "Peer ID prefix for BitTorrent".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "peer-agent".into(),
            opt_type: OptionType::String,
            default_value: OptionValue::Str(aria2_protocol::identity::DEFAULT_PEER_AGENT.into()),
            description: "Peer agent string for BitTorrent".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "select-file".into(),
            opt_type: OptionType::IntegerRange,
            min: Some(1),
            max: Some(1_000_000),
            description:
                "Comma-separated list of file indices to download (BT/Metalink, 1-indexed)".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });

        // --- File Index Output Mapping ---
        self.register(OptionDef {
            name: "index-out".into(),
            opt_type: OptionType::IndexOut,
            short_name: Some('O'),
            cumulative_delimiter: Some("\n"),
            description: "Set output filename for BT file index (INDEX=PATH format)".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });

        // --- Peer Blocklist (aria2-next) ---
        self.register(OptionDef {
            name: "bt-peer-blocklist".into(),
            opt_type: OptionType::Path,
            description: "Path to BT peer blocklist file (one IP/CIDR range per line)".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });

        // --- uTP (UDP Transport Protocol - BEP 29) ---
        // Note: uTP is not implemented in the original C++ aria2. This is an experimental
        // feature in aria2-rust that implements BEP 29 (http://www.bittorrent.org/beps/bep_0029.html).
        // uTP provides congestion control over UDP, making BitTorrent friendlier to network traffic.
        self.register(OptionDef {
            name: "enable-utp".into(),
            opt_type: OptionType::Boolean,
            default_value: OptionValue::Bool(false),
            description: "Enable uTP (UDP Transport Protocol, BEP 29). Experimental feature not in original aria2. Default: false".into(),
            category: OptionCategory::BitTorrent,
            expose_in_aria2_rpc: false,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "utp-listen-port".into(),
            opt_type: OptionType::Integer,
            default_value: OptionValue::Int(0),
            min: Some(0),
            max: Some(65535),
            description: "UDP port for uTP connections. 0 = auto-assign. Experimental feature not in original aria2".into(),
            category: OptionCategory::BitTorrent,
            expose_in_aria2_rpc: false,
            ..Default::default()
        });

        // --- BT Timeouts (Internal) ---
        self.register(OptionDef {
            name: "bt-keep-alive-interval".into(),
            opt_type: OptionType::Integer,
            default_value: OptionValue::Int(120),
            min: Some(1),
            max: Some(120),
            description: "BT keep-alive interval in seconds".into(),
            category: OptionCategory::BitTorrent,
            hidden: true,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "bt-timeout".into(),
            opt_type: OptionType::Integer,
            default_value: OptionValue::Int(180),
            min: Some(1),
            max: Some(600),
            description: "BT overall timeout in seconds".into(),
            category: OptionCategory::BitTorrent,
            hidden: true,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "bt-request-timeout".into(),
            opt_type: OptionType::Integer,
            default_value: OptionValue::Int(60),
            min: Some(1),
            max: Some(600),
            description: "BT piece request timeout in seconds".into(),
            category: OptionCategory::BitTorrent,
            hidden: true,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "peer-connection-timeout".into(),
            opt_type: OptionType::Integer,
            default_value: OptionValue::Int(20),
            min: Some(1),
            max: Some(600),
            description: "Peer connection timeout in seconds".into(),
            category: OptionCategory::BitTorrent,
            hidden: true,
            ..Default::default()
        });

        // --- DHT Entry Points (Fine-Grained) ---
        self.register(OptionDef {
            name: "dht-entry-point-host".into(),
            opt_type: OptionType::String,
            description: "DHT bootstrap node hostname (IPv4)".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "dht-entry-point-port".into(),
            opt_type: OptionType::Integer,
            default_value: OptionValue::Int(0),
            min: Some(0),
            max: Some(65535),
            description: "DHT bootstrap node port (IPv4)".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "dht-entry-point6".into(),
            opt_type: OptionType::String,
            description: "IPv6 DHT bootstrap node (hostname:port)".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "dht-entry-point-host6".into(),
            opt_type: OptionType::String,
            description: "IPv6 DHT bootstrap node hostname".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "dht-entry-point-port6".into(),
            opt_type: OptionType::Integer,
            default_value: OptionValue::Int(0),
            min: Some(0),
            max: Some(65535),
            description: "IPv6 DHT bootstrap node port".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "dht-file-path6".into(),
            opt_type: OptionType::Path,
            description: "Path to IPv6 DHT routing table file".into(),
            category: OptionCategory::BitTorrent,
            ..Default::default()
        });
        self.register(OptionDef {
            name: "dht-listen-addr".into(),
            opt_type: OptionType::String,
            description: "IPv4 DHT listen address".into(),
            category: OptionCategory::BitTorrent,
            hidden: true,
            ..Default::default()
        });
    }
}