syncweb-core 0.1.1-alpha.4

delay-tolerant web surfing
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
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
use std::collections::HashMap;

use rand::seq::SliceRandom;

use crate::parsing::{parse_depth_constraints, parse_size_constraint};

/// Ranking strategy for synchronized entries.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub enum SortCriterion {
    Niche,
    Frecency,
    Peers,
    Random,
    FolderAggregate,
    // NEW:
    Time,
    Date,
    Week,
    Month,
    Year,
    Size,
    FolderSize,
    FolderAvgSize,
    FolderDate,
    FolderTime,
    Count,
}

impl SortCriterion {
    /// Parse a criterion from a string.
    ///
    /// # Errors
    ///
    /// Returns an error if the string is not a valid criterion.
    pub fn parse_str(s: &str) -> Result<Self, String> {
        match s.to_ascii_lowercase().as_str() {
            "niche" => Ok(Self::Niche),
            "frecency" => Ok(Self::Frecency),
            "peers" | "seeds" | "copies" => Ok(Self::Peers),
            "random" => Ok(Self::Random),
            "folder" | "folderaggregate" => Ok(Self::FolderAggregate),
            "time" => Ok(Self::Time),
            "date" | "day" => Ok(Self::Date),
            "week" => Ok(Self::Week),
            "month" => Ok(Self::Month),
            "year" => Ok(Self::Year),
            "size" => Ok(Self::Size),
            "folder-size" | "foldersize" => Ok(Self::FolderSize),
            "folder-avg-size" | "folder-size-avg" | "foldersize-avg" => Ok(Self::FolderAvgSize),
            "folder-date" | "folderdate" => Ok(Self::FolderDate),
            "folder-time" | "foldertime" => Ok(Self::FolderTime),
            "count" | "file-count" => Ok(Self::Count),
            _ => Err(format!("unsupported sort criterion: {s:?}")),
        }
    }
}

/// Configuration for the sorter.
#[derive(Clone, Debug)]
#[non_exhaustive]
pub struct SortConfig {
    pub criteria: Vec<(SortCriterion, bool)>, // (criterion, descending)
    pub niche: usize,
    pub frecency_weight: u64,
    pub min_seeders: Option<usize>,
    pub max_seeders: Option<usize>,
    pub limit_size: Option<u64>,
    pub min_depth: Option<usize>,
    pub max_depth: Option<usize>,
    pub enrich: bool,
}

impl Default for SortConfig {
    fn default() -> Self {
        Self {
            criteria: vec![(SortCriterion::Niche, true), (SortCriterion::Frecency, true)],
            niche: 3,
            frecency_weight: 3,
            min_seeders: None,
            max_seeders: None,
            limit_size: None,
            min_depth: None,
            max_depth: None,
            enrich: false,
        }
    }
}

impl SortConfig {
    /// Parse sort criteria from strings like "-niche", "-frecency", "time".
    #[must_use]
    pub fn parse_criteria(criteria: &[String]) -> Vec<(SortCriterion, bool)> {
        criteria
            .iter()
            .filter_map(|s| {
                let (descending, name) = s.strip_prefix('-').map_or((false, s.as_str()), |rest| (true, rest));
                SortCriterion::parse_str(name)
                    .ok()
                    .map(|criterion| (criterion, descending))
            })
            .collect()
    }

    /// Parse limit size from a string.
    ///
    /// # Errors
    ///
    /// Returns an error if the string cannot be parsed.
    pub fn parse_limit_size(s: &str) -> Result<u64, crate::error::SyncwebError> {
        let (min, _max) = parse_size_constraint(s)?;
        min.ok_or_else(|| crate::error::SyncwebError::InvalidConfig(format!("invalid limit size: {s:?}")))
    }
}

/// Metadata consumed by [`Sorter`].
#[derive(Clone, Debug, PartialEq)]
#[non_exhaustive]
pub struct SortEntry {
    pub path: std::path::PathBuf,
    pub folder: String,
    pub niche: f64,
    pub frequency: u64,
    pub peers: usize,
    pub modified: std::time::SystemTime,
    pub size: u64,
}

impl SortEntry {
    #[must_use]
    pub fn new(path: impl Into<std::path::PathBuf>) -> Self {
        Self {
            path: path.into(),
            folder: String::new(),
            niche: 0.0,
            frequency: 0,
            peers: 0,
            modified: std::time::SystemTime::UNIX_EPOCH,
            size: 0,
        }
    }

