Class to represent an LTI Tool. More...

Inheritance diagram for ILIAS\LTI\ToolProvider\Tool:

Collaboration diagram for ILIAS\LTI\ToolProvider\Tool:

Public Member Functions
	__construct (DataConnector $dataConnector=null)
	Class constructor. More...

	initialize ()
	Initialise the tool. More...

	save ()
	Save the tool to the database. More...

	delete ()
	Delete the tool from the database. More...

	getMessageParameters ()
	Get the message parameters. More...

	handleRequest (bool $strictMode=false)
	Process an incoming request. More...

	setParameterConstraint (string $name, bool $required=true, int $maxLength=null, array $messageTypes=null)
	Add a parameter constraint to be checked on launch. More...

	getPlatforms ()
	Get an array of defined tool consumers. More...

	findService (string $format, array $methods)
	Find an offered service based on a media type and HTTP action(s) More...

Static Public Member Functions
static	fromConsumerKey (string $key=null, DataConnector $dataConnector=null, bool $autoEnable=false)
	Load the tool from the database by its consumer key. More...

static	fromInitiateLoginUrl (string $initiateLoginUrl, DataConnector $dataConnector=null, bool $autoEnable=false)
	Load the tool from the database by its initiate login URL. More...

static	fromRecordId (string $id, DataConnector $dataConnector)
	Load the tool from the database by its record ID. More...

Data Fields
const	CONNECTION_ERROR_MESSAGE = 'Sorry, there was an error connecting you to the application.'
	Default connection error message. More...

const	ID_SCOPE_ID_ONLY = 0
	Use ID value only. More...

const	ID_SCOPE_GLOBAL = 1
	Prefix an ID with the consumer key. More...

const	ID_SCOPE_CONTEXT = 2
	Prefix the ID with the consumer key and context ID. More...

const	ID_SCOPE_RESOURCE = 3
	Prefix the ID with the consumer key and resource ID. More...

const	ID_SCOPE_SEPARATOR = ':'
	Character used to separate each element of an ID. More...

ilLTIPlatform	$platform
	Platform object. More...

string	$returnUrl = null
	Return URL provided by platform. More...

UserResult	$userResult = null
	UserResult object. More...

ResourceLink	$resourceLink = null
	Resource link object. More...

Context	$context = null
	Context object. More...

string	$defaultEmail = ''
	Default email domain. More...

int	$idScope = self::ID_SCOPE_ID_ONLY
	Scope to use for user IDs. More...

bool	$allowSharing = false
	Whether shared resource link arrangements are permitted. More...

string	$message = null
	Message for last request processed. More...

string	$baseUrl = null
	Base URL for tool service. More...

Item	$vendor = null
	Vendor details. More...

Item	$product = null
	Product details. More...

array	$requiredServices = null
	Services required by Tool. More...

array	$optionalServices = null
	Optional services used by Tool. More...

array	$resourceHandlers = null
	Resource handlers for Tool. More...

string	$messageUrl = null
	Message URL for Tool. More...

string	$initiateLoginUrl = null
	Initiate Login request URL for Tool. More...

array	$redirectionUris = null
	Redirection URIs for Tool. More...

Static Public Attributes
static array	$MESSAGE_TYPES
	List of supported incoming message types. More...

static Tool	$defaultTool = null
	Default tool for use with service requests. More...

static bool	$authenticateUsingGet = false
	Use GET method for authentication request messages when true. More...

Protected Member Functions
	onLaunch ()
	Send the tool proxy to the platform. More...

	onConfigure ()
	Process a valid configure request. More...

	onDashboard ()
	Process a valid dashboard request. More...

	onContentItem ()
	Process a valid content-item request. More...

	onContentItemUpdate ()
	Process a valid content-item update request. More...

	onRegister ()
	Process a valid tool proxy registration request. More...

	onRegistration ()
	Process a dynamic registration request. More...

	onLtiStartProctoring ()
	Process a valid start proctoring request. More...

	onLtiEndAssessment ()
	Process a valid end assessment request. More...

	onInitiateLogin (array $requestParameters, array &$authParameters)
	Process a login initiation request. More...

	onError ()
	Process a response to an invalid request. More...

	getPlatformConfiguration ()
	Fetch a platform's configuration data. More...

	getConfiguration (array $platformConfig)
	Prepare the tool's configuration data. More...

	sendRegistration (array $platformConfig, array $toolConfig)
	Send the tool registration to the platform. More...

	getPlatformToRegister (array $platformConfig, array $registrationConfig, bool $doSave=true)
	Initialise the platform to be registered. More...

	getRegistrationResponsePage (array $toolConfig)
	Prepare the page to complete a registration request. More...

Protected Attributes
string	$redirectUrl = null
	URL to redirect user to on successful completion of the request. More...

array	$mediaTypes = null
	Media types accepted by the platform. More...

array	$contentTypes = null
	Content item types accepted by the platform. More...

array	$fileTypes = null
	File types accepted by the platform. More...

array	$documentTargets = null
	Document targets accepted by the platform. More...

string	$output = null
	Default HTML to be displayed on a successful completion of the request. More...

string	$errorOutput = null
	HTML to be displayed on an unsuccessful completion of the request and no return URL is available. More...

Private Member Functions
	result ()
	Perform the result of an action. More...

	authenticate (bool $strictMode)
	Check the authenticity of the LTI message. More...

	checkForShare ()
	Check if a share arrangement is in place. More...

	sendAuthenticationRequest (array $parameters)
	Generate a form to perform an authentication request. More...

	sendRelaunchRequest ()
	Generate a form to perform a relaunch request. More...

	checkValue (&$value, array $values, string $reason, bool $strictMode, bool $ignoreInvalid=false)
	Validate a parameter value from an array of permitted values. More...

Private Attributes
array	$constraints = null
	LTI parameter constraints for auto validation checks. More...

Static Private Attributes
static array	$LTI_CONSUMER_SETTING_NAMES = array('custom_tc_profile_url', 'custom_system_setting_url', 'custom_oauth2_access_token_url')
	Names of LTI parameters to be retained in the consumer settings property. More...

static array	$LTI_CONTEXT_SETTING_NAMES
	Names of LTI parameters to be retained in the context settings property. More...

static array	$LTI_RESOURCE_LINK_SETTING_NAMES
	Names of LTI parameters to be retained in the resource link settings property. More...

static array	$LTI_RETAIN_SETTING_NAMES = array('custom_lineitem_url')
	Names of LTI parameters to be retained even when not passed. More...

static array	$CUSTOM_SUBSTITUTION_VARIABLES
	Names of LTI custom parameter substitution variables (or capabilities) and their associated default message parameter names. More...

Detailed Description

Class to represent an LTI Tool.

Author: Stephen P Vickers steph.nosp@m.en@s.nosp@m.pvsof.nosp@m.twar.nosp@m.eprod.nosp@m.ucts.nosp@m..com

Copyright: SPV Software Products http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3

Definition at line 38 of file Tool.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\LTI\ToolProvider\Tool::__construct ( DataConnector $dataConnector = null )

Class constructor.

Parameters

DataConnector | null $dataConnector Object containing a database connection object

Definition at line 368 of file Tool.php.

References ILIAS\LTI\ToolProvider\$dataConnector, ILIAS\LTI\ToolProvider\DataConnector\DataConnector\getDataConnector(), and ILIAS\LTI\ToolProvider\Tool\initialize().

     {
 //        $this->consumer = &$this->platform; //UK: deprecated
         $this->initialize();
         if (empty($dataConnector)) {
             $dataConnector = DataConnector::getDataConnector();
         }
         $this->dataConnector = $dataConnector;
     }

Here is the call graph for this function:

Member Function Documentation

◆ authenticate()

ILIAS\LTI\ToolProvider\Tool::authenticate ( bool $strictMode )

private

Check the authenticity of the LTI message.

The platform, resource link and user objects will be initialised if the request is valid.

Parameters

bool $strictMode True if full compliance with the LTI specification is required

Returns: bool True if the request has been successfully validated.

Definition at line 1219 of file Tool.php.

Referenced by ILIAS\LTI\ToolProvider\Tool\handleRequest().

                                                    : bool
     {
         $doSavePlatform = false;
         $this->ok = $this->checkMessage();
         if ($this->ok && $strictMode && !empty($this->jwt) && !empty($this->jwt->hasJwt())) {
             if (!empty($this->jwt->getClaim('https://purl.imsglobal.org/spec/lti/claim/context', '')) &&
                 empty($this->messageParameters['context_id'])) {
                 $this->ok = false;
                 $this->reason = 'Missing id property in https://purl.imsglobal.org/spec/lti/claim/context claim';
             } elseif (!empty($this->jwt->getClaim('https://purl.imsglobal.org/spec/lti/claim/tool_platform', '')) &&
                 empty($this->messageParameters['tool_consumer_instance_guid'])) {
                 $this->ok = false;
                 $this->reason = 'Missing guid property in https://purl.imsglobal.org/spec/lti/claim/tool_platform claim';
             }
         }
         if ($this->ok) {
             if ($this->messageParameters['lti_message_type'] === 'basic-lti-launch-request') {
                 $this->ok = isset($this->messageParameters['resource_link_id']) && (strlen(trim($this->messageParameters['resource_link_id'])) > 0);
                 if (!$this->ok) {
                     $this->reason = 'Missing resource link ID.';
                 }
                 if ($this->ok && ($this->messageParameters['lti_version'] === Util::LTI_VERSION1P3)) {
                     $this->ok = isset($this->messageParameters['roles']);
                     if (!$this->ok) {
                         $this->reason = 'Missing roles parameter.';
                     }
                 }
             } elseif (($this->messageParameters['lti_message_type'] === 'ContentItemSelectionRequest') ||
                 ($this->messageParameters['lti_message_type'] === 'ContentItemUpdateRequest')) {
                 $isUpdate = ($this->messageParameters['lti_message_type'] === 'ContentItemUpdateRequest');
                 $mediaTypes = array();
                 $contentTypes = array();
                 $fileTypes = array();
                 if (isset($this->messageParameters['accept_media_types']) && (strlen(trim($this->messageParameters['accept_media_types'])) > 0)) {
                     $mediaTypes = array_filter(
                         explode(',', str_replace(' ', '', $this->messageParameters['accept_media_types'])),
                         'strlen'
                     );
                 }
                 $this->ok = (count($mediaTypes) > 0) || ($this->messageParameters['lti_version'] === Util::LTI_VERSION1P3);
                 if (!$this->ok) {
                     $this->reason = 'No content types specified.';
                 } elseif ($isUpdate) {
                     if ($this->messageParameters['lti_version'] !== Util::LTI_VERSION1P3) {
                         if (!$this->checkValue(
                             $this->messageParameters['accept_media_types'],
                             array(Item::LTI_LINK_MEDIA_TYPE, Item::LTI_ASSIGNMENT_MEDIA_TYPE),
                             'Invalid value in accept_media_types parameter: \'%s\'.',
                             $strictMode,
                             true
                         )) {
                             $this->ok = false;
                         }
                     } elseif (!$this->checkValue(
                         $this->messageParameters['accept_types'],
                         array(Item::TYPE_LTI_LINK, Item::TYPE_LTI_ASSIGNMENT),
                         'Invalid value in accept_types parameter: \'%s\'.',
                         $strictMode,
                         true
                     )) {
                         $this->ok = false;
                     }
                 }
                 if ($this->ok) {
                     $mediaTypes = array_unique($mediaTypes);
                     foreach ($mediaTypes as $mediaType) {
                         if (strpos($mediaType, 'application/vnd.ims.lti.') !== 0) {
                             $fileTypes[] = $mediaType;
                         }
                         if (($mediaType === 'text/html') || ($mediaType === '*/*')) {
                             $contentTypes[] = Item::TYPE_LINK;
                             $contentTypes[] = Item::TYPE_HTML;
                         } elseif ((strpos($mediaType, 'image/') === 0) || ($mediaType === '*/*')) {
                             $contentTypes[] = Item::TYPE_IMAGE;
                         } elseif ($mediaType === Item::LTI_LINK_MEDIA_TYPE) {
                             $contentTypes[] = Item::TYPE_LTI_LINK;
                         } elseif ($mediaType === Item::LTI_ASSIGNMENT_MEDIA_TYPE) {
                             $contentTypes[] = Item::TYPE_LTI_ASSIGNMENT;
                         }
                     }
                     if (!empty($fileTypes)) {
                         $contentTypes[] = Item::TYPE_FILE;
                     }
                     $contentTypes = array_unique($contentTypes);
                 }
                 if ($this->ok) {
                     if (isset($this->messageParameters['accept_presentation_document_targets']) &&
                         (strlen(trim($this->messageParameters['accept_presentation_document_targets'])) > 0)) {
                         $documentTargets = array_filter(explode(
                             ',',
                             str_replace(' ', '', $this->messageParameters['accept_presentation_document_targets'])
                         ), 'strlen');
                         $documentTargets = array_unique($documentTargets);
                         $this->ok = count($documentTargets) > 0;
                         if (!$this->ok) {
                             $this->reason = 'Missing or empty accept_presentation_document_targets parameter.';
                         } else {
                             if (empty($this->jwt) || !$this->jwt->hasJwt()) {
                                 $permittedTargets = array('embed', 'frame', 'iframe', 'window', 'popup', 'overlay', 'none');
                             } else {  // JWT
                                 $permittedTargets = array('embed', 'iframe', 'window');
                             }
                             foreach ($documentTargets as $documentTarget) {
                                 if (!$this->checkValue(
                                     $documentTarget,
                                     $permittedTargets,
                                     'Invalid value in accept_presentation_document_targets parameter: \'%s\'.',
                                     $strictMode,
                                     true
                                 )) {
                                     $this->ok = false;
                                     break;
                                 }
                             }
                             if ($this->ok) {
                                 $this->documentTargets = $documentTargets;
                             }
                         }
                     } else {
                         $this->ok = false;
                         $this->reason = 'No accept_presentation_document_targets parameter found.';
                     }
                 }
                 if ($this->ok) {
                     $this->ok = !empty($this->messageParameters['content_item_return_url']);
                     if (!$this->ok) {
                         $this->reason = 'Missing content_item_return_url parameter.';
                     } else {
                         $this->mediaTypes = $mediaTypes;
                         $this->contentTypes = $contentTypes;
                         $this->fileTypes = $fileTypes;
                     }
                 }
             } elseif ($this->messageParameters['lti_message_type'] === 'ToolProxyRegistrationRequest') {
                 $this->ok = ((isset($this->messageParameters['reg_key']) && (strlen(trim($this->messageParameters['reg_key'])) > 0)) && (isset($this->messageParameters['reg_password']) && (strlen(trim($this->messageParameters['reg_password'])) >
                             0)) && (isset($this->messageParameters['tc_profile_url']) && (strlen(trim($this->messageParameters['tc_profile_url'])) >
                             0)) && (isset($this->messageParameters['launch_presentation_return_url']) && (strlen(trim($this->messageParameters['launch_presentation_return_url'])) > 0)));
                 if ($this->debugMode && !$this->ok) {
                     $this->reason = 'Missing message parameters.';
                 }
             } elseif ($this->messageParameters['lti_message_type'] === 'LtiStartProctoring') {
                 $this->ok = isset($this->messageParameters['resource_link_id']) && (strlen(trim($this->messageParameters['resource_link_id'])) > 0);
                 if (!$this->ok) {
                     $this->reason = 'Missing resource link ID.';
                 } else {
                     $this->ok = isset($this->messageParameters['custom_ap_attempt_number']) && (strlen(trim($this->messageParameters['custom_ap_attempt_number'])) > 0) &&
                         is_numeric($this->messageParameters['custom_ap_attempt_number']);
                     if (!$this->ok) {
                         $this->reason = 'Missing or invalid value for attempt number.';
                     }
                 }
                 if ($this->ok) {
                     $this->ok = isset($this->messageParameters['user_id']) && (strlen(trim($this->messageParameters['user_id'])) > 0);
                     if (!$this->ok) {
                         $this->reason = 'Missing user ID.';
                     }
                 }
             }
         }
         $now = time();
         // Check consumer key
         if ($this->ok && ($this->messageParameters['lti_message_type'] !== 'ToolProxyRegistrationRequest')) {
             $this->ok = isset($this->messageParameters['oauth_consumer_key']);
             if (!$this->ok) {
                 $this->reason = 'Missing consumer key.';
             }
             if ($this->ok) {
                 $this->ok = !is_null($this->platform->created);
                 if (!$this->ok) {
                     if (empty($this->jwt) || !$this->jwt->hasJwt()) {
                         $this->reason = "Consumer key not recognised: {$this->messageParameters['oauth_consumer_key']}";
                     } else {
                         $this->reason = "Platform not recognised (Platform ID | Client ID | Deployment ID): {$this->messageParameters['platform_id']} | {$this->messageParameters['oauth_consumer_key']} | {$this->messageParameters['deployment_id']}";
                     }
                 }
             }
             if ($this->ok) {
                 if ($this->messageParameters['oauth_signature_method'] !== $this->platform->signatureMethod) {
                     $this->platform->signatureMethod = $this->messageParameters['oauth_signature_method'];
                     $doSavePlatform = true;
                 }
                 $today = date('Y-m-d', $now);
                 if (is_null($this->platform->lastAccess)) {
                     $doSavePlatform = true;
                 } else {
                     $last = date('Y-m-d', $this->platform->lastAccess);
                     $doSavePlatform = $doSavePlatform || ($last !== $today);
                 }
                 $this->platform->lastAccess = $now;
                 $this->ok = $this->verifySignature();
             }
             if ($this->ok) {
                 if ($this->platform->protected) {
                     if (!is_null($this->platform->consumerGuid)) {
                         $this->ok = empty($this->messageParameters['tool_consumer_instance_guid']) || ($this->platform->consumerGuid === $this->messageParameters['tool_consumer_instance_guid']);
                         if (!$this->ok) {
                             $this->reason = 'Request is from an invalid platform.';
                         }
                     } else {
                         $this->ok = isset($this->messageParameters['tool_consumer_instance_guid']);
                         if (!$this->ok) {
                             $this->reason = 'A platform GUID must be included in the launch request.';
                         }
                     }
                 }
                 if ($this->ok) {
                     $this->ok = $this->platform->enabled;
                     if (!$this->ok) {
                         $this->reason = 'Platform has not been enabled by the tool.';
                     }
                 }
                 if ($this->ok) {
                     $this->ok = is_null($this->platform->enableFrom) || ($this->platform->enableFrom <= $now);
                     if ($this->ok) {
                         $this->ok = is_null($this->platform->enableUntil) || ($this->platform->enableUntil > $now);
                         if (!$this->ok) {
                             $this->reason = 'Platform access has expired.';
                         }
                     } else {
                         $this->reason = 'Platform access is not yet available.';
                     }
                 }
             }
             // Validate other message parameter values
             if ($this->ok) {
                 if (($this->messageParameters['lti_message_type'] === 'ContentItemSelectionRequest') ||
                     ($this->messageParameters['lti_message_type'] === 'ContentItemUpdateRequest')) {
                     $isUpdate = ($this->messageParameters['lti_message_type'] === 'ContentItemUpdateRequest');
                     if (isset($this->messageParameters['accept_unsigned'])) {
                         $this->ok = $this->checkValue(
                             $this->messageParameters['accept_unsigned'],
                             array('true', 'false'),
                             'Invalid value for accept_unsigned parameter: \'%s\'.',
                             $strictMode
                         );
                     }
                     if ($this->ok && isset($this->messageParameters['accept_multiple'])) {
                         if (!$isUpdate) {
                             $this->ok = $this->checkValue(
                                 $this->messageParameters['accept_multiple'],
                                 array('true', 'false'),
                                 'Invalid value for accept_multiple parameter: \'%s\'.',
                                 $strictMode
                             );
                         } else {
                             $this->ok = $this->checkValue(
                                 $this->messageParameters['accept_multiple'],
                                 array('false'),
                                 'Invalid value for accept_multiple parameter: \'%s\'.',
                                 $strictMode
                             );
                         }
                     }
                     if ($this->ok && isset($this->messageParameters['accept_copy_advice'])) {
                         if (!$isUpdate) {
                             $this->ok = $this->checkValue(
                                 $this->messageParameters['accept_copy_advice'],
                                 array('true', 'false'),
                                 'Invalid value for accept_copy_advice parameter: \'%s\'.',
                                 $strictMode
                             );
                         } else {
                             $this->ok = $this->checkValue(
                                 $this->messageParameters['accept_copy_advice'],
                                 array('false'),
                                 'Invalid value for accept_copy_advice parameter: \'%s\'.',
                                 $strictMode
                             );
                         }
                     }
                     if ($this->ok && isset($this->messageParameters['auto_create'])) {
                         $this->ok = $this->checkValue(
                             $this->messageParameters['auto_create'],
                             array('true', 'false'),
                             'Invalid value for auto_create parameter: \'%s\'.',
                             $strictMode
                         );
                     }
                     if ($this->ok && isset($this->messageParameters['can_confirm'])) {
                         $this->ok = $this->checkValue(
                             $this->messageParameters['can_confirm'],
                             array('true', 'false'),
                             'Invalid value for can_confirm parameter: \'%s\'.',
                             $strictMode
                         );
                     }
                 }
                 if ($this->ok && isset($this->messageParameters['launch_presentation_document_target'])) {
                     $this->ok = $this->checkValue(
                         $this->messageParameters['launch_presentation_document_target'],
                         array('embed', 'frame', 'iframe', 'window', 'popup', 'overlay'),
                         'Invalid value for launch_presentation_document_target parameter: \'%s\'.',
                         $strictMode,
                         true
                     );
                     if ($this->ok && ($this->messageParameters['lti_message_type'] === 'LtiStartProctoring') &&
                         ($this->messageParameters['launch_presentation_document_target'] !== 'window')) {
                         $this->ok = !isset($this->messageParameters['launch_presentation_height']) &&
                             !isset($this->messageParameters['launch_presentation_width']);
                         if (!$this->ok) {
                             $this->reason = 'Height and width parameters must only be included for the window document target.';
                         }
                     }
                 }
             }
         }
 
         if ($this->ok && ($this->messageParameters['lti_message_type'] === 'ToolProxyRegistrationRequest')) {
             $this->ok = $this->messageParameters['lti_version'] === Util::LTI_VERSION2;
             if (!$this->ok) {
                 $this->reason = 'Invalid lti_version parameter.';
             }
             if ($this->ok) {
                 $url = $this->messageParameters['tc_profile_url'];
                 if (strpos($url, '?') === false) {
                     $url .= '?';
                 } else {
                     $url .= '&';
                 }
                 $url .= 'lti_version=' . Util::LTI_VERSION2;
                 $http = new HttpMessage($url, 'GET', null, 'Accept: application/vnd.ims.lti.v2.toolconsumerprofile+json');
                 $this->ok = $http->send();
                 if (!$this->ok) {
                     $this->reason = 'Platform profile not accessible.';
                 } else {
                     $tcProfile = json_decode($http->response);
                     $this->ok = !is_null($tcProfile);
                     if (!$this->ok) {
                         $this->reason = 'Invalid JSON in platform profile.';
                     }
                 }
             }
             // Check for required capabilities
             if ($this->ok) {
                 $this->platform = Platform::fromConsumerKey($this->messageParameters['reg_key'], $this->dataConnector);
                 $this->platform->profile = $tcProfile;
                 $capabilities = $this->platform->profile->capability_offered;
                 $missing = array();
                 foreach ($this->resourceHandlers as $resourceHandler) {
                     foreach ($resourceHandler->requiredMessages as $message) {
                         if (!in_array($message->type, $capabilities)) {
                             $missing[$message->type] = true;
                         }
                     }
                 }
                 foreach ($this->constraints as $name => $constraint) {
                     if ($constraint['required']) {
                         if (empty(array_intersect(
                             $capabilities,
                             array_keys(array_intersect(self::$CUSTOM_SUBSTITUTION_VARIABLES, array($name)))
                         ))) {
                             $missing[$name] = true;
                         }
                     }
                 }
                 if (!empty($missing)) {
                     ksort($missing);
                     $this->reason = 'Required capability not offered - \'' . implode('\', \'', array_keys($missing)) . '\'';
                     $this->ok = false;
                 }
             }
             // Check for required services
             if ($this->ok) {
                 foreach ($this->requiredServices as $service) {
                     foreach ($service->formats as $format) {
                         if (!$this->findService($format, $service->actions)) {
                             if ($this->ok) {
                                 $this->reason = 'Required service(s) not offered - ';
                                 $this->ok = false;
                             } else {
                                 $this->reason .= ', ';
                             }
                             $this->reason .= "'{$format}' [" . implode(', ', $service->actions) . ']';
                         }
                     }
                 }
             }
             if ($this->ok) {
                 if ($this->messageParameters['lti_message_type'] === 'ToolProxyRegistrationRequest') {
                     $this->platform->profile = $tcProfile;
                     $this->platform->secret = $this->messageParameters['reg_password'];
                     $this->platform->ltiVersion = $this->messageParameters['lti_version'];
                     $this->platform->name = $tcProfile->product_instance->service_owner->service_owner_name->default_value;
                     $this->platform->consumerName = $this->platform->name;
                     $this->platform->consumerVersion = "{$tcProfile->product_instance->product_info->product_family->code}-{$tcProfile->product_instance->product_info->product_version}";
                     $this->platform->consumerGuid = $tcProfile->product_instance->guid;
                     $this->platform->enabled = true;
                     $this->platform->protected = true;
                     $doSavePlatform = true;
                 }
             }
         } elseif ($this->ok && !empty($this->messageParameters['custom_tc_profile_url']) && empty($this->platform->profile)) {
             $url = $this->messageParameters['custom_tc_profile_url'];
             if (strpos($url, '?') === false) {
                 $url .= '?';
             } else {
                 $url .= '&';
             }
             $url .= 'lti_version=' . $this->messageParameters['lti_version'];
             $http = new HttpMessage($url, 'GET', null, 'Accept: application/vnd.ims.lti.v2.toolconsumerprofile+json');
             if ($http->send()) {
                 $tcProfile = json_decode($http->response);
                 if (!is_null($tcProfile)) {
                     $this->platform->profile = $tcProfile;
                     $doSavePlatform = true;
                 }
             }
         }
 
         if ($this->ok) {
             // Check if a relaunch is being requested
             if (isset($this->messageParameters['relaunch_url'])) {
                 if (empty($this->messageParameters['platform_state'])) {
                     $this->ok = false;
                     $this->reason = 'Missing or empty platform_state parameter.';
                 } else {
                     $this->sendRelaunchRequest();
                 }
             } else {
                 // Validate message parameter constraints
                 $invalidParameters = array();
                 foreach ($this->constraints as $name => $constraint) {
                     if (empty($constraint['messages']) || in_array(
                         $this->messageParameters['lti_message_type'],
                         $constraint['messages']
                     )) {
                         $ok = true;
                         if ($constraint['required']) {
                             if (!isset($this->messageParameters[$name]) || (strlen(trim($this->messageParameters[$name])) <= 0)) {
                                 $invalidParameters[] = "{$name} (missing)";
                                 $ok = false;
                             }
                         }
                         if ($ok && !is_null($constraint['max_length']) && isset($this->messageParameters[$name])) {
                             if (strlen(trim($this->messageParameters[$name])) > $constraint['max_length']) {
                                 $invalidParameters[] = "{$name} (too long)";
                             }
                         }
                     }
                 }
                 if (count($invalidParameters) > 0) {
                     $this->ok = false;
                     if (empty($this->reason)) {
                         $this->reason = 'Invalid parameter(s): ' . implode(', ', $invalidParameters) . '.';
                     }
                 }
 
                 if ($this->ok) {
                     // Set the request context
                     $contextId = '';
                     //UK: Check if necessary
                     if ($this->hasConfiguredApiHook(self::$CONTEXT_ID_HOOK, $this->platform->getFamilyCode(), $this)) {
                         $className = $this->getApiHook(self::$CONTEXT_ID_HOOK, $this->platform->getFamilyCode());
                         $tpHook = new $className($this);
                         $contextId = $tpHook->getContextId();
                     }
                     if (empty($contextId) && isset($this->messageParameters['context_id'])) {
                         $contextId = trim($this->messageParameters['context_id']);
                     }
                     if (!empty($contextId)) {
                         $this->context = Context::fromPlatform($this->platform, $contextId);
                         $title = '';
                         if (isset($this->messageParameters['context_title'])) {
                             $title = trim($this->messageParameters['context_title']);
                         }
                         if (empty($title)) {
                             $title = "Course {$this->context->getId()}";
                         }
                         $this->context->title = $title;
                         if (isset($this->messageParameters['context_type'])) {
                             $this->context->type = trim($this->messageParameters['context_type']);
                             if (strpos($this->context->type, 'http://purl.imsglobal.org/vocab/lis/v2/course#') === 0) {
                                 $this->context->type = substr($this->context->type, 46);
                             }
                         }
                     }
 
                     // Set the request resource link
                     if (isset($this->messageParameters['resource_link_id'])) {
                         $contentItemId = '';
                         if (isset($this->messageParameters['custom_content_item_id'])) {
                             $contentItemId = $this->messageParameters['custom_content_item_id'];
                         }
                         if (empty($this->context)) {
                             $this->resourceLink = ResourceLink::fromPlatform(
                                 $this->platform,
                                 trim($this->messageParameters['resource_link_id']),
                                 $contentItemId
                             );
                         } else {
                             $this->resourceLink = ResourceLink::fromContext(
                                 $this->context,
                                 trim($this->messageParameters['resource_link_id']),
                                 $contentItemId
                             );
                         }
                         $title = '';
                         if (isset($this->messageParameters['resource_link_title'])) {
                             $title = trim($this->messageParameters['resource_link_title']);
                         }
                         if (empty($title)) {
                             $title = "Resource {$this->resourceLink->getId()}";
                         }
                         $this->resourceLink->title = $title;
                     }
                     // Delete any existing custom parameters
                     foreach ($this->platform->getSettings() as $name => $value) {
                         if ((strpos($name, 'custom_') === 0) && (!in_array($name, self::$LTI_RETAIN_SETTING_NAMES))) {
                             $this->platform->setSetting($name);
                             $doSavePlatform = true;
                         }
                     }
                     if (!empty($this->context)) {
                         foreach ($this->context->getSettings() as $name => $value) {
                             if ((strpos($name, 'custom_') === 0) && (!in_array($name, self::$LTI_RETAIN_SETTING_NAMES))) {
                                 $this->context->setSetting($name);
                             }
                         }
                     }
                     if (!empty($this->resourceLink)) {
                         foreach ($this->resourceLink->getSettings() as $name => $value) {
                             if ((strpos($name, 'custom_') === 0) && (!in_array($name, self::$LTI_RETAIN_SETTING_NAMES))) {
                                 $this->resourceLink->setSetting($name);
                             }
                         }
                     }
                     // Save LTI parameters
                     foreach (self::$LTI_CONSUMER_SETTING_NAMES as $name) {
                         if (isset($this->messageParameters[$name])) {
                             $this->platform->setSetting($name, $this->messageParameters[$name]);
                         } elseif (!in_array($name, self::$LTI_RETAIN_SETTING_NAMES)) {
                             $this->platform->setSetting($name);
                         }
                     }
                     if (!empty($this->context)) {
                         foreach (self::$LTI_CONTEXT_SETTING_NAMES as $name) {
                             if (isset($this->messageParameters[$name])) {
                                 $this->context->setSetting($name, $this->messageParameters[$name]);
                             } elseif (!in_array($name, self::$LTI_RETAIN_SETTING_NAMES)) {
                                 $this->context->setSetting($name);
                             }
                         }
                     }
                     if (!empty($this->resourceLink)) {
                         foreach (self::$LTI_RESOURCE_LINK_SETTING_NAMES as $name) {
                             if (isset($this->messageParameters[$name])) {
                                 $this->resourceLink->setSetting($name, $this->messageParameters[$name]);
                             } elseif (!in_array($name, self::$LTI_RETAIN_SETTING_NAMES)) {
                                 $this->resourceLink->setSetting($name);
                             }
                         }
                     }
                     // Save other custom parameters at all levels
                     foreach ($this->messageParameters as $name => $value) {
                         if ((strpos($name, 'custom_') === 0) && !in_array(
                             $name,
                             array_merge(
                                 self::$LTI_CONSUMER_SETTING_NAMES,
                                 self::$LTI_CONTEXT_SETTING_NAMES,
                                 self::$LTI_RESOURCE_LINK_SETTING_NAMES
                             )
                         )) {
                             $this->platform->setSetting($name, $value);
                             if (!empty($this->context)) {
                                 $this->context->setSetting($name, $value);
                             }
                             if (!empty($this->resourceLink)) {
                                 $this->resourceLink->setSetting($name, $value);
                             }
                         }
                     }
 
                     // Set the user instance
                     $userId = '';
                     if ($this->hasConfiguredApiHook(self::$USER_ID_HOOK, $this->platform->getFamilyCode(), $this)) {
                         $className = $this->getApiHook(self::$USER_ID_HOOK, $this->platform->getFamilyCode());
                         $tpHook = new $className($this);
                         $userId = $tpHook->getUserId();
                     }
                     if (empty($userId) && isset($this->messageParameters['user_id'])) {
                         $userId = trim($this->messageParameters['user_id']);
                     }
 
                     $this->userResult = UserResult::fromResourceLink($this->resourceLink, $userId);
 
                     // Set the user name
                     $firstname = (isset($this->messageParameters['lis_person_name_given'])) ? $this->messageParameters['lis_person_name_given'] : '';
                     $lastname = (isset($this->messageParameters['lis_person_name_family'])) ? $this->messageParameters['lis_person_name_family'] : '';
                     $fullname = (isset($this->messageParameters['lis_person_name_full'])) ? $this->messageParameters['lis_person_name_full'] : '';
                     $this->userResult->setNames($firstname, $lastname, $fullname);
 
                     // Set the sourcedId
                     if (isset($this->messageParameters['lis_person_sourcedid'])) {
                         $this->userResult->sourcedId = $this->messageParameters['lis_person_sourcedid'];
                     }
 
                     // Set the username
                     if (isset($this->messageParameters['ext_username'])) {
                         $this->userResult->username = $this->messageParameters['ext_username'];
                     } elseif (isset($this->messageParameters['ext_user_username'])) {
                         $this->userResult->username = $this->messageParameters['ext_user_username'];
                     } elseif (isset($this->messageParameters['custom_username'])) {
                         $this->userResult->username = $this->messageParameters['custom_username'];
                     } elseif (isset($this->messageParameters['custom_user_username'])) {
                         $this->userResult->username = $this->messageParameters['custom_user_username'];
                     }
 
                     // Set the user email
                     $email = (isset($this->messageParameters['lis_person_contact_email_primary'])) ? $this->messageParameters['lis_person_contact_email_primary'] : '';
                     $this->userResult->setEmail($email, $this->defaultEmail);
 
                     // Set the user image URI
                     if (isset($this->messageParameters['user_image'])) {
                         $this->userResult->image = $this->messageParameters['user_image'];
                     }
 
                     // Set the user roles
                     if (isset($this->messageParameters['roles'])) {
                         $this->userResult->roles = self::parseRoles(
                             $this->messageParameters['roles'],
                             $this->messageParameters['lti_version']
                         );
                     }
 
                     // Initialise the platform and check for changes
                     $this->platform->defaultEmail = $this->defaultEmail;
                     if ($this->platform->ltiVersion !== $this->messageParameters['lti_version']) {
                         $this->platform->ltiVersion = $this->messageParameters['lti_version'];
                         $doSavePlatform = true;
                     }
                     if (isset($this->messageParameters['deployment_id'])) {
                         $this->platform->deploymentId = $this->messageParameters['deployment_id'];
                     }
                     if (isset($this->messageParameters['tool_consumer_instance_name'])) {
                         if ($this->platform->consumerName !== $this->messageParameters['tool_consumer_instance_name']) {
                             $this->platform->consumerName = $this->messageParameters['tool_consumer_instance_name'];
                             $doSavePlatform = true;
                         }
                     }
                     if (isset($this->messageParameters['tool_consumer_info_product_family_code'])) {
                         $version = $this->messageParameters['tool_consumer_info_product_family_code'];
                         if (isset($this->messageParameters['tool_consumer_info_version'])) {
                             $version .= "-{$this->messageParameters['tool_consumer_info_version']}";
                         }
                         // do not delete any existing consumer version if none is passed
                         if ($this->platform->consumerVersion !== $version) {
                             $this->platform->consumerVersion = $version;
                             $doSavePlatform = true;
                         }
                     } elseif (isset($this->messageParameters['ext_lms']) && ($this->platform->consumerName !== $this->messageParameters['ext_lms'])) {
                         $this->platform->consumerVersion = $this->messageParameters['ext_lms'];
                         $doSavePlatform = true;
                     }
                     if (isset($this->messageParameters['tool_consumer_instance_guid'])) {
                         if (is_null($this->platform->consumerGuid)) {
                             $this->platform->consumerGuid = $this->messageParameters['tool_consumer_instance_guid'];
                             $doSavePlatform = true;
                         } elseif (!$this->platform->protected && ($this->platform->consumerGuid !== $this->messageParameters['tool_consumer_instance_guid'])) {
                             $this->platform->consumerGuid = $this->messageParameters['tool_consumer_instance_guid'];
                             $doSavePlatform = true;
                         }
                     }
                     if (isset($this->messageParameters['launch_presentation_css_url'])) {
                         if ($this->platform->cssPath !== $this->messageParameters['launch_presentation_css_url']) {
                             $this->platform->cssPath = $this->messageParameters['launch_presentation_css_url'];
                             $doSavePlatform = true;
                         }
                     } elseif (isset($this->messageParameters['ext_launch_presentation_css_url']) && ($this->platform->cssPath !== $this->messageParameters['ext_launch_presentation_css_url'])) {
                         $this->platform->cssPath = $this->messageParameters['ext_launch_presentation_css_url'];
                         $doSavePlatform = true;
                     } elseif (!empty($this->platform->cssPath)) {
                         $this->platform->cssPath = null;
                         $doSavePlatform = true;
                     }
                 }
 
                 // Persist changes to platform
                 if ($doSavePlatform) {
                     $this->platform->save();
                 }
 
                 if ($this->ok) {
                     // Persist changes to cpntext
                     if (isset($this->context)) {
                         $this->context->save();
                     }
 
                     if (isset($this->resourceLink)) {
                         // Persist changes to resource link
                         $this->resourceLink->save();
 
                         // Persist changes to user instnce
                         $this->userResult->setResourceLinkId($this->resourceLink->getRecordId());
                         if (isset($this->messageParameters['lis_result_sourcedid'])) {
                             if ($this->userResult->ltiResultSourcedId !== $this->messageParameters['lis_result_sourcedid']) {
                                 $this->userResult->ltiResultSourcedId = $this->messageParameters['lis_result_sourcedid'];
                                 $this->userResult->save();
                             }
                         } elseif ($this->userResult->isLearner()) {  // Ensure all learners are recorded in case Assignment and Grade services are used
                             $this->userResult->ltiResultSourcedId = '';
                             $this->userResult->save();
                         }
 
                         // Check if a share arrangement is in place for this resource link
                         $this->ok = $this->checkForShare();
                     }
                 }
             }
         }
         return $this->ok;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkForShare()

ILIAS\LTI\ToolProvider\Tool::checkForShare ( )

private

Check if a share arrangement is in place.

Returns: bool True if no error is reported

Definition at line 1936 of file Tool.php.

References ILIAS\LTI\ToolProvider\$id, ILIAS\LTI\ToolProvider\Tool\$resourceLink, and ILIAS\LTI\ToolProvider\ResourceLink\fromRecordId().

Referenced by ILIAS\LTI\ToolProvider\Tool\authenticate().

                                     : bool
     {
         $ok = true;
         $doSaveResourceLink = true;
 
         $id = $this->resourceLink->primaryResourceLinkId;
 
         $shareRequest = isset($this->messageParameters['custom_share_key']) && !empty($this->messageParameters['custom_share_key']);
         if ($shareRequest) {
             if (!$this->allowSharing) {
                 $ok = false;
                 $this->reason = 'Your sharing request has been refused because sharing is not being permitted.';
             } else {
                 // Check if this is a new share key
                 $shareKey = new ResourceLinkShareKey($this->resourceLink, $this->messageParameters['custom_share_key']);
                 if (!is_null($shareKey->resourceLinkId)) {
                     // Update resource link with sharing primary resource link details
                     $id = $shareKey->resourceLinkId;
                     $ok = ($id !== $this->resourceLink->getRecordId());
                     if ($ok) {
                         $this->resourceLink->primaryResourceLinkId = $id;
                         $this->resourceLink->shareApproved = $shareKey->autoApprove;
                         $ok = $this->resourceLink->save();
                         if ($ok) {
                             $doSaveResourceLink = false;
                             $this->userResult->getResourceLink()->primaryResourceLinkId = $id;
                             $this->userResult->getResourceLink()->shareApproved = $shareKey->autoApprove;
                             $this->userResult->getResourceLink()->updated = time();
                             // Remove share key
                             $shareKey->delete();
                         } else {
                             $this->reason = 'An error occurred initialising your share arrangement.';
                         }
                     } else {
                         $this->reason = 'It is not possible to share your resource link with yourself.';
                     }
                 }
                 if ($ok) {
                     $ok = !is_null($id);
                     if (!$ok) {
                         $this->reason = 'You have requested to share a resource link but none is available.';
                     } else {
                         $ok = (!is_null($this->userResult->getResourceLink()->shareApproved) && $this->userResult->getResourceLink()->shareApproved);
                         if (!$ok) {
                             $this->reason = 'Your share request is waiting to be approved.';
                         }
                     }
                 }
             }
         } else {
             // Check no share is in place
             $ok = is_null($id);
             if (!$ok) {
                 $this->reason = 'You have not requested to share a resource link but an arrangement is currently in place.';
             }
         }
 
         // Look up primary resource link
         if ($ok && !is_null($id)) {
             $resourceLink = ResourceLink::fromRecordId($id, $this->dataConnector);
             $ok = !is_null($resourceLink->created);
             if ($ok) {
                 if ($doSaveResourceLink) {
                     $this->resourceLink->save();
                 }
                 $this->resourceLink = $resourceLink;
             } else {
                 $this->reason = 'Unable to load resource link being shared.';
             }
         }
 
         return $ok;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkValue()

ILIAS\LTI\ToolProvider\Tool::checkValue	(	&	$value,
		array	$values,
		string	$reason,
		bool	$strictMode,
		bool	$ignoreInvalid = `false`
	)

private

Validate a parameter value from an array of permitted values.

Parameters

mixed	$value	Value to be checked
array	$values	Array of permitted values
string	$reason	Reason to generate when the value is not permitted
bool	$strictMode	True if full compliance with the LTI specification is required
bool	$ignoreInvalid	True if invalid values are to be ignored (optional default is false)

Returns: bool True if value is valid

Definition at line 2132 of file Tool.php.

References ILIAS\LTI\ToolProvider\Util\logInfo().

Referenced by ILIAS\LTI\ToolProvider\Tool\authenticate().

                                                                                                                       : bool
     {
         $lookupValue = $value;
         if (!$strictMode) {
             $lookupValue = strtolower($value);
         }
         $ok = in_array($lookupValue, $values);
         if (!$ok && !$strictMode && $ignoreInvalid) {
             Util::logInfo(sprintf($reason, $value) . " [Error ignored]");
             $ok = true;
         } elseif (!$ok && !empty($reason)) {
             $this->reason = sprintf($reason, $value);
         } elseif ($lookupValue !== $value) {
             Util::logInfo(sprintf($reason, $value) . " [Changed to '{$lookupValue}']");
             $value = $lookupValue;
         }
 
         return $ok;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ILIAS\LTI\ToolProvider\Tool::delete ( )

Delete the tool from the database.

Returns: bool True if the object was successfully deleted

Definition at line 426 of file Tool.php.

                             : bool
     {
         return $this->dataConnector->deleteTool($this);
     }

◆ findService()

ILIAS\LTI\ToolProvider\Tool::findService	(	string	$format,
		array	$methods
	)

Find an offered service based on a media type and HTTP action(s)

Parameters

string	$format	Media type required
array	$methods	Array of HTTP actions required

Returns: object|bool The service object

Definition at line 562 of file Tool.php.

References $service.

Referenced by ILIAS\LTI\ToolProvider\Tool\authenticate().

     {
         $found = false;
         $services = $this->platform->profile->service_offered;
         if (is_array($services)) {
             $n = -1;
             foreach ($services as $service) {
                 $n++;
                 if (!is_array($service->format) || !in_array($format, $service->format)) {
                     continue;
                 }
                 $missing = array();
                 foreach ($methods as $method) {
                     if (!is_array($service->action) || !in_array($method, $service->action)) {
                         $missing[] = $method;
                     }
                 }
                 $methods = $missing;
                 if (count($methods) <= 0) {
                     $found = $service;
                     break;
                 }
             }
         }
 
         return $found;
     }

Here is the caller graph for this function:

◆ fromConsumerKey()

static ILIAS\LTI\ToolProvider\Tool::fromConsumerKey	(	string	$key = `null`,
		DataConnector	$dataConnector = `null`,
		bool	$autoEnable = `false`
	)

static

Load the tool from the database by its consumer key.

Parameters

string \| null	$key	Consumer key
DataConnector \| null	$dataConnector	A data connector object
bool	$autoEnable	true if the tool is to be enabled automatically (optional, default is false)

Returns: Tool The tool object

Definition at line 1089 of file Tool.php.

References ILIAS\LTI\ToolProvider\$dataConnector, and ILIAS\LTI\ToolProvider\$key.

                                                                                                                              : Tool
     {
         $tool = new static($dataConnector);
         $tool->key = $key;
         if (!empty($dataConnector)) {
             $ok = $dataConnector->loadTool($tool);
             if ($ok && $autoEnable) {
                 $tool->enabled = true;
             }
         }
 
         return $tool;
     }

◆ fromInitiateLoginUrl()

static ILIAS\LTI\ToolProvider\Tool::fromInitiateLoginUrl	(	string	$initiateLoginUrl,
		DataConnector	$dataConnector = `null`,
		bool	$autoEnable = `false`
	)

static

Load the tool from the database by its initiate login URL.

Parameters

string	$initiateLoginUrl	The initiate login URL
DataConnector \| null	$dataConnector	A data connector object
bool	$autoEnable	True if the tool is to be enabled automatically (optional, default is false)

Returns: Tool The tool object

Definition at line 1110 of file Tool.php.

References ILIAS\LTI\ToolProvider\$dataConnector, and ILIAS\LTI\ToolProvider\Tool\$initiateLoginUrl.

                                                                                                                                         : Tool
     {
         $tool = new static($dataConnector);
         $tool->initiateLoginUrl = $initiateLoginUrl;
         if ($dataConnector->loadTool($tool)) {
             if ($autoEnable) {
                 $tool->enabled = true;
             }
         }
 
         return $tool;
     }

◆ fromRecordId()

static ILIAS\LTI\ToolProvider\Tool::fromRecordId	(	string	$id,
		DataConnector	$dataConnector
	)

static

Load the tool from the database by its record ID.

Parameters

string	$id	The tool record ID
DataConnector	$dataConnector	A data connector object

Returns: Tool The tool object

Definition at line 1129 of file Tool.php.

References ILIAS\LTI\ToolProvider\$dataConnector, and ILIAS\LTI\ToolProvider\DataConnector\DataConnector\loadTool().

                                                                                  : Tool
     {
         $tool = new static($dataConnector);
         $tool->setRecordId($id);
         $dataConnector->loadTool($tool);
 
         return $tool;
     }

Here is the call graph for this function:

◆ getConfiguration()

ILIAS\LTI\ToolProvider\Tool::getConfiguration ( array $platformConfig )

protected

Prepare the tool's configuration data.

Parameters

array $platformConfig Platform configuration data

Returns: array Tool configuration data

Definition at line 804 of file Tool.php.

References $claims, ILIAS\LTI\ToolProvider\$jku, $messages, and ILIAS\LTI\ToolProvider\Util\MESSAGE_TYPE_MAPPING.

Referenced by ILIAS\LTI\ToolProvider\Tool\onRegistration().

                                                               : array
     {
         $claimsMapping = array(
             'User.id' => 'sub',
             'Person.name.full' => 'name',
             'Person.name.given' => 'given_name',
             'Person.name.family' => 'family_name',
             'Person.email.primary' => 'email'
         );
         $toolName = (!empty($this->product->name)) ? $this->product->name : 'Unnamed tool';
         $toolDescription = (!empty($this->product->description)) ? $this->product->description : '';
 //        $oauthRequest = OAuth\OAuthRequest::from_request();
         $oauthRequest = LTIOAuth\OAuthRequest::from_request();
         $toolUrl = $oauthRequest->get_normalized_http_url();
         $pos = strpos($toolUrl, '//');
         $domain = substr($toolUrl, $pos + 2);
         $domain = substr($domain, 0, strpos($domain, '/'));
         $claimsSupported = $platformConfig['claims_supported'];
         $messagesSupported = $platformConfig['https://purl.imsglobal.org/spec/lti-platform-configuration']['messages_supported'];
         $scopesSupported = $platformConfig['scopes_supported'];
         $iconUrl = null;
         $messages = array();
         $claims = array('iss');
         $variables = array();
         $constants = array();
         $redirectUris = array();
         foreach ($this->resourceHandlers as $resourceHandler) {
             if (empty($iconUrl)) {
                 $iconUrl = $resourceHandler->icon;
             }
             foreach (array_merge($resourceHandler->optionalMessages, $resourceHandler->requiredMessages) as $message) {
                 $type = $message->type;
                 if (array_key_exists($type, Util::MESSAGE_TYPE_MAPPING)) {
                     $type = Util::MESSAGE_TYPE_MAPPING[$type];
                 }
                 $capabilities = array();
                 if ($type === 'LtiResourceLinkRequest') {
                     $toolUrl = "{$this->baseUrl}{$message->path}";
                     $redirectUris[] = $toolUrl;
                     $capabilities = $message->capabilities;
                     $variables = array_merge($variables, $message->variables);
                     $constants = array_merge($constants, $message->constants);
                 } elseif (in_array($type, $messagesSupported)) {
                     $redirectUris[] = "{$this->baseUrl}{$message->path}";
                     $capabilities = $message->capabilities;
                     $variables = array_merge($message->variables, $variables);
                     $constants = array_merge($message->constants, $constants);
                     $messages[] = array(
                         'type' => $type,
                         'target_link_uri' => "{$this->baseUrl}{$message->path}",
                         'label' => $toolName
                     );
                 }
                 foreach ($capabilities as $capability) {
                     if (array_key_exists($capability, $claimsMapping) && in_array($claimsMapping[$capability], $claimsSupported)) {
                         $claims[] = $claimsMapping[$capability];
                     }
                 }
             }
         }
         if (empty($redirectUris)) {
             $redirectUris = array($toolUrl);
         } else {
             $redirectUris = array_unique($redirectUris);
         }
         if (!empty($claims)) {
             $claims = array_unique($claims);
         }
         $custom = array();
         foreach ($constants as $name => $value) {
             $custom[$name] = $value;
         }
         foreach ($variables as $name => $value) {
             $custom[$name] = '$' . $value;
         }
         $toolConfig = array();
         $toolConfig['application_type'] = 'web';
         $toolConfig['client_name'] = $toolName;
         $toolConfig['response_types'] = array('id_token');
         $toolConfig['grant_types'] = array('implicit', 'client_credentials');
         $toolConfig['initiate_login_uri'] = $toolUrl;
         $toolConfig['redirect_uris'] = $redirectUris;
         $toolConfig['jwks_uri'] = $this->jku;
         $toolConfig['token_endpoint_auth_method'] = 'private_key_jwt';
         $toolConfig['https://purl.imsglobal.org/spec/lti-tool-configuration'] = array(
             'domain' => $domain,
             'target_link_uri' => $toolUrl,
             'custom_parameters' => $custom,
             'claims' => $claims,
             'messages' => $messages,
             'description' => $toolDescription
         );
         $toolConfig['scope'] = implode(' ', array_intersect($this->requiredScopes, $scopesSupported));
         if (!empty($iconUrl)) {
             $toolConfig['logo_uri'] = "{$this->baseUrl}{$iconUrl}";
         }
 
         return $toolConfig;
     }

Here is the caller graph for this function:

◆ getMessageParameters()

ILIAS\LTI\ToolProvider\Tool::getMessageParameters ( )

Get the message parameters.

Returns: array The message parameter array

Definition at line 436 of file Tool.php.

References ILIAS\LTI\ToolProvider\Util\$logLevel, ILIAS\LTI\ToolProvider\$messageParameters, ILIAS\LTI\ToolProvider\Util\LOGLEVEL_DEBUG, and ILIAS\LTI\ToolProvider\parseMessage().

Referenced by ILIAS\LTI\ToolProvider\Tool\handleRequest().

                                           : array
     {
         if (is_null($this->messageParameters)) {
             $this->parseMessage();
             // Set debug mode
             if (Util::$logLevel < Util::LOGLEVEL_DEBUG) {
                 $this->debugMode = (isset($this->messageParameters['custom_debug']) &&
                     (strtolower($this->messageParameters['custom_debug']) === 'true'));
                 if ($this->debugMode) {
                     Util::$logLevel = Util::LOGLEVEL_DEBUG;
                 }
             }
             // Set return URL if available
             if (!empty($this->messageParameters['lti_message_type']) &&
                 (($this->messageParameters['lti_message_type'] === 'ContentItemSelectionRequest') || ($this->messageParameters['lti_message_type'] === 'ContentItemUpdateRequest')) &&
                 !empty($this->messageParameters['content_item_return_url'])) {
                 $this->returnUrl = $this->messageParameters['content_item_return_url'];
             }
             if (empty($this->returnUrl) && !empty($this->messageParameters['launch_presentation_return_url'])) {
                 $this->returnUrl = $this->messageParameters['launch_presentation_return_url'];
             }
         }
 
         return $this->messageParameters;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPlatformConfiguration()

ILIAS\LTI\ToolProvider\Tool::getPlatformConfiguration ( )

protected

Fetch a platform's configuration data.

Returns: array|null Platform configuration data

Definition at line 747 of file Tool.php.

References $http, ILIAS\LTI\ToolProvider\Jwt\Jwt\getJwtClient(), ILIAS\LTI\ToolProvider\Util\getRequestParameters(), and ILIAS\LTI\ToolProvider\Jwt\Jwt\setJwtClient().

Referenced by ILIAS\LTI\ToolProvider\Tool\onRegistration().

                                                  : ?array
     {
         if ($this->ok) {
             $parameters = Util::getRequestParameters();
             $this->ok = !empty($parameters['openid_configuration']);
             if ($this->ok) {
                 $http = new HttpMessage($parameters['openid_configuration']);
                 $this->ok = $http->send();
                 if ($this->ok) {
                     $platformConfig = json_decode($http->response, true);
                     $this->ok = !empty($platformConfig);
                 }
                 if (!$this->ok) {
                     $this->reason = 'Unable to access platform configuration details.';
                 }
             } else {
                 $this->reason = 'Invalid registration request: missing openid_configuration parameter.';
             }
             if ($this->ok) {
                 $this->ok = !empty($platformConfig['registration_endpoint']) && !empty($platformConfig['jwks_uri']) && !empty($platformConfig['authorization_endpoint']) &&
                     !empty($platformConfig['token_endpoint']) && !empty($platformConfig['https://purl.imsglobal.org/spec/lti-platform-configuration']) &&
                     !empty($platformConfig['claims_supported']) && !empty($platformConfig['scopes_supported']) &&
                     !empty($platformConfig['id_token_signing_alg_values_supported']) &&
                     !empty($platformConfig['https://purl.imsglobal.org/spec/lti-platform-configuration']['product_family_code']) &&
                     !empty($platformConfig['https://purl.imsglobal.org/spec/lti-platform-configuration']['version']) &&
                     !empty($platformConfig['https://purl.imsglobal.org/spec/lti-platform-configuration']['messages_supported']);
                 if (!$this->ok) {
                     $this->reason = 'Invalid platform configuration details.';
                 }
             }
             if ($this->ok) {
                 Jwt::setJwtClient(); //added - check
                 $jwtClient = Jwt::getJwtClient();
                 $algorithms = \array_intersect(
                     $jwtClient::getSupportedAlgorithms(),
                     $platformConfig['id_token_signing_alg_values_supported']
                 );
                 $this->ok = !empty($algorithms);
                 if ($this->ok) {
                     rsort($platformConfig['id_token_signing_alg_values_supported']);
                 } else {
                     $this->reason = 'None of the signature algorithms offered by the platform is supported.';
                 }
             }
         }
         if (!$this->ok) {
             $platformConfig = null;
         }
 
         return $platformConfig;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPlatforms()

ILIAS\LTI\ToolProvider\Tool::getPlatforms ( )

Get an array of defined tool consumers.

Deprecated:: Use getPlatforms() instead

See also: Tool::getPlatforms()

Returns: array Array of ToolConsumer objects Get an array of defined platforms; array Array of Platform objects

Definition at line 551 of file Tool.php.

                                   : array
     {
         return $this->dataConnector->getPlatforms();
     }

◆ getPlatformToRegister()

ILIAS\LTI\ToolProvider\Tool::getPlatformToRegister	(	array	$platformConfig,
		array	$registrationConfig,
		bool	$doSave = `true`
	)

protected

Initialise the platform to be registered.

Parameters

array	$platformConfig	Platform configuration data
array	$registrationConfig	Registration data
bool	$doSave	True if the platform should be saved (optional, default is true)

Returns: Platform Platform object

Definition at line 946 of file Tool.php.

References ILIAS\LTI\ToolProvider\Tool\$platform, and ILIAS\LTI\ToolProvider\Util\LTI_VERSION1P3.

Referenced by ILIAS\LTI\ToolProvider\Tool\onRegistration().

                                                                                                                    : ?Platform
     {
         $domain = $platformConfig['issuer'];
         $pos = strpos($domain, '//');
         if ($pos !== false) {
             $domain = substr($domain, $pos + 2);
             $pos = strpos($domain, '/');
             if ($pos !== false) {
                 $domain = substr($domain, 0, $pos);
             }
         }
         $this->platform = new Platform($this->dataConnector);
         $this->platform->name = $domain;
         $this->platform->ltiVersion = Util::LTI_VERSION1P3;
         $this->platform->signatureMethod = reset($platformConfig['id_token_signing_alg_values_supported']);
         $this->platform->platformId = $platformConfig['issuer'];
         $this->platform->clientId = $registrationConfig['client_id'];
         $this->platform->deploymentId = $registrationConfig['https://purl.imsglobal.org/spec/lti-tool-configuration']['deployment_id'];
         $this->platform->authenticationUrl = $platformConfig['authorization_endpoint'];
         $this->platform->accessTokenUrl = $platformConfig['token_endpoint'];
         $this->platform->jku = $platformConfig['jwks_uri'];
         if ($doSave) {
             $this->ok = $this->platform->save();
             if (!$this->ok) {
                 $this->reason = 'Sorry, an error occurred when saving the platform details.';
             }
         }
 
         return $this->platform;
     }

Here is the caller graph for this function:

◆ getRegistrationResponsePage()

ILIAS\LTI\ToolProvider\Tool::getRegistrationResponsePage ( array $toolConfig )

protected

Prepare the page to complete a registration request.

Parameters

array $toolConfig Tool configuration data

Definition at line 981 of file Tool.php.

References ILIAS\LTI\ToolProvider\$enabled, ILIAS\UI\examples\Symbol\Glyph\Bold\bold(), ILIAS\Repository\button(), ILIAS\Repository\html(), ILIAS\FileDelivery\http(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Referenced by ILIAS\LTI\ToolProvider\Tool\onRegistration().

     {
         $enabled = '';
         if (!empty($this->platform)) {
             $now = time();
             if (!$this->platform->enabled) {
                 $enabled = ', but it will need to be enabled by the tool provider before it can be used';
             } elseif (!empty($this->platform->enableFrom) && ($this->platform->enableFrom > $now)) {
                 $enabled = ', but you will only have access from ' . date('j F Y H:i T', $this->platform->enableFrom);
                 if (!empty($this->platform->enableUntil)) {
                     $enabled .= ' until ' . date('j F Y H:i T', $this->platform->enableUntil);
                 }
             } elseif (!empty($this->platform->enableUntil)) {
                 if ($this->platform->enableUntil > $now) {
                     $enabled = ', but you will only have access until ' . date('j F Y H:i T', $this->platform->enableUntil);
                 } else {
                     $enabled = ', but your access was set to end at ' . date('j F Y H:i T', $this->platform->enableUntil);
                 }
             }
         }
         $html = <<< EOD
 <!DOCTYPE html>
 <html lang="en">
   <head>
     <meta http-equiv="content-type" content="text/html; charset=UTF-8">
     <title>LTI Tool registration</title>
     <style>
       h1 {
         font-soze: 110%;
         font-weight: bold;
       }
       .success {
         color: #155724;
         background-color: #d4edda;
         border-color: #c3e6cb;
         border: 1px solid;
         padding: .75rem 1.25rem;
         margin-bottom: 1rem;
       }
       .error {
         color: #721c24;
         background-color: #f8d7da;
         border-color: #f5c6cb;
         border: 1px solid;
         padding: .75rem 1.25rem;
         margin-bottom: 1rem;
       }
       .centre {
         text-align: center;
       }
       button {
         border: 1px solid transparent;
         padding: 0.375rem 0.75rem;
         font-size: 1rem;
         line-height: 1.5;
         border-radius: 0.25rem;
         color: #fff;
         background-color: #007bff;
         border-color: #007bff;
         text-align: center;
         text-decoration: none;
         display: inline-block;
         cursor: pointer;
       }
     </style>
     <script language="javascript" type="text/javascript">
       function doClose(el) {
         (window.opener || window.parent).postMessage({subject:'org.imsglobal.lti.close'}, '*');
         return true;
       }
     </script>
   </head>
   <body>
     <h1>{$toolConfig['client_name']} registration</h1>
 
 EOD;
         if ($this->ok) {
             $html .= <<< EOD
     <p class="success">
       The tool registration was successful{$enabled}.
     </p>
     <p class="centre">
       <button type="button" onclick="return doClose();">Close</button>
     </p>
 
 EOD;
         } else {
             $html .= <<< EOD
     <p class="error">
       Sorry, the registration was not successful: {$this->reason}
     </p>
 
 EOD;
         }
         $html .= <<< EOD
   </body>
 </html>
 EOD;
         $this->output = $html;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleRequest()

ILIAS\LTI\ToolProvider\Tool::handleRequest ( bool $strictMode = false )

Process an incoming request.

Parameters

bool $strictMode True if full compliance with the LTI specification is required (optional, default is false)

Definition at line 466 of file Tool.php.

     {
         $parameters = Util::getRequestParameters();
         if ($this->debugMode) {
             Util::$logLevel = Util::LOGLEVEL_DEBUG;
         }
         if ($_SERVER['REQUEST_METHOD'] === 'HEAD') {  // Ignore HEAD requests
             Util::logRequest(true);
         } elseif (isset($parameters['iss']) && (strlen($parameters['iss']) > 0)) {  // Initiate login request
             Util::logRequest();
             if (!isset($parameters['login_hint']) || (strlen($parameters['login_hint']) <= 0)) {
                 $this->ok = false;
                 $this->reason = 'Missing login_hint parameter';
             } elseif (!isset($parameters['target_link_uri']) || (strlen($parameters['target_link_uri']) <= 0)) {
                 $this->ok = false;
                 $this->reason = 'Missing target_link_uri parameter';
             } else {
                 $this->ok = $this->sendAuthenticationRequest($parameters);
             }
         } elseif (isset($parameters['openid_configuration']) && (strlen($parameters['openid_configuration']) > 0)) {  // Dynamic registration request
             Util::logRequest();
             $this->onRegistration();
         } else {  // LTI message
             $this->getMessageParameters();
             Util::logRequest();
             if ($this->ok && $this->authenticate($strictMode)) {
                 if (empty($this->output)) {
                     $this->doCallback();
                     if ($this->ok && ($this->messageParameters['lti_message_type'] === 'ToolProxyRegistrationRequest')) {
                         $this->platform->save();
                     }
                 }
             }
         }
         if (!$this->ok) {
             $errorMessage = "Request failed with reason: '{$this->reason}'";
             if (!empty($this->details)) {
                 $errorMessage .= PHP_EOL . 'Debug information:';
                 foreach ($this->details as $detail) {
                     $errorMessage .= PHP_EOL . "  {$detail}";
                 }
             }
             Util::logError($errorMessage);
         }
 
         $this->result();
     }

Here is the call graph for this function:

◆ initialize()

ILIAS\LTI\ToolProvider\Tool::initialize ( )

Initialise the tool.

Definition at line 381 of file Tool.php.

References ILIAS\Repository\settings().

Referenced by ILIAS\LTI\ToolProvider\Tool\__construct(), and ILIAS\LTI\ToolProvider\DataConnector\DataConnector\deleteTool().

     {
         $this->id = null;
         $this->key = null;
         $this->name = null;
         $this->secret = null;
         $this->messageUrl = null;
         $this->initiateLoginUrl = null;
         $this->redirectionUris = null;
         $this->rsaKey = null;
         $this->signatureMethod = 'HMAC-SHA1';
         $this->encryptionMethod = null;
         $this->ltiVersion = null;
         $this->settings = array();
         $this->enabled = false;
         $this->enableFrom = null;
         $this->enableUntil = null;
         $this->lastAccess = null;
         $this->created = null;
         $this->updated = null;
         $this->constraints = array();
 //        $this->vendor = new Profile\Item(); //Changed UK
         $this->vendor = new \ILIAS\LTI\ToolProvider\Content\Item(null);
 //        $this->product = new Profile\Item();
         $this->product = new \ILIAS\LTI\ToolProvider\Content\Item(null);
         $this->requiredServices = array();
         $this->optionalServices = array();
         $this->resourceHandlers = array();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ onConfigure()

ILIAS\LTI\ToolProvider\Tool::onConfigure ( )

protected

Process a valid configure request.

Definition at line 647 of file Tool.php.

References ILIAS\LTI\ToolProvider\Tool\onError().

     {
         $this->reason = 'No onConfigure method found for tool';
         $this->onError();
     }

Here is the call graph for this function:

◆ onContentItem()

ILIAS\LTI\ToolProvider\Tool::onContentItem ( )

protected

Process a valid content-item request.

Definition at line 665 of file Tool.php.

References ILIAS\LTI\ToolProvider\Tool\onError().

     {
         $this->reason = 'No onContentItem method found for tool';
         $this->onError();
     }

Here is the call graph for this function:

◆ onContentItemUpdate()

ILIAS\LTI\ToolProvider\Tool::onContentItemUpdate ( )

protected

Process a valid content-item update request.

Definition at line 674 of file Tool.php.

References ILIAS\LTI\ToolProvider\Tool\onError().

     {
         $this->reason = 'No onContentItemUpdate method found for tool';
         $this->onError();
     }

Here is the call graph for this function:

◆ onDashboard()

ILIAS\LTI\ToolProvider\Tool::onDashboard ( )

protected

Process a valid dashboard request.

Definition at line 656 of file Tool.php.

References ILIAS\LTI\ToolProvider\Tool\onError().

     {
         $this->reason = 'No onDashboard method found for tool';
         $this->onError();
     }

Here is the call graph for this function:

◆ onError()

ILIAS\LTI\ToolProvider\Tool::onError ( )

protected

Process a response to an invalid request.

Definition at line 737 of file Tool.php.

Referenced by ILIAS\LTI\ToolProvider\Tool\onConfigure(), ILIAS\LTI\ToolProvider\Tool\onContentItem(), ILIAS\LTI\ToolProvider\Tool\onContentItemUpdate(), ILIAS\LTI\ToolProvider\Tool\onDashboard(), ILIAS\LTI\ToolProvider\Tool\onLaunch(), ILIAS\LTI\ToolProvider\Tool\onLtiEndAssessment(), ILIAS\LTI\ToolProvider\Tool\onLtiStartProctoring(), ILIAS\LTI\ToolProvider\Tool\onRegister(), and ILIAS\LTI\ToolProvider\Tool\result().

     {
         $this->ok = false;
     }

Here is the caller graph for this function:

◆ onInitiateLogin()

ILIAS\LTI\ToolProvider\Tool::onInitiateLogin	(	array	$requestParameters,
		array &	$authParameters
	)

protected

Process a login initiation request.

Parameters

array	$requestParameters	Request parameters
array	$authParameters	Authentication request parameters

Definition at line 730 of file Tool.php.

Referenced by ILIAS\LTI\ToolProvider\Tool\sendAuthenticationRequest().

731 {

732 }

Here is the caller graph for this function:

◆ onLaunch()

ILIAS\LTI\ToolProvider\Tool::onLaunch ( )

protected

Send the tool proxy to the platform.

Returns: bool True if the tool proxy was accepted Generate a web page containing an auto-submitted form of parameters.

Parameters

string	$url	URL to which the form should be submitted
array	$params	Array of form parameters
string	$target	Name of target (optional)

Returns: string

Deprecated:: Use Util::sendForm() instead

See also: Util::sendForm() Process a valid launch request

Definition at line 638 of file Tool.php.

References ILIAS\LTI\ToolProvider\Tool\onError().

     {
         $this->reason = 'No onLaunch method found for tool';
         $this->onError();
     }

Here is the call graph for this function:

◆ onLtiEndAssessment()

ILIAS\LTI\ToolProvider\Tool::onLtiEndAssessment ( )

protected

Process a valid end assessment request.

Definition at line 718 of file Tool.php.

References ILIAS\LTI\ToolProvider\Tool\onError().

     {
         $this->reason = 'No onLtiEndAssessment method found for tool';
         $this->onError();
     }

Here is the call graph for this function:

◆ onLtiStartProctoring()

ILIAS\LTI\ToolProvider\Tool::onLtiStartProctoring ( )

protected

Process a valid start proctoring request.

Definition at line 709 of file Tool.php.

References ILIAS\LTI\ToolProvider\Tool\onError().

     {
         $this->reason = 'No onLtiStartProctoring method found for tool';
         $this->onError();
     }

Here is the call graph for this function:

◆ onRegister()

ILIAS\LTI\ToolProvider\Tool::onRegister ( )

protected

Process a valid tool proxy registration request.

Definition at line 683 of file Tool.php.

References ILIAS\LTI\ToolProvider\Tool\onError().

     {
         $this->reason = 'No onRegister method found for tool';
         $this->onError();
     }

Here is the call graph for this function:

◆ onRegistration()

ILIAS\LTI\ToolProvider\Tool::onRegistration ( )

protected

Process a dynamic registration request.

Definition at line 692 of file Tool.php.

References ILIAS\LTI\ToolProvider\Tool\getConfiguration(), ILIAS\LTI\ToolProvider\Tool\getPlatformConfiguration(), ILIAS\LTI\ToolProvider\Tool\getPlatformToRegister(), ILIAS\LTI\ToolProvider\Tool\getRegistrationResponsePage(), and ILIAS\LTI\ToolProvider\Tool\sendRegistration().

Referenced by ILIAS\LTI\ToolProvider\Tool\handleRequest().

     {
         $platformConfig = $this->getPlatformConfiguration();
         if ($this->ok) {
             $toolConfig = $this->getConfiguration($platformConfig);
             $registrationConfig = $this->sendRegistration($platformConfig, $toolConfig);
             if ($this->ok) {
                 $this->getPlatformToRegister($platformConfig, $registrationConfig);
             }
         }
         $this->getRegistrationResponsePage($toolConfig);
         $this->ok = true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ result()

ILIAS\LTI\ToolProvider\Tool::result ( )

private

Perform the result of an action.

This function may redirect the user to another URL rather than returning a value.

returns string Output to be displayed (redirection, or display HTML or message) //UK: erased

Returns

Definition at line 1149 of file Tool.php.

References ILIAS\LTI\ToolProvider\Tool\$errorOutput, ILIAS\LTI\ToolProvider\Tool\$message, ILIAS\LTI\ToolProvider\Tool\$output, ILIAS\LTI\ToolProvider\$reason, ILIAS\LTI\ToolProvider\Tool\$returnUrl, exit, ILIAS\UI\examples\Symbol\Glyph\Header\header(), ILIAS\LTI\ToolProvider\Util\LTI_VERSION1, ILIAS\LTI\ToolProvider\Tool\onError(), and ILIAS\LTI\ToolProvider\sendMessage().

Referenced by ILIAS\LTI\ToolProvider\Tool\handleRequest().

                              : void
     {
         if (!$this->ok) {
             $this->message = self::CONNECTION_ERROR_MESSAGE . ' ' . $this->reason;
             $this->onError();
         }
         if (!$this->ok) {
             // If not valid, return an error message to the platform if a return URL is provided
             if (!empty($this->returnUrl)) {
                 $errorUrl = $this->returnUrl;
                 if (!is_null($this->platform) && isset($this->messageParameters['lti_message_type']) &&
                     (($this->messageParameters['lti_message_type'] === 'ContentItemSelectionRequest') ||
                         ($this->messageParameters['lti_message_type'] === 'ContentItemUpdateRequest'))) {
                     $formParams = array();
                     if ($this->debugMode && !is_null($this->reason)) {
                         $formParams['lti_errormsg'] = "Debug error: {$this->reason}";
                     } else {
                         $formParams['lti_errormsg'] = $this->message;
                         if (!is_null($this->reason)) {
                             $formParams['lti_errorlog'] = "Debug error: {$this->reason}";
                         }
                     }
                     if (isset($this->messageParameters['data'])) {
                         $formParams['data'] = $this->messageParameters['data'];
                     }
                     $this->version = (isset($this->messageParameters['lti_version'])) ? $this->messageParameters['lti_version'] : Util::LTI_VERSION1;
                     $page = $this->sendMessage($errorUrl, 'ContentItemSelection', $formParams);
                     echo $page;
                 } else {
                     if (strpos($errorUrl, '?') === false) {
                         $errorUrl .= '?';
                     } else {
                         $errorUrl .= '&';
                     }
                     if ($this->debugMode && !is_null($this->reason)) {
                         $errorUrl .= 'lti_errormsg=' . urlencode("Debug error: $this->reason");
                     } else {
                         $errorUrl .= 'lti_errormsg=' . urlencode($this->message);
                         if (!is_null($this->reason)) {
                             $errorUrl .= '&lti_errorlog=' . urlencode("Debug error: $this->reason");
                         }
                     }
                     header("Location: {$errorUrl}");
                 }
                 exit;
             } else {
                 if (!is_null($this->errorOutput)) {
                     echo $this->errorOutput;
                 } elseif ($this->debugMode && !empty($this->reason)) {
                     echo "Debug error: {$this->reason}";
                 } else {
                     echo "Error: {$this->message}";
                 }
                 exit;
             }
         } elseif (!is_null($this->redirectUrl)) {
             header("Location: {$this->redirectUrl}");
             exit;
         } elseif (!is_null($this->output)) {
             echo $this->output;
             exit;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ILIAS\LTI\ToolProvider\Tool::save ( )

Save the tool to the database.

Returns: bool True if the object was successfully saved

Definition at line 416 of file Tool.php.

                           : bool
     {
         return $this->dataConnector->saveTool($this);
     }

◆ sendAuthenticationRequest()

ILIAS\LTI\ToolProvider\Tool::sendAuthenticationRequest ( array $parameters )

private

Generate a form to perform an authentication request.

Parameters

array $parameters Request parameters

Returns: bool True if form was generated

Definition at line 2015 of file Tool.php.

References $_SERVER, ILIAS\LTI\ToolProvider\Tool\$authenticateUsingGet, $clientId, ILIAS\LTI\ToolProvider\Util\$logLevel, $param, $params, $parts, ilLTIPlatform\fromPlatformId(), ILIAS\LTI\ToolProvider\Util\getRandomString(), ILIAS\LTI\ToolProvider\Util\LOGLEVEL_INFO, ILIAS\LTI\ToolProvider\Util\logRequest(), ILIAS\LTI\ToolProvider\Tool\onInitiateLogin(), ILIAS\LTI\ToolProvider\Util\redirect(), and ILIAS\LTI\ToolProvider\Util\sendForm().

Referenced by ILIAS\LTI\ToolProvider\Tool\handleRequest().

                                                                  : bool
     {
         $clientId = null;
         if (isset($parameters['client_id'])) {
             $clientId = $parameters['client_id'];
         }
         $deploymentId = null;
         if (isset($parameters['lti_deployment_id'])) {
             $deploymentId = $parameters['lti_deployment_id'];
         }
         $currentLogLevel = Util::$logLevel;
         $this->platform = \ilLTIPlatform::fromPlatformId($parameters['iss'], $clientId, $deploymentId, $this->dataConnector);
         if ($this->platform->debugMode && ($currentLogLevel < Util::LOGLEVEL_INFO)) {
             $this->debugMode = true;
             Util::logRequest();
         }
         $ok = !is_null($this->platform) && !empty($this->platform->authenticationUrl);
         if (!$ok) {
             $this->reason = 'Platform not found or no platform authentication request URL.';
         } else {
             do {
                 $nonce = new PlatformNonce($this->platform, Util::getRandomString());
                 $ok = !$nonce->load();
             } while (!$ok);
             $nonce->expires = time() + 10;  // Expire after 10 seconds
             $ok = $nonce->save();
             if ($ok) {
 //                $oauthRequest = OAuth\OAuthRequest::from_request();
                 $oauthRequest = LTIOAuth\OAuthRequest::from_request();
                 $redirectUri = $oauthRequest->get_normalized_http_url();
                 if (!empty($_SERVER['QUERY_STRING'])) {
                     if ($_SERVER['REQUEST_METHOD'] === 'POST') {
                         $redirectUri .= "?{$_SERVER['QUERY_STRING']}";
                     } else {  // Remove all parameters added by platform from query string
                         $queryString = '';
                         $params = explode('&', $_SERVER['QUERY_STRING']);
                         $ignore = false;  // Only include those query parameters which come before any of the standard OpenID Connect ones
                         foreach ($params as $param) {
                             $parts = explode('=', $param, 2);
                             if (in_array(
                                 $parts[0],
                                 array('iss', 'target_link_uri', 'login_hint', 'lti_message_hint', 'client_id', 'lti_deployment_id')
                             )) {
                                 $ignore = true;
                             } elseif (!$ignore) {
                                 if ((count($parts) <= 1) || empty($parts[1])) {  // Drop equals sign for empty parameters to workaround Canvas bug
                                     $queryString .= "&{$parts[0]}";
                                 } else {
                                     $queryString .= "&{$parts[0]}={$parts[1]}";
                                 }
                             }
                         }
                         if (!empty($queryString)) {
                             $queryString = substr($queryString, 1);
                             $redirectUri .= "?{$queryString}";
                         }
                     }
                 }
                 $params = array(
                     'client_id' => $this->platform->clientId,
                     'login_hint' => $parameters['login_hint'],
                     'nonce' => Util::getRandomString(32),
                     'prompt' => 'none',
                     'redirect_uri' => $redirectUri,
                     'response_mode' => 'form_post',
                     'response_type' => 'id_token',
                     'scope' => 'openid',
                     'state' => $nonce->getValue()
                 );
                 if (isset($parameters['lti_message_hint'])) {
                     $params['lti_message_hint'] = $parameters['lti_message_hint'];
                 }
                 $this->onInitiateLogin($parameters, $params);
                 if (!Tool::$authenticateUsingGet) {
                     $this->output = Util::sendForm($this->platform->authenticationUrl, $params);
                 } else {
                     Util::redirect($this->platform->authenticationUrl, $params);
                 }
             } else {
                 $this->reason = 'Unable to generate a state value.';
             }
         }
 
         return $ok;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendRegistration()

ILIAS\LTI\ToolProvider\Tool::sendRegistration	(	array	$platformConfig,
		array	$toolConfig
	)

protected

Send the tool registration to the platform.

Parameters

array	$platformConfig	Platform configuration data
array	$toolConfig	Tool configuration data

Returns: array Registration data

Definition at line 910 of file Tool.php.

References $http, and ILIAS\LTI\ToolProvider\Util\getRequestParameters().

Referenced by ILIAS\LTI\ToolProvider\Tool\onRegistration().

                                                                                  : ?array
     {
         if ($this->ok) {
             $parameters = Util::getRequestParameters();
             $this->ok = !empty($parameters['registration_token']);
             if ($this->ok) {
                 $body = json_encode($toolConfig);
                 $headers = "Content-type: application/json\n" .
                     "Authorization: Bearer {$parameters['registration_token']}";
                 $http = new HttpMessage($platformConfig['registration_endpoint'], 'POST', $body, $headers);
                 $this->ok = $http->send();
                 if ($this->ok) {
                     $registrationConfig = json_decode($http->response, true);
                     $this->ok = !empty($registrationConfig);
                 }
                 if (!$this->ok) {
                     $this->reason = 'Unable to register with platform.';
                 }
             } else {
                 $this->reason = 'Invalid registration request: missing registration_token parameter.';
             }
         }
         if (!$this->ok) {
             $registrationConfig = null;
         }
 
         return $registrationConfig;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendRelaunchRequest()

ILIAS\LTI\ToolProvider\Tool::sendRelaunchRequest ( )

private

Generate a form to perform a relaunch request.

Definition at line 2104 of file Tool.php.

References $params, ILIAS\LTI\ToolProvider\Util\getRandomString(), and ILIAS\LTI\ToolProvider\Util\sendForm().

Referenced by ILIAS\LTI\ToolProvider\Tool\authenticate().

     {
         do {
             $nonce = new PlatformNonce($this->platform, Util::getRandomString());
             $ok = !$nonce->load();
         } while (!$ok);
         $ok = $nonce->save();
         if ($ok) {
             $params = array(
                 'tool_state' => $nonce->getValue(),
                 'platform_state' => $this->messageParameters['platform_state']
             );
             $params = $this->platform->addSignature($this->messageParameters['relaunch_url'], $params);
             $this->output = Util::sendForm($this->messageParameters['relaunch_url'], $params);
         } else {
             $this->reason = 'Unable to generate a state value.';
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setParameterConstraint()

ILIAS\LTI\ToolProvider\Tool::setParameterConstraint	(	string	$name,
		bool	$required = `true`,
		int	$maxLength = `null`,
		array	$messageTypes = `null`
	)

Add a parameter constraint to be checked on launch.

Parameters

string	$name	Name of parameter to be checked
bool	$required	True if parameter is required (optional, default is true)
int \| null	$maxLength	Maximum permitted length of parameter value (optional, default is null)
array \| null	$messageTypes	Array of message types to which the constraint applies (optional, default is all)

Definition at line 521 of file Tool.php.

Referenced by ilLTITool\__construct().

     {
         $name = trim($name);
         if (!empty($name)) {
             $this->constraints[$name] = array('required' => $required, 'max_length' => $maxLength, 'messages' => $messageTypes);
         }
     }

Here is the caller graph for this function:

Field Documentation

◆ $allowSharing

bool ILIAS\LTI\ToolProvider\Tool::$allowSharing = false

Whether shared resource link arrangements are permitted.

Definition at line 222 of file Tool.php.

◆ $authenticateUsingGet

bool ILIAS\LTI\ToolProvider\Tool::$authenticateUsingGet = false

static

Use GET method for authentication request messages when true.

Definition at line 306 of file Tool.php.

Referenced by ILIAS\LTI\ToolProvider\Tool\sendAuthenticationRequest().

◆ $baseUrl

string null ILIAS\LTI\ToolProvider\Tool::$baseUrl = null

Base URL for tool service.

Definition at line 236 of file Tool.php.

◆ $constraints

array null ILIAS\LTI\ToolProvider\Tool::$constraints = null

private

LTI parameter constraints for auto validation checks.

Definition at line 362 of file Tool.php.

◆ $contentTypes

array null ILIAS\LTI\ToolProvider\Tool::$contentTypes = null

protected

Content item types accepted by the platform.

Definition at line 327 of file Tool.php.

Referenced by ILIAS\LTI\ToolProvider\Tool\authenticate().

◆ $context

Context null ILIAS\LTI\ToolProvider\Tool::$context = null

Context object.

Definition at line 201 of file Tool.php.

◆ $CUSTOM_SUBSTITUTION_VARIABLES

array ILIAS\LTI\ToolProvider\Tool::$CUSTOM_SUBSTITUTION_VARIABLES

staticprivate

Names of LTI custom parameter substitution variables (or capabilities) and their associated default message parameter names.

Definition at line 122 of file Tool.php.

◆ $defaultEmail

string ILIAS\LTI\ToolProvider\Tool::$defaultEmail = ''

Default email domain.

Definition at line 208 of file Tool.php.

Referenced by ILIAS\LTI\ToolProvider\Tool\authenticate().

◆ $defaultTool

Tool null ILIAS\LTI\ToolProvider\Tool::$defaultTool = null

static

Default tool for use with service requests.

Definition at line 299 of file Tool.php.

Referenced by ILIAS\LTI\ToolProvider\addJWTSignature(), ILIAS\LTI\ToolProvider\addOAuth1Signature(), ILIAS\LTI\ToolProvider\ResourceLink\doLTI11Service(), ILIAS\LTI\ToolProvider\ResourceLink\doService(), ILIAS\LTI\ToolProvider\AccessToken\get(), ILIAS\LTI\ToolProvider\Platform\handleAuthenticationRequest(), ILIAS\LTI\ToolProvider\OAuthDataStore\lookup_consumer(), ILIAS\LTI\ToolProvider\Platform\onAuthenticate(), ILIAS\LTI\ToolProvider\signMessage(), and ILIAS\LTI\ToolProvider\verifySignature().

◆ $documentTargets

array null ILIAS\LTI\ToolProvider\Tool::$documentTargets = null

protected

Document targets accepted by the platform.

Definition at line 341 of file Tool.php.

Referenced by ILIAS\LTI\ToolProvider\Tool\authenticate().

◆ $errorOutput

string null ILIAS\LTI\ToolProvider\Tool::$errorOutput = null

protected

HTML to be displayed on an unsuccessful completion of the request and no return URL is available.

Definition at line 355 of file Tool.php.

Referenced by ILIAS\LTI\ToolProvider\Tool\result().

◆ $fileTypes

array null ILIAS\LTI\ToolProvider\Tool::$fileTypes = null

protected

File types accepted by the platform.

Definition at line 334 of file Tool.php.

Referenced by ILIAS\LTI\ToolProvider\Tool\authenticate().

◆ $idScope

int ILIAS\LTI\ToolProvider\Tool::$idScope = self::ID_SCOPE_ID_ONLY

Scope to use for user IDs.

Definition at line 215 of file Tool.php.

◆ $initiateLoginUrl

string null ILIAS\LTI\ToolProvider\Tool::$initiateLoginUrl = null

Initiate Login request URL for Tool.

Definition at line 285 of file Tool.php.

Referenced by ILIAS\LTI\ToolProvider\Tool\fromInitiateLoginUrl().

◆ $LTI_CONSUMER_SETTING_NAMES

array ILIAS\LTI\ToolProvider\Tool::$LTI_CONSUMER_SETTING_NAMES = array('custom_tc_profile_url', 'custom_system_setting_url', 'custom_oauth2_access_token_url')

staticprivate

Names of LTI parameters to be retained in the consumer settings property.

Definition at line 90 of file Tool.php.

◆ $LTI_CONTEXT_SETTING_NAMES

array ILIAS\LTI\ToolProvider\Tool::$LTI_CONTEXT_SETTING_NAMES

staticprivate

Initial value:

= array('custom_context_setting_url',
                                                            'ext_ims_lis_memberships_id', 'ext_ims_lis_memberships_url',
                                                            'custom_context_memberships_url', 'custom_context_memberships_v2_url',
                                                            'custom_context_group_sets_url', 'custom_context_groups_url',
                                                            'custom_lineitems_url', 'custom_ags_scopes'
    )

Names of LTI parameters to be retained in the context settings property.

Definition at line 95 of file Tool.php.

◆ $LTI_RESOURCE_LINK_SETTING_NAMES

array ILIAS\LTI\ToolProvider\Tool::$LTI_RESOURCE_LINK_SETTING_NAMES

staticprivate

Initial value:

= array('lis_result_sourcedid', 'lis_outcome_service_url',
                                                                  'ext_ims_lis_basic_outcome_url', 'ext_ims_lis_resultvalue_sourcedids', 'ext_outcome_data_values_accepted',
                                                                  'ext_ims_lis_memberships_id', 'ext_ims_lis_memberships_url',
                                                                  'ext_ims_lti_tool_setting', 'ext_ims_lti_tool_setting_id', 'ext_ims_lti_tool_setting_url',
                                                                  'custom_link_setting_url', 'custom_link_memberships_url',
                                                                  'custom_lineitems_url', 'custom_lineitem_url', 'custom_ags_scopes',
                                                                  'custom_ap_acs_url'
    )

Names of LTI parameters to be retained in the resource link settings property.

Definition at line 105 of file Tool.php.

◆ $LTI_RETAIN_SETTING_NAMES

array ILIAS\LTI\ToolProvider\Tool::$LTI_RETAIN_SETTING_NAMES = array('custom_lineitem_url')

staticprivate

Names of LTI parameters to be retained even when not passed.

Definition at line 117 of file Tool.php.

◆ $mediaTypes

array null ILIAS\LTI\ToolProvider\Tool::$mediaTypes = null

protected

Media types accepted by the platform.

Definition at line 320 of file Tool.php.

Referenced by ILIAS\LTI\ToolProvider\Tool\authenticate().

◆ $message

string ILIAS\LTI\ToolProvider\Tool::$message = null

Message for last request processed.

Definition at line 229 of file Tool.php.

Referenced by ILIAS\LTI\ToolProvider\Tool\result().

◆ $MESSAGE_TYPES

array ILIAS\LTI\ToolProvider\Tool::$MESSAGE_TYPES

static

Initial value:

= array(
        'basic-lti-launch-request',
        'ConfigureLaunchRequest',
        'DashboardRequest',
        'ContentItemSelectionRequest',
        'ContentItemUpdateRequest',
        'ToolProxyRegistrationRequest',
        'LtiStartProctoring',
        'LtiEndAssessment'
    )

List of supported incoming message types.

Definition at line 76 of file Tool.php.

◆ $messageUrl

string null ILIAS\LTI\ToolProvider\Tool::$messageUrl = null

Message URL for Tool.

Definition at line 278 of file Tool.php.

◆ $optionalServices

array null ILIAS\LTI\ToolProvider\Tool::$optionalServices = null

Optional services used by Tool.

Definition at line 264 of file Tool.php.

◆ $output

string null ILIAS\LTI\ToolProvider\Tool::$output = null

protected

Default HTML to be displayed on a successful completion of the request.

Definition at line 348 of file Tool.php.

Referenced by ILIAS\LTI\ToolProvider\Tool\result().

◆ $platform

ilLTIPlatform ILIAS\LTI\ToolProvider\Tool::$platform

Platform object.

Definition at line 173 of file Tool.php.

Referenced by ILIAS\LTI\ToolProvider\Tool\getPlatformToRegister().

◆ $product

Item null ILIAS\LTI\ToolProvider\Tool::$product = null

Product details.

Definition at line 250 of file Tool.php.

◆ $redirectionUris

array null ILIAS\LTI\ToolProvider\Tool::$redirectionUris = null

Redirection URIs for Tool.

Definition at line 292 of file Tool.php.

◆ $redirectUrl

string null ILIAS\LTI\ToolProvider\Tool::$redirectUrl = null

protected

URL to redirect user to on successful completion of the request.

Definition at line 313 of file Tool.php.

◆ $requiredServices

array null ILIAS\LTI\ToolProvider\Tool::$requiredServices = null

Services required by Tool.

Definition at line 257 of file Tool.php.

◆ $resourceHandlers

array null ILIAS\LTI\ToolProvider\Tool::$resourceHandlers = null

Resource handlers for Tool.

Definition at line 271 of file Tool.php.

◆ $resourceLink

ResourceLink null ILIAS\LTI\ToolProvider\Tool::$resourceLink = null

Resource link object.

Definition at line 194 of file Tool.php.

Referenced by ILIAS\LTI\ToolProvider\Tool\checkForShare().

◆ $returnUrl

string null ILIAS\LTI\ToolProvider\Tool::$returnUrl = null

Return URL provided by platform.

Definition at line 180 of file Tool.php.

Referenced by ILIAS\LTI\ToolProvider\Tool\result().

◆ $userResult

UserResult null ILIAS\LTI\ToolProvider\Tool::$userResult = null

UserResult object.

Definition at line 187 of file Tool.php.

◆ $vendor

Item null ILIAS\LTI\ToolProvider\Tool::$vendor = null

Vendor details.

Definition at line 243 of file Tool.php.

◆ CONNECTION_ERROR_MESSAGE

const ILIAS\LTI\ToolProvider\Tool::CONNECTION_ERROR_MESSAGE = 'Sorry, there was an error connecting you to the application.'

Default connection error message.

Definition at line 46 of file Tool.php.

◆ ID_SCOPE_CONTEXT

const ILIAS\LTI\ToolProvider\Tool::ID_SCOPE_CONTEXT = 2

Prefix the ID with the consumer key and context ID.

Definition at line 61 of file Tool.php.

Referenced by ILIAS\LTI\ToolProvider\UserResult\getId().

◆ ID_SCOPE_GLOBAL

const ILIAS\LTI\ToolProvider\Tool::ID_SCOPE_GLOBAL = 1

Prefix an ID with the consumer key.

Definition at line 56 of file Tool.php.

Referenced by ILIAS\LTI\ToolProvider\UserResult\getId().

◆ ID_SCOPE_ID_ONLY

const ILIAS\LTI\ToolProvider\Tool::ID_SCOPE_ID_ONLY = 0

Use ID value only.

Definition at line 51 of file Tool.php.

Referenced by ILIAS\LTI\ToolProvider\UserResult\getId(), ilLTIPlatform\initialize(), and ILIAS\LTI\ToolProvider\Platform\initialize().

◆ ID_SCOPE_RESOURCE

const ILIAS\LTI\ToolProvider\Tool::ID_SCOPE_RESOURCE = 3

Prefix the ID with the consumer key and resource ID.

Definition at line 66 of file Tool.php.

Referenced by ILIAS\LTI\ToolProvider\UserResult\getId(), ILIAS\LTI\ToolProvider\Service\Membership\getMembers(), and ILIAS\LTI\ToolProvider\ResourceLink\getMemberships().

◆ ID_SCOPE_SEPARATOR

const ILIAS\LTI\ToolProvider\Tool::ID_SCOPE_SEPARATOR = ':'

Character used to separate each element of an ID.

Definition at line 71 of file Tool.php.

Referenced by ILIAS\LTI\ToolProvider\UserResult\getId().

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

Services/LTI/src/ToolProvider/Tool.php

Public Member Functions

Static Public Member Functions

Data Fields

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ authenticate()

◆ checkForShare()

◆ checkValue()

◆ delete()

◆ findService()

◆ fromConsumerKey()

◆ fromInitiateLoginUrl()

◆ fromRecordId()

◆ getConfiguration()

◆ getMessageParameters()

◆ getPlatformConfiguration()

◆ getPlatforms()

◆ getPlatformToRegister()

◆ getRegistrationResponsePage()

◆ handleRequest()

◆ initialize()

◆ onConfigure()

◆ onContentItem()

◆ onContentItemUpdate()

◆ onDashboard()

◆ onError()

◆ onInitiateLogin()

◆ onLaunch()

◆ onLtiEndAssessment()

◆ onLtiStartProctoring()

◆ onRegister()

◆ onRegistration()

◆ result()

◆ save()

◆ sendAuthenticationRequest()

◆ sendRegistration()

◆ sendRelaunchRequest()

◆ setParameterConstraint()

Field Documentation

◆ $allowSharing

◆ $authenticateUsingGet

◆ $baseUrl

◆ $constraints

◆ $contentTypes

◆ $context

◆ $CUSTOM_SUBSTITUTION_VARIABLES

◆ $defaultEmail

◆ $defaultTool

◆ $documentTargets

◆ $errorOutput

◆ $fileTypes

◆ $idScope

◆ $initiateLoginUrl

◆ $LTI_CONSUMER_SETTING_NAMES

◆ $LTI_CONTEXT_SETTING_NAMES

◆ $LTI_RESOURCE_LINK_SETTING_NAMES

◆ $LTI_RETAIN_SETTING_NAMES

◆ $mediaTypes

◆ $message

◆ $MESSAGE_TYPES

◆ $messageUrl

◆ $optionalServices

◆ $output

◆ $platform

◆ $product

◆ $redirectionUris

◆ $redirectUrl

◆ $requiredServices

◆ $resourceHandlers

◆ $resourceLink

◆ $returnUrl

◆ $userResult