isbot 0.1.3

Detect if a user-agent is a known bot
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
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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339

//! [![github]](https://github.com/BryanMorgan/isbot) [![crates-io]](https://crates.io/crates/isbot)
//!
//! [github]: <https://img.shields.io/badge/github-8da0cb?style=for-the-badge&labelColor=555555&logo=github>
//! [crates-io]: <https://img.shields.io/badge/crates.io-fc8d62?style=for-the-badge&labelColor=555555&logo=rust>
//!
//! Detect bots or crawlers identified by matching a user-agent to a collection of known bot patterns.
//!
//! User-agent patterns are maintained as a single regular expression for fast validation.
//!
//! The default list of user-agent patterns balances a large set of known bots
//! while ensuring real browsers are not falsely identified as bots.
//!
//! # Examples
//!
//! ```
//! use isbot::Bots;
//!
//! let bots = Bots::default();
//! assert!(bots.is_bot("Googlebot-Image/1.0"));
//! assert!(!bots.is_bot("Opera/9.60 (Windows NT 6.0; U; en) Presto/2.1.1"));
//! ```
//!
//! User-agent regular expressions can be added or removed for specific use cases.
//! For example, you could remove the Chrome Lighthouse bot from the list of known bots:
//!
//! ```
//! let mut bots = isbot::Bots::default();
//!
//! // By default Chrome Lighthouse is considered a bot
//! assert!(bots.is_bot("Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/78.0.3904.97 Safari/537.36 Chrome-Lighthouse"));
//! // Remove the Chrome Lighthouse regular expression pattern to indicate it is not a bot
//! bots.remove(&["Chrome-Lighthouse"]);
//! assert!(!bots.is_bot("Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/78.0.3904.97 Safari/537.36 Chrome-Lighthouse"));
//! ```
//!
//! Or append a new user-agent to detect a custom bot:
//! ```
//! let mut bots = isbot::Bots::default();
//!
//! // Append a new custom bot user-agent regular expression
//! assert!(!bots.is_bot("Mozilla/5.0 (CustomNewTestB0T /1.2)"));
//! bots.append(&[r"CustomNewTestB0T\s/\d\.\d"]);
//! assert!(bots.is_bot("Mozilla/5.0 (CustomNewTestB0T /1.2)"));
//! ```

use regex::Regex;
use std::{collections::HashSet, fmt::Debug};

/// Wrapper struct to maintain bot regular expression patterns
///
/// # Example
///
/// ```
/// use isbot::Bots;
///
/// let bots = Bots::default();
/// ```
#[derive(Debug)]
pub struct Bots {
    user_agent_patterns: HashSet<String>,
    user_agents_regex: Regex,
}

/// Load default bot user-agent regular expressions from a local file, unless the feature is disabled
#[cfg(feature = "include-default-bots")]
const BOT_PATTERNS: &str = include_str!("bot_regex_patterns.txt");

/// Do not load any default user-agent strings into the compiled library if feature is not enabled
#[cfg(not(feature = "include-default-bots"))]
const BOT_PATTERNS: &str = "";

impl Default for Bots {
    /// Constructs a new instance with default user-agent patterns.
    ///
    /// # Example
    ///
    /// ```
    /// use isbot::Bots;
    ///
    /// let bots = Bots::default();
    ///
    /// assert!(bots.is_bot("Googlebot"));
    /// ```
    fn default() -> Self {
        Bots::new(BOT_PATTERNS)
    }
}

impl Bots {
    /// Constructs a new instance with bot user-agent regular expression entries delimited by a newline
    ///
    /// All user-agent regular expressions are converted to lowercase.
    ///
    /// # Example
    ///
    /// ```
    /// use isbot::Bots;
    ///
    /// let custom_user_agent_patterns = r#"
    /// ^Googlebot-Image/
    /// bingpreview/"#;
    /// let bots = Bots::new(custom_user_agent_patterns);
    ///
    /// assert!(bots.is_bot("Googlebot-Image/1.0"));
    /// assert!(bots.is_bot("Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/534+ (KHTML, like Gecko) BingPreview/1.0b"));
    /// assert!(!bots.is_bot("Googlebot"));
    /// ```
    pub fn new(bot_entries: &str) -> Self {
        let user_agent_patterns = Bots::parse_lines(&bot_entries.to_ascii_lowercase());
        let combined_user_agent_regex = Bots::to_regex(&user_agent_patterns);
        Bots {
            user_agent_patterns,
            user_agents_regex: combined_user_agent_regex,
        }
    }

