wordval-utils 1.0.8

Wordval utilities: string manipulation, date handling, masking, ID generation, validation, crypto, web helpers, collection tools, retry utilities
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
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
//! User-Agent 轻量解析:浏览器 / 操作系统 / 设备类型 / 爬虫识别
//!
//! 手工实现、零第三方依赖,覆盖主流浏览器、App 内核 WebView 与常见
//! HTTP 客户端的 UA 规则,面向审计日志、访问统计等"够用就好"的场景。
//! UA 串本身没有规范约束,追求完备解析请使用专门的 UA 解析库。
//!
//! ```rust
//! use wordval_utils::ua::Ua;
//!
//! let info = Ua::parse("Mozilla/5.0 (Linux; Android 14; Pixel 8) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Mobile Safari/537.36");
//! assert_eq!(info.os.as_deref(), Some("Android 14"));
//! assert_eq!(info.device, wordval_utils::ua::UaDevice::Mobile);
//! assert!(!info.bot);
//!
//! // 解析结果可直接序列化为 JSON(塞进审计扩展位等)
//! assert!(serde_json::to_value(&info).is_ok());
//! ```

use serde::Serialize;

/// 设备类型
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum UaDevice {
    /// 桌面(含笔记本)
    Desktop,
    /// 手机
    Mobile,
    /// 平板
    Tablet,
    /// 爬虫 / 自动化工具
    Bot,
    /// 无法识别
    Unknown,
}

/// UA 解析结果(`Serialize` 便于直接写入审计/日志扩展位)
#[derive(Debug, Clone, Serialize)]
pub struct UaInfo {
    /// 浏览器及版本(如 `Chrome 120.0.0.0`、`Safari 17.0`;无匹配为 None)
    pub browser: Option<String>,
    /// 操作系统(如 `Windows 10/11`、`macOS 10.15.7`、`Android 14`、`iOS 17.2`)
    pub os: Option<String>,
    /// 设备类型
    pub device: UaDevice,
    /// 是否爬虫 / 自动化工具
    pub bot: bool,
}

impl UaInfo {
    /// 是否移动设备(手机或平板)
    pub fn is_mobile_device(&self) -> bool {
        matches!(self.device, UaDevice::Mobile | UaDevice::Tablet)
    }

    /// 是否爬虫 / 自动化工具
    pub fn is_bot(&self) -> bool {
        self.bot
    }
}

/// User-Agent 解析工具
pub struct Ua;

/// 爬虫 / 自动化客户端标记(小写匹配):通用关键词 + 常见搜索引擎、
/// 无头浏览器与编程语言 HTTP 客户端
const BOT_TOKENS: &[&str] = &[
    // 通用爬虫关键词
    "bot",
    "spider",
    "scrapy",
    "crawl",
    "slurp",
    // 搜索引擎 / 社交媒体抓取器
    "bingpreview",
    "facebookexternalhit",
    "twitterbot",
    "telegrambot",
    "whatsapp",
    "discordbot",
    "slackbot",
    "linkedinbot",
    "petalbot",
    "sogou",
    "yisou",
    "mediapartners",
    "feedfetcher",
    // 无头 / 自动化浏览器
    "headlesschrome",
    "puppeteer",
    "playwright",
    "phantomjs",
    "selenium",
    "lighthouse",
    "pagespeed",
    // 编程语言 HTTP 客户端与探测工具
    "curl/",
    "wget/",
    "python-requests",
    "python-urllib",
    "aiohttp/",
    "okhttp/",
    "go-http-client",
    "apache-httpclient",
    "httpclient",
    "java/",
    "node-fetch",
    "axios/",
    "guzzle",
    "httpie/",
    "postmanruntime",
    "nmap",
    "zgrab",
    "masscan",
    "kube-probe",
    "prometheus",
    "elasticsearch",
];

