ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
Public Member Functions | Static Public Member Functions | Protected Member Functions
ilLTIConsumerGradeServiceScores Class Reference
+ Inheritance diagram for ilLTIConsumerGradeServiceScores:
+ Collaboration diagram for ilLTIConsumerGradeServiceScores:

Public Member Functions

 __construct (ilLTIConsumerServiceBase $service)
 Class constructor. More...
 
 execute (ilLTIConsumerServiceResponse $response)
 Execute the request for this resource. More...
 
- Public Member Functions inherited from ilLTIConsumerResourceBase
 __construct (ilLTIConsumerServiceBase $service)
 Class constructor. More...
 
 getTemplate ()
 Get the resource template. More...
 
 getFormats ()
 Get the resource media types. More...
 
 getMethods ()
 Get the resource methods. More...
 
 getService ()
 Get the resource's service. More...
 
 checkTool (array $scopes=array())
 Check to make sure the request is valid. More...
 

Static Public Member Functions

static validate_iso8601_date (string $date)
 

Protected Member Functions

 checkScore (string $requestData, int $objId)
 
- Protected Member Functions inherited from ilLTIConsumerResourceBase
 parseTemplate ()
 Parse the template for variables. More...
 

Additional Inherited Members

- Data Fields inherited from ilLTIConsumerResourceBase
const HTTP_POST = 'POST'
 HTTP Post method. More...
 
const HTTP_GET = 'GET'
 HTTP Get method. More...
 
const HTTP_PUT = 'PUT'
 HTTP Put method. More...
 
const HTTP_DELETE = 'DELETE'
 HTTP Delete method. More...
 
- Protected Attributes inherited from ilLTIConsumerResourceBase
string $type
 Type for this resource. More...
 
string $id
 ID for this resource. More...
 
string $template
 Template for this resource. More...
 
array $variables
 Custom parameter substitution variables associated with this resource. More...
 
array $formats
 Media types supported by this resource. More...
 
array $methods
 HTTP actions supported by this resource. More...
 
array $params
 Template variables parsed from the resource template. More...
 

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilLTIConsumerGradeServiceScores::__construct ( ilLTIConsumerServiceBase  $service)

Class constructor.

Service instance

Reimplemented from ilLTIConsumerResourceBase.

Definition at line 32 of file class.ilLTIConsumerGradeServiceScores.php.

33 {
34 parent::__construct($service);
35 $this->id = 'Score.collection';
36 $this->template = '/{context_id}/lineitems/{item_id}/lineitem/scores';
37 $this->variables[] = 'Scores.url';
38 $this->formats[] = 'application/vnd.ims.lis.v1.scorecontainer+json';
39 $this->formats[] = 'application/vnd.ims.lis.v1.score+json';
40 $this->methods[] = 'POST';
41 }
ilLTIConsumerResourceBase\$service
ilLTIConsumerServiceBase $service
Service associated with this resource.
Definition: class.ilLTIConsumerResourceBase.php:45
ILIAS\GlobalScreen\Provider\__construct
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc
Definition: PluginProviderHelper.php:38

References ilLTIConsumerResourceBase\$service, and ILIAS\GlobalScreen\Provider\__construct().

+ Here is the call graph for this function:

Member Function Documentation

◆ checkScore()

ilLTIConsumerGradeServiceScores::checkScore ( string  $requestData,
int  $objId 
)
protected

Definition at line 82 of file class.ilLTIConsumerGradeServiceScores.php.

