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
|
"""
The tool to check the availability or syntax of domain, IP or URL.
::
██████╗ ██╗ ██╗███████╗██╗ ██╗███╗ ██╗ ██████╗███████╗██████╗ ██╗ ███████╗
██╔══██╗╚██╗ ██╔╝██╔════╝██║ ██║████╗ ██║██╔════╝██╔════╝██╔══██╗██║ ██╔════╝
██████╔╝ ╚████╔╝ █████╗ ██║ ██║██╔██╗ ██║██║ █████╗ ██████╔╝██║ █████╗
██╔═══╝ ╚██╔╝ ██╔══╝ ██║ ██║██║╚██╗██║██║ ██╔══╝ ██╔══██╗██║ ██╔══╝
██║ ██║ ██║ ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝
Provides our tester worker. This is the description of a single tester worker.
Author:
Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom
Special thanks:
https://pyfunceble.github.io/#/special-thanks
Contributors:
https://pyfunceble.github.io/#/contributors
Project link:
https://github.com/funilrys/PyFunceble
Project documentation:
https://docs.pyfunceble.com
Project homepage:
https://pyfunceble.github.io/
License:
::
Copyright 2017, 2018, 2019, 2020, 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
https://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.
"""
import time
from typing import Any, Optional, Tuple
import PyFunceble.cli.utils.testing
import PyFunceble.facility
from PyFunceble.checker.availability.domain_and_ip import DomainAndIPAvailabilityChecker
from PyFunceble.checker.availability.url import URLAvailabilityChecker
from PyFunceble.checker.base import CheckerBase
from PyFunceble.checker.reputation.domain_and_ip import DomainAndIPReputationChecker
from PyFunceble.checker.reputation.url import URLReputationChecker
from PyFunceble.checker.syntax.domain_and_ip import DomainAndIPSyntaxChecker
from PyFunceble.checker.syntax.ip import IPSyntaxChecker
from PyFunceble.checker.syntax.url import URLSyntaxChecker
from PyFunceble.cli.processes.workers.base import WorkerBase
from PyFunceble.cli.utils.stdout import print_single_line
from PyFunceble.dataset.autocontinue.base import ContinueDatasetBase
from PyFunceble.dataset.autocontinue.csv import CSVContinueDataset
from PyFunceble.dataset.inactive.base import InactiveDatasetBase
from PyFunceble.helpers.regex import RegexHelper
class TesterWorker(WorkerBase):
"""
Provides our tester worker. The objective of this worker is to provides
a single worker (or process if you prefer) which will be used to handle
the tests.
"""
continue_dataset: Optional[ContinueDatasetBase] = None
inactive_dataset: Optional[InactiveDatasetBase] = None
testing_object: Optional[CheckerBase] = None
known_testing_objects: dict = {}
initiated_testing_objects: dict = {}
def perform_external_poweron_checks(self) -> None:
result = super().perform_external_poweron_checks()
self.continue_dataset = (
PyFunceble.cli.utils.testing.get_continue_dataset_object(
db_session=self.db_session
)
)
self.inactive_dataset = (
PyFunceble.cli.utils.testing.get_inactive_dataset_object(
db_session=self.db_session
)
)
self.known_testing_objects = {
"SYNTAX": {"domain": DomainAndIPSyntaxChecker, "url": URLSyntaxChecker},
"AVAILABILITY": {
"domain": DomainAndIPAvailabilityChecker,
"url": URLAvailabilityChecker,
},
"REPUTATION": {
"domain": DomainAndIPReputationChecker,
"url": URLReputationChecker,
},
}
self.initiated_testing_objects = {
"SYNTAX": {"domain": None, "url": None},
"AVAILABILITY": {
"domain": None,
"url": None,
},
"REPUTATION": {
"domain": None,
"url": None,
},
}
return result
@staticmethod
def should_be_ignored(subject: str) -> bool:
"""
Checks if the given subject should be ignored.
"""
# pylint: disable=line-too-long
regex_ignore = r"localhost$|localdomain$|local$|broadcasthost$|0\.0\.0\.0$|allhosts$|allnodes$|allrouters$|localnet$|loopback$|mcastprefix$|ip6-mcastprefix$|ip6-localhost$|ip6-loopback$|ip6-allnodes$|ip6-allrouters$|ip6-localnet$"
if RegexHelper(regex_ignore).match(subject, return_match=False):
PyFunceble.facility.Logger.info(
"Ignoring %r because it is in our default regex.", subject
)
return True
if (
not PyFunceble.storage.CONFIGURATION.cli_testing.local_network
and IPSyntaxChecker(subject).is_reserved()
):
PyFunceble.facility.Logger.info(
"Ignoring %r because it is a reserved IP and we are not testing "
"for/in a local network.",
subject,
)
return True
if bool(
PyFunceble.storage.CONFIGURATION.cli_testing.file_filter
) and not RegexHelper(
PyFunceble.storage.CONFIGURATION.cli_testing.file_filter
).match(
subject, return_match=False
):
PyFunceble.facility.Logger.info(
"Ignoring %r because it does not match the filter to look for.",
subject,
)
return True
PyFunceble.facility.Logger.info(
"Allowed to test %r.",
subject,
)
return False
def _init_testing_object(
self, subject_type: str, checker_type: str
) -> Optional[CheckerBase]:
"""
Provides the object to use for testing.
:raise ValueError:
When the given subject type is unknown.
"""
if checker_type not in self.known_testing_objects:
raise ValueError(f"<testing_mode> ({checker_type!r}) is unknown.")
if subject_type not in self.known_testing_objects[checker_type]:
raise ValueError(f"<subject_type> ({subject_type!r}) is unknown.")
if not self.initiated_testing_objects[checker_type][subject_type]:
self.initiated_testing_objects[checker_type][
subject_type
] = self.known_testing_objects[checker_type][subject_type](
db_session=self.db_session
).set_do_syntax_check_first(
# We want to always check the syntax first (ONLY UNDER THE CLI)
not bool(PyFunceble.storage.CONFIGURATION.cli_testing.local_network)
)
self.testing_object = self.initiated_testing_objects[checker_type][subject_type]
return self.testing_object
def target(self, consumed: dict) -> Optional[Tuple[Any, ...]]:
"""
This the target that is run to process something.
This method should return a result which will pu send to the output
queue.
"""
if "Connection" not in self.requester.headers:
# Just close the connection immediately. This prevent potential infinite
# streams.
self.requester.session.headers["Connection"] = "close"
if not isinstance(consumed, dict):
PyFunceble.facility.Logger.debug(
"Skipping latest dataset because consumed data was not a dictionary."
)
return None
# Just for human brain.
test_dataset = consumed
if self.should_be_ignored(test_dataset["idna_subject"]):
# X means that it was ignored because of our core ignore procedure.
print_single_line("X")
return None
if PyFunceble.storage.CONFIGURATION.cli_testing.cooldown_time > 0:
PyFunceble.facility.Logger.info(
"Sleeping: %rs for our own safety :-)",
PyFunceble.storage.CONFIGURATION.cli_testing.cooldown_time,
)
# Apply cooldowntime.
time.sleep(PyFunceble.storage.CONFIGURATION.cli_testing.cooldown_time)
PyFunceble.facility.Logger.info(
"Slept: %rs for our own safety :-)",
PyFunceble.storage.CONFIGURATION.cli_testing.cooldown_time,
)
if test_dataset["type"] != "single":
if test_dataset["output_dir"] and "from_preload" not in test_dataset:
if isinstance(self.continue_dataset, CSVContinueDataset):
self.continue_dataset.set_base_directory(test_dataset["output_dir"])
if self.continue_dataset.exists(test_dataset):
# A means that it was ignored because of the continue
# logic.
PyFunceble.facility.Logger.info(
"Ignoring %r because it was already tested previously "
"(continue).",
test_dataset["idna_subject"],
)
PyFunceble.cli.utils.stdout.print_single_line("A")
return None
if "from_inactive" not in test_dataset and self.inactive_dataset.exists(
test_dataset
):
# "I" means that it was ignored because of the inactive (db)
# logic.
PyFunceble.facility.Logger.info(
"Ignoring %r because it was already tested previously "
"(inactive).",
test_dataset["idna_subject"],
)
PyFunceble.cli.utils.stdout.print_single_line("I")
return test_dataset, "ignored_inactive"
PyFunceble.facility.Logger.info(
"Started test of %r.",
test_dataset["idna_subject"],
)
self._init_testing_object(
test_dataset["subject_type"], test_dataset["checker_type"]
)
result = (
self.testing_object.set_subject(test_dataset["idna_subject"])
.query_status()
.get_status()
)
PyFunceble.facility.Logger.info(
"Successfully handled %r.",
test_dataset["idna_subject"],
)
PyFunceble.facility.Logger.debug("Got status:\n%r.", result)
return test_dataset, result
|
