DataConnector.php

Go to the documentation of this file.

<?php

namespace ILIAS\LTI\ToolProvider\DataConnector;

use ILIAS\LTI\ToolProvider\PlatformNonce;
use ILIAS\LTI\ToolProvider\Context;
use ILIAS\LTI\ToolProvider\ResourceLink;
use ILIAS\LTI\ToolProvider\ResourceLinkShare;
use ILIAS\LTI\ToolProvider\ResourceLinkShareKey;
use ILIAS\LTI\ToolProvider\Platform;
use ILIAS\LTI\ToolProvider\UserResult;
use ILIAS\LTI\ToolProvider\Tool;
use ILIAS\LTI\ToolProvider\Util;
//UK: added
use ILIAS\LTI\ToolProvider\AccessToken;

class DataConnector
{
    public const PLATFORM_TABLE_NAME = 'lti2_consumer';

    public const CONSUMER_TABLE_NAME = self::PLATFORM_TABLE_NAME;

    public const CONTEXT_TABLE_NAME = 'lti2_context';

    public const RESOURCE_LINK_TABLE_NAME = 'lti2_resource_link';

    public const USER_RESULT_TABLE_NAME = 'lti2_user_result';

    public const RESOURCE_LINK_SHARE_KEY_TABLE_NAME = 'lti2_share_key';

    public const NONCE_TABLE_NAME = 'lti2_nonce';

    public const ACCESS_TOKEN_TABLE_NAME = 'lti2_access_token';

    public const TOOL_TABLE_NAME = 'lti2_tool';

    protected $db = null;

    protected string $dbTableNamePrefix = '';

    protected string $dateFormat = 'Y-m-d';

    protected string $timeFormat = 'H:i:s';

    protected function __construct(object $db, string $dbTableNamePrefix = '')
    {
        $this->db = $db;
        $this->dbTableNamePrefix = $dbTableNamePrefix;
    }

    ###
    ###  Platform methods
    ###

//    /**
//     * Load tool consumer object.
//     *
//     * @deprecated Use loadPlatform() instead
//     * @see DataConnector::loadPlatform()
//     *
//     * @param ToolConsumer $consumer  Tool consumer object
//     *
//     * @return bool    True if the tool consumer object was successfully loaded
//     */
//    public function loadToolConsumer($consumer)
//    {
//        Util::logDebug('Method ceLTIc\LTI\DataConnector\DataConnector::loadToolConsumer() has been deprecated; please use ceLTIc\LTI\DataConnector\DataConnector::loadPlatform() instead.',
//            true);
//        return $this->loadPlatform($consumer);
//    }

//    /**
//     * Save tool consumer object.
//     *
//     * @deprecated Use savePlatform() instead
//     * @see DataConnector::savePlatform()
//     *
//     * @param ToolConsumer $consumer  Tool consumer object
//     *
//     * @return bool    True if the tool consumer object was successfully saved
//     */
//    public function saveToolConsumer($consumer)
//    {
//        Util::logDebug('Method ceLTIc\LTI\DataConnector\DataConnector::saveToolConsumer() has been deprecated; please use ceLTIc\LTI\DataConnector\DataConnector::savePlatform() instead.',
//            true);
//        return $this->savePlatform($consumer);
//    }

//    /**
//     * Delete tool consumer object.
//     *
//     * @deprecated Use deletePlatform() instead
//     * @see DataConnector::deletePlatform()
//     *
//     * @param ToolConsumer $consumer  Tool consumer object
//     *
//     * @return bool    True if the tool consumer object was successfully deleted
//     */
//    public function deleteToolConsumer($consumer)
//    {
//        Util::logDebug('Method ceLTIc\LTI\DataConnector\DataConnector::deleteToolConsumer() has been deprecated; please use ceLTIc\LTI\DataConnector\DataConnector::deletePlatform() instead.',
//            true);
//        return $this->deletePlatform($consumer);
//    }

//    /**
//     * Load tool consumer objects.
//     *
//     * @deprecated Use getPlatforms() instead
//     * @see DataConnector::getPlatforms()
//     *
//     * @return ToolConsumer[] Array of all defined tool consumer objects
//     */
//    public function getToolConsumers()
//    {
//        Util::logDebug('Method ceLTIc\LTI\DataConnector\DataConnector::getToolConsumers() has been deprecated; please use ceLTIc\LTI\DataConnector\DataConnector::getPlatforms() instead.',
//            true);
//        return $this->getPlatforms();
//    }

    public function loadPlatform(Platform $platform): bool
    {
        $platform->secret = 'secret';
        $platform->enabled = true;
        $now = time();
        $platform->created = $now;
        $platform->updated = $now;

        return true;
    }

    public function savePlatform(Platform $platform): bool
    {
        $platform->updated = time();

        return true;
    }

    public function deletePlatform(Platform $platform): bool
    {
        $platform->initialize();

        return true;
    }

    public function getPlatforms(): array
    {
        return array();
    }

    ###
    ###  Context methods
    ###

