patholog 1.0.0

Diagnose, explain, clean, and safely repair PATH behavior.
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

use crate::model::{PathEntry, PathVariable, PlatformMode, PresetKind};
use crate::normalize::comparison_key;
use crate::platform::resolve_platform_rules;
use std::collections::HashSet;

const FINK_PATH_DROP_ENTRIES: &[&str] = &["/sw/bin", "/sw/sbin"];
const FINK_MANPATH_DROP_ENTRIES: &[&str] = &["/sw/share/man"];

#[derive(Clone, Debug, Default, Eq, PartialEq)]
pub(crate) struct PathPolicy {
    drop_entries: Vec<String>,
    ordering_presets: Vec<PresetKind>,
}

impl PathPolicy {
    pub(crate) fn new(
        explicit_drops: &[String],
        presets: &[PresetKind],
        variable: PathVariable,
    ) -> Self {
        let mut drop_entries = Vec::new();
        let mut ordering_presets = Vec::new();
        for entry in explicit_drops {
            push_unique(&mut drop_entries, entry);
        }
        for preset in presets {
            match preset {
                PresetKind::Fink => {
                    for entry in fink_drop_entries(variable) {
                        push_unique(&mut drop_entries, entry);
                    }
                }
                PresetKind::Homebrew | PresetKind::Cargo | PresetKind::Pyenv => {
                    push_unique_preset(&mut ordering_presets, *preset);
                }
            }
        }
        Self {
            drop_entries,
            ordering_presets,
        }
    }

    pub(crate) fn has_drop_entries(&self) -> bool {
        !self.drop_entries.is_empty()
    }

    pub(crate) fn ordering_presets(&self) -> &[PresetKind] {
        &self.ordering_presets
    }

    pub(crate) fn compile(
        &self,
        platform_mode: PlatformMode,
        pathext: Option<&str>,
    ) -> CompiledPathPolicy {
        let rules = resolve_platform_rules(platform_mode, pathext);
        let mut drop_keys = HashSet::with_capacity(self.drop_entries.len());
        for entry in &self.drop_entries {
            let key = comparison_key(entry, &rules);
            drop_keys.insert(key);
        }
        CompiledPathPolicy { drop_keys }
    }
}

fn fink_drop_entries(variable: PathVariable) -> &'static [&'static str] {
    match variable {
        PathVariable::Path => FINK_PATH_DROP_ENTRIES,
        PathVariable::Manpath => FINK_MANPATH_DROP_ENTRIES,
    }
}

#[derive(Clone, Debug, Default, Eq, PartialEq)]
pub(crate) struct CompiledPathPolicy {
    drop_keys: HashSet<String>,
}

impl CompiledPathPolicy {
    pub(crate) fn matches_entry(&self, entry: &PathEntry) -> bool {
        !entry.is_empty && self.drop_keys.contains(&entry.comparison_key)
    }
}

fn push_unique(entries: &mut Vec<String>, entry: &str) {
    if entries.iter().any(|existing| existing == entry) {
        return;
    }
    entries.push(entry.to_owned());
}

fn push_unique_preset(presets: &mut Vec<PresetKind>, preset: PresetKind) {
    if presets.contains(&preset) {
        return;
    }
    presets.push(preset);
}

#[cfg(test)]
#[path = "policy/tests.rs"]
mod tests;