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
|
"""
The tool to check the availability or syntax of domain, IP or URL.
::
██████╗ ██╗ ██╗███████╗██╗ ██╗███╗ ██╗ ██████╗███████╗██████╗ ██╗ ███████╗
██╔══██╗╚██╗ ██╔╝██╔════╝██║ ██║████╗ ██║██╔════╝██╔════╝██╔══██╗██║ ██╔════╝
██████╔╝ ╚████╔╝ █████╗ ██║ ██║██╔██╗ ██║██║ █████╗ ██████╔╝██║ █████╗
██╔═══╝ ╚██╔╝ ██╔══╝ ██║ ██║██║╚██╗██║██║ ██╔══╝ ██╔══██╗██║ ██╔══╝
██║ ██║ ██║ ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝
Provides our very own argument parser. Take this as a splitter which runs
some actions against other resource before returning the arguments.
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 os
import sys
import traceback
import colorama
import PyFunceble.cli.facility
import PyFunceble.cli.factory
import PyFunceble.cli.storage
import PyFunceble.facility
import PyFunceble.helpers.exceptions
import PyFunceble.storage
from PyFunceble.cli.continuous_integration.exceptions import StopExecution
from PyFunceble.cli.system.base import SystemBase
from PyFunceble.helpers.dict import DictHelper
class SystemIntegrator(SystemBase):
"""
Provides our system integrator. The idea is that we given an argparse
Namespace, we should be able to parse it into our system.
To simplify the trick and headache in the CLI management, I explicitly
mapped the :code:`dest` argument to what we are supposed to have in the
flatten version of the configuration. That way, we only need to compare
against the flatten version instead of looping over all possible levels
of the configuration tree.
"""
@SystemBase.ensure_args_is_given
def init_logger(self) -> "SystemIntegrator":
"""
Initiate the loggers. In fact, before this moment, in a normal case
the logger was not properly initiated.
To avoid multiple management place, I took it to the essential.
.. warning::
If you plan to play with the logger on your own, be sure to
follow the same procedure.
"""
PyFunceble.facility.Logger.set_output_directory(
os.path.join(
PyFunceble.cli.storage.OUTPUT_DIRECTORY,
PyFunceble.cli.storage.STD_LOGGING_DIRNAME,
)
)
if hasattr(self.args, "debug__active") and self.args.debug__active:
PyFunceble.facility.Logger.set_activated(True)
if hasattr(self.args, "debug__level") and self.args.debug__level:
PyFunceble.facility.Logger.set_min_level(self.args.debug__level)
PyFunceble.facility.Logger.set_activated(True)
if not PyFunceble.facility.Logger.activated:
PyFunceble.facility.Logger.guess_all_settings()
# We do this because the starting point is here under the CLI :-)
PyFunceble.facility.Logger.init_loggers()
@SystemBase.ensure_args_is_given
def inject_into_config(self) -> "SystemIntegrator":
"""
Injects the configuration variables into the configuration after
comparing each value with the current one.
"""
PyFunceble.facility.Logger.info(
"Started to inject arguments info configuration."
)
dict_helper = DictHelper(PyFunceble.storage.CONFIGURATION)
flatten_config = dict_helper.flatten()
to_update = {}
reserved_lookup_mode = []
for key, value in vars(self.args).items():
if value in (False, None):
continue
if "__" in key:
key = key.replace("__", ".")
if key in flatten_config:
if isinstance(flatten_config[key], bool) and isinstance(value, bool):
to_update[key] = not flatten_config[key]
else:
to_update[key] = value
elif key.startswith("self_contained") and "lookup" in key:
reserved_lookup_mode.append(key[key.rfind(".") + 1 :])
if reserved_lookup_mode:
for lookup_key in PyFunceble.storage.CONFIGURATION.lookup.keys():
if lookup_key in {"timeout"}:
continue
if lookup_key not in reserved_lookup_mode:
to_update[f"lookup.{lookup_key}"] = False
else:
to_update[f"lookup.{lookup_key}"] = True
dict_helper.set_subject(to_update)
unflatten_to_update = dict_helper.unflatten()
# We assume that the configuration was already loaded.
PyFunceble.facility.ConfigLoader.custom_config = unflatten_to_update
PyFunceble.facility.Logger.debug(
"Injected into config: %r", unflatten_to_update
)
PyFunceble.facility.Logger.info(
"Finished to inject arguments info configuration."
)
return self
@SystemBase.ensure_args_is_given
def check_config(self) -> "SystemIntegrator":
"""
Checks or do some sanity check of the configuration.
This method will basically check that the common mistakes while mixing
configuration and CLI arguments are not found.
.. warning::
The messages are not directly printed, but rather stored in the
PyFunceble.cli.storage.EXTRA_MESSAGES list.
"""
if (
not PyFunceble.storage.CONFIGURATION.cli_testing.file_generation.hosts
and not PyFunceble.storage.CONFIGURATION.cli_testing.file_generation.plain
):
PyFunceble.cli.storage.EXTRA_MESSAGES.append(
f"{colorama.Style.BRIGHT}{colorama.Fore.MAGENTA}Your setup won't "
"generate any output! "
"Reason: file_generation.hosts and file_generation.plain are "
"both disabled."
)
if "url_base" in PyFunceble.storage.CONFIGURATION.platform:
PyFunceble.cli.storage.EXTRA_MESSAGES.append(
f"{colorama.Style.BRIGHT}{colorama.Fore.MAGENTA}Your are still "
"defining the 'platform.url_base' configuration key which has "
"been deprecated and deleted. Please remove it from your "
"configuration file."
)
if (
"collection" in PyFunceble.storage.CONFIGURATION
or "collection" in PyFunceble.storage.CONFIGURATION.lookup
):
PyFunceble.cli.storage.EXTRA_MESSAGES.append(
f"{colorama.Style.BRIGHT}{colorama.Fore.MAGENTA}The 'collection' "
"configuration key is not supported anymore. Please switch to "
"'platform'."
)
if "PYFUNCEBLE_COLLECTION_API_TOKEN" in os.environ:
PyFunceble.cli.storage.EXTRA_MESSAGES.append(
f"{colorama.Style.BRIGHT}{colorama.Fore.MAGENTA}The "
"'PYFUNCEBLE_COLLECTION_API_TOKEN' environment variable is not "
"supported anymore. Please switch to 'PYFUNCEBLE_PLATFORM_API_TOKEN'."
)
if "PYFUNCEBLE_COLLECTION_API_URL" in os.environ:
PyFunceble.cli.storage.EXTRA_MESSAGES.append(
f"{colorama.Style.BRIGHT}{colorama.Fore.MAGENTA}The "
"'PYFUNCEBLE_COLLECTION_API_URL' environment variable is not "
"supported anymore. Please switch to 'PYFUNCEBLE_PLATFORM_API_URL'."
)
@SystemBase.ensure_args_is_given
def check_deprecated(self) -> "SystemIntegrator":
"""
Checks or do some deprecation checks.
This method will basically check if deprecated keys are still given and
provide guidance for end-users.
!!! warning
The messages are not directly printed, but rather stored in the
PyFunceble.cli.storage.EXTRA_MESSAGES list.
"""
if "adblock_aggressive" in PyFunceble.storage.CONFIGURATION.cli_decoding:
PyFunceble.cli.storage.EXTRA_MESSAGES.append(
f"{colorama.Style.BRIGHT}{colorama.Fore.MAGENTA}The "
"'cli_decoding.adblock_aggressive' configuration key has been "
"replaced by the 'cli_decoding.aggressive' key but you are "
"still setting it."
)
@SystemBase.ensure_args_is_given
def start(self) -> "SystemIntegrator":
"""
Starts a group of actions provided by this interface.
"""
try:
self.init_logger()
if hasattr(self.args, "output_location") and self.args.output_location:
PyFunceble.cli.storage.OUTPUT_DIRECTORY = os.path.realpath(
os.path.join(
self.args.output_location,
PyFunceble.cli.storage.OUTPUTS.parent_directory,
)
)
if hasattr(self.args, "config_dir") and self.args.config_dir:
PyFunceble.facility.ConfigLoader.set_config_dir(self.args.config_dir)
PyFunceble.storage.CONFIG_DIRECTORY = self.args.config_dir
if hasattr(self.args, "config_file") and self.args.config_file:
PyFunceble.facility.ConfigLoader.set_remote_config_location(
self.args.config_file
).reload()
PyFunceble.facility.Logger.debug("Given arguments:\n%r", self.args)
self.inject_into_config()
self.check_config()
self.check_deprecated()
PyFunceble.cli.facility.CredentialLoader.start()
PyFunceble.cli.factory.DBSession.init_db_sessions()
except (KeyboardInterrupt, StopExecution):
pass
except Exception as exception: # pylint: disable=broad-except
PyFunceble.facility.Logger.critical(
"Fatal error.",
exc_info=True,
)
if isinstance(exception, PyFunceble.helpers.exceptions.UnableToDownload):
message = (
f"{colorama.Fore.RED}{colorama.Style.BRIGHT}Unable to download "
f"{exception}"
)
else:
message = (
f"{colorama.Fore.RED}{colorama.Style.BRIGHT}Fatal Error: "
f"{exception}"
)
print(message)
if PyFunceble.facility.Logger.authorized:
print(traceback.format_exc())
sys.exit(1)
return self
|
