Merge branch 'MDL-30326' of git://github.com/scriby/moodle
[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  * Utility code for LTI service handling.
19  *
20  * @package    mod
21  * @subpackage lti
22  * @copyright  Copyright (c) 2011 Moodlerooms Inc. (http://www.moodlerooms.com)
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  * @author     Chris Scribner
25  */
27 defined('MOODLE_INTERNAL') || die;
29 require_once($CFG->dirroot.'/mod/lti/OAuthBody.php');
31 // TODO: Switch to core oauthlib once implemented - MDL-30149
32 use moodle\mod\lti as lti;
34 define('LTI_ITEM_TYPE', 'mod');
35 define('LTI_ITEM_MODULE', 'lti');
36 define('LTI_SOURCE', 'mod/lti');
38 function lti_get_response_xml($codemajor, $description, $messageref, $messagetype) {
39     $xml = new SimpleXMLElement('<?xml version="1.0" encoding="UTF-8"?><imsx_POXEnvelopeResponse />');
40     $xml->addAttribute('xmlns', 'http://www.imsglobal.org/lis/oms1p0/pox');
42     $headerinfo = $xml->addChild('imsx_POXHeader')->addChild('imsx_POXResponseHeaderInfo');
44     $headerinfo->addChild('imsx_version', 'V1.0');
45     $headerinfo->addChild('imsx_messageIdentifier', (string)mt_rand());
47     $statusinfo = $headerinfo->addChild('imsx_statusInfo');
48     $statusinfo->addchild('imsx_codeMajor', $codemajor);
49     $statusinfo->addChild('imsx_severity', 'status');
50     $statusinfo->addChild('imsx_description', $description);
51     $statusinfo->addChild('imsx_messageRefIdentifier', $messageref);
53     $xml->addChild('imsx_POXBody')->addChild($messagetype);
55     return $xml;
56 }
58 function lti_parse_message_id($xml) {
59     $node = $xml->imsx_POXHeader->imsx_POXRequestHeaderInfo->imsx_messageIdentifier;
60     $messageid = (string)$node;
62     return $messageid;
63 }
65 function lti_parse_grade_replace_message($xml) {
66     $node = $xml->imsx_POXBody->replaceResultRequest->resultRecord->sourcedGUID->sourcedId;
67     $resultjson = json_decode((string)$node);
69     $node = $xml->imsx_POXBody->replaceResultRequest->resultRecord->result->resultScore->textString;
70     $grade = floatval((string)$node);
72     $parsed = new stdClass();
73     $parsed->gradeval = $grade * 100;
75     $parsed->instanceid = $resultjson->data->instanceid;
76     $parsed->userid = $resultjson->data->userid;
77     $parsed->launchid = $resultjson->data->launchid;
78     $parsed->sourcedidhash = $resultjson->hash;
80     $parsed->messageid = lti_parse_message_id($xml);
82     return $parsed;
83 }
85 function lti_parse_grade_read_message($xml) {
86     $node = $xml->imsx_POXBody->readResultRequest->resultRecord->sourcedGUID->sourcedId;
87     $resultjson = json_decode((string)$node);
89     $parsed = new stdClass();
90     $parsed->instanceid = $resultjson->data->instanceid;
91     $parsed->userid = $resultjson->data->userid;
92     $parsed->launchid = $resultjson->data->launchid;
93     $parsed->sourcedidhash = $resultjson->hash;
95     $parsed->messageid = lti_parse_message_id($xml);
97     return $parsed;
98 }
100 function lti_parse_grade_delete_message($xml) {
101     $node = $xml->imsx_POXBody->deleteResultRequest->resultRecord->sourcedGUID->sourcedId;
102     $resultjson = json_decode((string)$node);
104     $parsed = new stdClass();
105     $parsed->instanceid = $resultjson->data->instanceid;
106     $parsed->userid = $resultjson->data->userid;
107     $parsed->launchid = $resultjson->data->launchid;
108     $parsed->sourcedidhash = $resultjson->hash;
110     $parsed->messageid = lti_parse_message_id($xml);
112     return $parsed;
115 function lti_update_grade($ltiinstance, $userid, $launchid, $gradeval) {
116     global $CFG, $DB;
117     require_once($CFG->libdir . '/gradelib.php');
119     $params = array();
120     $params['itemname'] = $ltiinstance->name;
122     $grade = new stdClass();
123     $grade->userid   = $userid;
124     $grade->rawgrade = $gradeval;
126     $status = grade_update(LTI_SOURCE, $ltiinstance->course, LTI_ITEM_TYPE, LTI_ITEM_MODULE, $ltiinstance->id, 0, $grade, $params);
128     $record = $DB->get_record('lti_submission', array('ltiid' => $ltiinstance->id, 'userid' => $userid, 'launchid' => $launchid), 'id');
129     if ($record) {
130         $id = $record->id;
131     } else {
132         $id = null;
133     }
135     if (!empty($id)) {
136         $DB->update_record('lti_submission', array(
137             'id' => $id,
138             'dateupdated' => time(),
139             'gradepercent' => $gradeval,
140             'state' => 2
141         ));
142     } else {
143         $DB->insert_record('lti_submission', array(
144             'ltiid' => $ltiinstance->id,
145             'userid' => $userid,
146             'datesubmitted' => time(),
147             'dateupdated' => time(),
148             'gradepercent' => $gradeval,
149             'originalgrade' => $gradeval,
150             'launchid' => $launchid,
151             'state' => 1
152         ));
153     }
155     return $status == GRADE_UPDATE_OK;
158 function lti_read_grade($ltiinstance, $userid) {
159     global $CFG;
160     require_once($CFG->libdir . '/gradelib.php');
162     $grades = grade_get_grades($ltiinstance->course, LTI_ITEM_TYPE, LTI_ITEM_MODULE, $ltiinstance->id, $userid);
164     if (isset($grades) && isset($grades->items[0]) && is_array($grades->items[0]->grades)) {
165         foreach ($grades->items[0]->grades as $agrade) {
166             $grade = $agrade->grade;
167             break;
168         }
169     }
171     if (isset($grade)) {
172         return $grade;
173     }
176 function lti_delete_grade($ltiinstance, $userid) {
177     global $CFG;
178     require_once($CFG->libdir . '/gradelib.php');
180     $grade = new stdClass();
181     $grade->userid   = $userid;
182     $grade->rawgrade = null;
184     $status = grade_update(LTI_SOURCE, $ltiinstance->course, LTI_ITEM_TYPE, LTI_ITEM_MODULE, $ltiinstance->id, 0, $grade, array('deleted'=>1));
186     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
189 function lti_verify_message($key, $sharedsecrets, $body, $headers = null) {
190     foreach ($sharedsecrets as $secret) {
191         $signaturefailed = false;
193         try {
194             // TODO: Switch to core oauthlib once implemented - MDL-30149
195             lti\handleOAuthBodyPOST($key, $secret, $body, $headers);
196         } catch (Exception $e) {
197             $signaturefailed = true;
198         }
200         if (!$signaturefailed) {
201             return $secret;//Return the secret used to sign the message)
202         }
203     }
205     return false;
208 function lti_verify_sourcedid($ltiinstance, $parsed) {
209     $sourceid = lti_build_sourcedid($parsed->instanceid, $parsed->userid, $parsed->launchid, $ltiinstance->servicesalt);
211     if ($sourceid->hash != $parsed->sourcedidhash) {
212         throw new Exception('SourcedId hash not valid');
213     }