Inheritance diagram for ilCmiXapiDelCron:

Collaboration diagram for ilCmiXapiDelCron:

Public Member Functions
	__construct ()

	getId ()

	getTitle ()

	getDescription ()

	hasAutoActivation ()
	@inheritdoc More...

	hasFlexibleSchedule ()
	@inheritdoc More...

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

	run ()

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 ()

Data Fields
const	JOB_ID = 'xapi_deletion_cron'

Protected Member Functions
	hasLrsType ()

	getLrsType ()

Protected Attributes
ilCmiXapiLrsType	$lrsType

ilCmiXapiDelModel	$model

ilLogger	$log

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

int	$schedule_value = null

Closure	$date_time_provider = null

Private Attributes
ILIAS DI Container	$dic

Detailed Description

Class ilCmiXapiDelCron.

Author: Uwe Kohnle kohnl.nosp@m.e@in.nosp@m.terne.nosp@m.tleh.nosp@m.rer-g.nosp@m.mbh..nosp@m.de; Stefan Schneider

Definition at line 32 of file class.ilCmiXapiDelCron.php.

Constructor & Destructor Documentation

◆ __construct()

ilCmiXapiDelCron::__construct ( )

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

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        $this->dic = $DIC;
 
        $DIC->language()->loadLanguageModule('cmix');
 
        $this->log = ilLoggerFactory::getLogger('cmix');
 
        $settings = new ilSetting(self::JOB_ID);
        $lrsTypeId = $settings->get('lrs_type_id', '0');
 
        if ($lrsTypeId) {
            $this->lrsType = new ilCmiXapiLrsType((int) $lrsTypeId);
        } else {
            $this->lrsType = null;
        }
 
        $this->model = ilCmiXapiDelModel::init();
    }

References $DIC, ilLoggerFactory\getLogger(), and ilCmiXapiDelModel\init().

Here is the call graph for this function:

Member Function Documentation

◆ getDefaultScheduleType()

ilCmiXapiDelCron::getDefaultScheduleType ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 96 of file class.ilCmiXapiDelCron.php.

                                            : JobScheduleType
    {
        return JobScheduleType::DAILY;
    }

◆ getDefaultScheduleValue()

ilCmiXapiDelCron::getDefaultScheduleValue ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 101 of file class.ilCmiXapiDelCron.php.

◆ getDescription()

ilCmiXapiDelCron::getDescription ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 75 of file class.ilCmiXapiDelCron.php.

                                    : string
    {
        return $this->dic->language()->txt("cron_xapi_del_desc");
    }

◆ getId()

ilCmiXapiDelCron::getId ( )

Reimplemented from ILIAS\Cron\CronJob.

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

                           : string
    {
        return self::JOB_ID;
    }

References JOB_ID.

◆ getLrsType()

ilCmiXapiDelCron::getLrsType ( )

protected

Definition at line 111 of file class.ilCmiXapiDelCron.php.

    {
        return $this->lrsType;
    }

References $lrsType.

Referenced by hasLrsType().

Here is the caller graph for this function:

◆ getTitle()

ilCmiXapiDelCron::getTitle ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 70 of file class.ilCmiXapiDelCron.php.

                              : string
    {
        return $this->dic->language()->txt("cron_xapi_del");
    }

◆ hasAutoActivation()

ilCmiXapiDelCron::hasAutoActivation ( )

@inheritdoc

Reimplemented from ILIAS\Cron\CronJob.

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

                                       : bool
    {
        return false;
    }

◆ hasFlexibleSchedule()

ilCmiXapiDelCron::hasFlexibleSchedule ( )

@inheritdoc

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 91 of file class.ilCmiXapiDelCron.php.

                                         : bool
    {
        return true;
    }

◆ hasLrsType()

ilCmiXapiDelCron::hasLrsType ( )

protected

Definition at line 106 of file class.ilCmiXapiDelCron.php.

    {
        return $this->getLrsType() !== null;
    }

References getLrsType().

Here is the call graph for this function:

◆ run()

