Inheritance diagram for ilLDAPCronSynchronization:

Collaboration diagram for ilLDAPCronSynchronization:

Public Member Functions
	getId ()
	Get id. More...

	getTitle ()
	Get title. More...

	getDescription ()
	Get description. More...

	getDefaultScheduleType ()
	Get schedule type. More...

	getDefaultScheduleValue ()
	Get schedule value. More...

	hasAutoActivation ()
	Is to be activated on "installation". More...

	hasFlexibleSchedule ()
	Can the schedule be configured? More...

	run ()
	Run job. More...

	addToExternalSettingsForm ($a_form_id, array &$a_fields, $a_is_active)
	Add external settings to form. More...

Public Member Functions inherited from ilCronJob
	isActive ($a_ts_last_run, $a_schedule_type, $a_schedule_value, $a_manual=false)
	Is job currently active? More...

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

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

	setSchedule ($a_type, $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...

	getTitle ()
	Get title. More...

	getDescription ()
	Get description. More...

	isManuallyExecutable ()
	Defines whether or not a cron job can be started manually. More...

	hasCustomSettings ()
	Has cron job any custom setting which can be edited? More...

	addCustomSettingsToForm (ilPropertyFormGUI $a_form)
	Add custom settings to form. More...

	saveCustomSettings (ilPropertyFormGUI $a_form)
	Save custom settings. More...

	addToExternalSettingsForm ($a_form_id, array &$a_fields, $a_is_active)
	Add external settings to form. More...

	activationWasToggled ($a_currently_active)
	Cron job status was changed. More...

	getId ()
	Get id. More...

	hasAutoActivation ()
	Is to be activated on "installation". More...

	hasFlexibleSchedule ()
	Can the schedule be configured? More...

	getDefaultScheduleType ()
	Get schedule type. More...

	getDefaultScheduleValue ()
	Get schedule value. More...

	run ()
	Run job. More...

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

Private Attributes
	$current_server = null

	$ldap_query = null

	$ldap_to_ilias = null

	$counter = 0

Additional Inherited Members
Data Fields inherited from ilCronJob
const	SCHEDULE_TYPE_DAILY = 1

const	SCHEDULE_TYPE_IN_MINUTES = 2

const	SCHEDULE_TYPE_IN_HOURS = 3

const	SCHEDULE_TYPE_IN_DAYS = 4

const	SCHEDULE_TYPE_WEEKLY = 5

const	SCHEDULE_TYPE_MONTHLY = 6

const	SCHEDULE_TYPE_QUARTERLY = 7

const	SCHEDULE_TYPE_YEARLY = 8

Protected Member Functions inherited from ilCronJob
	checkSchedule ($a_ts_last_run, $a_schedule_type, $a_schedule_value)

Detailed Description

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

Version: $Id$

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

Member Function Documentation

◆ addToExternalSettingsForm()

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

Add external settings to form.

Parameters

int	$a_form_id
array	$a_fields
bool	$a_is_active

Reimplemented from ilCronJob.

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

    {
        global $DIC;
 
        $lng = $DIC['lng'];
        
        switch ($a_form_id) {
            case ilAdministrationSettingsFormHandler::FORM_LDAP:
                $a_fields["ldap_user_sync_cron"] = $a_is_active ?
                    $lng->txt("enabled") :
                    $lng->txt("disabled");
                break;
        }
    }

References $DIC, $lng, and ilAdministrationSettingsFormHandler\FORM_LDAP.

◆ deactivateUsers()

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

private

Deactivate users that are disabled in LDAP.

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

    {
        global $DIC;
 
        $ilLog = $DIC['ilLog'];
        
        include_once './Services/User/classes/class.ilObjUser.php';
 
        
        $inactive = [];
 
        foreach ($ext = 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);
            $ilLog->write('LDAP: Found ' . count($inactive) . ' inactive users.');
            
            $this->counter++;
        } else {
            $ilLog->write('LDAP: No inactive users found');
        }
    }

References $DIC, $ilLog, $server, ilObjUser\_getExternalAccountsByAuthMode(), and ilObjUser\_toggleActiveStatusOfUsers().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultScheduleType()

ilLDAPCronSynchronization::getDefaultScheduleType ( )

Get schedule type.

Returns: int

Reimplemented from ilCronJob.

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

    {
        return self::SCHEDULE_TYPE_DAILY;
    }

References ilCronJob\SCHEDULE_TYPE_DAILY.

◆ getDefaultScheduleValue()

ilLDAPCronSynchronization::getDefaultScheduleValue ( )

Get schedule value.

Returns: int|array

Reimplemented from ilCronJob.

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

    {
        return;
    }

◆ getDescription()

ilLDAPCronSynchronization::getDescription ( )

Get description.

Returns: string

Reimplemented from ilCronJob.

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

    {
        global $DIC;
 
        $lng = $DIC['lng'];
        
        $lng->loadLanguageModule("ldap");
        return $lng->txt("ldap_user_sync_cron_info");
    }

References $DIC, and $lng.

◆ getId()

ilLDAPCronSynchronization::getId ( )

Get id.

Returns: string

Reimplemented from ilCronJob.

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

    {
        return "ldap_sync";
    }

Referenced by run().

Here is the caller graph for this function:

◆ getTitle()

ilLDAPCronSynchronization::getTitle ( )

Get title.

Returns: string

Reimplemented from ilCronJob.

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

    {
        global $DIC;
 
        $lng = $DIC['lng'];
        
        $lng->loadLanguageModule('ldap');
        return $lng->txt('ldap_user_sync_cron');
    }

References $DIC, and $lng.

◆ hasAutoActivation()

ilLDAPCronSynchronization::hasAutoActivation ( )

Is to be activated on "installation".

Returns: boolean

Reimplemented from ilCronJob.

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

    {
        return false;
    }

◆ hasFlexibleSchedule()

ilLDAPCronSynchronization::hasFlexibleSchedule ( )

Can the schedule be configured?

Returns: boolean

Reimplemented from ilCronJob.

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

    {
        return false;
    }

◆ run()

ilLDAPCronSynchronization::run ( )

Run job.

Returns: ilCronJobResult

Reimplemented from ilCronJob.

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

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