Merge branch 'MDL-30326' of git://github.com/scriby/moodle
[moodle.git] / mod / lti / service.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  * LTI web service endpoints
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 require_once(dirname(__FILE__) . "/../../config.php");
28 require_once($CFG->dirroot.'/mod/lti/locallib.php');
29 require_once($CFG->dirroot.'/mod/lti/servicelib.php');
31 // TODO: Switch to core oauthlib once implemented - MDL-30149
32 use moodle\mod\lti as lti;
34 $rawbody = file_get_contents("php://input");
36 foreach (getallheaders() as $name => $value) {
37     if ($name === 'Authorization') {
38         // TODO: Switch to core oauthlib once implemented - MDL-30149
39         $oauthparams = lti\OAuthUtil::split_header($value);
41         $consumerkey = $oauthparams['oauth_consumer_key'];
42         break;
43     }
44 }
46 if (empty($consumerkey)) {
47     throw new Exception('Consumer key is missing.');
48 }
50 $sharedsecret = lti_verify_message($consumerkey, lti_get_shared_secrets_by_key($consumerkey), $rawbody);
52 if ($sharedsecret === false) {
53     throw new Exception('Message signature not valid');
54 }
56 $xml = new SimpleXMLElement($rawbody);
58 $body = $xml->imsx_POXBody;
59 foreach ($body->children() as $child) {
60     $messagetype = $child->getName();
61 }
63 switch ($messagetype) {
64     case 'replaceResultRequest':
65         $parsed = lti_parse_grade_replace_message($xml);
67         $ltiinstance = $DB->get_record('lti', array('id' => $parsed->instanceid));
69         lti_verify_sourcedid($ltiinstance, $parsed);
71         $gradestatus = lti_update_grade($ltiinstance, $parsed->userid, $parsed->launchid, $parsed->gradeval);
73         $responsexml = lti_get_response_xml(
74                 $gradestatus ? 'success' : 'error',
75                 'Grade replace response',
76                 $parsed->messageid,
77                 'replaceResultResponse'
78         );
80         echo $responsexml->asXML();
82         break;
84     case 'readResultRequest':
85         $parsed = lti_parse_grade_read_message($xml);
87         $ltiinstance = $DB->get_record('lti', array('id' => $parsed->instanceid));
89         //Getting the grade requires the context is set
90         $context = get_context_instance(CONTEXT_COURSE, $ltiinstance->course);
91         $PAGE->set_context($context);
93         lti_verify_sourcedid($ltiinstance, $parsed);
95         $grade = lti_read_grade($ltiinstance, $parsed->userid);
97         $responsexml = lti_get_response_xml(
98                 isset($grade) ? 'success' : 'error',
99                 'Result read',
100                 $parsed->messageid,
101                 'readResultResponse'
102         );
104         $node = $responsexml->imsx_POXBody->readResultResponse;
105         $node->addChild('result')->addChild('resultScore')->addChild('textString', isset($grade) ? $grade : '');
107         echo $responsexml->asXML();
109         break;
111     case 'deleteResultRequest':
112         $parsed = lti_parse_grade_delete_message($xml);
114         $ltiinstance = $DB->get_record('lti', array('id' => $parsed->instanceid));
116         lti_verify_sourcedid($ltiinstance, $parsed);
118         $gradestatus = lti_delete_grade($ltiinstance, $parsed->userid);
120         $responsexml = lti_get_response_xml(
121                 $gradestatus ? 'success' : 'error',
122                 'Grade delete request',
123                 $parsed->messageid,
124                 'deleteResultResponse'
125         );
127         echo $responsexml->asXML();
129         break;
131     default:
132         //Fire an event if we get a web service request which we don't support directly.
133         //This will allow others to extend the LTI services, which I expect to be a common
134         //use case, at least until the spec matures.
135         $data = new stdClass();
136         $data->body = $rawbody;
137         $data->xml = $xml;
138         $data->messagetype = $messagetype;
139         $data->consumerkey = $consumerkey;
140         $data->sharedsecret = $sharedsecret;
142         //If an event handler handles the web service, it should set this global to true
143         //So this code knows whether to send an "operation not supported" or not.
144         global $lti_web_service_handled;
145         $lti_web_service_handled = false;
147         events_trigger('lti_unknown_service_api_call', $data);
149         if (!$lti_web_service_handled) {
150             $responsexml = lti_get_response_xml(
151                 'unsupported',
152                 'unsupported',
153                  lti_parse_message_id($xml),
154                  $messagetype
155             );
157             echo $responsexml->asXML();
158         }
160         break;
164 //echo print_r(apache_request_headers(), true);
166 //echo '<br />';
168 //echo file_get_contents("php://input");