Skip to content

Migrator

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 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.

MigratorProcessesManager

Bases: ProcessesManagerBase

Provides the migrator manager.

Source code in PyFunceble/cli/processes/migrator.py
class MigratorProcessesManager(ProcessesManagerBase):
    """
    Provides the migrator manager.
    """

    WORKER_OBJ: 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 create(self) -> "ProcessesManagerBase":
        for method in dir(self):
            if not method.endswith("_target"):
                continue

            worker = MigratorWorker(
                None,
                name=f"pyfunceble_{method}",
                daemon=True,
                continuous_integration=self.continuous_integration,
            )

            worker.target = getattr(self, method)

            self._created_workers.append(worker)
            PyFunceble.facility.Logger.info("Created worker for %r", method)

    @ProcessesManagerBase.ensure_worker_obj_is_given
    @ProcessesManagerBase.create_workers_if_missing
    def start(self) -> "ProcessesManagerBase":
        # We start the migration (as a standalone)
        Alembic(self._created_workers[0].db_session).upgrade()

        return super().start()

csv_file_add_registrar_column_target(continuous_integration) staticmethod

Provides the target for the addition of the registrar column.

Source code in PyFunceble/cli/processes/migrator.py
@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."
        )

csv_file_delete_source_column_target(continuous_integration) staticmethod

Provides the target for the deletion of the source column.

Source code in PyFunceble/cli/processes/migrator.py
@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."
        )

hashes_file_cleanup_target(continuous_integration) staticmethod

Provides the target for the cleanup of the hashes file.

Source code in PyFunceble/cli/processes/migrator.py
@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."
        )

json2csv_inactive_target(continuous_integration) staticmethod

Provides the target for the inactive database migrator.

Source code in PyFunceble/cli/processes/migrator.py
@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."
        )

json2csv_whois_target(continuous_integration) staticmethod

Provides the target for the whois database migrator.

Source code in PyFunceble/cli/processes/migrator.py
@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."
        )

mariadb_file_and_status_target(continuous_integration, *, db_session=None) staticmethod

Provides the target for the migration of the :code:pyfunceble_file and :code:pyfunceble_status tables.

Source code in PyFunceble/cli/processes/migrator.py
@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."
        )

mariadb_whois_record_idna_subject_target(continuous_integration, *, db_session=None) staticmethod

Provides the target for the whois addition of the missing idna_subject column.

Source code in PyFunceble/cli/processes/migrator.py
@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."
        )

mining_file_cleanup_target(continuous_integration) staticmethod

Provides the target for the cleanup of the mining file.

Source code in PyFunceble/cli/processes/migrator.py
@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."
        )

production_config_file_cleanup_target(continuous_integration) staticmethod

Provides the target for the cleanup of the production configuration file.

Source code in PyFunceble/cli/processes/migrator.py
@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."
        )