Collaboration diagram for ilCmiXapiAuthToken:

Public Member Functions
	__construct ()

	getRefId ()

	setRefId (int $ref_id)

	getObjId ()

	setObjId (int $obj_id)

	getUsrId ()

	setUsrId (int $usr_id)

	getToken ()

	setToken (string $token)

	getValidUntil ()

	setValidUntil (string $valid_until)

	getLrsTypeId ()

	setLrsTypeId (int $lrs_type_id)

	getCmi5Session ()

	setCmi5Session (string $cmi5_session)

	getCmi5SessionData ()

	setCmi5SessionData (string $cmi5_session_data)

	getReturnedForCmi5Session ()

	setReturnedForCmi5Session (string $returned_for_cmi5_session)

	update ()

	delete ()

Static Public Member Functions
static	insertToken ($usrId, $refId, $objId, $lrsTypeId, $a_token, $a_time)

static	deleteTokenByObjIdAndUsrId (int $objId, int $usrId)

static	deleteTokenByObjIdAndRefIdAndUsrId (int $objId, int $refId, int $usrId)

static	deleteExpiredTokens ()

static	selectCurrentTimestamp ()

static	createToken ()

static	fillToken (int $usrId, int $refId, int $objId, int $lrsTypeId=0)

static	getInstanceByToken (string $token)

static	getInstanceByObjIdAndUsrId (int $objId, int $usrId, bool $checkValid=true)

static	getInstanceByObjIdAndRefIdAndUsrId (int $objId, int $refId, int $usrId, bool $checkValid=true)

static	getCmi5SessionByUsrIdAndObjIdAndRefId (int $usrId, int $objId, ?int $refId=null)

static	getWacSalt ()

Data Fields
const	DB_TABLE_NAME = 'cmix_token'

const	OPENSSL_ENCRYPTION_METHOD = 'aes128'

const	OPENSSL_IV = '1234567890123456'

Protected Attributes
int	$ref_id

int	$obj_id

int	$usr_id

string	$token

string	$valid_until

int	$lrs_type_id

string	$cmi5_session = null

string	$cmi5_session_data

string	$returned_for_cmi5_session = null

ilDBInterface	$db

Detailed Description

Definition at line 30 of file class.ilCmiXapiAuthToken.php.

Constructor & Destructor Documentation

◆ __construct()

ilCmiXapiAuthToken::__construct ( )

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

References $DIC.

     {
         global $DIC;
         $this->db = $DIC->database();
     }

Member Function Documentation

◆ createToken()

static ilCmiXapiAuthToken::createToken ( )

static

Definition at line 249 of file class.ilCmiXapiAuthToken.php.

                                         : string
     {
         return (new \Ramsey\Uuid\UuidFactory())->uuid4()->toString();
     }

◆ delete()

ilCmiXapiAuthToken::delete ( )

Definition at line 217 of file class.ilCmiXapiAuthToken.php.

References $DIC, getObjId(), getRefId(), and getUsrId().

                             : void
     {
         global $DIC; /* @var \ILIAS\DI\Container $DIC */
 
         $query = "
                         DELETE FROM " . self::DB_TABLE_NAME . "
                         WHERE obj_id = %s AND ref_id = %s AND usr_id = %s
                 ";
 
         $DIC->database()->manipulateF($query, array('integer', 'integer', 'integer'), array($this->getObjId(), $this->getRefId(), $this->getUsrId()));
     }

Here is the call graph for this function:

◆ deleteExpiredTokens()

static ilCmiXapiAuthToken::deleteExpiredTokens ( )

static

Definition at line 229 of file class.ilCmiXapiAuthToken.php.

References $DIC.

                                                 : void
     {
         global $DIC; /* @var \ILIAS\DI\Container $DIC */
 
         $query = "DELETE FROM " . self::DB_TABLE_NAME . " WHERE valid_until < CURRENT_TIMESTAMP";
         $DIC->database()->manipulate($query);
     }

◆ deleteTokenByObjIdAndRefIdAndUsrId()

static ilCmiXapiAuthToken::deleteTokenByObjIdAndRefIdAndUsrId	(	int	$objId,
		int	$refId,
		int	$usrId
	)

static

Definition at line 205 of file class.ilCmiXapiAuthToken.php.

References $DIC.

                                                                                                  : void
     {
         global $DIC; /* @var \ILIAS\DI\Container $DIC */
 
         $query = "
                         DELETE FROM " . self::DB_TABLE_NAME . "
                         WHERE obj_id = %s AND ref_id = %s AND usr_id = %s
                 ";
 
         $DIC->database()->manipulateF($query, array('integer', 'integer', 'integer'), array($objId, $refId, $usrId));
     }

