ilLTIConsumerResultService Class Reference

Collaboration diagram for ilLTIConsumerResultService:

Public Member Functions
	getMasteryScore ()
	setMasteryScore (float $mastery_score)
	getAvailability ()
	setAvailability (int $availability)
	isAvailable ()
	handleRequest ()
	Handle an incoming request from the LTI tool provider. More...
	readProperties (int $a_obj_id)
	Read the LTI Consumer object properties. More...

Protected Member Functions
	readResult (\SimpleXMLElement $request)
	Read a stored result. More...
	replaceResult (\SimpleXMLElement $request)
	Replace a stored result. More...
	deleteResult (\SimpleXMLElement $request)
	Delete a stored result. More...
	loadResponse ($a_name)
	Load the XML template for the response. More...
	respondUnsupported ()
	Send a response that the operation is not supported This depends on the status of the object. More...
	respondUnknown ()
	Send a "unknown operation" response. More...
	respondBadRequest (?string $message=null)
	Send a "bad request" response. More...
	respondUnauthorized (?string $message=null)
	Send an "unauthorized" response. More...
	updateLP ()

Protected Attributes
ilLTIConsumerResult	$result = null
int	$availability = 0
float	$mastery_score = 1
array	$fields = array()
string	$message_ref_id = ''
string	$operation = ''

Private Member Functions
	readFields (int $a_obj_id)
	Read the LTI Consumer object fields. More...
	checkSignature (string $a_key, string $a_secret)
	Check the reqest signature. More...

Detailed Description

Definition at line 25 of file class.ilLTIConsumerResultService.php.

Member Function Documentation

checkSignature()

ilLTIConsumerResultService::checkSignature ( string  $a_key, string  $a_secret  )

private

Check the reqest signature.

Returns

bool|Exception Exception or true

Definition at line 361 of file class.ilLTIConsumerResultService.php.

References Vendor\Package\$e, and $server.

Referenced by handleRequest().

    {
        $store = new TrivialOAuthDataStore();
        $store->add_consumer($a_key, $a_secret);

        $server = new \ILIAS\LTIOAuth\OAuthServer($store);
        $method = new \ILIAS\LTIOAuth\OAuthSignatureMethod_HMAC_SHA1();
        $server->add_signature_method($method);

        $request = \ILIAS\LTIOAuth\OAuthRequest::from_request();
        try {
            $server->verify_request($request);
        } catch (Exception $e) {
            return $e;
        }
        return true;
    }

Here is the caller graph for this function:

deleteResult()

ilLTIConsumerResultService::deleteResult ( \SimpleXMLElement  $request )

protected

Delete a stored result.

Definition at line 211 of file class.ilLTIConsumerResultService.php.

References $response, ILIAS\UI\examples\Symbol\Glyph\Header\header(), loadResponse(), ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, and ilLPStatus\writeStatus().