82 : int
83 {
84 global $DIC; /* @var \ILIAS\DI\Container $DIC */
85
86 $logger = $DIC->logger()->root();
87
88 $logger->info('checkScore');
89 $score = json_decode($requestData);
90 //prüfe Userid
91 $userId = ilCmiXapiUser::getUsrIdForObjectAndUsrIdent($objId, $score->userId);
92 if ($userId == null) {
93 ilObjLTIConsumer::getLogger()->info('User not available');
94 throw new Exception('User not available', 404);
95 return 404;
96 }
97
98 if (empty($score) ||
99 !isset($score->userId) ||
100 !isset($score->gradingProgress) ||
101 !isset($score->activityProgress) ||
102 !isset($score->timestamp) ||
103 isset($score->timestamp) && !self::validate_iso8601_date($score->timestamp) ||
104 (isset($score->scoreGiven) && !is_numeric($score->scoreGiven)) ||
105 (isset($score->scoreGiven) && !isset($score->scoreMaximum)) ||
106 (isset($score->scoreMaximum) && !is_numeric($score->scoreMaximum))
107 ) {
108 ilObjLTIConsumer::getLogger()->info('Incorrect score received');
109 ilObjLTIConsumer::getLogger()->dump($score);
110 throw new Exception('Incorrect score received', 400);
111 return 400;
112 }
113 //Achtung Ggfs. Timestamp prüfen falls schon was ankam
114 if (!isset($score->scoreMaximum)) {
115 $score->scoreMaximum = 1;
116 }
117 if (isset($score->scoreGiven)) {
118 if ($score->gradingProgress != 'FullyGraded') {
119 $score->scoreGiven = null;
120 }
121 }
122 $result = (float) $score->scoreGiven / (float) $score->scoreMaximum;
123 ilObjLTIConsumer::getLogger()->info("result: " . $result);
124
125 $ltiObjRes = new ilLTIConsumerResultService();
126
127 $ltiObjRes->readProperties($objId);
128 // check the object status
129 if (!$ltiObjRes->isAvailable()) {
130 throw new Exception('Tool for Object not available', 404);
131 return 404;
132 }
133
134 if ($result >= $ltiObjRes->getMasteryScore()) {
135 $lp_status = ilLPStatus::LP_STATUS_COMPLETED_NUM;
136 } else {
137 $lp_status = ilLPStatus::LP_STATUS_IN_PROGRESS_NUM;
138 }
139 $lp_percentage = (int) round(100 * $result);
140
141 $consRes = ilLTIConsumerResult::getByKeys($objId, $userId, false);
142 if (empty($consRes)) {
143 ilObjLTIConsumer::getLogger()->info("lti_consumer_results_id not found!");
144 // throw new Exception('lti_consumer_results_id not found!', 404);
145 // return 404;
146 }
147 if (!isset($consRes->id)) {
148 $consRes->id = $DIC->database()->nextId('lti_consumer_results');
149 }
150 $DIC->database()->replace(
151 'lti_consumer_results',
152 array(
153 'id' => array('integer', $consRes->id)
154 ),
155 array(
156 'obj_id' => array('integer', $objId),
157 'usr_id' => array('integer', $userId),
158 'result' => array('float', $result)
159 )
160 );
161
162 ilLPStatus::writeStatus($objId, $userId, $lp_status, $lp_percentage, true);
163
164 $ltiTimestamp = DateTimeImmutable::createFromFormat(DateTimeInterface::RFC3339_EXTENDED, $score->timestamp);
165 if (!$ltiTimestamp) { //moodle 4
166 $ltiTimestamp = DateTimeImmutable::createFromFormat(DateTimeInterface::ISO8601, $score->timestamp);
167 }
168 if (!$ltiTimestamp) { //for example nothing
169 $ltiTimestamp = new DateTime('now');
170 }
171 $gradeValues = [
172 'id' => array('integer', $DIC->database()->nextId('lti_consumer_grades')),
173 'obj_id' => array('integer', $objId),
174 'usr_id' => array('integer', $userId),
175 'score_given' => array('float', $score->scoreGiven),
176 'score_maximum' => array('float', $score->scoreMaximum),
177 'activity_progress' => array('text', $score->activityProgress),
178 'grading_progress' => array('text', $score->gradingProgress),
179 'lti_timestamp' => array('timestamp',$ltiTimestamp->format("Y-m-d H:i:s")),
180 'stored' => array('timestamp', date("Y-m-d H:i:s"))
181 ];
182 $DIC->database()->insert('lti_consumer_grades', $gradeValues);
183
184
185
186 return 200;
187 }
ilCmiXapiUser\getUsrIdForObjectAndUsrIdent
static getUsrIdForObjectAndUsrIdent(int $objId, string $userIdent)
Definition: class.ilCmiXapiUser.php:606
ilLPStatus\writeStatus
static writeStatus(int $a_obj_id, int $a_user_id, int $a_status, int $a_percentage=0, bool $a_force_per=false, ?int &$a_old_status=self::LP_STATUS_NOT_ATTEMPTED_NUM)
Write status for user and object.
Definition: class.ilLPStatus.php:436
ilLPStatus\LP_STATUS_COMPLETED_NUM
const LP_STATUS_COMPLETED_NUM
Definition: class.ilLPStatus.php:44
ilLPStatus\LP_STATUS_IN_PROGRESS_NUM
const LP_STATUS_IN_PROGRESS_NUM
Definition: class.ilLPStatus.php:43
ilLTIConsumerResult\getByKeys
static getByKeys(int $a_obj_id, int $a_usr_id, ?bool $a_create=false)
Get a result by object and user key.
Definition: class.ilLTIConsumerResult.php:75
$DIC
global $DIC
Definition: shib_login.php:26
$objId
$objId
Definition: xapitoken.php:57

