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
|
//! Python bindings for Brave's adblocking library, which is written in Rust.
#![deny(
future_incompatible,
nonstandard_style,
rust_2018_idioms,
missing_copy_implementations,
trivial_casts,
trivial_numeric_casts,
unsafe_code,
unused_qualifications
)]
use pyo3::class::PyObjectProtocol;
use pyo3::prelude::*;
use adblock::blocker::BlockerResult as RustBlockerResult;
use adblock::engine::Engine as RustEngine;
/// Brave's adblocking library in Python!
#[pymodule]
fn adblock(_py: Python<'_>, m: &PyModule) -> PyResult<()> {
m.add("__version__", env!("CARGO_PKG_VERSION"))?;
m.add_class::<Engine>()?;
Ok(())
}
#[pyclass]
pub struct BlockerResult {
#[pyo3(get)]
pub matched: bool,
#[pyo3(get)]
pub explicit_cancel: bool,
#[pyo3(get)]
pub important: bool,
#[pyo3(get)]
pub redirect: Option<String>,
#[pyo3(get)]
pub exception: Option<String>,
#[pyo3(get)]
pub filter: Option<String>,
#[pyo3(get)]
pub error: Option<String>,
}
impl Into<BlockerResult> for RustBlockerResult {
fn into(self) -> BlockerResult {
BlockerResult {
matched: self.matched,
explicit_cancel: self.explicit_cancel,
important: self.important,
redirect: self.redirect,
exception: self.exception,
filter: self.filter,
error: self.error,
}
}
}
#[pyproto]
impl PyObjectProtocol for BlockerResult {
fn __repr__(&self) -> PyResult<String> {
Ok(format!(
"BlockerResult({}, {}, {}, {:?}, {:?}, {:?}, {:?})",
self.matched,
self.explicit_cancel,
self.important,
self.redirect,
self.exception,
self.filter,
self.error
))
}
}
#[pyclass]
pub struct Engine {
engine: RustEngine,
}
#[pymethods]
impl Engine {
#[new]
pub fn from_rules(network_filters: Vec<String>) -> Self {
let engine = RustEngine::from_rules(&network_filters);
Self { engine }
}
/// ## Request types
/// Examples of valid `request_type` parameters include:
/// * `beacon`
/// * `csp_report`
/// * `document`
/// * `font`
/// * `media`
/// * `object`
/// * `script`
/// * `stylesheet`
/// * and et cetera...
pub fn check_network_urls(
&self,
url: &str,
source_url: &str,
request_type: &str,
) -> BlockerResult {
let blocker_result = self
.engine
.check_network_urls(url, source_url, request_type);
blocker_result.into()
}
pub fn check_network_urls_with_hostnames(
&self,
url: &str,
hostname: &str,
source_hostname: &str,
request_type: &str,
third_party_request: Option<bool>,
) -> BlockerResult {
let blocker_result = self.engine.check_network_urls_with_hostnames(
url,
hostname,
source_hostname,
request_type,
third_party_request,
);
blocker_result.into()
}
pub fn check_network_urls_with_hostnames_subset(
&self,
url: &str,
hostname: &str,
source_hostname: &str,
request_type: &str,
third_party_request: Option<bool>,
previously_matched_rule: bool,
force_check_exceptions: bool,
) -> BlockerResult {
let blocker_result = self.engine.check_network_urls_with_hostnames_subset(
url,
hostname,
source_hostname,
request_type,
third_party_request,
previously_matched_rule,
force_check_exceptions,
);
blocker_result.into()
}
pub fn filter_exists(&self, filter: &str) -> bool {
self.engine.filter_exists(filter)
}
pub fn tags_enable(&mut self, tags: Vec<&str>) {
self.engine.tags_enable(&tags);
}
pub fn tags_disable(&mut self, tags: Vec<&str>) {
self.engine.tags_disable(&tags);
}
pub fn tag_exists(&self, tag: &str) -> bool {
self.engine.tag_exists(tag)
}
// pub fn hidden_class_id_selectors(
// &self,
// classes: Vec<String>,
// ids: Vec<String>,
// exceptions: &PySet,
// ) -> PyResult<Vec<String>> {
// let mut exception_hashset: HashSet<String> = HashSet::new();
// for exception in exceptions.iter() {
// let exception_pystr = PyString::from(exception);
// exception_hashset.insert(exception.to_string());
// }
// Ok(self.engine
// .hidden_class_id_selectors(&classes, &ids, &exception_hashset))
// }
}
|