Referenced by handleRequest().

                                                               : void
    {
        $this->result->result = null;
        $this->result->save();

        $lp_status = ilLPStatus::LP_STATUS_IN_PROGRESS_NUM;
        $lp_percentage = 0;
        ilLPStatus::writeStatus($this->result->obj_id, $this->result->usr_id, $lp_status, $lp_percentage, true);

        $code = "success";
        $severity = "status";

        $response = $this->loadResponse('deleteResult.xml');
        $response = str_replace('{message_id}', md5((string) rand(0, 999_999_999)), $response);
        $response = str_replace('{message_ref_id}', $this->message_ref_id, $response);
        $response = str_replace('{operation}', $this->operation, $response);
        $response = str_replace('{code}', $code, $response);
        $response = str_replace('{severity}', $severity, $response);

        header('Content-type: application/xml');
        echo $response;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAvailability()

ilLTIConsumerResultService::getAvailability

(

)

Definition at line 67 of file class.ilLTIConsumerResultService.php.

References $availability.

                                     : int
    {
        return $this->availability;
    }

getMasteryScore()

ilLTIConsumerResultService::getMasteryScore

(

)

Definition at line 57 of file class.ilLTIConsumerResultService.php.

References $mastery_score.

Referenced by replaceResult().

                                     : float
    {
        return $this->mastery_score;
    }

Here is the caller graph for this function:

handleRequest()

ilLTIConsumerResultService::handleRequest

(

)

Handle an incoming request from the LTI tool provider.

Definition at line 88 of file class.ilLTIConsumerResultService.php.

References $token, checkSignature(), deleteResult(), ilLTIConsumerResult\getByKeys(), ilCmiXapiAuthToken\getInstanceByToken(), isAvailable(), readFields(), readProperties(), readResult(), replaceResult(), respondBadRequest(), respondUnauthorized(), respondUnknown(), respondUnsupported(), and updateLP().

                                   : void
    {
        try {
            // get the request as xml
            $xml = simplexml_load_file('php://input');
            $this->message_ref_id = (string) $xml->imsx_POXHeader->imsx_POXRequestHeaderInfo->imsx_messageIdentifier;
            //            $request = current($xml->imsx_POXBody->children());
            $request = $xml->imsx_POXBody->children()[0];
            $this->operation = str_replace('Request', '', $request->getName());

            $token = ilCmiXapiAuthToken::getInstanceByToken((string) $request->resultRecord->sourcedGUID->sourcedId);

            $this->result = ilLTIConsumerResult::getByKeys($token->getObjId(), $token->getUsrId(), false);
            if (empty($this->result)) {
                $this->respondUnauthorized("lti_consumer_results_id not found!");
                return;
            }


            // check the object status
            $this->readProperties($this->result->obj_id);

            if (!$this->isAvailable()) {
                $this->respondUnsupported();
                return;
            }

            // Verify the signature
            $this->readFields($this->result->obj_id);
            $result = $this->checkSignature($this->fields['KEY'], $this->fields['SECRET']);
            if ($result instanceof Exception) {
                $this->respondUnauthorized($result->getMessage());
                return;
            }

            // Dispatch the operation
            switch ($this->operation) {
                case 'readResult':
                    $this->readResult($request);
                    break;

                case 'replaceResult':
                    $this->replaceResult($request);
                    $this->updateLP();
                    break;

                case 'deleteResult':
                    $this->deleteResult($request);
                    $this->updateLP();
                    break;

                default:
                    $this->respondUnknown();
                    break;
            }
        } catch (Exception $exception) {
            $this->respondBadRequest($exception->getMessage());
        }
    }

Here is the call graph for this function:

isAvailable()

ilLTIConsumerResultService::isAvailable

(

)

Definition at line 77 of file class.ilLTIConsumerResultService.php.

Referenced by handleRequest().

                                 : bool
    {
        if ($this->availability == 0) {
            return false;
        }
        return true;
    }

Here is the caller graph for this function:

loadResponse()

ilLTIConsumerResultService::loadResponse (   $a_name )

protected

Load the XML template for the response.

Parameters

string

file name

Returns

string file content

Definition at line 240 of file class.ilLTIConsumerResultService.php.

Referenced by deleteResult(), readResult(), replaceResult(), respondUnknown(), and respondUnsupported().

                                            : string
    {
        return file_get_contents('./Modules/LTIConsumer/responses/' . $a_name);
    }

Here is the caller graph for this function:

readFields()

ilLTIConsumerResultService::readFields ( int  $a_obj_id )

private

Read the LTI Consumer object fields.

Definition at line 330 of file class.ilLTIConsumerResultService.php.

References $DIC, and $res.

Referenced by handleRequest().

                                              : void
    {
        global $DIC;

        $query = "
                        SELECT lti_ext_provider.provider_key, lti_ext_provider.provider_secret, lti_consumer_settings.launch_key, lti_consumer_settings.launch_secret
                        FROM lti_ext_provider, lti_consumer_settings
                        WHERE lti_ext_provider.id = lti_consumer_settings.provider_id
                        AND lti_consumer_settings.obj_id = %s
                ";

        $res = $DIC->database()->queryF($query, array('integer'), array($a_obj_id));

        while ($row = $DIC->database()->fetchAssoc($res)) {
            if (strlen($row["launch_key"]) > 0) {
                $this->fields["KEY"] = $row["launch_key"];
            } else {
                $this->fields["KEY"] = $row["provider_key"];
            }
            if (strlen($row["launch_key"]) > 0) {
                $this->fields["SECRET"] = $row["launch_secret"];
            } else {
                $this->fields["SECRET"] = $row["provider_secret"];
            }
        }
    }

Here is the caller graph for this function:

readProperties()

ilLTIConsumerResultService::readProperties

(

int

$a_obj_id

)

Read the LTI Consumer object properties.

Definition at line 307 of file class.ilLTIConsumerResultService.php.

References $DIC, $res, setAvailability(), and setMasteryScore().

Referenced by handleRequest().

                                                 : void
    {
        global $DIC;

        $query = "
                        SELECT lti_ext_provider.availability, lti_consumer_settings.mastery_score 
                        FROM lti_ext_provider, lti_consumer_settings
                        WHERE lti_ext_provider.id = lti_consumer_settings.provider_id
                        AND lti_consumer_settings.obj_id = %s
                ";

        $res = $DIC->database()->queryF($query, array('integer'), array($a_obj_id));

        if ($row = $DIC->database()->fetchAssoc($res)) {
            //$this->properties = $row;
            $this->setAvailability((int) $row['availability']);
            $this->setMasteryScore((float) $row['mastery_score']);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readResult()

ilLTIConsumerResultService::readResult ( \SimpleXMLElement  $request )

protected

Read a stored result.

Definition at line 151 of file class.ilLTIConsumerResultService.php.

References $response, ILIAS\UI\examples\Symbol\Glyph\Header\header(), and loadResponse().

Referenced by handleRequest().

                                                             : void
    {
        $response = $this->loadResponse('readResult.xml');
        $response = str_replace('{message_id}', md5((string) rand(0, 999_999_999)), $response);
        $response = str_replace('{message_ref_id}', $this->message_ref_id, $response);
        $response = str_replace('{operation}', $this->operation, $response);
        $response = str_replace('{result}', (string) $this->result->result, $response);

        header('Content-type: application/xml');
        echo $response;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

replaceResult()

ilLTIConsumerResultService::replaceResult ( \SimpleXMLElement  $request )

protected

Replace a stored result.

Definition at line 166 of file class.ilLTIConsumerResultService.php.

References $response, getMasteryScore(), ILIAS\UI\examples\Symbol\Glyph\Header\header(), if, ILIAS\Repository\int(), loadResponse(), ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, ilLTIConsumerResult\save(), and ilLPStatus\writeStatus().

Referenced by handleRequest().

                                                                : void
    {
        $result = (string) $request->resultRecord->result->resultScore->textString;
        if (!is_numeric($result)) {
            $code = "failure";
            $severity = "status";
            $description = "The result is not a number.";
        } elseif ($result < 0 or $result > 1) {
            $code = "failure";
            $severity = "status";
            $description = "The result is out of range from 0 to 1.";
        } else {
            $this->result->result = (float) $result;
            $this->result->save();

            if ($result >= $this->getMasteryScore()) {
                $lp_status = ilLPStatus::LP_STATUS_COMPLETED_NUM;
            } else {
                $lp_status = ilLPStatus::LP_STATUS_IN_PROGRESS_NUM;
            }
            $lp_percentage = (int) round(100 * $result);

            //            Mantis #37080
            ilLPStatus::writeStatus($this->result->obj_id, $this->result->usr_id, $lp_status, $lp_percentage, true);

            $code = "success";
            $severity = "status";
            $description = sprintf("Score for %s is now %s", $this->result->id, $this->result->result);
        }

        $response = $this->loadResponse('replaceResult.xml');
        $response = str_replace('{message_id}', md5((string) rand(0, 999_999_999)), $response);
        $response = str_replace('{message_ref_id}', $this->message_ref_id, $response);
        $response = str_replace('{operation}', $this->operation, $response);
        $response = str_replace('{code}', $code, $response);
        $response = str_replace('{severity}', $severity, $response);
        $response = str_replace('{description}', $description, $response);

        header('Content-type: application/xml');
        echo $response;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

respondBadRequest()

ilLTIConsumerResultService::respondBadRequest ( ?string  $message = null )

protected

Send a "bad request" response.

Definition at line 278 of file class.ilLTIConsumerResultService.php.

References $message, and ILIAS\UI\examples\Symbol\Glyph\Header\header().

Referenced by handleRequest().

                                                                 : void
    {
        header('HTTP/1.1 400 Bad Request');
        header('Content-type: text/plain');
        if (isset($message)) {
            echo $message;
        } else {
            echo 'This is not a well-formed LTI Basic Outcomes Service request.';
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

respondUnauthorized()

ilLTIConsumerResultService::respondUnauthorized ( ?string  $message = null )

protected

Send an "unauthorized" response.

Parameters

string | null

$message

response message

Definition at line 293 of file class.ilLTIConsumerResultService.php.

References $message, and ILIAS\UI\examples\Symbol\Glyph\Header\header().

Referenced by handleRequest().

                                                                   : void
    {
        header('HTTP/1.1 401 Unauthorized');
        header('Content-type: text/plain');
        if (isset($message)) {
            echo $message;
        } else {
            echo 'This request could not be authorized.';
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

respondUnknown()

ilLTIConsumerResultService::respondUnknown ( )

protected

Send a "unknown operation" response.

Definition at line 264 of file class.ilLTIConsumerResultService.php.

References $response, ILIAS\UI\examples\Symbol\Glyph\Header\header(), and loadResponse().

Referenced by handleRequest().

                                       : void
    {
        $response = $this->loadResponse('unknown.xml');
        $response = str_replace('{message_id}', md5((string) rand(0, 999_999_999)), $response);
        $response = str_replace('{message_ref_id}', $this->message_ref_id, $response);
        $response = str_replace('{operation}', $this->operation, $response);

        header('Content-type: application/xml');
        echo $response;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

respondUnsupported()

ilLTIConsumerResultService::respondUnsupported ( )

protected

Send a response that the operation is not supported This depends on the status of the object.

Definition at line 250 of file class.ilLTIConsumerResultService.php.

References $response, ILIAS\UI\examples\Symbol\Glyph\Header\header(), and loadResponse().

Referenced by handleRequest().

                                           : void
    {
        $response = $this->loadResponse('unsupported.xml');
        $response = str_replace('{message_id}', md5((string) rand(0, 999_999_999)), $response);
        $response = str_replace('{message_ref_id}', $this->message_ref_id, $response);
        $response = str_replace('{operation}', $this->operation, $response);

        header('Content-type: application/xml');
        echo $response;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setAvailability()

ilLTIConsumerResultService::setAvailability

(

int

$availability

)

Definition at line 72 of file class.ilLTIConsumerResultService.php.

References $availability.

Referenced by readProperties().

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

Here is the caller graph for this function:

setMasteryScore()

ilLTIConsumerResultService::setMasteryScore

(

float

$mastery_score

)

Definition at line 62 of file class.ilLTIConsumerResultService.php.

References $mastery_score.

Referenced by readProperties().

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

Here is the caller graph for this function:

updateLP()

ilLTIConsumerResultService::updateLP ( )

protected

Definition at line 379 of file class.ilLTIConsumerResultService.php.

References ilLPStatusWrapper\_updateStatus().

Referenced by handleRequest().

                                 : void
    {
        if (!($this->result instanceof ilLTIConsumerResult)) {
            return;
        }

        ilLPStatusWrapper::_updateStatus($this->result->getObjId(), $this->result->getUsrId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$availability

int ilLTIConsumerResultService::$availability = 0

protected

Definition at line 35 of file class.ilLTIConsumerResultService.php.

Referenced by getAvailability(), and setAvailability().

$fields

array ilLTIConsumerResultService::$fields = array()

protected

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

$mastery_score

float ilLTIConsumerResultService::$mastery_score = 1

protected

Definition at line 40 of file class.ilLTIConsumerResultService.php.

Referenced by getMasteryScore(), and setMasteryScore().

$message_ref_id

string ilLTIConsumerResultService::$message_ref_id = ''

protected

Definition at line 50 of file class.ilLTIConsumerResultService.php.

$operation

string ilLTIConsumerResultService::$operation = ''

protected

Definition at line 54 of file class.ilLTIConsumerResultService.php.

$result

ilLTIConsumerResult ilLTIConsumerResultService::$result = null

protected

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

---

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

• Modules/LTIConsumer/classes/class.ilLTIConsumerResultService.php