◆ deleteTokenByObjIdAndUsrId()

static ilCmiXapiAuthToken::deleteTokenByObjIdAndUsrId	(	int	$objId,
		int	$usrId
	)

static

Definition at line 193 of file class.ilCmiXapiAuthToken.php.

References $DIC.

                                                                              : void
     {
         global $DIC; /* @var \ILIAS\DI\Container $DIC */
 
         $query = "
                         DELETE FROM " . self::DB_TABLE_NAME . "
                         WHERE obj_id = %s AND usr_id = %s
                 ";
 
         $DIC->database()->manipulateF($query, array('integer', 'integer'), array($objId, $usrId));
     }

◆ fillToken()

static ilCmiXapiAuthToken::fillToken	(	int	$usrId,
		int	$refId,
		int	$objId,
		int	$lrsTypeId = `0`
	)

static

Definition at line 254 of file class.ilCmiXapiAuthToken.php.

References Vendor\Package\$e, $token, IL_CAL_DATETIME, and IL_CAL_UNIX.

Referenced by ilLTIConsumerContentGUI\getLaunchParameters(), ilLTIConsumerContentGUI\getStartButtonTxt11(), ilLTIConsumerContentGUI\getStartButtonTxt13(), and ilCmiXapiLaunchGUI\getValidToken().

                                                                                             : string
     {
         //$seconds = $this->getTimeToDelete();
         $seconds = 86400; // TODO: invalidation interval
 
         $nowTimeDT = self::selectCurrentTimestamp();
 
         $nowTime = new ilDateTime($nowTimeDT, IL_CAL_DATETIME);
 
         $nowTimeTS = $nowTime->get(IL_CAL_UNIX);
         $newTimeTS = $nowTimeTS + $seconds;
 
         $newTime = new ilDateTime($newTimeTS, IL_CAL_UNIX);
 
         //self::deleteTokenByObjIdAndUsrId($object->getId(), $usrId);
 
         try {
             $tokenObject = self::getInstanceByObjIdAndRefIdAndUsrId($objId, $refId, $usrId, false);
             $tokenObject->setValidUntil($newTime->get(IL_CAL_DATETIME));
             $tokenObject->update();
 
             $token = $tokenObject->getToken();
         } catch (ilCmiXapiException $e) {
             $token = self::createToken();
             self::insertToken($usrId, $refId, $objId, $lrsTypeId, $token, $newTime->get(IL_CAL_DATETIME));
         }
 
         // TODO: move to cronjob ;-)
         // TODO: check cmi5 sessions of token and if not terminated -> abandoned statement
         self::deleteExpiredTokens();
 
         return $token;
     }

Here is the caller graph for this function:

◆ getCmi5Session()

ilCmiXapiAuthToken::getCmi5Session ( )

Definition at line 124 of file class.ilCmiXapiAuthToken.php.

References $cmi5_session.

Referenced by update().

                                     : ?string
     {
         return $this->cmi5_session;
     }

Here is the caller graph for this function:

◆ getCmi5SessionByUsrIdAndObjIdAndRefId()

static ilCmiXapiAuthToken::getCmi5SessionByUsrIdAndObjIdAndRefId	(	int	$usrId,
		int	$objId,
		?int	$refId = `null`
	)

static

Exceptions

ilCmiXapiException

Definition at line 393 of file class.ilCmiXapiAuthToken.php.

References $DIC, and $refId.

Referenced by ilObjCmiXapi\getSessionId().

                                                                                                             : string
     {
         global $DIC;
 
         if (empty($refId)) {
             $query = "SELECT cmi5_session FROM " . self::DB_TABLE_NAME . " WHERE usr_id = %s AND obj_id = %s";
             $result = $DIC->database()->queryF($query, array('integer', 'integer'), array($usrId, $objId));
         } else {
             $query = "SELECT cmi5_session FROM " . self::DB_TABLE_NAME . " WHERE usr_id = %s AND obj_id = %s AND ref_id = %s";
             $result = $DIC->database()->queryF($query, array('integer', 'integer', 'integer'), array($usrId, $objId, $refId));
         }
 
         $row = $DIC->database()->fetchAssoc($result);
 
         if ($row && $row['cmi5_session'] != '') {
             return $row['cmi5_session'];
         }
         throw new ilCmiXapiException('no valid cmi5_session found for: ' . $objId . '/' . $usrId);
     }

Here is the caller graph for this function:

◆ getCmi5SessionData()

ilCmiXapiAuthToken::getCmi5SessionData ( )

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

