ilLDAPCronSynchronization Class Reference

Inheritance diagram for ilLDAPCronSynchronization:

Collaboration diagram for ilLDAPCronSynchronization:

Public Member Functions
	getId ()
	getTitle ()
	getDescription ()
	getDefaultScheduleType ()
	getDefaultScheduleValue ()
	hasAutoActivation ()
	hasFlexibleSchedule ()
	run ()
	addToExternalSettingsForm ($a_form_id, array &$a_fields, $a_is_active)
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...
	getValidScheduleTypes ()
	Get all available schedule types. 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
	)

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

References $lng, and ilAdministrationSettingsFormHandler\FORM_LDAP.

    {
        global $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;
        }
    }

deactivateUsers()

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

private

Deactivate users that are disabled in LDAP.

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

References $ilLog, ilObjUser\_getExternalAccountsByAuthMode(), ilObjUser\_toggleActiveStatusOfUsers(), and ilLDAPServer\getAuthenticationMappingKey().

Referenced by run().

    {
        global $ilLog;
        
        include_once './Services/User/classes/class.ilObjUser.php';
        
        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');
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDefaultScheduleType()

ilLDAPCronSynchronization::getDefaultScheduleType

(

)

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

    {
        return self::SCHEDULE_TYPE_DAILY;
    }

getDefaultScheduleValue()

ilLDAPCronSynchronization::getDefaultScheduleValue

(

)

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

    {
        return;
    }

getDescription()

ilLDAPCronSynchronization::getDescription

(

)

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

References $lng.

    {
        global $lng;
        
        $lng->loadLanguageModule("ldap");
        return $lng->txt("ldap_user_sync_cron_info");
    }

getId()

ilLDAPCronSynchronization::getId

(

)

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

Referenced by run().

    {
        return "ldap_sync";
    }

Here is the caller graph for this function:

getTitle()

ilLDAPCronSynchronization::getTitle

(

)

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

References $lng.

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

hasAutoActivation()

ilLDAPCronSynchronization::hasAutoActivation

(

)

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

    {
        return false;
    }

hasFlexibleSchedule()

ilLDAPCronSynchronization::hasFlexibleSchedule

(

)

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

    {
        return false;
    }

run()

ilLDAPCronSynchronization::run

(

)

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

References $ilLog, $messages, $result, $users, ilLDAPServer\_getCronServerIds(), array, ilUserCreationContext\CONTEXT_LDAP, deactivateUsers(), getId(), ilUserCreationContext\getInstance(), IL_LDAP_BIND_DEFAULT, ilCronManager\ping(), ilCronJobResult\STATUS_NO_ACTION, and ilCronJobResult\STATUS_OK.

    {
        global $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;
    }

Here is the call graph for this function:

Field Documentation

$counter

ilLDAPCronSynchronization::$counter = 0

private

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

$current_server

ilLDAPCronSynchronization::$current_server = null

private

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

$ldap_query

ilLDAPCronSynchronization::$ldap_query = null

private

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

$ldap_to_ilias

ilLDAPCronSynchronization::$ldap_to_ilias = null

private

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

---

The documentation for this class was generated from the following file:

• Services/LDAP/classes/class.ilLDAPCronSynchronization.php