/// 浏览器识别规则(小写 contains 标记 → 展示名),按优先级排列:
/// 特定客户端在前,通用 Chrome/Safari 在后——微信、国产浏览器等
/// WebView 内核的 UA 同时带 Chrome/Safari 标记,先命中先赢
const BROWSER_RULES: &[(&str, &str)] = &[
    ("headlesschrome/", "HeadlessChrome"),
    ("micromessenger/", "WeChat"),
    ("qqbrowser/", "QQBrowser"),
    ("mqqbrowser/", "QQBrowser"),
    ("ucbrowser/", "UCBrowser"),
    ("baidubrowser/", "Baidu Browser"),
    ("bdbrowser/", "Baidu Browser"),
    ("baiduboxapp/", "Baidu App"),
    ("miuibrowser/", "Mi Browser"),
    ("huaweibrowser/", "Huawei Browser"),
    ("hwbrowser/", "Huawei Browser"),
    ("heytapbrowser/", "HeyTapBrowser"),
    ("vivobrowser/", "vivo Browser"),
    ("samsungbrowser/", "Samsung Internet"),
    ("edgios/", "Edge"),
    ("edga/", "Edge"),
    ("edg/", "Edge"),
    ("edge/", "Edge"),
    ("opios/", "Opera"),
    ("opr/", "Opera"),
    ("opera", "Opera"),
    ("fxios/", "Firefox"),
    ("firefox/", "Firefox"),
    ("crios/", "Chrome iOS"),
    ("chromium/", "Chromium"),
    ("chrome/", "Chrome"),
    ("msie ", "IE"),
    ("trident/", "IE"),
    ("curl/", "cURL"),
    ("wget/", "Wget"),
    ("postmanruntime/", "Postman"),
    ("python-requests/", "python-requests"),
    ("okhttp/", "OkHttp"),
    ("go-http-client/", "Go-http-client"),
    ("java/", "Java"),
    ("apache-httpclient/", "Apache HttpClient"),
    ("safari", "Safari"),
];

impl Ua {
    /// 解析 User-Agent 字符串(大小写不敏感;空串 / 无匹配字段返回 None)
    pub fn parse(ua: &str) -> UaInfo {
        let lower = ua.to_ascii_lowercase();
        let bot = is_bot(&lower);
        UaInfo {
            browser: detect_browser(&lower),
            os: detect_os(&lower),
            device: detect_device(&lower, bot),
            bot,
        }
    }
}

fn is_bot(lower: &str) -> bool {
    BOT_TOKENS.iter().any(|t| lower.contains(t))
}

fn detect_browser(lower: &str) -> Option<String> {
    for (marker, name) in BROWSER_RULES {
        if lower.contains(marker) {
            // 版本取自标记后的数字段;Safari 统一读 Version/,
            // 仅 Trident 的 IE 读 rv:
            let version_marker = match *name {
                "Safari" => "version/",
                "IE" if *marker == "trident/" => "rv:",
                _ => marker,
            };
            return Some(match version_after(lower, version_marker) {
                Some(v) => format!("{name} {v}"),
                None => (*name).to_string(),
            });
        }
    }
    None
}

fn detect_os(lower: &str) -> Option<String> {
    // Windows Phone / NT 版本映射在裸 "windows" 之前判定
    if let Some(v) = version_after(lower, "windows phone") {
        return Some(format!("Windows Phone {v}"));
    }
    if lower.contains("windows phone") {
        return Some("Windows Phone".into());
    }
    if let Some(name) = lower
        .contains("windows nt 10.0")
        .then_some("Windows 10/11")
        .or_else(|| lower.contains("windows nt 6.3").then_some("Windows 8.1"))
        .or_else(|| lower.contains("windows nt 6.2").then_some("Windows 8"))
        .or_else(|| lower.contains("windows nt 6.1").then_some("Windows 7"))
        .or_else(|| lower.contains("windows nt 5.1").then_some("Windows XP"))
        .or_else(|| lower.contains("windows").then_some("Windows"))
    {
        return Some(name.into());
    }
    // iPhone / iPad(iPad 标准 UA 的系统标记是 CPU OS;
    // "请求桌面网站" 的 iPad 与 Mac 完全同串,无法区分,按桌面解析)
    if let Some(v) = version_after(lower, "iphone os ") {
        return Some(format!("iOS {}", v.replace('_', ".")));
    }
    if lower.contains("iphone") || lower.contains("ipod") {
        return Some("iOS".into());
    }
    if let Some(v) = version_after(lower, "cpu os ") {
        return Some(format!("iPadOS {}", v.replace('_', ".")));
    }
    if lower.contains("ipad") {
        return Some("iPadOS".into());
    }
    if let Some(v) = version_after(lower, "android ") {
        return Some(format!("Android {v}"));
    }
    if lower.contains("android") {
        return Some("Android".into());
    }
    if let Some(v) = version_after(lower, "mac os x ") {
        return Some(format!("macOS {}", v.replace('_', ".")));
    }
    if lower.contains("macintosh") || lower.contains("mac os") {
        return Some("macOS".into());
    }
    if lower.contains("cros") {
        return Some("ChromeOS".into());
    }
    if lower.contains("freebsd") {
        return Some("FreeBSD".into());
    }
    if lower.contains("linux") {
        return Some("Linux".into());
    }
    None
}

