Inheritance diagram for ilLDAPCronSynchronization:

Collaboration diagram for ilLDAPCronSynchronization:

Public Member Functions
	__construct ()

	getId ()

	getTitle ()

	getDescription ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

	hasAutoActivation ()
	Is to be activated on "installation", does only work for ILIAS core cron jobs. More...

	hasFlexibleSchedule ()

	run ()

	addToExternalSettingsForm (int $a_form_id, array &$a_fields, bool $a_is_active)

Public Member Functions inherited from ILIAS\Cron\CronJob
	setDateTimeProvider (?\Closure $date_time_provider)

	isDue (?\DateTimeImmutable $last_run, ?JobScheduleType $schedule_type, ?int $schedule_value, bool $is_manually_executed=false)

	getScheduleType ()
	Get current schedule type (if flexible) More...

	getScheduleValue ()
	Get current schedule value (if flexible) More...

	setSchedule (?JobScheduleType $a_type, ?int $a_value)
	Update current schedule (if flexible) More...

	getAllScheduleTypes ()
	Get all available schedule types. More...

	getScheduleTypesWithValues ()

	getValidScheduleTypes ()
	Returns a collection of all valid schedule types for a specific job. More...

	isManuallyExecutable ()

	hasCustomSettings ()

	usesLegacyForms ()

	getCustomConfigurationInput (\ILIAS\UI\Factory $ui_factory, \ILIAS\Refinery\Factory $factory, \ilLanguage $lng)

	addCustomSettingsToForm (\ilPropertyFormGUI $a_form)

	saveCustomConfiguration (mixed $form_data)

	saveCustomSettings (\ilPropertyFormGUI $a_form)

	addToExternalSettingsForm (int $a_form_id, array &$a_fields, bool $a_is_active)

	activationWasToggled (\ilDBInterface $db, \ilSetting $setting, bool $a_currently_active)
	Important: This method is (also) called from the setup process, where the constructor of an ilCronJob ist NOT executed. More...

	getId ()

	getTitle ()

	getDescription ()

	hasAutoActivation ()
	Is to be activated on "installation", does only work for ILIAS core cron jobs. More...

	hasFlexibleSchedule ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

	run ()

Private Member Functions
	deactivateUsers (ilLDAPServer $server, array $a_ldap_users)
	Deactivate users that are disabled in LDAP. More...

Private Attributes
ilLanguage	$lng

ilLogger	$logger

JobManager	$cronManager

int	$counter = 0

Additional Inherited Members
Protected Attributes inherited from ILIAS\Cron\CronJob
JobScheduleType	$schedule_type = null

int	$schedule_value = null

Closure	$date_time_provider = null

Detailed Description

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 30 of file class.ilLDAPCronSynchronization.php.

Constructor & Destructor Documentation

◆ __construct()

ilLDAPCronSynchronization::__construct ( )

Definition at line 38 of file class.ilLDAPCronSynchronization.php.

    {
        global $DIC;
 
        $this->logger = $DIC->logger()->auth();
        $this->cronManager = $DIC->cron()->manager();
        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule('ldap');
    }

References $DIC, ILIAS\Repository\lng(), and ILIAS\Repository\logger().

Here is the call graph for this function:

Member Function Documentation

◆ addToExternalSettingsForm()

ilLDAPCronSynchronization::addToExternalSettingsForm	(	int	$a_form_id,
		array &	$a_fields,
		bool	$a_is_active
	)

Parameters

array<string,mixed> $a_fields

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 165 of file class.ilLDAPCronSynchronization.php.

                                                                                                  : void
    {
        if ($a_form_id === ilAdministrationSettingsFormHandler::FORM_LDAP) {
            $a_fields["ldap_user_sync_cron"] = [$a_is_active ?
                $this->lng->txt("enabled") :
                $this->lng->txt("disabled"),
                ilAdministrationSettingsFormHandler::VALUE_BOOL];
        }
    }

References ilAdministrationSettingsFormHandler\FORM_LDAP, ILIAS\Repository\lng(), and ilAdministrationSettingsFormHandler\VALUE_BOOL.

Here is the call graph for this function:

◆ deactivateUsers()

ilLDAPCronSynchronization::deactivateUsers	(	ilLDAPServer	$server,
		array	$a_ldap_users
	)

private

Deactivate users that are disabled in LDAP.

