ilCertificateMigrationJob Class Reference

Class ilCertificateMigrationJob. More...

Inheritance diagram for ilCertificateMigrationJob:

Collaboration diagram for ilCertificateMigrationJob:

Public Member Functions
	run (array $input, Observer $observer)
	isStateless ()
	getExpectedTimeOfTaskInSeconds ()
	getInputTypes ()
	getOutputType ()
	getTaskInformations ()
Public Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractJob
	getInput ()
	Returns mixed returns the input array More...
Public Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
	setInput (array $values)
	getOutput ()
	getInput ()
	getType ()
	unfoldTask ()
	Unfold the task. More...
	getRemoveOption ()
	Returns Option An Option to remove the current task and do some cleanup if possible. This Option is displayed if the Bucket is completed. You do not have to provide an additional Option to remove in your UserInteraction, the remove-Option is added to the list of Options (last position) See also self::getAbortOption(); More...
	getAbortOption ()
	Returns Option In case a Job is failed or did not respond for some time, an Abort-Option is displayed. There is already a Standard-Abort-Option registered, you can override with your own and do some cleanup if possible. More...

Protected Member Functions
	initTask ()
	updateTask (array $data)
	getScormCertificates ()
	Get certificates for scorm objects. More...
	getTestCertificates ()
	Get certificates for test objects. More...
	getExerciseCertificates ()
	Get certificates for exercise objects. More...
	getCourseCertificates ()
	Get certificates for course objects. More...
Protected Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
	checkTypes ($values)
	extractType ($value)

Protected Attributes
	$db_table
	$user_id
	$tree
	$db
	$event_handler
	$task_factory
Protected Attributes inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
	$input = []
	$output

Private Attributes
	$logger
	$types

Additional Inherited Members
Data Fields inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
const	MAIN_REMOVE = 'bt_main_remove'
const	MAIN_ABORT = 'bt_main_abort'

Detailed Description

Class ilCertificateMigrationJob.

Author

Ralph Dittrich dittr.nosp@m.ich@.nosp@m.quali.nosp@m.tus..nosp@m.de

Definition at line 35 of file class.ilCertificateMigrationJob.php.

Member Function Documentation

getCourseCertificates()

ilCertificateMigrationJob::getCourseCertificates ( )

protected

Get certificates for course objects.

Returns

array

Definition at line 515 of file class.ilCertificateMigrationJob.php.

References $data, ilParticipants\_getMembershipByType(), ilCourseCertificateAdapter\_hasUserCertificate(), ilCourseCertificateAdapter\_preloadListData(), and ilObjectFactory\getInstanceByObjId().

