adblock 0.5.0

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
88
89
90
91
92
93
94
95
96
97

use flate2::write::GzEncoder;
use flate2::read::GzDecoder;
use flate2::Compression;
use serde::{Serialize, Deserialize};

use crate::blocker::Blocker;

// Pick version to use for serialization from cargo package version
pub const VERSION: &'static str = env!("CARGO_PKG_VERSION");

// Helper structs to use the wrapped Blocker struct with its own serialization definitions
pub struct Wrapper<'a> {
    pub wrapped: &'a Blocker
}

pub struct Unwrappable {
    pub wrapped: Box<Blocker>
}

impl<'a> serde::Serialize for Wrapper<'a> {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        // An intermediate struct that adds manifest version and includes
        // the wrapped structure already encoded. Allows for checking of
        // `manifest-version` before any other field gets decoded
        #[derive(Serialize)]
        struct EncodedBlocker<'b> {
            #[serde(rename = "manifest-version")]
            manifest_version: &'b str,
            blocker: &'b Vec<u8>
        }

        let mut gz = GzEncoder::new(Vec::new(), Compression::default());

        bincode::serialize_into(&mut gz, &self)
            .or_else(|e| {
                Err(D::Error::invalid_value(::serde::de::Unexpected::Other("Failed to serialize to bincode"), &e.to_string().as_str()))
            })?;

        let compressed = gz.finish().unwrap();
            .or_else(|e| {
                Err(D::Error::invalid_value(::serde::de::Unexpected::Other("Failed to finish Gzip encoding"), &e.to_string().as_str()))
            })?;

        let output = EncodedBlocker {
            // Pick version to use for serialization from cargo package version
            manifest_version: VERSION,
            blocker: &compressed,
        };

        // Once again, serde does all the hard work for us
        output.serialize(serializer)
    }
}

impl<'de> serde::Deserialize<'de> for Unwrappable {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        use serde::de::Error;

        // An intermediate struct that exactly matches the input schema.
        #[derive(Deserialize)]
        struct EncodedBlocker {
            #[serde(rename = "manifest-version")]
            pub manifest_version: String,
            pub blocker: Vec<u8>
        }

        // Because we derived Deserialize automatically,
        // serde does all the hard work for us.
        let input = EncodedBlocker::deserialize(deserializer)?;

        // Validating the manifest_version field is straightforward.
        if input.manifest_version != VERSION {
            return Err(D::Error::invalid_value(
                ::serde::de::Unexpected::Str(&input.manifest_version), &VERSION
            ));
        }

        let gz = GzDecoder::new(&input.blocker[..]);
        let blocker = bincode::deserialize_from(gz)
            .or_else(|e| {
                Err(D::Error::invalid_value(::serde::de::Unexpected::Other("Failed to parse bincode formatted data"), &e.to_string().as_str()))
            })?;

        // Finally, we move all the data into an instance
        // of our wrapper struct.
        Ok(Unwrappable {
            wrapped: Box::new(blocker)
        })
    }
}