ilCmiXapiDelCron::run ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 116 of file class.ilCmiXapiDelCron.php.

                         : JobResult
    {
        global $DIC;
        $cronResult = new JobResult();
        $this->log->debug('run');
 
        // LRS - Ist Client gelöscht?
        // LRS - Wenn Client gelöscht dann nix machen
        // LRS - Wenn Client gelöscht wirklich alle Daten weg?
        // Wenn Objekt gelöscht warum wird es nochmal bei Nutzer aufgeführt (Tabelle gucken)
        // xxx Löschen wenn nut Lernerfahrung anzeigen dann nur anzeigen nicht löschen = kein Datenadmin
 
        /*
        Fall 1:
            * Objekt deleted (in Tabelle xapidel_object eingetragen mit Feld updated=null)
        => xapidel_object aktualisieren mit updated
        => hole alle Daten zu Users aus xxcf_users und die Daten zum lrs und activity_id aus xapidel_object inkl. xxcf_data_types
        => Löschvorgang an LRS-typ schicken
        => wenn's geklappt hat: Zeile aus xxcf_users löschen
        => wenn's für alle user geklappt hat: Zeile aus xxcf_data_settings löschen
        => wenn ggf. auch user gelöscht wurde und der user nur dieses objekt bearbeitet hat, dann lösche auch Zeile in xpidel_user
 
 
        Fall 2:
            * User deleted (in Tabelle xapidel_user eingetragen mit Feld updated=null)
            * Objekt noch vorhanden (kein Eintrag in Tabelle xapidel_object)
        => xapidel_user aktualisieren mit updated
        => hole alle Daten zum User aus xxcf_users und die Daten zum lrs und activity_id aus xxcf_settings inkl. xxcf_data_types
        => Löschvorgang an LRS-typ schicken
        => wenn's geklappt hat: Zeile aus xxcf_users löschen
        => wenn's für alle Objekte, die der User genutzt hat, gelöscht wurde: Zeile in xapidel_user löschen
 
        Fall 3:
            * User deleted (in Tabelle xapidel_user eingetragen mit Feld updated=null)
            * Objekt auch deleted (Eintrag in Tabelle xapidel_object mit updated=null)
            => xapidel_user aktualisieren mit updated
            => xapidel_object aktualisieren mit updated
            => hole alle Daten zum User aus xxcf_users und die Daten zum lrs und activity_id aus xapidel_object inkl. xxcf_data_types
            => Löschvorgang an LRS-typ schicken
            => wenn's geklappt hat: Zeile aus xxcf_users löschen
            => wenn's für alle Objekte, die der User genutzt hat, gelöscht wurde: Zeile in xapidel_user löschen
            => Zeile in Tabelle xapidel_object löschen
 
 
 
        */
 
 
        //user deleted
        //SELECT distinct LRS credentials for all objs  - ACHTUNG Plugin-Version beachten!
        //SELECT usr_id FROM xapidel_user
        //usr_ids=..
        //SELECT obj_id, user_cred WHERE user_id in (usr_ids)
        //delete in lrs - wenn nicht in separate log-tabelle schreiben
        //delete xxcf_users WHERE obj_id and user_cred
        //if numrows for usr_id =0 DELETE FROM xapidel_user WHERE usr_id=%s
 
        //Hinweis auf negative Auswirkungen von lrs-typ-Änderungen für Lösch vorgänge
 
        //object deleted
        //SELECT activity_id, lrs_cred FROM xapidel_obj, xxcf_data_types WHERE xxcf_data_types.type_id = xapidel_obj.type_d //ACHTUNG: endpoint_use egal, lrs_type_id genutzt?
 
 
        //lrs_type_id deleted???
 
        /*
        if( !$this->hasLrsType() )
        {
            ilLoggerFactory::getRootLogger()->alert('No lrs type configured!');
            $cronResult->setStatus(ilCronJobResult::STATUS_INVALID_CONFIGURATION);
            return $cronResult;
        }
        */
        // $lpChangesQueue = new ilxapidelChangesQueue();
        // $lpChangesQueue->load();
 
        // $statementListBuilder = new ilxapidelXapiStatementListBuilder(ilLoggerFactory::getRootLogger(), $this->getLrsType());
        // $statementList = $statementListBuilder->buildStatementsList($lpChangesQueue);
        /*
        $lrsRequest = new ilxapidelXapiRequest(
            ilLoggerFactory::getRootLogger(),
            $this->getLrsType()->getLrsEndpointStatementsLink(),
            $this->getLrsType()->getLrsKey(),
            $this->getLrsType()->getLrsSecret()
        );
 
        if( $lrsRequest->send($statementList) )
        {
            if( $lpChangesQueue->hasEntries() )
            {
                $lpChangesQueue->delete();
                $cronResult->setStatus(ilCronJobResult::STATUS_OK);
            }
            else
            {
                $cronResult->setStatus(ilCronJobResult::STATUS_NO_ACTION);
            }
        }
        else
        {
            $cronResult->setStatus(ilCronJobResult::STATUS_FAIL);
        }
        */
 
        // Fall 1:
        // check deleted objects where updated = NULL
 
        $newDeletedObjects = $this->model->getNewDeletedXapiObjects();
        //ilLoggerFactory::getRootLogger()->alert(var_export($newDeletedObjects,TRUE));
 
        $deletedObjectData = array();
        $allDone = true;
        foreach ($newDeletedObjects as $deletedObject) {
            $this->log->debug("delete for " . (string) $deletedObject['obj_id']);
            // set object to updated
            $this->model->setXapiObjAsUpdated($deletedObject['obj_id']);
            // delete data
            $deleteRequest = new ilCmiXapiStatementsDeleteRequest(
                (int) $deletedObject['obj_id'],
                (int) $deletedObject['type_id'],
                (string) $deletedObject['activity_id'],
                null,
                ilCmiXapiStatementsDeleteRequest::DELETE_SCOPE_ALL
            );
            $done = $deleteRequest->delete();
            // entry in xxcf_users is already deleted from ilXapiCmi5StatementsDeleteRequest
            // delete in obj_id from xxcf_data_settings
            if ($done) {
                $this->log->debug("deleted data for object: " . (string) $deletedObject['obj_id']);
                $deletedObjectData[] = $deletedObject['obj_id'];
                $this->model->deleteXapiObjectEntry($deletedObject['obj_id']);
            } else {
                $this->log->debug("error: delete data for object: " . (string) $deletedObject['obj_id']);
                $this->model->resetUpdatedXapiObj($deletedObject['obj_id']);
                $allDone = false;
            }
        }
 
        // Fall 2:
        // check deleted users where updated = NULL
        $newDeletedUsers = $this->model->getNewDeletedUsers();
        foreach ($newDeletedUsers as $deletedUser) {
            $usrId = $deletedUser['usr_id'];
            // set user to updated
            $this->model->setUserAsUpdated($usrId);
            // get all objects of deleted user
            $xapiObjects = $this->model->getXapiObjectsByUser($usrId);
            $usrObjectsDone = true;
            foreach ($xapiObjects as $xapiObject) {
                $objId = $xapiObject['obj_id'];
                // check if all object data already successfully deleted in previous step within this run, because object was also deleted
                if (in_array($objId, $deletedObjectData)) {
                    $this->log->debug("nothing to do, because of complete object data deletion in previous step");
                    continue;
                }
                $deleteRequest = new ilCmiXapiStatementsDeleteRequest(
                    (int) $xapiObject['obj_id'],
                    (int) $xapiObject['lrs_type_id'],
                    (string) $xapiObject['activity_id'],
                    $usrId,
                    ilCmiXapiStatementsDeleteRequest::DELETE_SCOPE_OWN
                );
                $done = $deleteRequest->delete();
                // entry in xxcf_users is already deleted from ilXapiCmi5StatementsDeleteRequest
                if ($done) {
                    $this->log->debug("deleted object " . (string) $objId . " data for user " . (string) $usrId);
                } else {
                    $this->log->debug("error deleting object " . (string) $objId . " data for user " . (string) $usrId);
                    $usrObjectsDone = false;
                }
            } // EOF foreach ($xapiObjects as $xapiObject)
 
            if ($usrObjectsDone) {
                $this->model->deleteUserEntry($usrId);
            } else {
                $this->model->resetUpdatedXapiUser($usrId);
                $allDone = false;
            }
        }
 
        // Fall 3 wird noch gebraucht?
 
        // maybe more detailled success/fail messages?
 
        if ($allDone) {
            $cronResult->setStatus(JobResult::STATUS_OK);
        } else {
            $cronResult->setStatus(JobResult::STATUS_FAIL);
        }
        return $cronResult;
    }

