Source code for ucsschool.importer.mass_import.mass_import

#!/usr/bin/python3
# -*- coding: utf-8 -*-
#
# Univention UCS@school
# Copyright 2016-2025 Univention GmbH
#
# https://www.univention.de/
#
# All rights reserved.
#
# The source code of this program is made available
# under the terms of the GNU Affero General Public License version 3
# (GNU AGPL V3) as published by the Free Software Foundation.
#
# Binary versions of this program provided by Univention to you as
# well as other copyrighted, protected or trademarked materials like
# Logos, graphics, fonts, specific documentations and configurations,
# cryptographic keys etc. are subject to a license agreement between
# you and Univention and not subject to the GNU AGPL V3.
#
# In the case you use this program under the terms of the GNU AGPL V3,
# the program is provided in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public
# License with the Debian GNU/Linux or Univention distribution in file
# /usr/share/common-licenses/AGPL-3; if not, see
# <http://www.gnu.org/licenses/>.

"""Default mass import class."""

import datetime
import logging
from typing import TYPE_CHECKING, Optional, TypeVar  # noqa: F401

from ucsschool.lib.models.utils import stopped_notifier

from ..configuration import Configuration
from ..exceptions import UcsSchoolImportError, UcsSchoolImportFatalError
from ..factory import Factory
from ..utils.import_pyhook import run_import_pyhooks
from ..utils.pre_read_pyhook import PreReadPyHook
from ..utils.result_pyhook import ResultPyHook
from ..utils.utils import nullcontext

if TYPE_CHECKING:
    from ..utils.import_pyhook import ImportPyHook

    ImportPyHookTV = TypeVar("ImportPyHookTV", bound=ImportPyHook)




class MassImport(object):
    """
    Create/modify/delete all objects from the input.

    Currently only implemented for users.
    """

    pyhooks_base_path = "/usr/share/ucs-school-import/pyhooks"
    _pyhook_cache = {}

    def __init__(self, dry_run=True):  # type: (Optional[bool]) -> None
        """:param bool dry_run: set to False to actually commit changes to LDAP"""
        self.dry_run = dry_run
        self.config = Configuration()
        self.logger = logging.getLogger(__name__)
        self.factory = Factory()
        self.result_exporter = self.factory.make_result_exporter()
        self.password_exporter = self.factory.make_password_exporter()
        self.errors = []
        self.user_import_stats_str = ""



    def mass_import(self):  # type: () -> None
        with nullcontext() if self.dry_run else stopped_notifier():
            self.import_computers()
            self.import_groups()
            self.import_inventory_numbers()
            self.import_networks()
            self.import_ous()
            self.import_printers()
            self.import_routers()
            self.import_users()




    def import_computers(self):
        pass




    def import_groups(self):
        pass




    def import_inventory_numbers(self):
        pass




    def import_networks(self):
        pass




    def import_ous(self):
        pass




    def import_printers(self):
        pass




    def import_routers(self):
        pass




    def import_users(self):  # type: () -> None
        self.logger.info("------ Importing users... ------")
        user_import = self.factory.make_user_importer(self.dry_run)
        exception = None
        try:
            user_import.progress_report(description="Running pre-read hooks: 0%.", percentage=0)
            run_import_pyhooks(PreReadPyHook, "pre_read")
            user_import.progress_report(description="Analyzing data: 1%.", percentage=1)
            imported_users = user_import.read_input()
            users_to_delete = user_import.detect_users_to_delete()
            user_import.delete_users(users_to_delete)  # 0% - 10%
            user_import.create_and_modify_users(imported_users)  # 90% - 100%
        except UcsSchoolImportError as exc:
            exception = exc
            user_import.errors.append(exc)
            self.logger.exception(exc)
        except Exception as exc:
            exception = exc
            user_import.errors.append(
                UcsSchoolImportFatalError("An unknown error terminated the import job: {}".format(exc))
            )
            self.logger.exception(exc)
        self.errors.extend(user_import.errors)
        self.user_import_stats_str = user_import.log_stats()
        if self.config["output"]["new_user_passwords"]:
            nup = datetime.datetime.now().strftime(self.config["output"]["new_user_passwords"])
            self.logger.info("------ Writing new users passwords to %s... ------", nup)
            self.password_exporter.dump(user_import, nup)
        if self.config["output"]["user_import_summary"]:
            uis = datetime.datetime.now().strftime(self.config["output"]["user_import_summary"])
            self.logger.info("------ Writing user import summary to %s... ------", uis)
            self.result_exporter.dump(user_import, uis)
        result_data = user_import.get_result_data()
        run_import_pyhooks(ResultPyHook, "user_result", result_data)
        self.logger.info("------ Importing users done. ------")
        if exception:
            raise exception