fn detect_device(lower: &str, bot: bool) -> UaDevice {
    if bot {
        return UaDevice::Bot;
    }
    if lower.contains("ipad") || lower.contains("tablet") {
        return UaDevice::Tablet;
    }
    // Android 平板的 UA 不带 Mobile 标记
    if lower.contains("android") && !lower.contains("mobi") {
        return UaDevice::Tablet;
    }
    if lower.contains("mobi")
        || lower.contains("iphone")
        || lower.contains("ipod")
        || lower.contains("windows phone")
    {
        return UaDevice::Mobile;
    }
    // 带桌面 OS 标记即视为桌面
    if lower.contains("windows")
        || lower.contains("macintosh")
        || lower.contains("mac os")
        || lower.contains("cros")
        || lower.contains("linux")
        || lower.contains("freebsd")
    {
        return UaDevice::Desktop;
    }
    UaDevice::Unknown
}

/// 取 `marker` 之后的版本数字段(`数字[.数字]...`,iOS/macOS 的 `_` 分隔
/// 原样保留、由调用方按需转 `.`);无版本返回 None
fn version_after(lower: &str, marker: &str) -> Option<String> {
    let idx = lower.find(marker)?;
    // 标记后可能是 "/ "(chrome/120)、纯空格(Windows Phone 10.0)或紧邻数字(android 14)
    let rest = lower[idx + marker.len()..].trim_start_matches(['/', ' ']);
    let end = rest
        .find(|c: char| !(c.is_ascii_digit() || c == '.' || c == '_'))
        .unwrap_or(rest.len());
    let v = rest[..end].trim_end_matches('.');
    if v.is_empty() {
        None
    } else {
        Some(v.to_string())
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn chrome_windows_desktop() {
        let info = Ua::parse("Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36");
        assert_eq!(info.browser.as_deref(), Some("Chrome 120.0.0.0"));
        assert_eq!(info.os.as_deref(), Some("Windows 10/11"));
        assert_eq!(info.device, UaDevice::Desktop);
        assert!(!info.bot);
    }

    #[test]
    fn safari_iphone_mobile() {
        let info = Ua::parse("Mozilla/5.0 (iPhone; CPU iPhone OS 17_2 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.0 Mobile/15E148 Safari/604.1");
        assert_eq!(info.browser.as_deref(), Some("Safari 17.0"));
        assert_eq!(info.os.as_deref(), Some("iOS 17.2"));
        assert_eq!(info.device, UaDevice::Mobile);
        assert!(info.is_mobile_device());
    }

    #[test]
    fn ipad_reports_ipados() {
        // 标准 iPad 形态(iPad; CPU OS ...)
        let info = Ua::parse("Mozilla/5.0 (iPad; CPU OS 17_2 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.0 Mobile/15E148 Safari/604.1");
        assert_eq!(info.device, UaDevice::Tablet);
        assert_eq!(info.os.as_deref(), Some("iPadOS 17.2"));
        // 注:"请求桌面网站" 的 iPad UA 与 Mac 完全同串,按桌面/macOS 解析(已知限制)
    }

    #[test]
    fn chrome_android_mobile_vs_tablet() {
        let phone = Ua::parse("Mozilla/5.0 (Linux; Android 14; Pixel 8) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Mobile Safari/537.36");
        assert_eq!(phone.os.as_deref(), Some("Android 14"));
        assert_eq!(phone.device, UaDevice::Mobile);

        let tablet = Ua::parse("Mozilla/5.0 (Linux; Android 13; SM-X710) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36");
        assert_eq!(tablet.device, UaDevice::Tablet);
    }

    #[test]
    fn wechat_webview_wins_over_chrome_core() {
        let info = Ua::parse("Mozilla/5.0 (Linux; Android 14; HUAWEI) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/116.0.0.0 Mobile Safari/537.36 XWEB/1160065 MicroMessenger/8.0.47.2560(0x28002F35) WeChat/arm64");
        assert_eq!(info.browser.as_deref(), Some("WeChat 8.0.47.2560"));
        assert_eq!(info.device, UaDevice::Mobile);
        assert!(!info.bot, "微信 WebView 是真实用户,不应判为爬虫");
    }

    #[test]
    fn mac_safari_and_firefox() {
        let info = Ua::parse("Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.1 Safari/605.1.15");
        assert_eq!(info.browser.as_deref(), Some("Safari 17.1"));
        assert_eq!(info.os.as_deref(), Some("macOS 10.15.7"));

        let ff = Ua::parse("Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) Gecko/20100101 Firefox/119.0");
        assert_eq!(ff.browser.as_deref(), Some("Firefox 119.0"));
        assert_eq!(ff.device, UaDevice::Desktop);
    }

    #[test]
    fn edge_ie_opera() {
        let edge = Ua::parse("Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36 Edg/120.0.2210.91");
        assert_eq!(edge.browser.as_deref(), Some("Edge 120.0.2210.91"));

        let ie = Ua::parse("Mozilla/5.0 (Windows NT 6.1; Trident/7.0; rv:11.0) like Gecko");
        assert_eq!(ie.browser.as_deref(), Some("IE 11.0"));
        assert_eq!(ie.os.as_deref(), Some("Windows 7"));

        let opera = Ua::parse("Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36 OPR/105.0.0.0");
        assert_eq!(opera.browser.as_deref(), Some("Opera 105.0.0.0"));
    }

    #[test]
    fn bots_detected() {
        for ua in [
            "Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)",
            "Mozilla/5.0 (compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm)",
            "Mozilla/5.0 (compatible; Baiduspider/2.0; +http://www.baidu.com/search/spider.html)",
            "curl/8.4.0",
            "Wget/1.21.4 (linux-gnu)",
            "python-requests/2.31.0",
            "okhttp/4.12.0",
            "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) HeadlessChrome/120.0.0.0 Safari/537.36",
        ] {
            let info = Ua::parse(ua);
            assert!(info.bot, "应识别为爬虫/自动化客户端: {ua}");
            assert_eq!(info.device, UaDevice::Bot);
            assert!(info.is_bot());
        }
        // HeadlessChrome 同时给出浏览器名与版本
        assert_eq!(
            Ua::parse("Mozilla/5.0 (X11; Linux x86_64) HeadlessChrome/120.0.0.0")
                .browser
                .as_deref(),
            Some("HeadlessChrome 120.0.0.0")
        );
    }

    #[test]
    fn windows_phone_version_and_ie_mobile() {
        let info = Ua::parse("Mozilla/5.0 (Windows Phone 10.0; Android 6.0.1; Microsoft; RM-1113) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/52.0.2743.116 Mobile Safari/537.36 Edge/14.14841");
        assert_eq!(info.os.as_deref(), Some("Windows Phone 10.0"));
        assert_eq!(info.device, UaDevice::Mobile);

        // 老 WinPhone 形态(标记后不是数字)退回无版本名,不误吞后文
        let old = Ua::parse("Mozilla/5.0 (compatible; MSIE 9.0; Windows Phone OS 7.5; Trident/5.0; IEMobile/9.0; NOKIA; Lumia 800)");
        assert_eq!(old.os.as_deref(), Some("Windows Phone"));
        assert_eq!(old.browser.as_deref(), Some("IE 9.0"));
    }

    #[test]
    fn empty_and_unknown() {
        let info = Ua::parse("");
        assert_eq!(info.browser, None);
        assert_eq!(info.os, None);
        assert_eq!(info.device, UaDevice::Unknown);
        assert!(!info.bot);
    }

    #[test]
    fn json_serializable_for_audit_extra() {
        let info = Ua::parse("Mozilla/5.0 (iPhone; CPU iPhone OS 17_2 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.0 Mobile/15E148 Safari/604.1");
        let v = serde_json::to_value(&info).unwrap();
        assert_eq!(v["device"], "mobile");
        assert_eq!(v["os"], "iOS 17.2");
    }
}