    #[must_use]
    pub fn with_folder(mut self, folder: impl Into<String>) -> Self {
        self.folder = folder.into();
        self
    }

    #[must_use]
    pub const fn with_niche(mut self, niche: f64) -> Self {
        self.niche = niche;
        self
    }

    #[must_use]
    pub const fn with_frequency(mut self, frequency: u64) -> Self {
        self.frequency = frequency;
        self
    }

    #[must_use]
    pub const fn with_peers(mut self, peers: usize) -> Self {
        self.peers = peers;
        self
    }

    #[must_use]
    pub const fn with_modified(mut self, modified: std::time::SystemTime) -> Self {
        self.modified = modified;
        self
    }

    #[must_use]
    pub const fn with_size(mut self, size: u64) -> Self {
        self.size = size;
        self
    }
}

/// Folder aggregates computed from entries.
#[derive(Clone, Copy, Debug)]
#[non_exhaustive]
pub struct FolderAggregate {
    pub modified_median: std::time::SystemTime,
    pub size_median: u64,
    pub size_sum: u64,
    pub file_count: usize,
}

impl Default for FolderAggregate {
    fn default() -> Self {
        Self {
            modified_median: std::time::SystemTime::UNIX_EPOCH,
            size_median: 0,
            size_sum: 0,
            file_count: 0,
        }
    }
}

/// Compute folder aggregates for sorting.
#[must_use]
pub fn aggregate_folders(
    entries: &[SortEntry],
    depth_list: &[String],
    min_depth: usize,
    max_depth: Option<usize>,
) -> HashMap<String, FolderAggregate> {
    let (effective_min, effective_max) = parse_depth_constraints(depth_list, min_depth, max_depth);

    let mut grouped: HashMap<String, Vec<&SortEntry>> = HashMap::new();
    for entry in entries {
        let path = entry.path.to_string_lossy();
        let parts: Vec<&str> = path.split('/').filter(|s| !s.is_empty()).collect();
        let folder_parts = if parts.len() > 1 {
            parts.get(..parts.len().saturating_sub(1)).unwrap_or(&[])
        } else {
            &[]
        };

        if effective_min == 0 && effective_max.is_none() {
            // Default: immediate parent folder
            let parent = if folder_parts.is_empty() {
                String::new()
            } else {
                folder_parts.join("/")
            };
            grouped.entry(parent).or_default().push(entry);
        } else {
            // Multi-level aggregation based on depth constraints
            let root = if path.starts_with('/') { "/" } else { "" };
            for depth in effective_min..=effective_max.unwrap_or(folder_parts.len()) {
                if depth <= folder_parts.len() {
                    let folder = if depth == 0 {
                        root.to_string()
                    } else {
                        format!("{root}{}", folder_parts.get(..depth).unwrap_or(&[]).join("/"))
                    };
                    grouped.entry(folder).or_default().push(entry);
                }
            }
        }
    }

    let mut aggregates = HashMap::new();
    for (folder, folder_entries) in grouped {
        let mut modified_times: Vec<_> = folder_entries.iter().map(|e| e.modified).collect();
        modified_times.sort();

        let mut sizes: Vec<u64> = folder_entries.iter().map(|e| e.size).collect();
        sizes.sort_unstable();

        let size_sum: u64 = sizes.iter().sum();
        let file_count = folder_entries.len();

        let modified_median = modified_times
            .get(modified_times.len().checked_div(2).unwrap_or(0))
            .copied()
            .unwrap_or(std::time::SystemTime::UNIX_EPOCH);

        let size_median = sizes.get(sizes.len().checked_div(2).unwrap_or(0)).copied().unwrap_or(0);

        aggregates.insert(
            folder,
            FolderAggregate {
                modified_median,
                size_median,
                size_sum,
                file_count,
            },
        );
    }

    aggregates
}

/// Sort entries using one of the supported content discovery rankings.
#[derive(Clone, Debug)]
pub struct Sorter {
    config: SortConfig,
}

impl Sorter {
    #[must_use]
    pub const fn new(config: SortConfig) -> Self {
        Self { config }
    }

