969212ab4814288bbc41e470aebd8c2526f1128f
[moodle.git] / mod / lti / servicelib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * MRTODO: Brief description of this file
19  *
20  * @package    mod
21  * @subpackage lti
22  * @copyright  2011 onwards MRTODO
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die;
28 require_once($CFG->dirroot.'/mod/lti/OAuthBody.php');
30 // TODO: Switch to core oauthlib once implemented - MDL-30149
31 use moodle\mod\lti as lti;
33 define('LTI_ITEM_TYPE', 'mod');
34 define('LTI_ITEM_MODULE', 'lti');
35 define('LTI_SOURCE', 'mod/lti');
37 function lti_get_response_xml($codemajor, $description, $messageref, $messagetype) {
38     $xml = new SimpleXMLElement('<?xml version="1.0" encoding="UTF-8"?><imsx_POXEnvelopeResponse />');
39     $xml->addAttribute('xmlns', 'http://www.imsglobal.org/lis/oms1p0/pox');
41     $headerinfo = $xml->addChild('imsx_POXHeader')->addChild('imsx_POXResponseHeaderInfo');
43     $headerinfo->addChild('imsx_version', 'V1.0');
44     $headerinfo->addChild('imsx_messageIdentifier', (string)mt_rand());
46     $statusinfo = $headerinfo->addChild('imsx_statusInfo');
47     $statusinfo->addchild('imsx_codeMajor', $codemajor);
48     $statusinfo->addChild('imsx_severity', 'status');
49     $statusinfo->addChild('imsx_description', $description);
50     $statusinfo->addChild('imsx_messageRefIdentifier', $messageref);
52     $xml->addChild('imsx_POXBody')->addChild($messagetype);
54     return $xml;
55 }
57 function lti_parse_message_id($xml) {
58     $node = $xml->imsx_POXHeader->imsx_POXRequestHeaderInfo->imsx_messageIdentifier;
59     $messageid = (string)$node;
61     return $messageid;
62 }
64 function lti_parse_grade_replace_message($xml) {
65     $node = $xml->imsx_POXBody->replaceResultRequest->resultRecord->sourcedGUID->sourcedId;
66     $resultjson = json_decode((string)$node);
68     $node = $xml->imsx_POXBody->replaceResultRequest->resultRecord->result->resultScore->textString;
70     $score = (string) $node;
71     if ( ! is_numeric($score) ) {
72         throw new Exception('Score must be numeric');
73     }
74     $grade = floatval($score);
75     if ( $grade < 0.0 || $grade > 1.0 ) {
76         throw new Exception('Score not between 0.0 and 1.0');
77     }
79     $parsed = new stdClass();
80     $parsed->gradeval = $grade * 100;
82     $parsed->instanceid = $resultjson->data->instanceid;
83     $parsed->userid = $resultjson->data->userid;
84     $parsed->launchid = $resultjson->data->launchid;
85     $parsed->sourcedidhash = $resultjson->hash;
87     $parsed->messageid = lti_parse_message_id($xml);
89     return $parsed;
90 }
92 function lti_parse_grade_read_message($xml) {
93     $node = $xml->imsx_POXBody->readResultRequest->resultRecord->sourcedGUID->sourcedId;
94     $resultjson = json_decode((string)$node);
96     $parsed = new stdClass();
97     $parsed->instanceid = $resultjson->data->instanceid;
98     $parsed->userid = $resultjson->data->userid;
99     $parsed->launchid = $resultjson->data->launchid;
100     $parsed->sourcedidhash = $resultjson->hash;
102     $parsed->messageid = lti_parse_message_id($xml);
104     return $parsed;
107 function lti_parse_grade_delete_message($xml) {
108     $node = $xml->imsx_POXBody->deleteResultRequest->resultRecord->sourcedGUID->sourcedId;
109     $resultjson = json_decode((string)$node);
111     $parsed = new stdClass();
112     $parsed->instanceid = $resultjson->data->instanceid;
113     $parsed->userid = $resultjson->data->userid;
114     $parsed->launchid = $resultjson->data->launchid;
115     $parsed->sourcedidhash = $resultjson->hash;
117     $parsed->messageid = lti_parse_message_id($xml);
119     return $parsed;
122 function lti_update_grade($ltiinstance, $userid, $launchid, $gradeval) {
123     global $CFG, $DB;
124     require_once($CFG->libdir . '/gradelib.php');
126     $params = array();
127     $params['itemname'] = $ltiinstance->name;
129     $grade = new stdClass();
130     $grade->userid   = $userid;
131     $grade->rawgrade = $gradeval;
133     $status = grade_update(LTI_SOURCE, $ltiinstance->course, LTI_ITEM_TYPE, LTI_ITEM_MODULE, $ltiinstance->id, 0, $grade, $params);
135     $record = $DB->get_record('lti_submission', array('ltiid' => $ltiinstance->id, 'userid' => $userid, 'launchid' => $launchid), 'id');
136     if ($record) {
137         $id = $record->id;
138     } else {
139         $id = null;
140     }
142     if (!empty($id)) {
143         $DB->update_record('lti_submission', array(
144             'id' => $id,
145             'dateupdated' => time(),
146             'gradepercent' => $gradeval,
147             'state' => 2
148         ));
149     } else {
150         $DB->insert_record('lti_submission', array(
151             'ltiid' => $ltiinstance->id,
152             'userid' => $userid,
153             'datesubmitted' => time(),
154             'dateupdated' => time(),
155             'gradepercent' => $gradeval,
156             'originalgrade' => $gradeval,
157             'launchid' => $launchid,
158             'state' => 1
159         ));
160     }
162     return $status == GRADE_UPDATE_OK;
165 function lti_read_grade($ltiinstance, $userid) {
166     global $CFG;
167     require_once($CFG->libdir . '/gradelib.php');
169     $grades = grade_get_grades($ltiinstance->course, LTI_ITEM_TYPE, LTI_ITEM_MODULE, $ltiinstance->id, $userid);
171     if (isset($grades) && isset($grades->items[0]) && is_array($grades->items[0]->grades)) {
172         foreach ($grades->items[0]->grades as $agrade) {
173             $grade = $agrade->grade;
174             $grade = $grade / 100.0;
175             break;
176         }
177     }
179     if (isset($grade)) {
180         return $grade;
181     }
184 function lti_delete_grade($ltiinstance, $userid) {
185     global $CFG;
186     require_once($CFG->libdir . '/gradelib.php');
188     $grade = new stdClass();
189     $grade->userid   = $userid;
190     $grade->rawgrade = null;
192     $status = grade_update(LTI_SOURCE, $ltiinstance->course, LTI_ITEM_TYPE, LTI_ITEM_MODULE, $ltiinstance->id, 0, $grade, array('deleted'=>1));
194     return $status == GRADE_UPDATE_OK || $status == GRADE_UPDATE_ITEM_DELETED; //grade_update seems to return ok now, but could reasonably return deleted in the future
197 function lti_verify_message($key, $sharedsecrets, $body, $headers = null) {
198     foreach ($sharedsecrets as $secret) {
199         $signaturefailed = false;
201         try {
202             // TODO: Switch to core oauthlib once implemented - MDL-30149
203             lti\handleOAuthBodyPOST($key, $secret, $body, $headers);
204         } catch (Exception $e) {
205             $signaturefailed = true;
206         }
208         if (!$signaturefailed) {
209             return $secret;//Return the secret used to sign the message)
210         }
211     }
213     return false;
216 function lti_verify_sourcedid($ltiinstance, $parsed) {
217     $sourceid = lti_build_sourcedid($parsed->instanceid, $parsed->userid, $parsed->launchid, $ltiinstance->servicesalt);
219     if ($sourceid->hash != $parsed->sourcedidhash) {
220         throw new Exception('SourcedId hash not valid');
221     }