    public function loadContext(Context $context): bool
    {
        $now = time();
        $context->created = $now;
        $context->updated = $now;

        return true;
    }

    public function saveContext(Context $context): bool
    {
        $context->updated = time();

        return true;
    }

    public function deleteContext(Context $context): bool
    {
        $context->initialize();

        return true;
    }

    ###
    ###  ResourceLink methods
    ###

    public function loadResourceLink(ResourceLink $resourceLink): bool
    {
        $now = time();
        $resourceLink->created = $now;
        $resourceLink->updated = $now;

        return true;
    }

    public function saveResourceLink(ResourceLink $resourceLink): bool
    {
        $resourceLink->updated = time();

        return true;
    }

    public function deleteResourceLink(ResourceLink $resourceLink): bool
    {
        $resourceLink->initialize();

        return true;
    }

    public function getUserResultSourcedIDsResourceLink(ResourceLink $resourceLink, bool $localOnly, int $idScope): array
    {
        return array();
    }

    public function getSharesResourceLink(ResourceLink $resourceLink): array
    {
        return array();
    }

    ###
    ###  PlatformNonce methods
    ###

//    /**
//     * Load nonce object.
//     *
//     * @deprecated Use loadPlatformNonce() instead
//     * @see DataConnector::loadPlatformNonce()
//     *
//     * @param ConsumerNonce $nonce Nonce object
//     *
//     * @return bool    True if the nonce object was successfully loaded
//     */
//    public function loadConsumerNonce($nonce)
//    {
//        Util::logDebug('Method ceLTIc\LTI\DataConnector\DataConnector::loadConsumerNonce() has been deprecated; please use ceLTIc\LTI\DataConnector\DataConnector::loadPlatformNonce() instead.',
//            true);
//        return $this->loadPlatformNonce($nonce);
//    }

//    /**
//     * Save nonce object.
//     *
//     * @deprecated Use savePlatformNonce() instead
//     * @see DataConnector::savePlatformNonce()
//     *
//     * @param ConsumerNonce $nonce Nonce object
//     *
//     * @return bool    True if the nonce object was successfully saved
//     */
//    public function saveConsumerNonce($nonce)
//    {
//        Util::logDebug('Method ceLTIc\LTI\DataConnector\DataConnector::saveConsumerNonce() has been deprecated; please use ceLTIc\LTI\DataConnector\DataConnector::savePlatformNonce() instead.',
//            true);
//        return $this->savePlatformNonce($nonce);
//    }

//    /**
//     * Delete nonce object.
//     *
//     * @deprecated Use deletePlatformNonce() instead
//     * @see DataConnector::deletePlatformNonce()
//     *
//     * @param ConsumerNonce $nonce Nonce object
//     *
//     * @return bool    True if the nonce object was successfully deleted
//     */
//    public function deleteConsumerNonce($nonce)
//    {
//        Util::logDebug('Method ceLTIc\LTI\DataConnector\DataConnector::deleteConsumerNonce() has been deprecated; please use ceLTIc\LTI\DataConnector\DataConnector::deletePlatformNonce() instead.',
//            true);
//        return $this->deletePlatformNonce($nonce);
//    }

    public function loadPlatformNonce(PlatformNonce $nonce): bool
    {
        return false;  // assume the nonce does not already exist
    }

    public function savePlatformNonce(PlatformNonce $nonce): bool
    {
        return true;
    }

    public function deletePlatformNonce(PlatformNonce $nonce): bool
    {
        return true;
    }

    ###
    ###  AccessToken methods
    ###

    public function loadAccessToken(AccessToken $accessToken): bool
    {
        return false;  // assume the access token does not already exist
    }

    public function saveAccessToken(AccessToken $accessToken): bool
    {
        return true;
    }

    ###
    ###  ResourceLinkShareKey methods
    ###

    public function loadResourceLinkShareKey(ResourceLinkShareKey $shareKey): bool
    {
        return true;
    }

    public function saveResourceLinkShareKey(ResourceLinkShareKey $shareKey): bool
    {
        return true;
    }

    public function deleteResourceLinkShareKey(ResourceLinkShareKey $shareKey): bool
    {
        return true;
    }

    ###
    ###  UserResult methods
    ###

    public function loadUserResult(UserResult $userresult): bool
    {
        $now = time();
        $userresult->created = $now;
        $userresult->updated = $now;

        return true;
    }

    public function saveUserResult(UserResult $userresult): bool
    {
        $userresult->updated = time();

        return true;
    }

    public function deleteUserResult(UserResult $userresult): bool
    {
        $userresult->initialize();

        return true;
    }

    ###
    ###  Tool methods
    ###

    public function loadTool(Tool $tool): bool
    {
        $tool->secret = 'secret';
        $tool->enabled = true;
        $now = time();
        $tool->created = $now;
        $tool->updated = $now;

        return true;
    }

    public function saveTool(Tool $tool): bool
    {
        $tool->updated = time();

        return true;
    }

