tivilsta 0.5.3

A different whitelisting mechanism for blocklist maintainers.
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

// Tivilsta - A different whitelisting mechanism
//
// Author:
//      Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom
//
// License:
//      Copyright (c) 2022, 2023, 2024, 2025 Nissar Chababy
//
//      Licensed under the Apache License, Version 2.0 (the "License");
//      you may not use this file except in compliance with the License.
//      You may obtain a copy of the License at
//
//          http://www.apache.org/licenses/LICENSE-2.0
//
//      Unless required by applicable law or agreed to in writing, software
//      distributed under the License is distributed on an "AS IS" BASIS,
//      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//      See the License for the specific language governing permissions and
//      limitations under the License.

#![allow(dead_code)]

use serde_json::Value;
use std::collections::HashMap;

use crate::utils;

/// Fetches the PSL registry of the PyFunceble project and provide the `reqwest` response
/// for other to use.
fn fetch_mapping() -> Result<reqwest::blocking::Response, Box<dyn std::error::Error>> {
    utils::fetch_url(
        &String::from(
            "https://raw.githubusercontent.com/PyFunceble/public-suffix/master/public-suffix.json",
        ),
        "Failed to fetch PSL. Is GitHub down?".to_string(),
    )
}

/// Fetches the PSL registry of the PyFunceble project, parse it and return
/// all known TLDs.
pub fn extensions() -> Result<Vec<String>, Box<dyn std::error::Error>> {
    let response: Value = fetch_mapping()?.json()?;
    let mut result: Vec<String> = Vec::new();

    for (extension, _) in response.as_object().unwrap() {
        result.push(extension.to_string());
    }
    Ok(result)
}

/// Fetches the PSL registry of the PyFunceble project, parse it and return
/// all known public suffixes.
pub fn suffixes() -> Result<Vec<String>, Box<dyn std::error::Error>> {
    let response: Value = fetch_mapping()?.json()?;
    let mut result: Vec<String> = Vec::new();

    for (_, suffixes) in response.as_object().unwrap() {
        for suffix in suffixes.as_array().unwrap() {
            result.push(suffix.as_str().unwrap().to_string());
        }
    }
    Ok(result)
}

/// Get all known suffixes and parse them as a huge Regex String with the following
/// format:
///
/// ```txt
/// ((?:\.(?:\.co\.uk)))|((?:\.(?:de.example)))
/// ```
///
/// Where `co.uk` and `de.example` are suffixes.
pub fn suffixes_regex_string() -> String {
    utils::to_regex_string(suffixes())
}

/// Get all known suffixes and parse them as a huge Regex String with the following
/// format:
///
/// ```txt
/// ((?:\.(?:com)))|((?:\.(?:de)))
/// ```
///
/// Where `com` and `de` are TLDs.
pub fn extensions_regex_string() -> String {
    utils::to_regex_string(extensions())
}

/// Read the IANA registry of the PyFunceble project and return all known
/// TLDs and their whois server.
///
/// The registry is a JSON file that has the following format:
///
/// ```json
/// {
///     "com": {
///         "xx.com",
///         "xy.com"
///     }
/// }
/// ```
///
/// Where `com` is the Top Level Domain (TlD) and `xx.com`+`xy.com` public suffixes.

pub fn extensions_and_suffixes() -> Result<HashMap<String, Vec<String>>, Box<dyn std::error::Error>>
{
    let response: Value = fetch_mapping()?.json()?;
    let mut result: HashMap<String, Vec<String>> = HashMap::new();

    for (extension, suffixes) in response.as_object().unwrap() {
        result.insert(
            extension.to_string(),
            suffixes
                .as_array()
                .unwrap()
                .iter()
                .map(|suffix| suffix.as_str().unwrap().to_string())
                .collect(),
        );
    }
    Ok(result)
}