    /// Returns `true` the user-agent is a known bot.
    ///
    /// The user-agent comparison is done using lowercase.
    ///
    /// # Example
    ///
    /// ```
    /// use isbot::Bots;
    ///
    /// let bots = Bots::default();
    ///
    /// assert!(bots.is_bot("Googlebot/2.1 (+http://www.google.com/bot.html)"));
    /// assert!(!bots.is_bot("Dalvik/2.1.0 (Linux; U; Android 8.0.0; SM-G930F Build/R16NW)"));
    /// ```    
    pub fn is_bot(&self, user_agent: &str) -> bool {
        self.user_agents_regex
            .is_match(&user_agent.to_ascii_lowercase())
    }

    /// Appends bot user-agent regular expressions patterns.
    ///
    /// Duplicates are ignored.
    ///
    /// # Example
    ///
    /// ```
    /// use isbot::Bots;
    ///
    /// let mut bots = Bots::default();
    /// assert!(!bots.is_bot("Mozilla/5.0 (CustomNewTestB0T /1.2)"));
    /// bots.append(&[r"CustomNewTestB0T\s/\d\.\d"]);
    /// assert!(bots.is_bot("Mozilla/5.0 (CustomNewTestB0T /1.2)"));
    ///
    /// let new_bot_patterns = vec!["GoogleMetaverse", "^Special/"];
    /// bots.append(&new_bot_patterns);
    /// assert!(bots.is_bot("Mozilla/5.0 (GoogleMetaverse/1.0)"));
    /// ```
    pub fn append(&mut self, bots: &[&str]) {
        for bot in bots {
            self.user_agent_patterns.insert(bot.to_ascii_lowercase());
        }
        self.update_regex()
    }

    /// Removes bot user-agent regular expressions.
    ///
    /// # Example
    ///
    /// ```
    /// use isbot::Bots;
    ///
    /// let mut bots = Bots::default();
    ///
    ///
    /// assert!(bots.is_bot("Chrome-Lighthouse"));
    /// bots.remove(&["Chrome-Lighthouse"]);
    /// assert!(!bots.is_bot("Chrome-Lighthouse"));
    ///
    /// let bot_patterns_to_remove = vec!["bingpreview/", "Google Favicon"];
    /// bots.remove(&bot_patterns_to_remove);
    /// assert!(!bots.is_bot("Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/534+ (KHTML, like Gecko) BingPreview/1.0b"));
    /// assert!(!bots.is_bot("Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/49.0.2623.75 Safari/537.36 Google Favicon"));
    /// ```
    pub fn remove(&mut self, bots: &[&str]) {
        for bot in bots {
            self.user_agent_patterns.remove(&bot.to_ascii_lowercase());
        }
        self.update_regex()
    }

    fn update_regex(&mut self) {
        self.user_agents_regex = Bots::to_regex(&self.user_agent_patterns)
    }

    fn parse_lines(bot_regex_entries: &str) -> HashSet<String> {
        HashSet::from_iter(
            bot_regex_entries
                .lines()
                .filter(|l| !l.trim().is_empty())
                .map(ToString::to_string),
        )
    }

    fn to_regex(regex_entries: &HashSet<String>) -> Regex {
        let pattern = regex_entries
            .iter()
            .cloned()
            .collect::<Vec<String>>()
            .join("|");

        if pattern.is_empty() {
            return Regex::new("^$").unwrap();
        }

        Regex::new(&pattern).unwrap()
    }
}

#[cfg(test)]
mod tests {
    use crate::Bots;

    static GOOD_BOTS: [&str; 7] = [
        "Googlebot",
        "Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)",
        "Mozilla/5.0 (compatible; Yahoo! Slurp; http://help.yahoo.com/help/us/ysearch/slurp)",
        "Mozilla/5.0 (Linux; Android 6.0.1; Nexus 5X Build/MMB29P) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.96 Mobile Safari/537.36 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)",
        "Mozilla/5.0 (compatible; Bingbot/2.0; +http://www.bing.com/bingbot.htm)",
        "DuckDuckBot/1.0; (+http://duckduckgo.com/duckduckbot.html)",
        "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/78.0.3904.97 Safari/537.36 Chrome-Lighthouse"
    ];

    static NOT_BOTS: [&str; 6] = [
        "",
        "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.36",
        "Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 5.1; Trident/4.0; .NET CLR 1.1.4322; .NET CLR 2.0.50727; .NET CLR 3.0.4506.2152; .NET CLR 3.5.30729)",
        "Mozilla/5.0 (iPhone; CPU iPhone OS 10_3_1 like Mac OS X) AppleWebKit/603.1.30 (KHTML, like Gecko) Version/10.0 Mobile/14E304 Safari/602.1",
        "Mozilla/5.0 (Linux; Android 5.0; SAMSUNG SM-N900 Build/LRX21V) AppleWebKit/537.36 (KHTML, like Gecko) SamsungBrowser/2.1 Chrome/34.0.1847.76 Mobile Safari/537.36",
        "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/95.0.4638.54 Safari/537.36",
    ];