    /// Filter entries by seeders before sorting.
    #[must_use]
    pub fn filter_seeders(&self, entries: Vec<SortEntry>) -> Vec<SortEntry> {
        entries
            .into_iter()
            .filter(|entry| {
                if let Some(min) = self.config.min_seeders
                    && entry.peers < min
                {
                    return false;
                }
                if let Some(max) = self.config.max_seeders
                    && entry.peers > max
                {
                    return false;
                }
                true
            })
            .collect()
    }

    /// Populate `entry.peers` from a path→count map.
    pub fn enrich_peers(&self, entries: &mut [SortEntry], peer_map: &HashMap<String, usize>) {
        for entry in entries.iter_mut() {
            if let Some(count) = peer_map.get(&entry.path.to_string_lossy().to_string()) {
                entry.peers = *count;
            }
        }
    }

    /// Compute `entry.niche` from `entry.peers` using `config.niche` as ideal count.
    /// Formula: `1.0 / (1.0 + |peers - ideal|)`
    pub fn enrich_niche(&self, entries: &mut [SortEntry]) {
        let ideal = self.config.niche;
        for entry in entries.iter_mut() {
            let distance = entry.peers.abs_diff(ideal);
            let dist_u32 = u32::try_from(distance).unwrap_or(u32::MAX);
            entry.niche = f64::from(dist_u32.saturating_add(1_u32)).recip();
        }
    }

    /// Populate `entry.frequency` from a path→access-count map.
    pub fn enrich_frequency(&self, entries: &mut [SortEntry], freq_map: &HashMap<String, u64>) {
        for entry in entries.iter_mut() {
            if let Some(count) = freq_map.get(&entry.path.to_string_lossy().to_string()) {
                entry.frequency = *count;
            }
        }
    }

    /// Sort entries by multiple criteria.
    ///
    /// Returns an iterator that yields paths until `limit_size` is reached.
    pub fn sort<'a>(&'a self, entries: &'a mut [SortEntry]) -> SortResult<'a> {
        let folder_aggregates =
            aggregate_folders(entries, &[], self.config.min_depth.unwrap_or(0), self.config.max_depth);

        let frecency_weight = self.config.frecency_weight;

        if self.config.criteria.iter().any(|(c, _)| *c == SortCriterion::Random) {
            let mut rng = rand::rng();
            entries.shuffle(&mut rng);
            return SortResult {
                entries,
                limit_size: self.config.limit_size,
                folder_aggregates,
            };
        }

        entries.sort_by(|left, right| {
            for (criterion, descending) in &self.config.criteria {
                let ordering = match criterion {
                    SortCriterion::Niche => left
                        .niche
                        .partial_cmp(&right.niche)
                        .unwrap_or(std::cmp::Ordering::Equal),
                    SortCriterion::Frecency => {
                        let left_frec = frecency(left, frecency_weight);
                        let right_frec = frecency(right, frecency_weight);
                        left_frec.cmp(&right_frec)
                    }
                    SortCriterion::Peers => left.peers.cmp(&right.peers),
                    SortCriterion::Random => std::cmp::Ordering::Equal, // handled separately
                    SortCriterion::FolderAggregate => {
                        let left_count = folder_aggregates.get(&left.folder).map_or(0, |agg| agg.file_count);
                        let right_count = folder_aggregates.get(&right.folder).map_or(0, |agg| agg.file_count);
                        left_count.cmp(&right_count)
                    }
                    SortCriterion::Time => left.modified.cmp(&right.modified),
                    SortCriterion::Date => {
                        let left_day = time_since_epoch(left.modified, 86400);
                        let right_day = time_since_epoch(right.modified, 86400);
                        left_day.cmp(&right_day)
                    }
                    SortCriterion::Week => {
                        let left_week = time_since_epoch(left.modified, 604_800);
                        let right_week = time_since_epoch(right.modified, 604_800);
                        left_week.cmp(&right_week)
                    }
                    SortCriterion::Month => {
                        let left_month = time_since_epoch(left.modified, 2_592_000);
                        let right_month = time_since_epoch(right.modified, 2_592_000);
                        left_month.cmp(&right_month)
                    }
                    SortCriterion::Year => {
                        let left_year = time_since_epoch(left.modified, 31_536_000);
                        let right_year = time_since_epoch(right.modified, 31_536_000);
                        left_year.cmp(&right_year)
                    }
                    SortCriterion::Size => left.size.cmp(&right.size),
                    SortCriterion::FolderSize => {
                        let left_size = folder_aggregates.get(&left.folder).map_or(0, |agg| agg.size_sum);
                        let right_size = folder_aggregates.get(&right.folder).map_or(0, |agg| agg.size_sum);
                        left_size.cmp(&right_size)
                    }
                    SortCriterion::FolderAvgSize => {
                        let avg_size = |agg: &FolderAggregate| -> u64 {
                            if agg.file_count > 0 {
                                let count = u64::try_from(agg.file_count).unwrap_or(u64::MAX);
                                agg.size_sum.checked_div(count).unwrap_or(0)
                            } else {
                                0
                            }
                        };
                        let left_avg = folder_aggregates.get(&left.folder).map_or(0, avg_size);
                        let right_avg = folder_aggregates.get(&right.folder).map_or(0, avg_size);
                        left_avg.cmp(&right_avg)
                    }
                    SortCriterion::FolderDate => {
                        let left_time = folder_aggregates
                            .get(&left.folder)
                            .map_or(std::time::SystemTime::UNIX_EPOCH, |agg| agg.modified_median);
                        let right_time = folder_aggregates
                            .get(&right.folder)
                            .map_or(std::time::SystemTime::UNIX_EPOCH, |agg| agg.modified_median);
                        let left_day = time_since_epoch(left_time, 86400);
                        let right_day = time_since_epoch(right_time, 86400);
                        left_day.cmp(&right_day)
                    }
                    SortCriterion::FolderTime => {
                        let left_time = folder_aggregates
                            .get(&left.folder)
                            .map_or(std::time::SystemTime::UNIX_EPOCH, |agg| agg.modified_median);
                        let right_time = folder_aggregates
                            .get(&right.folder)
                            .map_or(std::time::SystemTime::UNIX_EPOCH, |agg| agg.modified_median);
                        left_time.cmp(&right_time)
                    }
                    SortCriterion::Count => {
                        let left_count = folder_aggregates.get(&left.folder).map_or(0, |agg| agg.file_count);
                        let right_count = folder_aggregates.get(&right.folder).map_or(0, |agg| agg.file_count);
                        left_count.cmp(&right_count)
                    }
                };

                let final_ordering = if *descending { ordering.reverse() } else { ordering };

                if final_ordering != std::cmp::Ordering::Equal {
                    return final_ordering;
                }
            }
            std::cmp::Ordering::Equal
        });

        SortResult {
            entries,
            limit_size: self.config.limit_size,
            folder_aggregates,
        }
    }
}