References $cmi5_session_data.

Referenced by update().

                                         : string
     {
         return $this->cmi5_session_data;
     }

Here is the caller graph for this function:

◆ getInstanceByObjIdAndRefIdAndUsrId()

static ilCmiXapiAuthToken::getInstanceByObjIdAndRefIdAndUsrId	(	int	$objId,
		int	$refId,
		int	$usrId,
		bool	$checkValid = `true`
	)

static

Exceptions

ilCmiXapiException

Definition at line 358 of file class.ilCmiXapiAuthToken.php.

References $DIC.

                                                                                                                           : \ilCmiXapiAuthToken
     {
         global $DIC; /* @var \ILIAS\DI\Container $DIC */
 
         $query = "SELECT * FROM " . self::DB_TABLE_NAME . " WHERE obj_id = %s AND ref_id = %s AND usr_id = %s";
 
         if ($checkValid) {
             $query .= " AND valid_until > CURRENT_TIMESTAMP";
         }
 
         $result = $DIC->database()->queryF($query, array('integer', 'integer', 'integer'), array($objId, $refId, $usrId));
 
         $row = $DIC->database()->fetchAssoc($result);
 
         if ($row) {
             $tokenObject = new self();
             $tokenObject->setToken($row['token']);
             $tokenObject->setValidUntil($row['valid_until']);
             $tokenObject->setUsrId((int) $row['usr_id']);
             $tokenObject->setObjId((int) $row['obj_id']);
             $tokenObject->setRefId((int) $row['ref_id']);
             $tokenObject->setLrsTypeId((int) $row['lrs_type_id']);
             $tokenObject->setCmi5Session($row['cmi5_session']);
             $tokenObject->setReturnedForCmi5Session($row['returned_for_cmi5_session']);
             $tokenObject->setCmi5SessionData((string) $row['cmi5_session_data']);
 
             return $tokenObject;
         }
 
         throw new ilCmiXapiException('no valid token found for: ' . $objId . '/' . $usrId);
     }

◆ getInstanceByObjIdAndUsrId()

static ilCmiXapiAuthToken::getInstanceByObjIdAndUsrId	(	int	$objId,
		int	$usrId,
		bool	$checkValid = `true`
	)

static

Exceptions

ilCmiXapiException

Definition at line 323 of file class.ilCmiXapiAuthToken.php.

References $DIC.

                                                                                                       : \ilCmiXapiAuthToken
     {
         global $DIC; /* @var \ILIAS\DI\Container $DIC */
 
         $query = "SELECT * FROM " . self::DB_TABLE_NAME . " WHERE obj_id = %s AND usr_id = %s";
 
         if ($checkValid) {
             $query .= " AND valid_until > CURRENT_TIMESTAMP";
         }
 
         $result = $DIC->database()->queryF($query, array('integer', 'integer'), array($objId, $usrId));
 
         $row = $DIC->database()->fetchAssoc($result);
 
         if ($row) {
             $tokenObject = new self();
             $tokenObject->setToken($row['token']);
             $tokenObject->setValidUntil($row['valid_until']);
             $tokenObject->setUsrId($row['usr_id']);
             $tokenObject->setObjId($row['obj_id']);
             $tokenObject->setRefId($row['ref_id']);
             $tokenObject->setLrsTypeId($row['lrs_type_id']);
             $tokenObject->setCmi5Session($row['cmi5_session']);
             $tokenObject->setReturnedForCmi5Session($row['returned_for_cmi5_session']);
             $tokenObject->setCmi5SessionData($row['cmi5_session_data']);
 
             return $tokenObject;
         }
 
         throw new ilCmiXapiException('no valid token found for: ' . $objId . '/' . $usrId);
     }

◆ getInstanceByToken()

static ilCmiXapiAuthToken::getInstanceByToken ( string $token )

static

Exceptions

ilCmiXapiException

Definition at line 291 of file class.ilCmiXapiAuthToken.php.

References $DIC, and $res.