    #[test]
    fn good_bots() {
        let bots = Bots::default();
        for bot in GOOD_BOTS {
            assert!(bots.is_bot(bot), "Invalid bot: '{}'", bot);
        }
    }

    #[test]
    fn not_bots() {
        let bots = Bots::default();
        for bot in NOT_BOTS {
            assert!(!bots.is_bot(bot), "Is a bot{}", bot);
        }
    }

    #[test]
    fn custom_user_agent_patterns() {
        let custom_user_agent_patterns = "\
            ^Simplebot\n\
            anything\\s+bot\n\
            Numerical\\d{4}\\.\\d{4}\\.\\d{4}\\.\\d{4}";
        let bots = Bots::new(custom_user_agent_patterns);
        assert!(!bots.is_bot("InvalidBot"));
        assert!(!bots.is_bot("Googlebot"));
        assert!(bots.is_bot("Simplebot/1.2"));
        assert!(!bots.is_bot(" Simplebot/1.2"));
        assert!(bots.is_bot("Anything  Bot"));
        assert!(!bots.is_bot("AnythingBot"));
        assert!(bots.is_bot("numerical1101.2001.3987.4781"));
        assert!(!bots.is_bot("numerical1.2.3.4"));
    }

    #[test]
    fn empty_user_agent_patterns() {
        let empty_user_agent_patterns = "";
        let bots = Bots::new(empty_user_agent_patterns);
        assert!(bots.is_bot(""));
        assert!(!bots.is_bot("1"));
        assert!(!bots.is_bot("Googlebot"));
    }

    #[test]
    fn single_user_agent_patterns() {
        let single_user_agent_patterns = "me";
        let bots = Bots::new(single_user_agent_patterns);
        assert!(!bots.is_bot(""));
        assert!(!bots.is_bot("M"));
        assert!(bots.is_bot("Me"));
        assert!(!bots.is_bot("Googlebot"));
    }
    #[test]
    fn add_pattern() {
        let mut bots = Bots::default();
        assert!(!bots.is_bot("Mozilla/5.0 (FancyNewTestB0T /1.2)"));
        bots.append(&[r"FancyNewTestB0T\s/\d\.\d"]);
        assert!(bots.is_bot("Mozilla/5.0 (FancyNewTestB0T /1.2)"));
    }

    #[test]
    fn add_multiple_patterns() {
        let mut bots = Bots::default();
        assert!(!bots.is_bot("Mozilla/5.0 (FancyNewTestB0T /1.2)"));
        assert!(!bots.is_bot("Special/1.0"));
        assert!(!bots.is_bot("GoogleMetaverse/2.1 (experimental)"));

        let new_bot_patterns = vec!["FancyNewTestB0T", "^GoogleMetaverse", "^Special/"];
        bots.append(&new_bot_patterns);

        assert!(bots.is_bot("Mozilla/5.0 (FancyNewTestB0T /1.2)"));
        assert!(bots.is_bot("Special/1.0"));
        assert!(bots.is_bot("GoogleMetaverse/2.1 (experimental)"));
    }

    #[test]
    fn remove_pattern() {
        let mut bots = Bots::default();
        assert!(bots.is_bot("Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/78.0.3904.97 Safari/537.36 Chrome-Lighthouse"));
        bots.remove(&["Chrome-Lighthouse"]);
        assert!(!bots.is_bot("Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/78.0.3904.97 Safari/537.36 Chrome-Lighthouse"));
        assert!(!bots.is_bot("Chrome-Lighthouse"));
        assert!(bots.is_bot("Mozilla/5.0 (Windows NT 10.0; Win64; x64) adbeat.com/policy AppleWebKit/537.36 (KHTML, like Gecko) Chrome/73.0.3683.86 Safari/537.36"));
    }

    #[test]
    fn remove_multiple_patterns() {
        let mut bots = Bots::default();
        assert!(bots.is_bot("Datadog Agent/5.10.1"));
        assert!(bots.is_bot("Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/78.0.3904.97 Safari/537.36 Chrome-Lighthouse"));
        assert!(bots.is_bot("Mozilla/5.0 (Java) outbrain"));
        assert!(bots.is_bot("Mozilla/5.0 (compatible; Google-Site-Verification/1.0)"));

        let bot_patterns_to_remove =
            vec!["datadog agent", "Chrome-Lighthouse", "outbrain", "google-"];
        bots.remove(&bot_patterns_to_remove);

        assert!(!bots.is_bot("Datadog Agent/5.10.1"));
        assert!(!bots.is_bot("Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/78.0.3904.97 Safari/537.36 Chrome-Lighthouse"));
        assert!(!bots.is_bot("Mozilla/5.0 (Java) outbrain"));
        assert!(!bots.is_bot("Mozilla/5.0 (compatible; Google-Site-Verification/1.0)"));
    }
}