References $DIC, $objId, ilLTIConsumerResult\getByKeys(), ilObjLTIConsumer\getLogger(), ilCmiXapiUser\getUsrIdForObjectAndUsrIdent(), ILIAS\Repository\int(), ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, and ilLPStatus\writeStatus().

Referenced by execute().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ execute()

ilLTIConsumerGradeServiceScores::execute ( ilLTIConsumerServiceResponse  $response)

Execute the request for this resource.

Definition at line 46 of file class.ilLTIConsumerGradeServiceScores.php.

46 : void
47 {
48 $params = $this->parseTemplate();
49 $contextId = $params['context_id'];
50 $itemId = $params['item_id'];
51
52 ilObjLTIConsumer::getLogger()->info("contextId: " . $contextId);
53 ilObjLTIConsumer::getLogger()->info("objId: " . $itemId);
54 ilObjLTIConsumer::getLogger()->info("request data: " . $response->getRequestData());
55
56 // GET is disabled by the moment, but we have the code ready
57 // for a future implementation.
58
59 //$container = empty($contentType) || ($contentType === $this->formats[0]);
60
61 $typeid = 0;
62
63 $scope = ilLTIConsumerGradeService::SCOPE_GRADESERVICE_SCORE;
64 try {
65 $token = $this->checkTool(array($scope));
66 if (is_null($token)) {
67 throw new Exception('invalid request', 401);
68 }
69
70 // Bug in Moodle as tool provider, should accept only "204 No Content" but schedules grade sync task will notices a failed status if not exactly 200
71 // see: http://www.imsglobal.org/spec/lti-ags/v2p0#score-service-scope-and-allowed-http-methods
72 //$response->setCode(204); // correct
73 $returnCode = 200;
74 $returnCode = $this->checkScore($response->getRequestData(), (int) $itemId);
75 $response->setCode($returnCode); // not really correct
76 } catch (Exception $e) {
77 $response->setCode($e->getCode());
78 $response->setReason($e->getMessage());
79 }
80 }
ilLTIConsumerGradeService\SCOPE_GRADESERVICE_SCORE
const SCOPE_GRADESERVICE_SCORE
Scope for access to Score service.
Definition: class.ilLTIConsumerGradeService.php:48
ilLTIConsumerResourceBase\$params
array $params
Template variables parsed from the resource template.
Definition: class.ilLTIConsumerResourceBase.php:66
ilLTIConsumerResourceBase\checkTool
checkTool(array $scopes=array())
Check to make sure the request is valid.
Definition: class.ilLTIConsumerResourceBase.php:147
ilLTIConsumerResourceBase\parseTemplate
parseTemplate()
Parse the template for variables.
Definition: class.ilLTIConsumerResourceBase.php:121
$scope
$scope
Definition: ltiregstart.php:51
$token
$token
Definition: xapitoken.php:70
$response
$response
Definition: xapitoken.php:93

References Vendor\Package\$e, ilLTIConsumerResourceBase\$params, $response, $scope, $token, checkScore(), ilLTIConsumerResourceBase\checkTool(), ilObjLTIConsumer\getLogger(), ilLTIConsumerServiceResponse\getRequestData(), ilLTIConsumerResourceBase\parseTemplate(), and ilLTIConsumerGradeService\SCOPE_GRADESERVICE_SCORE.

+ Here is the call graph for this function:

◆ validate_iso8601_date()

static ilLTIConsumerGradeServiceScores::validate_iso8601_date ( string  $date)
static

Definition at line 189 of file class.ilLTIConsumerGradeServiceScores.php.

189 : bool
190 {
191 if (preg_match('/^([\+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])' .
192 '(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))' .
193 '([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24\:?00)([\.,]\d+(?!:))?)?(\17[0-5]\d([\.,]\d+)?)' .
194 '?([zZ]|([\+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?$/', $date) > 0) {
195 return true;
196 }
197 return false;
198 }
The documentation for this class was generated from the following file: