Functions
catch(ilCmiXapiException $e)	send ($response)

Variables
	$tokenRestriction = true
	see: https://github.com/AICC/CMI-5_Spec_Current/blob/quartz/cmi5_spec.md#fetch_url response should always be a valid json object check oneway fetching is optional: More...

	$origParam = $_GET['param']

if(!isset($origParam)\|\|!strlen($origParam))	try

	$param

	$_COOKIE [session_name()] = $param[session_name()]

	$_COOKIE ['ilClientId'] = $param['ilClientId']

	$objId = $param['obj_id']

	$refId = $param['ref_id']

	$DIC = $GLOBALS['DIC']

	$token = ilCmiXapiAuthToken::getInstanceByObjIdAndRefIdAndUsrId($objId, $refId, $DIC->user()->getId())

if($object->getContentType()==ilObjCmiXapi::CONT_TYPE_CMI5) if($object->isBypassProxyEnabled())	else

	$response = array("auth-token" => $authToken)

Function Documentation

◆ send()

catch (ilCmiXapiException $e) send ( $response )

Definition at line 100 of file xapitoken.php.

References $_SERVER, $response, and exit.

Referenced by nusoap_client\call(), soap_transport_http\sendHTTPS(), and ILIAS\LTI\ToolProvider\Service\ToolSettings\set().

                         : void
 {
     if (isset($_SERVER["HTTP_ORIGIN"]) && $_SERVER["HTTP_ORIGIN"] != "") {
         header('Access-Control-Allow-Origin: ' . $_SERVER["HTTP_ORIGIN"]);
     }
     header('Access-Control-Allow-Credentials: true');
     header('Content-type:application/json;charset=utf-8');
     echo json_encode($response);
     exit;
 }

Here is the caller graph for this function:

Variable Documentation

◆ $_COOKIE [1/2]

$_COOKIE[session_name()] = $param[session_name()]

Definition at line 54 of file xapitoken.php.

Referenced by ilStartUpGUI\_checkGoto(), ilTinyMCE\addCustomRTESupport(), ilTinyMCE\addRTESupport(), ilTestInfoScreenToolbarGUI\buildSessionLockString(), ilContainerGUI\cloneAllObject(), ilObjectCopyGUI\copyContainer(), ilDclContentExporter\exportAsync(), ilDelegatingHandler\handle(), ilInitialisation\initRefinery(), ilSoapUserAdministration\login(), ilCalendarRemoteAccessHandler\parseRequest(), ILIAS\UI\Implementation\Component\Layout\Page\Renderer\renderStandardPage(), ilInitialisation\resumeUserSession(), ilPlainTextHandler\tables(), and ilLoggingErrorFileStorage\tables().

◆ $_COOKIE [2/2]

$_COOKIE[ 'ilClientId'] = $param['ilClientId']

Definition at line 56 of file xapitoken.php.

◆ $DIC

$DIC = $GLOBALS['DIC']

Definition at line 62 of file xapitoken.php.

◆ $objId

$objId = $param['obj_id']

Definition at line 57 of file xapitoken.php.

Referenced by ilObjectCustomUserFieldsPlaceholderValues\__construct(), ilUserDefinedFieldsPlaceholderValues\__construct(), ilTestPlaceholderValues\__construct(), ilDefaultPlaceholderValues\__construct(), ilDclDetailedViewGUI\__construct(), ilObjCourseReferenceAccess\_preloadData(), ilObjChatroom\cloneObject(), ilCertificateTemplateDatabaseRepository\deleteTemplate(), ilObjCourseGUI\deliverCertificateObject(), ILIAS\Certificate\API\Filter\UserDataFilter\ensureValidUniqueObjIds(), ilCmiXapiContentUploadImporter\generateActivityId(), ilCourseMailTemplateMemberContext\getCachedPeriodByObjId(), ilCourseMailTemplateTutorContext\getCachedPeriodByObjId(), ilLPStatusCmiXapiAbstract\getCmixUserResult(), ilCertificateCron\getDefaultScheduleValue(), ilCertificateGUI\getEditorForm(), XapiProxy\XapiProxyPolyFill\getLrsType(), ilLPStatusLtiOutcome\getLtiUserResult(), ilPDSelectedItemsBlockMembershipsProvider\getObjectsByMembership(), ilForumDraftsDerivedTaskProvider\getTasks(), ilLPStatusTestPassed\getUserIdsByResultArrayStatus(), ilObjChatroomGUI\insertObject(), ilCmiXapiAuthToken\insertToken(), ilEmployeeTalkMyStaffListGUI\loadActionBar(), ilObjTest\lookupQuestionSetType(), ilContentPageDataSet\readData(), ilXapiResultsCronjob\run(), ilCertificateTemplateDatabaseRepository\save(), ilObjCmiXapiVerificationGUI\save(), ilObjLTIConsumerVerificationGUI\save(), ilUserCertificateRepository\save(), ilObjChatroomAccessTest\testAccessChecksFail(), ilObjChatroomAccessTest\testAccessChecksSucceed(), ilSCORMItemGUI\view(), and ilSCORMPresentationGUI\view().

◆ $origParam

$origParam = $_GET['param']

Definition at line 36 of file xapitoken.php.

◆ $param

$param

Initial value:

= json_decode(openssl_decrypt(
        $param,
        ilCmiXapiAuthToken::OPENSSL_ENCRYPTION_METHOD,
        ilCmiXapiAuthToken::getWacSalt(),
        0,
        ilCmiXapiAuthToken::OPENSSL_IV
    ), true)

Definition at line 46 of file xapitoken.php.

Referenced by ilStartUpGUI\_checkGoto(), ilHistory\_createEntry(), ILIAS\UI\examples\ViewControl\Section\base(), ILIAS\UI\examples\ViewControl\Mode\base(), ILIAS\GlobalScreen\Scope\Layout\Factory\AbstractLayoutModification\checkClosure(), ilOrgUnitStaffGUI\confirmRemoveUser(), ilErrorHandling\devmodeHandler(), ilWebResourceEditableLinkTableGUI\fillRow(), ilCmiXapiLaunchGUI\getAuthTokenFetchLink(), ilObjQuestionPoolListGUI\getCommandLink(), ilObjTestListGUI\getCommandLink(), ilObjLTIConsumer\getCustomParamsArray(), LSUrlBuilder\getHref(), ilForumXMLParser\getIdAndAliasArray(), ILIAS\Data\URI\getParameter(), ilObjLTIConsumer\getProviderCustomParamsArray(), ILIAS\LTI\ToolProvider\Util\getRequestParameters(), LSUrlBuilder\getURL(), ilWACPath\handleParameters(), ilWebLinkXmlParser\handlerBeginTag(), ILIAS\CI\Rector\DIC\DICDependencyManipulator\hasMethodParameter(), ilObjLinkResourceGUI\initFormLink(), ilPCSection\insertTimings(), nusoap_server\invoke_method(), ILIAS\CI\Rector\DIC\DICDependencyManipulator\isParamInConstructor(), ilPortfolioPageGUI\makePlaceHoldersClickable(), ilPCPlaceHolder\modifyPageContentPostXsl(), ilPCLearningHistory\modifyPageContentPostXsl(), ilPCContentInclude\modifyPageContentPostXsl(), ilPCMap\modifyPageContentPostXsl(), ilPCPlugged\modifyPageContentPostXsl(), ILIAS\Notes\NotificationsManager\notifyObserver(), ilICalParser\parseLine(), ilVirusScannerICapRemote\parseResponse(), ilLSPlayer\play(), ilLanguageFile\read(), ilInitialisation\redirect(), ILIAS\LTI\ToolProvider\Tool\sendAuthenticationRequest(), ilICalParser\storeItems(), ilWebResourceParameterTest\testAppendToLink(), ilWebResourceParameterTest\testAppendToLinkException(), ilWebResourceParameterTest\testGetInfo(), ilWebResourceParameterTest\testGetInfoException(), ilWebResourceParameterTest\testToXML(), ilObjLinkResourceGUI\updateLinks(), ilLSPlayer\updateViewState(), and ilICalParser\writeEvent().

