Stores what celtic/lti keeps of the platforms that launch ILIAS in the lti2_* tables of ILIAS, through ilDB. More...

Inheritance diagram for ilLTIDataConnector:

Collaboration diagram for ilLTIDataConnector:

Public Member Functions
	__construct ()

	loadPlatform (Platform $platform)
	By record id, by issuer, client id and deployment id for an LTI Advantage launch, or by consumer key for an LTI 1.1 launch. More...

	savePlatform (Platform $platform)
	A launch only updates what the platform tells about itself, and the public key celtic/lti fetched from the key set of an LTI Advantage platform, which it keeps with its kid. More...

	loadContext (Context $context)

	saveContext (Context $context)

	loadResourceLink (ResourceLink $resourceLink)
	By record id, or by its id at the platform within its context or directly within its platform. More...

	saveResourceLink (ResourceLink $resourceLink)

	loadUserResult (UserResult $userresult)

	saveUserResult (UserResult $userresult)

	loadPlatformNonce (PlatformNonce $nonce)
	A nonce is found while it has not expired, which is what protects against replayed requests. More...

	savePlatformNonce (PlatformNonce $nonce)

	deletePlatformNonce (PlatformNonce $nonce)

	loadAccessToken (AccessToken $accessToken)
	The access token ILIAS got from an LTI Advantage platform for its services, one per platform. More...

	saveAccessToken (AccessToken $accessToken)

Private Member Functions
	fetchAdvantagePlatform (Platform $platform)
	The registration of the platform (ref_id 0) comes first. More...

	fetch (string $table, string $column, int\|string $value, string $type, string $order_by='')

	decodeSettings (?string $settings)
	Earlier releases stored some settings serialized instead of as JSON. More...

	toTimestamp (?string $date)

Private Attributes
const string	DATE_FORMAT = 'Y-m-d H:i:s'

readonly ilDBInterface	$database

Detailed Description

Stores what celtic/lti keeps of the platforms that launch ILIAS in the lti2_* tables of ILIAS, through ilDB.

The library decides by the data whether a launch is LTI 1.1 or LTI Advantage.

The tables are the ones of the library with three differences: the ids come from sequences, the id of lti2_user_result is user_pk, and a resource link always keeps its platform (consumer_pk), which the learning progress sent back to the platform relies on.

Only what a launch and the outcome services use is implemented. The rest of the methods of the library keep their defaults, which store nothing.

Author: Saúl Díaz sdiaz.nosp@m.@sur.nosp@m.labs..nosp@m.com

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

Constructor & Destructor Documentation

◆ __construct()

ilLTIDataConnector::__construct ( )