Definition at line 146 of file class.ilLDAPCronSynchronization.php.

                                                                               : void
    {
        $inactive = [];
 
        foreach (ilObjUser::_getExternalAccountsByAuthMode($server->getAuthenticationMappingKey(), true) as $usr_id => $external_account) {
            if (!array_key_exists($external_account, $a_ldap_users)) {
                $inactive[] = $usr_id;
            }
        }
        if (count($inactive)) {
            ilObjUser::_toggleActiveStatusOfUsers($inactive, false);
            $this->logger->info('LDAP: Found ' . count($inactive) . ' inactive users.');
 
            $this->counter++;
        } else {
            $this->logger->info('LDAP: No inactive users found');
        }
    }

References $server, ilObjUser\_getExternalAccountsByAuthMode(), ilObjUser\_toggleActiveStatusOfUsers(), and ILIAS\Repository\logger().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultScheduleType()

ilLDAPCronSynchronization::getDefaultScheduleType ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 63 of file class.ilLDAPCronSynchronization.php.

                                            : JobScheduleType
    {
        return JobScheduleType::DAILY;
    }

◆ getDefaultScheduleValue()

ilLDAPCronSynchronization::getDefaultScheduleValue ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 68 of file class.ilLDAPCronSynchronization.php.

                                             : ?int
    {
        return null;
    }

◆ getDescription()

ilLDAPCronSynchronization::getDescription ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 58 of file class.ilLDAPCronSynchronization.php.

                                    : string
    {
        return $this->lng->txt("ldap_user_sync_cron_info");
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getId()

ilLDAPCronSynchronization::getId ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 48 of file class.ilLDAPCronSynchronization.php.

                           : string
    {
        return "ldap_sync";
    }

Referenced by run().

Here is the caller graph for this function:

◆ getTitle()

ilLDAPCronSynchronization::getTitle ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 53 of file class.ilLDAPCronSynchronization.php.

                              : string
    {
        return $this->lng->txt('ldap_user_sync_cron');
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ hasAutoActivation()

ilLDAPCronSynchronization::hasAutoActivation ( )

Is to be activated on "installation", does only work for ILIAS core cron jobs.

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 73 of file class.ilLDAPCronSynchronization.php.

                                       : bool
    {
        return false;
    }

◆ hasFlexibleSchedule()

ilLDAPCronSynchronization::hasFlexibleSchedule ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 78 of file class.ilLDAPCronSynchronization.php.

                                         : bool
    {
        return false;
    }

◆ run()

ilLDAPCronSynchronization::run ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 83 of file class.ilLDAPCronSynchronization.php.

                         : JobResult
    {
        $status = JobResult::STATUS_NO_ACTION;
 
        $messages = array();
        foreach (ilLDAPServer::_getCronServerIds() as $server_id) {
            try {
                $current_server = new ilLDAPServer($server_id);
                $current_server->doConnectionCheck();
                $this->logger->info("LDAP: starting user synchronization for " . $current_server->getName());
 
                $ldap_query = new ilLDAPQuery($current_server);
                $ldap_query->bind();
 
                if (is_array($users = $ldap_query->fetchUsers())) {
                    // Deactivate ldap users that are not in the list
                    $this->deactivateUsers($current_server, $users);
                }
 
                if (count($users)) {
                    ilUserCreationContext::getInstance()->addContext(ilUserCreationContext::CONTEXT_LDAP);
 
                    $offset = 0;
                    $limit = 500;
                    while ($user_sliced = array_slice($users, $offset, $limit, true)) {
                        $this->logger->info("LDAP: Starting update/creation of users ...");
                        $this->logger->info("LDAP: Offset: " . $offset);
                        $ldap_to_ilias = new ilLDAPAttributeToUser($current_server);
                        $ldap_to_ilias->setNewUserAuthMode($current_server->getAuthenticationMappingKey());
                        $ldap_to_ilias->setUserData($user_sliced);
                        $ldap_to_ilias->refresh();
                        $this->logger->info("LDAP: Finished update/creation");
 
                        $offset += $limit;
 
                        $this->cronManager->ping($this->getId());
                    }
                    $this->counter++;
                } else {
                    $this->logger->info("LDAP: No users for update/create. Aborting.");
                }
            } catch (ilLDAPQueryException $exc) {
                $mess = $exc->getMessage();
                $this->logger->info($mess);
 
                $messages[] = $mess;
            }
        }
 
        if ($this->counter) {
            $status = JobResult::STATUS_OK;
        }
        $result = new JobResult();
        if (count($messages)) {
            $result->setMessage(implode("\n", $messages));
        }
        $result->setStatus($status);
        return $result;
    }