mirrored from git://git.moodle.org/moodle.git
/
servicelib.php
261 lines (210 loc) · 8.36 KB
/
servicelib.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Utility code for LTI service handling.
*
* @package mod_lti
* @copyright Copyright (c) 2011 Moodlerooms Inc. (http://www.moodlerooms.com)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @author Chris Scribner
*/
defined('MOODLE_INTERNAL') || die;
require_once($CFG->dirroot.'/mod/lti/OAuthBody.php');
// TODO: Switch to core oauthlib once implemented - MDL-30149
use moodle\mod\lti as lti;
define('LTI_ITEM_TYPE', 'mod');
define('LTI_ITEM_MODULE', 'lti');
define('LTI_SOURCE', 'mod/lti');
function lti_get_response_xml($codemajor, $description, $messageref, $messagetype) {
$xml = new SimpleXMLElement('<?xml version="1.0" encoding="UTF-8"?><imsx_POXEnvelopeResponse />');
$xml->addAttribute('xmlns', 'http://www.imsglobal.org/services/ltiv1p1/xsd/imsoms_v1p0');
$headerinfo = $xml->addChild('imsx_POXHeader')->addChild('imsx_POXResponseHeaderInfo');
$headerinfo->addChild('imsx_version', 'V1.0');
$headerinfo->addChild('imsx_messageIdentifier', (string)mt_rand());
$statusinfo = $headerinfo->addChild('imsx_statusInfo');
$statusinfo->addchild('imsx_codeMajor', $codemajor);
$statusinfo->addChild('imsx_severity', 'status');
$statusinfo->addChild('imsx_description', $description);
$statusinfo->addChild('imsx_messageRefIdentifier', $messageref);
$incomingtype = str_replace('Response','Request', $messagetype);
$statusinfo->addChild('imsx_operationRefIdentifier', $incomingtype);
$xml->addChild('imsx_POXBody')->addChild($messagetype);
return $xml;
}
function lti_parse_message_id($xml) {
$node = $xml->imsx_POXHeader->imsx_POXRequestHeaderInfo->imsx_messageIdentifier;
$messageid = (string)$node;
return $messageid;
}
function lti_parse_grade_replace_message($xml) {
$node = $xml->imsx_POXBody->replaceResultRequest->resultRecord->sourcedGUID->sourcedId;
$resultjson = json_decode((string)$node);
$node = $xml->imsx_POXBody->replaceResultRequest->resultRecord->result->resultScore->textString;
$score = (string) $node;
if ( ! is_numeric($score) ) {
throw new Exception('Score must be numeric');
}
$grade = floatval($score);
if ( $grade < 0.0 || $grade > 1.0 ) {
throw new Exception('Score not between 0.0 and 1.0');
}
$parsed = new stdClass();
$parsed->gradeval = $grade * 100;
$parsed->instanceid = $resultjson->data->instanceid;
$parsed->userid = $resultjson->data->userid;
$parsed->launchid = $resultjson->data->launchid;
$parsed->sourcedidhash = $resultjson->hash;
$parsed->messageid = lti_parse_message_id($xml);
return $parsed;
}
function lti_parse_grade_read_message($xml) {
$node = $xml->imsx_POXBody->readResultRequest->resultRecord->sourcedGUID->sourcedId;
$resultjson = json_decode((string)$node);
$parsed = new stdClass();
$parsed->instanceid = $resultjson->data->instanceid;
$parsed->userid = $resultjson->data->userid;
$parsed->launchid = $resultjson->data->launchid;
$parsed->sourcedidhash = $resultjson->hash;
$parsed->messageid = lti_parse_message_id($xml);
return $parsed;
}
function lti_parse_grade_delete_message($xml) {
$node = $xml->imsx_POXBody->deleteResultRequest->resultRecord->sourcedGUID->sourcedId;
$resultjson = json_decode((string)$node);
$parsed = new stdClass();
$parsed->instanceid = $resultjson->data->instanceid;
$parsed->userid = $resultjson->data->userid;
$parsed->launchid = $resultjson->data->launchid;
$parsed->sourcedidhash = $resultjson->hash;
$parsed->messageid = lti_parse_message_id($xml);
return $parsed;
}
function lti_update_grade($ltiinstance, $userid, $launchid, $gradeval) {
global $CFG, $DB;
require_once($CFG->libdir . '/gradelib.php');
$params = array();
$params['itemname'] = $ltiinstance->name;
$grade = new stdClass();
$grade->userid = $userid;
$grade->rawgrade = $gradeval;
$status = grade_update(LTI_SOURCE, $ltiinstance->course, LTI_ITEM_TYPE, LTI_ITEM_MODULE, $ltiinstance->id, 0, $grade, $params);
$record = $DB->get_record('lti_submission', array('ltiid' => $ltiinstance->id, 'userid' => $userid, 'launchid' => $launchid), 'id');
if ($record) {
$id = $record->id;
} else {
$id = null;
}
if (!empty($id)) {
$DB->update_record('lti_submission', array(
'id' => $id,
'dateupdated' => time(),
'gradepercent' => $gradeval,
'state' => 2
));
} else {
$DB->insert_record('lti_submission', array(
'ltiid' => $ltiinstance->id,
'userid' => $userid,
'datesubmitted' => time(),
'dateupdated' => time(),
'gradepercent' => $gradeval,
'originalgrade' => $gradeval,
'launchid' => $launchid,
'state' => 1
));
}
return $status == GRADE_UPDATE_OK;
}
function lti_read_grade($ltiinstance, $userid) {
global $CFG;
require_once($CFG->libdir . '/gradelib.php');
$grades = grade_get_grades($ltiinstance->course, LTI_ITEM_TYPE, LTI_ITEM_MODULE, $ltiinstance->id, $userid);
if (isset($grades) && isset($grades->items[0]) && is_array($grades->items[0]->grades)) {
foreach ($grades->items[0]->grades as $agrade) {
$grade = $agrade->grade;
$grade = $grade / 100.0;
break;
}
}
if (isset($grade)) {
return $grade;
}
}
function lti_delete_grade($ltiinstance, $userid) {
global $CFG;
require_once($CFG->libdir . '/gradelib.php');
$grade = new stdClass();
$grade->userid = $userid;
$grade->rawgrade = null;
$status = grade_update(LTI_SOURCE, $ltiinstance->course, LTI_ITEM_TYPE, LTI_ITEM_MODULE, $ltiinstance->id, 0, $grade, array('deleted'=>1));
return $status == GRADE_UPDATE_OK;
}
function lti_verify_message($key, $sharedsecrets, $body, $headers = null) {
foreach ($sharedsecrets as $secret) {
$signaturefailed = false;
try {
// TODO: Switch to core oauthlib once implemented - MDL-30149
lti\handleOAuthBodyPOST($key, $secret, $body, $headers);
} catch (Exception $e) {
$signaturefailed = true;
}
if (!$signaturefailed) {
return $secret;//Return the secret used to sign the message)
}
}
return false;
}
function lti_verify_sourcedid($ltiinstance, $parsed) {
$sourceid = lti_build_sourcedid($parsed->instanceid, $parsed->userid, $parsed->launchid, $ltiinstance->servicesalt);
if ($sourceid->hash != $parsed->sourcedidhash) {
throw new Exception('SourcedId hash not valid');
}
}
/**
* Extend the LTI services through the ltisource plugins
*
* @param stdClass $data LTI request data
* @return bool
* @throws coding_exception
*/
function lti_extend_lti_services($data) {
$plugins = get_plugin_list_with_function('ltisource', $data->messagetype);
if (!empty($plugins)) {
try {
// There can only be one
if (count($plugins) > 1) {
throw new coding_exception('More than one ltisource plugin handler found');
}
$callback = current($plugins);
call_user_func($callback, $data);
} catch (moodle_exception $e) {
$error = $e->getMessage();
if (debugging('', DEBUG_DEVELOPER)) {
$error .= ' '.format_backtrace(get_exception_info($e)->backtrace);
}
$responsexml = lti_get_response_xml(
'failure',
$error,
$data->messageid,
$data->messagetype
);
header('HTTP/1.0 400 bad request');
echo $responsexml->asXML();
}
return true;
}
return false;
}