Definition at line 51 of file class.ilLTIDataConnector.php.

    {
        global $DIC;
 
        // every platform, tool and service of the library gets its storage here, so it logs to ILIAS from here on
        ilLTILibraryLogger::register();
        $this->database = $DIC->database();
        parent::__construct($this->database);
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\database(), and ilLTILibraryLogger\register().

Here is the call graph for this function:

Member Function Documentation

◆ decodeSettings()

ilLTIDataConnector::decodeSettings ( ?string $settings )

private

Earlier releases stored some settings serialized instead of as JSON.

Parameters

string | null $settings

Returns: array

Definition at line 428 of file class.ilLTIDataConnector.php.

                                                      : array
    {
        if ($settings === null || $settings === '') {
            return [];
        }
        $decoded = Util::jsonDecode($settings, true);
        if (!is_array($decoded)) {
            $decoded = @unserialize($settings, ['allowed_classes' => false]);
        }
 
        return is_array($decoded) ? $decoded : [];
    }

References $settings.

Referenced by loadContext(), loadPlatform(), and loadResourceLink().

Here is the caller graph for this function:

◆ deletePlatformNonce()

ilLTIDataConnector::deletePlatformNonce ( PlatformNonce $nonce )

Definition at line 331 of file class.ilLTIDataConnector.php.

                                                             : bool
    {
        $this->database->manipulateF(
            'DELETE FROM lti2_nonce WHERE consumer_pk = %s AND value = %s',
            ['integer', 'text'],
            [$nonce->getPlatform()->getRecordId() ?? 0, $nonce->getValue()]
        );
 
        return true;
    }

References ILIAS\Repository\database().

Here is the call graph for this function:

◆ fetch()

ilLTIDataConnector::fetch	(	string	$table,
		string	$column,
		int\|string	$value,
		string	$type,
		string	$order_by = `''`
	)

private

Parameters

string	$table
string	$column
int \| string	$value
string	$type
string	$order_by	which row wins when several match

Returns: array|null

Definition at line 411 of file class.ilLTIDataConnector.php.

                                                                                                                 : ?array
    {
        $this->database->setLimit(1);
 
        return $this->database->fetchAssoc($this->database->queryF(
            'SELECT * FROM ' . $table . ' WHERE ' . $column . ' = %s' . ($order_by !== '' ? ' ORDER BY ' . $order_by : ''),
            [$type],
            [$value]
        ));
    }

References ILIAS\Repository\database().

Referenced by loadAccessToken(), loadContext(), loadPlatform(), loadResourceLink(), and loadUserResult().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fetchAdvantagePlatform()

ilLTIDataConnector::fetchAdvantagePlatform ( Platform $platform )

private

The registration of the platform (ref_id 0) comes first.

Earlier releases registered an LTI Advantage platform once per released object (ref_id > 0): those rows are the fallback. The library leaves out client id and deployment id when the request does not give them.

Parameters

Platform $platform

Returns: array|null

Definition at line 385 of file class.ilLTIDataConnector.php.

                                                               : ?array
    {
        $where = ['platform_id = ' . $this->database->quote($platform->platformId, 'text')];
        if ($platform->clientId !== null && $platform->clientId !== '') {
            $where[] = 'client_id = ' . $this->database->quote($platform->clientId, 'text');
            if ($platform->deploymentId !== null && $platform->deploymentId !== '') {
                $where[] = 'deployment_id = ' . $this->database->quote($platform->deploymentId, 'text');
            }
        }
        $this->database->setLimit(1);
 
        return $this->database->fetchAssoc($this->database->query(
            'SELECT * FROM lti2_consumer WHERE ' . implode(' AND ', $where)
            . ' AND lti_version = ' . $this->database->quote(LtiVersion::V1P3->value, 'text')
            . ' ORDER BY ref_id, consumer_pk'
        ));
    }

References ILIAS\Repository\database().

Referenced by loadPlatform().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadAccessToken()

ilLTIDataConnector::loadAccessToken ( AccessToken $accessToken )

The access token ILIAS got from an LTI Advantage platform for its services, one per platform.

Definition at line 345 of file class.ilLTIDataConnector.php.

                                                             : bool
    {
        $row = $this->fetch('lti2_access_token', 'consumer_pk', (int) $accessToken->getPlatform()->getRecordId(), 'integer');
        if ($row === null) {
            return false;
        }
 
        $scopes = Util::jsonDecode((string) $row['scopes'], true);
        $accessToken->scopes = is_array($scopes) ? $scopes : [];
        $accessToken->token = (string) $row['token'];
        $accessToken->expires = $this->toTimestamp($row['expires']);
        $accessToken->created = $this->toTimestamp($row['created']);
        $accessToken->updated = $this->toTimestamp($row['updated']);
 
        return true;
    }

References $scopes, fetch(), and toTimestamp().

Here is the call graph for this function:

◆ loadContext()

ilLTIDataConnector::loadContext ( Context $context )

Definition at line 134 of file class.ilLTIDataConnector.php.

                                                 : bool
    {
        $row = $context->getRecordId() !== null
            ? $this->fetch('lti2_context', 'context_pk', $context->getRecordId(), 'integer')
            : $this->database->fetchAssoc($this->database->queryF(
                'SELECT * FROM lti2_context WHERE consumer_pk = %s AND lti_context_id = %s',
                ['integer', 'text'],
                [$context->getPlatform()->getRecordId(), $context->ltiContextId]
            ));
        if ($row === null) {
            return false;
        }
 
        $context->setRecordId((int) $row['context_pk']);
        $context->setPlatformId((int) $row['consumer_pk']);
        $context->title = $row['title'];
        $context->ltiContextId = $row['lti_context_id'];
        $context->type = $row['type'];
        $context->setSettings($this->decodeSettings($row['settings']));
        $context->created = $this->toTimestamp($row['created']);
        $context->updated = $this->toTimestamp($row['updated']);
 
        return true;
    }

References ILIAS\Repository\database(), decodeSettings(), fetch(), and toTimestamp().

Here is the call graph for this function:

◆ loadPlatform()

ilLTIDataConnector::loadPlatform ( Platform $platform )

By record id, by issuer, client id and deployment id for an LTI Advantage launch, or by consumer key for an LTI 1.1 launch.

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

                                                    : bool
    {
        $row = match (true) {
            $platform->getRecordId() !== null => $this->fetch('lti2_consumer', 'consumer_pk', $platform->getRecordId(), 'integer'),
            $platform->platformId !== null && $platform->platformId !== '' => $this->fetchAdvantagePlatform($platform),
            // earlier releases took the last of the platforms that share a consumer key
            $platform->getKey() !== null && $platform->getKey() !== '' => $this->fetch('lti2_consumer', 'consumer_key', $platform->getKey(), 'text', 'consumer_pk DESC'),
            default => null,
        };
        if ($row === null) {
            return false;
        }
 
        $platform->setRecordId((int) $row['consumer_pk']);
        $platform->name = (string) $row['name'];
        $platform->setKey($row['consumer_key']);
        $platform->secret = (string) $row['secret'];
        $platform->platformId = $row['platform_id'];
        $platform->clientId = $row['client_id'];
        $platform->deploymentId = $row['deployment_id'];
        $platform->rsaKey = $row['public_key'];
        $platform->ltiVersion = LtiVersion::tryFrom((string) $row['lti_version']);
        $platform->signatureMethod = (string) ($row['signature_method'] ?: 'HMAC-SHA1');
        $platform->consumerName = $row['consumer_name'];
        $platform->consumerVersion = $row['consumer_version'];
        $platform->consumerGuid = $row['consumer_guid'];
        $platform->setSettings($this->decodeSettings($row['settings']));
        $platform->protected = (int) $row['protected'] === 1;
        $platform->enabled = (int) $row['enabled'] === 1;
        $platform->enableFrom = $this->toTimestamp($row['enable_from']);
        $platform->enableUntil = $this->toTimestamp($row['enable_until']);
        $platform->lastAccess = $this->toTimestamp($row['last_access']);
        $platform->created = $this->toTimestamp($row['created']);
        $platform->updated = $this->toTimestamp($row['updated']);
        $this->fixPlatformSettings($platform, false);
        // platforms that do not register a token URL for their services may send it as a custom parameter
        $platform->accessTokenUrl = $platform->accessTokenUrl ?: ($platform->getSetting('custom_oauth2_access_token_url') ?: null);
 
        return true;
    }

References decodeSettings(), fetch(), fetchAdvantagePlatform(), ILIAS\Repository\int(), and toTimestamp().

Here is the call graph for this function:

◆ loadPlatformNonce()

ilLTIDataConnector::loadPlatformNonce ( PlatformNonce $nonce )

A nonce is found while it has not expired, which is what protects against replayed requests.

ILIAS as platform has no record of its own, so the nonces of the messages tools send it are kept under 0.

Definition at line 305 of file class.ilLTIDataConnector.php.

                                                           : bool
    {
        $this->database->manipulateF(
            'DELETE FROM lti2_nonce WHERE expires <= %s',
            ['timestamp'],
            [date(self::DATE_FORMAT)]
        );
 
        return $this->database->fetchAssoc($this->database->queryF(
            'SELECT value FROM lti2_nonce WHERE consumer_pk = %s AND value = %s',
            ['integer', 'text'],
            [$nonce->getPlatform()->getRecordId() ?? 0, $nonce->getValue()]
        )) !== null;
    }

References ILIAS\Repository\database(), and ILIAS\UI\examples\Symbol\Glyph\Date\date().

Here is the call graph for this function:

◆ loadResourceLink()

ilLTIDataConnector::loadResourceLink ( ResourceLink $resourceLink )

By record id, or by its id at the platform within its context or directly within its platform.

Definition at line 189 of file class.ilLTIDataConnector.php.

                                                                : bool
    {
        if ($resourceLink->getRecordId() !== null) {
            $row = $this->fetch('lti2_resource_link', 'resource_link_pk', $resourceLink->getRecordId(), 'integer');
        } elseif ($resourceLink->getContext() !== null) {
            $row = $this->database->fetchAssoc($this->database->queryF(
                'SELECT * FROM lti2_resource_link WHERE context_pk = %s AND lti_resource_link_id = %s',
                ['integer', 'text'],
                [$resourceLink->getContext()->getRecordId(), $resourceLink->getId()]
            ));
        } else {
            $row = $this->database->fetchAssoc($this->database->queryF(
                'SELECT * FROM lti2_resource_link WHERE context_pk IS NULL AND consumer_pk = %s AND lti_resource_link_id = %s',
                ['integer', 'text'],
                [$resourceLink->getPlatform()->getRecordId(), $resourceLink->getId()]
            ));
        }
        if ($row === null) {
            return false;
        }
 
        $resourceLink->setRecordId((int) $row['resource_link_pk']);
        $resourceLink->setContextId($row['context_pk'] === null ? null : (int) $row['context_pk']);
        $resourceLink->setPlatformId($row['consumer_pk'] === null ? null : (int) $row['consumer_pk']);
        $resourceLink->title = $row['title'];
        $resourceLink->ltiResourceLinkId = $row['lti_resource_link_id'];
        $resourceLink->setSettings($this->decodeSettings($row['settings']));
        $resourceLink->primaryResourceLinkId = $row['primary_resource_link_pk'] === null ? null : (int) $row['primary_resource_link_pk'];
        $resourceLink->shareApproved = $row['share_approved'] === null ? null : (int) $row['share_approved'] === 1;
        $resourceLink->created = $this->toTimestamp($row['created']);
        $resourceLink->updated = $this->toTimestamp($row['updated']);
 
        return true;
    }

References ILIAS\Repository\database(), decodeSettings(), fetch(), ILIAS\Repository\int(), and toTimestamp().

Here is the call graph for this function:

◆ loadUserResult()

ilLTIDataConnector::loadUserResult ( UserResult $userresult )

Definition at line 253 of file class.ilLTIDataConnector.php.

                                                          : bool
    {
        $row = $userresult->getRecordId() !== null
            ? $this->fetch('lti2_user_result', 'user_pk', $userresult->getRecordId(), 'integer')
            : $this->database->fetchAssoc($this->database->queryF(
                'SELECT * FROM lti2_user_result WHERE resource_link_pk = %s AND lti_user_id = %s',
                ['integer', 'text'],
                [$userresult->getResourceLink()->getRecordId(), $userresult->getId(IdScope::IdOnly)]
            ));
        if ($row === null) {
            return false;
        }
 
        $userresult->setRecordId((int) $row['user_pk']);
        $userresult->setResourceLinkId((int) $row['resource_link_pk']);
        $userresult->ltiUserId = $row['lti_user_id'];
        $userresult->ltiResultSourcedId = $row['lti_result_sourcedid'];
        $userresult->created = $this->toTimestamp($row['created']);
        $userresult->updated = $this->toTimestamp($row['updated']);
 
        return true;
    }

References ILIAS\Repository\database(), fetch(), and toTimestamp().

Here is the call graph for this function:

◆ saveAccessToken()

ilLTIDataConnector::saveAccessToken ( AccessToken $accessToken )

Definition at line 362 of file class.ilLTIDataConnector.php.

                                                             : bool
    {
        $consumer_pk = (int) $accessToken->getPlatform()->getRecordId();
        $now = date(self::DATE_FORMAT);
        $this->database->replace('lti2_access_token', ['consumer_pk' => ['integer', $consumer_pk]], [
            'scopes' => ['clob', json_encode($accessToken->scopes, JSON_UNESCAPED_SLASHES)],
            'token' => ['text', $accessToken->token],
            'expires' => ['timestamp', date(self::DATE_FORMAT, (int) $accessToken->expires)],
            'created' => ['timestamp', $accessToken->created === null ? $now : date(self::DATE_FORMAT, $accessToken->created)],
            'updated' => ['timestamp', $now],
        ]);
 
        return true;
    }

References ILIAS\Repository\database(), ILIAS\UI\examples\Symbol\Glyph\Date\date(), and ILIAS\Repository\int().

Here is the call graph for this function:

◆ saveContext()

ilLTIDataConnector::saveContext ( Context $context )

Definition at line 159 of file class.ilLTIDataConnector.php.

                                                 : bool
    {
        $context->updated = time();
        $fields = [
            'title' => ['text', $context->title],
            'type' => ['text', $context->type],
            'settings' => ['clob', json_encode($context->getSettings())],
            'updated' => ['timestamp', date(self::DATE_FORMAT, $context->updated)],
        ];
 
        if ($context->getRecordId() === null) {
            $context->created = $context->updated;
            $context->setRecordId($this->database->nextId('lti2_context'));
            $this->database->insert('lti2_context', $fields + [
                'context_pk' => ['integer', $context->getRecordId()],
                'consumer_pk' => ['integer', $context->getPlatform()->getRecordId()],
                'lti_context_id' => ['text', $context->ltiContextId],
                'created' => ['timestamp', date(self::DATE_FORMAT, $context->created)],
            ]);
            return true;
        }
 
        $this->database->update('lti2_context', $fields, ['context_pk' => ['integer', $context->getRecordId()]]);
 
        return true;
    }

References ILIAS\Repository\database(), and ILIAS\UI\examples\Symbol\Glyph\Date\date().

Here is the call graph for this function:

◆ savePlatform()

ilLTIDataConnector::savePlatform ( Platform $platform )

A launch only updates what the platform tells about itself, and the public key celtic/lti fetched from the key set of an LTI Advantage platform, which it keeps with its kid.

The platforms are defined in the administration and when an object is released, never here.

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

                                                    : bool
    {
        if ($platform->getRecordId() === null) {
            return false;
        }
 
        $platform->updated = time();
        $this->fixPlatformSettings($platform, true);
        $settings = $platform->getSettings();
        $this->fixPlatformSettings($platform, false);
        $this->database->update('lti2_consumer', [
            'public_key' => ['clob', $platform->rsaKey],
            'settings' => ['clob', json_encode($settings, JSON_UNESCAPED_SLASHES)],
            'consumer_name' => ['text', $platform->consumerName],
            'consumer_version' => ['text', $platform->consumerVersion],
            'consumer_guid' => ['text', $platform->consumerGuid],
            'last_access' => ['timestamp', $platform->lastAccess === null ? null : date(self::DATE_FORMAT, $platform->lastAccess)],
            'updated' => ['timestamp', date(self::DATE_FORMAT, $platform->updated)],
        ], ['consumer_pk' => ['integer', $platform->getRecordId()]]);
 
        return true;
    }

References $settings, ILIAS\Repository\database(), and ILIAS\UI\examples\Symbol\Glyph\Date\date().

Here is the call graph for this function:

◆ savePlatformNonce()

ilLTIDataConnector::savePlatformNonce ( PlatformNonce $nonce )

Definition at line 320 of file class.ilLTIDataConnector.php.

                                                           : bool
    {
        $this->database->insert('lti2_nonce', [
            'consumer_pk' => ['integer', $nonce->getPlatform()->getRecordId() ?? 0],
            'value' => ['text', $nonce->getValue()],
            'expires' => ['timestamp', date(self::DATE_FORMAT, $nonce->expires)],
        ]);
 
        return true;
    }

References ILIAS\Repository\database(), and ILIAS\UI\examples\Symbol\Glyph\Date\date().

Here is the call graph for this function:

◆ saveResourceLink()

ilLTIDataConnector::saveResourceLink ( ResourceLink $resourceLink )

Definition at line 224 of file class.ilLTIDataConnector.php.

                                                                : bool
    {
        $resourceLink->updated = time();
        $fields = [
            'title' => ['text', $resourceLink->title],
            'settings' => ['clob', json_encode($resourceLink->getSettings())],
            'primary_resource_link_pk' => ['integer', $resourceLink->primaryResourceLinkId],
            'share_approved' => ['integer', $resourceLink->shareApproved === null ? null : (int) $resourceLink->shareApproved],
            'updated' => ['timestamp', date(self::DATE_FORMAT, $resourceLink->updated)],
        ];
 
        if ($resourceLink->getRecordId() === null) {
            $resourceLink->created = $resourceLink->updated;
            $resourceLink->setRecordId($this->database->nextId('lti2_resource_link'));
            $this->database->insert('lti2_resource_link', $fields + [
                'resource_link_pk' => ['integer', $resourceLink->getRecordId()],
                'context_pk' => ['integer', $resourceLink->getContext()?->getRecordId()],
                'consumer_pk' => ['integer', $resourceLink->getPlatform()->getRecordId()],
                'lti_resource_link_id' => ['text', $resourceLink->getId()],
                'created' => ['timestamp', date(self::DATE_FORMAT, $resourceLink->created)],
            ]);
            return true;
        }
 
        $this->database->update('lti2_resource_link', $fields, ['resource_link_pk' => ['integer', $resourceLink->getRecordId()]]);
 
        return true;
    }

References ILIAS\Repository\database(), ILIAS\UI\examples\Symbol\Glyph\Date\date(), and ILIAS\Repository\int().

Here is the call graph for this function:

◆ saveUserResult()

ilLTIDataConnector::saveUserResult ( UserResult $userresult )

Definition at line 276 of file class.ilLTIDataConnector.php.

                                                          : bool
    {
        $userresult->updated = time();
        $fields = [
            'lti_result_sourcedid' => ['text', (string) $userresult->ltiResultSourcedId],
            'updated' => ['timestamp', date(self::DATE_FORMAT, $userresult->updated)],
        ];
 
        if ($userresult->getRecordId() === null) {
            $userresult->created = $userresult->updated;
            $userresult->setRecordId($this->database->nextId('lti2_user_result'));
            $this->database->insert('lti2_user_result', $fields + [
                'user_pk' => ['integer', $userresult->getRecordId()],
                'resource_link_pk' => ['integer', $userresult->getResourceLink()->getRecordId()],
                'lti_user_id' => ['text', $userresult->getId(IdScope::IdOnly)],
                'created' => ['timestamp', date(self::DATE_FORMAT, $userresult->created)],
            ]);
            return true;
        }
 
        $this->database->update('lti2_user_result', $fields, ['user_pk' => ['integer', $userresult->getRecordId()]]);
 
        return true;
    }

References ILIAS\Repository\database(), and ILIAS\UI\examples\Symbol\Glyph\Date\date().

Here is the call graph for this function:

◆ toTimestamp()

ilLTIDataConnector::toTimestamp ( ?string $date )

private

Definition at line 441 of file class.ilLTIDataConnector.php.

                                               : ?int
    {
        return $date === null || $date === '' ? null : (strtotime($date) ?: null);
    }

Referenced by loadAccessToken(), loadContext(), loadPlatform(), loadResourceLink(), and loadUserResult().

Here is the caller graph for this function:

Field Documentation

◆ $database

readonly ilDBInterface ilLTIDataConnector::$database

private

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

◆ DATE_FORMAT

const string ilLTIDataConnector::DATE_FORMAT = 'Y-m-d H:i:s'

private

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

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

components/ILIAS/LTI/classes/Tool/class.ilLTIDataConnector.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ decodeSettings()

◆ deletePlatformNonce()

◆ fetch()

◆ fetchAdvantagePlatform()

◆ loadAccessToken()

◆ loadContext()

◆ loadPlatform()

◆ loadPlatformNonce()

◆ loadResourceLink()

◆ loadUserResult()

◆ saveAccessToken()

◆ saveContext()

◆ savePlatform()

◆ savePlatformNonce()

◆ saveResourceLink()

◆ saveUserResult()

◆ toTimestamp()

Field Documentation

◆ $database

◆ DATE_FORMAT