    public function deleteTool(Tool $tool): bool
    {
        $tool->initialize();

        return true;
    }

    public function getTools(): array
    {
        return array();
    }

    ###
    ###  Other methods
    ###

    public static function getDataConnector(object $db = null, string $dbTableNamePrefix = '', string $type = ''): DataConnector
    {
        if (is_null($dbTableNamePrefix)) {
            $dbTableNamePrefix = '';
        }
        if (!is_null($db) && empty($type)) {
            if (is_object($db)) {
                $type = get_class($db);
            } elseif (is_resource($db)) {
                $type = strtok(get_resource_type($db), ' ');
            }
        }
        $type = strtolower($type);
        if ($type === 'pdo') {
            if ($db->getAttribute(\PDO::ATTR_DRIVER_NAME) === 'pgsql') {
                $type .= '_pgsql';
            } elseif ($db->getAttribute(\PDO::ATTR_DRIVER_NAME) === 'oci') {
                $type .= '_oci';
            }
        }
        if (!empty($type)) {
            $type = "DataConnector_{$type}";
        } else {
            $type = 'DataConnector';
        }
        $type = "\\ceLTIc\\LTI\\DataConnector\\{$type}";
        $dataConnector = new $type($db, $dbTableNamePrefix);

        return $dataConnector;
    }

//    /**
//     * Generate a random string.
//     *
//     * The generated string will only comprise letters (upper- and lower-case) and digits.
//     *
//     * @deprecated Use Util::getRandomString() instead
//     * @see Util::getRandomString()
//     *
//     * @param int $length Length of string to be generated (optional, default is 8 characters)
//     *
//     * @return string Random string
//     */
//    public static function getRandomString($length = 8)
//    {
//        Util::logDebug('Method ceLTIc\LTI\DataConnector::getRandomString() has been deprecated; please use ceLTIc\LTI\Util::getRandomString() instead.',
//            true);
//        return Util::getRandomString($length);
//    }

    public function escape(string $value, bool $addQuotes = true): string
    {
        return static::quoted($value, $addQuotes);
    }

    public static function quoted(string $value, bool $addQuotes = true): string
    {
        if (is_null($value)) {
            $value = 'null';
        } else {
            $value = str_replace('\'', '\'\'', $value);
            if ($addQuotes) {
                $value = "'{$value}'";
            }
        }

        return $value;
    }

    protected function fixPlatformSettings(Platform $platform, bool $isSave)
    {
        if (!$isSave) {
            $platform->authorizationServerId = $platform->getSetting('_authorization_server_id', $platform->authorizationServerId);
            $platform->setSetting('_authorization_server_id');
            $platform->authenticationUrl = $platform->getSetting('_authentication_request_url', $platform->authenticationUrl);
            $platform->setSetting('_authentication_request_url');
            $platform->accessTokenUrl = $platform->getSetting('_oauth2_access_token_url', $platform->accessTokenUrl);
            $platform->setSetting('_oauth2_access_token_url');
            $platform->jku = $platform->getSetting('_jku', $platform->jku);
            $platform->setSetting('_jku');
            $platform->encryptionMethod = $platform->getSetting('_encryption_method', $platform->encryptionMethod);
            $platform->setSetting('_encryption_method');
            $platform->debugMode = $platform->getSetting('_debug', $platform->debugMode ? 'true' : 'false') === 'true';
            $platform->setSetting('_debug');
            if ($platform->debugMode) {
                Util::$logLevel = Util::LOGLEVEL_DEBUG;
            }
        } else {
            $platform->setSetting(
                '_authorization_server_id',
                !empty($platform->authorizationServerId) ? $platform->authorizationServerId : null
            );
            $platform->setSetting(
                '_authentication_request_url',
                !empty($platform->authenticationUrl) ? $platform->authenticationUrl : null
            );
            $platform->setSetting('_oauth2_access_token_url', !empty($platform->accessTokenUrl) ? $platform->accessTokenUrl : null);
            $platform->setSetting('_jku', !empty($platform->jku) ? $platform->jku : null);
            $platform->setSetting('_encryption_method', !empty($platform->encryptionMethod) ? $platform->encryptionMethod : null);
            $platform->setSetting('_debug', $platform->debugMode ? 'true' : null);
        }
    }

    protected function fixToolSettings(Tool $tool, bool $isSave)
    {
        if (!$isSave) {
            $tool->encryptionMethod = $tool->getSetting('_encryption_method', $tool->encryptionMethod);
            $tool->setSetting('_encryption_method');
            $tool->debugMode = $tool->getSetting('_debug', $tool->debugMode ? 'true' : 'false') === 'true';
            $tool->setSetting('_debug');
            if ($tool->debugMode) {
                Util::$logLevel = Util::LOGLEVEL_DEBUG;
            }
        } else {
            $tool->setSetting('_encryption_method', !empty($tool->encryptionMethod) ? $tool->encryptionMethod : null);
            $tool->setSetting('_debug', $tool->debugMode ? 'true' : null);
        }
    }
}