Referenced by run().

                                               : array
    {
        $this->logger->info('Trying to get course certificates for user: ' . $this->user_id);

        $data = array();

        $obj_ids = \ilCourseParticipants::_getMembershipByType($this->user_id, "crs");
        if ($obj_ids) {
            \ilCourseCertificateAdapter::_preloadListData([$this->user_id], $obj_ids);

            foreach ($obj_ids as $objectId) {
                if (\ilCourseCertificateAdapter::_hasUserCertificate($this->user_id, $objectId)) {
                    $object = \ilObjectFactory::getInstanceByObjId($objectId, false);
                    if (!$object || !($object instanceof \ilObjCourse)) {
                        $this->logger->debug('Found inconsistent object, skipped migration: ' . $objectId);
                        continue;
                    }

                    $data[] = $objectId;
                }
            }
        }

        $this->logger->info('Got ' . count($data) . ' course certificates for user: ' . $this->user_id);
        return $data;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getExerciseCertificates()

ilCertificateMigrationJob::getExerciseCertificates ( )

protected

Get certificates for exercise objects.

Returns

array

Definition at line 488 of file class.ilCertificateMigrationJob.php.

References $data, ilObjExercise\_lookupFinishedUserExercises(), and ilObjectFactory\getInstanceByObjId().

Referenced by run().

                                                 : array
    {
        $this->logger->info('Trying to get exercise certificates for user: ' . $this->user_id);

        $data = array();

        foreach (\ilObjExercise::_lookupFinishedUserExercises($this->user_id) as $objectId => $passed) {
            $object = \ilObjectFactory::getInstanceByObjId($objectId, false);
            if (!$object || !($object instanceof \ilObjExercise)) {
                $this->logger->debug('Found inconsistent object, skipped migration: ' . $objectId);
                continue;
            }

            $adapter = new \ilExerciseCertificateAdapter($object);
            if ($adapter->hasUserCertificate($this->user_id)) {
                $data[] = $objectId;
            }
        }

        $this->logger->info('Got ' . count($data) . ' exercise certificates for user: ' . $this->user_id);
        return $data;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getExpectedTimeOfTaskInSeconds()

ilCertificateMigrationJob::getExpectedTimeOfTaskInSeconds

(

)

Returns

int the amount of seconds this task usually takes. If your task-duration scales with the the amount of data, try to set a possible high value of try to calculate it. If a task duration exceeds this value, it will be displayed as "possibly failed" to the user

Implements ILIAS\BackgroundTasks\Task\Job.

Definition at line 278 of file class.ilCertificateMigrationJob.php.

                                                     : int
    {
        return 100;
    }

getInputTypes()

ilCertificateMigrationJob::getInputTypes

(

)

Returns

Type[] Classof the Values

Implements ILIAS\BackgroundTasks\Task.

Definition at line 286 of file class.ilCertificateMigrationJob.php.

                                    : array
    {
        return [
            new SingleType(IntegerValue::class),
        ];
    }

getOutputType()

ilCertificateMigrationJob::getOutputType

(

)

Returns

Type

Implements ILIAS\BackgroundTasks\Task.

Definition at line 296 of file class.ilCertificateMigrationJob.php.

                                    : SingleType
    {
        return new SingleType(IntegerValue::class);
    }

getScormCertificates()

ilCertificateMigrationJob::getScormCertificates ( )

protected

Get certificates for scorm objects.

Returns

array

Definition at line 384 of file class.ilCertificateMigrationJob.php.

References $data, $root, $type, ilObjUserTracking\_enabledLearningProgress(), ilObjSCORM2004LearningModule\_getCourseCompletionForUser(), ilObjSCORMLearningModule\_getCourseCompletionForUser(), ilLPStatus\_hasUserCompleted(), ilObjSAHSLearningModule\_lookupSubType(), ilObjectFactory\getInstanceByObjId(), and ilCertificate\isActive().

Referenced by run().

                                              : array
    {
        $this->logger->info('Trying to get scorm certificates for user: ' . $this->user_id);

        $data = array();

        if (\ilCertificate::isActive()) {
            $lp_active = ilObjUserTracking::_enabledLearningProgress();
            $obj_ids = array();
            $root = $this->tree->getNodeData($this->tree->getRootId());
            foreach ($this->tree->getSubTree($root, true, "sahs") as $node) {
                $obj_ids[] = $node["obj_id"];
            }
            if ($obj_ids) {
                foreach (\ilCertificate::areObjectsActive($obj_ids) as $objectId => $active) {
                    if ($active) {
                        $type = \ilObjSAHSLearningModule::_lookupSubType($objectId);

                        $object = \ilObjectFactory::getInstanceByObjId($objectId, false);
                        if (!$object || !($object instanceof \ilObjSAHSLearningModule)) {
                            $this->logger->debug('Found inconsistent object, skipped migration: ' . $objectId);
                            continue;
                        }
                        $object->setSubType($type);

                        $lpdata = $completed = false;
                        if ($lp_active) {
                            $completed = ilLPStatus::_hasUserCompleted($objectId, $this->user_id);
                            $lpdata = true;
                        }

                        if (!$lpdata) {
                            switch ($type) {
                                case 'scorm':
                                    $completed = ilObjSCORMLearningModule::_getCourseCompletionForUser(
                                        $objectId,
                                        $this->user_id
                                    );
                                    break;

                                case 'scorm2004':
                                    $completed = ilObjSCORM2004LearningModule::_getCourseCompletionForUser(
                                        $objectId,
                                        $this->user_id
                                    );
                                    break;
                            }
                        }

                        if (!$completed) {
                            $this->logger->info(sprintf(
                                'User did not complete SCORM object with obj_id %s, ignoring object for migration ...',
                                $objectId
                            ));
                            continue;
                        }

                        $this->logger->info(sprintf(
                            'User completed SCORM object with obj_id %s, considering object for migration ...',
                            $objectId
                        ));

                        $data[] = $objectId;
                    }
                }
            }
        }

        $this->logger->info('Got ' . count($data) . ' scorm certificates for user: ' . $this->user_id);
        return $data;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTaskInformations()

ilCertificateMigrationJob::getTaskInformations

(

)

Returns

array

Definition at line 304 of file class.ilCertificateMigrationJob.php.

References $data, $db, $DIC, and $result.

Referenced by run().

                                          : array
    {
        global $DIC;

        $db = $DIC->database();

        $result = $db->queryF(
            'SELECT * FROM ' . $this->db_table . ' WHERE usr_id = %s',
            ['integer'],
            [$this->user_id]
        );
        if ($result->numRows() == 1) {
            $data = $db->fetchAssoc($result);
            return $data;
        }
        return [];
    }

Here is the caller graph for this function:

getTestCertificates()

ilCertificateMigrationJob::getTestCertificates ( )

protected

Get certificates for test objects.

Returns

array

Definition at line 460 of file class.ilCertificateMigrationJob.php.

References $data, $session, ilObjectFactory\getInstanceByObjId(), and ilObjTest\getTestObjIdsWithActiveForUserId().

Referenced by run().

                                             : array
    {
        $this->logger->info('Trying to get test certificates for user: ' . $this->user_id);

        $data = array();

        foreach (\ilObjTest::getTestObjIdsWithActiveForUserId($this->user_id) as $objectId) {
            $object = \ilObjectFactory::getInstanceByObjId($objectId, false);
            if (!$object || !($object instanceof \ilObjTest)) {
                $this->logger->debug('Found inconsistent object, skipped migration: ' . $objectId);
                continue;
            }

            $session = new \ilTestSessionFactory($object);
            $session = $session->getSession(null);
            if ($object->canShowCertificate($session, $session->getUserId(), $session->getActiveId())) {
                $data[] = $objectId;
            }
        }

        $this->logger->info('Got ' . count($data) . ' test certificates for user: ' . $this->user_id);
        return $data;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initTask()

ilCertificateMigrationJob::initTask ( )

protected

Returns

void

Definition at line 325 of file class.ilCertificateMigrationJob.php.

References $user_id, and ilCertificateMigrationJobDefinitions\CERT_MIGRATION_STATE_INIT.

Referenced by run().

    {
        $this->logger->debug('Insert new entry for user with id: ' . $this->user_id);
        $this->db->insert($this->db_table, [
            'id' => ['integer', $this->db->nextId($this->db_table)],
            'usr_id' => ['integer', $this->user_id],
            'lock' => ['integer', false],
            'found_items' => ['integer', 0],
            'processed_items' => ['integer', 0],
            'migrated_items' => ['integer', 0],
            'progress' => ['integer', 0],
            'state' => ['text', \ilCertificateMigrationJobDefinitions::CERT_MIGRATION_STATE_INIT],
            'started_ts' => ['integer', strtotime('now')],
            'finished_ts' => null,
        ]);
    }

Here is the caller graph for this function:

isStateless()

ilCertificateMigrationJob::isStateless

(

)

Returns

bool returns true iff the job's output ONLY depends on the input. Stateless task results may be cached!

Implements ILIAS\BackgroundTasks\Task\Job.

Definition at line 267 of file class.ilCertificateMigrationJob.php.

                                  : bool
    {
        return true;
    }

run()

ilCertificateMigrationJob::run	(	array	$input,
		Observer	$observer
	)

Parameters

Implements ILIAS\BackgroundTasks\Task\Job.

Definition at line 71 of file class.ilCertificateMigrationJob.php.

References $certificate, $certificates, $DIC, $f_time, ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask\$output, $template, $test, $type, $user, ilObjUserTracking\_enabledLearningProgress(), ilLPStatus\_lookupStatusChanged(), ilCertificateMigrationJobDefinitions\CERT_MIGRATION_JOB_TABLE, ilCertificateMigrationJobDefinitions\CERT_MIGRATION_RETURN_ALREADY_RUNNING, ilCertificateMigrationJobDefinitions\CERT_MIGRATION_RETURN_LOCKED, ilCertificateMigrationJobDefinitions\CERT_MIGRATION_RETURN_SUCCESS, ilCertificateMigrationJobDefinitions\CERT_MIGRATION_STATE_FAILED, ilCertificateMigrationJobDefinitions\CERT_MIGRATION_STATE_FINISHED, ilCertificateMigrationJobDefinitions\CERT_MIGRATION_STATE_RUNNING, getCourseCertificates(), ilCourseParticipants\getDateTimeOfPassed(), getExerciseCertificates(), getScormCertificates(), getTaskInformations(), getTestCertificates(), ILIAS\BackgroundTasks\Observer\heartbeat(), IL_CAL_DATETIME, IL_CAL_UNIX, ILIAS_VERSION_NUMERIC, initTask(), ilCertificate\isObjectActive(), and updateTask().

                                                          : \ILIAS\BackgroundTasks\Implementation\Values\ScalarValues\IntegerValue
    {
        global $DIC;

        $this->user_id = $input[0]->getValue();
        $user = new ilObjUser($this->user_id);

        $this->tree = $DIC->repositoryTree();
        $this->db = $DIC->database();
        $this->db_table = \ilCertificateMigrationJobDefinitions::CERT_MIGRATION_JOB_TABLE;
        $this->event_handler = $DIC['ilAppEventHandler'];
        $this->task_factory = $DIC->backgroundTasks()->taskFactory();
        $this->logger = $DIC->logger()->cert();

        $certificates = [];
        $output = new IntegerValue();

        $this->logger->debug('Started at ' . ($st_time = date('d.m.Y H:i:s')) . ' for user with id: ' . $this->user_id);

        $task_informations = $this->getTaskInformations();
        if (empty($task_informations)) {
            $this->initTask();
        }
        if ($task_informations['state'] === \ilCertificateMigrationJobDefinitions::CERT_MIGRATION_STATE_RUNNING) {
            $this->logger->info('Parallel execution protection. Stopped task for user ' . $this->user_id . ', because it is already running.');
            $output->setValue(\ilCertificateMigrationJobDefinitions::CERT_MIGRATION_RETURN_ALREADY_RUNNING);
            return $output;
        }
        if ($task_informations['lock'] == true) {
            // we should never get here if no fatal error occures
            $this->logger->info('Parallel execution protection. Stopped task for user ' . $this->user_id . ', because it is locked.');
            $output->setValue(\ilCertificateMigrationJobDefinitions::CERT_MIGRATION_RETURN_LOCKED);
            return $output;
        }

        $this->updateTask([
            'lock' => true,
            'state' => \ilCertificateMigrationJobDefinitions::CERT_MIGRATION_STATE_RUNNING
        ]);

        $found_items = 0;

        try {
            // collect all data
            $this->logger->info('Start collection certificate data for user: ' . $this->user_id);

            foreach ($this->types as $type) {
                if ($type === 'scorm') {
                    $certificates[$type] = $this->getScormCertificates();
                } elseif ($type === 'test') {
                    $certificates[$type] = $this->getTestCertificates();
                } elseif ($type === 'exercise') {
                    $certificates[$type] = $this->getExerciseCertificates();
                } elseif ($type === 'course') {
                    $certificates[$type] = $this->getCourseCertificates();
                }

                $found_items += count($certificates[$type]);
                $observer->heartbeat();
            }

            $this->updateTask(['found_items' => $found_items]);
            $this->logger->debug('Found overall ' . $found_items . ' items for user with id: ' . $this->user_id);
            $this->logger->info('Finished collecting certificate data for user: ' . $this->user_id);
            
            $processed_items = 0;

            $template_repository = new ilCertificateTemplateRepository($this->db);
            $repository = new ilUserCertificateRepository($this->db);
            $value_replacement = new ilCertificateValueReplacement();

            $this->logger->info('Start migrating certificates for user: ' . $user->getId());

            foreach ($this->types as $type) {
                $this->logger->info(sprintf('Start preparing "%s" certificates', $type));

                switch ($type) {
                    case 'test':
                        $class = ilTestPlaceholderValues::class;
                        break;

                    case 'scorm':
                        $class = ilScormPlaceholderValues::class;
                        break;

                    case 'exercise':
                        $class = ilExercisePlaceholderValues::class;
                        break;

                    case 'course':
                        $class = ilCoursePlaceholderValues::class;
                        break;
                }
                $placeholder_values = new $class();

                foreach ($certificates[$type] as $certificate_id) {
                    if (\ilCertificate::isObjectActive($certificate_id)) {
                        try {
                            switch (true) {
                                case $type == 'course':
                                    $acquireDate = new ilDateTime(
                                        ilCourseParticipants::getDateTimeOfPassed($certificate_id, $user->getId()),
                                        IL_CAL_DATETIME
                                    );
                                    $acquireTimestamp = $acquireDate->get(IL_CAL_UNIX);
                                    break;
                                case $type == 'test' && !ilObjUserTracking::_enabledLearningProgress():
                                    $test = new ilObjTest($certificate_id, false);
                                    $acquireTimestamp = $test
                                        ->getTestResult($test->getActiveIdOfUser($user->getId()))['test']['result_tstamp'];
                                    break;
                                default:
                                    $acquireDate = new ilDateTime(
                                        ilLPStatus::_lookupStatusChanged($certificate_id, $user->getId()),
                                        IL_CAL_DATETIME
                                    );
                                    $acquireTimestamp = $acquireDate->get(IL_CAL_UNIX);
                            }
                        } catch (Exception $exception) {
                            $this->logger->warning(sprintf('Unable to gather aquired timestamp for certificate %s', $certificate_id));
                            $acquireTimestamp = null;
                        }
                        if ($acquireTimestamp === null || 0 === (int) $acquireTimestamp) {
                            $acquireTimestamp = time();
                        }
                        $template = null;
                        try {
                            $template = $template_repository->fetchFirstCreatedTemplate($certificate_id);
                        } catch (Exception $exception) {
                            $this->logger->warning(sprintf('Unable to gather template for certificate %s. Skipped.', $certificate_id));
                        }
                        if ($template) {
                            $certificate = new ilUserCertificate(
                                $template->getId(),
                                $certificate_id,
                                $type,
                                $user->getId(),
                                $user->getFullname(),
                                $acquireTimestamp,
                                $value_replacement->replace(
                                    $placeholder_values->getPlaceholderValues($user->getId(), $certificate_id),
                                    $template->getCertificateContent()
                                ) ?? '',
                                json_encode($placeholder_values->getPlaceholderValues($user->getId(), $certificate_id)) ?? '',
                                null,
                                $template->getVersion(),
                                ILIAS_VERSION_NUMERIC,
                                true,
                                $template->getBackgroundImagePath() ?? '',
                                $template->getThumbnailImagePath() ?? ''
                            );
                            $repository->save($certificate);
                            $processed_items++;
                        }
                    }
                    $this->updateTask([
                        'processed_items' => $processed_items,
                        'progress' => ($processed_items / $found_items) * 100
                    ]);

                    $observer->heartbeat();
                }
                $this->logger->info(sprintf('Finished preparing "%s" certificates', $type));
            }

            $this->logger->info('Finished migrating certificates for user: ' . $user->getId());
        } catch (\Exception $e) {
            $this->logger->error($e->getMessage(), 'error');
            $this->updateTask([
                'lock' => false,
                'processed_items' => $processed_items,
                'state' => \ilCertificateMigrationJobDefinitions::CERT_MIGRATION_STATE_FAILED
            ]);
            $output->setValue((int) $e->getCode());
            return $output;
        }

        $output->setValue(\ilCertificateMigrationJobDefinitions::CERT_MIGRATION_RETURN_SUCCESS);

        $this->logger->debug('Finished at ' . ($f_time = date('d.m.Y H:i:s')) . ' after ' . (strtotime($f_time) - strtotime($st_time)) . ' seconds');
        $this->updateTask([
            'lock' => false,
            'finished_ts' => $f_time,
            'processed_items' => $processed_items,
            'state' => \ilCertificateMigrationJobDefinitions::CERT_MIGRATION_STATE_FINISHED
        ]);

        $user->writePref('cert_migr_finished', 1);

        return $output;
    }

Here is the call graph for this function:

updateTask()

ilCertificateMigrationJob::updateTask ( array  $data )

protected

Parameters

array

$data

Returns

void

Definition at line 346 of file class.ilCertificateMigrationJob.php.

Referenced by run().

    {
        $updata = [];
        if (array_key_exists('lock', $data)) {
            $updata['lock'] = ['integer', $data['lock']];
        }
        if (array_key_exists('found_items', $data)) {
            $updata['found_items'] = ['integer', $data['found_items']];
        }
        if (array_key_exists('processed_items', $data)) {
            $updata['processed_items'] = ['integer', $data['processed_items']];
        }
        if (array_key_exists('migrated_items', $data)) {
            $updata['migrated_items'] = ['integer', $data['migrated_items']];
        }
        if (array_key_exists('progress', $data)) {
            $updata['progress'] = ['integer', $data['progress']];
        }
        if (array_key_exists('state', $data)) {
            $updata['state'] = ['text', $data['state']];
        }
        if (array_key_exists('finished_ts', $data)) {
            if (is_string($data['finished_ts'])) {
                $data['finished_ts'] = strtotime($data['finished_ts']);
            }
            $updata['finished_ts'] = ['integer', $data['finished_ts']];
        }
        $this->logger->debug('Update data: ' . json_encode($updata));
        if (!empty($updata)) {
            $this->logger->debug('Update entry for user with id: ' . $this->user_id);
            $this->db->update($this->db_table, $updata, ['usr_id' => ['integer', $this->user_id] ]);
        }
    }

Here is the caller graph for this function:

Field Documentation

$db

ilCertificateMigrationJob::$db

protected

Definition at line 47 of file class.ilCertificateMigrationJob.php.

Referenced by getTaskInformations().

$db_table

ilCertificateMigrationJob::$db_table

protected

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

$event_handler

ilCertificateMigrationJob::$event_handler

protected

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

$logger

ilCertificateMigrationJob::$logger

private

Definition at line 56 of file class.ilCertificateMigrationJob.php.

$task_factory

ilCertificateMigrationJob::$task_factory

protected

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

$tree

ilCertificateMigrationJob::$tree

protected

Definition at line 44 of file class.ilCertificateMigrationJob.php.

$types

ilCertificateMigrationJob::$types

private

Initial value:

= [
        'test',
        'scorm',
        'exercise',
        'course'
    ]

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

$user_id

ilCertificateMigrationJob::$user_id

protected

Definition at line 41 of file class.ilCertificateMigrationJob.php.

Referenced by initTask().

---

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

• Services/Certificate/classes/BackgroundTasks/class.ilCertificateMigrationJob.php