◆ $refId

$refId = $param['ref_id']

Definition at line 58 of file xapitoken.php.

Referenced by ilSoapRepositoryStructureObject\__construct(), ilObjEmployeeTalkGUI\__construct(), ilObjEmployeeTalkSeriesGUI\__construct(), ilObjTestGUI\__construct(), ilObjContentPageGUI\_goto(), ilObjDataCollectionGUI\_goto(), ILIAS\Certificate\API\Data\UserCertificateDto\addRefId(), ilObjTestDynamicQuestionSetConfig\areDepenciesInVulnerableState(), ilObjLTIConsumerGUI\checkContentSelection(), ilPollBlockGUI\commentJSCall(), ilObjEmployeeTalkGUI\confirmedDeleteObject(), ilMailTest\create(), ilForumNotificationDataProvider\createRecipientArray(), ilObjDataCollectionGUI\editObject(), ilCertificateCourseLearningProgressEvaluation\evaluate(), ilObjSAHSLearningModuleGUI\executeCommand(), ilObjChatroomGUI\executeCommand(), ilChatroomInfoGUI\executeDefault(), ilEmployeeTalkMyStaffListGUI\getActions(), ilObjEmployeeTalkGUI\getAdminTabs(), ilCmiXapiAuthToken\getCmi5SessionByUsrIdAndObjIdAndRefId(), ilTestRandomQuestionSetConfig\getCommaSeparatedSourceQuestionPoolLinks(), ilBlogDraftsDerivedTaskProvider\getFirstRefIdWithPermission(), ilForumDraftsDerivedTaskProvider\getFirstRefIdWithPermission(), ilPDSelectedItemsBlockMembershipsProvider\getObjectsByMembership(), ilEmployeeTalkAppointmentGUI\getPendingTalksInSeries(), ilTestQuestionBrowserTableGUI\getQuestionParentObjIds(), ilTestExpressPage\getReturnToPageLink(), ilObjTestDynamicQuestionSetConfig\getSourceQuestionPoolLink(), ilObjTestDynamicQuestionSetConfig\getSourceQuestionPoolSummaryString(), ilBlogDraftsDerivedTaskProvider\getTasks(), ilForumDraftsDerivedTaskProvider\getTasks(), ilObjEmployeeTalkSeriesGUI\getTemplateRefId(), ilCertificateAppEventListener\handleLPUpdate(), ilObjTalkTemplateGUI\initMetaDataForm(), ilObjChatroomGUI\insertObject(), ilCmiXapiAuthToken\insertToken(), ilPDSelectedItemsBlockViewGUI\isRootNode(), ilUserCertificateGUI\listCertificates(), ilEmployeeTalkMyStaffListGUI\loadActionBar(), ilEmployeeTalkMyStaffUserGUI\loadActionBar(), ilPDSelectedItemsBlockMembershipsViewGUI\mayRemoveItem(), ilMailGroupAddressType\resolve(), ilCertificateSettingsCourseFormRepository\save(), ilObjLTIConsumerGUI\saveContentSelection(), ilHelpGUI\setCtrlPar(), ilObjDataCollectionGUI\setTabs(), ilObjSAHSLearningModuleGUI\setTabs(), ilObjSCORMTracking\storeJsApi(), ilObjChatroomAccessTest\testAccessChecksFail(), ilObjChatroomAccessTest\testAccessChecksSucceed(), ilForumNotificationTest\testCheckForumsExistsInsert(), ilMailTest\testGetMailObjectReferenceId(), ilObjSAHSLearningModuleGUI\uploadObject(), ilObjEmployeeTalkGUI\validateCustom(), and ilSCORMItemGUI\view().

◆ $response

$response = array("auth-token" => $authToken)

Definition at line 93 of file xapitoken.php.