References $DIC, $objId, ilCmiXapiStatementsDeleteRequest\DELETE_SCOPE_ALL, and ilCmiXapiStatementsDeleteRequest\DELETE_SCOPE_OWN.

Field Documentation

◆ $dic

ILIAS DI Container ilCmiXapiDelCron::$dic

private

Definition at line 42 of file class.ilCmiXapiDelCron.php.

◆ $log

ilLogger ilCmiXapiDelCron::$log

protected

Definition at line 40 of file class.ilCmiXapiDelCron.php.

◆ $lrsType

ilCmiXapiLrsType ilCmiXapiDelCron::$lrsType

protected

Definition at line 36 of file class.ilCmiXapiDelCron.php.

Referenced by getLrsType().

◆ $model

ilCmiXapiDelModel ilCmiXapiDelCron::$model

protected

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

◆ JOB_ID

const ilCmiXapiDelCron::JOB_ID = 'xapi_deletion_cron'

Definition at line 34 of file class.ilCmiXapiDelCron.php.

Referenced by getId().

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

components/ILIAS/CmiXapi/classes/class.ilCmiXapiDelCron.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getDefaultScheduleType()

◆ getDefaultScheduleValue()

◆ getDescription()

◆ getId()

◆ getLrsType()

◆ getTitle()

◆ hasAutoActivation()

◆ hasFlexibleSchedule()

◆ hasLrsType()

◆ run()

Field Documentation

◆ $dic

◆ $log

◆ $lrsType

◆ $model

◆ JOB_ID