/// Result of sorting, with iterator support for `limit_size`.
pub struct SortResult<'a> {
    entries: &'a mut [SortEntry],
    limit_size: Option<u64>,
    folder_aggregates: HashMap<String, FolderAggregate>,
}

impl<'a> SortResult<'a> {
    /// Iterate over sorted entries, stopping when `limit_size` is reached.
    #[must_use]
    pub const fn iter(&'a self) -> SortIterator<'a> {
        SortIterator {
            entries: self.entries,
            index: 0,
            cumulative_size: 0,
            limit_size: self.limit_size,
        }
    }

    /// Get the folder aggregates.
    #[must_use]
    pub const fn folder_aggregates(&self) -> &HashMap<String, FolderAggregate> {
        &self.folder_aggregates
    }
}

impl<'a> IntoIterator for &'a SortResult<'a> {
    type Item = &'a SortEntry;
    type IntoIter = SortIterator<'a>;

    fn into_iter(self) -> Self::IntoIter {
        self.iter()
    }
}

/// Iterator over sorted entries with size limit.
pub struct SortIterator<'a> {
    entries: &'a [SortEntry],
    index: usize,
    cumulative_size: u64,
    limit_size: Option<u64>,
}

impl<'a> Iterator for SortIterator<'a> {
    type Item = &'a SortEntry;

    fn next(&mut self) -> Option<Self::Item> {
        if self.index >= self.entries.len() {
            return None;
        }

        let entry = self.entries.get(self.index)?;
        let new_size = self.cumulative_size.saturating_add(entry.size);

        if let Some(limit) = self.limit_size
            && self.index > 0
            && new_size > limit
        {
            return None;
        }

        self.index = self.index.saturating_add(1);
        self.cumulative_size = new_size;
        Some(entry)
    }
}

