csaf_walker/visitors/
filter.rs

use crate::discover::{DiscoveredAdvisory, DiscoveredContext, DiscoveredVisitor};
use std::collections::HashSet;

/// A visitor, skipping advisories for existing files.
pub struct FilteringVisitor<V: DiscoveredVisitor> {
    pub visitor: V,

    pub config: FilterConfig,
}

#[non_exhaustive]
#[derive(Clone, Default, Debug, PartialEq, Eq)]
pub struct FilterConfig {
    /// A set of distributions to ignore
    ///
    /// **NOTE:** The distributions will still be discovered, as this is a post-discovery visitor. If you want to
    /// even skip discovering the source, use [`crate::walker::Walker::with_distribution_filter`].
    pub ignored_distributions: HashSet<String>,
    pub ignored_prefixes: Vec<String>,
    pub only_prefixes: Vec<String>,
}

impl FilterConfig {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn ignored_distributions<I>(mut self, ignored_distributions: I) -> Self
    where
        I: IntoIterator<Item = String>,
    {
        self.ignored_distributions = HashSet::from_iter(ignored_distributions);
        self
    }

    pub fn add_ignored_distribution(mut self, ignored_distribution: impl Into<String>) -> Self {
        self.ignored_distributions
            .insert(ignored_distribution.into());
        self
    }

    pub fn extend_ignored_distributions<I>(mut self, ignored_distributions: I) -> Self
    where
        I: IntoIterator<Item = String>,
    {
        self.ignored_distributions.extend(ignored_distributions);
        self
    }

    pub fn ignored_prefixes<I>(mut self, ignored_prefixes: I) -> Self
    where
        I: IntoIterator<Item = String>,
    {
        self.ignored_prefixes = Vec::from_iter(ignored_prefixes);
        self
    }

    pub fn add_ignored_prefix(mut self, ignored_prefix: impl Into<String>) -> Self {
        self.ignored_prefixes.push(ignored_prefix.into());
        self
    }

    pub fn extend_ignored_prefixes<I>(mut self, ignored_prefixes: I) -> Self
    where
        I: IntoIterator<Item = String>,
    {
        self.ignored_prefixes.extend(ignored_prefixes);
        self
    }

    pub fn only_prefixes<I>(mut self, only_prefixes: I) -> Self
    where
        I: IntoIterator<Item = String>,
    {
        self.only_prefixes = Vec::from_iter(only_prefixes);
        self
    }

    pub fn add_only_prefix(mut self, only_prefix: impl Into<String>) -> Self {
        self.only_prefixes.push(only_prefix.into());
        self
    }

    pub fn extend_only_prefixes<I>(mut self, only_prefixes: I) -> Self
    where
        I: IntoIterator<Item = String>,
    {
        self.only_prefixes.extend(only_prefixes);
        self
    }
}

impl<V: DiscoveredVisitor> DiscoveredVisitor for FilteringVisitor<V> {
    type Error = V::Error;
    type Context = V::Context;

    async fn visit_context(
        &self,
        discovered: &DiscoveredContext<'_>,
    ) -> Result<Self::Context, Self::Error> {
        self.visitor.visit_context(discovered).await
    }

    async fn visit_advisory(
        &self,
        context: &Self::Context,
        advisory: DiscoveredAdvisory,
    ) -> Result<(), Self::Error> {
        // ignore distributions

        if self
            .config
            .ignored_distributions
            .contains(advisory.context.url().as_str())
        {
            return Ok(());
        };

        // eval name

        let name = advisory
            .url
            .path_segments()
            .and_then(|seg| seg.last())
            .unwrap_or(advisory.url.path());

        // "ignore" prefix

        for n in &self.config.ignored_prefixes {
            if name.starts_with(n.as_str()) {
                return Ok(());
            }
        }

        // "only" prefix

        if !self.config.only_prefixes.is_empty()
            && !self
                .config
                .only_prefixes
                .iter()
                .any(|n| name.starts_with(n.as_str()))
        {
            return Ok(());
        }

        // ok to proceed

        self.visitor.visit_advisory(context, advisory).await
    }
}

#[cfg(test)]
mod test {
    use super::*;
    use crate::discover::DistributionContext;
    use std::sync::Arc;
    use std::time::SystemTime;
    use tokio::sync::Mutex;
    use url::Url;

    #[derive(Default)]
    struct MockVisitor {
        pub items: Arc<Mutex<Vec<DiscoveredAdvisory>>>,
    }

    impl DiscoveredVisitor for MockVisitor {
        type Error = anyhow::Error;
        type Context = ();

        async fn visit_context(
            &self,
            _context: &DiscoveredContext<'_>,
        ) -> Result<Self::Context, Self::Error> {
            Ok(())
        }

        async fn visit_advisory(
            &self,
            _context: &Self::Context,
            advisory: DiscoveredAdvisory,
        ) -> Result<(), Self::Error> {
            self.items.lock().await.push(advisory);
            Ok(())
        }
    }

    async fn issue<V>(filter: &FilteringVisitor<V>, name: &str) -> Result<(), anyhow::Error>
    where
        V: DiscoveredVisitor<Error = anyhow::Error, Context = ()>,
    {
        let context = Arc::new(DistributionContext::Directory(Url::parse(
            "https://localhost",
        )?));
        let url = Url::parse(&format!("https://localhost/{name}"))?;
        let modified = SystemTime::now();

        filter
            .visit_advisory(
                &(),
                DiscoveredAdvisory {
                    context,
                    url,
                    modified,
                },
            )
            .await?;

        Ok(())
    }

    #[tokio::test]
    async fn ignored() -> anyhow::Result<()> {
        let mock = MockVisitor::default();
        let filter = FilteringVisitor {
            config: FilterConfig::new()
                .add_ignored_prefix("foo-")
                .add_ignored_prefix("bar-"),
            visitor: mock,
        };

        issue(&filter, "foo-1").await?;
        issue(&filter, "foo-2").await?;
        issue(&filter, "bar-1").await?;
        issue(&filter, "bar-2").await?;
        issue(&filter, "baz-1").await?;
        issue(&filter, "baz-2").await?;

        let items = filter.visitor.items.lock().await.clone();
        assert_eq!(items.len(), 2);

        Ok(())
    }

    #[tokio::test]
    async fn only() -> anyhow::Result<()> {
        let mock = MockVisitor::default();
        let filter = FilteringVisitor {
            config: FilterConfig::new()
                .add_only_prefix("foo-")
                .add_only_prefix("bar-"),
            visitor: mock,
        };

        issue(&filter, "foo-1").await?;
        issue(&filter, "foo-2").await?;
        issue(&filter, "bar-1").await?;
        issue(&filter, "bar-2").await?;
        issue(&filter, "baz-1").await?;
        issue(&filter, "baz-2").await?;

        let items = filter.visitor.items.lock().await.clone();
        assert_eq!(items.len(), 4);

        Ok(())
    }
}
csaf_walker/visitors/filter.rs

csaf_walker/visitors/
filter.rs
