adblock 0.12.2

Native Rust module for Adblock Plus syntax (e.g. EasyList, EasyPrivacy) filter parsing and matching.
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

//! Builder for creating flatbuffer with serialized engine.

use std::collections::HashMap;

use flatbuffers::WIPOffset;

use crate::filters::fb_network_builder::NetworkFilterListBuilder;
use crate::flatbuffers::containers::flat_serialize::{FlatBuilder, FlatSerialize, WIPFlatVec};
use crate::flatbuffers::unsafe_tools::VerifiedFlatbufferMemory;
use crate::utils::Hash;

use super::flat::fb;

#[derive(Clone, Default)]
pub(crate) struct ShareableString {
    index: Option<usize>,
}

#[derive(Default)]
pub(crate) struct EngineFlatBuilder<'a> {
    fb_builder: flatbuffers::FlatBufferBuilder<'a>,
    unique_domains_hashes: Vec<Hash>,
    unique_domains_hashes_map: HashMap<Hash, u32>,
    shared_strings: Vec<WIPOffset<&'a str>>,
    shared_strings_original: Vec<String>,
}

impl<'a> EngineFlatBuilder<'a> {
    pub fn get_or_insert_unique_domain_hash(&mut self, h: &Hash) -> u32 {
        if let Some(&index) = self.unique_domains_hashes_map.get(h) {
            return index;
        }
        let index = self.unique_domains_hashes.len() as u32;
        self.unique_domains_hashes.push(*h);
        self.unique_domains_hashes_map.insert(*h, index);
        index
    }

    pub fn add_shareable_string(&mut self, s: &str) -> ShareableString {
        let wip_offset = self.fb_builder.create_string(s);
        self.shared_strings.push(wip_offset);
        self.shared_strings_original.push(s.to_string());
        ShareableString {
            index: Some(self.shared_strings.len() - 1),
        }
    }

    pub fn finish(
        &mut self,
        network_rules: WIPFlatVec<'a, NetworkFilterListBuilder, EngineFlatBuilder<'a>>,
        cosmetic_rules: WIPOffset<fb::CosmeticFilters<'_>>,
    ) -> VerifiedFlatbufferMemory {
        let unique_domains_hashes =
            Some(self.fb_builder.create_vector(&self.unique_domains_hashes));
        let engine = fb::Engine::create(
            self.raw_builder(),
            &fb::EngineArgs {
                network_rules: Some(network_rules),
                unique_domains_hashes,
                cosmetic_filters: Some(cosmetic_rules),
            },
        );
        self.raw_builder().finish(engine, None);
        VerifiedFlatbufferMemory::from_builder(self.raw_builder())
    }
}

impl<'a> FlatBuilder<'a> for EngineFlatBuilder<'a> {
    fn create_string(&mut self, s: &str) -> WIPOffset<&'a str> {
        self.fb_builder.create_string(s)
    }

    fn raw_builder(&mut self) -> &mut flatbuffers::FlatBufferBuilder<'a> {
        &mut self.fb_builder
    }
}

impl<'a> FlatSerialize<'a, EngineFlatBuilder<'a>> for ShareableString {
    type Output = WIPOffset<&'a str>;
    fn serialize(value: Self, builder: &mut EngineFlatBuilder<'a>) -> Self::Output {
        if let Some(index) = value.index {
            builder.shared_strings[index]
        } else {
            builder.raw_builder().create_shared_string("")
        }
    }
}