fn frecency(entry: &SortEntry, frecency_weight: u64) -> i64 {
    let days_since = days_since_modified(entry.modified);

    let freq = i64::try_from(entry.frequency).unwrap_or(i64::MAX);

    let penalty = days_since.checked_div(frecency_weight).unwrap_or(0);

    freq.saturating_sub(i64::try_from(penalty).unwrap_or(i64::MAX))
}

#[must_use]
fn days_since_modified(time: std::time::SystemTime) -> u64 {
    let now = std::time::SystemTime::now();
    now.duration_since(time)
        .map_or(0, |d| d.as_secs().checked_div(86400).unwrap_or(0))
}

fn time_since_epoch(time: std::time::SystemTime, divisor: u64) -> u64 {
    time.duration_since(std::time::UNIX_EPOCH)
        .map_or(0, |d| d.as_secs().checked_div(divisor).unwrap_or(0))
}

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

    #[test]
    fn test_parse_criteria() {
        let criteria = SortConfig::parse_criteria(&["-niche".to_string(), "-frecency".to_string(), "time".to_string()]);
        assert_eq!(criteria.len(), 3);
        assert_eq!(criteria.first().copied().unwrap(), (SortCriterion::Niche, true));
        assert_eq!(criteria.get(1).copied().unwrap(), (SortCriterion::Frecency, true));
        assert_eq!(criteria.get(2).copied().unwrap(), (SortCriterion::Time, false));
    }

    #[test]
    fn test_sort_by_peers() {
        let config = SortConfig {
            criteria: vec![(SortCriterion::Peers, true)],
            ..SortConfig::default()
        };
        let sorter = Sorter::new(config);
        let mut entries = vec![
            SortEntry::new("a.txt").with_peers(1),
            SortEntry::new("b.txt").with_peers(3),
            SortEntry::new("c.txt").with_peers(2),
        ];
        let result = sorter.sort(&mut entries);
        let paths: Vec<_> = result.iter().map(|e| e.path.clone()).collect();
        assert_eq!(
            paths,
            [
                std::path::PathBuf::from("b.txt"),
                std::path::PathBuf::from("c.txt"),
                std::path::PathBuf::from("a.txt")
            ]
        );
    }

    #[test]
    fn test_sort_by_size() {
        let config = SortConfig {
            criteria: vec![(SortCriterion::Size, false)],
            ..SortConfig::default()
        };
        let sorter = Sorter::new(config);
        let mut entries = vec![
            SortEntry::new("a.txt").with_size(100),
            SortEntry::new("b.txt").with_size(300),
            SortEntry::new("c.txt").with_size(200),
        ];
        let result = sorter.sort(&mut entries);
        let paths: Vec<_> = result.iter().map(|e| e.path.clone()).collect();
        assert_eq!(
            paths,
            [
                std::path::PathBuf::from("a.txt"),
                std::path::PathBuf::from("c.txt"),
                std::path::PathBuf::from("b.txt")
            ]
        );
    }

    #[test]
    fn test_limit_size() {
        let config = SortConfig {
            criteria: vec![(SortCriterion::Size, false)],
            limit_size: Some(300),
            ..SortConfig::default()
        };
        let sorter = Sorter::new(config);
        let mut entries = vec![
            SortEntry::new("a.txt").with_size(100),
            SortEntry::new("b.txt").with_size(300),
            SortEntry::new("c.txt").with_size(200),
        ];
        let result = sorter.sort(&mut entries);
        let paths: Vec<_> = result.iter().map(|e| e.path.clone()).collect();
        assert_eq!(
            paths,
            [std::path::PathBuf::from("a.txt"), std::path::PathBuf::from("c.txt")]
        );
    }

    #[test]
    fn test_filter_seeders() {
        let config = SortConfig {
            criteria: vec![(SortCriterion::Peers, true)],
            min_seeders: Some(2),
            max_seeders: Some(4),
            ..SortConfig::default()
        };
        let sorter = Sorter::new(config);
        let entries = vec![
            SortEntry::new("a.txt").with_peers(1),
            SortEntry::new("b.txt").with_peers(3),
            SortEntry::new("c.txt").with_peers(5),
        ];
        let filtered = sorter.filter_seeders(entries);
        assert_eq!(filtered.len(), 1);
        assert_eq!(filtered.first().unwrap().path, std::path::PathBuf::from("b.txt"));
    }
}