Referenced by ilCmiXapiLaunchGUI\CMI5preLaunch(), XapiProxy\XapiProxyRequest\handleGetStatementsRequest(), ilLTIConsumerResultService\handleRequest(), and XapiProxy\XapiProxyPolyFill\initLrs().

                                                             : \ilCmiXapiAuthToken
     {
         global $DIC; /* @var \ILIAS\DI\Container $DIC */
 
         $query = "
                         SELECT * FROM " . self::DB_TABLE_NAME . "
                         WHERE token = %s AND valid_until > CURRENT_TIMESTAMP
                 ";
 
         $res = $DIC->database()->queryF($query, array('text'), array($token));
 
         while ($row = $DIC->database()->fetchAssoc($res)) {
             $tokenObject = new self();
             $tokenObject->setToken($token);
             $tokenObject->setValidUntil((string) $row['valid_until']);
             $tokenObject->setUsrId((int) $row['usr_id']);
             $tokenObject->setObjId((int) $row['obj_id']);
             $tokenObject->setRefId((int) $row['ref_id']);
             $tokenObject->setLrsTypeId((int) $row['lrs_type_id']);
             $tokenObject->setCmi5Session((string) $row['cmi5_session']);
             $tokenObject->setReturnedForCmi5Session((string) $row['returned_for_cmi5_session']);
             $tokenObject->setCmi5SessionData((string) $row['cmi5_session_data']);
 
             return $tokenObject;
         }
 
         throw new ilCmiXapiException('no valid token found for: ' . $token);
     }

Here is the caller graph for this function:

◆ getLrsTypeId()

ilCmiXapiAuthToken::getLrsTypeId ( )

Definition at line 114 of file class.ilCmiXapiAuthToken.php.

References $lrs_type_id.

Referenced by update().

                                   : int
     {
         return $this->lrs_type_id;
     }

Here is the caller graph for this function:

◆ getObjId()

ilCmiXapiAuthToken::getObjId ( )

Definition at line 74 of file class.ilCmiXapiAuthToken.php.

References $obj_id.

Referenced by delete(), ilCmiXapiUser\getCMI5RegistrationFromAuthToken(), and update().

                               : int
     {
         return $this->obj_id;
     }

Here is the caller graph for this function:

◆ getRefId()

ilCmiXapiAuthToken::getRefId ( )

Definition at line 64 of file class.ilCmiXapiAuthToken.php.

References $ref_id.

Referenced by delete(), ilCmiXapiUser\getRegistrationFromAuthToken(), and update().

                               : int
     {
         return $this->ref_id;
     }

Here is the caller graph for this function:

◆ getReturnedForCmi5Session()

ilCmiXapiAuthToken::getReturnedForCmi5Session ( )

Definition at line 144 of file class.ilCmiXapiAuthToken.php.

References $returned_for_cmi5_session.

Referenced by update().

                                                : ?string
     {
         return $this->returned_for_cmi5_session;
     }

Here is the caller graph for this function:

◆ getToken()

ilCmiXapiAuthToken::getToken ( )

Definition at line 94 of file class.ilCmiXapiAuthToken.php.

References $token.

Referenced by update().

                               : string
     {
         return $this->token;
     }

Here is the caller graph for this function:

◆ getUsrId()

ilCmiXapiAuthToken::getUsrId ( )

Definition at line 84 of file class.ilCmiXapiAuthToken.php.

References $usr_id.

Referenced by delete(), ilCmiXapiUser\getCMI5RegistrationFromAuthToken(), ilCmiXapiUser\getRegistrationFromAuthToken(), and update().

                               : int
     {
         return $this->usr_id;
     }

Here is the caller graph for this function:

◆ getValidUntil()

ilCmiXapiAuthToken::getValidUntil ( )

Definition at line 104 of file class.ilCmiXapiAuthToken.php.

References $valid_until.

Referenced by update().

                                    : string
     {
         return $this->valid_until;
     }

Here is the caller graph for this function:

◆ getWacSalt()

static ilCmiXapiAuthToken::getWacSalt ( )

static

Exceptions

ilCmiXapiException

Definition at line 416 of file class.ilCmiXapiAuthToken.php.

Referenced by ilCmiXapiLaunchGUI\buildAuthTokenFetchParam().

                                        : string
     {
         include 'data/wacsalt.php';
 
         if (isset($salt)) {
             return $salt;
         }
 
         throw new ilCmiXapiException('no salt for encryption provided');
     }

Here is the caller graph for this function:

◆ insertToken()

static ilCmiXapiAuthToken::insertToken	(	$usrId,
		$refId,
		$objId,
		$lrsTypeId,
		$a_token,
		$a_time
	)

static

Definition at line 174 of file class.ilCmiXapiAuthToken.php.

References $DIC, $objId, and $refId.

                                                                                              : void
     {
         global $DIC; /* @var \ILIAS\DI\Container $DIC */
 
         $DIC->database()->insert(
             self::DB_TABLE_NAME,
             array(
                 'token' => array('text', $a_token),
                 'valid_until' => array('timestamp', $a_time),
                 'ref_id' => array('integer', $refId),
                 'obj_id' => array('integer', $objId),
                 'usr_id' => array('integer', $usrId),
                 'lrs_type_id' => array('integer', $lrsTypeId)
             )
         );
         // 'cmi5_session' defaults always to '' by inserting
         // 'returned_for_cmi5_session' defaults always to '' by inserting
     }

