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/>.
  16
  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  */
  25
  26 require_once($CFG->dirroot.'/mod/lti/OAuthBody.php');
  27
  28 // TODO: Switch to core oauthlib once implemented - MDL-30149
  29 use moodle\mod\lti as lti;
  30
  31 define('LTI_ITEM_TYPE', 'mod');
  32 define('LTI_ITEM_MODULE', 'lti');
  33 define('LTI_SOURCE', 'mod/lti');
  34
  35 function lti_get_response_xml($codemajor, $description, $messageref, $messagetype) {
  36     $xml = new SimpleXMLElement('<?xml version="1.0" encoding="UTF-8"?><imsx_POXEnvelopeResponse />');
  37     $xml->addAttribute('xmlns', 'http://www.imsglobal.org/lis/oms1p0/pox');
  38
  39     $headerinfo = $xml->addChild('imsx_POXHeader')->addChild('imsx_POXResponseHeaderInfo');
  40
  41     $headerinfo->addChild('imsx_version', 'V1.0');
  42     $headerinfo->addChild('imsx_messageIdentifier', (string)mt_rand());
  43
  44     $statusinfo = $headerinfo->addChild('imsx_statusInfo');
  45     $statusinfo->addchild('imsx_codeMajor', $codemajor);
  46     $statusinfo->addChild('imsx_severity', 'status');
  47     $statusinfo->addChild('imsx_description', $description);
  48     $statusinfo->addChild('imsx_messageRefIdentifier', $messageref);
  49
  50     $xml->addChild('imsx_POXBody')->addChild($messagetype);
  51
  52     return $xml;
  53 }
  54
  55 function lti_parse_message_id($xml) {
  56     $node = $xml->imsx_POXHeader->imsx_POXRequestHeaderInfo->imsx_messageIdentifier;
  57     $messageid = (string)$node;
  58
  59     return $messageid;
  60 }
  61
  62 function lti_parse_grade_replace_message($xml) {
  63     $node = $xml->imsx_POXBody->replaceResultRequest->resultRecord->sourcedGUID->sourcedId;
  64     $resultjson = json_decode((string)$node);
  65
  66     $node = $xml->imsx_POXBody->replaceResultRequest->resultRecord->result->resultScore->textString;
  67     $grade = floatval((string)$node);
  68
  69     $parsed = new stdClass();
  70     $parsed->gradeval = $grade * 100;
  71
  72     $parsed->instanceid = $resultjson->data->instanceid;
  73     $parsed->userid = $resultjson->data->userid;
  74     $parsed->launchid = $resultjson->data->launchid;
  75     $parsed->sourcedidhash = $resultjson->hash;
  76
  77     $parsed->messageid = lti_parse_message_id($xml);
  78
  79     return $parsed;
  80 }
  81
  82 function lti_parse_grade_read_message($xml) {
  83     $node = $xml->imsx_POXBody->readResultRequest->resultRecord->sourcedGUID->sourcedId;
  84     $resultjson = json_decode((string)$node);
  85
  86     $parsed = new stdClass();
  87     $parsed->instanceid = $resultjson->data->instanceid;
  88     $parsed->userid = $resultjson->data->userid;
  89     $parsed->launchid = $resultjson->data->launchid;
  90     $parsed->sourcedidhash = $resultjson->hash;
  91
  92     $parsed->messageid = lti_parse_message_id($xml);
  93
  94     return $parsed;
  95 }
  96
  97 function lti_parse_grade_delete_message($xml) {
  98     $node = $xml->imsx_POXBody->deleteResultRequest->resultRecord->sourcedGUID->sourcedId;
  99     $resultjson = json_decode((string)$node);
 100
 101     $parsed = new stdClass();
 102     $parsed->instanceid = $resultjson->data->instanceid;
 103     $parsed->userid = $resultjson->data->userid;
 104     $parsed->launchid = $resultjson->data->launchid;
 105     $parsed->sourcedidhash = $resultjson->hash;
 106
 107     $parsed->messageid = lti_parse_message_id($xml);
 108
 109     return $parsed;
 110 }
 111
 112 function lti_update_grade($ltiinstance, $userid, $launchid, $gradeval) {
 113     global $CFG, $DB;
 114     require_once($CFG->libdir . '/gradelib.php');
 115
 116     $params = array();
 117     $params['itemname'] = $ltiinstance->name;
 118
 119     $grade = new stdClass();
 120     $grade->userid   = $userid;
 121     $grade->rawgrade = $gradeval;
 122
 123     $status = grade_update(LTI_SOURCE, $ltiinstance->course, LTI_ITEM_TYPE, LTI_ITEM_MODULE, $ltiinstance->id, 0, $grade, $params);
 124
 125     $record = $DB->get_record('lti_submission', array('ltiid' => $ltiinstance->id, 'userid' => $userid, 'launchid' => $launchid), 'id');
 126     if ($record) {
 127         $id = $record->id;
 128     } else {
 129         $id = null;
 130     }
 131
 132     if (!empty($id)) {
 133         $DB->update_record('lti_submission', array(
 134             'id' => $id,
 135             'dateupdated' => time(),
 136             'gradepercent' => $gradeval,
 137             'state' => 2
 138         ));
 139     } else {
 140         $DB->insert_record('lti_submission', array(
 141             'ltiid' => $ltiinstance->id,
 142             'userid' => $userid,
 143             'datesubmitted' => time(),
 144             'dateupdated' => time(),
 145             'gradepercent' => $gradeval,
 146             'originalgrade' => $gradeval,
 147             'launchid' => $launchid,
 148             'state' => 1
 149         ));
 150     }
 151
 152     return $status == GRADE_UPDATE_OK;
 153 }
 154
 155 function lti_read_grade($ltiinstance, $userid) {
 156     global $CFG;
 157     require_once($CFG->libdir . '/gradelib.php');
 158
 159     $grades = grade_get_grades($ltiinstance->course, LTI_ITEM_TYPE, LTI_ITEM_MODULE, $ltiinstance->id, $userid);
 160
 161     if (isset($grades) && isset($grades->items[0]) && is_array($grades->items[0]->grades)) {
 162         foreach ($grades->items[0]->grades as $agrade) {
 163             $grade = $agrade->grade;
 164             break;
 165         }
 166     }
 167
 168     if (isset($grade)) {
 169         return $grade;
 170     }
 171 }
 172
 173 function lti_delete_grade($ltiinstance, $userid) {
 174     global $CFG;
 175     require_once($CFG->libdir . '/gradelib.php');
 176
 177     $grade = new stdClass();
 178     $grade->userid   = $userid;
 179     $grade->rawgrade = null;
 180
 181     $status = grade_update(LTI_SOURCE, $ltiinstance->course, LTI_ITEM_TYPE, LTI_ITEM_MODULE, $ltiinstance->id, 0, $grade, array('deleted'=>1));
 182
 183     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
 184 }
 185
 186 function lti_verify_message($key, $sharedsecrets, $body, $headers = null) {
 187     foreach ($sharedsecrets as $secret) {
 188         $signaturefailed = false;
 189
 190         try {
 191             // TODO: Switch to core oauthlib once implemented - MDL-30149
 192             lti\handleOAuthBodyPOST($key, $secret, $body, $headers);
 193         } catch (Exception $e) {
 194             $signaturefailed = true;
 195         }
 196
 197         if (!$signaturefailed) {
 198             return $secret;//Return the secret used to sign the message)
 199         }
 200     }
 201
 202     return false;
 203 }
 204
 205 function lti_verify_sourcedid($ltiinstance, $parsed) {
 206     $sourceid = lti_build_sourcedid($parsed->instanceid, $parsed->userid, $parsed->launchid, $ltiinstance->servicesalt);
 207
 208     if ($sourceid->hash != $parsed->sourcedidhash) {
 209         throw new Exception('SourcedId hash not valid');
 210     }
 211 }