Referenced by send().

◆ $token

$token = ilCmiXapiAuthToken::getInstanceByObjIdAndRefIdAndUsrId($objId, $refId, $DIC->user()->getId())

Definition at line 70 of file xapitoken.php.

Referenced by XapiProxy\XapiProxyPolyFill\__construct(), ILIAS\UI\URLBuilder\acquireParameter(), ILIAS\UI\URLBuilder\acquireParameters(), ilObjLTIConsumer\buildLaunchParameters(), ilDclExpressionParser\calculateFunctions(), ilPersonalProfileGUI\changeEmail(), ilLTIConsumerResourceBase\checkTool(), ilObjLTIConsumerGUI\contentSelectionResponse(), ilCalendarSubscriptionGUI\createToken(), EvalMath\evaluate(), ilLTIConsumerGradeServiceScores\execute(), EvalMath\from_hexbin(), ilCtrlTokenRepository\generateToken(), ILIAS\LTIOAuth\OAuthSignatureMethod_HMAC_SHA1\get_name(), ilLTIConsumerContentGUI\getLaunchParameters(), ilWACTokenTest\getModifiedSignedPath(), ILIAS\User\Profile\ProfileChangeMailTokenDBRepository\getNewTokenForUser(), ILIAS\ResourceStorage\Consumer\InlineSrcBuilder\getRevisionURL(), ilLTIConsumerContentGUI\getStartButtonTxt11(), ilLTIConsumerContentGUI\getStartButtonTxt13(), ilCtrl\getTargetUrl(), ilCtrlTokenRepository\getToken(), ilCmiXapiLaunchGUI\getValidToken(), ilPersonalProfileGUI\goToEmailConfirmation(), ilLTIConsumerResultService\handleRequest(), ilECSParticipantSettingsGUI\initFormSettings(), ilCalendarRemoteAccessHandler\initTokenHandler(), ilDclExpressionParser\isMathToken(), ilCmiXapiLaunchGUI\launchCmd(), ilDclExpressionParser\parse(), ilLangDeprecated\parseCodeFile(), ilDclExpressionParser\parseMath(), EvalMath\pfx(), ILIAS\ResourceStorage\Consumer\StreamAccess\StreamAccess\populateRevision(), ILIAS\UI\URLBuilder\renderTokens(), sendAccessToken(), ActionTest\setUp(), ilDclExpressionParser\substituteFieldValues(), ILIAS\UI\URLBuilderTokenTest\testConstruct(), DataTest\testDataTableActions(), DataRendererTest\testDataTableGetActionRegistration(), DataRendererTest\testDataTableMultiActionsDropdown(), DataRendererTest\testDataTableRenderHeaderWithActions(), DataRendererTest\testDataTableRowBuilder(), DataRendererTest\testDataTableSingleActionsDropdown(), ActionFactoryTest\testImplementsInterfaces(), ILIAS\ResourceStorage\Flavours\AccessTokenTest\testMemoryStream(), ILIAS\ResourceStorage\Flavours\AccessTokenTest\testRealStream(), ILIAS\UI\URLBuilderTokenTest\testTokenLength(), ILIAS\UI\URLBuilderTokenTest\testTokenName(), ilCtrlTokenTest\testTokenRetrieval(), ilCtrlTokenTest\testTokenVerification(), XapiProxy\XapiProxy\token(), and ilObjLTIConsumer\verifyToken().

◆ $tokenRestriction

$tokenRestriction = true

see: https://github.com/AICC/CMI-5_Spec_Current/blob/quartz/cmi5_spec.md#fetch_url response should always be a valid json object check oneway fetching is optional:

The AU SHOULD NOT attempt to retrieve the authorization token more than once. The fetch URL is a "one-time use" URL and subsequent uses SHOULD generate an error (see Section 8.2.3).

On reloading the initial content page it will send the exact url twice, should we really restrict this behavior? If there are issues on page reload it might be useful to set $tokenRestriction = false .

Definition at line 34 of file xapitoken.php.