◆ selectCurrentTimestamp()

static ilCmiXapiAuthToken::selectCurrentTimestamp ( )

static

Definition at line 238 of file class.ilCmiXapiAuthToken.php.

References $DIC.

Referenced by ilCmiXapiResult\insert(), and ilCmiXapiResult\update().

                                                    : string
     {
         global $DIC; /* @var \ILIAS\DI\Container $DIC */
 
         $query = "SELECT CURRENT_TIMESTAMP";
         $result = $DIC->database()->query($query);
         $row = $DIC->database()->fetchAssoc($result);
 
         return (string) $row['CURRENT_TIMESTAMP'];
     }

Here is the caller graph for this function:

◆ setCmi5Session()

ilCmiXapiAuthToken::setCmi5Session ( string $cmi5_session )

Definition at line 129 of file class.ilCmiXapiAuthToken.php.

References $cmi5_session.

                                                         : void
     {
         $this->cmi5_session = $cmi5_session;
     }

◆ setCmi5SessionData()

ilCmiXapiAuthToken::setCmi5SessionData ( string $cmi5_session_data )

Definition at line 139 of file class.ilCmiXapiAuthToken.php.

References $cmi5_session_data.

                                                                  : void
     {
         $this->cmi5_session_data = $cmi5_session_data;
     }

◆ setLrsTypeId()

ilCmiXapiAuthToken::setLrsTypeId ( int $lrs_type_id )

Definition at line 119 of file class.ilCmiXapiAuthToken.php.

References $lrs_type_id.

                                                   : void
     {
         $this->lrs_type_id = $lrs_type_id;
     }

◆ setObjId()

ilCmiXapiAuthToken::setObjId ( int $obj_id )

Definition at line 79 of file class.ilCmiXapiAuthToken.php.

References $obj_id.

                                          : void
     {
         $this->obj_id = $obj_id;
     }

◆ setRefId()

ilCmiXapiAuthToken::setRefId ( int $ref_id )

Definition at line 69 of file class.ilCmiXapiAuthToken.php.

References $ref_id.

                                          : void
     {
         $this->ref_id = $ref_id;
     }

◆ setReturnedForCmi5Session()

ilCmiXapiAuthToken::setReturnedForCmi5Session ( string $returned_for_cmi5_session )

Definition at line 149 of file class.ilCmiXapiAuthToken.php.

References $returned_for_cmi5_session.

                                                                                 : void
     {
         $this->returned_for_cmi5_session = $returned_for_cmi5_session;
     }

◆ setToken()

ilCmiXapiAuthToken::setToken ( string $token )

Definition at line 99 of file class.ilCmiXapiAuthToken.php.

References $token.

                                            : void
     {
         $this->token = $token;
     }

◆ setUsrId()

ilCmiXapiAuthToken::setUsrId ( int $usr_id )

Definition at line 89 of file class.ilCmiXapiAuthToken.php.

References $usr_id.

                                          : void
     {
         $this->usr_id = $usr_id;
     }

◆ setValidUntil()

ilCmiXapiAuthToken::setValidUntil ( string $valid_until )

Definition at line 109 of file class.ilCmiXapiAuthToken.php.

References $valid_until.

                                                       : void
     {
         $this->valid_until = $valid_until;
     }

◆ update()

ilCmiXapiAuthToken::update ( )

Definition at line 154 of file class.ilCmiXapiAuthToken.php.

References getCmi5Session(), getCmi5SessionData(), getLrsTypeId(), getObjId(), getRefId(), getReturnedForCmi5Session(), getToken(), getUsrId(), and getValidUntil().

                             : void
     {
         $this->db->update(
             self::DB_TABLE_NAME,
             [
                 'valid_until' => array('timestamp', $this->getValidUntil()),
                 'ref_id' => array('integer', $this->getRefId()),
                 'obj_id' => array('integer', $this->getObjId()),
                 'usr_id' => array('integer', $this->getUsrId()),
                 'lrs_type_id' => array('integer', $this->getLrsTypeId()),
                 'cmi5_session' => array('text', $this->getCmi5Session()),
                 'returned_for_cmi5_session' => array('text', $this->getReturnedForCmi5Session()),
                 'cmi5_session_data' => array('clob', $this->getCmi5SessionData())
             ],
             [
                 'token' => array('text', $this->getToken()),
             ]
         );
     }