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
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
|
"""
The tool to check the availability or syntax of domain, IP or URL.
::
██████╗ ██╗ ██╗███████╗██╗ ██╗███╗ ██╗ ██████╗███████╗██████╗ ██╗ ███████╗
██╔══██╗╚██╗ ██╔╝██╔════╝██║ ██║████╗ ██║██╔════╝██╔════╝██╔══██╗██║ ██╔════╝
██████╔╝ ╚████╔╝ █████╗ ██║ ██║██╔██╗ ██║██║ █████╗ ██████╔╝██║ █████╗
██╔═══╝ ╚██╔╝ ██╔══╝ ██║ ██║██║╚██╗██║██║ ██╔══╝ ██╔══██╗██║ ██╔══╝
██║ ██║ ██║ ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝
Provides the migrator manager.
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.
"""
from typing import Optional
import colorama
from sqlalchemy.orm import Session
import PyFunceble.cli.utils.stdout
import PyFunceble.cli.utils.testing
import PyFunceble.facility
import PyFunceble.storage
from PyFunceble.cli.continuous_integration.base import ContinuousIntegrationBase
from PyFunceble.cli.migrators.alembic import Alembic
from PyFunceble.cli.migrators.csv_file.inactive_source_delete import (
InactiveDatasetDeleteSourceColumnMigrator,
)
from PyFunceble.cli.migrators.csv_file.whois_registrar_add import (
WhoisDatasetAddRegistrarColumnMigrator,
)
from PyFunceble.cli.migrators.file_cleanup.hashes_file import HashesFileCleanupMigrator
from PyFunceble.cli.migrators.file_cleanup.mining_file import MiningFileCleanupMigrator
from PyFunceble.cli.migrators.file_cleanup.production_config_file import (
ProductionConfigFileCleanupMigrator,
)
from PyFunceble.cli.migrators.json2csv.inactive import InactiveJSON2CSVMigrator
from PyFunceble.cli.migrators.json2csv.whois import WhoisJSON2CSVMigrator
from PyFunceble.cli.migrators.mariadb.file_and_status import FileAndStatusMigrator
from PyFunceble.cli.migrators.mariadb.whois_record_idna_subject import (
WhoisRecordIDNASubjectMigrator,
)
from PyFunceble.cli.processes.base import ProcessesManagerBase
from PyFunceble.cli.processes.workers.migrator import MigratorWorker
from PyFunceble.helpers.file import FileHelper
class MigratorProcessesManager(ProcessesManagerBase):
"""
Provides the migrator manager.
"""
STD_NAME: str = "pyfunceble_migrator_worker"
WORKER_CLASS: MigratorWorker = MigratorWorker
@staticmethod
def json2csv_inactive_target(
continuous_integration: ContinuousIntegrationBase,
) -> None:
"""
Provides the target for the inactive database migrator.
"""
migrator = InactiveJSON2CSVMigrator(print_action_to_stdout=True)
migrator.continuous_integration = continuous_integration
if FileHelper(migrator.source_file).exists():
print(
f"{colorama.Fore.MAGENTA}{colorama.Style.BRIGHT}"
"Started migration (json2csv) of the inactive dataset."
)
migrator.start()
if migrator.done:
print(
f"\n{colorama.Fore.GREEN}{colorama.Style.BRIGHT}"
"Finished migration (json2csv) of the inactive dataset."
)
else:
print(
f"\n{colorama.Fore.MAGENTA}{colorama.Style.BRIGHT}"
"Unfinished migration (json2csv) of the inactive dataset."
)
else:
PyFunceble.facility.Logger.info(
"Stopped json2csv_inactive_target. File does not exist."
)
@staticmethod
def json2csv_whois_target(
continuous_integration: ContinuousIntegrationBase,
) -> None:
"""
Provides the target for the whois database migrator.
"""
migrator = WhoisJSON2CSVMigrator(print_action_to_stdout=True)
migrator.continuous_integration = continuous_integration
if FileHelper(migrator.source_file).exists():
print(
f"{colorama.Fore.MAGENTA}{colorama.Style.BRIGHT}"
"Started migration (json2csv) of the whois dataset."
)
migrator.start()
if migrator.done:
print(
f"\n{colorama.Fore.GREEN}{colorama.Style.BRIGHT}"
"Finished migration (json2csv) of the whois dataset."
)
else:
print(
f"\n{colorama.Fore.MAGENTA}{colorama.Style.BRIGHT}"
"Unfinished migration (json2csv) of the whois dataset."
)
else:
PyFunceble.facility.Logger.info(
"Stopped json2csv_whois_target. File does not exist."
)
@staticmethod
def mariadb_whois_record_idna_subject_target(
continuous_integration: ContinuousIntegrationBase,
*,
db_session: Optional[Session] = None,
) -> None:
"""
Provides the target for the whois addition of the missing
idna_subject column.
"""
migrator = WhoisRecordIDNASubjectMigrator(print_action_to_stdout=True)
migrator.continuous_integration = continuous_integration
migrator.db_session = db_session
if migrator.authorized:
print(
f"{colorama.Fore.MAGENTA}{colorama.Style.BRIGHT}"
"Started completion of NULL idna_subject(s) into the whois dataset."
)
migrator.start()
if migrator.done:
print(
f"{colorama.Fore.GREEN}{colorama.Style.BRIGHT}"
"Finished completion of NULL idna_subject(s) into "
"the whois dataset."
)
else:
print(
f"{colorama.Fore.MAGENTA}{colorama.Style.BRIGHT}"
"Unfinished completion of NULL idna_subject(s) into "
"the whois dataset."
)
else:
PyFunceble.facility.Logger.info(
"Stopped mariadb_whois_record_idna_subject_target. Not authorized."
)
@staticmethod
def mariadb_file_and_status_target(
continuous_integration: ContinuousIntegrationBase,
*,
db_session: Optional[Session] = None,
) -> None:
"""
Provides the target for the migration of the :code:`pyfunceble_file`
and :code:`pyfunceble_status` tables.
"""
migrator = FileAndStatusMigrator(print_action_to_stdout=True)
migrator.continuous_integration = continuous_integration
migrator.db_session = db_session
if migrator.authorized:
print(
f"{colorama.Fore.MAGENTA}{colorama.Style.BRIGHT}"
"Started migration of the pyfunceble_file and "
"pyfunceble_status tables."
)
migrator.start()
if migrator.done:
print(
f"{colorama.Fore.GREEN}{colorama.Style.BRIGHT}"
"Finished migration of the pyfunceble_file and "
"pyfunceble_status tables."
)
else:
print(
f"{colorama.Fore.MAGENTA}{colorama.Style.BRIGHT}"
"Unfinished migration of the pyfunceble_file and "
"pyfunceble_status tables."
)
else:
PyFunceble.facility.Logger.info(
"Stopped mariadb_file_and_status_target. Not authorized."
)
@staticmethod
def hashes_file_cleanup_target(
continuous_integration: ContinuousIntegrationBase,
) -> None:
"""
Provides the target for the cleanup of the hashes file.
"""
migrator = HashesFileCleanupMigrator(print_action_to_stdout=True)
migrator.continuous_integration = continuous_integration
if FileHelper(migrator.source_file).exists():
print(
f"{colorama.Fore.MAGENTA}{colorama.Style.BRIGHT}"
f"Started deletion of {migrator.source_file!r}."
)
migrator.start()
if migrator.done:
print(
f"{colorama.Fore.GREEN}{colorama.Style.BRIGHT}"
f"Finished deletion of {migrator.source_file!r}."
)
else:
print(
f"{colorama.Fore.MAGENTA}{colorama.Style.BRIGHT}"
f"Unfinished deletion of {migrator.source_file!r}."
)
else:
PyFunceble.facility.Logger.info(
"Stopped hashes_file_cleanup_target. File does not exist."
)
@staticmethod
def production_config_file_cleanup_target(
continuous_integration: ContinuousIntegrationBase,
) -> None:
"""
Provides the target for the cleanup of the production configuration file.
"""
migrator = ProductionConfigFileCleanupMigrator(print_action_to_stdout=True)
migrator.continuous_integration = continuous_integration
if FileHelper(migrator.source_file).exists():
print(
f"{colorama.Fore.MAGENTA}{colorama.Style.BRIGHT}"
f"Started deletion of {migrator.source_file!r}."
)
migrator.start()
if migrator.done:
print(
f"{colorama.Fore.GREEN}{colorama.Style.BRIGHT}"
f"Finished deletion of {migrator.source_file!r}."
)
else:
print(
f"{colorama.Fore.MAGENTA}{colorama.Style.BRIGHT}"
f"Unfinished deletion of {migrator.source_file!r}."
)
else:
PyFunceble.facility.Logger.info(
"Stopped production_config_file_cleanup_target. File does not exist."
)
@staticmethod
def mining_file_cleanup_target(
continuous_integration: ContinuousIntegrationBase,
) -> None:
"""
Provides the target for the cleanup of the mining file.
"""
migrator = MiningFileCleanupMigrator(print_action_to_stdout=True)
migrator.continuous_integration = continuous_integration
if FileHelper(migrator.source_file).exists():
print(
f"{colorama.Fore.MAGENTA}{colorama.Style.BRIGHT}"
f"Started deletion of {migrator.source_file!r}."
)
migrator.start()
if migrator.done:
print(
f"{colorama.Fore.GREEN}{colorama.Style.BRIGHT}"
f"Finished deletion of {migrator.source_file!r}."
)
else:
print(
f"{colorama.Fore.MAGENTA}{colorama.Style.BRIGHT}"
f"Unfinished deletion of {migrator.source_file!r}."
)
else:
PyFunceble.facility.Logger.info(
"Stopped hashes_file_cleanup_target. File does not exist."
)
@staticmethod
def csv_file_delete_source_column_target(
continuous_integration: ContinuousIntegrationBase,
) -> None:
"""
Provides the target for the deletion of the source column.
"""
migrator = InactiveDatasetDeleteSourceColumnMigrator(
print_action_to_stdout=True
)
migrator.continuous_integration = continuous_integration
file_helper = FileHelper(migrator.source_file)
if file_helper.exists():
with file_helper.open("r", encoding="utf-8") as file_stream:
first_line = next(file_stream)
if any(x in first_line for x in migrator.TO_DELETE):
print(
f"{colorama.Fore.MAGENTA}{colorama.Style.BRIGHT}"
"Started deletion of the 'source' column into "
f"{migrator.source_file!r}."
)
migrator.start()
if migrator.done:
print(
f"{colorama.Fore.GREEN}{colorama.Style.BRIGHT}"
"Finished deletion of the 'source' column into "
f"{migrator.source_file!r}."
)
else:
print(
f"{colorama.Fore.MAGENTA}{colorama.Style.BRIGHT}"
"unfinished deletion of the 'source' column into "
f"{migrator.source_file!r}."
)
else:
PyFunceble.facility.Logger.info(
"Stopped csv_file_delete_source_column_target. File does not exist."
)
@staticmethod
def csv_file_add_registrar_column_target(
continuous_integration: ContinuousIntegrationBase,
) -> None:
"""
Provides the target for the addition of the registrar column.
"""
migrator = WhoisDatasetAddRegistrarColumnMigrator(print_action_to_stdout=True)
migrator.continuous_integration = continuous_integration
file_helper = FileHelper(migrator.source_file)
if file_helper.exists():
with file_helper.open("r", encoding="utf-8") as file_stream:
first_line = next(file_stream)
if any(x not in first_line for x in migrator.TO_ADD):
print(
f"{colorama.Fore.MAGENTA}{colorama.Style.BRIGHT}"
"Started addition of the 'registrar' column into "
f"{migrator.source_file!r}."
)
migrator.start()
if migrator.done:
print(
f"{colorama.Fore.GREEN}{colorama.Style.BRIGHT}"
"Finished addition of the 'registrar' column into "
f"{migrator.source_file!r}."
)
else:
print(
f"{colorama.Fore.MAGENTA}{colorama.Style.BRIGHT}"
"unfinished addition of the 'registrar' column into "
f"{migrator.source_file!r}."
)
else:
PyFunceble.facility.Logger.info(
"Stopped csv_file_add_registrar_column_target. File does not exist."
)
def spawn_workers(self, *, start: bool = False) -> "ProcessesManagerBase":
"""
Spawn the necessary workers.
:param bool start:
Whether we should start the workers or not.
"""
for method in dir(self):
if not method.endswith("_target"):
continue
worker = self.spawn_worker(start=False, daemon=True, force=True)
worker.name = f"pyfunceble_{method}"
worker.target = getattr(self, method)
if start:
worker.start()
self.running_workers.append(worker)
PyFunceble.facility.Logger.info("Created worker for %r", method)
@ProcessesManagerBase.ensure_worker_class_is_set
@ProcessesManagerBase.ensure_worker_spawned
@ProcessesManagerBase.ignore_if_running
def start(self) -> "ProcessesManagerBase":
"""
Starts the migration process.
"""
# We start the migration (as a standalone)
Alembic(self.created_workers[0].db_session).upgrade()
return super().start()
|
